babylon.module.d.ts 6.7 MB

123456789101112131415161718192021222324252627282930313233343536373839404142434445464748495051525354555657585960616263646566676869707172737475767778798081828384858687888990919293949596979899100101102103104105106107108109110111112113114115116117118119120121122123124125126127128129130131132133134135136137138139140141142143144145146147148149150151152153154155156157158159160161162163164165166167168169170171172173174175176177178179180181182183184185186187188189190191192193194195196197198199200201202203204205206207208209210211212213214215216217218219220221222223224225226227228229230231232233234235236237238239240241242243244245246247248249250251252253254255256257258259260261262263264265266267268269270271272273274275276277278279280281282283284285286287288289290291292293294295296297298299300301302303304305306307308309310311312313314315316317318319320321322323324325326327328329330331332333334335336337338339340341342343344345346347348349350351352353354355356357358359360361362363364365366367368369370371372373374375376377378379380381382383384385386387388389390391392393394395396397398399400401402403404405406407408409410411412413414415416417418419420421422423424425426427428429430431432433434435436437438439440441442443444445446447448449450451452453454455456457458459460461462463464465466467468469470471472473474475476477478479480481482483484485486487488489490491492493494495496497498499500501502503504505506507508509510511512513514515516517518519520521522523524525526527528529530531532533534535536537538539540541542543544545546547548549550551552553554555556557558559560561562563564565566567568569570571572573574575576577578579580581582583584585586587588589590591592593594595596597598599600601602603604605606607608609610611612613614615616617618619620621622623624625626627628629630631632633634635636637638639640641642643644645646647648649650651652653654655656657658659660661662663664665666667668669670671672673674675676677678679680681682683684685686687688689690691692693694695696697698699700701702703704705706707708709710711712713714715716717718719720721722723724725726727728729730731732733734735736737738739740741742743744745746747748749750751752753754755756757758759760761762763764765766767768769770771772773774775776777778779780781782783784785786787788789790791792793794795796797798799800801802803804805806807808809810811812813814815816817818819820821822823824825826827828829830831832833834835836837838839840841842843844845846847848849850851852853854855856857858859860861862863864865866867868869870871872873874875876877878879880881882883884885886887888889890891892893894895896897898899900901902903904905906907908909910911912913914915916917918919920921922923924925926927928929930931932933934935936937938939940941942943944945946947948949950951952953954955956957958959960961962963964965966967968969970971972973974975976977978979980981982983984985986987988989990991992993994995996997998999100010011002100310041005100610071008100910101011101210131014101510161017101810191020102110221023102410251026102710281029103010311032103310341035103610371038103910401041104210431044104510461047104810491050105110521053105410551056105710581059106010611062106310641065106610671068106910701071107210731074107510761077107810791080108110821083108410851086108710881089109010911092109310941095109610971098109911001101110211031104110511061107110811091110111111121113111411151116111711181119112011211122112311241125112611271128112911301131113211331134113511361137113811391140114111421143114411451146114711481149115011511152115311541155115611571158115911601161116211631164116511661167116811691170117111721173117411751176117711781179118011811182118311841185118611871188118911901191119211931194119511961197119811991200120112021203120412051206120712081209121012111212121312141215121612171218121912201221122212231224122512261227122812291230123112321233123412351236123712381239124012411242124312441245124612471248124912501251125212531254125512561257125812591260126112621263126412651266126712681269127012711272127312741275127612771278127912801281128212831284128512861287128812891290129112921293129412951296129712981299130013011302130313041305130613071308130913101311131213131314131513161317131813191320132113221323132413251326132713281329133013311332133313341335133613371338133913401341134213431344134513461347134813491350135113521353135413551356135713581359136013611362136313641365136613671368136913701371137213731374137513761377137813791380138113821383138413851386138713881389139013911392139313941395139613971398139914001401140214031404140514061407140814091410141114121413141414151416141714181419142014211422142314241425142614271428142914301431143214331434143514361437143814391440144114421443144414451446144714481449145014511452145314541455145614571458145914601461146214631464146514661467146814691470147114721473147414751476147714781479148014811482148314841485148614871488148914901491149214931494149514961497149814991500150115021503150415051506150715081509151015111512151315141515151615171518151915201521152215231524152515261527152815291530153115321533153415351536153715381539154015411542154315441545154615471548154915501551155215531554155515561557155815591560156115621563156415651566156715681569157015711572157315741575157615771578157915801581158215831584158515861587158815891590159115921593159415951596159715981599160016011602160316041605160616071608160916101611161216131614161516161617161816191620162116221623162416251626162716281629163016311632163316341635163616371638163916401641164216431644164516461647164816491650165116521653165416551656165716581659166016611662166316641665166616671668166916701671167216731674167516761677167816791680168116821683168416851686168716881689169016911692169316941695169616971698169917001701170217031704170517061707170817091710171117121713171417151716171717181719172017211722172317241725172617271728172917301731173217331734173517361737173817391740174117421743174417451746174717481749175017511752175317541755175617571758175917601761176217631764176517661767176817691770177117721773177417751776177717781779178017811782178317841785178617871788178917901791179217931794179517961797179817991800180118021803180418051806180718081809181018111812181318141815181618171818181918201821182218231824182518261827182818291830183118321833183418351836183718381839184018411842184318441845184618471848184918501851185218531854185518561857185818591860186118621863186418651866186718681869187018711872187318741875187618771878187918801881188218831884188518861887188818891890189118921893189418951896189718981899190019011902190319041905190619071908190919101911191219131914191519161917191819191920192119221923192419251926192719281929193019311932193319341935193619371938193919401941194219431944194519461947194819491950195119521953195419551956195719581959196019611962196319641965196619671968196919701971197219731974197519761977197819791980198119821983198419851986198719881989199019911992199319941995199619971998199920002001200220032004200520062007200820092010201120122013201420152016201720182019202020212022202320242025202620272028202920302031203220332034203520362037203820392040204120422043204420452046204720482049205020512052205320542055205620572058205920602061206220632064206520662067206820692070207120722073207420752076207720782079208020812082208320842085208620872088208920902091209220932094209520962097209820992100210121022103210421052106210721082109211021112112211321142115211621172118211921202121212221232124212521262127212821292130213121322133213421352136213721382139214021412142214321442145214621472148214921502151215221532154215521562157215821592160216121622163216421652166216721682169217021712172217321742175217621772178217921802181218221832184218521862187218821892190219121922193219421952196219721982199220022012202220322042205220622072208220922102211221222132214221522162217221822192220222122222223222422252226222722282229223022312232223322342235223622372238223922402241224222432244224522462247224822492250225122522253225422552256225722582259226022612262226322642265226622672268226922702271227222732274227522762277227822792280228122822283228422852286228722882289229022912292229322942295229622972298229923002301230223032304230523062307230823092310231123122313231423152316231723182319232023212322232323242325232623272328232923302331233223332334233523362337233823392340234123422343234423452346234723482349235023512352235323542355235623572358235923602361236223632364236523662367236823692370237123722373237423752376237723782379238023812382238323842385238623872388238923902391239223932394239523962397239823992400240124022403240424052406240724082409241024112412241324142415241624172418241924202421242224232424242524262427242824292430243124322433243424352436243724382439244024412442244324442445244624472448244924502451245224532454245524562457245824592460246124622463246424652466246724682469247024712472247324742475247624772478247924802481248224832484248524862487248824892490249124922493249424952496249724982499250025012502250325042505250625072508250925102511251225132514251525162517251825192520252125222523252425252526252725282529253025312532253325342535253625372538253925402541254225432544254525462547254825492550255125522553255425552556255725582559256025612562256325642565256625672568256925702571257225732574257525762577257825792580258125822583258425852586258725882589259025912592259325942595259625972598259926002601260226032604260526062607260826092610261126122613261426152616261726182619262026212622262326242625262626272628262926302631263226332634263526362637263826392640264126422643264426452646264726482649265026512652265326542655265626572658265926602661266226632664266526662667266826692670267126722673267426752676267726782679268026812682268326842685268626872688268926902691269226932694269526962697269826992700270127022703270427052706270727082709271027112712271327142715271627172718271927202721272227232724272527262727272827292730273127322733273427352736273727382739274027412742274327442745274627472748274927502751275227532754275527562757275827592760276127622763276427652766276727682769277027712772277327742775277627772778277927802781278227832784278527862787278827892790279127922793279427952796279727982799280028012802280328042805280628072808280928102811281228132814281528162817281828192820282128222823282428252826282728282829283028312832283328342835283628372838283928402841284228432844284528462847284828492850285128522853285428552856285728582859286028612862286328642865286628672868286928702871287228732874287528762877287828792880288128822883288428852886288728882889289028912892289328942895289628972898289929002901290229032904290529062907290829092910291129122913291429152916291729182919292029212922292329242925292629272928292929302931293229332934293529362937293829392940294129422943294429452946294729482949295029512952295329542955295629572958295929602961296229632964296529662967296829692970297129722973297429752976297729782979298029812982298329842985298629872988298929902991299229932994299529962997299829993000300130023003300430053006300730083009301030113012301330143015301630173018301930203021302230233024302530263027302830293030303130323033303430353036303730383039304030413042304330443045304630473048304930503051305230533054305530563057305830593060306130623063306430653066306730683069307030713072307330743075307630773078307930803081308230833084308530863087308830893090309130923093309430953096309730983099310031013102310331043105310631073108310931103111311231133114311531163117311831193120312131223123312431253126312731283129313031313132313331343135313631373138313931403141314231433144314531463147314831493150315131523153315431553156315731583159316031613162316331643165316631673168316931703171317231733174317531763177317831793180318131823183318431853186318731883189319031913192319331943195319631973198319932003201320232033204320532063207320832093210321132123213321432153216321732183219322032213222322332243225322632273228322932303231323232333234323532363237323832393240324132423243324432453246324732483249325032513252325332543255325632573258325932603261326232633264326532663267326832693270327132723273327432753276327732783279328032813282328332843285328632873288328932903291329232933294329532963297329832993300330133023303330433053306330733083309331033113312331333143315331633173318331933203321332233233324332533263327332833293330333133323333333433353336333733383339334033413342334333443345334633473348334933503351335233533354335533563357335833593360336133623363336433653366336733683369337033713372337333743375337633773378337933803381338233833384338533863387338833893390339133923393339433953396339733983399340034013402340334043405340634073408340934103411341234133414341534163417341834193420342134223423342434253426342734283429343034313432343334343435343634373438343934403441344234433444344534463447344834493450345134523453345434553456345734583459346034613462346334643465346634673468346934703471347234733474347534763477347834793480348134823483348434853486348734883489349034913492349334943495349634973498349935003501350235033504350535063507350835093510351135123513351435153516351735183519352035213522352335243525352635273528352935303531353235333534353535363537353835393540354135423543354435453546354735483549355035513552355335543555355635573558355935603561356235633564356535663567356835693570357135723573357435753576357735783579358035813582358335843585358635873588358935903591359235933594359535963597359835993600360136023603360436053606360736083609361036113612361336143615361636173618361936203621362236233624362536263627362836293630363136323633363436353636363736383639364036413642364336443645364636473648364936503651365236533654365536563657365836593660366136623663366436653666366736683669367036713672367336743675367636773678367936803681368236833684368536863687368836893690369136923693369436953696369736983699370037013702370337043705370637073708370937103711371237133714371537163717371837193720372137223723372437253726372737283729373037313732373337343735373637373738373937403741374237433744374537463747374837493750375137523753375437553756375737583759376037613762376337643765376637673768376937703771377237733774377537763777377837793780378137823783378437853786378737883789379037913792379337943795379637973798379938003801380238033804380538063807380838093810381138123813381438153816381738183819382038213822382338243825382638273828382938303831383238333834383538363837383838393840384138423843384438453846384738483849385038513852385338543855385638573858385938603861386238633864386538663867386838693870387138723873387438753876387738783879388038813882388338843885388638873888388938903891389238933894389538963897389838993900390139023903390439053906390739083909391039113912391339143915391639173918391939203921392239233924392539263927392839293930393139323933393439353936393739383939394039413942394339443945394639473948394939503951395239533954395539563957395839593960396139623963396439653966396739683969397039713972397339743975397639773978397939803981398239833984398539863987398839893990399139923993399439953996399739983999400040014002400340044005400640074008400940104011401240134014401540164017401840194020402140224023402440254026402740284029403040314032403340344035403640374038403940404041404240434044404540464047404840494050405140524053405440554056405740584059406040614062406340644065406640674068406940704071407240734074407540764077407840794080408140824083408440854086408740884089409040914092409340944095409640974098409941004101410241034104410541064107410841094110411141124113411441154116411741184119412041214122412341244125412641274128412941304131413241334134413541364137413841394140414141424143414441454146414741484149415041514152415341544155415641574158415941604161416241634164416541664167416841694170417141724173417441754176417741784179418041814182418341844185418641874188418941904191419241934194419541964197419841994200420142024203420442054206420742084209421042114212421342144215421642174218421942204221422242234224422542264227422842294230423142324233423442354236423742384239424042414242424342444245424642474248424942504251425242534254425542564257425842594260426142624263426442654266426742684269427042714272427342744275427642774278427942804281428242834284428542864287428842894290429142924293429442954296429742984299430043014302430343044305430643074308430943104311431243134314431543164317431843194320432143224323432443254326432743284329433043314332433343344335433643374338433943404341434243434344434543464347434843494350435143524353435443554356435743584359436043614362436343644365436643674368436943704371437243734374437543764377437843794380438143824383438443854386438743884389439043914392439343944395439643974398439944004401440244034404440544064407440844094410441144124413441444154416441744184419442044214422442344244425442644274428442944304431443244334434443544364437443844394440444144424443444444454446444744484449445044514452445344544455445644574458445944604461446244634464446544664467446844694470447144724473447444754476447744784479448044814482448344844485448644874488448944904491449244934494449544964497449844994500450145024503450445054506450745084509451045114512451345144515451645174518451945204521452245234524452545264527452845294530453145324533453445354536453745384539454045414542454345444545454645474548454945504551455245534554455545564557455845594560456145624563456445654566456745684569457045714572457345744575457645774578457945804581458245834584458545864587458845894590459145924593459445954596459745984599460046014602460346044605460646074608460946104611461246134614461546164617461846194620462146224623462446254626462746284629463046314632463346344635463646374638463946404641464246434644464546464647464846494650465146524653465446554656465746584659466046614662466346644665466646674668466946704671467246734674467546764677467846794680468146824683468446854686468746884689469046914692469346944695469646974698469947004701470247034704470547064707470847094710471147124713471447154716471747184719472047214722472347244725472647274728472947304731473247334734473547364737473847394740474147424743474447454746474747484749475047514752475347544755475647574758475947604761476247634764476547664767476847694770477147724773477447754776477747784779478047814782478347844785478647874788478947904791479247934794479547964797479847994800480148024803480448054806480748084809481048114812481348144815481648174818481948204821482248234824482548264827482848294830483148324833483448354836483748384839484048414842484348444845484648474848484948504851485248534854485548564857485848594860486148624863486448654866486748684869487048714872487348744875487648774878487948804881488248834884488548864887488848894890489148924893489448954896489748984899490049014902490349044905490649074908490949104911491249134914491549164917491849194920492149224923492449254926492749284929493049314932493349344935493649374938493949404941494249434944494549464947494849494950495149524953495449554956495749584959496049614962496349644965496649674968496949704971497249734974497549764977497849794980498149824983498449854986498749884989499049914992499349944995499649974998499950005001500250035004500550065007500850095010501150125013501450155016501750185019502050215022502350245025502650275028502950305031503250335034503550365037503850395040504150425043504450455046504750485049505050515052505350545055505650575058505950605061506250635064506550665067506850695070507150725073507450755076507750785079508050815082508350845085508650875088508950905091509250935094509550965097509850995100510151025103510451055106510751085109511051115112511351145115511651175118511951205121512251235124512551265127512851295130513151325133513451355136513751385139514051415142514351445145514651475148514951505151515251535154515551565157515851595160516151625163516451655166516751685169517051715172517351745175517651775178517951805181518251835184518551865187518851895190519151925193519451955196519751985199520052015202520352045205520652075208520952105211521252135214521552165217521852195220522152225223522452255226522752285229523052315232523352345235523652375238523952405241524252435244524552465247524852495250525152525253525452555256525752585259526052615262526352645265526652675268526952705271527252735274527552765277527852795280528152825283528452855286528752885289529052915292529352945295529652975298529953005301530253035304530553065307530853095310531153125313531453155316531753185319532053215322532353245325532653275328532953305331533253335334533553365337533853395340534153425343534453455346534753485349535053515352535353545355535653575358535953605361536253635364536553665367536853695370537153725373537453755376537753785379538053815382538353845385538653875388538953905391539253935394539553965397539853995400540154025403540454055406540754085409541054115412541354145415541654175418541954205421542254235424542554265427542854295430543154325433543454355436543754385439544054415442544354445445544654475448544954505451545254535454545554565457545854595460546154625463546454655466546754685469547054715472547354745475547654775478547954805481548254835484548554865487548854895490549154925493549454955496549754985499550055015502550355045505550655075508550955105511551255135514551555165517551855195520552155225523552455255526552755285529553055315532553355345535553655375538553955405541554255435544554555465547554855495550555155525553555455555556555755585559556055615562556355645565556655675568556955705571557255735574557555765577557855795580558155825583558455855586558755885589559055915592559355945595559655975598559956005601560256035604560556065607560856095610561156125613561456155616561756185619562056215622562356245625562656275628562956305631563256335634563556365637563856395640564156425643564456455646564756485649565056515652565356545655565656575658565956605661566256635664566556665667566856695670567156725673567456755676567756785679568056815682568356845685568656875688568956905691569256935694569556965697569856995700570157025703570457055706570757085709571057115712571357145715571657175718571957205721572257235724572557265727572857295730573157325733573457355736573757385739574057415742574357445745574657475748574957505751575257535754575557565757575857595760576157625763576457655766576757685769577057715772577357745775577657775778577957805781578257835784578557865787578857895790579157925793579457955796579757985799580058015802580358045805580658075808580958105811581258135814581558165817581858195820582158225823582458255826582758285829583058315832583358345835583658375838583958405841584258435844584558465847584858495850585158525853585458555856585758585859586058615862586358645865586658675868586958705871587258735874587558765877587858795880588158825883588458855886588758885889589058915892589358945895589658975898589959005901590259035904590559065907590859095910591159125913591459155916591759185919592059215922592359245925592659275928592959305931593259335934593559365937593859395940594159425943594459455946594759485949595059515952595359545955595659575958595959605961596259635964596559665967596859695970597159725973597459755976597759785979598059815982598359845985598659875988598959905991599259935994599559965997599859996000600160026003600460056006600760086009601060116012601360146015601660176018601960206021602260236024602560266027602860296030603160326033603460356036603760386039604060416042604360446045604660476048604960506051605260536054605560566057605860596060606160626063606460656066606760686069607060716072607360746075607660776078607960806081608260836084608560866087608860896090609160926093609460956096609760986099610061016102610361046105610661076108610961106111611261136114611561166117611861196120612161226123612461256126612761286129613061316132613361346135613661376138613961406141614261436144614561466147614861496150615161526153615461556156615761586159616061616162616361646165616661676168616961706171617261736174617561766177617861796180618161826183618461856186618761886189619061916192619361946195619661976198619962006201620262036204620562066207620862096210621162126213621462156216621762186219622062216222622362246225622662276228622962306231623262336234623562366237623862396240624162426243624462456246624762486249625062516252625362546255625662576258625962606261626262636264626562666267626862696270627162726273627462756276627762786279628062816282628362846285628662876288628962906291629262936294629562966297629862996300630163026303630463056306630763086309631063116312631363146315631663176318631963206321632263236324632563266327632863296330633163326333633463356336633763386339634063416342634363446345634663476348634963506351635263536354635563566357635863596360636163626363636463656366636763686369637063716372637363746375637663776378637963806381638263836384638563866387638863896390639163926393639463956396639763986399640064016402640364046405640664076408640964106411641264136414641564166417641864196420642164226423642464256426642764286429643064316432643364346435643664376438643964406441644264436444644564466447644864496450645164526453645464556456645764586459646064616462646364646465646664676468646964706471647264736474647564766477647864796480648164826483648464856486648764886489649064916492649364946495649664976498649965006501650265036504650565066507650865096510651165126513651465156516651765186519652065216522652365246525652665276528652965306531653265336534653565366537653865396540654165426543654465456546654765486549655065516552655365546555655665576558655965606561656265636564656565666567656865696570657165726573657465756576657765786579658065816582658365846585658665876588658965906591659265936594659565966597659865996600660166026603660466056606660766086609661066116612661366146615661666176618661966206621662266236624662566266627662866296630663166326633663466356636663766386639664066416642664366446645664666476648664966506651665266536654665566566657665866596660666166626663666466656666666766686669667066716672667366746675667666776678667966806681668266836684668566866687668866896690669166926693669466956696669766986699670067016702670367046705670667076708670967106711671267136714671567166717671867196720672167226723672467256726672767286729673067316732673367346735673667376738673967406741674267436744674567466747674867496750675167526753675467556756675767586759676067616762676367646765676667676768676967706771677267736774677567766777677867796780678167826783678467856786678767886789679067916792679367946795679667976798679968006801680268036804680568066807680868096810681168126813681468156816681768186819682068216822682368246825682668276828682968306831683268336834683568366837683868396840684168426843684468456846684768486849685068516852685368546855685668576858685968606861686268636864686568666867686868696870687168726873687468756876687768786879688068816882688368846885688668876888688968906891689268936894689568966897689868996900690169026903690469056906690769086909691069116912691369146915691669176918691969206921692269236924692569266927692869296930693169326933693469356936693769386939694069416942694369446945694669476948694969506951695269536954695569566957695869596960696169626963696469656966696769686969697069716972697369746975697669776978697969806981698269836984698569866987698869896990699169926993699469956996699769986999700070017002700370047005700670077008700970107011701270137014701570167017701870197020702170227023702470257026702770287029703070317032703370347035703670377038703970407041704270437044704570467047704870497050705170527053705470557056705770587059706070617062706370647065706670677068706970707071707270737074707570767077707870797080708170827083708470857086708770887089709070917092709370947095709670977098709971007101710271037104710571067107710871097110711171127113711471157116711771187119712071217122712371247125712671277128712971307131713271337134713571367137713871397140714171427143714471457146714771487149715071517152715371547155715671577158715971607161716271637164716571667167716871697170717171727173717471757176717771787179718071817182718371847185718671877188718971907191719271937194719571967197719871997200720172027203720472057206720772087209721072117212721372147215721672177218721972207221722272237224722572267227722872297230723172327233723472357236723772387239724072417242724372447245724672477248724972507251725272537254725572567257725872597260726172627263726472657266726772687269727072717272727372747275727672777278727972807281728272837284728572867287728872897290729172927293729472957296729772987299730073017302730373047305730673077308730973107311731273137314731573167317731873197320732173227323732473257326732773287329733073317332733373347335733673377338733973407341734273437344734573467347734873497350735173527353735473557356735773587359736073617362736373647365736673677368736973707371737273737374737573767377737873797380738173827383738473857386738773887389739073917392739373947395739673977398739974007401740274037404740574067407740874097410741174127413741474157416741774187419742074217422742374247425742674277428742974307431743274337434743574367437743874397440744174427443744474457446744774487449745074517452745374547455745674577458745974607461746274637464746574667467746874697470747174727473747474757476747774787479748074817482748374847485748674877488748974907491749274937494749574967497749874997500750175027503750475057506750775087509751075117512751375147515751675177518751975207521752275237524752575267527752875297530753175327533753475357536753775387539754075417542754375447545754675477548754975507551755275537554755575567557755875597560756175627563756475657566756775687569757075717572757375747575757675777578757975807581758275837584758575867587758875897590759175927593759475957596759775987599760076017602760376047605760676077608760976107611761276137614761576167617761876197620762176227623762476257626762776287629763076317632763376347635763676377638763976407641764276437644764576467647764876497650765176527653765476557656765776587659766076617662766376647665766676677668766976707671767276737674767576767677767876797680768176827683768476857686768776887689769076917692769376947695769676977698769977007701770277037704770577067707770877097710771177127713771477157716771777187719772077217722772377247725772677277728772977307731773277337734773577367737773877397740774177427743774477457746774777487749775077517752775377547755775677577758775977607761776277637764776577667767776877697770777177727773777477757776777777787779778077817782778377847785778677877788778977907791779277937794779577967797779877997800780178027803780478057806780778087809781078117812781378147815781678177818781978207821782278237824782578267827782878297830783178327833783478357836783778387839784078417842784378447845784678477848784978507851785278537854785578567857785878597860786178627863786478657866786778687869787078717872787378747875787678777878787978807881788278837884788578867887788878897890789178927893789478957896789778987899790079017902790379047905790679077908790979107911791279137914791579167917791879197920792179227923792479257926792779287929793079317932793379347935793679377938793979407941794279437944794579467947794879497950795179527953795479557956795779587959796079617962796379647965796679677968796979707971797279737974797579767977797879797980798179827983798479857986798779887989799079917992799379947995799679977998799980008001800280038004800580068007800880098010801180128013801480158016801780188019802080218022802380248025802680278028802980308031803280338034803580368037803880398040804180428043804480458046804780488049805080518052805380548055805680578058805980608061806280638064806580668067806880698070807180728073807480758076807780788079808080818082808380848085808680878088808980908091809280938094809580968097809880998100810181028103810481058106810781088109811081118112811381148115811681178118811981208121812281238124812581268127812881298130813181328133813481358136813781388139814081418142814381448145814681478148814981508151815281538154815581568157815881598160816181628163816481658166816781688169817081718172817381748175817681778178817981808181818281838184818581868187818881898190819181928193819481958196819781988199820082018202820382048205820682078208820982108211821282138214821582168217821882198220822182228223822482258226822782288229823082318232823382348235823682378238823982408241824282438244824582468247824882498250825182528253825482558256825782588259826082618262826382648265826682678268826982708271827282738274827582768277827882798280828182828283828482858286828782888289829082918292829382948295829682978298829983008301830283038304830583068307830883098310831183128313831483158316831783188319832083218322832383248325832683278328832983308331833283338334833583368337833883398340834183428343834483458346834783488349835083518352835383548355835683578358835983608361836283638364836583668367836883698370837183728373837483758376837783788379838083818382838383848385838683878388838983908391839283938394839583968397839883998400840184028403840484058406840784088409841084118412841384148415841684178418841984208421842284238424842584268427842884298430843184328433843484358436843784388439844084418442844384448445844684478448844984508451845284538454845584568457845884598460846184628463846484658466846784688469847084718472847384748475847684778478847984808481848284838484848584868487848884898490849184928493849484958496849784988499850085018502850385048505850685078508850985108511851285138514851585168517851885198520852185228523852485258526852785288529853085318532853385348535853685378538853985408541854285438544854585468547854885498550855185528553855485558556855785588559856085618562856385648565856685678568856985708571857285738574857585768577857885798580858185828583858485858586858785888589859085918592859385948595859685978598859986008601860286038604860586068607860886098610861186128613861486158616861786188619862086218622862386248625862686278628862986308631863286338634863586368637863886398640864186428643864486458646864786488649865086518652865386548655865686578658865986608661866286638664866586668667866886698670867186728673867486758676867786788679868086818682868386848685868686878688868986908691869286938694869586968697869886998700870187028703870487058706870787088709871087118712871387148715871687178718871987208721872287238724872587268727872887298730873187328733873487358736873787388739874087418742874387448745874687478748874987508751875287538754875587568757875887598760876187628763876487658766876787688769877087718772877387748775877687778778877987808781878287838784878587868787878887898790879187928793879487958796879787988799880088018802880388048805880688078808880988108811881288138814881588168817881888198820882188228823882488258826882788288829883088318832883388348835883688378838883988408841884288438844884588468847884888498850885188528853885488558856885788588859886088618862886388648865886688678868886988708871887288738874887588768877887888798880888188828883888488858886888788888889889088918892889388948895889688978898889989008901890289038904890589068907890889098910891189128913891489158916891789188919892089218922892389248925892689278928892989308931893289338934893589368937893889398940894189428943894489458946894789488949895089518952895389548955895689578958895989608961896289638964896589668967896889698970897189728973897489758976897789788979898089818982898389848985898689878988898989908991899289938994899589968997899889999000900190029003900490059006900790089009901090119012901390149015901690179018901990209021902290239024902590269027902890299030903190329033903490359036903790389039904090419042904390449045904690479048904990509051905290539054905590569057905890599060906190629063906490659066906790689069907090719072907390749075907690779078907990809081908290839084908590869087908890899090909190929093909490959096909790989099910091019102910391049105910691079108910991109111911291139114911591169117911891199120912191229123912491259126912791289129913091319132913391349135913691379138913991409141914291439144914591469147914891499150915191529153915491559156915791589159916091619162916391649165916691679168916991709171917291739174917591769177917891799180918191829183918491859186918791889189919091919192919391949195919691979198919992009201920292039204920592069207920892099210921192129213921492159216921792189219922092219222922392249225922692279228922992309231923292339234923592369237923892399240924192429243924492459246924792489249925092519252925392549255925692579258925992609261926292639264926592669267926892699270927192729273927492759276927792789279928092819282928392849285928692879288928992909291929292939294929592969297929892999300930193029303930493059306930793089309931093119312931393149315931693179318931993209321932293239324932593269327932893299330933193329333933493359336933793389339934093419342934393449345934693479348934993509351935293539354935593569357935893599360936193629363936493659366936793689369937093719372937393749375937693779378937993809381938293839384938593869387938893899390939193929393939493959396939793989399940094019402940394049405940694079408940994109411941294139414941594169417941894199420942194229423942494259426942794289429943094319432943394349435943694379438943994409441944294439444944594469447944894499450945194529453945494559456945794589459946094619462946394649465946694679468946994709471947294739474947594769477947894799480948194829483948494859486948794889489949094919492949394949495949694979498949995009501950295039504950595069507950895099510951195129513951495159516951795189519952095219522952395249525952695279528952995309531953295339534953595369537953895399540954195429543954495459546954795489549955095519552955395549555955695579558955995609561956295639564956595669567956895699570957195729573957495759576957795789579958095819582958395849585958695879588958995909591959295939594959595969597959895999600960196029603960496059606960796089609961096119612961396149615961696179618961996209621962296239624962596269627962896299630963196329633963496359636963796389639964096419642964396449645964696479648964996509651965296539654965596569657965896599660966196629663966496659666966796689669967096719672967396749675967696779678967996809681968296839684968596869687968896899690969196929693969496959696969796989699970097019702970397049705970697079708970997109711971297139714971597169717971897199720972197229723972497259726972797289729973097319732973397349735973697379738973997409741974297439744974597469747974897499750975197529753975497559756975797589759976097619762976397649765976697679768976997709771977297739774977597769777977897799780978197829783978497859786978797889789979097919792979397949795979697979798979998009801980298039804980598069807980898099810981198129813981498159816981798189819982098219822982398249825982698279828982998309831983298339834983598369837983898399840984198429843984498459846984798489849985098519852985398549855985698579858985998609861986298639864986598669867986898699870987198729873987498759876987798789879988098819882988398849885988698879888988998909891989298939894989598969897989898999900990199029903990499059906990799089909991099119912991399149915991699179918991999209921992299239924992599269927992899299930993199329933993499359936993799389939994099419942994399449945994699479948994999509951995299539954995599569957995899599960996199629963996499659966996799689969997099719972997399749975997699779978997999809981998299839984998599869987998899899990999199929993999499959996999799989999100001000110002100031000410005100061000710008100091001010011100121001310014100151001610017100181001910020100211002210023100241002510026100271002810029100301003110032100331003410035100361003710038100391004010041100421004310044100451004610047100481004910050100511005210053100541005510056100571005810059100601006110062100631006410065100661006710068100691007010071100721007310074100751007610077100781007910080100811008210083100841008510086100871008810089100901009110092100931009410095100961009710098100991010010101101021010310104101051010610107101081010910110101111011210113101141011510116101171011810119101201012110122101231012410125101261012710128101291013010131101321013310134101351013610137101381013910140101411014210143101441014510146101471014810149101501015110152101531015410155101561015710158101591016010161101621016310164101651016610167101681016910170101711017210173101741017510176101771017810179101801018110182101831018410185101861018710188101891019010191101921019310194101951019610197101981019910200102011020210203102041020510206102071020810209102101021110212102131021410215102161021710218102191022010221102221022310224102251022610227102281022910230102311023210233102341023510236102371023810239102401024110242102431024410245102461024710248102491025010251102521025310254102551025610257102581025910260102611026210263102641026510266102671026810269102701027110272102731027410275102761027710278102791028010281102821028310284102851028610287102881028910290102911029210293102941029510296102971029810299103001030110302103031030410305103061030710308103091031010311103121031310314103151031610317103181031910320103211032210323103241032510326103271032810329103301033110332103331033410335103361033710338103391034010341103421034310344103451034610347103481034910350103511035210353103541035510356103571035810359103601036110362103631036410365103661036710368103691037010371103721037310374103751037610377103781037910380103811038210383103841038510386103871038810389103901039110392103931039410395103961039710398103991040010401104021040310404104051040610407104081040910410104111041210413104141041510416104171041810419104201042110422104231042410425104261042710428104291043010431104321043310434104351043610437104381043910440104411044210443104441044510446104471044810449104501045110452104531045410455104561045710458104591046010461104621046310464104651046610467104681046910470104711047210473104741047510476104771047810479104801048110482104831048410485104861048710488104891049010491104921049310494104951049610497104981049910500105011050210503105041050510506105071050810509105101051110512105131051410515105161051710518105191052010521105221052310524105251052610527105281052910530105311053210533105341053510536105371053810539105401054110542105431054410545105461054710548105491055010551105521055310554105551055610557105581055910560105611056210563105641056510566105671056810569105701057110572105731057410575105761057710578105791058010581105821058310584105851058610587105881058910590105911059210593105941059510596105971059810599106001060110602106031060410605106061060710608106091061010611106121061310614106151061610617106181061910620106211062210623106241062510626106271062810629106301063110632106331063410635106361063710638106391064010641106421064310644106451064610647106481064910650106511065210653106541065510656106571065810659106601066110662106631066410665106661066710668106691067010671106721067310674106751067610677106781067910680106811068210683106841068510686106871068810689106901069110692106931069410695106961069710698106991070010701107021070310704107051070610707107081070910710107111071210713107141071510716107171071810719107201072110722107231072410725107261072710728107291073010731107321073310734107351073610737107381073910740107411074210743107441074510746107471074810749107501075110752107531075410755107561075710758107591076010761107621076310764107651076610767107681076910770107711077210773107741077510776107771077810779107801078110782107831078410785107861078710788107891079010791107921079310794107951079610797107981079910800108011080210803108041080510806108071080810809108101081110812108131081410815108161081710818108191082010821108221082310824108251082610827108281082910830108311083210833108341083510836108371083810839108401084110842108431084410845108461084710848108491085010851108521085310854108551085610857108581085910860108611086210863108641086510866108671086810869108701087110872108731087410875108761087710878108791088010881108821088310884108851088610887108881088910890108911089210893108941089510896108971089810899109001090110902109031090410905109061090710908109091091010911109121091310914109151091610917109181091910920109211092210923109241092510926109271092810929109301093110932109331093410935109361093710938109391094010941109421094310944109451094610947109481094910950109511095210953109541095510956109571095810959109601096110962109631096410965109661096710968109691097010971109721097310974109751097610977109781097910980109811098210983109841098510986109871098810989109901099110992109931099410995109961099710998109991100011001110021100311004110051100611007110081100911010110111101211013110141101511016110171101811019110201102111022110231102411025110261102711028110291103011031110321103311034110351103611037110381103911040110411104211043110441104511046110471104811049110501105111052110531105411055110561105711058110591106011061110621106311064110651106611067110681106911070110711107211073110741107511076110771107811079110801108111082110831108411085110861108711088110891109011091110921109311094110951109611097110981109911100111011110211103111041110511106111071110811109111101111111112111131111411115111161111711118111191112011121111221112311124111251112611127111281112911130111311113211133111341113511136111371113811139111401114111142111431114411145111461114711148111491115011151111521115311154111551115611157111581115911160111611116211163111641116511166111671116811169111701117111172111731117411175111761117711178111791118011181111821118311184111851118611187111881118911190111911119211193111941119511196111971119811199112001120111202112031120411205112061120711208112091121011211112121121311214112151121611217112181121911220112211122211223112241122511226112271122811229112301123111232112331123411235112361123711238112391124011241112421124311244112451124611247112481124911250112511125211253112541125511256112571125811259112601126111262112631126411265112661126711268112691127011271112721127311274112751127611277112781127911280112811128211283112841128511286112871128811289112901129111292112931129411295112961129711298112991130011301113021130311304113051130611307113081130911310113111131211313113141131511316113171131811319113201132111322113231132411325113261132711328113291133011331113321133311334113351133611337113381133911340113411134211343113441134511346113471134811349113501135111352113531135411355113561135711358113591136011361113621136311364113651136611367113681136911370113711137211373113741137511376113771137811379113801138111382113831138411385113861138711388113891139011391113921139311394113951139611397113981139911400114011140211403114041140511406114071140811409114101141111412114131141411415114161141711418114191142011421114221142311424114251142611427114281142911430114311143211433114341143511436114371143811439114401144111442114431144411445114461144711448114491145011451114521145311454114551145611457114581145911460114611146211463114641146511466114671146811469114701147111472114731147411475114761147711478114791148011481114821148311484114851148611487114881148911490114911149211493114941149511496114971149811499115001150111502115031150411505115061150711508115091151011511115121151311514115151151611517115181151911520115211152211523115241152511526115271152811529115301153111532115331153411535115361153711538115391154011541115421154311544115451154611547115481154911550115511155211553115541155511556115571155811559115601156111562115631156411565115661156711568115691157011571115721157311574115751157611577115781157911580115811158211583115841158511586115871158811589115901159111592115931159411595115961159711598115991160011601116021160311604116051160611607116081160911610116111161211613116141161511616116171161811619116201162111622116231162411625116261162711628116291163011631116321163311634116351163611637116381163911640116411164211643116441164511646116471164811649116501165111652116531165411655116561165711658116591166011661116621166311664116651166611667116681166911670116711167211673116741167511676116771167811679116801168111682116831168411685116861168711688116891169011691116921169311694116951169611697116981169911700117011170211703117041170511706117071170811709117101171111712117131171411715117161171711718117191172011721117221172311724117251172611727117281172911730117311173211733117341173511736117371173811739117401174111742117431174411745117461174711748117491175011751117521175311754117551175611757117581175911760117611176211763117641176511766117671176811769117701177111772117731177411775117761177711778117791178011781117821178311784117851178611787117881178911790117911179211793117941179511796117971179811799118001180111802118031180411805118061180711808118091181011811118121181311814118151181611817118181181911820118211182211823118241182511826118271182811829118301183111832118331183411835118361183711838118391184011841118421184311844118451184611847118481184911850118511185211853118541185511856118571185811859118601186111862118631186411865118661186711868118691187011871118721187311874118751187611877118781187911880118811188211883118841188511886118871188811889118901189111892118931189411895118961189711898118991190011901119021190311904119051190611907119081190911910119111191211913119141191511916119171191811919119201192111922119231192411925119261192711928119291193011931119321193311934119351193611937119381193911940119411194211943119441194511946119471194811949119501195111952119531195411955119561195711958119591196011961119621196311964119651196611967119681196911970119711197211973119741197511976119771197811979119801198111982119831198411985119861198711988119891199011991119921199311994119951199611997119981199912000120011200212003120041200512006120071200812009120101201112012120131201412015120161201712018120191202012021120221202312024120251202612027120281202912030120311203212033120341203512036120371203812039120401204112042120431204412045120461204712048120491205012051120521205312054120551205612057120581205912060120611206212063120641206512066120671206812069120701207112072120731207412075120761207712078120791208012081120821208312084120851208612087120881208912090120911209212093120941209512096120971209812099121001210112102121031210412105121061210712108121091211012111121121211312114121151211612117121181211912120121211212212123121241212512126121271212812129121301213112132121331213412135121361213712138121391214012141121421214312144121451214612147121481214912150121511215212153121541215512156121571215812159121601216112162121631216412165121661216712168121691217012171121721217312174121751217612177121781217912180121811218212183121841218512186121871218812189121901219112192121931219412195121961219712198121991220012201122021220312204122051220612207122081220912210122111221212213122141221512216122171221812219122201222112222122231222412225122261222712228122291223012231122321223312234122351223612237122381223912240122411224212243122441224512246122471224812249122501225112252122531225412255122561225712258122591226012261122621226312264122651226612267122681226912270122711227212273122741227512276122771227812279122801228112282122831228412285122861228712288122891229012291122921229312294122951229612297122981229912300123011230212303123041230512306123071230812309123101231112312123131231412315123161231712318123191232012321123221232312324123251232612327123281232912330123311233212333123341233512336123371233812339123401234112342123431234412345123461234712348123491235012351123521235312354123551235612357123581235912360123611236212363123641236512366123671236812369123701237112372123731237412375123761237712378123791238012381123821238312384123851238612387123881238912390123911239212393123941239512396123971239812399124001240112402124031240412405124061240712408124091241012411124121241312414124151241612417124181241912420124211242212423124241242512426124271242812429124301243112432124331243412435124361243712438124391244012441124421244312444124451244612447124481244912450124511245212453124541245512456124571245812459124601246112462124631246412465124661246712468124691247012471124721247312474124751247612477124781247912480124811248212483124841248512486124871248812489124901249112492124931249412495124961249712498124991250012501125021250312504125051250612507125081250912510125111251212513125141251512516125171251812519125201252112522125231252412525125261252712528125291253012531125321253312534125351253612537125381253912540125411254212543125441254512546125471254812549125501255112552125531255412555125561255712558125591256012561125621256312564125651256612567125681256912570125711257212573125741257512576125771257812579125801258112582125831258412585125861258712588125891259012591125921259312594125951259612597125981259912600126011260212603126041260512606126071260812609126101261112612126131261412615126161261712618126191262012621126221262312624126251262612627126281262912630126311263212633126341263512636126371263812639126401264112642126431264412645126461264712648126491265012651126521265312654126551265612657126581265912660126611266212663126641266512666126671266812669126701267112672126731267412675126761267712678126791268012681126821268312684126851268612687126881268912690126911269212693126941269512696126971269812699127001270112702127031270412705127061270712708127091271012711127121271312714127151271612717127181271912720127211272212723127241272512726127271272812729127301273112732127331273412735127361273712738127391274012741127421274312744127451274612747127481274912750127511275212753127541275512756127571275812759127601276112762127631276412765127661276712768127691277012771127721277312774127751277612777127781277912780127811278212783127841278512786127871278812789127901279112792127931279412795127961279712798127991280012801128021280312804128051280612807128081280912810128111281212813128141281512816128171281812819128201282112822128231282412825128261282712828128291283012831128321283312834128351283612837128381283912840128411284212843128441284512846128471284812849128501285112852128531285412855128561285712858128591286012861128621286312864128651286612867128681286912870128711287212873128741287512876128771287812879128801288112882128831288412885128861288712888128891289012891128921289312894128951289612897128981289912900129011290212903129041290512906129071290812909129101291112912129131291412915129161291712918129191292012921129221292312924129251292612927129281292912930129311293212933129341293512936129371293812939129401294112942129431294412945129461294712948129491295012951129521295312954129551295612957129581295912960129611296212963129641296512966129671296812969129701297112972129731297412975129761297712978129791298012981129821298312984129851298612987129881298912990129911299212993129941299512996129971299812999130001300113002130031300413005130061300713008130091301013011130121301313014130151301613017130181301913020130211302213023130241302513026130271302813029130301303113032130331303413035130361303713038130391304013041130421304313044130451304613047130481304913050130511305213053130541305513056130571305813059130601306113062130631306413065130661306713068130691307013071130721307313074130751307613077130781307913080130811308213083130841308513086130871308813089130901309113092130931309413095130961309713098130991310013101131021310313104131051310613107131081310913110131111311213113131141311513116131171311813119131201312113122131231312413125131261312713128131291313013131131321313313134131351313613137131381313913140131411314213143131441314513146131471314813149131501315113152131531315413155131561315713158131591316013161131621316313164131651316613167131681316913170131711317213173131741317513176131771317813179131801318113182131831318413185131861318713188131891319013191131921319313194131951319613197131981319913200132011320213203132041320513206132071320813209132101321113212132131321413215132161321713218132191322013221132221322313224132251322613227132281322913230132311323213233132341323513236132371323813239132401324113242132431324413245132461324713248132491325013251132521325313254132551325613257132581325913260132611326213263132641326513266132671326813269132701327113272132731327413275132761327713278132791328013281132821328313284132851328613287132881328913290132911329213293132941329513296132971329813299133001330113302133031330413305133061330713308133091331013311133121331313314133151331613317133181331913320133211332213323133241332513326133271332813329133301333113332133331333413335133361333713338133391334013341133421334313344133451334613347133481334913350133511335213353133541335513356133571335813359133601336113362133631336413365133661336713368133691337013371133721337313374133751337613377133781337913380133811338213383133841338513386133871338813389133901339113392133931339413395133961339713398133991340013401134021340313404134051340613407134081340913410134111341213413134141341513416134171341813419134201342113422134231342413425134261342713428134291343013431134321343313434134351343613437134381343913440134411344213443134441344513446134471344813449134501345113452134531345413455134561345713458134591346013461134621346313464134651346613467134681346913470134711347213473134741347513476134771347813479134801348113482134831348413485134861348713488134891349013491134921349313494134951349613497134981349913500135011350213503135041350513506135071350813509135101351113512135131351413515135161351713518135191352013521135221352313524135251352613527135281352913530135311353213533135341353513536135371353813539135401354113542135431354413545135461354713548135491355013551135521355313554135551355613557135581355913560135611356213563135641356513566135671356813569135701357113572135731357413575135761357713578135791358013581135821358313584135851358613587135881358913590135911359213593135941359513596135971359813599136001360113602136031360413605136061360713608136091361013611136121361313614136151361613617136181361913620136211362213623136241362513626136271362813629136301363113632136331363413635136361363713638136391364013641136421364313644136451364613647136481364913650136511365213653136541365513656136571365813659136601366113662136631366413665136661366713668136691367013671136721367313674136751367613677136781367913680136811368213683136841368513686136871368813689136901369113692136931369413695136961369713698136991370013701137021370313704137051370613707137081370913710137111371213713137141371513716137171371813719137201372113722137231372413725137261372713728137291373013731137321373313734137351373613737137381373913740137411374213743137441374513746137471374813749137501375113752137531375413755137561375713758137591376013761137621376313764137651376613767137681376913770137711377213773137741377513776137771377813779137801378113782137831378413785137861378713788137891379013791137921379313794137951379613797137981379913800138011380213803138041380513806138071380813809138101381113812138131381413815138161381713818138191382013821138221382313824138251382613827138281382913830138311383213833138341383513836138371383813839138401384113842138431384413845138461384713848138491385013851138521385313854138551385613857138581385913860138611386213863138641386513866138671386813869138701387113872138731387413875138761387713878138791388013881138821388313884138851388613887138881388913890138911389213893138941389513896138971389813899139001390113902139031390413905139061390713908139091391013911139121391313914139151391613917139181391913920139211392213923139241392513926139271392813929139301393113932139331393413935139361393713938139391394013941139421394313944139451394613947139481394913950139511395213953139541395513956139571395813959139601396113962139631396413965139661396713968139691397013971139721397313974139751397613977139781397913980139811398213983139841398513986139871398813989139901399113992139931399413995139961399713998139991400014001140021400314004140051400614007140081400914010140111401214013140141401514016140171401814019140201402114022140231402414025140261402714028140291403014031140321403314034140351403614037140381403914040140411404214043140441404514046140471404814049140501405114052140531405414055140561405714058140591406014061140621406314064140651406614067140681406914070140711407214073140741407514076140771407814079140801408114082140831408414085140861408714088140891409014091140921409314094140951409614097140981409914100141011410214103141041410514106141071410814109141101411114112141131411414115141161411714118141191412014121141221412314124141251412614127141281412914130141311413214133141341413514136141371413814139141401414114142141431414414145141461414714148141491415014151141521415314154141551415614157141581415914160141611416214163141641416514166141671416814169141701417114172141731417414175141761417714178141791418014181141821418314184141851418614187141881418914190141911419214193141941419514196141971419814199142001420114202142031420414205142061420714208142091421014211142121421314214142151421614217142181421914220142211422214223142241422514226142271422814229142301423114232142331423414235142361423714238142391424014241142421424314244142451424614247142481424914250142511425214253142541425514256142571425814259142601426114262142631426414265142661426714268142691427014271142721427314274142751427614277142781427914280142811428214283142841428514286142871428814289142901429114292142931429414295142961429714298142991430014301143021430314304143051430614307143081430914310143111431214313143141431514316143171431814319143201432114322143231432414325143261432714328143291433014331143321433314334143351433614337143381433914340143411434214343143441434514346143471434814349143501435114352143531435414355143561435714358143591436014361143621436314364143651436614367143681436914370143711437214373143741437514376143771437814379143801438114382143831438414385143861438714388143891439014391143921439314394143951439614397143981439914400144011440214403144041440514406144071440814409144101441114412144131441414415144161441714418144191442014421144221442314424144251442614427144281442914430144311443214433144341443514436144371443814439144401444114442144431444414445144461444714448144491445014451144521445314454144551445614457144581445914460144611446214463144641446514466144671446814469144701447114472144731447414475144761447714478144791448014481144821448314484144851448614487144881448914490144911449214493144941449514496144971449814499145001450114502145031450414505145061450714508145091451014511145121451314514145151451614517145181451914520145211452214523145241452514526145271452814529145301453114532145331453414535145361453714538145391454014541145421454314544145451454614547145481454914550145511455214553145541455514556145571455814559145601456114562145631456414565145661456714568145691457014571145721457314574145751457614577145781457914580145811458214583145841458514586145871458814589145901459114592145931459414595145961459714598145991460014601146021460314604146051460614607146081460914610146111461214613146141461514616146171461814619146201462114622146231462414625146261462714628146291463014631146321463314634146351463614637146381463914640146411464214643146441464514646146471464814649146501465114652146531465414655146561465714658146591466014661146621466314664146651466614667146681466914670146711467214673146741467514676146771467814679146801468114682146831468414685146861468714688146891469014691146921469314694146951469614697146981469914700147011470214703147041470514706147071470814709147101471114712147131471414715147161471714718147191472014721147221472314724147251472614727147281472914730147311473214733147341473514736147371473814739147401474114742147431474414745147461474714748147491475014751147521475314754147551475614757147581475914760147611476214763147641476514766147671476814769147701477114772147731477414775147761477714778147791478014781147821478314784147851478614787147881478914790147911479214793147941479514796147971479814799148001480114802148031480414805148061480714808148091481014811148121481314814148151481614817148181481914820148211482214823148241482514826148271482814829148301483114832148331483414835148361483714838148391484014841148421484314844148451484614847148481484914850148511485214853148541485514856148571485814859148601486114862148631486414865148661486714868148691487014871148721487314874148751487614877148781487914880148811488214883148841488514886148871488814889148901489114892148931489414895148961489714898148991490014901149021490314904149051490614907149081490914910149111491214913149141491514916149171491814919149201492114922149231492414925149261492714928149291493014931149321493314934149351493614937149381493914940149411494214943149441494514946149471494814949149501495114952149531495414955149561495714958149591496014961149621496314964149651496614967149681496914970149711497214973149741497514976149771497814979149801498114982149831498414985149861498714988149891499014991149921499314994149951499614997149981499915000150011500215003150041500515006150071500815009150101501115012150131501415015150161501715018150191502015021150221502315024150251502615027150281502915030150311503215033150341503515036150371503815039150401504115042150431504415045150461504715048150491505015051150521505315054150551505615057150581505915060150611506215063150641506515066150671506815069150701507115072150731507415075150761507715078150791508015081150821508315084150851508615087150881508915090150911509215093150941509515096150971509815099151001510115102151031510415105151061510715108151091511015111151121511315114151151511615117151181511915120151211512215123151241512515126151271512815129151301513115132151331513415135151361513715138151391514015141151421514315144151451514615147151481514915150151511515215153151541515515156151571515815159151601516115162151631516415165151661516715168151691517015171151721517315174151751517615177151781517915180151811518215183151841518515186151871518815189151901519115192151931519415195151961519715198151991520015201152021520315204152051520615207152081520915210152111521215213152141521515216152171521815219152201522115222152231522415225152261522715228152291523015231152321523315234152351523615237152381523915240152411524215243152441524515246152471524815249152501525115252152531525415255152561525715258152591526015261152621526315264152651526615267152681526915270152711527215273152741527515276152771527815279152801528115282152831528415285152861528715288152891529015291152921529315294152951529615297152981529915300153011530215303153041530515306153071530815309153101531115312153131531415315153161531715318153191532015321153221532315324153251532615327153281532915330153311533215333153341533515336153371533815339153401534115342153431534415345153461534715348153491535015351153521535315354153551535615357153581535915360153611536215363153641536515366153671536815369153701537115372153731537415375153761537715378153791538015381153821538315384153851538615387153881538915390153911539215393153941539515396153971539815399154001540115402154031540415405154061540715408154091541015411154121541315414154151541615417154181541915420154211542215423154241542515426154271542815429154301543115432154331543415435154361543715438154391544015441154421544315444154451544615447154481544915450154511545215453154541545515456154571545815459154601546115462154631546415465154661546715468154691547015471154721547315474154751547615477154781547915480154811548215483154841548515486154871548815489154901549115492154931549415495154961549715498154991550015501155021550315504155051550615507155081550915510155111551215513155141551515516155171551815519155201552115522155231552415525155261552715528155291553015531155321553315534155351553615537155381553915540155411554215543155441554515546155471554815549155501555115552155531555415555155561555715558155591556015561155621556315564155651556615567155681556915570155711557215573155741557515576155771557815579155801558115582155831558415585155861558715588155891559015591155921559315594155951559615597155981559915600156011560215603156041560515606156071560815609156101561115612156131561415615156161561715618156191562015621156221562315624156251562615627156281562915630156311563215633156341563515636156371563815639156401564115642156431564415645156461564715648156491565015651156521565315654156551565615657156581565915660156611566215663156641566515666156671566815669156701567115672156731567415675156761567715678156791568015681156821568315684156851568615687156881568915690156911569215693156941569515696156971569815699157001570115702157031570415705157061570715708157091571015711157121571315714157151571615717157181571915720157211572215723157241572515726157271572815729157301573115732157331573415735157361573715738157391574015741157421574315744157451574615747157481574915750157511575215753157541575515756157571575815759157601576115762157631576415765157661576715768157691577015771157721577315774157751577615777157781577915780157811578215783157841578515786157871578815789157901579115792157931579415795157961579715798157991580015801158021580315804158051580615807158081580915810158111581215813158141581515816158171581815819158201582115822158231582415825158261582715828158291583015831158321583315834158351583615837158381583915840158411584215843158441584515846158471584815849158501585115852158531585415855158561585715858158591586015861158621586315864158651586615867158681586915870158711587215873158741587515876158771587815879158801588115882158831588415885158861588715888158891589015891158921589315894158951589615897158981589915900159011590215903159041590515906159071590815909159101591115912159131591415915159161591715918159191592015921159221592315924159251592615927159281592915930159311593215933159341593515936159371593815939159401594115942159431594415945159461594715948159491595015951159521595315954159551595615957159581595915960159611596215963159641596515966159671596815969159701597115972159731597415975159761597715978159791598015981159821598315984159851598615987159881598915990159911599215993159941599515996159971599815999160001600116002160031600416005160061600716008160091601016011160121601316014160151601616017160181601916020160211602216023160241602516026160271602816029160301603116032160331603416035160361603716038160391604016041160421604316044160451604616047160481604916050160511605216053160541605516056160571605816059160601606116062160631606416065160661606716068160691607016071160721607316074160751607616077160781607916080160811608216083160841608516086160871608816089160901609116092160931609416095160961609716098160991610016101161021610316104161051610616107161081610916110161111611216113161141611516116161171611816119161201612116122161231612416125161261612716128161291613016131161321613316134161351613616137161381613916140161411614216143161441614516146161471614816149161501615116152161531615416155161561615716158161591616016161161621616316164161651616616167161681616916170161711617216173161741617516176161771617816179161801618116182161831618416185161861618716188161891619016191161921619316194161951619616197161981619916200162011620216203162041620516206162071620816209162101621116212162131621416215162161621716218162191622016221162221622316224162251622616227162281622916230162311623216233162341623516236162371623816239162401624116242162431624416245162461624716248162491625016251162521625316254162551625616257162581625916260162611626216263162641626516266162671626816269162701627116272162731627416275162761627716278162791628016281162821628316284162851628616287162881628916290162911629216293162941629516296162971629816299163001630116302163031630416305163061630716308163091631016311163121631316314163151631616317163181631916320163211632216323163241632516326163271632816329163301633116332163331633416335163361633716338163391634016341163421634316344163451634616347163481634916350163511635216353163541635516356163571635816359163601636116362163631636416365163661636716368163691637016371163721637316374163751637616377163781637916380163811638216383163841638516386163871638816389163901639116392163931639416395163961639716398163991640016401164021640316404164051640616407164081640916410164111641216413164141641516416164171641816419164201642116422164231642416425164261642716428164291643016431164321643316434164351643616437164381643916440164411644216443164441644516446164471644816449164501645116452164531645416455164561645716458164591646016461164621646316464164651646616467164681646916470164711647216473164741647516476164771647816479164801648116482164831648416485164861648716488164891649016491164921649316494164951649616497164981649916500165011650216503165041650516506165071650816509165101651116512165131651416515165161651716518165191652016521165221652316524165251652616527165281652916530165311653216533165341653516536165371653816539165401654116542165431654416545165461654716548165491655016551165521655316554165551655616557165581655916560165611656216563165641656516566165671656816569165701657116572165731657416575165761657716578165791658016581165821658316584165851658616587165881658916590165911659216593165941659516596165971659816599166001660116602166031660416605166061660716608166091661016611166121661316614166151661616617166181661916620166211662216623166241662516626166271662816629166301663116632166331663416635166361663716638166391664016641166421664316644166451664616647166481664916650166511665216653166541665516656166571665816659166601666116662166631666416665166661666716668166691667016671166721667316674166751667616677166781667916680166811668216683166841668516686166871668816689166901669116692166931669416695166961669716698166991670016701167021670316704167051670616707167081670916710167111671216713167141671516716167171671816719167201672116722167231672416725167261672716728167291673016731167321673316734167351673616737167381673916740167411674216743167441674516746167471674816749167501675116752167531675416755167561675716758167591676016761167621676316764167651676616767167681676916770167711677216773167741677516776167771677816779167801678116782167831678416785167861678716788167891679016791167921679316794167951679616797167981679916800168011680216803168041680516806168071680816809168101681116812168131681416815168161681716818168191682016821168221682316824168251682616827168281682916830168311683216833168341683516836168371683816839168401684116842168431684416845168461684716848168491685016851168521685316854168551685616857168581685916860168611686216863168641686516866168671686816869168701687116872168731687416875168761687716878168791688016881168821688316884168851688616887168881688916890168911689216893168941689516896168971689816899169001690116902169031690416905169061690716908169091691016911169121691316914169151691616917169181691916920169211692216923169241692516926169271692816929169301693116932169331693416935169361693716938169391694016941169421694316944169451694616947169481694916950169511695216953169541695516956169571695816959169601696116962169631696416965169661696716968169691697016971169721697316974169751697616977169781697916980169811698216983169841698516986169871698816989169901699116992169931699416995169961699716998169991700017001170021700317004170051700617007170081700917010170111701217013170141701517016170171701817019170201702117022170231702417025170261702717028170291703017031170321703317034170351703617037170381703917040170411704217043170441704517046170471704817049170501705117052170531705417055170561705717058170591706017061170621706317064170651706617067170681706917070170711707217073170741707517076170771707817079170801708117082170831708417085170861708717088170891709017091170921709317094170951709617097170981709917100171011710217103171041710517106171071710817109171101711117112171131711417115171161711717118171191712017121171221712317124171251712617127171281712917130171311713217133171341713517136171371713817139171401714117142171431714417145171461714717148171491715017151171521715317154171551715617157171581715917160171611716217163171641716517166171671716817169171701717117172171731717417175171761717717178171791718017181171821718317184171851718617187171881718917190171911719217193171941719517196171971719817199172001720117202172031720417205172061720717208172091721017211172121721317214172151721617217172181721917220172211722217223172241722517226172271722817229172301723117232172331723417235172361723717238172391724017241172421724317244172451724617247172481724917250172511725217253172541725517256172571725817259172601726117262172631726417265172661726717268172691727017271172721727317274172751727617277172781727917280172811728217283172841728517286172871728817289172901729117292172931729417295172961729717298172991730017301173021730317304173051730617307173081730917310173111731217313173141731517316173171731817319173201732117322173231732417325173261732717328173291733017331173321733317334173351733617337173381733917340173411734217343173441734517346173471734817349173501735117352173531735417355173561735717358173591736017361173621736317364173651736617367173681736917370173711737217373173741737517376173771737817379173801738117382173831738417385173861738717388173891739017391173921739317394173951739617397173981739917400174011740217403174041740517406174071740817409174101741117412174131741417415174161741717418174191742017421174221742317424174251742617427174281742917430174311743217433174341743517436174371743817439174401744117442174431744417445174461744717448174491745017451174521745317454174551745617457174581745917460174611746217463174641746517466174671746817469174701747117472174731747417475174761747717478174791748017481174821748317484174851748617487174881748917490174911749217493174941749517496174971749817499175001750117502175031750417505175061750717508175091751017511175121751317514175151751617517175181751917520175211752217523175241752517526175271752817529175301753117532175331753417535175361753717538175391754017541175421754317544175451754617547175481754917550175511755217553175541755517556175571755817559175601756117562175631756417565175661756717568175691757017571175721757317574175751757617577175781757917580175811758217583175841758517586175871758817589175901759117592175931759417595175961759717598175991760017601176021760317604176051760617607176081760917610176111761217613176141761517616176171761817619176201762117622176231762417625176261762717628176291763017631176321763317634176351763617637176381763917640176411764217643176441764517646176471764817649176501765117652176531765417655176561765717658176591766017661176621766317664176651766617667176681766917670176711767217673176741767517676176771767817679176801768117682176831768417685176861768717688176891769017691176921769317694176951769617697176981769917700177011770217703177041770517706177071770817709177101771117712177131771417715177161771717718177191772017721177221772317724177251772617727177281772917730177311773217733177341773517736177371773817739177401774117742177431774417745177461774717748177491775017751177521775317754177551775617757177581775917760177611776217763177641776517766177671776817769177701777117772177731777417775177761777717778177791778017781177821778317784177851778617787177881778917790177911779217793177941779517796177971779817799178001780117802178031780417805178061780717808178091781017811178121781317814178151781617817178181781917820178211782217823178241782517826178271782817829178301783117832178331783417835178361783717838178391784017841178421784317844178451784617847178481784917850178511785217853178541785517856178571785817859178601786117862178631786417865178661786717868178691787017871178721787317874178751787617877178781787917880178811788217883178841788517886178871788817889178901789117892178931789417895178961789717898178991790017901179021790317904179051790617907179081790917910179111791217913179141791517916179171791817919179201792117922179231792417925179261792717928179291793017931179321793317934179351793617937179381793917940179411794217943179441794517946179471794817949179501795117952179531795417955179561795717958179591796017961179621796317964179651796617967179681796917970179711797217973179741797517976179771797817979179801798117982179831798417985179861798717988179891799017991179921799317994179951799617997179981799918000180011800218003180041800518006180071800818009180101801118012180131801418015180161801718018180191802018021180221802318024180251802618027180281802918030180311803218033180341803518036180371803818039180401804118042180431804418045180461804718048180491805018051180521805318054180551805618057180581805918060180611806218063180641806518066180671806818069180701807118072180731807418075180761807718078180791808018081180821808318084180851808618087180881808918090180911809218093180941809518096180971809818099181001810118102181031810418105181061810718108181091811018111181121811318114181151811618117181181811918120181211812218123181241812518126181271812818129181301813118132181331813418135181361813718138181391814018141181421814318144181451814618147181481814918150181511815218153181541815518156181571815818159181601816118162181631816418165181661816718168181691817018171181721817318174181751817618177181781817918180181811818218183181841818518186181871818818189181901819118192181931819418195181961819718198181991820018201182021820318204182051820618207182081820918210182111821218213182141821518216182171821818219182201822118222182231822418225182261822718228182291823018231182321823318234182351823618237182381823918240182411824218243182441824518246182471824818249182501825118252182531825418255182561825718258182591826018261182621826318264182651826618267182681826918270182711827218273182741827518276182771827818279182801828118282182831828418285182861828718288182891829018291182921829318294182951829618297182981829918300183011830218303183041830518306183071830818309183101831118312183131831418315183161831718318183191832018321183221832318324183251832618327183281832918330183311833218333183341833518336183371833818339183401834118342183431834418345183461834718348183491835018351183521835318354183551835618357183581835918360183611836218363183641836518366183671836818369183701837118372183731837418375183761837718378183791838018381183821838318384183851838618387183881838918390183911839218393183941839518396183971839818399184001840118402184031840418405184061840718408184091841018411184121841318414184151841618417184181841918420184211842218423184241842518426184271842818429184301843118432184331843418435184361843718438184391844018441184421844318444184451844618447184481844918450184511845218453184541845518456184571845818459184601846118462184631846418465184661846718468184691847018471184721847318474184751847618477184781847918480184811848218483184841848518486184871848818489184901849118492184931849418495184961849718498184991850018501185021850318504185051850618507185081850918510185111851218513185141851518516185171851818519185201852118522185231852418525185261852718528185291853018531185321853318534185351853618537185381853918540185411854218543185441854518546185471854818549185501855118552185531855418555185561855718558185591856018561185621856318564185651856618567185681856918570185711857218573185741857518576185771857818579185801858118582185831858418585185861858718588185891859018591185921859318594185951859618597185981859918600186011860218603186041860518606186071860818609186101861118612186131861418615186161861718618186191862018621186221862318624186251862618627186281862918630186311863218633186341863518636186371863818639186401864118642186431864418645186461864718648186491865018651186521865318654186551865618657186581865918660186611866218663186641866518666186671866818669186701867118672186731867418675186761867718678186791868018681186821868318684186851868618687186881868918690186911869218693186941869518696186971869818699187001870118702187031870418705187061870718708187091871018711187121871318714187151871618717187181871918720187211872218723187241872518726187271872818729187301873118732187331873418735187361873718738187391874018741187421874318744187451874618747187481874918750187511875218753187541875518756187571875818759187601876118762187631876418765187661876718768187691877018771187721877318774187751877618777187781877918780187811878218783187841878518786187871878818789187901879118792187931879418795187961879718798187991880018801188021880318804188051880618807188081880918810188111881218813188141881518816188171881818819188201882118822188231882418825188261882718828188291883018831188321883318834188351883618837188381883918840188411884218843188441884518846188471884818849188501885118852188531885418855188561885718858188591886018861188621886318864188651886618867188681886918870188711887218873188741887518876188771887818879188801888118882188831888418885188861888718888188891889018891188921889318894188951889618897188981889918900189011890218903189041890518906189071890818909189101891118912189131891418915189161891718918189191892018921189221892318924189251892618927189281892918930189311893218933189341893518936189371893818939189401894118942189431894418945189461894718948189491895018951189521895318954189551895618957189581895918960189611896218963189641896518966189671896818969189701897118972189731897418975189761897718978189791898018981189821898318984189851898618987189881898918990189911899218993189941899518996189971899818999190001900119002190031900419005190061900719008190091901019011190121901319014190151901619017190181901919020190211902219023190241902519026190271902819029190301903119032190331903419035190361903719038190391904019041190421904319044190451904619047190481904919050190511905219053190541905519056190571905819059190601906119062190631906419065190661906719068190691907019071190721907319074190751907619077190781907919080190811908219083190841908519086190871908819089190901909119092190931909419095190961909719098190991910019101191021910319104191051910619107191081910919110191111911219113191141911519116191171911819119191201912119122191231912419125191261912719128191291913019131191321913319134191351913619137191381913919140191411914219143191441914519146191471914819149191501915119152191531915419155191561915719158191591916019161191621916319164191651916619167191681916919170191711917219173191741917519176191771917819179191801918119182191831918419185191861918719188191891919019191191921919319194191951919619197191981919919200192011920219203192041920519206192071920819209192101921119212192131921419215192161921719218192191922019221192221922319224192251922619227192281922919230192311923219233192341923519236192371923819239192401924119242192431924419245192461924719248192491925019251192521925319254192551925619257192581925919260192611926219263192641926519266192671926819269192701927119272192731927419275192761927719278192791928019281192821928319284192851928619287192881928919290192911929219293192941929519296192971929819299193001930119302193031930419305193061930719308193091931019311193121931319314193151931619317193181931919320193211932219323193241932519326193271932819329193301933119332193331933419335193361933719338193391934019341193421934319344193451934619347193481934919350193511935219353193541935519356193571935819359193601936119362193631936419365193661936719368193691937019371193721937319374193751937619377193781937919380193811938219383193841938519386193871938819389193901939119392193931939419395193961939719398193991940019401194021940319404194051940619407194081940919410194111941219413194141941519416194171941819419194201942119422194231942419425194261942719428194291943019431194321943319434194351943619437194381943919440194411944219443194441944519446194471944819449194501945119452194531945419455194561945719458194591946019461194621946319464194651946619467194681946919470194711947219473194741947519476194771947819479194801948119482194831948419485194861948719488194891949019491194921949319494194951949619497194981949919500195011950219503195041950519506195071950819509195101951119512195131951419515195161951719518195191952019521195221952319524195251952619527195281952919530195311953219533195341953519536195371953819539195401954119542195431954419545195461954719548195491955019551195521955319554195551955619557195581955919560195611956219563195641956519566195671956819569195701957119572195731957419575195761957719578195791958019581195821958319584195851958619587195881958919590195911959219593195941959519596195971959819599196001960119602196031960419605196061960719608196091961019611196121961319614196151961619617196181961919620196211962219623196241962519626196271962819629196301963119632196331963419635196361963719638196391964019641196421964319644196451964619647196481964919650196511965219653196541965519656196571965819659196601966119662196631966419665196661966719668196691967019671196721967319674196751967619677196781967919680196811968219683196841968519686196871968819689196901969119692196931969419695196961969719698196991970019701197021970319704197051970619707197081970919710197111971219713197141971519716197171971819719197201972119722197231972419725197261972719728197291973019731197321973319734197351973619737197381973919740197411974219743197441974519746197471974819749197501975119752197531975419755197561975719758197591976019761197621976319764197651976619767197681976919770197711977219773197741977519776197771977819779197801978119782197831978419785197861978719788197891979019791197921979319794197951979619797197981979919800198011980219803198041980519806198071980819809198101981119812198131981419815198161981719818198191982019821198221982319824198251982619827198281982919830198311983219833198341983519836198371983819839198401984119842198431984419845198461984719848198491985019851198521985319854198551985619857198581985919860198611986219863198641986519866198671986819869198701987119872198731987419875198761987719878198791988019881198821988319884198851988619887198881988919890198911989219893198941989519896198971989819899199001990119902199031990419905199061990719908199091991019911199121991319914199151991619917199181991919920199211992219923199241992519926199271992819929199301993119932199331993419935199361993719938199391994019941199421994319944199451994619947199481994919950199511995219953199541995519956199571995819959199601996119962199631996419965199661996719968199691997019971199721997319974199751997619977199781997919980199811998219983199841998519986199871998819989199901999119992199931999419995199961999719998199992000020001200022000320004200052000620007200082000920010200112001220013200142001520016200172001820019200202002120022200232002420025200262002720028200292003020031200322003320034200352003620037200382003920040200412004220043200442004520046200472004820049200502005120052200532005420055200562005720058200592006020061200622006320064200652006620067200682006920070200712007220073200742007520076200772007820079200802008120082200832008420085200862008720088200892009020091200922009320094200952009620097200982009920100201012010220103201042010520106201072010820109201102011120112201132011420115201162011720118201192012020121201222012320124201252012620127201282012920130201312013220133201342013520136201372013820139201402014120142201432014420145201462014720148201492015020151201522015320154201552015620157201582015920160201612016220163201642016520166201672016820169201702017120172201732017420175201762017720178201792018020181201822018320184201852018620187201882018920190201912019220193201942019520196201972019820199202002020120202202032020420205202062020720208202092021020211202122021320214202152021620217202182021920220202212022220223202242022520226202272022820229202302023120232202332023420235202362023720238202392024020241202422024320244202452024620247202482024920250202512025220253202542025520256202572025820259202602026120262202632026420265202662026720268202692027020271202722027320274202752027620277202782027920280202812028220283202842028520286202872028820289202902029120292202932029420295202962029720298202992030020301203022030320304203052030620307203082030920310203112031220313203142031520316203172031820319203202032120322203232032420325203262032720328203292033020331203322033320334203352033620337203382033920340203412034220343203442034520346203472034820349203502035120352203532035420355203562035720358203592036020361203622036320364203652036620367203682036920370203712037220373203742037520376203772037820379203802038120382203832038420385203862038720388203892039020391203922039320394203952039620397203982039920400204012040220403204042040520406204072040820409204102041120412204132041420415204162041720418204192042020421204222042320424204252042620427204282042920430204312043220433204342043520436204372043820439204402044120442204432044420445204462044720448204492045020451204522045320454204552045620457204582045920460204612046220463204642046520466204672046820469204702047120472204732047420475204762047720478204792048020481204822048320484204852048620487204882048920490204912049220493204942049520496204972049820499205002050120502205032050420505205062050720508205092051020511205122051320514205152051620517205182051920520205212052220523205242052520526205272052820529205302053120532205332053420535205362053720538205392054020541205422054320544205452054620547205482054920550205512055220553205542055520556205572055820559205602056120562205632056420565205662056720568205692057020571205722057320574205752057620577205782057920580205812058220583205842058520586205872058820589205902059120592205932059420595205962059720598205992060020601206022060320604206052060620607206082060920610206112061220613206142061520616206172061820619206202062120622206232062420625206262062720628206292063020631206322063320634206352063620637206382063920640206412064220643206442064520646206472064820649206502065120652206532065420655206562065720658206592066020661206622066320664206652066620667206682066920670206712067220673206742067520676206772067820679206802068120682206832068420685206862068720688206892069020691206922069320694206952069620697206982069920700207012070220703207042070520706207072070820709207102071120712207132071420715207162071720718207192072020721207222072320724207252072620727207282072920730207312073220733207342073520736207372073820739207402074120742207432074420745207462074720748207492075020751207522075320754207552075620757207582075920760207612076220763207642076520766207672076820769207702077120772207732077420775207762077720778207792078020781207822078320784207852078620787207882078920790207912079220793207942079520796207972079820799208002080120802208032080420805208062080720808208092081020811208122081320814208152081620817208182081920820208212082220823208242082520826208272082820829208302083120832208332083420835208362083720838208392084020841208422084320844208452084620847208482084920850208512085220853208542085520856208572085820859208602086120862208632086420865208662086720868208692087020871208722087320874208752087620877208782087920880208812088220883208842088520886208872088820889208902089120892208932089420895208962089720898208992090020901209022090320904209052090620907209082090920910209112091220913209142091520916209172091820919209202092120922209232092420925209262092720928209292093020931209322093320934209352093620937209382093920940209412094220943209442094520946209472094820949209502095120952209532095420955209562095720958209592096020961209622096320964209652096620967209682096920970209712097220973209742097520976209772097820979209802098120982209832098420985209862098720988209892099020991209922099320994209952099620997209982099921000210012100221003210042100521006210072100821009210102101121012210132101421015210162101721018210192102021021210222102321024210252102621027210282102921030210312103221033210342103521036210372103821039210402104121042210432104421045210462104721048210492105021051210522105321054210552105621057210582105921060210612106221063210642106521066210672106821069210702107121072210732107421075210762107721078210792108021081210822108321084210852108621087210882108921090210912109221093210942109521096210972109821099211002110121102211032110421105211062110721108211092111021111211122111321114211152111621117211182111921120211212112221123211242112521126211272112821129211302113121132211332113421135211362113721138211392114021141211422114321144211452114621147211482114921150211512115221153211542115521156211572115821159211602116121162211632116421165211662116721168211692117021171211722117321174211752117621177211782117921180211812118221183211842118521186211872118821189211902119121192211932119421195211962119721198211992120021201212022120321204212052120621207212082120921210212112121221213212142121521216212172121821219212202122121222212232122421225212262122721228212292123021231212322123321234212352123621237212382123921240212412124221243212442124521246212472124821249212502125121252212532125421255212562125721258212592126021261212622126321264212652126621267212682126921270212712127221273212742127521276212772127821279212802128121282212832128421285212862128721288212892129021291212922129321294212952129621297212982129921300213012130221303213042130521306213072130821309213102131121312213132131421315213162131721318213192132021321213222132321324213252132621327213282132921330213312133221333213342133521336213372133821339213402134121342213432134421345213462134721348213492135021351213522135321354213552135621357213582135921360213612136221363213642136521366213672136821369213702137121372213732137421375213762137721378213792138021381213822138321384213852138621387213882138921390213912139221393213942139521396213972139821399214002140121402214032140421405214062140721408214092141021411214122141321414214152141621417214182141921420214212142221423214242142521426214272142821429214302143121432214332143421435214362143721438214392144021441214422144321444214452144621447214482144921450214512145221453214542145521456214572145821459214602146121462214632146421465214662146721468214692147021471214722147321474214752147621477214782147921480214812148221483214842148521486214872148821489214902149121492214932149421495214962149721498214992150021501215022150321504215052150621507215082150921510215112151221513215142151521516215172151821519215202152121522215232152421525215262152721528215292153021531215322153321534215352153621537215382153921540215412154221543215442154521546215472154821549215502155121552215532155421555215562155721558215592156021561215622156321564215652156621567215682156921570215712157221573215742157521576215772157821579215802158121582215832158421585215862158721588215892159021591215922159321594215952159621597215982159921600216012160221603216042160521606216072160821609216102161121612216132161421615216162161721618216192162021621216222162321624216252162621627216282162921630216312163221633216342163521636216372163821639216402164121642216432164421645216462164721648216492165021651216522165321654216552165621657216582165921660216612166221663216642166521666216672166821669216702167121672216732167421675216762167721678216792168021681216822168321684216852168621687216882168921690216912169221693216942169521696216972169821699217002170121702217032170421705217062170721708217092171021711217122171321714217152171621717217182171921720217212172221723217242172521726217272172821729217302173121732217332173421735217362173721738217392174021741217422174321744217452174621747217482174921750217512175221753217542175521756217572175821759217602176121762217632176421765217662176721768217692177021771217722177321774217752177621777217782177921780217812178221783217842178521786217872178821789217902179121792217932179421795217962179721798217992180021801218022180321804218052180621807218082180921810218112181221813218142181521816218172181821819218202182121822218232182421825218262182721828218292183021831218322183321834218352183621837218382183921840218412184221843218442184521846218472184821849218502185121852218532185421855218562185721858218592186021861218622186321864218652186621867218682186921870218712187221873218742187521876218772187821879218802188121882218832188421885218862188721888218892189021891218922189321894218952189621897218982189921900219012190221903219042190521906219072190821909219102191121912219132191421915219162191721918219192192021921219222192321924219252192621927219282192921930219312193221933219342193521936219372193821939219402194121942219432194421945219462194721948219492195021951219522195321954219552195621957219582195921960219612196221963219642196521966219672196821969219702197121972219732197421975219762197721978219792198021981219822198321984219852198621987219882198921990219912199221993219942199521996219972199821999220002200122002220032200422005220062200722008220092201022011220122201322014220152201622017220182201922020220212202222023220242202522026220272202822029220302203122032220332203422035220362203722038220392204022041220422204322044220452204622047220482204922050220512205222053220542205522056220572205822059220602206122062220632206422065220662206722068220692207022071220722207322074220752207622077220782207922080220812208222083220842208522086220872208822089220902209122092220932209422095220962209722098220992210022101221022210322104221052210622107221082210922110221112211222113221142211522116221172211822119221202212122122221232212422125221262212722128221292213022131221322213322134221352213622137221382213922140221412214222143221442214522146221472214822149221502215122152221532215422155221562215722158221592216022161221622216322164221652216622167221682216922170221712217222173221742217522176221772217822179221802218122182221832218422185221862218722188221892219022191221922219322194221952219622197221982219922200222012220222203222042220522206222072220822209222102221122212222132221422215222162221722218222192222022221222222222322224222252222622227222282222922230222312223222233222342223522236222372223822239222402224122242222432224422245222462224722248222492225022251222522225322254222552225622257222582225922260222612226222263222642226522266222672226822269222702227122272222732227422275222762227722278222792228022281222822228322284222852228622287222882228922290222912229222293222942229522296222972229822299223002230122302223032230422305223062230722308223092231022311223122231322314223152231622317223182231922320223212232222323223242232522326223272232822329223302233122332223332233422335223362233722338223392234022341223422234322344223452234622347223482234922350223512235222353223542235522356223572235822359223602236122362223632236422365223662236722368223692237022371223722237322374223752237622377223782237922380223812238222383223842238522386223872238822389223902239122392223932239422395223962239722398223992240022401224022240322404224052240622407224082240922410224112241222413224142241522416224172241822419224202242122422224232242422425224262242722428224292243022431224322243322434224352243622437224382243922440224412244222443224442244522446224472244822449224502245122452224532245422455224562245722458224592246022461224622246322464224652246622467224682246922470224712247222473224742247522476224772247822479224802248122482224832248422485224862248722488224892249022491224922249322494224952249622497224982249922500225012250222503225042250522506225072250822509225102251122512225132251422515225162251722518225192252022521225222252322524225252252622527225282252922530225312253222533225342253522536225372253822539225402254122542225432254422545225462254722548225492255022551225522255322554225552255622557225582255922560225612256222563225642256522566225672256822569225702257122572225732257422575225762257722578225792258022581225822258322584225852258622587225882258922590225912259222593225942259522596225972259822599226002260122602226032260422605226062260722608226092261022611226122261322614226152261622617226182261922620226212262222623226242262522626226272262822629226302263122632226332263422635226362263722638226392264022641226422264322644226452264622647226482264922650226512265222653226542265522656226572265822659226602266122662226632266422665226662266722668226692267022671226722267322674226752267622677226782267922680226812268222683226842268522686226872268822689226902269122692226932269422695226962269722698226992270022701227022270322704227052270622707227082270922710227112271222713227142271522716227172271822719227202272122722227232272422725227262272722728227292273022731227322273322734227352273622737227382273922740227412274222743227442274522746227472274822749227502275122752227532275422755227562275722758227592276022761227622276322764227652276622767227682276922770227712277222773227742277522776227772277822779227802278122782227832278422785227862278722788227892279022791227922279322794227952279622797227982279922800228012280222803228042280522806228072280822809228102281122812228132281422815228162281722818228192282022821228222282322824228252282622827228282282922830228312283222833228342283522836228372283822839228402284122842228432284422845228462284722848228492285022851228522285322854228552285622857228582285922860228612286222863228642286522866228672286822869228702287122872228732287422875228762287722878228792288022881228822288322884228852288622887228882288922890228912289222893228942289522896228972289822899229002290122902229032290422905229062290722908229092291022911229122291322914229152291622917229182291922920229212292222923229242292522926229272292822929229302293122932229332293422935229362293722938229392294022941229422294322944229452294622947229482294922950229512295222953229542295522956229572295822959229602296122962229632296422965229662296722968229692297022971229722297322974229752297622977229782297922980229812298222983229842298522986229872298822989229902299122992229932299422995229962299722998229992300023001230022300323004230052300623007230082300923010230112301223013230142301523016230172301823019230202302123022230232302423025230262302723028230292303023031230322303323034230352303623037230382303923040230412304223043230442304523046230472304823049230502305123052230532305423055230562305723058230592306023061230622306323064230652306623067230682306923070230712307223073230742307523076230772307823079230802308123082230832308423085230862308723088230892309023091230922309323094230952309623097230982309923100231012310223103231042310523106231072310823109231102311123112231132311423115231162311723118231192312023121231222312323124231252312623127231282312923130231312313223133231342313523136231372313823139231402314123142231432314423145231462314723148231492315023151231522315323154231552315623157231582315923160231612316223163231642316523166231672316823169231702317123172231732317423175231762317723178231792318023181231822318323184231852318623187231882318923190231912319223193231942319523196231972319823199232002320123202232032320423205232062320723208232092321023211232122321323214232152321623217232182321923220232212322223223232242322523226232272322823229232302323123232232332323423235232362323723238232392324023241232422324323244232452324623247232482324923250232512325223253232542325523256232572325823259232602326123262232632326423265232662326723268232692327023271232722327323274232752327623277232782327923280232812328223283232842328523286232872328823289232902329123292232932329423295232962329723298232992330023301233022330323304233052330623307233082330923310233112331223313233142331523316233172331823319233202332123322233232332423325233262332723328233292333023331233322333323334233352333623337233382333923340233412334223343233442334523346233472334823349233502335123352233532335423355233562335723358233592336023361233622336323364233652336623367233682336923370233712337223373233742337523376233772337823379233802338123382233832338423385233862338723388233892339023391233922339323394233952339623397233982339923400234012340223403234042340523406234072340823409234102341123412234132341423415234162341723418234192342023421234222342323424234252342623427234282342923430234312343223433234342343523436234372343823439234402344123442234432344423445234462344723448234492345023451234522345323454234552345623457234582345923460234612346223463234642346523466234672346823469234702347123472234732347423475234762347723478234792348023481234822348323484234852348623487234882348923490234912349223493234942349523496234972349823499235002350123502235032350423505235062350723508235092351023511235122351323514235152351623517235182351923520235212352223523235242352523526235272352823529235302353123532235332353423535235362353723538235392354023541235422354323544235452354623547235482354923550235512355223553235542355523556235572355823559235602356123562235632356423565235662356723568235692357023571235722357323574235752357623577235782357923580235812358223583235842358523586235872358823589235902359123592235932359423595235962359723598235992360023601236022360323604236052360623607236082360923610236112361223613236142361523616236172361823619236202362123622236232362423625236262362723628236292363023631236322363323634236352363623637236382363923640236412364223643236442364523646236472364823649236502365123652236532365423655236562365723658236592366023661236622366323664236652366623667236682366923670236712367223673236742367523676236772367823679236802368123682236832368423685236862368723688236892369023691236922369323694236952369623697236982369923700237012370223703237042370523706237072370823709237102371123712237132371423715237162371723718237192372023721237222372323724237252372623727237282372923730237312373223733237342373523736237372373823739237402374123742237432374423745237462374723748237492375023751237522375323754237552375623757237582375923760237612376223763237642376523766237672376823769237702377123772237732377423775237762377723778237792378023781237822378323784237852378623787237882378923790237912379223793237942379523796237972379823799238002380123802238032380423805238062380723808238092381023811238122381323814238152381623817238182381923820238212382223823238242382523826238272382823829238302383123832238332383423835238362383723838238392384023841238422384323844238452384623847238482384923850238512385223853238542385523856238572385823859238602386123862238632386423865238662386723868238692387023871238722387323874238752387623877238782387923880238812388223883238842388523886238872388823889238902389123892238932389423895238962389723898238992390023901239022390323904239052390623907239082390923910239112391223913239142391523916239172391823919239202392123922239232392423925239262392723928239292393023931239322393323934239352393623937239382393923940239412394223943239442394523946239472394823949239502395123952239532395423955239562395723958239592396023961239622396323964239652396623967239682396923970239712397223973239742397523976239772397823979239802398123982239832398423985239862398723988239892399023991239922399323994239952399623997239982399924000240012400224003240042400524006240072400824009240102401124012240132401424015240162401724018240192402024021240222402324024240252402624027240282402924030240312403224033240342403524036240372403824039240402404124042240432404424045240462404724048240492405024051240522405324054240552405624057240582405924060240612406224063240642406524066240672406824069240702407124072240732407424075240762407724078240792408024081240822408324084240852408624087240882408924090240912409224093240942409524096240972409824099241002410124102241032410424105241062410724108241092411024111241122411324114241152411624117241182411924120241212412224123241242412524126241272412824129241302413124132241332413424135241362413724138241392414024141241422414324144241452414624147241482414924150241512415224153241542415524156241572415824159241602416124162241632416424165241662416724168241692417024171241722417324174241752417624177241782417924180241812418224183241842418524186241872418824189241902419124192241932419424195241962419724198241992420024201242022420324204242052420624207242082420924210242112421224213242142421524216242172421824219242202422124222242232422424225242262422724228242292423024231242322423324234242352423624237242382423924240242412424224243242442424524246242472424824249242502425124252242532425424255242562425724258242592426024261242622426324264242652426624267242682426924270242712427224273242742427524276242772427824279242802428124282242832428424285242862428724288242892429024291242922429324294242952429624297242982429924300243012430224303243042430524306243072430824309243102431124312243132431424315243162431724318243192432024321243222432324324243252432624327243282432924330243312433224333243342433524336243372433824339243402434124342243432434424345243462434724348243492435024351243522435324354243552435624357243582435924360243612436224363243642436524366243672436824369243702437124372243732437424375243762437724378243792438024381243822438324384243852438624387243882438924390243912439224393243942439524396243972439824399244002440124402244032440424405244062440724408244092441024411244122441324414244152441624417244182441924420244212442224423244242442524426244272442824429244302443124432244332443424435244362443724438244392444024441244422444324444244452444624447244482444924450244512445224453244542445524456244572445824459244602446124462244632446424465244662446724468244692447024471244722447324474244752447624477244782447924480244812448224483244842448524486244872448824489244902449124492244932449424495244962449724498244992450024501245022450324504245052450624507245082450924510245112451224513245142451524516245172451824519245202452124522245232452424525245262452724528245292453024531245322453324534245352453624537245382453924540245412454224543245442454524546245472454824549245502455124552245532455424555245562455724558245592456024561245622456324564245652456624567245682456924570245712457224573245742457524576245772457824579245802458124582245832458424585245862458724588245892459024591245922459324594245952459624597245982459924600246012460224603246042460524606246072460824609246102461124612246132461424615246162461724618246192462024621246222462324624246252462624627246282462924630246312463224633246342463524636246372463824639246402464124642246432464424645246462464724648246492465024651246522465324654246552465624657246582465924660246612466224663246642466524666246672466824669246702467124672246732467424675246762467724678246792468024681246822468324684246852468624687246882468924690246912469224693246942469524696246972469824699247002470124702247032470424705247062470724708247092471024711247122471324714247152471624717247182471924720247212472224723247242472524726247272472824729247302473124732247332473424735247362473724738247392474024741247422474324744247452474624747247482474924750247512475224753247542475524756247572475824759247602476124762247632476424765247662476724768247692477024771247722477324774247752477624777247782477924780247812478224783247842478524786247872478824789247902479124792247932479424795247962479724798247992480024801248022480324804248052480624807248082480924810248112481224813248142481524816248172481824819248202482124822248232482424825248262482724828248292483024831248322483324834248352483624837248382483924840248412484224843248442484524846248472484824849248502485124852248532485424855248562485724858248592486024861248622486324864248652486624867248682486924870248712487224873248742487524876248772487824879248802488124882248832488424885248862488724888248892489024891248922489324894248952489624897248982489924900249012490224903249042490524906249072490824909249102491124912249132491424915249162491724918249192492024921249222492324924249252492624927249282492924930249312493224933249342493524936249372493824939249402494124942249432494424945249462494724948249492495024951249522495324954249552495624957249582495924960249612496224963249642496524966249672496824969249702497124972249732497424975249762497724978249792498024981249822498324984249852498624987249882498924990249912499224993249942499524996249972499824999250002500125002250032500425005250062500725008250092501025011250122501325014250152501625017250182501925020250212502225023250242502525026250272502825029250302503125032250332503425035250362503725038250392504025041250422504325044250452504625047250482504925050250512505225053250542505525056250572505825059250602506125062250632506425065250662506725068250692507025071250722507325074250752507625077250782507925080250812508225083250842508525086250872508825089250902509125092250932509425095250962509725098250992510025101251022510325104251052510625107251082510925110251112511225113251142511525116251172511825119251202512125122251232512425125251262512725128251292513025131251322513325134251352513625137251382513925140251412514225143251442514525146251472514825149251502515125152251532515425155251562515725158251592516025161251622516325164251652516625167251682516925170251712517225173251742517525176251772517825179251802518125182251832518425185251862518725188251892519025191251922519325194251952519625197251982519925200252012520225203252042520525206252072520825209252102521125212252132521425215252162521725218252192522025221252222522325224252252522625227252282522925230252312523225233252342523525236252372523825239252402524125242252432524425245252462524725248252492525025251252522525325254252552525625257252582525925260252612526225263252642526525266252672526825269252702527125272252732527425275252762527725278252792528025281252822528325284252852528625287252882528925290252912529225293252942529525296252972529825299253002530125302253032530425305253062530725308253092531025311253122531325314253152531625317253182531925320253212532225323253242532525326253272532825329253302533125332253332533425335253362533725338253392534025341253422534325344253452534625347253482534925350253512535225353253542535525356253572535825359253602536125362253632536425365253662536725368253692537025371253722537325374253752537625377253782537925380253812538225383253842538525386253872538825389253902539125392253932539425395253962539725398253992540025401254022540325404254052540625407254082540925410254112541225413254142541525416254172541825419254202542125422254232542425425254262542725428254292543025431254322543325434254352543625437254382543925440254412544225443254442544525446254472544825449254502545125452254532545425455254562545725458254592546025461254622546325464254652546625467254682546925470254712547225473254742547525476254772547825479254802548125482254832548425485254862548725488254892549025491254922549325494254952549625497254982549925500255012550225503255042550525506255072550825509255102551125512255132551425515255162551725518255192552025521255222552325524255252552625527255282552925530255312553225533255342553525536255372553825539255402554125542255432554425545255462554725548255492555025551255522555325554255552555625557255582555925560255612556225563255642556525566255672556825569255702557125572255732557425575255762557725578255792558025581255822558325584255852558625587255882558925590255912559225593255942559525596255972559825599256002560125602256032560425605256062560725608256092561025611256122561325614256152561625617256182561925620256212562225623256242562525626256272562825629256302563125632256332563425635256362563725638256392564025641256422564325644256452564625647256482564925650256512565225653256542565525656256572565825659256602566125662256632566425665256662566725668256692567025671256722567325674256752567625677256782567925680256812568225683256842568525686256872568825689256902569125692256932569425695256962569725698256992570025701257022570325704257052570625707257082570925710257112571225713257142571525716257172571825719257202572125722257232572425725257262572725728257292573025731257322573325734257352573625737257382573925740257412574225743257442574525746257472574825749257502575125752257532575425755257562575725758257592576025761257622576325764257652576625767257682576925770257712577225773257742577525776257772577825779257802578125782257832578425785257862578725788257892579025791257922579325794257952579625797257982579925800258012580225803258042580525806258072580825809258102581125812258132581425815258162581725818258192582025821258222582325824258252582625827258282582925830258312583225833258342583525836258372583825839258402584125842258432584425845258462584725848258492585025851258522585325854258552585625857258582585925860258612586225863258642586525866258672586825869258702587125872258732587425875258762587725878258792588025881258822588325884258852588625887258882588925890258912589225893258942589525896258972589825899259002590125902259032590425905259062590725908259092591025911259122591325914259152591625917259182591925920259212592225923259242592525926259272592825929259302593125932259332593425935259362593725938259392594025941259422594325944259452594625947259482594925950259512595225953259542595525956259572595825959259602596125962259632596425965259662596725968259692597025971259722597325974259752597625977259782597925980259812598225983259842598525986259872598825989259902599125992259932599425995259962599725998259992600026001260022600326004260052600626007260082600926010260112601226013260142601526016260172601826019260202602126022260232602426025260262602726028260292603026031260322603326034260352603626037260382603926040260412604226043260442604526046260472604826049260502605126052260532605426055260562605726058260592606026061260622606326064260652606626067260682606926070260712607226073260742607526076260772607826079260802608126082260832608426085260862608726088260892609026091260922609326094260952609626097260982609926100261012610226103261042610526106261072610826109261102611126112261132611426115261162611726118261192612026121261222612326124261252612626127261282612926130261312613226133261342613526136261372613826139261402614126142261432614426145261462614726148261492615026151261522615326154261552615626157261582615926160261612616226163261642616526166261672616826169261702617126172261732617426175261762617726178261792618026181261822618326184261852618626187261882618926190261912619226193261942619526196261972619826199262002620126202262032620426205262062620726208262092621026211262122621326214262152621626217262182621926220262212622226223262242622526226262272622826229262302623126232262332623426235262362623726238262392624026241262422624326244262452624626247262482624926250262512625226253262542625526256262572625826259262602626126262262632626426265262662626726268262692627026271262722627326274262752627626277262782627926280262812628226283262842628526286262872628826289262902629126292262932629426295262962629726298262992630026301263022630326304263052630626307263082630926310263112631226313263142631526316263172631826319263202632126322263232632426325263262632726328263292633026331263322633326334263352633626337263382633926340263412634226343263442634526346263472634826349263502635126352263532635426355263562635726358263592636026361263622636326364263652636626367263682636926370263712637226373263742637526376263772637826379263802638126382263832638426385263862638726388263892639026391263922639326394263952639626397263982639926400264012640226403264042640526406264072640826409264102641126412264132641426415264162641726418264192642026421264222642326424264252642626427264282642926430264312643226433264342643526436264372643826439264402644126442264432644426445264462644726448264492645026451264522645326454264552645626457264582645926460264612646226463264642646526466264672646826469264702647126472264732647426475264762647726478264792648026481264822648326484264852648626487264882648926490264912649226493264942649526496264972649826499265002650126502265032650426505265062650726508265092651026511265122651326514265152651626517265182651926520265212652226523265242652526526265272652826529265302653126532265332653426535265362653726538265392654026541265422654326544265452654626547265482654926550265512655226553265542655526556265572655826559265602656126562265632656426565265662656726568265692657026571265722657326574265752657626577265782657926580265812658226583265842658526586265872658826589265902659126592265932659426595265962659726598265992660026601266022660326604266052660626607266082660926610266112661226613266142661526616266172661826619266202662126622266232662426625266262662726628266292663026631266322663326634266352663626637266382663926640266412664226643266442664526646266472664826649266502665126652266532665426655266562665726658266592666026661266622666326664266652666626667266682666926670266712667226673266742667526676266772667826679266802668126682266832668426685266862668726688266892669026691266922669326694266952669626697266982669926700267012670226703267042670526706267072670826709267102671126712267132671426715267162671726718267192672026721267222672326724267252672626727267282672926730267312673226733267342673526736267372673826739267402674126742267432674426745267462674726748267492675026751267522675326754267552675626757267582675926760267612676226763267642676526766267672676826769267702677126772267732677426775267762677726778267792678026781267822678326784267852678626787267882678926790267912679226793267942679526796267972679826799268002680126802268032680426805268062680726808268092681026811268122681326814268152681626817268182681926820268212682226823268242682526826268272682826829268302683126832268332683426835268362683726838268392684026841268422684326844268452684626847268482684926850268512685226853268542685526856268572685826859268602686126862268632686426865268662686726868268692687026871268722687326874268752687626877268782687926880268812688226883268842688526886268872688826889268902689126892268932689426895268962689726898268992690026901269022690326904269052690626907269082690926910269112691226913269142691526916269172691826919269202692126922269232692426925269262692726928269292693026931269322693326934269352693626937269382693926940269412694226943269442694526946269472694826949269502695126952269532695426955269562695726958269592696026961269622696326964269652696626967269682696926970269712697226973269742697526976269772697826979269802698126982269832698426985269862698726988269892699026991269922699326994269952699626997269982699927000270012700227003270042700527006270072700827009270102701127012270132701427015270162701727018270192702027021270222702327024270252702627027270282702927030270312703227033270342703527036270372703827039270402704127042270432704427045270462704727048270492705027051270522705327054270552705627057270582705927060270612706227063270642706527066270672706827069270702707127072270732707427075270762707727078270792708027081270822708327084270852708627087270882708927090270912709227093270942709527096270972709827099271002710127102271032710427105271062710727108271092711027111271122711327114271152711627117271182711927120271212712227123271242712527126271272712827129271302713127132271332713427135271362713727138271392714027141271422714327144271452714627147271482714927150271512715227153271542715527156271572715827159271602716127162271632716427165271662716727168271692717027171271722717327174271752717627177271782717927180271812718227183271842718527186271872718827189271902719127192271932719427195271962719727198271992720027201272022720327204272052720627207272082720927210272112721227213272142721527216272172721827219272202722127222272232722427225272262722727228272292723027231272322723327234272352723627237272382723927240272412724227243272442724527246272472724827249272502725127252272532725427255272562725727258272592726027261272622726327264272652726627267272682726927270272712727227273272742727527276272772727827279272802728127282272832728427285272862728727288272892729027291272922729327294272952729627297272982729927300273012730227303273042730527306273072730827309273102731127312273132731427315273162731727318273192732027321273222732327324273252732627327273282732927330273312733227333273342733527336273372733827339273402734127342273432734427345273462734727348273492735027351273522735327354273552735627357273582735927360273612736227363273642736527366273672736827369273702737127372273732737427375273762737727378273792738027381273822738327384273852738627387273882738927390273912739227393273942739527396273972739827399274002740127402274032740427405274062740727408274092741027411274122741327414274152741627417274182741927420274212742227423274242742527426274272742827429274302743127432274332743427435274362743727438274392744027441274422744327444274452744627447274482744927450274512745227453274542745527456274572745827459274602746127462274632746427465274662746727468274692747027471274722747327474274752747627477274782747927480274812748227483274842748527486274872748827489274902749127492274932749427495274962749727498274992750027501275022750327504275052750627507275082750927510275112751227513275142751527516275172751827519275202752127522275232752427525275262752727528275292753027531275322753327534275352753627537275382753927540275412754227543275442754527546275472754827549275502755127552275532755427555275562755727558275592756027561275622756327564275652756627567275682756927570275712757227573275742757527576275772757827579275802758127582275832758427585275862758727588275892759027591275922759327594275952759627597275982759927600276012760227603276042760527606276072760827609276102761127612276132761427615276162761727618276192762027621276222762327624276252762627627276282762927630276312763227633276342763527636276372763827639276402764127642276432764427645276462764727648276492765027651276522765327654276552765627657276582765927660276612766227663276642766527666276672766827669276702767127672276732767427675276762767727678276792768027681276822768327684276852768627687276882768927690276912769227693276942769527696276972769827699277002770127702277032770427705277062770727708277092771027711277122771327714277152771627717277182771927720277212772227723277242772527726277272772827729277302773127732277332773427735277362773727738277392774027741277422774327744277452774627747277482774927750277512775227753277542775527756277572775827759277602776127762277632776427765277662776727768277692777027771277722777327774277752777627777277782777927780277812778227783277842778527786277872778827789277902779127792277932779427795277962779727798277992780027801278022780327804278052780627807278082780927810278112781227813278142781527816278172781827819278202782127822278232782427825278262782727828278292783027831278322783327834278352783627837278382783927840278412784227843278442784527846278472784827849278502785127852278532785427855278562785727858278592786027861278622786327864278652786627867278682786927870278712787227873278742787527876278772787827879278802788127882278832788427885278862788727888278892789027891278922789327894278952789627897278982789927900279012790227903279042790527906279072790827909279102791127912279132791427915279162791727918279192792027921279222792327924279252792627927279282792927930279312793227933279342793527936279372793827939279402794127942279432794427945279462794727948279492795027951279522795327954279552795627957279582795927960279612796227963279642796527966279672796827969279702797127972279732797427975279762797727978279792798027981279822798327984279852798627987279882798927990279912799227993279942799527996279972799827999280002800128002280032800428005280062800728008280092801028011280122801328014280152801628017280182801928020280212802228023280242802528026280272802828029280302803128032280332803428035280362803728038280392804028041280422804328044280452804628047280482804928050280512805228053280542805528056280572805828059280602806128062280632806428065280662806728068280692807028071280722807328074280752807628077280782807928080280812808228083280842808528086280872808828089280902809128092280932809428095280962809728098280992810028101281022810328104281052810628107281082810928110281112811228113281142811528116281172811828119281202812128122281232812428125281262812728128281292813028131281322813328134281352813628137281382813928140281412814228143281442814528146281472814828149281502815128152281532815428155281562815728158281592816028161281622816328164281652816628167281682816928170281712817228173281742817528176281772817828179281802818128182281832818428185281862818728188281892819028191281922819328194281952819628197281982819928200282012820228203282042820528206282072820828209282102821128212282132821428215282162821728218282192822028221282222822328224282252822628227282282822928230282312823228233282342823528236282372823828239282402824128242282432824428245282462824728248282492825028251282522825328254282552825628257282582825928260282612826228263282642826528266282672826828269282702827128272282732827428275282762827728278282792828028281282822828328284282852828628287282882828928290282912829228293282942829528296282972829828299283002830128302283032830428305283062830728308283092831028311283122831328314283152831628317283182831928320283212832228323283242832528326283272832828329283302833128332283332833428335283362833728338283392834028341283422834328344283452834628347283482834928350283512835228353283542835528356283572835828359283602836128362283632836428365283662836728368283692837028371283722837328374283752837628377283782837928380283812838228383283842838528386283872838828389283902839128392283932839428395283962839728398283992840028401284022840328404284052840628407284082840928410284112841228413284142841528416284172841828419284202842128422284232842428425284262842728428284292843028431284322843328434284352843628437284382843928440284412844228443284442844528446284472844828449284502845128452284532845428455284562845728458284592846028461284622846328464284652846628467284682846928470284712847228473284742847528476284772847828479284802848128482284832848428485284862848728488284892849028491284922849328494284952849628497284982849928500285012850228503285042850528506285072850828509285102851128512285132851428515285162851728518285192852028521285222852328524285252852628527285282852928530285312853228533285342853528536285372853828539285402854128542285432854428545285462854728548285492855028551285522855328554285552855628557285582855928560285612856228563285642856528566285672856828569285702857128572285732857428575285762857728578285792858028581285822858328584285852858628587285882858928590285912859228593285942859528596285972859828599286002860128602286032860428605286062860728608286092861028611286122861328614286152861628617286182861928620286212862228623286242862528626286272862828629286302863128632286332863428635286362863728638286392864028641286422864328644286452864628647286482864928650286512865228653286542865528656286572865828659286602866128662286632866428665286662866728668286692867028671286722867328674286752867628677286782867928680286812868228683286842868528686286872868828689286902869128692286932869428695286962869728698286992870028701287022870328704287052870628707287082870928710287112871228713287142871528716287172871828719287202872128722287232872428725287262872728728287292873028731287322873328734287352873628737287382873928740287412874228743287442874528746287472874828749287502875128752287532875428755287562875728758287592876028761287622876328764287652876628767287682876928770287712877228773287742877528776287772877828779287802878128782287832878428785287862878728788287892879028791287922879328794287952879628797287982879928800288012880228803288042880528806288072880828809288102881128812288132881428815288162881728818288192882028821288222882328824288252882628827288282882928830288312883228833288342883528836288372883828839288402884128842288432884428845288462884728848288492885028851288522885328854288552885628857288582885928860288612886228863288642886528866288672886828869288702887128872288732887428875288762887728878288792888028881288822888328884288852888628887288882888928890288912889228893288942889528896288972889828899289002890128902289032890428905289062890728908289092891028911289122891328914289152891628917289182891928920289212892228923289242892528926289272892828929289302893128932289332893428935289362893728938289392894028941289422894328944289452894628947289482894928950289512895228953289542895528956289572895828959289602896128962289632896428965289662896728968289692897028971289722897328974289752897628977289782897928980289812898228983289842898528986289872898828989289902899128992289932899428995289962899728998289992900029001290022900329004290052900629007290082900929010290112901229013290142901529016290172901829019290202902129022290232902429025290262902729028290292903029031290322903329034290352903629037290382903929040290412904229043290442904529046290472904829049290502905129052290532905429055290562905729058290592906029061290622906329064290652906629067290682906929070290712907229073290742907529076290772907829079290802908129082290832908429085290862908729088290892909029091290922909329094290952909629097290982909929100291012910229103291042910529106291072910829109291102911129112291132911429115291162911729118291192912029121291222912329124291252912629127291282912929130291312913229133291342913529136291372913829139291402914129142291432914429145291462914729148291492915029151291522915329154291552915629157291582915929160291612916229163291642916529166291672916829169291702917129172291732917429175291762917729178291792918029181291822918329184291852918629187291882918929190291912919229193291942919529196291972919829199292002920129202292032920429205292062920729208292092921029211292122921329214292152921629217292182921929220292212922229223292242922529226292272922829229292302923129232292332923429235292362923729238292392924029241292422924329244292452924629247292482924929250292512925229253292542925529256292572925829259292602926129262292632926429265292662926729268292692927029271292722927329274292752927629277292782927929280292812928229283292842928529286292872928829289292902929129292292932929429295292962929729298292992930029301293022930329304293052930629307293082930929310293112931229313293142931529316293172931829319293202932129322293232932429325293262932729328293292933029331293322933329334293352933629337293382933929340293412934229343293442934529346293472934829349293502935129352293532935429355293562935729358293592936029361293622936329364293652936629367293682936929370293712937229373293742937529376293772937829379293802938129382293832938429385293862938729388293892939029391293922939329394293952939629397293982939929400294012940229403294042940529406294072940829409294102941129412294132941429415294162941729418294192942029421294222942329424294252942629427294282942929430294312943229433294342943529436294372943829439294402944129442294432944429445294462944729448294492945029451294522945329454294552945629457294582945929460294612946229463294642946529466294672946829469294702947129472294732947429475294762947729478294792948029481294822948329484294852948629487294882948929490294912949229493294942949529496294972949829499295002950129502295032950429505295062950729508295092951029511295122951329514295152951629517295182951929520295212952229523295242952529526295272952829529295302953129532295332953429535295362953729538295392954029541295422954329544295452954629547295482954929550295512955229553295542955529556295572955829559295602956129562295632956429565295662956729568295692957029571295722957329574295752957629577295782957929580295812958229583295842958529586295872958829589295902959129592295932959429595295962959729598295992960029601296022960329604296052960629607296082960929610296112961229613296142961529616296172961829619296202962129622296232962429625296262962729628296292963029631296322963329634296352963629637296382963929640296412964229643296442964529646296472964829649296502965129652296532965429655296562965729658296592966029661296622966329664296652966629667296682966929670296712967229673296742967529676296772967829679296802968129682296832968429685296862968729688296892969029691296922969329694296952969629697296982969929700297012970229703297042970529706297072970829709297102971129712297132971429715297162971729718297192972029721297222972329724297252972629727297282972929730297312973229733297342973529736297372973829739297402974129742297432974429745297462974729748297492975029751297522975329754297552975629757297582975929760297612976229763297642976529766297672976829769297702977129772297732977429775297762977729778297792978029781297822978329784297852978629787297882978929790297912979229793297942979529796297972979829799298002980129802298032980429805298062980729808298092981029811298122981329814298152981629817298182981929820298212982229823298242982529826298272982829829298302983129832298332983429835298362983729838298392984029841298422984329844298452984629847298482984929850298512985229853298542985529856298572985829859298602986129862298632986429865298662986729868298692987029871298722987329874298752987629877298782987929880298812988229883298842988529886298872988829889298902989129892298932989429895298962989729898298992990029901299022990329904299052990629907299082990929910299112991229913299142991529916299172991829919299202992129922299232992429925299262992729928299292993029931299322993329934299352993629937299382993929940299412994229943299442994529946299472994829949299502995129952299532995429955299562995729958299592996029961299622996329964299652996629967299682996929970299712997229973299742997529976299772997829979299802998129982299832998429985299862998729988299892999029991299922999329994299952999629997299982999930000300013000230003300043000530006300073000830009300103001130012300133001430015300163001730018300193002030021300223002330024300253002630027300283002930030300313003230033300343003530036300373003830039300403004130042300433004430045300463004730048300493005030051300523005330054300553005630057300583005930060300613006230063300643006530066300673006830069300703007130072300733007430075300763007730078300793008030081300823008330084300853008630087300883008930090300913009230093300943009530096300973009830099301003010130102301033010430105301063010730108301093011030111301123011330114301153011630117301183011930120301213012230123301243012530126301273012830129301303013130132301333013430135301363013730138301393014030141301423014330144301453014630147301483014930150301513015230153301543015530156301573015830159301603016130162301633016430165301663016730168301693017030171301723017330174301753017630177301783017930180301813018230183301843018530186301873018830189301903019130192301933019430195301963019730198301993020030201302023020330204302053020630207302083020930210302113021230213302143021530216302173021830219302203022130222302233022430225302263022730228302293023030231302323023330234302353023630237302383023930240302413024230243302443024530246302473024830249302503025130252302533025430255302563025730258302593026030261302623026330264302653026630267302683026930270302713027230273302743027530276302773027830279302803028130282302833028430285302863028730288302893029030291302923029330294302953029630297302983029930300303013030230303303043030530306303073030830309303103031130312303133031430315303163031730318303193032030321303223032330324303253032630327303283032930330303313033230333303343033530336303373033830339303403034130342303433034430345303463034730348303493035030351303523035330354303553035630357303583035930360303613036230363303643036530366303673036830369303703037130372303733037430375303763037730378303793038030381303823038330384303853038630387303883038930390303913039230393303943039530396303973039830399304003040130402304033040430405304063040730408304093041030411304123041330414304153041630417304183041930420304213042230423304243042530426304273042830429304303043130432304333043430435304363043730438304393044030441304423044330444304453044630447304483044930450304513045230453304543045530456304573045830459304603046130462304633046430465304663046730468304693047030471304723047330474304753047630477304783047930480304813048230483304843048530486304873048830489304903049130492304933049430495304963049730498304993050030501305023050330504305053050630507305083050930510305113051230513305143051530516305173051830519305203052130522305233052430525305263052730528305293053030531305323053330534305353053630537305383053930540305413054230543305443054530546305473054830549305503055130552305533055430555305563055730558305593056030561305623056330564305653056630567305683056930570305713057230573305743057530576305773057830579305803058130582305833058430585305863058730588305893059030591305923059330594305953059630597305983059930600306013060230603306043060530606306073060830609306103061130612306133061430615306163061730618306193062030621306223062330624306253062630627306283062930630306313063230633306343063530636306373063830639306403064130642306433064430645306463064730648306493065030651306523065330654306553065630657306583065930660306613066230663306643066530666306673066830669306703067130672306733067430675306763067730678306793068030681306823068330684306853068630687306883068930690306913069230693306943069530696306973069830699307003070130702307033070430705307063070730708307093071030711307123071330714307153071630717307183071930720307213072230723307243072530726307273072830729307303073130732307333073430735307363073730738307393074030741307423074330744307453074630747307483074930750307513075230753307543075530756307573075830759307603076130762307633076430765307663076730768307693077030771307723077330774307753077630777307783077930780307813078230783307843078530786307873078830789307903079130792307933079430795307963079730798307993080030801308023080330804308053080630807308083080930810308113081230813308143081530816308173081830819308203082130822308233082430825308263082730828308293083030831308323083330834308353083630837308383083930840308413084230843308443084530846308473084830849308503085130852308533085430855308563085730858308593086030861308623086330864308653086630867308683086930870308713087230873308743087530876308773087830879308803088130882308833088430885308863088730888308893089030891308923089330894308953089630897308983089930900309013090230903309043090530906309073090830909309103091130912309133091430915309163091730918309193092030921309223092330924309253092630927309283092930930309313093230933309343093530936309373093830939309403094130942309433094430945309463094730948309493095030951309523095330954309553095630957309583095930960309613096230963309643096530966309673096830969309703097130972309733097430975309763097730978309793098030981309823098330984309853098630987309883098930990309913099230993309943099530996309973099830999310003100131002310033100431005310063100731008310093101031011310123101331014310153101631017310183101931020310213102231023310243102531026310273102831029310303103131032310333103431035310363103731038310393104031041310423104331044310453104631047310483104931050310513105231053310543105531056310573105831059310603106131062310633106431065310663106731068310693107031071310723107331074310753107631077310783107931080310813108231083310843108531086310873108831089310903109131092310933109431095310963109731098310993110031101311023110331104311053110631107311083110931110311113111231113311143111531116311173111831119311203112131122311233112431125311263112731128311293113031131311323113331134311353113631137311383113931140311413114231143311443114531146311473114831149311503115131152311533115431155311563115731158311593116031161311623116331164311653116631167311683116931170311713117231173311743117531176311773117831179311803118131182311833118431185311863118731188311893119031191311923119331194311953119631197311983119931200312013120231203312043120531206312073120831209312103121131212312133121431215312163121731218312193122031221312223122331224312253122631227312283122931230312313123231233312343123531236312373123831239312403124131242312433124431245312463124731248312493125031251312523125331254312553125631257312583125931260312613126231263312643126531266312673126831269312703127131272312733127431275312763127731278312793128031281312823128331284312853128631287312883128931290312913129231293312943129531296312973129831299313003130131302313033130431305313063130731308313093131031311313123131331314313153131631317313183131931320313213132231323313243132531326313273132831329313303133131332313333133431335313363133731338313393134031341313423134331344313453134631347313483134931350313513135231353313543135531356313573135831359313603136131362313633136431365313663136731368313693137031371313723137331374313753137631377313783137931380313813138231383313843138531386313873138831389313903139131392313933139431395313963139731398313993140031401314023140331404314053140631407314083140931410314113141231413314143141531416314173141831419314203142131422314233142431425314263142731428314293143031431314323143331434314353143631437314383143931440314413144231443314443144531446314473144831449314503145131452314533145431455314563145731458314593146031461314623146331464314653146631467314683146931470314713147231473314743147531476314773147831479314803148131482314833148431485314863148731488314893149031491314923149331494314953149631497314983149931500315013150231503315043150531506315073150831509315103151131512315133151431515315163151731518315193152031521315223152331524315253152631527315283152931530315313153231533315343153531536315373153831539315403154131542315433154431545315463154731548315493155031551315523155331554315553155631557315583155931560315613156231563315643156531566315673156831569315703157131572315733157431575315763157731578315793158031581315823158331584315853158631587315883158931590315913159231593315943159531596315973159831599316003160131602316033160431605316063160731608316093161031611316123161331614316153161631617316183161931620316213162231623316243162531626316273162831629316303163131632316333163431635316363163731638316393164031641316423164331644316453164631647316483164931650316513165231653316543165531656316573165831659316603166131662316633166431665316663166731668316693167031671316723167331674316753167631677316783167931680316813168231683316843168531686316873168831689316903169131692316933169431695316963169731698316993170031701317023170331704317053170631707317083170931710317113171231713317143171531716317173171831719317203172131722317233172431725317263172731728317293173031731317323173331734317353173631737317383173931740317413174231743317443174531746317473174831749317503175131752317533175431755317563175731758317593176031761317623176331764317653176631767317683176931770317713177231773317743177531776317773177831779317803178131782317833178431785317863178731788317893179031791317923179331794317953179631797317983179931800318013180231803318043180531806318073180831809318103181131812318133181431815318163181731818318193182031821318223182331824318253182631827318283182931830318313183231833318343183531836318373183831839318403184131842318433184431845318463184731848318493185031851318523185331854318553185631857318583185931860318613186231863318643186531866318673186831869318703187131872318733187431875318763187731878318793188031881318823188331884318853188631887318883188931890318913189231893318943189531896318973189831899319003190131902319033190431905319063190731908319093191031911319123191331914319153191631917319183191931920319213192231923319243192531926319273192831929319303193131932319333193431935319363193731938319393194031941319423194331944319453194631947319483194931950319513195231953319543195531956319573195831959319603196131962319633196431965319663196731968319693197031971319723197331974319753197631977319783197931980319813198231983319843198531986319873198831989319903199131992319933199431995319963199731998319993200032001320023200332004320053200632007320083200932010320113201232013320143201532016320173201832019320203202132022320233202432025320263202732028320293203032031320323203332034320353203632037320383203932040320413204232043320443204532046320473204832049320503205132052320533205432055320563205732058320593206032061320623206332064320653206632067320683206932070320713207232073320743207532076320773207832079320803208132082320833208432085320863208732088320893209032091320923209332094320953209632097320983209932100321013210232103321043210532106321073210832109321103211132112321133211432115321163211732118321193212032121321223212332124321253212632127321283212932130321313213232133321343213532136321373213832139321403214132142321433214432145321463214732148321493215032151321523215332154321553215632157321583215932160321613216232163321643216532166321673216832169321703217132172321733217432175321763217732178321793218032181321823218332184321853218632187321883218932190321913219232193321943219532196321973219832199322003220132202322033220432205322063220732208322093221032211322123221332214322153221632217322183221932220322213222232223322243222532226322273222832229322303223132232322333223432235322363223732238322393224032241322423224332244322453224632247322483224932250322513225232253322543225532256322573225832259322603226132262322633226432265322663226732268322693227032271322723227332274322753227632277322783227932280322813228232283322843228532286322873228832289322903229132292322933229432295322963229732298322993230032301323023230332304323053230632307323083230932310323113231232313323143231532316323173231832319323203232132322323233232432325323263232732328323293233032331323323233332334323353233632337323383233932340323413234232343323443234532346323473234832349323503235132352323533235432355323563235732358323593236032361323623236332364323653236632367323683236932370323713237232373323743237532376323773237832379323803238132382323833238432385323863238732388323893239032391323923239332394323953239632397323983239932400324013240232403324043240532406324073240832409324103241132412324133241432415324163241732418324193242032421324223242332424324253242632427324283242932430324313243232433324343243532436324373243832439324403244132442324433244432445324463244732448324493245032451324523245332454324553245632457324583245932460324613246232463324643246532466324673246832469324703247132472324733247432475324763247732478324793248032481324823248332484324853248632487324883248932490324913249232493324943249532496324973249832499325003250132502325033250432505325063250732508325093251032511325123251332514325153251632517325183251932520325213252232523325243252532526325273252832529325303253132532325333253432535325363253732538325393254032541325423254332544325453254632547325483254932550325513255232553325543255532556325573255832559325603256132562325633256432565325663256732568325693257032571325723257332574325753257632577325783257932580325813258232583325843258532586325873258832589325903259132592325933259432595325963259732598325993260032601326023260332604326053260632607326083260932610326113261232613326143261532616326173261832619326203262132622326233262432625326263262732628326293263032631326323263332634326353263632637326383263932640326413264232643326443264532646326473264832649326503265132652326533265432655326563265732658326593266032661326623266332664326653266632667326683266932670326713267232673326743267532676326773267832679326803268132682326833268432685326863268732688326893269032691326923269332694326953269632697326983269932700327013270232703327043270532706327073270832709327103271132712327133271432715327163271732718327193272032721327223272332724327253272632727327283272932730327313273232733327343273532736327373273832739327403274132742327433274432745327463274732748327493275032751327523275332754327553275632757327583275932760327613276232763327643276532766327673276832769327703277132772327733277432775327763277732778327793278032781327823278332784327853278632787327883278932790327913279232793327943279532796327973279832799328003280132802328033280432805328063280732808328093281032811328123281332814328153281632817328183281932820328213282232823328243282532826328273282832829328303283132832328333283432835328363283732838328393284032841328423284332844328453284632847328483284932850328513285232853328543285532856328573285832859328603286132862328633286432865328663286732868328693287032871328723287332874328753287632877328783287932880328813288232883328843288532886328873288832889328903289132892328933289432895328963289732898328993290032901329023290332904329053290632907329083290932910329113291232913329143291532916329173291832919329203292132922329233292432925329263292732928329293293032931329323293332934329353293632937329383293932940329413294232943329443294532946329473294832949329503295132952329533295432955329563295732958329593296032961329623296332964329653296632967329683296932970329713297232973329743297532976329773297832979329803298132982329833298432985329863298732988329893299032991329923299332994329953299632997329983299933000330013300233003330043300533006330073300833009330103301133012330133301433015330163301733018330193302033021330223302333024330253302633027330283302933030330313303233033330343303533036330373303833039330403304133042330433304433045330463304733048330493305033051330523305333054330553305633057330583305933060330613306233063330643306533066330673306833069330703307133072330733307433075330763307733078330793308033081330823308333084330853308633087330883308933090330913309233093330943309533096330973309833099331003310133102331033310433105331063310733108331093311033111331123311333114331153311633117331183311933120331213312233123331243312533126331273312833129331303313133132331333313433135331363313733138331393314033141331423314333144331453314633147331483314933150331513315233153331543315533156331573315833159331603316133162331633316433165331663316733168331693317033171331723317333174331753317633177331783317933180331813318233183331843318533186331873318833189331903319133192331933319433195331963319733198331993320033201332023320333204332053320633207332083320933210332113321233213332143321533216332173321833219332203322133222332233322433225332263322733228332293323033231332323323333234332353323633237332383323933240332413324233243332443324533246332473324833249332503325133252332533325433255332563325733258332593326033261332623326333264332653326633267332683326933270332713327233273332743327533276332773327833279332803328133282332833328433285332863328733288332893329033291332923329333294332953329633297332983329933300333013330233303333043330533306333073330833309333103331133312333133331433315333163331733318333193332033321333223332333324333253332633327333283332933330333313333233333333343333533336333373333833339333403334133342333433334433345333463334733348333493335033351333523335333354333553335633357333583335933360333613336233363333643336533366333673336833369333703337133372333733337433375333763337733378333793338033381333823338333384333853338633387333883338933390333913339233393333943339533396333973339833399334003340133402334033340433405334063340733408334093341033411334123341333414334153341633417334183341933420334213342233423334243342533426334273342833429334303343133432334333343433435334363343733438334393344033441334423344333444334453344633447334483344933450334513345233453334543345533456334573345833459334603346133462334633346433465334663346733468334693347033471334723347333474334753347633477334783347933480334813348233483334843348533486334873348833489334903349133492334933349433495334963349733498334993350033501335023350333504335053350633507335083350933510335113351233513335143351533516335173351833519335203352133522335233352433525335263352733528335293353033531335323353333534335353353633537335383353933540335413354233543335443354533546335473354833549335503355133552335533355433555335563355733558335593356033561335623356333564335653356633567335683356933570335713357233573335743357533576335773357833579335803358133582335833358433585335863358733588335893359033591335923359333594335953359633597335983359933600336013360233603336043360533606336073360833609336103361133612336133361433615336163361733618336193362033621336223362333624336253362633627336283362933630336313363233633336343363533636336373363833639336403364133642336433364433645336463364733648336493365033651336523365333654336553365633657336583365933660336613366233663336643366533666336673366833669336703367133672336733367433675336763367733678336793368033681336823368333684336853368633687336883368933690336913369233693336943369533696336973369833699337003370133702337033370433705337063370733708337093371033711337123371333714337153371633717337183371933720337213372233723337243372533726337273372833729337303373133732337333373433735337363373733738337393374033741337423374333744337453374633747337483374933750337513375233753337543375533756337573375833759337603376133762337633376433765337663376733768337693377033771337723377333774337753377633777337783377933780337813378233783337843378533786337873378833789337903379133792337933379433795337963379733798337993380033801338023380333804338053380633807338083380933810338113381233813338143381533816338173381833819338203382133822338233382433825338263382733828338293383033831338323383333834338353383633837338383383933840338413384233843338443384533846338473384833849338503385133852338533385433855338563385733858338593386033861338623386333864338653386633867338683386933870338713387233873338743387533876338773387833879338803388133882338833388433885338863388733888338893389033891338923389333894338953389633897338983389933900339013390233903339043390533906339073390833909339103391133912339133391433915339163391733918339193392033921339223392333924339253392633927339283392933930339313393233933339343393533936339373393833939339403394133942339433394433945339463394733948339493395033951339523395333954339553395633957339583395933960339613396233963339643396533966339673396833969339703397133972339733397433975339763397733978339793398033981339823398333984339853398633987339883398933990339913399233993339943399533996339973399833999340003400134002340033400434005340063400734008340093401034011340123401334014340153401634017340183401934020340213402234023340243402534026340273402834029340303403134032340333403434035340363403734038340393404034041340423404334044340453404634047340483404934050340513405234053340543405534056340573405834059340603406134062340633406434065340663406734068340693407034071340723407334074340753407634077340783407934080340813408234083340843408534086340873408834089340903409134092340933409434095340963409734098340993410034101341023410334104341053410634107341083410934110341113411234113341143411534116341173411834119341203412134122341233412434125341263412734128341293413034131341323413334134341353413634137341383413934140341413414234143341443414534146341473414834149341503415134152341533415434155341563415734158341593416034161341623416334164341653416634167341683416934170341713417234173341743417534176341773417834179341803418134182341833418434185341863418734188341893419034191341923419334194341953419634197341983419934200342013420234203342043420534206342073420834209342103421134212342133421434215342163421734218342193422034221342223422334224342253422634227342283422934230342313423234233342343423534236342373423834239342403424134242342433424434245342463424734248342493425034251342523425334254342553425634257342583425934260342613426234263342643426534266342673426834269342703427134272342733427434275342763427734278342793428034281342823428334284342853428634287342883428934290342913429234293342943429534296342973429834299343003430134302343033430434305343063430734308343093431034311343123431334314343153431634317343183431934320343213432234323343243432534326343273432834329343303433134332343333433434335343363433734338343393434034341343423434334344343453434634347343483434934350343513435234353343543435534356343573435834359343603436134362343633436434365343663436734368343693437034371343723437334374343753437634377343783437934380343813438234383343843438534386343873438834389343903439134392343933439434395343963439734398343993440034401344023440334404344053440634407344083440934410344113441234413344143441534416344173441834419344203442134422344233442434425344263442734428344293443034431344323443334434344353443634437344383443934440344413444234443344443444534446344473444834449344503445134452344533445434455344563445734458344593446034461344623446334464344653446634467344683446934470344713447234473344743447534476344773447834479344803448134482344833448434485344863448734488344893449034491344923449334494344953449634497344983449934500345013450234503345043450534506345073450834509345103451134512345133451434515345163451734518345193452034521345223452334524345253452634527345283452934530345313453234533345343453534536345373453834539345403454134542345433454434545345463454734548345493455034551345523455334554345553455634557345583455934560345613456234563345643456534566345673456834569345703457134572345733457434575345763457734578345793458034581345823458334584345853458634587345883458934590345913459234593345943459534596345973459834599346003460134602346033460434605346063460734608346093461034611346123461334614346153461634617346183461934620346213462234623346243462534626346273462834629346303463134632346333463434635346363463734638346393464034641346423464334644346453464634647346483464934650346513465234653346543465534656346573465834659346603466134662346633466434665346663466734668346693467034671346723467334674346753467634677346783467934680346813468234683346843468534686346873468834689346903469134692346933469434695346963469734698346993470034701347023470334704347053470634707347083470934710347113471234713347143471534716347173471834719347203472134722347233472434725347263472734728347293473034731347323473334734347353473634737347383473934740347413474234743347443474534746347473474834749347503475134752347533475434755347563475734758347593476034761347623476334764347653476634767347683476934770347713477234773347743477534776347773477834779347803478134782347833478434785347863478734788347893479034791347923479334794347953479634797347983479934800348013480234803348043480534806348073480834809348103481134812348133481434815348163481734818348193482034821348223482334824348253482634827348283482934830348313483234833348343483534836348373483834839348403484134842348433484434845348463484734848348493485034851348523485334854348553485634857348583485934860348613486234863348643486534866348673486834869348703487134872348733487434875348763487734878348793488034881348823488334884348853488634887348883488934890348913489234893348943489534896348973489834899349003490134902349033490434905349063490734908349093491034911349123491334914349153491634917349183491934920349213492234923349243492534926349273492834929349303493134932349333493434935349363493734938349393494034941349423494334944349453494634947349483494934950349513495234953349543495534956349573495834959349603496134962349633496434965349663496734968349693497034971349723497334974349753497634977349783497934980349813498234983349843498534986349873498834989349903499134992349933499434995349963499734998349993500035001350023500335004350053500635007350083500935010350113501235013350143501535016350173501835019350203502135022350233502435025350263502735028350293503035031350323503335034350353503635037350383503935040350413504235043350443504535046350473504835049350503505135052350533505435055350563505735058350593506035061350623506335064350653506635067350683506935070350713507235073350743507535076350773507835079350803508135082350833508435085350863508735088350893509035091350923509335094350953509635097350983509935100351013510235103351043510535106351073510835109351103511135112351133511435115351163511735118351193512035121351223512335124351253512635127351283512935130351313513235133351343513535136351373513835139351403514135142351433514435145351463514735148351493515035151351523515335154351553515635157351583515935160351613516235163351643516535166351673516835169351703517135172351733517435175351763517735178351793518035181351823518335184351853518635187351883518935190351913519235193351943519535196351973519835199352003520135202352033520435205352063520735208352093521035211352123521335214352153521635217352183521935220352213522235223352243522535226352273522835229352303523135232352333523435235352363523735238352393524035241352423524335244352453524635247352483524935250352513525235253352543525535256352573525835259352603526135262352633526435265352663526735268352693527035271352723527335274352753527635277352783527935280352813528235283352843528535286352873528835289352903529135292352933529435295352963529735298352993530035301353023530335304353053530635307353083530935310353113531235313353143531535316353173531835319353203532135322353233532435325353263532735328353293533035331353323533335334353353533635337353383533935340353413534235343353443534535346353473534835349353503535135352353533535435355353563535735358353593536035361353623536335364353653536635367353683536935370353713537235373353743537535376353773537835379353803538135382353833538435385353863538735388353893539035391353923539335394353953539635397353983539935400354013540235403354043540535406354073540835409354103541135412354133541435415354163541735418354193542035421354223542335424354253542635427354283542935430354313543235433354343543535436354373543835439354403544135442354433544435445354463544735448354493545035451354523545335454354553545635457354583545935460354613546235463354643546535466354673546835469354703547135472354733547435475354763547735478354793548035481354823548335484354853548635487354883548935490354913549235493354943549535496354973549835499355003550135502355033550435505355063550735508355093551035511355123551335514355153551635517355183551935520355213552235523355243552535526355273552835529355303553135532355333553435535355363553735538355393554035541355423554335544355453554635547355483554935550355513555235553355543555535556355573555835559355603556135562355633556435565355663556735568355693557035571355723557335574355753557635577355783557935580355813558235583355843558535586355873558835589355903559135592355933559435595355963559735598355993560035601356023560335604356053560635607356083560935610356113561235613356143561535616356173561835619356203562135622356233562435625356263562735628356293563035631356323563335634356353563635637356383563935640356413564235643356443564535646356473564835649356503565135652356533565435655356563565735658356593566035661356623566335664356653566635667356683566935670356713567235673356743567535676356773567835679356803568135682356833568435685356863568735688356893569035691356923569335694356953569635697356983569935700357013570235703357043570535706357073570835709357103571135712357133571435715357163571735718357193572035721357223572335724357253572635727357283572935730357313573235733357343573535736357373573835739357403574135742357433574435745357463574735748357493575035751357523575335754357553575635757357583575935760357613576235763357643576535766357673576835769357703577135772357733577435775357763577735778357793578035781357823578335784357853578635787357883578935790357913579235793357943579535796357973579835799358003580135802358033580435805358063580735808358093581035811358123581335814358153581635817358183581935820358213582235823358243582535826358273582835829358303583135832358333583435835358363583735838358393584035841358423584335844358453584635847358483584935850358513585235853358543585535856358573585835859358603586135862358633586435865358663586735868358693587035871358723587335874358753587635877358783587935880358813588235883358843588535886358873588835889358903589135892358933589435895358963589735898358993590035901359023590335904359053590635907359083590935910359113591235913359143591535916359173591835919359203592135922359233592435925359263592735928359293593035931359323593335934359353593635937359383593935940359413594235943359443594535946359473594835949359503595135952359533595435955359563595735958359593596035961359623596335964359653596635967359683596935970359713597235973359743597535976359773597835979359803598135982359833598435985359863598735988359893599035991359923599335994359953599635997359983599936000360013600236003360043600536006360073600836009360103601136012360133601436015360163601736018360193602036021360223602336024360253602636027360283602936030360313603236033360343603536036360373603836039360403604136042360433604436045360463604736048360493605036051360523605336054360553605636057360583605936060360613606236063360643606536066360673606836069360703607136072360733607436075360763607736078360793608036081360823608336084360853608636087360883608936090360913609236093360943609536096360973609836099361003610136102361033610436105361063610736108361093611036111361123611336114361153611636117361183611936120361213612236123361243612536126361273612836129361303613136132361333613436135361363613736138361393614036141361423614336144361453614636147361483614936150361513615236153361543615536156361573615836159361603616136162361633616436165361663616736168361693617036171361723617336174361753617636177361783617936180361813618236183361843618536186361873618836189361903619136192361933619436195361963619736198361993620036201362023620336204362053620636207362083620936210362113621236213362143621536216362173621836219362203622136222362233622436225362263622736228362293623036231362323623336234362353623636237362383623936240362413624236243362443624536246362473624836249362503625136252362533625436255362563625736258362593626036261362623626336264362653626636267362683626936270362713627236273362743627536276362773627836279362803628136282362833628436285362863628736288362893629036291362923629336294362953629636297362983629936300363013630236303363043630536306363073630836309363103631136312363133631436315363163631736318363193632036321363223632336324363253632636327363283632936330363313633236333363343633536336363373633836339363403634136342363433634436345363463634736348363493635036351363523635336354363553635636357363583635936360363613636236363363643636536366363673636836369363703637136372363733637436375363763637736378363793638036381363823638336384363853638636387363883638936390363913639236393363943639536396363973639836399364003640136402364033640436405364063640736408364093641036411364123641336414364153641636417364183641936420364213642236423364243642536426364273642836429364303643136432364333643436435364363643736438364393644036441364423644336444364453644636447364483644936450364513645236453364543645536456364573645836459364603646136462364633646436465364663646736468364693647036471364723647336474364753647636477364783647936480364813648236483364843648536486364873648836489364903649136492364933649436495364963649736498364993650036501365023650336504365053650636507365083650936510365113651236513365143651536516365173651836519365203652136522365233652436525365263652736528365293653036531365323653336534365353653636537365383653936540365413654236543365443654536546365473654836549365503655136552365533655436555365563655736558365593656036561365623656336564365653656636567365683656936570365713657236573365743657536576365773657836579365803658136582365833658436585365863658736588365893659036591365923659336594365953659636597365983659936600366013660236603366043660536606366073660836609366103661136612366133661436615366163661736618366193662036621366223662336624366253662636627366283662936630366313663236633366343663536636366373663836639366403664136642366433664436645366463664736648366493665036651366523665336654366553665636657366583665936660366613666236663366643666536666366673666836669366703667136672366733667436675366763667736678366793668036681366823668336684366853668636687366883668936690366913669236693366943669536696366973669836699367003670136702367033670436705367063670736708367093671036711367123671336714367153671636717367183671936720367213672236723367243672536726367273672836729367303673136732367333673436735367363673736738367393674036741367423674336744367453674636747367483674936750367513675236753367543675536756367573675836759367603676136762367633676436765367663676736768367693677036771367723677336774367753677636777367783677936780367813678236783367843678536786367873678836789367903679136792367933679436795367963679736798367993680036801368023680336804368053680636807368083680936810368113681236813368143681536816368173681836819368203682136822368233682436825368263682736828368293683036831368323683336834368353683636837368383683936840368413684236843368443684536846368473684836849368503685136852368533685436855368563685736858368593686036861368623686336864368653686636867368683686936870368713687236873368743687536876368773687836879368803688136882368833688436885368863688736888368893689036891368923689336894368953689636897368983689936900369013690236903369043690536906369073690836909369103691136912369133691436915369163691736918369193692036921369223692336924369253692636927369283692936930369313693236933369343693536936369373693836939369403694136942369433694436945369463694736948369493695036951369523695336954369553695636957369583695936960369613696236963369643696536966369673696836969369703697136972369733697436975369763697736978369793698036981369823698336984369853698636987369883698936990369913699236993369943699536996369973699836999370003700137002370033700437005370063700737008370093701037011370123701337014370153701637017370183701937020370213702237023370243702537026370273702837029370303703137032370333703437035370363703737038370393704037041370423704337044370453704637047370483704937050370513705237053370543705537056370573705837059370603706137062370633706437065370663706737068370693707037071370723707337074370753707637077370783707937080370813708237083370843708537086370873708837089370903709137092370933709437095370963709737098370993710037101371023710337104371053710637107371083710937110371113711237113371143711537116371173711837119371203712137122371233712437125371263712737128371293713037131371323713337134371353713637137371383713937140371413714237143371443714537146371473714837149371503715137152371533715437155371563715737158371593716037161371623716337164371653716637167371683716937170371713717237173371743717537176371773717837179371803718137182371833718437185371863718737188371893719037191371923719337194371953719637197371983719937200372013720237203372043720537206372073720837209372103721137212372133721437215372163721737218372193722037221372223722337224372253722637227372283722937230372313723237233372343723537236372373723837239372403724137242372433724437245372463724737248372493725037251372523725337254372553725637257372583725937260372613726237263372643726537266372673726837269372703727137272372733727437275372763727737278372793728037281372823728337284372853728637287372883728937290372913729237293372943729537296372973729837299373003730137302373033730437305373063730737308373093731037311373123731337314373153731637317373183731937320373213732237323373243732537326373273732837329373303733137332373333733437335373363733737338373393734037341373423734337344373453734637347373483734937350373513735237353373543735537356373573735837359373603736137362373633736437365373663736737368373693737037371373723737337374373753737637377373783737937380373813738237383373843738537386373873738837389373903739137392373933739437395373963739737398373993740037401374023740337404374053740637407374083740937410374113741237413374143741537416374173741837419374203742137422374233742437425374263742737428374293743037431374323743337434374353743637437374383743937440374413744237443374443744537446374473744837449374503745137452374533745437455374563745737458374593746037461374623746337464374653746637467374683746937470374713747237473374743747537476374773747837479374803748137482374833748437485374863748737488374893749037491374923749337494374953749637497374983749937500375013750237503375043750537506375073750837509375103751137512375133751437515375163751737518375193752037521375223752337524375253752637527375283752937530375313753237533375343753537536375373753837539375403754137542375433754437545375463754737548375493755037551375523755337554375553755637557375583755937560375613756237563375643756537566375673756837569375703757137572375733757437575375763757737578375793758037581375823758337584375853758637587375883758937590375913759237593375943759537596375973759837599376003760137602376033760437605376063760737608376093761037611376123761337614376153761637617376183761937620376213762237623376243762537626376273762837629376303763137632376333763437635376363763737638376393764037641376423764337644376453764637647376483764937650376513765237653376543765537656376573765837659376603766137662376633766437665376663766737668376693767037671376723767337674376753767637677376783767937680376813768237683376843768537686376873768837689376903769137692376933769437695376963769737698376993770037701377023770337704377053770637707377083770937710377113771237713377143771537716377173771837719377203772137722377233772437725377263772737728377293773037731377323773337734377353773637737377383773937740377413774237743377443774537746377473774837749377503775137752377533775437755377563775737758377593776037761377623776337764377653776637767377683776937770377713777237773377743777537776377773777837779377803778137782377833778437785377863778737788377893779037791377923779337794377953779637797377983779937800378013780237803378043780537806378073780837809378103781137812378133781437815378163781737818378193782037821378223782337824378253782637827378283782937830378313783237833378343783537836378373783837839378403784137842378433784437845378463784737848378493785037851378523785337854378553785637857378583785937860378613786237863378643786537866378673786837869378703787137872378733787437875378763787737878378793788037881378823788337884378853788637887378883788937890378913789237893378943789537896378973789837899379003790137902379033790437905379063790737908379093791037911379123791337914379153791637917379183791937920379213792237923379243792537926379273792837929379303793137932379333793437935379363793737938379393794037941379423794337944379453794637947379483794937950379513795237953379543795537956379573795837959379603796137962379633796437965379663796737968379693797037971379723797337974379753797637977379783797937980379813798237983379843798537986379873798837989379903799137992379933799437995379963799737998379993800038001380023800338004380053800638007380083800938010380113801238013380143801538016380173801838019380203802138022380233802438025380263802738028380293803038031380323803338034380353803638037380383803938040380413804238043380443804538046380473804838049380503805138052380533805438055380563805738058380593806038061380623806338064380653806638067380683806938070380713807238073380743807538076380773807838079380803808138082380833808438085380863808738088380893809038091380923809338094380953809638097380983809938100381013810238103381043810538106381073810838109381103811138112381133811438115381163811738118381193812038121381223812338124381253812638127381283812938130381313813238133381343813538136381373813838139381403814138142381433814438145381463814738148381493815038151381523815338154381553815638157381583815938160381613816238163381643816538166381673816838169381703817138172381733817438175381763817738178381793818038181381823818338184381853818638187381883818938190381913819238193381943819538196381973819838199382003820138202382033820438205382063820738208382093821038211382123821338214382153821638217382183821938220382213822238223382243822538226382273822838229382303823138232382333823438235382363823738238382393824038241382423824338244382453824638247382483824938250382513825238253382543825538256382573825838259382603826138262382633826438265382663826738268382693827038271382723827338274382753827638277382783827938280382813828238283382843828538286382873828838289382903829138292382933829438295382963829738298382993830038301383023830338304383053830638307383083830938310383113831238313383143831538316383173831838319383203832138322383233832438325383263832738328383293833038331383323833338334383353833638337383383833938340383413834238343383443834538346383473834838349383503835138352383533835438355383563835738358383593836038361383623836338364383653836638367383683836938370383713837238373383743837538376383773837838379383803838138382383833838438385383863838738388383893839038391383923839338394383953839638397383983839938400384013840238403384043840538406384073840838409384103841138412384133841438415384163841738418384193842038421384223842338424384253842638427384283842938430384313843238433384343843538436384373843838439384403844138442384433844438445384463844738448384493845038451384523845338454384553845638457384583845938460384613846238463384643846538466384673846838469384703847138472384733847438475384763847738478384793848038481384823848338484384853848638487384883848938490384913849238493384943849538496384973849838499385003850138502385033850438505385063850738508385093851038511385123851338514385153851638517385183851938520385213852238523385243852538526385273852838529385303853138532385333853438535385363853738538385393854038541385423854338544385453854638547385483854938550385513855238553385543855538556385573855838559385603856138562385633856438565385663856738568385693857038571385723857338574385753857638577385783857938580385813858238583385843858538586385873858838589385903859138592385933859438595385963859738598385993860038601386023860338604386053860638607386083860938610386113861238613386143861538616386173861838619386203862138622386233862438625386263862738628386293863038631386323863338634386353863638637386383863938640386413864238643386443864538646386473864838649386503865138652386533865438655386563865738658386593866038661386623866338664386653866638667386683866938670386713867238673386743867538676386773867838679386803868138682386833868438685386863868738688386893869038691386923869338694386953869638697386983869938700387013870238703387043870538706387073870838709387103871138712387133871438715387163871738718387193872038721387223872338724387253872638727387283872938730387313873238733387343873538736387373873838739387403874138742387433874438745387463874738748387493875038751387523875338754387553875638757387583875938760387613876238763387643876538766387673876838769387703877138772387733877438775387763877738778387793878038781387823878338784387853878638787387883878938790387913879238793387943879538796387973879838799388003880138802388033880438805388063880738808388093881038811388123881338814388153881638817388183881938820388213882238823388243882538826388273882838829388303883138832388333883438835388363883738838388393884038841388423884338844388453884638847388483884938850388513885238853388543885538856388573885838859388603886138862388633886438865388663886738868388693887038871388723887338874388753887638877388783887938880388813888238883388843888538886388873888838889388903889138892388933889438895388963889738898388993890038901389023890338904389053890638907389083890938910389113891238913389143891538916389173891838919389203892138922389233892438925389263892738928389293893038931389323893338934389353893638937389383893938940389413894238943389443894538946389473894838949389503895138952389533895438955389563895738958389593896038961389623896338964389653896638967389683896938970389713897238973389743897538976389773897838979389803898138982389833898438985389863898738988389893899038991389923899338994389953899638997389983899939000390013900239003390043900539006390073900839009390103901139012390133901439015390163901739018390193902039021390223902339024390253902639027390283902939030390313903239033390343903539036390373903839039390403904139042390433904439045390463904739048390493905039051390523905339054390553905639057390583905939060390613906239063390643906539066390673906839069390703907139072390733907439075390763907739078390793908039081390823908339084390853908639087390883908939090390913909239093390943909539096390973909839099391003910139102391033910439105391063910739108391093911039111391123911339114391153911639117391183911939120391213912239123391243912539126391273912839129391303913139132391333913439135391363913739138391393914039141391423914339144391453914639147391483914939150391513915239153391543915539156391573915839159391603916139162391633916439165391663916739168391693917039171391723917339174391753917639177391783917939180391813918239183391843918539186391873918839189391903919139192391933919439195391963919739198391993920039201392023920339204392053920639207392083920939210392113921239213392143921539216392173921839219392203922139222392233922439225392263922739228392293923039231392323923339234392353923639237392383923939240392413924239243392443924539246392473924839249392503925139252392533925439255392563925739258392593926039261392623926339264392653926639267392683926939270392713927239273392743927539276392773927839279392803928139282392833928439285392863928739288392893929039291392923929339294392953929639297392983929939300393013930239303393043930539306393073930839309393103931139312393133931439315393163931739318393193932039321393223932339324393253932639327393283932939330393313933239333393343933539336393373933839339393403934139342393433934439345393463934739348393493935039351393523935339354393553935639357393583935939360393613936239363393643936539366393673936839369393703937139372393733937439375393763937739378393793938039381393823938339384393853938639387393883938939390393913939239393393943939539396393973939839399394003940139402394033940439405394063940739408394093941039411394123941339414394153941639417394183941939420394213942239423394243942539426394273942839429394303943139432394333943439435394363943739438394393944039441394423944339444394453944639447394483944939450394513945239453394543945539456394573945839459394603946139462394633946439465394663946739468394693947039471394723947339474394753947639477394783947939480394813948239483394843948539486394873948839489394903949139492394933949439495394963949739498394993950039501395023950339504395053950639507395083950939510395113951239513395143951539516395173951839519395203952139522395233952439525395263952739528395293953039531395323953339534395353953639537395383953939540395413954239543395443954539546395473954839549395503955139552395533955439555395563955739558395593956039561395623956339564395653956639567395683956939570395713957239573395743957539576395773957839579395803958139582395833958439585395863958739588395893959039591395923959339594395953959639597395983959939600396013960239603396043960539606396073960839609396103961139612396133961439615396163961739618396193962039621396223962339624396253962639627396283962939630396313963239633396343963539636396373963839639396403964139642396433964439645396463964739648396493965039651396523965339654396553965639657396583965939660396613966239663396643966539666396673966839669396703967139672396733967439675396763967739678396793968039681396823968339684396853968639687396883968939690396913969239693396943969539696396973969839699397003970139702397033970439705397063970739708397093971039711397123971339714397153971639717397183971939720397213972239723397243972539726397273972839729397303973139732397333973439735397363973739738397393974039741397423974339744397453974639747397483974939750397513975239753397543975539756397573975839759397603976139762397633976439765397663976739768397693977039771397723977339774397753977639777397783977939780397813978239783397843978539786397873978839789397903979139792397933979439795397963979739798397993980039801398023980339804398053980639807398083980939810398113981239813398143981539816398173981839819398203982139822398233982439825398263982739828398293983039831398323983339834398353983639837398383983939840398413984239843398443984539846398473984839849398503985139852398533985439855398563985739858398593986039861398623986339864398653986639867398683986939870398713987239873398743987539876398773987839879398803988139882398833988439885398863988739888398893989039891398923989339894398953989639897398983989939900399013990239903399043990539906399073990839909399103991139912399133991439915399163991739918399193992039921399223992339924399253992639927399283992939930399313993239933399343993539936399373993839939399403994139942399433994439945399463994739948399493995039951399523995339954399553995639957399583995939960399613996239963399643996539966399673996839969399703997139972399733997439975399763997739978399793998039981399823998339984399853998639987399883998939990399913999239993399943999539996399973999839999400004000140002400034000440005400064000740008400094001040011400124001340014400154001640017400184001940020400214002240023400244002540026400274002840029400304003140032400334003440035400364003740038400394004040041400424004340044400454004640047400484004940050400514005240053400544005540056400574005840059400604006140062400634006440065400664006740068400694007040071400724007340074400754007640077400784007940080400814008240083400844008540086400874008840089400904009140092400934009440095400964009740098400994010040101401024010340104401054010640107401084010940110401114011240113401144011540116401174011840119401204012140122401234012440125401264012740128401294013040131401324013340134401354013640137401384013940140401414014240143401444014540146401474014840149401504015140152401534015440155401564015740158401594016040161401624016340164401654016640167401684016940170401714017240173401744017540176401774017840179401804018140182401834018440185401864018740188401894019040191401924019340194401954019640197401984019940200402014020240203402044020540206402074020840209402104021140212402134021440215402164021740218402194022040221402224022340224402254022640227402284022940230402314023240233402344023540236402374023840239402404024140242402434024440245402464024740248402494025040251402524025340254402554025640257402584025940260402614026240263402644026540266402674026840269402704027140272402734027440275402764027740278402794028040281402824028340284402854028640287402884028940290402914029240293402944029540296402974029840299403004030140302403034030440305403064030740308403094031040311403124031340314403154031640317403184031940320403214032240323403244032540326403274032840329403304033140332403334033440335403364033740338403394034040341403424034340344403454034640347403484034940350403514035240353403544035540356403574035840359403604036140362403634036440365403664036740368403694037040371403724037340374403754037640377403784037940380403814038240383403844038540386403874038840389403904039140392403934039440395403964039740398403994040040401404024040340404404054040640407404084040940410404114041240413404144041540416404174041840419404204042140422404234042440425404264042740428404294043040431404324043340434404354043640437404384043940440404414044240443404444044540446404474044840449404504045140452404534045440455404564045740458404594046040461404624046340464404654046640467404684046940470404714047240473404744047540476404774047840479404804048140482404834048440485404864048740488404894049040491404924049340494404954049640497404984049940500405014050240503405044050540506405074050840509405104051140512405134051440515405164051740518405194052040521405224052340524405254052640527405284052940530405314053240533405344053540536405374053840539405404054140542405434054440545405464054740548405494055040551405524055340554405554055640557405584055940560405614056240563405644056540566405674056840569405704057140572405734057440575405764057740578405794058040581405824058340584405854058640587405884058940590405914059240593405944059540596405974059840599406004060140602406034060440605406064060740608406094061040611406124061340614406154061640617406184061940620406214062240623406244062540626406274062840629406304063140632406334063440635406364063740638406394064040641406424064340644406454064640647406484064940650406514065240653406544065540656406574065840659406604066140662406634066440665406664066740668406694067040671406724067340674406754067640677406784067940680406814068240683406844068540686406874068840689406904069140692406934069440695406964069740698406994070040701407024070340704407054070640707407084070940710407114071240713407144071540716407174071840719407204072140722407234072440725407264072740728407294073040731407324073340734407354073640737407384073940740407414074240743407444074540746407474074840749407504075140752407534075440755407564075740758407594076040761407624076340764407654076640767407684076940770407714077240773407744077540776407774077840779407804078140782407834078440785407864078740788407894079040791407924079340794407954079640797407984079940800408014080240803408044080540806408074080840809408104081140812408134081440815408164081740818408194082040821408224082340824408254082640827408284082940830408314083240833408344083540836408374083840839408404084140842408434084440845408464084740848408494085040851408524085340854408554085640857408584085940860408614086240863408644086540866408674086840869408704087140872408734087440875408764087740878408794088040881408824088340884408854088640887408884088940890408914089240893408944089540896408974089840899409004090140902409034090440905409064090740908409094091040911409124091340914409154091640917409184091940920409214092240923409244092540926409274092840929409304093140932409334093440935409364093740938409394094040941409424094340944409454094640947409484094940950409514095240953409544095540956409574095840959409604096140962409634096440965409664096740968409694097040971409724097340974409754097640977409784097940980409814098240983409844098540986409874098840989409904099140992409934099440995409964099740998409994100041001410024100341004410054100641007410084100941010410114101241013410144101541016410174101841019410204102141022410234102441025410264102741028410294103041031410324103341034410354103641037410384103941040410414104241043410444104541046410474104841049410504105141052410534105441055410564105741058410594106041061410624106341064410654106641067410684106941070410714107241073410744107541076410774107841079410804108141082410834108441085410864108741088410894109041091410924109341094410954109641097410984109941100411014110241103411044110541106411074110841109411104111141112411134111441115411164111741118411194112041121411224112341124411254112641127411284112941130411314113241133411344113541136411374113841139411404114141142411434114441145411464114741148411494115041151411524115341154411554115641157411584115941160411614116241163411644116541166411674116841169411704117141172411734117441175411764117741178411794118041181411824118341184411854118641187411884118941190411914119241193411944119541196411974119841199412004120141202412034120441205412064120741208412094121041211412124121341214412154121641217412184121941220412214122241223412244122541226412274122841229412304123141232412334123441235412364123741238412394124041241412424124341244412454124641247412484124941250412514125241253412544125541256412574125841259412604126141262412634126441265412664126741268412694127041271412724127341274412754127641277412784127941280412814128241283412844128541286412874128841289412904129141292412934129441295412964129741298412994130041301413024130341304413054130641307413084130941310413114131241313413144131541316413174131841319413204132141322413234132441325413264132741328413294133041331413324133341334413354133641337413384133941340413414134241343413444134541346413474134841349413504135141352413534135441355413564135741358413594136041361413624136341364413654136641367413684136941370413714137241373413744137541376413774137841379413804138141382413834138441385413864138741388413894139041391413924139341394413954139641397413984139941400414014140241403414044140541406414074140841409414104141141412414134141441415414164141741418414194142041421414224142341424414254142641427414284142941430414314143241433414344143541436414374143841439414404144141442414434144441445414464144741448414494145041451414524145341454414554145641457414584145941460414614146241463414644146541466414674146841469414704147141472414734147441475414764147741478414794148041481414824148341484414854148641487414884148941490414914149241493414944149541496414974149841499415004150141502415034150441505415064150741508415094151041511415124151341514415154151641517415184151941520415214152241523415244152541526415274152841529415304153141532415334153441535415364153741538415394154041541415424154341544415454154641547415484154941550415514155241553415544155541556415574155841559415604156141562415634156441565415664156741568415694157041571415724157341574415754157641577415784157941580415814158241583415844158541586415874158841589415904159141592415934159441595415964159741598415994160041601416024160341604416054160641607416084160941610416114161241613416144161541616416174161841619416204162141622416234162441625416264162741628416294163041631416324163341634416354163641637416384163941640416414164241643416444164541646416474164841649416504165141652416534165441655416564165741658416594166041661416624166341664416654166641667416684166941670416714167241673416744167541676416774167841679416804168141682416834168441685416864168741688416894169041691416924169341694416954169641697416984169941700417014170241703417044170541706417074170841709417104171141712417134171441715417164171741718417194172041721417224172341724417254172641727417284172941730417314173241733417344173541736417374173841739417404174141742417434174441745417464174741748417494175041751417524175341754417554175641757417584175941760417614176241763417644176541766417674176841769417704177141772417734177441775417764177741778417794178041781417824178341784417854178641787417884178941790417914179241793417944179541796417974179841799418004180141802418034180441805418064180741808418094181041811418124181341814418154181641817418184181941820418214182241823418244182541826418274182841829418304183141832418334183441835418364183741838418394184041841418424184341844418454184641847418484184941850418514185241853418544185541856418574185841859418604186141862418634186441865418664186741868418694187041871418724187341874418754187641877418784187941880418814188241883418844188541886418874188841889418904189141892418934189441895418964189741898418994190041901419024190341904419054190641907419084190941910419114191241913419144191541916419174191841919419204192141922419234192441925419264192741928419294193041931419324193341934419354193641937419384193941940419414194241943419444194541946419474194841949419504195141952419534195441955419564195741958419594196041961419624196341964419654196641967419684196941970419714197241973419744197541976419774197841979419804198141982419834198441985419864198741988419894199041991419924199341994419954199641997419984199942000420014200242003420044200542006420074200842009420104201142012420134201442015420164201742018420194202042021420224202342024420254202642027420284202942030420314203242033420344203542036420374203842039420404204142042420434204442045420464204742048420494205042051420524205342054420554205642057420584205942060420614206242063420644206542066420674206842069420704207142072420734207442075420764207742078420794208042081420824208342084420854208642087420884208942090420914209242093420944209542096420974209842099421004210142102421034210442105421064210742108421094211042111421124211342114421154211642117421184211942120421214212242123421244212542126421274212842129421304213142132421334213442135421364213742138421394214042141421424214342144421454214642147421484214942150421514215242153421544215542156421574215842159421604216142162421634216442165421664216742168421694217042171421724217342174421754217642177421784217942180421814218242183421844218542186421874218842189421904219142192421934219442195421964219742198421994220042201422024220342204422054220642207422084220942210422114221242213422144221542216422174221842219422204222142222422234222442225422264222742228422294223042231422324223342234422354223642237422384223942240422414224242243422444224542246422474224842249422504225142252422534225442255422564225742258422594226042261422624226342264422654226642267422684226942270422714227242273422744227542276422774227842279422804228142282422834228442285422864228742288422894229042291422924229342294422954229642297422984229942300423014230242303423044230542306423074230842309423104231142312423134231442315423164231742318423194232042321423224232342324423254232642327423284232942330423314233242333423344233542336423374233842339423404234142342423434234442345423464234742348423494235042351423524235342354423554235642357423584235942360423614236242363423644236542366423674236842369423704237142372423734237442375423764237742378423794238042381423824238342384423854238642387423884238942390423914239242393423944239542396423974239842399424004240142402424034240442405424064240742408424094241042411424124241342414424154241642417424184241942420424214242242423424244242542426424274242842429424304243142432424334243442435424364243742438424394244042441424424244342444424454244642447424484244942450424514245242453424544245542456424574245842459424604246142462424634246442465424664246742468424694247042471424724247342474424754247642477424784247942480424814248242483424844248542486424874248842489424904249142492424934249442495424964249742498424994250042501425024250342504425054250642507425084250942510425114251242513425144251542516425174251842519425204252142522425234252442525425264252742528425294253042531425324253342534425354253642537425384253942540425414254242543425444254542546425474254842549425504255142552425534255442555425564255742558425594256042561425624256342564425654256642567425684256942570425714257242573425744257542576425774257842579425804258142582425834258442585425864258742588425894259042591425924259342594425954259642597425984259942600426014260242603426044260542606426074260842609426104261142612426134261442615426164261742618426194262042621426224262342624426254262642627426284262942630426314263242633426344263542636426374263842639426404264142642426434264442645426464264742648426494265042651426524265342654426554265642657426584265942660426614266242663426644266542666426674266842669426704267142672426734267442675426764267742678426794268042681426824268342684426854268642687426884268942690426914269242693426944269542696426974269842699427004270142702427034270442705427064270742708427094271042711427124271342714427154271642717427184271942720427214272242723427244272542726427274272842729427304273142732427334273442735427364273742738427394274042741427424274342744427454274642747427484274942750427514275242753427544275542756427574275842759427604276142762427634276442765427664276742768427694277042771427724277342774427754277642777427784277942780427814278242783427844278542786427874278842789427904279142792427934279442795427964279742798427994280042801428024280342804428054280642807428084280942810428114281242813428144281542816428174281842819428204282142822428234282442825428264282742828428294283042831428324283342834428354283642837428384283942840428414284242843428444284542846428474284842849428504285142852428534285442855428564285742858428594286042861428624286342864428654286642867428684286942870428714287242873428744287542876428774287842879428804288142882428834288442885428864288742888428894289042891428924289342894428954289642897428984289942900429014290242903429044290542906429074290842909429104291142912429134291442915429164291742918429194292042921429224292342924429254292642927429284292942930429314293242933429344293542936429374293842939429404294142942429434294442945429464294742948429494295042951429524295342954429554295642957429584295942960429614296242963429644296542966429674296842969429704297142972429734297442975429764297742978429794298042981429824298342984429854298642987429884298942990429914299242993429944299542996429974299842999430004300143002430034300443005430064300743008430094301043011430124301343014430154301643017430184301943020430214302243023430244302543026430274302843029430304303143032430334303443035430364303743038430394304043041430424304343044430454304643047430484304943050430514305243053430544305543056430574305843059430604306143062430634306443065430664306743068430694307043071430724307343074430754307643077430784307943080430814308243083430844308543086430874308843089430904309143092430934309443095430964309743098430994310043101431024310343104431054310643107431084310943110431114311243113431144311543116431174311843119431204312143122431234312443125431264312743128431294313043131431324313343134431354313643137431384313943140431414314243143431444314543146431474314843149431504315143152431534315443155431564315743158431594316043161431624316343164431654316643167431684316943170431714317243173431744317543176431774317843179431804318143182431834318443185431864318743188431894319043191431924319343194431954319643197431984319943200432014320243203432044320543206432074320843209432104321143212432134321443215432164321743218432194322043221432224322343224432254322643227432284322943230432314323243233432344323543236432374323843239432404324143242432434324443245432464324743248432494325043251432524325343254432554325643257432584325943260432614326243263432644326543266432674326843269432704327143272432734327443275432764327743278432794328043281432824328343284432854328643287432884328943290432914329243293432944329543296432974329843299433004330143302433034330443305433064330743308433094331043311433124331343314433154331643317433184331943320433214332243323433244332543326433274332843329433304333143332433334333443335433364333743338433394334043341433424334343344433454334643347433484334943350433514335243353433544335543356433574335843359433604336143362433634336443365433664336743368433694337043371433724337343374433754337643377433784337943380433814338243383433844338543386433874338843389433904339143392433934339443395433964339743398433994340043401434024340343404434054340643407434084340943410434114341243413434144341543416434174341843419434204342143422434234342443425434264342743428434294343043431434324343343434434354343643437434384343943440434414344243443434444344543446434474344843449434504345143452434534345443455434564345743458434594346043461434624346343464434654346643467434684346943470434714347243473434744347543476434774347843479434804348143482434834348443485434864348743488434894349043491434924349343494434954349643497434984349943500435014350243503435044350543506435074350843509435104351143512435134351443515435164351743518435194352043521435224352343524435254352643527435284352943530435314353243533435344353543536435374353843539435404354143542435434354443545435464354743548435494355043551435524355343554435554355643557435584355943560435614356243563435644356543566435674356843569435704357143572435734357443575435764357743578435794358043581435824358343584435854358643587435884358943590435914359243593435944359543596435974359843599436004360143602436034360443605436064360743608436094361043611436124361343614436154361643617436184361943620436214362243623436244362543626436274362843629436304363143632436334363443635436364363743638436394364043641436424364343644436454364643647436484364943650436514365243653436544365543656436574365843659436604366143662436634366443665436664366743668436694367043671436724367343674436754367643677436784367943680436814368243683436844368543686436874368843689436904369143692436934369443695436964369743698436994370043701437024370343704437054370643707437084370943710437114371243713437144371543716437174371843719437204372143722437234372443725437264372743728437294373043731437324373343734437354373643737437384373943740437414374243743437444374543746437474374843749437504375143752437534375443755437564375743758437594376043761437624376343764437654376643767437684376943770437714377243773437744377543776437774377843779437804378143782437834378443785437864378743788437894379043791437924379343794437954379643797437984379943800438014380243803438044380543806438074380843809438104381143812438134381443815438164381743818438194382043821438224382343824438254382643827438284382943830438314383243833438344383543836438374383843839438404384143842438434384443845438464384743848438494385043851438524385343854438554385643857438584385943860438614386243863438644386543866438674386843869438704387143872438734387443875438764387743878438794388043881438824388343884438854388643887438884388943890438914389243893438944389543896438974389843899439004390143902439034390443905439064390743908439094391043911439124391343914439154391643917439184391943920439214392243923439244392543926439274392843929439304393143932439334393443935439364393743938439394394043941439424394343944439454394643947439484394943950439514395243953439544395543956439574395843959439604396143962439634396443965439664396743968439694397043971439724397343974439754397643977439784397943980439814398243983439844398543986439874398843989439904399143992439934399443995439964399743998439994400044001440024400344004440054400644007440084400944010440114401244013440144401544016440174401844019440204402144022440234402444025440264402744028440294403044031440324403344034440354403644037440384403944040440414404244043440444404544046440474404844049440504405144052440534405444055440564405744058440594406044061440624406344064440654406644067440684406944070440714407244073440744407544076440774407844079440804408144082440834408444085440864408744088440894409044091440924409344094440954409644097440984409944100441014410244103441044410544106441074410844109441104411144112441134411444115441164411744118441194412044121441224412344124441254412644127441284412944130441314413244133441344413544136441374413844139441404414144142441434414444145441464414744148441494415044151441524415344154441554415644157441584415944160441614416244163441644416544166441674416844169441704417144172441734417444175441764417744178441794418044181441824418344184441854418644187441884418944190441914419244193441944419544196441974419844199442004420144202442034420444205442064420744208442094421044211442124421344214442154421644217442184421944220442214422244223442244422544226442274422844229442304423144232442334423444235442364423744238442394424044241442424424344244442454424644247442484424944250442514425244253442544425544256442574425844259442604426144262442634426444265442664426744268442694427044271442724427344274442754427644277442784427944280442814428244283442844428544286442874428844289442904429144292442934429444295442964429744298442994430044301443024430344304443054430644307443084430944310443114431244313443144431544316443174431844319443204432144322443234432444325443264432744328443294433044331443324433344334443354433644337443384433944340443414434244343443444434544346443474434844349443504435144352443534435444355443564435744358443594436044361443624436344364443654436644367443684436944370443714437244373443744437544376443774437844379443804438144382443834438444385443864438744388443894439044391443924439344394443954439644397443984439944400444014440244403444044440544406444074440844409444104441144412444134441444415444164441744418444194442044421444224442344424444254442644427444284442944430444314443244433444344443544436444374443844439444404444144442444434444444445444464444744448444494445044451444524445344454444554445644457444584445944460444614446244463444644446544466444674446844469444704447144472444734447444475444764447744478444794448044481444824448344484444854448644487444884448944490444914449244493444944449544496444974449844499445004450144502445034450444505445064450744508445094451044511445124451344514445154451644517445184451944520445214452244523445244452544526445274452844529445304453144532445334453444535445364453744538445394454044541445424454344544445454454644547445484454944550445514455244553445544455544556445574455844559445604456144562445634456444565445664456744568445694457044571445724457344574445754457644577445784457944580445814458244583445844458544586445874458844589445904459144592445934459444595445964459744598445994460044601446024460344604446054460644607446084460944610446114461244613446144461544616446174461844619446204462144622446234462444625446264462744628446294463044631446324463344634446354463644637446384463944640446414464244643446444464544646446474464844649446504465144652446534465444655446564465744658446594466044661446624466344664446654466644667446684466944670446714467244673446744467544676446774467844679446804468144682446834468444685446864468744688446894469044691446924469344694446954469644697446984469944700447014470244703447044470544706447074470844709447104471144712447134471444715447164471744718447194472044721447224472344724447254472644727447284472944730447314473244733447344473544736447374473844739447404474144742447434474444745447464474744748447494475044751447524475344754447554475644757447584475944760447614476244763447644476544766447674476844769447704477144772447734477444775447764477744778447794478044781447824478344784447854478644787447884478944790447914479244793447944479544796447974479844799448004480144802448034480444805448064480744808448094481044811448124481344814448154481644817448184481944820448214482244823448244482544826448274482844829448304483144832448334483444835448364483744838448394484044841448424484344844448454484644847448484484944850448514485244853448544485544856448574485844859448604486144862448634486444865448664486744868448694487044871448724487344874448754487644877448784487944880448814488244883448844488544886448874488844889448904489144892448934489444895448964489744898448994490044901449024490344904449054490644907449084490944910449114491244913449144491544916449174491844919449204492144922449234492444925449264492744928449294493044931449324493344934449354493644937449384493944940449414494244943449444494544946449474494844949449504495144952449534495444955449564495744958449594496044961449624496344964449654496644967449684496944970449714497244973449744497544976449774497844979449804498144982449834498444985449864498744988449894499044991449924499344994449954499644997449984499945000450014500245003450044500545006450074500845009450104501145012450134501445015450164501745018450194502045021450224502345024450254502645027450284502945030450314503245033450344503545036450374503845039450404504145042450434504445045450464504745048450494505045051450524505345054450554505645057450584505945060450614506245063450644506545066450674506845069450704507145072450734507445075450764507745078450794508045081450824508345084450854508645087450884508945090450914509245093450944509545096450974509845099451004510145102451034510445105451064510745108451094511045111451124511345114451154511645117451184511945120451214512245123451244512545126451274512845129451304513145132451334513445135451364513745138451394514045141451424514345144451454514645147451484514945150451514515245153451544515545156451574515845159451604516145162451634516445165451664516745168451694517045171451724517345174451754517645177451784517945180451814518245183451844518545186451874518845189451904519145192451934519445195451964519745198451994520045201452024520345204452054520645207452084520945210452114521245213452144521545216452174521845219452204522145222452234522445225452264522745228452294523045231452324523345234452354523645237452384523945240452414524245243452444524545246452474524845249452504525145252452534525445255452564525745258452594526045261452624526345264452654526645267452684526945270452714527245273452744527545276452774527845279452804528145282452834528445285452864528745288452894529045291452924529345294452954529645297452984529945300453014530245303453044530545306453074530845309453104531145312453134531445315453164531745318453194532045321453224532345324453254532645327453284532945330453314533245333453344533545336453374533845339453404534145342453434534445345453464534745348453494535045351453524535345354453554535645357453584535945360453614536245363453644536545366453674536845369453704537145372453734537445375453764537745378453794538045381453824538345384453854538645387453884538945390453914539245393453944539545396453974539845399454004540145402454034540445405454064540745408454094541045411454124541345414454154541645417454184541945420454214542245423454244542545426454274542845429454304543145432454334543445435454364543745438454394544045441454424544345444454454544645447454484544945450454514545245453454544545545456454574545845459454604546145462454634546445465454664546745468454694547045471454724547345474454754547645477454784547945480454814548245483454844548545486454874548845489454904549145492454934549445495454964549745498454994550045501455024550345504455054550645507455084550945510455114551245513455144551545516455174551845519455204552145522455234552445525455264552745528455294553045531455324553345534455354553645537455384553945540455414554245543455444554545546455474554845549455504555145552455534555445555455564555745558455594556045561455624556345564455654556645567455684556945570455714557245573455744557545576455774557845579455804558145582455834558445585455864558745588455894559045591455924559345594455954559645597455984559945600456014560245603456044560545606456074560845609456104561145612456134561445615456164561745618456194562045621456224562345624456254562645627456284562945630456314563245633456344563545636456374563845639456404564145642456434564445645456464564745648456494565045651456524565345654456554565645657456584565945660456614566245663456644566545666456674566845669456704567145672456734567445675456764567745678456794568045681456824568345684456854568645687456884568945690456914569245693456944569545696456974569845699457004570145702457034570445705457064570745708457094571045711457124571345714457154571645717457184571945720457214572245723457244572545726457274572845729457304573145732457334573445735457364573745738457394574045741457424574345744457454574645747457484574945750457514575245753457544575545756457574575845759457604576145762457634576445765457664576745768457694577045771457724577345774457754577645777457784577945780457814578245783457844578545786457874578845789457904579145792457934579445795457964579745798457994580045801458024580345804458054580645807458084580945810458114581245813458144581545816458174581845819458204582145822458234582445825458264582745828458294583045831458324583345834458354583645837458384583945840458414584245843458444584545846458474584845849458504585145852458534585445855458564585745858458594586045861458624586345864458654586645867458684586945870458714587245873458744587545876458774587845879458804588145882458834588445885458864588745888458894589045891458924589345894458954589645897458984589945900459014590245903459044590545906459074590845909459104591145912459134591445915459164591745918459194592045921459224592345924459254592645927459284592945930459314593245933459344593545936459374593845939459404594145942459434594445945459464594745948459494595045951459524595345954459554595645957459584595945960459614596245963459644596545966459674596845969459704597145972459734597445975459764597745978459794598045981459824598345984459854598645987459884598945990459914599245993459944599545996459974599845999460004600146002460034600446005460064600746008460094601046011460124601346014460154601646017460184601946020460214602246023460244602546026460274602846029460304603146032460334603446035460364603746038460394604046041460424604346044460454604646047460484604946050460514605246053460544605546056460574605846059460604606146062460634606446065460664606746068460694607046071460724607346074460754607646077460784607946080460814608246083460844608546086460874608846089460904609146092460934609446095460964609746098460994610046101461024610346104461054610646107461084610946110461114611246113461144611546116461174611846119461204612146122461234612446125461264612746128461294613046131461324613346134461354613646137461384613946140461414614246143461444614546146461474614846149461504615146152461534615446155461564615746158461594616046161461624616346164461654616646167461684616946170461714617246173461744617546176461774617846179461804618146182461834618446185461864618746188461894619046191461924619346194461954619646197461984619946200462014620246203462044620546206462074620846209462104621146212462134621446215462164621746218462194622046221462224622346224462254622646227462284622946230462314623246233462344623546236462374623846239462404624146242462434624446245462464624746248462494625046251462524625346254462554625646257462584625946260462614626246263462644626546266462674626846269462704627146272462734627446275462764627746278462794628046281462824628346284462854628646287462884628946290462914629246293462944629546296462974629846299463004630146302463034630446305463064630746308463094631046311463124631346314463154631646317463184631946320463214632246323463244632546326463274632846329463304633146332463334633446335463364633746338463394634046341463424634346344463454634646347463484634946350463514635246353463544635546356463574635846359463604636146362463634636446365463664636746368463694637046371463724637346374463754637646377463784637946380463814638246383463844638546386463874638846389463904639146392463934639446395463964639746398463994640046401464024640346404464054640646407464084640946410464114641246413464144641546416464174641846419464204642146422464234642446425464264642746428464294643046431464324643346434464354643646437464384643946440464414644246443464444644546446464474644846449464504645146452464534645446455464564645746458464594646046461464624646346464464654646646467464684646946470464714647246473464744647546476464774647846479464804648146482464834648446485464864648746488464894649046491464924649346494464954649646497464984649946500465014650246503465044650546506465074650846509465104651146512465134651446515465164651746518465194652046521465224652346524465254652646527465284652946530465314653246533465344653546536465374653846539465404654146542465434654446545465464654746548465494655046551465524655346554465554655646557465584655946560465614656246563465644656546566465674656846569465704657146572465734657446575465764657746578465794658046581465824658346584465854658646587465884658946590465914659246593465944659546596465974659846599466004660146602466034660446605466064660746608466094661046611466124661346614466154661646617466184661946620466214662246623466244662546626466274662846629466304663146632466334663446635466364663746638466394664046641466424664346644466454664646647466484664946650466514665246653466544665546656466574665846659466604666146662466634666446665466664666746668466694667046671466724667346674466754667646677466784667946680466814668246683466844668546686466874668846689466904669146692466934669446695466964669746698466994670046701467024670346704467054670646707467084670946710467114671246713467144671546716467174671846719467204672146722467234672446725467264672746728467294673046731467324673346734467354673646737467384673946740467414674246743467444674546746467474674846749467504675146752467534675446755467564675746758467594676046761467624676346764467654676646767467684676946770467714677246773467744677546776467774677846779467804678146782467834678446785467864678746788467894679046791467924679346794467954679646797467984679946800468014680246803468044680546806468074680846809468104681146812468134681446815468164681746818468194682046821468224682346824468254682646827468284682946830468314683246833468344683546836468374683846839468404684146842468434684446845468464684746848468494685046851468524685346854468554685646857468584685946860468614686246863468644686546866468674686846869468704687146872468734687446875468764687746878468794688046881468824688346884468854688646887468884688946890468914689246893468944689546896468974689846899469004690146902469034690446905469064690746908469094691046911469124691346914469154691646917469184691946920469214692246923469244692546926469274692846929469304693146932469334693446935469364693746938469394694046941469424694346944469454694646947469484694946950469514695246953469544695546956469574695846959469604696146962469634696446965469664696746968469694697046971469724697346974469754697646977469784697946980469814698246983469844698546986469874698846989469904699146992469934699446995469964699746998469994700047001470024700347004470054700647007470084700947010470114701247013470144701547016470174701847019470204702147022470234702447025470264702747028470294703047031470324703347034470354703647037470384703947040470414704247043470444704547046470474704847049470504705147052470534705447055470564705747058470594706047061470624706347064470654706647067470684706947070470714707247073470744707547076470774707847079470804708147082470834708447085470864708747088470894709047091470924709347094470954709647097470984709947100471014710247103471044710547106471074710847109471104711147112471134711447115471164711747118471194712047121471224712347124471254712647127471284712947130471314713247133471344713547136471374713847139471404714147142471434714447145471464714747148471494715047151471524715347154471554715647157471584715947160471614716247163471644716547166471674716847169471704717147172471734717447175471764717747178471794718047181471824718347184471854718647187471884718947190471914719247193471944719547196471974719847199472004720147202472034720447205472064720747208472094721047211472124721347214472154721647217472184721947220472214722247223472244722547226472274722847229472304723147232472334723447235472364723747238472394724047241472424724347244472454724647247472484724947250472514725247253472544725547256472574725847259472604726147262472634726447265472664726747268472694727047271472724727347274472754727647277472784727947280472814728247283472844728547286472874728847289472904729147292472934729447295472964729747298472994730047301473024730347304473054730647307473084730947310473114731247313473144731547316473174731847319473204732147322473234732447325473264732747328473294733047331473324733347334473354733647337473384733947340473414734247343473444734547346473474734847349473504735147352473534735447355473564735747358473594736047361473624736347364473654736647367473684736947370473714737247373473744737547376473774737847379473804738147382473834738447385473864738747388473894739047391473924739347394473954739647397473984739947400474014740247403474044740547406474074740847409474104741147412474134741447415474164741747418474194742047421474224742347424474254742647427474284742947430474314743247433474344743547436474374743847439474404744147442474434744447445474464744747448474494745047451474524745347454474554745647457474584745947460474614746247463474644746547466474674746847469474704747147472474734747447475474764747747478474794748047481474824748347484474854748647487474884748947490474914749247493474944749547496474974749847499475004750147502475034750447505475064750747508475094751047511475124751347514475154751647517475184751947520475214752247523475244752547526475274752847529475304753147532475334753447535475364753747538475394754047541475424754347544475454754647547475484754947550475514755247553475544755547556475574755847559475604756147562475634756447565475664756747568475694757047571475724757347574475754757647577475784757947580475814758247583475844758547586475874758847589475904759147592475934759447595475964759747598475994760047601476024760347604476054760647607476084760947610476114761247613476144761547616476174761847619476204762147622476234762447625476264762747628476294763047631476324763347634476354763647637476384763947640476414764247643476444764547646476474764847649476504765147652476534765447655476564765747658476594766047661476624766347664476654766647667476684766947670476714767247673476744767547676476774767847679476804768147682476834768447685476864768747688476894769047691476924769347694476954769647697476984769947700477014770247703477044770547706477074770847709477104771147712477134771447715477164771747718477194772047721477224772347724477254772647727477284772947730477314773247733477344773547736477374773847739477404774147742477434774447745477464774747748477494775047751477524775347754477554775647757477584775947760477614776247763477644776547766477674776847769477704777147772477734777447775477764777747778477794778047781477824778347784477854778647787477884778947790477914779247793477944779547796477974779847799478004780147802478034780447805478064780747808478094781047811478124781347814478154781647817478184781947820478214782247823478244782547826478274782847829478304783147832478334783447835478364783747838478394784047841478424784347844478454784647847478484784947850478514785247853478544785547856478574785847859478604786147862478634786447865478664786747868478694787047871478724787347874478754787647877478784787947880478814788247883478844788547886478874788847889478904789147892478934789447895478964789747898478994790047901479024790347904479054790647907479084790947910479114791247913479144791547916479174791847919479204792147922479234792447925479264792747928479294793047931479324793347934479354793647937479384793947940479414794247943479444794547946479474794847949479504795147952479534795447955479564795747958479594796047961479624796347964479654796647967479684796947970479714797247973479744797547976479774797847979479804798147982479834798447985479864798747988479894799047991479924799347994479954799647997479984799948000480014800248003480044800548006480074800848009480104801148012480134801448015480164801748018480194802048021480224802348024480254802648027480284802948030480314803248033480344803548036480374803848039480404804148042480434804448045480464804748048480494805048051480524805348054480554805648057480584805948060480614806248063480644806548066480674806848069480704807148072480734807448075480764807748078480794808048081480824808348084480854808648087480884808948090480914809248093480944809548096480974809848099481004810148102481034810448105481064810748108481094811048111481124811348114481154811648117481184811948120481214812248123481244812548126481274812848129481304813148132481334813448135481364813748138481394814048141481424814348144481454814648147481484814948150481514815248153481544815548156481574815848159481604816148162481634816448165481664816748168481694817048171481724817348174481754817648177481784817948180481814818248183481844818548186481874818848189481904819148192481934819448195481964819748198481994820048201482024820348204482054820648207482084820948210482114821248213482144821548216482174821848219482204822148222482234822448225482264822748228482294823048231482324823348234482354823648237482384823948240482414824248243482444824548246482474824848249482504825148252482534825448255482564825748258482594826048261482624826348264482654826648267482684826948270482714827248273482744827548276482774827848279482804828148282482834828448285482864828748288482894829048291482924829348294482954829648297482984829948300483014830248303483044830548306483074830848309483104831148312483134831448315483164831748318483194832048321483224832348324483254832648327483284832948330483314833248333483344833548336483374833848339483404834148342483434834448345483464834748348483494835048351483524835348354483554835648357483584835948360483614836248363483644836548366483674836848369483704837148372483734837448375483764837748378483794838048381483824838348384483854838648387483884838948390483914839248393483944839548396483974839848399484004840148402484034840448405484064840748408484094841048411484124841348414484154841648417484184841948420484214842248423484244842548426484274842848429484304843148432484334843448435484364843748438484394844048441484424844348444484454844648447484484844948450484514845248453484544845548456484574845848459484604846148462484634846448465484664846748468484694847048471484724847348474484754847648477484784847948480484814848248483484844848548486484874848848489484904849148492484934849448495484964849748498484994850048501485024850348504485054850648507485084850948510485114851248513485144851548516485174851848519485204852148522485234852448525485264852748528485294853048531485324853348534485354853648537485384853948540485414854248543485444854548546485474854848549485504855148552485534855448555485564855748558485594856048561485624856348564485654856648567485684856948570485714857248573485744857548576485774857848579485804858148582485834858448585485864858748588485894859048591485924859348594485954859648597485984859948600486014860248603486044860548606486074860848609486104861148612486134861448615486164861748618486194862048621486224862348624486254862648627486284862948630486314863248633486344863548636486374863848639486404864148642486434864448645486464864748648486494865048651486524865348654486554865648657486584865948660486614866248663486644866548666486674866848669486704867148672486734867448675486764867748678486794868048681486824868348684486854868648687486884868948690486914869248693486944869548696486974869848699487004870148702487034870448705487064870748708487094871048711487124871348714487154871648717487184871948720487214872248723487244872548726487274872848729487304873148732487334873448735487364873748738487394874048741487424874348744487454874648747487484874948750487514875248753487544875548756487574875848759487604876148762487634876448765487664876748768487694877048771487724877348774487754877648777487784877948780487814878248783487844878548786487874878848789487904879148792487934879448795487964879748798487994880048801488024880348804488054880648807488084880948810488114881248813488144881548816488174881848819488204882148822488234882448825488264882748828488294883048831488324883348834488354883648837488384883948840488414884248843488444884548846488474884848849488504885148852488534885448855488564885748858488594886048861488624886348864488654886648867488684886948870488714887248873488744887548876488774887848879488804888148882488834888448885488864888748888488894889048891488924889348894488954889648897488984889948900489014890248903489044890548906489074890848909489104891148912489134891448915489164891748918489194892048921489224892348924489254892648927489284892948930489314893248933489344893548936489374893848939489404894148942489434894448945489464894748948489494895048951489524895348954489554895648957489584895948960489614896248963489644896548966489674896848969489704897148972489734897448975489764897748978489794898048981489824898348984489854898648987489884898948990489914899248993489944899548996489974899848999490004900149002490034900449005490064900749008490094901049011490124901349014490154901649017490184901949020490214902249023490244902549026490274902849029490304903149032490334903449035490364903749038490394904049041490424904349044490454904649047490484904949050490514905249053490544905549056490574905849059490604906149062490634906449065490664906749068490694907049071490724907349074490754907649077490784907949080490814908249083490844908549086490874908849089490904909149092490934909449095490964909749098490994910049101491024910349104491054910649107491084910949110491114911249113491144911549116491174911849119491204912149122491234912449125491264912749128491294913049131491324913349134491354913649137491384913949140491414914249143491444914549146491474914849149491504915149152491534915449155491564915749158491594916049161491624916349164491654916649167491684916949170491714917249173491744917549176491774917849179491804918149182491834918449185491864918749188491894919049191491924919349194491954919649197491984919949200492014920249203492044920549206492074920849209492104921149212492134921449215492164921749218492194922049221492224922349224492254922649227492284922949230492314923249233492344923549236492374923849239492404924149242492434924449245492464924749248492494925049251492524925349254492554925649257492584925949260492614926249263492644926549266492674926849269492704927149272492734927449275492764927749278492794928049281492824928349284492854928649287492884928949290492914929249293492944929549296492974929849299493004930149302493034930449305493064930749308493094931049311493124931349314493154931649317493184931949320493214932249323493244932549326493274932849329493304933149332493334933449335493364933749338493394934049341493424934349344493454934649347493484934949350493514935249353493544935549356493574935849359493604936149362493634936449365493664936749368493694937049371493724937349374493754937649377493784937949380493814938249383493844938549386493874938849389493904939149392493934939449395493964939749398493994940049401494024940349404494054940649407494084940949410494114941249413494144941549416494174941849419494204942149422494234942449425494264942749428494294943049431494324943349434494354943649437494384943949440494414944249443494444944549446494474944849449494504945149452494534945449455494564945749458494594946049461494624946349464494654946649467494684946949470494714947249473494744947549476494774947849479494804948149482494834948449485494864948749488494894949049491494924949349494494954949649497494984949949500495014950249503495044950549506495074950849509495104951149512495134951449515495164951749518495194952049521495224952349524495254952649527495284952949530495314953249533495344953549536495374953849539495404954149542495434954449545495464954749548495494955049551495524955349554495554955649557495584955949560495614956249563495644956549566495674956849569495704957149572495734957449575495764957749578495794958049581495824958349584495854958649587495884958949590495914959249593495944959549596495974959849599496004960149602496034960449605496064960749608496094961049611496124961349614496154961649617496184961949620496214962249623496244962549626496274962849629496304963149632496334963449635496364963749638496394964049641496424964349644496454964649647496484964949650496514965249653496544965549656496574965849659496604966149662496634966449665496664966749668496694967049671496724967349674496754967649677496784967949680496814968249683496844968549686496874968849689496904969149692496934969449695496964969749698496994970049701497024970349704497054970649707497084970949710497114971249713497144971549716497174971849719497204972149722497234972449725497264972749728497294973049731497324973349734497354973649737497384973949740497414974249743497444974549746497474974849749497504975149752497534975449755497564975749758497594976049761497624976349764497654976649767497684976949770497714977249773497744977549776497774977849779497804978149782497834978449785497864978749788497894979049791497924979349794497954979649797497984979949800498014980249803498044980549806498074980849809498104981149812498134981449815498164981749818498194982049821498224982349824498254982649827498284982949830498314983249833498344983549836498374983849839498404984149842498434984449845498464984749848498494985049851498524985349854498554985649857498584985949860498614986249863498644986549866498674986849869498704987149872498734987449875498764987749878498794988049881498824988349884498854988649887498884988949890498914989249893498944989549896498974989849899499004990149902499034990449905499064990749908499094991049911499124991349914499154991649917499184991949920499214992249923499244992549926499274992849929499304993149932499334993449935499364993749938499394994049941499424994349944499454994649947499484994949950499514995249953499544995549956499574995849959499604996149962499634996449965499664996749968499694997049971499724997349974499754997649977499784997949980499814998249983499844998549986499874998849989499904999149992499934999449995499964999749998499995000050001500025000350004500055000650007500085000950010500115001250013500145001550016500175001850019500205002150022500235002450025500265002750028500295003050031500325003350034500355003650037500385003950040500415004250043500445004550046500475004850049500505005150052500535005450055500565005750058500595006050061500625006350064500655006650067500685006950070500715007250073500745007550076500775007850079500805008150082500835008450085500865008750088500895009050091500925009350094500955009650097500985009950100501015010250103501045010550106501075010850109501105011150112501135011450115501165011750118501195012050121501225012350124501255012650127501285012950130501315013250133501345013550136501375013850139501405014150142501435014450145501465014750148501495015050151501525015350154501555015650157501585015950160501615016250163501645016550166501675016850169501705017150172501735017450175501765017750178501795018050181501825018350184501855018650187501885018950190501915019250193501945019550196501975019850199502005020150202502035020450205502065020750208502095021050211502125021350214502155021650217502185021950220502215022250223502245022550226502275022850229502305023150232502335023450235502365023750238502395024050241502425024350244502455024650247502485024950250502515025250253502545025550256502575025850259502605026150262502635026450265502665026750268502695027050271502725027350274502755027650277502785027950280502815028250283502845028550286502875028850289502905029150292502935029450295502965029750298502995030050301503025030350304503055030650307503085030950310503115031250313503145031550316503175031850319503205032150322503235032450325503265032750328503295033050331503325033350334503355033650337503385033950340503415034250343503445034550346503475034850349503505035150352503535035450355503565035750358503595036050361503625036350364503655036650367503685036950370503715037250373503745037550376503775037850379503805038150382503835038450385503865038750388503895039050391503925039350394503955039650397503985039950400504015040250403504045040550406504075040850409504105041150412504135041450415504165041750418504195042050421504225042350424504255042650427504285042950430504315043250433504345043550436504375043850439504405044150442504435044450445504465044750448504495045050451504525045350454504555045650457504585045950460504615046250463504645046550466504675046850469504705047150472504735047450475504765047750478504795048050481504825048350484504855048650487504885048950490504915049250493504945049550496504975049850499505005050150502505035050450505505065050750508505095051050511505125051350514505155051650517505185051950520505215052250523505245052550526505275052850529505305053150532505335053450535505365053750538505395054050541505425054350544505455054650547505485054950550505515055250553505545055550556505575055850559505605056150562505635056450565505665056750568505695057050571505725057350574505755057650577505785057950580505815058250583505845058550586505875058850589505905059150592505935059450595505965059750598505995060050601506025060350604506055060650607506085060950610506115061250613506145061550616506175061850619506205062150622506235062450625506265062750628506295063050631506325063350634506355063650637506385063950640506415064250643506445064550646506475064850649506505065150652506535065450655506565065750658506595066050661506625066350664506655066650667506685066950670506715067250673506745067550676506775067850679506805068150682506835068450685506865068750688506895069050691506925069350694506955069650697506985069950700507015070250703507045070550706507075070850709507105071150712507135071450715507165071750718507195072050721507225072350724507255072650727507285072950730507315073250733507345073550736507375073850739507405074150742507435074450745507465074750748507495075050751507525075350754507555075650757507585075950760507615076250763507645076550766507675076850769507705077150772507735077450775507765077750778507795078050781507825078350784507855078650787507885078950790507915079250793507945079550796507975079850799508005080150802508035080450805508065080750808508095081050811508125081350814508155081650817508185081950820508215082250823508245082550826508275082850829508305083150832508335083450835508365083750838508395084050841508425084350844508455084650847508485084950850508515085250853508545085550856508575085850859508605086150862508635086450865508665086750868508695087050871508725087350874508755087650877508785087950880508815088250883508845088550886508875088850889508905089150892508935089450895508965089750898508995090050901509025090350904509055090650907509085090950910509115091250913509145091550916509175091850919509205092150922509235092450925509265092750928509295093050931509325093350934509355093650937509385093950940509415094250943509445094550946509475094850949509505095150952509535095450955509565095750958509595096050961509625096350964509655096650967509685096950970509715097250973509745097550976509775097850979509805098150982509835098450985509865098750988509895099050991509925099350994509955099650997509985099951000510015100251003510045100551006510075100851009510105101151012510135101451015510165101751018510195102051021510225102351024510255102651027510285102951030510315103251033510345103551036510375103851039510405104151042510435104451045510465104751048510495105051051510525105351054510555105651057510585105951060510615106251063510645106551066510675106851069510705107151072510735107451075510765107751078510795108051081510825108351084510855108651087510885108951090510915109251093510945109551096510975109851099511005110151102511035110451105511065110751108511095111051111511125111351114511155111651117511185111951120511215112251123511245112551126511275112851129511305113151132511335113451135511365113751138511395114051141511425114351144511455114651147511485114951150511515115251153511545115551156511575115851159511605116151162511635116451165511665116751168511695117051171511725117351174511755117651177511785117951180511815118251183511845118551186511875118851189511905119151192511935119451195511965119751198511995120051201512025120351204512055120651207512085120951210512115121251213512145121551216512175121851219512205122151222512235122451225512265122751228512295123051231512325123351234512355123651237512385123951240512415124251243512445124551246512475124851249512505125151252512535125451255512565125751258512595126051261512625126351264512655126651267512685126951270512715127251273512745127551276512775127851279512805128151282512835128451285512865128751288512895129051291512925129351294512955129651297512985129951300513015130251303513045130551306513075130851309513105131151312513135131451315513165131751318513195132051321513225132351324513255132651327513285132951330513315133251333513345133551336513375133851339513405134151342513435134451345513465134751348513495135051351513525135351354513555135651357513585135951360513615136251363513645136551366513675136851369513705137151372513735137451375513765137751378513795138051381513825138351384513855138651387513885138951390513915139251393513945139551396513975139851399514005140151402514035140451405514065140751408514095141051411514125141351414514155141651417514185141951420514215142251423514245142551426514275142851429514305143151432514335143451435514365143751438514395144051441514425144351444514455144651447514485144951450514515145251453514545145551456514575145851459514605146151462514635146451465514665146751468514695147051471514725147351474514755147651477514785147951480514815148251483514845148551486514875148851489514905149151492514935149451495514965149751498514995150051501515025150351504515055150651507515085150951510515115151251513515145151551516515175151851519515205152151522515235152451525515265152751528515295153051531515325153351534515355153651537515385153951540515415154251543515445154551546515475154851549515505155151552515535155451555515565155751558515595156051561515625156351564515655156651567515685156951570515715157251573515745157551576515775157851579515805158151582515835158451585515865158751588515895159051591515925159351594515955159651597515985159951600516015160251603516045160551606516075160851609516105161151612516135161451615516165161751618516195162051621516225162351624516255162651627516285162951630516315163251633516345163551636516375163851639516405164151642516435164451645516465164751648516495165051651516525165351654516555165651657516585165951660516615166251663516645166551666516675166851669516705167151672516735167451675516765167751678516795168051681516825168351684516855168651687516885168951690516915169251693516945169551696516975169851699517005170151702517035170451705517065170751708517095171051711517125171351714517155171651717517185171951720517215172251723517245172551726517275172851729517305173151732517335173451735517365173751738517395174051741517425174351744517455174651747517485174951750517515175251753517545175551756517575175851759517605176151762517635176451765517665176751768517695177051771517725177351774517755177651777517785177951780517815178251783517845178551786517875178851789517905179151792517935179451795517965179751798517995180051801518025180351804518055180651807518085180951810518115181251813518145181551816518175181851819518205182151822518235182451825518265182751828518295183051831518325183351834518355183651837518385183951840518415184251843518445184551846518475184851849518505185151852518535185451855518565185751858518595186051861518625186351864518655186651867518685186951870518715187251873518745187551876518775187851879518805188151882518835188451885518865188751888518895189051891518925189351894518955189651897518985189951900519015190251903519045190551906519075190851909519105191151912519135191451915519165191751918519195192051921519225192351924519255192651927519285192951930519315193251933519345193551936519375193851939519405194151942519435194451945519465194751948519495195051951519525195351954519555195651957519585195951960519615196251963519645196551966519675196851969519705197151972519735197451975519765197751978519795198051981519825198351984519855198651987519885198951990519915199251993519945199551996519975199851999520005200152002520035200452005520065200752008520095201052011520125201352014520155201652017520185201952020520215202252023520245202552026520275202852029520305203152032520335203452035520365203752038520395204052041520425204352044520455204652047520485204952050520515205252053520545205552056520575205852059520605206152062520635206452065520665206752068520695207052071520725207352074520755207652077520785207952080520815208252083520845208552086520875208852089520905209152092520935209452095520965209752098520995210052101521025210352104521055210652107521085210952110521115211252113521145211552116521175211852119521205212152122521235212452125521265212752128521295213052131521325213352134521355213652137521385213952140521415214252143521445214552146521475214852149521505215152152521535215452155521565215752158521595216052161521625216352164521655216652167521685216952170521715217252173521745217552176521775217852179521805218152182521835218452185521865218752188521895219052191521925219352194521955219652197521985219952200522015220252203522045220552206522075220852209522105221152212522135221452215522165221752218522195222052221522225222352224522255222652227522285222952230522315223252233522345223552236522375223852239522405224152242522435224452245522465224752248522495225052251522525225352254522555225652257522585225952260522615226252263522645226552266522675226852269522705227152272522735227452275522765227752278522795228052281522825228352284522855228652287522885228952290522915229252293522945229552296522975229852299523005230152302523035230452305523065230752308523095231052311523125231352314523155231652317523185231952320523215232252323523245232552326523275232852329523305233152332523335233452335523365233752338523395234052341523425234352344523455234652347523485234952350523515235252353523545235552356523575235852359523605236152362523635236452365523665236752368523695237052371523725237352374523755237652377523785237952380523815238252383523845238552386523875238852389523905239152392523935239452395523965239752398523995240052401524025240352404524055240652407524085240952410524115241252413524145241552416524175241852419524205242152422524235242452425524265242752428524295243052431524325243352434524355243652437524385243952440524415244252443524445244552446524475244852449524505245152452524535245452455524565245752458524595246052461524625246352464524655246652467524685246952470524715247252473524745247552476524775247852479524805248152482524835248452485524865248752488524895249052491524925249352494524955249652497524985249952500525015250252503525045250552506525075250852509525105251152512525135251452515525165251752518525195252052521525225252352524525255252652527525285252952530525315253252533525345253552536525375253852539525405254152542525435254452545525465254752548525495255052551525525255352554525555255652557525585255952560525615256252563525645256552566525675256852569525705257152572525735257452575525765257752578525795258052581525825258352584525855258652587525885258952590525915259252593525945259552596525975259852599526005260152602526035260452605526065260752608526095261052611526125261352614526155261652617526185261952620526215262252623526245262552626526275262852629526305263152632526335263452635526365263752638526395264052641526425264352644526455264652647526485264952650526515265252653526545265552656526575265852659526605266152662526635266452665526665266752668526695267052671526725267352674526755267652677526785267952680526815268252683526845268552686526875268852689526905269152692526935269452695526965269752698526995270052701527025270352704527055270652707527085270952710527115271252713527145271552716527175271852719527205272152722527235272452725527265272752728527295273052731527325273352734527355273652737527385273952740527415274252743527445274552746527475274852749527505275152752527535275452755527565275752758527595276052761527625276352764527655276652767527685276952770527715277252773527745277552776527775277852779527805278152782527835278452785527865278752788527895279052791527925279352794527955279652797527985279952800528015280252803528045280552806528075280852809528105281152812528135281452815528165281752818528195282052821528225282352824528255282652827528285282952830528315283252833528345283552836528375283852839528405284152842528435284452845528465284752848528495285052851528525285352854528555285652857528585285952860528615286252863528645286552866528675286852869528705287152872528735287452875528765287752878528795288052881528825288352884528855288652887528885288952890528915289252893528945289552896528975289852899529005290152902529035290452905529065290752908529095291052911529125291352914529155291652917529185291952920529215292252923529245292552926529275292852929529305293152932529335293452935529365293752938529395294052941529425294352944529455294652947529485294952950529515295252953529545295552956529575295852959529605296152962529635296452965529665296752968529695297052971529725297352974529755297652977529785297952980529815298252983529845298552986529875298852989529905299152992529935299452995529965299752998529995300053001530025300353004530055300653007530085300953010530115301253013530145301553016530175301853019530205302153022530235302453025530265302753028530295303053031530325303353034530355303653037530385303953040530415304253043530445304553046530475304853049530505305153052530535305453055530565305753058530595306053061530625306353064530655306653067530685306953070530715307253073530745307553076530775307853079530805308153082530835308453085530865308753088530895309053091530925309353094530955309653097530985309953100531015310253103531045310553106531075310853109531105311153112531135311453115531165311753118531195312053121531225312353124531255312653127531285312953130531315313253133531345313553136531375313853139531405314153142531435314453145531465314753148531495315053151531525315353154531555315653157531585315953160531615316253163531645316553166531675316853169531705317153172531735317453175531765317753178531795318053181531825318353184531855318653187531885318953190531915319253193531945319553196531975319853199532005320153202532035320453205532065320753208532095321053211532125321353214532155321653217532185321953220532215322253223532245322553226532275322853229532305323153232532335323453235532365323753238532395324053241532425324353244532455324653247532485324953250532515325253253532545325553256532575325853259532605326153262532635326453265532665326753268532695327053271532725327353274532755327653277532785327953280532815328253283532845328553286532875328853289532905329153292532935329453295532965329753298532995330053301533025330353304533055330653307533085330953310533115331253313533145331553316533175331853319533205332153322533235332453325533265332753328533295333053331533325333353334533355333653337533385333953340533415334253343533445334553346533475334853349533505335153352533535335453355533565335753358533595336053361533625336353364533655336653367533685336953370533715337253373533745337553376533775337853379533805338153382533835338453385533865338753388533895339053391533925339353394533955339653397533985339953400534015340253403534045340553406534075340853409534105341153412534135341453415534165341753418534195342053421534225342353424534255342653427534285342953430534315343253433534345343553436534375343853439534405344153442534435344453445534465344753448534495345053451534525345353454534555345653457534585345953460534615346253463534645346553466534675346853469534705347153472534735347453475534765347753478534795348053481534825348353484534855348653487534885348953490534915349253493534945349553496534975349853499535005350153502535035350453505535065350753508535095351053511535125351353514535155351653517535185351953520535215352253523535245352553526535275352853529535305353153532535335353453535535365353753538535395354053541535425354353544535455354653547535485354953550535515355253553535545355553556535575355853559535605356153562535635356453565535665356753568535695357053571535725357353574535755357653577535785357953580535815358253583535845358553586535875358853589535905359153592535935359453595535965359753598535995360053601536025360353604536055360653607536085360953610536115361253613536145361553616536175361853619536205362153622536235362453625536265362753628536295363053631536325363353634536355363653637536385363953640536415364253643536445364553646536475364853649536505365153652536535365453655536565365753658536595366053661536625366353664536655366653667536685366953670536715367253673536745367553676536775367853679536805368153682536835368453685536865368753688536895369053691536925369353694536955369653697536985369953700537015370253703537045370553706537075370853709537105371153712537135371453715537165371753718537195372053721537225372353724537255372653727537285372953730537315373253733537345373553736537375373853739537405374153742537435374453745537465374753748537495375053751537525375353754537555375653757537585375953760537615376253763537645376553766537675376853769537705377153772537735377453775537765377753778537795378053781537825378353784537855378653787537885378953790537915379253793537945379553796537975379853799538005380153802538035380453805538065380753808538095381053811538125381353814538155381653817538185381953820538215382253823538245382553826538275382853829538305383153832538335383453835538365383753838538395384053841538425384353844538455384653847538485384953850538515385253853538545385553856538575385853859538605386153862538635386453865538665386753868538695387053871538725387353874538755387653877538785387953880538815388253883538845388553886538875388853889538905389153892538935389453895538965389753898538995390053901539025390353904539055390653907539085390953910539115391253913539145391553916539175391853919539205392153922539235392453925539265392753928539295393053931539325393353934539355393653937539385393953940539415394253943539445394553946539475394853949539505395153952539535395453955539565395753958539595396053961539625396353964539655396653967539685396953970539715397253973539745397553976539775397853979539805398153982539835398453985539865398753988539895399053991539925399353994539955399653997539985399954000540015400254003540045400554006540075400854009540105401154012540135401454015540165401754018540195402054021540225402354024540255402654027540285402954030540315403254033540345403554036540375403854039540405404154042540435404454045540465404754048540495405054051540525405354054540555405654057540585405954060540615406254063540645406554066540675406854069540705407154072540735407454075540765407754078540795408054081540825408354084540855408654087540885408954090540915409254093540945409554096540975409854099541005410154102541035410454105541065410754108541095411054111541125411354114541155411654117541185411954120541215412254123541245412554126541275412854129541305413154132541335413454135541365413754138541395414054141541425414354144541455414654147541485414954150541515415254153541545415554156541575415854159541605416154162541635416454165541665416754168541695417054171541725417354174541755417654177541785417954180541815418254183541845418554186541875418854189541905419154192541935419454195541965419754198541995420054201542025420354204542055420654207542085420954210542115421254213542145421554216542175421854219542205422154222542235422454225542265422754228542295423054231542325423354234542355423654237542385423954240542415424254243542445424554246542475424854249542505425154252542535425454255542565425754258542595426054261542625426354264542655426654267542685426954270542715427254273542745427554276542775427854279542805428154282542835428454285542865428754288542895429054291542925429354294542955429654297542985429954300543015430254303543045430554306543075430854309543105431154312543135431454315543165431754318543195432054321543225432354324543255432654327543285432954330543315433254333543345433554336543375433854339543405434154342543435434454345543465434754348543495435054351543525435354354543555435654357543585435954360543615436254363543645436554366543675436854369543705437154372543735437454375543765437754378543795438054381543825438354384543855438654387543885438954390543915439254393543945439554396543975439854399544005440154402544035440454405544065440754408544095441054411544125441354414544155441654417544185441954420544215442254423544245442554426544275442854429544305443154432544335443454435544365443754438544395444054441544425444354444544455444654447544485444954450544515445254453544545445554456544575445854459544605446154462544635446454465544665446754468544695447054471544725447354474544755447654477544785447954480544815448254483544845448554486544875448854489544905449154492544935449454495544965449754498544995450054501545025450354504545055450654507545085450954510545115451254513545145451554516545175451854519545205452154522545235452454525545265452754528545295453054531545325453354534545355453654537545385453954540545415454254543545445454554546545475454854549545505455154552545535455454555545565455754558545595456054561545625456354564545655456654567545685456954570545715457254573545745457554576545775457854579545805458154582545835458454585545865458754588545895459054591545925459354594545955459654597545985459954600546015460254603546045460554606546075460854609546105461154612546135461454615546165461754618546195462054621546225462354624546255462654627546285462954630546315463254633546345463554636546375463854639546405464154642546435464454645546465464754648546495465054651546525465354654546555465654657546585465954660546615466254663546645466554666546675466854669546705467154672546735467454675546765467754678546795468054681546825468354684546855468654687546885468954690546915469254693546945469554696546975469854699547005470154702547035470454705547065470754708547095471054711547125471354714547155471654717547185471954720547215472254723547245472554726547275472854729547305473154732547335473454735547365473754738547395474054741547425474354744547455474654747547485474954750547515475254753547545475554756547575475854759547605476154762547635476454765547665476754768547695477054771547725477354774547755477654777547785477954780547815478254783547845478554786547875478854789547905479154792547935479454795547965479754798547995480054801548025480354804548055480654807548085480954810548115481254813548145481554816548175481854819548205482154822548235482454825548265482754828548295483054831548325483354834548355483654837548385483954840548415484254843548445484554846548475484854849548505485154852548535485454855548565485754858548595486054861548625486354864548655486654867548685486954870548715487254873548745487554876548775487854879548805488154882548835488454885548865488754888548895489054891548925489354894548955489654897548985489954900549015490254903549045490554906549075490854909549105491154912549135491454915549165491754918549195492054921549225492354924549255492654927549285492954930549315493254933549345493554936549375493854939549405494154942549435494454945549465494754948549495495054951549525495354954549555495654957549585495954960549615496254963549645496554966549675496854969549705497154972549735497454975549765497754978549795498054981549825498354984549855498654987549885498954990549915499254993549945499554996549975499854999550005500155002550035500455005550065500755008550095501055011550125501355014550155501655017550185501955020550215502255023550245502555026550275502855029550305503155032550335503455035550365503755038550395504055041550425504355044550455504655047550485504955050550515505255053550545505555056550575505855059550605506155062550635506455065550665506755068550695507055071550725507355074550755507655077550785507955080550815508255083550845508555086550875508855089550905509155092550935509455095550965509755098550995510055101551025510355104551055510655107551085510955110551115511255113551145511555116551175511855119551205512155122551235512455125551265512755128551295513055131551325513355134551355513655137551385513955140551415514255143551445514555146551475514855149551505515155152551535515455155551565515755158551595516055161551625516355164551655516655167551685516955170551715517255173551745517555176551775517855179551805518155182551835518455185551865518755188551895519055191551925519355194551955519655197551985519955200552015520255203552045520555206552075520855209552105521155212552135521455215552165521755218552195522055221552225522355224552255522655227552285522955230552315523255233552345523555236552375523855239552405524155242552435524455245552465524755248552495525055251552525525355254552555525655257552585525955260552615526255263552645526555266552675526855269552705527155272552735527455275552765527755278552795528055281552825528355284552855528655287552885528955290552915529255293552945529555296552975529855299553005530155302553035530455305553065530755308553095531055311553125531355314553155531655317553185531955320553215532255323553245532555326553275532855329553305533155332553335533455335553365533755338553395534055341553425534355344553455534655347553485534955350553515535255353553545535555356553575535855359553605536155362553635536455365553665536755368553695537055371553725537355374553755537655377553785537955380553815538255383553845538555386553875538855389553905539155392553935539455395553965539755398553995540055401554025540355404554055540655407554085540955410554115541255413554145541555416554175541855419554205542155422554235542455425554265542755428554295543055431554325543355434554355543655437554385543955440554415544255443554445544555446554475544855449554505545155452554535545455455554565545755458554595546055461554625546355464554655546655467554685546955470554715547255473554745547555476554775547855479554805548155482554835548455485554865548755488554895549055491554925549355494554955549655497554985549955500555015550255503555045550555506555075550855509555105551155512555135551455515555165551755518555195552055521555225552355524555255552655527555285552955530555315553255533555345553555536555375553855539555405554155542555435554455545555465554755548555495555055551555525555355554555555555655557555585555955560555615556255563555645556555566555675556855569555705557155572555735557455575555765557755578555795558055581555825558355584555855558655587555885558955590555915559255593555945559555596555975559855599556005560155602556035560455605556065560755608556095561055611556125561355614556155561655617556185561955620556215562255623556245562555626556275562855629556305563155632556335563455635556365563755638556395564055641556425564355644556455564655647556485564955650556515565255653556545565555656556575565855659556605566155662556635566455665556665566755668556695567055671556725567355674556755567655677556785567955680556815568255683556845568555686556875568855689556905569155692556935569455695556965569755698556995570055701557025570355704557055570655707557085570955710557115571255713557145571555716557175571855719557205572155722557235572455725557265572755728557295573055731557325573355734557355573655737557385573955740557415574255743557445574555746557475574855749557505575155752557535575455755557565575755758557595576055761557625576355764557655576655767557685576955770557715577255773557745577555776557775577855779557805578155782557835578455785557865578755788557895579055791557925579355794557955579655797557985579955800558015580255803558045580555806558075580855809558105581155812558135581455815558165581755818558195582055821558225582355824558255582655827558285582955830558315583255833558345583555836558375583855839558405584155842558435584455845558465584755848558495585055851558525585355854558555585655857558585585955860558615586255863558645586555866558675586855869558705587155872558735587455875558765587755878558795588055881558825588355884558855588655887558885588955890558915589255893558945589555896558975589855899559005590155902559035590455905559065590755908559095591055911559125591355914559155591655917559185591955920559215592255923559245592555926559275592855929559305593155932559335593455935559365593755938559395594055941559425594355944559455594655947559485594955950559515595255953559545595555956559575595855959559605596155962559635596455965559665596755968559695597055971559725597355974559755597655977559785597955980559815598255983559845598555986559875598855989559905599155992559935599455995559965599755998559995600056001560025600356004560055600656007560085600956010560115601256013560145601556016560175601856019560205602156022560235602456025560265602756028560295603056031560325603356034560355603656037560385603956040560415604256043560445604556046560475604856049560505605156052560535605456055560565605756058560595606056061560625606356064560655606656067560685606956070560715607256073560745607556076560775607856079560805608156082560835608456085560865608756088560895609056091560925609356094560955609656097560985609956100561015610256103561045610556106561075610856109561105611156112561135611456115561165611756118561195612056121561225612356124561255612656127561285612956130561315613256133561345613556136561375613856139561405614156142561435614456145561465614756148561495615056151561525615356154561555615656157561585615956160561615616256163561645616556166561675616856169561705617156172561735617456175561765617756178561795618056181561825618356184561855618656187561885618956190561915619256193561945619556196561975619856199562005620156202562035620456205562065620756208562095621056211562125621356214562155621656217562185621956220562215622256223562245622556226562275622856229562305623156232562335623456235562365623756238562395624056241562425624356244562455624656247562485624956250562515625256253562545625556256562575625856259562605626156262562635626456265562665626756268562695627056271562725627356274562755627656277562785627956280562815628256283562845628556286562875628856289562905629156292562935629456295562965629756298562995630056301563025630356304563055630656307563085630956310563115631256313563145631556316563175631856319563205632156322563235632456325563265632756328563295633056331563325633356334563355633656337563385633956340563415634256343563445634556346563475634856349563505635156352563535635456355563565635756358563595636056361563625636356364563655636656367563685636956370563715637256373563745637556376563775637856379563805638156382563835638456385563865638756388563895639056391563925639356394563955639656397563985639956400564015640256403564045640556406564075640856409564105641156412564135641456415564165641756418564195642056421564225642356424564255642656427564285642956430564315643256433564345643556436564375643856439564405644156442564435644456445564465644756448564495645056451564525645356454564555645656457564585645956460564615646256463564645646556466564675646856469564705647156472564735647456475564765647756478564795648056481564825648356484564855648656487564885648956490564915649256493564945649556496564975649856499565005650156502565035650456505565065650756508565095651056511565125651356514565155651656517565185651956520565215652256523565245652556526565275652856529565305653156532565335653456535565365653756538565395654056541565425654356544565455654656547565485654956550565515655256553565545655556556565575655856559565605656156562565635656456565565665656756568565695657056571565725657356574565755657656577565785657956580565815658256583565845658556586565875658856589565905659156592565935659456595565965659756598565995660056601566025660356604566055660656607566085660956610566115661256613566145661556616566175661856619566205662156622566235662456625566265662756628566295663056631566325663356634566355663656637566385663956640566415664256643566445664556646566475664856649566505665156652566535665456655566565665756658566595666056661566625666356664566655666656667566685666956670566715667256673566745667556676566775667856679566805668156682566835668456685566865668756688566895669056691566925669356694566955669656697566985669956700567015670256703567045670556706567075670856709567105671156712567135671456715567165671756718567195672056721567225672356724567255672656727567285672956730567315673256733567345673556736567375673856739567405674156742567435674456745567465674756748567495675056751567525675356754567555675656757567585675956760567615676256763567645676556766567675676856769567705677156772567735677456775567765677756778567795678056781567825678356784567855678656787567885678956790567915679256793567945679556796567975679856799568005680156802568035680456805568065680756808568095681056811568125681356814568155681656817568185681956820568215682256823568245682556826568275682856829568305683156832568335683456835568365683756838568395684056841568425684356844568455684656847568485684956850568515685256853568545685556856568575685856859568605686156862568635686456865568665686756868568695687056871568725687356874568755687656877568785687956880568815688256883568845688556886568875688856889568905689156892568935689456895568965689756898568995690056901569025690356904569055690656907569085690956910569115691256913569145691556916569175691856919569205692156922569235692456925569265692756928569295693056931569325693356934569355693656937569385693956940569415694256943569445694556946569475694856949569505695156952569535695456955569565695756958569595696056961569625696356964569655696656967569685696956970569715697256973569745697556976569775697856979569805698156982569835698456985569865698756988569895699056991569925699356994569955699656997569985699957000570015700257003570045700557006570075700857009570105701157012570135701457015570165701757018570195702057021570225702357024570255702657027570285702957030570315703257033570345703557036570375703857039570405704157042570435704457045570465704757048570495705057051570525705357054570555705657057570585705957060570615706257063570645706557066570675706857069570705707157072570735707457075570765707757078570795708057081570825708357084570855708657087570885708957090570915709257093570945709557096570975709857099571005710157102571035710457105571065710757108571095711057111571125711357114571155711657117571185711957120571215712257123571245712557126571275712857129571305713157132571335713457135571365713757138571395714057141571425714357144571455714657147571485714957150571515715257153571545715557156571575715857159571605716157162571635716457165571665716757168571695717057171571725717357174571755717657177571785717957180571815718257183571845718557186571875718857189571905719157192571935719457195571965719757198571995720057201572025720357204572055720657207572085720957210572115721257213572145721557216572175721857219572205722157222572235722457225572265722757228572295723057231572325723357234572355723657237572385723957240572415724257243572445724557246572475724857249572505725157252572535725457255572565725757258572595726057261572625726357264572655726657267572685726957270572715727257273572745727557276572775727857279572805728157282572835728457285572865728757288572895729057291572925729357294572955729657297572985729957300573015730257303573045730557306573075730857309573105731157312573135731457315573165731757318573195732057321573225732357324573255732657327573285732957330573315733257333573345733557336573375733857339573405734157342573435734457345573465734757348573495735057351573525735357354573555735657357573585735957360573615736257363573645736557366573675736857369573705737157372573735737457375573765737757378573795738057381573825738357384573855738657387573885738957390573915739257393573945739557396573975739857399574005740157402574035740457405574065740757408574095741057411574125741357414574155741657417574185741957420574215742257423574245742557426574275742857429574305743157432574335743457435574365743757438574395744057441574425744357444574455744657447574485744957450574515745257453574545745557456574575745857459574605746157462574635746457465574665746757468574695747057471574725747357474574755747657477574785747957480574815748257483574845748557486574875748857489574905749157492574935749457495574965749757498574995750057501575025750357504575055750657507575085750957510575115751257513575145751557516575175751857519575205752157522575235752457525575265752757528575295753057531575325753357534575355753657537575385753957540575415754257543575445754557546575475754857549575505755157552575535755457555575565755757558575595756057561575625756357564575655756657567575685756957570575715757257573575745757557576575775757857579575805758157582575835758457585575865758757588575895759057591575925759357594575955759657597575985759957600576015760257603576045760557606576075760857609576105761157612576135761457615576165761757618576195762057621576225762357624576255762657627576285762957630576315763257633576345763557636576375763857639576405764157642576435764457645576465764757648576495765057651576525765357654576555765657657576585765957660576615766257663576645766557666576675766857669576705767157672576735767457675576765767757678576795768057681576825768357684576855768657687576885768957690576915769257693576945769557696576975769857699577005770157702577035770457705577065770757708577095771057711577125771357714577155771657717577185771957720577215772257723577245772557726577275772857729577305773157732577335773457735577365773757738577395774057741577425774357744577455774657747577485774957750577515775257753577545775557756577575775857759577605776157762577635776457765577665776757768577695777057771577725777357774577755777657777577785777957780577815778257783577845778557786577875778857789577905779157792577935779457795577965779757798577995780057801578025780357804578055780657807578085780957810578115781257813578145781557816578175781857819578205782157822578235782457825578265782757828578295783057831578325783357834578355783657837578385783957840578415784257843578445784557846578475784857849578505785157852578535785457855578565785757858578595786057861578625786357864578655786657867578685786957870578715787257873578745787557876578775787857879578805788157882578835788457885578865788757888578895789057891578925789357894578955789657897578985789957900579015790257903579045790557906579075790857909579105791157912579135791457915579165791757918579195792057921579225792357924579255792657927579285792957930579315793257933579345793557936579375793857939579405794157942579435794457945579465794757948579495795057951579525795357954579555795657957579585795957960579615796257963579645796557966579675796857969579705797157972579735797457975579765797757978579795798057981579825798357984579855798657987579885798957990579915799257993579945799557996579975799857999580005800158002580035800458005580065800758008580095801058011580125801358014580155801658017580185801958020580215802258023580245802558026580275802858029580305803158032580335803458035580365803758038580395804058041580425804358044580455804658047580485804958050580515805258053580545805558056580575805858059580605806158062580635806458065580665806758068580695807058071580725807358074580755807658077580785807958080580815808258083580845808558086580875808858089580905809158092580935809458095580965809758098580995810058101581025810358104581055810658107581085810958110581115811258113581145811558116581175811858119581205812158122581235812458125581265812758128581295813058131581325813358134581355813658137581385813958140581415814258143581445814558146581475814858149581505815158152581535815458155581565815758158581595816058161581625816358164581655816658167581685816958170581715817258173581745817558176581775817858179581805818158182581835818458185581865818758188581895819058191581925819358194581955819658197581985819958200582015820258203582045820558206582075820858209582105821158212582135821458215582165821758218582195822058221582225822358224582255822658227582285822958230582315823258233582345823558236582375823858239582405824158242582435824458245582465824758248582495825058251582525825358254582555825658257582585825958260582615826258263582645826558266582675826858269582705827158272582735827458275582765827758278582795828058281582825828358284582855828658287582885828958290582915829258293582945829558296582975829858299583005830158302583035830458305583065830758308583095831058311583125831358314583155831658317583185831958320583215832258323583245832558326583275832858329583305833158332583335833458335583365833758338583395834058341583425834358344583455834658347583485834958350583515835258353583545835558356583575835858359583605836158362583635836458365583665836758368583695837058371583725837358374583755837658377583785837958380583815838258383583845838558386583875838858389583905839158392583935839458395583965839758398583995840058401584025840358404584055840658407584085840958410584115841258413584145841558416584175841858419584205842158422584235842458425584265842758428584295843058431584325843358434584355843658437584385843958440584415844258443584445844558446584475844858449584505845158452584535845458455584565845758458584595846058461584625846358464584655846658467584685846958470584715847258473584745847558476584775847858479584805848158482584835848458485584865848758488584895849058491584925849358494584955849658497584985849958500585015850258503585045850558506585075850858509585105851158512585135851458515585165851758518585195852058521585225852358524585255852658527585285852958530585315853258533585345853558536585375853858539585405854158542585435854458545585465854758548585495855058551585525855358554585555855658557585585855958560585615856258563585645856558566585675856858569585705857158572585735857458575585765857758578585795858058581585825858358584585855858658587585885858958590585915859258593585945859558596585975859858599586005860158602586035860458605586065860758608586095861058611586125861358614586155861658617586185861958620586215862258623586245862558626586275862858629586305863158632586335863458635586365863758638586395864058641586425864358644586455864658647586485864958650586515865258653586545865558656586575865858659586605866158662586635866458665586665866758668586695867058671586725867358674586755867658677586785867958680586815868258683586845868558686586875868858689586905869158692586935869458695586965869758698586995870058701587025870358704587055870658707587085870958710587115871258713587145871558716587175871858719587205872158722587235872458725587265872758728587295873058731587325873358734587355873658737587385873958740587415874258743587445874558746587475874858749587505875158752587535875458755587565875758758587595876058761587625876358764587655876658767587685876958770587715877258773587745877558776587775877858779587805878158782587835878458785587865878758788587895879058791587925879358794587955879658797587985879958800588015880258803588045880558806588075880858809588105881158812588135881458815588165881758818588195882058821588225882358824588255882658827588285882958830588315883258833588345883558836588375883858839588405884158842588435884458845588465884758848588495885058851588525885358854588555885658857588585885958860588615886258863588645886558866588675886858869588705887158872588735887458875588765887758878588795888058881588825888358884588855888658887588885888958890588915889258893588945889558896588975889858899589005890158902589035890458905589065890758908589095891058911589125891358914589155891658917589185891958920589215892258923589245892558926589275892858929589305893158932589335893458935589365893758938589395894058941589425894358944589455894658947589485894958950589515895258953589545895558956589575895858959589605896158962589635896458965589665896758968589695897058971589725897358974589755897658977589785897958980589815898258983589845898558986589875898858989589905899158992589935899458995589965899758998589995900059001590025900359004590055900659007590085900959010590115901259013590145901559016590175901859019590205902159022590235902459025590265902759028590295903059031590325903359034590355903659037590385903959040590415904259043590445904559046590475904859049590505905159052590535905459055590565905759058590595906059061590625906359064590655906659067590685906959070590715907259073590745907559076590775907859079590805908159082590835908459085590865908759088590895909059091590925909359094590955909659097590985909959100591015910259103591045910559106591075910859109591105911159112591135911459115591165911759118591195912059121591225912359124591255912659127591285912959130591315913259133591345913559136591375913859139591405914159142591435914459145591465914759148591495915059151591525915359154591555915659157591585915959160591615916259163591645916559166591675916859169591705917159172591735917459175591765917759178591795918059181591825918359184591855918659187591885918959190591915919259193591945919559196591975919859199592005920159202592035920459205592065920759208592095921059211592125921359214592155921659217592185921959220592215922259223592245922559226592275922859229592305923159232592335923459235592365923759238592395924059241592425924359244592455924659247592485924959250592515925259253592545925559256592575925859259592605926159262592635926459265592665926759268592695927059271592725927359274592755927659277592785927959280592815928259283592845928559286592875928859289592905929159292592935929459295592965929759298592995930059301593025930359304593055930659307593085930959310593115931259313593145931559316593175931859319593205932159322593235932459325593265932759328593295933059331593325933359334593355933659337593385933959340593415934259343593445934559346593475934859349593505935159352593535935459355593565935759358593595936059361593625936359364593655936659367593685936959370593715937259373593745937559376593775937859379593805938159382593835938459385593865938759388593895939059391593925939359394593955939659397593985939959400594015940259403594045940559406594075940859409594105941159412594135941459415594165941759418594195942059421594225942359424594255942659427594285942959430594315943259433594345943559436594375943859439594405944159442594435944459445594465944759448594495945059451594525945359454594555945659457594585945959460594615946259463594645946559466594675946859469594705947159472594735947459475594765947759478594795948059481594825948359484594855948659487594885948959490594915949259493594945949559496594975949859499595005950159502595035950459505595065950759508595095951059511595125951359514595155951659517595185951959520595215952259523595245952559526595275952859529595305953159532595335953459535595365953759538595395954059541595425954359544595455954659547595485954959550595515955259553595545955559556595575955859559595605956159562595635956459565595665956759568595695957059571595725957359574595755957659577595785957959580595815958259583595845958559586595875958859589595905959159592595935959459595595965959759598595995960059601596025960359604596055960659607596085960959610596115961259613596145961559616596175961859619596205962159622596235962459625596265962759628596295963059631596325963359634596355963659637596385963959640596415964259643596445964559646596475964859649596505965159652596535965459655596565965759658596595966059661596625966359664596655966659667596685966959670596715967259673596745967559676596775967859679596805968159682596835968459685596865968759688596895969059691596925969359694596955969659697596985969959700597015970259703597045970559706597075970859709597105971159712597135971459715597165971759718597195972059721597225972359724597255972659727597285972959730597315973259733597345973559736597375973859739597405974159742597435974459745597465974759748597495975059751597525975359754597555975659757597585975959760597615976259763597645976559766597675976859769597705977159772597735977459775597765977759778597795978059781597825978359784597855978659787597885978959790597915979259793597945979559796597975979859799598005980159802598035980459805598065980759808598095981059811598125981359814598155981659817598185981959820598215982259823598245982559826598275982859829598305983159832598335983459835598365983759838598395984059841598425984359844598455984659847598485984959850598515985259853598545985559856598575985859859598605986159862598635986459865598665986759868598695987059871598725987359874598755987659877598785987959880598815988259883598845988559886598875988859889598905989159892598935989459895598965989759898598995990059901599025990359904599055990659907599085990959910599115991259913599145991559916599175991859919599205992159922599235992459925599265992759928599295993059931599325993359934599355993659937599385993959940599415994259943599445994559946599475994859949599505995159952599535995459955599565995759958599595996059961599625996359964599655996659967599685996959970599715997259973599745997559976599775997859979599805998159982599835998459985599865998759988599895999059991599925999359994599955999659997599985999960000600016000260003600046000560006600076000860009600106001160012600136001460015600166001760018600196002060021600226002360024600256002660027600286002960030600316003260033600346003560036600376003860039600406004160042600436004460045600466004760048600496005060051600526005360054600556005660057600586005960060600616006260063600646006560066600676006860069600706007160072600736007460075600766007760078600796008060081600826008360084600856008660087600886008960090600916009260093600946009560096600976009860099601006010160102601036010460105601066010760108601096011060111601126011360114601156011660117601186011960120601216012260123601246012560126601276012860129601306013160132601336013460135601366013760138601396014060141601426014360144601456014660147601486014960150601516015260153601546015560156601576015860159601606016160162601636016460165601666016760168601696017060171601726017360174601756017660177601786017960180601816018260183601846018560186601876018860189601906019160192601936019460195601966019760198601996020060201602026020360204602056020660207602086020960210602116021260213602146021560216602176021860219602206022160222602236022460225602266022760228602296023060231602326023360234602356023660237602386023960240602416024260243602446024560246602476024860249602506025160252602536025460255602566025760258602596026060261602626026360264602656026660267602686026960270602716027260273602746027560276602776027860279602806028160282602836028460285602866028760288602896029060291602926029360294602956029660297602986029960300603016030260303603046030560306603076030860309603106031160312603136031460315603166031760318603196032060321603226032360324603256032660327603286032960330603316033260333603346033560336603376033860339603406034160342603436034460345603466034760348603496035060351603526035360354603556035660357603586035960360603616036260363603646036560366603676036860369603706037160372603736037460375603766037760378603796038060381603826038360384603856038660387603886038960390603916039260393603946039560396603976039860399604006040160402604036040460405604066040760408604096041060411604126041360414604156041660417604186041960420604216042260423604246042560426604276042860429604306043160432604336043460435604366043760438604396044060441604426044360444604456044660447604486044960450604516045260453604546045560456604576045860459604606046160462604636046460465604666046760468604696047060471604726047360474604756047660477604786047960480604816048260483604846048560486604876048860489604906049160492604936049460495604966049760498604996050060501605026050360504605056050660507605086050960510605116051260513605146051560516605176051860519605206052160522605236052460525605266052760528605296053060531605326053360534605356053660537605386053960540605416054260543605446054560546605476054860549605506055160552605536055460555605566055760558605596056060561605626056360564605656056660567605686056960570605716057260573605746057560576605776057860579605806058160582605836058460585605866058760588605896059060591605926059360594605956059660597605986059960600606016060260603606046060560606606076060860609606106061160612606136061460615606166061760618606196062060621606226062360624606256062660627606286062960630606316063260633606346063560636606376063860639606406064160642606436064460645606466064760648606496065060651606526065360654606556065660657606586065960660606616066260663606646066560666606676066860669606706067160672606736067460675606766067760678606796068060681606826068360684606856068660687606886068960690606916069260693606946069560696606976069860699607006070160702607036070460705607066070760708607096071060711607126071360714607156071660717607186071960720607216072260723607246072560726607276072860729607306073160732607336073460735607366073760738607396074060741607426074360744607456074660747607486074960750607516075260753607546075560756607576075860759607606076160762607636076460765607666076760768607696077060771607726077360774607756077660777607786077960780607816078260783607846078560786607876078860789607906079160792607936079460795607966079760798607996080060801608026080360804608056080660807608086080960810608116081260813608146081560816608176081860819608206082160822608236082460825608266082760828608296083060831608326083360834608356083660837608386083960840608416084260843608446084560846608476084860849608506085160852608536085460855608566085760858608596086060861608626086360864608656086660867608686086960870608716087260873608746087560876608776087860879608806088160882608836088460885608866088760888608896089060891608926089360894608956089660897608986089960900609016090260903609046090560906609076090860909609106091160912609136091460915609166091760918609196092060921609226092360924609256092660927609286092960930609316093260933609346093560936609376093860939609406094160942609436094460945609466094760948609496095060951609526095360954609556095660957609586095960960609616096260963609646096560966609676096860969609706097160972609736097460975609766097760978609796098060981609826098360984609856098660987609886098960990609916099260993609946099560996609976099860999610006100161002610036100461005610066100761008610096101061011610126101361014610156101661017610186101961020610216102261023610246102561026610276102861029610306103161032610336103461035610366103761038610396104061041610426104361044610456104661047610486104961050610516105261053610546105561056610576105861059610606106161062610636106461065610666106761068610696107061071610726107361074610756107661077610786107961080610816108261083610846108561086610876108861089610906109161092610936109461095610966109761098610996110061101611026110361104611056110661107611086110961110611116111261113611146111561116611176111861119611206112161122611236112461125611266112761128611296113061131611326113361134611356113661137611386113961140611416114261143611446114561146611476114861149611506115161152611536115461155611566115761158611596116061161611626116361164611656116661167611686116961170611716117261173611746117561176611776117861179611806118161182611836118461185611866118761188611896119061191611926119361194611956119661197611986119961200612016120261203612046120561206612076120861209612106121161212612136121461215612166121761218612196122061221612226122361224612256122661227612286122961230612316123261233612346123561236612376123861239612406124161242612436124461245612466124761248612496125061251612526125361254612556125661257612586125961260612616126261263612646126561266612676126861269612706127161272612736127461275612766127761278612796128061281612826128361284612856128661287612886128961290612916129261293612946129561296612976129861299613006130161302613036130461305613066130761308613096131061311613126131361314613156131661317613186131961320613216132261323613246132561326613276132861329613306133161332613336133461335613366133761338613396134061341613426134361344613456134661347613486134961350613516135261353613546135561356613576135861359613606136161362613636136461365613666136761368613696137061371613726137361374613756137661377613786137961380613816138261383613846138561386613876138861389613906139161392613936139461395613966139761398613996140061401614026140361404614056140661407614086140961410614116141261413614146141561416614176141861419614206142161422614236142461425614266142761428614296143061431614326143361434614356143661437614386143961440614416144261443614446144561446614476144861449614506145161452614536145461455614566145761458614596146061461614626146361464614656146661467614686146961470614716147261473614746147561476614776147861479614806148161482614836148461485614866148761488614896149061491614926149361494614956149661497614986149961500615016150261503615046150561506615076150861509615106151161512615136151461515615166151761518615196152061521615226152361524615256152661527615286152961530615316153261533615346153561536615376153861539615406154161542615436154461545615466154761548615496155061551615526155361554615556155661557615586155961560615616156261563615646156561566615676156861569615706157161572615736157461575615766157761578615796158061581615826158361584615856158661587615886158961590615916159261593615946159561596615976159861599616006160161602616036160461605616066160761608616096161061611616126161361614616156161661617616186161961620616216162261623616246162561626616276162861629616306163161632616336163461635616366163761638616396164061641616426164361644616456164661647616486164961650616516165261653616546165561656616576165861659616606166161662616636166461665616666166761668616696167061671616726167361674616756167661677616786167961680616816168261683616846168561686616876168861689616906169161692616936169461695616966169761698616996170061701617026170361704617056170661707617086170961710617116171261713617146171561716617176171861719617206172161722617236172461725617266172761728617296173061731617326173361734617356173661737617386173961740617416174261743617446174561746617476174861749617506175161752617536175461755617566175761758617596176061761617626176361764617656176661767617686176961770617716177261773617746177561776617776177861779617806178161782617836178461785617866178761788617896179061791617926179361794617956179661797617986179961800618016180261803618046180561806618076180861809618106181161812618136181461815618166181761818618196182061821618226182361824618256182661827618286182961830618316183261833618346183561836618376183861839618406184161842618436184461845618466184761848618496185061851618526185361854618556185661857618586185961860618616186261863618646186561866618676186861869618706187161872618736187461875618766187761878618796188061881618826188361884618856188661887618886188961890618916189261893618946189561896618976189861899619006190161902619036190461905619066190761908619096191061911619126191361914619156191661917619186191961920619216192261923619246192561926619276192861929619306193161932619336193461935619366193761938619396194061941619426194361944619456194661947619486194961950619516195261953619546195561956619576195861959619606196161962619636196461965619666196761968619696197061971619726197361974619756197661977619786197961980619816198261983619846198561986619876198861989619906199161992619936199461995619966199761998619996200062001620026200362004620056200662007620086200962010620116201262013620146201562016620176201862019620206202162022620236202462025620266202762028620296203062031620326203362034620356203662037620386203962040620416204262043620446204562046620476204862049620506205162052620536205462055620566205762058620596206062061620626206362064620656206662067620686206962070620716207262073620746207562076620776207862079620806208162082620836208462085620866208762088620896209062091620926209362094620956209662097620986209962100621016210262103621046210562106621076210862109621106211162112621136211462115621166211762118621196212062121621226212362124621256212662127621286212962130621316213262133621346213562136621376213862139621406214162142621436214462145621466214762148621496215062151621526215362154621556215662157621586215962160621616216262163621646216562166621676216862169621706217162172621736217462175621766217762178621796218062181621826218362184621856218662187621886218962190621916219262193621946219562196621976219862199622006220162202622036220462205622066220762208622096221062211622126221362214622156221662217622186221962220622216222262223622246222562226622276222862229622306223162232622336223462235622366223762238622396224062241622426224362244622456224662247622486224962250622516225262253622546225562256622576225862259622606226162262622636226462265622666226762268622696227062271622726227362274622756227662277622786227962280622816228262283622846228562286622876228862289622906229162292622936229462295622966229762298622996230062301623026230362304623056230662307623086230962310623116231262313623146231562316623176231862319623206232162322623236232462325623266232762328623296233062331623326233362334623356233662337623386233962340623416234262343623446234562346623476234862349623506235162352623536235462355623566235762358623596236062361623626236362364623656236662367623686236962370623716237262373623746237562376623776237862379623806238162382623836238462385623866238762388623896239062391623926239362394623956239662397623986239962400624016240262403624046240562406624076240862409624106241162412624136241462415624166241762418624196242062421624226242362424624256242662427624286242962430624316243262433624346243562436624376243862439624406244162442624436244462445624466244762448624496245062451624526245362454624556245662457624586245962460624616246262463624646246562466624676246862469624706247162472624736247462475624766247762478624796248062481624826248362484624856248662487624886248962490624916249262493624946249562496624976249862499625006250162502625036250462505625066250762508625096251062511625126251362514625156251662517625186251962520625216252262523625246252562526625276252862529625306253162532625336253462535625366253762538625396254062541625426254362544625456254662547625486254962550625516255262553625546255562556625576255862559625606256162562625636256462565625666256762568625696257062571625726257362574625756257662577625786257962580625816258262583625846258562586625876258862589625906259162592625936259462595625966259762598625996260062601626026260362604626056260662607626086260962610626116261262613626146261562616626176261862619626206262162622626236262462625626266262762628626296263062631626326263362634626356263662637626386263962640626416264262643626446264562646626476264862649626506265162652626536265462655626566265762658626596266062661626626266362664626656266662667626686266962670626716267262673626746267562676626776267862679626806268162682626836268462685626866268762688626896269062691626926269362694626956269662697626986269962700627016270262703627046270562706627076270862709627106271162712627136271462715627166271762718627196272062721627226272362724627256272662727627286272962730627316273262733627346273562736627376273862739627406274162742627436274462745627466274762748627496275062751627526275362754627556275662757627586275962760627616276262763627646276562766627676276862769627706277162772627736277462775627766277762778627796278062781627826278362784627856278662787627886278962790627916279262793627946279562796627976279862799628006280162802628036280462805628066280762808628096281062811628126281362814628156281662817628186281962820628216282262823628246282562826628276282862829628306283162832628336283462835628366283762838628396284062841628426284362844628456284662847628486284962850628516285262853628546285562856628576285862859628606286162862628636286462865628666286762868628696287062871628726287362874628756287662877628786287962880628816288262883628846288562886628876288862889628906289162892628936289462895628966289762898628996290062901629026290362904629056290662907629086290962910629116291262913629146291562916629176291862919629206292162922629236292462925629266292762928629296293062931629326293362934629356293662937629386293962940629416294262943629446294562946629476294862949629506295162952629536295462955629566295762958629596296062961629626296362964629656296662967629686296962970629716297262973629746297562976629776297862979629806298162982629836298462985629866298762988629896299062991629926299362994629956299662997629986299963000630016300263003630046300563006630076300863009630106301163012630136301463015630166301763018630196302063021630226302363024630256302663027630286302963030630316303263033630346303563036630376303863039630406304163042630436304463045630466304763048630496305063051630526305363054630556305663057630586305963060630616306263063630646306563066630676306863069630706307163072630736307463075630766307763078630796308063081630826308363084630856308663087630886308963090630916309263093630946309563096630976309863099631006310163102631036310463105631066310763108631096311063111631126311363114631156311663117631186311963120631216312263123631246312563126631276312863129631306313163132631336313463135631366313763138631396314063141631426314363144631456314663147631486314963150631516315263153631546315563156631576315863159631606316163162631636316463165631666316763168631696317063171631726317363174631756317663177631786317963180631816318263183631846318563186631876318863189631906319163192631936319463195631966319763198631996320063201632026320363204632056320663207632086320963210632116321263213632146321563216632176321863219632206322163222632236322463225632266322763228632296323063231632326323363234632356323663237632386323963240632416324263243632446324563246632476324863249632506325163252632536325463255632566325763258632596326063261632626326363264632656326663267632686326963270632716327263273632746327563276632776327863279632806328163282632836328463285632866328763288632896329063291632926329363294632956329663297632986329963300633016330263303633046330563306633076330863309633106331163312633136331463315633166331763318633196332063321633226332363324633256332663327633286332963330633316333263333633346333563336633376333863339633406334163342633436334463345633466334763348633496335063351633526335363354633556335663357633586335963360633616336263363633646336563366633676336863369633706337163372633736337463375633766337763378633796338063381633826338363384633856338663387633886338963390633916339263393633946339563396633976339863399634006340163402634036340463405634066340763408634096341063411634126341363414634156341663417634186341963420634216342263423634246342563426634276342863429634306343163432634336343463435634366343763438634396344063441634426344363444634456344663447634486344963450634516345263453634546345563456634576345863459634606346163462634636346463465634666346763468634696347063471634726347363474634756347663477634786347963480634816348263483634846348563486634876348863489634906349163492634936349463495634966349763498634996350063501635026350363504635056350663507635086350963510635116351263513635146351563516635176351863519635206352163522635236352463525635266352763528635296353063531635326353363534635356353663537635386353963540635416354263543635446354563546635476354863549635506355163552635536355463555635566355763558635596356063561635626356363564635656356663567635686356963570635716357263573635746357563576635776357863579635806358163582635836358463585635866358763588635896359063591635926359363594635956359663597635986359963600636016360263603636046360563606636076360863609636106361163612636136361463615636166361763618636196362063621636226362363624636256362663627636286362963630636316363263633636346363563636636376363863639636406364163642636436364463645636466364763648636496365063651636526365363654636556365663657636586365963660636616366263663636646366563666636676366863669636706367163672636736367463675636766367763678636796368063681636826368363684636856368663687636886368963690636916369263693636946369563696636976369863699637006370163702637036370463705637066370763708637096371063711637126371363714637156371663717637186371963720637216372263723637246372563726637276372863729637306373163732637336373463735637366373763738637396374063741637426374363744637456374663747637486374963750637516375263753637546375563756637576375863759637606376163762637636376463765637666376763768637696377063771637726377363774637756377663777637786377963780637816378263783637846378563786637876378863789637906379163792637936379463795637966379763798637996380063801638026380363804638056380663807638086380963810638116381263813638146381563816638176381863819638206382163822638236382463825638266382763828638296383063831638326383363834638356383663837638386383963840638416384263843638446384563846638476384863849638506385163852638536385463855638566385763858638596386063861638626386363864638656386663867638686386963870638716387263873638746387563876638776387863879638806388163882638836388463885638866388763888638896389063891638926389363894638956389663897638986389963900639016390263903639046390563906639076390863909639106391163912639136391463915639166391763918639196392063921639226392363924639256392663927639286392963930639316393263933639346393563936639376393863939639406394163942639436394463945639466394763948639496395063951639526395363954639556395663957639586395963960639616396263963639646396563966639676396863969639706397163972639736397463975639766397763978639796398063981639826398363984639856398663987639886398963990639916399263993639946399563996639976399863999640006400164002640036400464005640066400764008640096401064011640126401364014640156401664017640186401964020640216402264023640246402564026640276402864029640306403164032640336403464035640366403764038640396404064041640426404364044640456404664047640486404964050640516405264053640546405564056640576405864059640606406164062640636406464065640666406764068640696407064071640726407364074640756407664077640786407964080640816408264083640846408564086640876408864089640906409164092640936409464095640966409764098640996410064101641026410364104641056410664107641086410964110641116411264113641146411564116641176411864119641206412164122641236412464125641266412764128641296413064131641326413364134641356413664137641386413964140641416414264143641446414564146641476414864149641506415164152641536415464155641566415764158641596416064161641626416364164641656416664167641686416964170641716417264173641746417564176641776417864179641806418164182641836418464185641866418764188641896419064191641926419364194641956419664197641986419964200642016420264203642046420564206642076420864209642106421164212642136421464215642166421764218642196422064221642226422364224642256422664227642286422964230642316423264233642346423564236642376423864239642406424164242642436424464245642466424764248642496425064251642526425364254642556425664257642586425964260642616426264263642646426564266642676426864269642706427164272642736427464275642766427764278642796428064281642826428364284642856428664287642886428964290642916429264293642946429564296642976429864299643006430164302643036430464305643066430764308643096431064311643126431364314643156431664317643186431964320643216432264323643246432564326643276432864329643306433164332643336433464335643366433764338643396434064341643426434364344643456434664347643486434964350643516435264353643546435564356643576435864359643606436164362643636436464365643666436764368643696437064371643726437364374643756437664377643786437964380643816438264383643846438564386643876438864389643906439164392643936439464395643966439764398643996440064401644026440364404644056440664407644086440964410644116441264413644146441564416644176441864419644206442164422644236442464425644266442764428644296443064431644326443364434644356443664437644386443964440644416444264443644446444564446644476444864449644506445164452644536445464455644566445764458644596446064461644626446364464644656446664467644686446964470644716447264473644746447564476644776447864479644806448164482644836448464485644866448764488644896449064491644926449364494644956449664497644986449964500645016450264503645046450564506645076450864509645106451164512645136451464515645166451764518645196452064521645226452364524645256452664527645286452964530645316453264533645346453564536645376453864539645406454164542645436454464545645466454764548645496455064551645526455364554645556455664557645586455964560645616456264563645646456564566645676456864569645706457164572645736457464575645766457764578645796458064581645826458364584645856458664587645886458964590645916459264593645946459564596645976459864599646006460164602646036460464605646066460764608646096461064611646126461364614646156461664617646186461964620646216462264623646246462564626646276462864629646306463164632646336463464635646366463764638646396464064641646426464364644646456464664647646486464964650646516465264653646546465564656646576465864659646606466164662646636466464665646666466764668646696467064671646726467364674646756467664677646786467964680646816468264683646846468564686646876468864689646906469164692646936469464695646966469764698646996470064701647026470364704647056470664707647086470964710647116471264713647146471564716647176471864719647206472164722647236472464725647266472764728647296473064731647326473364734647356473664737647386473964740647416474264743647446474564746647476474864749647506475164752647536475464755647566475764758647596476064761647626476364764647656476664767647686476964770647716477264773647746477564776647776477864779647806478164782647836478464785647866478764788647896479064791647926479364794647956479664797647986479964800648016480264803648046480564806648076480864809648106481164812648136481464815648166481764818648196482064821648226482364824648256482664827648286482964830648316483264833648346483564836648376483864839648406484164842648436484464845648466484764848648496485064851648526485364854648556485664857648586485964860648616486264863648646486564866648676486864869648706487164872648736487464875648766487764878648796488064881648826488364884648856488664887648886488964890648916489264893648946489564896648976489864899649006490164902649036490464905649066490764908649096491064911649126491364914649156491664917649186491964920649216492264923649246492564926649276492864929649306493164932649336493464935649366493764938649396494064941649426494364944649456494664947649486494964950649516495264953649546495564956649576495864959649606496164962649636496464965649666496764968649696497064971649726497364974649756497664977649786497964980649816498264983649846498564986649876498864989649906499164992649936499464995649966499764998649996500065001650026500365004650056500665007650086500965010650116501265013650146501565016650176501865019650206502165022650236502465025650266502765028650296503065031650326503365034650356503665037650386503965040650416504265043650446504565046650476504865049650506505165052650536505465055650566505765058650596506065061650626506365064650656506665067650686506965070650716507265073650746507565076650776507865079650806508165082650836508465085650866508765088650896509065091650926509365094650956509665097650986509965100651016510265103651046510565106651076510865109651106511165112651136511465115651166511765118651196512065121651226512365124651256512665127651286512965130651316513265133651346513565136651376513865139651406514165142651436514465145651466514765148651496515065151651526515365154651556515665157651586515965160651616516265163651646516565166651676516865169651706517165172651736517465175651766517765178651796518065181651826518365184651856518665187651886518965190651916519265193651946519565196651976519865199652006520165202652036520465205652066520765208652096521065211652126521365214652156521665217652186521965220652216522265223652246522565226652276522865229652306523165232652336523465235652366523765238652396524065241652426524365244652456524665247652486524965250652516525265253652546525565256652576525865259652606526165262652636526465265652666526765268652696527065271652726527365274652756527665277652786527965280652816528265283652846528565286652876528865289652906529165292652936529465295652966529765298652996530065301653026530365304653056530665307653086530965310653116531265313653146531565316653176531865319653206532165322653236532465325653266532765328653296533065331653326533365334653356533665337653386533965340653416534265343653446534565346653476534865349653506535165352653536535465355653566535765358653596536065361653626536365364653656536665367653686536965370653716537265373653746537565376653776537865379653806538165382653836538465385653866538765388653896539065391653926539365394653956539665397653986539965400654016540265403654046540565406654076540865409654106541165412654136541465415654166541765418654196542065421654226542365424654256542665427654286542965430654316543265433654346543565436654376543865439654406544165442654436544465445654466544765448654496545065451654526545365454654556545665457654586545965460654616546265463654646546565466654676546865469654706547165472654736547465475654766547765478654796548065481654826548365484654856548665487654886548965490654916549265493654946549565496654976549865499655006550165502655036550465505655066550765508655096551065511655126551365514655156551665517655186551965520655216552265523655246552565526655276552865529655306553165532655336553465535655366553765538655396554065541655426554365544655456554665547655486554965550655516555265553655546555565556655576555865559655606556165562655636556465565655666556765568655696557065571655726557365574655756557665577655786557965580655816558265583655846558565586655876558865589655906559165592655936559465595655966559765598655996560065601656026560365604656056560665607656086560965610656116561265613656146561565616656176561865619656206562165622656236562465625656266562765628656296563065631656326563365634656356563665637656386563965640656416564265643656446564565646656476564865649656506565165652656536565465655656566565765658656596566065661656626566365664656656566665667656686566965670656716567265673656746567565676656776567865679656806568165682656836568465685656866568765688656896569065691656926569365694656956569665697656986569965700657016570265703657046570565706657076570865709657106571165712657136571465715657166571765718657196572065721657226572365724657256572665727657286572965730657316573265733657346573565736657376573865739657406574165742657436574465745657466574765748657496575065751657526575365754657556575665757657586575965760657616576265763657646576565766657676576865769657706577165772657736577465775657766577765778657796578065781657826578365784657856578665787657886578965790657916579265793657946579565796657976579865799658006580165802658036580465805658066580765808658096581065811658126581365814658156581665817658186581965820658216582265823658246582565826658276582865829658306583165832658336583465835658366583765838658396584065841658426584365844658456584665847658486584965850658516585265853658546585565856658576585865859658606586165862658636586465865658666586765868658696587065871658726587365874658756587665877658786587965880658816588265883658846588565886658876588865889658906589165892658936589465895658966589765898658996590065901659026590365904659056590665907659086590965910659116591265913659146591565916659176591865919659206592165922659236592465925659266592765928659296593065931659326593365934659356593665937659386593965940659416594265943659446594565946659476594865949659506595165952659536595465955659566595765958659596596065961659626596365964659656596665967659686596965970659716597265973659746597565976659776597865979659806598165982659836598465985659866598765988659896599065991659926599365994659956599665997659986599966000660016600266003660046600566006660076600866009660106601166012660136601466015660166601766018660196602066021660226602366024660256602666027660286602966030660316603266033660346603566036660376603866039660406604166042660436604466045660466604766048660496605066051660526605366054660556605666057660586605966060660616606266063660646606566066660676606866069660706607166072660736607466075660766607766078660796608066081660826608366084660856608666087660886608966090660916609266093660946609566096660976609866099661006610166102661036610466105661066610766108661096611066111661126611366114661156611666117661186611966120661216612266123661246612566126661276612866129661306613166132661336613466135661366613766138661396614066141661426614366144661456614666147661486614966150661516615266153661546615566156661576615866159661606616166162661636616466165661666616766168661696617066171661726617366174661756617666177661786617966180661816618266183661846618566186661876618866189661906619166192661936619466195661966619766198661996620066201662026620366204662056620666207662086620966210662116621266213662146621566216662176621866219662206622166222662236622466225662266622766228662296623066231662326623366234662356623666237662386623966240662416624266243662446624566246662476624866249662506625166252662536625466255662566625766258662596626066261662626626366264662656626666267662686626966270662716627266273662746627566276662776627866279662806628166282662836628466285662866628766288662896629066291662926629366294662956629666297662986629966300663016630266303663046630566306663076630866309663106631166312663136631466315663166631766318663196632066321663226632366324663256632666327663286632966330663316633266333663346633566336663376633866339663406634166342663436634466345663466634766348663496635066351663526635366354663556635666357663586635966360663616636266363663646636566366663676636866369663706637166372663736637466375663766637766378663796638066381663826638366384663856638666387663886638966390663916639266393663946639566396663976639866399664006640166402664036640466405664066640766408664096641066411664126641366414664156641666417664186641966420664216642266423664246642566426664276642866429664306643166432664336643466435664366643766438664396644066441664426644366444664456644666447664486644966450664516645266453664546645566456664576645866459664606646166462664636646466465664666646766468664696647066471664726647366474664756647666477664786647966480664816648266483664846648566486664876648866489664906649166492664936649466495664966649766498664996650066501665026650366504665056650666507665086650966510665116651266513665146651566516665176651866519665206652166522665236652466525665266652766528665296653066531665326653366534665356653666537665386653966540665416654266543665446654566546665476654866549665506655166552665536655466555665566655766558665596656066561665626656366564665656656666567665686656966570665716657266573665746657566576665776657866579665806658166582665836658466585665866658766588665896659066591665926659366594665956659666597665986659966600666016660266603666046660566606666076660866609666106661166612666136661466615666166661766618666196662066621666226662366624666256662666627666286662966630666316663266633666346663566636666376663866639666406664166642666436664466645666466664766648666496665066651666526665366654666556665666657666586665966660666616666266663666646666566666666676666866669666706667166672666736667466675666766667766678666796668066681666826668366684666856668666687666886668966690666916669266693666946669566696666976669866699667006670166702667036670466705667066670766708667096671066711667126671366714667156671666717667186671966720667216672266723667246672566726667276672866729667306673166732667336673466735667366673766738667396674066741667426674366744667456674666747667486674966750667516675266753667546675566756667576675866759667606676166762667636676466765667666676766768667696677066771667726677366774667756677666777667786677966780667816678266783667846678566786667876678866789667906679166792667936679466795667966679766798667996680066801668026680366804668056680666807668086680966810668116681266813668146681566816668176681866819668206682166822668236682466825668266682766828668296683066831668326683366834668356683666837668386683966840668416684266843668446684566846668476684866849668506685166852668536685466855668566685766858668596686066861668626686366864668656686666867668686686966870668716687266873668746687566876668776687866879668806688166882668836688466885668866688766888668896689066891668926689366894668956689666897668986689966900669016690266903669046690566906669076690866909669106691166912669136691466915669166691766918669196692066921669226692366924669256692666927669286692966930669316693266933669346693566936669376693866939669406694166942669436694466945669466694766948669496695066951669526695366954669556695666957669586695966960669616696266963669646696566966669676696866969669706697166972669736697466975669766697766978669796698066981669826698366984669856698666987669886698966990669916699266993669946699566996669976699866999670006700167002670036700467005670066700767008670096701067011670126701367014670156701667017670186701967020670216702267023670246702567026670276702867029670306703167032670336703467035670366703767038670396704067041670426704367044670456704667047670486704967050670516705267053670546705567056670576705867059670606706167062670636706467065670666706767068670696707067071670726707367074670756707667077670786707967080670816708267083670846708567086670876708867089670906709167092670936709467095670966709767098670996710067101671026710367104671056710667107671086710967110671116711267113671146711567116671176711867119671206712167122671236712467125671266712767128671296713067131671326713367134671356713667137671386713967140671416714267143671446714567146671476714867149671506715167152671536715467155671566715767158671596716067161671626716367164671656716667167671686716967170671716717267173671746717567176671776717867179671806718167182671836718467185671866718767188671896719067191671926719367194671956719667197671986719967200672016720267203672046720567206672076720867209672106721167212672136721467215672166721767218672196722067221672226722367224672256722667227672286722967230672316723267233672346723567236672376723867239672406724167242672436724467245672466724767248672496725067251672526725367254672556725667257672586725967260672616726267263672646726567266672676726867269672706727167272672736727467275672766727767278672796728067281672826728367284672856728667287672886728967290672916729267293672946729567296672976729867299673006730167302673036730467305673066730767308673096731067311673126731367314673156731667317673186731967320673216732267323673246732567326673276732867329673306733167332673336733467335673366733767338673396734067341673426734367344673456734667347673486734967350673516735267353673546735567356673576735867359673606736167362673636736467365673666736767368673696737067371673726737367374673756737667377673786737967380673816738267383673846738567386673876738867389673906739167392673936739467395673966739767398673996740067401674026740367404674056740667407674086740967410674116741267413674146741567416674176741867419674206742167422674236742467425674266742767428674296743067431674326743367434674356743667437674386743967440674416744267443674446744567446674476744867449674506745167452674536745467455674566745767458674596746067461674626746367464674656746667467674686746967470674716747267473674746747567476674776747867479674806748167482674836748467485674866748767488674896749067491674926749367494674956749667497674986749967500675016750267503675046750567506675076750867509675106751167512675136751467515675166751767518675196752067521675226752367524675256752667527675286752967530675316753267533675346753567536675376753867539675406754167542675436754467545675466754767548675496755067551675526755367554675556755667557675586755967560675616756267563675646756567566675676756867569675706757167572675736757467575675766757767578675796758067581675826758367584675856758667587675886758967590675916759267593675946759567596675976759867599676006760167602676036760467605676066760767608676096761067611676126761367614676156761667617676186761967620676216762267623676246762567626676276762867629676306763167632676336763467635676366763767638676396764067641676426764367644676456764667647676486764967650676516765267653676546765567656676576765867659676606766167662676636766467665676666766767668676696767067671676726767367674676756767667677676786767967680676816768267683676846768567686676876768867689676906769167692676936769467695676966769767698676996770067701677026770367704677056770667707677086770967710677116771267713677146771567716677176771867719677206772167722677236772467725677266772767728677296773067731677326773367734677356773667737677386773967740677416774267743677446774567746677476774867749677506775167752677536775467755677566775767758677596776067761677626776367764677656776667767677686776967770677716777267773677746777567776677776777867779677806778167782677836778467785677866778767788677896779067791677926779367794677956779667797677986779967800678016780267803678046780567806678076780867809678106781167812678136781467815678166781767818678196782067821678226782367824678256782667827678286782967830678316783267833678346783567836678376783867839678406784167842678436784467845678466784767848678496785067851678526785367854678556785667857678586785967860678616786267863678646786567866678676786867869678706787167872678736787467875678766787767878678796788067881678826788367884678856788667887678886788967890678916789267893678946789567896678976789867899679006790167902679036790467905679066790767908679096791067911679126791367914679156791667917679186791967920679216792267923679246792567926679276792867929679306793167932679336793467935679366793767938679396794067941679426794367944679456794667947679486794967950679516795267953679546795567956679576795867959679606796167962679636796467965679666796767968679696797067971679726797367974679756797667977679786797967980679816798267983679846798567986679876798867989679906799167992679936799467995679966799767998679996800068001680026800368004680056800668007680086800968010680116801268013680146801568016680176801868019680206802168022680236802468025680266802768028680296803068031680326803368034680356803668037680386803968040680416804268043680446804568046680476804868049680506805168052680536805468055680566805768058680596806068061680626806368064680656806668067680686806968070680716807268073680746807568076680776807868079680806808168082680836808468085680866808768088680896809068091680926809368094680956809668097680986809968100681016810268103681046810568106681076810868109681106811168112681136811468115681166811768118681196812068121681226812368124681256812668127681286812968130681316813268133681346813568136681376813868139681406814168142681436814468145681466814768148681496815068151681526815368154681556815668157681586815968160681616816268163681646816568166681676816868169681706817168172681736817468175681766817768178681796818068181681826818368184681856818668187681886818968190681916819268193681946819568196681976819868199682006820168202682036820468205682066820768208682096821068211682126821368214682156821668217682186821968220682216822268223682246822568226682276822868229682306823168232682336823468235682366823768238682396824068241682426824368244682456824668247682486824968250682516825268253682546825568256682576825868259682606826168262682636826468265682666826768268682696827068271682726827368274682756827668277682786827968280682816828268283682846828568286682876828868289682906829168292682936829468295682966829768298682996830068301683026830368304683056830668307683086830968310683116831268313683146831568316683176831868319683206832168322683236832468325683266832768328683296833068331683326833368334683356833668337683386833968340683416834268343683446834568346683476834868349683506835168352683536835468355683566835768358683596836068361683626836368364683656836668367683686836968370683716837268373683746837568376683776837868379683806838168382683836838468385683866838768388683896839068391683926839368394683956839668397683986839968400684016840268403684046840568406684076840868409684106841168412684136841468415684166841768418684196842068421684226842368424684256842668427684286842968430684316843268433684346843568436684376843868439684406844168442684436844468445684466844768448684496845068451684526845368454684556845668457684586845968460684616846268463684646846568466684676846868469684706847168472684736847468475684766847768478684796848068481684826848368484684856848668487684886848968490684916849268493684946849568496684976849868499685006850168502685036850468505685066850768508685096851068511685126851368514685156851668517685186851968520685216852268523685246852568526685276852868529685306853168532685336853468535685366853768538685396854068541685426854368544685456854668547685486854968550685516855268553685546855568556685576855868559685606856168562685636856468565685666856768568685696857068571685726857368574685756857668577685786857968580685816858268583685846858568586685876858868589685906859168592685936859468595685966859768598685996860068601686026860368604686056860668607686086860968610686116861268613686146861568616686176861868619686206862168622686236862468625686266862768628686296863068631686326863368634686356863668637686386863968640686416864268643686446864568646686476864868649686506865168652686536865468655686566865768658686596866068661686626866368664686656866668667686686866968670686716867268673686746867568676686776867868679686806868168682686836868468685686866868768688686896869068691686926869368694686956869668697686986869968700687016870268703687046870568706687076870868709687106871168712687136871468715687166871768718687196872068721687226872368724687256872668727687286872968730687316873268733687346873568736687376873868739687406874168742687436874468745687466874768748687496875068751687526875368754687556875668757687586875968760687616876268763687646876568766687676876868769687706877168772687736877468775687766877768778687796878068781687826878368784687856878668787687886878968790687916879268793687946879568796687976879868799688006880168802688036880468805688066880768808688096881068811688126881368814688156881668817688186881968820688216882268823688246882568826688276882868829688306883168832688336883468835688366883768838688396884068841688426884368844688456884668847688486884968850688516885268853688546885568856688576885868859688606886168862688636886468865688666886768868688696887068871688726887368874688756887668877688786887968880688816888268883688846888568886688876888868889688906889168892688936889468895688966889768898688996890068901689026890368904689056890668907689086890968910689116891268913689146891568916689176891868919689206892168922689236892468925689266892768928689296893068931689326893368934689356893668937689386893968940689416894268943689446894568946689476894868949689506895168952689536895468955689566895768958689596896068961689626896368964689656896668967689686896968970689716897268973689746897568976689776897868979689806898168982689836898468985689866898768988689896899068991689926899368994689956899668997689986899969000690016900269003690046900569006690076900869009690106901169012690136901469015690166901769018690196902069021690226902369024690256902669027690286902969030690316903269033690346903569036690376903869039690406904169042690436904469045690466904769048690496905069051690526905369054690556905669057690586905969060690616906269063690646906569066690676906869069690706907169072690736907469075690766907769078690796908069081690826908369084690856908669087690886908969090690916909269093690946909569096690976909869099691006910169102691036910469105691066910769108691096911069111691126911369114691156911669117691186911969120691216912269123691246912569126691276912869129691306913169132691336913469135691366913769138691396914069141691426914369144691456914669147691486914969150691516915269153691546915569156691576915869159691606916169162691636916469165691666916769168691696917069171691726917369174691756917669177691786917969180691816918269183691846918569186691876918869189691906919169192691936919469195691966919769198691996920069201692026920369204692056920669207692086920969210692116921269213692146921569216692176921869219692206922169222692236922469225692266922769228692296923069231692326923369234692356923669237692386923969240692416924269243692446924569246692476924869249692506925169252692536925469255692566925769258692596926069261692626926369264692656926669267692686926969270692716927269273692746927569276692776927869279692806928169282692836928469285692866928769288692896929069291692926929369294692956929669297692986929969300693016930269303693046930569306693076930869309693106931169312693136931469315693166931769318693196932069321693226932369324693256932669327693286932969330693316933269333693346933569336693376933869339693406934169342693436934469345693466934769348693496935069351693526935369354693556935669357693586935969360693616936269363693646936569366693676936869369693706937169372693736937469375693766937769378693796938069381693826938369384693856938669387693886938969390693916939269393693946939569396693976939869399694006940169402694036940469405694066940769408694096941069411694126941369414694156941669417694186941969420694216942269423694246942569426694276942869429694306943169432694336943469435694366943769438694396944069441694426944369444694456944669447694486944969450694516945269453694546945569456694576945869459694606946169462694636946469465694666946769468694696947069471694726947369474694756947669477694786947969480694816948269483694846948569486694876948869489694906949169492694936949469495694966949769498694996950069501695026950369504695056950669507695086950969510695116951269513695146951569516695176951869519695206952169522695236952469525695266952769528695296953069531695326953369534695356953669537695386953969540695416954269543695446954569546695476954869549695506955169552695536955469555695566955769558695596956069561695626956369564695656956669567695686956969570695716957269573695746957569576695776957869579695806958169582695836958469585695866958769588695896959069591695926959369594695956959669597695986959969600696016960269603696046960569606696076960869609696106961169612696136961469615696166961769618696196962069621696226962369624696256962669627696286962969630696316963269633696346963569636696376963869639696406964169642696436964469645696466964769648696496965069651696526965369654696556965669657696586965969660696616966269663696646966569666696676966869669696706967169672696736967469675696766967769678696796968069681696826968369684696856968669687696886968969690696916969269693696946969569696696976969869699697006970169702697036970469705697066970769708697096971069711697126971369714697156971669717697186971969720697216972269723697246972569726697276972869729697306973169732697336973469735697366973769738697396974069741697426974369744697456974669747697486974969750697516975269753697546975569756697576975869759697606976169762697636976469765697666976769768697696977069771697726977369774697756977669777697786977969780697816978269783697846978569786697876978869789697906979169792697936979469795697966979769798697996980069801698026980369804698056980669807698086980969810698116981269813698146981569816698176981869819698206982169822698236982469825698266982769828698296983069831698326983369834698356983669837698386983969840698416984269843698446984569846698476984869849698506985169852698536985469855698566985769858698596986069861698626986369864698656986669867698686986969870698716987269873698746987569876698776987869879698806988169882698836988469885698866988769888698896989069891698926989369894698956989669897698986989969900699016990269903699046990569906699076990869909699106991169912699136991469915699166991769918699196992069921699226992369924699256992669927699286992969930699316993269933699346993569936699376993869939699406994169942699436994469945699466994769948699496995069951699526995369954699556995669957699586995969960699616996269963699646996569966699676996869969699706997169972699736997469975699766997769978699796998069981699826998369984699856998669987699886998969990699916999269993699946999569996699976999869999700007000170002700037000470005700067000770008700097001070011700127001370014700157001670017700187001970020700217002270023700247002570026700277002870029700307003170032700337003470035700367003770038700397004070041700427004370044700457004670047700487004970050700517005270053700547005570056700577005870059700607006170062700637006470065700667006770068700697007070071700727007370074700757007670077700787007970080700817008270083700847008570086700877008870089700907009170092700937009470095700967009770098700997010070101701027010370104701057010670107701087010970110701117011270113701147011570116701177011870119701207012170122701237012470125701267012770128701297013070131701327013370134701357013670137701387013970140701417014270143701447014570146701477014870149701507015170152701537015470155701567015770158701597016070161701627016370164701657016670167701687016970170701717017270173701747017570176701777017870179701807018170182701837018470185701867018770188701897019070191701927019370194701957019670197701987019970200702017020270203702047020570206702077020870209702107021170212702137021470215702167021770218702197022070221702227022370224702257022670227702287022970230702317023270233702347023570236702377023870239702407024170242702437024470245702467024770248702497025070251702527025370254702557025670257702587025970260702617026270263702647026570266702677026870269702707027170272702737027470275702767027770278702797028070281702827028370284702857028670287702887028970290702917029270293702947029570296702977029870299703007030170302703037030470305703067030770308703097031070311703127031370314703157031670317703187031970320703217032270323703247032570326703277032870329703307033170332703337033470335703367033770338703397034070341703427034370344703457034670347703487034970350703517035270353703547035570356703577035870359703607036170362703637036470365703667036770368703697037070371703727037370374703757037670377703787037970380703817038270383703847038570386703877038870389703907039170392703937039470395703967039770398703997040070401704027040370404704057040670407704087040970410704117041270413704147041570416704177041870419704207042170422704237042470425704267042770428704297043070431704327043370434704357043670437704387043970440704417044270443704447044570446704477044870449704507045170452704537045470455704567045770458704597046070461704627046370464704657046670467704687046970470704717047270473704747047570476704777047870479704807048170482704837048470485704867048770488704897049070491704927049370494704957049670497704987049970500705017050270503705047050570506705077050870509705107051170512705137051470515705167051770518705197052070521705227052370524705257052670527705287052970530705317053270533705347053570536705377053870539705407054170542705437054470545705467054770548705497055070551705527055370554705557055670557705587055970560705617056270563705647056570566705677056870569705707057170572705737057470575705767057770578705797058070581705827058370584705857058670587705887058970590705917059270593705947059570596705977059870599706007060170602706037060470605706067060770608706097061070611706127061370614706157061670617706187061970620706217062270623706247062570626706277062870629706307063170632706337063470635706367063770638706397064070641706427064370644706457064670647706487064970650706517065270653706547065570656706577065870659706607066170662706637066470665706667066770668706697067070671706727067370674706757067670677706787067970680706817068270683706847068570686706877068870689706907069170692706937069470695706967069770698706997070070701707027070370704707057070670707707087070970710707117071270713707147071570716707177071870719707207072170722707237072470725707267072770728707297073070731707327073370734707357073670737707387073970740707417074270743707447074570746707477074870749707507075170752707537075470755707567075770758707597076070761707627076370764707657076670767707687076970770707717077270773707747077570776707777077870779707807078170782707837078470785707867078770788707897079070791707927079370794707957079670797707987079970800708017080270803708047080570806708077080870809708107081170812708137081470815708167081770818708197082070821708227082370824708257082670827708287082970830708317083270833708347083570836708377083870839708407084170842708437084470845708467084770848708497085070851708527085370854708557085670857708587085970860708617086270863708647086570866708677086870869708707087170872708737087470875708767087770878708797088070881708827088370884708857088670887708887088970890708917089270893708947089570896708977089870899709007090170902709037090470905709067090770908709097091070911709127091370914709157091670917709187091970920709217092270923709247092570926709277092870929709307093170932709337093470935709367093770938709397094070941709427094370944709457094670947709487094970950709517095270953709547095570956709577095870959709607096170962709637096470965709667096770968709697097070971709727097370974709757097670977709787097970980709817098270983709847098570986709877098870989709907099170992709937099470995709967099770998709997100071001710027100371004710057100671007710087100971010710117101271013710147101571016710177101871019710207102171022710237102471025710267102771028710297103071031710327103371034710357103671037710387103971040710417104271043710447104571046710477104871049710507105171052710537105471055710567105771058710597106071061710627106371064710657106671067710687106971070710717107271073710747107571076710777107871079710807108171082710837108471085710867108771088710897109071091710927109371094710957109671097710987109971100711017110271103711047110571106711077110871109711107111171112711137111471115711167111771118711197112071121711227112371124711257112671127711287112971130711317113271133711347113571136711377113871139711407114171142711437114471145711467114771148711497115071151711527115371154711557115671157711587115971160711617116271163711647116571166711677116871169711707117171172711737117471175711767117771178711797118071181711827118371184711857118671187711887118971190711917119271193711947119571196711977119871199712007120171202712037120471205712067120771208712097121071211712127121371214712157121671217712187121971220712217122271223712247122571226712277122871229712307123171232712337123471235712367123771238712397124071241712427124371244712457124671247712487124971250712517125271253712547125571256712577125871259712607126171262712637126471265712667126771268712697127071271712727127371274712757127671277712787127971280712817128271283712847128571286712877128871289712907129171292712937129471295712967129771298712997130071301713027130371304713057130671307713087130971310713117131271313713147131571316713177131871319713207132171322713237132471325713267132771328713297133071331713327133371334713357133671337713387133971340713417134271343713447134571346713477134871349713507135171352713537135471355713567135771358713597136071361713627136371364713657136671367713687136971370713717137271373713747137571376713777137871379713807138171382713837138471385713867138771388713897139071391713927139371394713957139671397713987139971400714017140271403714047140571406714077140871409714107141171412714137141471415714167141771418714197142071421714227142371424714257142671427714287142971430714317143271433714347143571436714377143871439714407144171442714437144471445714467144771448714497145071451714527145371454714557145671457714587145971460714617146271463714647146571466714677146871469714707147171472714737147471475714767147771478714797148071481714827148371484714857148671487714887148971490714917149271493714947149571496714977149871499715007150171502715037150471505715067150771508715097151071511715127151371514715157151671517715187151971520715217152271523715247152571526715277152871529715307153171532715337153471535715367153771538715397154071541715427154371544715457154671547715487154971550715517155271553715547155571556715577155871559715607156171562715637156471565715667156771568715697157071571715727157371574715757157671577715787157971580715817158271583715847158571586715877158871589715907159171592715937159471595715967159771598715997160071601716027160371604716057160671607716087160971610716117161271613716147161571616716177161871619716207162171622716237162471625716267162771628716297163071631716327163371634716357163671637716387163971640716417164271643716447164571646716477164871649716507165171652716537165471655716567165771658716597166071661716627166371664716657166671667716687166971670716717167271673716747167571676716777167871679716807168171682716837168471685716867168771688716897169071691716927169371694716957169671697716987169971700717017170271703717047170571706717077170871709717107171171712717137171471715717167171771718717197172071721717227172371724717257172671727717287172971730717317173271733717347173571736717377173871739717407174171742717437174471745717467174771748717497175071751717527175371754717557175671757717587175971760717617176271763717647176571766717677176871769717707177171772717737177471775717767177771778717797178071781717827178371784717857178671787717887178971790717917179271793717947179571796717977179871799718007180171802718037180471805718067180771808718097181071811718127181371814718157181671817718187181971820718217182271823718247182571826718277182871829718307183171832718337183471835718367183771838718397184071841718427184371844718457184671847718487184971850718517185271853718547185571856718577185871859718607186171862718637186471865718667186771868718697187071871718727187371874718757187671877718787187971880718817188271883718847188571886718877188871889718907189171892718937189471895718967189771898718997190071901719027190371904719057190671907719087190971910719117191271913719147191571916719177191871919719207192171922719237192471925719267192771928719297193071931719327193371934719357193671937719387193971940719417194271943719447194571946719477194871949719507195171952719537195471955719567195771958719597196071961719627196371964719657196671967719687196971970719717197271973719747197571976719777197871979719807198171982719837198471985719867198771988719897199071991719927199371994719957199671997719987199972000720017200272003720047200572006720077200872009720107201172012720137201472015720167201772018720197202072021720227202372024720257202672027720287202972030720317203272033720347203572036720377203872039720407204172042720437204472045720467204772048720497205072051720527205372054720557205672057720587205972060720617206272063720647206572066720677206872069720707207172072720737207472075720767207772078720797208072081720827208372084720857208672087720887208972090720917209272093720947209572096720977209872099721007210172102721037210472105721067210772108721097211072111721127211372114721157211672117721187211972120721217212272123721247212572126721277212872129721307213172132721337213472135721367213772138721397214072141721427214372144721457214672147721487214972150721517215272153721547215572156721577215872159721607216172162721637216472165721667216772168721697217072171721727217372174721757217672177721787217972180721817218272183721847218572186721877218872189721907219172192721937219472195721967219772198721997220072201722027220372204722057220672207722087220972210722117221272213722147221572216722177221872219722207222172222722237222472225722267222772228722297223072231722327223372234722357223672237722387223972240722417224272243722447224572246722477224872249722507225172252722537225472255722567225772258722597226072261722627226372264722657226672267722687226972270722717227272273722747227572276722777227872279722807228172282722837228472285722867228772288722897229072291722927229372294722957229672297722987229972300723017230272303723047230572306723077230872309723107231172312723137231472315723167231772318723197232072321723227232372324723257232672327723287232972330723317233272333723347233572336723377233872339723407234172342723437234472345723467234772348723497235072351723527235372354723557235672357723587235972360723617236272363723647236572366723677236872369723707237172372723737237472375723767237772378723797238072381723827238372384723857238672387723887238972390723917239272393723947239572396723977239872399724007240172402724037240472405724067240772408724097241072411724127241372414724157241672417724187241972420724217242272423724247242572426724277242872429724307243172432724337243472435724367243772438724397244072441724427244372444724457244672447724487244972450724517245272453724547245572456724577245872459724607246172462724637246472465724667246772468724697247072471724727247372474724757247672477724787247972480724817248272483724847248572486724877248872489724907249172492724937249472495724967249772498724997250072501725027250372504725057250672507725087250972510725117251272513725147251572516725177251872519725207252172522725237252472525725267252772528725297253072531725327253372534725357253672537725387253972540725417254272543725447254572546725477254872549725507255172552725537255472555725567255772558725597256072561725627256372564725657256672567725687256972570725717257272573725747257572576725777257872579725807258172582725837258472585725867258772588725897259072591725927259372594725957259672597725987259972600726017260272603726047260572606726077260872609726107261172612726137261472615726167261772618726197262072621726227262372624726257262672627726287262972630726317263272633726347263572636726377263872639726407264172642726437264472645726467264772648726497265072651726527265372654726557265672657726587265972660726617266272663726647266572666726677266872669726707267172672726737267472675726767267772678726797268072681726827268372684726857268672687726887268972690726917269272693726947269572696726977269872699727007270172702727037270472705727067270772708727097271072711727127271372714727157271672717727187271972720727217272272723727247272572726727277272872729727307273172732727337273472735727367273772738727397274072741727427274372744727457274672747727487274972750727517275272753727547275572756727577275872759727607276172762727637276472765727667276772768727697277072771727727277372774727757277672777727787277972780727817278272783727847278572786727877278872789727907279172792727937279472795727967279772798727997280072801728027280372804728057280672807728087280972810728117281272813728147281572816728177281872819728207282172822728237282472825728267282772828728297283072831728327283372834728357283672837728387283972840728417284272843728447284572846728477284872849728507285172852728537285472855728567285772858728597286072861728627286372864728657286672867728687286972870728717287272873728747287572876728777287872879728807288172882728837288472885728867288772888728897289072891728927289372894728957289672897728987289972900729017290272903729047290572906729077290872909729107291172912729137291472915729167291772918729197292072921729227292372924729257292672927729287292972930729317293272933729347293572936729377293872939729407294172942729437294472945729467294772948729497295072951729527295372954729557295672957729587295972960729617296272963729647296572966729677296872969729707297172972729737297472975729767297772978729797298072981729827298372984729857298672987729887298972990729917299272993729947299572996729977299872999730007300173002730037300473005730067300773008730097301073011730127301373014730157301673017730187301973020730217302273023730247302573026730277302873029730307303173032730337303473035730367303773038730397304073041730427304373044730457304673047730487304973050730517305273053730547305573056730577305873059730607306173062730637306473065730667306773068730697307073071730727307373074730757307673077730787307973080730817308273083730847308573086730877308873089730907309173092730937309473095730967309773098730997310073101731027310373104731057310673107731087310973110731117311273113731147311573116731177311873119731207312173122731237312473125731267312773128731297313073131731327313373134731357313673137731387313973140731417314273143731447314573146731477314873149731507315173152731537315473155731567315773158731597316073161731627316373164731657316673167731687316973170731717317273173731747317573176731777317873179731807318173182731837318473185731867318773188731897319073191731927319373194731957319673197731987319973200732017320273203732047320573206732077320873209732107321173212732137321473215732167321773218732197322073221732227322373224732257322673227732287322973230732317323273233732347323573236732377323873239732407324173242732437324473245732467324773248732497325073251732527325373254732557325673257732587325973260732617326273263732647326573266732677326873269732707327173272732737327473275732767327773278732797328073281732827328373284732857328673287732887328973290732917329273293732947329573296732977329873299733007330173302733037330473305733067330773308733097331073311733127331373314733157331673317733187331973320733217332273323733247332573326733277332873329733307333173332733337333473335733367333773338733397334073341733427334373344733457334673347733487334973350733517335273353733547335573356733577335873359733607336173362733637336473365733667336773368733697337073371733727337373374733757337673377733787337973380733817338273383733847338573386733877338873389733907339173392733937339473395733967339773398733997340073401734027340373404734057340673407734087340973410734117341273413734147341573416734177341873419734207342173422734237342473425734267342773428734297343073431734327343373434734357343673437734387343973440734417344273443734447344573446734477344873449734507345173452734537345473455734567345773458734597346073461734627346373464734657346673467734687346973470734717347273473734747347573476734777347873479734807348173482734837348473485734867348773488734897349073491734927349373494734957349673497734987349973500735017350273503735047350573506735077350873509735107351173512735137351473515735167351773518735197352073521735227352373524735257352673527735287352973530735317353273533735347353573536735377353873539735407354173542735437354473545735467354773548735497355073551735527355373554735557355673557735587355973560735617356273563735647356573566735677356873569735707357173572735737357473575735767357773578735797358073581735827358373584735857358673587735887358973590735917359273593735947359573596735977359873599736007360173602736037360473605736067360773608736097361073611736127361373614736157361673617736187361973620736217362273623736247362573626736277362873629736307363173632736337363473635736367363773638736397364073641736427364373644736457364673647736487364973650736517365273653736547365573656736577365873659736607366173662736637366473665736667366773668736697367073671736727367373674736757367673677736787367973680736817368273683736847368573686736877368873689736907369173692736937369473695736967369773698736997370073701737027370373704737057370673707737087370973710737117371273713737147371573716737177371873719737207372173722737237372473725737267372773728737297373073731737327373373734737357373673737737387373973740737417374273743737447374573746737477374873749737507375173752737537375473755737567375773758737597376073761737627376373764737657376673767737687376973770737717377273773737747377573776737777377873779737807378173782737837378473785737867378773788737897379073791737927379373794737957379673797737987379973800738017380273803738047380573806738077380873809738107381173812738137381473815738167381773818738197382073821738227382373824738257382673827738287382973830738317383273833738347383573836738377383873839738407384173842738437384473845738467384773848738497385073851738527385373854738557385673857738587385973860738617386273863738647386573866738677386873869738707387173872738737387473875738767387773878738797388073881738827388373884738857388673887738887388973890738917389273893738947389573896738977389873899739007390173902739037390473905739067390773908739097391073911739127391373914739157391673917739187391973920739217392273923739247392573926739277392873929739307393173932739337393473935739367393773938739397394073941739427394373944739457394673947739487394973950739517395273953739547395573956739577395873959739607396173962739637396473965739667396773968739697397073971739727397373974739757397673977739787397973980739817398273983739847398573986739877398873989739907399173992739937399473995739967399773998739997400074001740027400374004740057400674007740087400974010740117401274013740147401574016740177401874019740207402174022740237402474025740267402774028740297403074031740327403374034740357403674037740387403974040740417404274043740447404574046740477404874049740507405174052740537405474055740567405774058740597406074061740627406374064740657406674067740687406974070740717407274073740747407574076740777407874079740807408174082740837408474085740867408774088740897409074091740927409374094740957409674097740987409974100741017410274103741047410574106741077410874109741107411174112741137411474115741167411774118741197412074121741227412374124741257412674127741287412974130741317413274133741347413574136741377413874139741407414174142741437414474145741467414774148741497415074151741527415374154741557415674157741587415974160741617416274163741647416574166741677416874169741707417174172741737417474175741767417774178741797418074181741827418374184741857418674187741887418974190741917419274193741947419574196741977419874199742007420174202742037420474205742067420774208742097421074211742127421374214742157421674217742187421974220742217422274223742247422574226742277422874229742307423174232742337423474235742367423774238742397424074241742427424374244742457424674247742487424974250742517425274253742547425574256742577425874259742607426174262742637426474265742667426774268742697427074271742727427374274742757427674277742787427974280742817428274283742847428574286742877428874289742907429174292742937429474295742967429774298742997430074301743027430374304743057430674307743087430974310743117431274313743147431574316743177431874319743207432174322743237432474325743267432774328743297433074331743327433374334743357433674337743387433974340743417434274343743447434574346743477434874349743507435174352743537435474355743567435774358743597436074361743627436374364743657436674367743687436974370743717437274373743747437574376743777437874379743807438174382743837438474385743867438774388743897439074391743927439374394743957439674397743987439974400744017440274403744047440574406744077440874409744107441174412744137441474415744167441774418744197442074421744227442374424744257442674427744287442974430744317443274433744347443574436744377443874439744407444174442744437444474445744467444774448744497445074451744527445374454744557445674457744587445974460744617446274463744647446574466744677446874469744707447174472744737447474475744767447774478744797448074481744827448374484744857448674487744887448974490744917449274493744947449574496744977449874499745007450174502745037450474505745067450774508745097451074511745127451374514745157451674517745187451974520745217452274523745247452574526745277452874529745307453174532745337453474535745367453774538745397454074541745427454374544745457454674547745487454974550745517455274553745547455574556745577455874559745607456174562745637456474565745667456774568745697457074571745727457374574745757457674577745787457974580745817458274583745847458574586745877458874589745907459174592745937459474595745967459774598745997460074601746027460374604746057460674607746087460974610746117461274613746147461574616746177461874619746207462174622746237462474625746267462774628746297463074631746327463374634746357463674637746387463974640746417464274643746447464574646746477464874649746507465174652746537465474655746567465774658746597466074661746627466374664746657466674667746687466974670746717467274673746747467574676746777467874679746807468174682746837468474685746867468774688746897469074691746927469374694746957469674697746987469974700747017470274703747047470574706747077470874709747107471174712747137471474715747167471774718747197472074721747227472374724747257472674727747287472974730747317473274733747347473574736747377473874739747407474174742747437474474745747467474774748747497475074751747527475374754747557475674757747587475974760747617476274763747647476574766747677476874769747707477174772747737477474775747767477774778747797478074781747827478374784747857478674787747887478974790747917479274793747947479574796747977479874799748007480174802748037480474805748067480774808748097481074811748127481374814748157481674817748187481974820748217482274823748247482574826748277482874829748307483174832748337483474835748367483774838748397484074841748427484374844748457484674847748487484974850748517485274853748547485574856748577485874859748607486174862748637486474865748667486774868748697487074871748727487374874748757487674877748787487974880748817488274883748847488574886748877488874889748907489174892748937489474895748967489774898748997490074901749027490374904749057490674907749087490974910749117491274913749147491574916749177491874919749207492174922749237492474925749267492774928749297493074931749327493374934749357493674937749387493974940749417494274943749447494574946749477494874949749507495174952749537495474955749567495774958749597496074961749627496374964749657496674967749687496974970749717497274973749747497574976749777497874979749807498174982749837498474985749867498774988749897499074991749927499374994749957499674997749987499975000750017500275003750047500575006750077500875009750107501175012750137501475015750167501775018750197502075021750227502375024750257502675027750287502975030750317503275033750347503575036750377503875039750407504175042750437504475045750467504775048750497505075051750527505375054750557505675057750587505975060750617506275063750647506575066750677506875069750707507175072750737507475075750767507775078750797508075081750827508375084750857508675087750887508975090750917509275093750947509575096750977509875099751007510175102751037510475105751067510775108751097511075111751127511375114751157511675117751187511975120751217512275123751247512575126751277512875129751307513175132751337513475135751367513775138751397514075141751427514375144751457514675147751487514975150751517515275153751547515575156751577515875159751607516175162751637516475165751667516775168751697517075171751727517375174751757517675177751787517975180751817518275183751847518575186751877518875189751907519175192751937519475195751967519775198751997520075201752027520375204752057520675207752087520975210752117521275213752147521575216752177521875219752207522175222752237522475225752267522775228752297523075231752327523375234752357523675237752387523975240752417524275243752447524575246752477524875249752507525175252752537525475255752567525775258752597526075261752627526375264752657526675267752687526975270752717527275273752747527575276752777527875279752807528175282752837528475285752867528775288752897529075291752927529375294752957529675297752987529975300753017530275303753047530575306753077530875309753107531175312753137531475315753167531775318753197532075321753227532375324753257532675327753287532975330753317533275333753347533575336753377533875339753407534175342753437534475345753467534775348753497535075351753527535375354753557535675357753587535975360753617536275363753647536575366753677536875369753707537175372753737537475375753767537775378753797538075381753827538375384753857538675387753887538975390753917539275393753947539575396753977539875399754007540175402754037540475405754067540775408754097541075411754127541375414754157541675417754187541975420754217542275423754247542575426754277542875429754307543175432754337543475435754367543775438754397544075441754427544375444754457544675447754487544975450754517545275453754547545575456754577545875459754607546175462754637546475465754667546775468754697547075471754727547375474754757547675477754787547975480754817548275483754847548575486754877548875489754907549175492754937549475495754967549775498754997550075501755027550375504755057550675507755087550975510755117551275513755147551575516755177551875519755207552175522755237552475525755267552775528755297553075531755327553375534755357553675537755387553975540755417554275543755447554575546755477554875549755507555175552755537555475555755567555775558755597556075561755627556375564755657556675567755687556975570755717557275573755747557575576755777557875579755807558175582755837558475585755867558775588755897559075591755927559375594755957559675597755987559975600756017560275603756047560575606756077560875609756107561175612756137561475615756167561775618756197562075621756227562375624756257562675627756287562975630756317563275633756347563575636756377563875639756407564175642756437564475645756467564775648756497565075651756527565375654756557565675657756587565975660756617566275663756647566575666756677566875669756707567175672756737567475675756767567775678756797568075681756827568375684756857568675687756887568975690756917569275693756947569575696756977569875699757007570175702757037570475705757067570775708757097571075711757127571375714757157571675717757187571975720757217572275723757247572575726757277572875729757307573175732757337573475735757367573775738757397574075741757427574375744757457574675747757487574975750757517575275753757547575575756757577575875759757607576175762757637576475765757667576775768757697577075771757727577375774757757577675777757787577975780757817578275783757847578575786757877578875789757907579175792757937579475795757967579775798757997580075801758027580375804758057580675807758087580975810758117581275813758147581575816758177581875819758207582175822758237582475825758267582775828758297583075831758327583375834758357583675837758387583975840758417584275843758447584575846758477584875849758507585175852758537585475855758567585775858758597586075861758627586375864758657586675867758687586975870758717587275873758747587575876758777587875879758807588175882758837588475885758867588775888758897589075891758927589375894758957589675897758987589975900759017590275903759047590575906759077590875909759107591175912759137591475915759167591775918759197592075921759227592375924759257592675927759287592975930759317593275933759347593575936759377593875939759407594175942759437594475945759467594775948759497595075951759527595375954759557595675957759587595975960759617596275963759647596575966759677596875969759707597175972759737597475975759767597775978759797598075981759827598375984759857598675987759887598975990759917599275993759947599575996759977599875999760007600176002760037600476005760067600776008760097601076011760127601376014760157601676017760187601976020760217602276023760247602576026760277602876029760307603176032760337603476035760367603776038760397604076041760427604376044760457604676047760487604976050760517605276053760547605576056760577605876059760607606176062760637606476065760667606776068760697607076071760727607376074760757607676077760787607976080760817608276083760847608576086760877608876089760907609176092760937609476095760967609776098760997610076101761027610376104761057610676107761087610976110761117611276113761147611576116761177611876119761207612176122761237612476125761267612776128761297613076131761327613376134761357613676137761387613976140761417614276143761447614576146761477614876149761507615176152761537615476155761567615776158761597616076161761627616376164761657616676167761687616976170761717617276173761747617576176761777617876179761807618176182761837618476185761867618776188761897619076191761927619376194761957619676197761987619976200762017620276203762047620576206762077620876209762107621176212762137621476215762167621776218762197622076221762227622376224762257622676227762287622976230762317623276233762347623576236762377623876239762407624176242762437624476245762467624776248762497625076251762527625376254762557625676257762587625976260762617626276263762647626576266762677626876269762707627176272762737627476275762767627776278762797628076281762827628376284762857628676287762887628976290762917629276293762947629576296762977629876299763007630176302763037630476305763067630776308763097631076311763127631376314763157631676317763187631976320763217632276323763247632576326763277632876329763307633176332763337633476335763367633776338763397634076341763427634376344763457634676347763487634976350763517635276353763547635576356763577635876359763607636176362763637636476365763667636776368763697637076371763727637376374763757637676377763787637976380763817638276383763847638576386763877638876389763907639176392763937639476395763967639776398763997640076401764027640376404764057640676407764087640976410764117641276413764147641576416764177641876419764207642176422764237642476425764267642776428764297643076431764327643376434764357643676437764387643976440764417644276443764447644576446764477644876449764507645176452764537645476455764567645776458764597646076461764627646376464764657646676467764687646976470764717647276473764747647576476764777647876479764807648176482764837648476485764867648776488764897649076491764927649376494764957649676497764987649976500765017650276503765047650576506765077650876509765107651176512765137651476515765167651776518765197652076521765227652376524765257652676527765287652976530765317653276533765347653576536765377653876539765407654176542765437654476545765467654776548765497655076551765527655376554765557655676557765587655976560765617656276563765647656576566765677656876569765707657176572765737657476575765767657776578765797658076581765827658376584765857658676587765887658976590765917659276593765947659576596765977659876599766007660176602766037660476605766067660776608766097661076611766127661376614766157661676617766187661976620766217662276623766247662576626766277662876629766307663176632766337663476635766367663776638766397664076641766427664376644766457664676647766487664976650766517665276653766547665576656766577665876659766607666176662766637666476665766667666776668766697667076671766727667376674766757667676677766787667976680766817668276683766847668576686766877668876689766907669176692766937669476695766967669776698766997670076701767027670376704767057670676707767087670976710767117671276713767147671576716767177671876719767207672176722767237672476725767267672776728767297673076731767327673376734767357673676737767387673976740767417674276743767447674576746767477674876749767507675176752767537675476755767567675776758767597676076761767627676376764767657676676767767687676976770767717677276773767747677576776767777677876779767807678176782767837678476785767867678776788767897679076791767927679376794767957679676797767987679976800768017680276803768047680576806768077680876809768107681176812768137681476815768167681776818768197682076821768227682376824768257682676827768287682976830768317683276833768347683576836768377683876839768407684176842768437684476845768467684776848768497685076851768527685376854768557685676857768587685976860768617686276863768647686576866768677686876869768707687176872768737687476875768767687776878768797688076881768827688376884768857688676887768887688976890768917689276893768947689576896768977689876899769007690176902769037690476905769067690776908769097691076911769127691376914769157691676917769187691976920769217692276923769247692576926769277692876929769307693176932769337693476935769367693776938769397694076941769427694376944769457694676947769487694976950769517695276953769547695576956769577695876959769607696176962769637696476965769667696776968769697697076971769727697376974769757697676977769787697976980769817698276983769847698576986769877698876989769907699176992769937699476995769967699776998769997700077001770027700377004770057700677007770087700977010770117701277013770147701577016770177701877019770207702177022770237702477025770267702777028770297703077031770327703377034770357703677037770387703977040770417704277043770447704577046770477704877049770507705177052770537705477055770567705777058770597706077061770627706377064770657706677067770687706977070770717707277073770747707577076770777707877079770807708177082770837708477085770867708777088770897709077091770927709377094770957709677097770987709977100771017710277103771047710577106771077710877109771107711177112771137711477115771167711777118771197712077121771227712377124771257712677127771287712977130771317713277133771347713577136771377713877139771407714177142771437714477145771467714777148771497715077151771527715377154771557715677157771587715977160771617716277163771647716577166771677716877169771707717177172771737717477175771767717777178771797718077181771827718377184771857718677187771887718977190771917719277193771947719577196771977719877199772007720177202772037720477205772067720777208772097721077211772127721377214772157721677217772187721977220772217722277223772247722577226772277722877229772307723177232772337723477235772367723777238772397724077241772427724377244772457724677247772487724977250772517725277253772547725577256772577725877259772607726177262772637726477265772667726777268772697727077271772727727377274772757727677277772787727977280772817728277283772847728577286772877728877289772907729177292772937729477295772967729777298772997730077301773027730377304773057730677307773087730977310773117731277313773147731577316773177731877319773207732177322773237732477325773267732777328773297733077331773327733377334773357733677337773387733977340773417734277343773447734577346773477734877349773507735177352773537735477355773567735777358773597736077361773627736377364773657736677367773687736977370773717737277373773747737577376773777737877379773807738177382773837738477385773867738777388773897739077391773927739377394773957739677397773987739977400774017740277403774047740577406774077740877409774107741177412774137741477415774167741777418774197742077421774227742377424774257742677427774287742977430774317743277433774347743577436774377743877439774407744177442774437744477445774467744777448774497745077451774527745377454774557745677457774587745977460774617746277463774647746577466774677746877469774707747177472774737747477475774767747777478774797748077481774827748377484774857748677487774887748977490774917749277493774947749577496774977749877499775007750177502775037750477505775067750777508775097751077511775127751377514775157751677517775187751977520775217752277523775247752577526775277752877529775307753177532775337753477535775367753777538775397754077541775427754377544775457754677547775487754977550775517755277553775547755577556775577755877559775607756177562775637756477565775667756777568775697757077571775727757377574775757757677577775787757977580775817758277583775847758577586775877758877589775907759177592775937759477595775967759777598775997760077601776027760377604776057760677607776087760977610776117761277613776147761577616776177761877619776207762177622776237762477625776267762777628776297763077631776327763377634776357763677637776387763977640776417764277643776447764577646776477764877649776507765177652776537765477655776567765777658776597766077661776627766377664776657766677667776687766977670776717767277673776747767577676776777767877679776807768177682776837768477685776867768777688776897769077691776927769377694776957769677697776987769977700777017770277703777047770577706777077770877709777107771177712777137771477715777167771777718777197772077721777227772377724777257772677727777287772977730777317773277733777347773577736777377773877739777407774177742777437774477745777467774777748777497775077751777527775377754777557775677757777587775977760777617776277763777647776577766777677776877769777707777177772777737777477775777767777777778777797778077781777827778377784777857778677787777887778977790777917779277793777947779577796777977779877799778007780177802778037780477805778067780777808778097781077811778127781377814778157781677817778187781977820778217782277823778247782577826778277782877829778307783177832778337783477835778367783777838778397784077841778427784377844778457784677847778487784977850778517785277853778547785577856778577785877859778607786177862778637786477865778667786777868778697787077871778727787377874778757787677877778787787977880778817788277883778847788577886778877788877889778907789177892778937789477895778967789777898778997790077901779027790377904779057790677907779087790977910779117791277913779147791577916779177791877919779207792177922779237792477925779267792777928779297793077931779327793377934779357793677937779387793977940779417794277943779447794577946779477794877949779507795177952779537795477955779567795777958779597796077961779627796377964779657796677967779687796977970779717797277973779747797577976779777797877979779807798177982779837798477985779867798777988779897799077991779927799377994779957799677997779987799978000780017800278003780047800578006780077800878009780107801178012780137801478015780167801778018780197802078021780227802378024780257802678027780287802978030780317803278033780347803578036780377803878039780407804178042780437804478045780467804778048780497805078051780527805378054780557805678057780587805978060780617806278063780647806578066780677806878069780707807178072780737807478075780767807778078780797808078081780827808378084780857808678087780887808978090780917809278093780947809578096780977809878099781007810178102781037810478105781067810778108781097811078111781127811378114781157811678117781187811978120781217812278123781247812578126781277812878129781307813178132781337813478135781367813778138781397814078141781427814378144781457814678147781487814978150781517815278153781547815578156781577815878159781607816178162781637816478165781667816778168781697817078171781727817378174781757817678177781787817978180781817818278183781847818578186781877818878189781907819178192781937819478195781967819778198781997820078201782027820378204782057820678207782087820978210782117821278213782147821578216782177821878219782207822178222782237822478225782267822778228782297823078231782327823378234782357823678237782387823978240782417824278243782447824578246782477824878249782507825178252782537825478255782567825778258782597826078261782627826378264782657826678267782687826978270782717827278273782747827578276782777827878279782807828178282782837828478285782867828778288782897829078291782927829378294782957829678297782987829978300783017830278303783047830578306783077830878309783107831178312783137831478315783167831778318783197832078321783227832378324783257832678327783287832978330783317833278333783347833578336783377833878339783407834178342783437834478345783467834778348783497835078351783527835378354783557835678357783587835978360783617836278363783647836578366783677836878369783707837178372783737837478375783767837778378783797838078381783827838378384783857838678387783887838978390783917839278393783947839578396783977839878399784007840178402784037840478405784067840778408784097841078411784127841378414784157841678417784187841978420784217842278423784247842578426784277842878429784307843178432784337843478435784367843778438784397844078441784427844378444784457844678447784487844978450784517845278453784547845578456784577845878459784607846178462784637846478465784667846778468784697847078471784727847378474784757847678477784787847978480784817848278483784847848578486784877848878489784907849178492784937849478495784967849778498784997850078501785027850378504785057850678507785087850978510785117851278513785147851578516785177851878519785207852178522785237852478525785267852778528785297853078531785327853378534785357853678537785387853978540785417854278543785447854578546785477854878549785507855178552785537855478555785567855778558785597856078561785627856378564785657856678567785687856978570785717857278573785747857578576785777857878579785807858178582785837858478585785867858778588785897859078591785927859378594785957859678597785987859978600786017860278603786047860578606786077860878609786107861178612786137861478615786167861778618786197862078621786227862378624786257862678627786287862978630786317863278633786347863578636786377863878639786407864178642786437864478645786467864778648786497865078651786527865378654786557865678657786587865978660786617866278663786647866578666786677866878669786707867178672786737867478675786767867778678786797868078681786827868378684786857868678687786887868978690786917869278693786947869578696786977869878699787007870178702787037870478705787067870778708787097871078711787127871378714787157871678717787187871978720787217872278723787247872578726787277872878729787307873178732787337873478735787367873778738787397874078741787427874378744787457874678747787487874978750787517875278753787547875578756787577875878759787607876178762787637876478765787667876778768787697877078771787727877378774787757877678777787787877978780787817878278783787847878578786787877878878789787907879178792787937879478795787967879778798787997880078801788027880378804788057880678807788087880978810788117881278813788147881578816788177881878819788207882178822788237882478825788267882778828788297883078831788327883378834788357883678837788387883978840788417884278843788447884578846788477884878849788507885178852788537885478855788567885778858788597886078861788627886378864788657886678867788687886978870788717887278873788747887578876788777887878879788807888178882788837888478885788867888778888788897889078891788927889378894788957889678897788987889978900789017890278903789047890578906789077890878909789107891178912789137891478915789167891778918789197892078921789227892378924789257892678927789287892978930789317893278933789347893578936789377893878939789407894178942789437894478945789467894778948789497895078951789527895378954789557895678957789587895978960789617896278963789647896578966789677896878969789707897178972789737897478975789767897778978789797898078981789827898378984789857898678987789887898978990789917899278993789947899578996789977899878999790007900179002790037900479005790067900779008790097901079011790127901379014790157901679017790187901979020790217902279023790247902579026790277902879029790307903179032790337903479035790367903779038790397904079041790427904379044790457904679047790487904979050790517905279053790547905579056790577905879059790607906179062790637906479065790667906779068790697907079071790727907379074790757907679077790787907979080790817908279083790847908579086790877908879089790907909179092790937909479095790967909779098790997910079101791027910379104791057910679107791087910979110791117911279113791147911579116791177911879119791207912179122791237912479125791267912779128791297913079131791327913379134791357913679137791387913979140791417914279143791447914579146791477914879149791507915179152791537915479155791567915779158791597916079161791627916379164791657916679167791687916979170791717917279173791747917579176791777917879179791807918179182791837918479185791867918779188791897919079191791927919379194791957919679197791987919979200792017920279203792047920579206792077920879209792107921179212792137921479215792167921779218792197922079221792227922379224792257922679227792287922979230792317923279233792347923579236792377923879239792407924179242792437924479245792467924779248792497925079251792527925379254792557925679257792587925979260792617926279263792647926579266792677926879269792707927179272792737927479275792767927779278792797928079281792827928379284792857928679287792887928979290792917929279293792947929579296792977929879299793007930179302793037930479305793067930779308793097931079311793127931379314793157931679317793187931979320793217932279323793247932579326793277932879329793307933179332793337933479335793367933779338793397934079341793427934379344793457934679347793487934979350793517935279353793547935579356793577935879359793607936179362793637936479365793667936779368793697937079371793727937379374793757937679377793787937979380793817938279383793847938579386793877938879389793907939179392793937939479395793967939779398793997940079401794027940379404794057940679407794087940979410794117941279413794147941579416794177941879419794207942179422794237942479425794267942779428794297943079431794327943379434794357943679437794387943979440794417944279443794447944579446794477944879449794507945179452794537945479455794567945779458794597946079461794627946379464794657946679467794687946979470794717947279473794747947579476794777947879479794807948179482794837948479485794867948779488794897949079491794927949379494794957949679497794987949979500795017950279503795047950579506795077950879509795107951179512795137951479515795167951779518795197952079521795227952379524795257952679527795287952979530795317953279533795347953579536795377953879539795407954179542795437954479545795467954779548795497955079551795527955379554795557955679557795587955979560795617956279563795647956579566795677956879569795707957179572795737957479575795767957779578795797958079581795827958379584795857958679587795887958979590795917959279593795947959579596795977959879599796007960179602796037960479605796067960779608796097961079611796127961379614796157961679617796187961979620796217962279623796247962579626796277962879629796307963179632796337963479635796367963779638796397964079641796427964379644796457964679647796487964979650796517965279653796547965579656796577965879659796607966179662796637966479665796667966779668796697967079671796727967379674796757967679677796787967979680796817968279683796847968579686796877968879689796907969179692796937969479695796967969779698796997970079701797027970379704797057970679707797087970979710797117971279713797147971579716797177971879719797207972179722797237972479725797267972779728797297973079731797327973379734797357973679737797387973979740797417974279743797447974579746797477974879749797507975179752797537975479755797567975779758797597976079761797627976379764797657976679767797687976979770797717977279773797747977579776797777977879779797807978179782797837978479785797867978779788797897979079791797927979379794797957979679797797987979979800798017980279803798047980579806798077980879809798107981179812798137981479815798167981779818798197982079821798227982379824798257982679827798287982979830798317983279833798347983579836798377983879839798407984179842798437984479845798467984779848798497985079851798527985379854798557985679857798587985979860798617986279863798647986579866798677986879869798707987179872798737987479875798767987779878798797988079881798827988379884798857988679887798887988979890798917989279893798947989579896798977989879899799007990179902799037990479905799067990779908799097991079911799127991379914799157991679917799187991979920799217992279923799247992579926799277992879929799307993179932799337993479935799367993779938799397994079941799427994379944799457994679947799487994979950799517995279953799547995579956799577995879959799607996179962799637996479965799667996779968799697997079971799727997379974799757997679977799787997979980799817998279983799847998579986799877998879989799907999179992799937999479995799967999779998799998000080001800028000380004800058000680007800088000980010800118001280013800148001580016800178001880019800208002180022800238002480025800268002780028800298003080031800328003380034800358003680037800388003980040800418004280043800448004580046800478004880049800508005180052800538005480055800568005780058800598006080061800628006380064800658006680067800688006980070800718007280073800748007580076800778007880079800808008180082800838008480085800868008780088800898009080091800928009380094800958009680097800988009980100801018010280103801048010580106801078010880109801108011180112801138011480115801168011780118801198012080121801228012380124801258012680127801288012980130801318013280133801348013580136801378013880139801408014180142801438014480145801468014780148801498015080151801528015380154801558015680157801588015980160801618016280163801648016580166801678016880169801708017180172801738017480175801768017780178801798018080181801828018380184801858018680187801888018980190801918019280193801948019580196801978019880199802008020180202802038020480205802068020780208802098021080211802128021380214802158021680217802188021980220802218022280223802248022580226802278022880229802308023180232802338023480235802368023780238802398024080241802428024380244802458024680247802488024980250802518025280253802548025580256802578025880259802608026180262802638026480265802668026780268802698027080271802728027380274802758027680277802788027980280802818028280283802848028580286802878028880289802908029180292802938029480295802968029780298802998030080301803028030380304803058030680307803088030980310803118031280313803148031580316803178031880319803208032180322803238032480325803268032780328803298033080331803328033380334803358033680337803388033980340803418034280343803448034580346803478034880349803508035180352803538035480355803568035780358803598036080361803628036380364803658036680367803688036980370803718037280373803748037580376803778037880379803808038180382803838038480385803868038780388803898039080391803928039380394803958039680397803988039980400804018040280403804048040580406804078040880409804108041180412804138041480415804168041780418804198042080421804228042380424804258042680427804288042980430804318043280433804348043580436804378043880439804408044180442804438044480445804468044780448804498045080451804528045380454804558045680457804588045980460804618046280463804648046580466804678046880469804708047180472804738047480475804768047780478804798048080481804828048380484804858048680487804888048980490804918049280493804948049580496804978049880499805008050180502805038050480505805068050780508805098051080511805128051380514805158051680517805188051980520805218052280523805248052580526805278052880529805308053180532805338053480535805368053780538805398054080541805428054380544805458054680547805488054980550805518055280553805548055580556805578055880559805608056180562805638056480565805668056780568805698057080571805728057380574805758057680577805788057980580805818058280583805848058580586805878058880589805908059180592805938059480595805968059780598805998060080601806028060380604806058060680607806088060980610806118061280613806148061580616806178061880619806208062180622806238062480625806268062780628806298063080631806328063380634806358063680637806388063980640806418064280643806448064580646806478064880649806508065180652806538065480655806568065780658806598066080661806628066380664806658066680667806688066980670806718067280673806748067580676806778067880679806808068180682806838068480685806868068780688806898069080691806928069380694806958069680697806988069980700807018070280703807048070580706807078070880709807108071180712807138071480715807168071780718807198072080721807228072380724807258072680727807288072980730807318073280733807348073580736807378073880739807408074180742807438074480745807468074780748807498075080751807528075380754807558075680757807588075980760807618076280763807648076580766807678076880769807708077180772807738077480775807768077780778807798078080781807828078380784807858078680787807888078980790807918079280793807948079580796807978079880799808008080180802808038080480805808068080780808808098081080811808128081380814808158081680817808188081980820808218082280823808248082580826808278082880829808308083180832808338083480835808368083780838808398084080841808428084380844808458084680847808488084980850808518085280853808548085580856808578085880859808608086180862808638086480865808668086780868808698087080871808728087380874808758087680877808788087980880808818088280883808848088580886808878088880889808908089180892808938089480895808968089780898808998090080901809028090380904809058090680907809088090980910809118091280913809148091580916809178091880919809208092180922809238092480925809268092780928809298093080931809328093380934809358093680937809388093980940809418094280943809448094580946809478094880949809508095180952809538095480955809568095780958809598096080961809628096380964809658096680967809688096980970809718097280973809748097580976809778097880979809808098180982809838098480985809868098780988809898099080991809928099380994809958099680997809988099981000810018100281003810048100581006810078100881009810108101181012810138101481015810168101781018810198102081021810228102381024810258102681027810288102981030810318103281033810348103581036810378103881039810408104181042810438104481045810468104781048810498105081051810528105381054810558105681057810588105981060810618106281063810648106581066810678106881069810708107181072810738107481075810768107781078810798108081081810828108381084810858108681087810888108981090810918109281093810948109581096810978109881099811008110181102811038110481105811068110781108811098111081111811128111381114811158111681117811188111981120811218112281123811248112581126811278112881129811308113181132811338113481135811368113781138811398114081141811428114381144811458114681147811488114981150811518115281153811548115581156811578115881159811608116181162811638116481165811668116781168811698117081171811728117381174811758117681177811788117981180811818118281183811848118581186811878118881189811908119181192811938119481195811968119781198811998120081201812028120381204812058120681207812088120981210812118121281213812148121581216812178121881219812208122181222812238122481225812268122781228812298123081231812328123381234812358123681237812388123981240812418124281243812448124581246812478124881249812508125181252812538125481255812568125781258812598126081261812628126381264812658126681267812688126981270812718127281273812748127581276812778127881279812808128181282812838128481285812868128781288812898129081291812928129381294812958129681297812988129981300813018130281303813048130581306813078130881309813108131181312813138131481315813168131781318813198132081321813228132381324813258132681327813288132981330813318133281333813348133581336813378133881339813408134181342813438134481345813468134781348813498135081351813528135381354813558135681357813588135981360813618136281363813648136581366813678136881369813708137181372813738137481375813768137781378813798138081381813828138381384813858138681387813888138981390813918139281393813948139581396813978139881399814008140181402814038140481405814068140781408814098141081411814128141381414814158141681417814188141981420814218142281423814248142581426814278142881429814308143181432814338143481435814368143781438814398144081441814428144381444814458144681447814488144981450814518145281453814548145581456814578145881459814608146181462814638146481465814668146781468814698147081471814728147381474814758147681477814788147981480814818148281483814848148581486814878148881489814908149181492814938149481495814968149781498814998150081501815028150381504815058150681507815088150981510815118151281513815148151581516815178151881519815208152181522815238152481525815268152781528815298153081531815328153381534815358153681537815388153981540815418154281543815448154581546815478154881549815508155181552815538155481555815568155781558815598156081561815628156381564815658156681567815688156981570815718157281573815748157581576815778157881579815808158181582815838158481585815868158781588815898159081591815928159381594815958159681597815988159981600816018160281603816048160581606816078160881609816108161181612816138161481615816168161781618816198162081621816228162381624816258162681627816288162981630816318163281633816348163581636816378163881639816408164181642816438164481645816468164781648816498165081651816528165381654816558165681657816588165981660816618166281663816648166581666816678166881669816708167181672816738167481675816768167781678816798168081681816828168381684816858168681687816888168981690816918169281693816948169581696816978169881699817008170181702817038170481705817068170781708817098171081711817128171381714817158171681717817188171981720817218172281723817248172581726817278172881729817308173181732817338173481735817368173781738817398174081741817428174381744817458174681747817488174981750817518175281753817548175581756817578175881759817608176181762817638176481765817668176781768817698177081771817728177381774817758177681777817788177981780817818178281783817848178581786817878178881789817908179181792817938179481795817968179781798817998180081801818028180381804818058180681807818088180981810818118181281813818148181581816818178181881819818208182181822818238182481825818268182781828818298183081831818328183381834818358183681837818388183981840818418184281843818448184581846818478184881849818508185181852818538185481855818568185781858818598186081861818628186381864818658186681867818688186981870818718187281873818748187581876818778187881879818808188181882818838188481885818868188781888818898189081891818928189381894818958189681897818988189981900819018190281903819048190581906819078190881909819108191181912819138191481915819168191781918819198192081921819228192381924819258192681927819288192981930819318193281933819348193581936819378193881939819408194181942819438194481945819468194781948819498195081951819528195381954819558195681957819588195981960819618196281963819648196581966819678196881969819708197181972819738197481975819768197781978819798198081981819828198381984819858198681987819888198981990819918199281993819948199581996819978199881999820008200182002820038200482005820068200782008820098201082011820128201382014820158201682017820188201982020820218202282023820248202582026820278202882029820308203182032820338203482035820368203782038820398204082041820428204382044820458204682047820488204982050820518205282053820548205582056820578205882059820608206182062820638206482065820668206782068820698207082071820728207382074820758207682077820788207982080820818208282083820848208582086820878208882089820908209182092820938209482095820968209782098820998210082101821028210382104821058210682107821088210982110821118211282113821148211582116821178211882119821208212182122821238212482125821268212782128821298213082131821328213382134821358213682137821388213982140821418214282143821448214582146821478214882149821508215182152821538215482155821568215782158821598216082161821628216382164821658216682167821688216982170821718217282173821748217582176821778217882179821808218182182821838218482185821868218782188821898219082191821928219382194821958219682197821988219982200822018220282203822048220582206822078220882209822108221182212822138221482215822168221782218822198222082221822228222382224822258222682227822288222982230822318223282233822348223582236822378223882239822408224182242822438224482245822468224782248822498225082251822528225382254822558225682257822588225982260822618226282263822648226582266822678226882269822708227182272822738227482275822768227782278822798228082281822828228382284822858228682287822888228982290822918229282293822948229582296822978229882299823008230182302823038230482305823068230782308823098231082311823128231382314823158231682317823188231982320823218232282323823248232582326823278232882329823308233182332823338233482335823368233782338823398234082341823428234382344823458234682347823488234982350823518235282353823548235582356823578235882359823608236182362823638236482365823668236782368823698237082371823728237382374823758237682377823788237982380823818238282383823848238582386823878238882389823908239182392823938239482395823968239782398823998240082401824028240382404824058240682407824088240982410824118241282413824148241582416824178241882419824208242182422824238242482425824268242782428824298243082431824328243382434824358243682437824388243982440824418244282443824448244582446824478244882449824508245182452824538245482455824568245782458824598246082461824628246382464824658246682467824688246982470824718247282473824748247582476824778247882479824808248182482824838248482485824868248782488824898249082491824928249382494824958249682497824988249982500825018250282503825048250582506825078250882509825108251182512825138251482515825168251782518825198252082521825228252382524825258252682527825288252982530825318253282533825348253582536825378253882539825408254182542825438254482545825468254782548825498255082551825528255382554825558255682557825588255982560825618256282563825648256582566825678256882569825708257182572825738257482575825768257782578825798258082581825828258382584825858258682587825888258982590825918259282593825948259582596825978259882599826008260182602826038260482605826068260782608826098261082611826128261382614826158261682617826188261982620826218262282623826248262582626826278262882629826308263182632826338263482635826368263782638826398264082641826428264382644826458264682647826488264982650826518265282653826548265582656826578265882659826608266182662826638266482665826668266782668826698267082671826728267382674826758267682677826788267982680826818268282683826848268582686826878268882689826908269182692826938269482695826968269782698826998270082701827028270382704827058270682707827088270982710827118271282713827148271582716827178271882719827208272182722827238272482725827268272782728827298273082731827328273382734827358273682737827388273982740827418274282743827448274582746827478274882749827508275182752827538275482755827568275782758827598276082761827628276382764827658276682767827688276982770827718277282773827748277582776827778277882779827808278182782827838278482785827868278782788827898279082791827928279382794827958279682797827988279982800828018280282803828048280582806828078280882809828108281182812828138281482815828168281782818828198282082821828228282382824828258282682827828288282982830828318283282833828348283582836828378283882839828408284182842828438284482845828468284782848828498285082851828528285382854828558285682857828588285982860828618286282863828648286582866828678286882869828708287182872828738287482875828768287782878828798288082881828828288382884828858288682887828888288982890828918289282893828948289582896828978289882899829008290182902829038290482905829068290782908829098291082911829128291382914829158291682917829188291982920829218292282923829248292582926829278292882929829308293182932829338293482935829368293782938829398294082941829428294382944829458294682947829488294982950829518295282953829548295582956829578295882959829608296182962829638296482965829668296782968829698297082971829728297382974829758297682977829788297982980829818298282983829848298582986829878298882989829908299182992829938299482995829968299782998829998300083001830028300383004830058300683007830088300983010830118301283013830148301583016830178301883019830208302183022830238302483025830268302783028830298303083031830328303383034830358303683037830388303983040830418304283043830448304583046830478304883049830508305183052830538305483055830568305783058830598306083061830628306383064830658306683067830688306983070830718307283073830748307583076830778307883079830808308183082830838308483085830868308783088830898309083091830928309383094830958309683097830988309983100831018310283103831048310583106831078310883109831108311183112831138311483115831168311783118831198312083121831228312383124831258312683127831288312983130831318313283133831348313583136831378313883139831408314183142831438314483145831468314783148831498315083151831528315383154831558315683157831588315983160831618316283163831648316583166831678316883169831708317183172831738317483175831768317783178831798318083181831828318383184831858318683187831888318983190831918319283193831948319583196831978319883199832008320183202832038320483205832068320783208832098321083211832128321383214832158321683217832188321983220832218322283223832248322583226832278322883229832308323183232832338323483235832368323783238832398324083241832428324383244832458324683247832488324983250832518325283253832548325583256832578325883259832608326183262832638326483265832668326783268832698327083271832728327383274832758327683277832788327983280832818328283283832848328583286832878328883289832908329183292832938329483295832968329783298832998330083301833028330383304833058330683307833088330983310833118331283313833148331583316833178331883319833208332183322833238332483325833268332783328833298333083331833328333383334833358333683337833388333983340833418334283343833448334583346833478334883349833508335183352833538335483355833568335783358833598336083361833628336383364833658336683367833688336983370833718337283373833748337583376833778337883379833808338183382833838338483385833868338783388833898339083391833928339383394833958339683397833988339983400834018340283403834048340583406834078340883409834108341183412834138341483415834168341783418834198342083421834228342383424834258342683427834288342983430834318343283433834348343583436834378343883439834408344183442834438344483445834468344783448834498345083451834528345383454834558345683457834588345983460834618346283463834648346583466834678346883469834708347183472834738347483475834768347783478834798348083481834828348383484834858348683487834888348983490834918349283493834948349583496834978349883499835008350183502835038350483505835068350783508835098351083511835128351383514835158351683517835188351983520835218352283523835248352583526835278352883529835308353183532835338353483535835368353783538835398354083541835428354383544835458354683547835488354983550835518355283553835548355583556835578355883559835608356183562835638356483565835668356783568835698357083571835728357383574835758357683577835788357983580835818358283583835848358583586835878358883589835908359183592835938359483595835968359783598835998360083601836028360383604836058360683607836088360983610836118361283613836148361583616836178361883619836208362183622836238362483625836268362783628836298363083631836328363383634836358363683637836388363983640836418364283643836448364583646836478364883649836508365183652836538365483655836568365783658836598366083661836628366383664836658366683667836688366983670836718367283673836748367583676836778367883679836808368183682836838368483685836868368783688836898369083691836928369383694836958369683697836988369983700837018370283703837048370583706837078370883709837108371183712837138371483715837168371783718837198372083721837228372383724837258372683727837288372983730837318373283733837348373583736837378373883739837408374183742837438374483745837468374783748837498375083751837528375383754837558375683757837588375983760837618376283763837648376583766837678376883769837708377183772837738377483775837768377783778837798378083781837828378383784837858378683787837888378983790837918379283793837948379583796837978379883799838008380183802838038380483805838068380783808838098381083811838128381383814838158381683817838188381983820838218382283823838248382583826838278382883829838308383183832838338383483835838368383783838838398384083841838428384383844838458384683847838488384983850838518385283853838548385583856838578385883859838608386183862838638386483865838668386783868838698387083871838728387383874838758387683877838788387983880838818388283883838848388583886838878388883889838908389183892838938389483895838968389783898838998390083901839028390383904839058390683907839088390983910839118391283913839148391583916839178391883919839208392183922839238392483925839268392783928839298393083931839328393383934839358393683937839388393983940839418394283943839448394583946839478394883949839508395183952839538395483955839568395783958839598396083961839628396383964839658396683967839688396983970839718397283973839748397583976839778397883979839808398183982839838398483985839868398783988839898399083991839928399383994839958399683997839988399984000840018400284003840048400584006840078400884009840108401184012840138401484015840168401784018840198402084021840228402384024840258402684027840288402984030840318403284033840348403584036840378403884039840408404184042840438404484045840468404784048840498405084051840528405384054840558405684057840588405984060840618406284063840648406584066840678406884069840708407184072840738407484075840768407784078840798408084081840828408384084840858408684087840888408984090840918409284093840948409584096840978409884099841008410184102841038410484105841068410784108841098411084111841128411384114841158411684117841188411984120841218412284123841248412584126841278412884129841308413184132841338413484135841368413784138841398414084141841428414384144841458414684147841488414984150841518415284153841548415584156841578415884159841608416184162841638416484165841668416784168841698417084171841728417384174841758417684177841788417984180841818418284183841848418584186841878418884189841908419184192841938419484195841968419784198841998420084201842028420384204842058420684207842088420984210842118421284213842148421584216842178421884219842208422184222842238422484225842268422784228842298423084231842328423384234842358423684237842388423984240842418424284243842448424584246842478424884249842508425184252842538425484255842568425784258842598426084261842628426384264842658426684267842688426984270842718427284273842748427584276842778427884279842808428184282842838428484285842868428784288842898429084291842928429384294842958429684297842988429984300843018430284303843048430584306843078430884309843108431184312843138431484315843168431784318843198432084321843228432384324843258432684327843288432984330843318433284333843348433584336843378433884339843408434184342843438434484345843468434784348843498435084351843528435384354843558435684357843588435984360843618436284363843648436584366843678436884369843708437184372843738437484375843768437784378843798438084381843828438384384843858438684387843888438984390843918439284393843948439584396843978439884399844008440184402844038440484405844068440784408844098441084411844128441384414844158441684417844188441984420844218442284423844248442584426844278442884429844308443184432844338443484435844368443784438844398444084441844428444384444844458444684447844488444984450844518445284453844548445584456844578445884459844608446184462844638446484465844668446784468844698447084471844728447384474844758447684477844788447984480844818448284483844848448584486844878448884489844908449184492844938449484495844968449784498844998450084501845028450384504845058450684507845088450984510845118451284513845148451584516845178451884519845208452184522845238452484525845268452784528845298453084531845328453384534845358453684537845388453984540845418454284543845448454584546845478454884549845508455184552845538455484555845568455784558845598456084561845628456384564845658456684567845688456984570845718457284573845748457584576845778457884579845808458184582845838458484585845868458784588845898459084591845928459384594845958459684597845988459984600846018460284603846048460584606846078460884609846108461184612846138461484615846168461784618846198462084621846228462384624846258462684627846288462984630846318463284633846348463584636846378463884639846408464184642846438464484645846468464784648846498465084651846528465384654846558465684657846588465984660846618466284663846648466584666846678466884669846708467184672846738467484675846768467784678846798468084681846828468384684846858468684687846888468984690846918469284693846948469584696846978469884699847008470184702847038470484705847068470784708847098471084711847128471384714847158471684717847188471984720847218472284723847248472584726847278472884729847308473184732847338473484735847368473784738847398474084741847428474384744847458474684747847488474984750847518475284753847548475584756847578475884759847608476184762847638476484765847668476784768847698477084771847728477384774847758477684777847788477984780847818478284783847848478584786847878478884789847908479184792847938479484795847968479784798847998480084801848028480384804848058480684807848088480984810848118481284813848148481584816848178481884819848208482184822848238482484825848268482784828848298483084831848328483384834848358483684837848388483984840848418484284843848448484584846848478484884849848508485184852848538485484855848568485784858848598486084861848628486384864848658486684867848688486984870848718487284873848748487584876848778487884879848808488184882848838488484885848868488784888848898489084891848928489384894848958489684897848988489984900849018490284903849048490584906849078490884909849108491184912849138491484915849168491784918849198492084921849228492384924849258492684927849288492984930849318493284933849348493584936849378493884939849408494184942849438494484945849468494784948849498495084951849528495384954849558495684957849588495984960849618496284963849648496584966849678496884969849708497184972849738497484975849768497784978849798498084981849828498384984849858498684987849888498984990849918499284993849948499584996849978499884999850008500185002850038500485005850068500785008850098501085011850128501385014850158501685017850188501985020850218502285023850248502585026850278502885029850308503185032850338503485035850368503785038850398504085041850428504385044850458504685047850488504985050850518505285053850548505585056850578505885059850608506185062850638506485065850668506785068850698507085071850728507385074850758507685077850788507985080850818508285083850848508585086850878508885089850908509185092850938509485095850968509785098850998510085101851028510385104851058510685107851088510985110851118511285113851148511585116851178511885119851208512185122851238512485125851268512785128851298513085131851328513385134851358513685137851388513985140851418514285143851448514585146851478514885149851508515185152851538515485155851568515785158851598516085161851628516385164851658516685167851688516985170851718517285173851748517585176851778517885179851808518185182851838518485185851868518785188851898519085191851928519385194851958519685197851988519985200852018520285203852048520585206852078520885209852108521185212852138521485215852168521785218852198522085221852228522385224852258522685227852288522985230852318523285233852348523585236852378523885239852408524185242852438524485245852468524785248852498525085251852528525385254852558525685257852588525985260852618526285263852648526585266852678526885269852708527185272852738527485275852768527785278852798528085281852828528385284852858528685287852888528985290852918529285293852948529585296852978529885299853008530185302853038530485305853068530785308853098531085311853128531385314853158531685317853188531985320853218532285323853248532585326853278532885329853308533185332853338533485335853368533785338853398534085341853428534385344853458534685347853488534985350853518535285353853548535585356853578535885359853608536185362853638536485365853668536785368853698537085371853728537385374853758537685377853788537985380853818538285383853848538585386853878538885389853908539185392853938539485395853968539785398853998540085401854028540385404854058540685407854088540985410854118541285413854148541585416854178541885419854208542185422854238542485425854268542785428854298543085431854328543385434854358543685437854388543985440854418544285443854448544585446854478544885449854508545185452854538545485455854568545785458854598546085461854628546385464854658546685467854688546985470854718547285473854748547585476854778547885479854808548185482854838548485485854868548785488854898549085491854928549385494854958549685497854988549985500855018550285503855048550585506855078550885509855108551185512855138551485515855168551785518855198552085521855228552385524855258552685527855288552985530855318553285533855348553585536855378553885539855408554185542855438554485545855468554785548855498555085551855528555385554855558555685557855588555985560855618556285563855648556585566855678556885569855708557185572855738557485575855768557785578855798558085581855828558385584855858558685587855888558985590855918559285593855948559585596855978559885599856008560185602856038560485605856068560785608856098561085611856128561385614856158561685617856188561985620856218562285623856248562585626856278562885629856308563185632856338563485635856368563785638856398564085641856428564385644856458564685647856488564985650856518565285653856548565585656856578565885659856608566185662856638566485665856668566785668856698567085671856728567385674856758567685677856788567985680856818568285683856848568585686856878568885689856908569185692856938569485695856968569785698856998570085701857028570385704857058570685707857088570985710857118571285713857148571585716857178571885719857208572185722857238572485725857268572785728857298573085731857328573385734857358573685737857388573985740857418574285743857448574585746857478574885749857508575185752857538575485755857568575785758857598576085761857628576385764857658576685767857688576985770857718577285773857748577585776857778577885779857808578185782857838578485785857868578785788857898579085791857928579385794857958579685797857988579985800858018580285803858048580585806858078580885809858108581185812858138581485815858168581785818858198582085821858228582385824858258582685827858288582985830858318583285833858348583585836858378583885839858408584185842858438584485845858468584785848858498585085851858528585385854858558585685857858588585985860858618586285863858648586585866858678586885869858708587185872858738587485875858768587785878858798588085881858828588385884858858588685887858888588985890858918589285893858948589585896858978589885899859008590185902859038590485905859068590785908859098591085911859128591385914859158591685917859188591985920859218592285923859248592585926859278592885929859308593185932859338593485935859368593785938859398594085941859428594385944859458594685947859488594985950859518595285953859548595585956859578595885959859608596185962859638596485965859668596785968859698597085971859728597385974859758597685977859788597985980859818598285983859848598585986859878598885989859908599185992859938599485995859968599785998859998600086001860028600386004860058600686007860088600986010860118601286013860148601586016860178601886019860208602186022860238602486025860268602786028860298603086031860328603386034860358603686037860388603986040860418604286043860448604586046860478604886049860508605186052860538605486055860568605786058860598606086061860628606386064860658606686067860688606986070860718607286073860748607586076860778607886079860808608186082860838608486085860868608786088860898609086091860928609386094860958609686097860988609986100861018610286103861048610586106861078610886109861108611186112861138611486115861168611786118861198612086121861228612386124861258612686127861288612986130861318613286133861348613586136861378613886139861408614186142861438614486145861468614786148861498615086151861528615386154861558615686157861588615986160861618616286163861648616586166861678616886169861708617186172861738617486175861768617786178861798618086181861828618386184861858618686187861888618986190861918619286193861948619586196861978619886199862008620186202862038620486205862068620786208862098621086211862128621386214862158621686217862188621986220862218622286223862248622586226862278622886229862308623186232862338623486235862368623786238862398624086241862428624386244862458624686247862488624986250862518625286253862548625586256862578625886259862608626186262862638626486265862668626786268862698627086271862728627386274862758627686277862788627986280862818628286283862848628586286862878628886289862908629186292862938629486295862968629786298862998630086301863028630386304863058630686307863088630986310863118631286313863148631586316863178631886319863208632186322863238632486325863268632786328863298633086331863328633386334863358633686337863388633986340863418634286343863448634586346863478634886349863508635186352863538635486355863568635786358863598636086361863628636386364863658636686367863688636986370863718637286373863748637586376863778637886379863808638186382863838638486385863868638786388863898639086391863928639386394863958639686397863988639986400864018640286403864048640586406864078640886409864108641186412864138641486415864168641786418864198642086421864228642386424864258642686427864288642986430864318643286433864348643586436864378643886439864408644186442864438644486445864468644786448864498645086451864528645386454864558645686457864588645986460864618646286463864648646586466864678646886469864708647186472864738647486475864768647786478864798648086481864828648386484864858648686487864888648986490864918649286493864948649586496864978649886499865008650186502865038650486505865068650786508865098651086511865128651386514865158651686517865188651986520865218652286523865248652586526865278652886529865308653186532865338653486535865368653786538865398654086541865428654386544865458654686547865488654986550865518655286553865548655586556865578655886559865608656186562865638656486565865668656786568865698657086571865728657386574865758657686577865788657986580865818658286583865848658586586865878658886589865908659186592865938659486595865968659786598865998660086601866028660386604866058660686607866088660986610866118661286613866148661586616866178661886619866208662186622866238662486625866268662786628866298663086631866328663386634866358663686637866388663986640866418664286643866448664586646866478664886649866508665186652866538665486655866568665786658866598666086661866628666386664866658666686667866688666986670866718667286673866748667586676866778667886679866808668186682866838668486685866868668786688866898669086691866928669386694866958669686697866988669986700867018670286703867048670586706867078670886709867108671186712867138671486715867168671786718867198672086721867228672386724867258672686727867288672986730867318673286733867348673586736867378673886739867408674186742867438674486745867468674786748867498675086751867528675386754867558675686757867588675986760867618676286763867648676586766867678676886769867708677186772867738677486775867768677786778867798678086781867828678386784867858678686787867888678986790867918679286793867948679586796867978679886799868008680186802868038680486805868068680786808868098681086811868128681386814868158681686817868188681986820868218682286823868248682586826868278682886829868308683186832868338683486835868368683786838868398684086841868428684386844868458684686847868488684986850868518685286853868548685586856868578685886859868608686186862868638686486865868668686786868868698687086871868728687386874868758687686877868788687986880868818688286883868848688586886868878688886889868908689186892868938689486895868968689786898868998690086901869028690386904869058690686907869088690986910869118691286913869148691586916869178691886919869208692186922869238692486925869268692786928869298693086931869328693386934869358693686937869388693986940869418694286943869448694586946869478694886949869508695186952869538695486955869568695786958869598696086961869628696386964869658696686967869688696986970869718697286973869748697586976869778697886979869808698186982869838698486985869868698786988869898699086991869928699386994869958699686997869988699987000870018700287003870048700587006870078700887009870108701187012870138701487015870168701787018870198702087021870228702387024870258702687027870288702987030870318703287033870348703587036870378703887039870408704187042870438704487045870468704787048870498705087051870528705387054870558705687057870588705987060870618706287063870648706587066870678706887069870708707187072870738707487075870768707787078870798708087081870828708387084870858708687087870888708987090870918709287093870948709587096870978709887099871008710187102871038710487105871068710787108871098711087111871128711387114871158711687117871188711987120871218712287123871248712587126871278712887129871308713187132871338713487135871368713787138871398714087141871428714387144871458714687147871488714987150871518715287153871548715587156871578715887159871608716187162871638716487165871668716787168871698717087171871728717387174871758717687177871788717987180871818718287183871848718587186871878718887189871908719187192871938719487195871968719787198871998720087201872028720387204872058720687207872088720987210872118721287213872148721587216872178721887219872208722187222872238722487225872268722787228872298723087231872328723387234872358723687237872388723987240872418724287243872448724587246872478724887249872508725187252872538725487255872568725787258872598726087261872628726387264872658726687267872688726987270872718727287273872748727587276872778727887279872808728187282872838728487285872868728787288872898729087291872928729387294872958729687297872988729987300873018730287303873048730587306873078730887309873108731187312873138731487315873168731787318873198732087321873228732387324873258732687327873288732987330873318733287333873348733587336873378733887339873408734187342873438734487345873468734787348873498735087351873528735387354873558735687357873588735987360873618736287363873648736587366873678736887369873708737187372873738737487375873768737787378873798738087381873828738387384873858738687387873888738987390873918739287393873948739587396873978739887399874008740187402874038740487405874068740787408874098741087411874128741387414874158741687417874188741987420874218742287423874248742587426874278742887429874308743187432874338743487435874368743787438874398744087441874428744387444874458744687447874488744987450874518745287453874548745587456874578745887459874608746187462874638746487465874668746787468874698747087471874728747387474874758747687477874788747987480874818748287483874848748587486874878748887489874908749187492874938749487495874968749787498874998750087501875028750387504875058750687507875088750987510875118751287513875148751587516875178751887519875208752187522875238752487525875268752787528875298753087531875328753387534875358753687537875388753987540875418754287543875448754587546875478754887549875508755187552875538755487555875568755787558875598756087561875628756387564875658756687567875688756987570875718757287573875748757587576875778757887579875808758187582875838758487585875868758787588875898759087591875928759387594875958759687597875988759987600876018760287603876048760587606876078760887609876108761187612876138761487615876168761787618876198762087621876228762387624876258762687627876288762987630876318763287633876348763587636876378763887639876408764187642876438764487645876468764787648876498765087651876528765387654876558765687657876588765987660876618766287663876648766587666876678766887669876708767187672876738767487675876768767787678876798768087681876828768387684876858768687687876888768987690876918769287693876948769587696876978769887699877008770187702877038770487705877068770787708877098771087711877128771387714877158771687717877188771987720877218772287723877248772587726877278772887729877308773187732877338773487735877368773787738877398774087741877428774387744877458774687747877488774987750877518775287753877548775587756877578775887759877608776187762877638776487765877668776787768877698777087771877728777387774877758777687777877788777987780877818778287783877848778587786877878778887789877908779187792877938779487795877968779787798877998780087801878028780387804878058780687807878088780987810878118781287813878148781587816878178781887819878208782187822878238782487825878268782787828878298783087831878328783387834878358783687837878388783987840878418784287843878448784587846878478784887849878508785187852878538785487855878568785787858878598786087861878628786387864878658786687867878688786987870878718787287873878748787587876878778787887879878808788187882878838788487885878868788787888878898789087891878928789387894878958789687897878988789987900879018790287903879048790587906879078790887909879108791187912879138791487915879168791787918879198792087921879228792387924879258792687927879288792987930879318793287933879348793587936879378793887939879408794187942879438794487945879468794787948879498795087951879528795387954879558795687957879588795987960879618796287963879648796587966879678796887969879708797187972879738797487975879768797787978879798798087981879828798387984879858798687987879888798987990879918799287993879948799587996879978799887999880008800188002880038800488005880068800788008880098801088011880128801388014880158801688017880188801988020880218802288023880248802588026880278802888029880308803188032880338803488035880368803788038880398804088041880428804388044880458804688047880488804988050880518805288053880548805588056880578805888059880608806188062880638806488065880668806788068880698807088071880728807388074880758807688077880788807988080880818808288083880848808588086880878808888089880908809188092880938809488095880968809788098880998810088101881028810388104881058810688107881088810988110881118811288113881148811588116881178811888119881208812188122881238812488125881268812788128881298813088131881328813388134881358813688137881388813988140881418814288143881448814588146881478814888149881508815188152881538815488155881568815788158881598816088161881628816388164881658816688167881688816988170881718817288173881748817588176881778817888179881808818188182881838818488185881868818788188881898819088191881928819388194881958819688197881988819988200882018820288203882048820588206882078820888209882108821188212882138821488215882168821788218882198822088221882228822388224882258822688227882288822988230882318823288233882348823588236882378823888239882408824188242882438824488245882468824788248882498825088251882528825388254882558825688257882588825988260882618826288263882648826588266882678826888269882708827188272882738827488275882768827788278882798828088281882828828388284882858828688287882888828988290882918829288293882948829588296882978829888299883008830188302883038830488305883068830788308883098831088311883128831388314883158831688317883188831988320883218832288323883248832588326883278832888329883308833188332883338833488335883368833788338883398834088341883428834388344883458834688347883488834988350883518835288353883548835588356883578835888359883608836188362883638836488365883668836788368883698837088371883728837388374883758837688377883788837988380883818838288383883848838588386883878838888389883908839188392883938839488395883968839788398883998840088401884028840388404884058840688407884088840988410884118841288413884148841588416884178841888419884208842188422884238842488425884268842788428884298843088431884328843388434884358843688437884388843988440884418844288443884448844588446884478844888449884508845188452884538845488455884568845788458884598846088461884628846388464884658846688467884688846988470884718847288473884748847588476884778847888479884808848188482884838848488485884868848788488884898849088491884928849388494884958849688497884988849988500885018850288503885048850588506885078850888509885108851188512885138851488515885168851788518885198852088521885228852388524885258852688527885288852988530885318853288533885348853588536885378853888539885408854188542885438854488545885468854788548885498855088551885528855388554885558855688557885588855988560885618856288563885648856588566885678856888569885708857188572885738857488575885768857788578885798858088581885828858388584885858858688587885888858988590885918859288593885948859588596885978859888599886008860188602886038860488605886068860788608886098861088611886128861388614886158861688617886188861988620886218862288623886248862588626886278862888629886308863188632886338863488635886368863788638886398864088641886428864388644886458864688647886488864988650886518865288653886548865588656886578865888659886608866188662886638866488665886668866788668886698867088671886728867388674886758867688677886788867988680886818868288683886848868588686886878868888689886908869188692886938869488695886968869788698886998870088701887028870388704887058870688707887088870988710887118871288713887148871588716887178871888719887208872188722887238872488725887268872788728887298873088731887328873388734887358873688737887388873988740887418874288743887448874588746887478874888749887508875188752887538875488755887568875788758887598876088761887628876388764887658876688767887688876988770887718877288773887748877588776887778877888779887808878188782887838878488785887868878788788887898879088791887928879388794887958879688797887988879988800888018880288803888048880588806888078880888809888108881188812888138881488815888168881788818888198882088821888228882388824888258882688827888288882988830888318883288833888348883588836888378883888839888408884188842888438884488845888468884788848888498885088851888528885388854888558885688857888588885988860888618886288863888648886588866888678886888869888708887188872888738887488875888768887788878888798888088881888828888388884888858888688887888888888988890888918889288893888948889588896888978889888899889008890188902889038890488905889068890788908889098891088911889128891388914889158891688917889188891988920889218892288923889248892588926889278892888929889308893188932889338893488935889368893788938889398894088941889428894388944889458894688947889488894988950889518895288953889548895588956889578895888959889608896188962889638896488965889668896788968889698897088971889728897388974889758897688977889788897988980889818898288983889848898588986889878898888989889908899188992889938899488995889968899788998889998900089001890028900389004890058900689007890088900989010890118901289013890148901589016890178901889019890208902189022890238902489025890268902789028890298903089031890328903389034890358903689037890388903989040890418904289043890448904589046890478904889049890508905189052890538905489055890568905789058890598906089061890628906389064890658906689067890688906989070890718907289073890748907589076890778907889079890808908189082890838908489085890868908789088890898909089091890928909389094890958909689097890988909989100891018910289103891048910589106891078910889109891108911189112891138911489115891168911789118891198912089121891228912389124891258912689127891288912989130891318913289133891348913589136891378913889139891408914189142891438914489145891468914789148891498915089151891528915389154891558915689157891588915989160891618916289163891648916589166891678916889169891708917189172891738917489175891768917789178891798918089181891828918389184891858918689187891888918989190891918919289193891948919589196891978919889199892008920189202892038920489205892068920789208892098921089211892128921389214892158921689217892188921989220892218922289223892248922589226892278922889229892308923189232892338923489235892368923789238892398924089241892428924389244892458924689247892488924989250892518925289253892548925589256892578925889259892608926189262892638926489265892668926789268892698927089271892728927389274892758927689277892788927989280892818928289283892848928589286892878928889289892908929189292892938929489295892968929789298892998930089301893028930389304893058930689307893088930989310893118931289313893148931589316893178931889319893208932189322893238932489325893268932789328893298933089331893328933389334893358933689337893388933989340893418934289343893448934589346893478934889349893508935189352893538935489355893568935789358893598936089361893628936389364893658936689367893688936989370893718937289373893748937589376893778937889379893808938189382893838938489385893868938789388893898939089391893928939389394893958939689397893988939989400894018940289403894048940589406894078940889409894108941189412894138941489415894168941789418894198942089421894228942389424894258942689427894288942989430894318943289433894348943589436894378943889439894408944189442894438944489445894468944789448894498945089451894528945389454894558945689457894588945989460894618946289463894648946589466894678946889469894708947189472894738947489475894768947789478894798948089481894828948389484894858948689487894888948989490894918949289493894948949589496894978949889499895008950189502895038950489505895068950789508895098951089511895128951389514895158951689517895188951989520895218952289523895248952589526895278952889529895308953189532895338953489535895368953789538895398954089541895428954389544895458954689547895488954989550895518955289553895548955589556895578955889559895608956189562895638956489565895668956789568895698957089571895728957389574895758957689577895788957989580895818958289583895848958589586895878958889589895908959189592895938959489595895968959789598895998960089601896028960389604896058960689607896088960989610896118961289613896148961589616896178961889619896208962189622896238962489625896268962789628896298963089631896328963389634896358963689637896388963989640896418964289643896448964589646896478964889649896508965189652896538965489655896568965789658896598966089661896628966389664896658966689667896688966989670896718967289673896748967589676896778967889679896808968189682896838968489685896868968789688896898969089691896928969389694896958969689697896988969989700897018970289703897048970589706897078970889709897108971189712897138971489715897168971789718897198972089721897228972389724897258972689727897288972989730897318973289733897348973589736897378973889739897408974189742897438974489745897468974789748897498975089751897528975389754897558975689757897588975989760897618976289763897648976589766897678976889769897708977189772897738977489775897768977789778897798978089781897828978389784897858978689787897888978989790897918979289793897948979589796897978979889799898008980189802898038980489805898068980789808898098981089811898128981389814898158981689817898188981989820898218982289823898248982589826898278982889829898308983189832898338983489835898368983789838898398984089841898428984389844898458984689847898488984989850898518985289853898548985589856898578985889859898608986189862898638986489865898668986789868898698987089871898728987389874898758987689877898788987989880898818988289883898848988589886898878988889889898908989189892898938989489895898968989789898898998990089901899028990389904899058990689907899088990989910899118991289913899148991589916899178991889919899208992189922899238992489925899268992789928899298993089931899328993389934899358993689937899388993989940899418994289943899448994589946899478994889949899508995189952899538995489955899568995789958899598996089961899628996389964899658996689967899688996989970899718997289973899748997589976899778997889979899808998189982899838998489985899868998789988899898999089991899928999389994899958999689997899988999990000900019000290003900049000590006900079000890009900109001190012900139001490015900169001790018900199002090021900229002390024900259002690027900289002990030900319003290033900349003590036900379003890039900409004190042900439004490045900469004790048900499005090051900529005390054900559005690057900589005990060900619006290063900649006590066900679006890069900709007190072900739007490075900769007790078900799008090081900829008390084900859008690087900889008990090900919009290093900949009590096900979009890099901009010190102901039010490105901069010790108901099011090111901129011390114901159011690117901189011990120901219012290123901249012590126901279012890129901309013190132901339013490135901369013790138901399014090141901429014390144901459014690147901489014990150901519015290153901549015590156901579015890159901609016190162901639016490165901669016790168901699017090171901729017390174901759017690177901789017990180901819018290183901849018590186901879018890189901909019190192901939019490195901969019790198901999020090201902029020390204902059020690207902089020990210902119021290213902149021590216902179021890219902209022190222902239022490225902269022790228902299023090231902329023390234902359023690237902389023990240902419024290243902449024590246902479024890249902509025190252902539025490255902569025790258902599026090261902629026390264902659026690267902689026990270902719027290273902749027590276902779027890279902809028190282902839028490285902869028790288902899029090291902929029390294902959029690297902989029990300903019030290303903049030590306903079030890309903109031190312903139031490315903169031790318903199032090321903229032390324903259032690327903289032990330903319033290333903349033590336903379033890339903409034190342903439034490345903469034790348903499035090351903529035390354903559035690357903589035990360903619036290363903649036590366903679036890369903709037190372903739037490375903769037790378903799038090381903829038390384903859038690387903889038990390903919039290393903949039590396903979039890399904009040190402904039040490405904069040790408904099041090411904129041390414904159041690417904189041990420904219042290423904249042590426904279042890429904309043190432904339043490435904369043790438904399044090441904429044390444904459044690447904489044990450904519045290453904549045590456904579045890459904609046190462904639046490465904669046790468904699047090471904729047390474904759047690477904789047990480904819048290483904849048590486904879048890489904909049190492904939049490495904969049790498904999050090501905029050390504905059050690507905089050990510905119051290513905149051590516905179051890519905209052190522905239052490525905269052790528905299053090531905329053390534905359053690537905389053990540905419054290543905449054590546905479054890549905509055190552905539055490555905569055790558905599056090561905629056390564905659056690567905689056990570905719057290573905749057590576905779057890579905809058190582905839058490585905869058790588905899059090591905929059390594905959059690597905989059990600906019060290603906049060590606906079060890609906109061190612906139061490615906169061790618906199062090621906229062390624906259062690627906289062990630906319063290633906349063590636906379063890639906409064190642906439064490645906469064790648906499065090651906529065390654906559065690657906589065990660906619066290663906649066590666906679066890669906709067190672906739067490675906769067790678906799068090681906829068390684906859068690687906889068990690906919069290693906949069590696906979069890699907009070190702907039070490705907069070790708907099071090711907129071390714907159071690717907189071990720907219072290723907249072590726907279072890729907309073190732907339073490735907369073790738907399074090741907429074390744907459074690747907489074990750907519075290753907549075590756907579075890759907609076190762907639076490765907669076790768907699077090771907729077390774907759077690777907789077990780907819078290783907849078590786907879078890789907909079190792907939079490795907969079790798907999080090801908029080390804908059080690807908089080990810908119081290813908149081590816908179081890819908209082190822908239082490825908269082790828908299083090831908329083390834908359083690837908389083990840908419084290843908449084590846908479084890849908509085190852908539085490855908569085790858908599086090861908629086390864908659086690867908689086990870908719087290873908749087590876908779087890879908809088190882908839088490885908869088790888908899089090891908929089390894908959089690897908989089990900909019090290903909049090590906909079090890909909109091190912909139091490915909169091790918909199092090921909229092390924909259092690927909289092990930909319093290933909349093590936909379093890939909409094190942909439094490945909469094790948909499095090951909529095390954909559095690957909589095990960909619096290963909649096590966909679096890969909709097190972909739097490975909769097790978909799098090981909829098390984909859098690987909889098990990909919099290993909949099590996909979099890999910009100191002910039100491005910069100791008910099101091011910129101391014910159101691017910189101991020910219102291023910249102591026910279102891029910309103191032910339103491035910369103791038910399104091041910429104391044910459104691047910489104991050910519105291053910549105591056910579105891059910609106191062910639106491065910669106791068910699107091071910729107391074910759107691077910789107991080910819108291083910849108591086910879108891089910909109191092910939109491095910969109791098910999110091101911029110391104911059110691107911089110991110911119111291113911149111591116911179111891119911209112191122911239112491125911269112791128911299113091131911329113391134911359113691137911389113991140911419114291143911449114591146911479114891149911509115191152911539115491155911569115791158911599116091161911629116391164911659116691167911689116991170911719117291173911749117591176911779117891179911809118191182911839118491185911869118791188911899119091191911929119391194911959119691197911989119991200912019120291203912049120591206912079120891209912109121191212912139121491215912169121791218912199122091221912229122391224912259122691227912289122991230912319123291233912349123591236912379123891239912409124191242912439124491245912469124791248912499125091251912529125391254912559125691257912589125991260912619126291263912649126591266912679126891269912709127191272912739127491275912769127791278912799128091281912829128391284912859128691287912889128991290912919129291293912949129591296912979129891299913009130191302913039130491305913069130791308913099131091311913129131391314913159131691317913189131991320913219132291323913249132591326913279132891329913309133191332913339133491335913369133791338913399134091341913429134391344913459134691347913489134991350913519135291353913549135591356913579135891359913609136191362913639136491365913669136791368913699137091371913729137391374913759137691377913789137991380913819138291383913849138591386913879138891389913909139191392913939139491395913969139791398913999140091401914029140391404914059140691407914089140991410914119141291413914149141591416914179141891419914209142191422914239142491425914269142791428914299143091431914329143391434914359143691437914389143991440914419144291443914449144591446914479144891449914509145191452914539145491455914569145791458914599146091461914629146391464914659146691467914689146991470914719147291473914749147591476914779147891479914809148191482914839148491485914869148791488914899149091491914929149391494914959149691497914989149991500915019150291503915049150591506915079150891509915109151191512915139151491515915169151791518915199152091521915229152391524915259152691527915289152991530915319153291533915349153591536915379153891539915409154191542915439154491545915469154791548915499155091551915529155391554915559155691557915589155991560915619156291563915649156591566915679156891569915709157191572915739157491575915769157791578915799158091581915829158391584915859158691587915889158991590915919159291593915949159591596915979159891599916009160191602916039160491605916069160791608916099161091611916129161391614916159161691617916189161991620916219162291623916249162591626916279162891629916309163191632916339163491635916369163791638916399164091641916429164391644916459164691647916489164991650916519165291653916549165591656916579165891659916609166191662916639166491665916669166791668916699167091671916729167391674916759167691677916789167991680916819168291683916849168591686916879168891689916909169191692916939169491695916969169791698916999170091701917029170391704917059170691707917089170991710917119171291713917149171591716917179171891719917209172191722917239172491725917269172791728917299173091731917329173391734917359173691737917389173991740917419174291743917449174591746917479174891749917509175191752917539175491755917569175791758917599176091761917629176391764917659176691767917689176991770917719177291773917749177591776917779177891779917809178191782917839178491785917869178791788917899179091791917929179391794917959179691797917989179991800918019180291803918049180591806918079180891809918109181191812918139181491815918169181791818918199182091821918229182391824918259182691827918289182991830918319183291833918349183591836918379183891839918409184191842918439184491845918469184791848918499185091851918529185391854918559185691857918589185991860918619186291863918649186591866918679186891869918709187191872918739187491875918769187791878918799188091881918829188391884918859188691887918889188991890918919189291893918949189591896918979189891899919009190191902919039190491905919069190791908919099191091911919129191391914919159191691917919189191991920919219192291923919249192591926919279192891929919309193191932919339193491935919369193791938919399194091941919429194391944919459194691947919489194991950919519195291953919549195591956919579195891959919609196191962919639196491965919669196791968919699197091971919729197391974919759197691977919789197991980919819198291983919849198591986919879198891989919909199191992919939199491995919969199791998919999200092001920029200392004920059200692007920089200992010920119201292013920149201592016920179201892019920209202192022920239202492025920269202792028920299203092031920329203392034920359203692037920389203992040920419204292043920449204592046920479204892049920509205192052920539205492055920569205792058920599206092061920629206392064920659206692067920689206992070920719207292073920749207592076920779207892079920809208192082920839208492085920869208792088920899209092091920929209392094920959209692097920989209992100921019210292103921049210592106921079210892109921109211192112921139211492115921169211792118921199212092121921229212392124921259212692127921289212992130921319213292133921349213592136921379213892139921409214192142921439214492145921469214792148921499215092151921529215392154921559215692157921589215992160921619216292163921649216592166921679216892169921709217192172921739217492175921769217792178921799218092181921829218392184921859218692187921889218992190921919219292193921949219592196921979219892199922009220192202922039220492205922069220792208922099221092211922129221392214922159221692217922189221992220922219222292223922249222592226922279222892229922309223192232922339223492235922369223792238922399224092241922429224392244922459224692247922489224992250922519225292253922549225592256922579225892259922609226192262922639226492265922669226792268922699227092271922729227392274922759227692277922789227992280922819228292283922849228592286922879228892289922909229192292922939229492295922969229792298922999230092301923029230392304923059230692307923089230992310923119231292313923149231592316923179231892319923209232192322923239232492325923269232792328923299233092331923329233392334923359233692337923389233992340923419234292343923449234592346923479234892349923509235192352923539235492355923569235792358923599236092361923629236392364923659236692367923689236992370923719237292373923749237592376923779237892379923809238192382923839238492385923869238792388923899239092391923929239392394923959239692397923989239992400924019240292403924049240592406924079240892409924109241192412924139241492415924169241792418924199242092421924229242392424924259242692427924289242992430924319243292433924349243592436924379243892439924409244192442924439244492445924469244792448924499245092451924529245392454924559245692457924589245992460924619246292463924649246592466924679246892469924709247192472924739247492475924769247792478924799248092481924829248392484924859248692487924889248992490924919249292493924949249592496924979249892499925009250192502925039250492505925069250792508925099251092511925129251392514925159251692517925189251992520925219252292523925249252592526925279252892529925309253192532925339253492535925369253792538925399254092541925429254392544925459254692547925489254992550925519255292553925549255592556925579255892559925609256192562925639256492565925669256792568925699257092571925729257392574925759257692577925789257992580925819258292583925849258592586925879258892589925909259192592925939259492595925969259792598925999260092601926029260392604926059260692607926089260992610926119261292613926149261592616926179261892619926209262192622926239262492625926269262792628926299263092631926329263392634926359263692637926389263992640926419264292643926449264592646926479264892649926509265192652926539265492655926569265792658926599266092661926629266392664926659266692667926689266992670926719267292673926749267592676926779267892679926809268192682926839268492685926869268792688926899269092691926929269392694926959269692697926989269992700927019270292703927049270592706927079270892709927109271192712927139271492715927169271792718927199272092721927229272392724927259272692727927289272992730927319273292733927349273592736927379273892739927409274192742927439274492745927469274792748927499275092751927529275392754927559275692757927589275992760927619276292763927649276592766927679276892769927709277192772927739277492775927769277792778927799278092781927829278392784927859278692787927889278992790927919279292793927949279592796927979279892799928009280192802928039280492805928069280792808928099281092811928129281392814928159281692817928189281992820928219282292823928249282592826928279282892829928309283192832928339283492835928369283792838928399284092841928429284392844928459284692847928489284992850928519285292853928549285592856928579285892859928609286192862928639286492865928669286792868928699287092871928729287392874928759287692877928789287992880928819288292883928849288592886928879288892889928909289192892928939289492895928969289792898928999290092901929029290392904929059290692907929089290992910929119291292913929149291592916929179291892919929209292192922929239292492925929269292792928929299293092931929329293392934929359293692937929389293992940929419294292943929449294592946929479294892949929509295192952929539295492955929569295792958929599296092961929629296392964929659296692967929689296992970929719297292973929749297592976929779297892979929809298192982929839298492985929869298792988929899299092991929929299392994929959299692997929989299993000930019300293003930049300593006930079300893009930109301193012930139301493015930169301793018930199302093021930229302393024930259302693027930289302993030930319303293033930349303593036930379303893039930409304193042930439304493045930469304793048930499305093051930529305393054930559305693057930589305993060930619306293063930649306593066930679306893069930709307193072930739307493075930769307793078930799308093081930829308393084930859308693087930889308993090930919309293093930949309593096930979309893099931009310193102931039310493105931069310793108931099311093111931129311393114931159311693117931189311993120931219312293123931249312593126931279312893129931309313193132931339313493135931369313793138931399314093141931429314393144931459314693147931489314993150931519315293153931549315593156931579315893159931609316193162931639316493165931669316793168931699317093171931729317393174931759317693177931789317993180931819318293183931849318593186931879318893189931909319193192931939319493195931969319793198931999320093201932029320393204932059320693207932089320993210932119321293213932149321593216932179321893219932209322193222932239322493225932269322793228932299323093231932329323393234932359323693237932389323993240932419324293243932449324593246932479324893249932509325193252932539325493255932569325793258932599326093261932629326393264932659326693267932689326993270932719327293273932749327593276932779327893279932809328193282932839328493285932869328793288932899329093291932929329393294932959329693297932989329993300933019330293303933049330593306933079330893309933109331193312933139331493315933169331793318933199332093321933229332393324933259332693327933289332993330933319333293333933349333593336933379333893339933409334193342933439334493345933469334793348933499335093351933529335393354933559335693357933589335993360933619336293363933649336593366933679336893369933709337193372933739337493375933769337793378933799338093381933829338393384933859338693387933889338993390933919339293393933949339593396933979339893399934009340193402934039340493405934069340793408934099341093411934129341393414934159341693417934189341993420934219342293423934249342593426934279342893429934309343193432934339343493435934369343793438934399344093441934429344393444934459344693447934489344993450934519345293453934549345593456934579345893459934609346193462934639346493465934669346793468934699347093471934729347393474934759347693477934789347993480934819348293483934849348593486934879348893489934909349193492934939349493495934969349793498934999350093501935029350393504935059350693507935089350993510935119351293513935149351593516935179351893519935209352193522935239352493525935269352793528935299353093531935329353393534935359353693537935389353993540935419354293543935449354593546935479354893549935509355193552935539355493555935569355793558935599356093561935629356393564935659356693567935689356993570935719357293573935749357593576935779357893579935809358193582935839358493585935869358793588935899359093591935929359393594935959359693597935989359993600936019360293603936049360593606936079360893609936109361193612936139361493615936169361793618936199362093621936229362393624936259362693627936289362993630936319363293633936349363593636936379363893639936409364193642936439364493645936469364793648936499365093651936529365393654936559365693657936589365993660936619366293663936649366593666936679366893669936709367193672936739367493675936769367793678936799368093681936829368393684936859368693687936889368993690936919369293693936949369593696936979369893699937009370193702937039370493705937069370793708937099371093711937129371393714937159371693717937189371993720937219372293723937249372593726937279372893729937309373193732937339373493735937369373793738937399374093741937429374393744937459374693747937489374993750937519375293753937549375593756937579375893759937609376193762937639376493765937669376793768937699377093771937729377393774937759377693777937789377993780937819378293783937849378593786937879378893789937909379193792937939379493795937969379793798937999380093801938029380393804938059380693807938089380993810938119381293813938149381593816938179381893819938209382193822938239382493825938269382793828938299383093831938329383393834938359383693837938389383993840938419384293843938449384593846938479384893849938509385193852938539385493855938569385793858938599386093861938629386393864938659386693867938689386993870938719387293873938749387593876938779387893879938809388193882938839388493885938869388793888938899389093891938929389393894938959389693897938989389993900939019390293903939049390593906939079390893909939109391193912939139391493915939169391793918939199392093921939229392393924939259392693927939289392993930939319393293933939349393593936939379393893939939409394193942939439394493945939469394793948939499395093951939529395393954939559395693957939589395993960939619396293963939649396593966939679396893969939709397193972939739397493975939769397793978939799398093981939829398393984939859398693987939889398993990939919399293993939949399593996939979399893999940009400194002940039400494005940069400794008940099401094011940129401394014940159401694017940189401994020940219402294023940249402594026940279402894029940309403194032940339403494035940369403794038940399404094041940429404394044940459404694047940489404994050940519405294053940549405594056940579405894059940609406194062940639406494065940669406794068940699407094071940729407394074940759407694077940789407994080940819408294083940849408594086940879408894089940909409194092940939409494095940969409794098940999410094101941029410394104941059410694107941089410994110941119411294113941149411594116941179411894119941209412194122941239412494125941269412794128941299413094131941329413394134941359413694137941389413994140941419414294143941449414594146941479414894149941509415194152941539415494155941569415794158941599416094161941629416394164941659416694167941689416994170941719417294173941749417594176941779417894179941809418194182941839418494185941869418794188941899419094191941929419394194941959419694197941989419994200942019420294203942049420594206942079420894209942109421194212942139421494215942169421794218942199422094221942229422394224942259422694227942289422994230942319423294233942349423594236942379423894239942409424194242942439424494245942469424794248942499425094251942529425394254942559425694257942589425994260942619426294263942649426594266942679426894269942709427194272942739427494275942769427794278942799428094281942829428394284942859428694287942889428994290942919429294293942949429594296942979429894299943009430194302943039430494305943069430794308943099431094311943129431394314943159431694317943189431994320943219432294323943249432594326943279432894329943309433194332943339433494335943369433794338943399434094341943429434394344943459434694347943489434994350943519435294353943549435594356943579435894359943609436194362943639436494365943669436794368943699437094371943729437394374943759437694377943789437994380943819438294383943849438594386943879438894389943909439194392943939439494395943969439794398943999440094401944029440394404944059440694407944089440994410944119441294413944149441594416944179441894419944209442194422944239442494425944269442794428944299443094431944329443394434944359443694437944389443994440944419444294443944449444594446944479444894449944509445194452944539445494455944569445794458944599446094461944629446394464944659446694467944689446994470944719447294473944749447594476944779447894479944809448194482944839448494485944869448794488944899449094491944929449394494944959449694497944989449994500945019450294503945049450594506945079450894509945109451194512945139451494515945169451794518945199452094521945229452394524945259452694527945289452994530945319453294533945349453594536945379453894539945409454194542945439454494545945469454794548945499455094551945529455394554945559455694557945589455994560945619456294563945649456594566945679456894569945709457194572945739457494575945769457794578945799458094581945829458394584945859458694587945889458994590945919459294593945949459594596945979459894599946009460194602946039460494605946069460794608946099461094611946129461394614946159461694617946189461994620946219462294623946249462594626946279462894629946309463194632946339463494635946369463794638946399464094641946429464394644946459464694647946489464994650946519465294653946549465594656946579465894659946609466194662946639466494665946669466794668946699467094671946729467394674946759467694677946789467994680946819468294683946849468594686946879468894689946909469194692946939469494695946969469794698946999470094701947029470394704947059470694707947089470994710947119471294713947149471594716947179471894719947209472194722947239472494725947269472794728947299473094731947329473394734947359473694737947389473994740947419474294743947449474594746947479474894749947509475194752947539475494755947569475794758947599476094761947629476394764947659476694767947689476994770947719477294773947749477594776947779477894779947809478194782947839478494785947869478794788947899479094791947929479394794947959479694797947989479994800948019480294803948049480594806948079480894809948109481194812948139481494815948169481794818948199482094821948229482394824948259482694827948289482994830948319483294833948349483594836948379483894839948409484194842948439484494845948469484794848948499485094851948529485394854948559485694857948589485994860948619486294863948649486594866948679486894869948709487194872948739487494875948769487794878948799488094881948829488394884948859488694887948889488994890948919489294893948949489594896948979489894899949009490194902949039490494905949069490794908949099491094911949129491394914949159491694917949189491994920949219492294923949249492594926949279492894929949309493194932949339493494935949369493794938949399494094941949429494394944949459494694947949489494994950949519495294953949549495594956949579495894959949609496194962949639496494965949669496794968949699497094971949729497394974949759497694977949789497994980949819498294983949849498594986949879498894989949909499194992949939499494995949969499794998949999500095001950029500395004950059500695007950089500995010950119501295013950149501595016950179501895019950209502195022950239502495025950269502795028950299503095031950329503395034950359503695037950389503995040950419504295043950449504595046950479504895049950509505195052950539505495055950569505795058950599506095061950629506395064950659506695067950689506995070950719507295073950749507595076950779507895079950809508195082950839508495085950869508795088950899509095091950929509395094950959509695097950989509995100951019510295103951049510595106951079510895109951109511195112951139511495115951169511795118951199512095121951229512395124951259512695127951289512995130951319513295133951349513595136951379513895139951409514195142951439514495145951469514795148951499515095151951529515395154951559515695157951589515995160951619516295163951649516595166951679516895169951709517195172951739517495175951769517795178951799518095181951829518395184951859518695187951889518995190951919519295193951949519595196951979519895199952009520195202952039520495205952069520795208952099521095211952129521395214952159521695217952189521995220952219522295223952249522595226952279522895229952309523195232952339523495235952369523795238952399524095241952429524395244952459524695247952489524995250952519525295253952549525595256952579525895259952609526195262952639526495265952669526795268952699527095271952729527395274952759527695277952789527995280952819528295283952849528595286952879528895289952909529195292952939529495295952969529795298952999530095301953029530395304953059530695307953089530995310953119531295313953149531595316953179531895319953209532195322953239532495325953269532795328953299533095331953329533395334953359533695337953389533995340953419534295343953449534595346953479534895349953509535195352953539535495355953569535795358953599536095361953629536395364953659536695367953689536995370953719537295373953749537595376953779537895379953809538195382953839538495385953869538795388953899539095391953929539395394953959539695397953989539995400954019540295403954049540595406954079540895409954109541195412954139541495415954169541795418954199542095421954229542395424954259542695427954289542995430954319543295433954349543595436954379543895439954409544195442954439544495445954469544795448954499545095451954529545395454954559545695457954589545995460954619546295463954649546595466954679546895469954709547195472954739547495475954769547795478954799548095481954829548395484954859548695487954889548995490954919549295493954949549595496954979549895499955009550195502955039550495505955069550795508955099551095511955129551395514955159551695517955189551995520955219552295523955249552595526955279552895529955309553195532955339553495535955369553795538955399554095541955429554395544955459554695547955489554995550955519555295553955549555595556955579555895559955609556195562955639556495565955669556795568955699557095571955729557395574955759557695577955789557995580955819558295583955849558595586955879558895589955909559195592955939559495595955969559795598955999560095601956029560395604956059560695607956089560995610956119561295613956149561595616956179561895619956209562195622956239562495625956269562795628956299563095631956329563395634956359563695637956389563995640956419564295643956449564595646956479564895649956509565195652956539565495655956569565795658956599566095661956629566395664956659566695667956689566995670956719567295673956749567595676956779567895679956809568195682956839568495685956869568795688956899569095691956929569395694956959569695697956989569995700957019570295703957049570595706957079570895709957109571195712957139571495715957169571795718957199572095721957229572395724957259572695727957289572995730957319573295733957349573595736957379573895739957409574195742957439574495745957469574795748957499575095751957529575395754957559575695757957589575995760957619576295763957649576595766957679576895769957709577195772957739577495775957769577795778957799578095781957829578395784957859578695787957889578995790957919579295793957949579595796957979579895799958009580195802958039580495805958069580795808958099581095811958129581395814958159581695817958189581995820958219582295823958249582595826958279582895829958309583195832958339583495835958369583795838958399584095841958429584395844958459584695847958489584995850958519585295853958549585595856958579585895859958609586195862958639586495865958669586795868958699587095871958729587395874958759587695877958789587995880958819588295883958849588595886958879588895889958909589195892958939589495895958969589795898958999590095901959029590395904959059590695907959089590995910959119591295913959149591595916959179591895919959209592195922959239592495925959269592795928959299593095931959329593395934959359593695937959389593995940959419594295943959449594595946959479594895949959509595195952959539595495955959569595795958959599596095961959629596395964959659596695967959689596995970959719597295973959749597595976959779597895979959809598195982959839598495985959869598795988959899599095991959929599395994959959599695997959989599996000960019600296003960049600596006960079600896009960109601196012960139601496015960169601796018960199602096021960229602396024960259602696027960289602996030960319603296033960349603596036960379603896039960409604196042960439604496045960469604796048960499605096051960529605396054960559605696057960589605996060960619606296063960649606596066960679606896069960709607196072960739607496075960769607796078960799608096081960829608396084960859608696087960889608996090960919609296093960949609596096960979609896099961009610196102961039610496105961069610796108961099611096111961129611396114961159611696117961189611996120961219612296123961249612596126961279612896129961309613196132961339613496135961369613796138961399614096141961429614396144961459614696147961489614996150961519615296153961549615596156961579615896159961609616196162961639616496165961669616796168961699617096171961729617396174961759617696177961789617996180961819618296183961849618596186961879618896189961909619196192961939619496195961969619796198961999620096201962029620396204962059620696207962089620996210962119621296213962149621596216962179621896219962209622196222962239622496225962269622796228962299623096231962329623396234962359623696237962389623996240962419624296243962449624596246962479624896249962509625196252962539625496255962569625796258962599626096261962629626396264962659626696267962689626996270962719627296273962749627596276962779627896279962809628196282962839628496285962869628796288962899629096291962929629396294962959629696297962989629996300963019630296303963049630596306963079630896309963109631196312963139631496315963169631796318963199632096321963229632396324963259632696327963289632996330963319633296333963349633596336963379633896339963409634196342963439634496345963469634796348963499635096351963529635396354963559635696357963589635996360963619636296363963649636596366963679636896369963709637196372963739637496375963769637796378963799638096381963829638396384963859638696387963889638996390963919639296393963949639596396963979639896399964009640196402964039640496405964069640796408964099641096411964129641396414964159641696417964189641996420964219642296423964249642596426964279642896429964309643196432964339643496435964369643796438964399644096441964429644396444964459644696447964489644996450964519645296453964549645596456964579645896459964609646196462964639646496465964669646796468964699647096471964729647396474964759647696477964789647996480964819648296483964849648596486964879648896489964909649196492964939649496495964969649796498964999650096501965029650396504965059650696507965089650996510965119651296513965149651596516965179651896519965209652196522965239652496525965269652796528965299653096531965329653396534965359653696537965389653996540965419654296543965449654596546965479654896549965509655196552965539655496555965569655796558965599656096561965629656396564965659656696567965689656996570965719657296573965749657596576965779657896579965809658196582965839658496585965869658796588965899659096591965929659396594965959659696597965989659996600966019660296603966049660596606966079660896609966109661196612966139661496615966169661796618966199662096621966229662396624966259662696627966289662996630966319663296633966349663596636966379663896639966409664196642966439664496645966469664796648966499665096651966529665396654966559665696657966589665996660966619666296663966649666596666966679666896669966709667196672966739667496675966769667796678966799668096681966829668396684966859668696687966889668996690966919669296693966949669596696966979669896699967009670196702967039670496705967069670796708967099671096711967129671396714967159671696717967189671996720967219672296723967249672596726967279672896729967309673196732967339673496735967369673796738967399674096741967429674396744967459674696747967489674996750967519675296753967549675596756967579675896759967609676196762967639676496765967669676796768967699677096771967729677396774967759677696777967789677996780967819678296783967849678596786967879678896789967909679196792967939679496795967969679796798967999680096801968029680396804968059680696807968089680996810968119681296813968149681596816968179681896819968209682196822968239682496825968269682796828968299683096831968329683396834968359683696837968389683996840968419684296843968449684596846968479684896849968509685196852968539685496855968569685796858968599686096861968629686396864968659686696867968689686996870968719687296873968749687596876968779687896879968809688196882968839688496885968869688796888968899689096891968929689396894968959689696897968989689996900969019690296903969049690596906969079690896909969109691196912969139691496915969169691796918969199692096921969229692396924969259692696927969289692996930969319693296933969349693596936969379693896939969409694196942969439694496945969469694796948969499695096951969529695396954969559695696957969589695996960969619696296963969649696596966969679696896969969709697196972969739697496975969769697796978969799698096981969829698396984969859698696987969889698996990969919699296993969949699596996969979699896999970009700197002970039700497005970069700797008970099701097011970129701397014970159701697017970189701997020970219702297023970249702597026970279702897029970309703197032970339703497035970369703797038970399704097041970429704397044970459704697047970489704997050970519705297053970549705597056970579705897059970609706197062970639706497065970669706797068970699707097071970729707397074970759707697077970789707997080970819708297083970849708597086970879708897089970909709197092970939709497095970969709797098970999710097101971029710397104971059710697107971089710997110971119711297113971149711597116971179711897119971209712197122971239712497125971269712797128971299713097131971329713397134971359713697137971389713997140971419714297143971449714597146971479714897149971509715197152971539715497155971569715797158971599716097161971629716397164971659716697167971689716997170971719717297173971749717597176971779717897179971809718197182971839718497185971869718797188971899719097191971929719397194971959719697197971989719997200972019720297203972049720597206972079720897209972109721197212972139721497215972169721797218972199722097221972229722397224972259722697227972289722997230972319723297233972349723597236972379723897239972409724197242972439724497245972469724797248972499725097251972529725397254972559725697257972589725997260972619726297263972649726597266972679726897269972709727197272972739727497275972769727797278972799728097281972829728397284972859728697287972889728997290972919729297293972949729597296972979729897299973009730197302973039730497305973069730797308973099731097311973129731397314973159731697317973189731997320973219732297323973249732597326973279732897329973309733197332973339733497335973369733797338973399734097341973429734397344973459734697347973489734997350973519735297353973549735597356973579735897359973609736197362973639736497365973669736797368973699737097371973729737397374973759737697377973789737997380973819738297383973849738597386973879738897389973909739197392973939739497395973969739797398973999740097401974029740397404974059740697407974089740997410974119741297413974149741597416974179741897419974209742197422974239742497425974269742797428974299743097431974329743397434974359743697437974389743997440974419744297443974449744597446974479744897449974509745197452974539745497455974569745797458974599746097461974629746397464974659746697467974689746997470974719747297473974749747597476974779747897479974809748197482974839748497485974869748797488974899749097491974929749397494974959749697497974989749997500975019750297503975049750597506975079750897509975109751197512975139751497515975169751797518975199752097521975229752397524975259752697527975289752997530975319753297533975349753597536975379753897539975409754197542975439754497545975469754797548975499755097551975529755397554975559755697557975589755997560975619756297563975649756597566975679756897569975709757197572975739757497575975769757797578975799758097581975829758397584975859758697587975889758997590975919759297593975949759597596975979759897599976009760197602976039760497605976069760797608976099761097611976129761397614976159761697617976189761997620976219762297623976249762597626976279762897629976309763197632976339763497635976369763797638976399764097641976429764397644976459764697647976489764997650976519765297653976549765597656976579765897659976609766197662976639766497665976669766797668976699767097671976729767397674976759767697677976789767997680976819768297683976849768597686976879768897689976909769197692976939769497695976969769797698976999770097701977029770397704977059770697707977089770997710977119771297713977149771597716977179771897719977209772197722977239772497725977269772797728977299773097731977329773397734977359773697737977389773997740977419774297743977449774597746977479774897749977509775197752977539775497755977569775797758977599776097761977629776397764977659776697767977689776997770977719777297773977749777597776977779777897779977809778197782977839778497785977869778797788977899779097791977929779397794977959779697797977989779997800978019780297803978049780597806978079780897809978109781197812978139781497815978169781797818978199782097821978229782397824978259782697827978289782997830978319783297833978349783597836978379783897839978409784197842978439784497845978469784797848978499785097851978529785397854978559785697857978589785997860978619786297863978649786597866978679786897869978709787197872978739787497875978769787797878978799788097881978829788397884978859788697887978889788997890978919789297893978949789597896978979789897899979009790197902979039790497905979069790797908979099791097911979129791397914979159791697917979189791997920979219792297923979249792597926979279792897929979309793197932979339793497935979369793797938979399794097941979429794397944979459794697947979489794997950979519795297953979549795597956979579795897959979609796197962979639796497965979669796797968979699797097971979729797397974979759797697977979789797997980979819798297983979849798597986979879798897989979909799197992979939799497995979969799797998979999800098001980029800398004980059800698007980089800998010980119801298013980149801598016980179801898019980209802198022980239802498025980269802798028980299803098031980329803398034980359803698037980389803998040980419804298043980449804598046980479804898049980509805198052980539805498055980569805798058980599806098061980629806398064980659806698067980689806998070980719807298073980749807598076980779807898079980809808198082980839808498085980869808798088980899809098091980929809398094980959809698097980989809998100981019810298103981049810598106981079810898109981109811198112981139811498115981169811798118981199812098121981229812398124981259812698127981289812998130981319813298133981349813598136981379813898139981409814198142981439814498145981469814798148981499815098151981529815398154981559815698157981589815998160981619816298163981649816598166981679816898169981709817198172981739817498175981769817798178981799818098181981829818398184981859818698187981889818998190981919819298193981949819598196981979819898199982009820198202982039820498205982069820798208982099821098211982129821398214982159821698217982189821998220982219822298223982249822598226982279822898229982309823198232982339823498235982369823798238982399824098241982429824398244982459824698247982489824998250982519825298253982549825598256982579825898259982609826198262982639826498265982669826798268982699827098271982729827398274982759827698277982789827998280982819828298283982849828598286982879828898289982909829198292982939829498295982969829798298982999830098301983029830398304983059830698307983089830998310983119831298313983149831598316983179831898319983209832198322983239832498325983269832798328983299833098331983329833398334983359833698337983389833998340983419834298343983449834598346983479834898349983509835198352983539835498355983569835798358983599836098361983629836398364983659836698367983689836998370983719837298373983749837598376983779837898379983809838198382983839838498385983869838798388983899839098391983929839398394983959839698397983989839998400984019840298403984049840598406984079840898409984109841198412984139841498415984169841798418984199842098421984229842398424984259842698427984289842998430984319843298433984349843598436984379843898439984409844198442984439844498445984469844798448984499845098451984529845398454984559845698457984589845998460984619846298463984649846598466984679846898469984709847198472984739847498475984769847798478984799848098481984829848398484984859848698487984889848998490984919849298493984949849598496984979849898499985009850198502985039850498505985069850798508985099851098511985129851398514985159851698517985189851998520985219852298523985249852598526985279852898529985309853198532985339853498535985369853798538985399854098541985429854398544985459854698547985489854998550985519855298553985549855598556985579855898559985609856198562985639856498565985669856798568985699857098571985729857398574985759857698577985789857998580985819858298583985849858598586985879858898589985909859198592985939859498595985969859798598985999860098601986029860398604986059860698607986089860998610986119861298613986149861598616986179861898619986209862198622986239862498625986269862798628986299863098631986329863398634986359863698637986389863998640986419864298643986449864598646986479864898649986509865198652986539865498655986569865798658986599866098661986629866398664986659866698667986689866998670986719867298673986749867598676986779867898679986809868198682986839868498685986869868798688986899869098691986929869398694986959869698697986989869998700987019870298703987049870598706987079870898709987109871198712987139871498715987169871798718987199872098721987229872398724987259872698727987289872998730987319873298733987349873598736987379873898739987409874198742987439874498745987469874798748987499875098751987529875398754987559875698757987589875998760987619876298763987649876598766987679876898769987709877198772987739877498775987769877798778987799878098781987829878398784987859878698787987889878998790987919879298793987949879598796987979879898799988009880198802988039880498805988069880798808988099881098811988129881398814988159881698817988189881998820988219882298823988249882598826988279882898829988309883198832988339883498835988369883798838988399884098841988429884398844988459884698847988489884998850988519885298853988549885598856988579885898859988609886198862988639886498865988669886798868988699887098871988729887398874988759887698877988789887998880988819888298883988849888598886988879888898889988909889198892988939889498895988969889798898988999890098901989029890398904989059890698907989089890998910989119891298913989149891598916989179891898919989209892198922989239892498925989269892798928989299893098931989329893398934989359893698937989389893998940989419894298943989449894598946989479894898949989509895198952989539895498955989569895798958989599896098961989629896398964989659896698967989689896998970989719897298973989749897598976989779897898979989809898198982989839898498985989869898798988989899899098991989929899398994989959899698997989989899999000990019900299003990049900599006990079900899009990109901199012990139901499015990169901799018990199902099021990229902399024990259902699027990289902999030990319903299033990349903599036990379903899039990409904199042990439904499045990469904799048990499905099051990529905399054990559905699057990589905999060990619906299063990649906599066990679906899069990709907199072990739907499075990769907799078990799908099081990829908399084990859908699087990889908999090990919909299093990949909599096990979909899099991009910199102991039910499105991069910799108991099911099111991129911399114991159911699117991189911999120991219912299123991249912599126991279912899129991309913199132991339913499135991369913799138991399914099141991429914399144991459914699147991489914999150991519915299153991549915599156991579915899159991609916199162991639916499165991669916799168991699917099171991729917399174991759917699177991789917999180991819918299183991849918599186991879918899189991909919199192991939919499195991969919799198991999920099201992029920399204992059920699207992089920999210992119921299213992149921599216992179921899219992209922199222992239922499225992269922799228992299923099231992329923399234992359923699237992389923999240992419924299243992449924599246992479924899249992509925199252992539925499255992569925799258992599926099261992629926399264992659926699267992689926999270992719927299273992749927599276992779927899279992809928199282992839928499285992869928799288992899929099291992929929399294992959929699297992989929999300993019930299303993049930599306993079930899309993109931199312993139931499315993169931799318993199932099321993229932399324993259932699327993289932999330993319933299333993349933599336993379933899339993409934199342993439934499345993469934799348993499935099351993529935399354993559935699357993589935999360993619936299363993649936599366993679936899369993709937199372993739937499375993769937799378993799938099381993829938399384993859938699387993889938999390993919939299393993949939599396993979939899399994009940199402994039940499405994069940799408994099941099411994129941399414994159941699417994189941999420994219942299423994249942599426994279942899429994309943199432994339943499435994369943799438994399944099441994429944399444994459944699447994489944999450994519945299453994549945599456994579945899459994609946199462994639946499465994669946799468994699947099471994729947399474994759947699477994789947999480994819948299483994849948599486994879948899489994909949199492994939949499495994969949799498994999950099501995029950399504995059950699507995089950999510995119951299513995149951599516995179951899519995209952199522995239952499525995269952799528995299953099531995329953399534995359953699537995389953999540995419954299543995449954599546995479954899549995509955199552995539955499555995569955799558995599956099561995629956399564995659956699567995689956999570995719957299573995749957599576995779957899579995809958199582995839958499585995869958799588995899959099591995929959399594995959959699597995989959999600996019960299603996049960599606996079960899609996109961199612996139961499615996169961799618996199962099621996229962399624996259962699627996289962999630996319963299633996349963599636996379963899639996409964199642996439964499645996469964799648996499965099651996529965399654996559965699657996589965999660996619966299663996649966599666996679966899669996709967199672996739967499675996769967799678996799968099681996829968399684996859968699687996889968999690996919969299693996949969599696996979969899699997009970199702997039970499705997069970799708997099971099711997129971399714997159971699717997189971999720997219972299723997249972599726997279972899729997309973199732997339973499735997369973799738997399974099741997429974399744997459974699747997489974999750997519975299753997549975599756997579975899759997609976199762997639976499765997669976799768997699977099771997729977399774997759977699777997789977999780997819978299783997849978599786997879978899789997909979199792997939979499795997969979799798997999980099801998029980399804998059980699807998089980999810998119981299813998149981599816998179981899819998209982199822998239982499825998269982799828998299983099831998329983399834998359983699837998389983999840998419984299843998449984599846998479984899849998509985199852998539985499855998569985799858998599986099861998629986399864998659986699867998689986999870998719987299873998749987599876998779987899879998809988199882998839988499885998869988799888998899989099891998929989399894998959989699897998989989999900999019990299903999049990599906999079990899909999109991199912999139991499915999169991799918999199992099921999229992399924999259992699927999289992999930999319993299933999349993599936999379993899939999409994199942999439994499945999469994799948999499995099951999529995399954999559995699957999589995999960999619996299963999649996599966999679996899969999709997199972999739997499975999769997799978999799998099981999829998399984999859998699987999889998999990999919999299993999949999599996999979999899999100000100001100002100003100004100005100006100007100008100009100010100011100012100013100014100015100016100017100018100019100020100021100022100023100024100025100026100027100028100029100030100031100032100033100034100035100036100037100038100039100040100041100042100043100044100045100046100047100048100049100050100051100052100053100054100055100056100057100058100059100060100061100062100063100064100065100066100067100068100069100070100071100072100073100074100075100076100077100078100079100080100081100082100083100084100085100086100087100088100089100090100091100092100093100094100095100096100097100098100099100100100101100102100103100104100105100106100107100108100109100110100111100112100113100114100115100116100117100118100119100120100121100122100123100124100125100126100127100128100129100130100131100132100133100134100135100136100137100138100139100140100141100142100143100144100145100146100147100148100149100150100151100152100153100154100155100156100157100158100159100160100161100162100163100164100165100166100167100168100169100170100171100172100173100174100175100176100177100178100179100180100181100182100183100184100185100186100187100188100189100190100191100192100193100194100195100196100197100198100199100200100201100202100203100204100205100206100207100208100209100210100211100212100213100214100215100216100217100218100219100220100221100222100223100224100225100226100227100228100229100230100231100232100233100234100235100236100237100238100239100240100241100242100243100244100245100246100247100248100249100250100251100252100253100254100255100256100257100258100259100260100261100262100263100264100265100266100267100268100269100270100271100272100273100274100275100276100277100278100279100280100281100282100283100284100285100286100287100288100289100290100291100292100293100294100295100296100297100298100299100300100301100302100303100304100305100306100307100308100309100310100311100312100313100314100315100316100317100318100319100320100321100322100323100324100325100326100327100328100329100330100331100332100333100334100335100336100337100338100339100340100341100342100343100344100345100346100347100348100349100350100351100352100353100354100355100356100357100358100359100360100361100362100363100364100365100366100367100368100369100370100371100372100373100374100375100376100377100378100379100380100381100382100383100384100385100386100387100388100389100390100391100392100393100394100395100396100397100398100399100400100401100402100403100404100405100406100407100408100409100410100411100412100413100414100415100416100417100418100419100420100421100422100423100424100425100426100427100428100429100430100431100432100433100434100435100436100437100438100439100440100441100442100443100444100445100446100447100448100449100450100451100452100453100454100455100456100457100458100459100460100461100462100463100464100465100466100467100468100469100470100471100472100473100474100475100476100477100478100479100480100481100482100483100484100485100486100487100488100489100490100491100492100493100494100495100496100497100498100499100500100501100502100503100504100505100506100507100508100509100510100511100512100513100514100515100516100517100518100519100520100521100522100523100524100525100526100527100528100529100530100531100532100533100534100535100536100537100538100539100540100541100542100543100544100545100546100547100548100549100550100551100552100553100554100555100556100557100558100559100560100561100562100563100564100565100566100567100568100569100570100571100572100573100574100575100576100577100578100579100580100581100582100583100584100585100586100587100588100589100590100591100592100593100594100595100596100597100598100599100600100601100602100603100604100605100606100607100608100609100610100611100612100613100614100615100616100617100618100619100620100621100622100623100624100625100626100627100628100629100630100631100632100633100634100635100636100637100638100639100640100641100642100643100644100645100646100647100648100649100650100651100652100653100654100655100656100657100658100659100660100661100662100663100664100665100666100667100668100669100670100671100672100673100674100675100676100677100678100679100680100681100682100683100684100685100686100687100688100689100690100691100692100693100694100695100696100697100698100699100700100701100702100703100704100705100706100707100708100709100710100711100712100713100714100715100716100717100718100719100720100721100722100723100724100725100726100727100728100729100730100731100732100733100734100735100736100737100738100739100740100741100742100743100744100745100746100747100748100749100750100751100752100753100754100755100756100757100758100759100760100761100762100763100764100765100766100767100768100769100770100771100772100773100774100775100776100777100778100779100780100781100782100783100784100785100786100787100788100789100790100791100792100793100794100795100796100797100798100799100800100801100802100803100804100805100806100807100808100809100810100811100812100813100814100815100816100817100818100819100820100821100822100823100824100825100826100827100828100829100830100831100832100833100834100835100836100837100838100839100840100841100842100843100844100845100846100847100848100849100850100851100852100853100854100855100856100857100858100859100860100861100862100863100864100865100866100867100868100869100870100871100872100873100874100875100876100877100878100879100880100881100882100883100884100885100886100887100888100889100890100891100892100893100894100895100896100897100898100899100900100901100902100903100904100905100906100907100908100909100910100911100912100913100914100915100916100917100918100919100920100921100922100923100924100925100926100927100928100929100930100931100932100933100934100935100936100937100938100939100940100941100942100943100944100945100946100947100948100949100950100951100952100953100954100955100956100957100958100959100960100961100962100963100964100965100966100967100968100969100970100971100972100973100974100975100976100977100978100979100980100981100982100983100984100985100986100987100988100989100990100991100992100993100994100995100996100997100998100999101000101001101002101003101004101005101006101007101008101009101010101011101012101013101014101015101016101017101018101019101020101021101022101023101024101025101026101027101028101029101030101031101032101033101034101035101036101037101038101039101040101041101042101043101044101045101046101047101048101049101050101051101052101053101054101055101056101057101058101059101060101061101062101063101064101065101066101067101068101069101070101071101072101073101074101075101076101077101078101079101080101081101082101083101084101085101086101087101088101089101090101091101092101093101094101095101096101097101098101099101100101101101102101103101104101105101106101107101108101109101110101111101112101113101114101115101116101117101118101119101120101121101122101123101124101125101126101127101128101129101130101131101132101133101134101135101136101137101138101139101140101141101142101143101144101145101146101147101148101149101150101151101152101153101154101155101156101157101158101159101160101161101162101163101164101165101166101167101168101169101170101171101172101173101174101175101176101177101178101179101180101181101182101183101184101185101186101187101188101189101190101191101192101193101194101195101196101197101198101199101200101201101202101203101204101205101206101207101208101209101210101211101212101213101214101215101216101217101218101219101220101221101222101223101224101225101226101227101228101229101230101231101232101233101234101235101236101237101238101239101240101241101242101243101244101245101246101247101248101249101250101251101252101253101254101255101256101257101258101259101260101261101262101263101264101265101266101267101268101269101270101271101272101273101274101275101276101277101278101279101280101281101282101283101284101285101286101287101288101289101290101291101292101293101294101295101296101297101298101299101300101301101302101303101304101305101306101307101308101309101310101311101312101313101314101315101316101317101318101319101320101321101322101323101324101325101326101327101328101329101330101331101332101333101334101335101336101337101338101339101340101341101342101343101344101345101346101347101348101349101350101351101352101353101354101355101356101357101358101359101360101361101362101363101364101365101366101367101368101369101370101371101372101373101374101375101376101377101378101379101380101381101382101383101384101385101386101387101388101389101390101391101392101393101394101395101396101397101398101399101400101401101402101403101404101405101406101407101408101409101410101411101412101413101414101415101416101417101418101419101420101421101422101423101424101425101426101427101428101429101430101431101432101433101434101435101436101437101438101439101440101441101442101443101444101445101446101447101448101449101450101451101452101453101454101455101456101457101458101459101460101461101462101463101464101465101466101467101468101469101470101471101472101473101474101475101476101477101478101479101480101481101482101483101484101485101486101487101488101489101490101491101492101493101494101495101496101497101498101499101500101501101502101503101504101505101506101507101508101509101510101511101512101513101514101515101516101517101518101519101520101521101522101523101524101525101526101527101528101529101530101531101532101533101534101535101536101537101538101539101540101541101542101543101544101545101546101547101548101549101550101551101552101553101554101555101556101557101558101559101560101561101562101563101564101565101566101567101568101569101570101571101572101573101574101575101576101577101578101579101580101581101582101583101584101585101586101587101588101589101590101591101592101593101594101595101596101597101598101599101600101601101602101603101604101605101606101607101608101609101610101611101612101613101614101615101616101617101618101619101620101621101622101623101624101625101626101627101628101629101630101631101632101633101634101635101636101637101638101639101640101641101642101643101644101645101646101647101648101649101650101651101652101653101654101655101656101657101658101659101660101661101662101663101664101665101666101667101668101669101670101671101672101673101674101675101676101677101678101679101680101681101682101683101684101685101686101687101688101689101690101691101692101693101694101695101696101697101698101699101700101701101702101703101704101705101706101707101708101709101710101711101712101713101714101715101716101717101718101719101720101721101722101723101724101725101726101727101728101729101730101731101732101733101734101735101736101737101738101739101740101741101742101743101744101745101746101747101748101749101750101751101752101753101754101755101756101757101758101759101760101761101762101763101764101765101766101767101768101769101770101771101772101773101774101775101776101777101778101779101780101781101782101783101784101785101786101787101788101789101790101791101792101793101794101795101796101797101798101799101800101801101802101803101804101805101806101807101808101809101810101811101812101813101814101815101816101817101818101819101820101821101822101823101824101825101826101827101828101829101830101831101832101833101834101835101836101837101838101839101840101841101842101843101844101845101846101847101848101849101850101851101852101853101854101855101856101857101858101859101860101861101862101863101864101865101866101867101868101869101870101871101872101873101874101875101876101877101878101879101880101881101882101883101884101885101886101887101888101889101890101891101892101893101894101895101896101897101898101899101900101901101902101903101904101905101906101907101908101909101910101911101912101913101914101915101916101917101918101919101920101921101922101923101924101925101926101927101928101929101930101931101932101933101934101935101936101937101938101939101940101941101942101943101944101945101946101947101948101949101950101951101952101953101954101955101956101957101958101959101960101961101962101963101964101965101966101967101968101969101970101971101972101973101974101975101976101977101978101979101980101981101982101983101984101985101986101987101988101989101990101991101992101993101994101995101996101997101998101999102000102001102002102003102004102005102006102007102008102009102010102011102012102013102014102015102016102017102018102019102020102021102022102023102024102025102026102027102028102029102030102031102032102033102034102035102036102037102038102039102040102041102042102043102044102045102046102047102048102049102050102051102052102053102054102055102056102057102058102059102060102061102062102063102064102065102066102067102068102069102070102071102072102073102074102075102076102077102078102079102080102081102082102083102084102085102086102087102088102089102090102091102092102093102094102095102096102097102098102099102100102101102102102103102104102105102106102107102108102109102110102111102112102113102114102115102116102117102118102119102120102121102122102123102124102125102126102127102128102129102130102131102132102133102134102135102136102137102138102139102140102141102142102143102144102145102146102147102148102149102150102151102152102153102154102155102156102157102158102159102160102161102162102163102164102165102166102167102168102169102170102171102172102173102174102175102176102177102178102179102180102181102182102183102184102185102186102187102188102189102190102191102192102193102194102195102196102197102198102199102200102201102202102203102204102205102206102207102208102209102210102211102212102213102214102215102216102217102218102219102220102221102222102223102224102225102226102227102228102229102230102231102232102233102234102235102236102237102238102239102240102241102242102243102244102245102246102247102248102249102250102251102252102253102254102255102256102257102258102259102260102261102262102263102264102265102266102267102268102269102270102271102272102273102274102275102276102277102278102279102280102281102282102283102284102285102286102287102288102289102290102291102292102293102294102295102296102297102298102299102300102301102302102303102304102305102306102307102308102309102310102311102312102313102314102315102316102317102318102319102320102321102322102323102324102325102326102327102328102329102330102331102332102333102334102335102336102337102338102339102340102341102342102343102344102345102346102347102348102349102350102351102352102353102354102355102356102357102358102359102360102361102362102363102364102365102366102367102368102369102370102371102372102373102374102375102376102377102378102379102380102381102382102383102384102385102386102387102388102389102390102391102392102393102394102395102396102397102398102399102400102401102402102403102404102405102406102407102408102409102410102411102412102413102414102415102416102417102418102419102420102421102422102423102424102425102426102427102428102429102430102431102432102433102434102435102436102437102438102439102440102441102442102443102444102445102446102447102448102449102450102451102452102453102454102455102456102457102458102459102460102461102462102463102464102465102466102467102468102469102470102471102472102473102474102475102476102477102478102479102480102481102482102483102484102485102486102487102488102489102490102491102492102493102494102495102496102497102498102499102500102501102502102503102504102505102506102507102508102509102510102511102512102513102514102515102516102517102518102519102520102521102522102523102524102525102526102527102528102529102530102531102532102533102534102535102536102537102538102539102540102541102542102543102544102545102546102547102548102549102550102551102552102553102554102555102556102557102558102559102560102561102562102563102564102565102566102567102568102569102570102571102572102573102574102575102576102577102578102579102580102581102582102583102584102585102586102587102588102589102590102591102592102593102594102595102596102597102598102599102600102601102602102603102604102605102606102607102608102609102610102611102612102613102614102615102616102617102618102619102620102621102622102623102624102625102626102627102628102629102630102631102632102633102634102635102636102637102638102639102640102641102642102643102644102645102646102647102648102649102650102651102652102653102654102655102656102657102658102659102660102661102662102663102664102665102666102667102668102669102670102671102672102673102674102675102676102677102678102679102680102681102682102683102684102685102686102687102688102689102690102691102692102693102694102695102696102697102698102699102700102701102702102703102704102705102706102707102708102709102710102711102712102713102714102715102716102717102718102719102720102721102722102723102724102725102726102727102728102729102730102731102732102733102734102735102736102737102738102739102740102741102742102743102744102745102746102747102748102749102750102751102752102753102754102755102756102757102758102759102760102761102762102763102764102765102766102767102768102769102770102771102772102773102774102775102776102777102778102779102780102781102782102783102784102785102786102787102788102789102790102791102792102793102794102795102796102797102798102799102800102801102802102803102804102805102806102807102808102809102810102811102812102813102814102815102816102817102818102819102820102821102822102823102824102825102826102827102828102829102830102831102832102833102834102835102836102837102838102839102840102841102842102843102844102845102846102847102848102849102850102851102852102853102854102855102856102857102858102859102860102861102862102863102864102865102866102867102868102869102870102871102872102873102874102875102876102877102878102879102880102881102882102883102884102885102886102887102888102889102890102891102892102893102894102895102896102897102898102899102900102901102902102903102904102905102906102907102908102909102910102911102912102913102914102915102916102917102918102919102920102921102922102923102924102925102926102927102928102929102930102931102932102933102934102935102936102937102938102939102940102941102942102943102944102945102946102947102948102949102950102951102952102953102954102955102956102957102958102959102960102961102962102963102964102965102966102967102968102969102970102971102972102973102974102975102976102977102978102979102980102981102982102983102984102985102986102987102988102989102990102991102992102993102994102995102996102997102998102999103000103001103002103003103004103005103006103007103008103009103010103011103012103013103014103015103016103017103018103019103020103021103022103023103024103025103026103027103028103029103030103031103032103033103034103035103036103037103038103039103040103041103042103043103044103045103046103047103048103049103050103051103052103053103054103055103056103057103058103059103060103061103062103063103064103065103066103067103068103069103070103071103072103073103074103075103076103077103078103079103080103081103082103083103084103085103086103087103088103089103090103091103092103093103094103095103096103097103098103099103100103101103102103103103104103105103106103107103108103109103110103111103112103113103114103115103116103117103118103119103120103121103122103123103124103125103126103127103128103129103130103131103132103133103134103135103136103137103138103139103140103141103142103143103144103145103146103147103148103149103150103151103152103153103154103155103156103157103158103159103160103161103162103163103164103165103166103167103168103169103170103171103172103173103174103175103176103177103178103179103180103181103182103183103184103185103186103187103188103189103190103191103192103193103194103195103196103197103198103199103200103201103202103203103204103205103206103207103208103209103210103211103212103213103214103215103216103217103218103219103220103221103222103223103224103225103226103227103228103229103230103231103232103233103234103235103236103237103238103239103240103241103242103243103244103245103246103247103248103249103250103251103252103253103254103255103256103257103258103259103260103261103262103263103264103265103266103267103268103269103270103271103272103273103274103275103276103277103278103279103280103281103282103283103284103285103286103287103288103289103290103291103292103293103294103295103296103297103298103299103300103301103302103303103304103305103306103307103308103309103310103311103312103313103314103315103316103317103318103319103320103321103322103323103324103325103326103327103328103329103330103331103332103333103334103335103336103337103338103339103340103341103342103343103344103345103346103347103348103349103350103351103352103353103354103355103356103357103358103359103360103361103362103363103364103365103366103367103368103369103370103371103372103373103374103375103376103377103378103379103380103381103382103383103384103385103386103387103388103389103390103391103392103393103394103395103396103397103398103399103400103401103402103403103404103405103406103407103408103409103410103411103412103413103414103415103416103417103418103419103420103421103422103423103424103425103426103427103428103429103430103431103432103433103434103435103436103437103438103439103440103441103442103443103444103445103446103447103448103449103450103451103452103453103454103455103456103457103458103459103460103461103462103463103464103465103466103467103468103469103470103471103472103473103474103475103476103477103478103479103480103481103482103483103484103485103486103487103488103489103490103491103492103493103494103495103496103497103498103499103500103501103502103503103504103505103506103507103508103509103510103511103512103513103514103515103516103517103518103519103520103521103522103523103524103525103526103527103528103529103530103531103532103533103534103535103536103537103538103539103540103541103542103543103544103545103546103547103548103549103550103551103552103553103554103555103556103557103558103559103560103561103562103563103564103565103566103567103568103569103570103571103572103573103574103575103576103577103578103579103580103581103582103583103584103585103586103587103588103589103590103591103592103593103594103595103596103597103598103599103600103601103602103603103604103605103606103607103608103609103610103611103612103613103614103615103616103617103618103619103620103621103622103623103624103625103626103627103628103629103630103631103632103633103634103635103636103637103638103639103640103641103642103643103644103645103646103647103648103649103650103651103652103653103654103655103656103657103658103659103660103661103662103663103664103665103666103667103668103669103670103671103672103673103674103675103676103677103678103679103680103681103682103683103684103685103686103687103688103689103690103691103692103693103694103695103696103697103698103699103700103701103702103703103704103705103706103707103708103709103710103711103712103713103714103715103716103717103718103719103720103721103722103723103724103725103726103727103728103729103730103731103732103733103734103735103736103737103738103739103740103741103742103743103744103745103746103747103748103749103750103751103752103753103754103755103756103757103758103759103760103761103762103763103764103765103766103767103768103769103770103771103772103773103774103775103776103777103778103779103780103781103782103783103784103785103786103787103788103789103790103791103792103793103794103795103796103797103798103799103800103801103802103803103804103805103806103807103808103809103810103811103812103813103814103815103816103817103818103819103820103821103822103823103824103825103826103827103828103829103830103831103832103833103834103835103836103837103838103839103840103841103842103843103844103845103846103847103848103849103850103851103852103853103854103855103856103857103858103859103860103861103862103863103864103865103866103867103868103869103870103871103872103873103874103875103876103877103878103879103880103881103882103883103884103885103886103887103888103889103890103891103892103893103894103895103896103897103898103899103900103901103902103903103904103905103906103907103908103909103910103911103912103913103914103915103916103917103918103919103920103921103922103923103924103925103926103927103928103929103930103931103932103933103934103935103936103937103938103939103940103941103942103943103944103945103946103947103948103949103950103951103952103953103954103955103956103957103958103959103960103961103962103963103964103965103966103967103968103969103970103971103972103973103974103975103976103977103978103979103980103981103982103983103984103985103986103987103988103989103990103991103992103993103994103995103996103997103998103999104000104001104002104003104004104005104006104007104008104009104010104011104012104013104014104015104016104017104018104019104020104021104022104023104024104025104026104027104028104029104030104031104032104033104034104035104036104037104038104039104040104041104042104043104044104045104046104047104048104049104050104051104052104053104054104055104056104057104058104059104060104061104062104063104064104065104066104067104068104069104070104071104072104073104074104075104076104077104078104079104080104081104082104083104084104085104086104087104088104089104090104091104092104093104094104095104096104097104098104099104100104101104102104103104104104105104106104107104108104109104110104111104112104113104114104115104116104117104118104119104120104121104122104123104124104125104126104127104128104129104130104131104132104133104134104135104136104137104138104139104140104141104142104143104144104145104146104147104148104149104150104151104152104153104154104155104156104157104158104159104160104161104162104163104164104165104166104167104168104169104170104171104172104173104174104175104176104177104178104179104180104181104182104183104184104185104186104187104188104189104190104191104192104193104194104195104196104197104198104199104200104201104202104203104204104205104206104207104208104209104210104211104212104213104214104215104216104217104218104219104220104221104222104223104224104225104226104227104228104229104230104231104232104233104234104235104236104237104238104239104240104241104242104243104244104245104246104247104248104249104250104251104252104253104254104255104256104257104258104259104260104261104262104263104264104265104266104267104268104269104270104271104272104273104274104275104276104277104278104279104280104281104282104283104284104285104286104287104288104289104290104291104292104293104294104295104296104297104298104299104300104301104302104303104304104305104306104307104308104309104310104311104312104313104314104315104316104317104318104319104320104321104322104323104324104325104326104327104328104329104330104331104332104333104334104335104336104337104338104339104340104341104342104343104344104345104346104347104348104349104350104351104352104353104354104355104356104357104358104359104360104361104362104363104364104365104366104367104368104369104370104371104372104373104374104375104376104377104378104379104380104381104382104383104384104385104386104387104388104389104390104391104392104393104394104395104396104397104398104399104400104401104402104403104404104405104406104407104408104409104410104411104412104413104414104415104416104417104418104419104420104421104422104423104424104425104426104427104428104429104430104431104432104433104434104435104436104437104438104439104440104441104442104443104444104445104446104447104448104449104450104451104452104453104454104455104456104457104458104459104460104461104462104463104464104465104466104467104468104469104470104471104472104473104474104475104476104477104478104479104480104481104482104483104484104485104486104487104488104489104490104491104492104493104494104495104496104497104498104499104500104501104502104503104504104505104506104507104508104509104510104511104512104513104514104515104516104517104518104519104520104521104522104523104524104525104526104527104528104529104530104531104532104533104534104535104536104537104538104539104540104541104542104543104544104545104546104547104548104549104550104551104552104553104554104555104556104557104558104559104560104561104562104563104564104565104566104567104568104569104570104571104572104573104574104575104576104577104578104579104580104581104582104583104584104585104586104587104588104589104590104591104592104593104594104595104596104597104598104599104600104601104602104603104604104605104606104607104608104609104610104611104612104613104614104615104616104617104618104619104620104621104622104623104624104625104626104627104628104629104630104631104632104633104634104635104636104637104638104639104640104641104642104643104644104645104646104647104648104649104650104651104652104653104654104655104656104657104658104659104660104661104662104663104664104665104666104667104668104669104670104671104672104673104674104675104676104677104678104679104680104681104682104683104684104685104686104687104688104689104690104691104692104693104694104695104696104697104698104699104700104701104702104703104704104705104706104707104708104709104710104711104712104713104714104715104716104717104718104719104720104721104722104723104724104725104726104727104728104729104730104731104732104733104734104735104736104737104738104739104740104741104742104743104744104745104746104747104748104749104750104751104752104753104754104755104756104757104758104759104760104761104762104763104764104765104766104767104768104769104770104771104772104773104774104775104776104777104778104779104780104781104782104783104784104785104786104787104788104789104790104791104792104793104794104795104796104797104798104799104800104801104802104803104804104805104806104807104808104809104810104811104812104813104814104815104816104817104818104819104820104821104822104823104824104825104826104827104828104829104830104831104832104833104834104835104836104837104838104839104840104841104842104843104844104845104846104847104848104849104850104851104852104853104854104855104856104857104858104859104860104861104862104863104864104865104866104867104868104869104870104871104872104873104874104875104876104877104878104879104880104881104882104883104884104885104886104887104888104889104890104891104892104893104894104895104896104897104898104899104900104901104902104903104904104905104906104907104908104909104910104911104912104913104914104915104916104917104918104919104920104921104922104923104924104925104926104927104928104929104930104931104932104933104934104935104936104937104938104939104940104941104942104943104944104945104946104947104948104949104950104951104952104953104954104955104956104957104958104959104960104961104962104963104964104965104966104967104968104969104970104971104972104973104974104975104976104977104978104979104980104981104982104983104984104985104986104987104988104989104990104991104992104993104994104995104996104997104998104999105000105001105002105003105004105005105006105007105008105009105010105011105012105013105014105015105016105017105018105019105020105021105022105023105024105025105026105027105028105029105030105031105032105033105034105035105036105037105038105039105040105041105042105043105044105045105046105047105048105049105050105051105052105053105054105055105056105057105058105059105060105061105062105063105064105065105066105067105068105069105070105071105072105073105074105075105076105077105078105079105080105081105082105083105084105085105086105087105088105089105090105091105092105093105094105095105096105097105098105099105100105101105102105103105104105105105106105107105108105109105110105111105112105113105114105115105116105117105118105119105120105121105122105123105124105125105126105127105128105129105130105131105132105133105134105135105136105137105138105139105140105141105142105143105144105145105146105147105148105149105150105151105152105153105154105155105156105157105158105159105160105161105162105163105164105165105166105167105168105169105170105171105172105173105174105175105176105177105178105179105180105181105182105183105184105185105186105187105188105189105190105191105192105193105194105195105196105197105198105199105200105201105202105203105204105205105206105207105208105209105210105211105212105213105214105215105216105217105218105219105220105221105222105223105224105225105226105227105228105229105230105231105232105233105234105235105236105237105238105239105240105241105242105243105244105245105246105247105248105249105250105251105252105253105254105255105256105257105258105259105260105261105262105263105264105265105266105267105268105269105270105271105272105273105274105275105276105277105278105279105280105281105282105283105284105285105286105287105288105289105290105291105292105293105294105295105296105297105298105299105300105301105302105303105304105305105306105307105308105309105310105311105312105313105314105315105316105317105318105319105320105321105322105323105324105325105326105327105328105329105330105331105332105333105334105335105336105337105338105339105340105341105342105343105344105345105346105347105348105349105350105351105352105353105354105355105356105357105358105359105360105361105362105363105364105365105366105367105368105369105370105371105372105373105374105375105376105377105378105379105380105381105382105383105384105385105386105387105388105389105390105391105392105393105394105395105396105397105398105399105400105401105402105403105404105405105406105407105408105409105410105411105412105413105414105415105416105417105418105419105420105421105422105423105424105425105426105427105428105429105430105431105432105433105434105435105436105437105438105439105440105441105442105443105444105445105446105447105448105449105450105451105452105453105454105455105456105457105458105459105460105461105462105463105464105465105466105467105468105469105470105471105472105473105474105475105476105477105478105479105480105481105482105483105484105485105486105487105488105489105490105491105492105493105494105495105496105497105498105499105500105501105502105503105504105505105506105507105508105509105510105511105512105513105514105515105516105517105518105519105520105521105522105523105524105525105526105527105528105529105530105531105532105533105534105535105536105537105538105539105540105541105542105543105544105545105546105547105548105549105550105551105552105553105554105555105556105557105558105559105560105561105562105563105564105565105566105567105568105569105570105571105572105573105574105575105576105577105578105579105580105581105582105583105584105585105586105587105588105589105590105591105592105593105594105595105596105597105598105599105600105601105602105603105604105605105606105607105608105609105610105611105612105613105614105615105616105617105618105619105620105621105622105623105624105625105626105627105628105629105630105631105632105633105634105635105636105637105638105639105640105641105642105643105644105645105646105647105648105649105650105651105652105653105654105655105656105657105658105659105660105661105662105663105664105665105666105667105668105669105670105671105672105673105674105675105676105677105678105679105680105681105682105683105684105685105686105687105688105689105690105691105692105693105694105695105696105697105698105699105700105701105702105703105704105705105706105707105708105709105710105711105712105713105714105715105716105717105718105719105720105721105722105723105724105725105726105727105728105729105730105731105732105733105734105735105736105737105738105739105740105741105742105743105744105745105746105747105748105749105750105751105752105753105754105755105756105757105758105759105760105761105762105763105764105765105766105767105768105769105770105771105772105773105774105775105776105777105778105779105780105781105782105783105784105785105786105787105788105789105790105791105792105793105794105795105796105797105798105799105800105801105802105803105804105805105806105807105808105809105810105811105812105813105814105815105816105817105818105819105820105821105822105823105824105825105826105827105828105829105830105831105832105833105834105835105836105837105838105839105840105841105842105843105844105845105846105847105848105849105850105851105852105853105854105855105856105857105858105859105860105861105862105863105864105865105866105867105868105869105870105871105872105873105874105875105876105877105878105879105880105881105882105883105884105885105886105887105888105889105890105891105892105893105894105895105896105897105898105899105900105901105902105903105904105905105906105907105908105909105910105911105912105913105914105915105916105917105918105919105920105921105922105923105924105925105926105927105928105929105930105931105932105933105934105935105936105937105938105939105940105941105942105943105944105945105946105947105948105949105950105951105952105953105954105955105956105957105958105959105960105961105962105963105964105965105966105967105968105969105970105971105972105973105974105975105976105977105978105979105980105981105982105983105984105985105986105987105988105989105990105991105992105993105994105995105996105997105998105999106000106001106002106003106004106005106006106007106008106009106010106011106012106013106014106015106016106017106018106019106020106021106022106023106024106025106026106027106028106029106030106031106032106033106034106035106036106037106038106039106040106041106042106043106044106045106046106047106048106049106050106051106052106053106054106055106056106057106058106059106060106061106062106063106064106065106066106067106068106069106070106071106072106073106074106075106076106077106078106079106080106081106082106083106084106085106086106087106088106089106090106091106092106093106094106095106096106097106098106099106100106101106102106103106104106105106106106107106108106109106110106111106112106113106114106115106116106117106118106119106120106121106122106123106124106125106126106127106128106129106130106131106132106133106134106135106136106137106138106139106140106141106142106143106144106145106146106147106148106149106150106151106152106153106154106155106156106157106158106159106160106161106162106163106164106165106166106167106168106169106170106171106172106173106174106175106176106177106178106179106180106181106182106183106184106185106186106187106188106189106190106191106192106193106194106195106196106197106198106199106200106201106202106203106204106205106206106207106208106209106210106211106212106213106214106215106216106217106218106219106220106221106222106223106224106225106226106227106228106229106230106231106232106233106234106235106236106237106238106239106240106241106242106243106244106245106246106247106248106249106250106251106252106253106254106255106256106257106258106259106260106261106262106263106264106265106266106267106268106269106270106271106272106273106274106275106276106277106278106279106280106281106282106283106284106285106286106287106288106289106290106291106292106293106294106295106296106297106298106299106300106301106302106303106304106305106306106307106308106309106310106311106312106313106314106315106316106317106318106319106320106321106322106323106324106325106326106327106328106329106330106331106332106333106334106335106336106337106338106339106340106341106342106343106344106345106346106347106348106349106350106351106352106353106354106355106356106357106358106359106360106361106362106363106364106365106366106367106368106369106370106371106372106373106374106375106376106377106378106379106380106381106382106383106384106385106386106387106388106389106390106391106392106393106394106395106396106397106398106399106400106401106402106403106404106405106406106407106408106409106410106411106412106413106414106415106416106417106418106419106420106421106422106423106424106425106426106427106428106429106430106431106432106433106434106435106436106437106438106439106440106441106442106443106444106445106446106447106448106449106450106451106452106453106454106455106456106457106458106459106460106461106462106463106464106465106466106467106468106469106470106471106472106473106474106475106476106477106478106479106480106481106482106483106484106485106486106487106488106489106490106491106492106493106494106495106496106497106498106499106500106501106502106503106504106505106506106507106508106509106510106511106512106513106514106515106516106517106518106519106520106521106522106523106524106525106526106527106528106529106530106531106532106533106534106535106536106537106538106539106540106541106542106543106544106545106546106547106548106549106550106551106552106553106554106555106556106557106558106559106560106561106562106563106564106565106566106567106568106569106570106571106572106573106574106575106576106577106578106579106580106581106582106583106584106585106586106587106588106589106590106591106592106593106594106595106596106597106598106599106600106601106602106603106604106605106606106607106608106609106610106611106612106613106614106615106616106617106618106619106620106621106622106623106624106625106626106627106628106629106630106631106632106633106634106635106636106637106638106639106640106641106642106643106644106645106646106647106648106649106650106651106652106653106654106655106656106657106658106659106660106661106662106663106664106665106666106667106668106669106670106671106672106673106674106675106676106677106678106679106680106681106682106683106684106685106686106687106688106689106690106691106692106693106694106695106696106697106698106699106700106701106702106703106704106705106706106707106708106709106710106711106712106713106714106715106716106717106718106719106720106721106722106723106724106725106726106727106728106729106730106731106732106733106734106735106736106737106738106739106740106741106742106743106744106745106746106747106748106749106750106751106752106753106754106755106756106757106758106759106760106761106762106763106764106765106766106767106768106769106770106771106772106773106774106775106776106777106778106779106780106781106782106783106784106785106786106787106788106789106790106791106792106793106794106795106796106797106798106799106800106801106802106803106804106805106806106807106808106809106810106811106812106813106814106815106816106817106818106819106820106821106822106823106824106825106826106827106828106829106830106831106832106833106834106835106836106837106838106839106840106841106842106843106844106845106846106847106848106849106850106851106852106853106854106855106856106857106858106859106860106861106862106863106864106865106866106867106868106869106870106871106872106873106874106875106876106877106878106879106880106881106882106883106884106885106886106887106888106889106890106891106892106893106894106895106896106897106898106899106900106901106902106903106904106905106906106907106908106909106910106911106912106913106914106915106916106917106918106919106920106921106922106923106924106925106926106927106928106929106930106931106932106933106934106935106936106937106938106939106940106941106942106943106944106945106946106947106948106949106950106951106952106953106954106955106956106957106958106959106960106961106962106963106964106965106966106967106968106969106970106971106972106973106974106975106976106977106978106979106980106981106982106983106984106985106986106987106988106989106990106991106992106993106994106995106996106997106998106999107000107001107002107003107004107005107006107007107008107009107010107011107012107013107014107015107016107017107018107019107020107021107022107023107024107025107026107027107028107029107030107031107032107033107034107035107036107037107038107039107040107041107042107043107044107045107046107047107048107049107050107051107052107053107054107055107056107057107058107059107060107061107062107063107064107065107066107067107068107069107070107071107072107073107074107075107076107077107078107079107080107081107082107083107084107085107086107087107088107089107090107091107092107093107094107095107096107097107098107099107100107101107102107103107104107105107106107107107108107109107110107111107112107113107114107115107116107117107118107119107120107121107122107123107124107125107126107127107128107129107130107131107132107133107134107135107136107137107138107139107140107141107142107143107144107145107146107147107148107149107150107151107152107153107154107155107156107157107158107159107160107161107162107163107164107165107166107167107168107169107170107171107172107173107174107175107176107177107178107179107180107181107182107183107184107185107186107187107188107189107190107191107192107193107194107195107196107197107198107199107200107201107202107203107204107205107206107207107208107209107210107211107212107213107214107215107216107217107218107219107220107221107222107223107224107225107226107227107228107229107230107231107232107233107234107235107236107237107238107239107240107241107242107243107244107245107246107247107248107249107250107251107252107253107254107255107256107257107258107259107260107261107262107263107264107265107266107267107268107269107270107271107272107273107274107275107276107277107278107279107280107281107282107283107284107285107286107287107288107289107290107291107292107293107294107295107296107297107298107299107300107301107302107303107304107305107306107307107308107309107310107311107312107313107314107315107316107317107318107319107320107321107322107323107324107325107326107327107328107329107330107331107332107333107334107335107336107337107338107339107340107341107342107343107344107345107346107347107348107349107350107351107352107353107354107355107356107357107358107359107360107361107362107363107364107365107366107367107368107369107370107371107372107373107374107375107376107377107378107379107380107381107382107383107384107385107386107387107388107389107390107391107392107393107394107395107396107397107398107399107400107401107402107403107404107405107406107407107408107409107410107411107412107413107414107415107416107417107418107419107420107421107422107423107424107425107426107427107428107429107430107431107432107433107434107435107436107437107438107439107440107441107442107443107444107445107446107447107448107449107450107451107452107453107454107455107456107457107458107459107460107461107462107463107464107465107466107467107468107469107470107471107472107473107474107475107476107477107478107479107480107481107482107483107484107485107486107487107488107489107490107491107492107493107494107495107496107497107498107499107500107501107502107503107504107505107506107507107508107509107510107511107512107513107514107515107516107517107518107519107520107521107522107523107524107525107526107527107528107529107530107531107532107533107534107535107536107537107538107539107540107541107542107543107544107545107546107547107548107549107550107551107552107553107554107555107556107557107558107559107560107561107562107563107564107565107566107567107568107569107570107571107572107573107574107575107576107577107578107579107580107581107582107583107584107585107586107587107588107589107590107591107592107593107594107595107596107597107598107599107600107601107602107603107604107605107606107607107608107609107610107611107612107613107614107615107616107617107618107619107620107621107622107623107624107625107626107627107628107629107630107631107632107633107634107635107636107637107638107639107640107641107642107643107644107645107646107647107648107649107650107651107652107653107654107655107656107657107658107659107660107661107662107663107664107665107666107667107668107669107670107671107672107673107674107675107676107677107678107679107680107681107682107683107684107685107686107687107688107689107690107691107692107693107694107695107696107697107698107699107700107701107702107703107704107705107706107707107708107709107710107711107712107713107714107715107716107717107718107719107720107721107722107723107724107725107726107727107728107729107730107731107732107733107734107735107736107737107738107739107740107741107742107743107744107745107746107747107748107749107750107751107752107753107754107755107756107757107758107759107760107761107762107763107764107765107766107767107768107769107770107771107772107773107774107775107776107777107778107779107780107781107782107783107784107785107786107787107788107789107790107791107792107793107794107795107796107797107798107799107800107801107802107803107804107805107806107807107808107809107810107811107812107813107814107815107816107817107818107819107820107821107822107823107824107825107826107827107828107829107830107831107832107833107834107835107836107837107838107839107840107841107842107843107844107845107846107847107848107849107850107851107852107853107854107855107856107857107858107859107860107861107862107863107864107865107866107867107868107869107870107871107872107873107874107875107876107877107878107879107880107881107882107883107884107885107886107887107888107889107890107891107892107893107894107895107896107897107898107899107900107901107902107903107904107905107906107907107908107909107910107911107912107913107914107915107916107917107918107919107920107921107922107923107924107925107926107927107928107929107930107931107932107933107934107935107936107937107938107939107940107941107942107943107944107945107946107947107948107949107950107951107952107953107954107955107956107957107958107959107960107961107962107963107964107965107966107967107968107969107970107971107972107973107974107975107976107977107978107979107980107981107982107983107984107985107986107987107988107989107990107991107992107993107994107995107996107997107998107999108000108001108002108003108004108005108006108007108008108009108010108011108012108013108014108015108016108017108018108019108020108021108022108023108024108025108026108027108028108029108030108031108032108033108034108035108036108037108038108039108040108041108042108043108044108045108046108047108048108049108050108051108052108053108054108055108056108057108058108059108060108061108062108063108064108065108066108067108068108069108070108071108072108073108074108075108076108077108078108079108080108081108082108083108084108085108086108087108088108089108090108091108092108093108094108095108096108097108098108099108100108101108102108103108104108105108106108107108108108109108110108111108112108113108114108115108116108117108118108119108120108121108122108123108124108125108126108127108128108129108130108131108132108133108134108135108136108137108138108139108140108141108142108143108144108145108146108147108148108149108150108151108152108153108154108155108156108157108158108159108160108161108162108163108164108165108166108167108168108169108170108171108172108173108174108175108176108177108178108179108180108181108182108183108184108185108186108187108188108189108190108191108192108193108194108195108196108197108198108199108200108201108202108203108204108205108206108207108208108209108210108211108212108213108214108215108216108217108218108219108220108221108222108223108224108225108226108227108228108229108230108231108232108233108234108235108236108237108238108239108240108241108242108243108244108245108246108247108248108249108250108251108252108253108254108255108256108257108258108259108260108261108262108263108264108265108266108267108268108269108270108271108272108273108274108275108276108277108278108279108280108281108282108283108284108285108286108287108288108289108290108291108292108293108294108295108296108297108298108299108300108301108302108303108304108305108306108307108308108309108310108311108312108313108314108315108316108317108318108319108320108321108322108323108324108325108326108327108328108329108330108331108332108333108334108335108336108337108338108339108340108341108342108343108344108345108346108347108348108349108350108351108352108353108354108355108356108357108358108359108360108361108362108363108364108365108366108367108368108369108370108371108372108373108374108375108376108377108378108379108380108381108382108383108384108385108386108387108388108389108390108391108392108393108394108395108396108397108398108399108400108401108402108403108404108405108406108407108408108409108410108411108412108413108414108415108416108417108418108419108420108421108422108423108424108425108426108427108428108429108430108431108432108433108434108435108436108437108438108439108440108441108442108443108444108445108446108447108448108449108450108451108452108453108454108455108456108457108458108459108460108461108462108463108464108465108466108467108468108469108470108471108472108473108474108475108476108477108478108479108480108481108482108483108484108485108486108487108488108489108490108491108492108493108494108495108496108497108498108499108500108501108502108503108504108505108506108507108508108509108510108511108512108513108514108515108516108517108518108519108520108521108522108523108524108525108526108527108528108529108530108531108532108533108534108535108536108537108538108539108540108541108542108543108544108545108546108547108548108549108550108551108552108553108554108555108556108557108558108559108560108561108562108563108564108565108566108567108568108569108570108571108572108573108574108575108576108577108578108579108580108581108582108583108584108585108586108587108588108589108590108591108592108593108594108595108596108597108598108599108600108601108602108603108604108605108606108607108608108609108610108611108612108613108614108615108616108617108618108619108620108621108622108623108624108625108626108627108628108629108630108631108632108633108634108635108636108637108638108639108640108641108642108643108644108645108646108647108648108649108650108651108652108653108654108655108656108657108658108659108660108661108662108663108664108665108666108667108668108669108670108671108672108673108674108675108676108677108678108679108680108681108682108683108684108685108686108687108688108689108690108691108692108693108694108695108696108697108698108699108700108701108702108703108704108705108706108707108708108709108710108711108712108713108714108715108716108717108718108719108720108721108722108723108724108725108726108727108728108729108730108731108732108733108734108735108736108737108738108739108740108741108742108743108744108745108746108747108748108749108750108751108752108753108754108755108756108757108758108759108760108761108762108763108764108765108766108767108768108769108770108771108772108773108774108775108776108777108778108779108780108781108782108783108784108785108786108787108788108789108790108791108792108793108794108795108796108797108798108799108800108801108802108803108804108805108806108807108808108809108810108811108812108813108814108815108816108817108818108819108820108821108822108823108824108825108826108827108828108829108830108831108832108833108834108835108836108837108838108839108840108841108842108843108844108845108846108847108848108849108850108851108852108853108854108855108856108857108858108859108860108861108862108863108864108865108866108867108868108869108870108871108872108873108874108875108876108877108878108879108880108881108882108883108884108885108886108887108888108889108890108891108892108893108894108895108896108897108898108899108900108901108902108903108904108905108906108907108908108909108910108911108912108913108914108915108916108917108918108919108920108921108922108923108924108925108926108927108928108929108930108931108932108933108934108935108936108937108938108939108940108941108942108943108944108945108946108947108948108949108950108951108952108953108954108955108956108957108958108959108960108961108962108963108964108965108966108967108968108969108970108971108972108973108974108975108976108977108978108979108980108981108982108983108984108985108986108987108988108989108990108991108992108993108994108995108996108997108998108999109000109001109002109003109004109005109006109007109008109009109010109011109012109013109014109015109016109017109018109019109020109021109022109023109024109025109026109027109028109029109030109031109032109033109034109035109036109037109038109039109040109041109042109043109044109045109046109047109048109049109050109051109052109053109054109055109056109057109058109059109060109061109062109063109064109065109066109067109068109069109070109071109072109073109074109075109076109077109078109079109080109081109082109083109084109085109086109087109088109089109090109091109092109093109094109095109096109097109098109099109100109101109102109103109104109105109106109107109108109109109110109111109112109113109114109115109116109117109118109119109120109121109122109123109124109125109126109127109128109129109130109131109132109133109134109135109136109137109138109139109140109141109142109143109144109145109146109147109148109149109150109151109152109153109154109155109156109157109158109159109160109161109162109163109164109165109166109167109168109169109170109171109172109173109174109175109176109177109178109179109180109181109182109183109184109185109186109187109188109189109190109191109192109193109194109195109196109197109198109199109200109201109202109203109204109205109206109207109208109209109210109211109212109213109214109215109216109217109218109219109220109221109222109223109224109225109226109227109228109229109230109231109232109233109234109235109236109237109238109239109240109241109242109243109244109245109246109247109248109249109250109251109252109253109254109255109256109257109258109259109260109261109262109263109264109265109266109267109268109269109270109271109272109273109274109275109276109277109278109279109280109281109282109283109284109285109286109287109288109289109290109291109292109293109294109295109296109297109298109299109300109301109302109303109304109305109306109307109308109309109310109311109312109313109314109315109316109317109318109319109320109321109322109323109324109325109326109327109328109329109330109331109332109333109334109335109336109337109338109339109340109341109342109343109344109345109346109347109348109349109350109351109352109353109354109355109356109357109358109359109360109361109362109363109364109365109366109367109368109369109370109371109372109373109374109375109376109377109378109379109380109381109382109383109384109385109386109387109388109389109390109391109392109393109394109395109396109397109398109399109400109401109402109403109404109405109406109407109408109409109410109411109412109413109414109415109416109417109418109419109420109421109422109423109424109425109426109427109428109429109430109431109432109433109434109435109436109437109438109439109440109441109442109443109444109445109446109447109448109449109450109451109452109453109454109455109456109457109458109459109460109461109462109463109464109465109466109467109468109469109470109471109472109473109474109475109476109477109478109479109480109481109482109483109484109485109486109487109488109489109490109491109492109493109494109495109496109497109498109499109500109501109502109503109504109505109506109507109508109509109510109511109512109513109514109515109516109517109518109519109520109521109522109523109524109525109526109527109528109529109530109531109532109533109534109535109536109537109538109539109540109541109542109543109544109545109546109547109548109549109550109551109552109553109554109555109556109557109558109559109560109561109562109563109564109565109566109567109568109569109570109571109572109573109574109575109576109577109578109579109580109581109582109583109584109585109586109587109588109589109590109591109592109593109594109595109596109597109598109599109600109601109602109603109604109605109606109607109608109609109610109611109612109613109614109615109616109617109618109619109620109621109622109623109624109625109626109627109628109629109630109631109632109633109634109635109636109637109638109639109640109641109642109643109644109645109646109647109648109649109650109651109652109653109654109655109656109657109658109659109660109661109662109663109664109665109666109667109668109669109670109671109672109673109674109675109676109677109678109679109680109681109682109683109684109685109686109687109688109689109690109691109692109693109694109695109696109697109698109699109700109701109702109703109704109705109706109707109708109709109710109711109712109713109714109715109716109717109718109719109720109721109722109723109724109725109726109727109728109729109730109731109732109733109734109735109736109737109738109739109740109741109742109743109744109745109746109747109748109749109750109751109752109753109754109755109756109757109758109759109760109761109762109763109764109765109766109767109768109769109770109771109772109773109774109775109776109777109778109779109780109781109782109783109784109785109786109787109788109789109790109791109792109793109794109795109796109797109798109799109800109801109802109803109804109805109806109807109808109809109810109811109812109813109814109815109816109817109818109819109820109821109822109823109824109825109826109827109828109829109830109831109832109833109834109835109836109837109838109839109840109841109842109843109844109845109846109847109848109849109850109851109852109853109854109855109856109857109858109859109860109861109862109863109864109865109866109867109868109869109870109871109872109873109874109875109876109877109878109879109880109881109882109883109884109885109886109887109888109889109890109891109892109893109894109895109896109897109898109899109900109901109902109903109904109905109906109907109908109909109910109911109912109913109914109915109916109917109918109919109920109921109922109923109924109925109926109927109928109929109930109931109932109933109934109935109936109937109938109939109940109941109942109943109944109945109946109947109948109949109950109951109952109953109954109955109956109957109958109959109960109961109962109963109964109965109966109967109968109969109970109971109972109973109974109975109976109977109978109979109980109981109982109983109984109985109986109987109988109989109990109991109992109993109994109995109996109997109998109999110000110001110002110003110004110005110006110007110008110009110010110011110012110013110014110015110016110017110018110019110020110021110022110023110024110025110026110027110028110029110030110031110032110033110034110035110036110037110038110039110040110041110042110043110044110045110046110047110048110049110050110051110052110053110054110055110056110057110058110059110060110061110062110063110064110065110066110067110068110069110070110071110072110073110074110075110076110077110078110079110080110081110082110083110084110085110086110087110088110089110090110091110092110093110094110095110096110097110098110099110100110101110102110103110104110105110106110107110108110109110110110111110112110113110114110115110116110117110118110119110120110121110122110123110124110125110126110127110128110129110130110131110132110133110134110135110136110137110138110139110140110141110142110143110144110145110146110147110148110149110150110151110152110153110154110155110156110157110158110159110160110161110162110163110164110165110166110167110168110169110170110171110172110173110174110175110176110177110178110179110180110181110182110183110184110185110186110187110188110189110190110191110192110193110194110195110196110197110198110199110200110201110202110203110204110205110206110207110208110209110210110211110212110213110214110215110216110217110218110219110220110221110222110223110224110225110226110227110228110229110230110231110232110233110234110235110236110237110238110239110240110241110242110243110244110245110246110247110248110249110250110251110252110253110254110255110256110257110258110259110260110261110262110263110264110265110266110267110268110269110270110271110272110273110274110275110276110277110278110279110280110281110282110283110284110285110286110287110288110289110290110291110292110293110294110295110296110297110298110299110300110301110302110303110304110305110306110307110308110309110310110311110312110313110314110315110316110317110318110319110320110321110322110323110324110325110326110327110328110329110330110331110332110333110334110335110336110337110338110339110340110341110342110343110344110345110346110347110348110349110350110351110352110353110354110355110356110357110358110359110360110361110362110363110364110365110366110367110368110369110370110371110372110373110374110375110376110377110378110379110380110381110382110383110384110385110386110387110388110389110390110391110392110393110394110395110396110397110398110399110400110401110402110403110404110405110406110407110408110409110410110411110412110413110414110415110416110417110418110419110420110421110422110423110424110425110426110427110428110429110430110431110432110433110434110435110436110437110438110439110440110441110442110443110444110445110446110447110448110449110450110451110452110453110454110455110456110457110458110459110460110461110462110463110464110465110466110467110468110469110470110471110472110473110474110475110476110477110478110479110480110481110482110483110484110485110486110487110488110489110490110491110492110493110494110495110496110497110498110499110500110501110502110503110504110505110506110507110508110509110510110511110512110513110514110515110516110517110518110519110520110521110522110523110524110525110526110527110528110529110530110531110532110533110534110535110536110537110538110539110540110541110542110543110544110545110546110547110548110549110550110551110552110553110554110555110556110557110558110559110560110561110562110563110564110565110566110567110568110569110570110571110572110573110574110575110576110577110578110579110580110581110582110583110584110585110586110587110588110589110590110591110592110593110594110595110596110597110598110599110600110601110602110603110604110605110606110607110608110609110610110611110612110613110614110615110616110617110618110619110620110621110622110623110624110625110626110627110628110629110630110631110632110633110634110635110636110637110638110639110640110641110642110643110644110645110646110647110648110649110650110651110652110653110654110655110656110657110658110659110660110661110662110663110664110665110666110667110668110669110670110671110672110673110674110675110676110677110678110679110680110681110682110683110684110685110686110687110688110689110690110691110692110693110694110695110696110697110698110699110700110701110702110703110704110705110706110707110708110709110710110711110712110713110714110715110716110717110718110719110720110721110722110723110724110725110726110727110728110729110730110731110732110733110734110735110736110737110738110739110740110741110742110743110744110745110746110747110748110749110750110751110752110753110754110755110756110757110758110759110760110761110762110763110764110765110766110767110768110769110770110771110772110773110774110775110776110777110778110779110780110781110782110783110784110785110786110787110788110789110790110791110792110793110794110795110796110797110798110799110800110801110802110803110804110805110806110807110808110809110810110811110812110813110814110815110816110817110818110819110820110821110822110823110824110825110826110827110828110829110830110831110832110833110834110835110836110837110838110839110840110841110842110843110844110845110846110847110848110849110850110851110852110853110854110855110856110857110858110859110860110861110862110863110864110865110866110867110868110869110870110871110872110873110874110875110876110877110878110879110880110881110882110883110884110885110886110887110888110889110890110891110892110893110894110895110896110897110898110899110900110901110902110903110904110905110906110907110908110909110910110911110912110913110914110915110916110917110918110919110920110921110922110923110924110925110926110927110928110929110930110931110932110933110934110935110936110937110938110939110940110941110942110943110944110945110946110947110948110949110950110951110952110953110954110955110956110957110958110959110960110961110962110963110964110965110966110967110968110969110970110971110972110973110974110975110976110977110978110979110980110981110982110983110984110985110986110987110988110989110990110991110992110993110994110995110996110997110998110999111000111001111002111003111004111005111006111007111008111009111010111011111012111013111014111015111016111017111018111019111020111021111022111023111024111025111026111027111028111029111030111031111032111033111034111035111036111037111038111039111040111041111042111043111044111045111046111047111048111049111050111051111052111053111054111055111056111057111058111059111060111061111062111063111064111065111066111067111068111069111070111071111072111073111074111075111076111077111078111079111080111081111082111083111084111085111086111087111088111089111090111091111092111093111094111095111096111097111098111099111100111101111102111103111104111105111106111107111108111109111110111111111112111113111114111115111116111117111118111119111120111121111122111123111124111125111126111127111128111129111130111131111132111133111134111135111136111137111138111139111140111141111142111143111144111145111146111147111148111149111150111151111152111153111154111155111156111157111158111159111160111161111162111163111164111165111166111167111168111169111170111171111172111173111174111175111176111177111178111179111180111181111182111183111184111185111186111187111188111189111190111191111192111193111194111195111196111197111198111199111200111201111202111203111204111205111206111207111208111209111210111211111212111213111214111215111216111217111218111219111220111221111222111223111224111225111226111227111228111229111230111231111232111233111234111235111236111237111238111239111240111241111242111243111244111245111246111247111248111249111250111251111252111253111254111255111256111257111258111259111260111261111262111263111264111265111266111267111268111269111270111271111272111273111274111275111276111277111278111279111280111281111282111283111284111285111286111287111288111289111290111291111292111293111294111295111296111297111298111299111300111301111302111303111304111305111306111307111308111309111310111311111312111313111314111315111316111317111318111319111320111321111322111323111324111325111326111327111328111329111330111331111332111333111334111335111336111337111338111339111340111341111342111343111344111345111346111347111348111349111350111351111352111353111354111355111356111357111358111359111360111361111362111363111364111365111366111367111368111369111370111371111372111373111374111375111376111377111378111379111380111381111382111383111384111385111386111387111388111389111390111391111392111393111394111395111396111397111398111399111400111401111402111403111404111405111406111407111408111409111410111411111412111413111414111415111416111417111418111419111420111421111422111423111424111425111426111427111428111429111430111431111432111433111434111435111436111437111438111439111440111441111442111443111444111445111446111447111448111449111450111451111452111453111454111455111456111457111458111459111460111461111462111463111464111465111466111467111468111469111470111471111472111473111474111475111476111477111478111479111480111481111482111483111484111485111486111487111488111489111490111491111492111493111494111495111496111497111498111499111500111501111502111503111504111505111506111507111508111509111510111511111512111513111514111515111516111517111518111519111520111521111522111523111524111525111526111527111528111529111530111531111532111533111534111535111536111537111538111539111540111541111542111543111544111545111546111547111548111549111550111551111552111553111554111555111556111557111558111559111560111561111562111563111564111565111566111567111568111569111570111571111572111573111574111575111576111577111578111579111580111581111582111583111584111585111586111587111588111589111590111591111592111593111594111595111596111597111598111599111600111601111602111603111604111605111606111607111608111609111610111611111612111613111614111615111616111617111618111619111620111621111622111623111624111625111626111627111628111629111630111631111632111633111634111635111636111637111638111639111640111641111642111643111644111645111646111647111648111649111650111651111652111653111654111655111656111657111658111659111660111661111662111663111664111665111666111667111668111669111670111671111672111673111674111675111676111677111678111679111680111681111682111683111684111685111686111687111688111689111690111691111692111693111694111695111696111697111698111699111700111701111702111703111704111705111706111707111708111709111710111711111712111713111714111715111716111717111718111719111720111721111722111723111724111725111726111727111728111729111730111731111732111733111734111735111736111737111738111739111740111741111742111743111744111745111746111747111748111749111750111751111752111753111754111755111756111757111758111759111760111761111762111763111764111765111766111767111768111769111770111771111772111773111774111775111776111777111778111779111780111781111782111783111784111785111786111787111788111789111790111791111792111793111794111795111796111797111798111799111800111801111802111803111804111805111806111807111808111809111810111811111812111813111814111815111816111817111818111819111820111821111822111823111824111825111826111827111828111829111830111831111832111833111834111835111836111837111838111839111840111841111842111843111844111845111846111847111848111849111850111851111852111853111854111855111856111857111858111859111860111861111862111863111864111865111866111867111868111869111870111871111872111873111874111875111876111877111878111879111880111881111882111883111884111885111886111887111888111889111890111891111892111893111894111895111896111897111898111899111900111901111902111903111904111905111906111907111908111909111910111911111912111913111914111915111916111917111918111919111920111921111922111923111924111925111926111927111928111929111930111931111932111933111934111935111936111937111938111939111940111941111942111943111944111945111946111947111948111949111950111951111952111953111954111955111956111957111958111959111960111961111962111963111964111965111966111967111968111969111970111971111972111973111974111975111976111977111978111979111980111981111982111983111984111985111986111987111988111989111990111991111992111993111994111995111996111997111998111999112000112001112002112003112004112005112006112007112008112009112010112011112012112013112014112015112016112017112018112019112020112021112022112023112024112025112026112027112028112029112030112031112032112033112034112035112036112037112038112039112040112041112042112043112044112045112046112047112048112049112050112051112052112053112054112055112056112057112058112059112060112061112062112063112064112065112066112067112068112069112070112071112072112073112074112075112076112077112078112079112080112081112082112083112084112085112086112087112088112089112090112091112092112093112094112095112096112097112098112099112100112101112102112103112104112105112106112107112108112109112110112111112112112113112114112115112116112117112118112119112120112121112122112123112124112125112126112127112128112129112130112131112132112133112134112135112136112137112138112139112140112141112142112143112144112145112146112147112148112149112150112151112152112153112154112155112156112157112158112159112160112161112162112163112164112165112166112167112168112169112170112171112172112173112174112175112176112177112178112179112180112181112182112183112184112185112186112187112188112189112190112191112192112193112194112195112196112197112198112199112200112201112202112203112204112205112206112207112208112209112210112211112212112213112214112215112216112217112218112219112220112221112222112223112224112225112226112227112228112229112230112231112232112233112234112235112236112237112238112239112240112241112242112243112244112245112246112247112248112249112250112251112252112253112254112255112256112257112258112259112260112261112262112263112264112265112266112267112268112269112270112271112272112273112274112275112276112277112278112279112280112281112282112283112284112285112286112287112288112289112290112291112292112293112294112295112296112297112298112299112300112301112302112303112304112305112306112307112308112309112310112311112312112313112314112315112316112317112318112319112320112321112322112323112324112325112326112327112328112329112330112331112332112333112334112335112336112337112338112339112340112341112342112343112344112345112346112347112348112349112350112351112352112353112354112355112356112357112358112359112360112361112362112363112364112365112366112367112368112369112370112371112372112373112374112375112376112377112378112379112380112381112382112383112384112385112386112387112388112389112390112391112392112393112394112395112396112397112398112399112400112401112402112403112404112405112406112407112408112409112410112411112412112413112414112415112416112417112418112419112420112421112422112423112424112425112426112427112428112429112430112431112432112433112434112435112436112437112438112439112440112441112442112443112444112445112446112447112448112449112450112451112452112453112454112455112456112457112458112459112460112461112462112463112464112465112466112467112468112469112470112471112472112473112474112475112476112477112478112479112480112481112482112483112484112485112486112487112488112489112490112491112492112493112494112495112496112497112498112499112500112501112502112503112504112505112506112507112508112509112510112511112512112513112514112515112516112517112518112519112520112521112522112523112524112525112526112527112528112529112530112531112532112533112534112535112536112537112538112539112540112541112542112543112544112545112546112547112548112549112550112551112552112553112554112555112556112557112558112559112560112561112562112563112564112565112566112567112568112569112570112571112572112573112574112575112576112577112578112579112580112581112582112583112584112585112586112587112588112589112590112591112592112593112594112595112596112597112598112599112600112601112602112603112604112605112606112607112608112609112610112611112612112613112614112615112616112617112618112619112620112621112622112623112624112625112626112627112628112629112630112631112632112633112634112635112636112637112638112639112640112641112642112643112644112645112646112647112648112649112650112651112652112653112654112655112656112657112658112659112660112661112662112663112664112665112666112667112668112669112670112671112672112673112674112675112676112677112678112679112680112681112682112683112684112685112686112687112688112689112690112691112692112693112694112695112696112697112698112699112700112701112702112703112704112705112706112707112708112709112710112711112712112713112714112715112716112717112718112719112720112721112722112723112724112725112726112727112728112729112730112731112732112733112734112735112736112737112738112739112740112741112742112743112744112745112746112747112748112749112750112751112752112753112754112755112756112757112758112759112760112761112762112763112764112765112766112767112768112769112770112771112772112773112774112775112776112777112778112779112780112781112782112783112784112785112786112787112788112789112790112791112792112793112794112795112796112797112798112799112800112801112802112803112804112805112806112807112808112809112810112811112812112813112814112815112816112817112818112819112820112821112822112823112824112825112826112827112828112829112830112831112832112833112834112835112836112837112838112839112840112841112842112843112844112845112846112847112848112849112850112851112852112853112854112855112856112857112858112859112860112861112862112863112864112865112866112867112868112869112870112871112872112873112874112875112876112877112878112879112880112881112882112883112884112885112886112887112888112889112890112891112892112893112894112895112896112897112898112899112900112901112902112903112904112905112906112907112908112909112910112911112912112913112914112915112916112917112918112919112920112921112922112923112924112925112926112927112928112929112930112931112932112933112934112935112936112937112938112939112940112941112942112943112944112945112946112947112948112949112950112951112952112953112954112955112956112957112958112959112960112961112962112963112964112965112966112967112968112969112970112971112972112973112974112975112976112977112978112979112980112981112982112983112984112985112986112987112988112989112990112991112992112993112994112995112996112997112998112999113000113001113002113003113004113005113006113007113008113009113010113011113012113013113014113015113016113017113018113019113020113021113022113023113024113025113026113027113028113029113030113031113032113033113034113035113036113037113038113039113040113041113042113043113044113045113046113047113048113049113050113051113052113053113054113055113056113057113058113059113060113061113062113063113064113065113066113067113068113069113070113071113072113073113074113075113076113077113078113079113080113081113082113083113084113085113086113087113088113089113090113091113092113093113094113095113096113097113098113099113100113101113102113103113104113105113106113107113108113109113110113111113112113113113114113115113116113117113118113119113120113121113122113123113124113125113126113127113128113129113130113131113132113133113134113135113136113137113138113139113140113141113142113143113144113145113146113147113148113149113150113151113152113153113154113155113156113157113158113159113160113161113162113163113164113165113166113167113168113169113170113171113172113173113174113175113176113177113178113179113180113181113182113183113184113185113186113187113188113189113190113191113192113193113194113195113196113197113198113199113200113201113202113203113204113205113206113207113208113209113210113211113212113213113214113215113216113217113218113219113220113221113222113223113224113225113226113227113228113229113230113231113232113233113234113235113236113237113238113239113240113241113242113243113244113245113246113247113248113249113250113251113252113253113254113255113256113257113258113259113260113261113262113263113264113265113266113267113268113269113270113271113272113273113274113275113276113277113278113279113280113281113282113283113284113285113286113287113288113289113290113291113292113293113294113295113296113297113298113299113300113301113302113303113304113305113306113307113308113309113310113311113312113313113314113315113316113317113318113319113320113321113322113323113324113325113326113327113328113329113330113331113332113333113334113335113336113337113338113339113340113341113342113343113344113345113346113347113348113349113350113351113352113353113354113355113356113357113358113359113360113361113362113363113364113365113366113367113368113369113370113371113372113373113374113375113376113377113378113379113380113381113382113383113384113385113386113387113388113389113390113391113392113393113394113395113396113397113398113399113400113401113402113403113404113405113406113407113408113409113410113411113412113413113414113415113416113417113418113419113420113421113422113423113424113425113426113427113428113429113430113431113432113433113434113435113436113437113438113439113440113441113442113443113444113445113446113447113448113449113450113451113452113453113454113455113456113457113458113459113460113461113462113463113464113465113466113467113468113469113470113471113472113473113474113475113476113477113478113479113480113481113482113483113484113485113486113487113488113489113490113491113492113493113494113495113496113497113498113499113500113501113502113503113504113505113506113507113508113509113510113511113512113513113514113515113516113517113518113519113520113521113522113523113524113525113526113527113528113529113530113531113532113533113534113535113536113537113538113539113540113541113542113543113544113545113546113547113548113549113550113551113552113553113554113555113556113557113558113559113560113561113562113563113564113565113566113567113568113569113570113571113572113573113574113575113576113577113578113579113580113581113582113583113584113585113586113587113588113589113590113591113592113593113594113595113596113597113598113599113600113601113602113603113604113605113606113607113608113609113610113611113612113613113614113615113616113617113618113619113620113621113622113623113624113625113626113627113628113629113630113631113632113633113634113635113636113637113638113639113640113641113642113643113644113645113646113647113648113649113650113651113652113653113654113655113656113657113658113659113660113661113662113663113664113665113666113667113668113669113670113671113672113673113674113675113676113677113678113679113680113681113682113683113684113685113686113687113688113689113690113691113692113693113694113695113696113697113698113699113700113701113702113703113704113705113706113707113708113709113710113711113712113713113714113715113716113717113718113719113720113721113722113723113724113725113726113727113728113729113730113731113732113733113734113735113736113737113738113739113740113741113742113743113744113745113746113747113748113749113750113751113752113753113754113755113756113757113758113759113760113761113762113763113764113765113766113767113768113769113770113771113772113773113774113775113776113777113778113779113780113781113782113783113784113785113786113787113788113789113790113791113792113793113794113795113796113797113798113799113800113801113802113803113804113805113806113807113808113809113810113811113812113813113814113815113816113817113818113819113820113821113822113823113824113825113826113827113828113829113830113831113832113833113834113835113836113837113838113839113840113841113842113843113844113845113846113847113848113849113850113851113852113853113854113855113856113857113858113859113860113861113862113863113864113865113866113867113868113869113870113871113872113873113874113875113876113877113878113879113880113881113882113883113884113885113886113887113888113889113890113891113892113893113894113895113896113897113898113899113900113901113902113903113904113905113906113907113908113909113910113911113912113913113914113915113916113917113918113919113920113921113922113923113924113925113926113927113928113929113930113931113932113933113934113935113936113937113938113939113940113941113942113943113944113945113946113947113948113949113950113951113952113953113954113955113956113957113958113959113960113961113962113963113964113965113966113967113968113969113970113971113972113973113974113975113976113977113978113979113980113981113982113983113984113985113986113987113988113989113990113991113992113993113994113995113996113997113998113999114000114001114002114003114004114005114006114007114008114009114010114011114012114013114014114015114016114017114018114019114020114021114022114023114024114025114026114027114028114029114030114031114032114033114034114035114036114037114038114039114040114041114042114043114044114045114046114047114048114049114050114051114052114053114054114055114056114057114058114059114060114061114062114063114064114065114066114067114068114069114070114071114072114073114074114075114076114077114078114079114080114081114082114083114084114085114086114087114088114089114090114091114092114093114094114095114096114097114098114099114100114101114102114103114104114105114106114107114108114109114110114111114112114113114114114115114116114117114118114119114120114121114122114123114124114125114126114127114128114129114130114131114132114133114134114135114136114137114138114139114140114141114142114143114144114145114146114147114148114149114150114151114152114153114154114155114156114157114158114159114160114161114162114163114164114165114166114167114168114169114170114171114172114173114174114175114176114177114178114179114180114181114182114183114184114185114186114187114188114189114190114191114192114193114194114195114196114197114198114199114200114201114202114203114204114205114206114207114208114209114210114211114212114213114214114215114216114217114218114219114220114221114222114223114224114225114226114227114228114229114230114231114232114233114234114235114236114237114238114239114240114241114242114243114244114245114246114247114248114249114250114251114252114253114254114255114256114257114258114259114260114261114262114263114264114265114266114267114268114269114270114271114272114273114274114275114276114277114278114279114280114281114282114283114284114285114286114287114288114289114290114291114292114293114294114295114296114297114298114299114300114301114302114303114304114305114306114307114308114309114310114311114312114313114314114315114316114317114318114319114320114321114322114323114324114325114326114327114328114329114330114331114332114333114334114335114336114337114338114339114340114341114342114343114344114345114346114347114348114349114350114351114352114353114354114355114356114357114358114359114360114361114362114363114364114365114366114367114368114369114370114371114372114373114374114375114376114377114378114379114380114381114382114383114384114385114386114387114388114389114390114391114392114393114394114395114396114397114398114399114400114401114402114403114404114405114406114407114408114409114410114411114412114413114414114415114416114417114418114419114420114421114422114423114424114425114426114427114428114429114430114431114432114433114434114435114436114437114438114439114440114441114442114443114444114445114446114447114448114449114450114451114452114453114454114455114456114457114458114459114460114461114462114463114464114465114466114467114468114469114470114471114472114473114474114475114476114477114478114479114480114481114482114483114484114485114486114487114488114489114490114491114492114493114494114495114496114497114498114499114500114501114502114503114504114505114506114507114508114509114510114511114512114513114514114515114516114517114518114519114520114521114522114523114524114525114526114527114528114529114530114531114532114533114534114535114536114537114538114539114540114541114542114543114544114545114546114547114548114549114550114551114552114553114554114555114556114557114558114559114560114561114562114563114564114565114566114567114568114569114570114571114572114573114574114575114576114577114578114579114580114581114582114583114584114585114586114587114588114589114590114591114592114593114594114595114596114597114598114599114600114601114602114603114604114605114606114607114608114609114610114611114612114613114614114615114616114617114618114619114620114621114622114623114624114625114626114627114628114629114630114631114632114633114634114635114636114637114638114639114640114641114642114643114644114645114646114647114648114649114650114651114652114653114654114655114656114657114658114659114660114661114662114663114664114665114666114667114668114669114670114671114672114673114674114675114676114677114678114679114680114681114682114683114684114685114686114687114688114689114690114691114692114693114694114695114696114697114698114699114700114701114702114703114704114705114706114707114708114709114710114711114712114713114714114715114716114717114718114719114720114721114722114723114724114725114726114727114728114729114730114731114732114733114734114735114736114737114738114739114740114741114742114743114744114745114746114747114748114749114750114751114752114753114754114755114756114757114758114759114760114761114762114763114764114765114766114767114768114769114770114771114772114773114774114775114776114777114778114779114780114781114782114783114784114785114786114787114788114789114790114791114792114793114794114795114796114797114798114799114800114801114802114803114804114805114806114807114808114809114810114811114812114813114814114815114816114817114818114819114820114821114822114823114824114825114826114827114828114829114830114831114832114833114834114835114836114837114838114839114840114841114842114843114844114845114846114847114848114849114850114851114852114853114854114855114856114857114858114859114860114861114862114863114864114865114866114867114868114869114870114871114872114873114874114875114876114877114878114879114880114881114882114883114884114885114886114887114888114889114890114891114892114893114894114895114896114897114898114899114900114901114902114903114904114905114906114907114908114909114910114911114912114913114914114915114916114917114918114919114920114921114922114923114924114925114926114927114928114929114930114931114932114933114934114935114936114937114938114939114940114941114942114943114944114945114946114947114948114949114950114951114952114953114954114955114956114957114958114959114960114961114962114963114964114965114966114967114968114969114970114971114972114973114974114975114976114977114978114979114980114981114982114983114984114985114986114987114988114989114990114991114992114993114994114995114996114997114998114999115000115001115002115003115004115005115006115007115008115009115010115011115012115013115014115015115016115017115018115019115020115021115022115023115024115025115026115027115028115029115030115031115032115033115034115035115036115037115038115039115040115041115042115043115044115045115046115047115048115049115050115051115052115053115054115055115056115057115058115059115060115061115062115063115064115065115066115067115068115069115070115071115072115073115074115075115076115077115078115079115080115081115082115083115084115085115086115087115088115089115090115091115092115093115094115095115096115097115098115099115100115101115102115103115104115105115106115107115108115109115110115111115112115113115114115115115116115117115118115119115120115121115122115123115124115125115126115127115128115129115130115131115132115133115134115135115136115137115138115139115140115141115142115143115144115145115146115147115148115149115150115151115152115153115154115155115156115157115158115159115160115161115162115163115164115165115166115167115168115169115170115171115172115173115174115175115176115177115178115179115180115181115182115183115184115185115186115187115188115189115190115191115192115193115194115195115196115197115198115199115200115201115202115203115204115205115206115207115208115209115210115211115212115213115214115215115216115217115218115219115220115221115222115223115224115225115226115227115228115229115230115231115232115233115234115235115236115237115238115239115240115241115242115243115244115245115246115247115248115249115250115251115252115253115254115255115256115257115258115259115260115261115262115263115264115265115266115267115268115269115270115271115272115273115274115275115276115277115278115279115280115281115282115283115284115285115286115287115288115289115290115291115292115293115294115295115296115297115298115299115300115301115302115303115304115305115306115307115308115309115310115311115312115313115314115315115316115317115318115319115320115321115322115323115324115325115326115327115328115329115330115331115332115333115334115335115336115337115338115339115340115341115342115343115344115345115346115347115348115349115350115351115352115353115354115355115356115357115358115359115360115361115362115363115364115365115366115367115368115369115370115371115372115373115374115375115376115377115378115379115380115381115382115383115384115385115386115387115388115389115390115391115392115393115394115395115396115397115398115399115400115401115402115403115404115405115406115407115408115409115410115411115412115413115414115415115416115417115418115419115420115421115422115423115424115425115426115427115428115429115430115431115432115433115434115435115436115437115438115439115440115441115442115443115444115445115446115447115448115449115450115451115452115453115454115455115456115457115458115459115460115461115462115463115464115465115466115467115468115469115470115471115472115473115474115475115476115477115478115479115480115481115482115483115484115485115486115487115488115489115490115491115492115493115494115495115496115497115498115499115500115501115502115503115504115505115506115507115508115509115510115511115512115513115514115515115516115517115518115519115520115521115522115523115524115525115526115527115528115529115530115531115532115533115534115535115536115537115538115539115540115541115542115543115544115545115546115547115548115549115550115551115552115553115554115555115556115557115558115559115560115561115562115563115564115565115566115567115568115569115570115571115572115573115574115575115576115577115578115579115580115581115582115583115584115585115586115587115588115589115590115591115592115593115594115595115596115597115598115599115600115601115602115603115604115605115606115607115608115609115610115611115612115613115614115615115616115617115618115619115620115621115622115623115624115625115626115627115628115629115630115631115632115633115634115635115636115637115638115639115640115641115642115643115644115645115646115647115648115649115650115651115652115653115654115655115656115657115658115659115660115661115662115663115664115665115666115667115668115669115670115671115672115673115674115675115676115677115678115679115680115681115682115683115684115685115686115687115688115689115690115691115692115693115694115695115696115697115698115699115700115701115702115703115704115705115706115707115708115709115710115711115712115713115714115715115716115717115718115719115720115721115722115723115724115725115726115727115728115729115730115731115732115733115734115735115736115737115738115739115740115741115742115743115744115745115746115747115748115749115750115751115752115753115754115755115756115757115758115759115760115761115762115763115764115765115766115767115768115769115770115771115772115773115774115775115776115777115778115779115780115781115782115783115784115785115786115787115788115789115790115791115792115793115794115795115796115797115798115799115800115801115802115803115804115805115806115807115808115809115810115811115812115813115814115815115816115817115818115819115820115821115822115823115824115825115826115827115828115829115830115831115832115833115834115835115836115837115838115839115840115841115842115843115844115845115846115847115848115849115850115851115852115853115854115855115856115857115858115859115860115861115862115863115864115865115866115867115868115869115870115871115872115873115874115875115876115877115878115879115880115881115882115883115884115885115886115887115888115889115890115891115892115893115894115895115896115897115898115899115900115901115902115903115904115905115906115907115908115909115910115911115912115913115914115915115916115917115918115919115920115921115922115923115924115925115926115927115928115929115930115931115932115933115934115935115936115937115938115939115940115941115942115943115944115945115946115947115948115949115950115951115952115953115954115955115956115957115958115959115960115961115962115963115964115965115966115967115968115969115970115971115972115973115974115975115976115977115978115979115980115981115982115983115984115985115986115987115988115989115990115991115992115993115994115995115996115997115998115999116000116001116002116003116004116005116006116007116008116009116010116011116012116013116014116015116016116017116018116019116020116021116022116023116024116025116026116027116028116029116030116031116032116033116034116035116036116037116038116039116040116041116042116043116044116045116046116047116048116049116050116051116052116053116054116055116056116057116058116059116060116061116062116063116064116065116066116067116068116069116070116071116072116073116074116075116076116077116078116079116080116081116082116083116084116085116086116087116088116089116090116091116092116093116094116095116096116097116098116099116100116101116102116103116104116105116106116107116108116109116110116111116112116113116114116115116116116117116118116119116120116121116122116123116124116125116126116127116128116129116130116131116132116133116134116135116136116137116138116139116140116141116142116143116144116145116146116147116148116149116150116151116152116153116154116155116156116157116158116159116160116161116162116163116164116165116166116167116168116169116170116171116172116173116174116175116176116177116178116179116180116181116182116183116184116185116186116187116188116189116190116191116192116193116194116195116196116197116198116199116200116201116202116203116204116205116206116207116208116209116210116211116212116213116214116215116216116217116218116219116220116221116222116223116224116225116226116227116228116229116230116231116232116233116234116235116236116237116238116239116240116241116242116243116244116245116246116247116248116249116250116251116252116253116254116255116256116257116258116259116260116261116262116263116264116265116266116267116268116269116270116271116272116273116274116275116276116277116278116279116280116281116282116283116284116285116286116287116288116289116290116291116292116293116294116295116296116297116298116299116300116301116302116303116304116305116306116307116308116309116310116311116312116313116314116315116316116317116318116319116320116321116322116323116324116325116326116327116328116329116330116331116332116333116334116335116336116337116338116339116340116341116342116343116344116345116346116347116348116349116350116351116352116353116354116355116356116357116358116359116360116361116362116363116364116365116366116367116368116369116370116371116372116373116374116375116376116377116378116379116380116381116382116383116384116385116386116387116388116389116390116391116392116393116394116395116396116397116398116399116400116401116402116403116404116405116406116407116408116409116410116411116412116413116414116415116416116417116418116419116420116421116422116423116424116425116426116427116428116429116430116431116432116433116434116435116436116437116438116439116440116441116442116443116444116445116446116447116448116449116450116451116452116453116454116455116456116457116458116459116460116461116462116463116464116465116466116467116468116469116470116471116472116473116474116475116476116477116478116479116480116481116482116483116484116485116486116487116488116489116490116491116492116493116494116495116496116497116498116499116500116501116502116503116504116505116506116507116508116509116510116511116512116513116514116515116516116517116518116519116520116521116522116523116524116525116526116527116528116529116530116531116532116533116534116535116536116537116538116539116540116541116542116543116544116545116546116547116548116549116550116551116552116553116554116555116556116557116558116559116560116561116562116563116564116565116566116567116568116569116570116571116572116573116574116575116576116577116578116579116580116581116582116583116584116585116586116587116588116589116590116591116592116593116594116595116596116597116598116599116600116601116602116603116604116605116606116607116608116609116610116611116612116613116614116615116616116617116618116619116620116621116622116623116624116625116626116627116628116629116630116631116632116633116634116635116636116637116638116639116640116641116642116643116644116645116646116647116648116649116650116651116652116653116654116655116656116657116658116659116660116661116662116663116664116665116666116667116668116669116670116671116672116673116674116675116676116677116678116679116680116681116682116683116684116685116686116687116688116689116690116691116692116693116694116695116696116697116698116699116700116701116702116703116704116705116706116707116708116709116710116711116712116713116714116715116716116717116718116719116720116721116722116723116724116725116726116727116728116729116730116731116732116733116734116735116736116737116738116739116740116741116742116743116744116745116746116747116748116749116750116751116752116753116754116755116756116757116758116759116760116761116762116763116764116765116766116767116768116769116770116771116772116773116774116775116776116777116778116779116780116781116782116783116784116785116786116787116788116789116790116791116792116793116794116795116796116797116798116799116800116801116802116803116804116805116806116807116808116809116810116811116812116813116814116815116816116817116818116819116820116821116822116823116824116825116826116827116828116829116830116831116832116833116834116835116836116837116838116839116840116841116842116843116844116845116846116847116848116849116850116851116852116853116854116855116856116857116858116859116860116861116862116863116864116865116866116867116868116869116870116871116872116873116874116875116876116877116878116879116880116881116882116883116884116885116886116887116888116889116890116891116892116893116894116895116896116897116898116899116900116901116902116903116904116905116906116907116908116909116910116911116912116913116914116915116916116917116918116919116920116921116922116923116924116925116926116927116928116929116930116931116932116933116934116935116936116937116938116939116940116941116942116943116944116945116946116947116948116949116950116951116952116953116954116955116956116957116958116959116960116961116962116963116964116965116966116967116968116969116970116971116972116973116974116975116976116977116978116979116980116981116982116983116984116985116986116987116988116989116990116991116992116993116994116995116996116997116998116999117000117001117002117003117004117005117006117007117008117009117010117011117012117013117014117015117016117017117018117019117020117021117022117023117024117025117026117027117028117029117030117031117032117033117034117035117036117037117038117039117040117041117042117043117044117045117046117047117048117049117050117051117052117053117054117055117056117057117058117059117060117061117062117063117064117065117066117067117068117069117070117071117072117073117074117075117076117077117078117079117080117081117082117083117084117085117086117087117088117089117090117091117092117093117094117095117096117097117098117099117100117101117102117103117104117105117106117107117108117109117110117111117112117113117114117115117116117117117118117119117120117121117122117123117124117125117126117127117128117129117130117131117132117133117134117135117136117137117138117139117140117141117142117143117144117145117146117147117148117149117150117151117152117153117154117155117156117157117158117159117160117161117162117163117164117165117166117167117168117169117170117171117172117173117174117175117176117177117178117179117180117181117182117183117184117185117186117187117188117189117190117191117192117193117194117195117196117197117198117199117200117201117202117203117204117205117206117207117208117209117210117211117212117213117214117215117216117217117218117219117220117221117222117223117224117225117226117227117228117229117230117231117232117233117234117235117236117237117238117239117240117241117242117243117244117245117246117247117248117249117250117251117252117253117254117255117256117257117258117259117260117261117262117263117264117265117266117267117268117269117270117271117272117273117274117275117276117277117278117279117280117281117282117283117284117285117286117287117288117289117290117291117292117293117294117295117296117297117298117299117300117301117302117303117304117305117306117307117308117309117310117311117312117313117314117315117316117317117318117319117320117321117322117323117324117325117326117327117328117329117330117331117332117333117334117335117336117337117338117339117340117341117342117343117344117345117346117347117348117349117350117351117352117353117354117355117356117357117358117359117360117361117362117363117364117365117366117367117368117369117370117371117372117373117374117375117376117377117378117379117380117381117382117383117384117385117386117387117388117389117390117391117392117393117394117395117396117397117398117399117400117401117402117403117404117405117406117407117408117409117410117411117412117413117414117415117416117417117418117419117420117421117422117423117424117425117426117427117428117429117430117431117432117433117434117435117436117437117438117439117440117441117442117443117444117445117446117447117448117449117450117451117452117453117454117455117456117457117458117459117460117461117462117463117464117465117466117467117468117469117470117471117472117473117474117475117476117477117478117479117480117481117482117483117484117485117486117487117488117489117490117491117492117493117494117495117496117497117498117499117500117501117502117503117504117505117506117507117508117509117510117511117512117513117514117515117516117517117518117519117520117521117522117523117524117525117526117527117528117529117530117531117532117533117534117535117536117537117538117539117540117541117542117543117544117545117546117547117548117549117550117551117552117553117554117555117556117557117558117559117560117561117562117563117564117565117566117567117568117569117570117571117572117573117574117575117576117577117578117579117580117581117582117583117584117585117586117587117588117589117590117591117592117593117594117595117596117597117598117599117600117601117602117603117604117605117606117607117608117609117610117611117612117613117614117615117616117617117618117619117620117621117622117623117624117625117626117627117628117629117630117631117632117633117634117635117636117637117638117639117640117641117642117643117644117645117646117647117648117649117650117651117652117653117654117655117656117657117658117659117660117661117662117663117664117665117666117667117668117669117670117671117672117673117674117675117676117677117678117679117680117681117682117683117684117685117686117687117688117689117690117691117692117693117694117695117696117697117698117699117700117701117702117703117704117705117706117707117708117709117710117711117712117713117714117715117716117717117718117719117720117721117722117723117724117725117726117727117728117729117730117731117732117733117734117735117736117737117738117739117740117741117742117743117744117745117746117747117748117749117750117751117752117753117754117755117756117757117758117759117760117761117762117763117764117765117766117767117768117769117770117771117772117773117774117775117776117777117778117779117780117781117782117783117784117785117786117787117788117789117790117791117792117793117794117795117796117797117798117799117800117801117802117803117804117805117806117807117808117809117810117811117812117813117814117815117816117817117818117819117820117821117822117823117824117825117826117827117828117829117830117831117832117833117834117835117836117837117838117839117840117841117842117843117844117845117846117847117848117849117850117851117852117853117854117855117856117857117858117859117860117861117862117863117864117865117866117867117868117869117870117871117872117873117874117875117876117877117878117879117880117881117882117883117884117885117886117887117888117889117890117891117892117893117894117895117896117897117898117899117900117901117902117903117904117905117906117907117908117909117910117911117912117913117914117915117916117917117918117919117920117921117922117923117924117925117926117927117928117929117930117931117932117933117934117935117936117937117938117939117940117941117942117943117944117945117946117947117948117949117950117951117952117953117954117955117956117957117958117959117960117961117962117963117964117965117966117967117968117969117970117971117972117973117974117975117976117977117978117979117980117981117982117983117984117985117986117987117988117989117990117991117992117993117994117995117996117997117998117999118000118001118002118003118004118005118006118007118008118009118010118011118012118013118014118015118016118017118018118019118020118021118022118023118024118025118026118027118028118029118030118031118032118033118034118035118036118037118038118039118040118041118042118043118044118045118046118047118048118049118050118051118052118053118054118055118056118057118058118059118060118061118062118063118064118065118066118067118068118069118070118071118072118073118074118075118076118077118078118079118080118081118082118083118084118085118086118087118088118089118090118091118092118093118094118095118096118097118098118099118100118101118102118103118104118105118106118107118108118109118110118111118112118113118114118115118116118117118118118119118120118121118122118123118124118125118126118127118128118129118130118131118132118133118134118135118136118137118138118139118140118141118142118143118144118145118146118147118148118149118150118151118152118153118154118155118156118157118158118159118160118161118162118163118164118165118166118167118168118169118170118171118172118173118174118175118176118177118178118179118180118181118182118183118184118185118186118187118188118189118190118191118192118193118194118195118196118197118198118199118200118201118202118203118204118205118206118207118208118209118210118211118212118213118214118215118216118217118218118219118220118221118222118223118224118225118226118227118228118229118230118231118232118233118234118235118236118237118238118239118240118241118242118243118244118245118246118247118248118249118250118251118252118253118254118255118256118257118258118259118260118261118262118263118264118265118266118267118268118269118270118271118272118273118274118275118276118277118278118279118280118281118282118283118284118285118286118287118288118289118290118291118292118293118294118295118296118297118298118299118300118301118302118303118304118305118306118307118308118309118310118311118312118313118314118315118316118317118318118319118320118321118322118323118324118325118326118327118328118329118330118331118332118333118334118335118336118337118338118339118340118341118342118343118344118345118346118347118348118349118350118351118352118353118354118355118356118357118358118359118360118361118362118363118364118365118366118367118368118369118370118371118372118373118374118375118376118377118378118379118380118381118382118383118384118385118386118387118388118389118390118391118392118393118394118395118396118397118398118399118400118401118402118403118404118405118406118407118408118409118410118411118412118413118414118415118416118417118418118419118420118421118422118423118424118425118426118427118428118429118430118431118432118433118434118435118436118437118438118439118440118441118442118443118444118445118446118447118448118449118450118451118452118453118454118455118456118457118458118459118460118461118462118463118464118465118466118467118468118469118470118471118472118473118474118475118476118477118478118479118480118481118482118483118484118485118486118487118488118489118490118491118492118493118494118495118496118497118498118499118500118501118502118503118504118505118506118507118508118509118510118511118512118513118514118515118516118517118518118519118520118521118522118523118524118525118526118527118528118529118530118531118532118533118534118535118536118537118538118539118540118541118542118543118544118545118546118547118548118549118550118551118552118553118554118555118556118557118558118559118560118561118562118563118564118565118566118567118568118569118570118571118572118573118574118575118576118577118578118579118580118581118582118583118584118585118586118587118588118589118590118591118592118593118594118595118596118597118598118599118600118601118602118603118604118605118606118607118608118609118610118611118612118613118614118615118616118617118618118619118620118621118622118623118624118625118626118627118628118629118630118631118632118633118634118635118636118637118638118639118640118641118642118643118644118645118646118647118648118649118650118651118652118653118654118655118656118657118658118659118660118661118662118663118664118665118666118667118668118669118670118671118672118673118674118675118676118677118678118679118680118681118682118683118684118685118686118687118688118689118690118691118692118693118694118695118696118697118698118699118700118701118702118703118704118705118706118707118708118709118710118711118712118713118714118715118716118717118718118719118720118721118722118723118724118725118726118727118728118729118730118731118732118733118734118735118736118737118738118739118740118741118742118743118744118745118746118747118748118749118750118751118752118753118754118755118756118757118758118759118760118761118762118763118764118765118766118767118768118769118770118771118772118773118774118775118776118777118778118779118780118781118782118783118784118785118786118787118788118789118790118791118792118793118794118795118796118797118798118799118800118801118802118803118804118805118806118807118808118809118810118811118812118813118814118815118816118817118818118819118820118821118822118823118824118825118826118827118828118829118830118831118832118833118834118835118836118837118838118839118840118841118842118843118844118845118846118847118848118849118850118851118852118853118854118855118856118857118858118859118860118861118862118863118864118865118866118867118868118869118870118871118872118873118874118875118876118877118878118879118880118881118882118883118884118885118886118887118888118889118890118891118892118893118894118895118896118897118898118899118900118901118902118903118904118905118906118907118908118909118910118911118912118913118914118915118916118917118918118919118920118921118922118923118924118925118926118927118928118929118930118931118932118933118934118935118936118937118938118939118940118941118942118943118944118945118946118947118948118949118950118951118952118953118954118955118956118957118958118959118960118961118962118963118964118965118966118967118968118969118970118971118972118973118974118975118976118977118978118979118980118981118982118983118984118985118986118987118988118989118990118991118992118993118994118995118996118997118998118999119000119001119002119003119004119005119006119007119008119009119010119011119012119013119014119015119016119017119018119019119020119021119022119023119024119025119026119027119028119029119030119031119032119033119034119035119036119037119038119039119040119041119042119043119044119045119046119047119048119049119050119051119052119053119054119055119056119057119058119059119060119061119062119063119064119065119066119067119068119069119070119071119072119073119074119075119076119077119078119079119080119081119082119083119084119085119086119087119088119089119090119091119092119093119094119095119096119097119098119099119100119101119102119103119104119105119106119107119108119109119110119111119112119113119114119115119116119117119118119119119120119121119122119123119124119125119126119127119128119129119130119131119132119133119134119135119136119137119138119139119140119141119142119143119144119145119146119147119148119149119150119151119152119153119154119155119156119157119158119159119160119161119162119163119164119165119166119167119168119169119170119171119172119173119174119175119176119177119178119179119180119181119182119183119184119185119186119187119188119189119190119191119192119193119194119195119196119197119198119199119200119201119202119203119204119205119206119207119208119209119210119211119212119213119214119215119216119217119218119219119220119221119222119223119224119225119226119227119228119229119230119231119232119233119234119235119236119237119238119239119240119241119242119243119244119245119246119247119248119249119250119251119252119253119254119255119256119257119258119259119260119261119262119263119264119265119266119267119268119269119270119271119272119273119274119275119276119277119278119279119280119281119282119283119284119285119286119287119288119289119290119291119292119293119294119295119296119297119298119299119300119301119302119303119304119305119306119307119308119309119310119311119312119313119314119315119316119317119318119319119320119321119322119323119324119325119326119327119328119329119330119331119332119333119334119335119336119337119338119339119340119341119342119343119344119345119346119347119348119349119350119351119352119353119354119355119356119357119358119359119360119361119362119363119364119365119366119367119368119369119370119371119372119373119374119375119376119377119378119379119380119381119382119383119384119385119386119387119388119389119390119391119392119393119394119395119396119397119398119399119400119401119402119403119404119405119406119407119408119409119410119411119412119413119414119415119416119417119418119419119420119421119422119423119424119425119426119427119428119429119430119431119432119433119434119435119436119437119438119439119440119441119442119443119444119445119446119447119448119449119450119451119452119453119454119455119456119457119458119459119460119461119462119463119464119465119466119467119468119469119470119471119472119473119474119475119476119477119478119479119480119481119482119483119484119485119486119487119488119489119490119491119492119493119494119495119496119497119498119499119500119501119502119503119504119505119506119507119508119509119510119511119512119513119514119515119516119517119518119519119520119521119522119523119524119525119526119527119528119529119530119531119532119533119534119535119536119537119538119539119540119541119542119543119544119545119546119547119548119549119550119551119552119553119554119555119556119557119558119559119560119561119562119563119564119565119566119567119568119569119570119571119572119573119574119575119576119577119578119579119580119581119582119583119584119585119586119587119588119589119590119591119592119593119594119595119596119597119598119599119600119601119602119603119604119605119606119607119608119609119610119611119612119613119614119615119616119617119618119619119620119621119622119623119624119625119626119627119628119629119630119631119632119633119634119635119636119637119638119639119640119641119642119643119644119645119646119647119648119649119650119651119652119653119654119655119656119657119658119659119660119661119662119663119664119665119666119667119668119669119670119671119672119673119674119675119676119677119678119679119680119681119682119683119684119685119686119687119688119689119690119691119692119693119694119695119696119697119698119699119700119701119702119703119704119705119706119707119708119709119710119711119712119713119714119715119716119717119718119719119720119721119722119723119724119725119726119727119728119729119730119731119732119733119734119735119736119737119738119739119740119741119742119743119744119745119746119747119748119749119750119751119752119753119754119755119756119757119758119759119760119761119762119763119764119765119766119767119768119769119770119771119772119773119774119775119776119777119778119779119780119781119782119783119784119785119786119787119788119789119790119791119792119793119794119795119796119797119798119799119800119801119802119803119804119805119806119807119808119809119810119811119812119813119814119815119816119817119818119819119820119821119822119823119824119825119826119827119828119829119830119831119832119833119834119835119836119837119838119839119840119841119842119843119844119845119846119847119848119849119850119851119852119853119854119855119856119857119858119859119860119861119862119863119864119865119866119867119868119869119870119871119872119873119874119875119876119877119878119879119880119881119882119883119884119885119886119887119888119889119890119891119892119893119894119895119896119897119898119899119900119901119902119903119904119905119906119907119908119909119910119911119912119913119914119915119916119917119918119919119920119921119922119923119924119925119926119927119928119929119930119931119932119933119934119935119936119937119938119939119940119941119942119943119944119945119946119947119948119949119950119951119952119953119954119955119956119957119958119959119960119961119962119963119964119965119966119967119968119969119970119971119972119973119974119975119976119977119978119979119980119981119982119983119984119985119986119987119988119989119990119991119992119993119994119995119996119997119998119999120000120001120002120003120004120005120006120007120008120009120010120011120012120013120014120015120016120017120018120019120020120021120022120023120024120025120026120027120028120029120030120031120032120033120034120035120036120037120038120039120040120041120042120043120044120045120046120047120048120049120050120051120052120053120054120055120056120057120058120059120060120061120062120063120064120065120066120067120068120069120070120071120072120073120074120075120076120077120078120079120080120081120082120083120084120085120086120087120088120089120090120091120092120093120094120095120096120097120098120099120100120101120102120103120104120105120106120107120108120109120110120111120112120113120114120115120116120117120118120119120120120121120122120123120124120125120126120127120128120129120130120131120132120133120134120135120136120137120138120139120140120141120142120143120144120145120146120147120148120149120150120151120152120153120154120155120156120157120158120159120160120161120162120163120164120165120166120167120168120169120170120171120172120173120174120175120176120177120178120179120180120181120182120183120184120185120186120187120188120189120190120191120192120193120194120195120196120197120198120199120200120201120202120203120204120205120206120207120208120209120210120211120212120213120214120215120216120217120218120219120220120221120222120223120224120225120226120227120228120229120230120231120232120233120234120235120236120237120238120239120240120241120242120243120244120245120246120247120248120249120250120251120252120253120254120255120256120257120258120259120260120261120262120263120264120265120266120267120268120269120270120271120272120273120274120275120276120277120278120279120280120281120282120283120284120285120286120287120288120289120290120291120292120293120294120295120296120297120298120299120300120301120302120303120304120305120306120307120308120309120310120311120312120313120314120315120316120317120318120319120320120321120322120323120324120325120326120327120328120329120330120331120332120333120334120335120336120337120338120339120340120341120342120343120344120345120346120347120348120349120350120351120352120353120354120355120356120357120358120359120360120361120362120363120364120365120366120367120368120369120370120371120372120373120374120375120376120377120378120379120380120381120382120383120384120385120386120387120388120389120390120391120392120393120394120395120396120397120398120399120400120401120402120403120404120405120406120407120408120409120410120411120412120413120414120415120416120417120418120419120420120421120422120423120424120425120426120427120428120429120430120431120432120433120434120435120436120437120438120439120440120441120442120443120444120445120446120447120448120449120450120451120452120453120454120455120456120457120458120459120460120461120462120463120464120465120466120467120468120469120470120471120472120473120474120475120476120477120478120479120480120481120482120483120484120485120486120487120488120489120490120491120492120493120494120495120496120497120498120499120500120501120502120503120504120505120506120507120508120509120510120511120512120513120514120515120516120517120518120519120520120521120522120523120524120525120526120527120528120529120530120531120532120533120534120535120536120537120538120539120540120541120542120543120544120545120546120547120548120549120550120551120552120553120554120555120556120557120558120559120560120561120562120563120564120565120566120567120568120569120570120571120572120573120574120575120576120577120578120579120580120581120582120583120584120585120586120587120588120589120590120591120592120593120594120595120596120597120598120599120600120601120602120603120604120605120606120607120608120609120610120611120612120613120614120615120616120617120618120619120620120621120622120623120624120625120626120627120628120629120630120631120632120633120634120635120636120637120638120639120640120641120642120643120644120645120646120647120648120649120650120651120652120653120654120655120656120657120658120659120660120661120662120663120664120665120666120667120668120669120670120671120672120673120674120675120676120677120678120679120680120681120682120683120684120685120686120687120688120689120690120691120692120693120694120695120696120697120698120699120700120701120702120703120704120705120706120707120708120709120710120711120712120713120714120715120716120717120718120719120720120721120722120723120724120725120726120727120728120729120730120731120732120733120734120735120736120737120738120739120740120741120742120743120744120745120746120747120748120749120750120751120752120753120754120755120756120757120758120759120760120761120762120763120764120765120766120767120768120769120770120771120772120773120774120775120776120777120778120779120780120781120782120783120784120785120786120787120788120789120790120791120792120793120794120795120796120797120798120799120800120801120802120803120804120805120806120807120808120809120810120811120812120813120814120815120816120817120818120819120820120821120822120823120824120825120826120827120828120829120830120831120832120833120834120835120836120837120838120839120840120841120842120843120844120845120846120847120848120849120850120851120852120853120854120855120856120857120858120859120860120861120862120863120864120865120866120867120868120869120870120871120872120873120874120875120876120877120878120879120880120881120882120883120884120885120886120887120888120889120890120891120892120893120894120895120896120897120898120899120900120901120902120903120904120905120906120907120908120909120910120911120912120913120914120915120916120917120918120919120920120921120922120923120924120925120926120927120928120929120930120931120932120933120934120935120936120937120938120939120940120941120942120943120944120945120946120947120948120949120950120951120952120953120954120955120956120957120958120959120960120961120962120963120964120965120966120967120968120969120970120971120972120973120974120975120976120977120978120979120980120981120982120983120984120985120986120987120988120989120990120991120992120993120994120995120996120997120998120999121000121001121002121003121004121005121006121007121008121009121010121011121012121013121014121015121016121017121018121019121020121021121022121023121024121025121026121027121028121029121030121031121032121033121034121035121036121037121038121039121040121041121042121043121044121045121046121047121048121049121050121051121052121053121054121055121056121057121058121059121060121061121062121063121064121065121066121067121068121069121070121071121072121073121074121075121076121077121078121079121080121081121082121083121084121085121086121087121088121089121090121091121092121093121094121095121096121097121098121099121100121101121102121103121104121105121106121107121108121109121110121111121112121113121114121115121116121117121118121119121120121121121122121123121124121125121126121127121128121129121130121131121132121133121134121135121136121137121138121139121140121141121142121143121144121145121146121147121148121149121150121151121152121153121154121155121156121157121158121159121160121161121162121163121164121165121166121167121168121169121170121171121172121173121174121175121176121177121178121179121180121181121182121183121184121185121186121187121188121189121190121191121192121193121194121195121196121197121198121199121200121201121202121203121204121205121206121207121208121209121210121211121212121213121214121215121216121217121218121219121220121221121222121223121224121225121226121227121228121229121230121231121232121233121234121235121236121237121238121239121240121241121242121243121244121245121246121247121248121249121250121251121252121253121254121255121256121257121258121259121260121261121262121263121264121265121266121267121268121269121270121271121272121273121274121275121276121277121278121279121280121281121282121283121284121285121286121287121288121289121290121291121292121293121294121295121296121297121298121299121300121301121302121303121304121305121306121307121308121309121310121311121312121313121314121315121316121317121318121319121320121321121322121323121324121325121326121327121328121329121330121331121332121333121334121335121336121337121338121339121340121341121342121343121344121345121346121347121348121349121350121351121352121353121354121355121356121357121358121359121360121361121362121363121364121365121366121367121368121369121370121371121372121373121374121375121376121377121378121379121380121381121382121383121384121385121386121387121388121389121390121391121392121393121394121395121396121397121398121399121400121401121402121403121404121405121406121407121408121409121410121411121412121413121414121415121416121417121418121419121420121421121422121423121424121425121426121427121428121429121430121431121432121433121434121435121436121437121438121439121440121441121442121443121444121445121446121447121448121449121450121451121452121453121454121455121456121457121458121459121460121461121462121463121464121465121466121467121468121469121470121471121472121473121474121475121476121477121478121479121480121481121482121483121484121485121486121487121488121489121490121491121492121493121494121495121496121497121498121499121500121501121502121503121504121505121506121507121508121509121510121511121512121513121514121515121516121517121518121519121520121521121522121523121524121525121526121527121528121529121530121531121532121533121534121535121536121537121538121539121540121541121542121543121544121545121546121547121548121549121550121551121552121553121554121555121556121557121558121559121560121561121562121563121564121565121566121567121568121569121570121571121572121573121574121575121576121577121578121579121580121581121582121583121584121585121586121587121588121589121590121591121592121593121594121595121596121597121598121599121600121601121602121603121604121605121606121607121608121609121610121611121612121613121614121615121616121617121618121619121620121621121622121623121624121625121626121627121628121629121630121631121632121633121634121635121636121637121638121639121640121641121642121643121644121645121646121647121648121649121650121651121652121653121654121655121656121657121658121659121660121661121662121663121664121665121666121667121668121669121670121671121672121673121674121675121676121677121678121679121680121681121682121683121684121685121686121687121688121689121690121691121692121693121694121695121696121697121698121699121700121701121702121703121704121705121706121707121708121709121710121711121712121713121714121715121716121717121718121719121720121721121722121723121724121725121726121727121728121729121730121731121732121733121734121735121736121737121738121739121740121741121742121743121744121745121746121747121748121749121750121751121752121753121754121755121756121757121758121759121760121761121762121763121764121765121766121767121768121769121770121771121772121773121774121775121776121777121778121779121780121781121782121783121784121785121786121787121788121789121790121791121792121793121794121795121796121797121798121799121800121801121802121803121804121805121806121807121808121809121810121811121812121813121814121815121816121817121818121819121820121821121822121823121824121825121826121827121828121829121830121831121832121833121834121835121836121837121838121839121840121841121842121843121844121845121846121847121848121849121850121851121852121853121854121855121856121857121858121859121860121861121862121863121864121865121866121867121868121869121870121871121872121873121874121875121876121877121878121879121880121881121882121883121884121885121886121887121888121889121890121891121892121893121894121895121896121897121898121899121900121901121902121903121904121905121906121907121908121909121910121911121912121913121914121915121916121917121918121919121920121921121922121923121924121925121926121927121928121929121930121931121932121933121934121935121936121937121938121939121940121941121942121943121944121945121946121947121948121949121950121951121952121953121954121955121956121957121958121959121960121961121962121963121964121965121966121967121968121969121970121971121972121973121974121975121976121977121978121979121980121981121982121983121984121985121986121987121988121989121990121991121992121993121994121995121996121997121998121999122000122001122002122003122004122005122006122007122008122009122010122011122012122013122014122015122016122017122018122019122020122021122022122023122024122025122026122027122028122029122030122031122032122033122034122035122036122037122038122039122040122041122042122043122044122045122046122047122048122049122050122051122052122053122054122055122056122057122058122059122060122061122062122063122064122065122066122067122068122069122070122071122072122073122074122075122076122077122078122079122080122081122082122083122084122085122086122087122088122089122090122091122092122093122094122095122096122097122098122099122100122101122102122103122104122105122106122107122108122109122110122111122112122113122114122115122116122117122118122119122120122121122122122123122124122125122126122127122128122129122130122131122132122133122134122135122136122137122138122139122140122141122142122143122144122145122146122147122148122149122150122151122152122153122154122155122156122157122158122159122160122161122162122163122164122165122166122167122168122169122170122171122172122173122174122175122176122177122178122179122180122181122182122183122184122185122186122187122188122189122190122191122192122193122194122195122196122197122198122199122200122201122202122203122204122205122206122207122208122209122210122211122212122213122214122215122216122217122218122219122220122221122222122223122224122225122226122227122228122229122230122231122232122233122234122235122236122237122238122239122240122241122242122243122244122245122246122247122248122249122250122251122252122253122254122255122256122257122258122259122260122261122262122263122264122265122266122267122268122269122270122271122272122273122274122275122276122277122278122279122280122281122282122283122284122285122286122287122288122289122290122291122292122293122294122295122296122297122298122299122300122301122302122303122304122305122306122307122308122309122310122311122312122313122314122315122316122317122318122319122320122321122322122323122324122325122326122327122328122329122330122331122332122333122334122335122336122337122338122339122340122341122342122343122344122345122346122347122348122349122350122351122352122353122354122355122356122357122358122359122360122361122362122363122364122365122366122367122368122369122370122371122372122373122374122375122376122377122378122379122380122381122382122383122384122385122386122387122388122389122390122391122392122393122394122395122396122397122398122399122400122401122402122403122404122405122406122407122408122409122410122411122412122413122414122415122416122417122418122419122420122421122422122423122424122425122426122427122428122429122430122431122432122433122434122435122436122437122438122439122440122441122442122443122444122445122446122447122448122449122450122451122452122453122454122455122456122457122458122459122460122461122462122463122464122465122466122467122468122469122470122471122472122473122474122475122476122477122478122479122480122481122482122483122484122485122486122487122488122489122490122491122492122493122494122495122496122497122498122499122500122501122502122503122504122505122506122507122508122509122510122511122512122513122514122515122516122517122518122519122520122521122522122523122524122525122526122527122528122529122530122531122532122533122534122535122536122537122538122539122540122541122542122543122544122545122546122547122548122549122550122551122552122553122554122555122556122557122558122559122560122561122562122563122564122565122566122567122568122569122570122571122572122573122574122575122576122577122578122579122580122581122582122583122584122585122586122587122588122589122590122591122592122593122594122595122596122597122598122599122600122601122602122603122604122605122606122607122608122609122610122611122612122613122614122615122616122617122618122619122620122621122622122623122624122625122626122627122628122629122630122631122632122633122634122635122636122637122638122639122640122641122642122643122644122645122646122647122648122649122650122651122652122653122654122655122656122657122658122659122660122661122662122663122664122665122666122667122668122669122670122671122672122673122674122675122676122677122678122679122680122681122682122683122684122685122686122687122688122689122690122691122692122693122694122695122696122697122698122699122700122701122702122703122704122705122706122707122708122709122710122711122712122713122714122715122716122717122718122719122720122721122722122723122724122725122726122727122728122729122730122731122732122733122734122735122736122737122738122739122740122741122742122743122744122745122746122747122748122749122750122751122752122753122754122755122756122757122758122759122760122761122762122763122764122765122766122767122768122769122770122771122772122773122774122775122776122777122778122779122780122781122782122783122784122785122786122787122788122789122790122791122792122793122794122795122796122797122798122799122800122801122802122803122804122805122806122807122808122809122810122811122812122813122814122815122816122817122818122819122820122821122822122823122824122825122826122827122828122829122830122831122832122833122834122835122836122837122838122839122840122841122842122843122844122845122846122847122848122849122850122851122852122853122854122855122856122857122858122859122860122861122862122863122864122865122866122867122868122869122870122871122872122873122874122875122876122877122878122879122880122881122882122883122884122885122886122887122888122889122890122891122892122893122894122895122896122897122898122899122900122901122902122903122904122905122906122907122908122909122910122911122912122913122914122915122916122917122918122919122920122921122922122923122924122925122926122927122928122929122930122931122932122933122934122935122936122937122938122939122940122941122942122943122944122945122946122947122948122949122950122951122952122953122954122955122956122957122958122959122960122961122962122963122964122965122966122967122968122969122970122971122972122973122974122975122976122977122978122979122980122981122982122983122984122985122986122987122988122989122990122991122992122993122994122995122996122997122998122999123000123001123002123003123004123005123006123007123008123009123010123011123012123013123014123015123016123017123018123019123020123021123022123023123024123025123026123027123028123029123030123031123032123033123034123035123036123037123038123039123040123041123042123043123044123045123046123047123048123049123050123051123052123053123054123055123056123057123058123059123060123061123062123063123064123065123066123067123068123069123070123071123072123073123074123075123076123077123078123079123080123081123082123083123084123085123086123087123088123089123090123091123092123093123094123095123096123097123098123099123100123101123102123103123104123105123106123107123108123109123110123111123112123113123114123115123116123117123118123119123120123121123122123123123124123125123126123127123128123129123130123131123132123133123134123135123136123137123138123139123140123141123142123143123144123145123146123147123148123149123150123151123152123153123154123155123156123157123158123159123160123161123162123163123164123165123166123167123168123169123170123171123172123173123174123175123176123177123178123179123180123181123182123183123184123185123186123187123188123189123190123191123192123193123194123195123196123197123198123199123200123201123202123203123204123205123206123207123208123209123210123211123212123213123214123215123216123217123218123219123220123221123222123223123224123225123226123227123228123229123230123231123232123233123234123235123236123237123238123239123240123241123242123243123244123245123246123247123248123249123250123251123252123253123254123255123256123257123258123259123260123261123262123263123264123265123266123267123268123269123270123271123272123273123274123275123276123277123278123279123280123281123282123283123284123285123286123287123288123289123290123291123292123293123294123295123296123297123298123299123300123301123302123303123304123305123306123307123308123309123310123311123312123313123314123315123316123317123318123319123320123321123322123323123324123325123326123327123328123329123330123331123332123333123334123335123336123337123338123339123340123341123342123343123344123345123346123347123348123349123350123351123352123353123354123355123356123357123358123359123360123361123362123363123364123365123366123367123368123369123370123371123372123373123374123375123376123377123378123379123380123381123382123383123384123385123386123387123388123389123390123391123392123393123394123395123396123397123398123399123400123401123402123403123404123405123406123407123408123409123410123411123412123413123414123415123416123417123418123419123420123421123422123423123424123425123426123427123428123429123430123431123432123433123434123435123436123437123438123439123440123441123442123443123444123445123446123447123448123449123450123451123452123453123454123455123456123457123458123459123460123461123462123463123464123465123466123467123468123469123470123471123472123473123474123475123476123477123478123479123480123481123482123483123484123485123486123487123488123489123490123491123492123493123494123495123496123497123498123499123500123501123502123503123504123505123506123507123508123509123510123511123512123513123514123515123516123517123518123519123520123521123522123523123524123525123526123527123528123529123530123531123532123533123534123535123536123537123538123539123540123541123542123543123544123545123546123547123548123549123550123551123552123553123554123555123556123557123558123559123560123561123562123563123564123565123566123567123568123569123570123571123572123573123574123575123576123577123578123579123580123581123582123583123584123585123586123587123588123589123590123591123592123593123594123595123596123597123598123599123600123601123602123603123604123605123606123607123608123609123610123611123612123613123614123615123616123617123618123619123620123621123622123623123624123625123626123627123628123629123630123631123632123633123634123635123636123637123638123639123640123641123642123643123644123645123646123647123648123649123650123651123652123653123654123655123656123657123658123659123660123661123662123663123664123665123666123667123668123669123670123671123672123673123674123675123676123677123678123679123680123681123682123683123684123685123686123687123688123689123690123691123692123693123694123695123696123697123698123699123700123701123702123703123704123705123706123707123708123709123710123711123712123713123714123715123716123717123718123719123720123721123722123723123724123725123726123727123728123729123730123731123732123733123734123735123736123737123738123739123740123741123742123743123744123745123746123747123748123749123750123751123752123753123754123755123756123757123758123759123760123761123762123763123764123765123766123767123768123769123770123771123772123773123774123775123776123777123778123779123780123781123782123783123784123785123786123787123788123789123790123791123792123793123794123795123796123797123798123799123800123801123802123803123804123805123806123807123808123809123810123811123812123813123814123815123816123817123818123819123820123821123822123823123824123825123826123827123828123829123830123831123832123833123834123835123836123837123838123839123840123841123842123843123844123845123846123847123848123849123850123851123852123853123854123855123856123857123858123859123860123861123862123863123864123865123866123867123868123869123870123871123872123873123874123875123876123877123878123879123880123881123882123883123884123885123886123887123888123889123890123891123892123893123894123895123896123897123898123899123900123901123902123903123904123905123906123907123908123909123910123911123912123913123914123915123916123917123918123919123920123921123922123923123924123925123926123927123928123929123930123931123932123933123934123935123936123937123938123939123940123941123942123943123944123945123946123947123948123949123950123951123952123953123954123955123956123957123958123959123960123961123962123963123964123965123966123967123968123969123970123971123972123973123974123975123976123977123978123979123980123981123982123983123984123985123986123987123988123989123990123991123992123993123994123995123996123997123998123999124000124001124002124003124004124005124006124007124008124009124010124011124012124013124014124015124016124017124018124019124020124021124022124023124024124025124026124027124028124029124030124031124032124033124034124035124036124037124038124039124040124041124042124043124044124045124046124047124048124049124050124051124052124053124054124055124056124057124058124059124060124061124062124063124064124065124066124067124068124069124070124071124072124073124074124075124076124077124078124079124080124081124082124083124084124085124086124087124088124089124090124091124092124093124094124095124096124097124098124099124100124101124102124103124104124105124106124107124108124109124110124111124112124113124114124115124116124117124118124119124120124121124122124123124124124125124126124127124128124129124130124131124132124133124134124135124136124137124138124139124140124141124142124143124144124145124146124147124148124149124150124151124152124153124154124155124156124157124158124159124160124161124162124163124164124165124166124167124168124169124170124171124172124173124174124175124176124177124178124179124180124181124182124183124184124185124186124187124188124189124190124191124192124193124194124195124196124197124198124199124200124201124202124203124204124205124206124207124208124209124210124211124212124213124214124215124216124217124218124219124220124221124222124223124224124225124226124227124228124229124230124231124232124233124234124235124236124237124238124239124240124241124242124243124244124245124246124247124248124249124250124251124252124253124254124255124256124257124258124259124260124261124262124263124264124265124266124267124268124269124270124271124272124273124274124275124276124277124278124279124280124281124282124283124284124285124286124287124288124289124290124291124292124293124294124295124296124297124298124299124300124301124302124303124304124305124306124307124308124309124310124311124312124313124314124315124316124317124318124319124320124321124322124323124324124325124326124327124328124329124330124331124332124333124334124335124336124337124338124339124340124341124342124343124344124345124346124347124348124349124350124351124352124353124354124355124356124357124358124359124360124361124362124363124364124365124366124367124368124369124370124371124372124373124374124375124376124377124378124379124380124381124382124383124384124385124386124387124388124389124390124391124392124393124394124395124396124397124398124399124400124401124402124403124404124405124406124407124408124409124410124411124412124413124414124415124416124417124418124419124420124421124422124423124424124425124426124427124428124429124430124431124432124433124434124435124436124437124438124439124440124441124442124443124444124445124446124447124448124449124450124451124452124453124454124455124456124457124458124459124460124461124462124463124464124465124466124467124468124469124470124471124472124473124474124475124476124477124478124479124480124481124482124483124484124485124486124487124488124489124490124491124492124493124494124495124496124497124498124499124500124501124502124503124504124505124506124507124508124509124510124511124512124513124514124515124516124517124518124519124520124521124522124523124524124525124526124527124528124529124530124531124532124533124534124535124536124537124538124539124540124541124542124543124544124545124546124547124548124549124550124551124552124553124554124555124556124557124558124559124560124561124562124563124564124565124566124567124568124569124570124571124572124573124574124575124576124577124578124579124580124581124582124583124584124585124586124587124588124589124590124591124592124593124594124595124596124597124598124599124600124601124602124603124604124605124606124607124608124609124610124611124612124613124614124615124616124617124618124619124620124621124622124623124624124625124626124627124628124629124630124631124632124633124634124635124636124637124638124639124640124641124642124643124644124645124646124647124648124649124650124651124652124653124654124655124656124657124658124659124660124661124662124663124664124665124666124667124668124669124670124671124672124673124674124675124676124677124678124679124680124681124682124683124684124685124686124687124688124689124690124691124692124693124694124695124696124697124698124699124700124701124702124703124704124705124706124707124708124709124710124711124712124713124714124715124716124717124718124719124720124721124722124723124724124725124726124727124728124729124730124731124732124733124734124735124736124737124738124739124740124741124742124743124744124745124746124747124748124749124750124751124752124753124754124755124756124757124758124759124760124761124762124763124764124765124766124767124768124769124770124771124772124773124774124775124776124777124778124779124780124781124782124783124784124785124786124787124788124789124790124791124792124793124794124795124796124797124798124799124800124801124802124803124804124805124806124807124808124809124810124811124812124813124814124815124816124817124818124819124820124821124822124823124824124825124826124827124828124829124830124831124832124833124834124835124836124837124838124839124840124841124842124843124844124845124846124847124848124849124850124851124852124853124854124855124856124857124858124859124860124861124862124863124864124865124866124867124868124869124870124871124872124873124874124875124876124877124878124879124880124881124882124883124884124885124886124887124888124889124890124891124892124893124894124895124896124897124898124899124900124901124902124903124904124905124906124907124908124909124910124911124912124913124914124915124916124917124918124919124920124921124922124923124924124925124926124927124928124929124930124931124932124933124934124935124936124937124938124939124940124941124942124943124944124945124946124947124948124949124950124951124952124953124954124955124956124957124958124959124960124961124962124963124964124965124966124967124968124969124970124971124972124973124974124975124976124977124978124979124980124981124982124983124984124985124986124987124988124989124990124991124992124993124994124995124996124997124998124999125000125001125002125003125004125005125006125007125008125009125010125011125012125013125014125015125016125017125018125019125020125021125022125023125024125025125026125027125028125029125030125031125032125033125034125035125036125037125038125039125040125041125042125043125044125045125046125047125048125049125050125051125052125053125054125055125056125057125058125059125060125061125062125063125064125065125066125067125068125069125070125071125072125073125074125075125076125077125078125079125080125081125082125083125084125085125086125087125088125089125090125091125092125093125094125095125096125097125098125099125100125101125102125103125104125105125106125107125108125109125110125111125112125113125114125115125116125117125118125119125120125121125122125123125124125125125126125127125128125129125130125131125132125133125134125135125136125137125138125139125140125141125142125143125144125145125146125147125148125149125150125151125152125153125154125155125156125157125158125159125160125161125162125163125164125165125166125167125168125169125170125171125172125173125174125175125176125177125178125179125180125181125182125183125184125185125186125187125188125189125190125191125192125193125194125195125196125197125198125199125200125201125202125203125204125205125206125207125208125209125210125211125212125213125214125215125216125217125218125219125220125221125222125223125224125225125226125227125228125229125230125231125232125233125234125235125236125237125238125239125240125241125242125243125244125245125246125247125248125249125250125251125252125253125254125255125256125257125258125259125260125261125262125263125264125265125266125267125268125269125270125271125272125273125274125275125276125277125278125279125280125281125282125283125284125285125286125287125288125289125290125291125292125293125294125295125296125297125298125299125300125301125302125303125304125305125306125307125308125309125310125311125312125313125314125315125316125317125318125319125320125321125322125323125324125325125326125327125328125329125330125331125332125333125334125335125336125337125338125339125340125341125342125343125344125345125346125347125348125349125350125351125352125353125354125355125356125357125358125359125360125361125362125363125364125365125366125367125368125369125370125371125372125373125374125375125376125377125378125379125380125381125382125383125384125385125386125387125388125389125390125391125392125393125394125395125396125397125398125399125400125401125402125403125404125405125406125407125408125409125410125411125412125413125414125415125416125417125418125419125420125421125422125423125424125425125426125427125428125429125430125431125432125433125434125435125436125437125438125439125440125441125442125443125444125445125446125447125448125449125450125451125452125453125454125455125456125457125458125459125460125461125462125463125464125465125466125467125468125469125470125471125472125473125474125475125476125477125478125479125480125481125482125483125484125485125486125487125488125489125490125491125492125493125494125495125496125497125498125499125500125501125502125503125504125505125506125507125508125509125510125511125512125513125514125515125516125517125518125519125520125521125522125523125524125525125526125527125528125529125530125531125532125533125534125535125536125537125538125539125540125541125542125543125544125545125546125547125548125549125550125551125552125553125554125555125556125557125558125559125560125561125562125563125564125565125566125567125568125569125570125571125572125573125574125575125576125577125578125579125580125581125582125583125584125585125586125587125588125589125590125591125592125593125594125595125596125597125598125599125600125601125602125603125604125605125606125607125608125609125610125611125612125613125614125615125616125617125618125619125620125621125622125623125624125625125626125627125628125629125630125631125632125633125634125635125636125637125638125639125640125641125642125643125644125645125646125647125648125649125650125651125652125653125654125655125656125657125658125659125660125661125662125663125664125665125666125667125668125669125670125671125672125673125674125675125676125677125678125679125680125681125682125683125684125685125686125687125688125689125690125691125692125693125694125695125696125697125698125699125700125701125702125703125704125705125706125707125708125709125710125711125712125713125714125715125716125717125718125719125720125721125722125723125724125725125726125727125728125729125730125731125732125733125734125735125736125737125738125739125740125741125742125743125744125745125746125747125748125749125750125751125752125753125754125755125756125757125758125759125760125761125762125763125764125765125766125767125768125769125770125771125772125773125774125775125776125777125778125779125780125781125782125783125784125785125786125787125788125789125790125791125792125793125794125795125796125797125798125799125800125801125802125803125804125805125806125807125808125809125810125811125812125813125814125815125816125817125818125819125820125821125822125823125824125825125826125827125828125829125830125831125832125833125834125835125836125837125838125839125840125841125842125843125844125845125846125847125848125849125850125851125852125853125854125855125856125857125858125859125860125861125862125863125864125865125866125867125868125869125870125871125872125873125874125875125876125877125878125879125880125881125882125883125884125885125886125887125888125889125890125891125892125893125894125895125896125897125898125899125900125901125902125903125904125905125906125907125908125909125910125911125912125913125914125915125916125917125918125919125920125921125922125923125924125925125926125927125928125929125930125931125932125933125934125935125936125937125938125939125940125941125942125943125944125945125946125947125948125949125950125951125952125953125954125955125956125957125958125959125960125961125962125963125964125965125966125967125968125969125970125971125972125973125974125975125976125977125978125979125980125981125982125983125984125985125986125987125988125989125990125991125992125993125994125995125996125997125998125999126000126001126002126003126004126005126006126007126008126009126010126011126012126013126014126015126016126017126018126019126020126021126022126023126024126025126026126027126028126029126030126031126032126033126034126035126036126037126038126039126040126041126042126043126044126045126046126047126048126049126050126051126052126053126054126055126056126057126058126059126060126061126062126063126064126065126066126067126068126069126070126071126072126073126074126075126076126077126078126079126080126081126082126083126084126085126086126087126088126089126090126091126092126093126094126095126096126097126098126099126100126101126102126103126104126105126106126107126108126109126110126111126112126113126114126115126116126117126118126119126120126121126122126123126124126125126126126127126128126129126130126131126132126133126134126135126136126137126138126139126140126141126142126143126144126145126146126147126148126149126150126151126152126153126154126155126156126157126158126159126160126161126162126163126164126165126166126167126168126169126170126171126172126173126174126175126176126177126178126179126180126181126182126183126184126185126186126187126188126189126190126191126192126193126194126195126196126197126198126199126200126201126202126203126204126205126206126207126208126209126210126211126212126213126214126215126216126217126218126219126220126221126222126223126224126225126226126227126228126229126230126231126232126233126234126235126236126237126238126239126240126241126242126243126244126245126246126247126248126249126250126251126252126253126254126255126256126257126258126259126260126261126262126263126264126265126266126267126268126269126270126271126272126273126274126275126276126277126278126279126280126281126282126283126284126285126286126287126288126289126290126291126292126293126294126295126296126297126298126299126300126301126302126303126304126305126306126307126308126309126310126311126312126313126314126315126316126317126318126319126320126321126322126323126324126325126326126327126328126329126330126331126332126333126334126335126336126337126338126339126340126341126342126343126344126345126346126347126348126349126350126351126352126353126354126355126356126357126358126359126360126361126362126363126364126365126366126367126368126369126370126371126372126373126374126375126376126377126378126379126380126381126382126383126384126385126386126387126388126389126390126391126392126393126394126395126396126397126398126399126400126401126402126403126404126405126406126407126408126409126410126411126412126413126414126415126416126417126418126419126420126421126422126423126424126425126426126427126428126429126430126431126432126433126434126435126436126437126438126439126440126441126442126443126444126445126446126447126448126449126450126451126452126453126454126455126456126457126458126459126460126461126462126463126464126465126466126467126468126469126470126471126472126473126474126475126476126477126478126479126480126481126482126483126484126485126486126487126488126489126490126491126492126493126494126495126496126497126498126499126500126501126502126503126504126505126506126507126508126509126510126511126512126513126514126515126516126517126518126519126520126521126522126523126524126525126526126527126528126529126530126531126532126533126534126535126536126537126538126539126540126541126542126543126544126545126546126547126548126549126550126551126552126553126554126555126556126557126558126559126560126561126562126563126564126565126566126567126568126569126570126571126572126573126574126575126576126577126578126579126580126581126582126583126584126585126586126587126588126589126590126591126592126593126594126595126596126597126598126599126600126601126602126603126604126605126606126607126608126609126610126611126612126613126614126615126616126617126618126619126620126621126622126623126624126625126626126627126628126629126630126631126632126633126634126635126636126637126638126639126640126641126642126643126644126645126646126647126648126649126650126651126652126653126654126655126656126657126658126659126660126661126662126663126664126665126666126667126668126669126670126671126672126673126674126675126676126677126678126679126680126681126682126683126684126685126686126687126688126689126690126691126692126693126694126695126696126697126698126699126700126701126702126703126704126705126706126707126708126709126710126711126712126713126714126715126716126717126718126719126720126721126722126723126724126725126726126727126728126729126730126731126732126733126734126735126736126737126738126739126740126741126742126743126744126745126746126747126748126749126750126751126752126753126754126755126756126757126758126759126760126761126762126763126764126765126766126767126768126769126770126771126772126773126774126775126776126777126778126779126780126781126782126783126784126785126786126787126788126789126790126791126792126793126794126795126796126797126798126799126800126801126802126803126804126805126806126807126808126809126810126811126812126813126814126815126816126817126818126819126820126821126822126823126824126825126826126827126828126829126830126831126832126833126834126835126836126837126838126839126840126841126842126843126844126845126846126847126848126849126850126851126852126853126854126855126856126857126858126859126860126861126862126863126864126865126866126867126868126869126870126871126872126873126874126875126876126877126878126879126880126881126882126883126884126885126886126887126888126889126890126891126892126893126894126895126896126897126898126899126900126901126902126903126904126905126906126907126908126909126910126911126912126913126914126915126916126917126918126919126920126921126922126923126924126925126926126927126928126929126930126931126932126933126934126935126936126937126938126939126940126941126942126943126944126945126946126947126948126949126950126951126952126953126954126955126956126957126958126959126960126961126962126963126964126965126966126967126968126969126970126971126972126973126974126975126976126977126978126979126980126981126982126983126984126985126986126987126988126989126990126991126992126993126994126995126996126997126998126999127000127001127002127003127004127005127006127007127008127009127010127011127012127013127014127015127016127017127018127019127020127021127022127023127024127025127026127027127028127029127030127031127032127033127034127035127036127037127038127039127040127041127042127043127044127045127046127047127048127049127050127051127052127053127054127055127056127057127058127059127060127061127062127063127064127065127066127067127068127069127070127071127072127073127074127075127076127077127078127079127080127081127082127083127084127085127086127087127088127089127090127091127092127093127094127095127096127097127098127099127100127101127102127103127104127105127106127107127108127109127110127111127112127113127114127115127116127117127118127119127120127121127122127123127124127125127126127127127128127129127130127131127132127133127134127135127136127137127138127139127140127141127142127143127144127145127146127147127148127149127150127151127152127153127154127155127156127157127158127159127160127161127162127163127164127165127166127167127168127169127170127171127172127173127174127175127176127177127178127179127180127181127182127183127184127185127186127187127188127189127190127191127192127193127194127195127196127197127198127199127200127201127202127203127204127205127206127207127208127209127210127211127212127213127214127215127216127217127218127219127220127221127222127223127224127225127226127227127228127229127230127231127232127233127234127235127236127237127238127239127240127241127242127243127244127245127246127247127248127249127250127251127252127253127254127255127256127257127258127259127260127261127262127263127264127265127266127267127268127269127270127271127272127273127274127275127276127277127278127279127280127281127282127283127284127285127286127287127288127289127290127291127292127293127294127295127296127297127298127299127300127301127302127303127304127305127306127307127308127309127310127311127312127313127314127315127316127317127318127319127320127321127322127323127324127325127326127327127328127329127330127331127332127333127334127335127336127337127338127339127340127341127342127343127344127345127346127347127348127349127350127351127352127353127354127355127356127357127358127359127360127361127362127363127364127365127366127367127368127369127370127371127372127373127374127375127376127377127378127379127380127381127382127383127384127385127386127387127388127389127390127391127392127393127394127395127396127397127398127399127400127401127402127403127404127405127406127407127408127409127410127411127412127413127414127415127416127417127418127419127420127421127422127423127424127425127426127427127428127429127430127431127432127433127434127435127436127437127438127439127440127441127442127443127444127445127446127447127448127449127450127451127452127453127454127455127456127457127458127459127460127461127462127463127464127465127466127467127468127469127470127471127472127473127474127475127476127477127478127479127480127481127482127483127484127485127486127487127488127489127490127491127492127493127494127495127496127497127498127499127500127501127502127503127504127505127506127507127508127509127510127511127512127513127514127515127516127517127518127519127520127521127522127523127524127525127526127527127528127529127530127531127532127533127534127535127536127537127538127539127540127541127542127543127544127545127546127547127548127549127550127551127552127553127554127555127556127557127558127559127560127561127562127563127564127565127566127567127568127569127570127571127572127573127574127575127576127577127578127579127580127581127582127583127584127585127586127587127588127589127590127591127592127593127594127595127596127597127598127599127600127601127602127603127604127605127606127607127608127609127610127611127612127613127614127615127616127617127618127619127620127621127622127623127624127625127626127627127628127629127630127631127632127633127634127635127636127637127638127639127640127641127642127643127644127645127646127647127648127649127650127651127652127653127654127655127656127657127658127659127660127661127662127663127664127665127666127667127668127669127670127671127672127673127674127675127676127677127678127679127680127681127682127683127684127685127686127687127688127689127690127691127692127693127694127695127696127697127698127699127700127701127702127703127704127705127706127707127708127709127710127711127712127713127714127715127716127717127718127719127720127721127722127723127724127725127726127727127728127729127730127731127732127733127734127735127736127737127738127739127740127741127742127743127744127745127746127747127748127749127750127751127752127753127754127755127756127757127758127759127760127761127762127763127764127765127766127767127768127769127770127771127772127773127774127775127776127777127778127779127780127781127782127783127784127785127786127787127788127789127790127791127792127793127794127795127796127797127798127799127800127801127802127803127804127805127806127807127808127809127810127811127812127813127814127815127816127817127818127819127820127821127822127823127824127825127826127827127828127829127830127831127832127833127834127835127836127837127838127839127840127841127842127843127844127845127846127847127848127849127850127851127852127853127854127855127856127857127858127859127860127861127862127863127864127865127866127867127868127869127870127871127872127873127874127875127876127877127878127879127880127881127882127883127884127885127886127887127888127889127890127891127892127893127894127895127896127897127898127899127900127901127902127903127904127905127906127907127908127909127910127911127912127913127914127915127916127917127918127919127920127921127922127923127924127925127926127927127928127929127930127931127932127933127934127935127936127937127938127939127940127941127942127943127944127945127946127947127948127949127950127951127952127953127954127955127956127957127958127959127960127961127962127963127964127965127966127967127968127969127970127971127972127973127974127975127976127977127978127979127980127981127982127983127984127985127986127987127988127989127990127991127992127993127994127995127996127997127998127999128000128001128002128003128004128005128006128007128008128009128010128011128012128013128014128015128016128017128018128019128020128021128022128023128024128025128026128027128028128029128030128031128032128033128034128035128036128037128038128039128040128041128042128043128044128045128046128047128048128049128050128051128052128053128054128055128056128057128058128059128060128061128062128063128064128065128066128067128068128069128070128071128072128073128074128075128076128077128078128079128080128081128082128083128084128085128086128087128088128089128090128091128092128093128094128095128096128097128098128099128100128101128102128103128104128105128106128107128108128109128110128111128112128113128114128115128116128117128118128119128120128121128122128123128124128125128126128127128128128129128130128131128132128133128134128135128136128137128138128139128140128141128142128143128144128145128146128147128148128149128150128151128152128153128154128155128156128157128158128159128160128161128162128163128164128165128166128167128168128169128170128171128172128173128174128175128176128177128178128179128180128181128182128183128184128185128186128187128188128189128190128191128192128193128194128195128196128197128198128199128200128201128202128203128204128205128206128207128208128209128210128211128212128213128214128215128216128217128218128219128220128221128222128223128224128225128226128227128228128229128230128231128232128233128234128235128236128237128238128239128240128241128242128243128244128245128246128247128248128249128250128251128252128253128254128255128256128257128258128259128260128261128262128263128264128265128266128267128268128269128270128271128272128273128274128275128276128277128278128279128280128281128282128283128284128285128286128287128288128289128290128291128292128293128294128295128296128297128298128299128300128301128302128303128304128305128306128307128308128309128310128311128312128313128314128315128316128317128318128319128320128321128322128323128324128325128326128327128328128329128330128331128332128333128334128335128336128337128338128339128340128341128342128343128344128345128346128347128348128349128350128351128352128353128354128355128356128357128358128359128360128361128362128363128364128365128366128367128368128369128370128371128372128373128374128375128376128377128378128379128380128381128382128383128384128385128386128387128388128389128390128391128392128393128394128395128396128397128398128399128400128401128402128403128404128405128406128407128408128409128410128411128412128413128414128415128416128417128418128419128420128421128422128423128424128425128426128427128428128429128430128431128432128433128434128435128436128437128438128439128440128441128442128443128444128445128446128447128448128449128450128451128452128453128454128455128456128457128458128459128460128461128462128463128464128465128466128467128468128469128470128471128472128473128474128475128476128477128478128479128480128481128482128483128484128485128486128487128488128489128490128491128492128493128494128495128496128497128498128499128500128501128502128503128504128505128506128507128508128509128510128511128512128513128514128515128516128517128518128519128520128521128522128523128524128525128526128527128528128529128530128531128532128533128534128535128536128537128538128539128540128541128542128543128544128545128546128547128548128549128550128551128552128553128554128555128556128557128558128559128560128561128562128563128564128565128566128567128568128569128570128571128572128573128574128575128576128577128578128579128580128581128582128583128584128585128586128587128588128589128590128591128592128593128594128595128596128597128598128599128600128601128602128603128604128605128606128607128608128609128610128611128612128613128614128615128616128617128618128619128620128621128622128623128624128625128626128627128628128629128630128631128632128633128634128635128636128637128638128639128640128641128642128643128644128645128646128647128648128649128650128651128652128653128654128655128656128657128658128659128660128661128662128663128664128665128666128667128668128669128670128671128672128673128674128675128676128677128678128679128680128681128682128683128684128685128686128687128688128689128690128691128692128693128694128695128696128697128698128699128700128701128702128703128704128705128706128707128708128709128710128711128712128713128714128715128716128717128718128719128720128721128722128723128724128725128726128727128728128729128730128731128732128733128734128735128736128737128738128739128740128741128742128743128744128745128746128747128748128749128750128751128752128753128754128755128756128757128758128759128760128761128762128763128764128765128766128767128768128769128770128771128772128773128774128775128776128777128778128779128780128781128782128783128784128785128786128787128788128789128790128791128792128793128794128795128796128797128798128799128800128801128802128803128804128805128806128807128808128809128810128811128812128813128814128815128816128817128818128819128820128821128822128823128824128825128826128827128828128829128830128831128832128833128834128835128836128837128838128839128840128841128842128843128844128845128846128847128848128849128850128851128852128853128854128855128856128857128858128859128860128861128862128863128864128865128866128867128868128869128870128871128872128873128874128875128876128877128878128879128880128881128882128883128884128885128886128887128888128889128890128891128892128893128894128895128896128897128898128899128900128901128902128903128904128905128906128907128908128909128910128911128912128913128914128915128916128917128918128919128920128921128922128923128924128925128926128927128928128929128930128931128932128933128934128935128936128937128938128939128940128941128942128943128944128945128946128947128948128949128950128951128952128953128954128955128956128957128958128959128960128961128962128963128964128965128966128967128968128969128970128971128972128973128974128975128976128977128978128979128980128981128982128983128984128985128986128987128988128989128990128991128992128993128994128995128996128997128998128999129000129001129002129003129004129005129006129007129008129009129010129011129012129013129014129015129016129017129018129019129020129021129022129023129024129025129026129027129028129029129030129031129032129033129034129035129036129037129038129039129040129041129042129043129044129045129046129047129048129049129050129051129052129053129054129055129056129057129058129059129060129061129062129063129064129065129066129067129068129069129070129071129072129073129074129075129076129077129078129079129080129081129082129083129084129085129086129087129088129089129090129091129092129093129094129095129096129097129098129099129100129101129102129103129104129105129106129107129108129109129110129111129112129113129114129115129116129117129118129119129120129121129122129123129124129125129126129127129128129129129130129131129132129133129134129135129136129137129138129139129140129141129142129143129144129145129146129147129148129149129150129151129152129153129154129155129156129157129158129159129160129161129162129163129164129165129166129167129168129169129170129171129172129173129174129175129176129177129178129179129180129181129182129183129184129185129186129187129188129189129190129191129192129193129194129195129196129197129198129199129200129201129202129203129204129205129206129207129208129209129210129211129212129213129214129215129216129217129218129219129220129221129222129223129224129225129226129227129228129229129230129231129232129233129234129235129236129237129238129239129240129241129242129243129244129245129246129247129248129249129250129251129252129253129254129255129256129257129258129259129260129261129262129263129264129265129266129267129268129269129270129271129272129273129274129275129276129277129278129279129280129281129282129283129284129285129286129287129288129289129290129291129292129293129294129295129296129297129298129299129300129301129302129303129304129305129306129307129308129309129310129311129312129313129314129315129316129317129318129319129320129321129322129323129324129325129326129327129328129329129330129331129332129333129334129335129336129337129338129339129340129341129342129343129344129345129346129347129348129349129350129351129352129353129354129355129356129357129358129359129360129361129362129363129364129365129366129367129368129369129370129371129372129373129374129375129376129377129378129379129380129381129382129383129384129385129386129387129388129389129390129391129392129393129394129395129396129397129398129399129400129401129402129403129404129405129406129407129408129409129410129411129412129413129414129415129416129417129418129419129420129421129422129423129424129425129426129427129428129429129430129431129432129433129434129435129436129437129438129439129440129441129442129443129444129445129446129447129448129449129450129451129452129453129454129455129456129457129458129459129460129461129462129463129464129465129466129467129468129469129470129471129472129473129474129475129476129477129478129479129480129481129482129483129484129485129486129487129488129489129490129491129492129493129494129495129496129497129498129499129500129501129502129503129504129505129506129507129508129509129510129511129512129513129514129515129516129517129518129519129520129521129522129523129524129525129526129527129528129529129530129531129532129533129534129535129536129537129538129539129540129541129542129543129544129545129546129547129548129549129550129551129552129553129554129555129556129557129558129559129560129561129562129563129564129565129566129567129568129569129570129571129572129573129574129575129576129577129578129579129580129581129582129583129584129585129586129587129588129589129590129591129592129593129594129595129596129597129598129599129600129601129602129603129604129605129606129607129608129609129610129611129612129613129614129615129616129617129618129619129620129621129622129623129624129625129626129627129628129629129630129631129632129633129634129635129636129637129638129639129640129641129642129643129644129645129646129647129648129649129650129651129652129653129654129655129656129657129658129659129660129661129662129663129664129665129666129667129668129669129670129671129672129673129674129675129676129677129678129679129680129681129682129683129684129685129686129687129688129689129690129691129692129693129694129695129696129697129698129699129700129701129702129703129704129705129706129707129708129709129710129711129712129713129714129715129716129717129718129719129720129721129722129723129724129725129726129727129728129729129730129731129732129733129734129735129736129737129738129739129740129741129742129743129744129745129746129747129748129749129750129751129752129753129754129755129756129757129758129759129760129761129762129763129764129765129766129767129768129769129770129771129772129773129774129775129776129777129778129779129780129781129782129783129784129785129786129787129788129789129790129791129792129793129794129795129796129797129798129799129800129801129802129803129804129805129806129807129808129809129810129811129812129813129814129815129816129817129818129819129820129821129822129823129824129825129826129827129828129829129830129831129832129833129834129835129836129837129838129839129840129841129842129843129844129845129846129847129848129849129850129851129852129853129854129855129856129857129858129859129860129861129862129863129864129865129866129867129868129869129870129871129872129873129874129875129876129877129878129879129880129881129882129883129884129885129886129887129888129889129890129891129892129893129894129895129896129897129898129899129900129901129902129903129904129905129906129907129908129909129910129911129912129913129914129915129916129917129918129919129920129921129922129923129924129925129926129927129928129929129930129931129932129933129934129935129936129937129938129939129940129941129942129943129944129945129946129947129948129949129950129951129952129953129954129955129956129957129958129959129960129961129962129963129964129965129966129967129968129969129970129971129972129973129974129975129976129977129978129979129980129981129982129983129984129985129986129987129988129989129990129991129992129993129994129995129996129997129998129999130000130001130002130003130004130005130006130007130008130009130010130011130012130013130014130015130016130017130018130019130020130021130022130023130024130025130026130027130028130029130030130031130032130033130034130035130036130037130038130039130040130041130042130043130044130045130046130047130048130049130050130051130052130053130054130055130056130057130058130059130060130061130062130063130064130065130066130067130068130069130070130071130072130073130074130075130076130077130078130079130080130081130082130083130084130085130086130087130088130089130090130091130092130093130094130095130096130097130098130099130100130101130102130103130104130105130106130107130108130109130110130111130112130113130114130115130116130117130118130119130120130121130122130123130124130125130126130127130128130129130130130131130132130133130134130135130136130137130138130139130140130141130142130143130144130145130146130147130148130149130150130151130152130153130154130155130156130157130158130159130160130161130162130163130164130165130166130167130168130169130170130171130172130173130174130175130176130177130178130179130180130181130182130183130184130185130186130187130188130189130190130191130192130193130194130195130196130197130198130199130200130201130202130203130204130205130206130207130208130209130210130211130212130213130214130215130216130217130218130219130220130221130222130223130224130225130226130227130228130229130230130231130232130233130234130235130236130237130238130239130240130241130242130243130244130245130246130247130248130249130250130251130252130253130254130255130256130257130258130259130260130261130262130263130264130265130266130267130268130269130270130271130272130273130274130275130276130277130278130279130280130281130282130283130284130285130286130287130288130289130290130291130292130293130294130295130296130297130298130299130300130301130302130303130304130305130306130307130308130309130310130311130312130313130314130315130316130317130318130319130320130321130322130323130324130325130326130327130328130329130330130331130332130333130334130335130336130337130338130339130340130341130342130343130344130345130346130347130348130349130350130351130352130353130354130355130356130357130358130359130360130361130362130363130364130365130366130367130368130369130370130371130372130373130374130375130376130377130378130379130380130381130382130383130384130385130386130387130388130389130390130391130392130393130394130395130396130397130398130399130400130401130402130403130404130405130406130407130408130409130410130411130412130413130414130415130416130417130418130419130420130421130422130423130424130425130426130427130428130429130430130431130432130433130434130435130436130437130438130439130440130441130442130443130444130445130446130447130448130449130450130451130452130453130454130455130456130457130458130459130460130461130462130463130464130465130466130467130468130469130470130471130472130473130474130475130476130477130478130479130480130481130482130483130484130485130486130487130488130489130490130491130492130493130494130495130496130497130498130499130500130501130502130503130504130505130506130507130508130509130510130511130512130513130514130515130516130517130518130519130520130521130522130523130524130525130526130527130528130529130530130531130532130533130534130535130536130537130538130539130540130541130542130543130544130545130546130547130548130549130550130551130552130553130554130555130556130557130558130559130560130561130562130563130564130565130566130567130568130569130570130571130572130573130574130575130576130577130578130579130580130581130582130583130584130585130586130587130588130589130590130591130592130593130594130595130596130597130598130599130600130601130602130603130604130605130606130607130608130609130610130611130612130613130614130615130616130617130618130619130620130621130622130623130624130625130626130627130628130629130630130631130632130633130634130635130636130637130638130639130640130641130642130643130644130645130646130647130648130649130650130651130652130653130654130655130656130657130658130659130660130661130662130663130664130665130666130667130668130669130670130671130672130673130674130675130676130677130678130679130680130681130682130683130684130685130686130687130688130689130690130691130692130693130694130695130696130697130698130699130700130701130702130703130704130705130706130707130708130709130710130711130712130713130714130715130716130717130718130719130720130721130722130723130724130725130726130727130728130729130730130731130732130733130734130735130736130737130738130739130740130741130742130743130744130745130746130747130748130749130750130751130752130753130754130755130756130757130758130759130760130761130762130763130764130765130766130767130768130769130770130771130772130773130774130775130776130777130778130779130780130781130782130783130784130785130786130787130788130789130790130791130792130793130794130795130796130797130798130799130800130801130802130803130804130805130806130807130808130809130810130811130812130813130814130815130816130817130818130819130820130821130822130823130824130825130826130827130828130829130830130831130832130833130834130835130836130837130838130839130840130841130842130843130844130845130846130847130848130849130850130851130852130853130854130855130856130857130858130859130860130861130862130863130864130865130866130867130868130869130870130871130872130873130874130875130876130877130878130879130880130881130882130883130884130885130886130887130888130889130890130891130892130893130894130895130896130897130898130899130900130901130902130903130904130905130906130907130908130909130910130911130912130913130914130915130916130917130918130919130920130921130922130923130924130925130926130927130928130929130930130931130932130933130934130935130936130937130938130939130940130941130942130943130944130945130946130947130948130949130950130951130952130953130954130955130956130957130958130959130960130961130962130963130964130965130966130967130968130969130970130971130972130973130974130975130976130977130978130979130980130981130982130983130984130985130986130987130988130989130990130991130992130993130994130995130996130997130998130999131000131001131002131003131004131005131006131007131008131009131010131011131012131013131014131015131016131017131018131019131020131021131022131023131024131025131026131027131028131029131030131031131032131033131034131035131036131037131038131039131040131041131042131043131044131045131046131047131048131049131050131051131052131053131054131055131056131057131058131059131060131061131062131063131064131065131066131067131068131069131070131071131072131073131074131075131076131077131078131079131080131081131082131083131084131085131086131087131088131089131090131091131092131093131094131095131096131097131098131099131100131101131102131103131104131105131106131107131108131109131110131111131112131113131114131115131116131117131118131119131120131121131122131123131124131125131126131127131128131129131130131131131132131133131134131135131136131137131138131139131140131141131142131143131144131145131146131147131148131149131150131151131152131153131154131155131156131157131158131159131160131161131162131163131164131165131166131167131168131169131170131171131172131173131174131175131176131177131178131179131180131181131182131183131184131185131186131187131188131189131190131191131192131193131194131195131196131197131198131199131200131201131202131203131204131205131206131207131208131209131210131211131212131213131214131215131216131217131218131219131220131221131222131223131224131225131226131227131228131229131230131231131232131233131234131235131236131237131238131239131240131241131242131243131244131245131246131247131248131249131250131251131252131253131254131255131256131257131258131259131260131261131262131263131264131265131266131267131268131269131270131271131272131273131274131275131276131277131278131279131280131281131282131283131284131285131286131287131288131289131290131291131292131293131294131295131296131297131298131299131300131301131302131303131304131305131306131307131308131309131310131311131312131313131314131315131316131317131318131319131320131321131322131323131324131325131326131327131328131329131330131331131332131333131334131335131336131337131338131339131340131341131342131343131344131345131346131347131348131349131350131351131352131353131354131355131356131357131358131359131360131361131362131363131364131365131366131367131368131369131370131371131372131373131374131375131376131377131378131379131380131381131382131383131384131385131386131387131388131389131390131391131392131393131394131395131396131397131398131399131400131401131402131403131404131405131406131407131408131409131410131411131412131413131414131415131416131417131418131419131420131421131422131423131424131425131426131427131428131429131430131431131432131433131434131435131436131437131438131439131440131441131442131443131444131445131446131447131448131449131450131451131452131453131454131455131456131457131458131459131460131461131462131463131464131465131466131467131468131469131470131471131472131473131474131475131476131477131478131479131480131481131482131483131484131485131486131487131488131489131490131491131492131493131494131495131496131497131498131499131500131501131502131503131504131505131506131507131508131509131510131511131512131513131514131515131516131517131518131519131520131521131522131523131524131525131526131527131528131529131530131531131532131533131534131535131536131537131538131539131540131541131542131543131544131545131546131547131548131549131550131551131552131553131554131555131556131557131558131559131560131561131562131563131564131565131566131567131568131569131570131571131572131573131574131575131576131577131578131579131580131581131582131583131584131585131586131587131588131589131590131591131592131593131594131595131596131597131598131599131600131601131602131603131604131605131606131607131608131609131610131611131612131613131614131615131616131617131618131619131620131621131622131623131624131625131626131627131628131629131630131631131632131633131634131635131636131637131638131639131640131641131642131643131644131645131646131647131648131649131650131651131652131653131654131655131656131657131658131659131660131661131662131663131664131665131666131667131668131669131670131671131672131673131674131675131676131677131678131679131680131681131682131683131684131685131686131687131688131689131690131691131692131693131694131695131696131697131698131699131700131701131702131703131704131705131706131707131708131709131710131711131712131713131714131715131716131717131718131719131720131721131722131723131724131725131726131727131728131729131730131731131732131733131734131735131736131737131738131739131740131741131742131743131744131745131746131747131748131749131750131751131752131753131754131755131756131757131758131759131760131761131762131763131764131765131766131767131768131769131770131771131772131773131774131775131776131777131778131779131780131781131782131783131784131785131786131787131788131789131790131791131792131793131794131795131796131797131798131799131800131801131802131803131804131805131806131807131808131809131810131811131812131813131814131815131816131817131818131819131820131821131822131823131824131825131826131827131828131829131830131831131832131833131834131835131836131837131838131839131840131841131842131843131844131845131846131847131848131849131850131851131852131853131854131855131856131857131858131859131860131861131862131863131864131865131866131867131868131869131870131871131872131873131874131875131876131877131878131879131880131881131882131883131884131885131886131887131888131889131890131891131892131893131894131895131896131897131898131899131900131901131902131903131904131905131906131907131908131909131910131911131912131913131914131915131916131917131918131919131920131921131922131923131924131925131926131927131928131929131930131931131932131933131934131935131936131937131938131939131940131941131942131943131944131945131946131947131948131949131950131951131952131953131954131955131956131957131958131959131960131961131962131963131964131965131966131967131968131969131970131971131972131973131974131975131976131977131978131979131980131981131982131983131984131985131986131987131988131989131990131991131992131993131994131995131996131997131998131999132000132001132002132003132004132005132006132007132008132009132010132011132012132013132014132015132016132017132018132019132020132021132022132023132024132025132026132027132028132029132030132031132032132033132034132035132036132037132038132039132040132041132042132043132044132045132046132047132048132049132050132051132052132053132054132055132056132057132058132059132060132061132062132063132064132065132066132067132068132069132070132071132072132073132074132075132076132077132078132079132080132081132082132083132084132085132086132087132088132089132090132091132092132093132094132095132096132097132098132099132100132101132102132103132104132105132106132107132108132109132110132111132112132113132114132115132116132117132118132119132120132121132122132123132124132125132126132127132128132129132130132131132132132133132134132135132136132137132138132139132140132141132142132143132144132145132146132147132148132149132150132151132152132153132154132155132156132157132158132159132160132161132162132163132164132165132166132167132168132169132170132171132172132173132174132175132176132177132178132179132180132181132182132183132184132185132186132187132188132189132190132191132192132193132194132195132196132197132198132199132200132201132202132203132204132205132206132207132208132209132210132211132212132213132214132215132216132217132218132219132220132221132222132223132224132225132226132227132228132229132230132231132232132233132234132235132236132237132238132239132240132241132242132243132244132245132246132247132248132249132250132251132252132253132254132255132256132257132258132259132260132261132262132263132264132265132266132267132268132269132270132271132272132273132274132275132276132277132278132279132280132281132282132283132284132285132286132287132288132289132290132291132292132293132294132295132296132297132298132299132300132301132302132303132304132305132306132307132308132309132310132311132312132313132314132315132316132317132318132319132320132321132322132323132324132325132326132327132328132329132330132331132332132333132334132335132336132337132338132339132340132341132342132343132344132345132346132347132348132349132350132351132352132353132354132355132356132357132358132359132360132361132362132363132364132365132366132367132368132369132370132371132372132373132374132375132376132377132378132379132380132381132382132383132384132385132386132387132388132389132390132391132392132393132394132395132396132397132398132399132400132401132402132403132404132405132406132407132408132409132410132411132412132413132414132415132416132417132418132419132420132421132422132423132424132425132426132427132428132429132430132431132432132433132434132435132436132437132438132439132440132441132442132443132444132445132446132447132448132449132450132451132452132453132454132455132456132457132458132459132460132461132462132463132464132465132466132467132468132469132470132471132472132473132474132475132476132477132478132479132480132481132482132483132484132485132486132487132488132489132490132491132492132493132494132495132496132497132498132499132500132501132502132503132504132505132506132507132508132509132510132511132512132513132514132515132516132517132518132519132520132521132522132523132524132525132526132527132528132529132530132531132532132533132534132535132536132537132538132539132540132541132542132543132544132545132546132547132548132549132550132551132552132553132554132555132556132557132558132559132560132561132562132563132564132565132566132567132568132569132570132571132572132573132574132575132576132577132578132579132580132581132582132583132584132585132586132587132588132589132590132591132592132593132594132595132596132597132598132599132600132601132602132603132604132605132606132607132608132609132610132611132612132613132614132615132616132617132618132619132620132621132622132623132624132625132626132627132628132629132630132631132632132633132634132635132636132637132638132639132640132641132642132643132644132645132646132647132648132649132650132651132652132653132654132655132656132657132658132659132660132661132662132663132664132665132666132667132668132669132670132671132672132673132674132675132676132677132678132679132680132681132682132683132684132685132686132687132688132689132690132691132692132693132694132695132696132697132698132699132700132701132702132703132704132705132706132707132708132709132710132711132712132713132714132715132716132717132718132719132720132721132722132723132724132725132726132727132728132729132730132731132732132733132734132735132736132737132738132739132740132741132742132743132744132745132746132747132748132749132750132751132752132753132754132755132756132757132758132759132760132761132762132763132764132765132766132767132768132769132770132771132772132773132774132775132776132777132778132779132780132781132782132783132784132785132786132787132788132789132790132791132792132793132794132795132796132797132798132799132800132801132802132803132804132805132806132807132808132809132810132811132812132813132814132815132816132817132818132819132820132821132822132823132824132825132826132827132828132829132830132831132832132833132834132835132836132837132838132839132840132841132842132843132844132845132846132847132848132849132850132851132852132853132854132855132856132857132858132859132860132861132862132863132864132865132866132867132868132869132870132871132872132873132874132875132876132877132878132879132880132881132882132883132884132885132886132887132888132889132890132891132892132893132894132895132896132897132898132899132900132901132902132903132904132905132906132907132908132909132910132911132912132913132914132915132916132917132918132919132920132921132922132923132924132925132926132927132928132929132930132931132932132933132934132935132936132937132938132939132940132941132942132943132944132945132946132947132948132949132950132951132952132953132954132955132956132957132958132959132960132961132962132963132964132965132966132967132968132969132970132971132972132973132974132975132976132977132978132979132980132981132982132983132984132985132986132987132988132989132990132991132992132993132994132995132996132997132998132999133000133001133002133003133004133005133006133007133008133009133010133011133012133013133014133015133016133017133018133019133020133021133022133023133024133025133026133027133028133029133030133031133032133033133034133035133036133037133038133039133040133041133042133043133044133045133046133047133048133049133050133051133052133053133054133055133056133057133058133059133060133061133062133063133064133065133066133067133068133069133070133071133072133073133074133075133076133077133078133079133080133081133082133083133084133085133086133087133088133089133090133091133092133093133094133095133096133097133098133099133100133101133102133103133104133105133106133107133108133109133110133111133112133113133114133115133116133117133118133119133120133121133122133123133124133125133126133127133128133129133130133131133132133133133134133135133136133137133138133139133140133141133142133143133144133145133146133147133148133149133150133151133152133153133154133155133156133157133158133159133160133161133162133163133164133165133166133167133168133169133170133171133172133173133174133175133176133177133178133179133180133181133182133183133184133185133186133187133188133189133190133191133192133193133194133195133196133197133198133199133200133201133202133203133204133205133206133207133208133209133210133211133212133213133214133215133216133217133218133219133220133221133222133223133224133225133226133227133228133229133230133231133232133233133234133235133236133237133238133239133240133241133242133243133244133245133246133247133248133249133250133251133252133253133254133255133256133257133258133259133260133261133262133263133264133265133266133267133268133269133270133271133272133273133274133275133276133277133278133279133280133281133282133283133284133285133286133287133288133289133290133291133292133293133294133295133296133297133298133299133300133301133302133303133304133305133306133307133308133309133310133311133312133313133314133315133316133317133318133319133320133321133322133323133324133325133326133327133328133329133330133331133332133333133334133335133336133337133338133339133340133341133342133343133344133345133346133347133348133349133350133351133352133353133354133355133356133357133358133359133360133361133362133363133364133365133366133367133368133369133370133371133372133373133374133375133376133377133378133379133380133381133382133383133384133385133386133387133388133389133390133391133392133393133394133395133396133397133398133399133400133401133402133403133404133405133406133407133408133409133410133411133412133413133414133415133416133417133418133419133420133421133422133423133424133425133426133427133428133429133430133431133432133433133434133435133436133437133438133439133440133441133442133443133444133445133446133447133448133449133450133451133452133453133454133455133456133457133458133459133460133461133462133463133464133465133466133467133468133469133470133471133472133473133474133475133476133477133478133479133480133481133482133483133484133485133486133487133488133489133490133491133492133493133494133495133496133497133498133499133500133501133502133503133504133505133506133507133508133509133510133511133512133513133514133515133516133517133518133519133520133521133522133523133524133525133526133527133528133529133530133531133532133533133534133535133536133537133538133539133540133541133542133543133544133545133546133547133548133549133550133551133552133553133554133555133556133557133558133559133560133561133562133563133564133565133566133567133568133569133570133571133572133573133574133575133576133577133578133579133580133581133582133583133584133585133586133587133588133589133590133591133592133593133594133595133596133597133598133599133600133601133602133603133604133605133606133607133608133609133610133611133612133613133614133615133616133617133618133619133620133621133622133623133624133625133626133627133628133629133630133631133632133633133634133635133636133637133638133639133640133641133642133643133644133645133646133647133648133649133650133651133652133653133654133655133656133657133658133659133660133661133662133663133664133665133666133667133668133669133670133671133672133673133674133675133676133677133678133679133680133681133682133683133684133685133686133687133688133689133690133691133692133693133694133695133696133697133698133699133700133701133702133703133704133705133706133707133708133709133710133711133712133713133714133715133716133717133718133719133720133721133722133723133724133725133726133727133728133729133730133731133732133733133734133735133736133737133738133739133740133741133742133743133744133745133746133747133748133749133750133751133752133753133754133755133756133757133758133759133760133761133762133763133764133765133766133767133768133769133770133771133772133773133774133775133776133777133778133779133780133781133782133783133784133785133786133787133788133789133790133791133792133793133794133795133796133797133798133799133800133801133802133803133804133805133806133807133808133809133810133811133812133813133814133815133816133817133818133819133820133821133822133823133824133825133826133827133828133829133830133831133832133833133834133835133836133837133838133839133840133841133842133843133844133845133846133847133848133849133850133851133852133853133854133855133856133857133858133859133860133861133862133863133864133865133866133867133868133869133870133871133872133873133874133875133876133877133878133879133880133881133882133883133884133885133886133887133888133889133890133891133892133893133894133895133896133897133898133899133900133901133902133903133904133905133906133907133908133909133910133911133912133913133914133915133916133917133918133919133920133921133922133923133924133925133926133927133928133929133930133931133932133933133934133935133936133937133938133939133940133941133942133943133944133945133946133947133948133949133950133951133952133953133954133955133956133957133958133959133960133961133962133963133964133965133966133967133968133969133970133971133972133973133974133975133976133977133978133979133980133981133982133983133984133985133986133987133988133989133990133991133992133993133994133995133996133997133998133999134000134001134002134003134004134005134006134007134008134009134010134011134012134013134014134015134016134017134018134019134020134021134022134023134024134025134026134027134028134029134030134031134032134033134034134035134036134037134038134039134040134041134042134043134044134045134046134047134048134049134050134051134052134053134054134055134056134057134058134059134060134061134062134063134064134065134066134067134068134069134070134071134072134073134074134075134076134077134078134079134080134081134082134083134084134085134086134087134088134089134090134091134092134093134094134095134096134097134098134099134100134101134102134103134104134105134106134107134108134109134110134111134112134113134114134115134116134117134118134119134120134121134122134123134124134125134126134127134128134129134130134131134132134133134134134135134136134137134138134139134140134141134142134143134144134145134146134147134148134149134150134151134152134153134154134155134156134157134158134159134160134161134162134163134164134165134166134167134168134169134170134171134172134173134174134175134176134177134178134179134180134181134182134183134184134185134186134187134188134189134190134191134192134193134194134195134196134197134198134199134200134201134202134203134204134205134206134207134208134209134210134211134212134213134214134215134216134217134218134219134220134221134222134223134224134225134226134227134228134229134230134231134232134233134234134235134236134237134238134239134240134241134242134243134244134245134246134247134248134249134250134251134252134253134254134255134256134257134258134259134260134261134262134263134264134265134266134267134268134269134270134271134272134273134274134275134276134277134278134279134280134281134282134283134284134285134286134287134288134289134290134291134292134293134294134295134296134297134298134299134300134301134302134303134304134305134306134307134308134309134310134311134312134313134314134315134316134317134318134319134320134321134322134323134324134325134326134327134328134329134330134331134332134333134334134335134336134337134338134339134340134341134342134343134344134345134346134347134348134349134350134351134352134353134354134355134356134357134358134359134360134361134362134363134364134365134366134367134368134369134370134371134372134373134374134375134376134377134378134379134380134381134382134383134384134385134386134387134388134389134390134391134392134393134394134395134396134397134398134399134400134401134402134403134404134405134406134407134408134409134410134411134412134413134414134415134416134417134418134419134420134421134422134423134424134425134426134427134428134429134430134431134432134433134434134435134436134437134438134439134440134441134442134443134444134445134446134447134448134449134450134451134452134453134454134455134456134457134458134459134460134461134462134463134464134465134466134467134468134469134470134471134472134473134474134475134476134477134478134479134480134481134482134483134484134485134486134487134488134489134490134491134492134493134494134495134496134497134498134499134500134501134502134503134504134505134506134507134508134509134510134511134512134513134514134515134516134517134518134519134520134521134522134523134524134525134526134527134528134529134530134531134532134533134534134535134536134537134538134539134540134541134542134543134544134545134546134547134548134549134550134551134552134553134554134555134556134557134558134559134560134561134562134563134564134565134566134567134568134569134570134571134572134573134574134575134576134577134578134579134580134581134582134583134584134585134586134587134588134589134590134591134592134593134594134595134596134597134598134599134600134601134602134603134604134605134606134607134608134609134610134611134612134613134614134615134616134617134618134619134620134621134622134623134624134625134626134627134628134629134630134631134632134633134634134635134636134637134638134639134640134641134642134643134644134645134646134647134648134649134650134651134652134653134654134655134656134657134658134659134660134661134662134663134664134665134666134667134668134669134670134671134672134673134674134675134676134677134678134679134680134681134682134683134684134685134686134687134688134689134690134691134692134693134694134695134696134697134698134699134700134701134702134703134704134705134706134707134708134709134710134711134712134713134714134715134716134717134718134719134720134721134722134723134724134725134726134727134728134729134730134731134732134733134734134735134736134737134738134739134740134741134742134743134744134745134746134747134748134749134750134751134752134753134754134755134756134757134758134759134760134761134762134763134764134765134766134767134768134769134770134771134772134773134774134775134776134777134778134779134780134781134782134783134784134785134786134787134788134789134790134791134792134793134794134795134796134797134798134799134800134801134802134803134804134805134806134807134808134809134810134811134812134813134814134815134816134817134818134819134820134821134822134823134824134825134826134827134828134829134830134831134832134833134834134835134836134837134838134839134840134841134842134843134844134845134846134847134848134849134850134851134852134853134854134855134856134857134858134859134860134861134862134863134864134865134866134867134868134869134870134871134872134873134874134875134876134877134878134879134880134881134882134883134884134885134886134887134888134889134890134891134892134893134894134895134896134897134898134899134900134901134902134903134904134905134906134907134908134909134910134911134912134913134914134915134916134917134918134919134920134921134922134923134924134925134926134927134928134929134930134931134932134933134934134935134936134937134938134939134940134941134942134943134944134945134946134947134948134949134950134951134952134953134954134955134956134957134958134959134960134961134962134963134964134965134966134967134968134969134970134971134972134973134974134975134976134977134978134979134980134981134982134983134984134985134986134987134988134989134990134991134992134993134994134995134996134997134998134999135000135001135002135003135004135005135006135007135008135009135010135011135012135013135014135015135016135017135018135019135020135021135022135023135024135025135026135027135028135029135030135031135032135033135034135035135036135037135038135039135040135041135042135043135044135045135046135047135048135049135050135051135052135053135054135055135056135057135058135059135060135061135062135063135064135065135066135067135068135069135070135071135072135073135074135075135076135077135078135079135080135081135082135083135084135085135086135087135088135089135090135091135092135093135094135095135096135097135098135099135100135101135102135103135104135105135106135107135108135109135110135111135112135113135114135115135116135117135118135119135120135121135122135123135124135125135126135127135128135129135130135131135132135133135134135135135136135137135138135139135140135141135142135143135144135145135146135147135148135149135150135151135152135153135154135155135156135157135158135159135160135161135162135163135164135165135166135167135168135169135170135171135172135173135174135175135176135177135178135179135180135181135182135183135184135185135186135187135188135189135190135191135192135193135194135195135196135197135198135199135200135201135202135203135204135205135206135207135208135209135210135211135212135213135214135215135216135217135218135219135220135221135222135223135224135225135226135227135228135229135230135231135232135233135234135235135236135237135238135239135240135241135242135243135244135245135246135247135248135249135250135251135252135253135254135255135256135257135258135259135260135261135262135263135264135265135266135267135268135269135270135271135272135273135274135275135276135277135278135279135280135281135282135283135284135285135286135287135288135289135290135291135292135293135294135295135296135297135298135299135300135301135302135303135304135305135306135307135308135309135310135311135312135313135314135315135316135317135318135319135320135321135322135323135324135325135326135327135328135329135330135331135332135333135334135335135336135337135338135339135340135341135342135343135344135345135346135347135348135349135350135351135352135353135354135355135356135357135358135359135360135361135362135363135364135365135366135367135368135369135370135371135372135373135374135375135376135377135378135379135380135381135382135383135384135385135386135387135388135389135390135391135392135393135394135395135396135397135398135399135400135401135402135403135404135405135406135407135408135409135410135411135412135413135414135415135416135417135418135419135420135421135422135423135424135425135426135427135428135429135430135431135432135433135434135435135436135437135438135439135440135441135442135443135444135445135446135447135448135449135450135451135452135453135454135455135456135457135458135459135460135461135462135463135464135465135466135467135468135469135470135471135472135473135474135475135476135477135478135479135480135481135482135483135484135485135486135487135488135489135490135491135492135493135494135495135496135497135498135499135500135501135502135503135504135505135506135507135508135509135510135511135512135513135514135515135516135517135518135519135520135521135522135523135524135525135526135527135528135529135530135531135532135533135534135535135536135537135538135539135540135541135542135543135544135545135546135547135548135549135550135551135552135553135554135555135556135557135558135559135560135561135562135563135564135565135566135567135568135569135570135571135572135573135574135575135576135577135578135579135580135581135582135583135584135585135586135587135588135589135590135591135592135593135594135595135596135597135598135599135600135601135602135603135604135605135606135607135608135609135610135611135612135613135614135615135616135617135618135619135620135621135622135623135624135625135626135627135628135629135630135631135632135633135634135635135636135637135638135639135640135641135642135643135644135645135646135647135648135649135650135651135652135653135654135655135656135657135658135659135660135661135662135663135664135665135666135667135668135669135670135671135672135673135674135675135676135677135678135679135680135681135682135683135684135685135686135687135688135689135690135691135692135693135694135695135696135697135698135699135700135701135702135703135704135705135706135707135708135709135710135711135712135713135714135715135716135717135718135719135720135721135722135723135724135725135726135727135728135729135730135731135732135733135734135735135736135737135738135739135740135741135742135743135744135745135746135747135748135749135750135751135752135753135754135755135756135757135758135759135760135761135762135763135764135765135766135767135768135769135770135771135772135773135774135775135776135777135778135779135780135781135782135783135784135785135786135787135788135789135790135791135792135793135794135795135796135797135798135799135800135801135802135803135804135805135806135807135808135809135810135811135812135813135814135815135816135817135818135819135820135821135822135823135824135825135826135827135828135829135830135831135832135833135834135835135836135837135838135839135840135841135842135843135844135845135846135847135848135849135850135851135852135853135854135855135856135857135858135859135860135861135862135863135864135865135866135867135868135869135870135871135872135873135874135875135876135877135878135879135880135881135882135883135884135885135886135887135888135889135890135891135892135893135894135895135896135897135898135899135900135901135902135903135904135905135906135907135908135909135910135911135912135913135914135915135916135917135918135919135920135921135922135923135924135925135926135927135928135929135930135931135932135933135934135935135936135937135938135939135940135941135942135943135944135945135946135947135948135949135950135951135952135953135954135955135956135957135958135959135960135961135962135963135964135965135966135967135968135969135970135971135972135973135974135975135976135977135978135979135980135981135982135983135984135985135986135987135988135989135990135991135992135993135994135995135996135997135998135999136000136001136002136003136004136005136006136007136008136009136010136011136012136013136014136015136016136017136018136019136020136021136022136023136024136025136026136027136028136029136030136031136032136033136034136035136036136037136038136039136040136041136042136043136044136045136046136047136048136049136050136051136052136053136054136055136056136057136058136059136060136061136062136063136064136065136066136067136068136069136070136071136072136073136074136075136076136077136078136079136080136081136082136083136084136085136086136087136088136089136090136091136092136093136094136095136096136097136098136099136100136101136102136103136104136105136106136107136108136109136110136111136112136113136114136115136116136117136118136119136120136121136122136123136124136125136126136127136128136129136130136131136132136133136134136135136136136137136138136139136140136141136142136143136144136145136146136147136148136149136150136151136152136153136154136155136156136157136158136159136160136161136162136163136164136165136166136167136168136169136170136171136172136173136174136175136176136177136178136179136180136181136182136183136184136185136186136187136188136189136190136191136192136193136194136195136196136197136198136199136200136201136202136203136204136205136206136207136208136209136210136211136212136213136214136215136216136217136218136219136220136221136222136223136224136225136226136227136228136229136230136231136232136233136234136235136236136237136238136239136240136241136242136243136244136245136246136247136248136249136250136251136252136253136254136255136256136257136258136259136260136261136262136263136264136265136266136267136268136269136270136271136272136273136274136275136276136277136278136279136280136281136282136283136284136285136286136287136288136289136290136291136292136293136294136295136296136297136298136299136300136301136302136303136304136305136306136307136308136309136310136311136312136313136314136315136316136317136318136319136320136321136322136323136324136325136326136327136328136329136330136331136332136333136334136335136336136337136338136339136340136341136342136343136344136345136346136347136348136349136350136351136352136353136354136355136356136357136358136359136360136361136362136363136364136365136366136367136368136369136370136371136372136373136374136375136376136377136378136379136380136381136382136383136384136385136386136387136388136389136390136391136392136393136394136395136396136397136398136399136400136401136402136403136404136405136406136407136408136409136410136411136412136413136414136415136416136417136418136419136420136421136422136423136424136425136426136427136428136429136430136431136432136433136434136435136436136437136438136439136440136441136442136443136444136445136446136447136448136449136450136451136452136453136454136455136456136457136458136459136460136461136462136463136464136465136466136467136468136469136470136471136472136473136474136475136476136477136478136479136480136481136482136483136484136485136486136487136488136489136490136491136492136493136494136495136496136497136498136499136500136501136502136503136504136505136506136507136508136509136510136511136512136513136514136515136516136517136518136519136520136521136522136523136524136525136526136527136528136529136530136531136532136533136534136535136536136537136538136539136540136541136542136543136544136545136546136547136548136549136550136551136552136553136554136555136556136557136558136559136560136561136562136563136564136565136566136567136568136569136570136571136572136573136574136575136576136577136578136579136580136581136582136583136584136585136586136587136588136589136590136591136592136593136594136595136596136597136598136599136600136601136602136603136604136605136606136607136608136609136610136611136612136613136614136615136616136617136618136619136620136621136622136623136624136625136626136627136628136629136630136631136632136633136634136635136636136637136638136639136640136641136642136643136644136645136646136647136648136649136650136651136652136653136654136655136656136657136658136659136660136661136662136663136664136665136666136667136668136669136670136671136672136673136674136675136676136677136678136679136680136681136682136683136684136685136686136687136688136689136690136691136692136693136694136695136696136697136698136699136700136701136702136703136704136705136706136707136708136709136710136711136712136713136714136715136716136717136718136719136720136721136722136723136724136725136726136727136728136729136730136731136732136733136734136735136736136737136738136739136740136741136742136743136744136745136746136747136748136749136750136751136752136753136754136755136756136757136758136759136760136761136762136763136764136765136766136767136768136769136770136771136772136773136774136775136776136777136778136779136780136781136782136783136784136785136786136787136788136789136790136791136792136793136794136795136796136797136798136799136800136801136802136803136804136805136806136807136808136809136810136811136812136813136814136815136816136817136818136819136820136821136822136823136824136825136826136827136828136829136830136831136832136833136834136835136836136837136838136839136840136841136842136843136844136845136846136847136848136849136850136851136852136853136854136855136856136857136858136859136860136861136862136863136864136865136866136867136868136869136870136871136872136873136874136875136876136877136878136879136880136881136882136883136884136885136886136887136888136889136890136891136892136893136894136895136896136897136898136899136900136901136902136903136904136905136906136907136908136909136910136911136912136913136914136915136916136917136918136919136920136921136922136923136924136925136926136927136928136929136930136931136932136933136934136935136936136937136938136939136940136941136942136943136944136945136946136947136948136949136950136951136952136953136954136955136956136957136958136959136960136961136962136963136964136965136966136967136968136969136970136971136972136973136974136975136976136977136978136979136980136981136982136983136984136985136986136987136988136989136990136991136992136993136994136995136996136997136998136999137000137001137002137003137004137005137006137007137008137009137010137011137012137013137014137015137016137017137018137019137020137021137022137023137024137025137026137027137028137029137030137031137032137033137034137035137036137037137038137039137040137041137042137043137044137045137046137047137048137049137050137051137052137053137054137055137056137057137058137059137060137061137062137063137064137065137066137067137068137069137070137071137072137073137074137075137076137077137078137079137080137081137082137083137084137085137086137087137088137089137090137091137092137093137094137095137096137097137098137099137100137101137102137103137104137105137106137107137108137109137110137111137112137113137114137115137116137117137118137119137120137121137122137123137124137125137126137127137128137129137130137131137132137133137134137135137136137137137138137139137140137141137142137143137144137145137146137147137148137149137150137151137152137153137154137155137156137157137158137159137160137161137162137163137164137165137166137167137168137169137170137171137172137173137174137175137176137177137178137179137180137181137182137183137184137185137186137187137188137189137190137191137192137193137194137195137196137197137198137199137200137201137202137203137204137205137206137207137208137209137210137211137212137213137214137215137216137217137218137219137220137221137222137223137224137225137226137227137228137229137230137231137232137233137234137235137236137237137238137239137240137241137242137243137244137245137246137247137248137249137250137251137252137253137254137255137256137257137258137259137260137261137262137263137264137265137266137267137268137269137270137271137272137273137274137275137276137277137278137279137280137281137282137283137284137285137286137287137288137289137290137291137292137293137294137295137296137297137298137299137300137301137302137303137304137305137306137307137308137309137310137311137312137313137314137315137316137317137318137319137320137321137322137323137324137325137326137327137328137329137330137331137332137333137334137335137336137337137338137339137340137341137342137343137344137345137346137347137348137349137350137351137352137353137354137355137356137357137358137359137360137361137362137363137364137365137366137367137368137369137370137371137372137373137374137375137376137377137378137379137380137381137382137383137384137385137386137387137388137389137390137391137392137393137394137395137396137397137398137399137400137401137402137403137404137405137406137407137408137409137410137411137412137413137414137415137416137417137418137419137420137421137422137423137424137425137426137427137428137429137430137431137432137433137434137435137436137437137438137439137440137441137442137443137444137445137446137447137448137449137450137451137452137453137454137455137456137457137458137459137460137461137462137463137464137465137466137467137468137469137470137471137472137473137474137475137476137477137478137479137480137481137482137483137484137485137486137487137488137489137490137491137492137493137494137495137496137497137498137499137500137501137502137503137504137505137506137507137508137509137510137511137512137513137514137515137516137517137518137519137520137521137522137523137524137525137526137527137528137529137530137531137532137533137534137535137536137537137538137539137540137541137542137543137544137545137546137547137548137549137550137551137552137553137554137555137556137557137558137559137560137561137562137563137564137565137566137567137568137569137570137571137572137573137574137575137576137577137578137579137580137581137582137583137584137585137586137587137588137589137590137591137592137593137594137595137596137597137598137599137600137601137602137603137604137605137606137607137608137609137610137611137612137613137614137615137616137617137618137619137620137621137622137623137624137625137626137627137628137629137630137631137632137633137634137635137636137637137638137639137640137641137642137643137644137645137646137647137648137649137650137651137652137653137654137655137656137657137658137659137660137661137662137663137664137665137666137667137668137669137670137671137672137673137674137675137676137677137678137679137680137681137682137683137684137685137686137687137688137689137690137691137692137693137694137695137696137697137698137699137700137701137702137703137704137705137706137707137708137709137710137711137712137713137714137715137716137717137718137719137720137721137722137723137724137725137726137727137728137729137730137731137732137733137734137735137736137737137738137739137740137741137742137743137744137745137746137747137748137749137750137751137752137753137754137755137756137757137758137759137760137761137762137763137764137765137766137767137768137769137770137771137772137773137774137775137776137777137778137779137780137781137782137783137784137785137786137787137788137789137790137791137792137793137794137795137796137797137798137799137800137801137802137803137804137805137806137807137808137809137810137811137812137813137814137815137816137817137818137819137820137821137822137823137824137825137826137827137828137829137830137831137832137833137834137835137836137837137838137839137840137841137842137843137844137845137846137847137848137849137850137851137852137853137854137855137856137857137858137859137860137861137862137863137864137865137866137867137868137869137870137871137872137873137874137875137876137877137878137879137880137881137882137883137884137885137886137887137888137889137890137891137892137893137894137895137896137897137898137899137900137901137902137903137904137905137906137907137908137909137910137911137912137913137914137915137916137917137918137919137920137921137922137923137924137925137926137927137928137929137930137931137932137933137934137935137936137937137938137939137940137941137942137943137944137945137946137947137948137949137950137951137952137953137954137955137956137957137958137959137960137961137962137963137964137965137966137967137968137969137970137971137972137973137974137975137976137977137978137979137980137981137982137983137984137985137986137987137988137989137990137991137992137993137994137995137996137997137998137999138000138001138002138003138004138005138006138007138008138009138010138011138012138013138014138015138016138017138018138019138020138021138022138023138024138025138026138027138028138029138030138031138032138033138034138035138036138037138038138039138040138041138042138043138044138045138046138047138048138049138050138051138052138053138054138055138056138057138058138059138060138061138062138063138064138065138066138067138068138069138070138071138072138073138074138075138076138077138078138079138080138081138082138083138084138085138086138087138088138089138090138091138092138093138094138095138096138097138098138099138100138101138102138103138104138105138106138107138108138109138110138111138112138113138114138115138116138117138118138119138120138121138122138123138124138125138126138127138128138129138130138131138132138133138134138135138136138137138138138139138140138141138142138143138144138145138146138147138148138149138150138151138152138153138154138155138156138157138158138159138160138161138162138163138164138165138166138167138168138169138170138171138172138173138174138175138176138177138178138179138180138181138182138183138184138185138186138187138188138189138190138191138192138193138194138195138196138197138198138199138200138201138202138203138204138205138206138207138208138209138210138211138212138213138214138215138216138217138218138219138220138221138222138223138224138225138226138227138228138229138230138231138232138233138234138235138236138237138238138239138240138241138242138243138244138245138246138247138248138249138250138251138252138253138254138255138256138257138258138259138260138261138262138263138264138265138266138267138268138269138270138271138272138273138274138275138276138277138278138279138280138281138282138283138284138285138286138287138288138289138290138291138292138293138294138295138296138297138298138299138300138301138302138303138304138305138306138307138308138309138310138311138312138313138314138315138316138317138318138319138320138321138322138323138324138325138326138327138328138329138330138331138332138333138334138335138336138337138338138339138340138341138342138343138344138345138346138347138348138349138350138351138352138353138354138355138356138357138358138359138360138361138362138363138364138365138366138367138368138369138370138371138372138373138374138375138376138377138378138379138380138381138382138383138384138385138386138387138388138389138390138391138392138393138394138395138396138397138398138399138400138401138402138403138404138405138406138407138408138409138410138411138412138413138414138415138416138417138418138419138420138421138422138423138424138425138426138427138428138429138430138431138432138433138434138435138436138437138438138439138440138441138442138443138444138445138446138447138448138449138450138451138452138453138454138455138456138457138458138459138460138461138462138463138464138465138466138467138468138469138470138471138472138473138474138475138476138477138478138479138480138481138482138483138484138485138486138487138488138489138490138491138492138493138494138495138496138497138498138499138500138501138502138503138504138505138506138507138508138509138510138511138512138513138514138515138516138517138518138519138520138521138522138523138524138525138526138527138528138529138530138531138532138533138534138535138536138537138538138539138540138541138542138543138544138545138546138547138548138549138550138551138552138553138554138555138556138557138558138559138560138561138562138563138564138565138566138567138568138569138570138571138572138573138574138575138576138577138578138579138580138581138582138583138584138585138586138587138588138589138590138591138592138593138594138595138596138597138598138599138600138601138602138603138604138605138606138607138608138609138610138611138612138613138614138615138616138617138618138619138620138621138622138623138624138625138626138627138628138629138630138631138632138633138634138635138636138637138638138639138640138641138642138643138644138645138646138647138648138649138650138651138652138653138654138655138656138657138658138659138660138661138662138663138664138665138666138667138668138669138670138671138672138673138674138675138676138677138678138679138680138681138682138683138684138685138686138687138688138689138690138691138692138693138694138695138696138697138698138699138700138701138702138703138704138705138706138707138708138709138710138711138712138713138714138715138716138717138718138719138720138721138722138723138724138725138726138727138728138729138730138731138732138733138734138735138736138737138738138739138740138741138742138743138744138745138746138747138748138749138750138751138752138753138754138755138756138757138758138759138760138761138762138763138764138765138766138767138768138769138770138771138772138773138774138775138776138777138778138779138780138781138782138783138784138785138786138787138788138789138790138791138792138793138794138795138796138797138798138799138800138801138802138803138804138805138806138807138808138809138810138811138812138813138814138815138816138817138818138819138820138821138822138823138824138825138826138827138828138829138830138831138832138833138834138835138836138837138838138839138840138841138842138843138844138845138846138847138848138849138850138851138852138853138854138855138856138857138858138859138860138861138862138863138864138865138866138867138868138869138870138871138872138873138874138875138876138877138878138879138880138881138882138883138884138885138886138887138888138889138890138891138892138893138894138895138896138897138898138899138900138901138902138903138904138905138906138907138908138909138910138911138912138913138914138915138916138917138918138919138920138921138922138923138924138925138926138927138928138929138930138931138932138933138934138935138936138937138938138939138940138941138942138943138944138945138946138947138948138949138950138951138952138953138954138955138956138957138958138959138960138961138962138963138964138965138966138967138968138969138970138971138972138973138974138975138976138977138978138979138980138981138982138983138984138985138986138987138988138989138990138991138992138993138994138995138996138997138998138999139000139001139002139003139004139005139006139007139008139009139010139011139012139013139014139015139016139017139018139019139020139021139022139023139024139025139026139027139028139029139030139031139032139033139034139035139036139037139038139039139040139041139042139043139044139045139046139047139048139049139050139051139052139053139054139055139056139057139058139059139060139061139062139063139064139065139066139067139068139069139070139071139072139073139074139075139076139077139078139079139080139081139082139083139084139085139086139087139088139089139090139091139092139093139094139095139096139097139098139099139100139101139102139103139104139105139106139107139108139109139110139111139112139113139114139115139116139117139118139119139120139121139122139123139124139125139126139127139128139129139130139131139132139133139134139135139136139137139138139139139140139141139142139143139144139145139146139147139148139149139150139151139152139153139154139155139156139157139158139159139160139161139162139163139164139165139166139167139168139169139170139171139172139173139174139175139176139177139178139179139180139181139182139183139184139185139186139187139188139189139190139191139192139193139194139195139196139197139198139199139200139201139202139203139204139205139206139207139208139209139210139211139212139213139214139215139216139217139218139219139220139221139222139223139224139225139226139227139228139229139230139231139232139233139234139235139236139237139238139239139240139241139242139243139244139245139246139247139248139249139250139251139252139253139254139255139256139257139258139259139260139261139262139263139264139265139266139267139268139269139270139271139272139273139274139275139276139277139278139279139280139281139282139283139284139285139286139287139288139289139290139291139292139293139294139295139296139297139298139299139300139301139302139303139304139305139306139307139308139309139310139311139312139313139314139315139316139317139318139319139320139321139322139323139324139325139326139327139328139329139330139331139332139333139334139335139336139337139338139339139340139341139342139343139344139345139346139347139348139349139350139351139352139353139354139355139356139357139358139359139360139361139362139363139364139365139366139367139368139369139370139371139372139373139374139375139376139377139378139379139380139381139382139383139384139385139386139387139388139389139390139391139392139393139394139395139396139397139398139399139400139401139402139403139404139405139406139407139408139409139410139411139412139413139414139415139416139417139418139419139420139421139422139423139424139425139426139427139428139429139430139431139432139433139434139435139436139437139438139439139440139441139442139443139444139445139446139447139448139449139450139451139452139453139454139455139456139457139458139459139460139461139462139463139464139465139466139467139468139469139470139471139472139473139474139475139476139477139478139479139480139481139482139483139484139485139486139487139488139489139490139491139492139493139494139495139496139497139498139499139500139501139502139503139504139505139506139507139508139509139510139511139512139513139514139515139516139517139518139519139520139521139522139523139524139525139526139527139528139529139530139531139532139533139534139535139536139537139538139539139540139541139542139543139544139545139546139547139548139549139550139551139552139553139554139555139556139557139558139559139560139561139562139563139564139565139566139567139568139569139570139571139572139573139574139575139576139577139578139579139580139581139582139583139584139585139586139587139588139589139590139591139592139593139594139595139596139597139598139599139600139601139602139603139604139605139606139607139608139609139610139611139612139613139614139615139616139617139618139619139620139621139622139623139624139625139626139627139628139629139630139631139632139633139634139635139636139637139638139639139640139641139642139643139644139645139646139647139648139649139650139651139652139653139654139655139656139657139658139659139660139661139662139663139664139665139666139667139668139669139670139671139672139673139674139675139676139677139678139679139680139681139682139683139684139685139686139687139688139689139690139691139692139693139694139695139696139697139698139699139700139701139702139703139704139705139706139707139708139709139710139711139712139713139714139715139716139717139718139719139720139721139722139723139724139725139726139727139728139729139730139731139732139733139734139735139736139737139738139739139740139741139742139743139744139745139746139747139748139749139750139751139752139753139754139755139756139757139758139759139760139761139762139763139764139765139766139767139768139769139770139771139772139773139774139775139776139777139778139779139780139781139782139783139784139785139786139787139788139789139790139791139792139793139794139795139796139797139798139799139800139801139802139803139804139805139806139807139808139809139810139811139812139813139814139815139816139817139818139819139820139821139822139823139824139825139826139827139828139829139830139831139832139833139834139835139836139837139838139839139840139841139842139843139844139845139846139847139848139849139850139851139852139853139854139855139856139857139858139859139860139861139862139863139864139865139866139867139868139869139870139871139872139873139874139875139876139877139878139879139880139881139882139883139884139885139886139887139888139889139890139891139892139893139894139895139896139897139898139899139900139901139902139903139904139905139906139907139908139909139910139911139912139913139914139915139916139917139918139919139920139921139922139923139924139925139926139927139928139929139930139931139932139933139934139935139936139937139938139939139940139941139942139943139944139945139946139947139948139949139950139951139952139953139954139955139956139957139958139959139960139961139962139963139964139965139966139967139968139969139970139971139972139973139974139975139976139977139978139979139980139981139982139983139984139985139986139987139988139989139990139991139992139993139994139995139996139997139998139999140000140001140002140003140004140005140006140007140008140009140010140011140012140013140014140015140016140017140018140019140020140021140022140023140024140025140026140027140028140029140030140031140032140033140034140035140036140037140038140039140040140041140042140043140044140045140046140047140048140049140050140051140052140053140054140055140056140057140058140059140060140061140062140063140064140065140066140067140068140069140070140071140072140073140074140075140076140077140078140079140080140081140082140083140084140085140086140087140088140089140090140091140092140093140094140095140096140097140098140099140100140101140102140103140104140105140106140107140108140109140110140111140112140113140114140115140116140117140118140119140120140121140122140123140124140125140126140127140128140129140130140131140132140133140134140135140136140137140138140139140140140141140142140143140144140145140146140147140148140149140150140151140152140153140154140155140156140157140158140159140160140161140162140163140164140165140166140167140168140169140170140171140172140173140174140175140176140177140178140179140180140181140182140183140184140185140186140187140188140189140190140191140192140193140194140195140196140197140198140199140200140201140202140203140204140205140206140207140208140209140210140211140212140213140214140215140216140217140218140219140220140221140222140223140224140225140226140227140228140229140230140231140232140233140234140235140236140237140238140239140240140241140242140243140244140245140246140247140248140249140250140251140252140253140254140255140256140257140258140259140260140261140262140263140264140265140266140267140268140269140270140271140272140273140274140275140276140277140278140279140280140281140282140283140284140285140286140287140288140289140290140291140292140293140294140295140296140297140298140299140300140301140302140303140304140305140306140307140308140309140310140311140312140313140314140315140316140317140318140319140320140321140322140323140324140325140326140327140328140329140330140331140332140333140334140335140336140337140338140339140340140341140342140343140344140345140346140347140348140349140350140351140352140353140354140355140356140357140358140359140360140361140362140363140364140365140366140367140368140369140370140371140372140373140374140375140376140377140378140379140380140381140382140383140384140385140386140387140388140389140390140391140392140393140394140395140396140397140398140399140400140401140402140403140404140405140406140407140408140409140410140411140412140413140414140415140416140417140418140419140420140421140422140423140424140425140426140427140428140429140430140431140432140433140434140435140436140437140438140439140440140441140442140443140444140445140446140447140448140449140450140451140452140453140454140455140456140457140458140459140460140461140462140463140464140465140466140467140468140469140470140471140472140473140474140475140476140477140478140479140480140481140482140483140484140485140486140487140488140489140490140491140492140493140494140495140496140497140498140499140500140501140502140503140504140505140506140507140508140509140510140511140512140513140514140515140516140517140518140519140520140521140522140523140524140525140526140527140528140529140530140531140532140533140534140535140536140537140538140539140540140541140542140543140544140545140546140547140548140549140550140551140552140553140554140555140556140557140558140559140560140561140562140563140564140565140566140567140568140569140570140571140572140573140574140575140576140577140578140579140580140581140582140583140584140585140586140587140588140589140590140591140592140593140594140595140596140597140598140599140600140601140602140603140604140605140606140607140608140609140610140611140612140613140614140615140616140617140618140619140620140621140622140623140624140625140626140627140628140629140630140631140632140633140634140635140636140637140638140639140640140641140642140643140644140645140646140647140648140649140650140651140652140653140654140655140656140657140658140659140660140661140662140663140664140665140666140667140668140669140670140671140672140673140674140675140676140677140678140679140680140681140682140683140684140685140686140687140688140689140690140691140692140693140694140695140696140697140698140699140700140701140702140703140704140705140706140707140708140709140710140711140712140713140714140715140716140717140718140719140720140721140722140723140724140725140726140727140728140729140730140731140732140733140734140735140736140737140738140739140740140741140742140743140744140745140746140747140748140749140750140751140752140753140754140755140756140757140758140759140760140761140762140763140764140765140766140767140768140769140770140771140772140773140774140775140776140777140778140779140780140781140782140783140784140785140786140787140788140789140790140791140792140793140794140795140796140797140798140799140800140801140802140803140804140805140806140807140808140809140810140811140812140813140814140815140816140817140818140819140820140821140822140823140824140825140826140827140828140829140830140831140832140833140834140835140836140837140838140839140840140841140842140843140844140845140846140847140848140849140850140851140852140853140854140855140856140857140858140859140860140861140862140863140864140865140866140867140868140869140870140871140872140873140874140875140876140877140878140879140880140881140882140883140884140885140886140887140888140889140890140891140892140893140894140895140896140897140898140899140900140901140902140903140904140905140906140907140908140909140910140911140912140913140914140915140916140917140918140919140920140921140922140923140924140925140926140927140928140929140930140931140932140933140934140935140936140937140938140939140940140941140942140943140944140945140946140947140948140949140950140951140952140953140954140955140956140957140958140959140960140961140962140963140964140965140966140967140968140969140970140971140972140973140974140975140976140977140978140979140980140981140982140983140984140985140986140987140988140989140990140991140992140993140994140995140996140997140998140999141000141001141002141003141004141005141006141007141008141009141010141011141012141013141014141015141016141017141018141019141020141021141022141023141024141025141026141027141028141029141030141031141032141033141034141035141036141037141038141039141040141041141042141043141044141045141046141047141048141049141050141051141052141053141054141055141056141057141058141059141060141061141062141063141064141065141066141067141068141069141070141071141072141073141074141075141076141077141078141079141080141081141082141083141084141085141086141087141088141089141090141091141092141093141094141095141096141097141098141099141100141101141102141103141104141105141106141107141108141109141110141111141112141113141114141115141116141117141118141119141120141121141122141123141124141125141126141127141128141129141130141131141132141133141134141135141136141137141138141139141140141141141142141143141144141145141146141147141148141149141150141151141152141153141154141155141156141157141158141159141160141161141162141163141164141165141166141167141168141169141170141171141172141173141174141175141176141177141178141179141180141181141182141183141184141185141186141187141188141189141190141191141192141193141194141195141196141197141198141199141200141201141202141203141204141205141206141207141208141209141210141211141212141213141214141215141216141217141218141219141220141221141222141223141224141225141226141227141228141229141230141231141232141233141234141235141236141237141238141239141240141241141242141243141244141245141246141247141248141249141250141251141252141253141254141255141256141257141258141259141260141261141262141263141264141265141266141267141268141269141270141271141272141273141274141275141276141277141278141279141280141281141282141283141284141285141286141287141288141289141290141291141292141293141294141295141296141297141298141299141300141301141302141303141304141305141306141307141308141309141310141311141312141313141314141315141316141317141318141319141320141321141322141323141324141325141326141327141328141329141330141331141332141333141334141335141336141337141338141339141340141341141342141343141344141345141346141347141348141349141350141351141352141353141354141355141356141357141358141359141360141361141362141363141364141365141366141367141368141369141370141371141372141373141374141375141376141377141378141379141380141381141382141383141384141385141386141387141388141389141390141391141392141393141394141395141396141397141398141399141400141401141402141403141404141405141406141407141408141409141410141411141412141413141414141415141416141417141418141419141420141421141422141423141424141425141426141427141428141429141430141431141432141433141434141435141436141437141438141439141440141441141442141443141444141445141446141447141448141449141450141451141452141453141454141455141456141457141458141459141460141461141462141463141464141465141466141467141468141469141470141471141472141473141474141475141476141477141478141479141480141481141482141483141484141485141486141487141488141489141490141491141492141493141494141495141496141497141498141499141500141501141502141503141504141505141506141507141508141509141510141511141512141513141514141515141516141517141518141519141520141521141522141523141524141525141526141527141528141529141530141531141532141533141534141535141536141537141538141539141540141541141542141543141544141545141546141547141548141549141550141551141552141553141554141555141556141557141558141559141560141561141562141563141564141565141566141567141568141569141570141571141572141573141574141575141576141577141578141579141580141581141582141583141584141585141586141587141588141589141590141591141592141593141594141595141596141597141598141599141600141601141602141603141604141605141606141607141608141609141610141611141612141613141614141615141616141617141618141619141620141621141622141623141624141625141626141627141628141629141630141631141632141633141634141635141636141637141638141639141640141641141642141643141644141645141646141647141648141649141650141651141652141653141654141655141656141657141658141659141660141661141662141663141664141665141666141667141668141669141670141671141672141673141674141675141676141677141678141679141680141681141682141683141684141685141686141687141688141689141690141691141692141693141694141695141696141697141698141699141700141701141702141703141704141705141706141707141708141709141710141711141712141713141714141715141716141717141718141719141720141721141722141723141724141725141726141727141728141729141730141731141732141733141734141735141736141737141738141739141740141741141742141743141744141745141746141747141748141749141750141751141752141753141754141755141756141757141758141759141760141761141762141763141764141765141766141767141768141769141770141771141772141773141774141775141776141777141778141779141780141781141782141783141784141785141786141787141788141789141790141791141792141793141794141795141796141797141798141799141800141801141802141803141804141805141806141807141808141809141810141811141812141813141814141815141816141817141818141819141820141821141822141823141824141825141826141827141828141829141830141831141832141833141834141835141836141837141838141839141840141841141842141843141844141845141846141847141848141849141850141851141852141853141854141855141856141857141858141859141860141861141862141863141864141865141866141867141868141869141870141871141872141873141874141875141876141877141878141879141880141881141882141883141884141885141886141887141888141889141890141891141892141893141894141895141896141897141898141899141900141901141902141903141904141905141906141907141908141909141910141911141912141913141914141915141916141917141918141919141920141921141922141923141924141925141926141927141928141929141930141931141932141933141934141935141936141937141938141939141940141941141942141943141944141945141946141947141948141949141950141951141952141953141954141955141956141957141958141959141960141961141962141963141964141965141966141967141968141969141970141971141972141973141974141975141976141977141978141979141980141981141982141983141984141985141986141987141988141989141990141991141992141993141994141995141996141997141998141999142000142001142002142003142004142005142006142007142008142009142010142011142012142013142014142015142016142017142018142019142020142021142022142023142024142025142026142027142028142029142030142031142032142033142034142035142036142037142038142039142040142041142042142043142044142045142046142047142048142049142050142051142052142053142054142055142056142057142058142059142060142061142062142063142064142065142066142067142068142069142070142071142072142073142074142075142076142077142078142079142080142081142082142083142084142085142086142087142088142089142090142091142092142093142094142095142096142097142098142099142100142101142102142103142104142105142106142107142108142109142110142111142112142113142114142115142116142117142118142119142120142121142122142123142124142125142126142127142128142129142130142131142132142133142134142135142136142137142138142139142140142141142142142143142144142145142146142147142148142149142150142151142152142153142154142155142156142157142158142159142160142161142162142163142164142165142166142167142168142169142170142171142172142173142174142175142176142177142178142179142180142181142182142183142184142185142186142187142188142189142190142191142192142193142194142195142196142197142198142199142200142201142202142203142204142205142206142207142208142209142210142211142212142213142214142215142216142217142218142219142220142221142222142223142224142225142226142227142228142229142230142231142232142233142234142235142236142237142238142239142240142241142242142243142244142245142246142247142248142249142250142251142252142253142254142255142256142257142258142259142260142261142262142263142264142265142266142267142268142269142270142271142272142273142274142275142276142277142278142279142280142281142282142283142284142285142286142287142288142289142290142291142292142293142294142295142296142297142298142299142300142301142302142303142304142305142306142307142308142309142310142311142312142313142314142315142316142317142318142319142320142321142322142323142324142325142326142327142328142329142330142331142332142333142334142335142336142337142338142339142340142341142342142343142344142345142346142347142348142349142350142351142352142353142354142355142356142357142358142359142360142361142362142363142364142365142366142367142368142369142370142371142372142373142374142375142376142377142378142379142380142381142382142383142384142385142386142387142388142389142390142391142392142393142394142395142396142397142398142399142400142401142402142403142404142405142406142407142408142409142410142411142412142413142414142415142416142417142418142419142420142421142422142423142424142425142426142427142428142429142430142431142432142433142434142435142436142437142438142439142440142441142442142443142444142445142446142447142448142449142450142451142452142453142454142455142456142457142458142459142460142461142462142463142464142465142466142467142468142469142470142471142472142473142474142475142476142477142478142479142480142481142482142483142484142485142486142487142488142489142490142491142492142493142494142495142496142497142498142499142500142501142502142503142504142505142506142507142508142509142510142511142512142513142514142515142516142517142518142519142520142521142522142523142524142525142526142527142528142529142530142531142532142533142534142535142536142537142538142539142540142541142542142543142544142545142546142547142548142549142550142551142552142553142554142555142556142557142558142559142560142561142562142563142564142565142566142567142568142569142570142571142572142573142574142575142576142577142578142579142580142581142582142583142584142585142586142587142588142589142590142591142592142593142594142595142596142597142598142599142600142601142602142603142604142605142606142607142608142609142610142611142612142613142614142615142616142617142618142619142620142621142622142623142624142625142626142627142628142629142630142631142632142633142634142635142636142637142638142639142640142641142642142643142644142645142646142647142648142649142650142651142652142653142654142655142656142657142658142659142660142661142662142663142664142665142666142667142668142669142670142671142672142673142674142675142676142677142678142679142680142681142682142683142684142685142686142687142688142689142690142691142692142693142694142695142696142697142698142699142700142701142702142703142704142705142706142707142708142709142710142711142712142713142714142715142716142717142718142719142720142721142722142723142724142725142726142727142728142729142730142731142732142733142734142735142736142737142738142739142740142741142742142743142744142745142746142747142748142749142750142751142752142753142754142755142756142757142758142759142760142761142762142763142764142765142766142767142768142769142770142771142772142773142774142775142776142777142778142779142780142781142782142783142784142785142786142787142788142789142790142791142792142793142794142795142796142797142798142799142800142801142802142803142804142805142806142807142808142809142810142811142812142813142814142815142816142817142818142819142820142821142822142823142824142825142826142827142828142829142830142831142832142833142834142835142836142837142838142839142840142841142842142843142844142845142846142847142848142849142850142851142852142853142854142855142856142857142858142859142860142861142862142863142864142865142866142867142868142869142870142871142872142873142874142875142876142877142878142879142880142881142882142883142884142885142886142887142888142889142890142891142892142893142894142895142896142897142898142899142900142901142902142903142904142905142906142907142908142909142910142911142912142913142914142915142916142917142918142919142920142921142922142923142924142925142926142927142928142929142930142931142932142933142934142935142936142937142938142939142940142941142942142943142944142945142946142947142948142949142950142951142952142953142954142955142956142957142958142959142960142961142962142963142964142965142966142967142968142969142970142971142972142973142974142975142976142977142978142979142980142981142982142983142984142985142986142987142988142989142990142991142992142993142994142995142996142997142998142999143000143001143002143003143004143005143006143007143008143009143010143011143012143013143014143015143016143017143018143019143020143021143022143023143024143025143026143027143028143029143030143031143032143033143034143035143036143037143038143039143040143041143042143043143044143045143046143047143048143049143050143051143052143053143054143055143056143057143058143059143060143061143062143063143064143065143066143067143068143069143070143071143072143073143074143075143076143077143078143079143080143081143082143083143084143085143086143087143088143089143090143091143092143093143094143095143096143097143098143099143100143101143102143103143104143105143106143107143108143109143110143111143112143113143114143115143116143117143118143119143120143121143122143123143124143125143126143127143128143129143130143131143132143133143134143135143136143137143138143139143140143141143142143143143144143145143146143147143148143149143150143151143152143153143154143155143156143157143158143159143160143161143162143163143164143165143166143167143168143169143170143171143172143173143174143175143176143177143178143179143180143181143182143183143184143185143186143187143188143189143190143191143192143193143194143195143196143197143198143199143200143201143202143203143204143205143206143207143208143209143210143211143212143213143214143215143216143217143218143219143220143221143222143223143224143225143226143227143228143229143230143231143232143233143234143235143236143237143238143239143240143241143242143243143244143245143246143247143248143249143250143251143252143253143254143255143256143257143258143259143260143261143262143263143264143265143266143267143268143269143270143271143272143273143274143275143276143277143278143279143280143281143282143283143284143285143286143287143288143289143290143291143292143293143294143295143296143297143298143299143300143301143302143303143304143305143306143307143308143309143310143311143312143313143314143315143316143317143318143319143320143321143322143323143324143325143326143327143328143329143330143331143332143333143334143335143336143337143338143339143340143341143342143343143344143345143346143347143348143349143350143351143352143353143354143355143356143357143358143359143360143361143362143363143364143365143366143367143368143369143370143371143372143373143374143375143376143377143378143379143380143381143382143383143384143385143386143387143388143389143390143391143392143393143394143395143396143397143398143399143400143401143402143403143404143405143406143407143408143409143410143411143412143413143414143415143416143417143418143419143420143421143422143423143424143425143426143427143428143429143430143431143432143433143434143435143436143437143438143439143440143441143442143443143444143445143446143447143448143449143450143451143452143453143454143455143456143457143458143459143460143461143462143463143464143465143466143467143468143469143470143471143472143473143474143475143476143477143478143479143480143481143482143483143484143485143486143487143488143489143490143491143492143493143494143495143496143497143498143499143500143501143502143503143504143505143506143507143508143509143510143511143512143513143514143515143516143517143518143519143520143521143522143523143524143525143526143527143528143529143530143531143532143533143534143535143536143537143538143539143540143541143542143543143544143545143546143547143548143549143550143551143552143553143554143555143556143557143558143559143560143561143562143563143564143565143566143567143568143569143570143571143572143573143574143575143576143577143578143579143580143581143582143583143584143585143586143587143588143589143590143591143592143593143594143595143596143597143598143599143600143601143602143603143604143605143606143607143608143609143610143611143612143613143614143615143616143617143618143619143620143621143622143623143624143625143626143627143628143629143630143631143632143633143634143635143636143637143638143639143640143641143642143643143644143645143646143647143648143649143650143651143652143653143654143655143656143657143658143659143660143661143662143663143664143665143666143667143668143669143670143671143672143673143674143675143676143677143678143679143680143681143682143683143684143685143686143687143688143689143690143691143692143693143694143695143696143697143698143699143700143701143702143703143704143705143706143707143708143709143710143711143712143713143714143715143716143717143718143719143720143721143722143723143724143725143726143727143728143729143730143731143732143733143734143735143736143737143738143739143740143741143742143743143744143745143746143747143748143749143750143751143752143753143754143755143756143757143758143759143760143761143762143763143764143765143766143767143768143769143770143771143772143773143774143775143776143777143778143779143780143781143782143783143784143785143786143787143788143789143790143791143792143793143794143795143796143797143798143799143800143801143802143803143804143805143806143807143808143809143810143811143812143813143814143815143816143817143818143819143820143821143822143823143824143825143826143827143828143829143830143831143832143833143834143835143836143837143838143839143840143841143842143843143844143845143846143847143848143849143850143851143852143853143854143855143856143857143858143859143860143861143862143863143864143865143866143867143868143869143870143871143872143873143874143875143876143877143878143879143880143881143882143883143884143885143886143887143888143889143890143891143892143893143894143895143896143897143898143899143900143901143902143903143904143905143906143907143908143909143910143911143912143913143914143915143916143917143918143919143920143921143922143923143924143925143926143927143928143929143930143931143932143933143934143935143936143937143938143939143940143941143942143943143944143945143946143947143948143949143950143951143952143953143954143955143956143957143958143959143960143961143962143963143964143965143966143967143968143969143970143971143972143973143974143975143976143977143978143979143980143981143982143983143984143985143986143987143988143989143990143991143992143993143994143995143996143997143998143999144000144001144002144003144004144005144006144007144008144009144010144011144012144013144014144015144016144017144018144019144020144021144022144023144024144025144026144027144028144029144030144031144032144033144034144035144036144037144038144039144040144041144042144043144044144045144046144047144048144049144050144051144052144053144054144055144056144057144058144059144060144061144062144063144064144065144066144067144068144069144070144071144072144073144074144075144076144077144078144079144080144081144082144083144084144085144086144087144088144089144090144091144092144093144094144095144096144097144098144099144100144101144102144103144104144105144106144107144108144109144110144111144112144113144114144115144116144117144118144119144120144121144122144123144124144125144126144127144128144129144130144131144132144133144134144135144136144137144138144139144140144141144142144143144144144145144146144147144148144149144150144151144152144153144154144155144156144157144158144159144160144161144162144163144164144165144166144167144168144169144170144171144172144173144174144175144176144177144178144179144180144181144182144183144184144185144186144187144188144189144190144191144192144193144194144195144196144197144198144199144200144201144202144203144204144205144206144207144208144209144210144211144212144213144214144215144216144217144218144219144220144221144222144223144224144225144226144227144228144229144230144231144232144233144234144235144236144237144238144239144240144241144242144243144244144245144246144247144248144249144250144251144252144253144254144255144256144257144258144259144260144261144262144263144264144265144266144267144268144269144270144271144272144273144274144275144276144277144278144279144280144281144282144283144284144285144286144287144288144289144290144291144292144293144294144295144296144297144298144299144300144301144302144303144304144305144306144307144308144309144310144311144312144313144314144315144316144317144318144319144320144321144322144323144324144325144326144327144328144329144330144331144332144333144334144335144336144337144338144339144340144341144342144343144344144345144346144347144348144349144350144351144352144353144354144355144356144357144358144359144360144361144362144363144364144365144366144367144368144369144370144371144372144373144374144375144376144377144378144379144380144381144382144383144384144385144386144387144388144389144390144391144392144393144394144395144396144397144398144399144400144401144402144403144404144405144406144407144408144409144410144411144412144413144414144415144416144417144418144419144420144421144422144423144424144425144426144427144428144429144430144431144432144433144434144435144436144437144438144439144440144441144442144443144444144445144446144447144448144449144450144451144452144453144454144455144456144457144458144459144460144461144462144463144464144465144466144467144468144469144470144471144472144473144474144475144476144477144478144479144480144481144482144483144484144485144486144487144488144489144490144491144492144493144494144495144496144497144498144499144500144501144502144503144504144505144506144507144508144509144510144511144512144513144514144515144516144517144518144519144520144521144522144523144524144525144526144527144528144529144530144531144532144533144534144535144536144537144538144539144540144541144542144543144544144545144546144547144548144549144550144551144552144553144554144555144556144557144558144559144560144561144562144563144564144565144566144567144568144569144570144571144572144573144574144575144576144577144578144579144580144581144582144583144584144585144586144587144588144589144590144591144592144593144594144595144596144597144598144599144600144601144602144603144604144605144606144607144608144609144610144611144612144613144614144615144616144617144618144619144620144621144622144623144624144625144626144627144628144629144630144631144632144633144634144635144636144637144638144639144640144641144642144643144644144645144646144647144648144649144650144651144652144653144654144655144656144657144658144659144660144661144662144663144664144665144666144667144668144669144670144671144672144673144674144675144676144677144678144679144680144681144682144683144684144685144686144687144688144689144690144691144692144693144694144695144696144697144698144699144700144701144702144703144704144705144706144707144708144709144710144711144712144713144714144715144716144717144718144719144720144721144722144723144724144725144726144727144728144729144730144731144732144733144734144735144736144737144738144739144740144741144742144743144744144745144746144747144748144749144750144751144752144753144754144755144756144757144758144759144760144761144762144763144764144765144766144767144768144769144770144771144772144773144774144775144776144777144778144779144780144781144782144783144784144785144786144787144788144789144790144791144792144793144794144795144796144797144798144799144800144801144802144803144804144805144806144807144808144809144810144811144812144813144814144815144816144817144818144819144820144821144822144823144824144825144826144827144828144829144830144831144832144833144834144835144836144837144838144839144840144841144842144843144844144845144846144847144848144849144850144851144852144853144854144855144856144857144858144859144860144861144862144863144864144865144866144867144868144869144870144871144872144873144874144875144876144877144878144879144880144881144882144883144884144885144886144887144888144889144890144891144892144893144894144895144896144897144898144899144900144901144902144903144904144905144906144907144908144909144910144911144912144913144914144915144916144917144918144919144920144921144922144923144924144925144926144927144928144929144930144931144932144933144934144935144936144937144938144939144940144941144942144943144944144945144946144947144948144949144950144951144952144953144954144955144956144957144958144959144960144961144962144963144964144965144966144967144968144969144970144971144972144973144974144975144976144977144978144979144980144981144982144983144984144985144986144987144988144989144990144991144992144993144994144995144996144997144998144999145000145001145002145003145004145005145006145007145008145009145010145011145012145013145014145015145016145017145018145019145020145021145022145023145024145025145026145027145028145029145030145031145032145033145034145035145036145037145038145039145040145041145042145043145044145045145046145047145048145049145050145051145052145053145054145055145056145057145058145059145060145061145062145063145064145065145066145067145068145069145070145071145072145073145074145075145076145077145078145079145080145081145082145083145084145085145086145087145088145089145090145091145092145093145094145095145096145097145098145099145100145101145102145103145104145105145106145107145108145109145110145111145112145113145114145115145116145117145118145119145120145121145122145123145124145125145126145127145128145129145130145131145132145133145134145135145136145137145138145139145140145141145142145143145144145145145146145147145148145149145150145151145152145153145154145155145156145157145158145159145160145161145162145163145164145165145166145167145168145169145170145171145172145173145174145175145176145177145178145179145180145181145182145183145184145185145186145187145188145189145190145191145192145193145194145195145196145197145198145199145200145201145202145203145204145205145206145207145208145209145210145211145212145213145214145215145216145217145218145219145220145221145222145223145224145225145226145227145228145229145230145231145232145233145234145235145236145237145238145239145240145241145242145243145244145245145246145247145248145249145250145251145252145253145254145255145256145257145258145259145260145261145262145263145264145265145266145267145268145269145270145271145272145273145274145275145276145277145278145279145280145281145282145283145284145285145286145287145288145289145290145291145292145293145294145295145296145297145298145299145300145301145302145303145304145305145306145307145308145309145310145311145312145313145314145315145316145317145318145319145320145321145322145323145324145325145326145327145328145329145330145331145332145333145334145335145336145337145338145339145340145341145342145343145344145345145346145347145348145349145350145351145352145353145354145355145356145357145358145359145360145361145362145363145364145365145366145367145368145369145370145371145372145373145374145375145376145377145378145379145380145381145382145383145384145385145386145387145388145389145390145391145392145393145394145395145396145397145398145399145400145401145402145403145404145405145406145407145408145409145410145411145412145413145414145415145416145417145418145419145420145421145422145423145424145425145426145427145428145429145430145431145432145433145434145435145436145437145438145439145440145441145442145443145444145445145446145447145448145449145450145451145452145453145454145455145456145457145458145459145460145461145462145463145464145465145466145467145468145469145470145471145472145473145474145475145476145477145478145479145480145481145482145483145484145485145486145487145488145489145490145491145492145493145494145495145496145497145498145499145500145501145502145503145504145505145506145507145508145509145510145511145512145513145514145515145516145517145518145519145520145521145522145523145524145525145526145527145528145529145530145531145532145533145534145535145536145537145538145539145540145541145542145543145544145545145546145547145548145549145550145551145552145553145554145555145556145557145558145559145560145561145562145563145564145565145566145567145568145569145570145571145572145573145574145575145576145577145578145579145580145581145582145583145584145585145586145587145588145589145590145591145592145593145594145595145596145597145598145599145600145601145602145603145604145605145606145607145608145609145610145611145612145613145614145615145616145617145618145619145620145621145622145623145624145625145626145627145628145629145630145631145632145633145634145635145636145637145638145639145640145641145642145643145644145645145646145647145648145649145650145651145652145653145654145655145656145657145658145659145660145661145662145663145664145665145666145667145668145669145670145671145672145673145674145675145676145677145678145679145680145681145682145683145684145685145686145687145688145689145690145691145692145693145694145695145696145697145698145699145700145701145702145703145704145705145706145707145708145709145710145711145712145713145714145715145716145717145718145719145720145721145722145723145724145725145726145727145728145729145730145731145732145733145734145735145736145737145738145739145740145741145742145743145744145745145746145747145748145749145750145751145752145753145754145755145756145757145758145759145760145761145762145763145764145765145766145767145768145769145770145771145772145773145774145775145776145777145778145779145780145781145782145783145784145785145786145787145788145789145790145791145792145793145794145795145796145797145798145799145800145801145802145803145804145805145806145807145808145809145810145811145812145813145814145815145816145817145818145819145820145821145822145823145824145825145826145827145828145829145830145831145832145833145834145835145836145837145838145839145840145841145842145843145844145845145846145847145848145849145850145851145852145853145854145855145856145857145858145859145860145861145862145863145864145865145866145867145868145869145870145871145872145873145874145875145876145877145878145879145880145881145882145883145884145885145886145887145888145889145890145891145892145893145894145895145896145897145898145899145900145901145902145903145904145905145906145907145908145909145910145911145912145913145914145915145916145917145918145919145920145921145922145923145924145925145926145927145928145929145930145931145932145933145934145935145936145937145938145939145940145941145942145943145944145945145946145947145948145949145950145951145952145953145954145955145956145957145958145959145960145961145962145963145964145965145966145967145968145969145970145971145972145973145974145975145976145977145978145979145980145981145982145983145984145985145986145987145988145989145990145991145992145993145994145995145996145997145998145999146000146001146002146003146004146005146006146007146008146009146010146011146012146013146014146015146016146017146018146019146020146021146022146023146024146025146026146027146028146029146030146031146032146033146034146035146036146037146038146039146040146041146042146043146044146045146046146047146048146049146050146051146052146053146054146055146056146057146058146059146060146061146062146063146064146065146066146067146068146069146070146071146072146073146074146075146076146077146078146079146080146081146082146083146084146085146086146087146088146089146090146091146092146093146094146095146096146097146098146099146100146101146102146103146104146105146106146107146108146109146110146111146112146113146114146115146116146117146118146119146120146121146122146123146124146125146126146127146128146129146130146131146132146133146134146135146136146137146138146139146140146141146142146143146144146145146146146147146148146149146150146151146152146153146154146155146156146157146158146159146160146161146162146163146164146165146166146167146168146169146170146171146172146173146174146175146176146177146178146179146180146181146182146183146184146185146186146187146188146189146190146191146192146193146194146195146196146197146198146199146200146201146202146203146204146205146206146207146208146209146210146211146212146213146214146215146216146217146218146219146220146221146222146223146224146225146226146227146228146229146230146231146232146233146234146235146236146237146238146239146240146241146242146243146244146245146246146247146248146249146250146251146252146253146254146255146256146257146258146259146260146261146262146263146264146265146266146267146268146269146270146271146272146273146274146275146276146277146278146279146280146281146282146283146284146285146286146287146288146289146290146291146292146293146294146295146296146297146298146299146300146301146302146303146304146305146306146307146308146309146310146311146312146313146314146315146316146317146318146319146320146321146322146323146324146325146326146327146328146329146330146331146332146333146334146335146336146337146338146339146340146341146342146343146344146345146346146347146348146349146350146351146352146353146354146355146356146357146358146359146360146361146362146363146364146365146366146367146368146369146370146371146372146373146374146375146376146377146378146379146380146381146382146383146384146385146386146387146388146389146390146391146392146393146394146395146396146397146398146399146400146401146402146403146404146405146406146407146408146409146410146411146412146413146414146415146416146417146418146419146420146421146422146423146424146425146426146427146428146429146430146431146432146433146434146435146436146437146438146439146440146441146442146443146444146445146446146447146448146449146450146451146452146453146454146455146456146457146458146459146460146461146462146463146464146465146466146467146468146469146470146471146472146473146474146475146476146477146478146479146480146481146482146483146484146485146486146487146488146489146490146491146492146493146494146495146496146497146498146499146500146501146502146503146504146505146506146507146508146509146510146511146512146513146514146515146516146517146518146519146520146521146522146523146524146525146526146527146528146529146530146531146532146533146534146535146536146537146538146539146540146541146542146543146544146545146546146547146548146549146550146551146552146553146554146555146556146557146558146559146560146561146562146563146564146565146566146567146568146569146570146571146572146573146574146575146576146577146578146579146580146581146582146583146584146585146586146587146588146589146590146591146592146593146594146595146596146597146598146599146600146601146602146603146604146605146606146607146608146609146610146611146612146613146614146615146616146617146618146619146620146621146622146623146624146625146626146627146628146629146630146631146632146633146634146635146636146637146638146639146640146641146642146643146644146645146646146647146648146649146650146651146652146653146654146655146656146657146658146659146660146661146662146663146664146665146666146667146668146669146670146671146672146673146674146675146676146677146678146679146680146681146682146683146684146685146686146687146688146689146690146691146692146693146694146695146696146697146698146699146700146701146702146703146704146705146706146707146708146709146710146711146712146713146714146715146716146717146718146719146720146721146722146723146724146725146726146727146728146729146730146731146732146733146734146735146736146737146738146739146740146741146742146743146744146745146746146747146748146749146750146751146752146753146754146755146756146757146758146759146760146761146762146763146764146765146766146767146768146769146770146771146772146773146774146775146776146777146778146779146780146781146782146783146784146785146786146787146788146789146790146791146792146793146794146795146796146797146798146799146800146801146802146803146804146805146806146807146808146809146810146811146812146813146814146815146816146817146818146819146820146821146822146823146824146825146826146827146828146829146830146831146832146833146834146835146836146837146838146839146840146841146842146843146844146845146846146847146848146849146850146851146852146853146854146855146856146857146858146859146860146861146862146863146864146865146866146867146868146869146870146871146872146873146874146875146876146877146878146879146880146881146882146883146884146885146886146887146888146889146890146891146892146893146894146895146896146897146898146899146900146901146902146903146904146905146906146907146908146909146910146911146912146913146914146915146916146917146918146919146920146921146922146923146924146925146926146927146928146929146930146931146932146933146934146935146936146937146938146939146940146941146942146943146944146945146946146947146948146949146950146951146952146953146954146955146956146957146958146959146960146961146962146963146964146965146966146967146968146969146970146971146972146973146974146975146976146977146978146979146980146981146982146983146984146985146986146987146988146989146990146991146992146993146994146995146996146997146998146999147000147001147002147003147004147005147006147007147008147009147010147011147012147013147014147015147016147017147018147019147020147021147022147023147024147025147026147027147028147029147030147031147032147033147034147035147036147037147038147039147040147041147042147043147044147045147046147047147048147049147050147051147052147053147054147055147056147057147058147059147060147061147062147063147064147065147066147067147068147069147070147071147072147073147074147075147076147077147078147079147080147081147082147083147084147085147086147087147088147089147090147091147092147093147094147095147096147097147098147099147100147101147102147103147104147105147106147107147108147109147110147111147112147113147114147115147116147117147118147119147120147121147122147123147124147125147126147127147128147129147130147131147132147133147134147135147136147137147138147139147140147141147142147143147144147145147146147147147148147149147150147151147152147153147154147155147156147157147158147159147160147161147162147163147164147165147166147167147168147169147170147171147172147173147174147175147176147177147178147179147180147181147182147183147184147185147186147187147188147189147190147191147192147193147194147195147196147197147198147199147200147201147202147203147204147205147206147207147208147209147210147211147212147213147214147215147216147217147218147219147220147221147222147223147224147225147226147227147228147229147230147231147232147233147234147235147236147237147238147239147240147241147242147243147244147245147246147247147248147249147250147251147252147253147254147255147256147257147258147259147260147261147262147263147264147265147266147267147268147269147270147271147272147273147274147275147276147277147278147279147280147281147282147283147284147285147286147287147288147289147290147291147292147293147294147295147296147297147298147299147300147301147302147303147304147305147306147307147308147309147310147311147312147313147314147315147316147317147318147319147320147321147322147323147324147325147326147327147328147329147330147331147332147333147334147335147336147337147338147339147340147341147342147343147344147345147346147347147348147349147350147351147352147353147354147355147356147357147358147359147360147361147362147363147364147365147366147367147368147369147370147371147372147373147374147375147376147377147378147379147380147381147382147383147384147385147386147387147388147389147390147391147392147393147394147395147396147397147398147399147400147401147402147403147404147405147406147407147408147409147410147411147412147413147414147415147416147417147418147419147420147421147422147423147424147425147426147427147428147429147430147431147432147433147434147435147436147437147438147439147440147441147442147443147444147445147446147447147448147449147450147451147452147453147454147455147456147457147458147459147460147461147462147463147464147465147466147467147468147469147470147471147472147473147474147475147476147477147478147479147480147481147482147483147484147485147486147487147488147489147490147491147492147493147494147495147496147497147498147499147500147501147502147503147504147505147506147507147508147509147510147511147512147513147514147515147516147517147518147519147520147521147522147523147524147525147526147527147528147529147530147531147532147533147534147535147536147537147538147539147540147541147542147543147544147545147546147547147548147549147550147551147552147553147554147555147556147557147558147559147560147561147562147563147564147565147566147567147568147569147570147571147572147573147574147575147576147577147578147579147580147581147582147583147584147585147586147587147588147589147590147591147592147593147594147595147596147597147598147599147600147601147602147603147604147605147606147607147608147609147610147611147612147613147614147615147616147617147618147619147620147621147622147623147624147625147626147627147628147629147630147631147632147633147634147635147636147637147638147639147640147641147642147643147644147645147646147647147648147649147650147651147652147653147654147655147656147657147658147659147660147661147662147663147664147665147666147667147668147669147670147671147672147673147674147675147676147677147678147679147680147681147682147683147684147685147686147687147688147689147690147691147692147693147694147695147696147697147698147699147700147701147702147703147704147705147706147707147708147709147710147711147712147713147714147715147716147717147718147719147720147721147722147723147724147725147726147727147728147729147730147731147732147733147734147735147736147737147738147739147740147741147742147743147744147745147746147747147748147749147750147751147752147753147754147755147756147757147758147759147760147761147762147763147764147765147766147767147768147769147770147771147772147773147774147775147776147777147778147779147780147781147782147783147784147785147786147787147788147789147790147791147792147793147794147795147796147797147798147799147800147801147802147803147804147805147806147807147808147809147810147811147812147813147814147815147816147817147818147819147820147821147822147823147824147825147826147827147828147829147830147831147832147833147834147835147836147837147838147839147840147841147842147843147844147845147846147847147848147849147850147851147852147853147854147855147856147857147858147859147860147861147862147863147864147865147866147867147868147869147870147871147872147873147874147875147876147877147878147879147880147881147882147883147884147885147886147887147888147889147890147891147892147893147894147895147896147897147898147899147900147901147902147903147904147905147906147907147908147909147910147911147912147913147914147915147916147917147918147919147920147921147922147923147924147925147926147927147928147929147930147931147932147933147934147935147936147937147938147939147940147941147942147943147944147945147946147947147948147949147950147951147952147953147954147955147956147957147958147959147960147961147962147963147964147965147966147967147968147969147970147971147972147973147974147975147976147977147978147979147980147981147982147983147984147985147986147987147988147989147990147991147992147993147994147995147996147997147998147999148000148001148002148003148004148005148006148007148008148009148010148011148012148013148014148015148016148017148018148019148020148021148022148023148024148025148026148027148028148029148030148031148032148033148034148035148036148037148038148039148040148041148042148043148044148045148046148047148048148049148050148051148052148053148054148055148056148057148058148059148060148061148062148063148064148065148066148067148068148069148070148071148072148073148074148075148076148077148078148079148080148081148082148083148084148085148086148087148088148089148090148091148092148093148094148095148096148097148098148099148100148101148102148103148104148105148106148107148108148109148110148111148112148113148114148115148116148117148118148119148120148121148122148123148124148125148126148127148128148129148130148131148132148133148134148135148136148137148138148139148140148141148142148143148144148145148146148147148148148149148150148151148152148153148154148155148156148157148158148159148160148161148162148163148164148165148166148167148168148169148170148171148172148173148174148175148176148177148178148179148180148181148182148183148184148185148186148187148188148189148190148191148192148193148194148195148196148197148198148199148200148201148202148203148204148205148206148207148208148209148210148211148212148213148214148215148216148217148218148219148220148221148222148223148224148225148226148227148228148229148230148231148232148233148234148235148236148237148238148239148240148241148242148243148244148245148246148247148248148249148250148251148252148253148254148255148256148257148258148259148260148261148262148263148264148265148266148267148268148269148270148271148272148273148274148275148276148277148278148279148280148281148282148283148284148285148286148287148288148289148290148291148292148293148294148295148296148297148298148299148300148301148302148303148304148305148306148307148308148309148310148311148312148313148314148315148316148317148318148319148320148321148322148323148324148325148326148327148328148329148330148331148332148333148334148335148336148337148338148339148340148341148342148343148344148345148346148347148348148349148350148351148352148353148354148355148356148357148358148359148360148361148362148363148364148365148366148367148368148369148370148371148372148373148374148375148376148377148378148379148380148381148382148383148384148385148386148387148388148389148390148391148392148393148394148395148396148397148398148399148400148401148402148403148404148405148406148407148408148409148410148411148412148413148414148415148416148417148418148419148420148421148422148423148424148425148426148427148428148429148430148431148432148433148434148435148436148437148438148439148440148441148442148443148444148445148446148447148448148449148450148451148452148453148454148455148456148457148458148459148460148461148462148463148464148465148466148467148468148469148470148471148472148473148474148475148476148477148478148479148480148481148482148483148484148485148486148487148488148489148490148491148492148493148494148495148496148497148498148499148500148501148502148503148504148505148506148507148508148509148510148511148512148513148514148515148516148517148518148519148520148521148522148523148524148525148526148527148528148529148530148531148532148533148534148535148536148537148538148539148540148541148542148543148544148545148546148547148548148549148550148551148552148553148554148555148556148557148558148559148560148561148562148563148564148565148566148567148568148569148570148571148572148573148574148575148576148577148578148579148580148581148582148583148584148585148586148587148588148589148590148591148592148593148594148595148596148597148598148599148600148601148602148603148604148605148606148607148608148609148610148611148612148613148614148615148616148617148618148619148620148621148622148623148624148625148626148627148628148629148630148631148632148633148634148635148636148637148638148639148640148641148642148643148644148645148646148647148648148649148650148651148652148653148654148655148656148657148658148659148660148661148662148663148664148665148666148667148668148669148670148671148672148673148674148675148676148677148678148679148680148681148682148683148684148685148686148687148688148689148690148691148692148693148694148695148696148697148698148699148700148701148702148703148704148705148706148707148708148709148710148711148712148713148714148715148716148717148718148719148720148721148722148723148724148725148726148727148728148729148730148731148732148733148734148735148736148737148738148739148740148741148742148743148744148745148746148747148748148749148750148751148752148753148754148755148756148757148758148759148760148761148762148763148764148765148766148767148768148769148770148771148772148773148774148775148776148777148778148779148780148781148782148783148784148785148786148787148788148789148790148791148792148793148794148795148796148797148798148799148800148801148802148803148804148805148806148807148808148809148810148811148812148813148814148815148816148817148818148819148820148821148822148823148824148825148826148827148828148829148830148831148832148833148834148835148836148837148838148839148840148841148842148843148844148845148846148847148848148849148850148851148852148853148854148855148856148857148858148859148860148861148862148863148864148865148866148867148868148869148870148871148872148873148874148875148876148877148878148879148880148881148882148883148884148885148886148887148888148889148890148891148892148893148894148895148896148897148898148899148900148901148902148903148904148905148906148907148908148909148910148911148912148913148914148915148916148917148918148919148920148921148922148923148924148925148926148927148928148929148930148931148932148933148934148935148936148937148938148939148940148941148942148943148944148945148946148947148948148949148950148951148952148953148954148955148956148957148958148959148960148961148962148963148964148965148966148967148968148969148970148971148972148973148974148975148976148977148978148979148980148981148982148983148984148985148986148987148988148989148990148991148992148993148994148995148996148997148998148999149000149001149002149003149004149005149006149007149008149009149010149011149012149013149014149015149016149017149018149019149020149021149022149023149024149025149026149027149028149029149030149031149032149033149034149035149036149037149038149039149040149041149042149043149044149045149046149047149048149049149050149051149052149053149054149055149056149057149058149059149060149061149062149063149064149065149066149067149068149069149070149071149072149073149074149075149076149077149078149079149080149081149082149083149084149085149086149087149088149089149090149091149092149093149094149095149096149097149098149099149100149101149102149103149104149105149106149107149108149109149110149111149112149113149114149115149116149117149118149119149120149121149122149123149124149125149126149127149128149129149130149131149132149133149134149135149136149137149138149139149140149141149142149143149144149145149146149147149148149149149150149151149152149153149154149155149156149157149158149159149160149161149162149163149164149165149166149167149168149169149170149171149172149173149174149175149176149177149178149179149180149181149182149183149184149185149186149187149188149189149190149191149192149193149194149195149196149197149198149199149200149201149202149203149204149205149206149207149208149209149210149211149212149213149214149215149216149217149218149219149220149221149222149223149224149225149226149227149228149229149230149231149232149233149234149235149236149237149238149239149240149241149242149243149244149245149246149247149248149249149250149251149252149253149254149255149256149257149258149259149260149261149262149263149264149265149266149267149268149269149270149271149272149273149274149275149276149277149278149279149280149281149282149283149284149285149286149287149288149289149290149291149292149293149294149295149296149297149298149299149300149301149302149303149304149305149306149307149308149309149310149311149312149313149314149315149316149317149318149319149320149321149322149323149324149325149326149327149328149329149330149331149332149333149334149335149336149337149338149339149340149341149342149343149344149345149346149347149348149349149350149351149352149353149354149355149356149357149358149359149360149361149362149363149364149365149366149367149368149369149370149371149372149373149374149375149376149377149378149379149380149381149382149383149384149385149386149387149388149389149390149391149392149393149394149395149396149397149398149399149400149401149402149403149404149405149406149407149408149409149410149411149412149413149414149415149416149417149418149419149420149421149422149423149424149425149426149427149428149429149430149431149432149433149434149435149436149437149438149439149440149441149442149443149444149445149446149447149448149449149450149451149452149453149454149455149456149457149458149459149460149461149462149463149464149465149466149467149468149469149470149471149472149473149474149475149476149477149478149479149480149481149482149483149484149485149486149487149488149489149490149491149492149493149494149495149496149497149498149499149500149501149502149503149504149505149506149507149508149509149510149511149512149513149514149515149516149517149518149519149520149521149522149523149524149525149526149527149528149529149530149531149532149533149534149535149536149537149538149539149540149541149542149543149544149545149546149547149548149549149550149551149552149553149554149555149556149557149558149559149560149561149562149563149564149565149566149567149568149569149570149571149572149573149574149575149576149577149578149579149580149581149582149583149584149585149586149587149588149589149590149591149592149593149594149595149596149597149598149599149600149601149602149603149604149605149606149607149608149609149610149611149612149613149614149615149616149617149618149619149620149621149622149623149624149625149626149627149628149629149630149631149632149633149634149635149636149637149638149639149640149641149642149643149644149645149646149647149648149649149650149651149652149653149654149655149656149657149658149659149660149661149662149663149664149665149666149667149668149669149670149671149672149673149674149675149676149677149678149679149680149681149682149683149684149685149686149687149688149689149690149691149692149693149694149695149696149697149698149699149700149701149702149703149704149705149706149707149708149709149710149711149712149713149714149715149716149717149718149719149720149721149722149723149724149725149726149727149728149729149730149731149732149733149734149735149736149737149738149739149740149741149742149743149744149745149746149747149748149749149750149751149752149753149754149755149756149757149758149759149760149761149762149763149764149765149766149767149768149769149770149771149772149773149774149775149776149777149778149779149780149781149782149783149784149785149786149787149788149789149790149791149792149793149794149795149796149797149798149799149800149801149802149803149804149805149806149807149808149809149810149811149812149813149814149815149816149817149818149819149820149821149822149823149824149825149826149827149828149829149830149831149832149833149834149835149836149837149838149839149840149841149842149843149844149845149846149847149848149849149850149851149852149853149854149855149856149857149858149859149860149861149862149863149864149865149866149867149868149869149870149871149872149873149874149875149876149877149878149879149880149881149882149883149884149885149886149887149888149889149890149891149892149893149894149895149896149897149898149899149900149901149902149903149904149905149906149907149908149909149910149911149912149913149914149915149916149917149918149919149920149921149922149923149924149925149926149927149928149929149930149931149932149933149934149935149936149937149938149939149940149941149942149943149944149945149946149947149948149949149950149951149952149953149954149955149956149957149958149959149960149961149962149963149964149965149966149967149968149969149970149971149972149973149974149975149976149977149978149979149980149981149982149983149984149985149986149987149988149989149990149991149992149993149994149995149996149997149998149999150000150001150002150003150004150005150006150007150008150009150010150011150012150013150014150015150016150017150018150019150020150021150022150023150024150025150026150027150028150029150030150031150032150033150034150035150036150037150038150039150040150041150042150043150044150045150046150047150048150049150050150051150052150053150054150055150056150057150058150059150060150061150062150063150064150065150066150067150068150069150070150071150072150073150074150075150076150077150078150079150080150081150082150083150084150085150086150087150088150089150090150091150092150093150094150095150096150097150098150099150100150101150102150103150104150105150106150107150108150109150110150111150112150113150114150115150116150117150118150119150120150121150122150123150124150125150126150127150128150129150130150131150132150133150134150135150136150137150138150139150140150141150142150143150144150145150146150147150148150149150150150151150152150153150154150155150156150157150158150159150160150161150162150163150164150165150166150167150168150169150170150171150172150173150174150175150176150177150178150179150180150181150182150183150184150185150186150187150188150189150190150191150192150193150194150195150196150197150198150199150200150201150202150203150204150205150206150207150208150209150210150211150212150213150214150215150216150217150218150219150220150221150222150223150224150225150226150227150228150229150230150231150232150233150234150235150236150237150238150239150240150241150242150243150244150245150246150247150248150249150250150251150252150253150254150255150256150257150258150259150260150261150262150263150264150265150266150267150268150269150270150271150272150273150274150275150276150277150278150279150280150281150282150283150284150285150286150287150288150289150290150291150292150293150294150295150296150297150298150299150300150301150302150303150304150305150306150307150308150309150310150311150312150313150314150315150316150317150318150319150320150321150322150323150324150325150326150327150328150329150330150331150332150333150334150335150336150337150338150339150340150341150342150343150344150345150346150347150348150349150350150351150352150353150354150355150356150357150358150359150360150361150362150363150364150365150366150367150368150369150370150371150372150373150374150375150376150377150378150379150380150381150382150383150384150385150386150387150388150389150390150391150392150393150394150395150396150397150398150399150400150401150402150403150404150405150406150407150408150409150410150411150412150413150414150415150416150417150418150419150420150421150422150423150424150425150426150427150428150429150430150431150432150433150434150435150436150437150438150439150440150441150442150443150444150445150446150447150448150449150450150451150452150453150454150455150456150457150458150459150460150461150462150463150464150465150466150467150468150469150470150471150472150473150474150475150476150477150478150479150480150481150482150483150484150485150486150487150488150489150490150491150492150493150494150495150496150497150498150499150500150501150502150503150504150505150506150507150508150509150510150511150512150513150514150515150516150517150518150519150520150521150522150523150524150525150526150527150528150529150530150531150532150533150534150535150536150537150538150539150540150541150542150543150544150545150546150547150548150549150550150551150552150553150554150555150556150557150558150559150560150561150562150563150564150565150566150567150568150569150570150571150572150573150574150575150576150577150578150579150580150581150582150583150584150585150586150587150588150589150590150591150592150593150594150595150596150597150598150599150600150601150602150603150604150605150606150607150608150609150610150611150612150613150614150615150616150617150618150619150620150621150622150623150624150625150626150627150628150629150630150631150632150633150634150635150636150637150638150639150640150641150642150643150644150645150646150647150648150649150650150651150652150653150654150655150656150657150658150659150660150661150662150663150664150665150666150667150668150669150670150671150672150673150674150675150676150677150678150679150680150681150682150683150684150685150686150687150688150689150690150691150692150693150694150695150696150697150698150699150700150701150702150703150704150705150706150707150708150709150710150711150712150713150714150715150716150717150718150719150720150721150722150723150724150725150726150727150728150729150730150731150732150733150734150735150736150737150738150739150740150741150742150743150744150745150746150747150748150749150750150751150752150753150754150755150756150757150758150759150760150761150762150763150764150765150766150767150768150769150770150771150772150773150774150775150776150777150778150779150780150781150782150783150784150785150786150787150788150789150790150791150792150793150794150795150796150797150798150799150800150801150802150803150804150805150806150807150808150809150810150811150812150813150814150815150816150817150818150819150820150821150822150823150824150825150826150827150828150829150830150831150832150833150834150835150836150837150838150839150840150841150842150843150844150845150846150847150848150849150850150851150852150853150854150855150856150857150858150859150860150861150862150863150864150865150866150867150868150869150870150871150872150873150874150875150876150877150878150879150880150881150882150883150884150885150886150887150888150889150890150891150892150893150894150895150896150897150898150899150900150901150902150903150904150905150906150907150908150909150910150911150912150913150914150915150916150917150918150919150920150921150922150923150924150925150926150927150928150929150930150931150932150933150934150935150936150937150938150939150940150941150942150943150944150945150946150947150948150949150950150951150952150953150954150955150956150957150958150959150960150961150962150963150964150965150966150967150968150969150970150971150972150973150974150975150976150977150978150979150980150981150982150983150984150985150986150987150988150989150990150991150992150993150994150995150996150997150998150999151000151001151002151003151004151005151006151007151008151009151010151011151012151013151014151015151016151017151018151019151020151021151022151023151024151025151026151027151028151029151030151031151032151033151034151035151036151037151038151039151040151041151042151043151044151045151046151047151048151049151050151051151052151053151054151055151056151057151058151059151060151061151062151063151064151065151066151067151068151069151070151071151072151073151074151075151076151077151078151079151080151081151082151083151084151085151086151087151088151089151090151091151092151093151094151095151096151097151098151099151100151101151102151103151104151105151106151107151108151109151110151111151112151113151114151115151116151117151118151119151120151121151122151123151124151125151126151127151128151129151130151131151132151133151134151135151136151137151138151139151140151141151142151143151144151145151146151147151148151149151150151151151152151153151154151155151156151157151158151159151160151161151162151163151164151165151166151167151168151169151170151171151172151173151174151175151176151177151178151179151180151181151182151183151184151185151186151187151188151189151190151191151192151193151194151195151196151197151198151199151200151201151202151203151204151205151206151207151208151209151210151211151212151213151214151215151216151217151218151219151220151221151222151223151224151225151226151227151228151229151230151231151232151233151234151235151236151237151238151239151240151241151242151243151244151245151246151247151248151249151250151251151252151253151254151255151256151257151258151259151260151261151262151263151264151265151266151267151268151269151270151271151272151273151274151275151276151277151278151279151280151281151282151283151284151285151286151287151288151289151290151291151292151293151294151295151296151297151298151299151300151301151302151303151304151305151306151307151308151309151310151311151312151313151314151315151316151317151318151319151320151321151322151323151324151325151326151327151328151329151330151331151332151333151334151335151336151337151338151339151340151341151342151343151344151345151346151347151348151349151350151351151352151353151354151355151356151357151358151359151360151361151362151363151364151365151366151367151368151369151370151371151372151373151374151375151376151377151378151379151380151381151382151383151384151385151386151387151388151389151390151391151392151393151394151395151396151397151398151399151400151401151402151403151404151405151406151407151408151409151410151411151412151413151414151415151416151417151418151419151420151421151422151423151424151425151426151427151428151429151430151431151432151433151434151435151436151437151438151439151440151441151442151443151444151445151446151447151448151449151450151451151452151453151454151455151456151457151458151459151460151461151462151463151464151465151466151467151468151469151470151471151472151473151474151475151476151477151478151479151480151481151482151483151484151485151486151487151488151489151490151491151492151493151494151495151496151497151498151499151500151501151502151503151504151505151506151507151508151509151510151511151512151513151514151515151516151517151518151519151520151521151522151523151524151525151526151527151528151529151530151531151532151533151534151535151536151537151538151539151540151541151542151543151544151545151546151547151548151549151550151551151552151553151554151555151556151557151558151559151560151561151562151563151564151565151566151567151568151569151570151571151572151573151574151575151576151577151578151579151580151581151582151583151584151585151586151587151588151589151590151591151592151593151594151595151596151597151598151599151600151601151602151603151604151605151606151607151608151609151610151611151612151613151614151615151616151617151618151619151620151621151622151623151624151625151626151627151628151629151630151631151632151633151634151635151636151637151638151639151640151641151642151643151644151645151646151647151648151649151650151651151652151653151654151655151656151657151658151659151660151661151662151663151664151665151666151667151668151669151670151671151672151673151674151675151676151677151678151679151680151681151682151683151684151685151686151687151688151689151690151691151692151693151694151695151696151697151698151699151700151701151702151703151704151705151706151707151708151709151710151711151712151713151714151715151716151717151718151719151720151721151722151723151724151725151726151727151728151729151730151731151732151733151734151735151736151737151738151739151740151741151742151743151744151745151746151747151748151749151750151751151752151753151754151755151756151757151758151759151760151761151762151763151764151765151766151767151768151769151770151771151772151773151774151775151776151777151778151779151780151781151782151783151784151785151786151787151788151789151790151791151792151793151794151795151796151797151798151799151800151801151802151803151804151805151806151807151808151809151810151811151812151813151814151815151816151817151818151819151820151821151822151823151824151825151826151827151828151829151830151831151832151833151834151835151836151837151838151839151840151841151842151843151844151845151846151847151848151849151850151851151852151853151854151855151856151857151858151859151860151861151862151863151864151865151866151867151868151869151870151871151872151873151874151875151876151877151878151879151880151881151882151883151884151885151886151887151888151889151890151891151892151893151894151895151896151897151898151899151900151901151902151903151904151905151906151907151908151909151910151911151912151913151914151915151916151917151918151919151920151921151922151923151924151925151926151927151928151929151930151931151932151933151934151935151936151937151938151939151940151941151942151943151944151945151946151947151948151949151950151951151952151953151954151955151956151957151958151959151960151961151962151963151964151965151966151967151968151969151970151971151972151973151974151975151976151977151978151979151980151981151982151983151984151985151986151987151988151989151990151991151992151993151994151995151996151997151998151999152000152001152002152003152004152005152006152007152008152009152010152011152012152013152014152015152016152017152018152019152020152021152022152023152024152025152026152027152028152029152030152031152032152033152034152035152036152037152038152039152040152041152042152043152044152045152046152047152048152049152050152051152052152053152054152055152056152057152058152059152060152061152062152063152064152065152066152067152068152069152070152071152072152073152074152075152076152077152078152079152080152081152082152083152084152085152086152087152088152089152090152091152092152093152094152095152096152097152098152099152100152101152102152103152104152105152106152107152108152109152110152111152112152113152114152115152116152117152118152119152120152121152122152123152124152125152126152127152128152129152130152131152132152133152134152135152136152137152138152139152140152141152142152143152144152145152146152147152148152149152150152151152152152153152154152155152156152157152158152159152160152161152162152163152164152165152166152167152168152169152170152171152172152173152174152175152176152177152178152179152180152181152182152183152184152185152186152187152188152189152190152191152192152193152194152195152196152197152198152199152200152201152202152203152204152205152206152207152208152209152210152211152212152213152214152215152216152217152218152219152220152221152222152223152224152225152226152227152228152229152230152231152232152233152234152235152236152237152238152239152240152241152242152243152244152245152246152247152248152249152250152251152252152253152254152255152256152257152258152259152260152261152262152263152264152265152266152267152268152269152270152271152272152273152274152275152276152277152278152279152280152281152282152283152284152285152286152287152288152289152290152291152292152293152294152295152296152297152298152299152300152301152302152303152304152305152306152307152308152309152310152311152312152313152314152315152316152317152318152319152320152321152322152323152324152325152326152327152328152329152330152331152332152333152334152335152336152337152338152339152340152341152342152343152344152345152346152347152348152349152350152351152352152353152354152355152356152357152358152359152360152361152362152363152364152365152366152367152368152369152370152371152372152373152374152375152376152377152378152379152380152381152382152383152384152385152386152387152388152389152390152391152392152393152394152395152396152397152398152399152400152401152402152403152404152405152406152407152408152409152410152411152412152413152414152415152416152417152418152419152420152421152422152423152424152425152426152427152428152429152430152431152432152433152434152435152436152437152438152439152440152441152442152443152444152445152446152447152448152449152450152451152452152453152454152455152456152457152458152459152460152461152462152463152464152465152466152467152468152469152470152471152472152473152474152475152476152477152478152479152480152481152482152483152484152485152486152487152488152489152490152491152492152493152494152495152496152497152498152499152500152501152502152503152504152505152506152507152508152509152510152511152512152513152514152515152516152517152518152519152520152521152522152523152524152525152526152527152528152529152530152531152532152533152534152535152536152537152538152539152540152541152542152543152544152545152546152547152548152549152550152551152552152553152554152555152556152557152558152559152560152561152562152563152564152565152566152567152568152569152570152571152572152573152574152575152576152577152578152579152580152581152582152583152584152585152586152587152588152589152590152591152592152593152594152595152596152597152598152599152600152601152602152603152604152605152606152607152608152609152610152611152612152613152614152615152616152617152618152619152620152621152622152623152624152625152626152627152628152629152630152631152632152633152634152635152636152637152638152639152640152641152642152643152644152645152646152647152648152649152650152651152652152653152654152655152656152657152658152659152660152661152662152663152664152665152666152667152668152669152670152671152672152673152674152675152676152677152678152679152680152681152682152683152684152685152686152687152688152689152690152691152692152693152694152695152696152697152698152699152700152701152702152703152704152705152706152707152708152709152710152711152712152713152714152715152716152717152718152719152720152721152722152723152724152725152726152727152728152729152730152731152732152733152734152735152736152737152738152739152740152741152742152743152744152745152746152747152748152749152750152751152752152753152754152755152756152757152758152759152760152761152762152763152764152765152766152767152768152769152770152771152772152773152774152775152776152777152778152779152780152781152782152783152784152785152786152787152788152789152790152791152792152793152794152795152796152797152798152799152800152801152802152803152804152805152806152807152808152809152810152811152812152813152814152815152816152817152818152819152820152821152822152823152824152825152826152827152828152829152830152831152832152833152834152835152836152837152838152839152840152841152842152843152844152845152846152847152848152849152850152851152852152853152854152855152856152857152858152859152860152861152862152863152864152865152866152867152868152869152870152871152872152873152874152875152876152877152878152879152880152881152882152883152884152885152886152887152888152889152890152891152892152893152894152895152896152897152898152899152900152901152902152903152904152905152906152907152908152909152910152911152912152913152914152915152916152917152918152919152920152921152922152923152924152925152926152927152928152929152930152931152932152933152934152935152936152937152938152939152940152941152942152943152944152945152946152947152948152949152950152951152952152953152954152955152956152957152958152959152960152961152962152963152964152965152966152967152968152969152970152971152972152973152974152975152976152977152978152979152980152981152982152983152984152985152986152987152988152989152990152991152992152993152994152995152996152997152998152999153000153001153002153003153004153005153006153007153008153009153010153011153012153013153014153015153016153017153018153019153020153021153022153023153024153025153026153027153028153029153030153031153032153033153034153035153036153037153038153039153040153041153042153043153044153045153046153047153048153049153050153051153052153053153054153055153056153057153058153059153060153061153062153063153064153065153066153067153068153069153070153071153072153073153074153075153076153077153078153079153080153081153082153083153084153085153086153087153088153089153090153091153092153093153094153095153096153097153098153099153100153101153102153103153104153105153106153107153108153109153110153111153112153113153114153115153116153117153118153119153120153121153122153123153124153125153126153127153128153129153130153131153132153133153134153135153136153137153138153139153140153141153142153143153144153145153146153147153148153149153150153151153152153153153154153155153156153157153158153159153160153161153162153163153164153165153166153167153168153169153170153171153172153173153174153175153176153177153178153179153180153181153182153183153184153185153186153187153188153189153190153191153192153193153194153195153196153197153198153199153200153201153202153203153204153205153206153207153208153209153210153211153212153213153214153215153216153217153218153219153220153221153222153223153224153225153226153227153228153229153230153231153232153233153234153235153236153237153238153239153240153241153242153243153244153245153246153247153248153249153250153251153252153253153254153255153256153257153258153259153260153261153262153263153264153265153266153267153268153269153270153271153272153273153274153275153276153277153278153279153280153281153282153283153284153285153286153287153288153289153290153291153292153293153294153295153296153297153298153299153300153301153302153303153304153305153306153307153308153309153310153311153312153313153314153315153316153317153318153319153320153321153322153323153324153325153326153327153328153329153330153331153332153333153334153335153336153337153338153339153340153341153342153343153344153345153346153347153348153349153350153351153352153353153354153355153356153357153358153359153360153361153362153363153364153365153366153367153368153369153370153371153372153373153374153375153376153377153378153379153380153381153382153383153384153385153386153387153388153389153390153391153392153393153394153395153396153397153398153399153400153401153402153403153404153405153406153407153408153409153410153411153412153413153414153415153416153417153418153419153420153421153422153423153424153425153426153427153428153429153430153431153432153433153434153435153436153437153438153439153440153441153442153443153444153445153446153447153448153449153450153451153452153453153454153455153456153457153458153459153460153461153462153463153464153465153466153467153468153469153470153471153472153473153474153475153476153477153478153479153480153481153482153483153484153485153486153487153488153489153490153491153492153493153494153495153496153497153498153499153500153501153502153503153504153505153506153507153508153509153510153511153512153513153514153515153516153517153518153519153520153521153522153523153524153525153526153527153528153529153530153531153532153533153534153535153536153537153538153539153540153541153542153543153544153545153546153547153548153549153550153551153552153553153554153555153556153557153558153559153560153561153562153563153564153565153566153567153568153569153570153571153572153573153574153575153576153577153578153579153580153581153582153583153584153585153586153587153588153589153590153591153592153593153594153595153596153597153598153599153600153601153602153603153604153605153606153607153608153609153610153611153612153613153614153615153616153617153618153619153620153621153622153623153624153625153626153627153628153629153630153631153632153633153634153635153636153637153638153639153640153641153642153643153644153645153646153647153648153649153650153651153652153653153654153655153656153657153658153659153660153661153662153663153664153665153666153667153668153669153670153671153672153673153674153675153676153677153678153679153680153681153682153683153684153685153686153687153688153689153690153691153692153693153694153695153696153697153698153699153700153701153702153703153704153705153706153707153708153709153710153711153712153713153714153715153716153717153718153719153720153721153722153723153724153725153726153727153728153729153730153731153732153733153734153735153736153737153738153739153740153741153742153743153744153745153746153747153748153749153750153751153752153753153754153755153756153757153758153759153760153761153762153763153764153765153766153767153768153769153770153771153772153773153774153775153776153777153778153779153780153781153782153783153784153785153786153787153788153789153790153791153792153793153794153795153796153797153798153799153800153801153802153803153804153805153806153807153808153809153810153811153812153813153814153815153816153817153818153819153820153821153822153823153824153825153826153827153828153829153830153831153832153833153834153835153836153837153838153839153840153841153842153843153844153845153846153847153848153849153850153851153852153853153854153855153856153857153858153859153860153861153862153863153864153865153866153867153868153869153870153871153872153873153874153875153876153877153878153879153880153881153882153883153884153885153886153887153888153889153890153891153892153893153894153895153896153897153898153899153900153901153902153903153904153905153906153907153908153909153910153911153912153913153914153915153916153917153918153919153920153921153922153923153924153925153926153927153928153929153930153931153932153933153934153935153936153937153938153939153940153941153942153943153944153945153946153947153948153949153950153951153952153953153954153955153956153957153958153959153960153961153962153963153964153965153966153967153968153969153970153971153972153973153974153975153976153977153978153979153980153981153982153983153984153985153986153987153988153989153990153991153992153993153994153995153996153997153998153999154000154001154002154003154004154005154006154007154008154009154010154011154012154013154014154015154016154017154018154019154020154021154022154023154024154025154026154027154028154029154030154031154032154033154034154035154036154037154038154039154040154041154042154043154044154045154046154047154048154049154050154051154052154053154054154055154056154057154058154059154060154061154062154063154064154065154066154067154068154069154070154071154072154073154074154075154076154077154078154079154080154081154082154083154084154085154086154087154088154089154090154091154092154093154094154095154096154097154098154099154100154101154102154103154104154105154106154107154108154109154110154111154112154113154114154115154116154117154118154119154120154121154122154123154124154125154126154127154128154129154130154131154132154133154134154135154136154137154138154139154140154141154142154143154144154145154146154147154148154149154150154151154152154153154154154155154156154157154158154159154160154161154162154163154164154165154166154167154168154169154170154171154172154173154174154175154176154177154178154179154180154181154182154183154184154185154186154187154188154189154190154191154192154193154194154195154196154197154198154199154200154201154202154203154204154205154206154207154208154209154210154211154212154213154214154215154216154217154218154219154220154221154222154223154224154225154226154227154228154229154230154231154232154233154234154235154236154237154238154239154240154241154242154243154244154245154246154247154248154249154250154251154252154253154254154255154256154257154258154259154260154261154262154263154264154265154266154267154268154269154270154271154272154273154274154275154276154277154278154279154280154281154282154283154284154285154286154287154288154289154290154291154292154293154294154295154296154297154298154299154300154301154302154303154304154305154306154307154308154309154310154311154312154313154314154315154316154317154318154319154320154321154322154323154324154325154326154327154328154329154330154331154332154333154334154335154336154337154338154339154340154341154342154343154344154345154346154347154348154349154350154351154352154353154354154355154356154357154358154359154360154361154362154363154364154365154366154367154368154369154370154371154372154373154374154375154376154377154378154379154380154381154382154383154384154385154386154387154388154389154390154391154392154393154394154395154396154397154398154399154400154401154402154403154404154405154406154407154408154409154410154411154412154413154414154415154416154417154418154419154420154421154422154423154424154425154426154427154428154429154430154431154432154433154434154435154436154437154438154439154440154441154442154443154444154445154446154447154448154449154450154451154452154453154454154455154456154457154458154459154460154461154462154463154464154465154466154467154468154469154470154471154472154473154474154475154476154477154478154479154480154481154482154483154484154485154486154487154488154489154490154491154492154493154494154495154496154497154498154499154500154501154502154503154504154505154506154507154508154509154510154511154512154513154514154515154516154517154518154519154520154521154522154523154524154525154526154527154528154529154530154531154532154533154534154535154536154537154538154539154540154541154542154543154544154545154546154547154548154549154550154551154552154553154554154555154556154557154558154559154560154561154562154563154564154565154566154567154568154569154570154571154572154573154574154575154576154577154578154579154580154581154582154583154584154585154586154587154588154589154590154591154592154593154594154595154596154597154598154599154600154601154602154603154604154605154606154607154608154609154610154611154612154613154614154615154616154617154618154619154620154621154622154623154624154625154626154627154628154629154630154631154632154633154634154635154636154637154638154639154640154641154642154643154644154645154646154647154648154649154650154651154652154653154654154655154656154657154658154659154660154661154662154663154664154665154666154667154668154669154670154671154672154673154674154675154676154677154678154679154680154681154682154683154684154685154686154687154688154689154690154691154692154693154694154695154696154697154698154699154700154701154702154703154704154705154706154707154708154709154710154711154712154713154714154715154716154717154718154719154720154721154722154723154724154725154726154727154728154729154730154731154732154733154734154735154736154737154738154739154740154741154742154743154744154745154746154747154748154749154750154751154752154753154754154755154756154757154758154759154760154761154762154763154764154765154766154767154768154769154770154771154772154773154774154775154776154777154778154779154780154781154782154783154784154785154786154787154788154789154790154791154792154793154794154795154796154797154798154799154800154801154802154803154804154805154806154807154808154809154810154811154812154813154814154815154816154817154818154819154820154821154822154823154824154825154826154827154828154829154830154831154832154833154834154835154836154837154838154839154840154841154842154843154844154845154846154847154848154849154850154851154852154853154854154855154856154857154858154859154860154861154862154863154864154865154866154867154868154869154870154871154872154873154874154875154876154877154878154879154880154881154882154883154884154885154886154887154888154889154890154891154892154893154894154895154896154897154898154899154900154901154902154903154904154905154906154907154908154909154910154911154912154913154914154915154916154917154918154919154920154921154922154923154924154925154926154927154928154929154930154931154932154933154934154935154936154937154938154939154940154941154942154943154944154945154946154947154948154949154950154951154952154953154954154955154956154957154958154959154960154961154962154963154964154965154966154967154968154969154970154971154972154973154974154975154976154977154978154979154980154981154982154983154984154985154986154987154988154989154990154991154992154993154994154995154996154997154998154999155000155001155002155003155004155005155006155007155008155009155010155011155012155013155014155015155016155017155018155019155020155021155022155023155024155025155026155027155028155029155030155031155032155033155034155035155036155037155038155039155040155041155042155043155044155045155046155047155048155049155050155051155052155053155054155055155056155057155058155059155060155061155062155063155064155065155066155067155068155069155070155071155072155073155074155075155076155077155078155079155080155081155082155083155084155085155086155087155088155089155090155091155092155093155094155095155096155097155098155099155100155101155102155103155104155105155106155107155108155109155110155111155112155113155114155115155116155117155118155119155120155121155122155123155124155125155126155127155128155129155130155131155132155133155134155135155136155137155138155139155140155141155142155143155144155145155146155147155148155149155150155151155152155153155154155155155156155157155158155159155160155161155162155163155164155165155166155167155168155169155170155171155172155173155174155175155176155177155178155179155180155181155182155183155184155185155186155187155188155189155190155191155192155193155194155195155196155197155198155199155200155201155202155203155204155205155206155207155208155209155210155211155212155213155214155215155216155217155218155219155220155221155222155223155224155225155226155227155228155229155230155231155232155233155234155235155236155237155238155239155240155241155242155243155244155245155246155247155248155249155250155251155252155253155254155255155256155257155258155259155260155261155262155263155264155265155266155267155268155269155270155271155272155273155274155275155276155277155278155279155280155281155282155283155284155285155286155287155288155289155290155291155292155293155294155295155296155297155298155299155300155301155302155303155304155305155306155307155308155309155310155311155312155313155314155315155316155317155318155319155320155321155322155323155324155325155326155327155328155329155330155331155332155333155334155335155336155337155338155339155340155341155342155343155344155345155346155347155348155349155350155351155352155353155354155355155356155357155358155359155360155361155362155363155364155365155366155367155368155369155370155371155372155373155374155375155376155377155378155379155380155381155382155383155384155385155386155387155388155389155390155391155392155393155394155395155396155397155398155399155400155401155402155403155404155405155406155407155408155409155410155411155412155413155414155415155416155417155418155419155420155421155422155423155424155425155426155427155428155429155430155431155432155433155434155435155436155437155438155439155440155441155442155443155444155445155446155447155448155449155450155451155452155453155454155455155456155457155458155459155460155461155462155463155464155465155466155467155468155469155470155471155472155473155474155475155476155477155478155479155480155481155482155483155484155485155486155487155488155489155490155491155492155493155494155495155496155497155498155499155500155501155502155503155504155505155506155507155508155509155510155511155512155513155514155515155516155517155518155519155520155521155522155523155524155525155526155527155528155529155530155531155532155533155534155535155536155537155538155539155540155541155542155543155544155545155546155547155548155549155550155551155552155553155554155555155556155557155558155559155560155561155562155563155564155565155566155567155568155569155570155571155572155573155574155575155576155577155578155579155580155581155582155583155584155585155586155587155588155589155590155591155592155593155594155595155596155597155598155599155600155601155602155603155604155605155606155607155608155609155610155611155612155613155614155615155616155617155618155619155620155621155622155623155624155625155626155627155628155629155630155631155632155633155634155635155636155637155638155639155640155641155642155643155644155645155646155647155648155649155650155651155652155653155654155655155656155657155658155659155660155661155662155663155664155665155666155667155668155669155670155671155672155673155674155675155676155677155678155679155680155681155682155683155684155685155686155687155688155689155690155691155692155693155694155695155696155697155698155699155700155701155702155703155704155705155706155707155708155709155710155711155712155713155714155715155716155717155718155719155720155721155722155723155724155725155726155727155728155729155730155731155732155733155734155735155736155737155738155739155740155741155742155743155744155745155746155747155748155749155750155751155752155753155754155755155756155757155758155759155760155761155762155763155764155765155766155767155768155769155770155771155772155773155774155775155776155777155778155779155780155781155782155783155784155785155786155787155788155789155790155791155792155793155794155795155796155797155798155799155800155801155802155803155804155805155806155807155808155809155810155811155812155813155814155815155816155817155818155819155820155821155822155823155824155825155826155827155828155829155830155831155832155833155834155835155836155837155838155839155840155841155842155843155844155845155846155847155848155849155850155851155852155853155854155855155856155857155858155859155860155861155862155863155864155865155866155867155868155869155870155871155872155873155874155875155876155877155878155879155880155881155882155883155884155885155886155887155888155889155890155891155892155893155894155895155896155897155898155899155900155901155902155903155904155905155906155907155908155909155910155911155912155913155914155915155916155917155918155919155920155921155922155923155924155925155926155927155928155929155930155931155932155933155934155935155936155937155938155939155940155941155942155943155944155945155946155947155948155949155950155951155952155953155954155955155956155957155958155959155960155961155962155963155964155965155966155967155968155969155970155971155972155973155974155975155976155977155978155979155980155981155982155983155984155985155986155987155988155989155990155991155992155993155994155995155996155997155998155999156000156001156002156003156004156005156006156007156008156009156010156011156012156013156014156015156016156017156018156019156020156021156022156023156024156025156026156027156028156029156030156031156032156033156034156035156036156037156038156039156040156041156042156043156044156045156046156047156048156049156050156051156052156053156054156055156056156057156058156059156060156061156062156063156064156065156066156067156068156069156070156071156072156073156074156075156076156077156078156079156080156081156082156083156084156085156086156087156088156089156090156091156092156093156094156095156096156097156098156099156100156101156102156103156104156105156106156107156108156109156110156111156112156113156114156115156116156117156118156119156120156121156122156123156124156125156126156127156128156129156130156131156132156133156134156135156136156137156138156139156140156141156142156143156144156145156146156147156148156149156150156151156152156153156154156155156156156157156158156159156160156161156162156163156164156165156166156167156168156169156170156171156172156173156174156175156176156177156178156179156180156181156182156183156184156185156186156187156188156189156190156191156192156193156194156195156196156197156198156199156200156201156202156203156204156205156206156207156208156209156210156211156212156213156214156215156216156217156218156219156220156221156222156223156224156225156226156227156228156229156230156231156232156233156234156235156236156237156238156239156240156241156242156243156244156245156246156247156248156249156250156251156252156253156254156255156256156257156258156259156260156261156262156263156264156265156266156267156268156269156270156271156272156273156274156275156276156277156278156279156280156281156282156283156284156285156286156287156288156289156290156291156292156293156294156295156296156297156298156299156300156301156302156303156304156305156306156307156308156309156310156311156312156313156314156315156316156317156318156319156320156321156322156323156324156325156326156327156328156329156330156331156332156333156334156335156336156337156338156339156340156341156342156343156344156345156346156347156348156349156350156351156352156353156354156355156356156357156358156359156360156361156362156363156364156365156366156367156368156369156370156371156372156373156374156375156376156377156378156379156380156381156382156383156384156385156386156387156388156389156390156391156392156393156394156395156396156397156398156399156400156401156402156403156404156405156406156407156408156409156410156411156412156413156414156415156416156417156418156419156420156421156422156423156424156425156426156427156428156429156430156431156432156433156434156435156436156437156438156439156440156441156442156443156444156445156446156447156448156449156450156451156452156453156454156455156456156457156458156459156460156461156462156463156464156465156466156467156468156469156470156471156472156473156474156475156476156477156478156479156480156481156482156483156484156485156486156487156488156489156490156491156492156493156494156495156496156497156498156499156500156501156502156503156504156505156506156507156508156509156510156511156512156513156514156515156516156517156518156519156520156521156522156523156524156525156526156527156528156529156530156531156532156533156534156535156536156537156538156539156540156541156542156543156544156545156546156547156548156549156550156551156552156553156554156555156556156557156558156559156560156561156562156563156564156565156566156567156568156569156570156571156572156573156574156575156576156577156578156579156580156581156582156583156584156585156586156587156588156589156590156591156592156593156594156595156596156597156598156599156600156601156602156603156604156605156606156607156608156609156610156611156612156613156614156615156616156617156618156619156620156621156622156623156624156625156626156627156628156629156630156631156632156633156634156635156636156637156638156639156640156641156642156643156644156645156646156647156648156649156650156651156652156653156654156655156656156657156658156659156660156661156662156663156664156665156666156667156668156669156670156671156672156673156674156675156676156677156678156679156680156681156682156683156684156685156686156687156688156689156690156691156692156693156694156695156696156697156698156699156700156701156702156703156704156705156706156707156708156709156710156711156712156713156714156715156716156717156718156719156720156721156722156723156724156725156726156727156728156729156730156731156732156733156734156735156736156737156738156739156740156741156742156743156744156745156746156747156748156749156750156751156752156753156754156755156756156757156758156759156760156761156762156763156764156765156766156767156768156769156770156771156772156773156774156775156776156777156778156779156780156781156782156783156784156785156786156787156788156789156790156791156792156793156794156795156796156797156798156799156800156801156802156803156804156805156806156807156808156809156810156811156812156813156814156815156816156817156818156819156820156821156822156823156824156825156826156827156828156829156830156831156832156833156834156835156836156837156838156839156840156841156842156843156844156845156846156847156848156849156850156851156852156853156854156855156856156857156858156859156860156861156862156863156864156865156866156867156868156869156870156871156872156873156874156875156876156877156878156879156880156881156882156883156884156885156886156887156888156889156890156891156892156893156894156895156896156897156898156899156900156901156902156903156904156905156906156907156908156909156910156911156912156913156914156915156916156917156918156919156920156921156922156923156924156925156926156927156928156929156930156931156932156933156934156935156936156937156938156939156940156941156942156943156944156945156946156947156948156949156950156951156952156953156954156955156956156957156958156959156960156961156962156963156964156965156966156967156968156969156970156971156972156973156974156975156976156977156978156979156980156981156982156983156984156985156986156987156988156989156990156991156992156993156994156995156996156997156998156999157000157001157002157003157004157005157006157007157008157009157010157011157012157013157014157015157016157017157018157019157020157021157022157023157024157025157026157027157028157029157030157031157032157033157034157035157036157037157038157039157040157041157042157043157044157045157046157047157048157049157050157051157052157053157054157055157056157057157058157059157060157061157062157063157064157065157066157067157068157069157070157071157072157073157074157075157076157077157078157079157080157081157082157083157084157085157086157087157088157089157090157091157092157093157094157095157096157097157098157099157100157101157102157103157104157105157106157107157108157109157110157111157112157113157114157115157116157117157118157119157120157121157122157123157124157125157126157127157128157129157130157131157132157133157134157135157136157137157138157139157140157141157142157143157144157145157146157147157148157149157150157151157152157153157154157155157156157157157158157159157160157161157162157163157164157165157166157167157168157169157170157171157172157173157174157175157176157177157178157179157180157181157182157183157184157185157186157187157188157189157190157191157192157193157194157195157196157197157198157199157200157201157202157203157204157205157206157207157208157209157210157211157212157213157214157215157216157217157218157219157220157221157222157223157224157225157226157227157228157229157230157231157232157233157234157235157236157237157238157239157240157241157242157243157244157245157246157247157248157249157250157251157252157253157254157255157256157257157258157259157260157261157262157263157264157265157266157267157268157269157270157271157272157273157274157275157276157277157278157279157280157281157282157283157284157285157286157287157288157289157290157291157292157293157294157295157296157297157298157299157300157301157302157303157304157305157306157307157308157309157310157311157312157313157314157315157316157317157318157319157320157321157322157323157324157325157326157327157328157329157330157331157332157333157334157335157336157337157338157339157340157341157342157343157344157345157346157347157348157349157350157351157352157353157354157355157356157357157358157359157360157361157362157363157364157365157366157367157368157369157370157371157372157373157374157375157376157377157378157379157380157381157382157383157384157385157386157387157388157389157390157391157392157393157394157395157396157397157398157399157400157401157402157403157404157405157406157407157408157409157410157411157412157413157414157415157416157417157418157419157420157421157422157423157424157425157426157427157428157429157430157431157432157433157434157435157436157437157438157439157440157441157442157443157444157445157446157447157448157449157450157451157452157453157454157455157456157457157458157459157460157461157462157463157464157465157466157467157468157469157470157471157472157473157474157475157476157477157478157479157480157481157482157483157484157485157486157487157488157489157490157491157492157493157494157495157496157497157498157499157500157501157502157503157504157505157506157507157508157509157510157511157512157513157514157515157516157517157518157519157520157521157522157523157524157525157526157527157528157529157530157531157532157533157534157535157536157537157538157539157540157541157542157543157544157545157546157547157548157549157550157551157552157553157554157555157556157557157558157559157560157561157562157563157564157565157566157567157568157569157570157571157572157573157574157575157576157577157578157579157580157581157582157583157584157585157586157587157588157589157590157591157592157593157594157595157596157597157598157599157600157601157602157603157604157605157606157607157608157609157610157611157612157613157614157615157616157617157618157619157620157621157622157623157624157625157626157627157628157629157630157631157632157633157634157635157636157637157638157639157640157641157642157643157644157645157646157647157648157649157650157651157652157653157654157655157656157657157658157659157660157661157662157663157664157665157666157667157668157669157670157671157672157673157674157675157676157677157678157679157680157681157682157683157684157685157686157687157688157689157690157691157692157693157694157695157696157697157698157699157700157701157702157703157704157705157706157707157708157709157710157711157712157713157714157715157716157717157718157719157720157721157722157723157724157725157726157727157728157729157730157731157732157733157734157735157736157737157738157739157740157741157742157743157744157745157746157747157748157749157750157751157752157753157754157755157756157757157758157759157760157761157762157763157764157765157766157767157768157769157770157771157772157773157774157775157776157777157778157779157780157781157782157783157784157785157786157787157788157789157790157791157792157793157794157795157796157797157798157799157800157801157802157803157804157805157806157807157808157809157810157811157812157813157814157815157816157817157818157819157820157821157822157823157824157825157826157827157828157829157830157831157832157833157834157835157836157837157838157839157840157841157842157843157844157845157846157847157848157849157850157851157852157853157854157855157856157857157858157859157860157861157862157863157864157865157866157867157868157869157870157871157872157873157874157875157876157877157878157879157880157881157882157883157884157885157886157887157888157889157890157891157892157893157894157895157896157897157898157899157900157901157902157903157904157905157906157907157908157909157910157911157912157913157914157915157916157917157918157919157920157921157922157923157924157925157926157927157928157929157930157931157932157933157934157935157936157937157938157939157940157941157942157943157944157945157946157947157948157949157950157951157952157953157954157955157956
  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. * User defined information that will be sent to observers
  96. */
  97. userInfo?: any;
  98. }
  99. /**
  100. * Represent an Observer registered to a given Observable object.
  101. */
  102. export class Observer<T> {
  103. /**
  104. * Defines the callback to call when the observer is notified
  105. */
  106. callback: (eventData: T, eventState: EventState) => void;
  107. /**
  108. * Defines the mask of the observer (used to filter notifications)
  109. */
  110. mask: number;
  111. /**
  112. * Defines the current scope used to restore the JS context
  113. */
  114. scope: any;
  115. /** @hidden */
  116. _willBeUnregistered: boolean;
  117. /**
  118. * Gets or sets a property defining that the observer as to be unregistered after the next notification
  119. */
  120. unregisterOnNextCall: boolean;
  121. /**
  122. * Creates a new observer
  123. * @param callback defines the callback to call when the observer is notified
  124. * @param mask defines the mask of the observer (used to filter notifications)
  125. * @param scope defines the current scope used to restore the JS context
  126. */
  127. constructor(
  128. /**
  129. * Defines the callback to call when the observer is notified
  130. */
  131. callback: (eventData: T, eventState: EventState) => void,
  132. /**
  133. * Defines the mask of the observer (used to filter notifications)
  134. */
  135. mask: number,
  136. /**
  137. * Defines the current scope used to restore the JS context
  138. */
  139. scope?: any);
  140. }
  141. /**
  142. * Represent a list of observers registered to multiple Observables object.
  143. */
  144. export class MultiObserver<T> {
  145. private _observers;
  146. private _observables;
  147. /**
  148. * Release associated resources
  149. */
  150. dispose(): void;
  151. /**
  152. * Raise a callback when one of the observable will notify
  153. * @param observables defines a list of observables to watch
  154. * @param callback defines the callback to call on notification
  155. * @param mask defines the mask used to filter notifications
  156. * @param scope defines the current scope used to restore the JS context
  157. * @returns the new MultiObserver
  158. */
  159. static Watch<T>(observables: Observable<T>[], callback: (eventData: T, eventState: EventState) => void, mask?: number, scope?: any): MultiObserver<T>;
  160. }
  161. /**
  162. * The Observable class is a simple implementation of the Observable pattern.
  163. *
  164. * 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.
  165. * This enable a more fine grained execution without having to rely on multiple different Observable objects.
  166. * 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).
  167. * 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.
  168. */
  169. export class Observable<T> {
  170. private _observers;
  171. private _eventState;
  172. private _onObserverAdded;
  173. /**
  174. * Gets the list of observers
  175. */
  176. get observers(): Array<Observer<T>>;
  177. /**
  178. * Creates a new observable
  179. * @param onObserverAdded defines a callback to call when a new observer is added
  180. */
  181. constructor(onObserverAdded?: (observer: Observer<T>) => void);
  182. /**
  183. * Create a new Observer with the specified callback
  184. * @param callback the callback that will be executed for that Observer
  185. * @param mask the mask used to filter observers
  186. * @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.
  187. * @param scope optional scope for the callback to be called from
  188. * @param unregisterOnFirstCall defines if the observer as to be unregistered after the next notification
  189. * @returns the new observer created for the callback
  190. */
  191. add(callback: (eventData: T, eventState: EventState) => void, mask?: number, insertFirst?: boolean, scope?: any, unregisterOnFirstCall?: boolean): Nullable<Observer<T>>;
  192. /**
  193. * Create a new Observer with the specified callback and unregisters after the next notification
  194. * @param callback the callback that will be executed for that Observer
  195. * @returns the new observer created for the callback
  196. */
  197. addOnce(callback: (eventData: T, eventState: EventState) => void): Nullable<Observer<T>>;
  198. /**
  199. * Remove an Observer from the Observable object
  200. * @param observer the instance of the Observer to remove
  201. * @returns false if it doesn't belong to this Observable
  202. */
  203. remove(observer: Nullable<Observer<T>>): boolean;
  204. /**
  205. * Remove a callback from the Observable object
  206. * @param callback the callback to remove
  207. * @param scope optional scope. If used only the callbacks with this scope will be removed
  208. * @returns false if it doesn't belong to this Observable
  209. */
  210. removeCallback(callback: (eventData: T, eventState: EventState) => void, scope?: any): boolean;
  211. private _deferUnregister;
  212. private _remove;
  213. /**
  214. * Moves the observable to the top of the observer list making it get called first when notified
  215. * @param observer the observer to move
  216. */
  217. makeObserverTopPriority(observer: Observer<T>): void;
  218. /**
  219. * Moves the observable to the bottom of the observer list making it get called last when notified
  220. * @param observer the observer to move
  221. */
  222. makeObserverBottomPriority(observer: Observer<T>): void;
  223. /**
  224. * Notify all Observers by calling their respective callback with the given data
  225. * Will return true if all observers were executed, false if an observer set skipNextObservers to true, then prevent the subsequent ones to execute
  226. * @param eventData defines the data to send to all observers
  227. * @param mask defines the mask of the current notification (observers with incompatible mask (ie mask & observer.mask === 0) will not be notified)
  228. * @param target defines the original target of the state
  229. * @param currentTarget defines the current target of the state
  230. * @param userInfo defines any user info to send to observers
  231. * @returns false if the complete observer chain was not processed (because one observer set the skipNextObservers to true)
  232. */
  233. notifyObservers(eventData: T, mask?: number, target?: any, currentTarget?: any, userInfo?: any): boolean;
  234. /**
  235. * Calling this will execute each callback, expecting it to be a promise or return a value.
  236. * If at any point in the chain one function fails, the promise will fail and the execution will not continue.
  237. * This is useful when a chain of events (sometimes async events) is needed to initialize a certain object
  238. * and it is crucial that all callbacks will be executed.
  239. * The order of the callbacks is kept, callbacks are not executed parallel.
  240. *
  241. * @param eventData The data to be sent to each callback
  242. * @param mask is used to filter observers defaults to -1
  243. * @param target defines the callback target (see EventState)
  244. * @param currentTarget defines he current object in the bubbling phase
  245. * @param userInfo defines any user info to send to observers
  246. * @returns {Promise<T>} will return a Promise than resolves when all callbacks executed successfully.
  247. */
  248. notifyObserversWithPromise(eventData: T, mask?: number, target?: any, currentTarget?: any, userInfo?: any): Promise<T>;
  249. /**
  250. * Notify a specific observer
  251. * @param observer defines the observer to notify
  252. * @param eventData defines the data to be sent to each callback
  253. * @param mask is used to filter observers defaults to -1
  254. */
  255. notifyObserver(observer: Observer<T>, eventData: T, mask?: number): void;
  256. /**
  257. * Gets a boolean indicating if the observable has at least one observer
  258. * @returns true is the Observable has at least one Observer registered
  259. */
  260. hasObservers(): boolean;
  261. /**
  262. * Clear the list of observers
  263. */
  264. clear(): void;
  265. /**
  266. * Clone the current observable
  267. * @returns a new observable
  268. */
  269. clone(): Observable<T>;
  270. /**
  271. * Does this observable handles observer registered with a given mask
  272. * @param mask defines the mask to be tested
  273. * @return whether or not one observer registered with the given mask is handeled
  274. **/
  275. hasSpecificMask(mask?: number): boolean;
  276. }
  277. }
  278. declare module "babylonjs/Misc/domManagement" {
  279. /**
  280. * Sets of helpers dealing with the DOM and some of the recurrent functions needed in
  281. * Babylon.js
  282. */
  283. export class DomManagement {
  284. /**
  285. * Checks if the window object exists
  286. * @returns true if the window object exists
  287. */
  288. static IsWindowObjectExist(): boolean;
  289. /**
  290. * Checks if the navigator object exists
  291. * @returns true if the navigator object exists
  292. */
  293. static IsNavigatorAvailable(): boolean;
  294. /**
  295. * Check if the document object exists
  296. * @returns true if the document object exists
  297. */
  298. static IsDocumentAvailable(): boolean;
  299. /**
  300. * Extracts text content from a DOM element hierarchy
  301. * @param element defines the root element
  302. * @returns a string
  303. */
  304. static GetDOMTextContent(element: HTMLElement): string;
  305. }
  306. }
  307. declare module "babylonjs/Misc/logger" {
  308. /**
  309. * Logger used througouht the application to allow configuration of
  310. * the log level required for the messages.
  311. */
  312. export class Logger {
  313. /**
  314. * No log
  315. */
  316. static readonly NoneLogLevel: number;
  317. /**
  318. * Only message logs
  319. */
  320. static readonly MessageLogLevel: number;
  321. /**
  322. * Only warning logs
  323. */
  324. static readonly WarningLogLevel: number;
  325. /**
  326. * Only error logs
  327. */
  328. static readonly ErrorLogLevel: number;
  329. /**
  330. * All logs
  331. */
  332. static readonly AllLogLevel: number;
  333. private static _LogCache;
  334. /**
  335. * Gets a value indicating the number of loading errors
  336. * @ignorenaming
  337. */
  338. static errorsCount: number;
  339. /**
  340. * Callback called when a new log is added
  341. */
  342. static OnNewCacheEntry: (entry: string) => void;
  343. private static _AddLogEntry;
  344. private static _FormatMessage;
  345. private static _LogDisabled;
  346. private static _LogEnabled;
  347. private static _WarnDisabled;
  348. private static _WarnEnabled;
  349. private static _ErrorDisabled;
  350. private static _ErrorEnabled;
  351. /**
  352. * Log a message to the console
  353. */
  354. static Log: (message: string) => void;
  355. /**
  356. * Write a warning message to the console
  357. */
  358. static Warn: (message: string) => void;
  359. /**
  360. * Write an error message to the console
  361. */
  362. static Error: (message: string) => void;
  363. /**
  364. * Gets current log cache (list of logs)
  365. */
  366. static get LogCache(): string;
  367. /**
  368. * Clears the log cache
  369. */
  370. static ClearLogCache(): void;
  371. /**
  372. * Sets the current log level (MessageLogLevel / WarningLogLevel / ErrorLogLevel)
  373. */
  374. static set LogLevels(level: number);
  375. }
  376. }
  377. declare module "babylonjs/Misc/typeStore" {
  378. /** @hidden */
  379. export class _TypeStore {
  380. /** @hidden */
  381. static RegisteredTypes: {
  382. [key: string]: Object;
  383. };
  384. /** @hidden */
  385. static GetClass(fqdn: string): any;
  386. }
  387. }
  388. declare module "babylonjs/Misc/stringTools" {
  389. /**
  390. * Helper to manipulate strings
  391. */
  392. export class StringTools {
  393. /**
  394. * Checks for a matching suffix at the end of a string (for ES5 and lower)
  395. * @param str Source string
  396. * @param suffix Suffix to search for in the source string
  397. * @returns Boolean indicating whether the suffix was found (true) or not (false)
  398. */
  399. static EndsWith(str: string, suffix: string): boolean;
  400. /**
  401. * Checks for a matching suffix at the beginning of a string (for ES5 and lower)
  402. * @param str Source string
  403. * @param suffix Suffix to search for in the source string
  404. * @returns Boolean indicating whether the suffix was found (true) or not (false)
  405. */
  406. static StartsWith(str: string, suffix: string): boolean;
  407. /**
  408. * Decodes a buffer into a string
  409. * @param buffer The buffer to decode
  410. * @returns The decoded string
  411. */
  412. static Decode(buffer: Uint8Array | Uint16Array): string;
  413. /**
  414. * Encode a buffer to a base64 string
  415. * @param buffer defines the buffer to encode
  416. * @returns the encoded string
  417. */
  418. static EncodeArrayBufferToBase64(buffer: ArrayBuffer | ArrayBufferView): string;
  419. /**
  420. * Converts a number to string and pads with preceeding zeroes until it is of specified length.
  421. * @param num the number to convert and pad
  422. * @param length the expected length of the string
  423. * @returns the padded string
  424. */
  425. static PadNumber(num: number, length: number): string;
  426. }
  427. }
  428. declare module "babylonjs/Misc/deepCopier" {
  429. /**
  430. * Class containing a set of static utilities functions for deep copy.
  431. */
  432. export class DeepCopier {
  433. /**
  434. * Tries to copy an object by duplicating every property
  435. * @param source defines the source object
  436. * @param destination defines the target object
  437. * @param doNotCopyList defines a list of properties to avoid
  438. * @param mustCopyList defines a list of properties to copy (even if they start with _)
  439. */
  440. static DeepCopy(source: any, destination: any, doNotCopyList?: string[], mustCopyList?: string[]): void;
  441. }
  442. }
  443. declare module "babylonjs/Misc/precisionDate" {
  444. /**
  445. * Class containing a set of static utilities functions for precision date
  446. */
  447. export class PrecisionDate {
  448. /**
  449. * Gets either window.performance.now() if supported or Date.now() else
  450. */
  451. static get Now(): number;
  452. }
  453. }
  454. declare module "babylonjs/Misc/devTools" {
  455. /** @hidden */
  456. export class _DevTools {
  457. static WarnImport(name: string): string;
  458. }
  459. }
  460. declare module "babylonjs/Misc/interfaces/iWebRequest" {
  461. /**
  462. * Interface used to define the mechanism to get data from the network
  463. */
  464. export interface IWebRequest {
  465. /**
  466. * Returns client's response url
  467. */
  468. responseURL: string;
  469. /**
  470. * Returns client's status
  471. */
  472. status: number;
  473. /**
  474. * Returns client's status as a text
  475. */
  476. statusText: string;
  477. }
  478. }
  479. declare module "babylonjs/Misc/webRequest" {
  480. import { IWebRequest } from "babylonjs/Misc/interfaces/iWebRequest";
  481. import { Nullable } from "babylonjs/types";
  482. /**
  483. * Extended version of XMLHttpRequest with support for customizations (headers, ...)
  484. */
  485. export class WebRequest implements IWebRequest {
  486. private _xhr;
  487. /**
  488. * Custom HTTP Request Headers to be sent with XMLHttpRequests
  489. * i.e. when loading files, where the server/service expects an Authorization header
  490. */
  491. static CustomRequestHeaders: {
  492. [key: string]: string;
  493. };
  494. /**
  495. * Add callback functions in this array to update all the requests before they get sent to the network
  496. */
  497. static CustomRequestModifiers: ((request: XMLHttpRequest, url: string) => void)[];
  498. private _injectCustomRequestHeaders;
  499. /**
  500. * Gets or sets a function to be called when loading progress changes
  501. */
  502. get onprogress(): ((this: XMLHttpRequest, ev: ProgressEvent) => any) | null;
  503. set onprogress(value: ((this: XMLHttpRequest, ev: ProgressEvent) => any) | null);
  504. /**
  505. * Returns client's state
  506. */
  507. get readyState(): number;
  508. /**
  509. * Returns client's status
  510. */
  511. get status(): number;
  512. /**
  513. * Returns client's status as a text
  514. */
  515. get statusText(): string;
  516. /**
  517. * Returns client's response
  518. */
  519. get response(): any;
  520. /**
  521. * Returns client's response url
  522. */
  523. get responseURL(): string;
  524. /**
  525. * Returns client's response as text
  526. */
  527. get responseText(): string;
  528. /**
  529. * Gets or sets the expected response type
  530. */
  531. get responseType(): XMLHttpRequestResponseType;
  532. set responseType(value: XMLHttpRequestResponseType);
  533. /** @hidden */
  534. addEventListener<K extends keyof XMLHttpRequestEventMap>(type: K, listener: (this: XMLHttpRequest, ev: XMLHttpRequestEventMap[K]) => any, options?: boolean | AddEventListenerOptions): void;
  535. /** @hidden */
  536. removeEventListener<K extends keyof XMLHttpRequestEventMap>(type: K, listener: (this: XMLHttpRequest, ev: XMLHttpRequestEventMap[K]) => any, options?: boolean | EventListenerOptions): void;
  537. /**
  538. * Cancels any network activity
  539. */
  540. abort(): void;
  541. /**
  542. * Initiates the request. The optional argument provides the request body. The argument is ignored if request method is GET or HEAD
  543. * @param body defines an optional request body
  544. */
  545. send(body?: Document | BodyInit | null): void;
  546. /**
  547. * Sets the request method, request URL
  548. * @param method defines the method to use (GET, POST, etc..)
  549. * @param url defines the url to connect with
  550. */
  551. open(method: string, url: string): void;
  552. /**
  553. * Sets the value of a request header.
  554. * @param name The name of the header whose value is to be set
  555. * @param value The value to set as the body of the header
  556. */
  557. setRequestHeader(name: string, value: string): void;
  558. /**
  559. * Get the string containing the text of a particular header's value.
  560. * @param name The name of the header
  561. * @returns The string containing the text of the given header name
  562. */
  563. getResponseHeader(name: string): Nullable<string>;
  564. }
  565. }
  566. declare module "babylonjs/Misc/fileRequest" {
  567. import { Observable } from "babylonjs/Misc/observable";
  568. /**
  569. * File request interface
  570. */
  571. export interface IFileRequest {
  572. /**
  573. * Raised when the request is complete (success or error).
  574. */
  575. onCompleteObservable: Observable<IFileRequest>;
  576. /**
  577. * Aborts the request for a file.
  578. */
  579. abort: () => void;
  580. }
  581. }
  582. declare module "babylonjs/Materials/Textures/renderTargetCreationOptions" {
  583. /**
  584. * Define options used to create a render target texture
  585. */
  586. export class RenderTargetCreationOptions {
  587. /**
  588. * Specifies is mipmaps must be generated
  589. */
  590. generateMipMaps?: boolean;
  591. /** Specifies whether or not a depth should be allocated in the texture (true by default) */
  592. generateDepthBuffer?: boolean;
  593. /** Specifies whether or not a stencil should be allocated in the texture (false by default)*/
  594. generateStencilBuffer?: boolean;
  595. /** Defines texture type (int by default) */
  596. type?: number;
  597. /** Defines sampling mode (trilinear by default) */
  598. samplingMode?: number;
  599. /** Defines format (RGBA by default) */
  600. format?: number;
  601. }
  602. }
  603. declare module "babylonjs/Engines/constants" {
  604. /** Defines the cross module used constants to avoid circular dependncies */
  605. export class Constants {
  606. /** Defines that alpha blending is disabled */
  607. static readonly ALPHA_DISABLE: number;
  608. /** Defines that alpha blending is SRC ALPHA * SRC + DEST */
  609. static readonly ALPHA_ADD: number;
  610. /** Defines that alpha blending is SRC ALPHA * SRC + (1 - SRC ALPHA) * DEST */
  611. static readonly ALPHA_COMBINE: number;
  612. /** Defines that alpha blending is DEST - SRC * DEST */
  613. static readonly ALPHA_SUBTRACT: number;
  614. /** Defines that alpha blending is SRC * DEST */
  615. static readonly ALPHA_MULTIPLY: number;
  616. /** Defines that alpha blending is SRC ALPHA * SRC + (1 - SRC) * DEST */
  617. static readonly ALPHA_MAXIMIZED: number;
  618. /** Defines that alpha blending is SRC + DEST */
  619. static readonly ALPHA_ONEONE: number;
  620. /** Defines that alpha blending is SRC + (1 - SRC ALPHA) * DEST */
  621. static readonly ALPHA_PREMULTIPLIED: number;
  622. /**
  623. * Defines that alpha blending is SRC + (1 - SRC ALPHA) * DEST
  624. * Alpha will be set to (1 - SRC ALPHA) * DEST ALPHA
  625. */
  626. static readonly ALPHA_PREMULTIPLIED_PORTERDUFF: number;
  627. /** Defines that alpha blending is CST * SRC + (1 - CST) * DEST */
  628. static readonly ALPHA_INTERPOLATE: number;
  629. /**
  630. * Defines that alpha blending is SRC + (1 - SRC) * DEST
  631. * Alpha will be set to SRC ALPHA + (1 - SRC ALPHA) * DEST ALPHA
  632. */
  633. static readonly ALPHA_SCREENMODE: number;
  634. /**
  635. * Defines that alpha blending is SRC + DST
  636. * Alpha will be set to SRC ALPHA + DST ALPHA
  637. */
  638. static readonly ALPHA_ONEONE_ONEONE: number;
  639. /**
  640. * Defines that alpha blending is SRC * DST ALPHA + DST
  641. * Alpha will be set to 0
  642. */
  643. static readonly ALPHA_ALPHATOCOLOR: number;
  644. /**
  645. * Defines that alpha blending is SRC * (1 - DST) + DST * (1 - SRC)
  646. */
  647. static readonly ALPHA_REVERSEONEMINUS: number;
  648. /**
  649. * Defines that alpha blending is SRC + DST * (1 - SRC ALPHA)
  650. * Alpha will be set to SRC ALPHA + DST ALPHA * (1 - SRC ALPHA)
  651. */
  652. static readonly ALPHA_SRC_DSTONEMINUSSRCALPHA: number;
  653. /**
  654. * Defines that alpha blending is SRC + DST
  655. * Alpha will be set to SRC ALPHA
  656. */
  657. static readonly ALPHA_ONEONE_ONEZERO: number;
  658. /**
  659. * Defines that alpha blending is SRC * (1 - DST) + DST * (1 - SRC)
  660. * Alpha will be set to DST ALPHA
  661. */
  662. static readonly ALPHA_EXCLUSION: number;
  663. /** Defines that alpha blending equation a SUM */
  664. static readonly ALPHA_EQUATION_ADD: number;
  665. /** Defines that alpha blending equation a SUBSTRACTION */
  666. static readonly ALPHA_EQUATION_SUBSTRACT: number;
  667. /** Defines that alpha blending equation a REVERSE SUBSTRACTION */
  668. static readonly ALPHA_EQUATION_REVERSE_SUBTRACT: number;
  669. /** Defines that alpha blending equation a MAX operation */
  670. static readonly ALPHA_EQUATION_MAX: number;
  671. /** Defines that alpha blending equation a MIN operation */
  672. static readonly ALPHA_EQUATION_MIN: number;
  673. /**
  674. * Defines that alpha blending equation a DARKEN operation:
  675. * It takes the min of the src and sums the alpha channels.
  676. */
  677. static readonly ALPHA_EQUATION_DARKEN: number;
  678. /** Defines that the ressource is not delayed*/
  679. static readonly DELAYLOADSTATE_NONE: number;
  680. /** Defines that the ressource was successfully delay loaded */
  681. static readonly DELAYLOADSTATE_LOADED: number;
  682. /** Defines that the ressource is currently delay loading */
  683. static readonly DELAYLOADSTATE_LOADING: number;
  684. /** Defines that the ressource is delayed and has not started loading */
  685. static readonly DELAYLOADSTATE_NOTLOADED: number;
  686. /** Passed to depthFunction or stencilFunction to specify depth or stencil tests will never pass. i.e. Nothing will be drawn */
  687. static readonly NEVER: number;
  688. /** 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 */
  689. static readonly ALWAYS: number;
  690. /** Passed to depthFunction or stencilFunction to specify depth or stencil tests will pass if the new depth value is less than the stored value */
  691. static readonly LESS: number;
  692. /** Passed to depthFunction or stencilFunction to specify depth or stencil tests will pass if the new depth value is equals to the stored value */
  693. static readonly EQUAL: number;
  694. /** 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 */
  695. static readonly LEQUAL: number;
  696. /** Passed to depthFunction or stencilFunction to specify depth or stencil tests will pass if the new depth value is greater than the stored value */
  697. static readonly GREATER: number;
  698. /** 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 */
  699. static readonly GEQUAL: number;
  700. /** 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 */
  701. static readonly NOTEQUAL: number;
  702. /** Passed to stencilOperation to specify that stencil value must be kept */
  703. static readonly KEEP: number;
  704. /** Passed to stencilOperation to specify that stencil value must be replaced */
  705. static readonly REPLACE: number;
  706. /** Passed to stencilOperation to specify that stencil value must be incremented */
  707. static readonly INCR: number;
  708. /** Passed to stencilOperation to specify that stencil value must be decremented */
  709. static readonly DECR: number;
  710. /** Passed to stencilOperation to specify that stencil value must be inverted */
  711. static readonly INVERT: number;
  712. /** Passed to stencilOperation to specify that stencil value must be incremented with wrapping */
  713. static readonly INCR_WRAP: number;
  714. /** Passed to stencilOperation to specify that stencil value must be decremented with wrapping */
  715. static readonly DECR_WRAP: number;
  716. /** Texture is not repeating outside of 0..1 UVs */
  717. static readonly TEXTURE_CLAMP_ADDRESSMODE: number;
  718. /** Texture is repeating outside of 0..1 UVs */
  719. static readonly TEXTURE_WRAP_ADDRESSMODE: number;
  720. /** Texture is repeating and mirrored */
  721. static readonly TEXTURE_MIRROR_ADDRESSMODE: number;
  722. /** ALPHA */
  723. static readonly TEXTUREFORMAT_ALPHA: number;
  724. /** LUMINANCE */
  725. static readonly TEXTUREFORMAT_LUMINANCE: number;
  726. /** LUMINANCE_ALPHA */
  727. static readonly TEXTUREFORMAT_LUMINANCE_ALPHA: number;
  728. /** RGB */
  729. static readonly TEXTUREFORMAT_RGB: number;
  730. /** RGBA */
  731. static readonly TEXTUREFORMAT_RGBA: number;
  732. /** RED */
  733. static readonly TEXTUREFORMAT_RED: number;
  734. /** RED (2nd reference) */
  735. static readonly TEXTUREFORMAT_R: number;
  736. /** RG */
  737. static readonly TEXTUREFORMAT_RG: number;
  738. /** RED_INTEGER */
  739. static readonly TEXTUREFORMAT_RED_INTEGER: number;
  740. /** RED_INTEGER (2nd reference) */
  741. static readonly TEXTUREFORMAT_R_INTEGER: number;
  742. /** RG_INTEGER */
  743. static readonly TEXTUREFORMAT_RG_INTEGER: number;
  744. /** RGB_INTEGER */
  745. static readonly TEXTUREFORMAT_RGB_INTEGER: number;
  746. /** RGBA_INTEGER */
  747. static readonly TEXTUREFORMAT_RGBA_INTEGER: number;
  748. /** UNSIGNED_BYTE */
  749. static readonly TEXTURETYPE_UNSIGNED_BYTE: number;
  750. /** UNSIGNED_BYTE (2nd reference) */
  751. static readonly TEXTURETYPE_UNSIGNED_INT: number;
  752. /** FLOAT */
  753. static readonly TEXTURETYPE_FLOAT: number;
  754. /** HALF_FLOAT */
  755. static readonly TEXTURETYPE_HALF_FLOAT: number;
  756. /** BYTE */
  757. static readonly TEXTURETYPE_BYTE: number;
  758. /** SHORT */
  759. static readonly TEXTURETYPE_SHORT: number;
  760. /** UNSIGNED_SHORT */
  761. static readonly TEXTURETYPE_UNSIGNED_SHORT: number;
  762. /** INT */
  763. static readonly TEXTURETYPE_INT: number;
  764. /** UNSIGNED_INT */
  765. static readonly TEXTURETYPE_UNSIGNED_INTEGER: number;
  766. /** UNSIGNED_SHORT_4_4_4_4 */
  767. static readonly TEXTURETYPE_UNSIGNED_SHORT_4_4_4_4: number;
  768. /** UNSIGNED_SHORT_5_5_5_1 */
  769. static readonly TEXTURETYPE_UNSIGNED_SHORT_5_5_5_1: number;
  770. /** UNSIGNED_SHORT_5_6_5 */
  771. static readonly TEXTURETYPE_UNSIGNED_SHORT_5_6_5: number;
  772. /** UNSIGNED_INT_2_10_10_10_REV */
  773. static readonly TEXTURETYPE_UNSIGNED_INT_2_10_10_10_REV: number;
  774. /** UNSIGNED_INT_24_8 */
  775. static readonly TEXTURETYPE_UNSIGNED_INT_24_8: number;
  776. /** UNSIGNED_INT_10F_11F_11F_REV */
  777. static readonly TEXTURETYPE_UNSIGNED_INT_10F_11F_11F_REV: number;
  778. /** UNSIGNED_INT_5_9_9_9_REV */
  779. static readonly TEXTURETYPE_UNSIGNED_INT_5_9_9_9_REV: number;
  780. /** FLOAT_32_UNSIGNED_INT_24_8_REV */
  781. static readonly TEXTURETYPE_FLOAT_32_UNSIGNED_INT_24_8_REV: number;
  782. /** nearest is mag = nearest and min = nearest and no mip */
  783. static readonly TEXTURE_NEAREST_SAMPLINGMODE: number;
  784. /** mag = nearest and min = nearest and mip = none */
  785. static readonly TEXTURE_NEAREST_NEAREST: number;
  786. /** Bilinear is mag = linear and min = linear and no mip */
  787. static readonly TEXTURE_BILINEAR_SAMPLINGMODE: number;
  788. /** mag = linear and min = linear and mip = none */
  789. static readonly TEXTURE_LINEAR_LINEAR: number;
  790. /** Trilinear is mag = linear and min = linear and mip = linear */
  791. static readonly TEXTURE_TRILINEAR_SAMPLINGMODE: number;
  792. /** Trilinear is mag = linear and min = linear and mip = linear */
  793. static readonly TEXTURE_LINEAR_LINEAR_MIPLINEAR: number;
  794. /** mag = nearest and min = nearest and mip = nearest */
  795. static readonly TEXTURE_NEAREST_NEAREST_MIPNEAREST: number;
  796. /** mag = nearest and min = linear and mip = nearest */
  797. static readonly TEXTURE_NEAREST_LINEAR_MIPNEAREST: number;
  798. /** mag = nearest and min = linear and mip = linear */
  799. static readonly TEXTURE_NEAREST_LINEAR_MIPLINEAR: number;
  800. /** mag = nearest and min = linear and mip = none */
  801. static readonly TEXTURE_NEAREST_LINEAR: number;
  802. /** nearest is mag = nearest and min = nearest and mip = linear */
  803. static readonly TEXTURE_NEAREST_NEAREST_MIPLINEAR: number;
  804. /** mag = linear and min = nearest and mip = nearest */
  805. static readonly TEXTURE_LINEAR_NEAREST_MIPNEAREST: number;
  806. /** mag = linear and min = nearest and mip = linear */
  807. static readonly TEXTURE_LINEAR_NEAREST_MIPLINEAR: number;
  808. /** Bilinear is mag = linear and min = linear and mip = nearest */
  809. static readonly TEXTURE_LINEAR_LINEAR_MIPNEAREST: number;
  810. /** mag = linear and min = nearest and mip = none */
  811. static readonly TEXTURE_LINEAR_NEAREST: number;
  812. /** Explicit coordinates mode */
  813. static readonly TEXTURE_EXPLICIT_MODE: number;
  814. /** Spherical coordinates mode */
  815. static readonly TEXTURE_SPHERICAL_MODE: number;
  816. /** Planar coordinates mode */
  817. static readonly TEXTURE_PLANAR_MODE: number;
  818. /** Cubic coordinates mode */
  819. static readonly TEXTURE_CUBIC_MODE: number;
  820. /** Projection coordinates mode */
  821. static readonly TEXTURE_PROJECTION_MODE: number;
  822. /** Skybox coordinates mode */
  823. static readonly TEXTURE_SKYBOX_MODE: number;
  824. /** Inverse Cubic coordinates mode */
  825. static readonly TEXTURE_INVCUBIC_MODE: number;
  826. /** Equirectangular coordinates mode */
  827. static readonly TEXTURE_EQUIRECTANGULAR_MODE: number;
  828. /** Equirectangular Fixed coordinates mode */
  829. static readonly TEXTURE_FIXED_EQUIRECTANGULAR_MODE: number;
  830. /** Equirectangular Fixed Mirrored coordinates mode */
  831. static readonly TEXTURE_FIXED_EQUIRECTANGULAR_MIRRORED_MODE: number;
  832. /** Offline (baking) quality for texture filtering */
  833. static readonly TEXTURE_FILTERING_QUALITY_OFFLINE: number;
  834. /** High quality for texture filtering */
  835. static readonly TEXTURE_FILTERING_QUALITY_HIGH: number;
  836. /** Medium quality for texture filtering */
  837. static readonly TEXTURE_FILTERING_QUALITY_MEDIUM: number;
  838. /** Low quality for texture filtering */
  839. static readonly TEXTURE_FILTERING_QUALITY_LOW: number;
  840. /** Defines that texture rescaling will use a floor to find the closer power of 2 size */
  841. static readonly SCALEMODE_FLOOR: number;
  842. /** Defines that texture rescaling will look for the nearest power of 2 size */
  843. static readonly SCALEMODE_NEAREST: number;
  844. /** Defines that texture rescaling will use a ceil to find the closer power of 2 size */
  845. static readonly SCALEMODE_CEILING: number;
  846. /**
  847. * The dirty texture flag value
  848. */
  849. static readonly MATERIAL_TextureDirtyFlag: number;
  850. /**
  851. * The dirty light flag value
  852. */
  853. static readonly MATERIAL_LightDirtyFlag: number;
  854. /**
  855. * The dirty fresnel flag value
  856. */
  857. static readonly MATERIAL_FresnelDirtyFlag: number;
  858. /**
  859. * The dirty attribute flag value
  860. */
  861. static readonly MATERIAL_AttributesDirtyFlag: number;
  862. /**
  863. * The dirty misc flag value
  864. */
  865. static readonly MATERIAL_MiscDirtyFlag: number;
  866. /**
  867. * The dirty prepass flag value
  868. */
  869. static readonly MATERIAL_PrePassDirtyFlag: number;
  870. /**
  871. * The all dirty flag value
  872. */
  873. static readonly MATERIAL_AllDirtyFlag: number;
  874. /**
  875. * Returns the triangle fill mode
  876. */
  877. static readonly MATERIAL_TriangleFillMode: number;
  878. /**
  879. * Returns the wireframe mode
  880. */
  881. static readonly MATERIAL_WireFrameFillMode: number;
  882. /**
  883. * Returns the point fill mode
  884. */
  885. static readonly MATERIAL_PointFillMode: number;
  886. /**
  887. * Returns the point list draw mode
  888. */
  889. static readonly MATERIAL_PointListDrawMode: number;
  890. /**
  891. * Returns the line list draw mode
  892. */
  893. static readonly MATERIAL_LineListDrawMode: number;
  894. /**
  895. * Returns the line loop draw mode
  896. */
  897. static readonly MATERIAL_LineLoopDrawMode: number;
  898. /**
  899. * Returns the line strip draw mode
  900. */
  901. static readonly MATERIAL_LineStripDrawMode: number;
  902. /**
  903. * Returns the triangle strip draw mode
  904. */
  905. static readonly MATERIAL_TriangleStripDrawMode: number;
  906. /**
  907. * Returns the triangle fan draw mode
  908. */
  909. static readonly MATERIAL_TriangleFanDrawMode: number;
  910. /**
  911. * Stores the clock-wise side orientation
  912. */
  913. static readonly MATERIAL_ClockWiseSideOrientation: number;
  914. /**
  915. * Stores the counter clock-wise side orientation
  916. */
  917. static readonly MATERIAL_CounterClockWiseSideOrientation: number;
  918. /**
  919. * Nothing
  920. * @see https://doc.babylonjs.com/how_to/how_to_use_actions#triggers
  921. */
  922. static readonly ACTION_NothingTrigger: number;
  923. /**
  924. * On pick
  925. * @see https://doc.babylonjs.com/how_to/how_to_use_actions#triggers
  926. */
  927. static readonly ACTION_OnPickTrigger: number;
  928. /**
  929. * On left pick
  930. * @see https://doc.babylonjs.com/how_to/how_to_use_actions#triggers
  931. */
  932. static readonly ACTION_OnLeftPickTrigger: number;
  933. /**
  934. * On right pick
  935. * @see https://doc.babylonjs.com/how_to/how_to_use_actions#triggers
  936. */
  937. static readonly ACTION_OnRightPickTrigger: number;
  938. /**
  939. * On center pick
  940. * @see https://doc.babylonjs.com/how_to/how_to_use_actions#triggers
  941. */
  942. static readonly ACTION_OnCenterPickTrigger: number;
  943. /**
  944. * On pick down
  945. * @see https://doc.babylonjs.com/how_to/how_to_use_actions#triggers
  946. */
  947. static readonly ACTION_OnPickDownTrigger: number;
  948. /**
  949. * On double pick
  950. * @see https://doc.babylonjs.com/how_to/how_to_use_actions#triggers
  951. */
  952. static readonly ACTION_OnDoublePickTrigger: number;
  953. /**
  954. * On pick up
  955. * @see https://doc.babylonjs.com/how_to/how_to_use_actions#triggers
  956. */
  957. static readonly ACTION_OnPickUpTrigger: number;
  958. /**
  959. * On pick out.
  960. * This trigger will only be raised if you also declared a OnPickDown
  961. * @see https://doc.babylonjs.com/how_to/how_to_use_actions#triggers
  962. */
  963. static readonly ACTION_OnPickOutTrigger: number;
  964. /**
  965. * On long press
  966. * @see https://doc.babylonjs.com/how_to/how_to_use_actions#triggers
  967. */
  968. static readonly ACTION_OnLongPressTrigger: number;
  969. /**
  970. * On pointer over
  971. * @see https://doc.babylonjs.com/how_to/how_to_use_actions#triggers
  972. */
  973. static readonly ACTION_OnPointerOverTrigger: number;
  974. /**
  975. * On pointer out
  976. * @see https://doc.babylonjs.com/how_to/how_to_use_actions#triggers
  977. */
  978. static readonly ACTION_OnPointerOutTrigger: number;
  979. /**
  980. * On every frame
  981. * @see https://doc.babylonjs.com/how_to/how_to_use_actions#triggers
  982. */
  983. static readonly ACTION_OnEveryFrameTrigger: number;
  984. /**
  985. * On intersection enter
  986. * @see https://doc.babylonjs.com/how_to/how_to_use_actions#triggers
  987. */
  988. static readonly ACTION_OnIntersectionEnterTrigger: number;
  989. /**
  990. * On intersection exit
  991. * @see https://doc.babylonjs.com/how_to/how_to_use_actions#triggers
  992. */
  993. static readonly ACTION_OnIntersectionExitTrigger: number;
  994. /**
  995. * On key down
  996. * @see https://doc.babylonjs.com/how_to/how_to_use_actions#triggers
  997. */
  998. static readonly ACTION_OnKeyDownTrigger: number;
  999. /**
  1000. * On key up
  1001. * @see https://doc.babylonjs.com/how_to/how_to_use_actions#triggers
  1002. */
  1003. static readonly ACTION_OnKeyUpTrigger: number;
  1004. /**
  1005. * Billboard mode will only apply to Y axis
  1006. */
  1007. static readonly PARTICLES_BILLBOARDMODE_Y: number;
  1008. /**
  1009. * Billboard mode will apply to all axes
  1010. */
  1011. static readonly PARTICLES_BILLBOARDMODE_ALL: number;
  1012. /**
  1013. * Special billboard mode where the particle will be biilboard to the camera but rotated to align with direction
  1014. */
  1015. static readonly PARTICLES_BILLBOARDMODE_STRETCHED: number;
  1016. /** Default culling strategy : this is an exclusion test and it's the more accurate.
  1017. * Test order :
  1018. * Is the bounding sphere outside the frustum ?
  1019. * If not, are the bounding box vertices outside the frustum ?
  1020. * It not, then the cullable object is in the frustum.
  1021. */
  1022. static readonly MESHES_CULLINGSTRATEGY_STANDARD: number;
  1023. /** Culling strategy : Bounding Sphere Only.
  1024. * This is an exclusion test. It's faster than the standard strategy because the bounding box is not tested.
  1025. * It's also less accurate than the standard because some not visible objects can still be selected.
  1026. * Test : is the bounding sphere outside the frustum ?
  1027. * If not, then the cullable object is in the frustum.
  1028. */
  1029. static readonly MESHES_CULLINGSTRATEGY_BOUNDINGSPHERE_ONLY: number;
  1030. /** Culling strategy : Optimistic Inclusion.
  1031. * This in an inclusion test first, then the standard exclusion test.
  1032. * This can be faster when a cullable object is expected to be almost always in the camera frustum.
  1033. * 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.
  1034. * Anyway, it's as accurate as the standard strategy.
  1035. * Test :
  1036. * Is the cullable object bounding sphere center in the frustum ?
  1037. * If not, apply the default culling strategy.
  1038. */
  1039. static readonly MESHES_CULLINGSTRATEGY_OPTIMISTIC_INCLUSION: number;
  1040. /** Culling strategy : Optimistic Inclusion then Bounding Sphere Only.
  1041. * This in an inclusion test first, then the bounding sphere only exclusion test.
  1042. * This can be the fastest test when a cullable object is expected to be almost always in the camera frustum.
  1043. * 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.
  1044. * It's less accurate than the standard strategy and as accurate as the BoundingSphereOnly strategy.
  1045. * Test :
  1046. * Is the cullable object bounding sphere center in the frustum ?
  1047. * If not, apply the Bounding Sphere Only strategy. No Bounding Box is tested here.
  1048. */
  1049. static readonly MESHES_CULLINGSTRATEGY_OPTIMISTIC_INCLUSION_THEN_BSPHERE_ONLY: number;
  1050. /**
  1051. * No logging while loading
  1052. */
  1053. static readonly SCENELOADER_NO_LOGGING: number;
  1054. /**
  1055. * Minimal logging while loading
  1056. */
  1057. static readonly SCENELOADER_MINIMAL_LOGGING: number;
  1058. /**
  1059. * Summary logging while loading
  1060. */
  1061. static readonly SCENELOADER_SUMMARY_LOGGING: number;
  1062. /**
  1063. * Detailled logging while loading
  1064. */
  1065. static readonly SCENELOADER_DETAILED_LOGGING: number;
  1066. /**
  1067. * Constant used to retrieve the irradiance texture index in the textures array in the prepass
  1068. * using getIndex(Constants.PREPASS_IRRADIANCE_TEXTURE_TYPE)
  1069. */
  1070. static readonly PREPASS_IRRADIANCE_TEXTURE_TYPE: number;
  1071. /**
  1072. * Constant used to retrieve the position texture index in the textures array in the prepass
  1073. * using getIndex(Constants.PREPASS_POSITION_TEXTURE_INDEX)
  1074. */
  1075. static readonly PREPASS_POSITION_TEXTURE_TYPE: number;
  1076. /**
  1077. * Constant used to retrieve the velocity texture index in the textures array in the prepass
  1078. * using getIndex(Constants.PREPASS_VELOCITY_TEXTURE_INDEX)
  1079. */
  1080. static readonly PREPASS_VELOCITY_TEXTURE_TYPE: number;
  1081. /**
  1082. * Constant used to retrieve the reflectivity texture index in the textures array in the prepass
  1083. * using the getIndex(Constants.PREPASS_REFLECTIVITY_TEXTURE_TYPE)
  1084. */
  1085. static readonly PREPASS_REFLECTIVITY_TEXTURE_TYPE: number;
  1086. /**
  1087. * Constant used to retrieve the lit color texture index in the textures array in the prepass
  1088. * using the getIndex(Constants.PREPASS_COLOR_TEXTURE_TYPE)
  1089. */
  1090. static readonly PREPASS_COLOR_TEXTURE_TYPE: number;
  1091. /**
  1092. * Constant used to retrieve depth + normal index in the textures array in the prepass
  1093. * using the getIndex(Constants.PREPASS_DEPTHNORMAL_TEXTURE_TYPE)
  1094. */
  1095. static readonly PREPASS_DEPTHNORMAL_TEXTURE_TYPE: number;
  1096. /**
  1097. * Constant used to retrieve albedo index in the textures array in the prepass
  1098. * using the getIndex(Constants.PREPASS_ALBEDO_TEXTURE_TYPE)
  1099. */
  1100. static readonly PREPASS_ALBEDO_TEXTURE_TYPE: number;
  1101. }
  1102. }
  1103. declare module "babylonjs/Materials/Textures/internalTextureLoader" {
  1104. import { Nullable } from "babylonjs/types";
  1105. import { InternalTexture } from "babylonjs/Materials/Textures/internalTexture";
  1106. /**
  1107. * This represents the required contract to create a new type of texture loader.
  1108. */
  1109. export interface IInternalTextureLoader {
  1110. /**
  1111. * Defines wether the loader supports cascade loading the different faces.
  1112. */
  1113. supportCascades: boolean;
  1114. /**
  1115. * This returns if the loader support the current file information.
  1116. * @param extension defines the file extension of the file being loaded
  1117. * @param mimeType defines the optional mime type of the file being loaded
  1118. * @returns true if the loader can load the specified file
  1119. */
  1120. canLoad(extension: string, mimeType?: string): boolean;
  1121. /**
  1122. * Uploads the cube texture data to the WebGL texture. It has already been bound.
  1123. * @param data contains the texture data
  1124. * @param texture defines the BabylonJS internal texture
  1125. * @param createPolynomials will be true if polynomials have been requested
  1126. * @param onLoad defines the callback to trigger once the texture is ready
  1127. * @param onError defines the callback to trigger in case of error
  1128. */
  1129. loadCubeData(data: ArrayBufferView | ArrayBufferView[], texture: InternalTexture, createPolynomials: boolean, onLoad: Nullable<(data?: any) => void>, onError: Nullable<(message?: string, exception?: any) => void>): void;
  1130. /**
  1131. * Uploads the 2D texture data to the WebGL texture. It has already been bound once in the callback.
  1132. * @param data contains the texture data
  1133. * @param texture defines the BabylonJS internal texture
  1134. * @param callback defines the method to call once ready to upload
  1135. */
  1136. loadData(data: ArrayBufferView, texture: InternalTexture, callback: (width: number, height: number, loadMipmap: boolean, isCompressed: boolean, done: () => void, loadFailed?: boolean) => void): void;
  1137. }
  1138. }
  1139. declare module "babylonjs/Engines/IPipelineContext" {
  1140. /**
  1141. * Class used to store and describe the pipeline context associated with an effect
  1142. */
  1143. export interface IPipelineContext {
  1144. /**
  1145. * Gets a boolean indicating that this pipeline context is supporting asynchronous creating
  1146. */
  1147. isAsync: boolean;
  1148. /**
  1149. * Gets a boolean indicating that the context is ready to be used (like shaders / pipelines are compiled and ready for instance)
  1150. */
  1151. isReady: boolean;
  1152. /** @hidden */
  1153. _getVertexShaderCode(): string | null;
  1154. /** @hidden */
  1155. _getFragmentShaderCode(): string | null;
  1156. /** @hidden */
  1157. _handlesSpectorRebuildCallback(onCompiled: (compiledObject: any) => void): void;
  1158. }
  1159. }
  1160. declare module "babylonjs/Meshes/dataBuffer" {
  1161. /**
  1162. * Class used to store gfx data (like WebGLBuffer)
  1163. */
  1164. export class DataBuffer {
  1165. /**
  1166. * Gets or sets the number of objects referencing this buffer
  1167. */
  1168. references: number;
  1169. /** Gets or sets the size of the underlying buffer */
  1170. capacity: number;
  1171. /**
  1172. * Gets or sets a boolean indicating if the buffer contains 32bits indices
  1173. */
  1174. is32Bits: boolean;
  1175. /**
  1176. * Gets the underlying buffer
  1177. */
  1178. get underlyingResource(): any;
  1179. }
  1180. }
  1181. declare module "babylonjs/Engines/Processors/iShaderProcessor" {
  1182. /** @hidden */
  1183. export interface IShaderProcessor {
  1184. attributeProcessor?: (attribute: string) => string;
  1185. varyingProcessor?: (varying: string, isFragment: boolean) => string;
  1186. uniformProcessor?: (uniform: string, isFragment: boolean) => string;
  1187. uniformBufferProcessor?: (uniformBuffer: string, isFragment: boolean) => string;
  1188. endOfUniformBufferProcessor?: (closingBracketLine: string, isFragment: boolean) => string;
  1189. lineProcessor?: (line: string, isFragment: boolean) => string;
  1190. preProcessor?: (code: string, defines: string[], isFragment: boolean) => string;
  1191. postProcessor?: (code: string, defines: string[], isFragment: boolean) => string;
  1192. }
  1193. }
  1194. declare module "babylonjs/Engines/Processors/shaderProcessingOptions" {
  1195. import { IShaderProcessor } from "babylonjs/Engines/Processors/iShaderProcessor";
  1196. /** @hidden */
  1197. export interface ProcessingOptions {
  1198. defines: string[];
  1199. indexParameters: any;
  1200. isFragment: boolean;
  1201. shouldUseHighPrecisionShader: boolean;
  1202. supportsUniformBuffers: boolean;
  1203. shadersRepository: string;
  1204. includesShadersStore: {
  1205. [key: string]: string;
  1206. };
  1207. processor?: IShaderProcessor;
  1208. version: string;
  1209. platformName: string;
  1210. lookForClosingBracketForUniformBuffer?: boolean;
  1211. }
  1212. }
  1213. declare module "babylonjs/Engines/Processors/shaderCodeNode" {
  1214. import { ProcessingOptions } from "babylonjs/Engines/Processors/shaderProcessingOptions";
  1215. /** @hidden */
  1216. export class ShaderCodeNode {
  1217. line: string;
  1218. children: ShaderCodeNode[];
  1219. additionalDefineKey?: string;
  1220. additionalDefineValue?: string;
  1221. isValid(preprocessors: {
  1222. [key: string]: string;
  1223. }): boolean;
  1224. process(preprocessors: {
  1225. [key: string]: string;
  1226. }, options: ProcessingOptions): string;
  1227. }
  1228. }
  1229. declare module "babylonjs/Engines/Processors/shaderCodeCursor" {
  1230. /** @hidden */
  1231. export class ShaderCodeCursor {
  1232. private _lines;
  1233. lineIndex: number;
  1234. get currentLine(): string;
  1235. get canRead(): boolean;
  1236. set lines(value: string[]);
  1237. }
  1238. }
  1239. declare module "babylonjs/Engines/Processors/shaderCodeConditionNode" {
  1240. import { ShaderCodeNode } from "babylonjs/Engines/Processors/shaderCodeNode";
  1241. import { ProcessingOptions } from "babylonjs/Engines/Processors/shaderProcessingOptions";
  1242. /** @hidden */
  1243. export class ShaderCodeConditionNode extends ShaderCodeNode {
  1244. process(preprocessors: {
  1245. [key: string]: string;
  1246. }, options: ProcessingOptions): string;
  1247. }
  1248. }
  1249. declare module "babylonjs/Engines/Processors/Expressions/shaderDefineExpression" {
  1250. /** @hidden */
  1251. export class ShaderDefineExpression {
  1252. isTrue(preprocessors: {
  1253. [key: string]: string;
  1254. }): boolean;
  1255. private static _OperatorPriority;
  1256. private static _Stack;
  1257. static postfixToInfix(postfix: string[]): string;
  1258. static infixToPostfix(infix: string): string[];
  1259. }
  1260. }
  1261. declare module "babylonjs/Engines/Processors/shaderCodeTestNode" {
  1262. import { ShaderCodeNode } from "babylonjs/Engines/Processors/shaderCodeNode";
  1263. import { ShaderDefineExpression } from "babylonjs/Engines/Processors/Expressions/shaderDefineExpression";
  1264. /** @hidden */
  1265. export class ShaderCodeTestNode extends ShaderCodeNode {
  1266. testExpression: ShaderDefineExpression;
  1267. isValid(preprocessors: {
  1268. [key: string]: string;
  1269. }): boolean;
  1270. }
  1271. }
  1272. declare module "babylonjs/Engines/Processors/Expressions/Operators/shaderDefineIsDefinedOperator" {
  1273. import { ShaderDefineExpression } from "babylonjs/Engines/Processors/Expressions/shaderDefineExpression";
  1274. /** @hidden */
  1275. export class ShaderDefineIsDefinedOperator extends ShaderDefineExpression {
  1276. define: string;
  1277. not: boolean;
  1278. constructor(define: string, not?: boolean);
  1279. isTrue(preprocessors: {
  1280. [key: string]: string;
  1281. }): boolean;
  1282. }
  1283. }
  1284. declare module "babylonjs/Engines/Processors/Expressions/Operators/shaderDefineOrOperator" {
  1285. import { ShaderDefineExpression } from "babylonjs/Engines/Processors/Expressions/shaderDefineExpression";
  1286. /** @hidden */
  1287. export class ShaderDefineOrOperator extends ShaderDefineExpression {
  1288. leftOperand: ShaderDefineExpression;
  1289. rightOperand: ShaderDefineExpression;
  1290. isTrue(preprocessors: {
  1291. [key: string]: string;
  1292. }): boolean;
  1293. }
  1294. }
  1295. declare module "babylonjs/Engines/Processors/Expressions/Operators/shaderDefineAndOperator" {
  1296. import { ShaderDefineExpression } from "babylonjs/Engines/Processors/Expressions/shaderDefineExpression";
  1297. /** @hidden */
  1298. export class ShaderDefineAndOperator extends ShaderDefineExpression {
  1299. leftOperand: ShaderDefineExpression;
  1300. rightOperand: ShaderDefineExpression;
  1301. isTrue(preprocessors: {
  1302. [key: string]: string;
  1303. }): boolean;
  1304. }
  1305. }
  1306. declare module "babylonjs/Engines/Processors/Expressions/Operators/shaderDefineArithmeticOperator" {
  1307. import { ShaderDefineExpression } from "babylonjs/Engines/Processors/Expressions/shaderDefineExpression";
  1308. /** @hidden */
  1309. export class ShaderDefineArithmeticOperator extends ShaderDefineExpression {
  1310. define: string;
  1311. operand: string;
  1312. testValue: string;
  1313. constructor(define: string, operand: string, testValue: string);
  1314. isTrue(preprocessors: {
  1315. [key: string]: string;
  1316. }): boolean;
  1317. }
  1318. }
  1319. declare module "babylonjs/Offline/IOfflineProvider" {
  1320. /**
  1321. * Class used to enable access to offline support
  1322. * @see https://doc.babylonjs.com/how_to/caching_resources_in_indexeddb
  1323. */
  1324. export interface IOfflineProvider {
  1325. /**
  1326. * Gets a boolean indicating if scene must be saved in the database
  1327. */
  1328. enableSceneOffline: boolean;
  1329. /**
  1330. * Gets a boolean indicating if textures must be saved in the database
  1331. */
  1332. enableTexturesOffline: boolean;
  1333. /**
  1334. * Open the offline support and make it available
  1335. * @param successCallback defines the callback to call on success
  1336. * @param errorCallback defines the callback to call on error
  1337. */
  1338. open(successCallback: () => void, errorCallback: () => void): void;
  1339. /**
  1340. * Loads an image from the offline support
  1341. * @param url defines the url to load from
  1342. * @param image defines the target DOM image
  1343. */
  1344. loadImage(url: string, image: HTMLImageElement): void;
  1345. /**
  1346. * Loads a file from offline support
  1347. * @param url defines the URL to load from
  1348. * @param sceneLoaded defines a callback to call on success
  1349. * @param progressCallBack defines a callback to call when progress changed
  1350. * @param errorCallback defines a callback to call on error
  1351. * @param useArrayBuffer defines a boolean to use array buffer instead of text string
  1352. */
  1353. loadFile(url: string, sceneLoaded: (data: any) => void, progressCallBack?: (data: any) => void, errorCallback?: () => void, useArrayBuffer?: boolean): void;
  1354. }
  1355. }
  1356. declare module "babylonjs/Misc/filesInputStore" {
  1357. /**
  1358. * Class used to help managing file picking and drag'n'drop
  1359. * File Storage
  1360. */
  1361. export class FilesInputStore {
  1362. /**
  1363. * List of files ready to be loaded
  1364. */
  1365. static FilesToLoad: {
  1366. [key: string]: File;
  1367. };
  1368. }
  1369. }
  1370. declare module "babylonjs/Misc/retryStrategy" {
  1371. import { WebRequest } from "babylonjs/Misc/webRequest";
  1372. /**
  1373. * Class used to define a retry strategy when error happens while loading assets
  1374. */
  1375. export class RetryStrategy {
  1376. /**
  1377. * Function used to defines an exponential back off strategy
  1378. * @param maxRetries defines the maximum number of retries (3 by default)
  1379. * @param baseInterval defines the interval between retries
  1380. * @returns the strategy function to use
  1381. */
  1382. static ExponentialBackoff(maxRetries?: number, baseInterval?: number): (url: string, request: WebRequest, retryIndex: number) => number;
  1383. }
  1384. }
  1385. declare module "babylonjs/Misc/baseError" {
  1386. /**
  1387. * @ignore
  1388. * Application error to support additional information when loading a file
  1389. */
  1390. export abstract class BaseError extends Error {
  1391. protected static _setPrototypeOf: (o: any, proto: object | null) => any;
  1392. }
  1393. }
  1394. declare module "babylonjs/Misc/fileTools" {
  1395. import { WebRequest } from "babylonjs/Misc/webRequest";
  1396. import { Nullable } from "babylonjs/types";
  1397. import { IOfflineProvider } from "babylonjs/Offline/IOfflineProvider";
  1398. import { IFileRequest } from "babylonjs/Misc/fileRequest";
  1399. import { BaseError } from "babylonjs/Misc/baseError";
  1400. /** @ignore */
  1401. export class LoadFileError extends BaseError {
  1402. request?: WebRequest;
  1403. file?: File;
  1404. /**
  1405. * Creates a new LoadFileError
  1406. * @param message defines the message of the error
  1407. * @param request defines the optional web request
  1408. * @param file defines the optional file
  1409. */
  1410. constructor(message: string, object?: WebRequest | File);
  1411. }
  1412. /** @ignore */
  1413. export class RequestFileError extends BaseError {
  1414. request: WebRequest;
  1415. /**
  1416. * Creates a new LoadFileError
  1417. * @param message defines the message of the error
  1418. * @param request defines the optional web request
  1419. */
  1420. constructor(message: string, request: WebRequest);
  1421. }
  1422. /** @ignore */
  1423. export class ReadFileError extends BaseError {
  1424. file: File;
  1425. /**
  1426. * Creates a new ReadFileError
  1427. * @param message defines the message of the error
  1428. * @param file defines the optional file
  1429. */
  1430. constructor(message: string, file: File);
  1431. }
  1432. /**
  1433. * @hidden
  1434. */
  1435. export class FileTools {
  1436. /**
  1437. * Gets or sets the retry strategy to apply when an error happens while loading an asset
  1438. */
  1439. static DefaultRetryStrategy: (url: string, request: WebRequest, retryIndex: number) => number;
  1440. /**
  1441. * Gets or sets the base URL to use to load assets
  1442. */
  1443. static BaseUrl: string;
  1444. /**
  1445. * Default behaviour for cors in the application.
  1446. * It can be a string if the expected behavior is identical in the entire app.
  1447. * Or a callback to be able to set it per url or on a group of them (in case of Video source for instance)
  1448. */
  1449. static CorsBehavior: string | ((url: string | string[]) => string);
  1450. /**
  1451. * Gets or sets a function used to pre-process url before using them to load assets
  1452. */
  1453. static PreprocessUrl: (url: string) => string;
  1454. /**
  1455. * Removes unwanted characters from an url
  1456. * @param url defines the url to clean
  1457. * @returns the cleaned url
  1458. */
  1459. private static _CleanUrl;
  1460. /**
  1461. * Sets the cors behavior on a dom element. This will add the required Tools.CorsBehavior to the element.
  1462. * @param url define the url we are trying
  1463. * @param element define the dom element where to configure the cors policy
  1464. */
  1465. static SetCorsBehavior(url: string | string[], element: {
  1466. crossOrigin: string | null;
  1467. }): void;
  1468. /**
  1469. * Loads an image as an HTMLImageElement.
  1470. * @param input url string, ArrayBuffer, or Blob to load
  1471. * @param onLoad callback called when the image successfully loads
  1472. * @param onError callback called when the image fails to load
  1473. * @param offlineProvider offline provider for caching
  1474. * @param mimeType optional mime type
  1475. * @returns the HTMLImageElement of the loaded image
  1476. */
  1477. 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>;
  1478. /**
  1479. * Reads a file from a File object
  1480. * @param file defines the file to load
  1481. * @param onSuccess defines the callback to call when data is loaded
  1482. * @param onProgress defines the callback to call during loading process
  1483. * @param useArrayBuffer defines a boolean indicating that data must be returned as an ArrayBuffer
  1484. * @param onError defines the callback to call when an error occurs
  1485. * @returns a file request object
  1486. */
  1487. static ReadFile(file: File, onSuccess: (data: any) => void, onProgress?: (ev: ProgressEvent) => any, useArrayBuffer?: boolean, onError?: (error: ReadFileError) => void): IFileRequest;
  1488. /**
  1489. * Loads a file from a url
  1490. * @param url url to load
  1491. * @param onSuccess callback called when the file successfully loads
  1492. * @param onProgress callback called while file is loading (if the server supports this mode)
  1493. * @param offlineProvider defines the offline provider for caching
  1494. * @param useArrayBuffer defines a boolean indicating that date must be returned as ArrayBuffer
  1495. * @param onError callback called when the file fails to load
  1496. * @returns a file request object
  1497. */
  1498. 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;
  1499. /**
  1500. * Loads a file
  1501. * @param url url to load
  1502. * @param onSuccess callback called when the file successfully loads
  1503. * @param onProgress callback called while file is loading (if the server supports this mode)
  1504. * @param useArrayBuffer defines a boolean indicating that date must be returned as ArrayBuffer
  1505. * @param onError callback called when the file fails to load
  1506. * @param onOpened callback called when the web request is opened
  1507. * @returns a file request object
  1508. */
  1509. 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;
  1510. /**
  1511. * Checks if the loaded document was accessed via `file:`-Protocol.
  1512. * @returns boolean
  1513. */
  1514. static IsFileURL(): boolean;
  1515. }
  1516. }
  1517. declare module "babylonjs/Engines/Processors/shaderProcessor" {
  1518. import { ProcessingOptions } from "babylonjs/Engines/Processors/shaderProcessingOptions";
  1519. import { WebRequest } from "babylonjs/Misc/webRequest";
  1520. import { LoadFileError } from "babylonjs/Misc/fileTools";
  1521. import { IOfflineProvider } from "babylonjs/Offline/IOfflineProvider";
  1522. import { IFileRequest } from "babylonjs/Misc/fileRequest";
  1523. /** @hidden */
  1524. export class ShaderProcessor {
  1525. static Process(sourceCode: string, options: ProcessingOptions, callback: (migratedCode: string) => void): void;
  1526. private static _ProcessPrecision;
  1527. private static _ExtractOperation;
  1528. private static _BuildSubExpression;
  1529. private static _BuildExpression;
  1530. private static _MoveCursorWithinIf;
  1531. private static _MoveCursor;
  1532. private static _EvaluatePreProcessors;
  1533. private static _PreparePreProcessors;
  1534. private static _ProcessShaderConversion;
  1535. private static _ProcessIncludes;
  1536. /**
  1537. * Loads a file from a url
  1538. * @param url url to load
  1539. * @param onSuccess callback called when the file successfully loads
  1540. * @param onProgress callback called while file is loading (if the server supports this mode)
  1541. * @param offlineProvider defines the offline provider for caching
  1542. * @param useArrayBuffer defines a boolean indicating that date must be returned as ArrayBuffer
  1543. * @param onError callback called when the file fails to load
  1544. * @returns a file request object
  1545. * @hidden
  1546. */
  1547. 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;
  1548. }
  1549. }
  1550. declare module "babylonjs/Maths/math.like" {
  1551. import { float, int, DeepImmutable } from "babylonjs/types";
  1552. /**
  1553. * @hidden
  1554. */
  1555. export interface IColor4Like {
  1556. r: float;
  1557. g: float;
  1558. b: float;
  1559. a: float;
  1560. }
  1561. /**
  1562. * @hidden
  1563. */
  1564. export interface IColor3Like {
  1565. r: float;
  1566. g: float;
  1567. b: float;
  1568. }
  1569. /**
  1570. * @hidden
  1571. */
  1572. export interface IVector4Like {
  1573. x: float;
  1574. y: float;
  1575. z: float;
  1576. w: float;
  1577. }
  1578. /**
  1579. * @hidden
  1580. */
  1581. export interface IVector3Like {
  1582. x: float;
  1583. y: float;
  1584. z: float;
  1585. }
  1586. /**
  1587. * @hidden
  1588. */
  1589. export interface IVector2Like {
  1590. x: float;
  1591. y: float;
  1592. }
  1593. /**
  1594. * @hidden
  1595. */
  1596. export interface IMatrixLike {
  1597. toArray(): DeepImmutable<Float32Array | Array<number>>;
  1598. updateFlag: int;
  1599. }
  1600. /**
  1601. * @hidden
  1602. */
  1603. export interface IViewportLike {
  1604. x: float;
  1605. y: float;
  1606. width: float;
  1607. height: float;
  1608. }
  1609. /**
  1610. * @hidden
  1611. */
  1612. export interface IPlaneLike {
  1613. normal: IVector3Like;
  1614. d: float;
  1615. normalize(): void;
  1616. }
  1617. }
  1618. declare module "babylonjs/Materials/iEffectFallbacks" {
  1619. import { Effect } from "babylonjs/Materials/effect";
  1620. /**
  1621. * Interface used to define common properties for effect fallbacks
  1622. */
  1623. export interface IEffectFallbacks {
  1624. /**
  1625. * Removes the defines that should be removed when falling back.
  1626. * @param currentDefines defines the current define statements for the shader.
  1627. * @param effect defines the current effect we try to compile
  1628. * @returns The resulting defines with defines of the current rank removed.
  1629. */
  1630. reduce(currentDefines: string, effect: Effect): string;
  1631. /**
  1632. * Removes the fallback from the bound mesh.
  1633. */
  1634. unBindMesh(): void;
  1635. /**
  1636. * Checks to see if more fallbacks are still availible.
  1637. */
  1638. hasMoreFallbacks: boolean;
  1639. }
  1640. }
  1641. declare module "babylonjs/Misc/andOrNotEvaluator" {
  1642. /**
  1643. * Class used to evalaute queries containing `and` and `or` operators
  1644. */
  1645. export class AndOrNotEvaluator {
  1646. /**
  1647. * Evaluate a query
  1648. * @param query defines the query to evaluate
  1649. * @param evaluateCallback defines the callback used to filter result
  1650. * @returns true if the query matches
  1651. */
  1652. static Eval(query: string, evaluateCallback: (val: any) => boolean): boolean;
  1653. private static _HandleParenthesisContent;
  1654. private static _SimplifyNegation;
  1655. }
  1656. }
  1657. declare module "babylonjs/Misc/tags" {
  1658. /**
  1659. * Class used to store custom tags
  1660. */
  1661. export class Tags {
  1662. /**
  1663. * Adds support for tags on the given object
  1664. * @param obj defines the object to use
  1665. */
  1666. static EnableFor(obj: any): void;
  1667. /**
  1668. * Removes tags support
  1669. * @param obj defines the object to use
  1670. */
  1671. static DisableFor(obj: any): void;
  1672. /**
  1673. * Gets a boolean indicating if the given object has tags
  1674. * @param obj defines the object to use
  1675. * @returns a boolean
  1676. */
  1677. static HasTags(obj: any): boolean;
  1678. /**
  1679. * Gets the tags available on a given object
  1680. * @param obj defines the object to use
  1681. * @param asString defines if the tags must be returned as a string instead of an array of strings
  1682. * @returns the tags
  1683. */
  1684. static GetTags(obj: any, asString?: boolean): any;
  1685. /**
  1686. * Adds tags to an object
  1687. * @param obj defines the object to use
  1688. * @param tagsString defines the tag string. The tags 'true' and 'false' are reserved and cannot be used as tags.
  1689. * A tag cannot start with '||', '&&', and '!'. It cannot contain whitespaces
  1690. */
  1691. static AddTagsTo(obj: any, tagsString: string): void;
  1692. /**
  1693. * @hidden
  1694. */
  1695. static _AddTagTo(obj: any, tag: string): void;
  1696. /**
  1697. * Removes specific tags from a specific object
  1698. * @param obj defines the object to use
  1699. * @param tagsString defines the tags to remove
  1700. */
  1701. static RemoveTagsFrom(obj: any, tagsString: string): void;
  1702. /**
  1703. * @hidden
  1704. */
  1705. static _RemoveTagFrom(obj: any, tag: string): void;
  1706. /**
  1707. * Defines if tags hosted on an object match a given query
  1708. * @param obj defines the object to use
  1709. * @param tagsQuery defines the tag query
  1710. * @returns a boolean
  1711. */
  1712. static MatchesQuery(obj: any, tagsQuery: string): boolean;
  1713. }
  1714. }
  1715. declare module "babylonjs/Maths/math.scalar" {
  1716. /**
  1717. * Scalar computation library
  1718. */
  1719. export class Scalar {
  1720. /**
  1721. * Two pi constants convenient for computation.
  1722. */
  1723. static TwoPi: number;
  1724. /**
  1725. * Boolean : true if the absolute difference between a and b is lower than epsilon (default = 1.401298E-45)
  1726. * @param a number
  1727. * @param b number
  1728. * @param epsilon (default = 1.401298E-45)
  1729. * @returns true if the absolute difference between a and b is lower than epsilon (default = 1.401298E-45)
  1730. */
  1731. static WithinEpsilon(a: number, b: number, epsilon?: number): boolean;
  1732. /**
  1733. * Returns a string : the upper case translation of the number i to hexadecimal.
  1734. * @param i number
  1735. * @returns the upper case translation of the number i to hexadecimal.
  1736. */
  1737. static ToHex(i: number): string;
  1738. /**
  1739. * Returns -1 if value is negative and +1 is value is positive.
  1740. * @param value the value
  1741. * @returns the value itself if it's equal to zero.
  1742. */
  1743. static Sign(value: number): number;
  1744. /**
  1745. * Returns the value itself if it's between min and max.
  1746. * Returns min if the value is lower than min.
  1747. * Returns max if the value is greater than max.
  1748. * @param value the value to clmap
  1749. * @param min the min value to clamp to (default: 0)
  1750. * @param max the max value to clamp to (default: 1)
  1751. * @returns the clamped value
  1752. */
  1753. static Clamp(value: number, min?: number, max?: number): number;
  1754. /**
  1755. * the log2 of value.
  1756. * @param value the value to compute log2 of
  1757. * @returns the log2 of value.
  1758. */
  1759. static Log2(value: number): number;
  1760. /**
  1761. * Loops the value, so that it is never larger than length and never smaller than 0.
  1762. *
  1763. * This is similar to the modulo operator but it works with floating point numbers.
  1764. * For example, using 3.0 for t and 2.5 for length, the result would be 0.5.
  1765. * With t = 5 and length = 2.5, the result would be 0.0.
  1766. * Note, however, that the behaviour is not defined for negative numbers as it is for the modulo operator
  1767. * @param value the value
  1768. * @param length the length
  1769. * @returns the looped value
  1770. */
  1771. static Repeat(value: number, length: number): number;
  1772. /**
  1773. * Normalize the value between 0.0 and 1.0 using min and max values
  1774. * @param value value to normalize
  1775. * @param min max to normalize between
  1776. * @param max min to normalize between
  1777. * @returns the normalized value
  1778. */
  1779. static Normalize(value: number, min: number, max: number): number;
  1780. /**
  1781. * Denormalize the value from 0.0 and 1.0 using min and max values
  1782. * @param normalized value to denormalize
  1783. * @param min max to denormalize between
  1784. * @param max min to denormalize between
  1785. * @returns the denormalized value
  1786. */
  1787. static Denormalize(normalized: number, min: number, max: number): number;
  1788. /**
  1789. * Calculates the shortest difference between two given angles given in degrees.
  1790. * @param current current angle in degrees
  1791. * @param target target angle in degrees
  1792. * @returns the delta
  1793. */
  1794. static DeltaAngle(current: number, target: number): number;
  1795. /**
  1796. * PingPongs the value t, so that it is never larger than length and never smaller than 0.
  1797. * @param tx value
  1798. * @param length length
  1799. * @returns The returned value will move back and forth between 0 and length
  1800. */
  1801. static PingPong(tx: number, length: number): number;
  1802. /**
  1803. * Interpolates between min and max with smoothing at the limits.
  1804. *
  1805. * This function interpolates between min and max in a similar way to Lerp. However, the interpolation will gradually speed up
  1806. * from the start and slow down toward the end. This is useful for creating natural-looking animation, fading and other transitions.
  1807. * @param from from
  1808. * @param to to
  1809. * @param tx value
  1810. * @returns the smooth stepped value
  1811. */
  1812. static SmoothStep(from: number, to: number, tx: number): number;
  1813. /**
  1814. * Moves a value current towards target.
  1815. *
  1816. * This is essentially the same as Mathf.Lerp but instead the function will ensure that the speed never exceeds maxDelta.
  1817. * Negative values of maxDelta pushes the value away from target.
  1818. * @param current current value
  1819. * @param target target value
  1820. * @param maxDelta max distance to move
  1821. * @returns resulting value
  1822. */
  1823. static MoveTowards(current: number, target: number, maxDelta: number): number;
  1824. /**
  1825. * Same as MoveTowards but makes sure the values interpolate correctly when they wrap around 360 degrees.
  1826. *
  1827. * Variables current and target are assumed to be in degrees. For optimization reasons, negative values of maxDelta
  1828. * are not supported and may cause oscillation. To push current away from a target angle, add 180 to that angle instead.
  1829. * @param current current value
  1830. * @param target target value
  1831. * @param maxDelta max distance to move
  1832. * @returns resulting angle
  1833. */
  1834. static MoveTowardsAngle(current: number, target: number, maxDelta: number): number;
  1835. /**
  1836. * Creates a new scalar with values linearly interpolated of "amount" between the start scalar and the end scalar.
  1837. * @param start start value
  1838. * @param end target value
  1839. * @param amount amount to lerp between
  1840. * @returns the lerped value
  1841. */
  1842. static Lerp(start: number, end: number, amount: number): number;
  1843. /**
  1844. * Same as Lerp but makes sure the values interpolate correctly when they wrap around 360 degrees.
  1845. * The parameter t is clamped to the range [0, 1]. Variables a and b are assumed to be in degrees.
  1846. * @param start start value
  1847. * @param end target value
  1848. * @param amount amount to lerp between
  1849. * @returns the lerped value
  1850. */
  1851. static LerpAngle(start: number, end: number, amount: number): number;
  1852. /**
  1853. * Calculates the linear parameter t that produces the interpolant value within the range [a, b].
  1854. * @param a start value
  1855. * @param b target value
  1856. * @param value value between a and b
  1857. * @returns the inverseLerp value
  1858. */
  1859. static InverseLerp(a: number, b: number, value: number): number;
  1860. /**
  1861. * Returns a new scalar located for "amount" (float) on the Hermite spline defined by the scalars "value1", "value3", "tangent1", "tangent2".
  1862. * @see http://mathworld.wolfram.com/HermitePolynomial.html
  1863. * @param value1 spline value
  1864. * @param tangent1 spline value
  1865. * @param value2 spline value
  1866. * @param tangent2 spline value
  1867. * @param amount input value
  1868. * @returns hermite result
  1869. */
  1870. static Hermite(value1: number, tangent1: number, value2: number, tangent2: number, amount: number): number;
  1871. /**
  1872. * Returns a random float number between and min and max values
  1873. * @param min min value of random
  1874. * @param max max value of random
  1875. * @returns random value
  1876. */
  1877. static RandomRange(min: number, max: number): number;
  1878. /**
  1879. * This function returns percentage of a number in a given range.
  1880. *
  1881. * RangeToPercent(40,20,60) will return 0.5 (50%)
  1882. * RangeToPercent(34,0,100) will return 0.34 (34%)
  1883. * @param number to convert to percentage
  1884. * @param min min range
  1885. * @param max max range
  1886. * @returns the percentage
  1887. */
  1888. static RangeToPercent(number: number, min: number, max: number): number;
  1889. /**
  1890. * This function returns number that corresponds to the percentage in a given range.
  1891. *
  1892. * PercentToRange(0.34,0,100) will return 34.
  1893. * @param percent to convert to number
  1894. * @param min min range
  1895. * @param max max range
  1896. * @returns the number
  1897. */
  1898. static PercentToRange(percent: number, min: number, max: number): number;
  1899. /**
  1900. * Returns the angle converted to equivalent value between -Math.PI and Math.PI radians.
  1901. * @param angle The angle to normalize in radian.
  1902. * @return The converted angle.
  1903. */
  1904. static NormalizeRadians(angle: number): number;
  1905. }
  1906. }
  1907. declare module "babylonjs/Maths/math.constants" {
  1908. /**
  1909. * Constant used to convert a value to gamma space
  1910. * @ignorenaming
  1911. */
  1912. export const ToGammaSpace: number;
  1913. /**
  1914. * Constant used to convert a value to linear space
  1915. * @ignorenaming
  1916. */
  1917. export const ToLinearSpace = 2.2;
  1918. /**
  1919. * Constant used to define the minimal number value in Babylon.js
  1920. * @ignorenaming
  1921. */
  1922. let Epsilon: number;
  1923. export { Epsilon };
  1924. }
  1925. declare module "babylonjs/Maths/math.viewport" {
  1926. /**
  1927. * Class used to represent a viewport on screen
  1928. */
  1929. export class Viewport {
  1930. /** viewport left coordinate */
  1931. x: number;
  1932. /** viewport top coordinate */
  1933. y: number;
  1934. /**viewport width */
  1935. width: number;
  1936. /** viewport height */
  1937. height: number;
  1938. /**
  1939. * Creates a Viewport object located at (x, y) and sized (width, height)
  1940. * @param x defines viewport left coordinate
  1941. * @param y defines viewport top coordinate
  1942. * @param width defines the viewport width
  1943. * @param height defines the viewport height
  1944. */
  1945. constructor(
  1946. /** viewport left coordinate */
  1947. x: number,
  1948. /** viewport top coordinate */
  1949. y: number,
  1950. /**viewport width */
  1951. width: number,
  1952. /** viewport height */
  1953. height: number);
  1954. /**
  1955. * Creates a new viewport using absolute sizing (from 0-> width, 0-> height instead of 0->1)
  1956. * @param renderWidth defines the rendering width
  1957. * @param renderHeight defines the rendering height
  1958. * @returns a new Viewport
  1959. */
  1960. toGlobal(renderWidth: number, renderHeight: number): Viewport;
  1961. /**
  1962. * Stores absolute viewport value into a target viewport (from 0-> width, 0-> height instead of 0->1)
  1963. * @param renderWidth defines the rendering width
  1964. * @param renderHeight defines the rendering height
  1965. * @param ref defines the target viewport
  1966. * @returns the current viewport
  1967. */
  1968. toGlobalToRef(renderWidth: number, renderHeight: number, ref: Viewport): Viewport;
  1969. /**
  1970. * Returns a new Viewport copied from the current one
  1971. * @returns a new Viewport
  1972. */
  1973. clone(): Viewport;
  1974. }
  1975. }
  1976. declare module "babylonjs/Misc/arrayTools" {
  1977. /**
  1978. * Class containing a set of static utilities functions for arrays.
  1979. */
  1980. export class ArrayTools {
  1981. /**
  1982. * Returns an array of the given size filled with element built from the given constructor and the paramters
  1983. * @param size the number of element to construct and put in the array
  1984. * @param itemBuilder a callback responsible for creating new instance of item. Called once per array entry.
  1985. * @returns a new array filled with new objects
  1986. */
  1987. static BuildArray<T>(size: number, itemBuilder: () => T): Array<T>;
  1988. }
  1989. }
  1990. declare module "babylonjs/Maths/math.plane" {
  1991. import { DeepImmutable } from "babylonjs/types";
  1992. import { Vector3, Matrix } from "babylonjs/Maths/math.vector";
  1993. /**
  1994. * Represents a plane by the equation ax + by + cz + d = 0
  1995. */
  1996. export class Plane {
  1997. private static _TmpMatrix;
  1998. /**
  1999. * Normal of the plane (a,b,c)
  2000. */
  2001. normal: Vector3;
  2002. /**
  2003. * d component of the plane
  2004. */
  2005. d: number;
  2006. /**
  2007. * Creates a Plane object according to the given floats a, b, c, d and the plane equation : ax + by + cz + d = 0
  2008. * @param a a component of the plane
  2009. * @param b b component of the plane
  2010. * @param c c component of the plane
  2011. * @param d d component of the plane
  2012. */
  2013. constructor(a: number, b: number, c: number, d: number);
  2014. /**
  2015. * @returns the plane coordinates as a new array of 4 elements [a, b, c, d].
  2016. */
  2017. asArray(): number[];
  2018. /**
  2019. * @returns a new plane copied from the current Plane.
  2020. */
  2021. clone(): Plane;
  2022. /**
  2023. * @returns the string "Plane".
  2024. */
  2025. getClassName(): string;
  2026. /**
  2027. * @returns the Plane hash code.
  2028. */
  2029. getHashCode(): number;
  2030. /**
  2031. * Normalize the current Plane in place.
  2032. * @returns the updated Plane.
  2033. */
  2034. normalize(): Plane;
  2035. /**
  2036. * Applies a transformation the plane and returns the result
  2037. * @param transformation the transformation matrix to be applied to the plane
  2038. * @returns a new Plane as the result of the transformation of the current Plane by the given matrix.
  2039. */
  2040. transform(transformation: DeepImmutable<Matrix>): Plane;
  2041. /**
  2042. * Compute the dot product between the point and the plane normal
  2043. * @param point point to calculate the dot product with
  2044. * @returns the dot product (float) of the point coordinates and the plane normal.
  2045. */
  2046. dotCoordinate(point: DeepImmutable<Vector3>): number;
  2047. /**
  2048. * Updates the current Plane from the plane defined by the three given points.
  2049. * @param point1 one of the points used to contruct the plane
  2050. * @param point2 one of the points used to contruct the plane
  2051. * @param point3 one of the points used to contruct the plane
  2052. * @returns the updated Plane.
  2053. */
  2054. copyFromPoints(point1: DeepImmutable<Vector3>, point2: DeepImmutable<Vector3>, point3: DeepImmutable<Vector3>): Plane;
  2055. /**
  2056. * Checks if the plane is facing a given direction
  2057. * @param direction the direction to check if the plane is facing
  2058. * @param epsilon value the dot product is compared against (returns true if dot <= epsilon)
  2059. * @returns True is the vector "direction" is the same side than the plane normal.
  2060. */
  2061. isFrontFacingTo(direction: DeepImmutable<Vector3>, epsilon: number): boolean;
  2062. /**
  2063. * Calculates the distance to a point
  2064. * @param point point to calculate distance to
  2065. * @returns the signed distance (float) from the given point to the Plane.
  2066. */
  2067. signedDistanceTo(point: DeepImmutable<Vector3>): number;
  2068. /**
  2069. * Creates a plane from an array
  2070. * @param array the array to create a plane from
  2071. * @returns a new Plane from the given array.
  2072. */
  2073. static FromArray(array: DeepImmutable<ArrayLike<number>>): Plane;
  2074. /**
  2075. * Creates a plane from three points
  2076. * @param point1 point used to create the plane
  2077. * @param point2 point used to create the plane
  2078. * @param point3 point used to create the plane
  2079. * @returns a new Plane defined by the three given points.
  2080. */
  2081. static FromPoints(point1: DeepImmutable<Vector3>, point2: DeepImmutable<Vector3>, point3: DeepImmutable<Vector3>): Plane;
  2082. /**
  2083. * Creates a plane from an origin point and a normal
  2084. * @param origin origin of the plane to be constructed
  2085. * @param normal normal of the plane to be constructed
  2086. * @returns a new Plane the normal vector to this plane at the given origin point.
  2087. * Note : the vector "normal" is updated because normalized.
  2088. */
  2089. static FromPositionAndNormal(origin: DeepImmutable<Vector3>, normal: Vector3): Plane;
  2090. /**
  2091. * Calculates the distance from a plane and a point
  2092. * @param origin origin of the plane to be constructed
  2093. * @param normal normal of the plane to be constructed
  2094. * @param point point to calculate distance to
  2095. * @returns the signed distance between the plane defined by the normal vector at the "origin"" point and the given other point.
  2096. */
  2097. static SignedDistanceToPlaneFromPositionAndNormal(origin: DeepImmutable<Vector3>, normal: DeepImmutable<Vector3>, point: DeepImmutable<Vector3>): number;
  2098. }
  2099. }
  2100. declare module "babylonjs/Engines/performanceConfigurator" {
  2101. /** @hidden */
  2102. export class PerformanceConfigurator {
  2103. /** @hidden */
  2104. static MatrixUse64Bits: boolean;
  2105. /** @hidden */
  2106. static MatrixTrackPrecisionChange: boolean;
  2107. /** @hidden */
  2108. static MatrixCurrentType: any;
  2109. /** @hidden */
  2110. static MatrixTrackedMatrices: Array<any> | null;
  2111. /** @hidden */
  2112. static SetMatrixPrecision(use64bits: boolean): void;
  2113. }
  2114. }
  2115. declare module "babylonjs/Maths/math.vector" {
  2116. import { Viewport } from "babylonjs/Maths/math.viewport";
  2117. import { DeepImmutable, Nullable, FloatArray, float } from "babylonjs/types";
  2118. import { IPlaneLike } from "babylonjs/Maths/math.like";
  2119. import { Plane } from "babylonjs/Maths/math.plane";
  2120. /**
  2121. * Class representing a vector containing 2 coordinates
  2122. */
  2123. export class Vector2 {
  2124. /** defines the first coordinate */
  2125. x: number;
  2126. /** defines the second coordinate */
  2127. y: number;
  2128. /**
  2129. * Creates a new Vector2 from the given x and y coordinates
  2130. * @param x defines the first coordinate
  2131. * @param y defines the second coordinate
  2132. */
  2133. constructor(
  2134. /** defines the first coordinate */
  2135. x?: number,
  2136. /** defines the second coordinate */
  2137. y?: number);
  2138. /**
  2139. * Gets a string with the Vector2 coordinates
  2140. * @returns a string with the Vector2 coordinates
  2141. */
  2142. toString(): string;
  2143. /**
  2144. * Gets class name
  2145. * @returns the string "Vector2"
  2146. */
  2147. getClassName(): string;
  2148. /**
  2149. * Gets current vector hash code
  2150. * @returns the Vector2 hash code as a number
  2151. */
  2152. getHashCode(): number;
  2153. /**
  2154. * Sets the Vector2 coordinates in the given array or Float32Array from the given index.
  2155. * @param array defines the source array
  2156. * @param index defines the offset in source array
  2157. * @returns the current Vector2
  2158. */
  2159. toArray(array: FloatArray, index?: number): Vector2;
  2160. /**
  2161. * Update the current vector from an array
  2162. * @param array defines the destination array
  2163. * @param index defines the offset in the destination array
  2164. * @returns the current Vector3
  2165. */
  2166. fromArray(array: FloatArray, index?: number): Vector2;
  2167. /**
  2168. * Copy the current vector to an array
  2169. * @returns a new array with 2 elements: the Vector2 coordinates.
  2170. */
  2171. asArray(): number[];
  2172. /**
  2173. * Sets the Vector2 coordinates with the given Vector2 coordinates
  2174. * @param source defines the source Vector2
  2175. * @returns the current updated Vector2
  2176. */
  2177. copyFrom(source: DeepImmutable<Vector2>): Vector2;
  2178. /**
  2179. * Sets the Vector2 coordinates with the given floats
  2180. * @param x defines the first coordinate
  2181. * @param y defines the second coordinate
  2182. * @returns the current updated Vector2
  2183. */
  2184. copyFromFloats(x: number, y: number): Vector2;
  2185. /**
  2186. * Sets the Vector2 coordinates with the given floats
  2187. * @param x defines the first coordinate
  2188. * @param y defines the second coordinate
  2189. * @returns the current updated Vector2
  2190. */
  2191. set(x: number, y: number): Vector2;
  2192. /**
  2193. * Add another vector with the current one
  2194. * @param otherVector defines the other vector
  2195. * @returns a new Vector2 set with the addition of the current Vector2 and the given one coordinates
  2196. */
  2197. add(otherVector: DeepImmutable<Vector2>): Vector2;
  2198. /**
  2199. * Sets the "result" coordinates with the addition of the current Vector2 and the given one coordinates
  2200. * @param otherVector defines the other vector
  2201. * @param result defines the target vector
  2202. * @returns the unmodified current Vector2
  2203. */
  2204. addToRef(otherVector: DeepImmutable<Vector2>, result: Vector2): Vector2;
  2205. /**
  2206. * Set the Vector2 coordinates by adding the given Vector2 coordinates
  2207. * @param otherVector defines the other vector
  2208. * @returns the current updated Vector2
  2209. */
  2210. addInPlace(otherVector: DeepImmutable<Vector2>): Vector2;
  2211. /**
  2212. * Gets a new Vector2 by adding the current Vector2 coordinates to the given Vector3 x, y coordinates
  2213. * @param otherVector defines the other vector
  2214. * @returns a new Vector2
  2215. */
  2216. addVector3(otherVector: Vector3): Vector2;
  2217. /**
  2218. * Gets a new Vector2 set with the subtracted coordinates of the given one from the current Vector2
  2219. * @param otherVector defines the other vector
  2220. * @returns a new Vector2
  2221. */
  2222. subtract(otherVector: Vector2): Vector2;
  2223. /**
  2224. * Sets the "result" coordinates with the subtraction of the given one from the current Vector2 coordinates.
  2225. * @param otherVector defines the other vector
  2226. * @param result defines the target vector
  2227. * @returns the unmodified current Vector2
  2228. */
  2229. subtractToRef(otherVector: DeepImmutable<Vector2>, result: Vector2): Vector2;
  2230. /**
  2231. * Sets the current Vector2 coordinates by subtracting from it the given one coordinates
  2232. * @param otherVector defines the other vector
  2233. * @returns the current updated Vector2
  2234. */
  2235. subtractInPlace(otherVector: DeepImmutable<Vector2>): Vector2;
  2236. /**
  2237. * Multiplies in place the current Vector2 coordinates by the given ones
  2238. * @param otherVector defines the other vector
  2239. * @returns the current updated Vector2
  2240. */
  2241. multiplyInPlace(otherVector: DeepImmutable<Vector2>): Vector2;
  2242. /**
  2243. * Returns a new Vector2 set with the multiplication of the current Vector2 and the given one coordinates
  2244. * @param otherVector defines the other vector
  2245. * @returns a new Vector2
  2246. */
  2247. multiply(otherVector: DeepImmutable<Vector2>): Vector2;
  2248. /**
  2249. * Sets "result" coordinates with the multiplication of the current Vector2 and the given one coordinates
  2250. * @param otherVector defines the other vector
  2251. * @param result defines the target vector
  2252. * @returns the unmodified current Vector2
  2253. */
  2254. multiplyToRef(otherVector: DeepImmutable<Vector2>, result: Vector2): Vector2;
  2255. /**
  2256. * Gets a new Vector2 set with the Vector2 coordinates multiplied by the given floats
  2257. * @param x defines the first coordinate
  2258. * @param y defines the second coordinate
  2259. * @returns a new Vector2
  2260. */
  2261. multiplyByFloats(x: number, y: number): Vector2;
  2262. /**
  2263. * Returns a new Vector2 set with the Vector2 coordinates divided by the given one coordinates
  2264. * @param otherVector defines the other vector
  2265. * @returns a new Vector2
  2266. */
  2267. divide(otherVector: Vector2): Vector2;
  2268. /**
  2269. * Sets the "result" coordinates with the Vector2 divided by the given one coordinates
  2270. * @param otherVector defines the other vector
  2271. * @param result defines the target vector
  2272. * @returns the unmodified current Vector2
  2273. */
  2274. divideToRef(otherVector: DeepImmutable<Vector2>, result: Vector2): Vector2;
  2275. /**
  2276. * Divides the current Vector2 coordinates by the given ones
  2277. * @param otherVector defines the other vector
  2278. * @returns the current updated Vector2
  2279. */
  2280. divideInPlace(otherVector: DeepImmutable<Vector2>): Vector2;
  2281. /**
  2282. * Gets a new Vector2 with current Vector2 negated coordinates
  2283. * @returns a new Vector2
  2284. */
  2285. negate(): Vector2;
  2286. /**
  2287. * Negate this vector in place
  2288. * @returns this
  2289. */
  2290. negateInPlace(): Vector2;
  2291. /**
  2292. * Negate the current Vector2 and stores the result in the given vector "result" coordinates
  2293. * @param result defines the Vector3 object where to store the result
  2294. * @returns the current Vector2
  2295. */
  2296. negateToRef(result: Vector2): Vector2;
  2297. /**
  2298. * Multiply the Vector2 coordinates by scale
  2299. * @param scale defines the scaling factor
  2300. * @returns the current updated Vector2
  2301. */
  2302. scaleInPlace(scale: number): Vector2;
  2303. /**
  2304. * Returns a new Vector2 scaled by "scale" from the current Vector2
  2305. * @param scale defines the scaling factor
  2306. * @returns a new Vector2
  2307. */
  2308. scale(scale: number): Vector2;
  2309. /**
  2310. * Scale the current Vector2 values by a factor to a given Vector2
  2311. * @param scale defines the scale factor
  2312. * @param result defines the Vector2 object where to store the result
  2313. * @returns the unmodified current Vector2
  2314. */
  2315. scaleToRef(scale: number, result: Vector2): Vector2;
  2316. /**
  2317. * Scale the current Vector2 values by a factor and add the result to a given Vector2
  2318. * @param scale defines the scale factor
  2319. * @param result defines the Vector2 object where to store the result
  2320. * @returns the unmodified current Vector2
  2321. */
  2322. scaleAndAddToRef(scale: number, result: Vector2): Vector2;
  2323. /**
  2324. * Gets a boolean if two vectors are equals
  2325. * @param otherVector defines the other vector
  2326. * @returns true if the given vector coordinates strictly equal the current Vector2 ones
  2327. */
  2328. equals(otherVector: DeepImmutable<Vector2>): boolean;
  2329. /**
  2330. * Gets a boolean if two vectors are equals (using an epsilon value)
  2331. * @param otherVector defines the other vector
  2332. * @param epsilon defines the minimal distance to consider equality
  2333. * @returns true if the given vector coordinates are close to the current ones by a distance of epsilon.
  2334. */
  2335. equalsWithEpsilon(otherVector: DeepImmutable<Vector2>, epsilon?: number): boolean;
  2336. /**
  2337. * Gets a new Vector2 from current Vector2 floored values
  2338. * @returns a new Vector2
  2339. */
  2340. floor(): Vector2;
  2341. /**
  2342. * Gets a new Vector2 from current Vector2 floored values
  2343. * @returns a new Vector2
  2344. */
  2345. fract(): Vector2;
  2346. /**
  2347. * Gets the length of the vector
  2348. * @returns the vector length (float)
  2349. */
  2350. length(): number;
  2351. /**
  2352. * Gets the vector squared length
  2353. * @returns the vector squared length (float)
  2354. */
  2355. lengthSquared(): number;
  2356. /**
  2357. * Normalize the vector
  2358. * @returns the current updated Vector2
  2359. */
  2360. normalize(): Vector2;
  2361. /**
  2362. * Gets a new Vector2 copied from the Vector2
  2363. * @returns a new Vector2
  2364. */
  2365. clone(): Vector2;
  2366. /**
  2367. * Gets a new Vector2(0, 0)
  2368. * @returns a new Vector2
  2369. */
  2370. static Zero(): Vector2;
  2371. /**
  2372. * Gets a new Vector2(1, 1)
  2373. * @returns a new Vector2
  2374. */
  2375. static One(): Vector2;
  2376. /**
  2377. * Gets a new Vector2 set from the given index element of the given array
  2378. * @param array defines the data source
  2379. * @param offset defines the offset in the data source
  2380. * @returns a new Vector2
  2381. */
  2382. static FromArray(array: DeepImmutable<ArrayLike<number>>, offset?: number): Vector2;
  2383. /**
  2384. * Sets "result" from the given index element of the given array
  2385. * @param array defines the data source
  2386. * @param offset defines the offset in the data source
  2387. * @param result defines the target vector
  2388. */
  2389. static FromArrayToRef(array: DeepImmutable<ArrayLike<number>>, offset: number, result: Vector2): void;
  2390. /**
  2391. * Gets a new Vector2 located for "amount" (float) on the CatmullRom spline defined by the given four Vector2
  2392. * @param value1 defines 1st point of control
  2393. * @param value2 defines 2nd point of control
  2394. * @param value3 defines 3rd point of control
  2395. * @param value4 defines 4th point of control
  2396. * @param amount defines the interpolation factor
  2397. * @returns a new Vector2
  2398. */
  2399. static CatmullRom(value1: DeepImmutable<Vector2>, value2: DeepImmutable<Vector2>, value3: DeepImmutable<Vector2>, value4: DeepImmutable<Vector2>, amount: number): Vector2;
  2400. /**
  2401. * 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".
  2402. * If a coordinate of "value" is lower than "min" coordinates, the returned Vector2 is given this "min" coordinate.
  2403. * If a coordinate of "value" is greater than "max" coordinates, the returned Vector2 is given this "max" coordinate
  2404. * @param value defines the value to clamp
  2405. * @param min defines the lower limit
  2406. * @param max defines the upper limit
  2407. * @returns a new Vector2
  2408. */
  2409. static Clamp(value: DeepImmutable<Vector2>, min: DeepImmutable<Vector2>, max: DeepImmutable<Vector2>): Vector2;
  2410. /**
  2411. * Returns a new Vector2 located for "amount" (float) on the Hermite spline defined by the vectors "value1", "value3", "tangent1", "tangent2"
  2412. * @param value1 defines the 1st control point
  2413. * @param tangent1 defines the outgoing tangent
  2414. * @param value2 defines the 2nd control point
  2415. * @param tangent2 defines the incoming tangent
  2416. * @param amount defines the interpolation factor
  2417. * @returns a new Vector2
  2418. */
  2419. static Hermite(value1: DeepImmutable<Vector2>, tangent1: DeepImmutable<Vector2>, value2: DeepImmutable<Vector2>, tangent2: DeepImmutable<Vector2>, amount: number): Vector2;
  2420. /**
  2421. * Returns a new Vector2 located for "amount" (float) on the linear interpolation between the vector "start" adn the vector "end".
  2422. * @param start defines the start vector
  2423. * @param end defines the end vector
  2424. * @param amount defines the interpolation factor
  2425. * @returns a new Vector2
  2426. */
  2427. static Lerp(start: DeepImmutable<Vector2>, end: DeepImmutable<Vector2>, amount: number): Vector2;
  2428. /**
  2429. * Gets the dot product of the vector "left" and the vector "right"
  2430. * @param left defines first vector
  2431. * @param right defines second vector
  2432. * @returns the dot product (float)
  2433. */
  2434. static Dot(left: DeepImmutable<Vector2>, right: DeepImmutable<Vector2>): number;
  2435. /**
  2436. * Returns a new Vector2 equal to the normalized given vector
  2437. * @param vector defines the vector to normalize
  2438. * @returns a new Vector2
  2439. */
  2440. static Normalize(vector: DeepImmutable<Vector2>): Vector2;
  2441. /**
  2442. * Gets a new Vector2 set with the minimal coordinate values from the "left" and "right" vectors
  2443. * @param left defines 1st vector
  2444. * @param right defines 2nd vector
  2445. * @returns a new Vector2
  2446. */
  2447. static Minimize(left: DeepImmutable<Vector2>, right: DeepImmutable<Vector2>): Vector2;
  2448. /**
  2449. * Gets a new Vecto2 set with the maximal coordinate values from the "left" and "right" vectors
  2450. * @param left defines 1st vector
  2451. * @param right defines 2nd vector
  2452. * @returns a new Vector2
  2453. */
  2454. static Maximize(left: DeepImmutable<Vector2>, right: DeepImmutable<Vector2>): Vector2;
  2455. /**
  2456. * Gets a new Vector2 set with the transformed coordinates of the given vector by the given transformation matrix
  2457. * @param vector defines the vector to transform
  2458. * @param transformation defines the matrix to apply
  2459. * @returns a new Vector2
  2460. */
  2461. static Transform(vector: DeepImmutable<Vector2>, transformation: DeepImmutable<Matrix>): Vector2;
  2462. /**
  2463. * Transforms the given vector coordinates by the given transformation matrix and stores the result in the vector "result" coordinates
  2464. * @param vector defines the vector to transform
  2465. * @param transformation defines the matrix to apply
  2466. * @param result defines the target vector
  2467. */
  2468. static TransformToRef(vector: DeepImmutable<Vector2>, transformation: DeepImmutable<Matrix>, result: Vector2): void;
  2469. /**
  2470. * Determines if a given vector is included in a triangle
  2471. * @param p defines the vector to test
  2472. * @param p0 defines 1st triangle point
  2473. * @param p1 defines 2nd triangle point
  2474. * @param p2 defines 3rd triangle point
  2475. * @returns true if the point "p" is in the triangle defined by the vertors "p0", "p1", "p2"
  2476. */
  2477. static PointInTriangle(p: DeepImmutable<Vector2>, p0: DeepImmutable<Vector2>, p1: DeepImmutable<Vector2>, p2: DeepImmutable<Vector2>): boolean;
  2478. /**
  2479. * Gets the distance between the vectors "value1" and "value2"
  2480. * @param value1 defines first vector
  2481. * @param value2 defines second vector
  2482. * @returns the distance between vectors
  2483. */
  2484. static Distance(value1: DeepImmutable<Vector2>, value2: DeepImmutable<Vector2>): number;
  2485. /**
  2486. * Returns the squared distance between the vectors "value1" and "value2"
  2487. * @param value1 defines first vector
  2488. * @param value2 defines second vector
  2489. * @returns the squared distance between vectors
  2490. */
  2491. static DistanceSquared(value1: DeepImmutable<Vector2>, value2: DeepImmutable<Vector2>): number;
  2492. /**
  2493. * Gets a new Vector2 located at the center of the vectors "value1" and "value2"
  2494. * @param value1 defines first vector
  2495. * @param value2 defines second vector
  2496. * @returns a new Vector2
  2497. */
  2498. static Center(value1: DeepImmutable<Vector2>, value2: DeepImmutable<Vector2>): Vector2;
  2499. /**
  2500. * Gets the shortest distance (float) between the point "p" and the segment defined by the two points "segA" and "segB".
  2501. * @param p defines the middle point
  2502. * @param segA defines one point of the segment
  2503. * @param segB defines the other point of the segment
  2504. * @returns the shortest distance
  2505. */
  2506. static DistanceOfPointFromSegment(p: DeepImmutable<Vector2>, segA: DeepImmutable<Vector2>, segB: DeepImmutable<Vector2>): number;
  2507. }
  2508. /**
  2509. * Class used to store (x,y,z) vector representation
  2510. * A Vector3 is the main object used in 3D geometry
  2511. * It can represent etiher the coordinates of a point the space, either a direction
  2512. * Reminder: js uses a left handed forward facing system
  2513. */
  2514. export class Vector3 {
  2515. private static _UpReadOnly;
  2516. private static _ZeroReadOnly;
  2517. /** @hidden */
  2518. _x: number;
  2519. /** @hidden */
  2520. _y: number;
  2521. /** @hidden */
  2522. _z: number;
  2523. /** @hidden */
  2524. _isDirty: boolean;
  2525. /** Gets or sets the x coordinate */
  2526. get x(): number;
  2527. set x(value: number);
  2528. /** Gets or sets the y coordinate */
  2529. get y(): number;
  2530. set y(value: number);
  2531. /** Gets or sets the z coordinate */
  2532. get z(): number;
  2533. set z(value: number);
  2534. /**
  2535. * Creates a new Vector3 object from the given x, y, z (floats) coordinates.
  2536. * @param x defines the first coordinates (on X axis)
  2537. * @param y defines the second coordinates (on Y axis)
  2538. * @param z defines the third coordinates (on Z axis)
  2539. */
  2540. constructor(x?: number, y?: number, z?: number);
  2541. /**
  2542. * Creates a string representation of the Vector3
  2543. * @returns a string with the Vector3 coordinates.
  2544. */
  2545. toString(): string;
  2546. /**
  2547. * Gets the class name
  2548. * @returns the string "Vector3"
  2549. */
  2550. getClassName(): string;
  2551. /**
  2552. * Creates the Vector3 hash code
  2553. * @returns a number which tends to be unique between Vector3 instances
  2554. */
  2555. getHashCode(): number;
  2556. /**
  2557. * Creates an array containing three elements : the coordinates of the Vector3
  2558. * @returns a new array of numbers
  2559. */
  2560. asArray(): number[];
  2561. /**
  2562. * Populates the given array or Float32Array from the given index with the successive coordinates of the Vector3
  2563. * @param array defines the destination array
  2564. * @param index defines the offset in the destination array
  2565. * @returns the current Vector3
  2566. */
  2567. toArray(array: FloatArray, index?: number): Vector3;
  2568. /**
  2569. * Update the current vector from an array
  2570. * @param array defines the destination array
  2571. * @param index defines the offset in the destination array
  2572. * @returns the current Vector3
  2573. */
  2574. fromArray(array: FloatArray, index?: number): Vector3;
  2575. /**
  2576. * Converts the current Vector3 into a quaternion (considering that the Vector3 contains Euler angles representation of a rotation)
  2577. * @returns a new Quaternion object, computed from the Vector3 coordinates
  2578. */
  2579. toQuaternion(): Quaternion;
  2580. /**
  2581. * Adds the given vector to the current Vector3
  2582. * @param otherVector defines the second operand
  2583. * @returns the current updated Vector3
  2584. */
  2585. addInPlace(otherVector: DeepImmutable<Vector3>): Vector3;
  2586. /**
  2587. * Adds the given coordinates to the current Vector3
  2588. * @param x defines the x coordinate of the operand
  2589. * @param y defines the y coordinate of the operand
  2590. * @param z defines the z coordinate of the operand
  2591. * @returns the current updated Vector3
  2592. */
  2593. addInPlaceFromFloats(x: number, y: number, z: number): Vector3;
  2594. /**
  2595. * Gets a new Vector3, result of the addition the current Vector3 and the given vector
  2596. * @param otherVector defines the second operand
  2597. * @returns the resulting Vector3
  2598. */
  2599. add(otherVector: DeepImmutable<Vector3>): Vector3;
  2600. /**
  2601. * Adds the current Vector3 to the given one and stores the result in the vector "result"
  2602. * @param otherVector defines the second operand
  2603. * @param result defines the Vector3 object where to store the result
  2604. * @returns the current Vector3
  2605. */
  2606. addToRef(otherVector: DeepImmutable<Vector3>, result: Vector3): Vector3;
  2607. /**
  2608. * Subtract the given vector from the current Vector3
  2609. * @param otherVector defines the second operand
  2610. * @returns the current updated Vector3
  2611. */
  2612. subtractInPlace(otherVector: DeepImmutable<Vector3>): Vector3;
  2613. /**
  2614. * Returns a new Vector3, result of the subtraction of the given vector from the current Vector3
  2615. * @param otherVector defines the second operand
  2616. * @returns the resulting Vector3
  2617. */
  2618. subtract(otherVector: DeepImmutable<Vector3>): Vector3;
  2619. /**
  2620. * Subtracts the given vector from the current Vector3 and stores the result in the vector "result".
  2621. * @param otherVector defines the second operand
  2622. * @param result defines the Vector3 object where to store the result
  2623. * @returns the current Vector3
  2624. */
  2625. subtractToRef(otherVector: DeepImmutable<Vector3>, result: Vector3): Vector3;
  2626. /**
  2627. * Returns a new Vector3 set with the subtraction of the given floats from the current Vector3 coordinates
  2628. * @param x defines the x coordinate of the operand
  2629. * @param y defines the y coordinate of the operand
  2630. * @param z defines the z coordinate of the operand
  2631. * @returns the resulting Vector3
  2632. */
  2633. subtractFromFloats(x: number, y: number, z: number): Vector3;
  2634. /**
  2635. * Subtracts the given floats from the current Vector3 coordinates and set the given vector "result" with this result
  2636. * @param x defines the x coordinate of the operand
  2637. * @param y defines the y coordinate of the operand
  2638. * @param z defines the z coordinate of the operand
  2639. * @param result defines the Vector3 object where to store the result
  2640. * @returns the current Vector3
  2641. */
  2642. subtractFromFloatsToRef(x: number, y: number, z: number, result: Vector3): Vector3;
  2643. /**
  2644. * Gets a new Vector3 set with the current Vector3 negated coordinates
  2645. * @returns a new Vector3
  2646. */
  2647. negate(): Vector3;
  2648. /**
  2649. * Negate this vector in place
  2650. * @returns this
  2651. */
  2652. negateInPlace(): Vector3;
  2653. /**
  2654. * Negate the current Vector3 and stores the result in the given vector "result" coordinates
  2655. * @param result defines the Vector3 object where to store the result
  2656. * @returns the current Vector3
  2657. */
  2658. negateToRef(result: Vector3): Vector3;
  2659. /**
  2660. * Multiplies the Vector3 coordinates by the float "scale"
  2661. * @param scale defines the multiplier factor
  2662. * @returns the current updated Vector3
  2663. */
  2664. scaleInPlace(scale: number): Vector3;
  2665. /**
  2666. * Returns a new Vector3 set with the current Vector3 coordinates multiplied by the float "scale"
  2667. * @param scale defines the multiplier factor
  2668. * @returns a new Vector3
  2669. */
  2670. scale(scale: number): Vector3;
  2671. /**
  2672. * Multiplies the current Vector3 coordinates by the float "scale" and stores the result in the given vector "result" coordinates
  2673. * @param scale defines the multiplier factor
  2674. * @param result defines the Vector3 object where to store the result
  2675. * @returns the current Vector3
  2676. */
  2677. scaleToRef(scale: number, result: Vector3): Vector3;
  2678. /**
  2679. * Scale the current Vector3 values by a factor and add the result to a given Vector3
  2680. * @param scale defines the scale factor
  2681. * @param result defines the Vector3 object where to store the result
  2682. * @returns the unmodified current Vector3
  2683. */
  2684. scaleAndAddToRef(scale: number, result: Vector3): Vector3;
  2685. /**
  2686. * Projects the current vector3 to a plane along a ray starting from a specified origin and directed towards the point.
  2687. * @param origin defines the origin of the projection ray
  2688. * @param plane defines the plane to project to
  2689. * @returns the projected vector3
  2690. */
  2691. projectOnPlane(plane: Plane, origin: Vector3): Vector3;
  2692. /**
  2693. * Projects the current vector3 to a plane along a ray starting from a specified origin and directed towards the point.
  2694. * @param origin defines the origin of the projection ray
  2695. * @param plane defines the plane to project to
  2696. * @param result defines the Vector3 where to store the result
  2697. */
  2698. projectOnPlaneToRef(plane: Plane, origin: Vector3, result: Vector3): void;
  2699. /**
  2700. * Returns true if the current Vector3 and the given vector coordinates are strictly equal
  2701. * @param otherVector defines the second operand
  2702. * @returns true if both vectors are equals
  2703. */
  2704. equals(otherVector: DeepImmutable<Vector3>): boolean;
  2705. /**
  2706. * Returns true if the current Vector3 and the given vector coordinates are distant less than epsilon
  2707. * @param otherVector defines the second operand
  2708. * @param epsilon defines the minimal distance to define values as equals
  2709. * @returns true if both vectors are distant less than epsilon
  2710. */
  2711. equalsWithEpsilon(otherVector: DeepImmutable<Vector3>, epsilon?: number): boolean;
  2712. /**
  2713. * Returns true if the current Vector3 coordinates equals the given floats
  2714. * @param x defines the x coordinate of the operand
  2715. * @param y defines the y coordinate of the operand
  2716. * @param z defines the z coordinate of the operand
  2717. * @returns true if both vectors are equals
  2718. */
  2719. equalsToFloats(x: number, y: number, z: number): boolean;
  2720. /**
  2721. * Multiplies the current Vector3 coordinates by the given ones
  2722. * @param otherVector defines the second operand
  2723. * @returns the current updated Vector3
  2724. */
  2725. multiplyInPlace(otherVector: DeepImmutable<Vector3>): Vector3;
  2726. /**
  2727. * Returns a new Vector3, result of the multiplication of the current Vector3 by the given vector
  2728. * @param otherVector defines the second operand
  2729. * @returns the new Vector3
  2730. */
  2731. multiply(otherVector: DeepImmutable<Vector3>): Vector3;
  2732. /**
  2733. * Multiplies the current Vector3 by the given one and stores the result in the given vector "result"
  2734. * @param otherVector defines the second operand
  2735. * @param result defines the Vector3 object where to store the result
  2736. * @returns the current Vector3
  2737. */
  2738. multiplyToRef(otherVector: DeepImmutable<Vector3>, result: Vector3): Vector3;
  2739. /**
  2740. * Returns a new Vector3 set with the result of the mulliplication of the current Vector3 coordinates by the given floats
  2741. * @param x defines the x coordinate of the operand
  2742. * @param y defines the y coordinate of the operand
  2743. * @param z defines the z coordinate of the operand
  2744. * @returns the new Vector3
  2745. */
  2746. multiplyByFloats(x: number, y: number, z: number): Vector3;
  2747. /**
  2748. * Returns a new Vector3 set with the result of the division of the current Vector3 coordinates by the given ones
  2749. * @param otherVector defines the second operand
  2750. * @returns the new Vector3
  2751. */
  2752. divide(otherVector: DeepImmutable<Vector3>): Vector3;
  2753. /**
  2754. * Divides the current Vector3 coordinates by the given ones and stores the result in the given vector "result"
  2755. * @param otherVector defines the second operand
  2756. * @param result defines the Vector3 object where to store the result
  2757. * @returns the current Vector3
  2758. */
  2759. divideToRef(otherVector: DeepImmutable<Vector3>, result: Vector3): Vector3;
  2760. /**
  2761. * Divides the current Vector3 coordinates by the given ones.
  2762. * @param otherVector defines the second operand
  2763. * @returns the current updated Vector3
  2764. */
  2765. divideInPlace(otherVector: Vector3): Vector3;
  2766. /**
  2767. * Updates the current Vector3 with the minimal coordinate values between its and the given vector ones
  2768. * @param other defines the second operand
  2769. * @returns the current updated Vector3
  2770. */
  2771. minimizeInPlace(other: DeepImmutable<Vector3>): Vector3;
  2772. /**
  2773. * Updates the current Vector3 with the maximal coordinate values between its and the given vector ones.
  2774. * @param other defines the second operand
  2775. * @returns the current updated Vector3
  2776. */
  2777. maximizeInPlace(other: DeepImmutable<Vector3>): Vector3;
  2778. /**
  2779. * Updates the current Vector3 with the minimal coordinate values between its and the given coordinates
  2780. * @param x defines the x coordinate of the operand
  2781. * @param y defines the y coordinate of the operand
  2782. * @param z defines the z coordinate of the operand
  2783. * @returns the current updated Vector3
  2784. */
  2785. minimizeInPlaceFromFloats(x: number, y: number, z: number): Vector3;
  2786. /**
  2787. * Updates the current Vector3 with the maximal coordinate values between its and the given coordinates.
  2788. * @param x defines the x coordinate of the operand
  2789. * @param y defines the y coordinate of the operand
  2790. * @param z defines the z coordinate of the operand
  2791. * @returns the current updated Vector3
  2792. */
  2793. maximizeInPlaceFromFloats(x: number, y: number, z: number): Vector3;
  2794. /**
  2795. * Due to float precision, scale of a mesh could be uniform but float values are off by a small fraction
  2796. * Check if is non uniform within a certain amount of decimal places to account for this
  2797. * @param epsilon the amount the values can differ
  2798. * @returns if the the vector is non uniform to a certain number of decimal places
  2799. */
  2800. isNonUniformWithinEpsilon(epsilon: number): boolean;
  2801. /**
  2802. * Gets a boolean indicating that the vector is non uniform meaning x, y or z are not all the same
  2803. */
  2804. get isNonUniform(): boolean;
  2805. /**
  2806. * Gets a new Vector3 from current Vector3 floored values
  2807. * @returns a new Vector3
  2808. */
  2809. floor(): Vector3;
  2810. /**
  2811. * Gets a new Vector3 from current Vector3 floored values
  2812. * @returns a new Vector3
  2813. */
  2814. fract(): Vector3;
  2815. /**
  2816. * Gets the length of the Vector3
  2817. * @returns the length of the Vector3
  2818. */
  2819. length(): number;
  2820. /**
  2821. * Gets the squared length of the Vector3
  2822. * @returns squared length of the Vector3
  2823. */
  2824. lengthSquared(): number;
  2825. /**
  2826. * Normalize the current Vector3.
  2827. * Please note that this is an in place operation.
  2828. * @returns the current updated Vector3
  2829. */
  2830. normalize(): Vector3;
  2831. /**
  2832. * Reorders the x y z properties of the vector in place
  2833. * @param order new ordering of the properties (eg. for vector 1,2,3 with "ZYX" will produce 3,2,1)
  2834. * @returns the current updated vector
  2835. */
  2836. reorderInPlace(order: string): this;
  2837. /**
  2838. * Rotates the vector around 0,0,0 by a quaternion
  2839. * @param quaternion the rotation quaternion
  2840. * @param result vector to store the result
  2841. * @returns the resulting vector
  2842. */
  2843. rotateByQuaternionToRef(quaternion: Quaternion, result: Vector3): Vector3;
  2844. /**
  2845. * Rotates a vector around a given point
  2846. * @param quaternion the rotation quaternion
  2847. * @param point the point to rotate around
  2848. * @param result vector to store the result
  2849. * @returns the resulting vector
  2850. */
  2851. rotateByQuaternionAroundPointToRef(quaternion: Quaternion, point: Vector3, result: Vector3): Vector3;
  2852. /**
  2853. * Returns a new Vector3 as the cross product of the current vector and the "other" one
  2854. * The cross product is then orthogonal to both current and "other"
  2855. * @param other defines the right operand
  2856. * @returns the cross product
  2857. */
  2858. cross(other: Vector3): Vector3;
  2859. /**
  2860. * Normalize the current Vector3 with the given input length.
  2861. * Please note that this is an in place operation.
  2862. * @param len the length of the vector
  2863. * @returns the current updated Vector3
  2864. */
  2865. normalizeFromLength(len: number): Vector3;
  2866. /**
  2867. * Normalize the current Vector3 to a new vector
  2868. * @returns the new Vector3
  2869. */
  2870. normalizeToNew(): Vector3;
  2871. /**
  2872. * Normalize the current Vector3 to the reference
  2873. * @param reference define the Vector3 to update
  2874. * @returns the updated Vector3
  2875. */
  2876. normalizeToRef(reference: Vector3): Vector3;
  2877. /**
  2878. * Creates a new Vector3 copied from the current Vector3
  2879. * @returns the new Vector3
  2880. */
  2881. clone(): Vector3;
  2882. /**
  2883. * Copies the given vector coordinates to the current Vector3 ones
  2884. * @param source defines the source Vector3
  2885. * @returns the current updated Vector3
  2886. */
  2887. copyFrom(source: DeepImmutable<Vector3>): Vector3;
  2888. /**
  2889. * Copies the given floats to the current Vector3 coordinates
  2890. * @param x defines the x coordinate of the operand
  2891. * @param y defines the y coordinate of the operand
  2892. * @param z defines the z coordinate of the operand
  2893. * @returns the current updated Vector3
  2894. */
  2895. copyFromFloats(x: number, y: number, z: number): Vector3;
  2896. /**
  2897. * Copies the given floats to the current Vector3 coordinates
  2898. * @param x defines the x coordinate of the operand
  2899. * @param y defines the y coordinate of the operand
  2900. * @param z defines the z coordinate of the operand
  2901. * @returns the current updated Vector3
  2902. */
  2903. set(x: number, y: number, z: number): Vector3;
  2904. /**
  2905. * Copies the given float to the current Vector3 coordinates
  2906. * @param v defines the x, y and z coordinates of the operand
  2907. * @returns the current updated Vector3
  2908. */
  2909. setAll(v: number): Vector3;
  2910. /**
  2911. * Get the clip factor between two vectors
  2912. * @param vector0 defines the first operand
  2913. * @param vector1 defines the second operand
  2914. * @param axis defines the axis to use
  2915. * @param size defines the size along the axis
  2916. * @returns the clip factor
  2917. */
  2918. static GetClipFactor(vector0: DeepImmutable<Vector3>, vector1: DeepImmutable<Vector3>, axis: DeepImmutable<Vector3>, size: number): number;
  2919. /**
  2920. * Get angle between two vectors
  2921. * @param vector0 angle between vector0 and vector1
  2922. * @param vector1 angle between vector0 and vector1
  2923. * @param normal direction of the normal
  2924. * @return the angle between vector0 and vector1
  2925. */
  2926. static GetAngleBetweenVectors(vector0: DeepImmutable<Vector3>, vector1: DeepImmutable<Vector3>, normal: DeepImmutable<Vector3>): number;
  2927. /**
  2928. * Returns a new Vector3 set from the index "offset" of the given array
  2929. * @param array defines the source array
  2930. * @param offset defines the offset in the source array
  2931. * @returns the new Vector3
  2932. */
  2933. static FromArray(array: DeepImmutable<ArrayLike<number>>, offset?: number): Vector3;
  2934. /**
  2935. * Returns a new Vector3 set from the index "offset" of the given Float32Array
  2936. * @param array defines the source array
  2937. * @param offset defines the offset in the source array
  2938. * @returns the new Vector3
  2939. * @deprecated Please use FromArray instead.
  2940. */
  2941. static FromFloatArray(array: DeepImmutable<Float32Array>, offset?: number): Vector3;
  2942. /**
  2943. * Sets the given vector "result" with the element values from the index "offset" of the given array
  2944. * @param array defines the source array
  2945. * @param offset defines the offset in the source array
  2946. * @param result defines the Vector3 where to store the result
  2947. */
  2948. static FromArrayToRef(array: DeepImmutable<ArrayLike<number>>, offset: number, result: Vector3): void;
  2949. /**
  2950. * Sets the given vector "result" with the element values from the index "offset" of the given Float32Array
  2951. * @param array defines the source array
  2952. * @param offset defines the offset in the source array
  2953. * @param result defines the Vector3 where to store the result
  2954. * @deprecated Please use FromArrayToRef instead.
  2955. */
  2956. static FromFloatArrayToRef(array: DeepImmutable<Float32Array>, offset: number, result: Vector3): void;
  2957. /**
  2958. * Sets the given vector "result" with the given floats.
  2959. * @param x defines the x coordinate of the source
  2960. * @param y defines the y coordinate of the source
  2961. * @param z defines the z coordinate of the source
  2962. * @param result defines the Vector3 where to store the result
  2963. */
  2964. static FromFloatsToRef(x: number, y: number, z: number, result: Vector3): void;
  2965. /**
  2966. * Returns a new Vector3 set to (0.0, 0.0, 0.0)
  2967. * @returns a new empty Vector3
  2968. */
  2969. static Zero(): Vector3;
  2970. /**
  2971. * Returns a new Vector3 set to (1.0, 1.0, 1.0)
  2972. * @returns a new unit Vector3
  2973. */
  2974. static One(): Vector3;
  2975. /**
  2976. * Returns a new Vector3 set to (0.0, 1.0, 0.0)
  2977. * @returns a new up Vector3
  2978. */
  2979. static Up(): Vector3;
  2980. /**
  2981. * Gets a up Vector3 that must not be updated
  2982. */
  2983. static get UpReadOnly(): DeepImmutable<Vector3>;
  2984. /**
  2985. * Gets a zero Vector3 that must not be updated
  2986. */
  2987. static get ZeroReadOnly(): DeepImmutable<Vector3>;
  2988. /**
  2989. * Returns a new Vector3 set to (0.0, -1.0, 0.0)
  2990. * @returns a new down Vector3
  2991. */
  2992. static Down(): Vector3;
  2993. /**
  2994. * Returns a new Vector3 set to (0.0, 0.0, 1.0)
  2995. * @param rightHandedSystem is the scene right-handed (negative z)
  2996. * @returns a new forward Vector3
  2997. */
  2998. static Forward(rightHandedSystem?: boolean): Vector3;
  2999. /**
  3000. * Returns a new Vector3 set to (0.0, 0.0, -1.0)
  3001. * @param rightHandedSystem is the scene right-handed (negative-z)
  3002. * @returns a new forward Vector3
  3003. */
  3004. static Backward(rightHandedSystem?: boolean): Vector3;
  3005. /**
  3006. * Returns a new Vector3 set to (1.0, 0.0, 0.0)
  3007. * @returns a new right Vector3
  3008. */
  3009. static Right(): Vector3;
  3010. /**
  3011. * Returns a new Vector3 set to (-1.0, 0.0, 0.0)
  3012. * @returns a new left Vector3
  3013. */
  3014. static Left(): Vector3;
  3015. /**
  3016. * Returns a new Vector3 set with the result of the transformation by the given matrix of the given vector.
  3017. * This method computes tranformed coordinates only, not transformed direction vectors (ie. it takes translation in account)
  3018. * @param vector defines the Vector3 to transform
  3019. * @param transformation defines the transformation matrix
  3020. * @returns the transformed Vector3
  3021. */
  3022. static TransformCoordinates(vector: DeepImmutable<Vector3>, transformation: DeepImmutable<Matrix>): Vector3;
  3023. /**
  3024. * Sets the given vector "result" coordinates with the result of the transformation by the given matrix of the given vector
  3025. * This method computes tranformed coordinates only, not transformed direction vectors (ie. it takes translation in account)
  3026. * @param vector defines the Vector3 to transform
  3027. * @param transformation defines the transformation matrix
  3028. * @param result defines the Vector3 where to store the result
  3029. */
  3030. static TransformCoordinatesToRef(vector: DeepImmutable<Vector3>, transformation: DeepImmutable<Matrix>, result: Vector3): void;
  3031. /**
  3032. * Sets the given vector "result" coordinates with the result of the transformation by the given matrix of the given floats (x, y, z)
  3033. * This method computes tranformed coordinates only, not transformed direction vectors
  3034. * @param x define the x coordinate of the source vector
  3035. * @param y define the y coordinate of the source vector
  3036. * @param z define the z coordinate of the source vector
  3037. * @param transformation defines the transformation matrix
  3038. * @param result defines the Vector3 where to store the result
  3039. */
  3040. static TransformCoordinatesFromFloatsToRef(x: number, y: number, z: number, transformation: DeepImmutable<Matrix>, result: Vector3): void;
  3041. /**
  3042. * Returns a new Vector3 set with the result of the normal transformation by the given matrix of the given vector
  3043. * This methods computes transformed normalized direction vectors only (ie. it does not apply translation)
  3044. * @param vector defines the Vector3 to transform
  3045. * @param transformation defines the transformation matrix
  3046. * @returns the new Vector3
  3047. */
  3048. static TransformNormal(vector: DeepImmutable<Vector3>, transformation: DeepImmutable<Matrix>): Vector3;
  3049. /**
  3050. * Sets the given vector "result" with the result of the normal transformation by the given matrix of the given vector
  3051. * This methods computes transformed normalized direction vectors only (ie. it does not apply translation)
  3052. * @param vector defines the Vector3 to transform
  3053. * @param transformation defines the transformation matrix
  3054. * @param result defines the Vector3 where to store the result
  3055. */
  3056. static TransformNormalToRef(vector: DeepImmutable<Vector3>, transformation: DeepImmutable<Matrix>, result: Vector3): void;
  3057. /**
  3058. * Sets the given vector "result" with the result of the normal transformation by the given matrix of the given floats (x, y, z)
  3059. * This methods computes transformed normalized direction vectors only (ie. it does not apply translation)
  3060. * @param x define the x coordinate of the source vector
  3061. * @param y define the y coordinate of the source vector
  3062. * @param z define the z coordinate of the source vector
  3063. * @param transformation defines the transformation matrix
  3064. * @param result defines the Vector3 where to store the result
  3065. */
  3066. static TransformNormalFromFloatsToRef(x: number, y: number, z: number, transformation: DeepImmutable<Matrix>, result: Vector3): void;
  3067. /**
  3068. * Returns a new Vector3 located for "amount" on the CatmullRom interpolation spline defined by the vectors "value1", "value2", "value3", "value4"
  3069. * @param value1 defines the first control point
  3070. * @param value2 defines the second control point
  3071. * @param value3 defines the third control point
  3072. * @param value4 defines the fourth control point
  3073. * @param amount defines the amount on the spline to use
  3074. * @returns the new Vector3
  3075. */
  3076. static CatmullRom(value1: DeepImmutable<Vector3>, value2: DeepImmutable<Vector3>, value3: DeepImmutable<Vector3>, value4: DeepImmutable<Vector3>, amount: number): Vector3;
  3077. /**
  3078. * 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"
  3079. * If a coordinate value of "value" is lower than one of the "min" coordinate, then this "value" coordinate is set with the "min" one
  3080. * If a coordinate value of "value" is greater than one of the "max" coordinate, then this "value" coordinate is set with the "max" one
  3081. * @param value defines the current value
  3082. * @param min defines the lower range value
  3083. * @param max defines the upper range value
  3084. * @returns the new Vector3
  3085. */
  3086. static Clamp(value: DeepImmutable<Vector3>, min: DeepImmutable<Vector3>, max: DeepImmutable<Vector3>): Vector3;
  3087. /**
  3088. * 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"
  3089. * If a coordinate value of "value" is lower than one of the "min" coordinate, then this "value" coordinate is set with the "min" one
  3090. * If a coordinate value of "value" is greater than one of the "max" coordinate, then this "value" coordinate is set with the "max" one
  3091. * @param value defines the current value
  3092. * @param min defines the lower range value
  3093. * @param max defines the upper range value
  3094. * @param result defines the Vector3 where to store the result
  3095. */
  3096. static ClampToRef(value: DeepImmutable<Vector3>, min: DeepImmutable<Vector3>, max: DeepImmutable<Vector3>, result: Vector3): void;
  3097. /**
  3098. * Checks if a given vector is inside a specific range
  3099. * @param v defines the vector to test
  3100. * @param min defines the minimum range
  3101. * @param max defines the maximum range
  3102. */
  3103. static CheckExtends(v: Vector3, min: Vector3, max: Vector3): void;
  3104. /**
  3105. * Returns a new Vector3 located for "amount" (float) on the Hermite interpolation spline defined by the vectors "value1", "tangent1", "value2", "tangent2"
  3106. * @param value1 defines the first control point
  3107. * @param tangent1 defines the first tangent vector
  3108. * @param value2 defines the second control point
  3109. * @param tangent2 defines the second tangent vector
  3110. * @param amount defines the amount on the interpolation spline (between 0 and 1)
  3111. * @returns the new Vector3
  3112. */
  3113. static Hermite(value1: DeepImmutable<Vector3>, tangent1: DeepImmutable<Vector3>, value2: DeepImmutable<Vector3>, tangent2: DeepImmutable<Vector3>, amount: number): Vector3;
  3114. /**
  3115. * Returns a new Vector3 located for "amount" (float) on the linear interpolation between the vectors "start" and "end"
  3116. * @param start defines the start value
  3117. * @param end defines the end value
  3118. * @param amount max defines amount between both (between 0 and 1)
  3119. * @returns the new Vector3
  3120. */
  3121. static Lerp(start: DeepImmutable<Vector3>, end: DeepImmutable<Vector3>, amount: number): Vector3;
  3122. /**
  3123. * Sets the given vector "result" with the result of the linear interpolation from the vector "start" for "amount" to the vector "end"
  3124. * @param start defines the start value
  3125. * @param end defines the end value
  3126. * @param amount max defines amount between both (between 0 and 1)
  3127. * @param result defines the Vector3 where to store the result
  3128. */
  3129. static LerpToRef(start: DeepImmutable<Vector3>, end: DeepImmutable<Vector3>, amount: number, result: Vector3): void;
  3130. /**
  3131. * Returns the dot product (float) between the vectors "left" and "right"
  3132. * @param left defines the left operand
  3133. * @param right defines the right operand
  3134. * @returns the dot product
  3135. */
  3136. static Dot(left: DeepImmutable<Vector3>, right: DeepImmutable<Vector3>): number;
  3137. /**
  3138. * Returns a new Vector3 as the cross product of the vectors "left" and "right"
  3139. * The cross product is then orthogonal to both "left" and "right"
  3140. * @param left defines the left operand
  3141. * @param right defines the right operand
  3142. * @returns the cross product
  3143. */
  3144. static Cross(left: DeepImmutable<Vector3>, right: DeepImmutable<Vector3>): Vector3;
  3145. /**
  3146. * Sets the given vector "result" with the cross product of "left" and "right"
  3147. * The cross product is then orthogonal to both "left" and "right"
  3148. * @param left defines the left operand
  3149. * @param right defines the right operand
  3150. * @param result defines the Vector3 where to store the result
  3151. */
  3152. static CrossToRef(left: DeepImmutable<Vector3>, right: DeepImmutable<Vector3>, result: Vector3): void;
  3153. /**
  3154. * Returns a new Vector3 as the normalization of the given vector
  3155. * @param vector defines the Vector3 to normalize
  3156. * @returns the new Vector3
  3157. */
  3158. static Normalize(vector: DeepImmutable<Vector3>): Vector3;
  3159. /**
  3160. * Sets the given vector "result" with the normalization of the given first vector
  3161. * @param vector defines the Vector3 to normalize
  3162. * @param result defines the Vector3 where to store the result
  3163. */
  3164. static NormalizeToRef(vector: DeepImmutable<Vector3>, result: Vector3): void;
  3165. /**
  3166. * Project a Vector3 onto screen space
  3167. * @param vector defines the Vector3 to project
  3168. * @param world defines the world matrix to use
  3169. * @param transform defines the transform (view x projection) matrix to use
  3170. * @param viewport defines the screen viewport to use
  3171. * @returns the new Vector3
  3172. */
  3173. static Project(vector: DeepImmutable<Vector3>, world: DeepImmutable<Matrix>, transform: DeepImmutable<Matrix>, viewport: DeepImmutable<Viewport>): Vector3;
  3174. /**
  3175. * Project a Vector3 onto screen space to reference
  3176. * @param vector defines the Vector3 to project
  3177. * @param world defines the world matrix to use
  3178. * @param transform defines the transform (view x projection) matrix to use
  3179. * @param viewport defines the screen viewport to use
  3180. * @param result the vector in which the screen space will be stored
  3181. * @returns the new Vector3
  3182. */
  3183. static ProjectToRef(vector: DeepImmutable<Vector3>, world: DeepImmutable<Matrix>, transform: DeepImmutable<Matrix>, viewport: DeepImmutable<Viewport>, result: DeepImmutable<Vector3>): Vector3;
  3184. /** @hidden */
  3185. static _UnprojectFromInvertedMatrixToRef(source: DeepImmutable<Vector3>, matrix: DeepImmutable<Matrix>, result: Vector3): void;
  3186. /**
  3187. * Unproject from screen space to object space
  3188. * @param source defines the screen space Vector3 to use
  3189. * @param viewportWidth defines the current width of the viewport
  3190. * @param viewportHeight defines the current height of the viewport
  3191. * @param world defines the world matrix to use (can be set to Identity to go to world space)
  3192. * @param transform defines the transform (view x projection) matrix to use
  3193. * @returns the new Vector3
  3194. */
  3195. static UnprojectFromTransform(source: Vector3, viewportWidth: number, viewportHeight: number, world: DeepImmutable<Matrix>, transform: DeepImmutable<Matrix>): Vector3;
  3196. /**
  3197. * Unproject from screen space to object space
  3198. * @param source defines the screen space Vector3 to use
  3199. * @param viewportWidth defines the current width of the viewport
  3200. * @param viewportHeight defines the current height of the viewport
  3201. * @param world defines the world matrix to use (can be set to Identity to go to world space)
  3202. * @param view defines the view matrix to use
  3203. * @param projection defines the projection matrix to use
  3204. * @returns the new Vector3
  3205. */
  3206. static Unproject(source: DeepImmutable<Vector3>, viewportWidth: number, viewportHeight: number, world: DeepImmutable<Matrix>, view: DeepImmutable<Matrix>, projection: DeepImmutable<Matrix>): Vector3;
  3207. /**
  3208. * Unproject from screen space to object space
  3209. * @param source defines the screen space Vector3 to use
  3210. * @param viewportWidth defines the current width of the viewport
  3211. * @param viewportHeight defines the current height of the viewport
  3212. * @param world defines the world matrix to use (can be set to Identity to go to world space)
  3213. * @param view defines the view matrix to use
  3214. * @param projection defines the projection matrix to use
  3215. * @param result defines the Vector3 where to store the result
  3216. */
  3217. static UnprojectToRef(source: DeepImmutable<Vector3>, viewportWidth: number, viewportHeight: number, world: DeepImmutable<Matrix>, view: DeepImmutable<Matrix>, projection: DeepImmutable<Matrix>, result: Vector3): void;
  3218. /**
  3219. * Unproject from screen space to object space
  3220. * @param sourceX defines the screen space x coordinate to use
  3221. * @param sourceY defines the screen space y coordinate to use
  3222. * @param sourceZ defines the screen space z coordinate to use
  3223. * @param viewportWidth defines the current width of the viewport
  3224. * @param viewportHeight defines the current height of the viewport
  3225. * @param world defines the world matrix to use (can be set to Identity to go to world space)
  3226. * @param view defines the view matrix to use
  3227. * @param projection defines the projection matrix to use
  3228. * @param result defines the Vector3 where to store the result
  3229. */
  3230. static UnprojectFloatsToRef(sourceX: float, sourceY: float, sourceZ: float, viewportWidth: number, viewportHeight: number, world: DeepImmutable<Matrix>, view: DeepImmutable<Matrix>, projection: DeepImmutable<Matrix>, result: Vector3): void;
  3231. /**
  3232. * Gets the minimal coordinate values between two Vector3
  3233. * @param left defines the first operand
  3234. * @param right defines the second operand
  3235. * @returns the new Vector3
  3236. */
  3237. static Minimize(left: DeepImmutable<Vector3>, right: DeepImmutable<Vector3>): Vector3;
  3238. /**
  3239. * Gets the maximal coordinate values between two Vector3
  3240. * @param left defines the first operand
  3241. * @param right defines the second operand
  3242. * @returns the new Vector3
  3243. */
  3244. static Maximize(left: DeepImmutable<Vector3>, right: DeepImmutable<Vector3>): Vector3;
  3245. /**
  3246. * Returns the distance between the vectors "value1" and "value2"
  3247. * @param value1 defines the first operand
  3248. * @param value2 defines the second operand
  3249. * @returns the distance
  3250. */
  3251. static Distance(value1: DeepImmutable<Vector3>, value2: DeepImmutable<Vector3>): number;
  3252. /**
  3253. * Returns the squared distance between the vectors "value1" and "value2"
  3254. * @param value1 defines the first operand
  3255. * @param value2 defines the second operand
  3256. * @returns the squared distance
  3257. */
  3258. static DistanceSquared(value1: DeepImmutable<Vector3>, value2: DeepImmutable<Vector3>): number;
  3259. /**
  3260. * Returns a new Vector3 located at the center between "value1" and "value2"
  3261. * @param value1 defines the first operand
  3262. * @param value2 defines the second operand
  3263. * @returns the new Vector3
  3264. */
  3265. static Center(value1: DeepImmutable<Vector3>, value2: DeepImmutable<Vector3>): Vector3;
  3266. /**
  3267. * Given three orthogonal normalized left-handed oriented Vector3 axis in space (target system),
  3268. * RotationFromAxis() returns the rotation Euler angles (ex : rotation.x, rotation.y, rotation.z) to apply
  3269. * to something in order to rotate it from its local system to the given target system
  3270. * Note: axis1, axis2 and axis3 are normalized during this operation
  3271. * @param axis1 defines the first axis
  3272. * @param axis2 defines the second axis
  3273. * @param axis3 defines the third axis
  3274. * @returns a new Vector3
  3275. */
  3276. static RotationFromAxis(axis1: DeepImmutable<Vector3>, axis2: DeepImmutable<Vector3>, axis3: DeepImmutable<Vector3>): Vector3;
  3277. /**
  3278. * The same than RotationFromAxis but updates the given ref Vector3 parameter instead of returning a new Vector3
  3279. * @param axis1 defines the first axis
  3280. * @param axis2 defines the second axis
  3281. * @param axis3 defines the third axis
  3282. * @param ref defines the Vector3 where to store the result
  3283. */
  3284. static RotationFromAxisToRef(axis1: DeepImmutable<Vector3>, axis2: DeepImmutable<Vector3>, axis3: DeepImmutable<Vector3>, ref: Vector3): void;
  3285. }
  3286. /**
  3287. * Vector4 class created for EulerAngle class conversion to Quaternion
  3288. */
  3289. export class Vector4 {
  3290. /** x value of the vector */
  3291. x: number;
  3292. /** y value of the vector */
  3293. y: number;
  3294. /** z value of the vector */
  3295. z: number;
  3296. /** w value of the vector */
  3297. w: number;
  3298. /**
  3299. * Creates a Vector4 object from the given floats.
  3300. * @param x x value of the vector
  3301. * @param y y value of the vector
  3302. * @param z z value of the vector
  3303. * @param w w value of the vector
  3304. */
  3305. constructor(
  3306. /** x value of the vector */
  3307. x: number,
  3308. /** y value of the vector */
  3309. y: number,
  3310. /** z value of the vector */
  3311. z: number,
  3312. /** w value of the vector */
  3313. w: number);
  3314. /**
  3315. * Returns the string with the Vector4 coordinates.
  3316. * @returns a string containing all the vector values
  3317. */
  3318. toString(): string;
  3319. /**
  3320. * Returns the string "Vector4".
  3321. * @returns "Vector4"
  3322. */
  3323. getClassName(): string;
  3324. /**
  3325. * Returns the Vector4 hash code.
  3326. * @returns a unique hash code
  3327. */
  3328. getHashCode(): number;
  3329. /**
  3330. * Returns a new array populated with 4 elements : the Vector4 coordinates.
  3331. * @returns the resulting array
  3332. */
  3333. asArray(): number[];
  3334. /**
  3335. * Populates the given array from the given index with the Vector4 coordinates.
  3336. * @param array array to populate
  3337. * @param index index of the array to start at (default: 0)
  3338. * @returns the Vector4.
  3339. */
  3340. toArray(array: FloatArray, index?: number): Vector4;
  3341. /**
  3342. * Update the current vector from an array
  3343. * @param array defines the destination array
  3344. * @param index defines the offset in the destination array
  3345. * @returns the current Vector3
  3346. */
  3347. fromArray(array: FloatArray, index?: number): Vector4;
  3348. /**
  3349. * Adds the given vector to the current Vector4.
  3350. * @param otherVector the vector to add
  3351. * @returns the updated Vector4.
  3352. */
  3353. addInPlace(otherVector: DeepImmutable<Vector4>): Vector4;
  3354. /**
  3355. * Returns a new Vector4 as the result of the addition of the current Vector4 and the given one.
  3356. * @param otherVector the vector to add
  3357. * @returns the resulting vector
  3358. */
  3359. add(otherVector: DeepImmutable<Vector4>): Vector4;
  3360. /**
  3361. * Updates the given vector "result" with the result of the addition of the current Vector4 and the given one.
  3362. * @param otherVector the vector to add
  3363. * @param result the vector to store the result
  3364. * @returns the current Vector4.
  3365. */
  3366. addToRef(otherVector: DeepImmutable<Vector4>, result: Vector4): Vector4;
  3367. /**
  3368. * Subtract in place the given vector from the current Vector4.
  3369. * @param otherVector the vector to subtract
  3370. * @returns the updated Vector4.
  3371. */
  3372. subtractInPlace(otherVector: DeepImmutable<Vector4>): Vector4;
  3373. /**
  3374. * Returns a new Vector4 with the result of the subtraction of the given vector from the current Vector4.
  3375. * @param otherVector the vector to add
  3376. * @returns the new vector with the result
  3377. */
  3378. subtract(otherVector: DeepImmutable<Vector4>): Vector4;
  3379. /**
  3380. * Sets the given vector "result" with the result of the subtraction of the given vector from the current Vector4.
  3381. * @param otherVector the vector to subtract
  3382. * @param result the vector to store the result
  3383. * @returns the current Vector4.
  3384. */
  3385. subtractToRef(otherVector: DeepImmutable<Vector4>, result: Vector4): Vector4;
  3386. /**
  3387. * Returns a new Vector4 set with the result of the subtraction of the given floats from the current Vector4 coordinates.
  3388. */
  3389. /**
  3390. * Returns a new Vector4 set with the result of the subtraction of the given floats from the current Vector4 coordinates.
  3391. * @param x value to subtract
  3392. * @param y value to subtract
  3393. * @param z value to subtract
  3394. * @param w value to subtract
  3395. * @returns new vector containing the result
  3396. */
  3397. subtractFromFloats(x: number, y: number, z: number, w: number): Vector4;
  3398. /**
  3399. * Sets the given vector "result" set with the result of the subtraction of the given floats from the current Vector4 coordinates.
  3400. * @param x value to subtract
  3401. * @param y value to subtract
  3402. * @param z value to subtract
  3403. * @param w value to subtract
  3404. * @param result the vector to store the result in
  3405. * @returns the current Vector4.
  3406. */
  3407. subtractFromFloatsToRef(x: number, y: number, z: number, w: number, result: Vector4): Vector4;
  3408. /**
  3409. * Returns a new Vector4 set with the current Vector4 negated coordinates.
  3410. * @returns a new vector with the negated values
  3411. */
  3412. negate(): Vector4;
  3413. /**
  3414. * Negate this vector in place
  3415. * @returns this
  3416. */
  3417. negateInPlace(): Vector4;
  3418. /**
  3419. * Negate the current Vector4 and stores the result in the given vector "result" coordinates
  3420. * @param result defines the Vector3 object where to store the result
  3421. * @returns the current Vector4
  3422. */
  3423. negateToRef(result: Vector4): Vector4;
  3424. /**
  3425. * Multiplies the current Vector4 coordinates by scale (float).
  3426. * @param scale the number to scale with
  3427. * @returns the updated Vector4.
  3428. */
  3429. scaleInPlace(scale: number): Vector4;
  3430. /**
  3431. * Returns a new Vector4 set with the current Vector4 coordinates multiplied by scale (float).
  3432. * @param scale the number to scale with
  3433. * @returns a new vector with the result
  3434. */
  3435. scale(scale: number): Vector4;
  3436. /**
  3437. * Sets the given vector "result" with the current Vector4 coordinates multiplied by scale (float).
  3438. * @param scale the number to scale with
  3439. * @param result a vector to store the result in
  3440. * @returns the current Vector4.
  3441. */
  3442. scaleToRef(scale: number, result: Vector4): Vector4;
  3443. /**
  3444. * Scale the current Vector4 values by a factor and add the result to a given Vector4
  3445. * @param scale defines the scale factor
  3446. * @param result defines the Vector4 object where to store the result
  3447. * @returns the unmodified current Vector4
  3448. */
  3449. scaleAndAddToRef(scale: number, result: Vector4): Vector4;
  3450. /**
  3451. * Boolean : True if the current Vector4 coordinates are stricly equal to the given ones.
  3452. * @param otherVector the vector to compare against
  3453. * @returns true if they are equal
  3454. */
  3455. equals(otherVector: DeepImmutable<Vector4>): boolean;
  3456. /**
  3457. * Boolean : True if the current Vector4 coordinates are each beneath the distance "epsilon" from the given vector ones.
  3458. * @param otherVector vector to compare against
  3459. * @param epsilon (Default: very small number)
  3460. * @returns true if they are equal
  3461. */
  3462. equalsWithEpsilon(otherVector: DeepImmutable<Vector4>, epsilon?: number): boolean;
  3463. /**
  3464. * Boolean : True if the given floats are strictly equal to the current Vector4 coordinates.
  3465. * @param x x value to compare against
  3466. * @param y y value to compare against
  3467. * @param z z value to compare against
  3468. * @param w w value to compare against
  3469. * @returns true if equal
  3470. */
  3471. equalsToFloats(x: number, y: number, z: number, w: number): boolean;
  3472. /**
  3473. * Multiplies in place the current Vector4 by the given one.
  3474. * @param otherVector vector to multiple with
  3475. * @returns the updated Vector4.
  3476. */
  3477. multiplyInPlace(otherVector: Vector4): Vector4;
  3478. /**
  3479. * Returns a new Vector4 set with the multiplication result of the current Vector4 and the given one.
  3480. * @param otherVector vector to multiple with
  3481. * @returns resulting new vector
  3482. */
  3483. multiply(otherVector: DeepImmutable<Vector4>): Vector4;
  3484. /**
  3485. * Updates the given vector "result" with the multiplication result of the current Vector4 and the given one.
  3486. * @param otherVector vector to multiple with
  3487. * @param result vector to store the result
  3488. * @returns the current Vector4.
  3489. */
  3490. multiplyToRef(otherVector: DeepImmutable<Vector4>, result: Vector4): Vector4;
  3491. /**
  3492. * Returns a new Vector4 set with the multiplication result of the given floats and the current Vector4 coordinates.
  3493. * @param x x value multiply with
  3494. * @param y y value multiply with
  3495. * @param z z value multiply with
  3496. * @param w w value multiply with
  3497. * @returns resulting new vector
  3498. */
  3499. multiplyByFloats(x: number, y: number, z: number, w: number): Vector4;
  3500. /**
  3501. * Returns a new Vector4 set with the division result of the current Vector4 by the given one.
  3502. * @param otherVector vector to devide with
  3503. * @returns resulting new vector
  3504. */
  3505. divide(otherVector: DeepImmutable<Vector4>): Vector4;
  3506. /**
  3507. * Updates the given vector "result" with the division result of the current Vector4 by the given one.
  3508. * @param otherVector vector to devide with
  3509. * @param result vector to store the result
  3510. * @returns the current Vector4.
  3511. */
  3512. divideToRef(otherVector: DeepImmutable<Vector4>, result: Vector4): Vector4;
  3513. /**
  3514. * Divides the current Vector3 coordinates by the given ones.
  3515. * @param otherVector vector to devide with
  3516. * @returns the updated Vector3.
  3517. */
  3518. divideInPlace(otherVector: DeepImmutable<Vector4>): Vector4;
  3519. /**
  3520. * Updates the Vector4 coordinates with the minimum values between its own and the given vector ones
  3521. * @param other defines the second operand
  3522. * @returns the current updated Vector4
  3523. */
  3524. minimizeInPlace(other: DeepImmutable<Vector4>): Vector4;
  3525. /**
  3526. * Updates the Vector4 coordinates with the maximum values between its own and the given vector ones
  3527. * @param other defines the second operand
  3528. * @returns the current updated Vector4
  3529. */
  3530. maximizeInPlace(other: DeepImmutable<Vector4>): Vector4;
  3531. /**
  3532. * Gets a new Vector4 from current Vector4 floored values
  3533. * @returns a new Vector4
  3534. */
  3535. floor(): Vector4;
  3536. /**
  3537. * Gets a new Vector4 from current Vector3 floored values
  3538. * @returns a new Vector4
  3539. */
  3540. fract(): Vector4;
  3541. /**
  3542. * Returns the Vector4 length (float).
  3543. * @returns the length
  3544. */
  3545. length(): number;
  3546. /**
  3547. * Returns the Vector4 squared length (float).
  3548. * @returns the length squared
  3549. */
  3550. lengthSquared(): number;
  3551. /**
  3552. * Normalizes in place the Vector4.
  3553. * @returns the updated Vector4.
  3554. */
  3555. normalize(): Vector4;
  3556. /**
  3557. * Returns a new Vector3 from the Vector4 (x, y, z) coordinates.
  3558. * @returns this converted to a new vector3
  3559. */
  3560. toVector3(): Vector3;
  3561. /**
  3562. * Returns a new Vector4 copied from the current one.
  3563. * @returns the new cloned vector
  3564. */
  3565. clone(): Vector4;
  3566. /**
  3567. * Updates the current Vector4 with the given one coordinates.
  3568. * @param source the source vector to copy from
  3569. * @returns the updated Vector4.
  3570. */
  3571. copyFrom(source: DeepImmutable<Vector4>): Vector4;
  3572. /**
  3573. * Updates the current Vector4 coordinates with the given floats.
  3574. * @param x float to copy from
  3575. * @param y float to copy from
  3576. * @param z float to copy from
  3577. * @param w float to copy from
  3578. * @returns the updated Vector4.
  3579. */
  3580. copyFromFloats(x: number, y: number, z: number, w: number): Vector4;
  3581. /**
  3582. * Updates the current Vector4 coordinates with the given floats.
  3583. * @param x float to set from
  3584. * @param y float to set from
  3585. * @param z float to set from
  3586. * @param w float to set from
  3587. * @returns the updated Vector4.
  3588. */
  3589. set(x: number, y: number, z: number, w: number): Vector4;
  3590. /**
  3591. * Copies the given float to the current Vector3 coordinates
  3592. * @param v defines the x, y, z and w coordinates of the operand
  3593. * @returns the current updated Vector3
  3594. */
  3595. setAll(v: number): Vector4;
  3596. /**
  3597. * Returns a new Vector4 set from the starting index of the given array.
  3598. * @param array the array to pull values from
  3599. * @param offset the offset into the array to start at
  3600. * @returns the new vector
  3601. */
  3602. static FromArray(array: DeepImmutable<ArrayLike<number>>, offset?: number): Vector4;
  3603. /**
  3604. * Updates the given vector "result" from the starting index of the given array.
  3605. * @param array the array to pull values from
  3606. * @param offset the offset into the array to start at
  3607. * @param result the vector to store the result in
  3608. */
  3609. static FromArrayToRef(array: DeepImmutable<ArrayLike<number>>, offset: number, result: Vector4): void;
  3610. /**
  3611. * Updates the given vector "result" from the starting index of the given Float32Array.
  3612. * @param array the array to pull values from
  3613. * @param offset the offset into the array to start at
  3614. * @param result the vector to store the result in
  3615. */
  3616. static FromFloatArrayToRef(array: DeepImmutable<Float32Array>, offset: number, result: Vector4): void;
  3617. /**
  3618. * Updates the given vector "result" coordinates from the given floats.
  3619. * @param x float to set from
  3620. * @param y float to set from
  3621. * @param z float to set from
  3622. * @param w float to set from
  3623. * @param result the vector to the floats in
  3624. */
  3625. static FromFloatsToRef(x: number, y: number, z: number, w: number, result: Vector4): void;
  3626. /**
  3627. * Returns a new Vector4 set to (0.0, 0.0, 0.0, 0.0)
  3628. * @returns the new vector
  3629. */
  3630. static Zero(): Vector4;
  3631. /**
  3632. * Returns a new Vector4 set to (1.0, 1.0, 1.0, 1.0)
  3633. * @returns the new vector
  3634. */
  3635. static One(): Vector4;
  3636. /**
  3637. * Returns a new normalized Vector4 from the given one.
  3638. * @param vector the vector to normalize
  3639. * @returns the vector
  3640. */
  3641. static Normalize(vector: DeepImmutable<Vector4>): Vector4;
  3642. /**
  3643. * Updates the given vector "result" from the normalization of the given one.
  3644. * @param vector the vector to normalize
  3645. * @param result the vector to store the result in
  3646. */
  3647. static NormalizeToRef(vector: DeepImmutable<Vector4>, result: Vector4): void;
  3648. /**
  3649. * Returns a vector with the minimum values from the left and right vectors
  3650. * @param left left vector to minimize
  3651. * @param right right vector to minimize
  3652. * @returns a new vector with the minimum of the left and right vector values
  3653. */
  3654. static Minimize(left: DeepImmutable<Vector4>, right: DeepImmutable<Vector4>): Vector4;
  3655. /**
  3656. * Returns a vector with the maximum values from the left and right vectors
  3657. * @param left left vector to maximize
  3658. * @param right right vector to maximize
  3659. * @returns a new vector with the maximum of the left and right vector values
  3660. */
  3661. static Maximize(left: DeepImmutable<Vector4>, right: DeepImmutable<Vector4>): Vector4;
  3662. /**
  3663. * Returns the distance (float) between the vectors "value1" and "value2".
  3664. * @param value1 value to calulate the distance between
  3665. * @param value2 value to calulate the distance between
  3666. * @return the distance between the two vectors
  3667. */
  3668. static Distance(value1: DeepImmutable<Vector4>, value2: DeepImmutable<Vector4>): number;
  3669. /**
  3670. * Returns the squared distance (float) between the vectors "value1" and "value2".
  3671. * @param value1 value to calulate the distance between
  3672. * @param value2 value to calulate the distance between
  3673. * @return the distance between the two vectors squared
  3674. */
  3675. static DistanceSquared(value1: DeepImmutable<Vector4>, value2: DeepImmutable<Vector4>): number;
  3676. /**
  3677. * Returns a new Vector4 located at the center between the vectors "value1" and "value2".
  3678. * @param value1 value to calulate the center between
  3679. * @param value2 value to calulate the center between
  3680. * @return the center between the two vectors
  3681. */
  3682. static Center(value1: DeepImmutable<Vector4>, value2: DeepImmutable<Vector4>): Vector4;
  3683. /**
  3684. * Returns a new Vector4 set with the result of the normal transformation by the given matrix of the given vector.
  3685. * This methods computes transformed normalized direction vectors only.
  3686. * @param vector the vector to transform
  3687. * @param transformation the transformation matrix to apply
  3688. * @returns the new vector
  3689. */
  3690. static TransformNormal(vector: DeepImmutable<Vector4>, transformation: DeepImmutable<Matrix>): Vector4;
  3691. /**
  3692. * Sets the given vector "result" with the result of the normal transformation by the given matrix of the given vector.
  3693. * This methods computes transformed normalized direction vectors only.
  3694. * @param vector the vector to transform
  3695. * @param transformation the transformation matrix to apply
  3696. * @param result the vector to store the result in
  3697. */
  3698. static TransformNormalToRef(vector: DeepImmutable<Vector4>, transformation: DeepImmutable<Matrix>, result: Vector4): void;
  3699. /**
  3700. * Sets the given vector "result" with the result of the normal transformation by the given matrix of the given floats (x, y, z, w).
  3701. * This methods computes transformed normalized direction vectors only.
  3702. * @param x value to transform
  3703. * @param y value to transform
  3704. * @param z value to transform
  3705. * @param w value to transform
  3706. * @param transformation the transformation matrix to apply
  3707. * @param result the vector to store the results in
  3708. */
  3709. static TransformNormalFromFloatsToRef(x: number, y: number, z: number, w: number, transformation: DeepImmutable<Matrix>, result: Vector4): void;
  3710. /**
  3711. * Creates a new Vector4 from a Vector3
  3712. * @param source defines the source data
  3713. * @param w defines the 4th component (default is 0)
  3714. * @returns a new Vector4
  3715. */
  3716. static FromVector3(source: Vector3, w?: number): Vector4;
  3717. }
  3718. /**
  3719. * Class used to store quaternion data
  3720. * @see https://en.wikipedia.org/wiki/Quaternion
  3721. * @see https://doc.babylonjs.com/features/position,_rotation,_scaling
  3722. */
  3723. export class Quaternion {
  3724. /** @hidden */
  3725. _x: number;
  3726. /** @hidden */
  3727. _y: number;
  3728. /** @hidden */
  3729. _z: number;
  3730. /** @hidden */
  3731. _w: number;
  3732. /** @hidden */
  3733. _isDirty: boolean;
  3734. /** Gets or sets the x coordinate */
  3735. get x(): number;
  3736. set x(value: number);
  3737. /** Gets or sets the y coordinate */
  3738. get y(): number;
  3739. set y(value: number);
  3740. /** Gets or sets the z coordinate */
  3741. get z(): number;
  3742. set z(value: number);
  3743. /** Gets or sets the w coordinate */
  3744. get w(): number;
  3745. set w(value: number);
  3746. /**
  3747. * Creates a new Quaternion from the given floats
  3748. * @param x defines the first component (0 by default)
  3749. * @param y defines the second component (0 by default)
  3750. * @param z defines the third component (0 by default)
  3751. * @param w defines the fourth component (1.0 by default)
  3752. */
  3753. constructor(x?: number, y?: number, z?: number, w?: number);
  3754. /**
  3755. * Gets a string representation for the current quaternion
  3756. * @returns a string with the Quaternion coordinates
  3757. */
  3758. toString(): string;
  3759. /**
  3760. * Gets the class name of the quaternion
  3761. * @returns the string "Quaternion"
  3762. */
  3763. getClassName(): string;
  3764. /**
  3765. * Gets a hash code for this quaternion
  3766. * @returns the quaternion hash code
  3767. */
  3768. getHashCode(): number;
  3769. /**
  3770. * Copy the quaternion to an array
  3771. * @returns a new array populated with 4 elements from the quaternion coordinates
  3772. */
  3773. asArray(): number[];
  3774. /**
  3775. * Check if two quaternions are equals
  3776. * @param otherQuaternion defines the second operand
  3777. * @return true if the current quaternion and the given one coordinates are strictly equals
  3778. */
  3779. equals(otherQuaternion: DeepImmutable<Quaternion>): boolean;
  3780. /**
  3781. * Gets a boolean if two quaternions are equals (using an epsilon value)
  3782. * @param otherQuaternion defines the other quaternion
  3783. * @param epsilon defines the minimal distance to consider equality
  3784. * @returns true if the given quaternion coordinates are close to the current ones by a distance of epsilon.
  3785. */
  3786. equalsWithEpsilon(otherQuaternion: DeepImmutable<Quaternion>, epsilon?: number): boolean;
  3787. /**
  3788. * Clone the current quaternion
  3789. * @returns a new quaternion copied from the current one
  3790. */
  3791. clone(): Quaternion;
  3792. /**
  3793. * Copy a quaternion to the current one
  3794. * @param other defines the other quaternion
  3795. * @returns the updated current quaternion
  3796. */
  3797. copyFrom(other: DeepImmutable<Quaternion>): Quaternion;
  3798. /**
  3799. * Updates the current quaternion with the given float coordinates
  3800. * @param x defines the x coordinate
  3801. * @param y defines the y coordinate
  3802. * @param z defines the z coordinate
  3803. * @param w defines the w coordinate
  3804. * @returns the updated current quaternion
  3805. */
  3806. copyFromFloats(x: number, y: number, z: number, w: number): Quaternion;
  3807. /**
  3808. * Updates the current quaternion from the given float coordinates
  3809. * @param x defines the x coordinate
  3810. * @param y defines the y coordinate
  3811. * @param z defines the z coordinate
  3812. * @param w defines the w coordinate
  3813. * @returns the updated current quaternion
  3814. */
  3815. set(x: number, y: number, z: number, w: number): Quaternion;
  3816. /**
  3817. * Adds two quaternions
  3818. * @param other defines the second operand
  3819. * @returns a new quaternion as the addition result of the given one and the current quaternion
  3820. */
  3821. add(other: DeepImmutable<Quaternion>): Quaternion;
  3822. /**
  3823. * Add a quaternion to the current one
  3824. * @param other defines the quaternion to add
  3825. * @returns the current quaternion
  3826. */
  3827. addInPlace(other: DeepImmutable<Quaternion>): Quaternion;
  3828. /**
  3829. * Subtract two quaternions
  3830. * @param other defines the second operand
  3831. * @returns a new quaternion as the subtraction result of the given one from the current one
  3832. */
  3833. subtract(other: Quaternion): Quaternion;
  3834. /**
  3835. * Multiplies the current quaternion by a scale factor
  3836. * @param value defines the scale factor
  3837. * @returns a new quaternion set by multiplying the current quaternion coordinates by the float "scale"
  3838. */
  3839. scale(value: number): Quaternion;
  3840. /**
  3841. * Scale the current quaternion values by a factor and stores the result to a given quaternion
  3842. * @param scale defines the scale factor
  3843. * @param result defines the Quaternion object where to store the result
  3844. * @returns the unmodified current quaternion
  3845. */
  3846. scaleToRef(scale: number, result: Quaternion): Quaternion;
  3847. /**
  3848. * Multiplies in place the current quaternion by a scale factor
  3849. * @param value defines the scale factor
  3850. * @returns the current modified quaternion
  3851. */
  3852. scaleInPlace(value: number): Quaternion;
  3853. /**
  3854. * Scale the current quaternion values by a factor and add the result to a given quaternion
  3855. * @param scale defines the scale factor
  3856. * @param result defines the Quaternion object where to store the result
  3857. * @returns the unmodified current quaternion
  3858. */
  3859. scaleAndAddToRef(scale: number, result: Quaternion): Quaternion;
  3860. /**
  3861. * Multiplies two quaternions
  3862. * @param q1 defines the second operand
  3863. * @returns a new quaternion set as the multiplication result of the current one with the given one "q1"
  3864. */
  3865. multiply(q1: DeepImmutable<Quaternion>): Quaternion;
  3866. /**
  3867. * Sets the given "result" as the the multiplication result of the current one with the given one "q1"
  3868. * @param q1 defines the second operand
  3869. * @param result defines the target quaternion
  3870. * @returns the current quaternion
  3871. */
  3872. multiplyToRef(q1: DeepImmutable<Quaternion>, result: Quaternion): Quaternion;
  3873. /**
  3874. * Updates the current quaternion with the multiplication of itself with the given one "q1"
  3875. * @param q1 defines the second operand
  3876. * @returns the currentupdated quaternion
  3877. */
  3878. multiplyInPlace(q1: DeepImmutable<Quaternion>): Quaternion;
  3879. /**
  3880. * Conjugates (1-q) the current quaternion and stores the result in the given quaternion
  3881. * @param ref defines the target quaternion
  3882. * @returns the current quaternion
  3883. */
  3884. conjugateToRef(ref: Quaternion): Quaternion;
  3885. /**
  3886. * Conjugates in place (1-q) the current quaternion
  3887. * @returns the current updated quaternion
  3888. */
  3889. conjugateInPlace(): Quaternion;
  3890. /**
  3891. * Conjugates in place (1-q) the current quaternion
  3892. * @returns a new quaternion
  3893. */
  3894. conjugate(): Quaternion;
  3895. /**
  3896. * Gets length of current quaternion
  3897. * @returns the quaternion length (float)
  3898. */
  3899. length(): number;
  3900. /**
  3901. * Normalize in place the current quaternion
  3902. * @returns the current updated quaternion
  3903. */
  3904. normalize(): Quaternion;
  3905. /**
  3906. * Returns a new Vector3 set with the Euler angles translated from the current quaternion
  3907. * @param order is a reserved parameter and is ignored for now
  3908. * @returns a new Vector3 containing the Euler angles
  3909. */
  3910. toEulerAngles(order?: string): Vector3;
  3911. /**
  3912. * Sets the given vector3 "result" with the Euler angles translated from the current quaternion
  3913. * @param result defines the vector which will be filled with the Euler angles
  3914. * @returns the current unchanged quaternion
  3915. */
  3916. toEulerAnglesToRef(result: Vector3): Quaternion;
  3917. /**
  3918. * Updates the given rotation matrix with the current quaternion values
  3919. * @param result defines the target matrix
  3920. * @returns the current unchanged quaternion
  3921. */
  3922. toRotationMatrix(result: Matrix): Quaternion;
  3923. /**
  3924. * Updates the current quaternion from the given rotation matrix values
  3925. * @param matrix defines the source matrix
  3926. * @returns the current updated quaternion
  3927. */
  3928. fromRotationMatrix(matrix: DeepImmutable<Matrix>): Quaternion;
  3929. /**
  3930. * Creates a new quaternion from a rotation matrix
  3931. * @param matrix defines the source matrix
  3932. * @returns a new quaternion created from the given rotation matrix values
  3933. */
  3934. static FromRotationMatrix(matrix: DeepImmutable<Matrix>): Quaternion;
  3935. /**
  3936. * Updates the given quaternion with the given rotation matrix values
  3937. * @param matrix defines the source matrix
  3938. * @param result defines the target quaternion
  3939. */
  3940. static FromRotationMatrixToRef(matrix: DeepImmutable<Matrix>, result: Quaternion): void;
  3941. /**
  3942. * Returns the dot product (float) between the quaternions "left" and "right"
  3943. * @param left defines the left operand
  3944. * @param right defines the right operand
  3945. * @returns the dot product
  3946. */
  3947. static Dot(left: DeepImmutable<Quaternion>, right: DeepImmutable<Quaternion>): number;
  3948. /**
  3949. * Checks if the two quaternions are close to each other
  3950. * @param quat0 defines the first quaternion to check
  3951. * @param quat1 defines the second quaternion to check
  3952. * @returns true if the two quaternions are close to each other
  3953. */
  3954. static AreClose(quat0: DeepImmutable<Quaternion>, quat1: DeepImmutable<Quaternion>): boolean;
  3955. /**
  3956. * Creates an empty quaternion
  3957. * @returns a new quaternion set to (0.0, 0.0, 0.0)
  3958. */
  3959. static Zero(): Quaternion;
  3960. /**
  3961. * Inverse a given quaternion
  3962. * @param q defines the source quaternion
  3963. * @returns a new quaternion as the inverted current quaternion
  3964. */
  3965. static Inverse(q: DeepImmutable<Quaternion>): Quaternion;
  3966. /**
  3967. * Inverse a given quaternion
  3968. * @param q defines the source quaternion
  3969. * @param result the quaternion the result will be stored in
  3970. * @returns the result quaternion
  3971. */
  3972. static InverseToRef(q: Quaternion, result: Quaternion): Quaternion;
  3973. /**
  3974. * Creates an identity quaternion
  3975. * @returns the identity quaternion
  3976. */
  3977. static Identity(): Quaternion;
  3978. /**
  3979. * Gets a boolean indicating if the given quaternion is identity
  3980. * @param quaternion defines the quaternion to check
  3981. * @returns true if the quaternion is identity
  3982. */
  3983. static IsIdentity(quaternion: DeepImmutable<Quaternion>): boolean;
  3984. /**
  3985. * Creates a quaternion from a rotation around an axis
  3986. * @param axis defines the axis to use
  3987. * @param angle defines the angle to use
  3988. * @returns a new quaternion created from the given axis (Vector3) and angle in radians (float)
  3989. */
  3990. static RotationAxis(axis: DeepImmutable<Vector3>, angle: number): Quaternion;
  3991. /**
  3992. * Creates a rotation around an axis and stores it into the given quaternion
  3993. * @param axis defines the axis to use
  3994. * @param angle defines the angle to use
  3995. * @param result defines the target quaternion
  3996. * @returns the target quaternion
  3997. */
  3998. static RotationAxisToRef(axis: DeepImmutable<Vector3>, angle: number, result: Quaternion): Quaternion;
  3999. /**
  4000. * Creates a new quaternion from data stored into an array
  4001. * @param array defines the data source
  4002. * @param offset defines the offset in the source array where the data starts
  4003. * @returns a new quaternion
  4004. */
  4005. static FromArray(array: DeepImmutable<ArrayLike<number>>, offset?: number): Quaternion;
  4006. /**
  4007. * Updates the given quaternion "result" from the starting index of the given array.
  4008. * @param array the array to pull values from
  4009. * @param offset the offset into the array to start at
  4010. * @param result the quaternion to store the result in
  4011. */
  4012. static FromArrayToRef(array: DeepImmutable<ArrayLike<number>>, offset: number, result: Quaternion): void;
  4013. /**
  4014. * Create a quaternion from Euler rotation angles
  4015. * @param x Pitch
  4016. * @param y Yaw
  4017. * @param z Roll
  4018. * @returns the new Quaternion
  4019. */
  4020. static FromEulerAngles(x: number, y: number, z: number): Quaternion;
  4021. /**
  4022. * Updates a quaternion from Euler rotation angles
  4023. * @param x Pitch
  4024. * @param y Yaw
  4025. * @param z Roll
  4026. * @param result the quaternion to store the result
  4027. * @returns the updated quaternion
  4028. */
  4029. static FromEulerAnglesToRef(x: number, y: number, z: number, result: Quaternion): Quaternion;
  4030. /**
  4031. * Create a quaternion from Euler rotation vector
  4032. * @param vec the Euler vector (x Pitch, y Yaw, z Roll)
  4033. * @returns the new Quaternion
  4034. */
  4035. static FromEulerVector(vec: DeepImmutable<Vector3>): Quaternion;
  4036. /**
  4037. * Updates a quaternion from Euler rotation vector
  4038. * @param vec the Euler vector (x Pitch, y Yaw, z Roll)
  4039. * @param result the quaternion to store the result
  4040. * @returns the updated quaternion
  4041. */
  4042. static FromEulerVectorToRef(vec: DeepImmutable<Vector3>, result: Quaternion): Quaternion;
  4043. /**
  4044. * Creates a new quaternion from the given Euler float angles (y, x, z)
  4045. * @param yaw defines the rotation around Y axis
  4046. * @param pitch defines the rotation around X axis
  4047. * @param roll defines the rotation around Z axis
  4048. * @returns the new quaternion
  4049. */
  4050. static RotationYawPitchRoll(yaw: number, pitch: number, roll: number): Quaternion;
  4051. /**
  4052. * Creates a new rotation from the given Euler float angles (y, x, z) and stores it in the target quaternion
  4053. * @param yaw defines the rotation around Y axis
  4054. * @param pitch defines the rotation around X axis
  4055. * @param roll defines the rotation around Z axis
  4056. * @param result defines the target quaternion
  4057. */
  4058. static RotationYawPitchRollToRef(yaw: number, pitch: number, roll: number, result: Quaternion): void;
  4059. /**
  4060. * Creates a new quaternion from the given Euler float angles expressed in z-x-z orientation
  4061. * @param alpha defines the rotation around first axis
  4062. * @param beta defines the rotation around second axis
  4063. * @param gamma defines the rotation around third axis
  4064. * @returns the new quaternion
  4065. */
  4066. static RotationAlphaBetaGamma(alpha: number, beta: number, gamma: number): Quaternion;
  4067. /**
  4068. * Creates a new quaternion from the given Euler float angles expressed in z-x-z orientation and stores it in the target quaternion
  4069. * @param alpha defines the rotation around first axis
  4070. * @param beta defines the rotation around second axis
  4071. * @param gamma defines the rotation around third axis
  4072. * @param result defines the target quaternion
  4073. */
  4074. static RotationAlphaBetaGammaToRef(alpha: number, beta: number, gamma: number, result: Quaternion): void;
  4075. /**
  4076. * 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)
  4077. * @param axis1 defines the first axis
  4078. * @param axis2 defines the second axis
  4079. * @param axis3 defines the third axis
  4080. * @returns the new quaternion
  4081. */
  4082. static RotationQuaternionFromAxis(axis1: DeepImmutable<Vector3>, axis2: DeepImmutable<Vector3>, axis3: DeepImmutable<Vector3>): Quaternion;
  4083. /**
  4084. * 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
  4085. * @param axis1 defines the first axis
  4086. * @param axis2 defines the second axis
  4087. * @param axis3 defines the third axis
  4088. * @param ref defines the target quaternion
  4089. */
  4090. static RotationQuaternionFromAxisToRef(axis1: DeepImmutable<Vector3>, axis2: DeepImmutable<Vector3>, axis3: DeepImmutable<Vector3>, ref: Quaternion): void;
  4091. /**
  4092. * Interpolates between two quaternions
  4093. * @param left defines first quaternion
  4094. * @param right defines second quaternion
  4095. * @param amount defines the gradient to use
  4096. * @returns the new interpolated quaternion
  4097. */
  4098. static Slerp(left: DeepImmutable<Quaternion>, right: DeepImmutable<Quaternion>, amount: number): Quaternion;
  4099. /**
  4100. * Interpolates between two quaternions and stores it into a target quaternion
  4101. * @param left defines first quaternion
  4102. * @param right defines second quaternion
  4103. * @param amount defines the gradient to use
  4104. * @param result defines the target quaternion
  4105. */
  4106. static SlerpToRef(left: DeepImmutable<Quaternion>, right: DeepImmutable<Quaternion>, amount: number, result: Quaternion): void;
  4107. /**
  4108. * Interpolate between two quaternions using Hermite interpolation
  4109. * @param value1 defines first quaternion
  4110. * @param tangent1 defines the incoming tangent
  4111. * @param value2 defines second quaternion
  4112. * @param tangent2 defines the outgoing tangent
  4113. * @param amount defines the target quaternion
  4114. * @returns the new interpolated quaternion
  4115. */
  4116. static Hermite(value1: DeepImmutable<Quaternion>, tangent1: DeepImmutable<Quaternion>, value2: DeepImmutable<Quaternion>, tangent2: DeepImmutable<Quaternion>, amount: number): Quaternion;
  4117. }
  4118. /**
  4119. * Class used to store matrix data (4x4)
  4120. */
  4121. export class Matrix {
  4122. /**
  4123. * Gets the precision of matrix computations
  4124. */
  4125. static get Use64Bits(): boolean;
  4126. private static _updateFlagSeed;
  4127. private static _identityReadOnly;
  4128. private _isIdentity;
  4129. private _isIdentityDirty;
  4130. private _isIdentity3x2;
  4131. private _isIdentity3x2Dirty;
  4132. /**
  4133. * Gets the update flag of the matrix which is an unique number for the matrix.
  4134. * It will be incremented every time the matrix data change.
  4135. * You can use it to speed the comparison between two versions of the same matrix.
  4136. */
  4137. updateFlag: number;
  4138. private readonly _m;
  4139. /**
  4140. * Gets the internal data of the matrix
  4141. */
  4142. get m(): DeepImmutable<Float32Array | Array<number>>;
  4143. /** @hidden */
  4144. _markAsUpdated(): void;
  4145. /** @hidden */
  4146. private _updateIdentityStatus;
  4147. /**
  4148. * Creates an empty matrix (filled with zeros)
  4149. */
  4150. constructor();
  4151. /**
  4152. * Check if the current matrix is identity
  4153. * @returns true is the matrix is the identity matrix
  4154. */
  4155. isIdentity(): boolean;
  4156. /**
  4157. * Check if the current matrix is identity as a texture matrix (3x2 store in 4x4)
  4158. * @returns true is the matrix is the identity matrix
  4159. */
  4160. isIdentityAs3x2(): boolean;
  4161. /**
  4162. * Gets the determinant of the matrix
  4163. * @returns the matrix determinant
  4164. */
  4165. determinant(): number;
  4166. /**
  4167. * Returns the matrix as a Float32Array or Array<number>
  4168. * @returns the matrix underlying array
  4169. */
  4170. toArray(): DeepImmutable<Float32Array | Array<number>>;
  4171. /**
  4172. * Returns the matrix as a Float32Array or Array<number>
  4173. * @returns the matrix underlying array.
  4174. */
  4175. asArray(): DeepImmutable<Float32Array | Array<number>>;
  4176. /**
  4177. * Inverts the current matrix in place
  4178. * @returns the current inverted matrix
  4179. */
  4180. invert(): Matrix;
  4181. /**
  4182. * Sets all the matrix elements to zero
  4183. * @returns the current matrix
  4184. */
  4185. reset(): Matrix;
  4186. /**
  4187. * Adds the current matrix with a second one
  4188. * @param other defines the matrix to add
  4189. * @returns a new matrix as the addition of the current matrix and the given one
  4190. */
  4191. add(other: DeepImmutable<Matrix>): Matrix;
  4192. /**
  4193. * Sets the given matrix "result" to the addition of the current matrix and the given one
  4194. * @param other defines the matrix to add
  4195. * @param result defines the target matrix
  4196. * @returns the current matrix
  4197. */
  4198. addToRef(other: DeepImmutable<Matrix>, result: Matrix): Matrix;
  4199. /**
  4200. * Adds in place the given matrix to the current matrix
  4201. * @param other defines the second operand
  4202. * @returns the current updated matrix
  4203. */
  4204. addToSelf(other: DeepImmutable<Matrix>): Matrix;
  4205. /**
  4206. * Sets the given matrix to the current inverted Matrix
  4207. * @param other defines the target matrix
  4208. * @returns the unmodified current matrix
  4209. */
  4210. invertToRef(other: Matrix): Matrix;
  4211. /**
  4212. * add a value at the specified position in the current Matrix
  4213. * @param index the index of the value within the matrix. between 0 and 15.
  4214. * @param value the value to be added
  4215. * @returns the current updated matrix
  4216. */
  4217. addAtIndex(index: number, value: number): Matrix;
  4218. /**
  4219. * mutiply the specified position in the current Matrix by a value
  4220. * @param index the index of the value within the matrix. between 0 and 15.
  4221. * @param value the value to be added
  4222. * @returns the current updated matrix
  4223. */
  4224. multiplyAtIndex(index: number, value: number): Matrix;
  4225. /**
  4226. * Inserts the translation vector (using 3 floats) in the current matrix
  4227. * @param x defines the 1st component of the translation
  4228. * @param y defines the 2nd component of the translation
  4229. * @param z defines the 3rd component of the translation
  4230. * @returns the current updated matrix
  4231. */
  4232. setTranslationFromFloats(x: number, y: number, z: number): Matrix;
  4233. /**
  4234. * Adds the translation vector (using 3 floats) in the current matrix
  4235. * @param x defines the 1st component of the translation
  4236. * @param y defines the 2nd component of the translation
  4237. * @param z defines the 3rd component of the translation
  4238. * @returns the current updated matrix
  4239. */
  4240. addTranslationFromFloats(x: number, y: number, z: number): Matrix;
  4241. /**
  4242. * Inserts the translation vector in the current matrix
  4243. * @param vector3 defines the translation to insert
  4244. * @returns the current updated matrix
  4245. */
  4246. setTranslation(vector3: DeepImmutable<Vector3>): Matrix;
  4247. /**
  4248. * Gets the translation value of the current matrix
  4249. * @returns a new Vector3 as the extracted translation from the matrix
  4250. */
  4251. getTranslation(): Vector3;
  4252. /**
  4253. * Fill a Vector3 with the extracted translation from the matrix
  4254. * @param result defines the Vector3 where to store the translation
  4255. * @returns the current matrix
  4256. */
  4257. getTranslationToRef(result: Vector3): Matrix;
  4258. /**
  4259. * Remove rotation and scaling part from the matrix
  4260. * @returns the updated matrix
  4261. */
  4262. removeRotationAndScaling(): Matrix;
  4263. /**
  4264. * Multiply two matrices
  4265. * @param other defines the second operand
  4266. * @returns a new matrix set with the multiplication result of the current Matrix and the given one
  4267. */
  4268. multiply(other: DeepImmutable<Matrix>): Matrix;
  4269. /**
  4270. * Copy the current matrix from the given one
  4271. * @param other defines the source matrix
  4272. * @returns the current updated matrix
  4273. */
  4274. copyFrom(other: DeepImmutable<Matrix>): Matrix;
  4275. /**
  4276. * Populates the given array from the starting index with the current matrix values
  4277. * @param array defines the target array
  4278. * @param offset defines the offset in the target array where to start storing values
  4279. * @returns the current matrix
  4280. */
  4281. copyToArray(array: Float32Array | Array<number>, offset?: number): Matrix;
  4282. /**
  4283. * Sets the given matrix "result" with the multiplication result of the current Matrix and the given one
  4284. * @param other defines the second operand
  4285. * @param result defines the matrix where to store the multiplication
  4286. * @returns the current matrix
  4287. */
  4288. multiplyToRef(other: DeepImmutable<Matrix>, result: Matrix): Matrix;
  4289. /**
  4290. * Sets the Float32Array "result" from the given index "offset" with the multiplication of the current matrix and the given one
  4291. * @param other defines the second operand
  4292. * @param result defines the array where to store the multiplication
  4293. * @param offset defines the offset in the target array where to start storing values
  4294. * @returns the current matrix
  4295. */
  4296. multiplyToArray(other: DeepImmutable<Matrix>, result: Float32Array | Array<number>, offset: number): Matrix;
  4297. /**
  4298. * Check equality between this matrix and a second one
  4299. * @param value defines the second matrix to compare
  4300. * @returns true is the current matrix and the given one values are strictly equal
  4301. */
  4302. equals(value: DeepImmutable<Matrix>): boolean;
  4303. /**
  4304. * Clone the current matrix
  4305. * @returns a new matrix from the current matrix
  4306. */
  4307. clone(): Matrix;
  4308. /**
  4309. * Returns the name of the current matrix class
  4310. * @returns the string "Matrix"
  4311. */
  4312. getClassName(): string;
  4313. /**
  4314. * Gets the hash code of the current matrix
  4315. * @returns the hash code
  4316. */
  4317. getHashCode(): number;
  4318. /**
  4319. * Decomposes the current Matrix into a translation, rotation and scaling components
  4320. * @param scale defines the scale vector3 given as a reference to update
  4321. * @param rotation defines the rotation quaternion given as a reference to update
  4322. * @param translation defines the translation vector3 given as a reference to update
  4323. * @returns true if operation was successful
  4324. */
  4325. decompose(scale?: Vector3, rotation?: Quaternion, translation?: Vector3): boolean;
  4326. /**
  4327. * Gets specific row of the matrix
  4328. * @param index defines the number of the row to get
  4329. * @returns the index-th row of the current matrix as a new Vector4
  4330. */
  4331. getRow(index: number): Nullable<Vector4>;
  4332. /**
  4333. * Sets the index-th row of the current matrix to the vector4 values
  4334. * @param index defines the number of the row to set
  4335. * @param row defines the target vector4
  4336. * @returns the updated current matrix
  4337. */
  4338. setRow(index: number, row: Vector4): Matrix;
  4339. /**
  4340. * Compute the transpose of the matrix
  4341. * @returns the new transposed matrix
  4342. */
  4343. transpose(): Matrix;
  4344. /**
  4345. * Compute the transpose of the matrix and store it in a given matrix
  4346. * @param result defines the target matrix
  4347. * @returns the current matrix
  4348. */
  4349. transposeToRef(result: Matrix): Matrix;
  4350. /**
  4351. * Sets the index-th row of the current matrix with the given 4 x float values
  4352. * @param index defines the row index
  4353. * @param x defines the x component to set
  4354. * @param y defines the y component to set
  4355. * @param z defines the z component to set
  4356. * @param w defines the w component to set
  4357. * @returns the updated current matrix
  4358. */
  4359. setRowFromFloats(index: number, x: number, y: number, z: number, w: number): Matrix;
  4360. /**
  4361. * Compute a new matrix set with the current matrix values multiplied by scale (float)
  4362. * @param scale defines the scale factor
  4363. * @returns a new matrix
  4364. */
  4365. scale(scale: number): Matrix;
  4366. /**
  4367. * Scale the current matrix values by a factor to a given result matrix
  4368. * @param scale defines the scale factor
  4369. * @param result defines the matrix to store the result
  4370. * @returns the current matrix
  4371. */
  4372. scaleToRef(scale: number, result: Matrix): Matrix;
  4373. /**
  4374. * Scale the current matrix values by a factor and add the result to a given matrix
  4375. * @param scale defines the scale factor
  4376. * @param result defines the Matrix to store the result
  4377. * @returns the current matrix
  4378. */
  4379. scaleAndAddToRef(scale: number, result: Matrix): Matrix;
  4380. /**
  4381. * Writes to the given matrix a normal matrix, computed from this one (using values from identity matrix for fourth row and column).
  4382. * @param ref matrix to store the result
  4383. */
  4384. toNormalMatrix(ref: Matrix): void;
  4385. /**
  4386. * Gets only rotation part of the current matrix
  4387. * @returns a new matrix sets to the extracted rotation matrix from the current one
  4388. */
  4389. getRotationMatrix(): Matrix;
  4390. /**
  4391. * Extracts the rotation matrix from the current one and sets it as the given "result"
  4392. * @param result defines the target matrix to store data to
  4393. * @returns the current matrix
  4394. */
  4395. getRotationMatrixToRef(result: Matrix): Matrix;
  4396. /**
  4397. * Toggles model matrix from being right handed to left handed in place and vice versa
  4398. */
  4399. toggleModelMatrixHandInPlace(): void;
  4400. /**
  4401. * Toggles projection matrix from being right handed to left handed in place and vice versa
  4402. */
  4403. toggleProjectionMatrixHandInPlace(): void;
  4404. /**
  4405. * Creates a matrix from an array
  4406. * @param array defines the source array
  4407. * @param offset defines an offset in the source array
  4408. * @returns a new Matrix set from the starting index of the given array
  4409. */
  4410. static FromArray(array: DeepImmutable<ArrayLike<number>>, offset?: number): Matrix;
  4411. /**
  4412. * Copy the content of an array into a given matrix
  4413. * @param array defines the source array
  4414. * @param offset defines an offset in the source array
  4415. * @param result defines the target matrix
  4416. */
  4417. static FromArrayToRef(array: DeepImmutable<ArrayLike<number>>, offset: number, result: Matrix): void;
  4418. /**
  4419. * Stores an array into a matrix after having multiplied each component by a given factor
  4420. * @param array defines the source array
  4421. * @param offset defines the offset in the source array
  4422. * @param scale defines the scaling factor
  4423. * @param result defines the target matrix
  4424. */
  4425. static FromFloat32ArrayToRefScaled(array: DeepImmutable<Float32Array | Array<number>>, offset: number, scale: number, result: Matrix): void;
  4426. /**
  4427. * Gets an identity matrix that must not be updated
  4428. */
  4429. static get IdentityReadOnly(): DeepImmutable<Matrix>;
  4430. /**
  4431. * Stores a list of values (16) inside a given matrix
  4432. * @param initialM11 defines 1st value of 1st row
  4433. * @param initialM12 defines 2nd value of 1st row
  4434. * @param initialM13 defines 3rd value of 1st row
  4435. * @param initialM14 defines 4th value of 1st row
  4436. * @param initialM21 defines 1st value of 2nd row
  4437. * @param initialM22 defines 2nd value of 2nd row
  4438. * @param initialM23 defines 3rd value of 2nd row
  4439. * @param initialM24 defines 4th value of 2nd row
  4440. * @param initialM31 defines 1st value of 3rd row
  4441. * @param initialM32 defines 2nd value of 3rd row
  4442. * @param initialM33 defines 3rd value of 3rd row
  4443. * @param initialM34 defines 4th value of 3rd row
  4444. * @param initialM41 defines 1st value of 4th row
  4445. * @param initialM42 defines 2nd value of 4th row
  4446. * @param initialM43 defines 3rd value of 4th row
  4447. * @param initialM44 defines 4th value of 4th row
  4448. * @param result defines the target matrix
  4449. */
  4450. 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;
  4451. /**
  4452. * Creates new matrix from a list of values (16)
  4453. * @param initialM11 defines 1st value of 1st row
  4454. * @param initialM12 defines 2nd value of 1st row
  4455. * @param initialM13 defines 3rd value of 1st row
  4456. * @param initialM14 defines 4th value of 1st row
  4457. * @param initialM21 defines 1st value of 2nd row
  4458. * @param initialM22 defines 2nd value of 2nd row
  4459. * @param initialM23 defines 3rd value of 2nd row
  4460. * @param initialM24 defines 4th value of 2nd row
  4461. * @param initialM31 defines 1st value of 3rd row
  4462. * @param initialM32 defines 2nd value of 3rd row
  4463. * @param initialM33 defines 3rd value of 3rd row
  4464. * @param initialM34 defines 4th value of 3rd row
  4465. * @param initialM41 defines 1st value of 4th row
  4466. * @param initialM42 defines 2nd value of 4th row
  4467. * @param initialM43 defines 3rd value of 4th row
  4468. * @param initialM44 defines 4th value of 4th row
  4469. * @returns the new matrix
  4470. */
  4471. 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;
  4472. /**
  4473. * Creates a new matrix composed by merging scale (vector3), rotation (quaternion) and translation (vector3)
  4474. * @param scale defines the scale vector3
  4475. * @param rotation defines the rotation quaternion
  4476. * @param translation defines the translation vector3
  4477. * @returns a new matrix
  4478. */
  4479. static Compose(scale: DeepImmutable<Vector3>, rotation: DeepImmutable<Quaternion>, translation: DeepImmutable<Vector3>): Matrix;
  4480. /**
  4481. * Sets a matrix to a value composed by merging scale (vector3), rotation (quaternion) and translation (vector3)
  4482. * @param scale defines the scale vector3
  4483. * @param rotation defines the rotation quaternion
  4484. * @param translation defines the translation vector3
  4485. * @param result defines the target matrix
  4486. */
  4487. static ComposeToRef(scale: DeepImmutable<Vector3>, rotation: DeepImmutable<Quaternion>, translation: DeepImmutable<Vector3>, result: Matrix): void;
  4488. /**
  4489. * Creates a new identity matrix
  4490. * @returns a new identity matrix
  4491. */
  4492. static Identity(): Matrix;
  4493. /**
  4494. * Creates a new identity matrix and stores the result in a given matrix
  4495. * @param result defines the target matrix
  4496. */
  4497. static IdentityToRef(result: Matrix): void;
  4498. /**
  4499. * Creates a new zero matrix
  4500. * @returns a new zero matrix
  4501. */
  4502. static Zero(): Matrix;
  4503. /**
  4504. * Creates a new rotation matrix for "angle" radians around the X axis
  4505. * @param angle defines the angle (in radians) to use
  4506. * @return the new matrix
  4507. */
  4508. static RotationX(angle: number): Matrix;
  4509. /**
  4510. * Creates a new matrix as the invert of a given matrix
  4511. * @param source defines the source matrix
  4512. * @returns the new matrix
  4513. */
  4514. static Invert(source: DeepImmutable<Matrix>): Matrix;
  4515. /**
  4516. * Creates a new rotation matrix for "angle" radians around the X axis and stores it in a given matrix
  4517. * @param angle defines the angle (in radians) to use
  4518. * @param result defines the target matrix
  4519. */
  4520. static RotationXToRef(angle: number, result: Matrix): void;
  4521. /**
  4522. * Creates a new rotation matrix for "angle" radians around the Y axis
  4523. * @param angle defines the angle (in radians) to use
  4524. * @return the new matrix
  4525. */
  4526. static RotationY(angle: number): Matrix;
  4527. /**
  4528. * Creates a new rotation matrix for "angle" radians around the Y axis and stores it in a given matrix
  4529. * @param angle defines the angle (in radians) to use
  4530. * @param result defines the target matrix
  4531. */
  4532. static RotationYToRef(angle: number, result: Matrix): void;
  4533. /**
  4534. * Creates a new rotation matrix for "angle" radians around the Z axis
  4535. * @param angle defines the angle (in radians) to use
  4536. * @return the new matrix
  4537. */
  4538. static RotationZ(angle: number): Matrix;
  4539. /**
  4540. * Creates a new rotation matrix for "angle" radians around the Z axis and stores it in a given matrix
  4541. * @param angle defines the angle (in radians) to use
  4542. * @param result defines the target matrix
  4543. */
  4544. static RotationZToRef(angle: number, result: Matrix): void;
  4545. /**
  4546. * Creates a new rotation matrix for "angle" radians around the given axis
  4547. * @param axis defines the axis to use
  4548. * @param angle defines the angle (in radians) to use
  4549. * @return the new matrix
  4550. */
  4551. static RotationAxis(axis: DeepImmutable<Vector3>, angle: number): Matrix;
  4552. /**
  4553. * Creates a new rotation matrix for "angle" radians around the given axis and stores it in a given matrix
  4554. * @param axis defines the axis to use
  4555. * @param angle defines the angle (in radians) to use
  4556. * @param result defines the target matrix
  4557. */
  4558. static RotationAxisToRef(axis: DeepImmutable<Vector3>, angle: number, result: Matrix): void;
  4559. /**
  4560. * Takes normalised vectors and returns a rotation matrix to align "from" with "to".
  4561. * Taken from http://www.iquilezles.org/www/articles/noacos/noacos.htm
  4562. * @param from defines the vector to align
  4563. * @param to defines the vector to align to
  4564. * @param result defines the target matrix
  4565. */
  4566. static RotationAlignToRef(from: DeepImmutable<Vector3>, to: DeepImmutable<Vector3>, result: Matrix): void;
  4567. /**
  4568. * Creates a rotation matrix
  4569. * @param yaw defines the yaw angle in radians (Y axis)
  4570. * @param pitch defines the pitch angle in radians (X axis)
  4571. * @param roll defines the roll angle in radians (Z axis)
  4572. * @returns the new rotation matrix
  4573. */
  4574. static RotationYawPitchRoll(yaw: number, pitch: number, roll: number): Matrix;
  4575. /**
  4576. * Creates a rotation matrix and stores it in a given matrix
  4577. * @param yaw defines the yaw angle in radians (Y axis)
  4578. * @param pitch defines the pitch angle in radians (X axis)
  4579. * @param roll defines the roll angle in radians (Z axis)
  4580. * @param result defines the target matrix
  4581. */
  4582. static RotationYawPitchRollToRef(yaw: number, pitch: number, roll: number, result: Matrix): void;
  4583. /**
  4584. * Creates a scaling matrix
  4585. * @param x defines the scale factor on X axis
  4586. * @param y defines the scale factor on Y axis
  4587. * @param z defines the scale factor on Z axis
  4588. * @returns the new matrix
  4589. */
  4590. static Scaling(x: number, y: number, z: number): Matrix;
  4591. /**
  4592. * Creates a scaling matrix and stores it in a given matrix
  4593. * @param x defines the scale factor on X axis
  4594. * @param y defines the scale factor on Y axis
  4595. * @param z defines the scale factor on Z axis
  4596. * @param result defines the target matrix
  4597. */
  4598. static ScalingToRef(x: number, y: number, z: number, result: Matrix): void;
  4599. /**
  4600. * Creates a translation matrix
  4601. * @param x defines the translation on X axis
  4602. * @param y defines the translation on Y axis
  4603. * @param z defines the translationon Z axis
  4604. * @returns the new matrix
  4605. */
  4606. static Translation(x: number, y: number, z: number): Matrix;
  4607. /**
  4608. * Creates a translation matrix and stores it in a given matrix
  4609. * @param x defines the translation on X axis
  4610. * @param y defines the translation on Y axis
  4611. * @param z defines the translationon Z axis
  4612. * @param result defines the target matrix
  4613. */
  4614. static TranslationToRef(x: number, y: number, z: number, result: Matrix): void;
  4615. /**
  4616. * Returns a new Matrix whose values are the interpolated values for "gradient" (float) between the ones of the matrices "startValue" and "endValue".
  4617. * @param startValue defines the start value
  4618. * @param endValue defines the end value
  4619. * @param gradient defines the gradient factor
  4620. * @returns the new matrix
  4621. */
  4622. static Lerp(startValue: DeepImmutable<Matrix>, endValue: DeepImmutable<Matrix>, gradient: number): Matrix;
  4623. /**
  4624. * Set the given matrix "result" as the interpolated values for "gradient" (float) between the ones of the matrices "startValue" and "endValue".
  4625. * @param startValue defines the start value
  4626. * @param endValue defines the end value
  4627. * @param gradient defines the gradient factor
  4628. * @param result defines the Matrix object where to store data
  4629. */
  4630. static LerpToRef(startValue: DeepImmutable<Matrix>, endValue: DeepImmutable<Matrix>, gradient: number, result: Matrix): void;
  4631. /**
  4632. * Builds a new matrix whose values are computed by:
  4633. * * decomposing the the "startValue" and "endValue" matrices into their respective scale, rotation and translation matrices
  4634. * * interpolating for "gradient" (float) the values between each of these decomposed matrices between the start and the end
  4635. * * recomposing a new matrix from these 3 interpolated scale, rotation and translation matrices
  4636. * @param startValue defines the first matrix
  4637. * @param endValue defines the second matrix
  4638. * @param gradient defines the gradient between the two matrices
  4639. * @returns the new matrix
  4640. */
  4641. static DecomposeLerp(startValue: DeepImmutable<Matrix>, endValue: DeepImmutable<Matrix>, gradient: number): Matrix;
  4642. /**
  4643. * Update a matrix to values which are computed by:
  4644. * * decomposing the the "startValue" and "endValue" matrices into their respective scale, rotation and translation matrices
  4645. * * interpolating for "gradient" (float) the values between each of these decomposed matrices between the start and the end
  4646. * * recomposing a new matrix from these 3 interpolated scale, rotation and translation matrices
  4647. * @param startValue defines the first matrix
  4648. * @param endValue defines the second matrix
  4649. * @param gradient defines the gradient between the two matrices
  4650. * @param result defines the target matrix
  4651. */
  4652. static DecomposeLerpToRef(startValue: DeepImmutable<Matrix>, endValue: DeepImmutable<Matrix>, gradient: number, result: Matrix): void;
  4653. /**
  4654. * 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"
  4655. * This function works in left handed mode
  4656. * @param eye defines the final position of the entity
  4657. * @param target defines where the entity should look at
  4658. * @param up defines the up vector for the entity
  4659. * @returns the new matrix
  4660. */
  4661. static LookAtLH(eye: DeepImmutable<Vector3>, target: DeepImmutable<Vector3>, up: DeepImmutable<Vector3>): Matrix;
  4662. /**
  4663. * 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".
  4664. * This function works in left handed mode
  4665. * @param eye defines the final position of the entity
  4666. * @param target defines where the entity should look at
  4667. * @param up defines the up vector for the entity
  4668. * @param result defines the target matrix
  4669. */
  4670. static LookAtLHToRef(eye: DeepImmutable<Vector3>, target: DeepImmutable<Vector3>, up: DeepImmutable<Vector3>, result: Matrix): void;
  4671. /**
  4672. * 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"
  4673. * This function works in right handed mode
  4674. * @param eye defines the final position of the entity
  4675. * @param target defines where the entity should look at
  4676. * @param up defines the up vector for the entity
  4677. * @returns the new matrix
  4678. */
  4679. static LookAtRH(eye: DeepImmutable<Vector3>, target: DeepImmutable<Vector3>, up: DeepImmutable<Vector3>): Matrix;
  4680. /**
  4681. * 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".
  4682. * This function works in right handed mode
  4683. * @param eye defines the final position of the entity
  4684. * @param target defines where the entity should look at
  4685. * @param up defines the up vector for the entity
  4686. * @param result defines the target matrix
  4687. */
  4688. static LookAtRHToRef(eye: DeepImmutable<Vector3>, target: DeepImmutable<Vector3>, up: DeepImmutable<Vector3>, result: Matrix): void;
  4689. /**
  4690. * Create a left-handed orthographic projection matrix
  4691. * @param width defines the viewport width
  4692. * @param height defines the viewport height
  4693. * @param znear defines the near clip plane
  4694. * @param zfar defines the far clip plane
  4695. * @returns a new matrix as a left-handed orthographic projection matrix
  4696. */
  4697. static OrthoLH(width: number, height: number, znear: number, zfar: number): Matrix;
  4698. /**
  4699. * Store a left-handed orthographic projection to a given matrix
  4700. * @param width defines the viewport width
  4701. * @param height defines the viewport height
  4702. * @param znear defines the near clip plane
  4703. * @param zfar defines the far clip plane
  4704. * @param result defines the target matrix
  4705. */
  4706. static OrthoLHToRef(width: number, height: number, znear: number, zfar: number, result: Matrix): void;
  4707. /**
  4708. * Create a left-handed orthographic projection matrix
  4709. * @param left defines the viewport left coordinate
  4710. * @param right defines the viewport right coordinate
  4711. * @param bottom defines the viewport bottom coordinate
  4712. * @param top defines the viewport top coordinate
  4713. * @param znear defines the near clip plane
  4714. * @param zfar defines the far clip plane
  4715. * @returns a new matrix as a left-handed orthographic projection matrix
  4716. */
  4717. static OrthoOffCenterLH(left: number, right: number, bottom: number, top: number, znear: number, zfar: number): Matrix;
  4718. /**
  4719. * Stores a left-handed orthographic projection into a given matrix
  4720. * @param left defines the viewport left coordinate
  4721. * @param right defines the viewport right coordinate
  4722. * @param bottom defines the viewport bottom coordinate
  4723. * @param top defines the viewport top coordinate
  4724. * @param znear defines the near clip plane
  4725. * @param zfar defines the far clip plane
  4726. * @param result defines the target matrix
  4727. */
  4728. static OrthoOffCenterLHToRef(left: number, right: number, bottom: number, top: number, znear: number, zfar: number, result: Matrix): void;
  4729. /**
  4730. * Creates a right-handed orthographic projection matrix
  4731. * @param left defines the viewport left coordinate
  4732. * @param right defines the viewport right coordinate
  4733. * @param bottom defines the viewport bottom coordinate
  4734. * @param top defines the viewport top coordinate
  4735. * @param znear defines the near clip plane
  4736. * @param zfar defines the far clip plane
  4737. * @returns a new matrix as a right-handed orthographic projection matrix
  4738. */
  4739. static OrthoOffCenterRH(left: number, right: number, bottom: number, top: number, znear: number, zfar: number): Matrix;
  4740. /**
  4741. * Stores a right-handed orthographic projection into a given matrix
  4742. * @param left defines the viewport left coordinate
  4743. * @param right defines the viewport right coordinate
  4744. * @param bottom defines the viewport bottom coordinate
  4745. * @param top defines the viewport top coordinate
  4746. * @param znear defines the near clip plane
  4747. * @param zfar defines the far clip plane
  4748. * @param result defines the target matrix
  4749. */
  4750. static OrthoOffCenterRHToRef(left: number, right: number, bottom: number, top: number, znear: number, zfar: number, result: Matrix): void;
  4751. /**
  4752. * Creates a left-handed perspective projection matrix
  4753. * @param width defines the viewport width
  4754. * @param height defines the viewport height
  4755. * @param znear defines the near clip plane
  4756. * @param zfar defines the far clip plane
  4757. * @returns a new matrix as a left-handed perspective projection matrix
  4758. */
  4759. static PerspectiveLH(width: number, height: number, znear: number, zfar: number): Matrix;
  4760. /**
  4761. * Creates a left-handed perspective projection 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. * @returns a new matrix as a left-handed perspective projection matrix
  4767. */
  4768. static PerspectiveFovLH(fov: number, aspect: number, znear: number, zfar: number): Matrix;
  4769. /**
  4770. * Stores a left-handed perspective projection into a given matrix
  4771. * @param fov defines the horizontal field of view
  4772. * @param aspect defines the aspect ratio
  4773. * @param znear defines the near clip plane
  4774. * @param zfar defines the far clip plane
  4775. * @param result defines the target matrix
  4776. * @param isVerticalFovFixed defines it the fov is vertically fixed (default) or horizontally
  4777. */
  4778. static PerspectiveFovLHToRef(fov: number, aspect: number, znear: number, zfar: number, result: Matrix, isVerticalFovFixed?: boolean): void;
  4779. /**
  4780. * Stores a left-handed perspective projection into a given matrix with depth reversed
  4781. * @param fov defines the horizontal field of view
  4782. * @param aspect defines the aspect ratio
  4783. * @param znear defines the near clip plane
  4784. * @param zfar not used as infinity is used as far clip
  4785. * @param result defines the target matrix
  4786. * @param isVerticalFovFixed defines it the fov is vertically fixed (default) or horizontally
  4787. */
  4788. static PerspectiveFovReverseLHToRef(fov: number, aspect: number, znear: number, zfar: number, result: Matrix, isVerticalFovFixed?: boolean): void;
  4789. /**
  4790. * Creates a right-handed perspective projection matrix
  4791. * @param fov defines the horizontal field of view
  4792. * @param aspect defines the aspect ratio
  4793. * @param znear defines the near clip plane
  4794. * @param zfar defines the far clip plane
  4795. * @returns a new matrix as a right-handed perspective projection matrix
  4796. */
  4797. static PerspectiveFovRH(fov: number, aspect: number, znear: number, zfar: number): Matrix;
  4798. /**
  4799. * Stores a right-handed perspective projection into a given matrix
  4800. * @param fov defines the horizontal field of view
  4801. * @param aspect defines the aspect ratio
  4802. * @param znear defines the near clip plane
  4803. * @param zfar defines the far clip plane
  4804. * @param result defines the target matrix
  4805. * @param isVerticalFovFixed defines it the fov is vertically fixed (default) or horizontally
  4806. */
  4807. static PerspectiveFovRHToRef(fov: number, aspect: number, znear: number, zfar: number, result: Matrix, isVerticalFovFixed?: boolean): void;
  4808. /**
  4809. * Stores a right-handed perspective projection into a given matrix
  4810. * @param fov defines the horizontal field of view
  4811. * @param aspect defines the aspect ratio
  4812. * @param znear defines the near clip plane
  4813. * @param zfar not used as infinity is used as far clip
  4814. * @param result defines the target matrix
  4815. * @param isVerticalFovFixed defines it the fov is vertically fixed (default) or horizontally
  4816. */
  4817. static PerspectiveFovReverseRHToRef(fov: number, aspect: number, znear: number, zfar: number, result: Matrix, isVerticalFovFixed?: boolean): void;
  4818. /**
  4819. * Stores a perspective projection for WebVR info a given matrix
  4820. * @param fov defines the field of view
  4821. * @param znear defines the near clip plane
  4822. * @param zfar defines the far clip plane
  4823. * @param result defines the target matrix
  4824. * @param rightHanded defines if the matrix must be in right-handed mode (false by default)
  4825. */
  4826. static PerspectiveFovWebVRToRef(fov: {
  4827. upDegrees: number;
  4828. downDegrees: number;
  4829. leftDegrees: number;
  4830. rightDegrees: number;
  4831. }, znear: number, zfar: number, result: Matrix, rightHanded?: boolean): void;
  4832. /**
  4833. * Computes a complete transformation matrix
  4834. * @param viewport defines the viewport to use
  4835. * @param world defines the world matrix
  4836. * @param view defines the view matrix
  4837. * @param projection defines the projection matrix
  4838. * @param zmin defines the near clip plane
  4839. * @param zmax defines the far clip plane
  4840. * @returns the transformation matrix
  4841. */
  4842. static GetFinalMatrix(viewport: DeepImmutable<Viewport>, world: DeepImmutable<Matrix>, view: DeepImmutable<Matrix>, projection: DeepImmutable<Matrix>, zmin: number, zmax: number): Matrix;
  4843. /**
  4844. * Extracts a 2x2 matrix from a given matrix and store the result in a Float32Array
  4845. * @param matrix defines the matrix to use
  4846. * @returns a new Float32Array array with 4 elements : the 2x2 matrix extracted from the given matrix
  4847. */
  4848. static GetAsMatrix2x2(matrix: DeepImmutable<Matrix>): Float32Array | Array<number>;
  4849. /**
  4850. * Extracts a 3x3 matrix from a given matrix and store the result in a Float32Array
  4851. * @param matrix defines the matrix to use
  4852. * @returns a new Float32Array array with 9 elements : the 3x3 matrix extracted from the given matrix
  4853. */
  4854. static GetAsMatrix3x3(matrix: DeepImmutable<Matrix>): Float32Array | Array<number>;
  4855. /**
  4856. * Compute the transpose of a given matrix
  4857. * @param matrix defines the matrix to transpose
  4858. * @returns the new matrix
  4859. */
  4860. static Transpose(matrix: DeepImmutable<Matrix>): Matrix;
  4861. /**
  4862. * Compute the transpose of a matrix and store it in a target matrix
  4863. * @param matrix defines the matrix to transpose
  4864. * @param result defines the target matrix
  4865. */
  4866. static TransposeToRef(matrix: DeepImmutable<Matrix>, result: Matrix): void;
  4867. /**
  4868. * Computes a reflection matrix from a plane
  4869. * @param plane defines the reflection plane
  4870. * @returns a new matrix
  4871. */
  4872. static Reflection(plane: DeepImmutable<IPlaneLike>): Matrix;
  4873. /**
  4874. * Computes a reflection matrix from a plane
  4875. * @param plane defines the reflection plane
  4876. * @param result defines the target matrix
  4877. */
  4878. static ReflectionToRef(plane: DeepImmutable<IPlaneLike>, result: Matrix): void;
  4879. /**
  4880. * Sets the given matrix as a rotation matrix composed from the 3 left handed axes
  4881. * @param xaxis defines the value of the 1st axis
  4882. * @param yaxis defines the value of the 2nd axis
  4883. * @param zaxis defines the value of the 3rd axis
  4884. * @param result defines the target matrix
  4885. */
  4886. static FromXYZAxesToRef(xaxis: DeepImmutable<Vector3>, yaxis: DeepImmutable<Vector3>, zaxis: DeepImmutable<Vector3>, result: Matrix): void;
  4887. /**
  4888. * Creates a rotation matrix from a quaternion and stores it in a target matrix
  4889. * @param quat defines the quaternion to use
  4890. * @param result defines the target matrix
  4891. */
  4892. static FromQuaternionToRef(quat: DeepImmutable<Quaternion>, result: Matrix): void;
  4893. }
  4894. /**
  4895. * @hidden
  4896. */
  4897. export class TmpVectors {
  4898. static Vector2: Vector2[];
  4899. static Vector3: Vector3[];
  4900. static Vector4: Vector4[];
  4901. static Quaternion: Quaternion[];
  4902. static Matrix: Matrix[];
  4903. }
  4904. }
  4905. declare module "babylonjs/Maths/math.path" {
  4906. import { DeepImmutable, Nullable } from "babylonjs/types";
  4907. import { Vector2, Vector3 } from "babylonjs/Maths/math.vector";
  4908. /**
  4909. * Defines potential orientation for back face culling
  4910. */
  4911. export enum Orientation {
  4912. /**
  4913. * Clockwise
  4914. */
  4915. CW = 0,
  4916. /** Counter clockwise */
  4917. CCW = 1
  4918. }
  4919. /** Class used to represent a Bezier curve */
  4920. export class BezierCurve {
  4921. /**
  4922. * Returns the cubic Bezier interpolated value (float) at "t" (float) from the given x1, y1, x2, y2 floats
  4923. * @param t defines the time
  4924. * @param x1 defines the left coordinate on X axis
  4925. * @param y1 defines the left coordinate on Y axis
  4926. * @param x2 defines the right coordinate on X axis
  4927. * @param y2 defines the right coordinate on Y axis
  4928. * @returns the interpolated value
  4929. */
  4930. static Interpolate(t: number, x1: number, y1: number, x2: number, y2: number): number;
  4931. }
  4932. /**
  4933. * Defines angle representation
  4934. */
  4935. export class Angle {
  4936. private _radians;
  4937. /**
  4938. * Creates an Angle object of "radians" radians (float).
  4939. * @param radians the angle in radians
  4940. */
  4941. constructor(radians: number);
  4942. /**
  4943. * Get value in degrees
  4944. * @returns the Angle value in degrees (float)
  4945. */
  4946. degrees(): number;
  4947. /**
  4948. * Get value in radians
  4949. * @returns the Angle value in radians (float)
  4950. */
  4951. radians(): number;
  4952. /**
  4953. * Gets a new Angle object valued with the gradient angle, in radians, of the line joining two points
  4954. * @param a defines first point as the origin
  4955. * @param b defines point
  4956. * @returns a new Angle
  4957. */
  4958. static BetweenTwoPoints(a: DeepImmutable<Vector2>, b: DeepImmutable<Vector2>): Angle;
  4959. /**
  4960. * Gets a new Angle object from the given float in radians
  4961. * @param radians defines the angle value in radians
  4962. * @returns a new Angle
  4963. */
  4964. static FromRadians(radians: number): Angle;
  4965. /**
  4966. * Gets a new Angle object from the given float in degrees
  4967. * @param degrees defines the angle value in degrees
  4968. * @returns a new Angle
  4969. */
  4970. static FromDegrees(degrees: number): Angle;
  4971. }
  4972. /**
  4973. * This represents an arc in a 2d space.
  4974. */
  4975. export class Arc2 {
  4976. /** Defines the start point of the arc */
  4977. startPoint: Vector2;
  4978. /** Defines the mid point of the arc */
  4979. midPoint: Vector2;
  4980. /** Defines the end point of the arc */
  4981. endPoint: Vector2;
  4982. /**
  4983. * Defines the center point of the arc.
  4984. */
  4985. centerPoint: Vector2;
  4986. /**
  4987. * Defines the radius of the arc.
  4988. */
  4989. radius: number;
  4990. /**
  4991. * Defines the angle of the arc (from mid point to end point).
  4992. */
  4993. angle: Angle;
  4994. /**
  4995. * Defines the start angle of the arc (from start point to middle point).
  4996. */
  4997. startAngle: Angle;
  4998. /**
  4999. * Defines the orientation of the arc (clock wise/counter clock wise).
  5000. */
  5001. orientation: Orientation;
  5002. /**
  5003. * Creates an Arc object from the three given points : start, middle and end.
  5004. * @param startPoint Defines the start point of the arc
  5005. * @param midPoint Defines the midlle point of the arc
  5006. * @param endPoint Defines the end point of the arc
  5007. */
  5008. constructor(
  5009. /** Defines the start point of the arc */
  5010. startPoint: Vector2,
  5011. /** Defines the mid point of the arc */
  5012. midPoint: Vector2,
  5013. /** Defines the end point of the arc */
  5014. endPoint: Vector2);
  5015. }
  5016. /**
  5017. * Represents a 2D path made up of multiple 2D points
  5018. */
  5019. export class Path2 {
  5020. private _points;
  5021. private _length;
  5022. /**
  5023. * If the path start and end point are the same
  5024. */
  5025. closed: boolean;
  5026. /**
  5027. * Creates a Path2 object from the starting 2D coordinates x and y.
  5028. * @param x the starting points x value
  5029. * @param y the starting points y value
  5030. */
  5031. constructor(x: number, y: number);
  5032. /**
  5033. * Adds a new segment until the given coordinates (x, y) to the current Path2.
  5034. * @param x the added points x value
  5035. * @param y the added points y value
  5036. * @returns the updated Path2.
  5037. */
  5038. addLineTo(x: number, y: number): Path2;
  5039. /**
  5040. * 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.
  5041. * @param midX middle point x value
  5042. * @param midY middle point y value
  5043. * @param endX end point x value
  5044. * @param endY end point y value
  5045. * @param numberOfSegments (default: 36)
  5046. * @returns the updated Path2.
  5047. */
  5048. addArcTo(midX: number, midY: number, endX: number, endY: number, numberOfSegments?: number): Path2;
  5049. /**
  5050. * Closes the Path2.
  5051. * @returns the Path2.
  5052. */
  5053. close(): Path2;
  5054. /**
  5055. * Gets the sum of the distance between each sequential point in the path
  5056. * @returns the Path2 total length (float).
  5057. */
  5058. length(): number;
  5059. /**
  5060. * Gets the points which construct the path
  5061. * @returns the Path2 internal array of points.
  5062. */
  5063. getPoints(): Vector2[];
  5064. /**
  5065. * Retreives the point at the distance aways from the starting point
  5066. * @param normalizedLengthPosition the length along the path to retreive the point from
  5067. * @returns a new Vector2 located at a percentage of the Path2 total length on this path.
  5068. */
  5069. getPointAtLengthPosition(normalizedLengthPosition: number): Vector2;
  5070. /**
  5071. * Creates a new path starting from an x and y position
  5072. * @param x starting x value
  5073. * @param y starting y value
  5074. * @returns a new Path2 starting at the coordinates (x, y).
  5075. */
  5076. static StartingAt(x: number, y: number): Path2;
  5077. }
  5078. /**
  5079. * Represents a 3D path made up of multiple 3D points
  5080. */
  5081. export class Path3D {
  5082. /**
  5083. * an array of Vector3, the curve axis of the Path3D
  5084. */
  5085. path: Vector3[];
  5086. private _curve;
  5087. private _distances;
  5088. private _tangents;
  5089. private _normals;
  5090. private _binormals;
  5091. private _raw;
  5092. private _alignTangentsWithPath;
  5093. private readonly _pointAtData;
  5094. /**
  5095. * new Path3D(path, normal, raw)
  5096. * Creates a Path3D. A Path3D is a logical math object, so not a mesh.
  5097. * please read the description in the tutorial : https://doc.babylonjs.com/how_to/how_to_use_path3d
  5098. * @param path an array of Vector3, the curve axis of the Path3D
  5099. * @param firstNormal (options) Vector3, the first wanted normal to the curve. Ex (0, 1, 0) for a vertical normal.
  5100. * @param raw (optional, default false) : boolean, if true the returned Path3D isn't normalized. Useful to depict path acceleration or speed.
  5101. * @param alignTangentsWithPath (optional, default false) : boolean, if true the tangents will be aligned with the path.
  5102. */
  5103. constructor(
  5104. /**
  5105. * an array of Vector3, the curve axis of the Path3D
  5106. */
  5107. path: Vector3[], firstNormal?: Nullable<Vector3>, raw?: boolean, alignTangentsWithPath?: boolean);
  5108. /**
  5109. * Returns the Path3D array of successive Vector3 designing its curve.
  5110. * @returns the Path3D array of successive Vector3 designing its curve.
  5111. */
  5112. getCurve(): Vector3[];
  5113. /**
  5114. * Returns the Path3D array of successive Vector3 designing its curve.
  5115. * @returns the Path3D array of successive Vector3 designing its curve.
  5116. */
  5117. getPoints(): Vector3[];
  5118. /**
  5119. * @returns the computed length (float) of the path.
  5120. */
  5121. length(): number;
  5122. /**
  5123. * Returns an array populated with tangent vectors on each Path3D curve point.
  5124. * @returns an array populated with tangent vectors on each Path3D curve point.
  5125. */
  5126. getTangents(): Vector3[];
  5127. /**
  5128. * Returns an array populated with normal vectors on each Path3D curve point.
  5129. * @returns an array populated with normal vectors on each Path3D curve point.
  5130. */
  5131. getNormals(): Vector3[];
  5132. /**
  5133. * Returns an array populated with binormal vectors on each Path3D curve point.
  5134. * @returns an array populated with binormal vectors on each Path3D curve point.
  5135. */
  5136. getBinormals(): Vector3[];
  5137. /**
  5138. * Returns an array populated with distances (float) of the i-th point from the first curve point.
  5139. * @returns an array populated with distances (float) of the i-th point from the first curve point.
  5140. */
  5141. getDistances(): number[];
  5142. /**
  5143. * Returns an interpolated point along this path
  5144. * @param position the position of the point along this path, from 0.0 to 1.0
  5145. * @returns a new Vector3 as the point
  5146. */
  5147. getPointAt(position: number): Vector3;
  5148. /**
  5149. * Returns the tangent vector of an interpolated Path3D curve point at the specified position along this path.
  5150. * @param position the position of the point along this path, from 0.0 to 1.0
  5151. * @param interpolated (optional, default false) : boolean, if true returns an interpolated tangent instead of the tangent of the previous path point.
  5152. * @returns a tangent vector corresponding to the interpolated Path3D curve point, if not interpolated, the tangent is taken from the precomputed tangents array.
  5153. */
  5154. getTangentAt(position: number, interpolated?: boolean): Vector3;
  5155. /**
  5156. * Returns the tangent vector of an interpolated Path3D curve point at the specified position along this path.
  5157. * @param position the position of the point along this path, from 0.0 to 1.0
  5158. * @param interpolated (optional, default false) : boolean, if true returns an interpolated normal instead of the normal of the previous path point.
  5159. * @returns a normal vector corresponding to the interpolated Path3D curve point, if not interpolated, the normal is taken from the precomputed normals array.
  5160. */
  5161. getNormalAt(position: number, interpolated?: boolean): Vector3;
  5162. /**
  5163. * Returns the binormal vector of an interpolated Path3D curve point at the specified position along this path.
  5164. * @param position the position of the point along this path, from 0.0 to 1.0
  5165. * @param interpolated (optional, default false) : boolean, if true returns an interpolated binormal instead of the binormal of the previous path point.
  5166. * @returns a binormal vector corresponding to the interpolated Path3D curve point, if not interpolated, the binormal is taken from the precomputed binormals array.
  5167. */
  5168. getBinormalAt(position: number, interpolated?: boolean): Vector3;
  5169. /**
  5170. * Returns the distance (float) of an interpolated Path3D curve point at the specified position along this path.
  5171. * @param position the position of the point along this path, from 0.0 to 1.0
  5172. * @returns the distance of the interpolated Path3D curve point at the specified position along this path.
  5173. */
  5174. getDistanceAt(position: number): number;
  5175. /**
  5176. * Returns the array index of the previous point of an interpolated point along this path
  5177. * @param position the position of the point to interpolate along this path, from 0.0 to 1.0
  5178. * @returns the array index
  5179. */
  5180. getPreviousPointIndexAt(position: number): number;
  5181. /**
  5182. * 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)
  5183. * @param position the position of the point to interpolate along this path, from 0.0 to 1.0
  5184. * @returns the sub position
  5185. */
  5186. getSubPositionAt(position: number): number;
  5187. /**
  5188. * Returns the position of the closest virtual point on this path to an arbitrary Vector3, from 0.0 to 1.0
  5189. * @param target the vector of which to get the closest position to
  5190. * @returns the position of the closest virtual point on this path to the target vector
  5191. */
  5192. getClosestPositionTo(target: Vector3): number;
  5193. /**
  5194. * Returns a sub path (slice) of this path
  5195. * @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
  5196. * @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
  5197. * @returns a sub path (slice) of this path
  5198. */
  5199. slice(start?: number, end?: number): Path3D;
  5200. /**
  5201. * Forces the Path3D tangent, normal, binormal and distance recomputation.
  5202. * @param path path which all values are copied into the curves points
  5203. * @param firstNormal which should be projected onto the curve
  5204. * @param alignTangentsWithPath (optional, default false) : boolean, if true the tangents will be aligned with the path
  5205. * @returns the same object updated.
  5206. */
  5207. update(path: Vector3[], firstNormal?: Nullable<Vector3>, alignTangentsWithPath?: boolean): Path3D;
  5208. private _compute;
  5209. private _getFirstNonNullVector;
  5210. private _getLastNonNullVector;
  5211. private _normalVector;
  5212. /**
  5213. * Updates the point at data for an interpolated point along this curve
  5214. * @param position the position of the point along this curve, from 0.0 to 1.0
  5215. * @interpolateTNB wether to compute the interpolated tangent, normal and binormal
  5216. * @returns the (updated) point at data
  5217. */
  5218. private _updatePointAtData;
  5219. /**
  5220. * Updates the point at data from the specified parameters
  5221. * @param position where along the path the interpolated point is, from 0.0 to 1.0
  5222. * @param point the interpolated point
  5223. * @param parentIndex the index of an existing curve point that is on, or else positionally the first behind, the interpolated point
  5224. */
  5225. private _setPointAtData;
  5226. /**
  5227. * Updates the point at interpolation matrix for the tangents, normals and binormals
  5228. */
  5229. private _updateInterpolationMatrix;
  5230. }
  5231. /**
  5232. * A Curve3 object is a logical object, so not a mesh, to handle curves in the 3D geometric space.
  5233. * A Curve3 is designed from a series of successive Vector3.
  5234. * @see https://doc.babylonjs.com/how_to/how_to_use_curve3
  5235. */
  5236. export class Curve3 {
  5237. private _points;
  5238. private _length;
  5239. /**
  5240. * Returns a Curve3 object along a Quadratic Bezier curve : https://doc.babylonjs.com/how_to/how_to_use_curve3#quadratic-bezier-curve
  5241. * @param v0 (Vector3) the origin point of the Quadratic Bezier
  5242. * @param v1 (Vector3) the control point
  5243. * @param v2 (Vector3) the end point of the Quadratic Bezier
  5244. * @param nbPoints (integer) the wanted number of points in the curve
  5245. * @returns the created Curve3
  5246. */
  5247. static CreateQuadraticBezier(v0: DeepImmutable<Vector3>, v1: DeepImmutable<Vector3>, v2: DeepImmutable<Vector3>, nbPoints: number): Curve3;
  5248. /**
  5249. * Returns a Curve3 object along a Cubic Bezier curve : https://doc.babylonjs.com/how_to/how_to_use_curve3#cubic-bezier-curve
  5250. * @param v0 (Vector3) the origin point of the Cubic Bezier
  5251. * @param v1 (Vector3) the first control point
  5252. * @param v2 (Vector3) the second control point
  5253. * @param v3 (Vector3) the end point of the Cubic Bezier
  5254. * @param nbPoints (integer) the wanted number of points in the curve
  5255. * @returns the created Curve3
  5256. */
  5257. static CreateCubicBezier(v0: DeepImmutable<Vector3>, v1: DeepImmutable<Vector3>, v2: DeepImmutable<Vector3>, v3: DeepImmutable<Vector3>, nbPoints: number): Curve3;
  5258. /**
  5259. * Returns a Curve3 object along a Hermite Spline curve : https://doc.babylonjs.com/how_to/how_to_use_curve3#hermite-spline
  5260. * @param p1 (Vector3) the origin point of the Hermite Spline
  5261. * @param t1 (Vector3) the tangent vector at the origin point
  5262. * @param p2 (Vector3) the end point of the Hermite Spline
  5263. * @param t2 (Vector3) the tangent vector at the end point
  5264. * @param nbPoints (integer) the wanted number of points in the curve
  5265. * @returns the created Curve3
  5266. */
  5267. static CreateHermiteSpline(p1: DeepImmutable<Vector3>, t1: DeepImmutable<Vector3>, p2: DeepImmutable<Vector3>, t2: DeepImmutable<Vector3>, nbPoints: number): Curve3;
  5268. /**
  5269. * Returns a Curve3 object along a CatmullRom Spline curve :
  5270. * @param points (array of Vector3) the points the spline must pass through. At least, four points required
  5271. * @param nbPoints (integer) the wanted number of points between each curve control points
  5272. * @param closed (boolean) optional with default false, when true forms a closed loop from the points
  5273. * @returns the created Curve3
  5274. */
  5275. static CreateCatmullRomSpline(points: DeepImmutable<Vector3[]>, nbPoints: number, closed?: boolean): Curve3;
  5276. /**
  5277. * A Curve3 object is a logical object, so not a mesh, to handle curves in the 3D geometric space.
  5278. * A Curve3 is designed from a series of successive Vector3.
  5279. * Tuto : https://doc.babylonjs.com/how_to/how_to_use_curve3#curve3-object
  5280. * @param points points which make up the curve
  5281. */
  5282. constructor(points: Vector3[]);
  5283. /**
  5284. * @returns the Curve3 stored array of successive Vector3
  5285. */
  5286. getPoints(): Vector3[];
  5287. /**
  5288. * @returns the computed length (float) of the curve.
  5289. */
  5290. length(): number;
  5291. /**
  5292. * Returns a new instance of Curve3 object : var curve = curveA.continue(curveB);
  5293. * This new Curve3 is built by translating and sticking the curveB at the end of the curveA.
  5294. * curveA and curveB keep unchanged.
  5295. * @param curve the curve to continue from this curve
  5296. * @returns the newly constructed curve
  5297. */
  5298. continue(curve: DeepImmutable<Curve3>): Curve3;
  5299. private _computeLength;
  5300. }
  5301. }
  5302. declare module "babylonjs/Animations/easing" {
  5303. /**
  5304. * This represents the main contract an easing function should follow.
  5305. * Easing functions are used throughout the animation system.
  5306. * @see https://doc.babylonjs.com/babylon101/animations#easing-functions
  5307. */
  5308. export interface IEasingFunction {
  5309. /**
  5310. * Given an input gradient between 0 and 1, this returns the corrseponding value
  5311. * of the easing function.
  5312. * The link below provides some of the most common examples of easing functions.
  5313. * @see https://easings.net/
  5314. * @param gradient Defines the value between 0 and 1 we want the easing value for
  5315. * @returns the corresponding value on the curve defined by the easing function
  5316. */
  5317. ease(gradient: number): number;
  5318. }
  5319. /**
  5320. * Base class used for every default easing function.
  5321. * @see https://doc.babylonjs.com/babylon101/animations#easing-functions
  5322. */
  5323. export class EasingFunction implements IEasingFunction {
  5324. /**
  5325. * Interpolation follows the mathematical formula associated with the easing function.
  5326. */
  5327. static readonly EASINGMODE_EASEIN: number;
  5328. /**
  5329. * Interpolation follows 100% interpolation minus the output of the formula associated with the easing function.
  5330. */
  5331. static readonly EASINGMODE_EASEOUT: number;
  5332. /**
  5333. * Interpolation uses EaseIn for the first half of the animation and EaseOut for the second half.
  5334. */
  5335. static readonly EASINGMODE_EASEINOUT: number;
  5336. private _easingMode;
  5337. /**
  5338. * Sets the easing mode of the current function.
  5339. * @param easingMode Defines the willing mode (EASINGMODE_EASEIN, EASINGMODE_EASEOUT or EASINGMODE_EASEINOUT)
  5340. */
  5341. setEasingMode(easingMode: number): void;
  5342. /**
  5343. * Gets the current easing mode.
  5344. * @returns the easing mode
  5345. */
  5346. getEasingMode(): number;
  5347. /**
  5348. * @hidden
  5349. */
  5350. easeInCore(gradient: number): number;
  5351. /**
  5352. * Given an input gradient between 0 and 1, this returns the corresponding value
  5353. * of the easing function.
  5354. * @param gradient Defines the value between 0 and 1 we want the easing value for
  5355. * @returns the corresponding value on the curve defined by the easing function
  5356. */
  5357. ease(gradient: number): number;
  5358. }
  5359. /**
  5360. * Easing function with a circle shape (see link below).
  5361. * @see https://easings.net/#easeInCirc
  5362. * @see https://doc.babylonjs.com/babylon101/animations#easing-functions
  5363. */
  5364. export class CircleEase extends EasingFunction implements IEasingFunction {
  5365. /** @hidden */
  5366. easeInCore(gradient: number): number;
  5367. }
  5368. /**
  5369. * Easing function with a ease back shape (see link below).
  5370. * @see https://easings.net/#easeInBack
  5371. * @see https://doc.babylonjs.com/babylon101/animations#easing-functions
  5372. */
  5373. export class BackEase extends EasingFunction implements IEasingFunction {
  5374. /** Defines the amplitude of the function */
  5375. amplitude: number;
  5376. /**
  5377. * Instantiates a back ease easing
  5378. * @see https://easings.net/#easeInBack
  5379. * @param amplitude Defines the amplitude of the function
  5380. */
  5381. constructor(
  5382. /** Defines the amplitude of the function */
  5383. amplitude?: number);
  5384. /** @hidden */
  5385. easeInCore(gradient: number): number;
  5386. }
  5387. /**
  5388. * Easing function with a bouncing shape (see link below).
  5389. * @see https://easings.net/#easeInBounce
  5390. * @see https://doc.babylonjs.com/babylon101/animations#easing-functions
  5391. */
  5392. export class BounceEase extends EasingFunction implements IEasingFunction {
  5393. /** Defines the number of bounces */
  5394. bounces: number;
  5395. /** Defines the amplitude of the bounce */
  5396. bounciness: number;
  5397. /**
  5398. * Instantiates a bounce easing
  5399. * @see https://easings.net/#easeInBounce
  5400. * @param bounces Defines the number of bounces
  5401. * @param bounciness Defines the amplitude of the bounce
  5402. */
  5403. constructor(
  5404. /** Defines the number of bounces */
  5405. bounces?: number,
  5406. /** Defines the amplitude of the bounce */
  5407. bounciness?: number);
  5408. /** @hidden */
  5409. easeInCore(gradient: number): number;
  5410. }
  5411. /**
  5412. * Easing function with a power of 3 shape (see link below).
  5413. * @see https://easings.net/#easeInCubic
  5414. * @see https://doc.babylonjs.com/babylon101/animations#easing-functions
  5415. */
  5416. export class CubicEase extends EasingFunction implements IEasingFunction {
  5417. /** @hidden */
  5418. easeInCore(gradient: number): number;
  5419. }
  5420. /**
  5421. * Easing function with an elastic shape (see link below).
  5422. * @see https://easings.net/#easeInElastic
  5423. * @see https://doc.babylonjs.com/babylon101/animations#easing-functions
  5424. */
  5425. export class ElasticEase extends EasingFunction implements IEasingFunction {
  5426. /** Defines the number of oscillations*/
  5427. oscillations: number;
  5428. /** Defines the amplitude of the oscillations*/
  5429. springiness: number;
  5430. /**
  5431. * Instantiates an elastic easing function
  5432. * @see https://easings.net/#easeInElastic
  5433. * @param oscillations Defines the number of oscillations
  5434. * @param springiness Defines the amplitude of the oscillations
  5435. */
  5436. constructor(
  5437. /** Defines the number of oscillations*/
  5438. oscillations?: number,
  5439. /** Defines the amplitude of the oscillations*/
  5440. springiness?: number);
  5441. /** @hidden */
  5442. easeInCore(gradient: number): number;
  5443. }
  5444. /**
  5445. * Easing function with an exponential shape (see link below).
  5446. * @see https://easings.net/#easeInExpo
  5447. * @see https://doc.babylonjs.com/babylon101/animations#easing-functions
  5448. */
  5449. export class ExponentialEase extends EasingFunction implements IEasingFunction {
  5450. /** Defines the exponent of the function */
  5451. exponent: number;
  5452. /**
  5453. * Instantiates an exponential easing function
  5454. * @see https://easings.net/#easeInExpo
  5455. * @param exponent Defines the exponent of the function
  5456. */
  5457. constructor(
  5458. /** Defines the exponent of the function */
  5459. exponent?: number);
  5460. /** @hidden */
  5461. easeInCore(gradient: number): number;
  5462. }
  5463. /**
  5464. * Easing function with a power shape (see link below).
  5465. * @see https://easings.net/#easeInQuad
  5466. * @see https://doc.babylonjs.com/babylon101/animations#easing-functions
  5467. */
  5468. export class PowerEase extends EasingFunction implements IEasingFunction {
  5469. /** Defines the power of the function */
  5470. power: number;
  5471. /**
  5472. * Instantiates an power base easing function
  5473. * @see https://easings.net/#easeInQuad
  5474. * @param power Defines the power of the function
  5475. */
  5476. constructor(
  5477. /** Defines the power of the function */
  5478. power?: number);
  5479. /** @hidden */
  5480. easeInCore(gradient: number): number;
  5481. }
  5482. /**
  5483. * Easing function with a power of 2 shape (see link below).
  5484. * @see https://easings.net/#easeInQuad
  5485. * @see https://doc.babylonjs.com/babylon101/animations#easing-functions
  5486. */
  5487. export class QuadraticEase extends EasingFunction implements IEasingFunction {
  5488. /** @hidden */
  5489. easeInCore(gradient: number): number;
  5490. }
  5491. /**
  5492. * Easing function with a power of 4 shape (see link below).
  5493. * @see https://easings.net/#easeInQuart
  5494. * @see https://doc.babylonjs.com/babylon101/animations#easing-functions
  5495. */
  5496. export class QuarticEase extends EasingFunction implements IEasingFunction {
  5497. /** @hidden */
  5498. easeInCore(gradient: number): number;
  5499. }
  5500. /**
  5501. * Easing function with a power of 5 shape (see link below).
  5502. * @see https://easings.net/#easeInQuint
  5503. * @see https://doc.babylonjs.com/babylon101/animations#easing-functions
  5504. */
  5505. export class QuinticEase extends EasingFunction implements IEasingFunction {
  5506. /** @hidden */
  5507. easeInCore(gradient: number): number;
  5508. }
  5509. /**
  5510. * Easing function with a sin shape (see link below).
  5511. * @see https://easings.net/#easeInSine
  5512. * @see https://doc.babylonjs.com/babylon101/animations#easing-functions
  5513. */
  5514. export class SineEase extends EasingFunction implements IEasingFunction {
  5515. /** @hidden */
  5516. easeInCore(gradient: number): number;
  5517. }
  5518. /**
  5519. * Easing function with a bezier shape (see link below).
  5520. * @see http://cubic-bezier.com/#.17,.67,.83,.67
  5521. * @see https://doc.babylonjs.com/babylon101/animations#easing-functions
  5522. */
  5523. export class BezierCurveEase extends EasingFunction implements IEasingFunction {
  5524. /** Defines the x component of the start tangent in the bezier curve */
  5525. x1: number;
  5526. /** Defines the y component of the start tangent in the bezier curve */
  5527. y1: number;
  5528. /** Defines the x component of the end tangent in the bezier curve */
  5529. x2: number;
  5530. /** Defines the y component of the end tangent in the bezier curve */
  5531. y2: number;
  5532. /**
  5533. * Instantiates a bezier function
  5534. * @see http://cubic-bezier.com/#.17,.67,.83,.67
  5535. * @param x1 Defines the x component of the start tangent in the bezier curve
  5536. * @param y1 Defines the y component of the start tangent in the bezier curve
  5537. * @param x2 Defines the x component of the end tangent in the bezier curve
  5538. * @param y2 Defines the y component of the end tangent in the bezier curve
  5539. */
  5540. constructor(
  5541. /** Defines the x component of the start tangent in the bezier curve */
  5542. x1?: number,
  5543. /** Defines the y component of the start tangent in the bezier curve */
  5544. y1?: number,
  5545. /** Defines the x component of the end tangent in the bezier curve */
  5546. x2?: number,
  5547. /** Defines the y component of the end tangent in the bezier curve */
  5548. y2?: number);
  5549. /** @hidden */
  5550. easeInCore(gradient: number): number;
  5551. }
  5552. }
  5553. declare module "babylonjs/Maths/math.color" {
  5554. import { DeepImmutable, FloatArray } from "babylonjs/types";
  5555. /**
  5556. * Class used to hold a RBG color
  5557. */
  5558. export class Color3 {
  5559. /**
  5560. * Defines the red component (between 0 and 1, default is 0)
  5561. */
  5562. r: number;
  5563. /**
  5564. * Defines the green component (between 0 and 1, default is 0)
  5565. */
  5566. g: number;
  5567. /**
  5568. * Defines the blue component (between 0 and 1, default is 0)
  5569. */
  5570. b: number;
  5571. /**
  5572. * Creates a new Color3 object from red, green, blue values, all between 0 and 1
  5573. * @param r defines the red component (between 0 and 1, default is 0)
  5574. * @param g defines the green component (between 0 and 1, default is 0)
  5575. * @param b defines the blue component (between 0 and 1, default is 0)
  5576. */
  5577. constructor(
  5578. /**
  5579. * Defines the red component (between 0 and 1, default is 0)
  5580. */
  5581. r?: number,
  5582. /**
  5583. * Defines the green component (between 0 and 1, default is 0)
  5584. */
  5585. g?: number,
  5586. /**
  5587. * Defines the blue component (between 0 and 1, default is 0)
  5588. */
  5589. b?: number);
  5590. /**
  5591. * Creates a string with the Color3 current values
  5592. * @returns the string representation of the Color3 object
  5593. */
  5594. toString(): string;
  5595. /**
  5596. * Returns the string "Color3"
  5597. * @returns "Color3"
  5598. */
  5599. getClassName(): string;
  5600. /**
  5601. * Compute the Color3 hash code
  5602. * @returns an unique number that can be used to hash Color3 objects
  5603. */
  5604. getHashCode(): number;
  5605. /**
  5606. * Stores in the given array from the given starting index the red, green, blue values as successive elements
  5607. * @param array defines the array where to store the r,g,b components
  5608. * @param index defines an optional index in the target array to define where to start storing values
  5609. * @returns the current Color3 object
  5610. */
  5611. toArray(array: FloatArray, index?: number): Color3;
  5612. /**
  5613. * Update the current color with values stored in an array from the starting index of the given array
  5614. * @param array defines the source array
  5615. * @param offset defines an offset in the source array
  5616. * @returns the current Color3 object
  5617. */
  5618. fromArray(array: DeepImmutable<ArrayLike<number>>, offset?: number): Color3;
  5619. /**
  5620. * Returns a new Color4 object from the current Color3 and the given alpha
  5621. * @param alpha defines the alpha component on the new Color4 object (default is 1)
  5622. * @returns a new Color4 object
  5623. */
  5624. toColor4(alpha?: number): Color4;
  5625. /**
  5626. * Returns a new array populated with 3 numeric elements : red, green and blue values
  5627. * @returns the new array
  5628. */
  5629. asArray(): number[];
  5630. /**
  5631. * Returns the luminance value
  5632. * @returns a float value
  5633. */
  5634. toLuminance(): number;
  5635. /**
  5636. * Multiply each Color3 rgb values by the given Color3 rgb values in a new Color3 object
  5637. * @param otherColor defines the second operand
  5638. * @returns the new Color3 object
  5639. */
  5640. multiply(otherColor: DeepImmutable<Color3>): Color3;
  5641. /**
  5642. * Multiply the rgb values of the Color3 and the given Color3 and stores the result in the object "result"
  5643. * @param otherColor defines the second operand
  5644. * @param result defines the Color3 object where to store the result
  5645. * @returns the current Color3
  5646. */
  5647. multiplyToRef(otherColor: DeepImmutable<Color3>, result: Color3): Color3;
  5648. /**
  5649. * Determines equality between Color3 objects
  5650. * @param otherColor defines the second operand
  5651. * @returns true if the rgb values are equal to the given ones
  5652. */
  5653. equals(otherColor: DeepImmutable<Color3>): boolean;
  5654. /**
  5655. * Determines equality between the current Color3 object and a set of r,b,g values
  5656. * @param r defines the red component to check
  5657. * @param g defines the green component to check
  5658. * @param b defines the blue component to check
  5659. * @returns true if the rgb values are equal to the given ones
  5660. */
  5661. equalsFloats(r: number, g: number, b: number): boolean;
  5662. /**
  5663. * Multiplies in place each rgb value by scale
  5664. * @param scale defines the scaling factor
  5665. * @returns the updated Color3
  5666. */
  5667. scale(scale: number): Color3;
  5668. /**
  5669. * Multiplies the rgb values by scale and stores the result into "result"
  5670. * @param scale defines the scaling factor
  5671. * @param result defines the Color3 object where to store the result
  5672. * @returns the unmodified current Color3
  5673. */
  5674. scaleToRef(scale: number, result: Color3): Color3;
  5675. /**
  5676. * Scale the current Color3 values by a factor and add the result to a given Color3
  5677. * @param scale defines the scale factor
  5678. * @param result defines color to store the result into
  5679. * @returns the unmodified current Color3
  5680. */
  5681. scaleAndAddToRef(scale: number, result: Color3): Color3;
  5682. /**
  5683. * Clamps the rgb values by the min and max values and stores the result into "result"
  5684. * @param min defines minimum clamping value (default is 0)
  5685. * @param max defines maximum clamping value (default is 1)
  5686. * @param result defines color to store the result into
  5687. * @returns the original Color3
  5688. */
  5689. clampToRef(min: number | undefined, max: number | undefined, result: Color3): Color3;
  5690. /**
  5691. * Creates a new Color3 set with the added values of the current Color3 and of the given one
  5692. * @param otherColor defines the second operand
  5693. * @returns the new Color3
  5694. */
  5695. add(otherColor: DeepImmutable<Color3>): Color3;
  5696. /**
  5697. * Stores the result of the addition of the current Color3 and given one rgb values into "result"
  5698. * @param otherColor defines the second operand
  5699. * @param result defines Color3 object to store the result into
  5700. * @returns the unmodified current Color3
  5701. */
  5702. addToRef(otherColor: DeepImmutable<Color3>, result: Color3): Color3;
  5703. /**
  5704. * Returns a new Color3 set with the subtracted values of the given one from the current Color3
  5705. * @param otherColor defines the second operand
  5706. * @returns the new Color3
  5707. */
  5708. subtract(otherColor: DeepImmutable<Color3>): Color3;
  5709. /**
  5710. * Stores the result of the subtraction of given one from the current Color3 rgb values into "result"
  5711. * @param otherColor defines the second operand
  5712. * @param result defines Color3 object to store the result into
  5713. * @returns the unmodified current Color3
  5714. */
  5715. subtractToRef(otherColor: DeepImmutable<Color3>, result: Color3): Color3;
  5716. /**
  5717. * Copy the current object
  5718. * @returns a new Color3 copied the current one
  5719. */
  5720. clone(): Color3;
  5721. /**
  5722. * Copies the rgb values from the source in the current Color3
  5723. * @param source defines the source Color3 object
  5724. * @returns the updated Color3 object
  5725. */
  5726. copyFrom(source: DeepImmutable<Color3>): Color3;
  5727. /**
  5728. * Updates the Color3 rgb values from the given floats
  5729. * @param r defines the red component to read from
  5730. * @param g defines the green component to read from
  5731. * @param b defines the blue component to read from
  5732. * @returns the current Color3 object
  5733. */
  5734. copyFromFloats(r: number, g: number, b: number): Color3;
  5735. /**
  5736. * Updates the Color3 rgb values from the given floats
  5737. * @param r defines the red component to read from
  5738. * @param g defines the green component to read from
  5739. * @param b defines the blue component to read from
  5740. * @returns the current Color3 object
  5741. */
  5742. set(r: number, g: number, b: number): Color3;
  5743. /**
  5744. * Compute the Color3 hexadecimal code as a string
  5745. * @returns a string containing the hexadecimal representation of the Color3 object
  5746. */
  5747. toHexString(): string;
  5748. /**
  5749. * Computes a new Color3 converted from the current one to linear space
  5750. * @returns a new Color3 object
  5751. */
  5752. toLinearSpace(): Color3;
  5753. /**
  5754. * Converts current color in rgb space to HSV values
  5755. * @returns a new color3 representing the HSV values
  5756. */
  5757. toHSV(): Color3;
  5758. /**
  5759. * Converts current color in rgb space to HSV values
  5760. * @param result defines the Color3 where to store the HSV values
  5761. */
  5762. toHSVToRef(result: Color3): void;
  5763. /**
  5764. * Converts the Color3 values to linear space and stores the result in "convertedColor"
  5765. * @param convertedColor defines the Color3 object where to store the linear space version
  5766. * @returns the unmodified Color3
  5767. */
  5768. toLinearSpaceToRef(convertedColor: Color3): Color3;
  5769. /**
  5770. * Computes a new Color3 converted from the current one to gamma space
  5771. * @returns a new Color3 object
  5772. */
  5773. toGammaSpace(): Color3;
  5774. /**
  5775. * Converts the Color3 values to gamma space and stores the result in "convertedColor"
  5776. * @param convertedColor defines the Color3 object where to store the gamma space version
  5777. * @returns the unmodified Color3
  5778. */
  5779. toGammaSpaceToRef(convertedColor: Color3): Color3;
  5780. private static _BlackReadOnly;
  5781. /**
  5782. * Convert Hue, saturation and value to a Color3 (RGB)
  5783. * @param hue defines the hue
  5784. * @param saturation defines the saturation
  5785. * @param value defines the value
  5786. * @param result defines the Color3 where to store the RGB values
  5787. */
  5788. static HSVtoRGBToRef(hue: number, saturation: number, value: number, result: Color3): void;
  5789. /**
  5790. * Creates a new Color3 from the string containing valid hexadecimal values
  5791. * @param hex defines a string containing valid hexadecimal values
  5792. * @returns a new Color3 object
  5793. */
  5794. static FromHexString(hex: string): Color3;
  5795. /**
  5796. * Creates a new Color3 from the starting index of the given array
  5797. * @param array defines the source array
  5798. * @param offset defines an offset in the source array
  5799. * @returns a new Color3 object
  5800. */
  5801. static FromArray(array: DeepImmutable<ArrayLike<number>>, offset?: number): Color3;
  5802. /**
  5803. * Creates a new Color3 from the starting index element of the given array
  5804. * @param array defines the source array to read from
  5805. * @param offset defines the offset in the source array
  5806. * @param result defines the target Color3 object
  5807. */
  5808. static FromArrayToRef(array: DeepImmutable<ArrayLike<number>>, offset: number | undefined, result: Color3): void;
  5809. /**
  5810. * Creates a new Color3 from integer values (< 256)
  5811. * @param r defines the red component to read from (value between 0 and 255)
  5812. * @param g defines the green component to read from (value between 0 and 255)
  5813. * @param b defines the blue component to read from (value between 0 and 255)
  5814. * @returns a new Color3 object
  5815. */
  5816. static FromInts(r: number, g: number, b: number): Color3;
  5817. /**
  5818. * Creates a new Color3 with values linearly interpolated of "amount" between the start Color3 and the end Color3
  5819. * @param start defines the start Color3 value
  5820. * @param end defines the end Color3 value
  5821. * @param amount defines the gradient value between start and end
  5822. * @returns a new Color3 object
  5823. */
  5824. static Lerp(start: DeepImmutable<Color3>, end: DeepImmutable<Color3>, amount: number): Color3;
  5825. /**
  5826. * Creates a new Color3 with values linearly interpolated of "amount" between the start Color3 and the end Color3
  5827. * @param left defines the start value
  5828. * @param right defines the end value
  5829. * @param amount defines the gradient factor
  5830. * @param result defines the Color3 object where to store the result
  5831. */
  5832. static LerpToRef(left: DeepImmutable<Color3>, right: DeepImmutable<Color3>, amount: number, result: Color3): void;
  5833. /**
  5834. * Returns a Color3 value containing a red color
  5835. * @returns a new Color3 object
  5836. */
  5837. static Red(): Color3;
  5838. /**
  5839. * Returns a Color3 value containing a green color
  5840. * @returns a new Color3 object
  5841. */
  5842. static Green(): Color3;
  5843. /**
  5844. * Returns a Color3 value containing a blue color
  5845. * @returns a new Color3 object
  5846. */
  5847. static Blue(): Color3;
  5848. /**
  5849. * Returns a Color3 value containing a black color
  5850. * @returns a new Color3 object
  5851. */
  5852. static Black(): Color3;
  5853. /**
  5854. * Gets a Color3 value containing a black color that must not be updated
  5855. */
  5856. static get BlackReadOnly(): DeepImmutable<Color3>;
  5857. /**
  5858. * Returns a Color3 value containing a white color
  5859. * @returns a new Color3 object
  5860. */
  5861. static White(): Color3;
  5862. /**
  5863. * Returns a Color3 value containing a purple color
  5864. * @returns a new Color3 object
  5865. */
  5866. static Purple(): Color3;
  5867. /**
  5868. * Returns a Color3 value containing a magenta color
  5869. * @returns a new Color3 object
  5870. */
  5871. static Magenta(): Color3;
  5872. /**
  5873. * Returns a Color3 value containing a yellow color
  5874. * @returns a new Color3 object
  5875. */
  5876. static Yellow(): Color3;
  5877. /**
  5878. * Returns a Color3 value containing a gray color
  5879. * @returns a new Color3 object
  5880. */
  5881. static Gray(): Color3;
  5882. /**
  5883. * Returns a Color3 value containing a teal color
  5884. * @returns a new Color3 object
  5885. */
  5886. static Teal(): Color3;
  5887. /**
  5888. * Returns a Color3 value containing a random color
  5889. * @returns a new Color3 object
  5890. */
  5891. static Random(): Color3;
  5892. }
  5893. /**
  5894. * Class used to hold a RBGA color
  5895. */
  5896. export class Color4 {
  5897. /**
  5898. * Defines the red component (between 0 and 1, default is 0)
  5899. */
  5900. r: number;
  5901. /**
  5902. * Defines the green component (between 0 and 1, default is 0)
  5903. */
  5904. g: number;
  5905. /**
  5906. * Defines the blue component (between 0 and 1, default is 0)
  5907. */
  5908. b: number;
  5909. /**
  5910. * Defines the alpha component (between 0 and 1, default is 1)
  5911. */
  5912. a: number;
  5913. /**
  5914. * Creates a new Color4 object from red, green, blue values, all between 0 and 1
  5915. * @param r defines the red component (between 0 and 1, default is 0)
  5916. * @param g defines the green component (between 0 and 1, default is 0)
  5917. * @param b defines the blue component (between 0 and 1, default is 0)
  5918. * @param a defines the alpha component (between 0 and 1, default is 1)
  5919. */
  5920. constructor(
  5921. /**
  5922. * Defines the red component (between 0 and 1, default is 0)
  5923. */
  5924. r?: number,
  5925. /**
  5926. * Defines the green component (between 0 and 1, default is 0)
  5927. */
  5928. g?: number,
  5929. /**
  5930. * Defines the blue component (between 0 and 1, default is 0)
  5931. */
  5932. b?: number,
  5933. /**
  5934. * Defines the alpha component (between 0 and 1, default is 1)
  5935. */
  5936. a?: number);
  5937. /**
  5938. * Adds in place the given Color4 values to the current Color4 object
  5939. * @param right defines the second operand
  5940. * @returns the current updated Color4 object
  5941. */
  5942. addInPlace(right: DeepImmutable<Color4>): Color4;
  5943. /**
  5944. * Creates a new array populated with 4 numeric elements : red, green, blue, alpha values
  5945. * @returns the new array
  5946. */
  5947. asArray(): number[];
  5948. /**
  5949. * Stores from the starting index in the given array the Color4 successive values
  5950. * @param array defines the array where to store the r,g,b components
  5951. * @param index defines an optional index in the target array to define where to start storing values
  5952. * @returns the current Color4 object
  5953. */
  5954. toArray(array: number[], index?: number): Color4;
  5955. /**
  5956. * Update the current color with values stored in an array from the starting index of the given array
  5957. * @param array defines the source array
  5958. * @param offset defines an offset in the source array
  5959. * @returns the current Color4 object
  5960. */
  5961. fromArray(array: DeepImmutable<ArrayLike<number>>, offset?: number): Color4;
  5962. /**
  5963. * Determines equality between Color4 objects
  5964. * @param otherColor defines the second operand
  5965. * @returns true if the rgba values are equal to the given ones
  5966. */
  5967. equals(otherColor: DeepImmutable<Color4>): boolean;
  5968. /**
  5969. * Creates a new Color4 set with the added values of the current Color4 and of the given one
  5970. * @param right defines the second operand
  5971. * @returns a new Color4 object
  5972. */
  5973. add(right: DeepImmutable<Color4>): Color4;
  5974. /**
  5975. * Creates a new Color4 set with the subtracted values of the given one from the current Color4
  5976. * @param right defines the second operand
  5977. * @returns a new Color4 object
  5978. */
  5979. subtract(right: DeepImmutable<Color4>): Color4;
  5980. /**
  5981. * Subtracts the given ones from the current Color4 values and stores the results in "result"
  5982. * @param right defines the second operand
  5983. * @param result defines the Color4 object where to store the result
  5984. * @returns the current Color4 object
  5985. */
  5986. subtractToRef(right: DeepImmutable<Color4>, result: Color4): Color4;
  5987. /**
  5988. * Creates a new Color4 with the current Color4 values multiplied by scale
  5989. * @param scale defines the scaling factor to apply
  5990. * @returns a new Color4 object
  5991. */
  5992. scale(scale: number): Color4;
  5993. /**
  5994. * Multiplies the current Color4 values by scale and stores the result in "result"
  5995. * @param scale defines the scaling factor to apply
  5996. * @param result defines the Color4 object where to store the result
  5997. * @returns the current unmodified Color4
  5998. */
  5999. scaleToRef(scale: number, result: Color4): Color4;
  6000. /**
  6001. * Scale the current Color4 values by a factor and add the result to a given Color4
  6002. * @param scale defines the scale factor
  6003. * @param result defines the Color4 object where to store the result
  6004. * @returns the unmodified current Color4
  6005. */
  6006. scaleAndAddToRef(scale: number, result: Color4): Color4;
  6007. /**
  6008. * Clamps the rgb values by the min and max values and stores the result into "result"
  6009. * @param min defines minimum clamping value (default is 0)
  6010. * @param max defines maximum clamping value (default is 1)
  6011. * @param result defines color to store the result into.
  6012. * @returns the cuurent Color4
  6013. */
  6014. clampToRef(min: number | undefined, max: number | undefined, result: Color4): Color4;
  6015. /**
  6016. * Multipy an Color4 value by another and return a new Color4 object
  6017. * @param color defines the Color4 value to multiply by
  6018. * @returns a new Color4 object
  6019. */
  6020. multiply(color: Color4): Color4;
  6021. /**
  6022. * Multipy a Color4 value by another and push the result in a reference value
  6023. * @param color defines the Color4 value to multiply by
  6024. * @param result defines the Color4 to fill the result in
  6025. * @returns the result Color4
  6026. */
  6027. multiplyToRef(color: Color4, result: Color4): Color4;
  6028. /**
  6029. * Creates a string with the Color4 current values
  6030. * @returns the string representation of the Color4 object
  6031. */
  6032. toString(): string;
  6033. /**
  6034. * Returns the string "Color4"
  6035. * @returns "Color4"
  6036. */
  6037. getClassName(): string;
  6038. /**
  6039. * Compute the Color4 hash code
  6040. * @returns an unique number that can be used to hash Color4 objects
  6041. */
  6042. getHashCode(): number;
  6043. /**
  6044. * Creates a new Color4 copied from the current one
  6045. * @returns a new Color4 object
  6046. */
  6047. clone(): Color4;
  6048. /**
  6049. * Copies the given Color4 values into the current one
  6050. * @param source defines the source Color4 object
  6051. * @returns the current updated Color4 object
  6052. */
  6053. copyFrom(source: Color4): Color4;
  6054. /**
  6055. * Copies the given float values into the current one
  6056. * @param r defines the red component to read from
  6057. * @param g defines the green component to read from
  6058. * @param b defines the blue component to read from
  6059. * @param a defines the alpha component to read from
  6060. * @returns the current updated Color4 object
  6061. */
  6062. copyFromFloats(r: number, g: number, b: number, a: number): Color4;
  6063. /**
  6064. * Copies the given float values into the current one
  6065. * @param r defines the red component to read from
  6066. * @param g defines the green component to read from
  6067. * @param b defines the blue component to read from
  6068. * @param a defines the alpha component to read from
  6069. * @returns the current updated Color4 object
  6070. */
  6071. set(r: number, g: number, b: number, a: number): Color4;
  6072. /**
  6073. * Compute the Color4 hexadecimal code as a string
  6074. * @param returnAsColor3 defines if the string should only contains RGB values (off by default)
  6075. * @returns a string containing the hexadecimal representation of the Color4 object
  6076. */
  6077. toHexString(returnAsColor3?: boolean): string;
  6078. /**
  6079. * Computes a new Color4 converted from the current one to linear space
  6080. * @returns a new Color4 object
  6081. */
  6082. toLinearSpace(): Color4;
  6083. /**
  6084. * Converts the Color4 values to linear space and stores the result in "convertedColor"
  6085. * @param convertedColor defines the Color4 object where to store the linear space version
  6086. * @returns the unmodified Color4
  6087. */
  6088. toLinearSpaceToRef(convertedColor: Color4): Color4;
  6089. /**
  6090. * Computes a new Color4 converted from the current one to gamma space
  6091. * @returns a new Color4 object
  6092. */
  6093. toGammaSpace(): Color4;
  6094. /**
  6095. * Converts the Color4 values to gamma space and stores the result in "convertedColor"
  6096. * @param convertedColor defines the Color4 object where to store the gamma space version
  6097. * @returns the unmodified Color4
  6098. */
  6099. toGammaSpaceToRef(convertedColor: Color4): Color4;
  6100. /**
  6101. * Creates a new Color4 from the string containing valid hexadecimal values
  6102. * @param hex defines a string containing valid hexadecimal values
  6103. * @returns a new Color4 object
  6104. */
  6105. static FromHexString(hex: string): Color4;
  6106. /**
  6107. * Creates a new Color4 object set with the linearly interpolated values of "amount" between the left Color4 object and the right Color4 object
  6108. * @param left defines the start value
  6109. * @param right defines the end value
  6110. * @param amount defines the gradient factor
  6111. * @returns a new Color4 object
  6112. */
  6113. static Lerp(left: DeepImmutable<Color4>, right: DeepImmutable<Color4>, amount: number): Color4;
  6114. /**
  6115. * Set the given "result" with the linearly interpolated values of "amount" between the left Color4 object and the right Color4 object
  6116. * @param left defines the start value
  6117. * @param right defines the end value
  6118. * @param amount defines the gradient factor
  6119. * @param result defines the Color4 object where to store data
  6120. */
  6121. static LerpToRef(left: DeepImmutable<Color4>, right: DeepImmutable<Color4>, amount: number, result: Color4): void;
  6122. /**
  6123. * Creates a new Color4 from a Color3 and an alpha value
  6124. * @param color3 defines the source Color3 to read from
  6125. * @param alpha defines the alpha component (1.0 by default)
  6126. * @returns a new Color4 object
  6127. */
  6128. static FromColor3(color3: DeepImmutable<Color3>, alpha?: number): Color4;
  6129. /**
  6130. * Creates a new Color4 from the starting index element of the given array
  6131. * @param array defines the source array to read from
  6132. * @param offset defines the offset in the source array
  6133. * @returns a new Color4 object
  6134. */
  6135. static FromArray(array: DeepImmutable<ArrayLike<number>>, offset?: number): Color4;
  6136. /**
  6137. * Creates a new Color4 from the starting index element of the given array
  6138. * @param array defines the source array to read from
  6139. * @param offset defines the offset in the source array
  6140. * @param result defines the target Color4 object
  6141. */
  6142. static FromArrayToRef(array: DeepImmutable<ArrayLike<number>>, offset: number | undefined, result: Color4): void;
  6143. /**
  6144. * Creates a new Color3 from integer values (< 256)
  6145. * @param r defines the red component to read from (value between 0 and 255)
  6146. * @param g defines the green component to read from (value between 0 and 255)
  6147. * @param b defines the blue component to read from (value between 0 and 255)
  6148. * @param a defines the alpha component to read from (value between 0 and 255)
  6149. * @returns a new Color3 object
  6150. */
  6151. static FromInts(r: number, g: number, b: number, a: number): Color4;
  6152. /**
  6153. * Check the content of a given array and convert it to an array containing RGBA data
  6154. * If the original array was already containing count * 4 values then it is returned directly
  6155. * @param colors defines the array to check
  6156. * @param count defines the number of RGBA data to expect
  6157. * @returns an array containing count * 4 values (RGBA)
  6158. */
  6159. static CheckColors4(colors: number[], count: number): number[];
  6160. }
  6161. /**
  6162. * @hidden
  6163. */
  6164. export class TmpColors {
  6165. static Color3: Color3[];
  6166. static Color4: Color4[];
  6167. }
  6168. }
  6169. declare module "babylonjs/Animations/animationKey" {
  6170. /**
  6171. * Defines an interface which represents an animation key frame
  6172. */
  6173. export interface IAnimationKey {
  6174. /**
  6175. * Frame of the key frame
  6176. */
  6177. frame: number;
  6178. /**
  6179. * Value at the specifies key frame
  6180. */
  6181. value: any;
  6182. /**
  6183. * The input tangent for the cubic hermite spline
  6184. */
  6185. inTangent?: any;
  6186. /**
  6187. * The output tangent for the cubic hermite spline
  6188. */
  6189. outTangent?: any;
  6190. /**
  6191. * The animation interpolation type
  6192. */
  6193. interpolation?: AnimationKeyInterpolation;
  6194. }
  6195. /**
  6196. * Enum for the animation key frame interpolation type
  6197. */
  6198. export enum AnimationKeyInterpolation {
  6199. /**
  6200. * Do not interpolate between keys and use the start key value only. Tangents are ignored
  6201. */
  6202. STEP = 1
  6203. }
  6204. }
  6205. declare module "babylonjs/Animations/animationRange" {
  6206. /**
  6207. * Represents the range of an animation
  6208. */
  6209. export class AnimationRange {
  6210. /**The name of the animation range**/
  6211. name: string;
  6212. /**The starting frame of the animation */
  6213. from: number;
  6214. /**The ending frame of the animation*/
  6215. to: number;
  6216. /**
  6217. * Initializes the range of an animation
  6218. * @param name The name of the animation range
  6219. * @param from The starting frame of the animation
  6220. * @param to The ending frame of the animation
  6221. */
  6222. constructor(
  6223. /**The name of the animation range**/
  6224. name: string,
  6225. /**The starting frame of the animation */
  6226. from: number,
  6227. /**The ending frame of the animation*/
  6228. to: number);
  6229. /**
  6230. * Makes a copy of the animation range
  6231. * @returns A copy of the animation range
  6232. */
  6233. clone(): AnimationRange;
  6234. }
  6235. }
  6236. declare module "babylonjs/Animations/animationEvent" {
  6237. /**
  6238. * Composed of a frame, and an action function
  6239. */
  6240. export class AnimationEvent {
  6241. /** The frame for which the event is triggered **/
  6242. frame: number;
  6243. /** The event to perform when triggered **/
  6244. action: (currentFrame: number) => void;
  6245. /** Specifies if the event should be triggered only once**/
  6246. onlyOnce?: boolean | undefined;
  6247. /**
  6248. * Specifies if the animation event is done
  6249. */
  6250. isDone: boolean;
  6251. /**
  6252. * Initializes the animation event
  6253. * @param frame The frame for which the event is triggered
  6254. * @param action The event to perform when triggered
  6255. * @param onlyOnce Specifies if the event should be triggered only once
  6256. */
  6257. constructor(
  6258. /** The frame for which the event is triggered **/
  6259. frame: number,
  6260. /** The event to perform when triggered **/
  6261. action: (currentFrame: number) => void,
  6262. /** Specifies if the event should be triggered only once**/
  6263. onlyOnce?: boolean | undefined);
  6264. /** @hidden */
  6265. _clone(): AnimationEvent;
  6266. }
  6267. }
  6268. declare module "babylonjs/Behaviors/behavior" {
  6269. import { Nullable } from "babylonjs/types";
  6270. /**
  6271. * Interface used to define a behavior
  6272. */
  6273. export interface Behavior<T> {
  6274. /** gets or sets behavior's name */
  6275. name: string;
  6276. /**
  6277. * Function called when the behavior needs to be initialized (after attaching it to a target)
  6278. */
  6279. init(): void;
  6280. /**
  6281. * Called when the behavior is attached to a target
  6282. * @param target defines the target where the behavior is attached to
  6283. */
  6284. attach(target: T): void;
  6285. /**
  6286. * Called when the behavior is detached from its target
  6287. */
  6288. detach(): void;
  6289. }
  6290. /**
  6291. * Interface implemented by classes supporting behaviors
  6292. */
  6293. export interface IBehaviorAware<T> {
  6294. /**
  6295. * Attach a behavior
  6296. * @param behavior defines the behavior to attach
  6297. * @returns the current host
  6298. */
  6299. addBehavior(behavior: Behavior<T>): T;
  6300. /**
  6301. * Remove a behavior from the current object
  6302. * @param behavior defines the behavior to detach
  6303. * @returns the current host
  6304. */
  6305. removeBehavior(behavior: Behavior<T>): T;
  6306. /**
  6307. * Gets a behavior using its name to search
  6308. * @param name defines the name to search
  6309. * @returns the behavior or null if not found
  6310. */
  6311. getBehaviorByName(name: string): Nullable<Behavior<T>>;
  6312. }
  6313. }
  6314. declare module "babylonjs/Misc/smartArray" {
  6315. /**
  6316. * Defines an array and its length.
  6317. * It can be helpfull to group result from both Arrays and smart arrays in one structure.
  6318. */
  6319. export interface ISmartArrayLike<T> {
  6320. /**
  6321. * The data of the array.
  6322. */
  6323. data: Array<T>;
  6324. /**
  6325. * The active length of the array.
  6326. */
  6327. length: number;
  6328. }
  6329. /**
  6330. * Defines an GC Friendly array where the backfield array do not shrink to prevent over allocations.
  6331. */
  6332. export class SmartArray<T> implements ISmartArrayLike<T> {
  6333. /**
  6334. * The full set of data from the array.
  6335. */
  6336. data: Array<T>;
  6337. /**
  6338. * The active length of the array.
  6339. */
  6340. length: number;
  6341. protected _id: number;
  6342. /**
  6343. * Instantiates a Smart Array.
  6344. * @param capacity defines the default capacity of the array.
  6345. */
  6346. constructor(capacity: number);
  6347. /**
  6348. * Pushes a value at the end of the active data.
  6349. * @param value defines the object to push in the array.
  6350. */
  6351. push(value: T): void;
  6352. /**
  6353. * Iterates over the active data and apply the lambda to them.
  6354. * @param func defines the action to apply on each value.
  6355. */
  6356. forEach(func: (content: T) => void): void;
  6357. /**
  6358. * Sorts the full sets of data.
  6359. * @param compareFn defines the comparison function to apply.
  6360. */
  6361. sort(compareFn: (a: T, b: T) => number): void;
  6362. /**
  6363. * Resets the active data to an empty array.
  6364. */
  6365. reset(): void;
  6366. /**
  6367. * Releases all the data from the array as well as the array.
  6368. */
  6369. dispose(): void;
  6370. /**
  6371. * Concats the active data with a given array.
  6372. * @param array defines the data to concatenate with.
  6373. */
  6374. concat(array: any): void;
  6375. /**
  6376. * Returns the position of a value in the active data.
  6377. * @param value defines the value to find the index for
  6378. * @returns the index if found in the active data otherwise -1
  6379. */
  6380. indexOf(value: T): number;
  6381. /**
  6382. * Returns whether an element is part of the active data.
  6383. * @param value defines the value to look for
  6384. * @returns true if found in the active data otherwise false
  6385. */
  6386. contains(value: T): boolean;
  6387. private static _GlobalId;
  6388. }
  6389. /**
  6390. * Defines an GC Friendly array where the backfield array do not shrink to prevent over allocations.
  6391. * The data in this array can only be present once
  6392. */
  6393. export class SmartArrayNoDuplicate<T> extends SmartArray<T> {
  6394. private _duplicateId;
  6395. /**
  6396. * Pushes a value at the end of the active data.
  6397. * THIS DOES NOT PREVENT DUPPLICATE DATA
  6398. * @param value defines the object to push in the array.
  6399. */
  6400. push(value: T): void;
  6401. /**
  6402. * Pushes a value at the end of the active data.
  6403. * If the data is already present, it won t be added again
  6404. * @param value defines the object to push in the array.
  6405. * @returns true if added false if it was already present
  6406. */
  6407. pushNoDuplicate(value: T): boolean;
  6408. /**
  6409. * Resets the active data to an empty array.
  6410. */
  6411. reset(): void;
  6412. /**
  6413. * Concats the active data with a given array.
  6414. * This ensures no dupplicate will be present in the result.
  6415. * @param array defines the data to concatenate with.
  6416. */
  6417. concatWithNoDuplicate(array: any): void;
  6418. }
  6419. }
  6420. declare module "babylonjs/Cameras/cameraInputsManager" {
  6421. import { Nullable } from "babylonjs/types";
  6422. import { Camera } from "babylonjs/Cameras/camera";
  6423. /**
  6424. * @ignore
  6425. * This is a list of all the different input types that are available in the application.
  6426. * Fo instance: ArcRotateCameraGamepadInput...
  6427. */
  6428. export var CameraInputTypes: {};
  6429. /**
  6430. * This is the contract to implement in order to create a new input class.
  6431. * Inputs are dealing with listening to user actions and moving the camera accordingly.
  6432. */
  6433. export interface ICameraInput<TCamera extends Camera> {
  6434. /**
  6435. * Defines the camera the input is attached to.
  6436. */
  6437. camera: Nullable<TCamera>;
  6438. /**
  6439. * Gets the class name of the current intput.
  6440. * @returns the class name
  6441. */
  6442. getClassName(): string;
  6443. /**
  6444. * Get the friendly name associated with the input class.
  6445. * @returns the input friendly name
  6446. */
  6447. getSimpleName(): string;
  6448. /**
  6449. * Attach the input controls to a specific dom element to get the input from.
  6450. * @param element Defines the element the controls should be listened from
  6451. * @param noPreventDefault Defines whether event caught by the controls should call preventdefault() (https://developer.mozilla.org/en-US/docs/Web/API/Event/preventDefault)
  6452. */
  6453. attachControl(element: HTMLElement, noPreventDefault?: boolean): void;
  6454. /**
  6455. * Detach the current controls from the specified dom element.
  6456. * @param element Defines the element to stop listening the inputs from
  6457. */
  6458. detachControl(element: Nullable<HTMLElement>): void;
  6459. /**
  6460. * Update the current camera state depending on the inputs that have been used this frame.
  6461. * This is a dynamically created lambda to avoid the performance penalty of looping for inputs in the render loop.
  6462. */
  6463. checkInputs?: () => void;
  6464. }
  6465. /**
  6466. * Represents a map of input types to input instance or input index to input instance.
  6467. */
  6468. export interface CameraInputsMap<TCamera extends Camera> {
  6469. /**
  6470. * Accessor to the input by input type.
  6471. */
  6472. [name: string]: ICameraInput<TCamera>;
  6473. /**
  6474. * Accessor to the input by input index.
  6475. */
  6476. [idx: number]: ICameraInput<TCamera>;
  6477. }
  6478. /**
  6479. * This represents the input manager used within a camera.
  6480. * It helps dealing with all the different kind of input attached to a camera.
  6481. * @see https://doc.babylonjs.com/how_to/customizing_camera_inputs
  6482. */
  6483. export class CameraInputsManager<TCamera extends Camera> {
  6484. /**
  6485. * Defines the list of inputs attahed to the camera.
  6486. */
  6487. attached: CameraInputsMap<TCamera>;
  6488. /**
  6489. * Defines the dom element the camera is collecting inputs from.
  6490. * This is null if the controls have not been attached.
  6491. */
  6492. attachedElement: Nullable<HTMLElement>;
  6493. /**
  6494. * Defines whether event caught by the controls should call preventdefault() (https://developer.mozilla.org/en-US/docs/Web/API/Event/preventDefault)
  6495. */
  6496. noPreventDefault: boolean;
  6497. /**
  6498. * Defined the camera the input manager belongs to.
  6499. */
  6500. camera: TCamera;
  6501. /**
  6502. * Update the current camera state depending on the inputs that have been used this frame.
  6503. * This is a dynamically created lambda to avoid the performance penalty of looping for inputs in the render loop.
  6504. */
  6505. checkInputs: () => void;
  6506. /**
  6507. * Instantiate a new Camera Input Manager.
  6508. * @param camera Defines the camera the input manager blongs to
  6509. */
  6510. constructor(camera: TCamera);
  6511. /**
  6512. * Add an input method to a camera
  6513. * @see https://doc.babylonjs.com/how_to/customizing_camera_inputs
  6514. * @param input camera input method
  6515. */
  6516. add(input: ICameraInput<TCamera>): void;
  6517. /**
  6518. * Remove a specific input method from a camera
  6519. * example: camera.inputs.remove(camera.inputs.attached.mouse);
  6520. * @param inputToRemove camera input method
  6521. */
  6522. remove(inputToRemove: ICameraInput<TCamera>): void;
  6523. /**
  6524. * Remove a specific input type from a camera
  6525. * example: camera.inputs.remove("ArcRotateCameraGamepadInput");
  6526. * @param inputType the type of the input to remove
  6527. */
  6528. removeByType(inputType: string): void;
  6529. private _addCheckInputs;
  6530. /**
  6531. * Attach the input controls to the currently attached dom element to listen the events from.
  6532. * @param input Defines the input to attach
  6533. */
  6534. attachInput(input: ICameraInput<TCamera>): void;
  6535. /**
  6536. * Attach the current manager inputs controls to a specific dom element to listen the events from.
  6537. * @param element Defines the dom element to collect the events from
  6538. * @param noPreventDefault Defines whether event caught by the controls should call preventdefault() (https://developer.mozilla.org/en-US/docs/Web/API/Event/preventDefault)
  6539. */
  6540. attachElement(element: HTMLElement, noPreventDefault?: boolean): void;
  6541. /**
  6542. * Detach the current manager inputs controls from a specific dom element.
  6543. * @param element Defines the dom element to collect the events from
  6544. * @param disconnect Defines whether the input should be removed from the current list of attached inputs
  6545. */
  6546. detachElement(element: HTMLElement, disconnect?: boolean): void;
  6547. /**
  6548. * Rebuild the dynamic inputCheck function from the current list of
  6549. * defined inputs in the manager.
  6550. */
  6551. rebuildInputCheck(): void;
  6552. /**
  6553. * Remove all attached input methods from a camera
  6554. */
  6555. clear(): void;
  6556. /**
  6557. * Serialize the current input manager attached to a camera.
  6558. * This ensures than once parsed,
  6559. * the input associated to the camera will be identical to the current ones
  6560. * @param serializedCamera Defines the camera serialization JSON the input serialization should write to
  6561. */
  6562. serialize(serializedCamera: any): void;
  6563. /**
  6564. * Parses an input manager serialized JSON to restore the previous list of inputs
  6565. * and states associated to a camera.
  6566. * @param parsedCamera Defines the JSON to parse
  6567. */
  6568. parse(parsedCamera: any): void;
  6569. }
  6570. }
  6571. declare module "babylonjs/Meshes/buffer" {
  6572. import { Nullable, DataArray } from "babylonjs/types";
  6573. import { DataBuffer } from "babylonjs/Meshes/dataBuffer";
  6574. /**
  6575. * Class used to store data that will be store in GPU memory
  6576. */
  6577. export class Buffer {
  6578. private _engine;
  6579. private _buffer;
  6580. /** @hidden */
  6581. _data: Nullable<DataArray>;
  6582. private _updatable;
  6583. private _instanced;
  6584. private _divisor;
  6585. /**
  6586. * Gets the byte stride.
  6587. */
  6588. readonly byteStride: number;
  6589. /**
  6590. * Constructor
  6591. * @param engine the engine
  6592. * @param data the data to use for this buffer
  6593. * @param updatable whether the data is updatable
  6594. * @param stride the stride (optional)
  6595. * @param postponeInternalCreation whether to postpone creating the internal WebGL buffer (optional)
  6596. * @param instanced whether the buffer is instanced (optional)
  6597. * @param useBytes set to true if the stride in in bytes (optional)
  6598. * @param divisor sets an optional divisor for instances (1 by default)
  6599. */
  6600. constructor(engine: any, data: DataArray, updatable: boolean, stride?: number, postponeInternalCreation?: boolean, instanced?: boolean, useBytes?: boolean, divisor?: number);
  6601. /**
  6602. * Create a new VertexBuffer based on the current buffer
  6603. * @param kind defines the vertex buffer kind (position, normal, etc.)
  6604. * @param offset defines offset in the buffer (0 by default)
  6605. * @param size defines the size in floats of attributes (position is 3 for instance)
  6606. * @param stride defines the stride size in floats in the buffer (the offset to apply to reach next value when data is interleaved)
  6607. * @param instanced defines if the vertex buffer contains indexed data
  6608. * @param useBytes defines if the offset and stride are in bytes *
  6609. * @param divisor sets an optional divisor for instances (1 by default)
  6610. * @returns the new vertex buffer
  6611. */
  6612. createVertexBuffer(kind: string, offset: number, size: number, stride?: number, instanced?: boolean, useBytes?: boolean, divisor?: number): VertexBuffer;
  6613. /**
  6614. * Gets a boolean indicating if the Buffer is updatable?
  6615. * @returns true if the buffer is updatable
  6616. */
  6617. isUpdatable(): boolean;
  6618. /**
  6619. * Gets current buffer's data
  6620. * @returns a DataArray or null
  6621. */
  6622. getData(): Nullable<DataArray>;
  6623. /**
  6624. * Gets underlying native buffer
  6625. * @returns underlying native buffer
  6626. */
  6627. getBuffer(): Nullable<DataBuffer>;
  6628. /**
  6629. * Gets the stride in float32 units (i.e. byte stride / 4).
  6630. * May not be an integer if the byte stride is not divisible by 4.
  6631. * @returns the stride in float32 units
  6632. * @deprecated Please use byteStride instead.
  6633. */
  6634. getStrideSize(): number;
  6635. /**
  6636. * Store data into the buffer. If the buffer was already used it will be either recreated or updated depending on isUpdatable property
  6637. * @param data defines the data to store
  6638. */
  6639. create(data?: Nullable<DataArray>): void;
  6640. /** @hidden */
  6641. _rebuild(): void;
  6642. /**
  6643. * Update current buffer data
  6644. * @param data defines the data to store
  6645. */
  6646. update(data: DataArray): void;
  6647. /**
  6648. * Updates the data directly.
  6649. * @param data the new data
  6650. * @param offset the new offset
  6651. * @param vertexCount the vertex count (optional)
  6652. * @param useBytes set to true if the offset is in bytes
  6653. */
  6654. updateDirectly(data: DataArray, offset: number, vertexCount?: number, useBytes?: boolean): void;
  6655. /**
  6656. * Release all resources
  6657. */
  6658. dispose(): void;
  6659. }
  6660. /**
  6661. * Specialized buffer used to store vertex data
  6662. */
  6663. export class VertexBuffer {
  6664. /** @hidden */
  6665. _buffer: Buffer;
  6666. private _kind;
  6667. private _size;
  6668. private _ownsBuffer;
  6669. private _instanced;
  6670. private _instanceDivisor;
  6671. /**
  6672. * The byte type.
  6673. */
  6674. static readonly BYTE: number;
  6675. /**
  6676. * The unsigned byte type.
  6677. */
  6678. static readonly UNSIGNED_BYTE: number;
  6679. /**
  6680. * The short type.
  6681. */
  6682. static readonly SHORT: number;
  6683. /**
  6684. * The unsigned short type.
  6685. */
  6686. static readonly UNSIGNED_SHORT: number;
  6687. /**
  6688. * The integer type.
  6689. */
  6690. static readonly INT: number;
  6691. /**
  6692. * The unsigned integer type.
  6693. */
  6694. static readonly UNSIGNED_INT: number;
  6695. /**
  6696. * The float type.
  6697. */
  6698. static readonly FLOAT: number;
  6699. /**
  6700. * Gets or sets the instance divisor when in instanced mode
  6701. */
  6702. get instanceDivisor(): number;
  6703. set instanceDivisor(value: number);
  6704. /**
  6705. * Gets the byte stride.
  6706. */
  6707. readonly byteStride: number;
  6708. /**
  6709. * Gets the byte offset.
  6710. */
  6711. readonly byteOffset: number;
  6712. /**
  6713. * Gets whether integer data values should be normalized into a certain range when being casted to a float.
  6714. */
  6715. readonly normalized: boolean;
  6716. /**
  6717. * Gets the data type of each component in the array.
  6718. */
  6719. readonly type: number;
  6720. /**
  6721. * Constructor
  6722. * @param engine the engine
  6723. * @param data the data to use for this vertex buffer
  6724. * @param kind the vertex buffer kind
  6725. * @param updatable whether the data is updatable
  6726. * @param postponeInternalCreation whether to postpone creating the internal WebGL buffer (optional)
  6727. * @param stride the stride (optional)
  6728. * @param instanced whether the buffer is instanced (optional)
  6729. * @param offset the offset of the data (optional)
  6730. * @param size the number of components (optional)
  6731. * @param type the type of the component (optional)
  6732. * @param normalized whether the data contains normalized data (optional)
  6733. * @param useBytes set to true if stride and offset are in bytes (optional)
  6734. * @param divisor defines the instance divisor to use (1 by default)
  6735. */
  6736. 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);
  6737. /** @hidden */
  6738. _rebuild(): void;
  6739. /**
  6740. * Returns the kind of the VertexBuffer (string)
  6741. * @returns a string
  6742. */
  6743. getKind(): string;
  6744. /**
  6745. * Gets a boolean indicating if the VertexBuffer is updatable?
  6746. * @returns true if the buffer is updatable
  6747. */
  6748. isUpdatable(): boolean;
  6749. /**
  6750. * Gets current buffer's data
  6751. * @returns a DataArray or null
  6752. */
  6753. getData(): Nullable<DataArray>;
  6754. /**
  6755. * Gets underlying native buffer
  6756. * @returns underlying native buffer
  6757. */
  6758. getBuffer(): Nullable<DataBuffer>;
  6759. /**
  6760. * Gets the stride in float32 units (i.e. byte stride / 4).
  6761. * May not be an integer if the byte stride is not divisible by 4.
  6762. * @returns the stride in float32 units
  6763. * @deprecated Please use byteStride instead.
  6764. */
  6765. getStrideSize(): number;
  6766. /**
  6767. * Returns the offset as a multiple of the type byte length.
  6768. * @returns the offset in bytes
  6769. * @deprecated Please use byteOffset instead.
  6770. */
  6771. getOffset(): number;
  6772. /**
  6773. * Returns the number of components per vertex attribute (integer)
  6774. * @returns the size in float
  6775. */
  6776. getSize(): number;
  6777. /**
  6778. * Gets a boolean indicating is the internal buffer of the VertexBuffer is instanced
  6779. * @returns true if this buffer is instanced
  6780. */
  6781. getIsInstanced(): boolean;
  6782. /**
  6783. * Returns the instancing divisor, zero for non-instanced (integer).
  6784. * @returns a number
  6785. */
  6786. getInstanceDivisor(): number;
  6787. /**
  6788. * Store data into the buffer. If the buffer was already used it will be either recreated or updated depending on isUpdatable property
  6789. * @param data defines the data to store
  6790. */
  6791. create(data?: DataArray): void;
  6792. /**
  6793. * Updates the underlying buffer according to the passed numeric array or Float32Array.
  6794. * This function will create a new buffer if the current one is not updatable
  6795. * @param data defines the data to store
  6796. */
  6797. update(data: DataArray): void;
  6798. /**
  6799. * Updates directly the underlying WebGLBuffer according to the passed numeric array or Float32Array.
  6800. * Returns the directly updated WebGLBuffer.
  6801. * @param data the new data
  6802. * @param offset the new offset
  6803. * @param useBytes set to true if the offset is in bytes
  6804. */
  6805. updateDirectly(data: DataArray, offset: number, useBytes?: boolean): void;
  6806. /**
  6807. * Disposes the VertexBuffer and the underlying WebGLBuffer.
  6808. */
  6809. dispose(): void;
  6810. /**
  6811. * Enumerates each value of this vertex buffer as numbers.
  6812. * @param count the number of values to enumerate
  6813. * @param callback the callback function called for each value
  6814. */
  6815. forEach(count: number, callback: (value: number, index: number) => void): void;
  6816. /**
  6817. * Positions
  6818. */
  6819. static readonly PositionKind: string;
  6820. /**
  6821. * Normals
  6822. */
  6823. static readonly NormalKind: string;
  6824. /**
  6825. * Tangents
  6826. */
  6827. static readonly TangentKind: string;
  6828. /**
  6829. * Texture coordinates
  6830. */
  6831. static readonly UVKind: string;
  6832. /**
  6833. * Texture coordinates 2
  6834. */
  6835. static readonly UV2Kind: string;
  6836. /**
  6837. * Texture coordinates 3
  6838. */
  6839. static readonly UV3Kind: string;
  6840. /**
  6841. * Texture coordinates 4
  6842. */
  6843. static readonly UV4Kind: string;
  6844. /**
  6845. * Texture coordinates 5
  6846. */
  6847. static readonly UV5Kind: string;
  6848. /**
  6849. * Texture coordinates 6
  6850. */
  6851. static readonly UV6Kind: string;
  6852. /**
  6853. * Colors
  6854. */
  6855. static readonly ColorKind: string;
  6856. /**
  6857. * Matrix indices (for bones)
  6858. */
  6859. static readonly MatricesIndicesKind: string;
  6860. /**
  6861. * Matrix weights (for bones)
  6862. */
  6863. static readonly MatricesWeightsKind: string;
  6864. /**
  6865. * Additional matrix indices (for bones)
  6866. */
  6867. static readonly MatricesIndicesExtraKind: string;
  6868. /**
  6869. * Additional matrix weights (for bones)
  6870. */
  6871. static readonly MatricesWeightsExtraKind: string;
  6872. /**
  6873. * Deduces the stride given a kind.
  6874. * @param kind The kind string to deduce
  6875. * @returns The deduced stride
  6876. */
  6877. static DeduceStride(kind: string): number;
  6878. /**
  6879. * Gets the byte length of the given type.
  6880. * @param type the type
  6881. * @returns the number of bytes
  6882. */
  6883. static GetTypeByteLength(type: number): number;
  6884. /**
  6885. * Enumerates each value of the given parameters as numbers.
  6886. * @param data the data to enumerate
  6887. * @param byteOffset the byte offset of the data
  6888. * @param byteStride the byte stride of the data
  6889. * @param componentCount the number of components per element
  6890. * @param componentType the type of the component
  6891. * @param count the number of values to enumerate
  6892. * @param normalized whether the data is normalized
  6893. * @param callback the callback function called for each value
  6894. */
  6895. static ForEach(data: DataArray, byteOffset: number, byteStride: number, componentCount: number, componentType: number, count: number, normalized: boolean, callback: (value: number, index: number) => void): void;
  6896. private static _GetFloatValue;
  6897. }
  6898. }
  6899. declare module "babylonjs/Meshes/Builders/capsuleBuilder" {
  6900. import { Vector3 } from "babylonjs/Maths/math.vector";
  6901. import { Mesh } from "babylonjs/Meshes/mesh";
  6902. /**
  6903. * The options Interface for creating a Capsule Mesh
  6904. */
  6905. export interface ICreateCapsuleOptions {
  6906. /** The Orientation of the capsule. Default : Vector3.Up() */
  6907. orientation?: Vector3;
  6908. /** Number of sub segments on the tube section of the capsule running parallel to orientation. */
  6909. subdivisions: number;
  6910. /** Number of cylindrical segments on the capsule. */
  6911. tessellation: number;
  6912. /** Height or Length of the capsule. */
  6913. height: number;
  6914. /** Radius of the capsule. */
  6915. radius: number;
  6916. /** Number of sub segments on the cap sections of the capsule running parallel to orientation. */
  6917. capSubdivisions: number;
  6918. /** Overwrite for the top radius. */
  6919. radiusTop?: number;
  6920. /** Overwrite for the bottom radius. */
  6921. radiusBottom?: number;
  6922. /** Overwrite for the top capSubdivisions. */
  6923. topCapSubdivisions?: number;
  6924. /** Overwrite for the bottom capSubdivisions. */
  6925. bottomCapSubdivisions?: number;
  6926. }
  6927. /**
  6928. * Class containing static functions to help procedurally build meshes
  6929. */
  6930. export class CapsuleBuilder {
  6931. /**
  6932. * Creates a capsule or a pill mesh
  6933. * @param name defines the name of the mesh
  6934. * @param options The constructors options.
  6935. * @param scene The scene the mesh is scoped to.
  6936. * @returns Capsule Mesh
  6937. */
  6938. static CreateCapsule(name: string, options: ICreateCapsuleOptions | undefined, scene: any): Mesh;
  6939. }
  6940. }
  6941. declare module "babylonjs/Collisions/intersectionInfo" {
  6942. import { Nullable } from "babylonjs/types";
  6943. /**
  6944. * @hidden
  6945. */
  6946. export class IntersectionInfo {
  6947. bu: Nullable<number>;
  6948. bv: Nullable<number>;
  6949. distance: number;
  6950. faceId: number;
  6951. subMeshId: number;
  6952. constructor(bu: Nullable<number>, bv: Nullable<number>, distance: number);
  6953. }
  6954. }
  6955. declare module "babylonjs/Culling/boundingSphere" {
  6956. import { DeepImmutable } from "babylonjs/types";
  6957. import { Matrix, Vector3 } from "babylonjs/Maths/math.vector";
  6958. import { Plane } from "babylonjs/Maths/math.plane";
  6959. /**
  6960. * Class used to store bounding sphere information
  6961. */
  6962. export class BoundingSphere {
  6963. /**
  6964. * Gets the center of the bounding sphere in local space
  6965. */
  6966. readonly center: Vector3;
  6967. /**
  6968. * Radius of the bounding sphere in local space
  6969. */
  6970. radius: number;
  6971. /**
  6972. * Gets the center of the bounding sphere in world space
  6973. */
  6974. readonly centerWorld: Vector3;
  6975. /**
  6976. * Radius of the bounding sphere in world space
  6977. */
  6978. radiusWorld: number;
  6979. /**
  6980. * Gets the minimum vector in local space
  6981. */
  6982. readonly minimum: Vector3;
  6983. /**
  6984. * Gets the maximum vector in local space
  6985. */
  6986. readonly maximum: Vector3;
  6987. private _worldMatrix;
  6988. private static readonly TmpVector3;
  6989. /**
  6990. * Creates a new bounding sphere
  6991. * @param min defines the minimum vector (in local space)
  6992. * @param max defines the maximum vector (in local space)
  6993. * @param worldMatrix defines the new world matrix
  6994. */
  6995. constructor(min: DeepImmutable<Vector3>, max: DeepImmutable<Vector3>, worldMatrix?: DeepImmutable<Matrix>);
  6996. /**
  6997. * Recreates the entire bounding sphere from scratch as if we call the constructor in place
  6998. * @param min defines the new minimum vector (in local space)
  6999. * @param max defines the new maximum vector (in local space)
  7000. * @param worldMatrix defines the new world matrix
  7001. */
  7002. reConstruct(min: DeepImmutable<Vector3>, max: DeepImmutable<Vector3>, worldMatrix?: DeepImmutable<Matrix>): void;
  7003. /**
  7004. * Scale the current bounding sphere by applying a scale factor
  7005. * @param factor defines the scale factor to apply
  7006. * @returns the current bounding box
  7007. */
  7008. scale(factor: number): BoundingSphere;
  7009. /**
  7010. * Gets the world matrix of the bounding box
  7011. * @returns a matrix
  7012. */
  7013. getWorldMatrix(): DeepImmutable<Matrix>;
  7014. /** @hidden */
  7015. _update(worldMatrix: DeepImmutable<Matrix>): void;
  7016. /**
  7017. * Tests if the bounding sphere is intersecting the frustum planes
  7018. * @param frustumPlanes defines the frustum planes to test
  7019. * @returns true if there is an intersection
  7020. */
  7021. isInFrustum(frustumPlanes: Array<DeepImmutable<Plane>>): boolean;
  7022. /**
  7023. * Tests if the bounding sphere center is in between the frustum planes.
  7024. * Used for optimistic fast inclusion.
  7025. * @param frustumPlanes defines the frustum planes to test
  7026. * @returns true if the sphere center is in between the frustum planes
  7027. */
  7028. isCenterInFrustum(frustumPlanes: Array<DeepImmutable<Plane>>): boolean;
  7029. /**
  7030. * Tests if a point is inside the bounding sphere
  7031. * @param point defines the point to test
  7032. * @returns true if the point is inside the bounding sphere
  7033. */
  7034. intersectsPoint(point: DeepImmutable<Vector3>): boolean;
  7035. /**
  7036. * Checks if two sphere intersct
  7037. * @param sphere0 sphere 0
  7038. * @param sphere1 sphere 1
  7039. * @returns true if the speres intersect
  7040. */
  7041. static Intersects(sphere0: DeepImmutable<BoundingSphere>, sphere1: DeepImmutable<BoundingSphere>): boolean;
  7042. }
  7043. }
  7044. declare module "babylonjs/Culling/boundingBox" {
  7045. import { DeepImmutable } from "babylonjs/types";
  7046. import { Matrix, Vector3 } from "babylonjs/Maths/math.vector";
  7047. import { BoundingSphere } from "babylonjs/Culling/boundingSphere";
  7048. import { ICullable } from "babylonjs/Culling/boundingInfo";
  7049. import { Plane } from "babylonjs/Maths/math.plane";
  7050. /**
  7051. * Class used to store bounding box information
  7052. */
  7053. export class BoundingBox implements ICullable {
  7054. /**
  7055. * Gets the 8 vectors representing the bounding box in local space
  7056. */
  7057. readonly vectors: Vector3[];
  7058. /**
  7059. * Gets the center of the bounding box in local space
  7060. */
  7061. readonly center: Vector3;
  7062. /**
  7063. * Gets the center of the bounding box in world space
  7064. */
  7065. readonly centerWorld: Vector3;
  7066. /**
  7067. * Gets the extend size in local space
  7068. */
  7069. readonly extendSize: Vector3;
  7070. /**
  7071. * Gets the extend size in world space
  7072. */
  7073. readonly extendSizeWorld: Vector3;
  7074. /**
  7075. * Gets the OBB (object bounding box) directions
  7076. */
  7077. readonly directions: Vector3[];
  7078. /**
  7079. * Gets the 8 vectors representing the bounding box in world space
  7080. */
  7081. readonly vectorsWorld: Vector3[];
  7082. /**
  7083. * Gets the minimum vector in world space
  7084. */
  7085. readonly minimumWorld: Vector3;
  7086. /**
  7087. * Gets the maximum vector in world space
  7088. */
  7089. readonly maximumWorld: Vector3;
  7090. /**
  7091. * Gets the minimum vector in local space
  7092. */
  7093. readonly minimum: Vector3;
  7094. /**
  7095. * Gets the maximum vector in local space
  7096. */
  7097. readonly maximum: Vector3;
  7098. private _worldMatrix;
  7099. private static readonly TmpVector3;
  7100. /**
  7101. * @hidden
  7102. */
  7103. _tag: number;
  7104. /**
  7105. * Creates a new bounding box
  7106. * @param min defines the minimum vector (in local space)
  7107. * @param max defines the maximum vector (in local space)
  7108. * @param worldMatrix defines the new world matrix
  7109. */
  7110. constructor(min: DeepImmutable<Vector3>, max: DeepImmutable<Vector3>, worldMatrix?: DeepImmutable<Matrix>);
  7111. /**
  7112. * Recreates the entire bounding box from scratch as if we call the constructor in place
  7113. * @param min defines the new minimum vector (in local space)
  7114. * @param max defines the new maximum vector (in local space)
  7115. * @param worldMatrix defines the new world matrix
  7116. */
  7117. reConstruct(min: DeepImmutable<Vector3>, max: DeepImmutable<Vector3>, worldMatrix?: DeepImmutable<Matrix>): void;
  7118. /**
  7119. * Scale the current bounding box by applying a scale factor
  7120. * @param factor defines the scale factor to apply
  7121. * @returns the current bounding box
  7122. */
  7123. scale(factor: number): BoundingBox;
  7124. /**
  7125. * Gets the world matrix of the bounding box
  7126. * @returns a matrix
  7127. */
  7128. getWorldMatrix(): DeepImmutable<Matrix>;
  7129. /** @hidden */
  7130. _update(world: DeepImmutable<Matrix>): void;
  7131. /**
  7132. * Tests if the bounding box is intersecting the frustum planes
  7133. * @param frustumPlanes defines the frustum planes to test
  7134. * @returns true if there is an intersection
  7135. */
  7136. isInFrustum(frustumPlanes: Array<DeepImmutable<Plane>>): boolean;
  7137. /**
  7138. * Tests if the bounding box is entirely inside the frustum planes
  7139. * @param frustumPlanes defines the frustum planes to test
  7140. * @returns true if there is an inclusion
  7141. */
  7142. isCompletelyInFrustum(frustumPlanes: Array<DeepImmutable<Plane>>): boolean;
  7143. /**
  7144. * Tests if a point is inside the bounding box
  7145. * @param point defines the point to test
  7146. * @returns true if the point is inside the bounding box
  7147. */
  7148. intersectsPoint(point: DeepImmutable<Vector3>): boolean;
  7149. /**
  7150. * Tests if the bounding box intersects with a bounding sphere
  7151. * @param sphere defines the sphere to test
  7152. * @returns true if there is an intersection
  7153. */
  7154. intersectsSphere(sphere: DeepImmutable<BoundingSphere>): boolean;
  7155. /**
  7156. * Tests if the bounding box intersects with a box defined by a min and max vectors
  7157. * @param min defines the min vector to use
  7158. * @param max defines the max vector to use
  7159. * @returns true if there is an intersection
  7160. */
  7161. intersectsMinMax(min: DeepImmutable<Vector3>, max: DeepImmutable<Vector3>): boolean;
  7162. /**
  7163. * Tests if two bounding boxes are intersections
  7164. * @param box0 defines the first box to test
  7165. * @param box1 defines the second box to test
  7166. * @returns true if there is an intersection
  7167. */
  7168. static Intersects(box0: DeepImmutable<BoundingBox>, box1: DeepImmutable<BoundingBox>): boolean;
  7169. /**
  7170. * Tests if a bounding box defines by a min/max vectors intersects a sphere
  7171. * @param minPoint defines the minimum vector of the bounding box
  7172. * @param maxPoint defines the maximum vector of the bounding box
  7173. * @param sphereCenter defines the sphere center
  7174. * @param sphereRadius defines the sphere radius
  7175. * @returns true if there is an intersection
  7176. */
  7177. static IntersectsSphere(minPoint: DeepImmutable<Vector3>, maxPoint: DeepImmutable<Vector3>, sphereCenter: DeepImmutable<Vector3>, sphereRadius: number): boolean;
  7178. /**
  7179. * Tests if a bounding box defined with 8 vectors is entirely inside frustum planes
  7180. * @param boundingVectors defines an array of 8 vectors representing a bounding box
  7181. * @param frustumPlanes defines the frustum planes to test
  7182. * @return true if there is an inclusion
  7183. */
  7184. static IsCompletelyInFrustum(boundingVectors: Array<DeepImmutable<Vector3>>, frustumPlanes: Array<DeepImmutable<Plane>>): boolean;
  7185. /**
  7186. * Tests if a bounding box defined with 8 vectors intersects frustum planes
  7187. * @param boundingVectors defines an array of 8 vectors representing a bounding box
  7188. * @param frustumPlanes defines the frustum planes to test
  7189. * @return true if there is an intersection
  7190. */
  7191. static IsInFrustum(boundingVectors: Array<DeepImmutable<Vector3>>, frustumPlanes: Array<DeepImmutable<Plane>>): boolean;
  7192. }
  7193. }
  7194. declare module "babylonjs/Collisions/collider" {
  7195. import { Nullable, IndicesArray } from "babylonjs/types";
  7196. import { Vector3 } from "babylonjs/Maths/math.vector";
  7197. import { AbstractMesh } from "babylonjs/Meshes/abstractMesh";
  7198. import { Plane } from "babylonjs/Maths/math.plane";
  7199. /** @hidden */
  7200. export class Collider {
  7201. /** Define if a collision was found */
  7202. collisionFound: boolean;
  7203. /**
  7204. * Define last intersection point in local space
  7205. */
  7206. intersectionPoint: Vector3;
  7207. /**
  7208. * Define last collided mesh
  7209. */
  7210. collidedMesh: Nullable<AbstractMesh>;
  7211. private _collisionPoint;
  7212. private _planeIntersectionPoint;
  7213. private _tempVector;
  7214. private _tempVector2;
  7215. private _tempVector3;
  7216. private _tempVector4;
  7217. private _edge;
  7218. private _baseToVertex;
  7219. private _destinationPoint;
  7220. private _slidePlaneNormal;
  7221. private _displacementVector;
  7222. /** @hidden */
  7223. _radius: Vector3;
  7224. /** @hidden */
  7225. _retry: number;
  7226. private _velocity;
  7227. private _basePoint;
  7228. private _epsilon;
  7229. /** @hidden */
  7230. _velocityWorldLength: number;
  7231. /** @hidden */
  7232. _basePointWorld: Vector3;
  7233. private _velocityWorld;
  7234. private _normalizedVelocity;
  7235. /** @hidden */
  7236. _initialVelocity: Vector3;
  7237. /** @hidden */
  7238. _initialPosition: Vector3;
  7239. private _nearestDistance;
  7240. private _collisionMask;
  7241. get collisionMask(): number;
  7242. set collisionMask(mask: number);
  7243. /**
  7244. * Gets the plane normal used to compute the sliding response (in local space)
  7245. */
  7246. get slidePlaneNormal(): Vector3;
  7247. /** @hidden */
  7248. _initialize(source: Vector3, dir: Vector3, e: number): void;
  7249. /** @hidden */
  7250. _checkPointInTriangle(point: Vector3, pa: Vector3, pb: Vector3, pc: Vector3, n: Vector3): boolean;
  7251. /** @hidden */
  7252. _canDoCollision(sphereCenter: Vector3, sphereRadius: number, vecMin: Vector3, vecMax: Vector3): boolean;
  7253. /** @hidden */
  7254. _testTriangle(faceIndex: number, trianglePlaneArray: Array<Plane>, p1: Vector3, p2: Vector3, p3: Vector3, hasMaterial: boolean, hostMesh: AbstractMesh): void;
  7255. /** @hidden */
  7256. _collide(trianglePlaneArray: Array<Plane>, pts: Vector3[], indices: IndicesArray, indexStart: number, indexEnd: number, decal: number, hasMaterial: boolean, hostMesh: AbstractMesh): void;
  7257. /** @hidden */
  7258. _getResponse(pos: Vector3, vel: Vector3): void;
  7259. }
  7260. }
  7261. declare module "babylonjs/Culling/boundingInfo" {
  7262. import { DeepImmutable } from "babylonjs/types";
  7263. import { Matrix, Vector3 } from "babylonjs/Maths/math.vector";
  7264. import { BoundingBox } from "babylonjs/Culling/boundingBox";
  7265. import { BoundingSphere } from "babylonjs/Culling/boundingSphere";
  7266. import { Plane } from "babylonjs/Maths/math.plane";
  7267. import { Collider } from "babylonjs/Collisions/collider";
  7268. /**
  7269. * Interface for cullable objects
  7270. * @see https://doc.babylonjs.com/babylon101/materials#back-face-culling
  7271. */
  7272. export interface ICullable {
  7273. /**
  7274. * Checks if the object or part of the object is in the frustum
  7275. * @param frustumPlanes Camera near/planes
  7276. * @returns true if the object is in frustum otherwise false
  7277. */
  7278. isInFrustum(frustumPlanes: Plane[]): boolean;
  7279. /**
  7280. * Checks if a cullable object (mesh...) is in the camera frustum
  7281. * Unlike isInFrustum this cheks the full bounding box
  7282. * @param frustumPlanes Camera near/planes
  7283. * @returns true if the object is in frustum otherwise false
  7284. */
  7285. isCompletelyInFrustum(frustumPlanes: Plane[]): boolean;
  7286. }
  7287. /**
  7288. * Info for a bounding data of a mesh
  7289. */
  7290. export class BoundingInfo implements ICullable {
  7291. /**
  7292. * Bounding box for the mesh
  7293. */
  7294. readonly boundingBox: BoundingBox;
  7295. /**
  7296. * Bounding sphere for the mesh
  7297. */
  7298. readonly boundingSphere: BoundingSphere;
  7299. private _isLocked;
  7300. private static readonly TmpVector3;
  7301. /**
  7302. * Constructs bounding info
  7303. * @param minimum min vector of the bounding box/sphere
  7304. * @param maximum max vector of the bounding box/sphere
  7305. * @param worldMatrix defines the new world matrix
  7306. */
  7307. constructor(minimum: DeepImmutable<Vector3>, maximum: DeepImmutable<Vector3>, worldMatrix?: DeepImmutable<Matrix>);
  7308. /**
  7309. * Recreates the entire bounding info from scratch as if we call the constructor in place
  7310. * @param min defines the new minimum vector (in local space)
  7311. * @param max defines the new maximum vector (in local space)
  7312. * @param worldMatrix defines the new world matrix
  7313. */
  7314. reConstruct(min: DeepImmutable<Vector3>, max: DeepImmutable<Vector3>, worldMatrix?: DeepImmutable<Matrix>): void;
  7315. /**
  7316. * min vector of the bounding box/sphere
  7317. */
  7318. get minimum(): Vector3;
  7319. /**
  7320. * max vector of the bounding box/sphere
  7321. */
  7322. get maximum(): Vector3;
  7323. /**
  7324. * If the info is locked and won't be updated to avoid perf overhead
  7325. */
  7326. get isLocked(): boolean;
  7327. set isLocked(value: boolean);
  7328. /**
  7329. * Updates the bounding sphere and box
  7330. * @param world world matrix to be used to update
  7331. */
  7332. update(world: DeepImmutable<Matrix>): void;
  7333. /**
  7334. * Recreate the bounding info to be centered around a specific point given a specific extend.
  7335. * @param center New center of the bounding info
  7336. * @param extend New extend of the bounding info
  7337. * @returns the current bounding info
  7338. */
  7339. centerOn(center: DeepImmutable<Vector3>, extend: DeepImmutable<Vector3>): BoundingInfo;
  7340. /**
  7341. * Scale the current bounding info by applying a scale factor
  7342. * @param factor defines the scale factor to apply
  7343. * @returns the current bounding info
  7344. */
  7345. scale(factor: number): BoundingInfo;
  7346. /**
  7347. * Returns `true` if the bounding info is within the frustum defined by the passed array of planes.
  7348. * @param frustumPlanes defines the frustum to test
  7349. * @param strategy defines the strategy to use for the culling (default is BABYLON.AbstractMesh.CULLINGSTRATEGY_STANDARD)
  7350. * @returns true if the bounding info is in the frustum planes
  7351. */
  7352. isInFrustum(frustumPlanes: Array<DeepImmutable<Plane>>, strategy?: number): boolean;
  7353. /**
  7354. * Gets the world distance between the min and max points of the bounding box
  7355. */
  7356. get diagonalLength(): number;
  7357. /**
  7358. * Checks if a cullable object (mesh...) is in the camera frustum
  7359. * Unlike isInFrustum this cheks the full bounding box
  7360. * @param frustumPlanes Camera near/planes
  7361. * @returns true if the object is in frustum otherwise false
  7362. */
  7363. isCompletelyInFrustum(frustumPlanes: Array<DeepImmutable<Plane>>): boolean;
  7364. /** @hidden */
  7365. _checkCollision(collider: Collider): boolean;
  7366. /**
  7367. * Checks if a point is inside the bounding box and bounding sphere or the mesh
  7368. * @see https://doc.babylonjs.com/babylon101/intersect_collisions_-_mesh
  7369. * @param point the point to check intersection with
  7370. * @returns if the point intersects
  7371. */
  7372. intersectsPoint(point: DeepImmutable<Vector3>): boolean;
  7373. /**
  7374. * Checks if another bounding info intersects the bounding box and bounding sphere or the mesh
  7375. * @see https://doc.babylonjs.com/babylon101/intersect_collisions_-_mesh
  7376. * @param boundingInfo the bounding info to check intersection with
  7377. * @param precise if the intersection should be done using OBB
  7378. * @returns if the bounding info intersects
  7379. */
  7380. intersects(boundingInfo: DeepImmutable<BoundingInfo>, precise: boolean): boolean;
  7381. }
  7382. }
  7383. declare module "babylonjs/Maths/math.functions" {
  7384. import { FloatArray, Nullable, IndicesArray } from "babylonjs/types";
  7385. import { Vector2, Vector3 } from "babylonjs/Maths/math.vector";
  7386. /**
  7387. * Extracts minimum and maximum values from a list of indexed positions
  7388. * @param positions defines the positions to use
  7389. * @param indices defines the indices to the positions
  7390. * @param indexStart defines the start index
  7391. * @param indexCount defines the end index
  7392. * @param bias defines bias value to add to the result
  7393. * @return minimum and maximum values
  7394. */
  7395. export function extractMinAndMaxIndexed(positions: FloatArray, indices: IndicesArray, indexStart: number, indexCount: number, bias?: Nullable<Vector2>): {
  7396. minimum: Vector3;
  7397. maximum: Vector3;
  7398. };
  7399. /**
  7400. * Extracts minimum and maximum values from a list of positions
  7401. * @param positions defines the positions to use
  7402. * @param start defines the start index in the positions array
  7403. * @param count defines the number of positions to handle
  7404. * @param bias defines bias value to add to the result
  7405. * @param stride defines the stride size to use (distance between two positions in the positions array)
  7406. * @return minimum and maximum values
  7407. */
  7408. export function extractMinAndMax(positions: FloatArray, start: number, count: number, bias?: Nullable<Vector2>, stride?: number): {
  7409. minimum: Vector3;
  7410. maximum: Vector3;
  7411. };
  7412. }
  7413. declare module "babylonjs/Meshes/WebGL/webGLDataBuffer" {
  7414. import { DataBuffer } from "babylonjs/Meshes/dataBuffer";
  7415. /** @hidden */
  7416. export class WebGLDataBuffer extends DataBuffer {
  7417. private _buffer;
  7418. constructor(resource: WebGLBuffer);
  7419. get underlyingResource(): any;
  7420. }
  7421. }
  7422. declare module "babylonjs/Engines/WebGL/webGLPipelineContext" {
  7423. import { IPipelineContext } from "babylonjs/Engines/IPipelineContext";
  7424. import { Nullable } from "babylonjs/types";
  7425. import { ThinEngine } from "babylonjs/Engines/thinEngine";
  7426. /** @hidden */
  7427. export class WebGLPipelineContext implements IPipelineContext {
  7428. engine: ThinEngine;
  7429. program: Nullable<WebGLProgram>;
  7430. context?: WebGLRenderingContext;
  7431. vertexShader?: WebGLShader;
  7432. fragmentShader?: WebGLShader;
  7433. isParallelCompiled: boolean;
  7434. onCompiled?: () => void;
  7435. transformFeedback?: WebGLTransformFeedback | null;
  7436. vertexCompilationError: Nullable<string>;
  7437. fragmentCompilationError: Nullable<string>;
  7438. programLinkError: Nullable<string>;
  7439. programValidationError: Nullable<string>;
  7440. get isAsync(): boolean;
  7441. get isReady(): boolean;
  7442. _handlesSpectorRebuildCallback(onCompiled: (program: WebGLProgram) => void): void;
  7443. _getVertexShaderCode(): string | null;
  7444. _getFragmentShaderCode(): string | null;
  7445. }
  7446. }
  7447. declare module "babylonjs/Engines/Extensions/engine.uniformBuffer" {
  7448. import { FloatArray, Nullable } from "babylonjs/types";
  7449. import { DataBuffer } from "babylonjs/Meshes/dataBuffer";
  7450. import { IPipelineContext } from "babylonjs/Engines/IPipelineContext";
  7451. module "babylonjs/Engines/thinEngine" {
  7452. interface ThinEngine {
  7453. /**
  7454. * Create an uniform buffer
  7455. * @see https://doc.babylonjs.com/features/webgl2#uniform-buffer-objets
  7456. * @param elements defines the content of the uniform buffer
  7457. * @returns the webGL uniform buffer
  7458. */
  7459. createUniformBuffer(elements: FloatArray): DataBuffer;
  7460. /**
  7461. * Create a dynamic uniform buffer
  7462. * @see https://doc.babylonjs.com/features/webgl2#uniform-buffer-objets
  7463. * @param elements defines the content of the uniform buffer
  7464. * @returns the webGL uniform buffer
  7465. */
  7466. createDynamicUniformBuffer(elements: FloatArray): DataBuffer;
  7467. /**
  7468. * Update an existing uniform buffer
  7469. * @see https://doc.babylonjs.com/features/webgl2#uniform-buffer-objets
  7470. * @param uniformBuffer defines the target uniform buffer
  7471. * @param elements defines the content to update
  7472. * @param offset defines the offset in the uniform buffer where update should start
  7473. * @param count defines the size of the data to update
  7474. */
  7475. updateUniformBuffer(uniformBuffer: DataBuffer, elements: FloatArray, offset?: number, count?: number): void;
  7476. /**
  7477. * Bind an uniform buffer to the current webGL context
  7478. * @param buffer defines the buffer to bind
  7479. */
  7480. bindUniformBuffer(buffer: Nullable<DataBuffer>): void;
  7481. /**
  7482. * Bind a buffer to the current webGL context at a given location
  7483. * @param buffer defines the buffer to bind
  7484. * @param location defines the index where to bind the buffer
  7485. */
  7486. bindUniformBufferBase(buffer: DataBuffer, location: number): void;
  7487. /**
  7488. * Bind a specific block at a given index in a specific shader program
  7489. * @param pipelineContext defines the pipeline context to use
  7490. * @param blockName defines the block name
  7491. * @param index defines the index where to bind the block
  7492. */
  7493. bindUniformBlock(pipelineContext: IPipelineContext, blockName: string, index: number): void;
  7494. }
  7495. }
  7496. }
  7497. declare module "babylonjs/Materials/uniformBuffer" {
  7498. import { Nullable, FloatArray } from "babylonjs/types";
  7499. import { Matrix, Vector3, Vector4 } from "babylonjs/Maths/math.vector";
  7500. import { Engine } from "babylonjs/Engines/engine";
  7501. import { Effect } from "babylonjs/Materials/effect";
  7502. import { BaseTexture } from "babylonjs/Materials/Textures/baseTexture";
  7503. import { DataBuffer } from "babylonjs/Meshes/dataBuffer";
  7504. import { Color3 } from "babylonjs/Maths/math.color";
  7505. import "babylonjs/Engines/Extensions/engine.uniformBuffer";
  7506. /**
  7507. * Uniform buffer objects.
  7508. *
  7509. * Handles blocks of uniform on the GPU.
  7510. *
  7511. * If WebGL 2 is not available, this class falls back on traditionnal setUniformXXX calls.
  7512. *
  7513. * For more information, please refer to :
  7514. * https://www.khronos.org/opengl/wiki/Uniform_Buffer_Object
  7515. */
  7516. export class UniformBuffer {
  7517. private _engine;
  7518. private _buffer;
  7519. private _data;
  7520. private _bufferData;
  7521. private _dynamic?;
  7522. private _uniformLocations;
  7523. private _uniformSizes;
  7524. private _uniformLocationPointer;
  7525. private _needSync;
  7526. private _noUBO;
  7527. private _currentEffect;
  7528. /** @hidden */
  7529. _alreadyBound: boolean;
  7530. private static _MAX_UNIFORM_SIZE;
  7531. private static _tempBuffer;
  7532. /**
  7533. * Lambda to Update a 3x3 Matrix in a uniform buffer.
  7534. * This is dynamic to allow compat with webgl 1 and 2.
  7535. * You will need to pass the name of the uniform as well as the value.
  7536. */
  7537. updateMatrix3x3: (name: string, matrix: Float32Array) => void;
  7538. /**
  7539. * Lambda to Update a 2x2 Matrix in a uniform buffer.
  7540. * This is dynamic to allow compat with webgl 1 and 2.
  7541. * You will need to pass the name of the uniform as well as the value.
  7542. */
  7543. updateMatrix2x2: (name: string, matrix: Float32Array) => void;
  7544. /**
  7545. * Lambda to Update a single float in a uniform buffer.
  7546. * This is dynamic to allow compat with webgl 1 and 2.
  7547. * You will need to pass the name of the uniform as well as the value.
  7548. */
  7549. updateFloat: (name: string, x: number) => void;
  7550. /**
  7551. * Lambda to Update a vec2 of float in a uniform buffer.
  7552. * This is dynamic to allow compat with webgl 1 and 2.
  7553. * You will need to pass the name of the uniform as well as the value.
  7554. */
  7555. updateFloat2: (name: string, x: number, y: number, suffix?: string) => void;
  7556. /**
  7557. * Lambda to Update a vec3 of float in a uniform buffer.
  7558. * This is dynamic to allow compat with webgl 1 and 2.
  7559. * You will need to pass the name of the uniform as well as the value.
  7560. */
  7561. updateFloat3: (name: string, x: number, y: number, z: number, suffix?: string) => void;
  7562. /**
  7563. * Lambda to Update a vec4 of float in a uniform buffer.
  7564. * This is dynamic to allow compat with webgl 1 and 2.
  7565. * You will need to pass the name of the uniform as well as the value.
  7566. */
  7567. updateFloat4: (name: string, x: number, y: number, z: number, w: number, suffix?: string) => void;
  7568. /**
  7569. * Lambda to Update a 4x4 Matrix in a uniform buffer.
  7570. * This is dynamic to allow compat with webgl 1 and 2.
  7571. * You will need to pass the name of the uniform as well as the value.
  7572. */
  7573. updateMatrix: (name: string, mat: Matrix) => void;
  7574. /**
  7575. * Lambda to Update vec3 of float from a Vector in a uniform buffer.
  7576. * This is dynamic to allow compat with webgl 1 and 2.
  7577. * You will need to pass the name of the uniform as well as the value.
  7578. */
  7579. updateVector3: (name: string, vector: Vector3) => void;
  7580. /**
  7581. * Lambda to Update vec4 of float from a Vector in a uniform buffer.
  7582. * This is dynamic to allow compat with webgl 1 and 2.
  7583. * You will need to pass the name of the uniform as well as the value.
  7584. */
  7585. updateVector4: (name: string, vector: Vector4) => void;
  7586. /**
  7587. * Lambda to Update vec3 of float from a Color in a uniform buffer.
  7588. * This is dynamic to allow compat with webgl 1 and 2.
  7589. * You will need to pass the name of the uniform as well as the value.
  7590. */
  7591. updateColor3: (name: string, color: Color3, suffix?: string) => void;
  7592. /**
  7593. * Lambda to Update vec4 of float from a Color in a uniform buffer.
  7594. * This is dynamic to allow compat with webgl 1 and 2.
  7595. * You will need to pass the name of the uniform as well as the value.
  7596. */
  7597. updateColor4: (name: string, color: Color3, alpha: number, suffix?: string) => void;
  7598. /**
  7599. * Instantiates a new Uniform buffer objects.
  7600. *
  7601. * Handles blocks of uniform on the GPU.
  7602. *
  7603. * If WebGL 2 is not available, this class falls back on traditionnal setUniformXXX calls.
  7604. *
  7605. * For more information, please refer to :
  7606. * @see https://www.khronos.org/opengl/wiki/Uniform_Buffer_Object
  7607. * @param engine Define the engine the buffer is associated with
  7608. * @param data Define the data contained in the buffer
  7609. * @param dynamic Define if the buffer is updatable
  7610. */
  7611. constructor(engine: Engine, data?: number[], dynamic?: boolean);
  7612. /**
  7613. * Indicates if the buffer is using the WebGL2 UBO implementation,
  7614. * or just falling back on setUniformXXX calls.
  7615. */
  7616. get useUbo(): boolean;
  7617. /**
  7618. * Indicates if the WebGL underlying uniform buffer is in sync
  7619. * with the javascript cache data.
  7620. */
  7621. get isSync(): boolean;
  7622. /**
  7623. * Indicates if the WebGL underlying uniform buffer is dynamic.
  7624. * Also, a dynamic UniformBuffer will disable cache verification and always
  7625. * update the underlying WebGL uniform buffer to the GPU.
  7626. * @returns if Dynamic, otherwise false
  7627. */
  7628. isDynamic(): boolean;
  7629. /**
  7630. * The data cache on JS side.
  7631. * @returns the underlying data as a float array
  7632. */
  7633. getData(): Float32Array;
  7634. /**
  7635. * The underlying WebGL Uniform buffer.
  7636. * @returns the webgl buffer
  7637. */
  7638. getBuffer(): Nullable<DataBuffer>;
  7639. /**
  7640. * std140 layout specifies how to align data within an UBO structure.
  7641. * See https://khronos.org/registry/OpenGL/specs/gl/glspec45.core.pdf#page=159
  7642. * for specs.
  7643. */
  7644. private _fillAlignment;
  7645. /**
  7646. * Adds an uniform in the buffer.
  7647. * Warning : the subsequents calls of this function must be in the same order as declared in the shader
  7648. * for the layout to be correct !
  7649. * @param name Name of the uniform, as used in the uniform block in the shader.
  7650. * @param size Data size, or data directly.
  7651. */
  7652. addUniform(name: string, size: number | number[]): void;
  7653. /**
  7654. * Adds a Matrix 4x4 to the uniform buffer.
  7655. * @param name Name of the uniform, as used in the uniform block in the shader.
  7656. * @param mat A 4x4 matrix.
  7657. */
  7658. addMatrix(name: string, mat: Matrix): void;
  7659. /**
  7660. * Adds a vec2 to the uniform buffer.
  7661. * @param name Name of the uniform, as used in the uniform block in the shader.
  7662. * @param x Define the x component value of the vec2
  7663. * @param y Define the y component value of the vec2
  7664. */
  7665. addFloat2(name: string, x: number, y: number): void;
  7666. /**
  7667. * Adds a vec3 to the uniform buffer.
  7668. * @param name Name of the uniform, as used in the uniform block in the shader.
  7669. * @param x Define the x component value of the vec3
  7670. * @param y Define the y component value of the vec3
  7671. * @param z Define the z component value of the vec3
  7672. */
  7673. addFloat3(name: string, x: number, y: number, z: number): void;
  7674. /**
  7675. * Adds a vec3 to the uniform buffer.
  7676. * @param name Name of the uniform, as used in the uniform block in the shader.
  7677. * @param color Define the vec3 from a Color
  7678. */
  7679. addColor3(name: string, color: Color3): void;
  7680. /**
  7681. * Adds a vec4 to the uniform buffer.
  7682. * @param name Name of the uniform, as used in the uniform block in the shader.
  7683. * @param color Define the rgb components from a Color
  7684. * @param alpha Define the a component of the vec4
  7685. */
  7686. addColor4(name: string, color: Color3, alpha: number): void;
  7687. /**
  7688. * Adds a vec3 to the uniform buffer.
  7689. * @param name Name of the uniform, as used in the uniform block in the shader.
  7690. * @param vector Define the vec3 components from a Vector
  7691. */
  7692. addVector3(name: string, vector: Vector3): void;
  7693. /**
  7694. * Adds a Matrix 3x3 to the uniform buffer.
  7695. * @param name Name of the uniform, as used in the uniform block in the shader.
  7696. */
  7697. addMatrix3x3(name: string): void;
  7698. /**
  7699. * Adds a Matrix 2x2 to the uniform buffer.
  7700. * @param name Name of the uniform, as used in the uniform block in the shader.
  7701. */
  7702. addMatrix2x2(name: string): void;
  7703. /**
  7704. * Effectively creates the WebGL Uniform Buffer, once layout is completed with `addUniform`.
  7705. */
  7706. create(): void;
  7707. /** @hidden */
  7708. _rebuild(): void;
  7709. /**
  7710. * Updates the WebGL Uniform Buffer on the GPU.
  7711. * If the `dynamic` flag is set to true, no cache comparison is done.
  7712. * Otherwise, the buffer will be updated only if the cache differs.
  7713. */
  7714. update(): void;
  7715. /**
  7716. * Updates the value of an uniform. The `update` method must be called afterwards to make it effective in the GPU.
  7717. * @param uniformName Define the name of the uniform, as used in the uniform block in the shader.
  7718. * @param data Define the flattened data
  7719. * @param size Define the size of the data.
  7720. */
  7721. updateUniform(uniformName: string, data: FloatArray, size: number): void;
  7722. private _valueCache;
  7723. private _cacheMatrix;
  7724. private _updateMatrix3x3ForUniform;
  7725. private _updateMatrix3x3ForEffect;
  7726. private _updateMatrix2x2ForEffect;
  7727. private _updateMatrix2x2ForUniform;
  7728. private _updateFloatForEffect;
  7729. private _updateFloatForUniform;
  7730. private _updateFloat2ForEffect;
  7731. private _updateFloat2ForUniform;
  7732. private _updateFloat3ForEffect;
  7733. private _updateFloat3ForUniform;
  7734. private _updateFloat4ForEffect;
  7735. private _updateFloat4ForUniform;
  7736. private _updateMatrixForEffect;
  7737. private _updateMatrixForUniform;
  7738. private _updateVector3ForEffect;
  7739. private _updateVector3ForUniform;
  7740. private _updateVector4ForEffect;
  7741. private _updateVector4ForUniform;
  7742. private _updateColor3ForEffect;
  7743. private _updateColor3ForUniform;
  7744. private _updateColor4ForEffect;
  7745. private _updateColor4ForUniform;
  7746. /**
  7747. * Sets a sampler uniform on the effect.
  7748. * @param name Define the name of the sampler.
  7749. * @param texture Define the texture to set in the sampler
  7750. */
  7751. setTexture(name: string, texture: Nullable<BaseTexture>): void;
  7752. /**
  7753. * Directly updates the value of the uniform in the cache AND on the GPU.
  7754. * @param uniformName Define the name of the uniform, as used in the uniform block in the shader.
  7755. * @param data Define the flattened data
  7756. */
  7757. updateUniformDirectly(uniformName: string, data: FloatArray): void;
  7758. /**
  7759. * Binds this uniform buffer to an effect.
  7760. * @param effect Define the effect to bind the buffer to
  7761. * @param name Name of the uniform block in the shader.
  7762. */
  7763. bindToEffect(effect: Effect, name: string): void;
  7764. /**
  7765. * Disposes the uniform buffer.
  7766. */
  7767. dispose(): void;
  7768. }
  7769. }
  7770. declare module "babylonjs/Misc/iInspectable" {
  7771. /**
  7772. * Enum that determines the text-wrapping mode to use.
  7773. */
  7774. export enum InspectableType {
  7775. /**
  7776. * Checkbox for booleans
  7777. */
  7778. Checkbox = 0,
  7779. /**
  7780. * Sliders for numbers
  7781. */
  7782. Slider = 1,
  7783. /**
  7784. * Vector3
  7785. */
  7786. Vector3 = 2,
  7787. /**
  7788. * Quaternions
  7789. */
  7790. Quaternion = 3,
  7791. /**
  7792. * Color3
  7793. */
  7794. Color3 = 4,
  7795. /**
  7796. * String
  7797. */
  7798. String = 5
  7799. }
  7800. /**
  7801. * Interface used to define custom inspectable properties.
  7802. * This interface is used by the inspector to display custom property grids
  7803. * @see https://doc.babylonjs.com/how_to/debug_layer#extensibility
  7804. */
  7805. export interface IInspectable {
  7806. /**
  7807. * Gets the label to display
  7808. */
  7809. label: string;
  7810. /**
  7811. * Gets the name of the property to edit
  7812. */
  7813. propertyName: string;
  7814. /**
  7815. * Gets the type of the editor to use
  7816. */
  7817. type: InspectableType;
  7818. /**
  7819. * Gets the minimum value of the property when using in "slider" mode
  7820. */
  7821. min?: number;
  7822. /**
  7823. * Gets the maximum value of the property when using in "slider" mode
  7824. */
  7825. max?: number;
  7826. /**
  7827. * Gets the setp to use when using in "slider" mode
  7828. */
  7829. step?: number;
  7830. }
  7831. }
  7832. declare module "babylonjs/Misc/timingTools" {
  7833. /**
  7834. * Class used to provide helper for timing
  7835. */
  7836. export class TimingTools {
  7837. /**
  7838. * Polyfill for setImmediate
  7839. * @param action defines the action to execute after the current execution block
  7840. */
  7841. static SetImmediate(action: () => void): void;
  7842. }
  7843. }
  7844. declare module "babylonjs/Misc/instantiationTools" {
  7845. /**
  7846. * Class used to enable instatition of objects by class name
  7847. */
  7848. export class InstantiationTools {
  7849. /**
  7850. * Use this object to register external classes like custom textures or material
  7851. * to allow the laoders to instantiate them
  7852. */
  7853. static RegisteredExternalClasses: {
  7854. [key: string]: Object;
  7855. };
  7856. /**
  7857. * Tries to instantiate a new object from a given class name
  7858. * @param className defines the class name to instantiate
  7859. * @returns the new object or null if the system was not able to do the instantiation
  7860. */
  7861. static Instantiate(className: string): any;
  7862. }
  7863. }
  7864. declare module "babylonjs/Engines/depthTextureCreationOptions" {
  7865. /**
  7866. * Define options used to create a depth texture
  7867. */
  7868. export class DepthTextureCreationOptions {
  7869. /** Specifies whether or not a stencil should be allocated in the texture */
  7870. generateStencil?: boolean;
  7871. /** Specifies whether or not bilinear filtering is enable on the texture */
  7872. bilinearFiltering?: boolean;
  7873. /** Specifies the comparison function to set on the texture. If 0 or undefined, the texture is not in comparison mode */
  7874. comparisonFunction?: number;
  7875. /** Specifies if the created texture is a cube texture */
  7876. isCube?: boolean;
  7877. }
  7878. }
  7879. declare module "babylonjs/Engines/Extensions/engine.cubeTexture" {
  7880. import { InternalTexture } from "babylonjs/Materials/Textures/internalTexture";
  7881. import { Nullable } from "babylonjs/types";
  7882. import { Scene } from "babylonjs/scene";
  7883. import { DepthTextureCreationOptions } from "babylonjs/Engines/depthTextureCreationOptions";
  7884. module "babylonjs/Engines/thinEngine" {
  7885. interface ThinEngine {
  7886. /**
  7887. * Creates a depth stencil cube texture.
  7888. * This is only available in WebGL 2.
  7889. * @param size The size of face edge in the cube texture.
  7890. * @param options The options defining the cube texture.
  7891. * @returns The cube texture
  7892. */
  7893. _createDepthStencilCubeTexture(size: number, options: DepthTextureCreationOptions): InternalTexture;
  7894. /**
  7895. * Creates a cube texture
  7896. * @param rootUrl defines the url where the files to load is located
  7897. * @param scene defines the current scene
  7898. * @param files defines the list of files to load (1 per face)
  7899. * @param noMipmap defines a boolean indicating that no mipmaps shall be generated (false by default)
  7900. * @param onLoad defines an optional callback raised when the texture is loaded
  7901. * @param onError defines an optional callback raised if there is an issue to load the texture
  7902. * @param format defines the format of the data
  7903. * @param forcedExtension defines the extension to use to pick the right loader
  7904. * @param createPolynomials if a polynomial sphere should be created for the cube texture
  7905. * @param lodScale defines the scale applied to environment texture. This manages the range of LOD level used for IBL according to the roughness
  7906. * @param lodOffset defines the offset applied to environment texture. This manages first LOD level used for IBL according to the roughness
  7907. * @param fallback defines texture to use while falling back when (compressed) texture file not found.
  7908. * @returns the cube texture as an InternalTexture
  7909. */
  7910. 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;
  7911. /**
  7912. * Creates a cube texture
  7913. * @param rootUrl defines the url where the files to load is located
  7914. * @param scene defines the current scene
  7915. * @param files defines the list of files to load (1 per face)
  7916. * @param noMipmap defines a boolean indicating that no mipmaps shall be generated (false by default)
  7917. * @param onLoad defines an optional callback raised when the texture is loaded
  7918. * @param onError defines an optional callback raised if there is an issue to load the texture
  7919. * @param format defines the format of the data
  7920. * @param forcedExtension defines the extension to use to pick the right loader
  7921. * @returns the cube texture as an InternalTexture
  7922. */
  7923. 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;
  7924. /**
  7925. * Creates a cube texture
  7926. * @param rootUrl defines the url where the files to load is located
  7927. * @param scene defines the current scene
  7928. * @param files defines the list of files to load (1 per face)
  7929. * @param noMipmap defines a boolean indicating that no mipmaps shall be generated (false by default)
  7930. * @param onLoad defines an optional callback raised when the texture is loaded
  7931. * @param onError defines an optional callback raised if there is an issue to load the texture
  7932. * @param format defines the format of the data
  7933. * @param forcedExtension defines the extension to use to pick the right loader
  7934. * @param createPolynomials if a polynomial sphere should be created for the cube texture
  7935. * @param lodScale defines the scale applied to environment texture. This manages the range of LOD level used for IBL according to the roughness
  7936. * @param lodOffset defines the offset applied to environment texture. This manages first LOD level used for IBL according to the roughness
  7937. * @returns the cube texture as an InternalTexture
  7938. */
  7939. 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;
  7940. /** @hidden */
  7941. _partialLoadFile(url: string, index: number, loadedFiles: ArrayBuffer[], onfinish: (files: ArrayBuffer[]) => void, onErrorCallBack: Nullable<(message?: string, exception?: any) => void>): void;
  7942. /** @hidden */
  7943. _cascadeLoadFiles(scene: Nullable<Scene>, onfinish: (images: ArrayBuffer[]) => void, files: string[], onError: Nullable<(message?: string, exception?: any) => void>): void;
  7944. /** @hidden */
  7945. _cascadeLoadImgs(scene: Nullable<Scene>, onfinish: (images: HTMLImageElement[]) => void, files: string[], onError: Nullable<(message?: string, exception?: any) => void>, mimeType?: string): void;
  7946. /** @hidden */
  7947. _partialLoadImg(url: string, index: number, loadedImages: HTMLImageElement[], scene: Nullable<Scene>, onfinish: (images: HTMLImageElement[]) => void, onErrorCallBack: Nullable<(message?: string, exception?: any) => void>, mimeType?: string): void;
  7948. /**
  7949. * @hidden
  7950. */
  7951. _setCubeMapTextureParams(loadMipmap: boolean): void;
  7952. }
  7953. }
  7954. }
  7955. declare module "babylonjs/Materials/Textures/cubeTexture" {
  7956. import { Nullable } from "babylonjs/types";
  7957. import { Scene } from "babylonjs/scene";
  7958. import { Matrix, Vector3 } from "babylonjs/Maths/math.vector";
  7959. import { BaseTexture } from "babylonjs/Materials/Textures/baseTexture";
  7960. import { ThinEngine } from "babylonjs/Engines/thinEngine";
  7961. import "babylonjs/Engines/Extensions/engine.cubeTexture";
  7962. import { Observable } from "babylonjs/Misc/observable";
  7963. /**
  7964. * Class for creating a cube texture
  7965. */
  7966. export class CubeTexture extends BaseTexture {
  7967. private _delayedOnLoad;
  7968. /**
  7969. * Observable triggered once the texture has been loaded.
  7970. */
  7971. onLoadObservable: Observable<CubeTexture>;
  7972. /**
  7973. * The url of the texture
  7974. */
  7975. url: string;
  7976. /**
  7977. * Gets or sets the center of the bounding box associated with the cube texture.
  7978. * It must define where the camera used to render the texture was set
  7979. * @see https://doc.babylonjs.com/how_to/reflect#using-local-cubemap-mode
  7980. */
  7981. boundingBoxPosition: Vector3;
  7982. private _boundingBoxSize;
  7983. /**
  7984. * Gets or sets the size of the bounding box associated with the cube texture
  7985. * When defined, the cubemap will switch to local mode
  7986. * @see https://community.arm.com/graphics/b/blog/posts/reflections-based-on-local-cubemaps-in-unity
  7987. * @example https://www.babylonjs-playground.com/#RNASML
  7988. */
  7989. set boundingBoxSize(value: Vector3);
  7990. /**
  7991. * Returns the bounding box size
  7992. * @see https://doc.babylonjs.com/how_to/reflect#using-local-cubemap-mode
  7993. */
  7994. get boundingBoxSize(): Vector3;
  7995. protected _rotationY: number;
  7996. /**
  7997. * Sets texture matrix rotation angle around Y axis in radians.
  7998. */
  7999. set rotationY(value: number);
  8000. /**
  8001. * Gets texture matrix rotation angle around Y axis radians.
  8002. */
  8003. get rotationY(): number;
  8004. /**
  8005. * Are mip maps generated for this texture or not.
  8006. */
  8007. get noMipmap(): boolean;
  8008. private _noMipmap;
  8009. private _files;
  8010. protected _forcedExtension: Nullable<string>;
  8011. private _extensions;
  8012. private _textureMatrix;
  8013. private _format;
  8014. private _createPolynomials;
  8015. /**
  8016. * Creates a cube texture from an array of image urls
  8017. * @param files defines an array of image urls
  8018. * @param scene defines the hosting scene
  8019. * @param noMipmap specifies if mip maps are not used
  8020. * @returns a cube texture
  8021. */
  8022. static CreateFromImages(files: string[], scene: Scene, noMipmap?: boolean): CubeTexture;
  8023. /**
  8024. * Creates and return a texture created from prefilterd data by tools like IBL Baker or Lys.
  8025. * @param url defines the url of the prefiltered texture
  8026. * @param scene defines the scene the texture is attached to
  8027. * @param forcedExtension defines the extension of the file if different from the url
  8028. * @param createPolynomials defines whether or not to create polynomial harmonics from the texture data if necessary
  8029. * @return the prefiltered texture
  8030. */
  8031. static CreateFromPrefilteredData(url: string, scene: Scene, forcedExtension?: any, createPolynomials?: boolean): CubeTexture;
  8032. /**
  8033. * Creates a cube texture to use with reflection for instance. It can be based upon dds or six images as well
  8034. * as prefiltered data.
  8035. * @param rootUrl defines the url of the texture or the root name of the six images
  8036. * @param null defines the scene or engine the texture is attached to
  8037. * @param extensions defines the suffixes add to the picture name in case six images are in use like _px.jpg...
  8038. * @param noMipmap defines if mipmaps should be created or not
  8039. * @param files defines the six files to load for the different faces in that order: px, py, pz, nx, ny, nz
  8040. * @param onLoad defines a callback triggered at the end of the file load if no errors occured
  8041. * @param onError defines a callback triggered in case of error during load
  8042. * @param format defines the internal format to use for the texture once loaded
  8043. * @param prefiltered defines whether or not the texture is created from prefiltered data
  8044. * @param forcedExtension defines the extensions to use (force a special type of file to load) in case it is different from the file name
  8045. * @param createPolynomials defines whether or not to create polynomial harmonics from the texture data if necessary
  8046. * @param lodScale defines the scale applied to environment texture. This manages the range of LOD level used for IBL according to the roughness
  8047. * @param lodOffset defines the offset applied to environment texture. This manages first LOD level used for IBL according to the roughness
  8048. * @return the cube texture
  8049. */
  8050. 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);
  8051. /**
  8052. * Get the current class name of the texture useful for serialization or dynamic coding.
  8053. * @returns "CubeTexture"
  8054. */
  8055. getClassName(): string;
  8056. /**
  8057. * Update the url (and optional buffer) of this texture if url was null during construction.
  8058. * @param url the url of the texture
  8059. * @param forcedExtension defines the extension to use
  8060. * @param onLoad callback called when the texture is loaded (defaults to null)
  8061. * @param prefiltered Defines whether the updated texture is prefiltered or not
  8062. */
  8063. updateURL(url: string, forcedExtension?: string, onLoad?: () => void, prefiltered?: boolean): void;
  8064. /**
  8065. * Delays loading of the cube texture
  8066. * @param forcedExtension defines the extension to use
  8067. */
  8068. delayLoad(forcedExtension?: string): void;
  8069. /**
  8070. * Returns the reflection texture matrix
  8071. * @returns the reflection texture matrix
  8072. */
  8073. getReflectionTextureMatrix(): Matrix;
  8074. /**
  8075. * Sets the reflection texture matrix
  8076. * @param value Reflection texture matrix
  8077. */
  8078. setReflectionTextureMatrix(value: Matrix): void;
  8079. /**
  8080. * Parses text to create a cube texture
  8081. * @param parsedTexture define the serialized text to read from
  8082. * @param scene defines the hosting scene
  8083. * @param rootUrl defines the root url of the cube texture
  8084. * @returns a cube texture
  8085. */
  8086. static Parse(parsedTexture: any, scene: Scene, rootUrl: string): CubeTexture;
  8087. /**
  8088. * Makes a clone, or deep copy, of the cube texture
  8089. * @returns a new cube texture
  8090. */
  8091. clone(): CubeTexture;
  8092. }
  8093. }
  8094. declare module "babylonjs/Materials/materialDefines" {
  8095. /**
  8096. * Manages the defines for the Material
  8097. */
  8098. export class MaterialDefines {
  8099. /** @hidden */
  8100. protected _keys: string[];
  8101. private _isDirty;
  8102. /** @hidden */
  8103. _renderId: number;
  8104. /** @hidden */
  8105. _areLightsDirty: boolean;
  8106. /** @hidden */
  8107. _areLightsDisposed: boolean;
  8108. /** @hidden */
  8109. _areAttributesDirty: boolean;
  8110. /** @hidden */
  8111. _areTexturesDirty: boolean;
  8112. /** @hidden */
  8113. _areFresnelDirty: boolean;
  8114. /** @hidden */
  8115. _areMiscDirty: boolean;
  8116. /** @hidden */
  8117. _arePrePassDirty: boolean;
  8118. /** @hidden */
  8119. _areImageProcessingDirty: boolean;
  8120. /** @hidden */
  8121. _normals: boolean;
  8122. /** @hidden */
  8123. _uvs: boolean;
  8124. /** @hidden */
  8125. _needNormals: boolean;
  8126. /** @hidden */
  8127. _needUVs: boolean;
  8128. [id: string]: any;
  8129. /**
  8130. * Specifies if the material needs to be re-calculated
  8131. */
  8132. get isDirty(): boolean;
  8133. /**
  8134. * Marks the material to indicate that it has been re-calculated
  8135. */
  8136. markAsProcessed(): void;
  8137. /**
  8138. * Marks the material to indicate that it needs to be re-calculated
  8139. */
  8140. markAsUnprocessed(): void;
  8141. /**
  8142. * Marks the material to indicate all of its defines need to be re-calculated
  8143. */
  8144. markAllAsDirty(): void;
  8145. /**
  8146. * Marks the material to indicate that image processing needs to be re-calculated
  8147. */
  8148. markAsImageProcessingDirty(): void;
  8149. /**
  8150. * Marks the material to indicate the lights need to be re-calculated
  8151. * @param disposed Defines whether the light is dirty due to dispose or not
  8152. */
  8153. markAsLightDirty(disposed?: boolean): void;
  8154. /**
  8155. * Marks the attribute state as changed
  8156. */
  8157. markAsAttributesDirty(): void;
  8158. /**
  8159. * Marks the texture state as changed
  8160. */
  8161. markAsTexturesDirty(): void;
  8162. /**
  8163. * Marks the fresnel state as changed
  8164. */
  8165. markAsFresnelDirty(): void;
  8166. /**
  8167. * Marks the misc state as changed
  8168. */
  8169. markAsMiscDirty(): void;
  8170. /**
  8171. * Marks the prepass state as changed
  8172. */
  8173. markAsPrePassDirty(): void;
  8174. /**
  8175. * Rebuilds the material defines
  8176. */
  8177. rebuild(): void;
  8178. /**
  8179. * Specifies if two material defines are equal
  8180. * @param other - A material define instance to compare to
  8181. * @returns - Boolean indicating if the material defines are equal (true) or not (false)
  8182. */
  8183. isEqual(other: MaterialDefines): boolean;
  8184. /**
  8185. * Clones this instance's defines to another instance
  8186. * @param other - material defines to clone values to
  8187. */
  8188. cloneTo(other: MaterialDefines): void;
  8189. /**
  8190. * Resets the material define values
  8191. */
  8192. reset(): void;
  8193. /**
  8194. * Converts the material define values to a string
  8195. * @returns - String of material define information
  8196. */
  8197. toString(): string;
  8198. }
  8199. }
  8200. declare module "babylonjs/Materials/colorCurves" {
  8201. import { Effect } from "babylonjs/Materials/effect";
  8202. /**
  8203. * The color grading curves provide additional color adjustmnent that is applied after any color grading transform (3D LUT).
  8204. * They allow basic adjustment of saturation and small exposure adjustments, along with color filter tinting to provide white balance adjustment or more stylistic effects.
  8205. * 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;
  8206. * corresponding to low luminance, medium luminance, and high luminance areas respectively.
  8207. */
  8208. export class ColorCurves {
  8209. private _dirty;
  8210. private _tempColor;
  8211. private _globalCurve;
  8212. private _highlightsCurve;
  8213. private _midtonesCurve;
  8214. private _shadowsCurve;
  8215. private _positiveCurve;
  8216. private _negativeCurve;
  8217. private _globalHue;
  8218. private _globalDensity;
  8219. private _globalSaturation;
  8220. private _globalExposure;
  8221. /**
  8222. * Gets the global Hue value.
  8223. * 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).
  8224. */
  8225. get globalHue(): number;
  8226. /**
  8227. * Sets the global Hue value.
  8228. * 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).
  8229. */
  8230. set globalHue(value: number);
  8231. /**
  8232. * Gets the global Density value.
  8233. * 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.
  8234. * Values less than zero provide a filter of opposite hue.
  8235. */
  8236. get globalDensity(): number;
  8237. /**
  8238. * Sets the global 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. set globalDensity(value: number);
  8243. /**
  8244. * Gets the global Saturation value.
  8245. * 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.
  8246. */
  8247. get globalSaturation(): number;
  8248. /**
  8249. * Sets the global Saturation value.
  8250. * 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.
  8251. */
  8252. set globalSaturation(value: number);
  8253. /**
  8254. * Gets the global Exposure value.
  8255. * 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.
  8256. */
  8257. get globalExposure(): number;
  8258. /**
  8259. * Sets the global Exposure value.
  8260. * 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.
  8261. */
  8262. set globalExposure(value: number);
  8263. private _highlightsHue;
  8264. private _highlightsDensity;
  8265. private _highlightsSaturation;
  8266. private _highlightsExposure;
  8267. /**
  8268. * Gets the highlights Hue value.
  8269. * 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).
  8270. */
  8271. get highlightsHue(): number;
  8272. /**
  8273. * Sets the highlights Hue value.
  8274. * 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).
  8275. */
  8276. set highlightsHue(value: number);
  8277. /**
  8278. * Gets the highlights Density value.
  8279. * 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.
  8280. * Values less than zero provide a filter of opposite hue.
  8281. */
  8282. get highlightsDensity(): number;
  8283. /**
  8284. * Sets the highlights 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. set highlightsDensity(value: number);
  8289. /**
  8290. * Gets the highlights Saturation value.
  8291. * 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.
  8292. */
  8293. get highlightsSaturation(): number;
  8294. /**
  8295. * Sets the highlights Saturation value.
  8296. * 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.
  8297. */
  8298. set highlightsSaturation(value: number);
  8299. /**
  8300. * Gets the highlights Exposure value.
  8301. * 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.
  8302. */
  8303. get highlightsExposure(): number;
  8304. /**
  8305. * Sets the highlights Exposure value.
  8306. * 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.
  8307. */
  8308. set highlightsExposure(value: number);
  8309. private _midtonesHue;
  8310. private _midtonesDensity;
  8311. private _midtonesSaturation;
  8312. private _midtonesExposure;
  8313. /**
  8314. * Gets the midtones Hue value.
  8315. * 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).
  8316. */
  8317. get midtonesHue(): number;
  8318. /**
  8319. * Sets the midtones Hue value.
  8320. * 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).
  8321. */
  8322. set midtonesHue(value: number);
  8323. /**
  8324. * Gets the midtones Density value.
  8325. * 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.
  8326. * Values less than zero provide a filter of opposite hue.
  8327. */
  8328. get midtonesDensity(): number;
  8329. /**
  8330. * Sets the midtones Density value.
  8331. * 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.
  8332. * Values less than zero provide a filter of opposite hue.
  8333. */
  8334. set midtonesDensity(value: number);
  8335. /**
  8336. * Gets the midtones Saturation value.
  8337. * 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.
  8338. */
  8339. get midtonesSaturation(): number;
  8340. /**
  8341. * Sets the midtones Saturation value.
  8342. * 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.
  8343. */
  8344. set midtonesSaturation(value: number);
  8345. /**
  8346. * Gets the midtones Exposure value.
  8347. * 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.
  8348. */
  8349. get midtonesExposure(): number;
  8350. /**
  8351. * Sets the midtones Exposure value.
  8352. * 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.
  8353. */
  8354. set midtonesExposure(value: number);
  8355. private _shadowsHue;
  8356. private _shadowsDensity;
  8357. private _shadowsSaturation;
  8358. private _shadowsExposure;
  8359. /**
  8360. * Gets the shadows Hue value.
  8361. * 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).
  8362. */
  8363. get shadowsHue(): number;
  8364. /**
  8365. * Sets the shadows Hue value.
  8366. * 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).
  8367. */
  8368. set shadowsHue(value: number);
  8369. /**
  8370. * Gets the shadows Density value.
  8371. * 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.
  8372. * Values less than zero provide a filter of opposite hue.
  8373. */
  8374. get shadowsDensity(): number;
  8375. /**
  8376. * Sets the shadows Density value.
  8377. * 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.
  8378. * Values less than zero provide a filter of opposite hue.
  8379. */
  8380. set shadowsDensity(value: number);
  8381. /**
  8382. * Gets the shadows Saturation value.
  8383. * 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.
  8384. */
  8385. get shadowsSaturation(): number;
  8386. /**
  8387. * Sets the shadows Saturation value.
  8388. * 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.
  8389. */
  8390. set shadowsSaturation(value: number);
  8391. /**
  8392. * Gets the shadows Exposure value.
  8393. * 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.
  8394. */
  8395. get shadowsExposure(): number;
  8396. /**
  8397. * Sets the shadows Exposure value.
  8398. * 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.
  8399. */
  8400. set shadowsExposure(value: number);
  8401. /**
  8402. * Returns the class name
  8403. * @returns The class name
  8404. */
  8405. getClassName(): string;
  8406. /**
  8407. * Binds the color curves to the shader.
  8408. * @param colorCurves The color curve to bind
  8409. * @param effect The effect to bind to
  8410. * @param positiveUniform The positive uniform shader parameter
  8411. * @param neutralUniform The neutral uniform shader parameter
  8412. * @param negativeUniform The negative uniform shader parameter
  8413. */
  8414. static Bind(colorCurves: ColorCurves, effect: Effect, positiveUniform?: string, neutralUniform?: string, negativeUniform?: string): void;
  8415. /**
  8416. * Prepare the list of uniforms associated with the ColorCurves effects.
  8417. * @param uniformsList The list of uniforms used in the effect
  8418. */
  8419. static PrepareUniforms(uniformsList: string[]): void;
  8420. /**
  8421. * Returns color grading data based on a hue, density, saturation and exposure value.
  8422. * @param filterHue The hue of the color filter.
  8423. * @param filterDensity The density of the color filter.
  8424. * @param saturation The saturation.
  8425. * @param exposure The exposure.
  8426. * @param result The result data container.
  8427. */
  8428. private getColorGradingDataToRef;
  8429. /**
  8430. * Takes an input slider value and returns an adjusted value that provides extra control near the centre.
  8431. * @param value The input slider value in range [-100,100].
  8432. * @returns Adjusted value.
  8433. */
  8434. private static applyColorGradingSliderNonlinear;
  8435. /**
  8436. * Returns an RGBA Color4 based on Hue, Saturation and Brightness (also referred to as value, HSV).
  8437. * @param hue The hue (H) input.
  8438. * @param saturation The saturation (S) input.
  8439. * @param brightness The brightness (B) input.
  8440. * @result An RGBA color represented as Vector4.
  8441. */
  8442. private static fromHSBToRef;
  8443. /**
  8444. * Returns a value clamped between min and max
  8445. * @param value The value to clamp
  8446. * @param min The minimum of value
  8447. * @param max The maximum of value
  8448. * @returns The clamped value.
  8449. */
  8450. private static clamp;
  8451. /**
  8452. * Clones the current color curve instance.
  8453. * @return The cloned curves
  8454. */
  8455. clone(): ColorCurves;
  8456. /**
  8457. * Serializes the current color curve instance to a json representation.
  8458. * @return a JSON representation
  8459. */
  8460. serialize(): any;
  8461. /**
  8462. * Parses the color curve from a json representation.
  8463. * @param source the JSON source to parse
  8464. * @return The parsed curves
  8465. */
  8466. static Parse(source: any): ColorCurves;
  8467. }
  8468. }
  8469. declare module "babylonjs/Materials/imageProcessingConfiguration" {
  8470. import { Observable } from "babylonjs/Misc/observable";
  8471. import { Nullable } from "babylonjs/types";
  8472. import { Color4 } from "babylonjs/Maths/math.color";
  8473. import { MaterialDefines } from "babylonjs/Materials/materialDefines";
  8474. import { Effect } from "babylonjs/Materials/effect";
  8475. import { BaseTexture } from "babylonjs/Materials/Textures/baseTexture";
  8476. import { ColorCurves } from "babylonjs/Materials/colorCurves";
  8477. /**
  8478. * Interface to follow in your material defines to integrate easily the
  8479. * Image proccessing functions.
  8480. * @hidden
  8481. */
  8482. export interface IImageProcessingConfigurationDefines {
  8483. IMAGEPROCESSING: boolean;
  8484. VIGNETTE: boolean;
  8485. VIGNETTEBLENDMODEMULTIPLY: boolean;
  8486. VIGNETTEBLENDMODEOPAQUE: boolean;
  8487. TONEMAPPING: boolean;
  8488. TONEMAPPING_ACES: boolean;
  8489. CONTRAST: boolean;
  8490. EXPOSURE: boolean;
  8491. COLORCURVES: boolean;
  8492. COLORGRADING: boolean;
  8493. COLORGRADING3D: boolean;
  8494. SAMPLER3DGREENDEPTH: boolean;
  8495. SAMPLER3DBGRMAP: boolean;
  8496. IMAGEPROCESSINGPOSTPROCESS: boolean;
  8497. }
  8498. /**
  8499. * @hidden
  8500. */
  8501. export class ImageProcessingConfigurationDefines extends MaterialDefines implements IImageProcessingConfigurationDefines {
  8502. IMAGEPROCESSING: boolean;
  8503. VIGNETTE: boolean;
  8504. VIGNETTEBLENDMODEMULTIPLY: boolean;
  8505. VIGNETTEBLENDMODEOPAQUE: boolean;
  8506. TONEMAPPING: boolean;
  8507. TONEMAPPING_ACES: boolean;
  8508. CONTRAST: boolean;
  8509. COLORCURVES: boolean;
  8510. COLORGRADING: boolean;
  8511. COLORGRADING3D: boolean;
  8512. SAMPLER3DGREENDEPTH: boolean;
  8513. SAMPLER3DBGRMAP: boolean;
  8514. IMAGEPROCESSINGPOSTPROCESS: boolean;
  8515. EXPOSURE: boolean;
  8516. constructor();
  8517. }
  8518. /**
  8519. * This groups together the common properties used for image processing either in direct forward pass
  8520. * or through post processing effect depending on the use of the image processing pipeline in your scene
  8521. * or not.
  8522. */
  8523. export class ImageProcessingConfiguration {
  8524. /**
  8525. * Default tone mapping applied in BabylonJS.
  8526. */
  8527. static readonly TONEMAPPING_STANDARD: number;
  8528. /**
  8529. * ACES Tone mapping (used by default in unreal and unity). This can help getting closer
  8530. * to other engines rendering to increase portability.
  8531. */
  8532. static readonly TONEMAPPING_ACES: number;
  8533. /**
  8534. * Color curves setup used in the effect if colorCurvesEnabled is set to true
  8535. */
  8536. colorCurves: Nullable<ColorCurves>;
  8537. private _colorCurvesEnabled;
  8538. /**
  8539. * Gets wether the color curves effect is enabled.
  8540. */
  8541. get colorCurvesEnabled(): boolean;
  8542. /**
  8543. * Sets wether the color curves effect is enabled.
  8544. */
  8545. set colorCurvesEnabled(value: boolean);
  8546. private _colorGradingTexture;
  8547. /**
  8548. * Color grading LUT texture used in the effect if colorGradingEnabled is set to true
  8549. */
  8550. get colorGradingTexture(): Nullable<BaseTexture>;
  8551. /**
  8552. * Color grading LUT texture used in the effect if colorGradingEnabled is set to true
  8553. */
  8554. set colorGradingTexture(value: Nullable<BaseTexture>);
  8555. private _colorGradingEnabled;
  8556. /**
  8557. * Gets wether the color grading effect is enabled.
  8558. */
  8559. get colorGradingEnabled(): boolean;
  8560. /**
  8561. * Sets wether the color grading effect is enabled.
  8562. */
  8563. set colorGradingEnabled(value: boolean);
  8564. private _colorGradingWithGreenDepth;
  8565. /**
  8566. * Gets wether the color grading effect is using a green depth for the 3d Texture.
  8567. */
  8568. get colorGradingWithGreenDepth(): boolean;
  8569. /**
  8570. * Sets wether the color grading effect is using a green depth for the 3d Texture.
  8571. */
  8572. set colorGradingWithGreenDepth(value: boolean);
  8573. private _colorGradingBGR;
  8574. /**
  8575. * Gets wether the color grading texture contains BGR values.
  8576. */
  8577. get colorGradingBGR(): boolean;
  8578. /**
  8579. * Sets wether the color grading texture contains BGR values.
  8580. */
  8581. set colorGradingBGR(value: boolean);
  8582. /** @hidden */
  8583. _exposure: number;
  8584. /**
  8585. * Gets the Exposure used in the effect.
  8586. */
  8587. get exposure(): number;
  8588. /**
  8589. * Sets the Exposure used in the effect.
  8590. */
  8591. set exposure(value: number);
  8592. private _toneMappingEnabled;
  8593. /**
  8594. * Gets wether the tone mapping effect is enabled.
  8595. */
  8596. get toneMappingEnabled(): boolean;
  8597. /**
  8598. * Sets wether the tone mapping effect is enabled.
  8599. */
  8600. set toneMappingEnabled(value: boolean);
  8601. private _toneMappingType;
  8602. /**
  8603. * Gets the type of tone mapping effect.
  8604. */
  8605. get toneMappingType(): number;
  8606. /**
  8607. * Sets the type of tone mapping effect used in BabylonJS.
  8608. */
  8609. set toneMappingType(value: number);
  8610. protected _contrast: number;
  8611. /**
  8612. * Gets the contrast used in the effect.
  8613. */
  8614. get contrast(): number;
  8615. /**
  8616. * Sets the contrast used in the effect.
  8617. */
  8618. set contrast(value: number);
  8619. /**
  8620. * Vignette stretch size.
  8621. */
  8622. vignetteStretch: number;
  8623. /**
  8624. * Vignette centre X Offset.
  8625. */
  8626. vignetteCentreX: number;
  8627. /**
  8628. * Vignette centre Y Offset.
  8629. */
  8630. vignetteCentreY: number;
  8631. /**
  8632. * Vignette weight or intensity of the vignette effect.
  8633. */
  8634. vignetteWeight: number;
  8635. /**
  8636. * Color of the vignette applied on the screen through the chosen blend mode (vignetteBlendMode)
  8637. * if vignetteEnabled is set to true.
  8638. */
  8639. vignetteColor: Color4;
  8640. /**
  8641. * Camera field of view used by the Vignette effect.
  8642. */
  8643. vignetteCameraFov: number;
  8644. private _vignetteBlendMode;
  8645. /**
  8646. * Gets the vignette blend mode allowing different kind of effect.
  8647. */
  8648. get vignetteBlendMode(): number;
  8649. /**
  8650. * Sets the vignette blend mode allowing different kind of effect.
  8651. */
  8652. set vignetteBlendMode(value: number);
  8653. private _vignetteEnabled;
  8654. /**
  8655. * Gets wether the vignette effect is enabled.
  8656. */
  8657. get vignetteEnabled(): boolean;
  8658. /**
  8659. * Sets wether the vignette effect is enabled.
  8660. */
  8661. set vignetteEnabled(value: boolean);
  8662. private _applyByPostProcess;
  8663. /**
  8664. * Gets wether the image processing is applied through a post process or not.
  8665. */
  8666. get applyByPostProcess(): boolean;
  8667. /**
  8668. * Sets wether the image processing is applied through a post process or not.
  8669. */
  8670. set applyByPostProcess(value: boolean);
  8671. private _isEnabled;
  8672. /**
  8673. * Gets wether the image processing is enabled or not.
  8674. */
  8675. get isEnabled(): boolean;
  8676. /**
  8677. * Sets wether the image processing is enabled or not.
  8678. */
  8679. set isEnabled(value: boolean);
  8680. /**
  8681. * An event triggered when the configuration changes and requires Shader to Update some parameters.
  8682. */
  8683. onUpdateParameters: Observable<ImageProcessingConfiguration>;
  8684. /**
  8685. * Method called each time the image processing information changes requires to recompile the effect.
  8686. */
  8687. protected _updateParameters(): void;
  8688. /**
  8689. * Gets the current class name.
  8690. * @return "ImageProcessingConfiguration"
  8691. */
  8692. getClassName(): string;
  8693. /**
  8694. * Prepare the list of uniforms associated with the Image Processing effects.
  8695. * @param uniforms The list of uniforms used in the effect
  8696. * @param defines the list of defines currently in use
  8697. */
  8698. static PrepareUniforms(uniforms: string[], defines: IImageProcessingConfigurationDefines): void;
  8699. /**
  8700. * Prepare the list of samplers associated with the Image Processing effects.
  8701. * @param samplersList The list of uniforms used in the effect
  8702. * @param defines the list of defines currently in use
  8703. */
  8704. static PrepareSamplers(samplersList: string[], defines: IImageProcessingConfigurationDefines): void;
  8705. /**
  8706. * Prepare the list of defines associated to the shader.
  8707. * @param defines the list of defines to complete
  8708. * @param forPostProcess Define if we are currently in post process mode or not
  8709. */
  8710. prepareDefines(defines: IImageProcessingConfigurationDefines, forPostProcess?: boolean): void;
  8711. /**
  8712. * Returns true if all the image processing information are ready.
  8713. * @returns True if ready, otherwise, false
  8714. */
  8715. isReady(): boolean;
  8716. /**
  8717. * Binds the image processing to the shader.
  8718. * @param effect The effect to bind to
  8719. * @param overrideAspectRatio Override the aspect ratio of the effect
  8720. */
  8721. bind(effect: Effect, overrideAspectRatio?: number): void;
  8722. /**
  8723. * Clones the current image processing instance.
  8724. * @return The cloned image processing
  8725. */
  8726. clone(): ImageProcessingConfiguration;
  8727. /**
  8728. * Serializes the current image processing instance to a json representation.
  8729. * @return a JSON representation
  8730. */
  8731. serialize(): any;
  8732. /**
  8733. * Parses the image processing from a json representation.
  8734. * @param source the JSON source to parse
  8735. * @return The parsed image processing
  8736. */
  8737. static Parse(source: any): ImageProcessingConfiguration;
  8738. private static _VIGNETTEMODE_MULTIPLY;
  8739. private static _VIGNETTEMODE_OPAQUE;
  8740. /**
  8741. * Used to apply the vignette as a mix with the pixel color.
  8742. */
  8743. static get VIGNETTEMODE_MULTIPLY(): number;
  8744. /**
  8745. * Used to apply the vignette as a replacement of the pixel color.
  8746. */
  8747. static get VIGNETTEMODE_OPAQUE(): number;
  8748. }
  8749. }
  8750. declare module "babylonjs/Shaders/postprocess.vertex" {
  8751. /** @hidden */
  8752. export var postprocessVertexShader: {
  8753. name: string;
  8754. shader: string;
  8755. };
  8756. }
  8757. declare module "babylonjs/Engines/Extensions/engine.renderTarget" {
  8758. import { InternalTexture } from "babylonjs/Materials/Textures/internalTexture";
  8759. import { RenderTargetCreationOptions } from "babylonjs/Materials/Textures/renderTargetCreationOptions";
  8760. import { DepthTextureCreationOptions } from "babylonjs/Engines/depthTextureCreationOptions";
  8761. /**
  8762. * Type used to define a render target texture size (either with a number or with a rect width and height)
  8763. */
  8764. export type RenderTargetTextureSize = number | {
  8765. width: number;
  8766. height: number;
  8767. layers?: number;
  8768. };
  8769. module "babylonjs/Engines/thinEngine" {
  8770. interface ThinEngine {
  8771. /**
  8772. * Creates a new render target texture
  8773. * @param size defines the size of the texture
  8774. * @param options defines the options used to create the texture
  8775. * @returns a new render target texture stored in an InternalTexture
  8776. */
  8777. createRenderTargetTexture(size: RenderTargetTextureSize, options: boolean | RenderTargetCreationOptions): InternalTexture;
  8778. /**
  8779. * Creates a depth stencil texture.
  8780. * This is only available in WebGL 2 or with the depth texture extension available.
  8781. * @param size The size of face edge in the texture.
  8782. * @param options The options defining the texture.
  8783. * @returns The texture
  8784. */
  8785. createDepthStencilTexture(size: RenderTargetTextureSize, options: DepthTextureCreationOptions): InternalTexture;
  8786. /** @hidden */
  8787. _createDepthStencilTexture(size: RenderTargetTextureSize, options: DepthTextureCreationOptions): InternalTexture;
  8788. }
  8789. }
  8790. }
  8791. declare module "babylonjs/Materials/Node/Enums/nodeMaterialBlockConnectionPointTypes" {
  8792. /**
  8793. * Defines the kind of connection point for node based material
  8794. */
  8795. export enum NodeMaterialBlockConnectionPointTypes {
  8796. /** Float */
  8797. Float = 1,
  8798. /** Int */
  8799. Int = 2,
  8800. /** Vector2 */
  8801. Vector2 = 4,
  8802. /** Vector3 */
  8803. Vector3 = 8,
  8804. /** Vector4 */
  8805. Vector4 = 16,
  8806. /** Color3 */
  8807. Color3 = 32,
  8808. /** Color4 */
  8809. Color4 = 64,
  8810. /** Matrix */
  8811. Matrix = 128,
  8812. /** Custom object */
  8813. Object = 256,
  8814. /** Detect type based on connection */
  8815. AutoDetect = 1024,
  8816. /** Output type that will be defined by input type */
  8817. BasedOnInput = 2048
  8818. }
  8819. }
  8820. declare module "babylonjs/Materials/Node/Enums/nodeMaterialBlockTargets" {
  8821. /**
  8822. * Enum used to define the target of a block
  8823. */
  8824. export enum NodeMaterialBlockTargets {
  8825. /** Vertex shader */
  8826. Vertex = 1,
  8827. /** Fragment shader */
  8828. Fragment = 2,
  8829. /** Neutral */
  8830. Neutral = 4,
  8831. /** Vertex and Fragment */
  8832. VertexAndFragment = 3
  8833. }
  8834. }
  8835. declare module "babylonjs/Materials/Node/Enums/nodeMaterialBlockConnectionPointMode" {
  8836. /**
  8837. * Enum defining the mode of a NodeMaterialBlockConnectionPoint
  8838. */
  8839. export enum NodeMaterialBlockConnectionPointMode {
  8840. /** Value is an uniform */
  8841. Uniform = 0,
  8842. /** Value is a mesh attribute */
  8843. Attribute = 1,
  8844. /** Value is a varying between vertex and fragment shaders */
  8845. Varying = 2,
  8846. /** Mode is undefined */
  8847. Undefined = 3
  8848. }
  8849. }
  8850. declare module "babylonjs/Materials/Node/Enums/nodeMaterialSystemValues" {
  8851. /**
  8852. * Enum used to define system values e.g. values automatically provided by the system
  8853. */
  8854. export enum NodeMaterialSystemValues {
  8855. /** World */
  8856. World = 1,
  8857. /** View */
  8858. View = 2,
  8859. /** Projection */
  8860. Projection = 3,
  8861. /** ViewProjection */
  8862. ViewProjection = 4,
  8863. /** WorldView */
  8864. WorldView = 5,
  8865. /** WorldViewProjection */
  8866. WorldViewProjection = 6,
  8867. /** CameraPosition */
  8868. CameraPosition = 7,
  8869. /** Fog Color */
  8870. FogColor = 8,
  8871. /** Delta time */
  8872. DeltaTime = 9
  8873. }
  8874. }
  8875. declare module "babylonjs/Maths/math.axis" {
  8876. import { Vector3 } from "babylonjs/Maths/math.vector";
  8877. /** Defines supported spaces */
  8878. export enum Space {
  8879. /** Local (object) space */
  8880. LOCAL = 0,
  8881. /** World space */
  8882. WORLD = 1,
  8883. /** Bone space */
  8884. BONE = 2
  8885. }
  8886. /** Defines the 3 main axes */
  8887. export class Axis {
  8888. /** X axis */
  8889. static X: Vector3;
  8890. /** Y axis */
  8891. static Y: Vector3;
  8892. /** Z axis */
  8893. static Z: Vector3;
  8894. }
  8895. }
  8896. declare module "babylonjs/Maths/math.frustum" {
  8897. import { Matrix } from "babylonjs/Maths/math.vector";
  8898. import { DeepImmutable } from "babylonjs/types";
  8899. import { Plane } from "babylonjs/Maths/math.plane";
  8900. /**
  8901. * Represents a camera frustum
  8902. */
  8903. export class Frustum {
  8904. /**
  8905. * Gets the planes representing the frustum
  8906. * @param transform matrix to be applied to the returned planes
  8907. * @returns a new array of 6 Frustum planes computed by the given transformation matrix.
  8908. */
  8909. static GetPlanes(transform: DeepImmutable<Matrix>): Plane[];
  8910. /**
  8911. * Gets the near frustum plane transformed by the transform matrix
  8912. * @param transform transformation matrix to be applied to the resulting frustum plane
  8913. * @param frustumPlane the resuling frustum plane
  8914. */
  8915. static GetNearPlaneToRef(transform: DeepImmutable<Matrix>, frustumPlane: Plane): void;
  8916. /**
  8917. * Gets the far frustum plane transformed by the transform matrix
  8918. * @param transform transformation matrix to be applied to the resulting frustum plane
  8919. * @param frustumPlane the resuling frustum plane
  8920. */
  8921. static GetFarPlaneToRef(transform: DeepImmutable<Matrix>, frustumPlane: Plane): void;
  8922. /**
  8923. * Gets the left frustum plane transformed by the transform matrix
  8924. * @param transform transformation matrix to be applied to the resulting frustum plane
  8925. * @param frustumPlane the resuling frustum plane
  8926. */
  8927. static GetLeftPlaneToRef(transform: DeepImmutable<Matrix>, frustumPlane: Plane): void;
  8928. /**
  8929. * Gets the right frustum plane transformed by the transform matrix
  8930. * @param transform transformation matrix to be applied to the resulting frustum plane
  8931. * @param frustumPlane the resuling frustum plane
  8932. */
  8933. static GetRightPlaneToRef(transform: DeepImmutable<Matrix>, frustumPlane: Plane): void;
  8934. /**
  8935. * Gets the top frustum plane transformed by the transform matrix
  8936. * @param transform transformation matrix to be applied to the resulting frustum plane
  8937. * @param frustumPlane the resuling frustum plane
  8938. */
  8939. static GetTopPlaneToRef(transform: DeepImmutable<Matrix>, frustumPlane: Plane): void;
  8940. /**
  8941. * Gets the bottom frustum plane transformed by the transform matrix
  8942. * @param transform transformation matrix to be applied to the resulting frustum plane
  8943. * @param frustumPlane the resuling frustum plane
  8944. */
  8945. static GetBottomPlaneToRef(transform: DeepImmutable<Matrix>, frustumPlane: Plane): void;
  8946. /**
  8947. * Sets the given array "frustumPlanes" with the 6 Frustum planes computed by the given transformation matrix.
  8948. * @param transform transformation matrix to be applied to the resulting frustum planes
  8949. * @param frustumPlanes the resuling frustum planes
  8950. */
  8951. static GetPlanesToRef(transform: DeepImmutable<Matrix>, frustumPlanes: Plane[]): void;
  8952. }
  8953. }
  8954. declare module "babylonjs/Maths/math.size" {
  8955. /**
  8956. * Interface for the size containing width and height
  8957. */
  8958. export interface ISize {
  8959. /**
  8960. * Width
  8961. */
  8962. width: number;
  8963. /**
  8964. * Heighht
  8965. */
  8966. height: number;
  8967. }
  8968. /**
  8969. * Size containing widht and height
  8970. */
  8971. export class Size implements ISize {
  8972. /**
  8973. * Width
  8974. */
  8975. width: number;
  8976. /**
  8977. * Height
  8978. */
  8979. height: number;
  8980. /**
  8981. * Creates a Size object from the given width and height (floats).
  8982. * @param width width of the new size
  8983. * @param height height of the new size
  8984. */
  8985. constructor(width: number, height: number);
  8986. /**
  8987. * Returns a string with the Size width and height
  8988. * @returns a string with the Size width and height
  8989. */
  8990. toString(): string;
  8991. /**
  8992. * "Size"
  8993. * @returns the string "Size"
  8994. */
  8995. getClassName(): string;
  8996. /**
  8997. * Returns the Size hash code.
  8998. * @returns a hash code for a unique width and height
  8999. */
  9000. getHashCode(): number;
  9001. /**
  9002. * Updates the current size from the given one.
  9003. * @param src the given size
  9004. */
  9005. copyFrom(src: Size): void;
  9006. /**
  9007. * Updates in place the current Size from the given floats.
  9008. * @param width width of the new size
  9009. * @param height height of the new size
  9010. * @returns the updated Size.
  9011. */
  9012. copyFromFloats(width: number, height: number): Size;
  9013. /**
  9014. * Updates in place the current Size from the given floats.
  9015. * @param width width to set
  9016. * @param height height to set
  9017. * @returns the updated Size.
  9018. */
  9019. set(width: number, height: number): Size;
  9020. /**
  9021. * Multiplies the width and height by numbers
  9022. * @param w factor to multiple the width by
  9023. * @param h factor to multiple the height by
  9024. * @returns a new Size set with the multiplication result of the current Size and the given floats.
  9025. */
  9026. multiplyByFloats(w: number, h: number): Size;
  9027. /**
  9028. * Clones the size
  9029. * @returns a new Size copied from the given one.
  9030. */
  9031. clone(): Size;
  9032. /**
  9033. * True if the current Size and the given one width and height are strictly equal.
  9034. * @param other the other size to compare against
  9035. * @returns True if the current Size and the given one width and height are strictly equal.
  9036. */
  9037. equals(other: Size): boolean;
  9038. /**
  9039. * The surface of the Size : width * height (float).
  9040. */
  9041. get surface(): number;
  9042. /**
  9043. * Create a new size of zero
  9044. * @returns a new Size set to (0.0, 0.0)
  9045. */
  9046. static Zero(): Size;
  9047. /**
  9048. * Sums the width and height of two sizes
  9049. * @param otherSize size to add to this size
  9050. * @returns a new Size set as the addition result of the current Size and the given one.
  9051. */
  9052. add(otherSize: Size): Size;
  9053. /**
  9054. * Subtracts the width and height of two
  9055. * @param otherSize size to subtract to this size
  9056. * @returns a new Size set as the subtraction result of the given one from the current Size.
  9057. */
  9058. subtract(otherSize: Size): Size;
  9059. /**
  9060. * Creates a new Size set at the linear interpolation "amount" between "start" and "end"
  9061. * @param start starting size to lerp between
  9062. * @param end end size to lerp between
  9063. * @param amount amount to lerp between the start and end values
  9064. * @returns a new Size set at the linear interpolation "amount" between "start" and "end"
  9065. */
  9066. static Lerp(start: Size, end: Size, amount: number): Size;
  9067. }
  9068. }
  9069. declare module "babylonjs/Maths/math.vertexFormat" {
  9070. import { Vector3, Vector2 } from "babylonjs/Maths/math.vector";
  9071. /**
  9072. * Contains position and normal vectors for a vertex
  9073. */
  9074. export class PositionNormalVertex {
  9075. /** the position of the vertex (defaut: 0,0,0) */
  9076. position: Vector3;
  9077. /** the normal of the vertex (defaut: 0,1,0) */
  9078. normal: Vector3;
  9079. /**
  9080. * Creates a PositionNormalVertex
  9081. * @param position the position of the vertex (defaut: 0,0,0)
  9082. * @param normal the normal of the vertex (defaut: 0,1,0)
  9083. */
  9084. constructor(
  9085. /** the position of the vertex (defaut: 0,0,0) */
  9086. position?: Vector3,
  9087. /** the normal of the vertex (defaut: 0,1,0) */
  9088. normal?: Vector3);
  9089. /**
  9090. * Clones the PositionNormalVertex
  9091. * @returns the cloned PositionNormalVertex
  9092. */
  9093. clone(): PositionNormalVertex;
  9094. }
  9095. /**
  9096. * Contains position, normal and uv vectors for a vertex
  9097. */
  9098. export class PositionNormalTextureVertex {
  9099. /** the position of the vertex (defaut: 0,0,0) */
  9100. position: Vector3;
  9101. /** the normal of the vertex (defaut: 0,1,0) */
  9102. normal: Vector3;
  9103. /** the uv of the vertex (default: 0,0) */
  9104. uv: Vector2;
  9105. /**
  9106. * Creates a PositionNormalTextureVertex
  9107. * @param position the position of the vertex (defaut: 0,0,0)
  9108. * @param normal the normal of the vertex (defaut: 0,1,0)
  9109. * @param uv the uv of the vertex (default: 0,0)
  9110. */
  9111. constructor(
  9112. /** the position of the vertex (defaut: 0,0,0) */
  9113. position?: Vector3,
  9114. /** the normal of the vertex (defaut: 0,1,0) */
  9115. normal?: Vector3,
  9116. /** the uv of the vertex (default: 0,0) */
  9117. uv?: Vector2);
  9118. /**
  9119. * Clones the PositionNormalTextureVertex
  9120. * @returns the cloned PositionNormalTextureVertex
  9121. */
  9122. clone(): PositionNormalTextureVertex;
  9123. }
  9124. }
  9125. declare module "babylonjs/Maths/math" {
  9126. export * from "babylonjs/Maths/math.axis";
  9127. export * from "babylonjs/Maths/math.color";
  9128. export * from "babylonjs/Maths/math.constants";
  9129. export * from "babylonjs/Maths/math.frustum";
  9130. export * from "babylonjs/Maths/math.path";
  9131. export * from "babylonjs/Maths/math.plane";
  9132. export * from "babylonjs/Maths/math.size";
  9133. export * from "babylonjs/Maths/math.vector";
  9134. export * from "babylonjs/Maths/math.vertexFormat";
  9135. export * from "babylonjs/Maths/math.viewport";
  9136. }
  9137. declare module "babylonjs/Materials/Node/Blocks/Input/animatedInputBlockTypes" {
  9138. /**
  9139. * Enum defining the type of animations supported by InputBlock
  9140. */
  9141. export enum AnimatedInputBlockTypes {
  9142. /** No animation */
  9143. None = 0,
  9144. /** Time based animation. Will only work for floats */
  9145. Time = 1
  9146. }
  9147. }
  9148. declare module "babylonjs/Lights/shadowLight" {
  9149. import { Camera } from "babylonjs/Cameras/camera";
  9150. import { Scene } from "babylonjs/scene";
  9151. import { Matrix, Vector3 } from "babylonjs/Maths/math.vector";
  9152. import { AbstractMesh } from "babylonjs/Meshes/abstractMesh";
  9153. import { Light } from "babylonjs/Lights/light";
  9154. /**
  9155. * Interface describing all the common properties and methods a shadow light needs to implement.
  9156. * This helps both the shadow generator and materials to genrate the corresponding shadow maps
  9157. * as well as binding the different shadow properties to the effects.
  9158. */
  9159. export interface IShadowLight extends Light {
  9160. /**
  9161. * The light id in the scene (used in scene.findLighById for instance)
  9162. */
  9163. id: string;
  9164. /**
  9165. * The position the shdow will be casted from.
  9166. */
  9167. position: Vector3;
  9168. /**
  9169. * In 2d mode (needCube being false), the direction used to cast the shadow.
  9170. */
  9171. direction: Vector3;
  9172. /**
  9173. * The transformed position. Position of the light in world space taking parenting in account.
  9174. */
  9175. transformedPosition: Vector3;
  9176. /**
  9177. * The transformed direction. Direction of the light in world space taking parenting in account.
  9178. */
  9179. transformedDirection: Vector3;
  9180. /**
  9181. * The friendly name of the light in the scene.
  9182. */
  9183. name: string;
  9184. /**
  9185. * Defines the shadow projection clipping minimum z value.
  9186. */
  9187. shadowMinZ: number;
  9188. /**
  9189. * Defines the shadow projection clipping maximum z value.
  9190. */
  9191. shadowMaxZ: number;
  9192. /**
  9193. * Computes the transformed information (transformedPosition and transformedDirection in World space) of the current light
  9194. * @returns true if the information has been computed, false if it does not need to (no parenting)
  9195. */
  9196. computeTransformedInformation(): boolean;
  9197. /**
  9198. * Gets the scene the light belongs to.
  9199. * @returns The scene
  9200. */
  9201. getScene(): Scene;
  9202. /**
  9203. * Callback defining a custom Projection Matrix Builder.
  9204. * This can be used to override the default projection matrix computation.
  9205. */
  9206. customProjectionMatrixBuilder: (viewMatrix: Matrix, renderList: Array<AbstractMesh>, result: Matrix) => void;
  9207. /**
  9208. * Sets the shadow projection matrix in parameter to the generated projection matrix.
  9209. * @param matrix The materix to updated with the projection information
  9210. * @param viewMatrix The transform matrix of the light
  9211. * @param renderList The list of mesh to render in the map
  9212. * @returns The current light
  9213. */
  9214. setShadowProjectionMatrix(matrix: Matrix, viewMatrix: Matrix, renderList: Array<AbstractMesh>): IShadowLight;
  9215. /**
  9216. * Gets the current depth scale used in ESM.
  9217. * @returns The scale
  9218. */
  9219. getDepthScale(): number;
  9220. /**
  9221. * Returns whether or not the shadow generation require a cube texture or a 2d texture.
  9222. * @returns true if a cube texture needs to be use
  9223. */
  9224. needCube(): boolean;
  9225. /**
  9226. * Detects if the projection matrix requires to be recomputed this frame.
  9227. * @returns true if it requires to be recomputed otherwise, false.
  9228. */
  9229. needProjectionMatrixCompute(): boolean;
  9230. /**
  9231. * Forces the shadow generator to recompute the projection matrix even if position and direction did not changed.
  9232. */
  9233. forceProjectionMatrixCompute(): void;
  9234. /**
  9235. * Get the direction to use to render the shadow map. In case of cube texture, the face index can be passed.
  9236. * @param faceIndex The index of the face we are computed the direction to generate shadow
  9237. * @returns The set direction in 2d mode otherwise the direction to the cubemap face if needCube() is true
  9238. */
  9239. getShadowDirection(faceIndex?: number): Vector3;
  9240. /**
  9241. * Gets the minZ used for shadow according to both the scene and the light.
  9242. * @param activeCamera The camera we are returning the min for
  9243. * @returns the depth min z
  9244. */
  9245. getDepthMinZ(activeCamera: Camera): number;
  9246. /**
  9247. * Gets the maxZ used for shadow according to both the scene and the light.
  9248. * @param activeCamera The camera we are returning the max for
  9249. * @returns the depth max z
  9250. */
  9251. getDepthMaxZ(activeCamera: Camera): number;
  9252. }
  9253. /**
  9254. * Base implementation IShadowLight
  9255. * It groups all the common behaviour in order to reduce dupplication and better follow the DRY pattern.
  9256. */
  9257. export abstract class ShadowLight extends Light implements IShadowLight {
  9258. protected abstract _setDefaultShadowProjectionMatrix(matrix: Matrix, viewMatrix: Matrix, renderList: Array<AbstractMesh>): void;
  9259. protected _position: Vector3;
  9260. protected _setPosition(value: Vector3): void;
  9261. /**
  9262. * Sets the position the shadow will be casted from. Also use as the light position for both
  9263. * point and spot lights.
  9264. */
  9265. get position(): Vector3;
  9266. /**
  9267. * Sets the position the shadow will be casted from. Also use as the light position for both
  9268. * point and spot lights.
  9269. */
  9270. set position(value: Vector3);
  9271. protected _direction: Vector3;
  9272. protected _setDirection(value: Vector3): void;
  9273. /**
  9274. * In 2d mode (needCube being false), gets the direction used to cast the shadow.
  9275. * Also use as the light direction on spot and directional lights.
  9276. */
  9277. get direction(): Vector3;
  9278. /**
  9279. * In 2d mode (needCube being false), sets the direction used to cast the shadow.
  9280. * Also use as the light direction on spot and directional lights.
  9281. */
  9282. set direction(value: Vector3);
  9283. protected _shadowMinZ: number;
  9284. /**
  9285. * Gets the shadow projection clipping minimum z value.
  9286. */
  9287. get shadowMinZ(): number;
  9288. /**
  9289. * Sets the shadow projection clipping minimum z value.
  9290. */
  9291. set shadowMinZ(value: number);
  9292. protected _shadowMaxZ: number;
  9293. /**
  9294. * Sets the shadow projection clipping maximum z value.
  9295. */
  9296. get shadowMaxZ(): number;
  9297. /**
  9298. * Gets the shadow projection clipping maximum z value.
  9299. */
  9300. set shadowMaxZ(value: number);
  9301. /**
  9302. * Callback defining a custom Projection Matrix Builder.
  9303. * This can be used to override the default projection matrix computation.
  9304. */
  9305. customProjectionMatrixBuilder: (viewMatrix: Matrix, renderList: Array<AbstractMesh>, result: Matrix) => void;
  9306. /**
  9307. * The transformed position. Position of the light in world space taking parenting in account.
  9308. */
  9309. transformedPosition: Vector3;
  9310. /**
  9311. * The transformed direction. Direction of the light in world space taking parenting in account.
  9312. */
  9313. transformedDirection: Vector3;
  9314. private _needProjectionMatrixCompute;
  9315. /**
  9316. * Computes the transformed information (transformedPosition and transformedDirection in World space) of the current light
  9317. * @returns true if the information has been computed, false if it does not need to (no parenting)
  9318. */
  9319. computeTransformedInformation(): boolean;
  9320. /**
  9321. * Return the depth scale used for the shadow map.
  9322. * @returns the depth scale.
  9323. */
  9324. getDepthScale(): number;
  9325. /**
  9326. * Get the direction to use to render the shadow map. In case of cube texture, the face index can be passed.
  9327. * @param faceIndex The index of the face we are computed the direction to generate shadow
  9328. * @returns The set direction in 2d mode otherwise the direction to the cubemap face if needCube() is true
  9329. */
  9330. getShadowDirection(faceIndex?: number): Vector3;
  9331. /**
  9332. * Returns the ShadowLight absolute position in the World.
  9333. * @returns the position vector in world space
  9334. */
  9335. getAbsolutePosition(): Vector3;
  9336. /**
  9337. * Sets the ShadowLight direction toward the passed target.
  9338. * @param target The point to target in local space
  9339. * @returns the updated ShadowLight direction
  9340. */
  9341. setDirectionToTarget(target: Vector3): Vector3;
  9342. /**
  9343. * Returns the light rotation in euler definition.
  9344. * @returns the x y z rotation in local space.
  9345. */
  9346. getRotation(): Vector3;
  9347. /**
  9348. * Returns whether or not the shadow generation require a cube texture or a 2d texture.
  9349. * @returns true if a cube texture needs to be use
  9350. */
  9351. needCube(): boolean;
  9352. /**
  9353. * Detects if the projection matrix requires to be recomputed this frame.
  9354. * @returns true if it requires to be recomputed otherwise, false.
  9355. */
  9356. needProjectionMatrixCompute(): boolean;
  9357. /**
  9358. * Forces the shadow generator to recompute the projection matrix even if position and direction did not changed.
  9359. */
  9360. forceProjectionMatrixCompute(): void;
  9361. /** @hidden */
  9362. _initCache(): void;
  9363. /** @hidden */
  9364. _isSynchronized(): boolean;
  9365. /**
  9366. * Computes the world matrix of the node
  9367. * @param force defines if the cache version should be invalidated forcing the world matrix to be created from scratch
  9368. * @returns the world matrix
  9369. */
  9370. computeWorldMatrix(force?: boolean): Matrix;
  9371. /**
  9372. * Gets the minZ used for shadow according to both the scene and the light.
  9373. * @param activeCamera The camera we are returning the min for
  9374. * @returns the depth min z
  9375. */
  9376. getDepthMinZ(activeCamera: Camera): number;
  9377. /**
  9378. * Gets the maxZ used for shadow according to both the scene and the light.
  9379. * @param activeCamera The camera we are returning the max for
  9380. * @returns the depth max z
  9381. */
  9382. getDepthMaxZ(activeCamera: Camera): number;
  9383. /**
  9384. * Sets the shadow projection matrix in parameter to the generated projection matrix.
  9385. * @param matrix The materix to updated with the projection information
  9386. * @param viewMatrix The transform matrix of the light
  9387. * @param renderList The list of mesh to render in the map
  9388. * @returns The current light
  9389. */
  9390. setShadowProjectionMatrix(matrix: Matrix, viewMatrix: Matrix, renderList: Array<AbstractMesh>): IShadowLight;
  9391. }
  9392. }
  9393. declare module "babylonjs/Shaders/ShadersInclude/packingFunctions" {
  9394. /** @hidden */
  9395. export var packingFunctions: {
  9396. name: string;
  9397. shader: string;
  9398. };
  9399. }
  9400. declare module "babylonjs/Shaders/ShadersInclude/bayerDitherFunctions" {
  9401. /** @hidden */
  9402. export var bayerDitherFunctions: {
  9403. name: string;
  9404. shader: string;
  9405. };
  9406. }
  9407. declare module "babylonjs/Shaders/ShadersInclude/shadowMapFragmentDeclaration" {
  9408. import "babylonjs/Shaders/ShadersInclude/packingFunctions";
  9409. import "babylonjs/Shaders/ShadersInclude/bayerDitherFunctions";
  9410. /** @hidden */
  9411. export var shadowMapFragmentDeclaration: {
  9412. name: string;
  9413. shader: string;
  9414. };
  9415. }
  9416. declare module "babylonjs/Shaders/ShadersInclude/clipPlaneFragmentDeclaration" {
  9417. /** @hidden */
  9418. export var clipPlaneFragmentDeclaration: {
  9419. name: string;
  9420. shader: string;
  9421. };
  9422. }
  9423. declare module "babylonjs/Shaders/ShadersInclude/clipPlaneFragment" {
  9424. /** @hidden */
  9425. export var clipPlaneFragment: {
  9426. name: string;
  9427. shader: string;
  9428. };
  9429. }
  9430. declare module "babylonjs/Shaders/ShadersInclude/shadowMapFragment" {
  9431. /** @hidden */
  9432. export var shadowMapFragment: {
  9433. name: string;
  9434. shader: string;
  9435. };
  9436. }
  9437. declare module "babylonjs/Shaders/shadowMap.fragment" {
  9438. import "babylonjs/Shaders/ShadersInclude/shadowMapFragmentDeclaration";
  9439. import "babylonjs/Shaders/ShadersInclude/clipPlaneFragmentDeclaration";
  9440. import "babylonjs/Shaders/ShadersInclude/clipPlaneFragment";
  9441. import "babylonjs/Shaders/ShadersInclude/shadowMapFragment";
  9442. /** @hidden */
  9443. export var shadowMapPixelShader: {
  9444. name: string;
  9445. shader: string;
  9446. };
  9447. }
  9448. declare module "babylonjs/Shaders/ShadersInclude/bonesDeclaration" {
  9449. /** @hidden */
  9450. export var bonesDeclaration: {
  9451. name: string;
  9452. shader: string;
  9453. };
  9454. }
  9455. declare module "babylonjs/Shaders/ShadersInclude/morphTargetsVertexGlobalDeclaration" {
  9456. /** @hidden */
  9457. export var morphTargetsVertexGlobalDeclaration: {
  9458. name: string;
  9459. shader: string;
  9460. };
  9461. }
  9462. declare module "babylonjs/Shaders/ShadersInclude/morphTargetsVertexDeclaration" {
  9463. /** @hidden */
  9464. export var morphTargetsVertexDeclaration: {
  9465. name: string;
  9466. shader: string;
  9467. };
  9468. }
  9469. declare module "babylonjs/Shaders/ShadersInclude/instancesDeclaration" {
  9470. /** @hidden */
  9471. export var instancesDeclaration: {
  9472. name: string;
  9473. shader: string;
  9474. };
  9475. }
  9476. declare module "babylonjs/Shaders/ShadersInclude/helperFunctions" {
  9477. /** @hidden */
  9478. export var helperFunctions: {
  9479. name: string;
  9480. shader: string;
  9481. };
  9482. }
  9483. declare module "babylonjs/Shaders/ShadersInclude/shadowMapVertexDeclaration" {
  9484. /** @hidden */
  9485. export var shadowMapVertexDeclaration: {
  9486. name: string;
  9487. shader: string;
  9488. };
  9489. }
  9490. declare module "babylonjs/Shaders/ShadersInclude/clipPlaneVertexDeclaration" {
  9491. /** @hidden */
  9492. export var clipPlaneVertexDeclaration: {
  9493. name: string;
  9494. shader: string;
  9495. };
  9496. }
  9497. declare module "babylonjs/Shaders/ShadersInclude/morphTargetsVertex" {
  9498. /** @hidden */
  9499. export var morphTargetsVertex: {
  9500. name: string;
  9501. shader: string;
  9502. };
  9503. }
  9504. declare module "babylonjs/Shaders/ShadersInclude/instancesVertex" {
  9505. /** @hidden */
  9506. export var instancesVertex: {
  9507. name: string;
  9508. shader: string;
  9509. };
  9510. }
  9511. declare module "babylonjs/Shaders/ShadersInclude/bonesVertex" {
  9512. /** @hidden */
  9513. export var bonesVertex: {
  9514. name: string;
  9515. shader: string;
  9516. };
  9517. }
  9518. declare module "babylonjs/Shaders/ShadersInclude/shadowMapVertexNormalBias" {
  9519. /** @hidden */
  9520. export var shadowMapVertexNormalBias: {
  9521. name: string;
  9522. shader: string;
  9523. };
  9524. }
  9525. declare module "babylonjs/Shaders/ShadersInclude/shadowMapVertexMetric" {
  9526. /** @hidden */
  9527. export var shadowMapVertexMetric: {
  9528. name: string;
  9529. shader: string;
  9530. };
  9531. }
  9532. declare module "babylonjs/Shaders/ShadersInclude/clipPlaneVertex" {
  9533. /** @hidden */
  9534. export var clipPlaneVertex: {
  9535. name: string;
  9536. shader: string;
  9537. };
  9538. }
  9539. declare module "babylonjs/Shaders/shadowMap.vertex" {
  9540. import "babylonjs/Shaders/ShadersInclude/bonesDeclaration";
  9541. import "babylonjs/Shaders/ShadersInclude/morphTargetsVertexGlobalDeclaration";
  9542. import "babylonjs/Shaders/ShadersInclude/morphTargetsVertexDeclaration";
  9543. import "babylonjs/Shaders/ShadersInclude/instancesDeclaration";
  9544. import "babylonjs/Shaders/ShadersInclude/helperFunctions";
  9545. import "babylonjs/Shaders/ShadersInclude/shadowMapVertexDeclaration";
  9546. import "babylonjs/Shaders/ShadersInclude/clipPlaneVertexDeclaration";
  9547. import "babylonjs/Shaders/ShadersInclude/morphTargetsVertex";
  9548. import "babylonjs/Shaders/ShadersInclude/instancesVertex";
  9549. import "babylonjs/Shaders/ShadersInclude/bonesVertex";
  9550. import "babylonjs/Shaders/ShadersInclude/shadowMapVertexNormalBias";
  9551. import "babylonjs/Shaders/ShadersInclude/shadowMapVertexMetric";
  9552. import "babylonjs/Shaders/ShadersInclude/clipPlaneVertex";
  9553. /** @hidden */
  9554. export var shadowMapVertexShader: {
  9555. name: string;
  9556. shader: string;
  9557. };
  9558. }
  9559. declare module "babylonjs/Shaders/depthBoxBlur.fragment" {
  9560. /** @hidden */
  9561. export var depthBoxBlurPixelShader: {
  9562. name: string;
  9563. shader: string;
  9564. };
  9565. }
  9566. declare module "babylonjs/Shaders/ShadersInclude/shadowMapFragmentSoftTransparentShadow" {
  9567. /** @hidden */
  9568. export var shadowMapFragmentSoftTransparentShadow: {
  9569. name: string;
  9570. shader: string;
  9571. };
  9572. }
  9573. declare module "babylonjs/Materials/effectFallbacks" {
  9574. import { IEffectFallbacks } from "babylonjs/Materials/iEffectFallbacks";
  9575. import { Effect } from "babylonjs/Materials/effect";
  9576. import { AbstractMesh } from "babylonjs/Meshes/abstractMesh";
  9577. /**
  9578. * EffectFallbacks can be used to add fallbacks (properties to disable) to certain properties when desired to improve performance.
  9579. * (Eg. Start at high quality with reflection and fog, if fps is low, remove reflection, if still low remove fog)
  9580. */
  9581. export class EffectFallbacks implements IEffectFallbacks {
  9582. private _defines;
  9583. private _currentRank;
  9584. private _maxRank;
  9585. private _mesh;
  9586. /**
  9587. * Removes the fallback from the bound mesh.
  9588. */
  9589. unBindMesh(): void;
  9590. /**
  9591. * Adds a fallback on the specified property.
  9592. * @param rank The rank of the fallback (Lower ranks will be fallbacked to first)
  9593. * @param define The name of the define in the shader
  9594. */
  9595. addFallback(rank: number, define: string): void;
  9596. /**
  9597. * Sets the mesh to use CPU skinning when needing to fallback.
  9598. * @param rank The rank of the fallback (Lower ranks will be fallbacked to first)
  9599. * @param mesh The mesh to use the fallbacks.
  9600. */
  9601. addCPUSkinningFallback(rank: number, mesh: AbstractMesh): void;
  9602. /**
  9603. * Checks to see if more fallbacks are still availible.
  9604. */
  9605. get hasMoreFallbacks(): boolean;
  9606. /**
  9607. * Removes the defines that should be removed when falling back.
  9608. * @param currentDefines defines the current define statements for the shader.
  9609. * @param effect defines the current effect we try to compile
  9610. * @returns The resulting defines with defines of the current rank removed.
  9611. */
  9612. reduce(currentDefines: string, effect: Effect): string;
  9613. }
  9614. }
  9615. declare module "babylonjs/Actions/action" {
  9616. import { Observable } from "babylonjs/Misc/observable";
  9617. import { Condition } from "babylonjs/Actions/condition";
  9618. import { AbstractActionManager } from "babylonjs/Actions/abstractActionManager";
  9619. import { Nullable } from "babylonjs/types";
  9620. import { Scene } from "babylonjs/scene";
  9621. import { ActionManager } from "babylonjs/Actions/actionManager";
  9622. import { ActionEvent } from "babylonjs/Actions/actionEvent";
  9623. import { Node } from "babylonjs/node";
  9624. /**
  9625. * Interface used to define Action
  9626. */
  9627. export interface IAction {
  9628. /**
  9629. * Trigger for the action
  9630. */
  9631. trigger: number;
  9632. /** Options of the trigger */
  9633. triggerOptions: any;
  9634. /**
  9635. * Gets the trigger parameters
  9636. * @returns the trigger parameters
  9637. */
  9638. getTriggerParameter(): any;
  9639. /**
  9640. * Internal only - executes current action event
  9641. * @hidden
  9642. */
  9643. _executeCurrent(evt?: ActionEvent): void;
  9644. /**
  9645. * Serialize placeholder for child classes
  9646. * @param parent of child
  9647. * @returns the serialized object
  9648. */
  9649. serialize(parent: any): any;
  9650. /**
  9651. * Internal only
  9652. * @hidden
  9653. */
  9654. _prepare(): void;
  9655. /**
  9656. * Internal only - manager for action
  9657. * @hidden
  9658. */
  9659. _actionManager: Nullable<AbstractActionManager>;
  9660. /**
  9661. * Adds action to chain of actions, may be a DoNothingAction
  9662. * @param action defines the next action to execute
  9663. * @returns The action passed in
  9664. * @see https://www.babylonjs-playground.com/#1T30HR#0
  9665. */
  9666. then(action: IAction): IAction;
  9667. }
  9668. /**
  9669. * The action to be carried out following a trigger
  9670. * @see https://doc.babylonjs.com/how_to/how_to_use_actions#available-actions
  9671. */
  9672. export class Action implements IAction {
  9673. /** the trigger, with or without parameters, for the action */
  9674. triggerOptions: any;
  9675. /**
  9676. * Trigger for the action
  9677. */
  9678. trigger: number;
  9679. /**
  9680. * Internal only - manager for action
  9681. * @hidden
  9682. */
  9683. _actionManager: ActionManager;
  9684. private _nextActiveAction;
  9685. private _child;
  9686. private _condition?;
  9687. private _triggerParameter;
  9688. /**
  9689. * An event triggered prior to action being executed.
  9690. */
  9691. onBeforeExecuteObservable: Observable<Action>;
  9692. /**
  9693. * Creates a new Action
  9694. * @param triggerOptions the trigger, with or without parameters, for the action
  9695. * @param condition an optional determinant of action
  9696. */
  9697. constructor(
  9698. /** the trigger, with or without parameters, for the action */
  9699. triggerOptions: any, condition?: Condition);
  9700. /**
  9701. * Internal only
  9702. * @hidden
  9703. */
  9704. _prepare(): void;
  9705. /**
  9706. * Gets the trigger parameters
  9707. * @returns the trigger parameters
  9708. */
  9709. getTriggerParameter(): any;
  9710. /**
  9711. * Internal only - executes current action event
  9712. * @hidden
  9713. */
  9714. _executeCurrent(evt?: ActionEvent): void;
  9715. /**
  9716. * Execute placeholder for child classes
  9717. * @param evt optional action event
  9718. */
  9719. execute(evt?: ActionEvent): void;
  9720. /**
  9721. * Skips to next active action
  9722. */
  9723. skipToNextActiveAction(): void;
  9724. /**
  9725. * Adds action to chain of actions, may be a DoNothingAction
  9726. * @param action defines the next action to execute
  9727. * @returns The action passed in
  9728. * @see https://www.babylonjs-playground.com/#1T30HR#0
  9729. */
  9730. then(action: Action): Action;
  9731. /**
  9732. * Internal only
  9733. * @hidden
  9734. */
  9735. _getProperty(propertyPath: string): string;
  9736. /**
  9737. * Internal only
  9738. * @hidden
  9739. */
  9740. _getEffectiveTarget(target: any, propertyPath: string): any;
  9741. /**
  9742. * Serialize placeholder for child classes
  9743. * @param parent of child
  9744. * @returns the serialized object
  9745. */
  9746. serialize(parent: any): any;
  9747. /**
  9748. * Internal only called by serialize
  9749. * @hidden
  9750. */
  9751. protected _serialize(serializedAction: any, parent?: any): any;
  9752. /**
  9753. * Internal only
  9754. * @hidden
  9755. */
  9756. static _SerializeValueAsString: (value: any) => string;
  9757. /**
  9758. * Internal only
  9759. * @hidden
  9760. */
  9761. static _GetTargetProperty: (target: Scene | Node) => {
  9762. name: string;
  9763. targetType: string;
  9764. value: string;
  9765. };
  9766. }
  9767. }
  9768. declare module "babylonjs/Actions/condition" {
  9769. import { ActionManager } from "babylonjs/Actions/actionManager";
  9770. /**
  9771. * A Condition applied to an Action
  9772. */
  9773. export class Condition {
  9774. /**
  9775. * Internal only - manager for action
  9776. * @hidden
  9777. */
  9778. _actionManager: ActionManager;
  9779. /**
  9780. * Internal only
  9781. * @hidden
  9782. */
  9783. _evaluationId: number;
  9784. /**
  9785. * Internal only
  9786. * @hidden
  9787. */
  9788. _currentResult: boolean;
  9789. /**
  9790. * Creates a new Condition
  9791. * @param actionManager the manager of the action the condition is applied to
  9792. */
  9793. constructor(actionManager: ActionManager);
  9794. /**
  9795. * Check if the current condition is valid
  9796. * @returns a boolean
  9797. */
  9798. isValid(): boolean;
  9799. /**
  9800. * Internal only
  9801. * @hidden
  9802. */
  9803. _getProperty(propertyPath: string): string;
  9804. /**
  9805. * Internal only
  9806. * @hidden
  9807. */
  9808. _getEffectiveTarget(target: any, propertyPath: string): any;
  9809. /**
  9810. * Serialize placeholder for child classes
  9811. * @returns the serialized object
  9812. */
  9813. serialize(): any;
  9814. /**
  9815. * Internal only
  9816. * @hidden
  9817. */
  9818. protected _serialize(serializedCondition: any): any;
  9819. }
  9820. /**
  9821. * Defines specific conditional operators as extensions of Condition
  9822. */
  9823. export class ValueCondition extends Condition {
  9824. /** path to specify the property of the target the conditional operator uses */
  9825. propertyPath: string;
  9826. /** the value compared by the conditional operator against the current value of the property */
  9827. value: any;
  9828. /** the conditional operator, default ValueCondition.IsEqual */
  9829. operator: number;
  9830. /**
  9831. * Internal only
  9832. * @hidden
  9833. */
  9834. private static _IsEqual;
  9835. /**
  9836. * Internal only
  9837. * @hidden
  9838. */
  9839. private static _IsDifferent;
  9840. /**
  9841. * Internal only
  9842. * @hidden
  9843. */
  9844. private static _IsGreater;
  9845. /**
  9846. * Internal only
  9847. * @hidden
  9848. */
  9849. private static _IsLesser;
  9850. /**
  9851. * returns the number for IsEqual
  9852. */
  9853. static get IsEqual(): number;
  9854. /**
  9855. * Returns the number for IsDifferent
  9856. */
  9857. static get IsDifferent(): number;
  9858. /**
  9859. * Returns the number for IsGreater
  9860. */
  9861. static get IsGreater(): number;
  9862. /**
  9863. * Returns the number for IsLesser
  9864. */
  9865. static get IsLesser(): number;
  9866. /**
  9867. * Internal only The action manager for the condition
  9868. * @hidden
  9869. */
  9870. _actionManager: ActionManager;
  9871. /**
  9872. * Internal only
  9873. * @hidden
  9874. */
  9875. private _target;
  9876. /**
  9877. * Internal only
  9878. * @hidden
  9879. */
  9880. private _effectiveTarget;
  9881. /**
  9882. * Internal only
  9883. * @hidden
  9884. */
  9885. private _property;
  9886. /**
  9887. * Creates a new ValueCondition
  9888. * @param actionManager manager for the action the condition applies to
  9889. * @param target for the action
  9890. * @param propertyPath path to specify the property of the target the conditional operator uses
  9891. * @param value the value compared by the conditional operator against the current value of the property
  9892. * @param operator the conditional operator, default ValueCondition.IsEqual
  9893. */
  9894. constructor(actionManager: ActionManager, target: any,
  9895. /** path to specify the property of the target the conditional operator uses */
  9896. propertyPath: string,
  9897. /** the value compared by the conditional operator against the current value of the property */
  9898. value: any,
  9899. /** the conditional operator, default ValueCondition.IsEqual */
  9900. operator?: number);
  9901. /**
  9902. * Compares the given value with the property value for the specified conditional operator
  9903. * @returns the result of the comparison
  9904. */
  9905. isValid(): boolean;
  9906. /**
  9907. * Serialize the ValueCondition into a JSON compatible object
  9908. * @returns serialization object
  9909. */
  9910. serialize(): any;
  9911. /**
  9912. * Gets the name of the conditional operator for the ValueCondition
  9913. * @param operator the conditional operator
  9914. * @returns the name
  9915. */
  9916. static GetOperatorName(operator: number): string;
  9917. }
  9918. /**
  9919. * Defines a predicate condition as an extension of Condition
  9920. */
  9921. export class PredicateCondition extends Condition {
  9922. /** defines the predicate function used to validate the condition */
  9923. predicate: () => boolean;
  9924. /**
  9925. * Internal only - manager for action
  9926. * @hidden
  9927. */
  9928. _actionManager: ActionManager;
  9929. /**
  9930. * Creates a new PredicateCondition
  9931. * @param actionManager manager for the action the condition applies to
  9932. * @param predicate defines the predicate function used to validate the condition
  9933. */
  9934. constructor(actionManager: ActionManager,
  9935. /** defines the predicate function used to validate the condition */
  9936. predicate: () => boolean);
  9937. /**
  9938. * @returns the validity of the predicate condition
  9939. */
  9940. isValid(): boolean;
  9941. }
  9942. /**
  9943. * Defines a state condition as an extension of Condition
  9944. */
  9945. export class StateCondition extends Condition {
  9946. /** Value to compare with target state */
  9947. value: string;
  9948. /**
  9949. * Internal only - manager for action
  9950. * @hidden
  9951. */
  9952. _actionManager: ActionManager;
  9953. /**
  9954. * Internal only
  9955. * @hidden
  9956. */
  9957. private _target;
  9958. /**
  9959. * Creates a new StateCondition
  9960. * @param actionManager manager for the action the condition applies to
  9961. * @param target of the condition
  9962. * @param value to compare with target state
  9963. */
  9964. constructor(actionManager: ActionManager, target: any,
  9965. /** Value to compare with target state */
  9966. value: string);
  9967. /**
  9968. * Gets a boolean indicating if the current condition is met
  9969. * @returns the validity of the state
  9970. */
  9971. isValid(): boolean;
  9972. /**
  9973. * Serialize the StateCondition into a JSON compatible object
  9974. * @returns serialization object
  9975. */
  9976. serialize(): any;
  9977. }
  9978. }
  9979. declare module "babylonjs/Actions/directActions" {
  9980. import { Action } from "babylonjs/Actions/action";
  9981. import { Condition } from "babylonjs/Actions/condition";
  9982. import { ActionEvent } from "babylonjs/Actions/actionEvent";
  9983. /**
  9984. * This defines an action responsible to toggle a boolean once triggered.
  9985. * @see https://doc.babylonjs.com/how_to/how_to_use_actions
  9986. */
  9987. export class SwitchBooleanAction extends Action {
  9988. /**
  9989. * The path to the boolean property in the target object
  9990. */
  9991. propertyPath: string;
  9992. private _target;
  9993. private _effectiveTarget;
  9994. private _property;
  9995. /**
  9996. * Instantiate the action
  9997. * @param triggerOptions defines the trigger options
  9998. * @param target defines the object containing the boolean
  9999. * @param propertyPath defines the path to the boolean property in the target object
  10000. * @param condition defines the trigger related conditions
  10001. */
  10002. constructor(triggerOptions: any, target: any, propertyPath: string, condition?: Condition);
  10003. /** @hidden */
  10004. _prepare(): void;
  10005. /**
  10006. * Execute the action toggle the boolean value.
  10007. */
  10008. execute(): void;
  10009. /**
  10010. * Serializes the actions and its related information.
  10011. * @param parent defines the object to serialize in
  10012. * @returns the serialized object
  10013. */
  10014. serialize(parent: any): any;
  10015. }
  10016. /**
  10017. * This defines an action responsible to set a the state field of the target
  10018. * to a desired value once triggered.
  10019. * @see https://doc.babylonjs.com/how_to/how_to_use_actions
  10020. */
  10021. export class SetStateAction extends Action {
  10022. /**
  10023. * The value to store in the state field.
  10024. */
  10025. value: string;
  10026. private _target;
  10027. /**
  10028. * Instantiate the action
  10029. * @param triggerOptions defines the trigger options
  10030. * @param target defines the object containing the state property
  10031. * @param value defines the value to store in the state field
  10032. * @param condition defines the trigger related conditions
  10033. */
  10034. constructor(triggerOptions: any, target: any, value: string, condition?: Condition);
  10035. /**
  10036. * Execute the action and store the value on the target state property.
  10037. */
  10038. execute(): void;
  10039. /**
  10040. * Serializes the actions and its related information.
  10041. * @param parent defines the object to serialize in
  10042. * @returns the serialized object
  10043. */
  10044. serialize(parent: any): any;
  10045. }
  10046. /**
  10047. * This defines an action responsible to set a property of the target
  10048. * to a desired value once triggered.
  10049. * @see https://doc.babylonjs.com/how_to/how_to_use_actions
  10050. */
  10051. export class SetValueAction extends Action {
  10052. /**
  10053. * The path of the property to set in the target.
  10054. */
  10055. propertyPath: string;
  10056. /**
  10057. * The value to set in the property
  10058. */
  10059. value: any;
  10060. private _target;
  10061. private _effectiveTarget;
  10062. private _property;
  10063. /**
  10064. * Instantiate the action
  10065. * @param triggerOptions defines the trigger options
  10066. * @param target defines the object containing the property
  10067. * @param propertyPath defines the path of the property to set in the target
  10068. * @param value defines the value to set in the property
  10069. * @param condition defines the trigger related conditions
  10070. */
  10071. constructor(triggerOptions: any, target: any, propertyPath: string, value: any, condition?: Condition);
  10072. /** @hidden */
  10073. _prepare(): void;
  10074. /**
  10075. * Execute the action and set the targetted property to the desired value.
  10076. */
  10077. execute(): void;
  10078. /**
  10079. * Serializes the actions and its related information.
  10080. * @param parent defines the object to serialize in
  10081. * @returns the serialized object
  10082. */
  10083. serialize(parent: any): any;
  10084. }
  10085. /**
  10086. * This defines an action responsible to increment the target value
  10087. * to a desired value once triggered.
  10088. * @see https://doc.babylonjs.com/how_to/how_to_use_actions
  10089. */
  10090. export class IncrementValueAction extends Action {
  10091. /**
  10092. * The path of the property to increment in the target.
  10093. */
  10094. propertyPath: string;
  10095. /**
  10096. * The value we should increment the property by.
  10097. */
  10098. value: any;
  10099. private _target;
  10100. private _effectiveTarget;
  10101. private _property;
  10102. /**
  10103. * Instantiate the action
  10104. * @param triggerOptions defines the trigger options
  10105. * @param target defines the object containing the property
  10106. * @param propertyPath defines the path of the property to increment in the target
  10107. * @param value defines the value value we should increment the property by
  10108. * @param condition defines the trigger related conditions
  10109. */
  10110. constructor(triggerOptions: any, target: any, propertyPath: string, value: any, condition?: Condition);
  10111. /** @hidden */
  10112. _prepare(): void;
  10113. /**
  10114. * Execute the action and increment the target of the value amount.
  10115. */
  10116. execute(): void;
  10117. /**
  10118. * Serializes the actions and its related information.
  10119. * @param parent defines the object to serialize in
  10120. * @returns the serialized object
  10121. */
  10122. serialize(parent: any): any;
  10123. }
  10124. /**
  10125. * This defines an action responsible to start an animation once triggered.
  10126. * @see https://doc.babylonjs.com/how_to/how_to_use_actions
  10127. */
  10128. export class PlayAnimationAction extends Action {
  10129. /**
  10130. * Where the animation should start (animation frame)
  10131. */
  10132. from: number;
  10133. /**
  10134. * Where the animation should stop (animation frame)
  10135. */
  10136. to: number;
  10137. /**
  10138. * Define if the animation should loop or stop after the first play.
  10139. */
  10140. loop?: boolean;
  10141. private _target;
  10142. /**
  10143. * Instantiate the action
  10144. * @param triggerOptions defines the trigger options
  10145. * @param target defines the target animation or animation name
  10146. * @param from defines from where the animation should start (animation frame)
  10147. * @param end defines where the animation should stop (animation frame)
  10148. * @param loop defines if the animation should loop or stop after the first play
  10149. * @param condition defines the trigger related conditions
  10150. */
  10151. constructor(triggerOptions: any, target: any, from: number, to: number, loop?: boolean, condition?: Condition);
  10152. /** @hidden */
  10153. _prepare(): void;
  10154. /**
  10155. * Execute the action and play the animation.
  10156. */
  10157. execute(): void;
  10158. /**
  10159. * Serializes the actions and its related information.
  10160. * @param parent defines the object to serialize in
  10161. * @returns the serialized object
  10162. */
  10163. serialize(parent: any): any;
  10164. }
  10165. /**
  10166. * This defines an action responsible to stop an animation once triggered.
  10167. * @see https://doc.babylonjs.com/how_to/how_to_use_actions
  10168. */
  10169. export class StopAnimationAction extends Action {
  10170. private _target;
  10171. /**
  10172. * Instantiate the action
  10173. * @param triggerOptions defines the trigger options
  10174. * @param target defines the target animation or animation name
  10175. * @param condition defines the trigger related conditions
  10176. */
  10177. constructor(triggerOptions: any, target: any, condition?: Condition);
  10178. /** @hidden */
  10179. _prepare(): void;
  10180. /**
  10181. * Execute the action and stop the animation.
  10182. */
  10183. execute(): void;
  10184. /**
  10185. * Serializes the actions and its related information.
  10186. * @param parent defines the object to serialize in
  10187. * @returns the serialized object
  10188. */
  10189. serialize(parent: any): any;
  10190. }
  10191. /**
  10192. * This defines an action responsible that does nothing once triggered.
  10193. * @see https://doc.babylonjs.com/how_to/how_to_use_actions
  10194. */
  10195. export class DoNothingAction extends Action {
  10196. /**
  10197. * Instantiate the action
  10198. * @param triggerOptions defines the trigger options
  10199. * @param condition defines the trigger related conditions
  10200. */
  10201. constructor(triggerOptions?: any, condition?: Condition);
  10202. /**
  10203. * Execute the action and do nothing.
  10204. */
  10205. execute(): void;
  10206. /**
  10207. * Serializes the actions and its related information.
  10208. * @param parent defines the object to serialize in
  10209. * @returns the serialized object
  10210. */
  10211. serialize(parent: any): any;
  10212. }
  10213. /**
  10214. * This defines an action responsible to trigger several actions once triggered.
  10215. * @see https://doc.babylonjs.com/how_to/how_to_use_actions
  10216. */
  10217. export class CombineAction extends Action {
  10218. /**
  10219. * The list of aggregated animations to run.
  10220. */
  10221. children: Action[];
  10222. /**
  10223. * Instantiate the action
  10224. * @param triggerOptions defines the trigger options
  10225. * @param children defines the list of aggregated animations to run
  10226. * @param condition defines the trigger related conditions
  10227. */
  10228. constructor(triggerOptions: any, children: Action[], condition?: Condition);
  10229. /** @hidden */
  10230. _prepare(): void;
  10231. /**
  10232. * Execute the action and executes all the aggregated actions.
  10233. */
  10234. execute(evt: ActionEvent): void;
  10235. /**
  10236. * Serializes the actions and its related information.
  10237. * @param parent defines the object to serialize in
  10238. * @returns the serialized object
  10239. */
  10240. serialize(parent: any): any;
  10241. }
  10242. /**
  10243. * This defines an action responsible to run code (external event) once triggered.
  10244. * @see https://doc.babylonjs.com/how_to/how_to_use_actions
  10245. */
  10246. export class ExecuteCodeAction extends Action {
  10247. /**
  10248. * The callback function to run.
  10249. */
  10250. func: (evt: ActionEvent) => void;
  10251. /**
  10252. * Instantiate the action
  10253. * @param triggerOptions defines the trigger options
  10254. * @param func defines the callback function to run
  10255. * @param condition defines the trigger related conditions
  10256. */
  10257. constructor(triggerOptions: any, func: (evt: ActionEvent) => void, condition?: Condition);
  10258. /**
  10259. * Execute the action and run the attached code.
  10260. */
  10261. execute(evt: ActionEvent): void;
  10262. }
  10263. /**
  10264. * This defines an action responsible to set the parent property of the target once triggered.
  10265. * @see https://doc.babylonjs.com/how_to/how_to_use_actions
  10266. */
  10267. export class SetParentAction extends Action {
  10268. private _parent;
  10269. private _target;
  10270. /**
  10271. * Instantiate the action
  10272. * @param triggerOptions defines the trigger options
  10273. * @param target defines the target containing the parent property
  10274. * @param parent defines from where the animation should start (animation frame)
  10275. * @param condition defines the trigger related conditions
  10276. */
  10277. constructor(triggerOptions: any, target: any, parent: any, condition?: Condition);
  10278. /** @hidden */
  10279. _prepare(): void;
  10280. /**
  10281. * Execute the action and set the parent property.
  10282. */
  10283. execute(): void;
  10284. /**
  10285. * Serializes the actions and its related information.
  10286. * @param parent defines the object to serialize in
  10287. * @returns the serialized object
  10288. */
  10289. serialize(parent: any): any;
  10290. }
  10291. }
  10292. declare module "babylonjs/Actions/actionManager" {
  10293. import { Nullable } from "babylonjs/types";
  10294. import { AbstractMesh } from "babylonjs/Meshes/abstractMesh";
  10295. import { Scene } from "babylonjs/scene";
  10296. import { IAction } from "babylonjs/Actions/action";
  10297. import { IActionEvent } from "babylonjs/Actions/actionEvent";
  10298. import { AbstractActionManager } from "babylonjs/Actions/abstractActionManager";
  10299. /**
  10300. * Action Manager manages all events to be triggered on a given mesh or the global scene.
  10301. * A single scene can have many Action Managers to handle predefined actions on specific meshes.
  10302. * @see https://doc.babylonjs.com/how_to/how_to_use_actions
  10303. */
  10304. export class ActionManager extends AbstractActionManager {
  10305. /**
  10306. * Nothing
  10307. * @see https://doc.babylonjs.com/how_to/how_to_use_actions#triggers
  10308. */
  10309. static readonly NothingTrigger: number;
  10310. /**
  10311. * On pick
  10312. * @see https://doc.babylonjs.com/how_to/how_to_use_actions#triggers
  10313. */
  10314. static readonly OnPickTrigger: number;
  10315. /**
  10316. * On left pick
  10317. * @see https://doc.babylonjs.com/how_to/how_to_use_actions#triggers
  10318. */
  10319. static readonly OnLeftPickTrigger: number;
  10320. /**
  10321. * On right pick
  10322. * @see https://doc.babylonjs.com/how_to/how_to_use_actions#triggers
  10323. */
  10324. static readonly OnRightPickTrigger: number;
  10325. /**
  10326. * On center pick
  10327. * @see https://doc.babylonjs.com/how_to/how_to_use_actions#triggers
  10328. */
  10329. static readonly OnCenterPickTrigger: number;
  10330. /**
  10331. * On pick down
  10332. * @see https://doc.babylonjs.com/how_to/how_to_use_actions#triggers
  10333. */
  10334. static readonly OnPickDownTrigger: number;
  10335. /**
  10336. * On double pick
  10337. * @see https://doc.babylonjs.com/how_to/how_to_use_actions#triggers
  10338. */
  10339. static readonly OnDoublePickTrigger: number;
  10340. /**
  10341. * On pick up
  10342. * @see https://doc.babylonjs.com/how_to/how_to_use_actions#triggers
  10343. */
  10344. static readonly OnPickUpTrigger: number;
  10345. /**
  10346. * On pick out.
  10347. * This trigger will only be raised if you also declared a OnPickDown
  10348. * @see https://doc.babylonjs.com/how_to/how_to_use_actions#triggers
  10349. */
  10350. static readonly OnPickOutTrigger: number;
  10351. /**
  10352. * On long press
  10353. * @see https://doc.babylonjs.com/how_to/how_to_use_actions#triggers
  10354. */
  10355. static readonly OnLongPressTrigger: number;
  10356. /**
  10357. * On pointer over
  10358. * @see https://doc.babylonjs.com/how_to/how_to_use_actions#triggers
  10359. */
  10360. static readonly OnPointerOverTrigger: number;
  10361. /**
  10362. * On pointer out
  10363. * @see https://doc.babylonjs.com/how_to/how_to_use_actions#triggers
  10364. */
  10365. static readonly OnPointerOutTrigger: number;
  10366. /**
  10367. * On every frame
  10368. * @see https://doc.babylonjs.com/how_to/how_to_use_actions#triggers
  10369. */
  10370. static readonly OnEveryFrameTrigger: number;
  10371. /**
  10372. * On intersection enter
  10373. * @see https://doc.babylonjs.com/how_to/how_to_use_actions#triggers
  10374. */
  10375. static readonly OnIntersectionEnterTrigger: number;
  10376. /**
  10377. * On intersection exit
  10378. * @see https://doc.babylonjs.com/how_to/how_to_use_actions#triggers
  10379. */
  10380. static readonly OnIntersectionExitTrigger: number;
  10381. /**
  10382. * On key down
  10383. * @see https://doc.babylonjs.com/how_to/how_to_use_actions#triggers
  10384. */
  10385. static readonly OnKeyDownTrigger: number;
  10386. /**
  10387. * On key up
  10388. * @see https://doc.babylonjs.com/how_to/how_to_use_actions#triggers
  10389. */
  10390. static readonly OnKeyUpTrigger: number;
  10391. private _scene;
  10392. /**
  10393. * Creates a new action manager
  10394. * @param scene defines the hosting scene
  10395. */
  10396. constructor(scene: Scene);
  10397. /**
  10398. * Releases all associated resources
  10399. */
  10400. dispose(): void;
  10401. /**
  10402. * Gets hosting scene
  10403. * @returns the hosting scene
  10404. */
  10405. getScene(): Scene;
  10406. /**
  10407. * Does this action manager handles actions of any of the given triggers
  10408. * @param triggers defines the triggers to be tested
  10409. * @return a boolean indicating whether one (or more) of the triggers is handled
  10410. */
  10411. hasSpecificTriggers(triggers: number[]): boolean;
  10412. /**
  10413. * Does this action manager handles actions of any of the given triggers. This function takes two arguments for
  10414. * speed.
  10415. * @param triggerA defines the trigger to be tested
  10416. * @param triggerB defines the trigger to be tested
  10417. * @return a boolean indicating whether one (or more) of the triggers is handled
  10418. */
  10419. hasSpecificTriggers2(triggerA: number, triggerB: number): boolean;
  10420. /**
  10421. * Does this action manager handles actions of a given trigger
  10422. * @param trigger defines the trigger to be tested
  10423. * @param parameterPredicate defines an optional predicate to filter triggers by parameter
  10424. * @return whether the trigger is handled
  10425. */
  10426. hasSpecificTrigger(trigger: number, parameterPredicate?: (parameter: any) => boolean): boolean;
  10427. /**
  10428. * Does this action manager has pointer triggers
  10429. */
  10430. get hasPointerTriggers(): boolean;
  10431. /**
  10432. * Does this action manager has pick triggers
  10433. */
  10434. get hasPickTriggers(): boolean;
  10435. /**
  10436. * Registers an action to this action manager
  10437. * @param action defines the action to be registered
  10438. * @return the action amended (prepared) after registration
  10439. */
  10440. registerAction(action: IAction): Nullable<IAction>;
  10441. /**
  10442. * Unregisters an action to this action manager
  10443. * @param action defines the action to be unregistered
  10444. * @return a boolean indicating whether the action has been unregistered
  10445. */
  10446. unregisterAction(action: IAction): Boolean;
  10447. /**
  10448. * Process a specific trigger
  10449. * @param trigger defines the trigger to process
  10450. * @param evt defines the event details to be processed
  10451. */
  10452. processTrigger(trigger: number, evt?: IActionEvent): void;
  10453. /** @hidden */
  10454. _getEffectiveTarget(target: any, propertyPath: string): any;
  10455. /** @hidden */
  10456. _getProperty(propertyPath: string): string;
  10457. /**
  10458. * Serialize this manager to a JSON object
  10459. * @param name defines the property name to store this manager
  10460. * @returns a JSON representation of this manager
  10461. */
  10462. serialize(name: string): any;
  10463. /**
  10464. * Creates a new ActionManager from a JSON data
  10465. * @param parsedActions defines the JSON data to read from
  10466. * @param object defines the hosting mesh
  10467. * @param scene defines the hosting scene
  10468. */
  10469. static Parse(parsedActions: any, object: Nullable<AbstractMesh>, scene: Scene): void;
  10470. /**
  10471. * Get a trigger name by index
  10472. * @param trigger defines the trigger index
  10473. * @returns a trigger name
  10474. */
  10475. static GetTriggerName(trigger: number): string;
  10476. }
  10477. }
  10478. declare module "babylonjs/Sprites/sprite" {
  10479. import { Vector3 } from "babylonjs/Maths/math.vector";
  10480. import { Nullable } from "babylonjs/types";
  10481. import { ActionManager } from "babylonjs/Actions/actionManager";
  10482. import { ISpriteManager, SpriteManager } from "babylonjs/Sprites/spriteManager";
  10483. import { Color4 } from "babylonjs/Maths/math.color";
  10484. import { Observable } from "babylonjs/Misc/observable";
  10485. import { IAnimatable } from "babylonjs/Animations/animatable.interface";
  10486. import { Animation } from "babylonjs/Animations/animation";
  10487. /**
  10488. * Class used to represent a sprite
  10489. * @see https://doc.babylonjs.com/babylon101/sprites
  10490. */
  10491. export class Sprite implements IAnimatable {
  10492. /** defines the name */
  10493. name: string;
  10494. /** Gets or sets the current world position */
  10495. position: Vector3;
  10496. /** Gets or sets the main color */
  10497. color: Color4;
  10498. /** Gets or sets the width */
  10499. width: number;
  10500. /** Gets or sets the height */
  10501. height: number;
  10502. /** Gets or sets rotation angle */
  10503. angle: number;
  10504. /** Gets or sets the cell index in the sprite sheet */
  10505. cellIndex: number;
  10506. /** Gets or sets the cell reference in the sprite sheet, uses sprite's filename when added to sprite sheet */
  10507. cellRef: string;
  10508. /** Gets or sets a boolean indicating if UV coordinates should be inverted in U axis */
  10509. invertU: boolean;
  10510. /** Gets or sets a boolean indicating if UV coordinates should be inverted in B axis */
  10511. invertV: boolean;
  10512. /** Gets or sets a boolean indicating that this sprite should be disposed after animation ends */
  10513. disposeWhenFinishedAnimating: boolean;
  10514. /** Gets the list of attached animations */
  10515. animations: Nullable<Array<Animation>>;
  10516. /** Gets or sets a boolean indicating if the sprite can be picked */
  10517. isPickable: boolean;
  10518. /** Gets or sets a boolean indicating that sprite texture alpha will be used for precise picking (false by default) */
  10519. useAlphaForPicking: boolean;
  10520. /** @hidden */
  10521. _xOffset: number;
  10522. /** @hidden */
  10523. _yOffset: number;
  10524. /** @hidden */
  10525. _xSize: number;
  10526. /** @hidden */
  10527. _ySize: number;
  10528. /**
  10529. * Gets or sets the associated action manager
  10530. */
  10531. actionManager: Nullable<ActionManager>;
  10532. /**
  10533. * An event triggered when the control has been disposed
  10534. */
  10535. onDisposeObservable: Observable<Sprite>;
  10536. private _animationStarted;
  10537. private _loopAnimation;
  10538. private _fromIndex;
  10539. private _toIndex;
  10540. private _delay;
  10541. private _direction;
  10542. private _manager;
  10543. private _time;
  10544. private _onAnimationEnd;
  10545. /**
  10546. * Gets or sets a boolean indicating if the sprite is visible (renderable). Default is true
  10547. */
  10548. isVisible: boolean;
  10549. /**
  10550. * Gets or sets the sprite size
  10551. */
  10552. get size(): number;
  10553. set size(value: number);
  10554. /**
  10555. * Returns a boolean indicating if the animation is started
  10556. */
  10557. get animationStarted(): boolean;
  10558. /**
  10559. * Gets or sets the unique id of the sprite
  10560. */
  10561. uniqueId: number;
  10562. /**
  10563. * Gets the manager of this sprite
  10564. */
  10565. get manager(): ISpriteManager;
  10566. /**
  10567. * Creates a new Sprite
  10568. * @param name defines the name
  10569. * @param manager defines the manager
  10570. */
  10571. constructor(
  10572. /** defines the name */
  10573. name: string, manager: ISpriteManager);
  10574. /**
  10575. * Returns the string "Sprite"
  10576. * @returns "Sprite"
  10577. */
  10578. getClassName(): string;
  10579. /** Gets or sets the initial key for the animation (setting it will restart the animation) */
  10580. get fromIndex(): number;
  10581. set fromIndex(value: number);
  10582. /** Gets or sets the end key for the animation (setting it will restart the animation) */
  10583. get toIndex(): number;
  10584. set toIndex(value: number);
  10585. /** Gets or sets a boolean indicating if the animation is looping (setting it will restart the animation) */
  10586. get loopAnimation(): boolean;
  10587. set loopAnimation(value: boolean);
  10588. /** Gets or sets the delay between cell changes (setting it will restart the animation) */
  10589. get delay(): number;
  10590. set delay(value: number);
  10591. /**
  10592. * Starts an animation
  10593. * @param from defines the initial key
  10594. * @param to defines the end key
  10595. * @param loop defines if the animation must loop
  10596. * @param delay defines the start delay (in ms)
  10597. * @param onAnimationEnd defines a callback to call when animation ends
  10598. */
  10599. playAnimation(from: number, to: number, loop: boolean, delay: number, onAnimationEnd?: Nullable<() => void>): void;
  10600. /** Stops current animation (if any) */
  10601. stopAnimation(): void;
  10602. /** @hidden */
  10603. _animate(deltaTime: number): void;
  10604. /** Release associated resources */
  10605. dispose(): void;
  10606. /**
  10607. * Serializes the sprite to a JSON object
  10608. * @returns the JSON object
  10609. */
  10610. serialize(): any;
  10611. /**
  10612. * Parses a JSON object to create a new sprite
  10613. * @param parsedSprite The JSON object to parse
  10614. * @param manager defines the hosting manager
  10615. * @returns the new sprite
  10616. */
  10617. static Parse(parsedSprite: any, manager: SpriteManager): Sprite;
  10618. }
  10619. }
  10620. declare module "babylonjs/Collisions/pickingInfo" {
  10621. import { Nullable } from "babylonjs/types";
  10622. import { Vector3, Vector2 } from "babylonjs/Maths/math.vector";
  10623. import { AbstractMesh } from "babylonjs/Meshes/abstractMesh";
  10624. import { Sprite } from "babylonjs/Sprites/sprite";
  10625. import { Ray } from "babylonjs/Culling/ray";
  10626. /**
  10627. * Information about the result of picking within a scene
  10628. * @see https://doc.babylonjs.com/babylon101/picking_collisions
  10629. */
  10630. export class PickingInfo {
  10631. /** @hidden */
  10632. _pickingUnavailable: boolean;
  10633. /**
  10634. * If the pick collided with an object
  10635. */
  10636. hit: boolean;
  10637. /**
  10638. * Distance away where the pick collided
  10639. */
  10640. distance: number;
  10641. /**
  10642. * The location of pick collision
  10643. */
  10644. pickedPoint: Nullable<Vector3>;
  10645. /**
  10646. * The mesh corresponding the the pick collision
  10647. */
  10648. pickedMesh: Nullable<AbstractMesh>;
  10649. /** (See getTextureCoordinates) The barycentric U coordinate that is used when calculating the texture coordinates of the collision.*/
  10650. bu: number;
  10651. /** (See getTextureCoordinates) The barycentric V coordinate that is used when calculating the texture coordinates of the collision.*/
  10652. bv: number;
  10653. /** The index of the face on the mesh that was picked, or the index of the Line if the picked Mesh is a LinesMesh */
  10654. faceId: number;
  10655. /** The index of the face on the subMesh that was picked, or the index of the Line if the picked Mesh is a LinesMesh */
  10656. subMeshFaceId: number;
  10657. /** Id of the the submesh that was picked */
  10658. subMeshId: number;
  10659. /** If a sprite was picked, this will be the sprite the pick collided with */
  10660. pickedSprite: Nullable<Sprite>;
  10661. /** If we are pikcing a mesh with thin instance, this will give you the picked thin instance */
  10662. thinInstanceIndex: number;
  10663. /**
  10664. * If a mesh was used to do the picking (eg. 6dof controller) this will be populated.
  10665. */
  10666. originMesh: Nullable<AbstractMesh>;
  10667. /**
  10668. * The ray that was used to perform the picking.
  10669. */
  10670. ray: Nullable<Ray>;
  10671. /**
  10672. * Gets the normal correspodning to the face the pick collided with
  10673. * @param useWorldCoordinates If the resulting normal should be relative to the world (default: false)
  10674. * @param useVerticesNormals If the vertices normals should be used to calculate the normal instead of the normal map
  10675. * @returns The normal correspodning to the face the pick collided with
  10676. */
  10677. getNormal(useWorldCoordinates?: boolean, useVerticesNormals?: boolean): Nullable<Vector3>;
  10678. /**
  10679. * Gets the texture coordinates of where the pick occured
  10680. * @returns the vector containing the coordnates of the texture
  10681. */
  10682. getTextureCoordinates(): Nullable<Vector2>;
  10683. }
  10684. }
  10685. declare module "babylonjs/Culling/ray" {
  10686. import { DeepImmutable, Nullable, float } from "babylonjs/types";
  10687. import { Matrix, Vector3 } from "babylonjs/Maths/math.vector";
  10688. import { AbstractMesh } from "babylonjs/Meshes/abstractMesh";
  10689. import { PickingInfo } from "babylonjs/Collisions/pickingInfo";
  10690. import { IntersectionInfo } from "babylonjs/Collisions/intersectionInfo";
  10691. import { BoundingBox } from "babylonjs/Culling/boundingBox";
  10692. import { BoundingSphere } from "babylonjs/Culling/boundingSphere";
  10693. import { Plane } from "babylonjs/Maths/math.plane";
  10694. /**
  10695. * Class representing a ray with position and direction
  10696. */
  10697. export class Ray {
  10698. /** origin point */
  10699. origin: Vector3;
  10700. /** direction */
  10701. direction: Vector3;
  10702. /** length of the ray */
  10703. length: number;
  10704. private static readonly _TmpVector3;
  10705. private _tmpRay;
  10706. /**
  10707. * Creates a new ray
  10708. * @param origin origin point
  10709. * @param direction direction
  10710. * @param length length of the ray
  10711. */
  10712. constructor(
  10713. /** origin point */
  10714. origin: Vector3,
  10715. /** direction */
  10716. direction: Vector3,
  10717. /** length of the ray */
  10718. length?: number);
  10719. /**
  10720. * Checks if the ray intersects a box
  10721. * This does not account for the ray lenght by design to improve perfs.
  10722. * @param minimum bound of the box
  10723. * @param maximum bound of the box
  10724. * @param intersectionTreshold extra extend to be added to the box in all direction
  10725. * @returns if the box was hit
  10726. */
  10727. intersectsBoxMinMax(minimum: DeepImmutable<Vector3>, maximum: DeepImmutable<Vector3>, intersectionTreshold?: number): boolean;
  10728. /**
  10729. * Checks if the ray intersects a box
  10730. * This does not account for the ray lenght by design to improve perfs.
  10731. * @param box the bounding box to check
  10732. * @param intersectionTreshold extra extend to be added to the BoundingBox in all direction
  10733. * @returns if the box was hit
  10734. */
  10735. intersectsBox(box: DeepImmutable<BoundingBox>, intersectionTreshold?: number): boolean;
  10736. /**
  10737. * If the ray hits a sphere
  10738. * @param sphere the bounding sphere to check
  10739. * @param intersectionTreshold extra extend to be added to the BoundingSphere in all direction
  10740. * @returns true if it hits the sphere
  10741. */
  10742. intersectsSphere(sphere: DeepImmutable<BoundingSphere>, intersectionTreshold?: number): boolean;
  10743. /**
  10744. * If the ray hits a triange
  10745. * @param vertex0 triangle vertex
  10746. * @param vertex1 triangle vertex
  10747. * @param vertex2 triangle vertex
  10748. * @returns intersection information if hit
  10749. */
  10750. intersectsTriangle(vertex0: DeepImmutable<Vector3>, vertex1: DeepImmutable<Vector3>, vertex2: DeepImmutable<Vector3>): Nullable<IntersectionInfo>;
  10751. /**
  10752. * Checks if ray intersects a plane
  10753. * @param plane the plane to check
  10754. * @returns the distance away it was hit
  10755. */
  10756. intersectsPlane(plane: DeepImmutable<Plane>): Nullable<number>;
  10757. /**
  10758. * Calculate the intercept of a ray on a given axis
  10759. * @param axis to check 'x' | 'y' | 'z'
  10760. * @param offset from axis interception (i.e. an offset of 1y is intercepted above ground)
  10761. * @returns a vector containing the coordinates where 'axis' is equal to zero (else offset), or null if there is no intercept.
  10762. */
  10763. intersectsAxis(axis: string, offset?: number): Nullable<Vector3>;
  10764. /**
  10765. * Checks if ray intersects a mesh
  10766. * @param mesh the mesh to check
  10767. * @param fastCheck defines if the first intersection will be used (and not the closest)
  10768. * @returns picking info of the intersecton
  10769. */
  10770. intersectsMesh(mesh: DeepImmutable<AbstractMesh>, fastCheck?: boolean): PickingInfo;
  10771. /**
  10772. * Checks if ray intersects a mesh
  10773. * @param meshes the meshes to check
  10774. * @param fastCheck defines if the first intersection will be used (and not the closest)
  10775. * @param results array to store result in
  10776. * @returns Array of picking infos
  10777. */
  10778. intersectsMeshes(meshes: Array<DeepImmutable<AbstractMesh>>, fastCheck?: boolean, results?: Array<PickingInfo>): Array<PickingInfo>;
  10779. private _comparePickingInfo;
  10780. private static smallnum;
  10781. private static rayl;
  10782. /**
  10783. * Intersection test between the ray and a given segment whithin a given tolerance (threshold)
  10784. * @param sega the first point of the segment to test the intersection against
  10785. * @param segb the second point of the segment to test the intersection against
  10786. * @param threshold the tolerance margin, if the ray doesn't intersect the segment but is close to the given threshold, the intersection is successful
  10787. * @return the distance from the ray origin to the intersection point if there's intersection, or -1 if there's no intersection
  10788. */
  10789. intersectionSegment(sega: DeepImmutable<Vector3>, segb: DeepImmutable<Vector3>, threshold: number): number;
  10790. /**
  10791. * Update the ray from viewport position
  10792. * @param x position
  10793. * @param y y position
  10794. * @param viewportWidth viewport width
  10795. * @param viewportHeight viewport height
  10796. * @param world world matrix
  10797. * @param view view matrix
  10798. * @param projection projection matrix
  10799. * @returns this ray updated
  10800. */
  10801. update(x: number, y: number, viewportWidth: number, viewportHeight: number, world: DeepImmutable<Matrix>, view: DeepImmutable<Matrix>, projection: DeepImmutable<Matrix>): Ray;
  10802. /**
  10803. * Creates a ray with origin and direction of 0,0,0
  10804. * @returns the new ray
  10805. */
  10806. static Zero(): Ray;
  10807. /**
  10808. * Creates a new ray from screen space and viewport
  10809. * @param x position
  10810. * @param y y position
  10811. * @param viewportWidth viewport width
  10812. * @param viewportHeight viewport height
  10813. * @param world world matrix
  10814. * @param view view matrix
  10815. * @param projection projection matrix
  10816. * @returns new ray
  10817. */
  10818. static CreateNew(x: number, y: number, viewportWidth: number, viewportHeight: number, world: DeepImmutable<Matrix>, view: DeepImmutable<Matrix>, projection: DeepImmutable<Matrix>): Ray;
  10819. /**
  10820. * 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
  10821. * transformed to the given world matrix.
  10822. * @param origin The origin point
  10823. * @param end The end point
  10824. * @param world a matrix to transform the ray to. Default is the identity matrix.
  10825. * @returns the new ray
  10826. */
  10827. static CreateNewFromTo(origin: Vector3, end: Vector3, world?: DeepImmutable<Matrix>): Ray;
  10828. /**
  10829. * Transforms a ray by a matrix
  10830. * @param ray ray to transform
  10831. * @param matrix matrix to apply
  10832. * @returns the resulting new ray
  10833. */
  10834. static Transform(ray: DeepImmutable<Ray>, matrix: DeepImmutable<Matrix>): Ray;
  10835. /**
  10836. * Transforms a ray by a matrix
  10837. * @param ray ray to transform
  10838. * @param matrix matrix to apply
  10839. * @param result ray to store result in
  10840. */
  10841. static TransformToRef(ray: DeepImmutable<Ray>, matrix: DeepImmutable<Matrix>, result: Ray): void;
  10842. /**
  10843. * Unproject a ray from screen space to object space
  10844. * @param sourceX defines the screen space x coordinate to use
  10845. * @param sourceY defines the screen space y coordinate to use
  10846. * @param viewportWidth defines the current width of the viewport
  10847. * @param viewportHeight defines the current height of the viewport
  10848. * @param world defines the world matrix to use (can be set to Identity to go to world space)
  10849. * @param view defines the view matrix to use
  10850. * @param projection defines the projection matrix to use
  10851. */
  10852. unprojectRayToRef(sourceX: float, sourceY: float, viewportWidth: number, viewportHeight: number, world: DeepImmutable<Matrix>, view: DeepImmutable<Matrix>, projection: DeepImmutable<Matrix>): void;
  10853. }
  10854. /**
  10855. * Type used to define predicate used to select faces when a mesh intersection is detected
  10856. */
  10857. export type TrianglePickingPredicate = (p0: Vector3, p1: Vector3, p2: Vector3, ray: Ray) => boolean;
  10858. module "babylonjs/scene" {
  10859. interface Scene {
  10860. /** @hidden */
  10861. _tempPickingRay: Nullable<Ray>;
  10862. /** @hidden */
  10863. _cachedRayForTransform: Ray;
  10864. /** @hidden */
  10865. _pickWithRayInverseMatrix: Matrix;
  10866. /** @hidden */
  10867. _internalPick(rayFunction: (world: Matrix) => Ray, predicate?: (mesh: AbstractMesh) => boolean, fastCheck?: boolean, onlyBoundingInfo?: boolean, trianglePredicate?: TrianglePickingPredicate): Nullable<PickingInfo>;
  10868. /** @hidden */
  10869. _internalMultiPick(rayFunction: (world: Matrix) => Ray, predicate?: (mesh: AbstractMesh) => boolean, trianglePredicate?: TrianglePickingPredicate): Nullable<PickingInfo[]>;
  10870. /** @hidden */
  10871. _internalPickForMesh(pickingInfo: Nullable<PickingInfo>, rayFunction: (world: Matrix) => Ray, mesh: AbstractMesh, world: Matrix, fastCheck?: boolean, onlyBoundingInfo?: boolean, trianglePredicate?: TrianglePickingPredicate): Nullable<PickingInfo>;
  10872. }
  10873. }
  10874. }
  10875. declare module "babylonjs/sceneComponent" {
  10876. import { Scene } from "babylonjs/scene";
  10877. import { AbstractMesh } from "babylonjs/Meshes/abstractMesh";
  10878. import { SubMesh } from "babylonjs/Meshes/subMesh";
  10879. import { _InstancesBatch } from "babylonjs/Meshes/mesh";
  10880. import { SmartArrayNoDuplicate } from "babylonjs/Misc/smartArray";
  10881. import { Nullable } from "babylonjs/types";
  10882. import { Camera } from "babylonjs/Cameras/camera";
  10883. import { RenderTargetTexture } from "babylonjs/Materials/Textures/renderTargetTexture";
  10884. import { PickingInfo } from "babylonjs/Collisions/pickingInfo";
  10885. import { AbstractScene } from "babylonjs/abstractScene";
  10886. import { Mesh } from "babylonjs/Meshes/mesh";
  10887. /**
  10888. * Groups all the scene component constants in one place to ease maintenance.
  10889. * @hidden
  10890. */
  10891. export class SceneComponentConstants {
  10892. static readonly NAME_EFFECTLAYER: string;
  10893. static readonly NAME_LAYER: string;
  10894. static readonly NAME_LENSFLARESYSTEM: string;
  10895. static readonly NAME_BOUNDINGBOXRENDERER: string;
  10896. static readonly NAME_PARTICLESYSTEM: string;
  10897. static readonly NAME_GAMEPAD: string;
  10898. static readonly NAME_SIMPLIFICATIONQUEUE: string;
  10899. static readonly NAME_GEOMETRYBUFFERRENDERER: string;
  10900. static readonly NAME_PREPASSRENDERER: string;
  10901. static readonly NAME_DEPTHRENDERER: string;
  10902. static readonly NAME_POSTPROCESSRENDERPIPELINEMANAGER: string;
  10903. static readonly NAME_SPRITE: string;
  10904. static readonly NAME_SUBSURFACE: string;
  10905. static readonly NAME_OUTLINERENDERER: string;
  10906. static readonly NAME_PROCEDURALTEXTURE: string;
  10907. static readonly NAME_SHADOWGENERATOR: string;
  10908. static readonly NAME_OCTREE: string;
  10909. static readonly NAME_PHYSICSENGINE: string;
  10910. static readonly NAME_AUDIO: string;
  10911. static readonly STEP_ISREADYFORMESH_EFFECTLAYER: number;
  10912. static readonly STEP_BEFOREEVALUATEACTIVEMESH_BOUNDINGBOXRENDERER: number;
  10913. static readonly STEP_EVALUATESUBMESH_BOUNDINGBOXRENDERER: number;
  10914. static readonly STEP_ACTIVEMESH_BOUNDINGBOXRENDERER: number;
  10915. static readonly STEP_CAMERADRAWRENDERTARGET_EFFECTLAYER: number;
  10916. static readonly STEP_BEFORECAMERADRAW_EFFECTLAYER: number;
  10917. static readonly STEP_BEFORECAMERADRAW_LAYER: number;
  10918. static readonly STEP_BEFORECAMERADRAW_PREPASS: number;
  10919. static readonly STEP_BEFORERENDERTARGETDRAW_LAYER: number;
  10920. static readonly STEP_BEFORERENDERINGMESH_OUTLINE: number;
  10921. static readonly STEP_AFTERRENDERINGMESH_OUTLINE: number;
  10922. static readonly STEP_AFTERRENDERINGGROUPDRAW_EFFECTLAYER_DRAW: number;
  10923. static readonly STEP_AFTERRENDERINGGROUPDRAW_BOUNDINGBOXRENDERER: number;
  10924. static readonly STEP_BEFORECAMERAUPDATE_SIMPLIFICATIONQUEUE: number;
  10925. static readonly STEP_BEFORECAMERAUPDATE_GAMEPAD: number;
  10926. static readonly STEP_BEFORECLEAR_PROCEDURALTEXTURE: number;
  10927. static readonly STEP_AFTERRENDERTARGETDRAW_LAYER: number;
  10928. static readonly STEP_AFTERCAMERADRAW_EFFECTLAYER: number;
  10929. static readonly STEP_AFTERCAMERADRAW_LENSFLARESYSTEM: number;
  10930. static readonly STEP_AFTERCAMERADRAW_EFFECTLAYER_DRAW: number;
  10931. static readonly STEP_AFTERCAMERADRAW_LAYER: number;
  10932. static readonly STEP_AFTERCAMERADRAW_PREPASS: number;
  10933. static readonly STEP_AFTERRENDER_AUDIO: number;
  10934. static readonly STEP_GATHERRENDERTARGETS_DEPTHRENDERER: number;
  10935. static readonly STEP_GATHERRENDERTARGETS_GEOMETRYBUFFERRENDERER: number;
  10936. static readonly STEP_GATHERRENDERTARGETS_SHADOWGENERATOR: number;
  10937. static readonly STEP_GATHERRENDERTARGETS_POSTPROCESSRENDERPIPELINEMANAGER: number;
  10938. static readonly STEP_GATHERACTIVECAMERARENDERTARGETS_DEPTHRENDERER: number;
  10939. static readonly STEP_BEFORECLEARSTAGE_PREPASS: number;
  10940. static readonly STEP_POINTERMOVE_SPRITE: number;
  10941. static readonly STEP_POINTERDOWN_SPRITE: number;
  10942. static readonly STEP_POINTERUP_SPRITE: number;
  10943. }
  10944. /**
  10945. * This represents a scene component.
  10946. *
  10947. * This is used to decouple the dependency the scene is having on the different workloads like
  10948. * layers, post processes...
  10949. */
  10950. export interface ISceneComponent {
  10951. /**
  10952. * The name of the component. Each component must have a unique name.
  10953. */
  10954. name: string;
  10955. /**
  10956. * The scene the component belongs to.
  10957. */
  10958. scene: Scene;
  10959. /**
  10960. * Register the component to one instance of a scene.
  10961. */
  10962. register(): void;
  10963. /**
  10964. * Rebuilds the elements related to this component in case of
  10965. * context lost for instance.
  10966. */
  10967. rebuild(): void;
  10968. /**
  10969. * Disposes the component and the associated ressources.
  10970. */
  10971. dispose(): void;
  10972. }
  10973. /**
  10974. * This represents a SERIALIZABLE scene component.
  10975. *
  10976. * This extends Scene Component to add Serialization methods on top.
  10977. */
  10978. export interface ISceneSerializableComponent extends ISceneComponent {
  10979. /**
  10980. * Adds all the elements from the container to the scene
  10981. * @param container the container holding the elements
  10982. */
  10983. addFromContainer(container: AbstractScene): void;
  10984. /**
  10985. * Removes all the elements in the container from the scene
  10986. * @param container contains the elements to remove
  10987. * @param dispose if the removed element should be disposed (default: false)
  10988. */
  10989. removeFromContainer(container: AbstractScene, dispose?: boolean): void;
  10990. /**
  10991. * Serializes the component data to the specified json object
  10992. * @param serializationObject The object to serialize to
  10993. */
  10994. serialize(serializationObject: any): void;
  10995. }
  10996. /**
  10997. * Strong typing of a Mesh related stage step action
  10998. */
  10999. export type MeshStageAction = (mesh: AbstractMesh, hardwareInstancedRendering: boolean) => boolean;
  11000. /**
  11001. * Strong typing of a Evaluate Sub Mesh related stage step action
  11002. */
  11003. export type EvaluateSubMeshStageAction = (mesh: AbstractMesh, subMesh: SubMesh) => void;
  11004. /**
  11005. * Strong typing of a Active Mesh related stage step action
  11006. */
  11007. export type ActiveMeshStageAction = (sourceMesh: AbstractMesh, mesh: AbstractMesh) => void;
  11008. /**
  11009. * Strong typing of a Camera related stage step action
  11010. */
  11011. export type CameraStageAction = (camera: Camera) => void;
  11012. /**
  11013. * Strong typing of a Camera Frame buffer related stage step action
  11014. */
  11015. export type CameraStageFrameBufferAction = (camera: Camera) => boolean;
  11016. /**
  11017. * Strong typing of a Render Target related stage step action
  11018. */
  11019. export type RenderTargetStageAction = (renderTarget: RenderTargetTexture) => void;
  11020. /**
  11021. * Strong typing of a RenderingGroup related stage step action
  11022. */
  11023. export type RenderingGroupStageAction = (renderingGroupId: number) => void;
  11024. /**
  11025. * Strong typing of a Mesh Render related stage step action
  11026. */
  11027. export type RenderingMeshStageAction = (mesh: Mesh, subMesh: SubMesh, batch: _InstancesBatch) => void;
  11028. /**
  11029. * Strong typing of a simple stage step action
  11030. */
  11031. export type SimpleStageAction = () => void;
  11032. /**
  11033. * Strong typing of a render target action.
  11034. */
  11035. export type RenderTargetsStageAction = (renderTargets: SmartArrayNoDuplicate<RenderTargetTexture>) => void;
  11036. /**
  11037. * Strong typing of a pointer move action.
  11038. */
  11039. export type PointerMoveStageAction = (unTranslatedPointerX: number, unTranslatedPointerY: number, pickResult: Nullable<PickingInfo>, isMeshPicked: boolean, element: HTMLElement) => Nullable<PickingInfo>;
  11040. /**
  11041. * Strong typing of a pointer up/down action.
  11042. */
  11043. export type PointerUpDownStageAction = (unTranslatedPointerX: number, unTranslatedPointerY: number, pickResult: Nullable<PickingInfo>, evt: PointerEvent) => Nullable<PickingInfo>;
  11044. /**
  11045. * Representation of a stage in the scene (Basically a list of ordered steps)
  11046. * @hidden
  11047. */
  11048. export class Stage<T extends Function> extends Array<{
  11049. index: number;
  11050. component: ISceneComponent;
  11051. action: T;
  11052. }> {
  11053. /**
  11054. * Hide ctor from the rest of the world.
  11055. * @param items The items to add.
  11056. */
  11057. private constructor();
  11058. /**
  11059. * Creates a new Stage.
  11060. * @returns A new instance of a Stage
  11061. */
  11062. static Create<T extends Function>(): Stage<T>;
  11063. /**
  11064. * Registers a step in an ordered way in the targeted stage.
  11065. * @param index Defines the position to register the step in
  11066. * @param component Defines the component attached to the step
  11067. * @param action Defines the action to launch during the step
  11068. */
  11069. registerStep(index: number, component: ISceneComponent, action: T): void;
  11070. /**
  11071. * Clears all the steps from the stage.
  11072. */
  11073. clear(): void;
  11074. }
  11075. }
  11076. declare module "babylonjs/Sprites/spriteSceneComponent" {
  11077. import { Nullable } from "babylonjs/types";
  11078. import { Observable } from "babylonjs/Misc/observable";
  11079. import { Scene } from "babylonjs/scene";
  11080. import { Sprite } from "babylonjs/Sprites/sprite";
  11081. import { ISpriteManager } from "babylonjs/Sprites/spriteManager";
  11082. import { Ray } from "babylonjs/Culling/ray";
  11083. import { Camera } from "babylonjs/Cameras/camera";
  11084. import { PickingInfo } from "babylonjs/Collisions/pickingInfo";
  11085. import { ISceneComponent } from "babylonjs/sceneComponent";
  11086. module "babylonjs/scene" {
  11087. interface Scene {
  11088. /** @hidden */
  11089. _pointerOverSprite: Nullable<Sprite>;
  11090. /** @hidden */
  11091. _pickedDownSprite: Nullable<Sprite>;
  11092. /** @hidden */
  11093. _tempSpritePickingRay: Nullable<Ray>;
  11094. /**
  11095. * All of the sprite managers added to this scene
  11096. * @see https://doc.babylonjs.com/babylon101/sprites
  11097. */
  11098. spriteManagers: Array<ISpriteManager>;
  11099. /**
  11100. * An event triggered when sprites rendering is about to start
  11101. * Note: This event can be trigger more than once per frame (because sprites can be rendered by render target textures as well)
  11102. */
  11103. onBeforeSpritesRenderingObservable: Observable<Scene>;
  11104. /**
  11105. * An event triggered when sprites rendering is done
  11106. * Note: This event can be trigger more than once per frame (because sprites can be rendered by render target textures as well)
  11107. */
  11108. onAfterSpritesRenderingObservable: Observable<Scene>;
  11109. /** @hidden */
  11110. _internalPickSprites(ray: Ray, predicate?: (sprite: Sprite) => boolean, fastCheck?: boolean, camera?: Camera): Nullable<PickingInfo>;
  11111. /** Launch a ray to try to pick a sprite in the scene
  11112. * @param x position on screen
  11113. * @param y position on screen
  11114. * @param predicate Predicate function used to determine eligible sprites. Can be set to null. In this case, a sprite must have isPickable set to true
  11115. * @param fastCheck defines if the first intersection will be used (and not the closest)
  11116. * @param camera camera to use for computing the picking ray. Can be set to null. In this case, the scene.activeCamera will be used
  11117. * @returns a PickingInfo
  11118. */
  11119. pickSprite(x: number, y: number, predicate?: (sprite: Sprite) => boolean, fastCheck?: boolean, camera?: Camera): Nullable<PickingInfo>;
  11120. /** Use the given ray to pick a sprite in the scene
  11121. * @param ray The ray (in world space) to use to pick meshes
  11122. * @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
  11123. * @param fastCheck defines if the first intersection will be used (and not the closest)
  11124. * @param camera camera to use. Can be set to null. In this case, the scene.activeCamera will be used
  11125. * @returns a PickingInfo
  11126. */
  11127. pickSpriteWithRay(ray: Ray, predicate?: (sprite: Sprite) => boolean, fastCheck?: boolean, camera?: Camera): Nullable<PickingInfo>;
  11128. /** @hidden */
  11129. _internalMultiPickSprites(ray: Ray, predicate?: (sprite: Sprite) => boolean, camera?: Camera): Nullable<PickingInfo[]>;
  11130. /** Launch a ray to try to pick sprites in the scene
  11131. * @param x position on screen
  11132. * @param y position on screen
  11133. * @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
  11134. * @param camera camera to use for computing the picking ray. Can be set to null. In this case, the scene.activeCamera will be used
  11135. * @returns a PickingInfo array
  11136. */
  11137. multiPickSprite(x: number, y: number, predicate?: (sprite: Sprite) => boolean, camera?: Camera): Nullable<PickingInfo[]>;
  11138. /** Use the given ray to pick sprites in the scene
  11139. * @param ray The ray (in world space) to use to pick meshes
  11140. * @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
  11141. * @param camera camera to use. Can be set to null. In this case, the scene.activeCamera will be used
  11142. * @returns a PickingInfo array
  11143. */
  11144. multiPickSpriteWithRay(ray: Ray, predicate?: (sprite: Sprite) => boolean, camera?: Camera): Nullable<PickingInfo[]>;
  11145. /**
  11146. * Force the sprite under the pointer
  11147. * @param sprite defines the sprite to use
  11148. */
  11149. setPointerOverSprite(sprite: Nullable<Sprite>): void;
  11150. /**
  11151. * Gets the sprite under the pointer
  11152. * @returns a Sprite or null if no sprite is under the pointer
  11153. */
  11154. getPointerOverSprite(): Nullable<Sprite>;
  11155. }
  11156. }
  11157. /**
  11158. * Defines the sprite scene component responsible to manage sprites
  11159. * in a given scene.
  11160. */
  11161. export class SpriteSceneComponent implements ISceneComponent {
  11162. /**
  11163. * The component name helpfull to identify the component in the list of scene components.
  11164. */
  11165. readonly name: string;
  11166. /**
  11167. * The scene the component belongs to.
  11168. */
  11169. scene: Scene;
  11170. /** @hidden */
  11171. private _spritePredicate;
  11172. /**
  11173. * Creates a new instance of the component for the given scene
  11174. * @param scene Defines the scene to register the component in
  11175. */
  11176. constructor(scene: Scene);
  11177. /**
  11178. * Registers the component in a given scene
  11179. */
  11180. register(): void;
  11181. /**
  11182. * Rebuilds the elements related to this component in case of
  11183. * context lost for instance.
  11184. */
  11185. rebuild(): void;
  11186. /**
  11187. * Disposes the component and the associated ressources.
  11188. */
  11189. dispose(): void;
  11190. private _pickSpriteButKeepRay;
  11191. private _pointerMove;
  11192. private _pointerDown;
  11193. private _pointerUp;
  11194. }
  11195. }
  11196. declare module "babylonjs/Shaders/ShadersInclude/fogFragmentDeclaration" {
  11197. /** @hidden */
  11198. export var fogFragmentDeclaration: {
  11199. name: string;
  11200. shader: string;
  11201. };
  11202. }
  11203. declare module "babylonjs/Shaders/ShadersInclude/fogFragment" {
  11204. /** @hidden */
  11205. export var fogFragment: {
  11206. name: string;
  11207. shader: string;
  11208. };
  11209. }
  11210. declare module "babylonjs/Shaders/ShadersInclude/imageProcessingCompatibility" {
  11211. /** @hidden */
  11212. export var imageProcessingCompatibility: {
  11213. name: string;
  11214. shader: string;
  11215. };
  11216. }
  11217. declare module "babylonjs/Shaders/sprites.fragment" {
  11218. import "babylonjs/Shaders/ShadersInclude/fogFragmentDeclaration";
  11219. import "babylonjs/Shaders/ShadersInclude/fogFragment";
  11220. import "babylonjs/Shaders/ShadersInclude/imageProcessingCompatibility";
  11221. /** @hidden */
  11222. export var spritesPixelShader: {
  11223. name: string;
  11224. shader: string;
  11225. };
  11226. }
  11227. declare module "babylonjs/Shaders/ShadersInclude/fogVertexDeclaration" {
  11228. /** @hidden */
  11229. export var fogVertexDeclaration: {
  11230. name: string;
  11231. shader: string;
  11232. };
  11233. }
  11234. declare module "babylonjs/Shaders/sprites.vertex" {
  11235. import "babylonjs/Shaders/ShadersInclude/fogVertexDeclaration";
  11236. /** @hidden */
  11237. export var spritesVertexShader: {
  11238. name: string;
  11239. shader: string;
  11240. };
  11241. }
  11242. declare module "babylonjs/Sprites/spriteManager" {
  11243. import { IDisposable, Scene } from "babylonjs/scene";
  11244. import { Nullable } from "babylonjs/types";
  11245. import { Observable } from "babylonjs/Misc/observable";
  11246. import { Sprite } from "babylonjs/Sprites/sprite";
  11247. import { PickingInfo } from "babylonjs/Collisions/pickingInfo";
  11248. import { Camera } from "babylonjs/Cameras/camera";
  11249. import { Texture } from "babylonjs/Materials/Textures/texture";
  11250. import "babylonjs/Shaders/sprites.fragment";
  11251. import "babylonjs/Shaders/sprites.vertex";
  11252. import { Ray } from "babylonjs/Culling/ray";
  11253. /**
  11254. * Defines the minimum interface to fullfil in order to be a sprite manager.
  11255. */
  11256. export interface ISpriteManager extends IDisposable {
  11257. /**
  11258. * Gets manager's name
  11259. */
  11260. name: string;
  11261. /**
  11262. * Restricts the camera to viewing objects with the same layerMask.
  11263. * A camera with a layerMask of 1 will render spriteManager.layerMask & camera.layerMask!== 0
  11264. */
  11265. layerMask: number;
  11266. /**
  11267. * Gets or sets a boolean indicating if the mesh can be picked (by scene.pick for instance or through actions). Default is true
  11268. */
  11269. isPickable: boolean;
  11270. /**
  11271. * Gets the hosting scene
  11272. */
  11273. scene: Scene;
  11274. /**
  11275. * Specifies the rendering group id for this mesh (0 by default)
  11276. * @see https://doc.babylonjs.com/resources/transparency_and_how_meshes_are_rendered#rendering-groups
  11277. */
  11278. renderingGroupId: number;
  11279. /**
  11280. * Defines the list of sprites managed by the manager.
  11281. */
  11282. sprites: Array<Sprite>;
  11283. /**
  11284. * Gets or sets the spritesheet texture
  11285. */
  11286. texture: Texture;
  11287. /** Defines the default width of a cell in the spritesheet */
  11288. cellWidth: number;
  11289. /** Defines the default height of a cell in the spritesheet */
  11290. cellHeight: number;
  11291. /**
  11292. * Tests the intersection of a sprite with a specific ray.
  11293. * @param ray The ray we are sending to test the collision
  11294. * @param camera The camera space we are sending rays in
  11295. * @param predicate A predicate allowing excluding sprites from the list of object to test
  11296. * @param fastCheck defines if the first intersection will be used (and not the closest)
  11297. * @returns picking info or null.
  11298. */
  11299. intersects(ray: Ray, camera: Camera, predicate?: (sprite: Sprite) => boolean, fastCheck?: boolean): Nullable<PickingInfo>;
  11300. /**
  11301. * Intersects the sprites with a ray
  11302. * @param ray defines the ray to intersect with
  11303. * @param camera defines the current active camera
  11304. * @param predicate defines a predicate used to select candidate sprites
  11305. * @returns null if no hit or a PickingInfo array
  11306. */
  11307. multiIntersects(ray: Ray, camera: Camera, predicate?: (sprite: Sprite) => boolean): Nullable<PickingInfo[]>;
  11308. /**
  11309. * Renders the list of sprites on screen.
  11310. */
  11311. render(): void;
  11312. }
  11313. /**
  11314. * Class used to manage multiple sprites on the same spritesheet
  11315. * @see https://doc.babylonjs.com/babylon101/sprites
  11316. */
  11317. export class SpriteManager implements ISpriteManager {
  11318. /** defines the manager's name */
  11319. name: string;
  11320. /** Define the Url to load snippets */
  11321. static SnippetUrl: string;
  11322. /** Snippet ID if the manager was created from the snippet server */
  11323. snippetId: string;
  11324. /** Gets the list of sprites */
  11325. sprites: Sprite[];
  11326. /** Gets or sets the rendering group id (0 by default) */
  11327. renderingGroupId: number;
  11328. /** Gets or sets camera layer mask */
  11329. layerMask: number;
  11330. /** Gets or sets a boolean indicating if the manager must consider scene fog when rendering */
  11331. fogEnabled: boolean;
  11332. /** Gets or sets a boolean indicating if the sprites are pickable */
  11333. isPickable: boolean;
  11334. /** Defines the default width of a cell in the spritesheet */
  11335. cellWidth: number;
  11336. /** Defines the default height of a cell in the spritesheet */
  11337. cellHeight: number;
  11338. /** Associative array from JSON sprite data file */
  11339. private _cellData;
  11340. /** Array of sprite names from JSON sprite data file */
  11341. private _spriteMap;
  11342. /** True when packed cell data from JSON file is ready*/
  11343. private _packedAndReady;
  11344. private _textureContent;
  11345. private _useInstancing;
  11346. /**
  11347. * An event triggered when the manager is disposed.
  11348. */
  11349. onDisposeObservable: Observable<SpriteManager>;
  11350. private _onDisposeObserver;
  11351. /**
  11352. * Callback called when the manager is disposed
  11353. */
  11354. set onDispose(callback: () => void);
  11355. private _capacity;
  11356. private _fromPacked;
  11357. private _spriteTexture;
  11358. private _epsilon;
  11359. private _scene;
  11360. private _vertexData;
  11361. private _buffer;
  11362. private _vertexBuffers;
  11363. private _spriteBuffer;
  11364. private _indexBuffer;
  11365. private _effectBase;
  11366. private _effectFog;
  11367. private _vertexBufferSize;
  11368. /**
  11369. * Gets or sets the unique id of the sprite
  11370. */
  11371. uniqueId: number;
  11372. /**
  11373. * Gets the array of sprites
  11374. */
  11375. get children(): Sprite[];
  11376. /**
  11377. * Gets the hosting scene
  11378. */
  11379. get scene(): Scene;
  11380. /**
  11381. * Gets the capacity of the manager
  11382. */
  11383. get capacity(): number;
  11384. /**
  11385. * Gets or sets the spritesheet texture
  11386. */
  11387. get texture(): Texture;
  11388. set texture(value: Texture);
  11389. private _blendMode;
  11390. /**
  11391. * Blend mode use to render the particle, it can be any of
  11392. * the static Constants.ALPHA_x properties provided in this class.
  11393. * Default value is Constants.ALPHA_COMBINE
  11394. */
  11395. get blendMode(): number;
  11396. set blendMode(blendMode: number);
  11397. /** Disables writing to the depth buffer when rendering the sprites.
  11398. * It can be handy to disable depth writing when using textures without alpha channel
  11399. * and setting some specific blend modes.
  11400. */
  11401. disableDepthWrite: boolean;
  11402. /**
  11403. * Creates a new sprite manager
  11404. * @param name defines the manager's name
  11405. * @param imgUrl defines the sprite sheet url
  11406. * @param capacity defines the maximum allowed number of sprites
  11407. * @param cellSize defines the size of a sprite cell
  11408. * @param scene defines the hosting scene
  11409. * @param epsilon defines the epsilon value to align texture (0.01 by default)
  11410. * @param samplingMode defines the smapling mode to use with spritesheet
  11411. * @param fromPacked set to false; do not alter
  11412. * @param spriteJSON null otherwise a JSON object defining sprite sheet data; do not alter
  11413. */
  11414. constructor(
  11415. /** defines the manager's name */
  11416. name: string, imgUrl: string, capacity: number, cellSize: any, scene: Scene, epsilon?: number, samplingMode?: number, fromPacked?: boolean, spriteJSON?: any | null);
  11417. /**
  11418. * Returns the string "SpriteManager"
  11419. * @returns "SpriteManager"
  11420. */
  11421. getClassName(): string;
  11422. private _makePacked;
  11423. private _appendSpriteVertex;
  11424. private _checkTextureAlpha;
  11425. /**
  11426. * Intersects the sprites with a ray
  11427. * @param ray defines the ray to intersect with
  11428. * @param camera defines the current active camera
  11429. * @param predicate defines a predicate used to select candidate sprites
  11430. * @param fastCheck defines if a fast check only must be done (the first potential sprite is will be used and not the closer)
  11431. * @returns null if no hit or a PickingInfo
  11432. */
  11433. intersects(ray: Ray, camera: Camera, predicate?: (sprite: Sprite) => boolean, fastCheck?: boolean): Nullable<PickingInfo>;
  11434. /**
  11435. * Intersects the sprites with a ray
  11436. * @param ray defines the ray to intersect with
  11437. * @param camera defines the current active camera
  11438. * @param predicate defines a predicate used to select candidate sprites
  11439. * @returns null if no hit or a PickingInfo array
  11440. */
  11441. multiIntersects(ray: Ray, camera: Camera, predicate?: (sprite: Sprite) => boolean): Nullable<PickingInfo[]>;
  11442. /**
  11443. * Render all child sprites
  11444. */
  11445. render(): void;
  11446. /**
  11447. * Release associated resources
  11448. */
  11449. dispose(): void;
  11450. /**
  11451. * Serializes the sprite manager to a JSON object
  11452. * @param serializeTexture defines if the texture must be serialized as well
  11453. * @returns the JSON object
  11454. */
  11455. serialize(serializeTexture?: boolean): any;
  11456. /**
  11457. * Parses a JSON object to create a new sprite manager.
  11458. * @param parsedManager The JSON object to parse
  11459. * @param scene The scene to create the sprite managerin
  11460. * @param rootUrl The root url to use to load external dependencies like texture
  11461. * @returns the new sprite manager
  11462. */
  11463. static Parse(parsedManager: any, scene: Scene, rootUrl: string): SpriteManager;
  11464. /**
  11465. * Creates a sprite manager from a snippet saved in a remote file
  11466. * @param name defines the name of the sprite manager to create (can be null or empty to use the one from the json data)
  11467. * @param url defines the url to load from
  11468. * @param scene defines the hosting scene
  11469. * @param rootUrl defines the root URL to use to load textures and relative dependencies
  11470. * @returns a promise that will resolve to the new sprite manager
  11471. */
  11472. static ParseFromFileAsync(name: Nullable<string>, url: string, scene: Scene, rootUrl?: string): Promise<SpriteManager>;
  11473. /**
  11474. * Creates a sprite manager from a snippet saved by the sprite editor
  11475. * @param snippetId defines the snippet to load (can be set to _BLANK to create a default one)
  11476. * @param scene defines the hosting scene
  11477. * @param rootUrl defines the root URL to use to load textures and relative dependencies
  11478. * @returns a promise that will resolve to the new sprite manager
  11479. */
  11480. static CreateFromSnippetAsync(snippetId: string, scene: Scene, rootUrl?: string): Promise<SpriteManager>;
  11481. }
  11482. }
  11483. declare module "babylonjs/Misc/gradients" {
  11484. import { Color3, Color4 } from "babylonjs/Maths/math.color";
  11485. /** Interface used by value gradients (color, factor, ...) */
  11486. export interface IValueGradient {
  11487. /**
  11488. * Gets or sets the gradient value (between 0 and 1)
  11489. */
  11490. gradient: number;
  11491. }
  11492. /** Class used to store color4 gradient */
  11493. export class ColorGradient implements IValueGradient {
  11494. /**
  11495. * Gets or sets the gradient value (between 0 and 1)
  11496. */
  11497. gradient: number;
  11498. /**
  11499. * Gets or sets first associated color
  11500. */
  11501. color1: Color4;
  11502. /**
  11503. * Gets or sets second associated color
  11504. */
  11505. color2?: Color4 | undefined;
  11506. /**
  11507. * Creates a new color4 gradient
  11508. * @param gradient gets or sets the gradient value (between 0 and 1)
  11509. * @param color1 gets or sets first associated color
  11510. * @param color2 gets or sets first second color
  11511. */
  11512. constructor(
  11513. /**
  11514. * Gets or sets the gradient value (between 0 and 1)
  11515. */
  11516. gradient: number,
  11517. /**
  11518. * Gets or sets first associated color
  11519. */
  11520. color1: Color4,
  11521. /**
  11522. * Gets or sets second associated color
  11523. */
  11524. color2?: Color4 | undefined);
  11525. /**
  11526. * Will get a color picked randomly between color1 and color2.
  11527. * If color2 is undefined then color1 will be used
  11528. * @param result defines the target Color4 to store the result in
  11529. */
  11530. getColorToRef(result: Color4): void;
  11531. }
  11532. /** Class used to store color 3 gradient */
  11533. export class Color3Gradient implements IValueGradient {
  11534. /**
  11535. * Gets or sets the gradient value (between 0 and 1)
  11536. */
  11537. gradient: number;
  11538. /**
  11539. * Gets or sets the associated color
  11540. */
  11541. color: Color3;
  11542. /**
  11543. * Creates a new color3 gradient
  11544. * @param gradient gets or sets the gradient value (between 0 and 1)
  11545. * @param color gets or sets associated color
  11546. */
  11547. constructor(
  11548. /**
  11549. * Gets or sets the gradient value (between 0 and 1)
  11550. */
  11551. gradient: number,
  11552. /**
  11553. * Gets or sets the associated color
  11554. */
  11555. color: Color3);
  11556. }
  11557. /** Class used to store factor gradient */
  11558. export class FactorGradient implements IValueGradient {
  11559. /**
  11560. * Gets or sets the gradient value (between 0 and 1)
  11561. */
  11562. gradient: number;
  11563. /**
  11564. * Gets or sets first associated factor
  11565. */
  11566. factor1: number;
  11567. /**
  11568. * Gets or sets second associated factor
  11569. */
  11570. factor2?: number | undefined;
  11571. /**
  11572. * Creates a new factor gradient
  11573. * @param gradient gets or sets the gradient value (between 0 and 1)
  11574. * @param factor1 gets or sets first associated factor
  11575. * @param factor2 gets or sets second associated factor
  11576. */
  11577. constructor(
  11578. /**
  11579. * Gets or sets the gradient value (between 0 and 1)
  11580. */
  11581. gradient: number,
  11582. /**
  11583. * Gets or sets first associated factor
  11584. */
  11585. factor1: number,
  11586. /**
  11587. * Gets or sets second associated factor
  11588. */
  11589. factor2?: number | undefined);
  11590. /**
  11591. * Will get a number picked randomly between factor1 and factor2.
  11592. * If factor2 is undefined then factor1 will be used
  11593. * @returns the picked number
  11594. */
  11595. getFactor(): number;
  11596. }
  11597. /**
  11598. * Helper used to simplify some generic gradient tasks
  11599. */
  11600. export class GradientHelper {
  11601. /**
  11602. * Gets the current gradient from an array of IValueGradient
  11603. * @param ratio defines the current ratio to get
  11604. * @param gradients defines the array of IValueGradient
  11605. * @param updateFunc defines the callback function used to get the final value from the selected gradients
  11606. */
  11607. static GetCurrentGradient(ratio: number, gradients: IValueGradient[], updateFunc: (current: IValueGradient, next: IValueGradient, scale: number) => void): void;
  11608. }
  11609. }
  11610. declare module "babylonjs/Engines/Extensions/engine.rawTexture" {
  11611. import { Nullable } from "babylonjs/types";
  11612. import { InternalTexture } from "babylonjs/Materials/Textures/internalTexture";
  11613. import { Scene } from "babylonjs/scene";
  11614. module "babylonjs/Engines/thinEngine" {
  11615. interface ThinEngine {
  11616. /**
  11617. * Creates a raw texture
  11618. * @param data defines the data to store in the texture
  11619. * @param width defines the width of the texture
  11620. * @param height defines the height of the texture
  11621. * @param format defines the format of the data
  11622. * @param generateMipMaps defines if the engine should generate the mip levels
  11623. * @param invertY defines if data must be stored with Y axis inverted
  11624. * @param samplingMode defines the required sampling mode (Texture.NEAREST_SAMPLINGMODE by default)
  11625. * @param compression defines the compression used (null by default)
  11626. * @param type defines the type fo the data (Engine.TEXTURETYPE_UNSIGNED_INT by default)
  11627. * @returns the raw texture inside an InternalTexture
  11628. */
  11629. createRawTexture(data: Nullable<ArrayBufferView>, width: number, height: number, format: number, generateMipMaps: boolean, invertY: boolean, samplingMode: number, compression: Nullable<string>, type: number): InternalTexture;
  11630. /**
  11631. * Update a raw texture
  11632. * @param texture defines the texture to update
  11633. * @param data defines the data to store in the texture
  11634. * @param format defines the format of the data
  11635. * @param invertY defines if data must be stored with Y axis inverted
  11636. */
  11637. updateRawTexture(texture: Nullable<InternalTexture>, data: Nullable<ArrayBufferView>, format: number, invertY: boolean): void;
  11638. /**
  11639. * Update a raw texture
  11640. * @param texture defines the texture to update
  11641. * @param data defines the data to store in the texture
  11642. * @param format defines the format of the data
  11643. * @param invertY defines if data must be stored with Y axis inverted
  11644. * @param compression defines the compression used (null by default)
  11645. * @param type defines the type fo the data (Engine.TEXTURETYPE_UNSIGNED_INT by default)
  11646. */
  11647. updateRawTexture(texture: Nullable<InternalTexture>, data: Nullable<ArrayBufferView>, format: number, invertY: boolean, compression: Nullable<string>, type: number): void;
  11648. /**
  11649. * Creates a new raw cube texture
  11650. * @param data defines the array of data to use to create each face
  11651. * @param size defines the size of the textures
  11652. * @param format defines the format of the data
  11653. * @param type defines the type of the data (like Engine.TEXTURETYPE_UNSIGNED_INT)
  11654. * @param generateMipMaps defines if the engine should generate the mip levels
  11655. * @param invertY defines if data must be stored with Y axis inverted
  11656. * @param samplingMode defines the required sampling mode (like Texture.NEAREST_SAMPLINGMODE)
  11657. * @param compression defines the compression used (null by default)
  11658. * @returns the cube texture as an InternalTexture
  11659. */
  11660. createRawCubeTexture(data: Nullable<ArrayBufferView[]>, size: number, format: number, type: number, generateMipMaps: boolean, invertY: boolean, samplingMode: number, compression: Nullable<string>): InternalTexture;
  11661. /**
  11662. * Update a raw cube texture
  11663. * @param texture defines the texture to udpdate
  11664. * @param data defines the data to store
  11665. * @param format defines the data format
  11666. * @param type defines the type fo the data (Engine.TEXTURETYPE_UNSIGNED_INT by default)
  11667. * @param invertY defines if data must be stored with Y axis inverted
  11668. */
  11669. updateRawCubeTexture(texture: InternalTexture, data: ArrayBufferView[], format: number, type: number, invertY: boolean): void;
  11670. /**
  11671. * Update a raw cube texture
  11672. * @param texture defines the texture to udpdate
  11673. * @param data defines the data to store
  11674. * @param format defines the data format
  11675. * @param type defines the type fo the data (Engine.TEXTURETYPE_UNSIGNED_INT by default)
  11676. * @param invertY defines if data must be stored with Y axis inverted
  11677. * @param compression defines the compression used (null by default)
  11678. */
  11679. updateRawCubeTexture(texture: InternalTexture, data: ArrayBufferView[], format: number, type: number, invertY: boolean, compression: Nullable<string>): void;
  11680. /**
  11681. * Update a raw cube texture
  11682. * @param texture defines the texture to udpdate
  11683. * @param data defines the data to store
  11684. * @param format defines the data format
  11685. * @param type defines the type fo the data (Engine.TEXTURETYPE_UNSIGNED_INT by default)
  11686. * @param invertY defines if data must be stored with Y axis inverted
  11687. * @param compression defines the compression used (null by default)
  11688. * @param level defines which level of the texture to update
  11689. */
  11690. updateRawCubeTexture(texture: InternalTexture, data: ArrayBufferView[], format: number, type: number, invertY: boolean, compression: Nullable<string>, level: number): void;
  11691. /**
  11692. * Creates a new raw cube texture from a specified url
  11693. * @param url defines the url where the data is located
  11694. * @param scene defines the current scene
  11695. * @param size defines the size of the textures
  11696. * @param format defines the format of the data
  11697. * @param type defines the type fo the data (like Engine.TEXTURETYPE_UNSIGNED_INT)
  11698. * @param noMipmap defines if the engine should avoid generating the mip levels
  11699. * @param callback defines a callback used to extract texture data from loaded data
  11700. * @param mipmapGenerator defines to provide an optional tool to generate mip levels
  11701. * @param onLoad defines a callback called when texture is loaded
  11702. * @param onError defines a callback called if there is an error
  11703. * @returns the cube texture as an InternalTexture
  11704. */
  11705. 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;
  11706. /**
  11707. * Creates a new raw cube texture from a specified url
  11708. * @param url defines the url where the data is located
  11709. * @param scene defines the current scene
  11710. * @param size defines the size of the textures
  11711. * @param format defines the format of the data
  11712. * @param type defines the type fo the data (like Engine.TEXTURETYPE_UNSIGNED_INT)
  11713. * @param noMipmap defines if the engine should avoid generating the mip levels
  11714. * @param callback defines a callback used to extract texture data from loaded data
  11715. * @param mipmapGenerator defines to provide an optional tool to generate mip levels
  11716. * @param onLoad defines a callback called when texture is loaded
  11717. * @param onError defines a callback called if there is an error
  11718. * @param samplingMode defines the required sampling mode (like Texture.NEAREST_SAMPLINGMODE)
  11719. * @param invertY defines if data must be stored with Y axis inverted
  11720. * @returns the cube texture as an InternalTexture
  11721. */
  11722. 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;
  11723. /**
  11724. * Creates a new raw 3D texture
  11725. * @param data defines the data used to create the texture
  11726. * @param width defines the width of the texture
  11727. * @param height defines the height of the texture
  11728. * @param depth defines the depth of the texture
  11729. * @param format defines the format of the texture
  11730. * @param generateMipMaps defines if the engine must generate mip levels
  11731. * @param invertY defines if data must be stored with Y axis inverted
  11732. * @param samplingMode defines the required sampling mode (like Texture.NEAREST_SAMPLINGMODE)
  11733. * @param compression defines the compressed used (can be null)
  11734. * @param textureType defines the compressed used (can be null)
  11735. * @returns a new raw 3D texture (stored in an InternalTexture)
  11736. */
  11737. createRawTexture3D(data: Nullable<ArrayBufferView>, width: number, height: number, depth: number, format: number, generateMipMaps: boolean, invertY: boolean, samplingMode: number, compression: Nullable<string>, textureType: number): InternalTexture;
  11738. /**
  11739. * Update a raw 3D texture
  11740. * @param texture defines the texture to update
  11741. * @param data defines the data to store
  11742. * @param format defines the data format
  11743. * @param invertY defines if data must be stored with Y axis inverted
  11744. */
  11745. updateRawTexture3D(texture: InternalTexture, data: Nullable<ArrayBufferView>, format: number, invertY: boolean): void;
  11746. /**
  11747. * Update a raw 3D texture
  11748. * @param texture defines the texture to update
  11749. * @param data defines the data to store
  11750. * @param format defines the data format
  11751. * @param invertY defines if data must be stored with Y axis inverted
  11752. * @param compression defines the used compression (can be null)
  11753. * @param textureType defines the texture Type (Engine.TEXTURETYPE_UNSIGNED_INT, Engine.TEXTURETYPE_FLOAT...)
  11754. */
  11755. updateRawTexture3D(texture: InternalTexture, data: Nullable<ArrayBufferView>, format: number, invertY: boolean, compression: Nullable<string>, textureType: number): void;
  11756. /**
  11757. * Creates a new raw 2D array texture
  11758. * @param data defines the data used to create the texture
  11759. * @param width defines the width of the texture
  11760. * @param height defines the height of the texture
  11761. * @param depth defines the number of layers of the texture
  11762. * @param format defines the format of the texture
  11763. * @param generateMipMaps defines if the engine must generate mip levels
  11764. * @param invertY defines if data must be stored with Y axis inverted
  11765. * @param samplingMode defines the required sampling mode (like Texture.NEAREST_SAMPLINGMODE)
  11766. * @param compression defines the compressed used (can be null)
  11767. * @param textureType defines the compressed used (can be null)
  11768. * @returns a new raw 2D array texture (stored in an InternalTexture)
  11769. */
  11770. createRawTexture2DArray(data: Nullable<ArrayBufferView>, width: number, height: number, depth: number, format: number, generateMipMaps: boolean, invertY: boolean, samplingMode: number, compression: Nullable<string>, textureType: number): InternalTexture;
  11771. /**
  11772. * Update a raw 2D array texture
  11773. * @param texture defines the texture to update
  11774. * @param data defines the data to store
  11775. * @param format defines the data format
  11776. * @param invertY defines if data must be stored with Y axis inverted
  11777. */
  11778. updateRawTexture2DArray(texture: InternalTexture, data: Nullable<ArrayBufferView>, format: number, invertY: boolean): void;
  11779. /**
  11780. * Update a raw 2D array texture
  11781. * @param texture defines the texture to update
  11782. * @param data defines the data to store
  11783. * @param format defines the data format
  11784. * @param invertY defines if data must be stored with Y axis inverted
  11785. * @param compression defines the used compression (can be null)
  11786. * @param textureType defines the texture Type (Engine.TEXTURETYPE_UNSIGNED_INT, Engine.TEXTURETYPE_FLOAT...)
  11787. */
  11788. updateRawTexture2DArray(texture: InternalTexture, data: Nullable<ArrayBufferView>, format: number, invertY: boolean, compression: Nullable<string>, textureType: number): void;
  11789. }
  11790. }
  11791. }
  11792. declare module "babylonjs/Materials/Textures/rawTexture" {
  11793. import { Texture } from "babylonjs/Materials/Textures/texture";
  11794. import "babylonjs/Engines/Extensions/engine.rawTexture";
  11795. import { Nullable } from "babylonjs/types";
  11796. import { ThinEngine } from "babylonjs/Engines/thinEngine";
  11797. import { Scene } from "babylonjs/scene";
  11798. /**
  11799. * Raw texture can help creating a texture directly from an array of data.
  11800. * This can be super useful if you either get the data from an uncompressed source or
  11801. * if you wish to create your texture pixel by pixel.
  11802. */
  11803. export class RawTexture extends Texture {
  11804. /**
  11805. * Define the format of the data (RGB, RGBA... Engine.TEXTUREFORMAT_xxx)
  11806. */
  11807. format: number;
  11808. /**
  11809. * Instantiates a new RawTexture.
  11810. * Raw texture can help creating a texture directly from an array of data.
  11811. * This can be super useful if you either get the data from an uncompressed source or
  11812. * if you wish to create your texture pixel by pixel.
  11813. * @param data define the array of data to use to create the texture
  11814. * @param width define the width of the texture
  11815. * @param height define the height of the texture
  11816. * @param format define the format of the data (RGB, RGBA... Engine.TEXTUREFORMAT_xxx)
  11817. * @param sceneOrEngine defines the scene or engine the texture will belong to
  11818. * @param generateMipMaps define whether mip maps should be generated or not
  11819. * @param invertY define if the data should be flipped on Y when uploaded to the GPU
  11820. * @param samplingMode define the texture sampling mode (Texture.xxx_SAMPLINGMODE)
  11821. * @param type define the format of the data (int, float... Engine.TEXTURETYPE_xxx)
  11822. */
  11823. constructor(data: ArrayBufferView, width: number, height: number,
  11824. /**
  11825. * Define the format of the data (RGB, RGBA... Engine.TEXTUREFORMAT_xxx)
  11826. */
  11827. format: number, sceneOrEngine: Nullable<Scene | ThinEngine>, generateMipMaps?: boolean, invertY?: boolean, samplingMode?: number, type?: number);
  11828. /**
  11829. * Updates the texture underlying data.
  11830. * @param data Define the new data of the texture
  11831. */
  11832. update(data: ArrayBufferView): void;
  11833. /**
  11834. * Creates a luminance texture from some data.
  11835. * @param data Define the texture data
  11836. * @param width Define the width of the texture
  11837. * @param height Define the height of the texture
  11838. * @param sceneOrEngine defines the scene or engine the texture will belong to
  11839. * @param generateMipMaps Define whether or not to create mip maps for the texture
  11840. * @param invertY define if the data should be flipped on Y when uploaded to the GPU
  11841. * @param samplingMode define the texture sampling mode (Texture.xxx_SAMPLINGMODE)
  11842. * @returns the luminance texture
  11843. */
  11844. static CreateLuminanceTexture(data: ArrayBufferView, width: number, height: number, sceneOrEngine: Nullable<Scene | ThinEngine>, generateMipMaps?: boolean, invertY?: boolean, samplingMode?: number): RawTexture;
  11845. /**
  11846. * Creates a luminance alpha texture from some data.
  11847. * @param data Define the texture data
  11848. * @param width Define the width of the texture
  11849. * @param height Define the height of the texture
  11850. * @param sceneOrEngine defines the scene or engine the texture will belong to
  11851. * @param generateMipMaps Define whether or not to create mip maps for the texture
  11852. * @param invertY define if the data should be flipped on Y when uploaded to the GPU
  11853. * @param samplingMode define the texture sampling mode (Texture.xxx_SAMPLINGMODE)
  11854. * @returns the luminance alpha texture
  11855. */
  11856. static CreateLuminanceAlphaTexture(data: ArrayBufferView, width: number, height: number, sceneOrEngine: Nullable<Scene | ThinEngine>, generateMipMaps?: boolean, invertY?: boolean, samplingMode?: number): RawTexture;
  11857. /**
  11858. * Creates an alpha texture from some data.
  11859. * @param data Define the texture data
  11860. * @param width Define the width of the texture
  11861. * @param height Define the height of the texture
  11862. * @param sceneOrEngine defines the scene or engine the texture will belong to
  11863. * @param generateMipMaps Define whether or not to create mip maps for the texture
  11864. * @param invertY define if the data should be flipped on Y when uploaded to the GPU
  11865. * @param samplingMode define the texture sampling mode (Texture.xxx_SAMPLINGMODE)
  11866. * @returns the alpha texture
  11867. */
  11868. static CreateAlphaTexture(data: ArrayBufferView, width: number, height: number, sceneOrEngine: Nullable<Scene | ThinEngine>, generateMipMaps?: boolean, invertY?: boolean, samplingMode?: number): RawTexture;
  11869. /**
  11870. * Creates a RGB texture from some data.
  11871. * @param data Define the texture data
  11872. * @param width Define the width of the texture
  11873. * @param height Define the height of the texture
  11874. * @param sceneOrEngine defines the scene or engine the texture will belong to
  11875. * @param generateMipMaps Define whether or not to create mip maps for the texture
  11876. * @param invertY define if the data should be flipped on Y when uploaded to the GPU
  11877. * @param samplingMode define the texture sampling mode (Texture.xxx_SAMPLINGMODE)
  11878. * @param type define the format of the data (int, float... Engine.TEXTURETYPE_xxx)
  11879. * @returns the RGB alpha texture
  11880. */
  11881. static CreateRGBTexture(data: ArrayBufferView, width: number, height: number, sceneOrEngine: Nullable<Scene | ThinEngine>, generateMipMaps?: boolean, invertY?: boolean, samplingMode?: number, type?: number): RawTexture;
  11882. /**
  11883. * Creates a RGBA texture from some data.
  11884. * @param data Define the texture data
  11885. * @param width Define the width of the texture
  11886. * @param height Define the height of the texture
  11887. * @param sceneOrEngine defines the scene or engine the texture will belong to
  11888. * @param generateMipMaps Define whether or not to create mip maps for the texture
  11889. * @param invertY define if the data should be flipped on Y when uploaded to the GPU
  11890. * @param samplingMode define the texture sampling mode (Texture.xxx_SAMPLINGMODE)
  11891. * @param type define the format of the data (int, float... Engine.TEXTURETYPE_xxx)
  11892. * @returns the RGBA texture
  11893. */
  11894. static CreateRGBATexture(data: ArrayBufferView, width: number, height: number, sceneOrEngine: Nullable<Scene | ThinEngine>, generateMipMaps?: boolean, invertY?: boolean, samplingMode?: number, type?: number): RawTexture;
  11895. /**
  11896. * Creates a R texture from some data.
  11897. * @param data Define the texture data
  11898. * @param width Define the width of the texture
  11899. * @param height Define the height of the texture
  11900. * @param sceneOrEngine defines the scene or engine the texture will belong to
  11901. * @param generateMipMaps Define whether or not to create mip maps for the texture
  11902. * @param invertY define if the data should be flipped on Y when uploaded to the GPU
  11903. * @param samplingMode define the texture sampling mode (Texture.xxx_SAMPLINGMODE)
  11904. * @param type define the format of the data (int, float... Engine.TEXTURETYPE_xxx)
  11905. * @returns the R texture
  11906. */
  11907. static CreateRTexture(data: ArrayBufferView, width: number, height: number, sceneOrEngine: Nullable<Scene | ThinEngine>, generateMipMaps?: boolean, invertY?: boolean, samplingMode?: number, type?: number): RawTexture;
  11908. }
  11909. }
  11910. declare module "babylonjs/Engines/Extensions/engine.dynamicBuffer" {
  11911. import { DataBuffer } from "babylonjs/Meshes/dataBuffer";
  11912. import { IndicesArray, DataArray } from "babylonjs/types";
  11913. module "babylonjs/Engines/thinEngine" {
  11914. interface ThinEngine {
  11915. /**
  11916. * Update a dynamic index buffer
  11917. * @param indexBuffer defines the target index buffer
  11918. * @param indices defines the data to update
  11919. * @param offset defines the offset in the target index buffer where update should start
  11920. */
  11921. updateDynamicIndexBuffer(indexBuffer: DataBuffer, indices: IndicesArray, offset?: number): void;
  11922. /**
  11923. * Updates a dynamic vertex buffer.
  11924. * @param vertexBuffer the vertex buffer to update
  11925. * @param data the data used to update the vertex buffer
  11926. * @param byteOffset the byte offset of the data
  11927. * @param byteLength the byte length of the data
  11928. */
  11929. updateDynamicVertexBuffer(vertexBuffer: DataBuffer, data: DataArray, byteOffset?: number, byteLength?: number): void;
  11930. }
  11931. }
  11932. }
  11933. declare module "babylonjs/Materials/Textures/Procedurals/proceduralTextureSceneComponent" {
  11934. import { Scene } from "babylonjs/scene";
  11935. import { ISceneComponent } from "babylonjs/sceneComponent";
  11936. import { ProceduralTexture } from "babylonjs/Materials/Textures/Procedurals/proceduralTexture";
  11937. module "babylonjs/abstractScene" {
  11938. interface AbstractScene {
  11939. /**
  11940. * The list of procedural textures added to the scene
  11941. * @see https://doc.babylonjs.com/how_to/how_to_use_procedural_textures
  11942. */
  11943. proceduralTextures: Array<ProceduralTexture>;
  11944. }
  11945. }
  11946. /**
  11947. * Defines the Procedural Texture scene component responsible to manage any Procedural Texture
  11948. * in a given scene.
  11949. */
  11950. export class ProceduralTextureSceneComponent implements ISceneComponent {
  11951. /**
  11952. * The component name helpfull to identify the component in the list of scene components.
  11953. */
  11954. readonly name: string;
  11955. /**
  11956. * The scene the component belongs to.
  11957. */
  11958. scene: Scene;
  11959. /**
  11960. * Creates a new instance of the component for the given scene
  11961. * @param scene Defines the scene to register the component in
  11962. */
  11963. constructor(scene: Scene);
  11964. /**
  11965. * Registers the component in a given scene
  11966. */
  11967. register(): void;
  11968. /**
  11969. * Rebuilds the elements related to this component in case of
  11970. * context lost for instance.
  11971. */
  11972. rebuild(): void;
  11973. /**
  11974. * Disposes the component and the associated ressources.
  11975. */
  11976. dispose(): void;
  11977. private _beforeClear;
  11978. }
  11979. }
  11980. declare module "babylonjs/Engines/Extensions/engine.renderTargetCube" {
  11981. import { InternalTexture } from "babylonjs/Materials/Textures/internalTexture";
  11982. import { RenderTargetCreationOptions } from "babylonjs/Materials/Textures/renderTargetCreationOptions";
  11983. module "babylonjs/Engines/thinEngine" {
  11984. interface ThinEngine {
  11985. /**
  11986. * Creates a new render target cube texture
  11987. * @param size defines the size of the texture
  11988. * @param options defines the options used to create the texture
  11989. * @returns a new render target cube texture stored in an InternalTexture
  11990. */
  11991. createRenderTargetCubeTexture(size: number, options?: Partial<RenderTargetCreationOptions>): InternalTexture;
  11992. }
  11993. }
  11994. }
  11995. declare module "babylonjs/Shaders/procedural.vertex" {
  11996. /** @hidden */
  11997. export var proceduralVertexShader: {
  11998. name: string;
  11999. shader: string;
  12000. };
  12001. }
  12002. declare module "babylonjs/Materials/Textures/Procedurals/proceduralTexture" {
  12003. import { Observable } from "babylonjs/Misc/observable";
  12004. import { Nullable } from "babylonjs/types";
  12005. import { Scene } from "babylonjs/scene";
  12006. import { Matrix, Vector3, Vector2 } from "babylonjs/Maths/math.vector";
  12007. import { Color4, Color3 } from "babylonjs/Maths/math.color";
  12008. import { Effect } from "babylonjs/Materials/effect";
  12009. import { Texture } from "babylonjs/Materials/Textures/texture";
  12010. import "babylonjs/Engines/Extensions/engine.renderTarget";
  12011. import "babylonjs/Engines/Extensions/engine.renderTargetCube";
  12012. import "babylonjs/Shaders/procedural.vertex";
  12013. import { NodeMaterial } from "babylonjs/Materials/Node/nodeMaterial";
  12014. import { RenderTargetTextureSize } from "babylonjs/Engines/Extensions/engine.renderTarget";
  12015. /**
  12016. * 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.
  12017. * This is the base class of any Procedural texture and contains most of the shareable code.
  12018. * @see https://doc.babylonjs.com/how_to/how_to_use_procedural_textures
  12019. */
  12020. export class ProceduralTexture extends Texture {
  12021. /**
  12022. * Define if the texture is enabled or not (disabled texture will not render)
  12023. */
  12024. isEnabled: boolean;
  12025. /**
  12026. * Define if the texture must be cleared before rendering (default is true)
  12027. */
  12028. autoClear: boolean;
  12029. /**
  12030. * Callback called when the texture is generated
  12031. */
  12032. onGenerated: () => void;
  12033. /**
  12034. * Event raised when the texture is generated
  12035. */
  12036. onGeneratedObservable: Observable<ProceduralTexture>;
  12037. /**
  12038. * Event raised before the texture is generated
  12039. */
  12040. onBeforeGenerationObservable: Observable<ProceduralTexture>;
  12041. /**
  12042. * Gets or sets the node material used to create this texture (null if the texture was manually created)
  12043. */
  12044. nodeMaterialSource: Nullable<NodeMaterial>;
  12045. /** @hidden */
  12046. _generateMipMaps: boolean;
  12047. /** @hidden **/
  12048. _effect: Effect;
  12049. /** @hidden */
  12050. _textures: {
  12051. [key: string]: Texture;
  12052. };
  12053. /** @hidden */
  12054. protected _fallbackTexture: Nullable<Texture>;
  12055. private _size;
  12056. private _currentRefreshId;
  12057. private _frameId;
  12058. private _refreshRate;
  12059. private _vertexBuffers;
  12060. private _indexBuffer;
  12061. private _uniforms;
  12062. private _samplers;
  12063. private _fragment;
  12064. private _floats;
  12065. private _ints;
  12066. private _floatsArrays;
  12067. private _colors3;
  12068. private _colors4;
  12069. private _vectors2;
  12070. private _vectors3;
  12071. private _matrices;
  12072. private _fallbackTextureUsed;
  12073. private _fullEngine;
  12074. private _cachedDefines;
  12075. private _contentUpdateId;
  12076. private _contentData;
  12077. /**
  12078. * Instantiates a new procedural texture.
  12079. * 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.
  12080. * This is the base class of any Procedural texture and contains most of the shareable code.
  12081. * @see https://doc.babylonjs.com/how_to/how_to_use_procedural_textures
  12082. * @param name Define the name of the texture
  12083. * @param size Define the size of the texture to create
  12084. * @param fragment Define the fragment shader to use to generate the texture or null if it is defined later
  12085. * @param scene Define the scene the texture belongs to
  12086. * @param fallbackTexture Define a fallback texture in case there were issues to create the custom texture
  12087. * @param generateMipMaps Define if the texture should creates mip maps or not
  12088. * @param isCube Define if the texture is a cube texture or not (this will render each faces of the cube)
  12089. * @param textureType The FBO internal texture type
  12090. */
  12091. constructor(name: string, size: RenderTargetTextureSize, fragment: any, scene: Nullable<Scene>, fallbackTexture?: Nullable<Texture>, generateMipMaps?: boolean, isCube?: boolean, textureType?: number);
  12092. /**
  12093. * The effect that is created when initializing the post process.
  12094. * @returns The created effect corresponding the the postprocess.
  12095. */
  12096. getEffect(): Effect;
  12097. /**
  12098. * Gets texture content (Use this function wisely as reading from a texture can be slow)
  12099. * @returns an ArrayBufferView (Uint8Array or Float32Array)
  12100. */
  12101. getContent(): Nullable<ArrayBufferView>;
  12102. private _createIndexBuffer;
  12103. /** @hidden */
  12104. _rebuild(): void;
  12105. /**
  12106. * Resets the texture in order to recreate its associated resources.
  12107. * This can be called in case of context loss
  12108. */
  12109. reset(): void;
  12110. protected _getDefines(): string;
  12111. /**
  12112. * Is the texture ready to be used ? (rendered at least once)
  12113. * @returns true if ready, otherwise, false.
  12114. */
  12115. isReady(): boolean;
  12116. /**
  12117. * Resets the refresh counter of the texture and start bak from scratch.
  12118. * Could be useful to regenerate the texture if it is setup to render only once.
  12119. */
  12120. resetRefreshCounter(): void;
  12121. /**
  12122. * Set the fragment shader to use in order to render the texture.
  12123. * @param fragment This can be set to a path (into the shader store) or to a json object containing a fragmentElement property.
  12124. */
  12125. setFragment(fragment: any): void;
  12126. /**
  12127. * Define the refresh rate of the texture or the rendering frequency.
  12128. * Use 0 to render just once, 1 to render on every frame, 2 to render every two frames and so on...
  12129. */
  12130. get refreshRate(): number;
  12131. set refreshRate(value: number);
  12132. /** @hidden */
  12133. _shouldRender(): boolean;
  12134. /**
  12135. * Get the size the texture is rendering at.
  12136. * @returns the size (on cube texture it is always squared)
  12137. */
  12138. getRenderSize(): RenderTargetTextureSize;
  12139. /**
  12140. * Resize the texture to new value.
  12141. * @param size Define the new size the texture should have
  12142. * @param generateMipMaps Define whether the new texture should create mip maps
  12143. */
  12144. resize(size: number, generateMipMaps: boolean): void;
  12145. private _checkUniform;
  12146. /**
  12147. * Set a texture in the shader program used to render.
  12148. * @param name Define the name of the uniform samplers as defined in the shader
  12149. * @param texture Define the texture to bind to this sampler
  12150. * @return the texture itself allowing "fluent" like uniform updates
  12151. */
  12152. setTexture(name: string, texture: Texture): ProceduralTexture;
  12153. /**
  12154. * Set a float in the shader.
  12155. * @param name Define the name of the uniform as defined in the shader
  12156. * @param value Define the value to give to the uniform
  12157. * @return the texture itself allowing "fluent" like uniform updates
  12158. */
  12159. setFloat(name: string, value: number): ProceduralTexture;
  12160. /**
  12161. * Set a int in the shader.
  12162. * @param name Define the name of the uniform as defined in the shader
  12163. * @param value Define the value to give to the uniform
  12164. * @return the texture itself allowing "fluent" like uniform updates
  12165. */
  12166. setInt(name: string, value: number): ProceduralTexture;
  12167. /**
  12168. * Set an array of floats in the shader.
  12169. * @param name Define the name of the uniform as defined in the shader
  12170. * @param value Define the value to give to the uniform
  12171. * @return the texture itself allowing "fluent" like uniform updates
  12172. */
  12173. setFloats(name: string, value: number[]): ProceduralTexture;
  12174. /**
  12175. * Set a vec3 in the shader from a Color3.
  12176. * @param name Define the name of the uniform as defined in the shader
  12177. * @param value Define the value to give to the uniform
  12178. * @return the texture itself allowing "fluent" like uniform updates
  12179. */
  12180. setColor3(name: string, value: Color3): ProceduralTexture;
  12181. /**
  12182. * Set a vec4 in the shader from a Color4.
  12183. * @param name Define the name of the uniform as defined in the shader
  12184. * @param value Define the value to give to the uniform
  12185. * @return the texture itself allowing "fluent" like uniform updates
  12186. */
  12187. setColor4(name: string, value: Color4): ProceduralTexture;
  12188. /**
  12189. * Set a vec2 in the shader from a Vector2.
  12190. * @param name Define the name of the uniform as defined in the shader
  12191. * @param value Define the value to give to the uniform
  12192. * @return the texture itself allowing "fluent" like uniform updates
  12193. */
  12194. setVector2(name: string, value: Vector2): ProceduralTexture;
  12195. /**
  12196. * Set a vec3 in the shader from a Vector3.
  12197. * @param name Define the name of the uniform as defined in the shader
  12198. * @param value Define the value to give to the uniform
  12199. * @return the texture itself allowing "fluent" like uniform updates
  12200. */
  12201. setVector3(name: string, value: Vector3): ProceduralTexture;
  12202. /**
  12203. * Set a mat4 in the shader from a MAtrix.
  12204. * @param name Define the name of the uniform as defined in the shader
  12205. * @param value Define the value to give to the uniform
  12206. * @return the texture itself allowing "fluent" like uniform updates
  12207. */
  12208. setMatrix(name: string, value: Matrix): ProceduralTexture;
  12209. /**
  12210. * Render the texture to its associated render target.
  12211. * @param useCameraPostProcess Define if camera post process should be applied to the texture
  12212. */
  12213. render(useCameraPostProcess?: boolean): void;
  12214. /**
  12215. * Clone the texture.
  12216. * @returns the cloned texture
  12217. */
  12218. clone(): ProceduralTexture;
  12219. /**
  12220. * Dispose the texture and release its asoociated resources.
  12221. */
  12222. dispose(): void;
  12223. }
  12224. }
  12225. declare module "babylonjs/Particles/baseParticleSystem" {
  12226. import { Nullable } from "babylonjs/types";
  12227. import { Vector2, Vector3 } from "babylonjs/Maths/math.vector";
  12228. import { AbstractMesh } from "babylonjs/Meshes/abstractMesh";
  12229. import { ImageProcessingConfiguration, ImageProcessingConfigurationDefines } from "babylonjs/Materials/imageProcessingConfiguration";
  12230. import { ColorGradient, FactorGradient, Color3Gradient, IValueGradient } from "babylonjs/Misc/gradients";
  12231. import { BoxParticleEmitter, IParticleEmitterType, PointParticleEmitter, HemisphericParticleEmitter, SphereParticleEmitter, SphereDirectedParticleEmitter, CylinderParticleEmitter, CylinderDirectedParticleEmitter, ConeParticleEmitter } from "babylonjs/Particles/EmitterTypes/index";
  12232. import { BaseTexture } from "babylonjs/Materials/Textures/baseTexture";
  12233. import { Color4 } from "babylonjs/Maths/math.color";
  12234. import { ThinEngine } from "babylonjs/Engines/thinEngine";
  12235. import "babylonjs/Engines/Extensions/engine.dynamicBuffer";
  12236. import { Animation } from "babylonjs/Animations/animation";
  12237. import { Scene } from "babylonjs/scene";
  12238. import { ProceduralTexture } from "babylonjs/Materials/Textures/Procedurals/proceduralTexture";
  12239. import { RawTexture } from "babylonjs/Materials/Textures/rawTexture";
  12240. /**
  12241. * This represents the base class for particle system in Babylon.
  12242. * 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.
  12243. * Particles can take different shapes while emitted like box, sphere, cone or you can write your custom function.
  12244. * @example https://doc.babylonjs.com/babylon101/particles
  12245. */
  12246. export class BaseParticleSystem {
  12247. /**
  12248. * Source color is added to the destination color without alpha affecting the result
  12249. */
  12250. static BLENDMODE_ONEONE: number;
  12251. /**
  12252. * Blend current color and particle color using particle’s alpha
  12253. */
  12254. static BLENDMODE_STANDARD: number;
  12255. /**
  12256. * Add current color and particle color multiplied by particle’s alpha
  12257. */
  12258. static BLENDMODE_ADD: number;
  12259. /**
  12260. * Multiply current color with particle color
  12261. */
  12262. static BLENDMODE_MULTIPLY: number;
  12263. /**
  12264. * Multiply current color with particle color then add current color and particle color multiplied by particle’s alpha
  12265. */
  12266. static BLENDMODE_MULTIPLYADD: number;
  12267. /**
  12268. * List of animations used by the particle system.
  12269. */
  12270. animations: Animation[];
  12271. /**
  12272. * Gets or sets the unique id of the particle system
  12273. */
  12274. uniqueId: number;
  12275. /**
  12276. * The id of the Particle system.
  12277. */
  12278. id: string;
  12279. /**
  12280. * The friendly name of the Particle system.
  12281. */
  12282. name: string;
  12283. /**
  12284. * Snippet ID if the particle system was created from the snippet server
  12285. */
  12286. snippetId: string;
  12287. /**
  12288. * The rendering group used by the Particle system to chose when to render.
  12289. */
  12290. renderingGroupId: number;
  12291. /**
  12292. * The emitter represents the Mesh or position we are attaching the particle system to.
  12293. */
  12294. emitter: Nullable<AbstractMesh | Vector3>;
  12295. /**
  12296. * The maximum number of particles to emit per frame
  12297. */
  12298. emitRate: number;
  12299. /**
  12300. * If you want to launch only a few particles at once, that can be done, as well.
  12301. */
  12302. manualEmitCount: number;
  12303. /**
  12304. * The overall motion speed (0.01 is default update speed, faster updates = faster animation)
  12305. */
  12306. updateSpeed: number;
  12307. /**
  12308. * The amount of time the particle system is running (depends of the overall update speed).
  12309. */
  12310. targetStopDuration: number;
  12311. /**
  12312. * Specifies whether the particle system will be disposed once it reaches the end of the animation.
  12313. */
  12314. disposeOnStop: boolean;
  12315. /**
  12316. * Minimum power of emitting particles.
  12317. */
  12318. minEmitPower: number;
  12319. /**
  12320. * Maximum power of emitting particles.
  12321. */
  12322. maxEmitPower: number;
  12323. /**
  12324. * Minimum life time of emitting particles.
  12325. */
  12326. minLifeTime: number;
  12327. /**
  12328. * Maximum life time of emitting particles.
  12329. */
  12330. maxLifeTime: number;
  12331. /**
  12332. * Minimum Size of emitting particles.
  12333. */
  12334. minSize: number;
  12335. /**
  12336. * Maximum Size of emitting particles.
  12337. */
  12338. maxSize: number;
  12339. /**
  12340. * Minimum scale of emitting particles on X axis.
  12341. */
  12342. minScaleX: number;
  12343. /**
  12344. * Maximum scale of emitting particles on X axis.
  12345. */
  12346. maxScaleX: number;
  12347. /**
  12348. * Minimum scale of emitting particles on Y axis.
  12349. */
  12350. minScaleY: number;
  12351. /**
  12352. * Maximum scale of emitting particles on Y axis.
  12353. */
  12354. maxScaleY: number;
  12355. /**
  12356. * Gets or sets the minimal initial rotation in radians.
  12357. */
  12358. minInitialRotation: number;
  12359. /**
  12360. * Gets or sets the maximal initial rotation in radians.
  12361. */
  12362. maxInitialRotation: number;
  12363. /**
  12364. * Minimum angular speed of emitting particles (Z-axis rotation for each particle).
  12365. */
  12366. minAngularSpeed: number;
  12367. /**
  12368. * Maximum angular speed of emitting particles (Z-axis rotation for each particle).
  12369. */
  12370. maxAngularSpeed: number;
  12371. /**
  12372. * The texture used to render each particle. (this can be a spritesheet)
  12373. */
  12374. particleTexture: Nullable<BaseTexture>;
  12375. /**
  12376. * The layer mask we are rendering the particles through.
  12377. */
  12378. layerMask: number;
  12379. /**
  12380. * This can help using your own shader to render the particle system.
  12381. * The according effect will be created
  12382. */
  12383. customShader: any;
  12384. /**
  12385. * By default particle system starts as soon as they are created. This prevents the
  12386. * automatic start to happen and let you decide when to start emitting particles.
  12387. */
  12388. preventAutoStart: boolean;
  12389. private _noiseTexture;
  12390. /**
  12391. * Gets or sets a texture used to add random noise to particle positions
  12392. */
  12393. get noiseTexture(): Nullable<ProceduralTexture>;
  12394. set noiseTexture(value: Nullable<ProceduralTexture>);
  12395. /** Gets or sets the strength to apply to the noise value (default is (10, 10, 10)) */
  12396. noiseStrength: Vector3;
  12397. /**
  12398. * Callback triggered when the particle animation is ending.
  12399. */
  12400. onAnimationEnd: Nullable<() => void>;
  12401. /**
  12402. * Blend mode use to render the particle, it can be either ParticleSystem.BLENDMODE_ONEONE or ParticleSystem.BLENDMODE_STANDARD.
  12403. */
  12404. blendMode: number;
  12405. /**
  12406. * Forces the particle to write their depth information to the depth buffer. This can help preventing other draw calls
  12407. * to override the particles.
  12408. */
  12409. forceDepthWrite: boolean;
  12410. /** 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 */
  12411. preWarmCycles: number;
  12412. /** Gets or sets a value indicating the time step multiplier to use in pre-warm mode (default is 1) */
  12413. preWarmStepOffset: number;
  12414. /**
  12415. * 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)
  12416. */
  12417. spriteCellChangeSpeed: number;
  12418. /**
  12419. * If using a spritesheet (isAnimationSheetEnabled) defines the first sprite cell to display
  12420. */
  12421. startSpriteCellID: number;
  12422. /**
  12423. * If using a spritesheet (isAnimationSheetEnabled) defines the last sprite cell to display
  12424. */
  12425. endSpriteCellID: number;
  12426. /**
  12427. * If using a spritesheet (isAnimationSheetEnabled), defines the sprite cell width to use
  12428. */
  12429. spriteCellWidth: number;
  12430. /**
  12431. * If using a spritesheet (isAnimationSheetEnabled), defines the sprite cell height to use
  12432. */
  12433. spriteCellHeight: number;
  12434. /**
  12435. * This allows the system to random pick the start cell ID between startSpriteCellID and endSpriteCellID
  12436. */
  12437. spriteRandomStartCell: boolean;
  12438. /** Gets or sets a Vector2 used to move the pivot (by default (0,0)) */
  12439. translationPivot: Vector2;
  12440. /** @hidden */
  12441. protected _isAnimationSheetEnabled: boolean;
  12442. /**
  12443. * Gets or sets a boolean indicating that hosted animations (in the system.animations array) must be started when system.start() is called
  12444. */
  12445. beginAnimationOnStart: boolean;
  12446. /**
  12447. * Gets or sets the frame to start the animation from when beginAnimationOnStart is true
  12448. */
  12449. beginAnimationFrom: number;
  12450. /**
  12451. * Gets or sets the frame to end the animation on when beginAnimationOnStart is true
  12452. */
  12453. beginAnimationTo: number;
  12454. /**
  12455. * Gets or sets a boolean indicating if animations must loop when beginAnimationOnStart is true
  12456. */
  12457. beginAnimationLoop: boolean;
  12458. /**
  12459. * Gets or sets a world offset applied to all particles
  12460. */
  12461. worldOffset: Vector3;
  12462. /**
  12463. * Gets or sets whether an animation sprite sheet is enabled or not on the particle system
  12464. */
  12465. get isAnimationSheetEnabled(): boolean;
  12466. set isAnimationSheetEnabled(value: boolean);
  12467. /**
  12468. * Get hosting scene
  12469. * @returns the scene
  12470. */
  12471. getScene(): Nullable<Scene>;
  12472. /**
  12473. * You can use gravity if you want to give an orientation to your particles.
  12474. */
  12475. gravity: Vector3;
  12476. protected _colorGradients: Nullable<Array<ColorGradient>>;
  12477. protected _sizeGradients: Nullable<Array<FactorGradient>>;
  12478. protected _lifeTimeGradients: Nullable<Array<FactorGradient>>;
  12479. protected _angularSpeedGradients: Nullable<Array<FactorGradient>>;
  12480. protected _velocityGradients: Nullable<Array<FactorGradient>>;
  12481. protected _limitVelocityGradients: Nullable<Array<FactorGradient>>;
  12482. protected _dragGradients: Nullable<Array<FactorGradient>>;
  12483. protected _emitRateGradients: Nullable<Array<FactorGradient>>;
  12484. protected _startSizeGradients: Nullable<Array<FactorGradient>>;
  12485. protected _rampGradients: Nullable<Array<Color3Gradient>>;
  12486. protected _colorRemapGradients: Nullable<Array<FactorGradient>>;
  12487. protected _alphaRemapGradients: Nullable<Array<FactorGradient>>;
  12488. protected _hasTargetStopDurationDependantGradient(): boolean | null;
  12489. /**
  12490. * Defines the delay in milliseconds before starting the system (0 by default)
  12491. */
  12492. startDelay: number;
  12493. /**
  12494. * Gets the current list of drag gradients.
  12495. * You must use addDragGradient and removeDragGradient to udpate this list
  12496. * @returns the list of drag gradients
  12497. */
  12498. getDragGradients(): Nullable<Array<FactorGradient>>;
  12499. /** Gets or sets a value indicating the damping to apply if the limit velocity factor is reached */
  12500. limitVelocityDamping: number;
  12501. /**
  12502. * Gets the current list of limit velocity gradients.
  12503. * You must use addLimitVelocityGradient and removeLimitVelocityGradient to udpate this list
  12504. * @returns the list of limit velocity gradients
  12505. */
  12506. getLimitVelocityGradients(): Nullable<Array<FactorGradient>>;
  12507. /**
  12508. * Gets the current list of color gradients.
  12509. * You must use addColorGradient and removeColorGradient to udpate this list
  12510. * @returns the list of color gradients
  12511. */
  12512. getColorGradients(): Nullable<Array<ColorGradient>>;
  12513. /**
  12514. * Gets the current list of size gradients.
  12515. * You must use addSizeGradient and removeSizeGradient to udpate this list
  12516. * @returns the list of size gradients
  12517. */
  12518. getSizeGradients(): Nullable<Array<FactorGradient>>;
  12519. /**
  12520. * Gets the current list of color remap gradients.
  12521. * You must use addColorRemapGradient and removeColorRemapGradient to udpate this list
  12522. * @returns the list of color remap gradients
  12523. */
  12524. getColorRemapGradients(): Nullable<Array<FactorGradient>>;
  12525. /**
  12526. * Gets the current list of alpha remap gradients.
  12527. * You must use addAlphaRemapGradient and removeAlphaRemapGradient to udpate this list
  12528. * @returns the list of alpha remap gradients
  12529. */
  12530. getAlphaRemapGradients(): Nullable<Array<FactorGradient>>;
  12531. /**
  12532. * Gets the current list of life time gradients.
  12533. * You must use addLifeTimeGradient and removeLifeTimeGradient to udpate this list
  12534. * @returns the list of life time gradients
  12535. */
  12536. getLifeTimeGradients(): Nullable<Array<FactorGradient>>;
  12537. /**
  12538. * Gets the current list of angular speed gradients.
  12539. * You must use addAngularSpeedGradient and removeAngularSpeedGradient to udpate this list
  12540. * @returns the list of angular speed gradients
  12541. */
  12542. getAngularSpeedGradients(): Nullable<Array<FactorGradient>>;
  12543. /**
  12544. * Gets the current list of velocity gradients.
  12545. * You must use addVelocityGradient and removeVelocityGradient to udpate this list
  12546. * @returns the list of velocity gradients
  12547. */
  12548. getVelocityGradients(): Nullable<Array<FactorGradient>>;
  12549. /**
  12550. * Gets the current list of start size gradients.
  12551. * You must use addStartSizeGradient and removeStartSizeGradient to udpate this list
  12552. * @returns the list of start size gradients
  12553. */
  12554. getStartSizeGradients(): Nullable<Array<FactorGradient>>;
  12555. /**
  12556. * Gets the current list of emit rate gradients.
  12557. * You must use addEmitRateGradient and removeEmitRateGradient to udpate this list
  12558. * @returns the list of emit rate gradients
  12559. */
  12560. getEmitRateGradients(): Nullable<Array<FactorGradient>>;
  12561. /**
  12562. * Random direction of each particle after it has been emitted, between direction1 and direction2 vectors.
  12563. * This only works when particleEmitterTyps is a BoxParticleEmitter
  12564. */
  12565. get direction1(): Vector3;
  12566. set direction1(value: Vector3);
  12567. /**
  12568. * Random direction of each particle after it has been emitted, between direction1 and direction2 vectors.
  12569. * This only works when particleEmitterTyps is a BoxParticleEmitter
  12570. */
  12571. get direction2(): Vector3;
  12572. set direction2(value: Vector3);
  12573. /**
  12574. * 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.
  12575. * This only works when particleEmitterTyps is a BoxParticleEmitter
  12576. */
  12577. get minEmitBox(): Vector3;
  12578. set minEmitBox(value: Vector3);
  12579. /**
  12580. * 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.
  12581. * This only works when particleEmitterTyps is a BoxParticleEmitter
  12582. */
  12583. get maxEmitBox(): Vector3;
  12584. set maxEmitBox(value: Vector3);
  12585. /**
  12586. * Random color of each particle after it has been emitted, between color1 and color2 vectors
  12587. */
  12588. color1: Color4;
  12589. /**
  12590. * Random color of each particle after it has been emitted, between color1 and color2 vectors
  12591. */
  12592. color2: Color4;
  12593. /**
  12594. * Color the particle will have at the end of its lifetime
  12595. */
  12596. colorDead: Color4;
  12597. /**
  12598. * An optional mask to filter some colors out of the texture, or filter a part of the alpha channel
  12599. */
  12600. textureMask: Color4;
  12601. /**
  12602. * The particle emitter type defines the emitter used by the particle system.
  12603. * It can be for example box, sphere, or cone...
  12604. */
  12605. particleEmitterType: IParticleEmitterType;
  12606. /** @hidden */
  12607. _isSubEmitter: boolean;
  12608. /**
  12609. * Gets or sets the billboard mode to use when isBillboardBased = true.
  12610. * Value can be: ParticleSystem.BILLBOARDMODE_ALL, ParticleSystem.BILLBOARDMODE_Y, ParticleSystem.BILLBOARDMODE_STRETCHED
  12611. */
  12612. billboardMode: number;
  12613. protected _isBillboardBased: boolean;
  12614. /**
  12615. * Gets or sets a boolean indicating if the particles must be rendered as billboard or aligned with the direction
  12616. */
  12617. get isBillboardBased(): boolean;
  12618. set isBillboardBased(value: boolean);
  12619. /**
  12620. * The scene the particle system belongs to.
  12621. */
  12622. protected _scene: Nullable<Scene>;
  12623. /**
  12624. * The engine the particle system belongs to.
  12625. */
  12626. protected _engine: ThinEngine;
  12627. /**
  12628. * Local cache of defines for image processing.
  12629. */
  12630. protected _imageProcessingConfigurationDefines: ImageProcessingConfigurationDefines;
  12631. /**
  12632. * Default configuration related to image processing available in the standard Material.
  12633. */
  12634. protected _imageProcessingConfiguration: Nullable<ImageProcessingConfiguration>;
  12635. /**
  12636. * Gets the image processing configuration used either in this material.
  12637. */
  12638. get imageProcessingConfiguration(): Nullable<ImageProcessingConfiguration>;
  12639. /**
  12640. * Sets the Default image processing configuration used either in the this material.
  12641. *
  12642. * If sets to null, the scene one is in use.
  12643. */
  12644. set imageProcessingConfiguration(value: Nullable<ImageProcessingConfiguration>);
  12645. /**
  12646. * Attaches a new image processing configuration to the Standard Material.
  12647. * @param configuration
  12648. */
  12649. protected _attachImageProcessingConfiguration(configuration: Nullable<ImageProcessingConfiguration>): void;
  12650. /** @hidden */
  12651. protected _reset(): void;
  12652. /** @hidden */
  12653. protected _removeGradientAndTexture(gradient: number, gradients: Nullable<IValueGradient[]>, texture: Nullable<RawTexture>): BaseParticleSystem;
  12654. /**
  12655. * Instantiates a particle system.
  12656. * 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.
  12657. * @param name The name of the particle system
  12658. */
  12659. constructor(name: string);
  12660. /**
  12661. * Creates a Point Emitter for the particle system (emits directly from the emitter position)
  12662. * @param direction1 Particles are emitted between the direction1 and direction2 from within the box
  12663. * @param direction2 Particles are emitted between the direction1 and direction2 from within the box
  12664. * @returns the emitter
  12665. */
  12666. createPointEmitter(direction1: Vector3, direction2: Vector3): PointParticleEmitter;
  12667. /**
  12668. * Creates a Hemisphere Emitter for the particle system (emits along the hemisphere radius)
  12669. * @param radius The radius of the hemisphere to emit from
  12670. * @param radiusRange The range of the hemisphere to emit from [0-1] 0 Surface Only, 1 Entire Radius
  12671. * @returns the emitter
  12672. */
  12673. createHemisphericEmitter(radius?: number, radiusRange?: number): HemisphericParticleEmitter;
  12674. /**
  12675. * Creates a Sphere Emitter for the particle system (emits along the sphere radius)
  12676. * @param radius The radius of the sphere to emit from
  12677. * @param radiusRange The range of the sphere to emit from [0-1] 0 Surface Only, 1 Entire Radius
  12678. * @returns the emitter
  12679. */
  12680. createSphereEmitter(radius?: number, radiusRange?: number): SphereParticleEmitter;
  12681. /**
  12682. * Creates a Directed Sphere Emitter for the particle system (emits between direction1 and direction2)
  12683. * @param radius The radius of the sphere to emit from
  12684. * @param direction1 Particles are emitted between the direction1 and direction2 from within the sphere
  12685. * @param direction2 Particles are emitted between the direction1 and direction2 from within the sphere
  12686. * @returns the emitter
  12687. */
  12688. createDirectedSphereEmitter(radius?: number, direction1?: Vector3, direction2?: Vector3): SphereDirectedParticleEmitter;
  12689. /**
  12690. * Creates a Cylinder Emitter for the particle system (emits from the cylinder to the particle position)
  12691. * @param radius The radius of the emission cylinder
  12692. * @param height The height of the emission cylinder
  12693. * @param radiusRange The range of emission [0-1] 0 Surface only, 1 Entire Radius
  12694. * @param directionRandomizer How much to randomize the particle direction [0-1]
  12695. * @returns the emitter
  12696. */
  12697. createCylinderEmitter(radius?: number, height?: number, radiusRange?: number, directionRandomizer?: number): CylinderParticleEmitter;
  12698. /**
  12699. * Creates a Directed Cylinder Emitter for the particle system (emits between direction1 and direction2)
  12700. * @param radius The radius of the cylinder to emit from
  12701. * @param height The height of the emission cylinder
  12702. * @param radiusRange the range of the emission cylinder [0-1] 0 Surface only, 1 Entire Radius (1 by default)
  12703. * @param direction1 Particles are emitted between the direction1 and direction2 from within the cylinder
  12704. * @param direction2 Particles are emitted between the direction1 and direction2 from within the cylinder
  12705. * @returns the emitter
  12706. */
  12707. createDirectedCylinderEmitter(radius?: number, height?: number, radiusRange?: number, direction1?: Vector3, direction2?: Vector3): CylinderDirectedParticleEmitter;
  12708. /**
  12709. * Creates a Cone Emitter for the particle system (emits from the cone to the particle position)
  12710. * @param radius The radius of the cone to emit from
  12711. * @param angle The base angle of the cone
  12712. * @returns the emitter
  12713. */
  12714. createConeEmitter(radius?: number, angle?: number): ConeParticleEmitter;
  12715. /**
  12716. * Creates a Box Emitter for the particle system. (emits between direction1 and direction2 from withing the box defined by minEmitBox and maxEmitBox)
  12717. * @param direction1 Particles are emitted between the direction1 and direction2 from within the box
  12718. * @param direction2 Particles are emitted between the direction1 and direction2 from within the box
  12719. * @param minEmitBox Particles are emitted from the box between minEmitBox and maxEmitBox
  12720. * @param maxEmitBox Particles are emitted from the box between minEmitBox and maxEmitBox
  12721. * @returns the emitter
  12722. */
  12723. createBoxEmitter(direction1: Vector3, direction2: Vector3, minEmitBox: Vector3, maxEmitBox: Vector3): BoxParticleEmitter;
  12724. }
  12725. }
  12726. declare module "babylonjs/Particles/subEmitter" {
  12727. import { ThinEngine } from "babylonjs/Engines/thinEngine";
  12728. import { Scene } from "babylonjs/scene";
  12729. import { ParticleSystem } from "babylonjs/Particles/particleSystem";
  12730. /**
  12731. * Type of sub emitter
  12732. */
  12733. export enum SubEmitterType {
  12734. /**
  12735. * Attached to the particle over it's lifetime
  12736. */
  12737. ATTACHED = 0,
  12738. /**
  12739. * Created when the particle dies
  12740. */
  12741. END = 1
  12742. }
  12743. /**
  12744. * Sub emitter class used to emit particles from an existing particle
  12745. */
  12746. export class SubEmitter {
  12747. /**
  12748. * the particle system to be used by the sub emitter
  12749. */
  12750. particleSystem: ParticleSystem;
  12751. /**
  12752. * Type of the submitter (Default: END)
  12753. */
  12754. type: SubEmitterType;
  12755. /**
  12756. * 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)
  12757. * Note: This only is supported when using an emitter of type Mesh
  12758. */
  12759. inheritDirection: boolean;
  12760. /**
  12761. * How much of the attached particles speed should be added to the sub emitted particle (default: 0)
  12762. */
  12763. inheritedVelocityAmount: number;
  12764. /**
  12765. * Creates a sub emitter
  12766. * @param particleSystem the particle system to be used by the sub emitter
  12767. */
  12768. constructor(
  12769. /**
  12770. * the particle system to be used by the sub emitter
  12771. */
  12772. particleSystem: ParticleSystem);
  12773. /**
  12774. * Clones the sub emitter
  12775. * @returns the cloned sub emitter
  12776. */
  12777. clone(): SubEmitter;
  12778. /**
  12779. * Serialize current object to a JSON object
  12780. * @returns the serialized object
  12781. */
  12782. serialize(): any;
  12783. /** @hidden */
  12784. static _ParseParticleSystem(system: any, sceneOrEngine: Scene | ThinEngine, rootUrl: string): ParticleSystem;
  12785. /**
  12786. * Creates a new SubEmitter from a serialized JSON version
  12787. * @param serializationObject defines the JSON object to read from
  12788. * @param sceneOrEngine defines the hosting scene or the hosting engine
  12789. * @param rootUrl defines the rootUrl for data loading
  12790. * @returns a new SubEmitter
  12791. */
  12792. static Parse(serializationObject: any, sceneOrEngine: Scene | ThinEngine, rootUrl: string): SubEmitter;
  12793. /** Release associated resources */
  12794. dispose(): void;
  12795. }
  12796. }
  12797. declare module "babylonjs/Shaders/ShadersInclude/imageProcessingDeclaration" {
  12798. /** @hidden */
  12799. export var imageProcessingDeclaration: {
  12800. name: string;
  12801. shader: string;
  12802. };
  12803. }
  12804. declare module "babylonjs/Shaders/ShadersInclude/imageProcessingFunctions" {
  12805. /** @hidden */
  12806. export var imageProcessingFunctions: {
  12807. name: string;
  12808. shader: string;
  12809. };
  12810. }
  12811. declare module "babylonjs/Shaders/particles.fragment" {
  12812. import "babylonjs/Shaders/ShadersInclude/clipPlaneFragmentDeclaration";
  12813. import "babylonjs/Shaders/ShadersInclude/imageProcessingDeclaration";
  12814. import "babylonjs/Shaders/ShadersInclude/helperFunctions";
  12815. import "babylonjs/Shaders/ShadersInclude/imageProcessingFunctions";
  12816. import "babylonjs/Shaders/ShadersInclude/clipPlaneFragment";
  12817. /** @hidden */
  12818. export var particlesPixelShader: {
  12819. name: string;
  12820. shader: string;
  12821. };
  12822. }
  12823. declare module "babylonjs/Shaders/particles.vertex" {
  12824. import "babylonjs/Shaders/ShadersInclude/clipPlaneVertexDeclaration";
  12825. import "babylonjs/Shaders/ShadersInclude/clipPlaneVertex";
  12826. /** @hidden */
  12827. export var particlesVertexShader: {
  12828. name: string;
  12829. shader: string;
  12830. };
  12831. }
  12832. declare module "babylonjs/Misc/interfaces/iClipPlanesHolder" {
  12833. import { Nullable } from "babylonjs/types";
  12834. import { Plane } from "babylonjs/Maths/math";
  12835. /**
  12836. * Interface used to define entities containing multiple clip planes
  12837. */
  12838. export interface IClipPlanesHolder {
  12839. /**
  12840. * Gets or sets the active clipplane 1
  12841. */
  12842. clipPlane: Nullable<Plane>;
  12843. /**
  12844. * Gets or sets the active clipplane 2
  12845. */
  12846. clipPlane2: Nullable<Plane>;
  12847. /**
  12848. * Gets or sets the active clipplane 3
  12849. */
  12850. clipPlane3: Nullable<Plane>;
  12851. /**
  12852. * Gets or sets the active clipplane 4
  12853. */
  12854. clipPlane4: Nullable<Plane>;
  12855. /**
  12856. * Gets or sets the active clipplane 5
  12857. */
  12858. clipPlane5: Nullable<Plane>;
  12859. /**
  12860. * Gets or sets the active clipplane 6
  12861. */
  12862. clipPlane6: Nullable<Plane>;
  12863. }
  12864. }
  12865. declare module "babylonjs/Materials/thinMaterialHelper" {
  12866. import { Effect } from "babylonjs/Materials/effect";
  12867. import { IClipPlanesHolder } from "babylonjs/Misc/interfaces/iClipPlanesHolder";
  12868. /**
  12869. * "Static Class" containing a few commonly used helper while dealing with material for rendering purpose.
  12870. *
  12871. * It is complementary with MaterialHelper but provides completely independent functions (for tree shaking sake)
  12872. *
  12873. * This works by convention in BabylonJS but is meant to be use only with shader following the in place naming rules and conventions.
  12874. */
  12875. export class ThinMaterialHelper {
  12876. /**
  12877. * Binds the clip plane information from the holder to the effect.
  12878. * @param effect The effect we are binding the data to
  12879. * @param holder The entity containing the clip plane information
  12880. */
  12881. static BindClipPlane(effect: Effect, holder: IClipPlanesHolder): void;
  12882. }
  12883. }
  12884. declare module "babylonjs/Engines/Extensions/engine.alpha" {
  12885. module "babylonjs/Engines/thinEngine" {
  12886. interface ThinEngine {
  12887. /**
  12888. * Sets alpha constants used by some alpha blending modes
  12889. * @param r defines the red component
  12890. * @param g defines the green component
  12891. * @param b defines the blue component
  12892. * @param a defines the alpha component
  12893. */
  12894. setAlphaConstants(r: number, g: number, b: number, a: number): void;
  12895. /**
  12896. * Sets the current alpha mode
  12897. * @param mode defines the mode to use (one of the Engine.ALPHA_XXX)
  12898. * @param noDepthWriteChange defines if depth writing state should remains unchanged (false by default)
  12899. * @see https://doc.babylonjs.com/resources/transparency_and_how_meshes_are_rendered
  12900. */
  12901. setAlphaMode(mode: number, noDepthWriteChange?: boolean): void;
  12902. /**
  12903. * Gets the current alpha mode
  12904. * @see https://doc.babylonjs.com/resources/transparency_and_how_meshes_are_rendered
  12905. * @returns the current alpha mode
  12906. */
  12907. getAlphaMode(): number;
  12908. /**
  12909. * Sets the current alpha equation
  12910. * @param equation defines the equation to use (one of the Engine.ALPHA_EQUATION_XXX)
  12911. */
  12912. setAlphaEquation(equation: number): void;
  12913. /**
  12914. * Gets the current alpha equation.
  12915. * @returns the current alpha equation
  12916. */
  12917. getAlphaEquation(): number;
  12918. }
  12919. }
  12920. }
  12921. declare module "babylonjs/Particles/particleSystem" {
  12922. import { Nullable } from "babylonjs/types";
  12923. import { FactorGradient, Color3Gradient } from "babylonjs/Misc/gradients";
  12924. import { Observable } from "babylonjs/Misc/observable";
  12925. import { Vector3, Matrix } from "babylonjs/Maths/math.vector";
  12926. import { Effect } from "babylonjs/Materials/effect";
  12927. import { IDisposable } from "babylonjs/scene";
  12928. import { IParticleSystem } from "babylonjs/Particles/IParticleSystem";
  12929. import { BaseParticleSystem } from "babylonjs/Particles/baseParticleSystem";
  12930. import { Particle } from "babylonjs/Particles/particle";
  12931. import { SubEmitter } from "babylonjs/Particles/subEmitter";
  12932. import { IAnimatable } from "babylonjs/Animations/animatable.interface";
  12933. import "babylonjs/Shaders/particles.fragment";
  12934. import "babylonjs/Shaders/particles.vertex";
  12935. import { Color4, Color3 } from "babylonjs/Maths/math.color";
  12936. import { ThinEngine } from "babylonjs/Engines/thinEngine";
  12937. import "babylonjs/Engines/Extensions/engine.alpha";
  12938. import { Scene } from "babylonjs/scene";
  12939. /**
  12940. * This represents a particle system in Babylon.
  12941. * 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.
  12942. * Particles can take different shapes while emitted like box, sphere, cone or you can write your custom function.
  12943. * @example https://doc.babylonjs.com/babylon101/particles
  12944. */
  12945. export class ParticleSystem extends BaseParticleSystem implements IDisposable, IAnimatable, IParticleSystem {
  12946. /**
  12947. * Billboard mode will only apply to Y axis
  12948. */
  12949. static readonly BILLBOARDMODE_Y: number;
  12950. /**
  12951. * Billboard mode will apply to all axes
  12952. */
  12953. static readonly BILLBOARDMODE_ALL: number;
  12954. /**
  12955. * Special billboard mode where the particle will be biilboard to the camera but rotated to align with direction
  12956. */
  12957. static readonly BILLBOARDMODE_STRETCHED: number;
  12958. /**
  12959. * This function can be defined to provide custom update for active particles.
  12960. * This function will be called instead of regular update (age, position, color, etc.).
  12961. * Do not forget that this function will be called on every frame so try to keep it simple and fast :)
  12962. */
  12963. updateFunction: (particles: Particle[]) => void;
  12964. private _emitterWorldMatrix;
  12965. /**
  12966. * This function can be defined to specify initial direction for every new particle.
  12967. * It by default use the emitterType defined function
  12968. */
  12969. startDirectionFunction: (worldMatrix: Matrix, directionToUpdate: Vector3, particle: Particle, isLocal: boolean) => void;
  12970. /**
  12971. * This function can be defined to specify initial position for every new particle.
  12972. * It by default use the emitterType defined function
  12973. */
  12974. startPositionFunction: (worldMatrix: Matrix, positionToUpdate: Vector3, particle: Particle, isLocal: boolean) => void;
  12975. /**
  12976. * @hidden
  12977. */
  12978. _inheritedVelocityOffset: Vector3;
  12979. /**
  12980. * An event triggered when the system is disposed
  12981. */
  12982. onDisposeObservable: Observable<IParticleSystem>;
  12983. /**
  12984. * An event triggered when the system is stopped
  12985. */
  12986. onStoppedObservable: Observable<IParticleSystem>;
  12987. private _onDisposeObserver;
  12988. /**
  12989. * Sets a callback that will be triggered when the system is disposed
  12990. */
  12991. set onDispose(callback: () => void);
  12992. private _particles;
  12993. private _epsilon;
  12994. private _capacity;
  12995. private _stockParticles;
  12996. private _newPartsExcess;
  12997. private _vertexData;
  12998. private _vertexBuffer;
  12999. private _vertexBuffers;
  13000. private _spriteBuffer;
  13001. private _indexBuffer;
  13002. private _effect;
  13003. private _customEffect;
  13004. private _cachedDefines;
  13005. private _scaledColorStep;
  13006. private _colorDiff;
  13007. private _scaledDirection;
  13008. private _scaledGravity;
  13009. private _currentRenderId;
  13010. private _alive;
  13011. private _useInstancing;
  13012. private _vertexArrayObject;
  13013. private _started;
  13014. private _stopped;
  13015. private _actualFrame;
  13016. private _scaledUpdateSpeed;
  13017. private _vertexBufferSize;
  13018. /** @hidden */
  13019. _currentEmitRateGradient: Nullable<FactorGradient>;
  13020. /** @hidden */
  13021. _currentEmitRate1: number;
  13022. /** @hidden */
  13023. _currentEmitRate2: number;
  13024. /** @hidden */
  13025. _currentStartSizeGradient: Nullable<FactorGradient>;
  13026. /** @hidden */
  13027. _currentStartSize1: number;
  13028. /** @hidden */
  13029. _currentStartSize2: number;
  13030. private readonly _rawTextureWidth;
  13031. private _rampGradientsTexture;
  13032. private _useRampGradients;
  13033. /** Gets or sets a matrix to use to compute projection */
  13034. defaultProjectionMatrix: Matrix;
  13035. /** Gets or sets a matrix to use to compute view */
  13036. defaultViewMatrix: Matrix;
  13037. /** Gets or sets a boolean indicating that ramp gradients must be used
  13038. * @see https://doc.babylonjs.com/babylon101/particles#ramp-gradients
  13039. */
  13040. get useRampGradients(): boolean;
  13041. set useRampGradients(value: boolean);
  13042. /**
  13043. * 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.
  13044. * 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: [])
  13045. */
  13046. subEmitters: Array<ParticleSystem | SubEmitter | Array<SubEmitter>>;
  13047. private _subEmitters;
  13048. /**
  13049. * @hidden
  13050. * If the particle systems emitter should be disposed when the particle system is disposed
  13051. */
  13052. _disposeEmitterOnDispose: boolean;
  13053. /**
  13054. * The current active Sub-systems, this property is used by the root particle system only.
  13055. */
  13056. activeSubSystems: Array<ParticleSystem>;
  13057. /**
  13058. * Specifies if the particles are updated in emitter local space or world space
  13059. */
  13060. isLocal: boolean;
  13061. private _rootParticleSystem;
  13062. /**
  13063. * Gets the current list of active particles
  13064. */
  13065. get particles(): Particle[];
  13066. /**
  13067. * Gets the number of particles active at the same time.
  13068. * @returns The number of active particles.
  13069. */
  13070. getActiveCount(): number;
  13071. /**
  13072. * Returns the string "ParticleSystem"
  13073. * @returns a string containing the class name
  13074. */
  13075. getClassName(): string;
  13076. /**
  13077. * Gets a boolean indicating that the system is stopping
  13078. * @returns true if the system is currently stopping
  13079. */
  13080. isStopping(): boolean;
  13081. /**
  13082. * Gets the custom effect used to render the particles
  13083. * @param blendMode Blend mode for which the effect should be retrieved
  13084. * @returns The effect
  13085. */
  13086. getCustomEffect(blendMode?: number): Nullable<Effect>;
  13087. /**
  13088. * Sets the custom effect used to render the particles
  13089. * @param effect The effect to set
  13090. * @param blendMode Blend mode for which the effect should be set
  13091. */
  13092. setCustomEffect(effect: Nullable<Effect>, blendMode?: number): void;
  13093. /** @hidden */
  13094. private _onBeforeDrawParticlesObservable;
  13095. /**
  13096. * Observable that will be called just before the particles are drawn
  13097. */
  13098. get onBeforeDrawParticlesObservable(): Observable<Nullable<Effect>>;
  13099. /**
  13100. * Gets the name of the particle vertex shader
  13101. */
  13102. get vertexShaderName(): string;
  13103. /**
  13104. * Instantiates a particle system.
  13105. * 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.
  13106. * @param name The name of the particle system
  13107. * @param capacity The max number of particles alive at the same time
  13108. * @param sceneOrEngine The scene the particle system belongs to or the engine to use if no scene
  13109. * @param customEffect a custom effect used to change the way particles are rendered by default
  13110. * @param isAnimationSheetEnabled Must be true if using a spritesheet to animate the particles texture
  13111. * @param epsilon Offset used to render the particles
  13112. */
  13113. constructor(name: string, capacity: number, sceneOrEngine: Scene | ThinEngine, customEffect?: Nullable<Effect>, isAnimationSheetEnabled?: boolean, epsilon?: number);
  13114. private _addFactorGradient;
  13115. private _removeFactorGradient;
  13116. /**
  13117. * Adds a new life time gradient
  13118. * @param gradient defines the gradient to use (between 0 and 1)
  13119. * @param factor defines the life time factor to affect to the specified gradient
  13120. * @param factor2 defines an additional factor used to define a range ([factor, factor2]) with main value to pick the final value from
  13121. * @returns the current particle system
  13122. */
  13123. addLifeTimeGradient(gradient: number, factor: number, factor2?: number): IParticleSystem;
  13124. /**
  13125. * Remove a specific life time gradient
  13126. * @param gradient defines the gradient to remove
  13127. * @returns the current particle system
  13128. */
  13129. removeLifeTimeGradient(gradient: number): IParticleSystem;
  13130. /**
  13131. * Adds a new size gradient
  13132. * @param gradient defines the gradient to use (between 0 and 1)
  13133. * @param factor defines the size factor to affect to the specified gradient
  13134. * @param factor2 defines an additional factor used to define a range ([factor, factor2]) with main value to pick the final value from
  13135. * @returns the current particle system
  13136. */
  13137. addSizeGradient(gradient: number, factor: number, factor2?: number): IParticleSystem;
  13138. /**
  13139. * Remove a specific size gradient
  13140. * @param gradient defines the gradient to remove
  13141. * @returns the current particle system
  13142. */
  13143. removeSizeGradient(gradient: number): IParticleSystem;
  13144. /**
  13145. * Adds a new color remap gradient
  13146. * @param gradient defines the gradient to use (between 0 and 1)
  13147. * @param min defines the color remap minimal range
  13148. * @param max defines the color remap maximal range
  13149. * @returns the current particle system
  13150. */
  13151. addColorRemapGradient(gradient: number, min: number, max: number): IParticleSystem;
  13152. /**
  13153. * Remove a specific color remap gradient
  13154. * @param gradient defines the gradient to remove
  13155. * @returns the current particle system
  13156. */
  13157. removeColorRemapGradient(gradient: number): IParticleSystem;
  13158. /**
  13159. * Adds a new alpha remap gradient
  13160. * @param gradient defines the gradient to use (between 0 and 1)
  13161. * @param min defines the alpha remap minimal range
  13162. * @param max defines the alpha remap maximal range
  13163. * @returns the current particle system
  13164. */
  13165. addAlphaRemapGradient(gradient: number, min: number, max: number): IParticleSystem;
  13166. /**
  13167. * Remove a specific alpha remap gradient
  13168. * @param gradient defines the gradient to remove
  13169. * @returns the current particle system
  13170. */
  13171. removeAlphaRemapGradient(gradient: number): IParticleSystem;
  13172. /**
  13173. * Adds a new angular speed gradient
  13174. * @param gradient defines the gradient to use (between 0 and 1)
  13175. * @param factor defines the angular speed to affect to the specified gradient
  13176. * @param factor2 defines an additional factor used to define a range ([factor, factor2]) with main value to pick the final value from
  13177. * @returns the current particle system
  13178. */
  13179. addAngularSpeedGradient(gradient: number, factor: number, factor2?: number): IParticleSystem;
  13180. /**
  13181. * Remove a specific angular speed gradient
  13182. * @param gradient defines the gradient to remove
  13183. * @returns the current particle system
  13184. */
  13185. removeAngularSpeedGradient(gradient: number): IParticleSystem;
  13186. /**
  13187. * Adds a new velocity gradient
  13188. * @param gradient defines the gradient to use (between 0 and 1)
  13189. * @param factor defines the velocity to affect to the specified gradient
  13190. * @param factor2 defines an additional factor used to define a range ([factor, factor2]) with main value to pick the final value from
  13191. * @returns the current particle system
  13192. */
  13193. addVelocityGradient(gradient: number, factor: number, factor2?: number): IParticleSystem;
  13194. /**
  13195. * Remove a specific velocity gradient
  13196. * @param gradient defines the gradient to remove
  13197. * @returns the current particle system
  13198. */
  13199. removeVelocityGradient(gradient: number): IParticleSystem;
  13200. /**
  13201. * Adds a new limit velocity gradient
  13202. * @param gradient defines the gradient to use (between 0 and 1)
  13203. * @param factor defines the limit velocity value to affect to the specified gradient
  13204. * @param factor2 defines an additional factor used to define a range ([factor, factor2]) with main value to pick the final value from
  13205. * @returns the current particle system
  13206. */
  13207. addLimitVelocityGradient(gradient: number, factor: number, factor2?: number): IParticleSystem;
  13208. /**
  13209. * Remove a specific limit velocity gradient
  13210. * @param gradient defines the gradient to remove
  13211. * @returns the current particle system
  13212. */
  13213. removeLimitVelocityGradient(gradient: number): IParticleSystem;
  13214. /**
  13215. * Adds a new drag gradient
  13216. * @param gradient defines the gradient to use (between 0 and 1)
  13217. * @param factor defines the drag value to affect to the specified gradient
  13218. * @param factor2 defines an additional factor used to define a range ([factor, factor2]) with main value to pick the final value from
  13219. * @returns the current particle system
  13220. */
  13221. addDragGradient(gradient: number, factor: number, factor2?: number): IParticleSystem;
  13222. /**
  13223. * Remove a specific drag gradient
  13224. * @param gradient defines the gradient to remove
  13225. * @returns the current particle system
  13226. */
  13227. removeDragGradient(gradient: number): IParticleSystem;
  13228. /**
  13229. * Adds a new emit rate gradient (please note that this will only work if you set the targetStopDuration property)
  13230. * @param gradient defines the gradient to use (between 0 and 1)
  13231. * @param factor defines the emit rate value to affect to the specified gradient
  13232. * @param factor2 defines an additional factor used to define a range ([factor, factor2]) with main value to pick the final value from
  13233. * @returns the current particle system
  13234. */
  13235. addEmitRateGradient(gradient: number, factor: number, factor2?: number): IParticleSystem;
  13236. /**
  13237. * Remove a specific emit rate gradient
  13238. * @param gradient defines the gradient to remove
  13239. * @returns the current particle system
  13240. */
  13241. removeEmitRateGradient(gradient: number): IParticleSystem;
  13242. /**
  13243. * Adds a new start size gradient (please note that this will only work if you set the targetStopDuration property)
  13244. * @param gradient defines the gradient to use (between 0 and 1)
  13245. * @param factor defines the start size value to affect to the specified gradient
  13246. * @param factor2 defines an additional factor used to define a range ([factor, factor2]) with main value to pick the final value from
  13247. * @returns the current particle system
  13248. */
  13249. addStartSizeGradient(gradient: number, factor: number, factor2?: number): IParticleSystem;
  13250. /**
  13251. * Remove a specific start size gradient
  13252. * @param gradient defines the gradient to remove
  13253. * @returns the current particle system
  13254. */
  13255. removeStartSizeGradient(gradient: number): IParticleSystem;
  13256. private _createRampGradientTexture;
  13257. /**
  13258. * Gets the current list of ramp gradients.
  13259. * You must use addRampGradient and removeRampGradient to udpate this list
  13260. * @returns the list of ramp gradients
  13261. */
  13262. getRampGradients(): Nullable<Array<Color3Gradient>>;
  13263. /** Force the system to rebuild all gradients that need to be resync */
  13264. forceRefreshGradients(): void;
  13265. private _syncRampGradientTexture;
  13266. /**
  13267. * Adds a new ramp gradient used to remap particle colors
  13268. * @param gradient defines the gradient to use (between 0 and 1)
  13269. * @param color defines the color to affect to the specified gradient
  13270. * @returns the current particle system
  13271. */
  13272. addRampGradient(gradient: number, color: Color3): ParticleSystem;
  13273. /**
  13274. * Remove a specific ramp gradient
  13275. * @param gradient defines the gradient to remove
  13276. * @returns the current particle system
  13277. */
  13278. removeRampGradient(gradient: number): ParticleSystem;
  13279. /**
  13280. * Adds a new color gradient
  13281. * @param gradient defines the gradient to use (between 0 and 1)
  13282. * @param color1 defines the color to affect to the specified gradient
  13283. * @param color2 defines an additional color used to define a range ([color, color2]) with main color to pick the final color from
  13284. * @returns this particle system
  13285. */
  13286. addColorGradient(gradient: number, color1: Color4, color2?: Color4): IParticleSystem;
  13287. /**
  13288. * Remove a specific color gradient
  13289. * @param gradient defines the gradient to remove
  13290. * @returns this particle system
  13291. */
  13292. removeColorGradient(gradient: number): IParticleSystem;
  13293. private _fetchR;
  13294. protected _reset(): void;
  13295. private _resetEffect;
  13296. private _createVertexBuffers;
  13297. private _createIndexBuffer;
  13298. /**
  13299. * Gets the maximum number of particles active at the same time.
  13300. * @returns The max number of active particles.
  13301. */
  13302. getCapacity(): number;
  13303. /**
  13304. * Gets whether there are still active particles in the system.
  13305. * @returns True if it is alive, otherwise false.
  13306. */
  13307. isAlive(): boolean;
  13308. /**
  13309. * Gets if the system has been started. (Note: this will still be true after stop is called)
  13310. * @returns True if it has been started, otherwise false.
  13311. */
  13312. isStarted(): boolean;
  13313. private _prepareSubEmitterInternalArray;
  13314. /**
  13315. * Starts the particle system and begins to emit
  13316. * @param delay defines the delay in milliseconds before starting the system (this.startDelay by default)
  13317. */
  13318. start(delay?: number): void;
  13319. /**
  13320. * Stops the particle system.
  13321. * @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.
  13322. */
  13323. stop(stopSubEmitters?: boolean): void;
  13324. /**
  13325. * Remove all active particles
  13326. */
  13327. reset(): void;
  13328. /**
  13329. * @hidden (for internal use only)
  13330. */
  13331. _appendParticleVertex(index: number, particle: Particle, offsetX: number, offsetY: number): void;
  13332. /**
  13333. * "Recycles" one of the particle by copying it back to the "stock" of particles and removing it from the active list.
  13334. * Its lifetime will start back at 0.
  13335. */
  13336. recycleParticle: (particle: Particle) => void;
  13337. private _stopSubEmitters;
  13338. private _createParticle;
  13339. private _removeFromRoot;
  13340. private _emitFromParticle;
  13341. private _update;
  13342. /** @hidden */
  13343. static _GetAttributeNamesOrOptions(isAnimationSheetEnabled?: boolean, isBillboardBased?: boolean, useRampGradients?: boolean): string[];
  13344. /** @hidden */
  13345. static _GetEffectCreationOptions(isAnimationSheetEnabled?: boolean): string[];
  13346. /**
  13347. * Fill the defines array according to the current settings of the particle system
  13348. * @param defines Array to be updated
  13349. * @param blendMode blend mode to take into account when updating the array
  13350. */
  13351. fillDefines(defines: Array<string>, blendMode: number): void;
  13352. /**
  13353. * Fill the uniforms, attributes and samplers arrays according to the current settings of the particle system
  13354. * @param uniforms Uniforms array to fill
  13355. * @param attributes Attributes array to fill
  13356. * @param samplers Samplers array to fill
  13357. */
  13358. fillUniformsAttributesAndSamplerNames(uniforms: Array<string>, attributes: Array<string>, samplers: Array<string>): void;
  13359. /** @hidden */
  13360. private _getEffect;
  13361. /**
  13362. * Animates the particle system for the current frame by emitting new particles and or animating the living ones.
  13363. * @param preWarmOnly will prevent the system from updating the vertex buffer (default is false)
  13364. */
  13365. animate(preWarmOnly?: boolean): void;
  13366. private _appendParticleVertices;
  13367. /**
  13368. * Rebuilds the particle system.
  13369. */
  13370. rebuild(): void;
  13371. /**
  13372. * Is this system ready to be used/rendered
  13373. * @return true if the system is ready
  13374. */
  13375. isReady(): boolean;
  13376. private _render;
  13377. /**
  13378. * Renders the particle system in its current state.
  13379. * @returns the current number of particles
  13380. */
  13381. render(): number;
  13382. /**
  13383. * Disposes the particle system and free the associated resources
  13384. * @param disposeTexture defines if the particule texture must be disposed as well (true by default)
  13385. */
  13386. dispose(disposeTexture?: boolean): void;
  13387. /**
  13388. * Clones the particle system.
  13389. * @param name The name of the cloned object
  13390. * @param newEmitter The new emitter to use
  13391. * @returns the cloned particle system
  13392. */
  13393. clone(name: string, newEmitter: any): ParticleSystem;
  13394. /**
  13395. * Serializes the particle system to a JSON object
  13396. * @param serializeTexture defines if the texture must be serialized as well
  13397. * @returns the JSON object
  13398. */
  13399. serialize(serializeTexture?: boolean): any;
  13400. /** @hidden */
  13401. static _Serialize(serializationObject: any, particleSystem: IParticleSystem, serializeTexture: boolean): void;
  13402. /** @hidden */
  13403. static _Parse(parsedParticleSystem: any, particleSystem: IParticleSystem, sceneOrEngine: Scene | ThinEngine, rootUrl: string): void;
  13404. /**
  13405. * Parses a JSON object to create a particle system.
  13406. * @param parsedParticleSystem The JSON object to parse
  13407. * @param sceneOrEngine The scene or the engine to create the particle system in
  13408. * @param rootUrl The root url to use to load external dependencies like texture
  13409. * @param doNotStart Ignore the preventAutoStart attribute and does not start
  13410. * @returns the Parsed particle system
  13411. */
  13412. static Parse(parsedParticleSystem: any, sceneOrEngine: Scene | ThinEngine, rootUrl: string, doNotStart?: boolean): ParticleSystem;
  13413. }
  13414. }
  13415. declare module "babylonjs/Particles/particle" {
  13416. import { Nullable } from "babylonjs/types";
  13417. import { Vector2, Vector3, Vector4 } from "babylonjs/Maths/math.vector";
  13418. import { Color4 } from "babylonjs/Maths/math.color";
  13419. import { ParticleSystem } from "babylonjs/Particles/particleSystem";
  13420. import { SubEmitter } from "babylonjs/Particles/subEmitter";
  13421. import { ColorGradient, FactorGradient } from "babylonjs/Misc/gradients";
  13422. /**
  13423. * A particle represents one of the element emitted by a particle system.
  13424. * This is mainly define by its coordinates, direction, velocity and age.
  13425. */
  13426. export class Particle {
  13427. /**
  13428. * The particle system the particle belongs to.
  13429. */
  13430. particleSystem: ParticleSystem;
  13431. private static _Count;
  13432. /**
  13433. * Unique ID of the particle
  13434. */
  13435. id: number;
  13436. /**
  13437. * The world position of the particle in the scene.
  13438. */
  13439. position: Vector3;
  13440. /**
  13441. * The world direction of the particle in the scene.
  13442. */
  13443. direction: Vector3;
  13444. /**
  13445. * The color of the particle.
  13446. */
  13447. color: Color4;
  13448. /**
  13449. * The color change of the particle per step.
  13450. */
  13451. colorStep: Color4;
  13452. /**
  13453. * Defines how long will the life of the particle be.
  13454. */
  13455. lifeTime: number;
  13456. /**
  13457. * The current age of the particle.
  13458. */
  13459. age: number;
  13460. /**
  13461. * The current size of the particle.
  13462. */
  13463. size: number;
  13464. /**
  13465. * The current scale of the particle.
  13466. */
  13467. scale: Vector2;
  13468. /**
  13469. * The current angle of the particle.
  13470. */
  13471. angle: number;
  13472. /**
  13473. * Defines how fast is the angle changing.
  13474. */
  13475. angularSpeed: number;
  13476. /**
  13477. * Defines the cell index used by the particle to be rendered from a sprite.
  13478. */
  13479. cellIndex: number;
  13480. /**
  13481. * The information required to support color remapping
  13482. */
  13483. remapData: Vector4;
  13484. /** @hidden */
  13485. _randomCellOffset?: number;
  13486. /** @hidden */
  13487. _initialDirection: Nullable<Vector3>;
  13488. /** @hidden */
  13489. _attachedSubEmitters: Nullable<Array<SubEmitter>>;
  13490. /** @hidden */
  13491. _initialStartSpriteCellID: number;
  13492. /** @hidden */
  13493. _initialEndSpriteCellID: number;
  13494. /** @hidden */
  13495. _currentColorGradient: Nullable<ColorGradient>;
  13496. /** @hidden */
  13497. _currentColor1: Color4;
  13498. /** @hidden */
  13499. _currentColor2: Color4;
  13500. /** @hidden */
  13501. _currentSizeGradient: Nullable<FactorGradient>;
  13502. /** @hidden */
  13503. _currentSize1: number;
  13504. /** @hidden */
  13505. _currentSize2: number;
  13506. /** @hidden */
  13507. _currentAngularSpeedGradient: Nullable<FactorGradient>;
  13508. /** @hidden */
  13509. _currentAngularSpeed1: number;
  13510. /** @hidden */
  13511. _currentAngularSpeed2: number;
  13512. /** @hidden */
  13513. _currentVelocityGradient: Nullable<FactorGradient>;
  13514. /** @hidden */
  13515. _currentVelocity1: number;
  13516. /** @hidden */
  13517. _currentVelocity2: number;
  13518. /** @hidden */
  13519. _currentLimitVelocityGradient: Nullable<FactorGradient>;
  13520. /** @hidden */
  13521. _currentLimitVelocity1: number;
  13522. /** @hidden */
  13523. _currentLimitVelocity2: number;
  13524. /** @hidden */
  13525. _currentDragGradient: Nullable<FactorGradient>;
  13526. /** @hidden */
  13527. _currentDrag1: number;
  13528. /** @hidden */
  13529. _currentDrag2: number;
  13530. /** @hidden */
  13531. _randomNoiseCoordinates1: Vector3;
  13532. /** @hidden */
  13533. _randomNoiseCoordinates2: Vector3;
  13534. /** @hidden */
  13535. _localPosition?: Vector3;
  13536. /**
  13537. * Creates a new instance Particle
  13538. * @param particleSystem the particle system the particle belongs to
  13539. */
  13540. constructor(
  13541. /**
  13542. * The particle system the particle belongs to.
  13543. */
  13544. particleSystem: ParticleSystem);
  13545. private updateCellInfoFromSystem;
  13546. /**
  13547. * Defines how the sprite cell index is updated for the particle
  13548. */
  13549. updateCellIndex(): void;
  13550. /** @hidden */
  13551. _inheritParticleInfoToSubEmitter(subEmitter: SubEmitter): void;
  13552. /** @hidden */
  13553. _inheritParticleInfoToSubEmitters(): void;
  13554. /** @hidden */
  13555. _reset(): void;
  13556. /**
  13557. * Copy the properties of particle to another one.
  13558. * @param other the particle to copy the information to.
  13559. */
  13560. copyTo(other: Particle): void;
  13561. }
  13562. }
  13563. declare module "babylonjs/Particles/EmitterTypes/IParticleEmitterType" {
  13564. import { Vector3, Matrix } from "babylonjs/Maths/math.vector";
  13565. import { Effect } from "babylonjs/Materials/effect";
  13566. import { Particle } from "babylonjs/Particles/particle";
  13567. import { Nullable } from "babylonjs/types";
  13568. import { Scene } from "babylonjs/scene";
  13569. /**
  13570. * Particle emitter represents a volume emitting particles.
  13571. * This is the responsibility of the implementation to define the volume shape like cone/sphere/box.
  13572. */
  13573. export interface IParticleEmitterType {
  13574. /**
  13575. * Called by the particle System when the direction is computed for the created particle.
  13576. * @param worldMatrix is the world matrix of the particle system
  13577. * @param directionToUpdate is the direction vector to update with the result
  13578. * @param particle is the particle we are computed the direction for
  13579. * @param isLocal defines if the direction should be set in local space
  13580. */
  13581. startDirectionFunction(worldMatrix: Matrix, directionToUpdate: Vector3, particle: Particle, isLocal: boolean): void;
  13582. /**
  13583. * Called by the particle System when the position is computed for the created particle.
  13584. * @param worldMatrix is the world matrix of the particle system
  13585. * @param positionToUpdate is the position vector to update with the result
  13586. * @param particle is the particle we are computed the position for
  13587. * @param isLocal defines if the position should be set in local space
  13588. */
  13589. startPositionFunction(worldMatrix: Matrix, positionToUpdate: Vector3, particle: Particle, isLocal: boolean): void;
  13590. /**
  13591. * Clones the current emitter and returns a copy of it
  13592. * @returns the new emitter
  13593. */
  13594. clone(): IParticleEmitterType;
  13595. /**
  13596. * Called by the GPUParticleSystem to setup the update shader
  13597. * @param effect defines the update shader
  13598. */
  13599. applyToShader(effect: Effect): void;
  13600. /**
  13601. * Returns a string to use to update the GPU particles update shader
  13602. * @returns the effect defines string
  13603. */
  13604. getEffectDefines(): string;
  13605. /**
  13606. * Returns a string representing the class name
  13607. * @returns a string containing the class name
  13608. */
  13609. getClassName(): string;
  13610. /**
  13611. * Serializes the particle system to a JSON object.
  13612. * @returns the JSON object
  13613. */
  13614. serialize(): any;
  13615. /**
  13616. * Parse properties from a JSON object
  13617. * @param serializationObject defines the JSON object
  13618. * @param scene defines the hosting scene
  13619. */
  13620. parse(serializationObject: any, scene: Nullable<Scene>): void;
  13621. }
  13622. }
  13623. declare module "babylonjs/Particles/EmitterTypes/boxParticleEmitter" {
  13624. import { Vector3, Matrix } from "babylonjs/Maths/math.vector";
  13625. import { Effect } from "babylonjs/Materials/effect";
  13626. import { Particle } from "babylonjs/Particles/particle";
  13627. import { IParticleEmitterType } from "babylonjs/Particles/EmitterTypes/IParticleEmitterType";
  13628. /**
  13629. * Particle emitter emitting particles from the inside of a box.
  13630. * It emits the particles randomly between 2 given directions.
  13631. */
  13632. export class BoxParticleEmitter implements IParticleEmitterType {
  13633. /**
  13634. * Random direction of each particle after it has been emitted, between direction1 and direction2 vectors.
  13635. */
  13636. direction1: Vector3;
  13637. /**
  13638. * Random direction of each particle after it has been emitted, between direction1 and direction2 vectors.
  13639. */
  13640. direction2: Vector3;
  13641. /**
  13642. * 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.
  13643. */
  13644. minEmitBox: Vector3;
  13645. /**
  13646. * 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.
  13647. */
  13648. maxEmitBox: Vector3;
  13649. /**
  13650. * Creates a new instance BoxParticleEmitter
  13651. */
  13652. constructor();
  13653. /**
  13654. * Called by the particle System when the direction is computed for the created particle.
  13655. * @param worldMatrix is the world matrix of the particle system
  13656. * @param directionToUpdate is the direction vector to update with the result
  13657. * @param particle is the particle we are computed the direction for
  13658. * @param isLocal defines if the direction should be set in local space
  13659. */
  13660. startDirectionFunction(worldMatrix: Matrix, directionToUpdate: Vector3, particle: Particle, isLocal: boolean): void;
  13661. /**
  13662. * Called by the particle System when the position is computed for the created particle.
  13663. * @param worldMatrix is the world matrix of the particle system
  13664. * @param positionToUpdate is the position vector to update with the result
  13665. * @param particle is the particle we are computed the position for
  13666. * @param isLocal defines if the position should be set in local space
  13667. */
  13668. startPositionFunction(worldMatrix: Matrix, positionToUpdate: Vector3, particle: Particle, isLocal: boolean): void;
  13669. /**
  13670. * Clones the current emitter and returns a copy of it
  13671. * @returns the new emitter
  13672. */
  13673. clone(): BoxParticleEmitter;
  13674. /**
  13675. * Called by the GPUParticleSystem to setup the update shader
  13676. * @param effect defines the update shader
  13677. */
  13678. applyToShader(effect: Effect): void;
  13679. /**
  13680. * Returns a string to use to update the GPU particles update shader
  13681. * @returns a string containng the defines string
  13682. */
  13683. getEffectDefines(): string;
  13684. /**
  13685. * Returns the string "BoxParticleEmitter"
  13686. * @returns a string containing the class name
  13687. */
  13688. getClassName(): string;
  13689. /**
  13690. * Serializes the particle system to a JSON object.
  13691. * @returns the JSON object
  13692. */
  13693. serialize(): any;
  13694. /**
  13695. * Parse properties from a JSON object
  13696. * @param serializationObject defines the JSON object
  13697. */
  13698. parse(serializationObject: any): void;
  13699. }
  13700. }
  13701. declare module "babylonjs/Particles/EmitterTypes/coneParticleEmitter" {
  13702. import { Vector3, Matrix } from "babylonjs/Maths/math.vector";
  13703. import { Effect } from "babylonjs/Materials/effect";
  13704. import { Particle } from "babylonjs/Particles/particle";
  13705. import { IParticleEmitterType } from "babylonjs/Particles/EmitterTypes/IParticleEmitterType";
  13706. /**
  13707. * Particle emitter emitting particles from the inside of a cone.
  13708. * It emits the particles alongside the cone volume from the base to the particle.
  13709. * The emission direction might be randomized.
  13710. */
  13711. export class ConeParticleEmitter implements IParticleEmitterType {
  13712. /** defines how much to randomize the particle direction [0-1] (default is 0) */
  13713. directionRandomizer: number;
  13714. private _radius;
  13715. private _angle;
  13716. private _height;
  13717. /**
  13718. * Gets or sets a value indicating where on the radius the start position should be picked (1 = everywhere, 0 = only surface)
  13719. */
  13720. radiusRange: number;
  13721. /**
  13722. * Gets or sets a value indicating where on the height the start position should be picked (1 = everywhere, 0 = only surface)
  13723. */
  13724. heightRange: number;
  13725. /**
  13726. * Gets or sets a value indicating if all the particles should be emitted from the spawn point only (the base of the cone)
  13727. */
  13728. emitFromSpawnPointOnly: boolean;
  13729. /**
  13730. * Gets or sets the radius of the emission cone
  13731. */
  13732. get radius(): number;
  13733. set radius(value: number);
  13734. /**
  13735. * Gets or sets the angle of the emission cone
  13736. */
  13737. get angle(): number;
  13738. set angle(value: number);
  13739. private _buildHeight;
  13740. /**
  13741. * Creates a new instance ConeParticleEmitter
  13742. * @param radius the radius of the emission cone (1 by default)
  13743. * @param angle the cone base angle (PI by default)
  13744. * @param directionRandomizer defines how much to randomize the particle direction [0-1] (default is 0)
  13745. */
  13746. constructor(radius?: number, angle?: number,
  13747. /** defines how much to randomize the particle direction [0-1] (default is 0) */
  13748. directionRandomizer?: number);
  13749. /**
  13750. * Called by the particle System when the direction is computed for the created particle.
  13751. * @param worldMatrix is the world matrix of the particle system
  13752. * @param directionToUpdate is the direction vector to update with the result
  13753. * @param particle is the particle we are computed the direction for
  13754. * @param isLocal defines if the direction should be set in local space
  13755. */
  13756. startDirectionFunction(worldMatrix: Matrix, directionToUpdate: Vector3, particle: Particle, isLocal: boolean): void;
  13757. /**
  13758. * Called by the particle System when the position is computed for the created particle.
  13759. * @param worldMatrix is the world matrix of the particle system
  13760. * @param positionToUpdate is the position vector to update with the result
  13761. * @param particle is the particle we are computed the position for
  13762. * @param isLocal defines if the position should be set in local space
  13763. */
  13764. startPositionFunction(worldMatrix: Matrix, positionToUpdate: Vector3, particle: Particle, isLocal: boolean): void;
  13765. /**
  13766. * Clones the current emitter and returns a copy of it
  13767. * @returns the new emitter
  13768. */
  13769. clone(): ConeParticleEmitter;
  13770. /**
  13771. * Called by the GPUParticleSystem to setup the update shader
  13772. * @param effect defines the update shader
  13773. */
  13774. applyToShader(effect: Effect): void;
  13775. /**
  13776. * Returns a string to use to update the GPU particles update shader
  13777. * @returns a string containng the defines string
  13778. */
  13779. getEffectDefines(): string;
  13780. /**
  13781. * Returns the string "ConeParticleEmitter"
  13782. * @returns a string containing the class name
  13783. */
  13784. getClassName(): string;
  13785. /**
  13786. * Serializes the particle system to a JSON object.
  13787. * @returns the JSON object
  13788. */
  13789. serialize(): any;
  13790. /**
  13791. * Parse properties from a JSON object
  13792. * @param serializationObject defines the JSON object
  13793. */
  13794. parse(serializationObject: any): void;
  13795. }
  13796. }
  13797. declare module "babylonjs/Particles/EmitterTypes/cylinderParticleEmitter" {
  13798. import { Vector3, Matrix } from "babylonjs/Maths/math.vector";
  13799. import { Effect } from "babylonjs/Materials/effect";
  13800. import { Particle } from "babylonjs/Particles/particle";
  13801. import { IParticleEmitterType } from "babylonjs/Particles/EmitterTypes/IParticleEmitterType";
  13802. /**
  13803. * Particle emitter emitting particles from the inside of a cylinder.
  13804. * It emits the particles alongside the cylinder radius. The emission direction might be randomized.
  13805. */
  13806. export class CylinderParticleEmitter implements IParticleEmitterType {
  13807. /**
  13808. * The radius of the emission cylinder.
  13809. */
  13810. radius: number;
  13811. /**
  13812. * The height of the emission cylinder.
  13813. */
  13814. height: number;
  13815. /**
  13816. * The range of emission [0-1] 0 Surface only, 1 Entire Radius.
  13817. */
  13818. radiusRange: number;
  13819. /**
  13820. * How much to randomize the particle direction [0-1].
  13821. */
  13822. directionRandomizer: number;
  13823. /**
  13824. * Creates a new instance CylinderParticleEmitter
  13825. * @param radius the radius of the emission cylinder (1 by default)
  13826. * @param height the height of the emission cylinder (1 by default)
  13827. * @param radiusRange the range of the emission cylinder [0-1] 0 Surface only, 1 Entire Radius (1 by default)
  13828. * @param directionRandomizer defines how much to randomize the particle direction [0-1]
  13829. */
  13830. constructor(
  13831. /**
  13832. * The radius of the emission cylinder.
  13833. */
  13834. radius?: number,
  13835. /**
  13836. * The height of the emission cylinder.
  13837. */
  13838. height?: number,
  13839. /**
  13840. * The range of emission [0-1] 0 Surface only, 1 Entire Radius.
  13841. */
  13842. radiusRange?: number,
  13843. /**
  13844. * How much to randomize the particle direction [0-1].
  13845. */
  13846. directionRandomizer?: number);
  13847. /**
  13848. * Called by the particle System when the direction is computed for the created particle.
  13849. * @param worldMatrix is the world matrix of the particle system
  13850. * @param directionToUpdate is the direction vector to update with the result
  13851. * @param particle is the particle we are computed the direction for
  13852. * @param isLocal defines if the direction should be set in local space
  13853. */
  13854. startDirectionFunction(worldMatrix: Matrix, directionToUpdate: Vector3, particle: Particle, isLocal: boolean): void;
  13855. /**
  13856. * Called by the particle System when the position is computed for the created particle.
  13857. * @param worldMatrix is the world matrix of the particle system
  13858. * @param positionToUpdate is the position vector to update with the result
  13859. * @param particle is the particle we are computed the position for
  13860. * @param isLocal defines if the position should be set in local space
  13861. */
  13862. startPositionFunction(worldMatrix: Matrix, positionToUpdate: Vector3, particle: Particle, isLocal: boolean): void;
  13863. /**
  13864. * Clones the current emitter and returns a copy of it
  13865. * @returns the new emitter
  13866. */
  13867. clone(): CylinderParticleEmitter;
  13868. /**
  13869. * Called by the GPUParticleSystem to setup the update shader
  13870. * @param effect defines the update shader
  13871. */
  13872. applyToShader(effect: Effect): void;
  13873. /**
  13874. * Returns a string to use to update the GPU particles update shader
  13875. * @returns a string containng the defines string
  13876. */
  13877. getEffectDefines(): string;
  13878. /**
  13879. * Returns the string "CylinderParticleEmitter"
  13880. * @returns a string containing the class name
  13881. */
  13882. getClassName(): string;
  13883. /**
  13884. * Serializes the particle system to a JSON object.
  13885. * @returns the JSON object
  13886. */
  13887. serialize(): any;
  13888. /**
  13889. * Parse properties from a JSON object
  13890. * @param serializationObject defines the JSON object
  13891. */
  13892. parse(serializationObject: any): void;
  13893. }
  13894. /**
  13895. * Particle emitter emitting particles from the inside of a cylinder.
  13896. * It emits the particles randomly between two vectors.
  13897. */
  13898. export class CylinderDirectedParticleEmitter extends CylinderParticleEmitter {
  13899. /**
  13900. * The min limit of the emission direction.
  13901. */
  13902. direction1: Vector3;
  13903. /**
  13904. * The max limit of the emission direction.
  13905. */
  13906. direction2: Vector3;
  13907. /**
  13908. * Creates a new instance CylinderDirectedParticleEmitter
  13909. * @param radius the radius of the emission cylinder (1 by default)
  13910. * @param height the height of the emission cylinder (1 by default)
  13911. * @param radiusRange the range of the emission cylinder [0-1] 0 Surface only, 1 Entire Radius (1 by default)
  13912. * @param direction1 the min limit of the emission direction (up vector by default)
  13913. * @param direction2 the max limit of the emission direction (up vector by default)
  13914. */
  13915. constructor(radius?: number, height?: number, radiusRange?: number,
  13916. /**
  13917. * The min limit of the emission direction.
  13918. */
  13919. direction1?: Vector3,
  13920. /**
  13921. * The max limit of the emission direction.
  13922. */
  13923. direction2?: Vector3);
  13924. /**
  13925. * Called by the particle System when the direction is computed for the created particle.
  13926. * @param worldMatrix is the world matrix of the particle system
  13927. * @param directionToUpdate is the direction vector to update with the result
  13928. * @param particle is the particle we are computed the direction for
  13929. */
  13930. startDirectionFunction(worldMatrix: Matrix, directionToUpdate: Vector3, particle: Particle): void;
  13931. /**
  13932. * Clones the current emitter and returns a copy of it
  13933. * @returns the new emitter
  13934. */
  13935. clone(): CylinderDirectedParticleEmitter;
  13936. /**
  13937. * Called by the GPUParticleSystem to setup the update shader
  13938. * @param effect defines the update shader
  13939. */
  13940. applyToShader(effect: Effect): void;
  13941. /**
  13942. * Returns a string to use to update the GPU particles update shader
  13943. * @returns a string containng the defines string
  13944. */
  13945. getEffectDefines(): string;
  13946. /**
  13947. * Returns the string "CylinderDirectedParticleEmitter"
  13948. * @returns a string containing the class name
  13949. */
  13950. getClassName(): string;
  13951. /**
  13952. * Serializes the particle system to a JSON object.
  13953. * @returns the JSON object
  13954. */
  13955. serialize(): any;
  13956. /**
  13957. * Parse properties from a JSON object
  13958. * @param serializationObject defines the JSON object
  13959. */
  13960. parse(serializationObject: any): void;
  13961. }
  13962. }
  13963. declare module "babylonjs/Particles/EmitterTypes/hemisphericParticleEmitter" {
  13964. import { Vector3, Matrix } from "babylonjs/Maths/math.vector";
  13965. import { Effect } from "babylonjs/Materials/effect";
  13966. import { Particle } from "babylonjs/Particles/particle";
  13967. import { IParticleEmitterType } from "babylonjs/Particles/EmitterTypes/IParticleEmitterType";
  13968. /**
  13969. * Particle emitter emitting particles from the inside of a hemisphere.
  13970. * It emits the particles alongside the hemisphere radius. The emission direction might be randomized.
  13971. */
  13972. export class HemisphericParticleEmitter implements IParticleEmitterType {
  13973. /**
  13974. * The radius of the emission hemisphere.
  13975. */
  13976. radius: number;
  13977. /**
  13978. * The range of emission [0-1] 0 Surface only, 1 Entire Radius.
  13979. */
  13980. radiusRange: number;
  13981. /**
  13982. * How much to randomize the particle direction [0-1].
  13983. */
  13984. directionRandomizer: number;
  13985. /**
  13986. * Creates a new instance HemisphericParticleEmitter
  13987. * @param radius the radius of the emission hemisphere (1 by default)
  13988. * @param radiusRange the range of the emission hemisphere [0-1] 0 Surface only, 1 Entire Radius (1 by default)
  13989. * @param directionRandomizer defines how much to randomize the particle direction [0-1]
  13990. */
  13991. constructor(
  13992. /**
  13993. * The radius of the emission hemisphere.
  13994. */
  13995. radius?: number,
  13996. /**
  13997. * The range of emission [0-1] 0 Surface only, 1 Entire Radius.
  13998. */
  13999. radiusRange?: number,
  14000. /**
  14001. * How much to randomize the particle direction [0-1].
  14002. */
  14003. directionRandomizer?: number);
  14004. /**
  14005. * Called by the particle System when the direction is computed for the created particle.
  14006. * @param worldMatrix is the world matrix of the particle system
  14007. * @param directionToUpdate is the direction vector to update with the result
  14008. * @param particle is the particle we are computed the direction for
  14009. * @param isLocal defines if the direction should be set in local space
  14010. */
  14011. startDirectionFunction(worldMatrix: Matrix, directionToUpdate: Vector3, particle: Particle, isLocal: boolean): void;
  14012. /**
  14013. * Called by the particle System when the position is computed for the created particle.
  14014. * @param worldMatrix is the world matrix of the particle system
  14015. * @param positionToUpdate is the position vector to update with the result
  14016. * @param particle is the particle we are computed the position for
  14017. * @param isLocal defines if the position should be set in local space
  14018. */
  14019. startPositionFunction(worldMatrix: Matrix, positionToUpdate: Vector3, particle: Particle, isLocal: boolean): void;
  14020. /**
  14021. * Clones the current emitter and returns a copy of it
  14022. * @returns the new emitter
  14023. */
  14024. clone(): HemisphericParticleEmitter;
  14025. /**
  14026. * Called by the GPUParticleSystem to setup the update shader
  14027. * @param effect defines the update shader
  14028. */
  14029. applyToShader(effect: Effect): void;
  14030. /**
  14031. * Returns a string to use to update the GPU particles update shader
  14032. * @returns a string containng the defines string
  14033. */
  14034. getEffectDefines(): string;
  14035. /**
  14036. * Returns the string "HemisphericParticleEmitter"
  14037. * @returns a string containing the class name
  14038. */
  14039. getClassName(): string;
  14040. /**
  14041. * Serializes the particle system to a JSON object.
  14042. * @returns the JSON object
  14043. */
  14044. serialize(): any;
  14045. /**
  14046. * Parse properties from a JSON object
  14047. * @param serializationObject defines the JSON object
  14048. */
  14049. parse(serializationObject: any): void;
  14050. }
  14051. }
  14052. declare module "babylonjs/Particles/EmitterTypes/pointParticleEmitter" {
  14053. import { Vector3, Matrix } from "babylonjs/Maths/math.vector";
  14054. import { Effect } from "babylonjs/Materials/effect";
  14055. import { Particle } from "babylonjs/Particles/particle";
  14056. import { IParticleEmitterType } from "babylonjs/Particles/EmitterTypes/IParticleEmitterType";
  14057. /**
  14058. * Particle emitter emitting particles from a point.
  14059. * It emits the particles randomly between 2 given directions.
  14060. */
  14061. export class PointParticleEmitter implements IParticleEmitterType {
  14062. /**
  14063. * Random direction of each particle after it has been emitted, between direction1 and direction2 vectors.
  14064. */
  14065. direction1: Vector3;
  14066. /**
  14067. * Random direction of each particle after it has been emitted, between direction1 and direction2 vectors.
  14068. */
  14069. direction2: Vector3;
  14070. /**
  14071. * Creates a new instance PointParticleEmitter
  14072. */
  14073. constructor();
  14074. /**
  14075. * Called by the particle System when the direction is computed for the created particle.
  14076. * @param worldMatrix is the world matrix of the particle system
  14077. * @param directionToUpdate is the direction vector to update with the result
  14078. * @param particle is the particle we are computed the direction for
  14079. * @param isLocal defines if the direction should be set in local space
  14080. */
  14081. startDirectionFunction(worldMatrix: Matrix, directionToUpdate: Vector3, particle: Particle, isLocal: boolean): void;
  14082. /**
  14083. * Called by the particle System when the position is computed for the created particle.
  14084. * @param worldMatrix is the world matrix of the particle system
  14085. * @param positionToUpdate is the position vector to update with the result
  14086. * @param particle is the particle we are computed the position for
  14087. * @param isLocal defines if the position should be set in local space
  14088. */
  14089. startPositionFunction(worldMatrix: Matrix, positionToUpdate: Vector3, particle: Particle, isLocal: boolean): void;
  14090. /**
  14091. * Clones the current emitter and returns a copy of it
  14092. * @returns the new emitter
  14093. */
  14094. clone(): PointParticleEmitter;
  14095. /**
  14096. * Called by the GPUParticleSystem to setup the update shader
  14097. * @param effect defines the update shader
  14098. */
  14099. applyToShader(effect: Effect): void;
  14100. /**
  14101. * Returns a string to use to update the GPU particles update shader
  14102. * @returns a string containng the defines string
  14103. */
  14104. getEffectDefines(): string;
  14105. /**
  14106. * Returns the string "PointParticleEmitter"
  14107. * @returns a string containing the class name
  14108. */
  14109. getClassName(): string;
  14110. /**
  14111. * Serializes the particle system to a JSON object.
  14112. * @returns the JSON object
  14113. */
  14114. serialize(): any;
  14115. /**
  14116. * Parse properties from a JSON object
  14117. * @param serializationObject defines the JSON object
  14118. */
  14119. parse(serializationObject: any): void;
  14120. }
  14121. }
  14122. declare module "babylonjs/Particles/EmitterTypes/sphereParticleEmitter" {
  14123. import { Vector3, Matrix } from "babylonjs/Maths/math.vector";
  14124. import { Effect } from "babylonjs/Materials/effect";
  14125. import { Particle } from "babylonjs/Particles/particle";
  14126. import { IParticleEmitterType } from "babylonjs/Particles/EmitterTypes/IParticleEmitterType";
  14127. /**
  14128. * Particle emitter emitting particles from the inside of a sphere.
  14129. * It emits the particles alongside the sphere radius. The emission direction might be randomized.
  14130. */
  14131. export class SphereParticleEmitter implements IParticleEmitterType {
  14132. /**
  14133. * The radius of the emission sphere.
  14134. */
  14135. radius: number;
  14136. /**
  14137. * The range of emission [0-1] 0 Surface only, 1 Entire Radius.
  14138. */
  14139. radiusRange: number;
  14140. /**
  14141. * How much to randomize the particle direction [0-1].
  14142. */
  14143. directionRandomizer: number;
  14144. /**
  14145. * Creates a new instance SphereParticleEmitter
  14146. * @param radius the radius of the emission sphere (1 by default)
  14147. * @param radiusRange the range of the emission sphere [0-1] 0 Surface only, 1 Entire Radius (1 by default)
  14148. * @param directionRandomizer defines how much to randomize the particle direction [0-1]
  14149. */
  14150. constructor(
  14151. /**
  14152. * The radius of the emission sphere.
  14153. */
  14154. radius?: number,
  14155. /**
  14156. * The range of emission [0-1] 0 Surface only, 1 Entire Radius.
  14157. */
  14158. radiusRange?: number,
  14159. /**
  14160. * How much to randomize the particle direction [0-1].
  14161. */
  14162. directionRandomizer?: number);
  14163. /**
  14164. * Called by the particle System when the direction is computed for the created particle.
  14165. * @param worldMatrix is the world matrix of the particle system
  14166. * @param directionToUpdate is the direction vector to update with the result
  14167. * @param particle is the particle we are computed the direction for
  14168. * @param isLocal defines if the direction should be set in local space
  14169. */
  14170. startDirectionFunction(worldMatrix: Matrix, directionToUpdate: Vector3, particle: Particle, isLocal: boolean): void;
  14171. /**
  14172. * Called by the particle System when the position is computed for the created particle.
  14173. * @param worldMatrix is the world matrix of the particle system
  14174. * @param positionToUpdate is the position vector to update with the result
  14175. * @param particle is the particle we are computed the position for
  14176. * @param isLocal defines if the position should be set in local space
  14177. */
  14178. startPositionFunction(worldMatrix: Matrix, positionToUpdate: Vector3, particle: Particle, isLocal: boolean): void;
  14179. /**
  14180. * Clones the current emitter and returns a copy of it
  14181. * @returns the new emitter
  14182. */
  14183. clone(): SphereParticleEmitter;
  14184. /**
  14185. * Called by the GPUParticleSystem to setup the update shader
  14186. * @param effect defines the update shader
  14187. */
  14188. applyToShader(effect: Effect): void;
  14189. /**
  14190. * Returns a string to use to update the GPU particles update shader
  14191. * @returns a string containng the defines string
  14192. */
  14193. getEffectDefines(): string;
  14194. /**
  14195. * Returns the string "SphereParticleEmitter"
  14196. * @returns a string containing the class name
  14197. */
  14198. getClassName(): string;
  14199. /**
  14200. * Serializes the particle system to a JSON object.
  14201. * @returns the JSON object
  14202. */
  14203. serialize(): any;
  14204. /**
  14205. * Parse properties from a JSON object
  14206. * @param serializationObject defines the JSON object
  14207. */
  14208. parse(serializationObject: any): void;
  14209. }
  14210. /**
  14211. * Particle emitter emitting particles from the inside of a sphere.
  14212. * It emits the particles randomly between two vectors.
  14213. */
  14214. export class SphereDirectedParticleEmitter extends SphereParticleEmitter {
  14215. /**
  14216. * The min limit of the emission direction.
  14217. */
  14218. direction1: Vector3;
  14219. /**
  14220. * The max limit of the emission direction.
  14221. */
  14222. direction2: Vector3;
  14223. /**
  14224. * Creates a new instance SphereDirectedParticleEmitter
  14225. * @param radius the radius of the emission sphere (1 by default)
  14226. * @param direction1 the min limit of the emission direction (up vector by default)
  14227. * @param direction2 the max limit of the emission direction (up vector by default)
  14228. */
  14229. constructor(radius?: number,
  14230. /**
  14231. * The min limit of the emission direction.
  14232. */
  14233. direction1?: Vector3,
  14234. /**
  14235. * The max limit of the emission direction.
  14236. */
  14237. direction2?: Vector3);
  14238. /**
  14239. * Called by the particle System when the direction is computed for the created particle.
  14240. * @param worldMatrix is the world matrix of the particle system
  14241. * @param directionToUpdate is the direction vector to update with the result
  14242. * @param particle is the particle we are computed the direction for
  14243. */
  14244. startDirectionFunction(worldMatrix: Matrix, directionToUpdate: Vector3, particle: Particle): void;
  14245. /**
  14246. * Clones the current emitter and returns a copy of it
  14247. * @returns the new emitter
  14248. */
  14249. clone(): SphereDirectedParticleEmitter;
  14250. /**
  14251. * Called by the GPUParticleSystem to setup the update shader
  14252. * @param effect defines the update shader
  14253. */
  14254. applyToShader(effect: Effect): void;
  14255. /**
  14256. * Returns a string to use to update the GPU particles update shader
  14257. * @returns a string containng the defines string
  14258. */
  14259. getEffectDefines(): string;
  14260. /**
  14261. * Returns the string "SphereDirectedParticleEmitter"
  14262. * @returns a string containing the class name
  14263. */
  14264. getClassName(): string;
  14265. /**
  14266. * Serializes the particle system to a JSON object.
  14267. * @returns the JSON object
  14268. */
  14269. serialize(): any;
  14270. /**
  14271. * Parse properties from a JSON object
  14272. * @param serializationObject defines the JSON object
  14273. */
  14274. parse(serializationObject: any): void;
  14275. }
  14276. }
  14277. declare module "babylonjs/Particles/EmitterTypes/customParticleEmitter" {
  14278. import { Vector3, Matrix } from "babylonjs/Maths/math.vector";
  14279. import { Effect } from "babylonjs/Materials/effect";
  14280. import { Particle } from "babylonjs/Particles/particle";
  14281. import { IParticleEmitterType } from "babylonjs/Particles/EmitterTypes/IParticleEmitterType";
  14282. import { Nullable } from "babylonjs/types";
  14283. /**
  14284. * Particle emitter emitting particles from a custom list of positions.
  14285. */
  14286. export class CustomParticleEmitter implements IParticleEmitterType {
  14287. /**
  14288. * Gets or sets the position generator that will create the inital position of each particle.
  14289. * Index will be provided when used with GPU particle. Particle will be provided when used with CPU particles
  14290. */
  14291. particlePositionGenerator: (index: number, particle: Nullable<Particle>, outPosition: Vector3) => void;
  14292. /**
  14293. * Gets or sets the destination generator that will create the final destination of each particle.
  14294. * * Index will be provided when used with GPU particle. Particle will be provided when used with CPU particles
  14295. */
  14296. particleDestinationGenerator: (index: number, particle: Nullable<Particle>, outDestination: Vector3) => void;
  14297. /**
  14298. * Creates a new instance CustomParticleEmitter
  14299. */
  14300. constructor();
  14301. /**
  14302. * Called by the particle System when the direction is computed for the created particle.
  14303. * @param worldMatrix is the world matrix of the particle system
  14304. * @param directionToUpdate is the direction vector to update with the result
  14305. * @param particle is the particle we are computed the direction for
  14306. * @param isLocal defines if the direction should be set in local space
  14307. */
  14308. startDirectionFunction(worldMatrix: Matrix, directionToUpdate: Vector3, particle: Particle, isLocal: boolean): void;
  14309. /**
  14310. * Called by the particle System when the position is computed for the created particle.
  14311. * @param worldMatrix is the world matrix of the particle system
  14312. * @param positionToUpdate is the position vector to update with the result
  14313. * @param particle is the particle we are computed the position for
  14314. * @param isLocal defines if the position should be set in local space
  14315. */
  14316. startPositionFunction(worldMatrix: Matrix, positionToUpdate: Vector3, particle: Particle, isLocal: boolean): void;
  14317. /**
  14318. * Clones the current emitter and returns a copy of it
  14319. * @returns the new emitter
  14320. */
  14321. clone(): CustomParticleEmitter;
  14322. /**
  14323. * Called by the GPUParticleSystem to setup the update shader
  14324. * @param effect defines the update shader
  14325. */
  14326. applyToShader(effect: Effect): void;
  14327. /**
  14328. * Returns a string to use to update the GPU particles update shader
  14329. * @returns a string containng the defines string
  14330. */
  14331. getEffectDefines(): string;
  14332. /**
  14333. * Returns the string "PointParticleEmitter"
  14334. * @returns a string containing the class name
  14335. */
  14336. getClassName(): string;
  14337. /**
  14338. * Serializes the particle system to a JSON object.
  14339. * @returns the JSON object
  14340. */
  14341. serialize(): any;
  14342. /**
  14343. * Parse properties from a JSON object
  14344. * @param serializationObject defines the JSON object
  14345. */
  14346. parse(serializationObject: any): void;
  14347. }
  14348. }
  14349. declare module "babylonjs/Particles/EmitterTypes/meshParticleEmitter" {
  14350. import { Vector3, Matrix } from "babylonjs/Maths/math.vector";
  14351. import { Effect } from "babylonjs/Materials/effect";
  14352. import { Particle } from "babylonjs/Particles/particle";
  14353. import { IParticleEmitterType } from "babylonjs/Particles/EmitterTypes/IParticleEmitterType";
  14354. import { Nullable } from "babylonjs/types";
  14355. import { Scene } from "babylonjs/scene";
  14356. import { AbstractMesh } from "babylonjs/Meshes/abstractMesh";
  14357. /**
  14358. * Particle emitter emitting particles from the inside of a box.
  14359. * It emits the particles randomly between 2 given directions.
  14360. */
  14361. export class MeshParticleEmitter implements IParticleEmitterType {
  14362. private _indices;
  14363. private _positions;
  14364. private _normals;
  14365. private _storedNormal;
  14366. private _mesh;
  14367. /**
  14368. * Random direction of each particle after it has been emitted, between direction1 and direction2 vectors.
  14369. */
  14370. direction1: Vector3;
  14371. /**
  14372. * Random direction of each particle after it has been emitted, between direction1 and direction2 vectors.
  14373. */
  14374. direction2: Vector3;
  14375. /**
  14376. * Gets or sets a boolean indicating that particle directions must be built from mesh face normals
  14377. */
  14378. useMeshNormalsForDirection: boolean;
  14379. /** Defines the mesh to use as source */
  14380. get mesh(): Nullable<AbstractMesh>;
  14381. set mesh(value: Nullable<AbstractMesh>);
  14382. /**
  14383. * Creates a new instance MeshParticleEmitter
  14384. * @param mesh defines the mesh to use as source
  14385. */
  14386. constructor(mesh?: Nullable<AbstractMesh>);
  14387. /**
  14388. * Called by the particle System when the direction is computed for the created particle.
  14389. * @param worldMatrix is the world matrix of the particle system
  14390. * @param directionToUpdate is the direction vector to update with the result
  14391. * @param particle is the particle we are computed the direction for
  14392. * @param isLocal defines if the direction should be set in local space
  14393. */
  14394. startDirectionFunction(worldMatrix: Matrix, directionToUpdate: Vector3, particle: Particle, isLocal: boolean): void;
  14395. /**
  14396. * Called by the particle System when the position is computed for the created particle.
  14397. * @param worldMatrix is the world matrix of the particle system
  14398. * @param positionToUpdate is the position vector to update with the result
  14399. * @param particle is the particle we are computed the position for
  14400. * @param isLocal defines if the position should be set in local space
  14401. */
  14402. startPositionFunction(worldMatrix: Matrix, positionToUpdate: Vector3, particle: Particle, isLocal: boolean): void;
  14403. /**
  14404. * Clones the current emitter and returns a copy of it
  14405. * @returns the new emitter
  14406. */
  14407. clone(): MeshParticleEmitter;
  14408. /**
  14409. * Called by the GPUParticleSystem to setup the update shader
  14410. * @param effect defines the update shader
  14411. */
  14412. applyToShader(effect: Effect): void;
  14413. /**
  14414. * Returns a string to use to update the GPU particles update shader
  14415. * @returns a string containng the defines string
  14416. */
  14417. getEffectDefines(): string;
  14418. /**
  14419. * Returns the string "BoxParticleEmitter"
  14420. * @returns a string containing the class name
  14421. */
  14422. getClassName(): string;
  14423. /**
  14424. * Serializes the particle system to a JSON object.
  14425. * @returns the JSON object
  14426. */
  14427. serialize(): any;
  14428. /**
  14429. * Parse properties from a JSON object
  14430. * @param serializationObject defines the JSON object
  14431. * @param scene defines the hosting scene
  14432. */
  14433. parse(serializationObject: any, scene: Nullable<Scene>): void;
  14434. }
  14435. }
  14436. declare module "babylonjs/Particles/EmitterTypes/index" {
  14437. export * from "babylonjs/Particles/EmitterTypes/boxParticleEmitter";
  14438. export * from "babylonjs/Particles/EmitterTypes/coneParticleEmitter";
  14439. export * from "babylonjs/Particles/EmitterTypes/cylinderParticleEmitter";
  14440. export * from "babylonjs/Particles/EmitterTypes/hemisphericParticleEmitter";
  14441. export * from "babylonjs/Particles/EmitterTypes/IParticleEmitterType";
  14442. export * from "babylonjs/Particles/EmitterTypes/pointParticleEmitter";
  14443. export * from "babylonjs/Particles/EmitterTypes/sphereParticleEmitter";
  14444. export * from "babylonjs/Particles/EmitterTypes/customParticleEmitter";
  14445. export * from "babylonjs/Particles/EmitterTypes/meshParticleEmitter";
  14446. }
  14447. declare module "babylonjs/Particles/IParticleSystem" {
  14448. import { Nullable } from "babylonjs/types";
  14449. import { Vector2, Vector3, Matrix } from "babylonjs/Maths/math.vector";
  14450. import { Color3, Color4 } from "babylonjs/Maths/math.color";
  14451. import { BaseTexture } from "babylonjs/Materials/Textures/baseTexture";
  14452. import { BoxParticleEmitter, IParticleEmitterType, PointParticleEmitter, HemisphericParticleEmitter, SphereParticleEmitter, SphereDirectedParticleEmitter, CylinderParticleEmitter, ConeParticleEmitter } from "babylonjs/Particles/EmitterTypes/index";
  14453. import { Scene } from "babylonjs/scene";
  14454. import { ColorGradient, FactorGradient, Color3Gradient } from "babylonjs/Misc/gradients";
  14455. import { Effect } from "babylonjs/Materials/effect";
  14456. import { Observable } from "babylonjs/Misc/observable";
  14457. import { Animation } from "babylonjs/Animations/animation";
  14458. import { AbstractMesh } from "babylonjs/Meshes/abstractMesh";
  14459. /**
  14460. * Interface representing a particle system in Babylon.js.
  14461. * This groups the common functionalities that needs to be implemented in order to create a particle system.
  14462. * A particle system represents a way to manage particles from their emission to their animation and rendering.
  14463. */
  14464. export interface IParticleSystem {
  14465. /**
  14466. * List of animations used by the particle system.
  14467. */
  14468. animations: Animation[];
  14469. /**
  14470. * The id of the Particle system.
  14471. */
  14472. id: string;
  14473. /**
  14474. * The name of the Particle system.
  14475. */
  14476. name: string;
  14477. /**
  14478. * The emitter represents the Mesh or position we are attaching the particle system to.
  14479. */
  14480. emitter: Nullable<AbstractMesh | Vector3>;
  14481. /**
  14482. * Gets or sets a boolean indicating if the particles must be rendered as billboard or aligned with the direction
  14483. */
  14484. isBillboardBased: boolean;
  14485. /**
  14486. * The rendering group used by the Particle system to chose when to render.
  14487. */
  14488. renderingGroupId: number;
  14489. /**
  14490. * The layer mask we are rendering the particles through.
  14491. */
  14492. layerMask: number;
  14493. /**
  14494. * The overall motion speed (0.01 is default update speed, faster updates = faster animation)
  14495. */
  14496. updateSpeed: number;
  14497. /**
  14498. * The amount of time the particle system is running (depends of the overall update speed).
  14499. */
  14500. targetStopDuration: number;
  14501. /**
  14502. * The texture used to render each particle. (this can be a spritesheet)
  14503. */
  14504. particleTexture: Nullable<BaseTexture>;
  14505. /**
  14506. * Blend mode use to render the particle, it can be either ParticleSystem.BLENDMODE_ONEONE, ParticleSystem.BLENDMODE_STANDARD or ParticleSystem.BLENDMODE_ADD.
  14507. */
  14508. blendMode: number;
  14509. /**
  14510. * Minimum life time of emitting particles.
  14511. */
  14512. minLifeTime: number;
  14513. /**
  14514. * Maximum life time of emitting particles.
  14515. */
  14516. maxLifeTime: number;
  14517. /**
  14518. * Minimum Size of emitting particles.
  14519. */
  14520. minSize: number;
  14521. /**
  14522. * Maximum Size of emitting particles.
  14523. */
  14524. maxSize: number;
  14525. /**
  14526. * Minimum scale of emitting particles on X axis.
  14527. */
  14528. minScaleX: number;
  14529. /**
  14530. * Maximum scale of emitting particles on X axis.
  14531. */
  14532. maxScaleX: number;
  14533. /**
  14534. * Minimum scale of emitting particles on Y axis.
  14535. */
  14536. minScaleY: number;
  14537. /**
  14538. * Maximum scale of emitting particles on Y axis.
  14539. */
  14540. maxScaleY: number;
  14541. /**
  14542. * Random color of each particle after it has been emitted, between color1 and color2 vectors.
  14543. */
  14544. color1: Color4;
  14545. /**
  14546. * Random color of each particle after it has been emitted, between color1 and color2 vectors.
  14547. */
  14548. color2: Color4;
  14549. /**
  14550. * Color the particle will have at the end of its lifetime.
  14551. */
  14552. colorDead: Color4;
  14553. /**
  14554. * The maximum number of particles to emit per frame until we reach the activeParticleCount value
  14555. */
  14556. emitRate: number;
  14557. /**
  14558. * You can use gravity if you want to give an orientation to your particles.
  14559. */
  14560. gravity: Vector3;
  14561. /**
  14562. * Minimum power of emitting particles.
  14563. */
  14564. minEmitPower: number;
  14565. /**
  14566. * Maximum power of emitting particles.
  14567. */
  14568. maxEmitPower: number;
  14569. /**
  14570. * Minimum angular speed of emitting particles (Z-axis rotation for each particle).
  14571. */
  14572. minAngularSpeed: number;
  14573. /**
  14574. * Maximum angular speed of emitting particles (Z-axis rotation for each particle).
  14575. */
  14576. maxAngularSpeed: number;
  14577. /**
  14578. * Gets or sets the minimal initial rotation in radians.
  14579. */
  14580. minInitialRotation: number;
  14581. /**
  14582. * Gets or sets the maximal initial rotation in radians.
  14583. */
  14584. maxInitialRotation: number;
  14585. /**
  14586. * The particle emitter type defines the emitter used by the particle system.
  14587. * It can be for example box, sphere, or cone...
  14588. */
  14589. particleEmitterType: Nullable<IParticleEmitterType>;
  14590. /**
  14591. * Defines the delay in milliseconds before starting the system (0 by default)
  14592. */
  14593. startDelay: number;
  14594. /**
  14595. * 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
  14596. */
  14597. preWarmCycles: number;
  14598. /**
  14599. * Gets or sets a value indicating the time step multiplier to use in pre-warm mode (default is 1)
  14600. */
  14601. preWarmStepOffset: number;
  14602. /**
  14603. * 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)
  14604. */
  14605. spriteCellChangeSpeed: number;
  14606. /**
  14607. * If using a spritesheet (isAnimationSheetEnabled) defines the first sprite cell to display
  14608. */
  14609. startSpriteCellID: number;
  14610. /**
  14611. * If using a spritesheet (isAnimationSheetEnabled) defines the last sprite cell to display
  14612. */
  14613. endSpriteCellID: number;
  14614. /**
  14615. * If using a spritesheet (isAnimationSheetEnabled), defines the sprite cell width to use
  14616. */
  14617. spriteCellWidth: number;
  14618. /**
  14619. * If using a spritesheet (isAnimationSheetEnabled), defines the sprite cell height to use
  14620. */
  14621. spriteCellHeight: number;
  14622. /**
  14623. * This allows the system to random pick the start cell ID between startSpriteCellID and endSpriteCellID
  14624. */
  14625. spriteRandomStartCell: boolean;
  14626. /**
  14627. * Gets or sets a boolean indicating if a spritesheet is used to animate the particles texture
  14628. */
  14629. isAnimationSheetEnabled: boolean;
  14630. /** Gets or sets a Vector2 used to move the pivot (by default (0,0)) */
  14631. translationPivot: Vector2;
  14632. /**
  14633. * Gets or sets a texture used to add random noise to particle positions
  14634. */
  14635. noiseTexture: Nullable<BaseTexture>;
  14636. /** Gets or sets the strength to apply to the noise value (default is (10, 10, 10)) */
  14637. noiseStrength: Vector3;
  14638. /**
  14639. * Gets or sets the billboard mode to use when isBillboardBased = true.
  14640. * Value can be: ParticleSystem.BILLBOARDMODE_ALL, ParticleSystem.BILLBOARDMODE_Y, ParticleSystem.BILLBOARDMODE_STRETCHED
  14641. */
  14642. billboardMode: number;
  14643. /** Gets or sets a value indicating the damping to apply if the limit velocity factor is reached */
  14644. limitVelocityDamping: number;
  14645. /**
  14646. * Gets or sets a boolean indicating that hosted animations (in the system.animations array) must be started when system.start() is called
  14647. */
  14648. beginAnimationOnStart: boolean;
  14649. /**
  14650. * Gets or sets the frame to start the animation from when beginAnimationOnStart is true
  14651. */
  14652. beginAnimationFrom: number;
  14653. /**
  14654. * Gets or sets the frame to end the animation on when beginAnimationOnStart is true
  14655. */
  14656. beginAnimationTo: number;
  14657. /**
  14658. * Gets or sets a boolean indicating if animations must loop when beginAnimationOnStart is true
  14659. */
  14660. beginAnimationLoop: boolean;
  14661. /**
  14662. * Specifies whether the particle system will be disposed once it reaches the end of the animation.
  14663. */
  14664. disposeOnStop: boolean;
  14665. /**
  14666. * Specifies if the particles are updated in emitter local space or world space
  14667. */
  14668. isLocal: boolean;
  14669. /** Snippet ID if the particle system was created from the snippet server */
  14670. snippetId: string;
  14671. /** Gets or sets a matrix to use to compute projection */
  14672. defaultProjectionMatrix: Matrix;
  14673. /**
  14674. * Gets the maximum number of particles active at the same time.
  14675. * @returns The max number of active particles.
  14676. */
  14677. getCapacity(): number;
  14678. /**
  14679. * Gets the number of particles active at the same time.
  14680. * @returns The number of active particles.
  14681. */
  14682. getActiveCount(): number;
  14683. /**
  14684. * Gets if the system has been started. (Note: this will still be true after stop is called)
  14685. * @returns True if it has been started, otherwise false.
  14686. */
  14687. isStarted(): boolean;
  14688. /**
  14689. * Animates the particle system for this frame.
  14690. */
  14691. animate(): void;
  14692. /**
  14693. * Renders the particle system in its current state.
  14694. * @returns the current number of particles
  14695. */
  14696. render(): number;
  14697. /**
  14698. * Dispose the particle system and frees its associated resources.
  14699. * @param disposeTexture defines if the particule texture must be disposed as well (true by default)
  14700. */
  14701. dispose(disposeTexture?: boolean): void;
  14702. /**
  14703. * An event triggered when the system is disposed
  14704. */
  14705. onDisposeObservable: Observable<IParticleSystem>;
  14706. /**
  14707. * An event triggered when the system is stopped
  14708. */
  14709. onStoppedObservable: Observable<IParticleSystem>;
  14710. /**
  14711. * Clones the particle system.
  14712. * @param name The name of the cloned object
  14713. * @param newEmitter The new emitter to use
  14714. * @returns the cloned particle system
  14715. */
  14716. clone(name: string, newEmitter: any): Nullable<IParticleSystem>;
  14717. /**
  14718. * Serializes the particle system to a JSON object
  14719. * @param serializeTexture defines if the texture must be serialized as well
  14720. * @returns the JSON object
  14721. */
  14722. serialize(serializeTexture: boolean): any;
  14723. /**
  14724. * Rebuild the particle system
  14725. */
  14726. rebuild(): void;
  14727. /** Force the system to rebuild all gradients that need to be resync */
  14728. forceRefreshGradients(): void;
  14729. /**
  14730. * Starts the particle system and begins to emit
  14731. * @param delay defines the delay in milliseconds before starting the system (0 by default)
  14732. */
  14733. start(delay?: number): void;
  14734. /**
  14735. * Stops the particle system.
  14736. */
  14737. stop(): void;
  14738. /**
  14739. * Remove all active particles
  14740. */
  14741. reset(): void;
  14742. /**
  14743. * Gets a boolean indicating that the system is stopping
  14744. * @returns true if the system is currently stopping
  14745. */
  14746. isStopping(): boolean;
  14747. /**
  14748. * Is this system ready to be used/rendered
  14749. * @return true if the system is ready
  14750. */
  14751. isReady(): boolean;
  14752. /**
  14753. * Returns the string "ParticleSystem"
  14754. * @returns a string containing the class name
  14755. */
  14756. getClassName(): string;
  14757. /**
  14758. * Gets the custom effect used to render the particles
  14759. * @param blendMode Blend mode for which the effect should be retrieved
  14760. * @returns The effect
  14761. */
  14762. getCustomEffect(blendMode: number): Nullable<Effect>;
  14763. /**
  14764. * Sets the custom effect used to render the particles
  14765. * @param effect The effect to set
  14766. * @param blendMode Blend mode for which the effect should be set
  14767. */
  14768. setCustomEffect(effect: Nullable<Effect>, blendMode: number): void;
  14769. /**
  14770. * Fill the defines array according to the current settings of the particle system
  14771. * @param defines Array to be updated
  14772. * @param blendMode blend mode to take into account when updating the array
  14773. */
  14774. fillDefines(defines: Array<string>, blendMode: number): void;
  14775. /**
  14776. * Fill the uniforms, attributes and samplers arrays according to the current settings of the particle system
  14777. * @param uniforms Uniforms array to fill
  14778. * @param attributes Attributes array to fill
  14779. * @param samplers Samplers array to fill
  14780. */
  14781. fillUniformsAttributesAndSamplerNames(uniforms: Array<string>, attributes: Array<string>, samplers: Array<string>): void;
  14782. /**
  14783. * Observable that will be called just before the particles are drawn
  14784. */
  14785. onBeforeDrawParticlesObservable: Observable<Nullable<Effect>>;
  14786. /**
  14787. * Gets the name of the particle vertex shader
  14788. */
  14789. vertexShaderName: string;
  14790. /**
  14791. * Adds a new color gradient
  14792. * @param gradient defines the gradient to use (between 0 and 1)
  14793. * @param color1 defines the color to affect to the specified gradient
  14794. * @param color2 defines an additional color used to define a range ([color, color2]) with main color to pick the final color from
  14795. * @returns the current particle system
  14796. */
  14797. addColorGradient(gradient: number, color1: Color4, color2?: Color4): IParticleSystem;
  14798. /**
  14799. * Remove a specific color gradient
  14800. * @param gradient defines the gradient to remove
  14801. * @returns the current particle system
  14802. */
  14803. removeColorGradient(gradient: number): IParticleSystem;
  14804. /**
  14805. * Adds a new size gradient
  14806. * @param gradient defines the gradient to use (between 0 and 1)
  14807. * @param factor defines the size factor to affect to the specified gradient
  14808. * @param factor2 defines an additional factor used to define a range ([factor, factor2]) with main value to pick the final value from
  14809. * @returns the current particle system
  14810. */
  14811. addSizeGradient(gradient: number, factor: number, factor2?: number): IParticleSystem;
  14812. /**
  14813. * Remove a specific size gradient
  14814. * @param gradient defines the gradient to remove
  14815. * @returns the current particle system
  14816. */
  14817. removeSizeGradient(gradient: number): IParticleSystem;
  14818. /**
  14819. * Gets the current list of color gradients.
  14820. * You must use addColorGradient and removeColorGradient to udpate this list
  14821. * @returns the list of color gradients
  14822. */
  14823. getColorGradients(): Nullable<Array<ColorGradient>>;
  14824. /**
  14825. * Gets the current list of size gradients.
  14826. * You must use addSizeGradient and removeSizeGradient to udpate this list
  14827. * @returns the list of size gradients
  14828. */
  14829. getSizeGradients(): Nullable<Array<FactorGradient>>;
  14830. /**
  14831. * Gets the current list of angular speed gradients.
  14832. * You must use addAngularSpeedGradient and removeAngularSpeedGradient to udpate this list
  14833. * @returns the list of angular speed gradients
  14834. */
  14835. getAngularSpeedGradients(): Nullable<Array<FactorGradient>>;
  14836. /**
  14837. * Adds a new angular speed gradient
  14838. * @param gradient defines the gradient to use (between 0 and 1)
  14839. * @param factor defines the angular speed to affect to the specified gradient
  14840. * @param factor2 defines an additional factor used to define a range ([factor, factor2]) with main value to pick the final value from
  14841. * @returns the current particle system
  14842. */
  14843. addAngularSpeedGradient(gradient: number, factor: number, factor2?: number): IParticleSystem;
  14844. /**
  14845. * Remove a specific angular speed gradient
  14846. * @param gradient defines the gradient to remove
  14847. * @returns the current particle system
  14848. */
  14849. removeAngularSpeedGradient(gradient: number): IParticleSystem;
  14850. /**
  14851. * Gets the current list of velocity gradients.
  14852. * You must use addVelocityGradient and removeVelocityGradient to udpate this list
  14853. * @returns the list of velocity gradients
  14854. */
  14855. getVelocityGradients(): Nullable<Array<FactorGradient>>;
  14856. /**
  14857. * Adds a new velocity gradient
  14858. * @param gradient defines the gradient to use (between 0 and 1)
  14859. * @param factor defines the velocity to affect to the specified gradient
  14860. * @param factor2 defines an additional factor used to define a range ([factor, factor2]) with main value to pick the final value from
  14861. * @returns the current particle system
  14862. */
  14863. addVelocityGradient(gradient: number, factor: number, factor2?: number): IParticleSystem;
  14864. /**
  14865. * Remove a specific velocity gradient
  14866. * @param gradient defines the gradient to remove
  14867. * @returns the current particle system
  14868. */
  14869. removeVelocityGradient(gradient: number): IParticleSystem;
  14870. /**
  14871. * Gets the current list of limit velocity gradients.
  14872. * You must use addLimitVelocityGradient and removeLimitVelocityGradient to udpate this list
  14873. * @returns the list of limit velocity gradients
  14874. */
  14875. getLimitVelocityGradients(): Nullable<Array<FactorGradient>>;
  14876. /**
  14877. * Adds a new limit velocity gradient
  14878. * @param gradient defines the gradient to use (between 0 and 1)
  14879. * @param factor defines the limit velocity to affect to the specified gradient
  14880. * @param factor2 defines an additional factor used to define a range ([factor, factor2]) with main value to pick the final value from
  14881. * @returns the current particle system
  14882. */
  14883. addLimitVelocityGradient(gradient: number, factor: number, factor2?: number): IParticleSystem;
  14884. /**
  14885. * Remove a specific limit velocity gradient
  14886. * @param gradient defines the gradient to remove
  14887. * @returns the current particle system
  14888. */
  14889. removeLimitVelocityGradient(gradient: number): IParticleSystem;
  14890. /**
  14891. * Adds a new drag gradient
  14892. * @param gradient defines the gradient to use (between 0 and 1)
  14893. * @param factor defines the drag to affect to the specified gradient
  14894. * @param factor2 defines an additional factor used to define a range ([factor, factor2]) with main value to pick the final value from
  14895. * @returns the current particle system
  14896. */
  14897. addDragGradient(gradient: number, factor: number, factor2?: number): IParticleSystem;
  14898. /**
  14899. * Remove a specific drag gradient
  14900. * @param gradient defines the gradient to remove
  14901. * @returns the current particle system
  14902. */
  14903. removeDragGradient(gradient: number): IParticleSystem;
  14904. /**
  14905. * Gets the current list of drag gradients.
  14906. * You must use addDragGradient and removeDragGradient to udpate this list
  14907. * @returns the list of drag gradients
  14908. */
  14909. getDragGradients(): Nullable<Array<FactorGradient>>;
  14910. /**
  14911. * Adds a new emit rate gradient (please note that this will only work if you set the targetStopDuration property)
  14912. * @param gradient defines the gradient to use (between 0 and 1)
  14913. * @param factor defines the emit rate to affect to the specified gradient
  14914. * @param factor2 defines an additional factor used to define a range ([factor, factor2]) with main value to pick the final value from
  14915. * @returns the current particle system
  14916. */
  14917. addEmitRateGradient(gradient: number, factor: number, factor2?: number): IParticleSystem;
  14918. /**
  14919. * Remove a specific emit rate gradient
  14920. * @param gradient defines the gradient to remove
  14921. * @returns the current particle system
  14922. */
  14923. removeEmitRateGradient(gradient: number): IParticleSystem;
  14924. /**
  14925. * Gets the current list of emit rate gradients.
  14926. * You must use addEmitRateGradient and removeEmitRateGradient to udpate this list
  14927. * @returns the list of emit rate gradients
  14928. */
  14929. getEmitRateGradients(): Nullable<Array<FactorGradient>>;
  14930. /**
  14931. * Adds a new start size gradient (please note that this will only work if you set the targetStopDuration property)
  14932. * @param gradient defines the gradient to use (between 0 and 1)
  14933. * @param factor defines the start size to affect to the specified gradient
  14934. * @param factor2 defines an additional factor used to define a range ([factor, factor2]) with main value to pick the final value from
  14935. * @returns the current particle system
  14936. */
  14937. addStartSizeGradient(gradient: number, factor: number, factor2?: number): IParticleSystem;
  14938. /**
  14939. * Remove a specific start size gradient
  14940. * @param gradient defines the gradient to remove
  14941. * @returns the current particle system
  14942. */
  14943. removeStartSizeGradient(gradient: number): IParticleSystem;
  14944. /**
  14945. * Gets the current list of start size gradients.
  14946. * You must use addStartSizeGradient and removeStartSizeGradient to udpate this list
  14947. * @returns the list of start size gradients
  14948. */
  14949. getStartSizeGradients(): Nullable<Array<FactorGradient>>;
  14950. /**
  14951. * Adds a new life time gradient
  14952. * @param gradient defines the gradient to use (between 0 and 1)
  14953. * @param factor defines the life time factor to affect to the specified gradient
  14954. * @param factor2 defines an additional factor used to define a range ([factor, factor2]) with main value to pick the final value from
  14955. * @returns the current particle system
  14956. */
  14957. addLifeTimeGradient(gradient: number, factor: number, factor2?: number): IParticleSystem;
  14958. /**
  14959. * Remove a specific life time gradient
  14960. * @param gradient defines the gradient to remove
  14961. * @returns the current particle system
  14962. */
  14963. removeLifeTimeGradient(gradient: number): IParticleSystem;
  14964. /**
  14965. * Gets the current list of life time gradients.
  14966. * You must use addLifeTimeGradient and removeLifeTimeGradient to udpate this list
  14967. * @returns the list of life time gradients
  14968. */
  14969. getLifeTimeGradients(): Nullable<Array<FactorGradient>>;
  14970. /**
  14971. * Gets the current list of color gradients.
  14972. * You must use addColorGradient and removeColorGradient to udpate this list
  14973. * @returns the list of color gradients
  14974. */
  14975. getColorGradients(): Nullable<Array<ColorGradient>>;
  14976. /**
  14977. * Adds a new ramp gradient used to remap particle colors
  14978. * @param gradient defines the gradient to use (between 0 and 1)
  14979. * @param color defines the color to affect to the specified gradient
  14980. * @returns the current particle system
  14981. */
  14982. addRampGradient(gradient: number, color: Color3): IParticleSystem;
  14983. /**
  14984. * Gets the current list of ramp gradients.
  14985. * You must use addRampGradient and removeRampGradient to udpate this list
  14986. * @returns the list of ramp gradients
  14987. */
  14988. getRampGradients(): Nullable<Array<Color3Gradient>>;
  14989. /** Gets or sets a boolean indicating that ramp gradients must be used
  14990. * @see https://doc.babylonjs.com/babylon101/particles#ramp-gradients
  14991. */
  14992. useRampGradients: boolean;
  14993. /**
  14994. * Adds a new color remap gradient
  14995. * @param gradient defines the gradient to use (between 0 and 1)
  14996. * @param min defines the color remap minimal range
  14997. * @param max defines the color remap maximal range
  14998. * @returns the current particle system
  14999. */
  15000. addColorRemapGradient(gradient: number, min: number, max: number): IParticleSystem;
  15001. /**
  15002. * Gets the current list of color remap gradients.
  15003. * You must use addColorRemapGradient and removeColorRemapGradient to udpate this list
  15004. * @returns the list of color remap gradients
  15005. */
  15006. getColorRemapGradients(): Nullable<Array<FactorGradient>>;
  15007. /**
  15008. * Adds a new alpha remap gradient
  15009. * @param gradient defines the gradient to use (between 0 and 1)
  15010. * @param min defines the alpha remap minimal range
  15011. * @param max defines the alpha remap maximal range
  15012. * @returns the current particle system
  15013. */
  15014. addAlphaRemapGradient(gradient: number, min: number, max: number): IParticleSystem;
  15015. /**
  15016. * Gets the current list of alpha remap gradients.
  15017. * You must use addAlphaRemapGradient and removeAlphaRemapGradient to udpate this list
  15018. * @returns the list of alpha remap gradients
  15019. */
  15020. getAlphaRemapGradients(): Nullable<Array<FactorGradient>>;
  15021. /**
  15022. * Creates a Point Emitter for the particle system (emits directly from the emitter position)
  15023. * @param direction1 Particles are emitted between the direction1 and direction2 from within the box
  15024. * @param direction2 Particles are emitted between the direction1 and direction2 from within the box
  15025. * @returns the emitter
  15026. */
  15027. createPointEmitter(direction1: Vector3, direction2: Vector3): PointParticleEmitter;
  15028. /**
  15029. * Creates a Hemisphere Emitter for the particle system (emits along the hemisphere radius)
  15030. * @param radius The radius of the hemisphere to emit from
  15031. * @param radiusRange The range of the hemisphere to emit from [0-1] 0 Surface Only, 1 Entire Radius
  15032. * @returns the emitter
  15033. */
  15034. createHemisphericEmitter(radius: number, radiusRange: number): HemisphericParticleEmitter;
  15035. /**
  15036. * Creates a Sphere Emitter for the particle system (emits along the sphere radius)
  15037. * @param radius The radius of the sphere to emit from
  15038. * @param radiusRange The range of the sphere to emit from [0-1] 0 Surface Only, 1 Entire Radius
  15039. * @returns the emitter
  15040. */
  15041. createSphereEmitter(radius: number, radiusRange: number): SphereParticleEmitter;
  15042. /**
  15043. * Creates a Directed Sphere Emitter for the particle system (emits between direction1 and direction2)
  15044. * @param radius The radius of the sphere to emit from
  15045. * @param direction1 Particles are emitted between the direction1 and direction2 from within the sphere
  15046. * @param direction2 Particles are emitted between the direction1 and direction2 from within the sphere
  15047. * @returns the emitter
  15048. */
  15049. createDirectedSphereEmitter(radius: number, direction1: Vector3, direction2: Vector3): SphereDirectedParticleEmitter;
  15050. /**
  15051. * Creates a Cylinder Emitter for the particle system (emits from the cylinder to the particle position)
  15052. * @param radius The radius of the emission cylinder
  15053. * @param height The height of the emission cylinder
  15054. * @param radiusRange The range of emission [0-1] 0 Surface only, 1 Entire Radius
  15055. * @param directionRandomizer How much to randomize the particle direction [0-1]
  15056. * @returns the emitter
  15057. */
  15058. createCylinderEmitter(radius: number, height: number, radiusRange: number, directionRandomizer: number): CylinderParticleEmitter;
  15059. /**
  15060. * Creates a Directed Cylinder Emitter for the particle system (emits between direction1 and direction2)
  15061. * @param radius The radius of the cylinder to emit from
  15062. * @param height The height of the emission cylinder
  15063. * @param radiusRange the range of the emission cylinder [0-1] 0 Surface only, 1 Entire Radius (1 by default)
  15064. * @param direction1 Particles are emitted between the direction1 and direction2 from within the cylinder
  15065. * @param direction2 Particles are emitted between the direction1 and direction2 from within the cylinder
  15066. * @returns the emitter
  15067. */
  15068. createDirectedCylinderEmitter(radius: number, height: number, radiusRange: number, direction1: Vector3, direction2: Vector3): SphereDirectedParticleEmitter;
  15069. /**
  15070. * Creates a Cone Emitter for the particle system (emits from the cone to the particle position)
  15071. * @param radius The radius of the cone to emit from
  15072. * @param angle The base angle of the cone
  15073. * @returns the emitter
  15074. */
  15075. createConeEmitter(radius: number, angle: number): ConeParticleEmitter;
  15076. /**
  15077. * Creates a Box Emitter for the particle system. (emits between direction1 and direction2 from withing the box defined by minEmitBox and maxEmitBox)
  15078. * @param direction1 Particles are emitted between the direction1 and direction2 from within the box
  15079. * @param direction2 Particles are emitted between the direction1 and direction2 from within the box
  15080. * @param minEmitBox Particles are emitted from the box between minEmitBox and maxEmitBox
  15081. * @param maxEmitBox Particles are emitted from the box between minEmitBox and maxEmitBox
  15082. * @returns the emitter
  15083. */
  15084. createBoxEmitter(direction1: Vector3, direction2: Vector3, minEmitBox: Vector3, maxEmitBox: Vector3): BoxParticleEmitter;
  15085. /**
  15086. * Get hosting scene
  15087. * @returns the scene
  15088. */
  15089. getScene(): Nullable<Scene>;
  15090. }
  15091. }
  15092. declare module "babylonjs/Meshes/transformNode" {
  15093. import { DeepImmutable } from "babylonjs/types";
  15094. import { Observable } from "babylonjs/Misc/observable";
  15095. import { Nullable } from "babylonjs/types";
  15096. import { Camera } from "babylonjs/Cameras/camera";
  15097. import { Scene } from "babylonjs/scene";
  15098. import { Quaternion, Matrix, Vector3 } from "babylonjs/Maths/math.vector";
  15099. import { Node } from "babylonjs/node";
  15100. import { Bone } from "babylonjs/Bones/bone";
  15101. import { AbstractMesh } from "babylonjs/Meshes/abstractMesh";
  15102. import { Space } from "babylonjs/Maths/math.axis";
  15103. /**
  15104. * 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.
  15105. * @see https://doc.babylonjs.com/how_to/transformnode
  15106. */
  15107. export class TransformNode extends Node {
  15108. /**
  15109. * Object will not rotate to face the camera
  15110. */
  15111. static BILLBOARDMODE_NONE: number;
  15112. /**
  15113. * Object will rotate to face the camera but only on the x axis
  15114. */
  15115. static BILLBOARDMODE_X: number;
  15116. /**
  15117. * Object will rotate to face the camera but only on the y axis
  15118. */
  15119. static BILLBOARDMODE_Y: number;
  15120. /**
  15121. * Object will rotate to face the camera but only on the z axis
  15122. */
  15123. static BILLBOARDMODE_Z: number;
  15124. /**
  15125. * Object will rotate to face the camera
  15126. */
  15127. static BILLBOARDMODE_ALL: number;
  15128. /**
  15129. * Object will rotate to face the camera's position instead of orientation
  15130. */
  15131. static BILLBOARDMODE_USE_POSITION: number;
  15132. private static _TmpRotation;
  15133. private static _TmpScaling;
  15134. private static _TmpTranslation;
  15135. private _forward;
  15136. private _forwardInverted;
  15137. private _up;
  15138. private _right;
  15139. private _rightInverted;
  15140. private _position;
  15141. private _rotation;
  15142. private _rotationQuaternion;
  15143. protected _scaling: Vector3;
  15144. protected _isDirty: boolean;
  15145. private _transformToBoneReferal;
  15146. private _isAbsoluteSynced;
  15147. private _billboardMode;
  15148. /**
  15149. * Gets or sets the billboard mode. Default is 0.
  15150. *
  15151. * | Value | Type | Description |
  15152. * | --- | --- | --- |
  15153. * | 0 | BILLBOARDMODE_NONE | |
  15154. * | 1 | BILLBOARDMODE_X | |
  15155. * | 2 | BILLBOARDMODE_Y | |
  15156. * | 4 | BILLBOARDMODE_Z | |
  15157. * | 7 | BILLBOARDMODE_ALL | |
  15158. *
  15159. */
  15160. get billboardMode(): number;
  15161. set billboardMode(value: number);
  15162. private _preserveParentRotationForBillboard;
  15163. /**
  15164. * Gets or sets a boolean indicating that parent rotation should be preserved when using billboards.
  15165. * This could be useful for glTF objects where parent rotation helps converting from right handed to left handed
  15166. */
  15167. get preserveParentRotationForBillboard(): boolean;
  15168. set preserveParentRotationForBillboard(value: boolean);
  15169. /**
  15170. * 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
  15171. */
  15172. scalingDeterminant: number;
  15173. private _infiniteDistance;
  15174. /**
  15175. * Gets or sets the distance of the object to max, often used by skybox
  15176. */
  15177. get infiniteDistance(): boolean;
  15178. set infiniteDistance(value: boolean);
  15179. /**
  15180. * Gets or sets a boolean indicating that non uniform scaling (when at least one component is different from others) should be ignored.
  15181. * By default the system will update normals to compensate
  15182. */
  15183. ignoreNonUniformScaling: boolean;
  15184. /**
  15185. * 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
  15186. */
  15187. reIntegrateRotationIntoRotationQuaternion: boolean;
  15188. /** @hidden */
  15189. _poseMatrix: Nullable<Matrix>;
  15190. /** @hidden */
  15191. _localMatrix: Matrix;
  15192. private _usePivotMatrix;
  15193. private _absolutePosition;
  15194. private _absoluteScaling;
  15195. private _absoluteRotationQuaternion;
  15196. private _pivotMatrix;
  15197. private _pivotMatrixInverse;
  15198. /** @hidden */
  15199. _postMultiplyPivotMatrix: boolean;
  15200. protected _isWorldMatrixFrozen: boolean;
  15201. /** @hidden */
  15202. _indexInSceneTransformNodesArray: number;
  15203. /**
  15204. * An event triggered after the world matrix is updated
  15205. */
  15206. onAfterWorldMatrixUpdateObservable: Observable<TransformNode>;
  15207. constructor(name: string, scene?: Nullable<Scene>, isPure?: boolean);
  15208. /**
  15209. * Gets a string identifying the name of the class
  15210. * @returns "TransformNode" string
  15211. */
  15212. getClassName(): string;
  15213. /**
  15214. * Gets or set the node position (default is (0.0, 0.0, 0.0))
  15215. */
  15216. get position(): Vector3;
  15217. set position(newPosition: Vector3);
  15218. /**
  15219. * 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)).
  15220. * If rotation quaternion is set, this Vector3 will be ignored and copy from the quaternion
  15221. */
  15222. get rotation(): Vector3;
  15223. set rotation(newRotation: Vector3);
  15224. /**
  15225. * 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)).
  15226. */
  15227. get scaling(): Vector3;
  15228. set scaling(newScaling: Vector3);
  15229. /**
  15230. * 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).
  15231. * If set, only the rotationQuaternion is then used to compute the node rotation (ie. node.rotation will be ignored)
  15232. */
  15233. get rotationQuaternion(): Nullable<Quaternion>;
  15234. set rotationQuaternion(quaternion: Nullable<Quaternion>);
  15235. /**
  15236. * The forward direction of that transform in world space.
  15237. */
  15238. get forward(): Vector3;
  15239. /**
  15240. * The up direction of that transform in world space.
  15241. */
  15242. get up(): Vector3;
  15243. /**
  15244. * The right direction of that transform in world space.
  15245. */
  15246. get right(): Vector3;
  15247. /**
  15248. * Copies the parameter passed Matrix into the mesh Pose matrix.
  15249. * @param matrix the matrix to copy the pose from
  15250. * @returns this TransformNode.
  15251. */
  15252. updatePoseMatrix(matrix: Matrix): TransformNode;
  15253. /**
  15254. * Returns the mesh Pose matrix.
  15255. * @returns the pose matrix
  15256. */
  15257. getPoseMatrix(): Matrix;
  15258. /** @hidden */
  15259. _isSynchronized(): boolean;
  15260. /** @hidden */
  15261. _initCache(): void;
  15262. /**
  15263. * Flag the transform node as dirty (Forcing it to update everything)
  15264. * @param property if set to "rotation" the objects rotationQuaternion will be set to null
  15265. * @returns this transform node
  15266. */
  15267. markAsDirty(property: string): TransformNode;
  15268. /**
  15269. * Returns the current mesh absolute position.
  15270. * Returns a Vector3.
  15271. */
  15272. get absolutePosition(): Vector3;
  15273. /**
  15274. * Returns the current mesh absolute scaling.
  15275. * Returns a Vector3.
  15276. */
  15277. get absoluteScaling(): Vector3;
  15278. /**
  15279. * Returns the current mesh absolute rotation.
  15280. * Returns a Quaternion.
  15281. */
  15282. get absoluteRotationQuaternion(): Quaternion;
  15283. /**
  15284. * Sets a new matrix to apply before all other transformation
  15285. * @param matrix defines the transform matrix
  15286. * @returns the current TransformNode
  15287. */
  15288. setPreTransformMatrix(matrix: Matrix): TransformNode;
  15289. /**
  15290. * Sets a new pivot matrix to the current node
  15291. * @param matrix defines the new pivot matrix to use
  15292. * @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
  15293. * @returns the current TransformNode
  15294. */
  15295. setPivotMatrix(matrix: DeepImmutable<Matrix>, postMultiplyPivotMatrix?: boolean): TransformNode;
  15296. /**
  15297. * Returns the mesh pivot matrix.
  15298. * Default : Identity.
  15299. * @returns the matrix
  15300. */
  15301. getPivotMatrix(): Matrix;
  15302. /**
  15303. * Instantiate (when possible) or clone that node with its hierarchy
  15304. * @param newParent defines the new parent to use for the instance (or clone)
  15305. * @param options defines options to configure how copy is done
  15306. * @param onNewNodeCreated defines an option callback to call when a clone or an instance is created
  15307. * @returns an instance (or a clone) of the current node with its hiearchy
  15308. */
  15309. instantiateHierarchy(newParent?: Nullable<TransformNode>, options?: {
  15310. doNotInstantiate: boolean;
  15311. }, onNewNodeCreated?: (source: TransformNode, clone: TransformNode) => void): Nullable<TransformNode>;
  15312. /**
  15313. * Prevents the World matrix to be computed any longer
  15314. * @param newWorldMatrix defines an optional matrix to use as world matrix
  15315. * @returns the TransformNode.
  15316. */
  15317. freezeWorldMatrix(newWorldMatrix?: Nullable<Matrix>): TransformNode;
  15318. /**
  15319. * Allows back the World matrix computation.
  15320. * @returns the TransformNode.
  15321. */
  15322. unfreezeWorldMatrix(): this;
  15323. /**
  15324. * True if the World matrix has been frozen.
  15325. */
  15326. get isWorldMatrixFrozen(): boolean;
  15327. /**
  15328. * Retuns the mesh absolute position in the World.
  15329. * @returns a Vector3.
  15330. */
  15331. getAbsolutePosition(): Vector3;
  15332. /**
  15333. * Sets the mesh absolute position in the World from a Vector3 or an Array(3).
  15334. * @param absolutePosition the absolute position to set
  15335. * @returns the TransformNode.
  15336. */
  15337. setAbsolutePosition(absolutePosition: Vector3): TransformNode;
  15338. /**
  15339. * Sets the mesh position in its local space.
  15340. * @param vector3 the position to set in localspace
  15341. * @returns the TransformNode.
  15342. */
  15343. setPositionWithLocalVector(vector3: Vector3): TransformNode;
  15344. /**
  15345. * Returns the mesh position in the local space from the current World matrix values.
  15346. * @returns a new Vector3.
  15347. */
  15348. getPositionExpressedInLocalSpace(): Vector3;
  15349. /**
  15350. * Translates the mesh along the passed Vector3 in its local space.
  15351. * @param vector3 the distance to translate in localspace
  15352. * @returns the TransformNode.
  15353. */
  15354. locallyTranslate(vector3: Vector3): TransformNode;
  15355. private static _lookAtVectorCache;
  15356. /**
  15357. * Orients a mesh towards a target point. Mesh must be drawn facing user.
  15358. * @param targetPoint the position (must be in same space as current mesh) to look at
  15359. * @param yawCor optional yaw (y-axis) correction in radians
  15360. * @param pitchCor optional pitch (x-axis) correction in radians
  15361. * @param rollCor optional roll (z-axis) correction in radians
  15362. * @param space the choosen space of the target
  15363. * @returns the TransformNode.
  15364. */
  15365. lookAt(targetPoint: Vector3, yawCor?: number, pitchCor?: number, rollCor?: number, space?: Space): TransformNode;
  15366. /**
  15367. * Returns a new Vector3 that is the localAxis, expressed in the mesh local space, rotated like the mesh.
  15368. * This Vector3 is expressed in the World space.
  15369. * @param localAxis axis to rotate
  15370. * @returns a new Vector3 that is the localAxis, expressed in the mesh local space, rotated like the mesh.
  15371. */
  15372. getDirection(localAxis: Vector3): Vector3;
  15373. /**
  15374. * Sets the Vector3 "result" as the rotated Vector3 "localAxis" in the same rotation than the mesh.
  15375. * localAxis is expressed in the mesh local space.
  15376. * result is computed in the Wordl space from the mesh World matrix.
  15377. * @param localAxis axis to rotate
  15378. * @param result the resulting transformnode
  15379. * @returns this TransformNode.
  15380. */
  15381. getDirectionToRef(localAxis: Vector3, result: Vector3): TransformNode;
  15382. /**
  15383. * Sets this transform node rotation to the given local axis.
  15384. * @param localAxis the axis in local space
  15385. * @param yawCor optional yaw (y-axis) correction in radians
  15386. * @param pitchCor optional pitch (x-axis) correction in radians
  15387. * @param rollCor optional roll (z-axis) correction in radians
  15388. * @returns this TransformNode
  15389. */
  15390. setDirection(localAxis: Vector3, yawCor?: number, pitchCor?: number, rollCor?: number): TransformNode;
  15391. /**
  15392. * Sets a new pivot point to the current node
  15393. * @param point defines the new pivot point to use
  15394. * @param space defines if the point is in world or local space (local by default)
  15395. * @returns the current TransformNode
  15396. */
  15397. setPivotPoint(point: Vector3, space?: Space): TransformNode;
  15398. /**
  15399. * Returns a new Vector3 set with the mesh pivot point coordinates in the local space.
  15400. * @returns the pivot point
  15401. */
  15402. getPivotPoint(): Vector3;
  15403. /**
  15404. * Sets the passed Vector3 "result" with the coordinates of the mesh pivot point in the local space.
  15405. * @param result the vector3 to store the result
  15406. * @returns this TransformNode.
  15407. */
  15408. getPivotPointToRef(result: Vector3): TransformNode;
  15409. /**
  15410. * Returns a new Vector3 set with the mesh pivot point World coordinates.
  15411. * @returns a new Vector3 set with the mesh pivot point World coordinates.
  15412. */
  15413. getAbsolutePivotPoint(): Vector3;
  15414. /**
  15415. * Sets the Vector3 "result" coordinates with the mesh pivot point World coordinates.
  15416. * @param result vector3 to store the result
  15417. * @returns this TransformNode.
  15418. */
  15419. getAbsolutePivotPointToRef(result: Vector3): TransformNode;
  15420. /**
  15421. * Defines the passed node as the parent of the current node.
  15422. * The node will remain exactly where it is and its position / rotation will be updated accordingly
  15423. * @see https://doc.babylonjs.com/how_to/parenting
  15424. * @param node the node ot set as the parent
  15425. * @returns this TransformNode.
  15426. */
  15427. setParent(node: Nullable<Node>): TransformNode;
  15428. private _nonUniformScaling;
  15429. /**
  15430. * True if the scaling property of this object is non uniform eg. (1,2,1)
  15431. */
  15432. get nonUniformScaling(): boolean;
  15433. /** @hidden */
  15434. _updateNonUniformScalingState(value: boolean): boolean;
  15435. /**
  15436. * Attach the current TransformNode to another TransformNode associated with a bone
  15437. * @param bone Bone affecting the TransformNode
  15438. * @param affectedTransformNode TransformNode associated with the bone
  15439. * @returns this object
  15440. */
  15441. attachToBone(bone: Bone, affectedTransformNode: TransformNode): TransformNode;
  15442. /**
  15443. * Detach the transform node if its associated with a bone
  15444. * @returns this object
  15445. */
  15446. detachFromBone(): TransformNode;
  15447. private static _rotationAxisCache;
  15448. /**
  15449. * Rotates the mesh around the axis vector for the passed angle (amount) expressed in radians, in the given space.
  15450. * space (default LOCAL) can be either Space.LOCAL, either Space.WORLD.
  15451. * Note that the property `rotationQuaternion` is then automatically updated and the property `rotation` is set to (0,0,0) and no longer used.
  15452. * The passed axis is also normalized.
  15453. * @param axis the axis to rotate around
  15454. * @param amount the amount to rotate in radians
  15455. * @param space Space to rotate in (Default: local)
  15456. * @returns the TransformNode.
  15457. */
  15458. rotate(axis: Vector3, amount: number, space?: Space): TransformNode;
  15459. /**
  15460. * Rotates the mesh around the axis vector for the passed angle (amount) expressed in radians, in world space.
  15461. * Note that the property `rotationQuaternion` is then automatically updated and the property `rotation` is set to (0,0,0) and no longer used.
  15462. * The passed axis is also normalized. .
  15463. * Method is based on http://www.euclideanspace.com/maths/geometry/affine/aroundPoint/index.htm
  15464. * @param point the point to rotate around
  15465. * @param axis the axis to rotate around
  15466. * @param amount the amount to rotate in radians
  15467. * @returns the TransformNode
  15468. */
  15469. rotateAround(point: Vector3, axis: Vector3, amount: number): TransformNode;
  15470. /**
  15471. * Translates the mesh along the axis vector for the passed distance in the given space.
  15472. * space (default LOCAL) can be either Space.LOCAL, either Space.WORLD.
  15473. * @param axis the axis to translate in
  15474. * @param distance the distance to translate
  15475. * @param space Space to rotate in (Default: local)
  15476. * @returns the TransformNode.
  15477. */
  15478. translate(axis: Vector3, distance: number, space?: Space): TransformNode;
  15479. /**
  15480. * Adds a rotation step to the mesh current rotation.
  15481. * x, y, z are Euler angles expressed in radians.
  15482. * This methods updates the current mesh rotation, either mesh.rotation, either mesh.rotationQuaternion if it's set.
  15483. * This means this rotation is made in the mesh local space only.
  15484. * It's useful to set a custom rotation order different from the BJS standard one YXZ.
  15485. * Example : this rotates the mesh first around its local X axis, then around its local Z axis, finally around its local Y axis.
  15486. * ```javascript
  15487. * mesh.addRotation(x1, 0, 0).addRotation(0, 0, z2).addRotation(0, 0, y3);
  15488. * ```
  15489. * Note that `addRotation()` accumulates the passed rotation values to the current ones and computes the .rotation or .rotationQuaternion updated values.
  15490. * 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.
  15491. * @param x Rotation to add
  15492. * @param y Rotation to add
  15493. * @param z Rotation to add
  15494. * @returns the TransformNode.
  15495. */
  15496. addRotation(x: number, y: number, z: number): TransformNode;
  15497. /**
  15498. * @hidden
  15499. */
  15500. protected _getEffectiveParent(): Nullable<Node>;
  15501. /**
  15502. * Computes the world matrix of the node
  15503. * @param force defines if the cache version should be invalidated forcing the world matrix to be created from scratch
  15504. * @returns the world matrix
  15505. */
  15506. computeWorldMatrix(force?: boolean): Matrix;
  15507. /**
  15508. * Resets this nodeTransform's local matrix to Matrix.Identity().
  15509. * @param independentOfChildren indicates if all child nodeTransform's world-space transform should be preserved.
  15510. */
  15511. resetLocalMatrix(independentOfChildren?: boolean): void;
  15512. protected _afterComputeWorldMatrix(): void;
  15513. /**
  15514. * If you'd like to be called back after the mesh position, rotation or scaling has been updated.
  15515. * @param func callback function to add
  15516. *
  15517. * @returns the TransformNode.
  15518. */
  15519. registerAfterWorldMatrixUpdate(func: (mesh: TransformNode) => void): TransformNode;
  15520. /**
  15521. * Removes a registered callback function.
  15522. * @param func callback function to remove
  15523. * @returns the TransformNode.
  15524. */
  15525. unregisterAfterWorldMatrixUpdate(func: (mesh: TransformNode) => void): TransformNode;
  15526. /**
  15527. * Gets the position of the current mesh in camera space
  15528. * @param camera defines the camera to use
  15529. * @returns a position
  15530. */
  15531. getPositionInCameraSpace(camera?: Nullable<Camera>): Vector3;
  15532. /**
  15533. * Returns the distance from the mesh to the active camera
  15534. * @param camera defines the camera to use
  15535. * @returns the distance
  15536. */
  15537. getDistanceToCamera(camera?: Nullable<Camera>): number;
  15538. /**
  15539. * Clone the current transform node
  15540. * @param name Name of the new clone
  15541. * @param newParent New parent for the clone
  15542. * @param doNotCloneChildren Do not clone children hierarchy
  15543. * @returns the new transform node
  15544. */
  15545. clone(name: string, newParent: Nullable<Node>, doNotCloneChildren?: boolean): Nullable<TransformNode>;
  15546. /**
  15547. * Serializes the objects information.
  15548. * @param currentSerializationObject defines the object to serialize in
  15549. * @returns the serialized object
  15550. */
  15551. serialize(currentSerializationObject?: any): any;
  15552. /**
  15553. * Returns a new TransformNode object parsed from the source provided.
  15554. * @param parsedTransformNode is the source.
  15555. * @param scene the scne the object belongs to
  15556. * @param rootUrl is a string, it's the root URL to prefix the `delayLoadingFile` property with
  15557. * @returns a new TransformNode object parsed from the source provided.
  15558. */
  15559. static Parse(parsedTransformNode: any, scene: Scene, rootUrl: string): TransformNode;
  15560. /**
  15561. * Get all child-transformNodes of this node
  15562. * @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
  15563. * @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
  15564. * @returns an array of TransformNode
  15565. */
  15566. getChildTransformNodes(directDescendantsOnly?: boolean, predicate?: (node: Node) => boolean): TransformNode[];
  15567. /**
  15568. * Releases resources associated with this transform node.
  15569. * @param doNotRecurse Set to true to not recurse into each children (recurse into each children by default)
  15570. * @param disposeMaterialAndTextures Set to true to also dispose referenced materials and textures (false by default)
  15571. */
  15572. dispose(doNotRecurse?: boolean, disposeMaterialAndTextures?: boolean): void;
  15573. /**
  15574. * Uniformly scales the mesh to fit inside of a unit cube (1 X 1 X 1 units)
  15575. * @param includeDescendants Use the hierarchy's bounding box instead of the mesh's bounding box. Default is false
  15576. * @param ignoreRotation ignore rotation when computing the scale (ie. object will be axis aligned). Default is false
  15577. * @param predicate predicate that is passed in to getHierarchyBoundingVectors when selecting which object should be included when scaling
  15578. * @returns the current mesh
  15579. */
  15580. normalizeToUnitCube(includeDescendants?: boolean, ignoreRotation?: boolean, predicate?: Nullable<(node: AbstractMesh) => boolean>): TransformNode;
  15581. private _syncAbsoluteScalingAndRotation;
  15582. }
  15583. }
  15584. declare module "babylonjs/Animations/animationPropertiesOverride" {
  15585. /**
  15586. * Class used to override all child animations of a given target
  15587. */
  15588. export class AnimationPropertiesOverride {
  15589. /**
  15590. * Gets or sets a value indicating if animation blending must be used
  15591. */
  15592. enableBlending: boolean;
  15593. /**
  15594. * Gets or sets the blending speed to use when enableBlending is true
  15595. */
  15596. blendingSpeed: number;
  15597. /**
  15598. * Gets or sets the default loop mode to use
  15599. */
  15600. loopMode: number;
  15601. }
  15602. }
  15603. declare module "babylonjs/Bones/bone" {
  15604. import { Skeleton } from "babylonjs/Bones/skeleton";
  15605. import { Vector3, Quaternion, Matrix } from "babylonjs/Maths/math.vector";
  15606. import { Nullable } from "babylonjs/types";
  15607. import { AbstractMesh } from "babylonjs/Meshes/abstractMesh";
  15608. import { TransformNode } from "babylonjs/Meshes/transformNode";
  15609. import { Node } from "babylonjs/node";
  15610. import { Space } from "babylonjs/Maths/math.axis";
  15611. import { AnimationPropertiesOverride } from "babylonjs/Animations/animationPropertiesOverride";
  15612. /**
  15613. * Class used to store bone information
  15614. * @see https://doc.babylonjs.com/how_to/how_to_use_bones_and_skeletons
  15615. */
  15616. export class Bone extends Node {
  15617. /**
  15618. * defines the bone name
  15619. */
  15620. name: string;
  15621. private static _tmpVecs;
  15622. private static _tmpQuat;
  15623. private static _tmpMats;
  15624. /**
  15625. * Gets the list of child bones
  15626. */
  15627. children: Bone[];
  15628. /** Gets the animations associated with this bone */
  15629. animations: import("babylonjs/Animations/animation").Animation[];
  15630. /**
  15631. * Gets or sets bone length
  15632. */
  15633. length: number;
  15634. /**
  15635. * @hidden Internal only
  15636. * Set this value to map this bone to a different index in the transform matrices
  15637. * Set this value to -1 to exclude the bone from the transform matrices
  15638. */
  15639. _index: Nullable<number>;
  15640. private _skeleton;
  15641. private _localMatrix;
  15642. private _restPose;
  15643. private _bindPose;
  15644. private _baseMatrix;
  15645. private _absoluteTransform;
  15646. private _invertedAbsoluteTransform;
  15647. private _parent;
  15648. private _scalingDeterminant;
  15649. private _worldTransform;
  15650. private _localScaling;
  15651. private _localRotation;
  15652. private _localPosition;
  15653. private _needToDecompose;
  15654. private _needToCompose;
  15655. /** @hidden */
  15656. _linkedTransformNode: Nullable<TransformNode>;
  15657. /** @hidden */
  15658. _waitingTransformNodeId: Nullable<string>;
  15659. /** @hidden */
  15660. get _matrix(): Matrix;
  15661. /** @hidden */
  15662. set _matrix(value: Matrix);
  15663. /**
  15664. * Create a new bone
  15665. * @param name defines the bone name
  15666. * @param skeleton defines the parent skeleton
  15667. * @param parentBone defines the parent (can be null if the bone is the root)
  15668. * @param localMatrix defines the local matrix
  15669. * @param restPose defines the rest pose matrix
  15670. * @param baseMatrix defines the base matrix
  15671. * @param index defines index of the bone in the hiearchy
  15672. */
  15673. constructor(
  15674. /**
  15675. * defines the bone name
  15676. */
  15677. name: string, skeleton: Skeleton, parentBone?: Nullable<Bone>, localMatrix?: Nullable<Matrix>, restPose?: Nullable<Matrix>, baseMatrix?: Nullable<Matrix>, index?: Nullable<number>);
  15678. /**
  15679. * Gets the current object class name.
  15680. * @return the class name
  15681. */
  15682. getClassName(): string;
  15683. /**
  15684. * Gets the parent skeleton
  15685. * @returns a skeleton
  15686. */
  15687. getSkeleton(): Skeleton;
  15688. /**
  15689. * Gets parent bone
  15690. * @returns a bone or null if the bone is the root of the bone hierarchy
  15691. */
  15692. getParent(): Nullable<Bone>;
  15693. /**
  15694. * Returns an array containing the root bones
  15695. * @returns an array containing the root bones
  15696. */
  15697. getChildren(): Array<Bone>;
  15698. /**
  15699. * Gets the node index in matrix array generated for rendering
  15700. * @returns the node index
  15701. */
  15702. getIndex(): number;
  15703. /**
  15704. * Sets the parent bone
  15705. * @param parent defines the parent (can be null if the bone is the root)
  15706. * @param updateDifferenceMatrix defines if the difference matrix must be updated
  15707. */
  15708. setParent(parent: Nullable<Bone>, updateDifferenceMatrix?: boolean): void;
  15709. /**
  15710. * Gets the local matrix
  15711. * @returns a matrix
  15712. */
  15713. getLocalMatrix(): Matrix;
  15714. /**
  15715. * Gets the base matrix (initial matrix which remains unchanged)
  15716. * @returns a matrix
  15717. */
  15718. getBaseMatrix(): Matrix;
  15719. /**
  15720. * Gets the rest pose matrix
  15721. * @returns a matrix
  15722. */
  15723. getRestPose(): Matrix;
  15724. /**
  15725. * Sets the rest pose matrix
  15726. * @param matrix the local-space rest pose to set for this bone
  15727. */
  15728. setRestPose(matrix: Matrix): void;
  15729. /**
  15730. * Gets the bind pose matrix
  15731. * @returns the bind pose matrix
  15732. */
  15733. getBindPose(): Matrix;
  15734. /**
  15735. * Sets the bind pose matrix
  15736. * @param matrix the local-space bind pose to set for this bone
  15737. */
  15738. setBindPose(matrix: Matrix): void;
  15739. /**
  15740. * Gets a matrix used to store world matrix (ie. the matrix sent to shaders)
  15741. */
  15742. getWorldMatrix(): Matrix;
  15743. /**
  15744. * Sets the local matrix to rest pose matrix
  15745. */
  15746. returnToRest(): void;
  15747. /**
  15748. * Gets the inverse of the absolute transform matrix.
  15749. * This matrix will be multiplied by local matrix to get the difference matrix (ie. the difference between original state and current state)
  15750. * @returns a matrix
  15751. */
  15752. getInvertedAbsoluteTransform(): Matrix;
  15753. /**
  15754. * Gets the absolute transform matrix (ie base matrix * parent world matrix)
  15755. * @returns a matrix
  15756. */
  15757. getAbsoluteTransform(): Matrix;
  15758. /**
  15759. * Links with the given transform node.
  15760. * The local matrix of this bone is copied from the transform node every frame.
  15761. * @param transformNode defines the transform node to link to
  15762. */
  15763. linkTransformNode(transformNode: Nullable<TransformNode>): void;
  15764. /**
  15765. * Gets the node used to drive the bone's transformation
  15766. * @returns a transform node or null
  15767. */
  15768. getTransformNode(): Nullable<TransformNode>;
  15769. /** Gets or sets current position (in local space) */
  15770. get position(): Vector3;
  15771. set position(newPosition: Vector3);
  15772. /** Gets or sets current rotation (in local space) */
  15773. get rotation(): Vector3;
  15774. set rotation(newRotation: Vector3);
  15775. /** Gets or sets current rotation quaternion (in local space) */
  15776. get rotationQuaternion(): Quaternion;
  15777. set rotationQuaternion(newRotation: Quaternion);
  15778. /** Gets or sets current scaling (in local space) */
  15779. get scaling(): Vector3;
  15780. set scaling(newScaling: Vector3);
  15781. /**
  15782. * Gets the animation properties override
  15783. */
  15784. get animationPropertiesOverride(): Nullable<AnimationPropertiesOverride>;
  15785. private _decompose;
  15786. private _compose;
  15787. /**
  15788. * Update the base and local matrices
  15789. * @param matrix defines the new base or local matrix
  15790. * @param updateDifferenceMatrix defines if the difference matrix must be updated
  15791. * @param updateLocalMatrix defines if the local matrix should be updated
  15792. */
  15793. updateMatrix(matrix: Matrix, updateDifferenceMatrix?: boolean, updateLocalMatrix?: boolean): void;
  15794. /** @hidden */
  15795. _updateDifferenceMatrix(rootMatrix?: Matrix, updateChildren?: boolean): void;
  15796. /**
  15797. * Flag the bone as dirty (Forcing it to update everything)
  15798. */
  15799. markAsDirty(): void;
  15800. /** @hidden */
  15801. _markAsDirtyAndCompose(): void;
  15802. private _markAsDirtyAndDecompose;
  15803. /**
  15804. * Translate the bone in local or world space
  15805. * @param vec The amount to translate the bone
  15806. * @param space The space that the translation is in
  15807. * @param mesh The mesh that this bone is attached to. This is only used in world space
  15808. */
  15809. translate(vec: Vector3, space?: Space, mesh?: AbstractMesh): void;
  15810. /**
  15811. * Set the postion of the bone in local or world space
  15812. * @param position The position to set the bone
  15813. * @param space The space that the position is in
  15814. * @param mesh The mesh that this bone is attached to. This is only used in world space
  15815. */
  15816. setPosition(position: Vector3, space?: Space, mesh?: AbstractMesh): void;
  15817. /**
  15818. * Set the absolute position of the bone (world space)
  15819. * @param position The position to set the bone
  15820. * @param mesh The mesh that this bone is attached to
  15821. */
  15822. setAbsolutePosition(position: Vector3, mesh?: AbstractMesh): void;
  15823. /**
  15824. * Scale the bone on the x, y and z axes (in local space)
  15825. * @param x The amount to scale the bone on the x axis
  15826. * @param y The amount to scale the bone on the y axis
  15827. * @param z The amount to scale the bone on the z axis
  15828. * @param scaleChildren sets this to true if children of the bone should be scaled as well (false by default)
  15829. */
  15830. scale(x: number, y: number, z: number, scaleChildren?: boolean): void;
  15831. /**
  15832. * Set the bone scaling in local space
  15833. * @param scale defines the scaling vector
  15834. */
  15835. setScale(scale: Vector3): void;
  15836. /**
  15837. * Gets the current scaling in local space
  15838. * @returns the current scaling vector
  15839. */
  15840. getScale(): Vector3;
  15841. /**
  15842. * Gets the current scaling in local space and stores it in a target vector
  15843. * @param result defines the target vector
  15844. */
  15845. getScaleToRef(result: Vector3): void;
  15846. /**
  15847. * Set the yaw, pitch, and roll of the bone in local or world space
  15848. * @param yaw The rotation of the bone on the y axis
  15849. * @param pitch The rotation of the bone on the x axis
  15850. * @param roll The rotation of the bone on the z axis
  15851. * @param space The space that the axes of rotation are in
  15852. * @param mesh The mesh that this bone is attached to. This is only used in world space
  15853. */
  15854. setYawPitchRoll(yaw: number, pitch: number, roll: number, space?: Space, mesh?: AbstractMesh): void;
  15855. /**
  15856. * Add a rotation to the bone on an axis in local or world space
  15857. * @param axis The axis to rotate the bone on
  15858. * @param amount The amount to rotate the bone
  15859. * @param space The space that the axis is in
  15860. * @param mesh The mesh that this bone is attached to. This is only used in world space
  15861. */
  15862. rotate(axis: Vector3, amount: number, space?: Space, mesh?: AbstractMesh): void;
  15863. /**
  15864. * Set the rotation of the bone to a particular axis angle in local or world space
  15865. * @param axis The axis to rotate the bone on
  15866. * @param angle The angle that the bone should be rotated to
  15867. * @param space The space that the axis is in
  15868. * @param mesh The mesh that this bone is attached to. This is only used in world space
  15869. */
  15870. setAxisAngle(axis: Vector3, angle: number, space?: Space, mesh?: AbstractMesh): void;
  15871. /**
  15872. * Set the euler rotation of the bone in local or world space
  15873. * @param rotation The euler rotation that the bone should be set to
  15874. * @param space The space that the rotation is in
  15875. * @param mesh The mesh that this bone is attached to. This is only used in world space
  15876. */
  15877. setRotation(rotation: Vector3, space?: Space, mesh?: AbstractMesh): void;
  15878. /**
  15879. * Set the quaternion rotation of the bone in local or world space
  15880. * @param quat The quaternion rotation that the bone should be set to
  15881. * @param space The space that the rotation is in
  15882. * @param mesh The mesh that this bone is attached to. This is only used in world space
  15883. */
  15884. setRotationQuaternion(quat: Quaternion, space?: Space, mesh?: AbstractMesh): void;
  15885. /**
  15886. * Set the rotation matrix of the bone in local or world space
  15887. * @param rotMat The rotation matrix that the bone should be set to
  15888. * @param space The space that the rotation is in
  15889. * @param mesh The mesh that this bone is attached to. This is only used in world space
  15890. */
  15891. setRotationMatrix(rotMat: Matrix, space?: Space, mesh?: AbstractMesh): void;
  15892. private _rotateWithMatrix;
  15893. private _getNegativeRotationToRef;
  15894. /**
  15895. * Get the position of the bone in local or world space
  15896. * @param space The space that the returned position is in
  15897. * @param mesh The mesh that this bone is attached to. This is only used in world space
  15898. * @returns The position of the bone
  15899. */
  15900. getPosition(space?: Space, mesh?: Nullable<AbstractMesh>): Vector3;
  15901. /**
  15902. * Copy the position of the bone to a vector3 in local or world space
  15903. * @param space The space that the returned position is in
  15904. * @param mesh The mesh that this bone is attached to. This is only used in world space
  15905. * @param result The vector3 to copy the position to
  15906. */
  15907. getPositionToRef(space: Space | undefined, mesh: Nullable<AbstractMesh>, result: Vector3): void;
  15908. /**
  15909. * Get the absolute position of the bone (world space)
  15910. * @param mesh The mesh that this bone is attached to
  15911. * @returns The absolute position of the bone
  15912. */
  15913. getAbsolutePosition(mesh?: Nullable<AbstractMesh>): Vector3;
  15914. /**
  15915. * Copy the absolute position of the bone (world space) to the result param
  15916. * @param mesh The mesh that this bone is attached to
  15917. * @param result The vector3 to copy the absolute position to
  15918. */
  15919. getAbsolutePositionToRef(mesh: AbstractMesh, result: Vector3): void;
  15920. /**
  15921. * Compute the absolute transforms of this bone and its children
  15922. */
  15923. computeAbsoluteTransforms(): void;
  15924. /**
  15925. * Get the world direction from an axis that is in the local space of the bone
  15926. * @param localAxis The local direction that is used to compute the world direction
  15927. * @param mesh The mesh that this bone is attached to
  15928. * @returns The world direction
  15929. */
  15930. getDirection(localAxis: Vector3, mesh?: Nullable<AbstractMesh>): Vector3;
  15931. /**
  15932. * Copy the world direction to a vector3 from an axis that is in the local space of the bone
  15933. * @param localAxis The local direction that is used to compute the world direction
  15934. * @param mesh The mesh that this bone is attached to
  15935. * @param result The vector3 that the world direction will be copied to
  15936. */
  15937. getDirectionToRef(localAxis: Vector3, mesh: AbstractMesh | null | undefined, result: Vector3): void;
  15938. /**
  15939. * Get the euler rotation of the bone in local or world space
  15940. * @param space The space that the rotation should be in
  15941. * @param mesh The mesh that this bone is attached to. This is only used in world space
  15942. * @returns The euler rotation
  15943. */
  15944. getRotation(space?: Space, mesh?: Nullable<AbstractMesh>): Vector3;
  15945. /**
  15946. * Copy the euler rotation of the bone to a vector3. The rotation can be in either local or world space
  15947. * @param space The space that the rotation should be in
  15948. * @param mesh The mesh that this bone is attached to. This is only used in world space
  15949. * @param result The vector3 that the rotation should be copied to
  15950. */
  15951. getRotationToRef(space: Space | undefined, mesh: AbstractMesh | null | undefined, result: Vector3): void;
  15952. /**
  15953. * Get the quaternion rotation of the bone in either local or world space
  15954. * @param space The space that the rotation should be in
  15955. * @param mesh The mesh that this bone is attached to. This is only used in world space
  15956. * @returns The quaternion rotation
  15957. */
  15958. getRotationQuaternion(space?: Space, mesh?: Nullable<AbstractMesh>): Quaternion;
  15959. /**
  15960. * Copy the quaternion rotation of the bone to a quaternion. The rotation can be in either local or world space
  15961. * @param space The space that the rotation should be in
  15962. * @param mesh The mesh that this bone is attached to. This is only used in world space
  15963. * @param result The quaternion that the rotation should be copied to
  15964. */
  15965. getRotationQuaternionToRef(space: Space | undefined, mesh: AbstractMesh | null | undefined, result: Quaternion): void;
  15966. /**
  15967. * Get the rotation matrix of the bone in local or world space
  15968. * @param space The space that the rotation should be in
  15969. * @param mesh The mesh that this bone is attached to. This is only used in world space
  15970. * @returns The rotation matrix
  15971. */
  15972. getRotationMatrix(space: Space | undefined, mesh: AbstractMesh): Matrix;
  15973. /**
  15974. * Copy the rotation matrix of the bone to a matrix. The rotation can be in either local or world space
  15975. * @param space The space that the rotation should be in
  15976. * @param mesh The mesh that this bone is attached to. This is only used in world space
  15977. * @param result The quaternion that the rotation should be copied to
  15978. */
  15979. getRotationMatrixToRef(space: Space | undefined, mesh: AbstractMesh, result: Matrix): void;
  15980. /**
  15981. * Get the world position of a point that is in the local space of the bone
  15982. * @param position The local position
  15983. * @param mesh The mesh that this bone is attached to
  15984. * @returns The world position
  15985. */
  15986. getAbsolutePositionFromLocal(position: Vector3, mesh?: Nullable<AbstractMesh>): Vector3;
  15987. /**
  15988. * Get the world position of a point that is in the local space of the bone and copy it to the result param
  15989. * @param position The local position
  15990. * @param mesh The mesh that this bone is attached to
  15991. * @param result The vector3 that the world position should be copied to
  15992. */
  15993. getAbsolutePositionFromLocalToRef(position: Vector3, mesh: AbstractMesh | null | undefined, result: Vector3): void;
  15994. /**
  15995. * Get the local position of a point that is in world space
  15996. * @param position The world position
  15997. * @param mesh The mesh that this bone is attached to
  15998. * @returns The local position
  15999. */
  16000. getLocalPositionFromAbsolute(position: Vector3, mesh?: Nullable<AbstractMesh>): Vector3;
  16001. /**
  16002. * Get the local position of a point that is in world space and copy it to the result param
  16003. * @param position The world position
  16004. * @param mesh The mesh that this bone is attached to
  16005. * @param result The vector3 that the local position should be copied to
  16006. */
  16007. getLocalPositionFromAbsoluteToRef(position: Vector3, mesh: AbstractMesh | null | undefined, result: Vector3): void;
  16008. /**
  16009. * Set the current local matrix as the restPose for this bone.
  16010. */
  16011. setCurrentPoseAsRest(): void;
  16012. }
  16013. }
  16014. declare module "babylonjs/Animations/runtimeAnimation" {
  16015. import { Animation, _IAnimationState } from "babylonjs/Animations/animation";
  16016. import { Animatable } from "babylonjs/Animations/animatable";
  16017. import { Scene } from "babylonjs/scene";
  16018. /**
  16019. * Defines a runtime animation
  16020. */
  16021. export class RuntimeAnimation {
  16022. private _events;
  16023. /**
  16024. * The current frame of the runtime animation
  16025. */
  16026. private _currentFrame;
  16027. /**
  16028. * The animation used by the runtime animation
  16029. */
  16030. private _animation;
  16031. /**
  16032. * The target of the runtime animation
  16033. */
  16034. private _target;
  16035. /**
  16036. * The initiating animatable
  16037. */
  16038. private _host;
  16039. /**
  16040. * The original value of the runtime animation
  16041. */
  16042. private _originalValue;
  16043. /**
  16044. * The original blend value of the runtime animation
  16045. */
  16046. private _originalBlendValue;
  16047. /**
  16048. * The offsets cache of the runtime animation
  16049. */
  16050. private _offsetsCache;
  16051. /**
  16052. * The high limits cache of the runtime animation
  16053. */
  16054. private _highLimitsCache;
  16055. /**
  16056. * Specifies if the runtime animation has been stopped
  16057. */
  16058. private _stopped;
  16059. /**
  16060. * The blending factor of the runtime animation
  16061. */
  16062. private _blendingFactor;
  16063. /**
  16064. * The BabylonJS scene
  16065. */
  16066. private _scene;
  16067. /**
  16068. * The current value of the runtime animation
  16069. */
  16070. private _currentValue;
  16071. /** @hidden */
  16072. _animationState: _IAnimationState;
  16073. /**
  16074. * The active target of the runtime animation
  16075. */
  16076. private _activeTargets;
  16077. private _currentActiveTarget;
  16078. private _directTarget;
  16079. /**
  16080. * The target path of the runtime animation
  16081. */
  16082. private _targetPath;
  16083. /**
  16084. * The weight of the runtime animation
  16085. */
  16086. private _weight;
  16087. /**
  16088. * The ratio offset of the runtime animation
  16089. */
  16090. private _ratioOffset;
  16091. /**
  16092. * The previous delay of the runtime animation
  16093. */
  16094. private _previousDelay;
  16095. /**
  16096. * The previous ratio of the runtime animation
  16097. */
  16098. private _previousRatio;
  16099. private _enableBlending;
  16100. private _keys;
  16101. private _minFrame;
  16102. private _maxFrame;
  16103. private _minValue;
  16104. private _maxValue;
  16105. private _targetIsArray;
  16106. /**
  16107. * Gets the current frame of the runtime animation
  16108. */
  16109. get currentFrame(): number;
  16110. /**
  16111. * Gets the weight of the runtime animation
  16112. */
  16113. get weight(): number;
  16114. /**
  16115. * Gets the current value of the runtime animation
  16116. */
  16117. get currentValue(): any;
  16118. /**
  16119. * Gets the target path of the runtime animation
  16120. */
  16121. get targetPath(): string;
  16122. /**
  16123. * Gets the actual target of the runtime animation
  16124. */
  16125. get target(): any;
  16126. /**
  16127. * Gets the additive state of the runtime animation
  16128. */
  16129. get isAdditive(): boolean;
  16130. /** @hidden */
  16131. _onLoop: () => void;
  16132. /**
  16133. * Create a new RuntimeAnimation object
  16134. * @param target defines the target of the animation
  16135. * @param animation defines the source animation object
  16136. * @param scene defines the hosting scene
  16137. * @param host defines the initiating Animatable
  16138. */
  16139. constructor(target: any, animation: Animation, scene: Scene, host: Animatable);
  16140. private _preparePath;
  16141. /**
  16142. * Gets the animation from the runtime animation
  16143. */
  16144. get animation(): Animation;
  16145. /**
  16146. * Resets the runtime animation to the beginning
  16147. * @param restoreOriginal defines whether to restore the target property to the original value
  16148. */
  16149. reset(restoreOriginal?: boolean): void;
  16150. /**
  16151. * Specifies if the runtime animation is stopped
  16152. * @returns Boolean specifying if the runtime animation is stopped
  16153. */
  16154. isStopped(): boolean;
  16155. /**
  16156. * Disposes of the runtime animation
  16157. */
  16158. dispose(): void;
  16159. /**
  16160. * Apply the interpolated value to the target
  16161. * @param currentValue defines the value computed by the animation
  16162. * @param weight defines the weight to apply to this value (Defaults to 1.0)
  16163. */
  16164. setValue(currentValue: any, weight: number): void;
  16165. private _getOriginalValues;
  16166. private _setValue;
  16167. /**
  16168. * Gets the loop pmode of the runtime animation
  16169. * @returns Loop Mode
  16170. */
  16171. private _getCorrectLoopMode;
  16172. /**
  16173. * Move the current animation to a given frame
  16174. * @param frame defines the frame to move to
  16175. */
  16176. goToFrame(frame: number): void;
  16177. /**
  16178. * @hidden Internal use only
  16179. */
  16180. _prepareForSpeedRatioChange(newSpeedRatio: number): void;
  16181. /**
  16182. * Execute the current animation
  16183. * @param delay defines the delay to add to the current frame
  16184. * @param from defines the lower bound of the animation range
  16185. * @param to defines the upper bound of the animation range
  16186. * @param loop defines if the current animation must loop
  16187. * @param speedRatio defines the current speed ratio
  16188. * @param weight defines the weight of the animation (default is -1 so no weight)
  16189. * @param onLoop optional callback called when animation loops
  16190. * @returns a boolean indicating if the animation is running
  16191. */
  16192. animate(delay: number, from: number, to: number, loop: boolean, speedRatio: number, weight?: number): boolean;
  16193. }
  16194. }
  16195. declare module "babylonjs/Animations/animatable" {
  16196. import { Animation } from "babylonjs/Animations/animation";
  16197. import { RuntimeAnimation } from "babylonjs/Animations/runtimeAnimation";
  16198. import { Nullable } from "babylonjs/types";
  16199. import { Observable } from "babylonjs/Misc/observable";
  16200. import { Scene } from "babylonjs/scene";
  16201. import { Matrix, Quaternion, Vector3 } from "babylonjs/Maths/math.vector";
  16202. import { Node } from "babylonjs/node";
  16203. /**
  16204. * Class used to store an actual running animation
  16205. */
  16206. export class Animatable {
  16207. /** defines the target object */
  16208. target: any;
  16209. /** defines the starting frame number (default is 0) */
  16210. fromFrame: number;
  16211. /** defines the ending frame number (default is 100) */
  16212. toFrame: number;
  16213. /** defines if the animation must loop (default is false) */
  16214. loopAnimation: boolean;
  16215. /** defines a callback to call when animation ends if it is not looping */
  16216. onAnimationEnd?: (() => void) | null | undefined;
  16217. /** defines a callback to call when animation loops */
  16218. onAnimationLoop?: (() => void) | null | undefined;
  16219. /** defines whether the animation should be evaluated additively */
  16220. isAdditive: boolean;
  16221. private _localDelayOffset;
  16222. private _pausedDelay;
  16223. private _runtimeAnimations;
  16224. private _paused;
  16225. private _scene;
  16226. private _speedRatio;
  16227. private _weight;
  16228. private _syncRoot;
  16229. /**
  16230. * Gets or sets a boolean indicating if the animatable must be disposed and removed at the end of the animation.
  16231. * This will only apply for non looping animation (default is true)
  16232. */
  16233. disposeOnEnd: boolean;
  16234. /**
  16235. * Gets a boolean indicating if the animation has started
  16236. */
  16237. animationStarted: boolean;
  16238. /**
  16239. * Observer raised when the animation ends
  16240. */
  16241. onAnimationEndObservable: Observable<Animatable>;
  16242. /**
  16243. * Observer raised when the animation loops
  16244. */
  16245. onAnimationLoopObservable: Observable<Animatable>;
  16246. /**
  16247. * Gets the root Animatable used to synchronize and normalize animations
  16248. */
  16249. get syncRoot(): Nullable<Animatable>;
  16250. /**
  16251. * Gets the current frame of the first RuntimeAnimation
  16252. * Used to synchronize Animatables
  16253. */
  16254. get masterFrame(): number;
  16255. /**
  16256. * Gets or sets the animatable weight (-1.0 by default meaning not weighted)
  16257. */
  16258. get weight(): number;
  16259. set weight(value: number);
  16260. /**
  16261. * Gets or sets the speed ratio to apply to the animatable (1.0 by default)
  16262. */
  16263. get speedRatio(): number;
  16264. set speedRatio(value: number);
  16265. /**
  16266. * Creates a new Animatable
  16267. * @param scene defines the hosting scene
  16268. * @param target defines the target object
  16269. * @param fromFrame defines the starting frame number (default is 0)
  16270. * @param toFrame defines the ending frame number (default is 100)
  16271. * @param loopAnimation defines if the animation must loop (default is false)
  16272. * @param speedRatio defines the factor to apply to animation speed (default is 1)
  16273. * @param onAnimationEnd defines a callback to call when animation ends if it is not looping
  16274. * @param animations defines a group of animation to add to the new Animatable
  16275. * @param onAnimationLoop defines a callback to call when animation loops
  16276. * @param isAdditive defines whether the animation should be evaluated additively
  16277. */
  16278. constructor(scene: Scene,
  16279. /** defines the target object */
  16280. target: any,
  16281. /** defines the starting frame number (default is 0) */
  16282. fromFrame?: number,
  16283. /** defines the ending frame number (default is 100) */
  16284. toFrame?: number,
  16285. /** defines if the animation must loop (default is false) */
  16286. loopAnimation?: boolean, speedRatio?: number,
  16287. /** defines a callback to call when animation ends if it is not looping */
  16288. onAnimationEnd?: (() => void) | null | undefined, animations?: Animation[],
  16289. /** defines a callback to call when animation loops */
  16290. onAnimationLoop?: (() => void) | null | undefined,
  16291. /** defines whether the animation should be evaluated additively */
  16292. isAdditive?: boolean);
  16293. /**
  16294. * Synchronize and normalize current Animatable with a source Animatable
  16295. * This is useful when using animation weights and when animations are not of the same length
  16296. * @param root defines the root Animatable to synchronize with
  16297. * @returns the current Animatable
  16298. */
  16299. syncWith(root: Animatable): Animatable;
  16300. /**
  16301. * Gets the list of runtime animations
  16302. * @returns an array of RuntimeAnimation
  16303. */
  16304. getAnimations(): RuntimeAnimation[];
  16305. /**
  16306. * Adds more animations to the current animatable
  16307. * @param target defines the target of the animations
  16308. * @param animations defines the new animations to add
  16309. */
  16310. appendAnimations(target: any, animations: Animation[]): void;
  16311. /**
  16312. * Gets the source animation for a specific property
  16313. * @param property defines the propertyu to look for
  16314. * @returns null or the source animation for the given property
  16315. */
  16316. getAnimationByTargetProperty(property: string): Nullable<Animation>;
  16317. /**
  16318. * Gets the runtime animation for a specific property
  16319. * @param property defines the propertyu to look for
  16320. * @returns null or the runtime animation for the given property
  16321. */
  16322. getRuntimeAnimationByTargetProperty(property: string): Nullable<RuntimeAnimation>;
  16323. /**
  16324. * Resets the animatable to its original state
  16325. */
  16326. reset(): void;
  16327. /**
  16328. * Allows the animatable to blend with current running animations
  16329. * @see https://doc.babylonjs.com/babylon101/animations#animation-blending
  16330. * @param blendingSpeed defines the blending speed to use
  16331. */
  16332. enableBlending(blendingSpeed: number): void;
  16333. /**
  16334. * Disable animation blending
  16335. * @see https://doc.babylonjs.com/babylon101/animations#animation-blending
  16336. */
  16337. disableBlending(): void;
  16338. /**
  16339. * Jump directly to a given frame
  16340. * @param frame defines the frame to jump to
  16341. */
  16342. goToFrame(frame: number): void;
  16343. /**
  16344. * Pause the animation
  16345. */
  16346. pause(): void;
  16347. /**
  16348. * Restart the animation
  16349. */
  16350. restart(): void;
  16351. private _raiseOnAnimationEnd;
  16352. /**
  16353. * Stop and delete the current animation
  16354. * @param animationName defines a string used to only stop some of the runtime animations instead of all
  16355. * @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)
  16356. */
  16357. stop(animationName?: string, targetMask?: (target: any) => boolean): void;
  16358. /**
  16359. * Wait asynchronously for the animation to end
  16360. * @returns a promise which will be fullfilled when the animation ends
  16361. */
  16362. waitAsync(): Promise<Animatable>;
  16363. /** @hidden */
  16364. _animate(delay: number): boolean;
  16365. }
  16366. module "babylonjs/scene" {
  16367. interface Scene {
  16368. /** @hidden */
  16369. _registerTargetForLateAnimationBinding(runtimeAnimation: RuntimeAnimation, originalValue: any): void;
  16370. /** @hidden */
  16371. _processLateAnimationBindingsForMatrices(holder: {
  16372. totalWeight: number;
  16373. totalAdditiveWeight: number;
  16374. animations: RuntimeAnimation[];
  16375. additiveAnimations: RuntimeAnimation[];
  16376. originalValue: Matrix;
  16377. }): any;
  16378. /** @hidden */
  16379. _processLateAnimationBindingsForQuaternions(holder: {
  16380. totalWeight: number;
  16381. totalAdditiveWeight: number;
  16382. animations: RuntimeAnimation[];
  16383. additiveAnimations: RuntimeAnimation[];
  16384. originalValue: Quaternion;
  16385. }, refQuaternion: Quaternion): Quaternion;
  16386. /** @hidden */
  16387. _processLateAnimationBindings(): void;
  16388. /**
  16389. * Will start the animation sequence of a given target
  16390. * @param target defines the target
  16391. * @param from defines from which frame should animation start
  16392. * @param to defines until which frame should animation run.
  16393. * @param weight defines the weight to apply to the animation (1.0 by default)
  16394. * @param loop defines if the animation loops
  16395. * @param speedRatio defines the speed in which to run the animation (1.0 by default)
  16396. * @param onAnimationEnd defines the function to be executed when the animation ends
  16397. * @param animatable defines an animatable object. If not provided a new one will be created from the given params
  16398. * @param targetMask defines if the target should be animated if animations are present (this is called recursively on descendant animatables regardless of return value)
  16399. * @param onAnimationLoop defines the callback to call when an animation loops
  16400. * @param isAdditive defines whether the animation should be evaluated additively (false by default)
  16401. * @returns the animatable object created for this animation
  16402. */
  16403. 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;
  16404. /**
  16405. * Will start the animation sequence of a given target
  16406. * @param target defines the target
  16407. * @param from defines from which frame should animation start
  16408. * @param to defines until which frame should animation run.
  16409. * @param loop defines if the animation loops
  16410. * @param speedRatio defines the speed in which to run the animation (1.0 by default)
  16411. * @param onAnimationEnd defines the function to be executed when the animation ends
  16412. * @param animatable defines an animatable object. If not provided a new one will be created from the given params
  16413. * @param stopCurrent defines if the current animations must be stopped first (true by default)
  16414. * @param targetMask defines if the target should be animate if animations are present (this is called recursively on descendant animatables regardless of return value)
  16415. * @param onAnimationLoop defines the callback to call when an animation loops
  16416. * @param isAdditive defines whether the animation should be evaluated additively (false by default)
  16417. * @returns the animatable object created for this animation
  16418. */
  16419. 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;
  16420. /**
  16421. * Will start the animation sequence of a given target and its hierarchy
  16422. * @param target defines the target
  16423. * @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.
  16424. * @param from defines from which frame should animation start
  16425. * @param to defines until which frame should animation run.
  16426. * @param loop defines if the animation loops
  16427. * @param speedRatio defines the speed in which to run the animation (1.0 by default)
  16428. * @param onAnimationEnd defines the function to be executed when the animation ends
  16429. * @param animatable defines an animatable object. If not provided a new one will be created from the given params
  16430. * @param stopCurrent defines if the current animations must be stopped first (true by default)
  16431. * @param targetMask defines if the target should be animated if animations are present (this is called recursively on descendant animatables regardless of return value)
  16432. * @param onAnimationLoop defines the callback to call when an animation loops
  16433. * @param isAdditive defines whether the animation should be evaluated additively (false by default)
  16434. * @returns the list of created animatables
  16435. */
  16436. 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[];
  16437. /**
  16438. * Begin a new animation on a given node
  16439. * @param target defines the target where the animation will take place
  16440. * @param animations defines the list of animations to start
  16441. * @param from defines the initial value
  16442. * @param to defines the final value
  16443. * @param loop defines if you want animation to loop (off by default)
  16444. * @param speedRatio defines the speed ratio to apply to all animations
  16445. * @param onAnimationEnd defines the callback to call when an animation ends (will be called once per node)
  16446. * @param onAnimationLoop defines the callback to call when an animation loops
  16447. * @param isAdditive defines whether the animation should be evaluated additively (false by default)
  16448. * @returns the list of created animatables
  16449. */
  16450. beginDirectAnimation(target: any, animations: Animation[], from: number, to: number, loop?: boolean, speedRatio?: number, onAnimationEnd?: () => void, onAnimationLoop?: () => void, isAdditive?: boolean): Animatable;
  16451. /**
  16452. * Begin a new animation on a given node and its hierarchy
  16453. * @param target defines the root node where the animation will take place
  16454. * @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.
  16455. * @param animations defines the list of animations to start
  16456. * @param from defines the initial value
  16457. * @param to defines the final value
  16458. * @param loop defines if you want animation to loop (off by default)
  16459. * @param speedRatio defines the speed ratio to apply to all animations
  16460. * @param onAnimationEnd defines the callback to call when an animation ends (will be called once per node)
  16461. * @param onAnimationLoop defines the callback to call when an animation loops
  16462. * @param isAdditive defines whether the animation should be evaluated additively (false by default)
  16463. * @returns the list of animatables created for all nodes
  16464. */
  16465. beginDirectHierarchyAnimation(target: Node, directDescendantsOnly: boolean, animations: Animation[], from: number, to: number, loop?: boolean, speedRatio?: number, onAnimationEnd?: () => void, onAnimationLoop?: () => void, isAdditive?: boolean): Animatable[];
  16466. /**
  16467. * Gets the animatable associated with a specific target
  16468. * @param target defines the target of the animatable
  16469. * @returns the required animatable if found
  16470. */
  16471. getAnimatableByTarget(target: any): Nullable<Animatable>;
  16472. /**
  16473. * Gets all animatables associated with a given target
  16474. * @param target defines the target to look animatables for
  16475. * @returns an array of Animatables
  16476. */
  16477. getAllAnimatablesByTarget(target: any): Array<Animatable>;
  16478. /**
  16479. * Stops and removes all animations that have been applied to the scene
  16480. */
  16481. stopAllAnimations(): void;
  16482. /**
  16483. * Gets the current delta time used by animation engine
  16484. */
  16485. deltaTime: number;
  16486. }
  16487. }
  16488. module "babylonjs/Bones/bone" {
  16489. interface Bone {
  16490. /**
  16491. * Copy an animation range from another bone
  16492. * @param source defines the source bone
  16493. * @param rangeName defines the range name to copy
  16494. * @param frameOffset defines the frame offset
  16495. * @param rescaleAsRequired defines if rescaling must be applied if required
  16496. * @param skelDimensionsRatio defines the scaling ratio
  16497. * @returns true if operation was successful
  16498. */
  16499. copyAnimationRange(source: Bone, rangeName: string, frameOffset: number, rescaleAsRequired: boolean, skelDimensionsRatio: Nullable<Vector3>): boolean;
  16500. }
  16501. }
  16502. }
  16503. declare module "babylonjs/Bones/skeleton" {
  16504. import { Bone } from "babylonjs/Bones/bone";
  16505. import { Observable } from "babylonjs/Misc/observable";
  16506. import { Vector3, Matrix } from "babylonjs/Maths/math.vector";
  16507. import { Scene } from "babylonjs/scene";
  16508. import { Nullable } from "babylonjs/types";
  16509. import { AbstractMesh } from "babylonjs/Meshes/abstractMesh";
  16510. import { RawTexture } from "babylonjs/Materials/Textures/rawTexture";
  16511. import { Animatable } from "babylonjs/Animations/animatable";
  16512. import { AnimationPropertiesOverride } from "babylonjs/Animations/animationPropertiesOverride";
  16513. import { Animation } from "babylonjs/Animations/animation";
  16514. import { AnimationRange } from "babylonjs/Animations/animationRange";
  16515. import { IInspectable } from "babylonjs/Misc/iInspectable";
  16516. import { IAnimatable } from "babylonjs/Animations/animatable.interface";
  16517. /**
  16518. * Class used to handle skinning animations
  16519. * @see https://doc.babylonjs.com/how_to/how_to_use_bones_and_skeletons
  16520. */
  16521. export class Skeleton implements IAnimatable {
  16522. /** defines the skeleton name */
  16523. name: string;
  16524. /** defines the skeleton Id */
  16525. id: string;
  16526. /**
  16527. * Defines the list of child bones
  16528. */
  16529. bones: Bone[];
  16530. /**
  16531. * Defines an estimate of the dimension of the skeleton at rest
  16532. */
  16533. dimensionsAtRest: Vector3;
  16534. /**
  16535. * Defines a boolean indicating if the root matrix is provided by meshes or by the current skeleton (this is the default value)
  16536. */
  16537. needInitialSkinMatrix: boolean;
  16538. /**
  16539. * Defines a mesh that override the matrix used to get the world matrix (null by default).
  16540. */
  16541. overrideMesh: Nullable<AbstractMesh>;
  16542. /**
  16543. * Gets the list of animations attached to this skeleton
  16544. */
  16545. animations: Array<Animation>;
  16546. private _scene;
  16547. private _isDirty;
  16548. private _transformMatrices;
  16549. private _transformMatrixTexture;
  16550. private _meshesWithPoseMatrix;
  16551. private _animatables;
  16552. private _identity;
  16553. private _synchronizedWithMesh;
  16554. private _ranges;
  16555. private _lastAbsoluteTransformsUpdateId;
  16556. private _canUseTextureForBones;
  16557. private _uniqueId;
  16558. /** @hidden */
  16559. _numBonesWithLinkedTransformNode: number;
  16560. /** @hidden */
  16561. _hasWaitingData: Nullable<boolean>;
  16562. /** @hidden */
  16563. _waitingOverrideMeshId: Nullable<string>;
  16564. /**
  16565. * Specifies if the skeleton should be serialized
  16566. */
  16567. doNotSerialize: boolean;
  16568. private _useTextureToStoreBoneMatrices;
  16569. /**
  16570. * Gets or sets a boolean indicating that bone matrices should be stored as a texture instead of using shader uniforms (default is true).
  16571. * Please note that this option is not available if the hardware does not support it
  16572. */
  16573. get useTextureToStoreBoneMatrices(): boolean;
  16574. set useTextureToStoreBoneMatrices(value: boolean);
  16575. private _animationPropertiesOverride;
  16576. /**
  16577. * Gets or sets the animation properties override
  16578. */
  16579. get animationPropertiesOverride(): Nullable<AnimationPropertiesOverride>;
  16580. set animationPropertiesOverride(value: Nullable<AnimationPropertiesOverride>);
  16581. /**
  16582. * List of inspectable custom properties (used by the Inspector)
  16583. * @see https://doc.babylonjs.com/how_to/debug_layer#extensibility
  16584. */
  16585. inspectableCustomProperties: IInspectable[];
  16586. /**
  16587. * An observable triggered before computing the skeleton's matrices
  16588. */
  16589. onBeforeComputeObservable: Observable<Skeleton>;
  16590. /**
  16591. * Gets a boolean indicating that the skeleton effectively stores matrices into a texture
  16592. */
  16593. get isUsingTextureForMatrices(): boolean;
  16594. /**
  16595. * Gets the unique ID of this skeleton
  16596. */
  16597. get uniqueId(): number;
  16598. /**
  16599. * Creates a new skeleton
  16600. * @param name defines the skeleton name
  16601. * @param id defines the skeleton Id
  16602. * @param scene defines the hosting scene
  16603. */
  16604. constructor(
  16605. /** defines the skeleton name */
  16606. name: string,
  16607. /** defines the skeleton Id */
  16608. id: string, scene: Scene);
  16609. /**
  16610. * Gets the current object class name.
  16611. * @return the class name
  16612. */
  16613. getClassName(): string;
  16614. /**
  16615. * Returns an array containing the root bones
  16616. * @returns an array containing the root bones
  16617. */
  16618. getChildren(): Array<Bone>;
  16619. /**
  16620. * Gets the list of transform matrices to send to shaders (one matrix per bone)
  16621. * @param mesh defines the mesh to use to get the root matrix (if needInitialSkinMatrix === true)
  16622. * @returns a Float32Array containing matrices data
  16623. */
  16624. getTransformMatrices(mesh: AbstractMesh): Float32Array;
  16625. /**
  16626. * Gets the list of transform matrices to send to shaders inside a texture (one matrix per bone)
  16627. * @param mesh defines the mesh to use to get the root matrix (if needInitialSkinMatrix === true)
  16628. * @returns a raw texture containing the data
  16629. */
  16630. getTransformMatrixTexture(mesh: AbstractMesh): Nullable<RawTexture>;
  16631. /**
  16632. * Gets the current hosting scene
  16633. * @returns a scene object
  16634. */
  16635. getScene(): Scene;
  16636. /**
  16637. * Gets a string representing the current skeleton data
  16638. * @param fullDetails defines a boolean indicating if we want a verbose version
  16639. * @returns a string representing the current skeleton data
  16640. */
  16641. toString(fullDetails?: boolean): string;
  16642. /**
  16643. * Get bone's index searching by name
  16644. * @param name defines bone's name to search for
  16645. * @return the indice of the bone. Returns -1 if not found
  16646. */
  16647. getBoneIndexByName(name: string): number;
  16648. /**
  16649. * Creater a new animation range
  16650. * @param name defines the name of the range
  16651. * @param from defines the start key
  16652. * @param to defines the end key
  16653. */
  16654. createAnimationRange(name: string, from: number, to: number): void;
  16655. /**
  16656. * Delete a specific animation range
  16657. * @param name defines the name of the range
  16658. * @param deleteFrames defines if frames must be removed as well
  16659. */
  16660. deleteAnimationRange(name: string, deleteFrames?: boolean): void;
  16661. /**
  16662. * Gets a specific animation range
  16663. * @param name defines the name of the range to look for
  16664. * @returns the requested animation range or null if not found
  16665. */
  16666. getAnimationRange(name: string): Nullable<AnimationRange>;
  16667. /**
  16668. * Gets the list of all animation ranges defined on this skeleton
  16669. * @returns an array
  16670. */
  16671. getAnimationRanges(): Nullable<AnimationRange>[];
  16672. /**
  16673. * Copy animation range from a source skeleton.
  16674. * This is not for a complete retargeting, only between very similar skeleton's with only possible bone length differences
  16675. * @param source defines the source skeleton
  16676. * @param name defines the name of the range to copy
  16677. * @param rescaleAsRequired defines if rescaling must be applied if required
  16678. * @returns true if operation was successful
  16679. */
  16680. copyAnimationRange(source: Skeleton, name: string, rescaleAsRequired?: boolean): boolean;
  16681. /**
  16682. * Forces the skeleton to go to rest pose
  16683. */
  16684. returnToRest(): void;
  16685. private _getHighestAnimationFrame;
  16686. /**
  16687. * Begin a specific animation range
  16688. * @param name defines the name of the range to start
  16689. * @param loop defines if looping must be turned on (false by default)
  16690. * @param speedRatio defines the speed ratio to apply (1 by default)
  16691. * @param onAnimationEnd defines a callback which will be called when animation will end
  16692. * @returns a new animatable
  16693. */
  16694. beginAnimation(name: string, loop?: boolean, speedRatio?: number, onAnimationEnd?: () => void): Nullable<Animatable>;
  16695. /**
  16696. * Convert the keyframes for a range of animation on a skeleton to be relative to a given reference frame.
  16697. * @param skeleton defines the Skeleton containing the animation range to convert
  16698. * @param referenceFrame defines the frame that keyframes in the range will be relative to
  16699. * @param range defines the name of the AnimationRange belonging to the Skeleton to convert
  16700. * @returns the original skeleton
  16701. */
  16702. static MakeAnimationAdditive(skeleton: Skeleton, referenceFrame: number | undefined, range: string): Nullable<Skeleton>;
  16703. /** @hidden */
  16704. _markAsDirty(): void;
  16705. /** @hidden */
  16706. _registerMeshWithPoseMatrix(mesh: AbstractMesh): void;
  16707. /** @hidden */
  16708. _unregisterMeshWithPoseMatrix(mesh: AbstractMesh): void;
  16709. private _computeTransformMatrices;
  16710. /**
  16711. * Build all resources required to render a skeleton
  16712. */
  16713. prepare(): void;
  16714. /**
  16715. * Gets the list of animatables currently running for this skeleton
  16716. * @returns an array of animatables
  16717. */
  16718. getAnimatables(): IAnimatable[];
  16719. /**
  16720. * Clone the current skeleton
  16721. * @param name defines the name of the new skeleton
  16722. * @param id defines the id of the new skeleton
  16723. * @returns the new skeleton
  16724. */
  16725. clone(name: string, id?: string): Skeleton;
  16726. /**
  16727. * Enable animation blending for this skeleton
  16728. * @param blendingSpeed defines the blending speed to apply
  16729. * @see https://doc.babylonjs.com/babylon101/animations#animation-blending
  16730. */
  16731. enableBlending(blendingSpeed?: number): void;
  16732. /**
  16733. * Releases all resources associated with the current skeleton
  16734. */
  16735. dispose(): void;
  16736. /**
  16737. * Serialize the skeleton in a JSON object
  16738. * @returns a JSON object
  16739. */
  16740. serialize(): any;
  16741. /**
  16742. * Creates a new skeleton from serialized data
  16743. * @param parsedSkeleton defines the serialized data
  16744. * @param scene defines the hosting scene
  16745. * @returns a new skeleton
  16746. */
  16747. static Parse(parsedSkeleton: any, scene: Scene): Skeleton;
  16748. /**
  16749. * Compute all node absolute transforms
  16750. * @param forceUpdate defines if computation must be done even if cache is up to date
  16751. */
  16752. computeAbsoluteTransforms(forceUpdate?: boolean): void;
  16753. /**
  16754. * Gets the root pose matrix
  16755. * @returns a matrix
  16756. */
  16757. getPoseMatrix(): Nullable<Matrix>;
  16758. /**
  16759. * Sorts bones per internal index
  16760. */
  16761. sortBones(): void;
  16762. private _sortBones;
  16763. /**
  16764. * Set the current local matrix as the restPose for all bones in the skeleton.
  16765. */
  16766. setCurrentPoseAsRest(): void;
  16767. }
  16768. }
  16769. declare module "babylonjs/Meshes/instancedMesh" {
  16770. import { Nullable, FloatArray, IndicesArray } from "babylonjs/types";
  16771. import { Vector3, Matrix } from "babylonjs/Maths/math.vector";
  16772. import { Camera } from "babylonjs/Cameras/camera";
  16773. import { Node } from "babylonjs/node";
  16774. import { AbstractMesh } from "babylonjs/Meshes/abstractMesh";
  16775. import { Mesh } from "babylonjs/Meshes/mesh";
  16776. import { Material } from "babylonjs/Materials/material";
  16777. import { Skeleton } from "babylonjs/Bones/skeleton";
  16778. import { Light } from "babylonjs/Lights/light";
  16779. import { VertexBuffer } from "babylonjs/Meshes/buffer";
  16780. /**
  16781. * Creates an instance based on a source mesh.
  16782. */
  16783. export class InstancedMesh extends AbstractMesh {
  16784. private _sourceMesh;
  16785. private _currentLOD;
  16786. /** @hidden */
  16787. _indexInSourceMeshInstanceArray: number;
  16788. constructor(name: string, source: Mesh);
  16789. /**
  16790. * Returns the string "InstancedMesh".
  16791. */
  16792. getClassName(): string;
  16793. /** Gets the list of lights affecting that mesh */
  16794. get lightSources(): Light[];
  16795. _resyncLightSources(): void;
  16796. _resyncLightSource(light: Light): void;
  16797. _removeLightSource(light: Light, dispose: boolean): void;
  16798. /**
  16799. * If the source mesh receives shadows
  16800. */
  16801. get receiveShadows(): boolean;
  16802. /**
  16803. * The material of the source mesh
  16804. */
  16805. get material(): Nullable<Material>;
  16806. /**
  16807. * Visibility of the source mesh
  16808. */
  16809. get visibility(): number;
  16810. /**
  16811. * Skeleton of the source mesh
  16812. */
  16813. get skeleton(): Nullable<Skeleton>;
  16814. /**
  16815. * Rendering ground id of the source mesh
  16816. */
  16817. get renderingGroupId(): number;
  16818. set renderingGroupId(value: number);
  16819. /**
  16820. * Returns the total number of vertices (integer).
  16821. */
  16822. getTotalVertices(): number;
  16823. /**
  16824. * Returns a positive integer : the total number of indices in this mesh geometry.
  16825. * @returns the numner of indices or zero if the mesh has no geometry.
  16826. */
  16827. getTotalIndices(): number;
  16828. /**
  16829. * The source mesh of the instance
  16830. */
  16831. get sourceMesh(): Mesh;
  16832. /**
  16833. * Creates a new InstancedMesh object from the mesh model.
  16834. * @see https://doc.babylonjs.com/how_to/how_to_use_instances
  16835. * @param name defines the name of the new instance
  16836. * @returns a new InstancedMesh
  16837. */
  16838. createInstance(name: string): InstancedMesh;
  16839. /**
  16840. * Is this node ready to be used/rendered
  16841. * @param completeCheck defines if a complete check (including materials and lights) has to be done (false by default)
  16842. * @return {boolean} is it ready
  16843. */
  16844. isReady(completeCheck?: boolean): boolean;
  16845. /**
  16846. * Returns an array of integers or a typed array (Int32Array, Uint32Array, Uint16Array) populated with the mesh indices.
  16847. * @param kind kind of verticies to retreive (eg. positons, normals, uvs, etc.)
  16848. * @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.
  16849. * @returns a float array or a Float32Array of the requested kind of data : positons, normals, uvs, etc.
  16850. */
  16851. getVerticesData(kind: string, copyWhenShared?: boolean): Nullable<FloatArray>;
  16852. /**
  16853. * Sets the vertex data of the mesh geometry for the requested `kind`.
  16854. * If the mesh has no geometry, a new Geometry object is set to the mesh and then passed this vertex data.
  16855. * The `data` are either a numeric array either a Float32Array.
  16856. * The parameter `updatable` is passed as is to the underlying Geometry object constructor (if initianilly none) or updater.
  16857. * 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).
  16858. * Note that a new underlying VertexBuffer object is created each call.
  16859. * If the `kind` is the `PositionKind`, the mesh BoundingInfo is renewed, so the bounding box and sphere, and the mesh World Matrix is recomputed.
  16860. *
  16861. * Possible `kind` values :
  16862. * - VertexBuffer.PositionKind
  16863. * - VertexBuffer.UVKind
  16864. * - VertexBuffer.UV2Kind
  16865. * - VertexBuffer.UV3Kind
  16866. * - VertexBuffer.UV4Kind
  16867. * - VertexBuffer.UV5Kind
  16868. * - VertexBuffer.UV6Kind
  16869. * - VertexBuffer.ColorKind
  16870. * - VertexBuffer.MatricesIndicesKind
  16871. * - VertexBuffer.MatricesIndicesExtraKind
  16872. * - VertexBuffer.MatricesWeightsKind
  16873. * - VertexBuffer.MatricesWeightsExtraKind
  16874. *
  16875. * Returns the Mesh.
  16876. */
  16877. setVerticesData(kind: string, data: FloatArray, updatable?: boolean, stride?: number): AbstractMesh;
  16878. /**
  16879. * Updates the existing vertex data of the mesh geometry for the requested `kind`.
  16880. * If the mesh has no geometry, it is simply returned as it is.
  16881. * The `data` are either a numeric array either a Float32Array.
  16882. * No new underlying VertexBuffer object is created.
  16883. * 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.
  16884. * If the parameter `makeItUnique` is true, a new global geometry is created from this positions and is set to the mesh.
  16885. *
  16886. * Possible `kind` values :
  16887. * - VertexBuffer.PositionKind
  16888. * - VertexBuffer.UVKind
  16889. * - VertexBuffer.UV2Kind
  16890. * - VertexBuffer.UV3Kind
  16891. * - VertexBuffer.UV4Kind
  16892. * - VertexBuffer.UV5Kind
  16893. * - VertexBuffer.UV6Kind
  16894. * - VertexBuffer.ColorKind
  16895. * - VertexBuffer.MatricesIndicesKind
  16896. * - VertexBuffer.MatricesIndicesExtraKind
  16897. * - VertexBuffer.MatricesWeightsKind
  16898. * - VertexBuffer.MatricesWeightsExtraKind
  16899. *
  16900. * Returns the Mesh.
  16901. */
  16902. updateVerticesData(kind: string, data: FloatArray, updateExtends?: boolean, makeItUnique?: boolean): Mesh;
  16903. /**
  16904. * Sets the mesh indices.
  16905. * Expects an array populated with integers or a typed array (Int32Array, Uint32Array, Uint16Array).
  16906. * If the mesh has no geometry, a new Geometry object is created and set to the mesh.
  16907. * This method creates a new index buffer each call.
  16908. * Returns the Mesh.
  16909. */
  16910. setIndices(indices: IndicesArray, totalVertices?: Nullable<number>): Mesh;
  16911. /**
  16912. * Boolean : True if the mesh owns the requested kind of data.
  16913. */
  16914. isVerticesDataPresent(kind: string): boolean;
  16915. /**
  16916. * Returns an array of indices (IndicesArray).
  16917. */
  16918. getIndices(): Nullable<IndicesArray>;
  16919. get _positions(): Nullable<Vector3[]>;
  16920. /**
  16921. * This method recomputes and sets a new BoundingInfo to the mesh unless it is locked.
  16922. * This means the mesh underlying bounding box and sphere are recomputed.
  16923. * @param applySkeleton defines whether to apply the skeleton before computing the bounding info
  16924. * @returns the current mesh
  16925. */
  16926. refreshBoundingInfo(applySkeleton?: boolean): InstancedMesh;
  16927. /** @hidden */
  16928. _preActivate(): InstancedMesh;
  16929. /** @hidden */
  16930. _activate(renderId: number, intermediateRendering: boolean): boolean;
  16931. /** @hidden */
  16932. _postActivate(): void;
  16933. getWorldMatrix(): Matrix;
  16934. get isAnInstance(): boolean;
  16935. /**
  16936. * Returns the current associated LOD AbstractMesh.
  16937. */
  16938. getLOD(camera: Camera): AbstractMesh;
  16939. /** @hidden */
  16940. _preActivateForIntermediateRendering(renderId: number): Mesh;
  16941. /** @hidden */
  16942. _syncSubMeshes(): InstancedMesh;
  16943. /** @hidden */
  16944. _generatePointsArray(): boolean;
  16945. /** @hidden */
  16946. _updateBoundingInfo(): AbstractMesh;
  16947. /**
  16948. * Creates a new InstancedMesh from the current mesh.
  16949. * - name (string) : the cloned mesh name
  16950. * - newParent (optional Node) : the optional Node to parent the clone to.
  16951. * - doNotCloneChildren (optional boolean, default `false`) : if `true` the model children aren't cloned.
  16952. *
  16953. * Returns the clone.
  16954. */
  16955. clone(name: string, newParent?: Nullable<Node>, doNotCloneChildren?: boolean): InstancedMesh;
  16956. /**
  16957. * Disposes the InstancedMesh.
  16958. * Returns nothing.
  16959. */
  16960. dispose(doNotRecurse?: boolean, disposeMaterialAndTextures?: boolean): void;
  16961. }
  16962. module "babylonjs/Meshes/mesh" {
  16963. interface Mesh {
  16964. /**
  16965. * Register a custom buffer that will be instanced
  16966. * @see https://doc.babylonjs.com/how_to/how_to_use_instances#custom-buffers
  16967. * @param kind defines the buffer kind
  16968. * @param stride defines the stride in floats
  16969. */
  16970. registerInstancedBuffer(kind: string, stride: number): void;
  16971. /**
  16972. * true to use the edge renderer for all instances of this mesh
  16973. */
  16974. edgesShareWithInstances: boolean;
  16975. /** @hidden */
  16976. _userInstancedBuffersStorage: {
  16977. data: {
  16978. [key: string]: Float32Array;
  16979. };
  16980. sizes: {
  16981. [key: string]: number;
  16982. };
  16983. vertexBuffers: {
  16984. [key: string]: Nullable<VertexBuffer>;
  16985. };
  16986. strides: {
  16987. [key: string]: number;
  16988. };
  16989. };
  16990. }
  16991. }
  16992. module "babylonjs/Meshes/abstractMesh" {
  16993. interface AbstractMesh {
  16994. /**
  16995. * Object used to store instanced buffers defined by user
  16996. * @see https://doc.babylonjs.com/how_to/how_to_use_instances#custom-buffers
  16997. */
  16998. instancedBuffers: {
  16999. [key: string]: any;
  17000. };
  17001. }
  17002. }
  17003. }
  17004. declare module "babylonjs/Materials/shaderMaterial" {
  17005. import { Nullable } from "babylonjs/types";
  17006. import { Scene } from "babylonjs/scene";
  17007. import { Matrix, Vector3, Vector2, Vector4 } from "babylonjs/Maths/math.vector";
  17008. import { AbstractMesh } from "babylonjs/Meshes/abstractMesh";
  17009. import { Mesh } from "babylonjs/Meshes/mesh";
  17010. import { SubMesh } from "babylonjs/Meshes/subMesh";
  17011. import { BaseTexture } from "babylonjs/Materials/Textures/baseTexture";
  17012. import { Effect } from "babylonjs/Materials/effect";
  17013. import { Material } from "babylonjs/Materials/material";
  17014. import { Color3, Color4 } from "babylonjs/Maths/math.color";
  17015. /**
  17016. * Defines the options associated with the creation of a shader material.
  17017. */
  17018. export interface IShaderMaterialOptions {
  17019. /**
  17020. * Does the material work in alpha blend mode
  17021. */
  17022. needAlphaBlending: boolean;
  17023. /**
  17024. * Does the material work in alpha test mode
  17025. */
  17026. needAlphaTesting: boolean;
  17027. /**
  17028. * The list of attribute names used in the shader
  17029. */
  17030. attributes: string[];
  17031. /**
  17032. * The list of unifrom names used in the shader
  17033. */
  17034. uniforms: string[];
  17035. /**
  17036. * The list of UBO names used in the shader
  17037. */
  17038. uniformBuffers: string[];
  17039. /**
  17040. * The list of sampler names used in the shader
  17041. */
  17042. samplers: string[];
  17043. /**
  17044. * The list of defines used in the shader
  17045. */
  17046. defines: string[];
  17047. }
  17048. /**
  17049. * 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.
  17050. *
  17051. * This returned material effects how the mesh will look based on the code in the shaders.
  17052. *
  17053. * @see https://doc.babylonjs.com/how_to/shader_material
  17054. */
  17055. export class ShaderMaterial extends Material {
  17056. private _shaderPath;
  17057. private _options;
  17058. private _textures;
  17059. private _textureArrays;
  17060. private _floats;
  17061. private _ints;
  17062. private _floatsArrays;
  17063. private _colors3;
  17064. private _colors3Arrays;
  17065. private _colors4;
  17066. private _colors4Arrays;
  17067. private _vectors2;
  17068. private _vectors3;
  17069. private _vectors4;
  17070. private _matrices;
  17071. private _matrixArrays;
  17072. private _matrices3x3;
  17073. private _matrices2x2;
  17074. private _vectors2Arrays;
  17075. private _vectors3Arrays;
  17076. private _vectors4Arrays;
  17077. private _cachedWorldViewMatrix;
  17078. private _cachedWorldViewProjectionMatrix;
  17079. private _renderId;
  17080. private _multiview;
  17081. private _cachedDefines;
  17082. /** Define the Url to load snippets */
  17083. static SnippetUrl: string;
  17084. /** Snippet ID if the material was created from the snippet server */
  17085. snippetId: string;
  17086. /**
  17087. * Instantiate a new shader material.
  17088. * 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.
  17089. * This returned material effects how the mesh will look based on the code in the shaders.
  17090. * @see https://doc.babylonjs.com/how_to/shader_material
  17091. * @param name Define the name of the material in the scene
  17092. * @param scene Define the scene the material belongs to
  17093. * @param shaderPath Defines the route to the shader code in one of three ways:
  17094. * * object: { vertex: "custom", fragment: "custom" }, used with Effect.ShadersStore["customVertexShader"] and Effect.ShadersStore["customFragmentShader"]
  17095. * * object: { vertexElement: "vertexShaderCode", fragmentElement: "fragmentShaderCode" }, used with shader code in script tags
  17096. * * object: { vertexSource: "vertex shader code string", fragmentSource: "fragment shader code string" } using with strings containing the shaders code
  17097. * * string: "./COMMON_NAME", used with external files COMMON_NAME.vertex.fx and COMMON_NAME.fragment.fx in index.html folder.
  17098. * @param options Define the options used to create the shader
  17099. */
  17100. constructor(name: string, scene: Scene, shaderPath: any, options?: Partial<IShaderMaterialOptions>);
  17101. /**
  17102. * Gets the shader path used to define the shader code
  17103. * It can be modified to trigger a new compilation
  17104. */
  17105. get shaderPath(): any;
  17106. /**
  17107. * Sets the shader path used to define the shader code
  17108. * It can be modified to trigger a new compilation
  17109. */
  17110. set shaderPath(shaderPath: any);
  17111. /**
  17112. * Gets the options used to compile the shader.
  17113. * They can be modified to trigger a new compilation
  17114. */
  17115. get options(): IShaderMaterialOptions;
  17116. /**
  17117. * Gets the current class name of the material e.g. "ShaderMaterial"
  17118. * Mainly use in serialization.
  17119. * @returns the class name
  17120. */
  17121. getClassName(): string;
  17122. /**
  17123. * Specifies if the material will require alpha blending
  17124. * @returns a boolean specifying if alpha blending is needed
  17125. */
  17126. needAlphaBlending(): boolean;
  17127. /**
  17128. * Specifies if this material should be rendered in alpha test mode
  17129. * @returns a boolean specifying if an alpha test is needed.
  17130. */
  17131. needAlphaTesting(): boolean;
  17132. private _checkUniform;
  17133. /**
  17134. * Set a texture in the shader.
  17135. * @param name Define the name of the uniform samplers as defined in the shader
  17136. * @param texture Define the texture to bind to this sampler
  17137. * @return the material itself allowing "fluent" like uniform updates
  17138. */
  17139. setTexture(name: string, texture: BaseTexture): ShaderMaterial;
  17140. /**
  17141. * Set a texture array in the shader.
  17142. * @param name Define the name of the uniform sampler array as defined in the shader
  17143. * @param textures Define the list of textures to bind to this sampler
  17144. * @return the material itself allowing "fluent" like uniform updates
  17145. */
  17146. setTextureArray(name: string, textures: BaseTexture[]): ShaderMaterial;
  17147. /**
  17148. * Set a float in the shader.
  17149. * @param name Define the name of the uniform as defined in the shader
  17150. * @param value Define the value to give to the uniform
  17151. * @return the material itself allowing "fluent" like uniform updates
  17152. */
  17153. setFloat(name: string, value: number): ShaderMaterial;
  17154. /**
  17155. * Set a int in the shader.
  17156. * @param name Define the name of the uniform as defined in the shader
  17157. * @param value Define the value to give to the uniform
  17158. * @return the material itself allowing "fluent" like uniform updates
  17159. */
  17160. setInt(name: string, value: number): ShaderMaterial;
  17161. /**
  17162. * Set an array of floats in the shader.
  17163. * @param name Define the name of the uniform as defined in the shader
  17164. * @param value Define the value to give to the uniform
  17165. * @return the material itself allowing "fluent" like uniform updates
  17166. */
  17167. setFloats(name: string, value: number[]): ShaderMaterial;
  17168. /**
  17169. * Set a vec3 in the shader from a Color3.
  17170. * @param name Define the name of the uniform as defined in the shader
  17171. * @param value Define the value to give to the uniform
  17172. * @return the material itself allowing "fluent" like uniform updates
  17173. */
  17174. setColor3(name: string, value: Color3): ShaderMaterial;
  17175. /**
  17176. * Set a vec3 array in the shader from a Color3 array.
  17177. * @param name Define the name of the uniform as defined in the shader
  17178. * @param value Define the value to give to the uniform
  17179. * @return the material itself allowing "fluent" like uniform updates
  17180. */
  17181. setColor3Array(name: string, value: Color3[]): ShaderMaterial;
  17182. /**
  17183. * Set a vec4 in the shader from a Color4.
  17184. * @param name Define the name of the uniform as defined in the shader
  17185. * @param value Define the value to give to the uniform
  17186. * @return the material itself allowing "fluent" like uniform updates
  17187. */
  17188. setColor4(name: string, value: Color4): ShaderMaterial;
  17189. /**
  17190. * Set a vec4 array in the shader from a Color4 array.
  17191. * @param name Define the name of the uniform as defined in the shader
  17192. * @param value Define the value to give to the uniform
  17193. * @return the material itself allowing "fluent" like uniform updates
  17194. */
  17195. setColor4Array(name: string, value: Color4[]): ShaderMaterial;
  17196. /**
  17197. * Set a vec2 in the shader from a Vector2.
  17198. * @param name Define the name of the uniform as defined in the shader
  17199. * @param value Define the value to give to the uniform
  17200. * @return the material itself allowing "fluent" like uniform updates
  17201. */
  17202. setVector2(name: string, value: Vector2): ShaderMaterial;
  17203. /**
  17204. * Set a vec3 in the shader from a Vector3.
  17205. * @param name Define the name of the uniform as defined in the shader
  17206. * @param value Define the value to give to the uniform
  17207. * @return the material itself allowing "fluent" like uniform updates
  17208. */
  17209. setVector3(name: string, value: Vector3): ShaderMaterial;
  17210. /**
  17211. * Set a vec4 in the shader from a Vector4.
  17212. * @param name Define the name of the uniform as defined in the shader
  17213. * @param value Define the value to give to the uniform
  17214. * @return the material itself allowing "fluent" like uniform updates
  17215. */
  17216. setVector4(name: string, value: Vector4): ShaderMaterial;
  17217. /**
  17218. * Set a mat4 in the shader from a Matrix.
  17219. * @param name Define the name of the uniform as defined in the shader
  17220. * @param value Define the value to give to the uniform
  17221. * @return the material itself allowing "fluent" like uniform updates
  17222. */
  17223. setMatrix(name: string, value: Matrix): ShaderMaterial;
  17224. /**
  17225. * Set a float32Array in the shader from a matrix array.
  17226. * @param name Define the name of the uniform as defined in the shader
  17227. * @param value Define the value to give to the uniform
  17228. * @return the material itself allowing "fluent" like uniform updates
  17229. */
  17230. setMatrices(name: string, value: Matrix[]): ShaderMaterial;
  17231. /**
  17232. * Set a mat3 in the shader from a Float32Array.
  17233. * @param name Define the name of the uniform as defined in the shader
  17234. * @param value Define the value to give to the uniform
  17235. * @return the material itself allowing "fluent" like uniform updates
  17236. */
  17237. setMatrix3x3(name: string, value: Float32Array | Array<number>): ShaderMaterial;
  17238. /**
  17239. * Set a mat2 in the shader from a Float32Array.
  17240. * @param name Define the name of the uniform as defined in the shader
  17241. * @param value Define the value to give to the uniform
  17242. * @return the material itself allowing "fluent" like uniform updates
  17243. */
  17244. setMatrix2x2(name: string, value: Float32Array | Array<number>): ShaderMaterial;
  17245. /**
  17246. * Set a vec2 array in the shader from a number array.
  17247. * @param name Define the name of the uniform as defined in the shader
  17248. * @param value Define the value to give to the uniform
  17249. * @return the material itself allowing "fluent" like uniform updates
  17250. */
  17251. setArray2(name: string, value: number[]): ShaderMaterial;
  17252. /**
  17253. * Set a vec3 array in the shader from a number array.
  17254. * @param name Define the name of the uniform as defined in the shader
  17255. * @param value Define the value to give to the uniform
  17256. * @return the material itself allowing "fluent" like uniform updates
  17257. */
  17258. setArray3(name: string, value: number[]): ShaderMaterial;
  17259. /**
  17260. * Set a vec4 array in the shader from a number array.
  17261. * @param name Define the name of the uniform as defined in the shader
  17262. * @param value Define the value to give to the uniform
  17263. * @return the material itself allowing "fluent" like uniform updates
  17264. */
  17265. setArray4(name: string, value: number[]): ShaderMaterial;
  17266. private _checkCache;
  17267. /**
  17268. * Specifies that the submesh is ready to be used
  17269. * @param mesh defines the mesh to check
  17270. * @param subMesh defines which submesh to check
  17271. * @param useInstances specifies that instances should be used
  17272. * @returns a boolean indicating that the submesh is ready or not
  17273. */
  17274. isReadyForSubMesh(mesh: AbstractMesh, subMesh: SubMesh, useInstances?: boolean): boolean;
  17275. /**
  17276. * Checks if the material is ready to render the requested mesh
  17277. * @param mesh Define the mesh to render
  17278. * @param useInstances Define whether or not the material is used with instances
  17279. * @returns true if ready, otherwise false
  17280. */
  17281. isReady(mesh?: AbstractMesh, useInstances?: boolean): boolean;
  17282. /**
  17283. * Binds the world matrix to the material
  17284. * @param world defines the world transformation matrix
  17285. * @param effectOverride - If provided, use this effect instead of internal effect
  17286. */
  17287. bindOnlyWorldMatrix(world: Matrix, effectOverride?: Nullable<Effect>): void;
  17288. /**
  17289. * Binds the submesh to this material by preparing the effect and shader to draw
  17290. * @param world defines the world transformation matrix
  17291. * @param mesh defines the mesh containing the submesh
  17292. * @param subMesh defines the submesh to bind the material to
  17293. */
  17294. bindForSubMesh(world: Matrix, mesh: Mesh, subMesh: SubMesh): void;
  17295. /**
  17296. * Binds the material to the mesh
  17297. * @param world defines the world transformation matrix
  17298. * @param mesh defines the mesh to bind the material to
  17299. * @param effectOverride - If provided, use this effect instead of internal effect
  17300. */
  17301. bind(world: Matrix, mesh?: Mesh, effectOverride?: Nullable<Effect>): void;
  17302. protected _afterBind(mesh?: Mesh): void;
  17303. /**
  17304. * Gets the active textures from the material
  17305. * @returns an array of textures
  17306. */
  17307. getActiveTextures(): BaseTexture[];
  17308. /**
  17309. * Specifies if the material uses a texture
  17310. * @param texture defines the texture to check against the material
  17311. * @returns a boolean specifying if the material uses the texture
  17312. */
  17313. hasTexture(texture: BaseTexture): boolean;
  17314. /**
  17315. * Makes a duplicate of the material, and gives it a new name
  17316. * @param name defines the new name for the duplicated material
  17317. * @returns the cloned material
  17318. */
  17319. clone(name: string): ShaderMaterial;
  17320. /**
  17321. * Disposes the material
  17322. * @param forceDisposeEffect specifies if effects should be forcefully disposed
  17323. * @param forceDisposeTextures specifies if textures should be forcefully disposed
  17324. * @param notBoundToMesh specifies if the material that is being disposed is known to be not bound to any mesh
  17325. */
  17326. dispose(forceDisposeEffect?: boolean, forceDisposeTextures?: boolean, notBoundToMesh?: boolean): void;
  17327. /**
  17328. * Serializes this material in a JSON representation
  17329. * @returns the serialized material object
  17330. */
  17331. serialize(): any;
  17332. /**
  17333. * Creates a shader material from parsed shader material data
  17334. * @param source defines the JSON represnetation of the material
  17335. * @param scene defines the hosting scene
  17336. * @param rootUrl defines the root URL to use to load textures and relative dependencies
  17337. * @returns a new material
  17338. */
  17339. static Parse(source: any, scene: Scene, rootUrl: string): ShaderMaterial;
  17340. /**
  17341. * Creates a new ShaderMaterial from a snippet saved in a remote file
  17342. * @param name defines the name of the ShaderMaterial to create (can be null or empty to use the one from the json data)
  17343. * @param url defines the url to load from
  17344. * @param scene defines the hosting scene
  17345. * @param rootUrl defines the root URL to use to load textures and relative dependencies
  17346. * @returns a promise that will resolve to the new ShaderMaterial
  17347. */
  17348. static ParseFromFileAsync(name: Nullable<string>, url: string, scene: Scene, rootUrl?: string): Promise<ShaderMaterial>;
  17349. /**
  17350. * Creates a ShaderMaterial from a snippet saved by the Inspector
  17351. * @param snippetId defines the snippet to load
  17352. * @param scene defines the hosting scene
  17353. * @param rootUrl defines the root URL to use to load textures and relative dependencies
  17354. * @returns a promise that will resolve to the new ShaderMaterial
  17355. */
  17356. static CreateFromSnippetAsync(snippetId: string, scene: Scene, rootUrl?: string): Promise<ShaderMaterial>;
  17357. }
  17358. }
  17359. declare module "babylonjs/Shaders/color.fragment" {
  17360. import "babylonjs/Shaders/ShadersInclude/clipPlaneFragmentDeclaration";
  17361. import "babylonjs/Shaders/ShadersInclude/clipPlaneFragment";
  17362. /** @hidden */
  17363. export var colorPixelShader: {
  17364. name: string;
  17365. shader: string;
  17366. };
  17367. }
  17368. declare module "babylonjs/Shaders/color.vertex" {
  17369. import "babylonjs/Shaders/ShadersInclude/bonesDeclaration";
  17370. import "babylonjs/Shaders/ShadersInclude/clipPlaneVertexDeclaration";
  17371. import "babylonjs/Shaders/ShadersInclude/instancesDeclaration";
  17372. import "babylonjs/Shaders/ShadersInclude/instancesVertex";
  17373. import "babylonjs/Shaders/ShadersInclude/bonesVertex";
  17374. import "babylonjs/Shaders/ShadersInclude/clipPlaneVertex";
  17375. /** @hidden */
  17376. export var colorVertexShader: {
  17377. name: string;
  17378. shader: string;
  17379. };
  17380. }
  17381. declare module "babylonjs/Meshes/linesMesh" {
  17382. import { Nullable } from "babylonjs/types";
  17383. import { Scene } from "babylonjs/scene";
  17384. import { Color3 } from "babylonjs/Maths/math.color";
  17385. import { Node } from "babylonjs/node";
  17386. import { SubMesh } from "babylonjs/Meshes/subMesh";
  17387. import { Mesh } from "babylonjs/Meshes/mesh";
  17388. import { InstancedMesh } from "babylonjs/Meshes/instancedMesh";
  17389. import { Effect } from "babylonjs/Materials/effect";
  17390. import { Material } from "babylonjs/Materials/material";
  17391. import "babylonjs/Shaders/color.fragment";
  17392. import "babylonjs/Shaders/color.vertex";
  17393. /**
  17394. * Line mesh
  17395. * @see https://doc.babylonjs.com/babylon101/parametric_shapes
  17396. */
  17397. export class LinesMesh extends Mesh {
  17398. /**
  17399. * If vertex color should be applied to the mesh
  17400. */
  17401. readonly useVertexColor?: boolean | undefined;
  17402. /**
  17403. * If vertex alpha should be applied to the mesh
  17404. */
  17405. readonly useVertexAlpha?: boolean | undefined;
  17406. /**
  17407. * Color of the line (Default: White)
  17408. */
  17409. color: Color3;
  17410. /**
  17411. * Alpha of the line (Default: 1)
  17412. */
  17413. alpha: number;
  17414. /**
  17415. * The intersection Threshold is the margin applied when intersection a segment of the LinesMesh with a Ray.
  17416. * This margin is expressed in world space coordinates, so its value may vary.
  17417. * Default value is 0.1
  17418. */
  17419. intersectionThreshold: number;
  17420. private _colorShader;
  17421. private color4;
  17422. /**
  17423. * Creates a new LinesMesh
  17424. * @param name defines the name
  17425. * @param scene defines the hosting scene
  17426. * @param parent defines the parent mesh if any
  17427. * @param source defines the optional source LinesMesh used to clone data from
  17428. * @param doNotCloneChildren When cloning, skip cloning child meshes of source, default False.
  17429. * When false, achieved by calling a clone(), also passing False.
  17430. * This will make creation of children, recursive.
  17431. * @param useVertexColor defines if this LinesMesh supports vertex color
  17432. * @param useVertexAlpha defines if this LinesMesh supports vertex alpha
  17433. */
  17434. constructor(name: string, scene?: Nullable<Scene>, parent?: Nullable<Node>, source?: Nullable<LinesMesh>, doNotCloneChildren?: boolean,
  17435. /**
  17436. * If vertex color should be applied to the mesh
  17437. */
  17438. useVertexColor?: boolean | undefined,
  17439. /**
  17440. * If vertex alpha should be applied to the mesh
  17441. */
  17442. useVertexAlpha?: boolean | undefined);
  17443. private _addClipPlaneDefine;
  17444. private _removeClipPlaneDefine;
  17445. isReady(): boolean;
  17446. /**
  17447. * Returns the string "LineMesh"
  17448. */
  17449. getClassName(): string;
  17450. /**
  17451. * @hidden
  17452. */
  17453. get material(): Material;
  17454. /**
  17455. * @hidden
  17456. */
  17457. set material(value: Material);
  17458. /**
  17459. * @hidden
  17460. */
  17461. get checkCollisions(): boolean;
  17462. /** @hidden */
  17463. _bind(subMesh: SubMesh, effect: Effect, fillMode: number): Mesh;
  17464. /** @hidden */
  17465. _draw(subMesh: SubMesh, fillMode: number, instancesCount?: number): Mesh;
  17466. /**
  17467. * Disposes of the line mesh
  17468. * @param doNotRecurse If children should be disposed
  17469. */
  17470. dispose(doNotRecurse?: boolean): void;
  17471. /**
  17472. * Returns a new LineMesh object cloned from the current one.
  17473. */
  17474. clone(name: string, newParent?: Nullable<Node>, doNotCloneChildren?: boolean): LinesMesh;
  17475. /**
  17476. * Creates a new InstancedLinesMesh object from the mesh model.
  17477. * @see https://doc.babylonjs.com/how_to/how_to_use_instances
  17478. * @param name defines the name of the new instance
  17479. * @returns a new InstancedLinesMesh
  17480. */
  17481. createInstance(name: string): InstancedLinesMesh;
  17482. }
  17483. /**
  17484. * Creates an instance based on a source LinesMesh
  17485. */
  17486. export class InstancedLinesMesh extends InstancedMesh {
  17487. /**
  17488. * The intersection Threshold is the margin applied when intersection a segment of the LinesMesh with a Ray.
  17489. * This margin is expressed in world space coordinates, so its value may vary.
  17490. * Initilized with the intersectionThreshold value of the source LinesMesh
  17491. */
  17492. intersectionThreshold: number;
  17493. constructor(name: string, source: LinesMesh);
  17494. /**
  17495. * Returns the string "InstancedLinesMesh".
  17496. */
  17497. getClassName(): string;
  17498. }
  17499. }
  17500. declare module "babylonjs/Shaders/line.fragment" {
  17501. /** @hidden */
  17502. export var linePixelShader: {
  17503. name: string;
  17504. shader: string;
  17505. };
  17506. }
  17507. declare module "babylonjs/Shaders/line.vertex" {
  17508. import "babylonjs/Shaders/ShadersInclude/instancesDeclaration";
  17509. import "babylonjs/Shaders/ShadersInclude/instancesVertex";
  17510. /** @hidden */
  17511. export var lineVertexShader: {
  17512. name: string;
  17513. shader: string;
  17514. };
  17515. }
  17516. declare module "babylonjs/Rendering/edgesRenderer" {
  17517. import { Nullable } from "babylonjs/types";
  17518. import { VertexBuffer } from "babylonjs/Meshes/buffer";
  17519. import { AbstractMesh } from "babylonjs/Meshes/abstractMesh";
  17520. import { Vector3, Matrix } from "babylonjs/Maths/math.vector";
  17521. import { IDisposable } from "babylonjs/scene";
  17522. import { ShaderMaterial } from "babylonjs/Materials/shaderMaterial";
  17523. import "babylonjs/Shaders/line.fragment";
  17524. import "babylonjs/Shaders/line.vertex";
  17525. import { DataBuffer } from "babylonjs/Meshes/dataBuffer";
  17526. import { SmartArray } from "babylonjs/Misc/smartArray";
  17527. module "babylonjs/scene" {
  17528. interface Scene {
  17529. /** @hidden */
  17530. _edgeRenderLineShader: Nullable<ShaderMaterial>;
  17531. }
  17532. }
  17533. module "babylonjs/Meshes/abstractMesh" {
  17534. interface AbstractMesh {
  17535. /**
  17536. * Gets the edgesRenderer associated with the mesh
  17537. */
  17538. edgesRenderer: Nullable<EdgesRenderer>;
  17539. }
  17540. }
  17541. module "babylonjs/Meshes/linesMesh" {
  17542. interface LinesMesh {
  17543. /**
  17544. * Enables the edge rendering mode on the mesh.
  17545. * This mode makes the mesh edges visible
  17546. * @param epsilon defines the maximal distance between two angles to detect a face
  17547. * @param checkVerticesInsteadOfIndices indicates that we should check vertex list directly instead of faces
  17548. * @returns the currentAbstractMesh
  17549. * @see https://www.babylonjs-playground.com/#19O9TU#0
  17550. */
  17551. enableEdgesRendering(epsilon?: number, checkVerticesInsteadOfIndices?: boolean): AbstractMesh;
  17552. }
  17553. }
  17554. module "babylonjs/Meshes/linesMesh" {
  17555. interface InstancedLinesMesh {
  17556. /**
  17557. * Enables the edge rendering mode on the mesh.
  17558. * This mode makes the mesh edges visible
  17559. * @param epsilon defines the maximal distance between two angles to detect a face
  17560. * @param checkVerticesInsteadOfIndices indicates that we should check vertex list directly instead of faces
  17561. * @returns the current InstancedLinesMesh
  17562. * @see https://www.babylonjs-playground.com/#19O9TU#0
  17563. */
  17564. enableEdgesRendering(epsilon?: number, checkVerticesInsteadOfIndices?: boolean): InstancedLinesMesh;
  17565. }
  17566. }
  17567. /**
  17568. * Defines the minimum contract an Edges renderer should follow.
  17569. */
  17570. export interface IEdgesRenderer extends IDisposable {
  17571. /**
  17572. * Gets or sets a boolean indicating if the edgesRenderer is active
  17573. */
  17574. isEnabled: boolean;
  17575. /**
  17576. * Renders the edges of the attached mesh,
  17577. */
  17578. render(): void;
  17579. /**
  17580. * Checks wether or not the edges renderer is ready to render.
  17581. * @return true if ready, otherwise false.
  17582. */
  17583. isReady(): boolean;
  17584. /**
  17585. * List of instances to render in case the source mesh has instances
  17586. */
  17587. customInstances: SmartArray<Matrix>;
  17588. }
  17589. /**
  17590. * Defines the additional options of the edges renderer
  17591. */
  17592. export interface IEdgesRendererOptions {
  17593. /**
  17594. * Gets or sets a boolean indicating that the alternate edge finder algorithm must be used
  17595. * If not defined, the default value is true
  17596. */
  17597. useAlternateEdgeFinder?: boolean;
  17598. /**
  17599. * Gets or sets a boolean indicating that the vertex merger fast processing must be used.
  17600. * If not defined, the default value is true.
  17601. * 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)
  17602. * This option is used only if useAlternateEdgeFinder = true
  17603. */
  17604. useFastVertexMerger?: boolean;
  17605. /**
  17606. * During edges processing, the vertices are merged if they are close enough: epsilonVertexMerge is the limit whithin which vertices are considered to be equal.
  17607. * The default value is 1e-6
  17608. * This option is used only if useAlternateEdgeFinder = true
  17609. */
  17610. epsilonVertexMerge?: number;
  17611. /**
  17612. * 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
  17613. * 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.
  17614. * This option is used only if useAlternateEdgeFinder = true
  17615. */
  17616. applyTessellation?: boolean;
  17617. /**
  17618. * 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
  17619. * The default value is 1e-6
  17620. * This option is used only if useAlternateEdgeFinder = true
  17621. */
  17622. epsilonVertexAligned?: number;
  17623. }
  17624. /**
  17625. * This class is used to generate edges of the mesh that could then easily be rendered in a scene.
  17626. */
  17627. export class EdgesRenderer implements IEdgesRenderer {
  17628. /**
  17629. * Define the size of the edges with an orthographic camera
  17630. */
  17631. edgesWidthScalerForOrthographic: number;
  17632. /**
  17633. * Define the size of the edges with a perspective camera
  17634. */
  17635. edgesWidthScalerForPerspective: number;
  17636. protected _source: AbstractMesh;
  17637. protected _linesPositions: number[];
  17638. protected _linesNormals: number[];
  17639. protected _linesIndices: number[];
  17640. protected _epsilon: number;
  17641. protected _indicesCount: number;
  17642. protected _lineShader: ShaderMaterial;
  17643. protected _ib: DataBuffer;
  17644. protected _buffers: {
  17645. [key: string]: Nullable<VertexBuffer>;
  17646. };
  17647. protected _buffersForInstances: {
  17648. [key: string]: Nullable<VertexBuffer>;
  17649. };
  17650. protected _checkVerticesInsteadOfIndices: boolean;
  17651. protected _options: Nullable<IEdgesRendererOptions>;
  17652. private _meshRebuildObserver;
  17653. private _meshDisposeObserver;
  17654. /** Gets or sets a boolean indicating if the edgesRenderer is active */
  17655. isEnabled: boolean;
  17656. /**
  17657. * List of instances to render in case the source mesh has instances
  17658. */
  17659. customInstances: SmartArray<Matrix>;
  17660. private static GetShader;
  17661. /**
  17662. * Creates an instance of the EdgesRenderer. It is primarily use to display edges of a mesh.
  17663. * Beware when you use this class with complex objects as the adjacencies computation can be really long
  17664. * @param source Mesh used to create edges
  17665. * @param epsilon sum of angles in adjacency to check for edge
  17666. * @param checkVerticesInsteadOfIndices bases the edges detection on vertices vs indices. Note that this parameter is not used if options.useAlternateEdgeFinder = true
  17667. * @param generateEdgesLines - should generate Lines or only prepare resources.
  17668. * @param options The options to apply when generating the edges
  17669. */
  17670. constructor(source: AbstractMesh, epsilon?: number, checkVerticesInsteadOfIndices?: boolean, generateEdgesLines?: boolean, options?: IEdgesRendererOptions);
  17671. protected _prepareRessources(): void;
  17672. /** @hidden */
  17673. _rebuild(): void;
  17674. /**
  17675. * Releases the required resources for the edges renderer
  17676. */
  17677. dispose(): void;
  17678. protected _processEdgeForAdjacencies(pa: number, pb: number, p0: number, p1: number, p2: number): number;
  17679. protected _processEdgeForAdjacenciesWithVertices(pa: Vector3, pb: Vector3, p0: Vector3, p1: Vector3, p2: Vector3): number;
  17680. /**
  17681. * Checks if the pair of p0 and p1 is en edge
  17682. * @param faceIndex
  17683. * @param edge
  17684. * @param faceNormals
  17685. * @param p0
  17686. * @param p1
  17687. * @private
  17688. */
  17689. protected _checkEdge(faceIndex: number, edge: number, faceNormals: Array<Vector3>, p0: Vector3, p1: Vector3): void;
  17690. /**
  17691. * push line into the position, normal and index buffer
  17692. * @protected
  17693. */
  17694. protected createLine(p0: Vector3, p1: Vector3, offset: number): void;
  17695. /**
  17696. * See https://playground.babylonjs.com/#R3JR6V#1 for a visual display of the algorithm
  17697. */
  17698. private _tessellateTriangle;
  17699. private _generateEdgesLinesAlternate;
  17700. /**
  17701. * Generates lines edges from adjacencjes
  17702. * @private
  17703. */
  17704. _generateEdgesLines(): void;
  17705. /**
  17706. * Checks wether or not the edges renderer is ready to render.
  17707. * @return true if ready, otherwise false.
  17708. */
  17709. isReady(): boolean;
  17710. /**
  17711. * Renders the edges of the attached mesh,
  17712. */
  17713. render(): void;
  17714. }
  17715. /**
  17716. * LineEdgesRenderer for LineMeshes to remove unnecessary triangulation
  17717. */
  17718. export class LineEdgesRenderer extends EdgesRenderer {
  17719. /**
  17720. * This constructor turns off auto generating edges line in Edges Renderer to make it here.
  17721. * @param source LineMesh used to generate edges
  17722. * @param epsilon not important (specified angle for edge detection)
  17723. * @param checkVerticesInsteadOfIndices not important for LineMesh
  17724. */
  17725. constructor(source: AbstractMesh, epsilon?: number, checkVerticesInsteadOfIndices?: boolean);
  17726. /**
  17727. * Generate edges for each line in LinesMesh. Every Line should be rendered as edge.
  17728. */
  17729. _generateEdgesLines(): void;
  17730. }
  17731. }
  17732. declare module "babylonjs/Rendering/renderingGroup" {
  17733. import { SmartArray, SmartArrayNoDuplicate } from "babylonjs/Misc/smartArray";
  17734. import { SubMesh } from "babylonjs/Meshes/subMesh";
  17735. import { AbstractMesh } from "babylonjs/Meshes/abstractMesh";
  17736. import { Nullable } from "babylonjs/types";
  17737. import { IParticleSystem } from "babylonjs/Particles/IParticleSystem";
  17738. import { IEdgesRenderer } from "babylonjs/Rendering/edgesRenderer";
  17739. import { ISpriteManager } from "babylonjs/Sprites/spriteManager";
  17740. import { Material } from "babylonjs/Materials/material";
  17741. import { Scene } from "babylonjs/scene";
  17742. /**
  17743. * This represents the object necessary to create a rendering group.
  17744. * This is exclusively used and created by the rendering manager.
  17745. * To modify the behavior, you use the available helpers in your scene or meshes.
  17746. * @hidden
  17747. */
  17748. export class RenderingGroup {
  17749. index: number;
  17750. private static _zeroVector;
  17751. private _scene;
  17752. private _opaqueSubMeshes;
  17753. private _transparentSubMeshes;
  17754. private _alphaTestSubMeshes;
  17755. private _depthOnlySubMeshes;
  17756. private _particleSystems;
  17757. private _spriteManagers;
  17758. private _opaqueSortCompareFn;
  17759. private _alphaTestSortCompareFn;
  17760. private _transparentSortCompareFn;
  17761. private _renderOpaque;
  17762. private _renderAlphaTest;
  17763. private _renderTransparent;
  17764. /** @hidden */
  17765. _edgesRenderers: SmartArrayNoDuplicate<IEdgesRenderer>;
  17766. onBeforeTransparentRendering: () => void;
  17767. /**
  17768. * Set the opaque sort comparison function.
  17769. * If null the sub meshes will be render in the order they were created
  17770. */
  17771. set opaqueSortCompareFn(value: Nullable<(a: SubMesh, b: SubMesh) => number>);
  17772. /**
  17773. * Set the alpha test sort comparison function.
  17774. * If null the sub meshes will be render in the order they were created
  17775. */
  17776. set alphaTestSortCompareFn(value: Nullable<(a: SubMesh, b: SubMesh) => number>);
  17777. /**
  17778. * Set the transparent sort comparison function.
  17779. * If null the sub meshes will be render in the order they were created
  17780. */
  17781. set transparentSortCompareFn(value: Nullable<(a: SubMesh, b: SubMesh) => number>);
  17782. /**
  17783. * Creates a new rendering group.
  17784. * @param index The rendering group index
  17785. * @param opaqueSortCompareFn The opaque sort comparison function. If null no order is applied
  17786. * @param alphaTestSortCompareFn The alpha test sort comparison function. If null no order is applied
  17787. * @param transparentSortCompareFn The transparent sort comparison function. If null back to front + alpha index sort is applied
  17788. */
  17789. 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>);
  17790. /**
  17791. * Render all the sub meshes contained in the group.
  17792. * @param customRenderFunction Used to override the default render behaviour of the group.
  17793. * @returns true if rendered some submeshes.
  17794. */
  17795. render(customRenderFunction: Nullable<(opaqueSubMeshes: SmartArray<SubMesh>, transparentSubMeshes: SmartArray<SubMesh>, alphaTestSubMeshes: SmartArray<SubMesh>, depthOnlySubMeshes: SmartArray<SubMesh>) => void>, renderSprites: boolean, renderParticles: boolean, activeMeshes: Nullable<AbstractMesh[]>): void;
  17796. /**
  17797. * Renders the opaque submeshes in the order from the opaqueSortCompareFn.
  17798. * @param subMeshes The submeshes to render
  17799. */
  17800. private renderOpaqueSorted;
  17801. /**
  17802. * Renders the opaque submeshes in the order from the alphatestSortCompareFn.
  17803. * @param subMeshes The submeshes to render
  17804. */
  17805. private renderAlphaTestSorted;
  17806. /**
  17807. * Renders the opaque submeshes in the order from the transparentSortCompareFn.
  17808. * @param subMeshes The submeshes to render
  17809. */
  17810. private renderTransparentSorted;
  17811. /**
  17812. * Renders the submeshes in a specified order.
  17813. * @param subMeshes The submeshes to sort before render
  17814. * @param sortCompareFn The comparison function use to sort
  17815. * @param cameraPosition The camera position use to preprocess the submeshes to help sorting
  17816. * @param transparent Specifies to activate blending if true
  17817. */
  17818. private static renderSorted;
  17819. /**
  17820. * Renders the submeshes in the order they were dispatched (no sort applied).
  17821. * @param subMeshes The submeshes to render
  17822. */
  17823. private static renderUnsorted;
  17824. /**
  17825. * Build in function which can be applied to ensure meshes of a special queue (opaque, alpha test, transparent)
  17826. * are rendered back to front if in the same alpha index.
  17827. *
  17828. * @param a The first submesh
  17829. * @param b The second submesh
  17830. * @returns The result of the comparison
  17831. */
  17832. static defaultTransparentSortCompare(a: SubMesh, b: SubMesh): number;
  17833. /**
  17834. * Build in function which can be applied to ensure meshes of a special queue (opaque, alpha test, transparent)
  17835. * are rendered back to front.
  17836. *
  17837. * @param a The first submesh
  17838. * @param b The second submesh
  17839. * @returns The result of the comparison
  17840. */
  17841. static backToFrontSortCompare(a: SubMesh, b: SubMesh): number;
  17842. /**
  17843. * Build in function which can be applied to ensure meshes of a special queue (opaque, alpha test, transparent)
  17844. * are rendered front to back (prevent overdraw).
  17845. *
  17846. * @param a The first submesh
  17847. * @param b The second submesh
  17848. * @returns The result of the comparison
  17849. */
  17850. static frontToBackSortCompare(a: SubMesh, b: SubMesh): number;
  17851. /**
  17852. * Resets the different lists of submeshes to prepare a new frame.
  17853. */
  17854. prepare(): void;
  17855. dispose(): void;
  17856. /**
  17857. * Inserts the submesh in its correct queue depending on its material.
  17858. * @param subMesh The submesh to dispatch
  17859. * @param [mesh] Optional reference to the submeshes's mesh. Provide if you have an exiting reference to improve performance.
  17860. * @param [material] Optional reference to the submeshes's material. Provide if you have an exiting reference to improve performance.
  17861. */
  17862. dispatch(subMesh: SubMesh, mesh?: AbstractMesh, material?: Nullable<Material>): void;
  17863. dispatchSprites(spriteManager: ISpriteManager): void;
  17864. dispatchParticles(particleSystem: IParticleSystem): void;
  17865. private _renderParticles;
  17866. private _renderSprites;
  17867. }
  17868. }
  17869. declare module "babylonjs/Rendering/renderingManager" {
  17870. import { Nullable } from "babylonjs/types";
  17871. import { AbstractMesh } from "babylonjs/Meshes/abstractMesh";
  17872. import { SubMesh } from "babylonjs/Meshes/subMesh";
  17873. import { SmartArray } from "babylonjs/Misc/smartArray";
  17874. import { ISpriteManager } from "babylonjs/Sprites/spriteManager";
  17875. import { IParticleSystem } from "babylonjs/Particles/IParticleSystem";
  17876. import { Material } from "babylonjs/Materials/material";
  17877. import { Scene } from "babylonjs/scene";
  17878. import { Camera } from "babylonjs/Cameras/camera";
  17879. /**
  17880. * Interface describing the different options available in the rendering manager
  17881. * regarding Auto Clear between groups.
  17882. */
  17883. export interface IRenderingManagerAutoClearSetup {
  17884. /**
  17885. * Defines whether or not autoclear is enable.
  17886. */
  17887. autoClear: boolean;
  17888. /**
  17889. * Defines whether or not to autoclear the depth buffer.
  17890. */
  17891. depth: boolean;
  17892. /**
  17893. * Defines whether or not to autoclear the stencil buffer.
  17894. */
  17895. stencil: boolean;
  17896. }
  17897. /**
  17898. * This class is used by the onRenderingGroupObservable
  17899. */
  17900. export class RenderingGroupInfo {
  17901. /**
  17902. * The Scene that being rendered
  17903. */
  17904. scene: Scene;
  17905. /**
  17906. * The camera currently used for the rendering pass
  17907. */
  17908. camera: Nullable<Camera>;
  17909. /**
  17910. * The ID of the renderingGroup being processed
  17911. */
  17912. renderingGroupId: number;
  17913. }
  17914. /**
  17915. * This is the manager responsible of all the rendering for meshes sprites and particles.
  17916. * It is enable to manage the different groups as well as the different necessary sort functions.
  17917. * This should not be used directly aside of the few static configurations
  17918. */
  17919. export class RenderingManager {
  17920. /**
  17921. * The max id used for rendering groups (not included)
  17922. */
  17923. static MAX_RENDERINGGROUPS: number;
  17924. /**
  17925. * The min id used for rendering groups (included)
  17926. */
  17927. static MIN_RENDERINGGROUPS: number;
  17928. /**
  17929. * Used to globally prevent autoclearing scenes.
  17930. */
  17931. static AUTOCLEAR: boolean;
  17932. /**
  17933. * @hidden
  17934. */
  17935. _useSceneAutoClearSetup: boolean;
  17936. private _scene;
  17937. private _renderingGroups;
  17938. private _depthStencilBufferAlreadyCleaned;
  17939. private _autoClearDepthStencil;
  17940. private _customOpaqueSortCompareFn;
  17941. private _customAlphaTestSortCompareFn;
  17942. private _customTransparentSortCompareFn;
  17943. private _renderingGroupInfo;
  17944. /**
  17945. * Instantiates a new rendering group for a particular scene
  17946. * @param scene Defines the scene the groups belongs to
  17947. */
  17948. constructor(scene: Scene);
  17949. private _clearDepthStencilBuffer;
  17950. /**
  17951. * Renders the entire managed groups. This is used by the scene or the different rennder targets.
  17952. * @hidden
  17953. */
  17954. render(customRenderFunction: Nullable<(opaqueSubMeshes: SmartArray<SubMesh>, transparentSubMeshes: SmartArray<SubMesh>, alphaTestSubMeshes: SmartArray<SubMesh>, depthOnlySubMeshes: SmartArray<SubMesh>) => void>, activeMeshes: Nullable<AbstractMesh[]>, renderParticles: boolean, renderSprites: boolean): void;
  17955. /**
  17956. * Resets the different information of the group to prepare a new frame
  17957. * @hidden
  17958. */
  17959. reset(): void;
  17960. /**
  17961. * Dispose and release the group and its associated resources.
  17962. * @hidden
  17963. */
  17964. dispose(): void;
  17965. /**
  17966. * Clear the info related to rendering groups preventing retention points during dispose.
  17967. */
  17968. freeRenderingGroups(): void;
  17969. private _prepareRenderingGroup;
  17970. /**
  17971. * Add a sprite manager to the rendering manager in order to render it this frame.
  17972. * @param spriteManager Define the sprite manager to render
  17973. */
  17974. dispatchSprites(spriteManager: ISpriteManager): void;
  17975. /**
  17976. * Add a particle system to the rendering manager in order to render it this frame.
  17977. * @param particleSystem Define the particle system to render
  17978. */
  17979. dispatchParticles(particleSystem: IParticleSystem): void;
  17980. /**
  17981. * Add a submesh to the manager in order to render it this frame
  17982. * @param subMesh The submesh to dispatch
  17983. * @param mesh Optional reference to the submeshes's mesh. Provide if you have an exiting reference to improve performance.
  17984. * @param material Optional reference to the submeshes's material. Provide if you have an exiting reference to improve performance.
  17985. */
  17986. dispatch(subMesh: SubMesh, mesh?: AbstractMesh, material?: Nullable<Material>): void;
  17987. /**
  17988. * Overrides the default sort function applied in the renderging group to prepare the meshes.
  17989. * This allowed control for front to back rendering or reversly depending of the special needs.
  17990. *
  17991. * @param renderingGroupId The rendering group id corresponding to its index
  17992. * @param opaqueSortCompareFn The opaque queue comparison function use to sort.
  17993. * @param alphaTestSortCompareFn The alpha test queue comparison function use to sort.
  17994. * @param transparentSortCompareFn The transparent queue comparison function use to sort.
  17995. */
  17996. 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;
  17997. /**
  17998. * Specifies whether or not the stencil and depth buffer are cleared between two rendering groups.
  17999. *
  18000. * @param renderingGroupId The rendering group id corresponding to its index
  18001. * @param autoClearDepthStencil Automatically clears depth and stencil between groups if true.
  18002. * @param depth Automatically clears depth between groups if true and autoClear is true.
  18003. * @param stencil Automatically clears stencil between groups if true and autoClear is true.
  18004. */
  18005. setRenderingAutoClearDepthStencil(renderingGroupId: number, autoClearDepthStencil: boolean, depth?: boolean, stencil?: boolean): void;
  18006. /**
  18007. * Gets the current auto clear configuration for one rendering group of the rendering
  18008. * manager.
  18009. * @param index the rendering group index to get the information for
  18010. * @returns The auto clear setup for the requested rendering group
  18011. */
  18012. getAutoClearDepthStencilSetup(index: number): IRenderingManagerAutoClearSetup;
  18013. }
  18014. }
  18015. declare module "babylonjs/Lights/Shadows/shadowGenerator" {
  18016. import { SmartArray } from "babylonjs/Misc/smartArray";
  18017. import { Nullable } from "babylonjs/types";
  18018. import { Scene } from "babylonjs/scene";
  18019. import { Matrix, Vector3 } from "babylonjs/Maths/math.vector";
  18020. import { SubMesh } from "babylonjs/Meshes/subMesh";
  18021. import { AbstractMesh } from "babylonjs/Meshes/abstractMesh";
  18022. import { Mesh } from "babylonjs/Meshes/mesh";
  18023. import { IShadowLight } from "babylonjs/Lights/shadowLight";
  18024. import { MaterialDefines } from "babylonjs/Materials/materialDefines";
  18025. import { Effect } from "babylonjs/Materials/effect";
  18026. import { RenderTargetTexture } from "babylonjs/Materials/Textures/renderTargetTexture";
  18027. import { PostProcess } from "babylonjs/PostProcesses/postProcess";
  18028. import "babylonjs/Shaders/shadowMap.fragment";
  18029. import "babylonjs/Shaders/shadowMap.vertex";
  18030. import "babylonjs/Shaders/depthBoxBlur.fragment";
  18031. import "babylonjs/Shaders/ShadersInclude/shadowMapFragmentSoftTransparentShadow";
  18032. import { Observable } from "babylonjs/Misc/observable";
  18033. /**
  18034. * Defines the options associated with the creation of a custom shader for a shadow generator.
  18035. */
  18036. export interface ICustomShaderOptions {
  18037. /**
  18038. * Gets or sets the custom shader name to use
  18039. */
  18040. shaderName: string;
  18041. /**
  18042. * The list of attribute names used in the shader
  18043. */
  18044. attributes?: string[];
  18045. /**
  18046. * The list of unifrom names used in the shader
  18047. */
  18048. uniforms?: string[];
  18049. /**
  18050. * The list of sampler names used in the shader
  18051. */
  18052. samplers?: string[];
  18053. /**
  18054. * The list of defines used in the shader
  18055. */
  18056. defines?: string[];
  18057. }
  18058. /**
  18059. * Interface to implement to create a shadow generator compatible with BJS.
  18060. */
  18061. export interface IShadowGenerator {
  18062. /** Gets or set the id of the shadow generator. It will be the one from the light if not defined */
  18063. id: string;
  18064. /**
  18065. * Gets the main RTT containing the shadow map (usually storing depth from the light point of view).
  18066. * @returns The render target texture if present otherwise, null
  18067. */
  18068. getShadowMap(): Nullable<RenderTargetTexture>;
  18069. /**
  18070. * Determine wheter the shadow generator is ready or not (mainly all effects and related post processes needs to be ready).
  18071. * @param subMesh The submesh we want to render in the shadow map
  18072. * @param useInstances Defines wether will draw in the map using instances
  18073. * @param isTransparent Indicates that isReady is called for a transparent subMesh
  18074. * @returns true if ready otherwise, false
  18075. */
  18076. isReady(subMesh: SubMesh, useInstances: boolean, isTransparent: boolean): boolean;
  18077. /**
  18078. * Prepare all the defines in a material relying on a shadow map at the specified light index.
  18079. * @param defines Defines of the material we want to update
  18080. * @param lightIndex Index of the light in the enabled light list of the material
  18081. */
  18082. prepareDefines(defines: MaterialDefines, lightIndex: number): void;
  18083. /**
  18084. * Binds the shadow related information inside of an effect (information like near, far, darkness...
  18085. * defined in the generator but impacting the effect).
  18086. * It implies the unifroms available on the materials are the standard BJS ones.
  18087. * @param lightIndex Index of the light in the enabled light list of the material owning the effect
  18088. * @param effect The effect we are binfing the information for
  18089. */
  18090. bindShadowLight(lightIndex: string, effect: Effect): void;
  18091. /**
  18092. * Gets the transformation matrix used to project the meshes into the map from the light point of view.
  18093. * (eq to shadow prjection matrix * light transform matrix)
  18094. * @returns The transform matrix used to create the shadow map
  18095. */
  18096. getTransformMatrix(): Matrix;
  18097. /**
  18098. * Recreates the shadow map dependencies like RTT and post processes. This can be used during the switch between
  18099. * Cube and 2D textures for instance.
  18100. */
  18101. recreateShadowMap(): void;
  18102. /**
  18103. * Forces all the attached effect to compile to enable rendering only once ready vs. lazyly compiling effects.
  18104. * @param onCompiled Callback triggered at the and of the effects compilation
  18105. * @param options Sets of optional options forcing the compilation with different modes
  18106. */
  18107. forceCompilation(onCompiled?: (generator: IShadowGenerator) => void, options?: Partial<{
  18108. useInstances: boolean;
  18109. }>): void;
  18110. /**
  18111. * Forces all the attached effect to compile to enable rendering only once ready vs. lazyly compiling effects.
  18112. * @param options Sets of optional options forcing the compilation with different modes
  18113. * @returns A promise that resolves when the compilation completes
  18114. */
  18115. forceCompilationAsync(options?: Partial<{
  18116. useInstances: boolean;
  18117. }>): Promise<void>;
  18118. /**
  18119. * Serializes the shadow generator setup to a json object.
  18120. * @returns The serialized JSON object
  18121. */
  18122. serialize(): any;
  18123. /**
  18124. * Disposes the Shadow map and related Textures and effects.
  18125. */
  18126. dispose(): void;
  18127. }
  18128. /**
  18129. * Default implementation IShadowGenerator.
  18130. * This is the main object responsible of generating shadows in the framework.
  18131. * Documentation: https://doc.babylonjs.com/babylon101/shadows
  18132. */
  18133. export class ShadowGenerator implements IShadowGenerator {
  18134. /**
  18135. * Name of the shadow generator class
  18136. */
  18137. static CLASSNAME: string;
  18138. /**
  18139. * Shadow generator mode None: no filtering applied.
  18140. */
  18141. static readonly FILTER_NONE: number;
  18142. /**
  18143. * Shadow generator mode ESM: Exponential Shadow Mapping.
  18144. * (http://developer.download.nvidia.com/presentations/2008/GDC/GDC08_SoftShadowMapping.pdf)
  18145. */
  18146. static readonly FILTER_EXPONENTIALSHADOWMAP: number;
  18147. /**
  18148. * Shadow generator mode Poisson Sampling: Percentage Closer Filtering.
  18149. * (Multiple Tap around evenly distributed around the pixel are used to evaluate the shadow strength)
  18150. */
  18151. static readonly FILTER_POISSONSAMPLING: number;
  18152. /**
  18153. * Shadow generator mode ESM: Blurred Exponential Shadow Mapping.
  18154. * (http://developer.download.nvidia.com/presentations/2008/GDC/GDC08_SoftShadowMapping.pdf)
  18155. */
  18156. static readonly FILTER_BLUREXPONENTIALSHADOWMAP: number;
  18157. /**
  18158. * Shadow generator mode ESM: Exponential Shadow Mapping using the inverse of the exponential preventing
  18159. * edge artifacts on steep falloff.
  18160. * (http://developer.download.nvidia.com/presentations/2008/GDC/GDC08_SoftShadowMapping.pdf)
  18161. */
  18162. static readonly FILTER_CLOSEEXPONENTIALSHADOWMAP: number;
  18163. /**
  18164. * Shadow generator mode ESM: Blurred Exponential Shadow Mapping using the inverse of the exponential preventing
  18165. * edge artifacts on steep falloff.
  18166. * (http://developer.download.nvidia.com/presentations/2008/GDC/GDC08_SoftShadowMapping.pdf)
  18167. */
  18168. static readonly FILTER_BLURCLOSEEXPONENTIALSHADOWMAP: number;
  18169. /**
  18170. * Shadow generator mode PCF: Percentage Closer Filtering
  18171. * benefits from Webgl 2 shadow samplers. Fallback to Poisson Sampling in Webgl 1
  18172. * (https://developer.nvidia.com/gpugems/GPUGems/gpugems_ch11.html)
  18173. */
  18174. static readonly FILTER_PCF: number;
  18175. /**
  18176. * Shadow generator mode PCSS: Percentage Closering Soft Shadow.
  18177. * benefits from Webgl 2 shadow samplers. Fallback to Poisson Sampling in Webgl 1
  18178. * Contact Hardening
  18179. */
  18180. static readonly FILTER_PCSS: number;
  18181. /**
  18182. * Reserved for PCF and PCSS
  18183. * Highest Quality.
  18184. *
  18185. * Execute PCF on a 5*5 kernel improving a lot the shadow aliasing artifacts.
  18186. *
  18187. * Execute PCSS with 32 taps blocker search and 64 taps PCF.
  18188. */
  18189. static readonly QUALITY_HIGH: number;
  18190. /**
  18191. * Reserved for PCF and PCSS
  18192. * Good tradeoff for quality/perf cross devices
  18193. *
  18194. * Execute PCF on a 3*3 kernel.
  18195. *
  18196. * Execute PCSS with 16 taps blocker search and 32 taps PCF.
  18197. */
  18198. static readonly QUALITY_MEDIUM: number;
  18199. /**
  18200. * Reserved for PCF and PCSS
  18201. * The lowest quality but the fastest.
  18202. *
  18203. * Execute PCF on a 1*1 kernel.
  18204. *
  18205. * Execute PCSS with 16 taps blocker search and 16 taps PCF.
  18206. */
  18207. static readonly QUALITY_LOW: number;
  18208. /** Gets or set the id of the shadow generator. It will be the one from the light if not defined */
  18209. id: string;
  18210. /** Gets or sets the custom shader name to use */
  18211. customShaderOptions: ICustomShaderOptions;
  18212. /**
  18213. * Observable triggered before the shadow is rendered. Can be used to update internal effect state
  18214. */
  18215. onBeforeShadowMapRenderObservable: Observable<Effect>;
  18216. /**
  18217. * Observable triggered after the shadow is rendered. Can be used to restore internal effect state
  18218. */
  18219. onAfterShadowMapRenderObservable: Observable<Effect>;
  18220. /**
  18221. * Observable triggered before a mesh is rendered in the shadow map.
  18222. * Can be used to update internal effect state (that you can get from the onBeforeShadowMapRenderObservable)
  18223. */
  18224. onBeforeShadowMapRenderMeshObservable: Observable<Mesh>;
  18225. /**
  18226. * Observable triggered after a mesh is rendered in the shadow map.
  18227. * Can be used to update internal effect state (that you can get from the onAfterShadowMapRenderObservable)
  18228. */
  18229. onAfterShadowMapRenderMeshObservable: Observable<Mesh>;
  18230. protected _bias: number;
  18231. /**
  18232. * Gets the bias: offset applied on the depth preventing acnea (in light direction).
  18233. */
  18234. get bias(): number;
  18235. /**
  18236. * Sets the bias: offset applied on the depth preventing acnea (in light direction).
  18237. */
  18238. set bias(bias: number);
  18239. protected _normalBias: number;
  18240. /**
  18241. * Gets the normalBias: offset applied on the depth preventing acnea (along side the normal direction and proportinal to the light/normal angle).
  18242. */
  18243. get normalBias(): number;
  18244. /**
  18245. * Sets the normalBias: offset applied on the depth preventing acnea (along side the normal direction and proportinal to the light/normal angle).
  18246. */
  18247. set normalBias(normalBias: number);
  18248. protected _blurBoxOffset: number;
  18249. /**
  18250. * Gets the blur box offset: offset applied during the blur pass.
  18251. * Only useful if useKernelBlur = false
  18252. */
  18253. get blurBoxOffset(): number;
  18254. /**
  18255. * Sets the blur box offset: offset applied during the blur pass.
  18256. * Only useful if useKernelBlur = false
  18257. */
  18258. set blurBoxOffset(value: number);
  18259. protected _blurScale: number;
  18260. /**
  18261. * Gets the blur scale: scale of the blurred texture compared to the main shadow map.
  18262. * 2 means half of the size.
  18263. */
  18264. get blurScale(): number;
  18265. /**
  18266. * Sets the blur scale: scale of the blurred texture compared to the main shadow map.
  18267. * 2 means half of the size.
  18268. */
  18269. set blurScale(value: number);
  18270. protected _blurKernel: number;
  18271. /**
  18272. * Gets the blur kernel: kernel size of the blur pass.
  18273. * Only useful if useKernelBlur = true
  18274. */
  18275. get blurKernel(): number;
  18276. /**
  18277. * Sets the blur kernel: kernel size of the blur pass.
  18278. * Only useful if useKernelBlur = true
  18279. */
  18280. set blurKernel(value: number);
  18281. protected _useKernelBlur: boolean;
  18282. /**
  18283. * Gets whether the blur pass is a kernel blur (if true) or box blur.
  18284. * Only useful in filtered mode (useBlurExponentialShadowMap...)
  18285. */
  18286. get useKernelBlur(): boolean;
  18287. /**
  18288. * Sets whether the blur pass is a kernel blur (if true) or box blur.
  18289. * Only useful in filtered mode (useBlurExponentialShadowMap...)
  18290. */
  18291. set useKernelBlur(value: boolean);
  18292. protected _depthScale: number;
  18293. /**
  18294. * Gets the depth scale used in ESM mode.
  18295. */
  18296. get depthScale(): number;
  18297. /**
  18298. * Sets the depth scale used in ESM mode.
  18299. * This can override the scale stored on the light.
  18300. */
  18301. set depthScale(value: number);
  18302. protected _validateFilter(filter: number): number;
  18303. protected _filter: number;
  18304. /**
  18305. * Gets the current mode of the shadow generator (normal, PCF, ESM...).
  18306. * The returned value is a number equal to one of the available mode defined in ShadowMap.FILTER_x like _FILTER_NONE
  18307. */
  18308. get filter(): number;
  18309. /**
  18310. * Sets the current mode of the shadow generator (normal, PCF, ESM...).
  18311. * The returned value is a number equal to one of the available mode defined in ShadowMap.FILTER_x like _FILTER_NONE
  18312. */
  18313. set filter(value: number);
  18314. /**
  18315. * Gets if the current filter is set to Poisson Sampling.
  18316. */
  18317. get usePoissonSampling(): boolean;
  18318. /**
  18319. * Sets the current filter to Poisson Sampling.
  18320. */
  18321. set usePoissonSampling(value: boolean);
  18322. /**
  18323. * Gets if the current filter is set to ESM.
  18324. */
  18325. get useExponentialShadowMap(): boolean;
  18326. /**
  18327. * Sets the current filter is to ESM.
  18328. */
  18329. set useExponentialShadowMap(value: boolean);
  18330. /**
  18331. * Gets if the current filter is set to filtered ESM.
  18332. */
  18333. get useBlurExponentialShadowMap(): boolean;
  18334. /**
  18335. * Gets if the current filter is set to filtered ESM.
  18336. */
  18337. set useBlurExponentialShadowMap(value: boolean);
  18338. /**
  18339. * Gets if the current filter is set to "close ESM" (using the inverse of the
  18340. * exponential to prevent steep falloff artifacts).
  18341. */
  18342. get useCloseExponentialShadowMap(): boolean;
  18343. /**
  18344. * Sets the current filter to "close ESM" (using the inverse of the
  18345. * exponential to prevent steep falloff artifacts).
  18346. */
  18347. set useCloseExponentialShadowMap(value: boolean);
  18348. /**
  18349. * Gets if the current filter is set to filtered "close ESM" (using the inverse of the
  18350. * exponential to prevent steep falloff artifacts).
  18351. */
  18352. get useBlurCloseExponentialShadowMap(): boolean;
  18353. /**
  18354. * Sets the current filter to filtered "close ESM" (using the inverse of the
  18355. * exponential to prevent steep falloff artifacts).
  18356. */
  18357. set useBlurCloseExponentialShadowMap(value: boolean);
  18358. /**
  18359. * Gets if the current filter is set to "PCF" (percentage closer filtering).
  18360. */
  18361. get usePercentageCloserFiltering(): boolean;
  18362. /**
  18363. * Sets the current filter to "PCF" (percentage closer filtering).
  18364. */
  18365. set usePercentageCloserFiltering(value: boolean);
  18366. protected _filteringQuality: number;
  18367. /**
  18368. * Gets the PCF or PCSS Quality.
  18369. * Only valid if usePercentageCloserFiltering or usePercentageCloserFiltering is true.
  18370. */
  18371. get filteringQuality(): number;
  18372. /**
  18373. * Sets the PCF or PCSS Quality.
  18374. * Only valid if usePercentageCloserFiltering or usePercentageCloserFiltering is true.
  18375. */
  18376. set filteringQuality(filteringQuality: number);
  18377. /**
  18378. * Gets if the current filter is set to "PCSS" (contact hardening).
  18379. */
  18380. get useContactHardeningShadow(): boolean;
  18381. /**
  18382. * Sets the current filter to "PCSS" (contact hardening).
  18383. */
  18384. set useContactHardeningShadow(value: boolean);
  18385. protected _contactHardeningLightSizeUVRatio: number;
  18386. /**
  18387. * Gets the Light Size (in shadow map uv unit) used in PCSS to determine the blocker search area and the penumbra size.
  18388. * Using a ratio helps keeping shape stability independently of the map size.
  18389. *
  18390. * It does not account for the light projection as it was having too much
  18391. * instability during the light setup or during light position changes.
  18392. *
  18393. * Only valid if useContactHardeningShadow is true.
  18394. */
  18395. get contactHardeningLightSizeUVRatio(): number;
  18396. /**
  18397. * Sets the Light Size (in shadow map uv unit) used in PCSS to determine the blocker search area and the penumbra size.
  18398. * Using a ratio helps keeping shape stability independently of the map size.
  18399. *
  18400. * It does not account for the light projection as it was having too much
  18401. * instability during the light setup or during light position changes.
  18402. *
  18403. * Only valid if useContactHardeningShadow is true.
  18404. */
  18405. set contactHardeningLightSizeUVRatio(contactHardeningLightSizeUVRatio: number);
  18406. protected _darkness: number;
  18407. /** Gets or sets the actual darkness of a shadow */
  18408. get darkness(): number;
  18409. set darkness(value: number);
  18410. /**
  18411. * Returns the darkness value (float). This can only decrease the actual darkness of a shadow.
  18412. * 0 means strongest and 1 would means no shadow.
  18413. * @returns the darkness.
  18414. */
  18415. getDarkness(): number;
  18416. /**
  18417. * Sets the darkness value (float). This can only decrease the actual darkness of a shadow.
  18418. * @param darkness The darkness value 0 means strongest and 1 would means no shadow.
  18419. * @returns the shadow generator allowing fluent coding.
  18420. */
  18421. setDarkness(darkness: number): ShadowGenerator;
  18422. protected _transparencyShadow: boolean;
  18423. /** Gets or sets the ability to have transparent shadow */
  18424. get transparencyShadow(): boolean;
  18425. set transparencyShadow(value: boolean);
  18426. /**
  18427. * Sets the ability to have transparent shadow (boolean).
  18428. * @param transparent True if transparent else False
  18429. * @returns the shadow generator allowing fluent coding
  18430. */
  18431. setTransparencyShadow(transparent: boolean): ShadowGenerator;
  18432. /**
  18433. * Enables or disables shadows with varying strength based on the transparency
  18434. * When it is enabled, the strength of the shadow is taken equal to mesh.visibility
  18435. * If you enabled an alpha texture on your material, the alpha value red from the texture is also combined to compute the strength:
  18436. * mesh.visibility * alphaTexture.a
  18437. * Note that by definition transparencyShadow must be set to true for enableSoftTransparentShadow to work!
  18438. */
  18439. enableSoftTransparentShadow: boolean;
  18440. protected _shadowMap: Nullable<RenderTargetTexture>;
  18441. protected _shadowMap2: Nullable<RenderTargetTexture>;
  18442. /**
  18443. * Gets the main RTT containing the shadow map (usually storing depth from the light point of view).
  18444. * @returns The render target texture if present otherwise, null
  18445. */
  18446. getShadowMap(): Nullable<RenderTargetTexture>;
  18447. /**
  18448. * Gets the RTT used during rendering (can be a blurred version of the shadow map or the shadow map itself).
  18449. * @returns The render target texture if the shadow map is present otherwise, null
  18450. */
  18451. getShadowMapForRendering(): Nullable<RenderTargetTexture>;
  18452. /**
  18453. * Gets the class name of that object
  18454. * @returns "ShadowGenerator"
  18455. */
  18456. getClassName(): string;
  18457. /**
  18458. * Helper function to add a mesh and its descendants to the list of shadow casters.
  18459. * @param mesh Mesh to add
  18460. * @param includeDescendants boolean indicating if the descendants should be added. Default to true
  18461. * @returns the Shadow Generator itself
  18462. */
  18463. addShadowCaster(mesh: AbstractMesh, includeDescendants?: boolean): ShadowGenerator;
  18464. /**
  18465. * Helper function to remove a mesh and its descendants from the list of shadow casters
  18466. * @param mesh Mesh to remove
  18467. * @param includeDescendants boolean indicating if the descendants should be removed. Default to true
  18468. * @returns the Shadow Generator itself
  18469. */
  18470. removeShadowCaster(mesh: AbstractMesh, includeDescendants?: boolean): ShadowGenerator;
  18471. /**
  18472. * Controls the extent to which the shadows fade out at the edge of the frustum
  18473. */
  18474. frustumEdgeFalloff: number;
  18475. protected _light: IShadowLight;
  18476. /**
  18477. * Returns the associated light object.
  18478. * @returns the light generating the shadow
  18479. */
  18480. getLight(): IShadowLight;
  18481. /**
  18482. * If true the shadow map is generated by rendering the back face of the mesh instead of the front face.
  18483. * This can help with self-shadowing as the geometry making up the back of objects is slightly offset.
  18484. * It might on the other hand introduce peter panning.
  18485. */
  18486. forceBackFacesOnly: boolean;
  18487. protected _scene: Scene;
  18488. protected _lightDirection: Vector3;
  18489. protected _effect: Effect;
  18490. protected _viewMatrix: Matrix;
  18491. protected _projectionMatrix: Matrix;
  18492. protected _transformMatrix: Matrix;
  18493. protected _cachedPosition: Vector3;
  18494. protected _cachedDirection: Vector3;
  18495. protected _cachedDefines: string;
  18496. protected _currentRenderID: number;
  18497. protected _boxBlurPostprocess: Nullable<PostProcess>;
  18498. protected _kernelBlurXPostprocess: Nullable<PostProcess>;
  18499. protected _kernelBlurYPostprocess: Nullable<PostProcess>;
  18500. protected _blurPostProcesses: PostProcess[];
  18501. protected _mapSize: number;
  18502. protected _currentFaceIndex: number;
  18503. protected _currentFaceIndexCache: number;
  18504. protected _textureType: number;
  18505. protected _defaultTextureMatrix: Matrix;
  18506. protected _storedUniqueId: Nullable<number>;
  18507. /** @hidden */
  18508. static _SceneComponentInitialization: (scene: Scene) => void;
  18509. /**
  18510. * Gets or sets the size of the texture what stores the shadows
  18511. */
  18512. get mapSize(): number;
  18513. set mapSize(size: number);
  18514. /**
  18515. * Creates a ShadowGenerator object.
  18516. * A ShadowGenerator is the required tool to use the shadows.
  18517. * Each light casting shadows needs to use its own ShadowGenerator.
  18518. * Documentation : https://doc.babylonjs.com/babylon101/shadows
  18519. * @param mapSize The size of the texture what stores the shadows. Example : 1024.
  18520. * @param light The light object generating the shadows.
  18521. * @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.
  18522. */
  18523. constructor(mapSize: number, light: IShadowLight, usefulFloatFirst?: boolean);
  18524. protected _initializeGenerator(): void;
  18525. protected _createTargetRenderTexture(): void;
  18526. protected _initializeShadowMap(): void;
  18527. protected _initializeBlurRTTAndPostProcesses(): void;
  18528. protected _renderForShadowMap(opaqueSubMeshes: SmartArray<SubMesh>, alphaTestSubMeshes: SmartArray<SubMesh>, transparentSubMeshes: SmartArray<SubMesh>, depthOnlySubMeshes: SmartArray<SubMesh>): void;
  18529. protected _bindCustomEffectForRenderSubMeshForShadowMap(subMesh: SubMesh, effect: Effect, matriceNames: any, mesh: AbstractMesh): void;
  18530. protected _renderSubMeshForShadowMap(subMesh: SubMesh, isTransparent?: boolean): void;
  18531. protected _applyFilterValues(): void;
  18532. /**
  18533. * Forces all the attached effect to compile to enable rendering only once ready vs. lazyly compiling effects.
  18534. * @param onCompiled Callback triggered at the and of the effects compilation
  18535. * @param options Sets of optional options forcing the compilation with different modes
  18536. */
  18537. forceCompilation(onCompiled?: (generator: IShadowGenerator) => void, options?: Partial<{
  18538. useInstances: boolean;
  18539. }>): void;
  18540. /**
  18541. * Forces all the attached effect to compile to enable rendering only once ready vs. lazyly compiling effects.
  18542. * @param options Sets of optional options forcing the compilation with different modes
  18543. * @returns A promise that resolves when the compilation completes
  18544. */
  18545. forceCompilationAsync(options?: Partial<{
  18546. useInstances: boolean;
  18547. }>): Promise<void>;
  18548. protected _isReadyCustomDefines(defines: any, subMesh: SubMesh, useInstances: boolean): void;
  18549. private _prepareShadowDefines;
  18550. /**
  18551. * Determine wheter the shadow generator is ready or not (mainly all effects and related post processes needs to be ready).
  18552. * @param subMesh The submesh we want to render in the shadow map
  18553. * @param useInstances Defines wether will draw in the map using instances
  18554. * @param isTransparent Indicates that isReady is called for a transparent subMesh
  18555. * @returns true if ready otherwise, false
  18556. */
  18557. isReady(subMesh: SubMesh, useInstances: boolean, isTransparent: boolean): boolean;
  18558. /**
  18559. * Prepare all the defines in a material relying on a shadow map at the specified light index.
  18560. * @param defines Defines of the material we want to update
  18561. * @param lightIndex Index of the light in the enabled light list of the material
  18562. */
  18563. prepareDefines(defines: any, lightIndex: number): void;
  18564. /**
  18565. * Binds the shadow related information inside of an effect (information like near, far, darkness...
  18566. * defined in the generator but impacting the effect).
  18567. * @param lightIndex Index of the light in the enabled light list of the material owning the effect
  18568. * @param effect The effect we are binfing the information for
  18569. */
  18570. bindShadowLight(lightIndex: string, effect: Effect): void;
  18571. /**
  18572. * Gets the transformation matrix used to project the meshes into the map from the light point of view.
  18573. * (eq to shadow prjection matrix * light transform matrix)
  18574. * @returns The transform matrix used to create the shadow map
  18575. */
  18576. getTransformMatrix(): Matrix;
  18577. /**
  18578. * Recreates the shadow map dependencies like RTT and post processes. This can be used during the switch between
  18579. * Cube and 2D textures for instance.
  18580. */
  18581. recreateShadowMap(): void;
  18582. protected _disposeBlurPostProcesses(): void;
  18583. protected _disposeRTTandPostProcesses(): void;
  18584. /**
  18585. * Disposes the ShadowGenerator.
  18586. * Returns nothing.
  18587. */
  18588. dispose(): void;
  18589. /**
  18590. * Serializes the shadow generator setup to a json object.
  18591. * @returns The serialized JSON object
  18592. */
  18593. serialize(): any;
  18594. /**
  18595. * Parses a serialized ShadowGenerator and returns a new ShadowGenerator.
  18596. * @param parsedShadowGenerator The JSON object to parse
  18597. * @param scene The scene to create the shadow map for
  18598. * @param constr A function that builds a shadow generator or undefined to create an instance of the default shadow generator
  18599. * @returns The parsed shadow generator
  18600. */
  18601. static Parse(parsedShadowGenerator: any, scene: Scene, constr?: (mapSize: number, light: IShadowLight) => ShadowGenerator): ShadowGenerator;
  18602. }
  18603. }
  18604. declare module "babylonjs/Lights/light" {
  18605. import { Nullable } from "babylonjs/types";
  18606. import { Scene } from "babylonjs/scene";
  18607. import { Vector3 } from "babylonjs/Maths/math.vector";
  18608. import { Color3 } from "babylonjs/Maths/math.color";
  18609. import { Node } from "babylonjs/node";
  18610. import { AbstractMesh } from "babylonjs/Meshes/abstractMesh";
  18611. import { Effect } from "babylonjs/Materials/effect";
  18612. import { UniformBuffer } from "babylonjs/Materials/uniformBuffer";
  18613. import { IShadowGenerator } from "babylonjs/Lights/Shadows/shadowGenerator";
  18614. /**
  18615. * Base class of all the lights in Babylon. It groups all the generic information about lights.
  18616. * Lights are used, as you would expect, to affect how meshes are seen, in terms of both illumination and colour.
  18617. * 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.
  18618. */
  18619. export abstract class Light extends Node {
  18620. /**
  18621. * Falloff Default: light is falling off following the material specification:
  18622. * standard material is using standard falloff whereas pbr material can request special falloff per materials.
  18623. */
  18624. static readonly FALLOFF_DEFAULT: number;
  18625. /**
  18626. * Falloff Physical: light is falling off following the inverse squared distance law.
  18627. */
  18628. static readonly FALLOFF_PHYSICAL: number;
  18629. /**
  18630. * Falloff gltf: light is falling off as described in the gltf moving to PBR document
  18631. * to enhance interoperability with other engines.
  18632. */
  18633. static readonly FALLOFF_GLTF: number;
  18634. /**
  18635. * Falloff Standard: light is falling off like in the standard material
  18636. * to enhance interoperability with other materials.
  18637. */
  18638. static readonly FALLOFF_STANDARD: number;
  18639. /**
  18640. * If every light affecting the material is in this lightmapMode,
  18641. * material.lightmapTexture adds or multiplies
  18642. * (depends on material.useLightmapAsShadowmap)
  18643. * after every other light calculations.
  18644. */
  18645. static readonly LIGHTMAP_DEFAULT: number;
  18646. /**
  18647. * material.lightmapTexture as only diffuse lighting from this light
  18648. * adds only specular lighting from this light
  18649. * adds dynamic shadows
  18650. */
  18651. static readonly LIGHTMAP_SPECULAR: number;
  18652. /**
  18653. * material.lightmapTexture as only lighting
  18654. * no light calculation from this light
  18655. * only adds dynamic shadows from this light
  18656. */
  18657. static readonly LIGHTMAP_SHADOWSONLY: number;
  18658. /**
  18659. * Each light type uses the default quantity according to its type:
  18660. * point/spot lights use luminous intensity
  18661. * directional lights use illuminance
  18662. */
  18663. static readonly INTENSITYMODE_AUTOMATIC: number;
  18664. /**
  18665. * lumen (lm)
  18666. */
  18667. static readonly INTENSITYMODE_LUMINOUSPOWER: number;
  18668. /**
  18669. * candela (lm/sr)
  18670. */
  18671. static readonly INTENSITYMODE_LUMINOUSINTENSITY: number;
  18672. /**
  18673. * lux (lm/m^2)
  18674. */
  18675. static readonly INTENSITYMODE_ILLUMINANCE: number;
  18676. /**
  18677. * nit (cd/m^2)
  18678. */
  18679. static readonly INTENSITYMODE_LUMINANCE: number;
  18680. /**
  18681. * Light type const id of the point light.
  18682. */
  18683. static readonly LIGHTTYPEID_POINTLIGHT: number;
  18684. /**
  18685. * Light type const id of the directional light.
  18686. */
  18687. static readonly LIGHTTYPEID_DIRECTIONALLIGHT: number;
  18688. /**
  18689. * Light type const id of the spot light.
  18690. */
  18691. static readonly LIGHTTYPEID_SPOTLIGHT: number;
  18692. /**
  18693. * Light type const id of the hemispheric light.
  18694. */
  18695. static readonly LIGHTTYPEID_HEMISPHERICLIGHT: number;
  18696. /**
  18697. * Diffuse gives the basic color to an object.
  18698. */
  18699. diffuse: Color3;
  18700. /**
  18701. * Specular produces a highlight color on an object.
  18702. * Note: This is note affecting PBR materials.
  18703. */
  18704. specular: Color3;
  18705. /**
  18706. * Defines the falloff type for this light. This lets overrriding how punctual light are
  18707. * falling off base on range or angle.
  18708. * This can be set to any values in Light.FALLOFF_x.
  18709. *
  18710. * Note: This is only useful for PBR Materials at the moment. This could be extended if required to
  18711. * other types of materials.
  18712. */
  18713. falloffType: number;
  18714. /**
  18715. * Strength of the light.
  18716. * Note: By default it is define in the framework own unit.
  18717. * Note: In PBR materials the intensityMode can be use to chose what unit the intensity is defined in.
  18718. */
  18719. intensity: number;
  18720. private _range;
  18721. protected _inverseSquaredRange: number;
  18722. /**
  18723. * Defines how far from the source the light is impacting in scene units.
  18724. * Note: Unused in PBR material as the distance light falloff is defined following the inverse squared falloff.
  18725. */
  18726. get range(): number;
  18727. /**
  18728. * Defines how far from the source the light is impacting in scene units.
  18729. * Note: Unused in PBR material as the distance light falloff is defined following the inverse squared falloff.
  18730. */
  18731. set range(value: number);
  18732. /**
  18733. * Cached photometric scale default to 1.0 as the automatic intensity mode defaults to 1.0 for every type
  18734. * of light.
  18735. */
  18736. private _photometricScale;
  18737. private _intensityMode;
  18738. /**
  18739. * Gets the photometric scale used to interpret the intensity.
  18740. * This is only relevant with PBR Materials where the light intensity can be defined in a physical way.
  18741. */
  18742. get intensityMode(): number;
  18743. /**
  18744. * Sets the photometric scale used to interpret the intensity.
  18745. * This is only relevant with PBR Materials where the light intensity can be defined in a physical way.
  18746. */
  18747. set intensityMode(value: number);
  18748. private _radius;
  18749. /**
  18750. * Gets the light radius used by PBR Materials to simulate soft area lights.
  18751. */
  18752. get radius(): number;
  18753. /**
  18754. * sets the light radius used by PBR Materials to simulate soft area lights.
  18755. */
  18756. set radius(value: number);
  18757. private _renderPriority;
  18758. /**
  18759. * Defines the rendering priority of the lights. It can help in case of fallback or number of lights
  18760. * exceeding the number allowed of the materials.
  18761. */
  18762. renderPriority: number;
  18763. private _shadowEnabled;
  18764. /**
  18765. * Gets wether or not the shadows are enabled for this light. This can help turning off/on shadow without detaching
  18766. * the current shadow generator.
  18767. */
  18768. get shadowEnabled(): boolean;
  18769. /**
  18770. * Sets wether or not the shadows are enabled for this light. This can help turning off/on shadow without detaching
  18771. * the current shadow generator.
  18772. */
  18773. set shadowEnabled(value: boolean);
  18774. private _includedOnlyMeshes;
  18775. /**
  18776. * Gets the only meshes impacted by this light.
  18777. */
  18778. get includedOnlyMeshes(): AbstractMesh[];
  18779. /**
  18780. * Sets the only meshes impacted by this light.
  18781. */
  18782. set includedOnlyMeshes(value: AbstractMesh[]);
  18783. private _excludedMeshes;
  18784. /**
  18785. * Gets the meshes not impacted by this light.
  18786. */
  18787. get excludedMeshes(): AbstractMesh[];
  18788. /**
  18789. * Sets the meshes not impacted by this light.
  18790. */
  18791. set excludedMeshes(value: AbstractMesh[]);
  18792. private _excludeWithLayerMask;
  18793. /**
  18794. * Gets the layer id use to find what meshes are not impacted by the light.
  18795. * Inactive if 0
  18796. */
  18797. get excludeWithLayerMask(): number;
  18798. /**
  18799. * Sets the layer id use to find what meshes are not impacted by the light.
  18800. * Inactive if 0
  18801. */
  18802. set excludeWithLayerMask(value: number);
  18803. private _includeOnlyWithLayerMask;
  18804. /**
  18805. * Gets the layer id use to find what meshes are impacted by the light.
  18806. * Inactive if 0
  18807. */
  18808. get includeOnlyWithLayerMask(): number;
  18809. /**
  18810. * Sets the layer id use to find what meshes are impacted by the light.
  18811. * Inactive if 0
  18812. */
  18813. set includeOnlyWithLayerMask(value: number);
  18814. private _lightmapMode;
  18815. /**
  18816. * Gets the lightmap mode of this light (should be one of the constants defined by Light.LIGHTMAP_x)
  18817. */
  18818. get lightmapMode(): number;
  18819. /**
  18820. * Sets the lightmap mode of this light (should be one of the constants defined by Light.LIGHTMAP_x)
  18821. */
  18822. set lightmapMode(value: number);
  18823. /**
  18824. * Shadow generator associted to the light.
  18825. * @hidden Internal use only.
  18826. */
  18827. _shadowGenerator: Nullable<IShadowGenerator>;
  18828. /**
  18829. * @hidden Internal use only.
  18830. */
  18831. _excludedMeshesIds: string[];
  18832. /**
  18833. * @hidden Internal use only.
  18834. */
  18835. _includedOnlyMeshesIds: string[];
  18836. /**
  18837. * The current light unifom buffer.
  18838. * @hidden Internal use only.
  18839. */
  18840. _uniformBuffer: UniformBuffer;
  18841. /** @hidden */
  18842. _renderId: number;
  18843. /**
  18844. * Creates a Light object in the scene.
  18845. * Documentation : https://doc.babylonjs.com/babylon101/lights
  18846. * @param name The firendly name of the light
  18847. * @param scene The scene the light belongs too
  18848. */
  18849. constructor(name: string, scene: Scene);
  18850. protected abstract _buildUniformLayout(): void;
  18851. /**
  18852. * Sets the passed Effect "effect" with the Light information.
  18853. * @param effect The effect to update
  18854. * @param lightIndex The index of the light in the effect to update
  18855. * @returns The light
  18856. */
  18857. abstract transferToEffect(effect: Effect, lightIndex: string): Light;
  18858. /**
  18859. * Sets the passed Effect "effect" with the Light textures.
  18860. * @param effect The effect to update
  18861. * @param lightIndex The index of the light in the effect to update
  18862. * @returns The light
  18863. */
  18864. transferTexturesToEffect(effect: Effect, lightIndex: string): Light;
  18865. /**
  18866. * Binds the lights information from the scene to the effect for the given mesh.
  18867. * @param lightIndex Light index
  18868. * @param scene The scene where the light belongs to
  18869. * @param effect The effect we are binding the data to
  18870. * @param useSpecular Defines if specular is supported
  18871. * @param rebuildInParallel Specifies whether the shader is rebuilding in parallel
  18872. */
  18873. _bindLight(lightIndex: number, scene: Scene, effect: Effect, useSpecular: boolean, rebuildInParallel?: boolean): void;
  18874. /**
  18875. * Sets the passed Effect "effect" with the Light information.
  18876. * @param effect The effect to update
  18877. * @param lightDataUniformName The uniform used to store light data (position or direction)
  18878. * @returns The light
  18879. */
  18880. abstract transferToNodeMaterialEffect(effect: Effect, lightDataUniformName: string): Light;
  18881. /**
  18882. * Returns the string "Light".
  18883. * @returns the class name
  18884. */
  18885. getClassName(): string;
  18886. /** @hidden */
  18887. readonly _isLight: boolean;
  18888. /**
  18889. * Converts the light information to a readable string for debug purpose.
  18890. * @param fullDetails Supports for multiple levels of logging within scene loading
  18891. * @returns the human readable light info
  18892. */
  18893. toString(fullDetails?: boolean): string;
  18894. /** @hidden */
  18895. protected _syncParentEnabledState(): void;
  18896. /**
  18897. * Set the enabled state of this node.
  18898. * @param value - the new enabled state
  18899. */
  18900. setEnabled(value: boolean): void;
  18901. /**
  18902. * Returns the Light associated shadow generator if any.
  18903. * @return the associated shadow generator.
  18904. */
  18905. getShadowGenerator(): Nullable<IShadowGenerator>;
  18906. /**
  18907. * Returns a Vector3, the absolute light position in the World.
  18908. * @returns the world space position of the light
  18909. */
  18910. getAbsolutePosition(): Vector3;
  18911. /**
  18912. * Specifies if the light will affect the passed mesh.
  18913. * @param mesh The mesh to test against the light
  18914. * @return true the mesh is affected otherwise, false.
  18915. */
  18916. canAffectMesh(mesh: AbstractMesh): boolean;
  18917. /**
  18918. * Sort function to order lights for rendering.
  18919. * @param a First Light object to compare to second.
  18920. * @param b Second Light object to compare first.
  18921. * @return -1 to reduce's a's index relative to be, 0 for no change, 1 to increase a's index relative to b.
  18922. */
  18923. static CompareLightsPriority(a: Light, b: Light): number;
  18924. /**
  18925. * Releases resources associated with this node.
  18926. * @param doNotRecurse Set to true to not recurse into each children (recurse into each children by default)
  18927. * @param disposeMaterialAndTextures Set to true to also dispose referenced materials and textures (false by default)
  18928. */
  18929. dispose(doNotRecurse?: boolean, disposeMaterialAndTextures?: boolean): void;
  18930. /**
  18931. * Returns the light type ID (integer).
  18932. * @returns The light Type id as a constant defines in Light.LIGHTTYPEID_x
  18933. */
  18934. getTypeID(): number;
  18935. /**
  18936. * Returns the intensity scaled by the Photometric Scale according to the light type and intensity mode.
  18937. * @returns the scaled intensity in intensity mode unit
  18938. */
  18939. getScaledIntensity(): number;
  18940. /**
  18941. * Returns a new Light object, named "name", from the current one.
  18942. * @param name The name of the cloned light
  18943. * @param newParent The parent of this light, if it has one
  18944. * @returns the new created light
  18945. */
  18946. clone(name: string, newParent?: Nullable<Node>): Nullable<Light>;
  18947. /**
  18948. * Serializes the current light into a Serialization object.
  18949. * @returns the serialized object.
  18950. */
  18951. serialize(): any;
  18952. /**
  18953. * Creates a new typed light from the passed type (integer) : point light = 0, directional light = 1, spot light = 2, hemispheric light = 3.
  18954. * This new light is named "name" and added to the passed scene.
  18955. * @param type Type according to the types available in Light.LIGHTTYPEID_x
  18956. * @param name The friendly name of the light
  18957. * @param scene The scene the new light will belong to
  18958. * @returns the constructor function
  18959. */
  18960. static GetConstructorFromName(type: number, name: string, scene: Scene): Nullable<() => Light>;
  18961. /**
  18962. * Parses the passed "parsedLight" and returns a new instanced Light from this parsing.
  18963. * @param parsedLight The JSON representation of the light
  18964. * @param scene The scene to create the parsed light in
  18965. * @returns the created light after parsing
  18966. */
  18967. static Parse(parsedLight: any, scene: Scene): Nullable<Light>;
  18968. private _hookArrayForExcluded;
  18969. private _hookArrayForIncludedOnly;
  18970. private _resyncMeshes;
  18971. /**
  18972. * Forces the meshes to update their light related information in their rendering used effects
  18973. * @hidden Internal Use Only
  18974. */
  18975. _markMeshesAsLightDirty(): void;
  18976. /**
  18977. * Recomputes the cached photometric scale if needed.
  18978. */
  18979. private _computePhotometricScale;
  18980. /**
  18981. * Returns the Photometric Scale according to the light type and intensity mode.
  18982. */
  18983. private _getPhotometricScale;
  18984. /**
  18985. * Reorder the light in the scene according to their defined priority.
  18986. * @hidden Internal Use Only
  18987. */
  18988. _reorderLightsInScene(): void;
  18989. /**
  18990. * Prepares the list of defines specific to the light type.
  18991. * @param defines the list of defines
  18992. * @param lightIndex defines the index of the light for the effect
  18993. */
  18994. abstract prepareLightSpecificDefines(defines: any, lightIndex: number): void;
  18995. }
  18996. }
  18997. declare module "babylonjs/Materials/prePassConfiguration" {
  18998. import { Matrix } from "babylonjs/Maths/math.vector";
  18999. import { Mesh } from "babylonjs/Meshes/mesh";
  19000. import { Scene } from "babylonjs/scene";
  19001. import { Effect } from "babylonjs/Materials/effect";
  19002. /**
  19003. * Configuration needed for prepass-capable materials
  19004. */
  19005. export class PrePassConfiguration {
  19006. /**
  19007. * Previous world matrices of meshes carrying this material
  19008. * Used for computing velocity
  19009. */
  19010. previousWorldMatrices: {
  19011. [index: number]: Matrix;
  19012. };
  19013. /**
  19014. * Previous view project matrix
  19015. * Used for computing velocity
  19016. */
  19017. previousViewProjection: Matrix;
  19018. /**
  19019. * Previous bones of meshes carrying this material
  19020. * Used for computing velocity
  19021. */
  19022. previousBones: {
  19023. [index: number]: Float32Array;
  19024. };
  19025. /**
  19026. * Add the required uniforms to the current list.
  19027. * @param uniforms defines the current uniform list.
  19028. */
  19029. static AddUniforms(uniforms: string[]): void;
  19030. /**
  19031. * Add the required samplers to the current list.
  19032. * @param samplers defines the current sampler list.
  19033. */
  19034. static AddSamplers(samplers: string[]): void;
  19035. /**
  19036. * Binds the material data.
  19037. * @param effect defines the effect to update
  19038. * @param scene defines the scene the material belongs to.
  19039. * @param mesh The mesh
  19040. * @param world World matrix of this mesh
  19041. * @param isFrozen Is the material frozen
  19042. */
  19043. bindForSubMesh(effect: Effect, scene: Scene, mesh: Mesh, world: Matrix, isFrozen: boolean): void;
  19044. }
  19045. }
  19046. declare module "babylonjs/Cameras/targetCamera" {
  19047. import { Nullable } from "babylonjs/types";
  19048. import { Camera } from "babylonjs/Cameras/camera";
  19049. import { Scene } from "babylonjs/scene";
  19050. import { Quaternion, Matrix, Vector3, Vector2 } from "babylonjs/Maths/math.vector";
  19051. /**
  19052. * A target camera takes a mesh or position as a target and continues to look at it while it moves.
  19053. * This is the base of the follow, arc rotate cameras and Free camera
  19054. * @see https://doc.babylonjs.com/features/cameras
  19055. */
  19056. export class TargetCamera extends Camera {
  19057. private static _RigCamTransformMatrix;
  19058. private static _TargetTransformMatrix;
  19059. private static _TargetFocalPoint;
  19060. private _tmpUpVector;
  19061. private _tmpTargetVector;
  19062. /**
  19063. * Define the current direction the camera is moving to
  19064. */
  19065. cameraDirection: Vector3;
  19066. /**
  19067. * Define the current rotation the camera is rotating to
  19068. */
  19069. cameraRotation: Vector2;
  19070. /** Gets or sets a boolean indicating that the scaling of the parent hierarchy will not be taken in account by the camera */
  19071. ignoreParentScaling: boolean;
  19072. /**
  19073. * When set, the up vector of the camera will be updated by the rotation of the camera
  19074. */
  19075. updateUpVectorFromRotation: boolean;
  19076. private _tmpQuaternion;
  19077. /**
  19078. * Define the current rotation of the camera
  19079. */
  19080. rotation: Vector3;
  19081. /**
  19082. * Define the current rotation of the camera as a quaternion to prevent Gimbal lock
  19083. */
  19084. rotationQuaternion: Quaternion;
  19085. /**
  19086. * Define the current speed of the camera
  19087. */
  19088. speed: number;
  19089. /**
  19090. * Add constraint to the camera to prevent it to move freely in all directions and
  19091. * around all axis.
  19092. */
  19093. noRotationConstraint: boolean;
  19094. /**
  19095. * Reverses mouselook direction to 'natural' panning as opposed to traditional direct
  19096. * panning
  19097. */
  19098. invertRotation: boolean;
  19099. /**
  19100. * Speed multiplier for inverse camera panning
  19101. */
  19102. inverseRotationSpeed: number;
  19103. /**
  19104. * Define the current target of the camera as an object or a position.
  19105. */
  19106. lockedTarget: any;
  19107. /** @hidden */
  19108. _currentTarget: Vector3;
  19109. /** @hidden */
  19110. _initialFocalDistance: number;
  19111. /** @hidden */
  19112. _viewMatrix: Matrix;
  19113. /** @hidden */
  19114. _camMatrix: Matrix;
  19115. /** @hidden */
  19116. _cameraTransformMatrix: Matrix;
  19117. /** @hidden */
  19118. _cameraRotationMatrix: Matrix;
  19119. /** @hidden */
  19120. _referencePoint: Vector3;
  19121. /** @hidden */
  19122. _transformedReferencePoint: Vector3;
  19123. /** @hidden */
  19124. _reset: () => void;
  19125. private _defaultUp;
  19126. /**
  19127. * Instantiates a target camera that takes a mesh or position as a target and continues to look at it while it moves.
  19128. * This is the base of the follow, arc rotate cameras and Free camera
  19129. * @see https://doc.babylonjs.com/features/cameras
  19130. * @param name Defines the name of the camera in the scene
  19131. * @param position Defines the start position of the camera in the scene
  19132. * @param scene Defines the scene the camera belongs to
  19133. * @param setActiveOnSceneIfNoneActive Defines wheter the camera should be marked as active if not other active cameras have been defined
  19134. */
  19135. constructor(name: string, position: Vector3, scene: Scene, setActiveOnSceneIfNoneActive?: boolean);
  19136. /**
  19137. * Gets the position in front of the camera at a given distance.
  19138. * @param distance The distance from the camera we want the position to be
  19139. * @returns the position
  19140. */
  19141. getFrontPosition(distance: number): Vector3;
  19142. /** @hidden */
  19143. _getLockedTargetPosition(): Nullable<Vector3>;
  19144. private _storedPosition;
  19145. private _storedRotation;
  19146. private _storedRotationQuaternion;
  19147. /**
  19148. * Store current camera state of the camera (fov, position, rotation, etc..)
  19149. * @returns the camera
  19150. */
  19151. storeState(): Camera;
  19152. /**
  19153. * Restored camera state. You must call storeState() first
  19154. * @returns whether it was successful or not
  19155. * @hidden
  19156. */
  19157. _restoreStateValues(): boolean;
  19158. /** @hidden */
  19159. _initCache(): void;
  19160. /** @hidden */
  19161. _updateCache(ignoreParentClass?: boolean): void;
  19162. /** @hidden */
  19163. _isSynchronizedViewMatrix(): boolean;
  19164. /** @hidden */
  19165. _computeLocalCameraSpeed(): number;
  19166. /**
  19167. * Defines the target the camera should look at.
  19168. * @param target Defines the new target as a Vector or a mesh
  19169. */
  19170. setTarget(target: Vector3): void;
  19171. /**
  19172. * Defines the target point of the camera.
  19173. * The camera looks towards it form the radius distance.
  19174. */
  19175. get target(): Vector3;
  19176. set target(value: Vector3);
  19177. /**
  19178. * Return the current target position of the camera. This value is expressed in local space.
  19179. * @returns the target position
  19180. */
  19181. getTarget(): Vector3;
  19182. /** @hidden */
  19183. _decideIfNeedsToMove(): boolean;
  19184. /** @hidden */
  19185. _updatePosition(): void;
  19186. /** @hidden */
  19187. _checkInputs(): void;
  19188. protected _updateCameraRotationMatrix(): void;
  19189. /**
  19190. * 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)
  19191. * @returns the current camera
  19192. */
  19193. private _rotateUpVectorWithCameraRotationMatrix;
  19194. private _cachedRotationZ;
  19195. private _cachedQuaternionRotationZ;
  19196. /** @hidden */
  19197. _getViewMatrix(): Matrix;
  19198. protected _computeViewMatrix(position: Vector3, target: Vector3, up: Vector3): void;
  19199. /**
  19200. * @hidden
  19201. */
  19202. createRigCamera(name: string, cameraIndex: number): Nullable<Camera>;
  19203. /**
  19204. * @hidden
  19205. */
  19206. _updateRigCameras(): void;
  19207. private _getRigCamPositionAndTarget;
  19208. /**
  19209. * Gets the current object class name.
  19210. * @return the class name
  19211. */
  19212. getClassName(): string;
  19213. }
  19214. }
  19215. declare module "babylonjs/Events/keyboardEvents" {
  19216. /**
  19217. * Gather the list of keyboard event types as constants.
  19218. */
  19219. export class KeyboardEventTypes {
  19220. /**
  19221. * The keydown event is fired when a key becomes active (pressed).
  19222. */
  19223. static readonly KEYDOWN: number;
  19224. /**
  19225. * The keyup event is fired when a key has been released.
  19226. */
  19227. static readonly KEYUP: number;
  19228. }
  19229. /**
  19230. * This class is used to store keyboard related info for the onKeyboardObservable event.
  19231. */
  19232. export class KeyboardInfo {
  19233. /**
  19234. * Defines the type of event (KeyboardEventTypes)
  19235. */
  19236. type: number;
  19237. /**
  19238. * Defines the related dom event
  19239. */
  19240. event: KeyboardEvent;
  19241. /**
  19242. * Instantiates a new keyboard info.
  19243. * This class is used to store keyboard related info for the onKeyboardObservable event.
  19244. * @param type Defines the type of event (KeyboardEventTypes)
  19245. * @param event Defines the related dom event
  19246. */
  19247. constructor(
  19248. /**
  19249. * Defines the type of event (KeyboardEventTypes)
  19250. */
  19251. type: number,
  19252. /**
  19253. * Defines the related dom event
  19254. */
  19255. event: KeyboardEvent);
  19256. }
  19257. /**
  19258. * This class is used to store keyboard related info for the onPreKeyboardObservable event.
  19259. * Set the skipOnKeyboardObservable property to true if you want the engine to stop any process after this event is triggered, even not calling onKeyboardObservable
  19260. */
  19261. export class KeyboardInfoPre extends KeyboardInfo {
  19262. /**
  19263. * Defines the type of event (KeyboardEventTypes)
  19264. */
  19265. type: number;
  19266. /**
  19267. * Defines the related dom event
  19268. */
  19269. event: KeyboardEvent;
  19270. /**
  19271. * Defines whether the engine should skip the next onKeyboardObservable associated to this pre.
  19272. */
  19273. skipOnPointerObservable: boolean;
  19274. /**
  19275. * Instantiates a new keyboard pre info.
  19276. * This class is used to store keyboard related info for the onPreKeyboardObservable event.
  19277. * @param type Defines the type of event (KeyboardEventTypes)
  19278. * @param event Defines the related dom event
  19279. */
  19280. constructor(
  19281. /**
  19282. * Defines the type of event (KeyboardEventTypes)
  19283. */
  19284. type: number,
  19285. /**
  19286. * Defines the related dom event
  19287. */
  19288. event: KeyboardEvent);
  19289. }
  19290. }
  19291. declare module "babylonjs/Cameras/Inputs/freeCameraKeyboardMoveInput" {
  19292. import { Nullable } from "babylonjs/types";
  19293. import { ICameraInput } from "babylonjs/Cameras/cameraInputsManager";
  19294. import { FreeCamera } from "babylonjs/Cameras/freeCamera";
  19295. /**
  19296. * Manage the keyboard inputs to control the movement of a free camera.
  19297. * @see https://doc.babylonjs.com/how_to/customizing_camera_inputs
  19298. */
  19299. export class FreeCameraKeyboardMoveInput implements ICameraInput<FreeCamera> {
  19300. /**
  19301. * Defines the camera the input is attached to.
  19302. */
  19303. camera: FreeCamera;
  19304. /**
  19305. * Gets or Set the list of keyboard keys used to control the forward move of the camera.
  19306. */
  19307. keysUp: number[];
  19308. /**
  19309. * Gets or Set the list of keyboard keys used to control the upward move of the camera.
  19310. */
  19311. keysUpward: number[];
  19312. /**
  19313. * Gets or Set the list of keyboard keys used to control the backward move of the camera.
  19314. */
  19315. keysDown: number[];
  19316. /**
  19317. * Gets or Set the list of keyboard keys used to control the downward move of the camera.
  19318. */
  19319. keysDownward: number[];
  19320. /**
  19321. * Gets or Set the list of keyboard keys used to control the left strafe move of the camera.
  19322. */
  19323. keysLeft: number[];
  19324. /**
  19325. * Gets or Set the list of keyboard keys used to control the right strafe move of the camera.
  19326. */
  19327. keysRight: number[];
  19328. private _keys;
  19329. private _onCanvasBlurObserver;
  19330. private _onKeyboardObserver;
  19331. private _engine;
  19332. private _scene;
  19333. /**
  19334. * Attach the input controls to a specific dom element to get the input from.
  19335. * @param element Defines the element the controls should be listened from
  19336. * @param noPreventDefault Defines whether event caught by the controls should call preventdefault() (https://developer.mozilla.org/en-US/docs/Web/API/Event/preventDefault)
  19337. */
  19338. attachControl(element: HTMLElement, noPreventDefault?: boolean): void;
  19339. /**
  19340. * Detach the current controls from the specified dom element.
  19341. * @param element Defines the element to stop listening the inputs from
  19342. */
  19343. detachControl(element: Nullable<HTMLElement>): void;
  19344. /**
  19345. * Update the current camera state depending on the inputs that have been used this frame.
  19346. * This is a dynamically created lambda to avoid the performance penalty of looping for inputs in the render loop.
  19347. */
  19348. checkInputs(): void;
  19349. /**
  19350. * Gets the class name of the current intput.
  19351. * @returns the class name
  19352. */
  19353. getClassName(): string;
  19354. /** @hidden */
  19355. _onLostFocus(): void;
  19356. /**
  19357. * Get the friendly name associated with the input class.
  19358. * @returns the input friendly name
  19359. */
  19360. getSimpleName(): string;
  19361. }
  19362. }
  19363. declare module "babylonjs/Events/pointerEvents" {
  19364. import { Nullable } from "babylonjs/types";
  19365. import { Vector2 } from "babylonjs/Maths/math.vector";
  19366. import { PickingInfo } from "babylonjs/Collisions/pickingInfo";
  19367. import { Ray } from "babylonjs/Culling/ray";
  19368. /**
  19369. * Gather the list of pointer event types as constants.
  19370. */
  19371. export class PointerEventTypes {
  19372. /**
  19373. * 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.
  19374. */
  19375. static readonly POINTERDOWN: number;
  19376. /**
  19377. * The pointerup event is fired when a pointer is no longer active.
  19378. */
  19379. static readonly POINTERUP: number;
  19380. /**
  19381. * The pointermove event is fired when a pointer changes coordinates.
  19382. */
  19383. static readonly POINTERMOVE: number;
  19384. /**
  19385. * The pointerwheel event is fired when a mouse wheel has been rotated.
  19386. */
  19387. static readonly POINTERWHEEL: number;
  19388. /**
  19389. * The pointerpick event is fired when a mesh or sprite has been picked by the pointer.
  19390. */
  19391. static readonly POINTERPICK: number;
  19392. /**
  19393. * The pointertap event is fired when a the object has been touched and released without drag.
  19394. */
  19395. static readonly POINTERTAP: number;
  19396. /**
  19397. * The pointerdoubletap event is fired when a the object has been touched and released twice without drag.
  19398. */
  19399. static readonly POINTERDOUBLETAP: number;
  19400. }
  19401. /**
  19402. * Base class of pointer info types.
  19403. */
  19404. export class PointerInfoBase {
  19405. /**
  19406. * Defines the type of event (PointerEventTypes)
  19407. */
  19408. type: number;
  19409. /**
  19410. * Defines the related dom event
  19411. */
  19412. event: PointerEvent | MouseWheelEvent;
  19413. /**
  19414. * Instantiates the base class of pointers info.
  19415. * @param type Defines the type of event (PointerEventTypes)
  19416. * @param event Defines the related dom event
  19417. */
  19418. constructor(
  19419. /**
  19420. * Defines the type of event (PointerEventTypes)
  19421. */
  19422. type: number,
  19423. /**
  19424. * Defines the related dom event
  19425. */
  19426. event: PointerEvent | MouseWheelEvent);
  19427. }
  19428. /**
  19429. * This class is used to store pointer related info for the onPrePointerObservable event.
  19430. * Set the skipOnPointerObservable property to true if you want the engine to stop any process after this event is triggered, even not calling onPointerObservable
  19431. */
  19432. export class PointerInfoPre extends PointerInfoBase {
  19433. /**
  19434. * Ray from a pointer if availible (eg. 6dof controller)
  19435. */
  19436. ray: Nullable<Ray>;
  19437. /**
  19438. * Defines the local position of the pointer on the canvas.
  19439. */
  19440. localPosition: Vector2;
  19441. /**
  19442. * Defines whether the engine should skip the next OnPointerObservable associated to this pre.
  19443. */
  19444. skipOnPointerObservable: boolean;
  19445. /**
  19446. * Instantiates a PointerInfoPre to store pointer related info to the onPrePointerObservable event.
  19447. * @param type Defines the type of event (PointerEventTypes)
  19448. * @param event Defines the related dom event
  19449. * @param localX Defines the local x coordinates of the pointer when the event occured
  19450. * @param localY Defines the local y coordinates of the pointer when the event occured
  19451. */
  19452. constructor(type: number, event: PointerEvent | MouseWheelEvent, localX: number, localY: number);
  19453. }
  19454. /**
  19455. * This type contains all the data related to a pointer event in Babylon.js.
  19456. * 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.
  19457. */
  19458. export class PointerInfo extends PointerInfoBase {
  19459. /**
  19460. * Defines the picking info associated to the info (if any)\
  19461. */
  19462. pickInfo: Nullable<PickingInfo>;
  19463. /**
  19464. * Instantiates a PointerInfo to store pointer related info to the onPointerObservable event.
  19465. * @param type Defines the type of event (PointerEventTypes)
  19466. * @param event Defines the related dom event
  19467. * @param pickInfo Defines the picking info associated to the info (if any)\
  19468. */
  19469. constructor(type: number, event: PointerEvent | MouseWheelEvent,
  19470. /**
  19471. * Defines the picking info associated to the info (if any)\
  19472. */
  19473. pickInfo: Nullable<PickingInfo>);
  19474. }
  19475. /**
  19476. * Data relating to a touch event on the screen.
  19477. */
  19478. export interface PointerTouch {
  19479. /**
  19480. * X coordinate of touch.
  19481. */
  19482. x: number;
  19483. /**
  19484. * Y coordinate of touch.
  19485. */
  19486. y: number;
  19487. /**
  19488. * Id of touch. Unique for each finger.
  19489. */
  19490. pointerId: number;
  19491. /**
  19492. * Event type passed from DOM.
  19493. */
  19494. type: any;
  19495. }
  19496. }
  19497. declare module "babylonjs/Cameras/Inputs/freeCameraMouseInput" {
  19498. import { Observable } from "babylonjs/Misc/observable";
  19499. import { Nullable } from "babylonjs/types";
  19500. import { ICameraInput } from "babylonjs/Cameras/cameraInputsManager";
  19501. import { FreeCamera } from "babylonjs/Cameras/freeCamera";
  19502. /**
  19503. * Manage the mouse inputs to control the movement of a free camera.
  19504. * @see https://doc.babylonjs.com/how_to/customizing_camera_inputs
  19505. */
  19506. export class FreeCameraMouseInput implements ICameraInput<FreeCamera> {
  19507. /**
  19508. * Define if touch is enabled in the mouse input
  19509. */
  19510. touchEnabled: boolean;
  19511. /**
  19512. * Defines the camera the input is attached to.
  19513. */
  19514. camera: FreeCamera;
  19515. /**
  19516. * Defines the buttons associated with the input to handle camera move.
  19517. */
  19518. buttons: number[];
  19519. /**
  19520. * Defines the pointer angular sensibility along the X and Y axis or how fast is the camera rotating.
  19521. */
  19522. angularSensibility: number;
  19523. private _pointerInput;
  19524. private _onMouseMove;
  19525. private _observer;
  19526. private previousPosition;
  19527. /**
  19528. * Observable for when a pointer move event occurs containing the move offset
  19529. */
  19530. onPointerMovedObservable: Observable<{
  19531. offsetX: number;
  19532. offsetY: number;
  19533. }>;
  19534. /**
  19535. * @hidden
  19536. * If the camera should be rotated automatically based on pointer movement
  19537. */
  19538. _allowCameraRotation: boolean;
  19539. /**
  19540. * Manage the mouse inputs to control the movement of a free camera.
  19541. * @see https://doc.babylonjs.com/how_to/customizing_camera_inputs
  19542. * @param touchEnabled Defines if touch is enabled or not
  19543. */
  19544. constructor(
  19545. /**
  19546. * Define if touch is enabled in the mouse input
  19547. */
  19548. touchEnabled?: boolean);
  19549. /**
  19550. * Attach the input controls to a specific dom element to get the input from.
  19551. * @param element Defines the element the controls should be listened from
  19552. * @param noPreventDefault Defines whether event caught by the controls should call preventdefault() (https://developer.mozilla.org/en-US/docs/Web/API/Event/preventDefault)
  19553. */
  19554. attachControl(element: HTMLElement, noPreventDefault?: boolean): void;
  19555. /**
  19556. * Called on JS contextmenu event.
  19557. * Override this method to provide functionality.
  19558. */
  19559. protected onContextMenu(evt: PointerEvent): void;
  19560. /**
  19561. * Detach the current controls from the specified dom element.
  19562. * @param element Defines the element to stop listening the inputs from
  19563. */
  19564. detachControl(element: Nullable<HTMLElement>): void;
  19565. /**
  19566. * Gets the class name of the current intput.
  19567. * @returns the class name
  19568. */
  19569. getClassName(): string;
  19570. /**
  19571. * Get the friendly name associated with the input class.
  19572. * @returns the input friendly name
  19573. */
  19574. getSimpleName(): string;
  19575. }
  19576. }
  19577. declare module "babylonjs/Cameras/Inputs/freeCameraTouchInput" {
  19578. import { Nullable } from "babylonjs/types";
  19579. import { ICameraInput } from "babylonjs/Cameras/cameraInputsManager";
  19580. import { FreeCamera } from "babylonjs/Cameras/freeCamera";
  19581. /**
  19582. * Manage the touch inputs to control the movement of a free camera.
  19583. * @see https://doc.babylonjs.com/how_to/customizing_camera_inputs
  19584. */
  19585. export class FreeCameraTouchInput implements ICameraInput<FreeCamera> {
  19586. /**
  19587. * Define if mouse events can be treated as touch events
  19588. */
  19589. allowMouse: boolean;
  19590. /**
  19591. * Defines the camera the input is attached to.
  19592. */
  19593. camera: FreeCamera;
  19594. /**
  19595. * Defines the touch sensibility for rotation.
  19596. * The higher the faster.
  19597. */
  19598. touchAngularSensibility: number;
  19599. /**
  19600. * Defines the touch sensibility for move.
  19601. * The higher the faster.
  19602. */
  19603. touchMoveSensibility: number;
  19604. private _offsetX;
  19605. private _offsetY;
  19606. private _pointerPressed;
  19607. private _pointerInput;
  19608. private _observer;
  19609. private _onLostFocus;
  19610. /**
  19611. * Manage the touch inputs to control the movement of a free camera.
  19612. * @see https://doc.babylonjs.com/how_to/customizing_camera_inputs
  19613. * @param allowMouse Defines if mouse events can be treated as touch events
  19614. */
  19615. constructor(
  19616. /**
  19617. * Define if mouse events can be treated as touch events
  19618. */
  19619. allowMouse?: boolean);
  19620. /**
  19621. * Attach the input controls to a specific dom element to get the input from.
  19622. * @param element Defines the element the controls should be listened from
  19623. * @param noPreventDefault Defines whether event caught by the controls should call preventdefault() (https://developer.mozilla.org/en-US/docs/Web/API/Event/preventDefault)
  19624. */
  19625. attachControl(element: HTMLElement, noPreventDefault?: boolean): void;
  19626. /**
  19627. * Detach the current controls from the specified dom element.
  19628. * @param element Defines the element to stop listening the inputs from
  19629. */
  19630. detachControl(element: Nullable<HTMLElement>): void;
  19631. /**
  19632. * Update the current camera state depending on the inputs that have been used this frame.
  19633. * This is a dynamically created lambda to avoid the performance penalty of looping for inputs in the render loop.
  19634. */
  19635. checkInputs(): void;
  19636. /**
  19637. * Gets the class name of the current intput.
  19638. * @returns the class name
  19639. */
  19640. getClassName(): string;
  19641. /**
  19642. * Get the friendly name associated with the input class.
  19643. * @returns the input friendly name
  19644. */
  19645. getSimpleName(): string;
  19646. }
  19647. }
  19648. declare module "babylonjs/Cameras/freeCameraInputsManager" {
  19649. import { FreeCamera } from "babylonjs/Cameras/freeCamera";
  19650. import { CameraInputsManager } from "babylonjs/Cameras/cameraInputsManager";
  19651. import { FreeCameraMouseInput } from "babylonjs/Cameras/Inputs/freeCameraMouseInput";
  19652. import { Nullable } from "babylonjs/types";
  19653. /**
  19654. * Default Inputs manager for the FreeCamera.
  19655. * It groups all the default supported inputs for ease of use.
  19656. * @see https://doc.babylonjs.com/how_to/customizing_camera_inputs
  19657. */
  19658. export class FreeCameraInputsManager extends CameraInputsManager<FreeCamera> {
  19659. /**
  19660. * @hidden
  19661. */
  19662. _mouseInput: Nullable<FreeCameraMouseInput>;
  19663. /**
  19664. * Instantiates a new FreeCameraInputsManager.
  19665. * @param camera Defines the camera the inputs belong to
  19666. */
  19667. constructor(camera: FreeCamera);
  19668. /**
  19669. * Add keyboard input support to the input manager.
  19670. * @returns the current input manager
  19671. */
  19672. addKeyboard(): FreeCameraInputsManager;
  19673. /**
  19674. * Add mouse input support to the input manager.
  19675. * @param touchEnabled if the FreeCameraMouseInput should support touch (default: true)
  19676. * @returns the current input manager
  19677. */
  19678. addMouse(touchEnabled?: boolean): FreeCameraInputsManager;
  19679. /**
  19680. * Removes the mouse input support from the manager
  19681. * @returns the current input manager
  19682. */
  19683. removeMouse(): FreeCameraInputsManager;
  19684. /**
  19685. * Add touch input support to the input manager.
  19686. * @returns the current input manager
  19687. */
  19688. addTouch(): FreeCameraInputsManager;
  19689. /**
  19690. * Remove all attached input methods from a camera
  19691. */
  19692. clear(): void;
  19693. }
  19694. }
  19695. declare module "babylonjs/Cameras/freeCamera" {
  19696. import { Vector3 } from "babylonjs/Maths/math.vector";
  19697. import { AbstractMesh } from "babylonjs/Meshes/abstractMesh";
  19698. import { Scene } from "babylonjs/scene";
  19699. import { TargetCamera } from "babylonjs/Cameras/targetCamera";
  19700. import { FreeCameraInputsManager } from "babylonjs/Cameras/freeCameraInputsManager";
  19701. /**
  19702. * This represents a free type of camera. It can be useful in First Person Shooter game for instance.
  19703. * Please consider using the new UniversalCamera instead as it adds more functionality like the gamepad.
  19704. * @see https://doc.babylonjs.com/features/cameras#universal-camera
  19705. */
  19706. export class FreeCamera extends TargetCamera {
  19707. /**
  19708. * Define the collision ellipsoid of the camera.
  19709. * This is helpful to simulate a camera body like the player body around the camera
  19710. * @see https://doc.babylonjs.com/babylon101/cameras,_mesh_collisions_and_gravity#arcrotatecamera
  19711. */
  19712. ellipsoid: Vector3;
  19713. /**
  19714. * Define an offset for the position of the ellipsoid around the camera.
  19715. * This can be helpful to determine the center of the body near the gravity center of the body
  19716. * instead of its head.
  19717. */
  19718. ellipsoidOffset: Vector3;
  19719. /**
  19720. * Enable or disable collisions of the camera with the rest of the scene objects.
  19721. */
  19722. checkCollisions: boolean;
  19723. /**
  19724. * Enable or disable gravity on the camera.
  19725. */
  19726. applyGravity: boolean;
  19727. /**
  19728. * Define the input manager associated to the camera.
  19729. */
  19730. inputs: FreeCameraInputsManager;
  19731. /**
  19732. * Gets the input sensibility for a mouse input. (default is 2000.0)
  19733. * Higher values reduce sensitivity.
  19734. */
  19735. get angularSensibility(): number;
  19736. /**
  19737. * Sets the input sensibility for a mouse input. (default is 2000.0)
  19738. * Higher values reduce sensitivity.
  19739. */
  19740. set angularSensibility(value: number);
  19741. /**
  19742. * Gets or Set the list of keyboard keys used to control the forward move of the camera.
  19743. */
  19744. get keysUp(): number[];
  19745. set keysUp(value: number[]);
  19746. /**
  19747. * Gets or Set the list of keyboard keys used to control the upward move of the camera.
  19748. */
  19749. get keysUpward(): number[];
  19750. set keysUpward(value: number[]);
  19751. /**
  19752. * Gets or Set the list of keyboard keys used to control the backward move of the camera.
  19753. */
  19754. get keysDown(): number[];
  19755. set keysDown(value: number[]);
  19756. /**
  19757. * Gets or Set the list of keyboard keys used to control the downward move of the camera.
  19758. */
  19759. get keysDownward(): number[];
  19760. set keysDownward(value: number[]);
  19761. /**
  19762. * Gets or Set the list of keyboard keys used to control the left strafe move of the camera.
  19763. */
  19764. get keysLeft(): number[];
  19765. set keysLeft(value: number[]);
  19766. /**
  19767. * Gets or Set the list of keyboard keys used to control the right strafe move of the camera.
  19768. */
  19769. get keysRight(): number[];
  19770. set keysRight(value: number[]);
  19771. /**
  19772. * Event raised when the camera collide with a mesh in the scene.
  19773. */
  19774. onCollide: (collidedMesh: AbstractMesh) => void;
  19775. private _collider;
  19776. private _needMoveForGravity;
  19777. private _oldPosition;
  19778. private _diffPosition;
  19779. private _newPosition;
  19780. /** @hidden */
  19781. _localDirection: Vector3;
  19782. /** @hidden */
  19783. _transformedDirection: Vector3;
  19784. /**
  19785. * Instantiates a Free Camera.
  19786. * This represents a free type of camera. It can be useful in First Person Shooter game for instance.
  19787. * Please consider using the new UniversalCamera instead as it adds more functionality like touch to this camera.
  19788. * @see https://doc.babylonjs.com/features/cameras#universal-camera
  19789. * @param name Define the name of the camera in the scene
  19790. * @param position Define the start position of the camera in the scene
  19791. * @param scene Define the scene the camera belongs to
  19792. * @param setActiveOnSceneIfNoneActive Defines wheter the camera should be marked as active if not other active cameras have been defined
  19793. */
  19794. constructor(name: string, position: Vector3, scene: Scene, setActiveOnSceneIfNoneActive?: boolean);
  19795. /**
  19796. * Attached controls to the current camera.
  19797. * @param element Defines the element the controls should be listened from
  19798. * @param noPreventDefault Defines whether event caught by the controls should call preventdefault() (https://developer.mozilla.org/en-US/docs/Web/API/Event/preventDefault)
  19799. */
  19800. attachControl(element: HTMLElement, noPreventDefault?: boolean): void;
  19801. /**
  19802. * Detach the current controls from the camera.
  19803. * The camera will stop reacting to inputs.
  19804. * @param element Defines the element to stop listening the inputs from
  19805. */
  19806. detachControl(element: HTMLElement): void;
  19807. private _collisionMask;
  19808. /**
  19809. * Define a collision mask to limit the list of object the camera can collide with
  19810. */
  19811. get collisionMask(): number;
  19812. set collisionMask(mask: number);
  19813. /** @hidden */
  19814. _collideWithWorld(displacement: Vector3): void;
  19815. private _onCollisionPositionChange;
  19816. /** @hidden */
  19817. _checkInputs(): void;
  19818. /** @hidden */
  19819. _decideIfNeedsToMove(): boolean;
  19820. /** @hidden */
  19821. _updatePosition(): void;
  19822. /**
  19823. * Destroy the camera and release the current resources hold by it.
  19824. */
  19825. dispose(): void;
  19826. /**
  19827. * Gets the current object class name.
  19828. * @return the class name
  19829. */
  19830. getClassName(): string;
  19831. }
  19832. }
  19833. declare module "babylonjs/Gamepads/gamepad" {
  19834. import { Observable } from "babylonjs/Misc/observable";
  19835. /**
  19836. * Represents a gamepad control stick position
  19837. */
  19838. export class StickValues {
  19839. /**
  19840. * The x component of the control stick
  19841. */
  19842. x: number;
  19843. /**
  19844. * The y component of the control stick
  19845. */
  19846. y: number;
  19847. /**
  19848. * Initializes the gamepad x and y control stick values
  19849. * @param x The x component of the gamepad control stick value
  19850. * @param y The y component of the gamepad control stick value
  19851. */
  19852. constructor(
  19853. /**
  19854. * The x component of the control stick
  19855. */
  19856. x: number,
  19857. /**
  19858. * The y component of the control stick
  19859. */
  19860. y: number);
  19861. }
  19862. /**
  19863. * An interface which manages callbacks for gamepad button changes
  19864. */
  19865. export interface GamepadButtonChanges {
  19866. /**
  19867. * Called when a gamepad has been changed
  19868. */
  19869. changed: boolean;
  19870. /**
  19871. * Called when a gamepad press event has been triggered
  19872. */
  19873. pressChanged: boolean;
  19874. /**
  19875. * Called when a touch event has been triggered
  19876. */
  19877. touchChanged: boolean;
  19878. /**
  19879. * Called when a value has changed
  19880. */
  19881. valueChanged: boolean;
  19882. }
  19883. /**
  19884. * Represents a gamepad
  19885. */
  19886. export class Gamepad {
  19887. /**
  19888. * The id of the gamepad
  19889. */
  19890. id: string;
  19891. /**
  19892. * The index of the gamepad
  19893. */
  19894. index: number;
  19895. /**
  19896. * The browser gamepad
  19897. */
  19898. browserGamepad: any;
  19899. /**
  19900. * Specifies what type of gamepad this represents
  19901. */
  19902. type: number;
  19903. private _leftStick;
  19904. private _rightStick;
  19905. /** @hidden */
  19906. _isConnected: boolean;
  19907. private _leftStickAxisX;
  19908. private _leftStickAxisY;
  19909. private _rightStickAxisX;
  19910. private _rightStickAxisY;
  19911. /**
  19912. * Triggered when the left control stick has been changed
  19913. */
  19914. private _onleftstickchanged;
  19915. /**
  19916. * Triggered when the right control stick has been changed
  19917. */
  19918. private _onrightstickchanged;
  19919. /**
  19920. * Represents a gamepad controller
  19921. */
  19922. static GAMEPAD: number;
  19923. /**
  19924. * Represents a generic controller
  19925. */
  19926. static GENERIC: number;
  19927. /**
  19928. * Represents an XBox controller
  19929. */
  19930. static XBOX: number;
  19931. /**
  19932. * Represents a pose-enabled controller
  19933. */
  19934. static POSE_ENABLED: number;
  19935. /**
  19936. * Represents an Dual Shock controller
  19937. */
  19938. static DUALSHOCK: number;
  19939. /**
  19940. * Specifies whether the left control stick should be Y-inverted
  19941. */
  19942. protected _invertLeftStickY: boolean;
  19943. /**
  19944. * Specifies if the gamepad has been connected
  19945. */
  19946. get isConnected(): boolean;
  19947. /**
  19948. * Initializes the gamepad
  19949. * @param id The id of the gamepad
  19950. * @param index The index of the gamepad
  19951. * @param browserGamepad The browser gamepad
  19952. * @param leftStickX The x component of the left joystick
  19953. * @param leftStickY The y component of the left joystick
  19954. * @param rightStickX The x component of the right joystick
  19955. * @param rightStickY The y component of the right joystick
  19956. */
  19957. constructor(
  19958. /**
  19959. * The id of the gamepad
  19960. */
  19961. id: string,
  19962. /**
  19963. * The index of the gamepad
  19964. */
  19965. index: number,
  19966. /**
  19967. * The browser gamepad
  19968. */
  19969. browserGamepad: any, leftStickX?: number, leftStickY?: number, rightStickX?: number, rightStickY?: number);
  19970. /**
  19971. * Callback triggered when the left joystick has changed
  19972. * @param callback
  19973. */
  19974. onleftstickchanged(callback: (values: StickValues) => void): void;
  19975. /**
  19976. * Callback triggered when the right joystick has changed
  19977. * @param callback
  19978. */
  19979. onrightstickchanged(callback: (values: StickValues) => void): void;
  19980. /**
  19981. * Gets the left joystick
  19982. */
  19983. get leftStick(): StickValues;
  19984. /**
  19985. * Sets the left joystick values
  19986. */
  19987. set leftStick(newValues: StickValues);
  19988. /**
  19989. * Gets the right joystick
  19990. */
  19991. get rightStick(): StickValues;
  19992. /**
  19993. * Sets the right joystick value
  19994. */
  19995. set rightStick(newValues: StickValues);
  19996. /**
  19997. * Updates the gamepad joystick positions
  19998. */
  19999. update(): void;
  20000. /**
  20001. * Disposes the gamepad
  20002. */
  20003. dispose(): void;
  20004. }
  20005. /**
  20006. * Represents a generic gamepad
  20007. */
  20008. export class GenericPad extends Gamepad {
  20009. private _buttons;
  20010. private _onbuttondown;
  20011. private _onbuttonup;
  20012. /**
  20013. * Observable triggered when a button has been pressed
  20014. */
  20015. onButtonDownObservable: Observable<number>;
  20016. /**
  20017. * Observable triggered when a button has been released
  20018. */
  20019. onButtonUpObservable: Observable<number>;
  20020. /**
  20021. * Callback triggered when a button has been pressed
  20022. * @param callback Called when a button has been pressed
  20023. */
  20024. onbuttondown(callback: (buttonPressed: number) => void): void;
  20025. /**
  20026. * Callback triggered when a button has been released
  20027. * @param callback Called when a button has been released
  20028. */
  20029. onbuttonup(callback: (buttonReleased: number) => void): void;
  20030. /**
  20031. * Initializes the generic gamepad
  20032. * @param id The id of the generic gamepad
  20033. * @param index The index of the generic gamepad
  20034. * @param browserGamepad The browser gamepad
  20035. */
  20036. constructor(id: string, index: number, browserGamepad: any);
  20037. private _setButtonValue;
  20038. /**
  20039. * Updates the generic gamepad
  20040. */
  20041. update(): void;
  20042. /**
  20043. * Disposes the generic gamepad
  20044. */
  20045. dispose(): void;
  20046. }
  20047. }
  20048. declare module "babylonjs/Gamepads/Controllers/poseEnabledController" {
  20049. import { Observable } from "babylonjs/Misc/observable";
  20050. import { Nullable } from "babylonjs/types";
  20051. import { Quaternion, Matrix, Vector3 } from "babylonjs/Maths/math.vector";
  20052. import { TransformNode } from "babylonjs/Meshes/transformNode";
  20053. import { AbstractMesh } from "babylonjs/Meshes/abstractMesh";
  20054. import { Ray } from "babylonjs/Culling/ray";
  20055. import { Gamepad } from "babylonjs/Gamepads/gamepad";
  20056. import { PoseControlled, DevicePose } from "babylonjs/Cameras/VR/webVRCamera";
  20057. import { TargetCamera } from "babylonjs/Cameras/targetCamera";
  20058. /**
  20059. * Defines the types of pose enabled controllers that are supported
  20060. */
  20061. export enum PoseEnabledControllerType {
  20062. /**
  20063. * HTC Vive
  20064. */
  20065. VIVE = 0,
  20066. /**
  20067. * Oculus Rift
  20068. */
  20069. OCULUS = 1,
  20070. /**
  20071. * Windows mixed reality
  20072. */
  20073. WINDOWS = 2,
  20074. /**
  20075. * Samsung gear VR
  20076. */
  20077. GEAR_VR = 3,
  20078. /**
  20079. * Google Daydream
  20080. */
  20081. DAYDREAM = 4,
  20082. /**
  20083. * Generic
  20084. */
  20085. GENERIC = 5
  20086. }
  20087. /**
  20088. * Defines the MutableGamepadButton interface for the state of a gamepad button
  20089. */
  20090. export interface MutableGamepadButton {
  20091. /**
  20092. * Value of the button/trigger
  20093. */
  20094. value: number;
  20095. /**
  20096. * If the button/trigger is currently touched
  20097. */
  20098. touched: boolean;
  20099. /**
  20100. * If the button/trigger is currently pressed
  20101. */
  20102. pressed: boolean;
  20103. }
  20104. /**
  20105. * Defines the ExtendedGamepadButton interface for a gamepad button which includes state provided by a pose controller
  20106. * @hidden
  20107. */
  20108. export interface ExtendedGamepadButton extends GamepadButton {
  20109. /**
  20110. * If the button/trigger is currently pressed
  20111. */
  20112. readonly pressed: boolean;
  20113. /**
  20114. * If the button/trigger is currently touched
  20115. */
  20116. readonly touched: boolean;
  20117. /**
  20118. * Value of the button/trigger
  20119. */
  20120. readonly value: number;
  20121. }
  20122. /** @hidden */
  20123. export interface _GamePadFactory {
  20124. /**
  20125. * Returns whether or not the current gamepad can be created for this type of controller.
  20126. * @param gamepadInfo Defines the gamepad info as received from the controller APIs.
  20127. * @returns true if it can be created, otherwise false
  20128. */
  20129. canCreate(gamepadInfo: any): boolean;
  20130. /**
  20131. * Creates a new instance of the Gamepad.
  20132. * @param gamepadInfo Defines the gamepad info as received from the controller APIs.
  20133. * @returns the new gamepad instance
  20134. */
  20135. create(gamepadInfo: any): Gamepad;
  20136. }
  20137. /**
  20138. * Defines the PoseEnabledControllerHelper object that is used initialize a gamepad as the controller type it is specified as (eg. windows mixed reality controller)
  20139. */
  20140. export class PoseEnabledControllerHelper {
  20141. /** @hidden */
  20142. static _ControllerFactories: _GamePadFactory[];
  20143. /** @hidden */
  20144. static _DefaultControllerFactory: Nullable<(gamepadInfo: any) => Gamepad>;
  20145. /**
  20146. * Initializes a gamepad as the controller type it is specified as (eg. windows mixed reality controller)
  20147. * @param vrGamepad the gamepad to initialized
  20148. * @returns a vr controller of the type the gamepad identified as
  20149. */
  20150. static InitiateController(vrGamepad: any): Gamepad;
  20151. }
  20152. /**
  20153. * Defines the PoseEnabledController object that contains state of a vr capable controller
  20154. */
  20155. export class PoseEnabledController extends Gamepad implements PoseControlled {
  20156. /**
  20157. * If the controller is used in a webXR session
  20158. */
  20159. isXR: boolean;
  20160. private _deviceRoomPosition;
  20161. private _deviceRoomRotationQuaternion;
  20162. /**
  20163. * The device position in babylon space
  20164. */
  20165. devicePosition: Vector3;
  20166. /**
  20167. * The device rotation in babylon space
  20168. */
  20169. deviceRotationQuaternion: Quaternion;
  20170. /**
  20171. * The scale factor of the device in babylon space
  20172. */
  20173. deviceScaleFactor: number;
  20174. /**
  20175. * (Likely devicePosition should be used instead) The device position in its room space
  20176. */
  20177. position: Vector3;
  20178. /**
  20179. * (Likely deviceRotationQuaternion should be used instead) The device rotation in its room space
  20180. */
  20181. rotationQuaternion: Quaternion;
  20182. /**
  20183. * The type of controller (Eg. Windows mixed reality)
  20184. */
  20185. controllerType: PoseEnabledControllerType;
  20186. protected _calculatedPosition: Vector3;
  20187. private _calculatedRotation;
  20188. /**
  20189. * The raw pose from the device
  20190. */
  20191. rawPose: DevicePose;
  20192. private _trackPosition;
  20193. private _maxRotationDistFromHeadset;
  20194. private _draggedRoomRotation;
  20195. /**
  20196. * @hidden
  20197. */
  20198. _disableTrackPosition(fixedPosition: Vector3): void;
  20199. /**
  20200. * Internal, the mesh attached to the controller
  20201. * @hidden
  20202. */
  20203. _mesh: Nullable<AbstractMesh>;
  20204. private _poseControlledCamera;
  20205. private _leftHandSystemQuaternion;
  20206. /**
  20207. * Internal, matrix used to convert room space to babylon space
  20208. * @hidden
  20209. */
  20210. _deviceToWorld: Matrix;
  20211. /**
  20212. * Node to be used when casting a ray from the controller
  20213. * @hidden
  20214. */
  20215. _pointingPoseNode: Nullable<TransformNode>;
  20216. /**
  20217. * Name of the child mesh that can be used to cast a ray from the controller
  20218. */
  20219. static readonly POINTING_POSE: string;
  20220. /**
  20221. * Creates a new PoseEnabledController from a gamepad
  20222. * @param browserGamepad the gamepad that the PoseEnabledController should be created from
  20223. */
  20224. constructor(browserGamepad: any);
  20225. private _workingMatrix;
  20226. /**
  20227. * Updates the state of the pose enbaled controller and mesh based on the current position and rotation of the controller
  20228. */
  20229. update(): void;
  20230. /**
  20231. * Updates only the pose device and mesh without doing any button event checking
  20232. */
  20233. protected _updatePoseAndMesh(): void;
  20234. /**
  20235. * Updates the state of the pose enbaled controller based on the raw pose data from the device
  20236. * @param poseData raw pose fromthe device
  20237. */
  20238. updateFromDevice(poseData: DevicePose): void;
  20239. /**
  20240. * @hidden
  20241. */
  20242. _meshAttachedObservable: Observable<AbstractMesh>;
  20243. /**
  20244. * Attaches a mesh to the controller
  20245. * @param mesh the mesh to be attached
  20246. */
  20247. attachToMesh(mesh: AbstractMesh): void;
  20248. /**
  20249. * Attaches the controllers mesh to a camera
  20250. * @param camera the camera the mesh should be attached to
  20251. */
  20252. attachToPoseControlledCamera(camera: TargetCamera): void;
  20253. /**
  20254. * Disposes of the controller
  20255. */
  20256. dispose(): void;
  20257. /**
  20258. * The mesh that is attached to the controller
  20259. */
  20260. get mesh(): Nullable<AbstractMesh>;
  20261. /**
  20262. * Gets the ray of the controller in the direction the controller is pointing
  20263. * @param length the length the resulting ray should be
  20264. * @returns a ray in the direction the controller is pointing
  20265. */
  20266. getForwardRay(length?: number): Ray;
  20267. }
  20268. }
  20269. declare module "babylonjs/Gamepads/Controllers/webVRController" {
  20270. import { Observable } from "babylonjs/Misc/observable";
  20271. import { Scene } from "babylonjs/scene";
  20272. import { AbstractMesh } from "babylonjs/Meshes/abstractMesh";
  20273. import { PoseEnabledController, ExtendedGamepadButton, MutableGamepadButton } from "babylonjs/Gamepads/Controllers/poseEnabledController";
  20274. import { StickValues, GamepadButtonChanges } from "babylonjs/Gamepads/gamepad";
  20275. import { Nullable } from "babylonjs/types";
  20276. /**
  20277. * Defines the WebVRController object that represents controllers tracked in 3D space
  20278. */
  20279. export abstract class WebVRController extends PoseEnabledController {
  20280. /**
  20281. * Internal, the default controller model for the controller
  20282. */
  20283. protected _defaultModel: Nullable<AbstractMesh>;
  20284. /**
  20285. * Fired when the trigger state has changed
  20286. */
  20287. onTriggerStateChangedObservable: Observable<ExtendedGamepadButton>;
  20288. /**
  20289. * Fired when the main button state has changed
  20290. */
  20291. onMainButtonStateChangedObservable: Observable<ExtendedGamepadButton>;
  20292. /**
  20293. * Fired when the secondary button state has changed
  20294. */
  20295. onSecondaryButtonStateChangedObservable: Observable<ExtendedGamepadButton>;
  20296. /**
  20297. * Fired when the pad state has changed
  20298. */
  20299. onPadStateChangedObservable: Observable<ExtendedGamepadButton>;
  20300. /**
  20301. * Fired when controllers stick values have changed
  20302. */
  20303. onPadValuesChangedObservable: Observable<StickValues>;
  20304. /**
  20305. * Array of button availible on the controller
  20306. */
  20307. protected _buttons: Array<MutableGamepadButton>;
  20308. private _onButtonStateChange;
  20309. /**
  20310. * Fired when a controller button's state has changed
  20311. * @param callback the callback containing the button that was modified
  20312. */
  20313. onButtonStateChange(callback: (controlledIndex: number, buttonIndex: number, state: ExtendedGamepadButton) => void): void;
  20314. /**
  20315. * X and Y axis corresponding to the controllers joystick
  20316. */
  20317. pad: StickValues;
  20318. /**
  20319. * 'left' or 'right', see https://w3c.github.io/gamepad/extensions.html#gamepadhand-enum
  20320. */
  20321. hand: string;
  20322. /**
  20323. * The default controller model for the controller
  20324. */
  20325. get defaultModel(): Nullable<AbstractMesh>;
  20326. /**
  20327. * Creates a new WebVRController from a gamepad
  20328. * @param vrGamepad the gamepad that the WebVRController should be created from
  20329. */
  20330. constructor(vrGamepad: any);
  20331. /**
  20332. * Updates the state of the controller and mesh based on the current position and rotation of the controller
  20333. */
  20334. update(): void;
  20335. /**
  20336. * Function to be called when a button is modified
  20337. */
  20338. protected abstract _handleButtonChange(buttonIdx: number, value: ExtendedGamepadButton, changes: GamepadButtonChanges): void;
  20339. /**
  20340. * Loads a mesh and attaches it to the controller
  20341. * @param scene the scene the mesh should be added to
  20342. * @param meshLoaded callback for when the mesh has been loaded
  20343. */
  20344. abstract initControllerMesh(scene: Scene, meshLoaded?: (mesh: AbstractMesh) => void): void;
  20345. private _setButtonValue;
  20346. private _changes;
  20347. private _checkChanges;
  20348. /**
  20349. * Disposes of th webVRCOntroller
  20350. */
  20351. dispose(): void;
  20352. }
  20353. }
  20354. declare module "babylonjs/Lights/hemisphericLight" {
  20355. import { Nullable } from "babylonjs/types";
  20356. import { Scene } from "babylonjs/scene";
  20357. import { Matrix, Vector3 } from "babylonjs/Maths/math.vector";
  20358. import { Color3 } from "babylonjs/Maths/math.color";
  20359. import { Effect } from "babylonjs/Materials/effect";
  20360. import { Light } from "babylonjs/Lights/light";
  20361. import { IShadowGenerator } from "babylonjs/Lights/Shadows/shadowGenerator";
  20362. /**
  20363. * The HemisphericLight simulates the ambient environment light,
  20364. * so the passed direction is the light reflection direction, not the incoming direction.
  20365. */
  20366. export class HemisphericLight extends Light {
  20367. /**
  20368. * The groundColor is the light in the opposite direction to the one specified during creation.
  20369. * 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.
  20370. */
  20371. groundColor: Color3;
  20372. /**
  20373. * The light reflection direction, not the incoming direction.
  20374. */
  20375. direction: Vector3;
  20376. /**
  20377. * Creates a HemisphericLight object in the scene according to the passed direction (Vector3).
  20378. * The HemisphericLight simulates the ambient environment light, so the passed direction is the light reflection direction, not the incoming direction.
  20379. * The HemisphericLight can't cast shadows.
  20380. * Documentation : https://doc.babylonjs.com/babylon101/lights
  20381. * @param name The friendly name of the light
  20382. * @param direction The direction of the light reflection
  20383. * @param scene The scene the light belongs to
  20384. */
  20385. constructor(name: string, direction: Vector3, scene: Scene);
  20386. protected _buildUniformLayout(): void;
  20387. /**
  20388. * Returns the string "HemisphericLight".
  20389. * @return The class name
  20390. */
  20391. getClassName(): string;
  20392. /**
  20393. * Sets the HemisphericLight direction towards the passed target (Vector3).
  20394. * Returns the updated direction.
  20395. * @param target The target the direction should point to
  20396. * @return The computed direction
  20397. */
  20398. setDirectionToTarget(target: Vector3): Vector3;
  20399. /**
  20400. * Returns the shadow generator associated to the light.
  20401. * @returns Always null for hemispheric lights because it does not support shadows.
  20402. */
  20403. getShadowGenerator(): Nullable<IShadowGenerator>;
  20404. /**
  20405. * Sets the passed Effect object with the HemisphericLight normalized direction and color and the passed name (string).
  20406. * @param effect The effect to update
  20407. * @param lightIndex The index of the light in the effect to update
  20408. * @returns The hemispheric light
  20409. */
  20410. transferToEffect(effect: Effect, lightIndex: string): HemisphericLight;
  20411. transferToNodeMaterialEffect(effect: Effect, lightDataUniformName: string): this;
  20412. /**
  20413. * Computes the world matrix of the node
  20414. * @param force defines if the cache version should be invalidated forcing the world matrix to be created from scratch
  20415. * @param useWasUpdatedFlag defines a reserved property
  20416. * @returns the world matrix
  20417. */
  20418. computeWorldMatrix(): Matrix;
  20419. /**
  20420. * Returns the integer 3.
  20421. * @return The light Type id as a constant defines in Light.LIGHTTYPEID_x
  20422. */
  20423. getTypeID(): number;
  20424. /**
  20425. * Prepares the list of defines specific to the light type.
  20426. * @param defines the list of defines
  20427. * @param lightIndex defines the index of the light for the effect
  20428. */
  20429. prepareLightSpecificDefines(defines: any, lightIndex: number): void;
  20430. }
  20431. }
  20432. declare module "babylonjs/Shaders/vrMultiviewToSingleview.fragment" {
  20433. /** @hidden */
  20434. export var vrMultiviewToSingleviewPixelShader: {
  20435. name: string;
  20436. shader: string;
  20437. };
  20438. }
  20439. declare module "babylonjs/Materials/Textures/MultiviewRenderTarget" {
  20440. import { RenderTargetTexture } from "babylonjs/Materials/Textures/renderTargetTexture";
  20441. import { Scene } from "babylonjs/scene";
  20442. /**
  20443. * Renders to multiple views with a single draw call
  20444. * @see https://www.khronos.org/registry/webgl/extensions/WEBGL_multiview/
  20445. */
  20446. export class MultiviewRenderTarget extends RenderTargetTexture {
  20447. /**
  20448. * Creates a multiview render target
  20449. * @param scene scene used with the render target
  20450. * @param size the size of the render target (used for each view)
  20451. */
  20452. constructor(scene: Scene, size?: number | {
  20453. width: number;
  20454. height: number;
  20455. } | {
  20456. ratio: number;
  20457. });
  20458. /**
  20459. * @hidden
  20460. * @param faceIndex the face index, if its a cube texture
  20461. */
  20462. _bindFrameBuffer(faceIndex?: number): void;
  20463. /**
  20464. * Gets the number of views the corresponding to the texture (eg. a MultiviewRenderTarget will have > 1)
  20465. * @returns the view count
  20466. */
  20467. getViewCount(): number;
  20468. }
  20469. }
  20470. declare module "babylonjs/Engines/Extensions/engine.multiview" {
  20471. import { Camera } from "babylonjs/Cameras/camera";
  20472. import { InternalTexture } from "babylonjs/Materials/Textures/internalTexture";
  20473. import { Nullable } from "babylonjs/types";
  20474. import { RenderTargetTexture } from "babylonjs/Materials/Textures/renderTargetTexture";
  20475. import { Matrix } from "babylonjs/Maths/math.vector";
  20476. import { UniformBuffer } from "babylonjs/Materials/uniformBuffer";
  20477. module "babylonjs/Engines/engine" {
  20478. interface Engine {
  20479. /**
  20480. * Creates a new multiview render target
  20481. * @param width defines the width of the texture
  20482. * @param height defines the height of the texture
  20483. * @returns the created multiview texture
  20484. */
  20485. createMultiviewRenderTargetTexture(width: number, height: number): InternalTexture;
  20486. /**
  20487. * Binds a multiview framebuffer to be drawn to
  20488. * @param multiviewTexture texture to bind
  20489. */
  20490. bindMultiviewFramebuffer(multiviewTexture: InternalTexture): void;
  20491. }
  20492. }
  20493. module "babylonjs/Cameras/camera" {
  20494. interface Camera {
  20495. /**
  20496. * @hidden
  20497. * 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)
  20498. */
  20499. _useMultiviewToSingleView: boolean;
  20500. /**
  20501. * @hidden
  20502. * 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)
  20503. */
  20504. _multiviewTexture: Nullable<RenderTargetTexture>;
  20505. /**
  20506. * @hidden
  20507. * ensures the multiview texture of the camera exists and has the specified width/height
  20508. * @param width height to set on the multiview texture
  20509. * @param height width to set on the multiview texture
  20510. */
  20511. _resizeOrCreateMultiviewTexture(width: number, height: number): void;
  20512. }
  20513. }
  20514. module "babylonjs/scene" {
  20515. interface Scene {
  20516. /** @hidden */
  20517. _transformMatrixR: Matrix;
  20518. /** @hidden */
  20519. _multiviewSceneUbo: Nullable<UniformBuffer>;
  20520. /** @hidden */
  20521. _createMultiviewUbo(): void;
  20522. /** @hidden */
  20523. _updateMultiviewUbo(viewR?: Matrix, projectionR?: Matrix): void;
  20524. /** @hidden */
  20525. _renderMultiviewToSingleView(camera: Camera): void;
  20526. }
  20527. }
  20528. }
  20529. declare module "babylonjs/PostProcesses/vrMultiviewToSingleviewPostProcess" {
  20530. import { Camera } from "babylonjs/Cameras/camera";
  20531. import { PostProcess } from "babylonjs/PostProcesses/postProcess";
  20532. import "babylonjs/Shaders/vrMultiviewToSingleview.fragment";
  20533. import "babylonjs/Engines/Extensions/engine.multiview";
  20534. /**
  20535. * VRMultiviewToSingleview used to convert multiview texture arrays to standard textures for scenarios such as webVR
  20536. * This will not be used for webXR as it supports displaying texture arrays directly
  20537. */
  20538. export class VRMultiviewToSingleviewPostProcess extends PostProcess {
  20539. /**
  20540. * Gets a string identifying the name of the class
  20541. * @returns "VRMultiviewToSingleviewPostProcess" string
  20542. */
  20543. getClassName(): string;
  20544. /**
  20545. * Initializes a VRMultiviewToSingleview
  20546. * @param name name of the post process
  20547. * @param camera camera to be applied to
  20548. * @param scaleFactor scaling factor to the size of the output texture
  20549. */
  20550. constructor(name: string, camera: Camera, scaleFactor: number);
  20551. }
  20552. }
  20553. declare module "babylonjs/Cameras/RigModes/webVRRigMode" { }
  20554. declare module "babylonjs/Engines/Extensions/engine.webVR" {
  20555. import { Nullable } from "babylonjs/types";
  20556. import { Size } from "babylonjs/Maths/math.size";
  20557. import { Observable } from "babylonjs/Misc/observable";
  20558. import { WebVROptions } from "babylonjs/Cameras/VR/webVRCamera";
  20559. /**
  20560. * Interface used to define additional presentation attributes
  20561. */
  20562. export interface IVRPresentationAttributes {
  20563. /**
  20564. * Defines a boolean indicating that we want to get 72hz mode on Oculus Browser (default is off eg. 60hz)
  20565. */
  20566. highRefreshRate: boolean;
  20567. /**
  20568. * Enables foveation in VR to improve perf. 0 none, 1 low, 2 medium, 3 high (Default is 1)
  20569. */
  20570. foveationLevel: number;
  20571. }
  20572. module "babylonjs/Engines/engine" {
  20573. interface Engine {
  20574. /** @hidden */
  20575. _vrDisplay: any;
  20576. /** @hidden */
  20577. _vrSupported: boolean;
  20578. /** @hidden */
  20579. _oldSize: Size;
  20580. /** @hidden */
  20581. _oldHardwareScaleFactor: number;
  20582. /** @hidden */
  20583. _vrExclusivePointerMode: boolean;
  20584. /** @hidden */
  20585. _webVRInitPromise: Promise<IDisplayChangedEventArgs>;
  20586. /** @hidden */
  20587. _onVRDisplayPointerRestricted: () => void;
  20588. /** @hidden */
  20589. _onVRDisplayPointerUnrestricted: () => void;
  20590. /** @hidden */
  20591. _onVrDisplayConnect: Nullable<(display: any) => void>;
  20592. /** @hidden */
  20593. _onVrDisplayDisconnect: Nullable<() => void>;
  20594. /** @hidden */
  20595. _onVrDisplayPresentChange: Nullable<() => void>;
  20596. /**
  20597. * Observable signaled when VR display mode changes
  20598. */
  20599. onVRDisplayChangedObservable: Observable<IDisplayChangedEventArgs>;
  20600. /**
  20601. * Observable signaled when VR request present is complete
  20602. */
  20603. onVRRequestPresentComplete: Observable<boolean>;
  20604. /**
  20605. * Observable signaled when VR request present starts
  20606. */
  20607. onVRRequestPresentStart: Observable<Engine>;
  20608. /**
  20609. * Gets a boolean indicating that the engine is currently in VR exclusive mode for the pointers
  20610. * @see https://docs.microsoft.com/en-us/microsoft-edge/webvr/essentials#mouse-input
  20611. */
  20612. isInVRExclusivePointerMode: boolean;
  20613. /**
  20614. * Gets a boolean indicating if a webVR device was detected
  20615. * @returns true if a webVR device was detected
  20616. */
  20617. isVRDevicePresent(): boolean;
  20618. /**
  20619. * Gets the current webVR device
  20620. * @returns the current webVR device (or null)
  20621. */
  20622. getVRDevice(): any;
  20623. /**
  20624. * Initializes a webVR display and starts listening to display change events
  20625. * The onVRDisplayChangedObservable will be notified upon these changes
  20626. * @returns A promise containing a VRDisplay and if vr is supported
  20627. */
  20628. initWebVRAsync(): Promise<IDisplayChangedEventArgs>;
  20629. /** @hidden */
  20630. _getVRDisplaysAsync(): Promise<IDisplayChangedEventArgs>;
  20631. /**
  20632. * Gets or sets the presentation attributes used to configure VR rendering
  20633. */
  20634. vrPresentationAttributes?: IVRPresentationAttributes;
  20635. /**
  20636. * Call this function to switch to webVR mode
  20637. * Will do nothing if webVR is not supported or if there is no webVR device
  20638. * @param options the webvr options provided to the camera. mainly used for multiview
  20639. * @see https://doc.babylonjs.com/how_to/webvr_camera
  20640. */
  20641. enableVR(options: WebVROptions): void;
  20642. /** @hidden */
  20643. _onVRFullScreenTriggered(): void;
  20644. }
  20645. }
  20646. }
  20647. declare module "babylonjs/Cameras/VR/webVRCamera" {
  20648. import { Nullable } from "babylonjs/types";
  20649. import { Observable } from "babylonjs/Misc/observable";
  20650. import { FreeCamera } from "babylonjs/Cameras/freeCamera";
  20651. import { Scene } from "babylonjs/scene";
  20652. import { Quaternion, Matrix, Vector3 } from "babylonjs/Maths/math.vector";
  20653. import { WebVRController } from "babylonjs/Gamepads/Controllers/webVRController";
  20654. import { Node } from "babylonjs/node";
  20655. import { Ray } from "babylonjs/Culling/ray";
  20656. import "babylonjs/Cameras/RigModes/webVRRigMode";
  20657. import "babylonjs/Engines/Extensions/engine.webVR";
  20658. /**
  20659. * This is a copy of VRPose. See https://developer.mozilla.org/en-US/docs/Web/API/VRPose
  20660. * IMPORTANT!! The data is right-hand data.
  20661. * @export
  20662. * @interface DevicePose
  20663. */
  20664. export interface DevicePose {
  20665. /**
  20666. * The position of the device, values in array are [x,y,z].
  20667. */
  20668. readonly position: Nullable<Float32Array>;
  20669. /**
  20670. * The linearVelocity of the device, values in array are [x,y,z].
  20671. */
  20672. readonly linearVelocity: Nullable<Float32Array>;
  20673. /**
  20674. * The linearAcceleration of the device, values in array are [x,y,z].
  20675. */
  20676. readonly linearAcceleration: Nullable<Float32Array>;
  20677. /**
  20678. * The orientation of the device in a quaternion array, values in array are [x,y,z,w].
  20679. */
  20680. readonly orientation: Nullable<Float32Array>;
  20681. /**
  20682. * The angularVelocity of the device, values in array are [x,y,z].
  20683. */
  20684. readonly angularVelocity: Nullable<Float32Array>;
  20685. /**
  20686. * The angularAcceleration of the device, values in array are [x,y,z].
  20687. */
  20688. readonly angularAcceleration: Nullable<Float32Array>;
  20689. }
  20690. /**
  20691. * Interface representing a pose controlled object in Babylon.
  20692. * A pose controlled object has both regular pose values as well as pose values
  20693. * from an external device such as a VR head mounted display
  20694. */
  20695. export interface PoseControlled {
  20696. /**
  20697. * The position of the object in babylon space.
  20698. */
  20699. position: Vector3;
  20700. /**
  20701. * The rotation quaternion of the object in babylon space.
  20702. */
  20703. rotationQuaternion: Quaternion;
  20704. /**
  20705. * The position of the device in babylon space.
  20706. */
  20707. devicePosition?: Vector3;
  20708. /**
  20709. * The rotation quaternion of the device in babylon space.
  20710. */
  20711. deviceRotationQuaternion: Quaternion;
  20712. /**
  20713. * The raw pose coming from the device.
  20714. */
  20715. rawPose: Nullable<DevicePose>;
  20716. /**
  20717. * The scale of the device to be used when translating from device space to babylon space.
  20718. */
  20719. deviceScaleFactor: number;
  20720. /**
  20721. * Updates the poseControlled values based on the input device pose.
  20722. * @param poseData the pose data to update the object with
  20723. */
  20724. updateFromDevice(poseData: DevicePose): void;
  20725. }
  20726. /**
  20727. * Set of options to customize the webVRCamera
  20728. */
  20729. export interface WebVROptions {
  20730. /**
  20731. * Sets if the webVR camera should be tracked to the vrDevice. (default: true)
  20732. */
  20733. trackPosition?: boolean;
  20734. /**
  20735. * Sets the scale of the vrDevice in babylon space. (default: 1)
  20736. */
  20737. positionScale?: number;
  20738. /**
  20739. * If there are more than one VRDisplays, this will choose the display matching this name. (default: pick first vrDisplay)
  20740. */
  20741. displayName?: string;
  20742. /**
  20743. * Should the native controller meshes be initialized. (default: true)
  20744. */
  20745. controllerMeshes?: boolean;
  20746. /**
  20747. * Creating a default HemiLight only on controllers. (default: true)
  20748. */
  20749. defaultLightingOnControllers?: boolean;
  20750. /**
  20751. * If you don't want to use the default VR button of the helper. (default: false)
  20752. */
  20753. useCustomVRButton?: boolean;
  20754. /**
  20755. * If you'd like to provide your own button to the VRHelper. (default: standard babylon vr button)
  20756. */
  20757. customVRButton?: HTMLButtonElement;
  20758. /**
  20759. * To change the length of the ray for gaze/controllers. Will be scaled by positionScale. (default: 100)
  20760. */
  20761. rayLength?: number;
  20762. /**
  20763. * To change the default offset from the ground to account for user's height in meters. Will be scaled by positionScale. (default: 1.7)
  20764. */
  20765. defaultHeight?: number;
  20766. /**
  20767. * If multiview should be used if availible (default: false)
  20768. */
  20769. useMultiview?: boolean;
  20770. }
  20771. /**
  20772. * This represents a WebVR camera.
  20773. * The WebVR camera is Babylon's simple interface to interaction with Windows Mixed Reality, HTC Vive and Oculus Rift.
  20774. * @example https://doc.babylonjs.com/how_to/webvr_camera
  20775. */
  20776. export class WebVRFreeCamera extends FreeCamera implements PoseControlled {
  20777. private webVROptions;
  20778. /**
  20779. * @hidden
  20780. * The vrDisplay tied to the camera. See https://developer.mozilla.org/en-US/docs/Web/API/VRDisplay
  20781. */
  20782. _vrDevice: any;
  20783. /**
  20784. * The rawPose of the vrDevice.
  20785. */
  20786. rawPose: Nullable<DevicePose>;
  20787. private _onVREnabled;
  20788. private _specsVersion;
  20789. private _attached;
  20790. private _frameData;
  20791. protected _descendants: Array<Node>;
  20792. private _deviceRoomPosition;
  20793. /** @hidden */
  20794. _deviceRoomRotationQuaternion: Quaternion;
  20795. private _standingMatrix;
  20796. /**
  20797. * Represents device position in babylon space.
  20798. */
  20799. devicePosition: Vector3;
  20800. /**
  20801. * Represents device rotation in babylon space.
  20802. */
  20803. deviceRotationQuaternion: Quaternion;
  20804. /**
  20805. * The scale of the device to be used when translating from device space to babylon space.
  20806. */
  20807. deviceScaleFactor: number;
  20808. private _deviceToWorld;
  20809. private _worldToDevice;
  20810. /**
  20811. * References to the webVR controllers for the vrDevice.
  20812. */
  20813. controllers: Array<WebVRController>;
  20814. /**
  20815. * Emits an event when a controller is attached.
  20816. */
  20817. onControllersAttachedObservable: Observable<WebVRController[]>;
  20818. /**
  20819. * Emits an event when a controller's mesh has been loaded;
  20820. */
  20821. onControllerMeshLoadedObservable: Observable<WebVRController>;
  20822. /**
  20823. * Emits an event when the HMD's pose has been updated.
  20824. */
  20825. onPoseUpdatedFromDeviceObservable: Observable<any>;
  20826. private _poseSet;
  20827. /**
  20828. * If the rig cameras be used as parent instead of this camera.
  20829. */
  20830. rigParenting: boolean;
  20831. private _lightOnControllers;
  20832. private _defaultHeight?;
  20833. /**
  20834. * Instantiates a WebVRFreeCamera.
  20835. * @param name The name of the WebVRFreeCamera
  20836. * @param position The starting anchor position for the camera
  20837. * @param scene The scene the camera belongs to
  20838. * @param webVROptions a set of customizable options for the webVRCamera
  20839. */
  20840. constructor(name: string, position: Vector3, scene: Scene, webVROptions?: WebVROptions);
  20841. /**
  20842. * Gets the device distance from the ground in meters.
  20843. * @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.
  20844. */
  20845. deviceDistanceToRoomGround(): number;
  20846. /**
  20847. * Enables the standing matrix when supported. This can be used to position the user's view the correct height from the ground.
  20848. * @param callback will be called when the standing matrix is set. Callback parameter is if the standing matrix is supported.
  20849. */
  20850. useStandingMatrix(callback?: (bool: boolean) => void): void;
  20851. /**
  20852. * Enables the standing matrix when supported. This can be used to position the user's view the correct height from the ground.
  20853. * @returns A promise with a boolean set to if the standing matrix is supported.
  20854. */
  20855. useStandingMatrixAsync(): Promise<boolean>;
  20856. /**
  20857. * Disposes the camera
  20858. */
  20859. dispose(): void;
  20860. /**
  20861. * Gets a vrController by name.
  20862. * @param name The name of the controller to retreive
  20863. * @returns the controller matching the name specified or null if not found
  20864. */
  20865. getControllerByName(name: string): Nullable<WebVRController>;
  20866. private _leftController;
  20867. /**
  20868. * The controller corresponding to the users left hand.
  20869. */
  20870. get leftController(): Nullable<WebVRController>;
  20871. private _rightController;
  20872. /**
  20873. * The controller corresponding to the users right hand.
  20874. */
  20875. get rightController(): Nullable<WebVRController>;
  20876. /**
  20877. * Casts a ray forward from the vrCamera's gaze.
  20878. * @param length Length of the ray (default: 100)
  20879. * @returns the ray corresponding to the gaze
  20880. */
  20881. getForwardRay(length?: number): Ray;
  20882. /**
  20883. * @hidden
  20884. * Updates the camera based on device's frame data
  20885. */
  20886. _checkInputs(): void;
  20887. /**
  20888. * Updates the poseControlled values based on the input device pose.
  20889. * @param poseData Pose coming from the device
  20890. */
  20891. updateFromDevice(poseData: DevicePose): void;
  20892. private _htmlElementAttached;
  20893. private _detachIfAttached;
  20894. /**
  20895. * WebVR's attach control will start broadcasting frames to the device.
  20896. * Note that in certain browsers (chrome for example) this function must be called
  20897. * within a user-interaction callback. Example:
  20898. * <pre> scene.onPointerDown = function() { camera.attachControl(canvas); }</pre>
  20899. *
  20900. * @param element html element to attach the vrDevice to
  20901. * @param noPreventDefault prevent the default html element operation when attaching the vrDevice
  20902. */
  20903. attachControl(element: HTMLElement, noPreventDefault?: boolean): void;
  20904. /**
  20905. * Detaches the camera from the html element and disables VR
  20906. *
  20907. * @param element html element to detach from
  20908. */
  20909. detachControl(element: HTMLElement): void;
  20910. /**
  20911. * @returns the name of this class
  20912. */
  20913. getClassName(): string;
  20914. /**
  20915. * Calls resetPose on the vrDisplay
  20916. * See: https://developer.mozilla.org/en-US/docs/Web/API/VRDisplay/resetPose
  20917. */
  20918. resetToCurrentRotation(): void;
  20919. /**
  20920. * @hidden
  20921. * Updates the rig cameras (left and right eye)
  20922. */
  20923. _updateRigCameras(): void;
  20924. private _workingVector;
  20925. private _oneVector;
  20926. private _workingMatrix;
  20927. private updateCacheCalled;
  20928. private _correctPositionIfNotTrackPosition;
  20929. /**
  20930. * @hidden
  20931. * Updates the cached values of the camera
  20932. * @param ignoreParentClass ignores updating the parent class's cache (default: false)
  20933. */
  20934. _updateCache(ignoreParentClass?: boolean): void;
  20935. /**
  20936. * @hidden
  20937. * Get current device position in babylon world
  20938. */
  20939. _computeDevicePosition(): void;
  20940. /**
  20941. * Updates the current device position and rotation in the babylon world
  20942. */
  20943. update(): void;
  20944. /**
  20945. * @hidden
  20946. * Gets the view matrix of this camera (Always set to identity as left and right eye cameras contain the actual view matrix)
  20947. * @returns an identity matrix
  20948. */
  20949. _getViewMatrix(): Matrix;
  20950. private _tmpMatrix;
  20951. /**
  20952. * This function is called by the two RIG cameras.
  20953. * 'this' is the left or right camera (and NOT (!!!) the WebVRFreeCamera instance)
  20954. * @hidden
  20955. */
  20956. _getWebVRViewMatrix(): Matrix;
  20957. /** @hidden */
  20958. _getWebVRProjectionMatrix(): Matrix;
  20959. private _onGamepadConnectedObserver;
  20960. private _onGamepadDisconnectedObserver;
  20961. private _updateCacheWhenTrackingDisabledObserver;
  20962. /**
  20963. * Initializes the controllers and their meshes
  20964. */
  20965. initControllers(): void;
  20966. }
  20967. }
  20968. declare module "babylonjs/Materials/materialHelper" {
  20969. import { Nullable } from "babylonjs/types";
  20970. import { Scene } from "babylonjs/scene";
  20971. import { Engine } from "babylonjs/Engines/engine";
  20972. import { AbstractMesh } from "babylonjs/Meshes/abstractMesh";
  20973. import { Light } from "babylonjs/Lights/light";
  20974. import { PrePassConfiguration } from "babylonjs/Materials/prePassConfiguration";
  20975. import { UniformBuffer } from "babylonjs/Materials/uniformBuffer";
  20976. import { Effect, IEffectCreationOptions } from "babylonjs/Materials/effect";
  20977. import { BaseTexture } from "babylonjs/Materials/Textures/baseTexture";
  20978. import { MaterialDefines } from "babylonjs/Materials/materialDefines";
  20979. import { EffectFallbacks } from "babylonjs/Materials/effectFallbacks";
  20980. /**
  20981. * "Static Class" containing the most commonly used helper while dealing with material for rendering purpose.
  20982. *
  20983. * It contains the basic tools to help defining defines, binding uniform for the common part of the materials.
  20984. *
  20985. * This works by convention in BabylonJS but is meant to be use only with shader following the in place naming rules and conventions.
  20986. */
  20987. export class MaterialHelper {
  20988. /**
  20989. * Bind the current view position to an effect.
  20990. * @param effect The effect to be bound
  20991. * @param scene The scene the eyes position is used from
  20992. * @param variableName name of the shader variable that will hold the eye position
  20993. */
  20994. static BindEyePosition(effect: Effect, scene: Scene, variableName?: string): void;
  20995. /**
  20996. * Helps preparing the defines values about the UVs in used in the effect.
  20997. * UVs are shared as much as we can accross channels in the shaders.
  20998. * @param texture The texture we are preparing the UVs for
  20999. * @param defines The defines to update
  21000. * @param key The channel key "diffuse", "specular"... used in the shader
  21001. */
  21002. static PrepareDefinesForMergedUV(texture: BaseTexture, defines: any, key: string): void;
  21003. /**
  21004. * Binds a texture matrix value to its corrsponding uniform
  21005. * @param texture The texture to bind the matrix for
  21006. * @param uniformBuffer The uniform buffer receivin the data
  21007. * @param key The channel key "diffuse", "specular"... used in the shader
  21008. */
  21009. static BindTextureMatrix(texture: BaseTexture, uniformBuffer: UniformBuffer, key: string): void;
  21010. /**
  21011. * Gets the current status of the fog (should it be enabled?)
  21012. * @param mesh defines the mesh to evaluate for fog support
  21013. * @param scene defines the hosting scene
  21014. * @returns true if fog must be enabled
  21015. */
  21016. static GetFogState(mesh: AbstractMesh, scene: Scene): boolean;
  21017. /**
  21018. * Helper used to prepare the list of defines associated with misc. values for shader compilation
  21019. * @param mesh defines the current mesh
  21020. * @param scene defines the current scene
  21021. * @param useLogarithmicDepth defines if logarithmic depth has to be turned on
  21022. * @param pointsCloud defines if point cloud rendering has to be turned on
  21023. * @param fogEnabled defines if fog has to be turned on
  21024. * @param alphaTest defines if alpha testing has to be turned on
  21025. * @param defines defines the current list of defines
  21026. */
  21027. static PrepareDefinesForMisc(mesh: AbstractMesh, scene: Scene, useLogarithmicDepth: boolean, pointsCloud: boolean, fogEnabled: boolean, alphaTest: boolean, defines: any): void;
  21028. /**
  21029. * Helper used to prepare the list of defines associated with frame values for shader compilation
  21030. * @param scene defines the current scene
  21031. * @param engine defines the current engine
  21032. * @param defines specifies the list of active defines
  21033. * @param useInstances defines if instances have to be turned on
  21034. * @param useClipPlane defines if clip plane have to be turned on
  21035. * @param useInstances defines if instances have to be turned on
  21036. * @param useThinInstances defines if thin instances have to be turned on
  21037. */
  21038. static PrepareDefinesForFrameBoundValues(scene: Scene, engine: Engine, defines: any, useInstances: boolean, useClipPlane?: Nullable<boolean>, useThinInstances?: boolean): void;
  21039. /**
  21040. * Prepares the defines for bones
  21041. * @param mesh The mesh containing the geometry data we will draw
  21042. * @param defines The defines to update
  21043. */
  21044. static PrepareDefinesForBones(mesh: AbstractMesh, defines: any): void;
  21045. /**
  21046. * Prepares the defines for morph targets
  21047. * @param mesh The mesh containing the geometry data we will draw
  21048. * @param defines The defines to update
  21049. */
  21050. static PrepareDefinesForMorphTargets(mesh: AbstractMesh, defines: any): void;
  21051. /**
  21052. * Prepares the defines used in the shader depending on the attributes data available in the mesh
  21053. * @param mesh The mesh containing the geometry data we will draw
  21054. * @param defines The defines to update
  21055. * @param useVertexColor Precise whether vertex colors should be used or not (override mesh info)
  21056. * @param useBones Precise whether bones should be used or not (override mesh info)
  21057. * @param useMorphTargets Precise whether morph targets should be used or not (override mesh info)
  21058. * @param useVertexAlpha Precise whether vertex alpha should be used or not (override mesh info)
  21059. * @returns false if defines are considered not dirty and have not been checked
  21060. */
  21061. static PrepareDefinesForAttributes(mesh: AbstractMesh, defines: any, useVertexColor: boolean, useBones: boolean, useMorphTargets?: boolean, useVertexAlpha?: boolean): boolean;
  21062. /**
  21063. * Prepares the defines related to multiview
  21064. * @param scene The scene we are intending to draw
  21065. * @param defines The defines to update
  21066. */
  21067. static PrepareDefinesForMultiview(scene: Scene, defines: any): void;
  21068. /**
  21069. * Prepares the defines related to the prepass
  21070. * @param scene The scene we are intending to draw
  21071. * @param defines The defines to update
  21072. * @param canRenderToMRT Indicates if this material renders to several textures in the prepass
  21073. */
  21074. static PrepareDefinesForPrePass(scene: Scene, defines: any, canRenderToMRT: boolean): void;
  21075. /**
  21076. * Prepares the defines related to the light information passed in parameter
  21077. * @param scene The scene we are intending to draw
  21078. * @param mesh The mesh the effect is compiling for
  21079. * @param light The light the effect is compiling for
  21080. * @param lightIndex The index of the light
  21081. * @param defines The defines to update
  21082. * @param specularSupported Specifies whether specular is supported or not (override lights data)
  21083. * @param state Defines the current state regarding what is needed (normals, etc...)
  21084. */
  21085. static PrepareDefinesForLight(scene: Scene, mesh: AbstractMesh, light: Light, lightIndex: number, defines: any, specularSupported: boolean, state: {
  21086. needNormals: boolean;
  21087. needRebuild: boolean;
  21088. shadowEnabled: boolean;
  21089. specularEnabled: boolean;
  21090. lightmapMode: boolean;
  21091. }): void;
  21092. /**
  21093. * Prepares the defines related to the light information passed in parameter
  21094. * @param scene The scene we are intending to draw
  21095. * @param mesh The mesh the effect is compiling for
  21096. * @param defines The defines to update
  21097. * @param specularSupported Specifies whether specular is supported or not (override lights data)
  21098. * @param maxSimultaneousLights Specfies how manuy lights can be added to the effect at max
  21099. * @param disableLighting Specifies whether the lighting is disabled (override scene and light)
  21100. * @returns true if normals will be required for the rest of the effect
  21101. */
  21102. static PrepareDefinesForLights(scene: Scene, mesh: AbstractMesh, defines: any, specularSupported: boolean, maxSimultaneousLights?: number, disableLighting?: boolean): boolean;
  21103. /**
  21104. * Prepares the uniforms and samplers list to be used in the effect (for a specific light)
  21105. * @param lightIndex defines the light index
  21106. * @param uniformsList The uniform list
  21107. * @param samplersList The sampler list
  21108. * @param projectedLightTexture defines if projected texture must be used
  21109. * @param uniformBuffersList defines an optional list of uniform buffers
  21110. */
  21111. static PrepareUniformsAndSamplersForLight(lightIndex: number, uniformsList: string[], samplersList: string[], projectedLightTexture?: any, uniformBuffersList?: Nullable<string[]>): void;
  21112. /**
  21113. * Prepares the uniforms and samplers list to be used in the effect
  21114. * @param uniformsListOrOptions The uniform names to prepare or an EffectCreationOptions containing the liist and extra information
  21115. * @param samplersList The sampler list
  21116. * @param defines The defines helping in the list generation
  21117. * @param maxSimultaneousLights The maximum number of simultanous light allowed in the effect
  21118. */
  21119. static PrepareUniformsAndSamplersList(uniformsListOrOptions: string[] | IEffectCreationOptions, samplersList?: string[], defines?: any, maxSimultaneousLights?: number): void;
  21120. /**
  21121. * This helps decreasing rank by rank the shadow quality (0 being the highest rank and quality)
  21122. * @param defines The defines to update while falling back
  21123. * @param fallbacks The authorized effect fallbacks
  21124. * @param maxSimultaneousLights The maximum number of lights allowed
  21125. * @param rank the current rank of the Effect
  21126. * @returns The newly affected rank
  21127. */
  21128. static HandleFallbacksForShadows(defines: any, fallbacks: EffectFallbacks, maxSimultaneousLights?: number, rank?: number): number;
  21129. private static _TmpMorphInfluencers;
  21130. /**
  21131. * Prepares the list of attributes required for morph targets according to the effect defines.
  21132. * @param attribs The current list of supported attribs
  21133. * @param mesh The mesh to prepare the morph targets attributes for
  21134. * @param influencers The number of influencers
  21135. */
  21136. static PrepareAttributesForMorphTargetsInfluencers(attribs: string[], mesh: AbstractMesh, influencers: number): void;
  21137. /**
  21138. * Prepares the list of attributes required for morph targets according to the effect defines.
  21139. * @param attribs The current list of supported attribs
  21140. * @param mesh The mesh to prepare the morph targets attributes for
  21141. * @param defines The current Defines of the effect
  21142. */
  21143. static PrepareAttributesForMorphTargets(attribs: string[], mesh: AbstractMesh, defines: any): void;
  21144. /**
  21145. * Prepares the list of attributes required for bones according to the effect defines.
  21146. * @param attribs The current list of supported attribs
  21147. * @param mesh The mesh to prepare the bones attributes for
  21148. * @param defines The current Defines of the effect
  21149. * @param fallbacks The current efffect fallback strategy
  21150. */
  21151. static PrepareAttributesForBones(attribs: string[], mesh: AbstractMesh, defines: any, fallbacks: EffectFallbacks): void;
  21152. /**
  21153. * Check and prepare the list of attributes required for instances according to the effect defines.
  21154. * @param attribs The current list of supported attribs
  21155. * @param defines The current MaterialDefines of the effect
  21156. */
  21157. static PrepareAttributesForInstances(attribs: string[], defines: MaterialDefines): void;
  21158. /**
  21159. * Add the list of attributes required for instances to the attribs array.
  21160. * @param attribs The current list of supported attribs
  21161. */
  21162. static PushAttributesForInstances(attribs: string[]): void;
  21163. /**
  21164. * Binds the light information to the effect.
  21165. * @param light The light containing the generator
  21166. * @param effect The effect we are binding the data to
  21167. * @param lightIndex The light index in the effect used to render
  21168. */
  21169. static BindLightProperties(light: Light, effect: Effect, lightIndex: number): void;
  21170. /**
  21171. * Binds the lights information from the scene to the effect for the given mesh.
  21172. * @param light Light to bind
  21173. * @param lightIndex Light index
  21174. * @param scene The scene where the light belongs to
  21175. * @param effect The effect we are binding the data to
  21176. * @param useSpecular Defines if specular is supported
  21177. * @param rebuildInParallel Specifies whether the shader is rebuilding in parallel
  21178. */
  21179. static BindLight(light: Light, lightIndex: number, scene: Scene, effect: Effect, useSpecular: boolean, rebuildInParallel?: boolean): void;
  21180. /**
  21181. * Binds the lights information from the scene to the effect for the given mesh.
  21182. * @param scene The scene the lights belongs to
  21183. * @param mesh The mesh we are binding the information to render
  21184. * @param effect The effect we are binding the data to
  21185. * @param defines The generated defines for the effect
  21186. * @param maxSimultaneousLights The maximum number of light that can be bound to the effect
  21187. * @param rebuildInParallel Specifies whether the shader is rebuilding in parallel
  21188. */
  21189. static BindLights(scene: Scene, mesh: AbstractMesh, effect: Effect, defines: any, maxSimultaneousLights?: number, rebuildInParallel?: boolean): void;
  21190. private static _tempFogColor;
  21191. /**
  21192. * Binds the fog information from the scene to the effect for the given mesh.
  21193. * @param scene The scene the lights belongs to
  21194. * @param mesh The mesh we are binding the information to render
  21195. * @param effect The effect we are binding the data to
  21196. * @param linearSpace Defines if the fog effect is applied in linear space
  21197. */
  21198. static BindFogParameters(scene: Scene, mesh: AbstractMesh, effect: Effect, linearSpace?: boolean): void;
  21199. /**
  21200. * Binds the bones information from the mesh to the effect.
  21201. * @param mesh The mesh we are binding the information to render
  21202. * @param effect The effect we are binding the data to
  21203. * @param prePassConfiguration Configuration for the prepass, in case prepass is activated
  21204. */
  21205. static BindBonesParameters(mesh?: AbstractMesh, effect?: Effect, prePassConfiguration?: PrePassConfiguration): void;
  21206. private static _CopyBonesTransformationMatrices;
  21207. /**
  21208. * Binds the morph targets information from the mesh to the effect.
  21209. * @param abstractMesh The mesh we are binding the information to render
  21210. * @param effect The effect we are binding the data to
  21211. */
  21212. static BindMorphTargetParameters(abstractMesh: AbstractMesh, effect: Effect): void;
  21213. /**
  21214. * Binds the logarithmic depth information from the scene to the effect for the given defines.
  21215. * @param defines The generated defines used in the effect
  21216. * @param effect The effect we are binding the data to
  21217. * @param scene The scene we are willing to render with logarithmic scale for
  21218. */
  21219. static BindLogDepth(defines: any, effect: Effect, scene: Scene): void;
  21220. /**
  21221. * Binds the clip plane information from the scene to the effect.
  21222. * @param scene The scene the clip plane information are extracted from
  21223. * @param effect The effect we are binding the data to
  21224. */
  21225. static BindClipPlane(effect: Effect, scene: Scene): void;
  21226. }
  21227. }
  21228. declare module "babylonjs/Materials/Node/Blocks/Input/inputBlock" {
  21229. import { NodeMaterialBlock } from "babylonjs/Materials/Node/nodeMaterialBlock";
  21230. import { NodeMaterialBlockConnectionPointTypes } from "babylonjs/Materials/Node/Enums/nodeMaterialBlockConnectionPointTypes";
  21231. import { NodeMaterialSystemValues } from "babylonjs/Materials/Node/Enums/nodeMaterialSystemValues";
  21232. import { Nullable } from "babylonjs/types";
  21233. import { Effect } from "babylonjs/Materials/effect";
  21234. import { Matrix } from "babylonjs/Maths/math.vector";
  21235. import { Scene } from "babylonjs/scene";
  21236. import { NodeMaterialConnectionPoint } from "babylonjs/Materials/Node/nodeMaterialBlockConnectionPoint";
  21237. import { NodeMaterialBuildState } from "babylonjs/Materials/Node/nodeMaterialBuildState";
  21238. import { NodeMaterialBlockTargets } from "babylonjs/Materials/Node/Enums/nodeMaterialBlockTargets";
  21239. import { AnimatedInputBlockTypes } from "babylonjs/Materials/Node/Blocks/Input/animatedInputBlockTypes";
  21240. import { Observable } from "babylonjs/Misc/observable";
  21241. /**
  21242. * Block used to expose an input value
  21243. */
  21244. export class InputBlock extends NodeMaterialBlock {
  21245. private _mode;
  21246. private _associatedVariableName;
  21247. private _storedValue;
  21248. private _valueCallback;
  21249. private _type;
  21250. private _animationType;
  21251. /** Gets or set a value used to limit the range of float values */
  21252. min: number;
  21253. /** Gets or set a value used to limit the range of float values */
  21254. max: number;
  21255. /** Gets or set a value indicating that this input can only get 0 and 1 values */
  21256. isBoolean: boolean;
  21257. /** Gets or sets a value used by the Node Material editor to determine how to configure the current value if it is a matrix */
  21258. matrixMode: number;
  21259. /** @hidden */
  21260. _systemValue: Nullable<NodeMaterialSystemValues>;
  21261. /** Gets or sets a boolean indicating that the value of this input will not change after a build */
  21262. isConstant: boolean;
  21263. /** Gets or sets the group to use to display this block in the Inspector */
  21264. groupInInspector: string;
  21265. /** Gets an observable raised when the value is changed */
  21266. onValueChangedObservable: Observable<InputBlock>;
  21267. /**
  21268. * Gets or sets the connection point type (default is float)
  21269. */
  21270. get type(): NodeMaterialBlockConnectionPointTypes;
  21271. /**
  21272. * Creates a new InputBlock
  21273. * @param name defines the block name
  21274. * @param target defines the target of that block (Vertex by default)
  21275. * @param type defines the type of the input (can be set to NodeMaterialBlockConnectionPointTypes.AutoDetect)
  21276. */
  21277. constructor(name: string, target?: NodeMaterialBlockTargets, type?: NodeMaterialBlockConnectionPointTypes);
  21278. /**
  21279. * Validates if a name is a reserve word.
  21280. * @param newName the new name to be given to the node.
  21281. * @returns false if the name is a reserve word, else true.
  21282. */
  21283. validateBlockName(newName: string): boolean;
  21284. /**
  21285. * Gets the output component
  21286. */
  21287. get output(): NodeMaterialConnectionPoint;
  21288. /**
  21289. * Set the source of this connection point to a vertex attribute
  21290. * @param attributeName defines the attribute name (position, uv, normal, etc...). If not specified it will take the connection point name
  21291. * @returns the current connection point
  21292. */
  21293. setAsAttribute(attributeName?: string): InputBlock;
  21294. /**
  21295. * Set the source of this connection point to a system value
  21296. * @param value define the system value to use (world, view, etc...) or null to switch to manual value
  21297. * @returns the current connection point
  21298. */
  21299. setAsSystemValue(value: Nullable<NodeMaterialSystemValues>): InputBlock;
  21300. /**
  21301. * Gets or sets the value of that point.
  21302. * Please note that this value will be ignored if valueCallback is defined
  21303. */
  21304. get value(): any;
  21305. set value(value: any);
  21306. /**
  21307. * Gets or sets a callback used to get the value of that point.
  21308. * Please note that setting this value will force the connection point to ignore the value property
  21309. */
  21310. get valueCallback(): () => any;
  21311. set valueCallback(value: () => any);
  21312. /**
  21313. * Gets or sets the associated variable name in the shader
  21314. */
  21315. get associatedVariableName(): string;
  21316. set associatedVariableName(value: string);
  21317. /** Gets or sets the type of animation applied to the input */
  21318. get animationType(): AnimatedInputBlockTypes;
  21319. set animationType(value: AnimatedInputBlockTypes);
  21320. /**
  21321. * Gets a boolean indicating that this connection point not defined yet
  21322. */
  21323. get isUndefined(): boolean;
  21324. /**
  21325. * Gets or sets a boolean indicating that this connection point is coming from an uniform.
  21326. * In this case the connection point name must be the name of the uniform to use.
  21327. * Can only be set on inputs
  21328. */
  21329. get isUniform(): boolean;
  21330. set isUniform(value: boolean);
  21331. /**
  21332. * Gets or sets a boolean indicating that this connection point is coming from an attribute.
  21333. * In this case the connection point name must be the name of the attribute to use
  21334. * Can only be set on inputs
  21335. */
  21336. get isAttribute(): boolean;
  21337. set isAttribute(value: boolean);
  21338. /**
  21339. * Gets or sets a boolean indicating that this connection point is generating a varying variable.
  21340. * Can only be set on exit points
  21341. */
  21342. get isVarying(): boolean;
  21343. set isVarying(value: boolean);
  21344. /**
  21345. * Gets a boolean indicating that the current connection point is a system value
  21346. */
  21347. get isSystemValue(): boolean;
  21348. /**
  21349. * Gets or sets the current well known value or null if not defined as a system value
  21350. */
  21351. get systemValue(): Nullable<NodeMaterialSystemValues>;
  21352. set systemValue(value: Nullable<NodeMaterialSystemValues>);
  21353. /**
  21354. * Gets the current class name
  21355. * @returns the class name
  21356. */
  21357. getClassName(): string;
  21358. /**
  21359. * Animate the input if animationType !== None
  21360. * @param scene defines the rendering scene
  21361. */
  21362. animate(scene: Scene): void;
  21363. private _emitDefine;
  21364. initialize(state: NodeMaterialBuildState): void;
  21365. /**
  21366. * Set the input block to its default value (based on its type)
  21367. */
  21368. setDefaultValue(): void;
  21369. private _emitConstant;
  21370. /** @hidden */
  21371. get _noContextSwitch(): boolean;
  21372. private _emit;
  21373. /** @hidden */
  21374. _transmitWorld(effect: Effect, world: Matrix, worldView: Matrix, worldViewProjection: Matrix): void;
  21375. /** @hidden */
  21376. _transmit(effect: Effect, scene: Scene): void;
  21377. protected _buildBlock(state: NodeMaterialBuildState): void;
  21378. protected _dumpPropertiesCode(): string;
  21379. dispose(): void;
  21380. serialize(): any;
  21381. _deserialize(serializationObject: any, scene: Scene, rootUrl: string): void;
  21382. }
  21383. }
  21384. declare module "babylonjs/Materials/Node/nodeMaterialBlockConnectionPoint" {
  21385. import { NodeMaterialBlockConnectionPointTypes } from "babylonjs/Materials/Node/Enums/nodeMaterialBlockConnectionPointTypes";
  21386. import { NodeMaterialBlockTargets } from "babylonjs/Materials/Node/Enums/nodeMaterialBlockTargets";
  21387. import { Nullable } from "babylonjs/types";
  21388. import { InputBlock } from "babylonjs/Materials/Node/Blocks/Input/inputBlock";
  21389. import { Observable } from "babylonjs/Misc/observable";
  21390. import { NodeMaterialBlock } from "babylonjs/Materials/Node/nodeMaterialBlock";
  21391. /**
  21392. * Enum used to define the compatibility state between two connection points
  21393. */
  21394. export enum NodeMaterialConnectionPointCompatibilityStates {
  21395. /** Points are compatibles */
  21396. Compatible = 0,
  21397. /** Points are incompatible because of their types */
  21398. TypeIncompatible = 1,
  21399. /** Points are incompatible because of their targets (vertex vs fragment) */
  21400. TargetIncompatible = 2
  21401. }
  21402. /**
  21403. * Defines the direction of a connection point
  21404. */
  21405. export enum NodeMaterialConnectionPointDirection {
  21406. /** Input */
  21407. Input = 0,
  21408. /** Output */
  21409. Output = 1
  21410. }
  21411. /**
  21412. * Defines a connection point for a block
  21413. */
  21414. export class NodeMaterialConnectionPoint {
  21415. /** @hidden */
  21416. _ownerBlock: NodeMaterialBlock;
  21417. /** @hidden */
  21418. _connectedPoint: Nullable<NodeMaterialConnectionPoint>;
  21419. private _endpoints;
  21420. private _associatedVariableName;
  21421. private _direction;
  21422. /** @hidden */
  21423. _typeConnectionSource: Nullable<NodeMaterialConnectionPoint>;
  21424. /** @hidden */
  21425. _linkedConnectionSource: Nullable<NodeMaterialConnectionPoint>;
  21426. private _type;
  21427. /** @hidden */
  21428. _enforceAssociatedVariableName: boolean;
  21429. /** Gets the direction of the point */
  21430. get direction(): NodeMaterialConnectionPointDirection;
  21431. /** Indicates that this connection point needs dual validation before being connected to another point */
  21432. needDualDirectionValidation: boolean;
  21433. /**
  21434. * Gets or sets the additional types supported by this connection point
  21435. */
  21436. acceptedConnectionPointTypes: NodeMaterialBlockConnectionPointTypes[];
  21437. /**
  21438. * Gets or sets the additional types excluded by this connection point
  21439. */
  21440. excludedConnectionPointTypes: NodeMaterialBlockConnectionPointTypes[];
  21441. /**
  21442. * Observable triggered when this point is connected
  21443. */
  21444. onConnectionObservable: Observable<NodeMaterialConnectionPoint>;
  21445. /**
  21446. * Gets or sets the associated variable name in the shader
  21447. */
  21448. get associatedVariableName(): string;
  21449. set associatedVariableName(value: string);
  21450. /** Get the inner type (ie AutoDetect for instance instead of the inferred one) */
  21451. get innerType(): NodeMaterialBlockConnectionPointTypes;
  21452. /**
  21453. * Gets or sets the connection point type (default is float)
  21454. */
  21455. get type(): NodeMaterialBlockConnectionPointTypes;
  21456. set type(value: NodeMaterialBlockConnectionPointTypes);
  21457. /**
  21458. * Gets or sets the connection point name
  21459. */
  21460. name: string;
  21461. /**
  21462. * Gets or sets the connection point name
  21463. */
  21464. displayName: string;
  21465. /**
  21466. * Gets or sets a boolean indicating that this connection point can be omitted
  21467. */
  21468. isOptional: boolean;
  21469. /**
  21470. * Gets or sets a boolean indicating that this connection point is exposed on a frame
  21471. */
  21472. isExposedOnFrame: boolean;
  21473. /**
  21474. * Gets or sets number indicating the position that the port is exposed to on a frame
  21475. */
  21476. exposedPortPosition: number;
  21477. /**
  21478. * Gets or sets a string indicating that this uniform must be defined under a #ifdef
  21479. */
  21480. define: string;
  21481. /** @hidden */
  21482. _prioritizeVertex: boolean;
  21483. private _target;
  21484. /** Gets or sets the target of that connection point */
  21485. get target(): NodeMaterialBlockTargets;
  21486. set target(value: NodeMaterialBlockTargets);
  21487. /**
  21488. * Gets a boolean indicating that the current point is connected to another NodeMaterialBlock
  21489. */
  21490. get isConnected(): boolean;
  21491. /**
  21492. * Gets a boolean indicating that the current point is connected to an input block
  21493. */
  21494. get isConnectedToInputBlock(): boolean;
  21495. /**
  21496. * Gets a the connected input block (if any)
  21497. */
  21498. get connectInputBlock(): Nullable<InputBlock>;
  21499. /** Get the other side of the connection (if any) */
  21500. get connectedPoint(): Nullable<NodeMaterialConnectionPoint>;
  21501. /** Get the block that owns this connection point */
  21502. get ownerBlock(): NodeMaterialBlock;
  21503. /** Get the block connected on the other side of this connection (if any) */
  21504. get sourceBlock(): Nullable<NodeMaterialBlock>;
  21505. /** Get the block connected on the endpoints of this connection (if any) */
  21506. get connectedBlocks(): Array<NodeMaterialBlock>;
  21507. /** Gets the list of connected endpoints */
  21508. get endpoints(): NodeMaterialConnectionPoint[];
  21509. /** Gets a boolean indicating if that output point is connected to at least one input */
  21510. get hasEndpoints(): boolean;
  21511. /** Gets a boolean indicating that this connection will be used in the vertex shader */
  21512. get isConnectedInVertexShader(): boolean;
  21513. /** Gets a boolean indicating that this connection will be used in the fragment shader */
  21514. get isConnectedInFragmentShader(): boolean;
  21515. /**
  21516. * Creates a block suitable to be used as an input for this input point.
  21517. * If null is returned, a block based on the point type will be created.
  21518. * @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
  21519. */
  21520. createCustomInputBlock(): Nullable<[NodeMaterialBlock, string]>;
  21521. /**
  21522. * Creates a new connection point
  21523. * @param name defines the connection point name
  21524. * @param ownerBlock defines the block hosting this connection point
  21525. * @param direction defines the direction of the connection point
  21526. */
  21527. constructor(name: string, ownerBlock: NodeMaterialBlock, direction: NodeMaterialConnectionPointDirection);
  21528. /**
  21529. * Gets the current class name e.g. "NodeMaterialConnectionPoint"
  21530. * @returns the class name
  21531. */
  21532. getClassName(): string;
  21533. /**
  21534. * Gets a boolean indicating if the current point can be connected to another point
  21535. * @param connectionPoint defines the other connection point
  21536. * @returns a boolean
  21537. */
  21538. canConnectTo(connectionPoint: NodeMaterialConnectionPoint): boolean;
  21539. /**
  21540. * Gets a number indicating if the current point can be connected to another point
  21541. * @param connectionPoint defines the other connection point
  21542. * @returns a number defining the compatibility state
  21543. */
  21544. checkCompatibilityState(connectionPoint: NodeMaterialConnectionPoint): NodeMaterialConnectionPointCompatibilityStates;
  21545. /**
  21546. * Connect this point to another connection point
  21547. * @param connectionPoint defines the other connection point
  21548. * @param ignoreConstraints defines if the system will ignore connection type constraints (default is false)
  21549. * @returns the current connection point
  21550. */
  21551. connectTo(connectionPoint: NodeMaterialConnectionPoint, ignoreConstraints?: boolean): NodeMaterialConnectionPoint;
  21552. /**
  21553. * Disconnect this point from one of his endpoint
  21554. * @param endpoint defines the other connection point
  21555. * @returns the current connection point
  21556. */
  21557. disconnectFrom(endpoint: NodeMaterialConnectionPoint): NodeMaterialConnectionPoint;
  21558. /**
  21559. * Serializes this point in a JSON representation
  21560. * @param isInput defines if the connection point is an input (default is true)
  21561. * @returns the serialized point object
  21562. */
  21563. serialize(isInput?: boolean): any;
  21564. /**
  21565. * Release resources
  21566. */
  21567. dispose(): void;
  21568. }
  21569. }
  21570. declare module "babylonjs/Materials/Node/Enums/nodeMaterialModes" {
  21571. /**
  21572. * Enum used to define the material modes
  21573. */
  21574. export enum NodeMaterialModes {
  21575. /** Regular material */
  21576. Material = 0,
  21577. /** For post process */
  21578. PostProcess = 1,
  21579. /** For particle system */
  21580. Particle = 2,
  21581. /** For procedural texture */
  21582. ProceduralTexture = 3
  21583. }
  21584. }
  21585. declare module "babylonjs/Materials/Node/Blocks/Dual/textureBlock" {
  21586. import { NodeMaterialBlock } from "babylonjs/Materials/Node/nodeMaterialBlock";
  21587. import { NodeMaterialBuildState } from "babylonjs/Materials/Node/nodeMaterialBuildState";
  21588. import { NodeMaterialBlockTargets } from "babylonjs/Materials/Node/Enums/nodeMaterialBlockTargets";
  21589. import { NodeMaterialConnectionPoint } from "babylonjs/Materials/Node/nodeMaterialBlockConnectionPoint";
  21590. import { AbstractMesh } from "babylonjs/Meshes/abstractMesh";
  21591. import { NodeMaterial, NodeMaterialDefines } from "babylonjs/Materials/Node/nodeMaterial";
  21592. import { Effect } from "babylonjs/Materials/effect";
  21593. import { Mesh } from "babylonjs/Meshes/mesh";
  21594. import { Nullable } from "babylonjs/types";
  21595. import { Texture } from "babylonjs/Materials/Textures/texture";
  21596. import { Scene } from "babylonjs/scene";
  21597. import "babylonjs/Shaders/ShadersInclude/helperFunctions";
  21598. /**
  21599. * Block used to read a texture from a sampler
  21600. */
  21601. export class TextureBlock extends NodeMaterialBlock {
  21602. private _defineName;
  21603. private _linearDefineName;
  21604. private _gammaDefineName;
  21605. private _tempTextureRead;
  21606. private _samplerName;
  21607. private _transformedUVName;
  21608. private _textureTransformName;
  21609. private _textureInfoName;
  21610. private _mainUVName;
  21611. private _mainUVDefineName;
  21612. private _fragmentOnly;
  21613. /**
  21614. * Gets or sets the texture associated with the node
  21615. */
  21616. texture: Nullable<Texture>;
  21617. /**
  21618. * Gets or sets a boolean indicating if content needs to be converted to gamma space
  21619. */
  21620. convertToGammaSpace: boolean;
  21621. /**
  21622. * Gets or sets a boolean indicating if content needs to be converted to linear space
  21623. */
  21624. convertToLinearSpace: boolean;
  21625. /**
  21626. * Create a new TextureBlock
  21627. * @param name defines the block name
  21628. */
  21629. constructor(name: string, fragmentOnly?: boolean);
  21630. /**
  21631. * Gets the current class name
  21632. * @returns the class name
  21633. */
  21634. getClassName(): string;
  21635. /**
  21636. * Gets the uv input component
  21637. */
  21638. get uv(): NodeMaterialConnectionPoint;
  21639. /**
  21640. * Gets the rgba output component
  21641. */
  21642. get rgba(): NodeMaterialConnectionPoint;
  21643. /**
  21644. * Gets the rgb output component
  21645. */
  21646. get rgb(): NodeMaterialConnectionPoint;
  21647. /**
  21648. * Gets the r output component
  21649. */
  21650. get r(): NodeMaterialConnectionPoint;
  21651. /**
  21652. * Gets the g output component
  21653. */
  21654. get g(): NodeMaterialConnectionPoint;
  21655. /**
  21656. * Gets the b output component
  21657. */
  21658. get b(): NodeMaterialConnectionPoint;
  21659. /**
  21660. * Gets the a output component
  21661. */
  21662. get a(): NodeMaterialConnectionPoint;
  21663. get target(): NodeMaterialBlockTargets;
  21664. autoConfigure(material: NodeMaterial): void;
  21665. initializeDefines(mesh: AbstractMesh, nodeMaterial: NodeMaterial, defines: NodeMaterialDefines, useInstances?: boolean): void;
  21666. prepareDefines(mesh: AbstractMesh, nodeMaterial: NodeMaterial, defines: NodeMaterialDefines): void;
  21667. isReady(): boolean;
  21668. bind(effect: Effect, nodeMaterial: NodeMaterial, mesh?: Mesh): void;
  21669. private get _isMixed();
  21670. private _injectVertexCode;
  21671. private _writeTextureRead;
  21672. private _writeOutput;
  21673. protected _buildBlock(state: NodeMaterialBuildState): this | undefined;
  21674. protected _dumpPropertiesCode(): string;
  21675. serialize(): any;
  21676. _deserialize(serializationObject: any, scene: Scene, rootUrl: string): void;
  21677. }
  21678. }
  21679. declare module "babylonjs/Shaders/ShadersInclude/reflectionFunction" {
  21680. /** @hidden */
  21681. export var reflectionFunction: {
  21682. name: string;
  21683. shader: string;
  21684. };
  21685. }
  21686. declare module "babylonjs/Materials/Node/Blocks/Dual/reflectionTextureBaseBlock" {
  21687. import { NodeMaterialBlock } from "babylonjs/Materials/Node/nodeMaterialBlock";
  21688. import { NodeMaterialBuildState } from "babylonjs/Materials/Node/nodeMaterialBuildState";
  21689. import { NodeMaterialConnectionPoint } from "babylonjs/Materials/Node/nodeMaterialBlockConnectionPoint";
  21690. import { BaseTexture } from "babylonjs/Materials/Textures/baseTexture";
  21691. import { AbstractMesh } from "babylonjs/Meshes/abstractMesh";
  21692. import { NodeMaterial, NodeMaterialDefines } from "babylonjs/Materials/Node/nodeMaterial";
  21693. import { Effect } from "babylonjs/Materials/effect";
  21694. import { Mesh } from "babylonjs/Meshes/mesh";
  21695. import { Nullable } from "babylonjs/types";
  21696. import { Scene } from "babylonjs/scene";
  21697. import "babylonjs/Shaders/ShadersInclude/reflectionFunction";
  21698. /**
  21699. * Base block used to read a reflection texture from a sampler
  21700. */
  21701. export abstract class ReflectionTextureBaseBlock extends NodeMaterialBlock {
  21702. /** @hidden */
  21703. _define3DName: string;
  21704. /** @hidden */
  21705. _defineCubicName: string;
  21706. /** @hidden */
  21707. _defineExplicitName: string;
  21708. /** @hidden */
  21709. _defineProjectionName: string;
  21710. /** @hidden */
  21711. _defineLocalCubicName: string;
  21712. /** @hidden */
  21713. _defineSphericalName: string;
  21714. /** @hidden */
  21715. _definePlanarName: string;
  21716. /** @hidden */
  21717. _defineEquirectangularName: string;
  21718. /** @hidden */
  21719. _defineMirroredEquirectangularFixedName: string;
  21720. /** @hidden */
  21721. _defineEquirectangularFixedName: string;
  21722. /** @hidden */
  21723. _defineSkyboxName: string;
  21724. /** @hidden */
  21725. _defineOppositeZ: string;
  21726. /** @hidden */
  21727. _cubeSamplerName: string;
  21728. /** @hidden */
  21729. _2DSamplerName: string;
  21730. protected _positionUVWName: string;
  21731. protected _directionWName: string;
  21732. protected _reflectionVectorName: string;
  21733. /** @hidden */
  21734. _reflectionCoordsName: string;
  21735. /** @hidden */
  21736. _reflectionMatrixName: string;
  21737. protected _reflectionColorName: string;
  21738. /**
  21739. * Gets or sets the texture associated with the node
  21740. */
  21741. texture: Nullable<BaseTexture>;
  21742. /**
  21743. * Create a new ReflectionTextureBaseBlock
  21744. * @param name defines the block name
  21745. */
  21746. constructor(name: string);
  21747. /**
  21748. * Gets the current class name
  21749. * @returns the class name
  21750. */
  21751. getClassName(): string;
  21752. /**
  21753. * Gets the world position input component
  21754. */
  21755. abstract get position(): NodeMaterialConnectionPoint;
  21756. /**
  21757. * Gets the world position input component
  21758. */
  21759. abstract get worldPosition(): NodeMaterialConnectionPoint;
  21760. /**
  21761. * Gets the world normal input component
  21762. */
  21763. abstract get worldNormal(): NodeMaterialConnectionPoint;
  21764. /**
  21765. * Gets the world input component
  21766. */
  21767. abstract get world(): NodeMaterialConnectionPoint;
  21768. /**
  21769. * Gets the camera (or eye) position component
  21770. */
  21771. abstract get cameraPosition(): NodeMaterialConnectionPoint;
  21772. /**
  21773. * Gets the view input component
  21774. */
  21775. abstract get view(): NodeMaterialConnectionPoint;
  21776. protected _getTexture(): Nullable<BaseTexture>;
  21777. autoConfigure(material: NodeMaterial): void;
  21778. prepareDefines(mesh: AbstractMesh, nodeMaterial: NodeMaterial, defines: NodeMaterialDefines): void;
  21779. isReady(): boolean;
  21780. bind(effect: Effect, nodeMaterial: NodeMaterial, mesh?: Mesh): void;
  21781. /**
  21782. * Gets the code to inject in the vertex shader
  21783. * @param state current state of the node material building
  21784. * @returns the shader code
  21785. */
  21786. handleVertexSide(state: NodeMaterialBuildState): string;
  21787. /**
  21788. * Handles the inits for the fragment code path
  21789. * @param state node material build state
  21790. */
  21791. handleFragmentSideInits(state: NodeMaterialBuildState): void;
  21792. /**
  21793. * Generates the reflection coords code for the fragment code path
  21794. * @param worldNormalVarName name of the world normal variable
  21795. * @param worldPos name of the world position variable. If not provided, will use the world position connected to this block
  21796. * @param onlyReflectionVector if true, generates code only for the reflection vector computation, not for the reflection coordinates
  21797. * @returns the shader code
  21798. */
  21799. handleFragmentSideCodeReflectionCoords(worldNormalVarName: string, worldPos?: string, onlyReflectionVector?: boolean): string;
  21800. /**
  21801. * Generates the reflection color code for the fragment code path
  21802. * @param lodVarName name of the lod variable
  21803. * @param swizzleLookupTexture swizzle to use for the final color variable
  21804. * @returns the shader code
  21805. */
  21806. handleFragmentSideCodeReflectionColor(lodVarName?: string, swizzleLookupTexture?: string): string;
  21807. /**
  21808. * Generates the code corresponding to the connected output points
  21809. * @param state node material build state
  21810. * @param varName name of the variable to output
  21811. * @returns the shader code
  21812. */
  21813. writeOutputs(state: NodeMaterialBuildState, varName: string): string;
  21814. protected _buildBlock(state: NodeMaterialBuildState): this;
  21815. protected _dumpPropertiesCode(): string;
  21816. serialize(): any;
  21817. _deserialize(serializationObject: any, scene: Scene, rootUrl: string): void;
  21818. }
  21819. }
  21820. declare module "babylonjs/Materials/Node/nodeMaterialConnectionPointCustomObject" {
  21821. import { NodeMaterialBlock } from "babylonjs/Materials/Node/nodeMaterialBlock";
  21822. import { NodeMaterialConnectionPoint, NodeMaterialConnectionPointDirection, NodeMaterialConnectionPointCompatibilityStates } from "babylonjs/Materials/Node/nodeMaterialBlockConnectionPoint";
  21823. import { Nullable } from "babylonjs/types";
  21824. /**
  21825. * Defines a connection point to be used for points with a custom object type
  21826. */
  21827. export class NodeMaterialConnectionPointCustomObject<T extends NodeMaterialBlock> extends NodeMaterialConnectionPoint {
  21828. private _blockType;
  21829. private _blockName;
  21830. private _nameForCheking?;
  21831. /**
  21832. * Creates a new connection point
  21833. * @param name defines the connection point name
  21834. * @param ownerBlock defines the block hosting this connection point
  21835. * @param direction defines the direction of the connection point
  21836. */
  21837. constructor(name: string, ownerBlock: NodeMaterialBlock, direction: NodeMaterialConnectionPointDirection, _blockType: new (...args: any[]) => T, _blockName: string, _nameForCheking?: string | undefined);
  21838. /**
  21839. * Gets a number indicating if the current point can be connected to another point
  21840. * @param connectionPoint defines the other connection point
  21841. * @returns a number defining the compatibility state
  21842. */
  21843. checkCompatibilityState(connectionPoint: NodeMaterialConnectionPoint): NodeMaterialConnectionPointCompatibilityStates;
  21844. /**
  21845. * Creates a block suitable to be used as an input for this input point.
  21846. * If null is returned, a block based on the point type will be created.
  21847. * @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
  21848. */
  21849. createCustomInputBlock(): Nullable<[NodeMaterialBlock, string]>;
  21850. }
  21851. }
  21852. declare module "babylonjs/Materials/Node/nodeMaterialDecorator" {
  21853. /**
  21854. * Enum defining the type of properties that can be edited in the property pages in the NME
  21855. */
  21856. export enum PropertyTypeForEdition {
  21857. /** property is a boolean */
  21858. Boolean = 0,
  21859. /** property is a float */
  21860. Float = 1,
  21861. /** property is a Vector2 */
  21862. Vector2 = 2,
  21863. /** property is a list of values */
  21864. List = 3
  21865. }
  21866. /**
  21867. * Interface that defines an option in a variable of type list
  21868. */
  21869. export interface IEditablePropertyListOption {
  21870. /** label of the option */
  21871. "label": string;
  21872. /** value of the option */
  21873. "value": number;
  21874. }
  21875. /**
  21876. * Interface that defines the options available for an editable property
  21877. */
  21878. export interface IEditablePropertyOption {
  21879. /** min value */
  21880. "min"?: number;
  21881. /** max value */
  21882. "max"?: number;
  21883. /** notifiers: indicates which actions to take when the property is changed */
  21884. "notifiers"?: {
  21885. /** the material should be rebuilt */
  21886. "rebuild"?: boolean;
  21887. /** the preview should be updated */
  21888. "update"?: boolean;
  21889. };
  21890. /** list of the options for a variable of type list */
  21891. "options"?: IEditablePropertyListOption[];
  21892. }
  21893. /**
  21894. * Interface that describes an editable property
  21895. */
  21896. export interface IPropertyDescriptionForEdition {
  21897. /** name of the property */
  21898. "propertyName": string;
  21899. /** display name of the property */
  21900. "displayName": string;
  21901. /** type of the property */
  21902. "type": PropertyTypeForEdition;
  21903. /** group of the property - all properties with the same group value will be displayed in a specific section */
  21904. "groupName": string;
  21905. /** options for the property */
  21906. "options": IEditablePropertyOption;
  21907. }
  21908. /**
  21909. * Decorator that flags a property in a node material block as being editable
  21910. */
  21911. export function editableInPropertyPage(displayName: string, propertyType?: PropertyTypeForEdition, groupName?: string, options?: IEditablePropertyOption): (target: any, propertyKey: string) => void;
  21912. }
  21913. declare module "babylonjs/Materials/Node/Blocks/PBR/refractionBlock" {
  21914. import { NodeMaterialBuildState } from "babylonjs/Materials/Node/nodeMaterialBuildState";
  21915. import { NodeMaterialConnectionPoint } from "babylonjs/Materials/Node/nodeMaterialBlockConnectionPoint";
  21916. import { NodeMaterial, NodeMaterialDefines } from "babylonjs/Materials/Node/nodeMaterial";
  21917. import { AbstractMesh } from "babylonjs/Meshes/abstractMesh";
  21918. import { Nullable } from "babylonjs/types";
  21919. import { BaseTexture } from "babylonjs/Materials/Textures/baseTexture";
  21920. import { Mesh } from "babylonjs/Meshes/mesh";
  21921. import { SubMesh } from "babylonjs/Meshes/subMesh";
  21922. import { Effect } from "babylonjs/Materials/effect";
  21923. import { Scene } from "babylonjs/scene";
  21924. import { NodeMaterialBlock } from "babylonjs/Materials/Node/nodeMaterialBlock";
  21925. /**
  21926. * Block used to implement the refraction part of the sub surface module of the PBR material
  21927. */
  21928. export class RefractionBlock extends NodeMaterialBlock {
  21929. /** @hidden */
  21930. _define3DName: string;
  21931. /** @hidden */
  21932. _refractionMatrixName: string;
  21933. /** @hidden */
  21934. _defineLODRefractionAlpha: string;
  21935. /** @hidden */
  21936. _defineLinearSpecularRefraction: string;
  21937. /** @hidden */
  21938. _defineOppositeZ: string;
  21939. /** @hidden */
  21940. _cubeSamplerName: string;
  21941. /** @hidden */
  21942. _2DSamplerName: string;
  21943. /** @hidden */
  21944. _vRefractionMicrosurfaceInfosName: string;
  21945. /** @hidden */
  21946. _vRefractionInfosName: string;
  21947. private _scene;
  21948. /**
  21949. * This parameters will make the material used its opacity to control how much it is refracting aginst not.
  21950. * Materials half opaque for instance using refraction could benefit from this control.
  21951. */
  21952. linkRefractionWithTransparency: boolean;
  21953. /**
  21954. * Controls if refraction needs to be inverted on Y. This could be useful for procedural texture.
  21955. */
  21956. invertRefractionY: boolean;
  21957. /**
  21958. * Gets or sets the texture associated with the node
  21959. */
  21960. texture: Nullable<BaseTexture>;
  21961. /**
  21962. * Create a new RefractionBlock
  21963. * @param name defines the block name
  21964. */
  21965. constructor(name: string);
  21966. /**
  21967. * Gets the current class name
  21968. * @returns the class name
  21969. */
  21970. getClassName(): string;
  21971. /**
  21972. * Gets the intensity input component
  21973. */
  21974. get intensity(): NodeMaterialConnectionPoint;
  21975. /**
  21976. * Gets the index of refraction input component
  21977. */
  21978. get indexOfRefraction(): NodeMaterialConnectionPoint;
  21979. /**
  21980. * Gets the tint at distance input component
  21981. */
  21982. get tintAtDistance(): NodeMaterialConnectionPoint;
  21983. /**
  21984. * Gets the view input component
  21985. */
  21986. get view(): NodeMaterialConnectionPoint;
  21987. /**
  21988. * Gets the refraction object output component
  21989. */
  21990. get refraction(): NodeMaterialConnectionPoint;
  21991. /**
  21992. * Returns true if the block has a texture
  21993. */
  21994. get hasTexture(): boolean;
  21995. protected _getTexture(): Nullable<BaseTexture>;
  21996. autoConfigure(material: NodeMaterial): void;
  21997. prepareDefines(mesh: AbstractMesh, nodeMaterial: NodeMaterial, defines: NodeMaterialDefines): void;
  21998. isReady(): boolean;
  21999. bind(effect: Effect, nodeMaterial: NodeMaterial, mesh?: Mesh, subMesh?: SubMesh): void;
  22000. /**
  22001. * Gets the main code of the block (fragment side)
  22002. * @param state current state of the node material building
  22003. * @returns the shader code
  22004. */
  22005. getCode(state: NodeMaterialBuildState): string;
  22006. protected _buildBlock(state: NodeMaterialBuildState): this;
  22007. protected _dumpPropertiesCode(): string;
  22008. serialize(): any;
  22009. _deserialize(serializationObject: any, scene: Scene, rootUrl: string): void;
  22010. }
  22011. }
  22012. declare module "babylonjs/Materials/Node/Blocks/Dual/currentScreenBlock" {
  22013. import { NodeMaterialBlock } from "babylonjs/Materials/Node/nodeMaterialBlock";
  22014. import { NodeMaterialBuildState } from "babylonjs/Materials/Node/nodeMaterialBuildState";
  22015. import { NodeMaterialBlockTargets } from "babylonjs/Materials/Node/Enums/nodeMaterialBlockTargets";
  22016. import { NodeMaterialConnectionPoint } from "babylonjs/Materials/Node/nodeMaterialBlockConnectionPoint";
  22017. import { AbstractMesh } from "babylonjs/Meshes/abstractMesh";
  22018. import { NodeMaterialDefines } from "babylonjs/Materials/Node/nodeMaterial";
  22019. import { BaseTexture } from "babylonjs/Materials/Textures/baseTexture";
  22020. import { Nullable } from "babylonjs/types";
  22021. import { Scene } from "babylonjs/scene";
  22022. import { NodeMaterial } from "babylonjs/Materials/Node/nodeMaterial";
  22023. /**
  22024. * Base block used as input for post process
  22025. */
  22026. export class CurrentScreenBlock extends NodeMaterialBlock {
  22027. private _samplerName;
  22028. private _linearDefineName;
  22029. private _gammaDefineName;
  22030. private _mainUVName;
  22031. private _tempTextureRead;
  22032. /**
  22033. * Gets or sets the texture associated with the node
  22034. */
  22035. texture: Nullable<BaseTexture>;
  22036. /**
  22037. * Gets or sets a boolean indicating if content needs to be converted to gamma space
  22038. */
  22039. convertToGammaSpace: boolean;
  22040. /**
  22041. * Gets or sets a boolean indicating if content needs to be converted to linear space
  22042. */
  22043. convertToLinearSpace: boolean;
  22044. /**
  22045. * Create a new CurrentScreenBlock
  22046. * @param name defines the block name
  22047. */
  22048. constructor(name: string);
  22049. /**
  22050. * Gets the current class name
  22051. * @returns the class name
  22052. */
  22053. getClassName(): string;
  22054. /**
  22055. * Gets the uv input component
  22056. */
  22057. get uv(): NodeMaterialConnectionPoint;
  22058. /**
  22059. * Gets the rgba output component
  22060. */
  22061. get rgba(): NodeMaterialConnectionPoint;
  22062. /**
  22063. * Gets the rgb output component
  22064. */
  22065. get rgb(): NodeMaterialConnectionPoint;
  22066. /**
  22067. * Gets the r output component
  22068. */
  22069. get r(): NodeMaterialConnectionPoint;
  22070. /**
  22071. * Gets the g output component
  22072. */
  22073. get g(): NodeMaterialConnectionPoint;
  22074. /**
  22075. * Gets the b output component
  22076. */
  22077. get b(): NodeMaterialConnectionPoint;
  22078. /**
  22079. * Gets the a output component
  22080. */
  22081. get a(): NodeMaterialConnectionPoint;
  22082. /**
  22083. * Initialize the block and prepare the context for build
  22084. * @param state defines the state that will be used for the build
  22085. */
  22086. initialize(state: NodeMaterialBuildState): void;
  22087. get target(): NodeMaterialBlockTargets;
  22088. prepareDefines(mesh: AbstractMesh, nodeMaterial: NodeMaterial, defines: NodeMaterialDefines): void;
  22089. isReady(): boolean;
  22090. private _injectVertexCode;
  22091. private _writeTextureRead;
  22092. private _writeOutput;
  22093. protected _buildBlock(state: NodeMaterialBuildState): this | undefined;
  22094. serialize(): any;
  22095. _deserialize(serializationObject: any, scene: Scene, rootUrl: string): void;
  22096. }
  22097. }
  22098. declare module "babylonjs/Materials/Node/Blocks/Particle/particleTextureBlock" {
  22099. import { NodeMaterialBlock } from "babylonjs/Materials/Node/nodeMaterialBlock";
  22100. import { NodeMaterialBuildState } from "babylonjs/Materials/Node/nodeMaterialBuildState";
  22101. import { NodeMaterialConnectionPoint } from "babylonjs/Materials/Node/nodeMaterialBlockConnectionPoint";
  22102. import { AbstractMesh } from "babylonjs/Meshes/abstractMesh";
  22103. import { NodeMaterialDefines } from "babylonjs/Materials/Node/nodeMaterial";
  22104. import { BaseTexture } from "babylonjs/Materials/Textures/baseTexture";
  22105. import { Nullable } from "babylonjs/types";
  22106. import { Scene } from "babylonjs/scene";
  22107. import { NodeMaterial } from "babylonjs/Materials/Node/nodeMaterial";
  22108. /**
  22109. * Base block used for the particle texture
  22110. */
  22111. export class ParticleTextureBlock extends NodeMaterialBlock {
  22112. private _samplerName;
  22113. private _linearDefineName;
  22114. private _gammaDefineName;
  22115. private _tempTextureRead;
  22116. /**
  22117. * Gets or sets the texture associated with the node
  22118. */
  22119. texture: Nullable<BaseTexture>;
  22120. /**
  22121. * Gets or sets a boolean indicating if content needs to be converted to gamma space
  22122. */
  22123. convertToGammaSpace: boolean;
  22124. /**
  22125. * Gets or sets a boolean indicating if content needs to be converted to linear space
  22126. */
  22127. convertToLinearSpace: boolean;
  22128. /**
  22129. * Create a new ParticleTextureBlock
  22130. * @param name defines the block name
  22131. */
  22132. constructor(name: string);
  22133. /**
  22134. * Gets the current class name
  22135. * @returns the class name
  22136. */
  22137. getClassName(): string;
  22138. /**
  22139. * Gets the uv input component
  22140. */
  22141. get uv(): NodeMaterialConnectionPoint;
  22142. /**
  22143. * Gets the rgba output component
  22144. */
  22145. get rgba(): NodeMaterialConnectionPoint;
  22146. /**
  22147. * Gets the rgb output component
  22148. */
  22149. get rgb(): NodeMaterialConnectionPoint;
  22150. /**
  22151. * Gets the r output component
  22152. */
  22153. get r(): NodeMaterialConnectionPoint;
  22154. /**
  22155. * Gets the g output component
  22156. */
  22157. get g(): NodeMaterialConnectionPoint;
  22158. /**
  22159. * Gets the b output component
  22160. */
  22161. get b(): NodeMaterialConnectionPoint;
  22162. /**
  22163. * Gets the a output component
  22164. */
  22165. get a(): NodeMaterialConnectionPoint;
  22166. /**
  22167. * Initialize the block and prepare the context for build
  22168. * @param state defines the state that will be used for the build
  22169. */
  22170. initialize(state: NodeMaterialBuildState): void;
  22171. autoConfigure(material: NodeMaterial): void;
  22172. prepareDefines(mesh: AbstractMesh, nodeMaterial: NodeMaterial, defines: NodeMaterialDefines): void;
  22173. isReady(): boolean;
  22174. private _writeOutput;
  22175. protected _buildBlock(state: NodeMaterialBuildState): this | undefined;
  22176. serialize(): any;
  22177. _deserialize(serializationObject: any, scene: Scene, rootUrl: string): void;
  22178. }
  22179. }
  22180. declare module "babylonjs/Materials/Node/nodeMaterialBuildStateSharedData" {
  22181. import { NodeMaterialConnectionPoint } from "babylonjs/Materials/Node/nodeMaterialBlockConnectionPoint";
  22182. import { NodeMaterialBlock } from "babylonjs/Materials/Node/nodeMaterialBlock";
  22183. import { InputBlock } from "babylonjs/Materials/Node/Blocks/Input/inputBlock";
  22184. import { TextureBlock } from "babylonjs/Materials/Node/Blocks/Dual/textureBlock";
  22185. import { ReflectionTextureBaseBlock } from "babylonjs/Materials/Node/Blocks/Dual/reflectionTextureBaseBlock";
  22186. import { RefractionBlock } from "babylonjs/Materials/Node/Blocks/PBR/refractionBlock";
  22187. import { CurrentScreenBlock } from "babylonjs/Materials/Node/Blocks/Dual/currentScreenBlock";
  22188. import { ParticleTextureBlock } from "babylonjs/Materials/Node/Blocks/Particle/particleTextureBlock";
  22189. import { Scene } from "babylonjs/scene";
  22190. /**
  22191. * Class used to store shared data between 2 NodeMaterialBuildState
  22192. */
  22193. export class NodeMaterialBuildStateSharedData {
  22194. /**
  22195. * Gets the list of emitted varyings
  22196. */
  22197. temps: string[];
  22198. /**
  22199. * Gets the list of emitted varyings
  22200. */
  22201. varyings: string[];
  22202. /**
  22203. * Gets the varying declaration string
  22204. */
  22205. varyingDeclaration: string;
  22206. /**
  22207. * Input blocks
  22208. */
  22209. inputBlocks: InputBlock[];
  22210. /**
  22211. * Input blocks
  22212. */
  22213. textureBlocks: (TextureBlock | ReflectionTextureBaseBlock | RefractionBlock | CurrentScreenBlock | ParticleTextureBlock)[];
  22214. /**
  22215. * Bindable blocks (Blocks that need to set data to the effect)
  22216. */
  22217. bindableBlocks: NodeMaterialBlock[];
  22218. /**
  22219. * List of blocks that can provide a compilation fallback
  22220. */
  22221. blocksWithFallbacks: NodeMaterialBlock[];
  22222. /**
  22223. * List of blocks that can provide a define update
  22224. */
  22225. blocksWithDefines: NodeMaterialBlock[];
  22226. /**
  22227. * List of blocks that can provide a repeatable content
  22228. */
  22229. repeatableContentBlocks: NodeMaterialBlock[];
  22230. /**
  22231. * List of blocks that can provide a dynamic list of uniforms
  22232. */
  22233. dynamicUniformBlocks: NodeMaterialBlock[];
  22234. /**
  22235. * List of blocks that can block the isReady function for the material
  22236. */
  22237. blockingBlocks: NodeMaterialBlock[];
  22238. /**
  22239. * Gets the list of animated inputs
  22240. */
  22241. animatedInputs: InputBlock[];
  22242. /**
  22243. * Build Id used to avoid multiple recompilations
  22244. */
  22245. buildId: number;
  22246. /** List of emitted variables */
  22247. variableNames: {
  22248. [key: string]: number;
  22249. };
  22250. /** List of emitted defines */
  22251. defineNames: {
  22252. [key: string]: number;
  22253. };
  22254. /** Should emit comments? */
  22255. emitComments: boolean;
  22256. /** Emit build activity */
  22257. verbose: boolean;
  22258. /** Gets or sets the hosting scene */
  22259. scene: Scene;
  22260. /**
  22261. * Gets the compilation hints emitted at compilation time
  22262. */
  22263. hints: {
  22264. needWorldViewMatrix: boolean;
  22265. needWorldViewProjectionMatrix: boolean;
  22266. needAlphaBlending: boolean;
  22267. needAlphaTesting: boolean;
  22268. };
  22269. /**
  22270. * List of compilation checks
  22271. */
  22272. checks: {
  22273. emitVertex: boolean;
  22274. emitFragment: boolean;
  22275. notConnectedNonOptionalInputs: NodeMaterialConnectionPoint[];
  22276. };
  22277. /**
  22278. * Is vertex program allowed to be empty?
  22279. */
  22280. allowEmptyVertexProgram: boolean;
  22281. /** Creates a new shared data */
  22282. constructor();
  22283. /**
  22284. * Emits console errors and exceptions if there is a failing check
  22285. */
  22286. emitErrors(): void;
  22287. }
  22288. }
  22289. declare module "babylonjs/Materials/Node/nodeMaterialBuildState" {
  22290. import { NodeMaterialBlockConnectionPointTypes } from "babylonjs/Materials/Node/Enums/nodeMaterialBlockConnectionPointTypes";
  22291. import { NodeMaterialBlockTargets } from "babylonjs/Materials/Node/Enums/nodeMaterialBlockTargets";
  22292. import { NodeMaterialBuildStateSharedData } from "babylonjs/Materials/Node/nodeMaterialBuildStateSharedData";
  22293. /**
  22294. * Class used to store node based material build state
  22295. */
  22296. export class NodeMaterialBuildState {
  22297. /** Gets or sets a boolean indicating if the current state can emit uniform buffers */
  22298. supportUniformBuffers: boolean;
  22299. /**
  22300. * Gets the list of emitted attributes
  22301. */
  22302. attributes: string[];
  22303. /**
  22304. * Gets the list of emitted uniforms
  22305. */
  22306. uniforms: string[];
  22307. /**
  22308. * Gets the list of emitted constants
  22309. */
  22310. constants: string[];
  22311. /**
  22312. * Gets the list of emitted samplers
  22313. */
  22314. samplers: string[];
  22315. /**
  22316. * Gets the list of emitted functions
  22317. */
  22318. functions: {
  22319. [key: string]: string;
  22320. };
  22321. /**
  22322. * Gets the list of emitted extensions
  22323. */
  22324. extensions: {
  22325. [key: string]: string;
  22326. };
  22327. /**
  22328. * Gets the target of the compilation state
  22329. */
  22330. target: NodeMaterialBlockTargets;
  22331. /**
  22332. * Gets the list of emitted counters
  22333. */
  22334. counters: {
  22335. [key: string]: number;
  22336. };
  22337. /**
  22338. * Shared data between multiple NodeMaterialBuildState instances
  22339. */
  22340. sharedData: NodeMaterialBuildStateSharedData;
  22341. /** @hidden */
  22342. _vertexState: NodeMaterialBuildState;
  22343. /** @hidden */
  22344. _attributeDeclaration: string;
  22345. /** @hidden */
  22346. _uniformDeclaration: string;
  22347. /** @hidden */
  22348. _constantDeclaration: string;
  22349. /** @hidden */
  22350. _samplerDeclaration: string;
  22351. /** @hidden */
  22352. _varyingTransfer: string;
  22353. /** @hidden */
  22354. _injectAtEnd: string;
  22355. private _repeatableContentAnchorIndex;
  22356. /** @hidden */
  22357. _builtCompilationString: string;
  22358. /**
  22359. * Gets the emitted compilation strings
  22360. */
  22361. compilationString: string;
  22362. /**
  22363. * Finalize the compilation strings
  22364. * @param state defines the current compilation state
  22365. */
  22366. finalize(state: NodeMaterialBuildState): void;
  22367. /** @hidden */
  22368. get _repeatableContentAnchor(): string;
  22369. /** @hidden */
  22370. _getFreeVariableName(prefix: string): string;
  22371. /** @hidden */
  22372. _getFreeDefineName(prefix: string): string;
  22373. /** @hidden */
  22374. _excludeVariableName(name: string): void;
  22375. /** @hidden */
  22376. _emit2DSampler(name: string): void;
  22377. /** @hidden */
  22378. _getGLType(type: NodeMaterialBlockConnectionPointTypes): string;
  22379. /** @hidden */
  22380. _emitExtension(name: string, extension: string, define?: string): void;
  22381. /** @hidden */
  22382. _emitFunction(name: string, code: string, comments: string): void;
  22383. /** @hidden */
  22384. _emitCodeFromInclude(includeName: string, comments: string, options?: {
  22385. replaceStrings?: {
  22386. search: RegExp;
  22387. replace: string;
  22388. }[];
  22389. repeatKey?: string;
  22390. }): string;
  22391. /** @hidden */
  22392. _emitFunctionFromInclude(includeName: string, comments: string, options?: {
  22393. repeatKey?: string;
  22394. removeAttributes?: boolean;
  22395. removeUniforms?: boolean;
  22396. removeVaryings?: boolean;
  22397. removeIfDef?: boolean;
  22398. replaceStrings?: {
  22399. search: RegExp;
  22400. replace: string;
  22401. }[];
  22402. }, storeKey?: string): void;
  22403. /** @hidden */
  22404. _registerTempVariable(name: string): boolean;
  22405. /** @hidden */
  22406. _emitVaryingFromString(name: string, type: string, define?: string, notDefine?: boolean): boolean;
  22407. /** @hidden */
  22408. _emitUniformFromString(name: string, type: string, define?: string, notDefine?: boolean): void;
  22409. /** @hidden */
  22410. _emitFloat(value: number): string;
  22411. }
  22412. }
  22413. declare module "babylonjs/Misc/uniqueIdGenerator" {
  22414. /**
  22415. * Helper class used to generate session unique ID
  22416. */
  22417. export class UniqueIdGenerator {
  22418. private static _UniqueIdCounter;
  22419. /**
  22420. * Gets an unique (relatively to the current scene) Id
  22421. */
  22422. static get UniqueId(): number;
  22423. }
  22424. }
  22425. declare module "babylonjs/Materials/Node/nodeMaterialBlock" {
  22426. import { NodeMaterialBlockConnectionPointTypes } from "babylonjs/Materials/Node/Enums/nodeMaterialBlockConnectionPointTypes";
  22427. import { NodeMaterialBuildState } from "babylonjs/Materials/Node/nodeMaterialBuildState";
  22428. import { Nullable } from "babylonjs/types";
  22429. import { NodeMaterialConnectionPoint } from "babylonjs/Materials/Node/nodeMaterialBlockConnectionPoint";
  22430. import { NodeMaterialBlockTargets } from "babylonjs/Materials/Node/Enums/nodeMaterialBlockTargets";
  22431. import { Effect } from "babylonjs/Materials/effect";
  22432. import { AbstractMesh } from "babylonjs/Meshes/abstractMesh";
  22433. import { Mesh } from "babylonjs/Meshes/mesh";
  22434. import { SubMesh } from "babylonjs/Meshes/subMesh";
  22435. import { NodeMaterial, NodeMaterialDefines } from "babylonjs/Materials/Node/nodeMaterial";
  22436. import { Scene } from "babylonjs/scene";
  22437. import { EffectFallbacks } from "babylonjs/Materials/effectFallbacks";
  22438. /**
  22439. * Defines a block that can be used inside a node based material
  22440. */
  22441. export class NodeMaterialBlock {
  22442. private _buildId;
  22443. private _buildTarget;
  22444. private _target;
  22445. private _isFinalMerger;
  22446. private _isInput;
  22447. private _name;
  22448. protected _isUnique: boolean;
  22449. /** Gets or sets a boolean indicating that only one input can be connected at a time */
  22450. inputsAreExclusive: boolean;
  22451. /** @hidden */
  22452. _codeVariableName: string;
  22453. /** @hidden */
  22454. _inputs: NodeMaterialConnectionPoint[];
  22455. /** @hidden */
  22456. _outputs: NodeMaterialConnectionPoint[];
  22457. /** @hidden */
  22458. _preparationId: number;
  22459. /**
  22460. * Gets the name of the block
  22461. */
  22462. get name(): string;
  22463. /**
  22464. * Sets the name of the block. Will check if the name is valid.
  22465. */
  22466. set name(newName: string);
  22467. /**
  22468. * Gets or sets the unique id of the node
  22469. */
  22470. uniqueId: number;
  22471. /**
  22472. * Gets or sets the comments associated with this block
  22473. */
  22474. comments: string;
  22475. /**
  22476. * Gets a boolean indicating that this block can only be used once per NodeMaterial
  22477. */
  22478. get isUnique(): boolean;
  22479. /**
  22480. * Gets a boolean indicating that this block is an end block (e.g. it is generating a system value)
  22481. */
  22482. get isFinalMerger(): boolean;
  22483. /**
  22484. * Gets a boolean indicating that this block is an input (e.g. it sends data to the shader)
  22485. */
  22486. get isInput(): boolean;
  22487. /**
  22488. * Gets or sets the build Id
  22489. */
  22490. get buildId(): number;
  22491. set buildId(value: number);
  22492. /**
  22493. * Gets or sets the target of the block
  22494. */
  22495. get target(): NodeMaterialBlockTargets;
  22496. set target(value: NodeMaterialBlockTargets);
  22497. /**
  22498. * Gets the list of input points
  22499. */
  22500. get inputs(): NodeMaterialConnectionPoint[];
  22501. /** Gets the list of output points */
  22502. get outputs(): NodeMaterialConnectionPoint[];
  22503. /**
  22504. * Find an input by its name
  22505. * @param name defines the name of the input to look for
  22506. * @returns the input or null if not found
  22507. */
  22508. getInputByName(name: string): Nullable<NodeMaterialConnectionPoint>;
  22509. /**
  22510. * Find an output by its name
  22511. * @param name defines the name of the outputto look for
  22512. * @returns the output or null if not found
  22513. */
  22514. getOutputByName(name: string): Nullable<NodeMaterialConnectionPoint>;
  22515. /** Gets or sets a boolean indicating that this input can be edited in the Inspector (false by default) */
  22516. visibleInInspector: boolean;
  22517. /**
  22518. * Creates a new NodeMaterialBlock
  22519. * @param name defines the block name
  22520. * @param target defines the target of that block (Vertex by default)
  22521. * @param isFinalMerger defines a boolean indicating that this block is an end block (e.g. it is generating a system value). Default is false
  22522. * @param isInput defines a boolean indicating that this block is an input (e.g. it sends data to the shader). Default is false
  22523. */
  22524. constructor(name: string, target?: NodeMaterialBlockTargets, isFinalMerger?: boolean, isInput?: boolean);
  22525. /**
  22526. * Initialize the block and prepare the context for build
  22527. * @param state defines the state that will be used for the build
  22528. */
  22529. initialize(state: NodeMaterialBuildState): void;
  22530. /**
  22531. * Bind data to effect. Will only be called for blocks with isBindable === true
  22532. * @param effect defines the effect to bind data to
  22533. * @param nodeMaterial defines the hosting NodeMaterial
  22534. * @param mesh defines the mesh that will be rendered
  22535. * @param subMesh defines the submesh that will be rendered
  22536. */
  22537. bind(effect: Effect, nodeMaterial: NodeMaterial, mesh?: Mesh, subMesh?: SubMesh): void;
  22538. protected _declareOutput(output: NodeMaterialConnectionPoint, state: NodeMaterialBuildState): string;
  22539. protected _writeVariable(currentPoint: NodeMaterialConnectionPoint): string;
  22540. protected _writeFloat(value: number): string;
  22541. /**
  22542. * Gets the current class name e.g. "NodeMaterialBlock"
  22543. * @returns the class name
  22544. */
  22545. getClassName(): string;
  22546. /**
  22547. * Register a new input. Must be called inside a block constructor
  22548. * @param name defines the connection point name
  22549. * @param type defines the connection point type
  22550. * @param isOptional defines a boolean indicating that this input can be omitted
  22551. * @param target defines the target to use to limit the connection point (will be VertexAndFragment by default)
  22552. * @param point an already created connection point. If not provided, create a new one
  22553. * @returns the current block
  22554. */
  22555. registerInput(name: string, type: NodeMaterialBlockConnectionPointTypes, isOptional?: boolean, target?: NodeMaterialBlockTargets, point?: NodeMaterialConnectionPoint): this;
  22556. /**
  22557. * Register a new output. Must be called inside a block constructor
  22558. * @param name defines the connection point name
  22559. * @param type defines the connection point type
  22560. * @param target defines the target to use to limit the connection point (will be VertexAndFragment by default)
  22561. * @param point an already created connection point. If not provided, create a new one
  22562. * @returns the current block
  22563. */
  22564. registerOutput(name: string, type: NodeMaterialBlockConnectionPointTypes, target?: NodeMaterialBlockTargets, point?: NodeMaterialConnectionPoint): this;
  22565. /**
  22566. * Will return the first available input e.g. the first one which is not an uniform or an attribute
  22567. * @param forOutput defines an optional connection point to check compatibility with
  22568. * @returns the first available input or null
  22569. */
  22570. getFirstAvailableInput(forOutput?: Nullable<NodeMaterialConnectionPoint>): Nullable<NodeMaterialConnectionPoint>;
  22571. /**
  22572. * Will return the first available output e.g. the first one which is not yet connected and not a varying
  22573. * @param forBlock defines an optional block to check compatibility with
  22574. * @returns the first available input or null
  22575. */
  22576. getFirstAvailableOutput(forBlock?: Nullable<NodeMaterialBlock>): Nullable<NodeMaterialConnectionPoint>;
  22577. /**
  22578. * Gets the sibling of the given output
  22579. * @param current defines the current output
  22580. * @returns the next output in the list or null
  22581. */
  22582. getSiblingOutput(current: NodeMaterialConnectionPoint): Nullable<NodeMaterialConnectionPoint>;
  22583. /**
  22584. * Connect current block with another block
  22585. * @param other defines the block to connect with
  22586. * @param options define the various options to help pick the right connections
  22587. * @returns the current block
  22588. */
  22589. connectTo(other: NodeMaterialBlock, options?: {
  22590. input?: string;
  22591. output?: string;
  22592. outputSwizzle?: string;
  22593. }): this | undefined;
  22594. protected _buildBlock(state: NodeMaterialBuildState): void;
  22595. /**
  22596. * Add uniforms, samplers and uniform buffers at compilation time
  22597. * @param state defines the state to update
  22598. * @param nodeMaterial defines the node material requesting the update
  22599. * @param defines defines the material defines to update
  22600. * @param uniformBuffers defines the list of uniform buffer names
  22601. */
  22602. updateUniformsAndSamples(state: NodeMaterialBuildState, nodeMaterial: NodeMaterial, defines: NodeMaterialDefines, uniformBuffers: string[]): void;
  22603. /**
  22604. * Add potential fallbacks if shader compilation fails
  22605. * @param mesh defines the mesh to be rendered
  22606. * @param fallbacks defines the current prioritized list of fallbacks
  22607. */
  22608. provideFallbacks(mesh: AbstractMesh, fallbacks: EffectFallbacks): void;
  22609. /**
  22610. * Initialize defines for shader compilation
  22611. * @param mesh defines the mesh to be rendered
  22612. * @param nodeMaterial defines the node material requesting the update
  22613. * @param defines defines the material defines to update
  22614. * @param useInstances specifies that instances should be used
  22615. */
  22616. initializeDefines(mesh: AbstractMesh, nodeMaterial: NodeMaterial, defines: NodeMaterialDefines, useInstances?: boolean): void;
  22617. /**
  22618. * Update defines for shader compilation
  22619. * @param mesh defines the mesh to be rendered
  22620. * @param nodeMaterial defines the node material requesting the update
  22621. * @param defines defines the material defines to update
  22622. * @param useInstances specifies that instances should be used
  22623. * @param subMesh defines which submesh to render
  22624. */
  22625. prepareDefines(mesh: AbstractMesh, nodeMaterial: NodeMaterial, defines: NodeMaterialDefines, useInstances?: boolean, subMesh?: SubMesh): void;
  22626. /**
  22627. * Lets the block try to connect some inputs automatically
  22628. * @param material defines the hosting NodeMaterial
  22629. */
  22630. autoConfigure(material: NodeMaterial): void;
  22631. /**
  22632. * Function called when a block is declared as repeatable content generator
  22633. * @param vertexShaderState defines the current compilation state for the vertex shader
  22634. * @param fragmentShaderState defines the current compilation state for the fragment shader
  22635. * @param mesh defines the mesh to be rendered
  22636. * @param defines defines the material defines to update
  22637. */
  22638. replaceRepeatableContent(vertexShaderState: NodeMaterialBuildState, fragmentShaderState: NodeMaterialBuildState, mesh: AbstractMesh, defines: NodeMaterialDefines): void;
  22639. /**
  22640. * Checks if the block is ready
  22641. * @param mesh defines the mesh to be rendered
  22642. * @param nodeMaterial defines the node material requesting the update
  22643. * @param defines defines the material defines to update
  22644. * @param useInstances specifies that instances should be used
  22645. * @returns true if the block is ready
  22646. */
  22647. isReady(mesh: AbstractMesh, nodeMaterial: NodeMaterial, defines: NodeMaterialDefines, useInstances?: boolean): boolean;
  22648. protected _linkConnectionTypes(inputIndex0: number, inputIndex1: number): void;
  22649. private _processBuild;
  22650. /**
  22651. * Validates the new name for the block node.
  22652. * @param newName the new name to be given to the node.
  22653. * @returns false if the name is a reserve word, else true.
  22654. */
  22655. validateBlockName(newName: string): boolean;
  22656. /**
  22657. * Compile the current node and generate the shader code
  22658. * @param state defines the current compilation state (uniforms, samplers, current string)
  22659. * @param activeBlocks defines the list of active blocks (i.e. blocks to compile)
  22660. * @returns true if already built
  22661. */
  22662. build(state: NodeMaterialBuildState, activeBlocks: NodeMaterialBlock[]): boolean;
  22663. protected _inputRename(name: string): string;
  22664. protected _outputRename(name: string): string;
  22665. protected _dumpPropertiesCode(): string;
  22666. /** @hidden */
  22667. _dumpCode(uniqueNames: string[], alreadyDumped: NodeMaterialBlock[]): string;
  22668. /** @hidden */
  22669. _dumpCodeForOutputConnections(alreadyDumped: NodeMaterialBlock[]): string;
  22670. /**
  22671. * Clone the current block to a new identical block
  22672. * @param scene defines the hosting scene
  22673. * @param rootUrl defines the root URL to use to load textures and relative dependencies
  22674. * @returns a copy of the current block
  22675. */
  22676. clone(scene: Scene, rootUrl?: string): Nullable<NodeMaterialBlock>;
  22677. /**
  22678. * Serializes this block in a JSON representation
  22679. * @returns the serialized block object
  22680. */
  22681. serialize(): any;
  22682. /** @hidden */
  22683. _deserialize(serializationObject: any, scene: Scene, rootUrl: string): void;
  22684. private _deserializePortDisplayNamesAndExposedOnFrame;
  22685. /**
  22686. * Release resources
  22687. */
  22688. dispose(): void;
  22689. }
  22690. }
  22691. declare module "babylonjs/Materials/pushMaterial" {
  22692. import { Nullable } from "babylonjs/types";
  22693. import { Scene } from "babylonjs/scene";
  22694. import { Matrix } from "babylonjs/Maths/math.vector";
  22695. import { AbstractMesh } from "babylonjs/Meshes/abstractMesh";
  22696. import { Mesh } from "babylonjs/Meshes/mesh";
  22697. import { Material } from "babylonjs/Materials/material";
  22698. import { Effect } from "babylonjs/Materials/effect";
  22699. import { SubMesh } from "babylonjs/Meshes/subMesh";
  22700. /**
  22701. * Base class of materials working in push mode in babylon JS
  22702. * @hidden
  22703. */
  22704. export class PushMaterial extends Material {
  22705. protected _activeEffect: Effect;
  22706. protected _normalMatrix: Matrix;
  22707. constructor(name: string, scene: Scene);
  22708. getEffect(): Effect;
  22709. isReady(mesh?: AbstractMesh, useInstances?: boolean): boolean;
  22710. protected _isReadyForSubMesh(subMesh: SubMesh): boolean;
  22711. /**
  22712. * Binds the given world matrix to the active effect
  22713. *
  22714. * @param world the matrix to bind
  22715. */
  22716. bindOnlyWorldMatrix(world: Matrix): void;
  22717. /**
  22718. * Binds the given normal matrix to the active effect
  22719. *
  22720. * @param normalMatrix the matrix to bind
  22721. */
  22722. bindOnlyNormalMatrix(normalMatrix: Matrix): void;
  22723. bind(world: Matrix, mesh?: Mesh): void;
  22724. protected _afterBind(mesh: Mesh, effect?: Nullable<Effect>): void;
  22725. protected _mustRebind(scene: Scene, effect: Effect, visibility?: number): boolean;
  22726. }
  22727. }
  22728. declare module "babylonjs/Materials/Node/Optimizers/nodeMaterialOptimizer" {
  22729. import { NodeMaterialBlock } from "babylonjs/Materials/Node/nodeMaterialBlock";
  22730. /**
  22731. * Root class for all node material optimizers
  22732. */
  22733. export class NodeMaterialOptimizer {
  22734. /**
  22735. * Function used to optimize a NodeMaterial graph
  22736. * @param vertexOutputNodes defines the list of output nodes for the vertex shader
  22737. * @param fragmentOutputNodes defines the list of output nodes for the fragment shader
  22738. */
  22739. optimize(vertexOutputNodes: NodeMaterialBlock[], fragmentOutputNodes: NodeMaterialBlock[]): void;
  22740. }
  22741. }
  22742. declare module "babylonjs/Materials/Node/Blocks/transformBlock" {
  22743. import { NodeMaterialBlock } from "babylonjs/Materials/Node/nodeMaterialBlock";
  22744. import { NodeMaterialBuildState } from "babylonjs/Materials/Node/nodeMaterialBuildState";
  22745. import { NodeMaterialConnectionPoint } from "babylonjs/Materials/Node/nodeMaterialBlockConnectionPoint";
  22746. import { Scene } from "babylonjs/scene";
  22747. import { AbstractMesh } from "babylonjs/Meshes/abstractMesh";
  22748. import { NodeMaterial, NodeMaterialDefines } from "babylonjs/Materials/Node/nodeMaterial";
  22749. import { SubMesh } from "babylonjs/Meshes/subMesh";
  22750. /**
  22751. * Block used to transform a vector (2, 3 or 4) with a matrix. It will generate a Vector4
  22752. */
  22753. export class TransformBlock extends NodeMaterialBlock {
  22754. /**
  22755. * Defines the value to use to complement W value to transform it to a Vector4
  22756. */
  22757. complementW: number;
  22758. /**
  22759. * Defines the value to use to complement z value to transform it to a Vector4
  22760. */
  22761. complementZ: number;
  22762. /**
  22763. * Creates a new TransformBlock
  22764. * @param name defines the block name
  22765. */
  22766. constructor(name: string);
  22767. /**
  22768. * Gets the current class name
  22769. * @returns the class name
  22770. */
  22771. getClassName(): string;
  22772. /**
  22773. * Gets the vector input
  22774. */
  22775. get vector(): NodeMaterialConnectionPoint;
  22776. /**
  22777. * Gets the output component
  22778. */
  22779. get output(): NodeMaterialConnectionPoint;
  22780. /**
  22781. * Gets the xyz output component
  22782. */
  22783. get xyz(): NodeMaterialConnectionPoint;
  22784. /**
  22785. * Gets the matrix transform input
  22786. */
  22787. get transform(): NodeMaterialConnectionPoint;
  22788. protected _buildBlock(state: NodeMaterialBuildState): this;
  22789. /**
  22790. * Update defines for shader compilation
  22791. * @param mesh defines the mesh to be rendered
  22792. * @param nodeMaterial defines the node material requesting the update
  22793. * @param defines defines the material defines to update
  22794. * @param useInstances specifies that instances should be used
  22795. * @param subMesh defines which submesh to render
  22796. */
  22797. prepareDefines(mesh: AbstractMesh, nodeMaterial: NodeMaterial, defines: NodeMaterialDefines, useInstances?: boolean, subMesh?: SubMesh): void;
  22798. serialize(): any;
  22799. _deserialize(serializationObject: any, scene: Scene, rootUrl: string): void;
  22800. protected _dumpPropertiesCode(): string;
  22801. }
  22802. }
  22803. declare module "babylonjs/Materials/Node/Blocks/Vertex/vertexOutputBlock" {
  22804. import { NodeMaterialBlock } from "babylonjs/Materials/Node/nodeMaterialBlock";
  22805. import { NodeMaterialBuildState } from "babylonjs/Materials/Node/nodeMaterialBuildState";
  22806. import { NodeMaterialConnectionPoint } from "babylonjs/Materials/Node/nodeMaterialBlockConnectionPoint";
  22807. /**
  22808. * Block used to output the vertex position
  22809. */
  22810. export class VertexOutputBlock extends NodeMaterialBlock {
  22811. /**
  22812. * Creates a new VertexOutputBlock
  22813. * @param name defines the block name
  22814. */
  22815. constructor(name: string);
  22816. /**
  22817. * Gets the current class name
  22818. * @returns the class name
  22819. */
  22820. getClassName(): string;
  22821. /**
  22822. * Gets the vector input component
  22823. */
  22824. get vector(): NodeMaterialConnectionPoint;
  22825. protected _buildBlock(state: NodeMaterialBuildState): this;
  22826. }
  22827. }
  22828. declare module "babylonjs/Materials/Node/Blocks/Fragment/fragmentOutputBlock" {
  22829. import { NodeMaterialBlock } from "babylonjs/Materials/Node/nodeMaterialBlock";
  22830. import { NodeMaterialBuildState } from "babylonjs/Materials/Node/nodeMaterialBuildState";
  22831. import { NodeMaterialConnectionPoint } from "babylonjs/Materials/Node/nodeMaterialBlockConnectionPoint";
  22832. /**
  22833. * Block used to output the final color
  22834. */
  22835. export class FragmentOutputBlock extends NodeMaterialBlock {
  22836. /**
  22837. * Create a new FragmentOutputBlock
  22838. * @param name defines the block name
  22839. */
  22840. constructor(name: string);
  22841. /**
  22842. * Gets the current class name
  22843. * @returns the class name
  22844. */
  22845. getClassName(): string;
  22846. /**
  22847. * Gets the rgba input component
  22848. */
  22849. get rgba(): NodeMaterialConnectionPoint;
  22850. /**
  22851. * Gets the rgb input component
  22852. */
  22853. get rgb(): NodeMaterialConnectionPoint;
  22854. /**
  22855. * Gets the a input component
  22856. */
  22857. get a(): NodeMaterialConnectionPoint;
  22858. protected _buildBlock(state: NodeMaterialBuildState): this;
  22859. }
  22860. }
  22861. declare module "babylonjs/Materials/Node/Blocks/Particle/particleRampGradientBlock" {
  22862. import { NodeMaterialBlock } from "babylonjs/Materials/Node/nodeMaterialBlock";
  22863. import { NodeMaterialBuildState } from "babylonjs/Materials/Node/nodeMaterialBuildState";
  22864. import { NodeMaterialConnectionPoint } from "babylonjs/Materials/Node/nodeMaterialBlockConnectionPoint";
  22865. /**
  22866. * Block used for the particle ramp gradient section
  22867. */
  22868. export class ParticleRampGradientBlock extends NodeMaterialBlock {
  22869. /**
  22870. * Create a new ParticleRampGradientBlock
  22871. * @param name defines the block name
  22872. */
  22873. constructor(name: string);
  22874. /**
  22875. * Gets the current class name
  22876. * @returns the class name
  22877. */
  22878. getClassName(): string;
  22879. /**
  22880. * Gets the color input component
  22881. */
  22882. get color(): NodeMaterialConnectionPoint;
  22883. /**
  22884. * Gets the rampColor output component
  22885. */
  22886. get rampColor(): NodeMaterialConnectionPoint;
  22887. /**
  22888. * Initialize the block and prepare the context for build
  22889. * @param state defines the state that will be used for the build
  22890. */
  22891. initialize(state: NodeMaterialBuildState): void;
  22892. protected _buildBlock(state: NodeMaterialBuildState): this | undefined;
  22893. }
  22894. }
  22895. declare module "babylonjs/Materials/Node/Blocks/Particle/particleBlendMultiplyBlock" {
  22896. import { NodeMaterialBlock } from "babylonjs/Materials/Node/nodeMaterialBlock";
  22897. import { NodeMaterialBuildState } from "babylonjs/Materials/Node/nodeMaterialBuildState";
  22898. import { NodeMaterialConnectionPoint } from "babylonjs/Materials/Node/nodeMaterialBlockConnectionPoint";
  22899. /**
  22900. * Block used for the particle blend multiply section
  22901. */
  22902. export class ParticleBlendMultiplyBlock extends NodeMaterialBlock {
  22903. /**
  22904. * Create a new ParticleBlendMultiplyBlock
  22905. * @param name defines the block name
  22906. */
  22907. constructor(name: string);
  22908. /**
  22909. * Gets the current class name
  22910. * @returns the class name
  22911. */
  22912. getClassName(): string;
  22913. /**
  22914. * Gets the color input component
  22915. */
  22916. get color(): NodeMaterialConnectionPoint;
  22917. /**
  22918. * Gets the alphaTexture input component
  22919. */
  22920. get alphaTexture(): NodeMaterialConnectionPoint;
  22921. /**
  22922. * Gets the alphaColor input component
  22923. */
  22924. get alphaColor(): NodeMaterialConnectionPoint;
  22925. /**
  22926. * Gets the blendColor output component
  22927. */
  22928. get blendColor(): NodeMaterialConnectionPoint;
  22929. /**
  22930. * Initialize the block and prepare the context for build
  22931. * @param state defines the state that will be used for the build
  22932. */
  22933. initialize(state: NodeMaterialBuildState): void;
  22934. protected _buildBlock(state: NodeMaterialBuildState): this | undefined;
  22935. }
  22936. }
  22937. declare module "babylonjs/Materials/Node/Blocks/vectorMergerBlock" {
  22938. import { NodeMaterialBlock } from "babylonjs/Materials/Node/nodeMaterialBlock";
  22939. import { NodeMaterialBuildState } from "babylonjs/Materials/Node/nodeMaterialBuildState";
  22940. import { NodeMaterialConnectionPoint } from "babylonjs/Materials/Node/nodeMaterialBlockConnectionPoint";
  22941. /**
  22942. * Block used to create a Vector2/3/4 out of individual inputs (one for each component)
  22943. */
  22944. export class VectorMergerBlock extends NodeMaterialBlock {
  22945. /**
  22946. * Create a new VectorMergerBlock
  22947. * @param name defines the block name
  22948. */
  22949. constructor(name: string);
  22950. /**
  22951. * Gets the current class name
  22952. * @returns the class name
  22953. */
  22954. getClassName(): string;
  22955. /**
  22956. * Gets the xyz component (input)
  22957. */
  22958. get xyzIn(): NodeMaterialConnectionPoint;
  22959. /**
  22960. * Gets the xy component (input)
  22961. */
  22962. get xyIn(): NodeMaterialConnectionPoint;
  22963. /**
  22964. * Gets the x component (input)
  22965. */
  22966. get x(): NodeMaterialConnectionPoint;
  22967. /**
  22968. * Gets the y component (input)
  22969. */
  22970. get y(): NodeMaterialConnectionPoint;
  22971. /**
  22972. * Gets the z component (input)
  22973. */
  22974. get z(): NodeMaterialConnectionPoint;
  22975. /**
  22976. * Gets the w component (input)
  22977. */
  22978. get w(): NodeMaterialConnectionPoint;
  22979. /**
  22980. * Gets the xyzw component (output)
  22981. */
  22982. get xyzw(): NodeMaterialConnectionPoint;
  22983. /**
  22984. * Gets the xyz component (output)
  22985. */
  22986. get xyzOut(): NodeMaterialConnectionPoint;
  22987. /**
  22988. * Gets the xy component (output)
  22989. */
  22990. get xyOut(): NodeMaterialConnectionPoint;
  22991. /**
  22992. * Gets the xy component (output)
  22993. * @deprecated Please use xyOut instead.
  22994. */
  22995. get xy(): NodeMaterialConnectionPoint;
  22996. /**
  22997. * Gets the xyz component (output)
  22998. * @deprecated Please use xyzOut instead.
  22999. */
  23000. get xyz(): NodeMaterialConnectionPoint;
  23001. protected _buildBlock(state: NodeMaterialBuildState): this;
  23002. }
  23003. }
  23004. declare module "babylonjs/Materials/Node/Blocks/remapBlock" {
  23005. import { NodeMaterialBlock } from "babylonjs/Materials/Node/nodeMaterialBlock";
  23006. import { NodeMaterialBuildState } from "babylonjs/Materials/Node/nodeMaterialBuildState";
  23007. import { NodeMaterialConnectionPoint } from "babylonjs/Materials/Node/nodeMaterialBlockConnectionPoint";
  23008. import { Vector2 } from "babylonjs/Maths/math.vector";
  23009. import { Scene } from "babylonjs/scene";
  23010. /**
  23011. * Block used to remap a float from a range to a new one
  23012. */
  23013. export class RemapBlock extends NodeMaterialBlock {
  23014. /**
  23015. * Gets or sets the source range
  23016. */
  23017. sourceRange: Vector2;
  23018. /**
  23019. * Gets or sets the target range
  23020. */
  23021. targetRange: Vector2;
  23022. /**
  23023. * Creates a new RemapBlock
  23024. * @param name defines the block name
  23025. */
  23026. constructor(name: string);
  23027. /**
  23028. * Gets the current class name
  23029. * @returns the class name
  23030. */
  23031. getClassName(): string;
  23032. /**
  23033. * Gets the input component
  23034. */
  23035. get input(): NodeMaterialConnectionPoint;
  23036. /**
  23037. * Gets the source min input component
  23038. */
  23039. get sourceMin(): NodeMaterialConnectionPoint;
  23040. /**
  23041. * Gets the source max input component
  23042. */
  23043. get sourceMax(): NodeMaterialConnectionPoint;
  23044. /**
  23045. * Gets the target min input component
  23046. */
  23047. get targetMin(): NodeMaterialConnectionPoint;
  23048. /**
  23049. * Gets the target max input component
  23050. */
  23051. get targetMax(): NodeMaterialConnectionPoint;
  23052. /**
  23053. * Gets the output component
  23054. */
  23055. get output(): NodeMaterialConnectionPoint;
  23056. protected _buildBlock(state: NodeMaterialBuildState): this;
  23057. protected _dumpPropertiesCode(): string;
  23058. serialize(): any;
  23059. _deserialize(serializationObject: any, scene: Scene, rootUrl: string): void;
  23060. }
  23061. }
  23062. declare module "babylonjs/Materials/Node/Blocks/multiplyBlock" {
  23063. import { NodeMaterialBlock } from "babylonjs/Materials/Node/nodeMaterialBlock";
  23064. import { NodeMaterialBuildState } from "babylonjs/Materials/Node/nodeMaterialBuildState";
  23065. import { NodeMaterialConnectionPoint } from "babylonjs/Materials/Node/nodeMaterialBlockConnectionPoint";
  23066. /**
  23067. * Block used to multiply 2 values
  23068. */
  23069. export class MultiplyBlock extends NodeMaterialBlock {
  23070. /**
  23071. * Creates a new MultiplyBlock
  23072. * @param name defines the block name
  23073. */
  23074. constructor(name: string);
  23075. /**
  23076. * Gets the current class name
  23077. * @returns the class name
  23078. */
  23079. getClassName(): string;
  23080. /**
  23081. * Gets the left operand input component
  23082. */
  23083. get left(): NodeMaterialConnectionPoint;
  23084. /**
  23085. * Gets the right operand input component
  23086. */
  23087. get right(): NodeMaterialConnectionPoint;
  23088. /**
  23089. * Gets the output component
  23090. */
  23091. get output(): NodeMaterialConnectionPoint;
  23092. protected _buildBlock(state: NodeMaterialBuildState): this;
  23093. }
  23094. }
  23095. declare module "babylonjs/Materials/Node/Blocks/colorSplitterBlock" {
  23096. import { NodeMaterialBlock } from "babylonjs/Materials/Node/nodeMaterialBlock";
  23097. import { NodeMaterialBuildState } from "babylonjs/Materials/Node/nodeMaterialBuildState";
  23098. import { NodeMaterialConnectionPoint } from "babylonjs/Materials/Node/nodeMaterialBlockConnectionPoint";
  23099. /**
  23100. * Block used to expand a Color3/4 into 4 outputs (one for each component)
  23101. */
  23102. export class ColorSplitterBlock extends NodeMaterialBlock {
  23103. /**
  23104. * Create a new ColorSplitterBlock
  23105. * @param name defines the block name
  23106. */
  23107. constructor(name: string);
  23108. /**
  23109. * Gets the current class name
  23110. * @returns the class name
  23111. */
  23112. getClassName(): string;
  23113. /**
  23114. * Gets the rgba component (input)
  23115. */
  23116. get rgba(): NodeMaterialConnectionPoint;
  23117. /**
  23118. * Gets the rgb component (input)
  23119. */
  23120. get rgbIn(): NodeMaterialConnectionPoint;
  23121. /**
  23122. * Gets the rgb component (output)
  23123. */
  23124. get rgbOut(): NodeMaterialConnectionPoint;
  23125. /**
  23126. * Gets the r component (output)
  23127. */
  23128. get r(): NodeMaterialConnectionPoint;
  23129. /**
  23130. * Gets the g component (output)
  23131. */
  23132. get g(): NodeMaterialConnectionPoint;
  23133. /**
  23134. * Gets the b component (output)
  23135. */
  23136. get b(): NodeMaterialConnectionPoint;
  23137. /**
  23138. * Gets the a component (output)
  23139. */
  23140. get a(): NodeMaterialConnectionPoint;
  23141. protected _inputRename(name: string): string;
  23142. protected _outputRename(name: string): string;
  23143. protected _buildBlock(state: NodeMaterialBuildState): this | undefined;
  23144. }
  23145. }
  23146. declare module "babylonjs/Materials/Node/Blocks/trigonometryBlock" {
  23147. import { NodeMaterialBlock } from "babylonjs/Materials/Node/nodeMaterialBlock";
  23148. import { NodeMaterialBuildState } from "babylonjs/Materials/Node/nodeMaterialBuildState";
  23149. import { NodeMaterialConnectionPoint } from "babylonjs/Materials/Node/nodeMaterialBlockConnectionPoint";
  23150. import { Scene } from "babylonjs/scene";
  23151. /**
  23152. * Operations supported by the Trigonometry block
  23153. */
  23154. export enum TrigonometryBlockOperations {
  23155. /** Cos */
  23156. Cos = 0,
  23157. /** Sin */
  23158. Sin = 1,
  23159. /** Abs */
  23160. Abs = 2,
  23161. /** Exp */
  23162. Exp = 3,
  23163. /** Exp2 */
  23164. Exp2 = 4,
  23165. /** Round */
  23166. Round = 5,
  23167. /** Floor */
  23168. Floor = 6,
  23169. /** Ceiling */
  23170. Ceiling = 7,
  23171. /** Square root */
  23172. Sqrt = 8,
  23173. /** Log */
  23174. Log = 9,
  23175. /** Tangent */
  23176. Tan = 10,
  23177. /** Arc tangent */
  23178. ArcTan = 11,
  23179. /** Arc cosinus */
  23180. ArcCos = 12,
  23181. /** Arc sinus */
  23182. ArcSin = 13,
  23183. /** Fraction */
  23184. Fract = 14,
  23185. /** Sign */
  23186. Sign = 15,
  23187. /** To radians (from degrees) */
  23188. Radians = 16,
  23189. /** To degrees (from radians) */
  23190. Degrees = 17
  23191. }
  23192. /**
  23193. * Block used to apply trigonometry operation to floats
  23194. */
  23195. export class TrigonometryBlock extends NodeMaterialBlock {
  23196. /**
  23197. * Gets or sets the operation applied by the block
  23198. */
  23199. operation: TrigonometryBlockOperations;
  23200. /**
  23201. * Creates a new TrigonometryBlock
  23202. * @param name defines the block name
  23203. */
  23204. constructor(name: string);
  23205. /**
  23206. * Gets the current class name
  23207. * @returns the class name
  23208. */
  23209. getClassName(): string;
  23210. /**
  23211. * Gets the input component
  23212. */
  23213. get input(): NodeMaterialConnectionPoint;
  23214. /**
  23215. * Gets the output component
  23216. */
  23217. get output(): NodeMaterialConnectionPoint;
  23218. protected _buildBlock(state: NodeMaterialBuildState): this;
  23219. serialize(): any;
  23220. _deserialize(serializationObject: any, scene: Scene, rootUrl: string): void;
  23221. protected _dumpPropertiesCode(): string;
  23222. }
  23223. }
  23224. declare module "babylonjs/Materials/Node/nodeMaterial" {
  23225. import { NodeMaterialBlock } from "babylonjs/Materials/Node/nodeMaterialBlock";
  23226. import { PushMaterial } from "babylonjs/Materials/pushMaterial";
  23227. import { Scene } from "babylonjs/scene";
  23228. import { AbstractMesh } from "babylonjs/Meshes/abstractMesh";
  23229. import { Matrix } from "babylonjs/Maths/math.vector";
  23230. import { Mesh } from "babylonjs/Meshes/mesh";
  23231. import { Engine } from "babylonjs/Engines/engine";
  23232. import { BaseTexture } from "babylonjs/Materials/Textures/baseTexture";
  23233. import { Observable } from "babylonjs/Misc/observable";
  23234. import { SubMesh } from "babylonjs/Meshes/subMesh";
  23235. import { MaterialDefines } from "babylonjs/Materials/materialDefines";
  23236. import { NodeMaterialOptimizer } from "babylonjs/Materials/Node/Optimizers/nodeMaterialOptimizer";
  23237. import { ImageProcessingConfiguration, IImageProcessingConfigurationDefines } from "babylonjs/Materials/imageProcessingConfiguration";
  23238. import { Nullable } from "babylonjs/types";
  23239. import { InputBlock } from "babylonjs/Materials/Node/Blocks/Input/inputBlock";
  23240. import { TextureBlock } from "babylonjs/Materials/Node/Blocks/Dual/textureBlock";
  23241. import { ReflectionTextureBaseBlock } from "babylonjs/Materials/Node/Blocks/Dual/reflectionTextureBaseBlock";
  23242. import { RefractionBlock } from "babylonjs/Materials/Node/Blocks/PBR/refractionBlock";
  23243. import { CurrentScreenBlock } from "babylonjs/Materials/Node/Blocks/Dual/currentScreenBlock";
  23244. import { ParticleTextureBlock } from "babylonjs/Materials/Node/Blocks/Particle/particleTextureBlock";
  23245. import { Effect } from "babylonjs/Materials/effect";
  23246. import { PostProcess, PostProcessOptions } from "babylonjs/PostProcesses/postProcess";
  23247. import { Camera } from "babylonjs/Cameras/camera";
  23248. import { NodeMaterialModes } from "babylonjs/Materials/Node/Enums/nodeMaterialModes";
  23249. import { IParticleSystem } from "babylonjs/Particles/IParticleSystem";
  23250. import { ProceduralTexture } from "babylonjs/Materials/Textures/Procedurals/proceduralTexture";
  23251. /**
  23252. * Interface used to configure the node material editor
  23253. */
  23254. export interface INodeMaterialEditorOptions {
  23255. /** Define the URl to load node editor script */
  23256. editorURL?: string;
  23257. }
  23258. /** @hidden */
  23259. export class NodeMaterialDefines extends MaterialDefines implements IImageProcessingConfigurationDefines {
  23260. NORMAL: boolean;
  23261. TANGENT: boolean;
  23262. UV1: boolean;
  23263. /** BONES */
  23264. NUM_BONE_INFLUENCERS: number;
  23265. BonesPerMesh: number;
  23266. BONETEXTURE: boolean;
  23267. /** MORPH TARGETS */
  23268. MORPHTARGETS: boolean;
  23269. MORPHTARGETS_NORMAL: boolean;
  23270. MORPHTARGETS_TANGENT: boolean;
  23271. MORPHTARGETS_UV: boolean;
  23272. NUM_MORPH_INFLUENCERS: number;
  23273. /** IMAGE PROCESSING */
  23274. IMAGEPROCESSING: boolean;
  23275. VIGNETTE: boolean;
  23276. VIGNETTEBLENDMODEMULTIPLY: boolean;
  23277. VIGNETTEBLENDMODEOPAQUE: boolean;
  23278. TONEMAPPING: boolean;
  23279. TONEMAPPING_ACES: boolean;
  23280. CONTRAST: boolean;
  23281. EXPOSURE: boolean;
  23282. COLORCURVES: boolean;
  23283. COLORGRADING: boolean;
  23284. COLORGRADING3D: boolean;
  23285. SAMPLER3DGREENDEPTH: boolean;
  23286. SAMPLER3DBGRMAP: boolean;
  23287. IMAGEPROCESSINGPOSTPROCESS: boolean;
  23288. /** MISC. */
  23289. BUMPDIRECTUV: number;
  23290. constructor();
  23291. setValue(name: string, value: any, markAsUnprocessedIfDirty?: boolean): void;
  23292. }
  23293. /**
  23294. * Class used to configure NodeMaterial
  23295. */
  23296. export interface INodeMaterialOptions {
  23297. /**
  23298. * Defines if blocks should emit comments
  23299. */
  23300. emitComments: boolean;
  23301. }
  23302. /**
  23303. * Class used to create a node based material built by assembling shader blocks
  23304. */
  23305. export class NodeMaterial extends PushMaterial {
  23306. private static _BuildIdGenerator;
  23307. private _options;
  23308. private _vertexCompilationState;
  23309. private _fragmentCompilationState;
  23310. private _sharedData;
  23311. private _buildId;
  23312. private _buildWasSuccessful;
  23313. private _cachedWorldViewMatrix;
  23314. private _cachedWorldViewProjectionMatrix;
  23315. private _optimizers;
  23316. private _animationFrame;
  23317. /** Define the Url to load node editor script */
  23318. static EditorURL: string;
  23319. /** Define the Url to load snippets */
  23320. static SnippetUrl: string;
  23321. /** Gets or sets a boolean indicating that node materials should not deserialize textures from json / snippet content */
  23322. static IgnoreTexturesAtLoadTime: boolean;
  23323. private BJSNODEMATERIALEDITOR;
  23324. /** Get the inspector from bundle or global */
  23325. private _getGlobalNodeMaterialEditor;
  23326. /**
  23327. * Snippet ID if the material was created from the snippet server
  23328. */
  23329. snippetId: string;
  23330. /**
  23331. * Gets or sets data used by visual editor
  23332. * @see https://nme.babylonjs.com
  23333. */
  23334. editorData: any;
  23335. /**
  23336. * 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)
  23337. */
  23338. ignoreAlpha: boolean;
  23339. /**
  23340. * Defines the maximum number of lights that can be used in the material
  23341. */
  23342. maxSimultaneousLights: number;
  23343. /**
  23344. * Observable raised when the material is built
  23345. */
  23346. onBuildObservable: Observable<NodeMaterial>;
  23347. /**
  23348. * Gets or sets the root nodes of the material vertex shader
  23349. */
  23350. _vertexOutputNodes: NodeMaterialBlock[];
  23351. /**
  23352. * Gets or sets the root nodes of the material fragment (pixel) shader
  23353. */
  23354. _fragmentOutputNodes: NodeMaterialBlock[];
  23355. /** Gets or sets options to control the node material overall behavior */
  23356. get options(): INodeMaterialOptions;
  23357. set options(options: INodeMaterialOptions);
  23358. /**
  23359. * Default configuration related to image processing available in the standard Material.
  23360. */
  23361. protected _imageProcessingConfiguration: ImageProcessingConfiguration;
  23362. /**
  23363. * Gets the image processing configuration used either in this material.
  23364. */
  23365. get imageProcessingConfiguration(): ImageProcessingConfiguration;
  23366. /**
  23367. * Sets the Default image processing configuration used either in the this material.
  23368. *
  23369. * If sets to null, the scene one is in use.
  23370. */
  23371. set imageProcessingConfiguration(value: ImageProcessingConfiguration);
  23372. /**
  23373. * Gets an array of blocks that needs to be serialized even if they are not yet connected
  23374. */
  23375. attachedBlocks: NodeMaterialBlock[];
  23376. /**
  23377. * Specifies the mode of the node material
  23378. * @hidden
  23379. */
  23380. _mode: NodeMaterialModes;
  23381. /**
  23382. * Gets the mode property
  23383. */
  23384. get mode(): NodeMaterialModes;
  23385. /**
  23386. * Create a new node based material
  23387. * @param name defines the material name
  23388. * @param scene defines the hosting scene
  23389. * @param options defines creation option
  23390. */
  23391. constructor(name: string, scene?: Scene, options?: Partial<INodeMaterialOptions>);
  23392. /**
  23393. * Gets the current class name of the material e.g. "NodeMaterial"
  23394. * @returns the class name
  23395. */
  23396. getClassName(): string;
  23397. /**
  23398. * Keep track of the image processing observer to allow dispose and replace.
  23399. */
  23400. private _imageProcessingObserver;
  23401. /**
  23402. * Attaches a new image processing configuration to the Standard Material.
  23403. * @param configuration
  23404. */
  23405. protected _attachImageProcessingConfiguration(configuration: Nullable<ImageProcessingConfiguration>): void;
  23406. /**
  23407. * Get a block by its name
  23408. * @param name defines the name of the block to retrieve
  23409. * @returns the required block or null if not found
  23410. */
  23411. getBlockByName(name: string): Nullable<NodeMaterialBlock>;
  23412. /**
  23413. * Get a block by its name
  23414. * @param predicate defines the predicate used to find the good candidate
  23415. * @returns the required block or null if not found
  23416. */
  23417. getBlockByPredicate(predicate: (block: NodeMaterialBlock) => boolean): Nullable<NodeMaterialBlock>;
  23418. /**
  23419. * Get an input block by its name
  23420. * @param predicate defines the predicate used to find the good candidate
  23421. * @returns the required input block or null if not found
  23422. */
  23423. getInputBlockByPredicate(predicate: (block: InputBlock) => boolean): Nullable<InputBlock>;
  23424. /**
  23425. * Gets the list of input blocks attached to this material
  23426. * @returns an array of InputBlocks
  23427. */
  23428. getInputBlocks(): InputBlock[];
  23429. /**
  23430. * Adds a new optimizer to the list of optimizers
  23431. * @param optimizer defines the optimizers to add
  23432. * @returns the current material
  23433. */
  23434. registerOptimizer(optimizer: NodeMaterialOptimizer): this | undefined;
  23435. /**
  23436. * Remove an optimizer from the list of optimizers
  23437. * @param optimizer defines the optimizers to remove
  23438. * @returns the current material
  23439. */
  23440. unregisterOptimizer(optimizer: NodeMaterialOptimizer): this | undefined;
  23441. /**
  23442. * Add a new block to the list of output nodes
  23443. * @param node defines the node to add
  23444. * @returns the current material
  23445. */
  23446. addOutputNode(node: NodeMaterialBlock): this;
  23447. /**
  23448. * Remove a block from the list of root nodes
  23449. * @param node defines the node to remove
  23450. * @returns the current material
  23451. */
  23452. removeOutputNode(node: NodeMaterialBlock): this;
  23453. private _addVertexOutputNode;
  23454. private _removeVertexOutputNode;
  23455. private _addFragmentOutputNode;
  23456. private _removeFragmentOutputNode;
  23457. /**
  23458. * Specifies if the material will require alpha blending
  23459. * @returns a boolean specifying if alpha blending is needed
  23460. */
  23461. needAlphaBlending(): boolean;
  23462. /**
  23463. * Specifies if this material should be rendered in alpha test mode
  23464. * @returns a boolean specifying if an alpha test is needed.
  23465. */
  23466. needAlphaTesting(): boolean;
  23467. private _initializeBlock;
  23468. private _resetDualBlocks;
  23469. /**
  23470. * Remove a block from the current node material
  23471. * @param block defines the block to remove
  23472. */
  23473. removeBlock(block: NodeMaterialBlock): void;
  23474. /**
  23475. * Build the material and generates the inner effect
  23476. * @param verbose defines if the build should log activity
  23477. */
  23478. build(verbose?: boolean): void;
  23479. /**
  23480. * Runs an otpimization phase to try to improve the shader code
  23481. */
  23482. optimize(): void;
  23483. private _prepareDefinesForAttributes;
  23484. /**
  23485. * Create a post process from the material
  23486. * @param camera The camera to apply the render pass to.
  23487. * @param options The required width/height ratio to downsize to before computing the render pass. (Use 1.0 for full size)
  23488. * @param samplingMode The sampling mode to be used when computing the pass. (default: 0)
  23489. * @param engine The engine which the post process will be applied. (default: current engine)
  23490. * @param reusable If the post process can be reused on the same frame. (default: false)
  23491. * @param textureType Type of textures used when performing the post process. (default: 0)
  23492. * @param textureFormat Format of textures used when performing the post process. (default: TEXTUREFORMAT_RGBA)
  23493. * @returns the post process created
  23494. */
  23495. createPostProcess(camera: Nullable<Camera>, options?: number | PostProcessOptions, samplingMode?: number, engine?: Engine, reusable?: boolean, textureType?: number, textureFormat?: number): Nullable<PostProcess>;
  23496. /**
  23497. * Create the post process effect from the material
  23498. * @param postProcess The post process to create the effect for
  23499. */
  23500. createEffectForPostProcess(postProcess: PostProcess): void;
  23501. private _createEffectForPostProcess;
  23502. /**
  23503. * Create a new procedural texture based on this node material
  23504. * @param size defines the size of the texture
  23505. * @param scene defines the hosting scene
  23506. * @returns the new procedural texture attached to this node material
  23507. */
  23508. createProceduralTexture(size: number | {
  23509. width: number;
  23510. height: number;
  23511. layers?: number;
  23512. }, scene: Scene): Nullable<ProceduralTexture>;
  23513. private _createEffectForParticles;
  23514. private _checkInternals;
  23515. /**
  23516. * Create the effect to be used as the custom effect for a particle system
  23517. * @param particleSystem Particle system to create the effect for
  23518. * @param onCompiled defines a function to call when the effect creation is successful
  23519. * @param onError defines a function to call when the effect creation has failed
  23520. */
  23521. createEffectForParticles(particleSystem: IParticleSystem, onCompiled?: (effect: Effect) => void, onError?: (effect: Effect, errors: string) => void): void;
  23522. private _processDefines;
  23523. /**
  23524. * Get if the submesh is ready to be used and all its information available.
  23525. * Child classes can use it to update shaders
  23526. * @param mesh defines the mesh to check
  23527. * @param subMesh defines which submesh to check
  23528. * @param useInstances specifies that instances should be used
  23529. * @returns a boolean indicating that the submesh is ready or not
  23530. */
  23531. isReadyForSubMesh(mesh: AbstractMesh, subMesh: SubMesh, useInstances?: boolean): boolean;
  23532. /**
  23533. * Get a string representing the shaders built by the current node graph
  23534. */
  23535. get compiledShaders(): string;
  23536. /**
  23537. * Binds the world matrix to the material
  23538. * @param world defines the world transformation matrix
  23539. */
  23540. bindOnlyWorldMatrix(world: Matrix): void;
  23541. /**
  23542. * Binds the submesh to this material by preparing the effect and shader to draw
  23543. * @param world defines the world transformation matrix
  23544. * @param mesh defines the mesh containing the submesh
  23545. * @param subMesh defines the submesh to bind the material to
  23546. */
  23547. bindForSubMesh(world: Matrix, mesh: Mesh, subMesh: SubMesh): void;
  23548. /**
  23549. * Gets the active textures from the material
  23550. * @returns an array of textures
  23551. */
  23552. getActiveTextures(): BaseTexture[];
  23553. /**
  23554. * Gets the list of texture blocks
  23555. * @returns an array of texture blocks
  23556. */
  23557. getTextureBlocks(): (TextureBlock | ReflectionTextureBaseBlock | RefractionBlock | CurrentScreenBlock | ParticleTextureBlock)[];
  23558. /**
  23559. * Specifies if the material uses a texture
  23560. * @param texture defines the texture to check against the material
  23561. * @returns a boolean specifying if the material uses the texture
  23562. */
  23563. hasTexture(texture: BaseTexture): boolean;
  23564. /**
  23565. * Disposes the material
  23566. * @param forceDisposeEffect specifies if effects should be forcefully disposed
  23567. * @param forceDisposeTextures specifies if textures should be forcefully disposed
  23568. * @param notBoundToMesh specifies if the material that is being disposed is known to be not bound to any mesh
  23569. */
  23570. dispose(forceDisposeEffect?: boolean, forceDisposeTextures?: boolean, notBoundToMesh?: boolean): void;
  23571. /** Creates the node editor window. */
  23572. private _createNodeEditor;
  23573. /**
  23574. * Launch the node material editor
  23575. * @param config Define the configuration of the editor
  23576. * @return a promise fulfilled when the node editor is visible
  23577. */
  23578. edit(config?: INodeMaterialEditorOptions): Promise<void>;
  23579. /**
  23580. * Clear the current material
  23581. */
  23582. clear(): void;
  23583. /**
  23584. * Clear the current material and set it to a default state
  23585. */
  23586. setToDefault(): void;
  23587. /**
  23588. * Clear the current material and set it to a default state for post process
  23589. */
  23590. setToDefaultPostProcess(): void;
  23591. /**
  23592. * Clear the current material and set it to a default state for procedural texture
  23593. */
  23594. setToDefaultProceduralTexture(): void;
  23595. /**
  23596. * Clear the current material and set it to a default state for particle
  23597. */
  23598. setToDefaultParticle(): void;
  23599. /**
  23600. * Loads the current Node Material from a url pointing to a file save by the Node Material Editor
  23601. * @param url defines the url to load from
  23602. * @returns a promise that will fullfil when the material is fully loaded
  23603. */
  23604. loadAsync(url: string): Promise<void>;
  23605. private _gatherBlocks;
  23606. /**
  23607. * Generate a string containing the code declaration required to create an equivalent of this material
  23608. * @returns a string
  23609. */
  23610. generateCode(): string;
  23611. /**
  23612. * Serializes this material in a JSON representation
  23613. * @returns the serialized material object
  23614. */
  23615. serialize(selectedBlocks?: NodeMaterialBlock[]): any;
  23616. private _restoreConnections;
  23617. /**
  23618. * Clear the current graph and load a new one from a serialization object
  23619. * @param source defines the JSON representation of the material
  23620. * @param rootUrl defines the root URL to use to load textures and relative dependencies
  23621. * @param merge defines whether or not the source must be merged or replace the current content
  23622. */
  23623. loadFromSerialization(source: any, rootUrl?: string, merge?: boolean): void;
  23624. /**
  23625. * Makes a duplicate of the current material.
  23626. * @param name - name to use for the new material.
  23627. */
  23628. clone(name: string): NodeMaterial;
  23629. /**
  23630. * Creates a node material from parsed material data
  23631. * @param source defines the JSON representation of the material
  23632. * @param scene defines the hosting scene
  23633. * @param rootUrl defines the root URL to use to load textures and relative dependencies
  23634. * @returns a new node material
  23635. */
  23636. static Parse(source: any, scene: Scene, rootUrl?: string): NodeMaterial;
  23637. /**
  23638. * Creates a node material from a snippet saved in a remote file
  23639. * @param name defines the name of the material to create
  23640. * @param url defines the url to load from
  23641. * @param scene defines the hosting scene
  23642. * @returns a promise that will resolve to the new node material
  23643. */
  23644. static ParseFromFileAsync(name: string, url: string, scene: Scene): Promise<NodeMaterial>;
  23645. /**
  23646. * Creates a node material from a snippet saved by the node material editor
  23647. * @param snippetId defines the snippet to load
  23648. * @param scene defines the hosting scene
  23649. * @param rootUrl defines the root URL to use to load textures and relative dependencies
  23650. * @param nodeMaterial defines a node material to update (instead of creating a new one)
  23651. * @returns a promise that will resolve to the new node material
  23652. */
  23653. static ParseFromSnippetAsync(snippetId: string, scene: Scene, rootUrl?: string, nodeMaterial?: NodeMaterial): Promise<NodeMaterial>;
  23654. /**
  23655. * Creates a new node material set to default basic configuration
  23656. * @param name defines the name of the material
  23657. * @param scene defines the hosting scene
  23658. * @returns a new NodeMaterial
  23659. */
  23660. static CreateDefault(name: string, scene?: Scene): NodeMaterial;
  23661. }
  23662. }
  23663. declare module "babylonjs/Engines/Extensions/engine.multiRender" {
  23664. import { InternalTexture } from "babylonjs/Materials/Textures/internalTexture";
  23665. import { IMultiRenderTargetOptions } from "babylonjs/Materials/Textures/multiRenderTarget";
  23666. import { Nullable } from "babylonjs/types";
  23667. module "babylonjs/Engines/thinEngine" {
  23668. interface ThinEngine {
  23669. /**
  23670. * Unbind a list of render target textures from the webGL context
  23671. * This is used only when drawBuffer extension or webGL2 are active
  23672. * @param textures defines the render target textures to unbind
  23673. * @param disableGenerateMipMaps defines a boolean indicating that mipmaps must not be generated
  23674. * @param onBeforeUnbind defines a function which will be called before the effective unbind
  23675. */
  23676. unBindMultiColorAttachmentFramebuffer(textures: InternalTexture[], disableGenerateMipMaps: boolean, onBeforeUnbind?: () => void): void;
  23677. /**
  23678. * Create a multi render target texture
  23679. * @see https://doc.babylonjs.com/features/webgl2#multiple-render-target
  23680. * @param size defines the size of the texture
  23681. * @param options defines the creation options
  23682. * @returns the cube texture as an InternalTexture
  23683. */
  23684. createMultipleRenderTarget(size: any, options: IMultiRenderTargetOptions): InternalTexture[];
  23685. /**
  23686. * Update the sample count for a given multiple render target texture
  23687. * @see https://doc.babylonjs.com/features/webgl2#multisample-render-targets
  23688. * @param textures defines the textures to update
  23689. * @param samples defines the sample count to set
  23690. * @returns the effective sample count (could be 0 if multisample render targets are not supported)
  23691. */
  23692. updateMultipleRenderTargetTextureSampleCount(textures: Nullable<InternalTexture[]>, samples: number): number;
  23693. /**
  23694. * Select a subsets of attachments to draw to.
  23695. * @param attachments gl attachments
  23696. */
  23697. bindAttachments(attachments: number[]): void;
  23698. /**
  23699. * Creates a layout object to draw/clear on specific textures in a MRT
  23700. * @param textureStatus textureStatus[i] indicates if the i-th is active
  23701. * @returns A layout to be fed to the engine, calling `bindAttachments`.
  23702. */
  23703. buildTextureLayout(textureStatus: boolean[]): number[];
  23704. /**
  23705. * Restores the webgl state to only draw on the main color attachment
  23706. */
  23707. restoreSingleAttachment(): void;
  23708. }
  23709. }
  23710. }
  23711. declare module "babylonjs/Materials/Textures/multiRenderTarget" {
  23712. import { Scene } from "babylonjs/scene";
  23713. import { Engine } from "babylonjs/Engines/engine";
  23714. import { Texture } from "babylonjs/Materials/Textures/texture";
  23715. import { RenderTargetTexture } from "babylonjs/Materials/Textures/renderTargetTexture";
  23716. import "babylonjs/Engines/Extensions/engine.multiRender";
  23717. /**
  23718. * Creation options of the multi render target texture.
  23719. */
  23720. export interface IMultiRenderTargetOptions {
  23721. /**
  23722. * Define if the texture needs to create mip maps after render.
  23723. */
  23724. generateMipMaps?: boolean;
  23725. /**
  23726. * Define the types of all the draw buffers we want to create
  23727. */
  23728. types?: number[];
  23729. /**
  23730. * Define the sampling modes of all the draw buffers we want to create
  23731. */
  23732. samplingModes?: number[];
  23733. /**
  23734. * Define if a depth buffer is required
  23735. */
  23736. generateDepthBuffer?: boolean;
  23737. /**
  23738. * Define if a stencil buffer is required
  23739. */
  23740. generateStencilBuffer?: boolean;
  23741. /**
  23742. * Define if a depth texture is required instead of a depth buffer
  23743. */
  23744. generateDepthTexture?: boolean;
  23745. /**
  23746. * Define the number of desired draw buffers
  23747. */
  23748. textureCount?: number;
  23749. /**
  23750. * Define if aspect ratio should be adapted to the texture or stay the scene one
  23751. */
  23752. doNotChangeAspectRatio?: boolean;
  23753. /**
  23754. * Define the default type of the buffers we are creating
  23755. */
  23756. defaultType?: number;
  23757. }
  23758. /**
  23759. * A multi render target, like a render target provides the ability to render to a texture.
  23760. * Unlike the render target, it can render to several draw buffers in one draw.
  23761. * This is specially interesting in deferred rendering or for any effects requiring more than
  23762. * just one color from a single pass.
  23763. */
  23764. export class MultiRenderTarget extends RenderTargetTexture {
  23765. private _internalTextures;
  23766. private _textures;
  23767. private _multiRenderTargetOptions;
  23768. private _count;
  23769. /**
  23770. * Get if draw buffers are currently supported by the used hardware and browser.
  23771. */
  23772. get isSupported(): boolean;
  23773. /**
  23774. * Get the list of textures generated by the multi render target.
  23775. */
  23776. get textures(): Texture[];
  23777. /**
  23778. * Gets the number of textures in this MRT. This number can be different from `_textures.length` in case a depth texture is generated.
  23779. */
  23780. get count(): number;
  23781. /**
  23782. * Get the depth texture generated by the multi render target if options.generateDepthTexture has been set
  23783. */
  23784. get depthTexture(): Texture;
  23785. /**
  23786. * Set the wrapping mode on U of all the textures we are rendering to.
  23787. * Can be any of the Texture. (CLAMP_ADDRESSMODE, MIRROR_ADDRESSMODE or WRAP_ADDRESSMODE)
  23788. */
  23789. set wrapU(wrap: number);
  23790. /**
  23791. * Set the wrapping mode on V of all the textures we are rendering to.
  23792. * Can be any of the Texture. (CLAMP_ADDRESSMODE, MIRROR_ADDRESSMODE or WRAP_ADDRESSMODE)
  23793. */
  23794. set wrapV(wrap: number);
  23795. /**
  23796. * Instantiate a new multi render target texture.
  23797. * A multi render target, like a render target provides the ability to render to a texture.
  23798. * Unlike the render target, it can render to several draw buffers in one draw.
  23799. * This is specially interesting in deferred rendering or for any effects requiring more than
  23800. * just one color from a single pass.
  23801. * @param name Define the name of the texture
  23802. * @param size Define the size of the buffers to render to
  23803. * @param count Define the number of target we are rendering into
  23804. * @param scene Define the scene the texture belongs to
  23805. * @param options Define the options used to create the multi render target
  23806. */
  23807. constructor(name: string, size: any, count: number, scene: Scene, options?: IMultiRenderTargetOptions);
  23808. private _initTypes;
  23809. /** @hidden */
  23810. _rebuild(forceFullRebuild?: boolean): void;
  23811. private _createInternalTextures;
  23812. private _createTextures;
  23813. /**
  23814. * Replaces a texture within the MRT.
  23815. * @param texture The new texture to insert in the MRT
  23816. * @param index The index of the texture to replace
  23817. */
  23818. replaceTexture(texture: Texture, index: number): void;
  23819. /**
  23820. * Define the number of samples used if MSAA is enabled.
  23821. */
  23822. get samples(): number;
  23823. set samples(value: number);
  23824. /**
  23825. * Resize all the textures in the multi render target.
  23826. * Be careful as it will recreate all the data in the new texture.
  23827. * @param size Define the new size
  23828. */
  23829. resize(size: any): void;
  23830. /**
  23831. * Changes the number of render targets in this MRT
  23832. * Be careful as it will recreate all the data in the new texture.
  23833. * @param count new texture count
  23834. * @param options Specifies texture types and sampling modes for new textures
  23835. */
  23836. updateCount(count: number, options?: IMultiRenderTargetOptions): void;
  23837. protected unbindFrameBuffer(engine: Engine, faceIndex: number): void;
  23838. /**
  23839. * Dispose the render targets and their associated resources
  23840. */
  23841. dispose(): void;
  23842. /**
  23843. * Release all the underlying texture used as draw buffers.
  23844. */
  23845. releaseInternalTextures(): void;
  23846. }
  23847. }
  23848. declare module "babylonjs/Shaders/imageProcessing.fragment" {
  23849. import "babylonjs/Shaders/ShadersInclude/imageProcessingDeclaration";
  23850. import "babylonjs/Shaders/ShadersInclude/helperFunctions";
  23851. import "babylonjs/Shaders/ShadersInclude/imageProcessingFunctions";
  23852. /** @hidden */
  23853. export var imageProcessingPixelShader: {
  23854. name: string;
  23855. shader: string;
  23856. };
  23857. }
  23858. declare module "babylonjs/PostProcesses/imageProcessingPostProcess" {
  23859. import { Nullable } from "babylonjs/types";
  23860. import { Color4 } from "babylonjs/Maths/math.color";
  23861. import { Camera } from "babylonjs/Cameras/camera";
  23862. import { BaseTexture } from "babylonjs/Materials/Textures/baseTexture";
  23863. import { ColorCurves } from "babylonjs/Materials/colorCurves";
  23864. import { ImageProcessingConfiguration } from "babylonjs/Materials/imageProcessingConfiguration";
  23865. import { PostProcess, PostProcessOptions } from "babylonjs/PostProcesses/postProcess";
  23866. import { Engine } from "babylonjs/Engines/engine";
  23867. import "babylonjs/Shaders/imageProcessing.fragment";
  23868. import "babylonjs/Shaders/postprocess.vertex";
  23869. /**
  23870. * ImageProcessingPostProcess
  23871. * @see https://doc.babylonjs.com/how_to/how_to_use_postprocesses#imageprocessing
  23872. */
  23873. export class ImageProcessingPostProcess extends PostProcess {
  23874. /**
  23875. * Default configuration related to image processing available in the PBR Material.
  23876. */
  23877. protected _imageProcessingConfiguration: ImageProcessingConfiguration;
  23878. /**
  23879. * Gets the image processing configuration used either in this material.
  23880. */
  23881. get imageProcessingConfiguration(): ImageProcessingConfiguration;
  23882. /**
  23883. * Sets the Default image processing configuration used either in the this material.
  23884. *
  23885. * If sets to null, the scene one is in use.
  23886. */
  23887. set imageProcessingConfiguration(value: ImageProcessingConfiguration);
  23888. /**
  23889. * Keep track of the image processing observer to allow dispose and replace.
  23890. */
  23891. private _imageProcessingObserver;
  23892. /**
  23893. * Attaches a new image processing configuration to the PBR Material.
  23894. * @param configuration
  23895. */
  23896. protected _attachImageProcessingConfiguration(configuration: Nullable<ImageProcessingConfiguration>, doNotBuild?: boolean): void;
  23897. /**
  23898. * If the post process is supported.
  23899. */
  23900. get isSupported(): boolean;
  23901. /**
  23902. * Gets Color curves setup used in the effect if colorCurvesEnabled is set to true .
  23903. */
  23904. get colorCurves(): Nullable<ColorCurves>;
  23905. /**
  23906. * Sets Color curves setup used in the effect if colorCurvesEnabled is set to true .
  23907. */
  23908. set colorCurves(value: Nullable<ColorCurves>);
  23909. /**
  23910. * Gets wether the color curves effect is enabled.
  23911. */
  23912. get colorCurvesEnabled(): boolean;
  23913. /**
  23914. * Sets wether the color curves effect is enabled.
  23915. */
  23916. set colorCurvesEnabled(value: boolean);
  23917. /**
  23918. * Gets Color grading LUT texture used in the effect if colorGradingEnabled is set to true.
  23919. */
  23920. get colorGradingTexture(): Nullable<BaseTexture>;
  23921. /**
  23922. * Sets Color grading LUT texture used in the effect if colorGradingEnabled is set to true.
  23923. */
  23924. set colorGradingTexture(value: Nullable<BaseTexture>);
  23925. /**
  23926. * Gets wether the color grading effect is enabled.
  23927. */
  23928. get colorGradingEnabled(): boolean;
  23929. /**
  23930. * Gets wether the color grading effect is enabled.
  23931. */
  23932. set colorGradingEnabled(value: boolean);
  23933. /**
  23934. * Gets exposure used in the effect.
  23935. */
  23936. get exposure(): number;
  23937. /**
  23938. * Sets exposure used in the effect.
  23939. */
  23940. set exposure(value: number);
  23941. /**
  23942. * Gets wether tonemapping is enabled or not.
  23943. */
  23944. get toneMappingEnabled(): boolean;
  23945. /**
  23946. * Sets wether tonemapping is enabled or not
  23947. */
  23948. set toneMappingEnabled(value: boolean);
  23949. /**
  23950. * Gets the type of tone mapping effect.
  23951. */
  23952. get toneMappingType(): number;
  23953. /**
  23954. * Sets the type of tone mapping effect.
  23955. */
  23956. set toneMappingType(value: number);
  23957. /**
  23958. * Gets contrast used in the effect.
  23959. */
  23960. get contrast(): number;
  23961. /**
  23962. * Sets contrast used in the effect.
  23963. */
  23964. set contrast(value: number);
  23965. /**
  23966. * Gets Vignette stretch size.
  23967. */
  23968. get vignetteStretch(): number;
  23969. /**
  23970. * Sets Vignette stretch size.
  23971. */
  23972. set vignetteStretch(value: number);
  23973. /**
  23974. * Gets Vignette centre X Offset.
  23975. */
  23976. get vignetteCentreX(): number;
  23977. /**
  23978. * Sets Vignette centre X Offset.
  23979. */
  23980. set vignetteCentreX(value: number);
  23981. /**
  23982. * Gets Vignette centre Y Offset.
  23983. */
  23984. get vignetteCentreY(): number;
  23985. /**
  23986. * Sets Vignette centre Y Offset.
  23987. */
  23988. set vignetteCentreY(value: number);
  23989. /**
  23990. * Gets Vignette weight or intensity of the vignette effect.
  23991. */
  23992. get vignetteWeight(): number;
  23993. /**
  23994. * Sets Vignette weight or intensity of the vignette effect.
  23995. */
  23996. set vignetteWeight(value: number);
  23997. /**
  23998. * Gets Color of the vignette applied on the screen through the chosen blend mode (vignetteBlendMode)
  23999. * if vignetteEnabled is set to true.
  24000. */
  24001. get vignetteColor(): Color4;
  24002. /**
  24003. * Sets Color of the vignette applied on the screen through the chosen blend mode (vignetteBlendMode)
  24004. * if vignetteEnabled is set to true.
  24005. */
  24006. set vignetteColor(value: Color4);
  24007. /**
  24008. * Gets Camera field of view used by the Vignette effect.
  24009. */
  24010. get vignetteCameraFov(): number;
  24011. /**
  24012. * Sets Camera field of view used by the Vignette effect.
  24013. */
  24014. set vignetteCameraFov(value: number);
  24015. /**
  24016. * Gets the vignette blend mode allowing different kind of effect.
  24017. */
  24018. get vignetteBlendMode(): number;
  24019. /**
  24020. * Sets the vignette blend mode allowing different kind of effect.
  24021. */
  24022. set vignetteBlendMode(value: number);
  24023. /**
  24024. * Gets wether the vignette effect is enabled.
  24025. */
  24026. get vignetteEnabled(): boolean;
  24027. /**
  24028. * Sets wether the vignette effect is enabled.
  24029. */
  24030. set vignetteEnabled(value: boolean);
  24031. private _fromLinearSpace;
  24032. /**
  24033. * Gets wether the input of the processing is in Gamma or Linear Space.
  24034. */
  24035. get fromLinearSpace(): boolean;
  24036. /**
  24037. * Sets wether the input of the processing is in Gamma or Linear Space.
  24038. */
  24039. set fromLinearSpace(value: boolean);
  24040. /**
  24041. * Defines cache preventing GC.
  24042. */
  24043. private _defines;
  24044. constructor(name: string, options: number | PostProcessOptions, camera?: Nullable<Camera>, samplingMode?: number, engine?: Engine, reusable?: boolean, textureType?: number, imageProcessingConfiguration?: ImageProcessingConfiguration);
  24045. /**
  24046. * "ImageProcessingPostProcess"
  24047. * @returns "ImageProcessingPostProcess"
  24048. */
  24049. getClassName(): string;
  24050. /**
  24051. * @hidden
  24052. */
  24053. _updateParameters(): void;
  24054. dispose(camera?: Camera): void;
  24055. }
  24056. }
  24057. declare module "babylonjs/Rendering/prePassEffectConfiguration" {
  24058. import { PostProcess } from "babylonjs/PostProcesses/postProcess";
  24059. /**
  24060. * Interface for defining prepass effects in the prepass post-process pipeline
  24061. */
  24062. export interface PrePassEffectConfiguration {
  24063. /**
  24064. * Name of the effect
  24065. */
  24066. name: string;
  24067. /**
  24068. * Post process to attach for this effect
  24069. */
  24070. postProcess?: PostProcess;
  24071. /**
  24072. * Textures required in the MRT
  24073. */
  24074. texturesRequired: number[];
  24075. /**
  24076. * Is the effect enabled
  24077. */
  24078. enabled: boolean;
  24079. /**
  24080. * Disposes the effect configuration
  24081. */
  24082. dispose?: () => void;
  24083. /**
  24084. * Creates the associated post process
  24085. */
  24086. createPostProcess?: () => PostProcess;
  24087. }
  24088. }
  24089. declare module "babylonjs/Materials/fresnelParameters" {
  24090. import { DeepImmutable } from "babylonjs/types";
  24091. import { Color3 } from "babylonjs/Maths/math.color";
  24092. /**
  24093. * Options to be used when creating a FresnelParameters.
  24094. */
  24095. export type IFresnelParametersCreationOptions = {
  24096. /**
  24097. * Define the color used on edges (grazing angle)
  24098. */
  24099. leftColor?: Color3;
  24100. /**
  24101. * Define the color used on center
  24102. */
  24103. rightColor?: Color3;
  24104. /**
  24105. * Define bias applied to computed fresnel term
  24106. */
  24107. bias?: number;
  24108. /**
  24109. * Defined the power exponent applied to fresnel term
  24110. */
  24111. power?: number;
  24112. /**
  24113. * Define if the fresnel effect is enable or not.
  24114. */
  24115. isEnabled?: boolean;
  24116. };
  24117. /**
  24118. * Serialized format for FresnelParameters.
  24119. */
  24120. export type IFresnelParametersSerialized = {
  24121. /**
  24122. * Define the color used on edges (grazing angle) [as an array]
  24123. */
  24124. leftColor: number[];
  24125. /**
  24126. * Define the color used on center [as an array]
  24127. */
  24128. rightColor: number[];
  24129. /**
  24130. * Define bias applied to computed fresnel term
  24131. */
  24132. bias: number;
  24133. /**
  24134. * Defined the power exponent applied to fresnel term
  24135. */
  24136. power?: number;
  24137. /**
  24138. * Define if the fresnel effect is enable or not.
  24139. */
  24140. isEnabled: boolean;
  24141. };
  24142. /**
  24143. * This represents all the required information to add a fresnel effect on a material:
  24144. * @see https://doc.babylonjs.com/how_to/how_to_use_fresnelparameters
  24145. */
  24146. export class FresnelParameters {
  24147. private _isEnabled;
  24148. /**
  24149. * Define if the fresnel effect is enable or not.
  24150. */
  24151. get isEnabled(): boolean;
  24152. set isEnabled(value: boolean);
  24153. /**
  24154. * Define the color used on edges (grazing angle)
  24155. */
  24156. leftColor: Color3;
  24157. /**
  24158. * Define the color used on center
  24159. */
  24160. rightColor: Color3;
  24161. /**
  24162. * Define bias applied to computed fresnel term
  24163. */
  24164. bias: number;
  24165. /**
  24166. * Defined the power exponent applied to fresnel term
  24167. */
  24168. power: number;
  24169. /**
  24170. * Creates a new FresnelParameters object.
  24171. *
  24172. * @param options provide your own settings to optionally to override defaults
  24173. */
  24174. constructor(options?: IFresnelParametersCreationOptions);
  24175. /**
  24176. * Clones the current fresnel and its valuues
  24177. * @returns a clone fresnel configuration
  24178. */
  24179. clone(): FresnelParameters;
  24180. /**
  24181. * Determines equality between FresnelParameters objects
  24182. * @param otherFresnelParameters defines the second operand
  24183. * @returns true if the power, bias, leftColor, rightColor and isEnabled values are equal to the given ones
  24184. */
  24185. equals(otherFresnelParameters: DeepImmutable<FresnelParameters>): boolean;
  24186. /**
  24187. * Serializes the current fresnel parameters to a JSON representation.
  24188. * @return the JSON serialization
  24189. */
  24190. serialize(): IFresnelParametersSerialized;
  24191. /**
  24192. * Parse a JSON object and deserialize it to a new Fresnel parameter object.
  24193. * @param parsedFresnelParameters Define the JSON representation
  24194. * @returns the parsed parameters
  24195. */
  24196. static Parse(parsedFresnelParameters: IFresnelParametersSerialized): FresnelParameters;
  24197. }
  24198. }
  24199. declare module "babylonjs/Materials/materialFlags" {
  24200. /**
  24201. * This groups all the flags used to control the materials channel.
  24202. */
  24203. export class MaterialFlags {
  24204. private static _DiffuseTextureEnabled;
  24205. /**
  24206. * Are diffuse textures enabled in the application.
  24207. */
  24208. static get DiffuseTextureEnabled(): boolean;
  24209. static set DiffuseTextureEnabled(value: boolean);
  24210. private static _DetailTextureEnabled;
  24211. /**
  24212. * Are detail textures enabled in the application.
  24213. */
  24214. static get DetailTextureEnabled(): boolean;
  24215. static set DetailTextureEnabled(value: boolean);
  24216. private static _AmbientTextureEnabled;
  24217. /**
  24218. * Are ambient textures enabled in the application.
  24219. */
  24220. static get AmbientTextureEnabled(): boolean;
  24221. static set AmbientTextureEnabled(value: boolean);
  24222. private static _OpacityTextureEnabled;
  24223. /**
  24224. * Are opacity textures enabled in the application.
  24225. */
  24226. static get OpacityTextureEnabled(): boolean;
  24227. static set OpacityTextureEnabled(value: boolean);
  24228. private static _ReflectionTextureEnabled;
  24229. /**
  24230. * Are reflection textures enabled in the application.
  24231. */
  24232. static get ReflectionTextureEnabled(): boolean;
  24233. static set ReflectionTextureEnabled(value: boolean);
  24234. private static _EmissiveTextureEnabled;
  24235. /**
  24236. * Are emissive textures enabled in the application.
  24237. */
  24238. static get EmissiveTextureEnabled(): boolean;
  24239. static set EmissiveTextureEnabled(value: boolean);
  24240. private static _SpecularTextureEnabled;
  24241. /**
  24242. * Are specular textures enabled in the application.
  24243. */
  24244. static get SpecularTextureEnabled(): boolean;
  24245. static set SpecularTextureEnabled(value: boolean);
  24246. private static _BumpTextureEnabled;
  24247. /**
  24248. * Are bump textures enabled in the application.
  24249. */
  24250. static get BumpTextureEnabled(): boolean;
  24251. static set BumpTextureEnabled(value: boolean);
  24252. private static _LightmapTextureEnabled;
  24253. /**
  24254. * Are lightmap textures enabled in the application.
  24255. */
  24256. static get LightmapTextureEnabled(): boolean;
  24257. static set LightmapTextureEnabled(value: boolean);
  24258. private static _RefractionTextureEnabled;
  24259. /**
  24260. * Are refraction textures enabled in the application.
  24261. */
  24262. static get RefractionTextureEnabled(): boolean;
  24263. static set RefractionTextureEnabled(value: boolean);
  24264. private static _ColorGradingTextureEnabled;
  24265. /**
  24266. * Are color grading textures enabled in the application.
  24267. */
  24268. static get ColorGradingTextureEnabled(): boolean;
  24269. static set ColorGradingTextureEnabled(value: boolean);
  24270. private static _FresnelEnabled;
  24271. /**
  24272. * Are fresnels enabled in the application.
  24273. */
  24274. static get FresnelEnabled(): boolean;
  24275. static set FresnelEnabled(value: boolean);
  24276. private static _ClearCoatTextureEnabled;
  24277. /**
  24278. * Are clear coat textures enabled in the application.
  24279. */
  24280. static get ClearCoatTextureEnabled(): boolean;
  24281. static set ClearCoatTextureEnabled(value: boolean);
  24282. private static _ClearCoatBumpTextureEnabled;
  24283. /**
  24284. * Are clear coat bump textures enabled in the application.
  24285. */
  24286. static get ClearCoatBumpTextureEnabled(): boolean;
  24287. static set ClearCoatBumpTextureEnabled(value: boolean);
  24288. private static _ClearCoatTintTextureEnabled;
  24289. /**
  24290. * Are clear coat tint textures enabled in the application.
  24291. */
  24292. static get ClearCoatTintTextureEnabled(): boolean;
  24293. static set ClearCoatTintTextureEnabled(value: boolean);
  24294. private static _SheenTextureEnabled;
  24295. /**
  24296. * Are sheen textures enabled in the application.
  24297. */
  24298. static get SheenTextureEnabled(): boolean;
  24299. static set SheenTextureEnabled(value: boolean);
  24300. private static _AnisotropicTextureEnabled;
  24301. /**
  24302. * Are anisotropic textures enabled in the application.
  24303. */
  24304. static get AnisotropicTextureEnabled(): boolean;
  24305. static set AnisotropicTextureEnabled(value: boolean);
  24306. private static _ThicknessTextureEnabled;
  24307. /**
  24308. * Are thickness textures enabled in the application.
  24309. */
  24310. static get ThicknessTextureEnabled(): boolean;
  24311. static set ThicknessTextureEnabled(value: boolean);
  24312. }
  24313. }
  24314. declare module "babylonjs/Shaders/ShadersInclude/defaultFragmentDeclaration" {
  24315. /** @hidden */
  24316. export var defaultFragmentDeclaration: {
  24317. name: string;
  24318. shader: string;
  24319. };
  24320. }
  24321. declare module "babylonjs/Shaders/ShadersInclude/defaultUboDeclaration" {
  24322. /** @hidden */
  24323. export var defaultUboDeclaration: {
  24324. name: string;
  24325. shader: string;
  24326. };
  24327. }
  24328. declare module "babylonjs/Shaders/ShadersInclude/prePassDeclaration" {
  24329. /** @hidden */
  24330. export var prePassDeclaration: {
  24331. name: string;
  24332. shader: string;
  24333. };
  24334. }
  24335. declare module "babylonjs/Shaders/ShadersInclude/lightFragmentDeclaration" {
  24336. /** @hidden */
  24337. export var lightFragmentDeclaration: {
  24338. name: string;
  24339. shader: string;
  24340. };
  24341. }
  24342. declare module "babylonjs/Shaders/ShadersInclude/lightUboDeclaration" {
  24343. /** @hidden */
  24344. export var lightUboDeclaration: {
  24345. name: string;
  24346. shader: string;
  24347. };
  24348. }
  24349. declare module "babylonjs/Shaders/ShadersInclude/lightsFragmentFunctions" {
  24350. /** @hidden */
  24351. export var lightsFragmentFunctions: {
  24352. name: string;
  24353. shader: string;
  24354. };
  24355. }
  24356. declare module "babylonjs/Shaders/ShadersInclude/shadowsFragmentFunctions" {
  24357. /** @hidden */
  24358. export var shadowsFragmentFunctions: {
  24359. name: string;
  24360. shader: string;
  24361. };
  24362. }
  24363. declare module "babylonjs/Shaders/ShadersInclude/fresnelFunction" {
  24364. /** @hidden */
  24365. export var fresnelFunction: {
  24366. name: string;
  24367. shader: string;
  24368. };
  24369. }
  24370. declare module "babylonjs/Shaders/ShadersInclude/bumpFragmentMainFunctions" {
  24371. /** @hidden */
  24372. export var bumpFragmentMainFunctions: {
  24373. name: string;
  24374. shader: string;
  24375. };
  24376. }
  24377. declare module "babylonjs/Shaders/ShadersInclude/bumpFragmentFunctions" {
  24378. /** @hidden */
  24379. export var bumpFragmentFunctions: {
  24380. name: string;
  24381. shader: string;
  24382. };
  24383. }
  24384. declare module "babylonjs/Shaders/ShadersInclude/logDepthDeclaration" {
  24385. /** @hidden */
  24386. export var logDepthDeclaration: {
  24387. name: string;
  24388. shader: string;
  24389. };
  24390. }
  24391. declare module "babylonjs/Shaders/ShadersInclude/bumpFragment" {
  24392. /** @hidden */
  24393. export var bumpFragment: {
  24394. name: string;
  24395. shader: string;
  24396. };
  24397. }
  24398. declare module "babylonjs/Shaders/ShadersInclude/depthPrePass" {
  24399. /** @hidden */
  24400. export var depthPrePass: {
  24401. name: string;
  24402. shader: string;
  24403. };
  24404. }
  24405. declare module "babylonjs/Shaders/ShadersInclude/lightFragment" {
  24406. /** @hidden */
  24407. export var lightFragment: {
  24408. name: string;
  24409. shader: string;
  24410. };
  24411. }
  24412. declare module "babylonjs/Shaders/ShadersInclude/logDepthFragment" {
  24413. /** @hidden */
  24414. export var logDepthFragment: {
  24415. name: string;
  24416. shader: string;
  24417. };
  24418. }
  24419. declare module "babylonjs/Shaders/default.fragment" {
  24420. import "babylonjs/Shaders/ShadersInclude/defaultFragmentDeclaration";
  24421. import "babylonjs/Shaders/ShadersInclude/defaultUboDeclaration";
  24422. import "babylonjs/Shaders/ShadersInclude/prePassDeclaration";
  24423. import "babylonjs/Shaders/ShadersInclude/helperFunctions";
  24424. import "babylonjs/Shaders/ShadersInclude/lightFragmentDeclaration";
  24425. import "babylonjs/Shaders/ShadersInclude/lightUboDeclaration";
  24426. import "babylonjs/Shaders/ShadersInclude/lightsFragmentFunctions";
  24427. import "babylonjs/Shaders/ShadersInclude/shadowsFragmentFunctions";
  24428. import "babylonjs/Shaders/ShadersInclude/fresnelFunction";
  24429. import "babylonjs/Shaders/ShadersInclude/reflectionFunction";
  24430. import "babylonjs/Shaders/ShadersInclude/imageProcessingDeclaration";
  24431. import "babylonjs/Shaders/ShadersInclude/imageProcessingFunctions";
  24432. import "babylonjs/Shaders/ShadersInclude/bumpFragmentMainFunctions";
  24433. import "babylonjs/Shaders/ShadersInclude/bumpFragmentFunctions";
  24434. import "babylonjs/Shaders/ShadersInclude/clipPlaneFragmentDeclaration";
  24435. import "babylonjs/Shaders/ShadersInclude/logDepthDeclaration";
  24436. import "babylonjs/Shaders/ShadersInclude/fogFragmentDeclaration";
  24437. import "babylonjs/Shaders/ShadersInclude/clipPlaneFragment";
  24438. import "babylonjs/Shaders/ShadersInclude/bumpFragment";
  24439. import "babylonjs/Shaders/ShadersInclude/depthPrePass";
  24440. import "babylonjs/Shaders/ShadersInclude/lightFragment";
  24441. import "babylonjs/Shaders/ShadersInclude/logDepthFragment";
  24442. import "babylonjs/Shaders/ShadersInclude/fogFragment";
  24443. /** @hidden */
  24444. export var defaultPixelShader: {
  24445. name: string;
  24446. shader: string;
  24447. };
  24448. }
  24449. declare module "babylonjs/Shaders/ShadersInclude/defaultVertexDeclaration" {
  24450. /** @hidden */
  24451. export var defaultVertexDeclaration: {
  24452. name: string;
  24453. shader: string;
  24454. };
  24455. }
  24456. declare module "babylonjs/Shaders/ShadersInclude/prePassVertexDeclaration" {
  24457. /** @hidden */
  24458. export var prePassVertexDeclaration: {
  24459. name: string;
  24460. shader: string;
  24461. };
  24462. }
  24463. declare module "babylonjs/Shaders/ShadersInclude/bumpVertexDeclaration" {
  24464. /** @hidden */
  24465. export var bumpVertexDeclaration: {
  24466. name: string;
  24467. shader: string;
  24468. };
  24469. }
  24470. declare module "babylonjs/Shaders/ShadersInclude/prePassVertex" {
  24471. /** @hidden */
  24472. export var prePassVertex: {
  24473. name: string;
  24474. shader: string;
  24475. };
  24476. }
  24477. declare module "babylonjs/Shaders/ShadersInclude/bumpVertex" {
  24478. /** @hidden */
  24479. export var bumpVertex: {
  24480. name: string;
  24481. shader: string;
  24482. };
  24483. }
  24484. declare module "babylonjs/Shaders/ShadersInclude/fogVertex" {
  24485. /** @hidden */
  24486. export var fogVertex: {
  24487. name: string;
  24488. shader: string;
  24489. };
  24490. }
  24491. declare module "babylonjs/Shaders/ShadersInclude/shadowsVertex" {
  24492. /** @hidden */
  24493. export var shadowsVertex: {
  24494. name: string;
  24495. shader: string;
  24496. };
  24497. }
  24498. declare module "babylonjs/Shaders/ShadersInclude/pointCloudVertex" {
  24499. /** @hidden */
  24500. export var pointCloudVertex: {
  24501. name: string;
  24502. shader: string;
  24503. };
  24504. }
  24505. declare module "babylonjs/Shaders/ShadersInclude/logDepthVertex" {
  24506. /** @hidden */
  24507. export var logDepthVertex: {
  24508. name: string;
  24509. shader: string;
  24510. };
  24511. }
  24512. declare module "babylonjs/Shaders/default.vertex" {
  24513. import "babylonjs/Shaders/ShadersInclude/defaultVertexDeclaration";
  24514. import "babylonjs/Shaders/ShadersInclude/defaultUboDeclaration";
  24515. import "babylonjs/Shaders/ShadersInclude/helperFunctions";
  24516. import "babylonjs/Shaders/ShadersInclude/bonesDeclaration";
  24517. import "babylonjs/Shaders/ShadersInclude/instancesDeclaration";
  24518. import "babylonjs/Shaders/ShadersInclude/prePassVertexDeclaration";
  24519. import "babylonjs/Shaders/ShadersInclude/bumpVertexDeclaration";
  24520. import "babylonjs/Shaders/ShadersInclude/clipPlaneVertexDeclaration";
  24521. import "babylonjs/Shaders/ShadersInclude/fogVertexDeclaration";
  24522. import "babylonjs/Shaders/ShadersInclude/lightFragmentDeclaration";
  24523. import "babylonjs/Shaders/ShadersInclude/lightUboDeclaration";
  24524. import "babylonjs/Shaders/ShadersInclude/morphTargetsVertexGlobalDeclaration";
  24525. import "babylonjs/Shaders/ShadersInclude/morphTargetsVertexDeclaration";
  24526. import "babylonjs/Shaders/ShadersInclude/logDepthDeclaration";
  24527. import "babylonjs/Shaders/ShadersInclude/morphTargetsVertex";
  24528. import "babylonjs/Shaders/ShadersInclude/instancesVertex";
  24529. import "babylonjs/Shaders/ShadersInclude/bonesVertex";
  24530. import "babylonjs/Shaders/ShadersInclude/prePassVertex";
  24531. import "babylonjs/Shaders/ShadersInclude/bumpVertex";
  24532. import "babylonjs/Shaders/ShadersInclude/clipPlaneVertex";
  24533. import "babylonjs/Shaders/ShadersInclude/fogVertex";
  24534. import "babylonjs/Shaders/ShadersInclude/shadowsVertex";
  24535. import "babylonjs/Shaders/ShadersInclude/pointCloudVertex";
  24536. import "babylonjs/Shaders/ShadersInclude/logDepthVertex";
  24537. /** @hidden */
  24538. export var defaultVertexShader: {
  24539. name: string;
  24540. shader: string;
  24541. };
  24542. }
  24543. declare module "babylonjs/Materials/material.detailMapConfiguration" {
  24544. import { Nullable } from "babylonjs/types";
  24545. import { Scene } from "babylonjs/scene";
  24546. import { BaseTexture } from "babylonjs/Materials/Textures/baseTexture";
  24547. import { UniformBuffer } from "babylonjs/Materials/uniformBuffer";
  24548. import { IAnimatable } from "babylonjs/Animations/animatable.interface";
  24549. /**
  24550. * @hidden
  24551. */
  24552. export interface IMaterialDetailMapDefines {
  24553. DETAIL: boolean;
  24554. DETAILDIRECTUV: number;
  24555. DETAIL_NORMALBLENDMETHOD: number;
  24556. /** @hidden */
  24557. _areTexturesDirty: boolean;
  24558. }
  24559. /**
  24560. * Define the code related to the detail map parameters of a material
  24561. *
  24562. * Inspired from:
  24563. * 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
  24564. * Unreal: https://docs.unrealengine.com/en-US/Engine/Rendering/Materials/HowTo/DetailTexturing/index.html
  24565. * Cryengine: https://docs.cryengine.com/display/SDKDOC2/Detail+Maps
  24566. */
  24567. export class DetailMapConfiguration {
  24568. private _texture;
  24569. /**
  24570. * The detail texture of the material.
  24571. */
  24572. texture: Nullable<BaseTexture>;
  24573. /**
  24574. * Defines how strongly the detail diffuse/albedo channel is blended with the regular diffuse/albedo texture
  24575. * Bigger values mean stronger blending
  24576. */
  24577. diffuseBlendLevel: number;
  24578. /**
  24579. * Defines how strongly the detail roughness channel is blended with the regular roughness value
  24580. * Bigger values mean stronger blending. Only used with PBR materials
  24581. */
  24582. roughnessBlendLevel: number;
  24583. /**
  24584. * Defines how strong the bump effect from the detail map is
  24585. * Bigger values mean stronger effect
  24586. */
  24587. bumpLevel: number;
  24588. private _normalBlendMethod;
  24589. /**
  24590. * The method used to blend the bump and detail normals together
  24591. */
  24592. normalBlendMethod: number;
  24593. private _isEnabled;
  24594. /**
  24595. * Enable or disable the detail map on this material
  24596. */
  24597. isEnabled: boolean;
  24598. /** @hidden */
  24599. private _internalMarkAllSubMeshesAsTexturesDirty;
  24600. /** @hidden */
  24601. _markAllSubMeshesAsTexturesDirty(): void;
  24602. /**
  24603. * Instantiate a new detail map
  24604. * @param markAllSubMeshesAsTexturesDirty Callback to flag the material to dirty
  24605. */
  24606. constructor(markAllSubMeshesAsTexturesDirty: () => void);
  24607. /**
  24608. * Gets whether the submesh is ready to be used or not.
  24609. * @param defines the list of "defines" to update.
  24610. * @param scene defines the scene the material belongs to.
  24611. * @returns - boolean indicating that the submesh is ready or not.
  24612. */
  24613. isReadyForSubMesh(defines: IMaterialDetailMapDefines, scene: Scene): boolean;
  24614. /**
  24615. * Update the defines for detail map usage
  24616. * @param defines the list of "defines" to update.
  24617. * @param scene defines the scene the material belongs to.
  24618. */
  24619. prepareDefines(defines: IMaterialDetailMapDefines, scene: Scene): void;
  24620. /**
  24621. * Binds the material data.
  24622. * @param uniformBuffer defines the Uniform buffer to fill in.
  24623. * @param scene defines the scene the material belongs to.
  24624. * @param isFrozen defines whether the material is frozen or not.
  24625. */
  24626. bindForSubMesh(uniformBuffer: UniformBuffer, scene: Scene, isFrozen: boolean): void;
  24627. /**
  24628. * Checks to see if a texture is used in the material.
  24629. * @param texture - Base texture to use.
  24630. * @returns - Boolean specifying if a texture is used in the material.
  24631. */
  24632. hasTexture(texture: BaseTexture): boolean;
  24633. /**
  24634. * Returns an array of the actively used textures.
  24635. * @param activeTextures Array of BaseTextures
  24636. */
  24637. getActiveTextures(activeTextures: BaseTexture[]): void;
  24638. /**
  24639. * Returns the animatable textures.
  24640. * @param animatables Array of animatable textures.
  24641. */
  24642. getAnimatables(animatables: IAnimatable[]): void;
  24643. /**
  24644. * Disposes the resources of the material.
  24645. * @param forceDisposeTextures - Forces the disposal of all textures.
  24646. */
  24647. dispose(forceDisposeTextures?: boolean): void;
  24648. /**
  24649. * Get the current class name useful for serialization or dynamic coding.
  24650. * @returns "DetailMap"
  24651. */
  24652. getClassName(): string;
  24653. /**
  24654. * Add the required uniforms to the current list.
  24655. * @param uniforms defines the current uniform list.
  24656. */
  24657. static AddUniforms(uniforms: string[]): void;
  24658. /**
  24659. * Add the required samplers to the current list.
  24660. * @param samplers defines the current sampler list.
  24661. */
  24662. static AddSamplers(samplers: string[]): void;
  24663. /**
  24664. * Add the required uniforms to the current buffer.
  24665. * @param uniformBuffer defines the current uniform buffer.
  24666. */
  24667. static PrepareUniformBuffer(uniformBuffer: UniformBuffer): void;
  24668. /**
  24669. * Makes a duplicate of the current instance into another one.
  24670. * @param detailMap define the instance where to copy the info
  24671. */
  24672. copyTo(detailMap: DetailMapConfiguration): void;
  24673. /**
  24674. * Serializes this detail map instance
  24675. * @returns - An object with the serialized instance.
  24676. */
  24677. serialize(): any;
  24678. /**
  24679. * Parses a detail map setting from a serialized object.
  24680. * @param source - Serialized object.
  24681. * @param scene Defines the scene we are parsing for
  24682. * @param rootUrl Defines the rootUrl to load from
  24683. */
  24684. parse(source: any, scene: Scene, rootUrl: string): void;
  24685. }
  24686. }
  24687. declare module "babylonjs/Materials/standardMaterial" {
  24688. import { SmartArray } from "babylonjs/Misc/smartArray";
  24689. import { IAnimatable } from "babylonjs/Animations/animatable.interface";
  24690. import { Nullable } from "babylonjs/types";
  24691. import { Scene } from "babylonjs/scene";
  24692. import { Matrix } from "babylonjs/Maths/math.vector";
  24693. import { Color3 } from "babylonjs/Maths/math.color";
  24694. import { SubMesh } from "babylonjs/Meshes/subMesh";
  24695. import { AbstractMesh } from "babylonjs/Meshes/abstractMesh";
  24696. import { Mesh } from "babylonjs/Meshes/mesh";
  24697. import { PrePassConfiguration } from "babylonjs/Materials/prePassConfiguration";
  24698. import { ImageProcessingConfiguration, IImageProcessingConfigurationDefines } from "babylonjs/Materials/imageProcessingConfiguration";
  24699. import { ColorCurves } from "babylonjs/Materials/colorCurves";
  24700. import { FresnelParameters } from "babylonjs/Materials/fresnelParameters";
  24701. import { MaterialDefines } from "babylonjs/Materials/materialDefines";
  24702. import { PushMaterial } from "babylonjs/Materials/pushMaterial";
  24703. import { BaseTexture } from "babylonjs/Materials/Textures/baseTexture";
  24704. import { RenderTargetTexture } from "babylonjs/Materials/Textures/renderTargetTexture";
  24705. import "babylonjs/Shaders/default.fragment";
  24706. import "babylonjs/Shaders/default.vertex";
  24707. import { IMaterialDetailMapDefines, DetailMapConfiguration } from "babylonjs/Materials/material.detailMapConfiguration";
  24708. /** @hidden */
  24709. export class StandardMaterialDefines extends MaterialDefines implements IImageProcessingConfigurationDefines, IMaterialDetailMapDefines {
  24710. MAINUV1: boolean;
  24711. MAINUV2: boolean;
  24712. DIFFUSE: boolean;
  24713. DIFFUSEDIRECTUV: number;
  24714. DETAIL: boolean;
  24715. DETAILDIRECTUV: number;
  24716. DETAIL_NORMALBLENDMETHOD: number;
  24717. AMBIENT: boolean;
  24718. AMBIENTDIRECTUV: number;
  24719. OPACITY: boolean;
  24720. OPACITYDIRECTUV: number;
  24721. OPACITYRGB: boolean;
  24722. REFLECTION: boolean;
  24723. EMISSIVE: boolean;
  24724. EMISSIVEDIRECTUV: number;
  24725. SPECULAR: boolean;
  24726. SPECULARDIRECTUV: number;
  24727. BUMP: boolean;
  24728. BUMPDIRECTUV: number;
  24729. PARALLAX: boolean;
  24730. PARALLAXOCCLUSION: boolean;
  24731. SPECULAROVERALPHA: boolean;
  24732. CLIPPLANE: boolean;
  24733. CLIPPLANE2: boolean;
  24734. CLIPPLANE3: boolean;
  24735. CLIPPLANE4: boolean;
  24736. CLIPPLANE5: boolean;
  24737. CLIPPLANE6: boolean;
  24738. ALPHATEST: boolean;
  24739. DEPTHPREPASS: boolean;
  24740. ALPHAFROMDIFFUSE: boolean;
  24741. POINTSIZE: boolean;
  24742. FOG: boolean;
  24743. SPECULARTERM: boolean;
  24744. DIFFUSEFRESNEL: boolean;
  24745. OPACITYFRESNEL: boolean;
  24746. REFLECTIONFRESNEL: boolean;
  24747. REFRACTIONFRESNEL: boolean;
  24748. EMISSIVEFRESNEL: boolean;
  24749. FRESNEL: boolean;
  24750. NORMAL: boolean;
  24751. UV1: boolean;
  24752. UV2: boolean;
  24753. VERTEXCOLOR: boolean;
  24754. VERTEXALPHA: boolean;
  24755. NUM_BONE_INFLUENCERS: number;
  24756. BonesPerMesh: number;
  24757. BONETEXTURE: boolean;
  24758. BONES_VELOCITY_ENABLED: boolean;
  24759. INSTANCES: boolean;
  24760. THIN_INSTANCES: boolean;
  24761. GLOSSINESS: boolean;
  24762. ROUGHNESS: boolean;
  24763. EMISSIVEASILLUMINATION: boolean;
  24764. LINKEMISSIVEWITHDIFFUSE: boolean;
  24765. REFLECTIONFRESNELFROMSPECULAR: boolean;
  24766. LIGHTMAP: boolean;
  24767. LIGHTMAPDIRECTUV: number;
  24768. OBJECTSPACE_NORMALMAP: boolean;
  24769. USELIGHTMAPASSHADOWMAP: boolean;
  24770. REFLECTIONMAP_3D: boolean;
  24771. REFLECTIONMAP_SPHERICAL: boolean;
  24772. REFLECTIONMAP_PLANAR: boolean;
  24773. REFLECTIONMAP_CUBIC: boolean;
  24774. USE_LOCAL_REFLECTIONMAP_CUBIC: boolean;
  24775. REFLECTIONMAP_PROJECTION: boolean;
  24776. REFLECTIONMAP_SKYBOX: boolean;
  24777. REFLECTIONMAP_EXPLICIT: boolean;
  24778. REFLECTIONMAP_EQUIRECTANGULAR: boolean;
  24779. REFLECTIONMAP_EQUIRECTANGULAR_FIXED: boolean;
  24780. REFLECTIONMAP_MIRROREDEQUIRECTANGULAR_FIXED: boolean;
  24781. INVERTCUBICMAP: boolean;
  24782. LOGARITHMICDEPTH: boolean;
  24783. REFRACTION: boolean;
  24784. REFRACTIONMAP_3D: boolean;
  24785. REFLECTIONOVERALPHA: boolean;
  24786. TWOSIDEDLIGHTING: boolean;
  24787. SHADOWFLOAT: boolean;
  24788. MORPHTARGETS: boolean;
  24789. MORPHTARGETS_NORMAL: boolean;
  24790. MORPHTARGETS_TANGENT: boolean;
  24791. MORPHTARGETS_UV: boolean;
  24792. NUM_MORPH_INFLUENCERS: number;
  24793. NONUNIFORMSCALING: boolean;
  24794. PREMULTIPLYALPHA: boolean;
  24795. ALPHATEST_AFTERALLALPHACOMPUTATIONS: boolean;
  24796. ALPHABLEND: boolean;
  24797. PREPASS: boolean;
  24798. PREPASS_IRRADIANCE: boolean;
  24799. PREPASS_IRRADIANCE_INDEX: number;
  24800. PREPASS_ALBEDO: boolean;
  24801. PREPASS_ALBEDO_INDEX: number;
  24802. PREPASS_DEPTHNORMAL: boolean;
  24803. PREPASS_DEPTHNORMAL_INDEX: number;
  24804. PREPASS_POSITION: boolean;
  24805. PREPASS_POSITION_INDEX: number;
  24806. PREPASS_VELOCITY: boolean;
  24807. PREPASS_VELOCITY_INDEX: number;
  24808. PREPASS_REFLECTIVITY: boolean;
  24809. PREPASS_REFLECTIVITY_INDEX: number;
  24810. SCENE_MRT_COUNT: number;
  24811. RGBDLIGHTMAP: boolean;
  24812. RGBDREFLECTION: boolean;
  24813. RGBDREFRACTION: boolean;
  24814. IMAGEPROCESSING: boolean;
  24815. VIGNETTE: boolean;
  24816. VIGNETTEBLENDMODEMULTIPLY: boolean;
  24817. VIGNETTEBLENDMODEOPAQUE: boolean;
  24818. TONEMAPPING: boolean;
  24819. TONEMAPPING_ACES: boolean;
  24820. CONTRAST: boolean;
  24821. COLORCURVES: boolean;
  24822. COLORGRADING: boolean;
  24823. COLORGRADING3D: boolean;
  24824. SAMPLER3DGREENDEPTH: boolean;
  24825. SAMPLER3DBGRMAP: boolean;
  24826. IMAGEPROCESSINGPOSTPROCESS: boolean;
  24827. MULTIVIEW: boolean;
  24828. /**
  24829. * If the reflection texture on this material is in linear color space
  24830. * @hidden
  24831. */
  24832. IS_REFLECTION_LINEAR: boolean;
  24833. /**
  24834. * If the refraction texture on this material is in linear color space
  24835. * @hidden
  24836. */
  24837. IS_REFRACTION_LINEAR: boolean;
  24838. EXPOSURE: boolean;
  24839. constructor();
  24840. setReflectionMode(modeToEnable: string): void;
  24841. }
  24842. /**
  24843. * This is the default material used in Babylon. It is the best trade off between quality
  24844. * and performances.
  24845. * @see https://doc.babylonjs.com/babylon101/materials
  24846. */
  24847. export class StandardMaterial extends PushMaterial {
  24848. private _diffuseTexture;
  24849. /**
  24850. * The basic texture of the material as viewed under a light.
  24851. */
  24852. diffuseTexture: Nullable<BaseTexture>;
  24853. private _ambientTexture;
  24854. /**
  24855. * AKA Occlusion Texture in other nomenclature, it helps adding baked shadows into your material.
  24856. */
  24857. ambientTexture: Nullable<BaseTexture>;
  24858. private _opacityTexture;
  24859. /**
  24860. * Define the transparency of the material from a texture.
  24861. * The final alpha value can be read either from the red channel (if texture.getAlphaFromRGB is false)
  24862. * or from the luminance or the current texel (if texture.getAlphaFromRGB is true)
  24863. */
  24864. opacityTexture: Nullable<BaseTexture>;
  24865. private _reflectionTexture;
  24866. /**
  24867. * Define the texture used to display the reflection.
  24868. * @see https://doc.babylonjs.com/how_to/reflect#how-to-obtain-reflections-and-refractions
  24869. */
  24870. reflectionTexture: Nullable<BaseTexture>;
  24871. private _emissiveTexture;
  24872. /**
  24873. * Define texture of the material as if self lit.
  24874. * This will be mixed in the final result even in the absence of light.
  24875. */
  24876. emissiveTexture: Nullable<BaseTexture>;
  24877. private _specularTexture;
  24878. /**
  24879. * Define how the color and intensity of the highlight given by the light in the material.
  24880. */
  24881. specularTexture: Nullable<BaseTexture>;
  24882. private _bumpTexture;
  24883. /**
  24884. * Bump mapping is a technique to simulate bump and dents on a rendered surface.
  24885. * 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.
  24886. * @see https://doc.babylonjs.com/how_to/more_materials#bump-map
  24887. */
  24888. bumpTexture: Nullable<BaseTexture>;
  24889. private _lightmapTexture;
  24890. /**
  24891. * Complex lighting can be computationally expensive to compute at runtime.
  24892. * To save on computation, lightmaps may be used to store calculated lighting in a texture which will be applied to a given mesh.
  24893. * @see https://doc.babylonjs.com/babylon101/lights#lightmaps
  24894. */
  24895. lightmapTexture: Nullable<BaseTexture>;
  24896. private _refractionTexture;
  24897. /**
  24898. * Define the texture used to display the refraction.
  24899. * @see https://doc.babylonjs.com/how_to/reflect#how-to-obtain-reflections-and-refractions
  24900. */
  24901. refractionTexture: Nullable<BaseTexture>;
  24902. /**
  24903. * The color of the material lit by the environmental background lighting.
  24904. * @see https://doc.babylonjs.com/babylon101/materials#ambient-color-example
  24905. */
  24906. ambientColor: Color3;
  24907. /**
  24908. * The basic color of the material as viewed under a light.
  24909. */
  24910. diffuseColor: Color3;
  24911. /**
  24912. * Define how the color and intensity of the highlight given by the light in the material.
  24913. */
  24914. specularColor: Color3;
  24915. /**
  24916. * Define the color of the material as if self lit.
  24917. * This will be mixed in the final result even in the absence of light.
  24918. */
  24919. emissiveColor: Color3;
  24920. /**
  24921. * Defines how sharp are the highlights in the material.
  24922. * The bigger the value the sharper giving a more glossy feeling to the result.
  24923. * Reversely, the smaller the value the blurrier giving a more rough feeling to the result.
  24924. */
  24925. specularPower: number;
  24926. private _useAlphaFromDiffuseTexture;
  24927. /**
  24928. * Does the transparency come from the diffuse texture alpha channel.
  24929. */
  24930. useAlphaFromDiffuseTexture: boolean;
  24931. private _useEmissiveAsIllumination;
  24932. /**
  24933. * If true, the emissive value is added into the end result, otherwise it is multiplied in.
  24934. */
  24935. useEmissiveAsIllumination: boolean;
  24936. private _linkEmissiveWithDiffuse;
  24937. /**
  24938. * If true, some kind of energy conservation will prevent the end result to be more than 1 by reducing
  24939. * the emissive level when the final color is close to one.
  24940. */
  24941. linkEmissiveWithDiffuse: boolean;
  24942. private _useSpecularOverAlpha;
  24943. /**
  24944. * Specifies that the material will keep the specular highlights over a transparent surface (only the most limunous ones).
  24945. * A car glass is a good exemple of that. When sun reflects on it you can not see what is behind.
  24946. */
  24947. useSpecularOverAlpha: boolean;
  24948. private _useReflectionOverAlpha;
  24949. /**
  24950. * Specifies that the material will keeps the reflection highlights over a transparent surface (only the most limunous ones).
  24951. * A car glass is a good exemple of that. When the street lights reflects on it you can not see what is behind.
  24952. */
  24953. useReflectionOverAlpha: boolean;
  24954. private _disableLighting;
  24955. /**
  24956. * Does lights from the scene impacts this material.
  24957. * It can be a nice trick for performance to disable lighting on a fully emissive material.
  24958. */
  24959. disableLighting: boolean;
  24960. private _useObjectSpaceNormalMap;
  24961. /**
  24962. * Allows using an object space normal map (instead of tangent space).
  24963. */
  24964. useObjectSpaceNormalMap: boolean;
  24965. private _useParallax;
  24966. /**
  24967. * Is parallax enabled or not.
  24968. * @see https://doc.babylonjs.com/how_to/using_parallax_mapping
  24969. */
  24970. useParallax: boolean;
  24971. private _useParallaxOcclusion;
  24972. /**
  24973. * Is parallax occlusion enabled or not.
  24974. * If true, the outcome is way more realistic than traditional Parallax but you can expect a performance hit that worthes consideration.
  24975. * @see https://doc.babylonjs.com/how_to/using_parallax_mapping
  24976. */
  24977. useParallaxOcclusion: boolean;
  24978. /**
  24979. * 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.
  24980. */
  24981. parallaxScaleBias: number;
  24982. private _roughness;
  24983. /**
  24984. * Helps to define how blurry the reflections should appears in the material.
  24985. */
  24986. roughness: number;
  24987. /**
  24988. * In case of refraction, define the value of the index of refraction.
  24989. * @see https://doc.babylonjs.com/how_to/reflect#how-to-obtain-reflections-and-refractions
  24990. */
  24991. indexOfRefraction: number;
  24992. /**
  24993. * Invert the refraction texture alongside the y axis.
  24994. * It can be useful with procedural textures or probe for instance.
  24995. * @see https://doc.babylonjs.com/how_to/reflect#how-to-obtain-reflections-and-refractions
  24996. */
  24997. invertRefractionY: boolean;
  24998. /**
  24999. * Defines the alpha limits in alpha test mode.
  25000. */
  25001. alphaCutOff: number;
  25002. private _useLightmapAsShadowmap;
  25003. /**
  25004. * In case of light mapping, define whether the map contains light or shadow informations.
  25005. */
  25006. useLightmapAsShadowmap: boolean;
  25007. private _diffuseFresnelParameters;
  25008. /**
  25009. * Define the diffuse fresnel parameters of the material.
  25010. * @see https://doc.babylonjs.com/how_to/how_to_use_fresnelparameters
  25011. */
  25012. diffuseFresnelParameters: FresnelParameters;
  25013. private _opacityFresnelParameters;
  25014. /**
  25015. * Define the opacity fresnel parameters of the material.
  25016. * @see https://doc.babylonjs.com/how_to/how_to_use_fresnelparameters
  25017. */
  25018. opacityFresnelParameters: FresnelParameters;
  25019. private _reflectionFresnelParameters;
  25020. /**
  25021. * Define the reflection fresnel parameters of the material.
  25022. * @see https://doc.babylonjs.com/how_to/how_to_use_fresnelparameters
  25023. */
  25024. reflectionFresnelParameters: FresnelParameters;
  25025. private _refractionFresnelParameters;
  25026. /**
  25027. * Define the refraction fresnel parameters of the material.
  25028. * @see https://doc.babylonjs.com/how_to/how_to_use_fresnelparameters
  25029. */
  25030. refractionFresnelParameters: FresnelParameters;
  25031. private _emissiveFresnelParameters;
  25032. /**
  25033. * Define the emissive fresnel parameters of the material.
  25034. * @see https://doc.babylonjs.com/how_to/how_to_use_fresnelparameters
  25035. */
  25036. emissiveFresnelParameters: FresnelParameters;
  25037. private _useReflectionFresnelFromSpecular;
  25038. /**
  25039. * If true automatically deducts the fresnels values from the material specularity.
  25040. * @see https://doc.babylonjs.com/how_to/how_to_use_fresnelparameters
  25041. */
  25042. useReflectionFresnelFromSpecular: boolean;
  25043. private _useGlossinessFromSpecularMapAlpha;
  25044. /**
  25045. * Defines if the glossiness/roughness of the material should be read from the specular map alpha channel
  25046. */
  25047. useGlossinessFromSpecularMapAlpha: boolean;
  25048. private _maxSimultaneousLights;
  25049. /**
  25050. * Defines the maximum number of lights that can be used in the material
  25051. */
  25052. maxSimultaneousLights: number;
  25053. private _invertNormalMapX;
  25054. /**
  25055. * If sets to true, x component of normal map value will invert (x = 1.0 - x).
  25056. */
  25057. invertNormalMapX: boolean;
  25058. private _invertNormalMapY;
  25059. /**
  25060. * If sets to true, y component of normal map value will invert (y = 1.0 - y).
  25061. */
  25062. invertNormalMapY: boolean;
  25063. private _twoSidedLighting;
  25064. /**
  25065. * If sets to true and backfaceCulling is false, normals will be flipped on the backside.
  25066. */
  25067. twoSidedLighting: boolean;
  25068. /**
  25069. * Default configuration related to image processing available in the standard Material.
  25070. */
  25071. protected _imageProcessingConfiguration: ImageProcessingConfiguration;
  25072. /**
  25073. * Gets the image processing configuration used either in this material.
  25074. */
  25075. get imageProcessingConfiguration(): ImageProcessingConfiguration;
  25076. /**
  25077. * Sets the Default image processing configuration used either in the this material.
  25078. *
  25079. * If sets to null, the scene one is in use.
  25080. */
  25081. set imageProcessingConfiguration(value: ImageProcessingConfiguration);
  25082. /**
  25083. * Keep track of the image processing observer to allow dispose and replace.
  25084. */
  25085. private _imageProcessingObserver;
  25086. /**
  25087. * Attaches a new image processing configuration to the Standard Material.
  25088. * @param configuration
  25089. */
  25090. protected _attachImageProcessingConfiguration(configuration: Nullable<ImageProcessingConfiguration>): void;
  25091. /**
  25092. * Defines additionnal PrePass parameters for the material.
  25093. */
  25094. readonly prePassConfiguration: PrePassConfiguration;
  25095. /**
  25096. * Gets wether the color curves effect is enabled.
  25097. */
  25098. get cameraColorCurvesEnabled(): boolean;
  25099. /**
  25100. * Sets wether the color curves effect is enabled.
  25101. */
  25102. set cameraColorCurvesEnabled(value: boolean);
  25103. /**
  25104. * Gets wether the color grading effect is enabled.
  25105. */
  25106. get cameraColorGradingEnabled(): boolean;
  25107. /**
  25108. * Gets wether the color grading effect is enabled.
  25109. */
  25110. set cameraColorGradingEnabled(value: boolean);
  25111. /**
  25112. * Gets wether tonemapping is enabled or not.
  25113. */
  25114. get cameraToneMappingEnabled(): boolean;
  25115. /**
  25116. * Sets wether tonemapping is enabled or not
  25117. */
  25118. set cameraToneMappingEnabled(value: boolean);
  25119. /**
  25120. * The camera exposure used on this material.
  25121. * This property is here and not in the camera to allow controlling exposure without full screen post process.
  25122. * This corresponds to a photographic exposure.
  25123. */
  25124. get cameraExposure(): number;
  25125. /**
  25126. * The camera exposure used on this material.
  25127. * This property is here and not in the camera to allow controlling exposure without full screen post process.
  25128. * This corresponds to a photographic exposure.
  25129. */
  25130. set cameraExposure(value: number);
  25131. /**
  25132. * Gets The camera contrast used on this material.
  25133. */
  25134. get cameraContrast(): number;
  25135. /**
  25136. * Sets The camera contrast used on this material.
  25137. */
  25138. set cameraContrast(value: number);
  25139. /**
  25140. * Gets the Color Grading 2D Lookup Texture.
  25141. */
  25142. get cameraColorGradingTexture(): Nullable<BaseTexture>;
  25143. /**
  25144. * Sets the Color Grading 2D Lookup Texture.
  25145. */
  25146. set cameraColorGradingTexture(value: Nullable<BaseTexture>);
  25147. /**
  25148. * The color grading curves provide additional color adjustmnent that is applied after any color grading transform (3D LUT).
  25149. * They allow basic adjustment of saturation and small exposure adjustments, along with color filter tinting to provide white balance adjustment or more stylistic effects.
  25150. * 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;
  25151. * corresponding to low luminance, medium luminance, and high luminance areas respectively.
  25152. */
  25153. get cameraColorCurves(): Nullable<ColorCurves>;
  25154. /**
  25155. * The color grading curves provide additional color adjustmnent that is applied after any color grading transform (3D LUT).
  25156. * They allow basic adjustment of saturation and small exposure adjustments, along with color filter tinting to provide white balance adjustment or more stylistic effects.
  25157. * 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;
  25158. * corresponding to low luminance, medium luminance, and high luminance areas respectively.
  25159. */
  25160. set cameraColorCurves(value: Nullable<ColorCurves>);
  25161. /**
  25162. * Can this material render to several textures at once
  25163. */
  25164. get canRenderToMRT(): boolean;
  25165. /**
  25166. * Defines the detail map parameters for the material.
  25167. */
  25168. readonly detailMap: DetailMapConfiguration;
  25169. protected _renderTargets: SmartArray<RenderTargetTexture>;
  25170. protected _worldViewProjectionMatrix: Matrix;
  25171. protected _globalAmbientColor: Color3;
  25172. protected _useLogarithmicDepth: boolean;
  25173. protected _rebuildInParallel: boolean;
  25174. /**
  25175. * Instantiates a new standard material.
  25176. * This is the default material used in Babylon. It is the best trade off between quality
  25177. * and performances.
  25178. * @see https://doc.babylonjs.com/babylon101/materials
  25179. * @param name Define the name of the material in the scene
  25180. * @param scene Define the scene the material belong to
  25181. */
  25182. constructor(name: string, scene: Scene);
  25183. /**
  25184. * Gets a boolean indicating that current material needs to register RTT
  25185. */
  25186. get hasRenderTargetTextures(): boolean;
  25187. /**
  25188. * Gets the current class name of the material e.g. "StandardMaterial"
  25189. * Mainly use in serialization.
  25190. * @returns the class name
  25191. */
  25192. getClassName(): string;
  25193. /**
  25194. * In case the depth buffer does not allow enough depth precision for your scene (might be the case in large scenes)
  25195. * You can try switching to logarithmic depth.
  25196. * @see https://doc.babylonjs.com/how_to/using_logarithmic_depth_buffer
  25197. */
  25198. get useLogarithmicDepth(): boolean;
  25199. set useLogarithmicDepth(value: boolean);
  25200. /**
  25201. * Specifies if the material will require alpha blending
  25202. * @returns a boolean specifying if alpha blending is needed
  25203. */
  25204. needAlphaBlending(): boolean;
  25205. /**
  25206. * Specifies if this material should be rendered in alpha test mode
  25207. * @returns a boolean specifying if an alpha test is needed.
  25208. */
  25209. needAlphaTesting(): boolean;
  25210. /**
  25211. * Specifies whether or not the alpha value of the diffuse texture should be used for alpha blending.
  25212. */
  25213. protected _shouldUseAlphaFromDiffuseTexture(): boolean;
  25214. /**
  25215. * Specifies whether or not there is a usable alpha channel for transparency.
  25216. */
  25217. protected _hasAlphaChannel(): boolean;
  25218. /**
  25219. * Get the texture used for alpha test purpose.
  25220. * @returns the diffuse texture in case of the standard material.
  25221. */
  25222. getAlphaTestTexture(): Nullable<BaseTexture>;
  25223. /**
  25224. * Get if the submesh is ready to be used and all its information available.
  25225. * Child classes can use it to update shaders
  25226. * @param mesh defines the mesh to check
  25227. * @param subMesh defines which submesh to check
  25228. * @param useInstances specifies that instances should be used
  25229. * @returns a boolean indicating that the submesh is ready or not
  25230. */
  25231. isReadyForSubMesh(mesh: AbstractMesh, subMesh: SubMesh, useInstances?: boolean): boolean;
  25232. /**
  25233. * Builds the material UBO layouts.
  25234. * Used internally during the effect preparation.
  25235. */
  25236. buildUniformLayout(): void;
  25237. /**
  25238. * Unbinds the material from the mesh
  25239. */
  25240. unbind(): void;
  25241. /**
  25242. * Binds the submesh to this material by preparing the effect and shader to draw
  25243. * @param world defines the world transformation matrix
  25244. * @param mesh defines the mesh containing the submesh
  25245. * @param subMesh defines the submesh to bind the material to
  25246. */
  25247. bindForSubMesh(world: Matrix, mesh: Mesh, subMesh: SubMesh): void;
  25248. /**
  25249. * Get the list of animatables in the material.
  25250. * @returns the list of animatables object used in the material
  25251. */
  25252. getAnimatables(): IAnimatable[];
  25253. /**
  25254. * Gets the active textures from the material
  25255. * @returns an array of textures
  25256. */
  25257. getActiveTextures(): BaseTexture[];
  25258. /**
  25259. * Specifies if the material uses a texture
  25260. * @param texture defines the texture to check against the material
  25261. * @returns a boolean specifying if the material uses the texture
  25262. */
  25263. hasTexture(texture: BaseTexture): boolean;
  25264. /**
  25265. * Disposes the material
  25266. * @param forceDisposeEffect specifies if effects should be forcefully disposed
  25267. * @param forceDisposeTextures specifies if textures should be forcefully disposed
  25268. */
  25269. dispose(forceDisposeEffect?: boolean, forceDisposeTextures?: boolean): void;
  25270. /**
  25271. * Makes a duplicate of the material, and gives it a new name
  25272. * @param name defines the new name for the duplicated material
  25273. * @returns the cloned material
  25274. */
  25275. clone(name: string): StandardMaterial;
  25276. /**
  25277. * Serializes this material in a JSON representation
  25278. * @returns the serialized material object
  25279. */
  25280. serialize(): any;
  25281. /**
  25282. * Creates a standard material from parsed material data
  25283. * @param source defines the JSON representation of the material
  25284. * @param scene defines the hosting scene
  25285. * @param rootUrl defines the root URL to use to load textures and relative dependencies
  25286. * @returns a new standard material
  25287. */
  25288. static Parse(source: any, scene: Scene, rootUrl: string): StandardMaterial;
  25289. /**
  25290. * Are diffuse textures enabled in the application.
  25291. */
  25292. static get DiffuseTextureEnabled(): boolean;
  25293. static set DiffuseTextureEnabled(value: boolean);
  25294. /**
  25295. * Are detail textures enabled in the application.
  25296. */
  25297. static get DetailTextureEnabled(): boolean;
  25298. static set DetailTextureEnabled(value: boolean);
  25299. /**
  25300. * Are ambient textures enabled in the application.
  25301. */
  25302. static get AmbientTextureEnabled(): boolean;
  25303. static set AmbientTextureEnabled(value: boolean);
  25304. /**
  25305. * Are opacity textures enabled in the application.
  25306. */
  25307. static get OpacityTextureEnabled(): boolean;
  25308. static set OpacityTextureEnabled(value: boolean);
  25309. /**
  25310. * Are reflection textures enabled in the application.
  25311. */
  25312. static get ReflectionTextureEnabled(): boolean;
  25313. static set ReflectionTextureEnabled(value: boolean);
  25314. /**
  25315. * Are emissive textures enabled in the application.
  25316. */
  25317. static get EmissiveTextureEnabled(): boolean;
  25318. static set EmissiveTextureEnabled(value: boolean);
  25319. /**
  25320. * Are specular textures enabled in the application.
  25321. */
  25322. static get SpecularTextureEnabled(): boolean;
  25323. static set SpecularTextureEnabled(value: boolean);
  25324. /**
  25325. * Are bump textures enabled in the application.
  25326. */
  25327. static get BumpTextureEnabled(): boolean;
  25328. static set BumpTextureEnabled(value: boolean);
  25329. /**
  25330. * Are lightmap textures enabled in the application.
  25331. */
  25332. static get LightmapTextureEnabled(): boolean;
  25333. static set LightmapTextureEnabled(value: boolean);
  25334. /**
  25335. * Are refraction textures enabled in the application.
  25336. */
  25337. static get RefractionTextureEnabled(): boolean;
  25338. static set RefractionTextureEnabled(value: boolean);
  25339. /**
  25340. * Are color grading textures enabled in the application.
  25341. */
  25342. static get ColorGradingTextureEnabled(): boolean;
  25343. static set ColorGradingTextureEnabled(value: boolean);
  25344. /**
  25345. * Are fresnels enabled in the application.
  25346. */
  25347. static get FresnelEnabled(): boolean;
  25348. static set FresnelEnabled(value: boolean);
  25349. }
  25350. }
  25351. declare module "babylonjs/Shaders/rgbdDecode.fragment" {
  25352. import "babylonjs/Shaders/ShadersInclude/helperFunctions";
  25353. /** @hidden */
  25354. export var rgbdDecodePixelShader: {
  25355. name: string;
  25356. shader: string;
  25357. };
  25358. }
  25359. declare module "babylonjs/Misc/rgbdTextureTools" {
  25360. import "babylonjs/Shaders/rgbdDecode.fragment";
  25361. import "babylonjs/Engines/Extensions/engine.renderTarget";
  25362. import { Texture } from "babylonjs/Materials/Textures/texture";
  25363. /**
  25364. * Class used to host RGBD texture specific utilities
  25365. */
  25366. export class RGBDTextureTools {
  25367. /**
  25368. * Expand the RGBD Texture from RGBD to Half Float if possible.
  25369. * @param texture the texture to expand.
  25370. */
  25371. static ExpandRGBDTexture(texture: Texture): void;
  25372. }
  25373. }
  25374. declare module "babylonjs/Misc/brdfTextureTools" {
  25375. import { BaseTexture } from "babylonjs/Materials/Textures/baseTexture";
  25376. import { Scene } from "babylonjs/scene";
  25377. /**
  25378. * Class used to host texture specific utilities
  25379. */
  25380. export class BRDFTextureTools {
  25381. /**
  25382. * Prevents texture cache collision
  25383. */
  25384. private static _instanceNumber;
  25385. /**
  25386. * Gets a default environment BRDF for MS-BRDF Height Correlated BRDF
  25387. * @param scene defines the hosting scene
  25388. * @returns the environment BRDF texture
  25389. */
  25390. static GetEnvironmentBRDFTexture(scene: Scene): BaseTexture;
  25391. private static _environmentBRDFBase64Texture;
  25392. }
  25393. }
  25394. declare module "babylonjs/Materials/PBR/pbrClearCoatConfiguration" {
  25395. import { Nullable } from "babylonjs/types";
  25396. import { Color3 } from "babylonjs/Maths/math.color";
  25397. import { BaseTexture } from "babylonjs/Materials/Textures/baseTexture";
  25398. import { UniformBuffer } from "babylonjs/Materials/uniformBuffer";
  25399. import { IAnimatable } from "babylonjs/Animations/animatable.interface";
  25400. import { EffectFallbacks } from "babylonjs/Materials/effectFallbacks";
  25401. import { SubMesh } from "babylonjs/Meshes/subMesh";
  25402. import { Engine } from "babylonjs/Engines/engine";
  25403. import { Scene } from "babylonjs/scene";
  25404. /**
  25405. * @hidden
  25406. */
  25407. export interface IMaterialClearCoatDefines {
  25408. CLEARCOAT: boolean;
  25409. CLEARCOAT_DEFAULTIOR: boolean;
  25410. CLEARCOAT_TEXTURE: boolean;
  25411. CLEARCOAT_TEXTURE_ROUGHNESS: boolean;
  25412. CLEARCOAT_TEXTUREDIRECTUV: number;
  25413. CLEARCOAT_TEXTURE_ROUGHNESSDIRECTUV: number;
  25414. CLEARCOAT_BUMP: boolean;
  25415. CLEARCOAT_BUMPDIRECTUV: number;
  25416. CLEARCOAT_USE_ROUGHNESS_FROM_MAINTEXTURE: boolean;
  25417. CLEARCOAT_TEXTURE_ROUGHNESS_IDENTICAL: boolean;
  25418. CLEARCOAT_REMAP_F0: boolean;
  25419. CLEARCOAT_TINT: boolean;
  25420. CLEARCOAT_TINT_TEXTURE: boolean;
  25421. CLEARCOAT_TINT_TEXTUREDIRECTUV: number;
  25422. /** @hidden */
  25423. _areTexturesDirty: boolean;
  25424. }
  25425. /**
  25426. * Define the code related to the clear coat parameters of the pbr material.
  25427. */
  25428. export class PBRClearCoatConfiguration {
  25429. /**
  25430. * This defaults to 1.5 corresponding to a 0.04 f0 or a 4% reflectance at normal incidence
  25431. * The default fits with a polyurethane material.
  25432. */
  25433. private static readonly _DefaultIndexOfRefraction;
  25434. private _isEnabled;
  25435. /**
  25436. * Defines if the clear coat is enabled in the material.
  25437. */
  25438. isEnabled: boolean;
  25439. /**
  25440. * Defines the clear coat layer strength (between 0 and 1) it defaults to 1.
  25441. */
  25442. intensity: number;
  25443. /**
  25444. * Defines the clear coat layer roughness.
  25445. */
  25446. roughness: number;
  25447. private _indexOfRefraction;
  25448. /**
  25449. * Defines the index of refraction of the clear coat.
  25450. * This defaults to 1.5 corresponding to a 0.04 f0 or a 4% reflectance at normal incidence
  25451. * The default fits with a polyurethane material.
  25452. * Changing the default value is more performance intensive.
  25453. */
  25454. indexOfRefraction: number;
  25455. private _texture;
  25456. /**
  25457. * Stores the clear coat values in a texture (red channel is intensity and green channel is roughness)
  25458. * If useRoughnessFromMainTexture is false, the green channel of texture is not used and the green channel of textureRoughness is used instead
  25459. * if textureRoughness is not empty, else no texture roughness is used
  25460. */
  25461. texture: Nullable<BaseTexture>;
  25462. private _useRoughnessFromMainTexture;
  25463. /**
  25464. * Indicates that the green channel of the texture property will be used for roughness (default: true)
  25465. * If false, the green channel from textureRoughness is used for roughness
  25466. */
  25467. useRoughnessFromMainTexture: boolean;
  25468. private _textureRoughness;
  25469. /**
  25470. * Stores the clear coat roughness in a texture (green channel)
  25471. * Not used if useRoughnessFromMainTexture is true
  25472. */
  25473. textureRoughness: Nullable<BaseTexture>;
  25474. private _remapF0OnInterfaceChange;
  25475. /**
  25476. * Defines if the F0 value should be remapped to account for the interface change in the material.
  25477. */
  25478. remapF0OnInterfaceChange: boolean;
  25479. private _bumpTexture;
  25480. /**
  25481. * Define the clear coat specific bump texture.
  25482. */
  25483. bumpTexture: Nullable<BaseTexture>;
  25484. private _isTintEnabled;
  25485. /**
  25486. * Defines if the clear coat tint is enabled in the material.
  25487. */
  25488. isTintEnabled: boolean;
  25489. /**
  25490. * Defines the clear coat tint of the material.
  25491. * This is only use if tint is enabled
  25492. */
  25493. tintColor: Color3;
  25494. /**
  25495. * Defines the distance at which the tint color should be found in the
  25496. * clear coat media.
  25497. * This is only use if tint is enabled
  25498. */
  25499. tintColorAtDistance: number;
  25500. /**
  25501. * Defines the clear coat layer thickness.
  25502. * This is only use if tint is enabled
  25503. */
  25504. tintThickness: number;
  25505. private _tintTexture;
  25506. /**
  25507. * Stores the clear tint values in a texture.
  25508. * rgb is tint
  25509. * a is a thickness factor
  25510. */
  25511. tintTexture: Nullable<BaseTexture>;
  25512. /** @hidden */
  25513. private _internalMarkAllSubMeshesAsTexturesDirty;
  25514. /** @hidden */
  25515. _markAllSubMeshesAsTexturesDirty(): void;
  25516. /**
  25517. * Instantiate a new istance of clear coat configuration.
  25518. * @param markAllSubMeshesAsTexturesDirty Callback to flag the material to dirty
  25519. */
  25520. constructor(markAllSubMeshesAsTexturesDirty: () => void);
  25521. /**
  25522. * Gets wehter the submesh is ready to be used or not.
  25523. * @param defines the list of "defines" to update.
  25524. * @param scene defines the scene the material belongs to.
  25525. * @param engine defines the engine the material belongs to.
  25526. * @param disableBumpMap defines wether the material disables bump or not.
  25527. * @returns - boolean indicating that the submesh is ready or not.
  25528. */
  25529. isReadyForSubMesh(defines: IMaterialClearCoatDefines, scene: Scene, engine: Engine, disableBumpMap: boolean): boolean;
  25530. /**
  25531. * Checks to see if a texture is used in the material.
  25532. * @param defines the list of "defines" to update.
  25533. * @param scene defines the scene to the material belongs to.
  25534. */
  25535. prepareDefines(defines: IMaterialClearCoatDefines, scene: Scene): void;
  25536. /**
  25537. * Binds the material data.
  25538. * @param uniformBuffer defines the Uniform buffer to fill in.
  25539. * @param scene defines the scene the material belongs to.
  25540. * @param engine defines the engine the material belongs to.
  25541. * @param disableBumpMap defines wether the material disables bump or not.
  25542. * @param isFrozen defines wether the material is frozen or not.
  25543. * @param invertNormalMapX If sets to true, x component of normal map value will be inverted (x = 1.0 - x).
  25544. * @param invertNormalMapY If sets to true, y component of normal map value will be inverted (y = 1.0 - y).
  25545. * @param subMesh the submesh to bind data for
  25546. */
  25547. bindForSubMesh(uniformBuffer: UniformBuffer, scene: Scene, engine: Engine, disableBumpMap: boolean, isFrozen: boolean, invertNormalMapX: boolean, invertNormalMapY: boolean, subMesh?: SubMesh): void;
  25548. /**
  25549. * Checks to see if a texture is used in the material.
  25550. * @param texture - Base texture to use.
  25551. * @returns - Boolean specifying if a texture is used in the material.
  25552. */
  25553. hasTexture(texture: BaseTexture): boolean;
  25554. /**
  25555. * Returns an array of the actively used textures.
  25556. * @param activeTextures Array of BaseTextures
  25557. */
  25558. getActiveTextures(activeTextures: BaseTexture[]): void;
  25559. /**
  25560. * Returns the animatable textures.
  25561. * @param animatables Array of animatable textures.
  25562. */
  25563. getAnimatables(animatables: IAnimatable[]): void;
  25564. /**
  25565. * Disposes the resources of the material.
  25566. * @param forceDisposeTextures - Forces the disposal of all textures.
  25567. */
  25568. dispose(forceDisposeTextures?: boolean): void;
  25569. /**
  25570. * Get the current class name of the texture useful for serialization or dynamic coding.
  25571. * @returns "PBRClearCoatConfiguration"
  25572. */
  25573. getClassName(): string;
  25574. /**
  25575. * Add fallbacks to the effect fallbacks list.
  25576. * @param defines defines the Base texture to use.
  25577. * @param fallbacks defines the current fallback list.
  25578. * @param currentRank defines the current fallback rank.
  25579. * @returns the new fallback rank.
  25580. */
  25581. static AddFallbacks(defines: IMaterialClearCoatDefines, fallbacks: EffectFallbacks, currentRank: number): number;
  25582. /**
  25583. * Add the required uniforms to the current list.
  25584. * @param uniforms defines the current uniform list.
  25585. */
  25586. static AddUniforms(uniforms: string[]): void;
  25587. /**
  25588. * Add the required samplers to the current list.
  25589. * @param samplers defines the current sampler list.
  25590. */
  25591. static AddSamplers(samplers: string[]): void;
  25592. /**
  25593. * Add the required uniforms to the current buffer.
  25594. * @param uniformBuffer defines the current uniform buffer.
  25595. */
  25596. static PrepareUniformBuffer(uniformBuffer: UniformBuffer): void;
  25597. /**
  25598. * Makes a duplicate of the current configuration into another one.
  25599. * @param clearCoatConfiguration define the config where to copy the info
  25600. */
  25601. copyTo(clearCoatConfiguration: PBRClearCoatConfiguration): void;
  25602. /**
  25603. * Serializes this clear coat configuration.
  25604. * @returns - An object with the serialized config.
  25605. */
  25606. serialize(): any;
  25607. /**
  25608. * Parses a anisotropy Configuration from a serialized object.
  25609. * @param source - Serialized object.
  25610. * @param scene Defines the scene we are parsing for
  25611. * @param rootUrl Defines the rootUrl to load from
  25612. */
  25613. parse(source: any, scene: Scene, rootUrl: string): void;
  25614. }
  25615. }
  25616. declare module "babylonjs/Materials/PBR/pbrAnisotropicConfiguration" {
  25617. import { UniformBuffer } from "babylonjs/Materials/uniformBuffer";
  25618. import { AbstractMesh } from "babylonjs/Meshes/abstractMesh";
  25619. import { Vector2 } from "babylonjs/Maths/math.vector";
  25620. import { Scene } from "babylonjs/scene";
  25621. import { BaseTexture } from "babylonjs/Materials/Textures/baseTexture";
  25622. import { Nullable } from "babylonjs/types";
  25623. import { IAnimatable } from "babylonjs/Animations/animatable.interface";
  25624. import { EffectFallbacks } from "babylonjs/Materials/effectFallbacks";
  25625. /**
  25626. * @hidden
  25627. */
  25628. export interface IMaterialAnisotropicDefines {
  25629. ANISOTROPIC: boolean;
  25630. ANISOTROPIC_TEXTURE: boolean;
  25631. ANISOTROPIC_TEXTUREDIRECTUV: number;
  25632. MAINUV1: boolean;
  25633. _areTexturesDirty: boolean;
  25634. _needUVs: boolean;
  25635. }
  25636. /**
  25637. * Define the code related to the anisotropic parameters of the pbr material.
  25638. */
  25639. export class PBRAnisotropicConfiguration {
  25640. private _isEnabled;
  25641. /**
  25642. * Defines if the anisotropy is enabled in the material.
  25643. */
  25644. isEnabled: boolean;
  25645. /**
  25646. * Defines the anisotropy strength (between 0 and 1) it defaults to 1.
  25647. */
  25648. intensity: number;
  25649. /**
  25650. * Defines if the effect is along the tangents, bitangents or in between.
  25651. * By default, the effect is "strectching" the highlights along the tangents.
  25652. */
  25653. direction: Vector2;
  25654. private _texture;
  25655. /**
  25656. * Stores the anisotropy values in a texture.
  25657. * rg is direction (like normal from -1 to 1)
  25658. * b is a intensity
  25659. */
  25660. texture: Nullable<BaseTexture>;
  25661. /** @hidden */
  25662. private _internalMarkAllSubMeshesAsTexturesDirty;
  25663. /** @hidden */
  25664. _markAllSubMeshesAsTexturesDirty(): void;
  25665. /**
  25666. * Instantiate a new istance of anisotropy configuration.
  25667. * @param markAllSubMeshesAsTexturesDirty Callback to flag the material to dirty
  25668. */
  25669. constructor(markAllSubMeshesAsTexturesDirty: () => void);
  25670. /**
  25671. * Specifies that the submesh is ready to be used.
  25672. * @param defines the list of "defines" to update.
  25673. * @param scene defines the scene the material belongs to.
  25674. * @returns - boolean indicating that the submesh is ready or not.
  25675. */
  25676. isReadyForSubMesh(defines: IMaterialAnisotropicDefines, scene: Scene): boolean;
  25677. /**
  25678. * Checks to see if a texture is used in the material.
  25679. * @param defines the list of "defines" to update.
  25680. * @param mesh the mesh we are preparing the defines for.
  25681. * @param scene defines the scene the material belongs to.
  25682. */
  25683. prepareDefines(defines: IMaterialAnisotropicDefines, mesh: AbstractMesh, scene: Scene): void;
  25684. /**
  25685. * Binds the material data.
  25686. * @param uniformBuffer defines the Uniform buffer to fill in.
  25687. * @param scene defines the scene the material belongs to.
  25688. * @param isFrozen defines wether the material is frozen or not.
  25689. */
  25690. bindForSubMesh(uniformBuffer: UniformBuffer, scene: Scene, isFrozen: boolean): void;
  25691. /**
  25692. * Checks to see if a texture is used in the material.
  25693. * @param texture - Base texture to use.
  25694. * @returns - Boolean specifying if a texture is used in the material.
  25695. */
  25696. hasTexture(texture: BaseTexture): boolean;
  25697. /**
  25698. * Returns an array of the actively used textures.
  25699. * @param activeTextures Array of BaseTextures
  25700. */
  25701. getActiveTextures(activeTextures: BaseTexture[]): void;
  25702. /**
  25703. * Returns the animatable textures.
  25704. * @param animatables Array of animatable textures.
  25705. */
  25706. getAnimatables(animatables: IAnimatable[]): void;
  25707. /**
  25708. * Disposes the resources of the material.
  25709. * @param forceDisposeTextures - Forces the disposal of all textures.
  25710. */
  25711. dispose(forceDisposeTextures?: boolean): void;
  25712. /**
  25713. * Get the current class name of the texture useful for serialization or dynamic coding.
  25714. * @returns "PBRAnisotropicConfiguration"
  25715. */
  25716. getClassName(): string;
  25717. /**
  25718. * Add fallbacks to the effect fallbacks list.
  25719. * @param defines defines the Base texture to use.
  25720. * @param fallbacks defines the current fallback list.
  25721. * @param currentRank defines the current fallback rank.
  25722. * @returns the new fallback rank.
  25723. */
  25724. static AddFallbacks(defines: IMaterialAnisotropicDefines, fallbacks: EffectFallbacks, currentRank: number): number;
  25725. /**
  25726. * Add the required uniforms to the current list.
  25727. * @param uniforms defines the current uniform list.
  25728. */
  25729. static AddUniforms(uniforms: string[]): void;
  25730. /**
  25731. * Add the required uniforms to the current buffer.
  25732. * @param uniformBuffer defines the current uniform buffer.
  25733. */
  25734. static PrepareUniformBuffer(uniformBuffer: UniformBuffer): void;
  25735. /**
  25736. * Add the required samplers to the current list.
  25737. * @param samplers defines the current sampler list.
  25738. */
  25739. static AddSamplers(samplers: string[]): void;
  25740. /**
  25741. * Makes a duplicate of the current configuration into another one.
  25742. * @param anisotropicConfiguration define the config where to copy the info
  25743. */
  25744. copyTo(anisotropicConfiguration: PBRAnisotropicConfiguration): void;
  25745. /**
  25746. * Serializes this anisotropy configuration.
  25747. * @returns - An object with the serialized config.
  25748. */
  25749. serialize(): any;
  25750. /**
  25751. * Parses a anisotropy Configuration from a serialized object.
  25752. * @param source - Serialized object.
  25753. * @param scene Defines the scene we are parsing for
  25754. * @param rootUrl Defines the rootUrl to load from
  25755. */
  25756. parse(source: any, scene: Scene, rootUrl: string): void;
  25757. }
  25758. }
  25759. declare module "babylonjs/Materials/PBR/pbrBRDFConfiguration" {
  25760. import { Scene } from "babylonjs/scene";
  25761. /**
  25762. * @hidden
  25763. */
  25764. export interface IMaterialBRDFDefines {
  25765. BRDF_V_HEIGHT_CORRELATED: boolean;
  25766. MS_BRDF_ENERGY_CONSERVATION: boolean;
  25767. SPHERICAL_HARMONICS: boolean;
  25768. SPECULAR_GLOSSINESS_ENERGY_CONSERVATION: boolean;
  25769. /** @hidden */
  25770. _areMiscDirty: boolean;
  25771. }
  25772. /**
  25773. * Define the code related to the BRDF parameters of the pbr material.
  25774. */
  25775. export class PBRBRDFConfiguration {
  25776. /**
  25777. * Default value used for the energy conservation.
  25778. * This should only be changed to adapt to the type of texture in scene.environmentBRDFTexture.
  25779. */
  25780. static DEFAULT_USE_ENERGY_CONSERVATION: boolean;
  25781. /**
  25782. * Default value used for the Smith Visibility Height Correlated mode.
  25783. * This should only be changed to adapt to the type of texture in scene.environmentBRDFTexture.
  25784. */
  25785. static DEFAULT_USE_SMITH_VISIBILITY_HEIGHT_CORRELATED: boolean;
  25786. /**
  25787. * Default value used for the IBL diffuse part.
  25788. * This can help switching back to the polynomials mode globally which is a tiny bit
  25789. * less GPU intensive at the drawback of a lower quality.
  25790. */
  25791. static DEFAULT_USE_SPHERICAL_HARMONICS: boolean;
  25792. /**
  25793. * Default value used for activating energy conservation for the specular workflow.
  25794. * If activated, the albedo color is multiplied with (1. - maxChannel(specular color)).
  25795. * If deactivated, a material is only physically plausible, when (albedo color + specular color) < 1.
  25796. */
  25797. static DEFAULT_USE_SPECULAR_GLOSSINESS_INPUT_ENERGY_CONSERVATION: boolean;
  25798. private _useEnergyConservation;
  25799. /**
  25800. * Defines if the material uses energy conservation.
  25801. */
  25802. useEnergyConservation: boolean;
  25803. private _useSmithVisibilityHeightCorrelated;
  25804. /**
  25805. * LEGACY Mode set to false
  25806. * Defines if the material uses height smith correlated visibility term.
  25807. * If you intent to not use our default BRDF, you need to load a separate BRDF Texture for the PBR
  25808. * You can either load https://assets.babylonjs.com/environments/uncorrelatedBRDF.png
  25809. * or https://assets.babylonjs.com/environments/uncorrelatedBRDF.dds to have more precision
  25810. * Not relying on height correlated will also disable energy conservation.
  25811. */
  25812. useSmithVisibilityHeightCorrelated: boolean;
  25813. private _useSphericalHarmonics;
  25814. /**
  25815. * LEGACY Mode set to false
  25816. * Defines if the material uses spherical harmonics vs spherical polynomials for the
  25817. * diffuse part of the IBL.
  25818. * The harmonics despite a tiny bigger cost has been proven to provide closer results
  25819. * to the ground truth.
  25820. */
  25821. useSphericalHarmonics: boolean;
  25822. private _useSpecularGlossinessInputEnergyConservation;
  25823. /**
  25824. * Defines if the material uses energy conservation, when the specular workflow is active.
  25825. * If activated, the albedo color is multiplied with (1. - maxChannel(specular color)).
  25826. * If deactivated, a material is only physically plausible, when (albedo color + specular color) < 1.
  25827. * In the deactivated case, the material author has to ensure energy conservation, for a physically plausible rendering.
  25828. */
  25829. useSpecularGlossinessInputEnergyConservation: boolean;
  25830. /** @hidden */
  25831. private _internalMarkAllSubMeshesAsMiscDirty;
  25832. /** @hidden */
  25833. _markAllSubMeshesAsMiscDirty(): void;
  25834. /**
  25835. * Instantiate a new istance of clear coat configuration.
  25836. * @param markAllSubMeshesAsMiscDirty Callback to flag the material to dirty
  25837. */
  25838. constructor(markAllSubMeshesAsMiscDirty: () => void);
  25839. /**
  25840. * Checks to see if a texture is used in the material.
  25841. * @param defines the list of "defines" to update.
  25842. */
  25843. prepareDefines(defines: IMaterialBRDFDefines): void;
  25844. /**
  25845. * Get the current class name of the texture useful for serialization or dynamic coding.
  25846. * @returns "PBRClearCoatConfiguration"
  25847. */
  25848. getClassName(): string;
  25849. /**
  25850. * Makes a duplicate of the current configuration into another one.
  25851. * @param brdfConfiguration define the config where to copy the info
  25852. */
  25853. copyTo(brdfConfiguration: PBRBRDFConfiguration): void;
  25854. /**
  25855. * Serializes this BRDF configuration.
  25856. * @returns - An object with the serialized config.
  25857. */
  25858. serialize(): any;
  25859. /**
  25860. * Parses a anisotropy Configuration from a serialized object.
  25861. * @param source - Serialized object.
  25862. * @param scene Defines the scene we are parsing for
  25863. * @param rootUrl Defines the rootUrl to load from
  25864. */
  25865. parse(source: any, scene: Scene, rootUrl: string): void;
  25866. }
  25867. }
  25868. declare module "babylonjs/Materials/PBR/pbrSheenConfiguration" {
  25869. import { UniformBuffer } from "babylonjs/Materials/uniformBuffer";
  25870. import { Color3 } from "babylonjs/Maths/math.color";
  25871. import { Scene } from "babylonjs/scene";
  25872. import { BaseTexture } from "babylonjs/Materials/Textures/baseTexture";
  25873. import { Nullable } from "babylonjs/types";
  25874. import { IAnimatable } from "babylonjs/Animations/animatable.interface";
  25875. import { EffectFallbacks } from "babylonjs/Materials/effectFallbacks";
  25876. import { SubMesh } from "babylonjs/Meshes/subMesh";
  25877. /**
  25878. * @hidden
  25879. */
  25880. export interface IMaterialSheenDefines {
  25881. SHEEN: boolean;
  25882. SHEEN_TEXTURE: boolean;
  25883. SHEEN_TEXTURE_ROUGHNESS: boolean;
  25884. SHEEN_TEXTUREDIRECTUV: number;
  25885. SHEEN_TEXTURE_ROUGHNESSDIRECTUV: number;
  25886. SHEEN_LINKWITHALBEDO: boolean;
  25887. SHEEN_ROUGHNESS: boolean;
  25888. SHEEN_ALBEDOSCALING: boolean;
  25889. SHEEN_USE_ROUGHNESS_FROM_MAINTEXTURE: boolean;
  25890. SHEEN_TEXTURE_ROUGHNESS_IDENTICAL: boolean;
  25891. /** @hidden */
  25892. _areTexturesDirty: boolean;
  25893. }
  25894. /**
  25895. * Define the code related to the Sheen parameters of the pbr material.
  25896. */
  25897. export class PBRSheenConfiguration {
  25898. private _isEnabled;
  25899. /**
  25900. * Defines if the material uses sheen.
  25901. */
  25902. isEnabled: boolean;
  25903. private _linkSheenWithAlbedo;
  25904. /**
  25905. * Defines if the sheen is linked to the sheen color.
  25906. */
  25907. linkSheenWithAlbedo: boolean;
  25908. /**
  25909. * Defines the sheen intensity.
  25910. */
  25911. intensity: number;
  25912. /**
  25913. * Defines the sheen color.
  25914. */
  25915. color: Color3;
  25916. private _texture;
  25917. /**
  25918. * Stores the sheen tint values in a texture.
  25919. * rgb is tint
  25920. * a is a intensity or roughness if the roughness property has been defined and useRoughnessFromTexture is true (in that case, textureRoughness won't be used)
  25921. * If the roughness property has been defined and useRoughnessFromTexture is false then the alpha channel is not used to modulate roughness
  25922. */
  25923. texture: Nullable<BaseTexture>;
  25924. private _useRoughnessFromMainTexture;
  25925. /**
  25926. * Indicates that the alpha channel of the texture property will be used for roughness.
  25927. * Has no effect if the roughness (and texture!) property is not defined
  25928. */
  25929. useRoughnessFromMainTexture: boolean;
  25930. private _roughness;
  25931. /**
  25932. * Defines the sheen roughness.
  25933. * It is not taken into account if linkSheenWithAlbedo is true.
  25934. * To stay backward compatible, material roughness is used instead if sheen roughness = null
  25935. */
  25936. roughness: Nullable<number>;
  25937. private _textureRoughness;
  25938. /**
  25939. * Stores the sheen roughness in a texture.
  25940. * alpha channel is the roughness. This texture won't be used if the texture property is not empty and useRoughnessFromTexture is true
  25941. */
  25942. textureRoughness: Nullable<BaseTexture>;
  25943. private _albedoScaling;
  25944. /**
  25945. * If true, the sheen effect is layered above the base BRDF with the albedo-scaling technique.
  25946. * It allows the strength of the sheen effect to not depend on the base color of the material,
  25947. * making it easier to setup and tweak the effect
  25948. */
  25949. albedoScaling: boolean;
  25950. /** @hidden */
  25951. private _internalMarkAllSubMeshesAsTexturesDirty;
  25952. /** @hidden */
  25953. _markAllSubMeshesAsTexturesDirty(): void;
  25954. /**
  25955. * Instantiate a new istance of clear coat configuration.
  25956. * @param markAllSubMeshesAsTexturesDirty Callback to flag the material to dirty
  25957. */
  25958. constructor(markAllSubMeshesAsTexturesDirty: () => void);
  25959. /**
  25960. * Specifies that the submesh is ready to be used.
  25961. * @param defines the list of "defines" to update.
  25962. * @param scene defines the scene the material belongs to.
  25963. * @returns - boolean indicating that the submesh is ready or not.
  25964. */
  25965. isReadyForSubMesh(defines: IMaterialSheenDefines, scene: Scene): boolean;
  25966. /**
  25967. * Checks to see if a texture is used in the material.
  25968. * @param defines the list of "defines" to update.
  25969. * @param scene defines the scene the material belongs to.
  25970. */
  25971. prepareDefines(defines: IMaterialSheenDefines, scene: Scene): void;
  25972. /**
  25973. * Binds the material data.
  25974. * @param uniformBuffer defines the Uniform buffer to fill in.
  25975. * @param scene defines the scene the material belongs to.
  25976. * @param isFrozen defines wether the material is frozen or not.
  25977. * @param subMesh the submesh to bind data for
  25978. */
  25979. bindForSubMesh(uniformBuffer: UniformBuffer, scene: Scene, isFrozen: boolean, subMesh?: SubMesh): void;
  25980. /**
  25981. * Checks to see if a texture is used in the material.
  25982. * @param texture - Base texture to use.
  25983. * @returns - Boolean specifying if a texture is used in the material.
  25984. */
  25985. hasTexture(texture: BaseTexture): boolean;
  25986. /**
  25987. * Returns an array of the actively used textures.
  25988. * @param activeTextures Array of BaseTextures
  25989. */
  25990. getActiveTextures(activeTextures: BaseTexture[]): void;
  25991. /**
  25992. * Returns the animatable textures.
  25993. * @param animatables Array of animatable textures.
  25994. */
  25995. getAnimatables(animatables: IAnimatable[]): void;
  25996. /**
  25997. * Disposes the resources of the material.
  25998. * @param forceDisposeTextures - Forces the disposal of all textures.
  25999. */
  26000. dispose(forceDisposeTextures?: boolean): void;
  26001. /**
  26002. * Get the current class name of the texture useful for serialization or dynamic coding.
  26003. * @returns "PBRSheenConfiguration"
  26004. */
  26005. getClassName(): string;
  26006. /**
  26007. * Add fallbacks to the effect fallbacks list.
  26008. * @param defines defines the Base texture to use.
  26009. * @param fallbacks defines the current fallback list.
  26010. * @param currentRank defines the current fallback rank.
  26011. * @returns the new fallback rank.
  26012. */
  26013. static AddFallbacks(defines: IMaterialSheenDefines, fallbacks: EffectFallbacks, currentRank: number): number;
  26014. /**
  26015. * Add the required uniforms to the current list.
  26016. * @param uniforms defines the current uniform list.
  26017. */
  26018. static AddUniforms(uniforms: string[]): void;
  26019. /**
  26020. * Add the required uniforms to the current buffer.
  26021. * @param uniformBuffer defines the current uniform buffer.
  26022. */
  26023. static PrepareUniformBuffer(uniformBuffer: UniformBuffer): void;
  26024. /**
  26025. * Add the required samplers to the current list.
  26026. * @param samplers defines the current sampler list.
  26027. */
  26028. static AddSamplers(samplers: string[]): void;
  26029. /**
  26030. * Makes a duplicate of the current configuration into another one.
  26031. * @param sheenConfiguration define the config where to copy the info
  26032. */
  26033. copyTo(sheenConfiguration: PBRSheenConfiguration): void;
  26034. /**
  26035. * Serializes this BRDF configuration.
  26036. * @returns - An object with the serialized config.
  26037. */
  26038. serialize(): any;
  26039. /**
  26040. * Parses a anisotropy Configuration from a serialized object.
  26041. * @param source - Serialized object.
  26042. * @param scene Defines the scene we are parsing for
  26043. * @param rootUrl Defines the rootUrl to load from
  26044. */
  26045. parse(source: any, scene: Scene, rootUrl: string): void;
  26046. }
  26047. }
  26048. declare module "babylonjs/Materials/PBR/pbrSubSurfaceConfiguration" {
  26049. import { Nullable } from "babylonjs/types";
  26050. import { IAnimatable } from "babylonjs/Animations/animatable.interface";
  26051. import { Color3 } from "babylonjs/Maths/math.color";
  26052. import { SmartArray } from "babylonjs/Misc/smartArray";
  26053. import { BaseTexture } from "babylonjs/Materials/Textures/baseTexture";
  26054. import { RenderTargetTexture } from "babylonjs/Materials/Textures/renderTargetTexture";
  26055. import { Effect } from "babylonjs/Materials/effect";
  26056. import { UniformBuffer } from "babylonjs/Materials/uniformBuffer";
  26057. import { EffectFallbacks } from "babylonjs/Materials/effectFallbacks";
  26058. import { Engine } from "babylonjs/Engines/engine";
  26059. import { Scene } from "babylonjs/scene";
  26060. /**
  26061. * @hidden
  26062. */
  26063. export interface IMaterialSubSurfaceDefines {
  26064. SUBSURFACE: boolean;
  26065. SS_REFRACTION: boolean;
  26066. SS_TRANSLUCENCY: boolean;
  26067. SS_SCATTERING: boolean;
  26068. SS_THICKNESSANDMASK_TEXTURE: boolean;
  26069. SS_THICKNESSANDMASK_TEXTUREDIRECTUV: number;
  26070. SS_REFRACTIONMAP_3D: boolean;
  26071. SS_REFRACTIONMAP_OPPOSITEZ: boolean;
  26072. SS_LODINREFRACTIONALPHA: boolean;
  26073. SS_GAMMAREFRACTION: boolean;
  26074. SS_RGBDREFRACTION: boolean;
  26075. SS_LINEARSPECULARREFRACTION: boolean;
  26076. SS_LINKREFRACTIONTOTRANSPARENCY: boolean;
  26077. SS_ALBEDOFORREFRACTIONTINT: boolean;
  26078. SS_MASK_FROM_THICKNESS_TEXTURE: boolean;
  26079. /** @hidden */
  26080. _areTexturesDirty: boolean;
  26081. }
  26082. /**
  26083. * Define the code related to the sub surface parameters of the pbr material.
  26084. */
  26085. export class PBRSubSurfaceConfiguration {
  26086. private _isRefractionEnabled;
  26087. /**
  26088. * Defines if the refraction is enabled in the material.
  26089. */
  26090. isRefractionEnabled: boolean;
  26091. private _isTranslucencyEnabled;
  26092. /**
  26093. * Defines if the translucency is enabled in the material.
  26094. */
  26095. isTranslucencyEnabled: boolean;
  26096. private _isScatteringEnabled;
  26097. /**
  26098. * Defines if the sub surface scattering is enabled in the material.
  26099. */
  26100. isScatteringEnabled: boolean;
  26101. private _scatteringDiffusionProfileIndex;
  26102. /**
  26103. * Diffusion profile for subsurface scattering.
  26104. * Useful for better scattering in the skins or foliages.
  26105. */
  26106. get scatteringDiffusionProfile(): Nullable<Color3>;
  26107. set scatteringDiffusionProfile(c: Nullable<Color3>);
  26108. /**
  26109. * Defines the refraction intensity of the material.
  26110. * The refraction when enabled replaces the Diffuse part of the material.
  26111. * The intensity helps transitionning between diffuse and refraction.
  26112. */
  26113. refractionIntensity: number;
  26114. /**
  26115. * Defines the translucency intensity of the material.
  26116. * When translucency has been enabled, this defines how much of the "translucency"
  26117. * is addded to the diffuse part of the material.
  26118. */
  26119. translucencyIntensity: number;
  26120. /**
  26121. * When enabled, transparent surfaces will be tinted with the albedo colour (independent of thickness)
  26122. */
  26123. useAlbedoToTintRefraction: boolean;
  26124. private _thicknessTexture;
  26125. /**
  26126. * Stores the average thickness of a mesh in a texture (The texture is holding the values linearly).
  26127. * The red channel of the texture should contain the thickness remapped between 0 and 1.
  26128. * 0 would mean minimumThickness
  26129. * 1 would mean maximumThickness
  26130. * The other channels might be use as a mask to vary the different effects intensity.
  26131. */
  26132. thicknessTexture: Nullable<BaseTexture>;
  26133. private _refractionTexture;
  26134. /**
  26135. * Defines the texture to use for refraction.
  26136. */
  26137. refractionTexture: Nullable<BaseTexture>;
  26138. private _indexOfRefraction;
  26139. /**
  26140. * Index of refraction of the material base layer.
  26141. * https://en.wikipedia.org/wiki/List_of_refractive_indices
  26142. *
  26143. * This does not only impact refraction but also the Base F0 of Dielectric Materials.
  26144. *
  26145. * From dielectric fresnel rules: F0 = square((iorT - iorI) / (iorT + iorI))
  26146. */
  26147. indexOfRefraction: number;
  26148. private _volumeIndexOfRefraction;
  26149. /**
  26150. * Index of refraction of the material's volume.
  26151. * https://en.wikipedia.org/wiki/List_of_refractive_indices
  26152. *
  26153. * This ONLY impacts refraction. If not provided or given a non-valid value,
  26154. * the volume will use the same IOR as the surface.
  26155. */
  26156. get volumeIndexOfRefraction(): number;
  26157. set volumeIndexOfRefraction(value: number);
  26158. private _invertRefractionY;
  26159. /**
  26160. * Controls if refraction needs to be inverted on Y. This could be useful for procedural texture.
  26161. */
  26162. invertRefractionY: boolean;
  26163. private _linkRefractionWithTransparency;
  26164. /**
  26165. * This parameters will make the material used its opacity to control how much it is refracting aginst not.
  26166. * Materials half opaque for instance using refraction could benefit from this control.
  26167. */
  26168. linkRefractionWithTransparency: boolean;
  26169. /**
  26170. * Defines the minimum thickness stored in the thickness map.
  26171. * If no thickness map is defined, this value will be used to simulate thickness.
  26172. */
  26173. minimumThickness: number;
  26174. /**
  26175. * Defines the maximum thickness stored in the thickness map.
  26176. */
  26177. maximumThickness: number;
  26178. /**
  26179. * Defines the volume tint of the material.
  26180. * This is used for both translucency and scattering.
  26181. */
  26182. tintColor: Color3;
  26183. /**
  26184. * Defines the distance at which the tint color should be found in the media.
  26185. * This is used for refraction only.
  26186. */
  26187. tintColorAtDistance: number;
  26188. /**
  26189. * Defines how far each channel transmit through the media.
  26190. * It is defined as a color to simplify it selection.
  26191. */
  26192. diffusionDistance: Color3;
  26193. private _useMaskFromThicknessTexture;
  26194. /**
  26195. * Stores the intensity of the different subsurface effects in the thickness texture.
  26196. * * the green channel is the translucency intensity.
  26197. * * the blue channel is the scattering intensity.
  26198. * * the alpha channel is the refraction intensity.
  26199. */
  26200. useMaskFromThicknessTexture: boolean;
  26201. private _scene;
  26202. /** @hidden */
  26203. private _internalMarkAllSubMeshesAsTexturesDirty;
  26204. private _internalMarkScenePrePassDirty;
  26205. /** @hidden */
  26206. _markAllSubMeshesAsTexturesDirty(): void;
  26207. /** @hidden */
  26208. _markScenePrePassDirty(): void;
  26209. /**
  26210. * Instantiate a new istance of sub surface configuration.
  26211. * @param markAllSubMeshesAsTexturesDirty Callback to flag the material to dirty
  26212. * @param markScenePrePassDirty Callback to flag the scene as prepass dirty
  26213. * @param scene The scene
  26214. */
  26215. constructor(markAllSubMeshesAsTexturesDirty: () => void, markScenePrePassDirty: () => void, scene: Scene);
  26216. /**
  26217. * Gets wehter the submesh is ready to be used or not.
  26218. * @param defines the list of "defines" to update.
  26219. * @param scene defines the scene the material belongs to.
  26220. * @returns - boolean indicating that the submesh is ready or not.
  26221. */
  26222. isReadyForSubMesh(defines: IMaterialSubSurfaceDefines, scene: Scene): boolean;
  26223. /**
  26224. * Checks to see if a texture is used in the material.
  26225. * @param defines the list of "defines" to update.
  26226. * @param scene defines the scene to the material belongs to.
  26227. */
  26228. prepareDefines(defines: IMaterialSubSurfaceDefines, scene: Scene): void;
  26229. /**
  26230. * Binds the material data.
  26231. * @param uniformBuffer defines the Uniform buffer to fill in.
  26232. * @param scene defines the scene the material belongs to.
  26233. * @param engine defines the engine the material belongs to.
  26234. * @param isFrozen defines whether the material is frozen or not.
  26235. * @param lodBasedMicrosurface defines whether the material relies on lod based microsurface or not.
  26236. * @param realTimeFiltering defines whether the textures should be filtered on the fly.
  26237. */
  26238. bindForSubMesh(uniformBuffer: UniformBuffer, scene: Scene, engine: Engine, isFrozen: boolean, lodBasedMicrosurface: boolean, realTimeFiltering: boolean): void;
  26239. /**
  26240. * Unbinds the material from the mesh.
  26241. * @param activeEffect defines the effect that should be unbound from.
  26242. * @returns true if unbound, otherwise false
  26243. */
  26244. unbind(activeEffect: Effect): boolean;
  26245. /**
  26246. * Returns the texture used for refraction or null if none is used.
  26247. * @param scene defines the scene the material belongs to.
  26248. * @returns - Refraction texture if present. If no refraction texture and refraction
  26249. * is linked with transparency, returns environment texture. Otherwise, returns null.
  26250. */
  26251. private _getRefractionTexture;
  26252. /**
  26253. * Returns true if alpha blending should be disabled.
  26254. */
  26255. get disableAlphaBlending(): boolean;
  26256. /**
  26257. * Fills the list of render target textures.
  26258. * @param renderTargets the list of render targets to update
  26259. */
  26260. fillRenderTargetTextures(renderTargets: SmartArray<RenderTargetTexture>): void;
  26261. /**
  26262. * Checks to see if a texture is used in the material.
  26263. * @param texture - Base texture to use.
  26264. * @returns - Boolean specifying if a texture is used in the material.
  26265. */
  26266. hasTexture(texture: BaseTexture): boolean;
  26267. /**
  26268. * Gets a boolean indicating that current material needs to register RTT
  26269. * @returns true if this uses a render target otherwise false.
  26270. */
  26271. hasRenderTargetTextures(): boolean;
  26272. /**
  26273. * Returns an array of the actively used textures.
  26274. * @param activeTextures Array of BaseTextures
  26275. */
  26276. getActiveTextures(activeTextures: BaseTexture[]): void;
  26277. /**
  26278. * Returns the animatable textures.
  26279. * @param animatables Array of animatable textures.
  26280. */
  26281. getAnimatables(animatables: IAnimatable[]): void;
  26282. /**
  26283. * Disposes the resources of the material.
  26284. * @param forceDisposeTextures - Forces the disposal of all textures.
  26285. */
  26286. dispose(forceDisposeTextures?: boolean): void;
  26287. /**
  26288. * Get the current class name of the texture useful for serialization or dynamic coding.
  26289. * @returns "PBRSubSurfaceConfiguration"
  26290. */
  26291. getClassName(): string;
  26292. /**
  26293. * Add fallbacks to the effect fallbacks list.
  26294. * @param defines defines the Base texture to use.
  26295. * @param fallbacks defines the current fallback list.
  26296. * @param currentRank defines the current fallback rank.
  26297. * @returns the new fallback rank.
  26298. */
  26299. static AddFallbacks(defines: IMaterialSubSurfaceDefines, fallbacks: EffectFallbacks, currentRank: number): number;
  26300. /**
  26301. * Add the required uniforms to the current list.
  26302. * @param uniforms defines the current uniform list.
  26303. */
  26304. static AddUniforms(uniforms: string[]): void;
  26305. /**
  26306. * Add the required samplers to the current list.
  26307. * @param samplers defines the current sampler list.
  26308. */
  26309. static AddSamplers(samplers: string[]): void;
  26310. /**
  26311. * Add the required uniforms to the current buffer.
  26312. * @param uniformBuffer defines the current uniform buffer.
  26313. */
  26314. static PrepareUniformBuffer(uniformBuffer: UniformBuffer): void;
  26315. /**
  26316. * Makes a duplicate of the current configuration into another one.
  26317. * @param configuration define the config where to copy the info
  26318. */
  26319. copyTo(configuration: PBRSubSurfaceConfiguration): void;
  26320. /**
  26321. * Serializes this Sub Surface configuration.
  26322. * @returns - An object with the serialized config.
  26323. */
  26324. serialize(): any;
  26325. /**
  26326. * Parses a anisotropy Configuration from a serialized object.
  26327. * @param source - Serialized object.
  26328. * @param scene Defines the scene we are parsing for
  26329. * @param rootUrl Defines the rootUrl to load from
  26330. */
  26331. parse(source: any, scene: Scene, rootUrl: string): void;
  26332. }
  26333. }
  26334. declare module "babylonjs/Maths/sphericalPolynomial" {
  26335. import { Vector3 } from "babylonjs/Maths/math.vector";
  26336. import { Color3 } from "babylonjs/Maths/math.color";
  26337. /**
  26338. * Class representing spherical harmonics coefficients to the 3rd degree
  26339. */
  26340. export class SphericalHarmonics {
  26341. /**
  26342. * Defines whether or not the harmonics have been prescaled for rendering.
  26343. */
  26344. preScaled: boolean;
  26345. /**
  26346. * The l0,0 coefficients of the spherical harmonics
  26347. */
  26348. l00: Vector3;
  26349. /**
  26350. * The l1,-1 coefficients of the spherical harmonics
  26351. */
  26352. l1_1: Vector3;
  26353. /**
  26354. * The l1,0 coefficients of the spherical harmonics
  26355. */
  26356. l10: Vector3;
  26357. /**
  26358. * The l1,1 coefficients of the spherical harmonics
  26359. */
  26360. l11: Vector3;
  26361. /**
  26362. * The l2,-2 coefficients of the spherical harmonics
  26363. */
  26364. l2_2: Vector3;
  26365. /**
  26366. * The l2,-1 coefficients of the spherical harmonics
  26367. */
  26368. l2_1: Vector3;
  26369. /**
  26370. * The l2,0 coefficients of the spherical harmonics
  26371. */
  26372. l20: Vector3;
  26373. /**
  26374. * The l2,1 coefficients of the spherical harmonics
  26375. */
  26376. l21: Vector3;
  26377. /**
  26378. * The l2,2 coefficients of the spherical harmonics
  26379. */
  26380. l22: Vector3;
  26381. /**
  26382. * Adds a light to the spherical harmonics
  26383. * @param direction the direction of the light
  26384. * @param color the color of the light
  26385. * @param deltaSolidAngle the delta solid angle of the light
  26386. */
  26387. addLight(direction: Vector3, color: Color3, deltaSolidAngle: number): void;
  26388. /**
  26389. * Scales the spherical harmonics by the given amount
  26390. * @param scale the amount to scale
  26391. */
  26392. scaleInPlace(scale: number): void;
  26393. /**
  26394. * Convert from incident radiance (Li) to irradiance (E) by applying convolution with the cosine-weighted hemisphere.
  26395. *
  26396. * ```
  26397. * E_lm = A_l * L_lm
  26398. * ```
  26399. *
  26400. * In spherical harmonics this convolution amounts to scaling factors for each frequency band.
  26401. * This corresponds to equation 5 in "An Efficient Representation for Irradiance Environment Maps", where
  26402. * the scaling factors are given in equation 9.
  26403. */
  26404. convertIncidentRadianceToIrradiance(): void;
  26405. /**
  26406. * Convert from irradiance to outgoing radiance for Lambertian BDRF, suitable for efficient shader evaluation.
  26407. *
  26408. * ```
  26409. * L = (1/pi) * E * rho
  26410. * ```
  26411. *
  26412. * This is done by an additional scale by 1/pi, so is a fairly trivial operation but important conceptually.
  26413. */
  26414. convertIrradianceToLambertianRadiance(): void;
  26415. /**
  26416. * Integrates the reconstruction coefficients directly in to the SH preventing further
  26417. * required operations at run time.
  26418. *
  26419. * This is simply done by scaling back the SH with Ylm constants parameter.
  26420. * The trigonometric part being applied by the shader at run time.
  26421. */
  26422. preScaleForRendering(): void;
  26423. /**
  26424. * Constructs a spherical harmonics from an array.
  26425. * @param data defines the 9x3 coefficients (l00, l1-1, l10, l11, l2-2, l2-1, l20, l21, l22)
  26426. * @returns the spherical harmonics
  26427. */
  26428. static FromArray(data: ArrayLike<ArrayLike<number>>): SphericalHarmonics;
  26429. /**
  26430. * Gets the spherical harmonics from polynomial
  26431. * @param polynomial the spherical polynomial
  26432. * @returns the spherical harmonics
  26433. */
  26434. static FromPolynomial(polynomial: SphericalPolynomial): SphericalHarmonics;
  26435. }
  26436. /**
  26437. * Class representing spherical polynomial coefficients to the 3rd degree
  26438. */
  26439. export class SphericalPolynomial {
  26440. private _harmonics;
  26441. /**
  26442. * The spherical harmonics used to create the polynomials.
  26443. */
  26444. get preScaledHarmonics(): SphericalHarmonics;
  26445. /**
  26446. * The x coefficients of the spherical polynomial
  26447. */
  26448. x: Vector3;
  26449. /**
  26450. * The y coefficients of the spherical polynomial
  26451. */
  26452. y: Vector3;
  26453. /**
  26454. * The z coefficients of the spherical polynomial
  26455. */
  26456. z: Vector3;
  26457. /**
  26458. * The xx coefficients of the spherical polynomial
  26459. */
  26460. xx: Vector3;
  26461. /**
  26462. * The yy coefficients of the spherical polynomial
  26463. */
  26464. yy: Vector3;
  26465. /**
  26466. * The zz coefficients of the spherical polynomial
  26467. */
  26468. zz: Vector3;
  26469. /**
  26470. * The xy coefficients of the spherical polynomial
  26471. */
  26472. xy: Vector3;
  26473. /**
  26474. * The yz coefficients of the spherical polynomial
  26475. */
  26476. yz: Vector3;
  26477. /**
  26478. * The zx coefficients of the spherical polynomial
  26479. */
  26480. zx: Vector3;
  26481. /**
  26482. * Adds an ambient color to the spherical polynomial
  26483. * @param color the color to add
  26484. */
  26485. addAmbient(color: Color3): void;
  26486. /**
  26487. * Scales the spherical polynomial by the given amount
  26488. * @param scale the amount to scale
  26489. */
  26490. scaleInPlace(scale: number): void;
  26491. /**
  26492. * Gets the spherical polynomial from harmonics
  26493. * @param harmonics the spherical harmonics
  26494. * @returns the spherical polynomial
  26495. */
  26496. static FromHarmonics(harmonics: SphericalHarmonics): SphericalPolynomial;
  26497. /**
  26498. * Constructs a spherical polynomial from an array.
  26499. * @param data defines the 9x3 coefficients (x, y, z, xx, yy, zz, yz, zx, xy)
  26500. * @returns the spherical polynomial
  26501. */
  26502. static FromArray(data: ArrayLike<ArrayLike<number>>): SphericalPolynomial;
  26503. }
  26504. }
  26505. declare module "babylonjs/Misc/HighDynamicRange/panoramaToCubemap" {
  26506. import { Nullable } from "babylonjs/types";
  26507. /**
  26508. * CubeMap information grouping all the data for each faces as well as the cubemap size.
  26509. */
  26510. export interface CubeMapInfo {
  26511. /**
  26512. * The pixel array for the front face.
  26513. * This is stored in format, left to right, up to down format.
  26514. */
  26515. front: Nullable<ArrayBufferView>;
  26516. /**
  26517. * The pixel array for the back face.
  26518. * This is stored in format, left to right, up to down format.
  26519. */
  26520. back: Nullable<ArrayBufferView>;
  26521. /**
  26522. * The pixel array for the left face.
  26523. * This is stored in format, left to right, up to down format.
  26524. */
  26525. left: Nullable<ArrayBufferView>;
  26526. /**
  26527. * The pixel array for the right face.
  26528. * This is stored in format, left to right, up to down format.
  26529. */
  26530. right: Nullable<ArrayBufferView>;
  26531. /**
  26532. * The pixel array for the up face.
  26533. * This is stored in format, left to right, up to down format.
  26534. */
  26535. up: Nullable<ArrayBufferView>;
  26536. /**
  26537. * The pixel array for the down face.
  26538. * This is stored in format, left to right, up to down format.
  26539. */
  26540. down: Nullable<ArrayBufferView>;
  26541. /**
  26542. * The size of the cubemap stored.
  26543. *
  26544. * Each faces will be size * size pixels.
  26545. */
  26546. size: number;
  26547. /**
  26548. * The format of the texture.
  26549. *
  26550. * RGBA, RGB.
  26551. */
  26552. format: number;
  26553. /**
  26554. * The type of the texture data.
  26555. *
  26556. * UNSIGNED_INT, FLOAT.
  26557. */
  26558. type: number;
  26559. /**
  26560. * Specifies whether the texture is in gamma space.
  26561. */
  26562. gammaSpace: boolean;
  26563. }
  26564. /**
  26565. * Helper class useful to convert panorama picture to their cubemap representation in 6 faces.
  26566. */
  26567. export class PanoramaToCubeMapTools {
  26568. private static FACE_LEFT;
  26569. private static FACE_RIGHT;
  26570. private static FACE_FRONT;
  26571. private static FACE_BACK;
  26572. private static FACE_DOWN;
  26573. private static FACE_UP;
  26574. /**
  26575. * Converts a panorma stored in RGB right to left up to down format into a cubemap (6 faces).
  26576. *
  26577. * @param float32Array The source data.
  26578. * @param inputWidth The width of the input panorama.
  26579. * @param inputHeight The height of the input panorama.
  26580. * @param size The willing size of the generated cubemap (each faces will be size * size pixels)
  26581. * @return The cubemap data
  26582. */
  26583. static ConvertPanoramaToCubemap(float32Array: Float32Array, inputWidth: number, inputHeight: number, size: number): CubeMapInfo;
  26584. private static CreateCubemapTexture;
  26585. private static CalcProjectionSpherical;
  26586. }
  26587. }
  26588. declare module "babylonjs/Misc/HighDynamicRange/cubemapToSphericalPolynomial" {
  26589. import { SphericalPolynomial } from "babylonjs/Maths/sphericalPolynomial";
  26590. import { BaseTexture } from "babylonjs/Materials/Textures/baseTexture";
  26591. import { Nullable } from "babylonjs/types";
  26592. import { CubeMapInfo } from "babylonjs/Misc/HighDynamicRange/panoramaToCubemap";
  26593. /**
  26594. * Helper class dealing with the extraction of spherical polynomial dataArray
  26595. * from a cube map.
  26596. */
  26597. export class CubeMapToSphericalPolynomialTools {
  26598. private static FileFaces;
  26599. /**
  26600. * Converts a texture to the according Spherical Polynomial data.
  26601. * This extracts the first 3 orders only as they are the only one used in the lighting.
  26602. *
  26603. * @param texture The texture to extract the information from.
  26604. * @return The Spherical Polynomial data.
  26605. */
  26606. static ConvertCubeMapTextureToSphericalPolynomial(texture: BaseTexture): Nullable<SphericalPolynomial>;
  26607. /**
  26608. * Converts a cubemap to the according Spherical Polynomial data.
  26609. * This extracts the first 3 orders only as they are the only one used in the lighting.
  26610. *
  26611. * @param cubeInfo The Cube map to extract the information from.
  26612. * @return The Spherical Polynomial data.
  26613. */
  26614. static ConvertCubeMapToSphericalPolynomial(cubeInfo: CubeMapInfo): SphericalPolynomial;
  26615. }
  26616. }
  26617. declare module "babylonjs/Materials/Textures/baseTexture.polynomial" {
  26618. import { Nullable } from "babylonjs/types";
  26619. import { SphericalPolynomial } from "babylonjs/Maths/sphericalPolynomial";
  26620. module "babylonjs/Materials/Textures/baseTexture" {
  26621. interface BaseTexture {
  26622. /**
  26623. * Get the polynomial representation of the texture data.
  26624. * This is mainly use as a fast way to recover IBL Diffuse irradiance data.
  26625. * @see https://learnopengl.com/PBR/IBL/Diffuse-irradiance
  26626. */
  26627. sphericalPolynomial: Nullable<SphericalPolynomial>;
  26628. }
  26629. }
  26630. }
  26631. declare module "babylonjs/Shaders/ShadersInclude/pbrFragmentDeclaration" {
  26632. /** @hidden */
  26633. export var pbrFragmentDeclaration: {
  26634. name: string;
  26635. shader: string;
  26636. };
  26637. }
  26638. declare module "babylonjs/Shaders/ShadersInclude/pbrUboDeclaration" {
  26639. /** @hidden */
  26640. export var pbrUboDeclaration: {
  26641. name: string;
  26642. shader: string;
  26643. };
  26644. }
  26645. declare module "babylonjs/Shaders/ShadersInclude/pbrFragmentExtraDeclaration" {
  26646. /** @hidden */
  26647. export var pbrFragmentExtraDeclaration: {
  26648. name: string;
  26649. shader: string;
  26650. };
  26651. }
  26652. declare module "babylonjs/Shaders/ShadersInclude/pbrFragmentSamplersDeclaration" {
  26653. /** @hidden */
  26654. export var pbrFragmentSamplersDeclaration: {
  26655. name: string;
  26656. shader: string;
  26657. };
  26658. }
  26659. declare module "babylonjs/Shaders/ShadersInclude/subSurfaceScatteringFunctions" {
  26660. /** @hidden */
  26661. export var subSurfaceScatteringFunctions: {
  26662. name: string;
  26663. shader: string;
  26664. };
  26665. }
  26666. declare module "babylonjs/Shaders/ShadersInclude/importanceSampling" {
  26667. /** @hidden */
  26668. export var importanceSampling: {
  26669. name: string;
  26670. shader: string;
  26671. };
  26672. }
  26673. declare module "babylonjs/Shaders/ShadersInclude/pbrHelperFunctions" {
  26674. /** @hidden */
  26675. export var pbrHelperFunctions: {
  26676. name: string;
  26677. shader: string;
  26678. };
  26679. }
  26680. declare module "babylonjs/Shaders/ShadersInclude/harmonicsFunctions" {
  26681. /** @hidden */
  26682. export var harmonicsFunctions: {
  26683. name: string;
  26684. shader: string;
  26685. };
  26686. }
  26687. declare module "babylonjs/Shaders/ShadersInclude/pbrDirectLightingSetupFunctions" {
  26688. /** @hidden */
  26689. export var pbrDirectLightingSetupFunctions: {
  26690. name: string;
  26691. shader: string;
  26692. };
  26693. }
  26694. declare module "babylonjs/Shaders/ShadersInclude/pbrDirectLightingFalloffFunctions" {
  26695. /** @hidden */
  26696. export var pbrDirectLightingFalloffFunctions: {
  26697. name: string;
  26698. shader: string;
  26699. };
  26700. }
  26701. declare module "babylonjs/Shaders/ShadersInclude/pbrBRDFFunctions" {
  26702. /** @hidden */
  26703. export var pbrBRDFFunctions: {
  26704. name: string;
  26705. shader: string;
  26706. };
  26707. }
  26708. declare module "babylonjs/Shaders/ShadersInclude/hdrFilteringFunctions" {
  26709. /** @hidden */
  26710. export var hdrFilteringFunctions: {
  26711. name: string;
  26712. shader: string;
  26713. };
  26714. }
  26715. declare module "babylonjs/Shaders/ShadersInclude/pbrDirectLightingFunctions" {
  26716. /** @hidden */
  26717. export var pbrDirectLightingFunctions: {
  26718. name: string;
  26719. shader: string;
  26720. };
  26721. }
  26722. declare module "babylonjs/Shaders/ShadersInclude/pbrIBLFunctions" {
  26723. /** @hidden */
  26724. export var pbrIBLFunctions: {
  26725. name: string;
  26726. shader: string;
  26727. };
  26728. }
  26729. declare module "babylonjs/Shaders/ShadersInclude/pbrBlockAlbedoOpacity" {
  26730. /** @hidden */
  26731. export var pbrBlockAlbedoOpacity: {
  26732. name: string;
  26733. shader: string;
  26734. };
  26735. }
  26736. declare module "babylonjs/Shaders/ShadersInclude/pbrBlockReflectivity" {
  26737. /** @hidden */
  26738. export var pbrBlockReflectivity: {
  26739. name: string;
  26740. shader: string;
  26741. };
  26742. }
  26743. declare module "babylonjs/Shaders/ShadersInclude/pbrBlockAmbientOcclusion" {
  26744. /** @hidden */
  26745. export var pbrBlockAmbientOcclusion: {
  26746. name: string;
  26747. shader: string;
  26748. };
  26749. }
  26750. declare module "babylonjs/Shaders/ShadersInclude/pbrBlockAlphaFresnel" {
  26751. /** @hidden */
  26752. export var pbrBlockAlphaFresnel: {
  26753. name: string;
  26754. shader: string;
  26755. };
  26756. }
  26757. declare module "babylonjs/Shaders/ShadersInclude/pbrBlockAnisotropic" {
  26758. /** @hidden */
  26759. export var pbrBlockAnisotropic: {
  26760. name: string;
  26761. shader: string;
  26762. };
  26763. }
  26764. declare module "babylonjs/Shaders/ShadersInclude/pbrBlockReflection" {
  26765. /** @hidden */
  26766. export var pbrBlockReflection: {
  26767. name: string;
  26768. shader: string;
  26769. };
  26770. }
  26771. declare module "babylonjs/Shaders/ShadersInclude/pbrBlockSheen" {
  26772. /** @hidden */
  26773. export var pbrBlockSheen: {
  26774. name: string;
  26775. shader: string;
  26776. };
  26777. }
  26778. declare module "babylonjs/Shaders/ShadersInclude/pbrBlockClearcoat" {
  26779. /** @hidden */
  26780. export var pbrBlockClearcoat: {
  26781. name: string;
  26782. shader: string;
  26783. };
  26784. }
  26785. declare module "babylonjs/Shaders/ShadersInclude/pbrBlockSubSurface" {
  26786. /** @hidden */
  26787. export var pbrBlockSubSurface: {
  26788. name: string;
  26789. shader: string;
  26790. };
  26791. }
  26792. declare module "babylonjs/Shaders/ShadersInclude/pbrBlockNormalGeometric" {
  26793. /** @hidden */
  26794. export var pbrBlockNormalGeometric: {
  26795. name: string;
  26796. shader: string;
  26797. };
  26798. }
  26799. declare module "babylonjs/Shaders/ShadersInclude/pbrBlockNormalFinal" {
  26800. /** @hidden */
  26801. export var pbrBlockNormalFinal: {
  26802. name: string;
  26803. shader: string;
  26804. };
  26805. }
  26806. declare module "babylonjs/Shaders/ShadersInclude/pbrBlockLightmapInit" {
  26807. /** @hidden */
  26808. export var pbrBlockLightmapInit: {
  26809. name: string;
  26810. shader: string;
  26811. };
  26812. }
  26813. declare module "babylonjs/Shaders/ShadersInclude/pbrBlockGeometryInfo" {
  26814. /** @hidden */
  26815. export var pbrBlockGeometryInfo: {
  26816. name: string;
  26817. shader: string;
  26818. };
  26819. }
  26820. declare module "babylonjs/Shaders/ShadersInclude/pbrBlockReflectance0" {
  26821. /** @hidden */
  26822. export var pbrBlockReflectance0: {
  26823. name: string;
  26824. shader: string;
  26825. };
  26826. }
  26827. declare module "babylonjs/Shaders/ShadersInclude/pbrBlockReflectance" {
  26828. /** @hidden */
  26829. export var pbrBlockReflectance: {
  26830. name: string;
  26831. shader: string;
  26832. };
  26833. }
  26834. declare module "babylonjs/Shaders/ShadersInclude/pbrBlockDirectLighting" {
  26835. /** @hidden */
  26836. export var pbrBlockDirectLighting: {
  26837. name: string;
  26838. shader: string;
  26839. };
  26840. }
  26841. declare module "babylonjs/Shaders/ShadersInclude/pbrBlockFinalLitComponents" {
  26842. /** @hidden */
  26843. export var pbrBlockFinalLitComponents: {
  26844. name: string;
  26845. shader: string;
  26846. };
  26847. }
  26848. declare module "babylonjs/Shaders/ShadersInclude/pbrBlockFinalUnlitComponents" {
  26849. /** @hidden */
  26850. export var pbrBlockFinalUnlitComponents: {
  26851. name: string;
  26852. shader: string;
  26853. };
  26854. }
  26855. declare module "babylonjs/Shaders/ShadersInclude/pbrBlockFinalColorComposition" {
  26856. /** @hidden */
  26857. export var pbrBlockFinalColorComposition: {
  26858. name: string;
  26859. shader: string;
  26860. };
  26861. }
  26862. declare module "babylonjs/Shaders/ShadersInclude/pbrBlockImageProcessing" {
  26863. /** @hidden */
  26864. export var pbrBlockImageProcessing: {
  26865. name: string;
  26866. shader: string;
  26867. };
  26868. }
  26869. declare module "babylonjs/Shaders/ShadersInclude/pbrDebug" {
  26870. /** @hidden */
  26871. export var pbrDebug: {
  26872. name: string;
  26873. shader: string;
  26874. };
  26875. }
  26876. declare module "babylonjs/Shaders/pbr.fragment" {
  26877. import "babylonjs/Shaders/ShadersInclude/prePassDeclaration";
  26878. import "babylonjs/Shaders/ShadersInclude/pbrFragmentDeclaration";
  26879. import "babylonjs/Shaders/ShadersInclude/pbrUboDeclaration";
  26880. import "babylonjs/Shaders/ShadersInclude/pbrFragmentExtraDeclaration";
  26881. import "babylonjs/Shaders/ShadersInclude/lightFragmentDeclaration";
  26882. import "babylonjs/Shaders/ShadersInclude/lightUboDeclaration";
  26883. import "babylonjs/Shaders/ShadersInclude/pbrFragmentSamplersDeclaration";
  26884. import "babylonjs/Shaders/ShadersInclude/imageProcessingDeclaration";
  26885. import "babylonjs/Shaders/ShadersInclude/clipPlaneFragmentDeclaration";
  26886. import "babylonjs/Shaders/ShadersInclude/logDepthDeclaration";
  26887. import "babylonjs/Shaders/ShadersInclude/fogFragmentDeclaration";
  26888. import "babylonjs/Shaders/ShadersInclude/helperFunctions";
  26889. import "babylonjs/Shaders/ShadersInclude/subSurfaceScatteringFunctions";
  26890. import "babylonjs/Shaders/ShadersInclude/importanceSampling";
  26891. import "babylonjs/Shaders/ShadersInclude/pbrHelperFunctions";
  26892. import "babylonjs/Shaders/ShadersInclude/imageProcessingFunctions";
  26893. import "babylonjs/Shaders/ShadersInclude/shadowsFragmentFunctions";
  26894. import "babylonjs/Shaders/ShadersInclude/harmonicsFunctions";
  26895. import "babylonjs/Shaders/ShadersInclude/pbrDirectLightingSetupFunctions";
  26896. import "babylonjs/Shaders/ShadersInclude/pbrDirectLightingFalloffFunctions";
  26897. import "babylonjs/Shaders/ShadersInclude/pbrBRDFFunctions";
  26898. import "babylonjs/Shaders/ShadersInclude/hdrFilteringFunctions";
  26899. import "babylonjs/Shaders/ShadersInclude/pbrDirectLightingFunctions";
  26900. import "babylonjs/Shaders/ShadersInclude/pbrIBLFunctions";
  26901. import "babylonjs/Shaders/ShadersInclude/bumpFragmentMainFunctions";
  26902. import "babylonjs/Shaders/ShadersInclude/bumpFragmentFunctions";
  26903. import "babylonjs/Shaders/ShadersInclude/reflectionFunction";
  26904. import "babylonjs/Shaders/ShadersInclude/pbrBlockAlbedoOpacity";
  26905. import "babylonjs/Shaders/ShadersInclude/pbrBlockReflectivity";
  26906. import "babylonjs/Shaders/ShadersInclude/pbrBlockAmbientOcclusion";
  26907. import "babylonjs/Shaders/ShadersInclude/pbrBlockAlphaFresnel";
  26908. import "babylonjs/Shaders/ShadersInclude/pbrBlockAnisotropic";
  26909. import "babylonjs/Shaders/ShadersInclude/pbrBlockReflection";
  26910. import "babylonjs/Shaders/ShadersInclude/pbrBlockSheen";
  26911. import "babylonjs/Shaders/ShadersInclude/pbrBlockClearcoat";
  26912. import "babylonjs/Shaders/ShadersInclude/pbrBlockSubSurface";
  26913. import "babylonjs/Shaders/ShadersInclude/clipPlaneFragment";
  26914. import "babylonjs/Shaders/ShadersInclude/pbrBlockNormalGeometric";
  26915. import "babylonjs/Shaders/ShadersInclude/bumpFragment";
  26916. import "babylonjs/Shaders/ShadersInclude/pbrBlockNormalFinal";
  26917. import "babylonjs/Shaders/ShadersInclude/depthPrePass";
  26918. import "babylonjs/Shaders/ShadersInclude/pbrBlockLightmapInit";
  26919. import "babylonjs/Shaders/ShadersInclude/pbrBlockGeometryInfo";
  26920. import "babylonjs/Shaders/ShadersInclude/pbrBlockReflectance0";
  26921. import "babylonjs/Shaders/ShadersInclude/pbrBlockReflectance";
  26922. import "babylonjs/Shaders/ShadersInclude/pbrBlockDirectLighting";
  26923. import "babylonjs/Shaders/ShadersInclude/lightFragment";
  26924. import "babylonjs/Shaders/ShadersInclude/pbrBlockFinalLitComponents";
  26925. import "babylonjs/Shaders/ShadersInclude/pbrBlockFinalUnlitComponents";
  26926. import "babylonjs/Shaders/ShadersInclude/pbrBlockFinalColorComposition";
  26927. import "babylonjs/Shaders/ShadersInclude/logDepthFragment";
  26928. import "babylonjs/Shaders/ShadersInclude/fogFragment";
  26929. import "babylonjs/Shaders/ShadersInclude/pbrBlockImageProcessing";
  26930. import "babylonjs/Shaders/ShadersInclude/pbrDebug";
  26931. /** @hidden */
  26932. export var pbrPixelShader: {
  26933. name: string;
  26934. shader: string;
  26935. };
  26936. }
  26937. declare module "babylonjs/Shaders/ShadersInclude/pbrVertexDeclaration" {
  26938. /** @hidden */
  26939. export var pbrVertexDeclaration: {
  26940. name: string;
  26941. shader: string;
  26942. };
  26943. }
  26944. declare module "babylonjs/Shaders/pbr.vertex" {
  26945. import "babylonjs/Shaders/ShadersInclude/pbrVertexDeclaration";
  26946. import "babylonjs/Shaders/ShadersInclude/pbrUboDeclaration";
  26947. import "babylonjs/Shaders/ShadersInclude/helperFunctions";
  26948. import "babylonjs/Shaders/ShadersInclude/bonesDeclaration";
  26949. import "babylonjs/Shaders/ShadersInclude/instancesDeclaration";
  26950. import "babylonjs/Shaders/ShadersInclude/prePassVertexDeclaration";
  26951. import "babylonjs/Shaders/ShadersInclude/harmonicsFunctions";
  26952. import "babylonjs/Shaders/ShadersInclude/bumpVertexDeclaration";
  26953. import "babylonjs/Shaders/ShadersInclude/clipPlaneVertexDeclaration";
  26954. import "babylonjs/Shaders/ShadersInclude/fogVertexDeclaration";
  26955. import "babylonjs/Shaders/ShadersInclude/lightFragmentDeclaration";
  26956. import "babylonjs/Shaders/ShadersInclude/lightUboDeclaration";
  26957. import "babylonjs/Shaders/ShadersInclude/morphTargetsVertexGlobalDeclaration";
  26958. import "babylonjs/Shaders/ShadersInclude/morphTargetsVertexDeclaration";
  26959. import "babylonjs/Shaders/ShadersInclude/logDepthDeclaration";
  26960. import "babylonjs/Shaders/ShadersInclude/morphTargetsVertex";
  26961. import "babylonjs/Shaders/ShadersInclude/instancesVertex";
  26962. import "babylonjs/Shaders/ShadersInclude/bonesVertex";
  26963. import "babylonjs/Shaders/ShadersInclude/prePassVertex";
  26964. import "babylonjs/Shaders/ShadersInclude/bumpVertex";
  26965. import "babylonjs/Shaders/ShadersInclude/clipPlaneVertex";
  26966. import "babylonjs/Shaders/ShadersInclude/fogVertex";
  26967. import "babylonjs/Shaders/ShadersInclude/shadowsVertex";
  26968. import "babylonjs/Shaders/ShadersInclude/logDepthVertex";
  26969. /** @hidden */
  26970. export var pbrVertexShader: {
  26971. name: string;
  26972. shader: string;
  26973. };
  26974. }
  26975. declare module "babylonjs/Materials/PBR/pbrBaseMaterial" {
  26976. import { Nullable } from "babylonjs/types";
  26977. import { Scene } from "babylonjs/scene";
  26978. import { Matrix } from "babylonjs/Maths/math.vector";
  26979. import { SubMesh } from "babylonjs/Meshes/subMesh";
  26980. import { AbstractMesh } from "babylonjs/Meshes/abstractMesh";
  26981. import { Mesh } from "babylonjs/Meshes/mesh";
  26982. import { IMaterialClearCoatDefines, PBRClearCoatConfiguration } from "babylonjs/Materials/PBR/pbrClearCoatConfiguration";
  26983. import { IMaterialAnisotropicDefines, PBRAnisotropicConfiguration } from "babylonjs/Materials/PBR/pbrAnisotropicConfiguration";
  26984. import { IMaterialBRDFDefines, PBRBRDFConfiguration } from "babylonjs/Materials/PBR/pbrBRDFConfiguration";
  26985. import { IMaterialSheenDefines, PBRSheenConfiguration } from "babylonjs/Materials/PBR/pbrSheenConfiguration";
  26986. import { IMaterialSubSurfaceDefines, PBRSubSurfaceConfiguration } from "babylonjs/Materials/PBR/pbrSubSurfaceConfiguration";
  26987. import { PrePassConfiguration } from "babylonjs/Materials/prePassConfiguration";
  26988. import { Color3 } from "babylonjs/Maths/math.color";
  26989. import { ImageProcessingConfiguration, IImageProcessingConfigurationDefines } from "babylonjs/Materials/imageProcessingConfiguration";
  26990. import { Material, IMaterialCompilationOptions } from "babylonjs/Materials/material";
  26991. import { MaterialDefines } from "babylonjs/Materials/materialDefines";
  26992. import { PushMaterial } from "babylonjs/Materials/pushMaterial";
  26993. import { BaseTexture } from "babylonjs/Materials/Textures/baseTexture";
  26994. import { IAnimatable } from "babylonjs/Animations/animatable.interface";
  26995. import "babylonjs/Materials/Textures/baseTexture.polynomial";
  26996. import "babylonjs/Shaders/pbr.fragment";
  26997. import "babylonjs/Shaders/pbr.vertex";
  26998. import { IMaterialDetailMapDefines, DetailMapConfiguration } from "babylonjs/Materials/material.detailMapConfiguration";
  26999. import { PrePassRenderer } from "babylonjs/Rendering/prePassRenderer";
  27000. /**
  27001. * Manages the defines for the PBR Material.
  27002. * @hidden
  27003. */
  27004. export class PBRMaterialDefines extends MaterialDefines implements IImageProcessingConfigurationDefines, IMaterialClearCoatDefines, IMaterialAnisotropicDefines, IMaterialBRDFDefines, IMaterialSheenDefines, IMaterialSubSurfaceDefines, IMaterialDetailMapDefines {
  27005. PBR: boolean;
  27006. NUM_SAMPLES: string;
  27007. REALTIME_FILTERING: boolean;
  27008. MAINUV1: boolean;
  27009. MAINUV2: boolean;
  27010. UV1: boolean;
  27011. UV2: boolean;
  27012. ALBEDO: boolean;
  27013. GAMMAALBEDO: boolean;
  27014. ALBEDODIRECTUV: number;
  27015. VERTEXCOLOR: boolean;
  27016. DETAIL: boolean;
  27017. DETAILDIRECTUV: number;
  27018. DETAIL_NORMALBLENDMETHOD: number;
  27019. AMBIENT: boolean;
  27020. AMBIENTDIRECTUV: number;
  27021. AMBIENTINGRAYSCALE: boolean;
  27022. OPACITY: boolean;
  27023. VERTEXALPHA: boolean;
  27024. OPACITYDIRECTUV: number;
  27025. OPACITYRGB: boolean;
  27026. ALPHATEST: boolean;
  27027. DEPTHPREPASS: boolean;
  27028. ALPHABLEND: boolean;
  27029. ALPHAFROMALBEDO: boolean;
  27030. ALPHATESTVALUE: string;
  27031. SPECULAROVERALPHA: boolean;
  27032. RADIANCEOVERALPHA: boolean;
  27033. ALPHAFRESNEL: boolean;
  27034. LINEARALPHAFRESNEL: boolean;
  27035. PREMULTIPLYALPHA: boolean;
  27036. EMISSIVE: boolean;
  27037. EMISSIVEDIRECTUV: number;
  27038. REFLECTIVITY: boolean;
  27039. REFLECTIVITYDIRECTUV: number;
  27040. SPECULARTERM: boolean;
  27041. MICROSURFACEFROMREFLECTIVITYMAP: boolean;
  27042. MICROSURFACEAUTOMATIC: boolean;
  27043. LODBASEDMICROSFURACE: boolean;
  27044. MICROSURFACEMAP: boolean;
  27045. MICROSURFACEMAPDIRECTUV: number;
  27046. METALLICWORKFLOW: boolean;
  27047. ROUGHNESSSTOREINMETALMAPALPHA: boolean;
  27048. ROUGHNESSSTOREINMETALMAPGREEN: boolean;
  27049. METALLNESSSTOREINMETALMAPBLUE: boolean;
  27050. AOSTOREINMETALMAPRED: boolean;
  27051. METALLIC_REFLECTANCE: boolean;
  27052. METALLIC_REFLECTANCEDIRECTUV: number;
  27053. ENVIRONMENTBRDF: boolean;
  27054. ENVIRONMENTBRDF_RGBD: boolean;
  27055. NORMAL: boolean;
  27056. TANGENT: boolean;
  27057. BUMP: boolean;
  27058. BUMPDIRECTUV: number;
  27059. OBJECTSPACE_NORMALMAP: boolean;
  27060. PARALLAX: boolean;
  27061. PARALLAXOCCLUSION: boolean;
  27062. NORMALXYSCALE: boolean;
  27063. LIGHTMAP: boolean;
  27064. LIGHTMAPDIRECTUV: number;
  27065. USELIGHTMAPASSHADOWMAP: boolean;
  27066. GAMMALIGHTMAP: boolean;
  27067. RGBDLIGHTMAP: boolean;
  27068. REFLECTION: boolean;
  27069. REFLECTIONMAP_3D: boolean;
  27070. REFLECTIONMAP_SPHERICAL: boolean;
  27071. REFLECTIONMAP_PLANAR: boolean;
  27072. REFLECTIONMAP_CUBIC: boolean;
  27073. USE_LOCAL_REFLECTIONMAP_CUBIC: boolean;
  27074. REFLECTIONMAP_PROJECTION: boolean;
  27075. REFLECTIONMAP_SKYBOX: boolean;
  27076. REFLECTIONMAP_EXPLICIT: boolean;
  27077. REFLECTIONMAP_EQUIRECTANGULAR: boolean;
  27078. REFLECTIONMAP_EQUIRECTANGULAR_FIXED: boolean;
  27079. REFLECTIONMAP_MIRROREDEQUIRECTANGULAR_FIXED: boolean;
  27080. INVERTCUBICMAP: boolean;
  27081. USESPHERICALFROMREFLECTIONMAP: boolean;
  27082. USEIRRADIANCEMAP: boolean;
  27083. SPHERICAL_HARMONICS: boolean;
  27084. USESPHERICALINVERTEX: boolean;
  27085. REFLECTIONMAP_OPPOSITEZ: boolean;
  27086. LODINREFLECTIONALPHA: boolean;
  27087. GAMMAREFLECTION: boolean;
  27088. RGBDREFLECTION: boolean;
  27089. LINEARSPECULARREFLECTION: boolean;
  27090. RADIANCEOCCLUSION: boolean;
  27091. HORIZONOCCLUSION: boolean;
  27092. INSTANCES: boolean;
  27093. THIN_INSTANCES: boolean;
  27094. PREPASS: boolean;
  27095. PREPASS_IRRADIANCE: boolean;
  27096. PREPASS_IRRADIANCE_INDEX: number;
  27097. PREPASS_ALBEDO: boolean;
  27098. PREPASS_ALBEDO_INDEX: number;
  27099. PREPASS_DEPTHNORMAL: boolean;
  27100. PREPASS_DEPTHNORMAL_INDEX: number;
  27101. PREPASS_POSITION: boolean;
  27102. PREPASS_POSITION_INDEX: number;
  27103. PREPASS_VELOCITY: boolean;
  27104. PREPASS_VELOCITY_INDEX: number;
  27105. PREPASS_REFLECTIVITY: boolean;
  27106. PREPASS_REFLECTIVITY_INDEX: number;
  27107. SCENE_MRT_COUNT: number;
  27108. NUM_BONE_INFLUENCERS: number;
  27109. BonesPerMesh: number;
  27110. BONETEXTURE: boolean;
  27111. BONES_VELOCITY_ENABLED: boolean;
  27112. NONUNIFORMSCALING: boolean;
  27113. MORPHTARGETS: boolean;
  27114. MORPHTARGETS_NORMAL: boolean;
  27115. MORPHTARGETS_TANGENT: boolean;
  27116. MORPHTARGETS_UV: boolean;
  27117. NUM_MORPH_INFLUENCERS: number;
  27118. IMAGEPROCESSING: boolean;
  27119. VIGNETTE: boolean;
  27120. VIGNETTEBLENDMODEMULTIPLY: boolean;
  27121. VIGNETTEBLENDMODEOPAQUE: boolean;
  27122. TONEMAPPING: boolean;
  27123. TONEMAPPING_ACES: boolean;
  27124. CONTRAST: boolean;
  27125. COLORCURVES: boolean;
  27126. COLORGRADING: boolean;
  27127. COLORGRADING3D: boolean;
  27128. SAMPLER3DGREENDEPTH: boolean;
  27129. SAMPLER3DBGRMAP: boolean;
  27130. IMAGEPROCESSINGPOSTPROCESS: boolean;
  27131. EXPOSURE: boolean;
  27132. MULTIVIEW: boolean;
  27133. USEPHYSICALLIGHTFALLOFF: boolean;
  27134. USEGLTFLIGHTFALLOFF: boolean;
  27135. TWOSIDEDLIGHTING: boolean;
  27136. SHADOWFLOAT: boolean;
  27137. CLIPPLANE: boolean;
  27138. CLIPPLANE2: boolean;
  27139. CLIPPLANE3: boolean;
  27140. CLIPPLANE4: boolean;
  27141. CLIPPLANE5: boolean;
  27142. CLIPPLANE6: boolean;
  27143. POINTSIZE: boolean;
  27144. FOG: boolean;
  27145. LOGARITHMICDEPTH: boolean;
  27146. FORCENORMALFORWARD: boolean;
  27147. SPECULARAA: boolean;
  27148. CLEARCOAT: boolean;
  27149. CLEARCOAT_DEFAULTIOR: boolean;
  27150. CLEARCOAT_TEXTURE: boolean;
  27151. CLEARCOAT_TEXTURE_ROUGHNESS: boolean;
  27152. CLEARCOAT_TEXTUREDIRECTUV: number;
  27153. CLEARCOAT_TEXTURE_ROUGHNESSDIRECTUV: number;
  27154. CLEARCOAT_USE_ROUGHNESS_FROM_MAINTEXTURE: boolean;
  27155. CLEARCOAT_TEXTURE_ROUGHNESS_IDENTICAL: boolean;
  27156. CLEARCOAT_BUMP: boolean;
  27157. CLEARCOAT_BUMPDIRECTUV: number;
  27158. CLEARCOAT_REMAP_F0: boolean;
  27159. CLEARCOAT_TINT: boolean;
  27160. CLEARCOAT_TINT_TEXTURE: boolean;
  27161. CLEARCOAT_TINT_TEXTUREDIRECTUV: number;
  27162. ANISOTROPIC: boolean;
  27163. ANISOTROPIC_TEXTURE: boolean;
  27164. ANISOTROPIC_TEXTUREDIRECTUV: number;
  27165. BRDF_V_HEIGHT_CORRELATED: boolean;
  27166. MS_BRDF_ENERGY_CONSERVATION: boolean;
  27167. SPECULAR_GLOSSINESS_ENERGY_CONSERVATION: boolean;
  27168. SHEEN: boolean;
  27169. SHEEN_TEXTURE: boolean;
  27170. SHEEN_TEXTURE_ROUGHNESS: boolean;
  27171. SHEEN_TEXTUREDIRECTUV: number;
  27172. SHEEN_TEXTURE_ROUGHNESSDIRECTUV: number;
  27173. SHEEN_LINKWITHALBEDO: boolean;
  27174. SHEEN_ROUGHNESS: boolean;
  27175. SHEEN_ALBEDOSCALING: boolean;
  27176. SHEEN_USE_ROUGHNESS_FROM_MAINTEXTURE: boolean;
  27177. SHEEN_TEXTURE_ROUGHNESS_IDENTICAL: boolean;
  27178. SUBSURFACE: boolean;
  27179. SS_REFRACTION: boolean;
  27180. SS_TRANSLUCENCY: boolean;
  27181. SS_SCATTERING: boolean;
  27182. SS_THICKNESSANDMASK_TEXTURE: boolean;
  27183. SS_THICKNESSANDMASK_TEXTUREDIRECTUV: number;
  27184. SS_REFRACTIONMAP_3D: boolean;
  27185. SS_REFRACTIONMAP_OPPOSITEZ: boolean;
  27186. SS_LODINREFRACTIONALPHA: boolean;
  27187. SS_GAMMAREFRACTION: boolean;
  27188. SS_RGBDREFRACTION: boolean;
  27189. SS_LINEARSPECULARREFRACTION: boolean;
  27190. SS_LINKREFRACTIONTOTRANSPARENCY: boolean;
  27191. SS_ALBEDOFORREFRACTIONTINT: boolean;
  27192. SS_MASK_FROM_THICKNESS_TEXTURE: boolean;
  27193. UNLIT: boolean;
  27194. DEBUGMODE: number;
  27195. /**
  27196. * Initializes the PBR Material defines.
  27197. */
  27198. constructor();
  27199. /**
  27200. * Resets the PBR Material defines.
  27201. */
  27202. reset(): void;
  27203. }
  27204. /**
  27205. * The Physically based material base class of BJS.
  27206. *
  27207. * This offers the main features of a standard PBR material.
  27208. * For more information, please refer to the documentation :
  27209. * https://doc.babylonjs.com/how_to/physically_based_rendering
  27210. */
  27211. export abstract class PBRBaseMaterial extends PushMaterial {
  27212. /**
  27213. * PBRMaterialTransparencyMode: No transparency mode, Alpha channel is not use.
  27214. */
  27215. static readonly PBRMATERIAL_OPAQUE: number;
  27216. /**
  27217. * PBRMaterialTransparencyMode: Alpha Test mode, pixel are discarded below a certain threshold defined by the alpha cutoff value.
  27218. */
  27219. static readonly PBRMATERIAL_ALPHATEST: number;
  27220. /**
  27221. * PBRMaterialTransparencyMode: Pixels are blended (according to the alpha mode) with the already drawn pixels in the current frame buffer.
  27222. */
  27223. static readonly PBRMATERIAL_ALPHABLEND: number;
  27224. /**
  27225. * PBRMaterialTransparencyMode: Pixels are blended (according to the alpha mode) with the already drawn pixels in the current frame buffer.
  27226. * They are also discarded below the alpha cutoff threshold to improve performances.
  27227. */
  27228. static readonly PBRMATERIAL_ALPHATESTANDBLEND: number;
  27229. /**
  27230. * Defines the default value of how much AO map is occluding the analytical lights
  27231. * (point spot...).
  27232. */
  27233. static DEFAULT_AO_ON_ANALYTICAL_LIGHTS: number;
  27234. /**
  27235. * PBRMaterialLightFalloff Physical: light is falling off following the inverse squared distance law.
  27236. */
  27237. static readonly LIGHTFALLOFF_PHYSICAL: number;
  27238. /**
  27239. * PBRMaterialLightFalloff gltf: light is falling off as described in the gltf moving to PBR document
  27240. * to enhance interoperability with other engines.
  27241. */
  27242. static readonly LIGHTFALLOFF_GLTF: number;
  27243. /**
  27244. * PBRMaterialLightFalloff Standard: light is falling off like in the standard material
  27245. * to enhance interoperability with other materials.
  27246. */
  27247. static readonly LIGHTFALLOFF_STANDARD: number;
  27248. /**
  27249. * Intensity of the direct lights e.g. the four lights available in your scene.
  27250. * This impacts both the direct diffuse and specular highlights.
  27251. */
  27252. protected _directIntensity: number;
  27253. /**
  27254. * Intensity of the emissive part of the material.
  27255. * This helps controlling the emissive effect without modifying the emissive color.
  27256. */
  27257. protected _emissiveIntensity: number;
  27258. /**
  27259. * Intensity of the environment e.g. how much the environment will light the object
  27260. * either through harmonics for rough material or through the refelction for shiny ones.
  27261. */
  27262. protected _environmentIntensity: number;
  27263. /**
  27264. * This is a special control allowing the reduction of the specular highlights coming from the
  27265. * four lights of the scene. Those highlights may not be needed in full environment lighting.
  27266. */
  27267. protected _specularIntensity: number;
  27268. /**
  27269. * This stores the direct, emissive, environment, and specular light intensities into a Vector4.
  27270. */
  27271. private _lightingInfos;
  27272. /**
  27273. * Debug Control allowing disabling the bump map on this material.
  27274. */
  27275. protected _disableBumpMap: boolean;
  27276. /**
  27277. * AKA Diffuse Texture in standard nomenclature.
  27278. */
  27279. protected _albedoTexture: Nullable<BaseTexture>;
  27280. /**
  27281. * AKA Occlusion Texture in other nomenclature.
  27282. */
  27283. protected _ambientTexture: Nullable<BaseTexture>;
  27284. /**
  27285. * AKA Occlusion Texture Intensity in other nomenclature.
  27286. */
  27287. protected _ambientTextureStrength: number;
  27288. /**
  27289. * Defines how much the AO map is occluding the analytical lights (point spot...).
  27290. * 1 means it completely occludes it
  27291. * 0 mean it has no impact
  27292. */
  27293. protected _ambientTextureImpactOnAnalyticalLights: number;
  27294. /**
  27295. * Stores the alpha values in a texture.
  27296. */
  27297. protected _opacityTexture: Nullable<BaseTexture>;
  27298. /**
  27299. * Stores the reflection values in a texture.
  27300. */
  27301. protected _reflectionTexture: Nullable<BaseTexture>;
  27302. /**
  27303. * Stores the emissive values in a texture.
  27304. */
  27305. protected _emissiveTexture: Nullable<BaseTexture>;
  27306. /**
  27307. * AKA Specular texture in other nomenclature.
  27308. */
  27309. protected _reflectivityTexture: Nullable<BaseTexture>;
  27310. /**
  27311. * Used to switch from specular/glossiness to metallic/roughness workflow.
  27312. */
  27313. protected _metallicTexture: Nullable<BaseTexture>;
  27314. /**
  27315. * Specifies the metallic scalar of the metallic/roughness workflow.
  27316. * Can also be used to scale the metalness values of the metallic texture.
  27317. */
  27318. protected _metallic: Nullable<number>;
  27319. /**
  27320. * Specifies the roughness scalar of the metallic/roughness workflow.
  27321. * Can also be used to scale the roughness values of the metallic texture.
  27322. */
  27323. protected _roughness: Nullable<number>;
  27324. /**
  27325. * In metallic workflow, specifies an F0 factor to help configuring the material F0.
  27326. * By default the indexOfrefraction is used to compute F0;
  27327. *
  27328. * This is used as a factor against the default reflectance at normal incidence to tweak it.
  27329. *
  27330. * F0 = defaultF0 * metallicF0Factor * metallicReflectanceColor;
  27331. * F90 = metallicReflectanceColor;
  27332. */
  27333. protected _metallicF0Factor: number;
  27334. /**
  27335. * In metallic workflow, specifies an F90 color to help configuring the material F90.
  27336. * By default the F90 is always 1;
  27337. *
  27338. * Please note that this factor is also used as a factor against the default reflectance at normal incidence.
  27339. *
  27340. * F0 = defaultF0 * metallicF0Factor * metallicReflectanceColor
  27341. * F90 = metallicReflectanceColor;
  27342. */
  27343. protected _metallicReflectanceColor: Color3;
  27344. /**
  27345. * Defines to store metallicReflectanceColor in RGB and metallicF0Factor in A
  27346. * This is multiply against the scalar values defined in the material.
  27347. */
  27348. protected _metallicReflectanceTexture: Nullable<BaseTexture>;
  27349. /**
  27350. * Used to enable roughness/glossiness fetch from a separate channel depending on the current mode.
  27351. * Gray Scale represents roughness in metallic mode and glossiness in specular mode.
  27352. */
  27353. protected _microSurfaceTexture: Nullable<BaseTexture>;
  27354. /**
  27355. * Stores surface normal data used to displace a mesh in a texture.
  27356. */
  27357. protected _bumpTexture: Nullable<BaseTexture>;
  27358. /**
  27359. * Stores the pre-calculated light information of a mesh in a texture.
  27360. */
  27361. protected _lightmapTexture: Nullable<BaseTexture>;
  27362. /**
  27363. * The color of a material in ambient lighting.
  27364. */
  27365. protected _ambientColor: Color3;
  27366. /**
  27367. * AKA Diffuse Color in other nomenclature.
  27368. */
  27369. protected _albedoColor: Color3;
  27370. /**
  27371. * AKA Specular Color in other nomenclature.
  27372. */
  27373. protected _reflectivityColor: Color3;
  27374. /**
  27375. * The color applied when light is reflected from a material.
  27376. */
  27377. protected _reflectionColor: Color3;
  27378. /**
  27379. * The color applied when light is emitted from a material.
  27380. */
  27381. protected _emissiveColor: Color3;
  27382. /**
  27383. * AKA Glossiness in other nomenclature.
  27384. */
  27385. protected _microSurface: number;
  27386. /**
  27387. * Specifies that the material will use the light map as a show map.
  27388. */
  27389. protected _useLightmapAsShadowmap: boolean;
  27390. /**
  27391. * This parameters will enable/disable Horizon occlusion to prevent normal maps to look shiny when the normal
  27392. * makes the reflect vector face the model (under horizon).
  27393. */
  27394. protected _useHorizonOcclusion: boolean;
  27395. /**
  27396. * This parameters will enable/disable radiance occlusion by preventing the radiance to lit
  27397. * too much the area relying on ambient texture to define their ambient occlusion.
  27398. */
  27399. protected _useRadianceOcclusion: boolean;
  27400. /**
  27401. * Specifies that the alpha is coming form the albedo channel alpha channel for alpha blending.
  27402. */
  27403. protected _useAlphaFromAlbedoTexture: boolean;
  27404. /**
  27405. * Specifies that the material will keeps the specular highlights over a transparent surface (only the most limunous ones).
  27406. * A car glass is a good exemple of that. When sun reflects on it you can not see what is behind.
  27407. */
  27408. protected _useSpecularOverAlpha: boolean;
  27409. /**
  27410. * Specifies if the reflectivity texture contains the glossiness information in its alpha channel.
  27411. */
  27412. protected _useMicroSurfaceFromReflectivityMapAlpha: boolean;
  27413. /**
  27414. * Specifies if the metallic texture contains the roughness information in its alpha channel.
  27415. */
  27416. protected _useRoughnessFromMetallicTextureAlpha: boolean;
  27417. /**
  27418. * Specifies if the metallic texture contains the roughness information in its green channel.
  27419. */
  27420. protected _useRoughnessFromMetallicTextureGreen: boolean;
  27421. /**
  27422. * Specifies if the metallic texture contains the metallness information in its blue channel.
  27423. */
  27424. protected _useMetallnessFromMetallicTextureBlue: boolean;
  27425. /**
  27426. * Specifies if the metallic texture contains the ambient occlusion information in its red channel.
  27427. */
  27428. protected _useAmbientOcclusionFromMetallicTextureRed: boolean;
  27429. /**
  27430. * Specifies if the ambient texture contains the ambient occlusion information in its red channel only.
  27431. */
  27432. protected _useAmbientInGrayScale: boolean;
  27433. /**
  27434. * In case the reflectivity map does not contain the microsurface information in its alpha channel,
  27435. * The material will try to infer what glossiness each pixel should be.
  27436. */
  27437. protected _useAutoMicroSurfaceFromReflectivityMap: boolean;
  27438. /**
  27439. * Defines the falloff type used in this material.
  27440. * It by default is Physical.
  27441. */
  27442. protected _lightFalloff: number;
  27443. /**
  27444. * Specifies that the material will keeps the reflection highlights over a transparent surface (only the most limunous ones).
  27445. * A car glass is a good exemple of that. When the street lights reflects on it you can not see what is behind.
  27446. */
  27447. protected _useRadianceOverAlpha: boolean;
  27448. /**
  27449. * Allows using an object space normal map (instead of tangent space).
  27450. */
  27451. protected _useObjectSpaceNormalMap: boolean;
  27452. /**
  27453. * Allows using the bump map in parallax mode.
  27454. */
  27455. protected _useParallax: boolean;
  27456. /**
  27457. * Allows using the bump map in parallax occlusion mode.
  27458. */
  27459. protected _useParallaxOcclusion: boolean;
  27460. /**
  27461. * Controls the scale bias of the parallax mode.
  27462. */
  27463. protected _parallaxScaleBias: number;
  27464. /**
  27465. * If sets to true, disables all the lights affecting the material.
  27466. */
  27467. protected _disableLighting: boolean;
  27468. /**
  27469. * Number of Simultaneous lights allowed on the material.
  27470. */
  27471. protected _maxSimultaneousLights: number;
  27472. /**
  27473. * If sets to true, x component of normal map value will be inverted (x = 1.0 - x).
  27474. */
  27475. protected _invertNormalMapX: boolean;
  27476. /**
  27477. * If sets to true, y component of normal map value will be inverted (y = 1.0 - y).
  27478. */
  27479. protected _invertNormalMapY: boolean;
  27480. /**
  27481. * If sets to true and backfaceCulling is false, normals will be flipped on the backside.
  27482. */
  27483. protected _twoSidedLighting: boolean;
  27484. /**
  27485. * Defines the alpha limits in alpha test mode.
  27486. */
  27487. protected _alphaCutOff: number;
  27488. /**
  27489. * Enforces alpha test in opaque or blend mode in order to improve the performances of some situations.
  27490. */
  27491. protected _forceAlphaTest: boolean;
  27492. /**
  27493. * A fresnel is applied to the alpha of the model to ensure grazing angles edges are not alpha tested.
  27494. * And/Or occlude the blended part. (alpha is converted to gamma to compute the fresnel)
  27495. */
  27496. protected _useAlphaFresnel: boolean;
  27497. /**
  27498. * A fresnel is applied to the alpha of the model to ensure grazing angles edges are not alpha tested.
  27499. * And/Or occlude the blended part. (alpha stays linear to compute the fresnel)
  27500. */
  27501. protected _useLinearAlphaFresnel: boolean;
  27502. /**
  27503. * Specifies the environment BRDF texture used to comput the scale and offset roughness values
  27504. * from cos thetav and roughness:
  27505. * http://blog.selfshadow.com/publications/s2013-shading-course/karis/s2013_pbs_epic_notes_v2.pdf
  27506. */
  27507. protected _environmentBRDFTexture: Nullable<BaseTexture>;
  27508. /**
  27509. * Force the shader to compute irradiance in the fragment shader in order to take bump in account.
  27510. */
  27511. protected _forceIrradianceInFragment: boolean;
  27512. private _realTimeFiltering;
  27513. /**
  27514. * Enables realtime filtering on the texture.
  27515. */
  27516. get realTimeFiltering(): boolean;
  27517. set realTimeFiltering(b: boolean);
  27518. private _realTimeFilteringQuality;
  27519. /**
  27520. * Quality switch for realtime filtering
  27521. */
  27522. get realTimeFilteringQuality(): number;
  27523. set realTimeFilteringQuality(n: number);
  27524. /**
  27525. * Can this material render to several textures at once
  27526. */
  27527. get canRenderToMRT(): boolean;
  27528. /**
  27529. * Force normal to face away from face.
  27530. */
  27531. protected _forceNormalForward: boolean;
  27532. /**
  27533. * Enables specular anti aliasing in the PBR shader.
  27534. * It will both interacts on the Geometry for analytical and IBL lighting.
  27535. * It also prefilter the roughness map based on the bump values.
  27536. */
  27537. protected _enableSpecularAntiAliasing: boolean;
  27538. /**
  27539. * Default configuration related to image processing available in the PBR Material.
  27540. */
  27541. protected _imageProcessingConfiguration: ImageProcessingConfiguration;
  27542. /**
  27543. * Keep track of the image processing observer to allow dispose and replace.
  27544. */
  27545. private _imageProcessingObserver;
  27546. /**
  27547. * Attaches a new image processing configuration to the PBR Material.
  27548. * @param configuration
  27549. */
  27550. protected _attachImageProcessingConfiguration(configuration: Nullable<ImageProcessingConfiguration>): void;
  27551. /**
  27552. * Stores the available render targets.
  27553. */
  27554. private _renderTargets;
  27555. /**
  27556. * Sets the global ambient color for the material used in lighting calculations.
  27557. */
  27558. private _globalAmbientColor;
  27559. /**
  27560. * Enables the use of logarithmic depth buffers, which is good for wide depth buffers.
  27561. */
  27562. private _useLogarithmicDepth;
  27563. /**
  27564. * If set to true, no lighting calculations will be applied.
  27565. */
  27566. private _unlit;
  27567. private _debugMode;
  27568. /**
  27569. * @hidden
  27570. * This is reserved for the inspector.
  27571. * Defines the material debug mode.
  27572. * It helps seeing only some components of the material while troubleshooting.
  27573. */
  27574. debugMode: number;
  27575. /**
  27576. * @hidden
  27577. * This is reserved for the inspector.
  27578. * Specify from where on screen the debug mode should start.
  27579. * The value goes from -1 (full screen) to 1 (not visible)
  27580. * It helps with side by side comparison against the final render
  27581. * This defaults to -1
  27582. */
  27583. private debugLimit;
  27584. /**
  27585. * @hidden
  27586. * This is reserved for the inspector.
  27587. * As the default viewing range might not be enough (if the ambient is really small for instance)
  27588. * You can use the factor to better multiply the final value.
  27589. */
  27590. private debugFactor;
  27591. /**
  27592. * Defines the clear coat layer parameters for the material.
  27593. */
  27594. readonly clearCoat: PBRClearCoatConfiguration;
  27595. /**
  27596. * Defines the anisotropic parameters for the material.
  27597. */
  27598. readonly anisotropy: PBRAnisotropicConfiguration;
  27599. /**
  27600. * Defines the BRDF parameters for the material.
  27601. */
  27602. readonly brdf: PBRBRDFConfiguration;
  27603. /**
  27604. * Defines the Sheen parameters for the material.
  27605. */
  27606. readonly sheen: PBRSheenConfiguration;
  27607. /**
  27608. * Defines the SubSurface parameters for the material.
  27609. */
  27610. readonly subSurface: PBRSubSurfaceConfiguration;
  27611. /**
  27612. * Defines additionnal PrePass parameters for the material.
  27613. */
  27614. readonly prePassConfiguration: PrePassConfiguration;
  27615. /**
  27616. * Defines the detail map parameters for the material.
  27617. */
  27618. readonly detailMap: DetailMapConfiguration;
  27619. protected _rebuildInParallel: boolean;
  27620. /**
  27621. * Instantiates a new PBRMaterial instance.
  27622. *
  27623. * @param name The material name
  27624. * @param scene The scene the material will be use in.
  27625. */
  27626. constructor(name: string, scene: Scene);
  27627. /**
  27628. * Gets a boolean indicating that current material needs to register RTT
  27629. */
  27630. get hasRenderTargetTextures(): boolean;
  27631. /**
  27632. * Gets the name of the material class.
  27633. */
  27634. getClassName(): string;
  27635. /**
  27636. * Enabled the use of logarithmic depth buffers, which is good for wide depth buffers.
  27637. */
  27638. get useLogarithmicDepth(): boolean;
  27639. /**
  27640. * Enabled the use of logarithmic depth buffers, which is good for wide depth buffers.
  27641. */
  27642. set useLogarithmicDepth(value: boolean);
  27643. /**
  27644. * Returns true if alpha blending should be disabled.
  27645. */
  27646. protected get _disableAlphaBlending(): boolean;
  27647. /**
  27648. * Specifies whether or not this material should be rendered in alpha blend mode.
  27649. */
  27650. needAlphaBlending(): boolean;
  27651. /**
  27652. * Specifies whether or not this material should be rendered in alpha test mode.
  27653. */
  27654. needAlphaTesting(): boolean;
  27655. /**
  27656. * Specifies whether or not the alpha value of the albedo texture should be used for alpha blending.
  27657. */
  27658. protected _shouldUseAlphaFromAlbedoTexture(): boolean;
  27659. /**
  27660. * Specifies whether or not there is a usable alpha channel for transparency.
  27661. */
  27662. protected _hasAlphaChannel(): boolean;
  27663. /**
  27664. * Gets the texture used for the alpha test.
  27665. */
  27666. getAlphaTestTexture(): Nullable<BaseTexture>;
  27667. /**
  27668. * Specifies that the submesh is ready to be used.
  27669. * @param mesh - BJS mesh.
  27670. * @param subMesh - A submesh of the BJS mesh. Used to check if it is ready.
  27671. * @param useInstances - Specifies that instances should be used.
  27672. * @returns - boolean indicating that the submesh is ready or not.
  27673. */
  27674. isReadyForSubMesh(mesh: AbstractMesh, subMesh: SubMesh, useInstances?: boolean): boolean;
  27675. /**
  27676. * Specifies if the material uses metallic roughness workflow.
  27677. * @returns boolean specifiying if the material uses metallic roughness workflow.
  27678. */
  27679. isMetallicWorkflow(): boolean;
  27680. private _prepareEffect;
  27681. private _prepareDefines;
  27682. /**
  27683. * Force shader compilation
  27684. */
  27685. forceCompilation(mesh: AbstractMesh, onCompiled?: (material: Material) => void, options?: Partial<IMaterialCompilationOptions>): void;
  27686. /**
  27687. * Initializes the uniform buffer layout for the shader.
  27688. */
  27689. buildUniformLayout(): void;
  27690. /**
  27691. * Unbinds the material from the mesh
  27692. */
  27693. unbind(): void;
  27694. /**
  27695. * Binds the submesh data.
  27696. * @param world - The world matrix.
  27697. * @param mesh - The BJS mesh.
  27698. * @param subMesh - A submesh of the BJS mesh.
  27699. */
  27700. bindForSubMesh(world: Matrix, mesh: Mesh, subMesh: SubMesh): void;
  27701. /**
  27702. * Returns the animatable textures.
  27703. * @returns - Array of animatable textures.
  27704. */
  27705. getAnimatables(): IAnimatable[];
  27706. /**
  27707. * Returns the texture used for reflections.
  27708. * @returns - Reflection texture if present. Otherwise, returns the environment texture.
  27709. */
  27710. private _getReflectionTexture;
  27711. /**
  27712. * Returns an array of the actively used textures.
  27713. * @returns - Array of BaseTextures
  27714. */
  27715. getActiveTextures(): BaseTexture[];
  27716. /**
  27717. * Checks to see if a texture is used in the material.
  27718. * @param texture - Base texture to use.
  27719. * @returns - Boolean specifying if a texture is used in the material.
  27720. */
  27721. hasTexture(texture: BaseTexture): boolean;
  27722. /**
  27723. * Sets the required values to the prepass renderer.
  27724. * @param prePassRenderer defines the prepass renderer to setup
  27725. */
  27726. setPrePassRenderer(prePassRenderer: PrePassRenderer): boolean;
  27727. /**
  27728. * Disposes the resources of the material.
  27729. * @param forceDisposeEffect - Forces the disposal of effects.
  27730. * @param forceDisposeTextures - Forces the disposal of all textures.
  27731. */
  27732. dispose(forceDisposeEffect?: boolean, forceDisposeTextures?: boolean): void;
  27733. }
  27734. }
  27735. declare module "babylonjs/Materials/PBR/pbrMaterial" {
  27736. import { Nullable } from "babylonjs/types";
  27737. import { Scene } from "babylonjs/scene";
  27738. import { Color3 } from "babylonjs/Maths/math.color";
  27739. import { ImageProcessingConfiguration } from "babylonjs/Materials/imageProcessingConfiguration";
  27740. import { ColorCurves } from "babylonjs/Materials/colorCurves";
  27741. import { BaseTexture } from "babylonjs/Materials/Textures/baseTexture";
  27742. import { PBRBaseMaterial } from "babylonjs/Materials/PBR/pbrBaseMaterial";
  27743. /**
  27744. * The Physically based material of BJS.
  27745. *
  27746. * This offers the main features of a standard PBR material.
  27747. * For more information, please refer to the documentation :
  27748. * https://doc.babylonjs.com/how_to/physically_based_rendering
  27749. */
  27750. export class PBRMaterial extends PBRBaseMaterial {
  27751. /**
  27752. * PBRMaterialTransparencyMode: No transparency mode, Alpha channel is not use.
  27753. */
  27754. static readonly PBRMATERIAL_OPAQUE: number;
  27755. /**
  27756. * PBRMaterialTransparencyMode: Alpha Test mode, pixel are discarded below a certain threshold defined by the alpha cutoff value.
  27757. */
  27758. static readonly PBRMATERIAL_ALPHATEST: number;
  27759. /**
  27760. * PBRMaterialTransparencyMode: Pixels are blended (according to the alpha mode) with the already drawn pixels in the current frame buffer.
  27761. */
  27762. static readonly PBRMATERIAL_ALPHABLEND: number;
  27763. /**
  27764. * PBRMaterialTransparencyMode: Pixels are blended (according to the alpha mode) with the already drawn pixels in the current frame buffer.
  27765. * They are also discarded below the alpha cutoff threshold to improve performances.
  27766. */
  27767. static readonly PBRMATERIAL_ALPHATESTANDBLEND: number;
  27768. /**
  27769. * Defines the default value of how much AO map is occluding the analytical lights
  27770. * (point spot...).
  27771. */
  27772. static DEFAULT_AO_ON_ANALYTICAL_LIGHTS: number;
  27773. /**
  27774. * Intensity of the direct lights e.g. the four lights available in your scene.
  27775. * This impacts both the direct diffuse and specular highlights.
  27776. */
  27777. directIntensity: number;
  27778. /**
  27779. * Intensity of the emissive part of the material.
  27780. * This helps controlling the emissive effect without modifying the emissive color.
  27781. */
  27782. emissiveIntensity: number;
  27783. /**
  27784. * Intensity of the environment e.g. how much the environment will light the object
  27785. * either through harmonics for rough material or through the refelction for shiny ones.
  27786. */
  27787. environmentIntensity: number;
  27788. /**
  27789. * This is a special control allowing the reduction of the specular highlights coming from the
  27790. * four lights of the scene. Those highlights may not be needed in full environment lighting.
  27791. */
  27792. specularIntensity: number;
  27793. /**
  27794. * Debug Control allowing disabling the bump map on this material.
  27795. */
  27796. disableBumpMap: boolean;
  27797. /**
  27798. * AKA Diffuse Texture in standard nomenclature.
  27799. */
  27800. albedoTexture: BaseTexture;
  27801. /**
  27802. * AKA Occlusion Texture in other nomenclature.
  27803. */
  27804. ambientTexture: BaseTexture;
  27805. /**
  27806. * AKA Occlusion Texture Intensity in other nomenclature.
  27807. */
  27808. ambientTextureStrength: number;
  27809. /**
  27810. * Defines how much the AO map is occluding the analytical lights (point spot...).
  27811. * 1 means it completely occludes it
  27812. * 0 mean it has no impact
  27813. */
  27814. ambientTextureImpactOnAnalyticalLights: number;
  27815. /**
  27816. * Stores the alpha values in a texture. Use luminance if texture.getAlphaFromRGB is true.
  27817. */
  27818. opacityTexture: BaseTexture;
  27819. /**
  27820. * Stores the reflection values in a texture.
  27821. */
  27822. reflectionTexture: Nullable<BaseTexture>;
  27823. /**
  27824. * Stores the emissive values in a texture.
  27825. */
  27826. emissiveTexture: BaseTexture;
  27827. /**
  27828. * AKA Specular texture in other nomenclature.
  27829. */
  27830. reflectivityTexture: BaseTexture;
  27831. /**
  27832. * Used to switch from specular/glossiness to metallic/roughness workflow.
  27833. */
  27834. metallicTexture: BaseTexture;
  27835. /**
  27836. * Specifies the metallic scalar of the metallic/roughness workflow.
  27837. * Can also be used to scale the metalness values of the metallic texture.
  27838. */
  27839. metallic: Nullable<number>;
  27840. /**
  27841. * Specifies the roughness scalar of the metallic/roughness workflow.
  27842. * Can also be used to scale the roughness values of the metallic texture.
  27843. */
  27844. roughness: Nullable<number>;
  27845. /**
  27846. * In metallic workflow, specifies an F0 factor to help configuring the material F0.
  27847. * By default the indexOfrefraction is used to compute F0;
  27848. *
  27849. * This is used as a factor against the default reflectance at normal incidence to tweak it.
  27850. *
  27851. * F0 = defaultF0 * metallicF0Factor * metallicReflectanceColor;
  27852. * F90 = metallicReflectanceColor;
  27853. */
  27854. metallicF0Factor: number;
  27855. /**
  27856. * In metallic workflow, specifies an F90 color to help configuring the material F90.
  27857. * By default the F90 is always 1;
  27858. *
  27859. * Please note that this factor is also used as a factor against the default reflectance at normal incidence.
  27860. *
  27861. * F0 = defaultF0 * metallicF0Factor * metallicReflectanceColor
  27862. * F90 = metallicReflectanceColor;
  27863. */
  27864. metallicReflectanceColor: Color3;
  27865. /**
  27866. * Defines to store metallicReflectanceColor in RGB and metallicF0Factor in A
  27867. * This is multiply against the scalar values defined in the material.
  27868. */
  27869. metallicReflectanceTexture: Nullable<BaseTexture>;
  27870. /**
  27871. * Used to enable roughness/glossiness fetch from a separate channel depending on the current mode.
  27872. * Gray Scale represents roughness in metallic mode and glossiness in specular mode.
  27873. */
  27874. microSurfaceTexture: BaseTexture;
  27875. /**
  27876. * Stores surface normal data used to displace a mesh in a texture.
  27877. */
  27878. bumpTexture: BaseTexture;
  27879. /**
  27880. * Stores the pre-calculated light information of a mesh in a texture.
  27881. */
  27882. lightmapTexture: BaseTexture;
  27883. /**
  27884. * Stores the refracted light information in a texture.
  27885. */
  27886. get refractionTexture(): Nullable<BaseTexture>;
  27887. set refractionTexture(value: Nullable<BaseTexture>);
  27888. /**
  27889. * The color of a material in ambient lighting.
  27890. */
  27891. ambientColor: Color3;
  27892. /**
  27893. * AKA Diffuse Color in other nomenclature.
  27894. */
  27895. albedoColor: Color3;
  27896. /**
  27897. * AKA Specular Color in other nomenclature.
  27898. */
  27899. reflectivityColor: Color3;
  27900. /**
  27901. * The color reflected from the material.
  27902. */
  27903. reflectionColor: Color3;
  27904. /**
  27905. * The color emitted from the material.
  27906. */
  27907. emissiveColor: Color3;
  27908. /**
  27909. * AKA Glossiness in other nomenclature.
  27910. */
  27911. microSurface: number;
  27912. /**
  27913. * Index of refraction of the material base layer.
  27914. * https://en.wikipedia.org/wiki/List_of_refractive_indices
  27915. *
  27916. * This does not only impact refraction but also the Base F0 of Dielectric Materials.
  27917. *
  27918. * From dielectric fresnel rules: F0 = square((iorT - iorI) / (iorT + iorI))
  27919. */
  27920. get indexOfRefraction(): number;
  27921. set indexOfRefraction(value: number);
  27922. /**
  27923. * Controls if refraction needs to be inverted on Y. This could be useful for procedural texture.
  27924. */
  27925. get invertRefractionY(): boolean;
  27926. set invertRefractionY(value: boolean);
  27927. /**
  27928. * This parameters will make the material used its opacity to control how much it is refracting aginst not.
  27929. * Materials half opaque for instance using refraction could benefit from this control.
  27930. */
  27931. get linkRefractionWithTransparency(): boolean;
  27932. set linkRefractionWithTransparency(value: boolean);
  27933. /**
  27934. * If true, the light map contains occlusion information instead of lighting info.
  27935. */
  27936. useLightmapAsShadowmap: boolean;
  27937. /**
  27938. * Specifies that the alpha is coming form the albedo channel alpha channel for alpha blending.
  27939. */
  27940. useAlphaFromAlbedoTexture: boolean;
  27941. /**
  27942. * Enforces alpha test in opaque or blend mode in order to improve the performances of some situations.
  27943. */
  27944. forceAlphaTest: boolean;
  27945. /**
  27946. * Defines the alpha limits in alpha test mode.
  27947. */
  27948. alphaCutOff: number;
  27949. /**
  27950. * Specifies that the material will keep the specular highlights over a transparent surface (only the most limunous ones).
  27951. * A car glass is a good exemple of that. When sun reflects on it you can not see what is behind.
  27952. */
  27953. useSpecularOverAlpha: boolean;
  27954. /**
  27955. * Specifies if the reflectivity texture contains the glossiness information in its alpha channel.
  27956. */
  27957. useMicroSurfaceFromReflectivityMapAlpha: boolean;
  27958. /**
  27959. * Specifies if the metallic texture contains the roughness information in its alpha channel.
  27960. */
  27961. useRoughnessFromMetallicTextureAlpha: boolean;
  27962. /**
  27963. * Specifies if the metallic texture contains the roughness information in its green channel.
  27964. */
  27965. useRoughnessFromMetallicTextureGreen: boolean;
  27966. /**
  27967. * Specifies if the metallic texture contains the metallness information in its blue channel.
  27968. */
  27969. useMetallnessFromMetallicTextureBlue: boolean;
  27970. /**
  27971. * Specifies if the metallic texture contains the ambient occlusion information in its red channel.
  27972. */
  27973. useAmbientOcclusionFromMetallicTextureRed: boolean;
  27974. /**
  27975. * Specifies if the ambient texture contains the ambient occlusion information in its red channel only.
  27976. */
  27977. useAmbientInGrayScale: boolean;
  27978. /**
  27979. * In case the reflectivity map does not contain the microsurface information in its alpha channel,
  27980. * The material will try to infer what glossiness each pixel should be.
  27981. */
  27982. useAutoMicroSurfaceFromReflectivityMap: boolean;
  27983. /**
  27984. * BJS is using an harcoded light falloff based on a manually sets up range.
  27985. * In PBR, one way to represents the fallof is to use the inverse squared root algorythm.
  27986. * This parameter can help you switch back to the BJS mode in order to create scenes using both materials.
  27987. */
  27988. get usePhysicalLightFalloff(): boolean;
  27989. /**
  27990. * BJS is using an harcoded light falloff based on a manually sets up range.
  27991. * In PBR, one way to represents the fallof is to use the inverse squared root algorythm.
  27992. * This parameter can help you switch back to the BJS mode in order to create scenes using both materials.
  27993. */
  27994. set usePhysicalLightFalloff(value: boolean);
  27995. /**
  27996. * In order to support the falloff compatibility with gltf, a special mode has been added
  27997. * to reproduce the gltf light falloff.
  27998. */
  27999. get useGLTFLightFalloff(): boolean;
  28000. /**
  28001. * In order to support the falloff compatibility with gltf, a special mode has been added
  28002. * to reproduce the gltf light falloff.
  28003. */
  28004. set useGLTFLightFalloff(value: boolean);
  28005. /**
  28006. * Specifies that the material will keeps the reflection highlights over a transparent surface (only the most limunous ones).
  28007. * A car glass is a good exemple of that. When the street lights reflects on it you can not see what is behind.
  28008. */
  28009. useRadianceOverAlpha: boolean;
  28010. /**
  28011. * Allows using an object space normal map (instead of tangent space).
  28012. */
  28013. useObjectSpaceNormalMap: boolean;
  28014. /**
  28015. * Allows using the bump map in parallax mode.
  28016. */
  28017. useParallax: boolean;
  28018. /**
  28019. * Allows using the bump map in parallax occlusion mode.
  28020. */
  28021. useParallaxOcclusion: boolean;
  28022. /**
  28023. * Controls the scale bias of the parallax mode.
  28024. */
  28025. parallaxScaleBias: number;
  28026. /**
  28027. * If sets to true, disables all the lights affecting the material.
  28028. */
  28029. disableLighting: boolean;
  28030. /**
  28031. * Force the shader to compute irradiance in the fragment shader in order to take bump in account.
  28032. */
  28033. forceIrradianceInFragment: boolean;
  28034. /**
  28035. * Number of Simultaneous lights allowed on the material.
  28036. */
  28037. maxSimultaneousLights: number;
  28038. /**
  28039. * If sets to true, x component of normal map value will invert (x = 1.0 - x).
  28040. */
  28041. invertNormalMapX: boolean;
  28042. /**
  28043. * If sets to true, y component of normal map value will invert (y = 1.0 - y).
  28044. */
  28045. invertNormalMapY: boolean;
  28046. /**
  28047. * If sets to true and backfaceCulling is false, normals will be flipped on the backside.
  28048. */
  28049. twoSidedLighting: boolean;
  28050. /**
  28051. * A fresnel is applied to the alpha of the model to ensure grazing angles edges are not alpha tested.
  28052. * And/Or occlude the blended part. (alpha is converted to gamma to compute the fresnel)
  28053. */
  28054. useAlphaFresnel: boolean;
  28055. /**
  28056. * A fresnel is applied to the alpha of the model to ensure grazing angles edges are not alpha tested.
  28057. * And/Or occlude the blended part. (alpha stays linear to compute the fresnel)
  28058. */
  28059. useLinearAlphaFresnel: boolean;
  28060. /**
  28061. * Let user defines the brdf lookup texture used for IBL.
  28062. * A default 8bit version is embedded but you could point at :
  28063. * * Default texture: https://assets.babylonjs.com/environments/correlatedMSBRDF_RGBD.png
  28064. * * Default 16bit pixel depth texture: https://assets.babylonjs.com/environments/correlatedMSBRDF.dds
  28065. * * LEGACY Default None correlated https://assets.babylonjs.com/environments/uncorrelatedBRDF_RGBD.png
  28066. * * LEGACY Default None correlated 16bit pixel depth https://assets.babylonjs.com/environments/uncorrelatedBRDF.dds
  28067. */
  28068. environmentBRDFTexture: Nullable<BaseTexture>;
  28069. /**
  28070. * Force normal to face away from face.
  28071. */
  28072. forceNormalForward: boolean;
  28073. /**
  28074. * Enables specular anti aliasing in the PBR shader.
  28075. * It will both interacts on the Geometry for analytical and IBL lighting.
  28076. * It also prefilter the roughness map based on the bump values.
  28077. */
  28078. enableSpecularAntiAliasing: boolean;
  28079. /**
  28080. * This parameters will enable/disable Horizon occlusion to prevent normal maps to look shiny when the normal
  28081. * makes the reflect vector face the model (under horizon).
  28082. */
  28083. useHorizonOcclusion: boolean;
  28084. /**
  28085. * This parameters will enable/disable radiance occlusion by preventing the radiance to lit
  28086. * too much the area relying on ambient texture to define their ambient occlusion.
  28087. */
  28088. useRadianceOcclusion: boolean;
  28089. /**
  28090. * If set to true, no lighting calculations will be applied.
  28091. */
  28092. unlit: boolean;
  28093. /**
  28094. * Gets the image processing configuration used either in this material.
  28095. */
  28096. get imageProcessingConfiguration(): ImageProcessingConfiguration;
  28097. /**
  28098. * Sets the Default image processing configuration used either in the this material.
  28099. *
  28100. * If sets to null, the scene one is in use.
  28101. */
  28102. set imageProcessingConfiguration(value: ImageProcessingConfiguration);
  28103. /**
  28104. * Gets wether the color curves effect is enabled.
  28105. */
  28106. get cameraColorCurvesEnabled(): boolean;
  28107. /**
  28108. * Sets wether the color curves effect is enabled.
  28109. */
  28110. set cameraColorCurvesEnabled(value: boolean);
  28111. /**
  28112. * Gets wether the color grading effect is enabled.
  28113. */
  28114. get cameraColorGradingEnabled(): boolean;
  28115. /**
  28116. * Gets wether the color grading effect is enabled.
  28117. */
  28118. set cameraColorGradingEnabled(value: boolean);
  28119. /**
  28120. * Gets wether tonemapping is enabled or not.
  28121. */
  28122. get cameraToneMappingEnabled(): boolean;
  28123. /**
  28124. * Sets wether tonemapping is enabled or not
  28125. */
  28126. set cameraToneMappingEnabled(value: boolean);
  28127. /**
  28128. * The camera exposure used on this material.
  28129. * This property is here and not in the camera to allow controlling exposure without full screen post process.
  28130. * This corresponds to a photographic exposure.
  28131. */
  28132. get cameraExposure(): number;
  28133. /**
  28134. * The camera exposure used on this material.
  28135. * This property is here and not in the camera to allow controlling exposure without full screen post process.
  28136. * This corresponds to a photographic exposure.
  28137. */
  28138. set cameraExposure(value: number);
  28139. /**
  28140. * Gets The camera contrast used on this material.
  28141. */
  28142. get cameraContrast(): number;
  28143. /**
  28144. * Sets The camera contrast used on this material.
  28145. */
  28146. set cameraContrast(value: number);
  28147. /**
  28148. * Gets the Color Grading 2D Lookup Texture.
  28149. */
  28150. get cameraColorGradingTexture(): Nullable<BaseTexture>;
  28151. /**
  28152. * Sets the Color Grading 2D Lookup Texture.
  28153. */
  28154. set cameraColorGradingTexture(value: Nullable<BaseTexture>);
  28155. /**
  28156. * The color grading curves provide additional color adjustmnent that is applied after any color grading transform (3D LUT).
  28157. * They allow basic adjustment of saturation and small exposure adjustments, along with color filter tinting to provide white balance adjustment or more stylistic effects.
  28158. * 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;
  28159. * corresponding to low luminance, medium luminance, and high luminance areas respectively.
  28160. */
  28161. get cameraColorCurves(): Nullable<ColorCurves>;
  28162. /**
  28163. * The color grading curves provide additional color adjustmnent that is applied after any color grading transform (3D LUT).
  28164. * They allow basic adjustment of saturation and small exposure adjustments, along with color filter tinting to provide white balance adjustment or more stylistic effects.
  28165. * 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;
  28166. * corresponding to low luminance, medium luminance, and high luminance areas respectively.
  28167. */
  28168. set cameraColorCurves(value: Nullable<ColorCurves>);
  28169. /**
  28170. * Instantiates a new PBRMaterial instance.
  28171. *
  28172. * @param name The material name
  28173. * @param scene The scene the material will be use in.
  28174. */
  28175. constructor(name: string, scene: Scene);
  28176. /**
  28177. * Returns the name of this material class.
  28178. */
  28179. getClassName(): string;
  28180. /**
  28181. * Makes a duplicate of the current material.
  28182. * @param name - name to use for the new material.
  28183. */
  28184. clone(name: string): PBRMaterial;
  28185. /**
  28186. * Serializes this PBR Material.
  28187. * @returns - An object with the serialized material.
  28188. */
  28189. serialize(): any;
  28190. /**
  28191. * Parses a PBR Material from a serialized object.
  28192. * @param source - Serialized object.
  28193. * @param scene - BJS scene instance.
  28194. * @param rootUrl - url for the scene object
  28195. * @returns - PBRMaterial
  28196. */
  28197. static Parse(source: any, scene: Scene, rootUrl: string): PBRMaterial;
  28198. }
  28199. }
  28200. declare module "babylonjs/Shaders/ShadersInclude/mrtFragmentDeclaration" {
  28201. /** @hidden */
  28202. export var mrtFragmentDeclaration: {
  28203. name: string;
  28204. shader: string;
  28205. };
  28206. }
  28207. declare module "babylonjs/Shaders/geometry.fragment" {
  28208. import "babylonjs/Shaders/ShadersInclude/mrtFragmentDeclaration";
  28209. import "babylonjs/Shaders/ShadersInclude/bumpFragmentMainFunctions";
  28210. import "babylonjs/Shaders/ShadersInclude/bumpFragmentFunctions";
  28211. import "babylonjs/Shaders/ShadersInclude/bumpFragment";
  28212. /** @hidden */
  28213. export var geometryPixelShader: {
  28214. name: string;
  28215. shader: string;
  28216. };
  28217. }
  28218. declare module "babylonjs/Shaders/geometry.vertex" {
  28219. import "babylonjs/Shaders/ShadersInclude/bonesDeclaration";
  28220. import "babylonjs/Shaders/ShadersInclude/morphTargetsVertexGlobalDeclaration";
  28221. import "babylonjs/Shaders/ShadersInclude/morphTargetsVertexDeclaration";
  28222. import "babylonjs/Shaders/ShadersInclude/instancesDeclaration";
  28223. import "babylonjs/Shaders/ShadersInclude/morphTargetsVertex";
  28224. import "babylonjs/Shaders/ShadersInclude/instancesVertex";
  28225. import "babylonjs/Shaders/ShadersInclude/bonesVertex";
  28226. import "babylonjs/Shaders/ShadersInclude/bumpVertex";
  28227. /** @hidden */
  28228. export var geometryVertexShader: {
  28229. name: string;
  28230. shader: string;
  28231. };
  28232. }
  28233. declare module "babylonjs/Rendering/geometryBufferRenderer" {
  28234. import { Matrix } from "babylonjs/Maths/math.vector";
  28235. import { SubMesh } from "babylonjs/Meshes/subMesh";
  28236. import { InternalTexture } from "babylonjs/Materials/Textures/internalTexture";
  28237. import { MultiRenderTarget } from "babylonjs/Materials/Textures/multiRenderTarget";
  28238. import { Effect } from "babylonjs/Materials/effect";
  28239. import { PrePassRenderer } from "babylonjs/Rendering/prePassRenderer";
  28240. import { Scene } from "babylonjs/scene";
  28241. import { AbstractMesh } from "babylonjs/Meshes/abstractMesh";
  28242. import { Nullable } from "babylonjs/types";
  28243. import "babylonjs/Shaders/geometry.fragment";
  28244. import "babylonjs/Shaders/geometry.vertex";
  28245. /** @hidden */
  28246. interface ISavedTransformationMatrix {
  28247. world: Matrix;
  28248. viewProjection: Matrix;
  28249. }
  28250. /**
  28251. * This renderer is helpfull to fill one of the render target with a geometry buffer.
  28252. */
  28253. export class GeometryBufferRenderer {
  28254. /**
  28255. * Constant used to retrieve the depth + normal texture index in the G-Buffer textures array
  28256. * using getIndex(GeometryBufferRenderer.DEPTHNORMAL_TEXTURE_INDEX)
  28257. */
  28258. static readonly DEPTHNORMAL_TEXTURE_TYPE: number;
  28259. /**
  28260. * Constant used to retrieve the position texture index in the G-Buffer textures array
  28261. * using getIndex(GeometryBufferRenderer.POSITION_TEXTURE_INDEX)
  28262. */
  28263. static readonly POSITION_TEXTURE_TYPE: number;
  28264. /**
  28265. * Constant used to retrieve the velocity texture index in the G-Buffer textures array
  28266. * using getIndex(GeometryBufferRenderer.VELOCITY_TEXTURE_INDEX)
  28267. */
  28268. static readonly VELOCITY_TEXTURE_TYPE: number;
  28269. /**
  28270. * Constant used to retrieve the reflectivity texture index in the G-Buffer textures array
  28271. * using the getIndex(GeometryBufferRenderer.REFLECTIVITY_TEXTURE_TYPE)
  28272. */
  28273. static readonly REFLECTIVITY_TEXTURE_TYPE: number;
  28274. /**
  28275. * Dictionary used to store the previous transformation matrices of each rendered mesh
  28276. * in order to compute objects velocities when enableVelocity is set to "true"
  28277. * @hidden
  28278. */
  28279. _previousTransformationMatrices: {
  28280. [index: number]: ISavedTransformationMatrix;
  28281. };
  28282. /**
  28283. * Dictionary used to store the previous bones transformation matrices of each rendered mesh
  28284. * in order to compute objects velocities when enableVelocity is set to "true"
  28285. * @hidden
  28286. */
  28287. _previousBonesTransformationMatrices: {
  28288. [index: number]: Float32Array;
  28289. };
  28290. /**
  28291. * Array used to store the ignored skinned meshes while computing velocity map (typically used by the motion blur post-process).
  28292. * Avoids computing bones velocities and computes only mesh's velocity itself (position, rotation, scaling).
  28293. */
  28294. excludedSkinnedMeshesFromVelocity: AbstractMesh[];
  28295. /** Gets or sets a boolean indicating if transparent meshes should be rendered */
  28296. renderTransparentMeshes: boolean;
  28297. private _scene;
  28298. private _resizeObserver;
  28299. private _multiRenderTarget;
  28300. private _ratio;
  28301. private _enablePosition;
  28302. private _enableVelocity;
  28303. private _enableReflectivity;
  28304. private _positionIndex;
  28305. private _velocityIndex;
  28306. private _reflectivityIndex;
  28307. private _depthNormalIndex;
  28308. private _linkedWithPrePass;
  28309. private _prePassRenderer;
  28310. private _attachments;
  28311. protected _effect: Effect;
  28312. protected _cachedDefines: string;
  28313. /**
  28314. * @hidden
  28315. * Sets up internal structures to share outputs with PrePassRenderer
  28316. * This method should only be called by the PrePassRenderer itself
  28317. */
  28318. _linkPrePassRenderer(prePassRenderer: PrePassRenderer): void;
  28319. /**
  28320. * @hidden
  28321. * Separates internal structures from PrePassRenderer so the geometry buffer can now operate by itself.
  28322. * This method should only be called by the PrePassRenderer itself
  28323. */
  28324. _unlinkPrePassRenderer(): void;
  28325. /**
  28326. * @hidden
  28327. * Resets the geometry buffer layout
  28328. */
  28329. _resetLayout(): void;
  28330. /**
  28331. * @hidden
  28332. * Replaces a texture in the geometry buffer renderer
  28333. * Useful when linking textures of the prepass renderer
  28334. */
  28335. _forceTextureType(geometryBufferType: number, index: number): void;
  28336. /**
  28337. * @hidden
  28338. * Sets texture attachments
  28339. * Useful when linking textures of the prepass renderer
  28340. */
  28341. _setAttachments(attachments: number[]): void;
  28342. /**
  28343. * @hidden
  28344. * Replaces the first texture which is hard coded as a depth texture in the geometry buffer
  28345. * Useful when linking textures of the prepass renderer
  28346. */
  28347. _linkInternalTexture(internalTexture: InternalTexture): void;
  28348. /**
  28349. * Gets the render list (meshes to be rendered) used in the G buffer.
  28350. */
  28351. get renderList(): Nullable<AbstractMesh[]>;
  28352. /**
  28353. * Set the render list (meshes to be rendered) used in the G buffer.
  28354. */
  28355. set renderList(meshes: Nullable<AbstractMesh[]>);
  28356. /**
  28357. * Gets wether or not G buffer are supported by the running hardware.
  28358. * This requires draw buffer supports
  28359. */
  28360. get isSupported(): boolean;
  28361. /**
  28362. * Returns the index of the given texture type in the G-Buffer textures array
  28363. * @param textureType The texture type constant. For example GeometryBufferRenderer.POSITION_TEXTURE_INDEX
  28364. * @returns the index of the given texture type in the G-Buffer textures array
  28365. */
  28366. getTextureIndex(textureType: number): number;
  28367. /**
  28368. * Gets a boolean indicating if objects positions are enabled for the G buffer.
  28369. */
  28370. get enablePosition(): boolean;
  28371. /**
  28372. * Sets whether or not objects positions are enabled for the G buffer.
  28373. */
  28374. set enablePosition(enable: boolean);
  28375. /**
  28376. * Gets a boolean indicating if objects velocities are enabled for the G buffer.
  28377. */
  28378. get enableVelocity(): boolean;
  28379. /**
  28380. * Sets wether or not objects velocities are enabled for the G buffer.
  28381. */
  28382. set enableVelocity(enable: boolean);
  28383. /**
  28384. * Gets a boolean indicating if objects roughness are enabled in the G buffer.
  28385. */
  28386. get enableReflectivity(): boolean;
  28387. /**
  28388. * Sets wether or not objects roughness are enabled for the G buffer.
  28389. */
  28390. set enableReflectivity(enable: boolean);
  28391. /**
  28392. * Gets the scene associated with the buffer.
  28393. */
  28394. get scene(): Scene;
  28395. /**
  28396. * Gets the ratio used by the buffer during its creation.
  28397. * How big is the buffer related to the main canvas.
  28398. */
  28399. get ratio(): number;
  28400. /** @hidden */
  28401. static _SceneComponentInitialization: (scene: Scene) => void;
  28402. /**
  28403. * Creates a new G Buffer for the scene
  28404. * @param scene The scene the buffer belongs to
  28405. * @param ratio How big is the buffer related to the main canvas.
  28406. */
  28407. constructor(scene: Scene, ratio?: number);
  28408. /**
  28409. * Checks wether everything is ready to render a submesh to the G buffer.
  28410. * @param subMesh the submesh to check readiness for
  28411. * @param useInstances is the mesh drawn using instance or not
  28412. * @returns true if ready otherwise false
  28413. */
  28414. isReady(subMesh: SubMesh, useInstances: boolean): boolean;
  28415. /**
  28416. * Gets the current underlying G Buffer.
  28417. * @returns the buffer
  28418. */
  28419. getGBuffer(): MultiRenderTarget;
  28420. /**
  28421. * Gets the number of samples used to render the buffer (anti aliasing).
  28422. */
  28423. get samples(): number;
  28424. /**
  28425. * Sets the number of samples used to render the buffer (anti aliasing).
  28426. */
  28427. set samples(value: number);
  28428. /**
  28429. * Disposes the renderer and frees up associated resources.
  28430. */
  28431. dispose(): void;
  28432. private _assignRenderTargetIndices;
  28433. protected _createRenderTargets(): void;
  28434. private _copyBonesTransformationMatrices;
  28435. }
  28436. }
  28437. declare module "babylonjs/Rendering/prePassRenderer" {
  28438. import { MultiRenderTarget } from "babylonjs/Materials/Textures/multiRenderTarget";
  28439. import { Scene } from "babylonjs/scene";
  28440. import { ImageProcessingPostProcess } from "babylonjs/PostProcesses/imageProcessingPostProcess";
  28441. import { Effect } from "babylonjs/Materials/effect";
  28442. import { PrePassEffectConfiguration } from "babylonjs/Rendering/prePassEffectConfiguration";
  28443. import { AbstractMesh } from "babylonjs/Meshes/abstractMesh";
  28444. import { Material } from "babylonjs/Materials/material";
  28445. import { SubMesh } from "babylonjs/Meshes/subMesh";
  28446. /**
  28447. * Renders a pre pass of the scene
  28448. * This means every mesh in the scene will be rendered to a render target texture
  28449. * And then this texture will be composited to the rendering canvas with post processes
  28450. * It is necessary for effects like subsurface scattering or deferred shading
  28451. */
  28452. export class PrePassRenderer {
  28453. /** @hidden */
  28454. static _SceneComponentInitialization: (scene: Scene) => void;
  28455. private _textureFormats;
  28456. /**
  28457. * To save performance, we can excluded skinned meshes from the prepass
  28458. */
  28459. excludedSkinnedMesh: AbstractMesh[];
  28460. /**
  28461. * Force material to be excluded from the prepass
  28462. * Can be useful when `useGeometryBufferFallback` is set to `true`
  28463. * and you don't want a material to show in the effect.
  28464. */
  28465. excludedMaterials: Material[];
  28466. private _textureIndices;
  28467. private _scene;
  28468. private _engine;
  28469. private _isDirty;
  28470. /**
  28471. * Number of textures in the multi render target texture where the scene is directly rendered
  28472. */
  28473. mrtCount: number;
  28474. /**
  28475. * The render target where the scene is directly rendered
  28476. */
  28477. prePassRT: MultiRenderTarget;
  28478. private _multiRenderAttachments;
  28479. private _defaultAttachments;
  28480. private _clearAttachments;
  28481. private _postProcesses;
  28482. private readonly _clearColor;
  28483. /**
  28484. * Image processing post process for composition
  28485. */
  28486. imageProcessingPostProcess: ImageProcessingPostProcess;
  28487. /**
  28488. * Configuration for prepass effects
  28489. */
  28490. private _effectConfigurations;
  28491. private _mrtFormats;
  28492. private _mrtLayout;
  28493. private _enabled;
  28494. /**
  28495. * Indicates if the prepass is enabled
  28496. */
  28497. get enabled(): boolean;
  28498. /**
  28499. * How many samples are used for MSAA of the scene render target
  28500. */
  28501. get samples(): number;
  28502. set samples(n: number);
  28503. private _geometryBuffer;
  28504. private _useGeometryBufferFallback;
  28505. /**
  28506. * Uses the geometry buffer renderer as a fallback for non prepass capable effects
  28507. */
  28508. get useGeometryBufferFallback(): boolean;
  28509. set useGeometryBufferFallback(value: boolean);
  28510. /**
  28511. * Instanciates a prepass renderer
  28512. * @param scene The scene
  28513. */
  28514. constructor(scene: Scene);
  28515. private _initializeAttachments;
  28516. private _createCompositionEffect;
  28517. /**
  28518. * Indicates if rendering a prepass is supported
  28519. */
  28520. get isSupported(): boolean;
  28521. /**
  28522. * Sets the proper output textures to draw in the engine.
  28523. * @param effect The effect that is drawn. It can be or not be compatible with drawing to several output textures.
  28524. * @param subMesh Submesh on which the effect is applied
  28525. */
  28526. bindAttachmentsForEffect(effect: Effect, subMesh: SubMesh): void;
  28527. /**
  28528. * @hidden
  28529. */
  28530. _beforeCameraDraw(): void;
  28531. /**
  28532. * @hidden
  28533. */
  28534. _afterCameraDraw(): void;
  28535. private _checkRTSize;
  28536. private _bindFrameBuffer;
  28537. /**
  28538. * Clears the scene render target (in the sense of settings pixels to the scene clear color value)
  28539. */
  28540. clear(): void;
  28541. private _setState;
  28542. private _updateGeometryBufferLayout;
  28543. /**
  28544. * Adds an effect configuration to the prepass.
  28545. * If an effect has already been added, it won't add it twice and will return the configuration
  28546. * already present.
  28547. * @param cfg the effect configuration
  28548. * @return the effect configuration now used by the prepass
  28549. */
  28550. addEffectConfiguration(cfg: PrePassEffectConfiguration): PrePassEffectConfiguration;
  28551. /**
  28552. * Returns the index of a texture in the multi render target texture array.
  28553. * @param type Texture type
  28554. * @return The index
  28555. */
  28556. getIndex(type: number): number;
  28557. private _enable;
  28558. private _disable;
  28559. private _resetLayout;
  28560. private _resetPostProcessChain;
  28561. private _bindPostProcessChain;
  28562. /**
  28563. * Marks the prepass renderer as dirty, triggering a check if the prepass is necessary for the next rendering.
  28564. */
  28565. markAsDirty(): void;
  28566. /**
  28567. * Enables a texture on the MultiRenderTarget for prepass
  28568. */
  28569. private _enableTextures;
  28570. private _update;
  28571. private _markAllMaterialsAsPrePassDirty;
  28572. /**
  28573. * Disposes the prepass renderer.
  28574. */
  28575. dispose(): void;
  28576. }
  28577. }
  28578. declare module "babylonjs/PostProcesses/postProcess" {
  28579. import { Nullable } from "babylonjs/types";
  28580. import { SmartArray } from "babylonjs/Misc/smartArray";
  28581. import { Observable } from "babylonjs/Misc/observable";
  28582. import { Vector2 } from "babylonjs/Maths/math.vector";
  28583. import { Camera } from "babylonjs/Cameras/camera";
  28584. import { Effect } from "babylonjs/Materials/effect";
  28585. import "babylonjs/Shaders/postprocess.vertex";
  28586. import { IInspectable } from "babylonjs/Misc/iInspectable";
  28587. import { Engine } from "babylonjs/Engines/engine";
  28588. import { Color4 } from "babylonjs/Maths/math.color";
  28589. import "babylonjs/Engines/Extensions/engine.renderTarget";
  28590. import { NodeMaterial } from "babylonjs/Materials/Node/nodeMaterial";
  28591. import { Scene } from "babylonjs/scene";
  28592. import { InternalTexture } from "babylonjs/Materials/Textures/internalTexture";
  28593. import { PrePassRenderer } from "babylonjs/Rendering/prePassRenderer";
  28594. import { PrePassEffectConfiguration } from "babylonjs/Rendering/prePassEffectConfiguration";
  28595. /**
  28596. * Size options for a post process
  28597. */
  28598. export type PostProcessOptions = {
  28599. width: number;
  28600. height: number;
  28601. };
  28602. /**
  28603. * PostProcess can be used to apply a shader to a texture after it has been rendered
  28604. * See https://doc.babylonjs.com/how_to/how_to_use_postprocesses
  28605. */
  28606. export class PostProcess {
  28607. /**
  28608. * Gets or sets the unique id of the post process
  28609. */
  28610. uniqueId: number;
  28611. /** Name of the PostProcess. */
  28612. name: string;
  28613. /**
  28614. * Width of the texture to apply the post process on
  28615. */
  28616. width: number;
  28617. /**
  28618. * Height of the texture to apply the post process on
  28619. */
  28620. height: number;
  28621. /**
  28622. * Gets the node material used to create this postprocess (null if the postprocess was manually created)
  28623. */
  28624. nodeMaterialSource: Nullable<NodeMaterial>;
  28625. /**
  28626. * Internal, reference to the location where this postprocess was output to. (Typically the texture on the next postprocess in the chain)
  28627. * @hidden
  28628. */
  28629. _outputTexture: Nullable<InternalTexture>;
  28630. /**
  28631. * Sampling mode used by the shader
  28632. * See https://doc.babylonjs.com/classes/3.1/texture
  28633. */
  28634. renderTargetSamplingMode: number;
  28635. /**
  28636. * Clear color to use when screen clearing
  28637. */
  28638. clearColor: Color4;
  28639. /**
  28640. * If the buffer needs to be cleared before applying the post process. (default: true)
  28641. * Should be set to false if shader will overwrite all previous pixels.
  28642. */
  28643. autoClear: boolean;
  28644. /**
  28645. * Type of alpha mode to use when performing the post process (default: Engine.ALPHA_DISABLE)
  28646. */
  28647. alphaMode: number;
  28648. /**
  28649. * Sets the setAlphaBlendConstants of the babylon engine
  28650. */
  28651. alphaConstants: Color4;
  28652. /**
  28653. * Animations to be used for the post processing
  28654. */
  28655. animations: import("babylonjs/Animations/animation").Animation[];
  28656. /**
  28657. * Enable Pixel Perfect mode where texture is not scaled to be power of 2.
  28658. * Can only be used on a single postprocess or on the last one of a chain. (default: false)
  28659. */
  28660. enablePixelPerfectMode: boolean;
  28661. /**
  28662. * Force the postprocess to be applied without taking in account viewport
  28663. */
  28664. forceFullscreenViewport: boolean;
  28665. /**
  28666. * List of inspectable custom properties (used by the Inspector)
  28667. * @see https://doc.babylonjs.com/how_to/debug_layer#extensibility
  28668. */
  28669. inspectableCustomProperties: IInspectable[];
  28670. /**
  28671. * Scale mode for the post process (default: Engine.SCALEMODE_FLOOR)
  28672. *
  28673. * | Value | Type | Description |
  28674. * | ----- | ----------------------------------- | ----------- |
  28675. * | 1 | SCALEMODE_FLOOR | [engine.scalemode_floor](https://doc.babylonjs.com/api/classes/babylon.engine#scalemode_floor) |
  28676. * | 2 | SCALEMODE_NEAREST | [engine.scalemode_nearest](https://doc.babylonjs.com/api/classes/babylon.engine#scalemode_nearest) |
  28677. * | 3 | SCALEMODE_CEILING | [engine.scalemode_ceiling](https://doc.babylonjs.com/api/classes/babylon.engine#scalemode_ceiling) |
  28678. *
  28679. */
  28680. scaleMode: number;
  28681. /**
  28682. * Force textures to be a power of two (default: false)
  28683. */
  28684. alwaysForcePOT: boolean;
  28685. private _samples;
  28686. /**
  28687. * Number of sample textures (default: 1)
  28688. */
  28689. get samples(): number;
  28690. set samples(n: number);
  28691. /**
  28692. * Modify the scale of the post process to be the same as the viewport (default: false)
  28693. */
  28694. adaptScaleToCurrentViewport: boolean;
  28695. private _camera;
  28696. protected _scene: Scene;
  28697. private _engine;
  28698. private _options;
  28699. private _reusable;
  28700. private _textureType;
  28701. private _textureFormat;
  28702. /**
  28703. * Smart array of input and output textures for the post process.
  28704. * @hidden
  28705. */
  28706. _textures: SmartArray<import("babylonjs/Materials/Textures/internalTexture").InternalTexture>;
  28707. /**
  28708. * The index in _textures that corresponds to the output texture.
  28709. * @hidden
  28710. */
  28711. _currentRenderTextureInd: number;
  28712. private _effect;
  28713. private _samplers;
  28714. private _fragmentUrl;
  28715. private _vertexUrl;
  28716. private _parameters;
  28717. private _scaleRatio;
  28718. protected _indexParameters: any;
  28719. private _shareOutputWithPostProcess;
  28720. private _texelSize;
  28721. private _forcedOutputTexture;
  28722. /**
  28723. * Prepass configuration in case this post process needs a texture from prepass
  28724. * @hidden
  28725. */
  28726. _prePassEffectConfiguration: PrePassEffectConfiguration;
  28727. /**
  28728. * Returns the fragment url or shader name used in the post process.
  28729. * @returns the fragment url or name in the shader store.
  28730. */
  28731. getEffectName(): string;
  28732. /**
  28733. * An event triggered when the postprocess is activated.
  28734. */
  28735. onActivateObservable: Observable<Camera>;
  28736. private _onActivateObserver;
  28737. /**
  28738. * A function that is added to the onActivateObservable
  28739. */
  28740. set onActivate(callback: Nullable<(camera: Camera) => void>);
  28741. /**
  28742. * An event triggered when the postprocess changes its size.
  28743. */
  28744. onSizeChangedObservable: Observable<PostProcess>;
  28745. private _onSizeChangedObserver;
  28746. /**
  28747. * A function that is added to the onSizeChangedObservable
  28748. */
  28749. set onSizeChanged(callback: (postProcess: PostProcess) => void);
  28750. /**
  28751. * An event triggered when the postprocess applies its effect.
  28752. */
  28753. onApplyObservable: Observable<Effect>;
  28754. private _onApplyObserver;
  28755. /**
  28756. * A function that is added to the onApplyObservable
  28757. */
  28758. set onApply(callback: (effect: Effect) => void);
  28759. /**
  28760. * An event triggered before rendering the postprocess
  28761. */
  28762. onBeforeRenderObservable: Observable<Effect>;
  28763. private _onBeforeRenderObserver;
  28764. /**
  28765. * A function that is added to the onBeforeRenderObservable
  28766. */
  28767. set onBeforeRender(callback: (effect: Effect) => void);
  28768. /**
  28769. * An event triggered after rendering the postprocess
  28770. */
  28771. onAfterRenderObservable: Observable<Effect>;
  28772. private _onAfterRenderObserver;
  28773. /**
  28774. * A function that is added to the onAfterRenderObservable
  28775. */
  28776. set onAfterRender(callback: (efect: Effect) => void);
  28777. /**
  28778. * 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
  28779. * render it's output into this texture and this texture will be used as textureSampler in the fragment shader of this post process.
  28780. */
  28781. get inputTexture(): InternalTexture;
  28782. set inputTexture(value: InternalTexture);
  28783. /**
  28784. * Since inputTexture should always be defined, if we previously manually set `inputTexture`,
  28785. * the only way to unset it is to use this function to restore its internal state
  28786. */
  28787. restoreDefaultInputTexture(): void;
  28788. /**
  28789. * Gets the camera which post process is applied to.
  28790. * @returns The camera the post process is applied to.
  28791. */
  28792. getCamera(): Camera;
  28793. /**
  28794. * Gets the texel size of the postprocess.
  28795. * See https://en.wikipedia.org/wiki/Texel_(graphics)
  28796. */
  28797. get texelSize(): Vector2;
  28798. /**
  28799. * Creates a new instance PostProcess
  28800. * @param name The name of the PostProcess.
  28801. * @param fragmentUrl The url of the fragment shader to be used.
  28802. * @param parameters Array of the names of uniform non-sampler2D variables that will be passed to the shader.
  28803. * @param samplers Array of the names of uniform sampler2D variables that will be passed to the shader.
  28804. * @param options The required width/height ratio to downsize to before computing the render pass. (Use 1.0 for full size)
  28805. * @param camera The camera to apply the render pass to.
  28806. * @param samplingMode The sampling mode to be used when computing the pass. (default: 0)
  28807. * @param engine The engine which the post process will be applied. (default: current engine)
  28808. * @param reusable If the post process can be reused on the same frame. (default: false)
  28809. * @param defines String of defines that will be set when running the fragment shader. (default: null)
  28810. * @param textureType Type of textures used when performing the post process. (default: 0)
  28811. * @param vertexUrl The url of the vertex shader to be used. (default: "postprocess")
  28812. * @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
  28813. * @param blockCompilation If the shader should not be compiled immediatly. (default: false)
  28814. * @param textureFormat Format of textures used when performing the post process. (default: TEXTUREFORMAT_RGBA)
  28815. */
  28816. 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);
  28817. /**
  28818. * Gets a string identifying the name of the class
  28819. * @returns "PostProcess" string
  28820. */
  28821. getClassName(): string;
  28822. /**
  28823. * Gets the engine which this post process belongs to.
  28824. * @returns The engine the post process was enabled with.
  28825. */
  28826. getEngine(): Engine;
  28827. /**
  28828. * The effect that is created when initializing the post process.
  28829. * @returns The created effect corresponding the the postprocess.
  28830. */
  28831. getEffect(): Effect;
  28832. /**
  28833. * To avoid multiple redundant textures for multiple post process, the output the output texture for this post process can be shared with another.
  28834. * @param postProcess The post process to share the output with.
  28835. * @returns This post process.
  28836. */
  28837. shareOutputWith(postProcess: PostProcess): PostProcess;
  28838. /**
  28839. * Reverses the effect of calling shareOutputWith and returns the post process back to its original state.
  28840. * This should be called if the post process that shares output with this post process is disabled/disposed.
  28841. */
  28842. useOwnOutput(): void;
  28843. /**
  28844. * Updates the effect with the current post process compile time values and recompiles the shader.
  28845. * @param defines Define statements that should be added at the beginning of the shader. (default: null)
  28846. * @param uniforms Set of uniform variables that will be passed to the shader. (default: null)
  28847. * @param samplers Set of Texture2D variables that will be passed to the shader. (default: null)
  28848. * @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
  28849. * @param onCompiled Called when the shader has been compiled.
  28850. * @param onError Called if there is an error when compiling a shader.
  28851. * @param vertexUrl The url of the vertex shader to be used (default: the one given at construction time)
  28852. * @param fragmentUrl The url of the fragment shader to be used (default: the one given at construction time)
  28853. */
  28854. 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;
  28855. /**
  28856. * The post process is reusable if it can be used multiple times within one frame.
  28857. * @returns If the post process is reusable
  28858. */
  28859. isReusable(): boolean;
  28860. /** invalidate frameBuffer to hint the postprocess to create a depth buffer */
  28861. markTextureDirty(): void;
  28862. /**
  28863. * Activates the post process by intializing the textures to be used when executed. Notifies onActivateObservable.
  28864. * 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.
  28865. * @param camera The camera that will be used in the post process. This camera will be used when calling onActivateObservable.
  28866. * @param sourceTexture The source texture to be inspected to get the width and height if not specified in the post process constructor. (default: null)
  28867. * @param forceDepthStencil If true, a depth and stencil buffer will be generated. (default: false)
  28868. * @returns The target texture that was bound to be written to.
  28869. */
  28870. activate(camera: Nullable<Camera>, sourceTexture?: Nullable<InternalTexture>, forceDepthStencil?: boolean): InternalTexture;
  28871. /**
  28872. * If the post process is supported.
  28873. */
  28874. get isSupported(): boolean;
  28875. /**
  28876. * The aspect ratio of the output texture.
  28877. */
  28878. get aspectRatio(): number;
  28879. /**
  28880. * Get a value indicating if the post-process is ready to be used
  28881. * @returns true if the post-process is ready (shader is compiled)
  28882. */
  28883. isReady(): boolean;
  28884. /**
  28885. * Binds all textures and uniforms to the shader, this will be run on every pass.
  28886. * @returns the effect corresponding to this post process. Null if not compiled or not ready.
  28887. */
  28888. apply(): Nullable<Effect>;
  28889. private _disposeTextures;
  28890. /**
  28891. * Sets the required values to the prepass renderer.
  28892. * @param prePassRenderer defines the prepass renderer to setup.
  28893. * @returns true if the pre pass is needed.
  28894. */
  28895. setPrePassRenderer(prePassRenderer: PrePassRenderer): boolean;
  28896. /**
  28897. * Disposes the post process.
  28898. * @param camera The camera to dispose the post process on.
  28899. */
  28900. dispose(camera?: Camera): void;
  28901. /**
  28902. * Serializes the particle system to a JSON object
  28903. * @returns the JSON object
  28904. */
  28905. serialize(): any;
  28906. /**
  28907. * Creates a material from parsed material data
  28908. * @param parsedPostProcess defines parsed post process data
  28909. * @param scene defines the hosting scene
  28910. * @param rootUrl defines the root URL to use to load textures
  28911. * @returns a new post process
  28912. */
  28913. static Parse(parsedPostProcess: any, scene: Scene, rootUrl: string): Nullable<PostProcess>;
  28914. }
  28915. }
  28916. declare module "babylonjs/Shaders/ShadersInclude/kernelBlurVaryingDeclaration" {
  28917. /** @hidden */
  28918. export var kernelBlurVaryingDeclaration: {
  28919. name: string;
  28920. shader: string;
  28921. };
  28922. }
  28923. declare module "babylonjs/Shaders/ShadersInclude/kernelBlurFragment" {
  28924. /** @hidden */
  28925. export var kernelBlurFragment: {
  28926. name: string;
  28927. shader: string;
  28928. };
  28929. }
  28930. declare module "babylonjs/Shaders/ShadersInclude/kernelBlurFragment2" {
  28931. /** @hidden */
  28932. export var kernelBlurFragment2: {
  28933. name: string;
  28934. shader: string;
  28935. };
  28936. }
  28937. declare module "babylonjs/Shaders/kernelBlur.fragment" {
  28938. import "babylonjs/Shaders/ShadersInclude/kernelBlurVaryingDeclaration";
  28939. import "babylonjs/Shaders/ShadersInclude/packingFunctions";
  28940. import "babylonjs/Shaders/ShadersInclude/kernelBlurFragment";
  28941. import "babylonjs/Shaders/ShadersInclude/kernelBlurFragment2";
  28942. /** @hidden */
  28943. export var kernelBlurPixelShader: {
  28944. name: string;
  28945. shader: string;
  28946. };
  28947. }
  28948. declare module "babylonjs/Shaders/ShadersInclude/kernelBlurVertex" {
  28949. /** @hidden */
  28950. export var kernelBlurVertex: {
  28951. name: string;
  28952. shader: string;
  28953. };
  28954. }
  28955. declare module "babylonjs/Shaders/kernelBlur.vertex" {
  28956. import "babylonjs/Shaders/ShadersInclude/kernelBlurVaryingDeclaration";
  28957. import "babylonjs/Shaders/ShadersInclude/kernelBlurVertex";
  28958. /** @hidden */
  28959. export var kernelBlurVertexShader: {
  28960. name: string;
  28961. shader: string;
  28962. };
  28963. }
  28964. declare module "babylonjs/PostProcesses/blurPostProcess" {
  28965. import { Vector2 } from "babylonjs/Maths/math.vector";
  28966. import { Nullable } from "babylonjs/types";
  28967. import { PostProcess, PostProcessOptions } from "babylonjs/PostProcesses/postProcess";
  28968. import { Camera } from "babylonjs/Cameras/camera";
  28969. import { Effect } from "babylonjs/Materials/effect";
  28970. import { Engine } from "babylonjs/Engines/engine";
  28971. import "babylonjs/Shaders/kernelBlur.fragment";
  28972. import "babylonjs/Shaders/kernelBlur.vertex";
  28973. import { Scene } from "babylonjs/scene";
  28974. /**
  28975. * The Blur Post Process which blurs an image based on a kernel and direction.
  28976. * Can be used twice in x and y directions to perform a guassian blur in two passes.
  28977. */
  28978. export class BlurPostProcess extends PostProcess {
  28979. private blockCompilation;
  28980. protected _kernel: number;
  28981. protected _idealKernel: number;
  28982. protected _packedFloat: boolean;
  28983. private _staticDefines;
  28984. /** The direction in which to blur the image. */
  28985. direction: Vector2;
  28986. /**
  28987. * Sets the length in pixels of the blur sample region
  28988. */
  28989. set kernel(v: number);
  28990. /**
  28991. * Gets the length in pixels of the blur sample region
  28992. */
  28993. get kernel(): number;
  28994. /**
  28995. * Sets wether or not the blur needs to unpack/repack floats
  28996. */
  28997. set packedFloat(v: boolean);
  28998. /**
  28999. * Gets wether or not the blur is unpacking/repacking floats
  29000. */
  29001. get packedFloat(): boolean;
  29002. /**
  29003. * Gets a string identifying the name of the class
  29004. * @returns "BlurPostProcess" string
  29005. */
  29006. getClassName(): string;
  29007. /**
  29008. * Creates a new instance BlurPostProcess
  29009. * @param name The name of the effect.
  29010. * @param direction The direction in which to blur the image.
  29011. * @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.
  29012. * @param options The required width/height ratio to downsize to before computing the render pass. (Use 1.0 for full size)
  29013. * @param camera The camera to apply the render pass to.
  29014. * @param samplingMode The sampling mode to be used when computing the pass. (default: 0)
  29015. * @param engine The engine which the post process will be applied. (default: current engine)
  29016. * @param reusable If the post process can be reused on the same frame. (default: false)
  29017. * @param textureType Type of textures used when performing the post process. (default: 0)
  29018. * @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)
  29019. */
  29020. 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);
  29021. /**
  29022. * Updates the effect with the current post process compile time values and recompiles the shader.
  29023. * @param defines Define statements that should be added at the beginning of the shader. (default: null)
  29024. * @param uniforms Set of uniform variables that will be passed to the shader. (default: null)
  29025. * @param samplers Set of Texture2D variables that will be passed to the shader. (default: null)
  29026. * @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
  29027. * @param onCompiled Called when the shader has been compiled.
  29028. * @param onError Called if there is an error when compiling a shader.
  29029. */
  29030. updateEffect(defines?: Nullable<string>, uniforms?: Nullable<string[]>, samplers?: Nullable<string[]>, indexParameters?: any, onCompiled?: (effect: Effect) => void, onError?: (effect: Effect, errors: string) => void): void;
  29031. protected _updateParameters(onCompiled?: (effect: Effect) => void, onError?: (effect: Effect, errors: string) => void): void;
  29032. /**
  29033. * Best kernels are odd numbers that when divided by 2, their integer part is even, so 5, 9 or 13.
  29034. * Other odd kernels optimize correctly but require proportionally more samples, even kernels are
  29035. * possible but will produce minor visual artifacts. Since each new kernel requires a new shader we
  29036. * want to minimize kernel changes, having gaps between physical kernels is helpful in that regard.
  29037. * The gaps between physical kernels are compensated for in the weighting of the samples
  29038. * @param idealKernel Ideal blur kernel.
  29039. * @return Nearest best kernel.
  29040. */
  29041. protected _nearestBestKernel(idealKernel: number): number;
  29042. /**
  29043. * Calculates the value of a Gaussian distribution with sigma 3 at a given point.
  29044. * @param x The point on the Gaussian distribution to sample.
  29045. * @return the value of the Gaussian function at x.
  29046. */
  29047. protected _gaussianWeight(x: number): number;
  29048. /**
  29049. * Generates a string that can be used as a floating point number in GLSL.
  29050. * @param x Value to print.
  29051. * @param decimalFigures Number of decimal places to print the number to (excluding trailing 0s).
  29052. * @return GLSL float string.
  29053. */
  29054. protected _glslFloat(x: number, decimalFigures?: number): string;
  29055. /** @hidden */
  29056. static _Parse(parsedPostProcess: any, targetCamera: Camera, scene: Scene, rootUrl: string): Nullable<BlurPostProcess>;
  29057. }
  29058. }
  29059. declare module "babylonjs/Materials/Textures/mirrorTexture" {
  29060. import { Scene } from "babylonjs/scene";
  29061. import { RenderTargetTexture } from "babylonjs/Materials/Textures/renderTargetTexture";
  29062. import { Plane } from "babylonjs/Maths/math.plane";
  29063. /**
  29064. * Mirror texture can be used to simulate the view from a mirror in a scene.
  29065. * It will dynamically be rendered every frame to adapt to the camera point of view.
  29066. * You can then easily use it as a reflectionTexture on a flat surface.
  29067. * In case the surface is not a plane, please consider relying on reflection probes.
  29068. * @see https://doc.babylonjs.com/how_to/reflect#mirrors
  29069. */
  29070. export class MirrorTexture extends RenderTargetTexture {
  29071. private scene;
  29072. /**
  29073. * Define the reflection plane we want to use. The mirrorPlane is usually set to the constructed reflector.
  29074. * 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.
  29075. * @see https://doc.babylonjs.com/how_to/reflect#mirrors
  29076. */
  29077. mirrorPlane: Plane;
  29078. /**
  29079. * Define the blur ratio used to blur the reflection if needed.
  29080. */
  29081. set blurRatio(value: number);
  29082. get blurRatio(): number;
  29083. /**
  29084. * Define the adaptive blur kernel used to blur the reflection if needed.
  29085. * This will autocompute the closest best match for the `blurKernel`
  29086. */
  29087. set adaptiveBlurKernel(value: number);
  29088. /**
  29089. * Define the blur kernel used to blur the reflection if needed.
  29090. * Please consider using `adaptiveBlurKernel` as it could find the closest best value for you.
  29091. */
  29092. set blurKernel(value: number);
  29093. /**
  29094. * Define the blur kernel on the X Axis used to blur the reflection if needed.
  29095. * Please consider using `adaptiveBlurKernel` as it could find the closest best value for you.
  29096. */
  29097. set blurKernelX(value: number);
  29098. get blurKernelX(): number;
  29099. /**
  29100. * Define the blur kernel on the Y Axis used to blur the reflection if needed.
  29101. * Please consider using `adaptiveBlurKernel` as it could find the closest best value for you.
  29102. */
  29103. set blurKernelY(value: number);
  29104. get blurKernelY(): number;
  29105. private _autoComputeBlurKernel;
  29106. protected _onRatioRescale(): void;
  29107. private _updateGammaSpace;
  29108. private _imageProcessingConfigChangeObserver;
  29109. private _transformMatrix;
  29110. private _mirrorMatrix;
  29111. private _savedViewMatrix;
  29112. private _blurX;
  29113. private _blurY;
  29114. private _adaptiveBlurKernel;
  29115. private _blurKernelX;
  29116. private _blurKernelY;
  29117. private _blurRatio;
  29118. /**
  29119. * Instantiates a Mirror Texture.
  29120. * Mirror texture can be used to simulate the view from a mirror in a scene.
  29121. * It will dynamically be rendered every frame to adapt to the camera point of view.
  29122. * You can then easily use it as a reflectionTexture on a flat surface.
  29123. * In case the surface is not a plane, please consider relying on reflection probes.
  29124. * @see https://doc.babylonjs.com/how_to/reflect#mirrors
  29125. * @param name
  29126. * @param size
  29127. * @param scene
  29128. * @param generateMipMaps
  29129. * @param type
  29130. * @param samplingMode
  29131. * @param generateDepthBuffer
  29132. */
  29133. constructor(name: string, size: number | {
  29134. width: number;
  29135. height: number;
  29136. } | {
  29137. ratio: number;
  29138. }, scene: Scene, generateMipMaps?: boolean, type?: number, samplingMode?: number, generateDepthBuffer?: boolean);
  29139. private _preparePostProcesses;
  29140. /**
  29141. * Clone the mirror texture.
  29142. * @returns the cloned texture
  29143. */
  29144. clone(): MirrorTexture;
  29145. /**
  29146. * Serialize the texture to a JSON representation you could use in Parse later on
  29147. * @returns the serialized JSON representation
  29148. */
  29149. serialize(): any;
  29150. /**
  29151. * Dispose the texture and release its associated resources.
  29152. */
  29153. dispose(): void;
  29154. }
  29155. }
  29156. declare module "babylonjs/Materials/Textures/texture" {
  29157. import { Observable } from "babylonjs/Misc/observable";
  29158. import { Nullable } from "babylonjs/types";
  29159. import { Matrix } from "babylonjs/Maths/math.vector";
  29160. import { BaseTexture } from "babylonjs/Materials/Textures/baseTexture";
  29161. import { IInspectable } from "babylonjs/Misc/iInspectable";
  29162. import { ThinEngine } from "babylonjs/Engines/thinEngine";
  29163. import { CubeTexture } from "babylonjs/Materials/Textures/cubeTexture";
  29164. import { MirrorTexture } from "babylonjs/Materials/Textures/mirrorTexture";
  29165. import { RenderTargetTexture } from "babylonjs/Materials/Textures/renderTargetTexture";
  29166. import { Scene } from "babylonjs/scene";
  29167. /**
  29168. * This represents a texture in babylon. It can be easily loaded from a network, base64 or html input.
  29169. * @see https://doc.babylonjs.com/babylon101/materials#texture
  29170. */
  29171. export class Texture extends BaseTexture {
  29172. /**
  29173. * Gets or sets a general boolean used to indicate that textures containing direct data (buffers) must be saved as part of the serialization process
  29174. */
  29175. static SerializeBuffers: boolean;
  29176. /** @hidden */
  29177. static _CubeTextureParser: (jsonTexture: any, scene: Scene, rootUrl: string) => CubeTexture;
  29178. /** @hidden */
  29179. static _CreateMirror: (name: string, renderTargetSize: number, scene: Scene, generateMipMaps: boolean) => MirrorTexture;
  29180. /** @hidden */
  29181. static _CreateRenderTargetTexture: (name: string, renderTargetSize: number, scene: Scene, generateMipMaps: boolean) => RenderTargetTexture;
  29182. /** nearest is mag = nearest and min = nearest and mip = linear */
  29183. static readonly NEAREST_SAMPLINGMODE: number;
  29184. /** nearest is mag = nearest and min = nearest and mip = linear */
  29185. static readonly NEAREST_NEAREST_MIPLINEAR: number;
  29186. /** Bilinear is mag = linear and min = linear and mip = nearest */
  29187. static readonly BILINEAR_SAMPLINGMODE: number;
  29188. /** Bilinear is mag = linear and min = linear and mip = nearest */
  29189. static readonly LINEAR_LINEAR_MIPNEAREST: number;
  29190. /** Trilinear is mag = linear and min = linear and mip = linear */
  29191. static readonly TRILINEAR_SAMPLINGMODE: number;
  29192. /** Trilinear is mag = linear and min = linear and mip = linear */
  29193. static readonly LINEAR_LINEAR_MIPLINEAR: number;
  29194. /** mag = nearest and min = nearest and mip = nearest */
  29195. static readonly NEAREST_NEAREST_MIPNEAREST: number;
  29196. /** mag = nearest and min = linear and mip = nearest */
  29197. static readonly NEAREST_LINEAR_MIPNEAREST: number;
  29198. /** mag = nearest and min = linear and mip = linear */
  29199. static readonly NEAREST_LINEAR_MIPLINEAR: number;
  29200. /** mag = nearest and min = linear and mip = none */
  29201. static readonly NEAREST_LINEAR: number;
  29202. /** mag = nearest and min = nearest and mip = none */
  29203. static readonly NEAREST_NEAREST: number;
  29204. /** mag = linear and min = nearest and mip = nearest */
  29205. static readonly LINEAR_NEAREST_MIPNEAREST: number;
  29206. /** mag = linear and min = nearest and mip = linear */
  29207. static readonly LINEAR_NEAREST_MIPLINEAR: number;
  29208. /** mag = linear and min = linear and mip = none */
  29209. static readonly LINEAR_LINEAR: number;
  29210. /** mag = linear and min = nearest and mip = none */
  29211. static readonly LINEAR_NEAREST: number;
  29212. /** Explicit coordinates mode */
  29213. static readonly EXPLICIT_MODE: number;
  29214. /** Spherical coordinates mode */
  29215. static readonly SPHERICAL_MODE: number;
  29216. /** Planar coordinates mode */
  29217. static readonly PLANAR_MODE: number;
  29218. /** Cubic coordinates mode */
  29219. static readonly CUBIC_MODE: number;
  29220. /** Projection coordinates mode */
  29221. static readonly PROJECTION_MODE: number;
  29222. /** Inverse Cubic coordinates mode */
  29223. static readonly SKYBOX_MODE: number;
  29224. /** Inverse Cubic coordinates mode */
  29225. static readonly INVCUBIC_MODE: number;
  29226. /** Equirectangular coordinates mode */
  29227. static readonly EQUIRECTANGULAR_MODE: number;
  29228. /** Equirectangular Fixed coordinates mode */
  29229. static readonly FIXED_EQUIRECTANGULAR_MODE: number;
  29230. /** Equirectangular Fixed Mirrored coordinates mode */
  29231. static readonly FIXED_EQUIRECTANGULAR_MIRRORED_MODE: number;
  29232. /** Texture is not repeating outside of 0..1 UVs */
  29233. static readonly CLAMP_ADDRESSMODE: number;
  29234. /** Texture is repeating outside of 0..1 UVs */
  29235. static readonly WRAP_ADDRESSMODE: number;
  29236. /** Texture is repeating and mirrored */
  29237. static readonly MIRROR_ADDRESSMODE: number;
  29238. /**
  29239. * 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
  29240. */
  29241. static UseSerializedUrlIfAny: boolean;
  29242. /**
  29243. * Define the url of the texture.
  29244. */
  29245. url: Nullable<string>;
  29246. /**
  29247. * Define an offset on the texture to offset the u coordinates of the UVs
  29248. * @see https://doc.babylonjs.com/how_to/more_materials#offsetting
  29249. */
  29250. uOffset: number;
  29251. /**
  29252. * Define an offset on the texture to offset the v coordinates of the UVs
  29253. * @see https://doc.babylonjs.com/how_to/more_materials#offsetting
  29254. */
  29255. vOffset: number;
  29256. /**
  29257. * Define an offset on the texture to scale the u coordinates of the UVs
  29258. * @see https://doc.babylonjs.com/how_to/more_materials#tiling
  29259. */
  29260. uScale: number;
  29261. /**
  29262. * Define an offset on the texture to scale the v coordinates of the UVs
  29263. * @see https://doc.babylonjs.com/how_to/more_materials#tiling
  29264. */
  29265. vScale: number;
  29266. /**
  29267. * Define an offset on the texture to rotate around the u coordinates of the UVs
  29268. * @see https://doc.babylonjs.com/how_to/more_materials
  29269. */
  29270. uAng: number;
  29271. /**
  29272. * Define an offset on the texture to rotate around the v coordinates of the UVs
  29273. * @see https://doc.babylonjs.com/how_to/more_materials
  29274. */
  29275. vAng: number;
  29276. /**
  29277. * Define an offset on the texture to rotate around the w coordinates of the UVs (in case of 3d texture)
  29278. * @see https://doc.babylonjs.com/how_to/more_materials
  29279. */
  29280. wAng: number;
  29281. /**
  29282. * Defines the center of rotation (U)
  29283. */
  29284. uRotationCenter: number;
  29285. /**
  29286. * Defines the center of rotation (V)
  29287. */
  29288. vRotationCenter: number;
  29289. /**
  29290. * Defines the center of rotation (W)
  29291. */
  29292. wRotationCenter: number;
  29293. /**
  29294. * Sets this property to true to avoid deformations when rotating the texture with non-uniform scaling
  29295. */
  29296. homogeneousRotationInUVTransform: boolean;
  29297. /**
  29298. * Are mip maps generated for this texture or not.
  29299. */
  29300. get noMipmap(): boolean;
  29301. /**
  29302. * List of inspectable custom properties (used by the Inspector)
  29303. * @see https://doc.babylonjs.com/how_to/debug_layer#extensibility
  29304. */
  29305. inspectableCustomProperties: Nullable<IInspectable[]>;
  29306. private _noMipmap;
  29307. /** @hidden */
  29308. _invertY: boolean;
  29309. private _rowGenerationMatrix;
  29310. private _cachedTextureMatrix;
  29311. private _projectionModeMatrix;
  29312. private _t0;
  29313. private _t1;
  29314. private _t2;
  29315. private _cachedUOffset;
  29316. private _cachedVOffset;
  29317. private _cachedUScale;
  29318. private _cachedVScale;
  29319. private _cachedUAng;
  29320. private _cachedVAng;
  29321. private _cachedWAng;
  29322. private _cachedProjectionMatrixId;
  29323. private _cachedURotationCenter;
  29324. private _cachedVRotationCenter;
  29325. private _cachedWRotationCenter;
  29326. private _cachedHomogeneousRotationInUVTransform;
  29327. private _cachedCoordinatesMode;
  29328. /** @hidden */
  29329. protected _initialSamplingMode: number;
  29330. /** @hidden */
  29331. _buffer: Nullable<string | ArrayBuffer | ArrayBufferView | HTMLImageElement | Blob | ImageBitmap>;
  29332. private _deleteBuffer;
  29333. protected _format: Nullable<number>;
  29334. private _delayedOnLoad;
  29335. private _delayedOnError;
  29336. private _mimeType?;
  29337. /** Returns the texture mime type if it was defined by a loader (undefined else) */
  29338. get mimeType(): string | undefined;
  29339. /**
  29340. * Observable triggered once the texture has been loaded.
  29341. */
  29342. onLoadObservable: Observable<Texture>;
  29343. protected _isBlocking: boolean;
  29344. /**
  29345. * Is the texture preventing material to render while loading.
  29346. * If false, a default texture will be used instead of the loading one during the preparation step.
  29347. */
  29348. set isBlocking(value: boolean);
  29349. get isBlocking(): boolean;
  29350. /**
  29351. * Get the current sampling mode associated with the texture.
  29352. */
  29353. get samplingMode(): number;
  29354. /**
  29355. * Gets a boolean indicating if the texture needs to be inverted on the y axis during loading
  29356. */
  29357. get invertY(): boolean;
  29358. /**
  29359. * Instantiates a new texture.
  29360. * This represents a texture in babylon. It can be easily loaded from a network, base64 or html input.
  29361. * @see https://doc.babylonjs.com/babylon101/materials#texture
  29362. * @param url defines the url of the picture to load as a texture
  29363. * @param sceneOrEngine defines the scene or engine the texture will belong to
  29364. * @param noMipmap defines if the texture will require mip maps or not
  29365. * @param invertY defines if the texture needs to be inverted on the y axis during loading
  29366. * @param samplingMode defines the sampling mode we want for the texture while fectching from it (Texture.NEAREST_SAMPLINGMODE...)
  29367. * @param onLoad defines a callback triggered when the texture has been loaded
  29368. * @param onError defines a callback triggered when an error occurred during the loading session
  29369. * @param buffer defines the buffer to load the texture from in case the texture is loaded from a buffer representation
  29370. * @param deleteBuffer defines if the buffer we are loading the texture from should be deleted after load
  29371. * @param format defines the format of the texture we are trying to load (Engine.TEXTUREFORMAT_RGBA...)
  29372. * @param mimeType defines an optional mime type information
  29373. */
  29374. 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);
  29375. /**
  29376. * Update the url (and optional buffer) of this texture if url was null during construction.
  29377. * @param url the url of the texture
  29378. * @param buffer the buffer of the texture (defaults to null)
  29379. * @param onLoad callback called when the texture is loaded (defaults to null)
  29380. */
  29381. updateURL(url: string, buffer?: Nullable<string | ArrayBuffer | ArrayBufferView | HTMLImageElement | Blob>, onLoad?: () => void): void;
  29382. /**
  29383. * Finish the loading sequence of a texture flagged as delayed load.
  29384. * @hidden
  29385. */
  29386. delayLoad(): void;
  29387. private _prepareRowForTextureGeneration;
  29388. /**
  29389. * Checks if the texture has the same transform matrix than another texture
  29390. * @param texture texture to check against
  29391. * @returns true if the transforms are the same, else false
  29392. */
  29393. checkTransformsAreIdentical(texture: Nullable<Texture>): boolean;
  29394. /**
  29395. * Get the current texture matrix which includes the requested offsetting, tiling and rotation components.
  29396. * @returns the transform matrix of the texture.
  29397. */
  29398. getTextureMatrix(uBase?: number): Matrix;
  29399. /**
  29400. * Get the current matrix used to apply reflection. This is useful to rotate an environment texture for instance.
  29401. * @returns The reflection texture transform
  29402. */
  29403. getReflectionTextureMatrix(): Matrix;
  29404. /**
  29405. * Clones the texture.
  29406. * @returns the cloned texture
  29407. */
  29408. clone(): Texture;
  29409. /**
  29410. * Serialize the texture to a JSON representation we can easily use in the resepective Parse function.
  29411. * @returns The JSON representation of the texture
  29412. */
  29413. serialize(): any;
  29414. /**
  29415. * Get the current class name of the texture useful for serialization or dynamic coding.
  29416. * @returns "Texture"
  29417. */
  29418. getClassName(): string;
  29419. /**
  29420. * Dispose the texture and release its associated resources.
  29421. */
  29422. dispose(): void;
  29423. /**
  29424. * Parse the JSON representation of a texture in order to recreate the texture in the given scene.
  29425. * @param parsedTexture Define the JSON representation of the texture
  29426. * @param scene Define the scene the parsed texture should be instantiated in
  29427. * @param rootUrl Define the root url of the parsing sequence in the case of relative dependencies
  29428. * @returns The parsed texture if successful
  29429. */
  29430. static Parse(parsedTexture: any, scene: Scene, rootUrl: string): Nullable<BaseTexture>;
  29431. /**
  29432. * Creates a texture from its base 64 representation.
  29433. * @param data Define the base64 payload without the data: prefix
  29434. * @param name Define the name of the texture in the scene useful fo caching purpose for instance
  29435. * @param scene Define the scene the texture should belong to
  29436. * @param noMipmap Forces the texture to not create mip map information if true
  29437. * @param invertY define if the texture needs to be inverted on the y axis during loading
  29438. * @param samplingMode define the sampling mode we want for the texture while fectching from it (Texture.NEAREST_SAMPLINGMODE...)
  29439. * @param onLoad define a callback triggered when the texture has been loaded
  29440. * @param onError define a callback triggered when an error occurred during the loading session
  29441. * @param format define the format of the texture we are trying to load (Engine.TEXTUREFORMAT_RGBA...)
  29442. * @returns the created texture
  29443. */
  29444. static CreateFromBase64String(data: string, name: string, scene: Scene, noMipmap?: boolean, invertY?: boolean, samplingMode?: number, onLoad?: Nullable<() => void>, onError?: Nullable<() => void>, format?: number): Texture;
  29445. /**
  29446. * Creates a texture from its data: representation. (data: will be added in case only the payload has been passed in)
  29447. * @param data Define the base64 payload without the data: prefix
  29448. * @param name Define the name of the texture in the scene useful fo caching purpose for instance
  29449. * @param buffer define the buffer to load the texture from in case the texture is loaded from a buffer representation
  29450. * @param scene Define the scene the texture should belong to
  29451. * @param deleteBuffer define if the buffer we are loading the texture from should be deleted after load
  29452. * @param noMipmap Forces the texture to not create mip map information if true
  29453. * @param invertY define if the texture needs to be inverted on the y axis during loading
  29454. * @param samplingMode define the sampling mode we want for the texture while fectching from it (Texture.NEAREST_SAMPLINGMODE...)
  29455. * @param onLoad define a callback triggered when the texture has been loaded
  29456. * @param onError define a callback triggered when an error occurred during the loading session
  29457. * @param format define the format of the texture we are trying to load (Engine.TEXTUREFORMAT_RGBA...)
  29458. * @returns the created texture
  29459. */
  29460. 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;
  29461. }
  29462. }
  29463. declare module "babylonjs/PostProcesses/postProcessManager" {
  29464. import { Nullable } from "babylonjs/types";
  29465. import { InternalTexture } from "babylonjs/Materials/Textures/internalTexture";
  29466. import { PostProcess } from "babylonjs/PostProcesses/postProcess";
  29467. import { Scene } from "babylonjs/scene";
  29468. /**
  29469. * PostProcessManager is used to manage one or more post processes or post process pipelines
  29470. * See https://doc.babylonjs.com/how_to/how_to_use_postprocesses
  29471. */
  29472. export class PostProcessManager {
  29473. private _scene;
  29474. private _indexBuffer;
  29475. private _vertexBuffers;
  29476. /**
  29477. * Creates a new instance PostProcess
  29478. * @param scene The scene that the post process is associated with.
  29479. */
  29480. constructor(scene: Scene);
  29481. private _prepareBuffers;
  29482. private _buildIndexBuffer;
  29483. /**
  29484. * Rebuilds the vertex buffers of the manager.
  29485. * @hidden
  29486. */
  29487. _rebuild(): void;
  29488. /**
  29489. * Prepares a frame to be run through a post process.
  29490. * @param sourceTexture The input texture to the post procesess. (default: null)
  29491. * @param postProcesses An array of post processes to be run. (default: null)
  29492. * @returns True if the post processes were able to be run.
  29493. * @hidden
  29494. */
  29495. _prepareFrame(sourceTexture?: Nullable<InternalTexture>, postProcesses?: Nullable<PostProcess[]>): boolean;
  29496. /**
  29497. * Manually render a set of post processes to a texture.
  29498. * Please note, the frame buffer won't be unbound after the call in case you have more render to do.
  29499. * @param postProcesses An array of post processes to be run.
  29500. * @param targetTexture The target texture to render to.
  29501. * @param forceFullscreenViewport force gl.viewport to be full screen eg. 0,0,textureWidth,textureHeight
  29502. * @param faceIndex defines the face to render to if a cubemap is defined as the target
  29503. * @param lodLevel defines which lod of the texture to render to
  29504. * @param doNotBindFrambuffer If set to true, assumes that the framebuffer has been bound previously
  29505. */
  29506. directRender(postProcesses: PostProcess[], targetTexture?: Nullable<InternalTexture>, forceFullscreenViewport?: boolean, faceIndex?: number, lodLevel?: number, doNotBindFrambuffer?: boolean): void;
  29507. /**
  29508. * Finalize the result of the output of the postprocesses.
  29509. * @param doNotPresent If true the result will not be displayed to the screen.
  29510. * @param targetTexture The target texture to render to.
  29511. * @param faceIndex The index of the face to bind the target texture to.
  29512. * @param postProcesses The array of post processes to render.
  29513. * @param forceFullscreenViewport force gl.viewport to be full screen eg. 0,0,textureWidth,textureHeight (default: false)
  29514. * @hidden
  29515. */
  29516. _finalizeFrame(doNotPresent?: boolean, targetTexture?: InternalTexture, faceIndex?: number, postProcesses?: Array<PostProcess>, forceFullscreenViewport?: boolean): void;
  29517. /**
  29518. * Disposes of the post process manager.
  29519. */
  29520. dispose(): void;
  29521. }
  29522. }
  29523. declare module "babylonjs/Materials/Textures/renderTargetTexture" {
  29524. import { Observable } from "babylonjs/Misc/observable";
  29525. import { SmartArray } from "babylonjs/Misc/smartArray";
  29526. import { Nullable, Immutable } from "babylonjs/types";
  29527. import { Camera } from "babylonjs/Cameras/camera";
  29528. import { Scene } from "babylonjs/scene";
  29529. import { Matrix, Vector3 } from "babylonjs/Maths/math.vector";
  29530. import { Color4 } from "babylonjs/Maths/math.color";
  29531. import { RenderTargetCreationOptions } from "babylonjs/Materials/Textures/renderTargetCreationOptions";
  29532. import { AbstractMesh } from "babylonjs/Meshes/abstractMesh";
  29533. import { SubMesh } from "babylonjs/Meshes/subMesh";
  29534. import { InternalTexture } from "babylonjs/Materials/Textures/internalTexture";
  29535. import { Texture } from "babylonjs/Materials/Textures/texture";
  29536. import { PostProcess } from "babylonjs/PostProcesses/postProcess";
  29537. import { RenderingManager } from "babylonjs/Rendering/renderingManager";
  29538. import "babylonjs/Engines/Extensions/engine.renderTarget";
  29539. import "babylonjs/Engines/Extensions/engine.renderTargetCube";
  29540. import { Engine } from "babylonjs/Engines/engine";
  29541. /**
  29542. * This Helps creating a texture that will be created from a camera in your scene.
  29543. * It is basically a dynamic texture that could be used to create special effects for instance.
  29544. * Actually, It is the base of lot of effects in the framework like post process, shadows, effect layers and rendering pipelines...
  29545. */
  29546. export class RenderTargetTexture extends Texture {
  29547. /**
  29548. * The texture will only be rendered once which can be useful to improve performance if everything in your render is static for instance.
  29549. */
  29550. static readonly REFRESHRATE_RENDER_ONCE: number;
  29551. /**
  29552. * The texture will only be rendered rendered every frame and is recomended for dynamic contents.
  29553. */
  29554. static readonly REFRESHRATE_RENDER_ONEVERYFRAME: number;
  29555. /**
  29556. * The texture will be rendered every 2 frames which could be enough if your dynamic objects are not
  29557. * the central point of your effect and can save a lot of performances.
  29558. */
  29559. static readonly REFRESHRATE_RENDER_ONEVERYTWOFRAMES: number;
  29560. /**
  29561. * Use this predicate to dynamically define the list of mesh you want to render.
  29562. * If set, the renderList property will be overwritten.
  29563. */
  29564. renderListPredicate: (AbstractMesh: AbstractMesh) => boolean;
  29565. private _renderList;
  29566. /**
  29567. * Use this list to define the list of mesh you want to render.
  29568. */
  29569. get renderList(): Nullable<Array<AbstractMesh>>;
  29570. set renderList(value: Nullable<Array<AbstractMesh>>);
  29571. /**
  29572. * Use this function to overload the renderList array at rendering time.
  29573. * Return null to render with the curent renderList, else return the list of meshes to use for rendering.
  29574. * For 2DArray RTT, layerOrFace is the index of the layer that is going to be rendered, else it is the faceIndex of
  29575. * the cube (if the RTT is a cube, else layerOrFace=0).
  29576. * The renderList passed to the function is the current render list (the one that will be used if the function returns null).
  29577. * The length of this list is passed through renderListLength: don't use renderList.length directly because the array can
  29578. * hold dummy elements!
  29579. */
  29580. getCustomRenderList: (layerOrFace: number, renderList: Nullable<Immutable<Array<AbstractMesh>>>, renderListLength: number) => Nullable<Array<AbstractMesh>>;
  29581. private _hookArray;
  29582. /**
  29583. * Define if particles should be rendered in your texture.
  29584. */
  29585. renderParticles: boolean;
  29586. /**
  29587. * Define if sprites should be rendered in your texture.
  29588. */
  29589. renderSprites: boolean;
  29590. /**
  29591. * Define the camera used to render the texture.
  29592. */
  29593. activeCamera: Nullable<Camera>;
  29594. /**
  29595. * Override the mesh isReady function with your own one.
  29596. */
  29597. customIsReadyFunction: (mesh: AbstractMesh, refreshRate: number) => boolean;
  29598. /**
  29599. * Override the render function of the texture with your own one.
  29600. */
  29601. customRenderFunction: (opaqueSubMeshes: SmartArray<SubMesh>, alphaTestSubMeshes: SmartArray<SubMesh>, transparentSubMeshes: SmartArray<SubMesh>, depthOnlySubMeshes: SmartArray<SubMesh>, beforeTransparents?: () => void) => void;
  29602. /**
  29603. * Define if camera post processes should be use while rendering the texture.
  29604. */
  29605. useCameraPostProcesses: boolean;
  29606. /**
  29607. * Define if the camera viewport should be respected while rendering the texture or if the render should be done to the entire texture.
  29608. */
  29609. ignoreCameraViewport: boolean;
  29610. private _postProcessManager;
  29611. private _postProcesses;
  29612. private _resizeObserver;
  29613. /**
  29614. * An event triggered when the texture is unbind.
  29615. */
  29616. onBeforeBindObservable: Observable<RenderTargetTexture>;
  29617. /**
  29618. * An event triggered when the texture is unbind.
  29619. */
  29620. onAfterUnbindObservable: Observable<RenderTargetTexture>;
  29621. private _onAfterUnbindObserver;
  29622. /**
  29623. * Set a after unbind callback in the texture.
  29624. * This has been kept for backward compatibility and use of onAfterUnbindObservable is recommended.
  29625. */
  29626. set onAfterUnbind(callback: () => void);
  29627. /**
  29628. * An event triggered before rendering the texture
  29629. */
  29630. onBeforeRenderObservable: Observable<number>;
  29631. private _onBeforeRenderObserver;
  29632. /**
  29633. * Set a before render callback in the texture.
  29634. * This has been kept for backward compatibility and use of onBeforeRenderObservable is recommended.
  29635. */
  29636. set onBeforeRender(callback: (faceIndex: number) => void);
  29637. /**
  29638. * An event triggered after rendering the texture
  29639. */
  29640. onAfterRenderObservable: Observable<number>;
  29641. private _onAfterRenderObserver;
  29642. /**
  29643. * Set a after render callback in the texture.
  29644. * This has been kept for backward compatibility and use of onAfterRenderObservable is recommended.
  29645. */
  29646. set onAfterRender(callback: (faceIndex: number) => void);
  29647. /**
  29648. * An event triggered after the texture clear
  29649. */
  29650. onClearObservable: Observable<Engine>;
  29651. private _onClearObserver;
  29652. /**
  29653. * Set a clear callback in the texture.
  29654. * This has been kept for backward compatibility and use of onClearObservable is recommended.
  29655. */
  29656. set onClear(callback: (Engine: Engine) => void);
  29657. /**
  29658. * An event triggered when the texture is resized.
  29659. */
  29660. onResizeObservable: Observable<RenderTargetTexture>;
  29661. /**
  29662. * Define the clear color of the Render Target if it should be different from the scene.
  29663. */
  29664. clearColor: Color4;
  29665. protected _size: number | {
  29666. width: number;
  29667. height: number;
  29668. layers?: number;
  29669. };
  29670. protected _initialSizeParameter: number | {
  29671. width: number;
  29672. height: number;
  29673. } | {
  29674. ratio: number;
  29675. };
  29676. protected _sizeRatio: Nullable<number>;
  29677. /** @hidden */
  29678. _generateMipMaps: boolean;
  29679. protected _renderingManager: RenderingManager;
  29680. /** @hidden */
  29681. _waitingRenderList?: string[];
  29682. protected _doNotChangeAspectRatio: boolean;
  29683. protected _currentRefreshId: number;
  29684. protected _refreshRate: number;
  29685. protected _textureMatrix: Matrix;
  29686. protected _samples: number;
  29687. protected _renderTargetOptions: RenderTargetCreationOptions;
  29688. /**
  29689. * Gets render target creation options that were used.
  29690. */
  29691. get renderTargetOptions(): RenderTargetCreationOptions;
  29692. protected _onRatioRescale(): void;
  29693. /**
  29694. * Gets or sets the center of the bounding box associated with the texture (when in cube mode)
  29695. * It must define where the camera used to render the texture is set
  29696. */
  29697. boundingBoxPosition: Vector3;
  29698. private _boundingBoxSize;
  29699. /**
  29700. * Gets or sets the size of the bounding box associated with the texture (when in cube mode)
  29701. * When defined, the cubemap will switch to local mode
  29702. * @see https://community.arm.com/graphics/b/blog/posts/reflections-based-on-local-cubemaps-in-unity
  29703. * @example https://www.babylonjs-playground.com/#RNASML
  29704. */
  29705. set boundingBoxSize(value: Vector3);
  29706. get boundingBoxSize(): Vector3;
  29707. /**
  29708. * In case the RTT has been created with a depth texture, get the associated
  29709. * depth texture.
  29710. * Otherwise, return null.
  29711. */
  29712. get depthStencilTexture(): Nullable<InternalTexture>;
  29713. /**
  29714. * Instantiate a render target texture. This is mainly used to render of screen the scene to for instance apply post processse
  29715. * or used a shadow, depth texture...
  29716. * @param name The friendly name of the texture
  29717. * @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)
  29718. * @param scene The scene the RTT belongs to. The latest created scene will be used if not precised.
  29719. * @param generateMipMaps True if mip maps need to be generated after render.
  29720. * @param doNotChangeAspectRatio True to not change the aspect ratio of the scene in the RTT
  29721. * @param type The type of the buffer in the RTT (int, half float, float...)
  29722. * @param isCube True if a cube texture needs to be created
  29723. * @param samplingMode The sampling mode to be usedwith the render target (Linear, Nearest...)
  29724. * @param generateDepthBuffer True to generate a depth buffer
  29725. * @param generateStencilBuffer True to generate a stencil buffer
  29726. * @param isMulti True if multiple textures need to be created (Draw Buffers)
  29727. * @param format The internal format of the buffer in the RTT (RED, RG, RGB, RGBA, ALPHA...)
  29728. * @param delayAllocation if the texture allocation should be delayed (default: false)
  29729. */
  29730. constructor(name: string, size: number | {
  29731. width: number;
  29732. height: number;
  29733. layers?: number;
  29734. } | {
  29735. ratio: number;
  29736. }, scene: Nullable<Scene>, generateMipMaps?: boolean, doNotChangeAspectRatio?: boolean, type?: number, isCube?: boolean, samplingMode?: number, generateDepthBuffer?: boolean, generateStencilBuffer?: boolean, isMulti?: boolean, format?: number, delayAllocation?: boolean);
  29737. /**
  29738. * Creates a depth stencil texture.
  29739. * This is only available in WebGL 2 or with the depth texture extension available.
  29740. * @param comparisonFunction Specifies the comparison function to set on the texture. If 0 or undefined, the texture is not in comparison mode
  29741. * @param bilinearFiltering Specifies whether or not bilinear filtering is enable on the texture
  29742. * @param generateStencil Specifies whether or not a stencil should be allocated in the texture
  29743. */
  29744. createDepthStencilTexture(comparisonFunction?: number, bilinearFiltering?: boolean, generateStencil?: boolean): void;
  29745. private _processSizeParameter;
  29746. /**
  29747. * Define the number of samples to use in case of MSAA.
  29748. * It defaults to one meaning no MSAA has been enabled.
  29749. */
  29750. get samples(): number;
  29751. set samples(value: number);
  29752. /**
  29753. * Resets the refresh counter of the texture and start bak from scratch.
  29754. * Could be useful to regenerate the texture if it is setup to render only once.
  29755. */
  29756. resetRefreshCounter(): void;
  29757. /**
  29758. * Define the refresh rate of the texture or the rendering frequency.
  29759. * Use 0 to render just once, 1 to render on every frame, 2 to render every two frames and so on...
  29760. */
  29761. get refreshRate(): number;
  29762. set refreshRate(value: number);
  29763. /**
  29764. * Adds a post process to the render target rendering passes.
  29765. * @param postProcess define the post process to add
  29766. */
  29767. addPostProcess(postProcess: PostProcess): void;
  29768. /**
  29769. * Clear all the post processes attached to the render target
  29770. * @param dispose define if the cleared post processesshould also be disposed (false by default)
  29771. */
  29772. clearPostProcesses(dispose?: boolean): void;
  29773. /**
  29774. * Remove one of the post process from the list of attached post processes to the texture
  29775. * @param postProcess define the post process to remove from the list
  29776. */
  29777. removePostProcess(postProcess: PostProcess): void;
  29778. /** @hidden */
  29779. _shouldRender(): boolean;
  29780. /**
  29781. * Gets the actual render size of the texture.
  29782. * @returns the width of the render size
  29783. */
  29784. getRenderSize(): number;
  29785. /**
  29786. * Gets the actual render width of the texture.
  29787. * @returns the width of the render size
  29788. */
  29789. getRenderWidth(): number;
  29790. /**
  29791. * Gets the actual render height of the texture.
  29792. * @returns the height of the render size
  29793. */
  29794. getRenderHeight(): number;
  29795. /**
  29796. * Gets the actual number of layers of the texture.
  29797. * @returns the number of layers
  29798. */
  29799. getRenderLayers(): number;
  29800. /**
  29801. * Get if the texture can be rescaled or not.
  29802. */
  29803. get canRescale(): boolean;
  29804. /**
  29805. * Resize the texture using a ratio.
  29806. * @param ratio the ratio to apply to the texture size in order to compute the new target size
  29807. */
  29808. scale(ratio: number): void;
  29809. /**
  29810. * Get the texture reflection matrix used to rotate/transform the reflection.
  29811. * @returns the reflection matrix
  29812. */
  29813. getReflectionTextureMatrix(): Matrix;
  29814. /**
  29815. * Resize the texture to a new desired size.
  29816. * Be carrefull as it will recreate all the data in the new texture.
  29817. * @param size Define the new size. It can be:
  29818. * - a number for squared texture,
  29819. * - an object containing { width: number, height: number }
  29820. * - or an object containing a ratio { ratio: number }
  29821. */
  29822. resize(size: number | {
  29823. width: number;
  29824. height: number;
  29825. } | {
  29826. ratio: number;
  29827. }): void;
  29828. private _defaultRenderListPrepared;
  29829. /**
  29830. * Renders all the objects from the render list into the texture.
  29831. * @param useCameraPostProcess Define if camera post processes should be used during the rendering
  29832. * @param dumpForDebug Define if the rendering result should be dumped (copied) for debugging purpose
  29833. */
  29834. render(useCameraPostProcess?: boolean, dumpForDebug?: boolean): void;
  29835. private _bestReflectionRenderTargetDimension;
  29836. private _prepareRenderingManager;
  29837. /**
  29838. * @hidden
  29839. * @param faceIndex face index to bind to if this is a cubetexture
  29840. * @param layer defines the index of the texture to bind in the array
  29841. */
  29842. _bindFrameBuffer(faceIndex?: number, layer?: number): void;
  29843. protected unbindFrameBuffer(engine: Engine, faceIndex: number): void;
  29844. private renderToTarget;
  29845. /**
  29846. * Overrides the default sort function applied in the renderging group to prepare the meshes.
  29847. * This allowed control for front to back rendering or reversly depending of the special needs.
  29848. *
  29849. * @param renderingGroupId The rendering group id corresponding to its index
  29850. * @param opaqueSortCompareFn The opaque queue comparison function use to sort.
  29851. * @param alphaTestSortCompareFn The alpha test queue comparison function use to sort.
  29852. * @param transparentSortCompareFn The transparent queue comparison function use to sort.
  29853. */
  29854. 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;
  29855. /**
  29856. * Specifies whether or not the stencil and depth buffer are cleared between two rendering groups.
  29857. *
  29858. * @param renderingGroupId The rendering group id corresponding to its index
  29859. * @param autoClearDepthStencil Automatically clears depth and stencil between groups if true.
  29860. */
  29861. setRenderingAutoClearDepthStencil(renderingGroupId: number, autoClearDepthStencil: boolean): void;
  29862. /**
  29863. * Clones the texture.
  29864. * @returns the cloned texture
  29865. */
  29866. clone(): RenderTargetTexture;
  29867. /**
  29868. * Serialize the texture to a JSON representation we can easily use in the resepective Parse function.
  29869. * @returns The JSON representation of the texture
  29870. */
  29871. serialize(): any;
  29872. /**
  29873. * This will remove the attached framebuffer objects. The texture will not be able to be used as render target anymore
  29874. */
  29875. disposeFramebufferObjects(): void;
  29876. /**
  29877. * Dispose the texture and release its associated resources.
  29878. */
  29879. dispose(): void;
  29880. /** @hidden */
  29881. _rebuild(): void;
  29882. /**
  29883. * Clear the info related to rendering groups preventing retention point in material dispose.
  29884. */
  29885. freeRenderingGroups(): void;
  29886. /**
  29887. * Gets the number of views the corresponding to the texture (eg. a MultiviewRenderTarget will have > 1)
  29888. * @returns the view count
  29889. */
  29890. getViewCount(): number;
  29891. }
  29892. }
  29893. declare module "babylonjs/Misc/guid" {
  29894. /**
  29895. * Class used to manipulate GUIDs
  29896. */
  29897. export class GUID {
  29898. /**
  29899. * Implementation from http://stackoverflow.com/questions/105034/how-to-create-a-guid-uuid-in-javascript/2117523#answer-2117523
  29900. * Be aware Math.random() could cause collisions, but:
  29901. * "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"
  29902. * @returns a pseudo random id
  29903. */
  29904. static RandomId(): string;
  29905. }
  29906. }
  29907. declare module "babylonjs/Materials/shadowDepthWrapper" {
  29908. import { Nullable } from "babylonjs/types";
  29909. import { Scene } from "babylonjs/scene";
  29910. import { SubMesh } from "babylonjs/Meshes/subMesh";
  29911. import { Material } from "babylonjs/Materials/material";
  29912. import { Effect } from "babylonjs/Materials/effect";
  29913. import { ShadowGenerator } from "babylonjs/Lights/Shadows/shadowGenerator";
  29914. /**
  29915. * Options to be used when creating a shadow depth material
  29916. */
  29917. export interface IIOptionShadowDepthMaterial {
  29918. /** Variables in the vertex shader code that need to have their names remapped.
  29919. * The format is: ["var_name", "var_remapped_name", "var_name", "var_remapped_name", ...]
  29920. * "var_name" should be either: worldPos or vNormalW
  29921. * So, if the variable holding the world position in your vertex shader is not named worldPos, you must tell the system
  29922. * the name to use instead by using: ["worldPos", "myWorldPosVar"] assuming the variable is named myWorldPosVar in your code.
  29923. * If the normal must also be remapped: ["worldPos", "myWorldPosVar", "vNormalW", "myWorldNormal"]
  29924. */
  29925. remappedVariables?: string[];
  29926. /** Set standalone to true if the base material wrapped by ShadowDepthMaterial is not used for a regular object but for depth shadow generation only */
  29927. standalone?: boolean;
  29928. }
  29929. /**
  29930. * Class that can be used to wrap a base material to generate accurate shadows when using custom vertex/fragment code in the base material
  29931. */
  29932. export class ShadowDepthWrapper {
  29933. private _scene;
  29934. private _options?;
  29935. private _baseMaterial;
  29936. private _onEffectCreatedObserver;
  29937. private _subMeshToEffect;
  29938. private _subMeshToDepthEffect;
  29939. private _meshes;
  29940. /** @hidden */
  29941. _matriceNames: any;
  29942. /** Gets the standalone status of the wrapper */
  29943. get standalone(): boolean;
  29944. /** Gets the base material the wrapper is built upon */
  29945. get baseMaterial(): Material;
  29946. /**
  29947. * Instantiate a new shadow depth wrapper.
  29948. * It works by injecting some specific code in the vertex/fragment shaders of the base material and is used by a shadow generator to
  29949. * generate the shadow depth map. For more information, please refer to the documentation:
  29950. * https://doc.babylonjs.com/babylon101/shadows
  29951. * @param baseMaterial Material to wrap
  29952. * @param scene Define the scene the material belongs to
  29953. * @param options Options used to create the wrapper
  29954. */
  29955. constructor(baseMaterial: Material, scene: Scene, options?: IIOptionShadowDepthMaterial);
  29956. /**
  29957. * Gets the effect to use to generate the depth map
  29958. * @param subMesh subMesh to get the effect for
  29959. * @param shadowGenerator shadow generator to get the effect for
  29960. * @returns the effect to use to generate the depth map for the subMesh + shadow generator specified
  29961. */
  29962. getEffect(subMesh: Nullable<SubMesh>, shadowGenerator: ShadowGenerator): Nullable<Effect>;
  29963. /**
  29964. * Specifies that the submesh is ready to be used for depth rendering
  29965. * @param subMesh submesh to check
  29966. * @param defines the list of defines to take into account when checking the effect
  29967. * @param shadowGenerator combined with subMesh, it defines the effect to check
  29968. * @param useInstances specifies that instances should be used
  29969. * @returns a boolean indicating that the submesh is ready or not
  29970. */
  29971. isReadyForSubMesh(subMesh: SubMesh, defines: string[], shadowGenerator: ShadowGenerator, useInstances: boolean): boolean;
  29972. /**
  29973. * Disposes the resources
  29974. */
  29975. dispose(): void;
  29976. private _makeEffect;
  29977. }
  29978. }
  29979. declare module "babylonjs/Materials/material" {
  29980. import { IAnimatable } from "babylonjs/Animations/animatable.interface";
  29981. import { SmartArray } from "babylonjs/Misc/smartArray";
  29982. import { Observable } from "babylonjs/Misc/observable";
  29983. import { Nullable } from "babylonjs/types";
  29984. import { Scene } from "babylonjs/scene";
  29985. import { Matrix } from "babylonjs/Maths/math.vector";
  29986. import { SubMesh } from "babylonjs/Meshes/subMesh";
  29987. import { AbstractMesh } from "babylonjs/Meshes/abstractMesh";
  29988. import { UniformBuffer } from "babylonjs/Materials/uniformBuffer";
  29989. import { Effect } from "babylonjs/Materials/effect";
  29990. import { BaseTexture } from "babylonjs/Materials/Textures/baseTexture";
  29991. import { RenderTargetTexture } from "babylonjs/Materials/Textures/renderTargetTexture";
  29992. import { MaterialDefines } from "babylonjs/Materials/materialDefines";
  29993. import { IInspectable } from "babylonjs/Misc/iInspectable";
  29994. import { ShadowDepthWrapper } from "babylonjs/Materials/shadowDepthWrapper";
  29995. import { PrePassRenderer } from "babylonjs/Rendering/prePassRenderer";
  29996. import { Mesh } from "babylonjs/Meshes/mesh";
  29997. import { Animation } from "babylonjs/Animations/animation";
  29998. /**
  29999. * Options for compiling materials.
  30000. */
  30001. export interface IMaterialCompilationOptions {
  30002. /**
  30003. * Defines whether clip planes are enabled.
  30004. */
  30005. clipPlane: boolean;
  30006. /**
  30007. * Defines whether instances are enabled.
  30008. */
  30009. useInstances: boolean;
  30010. }
  30011. /**
  30012. * Options passed when calling customShaderNameResolve
  30013. */
  30014. export interface ICustomShaderNameResolveOptions {
  30015. /**
  30016. * 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
  30017. */
  30018. processFinalCode?: Nullable<(shaderType: string, code: string) => string>;
  30019. }
  30020. /**
  30021. * Base class for the main features of a material in Babylon.js
  30022. */
  30023. export class Material implements IAnimatable {
  30024. /**
  30025. * Returns the triangle fill mode
  30026. */
  30027. static readonly TriangleFillMode: number;
  30028. /**
  30029. * Returns the wireframe mode
  30030. */
  30031. static readonly WireFrameFillMode: number;
  30032. /**
  30033. * Returns the point fill mode
  30034. */
  30035. static readonly PointFillMode: number;
  30036. /**
  30037. * Returns the point list draw mode
  30038. */
  30039. static readonly PointListDrawMode: number;
  30040. /**
  30041. * Returns the line list draw mode
  30042. */
  30043. static readonly LineListDrawMode: number;
  30044. /**
  30045. * Returns the line loop draw mode
  30046. */
  30047. static readonly LineLoopDrawMode: number;
  30048. /**
  30049. * Returns the line strip draw mode
  30050. */
  30051. static readonly LineStripDrawMode: number;
  30052. /**
  30053. * Returns the triangle strip draw mode
  30054. */
  30055. static readonly TriangleStripDrawMode: number;
  30056. /**
  30057. * Returns the triangle fan draw mode
  30058. */
  30059. static readonly TriangleFanDrawMode: number;
  30060. /**
  30061. * Stores the clock-wise side orientation
  30062. */
  30063. static readonly ClockWiseSideOrientation: number;
  30064. /**
  30065. * Stores the counter clock-wise side orientation
  30066. */
  30067. static readonly CounterClockWiseSideOrientation: number;
  30068. /**
  30069. * The dirty texture flag value
  30070. */
  30071. static readonly TextureDirtyFlag: number;
  30072. /**
  30073. * The dirty light flag value
  30074. */
  30075. static readonly LightDirtyFlag: number;
  30076. /**
  30077. * The dirty fresnel flag value
  30078. */
  30079. static readonly FresnelDirtyFlag: number;
  30080. /**
  30081. * The dirty attribute flag value
  30082. */
  30083. static readonly AttributesDirtyFlag: number;
  30084. /**
  30085. * The dirty misc flag value
  30086. */
  30087. static readonly MiscDirtyFlag: number;
  30088. /**
  30089. * The dirty prepass flag value
  30090. */
  30091. static readonly PrePassDirtyFlag: number;
  30092. /**
  30093. * The all dirty flag value
  30094. */
  30095. static readonly AllDirtyFlag: number;
  30096. /**
  30097. * MaterialTransparencyMode: No transparency mode, Alpha channel is not use.
  30098. */
  30099. static readonly MATERIAL_OPAQUE: number;
  30100. /**
  30101. * MaterialTransparencyMode: Alpha Test mode, pixel are discarded below a certain threshold defined by the alpha cutoff value.
  30102. */
  30103. static readonly MATERIAL_ALPHATEST: number;
  30104. /**
  30105. * MaterialTransparencyMode: Pixels are blended (according to the alpha mode) with the already drawn pixels in the current frame buffer.
  30106. */
  30107. static readonly MATERIAL_ALPHABLEND: number;
  30108. /**
  30109. * MaterialTransparencyMode: Pixels are blended (according to the alpha mode) with the already drawn pixels in the current frame buffer.
  30110. * They are also discarded below the alpha cutoff threshold to improve performances.
  30111. */
  30112. static readonly MATERIAL_ALPHATESTANDBLEND: number;
  30113. /**
  30114. * The Whiteout method is used to blend normals.
  30115. * Details of the algorithm can be found here: https://blog.selfshadow.com/publications/blending-in-detail/
  30116. */
  30117. static readonly MATERIAL_NORMALBLENDMETHOD_WHITEOUT: number;
  30118. /**
  30119. * The Reoriented Normal Mapping method is used to blend normals.
  30120. * Details of the algorithm can be found here: https://blog.selfshadow.com/publications/blending-in-detail/
  30121. */
  30122. static readonly MATERIAL_NORMALBLENDMETHOD_RNM: number;
  30123. /**
  30124. * Custom callback helping to override the default shader used in the material.
  30125. */
  30126. customShaderNameResolve: (shaderName: string, uniforms: string[], uniformBuffers: string[], samplers: string[], defines: MaterialDefines | string[], attributes?: string[], options?: ICustomShaderNameResolveOptions) => string;
  30127. /**
  30128. * Custom shadow depth material to use for shadow rendering instead of the in-built one
  30129. */
  30130. shadowDepthWrapper: Nullable<ShadowDepthWrapper>;
  30131. /**
  30132. * Gets or sets a boolean indicating that the material is allowed (if supported) to do shader hot swapping.
  30133. * This means that the material can keep using a previous shader while a new one is being compiled.
  30134. * This is mostly used when shader parallel compilation is supported (true by default)
  30135. */
  30136. allowShaderHotSwapping: boolean;
  30137. /**
  30138. * The ID of the material
  30139. */
  30140. id: string;
  30141. /**
  30142. * Gets or sets the unique id of the material
  30143. */
  30144. uniqueId: number;
  30145. /**
  30146. * The name of the material
  30147. */
  30148. name: string;
  30149. /**
  30150. * Gets or sets user defined metadata
  30151. */
  30152. metadata: any;
  30153. /**
  30154. * For internal use only. Please do not use.
  30155. */
  30156. reservedDataStore: any;
  30157. /**
  30158. * Specifies if the ready state should be checked on each call
  30159. */
  30160. checkReadyOnEveryCall: boolean;
  30161. /**
  30162. * Specifies if the ready state should be checked once
  30163. */
  30164. checkReadyOnlyOnce: boolean;
  30165. /**
  30166. * The state of the material
  30167. */
  30168. state: string;
  30169. /**
  30170. * If the material can be rendered to several textures with MRT extension
  30171. */
  30172. get canRenderToMRT(): boolean;
  30173. /**
  30174. * The alpha value of the material
  30175. */
  30176. protected _alpha: number;
  30177. /**
  30178. * List of inspectable custom properties (used by the Inspector)
  30179. * @see https://doc.babylonjs.com/how_to/debug_layer#extensibility
  30180. */
  30181. inspectableCustomProperties: IInspectable[];
  30182. /**
  30183. * Sets the alpha value of the material
  30184. */
  30185. set alpha(value: number);
  30186. /**
  30187. * Gets the alpha value of the material
  30188. */
  30189. get alpha(): number;
  30190. /**
  30191. * Specifies if back face culling is enabled
  30192. */
  30193. protected _backFaceCulling: boolean;
  30194. /**
  30195. * Sets the back-face culling state
  30196. */
  30197. set backFaceCulling(value: boolean);
  30198. /**
  30199. * Gets the back-face culling state
  30200. */
  30201. get backFaceCulling(): boolean;
  30202. /**
  30203. * Stores the value for side orientation
  30204. */
  30205. sideOrientation: number;
  30206. /**
  30207. * Callback triggered when the material is compiled
  30208. */
  30209. onCompiled: Nullable<(effect: Effect) => void>;
  30210. /**
  30211. * Callback triggered when an error occurs
  30212. */
  30213. onError: Nullable<(effect: Effect, errors: string) => void>;
  30214. /**
  30215. * Callback triggered to get the render target textures
  30216. */
  30217. getRenderTargetTextures: Nullable<() => SmartArray<RenderTargetTexture>>;
  30218. /**
  30219. * Gets a boolean indicating that current material needs to register RTT
  30220. */
  30221. get hasRenderTargetTextures(): boolean;
  30222. /**
  30223. * Specifies if the material should be serialized
  30224. */
  30225. doNotSerialize: boolean;
  30226. /**
  30227. * @hidden
  30228. */
  30229. _storeEffectOnSubMeshes: boolean;
  30230. /**
  30231. * Stores the animations for the material
  30232. */
  30233. animations: Nullable<Array<Animation>>;
  30234. /**
  30235. * An event triggered when the material is disposed
  30236. */
  30237. onDisposeObservable: Observable<Material>;
  30238. /**
  30239. * An observer which watches for dispose events
  30240. */
  30241. private _onDisposeObserver;
  30242. private _onUnBindObservable;
  30243. /**
  30244. * Called during a dispose event
  30245. */
  30246. set onDispose(callback: () => void);
  30247. private _onBindObservable;
  30248. /**
  30249. * An event triggered when the material is bound
  30250. */
  30251. get onBindObservable(): Observable<AbstractMesh>;
  30252. /**
  30253. * An observer which watches for bind events
  30254. */
  30255. private _onBindObserver;
  30256. /**
  30257. * Called during a bind event
  30258. */
  30259. set onBind(callback: (Mesh: AbstractMesh) => void);
  30260. /**
  30261. * An event triggered when the material is unbound
  30262. */
  30263. get onUnBindObservable(): Observable<Material>;
  30264. protected _onEffectCreatedObservable: Nullable<Observable<{
  30265. effect: Effect;
  30266. subMesh: Nullable<SubMesh>;
  30267. }>>;
  30268. /**
  30269. * An event triggered when the effect is (re)created
  30270. */
  30271. get onEffectCreatedObservable(): Observable<{
  30272. effect: Effect;
  30273. subMesh: Nullable<SubMesh>;
  30274. }>;
  30275. /**
  30276. * Stores the value of the alpha mode
  30277. */
  30278. private _alphaMode;
  30279. /**
  30280. * Sets the value of the alpha mode.
  30281. *
  30282. * | Value | Type | Description |
  30283. * | --- | --- | --- |
  30284. * | 0 | ALPHA_DISABLE | |
  30285. * | 1 | ALPHA_ADD | |
  30286. * | 2 | ALPHA_COMBINE | |
  30287. * | 3 | ALPHA_SUBTRACT | |
  30288. * | 4 | ALPHA_MULTIPLY | |
  30289. * | 5 | ALPHA_MAXIMIZED | |
  30290. * | 6 | ALPHA_ONEONE | |
  30291. * | 7 | ALPHA_PREMULTIPLIED | |
  30292. * | 8 | ALPHA_PREMULTIPLIED_PORTERDUFF | |
  30293. * | 9 | ALPHA_INTERPOLATE | |
  30294. * | 10 | ALPHA_SCREENMODE | |
  30295. *
  30296. */
  30297. set alphaMode(value: number);
  30298. /**
  30299. * Gets the value of the alpha mode
  30300. */
  30301. get alphaMode(): number;
  30302. /**
  30303. * Stores the state of the need depth pre-pass value
  30304. */
  30305. private _needDepthPrePass;
  30306. /**
  30307. * Sets the need depth pre-pass value
  30308. */
  30309. set needDepthPrePass(value: boolean);
  30310. /**
  30311. * Gets the depth pre-pass value
  30312. */
  30313. get needDepthPrePass(): boolean;
  30314. /**
  30315. * Specifies if depth writing should be disabled
  30316. */
  30317. disableDepthWrite: boolean;
  30318. /**
  30319. * Specifies if color writing should be disabled
  30320. */
  30321. disableColorWrite: boolean;
  30322. /**
  30323. * Specifies if depth writing should be forced
  30324. */
  30325. forceDepthWrite: boolean;
  30326. /**
  30327. * Specifies the depth function that should be used. 0 means the default engine function
  30328. */
  30329. depthFunction: number;
  30330. /**
  30331. * Specifies if there should be a separate pass for culling
  30332. */
  30333. separateCullingPass: boolean;
  30334. /**
  30335. * Stores the state specifing if fog should be enabled
  30336. */
  30337. private _fogEnabled;
  30338. /**
  30339. * Sets the state for enabling fog
  30340. */
  30341. set fogEnabled(value: boolean);
  30342. /**
  30343. * Gets the value of the fog enabled state
  30344. */
  30345. get fogEnabled(): boolean;
  30346. /**
  30347. * Stores the size of points
  30348. */
  30349. pointSize: number;
  30350. /**
  30351. * Stores the z offset value
  30352. */
  30353. zOffset: number;
  30354. get wireframe(): boolean;
  30355. /**
  30356. * Sets the state of wireframe mode
  30357. */
  30358. set wireframe(value: boolean);
  30359. /**
  30360. * Gets the value specifying if point clouds are enabled
  30361. */
  30362. get pointsCloud(): boolean;
  30363. /**
  30364. * Sets the state of point cloud mode
  30365. */
  30366. set pointsCloud(value: boolean);
  30367. /**
  30368. * Gets the material fill mode
  30369. */
  30370. get fillMode(): number;
  30371. /**
  30372. * Sets the material fill mode
  30373. */
  30374. set fillMode(value: number);
  30375. /**
  30376. * @hidden
  30377. * Stores the effects for the material
  30378. */
  30379. _effect: Nullable<Effect>;
  30380. /**
  30381. * Specifies if uniform buffers should be used
  30382. */
  30383. private _useUBO;
  30384. /**
  30385. * Stores a reference to the scene
  30386. */
  30387. private _scene;
  30388. /**
  30389. * Stores the fill mode state
  30390. */
  30391. private _fillMode;
  30392. /**
  30393. * Specifies if the depth write state should be cached
  30394. */
  30395. private _cachedDepthWriteState;
  30396. /**
  30397. * Specifies if the color write state should be cached
  30398. */
  30399. private _cachedColorWriteState;
  30400. /**
  30401. * Specifies if the depth function state should be cached
  30402. */
  30403. private _cachedDepthFunctionState;
  30404. /**
  30405. * Stores the uniform buffer
  30406. */
  30407. protected _uniformBuffer: UniformBuffer;
  30408. /** @hidden */
  30409. _indexInSceneMaterialArray: number;
  30410. /** @hidden */
  30411. meshMap: Nullable<{
  30412. [id: string]: AbstractMesh | undefined;
  30413. }>;
  30414. /**
  30415. * Creates a material instance
  30416. * @param name defines the name of the material
  30417. * @param scene defines the scene to reference
  30418. * @param doNotAdd specifies if the material should be added to the scene
  30419. */
  30420. constructor(name: string, scene: Scene, doNotAdd?: boolean);
  30421. /**
  30422. * Returns a string representation of the current material
  30423. * @param fullDetails defines a boolean indicating which levels of logging is desired
  30424. * @returns a string with material information
  30425. */
  30426. toString(fullDetails?: boolean): string;
  30427. /**
  30428. * Gets the class name of the material
  30429. * @returns a string with the class name of the material
  30430. */
  30431. getClassName(): string;
  30432. /**
  30433. * Specifies if updates for the material been locked
  30434. */
  30435. get isFrozen(): boolean;
  30436. /**
  30437. * Locks updates for the material
  30438. */
  30439. freeze(): void;
  30440. /**
  30441. * Unlocks updates for the material
  30442. */
  30443. unfreeze(): void;
  30444. /**
  30445. * Specifies if the material is ready to be used
  30446. * @param mesh defines the mesh to check
  30447. * @param useInstances specifies if instances should be used
  30448. * @returns a boolean indicating if the material is ready to be used
  30449. */
  30450. isReady(mesh?: AbstractMesh, useInstances?: boolean): boolean;
  30451. /**
  30452. * Specifies that the submesh is ready to be used
  30453. * @param mesh defines the mesh to check
  30454. * @param subMesh defines which submesh to check
  30455. * @param useInstances specifies that instances should be used
  30456. * @returns a boolean indicating that the submesh is ready or not
  30457. */
  30458. isReadyForSubMesh(mesh: AbstractMesh, subMesh: SubMesh, useInstances?: boolean): boolean;
  30459. /**
  30460. * Returns the material effect
  30461. * @returns the effect associated with the material
  30462. */
  30463. getEffect(): Nullable<Effect>;
  30464. /**
  30465. * Returns the current scene
  30466. * @returns a Scene
  30467. */
  30468. getScene(): Scene;
  30469. /**
  30470. * Enforces alpha test in opaque or blend mode in order to improve the performances of some situations.
  30471. */
  30472. protected _forceAlphaTest: boolean;
  30473. /**
  30474. * The transparency mode of the material.
  30475. */
  30476. protected _transparencyMode: Nullable<number>;
  30477. /**
  30478. * Gets the current transparency mode.
  30479. */
  30480. get transparencyMode(): Nullable<number>;
  30481. /**
  30482. * Sets the transparency mode of the material.
  30483. *
  30484. * | Value | Type | Description |
  30485. * | ----- | ----------------------------------- | ----------- |
  30486. * | 0 | OPAQUE | |
  30487. * | 1 | ALPHATEST | |
  30488. * | 2 | ALPHABLEND | |
  30489. * | 3 | ALPHATESTANDBLEND | |
  30490. *
  30491. */
  30492. set transparencyMode(value: Nullable<number>);
  30493. /**
  30494. * Returns true if alpha blending should be disabled.
  30495. */
  30496. protected get _disableAlphaBlending(): boolean;
  30497. /**
  30498. * Specifies whether or not this material should be rendered in alpha blend mode.
  30499. * @returns a boolean specifying if alpha blending is needed
  30500. */
  30501. needAlphaBlending(): boolean;
  30502. /**
  30503. * Specifies if the mesh will require alpha blending
  30504. * @param mesh defines the mesh to check
  30505. * @returns a boolean specifying if alpha blending is needed for the mesh
  30506. */
  30507. needAlphaBlendingForMesh(mesh: AbstractMesh): boolean;
  30508. /**
  30509. * Specifies whether or not this material should be rendered in alpha test mode.
  30510. * @returns a boolean specifying if an alpha test is needed.
  30511. */
  30512. needAlphaTesting(): boolean;
  30513. /**
  30514. * Specifies if material alpha testing should be turned on for the mesh
  30515. * @param mesh defines the mesh to check
  30516. */
  30517. protected _shouldTurnAlphaTestOn(mesh: AbstractMesh): boolean;
  30518. /**
  30519. * Gets the texture used for the alpha test
  30520. * @returns the texture to use for alpha testing
  30521. */
  30522. getAlphaTestTexture(): Nullable<BaseTexture>;
  30523. /**
  30524. * Marks the material to indicate that it needs to be re-calculated
  30525. */
  30526. markDirty(): void;
  30527. /** @hidden */
  30528. _preBind(effect?: Effect, overrideOrientation?: Nullable<number>): boolean;
  30529. /**
  30530. * Binds the material to the mesh
  30531. * @param world defines the world transformation matrix
  30532. * @param mesh defines the mesh to bind the material to
  30533. */
  30534. bind(world: Matrix, mesh?: Mesh): void;
  30535. /**
  30536. * Binds the submesh to the material
  30537. * @param world defines the world transformation matrix
  30538. * @param mesh defines the mesh containing the submesh
  30539. * @param subMesh defines the submesh to bind the material to
  30540. */
  30541. bindForSubMesh(world: Matrix, mesh: Mesh, subMesh: SubMesh): void;
  30542. /**
  30543. * Binds the world matrix to the material
  30544. * @param world defines the world transformation matrix
  30545. */
  30546. bindOnlyWorldMatrix(world: Matrix): void;
  30547. /**
  30548. * Binds the scene's uniform buffer to the effect.
  30549. * @param effect defines the effect to bind to the scene uniform buffer
  30550. * @param sceneUbo defines the uniform buffer storing scene data
  30551. */
  30552. bindSceneUniformBuffer(effect: Effect, sceneUbo: UniformBuffer): void;
  30553. /**
  30554. * Binds the view matrix to the effect
  30555. * @param effect defines the effect to bind the view matrix to
  30556. */
  30557. bindView(effect: Effect): void;
  30558. /**
  30559. * Binds the view projection matrix to the effect
  30560. * @param effect defines the effect to bind the view projection matrix to
  30561. */
  30562. bindViewProjection(effect: Effect): void;
  30563. /**
  30564. * Processes to execute after binding the material to a mesh
  30565. * @param mesh defines the rendered mesh
  30566. */
  30567. protected _afterBind(mesh?: Mesh): void;
  30568. /**
  30569. * Unbinds the material from the mesh
  30570. */
  30571. unbind(): void;
  30572. /**
  30573. * Gets the active textures from the material
  30574. * @returns an array of textures
  30575. */
  30576. getActiveTextures(): BaseTexture[];
  30577. /**
  30578. * Specifies if the material uses a texture
  30579. * @param texture defines the texture to check against the material
  30580. * @returns a boolean specifying if the material uses the texture
  30581. */
  30582. hasTexture(texture: BaseTexture): boolean;
  30583. /**
  30584. * Makes a duplicate of the material, and gives it a new name
  30585. * @param name defines the new name for the duplicated material
  30586. * @returns the cloned material
  30587. */
  30588. clone(name: string): Nullable<Material>;
  30589. /**
  30590. * Gets the meshes bound to the material
  30591. * @returns an array of meshes bound to the material
  30592. */
  30593. getBindedMeshes(): AbstractMesh[];
  30594. /**
  30595. * Force shader compilation
  30596. * @param mesh defines the mesh associated with this material
  30597. * @param onCompiled defines a function to execute once the material is compiled
  30598. * @param options defines the options to configure the compilation
  30599. * @param onError defines a function to execute if the material fails compiling
  30600. */
  30601. forceCompilation(mesh: AbstractMesh, onCompiled?: (material: Material) => void, options?: Partial<IMaterialCompilationOptions>, onError?: (reason: string) => void): void;
  30602. /**
  30603. * Force shader compilation
  30604. * @param mesh defines the mesh that will use this material
  30605. * @param options defines additional options for compiling the shaders
  30606. * @returns a promise that resolves when the compilation completes
  30607. */
  30608. forceCompilationAsync(mesh: AbstractMesh, options?: Partial<IMaterialCompilationOptions>): Promise<void>;
  30609. private static readonly _AllDirtyCallBack;
  30610. private static readonly _ImageProcessingDirtyCallBack;
  30611. private static readonly _TextureDirtyCallBack;
  30612. private static readonly _FresnelDirtyCallBack;
  30613. private static readonly _MiscDirtyCallBack;
  30614. private static readonly _PrePassDirtyCallBack;
  30615. private static readonly _LightsDirtyCallBack;
  30616. private static readonly _AttributeDirtyCallBack;
  30617. private static _FresnelAndMiscDirtyCallBack;
  30618. private static _TextureAndMiscDirtyCallBack;
  30619. private static readonly _DirtyCallbackArray;
  30620. private static readonly _RunDirtyCallBacks;
  30621. /**
  30622. * Marks a define in the material to indicate that it needs to be re-computed
  30623. * @param flag defines a flag used to determine which parts of the material have to be marked as dirty
  30624. */
  30625. markAsDirty(flag: number): void;
  30626. /**
  30627. * Marks all submeshes of a material to indicate that their material defines need to be re-calculated
  30628. * @param func defines a function which checks material defines against the submeshes
  30629. */
  30630. protected _markAllSubMeshesAsDirty(func: (defines: MaterialDefines) => void): void;
  30631. /**
  30632. * Indicates that the scene should check if the rendering now needs a prepass
  30633. */
  30634. protected _markScenePrePassDirty(): void;
  30635. /**
  30636. * Indicates that we need to re-calculated for all submeshes
  30637. */
  30638. protected _markAllSubMeshesAsAllDirty(): void;
  30639. /**
  30640. * Indicates that image processing needs to be re-calculated for all submeshes
  30641. */
  30642. protected _markAllSubMeshesAsImageProcessingDirty(): void;
  30643. /**
  30644. * Indicates that textures need to be re-calculated for all submeshes
  30645. */
  30646. protected _markAllSubMeshesAsTexturesDirty(): void;
  30647. /**
  30648. * Indicates that fresnel needs to be re-calculated for all submeshes
  30649. */
  30650. protected _markAllSubMeshesAsFresnelDirty(): void;
  30651. /**
  30652. * Indicates that fresnel and misc need to be re-calculated for all submeshes
  30653. */
  30654. protected _markAllSubMeshesAsFresnelAndMiscDirty(): void;
  30655. /**
  30656. * Indicates that lights need to be re-calculated for all submeshes
  30657. */
  30658. protected _markAllSubMeshesAsLightsDirty(): void;
  30659. /**
  30660. * Indicates that attributes need to be re-calculated for all submeshes
  30661. */
  30662. protected _markAllSubMeshesAsAttributesDirty(): void;
  30663. /**
  30664. * Indicates that misc needs to be re-calculated for all submeshes
  30665. */
  30666. protected _markAllSubMeshesAsMiscDirty(): void;
  30667. /**
  30668. * Indicates that prepass needs to be re-calculated for all submeshes
  30669. */
  30670. protected _markAllSubMeshesAsPrePassDirty(): void;
  30671. /**
  30672. * Indicates that textures and misc need to be re-calculated for all submeshes
  30673. */
  30674. protected _markAllSubMeshesAsTexturesAndMiscDirty(): void;
  30675. /**
  30676. * Sets the required values to the prepass renderer.
  30677. * @param prePassRenderer defines the prepass renderer to setup.
  30678. * @returns true if the pre pass is needed.
  30679. */
  30680. setPrePassRenderer(prePassRenderer: PrePassRenderer): boolean;
  30681. /**
  30682. * Disposes the material
  30683. * @param forceDisposeEffect specifies if effects should be forcefully disposed
  30684. * @param forceDisposeTextures specifies if textures should be forcefully disposed
  30685. * @param notBoundToMesh specifies if the material that is being disposed is known to be not bound to any mesh
  30686. */
  30687. dispose(forceDisposeEffect?: boolean, forceDisposeTextures?: boolean, notBoundToMesh?: boolean): void;
  30688. /** @hidden */
  30689. private releaseVertexArrayObject;
  30690. /**
  30691. * Serializes this material
  30692. * @returns the serialized material object
  30693. */
  30694. serialize(): any;
  30695. /**
  30696. * Creates a material from parsed material data
  30697. * @param parsedMaterial defines parsed material data
  30698. * @param scene defines the hosting scene
  30699. * @param rootUrl defines the root URL to use to load textures
  30700. * @returns a new material
  30701. */
  30702. static Parse(parsedMaterial: any, scene: Scene, rootUrl: string): Nullable<Material>;
  30703. }
  30704. }
  30705. declare module "babylonjs/Materials/multiMaterial" {
  30706. import { Nullable } from "babylonjs/types";
  30707. import { Scene } from "babylonjs/scene";
  30708. import { AbstractMesh } from "babylonjs/Meshes/abstractMesh";
  30709. import { SubMesh } from "babylonjs/Meshes/subMesh";
  30710. import { BaseTexture } from "babylonjs/Materials/Textures/baseTexture";
  30711. import { Material } from "babylonjs/Materials/material";
  30712. /**
  30713. * A multi-material is used to apply different materials to different parts of the same object without the need of
  30714. * separate meshes. This can be use to improve performances.
  30715. * @see https://doc.babylonjs.com/how_to/multi_materials
  30716. */
  30717. export class MultiMaterial extends Material {
  30718. private _subMaterials;
  30719. /**
  30720. * Gets or Sets the list of Materials used within the multi material.
  30721. * They need to be ordered according to the submeshes order in the associated mesh
  30722. */
  30723. get subMaterials(): Nullable<Material>[];
  30724. set subMaterials(value: Nullable<Material>[]);
  30725. /**
  30726. * Function used to align with Node.getChildren()
  30727. * @returns the list of Materials used within the multi material
  30728. */
  30729. getChildren(): Nullable<Material>[];
  30730. /**
  30731. * Instantiates a new Multi Material
  30732. * A multi-material is used to apply different materials to different parts of the same object without the need of
  30733. * separate meshes. This can be use to improve performances.
  30734. * @see https://doc.babylonjs.com/how_to/multi_materials
  30735. * @param name Define the name in the scene
  30736. * @param scene Define the scene the material belongs to
  30737. */
  30738. constructor(name: string, scene: Scene);
  30739. private _hookArray;
  30740. /**
  30741. * Get one of the submaterial by its index in the submaterials array
  30742. * @param index The index to look the sub material at
  30743. * @returns The Material if the index has been defined
  30744. */
  30745. getSubMaterial(index: number): Nullable<Material>;
  30746. /**
  30747. * Get the list of active textures for the whole sub materials list.
  30748. * @returns All the textures that will be used during the rendering
  30749. */
  30750. getActiveTextures(): BaseTexture[];
  30751. /**
  30752. * Gets the current class name of the material e.g. "MultiMaterial"
  30753. * Mainly use in serialization.
  30754. * @returns the class name
  30755. */
  30756. getClassName(): string;
  30757. /**
  30758. * Checks if the material is ready to render the requested sub mesh
  30759. * @param mesh Define the mesh the submesh belongs to
  30760. * @param subMesh Define the sub mesh to look readyness for
  30761. * @param useInstances Define whether or not the material is used with instances
  30762. * @returns true if ready, otherwise false
  30763. */
  30764. isReadyForSubMesh(mesh: AbstractMesh, subMesh: SubMesh, useInstances?: boolean): boolean;
  30765. /**
  30766. * Clones the current material and its related sub materials
  30767. * @param name Define the name of the newly cloned material
  30768. * @param cloneChildren Define if submaterial will be cloned or shared with the parent instance
  30769. * @returns the cloned material
  30770. */
  30771. clone(name: string, cloneChildren?: boolean): MultiMaterial;
  30772. /**
  30773. * Serializes the materials into a JSON representation.
  30774. * @returns the JSON representation
  30775. */
  30776. serialize(): any;
  30777. /**
  30778. * Dispose the material and release its associated resources
  30779. * @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)
  30780. * @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)
  30781. * @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)
  30782. */
  30783. dispose(forceDisposeEffect?: boolean, forceDisposeTextures?: boolean, forceDisposeChildren?: boolean): void;
  30784. /**
  30785. * Creates a MultiMaterial from parsed MultiMaterial data.
  30786. * @param parsedMultiMaterial defines parsed MultiMaterial data.
  30787. * @param scene defines the hosting scene
  30788. * @returns a new MultiMaterial
  30789. */
  30790. static ParseMultiMaterial(parsedMultiMaterial: any, scene: Scene): MultiMaterial;
  30791. }
  30792. }
  30793. declare module "babylonjs/Meshes/subMesh" {
  30794. import { Nullable, IndicesArray, DeepImmutable, FloatArray } from "babylonjs/types";
  30795. import { Matrix, Vector3 } from "babylonjs/Maths/math.vector";
  30796. import { Engine } from "babylonjs/Engines/engine";
  30797. import { IntersectionInfo } from "babylonjs/Collisions/intersectionInfo";
  30798. import { ICullable, BoundingInfo } from "babylonjs/Culling/boundingInfo";
  30799. import { Effect } from "babylonjs/Materials/effect";
  30800. import { DataBuffer } from "babylonjs/Meshes/dataBuffer";
  30801. import { Plane } from "babylonjs/Maths/math.plane";
  30802. import { Collider } from "babylonjs/Collisions/collider";
  30803. import { Material } from "babylonjs/Materials/material";
  30804. import { MaterialDefines } from "babylonjs/Materials/materialDefines";
  30805. import { AbstractMesh } from "babylonjs/Meshes/abstractMesh";
  30806. import { Mesh } from "babylonjs/Meshes/mesh";
  30807. import { Ray } from "babylonjs/Culling/ray";
  30808. import { TrianglePickingPredicate } from "babylonjs/Culling/ray";
  30809. /**
  30810. * Defines a subdivision inside a mesh
  30811. */
  30812. export class SubMesh implements ICullable {
  30813. /** the material index to use */
  30814. materialIndex: number;
  30815. /** vertex index start */
  30816. verticesStart: number;
  30817. /** vertices count */
  30818. verticesCount: number;
  30819. /** index start */
  30820. indexStart: number;
  30821. /** indices count */
  30822. indexCount: number;
  30823. /** @hidden */
  30824. _materialDefines: Nullable<MaterialDefines>;
  30825. /** @hidden */
  30826. _materialEffect: Nullable<Effect>;
  30827. /** @hidden */
  30828. _effectOverride: Nullable<Effect>;
  30829. /**
  30830. * Gets material defines used by the effect associated to the sub mesh
  30831. */
  30832. get materialDefines(): Nullable<MaterialDefines>;
  30833. /**
  30834. * Sets material defines used by the effect associated to the sub mesh
  30835. */
  30836. set materialDefines(defines: Nullable<MaterialDefines>);
  30837. /**
  30838. * Gets associated effect
  30839. */
  30840. get effect(): Nullable<Effect>;
  30841. /**
  30842. * Sets associated effect (effect used to render this submesh)
  30843. * @param effect defines the effect to associate with
  30844. * @param defines defines the set of defines used to compile this effect
  30845. */
  30846. setEffect(effect: Nullable<Effect>, defines?: Nullable<MaterialDefines>): void;
  30847. /** @hidden */
  30848. _linesIndexCount: number;
  30849. private _mesh;
  30850. private _renderingMesh;
  30851. private _boundingInfo;
  30852. private _linesIndexBuffer;
  30853. /** @hidden */
  30854. _lastColliderWorldVertices: Nullable<Vector3[]>;
  30855. /** @hidden */
  30856. _trianglePlanes: Plane[];
  30857. /** @hidden */
  30858. _lastColliderTransformMatrix: Nullable<Matrix>;
  30859. /** @hidden */
  30860. _renderId: number;
  30861. /** @hidden */
  30862. _alphaIndex: number;
  30863. /** @hidden */
  30864. _distanceToCamera: number;
  30865. /** @hidden */
  30866. _id: number;
  30867. private _currentMaterial;
  30868. /**
  30869. * Add a new submesh to a mesh
  30870. * @param materialIndex defines the material index to use
  30871. * @param verticesStart defines vertex index start
  30872. * @param verticesCount defines vertices count
  30873. * @param indexStart defines index start
  30874. * @param indexCount defines indices count
  30875. * @param mesh defines the parent mesh
  30876. * @param renderingMesh defines an optional rendering mesh
  30877. * @param createBoundingBox defines if bounding box should be created for this submesh
  30878. * @returns the new submesh
  30879. */
  30880. static AddToMesh(materialIndex: number, verticesStart: number, verticesCount: number, indexStart: number, indexCount: number, mesh: AbstractMesh, renderingMesh?: Mesh, createBoundingBox?: boolean): SubMesh;
  30881. /**
  30882. * Creates a new submesh
  30883. * @param materialIndex defines the material index to use
  30884. * @param verticesStart defines vertex index start
  30885. * @param verticesCount defines vertices count
  30886. * @param indexStart defines index start
  30887. * @param indexCount defines indices count
  30888. * @param mesh defines the parent mesh
  30889. * @param renderingMesh defines an optional rendering mesh
  30890. * @param createBoundingBox defines if bounding box should be created for this submesh
  30891. * @param addToMesh defines a boolean indicating that the submesh must be added to the mesh.subMeshes array (true by default)
  30892. */
  30893. constructor(
  30894. /** the material index to use */
  30895. materialIndex: number,
  30896. /** vertex index start */
  30897. verticesStart: number,
  30898. /** vertices count */
  30899. verticesCount: number,
  30900. /** index start */
  30901. indexStart: number,
  30902. /** indices count */
  30903. indexCount: number, mesh: AbstractMesh, renderingMesh?: Mesh, createBoundingBox?: boolean, addToMesh?: boolean);
  30904. /**
  30905. * Returns true if this submesh covers the entire parent mesh
  30906. * @ignorenaming
  30907. */
  30908. get IsGlobal(): boolean;
  30909. /**
  30910. * Returns the submesh BoudingInfo object
  30911. * @returns current bounding info (or mesh's one if the submesh is global)
  30912. */
  30913. getBoundingInfo(): BoundingInfo;
  30914. /**
  30915. * Sets the submesh BoundingInfo
  30916. * @param boundingInfo defines the new bounding info to use
  30917. * @returns the SubMesh
  30918. */
  30919. setBoundingInfo(boundingInfo: BoundingInfo): SubMesh;
  30920. /**
  30921. * Returns the mesh of the current submesh
  30922. * @return the parent mesh
  30923. */
  30924. getMesh(): AbstractMesh;
  30925. /**
  30926. * Returns the rendering mesh of the submesh
  30927. * @returns the rendering mesh (could be different from parent mesh)
  30928. */
  30929. getRenderingMesh(): Mesh;
  30930. /**
  30931. * Returns the replacement mesh of the submesh
  30932. * @returns the replacement mesh (could be different from parent mesh)
  30933. */
  30934. getReplacementMesh(): Nullable<AbstractMesh>;
  30935. /**
  30936. * Returns the effective mesh of the submesh
  30937. * @returns the effective mesh (could be different from parent mesh)
  30938. */
  30939. getEffectiveMesh(): AbstractMesh;
  30940. /**
  30941. * Returns the submesh material
  30942. * @returns null or the current material
  30943. */
  30944. getMaterial(): Nullable<Material>;
  30945. private _IsMultiMaterial;
  30946. /**
  30947. * Sets a new updated BoundingInfo object to the submesh
  30948. * @param data defines an optional position array to use to determine the bounding info
  30949. * @returns the SubMesh
  30950. */
  30951. refreshBoundingInfo(data?: Nullable<FloatArray>): SubMesh;
  30952. /** @hidden */
  30953. _checkCollision(collider: Collider): boolean;
  30954. /**
  30955. * Updates the submesh BoundingInfo
  30956. * @param world defines the world matrix to use to update the bounding info
  30957. * @returns the submesh
  30958. */
  30959. updateBoundingInfo(world: DeepImmutable<Matrix>): SubMesh;
  30960. /**
  30961. * True is the submesh bounding box intersects the frustum defined by the passed array of planes.
  30962. * @param frustumPlanes defines the frustum planes
  30963. * @returns true if the submesh is intersecting with the frustum
  30964. */
  30965. isInFrustum(frustumPlanes: Plane[]): boolean;
  30966. /**
  30967. * True is the submesh bounding box is completely inside the frustum defined by the passed array of planes
  30968. * @param frustumPlanes defines the frustum planes
  30969. * @returns true if the submesh is inside the frustum
  30970. */
  30971. isCompletelyInFrustum(frustumPlanes: Plane[]): boolean;
  30972. /**
  30973. * Renders the submesh
  30974. * @param enableAlphaMode defines if alpha needs to be used
  30975. * @returns the submesh
  30976. */
  30977. render(enableAlphaMode: boolean): SubMesh;
  30978. /**
  30979. * @hidden
  30980. */
  30981. _getLinesIndexBuffer(indices: IndicesArray, engine: Engine): DataBuffer;
  30982. /**
  30983. * Checks if the submesh intersects with a ray
  30984. * @param ray defines the ray to test
  30985. * @returns true is the passed ray intersects the submesh bounding box
  30986. */
  30987. canIntersects(ray: Ray): boolean;
  30988. /**
  30989. * Intersects current submesh with a ray
  30990. * @param ray defines the ray to test
  30991. * @param positions defines mesh's positions array
  30992. * @param indices defines mesh's indices array
  30993. * @param fastCheck defines if the first intersection will be used (and not the closest)
  30994. * @param trianglePredicate defines an optional predicate used to select faces when a mesh intersection is detected
  30995. * @returns intersection info or null if no intersection
  30996. */
  30997. intersects(ray: Ray, positions: Vector3[], indices: IndicesArray, fastCheck?: boolean, trianglePredicate?: TrianglePickingPredicate): Nullable<IntersectionInfo>;
  30998. /** @hidden */
  30999. private _intersectLines;
  31000. /** @hidden */
  31001. private _intersectUnIndexedLines;
  31002. /** @hidden */
  31003. private _intersectTriangles;
  31004. /** @hidden */
  31005. private _intersectUnIndexedTriangles;
  31006. /** @hidden */
  31007. _rebuild(): void;
  31008. /**
  31009. * Creates a new submesh from the passed mesh
  31010. * @param newMesh defines the new hosting mesh
  31011. * @param newRenderingMesh defines an optional rendering mesh
  31012. * @returns the new submesh
  31013. */
  31014. clone(newMesh: AbstractMesh, newRenderingMesh?: Mesh): SubMesh;
  31015. /**
  31016. * Release associated resources
  31017. */
  31018. dispose(): void;
  31019. /**
  31020. * Gets the class name
  31021. * @returns the string "SubMesh".
  31022. */
  31023. getClassName(): string;
  31024. /**
  31025. * Creates a new submesh from indices data
  31026. * @param materialIndex the index of the main mesh material
  31027. * @param startIndex the index where to start the copy in the mesh indices array
  31028. * @param indexCount the number of indices to copy then from the startIndex
  31029. * @param mesh the main mesh to create the submesh from
  31030. * @param renderingMesh the optional rendering mesh
  31031. * @returns a new submesh
  31032. */
  31033. static CreateFromIndices(materialIndex: number, startIndex: number, indexCount: number, mesh: AbstractMesh, renderingMesh?: Mesh): SubMesh;
  31034. }
  31035. }
  31036. declare module "babylonjs/Loading/sceneLoaderFlags" {
  31037. /**
  31038. * Class used to represent data loading progression
  31039. */
  31040. export class SceneLoaderFlags {
  31041. private static _ForceFullSceneLoadingForIncremental;
  31042. private static _ShowLoadingScreen;
  31043. private static _CleanBoneMatrixWeights;
  31044. private static _loggingLevel;
  31045. /**
  31046. * Gets or sets a boolean indicating if entire scene must be loaded even if scene contains incremental data
  31047. */
  31048. static get ForceFullSceneLoadingForIncremental(): boolean;
  31049. static set ForceFullSceneLoadingForIncremental(value: boolean);
  31050. /**
  31051. * Gets or sets a boolean indicating if loading screen must be displayed while loading a scene
  31052. */
  31053. static get ShowLoadingScreen(): boolean;
  31054. static set ShowLoadingScreen(value: boolean);
  31055. /**
  31056. * Defines the current logging level (while loading the scene)
  31057. * @ignorenaming
  31058. */
  31059. static get loggingLevel(): number;
  31060. static set loggingLevel(value: number);
  31061. /**
  31062. * Gets or set a boolean indicating if matrix weights must be cleaned upon loading
  31063. */
  31064. static get CleanBoneMatrixWeights(): boolean;
  31065. static set CleanBoneMatrixWeights(value: boolean);
  31066. }
  31067. }
  31068. declare module "babylonjs/Meshes/geometry" {
  31069. import { Nullable, FloatArray, DataArray, IndicesArray } from "babylonjs/types";
  31070. import { Scene } from "babylonjs/scene";
  31071. import { Vector3, Vector2 } from "babylonjs/Maths/math.vector";
  31072. import { Engine } from "babylonjs/Engines/engine";
  31073. import { IGetSetVerticesData, VertexData } from "babylonjs/Meshes/mesh.vertexData";
  31074. import { VertexBuffer } from "babylonjs/Meshes/buffer";
  31075. import { Effect } from "babylonjs/Materials/effect";
  31076. import { BoundingInfo } from "babylonjs/Culling/boundingInfo";
  31077. import { DataBuffer } from "babylonjs/Meshes/dataBuffer";
  31078. import { Mesh } from "babylonjs/Meshes/mesh";
  31079. /**
  31080. * Class used to store geometry data (vertex buffers + index buffer)
  31081. */
  31082. export class Geometry implements IGetSetVerticesData {
  31083. /**
  31084. * Gets or sets the ID of the geometry
  31085. */
  31086. id: string;
  31087. /**
  31088. * Gets or sets the unique ID of the geometry
  31089. */
  31090. uniqueId: number;
  31091. /**
  31092. * Gets the delay loading state of the geometry (none by default which means not delayed)
  31093. */
  31094. delayLoadState: number;
  31095. /**
  31096. * Gets the file containing the data to load when running in delay load state
  31097. */
  31098. delayLoadingFile: Nullable<string>;
  31099. /**
  31100. * Callback called when the geometry is updated
  31101. */
  31102. onGeometryUpdated: (geometry: Geometry, kind?: string) => void;
  31103. private _scene;
  31104. private _engine;
  31105. private _meshes;
  31106. private _totalVertices;
  31107. /** @hidden */
  31108. _indices: IndicesArray;
  31109. /** @hidden */
  31110. _vertexBuffers: {
  31111. [key: string]: VertexBuffer;
  31112. };
  31113. private _isDisposed;
  31114. private _extend;
  31115. private _boundingBias;
  31116. /** @hidden */
  31117. _delayInfo: Array<string>;
  31118. private _indexBuffer;
  31119. private _indexBufferIsUpdatable;
  31120. /** @hidden */
  31121. _boundingInfo: Nullable<BoundingInfo>;
  31122. /** @hidden */
  31123. _delayLoadingFunction: Nullable<(any: any, geometry: Geometry) => void>;
  31124. /** @hidden */
  31125. _softwareSkinningFrameId: number;
  31126. private _vertexArrayObjects;
  31127. private _updatable;
  31128. /** @hidden */
  31129. _positions: Nullable<Vector3[]>;
  31130. /**
  31131. * 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
  31132. */
  31133. get boundingBias(): Vector2;
  31134. /**
  31135. * 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
  31136. */
  31137. set boundingBias(value: Vector2);
  31138. /**
  31139. * Static function used to attach a new empty geometry to a mesh
  31140. * @param mesh defines the mesh to attach the geometry to
  31141. * @returns the new Geometry
  31142. */
  31143. static CreateGeometryForMesh(mesh: Mesh): Geometry;
  31144. /** Get the list of meshes using this geometry */
  31145. get meshes(): Mesh[];
  31146. /**
  31147. * 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
  31148. * and won't be computed based on the vertex positions (which is what we get when useBoundingInfoFromGeometry = false)
  31149. */
  31150. useBoundingInfoFromGeometry: boolean;
  31151. /**
  31152. * Creates a new geometry
  31153. * @param id defines the unique ID
  31154. * @param scene defines the hosting scene
  31155. * @param vertexData defines the VertexData used to get geometry data
  31156. * @param updatable defines if geometry must be updatable (false by default)
  31157. * @param mesh defines the mesh that will be associated with the geometry
  31158. */
  31159. constructor(id: string, scene: Scene, vertexData?: VertexData, updatable?: boolean, mesh?: Nullable<Mesh>);
  31160. /**
  31161. * Gets the current extend of the geometry
  31162. */
  31163. get extend(): {
  31164. minimum: Vector3;
  31165. maximum: Vector3;
  31166. };
  31167. /**
  31168. * Gets the hosting scene
  31169. * @returns the hosting Scene
  31170. */
  31171. getScene(): Scene;
  31172. /**
  31173. * Gets the hosting engine
  31174. * @returns the hosting Engine
  31175. */
  31176. getEngine(): Engine;
  31177. /**
  31178. * Defines if the geometry is ready to use
  31179. * @returns true if the geometry is ready to be used
  31180. */
  31181. isReady(): boolean;
  31182. /**
  31183. * Gets a value indicating that the geometry should not be serialized
  31184. */
  31185. get doNotSerialize(): boolean;
  31186. /** @hidden */
  31187. _rebuild(): void;
  31188. /**
  31189. * Affects all geometry data in one call
  31190. * @param vertexData defines the geometry data
  31191. * @param updatable defines if the geometry must be flagged as updatable (false as default)
  31192. */
  31193. setAllVerticesData(vertexData: VertexData, updatable?: boolean): void;
  31194. /**
  31195. * Set specific vertex data
  31196. * @param kind defines the data kind (Position, normal, etc...)
  31197. * @param data defines the vertex data to use
  31198. * @param updatable defines if the vertex must be flagged as updatable (false as default)
  31199. * @param stride defines the stride to use (0 by default). This value is deduced from the kind value if not specified
  31200. */
  31201. setVerticesData(kind: string, data: FloatArray, updatable?: boolean, stride?: number): void;
  31202. /**
  31203. * Removes a specific vertex data
  31204. * @param kind defines the data kind (Position, normal, etc...)
  31205. */
  31206. removeVerticesData(kind: string): void;
  31207. /**
  31208. * Affect a vertex buffer to the geometry. the vertexBuffer.getKind() function is used to determine where to store the data
  31209. * @param buffer defines the vertex buffer to use
  31210. * @param totalVertices defines the total number of vertices for position kind (could be null)
  31211. */
  31212. setVerticesBuffer(buffer: VertexBuffer, totalVertices?: Nullable<number>): void;
  31213. /**
  31214. * Update a specific vertex buffer
  31215. * This function will directly update the underlying DataBuffer according to the passed numeric array or Float32Array
  31216. * It will do nothing if the buffer is not updatable
  31217. * @param kind defines the data kind (Position, normal, etc...)
  31218. * @param data defines the data to use
  31219. * @param offset defines the offset in the target buffer where to store the data
  31220. * @param useBytes set to true if the offset is in bytes
  31221. */
  31222. updateVerticesDataDirectly(kind: string, data: DataArray, offset: number, useBytes?: boolean): void;
  31223. /**
  31224. * Update a specific vertex buffer
  31225. * This function will create a new buffer if the current one is not updatable
  31226. * @param kind defines the data kind (Position, normal, etc...)
  31227. * @param data defines the data to use
  31228. * @param updateExtends defines if the geometry extends must be recomputed (false by default)
  31229. */
  31230. updateVerticesData(kind: string, data: FloatArray, updateExtends?: boolean): void;
  31231. private _updateBoundingInfo;
  31232. /** @hidden */
  31233. _bind(effect: Nullable<Effect>, indexToBind?: Nullable<DataBuffer>): void;
  31234. /**
  31235. * Gets total number of vertices
  31236. * @returns the total number of vertices
  31237. */
  31238. getTotalVertices(): number;
  31239. /**
  31240. * Gets a specific vertex data attached to this geometry. Float data is constructed if the vertex buffer data cannot be returned directly.
  31241. * @param kind defines the data kind (Position, normal, etc...)
  31242. * @param copyWhenShared defines if the returned array must be cloned upon returning it if the current geometry is shared between multiple meshes
  31243. * @param forceCopy defines a boolean indicating that the returned array must be cloned upon returning it
  31244. * @returns a float array containing vertex data
  31245. */
  31246. getVerticesData(kind: string, copyWhenShared?: boolean, forceCopy?: boolean): Nullable<FloatArray>;
  31247. /**
  31248. * Returns a boolean defining if the vertex data for the requested `kind` is updatable
  31249. * @param kind defines the data kind (Position, normal, etc...)
  31250. * @returns true if the vertex buffer with the specified kind is updatable
  31251. */
  31252. isVertexBufferUpdatable(kind: string): boolean;
  31253. /**
  31254. * Gets a specific vertex buffer
  31255. * @param kind defines the data kind (Position, normal, etc...)
  31256. * @returns a VertexBuffer
  31257. */
  31258. getVertexBuffer(kind: string): Nullable<VertexBuffer>;
  31259. /**
  31260. * Returns all vertex buffers
  31261. * @return an object holding all vertex buffers indexed by kind
  31262. */
  31263. getVertexBuffers(): Nullable<{
  31264. [key: string]: VertexBuffer;
  31265. }>;
  31266. /**
  31267. * Gets a boolean indicating if specific vertex buffer is present
  31268. * @param kind defines the data kind (Position, normal, etc...)
  31269. * @returns true if data is present
  31270. */
  31271. isVerticesDataPresent(kind: string): boolean;
  31272. /**
  31273. * Gets a list of all attached data kinds (Position, normal, etc...)
  31274. * @returns a list of string containing all kinds
  31275. */
  31276. getVerticesDataKinds(): string[];
  31277. /**
  31278. * Update index buffer
  31279. * @param indices defines the indices to store in the index buffer
  31280. * @param offset defines the offset in the target buffer where to store the data
  31281. * @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)
  31282. */
  31283. updateIndices(indices: IndicesArray, offset?: number, gpuMemoryOnly?: boolean): void;
  31284. /**
  31285. * Creates a new index buffer
  31286. * @param indices defines the indices to store in the index buffer
  31287. * @param totalVertices defines the total number of vertices (could be null)
  31288. * @param updatable defines if the index buffer must be flagged as updatable (false by default)
  31289. */
  31290. setIndices(indices: IndicesArray, totalVertices?: Nullable<number>, updatable?: boolean): void;
  31291. /**
  31292. * Return the total number of indices
  31293. * @returns the total number of indices
  31294. */
  31295. getTotalIndices(): number;
  31296. /**
  31297. * Gets the index buffer array
  31298. * @param copyWhenShared defines if the returned array must be cloned upon returning it if the current geometry is shared between multiple meshes
  31299. * @param forceCopy defines a boolean indicating that the returned array must be cloned upon returning it
  31300. * @returns the index buffer array
  31301. */
  31302. getIndices(copyWhenShared?: boolean, forceCopy?: boolean): Nullable<IndicesArray>;
  31303. /**
  31304. * Gets the index buffer
  31305. * @return the index buffer
  31306. */
  31307. getIndexBuffer(): Nullable<DataBuffer>;
  31308. /** @hidden */
  31309. _releaseVertexArrayObject(effect?: Nullable<Effect>): void;
  31310. /**
  31311. * Release the associated resources for a specific mesh
  31312. * @param mesh defines the source mesh
  31313. * @param shouldDispose defines if the geometry must be disposed if there is no more mesh pointing to it
  31314. */
  31315. releaseForMesh(mesh: Mesh, shouldDispose?: boolean): void;
  31316. /**
  31317. * Apply current geometry to a given mesh
  31318. * @param mesh defines the mesh to apply geometry to
  31319. */
  31320. applyToMesh(mesh: Mesh): void;
  31321. private _updateExtend;
  31322. private _applyToMesh;
  31323. private notifyUpdate;
  31324. /**
  31325. * Load the geometry if it was flagged as delay loaded
  31326. * @param scene defines the hosting scene
  31327. * @param onLoaded defines a callback called when the geometry is loaded
  31328. */
  31329. load(scene: Scene, onLoaded?: () => void): void;
  31330. private _queueLoad;
  31331. /**
  31332. * Invert the geometry to move from a right handed system to a left handed one.
  31333. */
  31334. toLeftHanded(): void;
  31335. /** @hidden */
  31336. _resetPointsArrayCache(): void;
  31337. /** @hidden */
  31338. _generatePointsArray(): boolean;
  31339. /**
  31340. * Gets a value indicating if the geometry is disposed
  31341. * @returns true if the geometry was disposed
  31342. */
  31343. isDisposed(): boolean;
  31344. private _disposeVertexArrayObjects;
  31345. /**
  31346. * Free all associated resources
  31347. */
  31348. dispose(): void;
  31349. /**
  31350. * Clone the current geometry into a new geometry
  31351. * @param id defines the unique ID of the new geometry
  31352. * @returns a new geometry object
  31353. */
  31354. copy(id: string): Geometry;
  31355. /**
  31356. * Serialize the current geometry info (and not the vertices data) into a JSON object
  31357. * @return a JSON representation of the current geometry data (without the vertices data)
  31358. */
  31359. serialize(): any;
  31360. private toNumberArray;
  31361. /**
  31362. * Serialize all vertices data into a JSON oject
  31363. * @returns a JSON representation of the current geometry data
  31364. */
  31365. serializeVerticeData(): any;
  31366. /**
  31367. * Extracts a clone of a mesh geometry
  31368. * @param mesh defines the source mesh
  31369. * @param id defines the unique ID of the new geometry object
  31370. * @returns the new geometry object
  31371. */
  31372. static ExtractFromMesh(mesh: Mesh, id: string): Nullable<Geometry>;
  31373. /**
  31374. * You should now use Tools.RandomId(), this method is still here for legacy reasons.
  31375. * Implementation from http://stackoverflow.com/questions/105034/how-to-create-a-guid-uuid-in-javascript/2117523#answer-2117523
  31376. * Be aware Math.random() could cause collisions, but:
  31377. * "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"
  31378. * @returns a string containing a new GUID
  31379. */
  31380. static RandomId(): string;
  31381. /** @hidden */
  31382. static _ImportGeometry(parsedGeometry: any, mesh: Mesh): void;
  31383. private static _CleanMatricesWeights;
  31384. /**
  31385. * Create a new geometry from persisted data (Using .babylon file format)
  31386. * @param parsedVertexData defines the persisted data
  31387. * @param scene defines the hosting scene
  31388. * @param rootUrl defines the root url to use to load assets (like delayed data)
  31389. * @returns the new geometry object
  31390. */
  31391. static Parse(parsedVertexData: any, scene: Scene, rootUrl: string): Nullable<Geometry>;
  31392. }
  31393. }
  31394. declare module "babylonjs/Meshes/mesh.vertexData" {
  31395. import { Nullable, FloatArray, IndicesArray } from "babylonjs/types";
  31396. import { Matrix, Vector3, Vector2, Vector4 } from "babylonjs/Maths/math.vector";
  31397. import { Color4, Color3 } from "babylonjs/Maths/math.color";
  31398. import { Geometry } from "babylonjs/Meshes/geometry";
  31399. import { Mesh } from "babylonjs/Meshes/mesh";
  31400. import { ICreateCapsuleOptions } from "babylonjs/Meshes/Builders/capsuleBuilder";
  31401. /**
  31402. * Define an interface for all classes that will get and set the data on vertices
  31403. */
  31404. export interface IGetSetVerticesData {
  31405. /**
  31406. * Gets a boolean indicating if specific vertex data is present
  31407. * @param kind defines the vertex data kind to use
  31408. * @returns true is data kind is present
  31409. */
  31410. isVerticesDataPresent(kind: string): boolean;
  31411. /**
  31412. * Gets a specific vertex data attached to this geometry. Float data is constructed if the vertex buffer data cannot be returned directly.
  31413. * @param kind defines the data kind (Position, normal, etc...)
  31414. * @param copyWhenShared defines if the returned array must be cloned upon returning it if the current geometry is shared between multiple meshes
  31415. * @param forceCopy defines a boolean indicating that the returned array must be cloned upon returning it
  31416. * @returns a float array containing vertex data
  31417. */
  31418. getVerticesData(kind: string, copyWhenShared?: boolean, forceCopy?: boolean): Nullable<FloatArray>;
  31419. /**
  31420. * Returns an array of integers or a typed array (Int32Array, Uint32Array, Uint16Array) populated with the mesh indices.
  31421. * @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.
  31422. * @param forceCopy defines a boolean indicating that the returned array must be cloned upon returning it
  31423. * @returns the indices array or an empty array if the mesh has no geometry
  31424. */
  31425. getIndices(copyWhenShared?: boolean, forceCopy?: boolean): Nullable<IndicesArray>;
  31426. /**
  31427. * Set specific vertex data
  31428. * @param kind defines the data kind (Position, normal, etc...)
  31429. * @param data defines the vertex data to use
  31430. * @param updatable defines if the vertex must be flagged as updatable (false as default)
  31431. * @param stride defines the stride to use (0 by default). This value is deduced from the kind value if not specified
  31432. */
  31433. setVerticesData(kind: string, data: FloatArray, updatable: boolean): void;
  31434. /**
  31435. * Update a specific associated vertex buffer
  31436. * @param kind defines which buffer to write to (positions, indices, normals, etc). Possible `kind` values :
  31437. * - VertexBuffer.PositionKind
  31438. * - VertexBuffer.UVKind
  31439. * - VertexBuffer.UV2Kind
  31440. * - VertexBuffer.UV3Kind
  31441. * - VertexBuffer.UV4Kind
  31442. * - VertexBuffer.UV5Kind
  31443. * - VertexBuffer.UV6Kind
  31444. * - VertexBuffer.ColorKind
  31445. * - VertexBuffer.MatricesIndicesKind
  31446. * - VertexBuffer.MatricesIndicesExtraKind
  31447. * - VertexBuffer.MatricesWeightsKind
  31448. * - VertexBuffer.MatricesWeightsExtraKind
  31449. * @param data defines the data source
  31450. * @param updateExtends defines if extends info of the mesh must be updated (can be null). This is mostly useful for "position" kind
  31451. * @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)
  31452. */
  31453. updateVerticesData(kind: string, data: FloatArray, updateExtends?: boolean, makeItUnique?: boolean): void;
  31454. /**
  31455. * Creates a new index buffer
  31456. * @param indices defines the indices to store in the index buffer
  31457. * @param totalVertices defines the total number of vertices (could be null)
  31458. * @param updatable defines if the index buffer must be flagged as updatable (false by default)
  31459. */
  31460. setIndices(indices: IndicesArray, totalVertices: Nullable<number>, updatable?: boolean): void;
  31461. }
  31462. /**
  31463. * This class contains the various kinds of data on every vertex of a mesh used in determining its shape and appearance
  31464. */
  31465. export class VertexData {
  31466. /**
  31467. * Mesh side orientation : usually the external or front surface
  31468. */
  31469. static readonly FRONTSIDE: number;
  31470. /**
  31471. * Mesh side orientation : usually the internal or back surface
  31472. */
  31473. static readonly BACKSIDE: number;
  31474. /**
  31475. * Mesh side orientation : both internal and external or front and back surfaces
  31476. */
  31477. static readonly DOUBLESIDE: number;
  31478. /**
  31479. * Mesh side orientation : by default, `FRONTSIDE`
  31480. */
  31481. static readonly DEFAULTSIDE: number;
  31482. /**
  31483. * An array of the x, y, z position of each vertex [...., x, y, z, .....]
  31484. */
  31485. positions: Nullable<FloatArray>;
  31486. /**
  31487. * An array of the x, y, z normal vector of each vertex [...., x, y, z, .....]
  31488. */
  31489. normals: Nullable<FloatArray>;
  31490. /**
  31491. * An array of the x, y, z tangent vector of each vertex [...., x, y, z, .....]
  31492. */
  31493. tangents: Nullable<FloatArray>;
  31494. /**
  31495. * An array of u,v which maps a texture image onto each vertex [...., u, v, .....]
  31496. */
  31497. uvs: Nullable<FloatArray>;
  31498. /**
  31499. * A second array of u,v which maps a texture image onto each vertex [...., u, v, .....]
  31500. */
  31501. uvs2: Nullable<FloatArray>;
  31502. /**
  31503. * A third array of u,v which maps a texture image onto each vertex [...., u, v, .....]
  31504. */
  31505. uvs3: Nullable<FloatArray>;
  31506. /**
  31507. * A fourth array of u,v which maps a texture image onto each vertex [...., u, v, .....]
  31508. */
  31509. uvs4: Nullable<FloatArray>;
  31510. /**
  31511. * A fifth array of u,v which maps a texture image onto each vertex [...., u, v, .....]
  31512. */
  31513. uvs5: Nullable<FloatArray>;
  31514. /**
  31515. * A sixth array of u,v which maps a texture image onto each vertex [...., u, v, .....]
  31516. */
  31517. uvs6: Nullable<FloatArray>;
  31518. /**
  31519. * An array of the r, g, b, a, color of each vertex [...., r, g, b, a, .....]
  31520. */
  31521. colors: Nullable<FloatArray>;
  31522. /**
  31523. * 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).
  31524. */
  31525. matricesIndices: Nullable<FloatArray>;
  31526. /**
  31527. * An array containing the list of weights defining the weight of each indexed matrix in the final computation
  31528. */
  31529. matricesWeights: Nullable<FloatArray>;
  31530. /**
  31531. * An array extending the number of possible indices
  31532. */
  31533. matricesIndicesExtra: Nullable<FloatArray>;
  31534. /**
  31535. * An array extending the number of possible weights when the number of indices is extended
  31536. */
  31537. matricesWeightsExtra: Nullable<FloatArray>;
  31538. /**
  31539. * An array of i, j, k the three vertex indices required for each triangular facet [...., i, j, k .....]
  31540. */
  31541. indices: Nullable<IndicesArray>;
  31542. /**
  31543. * Uses the passed data array to set the set the values for the specified kind of data
  31544. * @param data a linear array of floating numbers
  31545. * @param kind the type of data that is being set, eg positions, colors etc
  31546. */
  31547. set(data: FloatArray, kind: string): void;
  31548. /**
  31549. * Associates the vertexData to the passed Mesh.
  31550. * Sets it as updatable or not (default `false`)
  31551. * @param mesh the mesh the vertexData is applied to
  31552. * @param updatable when used and having the value true allows new data to update the vertexData
  31553. * @returns the VertexData
  31554. */
  31555. applyToMesh(mesh: Mesh, updatable?: boolean): VertexData;
  31556. /**
  31557. * Associates the vertexData to the passed Geometry.
  31558. * Sets it as updatable or not (default `false`)
  31559. * @param geometry the geometry the vertexData is applied to
  31560. * @param updatable when used and having the value true allows new data to update the vertexData
  31561. * @returns VertexData
  31562. */
  31563. applyToGeometry(geometry: Geometry, updatable?: boolean): VertexData;
  31564. /**
  31565. * Updates the associated mesh
  31566. * @param mesh the mesh to be updated
  31567. * @param updateExtends when true the mesh BoundingInfo will be renewed when and if position kind is updated, optional with default false
  31568. * @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
  31569. * @returns VertexData
  31570. */
  31571. updateMesh(mesh: Mesh): VertexData;
  31572. /**
  31573. * Updates the associated geometry
  31574. * @param geometry the geometry to be updated
  31575. * @param updateExtends when true BoundingInfo will be renewed when and if position kind is updated, optional with default false
  31576. * @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
  31577. * @returns VertexData.
  31578. */
  31579. updateGeometry(geometry: Geometry): VertexData;
  31580. private _applyTo;
  31581. private _update;
  31582. /**
  31583. * Transforms each position and each normal of the vertexData according to the passed Matrix
  31584. * @param matrix the transforming matrix
  31585. * @returns the VertexData
  31586. */
  31587. transform(matrix: Matrix): VertexData;
  31588. /**
  31589. * Merges the passed VertexData into the current one
  31590. * @param other the VertexData to be merged into the current one
  31591. * @param use32BitsIndices defines a boolean indicating if indices must be store in a 32 bits array
  31592. * @returns the modified VertexData
  31593. */
  31594. merge(other: VertexData, use32BitsIndices?: boolean): VertexData;
  31595. private _mergeElement;
  31596. private _validate;
  31597. /**
  31598. * Serializes the VertexData
  31599. * @returns a serialized object
  31600. */
  31601. serialize(): any;
  31602. /**
  31603. * Extracts the vertexData from a mesh
  31604. * @param mesh the mesh from which to extract the VertexData
  31605. * @param copyWhenShared defines if the VertexData must be cloned when shared between multiple meshes, optional, default false
  31606. * @param forceCopy indicating that the VertexData must be cloned, optional, default false
  31607. * @returns the object VertexData associated to the passed mesh
  31608. */
  31609. static ExtractFromMesh(mesh: Mesh, copyWhenShared?: boolean, forceCopy?: boolean): VertexData;
  31610. /**
  31611. * Extracts the vertexData from the geometry
  31612. * @param geometry the geometry from which to extract the VertexData
  31613. * @param copyWhenShared defines if the VertexData must be cloned when the geometrty is shared between multiple meshes, optional, default false
  31614. * @param forceCopy indicating that the VertexData must be cloned, optional, default false
  31615. * @returns the object VertexData associated to the passed mesh
  31616. */
  31617. static ExtractFromGeometry(geometry: Geometry, copyWhenShared?: boolean, forceCopy?: boolean): VertexData;
  31618. private static _ExtractFrom;
  31619. /**
  31620. * Creates the VertexData for a Ribbon
  31621. * @param options an object used to set the following optional parameters for the ribbon, required but can be empty
  31622. * * pathArray array of paths, each of which an array of successive Vector3
  31623. * * closeArray creates a seam between the first and the last paths of the pathArray, optional, default false
  31624. * * closePath creates a seam between the first and the last points of each path of the path array, optional, default false
  31625. * * 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
  31626. * * sideOrientation optional and takes the values : Mesh.FRONTSIDE (default), Mesh.BACKSIDE or Mesh.DOUBLESIDE
  31627. * * 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)
  31628. * * 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)
  31629. * * invertUV swaps in the U and V coordinates when applying a texture, optional, default false
  31630. * * uvs a linear array, of length 2 * number of vertices, of custom UV values, optional
  31631. * * colors a linear array, of length 4 * number of vertices, of custom color values, optional
  31632. * @returns the VertexData of the ribbon
  31633. */
  31634. static CreateRibbon(options: {
  31635. pathArray: Vector3[][];
  31636. closeArray?: boolean;
  31637. closePath?: boolean;
  31638. offset?: number;
  31639. sideOrientation?: number;
  31640. frontUVs?: Vector4;
  31641. backUVs?: Vector4;
  31642. invertUV?: boolean;
  31643. uvs?: Vector2[];
  31644. colors?: Color4[];
  31645. }): VertexData;
  31646. /**
  31647. * Creates the VertexData for a box
  31648. * @param options an object used to set the following optional parameters for the box, required but can be empty
  31649. * * size sets the width, height and depth of the box to the value of size, optional default 1
  31650. * * width sets the width (x direction) of the box, overwrites the width set by size, optional, default size
  31651. * * height sets the height (y direction) of the box, overwrites the height set by size, optional, default size
  31652. * * depth sets the depth (z direction) of the box, overwrites the depth set by size, optional, default size
  31653. * * faceUV an array of 6 Vector4 elements used to set different images to each box side
  31654. * * faceColors an array of 6 Color3 elements used to set different colors to each box side
  31655. * * sideOrientation optional and takes the values : Mesh.FRONTSIDE (default), Mesh.BACKSIDE or Mesh.DOUBLESIDE
  31656. * * 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)
  31657. * * 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)
  31658. * @returns the VertexData of the box
  31659. */
  31660. static CreateBox(options: {
  31661. size?: number;
  31662. width?: number;
  31663. height?: number;
  31664. depth?: number;
  31665. faceUV?: Vector4[];
  31666. faceColors?: Color4[];
  31667. sideOrientation?: number;
  31668. frontUVs?: Vector4;
  31669. backUVs?: Vector4;
  31670. }): VertexData;
  31671. /**
  31672. * Creates the VertexData for a tiled box
  31673. * @param options an object used to set the following optional parameters for the box, required but can be empty
  31674. * * faceTiles sets the pattern, tile size and number of tiles for a face
  31675. * * faceUV an array of 6 Vector4 elements used to set different images to each box side
  31676. * * faceColors an array of 6 Color3 elements used to set different colors to each box side
  31677. * * sideOrientation optional and takes the values : Mesh.FRONTSIDE (default), Mesh.BACKSIDE or Mesh.DOUBLESIDE
  31678. * @returns the VertexData of the box
  31679. */
  31680. static CreateTiledBox(options: {
  31681. pattern?: number;
  31682. width?: number;
  31683. height?: number;
  31684. depth?: number;
  31685. tileSize?: number;
  31686. tileWidth?: number;
  31687. tileHeight?: number;
  31688. alignHorizontal?: number;
  31689. alignVertical?: number;
  31690. faceUV?: Vector4[];
  31691. faceColors?: Color4[];
  31692. sideOrientation?: number;
  31693. }): VertexData;
  31694. /**
  31695. * Creates the VertexData for a tiled plane
  31696. * @param options an object used to set the following optional parameters for the box, required but can be empty
  31697. * * pattern a limited pattern arrangement depending on the number
  31698. * * tileSize sets the width, height and depth of the tile to the value of size, optional default 1
  31699. * * tileWidth sets the width (x direction) of the tile, overwrites the width set by size, optional, default size
  31700. * * tileHeight sets the height (y direction) of the tile, overwrites the height set by size, optional, default size
  31701. * * sideOrientation optional and takes the values : Mesh.FRONTSIDE (default), Mesh.BACKSIDE or Mesh.DOUBLESIDE
  31702. * * 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)
  31703. * * 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)
  31704. * @returns the VertexData of the tiled plane
  31705. */
  31706. static CreateTiledPlane(options: {
  31707. pattern?: number;
  31708. tileSize?: number;
  31709. tileWidth?: number;
  31710. tileHeight?: number;
  31711. size?: number;
  31712. width?: number;
  31713. height?: number;
  31714. alignHorizontal?: number;
  31715. alignVertical?: number;
  31716. sideOrientation?: number;
  31717. frontUVs?: Vector4;
  31718. backUVs?: Vector4;
  31719. }): VertexData;
  31720. /**
  31721. * Creates the VertexData for an ellipsoid, defaults to a sphere
  31722. * @param options an object used to set the following optional parameters for the box, required but can be empty
  31723. * * segments sets the number of horizontal strips optional, default 32
  31724. * * diameter sets the axes dimensions, diameterX, diameterY and diameterZ to the value of diameter, optional default 1
  31725. * * diameterX sets the diameterX (x direction) of the ellipsoid, overwrites the diameterX set by diameter, optional, default diameter
  31726. * * diameterY sets the diameterY (y direction) of the ellipsoid, overwrites the diameterY set by diameter, optional, default diameter
  31727. * * diameterZ sets the diameterZ (z direction) of the ellipsoid, overwrites the diameterZ set by diameter, optional, default diameter
  31728. * * 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
  31729. * * 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
  31730. * * sideOrientation optional and takes the values : Mesh.FRONTSIDE (default), Mesh.BACKSIDE or Mesh.DOUBLESIDE
  31731. * * 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)
  31732. * * 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)
  31733. * @returns the VertexData of the ellipsoid
  31734. */
  31735. static CreateSphere(options: {
  31736. segments?: number;
  31737. diameter?: number;
  31738. diameterX?: number;
  31739. diameterY?: number;
  31740. diameterZ?: number;
  31741. arc?: number;
  31742. slice?: number;
  31743. sideOrientation?: number;
  31744. frontUVs?: Vector4;
  31745. backUVs?: Vector4;
  31746. }): VertexData;
  31747. /**
  31748. * Creates the VertexData for a cylinder, cone or prism
  31749. * @param options an object used to set the following optional parameters for the box, required but can be empty
  31750. * * height sets the height (y direction) of the cylinder, optional, default 2
  31751. * * diameterTop sets the diameter of the top of the cone, overwrites diameter, optional, default diameter
  31752. * * diameterBottom sets the diameter of the bottom of the cone, overwrites diameter, optional, default diameter
  31753. * * diameter sets the diameter of the top and bottom of the cone, optional default 1
  31754. * * tessellation the number of prism sides, 3 for a triangular prism, optional, default 24
  31755. * * subdivisions` the number of rings along the cylinder height, optional, default 1
  31756. * * 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
  31757. * * faceColors an array of Color3 elements used to set different colors to the top, rings and bottom respectively
  31758. * * faceUV an array of Vector4 elements used to set different images to the top, rings and bottom respectively
  31759. * * hasRings when true makes each subdivision independantly treated as a face for faceUV and faceColors, optional, default false
  31760. * * enclose when true closes an open cylinder by adding extra flat faces between the height axis and vertical edges, think cut cake
  31761. * * sideOrientation optional and takes the values : Mesh.FRONTSIDE (default), Mesh.BACKSIDE or Mesh.DOUBLESIDE
  31762. * * 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)
  31763. * * 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)
  31764. * @returns the VertexData of the cylinder, cone or prism
  31765. */
  31766. static CreateCylinder(options: {
  31767. height?: number;
  31768. diameterTop?: number;
  31769. diameterBottom?: number;
  31770. diameter?: number;
  31771. tessellation?: number;
  31772. subdivisions?: number;
  31773. arc?: number;
  31774. faceColors?: Color4[];
  31775. faceUV?: Vector4[];
  31776. hasRings?: boolean;
  31777. enclose?: boolean;
  31778. sideOrientation?: number;
  31779. frontUVs?: Vector4;
  31780. backUVs?: Vector4;
  31781. }): VertexData;
  31782. /**
  31783. * Creates the VertexData for a torus
  31784. * @param options an object used to set the following optional parameters for the box, required but can be empty
  31785. * * diameter the diameter of the torus, optional default 1
  31786. * * thickness the diameter of the tube forming the torus, optional default 0.5
  31787. * * tessellation the number of prism sides, 3 for a triangular prism, optional, default 24
  31788. * * sideOrientation optional and takes the values : Mesh.FRONTSIDE (default), Mesh.BACKSIDE or Mesh.DOUBLESIDE
  31789. * * 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)
  31790. * * 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)
  31791. * @returns the VertexData of the torus
  31792. */
  31793. static CreateTorus(options: {
  31794. diameter?: number;
  31795. thickness?: number;
  31796. tessellation?: number;
  31797. sideOrientation?: number;
  31798. frontUVs?: Vector4;
  31799. backUVs?: Vector4;
  31800. }): VertexData;
  31801. /**
  31802. * Creates the VertexData of the LineSystem
  31803. * @param options an object used to set the following optional parameters for the LineSystem, required but can be empty
  31804. * - lines an array of lines, each line being an array of successive Vector3
  31805. * - colors an array of line colors, each of the line colors being an array of successive Color4, one per line point
  31806. * @returns the VertexData of the LineSystem
  31807. */
  31808. static CreateLineSystem(options: {
  31809. lines: Vector3[][];
  31810. colors?: Nullable<Color4[][]>;
  31811. }): VertexData;
  31812. /**
  31813. * Create the VertexData for a DashedLines
  31814. * @param options an object used to set the following optional parameters for the DashedLines, required but can be empty
  31815. * - points an array successive Vector3
  31816. * - dashSize the size of the dashes relative to the dash number, optional, default 3
  31817. * - gapSize the size of the gap between two successive dashes relative to the dash number, optional, default 1
  31818. * - dashNb the intended total number of dashes, optional, default 200
  31819. * @returns the VertexData for the DashedLines
  31820. */
  31821. static CreateDashedLines(options: {
  31822. points: Vector3[];
  31823. dashSize?: number;
  31824. gapSize?: number;
  31825. dashNb?: number;
  31826. }): VertexData;
  31827. /**
  31828. * Creates the VertexData for a Ground
  31829. * @param options an object used to set the following optional parameters for the Ground, required but can be empty
  31830. * - width the width (x direction) of the ground, optional, default 1
  31831. * - height the height (z direction) of the ground, optional, default 1
  31832. * - subdivisions the number of subdivisions per side, optional, default 1
  31833. * @returns the VertexData of the Ground
  31834. */
  31835. static CreateGround(options: {
  31836. width?: number;
  31837. height?: number;
  31838. subdivisions?: number;
  31839. subdivisionsX?: number;
  31840. subdivisionsY?: number;
  31841. }): VertexData;
  31842. /**
  31843. * Creates the VertexData for a TiledGround by subdividing the ground into tiles
  31844. * @param options an object used to set the following optional parameters for the Ground, required but can be empty
  31845. * * xmin the ground minimum X coordinate, optional, default -1
  31846. * * zmin the ground minimum Z coordinate, optional, default -1
  31847. * * xmax the ground maximum X coordinate, optional, default 1
  31848. * * zmax the ground maximum Z coordinate, optional, default 1
  31849. * * 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}
  31850. * * 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}
  31851. * @returns the VertexData of the TiledGround
  31852. */
  31853. static CreateTiledGround(options: {
  31854. xmin: number;
  31855. zmin: number;
  31856. xmax: number;
  31857. zmax: number;
  31858. subdivisions?: {
  31859. w: number;
  31860. h: number;
  31861. };
  31862. precision?: {
  31863. w: number;
  31864. h: number;
  31865. };
  31866. }): VertexData;
  31867. /**
  31868. * Creates the VertexData of the Ground designed from a heightmap
  31869. * @param options an object used to set the following parameters for the Ground, required and provided by MeshBuilder.CreateGroundFromHeightMap
  31870. * * width the width (x direction) of the ground
  31871. * * height the height (z direction) of the ground
  31872. * * subdivisions the number of subdivisions per side
  31873. * * minHeight the minimum altitude on the ground, optional, default 0
  31874. * * maxHeight the maximum altitude on the ground, optional default 1
  31875. * * colorFilter the filter to apply to the image pixel colors to compute the height, optional Color3, default (0.3, 0.59, 0.11)
  31876. * * buffer the array holding the image color data
  31877. * * bufferWidth the width of image
  31878. * * bufferHeight the height of image
  31879. * * alphaFilter Remove any data where the alpha channel is below this value, defaults 0 (all data visible)
  31880. * @returns the VertexData of the Ground designed from a heightmap
  31881. */
  31882. static CreateGroundFromHeightMap(options: {
  31883. width: number;
  31884. height: number;
  31885. subdivisions: number;
  31886. minHeight: number;
  31887. maxHeight: number;
  31888. colorFilter: Color3;
  31889. buffer: Uint8Array;
  31890. bufferWidth: number;
  31891. bufferHeight: number;
  31892. alphaFilter: number;
  31893. }): VertexData;
  31894. /**
  31895. * Creates the VertexData for a Plane
  31896. * @param options an object used to set the following optional parameters for the plane, required but can be empty
  31897. * * size sets the width and height of the plane to the value of size, optional default 1
  31898. * * width sets the width (x direction) of the plane, overwrites the width set by size, optional, default size
  31899. * * height sets the height (y direction) of the plane, overwrites the height set by size, optional, default size
  31900. * * sideOrientation optional and takes the values : Mesh.FRONTSIDE (default), Mesh.BACKSIDE or Mesh.DOUBLESIDE
  31901. * * 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)
  31902. * * 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)
  31903. * @returns the VertexData of the box
  31904. */
  31905. static CreatePlane(options: {
  31906. size?: number;
  31907. width?: number;
  31908. height?: number;
  31909. sideOrientation?: number;
  31910. frontUVs?: Vector4;
  31911. backUVs?: Vector4;
  31912. }): VertexData;
  31913. /**
  31914. * Creates the VertexData of the Disc or regular Polygon
  31915. * @param options an object used to set the following optional parameters for the disc, required but can be empty
  31916. * * radius the radius of the disc, optional default 0.5
  31917. * * tessellation the number of polygon sides, optional, default 64
  31918. * * 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
  31919. * * sideOrientation optional and takes the values : Mesh.FRONTSIDE (default), Mesh.BACKSIDE or Mesh.DOUBLESIDE
  31920. * * 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)
  31921. * * 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)
  31922. * @returns the VertexData of the box
  31923. */
  31924. static CreateDisc(options: {
  31925. radius?: number;
  31926. tessellation?: number;
  31927. arc?: number;
  31928. sideOrientation?: number;
  31929. frontUVs?: Vector4;
  31930. backUVs?: Vector4;
  31931. }): VertexData;
  31932. /**
  31933. * Creates the VertexData for an irregular Polygon in the XoZ plane using a mesh built by polygonTriangulation.build()
  31934. * All parameters are provided by MeshBuilder.CreatePolygon as needed
  31935. * @param polygon a mesh built from polygonTriangulation.build()
  31936. * @param sideOrientation takes the values Mesh.FRONTSIDE (default), Mesh.BACKSIDE or Mesh.DOUBLESIDE
  31937. * @param fUV an array of Vector4 elements used to set different images to the top, rings and bottom respectively
  31938. * @param fColors an array of Color3 elements used to set different colors to the top, rings and bottom respectively
  31939. * @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)
  31940. * @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)
  31941. * @param wrap a boolean, default false, when true and fUVs used texture is wrapped around all sides, when false texture is applied side
  31942. * @returns the VertexData of the Polygon
  31943. */
  31944. static CreatePolygon(polygon: Mesh, sideOrientation: number, fUV?: Vector4[], fColors?: Color4[], frontUVs?: Vector4, backUVs?: Vector4, wrap?: boolean): VertexData;
  31945. /**
  31946. * Creates the VertexData of the IcoSphere
  31947. * @param options an object used to set the following optional parameters for the IcoSphere, required but can be empty
  31948. * * radius the radius of the IcoSphere, optional default 1
  31949. * * radiusX allows stretching in the x direction, optional, default radius
  31950. * * radiusY allows stretching in the y direction, optional, default radius
  31951. * * radiusZ allows stretching in the z direction, optional, default radius
  31952. * * flat when true creates a flat shaded mesh, optional, default true
  31953. * * subdivisions increasing the subdivisions increases the number of faces, optional, default 4
  31954. * * sideOrientation optional and takes the values : Mesh.FRONTSIDE (default), Mesh.BACKSIDE or Mesh.DOUBLESIDE
  31955. * * 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)
  31956. * * 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)
  31957. * @returns the VertexData of the IcoSphere
  31958. */
  31959. static CreateIcoSphere(options: {
  31960. radius?: number;
  31961. radiusX?: number;
  31962. radiusY?: number;
  31963. radiusZ?: number;
  31964. flat?: boolean;
  31965. subdivisions?: number;
  31966. sideOrientation?: number;
  31967. frontUVs?: Vector4;
  31968. backUVs?: Vector4;
  31969. }): VertexData;
  31970. /**
  31971. * Creates the VertexData for a Polyhedron
  31972. * @param options an object used to set the following optional parameters for the polyhedron, required but can be empty
  31973. * * type provided types are:
  31974. * * 0 : Tetrahedron, 1 : Octahedron, 2 : Dodecahedron, 3 : Icosahedron, 4 : Rhombicuboctahedron, 5 : Triangular Prism, 6 : Pentagonal Prism, 7 : Hexagonal Prism, 8 : Square Pyramid (J1)
  31975. * * 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)
  31976. * * size the size of the IcoSphere, optional default 1
  31977. * * sizeX allows stretching in the x direction, optional, default size
  31978. * * sizeY allows stretching in the y direction, optional, default size
  31979. * * sizeZ allows stretching in the z direction, optional, default size
  31980. * * 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
  31981. * * faceUV an array of Vector4 elements used to set different images to the top, rings and bottom respectively
  31982. * * faceColors an array of Color3 elements used to set different colors to the top, rings and bottom respectively
  31983. * * flat when true creates a flat shaded mesh, optional, default true
  31984. * * subdivisions increasing the subdivisions increases the number of faces, optional, default 4
  31985. * * sideOrientation optional and takes the values : Mesh.FRONTSIDE (default), Mesh.BACKSIDE or Mesh.DOUBLESIDE
  31986. * * 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)
  31987. * * 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)
  31988. * @returns the VertexData of the Polyhedron
  31989. */
  31990. static CreatePolyhedron(options: {
  31991. type?: number;
  31992. size?: number;
  31993. sizeX?: number;
  31994. sizeY?: number;
  31995. sizeZ?: number;
  31996. custom?: any;
  31997. faceUV?: Vector4[];
  31998. faceColors?: Color4[];
  31999. flat?: boolean;
  32000. sideOrientation?: number;
  32001. frontUVs?: Vector4;
  32002. backUVs?: Vector4;
  32003. }): VertexData;
  32004. /**
  32005. * Creates the VertexData for a Capsule, inspired from https://github.com/maximeq/three-js-capsule-geometry/blob/master/src/CapsuleBufferGeometry.js
  32006. * @param options an object used to set the following optional parameters for the capsule, required but can be empty
  32007. * @returns the VertexData of the Capsule
  32008. */
  32009. static CreateCapsule(options?: ICreateCapsuleOptions): VertexData;
  32010. /**
  32011. * Creates the VertexData for a TorusKnot
  32012. * @param options an object used to set the following optional parameters for the TorusKnot, required but can be empty
  32013. * * radius the radius of the torus knot, optional, default 2
  32014. * * tube the thickness of the tube, optional, default 0.5
  32015. * * radialSegments the number of sides on each tube segments, optional, default 32
  32016. * * tubularSegments the number of tubes to decompose the knot into, optional, default 32
  32017. * * p the number of windings around the z axis, optional, default 2
  32018. * * q the number of windings around the x axis, optional, default 3
  32019. * * sideOrientation optional and takes the values : Mesh.FRONTSIDE (default), Mesh.BACKSIDE or Mesh.DOUBLESIDE
  32020. * * 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)
  32021. * * 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)
  32022. * @returns the VertexData of the Torus Knot
  32023. */
  32024. static CreateTorusKnot(options: {
  32025. radius?: number;
  32026. tube?: number;
  32027. radialSegments?: number;
  32028. tubularSegments?: number;
  32029. p?: number;
  32030. q?: number;
  32031. sideOrientation?: number;
  32032. frontUVs?: Vector4;
  32033. backUVs?: Vector4;
  32034. }): VertexData;
  32035. /**
  32036. * Compute normals for given positions and indices
  32037. * @param positions an array of vertex positions, [...., x, y, z, ......]
  32038. * @param indices an array of indices in groups of three for each triangular facet, [...., i, j, k, ......]
  32039. * @param normals an array of vertex normals, [...., x, y, z, ......]
  32040. * @param options an object used to set the following optional parameters for the TorusKnot, optional
  32041. * * facetNormals : optional array of facet normals (vector3)
  32042. * * facetPositions : optional array of facet positions (vector3)
  32043. * * facetPartitioning : optional partitioning array. facetPositions is required for facetPartitioning computation
  32044. * * ratio : optional partitioning ratio / bounding box, required for facetPartitioning computation
  32045. * * bInfo : optional bounding info, required for facetPartitioning computation
  32046. * * bbSize : optional bounding box size data, required for facetPartitioning computation
  32047. * * subDiv : optional partitioning data about subdivsions on each axis (int), required for facetPartitioning computation
  32048. * * useRightHandedSystem: optional boolean to for right handed system computation
  32049. * * depthSort : optional boolean to enable the facet depth sort computation
  32050. * * distanceTo : optional Vector3 to compute the facet depth from this location
  32051. * * depthSortedFacets : optional array of depthSortedFacets to store the facet distances from the reference location
  32052. */
  32053. static ComputeNormals(positions: any, indices: any, normals: any, options?: {
  32054. facetNormals?: any;
  32055. facetPositions?: any;
  32056. facetPartitioning?: any;
  32057. ratio?: number;
  32058. bInfo?: any;
  32059. bbSize?: Vector3;
  32060. subDiv?: any;
  32061. useRightHandedSystem?: boolean;
  32062. depthSort?: boolean;
  32063. distanceTo?: Vector3;
  32064. depthSortedFacets?: any;
  32065. }): void;
  32066. /** @hidden */
  32067. static _ComputeSides(sideOrientation: number, positions: FloatArray, indices: FloatArray, normals: FloatArray, uvs: FloatArray, frontUVs?: Vector4, backUVs?: Vector4): void;
  32068. /**
  32069. * Applies VertexData created from the imported parameters to the geometry
  32070. * @param parsedVertexData the parsed data from an imported file
  32071. * @param geometry the geometry to apply the VertexData to
  32072. */
  32073. static ImportVertexData(parsedVertexData: any, geometry: Geometry): void;
  32074. }
  32075. }
  32076. declare module "babylonjs/Morph/morphTarget" {
  32077. import { IAnimatable } from "babylonjs/Animations/animatable.interface";
  32078. import { Observable } from "babylonjs/Misc/observable";
  32079. import { Nullable, FloatArray } from "babylonjs/types";
  32080. import { Scene } from "babylonjs/scene";
  32081. import { AbstractMesh } from "babylonjs/Meshes/abstractMesh";
  32082. import { AnimationPropertiesOverride } from "babylonjs/Animations/animationPropertiesOverride";
  32083. /**
  32084. * Defines a target to use with MorphTargetManager
  32085. * @see https://doc.babylonjs.com/how_to/how_to_use_morphtargets
  32086. */
  32087. export class MorphTarget implements IAnimatable {
  32088. /** defines the name of the target */
  32089. name: string;
  32090. /**
  32091. * Gets or sets the list of animations
  32092. */
  32093. animations: import("babylonjs/Animations/animation").Animation[];
  32094. private _scene;
  32095. private _positions;
  32096. private _normals;
  32097. private _tangents;
  32098. private _uvs;
  32099. private _influence;
  32100. private _uniqueId;
  32101. /**
  32102. * Observable raised when the influence changes
  32103. */
  32104. onInfluenceChanged: Observable<boolean>;
  32105. /** @hidden */
  32106. _onDataLayoutChanged: Observable<void>;
  32107. /**
  32108. * Gets or sets the influence of this target (ie. its weight in the overall morphing)
  32109. */
  32110. get influence(): number;
  32111. set influence(influence: number);
  32112. /**
  32113. * Gets or sets the id of the morph Target
  32114. */
  32115. id: string;
  32116. private _animationPropertiesOverride;
  32117. /**
  32118. * Gets or sets the animation properties override
  32119. */
  32120. get animationPropertiesOverride(): Nullable<AnimationPropertiesOverride>;
  32121. set animationPropertiesOverride(value: Nullable<AnimationPropertiesOverride>);
  32122. /**
  32123. * Creates a new MorphTarget
  32124. * @param name defines the name of the target
  32125. * @param influence defines the influence to use
  32126. * @param scene defines the scene the morphtarget belongs to
  32127. */
  32128. constructor(
  32129. /** defines the name of the target */
  32130. name: string, influence?: number, scene?: Nullable<Scene>);
  32131. /**
  32132. * Gets the unique ID of this manager
  32133. */
  32134. get uniqueId(): number;
  32135. /**
  32136. * Gets a boolean defining if the target contains position data
  32137. */
  32138. get hasPositions(): boolean;
  32139. /**
  32140. * Gets a boolean defining if the target contains normal data
  32141. */
  32142. get hasNormals(): boolean;
  32143. /**
  32144. * Gets a boolean defining if the target contains tangent data
  32145. */
  32146. get hasTangents(): boolean;
  32147. /**
  32148. * Gets a boolean defining if the target contains texture coordinates data
  32149. */
  32150. get hasUVs(): boolean;
  32151. /**
  32152. * Affects position data to this target
  32153. * @param data defines the position data to use
  32154. */
  32155. setPositions(data: Nullable<FloatArray>): void;
  32156. /**
  32157. * Gets the position data stored in this target
  32158. * @returns a FloatArray containing the position data (or null if not present)
  32159. */
  32160. getPositions(): Nullable<FloatArray>;
  32161. /**
  32162. * Affects normal data to this target
  32163. * @param data defines the normal data to use
  32164. */
  32165. setNormals(data: Nullable<FloatArray>): void;
  32166. /**
  32167. * Gets the normal data stored in this target
  32168. * @returns a FloatArray containing the normal data (or null if not present)
  32169. */
  32170. getNormals(): Nullable<FloatArray>;
  32171. /**
  32172. * Affects tangent data to this target
  32173. * @param data defines the tangent data to use
  32174. */
  32175. setTangents(data: Nullable<FloatArray>): void;
  32176. /**
  32177. * Gets the tangent data stored in this target
  32178. * @returns a FloatArray containing the tangent data (or null if not present)
  32179. */
  32180. getTangents(): Nullable<FloatArray>;
  32181. /**
  32182. * Affects texture coordinates data to this target
  32183. * @param data defines the texture coordinates data to use
  32184. */
  32185. setUVs(data: Nullable<FloatArray>): void;
  32186. /**
  32187. * Gets the texture coordinates data stored in this target
  32188. * @returns a FloatArray containing the texture coordinates data (or null if not present)
  32189. */
  32190. getUVs(): Nullable<FloatArray>;
  32191. /**
  32192. * Clone the current target
  32193. * @returns a new MorphTarget
  32194. */
  32195. clone(): MorphTarget;
  32196. /**
  32197. * Serializes the current target into a Serialization object
  32198. * @returns the serialized object
  32199. */
  32200. serialize(): any;
  32201. /**
  32202. * Returns the string "MorphTarget"
  32203. * @returns "MorphTarget"
  32204. */
  32205. getClassName(): string;
  32206. /**
  32207. * Creates a new target from serialized data
  32208. * @param serializationObject defines the serialized data to use
  32209. * @returns a new MorphTarget
  32210. */
  32211. static Parse(serializationObject: any): MorphTarget;
  32212. /**
  32213. * Creates a MorphTarget from mesh data
  32214. * @param mesh defines the source mesh
  32215. * @param name defines the name to use for the new target
  32216. * @param influence defines the influence to attach to the target
  32217. * @returns a new MorphTarget
  32218. */
  32219. static FromMesh(mesh: AbstractMesh, name?: string, influence?: number): MorphTarget;
  32220. }
  32221. }
  32222. declare module "babylonjs/Morph/morphTargetManager" {
  32223. import { Nullable } from "babylonjs/types";
  32224. import { Scene } from "babylonjs/scene";
  32225. import { MorphTarget } from "babylonjs/Morph/morphTarget";
  32226. /**
  32227. * This class is used to deform meshes using morphing between different targets
  32228. * @see https://doc.babylonjs.com/how_to/how_to_use_morphtargets
  32229. */
  32230. export class MorphTargetManager {
  32231. private _targets;
  32232. private _targetInfluenceChangedObservers;
  32233. private _targetDataLayoutChangedObservers;
  32234. private _activeTargets;
  32235. private _scene;
  32236. private _influences;
  32237. private _supportsNormals;
  32238. private _supportsTangents;
  32239. private _supportsUVs;
  32240. private _vertexCount;
  32241. private _uniqueId;
  32242. private _tempInfluences;
  32243. /**
  32244. * Gets or sets a boolean indicating if normals must be morphed
  32245. */
  32246. enableNormalMorphing: boolean;
  32247. /**
  32248. * Gets or sets a boolean indicating if tangents must be morphed
  32249. */
  32250. enableTangentMorphing: boolean;
  32251. /**
  32252. * Gets or sets a boolean indicating if UV must be morphed
  32253. */
  32254. enableUVMorphing: boolean;
  32255. /**
  32256. * Creates a new MorphTargetManager
  32257. * @param scene defines the current scene
  32258. */
  32259. constructor(scene?: Nullable<Scene>);
  32260. /**
  32261. * Gets the unique ID of this manager
  32262. */
  32263. get uniqueId(): number;
  32264. /**
  32265. * Gets the number of vertices handled by this manager
  32266. */
  32267. get vertexCount(): number;
  32268. /**
  32269. * Gets a boolean indicating if this manager supports morphing of normals
  32270. */
  32271. get supportsNormals(): boolean;
  32272. /**
  32273. * Gets a boolean indicating if this manager supports morphing of tangents
  32274. */
  32275. get supportsTangents(): boolean;
  32276. /**
  32277. * Gets a boolean indicating if this manager supports morphing of texture coordinates
  32278. */
  32279. get supportsUVs(): boolean;
  32280. /**
  32281. * Gets the number of targets stored in this manager
  32282. */
  32283. get numTargets(): number;
  32284. /**
  32285. * Gets the number of influencers (ie. the number of targets with influences > 0)
  32286. */
  32287. get numInfluencers(): number;
  32288. /**
  32289. * Gets the list of influences (one per target)
  32290. */
  32291. get influences(): Float32Array;
  32292. /**
  32293. * Gets the active target at specified index. An active target is a target with an influence > 0
  32294. * @param index defines the index to check
  32295. * @returns the requested target
  32296. */
  32297. getActiveTarget(index: number): MorphTarget;
  32298. /**
  32299. * Gets the target at specified index
  32300. * @param index defines the index to check
  32301. * @returns the requested target
  32302. */
  32303. getTarget(index: number): MorphTarget;
  32304. /**
  32305. * Add a new target to this manager
  32306. * @param target defines the target to add
  32307. */
  32308. addTarget(target: MorphTarget): void;
  32309. /**
  32310. * Removes a target from the manager
  32311. * @param target defines the target to remove
  32312. */
  32313. removeTarget(target: MorphTarget): void;
  32314. /**
  32315. * Clone the current manager
  32316. * @returns a new MorphTargetManager
  32317. */
  32318. clone(): MorphTargetManager;
  32319. /**
  32320. * Serializes the current manager into a Serialization object
  32321. * @returns the serialized object
  32322. */
  32323. serialize(): any;
  32324. private _syncActiveTargets;
  32325. /**
  32326. * Syncrhonize the targets with all the meshes using this morph target manager
  32327. */
  32328. synchronize(): void;
  32329. /**
  32330. * Creates a new MorphTargetManager from serialized data
  32331. * @param serializationObject defines the serialized data
  32332. * @param scene defines the hosting scene
  32333. * @returns the new MorphTargetManager
  32334. */
  32335. static Parse(serializationObject: any, scene: Scene): MorphTargetManager;
  32336. }
  32337. }
  32338. declare module "babylonjs/Meshes/meshLODLevel" {
  32339. import { Mesh } from "babylonjs/Meshes/mesh";
  32340. import { Nullable } from "babylonjs/types";
  32341. /**
  32342. * Class used to represent a specific level of detail of a mesh
  32343. * @see https://doc.babylonjs.com/how_to/how_to_use_lod
  32344. */
  32345. export class MeshLODLevel {
  32346. /** Defines the distance where this level should start being displayed */
  32347. distance: number;
  32348. /** Defines the mesh to use to render this level */
  32349. mesh: Nullable<Mesh>;
  32350. /**
  32351. * Creates a new LOD level
  32352. * @param distance defines the distance where this level should star being displayed
  32353. * @param mesh defines the mesh to use to render this level
  32354. */
  32355. constructor(
  32356. /** Defines the distance where this level should start being displayed */
  32357. distance: number,
  32358. /** Defines the mesh to use to render this level */
  32359. mesh: Nullable<Mesh>);
  32360. }
  32361. }
  32362. declare module "babylonjs/Misc/canvasGenerator" {
  32363. /**
  32364. * Helper class used to generate a canvas to manipulate images
  32365. */
  32366. export class CanvasGenerator {
  32367. /**
  32368. * Create a new canvas (or offscreen canvas depending on the context)
  32369. * @param width defines the expected width
  32370. * @param height defines the expected height
  32371. * @return a new canvas or offscreen canvas
  32372. */
  32373. static CreateCanvas(width: number, height: number): HTMLCanvasElement | OffscreenCanvas;
  32374. }
  32375. }
  32376. declare module "babylonjs/Meshes/groundMesh" {
  32377. import { Scene } from "babylonjs/scene";
  32378. import { Vector3 } from "babylonjs/Maths/math.vector";
  32379. import { Mesh } from "babylonjs/Meshes/mesh";
  32380. /**
  32381. * Mesh representing the gorund
  32382. */
  32383. export class GroundMesh extends Mesh {
  32384. /** If octree should be generated */
  32385. generateOctree: boolean;
  32386. private _heightQuads;
  32387. /** @hidden */
  32388. _subdivisionsX: number;
  32389. /** @hidden */
  32390. _subdivisionsY: number;
  32391. /** @hidden */
  32392. _width: number;
  32393. /** @hidden */
  32394. _height: number;
  32395. /** @hidden */
  32396. _minX: number;
  32397. /** @hidden */
  32398. _maxX: number;
  32399. /** @hidden */
  32400. _minZ: number;
  32401. /** @hidden */
  32402. _maxZ: number;
  32403. constructor(name: string, scene: Scene);
  32404. /**
  32405. * "GroundMesh"
  32406. * @returns "GroundMesh"
  32407. */
  32408. getClassName(): string;
  32409. /**
  32410. * The minimum of x and y subdivisions
  32411. */
  32412. get subdivisions(): number;
  32413. /**
  32414. * X subdivisions
  32415. */
  32416. get subdivisionsX(): number;
  32417. /**
  32418. * Y subdivisions
  32419. */
  32420. get subdivisionsY(): number;
  32421. /**
  32422. * This function will update an octree to help to select the right submeshes for rendering, picking and collision computations.
  32423. * Please note that you must have a decent number of submeshes to get performance improvements when using an octree
  32424. * @param chunksCount the number of subdivisions for x and y
  32425. * @param octreeBlocksSize (Default: 32)
  32426. */
  32427. optimize(chunksCount: number, octreeBlocksSize?: number): void;
  32428. /**
  32429. * Returns a height (y) value in the Worl system :
  32430. * the ground altitude at the coordinates (x, z) expressed in the World system.
  32431. * @param x x coordinate
  32432. * @param z z coordinate
  32433. * @returns the ground y position if (x, z) are outside the ground surface.
  32434. */
  32435. getHeightAtCoordinates(x: number, z: number): number;
  32436. /**
  32437. * Returns a normalized vector (Vector3) orthogonal to the ground
  32438. * at the ground coordinates (x, z) expressed in the World system.
  32439. * @param x x coordinate
  32440. * @param z z coordinate
  32441. * @returns Vector3(0.0, 1.0, 0.0) if (x, z) are outside the ground surface.
  32442. */
  32443. getNormalAtCoordinates(x: number, z: number): Vector3;
  32444. /**
  32445. * Updates the Vector3 passed a reference with a normalized vector orthogonal to the ground
  32446. * at the ground coordinates (x, z) expressed in the World system.
  32447. * Doesn't uptade the reference Vector3 if (x, z) are outside the ground surface.
  32448. * @param x x coordinate
  32449. * @param z z coordinate
  32450. * @param ref vector to store the result
  32451. * @returns the GroundMesh.
  32452. */
  32453. getNormalAtCoordinatesToRef(x: number, z: number, ref: Vector3): GroundMesh;
  32454. /**
  32455. * Force the heights to be recomputed for getHeightAtCoordinates() or getNormalAtCoordinates()
  32456. * if the ground has been updated.
  32457. * This can be used in the render loop.
  32458. * @returns the GroundMesh.
  32459. */
  32460. updateCoordinateHeights(): GroundMesh;
  32461. private _getFacetAt;
  32462. private _initHeightQuads;
  32463. private _computeHeightQuads;
  32464. /**
  32465. * Serializes this ground mesh
  32466. * @param serializationObject object to write serialization to
  32467. */
  32468. serialize(serializationObject: any): void;
  32469. /**
  32470. * Parses a serialized ground mesh
  32471. * @param parsedMesh the serialized mesh
  32472. * @param scene the scene to create the ground mesh in
  32473. * @returns the created ground mesh
  32474. */
  32475. static Parse(parsedMesh: any, scene: Scene): GroundMesh;
  32476. }
  32477. }
  32478. declare module "babylonjs/Physics/physicsJoint" {
  32479. import { Vector3 } from "babylonjs/Maths/math.vector";
  32480. import { IPhysicsEnginePlugin } from "babylonjs/Physics/IPhysicsEngine";
  32481. /**
  32482. * Interface for Physics-Joint data
  32483. * @see https://doc.babylonjs.com/how_to/using_the_physics_engine
  32484. */
  32485. export interface PhysicsJointData {
  32486. /**
  32487. * The main pivot of the joint
  32488. */
  32489. mainPivot?: Vector3;
  32490. /**
  32491. * The connected pivot of the joint
  32492. */
  32493. connectedPivot?: Vector3;
  32494. /**
  32495. * The main axis of the joint
  32496. */
  32497. mainAxis?: Vector3;
  32498. /**
  32499. * The connected axis of the joint
  32500. */
  32501. connectedAxis?: Vector3;
  32502. /**
  32503. * The collision of the joint
  32504. */
  32505. collision?: boolean;
  32506. /**
  32507. * Native Oimo/Cannon/Energy data
  32508. */
  32509. nativeParams?: any;
  32510. }
  32511. /**
  32512. * This is a holder class for the physics joint created by the physics plugin
  32513. * It holds a set of functions to control the underlying joint
  32514. * @see https://doc.babylonjs.com/how_to/using_the_physics_engine
  32515. */
  32516. export class PhysicsJoint {
  32517. /**
  32518. * The type of the physics joint
  32519. */
  32520. type: number;
  32521. /**
  32522. * The data for the physics joint
  32523. */
  32524. jointData: PhysicsJointData;
  32525. private _physicsJoint;
  32526. protected _physicsPlugin: IPhysicsEnginePlugin;
  32527. /**
  32528. * Initializes the physics joint
  32529. * @param type The type of the physics joint
  32530. * @param jointData The data for the physics joint
  32531. */
  32532. constructor(
  32533. /**
  32534. * The type of the physics joint
  32535. */
  32536. type: number,
  32537. /**
  32538. * The data for the physics joint
  32539. */
  32540. jointData: PhysicsJointData);
  32541. /**
  32542. * Gets the physics joint
  32543. */
  32544. get physicsJoint(): any;
  32545. /**
  32546. * Sets the physics joint
  32547. */
  32548. set physicsJoint(newJoint: any);
  32549. /**
  32550. * Sets the physics plugin
  32551. */
  32552. set physicsPlugin(physicsPlugin: IPhysicsEnginePlugin);
  32553. /**
  32554. * Execute a function that is physics-plugin specific.
  32555. * @param {Function} func the function that will be executed.
  32556. * It accepts two parameters: the physics world and the physics joint
  32557. */
  32558. executeNativeFunction(func: (world: any, physicsJoint: any) => void): void;
  32559. /**
  32560. * Distance-Joint type
  32561. */
  32562. static DistanceJoint: number;
  32563. /**
  32564. * Hinge-Joint type
  32565. */
  32566. static HingeJoint: number;
  32567. /**
  32568. * Ball-and-Socket joint type
  32569. */
  32570. static BallAndSocketJoint: number;
  32571. /**
  32572. * Wheel-Joint type
  32573. */
  32574. static WheelJoint: number;
  32575. /**
  32576. * Slider-Joint type
  32577. */
  32578. static SliderJoint: number;
  32579. /**
  32580. * Prismatic-Joint type
  32581. */
  32582. static PrismaticJoint: number;
  32583. /**
  32584. * Universal-Joint type
  32585. * ENERGY FTW! (compare with this - @see http://ode-wiki.org/wiki/index.php?title=Manual:_Joint_Types_and_Functions)
  32586. */
  32587. static UniversalJoint: number;
  32588. /**
  32589. * Hinge-Joint 2 type
  32590. */
  32591. static Hinge2Joint: number;
  32592. /**
  32593. * Point to Point Joint type. Similar to a Ball-Joint. Different in parameters
  32594. */
  32595. static PointToPointJoint: number;
  32596. /**
  32597. * Spring-Joint type
  32598. */
  32599. static SpringJoint: number;
  32600. /**
  32601. * Lock-Joint type
  32602. */
  32603. static LockJoint: number;
  32604. }
  32605. /**
  32606. * A class representing a physics distance joint
  32607. * @see https://doc.babylonjs.com/how_to/using_the_physics_engine
  32608. */
  32609. export class DistanceJoint extends PhysicsJoint {
  32610. /**
  32611. *
  32612. * @param jointData The data for the Distance-Joint
  32613. */
  32614. constructor(jointData: DistanceJointData);
  32615. /**
  32616. * Update the predefined distance.
  32617. * @param maxDistance The maximum preferred distance
  32618. * @param minDistance The minimum preferred distance
  32619. */
  32620. updateDistance(maxDistance: number, minDistance?: number): void;
  32621. }
  32622. /**
  32623. * Represents a Motor-Enabled Joint
  32624. * @see https://doc.babylonjs.com/how_to/using_the_physics_engine
  32625. */
  32626. export class MotorEnabledJoint extends PhysicsJoint implements IMotorEnabledJoint {
  32627. /**
  32628. * Initializes the Motor-Enabled Joint
  32629. * @param type The type of the joint
  32630. * @param jointData The physica joint data for the joint
  32631. */
  32632. constructor(type: number, jointData: PhysicsJointData);
  32633. /**
  32634. * Set the motor values.
  32635. * Attention, this function is plugin specific. Engines won't react 100% the same.
  32636. * @param force the force to apply
  32637. * @param maxForce max force for this motor.
  32638. */
  32639. setMotor(force?: number, maxForce?: number): void;
  32640. /**
  32641. * Set the motor's limits.
  32642. * Attention, this function is plugin specific. Engines won't react 100% the same.
  32643. * @param upperLimit The upper limit of the motor
  32644. * @param lowerLimit The lower limit of the motor
  32645. */
  32646. setLimit(upperLimit: number, lowerLimit?: number): void;
  32647. }
  32648. /**
  32649. * This class represents a single physics Hinge-Joint
  32650. * @see https://doc.babylonjs.com/how_to/using_the_physics_engine
  32651. */
  32652. export class HingeJoint extends MotorEnabledJoint {
  32653. /**
  32654. * Initializes the Hinge-Joint
  32655. * @param jointData The joint data for the Hinge-Joint
  32656. */
  32657. constructor(jointData: PhysicsJointData);
  32658. /**
  32659. * Set the motor values.
  32660. * Attention, this function is plugin specific. Engines won't react 100% the same.
  32661. * @param {number} force the force to apply
  32662. * @param {number} maxForce max force for this motor.
  32663. */
  32664. setMotor(force?: number, maxForce?: number): void;
  32665. /**
  32666. * Set the motor's limits.
  32667. * Attention, this function is plugin specific. Engines won't react 100% the same.
  32668. * @param upperLimit The upper limit of the motor
  32669. * @param lowerLimit The lower limit of the motor
  32670. */
  32671. setLimit(upperLimit: number, lowerLimit?: number): void;
  32672. }
  32673. /**
  32674. * This class represents a dual hinge physics joint (same as wheel joint)
  32675. * @see https://doc.babylonjs.com/how_to/using_the_physics_engine
  32676. */
  32677. export class Hinge2Joint extends MotorEnabledJoint {
  32678. /**
  32679. * Initializes the Hinge2-Joint
  32680. * @param jointData The joint data for the Hinge2-Joint
  32681. */
  32682. constructor(jointData: PhysicsJointData);
  32683. /**
  32684. * Set the motor values.
  32685. * Attention, this function is plugin specific. Engines won't react 100% the same.
  32686. * @param {number} targetSpeed the speed the motor is to reach
  32687. * @param {number} maxForce max force for this motor.
  32688. * @param {motorIndex} the motor's index, 0 or 1.
  32689. */
  32690. setMotor(targetSpeed?: number, maxForce?: number, motorIndex?: number): void;
  32691. /**
  32692. * Set the motor limits.
  32693. * Attention, this function is plugin specific. Engines won't react 100% the same.
  32694. * @param {number} upperLimit the upper limit
  32695. * @param {number} lowerLimit lower limit
  32696. * @param {motorIndex} the motor's index, 0 or 1.
  32697. */
  32698. setLimit(upperLimit: number, lowerLimit?: number, motorIndex?: number): void;
  32699. }
  32700. /**
  32701. * Interface for a motor enabled joint
  32702. * @see https://doc.babylonjs.com/how_to/using_the_physics_engine
  32703. */
  32704. export interface IMotorEnabledJoint {
  32705. /**
  32706. * Physics joint
  32707. */
  32708. physicsJoint: any;
  32709. /**
  32710. * Sets the motor of the motor-enabled joint
  32711. * @param force The force of the motor
  32712. * @param maxForce The maximum force of the motor
  32713. * @param motorIndex The index of the motor
  32714. */
  32715. setMotor(force?: number, maxForce?: number, motorIndex?: number): void;
  32716. /**
  32717. * Sets the limit of the motor
  32718. * @param upperLimit The upper limit of the motor
  32719. * @param lowerLimit The lower limit of the motor
  32720. * @param motorIndex The index of the motor
  32721. */
  32722. setLimit(upperLimit: number, lowerLimit?: number, motorIndex?: number): void;
  32723. }
  32724. /**
  32725. * Joint data for a Distance-Joint
  32726. * @see https://doc.babylonjs.com/how_to/using_the_physics_engine
  32727. */
  32728. export interface DistanceJointData extends PhysicsJointData {
  32729. /**
  32730. * Max distance the 2 joint objects can be apart
  32731. */
  32732. maxDistance: number;
  32733. }
  32734. /**
  32735. * Joint data from a spring joint
  32736. * @see https://doc.babylonjs.com/how_to/using_the_physics_engine
  32737. */
  32738. export interface SpringJointData extends PhysicsJointData {
  32739. /**
  32740. * Length of the spring
  32741. */
  32742. length: number;
  32743. /**
  32744. * Stiffness of the spring
  32745. */
  32746. stiffness: number;
  32747. /**
  32748. * Damping of the spring
  32749. */
  32750. damping: number;
  32751. /** this callback will be called when applying the force to the impostors. */
  32752. forceApplicationCallback: () => void;
  32753. }
  32754. }
  32755. declare module "babylonjs/Physics/physicsRaycastResult" {
  32756. import { Vector3 } from "babylonjs/Maths/math.vector";
  32757. /**
  32758. * Holds the data for the raycast result
  32759. * @see https://doc.babylonjs.com/how_to/using_the_physics_engine
  32760. */
  32761. export class PhysicsRaycastResult {
  32762. private _hasHit;
  32763. private _hitDistance;
  32764. private _hitNormalWorld;
  32765. private _hitPointWorld;
  32766. private _rayFromWorld;
  32767. private _rayToWorld;
  32768. /**
  32769. * Gets if there was a hit
  32770. */
  32771. get hasHit(): boolean;
  32772. /**
  32773. * Gets the distance from the hit
  32774. */
  32775. get hitDistance(): number;
  32776. /**
  32777. * Gets the hit normal/direction in the world
  32778. */
  32779. get hitNormalWorld(): Vector3;
  32780. /**
  32781. * Gets the hit point in the world
  32782. */
  32783. get hitPointWorld(): Vector3;
  32784. /**
  32785. * Gets the ray "start point" of the ray in the world
  32786. */
  32787. get rayFromWorld(): Vector3;
  32788. /**
  32789. * Gets the ray "end point" of the ray in the world
  32790. */
  32791. get rayToWorld(): Vector3;
  32792. /**
  32793. * Sets the hit data (normal & point in world space)
  32794. * @param hitNormalWorld defines the normal in world space
  32795. * @param hitPointWorld defines the point in world space
  32796. */
  32797. setHitData(hitNormalWorld: IXYZ, hitPointWorld: IXYZ): void;
  32798. /**
  32799. * Sets the distance from the start point to the hit point
  32800. * @param distance
  32801. */
  32802. setHitDistance(distance: number): void;
  32803. /**
  32804. * Calculates the distance manually
  32805. */
  32806. calculateHitDistance(): void;
  32807. /**
  32808. * Resets all the values to default
  32809. * @param from The from point on world space
  32810. * @param to The to point on world space
  32811. */
  32812. reset(from?: Vector3, to?: Vector3): void;
  32813. }
  32814. /**
  32815. * Interface for the size containing width and height
  32816. */
  32817. interface IXYZ {
  32818. /**
  32819. * X
  32820. */
  32821. x: number;
  32822. /**
  32823. * Y
  32824. */
  32825. y: number;
  32826. /**
  32827. * Z
  32828. */
  32829. z: number;
  32830. }
  32831. }
  32832. declare module "babylonjs/Physics/IPhysicsEngine" {
  32833. import { Nullable } from "babylonjs/types";
  32834. import { Vector3, Quaternion } from "babylonjs/Maths/math.vector";
  32835. import { AbstractMesh } from "babylonjs/Meshes/abstractMesh";
  32836. import { PhysicsImpostor, IPhysicsEnabledObject } from "babylonjs/Physics/physicsImpostor";
  32837. import { PhysicsJoint, IMotorEnabledJoint } from "babylonjs/Physics/physicsJoint";
  32838. import { PhysicsRaycastResult } from "babylonjs/Physics/physicsRaycastResult";
  32839. /**
  32840. * Interface used to describe a physics joint
  32841. */
  32842. export interface PhysicsImpostorJoint {
  32843. /** Defines the main impostor to which the joint is linked */
  32844. mainImpostor: PhysicsImpostor;
  32845. /** Defines the impostor that is connected to the main impostor using this joint */
  32846. connectedImpostor: PhysicsImpostor;
  32847. /** Defines the joint itself */
  32848. joint: PhysicsJoint;
  32849. }
  32850. /** @hidden */
  32851. export interface IPhysicsEnginePlugin {
  32852. world: any;
  32853. name: string;
  32854. setGravity(gravity: Vector3): void;
  32855. setTimeStep(timeStep: number): void;
  32856. getTimeStep(): number;
  32857. executeStep(delta: number, impostors: Array<PhysicsImpostor>): void;
  32858. applyImpulse(impostor: PhysicsImpostor, force: Vector3, contactPoint: Vector3): void;
  32859. applyForce(impostor: PhysicsImpostor, force: Vector3, contactPoint: Vector3): void;
  32860. generatePhysicsBody(impostor: PhysicsImpostor): void;
  32861. removePhysicsBody(impostor: PhysicsImpostor): void;
  32862. generateJoint(joint: PhysicsImpostorJoint): void;
  32863. removeJoint(joint: PhysicsImpostorJoint): void;
  32864. isSupported(): boolean;
  32865. setTransformationFromPhysicsBody(impostor: PhysicsImpostor): void;
  32866. setPhysicsBodyTransformation(impostor: PhysicsImpostor, newPosition: Vector3, newRotation: Quaternion): void;
  32867. setLinearVelocity(impostor: PhysicsImpostor, velocity: Nullable<Vector3>): void;
  32868. setAngularVelocity(impostor: PhysicsImpostor, velocity: Nullable<Vector3>): void;
  32869. getLinearVelocity(impostor: PhysicsImpostor): Nullable<Vector3>;
  32870. getAngularVelocity(impostor: PhysicsImpostor): Nullable<Vector3>;
  32871. setBodyMass(impostor: PhysicsImpostor, mass: number): void;
  32872. getBodyMass(impostor: PhysicsImpostor): number;
  32873. getBodyFriction(impostor: PhysicsImpostor): number;
  32874. setBodyFriction(impostor: PhysicsImpostor, friction: number): void;
  32875. getBodyRestitution(impostor: PhysicsImpostor): number;
  32876. setBodyRestitution(impostor: PhysicsImpostor, restitution: number): void;
  32877. getBodyPressure?(impostor: PhysicsImpostor): number;
  32878. setBodyPressure?(impostor: PhysicsImpostor, pressure: number): void;
  32879. getBodyStiffness?(impostor: PhysicsImpostor): number;
  32880. setBodyStiffness?(impostor: PhysicsImpostor, stiffness: number): void;
  32881. getBodyVelocityIterations?(impostor: PhysicsImpostor): number;
  32882. setBodyVelocityIterations?(impostor: PhysicsImpostor, velocityIterations: number): void;
  32883. getBodyPositionIterations?(impostor: PhysicsImpostor): number;
  32884. setBodyPositionIterations?(impostor: PhysicsImpostor, positionIterations: number): void;
  32885. appendAnchor?(impostor: PhysicsImpostor, otherImpostor: PhysicsImpostor, width: number, height: number, influence: number, noCollisionBetweenLinkedBodies: boolean): void;
  32886. appendHook?(impostor: PhysicsImpostor, otherImpostor: PhysicsImpostor, length: number, influence: number, noCollisionBetweenLinkedBodies: boolean): void;
  32887. sleepBody(impostor: PhysicsImpostor): void;
  32888. wakeUpBody(impostor: PhysicsImpostor): void;
  32889. raycast(from: Vector3, to: Vector3): PhysicsRaycastResult;
  32890. updateDistanceJoint(joint: PhysicsJoint, maxDistance: number, minDistance?: number): void;
  32891. setMotor(joint: IMotorEnabledJoint, speed: number, maxForce?: number, motorIndex?: number): void;
  32892. setLimit(joint: IMotorEnabledJoint, upperLimit: number, lowerLimit?: number, motorIndex?: number): void;
  32893. getRadius(impostor: PhysicsImpostor): number;
  32894. getBoxSizeToRef(impostor: PhysicsImpostor, result: Vector3): void;
  32895. syncMeshWithImpostor(mesh: AbstractMesh, impostor: PhysicsImpostor): void;
  32896. dispose(): void;
  32897. }
  32898. /**
  32899. * Interface used to define a physics engine
  32900. * @see https://doc.babylonjs.com/how_to/using_the_physics_engine
  32901. */
  32902. export interface IPhysicsEngine {
  32903. /**
  32904. * Gets the gravity vector used by the simulation
  32905. */
  32906. gravity: Vector3;
  32907. /**
  32908. * Sets the gravity vector used by the simulation
  32909. * @param gravity defines the gravity vector to use
  32910. */
  32911. setGravity(gravity: Vector3): void;
  32912. /**
  32913. * Set the time step of the physics engine.
  32914. * Default is 1/60.
  32915. * To slow it down, enter 1/600 for example.
  32916. * To speed it up, 1/30
  32917. * @param newTimeStep the new timestep to apply to this world.
  32918. */
  32919. setTimeStep(newTimeStep: number): void;
  32920. /**
  32921. * Get the time step of the physics engine.
  32922. * @returns the current time step
  32923. */
  32924. getTimeStep(): number;
  32925. /**
  32926. * Set the sub time step of the physics engine.
  32927. * Default is 0 meaning there is no sub steps
  32928. * To increase physics resolution precision, set a small value (like 1 ms)
  32929. * @param subTimeStep defines the new sub timestep used for physics resolution.
  32930. */
  32931. setSubTimeStep(subTimeStep: number): void;
  32932. /**
  32933. * Get the sub time step of the physics engine.
  32934. * @returns the current sub time step
  32935. */
  32936. getSubTimeStep(): number;
  32937. /**
  32938. * Release all resources
  32939. */
  32940. dispose(): void;
  32941. /**
  32942. * Gets the name of the current physics plugin
  32943. * @returns the name of the plugin
  32944. */
  32945. getPhysicsPluginName(): string;
  32946. /**
  32947. * Adding a new impostor for the impostor tracking.
  32948. * This will be done by the impostor itself.
  32949. * @param impostor the impostor to add
  32950. */
  32951. addImpostor(impostor: PhysicsImpostor): void;
  32952. /**
  32953. * Remove an impostor from the engine.
  32954. * This impostor and its mesh will not longer be updated by the physics engine.
  32955. * @param impostor the impostor to remove
  32956. */
  32957. removeImpostor(impostor: PhysicsImpostor): void;
  32958. /**
  32959. * Add a joint to the physics engine
  32960. * @param mainImpostor defines the main impostor to which the joint is added.
  32961. * @param connectedImpostor defines the impostor that is connected to the main impostor using this joint
  32962. * @param joint defines the joint that will connect both impostors.
  32963. */
  32964. addJoint(mainImpostor: PhysicsImpostor, connectedImpostor: PhysicsImpostor, joint: PhysicsJoint): void;
  32965. /**
  32966. * Removes a joint from the simulation
  32967. * @param mainImpostor defines the impostor used with the joint
  32968. * @param connectedImpostor defines the other impostor connected to the main one by the joint
  32969. * @param joint defines the joint to remove
  32970. */
  32971. removeJoint(mainImpostor: PhysicsImpostor, connectedImpostor: PhysicsImpostor, joint: PhysicsJoint): void;
  32972. /**
  32973. * Gets the current plugin used to run the simulation
  32974. * @returns current plugin
  32975. */
  32976. getPhysicsPlugin(): IPhysicsEnginePlugin;
  32977. /**
  32978. * Gets the list of physic impostors
  32979. * @returns an array of PhysicsImpostor
  32980. */
  32981. getImpostors(): Array<PhysicsImpostor>;
  32982. /**
  32983. * Gets the impostor for a physics enabled object
  32984. * @param object defines the object impersonated by the impostor
  32985. * @returns the PhysicsImpostor or null if not found
  32986. */
  32987. getImpostorForPhysicsObject(object: IPhysicsEnabledObject): Nullable<PhysicsImpostor>;
  32988. /**
  32989. * Gets the impostor for a physics body object
  32990. * @param body defines physics body used by the impostor
  32991. * @returns the PhysicsImpostor or null if not found
  32992. */
  32993. getImpostorWithPhysicsBody(body: any): Nullable<PhysicsImpostor>;
  32994. /**
  32995. * Does a raycast in the physics world
  32996. * @param from when should the ray start?
  32997. * @param to when should the ray end?
  32998. * @returns PhysicsRaycastResult
  32999. */
  33000. raycast(from: Vector3, to: Vector3): PhysicsRaycastResult;
  33001. /**
  33002. * Called by the scene. No need to call it.
  33003. * @param delta defines the timespam between frames
  33004. */
  33005. _step(delta: number): void;
  33006. }
  33007. }
  33008. declare module "babylonjs/Physics/physicsImpostor" {
  33009. import { Nullable, IndicesArray } from "babylonjs/types";
  33010. import { Vector3, Matrix, Quaternion } from "babylonjs/Maths/math.vector";
  33011. import { TransformNode } from "babylonjs/Meshes/transformNode";
  33012. import { AbstractMesh } from "babylonjs/Meshes/abstractMesh";
  33013. import { Scene } from "babylonjs/scene";
  33014. import { Bone } from "babylonjs/Bones/bone";
  33015. import { BoundingInfo } from "babylonjs/Culling/boundingInfo";
  33016. import { PhysicsJoint, PhysicsJointData } from "babylonjs/Physics/physicsJoint";
  33017. import { Space } from "babylonjs/Maths/math.axis";
  33018. /**
  33019. * The interface for the physics imposter parameters
  33020. * @see https://doc.babylonjs.com/how_to/using_the_physics_engine
  33021. */
  33022. export interface PhysicsImpostorParameters {
  33023. /**
  33024. * The mass of the physics imposter
  33025. */
  33026. mass: number;
  33027. /**
  33028. * The friction of the physics imposter
  33029. */
  33030. friction?: number;
  33031. /**
  33032. * The coefficient of restitution of the physics imposter
  33033. */
  33034. restitution?: number;
  33035. /**
  33036. * The native options of the physics imposter
  33037. */
  33038. nativeOptions?: any;
  33039. /**
  33040. * Specifies if the parent should be ignored
  33041. */
  33042. ignoreParent?: boolean;
  33043. /**
  33044. * Specifies if bi-directional transformations should be disabled
  33045. */
  33046. disableBidirectionalTransformation?: boolean;
  33047. /**
  33048. * The pressure inside the physics imposter, soft object only
  33049. */
  33050. pressure?: number;
  33051. /**
  33052. * The stiffness the physics imposter, soft object only
  33053. */
  33054. stiffness?: number;
  33055. /**
  33056. * The number of iterations used in maintaining consistent vertex velocities, soft object only
  33057. */
  33058. velocityIterations?: number;
  33059. /**
  33060. * The number of iterations used in maintaining consistent vertex positions, soft object only
  33061. */
  33062. positionIterations?: number;
  33063. /**
  33064. * The number used to fix points on a cloth (0, 1, 2, 4, 8) or rope (0, 1, 2) only
  33065. * 0 None, 1, back left or top, 2, back right or bottom, 4, front left, 8, front right
  33066. * Add to fix multiple points
  33067. */
  33068. fixedPoints?: number;
  33069. /**
  33070. * The collision margin around a soft object
  33071. */
  33072. margin?: number;
  33073. /**
  33074. * The collision margin around a soft object
  33075. */
  33076. damping?: number;
  33077. /**
  33078. * The path for a rope based on an extrusion
  33079. */
  33080. path?: any;
  33081. /**
  33082. * The shape of an extrusion used for a rope based on an extrusion
  33083. */
  33084. shape?: any;
  33085. }
  33086. /**
  33087. * Interface for a physics-enabled object
  33088. * @see https://doc.babylonjs.com/how_to/using_the_physics_engine
  33089. */
  33090. export interface IPhysicsEnabledObject {
  33091. /**
  33092. * The position of the physics-enabled object
  33093. */
  33094. position: Vector3;
  33095. /**
  33096. * The rotation of the physics-enabled object
  33097. */
  33098. rotationQuaternion: Nullable<Quaternion>;
  33099. /**
  33100. * The scale of the physics-enabled object
  33101. */
  33102. scaling: Vector3;
  33103. /**
  33104. * The rotation of the physics-enabled object
  33105. */
  33106. rotation?: Vector3;
  33107. /**
  33108. * The parent of the physics-enabled object
  33109. */
  33110. parent?: any;
  33111. /**
  33112. * The bounding info of the physics-enabled object
  33113. * @returns The bounding info of the physics-enabled object
  33114. */
  33115. getBoundingInfo(): BoundingInfo;
  33116. /**
  33117. * Computes the world matrix
  33118. * @param force Specifies if the world matrix should be computed by force
  33119. * @returns A world matrix
  33120. */
  33121. computeWorldMatrix(force: boolean): Matrix;
  33122. /**
  33123. * Gets the world matrix
  33124. * @returns A world matrix
  33125. */
  33126. getWorldMatrix?(): Matrix;
  33127. /**
  33128. * Gets the child meshes
  33129. * @param directDescendantsOnly Specifies if only direct-descendants should be obtained
  33130. * @returns An array of abstract meshes
  33131. */
  33132. getChildMeshes?(directDescendantsOnly?: boolean): Array<AbstractMesh>;
  33133. /**
  33134. * Gets the vertex data
  33135. * @param kind The type of vertex data
  33136. * @returns A nullable array of numbers, or a float32 array
  33137. */
  33138. getVerticesData(kind: string): Nullable<Array<number> | Float32Array>;
  33139. /**
  33140. * Gets the indices from the mesh
  33141. * @returns A nullable array of index arrays
  33142. */
  33143. getIndices?(): Nullable<IndicesArray>;
  33144. /**
  33145. * Gets the scene from the mesh
  33146. * @returns the indices array or null
  33147. */
  33148. getScene?(): Scene;
  33149. /**
  33150. * Gets the absolute position from the mesh
  33151. * @returns the absolute position
  33152. */
  33153. getAbsolutePosition(): Vector3;
  33154. /**
  33155. * Gets the absolute pivot point from the mesh
  33156. * @returns the absolute pivot point
  33157. */
  33158. getAbsolutePivotPoint(): Vector3;
  33159. /**
  33160. * Rotates the mesh
  33161. * @param axis The axis of rotation
  33162. * @param amount The amount of rotation
  33163. * @param space The space of the rotation
  33164. * @returns The rotation transform node
  33165. */
  33166. rotate(axis: Vector3, amount: number, space?: Space): TransformNode;
  33167. /**
  33168. * Translates the mesh
  33169. * @param axis The axis of translation
  33170. * @param distance The distance of translation
  33171. * @param space The space of the translation
  33172. * @returns The transform node
  33173. */
  33174. translate(axis: Vector3, distance: number, space?: Space): TransformNode;
  33175. /**
  33176. * Sets the absolute position of the mesh
  33177. * @param absolutePosition The absolute position of the mesh
  33178. * @returns The transform node
  33179. */
  33180. setAbsolutePosition(absolutePosition: Vector3): TransformNode;
  33181. /**
  33182. * Gets the class name of the mesh
  33183. * @returns The class name
  33184. */
  33185. getClassName(): string;
  33186. }
  33187. /**
  33188. * Represents a physics imposter
  33189. * @see https://doc.babylonjs.com/how_to/using_the_physics_engine
  33190. */
  33191. export class PhysicsImpostor {
  33192. /**
  33193. * The physics-enabled object used as the physics imposter
  33194. */
  33195. object: IPhysicsEnabledObject;
  33196. /**
  33197. * The type of the physics imposter
  33198. */
  33199. type: number;
  33200. private _options;
  33201. private _scene?;
  33202. /**
  33203. * The default object size of the imposter
  33204. */
  33205. static DEFAULT_OBJECT_SIZE: Vector3;
  33206. /**
  33207. * The identity quaternion of the imposter
  33208. */
  33209. static IDENTITY_QUATERNION: Quaternion;
  33210. /** @hidden */
  33211. _pluginData: any;
  33212. private _physicsEngine;
  33213. private _physicsBody;
  33214. private _bodyUpdateRequired;
  33215. private _onBeforePhysicsStepCallbacks;
  33216. private _onAfterPhysicsStepCallbacks;
  33217. /** @hidden */
  33218. _onPhysicsCollideCallbacks: Array<{
  33219. callback: (collider: PhysicsImpostor, collidedAgainst: PhysicsImpostor, point: Nullable<Vector3>) => void;
  33220. otherImpostors: Array<PhysicsImpostor>;
  33221. }>;
  33222. private _deltaPosition;
  33223. private _deltaRotation;
  33224. private _deltaRotationConjugated;
  33225. /** @hidden */
  33226. _isFromLine: boolean;
  33227. private _parent;
  33228. private _isDisposed;
  33229. private static _tmpVecs;
  33230. private static _tmpQuat;
  33231. /**
  33232. * Specifies if the physics imposter is disposed
  33233. */
  33234. get isDisposed(): boolean;
  33235. /**
  33236. * Gets the mass of the physics imposter
  33237. */
  33238. get mass(): number;
  33239. set mass(value: number);
  33240. /**
  33241. * Gets the coefficient of friction
  33242. */
  33243. get friction(): number;
  33244. /**
  33245. * Sets the coefficient of friction
  33246. */
  33247. set friction(value: number);
  33248. /**
  33249. * Gets the coefficient of restitution
  33250. */
  33251. get restitution(): number;
  33252. /**
  33253. * Sets the coefficient of restitution
  33254. */
  33255. set restitution(value: number);
  33256. /**
  33257. * Gets the pressure of a soft body; only supported by the AmmoJSPlugin
  33258. */
  33259. get pressure(): number;
  33260. /**
  33261. * Sets the pressure of a soft body; only supported by the AmmoJSPlugin
  33262. */
  33263. set pressure(value: number);
  33264. /**
  33265. * Gets the stiffness of a soft body; only supported by the AmmoJSPlugin
  33266. */
  33267. get stiffness(): number;
  33268. /**
  33269. * Sets the stiffness of a soft body; only supported by the AmmoJSPlugin
  33270. */
  33271. set stiffness(value: number);
  33272. /**
  33273. * Gets the velocityIterations of a soft body; only supported by the AmmoJSPlugin
  33274. */
  33275. get velocityIterations(): number;
  33276. /**
  33277. * Sets the velocityIterations of a soft body; only supported by the AmmoJSPlugin
  33278. */
  33279. set velocityIterations(value: number);
  33280. /**
  33281. * Gets the positionIterations of a soft body; only supported by the AmmoJSPlugin
  33282. */
  33283. get positionIterations(): number;
  33284. /**
  33285. * Sets the positionIterations of a soft body; only supported by the AmmoJSPlugin
  33286. */
  33287. set positionIterations(value: number);
  33288. /**
  33289. * The unique id of the physics imposter
  33290. * set by the physics engine when adding this impostor to the array
  33291. */
  33292. uniqueId: number;
  33293. /**
  33294. * @hidden
  33295. */
  33296. soft: boolean;
  33297. /**
  33298. * @hidden
  33299. */
  33300. segments: number;
  33301. private _joints;
  33302. /**
  33303. * Initializes the physics imposter
  33304. * @param object The physics-enabled object used as the physics imposter
  33305. * @param type The type of the physics imposter
  33306. * @param _options The options for the physics imposter
  33307. * @param _scene The Babylon scene
  33308. */
  33309. constructor(
  33310. /**
  33311. * The physics-enabled object used as the physics imposter
  33312. */
  33313. object: IPhysicsEnabledObject,
  33314. /**
  33315. * The type of the physics imposter
  33316. */
  33317. type: number, _options?: PhysicsImpostorParameters, _scene?: Scene | undefined);
  33318. /**
  33319. * This function will completly initialize this impostor.
  33320. * It will create a new body - but only if this mesh has no parent.
  33321. * If it has, this impostor will not be used other than to define the impostor
  33322. * of the child mesh.
  33323. * @hidden
  33324. */
  33325. _init(): void;
  33326. private _getPhysicsParent;
  33327. /**
  33328. * Should a new body be generated.
  33329. * @returns boolean specifying if body initialization is required
  33330. */
  33331. isBodyInitRequired(): boolean;
  33332. /**
  33333. * Sets the updated scaling
  33334. * @param updated Specifies if the scaling is updated
  33335. */
  33336. setScalingUpdated(): void;
  33337. /**
  33338. * Force a regeneration of this or the parent's impostor's body.
  33339. * Use under cautious - This will remove all joints already implemented.
  33340. */
  33341. forceUpdate(): void;
  33342. /**
  33343. * Gets the body that holds this impostor. Either its own, or its parent.
  33344. */
  33345. get physicsBody(): any;
  33346. /**
  33347. * Get the parent of the physics imposter
  33348. * @returns Physics imposter or null
  33349. */
  33350. get parent(): Nullable<PhysicsImpostor>;
  33351. /**
  33352. * Sets the parent of the physics imposter
  33353. */
  33354. set parent(value: Nullable<PhysicsImpostor>);
  33355. /**
  33356. * Set the physics body. Used mainly by the physics engine/plugin
  33357. */
  33358. set physicsBody(physicsBody: any);
  33359. /**
  33360. * Resets the update flags
  33361. */
  33362. resetUpdateFlags(): void;
  33363. /**
  33364. * Gets the object extend size
  33365. * @returns the object extend size
  33366. */
  33367. getObjectExtendSize(): Vector3;
  33368. /**
  33369. * Gets the object center
  33370. * @returns The object center
  33371. */
  33372. getObjectCenter(): Vector3;
  33373. /**
  33374. * Get a specific parameter from the options parameters
  33375. * @param paramName The object parameter name
  33376. * @returns The object parameter
  33377. */
  33378. getParam(paramName: string): any;
  33379. /**
  33380. * Sets a specific parameter in the options given to the physics plugin
  33381. * @param paramName The parameter name
  33382. * @param value The value of the parameter
  33383. */
  33384. setParam(paramName: string, value: number): void;
  33385. /**
  33386. * Specifically change the body's mass option. Won't recreate the physics body object
  33387. * @param mass The mass of the physics imposter
  33388. */
  33389. setMass(mass: number): void;
  33390. /**
  33391. * Gets the linear velocity
  33392. * @returns linear velocity or null
  33393. */
  33394. getLinearVelocity(): Nullable<Vector3>;
  33395. /**
  33396. * Sets the linear velocity
  33397. * @param velocity linear velocity or null
  33398. */
  33399. setLinearVelocity(velocity: Nullable<Vector3>): void;
  33400. /**
  33401. * Gets the angular velocity
  33402. * @returns angular velocity or null
  33403. */
  33404. getAngularVelocity(): Nullable<Vector3>;
  33405. /**
  33406. * Sets the angular velocity
  33407. * @param velocity The velocity or null
  33408. */
  33409. setAngularVelocity(velocity: Nullable<Vector3>): void;
  33410. /**
  33411. * Execute a function with the physics plugin native code
  33412. * Provide a function the will have two variables - the world object and the physics body object
  33413. * @param func The function to execute with the physics plugin native code
  33414. */
  33415. executeNativeFunction(func: (world: any, physicsBody: any) => void): void;
  33416. /**
  33417. * Register a function that will be executed before the physics world is stepping forward
  33418. * @param func The function to execute before the physics world is stepped forward
  33419. */
  33420. registerBeforePhysicsStep(func: (impostor: PhysicsImpostor) => void): void;
  33421. /**
  33422. * Unregister a function that will be executed before the physics world is stepping forward
  33423. * @param func The function to execute before the physics world is stepped forward
  33424. */
  33425. unregisterBeforePhysicsStep(func: (impostor: PhysicsImpostor) => void): void;
  33426. /**
  33427. * Register a function that will be executed after the physics step
  33428. * @param func The function to execute after physics step
  33429. */
  33430. registerAfterPhysicsStep(func: (impostor: PhysicsImpostor) => void): void;
  33431. /**
  33432. * Unregisters a function that will be executed after the physics step
  33433. * @param func The function to execute after physics step
  33434. */
  33435. unregisterAfterPhysicsStep(func: (impostor: PhysicsImpostor) => void): void;
  33436. /**
  33437. * register a function that will be executed when this impostor collides against a different body
  33438. * @param collideAgainst Physics imposter, or array of physics imposters to collide against
  33439. * @param func Callback that is executed on collision
  33440. */
  33441. registerOnPhysicsCollide(collideAgainst: PhysicsImpostor | Array<PhysicsImpostor>, func: (collider: PhysicsImpostor, collidedAgainst: PhysicsImpostor) => void): void;
  33442. /**
  33443. * Unregisters the physics imposter on contact
  33444. * @param collideAgainst The physics object to collide against
  33445. * @param func Callback to execute on collision
  33446. */
  33447. unregisterOnPhysicsCollide(collideAgainst: PhysicsImpostor | Array<PhysicsImpostor>, func: (collider: PhysicsImpostor, collidedAgainst: PhysicsImpostor | Array<PhysicsImpostor>) => void): void;
  33448. private _tmpQuat;
  33449. private _tmpQuat2;
  33450. /**
  33451. * Get the parent rotation
  33452. * @returns The parent rotation
  33453. */
  33454. getParentsRotation(): Quaternion;
  33455. /**
  33456. * this function is executed by the physics engine.
  33457. */
  33458. beforeStep: () => void;
  33459. /**
  33460. * this function is executed by the physics engine
  33461. */
  33462. afterStep: () => void;
  33463. /**
  33464. * Legacy collision detection event support
  33465. */
  33466. onCollideEvent: Nullable<(collider: PhysicsImpostor, collidedWith: PhysicsImpostor) => void>;
  33467. /**
  33468. * event and body object due to cannon's event-based architecture.
  33469. */
  33470. onCollide: (e: {
  33471. body: any;
  33472. point: Nullable<Vector3>;
  33473. }) => void;
  33474. /**
  33475. * Apply a force
  33476. * @param force The force to apply
  33477. * @param contactPoint The contact point for the force
  33478. * @returns The physics imposter
  33479. */
  33480. applyForce(force: Vector3, contactPoint: Vector3): PhysicsImpostor;
  33481. /**
  33482. * Apply an impulse
  33483. * @param force The impulse force
  33484. * @param contactPoint The contact point for the impulse force
  33485. * @returns The physics imposter
  33486. */
  33487. applyImpulse(force: Vector3, contactPoint: Vector3): PhysicsImpostor;
  33488. /**
  33489. * A help function to create a joint
  33490. * @param otherImpostor A physics imposter used to create a joint
  33491. * @param jointType The type of joint
  33492. * @param jointData The data for the joint
  33493. * @returns The physics imposter
  33494. */
  33495. createJoint(otherImpostor: PhysicsImpostor, jointType: number, jointData: PhysicsJointData): PhysicsImpostor;
  33496. /**
  33497. * Add a joint to this impostor with a different impostor
  33498. * @param otherImpostor A physics imposter used to add a joint
  33499. * @param joint The joint to add
  33500. * @returns The physics imposter
  33501. */
  33502. addJoint(otherImpostor: PhysicsImpostor, joint: PhysicsJoint): PhysicsImpostor;
  33503. /**
  33504. * Add an anchor to a cloth impostor
  33505. * @param otherImpostor rigid impostor to anchor to
  33506. * @param width ratio across width from 0 to 1
  33507. * @param height ratio up height from 0 to 1
  33508. * @param influence the elasticity between cloth impostor and anchor from 0, very stretchy to 1, little strech
  33509. * @param noCollisionBetweenLinkedBodies when true collisions between cloth impostor and anchor are ignored; default false
  33510. * @returns impostor the soft imposter
  33511. */
  33512. addAnchor(otherImpostor: PhysicsImpostor, width: number, height: number, influence: number, noCollisionBetweenLinkedBodies: boolean): PhysicsImpostor;
  33513. /**
  33514. * Add a hook to a rope impostor
  33515. * @param otherImpostor rigid impostor to anchor to
  33516. * @param length ratio across rope from 0 to 1
  33517. * @param influence the elasticity between rope impostor and anchor from 0, very stretchy to 1, little strech
  33518. * @param noCollisionBetweenLinkedBodies when true collisions between soft impostor and anchor are ignored; default false
  33519. * @returns impostor the rope imposter
  33520. */
  33521. addHook(otherImpostor: PhysicsImpostor, length: number, influence: number, noCollisionBetweenLinkedBodies: boolean): PhysicsImpostor;
  33522. /**
  33523. * Will keep this body still, in a sleep mode.
  33524. * @returns the physics imposter
  33525. */
  33526. sleep(): PhysicsImpostor;
  33527. /**
  33528. * Wake the body up.
  33529. * @returns The physics imposter
  33530. */
  33531. wakeUp(): PhysicsImpostor;
  33532. /**
  33533. * Clones the physics imposter
  33534. * @param newObject The physics imposter clones to this physics-enabled object
  33535. * @returns A nullable physics imposter
  33536. */
  33537. clone(newObject: IPhysicsEnabledObject): Nullable<PhysicsImpostor>;
  33538. /**
  33539. * Disposes the physics imposter
  33540. */
  33541. dispose(): void;
  33542. /**
  33543. * Sets the delta position
  33544. * @param position The delta position amount
  33545. */
  33546. setDeltaPosition(position: Vector3): void;
  33547. /**
  33548. * Sets the delta rotation
  33549. * @param rotation The delta rotation amount
  33550. */
  33551. setDeltaRotation(rotation: Quaternion): void;
  33552. /**
  33553. * Gets the box size of the physics imposter and stores the result in the input parameter
  33554. * @param result Stores the box size
  33555. * @returns The physics imposter
  33556. */
  33557. getBoxSizeToRef(result: Vector3): PhysicsImpostor;
  33558. /**
  33559. * Gets the radius of the physics imposter
  33560. * @returns Radius of the physics imposter
  33561. */
  33562. getRadius(): number;
  33563. /**
  33564. * Sync a bone with this impostor
  33565. * @param bone The bone to sync to the impostor.
  33566. * @param boneMesh The mesh that the bone is influencing.
  33567. * @param jointPivot The pivot of the joint / bone in local space.
  33568. * @param distToJoint Optional distance from the impostor to the joint.
  33569. * @param adjustRotation Optional quaternion for adjusting the local rotation of the bone.
  33570. */
  33571. syncBoneWithImpostor(bone: Bone, boneMesh: AbstractMesh, jointPivot: Vector3, distToJoint?: number, adjustRotation?: Quaternion): void;
  33572. /**
  33573. * Sync impostor to a bone
  33574. * @param bone The bone that the impostor will be synced to.
  33575. * @param boneMesh The mesh that the bone is influencing.
  33576. * @param jointPivot The pivot of the joint / bone in local space.
  33577. * @param distToJoint Optional distance from the impostor to the joint.
  33578. * @param adjustRotation Optional quaternion for adjusting the local rotation of the bone.
  33579. * @param boneAxis Optional vector3 axis the bone is aligned with
  33580. */
  33581. syncImpostorWithBone(bone: Bone, boneMesh: AbstractMesh, jointPivot: Vector3, distToJoint?: number, adjustRotation?: Quaternion, boneAxis?: Vector3): void;
  33582. /**
  33583. * No-Imposter type
  33584. */
  33585. static NoImpostor: number;
  33586. /**
  33587. * Sphere-Imposter type
  33588. */
  33589. static SphereImpostor: number;
  33590. /**
  33591. * Box-Imposter type
  33592. */
  33593. static BoxImpostor: number;
  33594. /**
  33595. * Plane-Imposter type
  33596. */
  33597. static PlaneImpostor: number;
  33598. /**
  33599. * Mesh-imposter type
  33600. */
  33601. static MeshImpostor: number;
  33602. /**
  33603. * Capsule-Impostor type (Ammo.js plugin only)
  33604. */
  33605. static CapsuleImpostor: number;
  33606. /**
  33607. * Cylinder-Imposter type
  33608. */
  33609. static CylinderImpostor: number;
  33610. /**
  33611. * Particle-Imposter type
  33612. */
  33613. static ParticleImpostor: number;
  33614. /**
  33615. * Heightmap-Imposter type
  33616. */
  33617. static HeightmapImpostor: number;
  33618. /**
  33619. * ConvexHull-Impostor type (Ammo.js plugin only)
  33620. */
  33621. static ConvexHullImpostor: number;
  33622. /**
  33623. * Custom-Imposter type (Ammo.js plugin only)
  33624. */
  33625. static CustomImpostor: number;
  33626. /**
  33627. * Rope-Imposter type
  33628. */
  33629. static RopeImpostor: number;
  33630. /**
  33631. * Cloth-Imposter type
  33632. */
  33633. static ClothImpostor: number;
  33634. /**
  33635. * Softbody-Imposter type
  33636. */
  33637. static SoftbodyImpostor: number;
  33638. }
  33639. }
  33640. declare module "babylonjs/Meshes/mesh" {
  33641. import { Observable } from "babylonjs/Misc/observable";
  33642. import { IAnimatable } from "babylonjs/Animations/animatable.interface";
  33643. import { Nullable, FloatArray, IndicesArray } from "babylonjs/types";
  33644. import { Camera } from "babylonjs/Cameras/camera";
  33645. import { Scene } from "babylonjs/scene";
  33646. import { Matrix, Vector3, Vector2, Vector4 } from "babylonjs/Maths/math.vector";
  33647. import { Color4 } from "babylonjs/Maths/math.color";
  33648. import { Engine } from "babylonjs/Engines/engine";
  33649. import { Node } from "babylonjs/node";
  33650. import { VertexBuffer } from "babylonjs/Meshes/buffer";
  33651. import { IGetSetVerticesData } from "babylonjs/Meshes/mesh.vertexData";
  33652. import { Buffer } from "babylonjs/Meshes/buffer";
  33653. import { Geometry } from "babylonjs/Meshes/geometry";
  33654. import { AbstractMesh } from "babylonjs/Meshes/abstractMesh";
  33655. import { SubMesh } from "babylonjs/Meshes/subMesh";
  33656. import { BoundingSphere } from "babylonjs/Culling/boundingSphere";
  33657. import { Effect } from "babylonjs/Materials/effect";
  33658. import { Material } from "babylonjs/Materials/material";
  33659. import { Skeleton } from "babylonjs/Bones/skeleton";
  33660. import { MorphTargetManager } from "babylonjs/Morph/morphTargetManager";
  33661. import { MeshLODLevel } from "babylonjs/Meshes/meshLODLevel";
  33662. import { Path3D } from "babylonjs/Maths/math.path";
  33663. import { Plane } from "babylonjs/Maths/math.plane";
  33664. import { TransformNode } from "babylonjs/Meshes/transformNode";
  33665. import { ICreateCapsuleOptions } from "babylonjs/Meshes/Builders/capsuleBuilder";
  33666. import { LinesMesh } from "babylonjs/Meshes/linesMesh";
  33667. import { InstancedMesh } from "babylonjs/Meshes/instancedMesh";
  33668. import { GroundMesh } from "babylonjs/Meshes/groundMesh";
  33669. import { IPhysicsEnabledObject } from "babylonjs/Physics/physicsImpostor";
  33670. import { PhysicsImpostor } from "babylonjs/Physics/physicsImpostor";
  33671. /**
  33672. * @hidden
  33673. **/
  33674. export class _CreationDataStorage {
  33675. closePath?: boolean;
  33676. closeArray?: boolean;
  33677. idx: number[];
  33678. dashSize: number;
  33679. gapSize: number;
  33680. path3D: Path3D;
  33681. pathArray: Vector3[][];
  33682. arc: number;
  33683. radius: number;
  33684. cap: number;
  33685. tessellation: number;
  33686. }
  33687. /**
  33688. * @hidden
  33689. **/
  33690. class _InstanceDataStorage {
  33691. visibleInstances: any;
  33692. batchCache: _InstancesBatch;
  33693. instancesBufferSize: number;
  33694. instancesBuffer: Nullable<Buffer>;
  33695. instancesData: Float32Array;
  33696. overridenInstanceCount: number;
  33697. isFrozen: boolean;
  33698. previousBatch: Nullable<_InstancesBatch>;
  33699. hardwareInstancedRendering: boolean;
  33700. sideOrientation: number;
  33701. manualUpdate: boolean;
  33702. previousRenderId: number;
  33703. }
  33704. /**
  33705. * @hidden
  33706. **/
  33707. export class _InstancesBatch {
  33708. mustReturn: boolean;
  33709. visibleInstances: Nullable<import("babylonjs/Meshes/instancedMesh").InstancedMesh[]>[];
  33710. renderSelf: boolean[];
  33711. hardwareInstancedRendering: boolean[];
  33712. }
  33713. /**
  33714. * @hidden
  33715. **/
  33716. class _ThinInstanceDataStorage {
  33717. instancesCount: number;
  33718. matrixBuffer: Nullable<Buffer>;
  33719. matrixBufferSize: number;
  33720. matrixData: Nullable<Float32Array>;
  33721. boundingVectors: Array<Vector3>;
  33722. worldMatrices: Nullable<Matrix[]>;
  33723. }
  33724. /**
  33725. * Class used to represent renderable models
  33726. */
  33727. export class Mesh extends AbstractMesh implements IGetSetVerticesData {
  33728. /**
  33729. * Mesh side orientation : usually the external or front surface
  33730. */
  33731. static readonly FRONTSIDE: number;
  33732. /**
  33733. * Mesh side orientation : usually the internal or back surface
  33734. */
  33735. static readonly BACKSIDE: number;
  33736. /**
  33737. * Mesh side orientation : both internal and external or front and back surfaces
  33738. */
  33739. static readonly DOUBLESIDE: number;
  33740. /**
  33741. * Mesh side orientation : by default, `FRONTSIDE`
  33742. */
  33743. static readonly DEFAULTSIDE: number;
  33744. /**
  33745. * Mesh cap setting : no cap
  33746. */
  33747. static readonly NO_CAP: number;
  33748. /**
  33749. * Mesh cap setting : one cap at the beginning of the mesh
  33750. */
  33751. static readonly CAP_START: number;
  33752. /**
  33753. * Mesh cap setting : one cap at the end of the mesh
  33754. */
  33755. static readonly CAP_END: number;
  33756. /**
  33757. * Mesh cap setting : two caps, one at the beginning and one at the end of the mesh
  33758. */
  33759. static readonly CAP_ALL: number;
  33760. /**
  33761. * Mesh pattern setting : no flip or rotate
  33762. */
  33763. static readonly NO_FLIP: number;
  33764. /**
  33765. * Mesh pattern setting : flip (reflect in y axis) alternate tiles on each row or column
  33766. */
  33767. static readonly FLIP_TILE: number;
  33768. /**
  33769. * Mesh pattern setting : rotate (180degs) alternate tiles on each row or column
  33770. */
  33771. static readonly ROTATE_TILE: number;
  33772. /**
  33773. * Mesh pattern setting : flip (reflect in y axis) all tiles on alternate rows
  33774. */
  33775. static readonly FLIP_ROW: number;
  33776. /**
  33777. * Mesh pattern setting : rotate (180degs) all tiles on alternate rows
  33778. */
  33779. static readonly ROTATE_ROW: number;
  33780. /**
  33781. * Mesh pattern setting : flip and rotate alternate tiles on each row or column
  33782. */
  33783. static readonly FLIP_N_ROTATE_TILE: number;
  33784. /**
  33785. * Mesh pattern setting : rotate pattern and rotate
  33786. */
  33787. static readonly FLIP_N_ROTATE_ROW: number;
  33788. /**
  33789. * Mesh tile positioning : part tiles same on left/right or top/bottom
  33790. */
  33791. static readonly CENTER: number;
  33792. /**
  33793. * Mesh tile positioning : part tiles on left
  33794. */
  33795. static readonly LEFT: number;
  33796. /**
  33797. * Mesh tile positioning : part tiles on right
  33798. */
  33799. static readonly RIGHT: number;
  33800. /**
  33801. * Mesh tile positioning : part tiles on top
  33802. */
  33803. static readonly TOP: number;
  33804. /**
  33805. * Mesh tile positioning : part tiles on bottom
  33806. */
  33807. static readonly BOTTOM: number;
  33808. /**
  33809. * Gets the default side orientation.
  33810. * @param orientation the orientation to value to attempt to get
  33811. * @returns the default orientation
  33812. * @hidden
  33813. */
  33814. static _GetDefaultSideOrientation(orientation?: number): number;
  33815. private _internalMeshDataInfo;
  33816. get computeBonesUsingShaders(): boolean;
  33817. set computeBonesUsingShaders(value: boolean);
  33818. /**
  33819. * An event triggered before rendering the mesh
  33820. */
  33821. get onBeforeRenderObservable(): Observable<Mesh>;
  33822. /**
  33823. * An event triggered before binding the mesh
  33824. */
  33825. get onBeforeBindObservable(): Observable<Mesh>;
  33826. /**
  33827. * An event triggered after rendering the mesh
  33828. */
  33829. get onAfterRenderObservable(): Observable<Mesh>;
  33830. /**
  33831. * An event triggered before drawing the mesh
  33832. */
  33833. get onBeforeDrawObservable(): Observable<Mesh>;
  33834. private _onBeforeDrawObserver;
  33835. /**
  33836. * Sets a callback to call before drawing the mesh. It is recommended to use onBeforeDrawObservable instead
  33837. */
  33838. set onBeforeDraw(callback: () => void);
  33839. get hasInstances(): boolean;
  33840. get hasThinInstances(): boolean;
  33841. /**
  33842. * Gets the delay loading state of the mesh (when delay loading is turned on)
  33843. * @see https://doc.babylonjs.com/how_to/using_the_incremental_loading_system
  33844. */
  33845. delayLoadState: number;
  33846. /**
  33847. * Gets the list of instances created from this mesh
  33848. * it is not supposed to be modified manually.
  33849. * Note also that the order of the InstancedMesh wihin the array is not significant and might change.
  33850. * @see https://doc.babylonjs.com/how_to/how_to_use_instances
  33851. */
  33852. instances: import("babylonjs/Meshes/instancedMesh").InstancedMesh[];
  33853. /**
  33854. * Gets the file containing delay loading data for this mesh
  33855. */
  33856. delayLoadingFile: string;
  33857. /** @hidden */
  33858. _binaryInfo: any;
  33859. /**
  33860. * User defined function used to change how LOD level selection is done
  33861. * @see https://doc.babylonjs.com/how_to/how_to_use_lod
  33862. */
  33863. onLODLevelSelection: (distance: number, mesh: Mesh, selectedLevel: Nullable<Mesh>) => void;
  33864. /**
  33865. * Gets or sets the morph target manager
  33866. * @see https://doc.babylonjs.com/how_to/how_to_use_morphtargets
  33867. */
  33868. get morphTargetManager(): Nullable<MorphTargetManager>;
  33869. set morphTargetManager(value: Nullable<MorphTargetManager>);
  33870. /** @hidden */
  33871. _creationDataStorage: Nullable<_CreationDataStorage>;
  33872. /** @hidden */
  33873. _geometry: Nullable<Geometry>;
  33874. /** @hidden */
  33875. _delayInfo: Array<string>;
  33876. /** @hidden */
  33877. _delayLoadingFunction: (any: any, mesh: Mesh) => void;
  33878. /** @hidden */
  33879. _instanceDataStorage: _InstanceDataStorage;
  33880. /** @hidden */
  33881. _thinInstanceDataStorage: _ThinInstanceDataStorage;
  33882. private _effectiveMaterial;
  33883. /** @hidden */
  33884. _shouldGenerateFlatShading: boolean;
  33885. /** @hidden */
  33886. _originalBuilderSideOrientation: number;
  33887. /**
  33888. * Use this property to change the original side orientation defined at construction time
  33889. */
  33890. overrideMaterialSideOrientation: Nullable<number>;
  33891. /**
  33892. * Gets the source mesh (the one used to clone this one from)
  33893. */
  33894. get source(): Nullable<Mesh>;
  33895. /**
  33896. * Gets the list of clones of this mesh
  33897. * The scene must have been constructed with useClonedMeshMap=true for this to work!
  33898. * Note that useClonedMeshMap=true is the default setting
  33899. */
  33900. get cloneMeshMap(): Nullable<{
  33901. [id: string]: Mesh | undefined;
  33902. }>;
  33903. /**
  33904. * Gets or sets a boolean indicating that this mesh does not use index buffer
  33905. */
  33906. get isUnIndexed(): boolean;
  33907. set isUnIndexed(value: boolean);
  33908. /** Gets the array buffer used to store the instanced buffer used for instances' world matrices */
  33909. get worldMatrixInstancedBuffer(): Float32Array;
  33910. /** Gets or sets a boolean indicating that the update of the instance buffer of the world matrices is manual */
  33911. get manualUpdateOfWorldMatrixInstancedBuffer(): boolean;
  33912. set manualUpdateOfWorldMatrixInstancedBuffer(value: boolean);
  33913. /**
  33914. * @constructor
  33915. * @param name The value used by scene.getMeshByName() to do a lookup.
  33916. * @param scene The scene to add this mesh to.
  33917. * @param parent The parent of this mesh, if it has one
  33918. * @param source An optional Mesh from which geometry is shared, cloned.
  33919. * @param doNotCloneChildren When cloning, skip cloning child meshes of source, default False.
  33920. * When false, achieved by calling a clone(), also passing False.
  33921. * This will make creation of children, recursive.
  33922. * @param clonePhysicsImpostor When cloning, include cloning mesh physics impostor, default True.
  33923. */
  33924. constructor(name: string, scene?: Nullable<Scene>, parent?: Nullable<Node>, source?: Nullable<Mesh>, doNotCloneChildren?: boolean, clonePhysicsImpostor?: boolean);
  33925. instantiateHierarchy(newParent?: Nullable<TransformNode>, options?: {
  33926. doNotInstantiate: boolean;
  33927. }, onNewNodeCreated?: (source: TransformNode, clone: TransformNode) => void): Nullable<TransformNode>;
  33928. /**
  33929. * Gets the class name
  33930. * @returns the string "Mesh".
  33931. */
  33932. getClassName(): string;
  33933. /** @hidden */
  33934. get _isMesh(): boolean;
  33935. /**
  33936. * Returns a description of this mesh
  33937. * @param fullDetails define if full details about this mesh must be used
  33938. * @returns a descriptive string representing this mesh
  33939. */
  33940. toString(fullDetails?: boolean): string;
  33941. /** @hidden */
  33942. _unBindEffect(): void;
  33943. /**
  33944. * Gets a boolean indicating if this mesh has LOD
  33945. */
  33946. get hasLODLevels(): boolean;
  33947. /**
  33948. * Gets the list of MeshLODLevel associated with the current mesh
  33949. * @returns an array of MeshLODLevel
  33950. */
  33951. getLODLevels(): MeshLODLevel[];
  33952. private _sortLODLevels;
  33953. /**
  33954. * Add a mesh as LOD level triggered at the given distance.
  33955. * @see https://doc.babylonjs.com/how_to/how_to_use_lod
  33956. * @param distance The distance from the center of the object to show this level
  33957. * @param mesh The mesh to be added as LOD level (can be null)
  33958. * @return This mesh (for chaining)
  33959. */
  33960. addLODLevel(distance: number, mesh: Nullable<Mesh>): Mesh;
  33961. /**
  33962. * Returns the LOD level mesh at the passed distance or null if not found.
  33963. * @see https://doc.babylonjs.com/how_to/how_to_use_lod
  33964. * @param distance The distance from the center of the object to show this level
  33965. * @returns a Mesh or `null`
  33966. */
  33967. getLODLevelAtDistance(distance: number): Nullable<Mesh>;
  33968. /**
  33969. * Remove a mesh from the LOD array
  33970. * @see https://doc.babylonjs.com/how_to/how_to_use_lod
  33971. * @param mesh defines the mesh to be removed
  33972. * @return This mesh (for chaining)
  33973. */
  33974. removeLODLevel(mesh: Mesh): Mesh;
  33975. /**
  33976. * Returns the registered LOD mesh distant from the parameter `camera` position if any, else returns the current mesh.
  33977. * @see https://doc.babylonjs.com/how_to/how_to_use_lod
  33978. * @param camera defines the camera to use to compute distance
  33979. * @param boundingSphere defines a custom bounding sphere to use instead of the one from this mesh
  33980. * @return This mesh (for chaining)
  33981. */
  33982. getLOD(camera: Camera, boundingSphere?: BoundingSphere): Nullable<AbstractMesh>;
  33983. /**
  33984. * Gets the mesh internal Geometry object
  33985. */
  33986. get geometry(): Nullable<Geometry>;
  33987. /**
  33988. * Returns the total number of vertices within the mesh geometry or zero if the mesh has no geometry.
  33989. * @returns the total number of vertices
  33990. */
  33991. getTotalVertices(): number;
  33992. /**
  33993. * Returns the content of an associated vertex buffer
  33994. * @param kind defines which buffer to read from (positions, indices, normals, etc). Possible `kind` values :
  33995. * - VertexBuffer.PositionKind
  33996. * - VertexBuffer.UVKind
  33997. * - VertexBuffer.UV2Kind
  33998. * - VertexBuffer.UV3Kind
  33999. * - VertexBuffer.UV4Kind
  34000. * - VertexBuffer.UV5Kind
  34001. * - VertexBuffer.UV6Kind
  34002. * - VertexBuffer.ColorKind
  34003. * - VertexBuffer.MatricesIndicesKind
  34004. * - VertexBuffer.MatricesIndicesExtraKind
  34005. * - VertexBuffer.MatricesWeightsKind
  34006. * - VertexBuffer.MatricesWeightsExtraKind
  34007. * @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
  34008. * @param forceCopy defines a boolean forcing the copy of the buffer no matter what the value of copyWhenShared is
  34009. * @returns a FloatArray or null if the mesh has no geometry or no vertex buffer for this kind.
  34010. */
  34011. getVerticesData(kind: string, copyWhenShared?: boolean, forceCopy?: boolean): Nullable<FloatArray>;
  34012. /**
  34013. * Returns the mesh VertexBuffer object from the requested `kind`
  34014. * @param kind defines which buffer to read from (positions, indices, normals, etc). Possible `kind` values :
  34015. * - VertexBuffer.PositionKind
  34016. * - VertexBuffer.NormalKind
  34017. * - VertexBuffer.UVKind
  34018. * - VertexBuffer.UV2Kind
  34019. * - VertexBuffer.UV3Kind
  34020. * - VertexBuffer.UV4Kind
  34021. * - VertexBuffer.UV5Kind
  34022. * - VertexBuffer.UV6Kind
  34023. * - VertexBuffer.ColorKind
  34024. * - VertexBuffer.MatricesIndicesKind
  34025. * - VertexBuffer.MatricesIndicesExtraKind
  34026. * - VertexBuffer.MatricesWeightsKind
  34027. * - VertexBuffer.MatricesWeightsExtraKind
  34028. * @returns a FloatArray or null if the mesh has no vertex buffer for this kind.
  34029. */
  34030. getVertexBuffer(kind: string): Nullable<VertexBuffer>;
  34031. /**
  34032. * Tests if a specific vertex buffer is associated with this mesh
  34033. * @param kind defines which buffer to check (positions, indices, normals, etc). Possible `kind` values :
  34034. * - VertexBuffer.PositionKind
  34035. * - VertexBuffer.NormalKind
  34036. * - VertexBuffer.UVKind
  34037. * - VertexBuffer.UV2Kind
  34038. * - VertexBuffer.UV3Kind
  34039. * - VertexBuffer.UV4Kind
  34040. * - VertexBuffer.UV5Kind
  34041. * - VertexBuffer.UV6Kind
  34042. * - VertexBuffer.ColorKind
  34043. * - VertexBuffer.MatricesIndicesKind
  34044. * - VertexBuffer.MatricesIndicesExtraKind
  34045. * - VertexBuffer.MatricesWeightsKind
  34046. * - VertexBuffer.MatricesWeightsExtraKind
  34047. * @returns a boolean
  34048. */
  34049. isVerticesDataPresent(kind: string): boolean;
  34050. /**
  34051. * Returns a boolean defining if the vertex data for the requested `kind` is updatable.
  34052. * @param kind defines which buffer to check (positions, indices, normals, etc). Possible `kind` values :
  34053. * - VertexBuffer.PositionKind
  34054. * - VertexBuffer.UVKind
  34055. * - VertexBuffer.UV2Kind
  34056. * - VertexBuffer.UV3Kind
  34057. * - VertexBuffer.UV4Kind
  34058. * - VertexBuffer.UV5Kind
  34059. * - VertexBuffer.UV6Kind
  34060. * - VertexBuffer.ColorKind
  34061. * - VertexBuffer.MatricesIndicesKind
  34062. * - VertexBuffer.MatricesIndicesExtraKind
  34063. * - VertexBuffer.MatricesWeightsKind
  34064. * - VertexBuffer.MatricesWeightsExtraKind
  34065. * @returns a boolean
  34066. */
  34067. isVertexBufferUpdatable(kind: string): boolean;
  34068. /**
  34069. * Returns a string which contains the list of existing `kinds` of Vertex Data associated with this mesh.
  34070. * @param kind defines which buffer to read from (positions, indices, normals, etc). Possible `kind` values :
  34071. * - VertexBuffer.PositionKind
  34072. * - VertexBuffer.NormalKind
  34073. * - VertexBuffer.UVKind
  34074. * - VertexBuffer.UV2Kind
  34075. * - VertexBuffer.UV3Kind
  34076. * - VertexBuffer.UV4Kind
  34077. * - VertexBuffer.UV5Kind
  34078. * - VertexBuffer.UV6Kind
  34079. * - VertexBuffer.ColorKind
  34080. * - VertexBuffer.MatricesIndicesKind
  34081. * - VertexBuffer.MatricesIndicesExtraKind
  34082. * - VertexBuffer.MatricesWeightsKind
  34083. * - VertexBuffer.MatricesWeightsExtraKind
  34084. * @returns an array of strings
  34085. */
  34086. getVerticesDataKinds(): string[];
  34087. /**
  34088. * Returns a positive integer : the total number of indices in this mesh geometry.
  34089. * @returns the numner of indices or zero if the mesh has no geometry.
  34090. */
  34091. getTotalIndices(): number;
  34092. /**
  34093. * Returns an array of integers or a typed array (Int32Array, Uint32Array, Uint16Array) populated with the mesh indices.
  34094. * @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.
  34095. * @param forceCopy defines a boolean indicating that the returned array must be cloned upon returning it
  34096. * @returns the indices array or an empty array if the mesh has no geometry
  34097. */
  34098. getIndices(copyWhenShared?: boolean, forceCopy?: boolean): Nullable<IndicesArray>;
  34099. get isBlocked(): boolean;
  34100. /**
  34101. * Determine if the current mesh is ready to be rendered
  34102. * @param completeCheck defines if a complete check (including materials and lights) has to be done (false by default)
  34103. * @param forceInstanceSupport will check if the mesh will be ready when used with instances (false by default)
  34104. * @returns true if all associated assets are ready (material, textures, shaders)
  34105. */
  34106. isReady(completeCheck?: boolean, forceInstanceSupport?: boolean): boolean;
  34107. /**
  34108. * 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.
  34109. */
  34110. get areNormalsFrozen(): boolean;
  34111. /**
  34112. * 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.
  34113. * @returns the current mesh
  34114. */
  34115. freezeNormals(): Mesh;
  34116. /**
  34117. * 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
  34118. * @returns the current mesh
  34119. */
  34120. unfreezeNormals(): Mesh;
  34121. /**
  34122. * Sets a value overriding the instance count. Only applicable when custom instanced InterleavedVertexBuffer are used rather than InstancedMeshs
  34123. */
  34124. set overridenInstanceCount(count: number);
  34125. /** @hidden */
  34126. _preActivate(): Mesh;
  34127. /** @hidden */
  34128. _preActivateForIntermediateRendering(renderId: number): Mesh;
  34129. /** @hidden */
  34130. _registerInstanceForRenderId(instance: InstancedMesh, renderId: number): Mesh;
  34131. protected _afterComputeWorldMatrix(): void;
  34132. /** @hidden */
  34133. _postActivate(): void;
  34134. /**
  34135. * This method recomputes and sets a new BoundingInfo to the mesh unless it is locked.
  34136. * This means the mesh underlying bounding box and sphere are recomputed.
  34137. * @param applySkeleton defines whether to apply the skeleton before computing the bounding info
  34138. * @returns the current mesh
  34139. */
  34140. refreshBoundingInfo(applySkeleton?: boolean): Mesh;
  34141. /** @hidden */
  34142. _createGlobalSubMesh(force: boolean): Nullable<SubMesh>;
  34143. /**
  34144. * This function will subdivide the mesh into multiple submeshes
  34145. * @param count defines the expected number of submeshes
  34146. */
  34147. subdivide(count: number): void;
  34148. /**
  34149. * Copy a FloatArray into a specific associated vertex buffer
  34150. * @param kind defines which buffer to write to (positions, indices, normals, etc). Possible `kind` values :
  34151. * - VertexBuffer.PositionKind
  34152. * - VertexBuffer.UVKind
  34153. * - VertexBuffer.UV2Kind
  34154. * - VertexBuffer.UV3Kind
  34155. * - VertexBuffer.UV4Kind
  34156. * - VertexBuffer.UV5Kind
  34157. * - VertexBuffer.UV6Kind
  34158. * - VertexBuffer.ColorKind
  34159. * - VertexBuffer.MatricesIndicesKind
  34160. * - VertexBuffer.MatricesIndicesExtraKind
  34161. * - VertexBuffer.MatricesWeightsKind
  34162. * - VertexBuffer.MatricesWeightsExtraKind
  34163. * @param data defines the data source
  34164. * @param updatable defines if the updated vertex buffer must be flagged as updatable
  34165. * @param stride defines the data stride size (can be null)
  34166. * @returns the current mesh
  34167. */
  34168. setVerticesData(kind: string, data: FloatArray, updatable?: boolean, stride?: number): AbstractMesh;
  34169. /**
  34170. * Delete a vertex buffer associated with this mesh
  34171. * @param kind defines which buffer to delete (positions, indices, normals, etc). Possible `kind` values :
  34172. * - VertexBuffer.PositionKind
  34173. * - VertexBuffer.UVKind
  34174. * - VertexBuffer.UV2Kind
  34175. * - VertexBuffer.UV3Kind
  34176. * - VertexBuffer.UV4Kind
  34177. * - VertexBuffer.UV5Kind
  34178. * - VertexBuffer.UV6Kind
  34179. * - VertexBuffer.ColorKind
  34180. * - VertexBuffer.MatricesIndicesKind
  34181. * - VertexBuffer.MatricesIndicesExtraKind
  34182. * - VertexBuffer.MatricesWeightsKind
  34183. * - VertexBuffer.MatricesWeightsExtraKind
  34184. */
  34185. removeVerticesData(kind: string): void;
  34186. /**
  34187. * Flags an associated vertex buffer as updatable
  34188. * @param kind defines which buffer to use (positions, indices, normals, etc). Possible `kind` values :
  34189. * - VertexBuffer.PositionKind
  34190. * - VertexBuffer.UVKind
  34191. * - VertexBuffer.UV2Kind
  34192. * - VertexBuffer.UV3Kind
  34193. * - VertexBuffer.UV4Kind
  34194. * - VertexBuffer.UV5Kind
  34195. * - VertexBuffer.UV6Kind
  34196. * - VertexBuffer.ColorKind
  34197. * - VertexBuffer.MatricesIndicesKind
  34198. * - VertexBuffer.MatricesIndicesExtraKind
  34199. * - VertexBuffer.MatricesWeightsKind
  34200. * - VertexBuffer.MatricesWeightsExtraKind
  34201. * @param updatable defines if the updated vertex buffer must be flagged as updatable
  34202. */
  34203. markVerticesDataAsUpdatable(kind: string, updatable?: boolean): void;
  34204. /**
  34205. * Sets the mesh global Vertex Buffer
  34206. * @param buffer defines the buffer to use
  34207. * @returns the current mesh
  34208. */
  34209. setVerticesBuffer(buffer: VertexBuffer): Mesh;
  34210. /**
  34211. * Update a specific associated vertex buffer
  34212. * @param kind defines which buffer to write to (positions, indices, normals, etc). Possible `kind` values :
  34213. * - VertexBuffer.PositionKind
  34214. * - VertexBuffer.UVKind
  34215. * - VertexBuffer.UV2Kind
  34216. * - VertexBuffer.UV3Kind
  34217. * - VertexBuffer.UV4Kind
  34218. * - VertexBuffer.UV5Kind
  34219. * - VertexBuffer.UV6Kind
  34220. * - VertexBuffer.ColorKind
  34221. * - VertexBuffer.MatricesIndicesKind
  34222. * - VertexBuffer.MatricesIndicesExtraKind
  34223. * - VertexBuffer.MatricesWeightsKind
  34224. * - VertexBuffer.MatricesWeightsExtraKind
  34225. * @param data defines the data source
  34226. * @param updateExtends defines if extends info of the mesh must be updated (can be null). This is mostly useful for "position" kind
  34227. * @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)
  34228. * @returns the current mesh
  34229. */
  34230. updateVerticesData(kind: string, data: FloatArray, updateExtends?: boolean, makeItUnique?: boolean): AbstractMesh;
  34231. /**
  34232. * This method updates the vertex positions of an updatable mesh according to the `positionFunction` returned values.
  34233. * @see https://doc.babylonjs.com/how_to/how_to_dynamically_morph_a_mesh#other-shapes-updatemeshpositions
  34234. * @param positionFunction is a simple JS function what is passed the mesh `positions` array. It doesn't need to return anything
  34235. * @param computeNormals is a boolean (default true) to enable/disable the mesh normal recomputation after the vertex position update
  34236. * @returns the current mesh
  34237. */
  34238. updateMeshPositions(positionFunction: (data: FloatArray) => void, computeNormals?: boolean): Mesh;
  34239. /**
  34240. * Creates a un-shared specific occurence of the geometry for the mesh.
  34241. * @returns the current mesh
  34242. */
  34243. makeGeometryUnique(): Mesh;
  34244. /**
  34245. * Set the index buffer of this mesh
  34246. * @param indices defines the source data
  34247. * @param totalVertices defines the total number of vertices referenced by this index data (can be null)
  34248. * @param updatable defines if the updated index buffer must be flagged as updatable (default is false)
  34249. * @returns the current mesh
  34250. */
  34251. setIndices(indices: IndicesArray, totalVertices?: Nullable<number>, updatable?: boolean): AbstractMesh;
  34252. /**
  34253. * Update the current index buffer
  34254. * @param indices defines the source data
  34255. * @param offset defines the offset in the index buffer where to store the new data (can be null)
  34256. * @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)
  34257. * @returns the current mesh
  34258. */
  34259. updateIndices(indices: IndicesArray, offset?: number, gpuMemoryOnly?: boolean): AbstractMesh;
  34260. /**
  34261. * Invert the geometry to move from a right handed system to a left handed one.
  34262. * @returns the current mesh
  34263. */
  34264. toLeftHanded(): Mesh;
  34265. /** @hidden */
  34266. _bind(subMesh: SubMesh, effect: Effect, fillMode: number): Mesh;
  34267. /** @hidden */
  34268. _draw(subMesh: SubMesh, fillMode: number, instancesCount?: number): Mesh;
  34269. /**
  34270. * Registers for this mesh a javascript function called just before the rendering process
  34271. * @param func defines the function to call before rendering this mesh
  34272. * @returns the current mesh
  34273. */
  34274. registerBeforeRender(func: (mesh: AbstractMesh) => void): Mesh;
  34275. /**
  34276. * Disposes a previously registered javascript function called before the rendering
  34277. * @param func defines the function to remove
  34278. * @returns the current mesh
  34279. */
  34280. unregisterBeforeRender(func: (mesh: AbstractMesh) => void): Mesh;
  34281. /**
  34282. * Registers for this mesh a javascript function called just after the rendering is complete
  34283. * @param func defines the function to call after rendering this mesh
  34284. * @returns the current mesh
  34285. */
  34286. registerAfterRender(func: (mesh: AbstractMesh) => void): Mesh;
  34287. /**
  34288. * Disposes a previously registered javascript function called after the rendering.
  34289. * @param func defines the function to remove
  34290. * @returns the current mesh
  34291. */
  34292. unregisterAfterRender(func: (mesh: AbstractMesh) => void): Mesh;
  34293. /** @hidden */
  34294. _getInstancesRenderList(subMeshId: number, isReplacementMode?: boolean): _InstancesBatch;
  34295. /** @hidden */
  34296. _renderWithInstances(subMesh: SubMesh, fillMode: number, batch: _InstancesBatch, effect: Effect, engine: Engine): Mesh;
  34297. /** @hidden */
  34298. _renderWithThinInstances(subMesh: SubMesh, fillMode: number, effect: Effect, engine: Engine): void;
  34299. /** @hidden */
  34300. _processInstancedBuffers(visibleInstances: InstancedMesh[], renderSelf: boolean): void;
  34301. /** @hidden */
  34302. _processRendering(renderingMesh: AbstractMesh, subMesh: SubMesh, effect: Effect, fillMode: number, batch: _InstancesBatch, hardwareInstancedRendering: boolean, onBeforeDraw: (isInstance: boolean, world: Matrix, effectiveMaterial?: Material) => void, effectiveMaterial?: Material): Mesh;
  34303. /** @hidden */
  34304. _rebuild(): void;
  34305. /** @hidden */
  34306. _freeze(): void;
  34307. /** @hidden */
  34308. _unFreeze(): void;
  34309. /**
  34310. * 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
  34311. * @param subMesh defines the subMesh to render
  34312. * @param enableAlphaMode defines if alpha mode can be changed
  34313. * @param effectiveMeshReplacement defines an optional mesh used to provide info for the rendering
  34314. * @returns the current mesh
  34315. */
  34316. render(subMesh: SubMesh, enableAlphaMode: boolean, effectiveMeshReplacement?: AbstractMesh): Mesh;
  34317. private _onBeforeDraw;
  34318. /**
  34319. * Renormalize the mesh and patch it up if there are no weights
  34320. * Similar to normalization by adding the weights compute the reciprocal and multiply all elements, this wil ensure that everything adds to 1.
  34321. * However in the case of zero weights then we set just a single influence to 1.
  34322. * We check in the function for extra's present and if so we use the normalizeSkinWeightsWithExtras rather than the FourWeights version.
  34323. */
  34324. cleanMatrixWeights(): void;
  34325. private normalizeSkinFourWeights;
  34326. private normalizeSkinWeightsAndExtra;
  34327. /**
  34328. * ValidateSkinning is used to determine that a mesh has valid skinning data along with skin metrics, if missing weights,
  34329. * or not normalized it is returned as invalid mesh the string can be used for console logs, or on screen messages to let
  34330. * the user know there was an issue with importing the mesh
  34331. * @returns a validation object with skinned, valid and report string
  34332. */
  34333. validateSkinning(): {
  34334. skinned: boolean;
  34335. valid: boolean;
  34336. report: string;
  34337. };
  34338. /** @hidden */
  34339. _checkDelayState(): Mesh;
  34340. private _queueLoad;
  34341. /**
  34342. * Returns `true` if the mesh is within the frustum defined by the passed array of planes.
  34343. * A mesh is in the frustum if its bounding box intersects the frustum
  34344. * @param frustumPlanes defines the frustum to test
  34345. * @returns true if the mesh is in the frustum planes
  34346. */
  34347. isInFrustum(frustumPlanes: Plane[]): boolean;
  34348. /**
  34349. * Sets the mesh material by the material or multiMaterial `id` property
  34350. * @param id is a string identifying the material or the multiMaterial
  34351. * @returns the current mesh
  34352. */
  34353. setMaterialByID(id: string): Mesh;
  34354. /**
  34355. * Returns as a new array populated with the mesh material and/or skeleton, if any.
  34356. * @returns an array of IAnimatable
  34357. */
  34358. getAnimatables(): IAnimatable[];
  34359. /**
  34360. * Modifies the mesh geometry according to the passed transformation matrix.
  34361. * This method returns nothing but it really modifies the mesh even if it's originally not set as updatable.
  34362. * The mesh normals are modified using the same transformation.
  34363. * Note that, under the hood, this method sets a new VertexBuffer each call.
  34364. * @param transform defines the transform matrix to use
  34365. * @see https://doc.babylonjs.com/resources/baking_transformations
  34366. * @returns the current mesh
  34367. */
  34368. bakeTransformIntoVertices(transform: Matrix): Mesh;
  34369. /**
  34370. * Modifies the mesh geometry according to its own current World Matrix.
  34371. * The mesh World Matrix is then reset.
  34372. * This method returns nothing but really modifies the mesh even if it's originally not set as updatable.
  34373. * Note that, under the hood, this method sets a new VertexBuffer each call.
  34374. * @see https://doc.babylonjs.com/resources/baking_transformations
  34375. * @param bakeIndependenlyOfChildren indicates whether to preserve all child nodes' World Matrix during baking
  34376. * @returns the current mesh
  34377. */
  34378. bakeCurrentTransformIntoVertices(bakeIndependenlyOfChildren?: boolean): Mesh;
  34379. /** @hidden */
  34380. get _positions(): Nullable<Vector3[]>;
  34381. /** @hidden */
  34382. _resetPointsArrayCache(): Mesh;
  34383. /** @hidden */
  34384. _generatePointsArray(): boolean;
  34385. /**
  34386. * Returns a new Mesh object generated from the current mesh properties.
  34387. * This method must not get confused with createInstance()
  34388. * @param name is a string, the name given to the new mesh
  34389. * @param newParent can be any Node object (default `null`)
  34390. * @param doNotCloneChildren allows/denies the recursive cloning of the original mesh children if any (default `false`)
  34391. * @param clonePhysicsImpostor allows/denies the cloning in the same time of the original mesh `body` used by the physics engine, if any (default `true`)
  34392. * @returns a new mesh
  34393. */
  34394. clone(name?: string, newParent?: Nullable<Node>, doNotCloneChildren?: boolean, clonePhysicsImpostor?: boolean): Mesh;
  34395. /**
  34396. * Releases resources associated with this mesh.
  34397. * @param doNotRecurse Set to true to not recurse into each children (recurse into each children by default)
  34398. * @param disposeMaterialAndTextures Set to true to also dispose referenced materials and textures (false by default)
  34399. */
  34400. dispose(doNotRecurse?: boolean, disposeMaterialAndTextures?: boolean): void;
  34401. /** @hidden */
  34402. _disposeInstanceSpecificData(): void;
  34403. /** @hidden */
  34404. _disposeThinInstanceSpecificData(): void;
  34405. /**
  34406. * Modifies the mesh geometry according to a displacement map.
  34407. * 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.
  34408. * The mesh must be set as updatable. Its internal geometry is directly modified, no new buffer are allocated.
  34409. * @param url is a string, the URL from the image file is to be downloaded.
  34410. * @param minHeight is the lower limit of the displacement.
  34411. * @param maxHeight is the upper limit of the displacement.
  34412. * @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.
  34413. * @param uvOffset is an optional vector2 used to offset UV.
  34414. * @param uvScale is an optional vector2 used to scale UV.
  34415. * @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.
  34416. * @returns the Mesh.
  34417. */
  34418. applyDisplacementMap(url: string, minHeight: number, maxHeight: number, onSuccess?: (mesh: Mesh) => void, uvOffset?: Vector2, uvScale?: Vector2, forceUpdate?: boolean): Mesh;
  34419. /**
  34420. * Modifies the mesh geometry according to a displacementMap buffer.
  34421. * 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.
  34422. * The mesh must be set as updatable. Its internal geometry is directly modified, no new buffer are allocated.
  34423. * @param buffer is a `Uint8Array` buffer containing series of `Uint8` lower than 255, the red, green, blue and alpha values of each successive pixel.
  34424. * @param heightMapWidth is the width of the buffer image.
  34425. * @param heightMapHeight is the height of the buffer image.
  34426. * @param minHeight is the lower limit of the displacement.
  34427. * @param maxHeight is the upper limit of the displacement.
  34428. * @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.
  34429. * @param uvOffset is an optional vector2 used to offset UV.
  34430. * @param uvScale is an optional vector2 used to scale UV.
  34431. * @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.
  34432. * @returns the Mesh.
  34433. */
  34434. applyDisplacementMapFromBuffer(buffer: Uint8Array, heightMapWidth: number, heightMapHeight: number, minHeight: number, maxHeight: number, uvOffset?: Vector2, uvScale?: Vector2, forceUpdate?: boolean): Mesh;
  34435. /**
  34436. * Modify the mesh to get a flat shading rendering.
  34437. * This means each mesh facet will then have its own normals. Usually new vertices are added in the mesh geometry to get this result.
  34438. * Warning : the mesh is really modified even if not set originally as updatable and, under the hood, a new VertexBuffer is allocated.
  34439. * @returns current mesh
  34440. */
  34441. convertToFlatShadedMesh(): Mesh;
  34442. /**
  34443. * This method removes all the mesh indices and add new vertices (duplication) in order to unfold facets into buffers.
  34444. * In other words, more vertices, no more indices and a single bigger VBO.
  34445. * The mesh is really modified even if not set originally as updatable. Under the hood, a new VertexBuffer is allocated.
  34446. * @returns current mesh
  34447. */
  34448. convertToUnIndexedMesh(): Mesh;
  34449. /**
  34450. * Inverses facet orientations.
  34451. * Warning : the mesh is really modified even if not set originally as updatable. A new VertexBuffer is created under the hood each call.
  34452. * @param flipNormals will also inverts the normals
  34453. * @returns current mesh
  34454. */
  34455. flipFaces(flipNormals?: boolean): Mesh;
  34456. /**
  34457. * Increase the number of facets and hence vertices in a mesh
  34458. * Vertex normals are interpolated from existing vertex normals
  34459. * Warning : the mesh is really modified even if not set originally as updatable. A new VertexBuffer is created under the hood each call.
  34460. * @param numberPerEdge the number of new vertices to add to each edge of a facet, optional default 1
  34461. */
  34462. increaseVertices(numberPerEdge: number): void;
  34463. /**
  34464. * Force adjacent facets to share vertices and remove any facets that have all vertices in a line
  34465. * This will undo any application of covertToFlatShadedMesh
  34466. * Warning : the mesh is really modified even if not set originally as updatable. A new VertexBuffer is created under the hood each call.
  34467. */
  34468. forceSharedVertices(): void;
  34469. /** @hidden */
  34470. static _instancedMeshFactory(name: string, mesh: Mesh): InstancedMesh;
  34471. /** @hidden */
  34472. static _PhysicsImpostorParser(scene: Scene, physicObject: IPhysicsEnabledObject, jsonObject: any): PhysicsImpostor;
  34473. /**
  34474. * Creates a new InstancedMesh object from the mesh model.
  34475. * @see https://doc.babylonjs.com/how_to/how_to_use_instances
  34476. * @param name defines the name of the new instance
  34477. * @returns a new InstancedMesh
  34478. */
  34479. createInstance(name: string): InstancedMesh;
  34480. /**
  34481. * Synchronises all the mesh instance submeshes to the current mesh submeshes, if any.
  34482. * After this call, all the mesh instances have the same submeshes than the current mesh.
  34483. * @returns the current mesh
  34484. */
  34485. synchronizeInstances(): Mesh;
  34486. /**
  34487. * Optimization of the mesh's indices, in case a mesh has duplicated vertices.
  34488. * The function will only reorder the indices and will not remove unused vertices to avoid problems with submeshes.
  34489. * This should be used together with the simplification to avoid disappearing triangles.
  34490. * @param successCallback an optional success callback to be called after the optimization finished.
  34491. * @returns the current mesh
  34492. */
  34493. optimizeIndices(successCallback?: (mesh?: Mesh) => void): Mesh;
  34494. /**
  34495. * Serialize current mesh
  34496. * @param serializationObject defines the object which will receive the serialization data
  34497. */
  34498. serialize(serializationObject: any): void;
  34499. /** @hidden */
  34500. _syncGeometryWithMorphTargetManager(): void;
  34501. /** @hidden */
  34502. static _GroundMeshParser: (parsedMesh: any, scene: Scene) => Mesh;
  34503. /**
  34504. * Returns a new Mesh object parsed from the source provided.
  34505. * @param parsedMesh is the source
  34506. * @param scene defines the hosting scene
  34507. * @param rootUrl is the root URL to prefix the `delayLoadingFile` property with
  34508. * @returns a new Mesh
  34509. */
  34510. static Parse(parsedMesh: any, scene: Scene, rootUrl: string): Mesh;
  34511. /**
  34512. * Creates a ribbon mesh. Please consider using the same method from the MeshBuilder class instead
  34513. * @see https://doc.babylonjs.com/how_to/parametric_shapes
  34514. * @param name defines the name of the mesh to create
  34515. * @param pathArray is a required array of paths, what are each an array of successive Vector3. The pathArray parameter depicts the ribbon geometry.
  34516. * @param closeArray creates a seam between the first and the last paths of the path array (default is false)
  34517. * @param closePath creates a seam between the first and the last points of each path of the path array
  34518. * @param offset is taken in account only if the `pathArray` is containing a single path
  34519. * @param scene defines the hosting scene
  34520. * @param updatable defines if the mesh must be flagged as updatable
  34521. * @param sideOrientation defines the mesh side orientation (https://doc.babylonjs.com/babylon101/discover_basic_elements#side-orientation)
  34522. * @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)
  34523. * @returns a new Mesh
  34524. */
  34525. static CreateRibbon(name: string, pathArray: Vector3[][], closeArray: boolean, closePath: boolean, offset: number, scene?: Scene, updatable?: boolean, sideOrientation?: number, instance?: Mesh): Mesh;
  34526. /**
  34527. * Creates a plane polygonal mesh. By default, this is a disc. Please consider using the same method from the MeshBuilder class instead
  34528. * @param name defines the name of the mesh to create
  34529. * @param radius sets the radius size (float) of the polygon (default 0.5)
  34530. * @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
  34531. * @param scene defines the hosting scene
  34532. * @param updatable defines if the mesh must be flagged as updatable
  34533. * @param sideOrientation defines the mesh side orientation (https://doc.babylonjs.com/babylon101/discover_basic_elements#side-orientation)
  34534. * @returns a new Mesh
  34535. */
  34536. static CreateDisc(name: string, radius: number, tessellation: number, scene?: Nullable<Scene>, updatable?: boolean, sideOrientation?: number): Mesh;
  34537. /**
  34538. * Creates a box mesh. Please consider using the same method from the MeshBuilder class instead
  34539. * @param name defines the name of the mesh to create
  34540. * @param size sets the size (float) of each box side (default 1)
  34541. * @param scene defines the hosting scene
  34542. * @param updatable defines if the mesh must be flagged as updatable
  34543. * @param sideOrientation defines the mesh side orientation (https://doc.babylonjs.com/babylon101/discover_basic_elements#side-orientation)
  34544. * @returns a new Mesh
  34545. */
  34546. static CreateBox(name: string, size: number, scene?: Nullable<Scene>, updatable?: boolean, sideOrientation?: number): Mesh;
  34547. /**
  34548. * Creates a sphere mesh. Please consider using the same method from the MeshBuilder class instead
  34549. * @param name defines the name of the mesh to create
  34550. * @param segments sets the sphere number of horizontal stripes (positive integer, default 32)
  34551. * @param diameter sets the diameter size (float) of the sphere (default 1)
  34552. * @param scene defines the hosting scene
  34553. * @param updatable defines if the mesh must be flagged as updatable
  34554. * @param sideOrientation defines the mesh side orientation (https://doc.babylonjs.com/babylon101/discover_basic_elements#side-orientation)
  34555. * @returns a new Mesh
  34556. */
  34557. static CreateSphere(name: string, segments: number, diameter: number, scene?: Scene, updatable?: boolean, sideOrientation?: number): Mesh;
  34558. /**
  34559. * Creates a hemisphere mesh. Please consider using the same method from the MeshBuilder class instead
  34560. * @param name defines the name of the mesh to create
  34561. * @param segments sets the sphere number of horizontal stripes (positive integer, default 32)
  34562. * @param diameter sets the diameter size (float) of the sphere (default 1)
  34563. * @param scene defines the hosting scene
  34564. * @returns a new Mesh
  34565. */
  34566. static CreateHemisphere(name: string, segments: number, diameter: number, scene?: Scene): Mesh;
  34567. /**
  34568. * Creates a cylinder or a cone mesh. Please consider using the same method from the MeshBuilder class instead
  34569. * @param name defines the name of the mesh to create
  34570. * @param height sets the height size (float) of the cylinder/cone (float, default 2)
  34571. * @param diameterTop set the top cap diameter (floats, default 1)
  34572. * @param diameterBottom set the bottom cap diameter (floats, default 1). This value can't be zero
  34573. * @param tessellation sets the number of cylinder sides (positive integer, default 24). Set it to 3 to get a prism for instance
  34574. * @param subdivisions sets the number of rings along the cylinder height (positive integer, default 1)
  34575. * @param scene defines the hosting scene
  34576. * @param updatable defines if the mesh must be flagged as updatable
  34577. * @param sideOrientation defines the mesh side orientation (https://doc.babylonjs.com/babylon101/discover_basic_elements#side-orientation)
  34578. * @returns a new Mesh
  34579. */
  34580. static CreateCylinder(name: string, height: number, diameterTop: number, diameterBottom: number, tessellation: number, subdivisions: any, scene?: Scene, updatable?: any, sideOrientation?: number): Mesh;
  34581. /**
  34582. * Creates a torus mesh. Please consider using the same method from the MeshBuilder class instead
  34583. * @param name defines the name of the mesh to create
  34584. * @param diameter sets the diameter size (float) of the torus (default 1)
  34585. * @param thickness sets the diameter size of the tube of the torus (float, default 0.5)
  34586. * @param tessellation sets the number of torus sides (postive integer, default 16)
  34587. * @param scene defines the hosting scene
  34588. * @param updatable defines if the mesh must be flagged as updatable
  34589. * @param sideOrientation defines the mesh side orientation (https://doc.babylonjs.com/babylon101/discover_basic_elements#side-orientation)
  34590. * @returns a new Mesh
  34591. */
  34592. static CreateTorus(name: string, diameter: number, thickness: number, tessellation: number, scene?: Scene, updatable?: boolean, sideOrientation?: number): Mesh;
  34593. /**
  34594. * Creates a torus knot mesh. Please consider using the same method from the MeshBuilder class instead
  34595. * @param name defines the name of the mesh to create
  34596. * @param radius sets the global radius size (float) of the torus knot (default 2)
  34597. * @param tube sets the diameter size of the tube of the torus (float, default 0.5)
  34598. * @param radialSegments sets the number of sides on each tube segments (positive integer, default 32)
  34599. * @param tubularSegments sets the number of tubes to decompose the knot into (positive integer, default 32)
  34600. * @param p the number of windings on X axis (positive integers, default 2)
  34601. * @param q the number of windings on Y axis (positive integers, default 3)
  34602. * @param scene defines the hosting scene
  34603. * @param updatable defines if the mesh must be flagged as updatable
  34604. * @param sideOrientation defines the mesh side orientation (https://doc.babylonjs.com/babylon101/discover_basic_elements#side-orientation)
  34605. * @returns a new Mesh
  34606. */
  34607. static CreateTorusKnot(name: string, radius: number, tube: number, radialSegments: number, tubularSegments: number, p: number, q: number, scene?: Scene, updatable?: boolean, sideOrientation?: number): Mesh;
  34608. /**
  34609. * Creates a line mesh. Please consider using the same method from the MeshBuilder class instead.
  34610. * @param name defines the name of the mesh to create
  34611. * @param points is an array successive Vector3
  34612. * @param scene defines the hosting scene
  34613. * @param updatable defines if the mesh must be flagged as updatable
  34614. * @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).
  34615. * @returns a new Mesh
  34616. */
  34617. static CreateLines(name: string, points: Vector3[], scene?: Nullable<Scene>, updatable?: boolean, instance?: Nullable<LinesMesh>): LinesMesh;
  34618. /**
  34619. * Creates a dashed line mesh. Please consider using the same method from the MeshBuilder class instead
  34620. * @param name defines the name of the mesh to create
  34621. * @param points is an array successive Vector3
  34622. * @param dashSize is the size of the dashes relatively the dash number (positive float, default 3)
  34623. * @param gapSize is the size of the gap between two successive dashes relatively the dash number (positive float, default 1)
  34624. * @param dashNb is the intended total number of dashes (positive integer, default 200)
  34625. * @param scene defines the hosting scene
  34626. * @param updatable defines if the mesh must be flagged as updatable
  34627. * @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)
  34628. * @returns a new Mesh
  34629. */
  34630. static CreateDashedLines(name: string, points: Vector3[], dashSize: number, gapSize: number, dashNb: number, scene?: Nullable<Scene>, updatable?: boolean, instance?: LinesMesh): LinesMesh;
  34631. /**
  34632. * Creates a polygon mesh.Please consider using the same method from the MeshBuilder class instead
  34633. * The polygon's shape will depend on the input parameters and is constructed parallel to a ground mesh.
  34634. * 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.
  34635. * You can set the mesh side orientation with the values : Mesh.FRONTSIDE (default), Mesh.BACKSIDE or Mesh.DOUBLESIDE
  34636. * The mesh can be set to updatable with the boolean parameter `updatable` (default false) if its internal geometry is supposed to change once created.
  34637. * Remember you can only change the shape positions, not their number when updating a polygon.
  34638. * @see https://doc.babylonjs.com/how_to/parametric_shapes#non-regular-polygon
  34639. * @param name defines the name of the mesh to create
  34640. * @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
  34641. * @param scene defines the hosting scene
  34642. * @param holes is a required array of arrays of successive Vector3 used to defines holes in the polygon
  34643. * @param updatable defines if the mesh must be flagged as updatable
  34644. * @param sideOrientation defines the mesh side orientation (https://doc.babylonjs.com/babylon101/discover_basic_elements#side-orientation)
  34645. * @param earcutInjection can be used to inject your own earcut reference
  34646. * @returns a new Mesh
  34647. */
  34648. static CreatePolygon(name: string, shape: Vector3[], scene: Scene, holes?: Vector3[][], updatable?: boolean, sideOrientation?: number, earcutInjection?: any): Mesh;
  34649. /**
  34650. * Creates an extruded polygon mesh, with depth in the Y direction. Please consider using the same method from the MeshBuilder class instead.
  34651. * @see https://doc.babylonjs.com/how_to/parametric_shapes#extruded-non-regular-polygon
  34652. * @param name defines the name of the mesh to create
  34653. * @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
  34654. * @param depth defines the height of extrusion
  34655. * @param scene defines the hosting scene
  34656. * @param holes is a required array of arrays of successive Vector3 used to defines holes in the polygon
  34657. * @param updatable defines if the mesh must be flagged as updatable
  34658. * @param sideOrientation defines the mesh side orientation (https://doc.babylonjs.com/babylon101/discover_basic_elements#side-orientation)
  34659. * @param earcutInjection can be used to inject your own earcut reference
  34660. * @returns a new Mesh
  34661. */
  34662. static ExtrudePolygon(name: string, shape: Vector3[], depth: number, scene: Scene, holes?: Vector3[][], updatable?: boolean, sideOrientation?: number, earcutInjection?: any): Mesh;
  34663. /**
  34664. * Creates an extruded shape mesh.
  34665. * 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
  34666. * @see https://doc.babylonjs.com/how_to/parametric_shapes
  34667. * @see https://doc.babylonjs.com/how_to/parametric_shapes#extruded-shapes
  34668. * @param name defines the name of the mesh to create
  34669. * @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
  34670. * @param path is a required array of successive Vector3. This is the axis curve the shape is extruded along
  34671. * @param scale is the value to scale the shape
  34672. * @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
  34673. * @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
  34674. * @param scene defines the hosting scene
  34675. * @param updatable defines if the mesh must be flagged as updatable
  34676. * @param sideOrientation defines the mesh side orientation (https://doc.babylonjs.com/babylon101/discover_basic_elements#side-orientation)
  34677. * @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)
  34678. * @returns a new Mesh
  34679. */
  34680. static ExtrudeShape(name: string, shape: Vector3[], path: Vector3[], scale: number, rotation: number, cap: number, scene?: Nullable<Scene>, updatable?: boolean, sideOrientation?: number, instance?: Mesh): Mesh;
  34681. /**
  34682. * Creates an custom extruded shape mesh.
  34683. * The custom extrusion is a parametric shape.
  34684. * It has no predefined shape. Its final shape will depend on the input parameters.
  34685. * Please consider using the same method from the MeshBuilder class instead
  34686. * @see https://doc.babylonjs.com/how_to/parametric_shapes#extruded-shapes
  34687. * @param name defines the name of the mesh to create
  34688. * @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
  34689. * @param path is a required array of successive Vector3. This is the axis curve the shape is extruded along
  34690. * @param scaleFunction is a custom Javascript function called on each path point
  34691. * @param rotationFunction is a custom Javascript function called on each path point
  34692. * @param ribbonCloseArray forces the extrusion underlying ribbon to close all the paths in its `pathArray`
  34693. * @param ribbonClosePath forces the extrusion underlying ribbon to close its `pathArray`
  34694. * @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
  34695. * @param scene defines the hosting scene
  34696. * @param updatable defines if the mesh must be flagged as updatable
  34697. * @param sideOrientation defines the mesh side orientation (https://doc.babylonjs.com/babylon101/discover_basic_elements#side-orientation)
  34698. * @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)
  34699. * @returns a new Mesh
  34700. */
  34701. 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;
  34702. /**
  34703. * Creates lathe mesh.
  34704. * The lathe is a shape with a symetry axis : a 2D model shape is rotated around this axis to design the lathe.
  34705. * Please consider using the same method from the MeshBuilder class instead
  34706. * @param name defines the name of the mesh to create
  34707. * @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
  34708. * @param radius is the radius value of the lathe
  34709. * @param tessellation is the side number of the lathe.
  34710. * @param scene defines the hosting scene
  34711. * @param updatable defines if the mesh must be flagged as updatable
  34712. * @param sideOrientation defines the mesh side orientation (https://doc.babylonjs.com/babylon101/discover_basic_elements#side-orientation)
  34713. * @returns a new Mesh
  34714. */
  34715. static CreateLathe(name: string, shape: Vector3[], radius: number, tessellation: number, scene: Scene, updatable?: boolean, sideOrientation?: number): Mesh;
  34716. /**
  34717. * Creates a plane mesh. Please consider using the same method from the MeshBuilder class instead
  34718. * @param name defines the name of the mesh to create
  34719. * @param size sets the size (float) of both sides of the plane at once (default 1)
  34720. * @param scene defines the hosting scene
  34721. * @param updatable defines if the mesh must be flagged as updatable
  34722. * @param sideOrientation defines the mesh side orientation (https://doc.babylonjs.com/babylon101/discover_basic_elements#side-orientation)
  34723. * @returns a new Mesh
  34724. */
  34725. static CreatePlane(name: string, size: number, scene: Scene, updatable?: boolean, sideOrientation?: number): Mesh;
  34726. /**
  34727. * Creates a ground mesh.
  34728. * Please consider using the same method from the MeshBuilder class instead
  34729. * @param name defines the name of the mesh to create
  34730. * @param width set the width of the ground
  34731. * @param height set the height of the ground
  34732. * @param subdivisions sets the number of subdivisions per side
  34733. * @param scene defines the hosting scene
  34734. * @param updatable defines if the mesh must be flagged as updatable
  34735. * @returns a new Mesh
  34736. */
  34737. static CreateGround(name: string, width: number, height: number, subdivisions: number, scene?: Scene, updatable?: boolean): Mesh;
  34738. /**
  34739. * Creates a tiled ground mesh.
  34740. * Please consider using the same method from the MeshBuilder class instead
  34741. * @param name defines the name of the mesh to create
  34742. * @param xmin set the ground minimum X coordinate
  34743. * @param zmin set the ground minimum Y coordinate
  34744. * @param xmax set the ground maximum X coordinate
  34745. * @param zmax set the ground maximum Z coordinate
  34746. * @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
  34747. * @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
  34748. * @param scene defines the hosting scene
  34749. * @param updatable defines if the mesh must be flagged as updatable
  34750. * @returns a new Mesh
  34751. */
  34752. static CreateTiledGround(name: string, xmin: number, zmin: number, xmax: number, zmax: number, subdivisions: {
  34753. w: number;
  34754. h: number;
  34755. }, precision: {
  34756. w: number;
  34757. h: number;
  34758. }, scene: Scene, updatable?: boolean): Mesh;
  34759. /**
  34760. * Creates a ground mesh from a height map.
  34761. * Please consider using the same method from the MeshBuilder class instead
  34762. * @see https://doc.babylonjs.com/babylon101/height_map
  34763. * @param name defines the name of the mesh to create
  34764. * @param url sets the URL of the height map image resource
  34765. * @param width set the ground width size
  34766. * @param height set the ground height size
  34767. * @param subdivisions sets the number of subdivision per side
  34768. * @param minHeight is the minimum altitude on the ground
  34769. * @param maxHeight is the maximum altitude on the ground
  34770. * @param scene defines the hosting scene
  34771. * @param updatable defines if the mesh must be flagged as updatable
  34772. * @param onReady is a callback function that will be called once the mesh is built (the height map download can last some time)
  34773. * @param alphaFilter will filter any data where the alpha channel is below this value, defaults 0 (all data visible)
  34774. * @returns a new Mesh
  34775. */
  34776. 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;
  34777. /**
  34778. * Creates a tube mesh.
  34779. * The tube is a parametric shape.
  34780. * It has no predefined shape. Its final shape will depend on the input parameters.
  34781. * Please consider using the same method from the MeshBuilder class instead
  34782. * @see https://doc.babylonjs.com/how_to/parametric_shapes
  34783. * @param name defines the name of the mesh to create
  34784. * @param path is a required array of successive Vector3. It is the curve used as the axis of the tube
  34785. * @param radius sets the tube radius size
  34786. * @param tessellation is the number of sides on the tubular surface
  34787. * @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
  34788. * @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
  34789. * @param scene defines the hosting scene
  34790. * @param updatable defines if the mesh must be flagged as updatable
  34791. * @param sideOrientation defines the mesh side orientation (https://doc.babylonjs.com/babylon101/discover_basic_elements#side-orientation)
  34792. * @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)
  34793. * @returns a new Mesh
  34794. */
  34795. static CreateTube(name: string, path: Vector3[], radius: number, tessellation: number, radiusFunction: {
  34796. (i: number, distance: number): number;
  34797. }, cap: number, scene: Scene, updatable?: boolean, sideOrientation?: number, instance?: Mesh): Mesh;
  34798. /**
  34799. * Creates a polyhedron mesh.
  34800. * Please consider using the same method from the MeshBuilder class instead.
  34801. * * 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
  34802. * * The parameter `size` (positive float, default 1) sets the polygon size
  34803. * * You can overwrite the `size` on each dimension bu using the parameters `sizeX`, `sizeY` or `sizeZ` (positive floats, default to `size` value)
  34804. * * 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`
  34805. * * 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
  34806. * * 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)`)
  34807. * * 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
  34808. * * 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
  34809. * * You can also set the mesh side orientation with the values : Mesh.FRONTSIDE (default), Mesh.BACKSIDE or Mesh.DOUBLESIDE
  34810. * * If you create a double-sided mesh, you can choose what parts of the texture image to crop and stick respectively on the front and the back sides with the parameters `frontUVs` and `backUVs` (Vector4). Detail here : https://doc.babylonjs.com/babylon101/discover_basic_elements#side-orientation
  34811. * * The mesh can be set to updatable with the boolean parameter `updatable` (default false) if its internal geometry is supposed to change once created
  34812. * @param name defines the name of the mesh to create
  34813. * @param options defines the options used to create the mesh
  34814. * @param scene defines the hosting scene
  34815. * @returns a new Mesh
  34816. */
  34817. static CreatePolyhedron(name: string, options: {
  34818. type?: number;
  34819. size?: number;
  34820. sizeX?: number;
  34821. sizeY?: number;
  34822. sizeZ?: number;
  34823. custom?: any;
  34824. faceUV?: Vector4[];
  34825. faceColors?: Color4[];
  34826. updatable?: boolean;
  34827. sideOrientation?: number;
  34828. }, scene: Scene): Mesh;
  34829. /**
  34830. * Creates a sphere based upon an icosahedron with 20 triangular faces which can be subdivided
  34831. * * The parameter `radius` sets the radius size (float) of the icosphere (default 1)
  34832. * * 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`)
  34833. * * The parameter `subdivisions` sets the number of subdivisions (postive integer, default 4). The more subdivisions, the more faces on the icosphere whatever its size
  34834. * * 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
  34835. * * You can also set the mesh side orientation with the values : Mesh.FRONTSIDE (default), Mesh.BACKSIDE or Mesh.DOUBLESIDE
  34836. * * If you create a double-sided mesh, you can choose what parts of the texture image to crop and stick respectively on the front and the back sides with the parameters `frontUVs` and `backUVs` (Vector4). Detail here : https://doc.babylonjs.com/babylon101/discover_basic_elements#side-orientation
  34837. * * The mesh can be set to updatable with the boolean parameter `updatable` (default false) if its internal geometry is supposed to change once created
  34838. * @param name defines the name of the mesh
  34839. * @param options defines the options used to create the mesh
  34840. * @param scene defines the hosting scene
  34841. * @returns a new Mesh
  34842. * @see https://doc.babylonjs.com/how_to/polyhedra_shapes#icosphere
  34843. */
  34844. static CreateIcoSphere(name: string, options: {
  34845. radius?: number;
  34846. flat?: boolean;
  34847. subdivisions?: number;
  34848. sideOrientation?: number;
  34849. updatable?: boolean;
  34850. }, scene: Scene): Mesh;
  34851. /**
  34852. * Creates a decal mesh.
  34853. * Please consider using the same method from the MeshBuilder class instead.
  34854. * A decal is a mesh usually applied as a model onto the surface of another mesh
  34855. * @param name defines the name of the mesh
  34856. * @param sourceMesh defines the mesh receiving the decal
  34857. * @param position sets the position of the decal in world coordinates
  34858. * @param normal sets the normal of the mesh where the decal is applied onto in world coordinates
  34859. * @param size sets the decal scaling
  34860. * @param angle sets the angle to rotate the decal
  34861. * @returns a new Mesh
  34862. */
  34863. static CreateDecal(name: string, sourceMesh: AbstractMesh, position: Vector3, normal: Vector3, size: Vector3, angle: number): Mesh;
  34864. /** Creates a Capsule Mesh
  34865. * @param name defines the name of the mesh.
  34866. * @param options the constructors options used to shape the mesh.
  34867. * @param scene defines the scene the mesh is scoped to.
  34868. * @returns the capsule mesh
  34869. * @see https://doc.babylonjs.com/how_to/capsule_shape
  34870. */
  34871. static CreateCapsule(name: string, options: ICreateCapsuleOptions, scene: Scene): Mesh;
  34872. /**
  34873. * Prepare internal position array for software CPU skinning
  34874. * @returns original positions used for CPU skinning. Useful for integrating Morphing with skeletons in same mesh
  34875. */
  34876. setPositionsForCPUSkinning(): Float32Array;
  34877. /**
  34878. * Prepare internal normal array for software CPU skinning
  34879. * @returns original normals used for CPU skinning. Useful for integrating Morphing with skeletons in same mesh.
  34880. */
  34881. setNormalsForCPUSkinning(): Float32Array;
  34882. /**
  34883. * Updates the vertex buffer by applying transformation from the bones
  34884. * @param skeleton defines the skeleton to apply to current mesh
  34885. * @returns the current mesh
  34886. */
  34887. applySkeleton(skeleton: Skeleton): Mesh;
  34888. /**
  34889. * 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
  34890. * @param meshes defines the list of meshes to scan
  34891. * @returns an object `{min:` Vector3`, max:` Vector3`}`
  34892. */
  34893. static MinMax(meshes: AbstractMesh[]): {
  34894. min: Vector3;
  34895. max: Vector3;
  34896. };
  34897. /**
  34898. * Returns the center of the `{min:` Vector3`, max:` Vector3`}` or the center of MinMax vector3 computed from a mesh array
  34899. * @param meshesOrMinMaxVector could be an array of meshes or a `{min:` Vector3`, max:` Vector3`}` object
  34900. * @returns a vector3
  34901. */
  34902. static Center(meshesOrMinMaxVector: {
  34903. min: Vector3;
  34904. max: Vector3;
  34905. } | AbstractMesh[]): Vector3;
  34906. /**
  34907. * Merge the array of meshes into a single mesh for performance reasons.
  34908. * @param meshes defines he vertices source. They should all be of the same material. Entries can empty
  34909. * @param disposeSource when true (default), dispose of the vertices from the source meshes
  34910. * @param allow32BitsIndices when the sum of the vertices > 64k, this must be set to true
  34911. * @param meshSubclass when set, vertices inserted into this Mesh. Meshes can then be merged into a Mesh sub-class.
  34912. * @param subdivideWithSubMeshes when true (false default), subdivide mesh to his subMesh array with meshes source.
  34913. * @param multiMultiMaterials when true (false default), subdivide mesh and accept multiple multi materials, ignores subdivideWithSubMeshes.
  34914. * @returns a new mesh
  34915. */
  34916. static MergeMeshes(meshes: Array<Mesh>, disposeSource?: boolean, allow32BitsIndices?: boolean, meshSubclass?: Mesh, subdivideWithSubMeshes?: boolean, multiMultiMaterials?: boolean): Nullable<Mesh>;
  34917. /** @hidden */
  34918. addInstance(instance: InstancedMesh): void;
  34919. /** @hidden */
  34920. removeInstance(instance: InstancedMesh): void;
  34921. }
  34922. }
  34923. declare module "babylonjs/Cameras/camera" {
  34924. import { SmartArray } from "babylonjs/Misc/smartArray";
  34925. import { Observable } from "babylonjs/Misc/observable";
  34926. import { Nullable } from "babylonjs/types";
  34927. import { CameraInputsManager } from "babylonjs/Cameras/cameraInputsManager";
  34928. import { Scene } from "babylonjs/scene";
  34929. import { Matrix, Vector3, Quaternion } from "babylonjs/Maths/math.vector";
  34930. import { Node } from "babylonjs/node";
  34931. import { Mesh } from "babylonjs/Meshes/mesh";
  34932. import { AbstractMesh } from "babylonjs/Meshes/abstractMesh";
  34933. import { ICullable } from "babylonjs/Culling/boundingInfo";
  34934. import { Viewport } from "babylonjs/Maths/math.viewport";
  34935. import { PostProcess } from "babylonjs/PostProcesses/postProcess";
  34936. import { RenderTargetTexture } from "babylonjs/Materials/Textures/renderTargetTexture";
  34937. import { FreeCamera } from "babylonjs/Cameras/freeCamera";
  34938. import { Ray } from "babylonjs/Culling/ray";
  34939. /**
  34940. * This is the base class of all the camera used in the application.
  34941. * @see https://doc.babylonjs.com/features/cameras
  34942. */
  34943. export class Camera extends Node {
  34944. /** @hidden */
  34945. static _createDefaultParsedCamera: (name: string, scene: Scene) => Camera;
  34946. /**
  34947. * This is the default projection mode used by the cameras.
  34948. * It helps recreating a feeling of perspective and better appreciate depth.
  34949. * This is the best way to simulate real life cameras.
  34950. */
  34951. static readonly PERSPECTIVE_CAMERA: number;
  34952. /**
  34953. * This helps creating camera with an orthographic mode.
  34954. * 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.
  34955. */
  34956. static readonly ORTHOGRAPHIC_CAMERA: number;
  34957. /**
  34958. * This is the default FOV mode for perspective cameras.
  34959. * This setting aligns the upper and lower bounds of the viewport to the upper and lower bounds of the camera frustum.
  34960. */
  34961. static readonly FOVMODE_VERTICAL_FIXED: number;
  34962. /**
  34963. * This setting aligns the left and right bounds of the viewport to the left and right bounds of the camera frustum.
  34964. */
  34965. static readonly FOVMODE_HORIZONTAL_FIXED: number;
  34966. /**
  34967. * This specifies ther is no need for a camera rig.
  34968. * Basically only one eye is rendered corresponding to the camera.
  34969. */
  34970. static readonly RIG_MODE_NONE: number;
  34971. /**
  34972. * Simulates a camera Rig with one blue eye and one red eye.
  34973. * This can be use with 3d blue and red glasses.
  34974. */
  34975. static readonly RIG_MODE_STEREOSCOPIC_ANAGLYPH: number;
  34976. /**
  34977. * Defines that both eyes of the camera will be rendered side by side with a parallel target.
  34978. */
  34979. static readonly RIG_MODE_STEREOSCOPIC_SIDEBYSIDE_PARALLEL: number;
  34980. /**
  34981. * Defines that both eyes of the camera will be rendered side by side with a none parallel target.
  34982. */
  34983. static readonly RIG_MODE_STEREOSCOPIC_SIDEBYSIDE_CROSSEYED: number;
  34984. /**
  34985. * Defines that both eyes of the camera will be rendered over under each other.
  34986. */
  34987. static readonly RIG_MODE_STEREOSCOPIC_OVERUNDER: number;
  34988. /**
  34989. * Defines that both eyes of the camera will be rendered on successive lines interlaced for passive 3d monitors.
  34990. */
  34991. static readonly RIG_MODE_STEREOSCOPIC_INTERLACED: number;
  34992. /**
  34993. * Defines that both eyes of the camera should be renderered in a VR mode (carbox).
  34994. */
  34995. static readonly RIG_MODE_VR: number;
  34996. /**
  34997. * Defines that both eyes of the camera should be renderered in a VR mode (webVR).
  34998. */
  34999. static readonly RIG_MODE_WEBVR: number;
  35000. /**
  35001. * Custom rig mode allowing rig cameras to be populated manually with any number of cameras
  35002. */
  35003. static readonly RIG_MODE_CUSTOM: number;
  35004. /**
  35005. * Defines if by default attaching controls should prevent the default javascript event to continue.
  35006. */
  35007. static ForceAttachControlToAlwaysPreventDefault: boolean;
  35008. /**
  35009. * Define the input manager associated with the camera.
  35010. */
  35011. inputs: CameraInputsManager<Camera>;
  35012. /** @hidden */
  35013. _position: Vector3;
  35014. /**
  35015. * Define the current local position of the camera in the scene
  35016. */
  35017. get position(): Vector3;
  35018. set position(newPosition: Vector3);
  35019. protected _upVector: Vector3;
  35020. /**
  35021. * The vector the camera should consider as up.
  35022. * (default is Vector3(0, 1, 0) aka Vector3.Up())
  35023. */
  35024. set upVector(vec: Vector3);
  35025. get upVector(): Vector3;
  35026. /**
  35027. * Define the current limit on the left side for an orthographic camera
  35028. * In scene unit
  35029. */
  35030. orthoLeft: Nullable<number>;
  35031. /**
  35032. * Define the current limit on the right side for an orthographic camera
  35033. * In scene unit
  35034. */
  35035. orthoRight: Nullable<number>;
  35036. /**
  35037. * Define the current limit on the bottom side for an orthographic camera
  35038. * In scene unit
  35039. */
  35040. orthoBottom: Nullable<number>;
  35041. /**
  35042. * Define the current limit on the top side for an orthographic camera
  35043. * In scene unit
  35044. */
  35045. orthoTop: Nullable<number>;
  35046. /**
  35047. * Field Of View is set in Radians. (default is 0.8)
  35048. */
  35049. fov: number;
  35050. /**
  35051. * Define the minimum distance the camera can see from.
  35052. * This is important to note that the depth buffer are not infinite and the closer it starts
  35053. * the more your scene might encounter depth fighting issue.
  35054. */
  35055. minZ: number;
  35056. /**
  35057. * Define the maximum distance the camera can see to.
  35058. * This is important to note that the depth buffer are not infinite and the further it end
  35059. * the more your scene might encounter depth fighting issue.
  35060. */
  35061. maxZ: number;
  35062. /**
  35063. * Define the default inertia of the camera.
  35064. * This helps giving a smooth feeling to the camera movement.
  35065. */
  35066. inertia: number;
  35067. /**
  35068. * Define the mode of the camera (Camera.PERSPECTIVE_CAMERA or Camera.ORTHOGRAPHIC_CAMERA)
  35069. */
  35070. mode: number;
  35071. /**
  35072. * Define whether the camera is intermediate.
  35073. * This is useful to not present the output directly to the screen in case of rig without post process for instance
  35074. */
  35075. isIntermediate: boolean;
  35076. /**
  35077. * Define the viewport of the camera.
  35078. * This correspond to the portion of the screen the camera will render to in normalized 0 to 1 unit.
  35079. */
  35080. viewport: Viewport;
  35081. /**
  35082. * Restricts the camera to viewing objects with the same layerMask.
  35083. * A camera with a layerMask of 1 will render mesh.layerMask & camera.layerMask!== 0
  35084. */
  35085. layerMask: number;
  35086. /**
  35087. * fovMode sets the camera frustum bounds to the viewport bounds. (default is FOVMODE_VERTICAL_FIXED)
  35088. */
  35089. fovMode: number;
  35090. /**
  35091. * Rig mode of the camera.
  35092. * This is useful to create the camera with two "eyes" instead of one to create VR or stereoscopic scenes.
  35093. * This is normally controlled byt the camera themselves as internal use.
  35094. */
  35095. cameraRigMode: number;
  35096. /**
  35097. * Defines the distance between both "eyes" in case of a RIG
  35098. */
  35099. interaxialDistance: number;
  35100. /**
  35101. * Defines if stereoscopic rendering is done side by side or over under.
  35102. */
  35103. isStereoscopicSideBySide: boolean;
  35104. /**
  35105. * 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
  35106. * This is pretty helpfull if you wish to make a camera render to a texture you could reuse somewhere
  35107. * else in the scene. (Eg. security camera)
  35108. *
  35109. * 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)
  35110. */
  35111. customRenderTargets: import("babylonjs/Materials/Textures/renderTargetTexture").RenderTargetTexture[];
  35112. /**
  35113. * When set, the camera will render to this render target instead of the default canvas
  35114. *
  35115. * If the desire is to use the output of a camera as a texture in the scene consider using camera.customRenderTargets instead
  35116. */
  35117. outputRenderTarget: Nullable<RenderTargetTexture>;
  35118. /**
  35119. * Observable triggered when the camera view matrix has changed.
  35120. */
  35121. onViewMatrixChangedObservable: Observable<Camera>;
  35122. /**
  35123. * Observable triggered when the camera Projection matrix has changed.
  35124. */
  35125. onProjectionMatrixChangedObservable: Observable<Camera>;
  35126. /**
  35127. * Observable triggered when the inputs have been processed.
  35128. */
  35129. onAfterCheckInputsObservable: Observable<Camera>;
  35130. /**
  35131. * Observable triggered when reset has been called and applied to the camera.
  35132. */
  35133. onRestoreStateObservable: Observable<Camera>;
  35134. /**
  35135. * Is this camera a part of a rig system?
  35136. */
  35137. isRigCamera: boolean;
  35138. /**
  35139. * If isRigCamera set to true this will be set with the parent camera.
  35140. * The parent camera is not (!) necessarily the .parent of this camera (like in the case of XR)
  35141. */
  35142. rigParent?: Camera;
  35143. /** @hidden */
  35144. _cameraRigParams: any;
  35145. /** @hidden */
  35146. _rigCameras: Camera[];
  35147. /** @hidden */
  35148. _rigPostProcess: Nullable<PostProcess>;
  35149. protected _webvrViewMatrix: Matrix;
  35150. /** @hidden */
  35151. _skipRendering: boolean;
  35152. /** @hidden */
  35153. _projectionMatrix: Matrix;
  35154. /** @hidden */
  35155. _postProcesses: Nullable<import("babylonjs/PostProcesses/postProcess").PostProcess>[];
  35156. /** @hidden */
  35157. _activeMeshes: SmartArray<AbstractMesh>;
  35158. protected _globalPosition: Vector3;
  35159. /** @hidden */
  35160. _computedViewMatrix: Matrix;
  35161. private _doNotComputeProjectionMatrix;
  35162. private _transformMatrix;
  35163. private _frustumPlanes;
  35164. private _refreshFrustumPlanes;
  35165. private _storedFov;
  35166. private _stateStored;
  35167. /**
  35168. * Instantiates a new camera object.
  35169. * This should not be used directly but through the inherited cameras: ArcRotate, Free...
  35170. * @see https://doc.babylonjs.com/features/cameras
  35171. * @param name Defines the name of the camera in the scene
  35172. * @param position Defines the position of the camera
  35173. * @param scene Defines the scene the camera belongs too
  35174. * @param setActiveOnSceneIfNoneActive Defines if the camera should be set as active after creation if no other camera have been defined in the scene
  35175. */
  35176. constructor(name: string, position: Vector3, scene: Scene, setActiveOnSceneIfNoneActive?: boolean);
  35177. /**
  35178. * Store current camera state (fov, position, etc..)
  35179. * @returns the camera
  35180. */
  35181. storeState(): Camera;
  35182. /**
  35183. * Restores the camera state values if it has been stored. You must call storeState() first
  35184. */
  35185. protected _restoreStateValues(): boolean;
  35186. /**
  35187. * Restored camera state. You must call storeState() first.
  35188. * @returns true if restored and false otherwise
  35189. */
  35190. restoreState(): boolean;
  35191. /**
  35192. * Gets the class name of the camera.
  35193. * @returns the class name
  35194. */
  35195. getClassName(): string;
  35196. /** @hidden */
  35197. readonly _isCamera: boolean;
  35198. /**
  35199. * Gets a string representation of the camera useful for debug purpose.
  35200. * @param fullDetails Defines that a more verboe level of logging is required
  35201. * @returns the string representation
  35202. */
  35203. toString(fullDetails?: boolean): string;
  35204. /**
  35205. * Gets the current world space position of the camera.
  35206. */
  35207. get globalPosition(): Vector3;
  35208. /**
  35209. * Gets the list of active meshes this frame (meshes no culled or excluded by lod s in the frame)
  35210. * @returns the active meshe list
  35211. */
  35212. getActiveMeshes(): SmartArray<AbstractMesh>;
  35213. /**
  35214. * Check whether a mesh is part of the current active mesh list of the camera
  35215. * @param mesh Defines the mesh to check
  35216. * @returns true if active, false otherwise
  35217. */
  35218. isActiveMesh(mesh: Mesh): boolean;
  35219. /**
  35220. * Is this camera ready to be used/rendered
  35221. * @param completeCheck defines if a complete check (including post processes) has to be done (false by default)
  35222. * @return true if the camera is ready
  35223. */
  35224. isReady(completeCheck?: boolean): boolean;
  35225. /** @hidden */
  35226. _initCache(): void;
  35227. /** @hidden */
  35228. _updateCache(ignoreParentClass?: boolean): void;
  35229. /** @hidden */
  35230. _isSynchronized(): boolean;
  35231. /** @hidden */
  35232. _isSynchronizedViewMatrix(): boolean;
  35233. /** @hidden */
  35234. _isSynchronizedProjectionMatrix(): boolean;
  35235. /**
  35236. * Attach the input controls to a specific dom element to get the input from.
  35237. * @param element Defines the element the controls should be listened from
  35238. * @param noPreventDefault Defines whether event caught by the controls should call preventdefault() (https://developer.mozilla.org/en-US/docs/Web/API/Event/preventDefault)
  35239. */
  35240. attachControl(element: HTMLElement, noPreventDefault?: boolean): void;
  35241. /**
  35242. * Detach the current controls from the specified dom element.
  35243. * @param element Defines the element to stop listening the inputs from
  35244. */
  35245. detachControl(element: HTMLElement): void;
  35246. /**
  35247. * Update the camera state according to the different inputs gathered during the frame.
  35248. */
  35249. update(): void;
  35250. /** @hidden */
  35251. _checkInputs(): void;
  35252. /** @hidden */
  35253. get rigCameras(): Camera[];
  35254. /**
  35255. * Gets the post process used by the rig cameras
  35256. */
  35257. get rigPostProcess(): Nullable<PostProcess>;
  35258. /**
  35259. * Internal, gets the first post proces.
  35260. * @returns the first post process to be run on this camera.
  35261. */
  35262. _getFirstPostProcess(): Nullable<PostProcess>;
  35263. private _cascadePostProcessesToRigCams;
  35264. /**
  35265. * Attach a post process to the camera.
  35266. * @see https://doc.babylonjs.com/how_to/how_to_use_postprocesses#attach-postprocess
  35267. * @param postProcess The post process to attach to the camera
  35268. * @param insertAt The position of the post process in case several of them are in use in the scene
  35269. * @returns the position the post process has been inserted at
  35270. */
  35271. attachPostProcess(postProcess: PostProcess, insertAt?: Nullable<number>): number;
  35272. /**
  35273. * Detach a post process to the camera.
  35274. * @see https://doc.babylonjs.com/how_to/how_to_use_postprocesses#attach-postprocess
  35275. * @param postProcess The post process to detach from the camera
  35276. */
  35277. detachPostProcess(postProcess: PostProcess): void;
  35278. /**
  35279. * Gets the current world matrix of the camera
  35280. */
  35281. getWorldMatrix(): Matrix;
  35282. /** @hidden */
  35283. _getViewMatrix(): Matrix;
  35284. /**
  35285. * Gets the current view matrix of the camera.
  35286. * @param force forces the camera to recompute the matrix without looking at the cached state
  35287. * @returns the view matrix
  35288. */
  35289. getViewMatrix(force?: boolean): Matrix;
  35290. /**
  35291. * Freeze the projection matrix.
  35292. * It will prevent the cache check of the camera projection compute and can speed up perf
  35293. * if no parameter of the camera are meant to change
  35294. * @param projection Defines manually a projection if necessary
  35295. */
  35296. freezeProjectionMatrix(projection?: Matrix): void;
  35297. /**
  35298. * Unfreeze the projection matrix if it has previously been freezed by freezeProjectionMatrix.
  35299. */
  35300. unfreezeProjectionMatrix(): void;
  35301. /**
  35302. * Gets the current projection matrix of the camera.
  35303. * @param force forces the camera to recompute the matrix without looking at the cached state
  35304. * @returns the projection matrix
  35305. */
  35306. getProjectionMatrix(force?: boolean): Matrix;
  35307. /**
  35308. * Gets the transformation matrix (ie. the multiplication of view by projection matrices)
  35309. * @returns a Matrix
  35310. */
  35311. getTransformationMatrix(): Matrix;
  35312. private _updateFrustumPlanes;
  35313. /**
  35314. * Checks if a cullable object (mesh...) is in the camera frustum
  35315. * This checks the bounding box center. See isCompletelyInFrustum for a full bounding check
  35316. * @param target The object to check
  35317. * @param checkRigCameras If the rig cameras should be checked (eg. with webVR camera both eyes should be checked) (Default: false)
  35318. * @returns true if the object is in frustum otherwise false
  35319. */
  35320. isInFrustum(target: ICullable, checkRigCameras?: boolean): boolean;
  35321. /**
  35322. * Checks if a cullable object (mesh...) is in the camera frustum
  35323. * Unlike isInFrustum this cheks the full bounding box
  35324. * @param target The object to check
  35325. * @returns true if the object is in frustum otherwise false
  35326. */
  35327. isCompletelyInFrustum(target: ICullable): boolean;
  35328. /**
  35329. * Gets a ray in the forward direction from the camera.
  35330. * @param length Defines the length of the ray to create
  35331. * @param transform Defines the transform to apply to the ray, by default the world matrx is used to create a workd space ray
  35332. * @param origin Defines the start point of the ray which defaults to the camera position
  35333. * @returns the forward ray
  35334. */
  35335. getForwardRay(length?: number, transform?: Matrix, origin?: Vector3): Ray;
  35336. /**
  35337. * Gets a ray in the forward direction from the camera.
  35338. * @param refRay the ray to (re)use when setting the values
  35339. * @param length Defines the length of the ray to create
  35340. * @param transform Defines the transform to apply to the ray, by default the world matrx is used to create a workd space ray
  35341. * @param origin Defines the start point of the ray which defaults to the camera position
  35342. * @returns the forward ray
  35343. */
  35344. getForwardRayToRef(refRay: Ray, length?: number, transform?: Matrix, origin?: Vector3): Ray;
  35345. /**
  35346. * Releases resources associated with this node.
  35347. * @param doNotRecurse Set to true to not recurse into each children (recurse into each children by default)
  35348. * @param disposeMaterialAndTextures Set to true to also dispose referenced materials and textures (false by default)
  35349. */
  35350. dispose(doNotRecurse?: boolean, disposeMaterialAndTextures?: boolean): void;
  35351. /** @hidden */
  35352. _isLeftCamera: boolean;
  35353. /**
  35354. * Gets the left camera of a rig setup in case of Rigged Camera
  35355. */
  35356. get isLeftCamera(): boolean;
  35357. /** @hidden */
  35358. _isRightCamera: boolean;
  35359. /**
  35360. * Gets the right camera of a rig setup in case of Rigged Camera
  35361. */
  35362. get isRightCamera(): boolean;
  35363. /**
  35364. * Gets the left camera of a rig setup in case of Rigged Camera
  35365. */
  35366. get leftCamera(): Nullable<FreeCamera>;
  35367. /**
  35368. * Gets the right camera of a rig setup in case of Rigged Camera
  35369. */
  35370. get rightCamera(): Nullable<FreeCamera>;
  35371. /**
  35372. * Gets the left camera target of a rig setup in case of Rigged Camera
  35373. * @returns the target position
  35374. */
  35375. getLeftTarget(): Nullable<Vector3>;
  35376. /**
  35377. * Gets the right camera target of a rig setup in case of Rigged Camera
  35378. * @returns the target position
  35379. */
  35380. getRightTarget(): Nullable<Vector3>;
  35381. /**
  35382. * @hidden
  35383. */
  35384. setCameraRigMode(mode: number, rigParams: any): void;
  35385. /** @hidden */
  35386. static _setStereoscopicRigMode(camera: Camera): void;
  35387. /** @hidden */
  35388. static _setStereoscopicAnaglyphRigMode(camera: Camera): void;
  35389. /** @hidden */
  35390. static _setVRRigMode(camera: Camera, rigParams: any): void;
  35391. /** @hidden */
  35392. static _setWebVRRigMode(camera: Camera, rigParams: any): void;
  35393. /** @hidden */
  35394. _getVRProjectionMatrix(): Matrix;
  35395. protected _updateCameraRotationMatrix(): void;
  35396. protected _updateWebVRCameraRotationMatrix(): void;
  35397. /**
  35398. * This function MUST be overwritten by the different WebVR cameras available.
  35399. * The context in which it is running is the RIG camera. So 'this' is the TargetCamera, left or right.
  35400. * @hidden
  35401. */
  35402. _getWebVRProjectionMatrix(): Matrix;
  35403. /**
  35404. * This function MUST be overwritten by the different WebVR cameras available.
  35405. * The context in which it is running is the RIG camera. So 'this' is the TargetCamera, left or right.
  35406. * @hidden
  35407. */
  35408. _getWebVRViewMatrix(): Matrix;
  35409. /** @hidden */
  35410. setCameraRigParameter(name: string, value: any): void;
  35411. /**
  35412. * needs to be overridden by children so sub has required properties to be copied
  35413. * @hidden
  35414. */
  35415. createRigCamera(name: string, cameraIndex: number): Nullable<Camera>;
  35416. /**
  35417. * May need to be overridden by children
  35418. * @hidden
  35419. */
  35420. _updateRigCameras(): void;
  35421. /** @hidden */
  35422. _setupInputs(): void;
  35423. /**
  35424. * Serialiaze the camera setup to a json represention
  35425. * @returns the JSON representation
  35426. */
  35427. serialize(): any;
  35428. /**
  35429. * Clones the current camera.
  35430. * @param name The cloned camera name
  35431. * @returns the cloned camera
  35432. */
  35433. clone(name: string): Camera;
  35434. /**
  35435. * Gets the direction of the camera relative to a given local axis.
  35436. * @param localAxis Defines the reference axis to provide a relative direction.
  35437. * @return the direction
  35438. */
  35439. getDirection(localAxis: Vector3): Vector3;
  35440. /**
  35441. * Returns the current camera absolute rotation
  35442. */
  35443. get absoluteRotation(): Quaternion;
  35444. /**
  35445. * Gets the direction of the camera relative to a given local axis into a passed vector.
  35446. * @param localAxis Defines the reference axis to provide a relative direction.
  35447. * @param result Defines the vector to store the result in
  35448. */
  35449. getDirectionToRef(localAxis: Vector3, result: Vector3): void;
  35450. /**
  35451. * Gets a camera constructor for a given camera type
  35452. * @param type The type of the camera to construct (should be equal to one of the camera class name)
  35453. * @param name The name of the camera the result will be able to instantiate
  35454. * @param scene The scene the result will construct the camera in
  35455. * @param interaxial_distance In case of stereoscopic setup, the distance between both eyes
  35456. * @param isStereoscopicSideBySide In case of stereoscopic setup, should the sereo be side b side
  35457. * @returns a factory method to construc the camera
  35458. */
  35459. static GetConstructorFromName(type: string, name: string, scene: Scene, interaxial_distance?: number, isStereoscopicSideBySide?: boolean): () => Camera;
  35460. /**
  35461. * Compute the world matrix of the camera.
  35462. * @returns the camera world matrix
  35463. */
  35464. computeWorldMatrix(): Matrix;
  35465. /**
  35466. * Parse a JSON and creates the camera from the parsed information
  35467. * @param parsedCamera The JSON to parse
  35468. * @param scene The scene to instantiate the camera in
  35469. * @returns the newly constructed camera
  35470. */
  35471. static Parse(parsedCamera: any, scene: Scene): Camera;
  35472. }
  35473. }
  35474. declare module "babylonjs/Meshes/Builders/discBuilder" {
  35475. import { Nullable } from "babylonjs/types";
  35476. import { Scene } from "babylonjs/scene";
  35477. import { Vector4 } from "babylonjs/Maths/math.vector";
  35478. import { Mesh } from "babylonjs/Meshes/mesh";
  35479. /**
  35480. * Class containing static functions to help procedurally build meshes
  35481. */
  35482. export class DiscBuilder {
  35483. /**
  35484. * Creates a plane polygonal mesh. By default, this is a disc
  35485. * * The parameter `radius` sets the radius size (float) of the polygon (default 0.5)
  35486. * * 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
  35487. * * 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
  35488. * * You can also set the mesh side orientation with the values : BABYLON.Mesh.FRONTSIDE (default), BABYLON.Mesh.BACKSIDE or BABYLON.Mesh.DOUBLESIDE
  35489. * * If you create a double-sided mesh, you can choose what parts of the texture image to crop and stick respectively on the front and the back sides with the parameters `frontUVs` and `backUVs` (Vector4). Detail here : https://doc.babylonjs.com/babylon101/discover_basic_elements#side-orientation
  35490. * * The mesh can be set to updatable with the boolean parameter `updatable` (default false) if its internal geometry is supposed to change once created
  35491. * @param name defines the name of the mesh
  35492. * @param options defines the options used to create the mesh
  35493. * @param scene defines the hosting scene
  35494. * @returns the plane polygonal mesh
  35495. * @see https://doc.babylonjs.com/how_to/set_shapes#disc-or-regular-polygon
  35496. */
  35497. static CreateDisc(name: string, options: {
  35498. radius?: number;
  35499. tessellation?: number;
  35500. arc?: number;
  35501. updatable?: boolean;
  35502. sideOrientation?: number;
  35503. frontUVs?: Vector4;
  35504. backUVs?: Vector4;
  35505. }, scene?: Nullable<Scene>): Mesh;
  35506. }
  35507. }
  35508. declare module "babylonjs/Particles/solidParticleSystem" {
  35509. import { Nullable } from "babylonjs/types";
  35510. import { Mesh } from "babylonjs/Meshes/mesh";
  35511. import { Scene, IDisposable } from "babylonjs/scene";
  35512. import { DepthSortedParticle, SolidParticle, SolidParticleVertex } from "babylonjs/Particles/solidParticle";
  35513. import { Material } from "babylonjs/Materials/material";
  35514. import { MultiMaterial } from "babylonjs/Materials/multiMaterial";
  35515. import { PickingInfo } from "babylonjs/Collisions/pickingInfo";
  35516. /**
  35517. * The SPS is a single updatable mesh. The solid particles are simply separate parts or faces fo this big mesh.
  35518. *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.
  35519. * The SPS is also a particle system. It provides some methods to manage the particles.
  35520. * However it is behavior agnostic. This means it has no emitter, no particle physics, no particle recycler. You have to implement your own behavior.
  35521. *
  35522. * Full documentation here : https://doc.babylonjs.com/how_to/Solid_Particle_System
  35523. */
  35524. export class SolidParticleSystem implements IDisposable {
  35525. /**
  35526. * The SPS array of Solid Particle objects. Just access each particle as with any classic array.
  35527. * Example : var p = SPS.particles[i];
  35528. */
  35529. particles: SolidParticle[];
  35530. /**
  35531. * The SPS total number of particles. Read only. Use SPS.counter instead if you need to set your own value.
  35532. */
  35533. nbParticles: number;
  35534. /**
  35535. * If the particles must ever face the camera (default false). Useful for planar particles.
  35536. */
  35537. billboard: boolean;
  35538. /**
  35539. * Recompute normals when adding a shape
  35540. */
  35541. recomputeNormals: boolean;
  35542. /**
  35543. * This a counter ofr your own usage. It's not set by any SPS functions.
  35544. */
  35545. counter: number;
  35546. /**
  35547. * The SPS name. This name is also given to the underlying mesh.
  35548. */
  35549. name: string;
  35550. /**
  35551. * The SPS mesh. It's a standard BJS Mesh, so all the methods from the Mesh class are avalaible.
  35552. */
  35553. mesh: Mesh;
  35554. /**
  35555. * This empty object is intended to store some SPS specific or temporary values in order to lower the Garbage Collector activity.
  35556. * Please read : https://doc.babylonjs.com/how_to/Solid_Particle_System#garbage-collector-concerns
  35557. */
  35558. vars: any;
  35559. /**
  35560. * This array is populated when the SPS is set as 'pickable'.
  35561. * Each key of this array is a `faceId` value that you can get from a pickResult object.
  35562. * Each element of this array is an object `{idx: int, faceId: int}`.
  35563. * `idx` is the picked particle index in the `SPS.particles` array
  35564. * `faceId` is the picked face index counted within this particle.
  35565. * This array is the first element of the pickedBySubMesh array : sps.pickBySubMesh[0].
  35566. * It's not pertinent to use it when using a SPS with the support for MultiMaterial enabled.
  35567. * Use the method SPS.pickedParticle(pickingInfo) instead.
  35568. * Please read : https://doc.babylonjs.com/how_to/Solid_Particle_System#pickable-particles
  35569. */
  35570. pickedParticles: {
  35571. idx: number;
  35572. faceId: number;
  35573. }[];
  35574. /**
  35575. * This array is populated when the SPS is set as 'pickable'
  35576. * Each key of this array is a submesh index.
  35577. * Each element of this array is a second array defined like this :
  35578. * Each key of this second array is a `faceId` value that you can get from a pickResult object.
  35579. * Each element of this second array is an object `{idx: int, faceId: int}`.
  35580. * `idx` is the picked particle index in the `SPS.particles` array
  35581. * `faceId` is the picked face index counted within this particle.
  35582. * It's better to use the method SPS.pickedParticle(pickingInfo) rather than using directly this array.
  35583. * Please read : https://doc.babylonjs.com/how_to/Solid_Particle_System#pickable-particles
  35584. */
  35585. pickedBySubMesh: {
  35586. idx: number;
  35587. faceId: number;
  35588. }[][];
  35589. /**
  35590. * This array is populated when `enableDepthSort` is set to true.
  35591. * Each element of this array is an instance of the class DepthSortedParticle.
  35592. */
  35593. depthSortedParticles: DepthSortedParticle[];
  35594. /**
  35595. * If the particle intersection must be computed only with the bounding sphere (no bounding box computation, so faster). (Internal use only)
  35596. * @hidden
  35597. */
  35598. _bSphereOnly: boolean;
  35599. /**
  35600. * A number to multiply the boundind sphere radius by in order to reduce it for instance. (Internal use only)
  35601. * @hidden
  35602. */
  35603. _bSphereRadiusFactor: number;
  35604. private _scene;
  35605. private _positions;
  35606. private _indices;
  35607. private _normals;
  35608. private _colors;
  35609. private _uvs;
  35610. private _indices32;
  35611. private _positions32;
  35612. private _normals32;
  35613. private _fixedNormal32;
  35614. private _colors32;
  35615. private _uvs32;
  35616. private _index;
  35617. private _updatable;
  35618. private _pickable;
  35619. private _isVisibilityBoxLocked;
  35620. private _alwaysVisible;
  35621. private _depthSort;
  35622. private _expandable;
  35623. private _shapeCounter;
  35624. private _copy;
  35625. private _color;
  35626. private _computeParticleColor;
  35627. private _computeParticleTexture;
  35628. private _computeParticleRotation;
  35629. private _computeParticleVertex;
  35630. private _computeBoundingBox;
  35631. private _depthSortParticles;
  35632. private _camera;
  35633. private _mustUnrotateFixedNormals;
  35634. private _particlesIntersect;
  35635. private _needs32Bits;
  35636. private _isNotBuilt;
  35637. private _lastParticleId;
  35638. private _idxOfId;
  35639. private _multimaterialEnabled;
  35640. private _useModelMaterial;
  35641. private _indicesByMaterial;
  35642. private _materialIndexes;
  35643. private _depthSortFunction;
  35644. private _materialSortFunction;
  35645. private _materials;
  35646. private _multimaterial;
  35647. private _materialIndexesById;
  35648. private _defaultMaterial;
  35649. private _autoUpdateSubMeshes;
  35650. private _tmpVertex;
  35651. /**
  35652. * Creates a SPS (Solid Particle System) object.
  35653. * @param name (String) is the SPS name, this will be the underlying mesh name.
  35654. * @param scene (Scene) is the scene in which the SPS is added.
  35655. * @param options defines the options of the sps e.g.
  35656. * * updatable (optional boolean, default true) : if the SPS must be updatable or immutable.
  35657. * * isPickable (optional boolean, default false) : if the solid particles must be pickable.
  35658. * * enableDepthSort (optional boolean, default false) : if the solid particles must be sorted in the geometry according to their distance to the camera.
  35659. * * 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.
  35660. * * enableMultiMaterial (optional boolean, default false) : if the solid particles can be given different materials.
  35661. * * expandable (optional boolean, default false) : if particles can still be added after the initial SPS mesh creation.
  35662. * * particleIntersection (optional boolean, default false) : if the solid particle intersections must be computed.
  35663. * * boundingSphereOnly (optional boolean, default false) : if the particle intersection must be computed only with the bounding sphere (no bounding box computation, so faster).
  35664. * * bSphereRadiusFactor (optional float, default 1.0) : a number to multiply the boundind sphere radius by in order to reduce it for instance.
  35665. * @example bSphereRadiusFactor = 1.0 / Math.sqrt(3.0) => the bounding sphere exactly matches a spherical mesh.
  35666. */
  35667. constructor(name: string, scene: Scene, options?: {
  35668. updatable?: boolean;
  35669. isPickable?: boolean;
  35670. enableDepthSort?: boolean;
  35671. particleIntersection?: boolean;
  35672. boundingSphereOnly?: boolean;
  35673. bSphereRadiusFactor?: number;
  35674. expandable?: boolean;
  35675. useModelMaterial?: boolean;
  35676. enableMultiMaterial?: boolean;
  35677. });
  35678. /**
  35679. * Builds the SPS underlying mesh. Returns a standard Mesh.
  35680. * If no model shape was added to the SPS, the returned mesh is just a single triangular plane.
  35681. * @returns the created mesh
  35682. */
  35683. buildMesh(): Mesh;
  35684. /**
  35685. * Digests the mesh and generates as many solid particles in the system as wanted. Returns the SPS.
  35686. * These particles will have the same geometry than the mesh parts and will be positioned at the same localisation than the mesh original places.
  35687. * Thus the particles generated from `digest()` have their property `position` set yet.
  35688. * @param mesh ( Mesh ) is the mesh to be digested
  35689. * @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
  35690. * {delta} (optional integer, default 0) is the random extra number of facets per particle , each particle will have between `facetNb` and `facetNb + delta` facets
  35691. * {number} (optional positive integer) is the wanted number of particles : each particle is built with `mesh_total_facets / number` facets
  35692. * {storage} (optional existing array) is an array where the particles will be stored for a further use instead of being inserted in the SPS.
  35693. * @returns the current SPS
  35694. */
  35695. digest(mesh: Mesh, options?: {
  35696. facetNb?: number;
  35697. number?: number;
  35698. delta?: number;
  35699. storage?: [];
  35700. }): SolidParticleSystem;
  35701. /**
  35702. * Unrotate the fixed normals in case the mesh was built with pre-rotated particles, ex : use of positionFunction in addShape()
  35703. * @hidden
  35704. */
  35705. private _unrotateFixedNormals;
  35706. /**
  35707. * Resets the temporary working copy particle
  35708. * @hidden
  35709. */
  35710. private _resetCopy;
  35711. /**
  35712. * Inserts the shape model geometry in the global SPS mesh by updating the positions, indices, normals, colors, uvs arrays
  35713. * @param p the current index in the positions array to be updated
  35714. * @param ind the current index in the indices array
  35715. * @param shape a Vector3 array, the shape geometry
  35716. * @param positions the positions array to be updated
  35717. * @param meshInd the shape indices array
  35718. * @param indices the indices array to be updated
  35719. * @param meshUV the shape uv array
  35720. * @param uvs the uv array to be updated
  35721. * @param meshCol the shape color array
  35722. * @param colors the color array to be updated
  35723. * @param meshNor the shape normals array
  35724. * @param normals the normals array to be updated
  35725. * @param idx the particle index
  35726. * @param idxInShape the particle index in its shape
  35727. * @param options the addShape() method passed options
  35728. * @model the particle model
  35729. * @hidden
  35730. */
  35731. private _meshBuilder;
  35732. /**
  35733. * Returns a shape Vector3 array from positions float array
  35734. * @param positions float array
  35735. * @returns a vector3 array
  35736. * @hidden
  35737. */
  35738. private _posToShape;
  35739. /**
  35740. * Returns a shapeUV array from a float uvs (array deep copy)
  35741. * @param uvs as a float array
  35742. * @returns a shapeUV array
  35743. * @hidden
  35744. */
  35745. private _uvsToShapeUV;
  35746. /**
  35747. * Adds a new particle object in the particles array
  35748. * @param idx particle index in particles array
  35749. * @param id particle id
  35750. * @param idxpos positionIndex : the starting index of the particle vertices in the SPS "positions" array
  35751. * @param idxind indiceIndex : he starting index of the particle indices in the SPS "indices" array
  35752. * @param model particle ModelShape object
  35753. * @param shapeId model shape identifier
  35754. * @param idxInShape index of the particle in the current model
  35755. * @param bInfo model bounding info object
  35756. * @param storage target storage array, if any
  35757. * @hidden
  35758. */
  35759. private _addParticle;
  35760. /**
  35761. * Adds some particles to the SPS from the model shape. Returns the shape id.
  35762. * Please read the doc : https://doc.babylonjs.com/how_to/Solid_Particle_System#create-an-immutable-sps
  35763. * @param mesh is any Mesh object that will be used as a model for the solid particles.
  35764. * @param nb (positive integer) the number of particles to be created from this model
  35765. * @param options {positionFunction} is an optional javascript function to called for each particle on SPS creation.
  35766. * {vertexFunction} is an optional javascript function to called for each vertex of each particle on SPS creation
  35767. * {storage} (optional existing array) is an array where the particles will be stored for a further use instead of being inserted in the SPS.
  35768. * @returns the number of shapes in the system
  35769. */
  35770. addShape(mesh: Mesh, nb: number, options?: {
  35771. positionFunction?: any;
  35772. vertexFunction?: any;
  35773. storage?: [];
  35774. }): number;
  35775. /**
  35776. * Rebuilds a particle back to its just built status : if needed, recomputes the custom positions and vertices
  35777. * @hidden
  35778. */
  35779. private _rebuildParticle;
  35780. /**
  35781. * Rebuilds the whole mesh and updates the VBO : custom positions and vertices are recomputed if needed.
  35782. * @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.
  35783. * @returns the SPS.
  35784. */
  35785. rebuildMesh(reset?: boolean): SolidParticleSystem;
  35786. /** Removes the particles from the start-th to the end-th included from an expandable SPS (required).
  35787. * Returns an array with the removed particles.
  35788. * 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.
  35789. * The SPS can't be empty so at least one particle needs to remain in place.
  35790. * Under the hood, the VertexData array, so the VBO buffer, is recreated each call.
  35791. * @param start index of the first particle to remove
  35792. * @param end index of the last particle to remove (included)
  35793. * @returns an array populated with the removed particles
  35794. */
  35795. removeParticles(start: number, end: number): SolidParticle[];
  35796. /**
  35797. * Inserts some pre-created particles in the solid particle system so that they can be managed by setParticles().
  35798. * @param solidParticleArray an array populated with Solid Particles objects
  35799. * @returns the SPS
  35800. */
  35801. insertParticlesFromArray(solidParticleArray: SolidParticle[]): SolidParticleSystem;
  35802. /**
  35803. * Creates a new particle and modifies the SPS mesh geometry :
  35804. * - calls _meshBuilder() to increase the SPS mesh geometry step by step
  35805. * - calls _addParticle() to populate the particle array
  35806. * factorized code from addShape() and insertParticlesFromArray()
  35807. * @param idx particle index in the particles array
  35808. * @param i particle index in its shape
  35809. * @param modelShape particle ModelShape object
  35810. * @param shape shape vertex array
  35811. * @param meshInd shape indices array
  35812. * @param meshUV shape uv array
  35813. * @param meshCol shape color array
  35814. * @param meshNor shape normals array
  35815. * @param bbInfo shape bounding info
  35816. * @param storage target particle storage
  35817. * @options addShape() passed options
  35818. * @hidden
  35819. */
  35820. private _insertNewParticle;
  35821. /**
  35822. * Sets all the particles : this method actually really updates the mesh according to the particle positions, rotations, colors, textures, etc.
  35823. * This method calls `updateParticle()` for each particle of the SPS.
  35824. * For an animated SPS, it is usually called within the render loop.
  35825. * 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.
  35826. * @param start The particle index in the particle array where to start to compute the particle property values _(default 0)_
  35827. * @param end The particle index in the particle array where to stop to compute the particle property values _(default nbParticle - 1)_
  35828. * @param update If the mesh must be finally updated on this call after all the particle computations _(default true)_
  35829. * @returns the SPS.
  35830. */
  35831. setParticles(start?: number, end?: number, update?: boolean): SolidParticleSystem;
  35832. /**
  35833. * Disposes the SPS.
  35834. */
  35835. dispose(): void;
  35836. /** Returns an object {idx: numbern faceId: number} for the picked particle from the passed pickingInfo object.
  35837. * idx is the particle index in the SPS
  35838. * faceId is the picked face index counted within this particle.
  35839. * Returns null if the pickInfo can't identify a picked particle.
  35840. * @param pickingInfo (PickingInfo object)
  35841. * @returns {idx: number, faceId: number} or null
  35842. */
  35843. pickedParticle(pickingInfo: PickingInfo): Nullable<{
  35844. idx: number;
  35845. faceId: number;
  35846. }>;
  35847. /**
  35848. * Returns a SolidParticle object from its identifier : particle.id
  35849. * @param id (integer) the particle Id
  35850. * @returns the searched particle or null if not found in the SPS.
  35851. */
  35852. getParticleById(id: number): Nullable<SolidParticle>;
  35853. /**
  35854. * Returns a new array populated with the particles having the passed shapeId.
  35855. * @param shapeId (integer) the shape identifier
  35856. * @returns a new solid particle array
  35857. */
  35858. getParticlesByShapeId(shapeId: number): SolidParticle[];
  35859. /**
  35860. * Populates the passed array "ref" with the particles having the passed shapeId.
  35861. * @param shapeId the shape identifier
  35862. * @returns the SPS
  35863. * @param ref
  35864. */
  35865. getParticlesByShapeIdToRef(shapeId: number, ref: SolidParticle[]): SolidParticleSystem;
  35866. /**
  35867. * Computes the required SubMeshes according the materials assigned to the particles.
  35868. * @returns the solid particle system.
  35869. * Does nothing if called before the SPS mesh is built.
  35870. */
  35871. computeSubMeshes(): SolidParticleSystem;
  35872. /**
  35873. * Sorts the solid particles by material when MultiMaterial is enabled.
  35874. * Updates the indices32 array.
  35875. * Updates the indicesByMaterial array.
  35876. * Updates the mesh indices array.
  35877. * @returns the SPS
  35878. * @hidden
  35879. */
  35880. private _sortParticlesByMaterial;
  35881. /**
  35882. * Sets the material indexes by id materialIndexesById[id] = materialIndex
  35883. * @hidden
  35884. */
  35885. private _setMaterialIndexesById;
  35886. /**
  35887. * Returns an array with unique values of Materials from the passed array
  35888. * @param array the material array to be checked and filtered
  35889. * @hidden
  35890. */
  35891. private _filterUniqueMaterialId;
  35892. /**
  35893. * Sets a new Standard Material as _defaultMaterial if not already set.
  35894. * @hidden
  35895. */
  35896. private _setDefaultMaterial;
  35897. /**
  35898. * Visibilty helper : Recomputes the visible size according to the mesh bounding box
  35899. * doc : https://doc.babylonjs.com/how_to/Solid_Particle_System#sps-visibility
  35900. * @returns the SPS.
  35901. */
  35902. refreshVisibleSize(): SolidParticleSystem;
  35903. /**
  35904. * Visibility helper : Sets the size of a visibility box, this sets the underlying mesh bounding box.
  35905. * @param size the size (float) of the visibility box
  35906. * note : this doesn't lock the SPS mesh bounding box.
  35907. * doc : https://doc.babylonjs.com/how_to/Solid_Particle_System#sps-visibility
  35908. */
  35909. setVisibilityBox(size: number): void;
  35910. /**
  35911. * Gets whether the SPS as always visible or not
  35912. * doc : https://doc.babylonjs.com/how_to/Solid_Particle_System#sps-visibility
  35913. */
  35914. get isAlwaysVisible(): boolean;
  35915. /**
  35916. * Sets the SPS as always visible or not
  35917. * doc : https://doc.babylonjs.com/how_to/Solid_Particle_System#sps-visibility
  35918. */
  35919. set isAlwaysVisible(val: boolean);
  35920. /**
  35921. * Sets the SPS visibility box as locked or not. This enables/disables the underlying mesh bounding box updates.
  35922. * doc : https://doc.babylonjs.com/how_to/Solid_Particle_System#sps-visibility
  35923. */
  35924. set isVisibilityBoxLocked(val: boolean);
  35925. /**
  35926. * Gets if the SPS visibility box as locked or not. This enables/disables the underlying mesh bounding box updates.
  35927. * doc : https://doc.babylonjs.com/how_to/Solid_Particle_System#sps-visibility
  35928. */
  35929. get isVisibilityBoxLocked(): boolean;
  35930. /**
  35931. * Tells to `setParticles()` to compute the particle rotations or not.
  35932. * Default value : true. The SPS is faster when it's set to false.
  35933. * Note : the particle rotations aren't stored values, so setting `computeParticleRotation` to false will prevents the particle to rotate.
  35934. */
  35935. set computeParticleRotation(val: boolean);
  35936. /**
  35937. * Tells to `setParticles()` to compute the particle colors or not.
  35938. * Default value : true. The SPS is faster when it's set to false.
  35939. * Note : the particle colors are stored values, so setting `computeParticleColor` to false will keep yet the last colors set.
  35940. */
  35941. set computeParticleColor(val: boolean);
  35942. set computeParticleTexture(val: boolean);
  35943. /**
  35944. * Tells to `setParticles()` to call the vertex function for each vertex of each particle, or not.
  35945. * Default value : false. The SPS is faster when it's set to false.
  35946. * Note : the particle custom vertex positions aren't stored values.
  35947. */
  35948. set computeParticleVertex(val: boolean);
  35949. /**
  35950. * Tells to `setParticles()` to compute or not the mesh bounding box when computing the particle positions.
  35951. */
  35952. set computeBoundingBox(val: boolean);
  35953. /**
  35954. * Tells to `setParticles()` to sort or not the distance between each particle and the camera.
  35955. * Skipped when `enableDepthSort` is set to `false` (default) at construction time.
  35956. * Default : `true`
  35957. */
  35958. set depthSortParticles(val: boolean);
  35959. /**
  35960. * Gets if `setParticles()` computes the particle rotations or not.
  35961. * Default value : true. The SPS is faster when it's set to false.
  35962. * Note : the particle rotations aren't stored values, so setting `computeParticleRotation` to false will prevents the particle to rotate.
  35963. */
  35964. get computeParticleRotation(): boolean;
  35965. /**
  35966. * Gets if `setParticles()` computes the particle colors or not.
  35967. * Default value : true. The SPS is faster when it's set to false.
  35968. * Note : the particle colors are stored values, so setting `computeParticleColor` to false will keep yet the last colors set.
  35969. */
  35970. get computeParticleColor(): boolean;
  35971. /**
  35972. * Gets if `setParticles()` computes the particle textures or not.
  35973. * Default value : true. The SPS is faster when it's set to false.
  35974. * Note : the particle textures are stored values, so setting `computeParticleTexture` to false will keep yet the last colors set.
  35975. */
  35976. get computeParticleTexture(): boolean;
  35977. /**
  35978. * Gets if `setParticles()` calls the vertex function for each vertex of each particle, or not.
  35979. * Default value : false. The SPS is faster when it's set to false.
  35980. * Note : the particle custom vertex positions aren't stored values.
  35981. */
  35982. get computeParticleVertex(): boolean;
  35983. /**
  35984. * Gets if `setParticles()` computes or not the mesh bounding box when computing the particle positions.
  35985. */
  35986. get computeBoundingBox(): boolean;
  35987. /**
  35988. * Gets if `setParticles()` sorts or not the distance between each particle and the camera.
  35989. * Skipped when `enableDepthSort` is set to `false` (default) at construction time.
  35990. * Default : `true`
  35991. */
  35992. get depthSortParticles(): boolean;
  35993. /**
  35994. * Gets if the SPS is created as expandable at construction time.
  35995. * Default : `false`
  35996. */
  35997. get expandable(): boolean;
  35998. /**
  35999. * Gets if the SPS supports the Multi Materials
  36000. */
  36001. get multimaterialEnabled(): boolean;
  36002. /**
  36003. * Gets if the SPS uses the model materials for its own multimaterial.
  36004. */
  36005. get useModelMaterial(): boolean;
  36006. /**
  36007. * The SPS used material array.
  36008. */
  36009. get materials(): Material[];
  36010. /**
  36011. * Sets the SPS MultiMaterial from the passed materials.
  36012. * Note : the passed array is internally copied and not used then by reference.
  36013. * @param materials an array of material objects. This array indexes are the materialIndex values of the particles.
  36014. */
  36015. setMultiMaterial(materials: Material[]): void;
  36016. /**
  36017. * The SPS computed multimaterial object
  36018. */
  36019. get multimaterial(): MultiMaterial;
  36020. set multimaterial(mm: MultiMaterial);
  36021. /**
  36022. * If the subMeshes must be updated on the next call to setParticles()
  36023. */
  36024. get autoUpdateSubMeshes(): boolean;
  36025. set autoUpdateSubMeshes(val: boolean);
  36026. /**
  36027. * This function does nothing. It may be overwritten to set all the particle first values.
  36028. * The SPS doesn't call this function, you may have to call it by your own.
  36029. * doc : https://doc.babylonjs.com/how_to/Solid_Particle_System#particle-management
  36030. */
  36031. initParticles(): void;
  36032. /**
  36033. * This function does nothing. It may be overwritten to recycle a particle.
  36034. * The SPS doesn't call this function, you may have to call it by your own.
  36035. * doc : https://doc.babylonjs.com/how_to/Solid_Particle_System#particle-management
  36036. * @param particle The particle to recycle
  36037. * @returns the recycled particle
  36038. */
  36039. recycleParticle(particle: SolidParticle): SolidParticle;
  36040. /**
  36041. * Updates a particle : this function should be overwritten by the user.
  36042. * It is called on each particle by `setParticles()`. This is the place to code each particle behavior.
  36043. * doc : https://doc.babylonjs.com/how_to/Solid_Particle_System#particle-management
  36044. * @example : just set a particle position or velocity and recycle conditions
  36045. * @param particle The particle to update
  36046. * @returns the updated particle
  36047. */
  36048. updateParticle(particle: SolidParticle): SolidParticle;
  36049. /**
  36050. * Updates a vertex of a particle : it can be overwritten by the user.
  36051. * This will be called on each vertex particle by `setParticles()` if `computeParticleVertex` is set to true only.
  36052. * @param particle the current particle
  36053. * @param vertex the current vertex of the current particle : a SolidParticleVertex object
  36054. * @param pt the index of the current vertex in the particle shape
  36055. * doc : https://doc.babylonjs.com/how_to/Solid_Particle_System#update-each-particle-shape
  36056. * @example : just set a vertex particle position or color
  36057. * @returns the sps
  36058. */
  36059. updateParticleVertex(particle: SolidParticle, vertex: SolidParticleVertex, pt: number): SolidParticleSystem;
  36060. /**
  36061. * This will be called before any other treatment by `setParticles()` and will be passed three parameters.
  36062. * This does nothing and may be overwritten by the user.
  36063. * @param start the particle index in the particle array where to stop to iterate, same than the value passed to setParticle()
  36064. * @param stop the particle index in the particle array where to stop to iterate, same than the value passed to setParticle()
  36065. * @param update the boolean update value actually passed to setParticles()
  36066. */
  36067. beforeUpdateParticles(start?: number, stop?: number, update?: boolean): void;
  36068. /**
  36069. * This will be called by `setParticles()` after all the other treatments and just before the actual mesh update.
  36070. * This will be passed three parameters.
  36071. * This does nothing and may be overwritten by the user.
  36072. * @param start the particle index in the particle array where to stop to iterate, same than the value passed to setParticle()
  36073. * @param stop the particle index in the particle array where to stop to iterate, same than the value passed to setParticle()
  36074. * @param update the boolean update value actually passed to setParticles()
  36075. */
  36076. afterUpdateParticles(start?: number, stop?: number, update?: boolean): void;
  36077. }
  36078. }
  36079. declare module "babylonjs/Particles/solidParticle" {
  36080. import { Nullable } from "babylonjs/types";
  36081. import { Vector3, Matrix, Quaternion, Vector4, Vector2 } from "babylonjs/Maths/math.vector";
  36082. import { Color4 } from "babylonjs/Maths/math.color";
  36083. import { Mesh } from "babylonjs/Meshes/mesh";
  36084. import { BoundingInfo } from "babylonjs/Culling/boundingInfo";
  36085. import { SolidParticleSystem } from "babylonjs/Particles/solidParticleSystem";
  36086. import { Plane } from "babylonjs/Maths/math.plane";
  36087. import { Material } from "babylonjs/Materials/material";
  36088. /**
  36089. * Represents one particle of a solid particle system.
  36090. */
  36091. export class SolidParticle {
  36092. /**
  36093. * particle global index
  36094. */
  36095. idx: number;
  36096. /**
  36097. * particle identifier
  36098. */
  36099. id: number;
  36100. /**
  36101. * The color of the particle
  36102. */
  36103. color: Nullable<Color4>;
  36104. /**
  36105. * The world space position of the particle.
  36106. */
  36107. position: Vector3;
  36108. /**
  36109. * The world space rotation of the particle. (Not use if rotationQuaternion is set)
  36110. */
  36111. rotation: Vector3;
  36112. /**
  36113. * The world space rotation quaternion of the particle.
  36114. */
  36115. rotationQuaternion: Nullable<Quaternion>;
  36116. /**
  36117. * The scaling of the particle.
  36118. */
  36119. scaling: Vector3;
  36120. /**
  36121. * The uvs of the particle.
  36122. */
  36123. uvs: Vector4;
  36124. /**
  36125. * The current speed of the particle.
  36126. */
  36127. velocity: Vector3;
  36128. /**
  36129. * The pivot point in the particle local space.
  36130. */
  36131. pivot: Vector3;
  36132. /**
  36133. * Must the particle be translated from its pivot point in its local space ?
  36134. * In this case, the pivot point is set at the origin of the particle local space and the particle is translated.
  36135. * Default : false
  36136. */
  36137. translateFromPivot: boolean;
  36138. /**
  36139. * Is the particle active or not ?
  36140. */
  36141. alive: boolean;
  36142. /**
  36143. * Is the particle visible or not ?
  36144. */
  36145. isVisible: boolean;
  36146. /**
  36147. * Index of this particle in the global "positions" array (Internal use)
  36148. * @hidden
  36149. */
  36150. _pos: number;
  36151. /**
  36152. * @hidden Index of this particle in the global "indices" array (Internal use)
  36153. */
  36154. _ind: number;
  36155. /**
  36156. * @hidden ModelShape of this particle (Internal use)
  36157. */
  36158. _model: ModelShape;
  36159. /**
  36160. * ModelShape id of this particle
  36161. */
  36162. shapeId: number;
  36163. /**
  36164. * Index of the particle in its shape id
  36165. */
  36166. idxInShape: number;
  36167. /**
  36168. * @hidden Reference to the shape model BoundingInfo object (Internal use)
  36169. */
  36170. _modelBoundingInfo: BoundingInfo;
  36171. /**
  36172. * @hidden Particle BoundingInfo object (Internal use)
  36173. */
  36174. _boundingInfo: BoundingInfo;
  36175. /**
  36176. * @hidden Reference to the SPS what the particle belongs to (Internal use)
  36177. */
  36178. _sps: SolidParticleSystem;
  36179. /**
  36180. * @hidden Still set as invisible in order to skip useless computations (Internal use)
  36181. */
  36182. _stillInvisible: boolean;
  36183. /**
  36184. * @hidden Last computed particle rotation matrix
  36185. */
  36186. _rotationMatrix: number[];
  36187. /**
  36188. * Parent particle Id, if any.
  36189. * Default null.
  36190. */
  36191. parentId: Nullable<number>;
  36192. /**
  36193. * The particle material identifier (integer) when MultiMaterials are enabled in the SPS.
  36194. */
  36195. materialIndex: Nullable<number>;
  36196. /**
  36197. * Custom object or properties.
  36198. */
  36199. props: Nullable<any>;
  36200. /**
  36201. * The culling strategy to use to check whether the solid particle must be culled or not when using isInFrustum().
  36202. * The possible values are :
  36203. * - AbstractMesh.CULLINGSTRATEGY_STANDARD
  36204. * - AbstractMesh.CULLINGSTRATEGY_BOUNDINGSPHERE_ONLY
  36205. * - AbstractMesh.CULLINGSTRATEGY_OPTIMISTIC_INCLUSION
  36206. * - AbstractMesh.CULLINGSTRATEGY_OPTIMISTIC_INCLUSION_THEN_BSPHERE_ONLY
  36207. * The default value for solid particles is AbstractMesh.CULLINGSTRATEGY_BOUNDINGSPHERE_ONLY
  36208. * Please read each static variable documentation in the class AbstractMesh to get details about the culling process.
  36209. * */
  36210. cullingStrategy: number;
  36211. /**
  36212. * @hidden Internal global position in the SPS.
  36213. */
  36214. _globalPosition: Vector3;
  36215. /**
  36216. * Creates a Solid Particle object.
  36217. * Don't create particles manually, use instead the Solid Particle System internal tools like _addParticle()
  36218. * @param particleIndex (integer) is the particle index in the Solid Particle System pool.
  36219. * @param particleId (integer) is the particle identifier. Unless some particles are removed from the SPS, it's the same value than the particle idx.
  36220. * @param positionIndex (integer) is the starting index of the particle vertices in the SPS "positions" array.
  36221. * @param indiceIndex (integer) is the starting index of the particle indices in the SPS "indices" array.
  36222. * @param model (ModelShape) is a reference to the model shape on what the particle is designed.
  36223. * @param shapeId (integer) is the model shape identifier in the SPS.
  36224. * @param idxInShape (integer) is the index of the particle in the current model (ex: the 10th box of addShape(box, 30))
  36225. * @param sps defines the sps it is associated to
  36226. * @param modelBoundingInfo is the reference to the model BoundingInfo used for intersection computations.
  36227. * @param materialIndex is the particle material identifier (integer) when the MultiMaterials are enabled in the SPS.
  36228. */
  36229. constructor(particleIndex: number, particleId: number, positionIndex: number, indiceIndex: number, model: Nullable<ModelShape>, shapeId: number, idxInShape: number, sps: SolidParticleSystem, modelBoundingInfo?: Nullable<BoundingInfo>, materialIndex?: Nullable<number>);
  36230. /**
  36231. * Copies the particle property values into the existing target : position, rotation, scaling, uvs, colors, pivot, parent, visibility, alive
  36232. * @param target the particle target
  36233. * @returns the current particle
  36234. */
  36235. copyToRef(target: SolidParticle): SolidParticle;
  36236. /**
  36237. * Legacy support, changed scale to scaling
  36238. */
  36239. get scale(): Vector3;
  36240. /**
  36241. * Legacy support, changed scale to scaling
  36242. */
  36243. set scale(scale: Vector3);
  36244. /**
  36245. * Legacy support, changed quaternion to rotationQuaternion
  36246. */
  36247. get quaternion(): Nullable<Quaternion>;
  36248. /**
  36249. * Legacy support, changed quaternion to rotationQuaternion
  36250. */
  36251. set quaternion(q: Nullable<Quaternion>);
  36252. /**
  36253. * Returns a boolean. True if the particle intersects another particle or another mesh, else false.
  36254. * The intersection is computed on the particle bounding sphere and Axis Aligned Bounding Box (AABB)
  36255. * @param target is the object (solid particle or mesh) what the intersection is computed against.
  36256. * @returns true if it intersects
  36257. */
  36258. intersectsMesh(target: Mesh | SolidParticle): boolean;
  36259. /**
  36260. * Returns `true` if the solid particle is within the frustum defined by the passed array of planes.
  36261. * A particle is in the frustum if its bounding box intersects the frustum
  36262. * @param frustumPlanes defines the frustum to test
  36263. * @returns true if the particle is in the frustum planes
  36264. */
  36265. isInFrustum(frustumPlanes: Plane[]): boolean;
  36266. /**
  36267. * get the rotation matrix of the particle
  36268. * @hidden
  36269. */
  36270. getRotationMatrix(m: Matrix): void;
  36271. }
  36272. /**
  36273. * Represents the shape of the model used by one particle of a solid particle system.
  36274. * SPS internal tool, don't use it manually.
  36275. */
  36276. export class ModelShape {
  36277. /**
  36278. * The shape id
  36279. * @hidden
  36280. */
  36281. shapeID: number;
  36282. /**
  36283. * flat array of model positions (internal use)
  36284. * @hidden
  36285. */
  36286. _shape: Vector3[];
  36287. /**
  36288. * flat array of model UVs (internal use)
  36289. * @hidden
  36290. */
  36291. _shapeUV: number[];
  36292. /**
  36293. * color array of the model
  36294. * @hidden
  36295. */
  36296. _shapeColors: number[];
  36297. /**
  36298. * indices array of the model
  36299. * @hidden
  36300. */
  36301. _indices: number[];
  36302. /**
  36303. * normals array of the model
  36304. * @hidden
  36305. */
  36306. _normals: number[];
  36307. /**
  36308. * length of the shape in the model indices array (internal use)
  36309. * @hidden
  36310. */
  36311. _indicesLength: number;
  36312. /**
  36313. * Custom position function (internal use)
  36314. * @hidden
  36315. */
  36316. _positionFunction: Nullable<(particle: SolidParticle, i: number, s: number) => void>;
  36317. /**
  36318. * Custom vertex function (internal use)
  36319. * @hidden
  36320. */
  36321. _vertexFunction: Nullable<(particle: SolidParticle, vertex: Vector3, i: number) => void>;
  36322. /**
  36323. * Model material (internal use)
  36324. * @hidden
  36325. */
  36326. _material: Nullable<Material>;
  36327. /**
  36328. * 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.
  36329. * SPS internal tool, don't use it manually.
  36330. * @hidden
  36331. */
  36332. 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>);
  36333. }
  36334. /**
  36335. * Represents a Depth Sorted Particle in the solid particle system.
  36336. * @hidden
  36337. */
  36338. export class DepthSortedParticle {
  36339. /**
  36340. * Particle index
  36341. */
  36342. idx: number;
  36343. /**
  36344. * Index of the particle in the "indices" array
  36345. */
  36346. ind: number;
  36347. /**
  36348. * Length of the particle shape in the "indices" array
  36349. */
  36350. indicesLength: number;
  36351. /**
  36352. * Squared distance from the particle to the camera
  36353. */
  36354. sqDistance: number;
  36355. /**
  36356. * Material index when used with MultiMaterials
  36357. */
  36358. materialIndex: number;
  36359. /**
  36360. * Creates a new sorted particle
  36361. * @param materialIndex
  36362. */
  36363. constructor(idx: number, ind: number, indLength: number, materialIndex: number);
  36364. }
  36365. /**
  36366. * Represents a solid particle vertex
  36367. */
  36368. export class SolidParticleVertex {
  36369. /**
  36370. * Vertex position
  36371. */
  36372. position: Vector3;
  36373. /**
  36374. * Vertex color
  36375. */
  36376. color: Color4;
  36377. /**
  36378. * Vertex UV
  36379. */
  36380. uv: Vector2;
  36381. /**
  36382. * Creates a new solid particle vertex
  36383. */
  36384. constructor();
  36385. /** Vertex x coordinate */
  36386. get x(): number;
  36387. set x(val: number);
  36388. /** Vertex y coordinate */
  36389. get y(): number;
  36390. set y(val: number);
  36391. /** Vertex z coordinate */
  36392. get z(): number;
  36393. set z(val: number);
  36394. }
  36395. }
  36396. declare module "babylonjs/Collisions/meshCollisionData" {
  36397. import { Collider } from "babylonjs/Collisions/collider";
  36398. import { Vector3 } from "babylonjs/Maths/math.vector";
  36399. import { Nullable } from "babylonjs/types";
  36400. import { Observer } from "babylonjs/Misc/observable";
  36401. import { AbstractMesh } from "babylonjs/Meshes/abstractMesh";
  36402. /**
  36403. * @hidden
  36404. */
  36405. export class _MeshCollisionData {
  36406. _checkCollisions: boolean;
  36407. _collisionMask: number;
  36408. _collisionGroup: number;
  36409. _surroundingMeshes: Nullable<AbstractMesh[]>;
  36410. _collider: Nullable<Collider>;
  36411. _oldPositionForCollisions: Vector3;
  36412. _diffPositionForCollisions: Vector3;
  36413. _onCollideObserver: Nullable<Observer<AbstractMesh>>;
  36414. _onCollisionPositionChangeObserver: Nullable<Observer<Vector3>>;
  36415. _collisionResponse: boolean;
  36416. }
  36417. }
  36418. declare module "babylonjs/Meshes/abstractMesh" {
  36419. import { Observable } from "babylonjs/Misc/observable";
  36420. import { Nullable, FloatArray, IndicesArray, DeepImmutable } from "babylonjs/types";
  36421. import { Camera } from "babylonjs/Cameras/camera";
  36422. import { Scene, IDisposable } from "babylonjs/scene";
  36423. import { Matrix, Vector3, Vector2 } from "babylonjs/Maths/math.vector";
  36424. import { Node } from "babylonjs/node";
  36425. import { IGetSetVerticesData } from "babylonjs/Meshes/mesh.vertexData";
  36426. import { TransformNode } from "babylonjs/Meshes/transformNode";
  36427. import { SubMesh } from "babylonjs/Meshes/subMesh";
  36428. import { PickingInfo } from "babylonjs/Collisions/pickingInfo";
  36429. import { ICullable, BoundingInfo } from "babylonjs/Culling/boundingInfo";
  36430. import { Material } from "babylonjs/Materials/material";
  36431. import { Light } from "babylonjs/Lights/light";
  36432. import { Skeleton } from "babylonjs/Bones/skeleton";
  36433. import { IEdgesRenderer } from "babylonjs/Rendering/edgesRenderer";
  36434. import { SolidParticle } from "babylonjs/Particles/solidParticle";
  36435. import { AbstractActionManager } from "babylonjs/Actions/abstractActionManager";
  36436. import { RawTexture } from "babylonjs/Materials/Textures/rawTexture";
  36437. import { Color3, Color4 } from "babylonjs/Maths/math.color";
  36438. import { Plane } from "babylonjs/Maths/math.plane";
  36439. import { IParticleSystem } from "babylonjs/Particles/IParticleSystem";
  36440. import { Ray } from "babylonjs/Culling/ray";
  36441. import { Collider } from "babylonjs/Collisions/collider";
  36442. import { TrianglePickingPredicate } from "babylonjs/Culling/ray";
  36443. import { RenderingGroup } from "babylonjs/Rendering/renderingGroup";
  36444. /** @hidden */
  36445. class _FacetDataStorage {
  36446. facetPositions: Vector3[];
  36447. facetNormals: Vector3[];
  36448. facetPartitioning: number[][];
  36449. facetNb: number;
  36450. partitioningSubdivisions: number;
  36451. partitioningBBoxRatio: number;
  36452. facetDataEnabled: boolean;
  36453. facetParameters: any;
  36454. bbSize: Vector3;
  36455. subDiv: {
  36456. max: number;
  36457. X: number;
  36458. Y: number;
  36459. Z: number;
  36460. };
  36461. facetDepthSort: boolean;
  36462. facetDepthSortEnabled: boolean;
  36463. depthSortedIndices: IndicesArray;
  36464. depthSortedFacets: {
  36465. ind: number;
  36466. sqDistance: number;
  36467. }[];
  36468. facetDepthSortFunction: (f1: {
  36469. ind: number;
  36470. sqDistance: number;
  36471. }, f2: {
  36472. ind: number;
  36473. sqDistance: number;
  36474. }) => number;
  36475. facetDepthSortFrom: Vector3;
  36476. facetDepthSortOrigin: Vector3;
  36477. invertedMatrix: Matrix;
  36478. }
  36479. /**
  36480. * @hidden
  36481. **/
  36482. class _InternalAbstractMeshDataInfo {
  36483. _hasVertexAlpha: boolean;
  36484. _useVertexColors: boolean;
  36485. _numBoneInfluencers: number;
  36486. _applyFog: boolean;
  36487. _receiveShadows: boolean;
  36488. _facetData: _FacetDataStorage;
  36489. _visibility: number;
  36490. _skeleton: Nullable<Skeleton>;
  36491. _layerMask: number;
  36492. _computeBonesUsingShaders: boolean;
  36493. _isActive: boolean;
  36494. _onlyForInstances: boolean;
  36495. _isActiveIntermediate: boolean;
  36496. _onlyForInstancesIntermediate: boolean;
  36497. _actAsRegularMesh: boolean;
  36498. _currentLOD: Nullable<AbstractMesh>;
  36499. }
  36500. /**
  36501. * Class used to store all common mesh properties
  36502. */
  36503. export class AbstractMesh extends TransformNode implements IDisposable, ICullable, IGetSetVerticesData {
  36504. /** No occlusion */
  36505. static OCCLUSION_TYPE_NONE: number;
  36506. /** Occlusion set to optimisitic */
  36507. static OCCLUSION_TYPE_OPTIMISTIC: number;
  36508. /** Occlusion set to strict */
  36509. static OCCLUSION_TYPE_STRICT: number;
  36510. /** Use an accurante occlusion algorithm */
  36511. static OCCLUSION_ALGORITHM_TYPE_ACCURATE: number;
  36512. /** Use a conservative occlusion algorithm */
  36513. static OCCLUSION_ALGORITHM_TYPE_CONSERVATIVE: number;
  36514. /** Default culling strategy : this is an exclusion test and it's the more accurate.
  36515. * Test order :
  36516. * Is the bounding sphere outside the frustum ?
  36517. * If not, are the bounding box vertices outside the frustum ?
  36518. * It not, then the cullable object is in the frustum.
  36519. */
  36520. static readonly CULLINGSTRATEGY_STANDARD: number;
  36521. /** Culling strategy : Bounding Sphere Only.
  36522. * This is an exclusion test. It's faster than the standard strategy because the bounding box is not tested.
  36523. * It's also less accurate than the standard because some not visible objects can still be selected.
  36524. * Test : is the bounding sphere outside the frustum ?
  36525. * If not, then the cullable object is in the frustum.
  36526. */
  36527. static readonly CULLINGSTRATEGY_BOUNDINGSPHERE_ONLY: number;
  36528. /** Culling strategy : Optimistic Inclusion.
  36529. * This in an inclusion test first, then the standard exclusion test.
  36530. * This can be faster when a cullable object is expected to be almost always in the camera frustum.
  36531. * 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.
  36532. * Anyway, it's as accurate as the standard strategy.
  36533. * Test :
  36534. * Is the cullable object bounding sphere center in the frustum ?
  36535. * If not, apply the default culling strategy.
  36536. */
  36537. static readonly CULLINGSTRATEGY_OPTIMISTIC_INCLUSION: number;
  36538. /** Culling strategy : Optimistic Inclusion then Bounding Sphere Only.
  36539. * This in an inclusion test first, then the bounding sphere only exclusion test.
  36540. * This can be the fastest test when a cullable object is expected to be almost always in the camera frustum.
  36541. * 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.
  36542. * It's less accurate than the standard strategy and as accurate as the BoundingSphereOnly strategy.
  36543. * Test :
  36544. * Is the cullable object bounding sphere center in the frustum ?
  36545. * If not, apply the Bounding Sphere Only strategy. No Bounding Box is tested here.
  36546. */
  36547. static readonly CULLINGSTRATEGY_OPTIMISTIC_INCLUSION_THEN_BSPHERE_ONLY: number;
  36548. /**
  36549. * No billboard
  36550. */
  36551. static get BILLBOARDMODE_NONE(): number;
  36552. /** Billboard on X axis */
  36553. static get BILLBOARDMODE_X(): number;
  36554. /** Billboard on Y axis */
  36555. static get BILLBOARDMODE_Y(): number;
  36556. /** Billboard on Z axis */
  36557. static get BILLBOARDMODE_Z(): number;
  36558. /** Billboard on all axes */
  36559. static get BILLBOARDMODE_ALL(): number;
  36560. /** Billboard on using position instead of orientation */
  36561. static get BILLBOARDMODE_USE_POSITION(): number;
  36562. /** @hidden */
  36563. _internalAbstractMeshDataInfo: _InternalAbstractMeshDataInfo;
  36564. /**
  36565. * The culling strategy to use to check whether the mesh must be rendered or not.
  36566. * This value can be changed at any time and will be used on the next render mesh selection.
  36567. * The possible values are :
  36568. * - AbstractMesh.CULLINGSTRATEGY_STANDARD
  36569. * - AbstractMesh.CULLINGSTRATEGY_BOUNDINGSPHERE_ONLY
  36570. * - AbstractMesh.CULLINGSTRATEGY_OPTIMISTIC_INCLUSION
  36571. * - AbstractMesh.CULLINGSTRATEGY_OPTIMISTIC_INCLUSION_THEN_BSPHERE_ONLY
  36572. * Please read each static variable documentation to get details about the culling process.
  36573. * */
  36574. cullingStrategy: number;
  36575. /**
  36576. * Gets the number of facets in the mesh
  36577. * @see https://doc.babylonjs.com/how_to/how_to_use_facetdata#what-is-a-mesh-facet
  36578. */
  36579. get facetNb(): number;
  36580. /**
  36581. * Gets or set the number (integer) of subdivisions per axis in the partioning space
  36582. * @see https://doc.babylonjs.com/how_to/how_to_use_facetdata#tweaking-the-partitioning
  36583. */
  36584. get partitioningSubdivisions(): number;
  36585. set partitioningSubdivisions(nb: number);
  36586. /**
  36587. * The ratio (float) to apply to the bouding box size to set to the partioning space.
  36588. * Ex : 1.01 (default) the partioning space is 1% bigger than the bounding box
  36589. * @see https://doc.babylonjs.com/how_to/how_to_use_facetdata#tweaking-the-partitioning
  36590. */
  36591. get partitioningBBoxRatio(): number;
  36592. set partitioningBBoxRatio(ratio: number);
  36593. /**
  36594. * Gets or sets a boolean indicating that the facets must be depth sorted on next call to `updateFacetData()`.
  36595. * Works only for updatable meshes.
  36596. * Doesn't work with multi-materials
  36597. * @see https://doc.babylonjs.com/how_to/how_to_use_facetdata#facet-depth-sort
  36598. */
  36599. get mustDepthSortFacets(): boolean;
  36600. set mustDepthSortFacets(sort: boolean);
  36601. /**
  36602. * The location (Vector3) where the facet depth sort must be computed from.
  36603. * By default, the active camera position.
  36604. * Used only when facet depth sort is enabled
  36605. * @see https://doc.babylonjs.com/how_to/how_to_use_facetdata#facet-depth-sort
  36606. */
  36607. get facetDepthSortFrom(): Vector3;
  36608. set facetDepthSortFrom(location: Vector3);
  36609. /**
  36610. * gets a boolean indicating if facetData is enabled
  36611. * @see https://doc.babylonjs.com/how_to/how_to_use_facetdata#what-is-a-mesh-facet
  36612. */
  36613. get isFacetDataEnabled(): boolean;
  36614. /** @hidden */
  36615. _updateNonUniformScalingState(value: boolean): boolean;
  36616. /**
  36617. * An event triggered when this mesh collides with another one
  36618. */
  36619. onCollideObservable: Observable<AbstractMesh>;
  36620. /** Set a function to call when this mesh collides with another one */
  36621. set onCollide(callback: () => void);
  36622. /**
  36623. * An event triggered when the collision's position changes
  36624. */
  36625. onCollisionPositionChangeObservable: Observable<Vector3>;
  36626. /** Set a function to call when the collision's position changes */
  36627. set onCollisionPositionChange(callback: () => void);
  36628. /**
  36629. * An event triggered when material is changed
  36630. */
  36631. onMaterialChangedObservable: Observable<AbstractMesh>;
  36632. /**
  36633. * Gets or sets the orientation for POV movement & rotation
  36634. */
  36635. definedFacingForward: boolean;
  36636. /** @hidden */
  36637. _occlusionQuery: Nullable<WebGLQuery>;
  36638. /** @hidden */
  36639. _renderingGroup: Nullable<RenderingGroup>;
  36640. /**
  36641. * Gets or sets mesh visibility between 0 and 1 (default is 1)
  36642. */
  36643. get visibility(): number;
  36644. /**
  36645. * Gets or sets mesh visibility between 0 and 1 (default is 1)
  36646. */
  36647. set visibility(value: number);
  36648. /** Gets or sets the alpha index used to sort transparent meshes
  36649. * @see https://doc.babylonjs.com/resources/transparency_and_how_meshes_are_rendered#alpha-index
  36650. */
  36651. alphaIndex: number;
  36652. /**
  36653. * Gets or sets a boolean indicating if the mesh is visible (renderable). Default is true
  36654. */
  36655. isVisible: boolean;
  36656. /**
  36657. * Gets or sets a boolean indicating if the mesh can be picked (by scene.pick for instance or through actions). Default is true
  36658. */
  36659. isPickable: boolean;
  36660. /** Gets or sets a boolean indicating that bounding boxes of subMeshes must be rendered as well (false by default) */
  36661. showSubMeshesBoundingBox: boolean;
  36662. /** Gets or sets a boolean indicating if the mesh must be considered as a ray blocker for lens flares (false by default)
  36663. * @see https://doc.babylonjs.com/how_to/how_to_use_lens_flares
  36664. */
  36665. isBlocker: boolean;
  36666. /**
  36667. * Gets or sets a boolean indicating that pointer move events must be supported on this mesh (false by default)
  36668. */
  36669. enablePointerMoveEvents: boolean;
  36670. private _renderingGroupId;
  36671. /**
  36672. * Specifies the rendering group id for this mesh (0 by default)
  36673. * @see https://doc.babylonjs.com/resources/transparency_and_how_meshes_are_rendered#rendering-groups
  36674. */
  36675. get renderingGroupId(): number;
  36676. set renderingGroupId(value: number);
  36677. private _material;
  36678. /** Gets or sets current material */
  36679. get material(): Nullable<Material>;
  36680. set material(value: Nullable<Material>);
  36681. /**
  36682. * Gets or sets a boolean indicating that this mesh can receive realtime shadows
  36683. * @see https://doc.babylonjs.com/babylon101/shadows
  36684. */
  36685. get receiveShadows(): boolean;
  36686. set receiveShadows(value: boolean);
  36687. /** Defines color to use when rendering outline */
  36688. outlineColor: Color3;
  36689. /** Define width to use when rendering outline */
  36690. outlineWidth: number;
  36691. /** Defines color to use when rendering overlay */
  36692. overlayColor: Color3;
  36693. /** Defines alpha to use when rendering overlay */
  36694. overlayAlpha: number;
  36695. /** Gets or sets a boolean indicating that this mesh contains vertex color data with alpha values */
  36696. get hasVertexAlpha(): boolean;
  36697. set hasVertexAlpha(value: boolean);
  36698. /** 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) */
  36699. get useVertexColors(): boolean;
  36700. set useVertexColors(value: boolean);
  36701. /**
  36702. * Gets or sets a boolean indicating that bone animations must be computed by the CPU (false by default)
  36703. */
  36704. get computeBonesUsingShaders(): boolean;
  36705. set computeBonesUsingShaders(value: boolean);
  36706. /** Gets or sets the number of allowed bone influences per vertex (4 by default) */
  36707. get numBoneInfluencers(): number;
  36708. set numBoneInfluencers(value: number);
  36709. /** Gets or sets a boolean indicating that this mesh will allow fog to be rendered on it (true by default) */
  36710. get applyFog(): boolean;
  36711. set applyFog(value: boolean);
  36712. /** Gets or sets a boolean indicating that internal octree (if available) can be used to boost submeshes selection (true by default) */
  36713. useOctreeForRenderingSelection: boolean;
  36714. /** Gets or sets a boolean indicating that internal octree (if available) can be used to boost submeshes picking (true by default) */
  36715. useOctreeForPicking: boolean;
  36716. /** Gets or sets a boolean indicating that internal octree (if available) can be used to boost submeshes collision (true by default) */
  36717. useOctreeForCollisions: boolean;
  36718. /**
  36719. * Gets or sets the current layer mask (default is 0x0FFFFFFF)
  36720. * @see https://doc.babylonjs.com/how_to/layermasks_and_multi-cam_textures
  36721. */
  36722. get layerMask(): number;
  36723. set layerMask(value: number);
  36724. /**
  36725. * True if the mesh must be rendered in any case (this will shortcut the frustum clipping phase)
  36726. */
  36727. alwaysSelectAsActiveMesh: boolean;
  36728. /**
  36729. * Gets or sets a boolean indicating that the bounding info does not need to be kept in sync (for performance reason)
  36730. */
  36731. doNotSyncBoundingInfo: boolean;
  36732. /**
  36733. * Gets or sets the current action manager
  36734. * @see https://doc.babylonjs.com/how_to/how_to_use_actions
  36735. */
  36736. actionManager: Nullable<AbstractActionManager>;
  36737. private _meshCollisionData;
  36738. /**
  36739. * Gets or sets the ellipsoid used to impersonate this mesh when using collision engine (default is (0.5, 1, 0.5))
  36740. * @see https://doc.babylonjs.com/babylon101/cameras,_mesh_collisions_and_gravity
  36741. */
  36742. ellipsoid: Vector3;
  36743. /**
  36744. * Gets or sets the ellipsoid offset used to impersonate this mesh when using collision engine (default is (0, 0, 0))
  36745. * @see https://doc.babylonjs.com/babylon101/cameras,_mesh_collisions_and_gravity
  36746. */
  36747. ellipsoidOffset: Vector3;
  36748. /**
  36749. * Gets or sets a collision mask used to mask collisions (default is -1).
  36750. * A collision between A and B will happen if A.collisionGroup & b.collisionMask !== 0
  36751. */
  36752. get collisionMask(): number;
  36753. set collisionMask(mask: number);
  36754. /**
  36755. * Gets or sets a collision response flag (default is true).
  36756. * when collisionResponse is false, events are still triggered but colliding entity has no response
  36757. * This helps creating trigger volume when user wants collision feedback events but not position/velocity
  36758. * to respond to the collision.
  36759. */
  36760. get collisionResponse(): boolean;
  36761. set collisionResponse(response: boolean);
  36762. /**
  36763. * Gets or sets the current collision group mask (-1 by default).
  36764. * A collision between A and B will happen if A.collisionGroup & b.collisionMask !== 0
  36765. */
  36766. get collisionGroup(): number;
  36767. set collisionGroup(mask: number);
  36768. /**
  36769. * Gets or sets current surrounding meshes (null by default).
  36770. *
  36771. * By default collision detection is tested against every mesh in the scene.
  36772. * It is possible to set surroundingMeshes to a defined list of meshes and then only these specified
  36773. * meshes will be tested for the collision.
  36774. *
  36775. * Note: if set to an empty array no collision will happen when this mesh is moved.
  36776. */
  36777. get surroundingMeshes(): Nullable<AbstractMesh[]>;
  36778. set surroundingMeshes(meshes: Nullable<AbstractMesh[]>);
  36779. /**
  36780. * Defines edge width used when edgesRenderer is enabled
  36781. * @see https://www.babylonjs-playground.com/#10OJSG#13
  36782. */
  36783. edgesWidth: number;
  36784. /**
  36785. * Defines edge color used when edgesRenderer is enabled
  36786. * @see https://www.babylonjs-playground.com/#10OJSG#13
  36787. */
  36788. edgesColor: Color4;
  36789. /** @hidden */
  36790. _edgesRenderer: Nullable<IEdgesRenderer>;
  36791. /** @hidden */
  36792. _masterMesh: Nullable<AbstractMesh>;
  36793. /** @hidden */
  36794. _boundingInfo: Nullable<BoundingInfo>;
  36795. /** @hidden */
  36796. _renderId: number;
  36797. /**
  36798. * Gets or sets the list of subMeshes
  36799. * @see https://doc.babylonjs.com/how_to/multi_materials
  36800. */
  36801. subMeshes: SubMesh[];
  36802. /** @hidden */
  36803. _intersectionsInProgress: AbstractMesh[];
  36804. /** @hidden */
  36805. _unIndexed: boolean;
  36806. /** @hidden */
  36807. _lightSources: Light[];
  36808. /** Gets the list of lights affecting that mesh */
  36809. get lightSources(): Light[];
  36810. /** @hidden */
  36811. get _positions(): Nullable<Vector3[]>;
  36812. /** @hidden */
  36813. _waitingData: {
  36814. lods: Nullable<any>;
  36815. actions: Nullable<any>;
  36816. freezeWorldMatrix: Nullable<boolean>;
  36817. };
  36818. /** @hidden */
  36819. _bonesTransformMatrices: Nullable<Float32Array>;
  36820. /** @hidden */
  36821. _transformMatrixTexture: Nullable<RawTexture>;
  36822. /**
  36823. * Gets or sets a skeleton to apply skining transformations
  36824. * @see https://doc.babylonjs.com/how_to/how_to_use_bones_and_skeletons
  36825. */
  36826. set skeleton(value: Nullable<Skeleton>);
  36827. get skeleton(): Nullable<Skeleton>;
  36828. /**
  36829. * An event triggered when the mesh is rebuilt.
  36830. */
  36831. onRebuildObservable: Observable<AbstractMesh>;
  36832. /**
  36833. * Creates a new AbstractMesh
  36834. * @param name defines the name of the mesh
  36835. * @param scene defines the hosting scene
  36836. */
  36837. constructor(name: string, scene?: Nullable<Scene>);
  36838. /**
  36839. * Returns the string "AbstractMesh"
  36840. * @returns "AbstractMesh"
  36841. */
  36842. getClassName(): string;
  36843. /**
  36844. * Gets a string representation of the current mesh
  36845. * @param fullDetails defines a boolean indicating if full details must be included
  36846. * @returns a string representation of the current mesh
  36847. */
  36848. toString(fullDetails?: boolean): string;
  36849. /**
  36850. * @hidden
  36851. */
  36852. protected _getEffectiveParent(): Nullable<Node>;
  36853. /** @hidden */
  36854. _getActionManagerForTrigger(trigger?: number, initialCall?: boolean): Nullable<AbstractActionManager>;
  36855. /** @hidden */
  36856. _rebuild(): void;
  36857. /** @hidden */
  36858. _resyncLightSources(): void;
  36859. /** @hidden */
  36860. _resyncLightSource(light: Light): void;
  36861. /** @hidden */
  36862. _unBindEffect(): void;
  36863. /** @hidden */
  36864. _removeLightSource(light: Light, dispose: boolean): void;
  36865. private _markSubMeshesAsDirty;
  36866. /** @hidden */
  36867. _markSubMeshesAsLightDirty(dispose?: boolean): void;
  36868. /** @hidden */
  36869. _markSubMeshesAsAttributesDirty(): void;
  36870. /** @hidden */
  36871. _markSubMeshesAsMiscDirty(): void;
  36872. /**
  36873. * Gets or sets a Vector3 depicting the mesh scaling along each local axis X, Y, Z. Default is (1.0, 1.0, 1.0)
  36874. */
  36875. get scaling(): Vector3;
  36876. set scaling(newScaling: Vector3);
  36877. /**
  36878. * Returns true if the mesh is blocked. Implemented by child classes
  36879. */
  36880. get isBlocked(): boolean;
  36881. /**
  36882. * Returns the mesh itself by default. Implemented by child classes
  36883. * @param camera defines the camera to use to pick the right LOD level
  36884. * @returns the currentAbstractMesh
  36885. */
  36886. getLOD(camera: Camera): Nullable<AbstractMesh>;
  36887. /**
  36888. * Returns 0 by default. Implemented by child classes
  36889. * @returns an integer
  36890. */
  36891. getTotalVertices(): number;
  36892. /**
  36893. * Returns a positive integer : the total number of indices in this mesh geometry.
  36894. * @returns the numner of indices or zero if the mesh has no geometry.
  36895. */
  36896. getTotalIndices(): number;
  36897. /**
  36898. * Returns null by default. Implemented by child classes
  36899. * @returns null
  36900. */
  36901. getIndices(): Nullable<IndicesArray>;
  36902. /**
  36903. * Returns the array of the requested vertex data kind. Implemented by child classes
  36904. * @param kind defines the vertex data kind to use
  36905. * @returns null
  36906. */
  36907. getVerticesData(kind: string): Nullable<FloatArray>;
  36908. /**
  36909. * Sets the vertex data of the mesh geometry for the requested `kind`.
  36910. * If the mesh has no geometry, a new Geometry object is set to the mesh and then passed this vertex data.
  36911. * Note that a new underlying VertexBuffer object is created each call.
  36912. * If the `kind` is the `PositionKind`, the mesh BoundingInfo is renewed, so the bounding box and sphere, and the mesh World Matrix is recomputed.
  36913. * @param kind defines vertex data kind:
  36914. * * VertexBuffer.PositionKind
  36915. * * VertexBuffer.UVKind
  36916. * * VertexBuffer.UV2Kind
  36917. * * VertexBuffer.UV3Kind
  36918. * * VertexBuffer.UV4Kind
  36919. * * VertexBuffer.UV5Kind
  36920. * * VertexBuffer.UV6Kind
  36921. * * VertexBuffer.ColorKind
  36922. * * VertexBuffer.MatricesIndicesKind
  36923. * * VertexBuffer.MatricesIndicesExtraKind
  36924. * * VertexBuffer.MatricesWeightsKind
  36925. * * VertexBuffer.MatricesWeightsExtraKind
  36926. * @param data defines the data source
  36927. * @param updatable defines if the data must be flagged as updatable (or static)
  36928. * @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
  36929. * @returns the current mesh
  36930. */
  36931. setVerticesData(kind: string, data: FloatArray, updatable?: boolean, stride?: number): AbstractMesh;
  36932. /**
  36933. * Updates the existing vertex data of the mesh geometry for the requested `kind`.
  36934. * If the mesh has no geometry, it is simply returned as it is.
  36935. * @param kind defines vertex data kind:
  36936. * * VertexBuffer.PositionKind
  36937. * * VertexBuffer.UVKind
  36938. * * VertexBuffer.UV2Kind
  36939. * * VertexBuffer.UV3Kind
  36940. * * VertexBuffer.UV4Kind
  36941. * * VertexBuffer.UV5Kind
  36942. * * VertexBuffer.UV6Kind
  36943. * * VertexBuffer.ColorKind
  36944. * * VertexBuffer.MatricesIndicesKind
  36945. * * VertexBuffer.MatricesIndicesExtraKind
  36946. * * VertexBuffer.MatricesWeightsKind
  36947. * * VertexBuffer.MatricesWeightsExtraKind
  36948. * @param data defines the data source
  36949. * @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
  36950. * @param makeItUnique If true, a new global geometry is created from this data and is set to the mesh
  36951. * @returns the current mesh
  36952. */
  36953. updateVerticesData(kind: string, data: FloatArray, updateExtends?: boolean, makeItUnique?: boolean): AbstractMesh;
  36954. /**
  36955. * Sets the mesh indices,
  36956. * If the mesh has no geometry, a new Geometry object is created and set to the mesh.
  36957. * @param indices Expects an array populated with integers or a typed array (Int32Array, Uint32Array, Uint16Array)
  36958. * @param totalVertices Defines the total number of vertices
  36959. * @returns the current mesh
  36960. */
  36961. setIndices(indices: IndicesArray, totalVertices: Nullable<number>): AbstractMesh;
  36962. /**
  36963. * Gets a boolean indicating if specific vertex data is present
  36964. * @param kind defines the vertex data kind to use
  36965. * @returns true is data kind is present
  36966. */
  36967. isVerticesDataPresent(kind: string): boolean;
  36968. /**
  36969. * Returns the mesh BoundingInfo object or creates a new one and returns if it was undefined.
  36970. * Note that it returns a shallow bounding of the mesh (i.e. it does not include children).
  36971. * To get the full bounding of all children, call `getHierarchyBoundingVectors` instead.
  36972. * @returns a BoundingInfo
  36973. */
  36974. getBoundingInfo(): BoundingInfo;
  36975. /**
  36976. * Uniformly scales the mesh to fit inside of a unit cube (1 X 1 X 1 units)
  36977. * @param includeDescendants Use the hierarchy's bounding box instead of the mesh's bounding box. Default is false
  36978. * @param ignoreRotation ignore rotation when computing the scale (ie. object will be axis aligned). Default is false
  36979. * @param predicate predicate that is passed in to getHierarchyBoundingVectors when selecting which object should be included when scaling
  36980. * @returns the current mesh
  36981. */
  36982. normalizeToUnitCube(includeDescendants?: boolean, ignoreRotation?: boolean, predicate?: Nullable<(node: AbstractMesh) => boolean>): AbstractMesh;
  36983. /**
  36984. * Overwrite the current bounding info
  36985. * @param boundingInfo defines the new bounding info
  36986. * @returns the current mesh
  36987. */
  36988. setBoundingInfo(boundingInfo: BoundingInfo): AbstractMesh;
  36989. /** Gets a boolean indicating if this mesh has skinning data and an attached skeleton */
  36990. get useBones(): boolean;
  36991. /** @hidden */
  36992. _preActivate(): void;
  36993. /** @hidden */
  36994. _preActivateForIntermediateRendering(renderId: number): void;
  36995. /** @hidden */
  36996. _activate(renderId: number, intermediateRendering: boolean): boolean;
  36997. /** @hidden */
  36998. _postActivate(): void;
  36999. /** @hidden */
  37000. _freeze(): void;
  37001. /** @hidden */
  37002. _unFreeze(): void;
  37003. /**
  37004. * Gets the current world matrix
  37005. * @returns a Matrix
  37006. */
  37007. getWorldMatrix(): Matrix;
  37008. /** @hidden */
  37009. _getWorldMatrixDeterminant(): number;
  37010. /**
  37011. * Gets a boolean indicating if this mesh is an instance or a regular mesh
  37012. */
  37013. get isAnInstance(): boolean;
  37014. /**
  37015. * Gets a boolean indicating if this mesh has instances
  37016. */
  37017. get hasInstances(): boolean;
  37018. /**
  37019. * Gets a boolean indicating if this mesh has thin instances
  37020. */
  37021. get hasThinInstances(): boolean;
  37022. /**
  37023. * Perform relative position change from the point of view of behind the front of the mesh.
  37024. * This is performed taking into account the meshes current rotation, so you do not have to care.
  37025. * Supports definition of mesh facing forward or backward
  37026. * @param amountRight defines the distance on the right axis
  37027. * @param amountUp defines the distance on the up axis
  37028. * @param amountForward defines the distance on the forward axis
  37029. * @returns the current mesh
  37030. */
  37031. movePOV(amountRight: number, amountUp: number, amountForward: number): AbstractMesh;
  37032. /**
  37033. * Calculate relative position change from the point of view of behind the front of the mesh.
  37034. * This is performed taking into account the meshes current rotation, so you do not have to care.
  37035. * Supports definition of mesh facing forward or backward
  37036. * @param amountRight defines the distance on the right axis
  37037. * @param amountUp defines the distance on the up axis
  37038. * @param amountForward defines the distance on the forward axis
  37039. * @returns the new displacement vector
  37040. */
  37041. calcMovePOV(amountRight: number, amountUp: number, amountForward: number): Vector3;
  37042. /**
  37043. * Perform relative rotation change from the point of view of behind the front of the mesh.
  37044. * Supports definition of mesh facing forward or backward
  37045. * @param flipBack defines the flip
  37046. * @param twirlClockwise defines the twirl
  37047. * @param tiltRight defines the tilt
  37048. * @returns the current mesh
  37049. */
  37050. rotatePOV(flipBack: number, twirlClockwise: number, tiltRight: number): AbstractMesh;
  37051. /**
  37052. * Calculate relative rotation change from the point of view of behind the front of the mesh.
  37053. * Supports definition of mesh facing forward or backward.
  37054. * @param flipBack defines the flip
  37055. * @param twirlClockwise defines the twirl
  37056. * @param tiltRight defines the tilt
  37057. * @returns the new rotation vector
  37058. */
  37059. calcRotatePOV(flipBack: number, twirlClockwise: number, tiltRight: number): Vector3;
  37060. /**
  37061. * This method recomputes and sets a new BoundingInfo to the mesh unless it is locked.
  37062. * This means the mesh underlying bounding box and sphere are recomputed.
  37063. * @param applySkeleton defines whether to apply the skeleton before computing the bounding info
  37064. * @returns the current mesh
  37065. */
  37066. refreshBoundingInfo(applySkeleton?: boolean): AbstractMesh;
  37067. /** @hidden */
  37068. _refreshBoundingInfo(data: Nullable<FloatArray>, bias: Nullable<Vector2>): void;
  37069. /** @hidden */
  37070. _getPositionData(applySkeleton: boolean): Nullable<FloatArray>;
  37071. /** @hidden */
  37072. _updateBoundingInfo(): AbstractMesh;
  37073. /** @hidden */
  37074. _updateSubMeshesBoundingInfo(matrix: DeepImmutable<Matrix>): AbstractMesh;
  37075. /** @hidden */
  37076. protected _afterComputeWorldMatrix(): void;
  37077. /** @hidden */
  37078. get _effectiveMesh(): AbstractMesh;
  37079. /**
  37080. * Returns `true` if the mesh is within the frustum defined by the passed array of planes.
  37081. * A mesh is in the frustum if its bounding box intersects the frustum
  37082. * @param frustumPlanes defines the frustum to test
  37083. * @returns true if the mesh is in the frustum planes
  37084. */
  37085. isInFrustum(frustumPlanes: Plane[]): boolean;
  37086. /**
  37087. * Returns `true` if the mesh is completely in the frustum defined be the passed array of planes.
  37088. * A mesh is completely in the frustum if its bounding box it completely inside the frustum.
  37089. * @param frustumPlanes defines the frustum to test
  37090. * @returns true if the mesh is completely in the frustum planes
  37091. */
  37092. isCompletelyInFrustum(frustumPlanes: Plane[]): boolean;
  37093. /**
  37094. * True if the mesh intersects another mesh or a SolidParticle object
  37095. * @param mesh defines a target mesh or SolidParticle to test
  37096. * @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)
  37097. * @param includeDescendants Can be set to true to test if the mesh defined in parameters intersects with the current mesh or any child meshes
  37098. * @returns true if there is an intersection
  37099. */
  37100. intersectsMesh(mesh: AbstractMesh | SolidParticle, precise?: boolean, includeDescendants?: boolean): boolean;
  37101. /**
  37102. * Returns true if the passed point (Vector3) is inside the mesh bounding box
  37103. * @param point defines the point to test
  37104. * @returns true if there is an intersection
  37105. */
  37106. intersectsPoint(point: Vector3): boolean;
  37107. /**
  37108. * Gets or sets a boolean indicating that this mesh can be used in the collision engine
  37109. * @see https://doc.babylonjs.com/babylon101/cameras,_mesh_collisions_and_gravity
  37110. */
  37111. get checkCollisions(): boolean;
  37112. set checkCollisions(collisionEnabled: boolean);
  37113. /**
  37114. * Gets Collider object used to compute collisions (not physics)
  37115. * @see https://doc.babylonjs.com/babylon101/cameras,_mesh_collisions_and_gravity
  37116. */
  37117. get collider(): Nullable<Collider>;
  37118. /**
  37119. * Move the mesh using collision engine
  37120. * @see https://doc.babylonjs.com/babylon101/cameras,_mesh_collisions_and_gravity
  37121. * @param displacement defines the requested displacement vector
  37122. * @returns the current mesh
  37123. */
  37124. moveWithCollisions(displacement: Vector3): AbstractMesh;
  37125. private _onCollisionPositionChange;
  37126. /** @hidden */
  37127. _collideForSubMesh(subMesh: SubMesh, transformMatrix: Matrix, collider: Collider): AbstractMesh;
  37128. /** @hidden */
  37129. _processCollisionsForSubMeshes(collider: Collider, transformMatrix: Matrix): AbstractMesh;
  37130. /** @hidden */
  37131. _checkCollision(collider: Collider): AbstractMesh;
  37132. /** @hidden */
  37133. _generatePointsArray(): boolean;
  37134. /**
  37135. * Checks if the passed Ray intersects with the mesh
  37136. * @param ray defines the ray to use
  37137. * @param fastCheck defines if fast mode (but less precise) must be used (false by default)
  37138. * @param trianglePredicate defines an optional predicate used to select faces when a mesh intersection is detected
  37139. * @param onlyBoundingInfo defines a boolean indicating if picking should only happen using bounding info (false by default)
  37140. * @param worldToUse defines the world matrix to use to get the world coordinate of the intersection point
  37141. * @returns the picking info
  37142. * @see https://doc.babylonjs.com/babylon101/intersect_collisions_-_mesh
  37143. */
  37144. intersects(ray: Ray, fastCheck?: boolean, trianglePredicate?: TrianglePickingPredicate, onlyBoundingInfo?: boolean, worldToUse?: Matrix): PickingInfo;
  37145. /**
  37146. * Clones the current mesh
  37147. * @param name defines the mesh name
  37148. * @param newParent defines the new mesh parent
  37149. * @param doNotCloneChildren defines a boolean indicating that children must not be cloned (false by default)
  37150. * @returns the new mesh
  37151. */
  37152. clone(name: string, newParent: Nullable<Node>, doNotCloneChildren?: boolean): Nullable<AbstractMesh>;
  37153. /**
  37154. * Disposes all the submeshes of the current meshnp
  37155. * @returns the current mesh
  37156. */
  37157. releaseSubMeshes(): AbstractMesh;
  37158. /**
  37159. * Releases resources associated with this abstract mesh.
  37160. * @param doNotRecurse Set to true to not recurse into each children (recurse into each children by default)
  37161. * @param disposeMaterialAndTextures Set to true to also dispose referenced materials and textures (false by default)
  37162. */
  37163. dispose(doNotRecurse?: boolean, disposeMaterialAndTextures?: boolean): void;
  37164. /**
  37165. * Adds the passed mesh as a child to the current mesh
  37166. * @param mesh defines the child mesh
  37167. * @returns the current mesh
  37168. */
  37169. addChild(mesh: AbstractMesh): AbstractMesh;
  37170. /**
  37171. * Removes the passed mesh from the current mesh children list
  37172. * @param mesh defines the child mesh
  37173. * @returns the current mesh
  37174. */
  37175. removeChild(mesh: AbstractMesh): AbstractMesh;
  37176. /** @hidden */
  37177. private _initFacetData;
  37178. /**
  37179. * Updates the mesh facetData arrays and the internal partitioning when the mesh is morphed or updated.
  37180. * This method can be called within the render loop.
  37181. * 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
  37182. * @returns the current mesh
  37183. * @see https://doc.babylonjs.com/how_to/how_to_use_facetdata
  37184. */
  37185. updateFacetData(): AbstractMesh;
  37186. /**
  37187. * Returns the facetLocalNormals array.
  37188. * The normals are expressed in the mesh local spac
  37189. * @returns an array of Vector3
  37190. * @see https://doc.babylonjs.com/how_to/how_to_use_facetdata
  37191. */
  37192. getFacetLocalNormals(): Vector3[];
  37193. /**
  37194. * Returns the facetLocalPositions array.
  37195. * The facet positions are expressed in the mesh local space
  37196. * @returns an array of Vector3
  37197. * @see https://doc.babylonjs.com/how_to/how_to_use_facetdata
  37198. */
  37199. getFacetLocalPositions(): Vector3[];
  37200. /**
  37201. * Returns the facetLocalPartioning array
  37202. * @returns an array of array of numbers
  37203. * @see https://doc.babylonjs.com/how_to/how_to_use_facetdata
  37204. */
  37205. getFacetLocalPartitioning(): number[][];
  37206. /**
  37207. * Returns the i-th facet position in the world system.
  37208. * This method allocates a new Vector3 per call
  37209. * @param i defines the facet index
  37210. * @returns a new Vector3
  37211. * @see https://doc.babylonjs.com/how_to/how_to_use_facetdata
  37212. */
  37213. getFacetPosition(i: number): Vector3;
  37214. /**
  37215. * Sets the reference Vector3 with the i-th facet position in the world system
  37216. * @param i defines the facet index
  37217. * @param ref defines the target vector
  37218. * @returns the current mesh
  37219. * @see https://doc.babylonjs.com/how_to/how_to_use_facetdata
  37220. */
  37221. getFacetPositionToRef(i: number, ref: Vector3): AbstractMesh;
  37222. /**
  37223. * Returns the i-th facet normal in the world system.
  37224. * This method allocates a new Vector3 per call
  37225. * @param i defines the facet index
  37226. * @returns a new Vector3
  37227. * @see https://doc.babylonjs.com/how_to/how_to_use_facetdata
  37228. */
  37229. getFacetNormal(i: number): Vector3;
  37230. /**
  37231. * Sets the reference Vector3 with the i-th facet normal in the world system
  37232. * @param i defines the facet index
  37233. * @param ref defines the target vector
  37234. * @returns the current mesh
  37235. * @see https://doc.babylonjs.com/how_to/how_to_use_facetdata
  37236. */
  37237. getFacetNormalToRef(i: number, ref: Vector3): this;
  37238. /**
  37239. * 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)
  37240. * @param x defines x coordinate
  37241. * @param y defines y coordinate
  37242. * @param z defines z coordinate
  37243. * @returns the array of facet indexes
  37244. * @see https://doc.babylonjs.com/how_to/how_to_use_facetdata
  37245. */
  37246. getFacetsAtLocalCoordinates(x: number, y: number, z: number): Nullable<number[]>;
  37247. /**
  37248. * Returns the closest mesh facet index at (x,y,z) World coordinates, null if not found
  37249. * @param projected sets as the (x,y,z) world projection on the facet
  37250. * @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
  37251. * @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
  37252. * @param x defines x coordinate
  37253. * @param y defines y coordinate
  37254. * @param z defines z coordinate
  37255. * @returns the face index if found (or null instead)
  37256. * @see https://doc.babylonjs.com/how_to/how_to_use_facetdata
  37257. */
  37258. getClosestFacetAtCoordinates(x: number, y: number, z: number, projected?: Vector3, checkFace?: boolean, facing?: boolean): Nullable<number>;
  37259. /**
  37260. * Returns the closest mesh facet index at (x,y,z) local coordinates, null if not found
  37261. * @param projected sets as the (x,y,z) local projection on the facet
  37262. * @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
  37263. * @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
  37264. * @param x defines x coordinate
  37265. * @param y defines y coordinate
  37266. * @param z defines z coordinate
  37267. * @returns the face index if found (or null instead)
  37268. * @see https://doc.babylonjs.com/how_to/how_to_use_facetdata
  37269. */
  37270. getClosestFacetAtLocalCoordinates(x: number, y: number, z: number, projected?: Vector3, checkFace?: boolean, facing?: boolean): Nullable<number>;
  37271. /**
  37272. * Returns the object "parameter" set with all the expected parameters for facetData computation by ComputeNormals()
  37273. * @returns the parameters
  37274. * @see https://doc.babylonjs.com/how_to/how_to_use_facetdata
  37275. */
  37276. getFacetDataParameters(): any;
  37277. /**
  37278. * Disables the feature FacetData and frees the related memory
  37279. * @returns the current mesh
  37280. * @see https://doc.babylonjs.com/how_to/how_to_use_facetdata
  37281. */
  37282. disableFacetData(): AbstractMesh;
  37283. /**
  37284. * Updates the AbstractMesh indices array
  37285. * @param indices defines the data source
  37286. * @param offset defines the offset in the index buffer where to store the new data (can be null)
  37287. * @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)
  37288. * @returns the current mesh
  37289. */
  37290. updateIndices(indices: IndicesArray, offset?: number, gpuMemoryOnly?: boolean): AbstractMesh;
  37291. /**
  37292. * Creates new normals data for the mesh
  37293. * @param updatable defines if the normal vertex buffer must be flagged as updatable
  37294. * @returns the current mesh
  37295. */
  37296. createNormals(updatable: boolean): AbstractMesh;
  37297. /**
  37298. * Align the mesh with a normal
  37299. * @param normal defines the normal to use
  37300. * @param upDirection can be used to redefined the up vector to use (will use the (0, 1, 0) by default)
  37301. * @returns the current mesh
  37302. */
  37303. alignWithNormal(normal: Vector3, upDirection?: Vector3): AbstractMesh;
  37304. /** @hidden */
  37305. _checkOcclusionQuery(): boolean;
  37306. /**
  37307. * Disables the mesh edge rendering mode
  37308. * @returns the currentAbstractMesh
  37309. */
  37310. disableEdgesRendering(): AbstractMesh;
  37311. /**
  37312. * Enables the edge rendering mode on the mesh.
  37313. * This mode makes the mesh edges visible
  37314. * @param epsilon defines the maximal distance between two angles to detect a face
  37315. * @param checkVerticesInsteadOfIndices indicates that we should check vertex list directly instead of faces
  37316. * @returns the currentAbstractMesh
  37317. * @see https://www.babylonjs-playground.com/#19O9TU#0
  37318. */
  37319. enableEdgesRendering(epsilon?: number, checkVerticesInsteadOfIndices?: boolean): AbstractMesh;
  37320. /**
  37321. * This function returns all of the particle systems in the scene that use the mesh as an emitter.
  37322. * @returns an array of particle systems in the scene that use the mesh as an emitter
  37323. */
  37324. getConnectedParticleSystems(): IParticleSystem[];
  37325. }
  37326. }
  37327. declare module "babylonjs/Actions/actionEvent" {
  37328. import { AbstractMesh } from "babylonjs/Meshes/abstractMesh";
  37329. import { Nullable } from "babylonjs/types";
  37330. import { Sprite } from "babylonjs/Sprites/sprite";
  37331. import { Scene } from "babylonjs/scene";
  37332. import { Vector2 } from "babylonjs/Maths/math.vector";
  37333. /**
  37334. * Interface used to define ActionEvent
  37335. */
  37336. export interface IActionEvent {
  37337. /** The mesh or sprite that triggered the action */
  37338. source: any;
  37339. /** The X mouse cursor position at the time of the event */
  37340. pointerX: number;
  37341. /** The Y mouse cursor position at the time of the event */
  37342. pointerY: number;
  37343. /** The mesh that is currently pointed at (can be null) */
  37344. meshUnderPointer: Nullable<AbstractMesh>;
  37345. /** the original (browser) event that triggered the ActionEvent */
  37346. sourceEvent?: any;
  37347. /** additional data for the event */
  37348. additionalData?: any;
  37349. }
  37350. /**
  37351. * ActionEvent is the event being sent when an action is triggered.
  37352. */
  37353. export class ActionEvent implements IActionEvent {
  37354. /** The mesh or sprite that triggered the action */
  37355. source: any;
  37356. /** The X mouse cursor position at the time of the event */
  37357. pointerX: number;
  37358. /** The Y mouse cursor position at the time of the event */
  37359. pointerY: number;
  37360. /** The mesh that is currently pointed at (can be null) */
  37361. meshUnderPointer: Nullable<AbstractMesh>;
  37362. /** the original (browser) event that triggered the ActionEvent */
  37363. sourceEvent?: any;
  37364. /** additional data for the event */
  37365. additionalData?: any;
  37366. /**
  37367. * Creates a new ActionEvent
  37368. * @param source The mesh or sprite that triggered the action
  37369. * @param pointerX The X mouse cursor position at the time of the event
  37370. * @param pointerY The Y mouse cursor position at the time of the event
  37371. * @param meshUnderPointer The mesh that is currently pointed at (can be null)
  37372. * @param sourceEvent the original (browser) event that triggered the ActionEvent
  37373. * @param additionalData additional data for the event
  37374. */
  37375. constructor(
  37376. /** The mesh or sprite that triggered the action */
  37377. source: any,
  37378. /** The X mouse cursor position at the time of the event */
  37379. pointerX: number,
  37380. /** The Y mouse cursor position at the time of the event */
  37381. pointerY: number,
  37382. /** The mesh that is currently pointed at (can be null) */
  37383. meshUnderPointer: Nullable<AbstractMesh>,
  37384. /** the original (browser) event that triggered the ActionEvent */
  37385. sourceEvent?: any,
  37386. /** additional data for the event */
  37387. additionalData?: any);
  37388. /**
  37389. * Helper function to auto-create an ActionEvent from a source mesh.
  37390. * @param source The source mesh that triggered the event
  37391. * @param evt The original (browser) event
  37392. * @param additionalData additional data for the event
  37393. * @returns the new ActionEvent
  37394. */
  37395. static CreateNew(source: AbstractMesh, evt?: Event, additionalData?: any): ActionEvent;
  37396. /**
  37397. * Helper function to auto-create an ActionEvent from a source sprite
  37398. * @param source The source sprite that triggered the event
  37399. * @param scene Scene associated with the sprite
  37400. * @param evt The original (browser) event
  37401. * @param additionalData additional data for the event
  37402. * @returns the new ActionEvent
  37403. */
  37404. static CreateNewFromSprite(source: Sprite, scene: Scene, evt?: Event, additionalData?: any): ActionEvent;
  37405. /**
  37406. * Helper function to auto-create an ActionEvent from a scene. If triggered by a mesh use ActionEvent.CreateNew
  37407. * @param scene the scene where the event occurred
  37408. * @param evt The original (browser) event
  37409. * @returns the new ActionEvent
  37410. */
  37411. static CreateNewFromScene(scene: Scene, evt: Event): ActionEvent;
  37412. /**
  37413. * Helper function to auto-create an ActionEvent from a primitive
  37414. * @param prim defines the target primitive
  37415. * @param pointerPos defines the pointer position
  37416. * @param evt The original (browser) event
  37417. * @param additionalData additional data for the event
  37418. * @returns the new ActionEvent
  37419. */
  37420. static CreateNewFromPrimitive(prim: any, pointerPos: Vector2, evt?: Event, additionalData?: any): ActionEvent;
  37421. }
  37422. }
  37423. declare module "babylonjs/Actions/abstractActionManager" {
  37424. import { IDisposable } from "babylonjs/scene";
  37425. import { IActionEvent } from "babylonjs/Actions/actionEvent";
  37426. import { IAction } from "babylonjs/Actions/action";
  37427. import { Nullable } from "babylonjs/types";
  37428. /**
  37429. * Abstract class used to decouple action Manager from scene and meshes.
  37430. * Do not instantiate.
  37431. * @see https://doc.babylonjs.com/how_to/how_to_use_actions
  37432. */
  37433. export abstract class AbstractActionManager implements IDisposable {
  37434. /** Gets the list of active triggers */
  37435. static Triggers: {
  37436. [key: string]: number;
  37437. };
  37438. /** Gets the cursor to use when hovering items */
  37439. hoverCursor: string;
  37440. /** Gets the list of actions */
  37441. actions: IAction[];
  37442. /**
  37443. * Gets or sets a boolean indicating that the manager is recursive meaning that it can trigger action from children
  37444. */
  37445. isRecursive: boolean;
  37446. /**
  37447. * Releases all associated resources
  37448. */
  37449. abstract dispose(): void;
  37450. /**
  37451. * Does this action manager has pointer triggers
  37452. */
  37453. abstract get hasPointerTriggers(): boolean;
  37454. /**
  37455. * Does this action manager has pick triggers
  37456. */
  37457. abstract get hasPickTriggers(): boolean;
  37458. /**
  37459. * Process a specific trigger
  37460. * @param trigger defines the trigger to process
  37461. * @param evt defines the event details to be processed
  37462. */
  37463. abstract processTrigger(trigger: number, evt?: IActionEvent): void;
  37464. /**
  37465. * Does this action manager handles actions of any of the given triggers
  37466. * @param triggers defines the triggers to be tested
  37467. * @return a boolean indicating whether one (or more) of the triggers is handled
  37468. */
  37469. abstract hasSpecificTriggers(triggers: number[]): boolean;
  37470. /**
  37471. * Does this action manager handles actions of any of the given triggers. This function takes two arguments for
  37472. * speed.
  37473. * @param triggerA defines the trigger to be tested
  37474. * @param triggerB defines the trigger to be tested
  37475. * @return a boolean indicating whether one (or more) of the triggers is handled
  37476. */
  37477. abstract hasSpecificTriggers2(triggerA: number, triggerB: number): boolean;
  37478. /**
  37479. * Does this action manager handles actions of a given trigger
  37480. * @param trigger defines the trigger to be tested
  37481. * @param parameterPredicate defines an optional predicate to filter triggers by parameter
  37482. * @return whether the trigger is handled
  37483. */
  37484. abstract hasSpecificTrigger(trigger: number, parameterPredicate?: (parameter: any) => boolean): boolean;
  37485. /**
  37486. * Serialize this manager to a JSON object
  37487. * @param name defines the property name to store this manager
  37488. * @returns a JSON representation of this manager
  37489. */
  37490. abstract serialize(name: string): any;
  37491. /**
  37492. * Registers an action to this action manager
  37493. * @param action defines the action to be registered
  37494. * @return the action amended (prepared) after registration
  37495. */
  37496. abstract registerAction(action: IAction): Nullable<IAction>;
  37497. /**
  37498. * Unregisters an action to this action manager
  37499. * @param action defines the action to be unregistered
  37500. * @return a boolean indicating whether the action has been unregistered
  37501. */
  37502. abstract unregisterAction(action: IAction): Boolean;
  37503. /**
  37504. * Does exist one action manager with at least one trigger
  37505. **/
  37506. static get HasTriggers(): boolean;
  37507. /**
  37508. * Does exist one action manager with at least one pick trigger
  37509. **/
  37510. static get HasPickTriggers(): boolean;
  37511. /**
  37512. * Does exist one action manager that handles actions of a given trigger
  37513. * @param trigger defines the trigger to be tested
  37514. * @return a boolean indicating whether the trigger is handeled by at least one action manager
  37515. **/
  37516. static HasSpecificTrigger(trigger: number): boolean;
  37517. }
  37518. }
  37519. declare module "babylonjs/node" {
  37520. import { Scene } from "babylonjs/scene";
  37521. import { Nullable } from "babylonjs/types";
  37522. import { Matrix, Vector3 } from "babylonjs/Maths/math.vector";
  37523. import { Engine } from "babylonjs/Engines/engine";
  37524. import { IBehaviorAware, Behavior } from "babylonjs/Behaviors/behavior";
  37525. import { Observable } from "babylonjs/Misc/observable";
  37526. import { AbstractActionManager } from "babylonjs/Actions/abstractActionManager";
  37527. import { IInspectable } from "babylonjs/Misc/iInspectable";
  37528. import { Animatable } from "babylonjs/Animations/animatable";
  37529. import { AnimationPropertiesOverride } from "babylonjs/Animations/animationPropertiesOverride";
  37530. import { Animation } from "babylonjs/Animations/animation";
  37531. import { AnimationRange } from "babylonjs/Animations/animationRange";
  37532. import { AbstractMesh } from "babylonjs/Meshes/abstractMesh";
  37533. /**
  37534. * Defines how a node can be built from a string name.
  37535. */
  37536. export type NodeConstructor = (name: string, scene: Scene, options?: any) => () => Node;
  37537. /**
  37538. * Node is the basic class for all scene objects (Mesh, Light, Camera.)
  37539. */
  37540. export class Node implements IBehaviorAware<Node> {
  37541. /** @hidden */
  37542. static _AnimationRangeFactory: (name: string, from: number, to: number) => AnimationRange;
  37543. private static _NodeConstructors;
  37544. /**
  37545. * Add a new node constructor
  37546. * @param type defines the type name of the node to construct
  37547. * @param constructorFunc defines the constructor function
  37548. */
  37549. static AddNodeConstructor(type: string, constructorFunc: NodeConstructor): void;
  37550. /**
  37551. * Returns a node constructor based on type name
  37552. * @param type defines the type name
  37553. * @param name defines the new node name
  37554. * @param scene defines the hosting scene
  37555. * @param options defines optional options to transmit to constructors
  37556. * @returns the new constructor or null
  37557. */
  37558. static Construct(type: string, name: string, scene: Scene, options?: any): Nullable<() => Node>;
  37559. /**
  37560. * Gets or sets the name of the node
  37561. */
  37562. name: string;
  37563. /**
  37564. * Gets or sets the id of the node
  37565. */
  37566. id: string;
  37567. /**
  37568. * Gets or sets the unique id of the node
  37569. */
  37570. uniqueId: number;
  37571. /**
  37572. * Gets or sets a string used to store user defined state for the node
  37573. */
  37574. state: string;
  37575. /**
  37576. * Gets or sets an object used to store user defined information for the node
  37577. */
  37578. metadata: any;
  37579. /**
  37580. * For internal use only. Please do not use.
  37581. */
  37582. reservedDataStore: any;
  37583. /**
  37584. * List of inspectable custom properties (used by the Inspector)
  37585. * @see https://doc.babylonjs.com/how_to/debug_layer#extensibility
  37586. */
  37587. inspectableCustomProperties: IInspectable[];
  37588. private _doNotSerialize;
  37589. /**
  37590. * Gets or sets a boolean used to define if the node must be serialized
  37591. */
  37592. get doNotSerialize(): boolean;
  37593. set doNotSerialize(value: boolean);
  37594. /** @hidden */
  37595. _isDisposed: boolean;
  37596. /**
  37597. * Gets a list of Animations associated with the node
  37598. */
  37599. animations: import("babylonjs/Animations/animation").Animation[];
  37600. protected _ranges: {
  37601. [name: string]: Nullable<AnimationRange>;
  37602. };
  37603. /**
  37604. * Callback raised when the node is ready to be used
  37605. */
  37606. onReady: Nullable<(node: Node) => void>;
  37607. private _isEnabled;
  37608. private _isParentEnabled;
  37609. private _isReady;
  37610. /** @hidden */
  37611. _currentRenderId: number;
  37612. private _parentUpdateId;
  37613. /** @hidden */
  37614. _childUpdateId: number;
  37615. /** @hidden */
  37616. _waitingParentId: Nullable<string>;
  37617. /** @hidden */
  37618. _scene: Scene;
  37619. /** @hidden */
  37620. _cache: any;
  37621. private _parentNode;
  37622. private _children;
  37623. /** @hidden */
  37624. _worldMatrix: Matrix;
  37625. /** @hidden */
  37626. _worldMatrixDeterminant: number;
  37627. /** @hidden */
  37628. _worldMatrixDeterminantIsDirty: boolean;
  37629. /** @hidden */
  37630. private _sceneRootNodesIndex;
  37631. /**
  37632. * Gets a boolean indicating if the node has been disposed
  37633. * @returns true if the node was disposed
  37634. */
  37635. isDisposed(): boolean;
  37636. /**
  37637. * Gets or sets the parent of the node (without keeping the current position in the scene)
  37638. * @see https://doc.babylonjs.com/how_to/parenting
  37639. */
  37640. set parent(parent: Nullable<Node>);
  37641. get parent(): Nullable<Node>;
  37642. /** @hidden */
  37643. _addToSceneRootNodes(): void;
  37644. /** @hidden */
  37645. _removeFromSceneRootNodes(): void;
  37646. private _animationPropertiesOverride;
  37647. /**
  37648. * Gets or sets the animation properties override
  37649. */
  37650. get animationPropertiesOverride(): Nullable<AnimationPropertiesOverride>;
  37651. set animationPropertiesOverride(value: Nullable<AnimationPropertiesOverride>);
  37652. /**
  37653. * Gets a string identifying the name of the class
  37654. * @returns "Node" string
  37655. */
  37656. getClassName(): string;
  37657. /** @hidden */
  37658. readonly _isNode: boolean;
  37659. /**
  37660. * An event triggered when the mesh is disposed
  37661. */
  37662. onDisposeObservable: Observable<Node>;
  37663. private _onDisposeObserver;
  37664. /**
  37665. * Sets a callback that will be raised when the node will be disposed
  37666. */
  37667. set onDispose(callback: () => void);
  37668. /**
  37669. * Creates a new Node
  37670. * @param name the name and id to be given to this node
  37671. * @param scene the scene this node will be added to
  37672. */
  37673. constructor(name: string, scene?: Nullable<Scene>);
  37674. /**
  37675. * Gets the scene of the node
  37676. * @returns a scene
  37677. */
  37678. getScene(): Scene;
  37679. /**
  37680. * Gets the engine of the node
  37681. * @returns a Engine
  37682. */
  37683. getEngine(): Engine;
  37684. private _behaviors;
  37685. /**
  37686. * Attach a behavior to the node
  37687. * @see https://doc.babylonjs.com/features/behaviour
  37688. * @param behavior defines the behavior to attach
  37689. * @param attachImmediately defines that the behavior must be attached even if the scene is still loading
  37690. * @returns the current Node
  37691. */
  37692. addBehavior(behavior: Behavior<Node>, attachImmediately?: boolean): Node;
  37693. /**
  37694. * Remove an attached behavior
  37695. * @see https://doc.babylonjs.com/features/behaviour
  37696. * @param behavior defines the behavior to attach
  37697. * @returns the current Node
  37698. */
  37699. removeBehavior(behavior: Behavior<Node>): Node;
  37700. /**
  37701. * Gets the list of attached behaviors
  37702. * @see https://doc.babylonjs.com/features/behaviour
  37703. */
  37704. get behaviors(): Behavior<Node>[];
  37705. /**
  37706. * Gets an attached behavior by name
  37707. * @param name defines the name of the behavior to look for
  37708. * @see https://doc.babylonjs.com/features/behaviour
  37709. * @returns null if behavior was not found else the requested behavior
  37710. */
  37711. getBehaviorByName(name: string): Nullable<Behavior<Node>>;
  37712. /**
  37713. * Returns the latest update of the World matrix
  37714. * @returns a Matrix
  37715. */
  37716. getWorldMatrix(): Matrix;
  37717. /** @hidden */
  37718. _getWorldMatrixDeterminant(): number;
  37719. /**
  37720. * Returns directly the latest state of the mesh World matrix.
  37721. * A Matrix is returned.
  37722. */
  37723. get worldMatrixFromCache(): Matrix;
  37724. /** @hidden */
  37725. _initCache(): void;
  37726. /** @hidden */
  37727. updateCache(force?: boolean): void;
  37728. /** @hidden */
  37729. _getActionManagerForTrigger(trigger?: number, initialCall?: boolean): Nullable<AbstractActionManager>;
  37730. /** @hidden */
  37731. _updateCache(ignoreParentClass?: boolean): void;
  37732. /** @hidden */
  37733. _isSynchronized(): boolean;
  37734. /** @hidden */
  37735. _markSyncedWithParent(): void;
  37736. /** @hidden */
  37737. isSynchronizedWithParent(): boolean;
  37738. /** @hidden */
  37739. isSynchronized(): boolean;
  37740. /**
  37741. * Is this node ready to be used/rendered
  37742. * @param completeCheck defines if a complete check (including materials and lights) has to be done (false by default)
  37743. * @return true if the node is ready
  37744. */
  37745. isReady(completeCheck?: boolean): boolean;
  37746. /**
  37747. * Is this node enabled?
  37748. * 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
  37749. * @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
  37750. * @return whether this node (and its parent) is enabled
  37751. */
  37752. isEnabled(checkAncestors?: boolean): boolean;
  37753. /** @hidden */
  37754. protected _syncParentEnabledState(): void;
  37755. /**
  37756. * Set the enabled state of this node
  37757. * @param value defines the new enabled state
  37758. */
  37759. setEnabled(value: boolean): void;
  37760. /**
  37761. * Is this node a descendant of the given node?
  37762. * The function will iterate up the hierarchy until the ancestor was found or no more parents defined
  37763. * @param ancestor defines the parent node to inspect
  37764. * @returns a boolean indicating if this node is a descendant of the given node
  37765. */
  37766. isDescendantOf(ancestor: Node): boolean;
  37767. /** @hidden */
  37768. _getDescendants(results: Node[], directDescendantsOnly?: boolean, predicate?: (node: Node) => boolean): void;
  37769. /**
  37770. * Will return all nodes that have this node as ascendant
  37771. * @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
  37772. * @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
  37773. * @return all children nodes of all types
  37774. */
  37775. getDescendants(directDescendantsOnly?: boolean, predicate?: (node: Node) => boolean): Node[];
  37776. /**
  37777. * Get all child-meshes of this node
  37778. * @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)
  37779. * @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
  37780. * @returns an array of AbstractMesh
  37781. */
  37782. getChildMeshes(directDescendantsOnly?: boolean, predicate?: (node: Node) => boolean): AbstractMesh[];
  37783. /**
  37784. * Get all direct children of this node
  37785. * @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
  37786. * @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)
  37787. * @returns an array of Node
  37788. */
  37789. getChildren(predicate?: (node: Node) => boolean, directDescendantsOnly?: boolean): Node[];
  37790. /** @hidden */
  37791. _setReady(state: boolean): void;
  37792. /**
  37793. * Get an animation by name
  37794. * @param name defines the name of the animation to look for
  37795. * @returns null if not found else the requested animation
  37796. */
  37797. getAnimationByName(name: string): Nullable<Animation>;
  37798. /**
  37799. * Creates an animation range for this node
  37800. * @param name defines the name of the range
  37801. * @param from defines the starting key
  37802. * @param to defines the end key
  37803. */
  37804. createAnimationRange(name: string, from: number, to: number): void;
  37805. /**
  37806. * Delete a specific animation range
  37807. * @param name defines the name of the range to delete
  37808. * @param deleteFrames defines if animation frames from the range must be deleted as well
  37809. */
  37810. deleteAnimationRange(name: string, deleteFrames?: boolean): void;
  37811. /**
  37812. * Get an animation range by name
  37813. * @param name defines the name of the animation range to look for
  37814. * @returns null if not found else the requested animation range
  37815. */
  37816. getAnimationRange(name: string): Nullable<AnimationRange>;
  37817. /**
  37818. * Gets the list of all animation ranges defined on this node
  37819. * @returns an array
  37820. */
  37821. getAnimationRanges(): Nullable<AnimationRange>[];
  37822. /**
  37823. * Will start the animation sequence
  37824. * @param name defines the range frames for animation sequence
  37825. * @param loop defines if the animation should loop (false by default)
  37826. * @param speedRatio defines the speed factor in which to run the animation (1 by default)
  37827. * @param onAnimationEnd defines a function to be executed when the animation ended (undefined by default)
  37828. * @returns the object created for this animation. If range does not exist, it will return null
  37829. */
  37830. beginAnimation(name: string, loop?: boolean, speedRatio?: number, onAnimationEnd?: () => void): Nullable<Animatable>;
  37831. /**
  37832. * Serialize animation ranges into a JSON compatible object
  37833. * @returns serialization object
  37834. */
  37835. serializeAnimationRanges(): any;
  37836. /**
  37837. * Computes the world matrix of the node
  37838. * @param force defines if the cache version should be invalidated forcing the world matrix to be created from scratch
  37839. * @returns the world matrix
  37840. */
  37841. computeWorldMatrix(force?: boolean): Matrix;
  37842. /**
  37843. * Releases resources associated with this node.
  37844. * @param doNotRecurse Set to true to not recurse into each children (recurse into each children by default)
  37845. * @param disposeMaterialAndTextures Set to true to also dispose referenced materials and textures (false by default)
  37846. */
  37847. dispose(doNotRecurse?: boolean, disposeMaterialAndTextures?: boolean): void;
  37848. /**
  37849. * Parse animation range data from a serialization object and store them into a given node
  37850. * @param node defines where to store the animation ranges
  37851. * @param parsedNode defines the serialization object to read data from
  37852. * @param scene defines the hosting scene
  37853. */
  37854. static ParseAnimationRanges(node: Node, parsedNode: any, scene: Scene): void;
  37855. /**
  37856. * Return the minimum and maximum world vectors of the entire hierarchy under current node
  37857. * @param includeDescendants Include bounding info from descendants as well (true by default)
  37858. * @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
  37859. * @returns the new bounding vectors
  37860. */
  37861. getHierarchyBoundingVectors(includeDescendants?: boolean, predicate?: Nullable<(abstractMesh: AbstractMesh) => boolean>): {
  37862. min: Vector3;
  37863. max: Vector3;
  37864. };
  37865. }
  37866. }
  37867. declare module "babylonjs/Animations/animation" {
  37868. import { IEasingFunction, EasingFunction } from "babylonjs/Animations/easing";
  37869. import { Vector3, Quaternion, Vector2, Matrix } from "babylonjs/Maths/math.vector";
  37870. import { Color3, Color4 } from "babylonjs/Maths/math.color";
  37871. import { Nullable } from "babylonjs/types";
  37872. import { Scene } from "babylonjs/scene";
  37873. import { IAnimationKey } from "babylonjs/Animations/animationKey";
  37874. import { AnimationRange } from "babylonjs/Animations/animationRange";
  37875. import { AnimationEvent } from "babylonjs/Animations/animationEvent";
  37876. import { Node } from "babylonjs/node";
  37877. import { IAnimatable } from "babylonjs/Animations/animatable.interface";
  37878. import { Size } from "babylonjs/Maths/math.size";
  37879. import { Animatable } from "babylonjs/Animations/animatable";
  37880. import { RuntimeAnimation } from "babylonjs/Animations/runtimeAnimation";
  37881. /**
  37882. * @hidden
  37883. */
  37884. export class _IAnimationState {
  37885. key: number;
  37886. repeatCount: number;
  37887. workValue?: any;
  37888. loopMode?: number;
  37889. offsetValue?: any;
  37890. highLimitValue?: any;
  37891. }
  37892. /**
  37893. * Class used to store any kind of animation
  37894. */
  37895. export class Animation {
  37896. /**Name of the animation */
  37897. name: string;
  37898. /**Property to animate */
  37899. targetProperty: string;
  37900. /**The frames per second of the animation */
  37901. framePerSecond: number;
  37902. /**The data type of the animation */
  37903. dataType: number;
  37904. /**The loop mode of the animation */
  37905. loopMode?: number | undefined;
  37906. /**Specifies if blending should be enabled */
  37907. enableBlending?: boolean | undefined;
  37908. /**
  37909. * Use matrix interpolation instead of using direct key value when animating matrices
  37910. */
  37911. static AllowMatricesInterpolation: boolean;
  37912. /**
  37913. * When matrix interpolation is enabled, this boolean forces the system to use Matrix.DecomposeLerp instead of Matrix.Lerp. Interpolation is more precise but slower
  37914. */
  37915. static AllowMatrixDecomposeForInterpolation: boolean;
  37916. /** Define the Url to load snippets */
  37917. static SnippetUrl: string;
  37918. /** Snippet ID if the animation was created from the snippet server */
  37919. snippetId: string;
  37920. /**
  37921. * Stores the key frames of the animation
  37922. */
  37923. private _keys;
  37924. /**
  37925. * Stores the easing function of the animation
  37926. */
  37927. private _easingFunction;
  37928. /**
  37929. * @hidden Internal use only
  37930. */
  37931. _runtimeAnimations: import("babylonjs/Animations/runtimeAnimation").RuntimeAnimation[];
  37932. /**
  37933. * The set of event that will be linked to this animation
  37934. */
  37935. private _events;
  37936. /**
  37937. * Stores an array of target property paths
  37938. */
  37939. targetPropertyPath: string[];
  37940. /**
  37941. * Stores the blending speed of the animation
  37942. */
  37943. blendingSpeed: number;
  37944. /**
  37945. * Stores the animation ranges for the animation
  37946. */
  37947. private _ranges;
  37948. /**
  37949. * @hidden Internal use
  37950. */
  37951. static _PrepareAnimation(name: string, targetProperty: string, framePerSecond: number, totalFrame: number, from: any, to: any, loopMode?: number, easingFunction?: EasingFunction): Nullable<Animation>;
  37952. /**
  37953. * Sets up an animation
  37954. * @param property The property to animate
  37955. * @param animationType The animation type to apply
  37956. * @param framePerSecond The frames per second of the animation
  37957. * @param easingFunction The easing function used in the animation
  37958. * @returns The created animation
  37959. */
  37960. static CreateAnimation(property: string, animationType: number, framePerSecond: number, easingFunction: EasingFunction): Animation;
  37961. /**
  37962. * Create and start an animation on a node
  37963. * @param name defines the name of the global animation that will be run on all nodes
  37964. * @param node defines the root node where the animation will take place
  37965. * @param targetProperty defines property to animate
  37966. * @param framePerSecond defines the number of frame per second yo use
  37967. * @param totalFrame defines the number of frames in total
  37968. * @param from defines the initial value
  37969. * @param to defines the final value
  37970. * @param loopMode defines which loop mode you want to use (off by default)
  37971. * @param easingFunction defines the easing function to use (linear by default)
  37972. * @param onAnimationEnd defines the callback to call when animation end
  37973. * @returns the animatable created for this animation
  37974. */
  37975. static CreateAndStartAnimation(name: string, node: Node, targetProperty: string, framePerSecond: number, totalFrame: number, from: any, to: any, loopMode?: number, easingFunction?: EasingFunction, onAnimationEnd?: () => void): Nullable<Animatable>;
  37976. /**
  37977. * Create and start an animation on a node and its descendants
  37978. * @param name defines the name of the global animation that will be run on all nodes
  37979. * @param node defines the root node where the animation will take place
  37980. * @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
  37981. * @param targetProperty defines property to animate
  37982. * @param framePerSecond defines the number of frame per second to use
  37983. * @param totalFrame defines the number of frames in total
  37984. * @param from defines the initial value
  37985. * @param to defines the final value
  37986. * @param loopMode defines which loop mode you want to use (off by default)
  37987. * @param easingFunction defines the easing function to use (linear by default)
  37988. * @param onAnimationEnd defines the callback to call when an animation ends (will be called once per node)
  37989. * @returns the list of animatables created for all nodes
  37990. * @example https://www.babylonjs-playground.com/#MH0VLI
  37991. */
  37992. 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[]>;
  37993. /**
  37994. * Creates a new animation, merges it with the existing animations and starts it
  37995. * @param name Name of the animation
  37996. * @param node Node which contains the scene that begins the animations
  37997. * @param targetProperty Specifies which property to animate
  37998. * @param framePerSecond The frames per second of the animation
  37999. * @param totalFrame The total number of frames
  38000. * @param from The frame at the beginning of the animation
  38001. * @param to The frame at the end of the animation
  38002. * @param loopMode Specifies the loop mode of the animation
  38003. * @param easingFunction (Optional) The easing function of the animation, which allow custom mathematical formulas for animations
  38004. * @param onAnimationEnd Callback to run once the animation is complete
  38005. * @returns Nullable animation
  38006. */
  38007. static CreateMergeAndStartAnimation(name: string, node: Node, targetProperty: string, framePerSecond: number, totalFrame: number, from: any, to: any, loopMode?: number, easingFunction?: EasingFunction, onAnimationEnd?: () => void): Nullable<Animatable>;
  38008. /**
  38009. * Convert the keyframes for all animations belonging to the group to be relative to a given reference frame.
  38010. * @param sourceAnimation defines the Animation containing keyframes to convert
  38011. * @param referenceFrame defines the frame that keyframes in the range will be relative to
  38012. * @param range defines the name of the AnimationRange belonging to the Animation to convert
  38013. * @param cloneOriginal defines whether or not to clone the animation and convert the clone or convert the original animation (default is false)
  38014. * @param clonedName defines the name of the resulting cloned Animation if cloneOriginal is true
  38015. * @returns a new Animation if cloneOriginal is true or the original Animation if cloneOriginal is false
  38016. */
  38017. static MakeAnimationAdditive(sourceAnimation: Animation, referenceFrame?: number, range?: string, cloneOriginal?: boolean, clonedName?: string): Animation;
  38018. /**
  38019. * Transition property of an host to the target Value
  38020. * @param property The property to transition
  38021. * @param targetValue The target Value of the property
  38022. * @param host The object where the property to animate belongs
  38023. * @param scene Scene used to run the animation
  38024. * @param frameRate Framerate (in frame/s) to use
  38025. * @param transition The transition type we want to use
  38026. * @param duration The duration of the animation, in milliseconds
  38027. * @param onAnimationEnd Callback trigger at the end of the animation
  38028. * @returns Nullable animation
  38029. */
  38030. static TransitionTo(property: string, targetValue: any, host: any, scene: Scene, frameRate: number, transition: Animation, duration: number, onAnimationEnd?: Nullable<() => void>): Nullable<Animatable>;
  38031. /**
  38032. * Return the array of runtime animations currently using this animation
  38033. */
  38034. get runtimeAnimations(): RuntimeAnimation[];
  38035. /**
  38036. * Specifies if any of the runtime animations are currently running
  38037. */
  38038. get hasRunningRuntimeAnimations(): boolean;
  38039. /**
  38040. * Initializes the animation
  38041. * @param name Name of the animation
  38042. * @param targetProperty Property to animate
  38043. * @param framePerSecond The frames per second of the animation
  38044. * @param dataType The data type of the animation
  38045. * @param loopMode The loop mode of the animation
  38046. * @param enableBlending Specifies if blending should be enabled
  38047. */
  38048. constructor(
  38049. /**Name of the animation */
  38050. name: string,
  38051. /**Property to animate */
  38052. targetProperty: string,
  38053. /**The frames per second of the animation */
  38054. framePerSecond: number,
  38055. /**The data type of the animation */
  38056. dataType: number,
  38057. /**The loop mode of the animation */
  38058. loopMode?: number | undefined,
  38059. /**Specifies if blending should be enabled */
  38060. enableBlending?: boolean | undefined);
  38061. /**
  38062. * Converts the animation to a string
  38063. * @param fullDetails support for multiple levels of logging within scene loading
  38064. * @returns String form of the animation
  38065. */
  38066. toString(fullDetails?: boolean): string;
  38067. /**
  38068. * Add an event to this animation
  38069. * @param event Event to add
  38070. */
  38071. addEvent(event: AnimationEvent): void;
  38072. /**
  38073. * Remove all events found at the given frame
  38074. * @param frame The frame to remove events from
  38075. */
  38076. removeEvents(frame: number): void;
  38077. /**
  38078. * Retrieves all the events from the animation
  38079. * @returns Events from the animation
  38080. */
  38081. getEvents(): AnimationEvent[];
  38082. /**
  38083. * Creates an animation range
  38084. * @param name Name of the animation range
  38085. * @param from Starting frame of the animation range
  38086. * @param to Ending frame of the animation
  38087. */
  38088. createRange(name: string, from: number, to: number): void;
  38089. /**
  38090. * Deletes an animation range by name
  38091. * @param name Name of the animation range to delete
  38092. * @param deleteFrames Specifies if the key frames for the range should also be deleted (true) or not (false)
  38093. */
  38094. deleteRange(name: string, deleteFrames?: boolean): void;
  38095. /**
  38096. * Gets the animation range by name, or null if not defined
  38097. * @param name Name of the animation range
  38098. * @returns Nullable animation range
  38099. */
  38100. getRange(name: string): Nullable<AnimationRange>;
  38101. /**
  38102. * Gets the key frames from the animation
  38103. * @returns The key frames of the animation
  38104. */
  38105. getKeys(): Array<IAnimationKey>;
  38106. /**
  38107. * Gets the highest frame rate of the animation
  38108. * @returns Highest frame rate of the animation
  38109. */
  38110. getHighestFrame(): number;
  38111. /**
  38112. * Gets the easing function of the animation
  38113. * @returns Easing function of the animation
  38114. */
  38115. getEasingFunction(): IEasingFunction;
  38116. /**
  38117. * Sets the easing function of the animation
  38118. * @param easingFunction A custom mathematical formula for animation
  38119. */
  38120. setEasingFunction(easingFunction: EasingFunction): void;
  38121. /**
  38122. * Interpolates a scalar linearly
  38123. * @param startValue Start value of the animation curve
  38124. * @param endValue End value of the animation curve
  38125. * @param gradient Scalar amount to interpolate
  38126. * @returns Interpolated scalar value
  38127. */
  38128. floatInterpolateFunction(startValue: number, endValue: number, gradient: number): number;
  38129. /**
  38130. * Interpolates a scalar cubically
  38131. * @param startValue Start value of the animation curve
  38132. * @param outTangent End tangent of the animation
  38133. * @param endValue End value of the animation curve
  38134. * @param inTangent Start tangent of the animation curve
  38135. * @param gradient Scalar amount to interpolate
  38136. * @returns Interpolated scalar value
  38137. */
  38138. floatInterpolateFunctionWithTangents(startValue: number, outTangent: number, endValue: number, inTangent: number, gradient: number): number;
  38139. /**
  38140. * Interpolates a quaternion using a spherical linear interpolation
  38141. * @param startValue Start value of the animation curve
  38142. * @param endValue End value of the animation curve
  38143. * @param gradient Scalar amount to interpolate
  38144. * @returns Interpolated quaternion value
  38145. */
  38146. quaternionInterpolateFunction(startValue: Quaternion, endValue: Quaternion, gradient: number): Quaternion;
  38147. /**
  38148. * Interpolates a quaternion cubically
  38149. * @param startValue Start value of the animation curve
  38150. * @param outTangent End tangent of the animation curve
  38151. * @param endValue End value of the animation curve
  38152. * @param inTangent Start tangent of the animation curve
  38153. * @param gradient Scalar amount to interpolate
  38154. * @returns Interpolated quaternion value
  38155. */
  38156. quaternionInterpolateFunctionWithTangents(startValue: Quaternion, outTangent: Quaternion, endValue: Quaternion, inTangent: Quaternion, gradient: number): Quaternion;
  38157. /**
  38158. * Interpolates a Vector3 linearl
  38159. * @param startValue Start value of the animation curve
  38160. * @param endValue End value of the animation curve
  38161. * @param gradient Scalar amount to interpolate
  38162. * @returns Interpolated scalar value
  38163. */
  38164. vector3InterpolateFunction(startValue: Vector3, endValue: Vector3, gradient: number): Vector3;
  38165. /**
  38166. * Interpolates a Vector3 cubically
  38167. * @param startValue Start value of the animation curve
  38168. * @param outTangent End tangent of the animation
  38169. * @param endValue End value of the animation curve
  38170. * @param inTangent Start tangent of the animation curve
  38171. * @param gradient Scalar amount to interpolate
  38172. * @returns InterpolatedVector3 value
  38173. */
  38174. vector3InterpolateFunctionWithTangents(startValue: Vector3, outTangent: Vector3, endValue: Vector3, inTangent: Vector3, gradient: number): Vector3;
  38175. /**
  38176. * Interpolates a Vector2 linearly
  38177. * @param startValue Start value of the animation curve
  38178. * @param endValue End value of the animation curve
  38179. * @param gradient Scalar amount to interpolate
  38180. * @returns Interpolated Vector2 value
  38181. */
  38182. vector2InterpolateFunction(startValue: Vector2, endValue: Vector2, gradient: number): Vector2;
  38183. /**
  38184. * Interpolates a Vector2 cubically
  38185. * @param startValue Start value of the animation curve
  38186. * @param outTangent End tangent of the animation
  38187. * @param endValue End value of the animation curve
  38188. * @param inTangent Start tangent of the animation curve
  38189. * @param gradient Scalar amount to interpolate
  38190. * @returns Interpolated Vector2 value
  38191. */
  38192. vector2InterpolateFunctionWithTangents(startValue: Vector2, outTangent: Vector2, endValue: Vector2, inTangent: Vector2, gradient: number): Vector2;
  38193. /**
  38194. * Interpolates a size linearly
  38195. * @param startValue Start value of the animation curve
  38196. * @param endValue End value of the animation curve
  38197. * @param gradient Scalar amount to interpolate
  38198. * @returns Interpolated Size value
  38199. */
  38200. sizeInterpolateFunction(startValue: Size, endValue: Size, gradient: number): Size;
  38201. /**
  38202. * Interpolates a Color3 linearly
  38203. * @param startValue Start value of the animation curve
  38204. * @param endValue End value of the animation curve
  38205. * @param gradient Scalar amount to interpolate
  38206. * @returns Interpolated Color3 value
  38207. */
  38208. color3InterpolateFunction(startValue: Color3, endValue: Color3, gradient: number): Color3;
  38209. /**
  38210. * Interpolates a Color4 linearly
  38211. * @param startValue Start value of the animation curve
  38212. * @param endValue End value of the animation curve
  38213. * @param gradient Scalar amount to interpolate
  38214. * @returns Interpolated Color3 value
  38215. */
  38216. color4InterpolateFunction(startValue: Color4, endValue: Color4, gradient: number): Color4;
  38217. /**
  38218. * @hidden Internal use only
  38219. */
  38220. _getKeyValue(value: any): any;
  38221. /**
  38222. * @hidden Internal use only
  38223. */
  38224. _interpolate(currentFrame: number, state: _IAnimationState): any;
  38225. /**
  38226. * Defines the function to use to interpolate matrices
  38227. * @param startValue defines the start matrix
  38228. * @param endValue defines the end matrix
  38229. * @param gradient defines the gradient between both matrices
  38230. * @param result defines an optional target matrix where to store the interpolation
  38231. * @returns the interpolated matrix
  38232. */
  38233. matrixInterpolateFunction(startValue: Matrix, endValue: Matrix, gradient: number, result?: Matrix): Matrix;
  38234. /**
  38235. * Makes a copy of the animation
  38236. * @returns Cloned animation
  38237. */
  38238. clone(): Animation;
  38239. /**
  38240. * Sets the key frames of the animation
  38241. * @param values The animation key frames to set
  38242. */
  38243. setKeys(values: Array<IAnimationKey>): void;
  38244. /**
  38245. * Serializes the animation to an object
  38246. * @returns Serialized object
  38247. */
  38248. serialize(): any;
  38249. /**
  38250. * Float animation type
  38251. */
  38252. static readonly ANIMATIONTYPE_FLOAT: number;
  38253. /**
  38254. * Vector3 animation type
  38255. */
  38256. static readonly ANIMATIONTYPE_VECTOR3: number;
  38257. /**
  38258. * Quaternion animation type
  38259. */
  38260. static readonly ANIMATIONTYPE_QUATERNION: number;
  38261. /**
  38262. * Matrix animation type
  38263. */
  38264. static readonly ANIMATIONTYPE_MATRIX: number;
  38265. /**
  38266. * Color3 animation type
  38267. */
  38268. static readonly ANIMATIONTYPE_COLOR3: number;
  38269. /**
  38270. * Color3 animation type
  38271. */
  38272. static readonly ANIMATIONTYPE_COLOR4: number;
  38273. /**
  38274. * Vector2 animation type
  38275. */
  38276. static readonly ANIMATIONTYPE_VECTOR2: number;
  38277. /**
  38278. * Size animation type
  38279. */
  38280. static readonly ANIMATIONTYPE_SIZE: number;
  38281. /**
  38282. * Relative Loop Mode
  38283. */
  38284. static readonly ANIMATIONLOOPMODE_RELATIVE: number;
  38285. /**
  38286. * Cycle Loop Mode
  38287. */
  38288. static readonly ANIMATIONLOOPMODE_CYCLE: number;
  38289. /**
  38290. * Constant Loop Mode
  38291. */
  38292. static readonly ANIMATIONLOOPMODE_CONSTANT: number;
  38293. /** @hidden */
  38294. static _UniversalLerp(left: any, right: any, amount: number): any;
  38295. /**
  38296. * Parses an animation object and creates an animation
  38297. * @param parsedAnimation Parsed animation object
  38298. * @returns Animation object
  38299. */
  38300. static Parse(parsedAnimation: any): Animation;
  38301. /**
  38302. * Appends the serialized animations from the source animations
  38303. * @param source Source containing the animations
  38304. * @param destination Target to store the animations
  38305. */
  38306. static AppendSerializedAnimations(source: IAnimatable, destination: any): void;
  38307. /**
  38308. * Creates a new animation or an array of animations from a snippet saved in a remote file
  38309. * @param name defines the name of the animation to create (can be null or empty to use the one from the json data)
  38310. * @param url defines the url to load from
  38311. * @returns a promise that will resolve to the new animation or an array of animations
  38312. */
  38313. static ParseFromFileAsync(name: Nullable<string>, url: string): Promise<Animation | Array<Animation>>;
  38314. /**
  38315. * Creates an animation or an array of animations from a snippet saved by the Inspector
  38316. * @param snippetId defines the snippet to load
  38317. * @returns a promise that will resolve to the new animation or a new array of animations
  38318. */
  38319. static CreateFromSnippetAsync(snippetId: string): Promise<Animation | Array<Animation>>;
  38320. }
  38321. }
  38322. declare module "babylonjs/Animations/animatable.interface" {
  38323. import { Nullable } from "babylonjs/types";
  38324. import { Animation } from "babylonjs/Animations/animation";
  38325. /**
  38326. * Interface containing an array of animations
  38327. */
  38328. export interface IAnimatable {
  38329. /**
  38330. * Array of animations
  38331. */
  38332. animations: Nullable<Array<Animation>>;
  38333. }
  38334. }
  38335. declare module "babylonjs/Misc/decorators" {
  38336. import { Nullable } from "babylonjs/types";
  38337. import { IAnimatable } from "babylonjs/Animations/animatable.interface";
  38338. import { Scene } from "babylonjs/scene";
  38339. import { ImageProcessingConfiguration } from "babylonjs/Materials/imageProcessingConfiguration";
  38340. import { FresnelParameters } from "babylonjs/Materials/fresnelParameters";
  38341. import { ColorCurves } from "babylonjs/Materials/colorCurves";
  38342. import { BaseTexture } from "babylonjs/Materials/Textures/baseTexture";
  38343. export function expandToProperty(callback: string, targetKey?: Nullable<string>): (target: any, propertyKey: string) => void;
  38344. export function serialize(sourceName?: string): (target: any, propertyKey: string | symbol) => void;
  38345. export function serializeAsTexture(sourceName?: string): (target: any, propertyKey: string | symbol) => void;
  38346. export function serializeAsColor3(sourceName?: string): (target: any, propertyKey: string | symbol) => void;
  38347. export function serializeAsFresnelParameters(sourceName?: string): (target: any, propertyKey: string | symbol) => void;
  38348. export function serializeAsVector2(sourceName?: string): (target: any, propertyKey: string | symbol) => void;
  38349. export function serializeAsVector3(sourceName?: string): (target: any, propertyKey: string | symbol) => void;
  38350. export function serializeAsMeshReference(sourceName?: string): (target: any, propertyKey: string | symbol) => void;
  38351. export function serializeAsColorCurves(sourceName?: string): (target: any, propertyKey: string | symbol) => void;
  38352. export function serializeAsColor4(sourceName?: string): (target: any, propertyKey: string | symbol) => void;
  38353. export function serializeAsImageProcessingConfiguration(sourceName?: string): (target: any, propertyKey: string | symbol) => void;
  38354. export function serializeAsQuaternion(sourceName?: string): (target: any, propertyKey: string | symbol) => void;
  38355. export function serializeAsMatrix(sourceName?: string): (target: any, propertyKey: string | symbol) => void;
  38356. /**
  38357. * Decorator used to define property that can be serialized as reference to a camera
  38358. * @param sourceName defines the name of the property to decorate
  38359. */
  38360. export function serializeAsCameraReference(sourceName?: string): (target: any, propertyKey: string | symbol) => void;
  38361. /**
  38362. * Class used to help serialization objects
  38363. */
  38364. export class SerializationHelper {
  38365. /** @hidden */
  38366. static _ImageProcessingConfigurationParser: (sourceProperty: any) => ImageProcessingConfiguration;
  38367. /** @hidden */
  38368. static _FresnelParametersParser: (sourceProperty: any) => FresnelParameters;
  38369. /** @hidden */
  38370. static _ColorCurvesParser: (sourceProperty: any) => ColorCurves;
  38371. /** @hidden */
  38372. static _TextureParser: (sourceProperty: any, scene: Scene, rootUrl: string) => Nullable<BaseTexture>;
  38373. /**
  38374. * Appends the serialized animations from the source animations
  38375. * @param source Source containing the animations
  38376. * @param destination Target to store the animations
  38377. */
  38378. static AppendSerializedAnimations(source: IAnimatable, destination: any): void;
  38379. /**
  38380. * Static function used to serialized a specific entity
  38381. * @param entity defines the entity to serialize
  38382. * @param serializationObject defines the optional target obecjt where serialization data will be stored
  38383. * @returns a JSON compatible object representing the serialization of the entity
  38384. */
  38385. static Serialize<T>(entity: T, serializationObject?: any): any;
  38386. /**
  38387. * Creates a new entity from a serialization data object
  38388. * @param creationFunction defines a function used to instanciated the new entity
  38389. * @param source defines the source serialization data
  38390. * @param scene defines the hosting scene
  38391. * @param rootUrl defines the root url for resources
  38392. * @returns a new entity
  38393. */
  38394. static Parse<T>(creationFunction: () => T, source: any, scene: Nullable<Scene>, rootUrl?: Nullable<string>): T;
  38395. /**
  38396. * Clones an object
  38397. * @param creationFunction defines the function used to instanciate the new object
  38398. * @param source defines the source object
  38399. * @returns the cloned object
  38400. */
  38401. static Clone<T>(creationFunction: () => T, source: T): T;
  38402. /**
  38403. * Instanciates a new object based on a source one (some data will be shared between both object)
  38404. * @param creationFunction defines the function used to instanciate the new object
  38405. * @param source defines the source object
  38406. * @returns the new object
  38407. */
  38408. static Instanciate<T>(creationFunction: () => T, source: T): T;
  38409. }
  38410. }
  38411. declare module "babylonjs/Materials/Textures/baseTexture" {
  38412. import { Observable } from "babylonjs/Misc/observable";
  38413. import { Nullable } from "babylonjs/types";
  38414. import { Scene } from "babylonjs/scene";
  38415. import { Matrix } from "babylonjs/Maths/math.vector";
  38416. import { InternalTexture } from "babylonjs/Materials/Textures/internalTexture";
  38417. import { IAnimatable } from "babylonjs/Animations/animatable.interface";
  38418. import { ISize } from "babylonjs/Maths/math.size";
  38419. import "babylonjs/Misc/fileTools";
  38420. import { ThinEngine } from "babylonjs/Engines/thinEngine";
  38421. /**
  38422. * Base class of all the textures in babylon.
  38423. * It groups all the common properties the materials, post process, lights... might need
  38424. * in order to make a correct use of the texture.
  38425. */
  38426. export class BaseTexture implements IAnimatable {
  38427. /**
  38428. * Default anisotropic filtering level for the application.
  38429. * It is set to 4 as a good tradeoff between perf and quality.
  38430. */
  38431. static DEFAULT_ANISOTROPIC_FILTERING_LEVEL: number;
  38432. /**
  38433. * Gets or sets the unique id of the texture
  38434. */
  38435. uniqueId: number;
  38436. /**
  38437. * Define the name of the texture.
  38438. */
  38439. name: string;
  38440. /**
  38441. * Gets or sets an object used to store user defined information.
  38442. */
  38443. metadata: any;
  38444. /**
  38445. * For internal use only. Please do not use.
  38446. */
  38447. reservedDataStore: any;
  38448. private _hasAlpha;
  38449. /**
  38450. * Define if the texture is having a usable alpha value (can be use for transparency or glossiness for instance).
  38451. */
  38452. set hasAlpha(value: boolean);
  38453. get hasAlpha(): boolean;
  38454. /**
  38455. * Defines if the alpha value should be determined via the rgb values.
  38456. * If true the luminance of the pixel might be used to find the corresponding alpha value.
  38457. */
  38458. getAlphaFromRGB: boolean;
  38459. /**
  38460. * Intensity or strength of the texture.
  38461. * It is commonly used by materials to fine tune the intensity of the texture
  38462. */
  38463. level: number;
  38464. /**
  38465. * Define the UV chanel to use starting from 0 and defaulting to 0.
  38466. * This is part of the texture as textures usually maps to one uv set.
  38467. */
  38468. coordinatesIndex: number;
  38469. protected _coordinatesMode: number;
  38470. /**
  38471. * How a texture is mapped.
  38472. *
  38473. * | Value | Type | Description |
  38474. * | ----- | ----------------------------------- | ----------- |
  38475. * | 0 | EXPLICIT_MODE | |
  38476. * | 1 | SPHERICAL_MODE | |
  38477. * | 2 | PLANAR_MODE | |
  38478. * | 3 | CUBIC_MODE | |
  38479. * | 4 | PROJECTION_MODE | |
  38480. * | 5 | SKYBOX_MODE | |
  38481. * | 6 | INVCUBIC_MODE | |
  38482. * | 7 | EQUIRECTANGULAR_MODE | |
  38483. * | 8 | FIXED_EQUIRECTANGULAR_MODE | |
  38484. * | 9 | FIXED_EQUIRECTANGULAR_MIRRORED_MODE | |
  38485. */
  38486. set coordinatesMode(value: number);
  38487. get coordinatesMode(): number;
  38488. private _wrapU;
  38489. /**
  38490. * | Value | Type | Description |
  38491. * | ----- | ------------------ | ----------- |
  38492. * | 0 | CLAMP_ADDRESSMODE | |
  38493. * | 1 | WRAP_ADDRESSMODE | |
  38494. * | 2 | MIRROR_ADDRESSMODE | |
  38495. */
  38496. get wrapU(): number;
  38497. set wrapU(value: number);
  38498. private _wrapV;
  38499. /**
  38500. * | Value | Type | Description |
  38501. * | ----- | ------------------ | ----------- |
  38502. * | 0 | CLAMP_ADDRESSMODE | |
  38503. * | 1 | WRAP_ADDRESSMODE | |
  38504. * | 2 | MIRROR_ADDRESSMODE | |
  38505. */
  38506. get wrapV(): number;
  38507. set wrapV(value: number);
  38508. /**
  38509. * | Value | Type | Description |
  38510. * | ----- | ------------------ | ----------- |
  38511. * | 0 | CLAMP_ADDRESSMODE | |
  38512. * | 1 | WRAP_ADDRESSMODE | |
  38513. * | 2 | MIRROR_ADDRESSMODE | |
  38514. */
  38515. wrapR: number;
  38516. /**
  38517. * With compliant hardware and browser (supporting anisotropic filtering)
  38518. * this defines the level of anisotropic filtering in the texture.
  38519. * The higher the better but the slower. This defaults to 4 as it seems to be the best tradeoff.
  38520. */
  38521. anisotropicFilteringLevel: number;
  38522. /**
  38523. * Define if the texture is a cube texture or if false a 2d texture.
  38524. */
  38525. get isCube(): boolean;
  38526. set isCube(value: boolean);
  38527. /**
  38528. * Define if the texture is a 3d texture (webgl 2) or if false a 2d texture.
  38529. */
  38530. get is3D(): boolean;
  38531. set is3D(value: boolean);
  38532. /**
  38533. * Define if the texture is a 2d array texture (webgl 2) or if false a 2d texture.
  38534. */
  38535. get is2DArray(): boolean;
  38536. set is2DArray(value: boolean);
  38537. private _gammaSpace;
  38538. /**
  38539. * Define if the texture contains data in gamma space (most of the png/jpg aside bump).
  38540. * HDR texture are usually stored in linear space.
  38541. * This only impacts the PBR and Background materials
  38542. */
  38543. get gammaSpace(): boolean;
  38544. set gammaSpace(gamma: boolean);
  38545. /**
  38546. * Gets or sets whether or not the texture contains RGBD data.
  38547. */
  38548. get isRGBD(): boolean;
  38549. set isRGBD(value: boolean);
  38550. /**
  38551. * Is Z inverted in the texture (useful in a cube texture).
  38552. */
  38553. invertZ: boolean;
  38554. /**
  38555. * Are mip maps generated for this texture or not.
  38556. */
  38557. get noMipmap(): boolean;
  38558. /**
  38559. * @hidden
  38560. */
  38561. lodLevelInAlpha: boolean;
  38562. /**
  38563. * With prefiltered texture, defined the offset used during the prefiltering steps.
  38564. */
  38565. get lodGenerationOffset(): number;
  38566. set lodGenerationOffset(value: number);
  38567. /**
  38568. * With prefiltered texture, defined the scale used during the prefiltering steps.
  38569. */
  38570. get lodGenerationScale(): number;
  38571. set lodGenerationScale(value: number);
  38572. /**
  38573. * With prefiltered texture, defined if the specular generation is based on a linear ramp.
  38574. * By default we are using a log2 of the linear roughness helping to keep a better resolution for
  38575. * average roughness values.
  38576. */
  38577. get linearSpecularLOD(): boolean;
  38578. set linearSpecularLOD(value: boolean);
  38579. /**
  38580. * In case a better definition than spherical harmonics is required for the diffuse part of the environment.
  38581. * You can set the irradiance texture to rely on a texture instead of the spherical approach.
  38582. * This texture need to have the same characteristics than its parent (Cube vs 2d, coordinates mode, Gamma/Linear, RGBD).
  38583. */
  38584. get irradianceTexture(): Nullable<BaseTexture>;
  38585. set irradianceTexture(value: Nullable<BaseTexture>);
  38586. /**
  38587. * Define if the texture is a render target.
  38588. */
  38589. isRenderTarget: boolean;
  38590. /**
  38591. * Define the unique id of the texture in the scene.
  38592. */
  38593. get uid(): string;
  38594. /** @hidden */
  38595. _prefiltered: boolean;
  38596. /**
  38597. * Return a string representation of the texture.
  38598. * @returns the texture as a string
  38599. */
  38600. toString(): string;
  38601. /**
  38602. * Get the class name of the texture.
  38603. * @returns "BaseTexture"
  38604. */
  38605. getClassName(): string;
  38606. /**
  38607. * Define the list of animation attached to the texture.
  38608. */
  38609. animations: import("babylonjs/Animations/animation").Animation[];
  38610. /**
  38611. * An event triggered when the texture is disposed.
  38612. */
  38613. onDisposeObservable: Observable<BaseTexture>;
  38614. private _onDisposeObserver;
  38615. /**
  38616. * Callback triggered when the texture has been disposed.
  38617. * Kept for back compatibility, you can use the onDisposeObservable instead.
  38618. */
  38619. set onDispose(callback: () => void);
  38620. /**
  38621. * Define the current state of the loading sequence when in delayed load mode.
  38622. */
  38623. delayLoadState: number;
  38624. protected _scene: Nullable<Scene>;
  38625. protected _engine: Nullable<ThinEngine>;
  38626. /** @hidden */
  38627. _texture: Nullable<InternalTexture>;
  38628. private _uid;
  38629. /**
  38630. * Define if the texture is preventinga material to render or not.
  38631. * If not and the texture is not ready, the engine will use a default black texture instead.
  38632. */
  38633. get isBlocking(): boolean;
  38634. /**
  38635. * Instantiates a new BaseTexture.
  38636. * Base class of all the textures in babylon.
  38637. * It groups all the common properties the materials, post process, lights... might need
  38638. * in order to make a correct use of the texture.
  38639. * @param sceneOrEngine Define the scene or engine the texture blongs to
  38640. */
  38641. constructor(sceneOrEngine: Nullable<Scene | ThinEngine>);
  38642. /**
  38643. * Get the scene the texture belongs to.
  38644. * @returns the scene or null if undefined
  38645. */
  38646. getScene(): Nullable<Scene>;
  38647. /** @hidden */
  38648. protected _getEngine(): Nullable<ThinEngine>;
  38649. /**
  38650. * Checks if the texture has the same transform matrix than another texture
  38651. * @param texture texture to check against
  38652. * @returns true if the transforms are the same, else false
  38653. */
  38654. checkTransformsAreIdentical(texture: Nullable<BaseTexture>): boolean;
  38655. /**
  38656. * Get the texture transform matrix used to offset tile the texture for istance.
  38657. * @returns the transformation matrix
  38658. */
  38659. getTextureMatrix(): Matrix;
  38660. /**
  38661. * Get the texture reflection matrix used to rotate/transform the reflection.
  38662. * @returns the reflection matrix
  38663. */
  38664. getReflectionTextureMatrix(): Matrix;
  38665. /**
  38666. * Get the underlying lower level texture from Babylon.
  38667. * @returns the insternal texture
  38668. */
  38669. getInternalTexture(): Nullable<InternalTexture>;
  38670. /**
  38671. * Get if the texture is ready to be consumed (either it is ready or it is not blocking)
  38672. * @returns true if ready or not blocking
  38673. */
  38674. isReadyOrNotBlocking(): boolean;
  38675. /**
  38676. * Get if the texture is ready to be used (downloaded, converted, mip mapped...).
  38677. * @returns true if fully ready
  38678. */
  38679. isReady(): boolean;
  38680. private _cachedSize;
  38681. /**
  38682. * Get the size of the texture.
  38683. * @returns the texture size.
  38684. */
  38685. getSize(): ISize;
  38686. /**
  38687. * Get the base size of the texture.
  38688. * It can be different from the size if the texture has been resized for POT for instance
  38689. * @returns the base size
  38690. */
  38691. getBaseSize(): ISize;
  38692. /**
  38693. * Update the sampling mode of the texture.
  38694. * Default is Trilinear mode.
  38695. *
  38696. * | Value | Type | Description |
  38697. * | ----- | ------------------ | ----------- |
  38698. * | 1 | NEAREST_SAMPLINGMODE or NEAREST_NEAREST_MIPLINEAR | Nearest is: mag = nearest, min = nearest, mip = linear |
  38699. * | 2 | BILINEAR_SAMPLINGMODE or LINEAR_LINEAR_MIPNEAREST | Bilinear is: mag = linear, min = linear, mip = nearest |
  38700. * | 3 | TRILINEAR_SAMPLINGMODE or LINEAR_LINEAR_MIPLINEAR | Trilinear is: mag = linear, min = linear, mip = linear |
  38701. * | 4 | NEAREST_NEAREST_MIPNEAREST | |
  38702. * | 5 | NEAREST_LINEAR_MIPNEAREST | |
  38703. * | 6 | NEAREST_LINEAR_MIPLINEAR | |
  38704. * | 7 | NEAREST_LINEAR | |
  38705. * | 8 | NEAREST_NEAREST | |
  38706. * | 9 | LINEAR_NEAREST_MIPNEAREST | |
  38707. * | 10 | LINEAR_NEAREST_MIPLINEAR | |
  38708. * | 11 | LINEAR_LINEAR | |
  38709. * | 12 | LINEAR_NEAREST | |
  38710. *
  38711. * > _mag_: magnification filter (close to the viewer)
  38712. * > _min_: minification filter (far from the viewer)
  38713. * > _mip_: filter used between mip map levels
  38714. *@param samplingMode Define the new sampling mode of the texture
  38715. */
  38716. updateSamplingMode(samplingMode: number): void;
  38717. /**
  38718. * Scales the texture if is `canRescale()`
  38719. * @param ratio the resize factor we want to use to rescale
  38720. */
  38721. scale(ratio: number): void;
  38722. /**
  38723. * Get if the texture can rescale.
  38724. */
  38725. get canRescale(): boolean;
  38726. /** @hidden */
  38727. _getFromCache(url: Nullable<string>, noMipmap: boolean, sampling?: number, invertY?: boolean): Nullable<InternalTexture>;
  38728. /** @hidden */
  38729. _rebuild(): void;
  38730. /**
  38731. * Triggers the load sequence in delayed load mode.
  38732. */
  38733. delayLoad(): void;
  38734. /**
  38735. * Clones the texture.
  38736. * @returns the cloned texture
  38737. */
  38738. clone(): Nullable<BaseTexture>;
  38739. /**
  38740. * Get the texture underlying type (INT, FLOAT...)
  38741. */
  38742. get textureType(): number;
  38743. /**
  38744. * Get the texture underlying format (RGB, RGBA...)
  38745. */
  38746. get textureFormat(): number;
  38747. /**
  38748. * Indicates that textures need to be re-calculated for all materials
  38749. */
  38750. protected _markAllSubMeshesAsTexturesDirty(): void;
  38751. /**
  38752. * Reads the pixels stored in the webgl texture and returns them as an ArrayBuffer.
  38753. * This will returns an RGBA array buffer containing either in values (0-255) or
  38754. * float values (0-1) depending of the underlying buffer type.
  38755. * @param faceIndex defines the face of the texture to read (in case of cube texture)
  38756. * @param level defines the LOD level of the texture to read (in case of Mip Maps)
  38757. * @param buffer defines a user defined buffer to fill with data (can be null)
  38758. * @returns The Array buffer containing the pixels data.
  38759. */
  38760. readPixels(faceIndex?: number, level?: number, buffer?: Nullable<ArrayBufferView>): Nullable<ArrayBufferView>;
  38761. /**
  38762. * Release and destroy the underlying lower level texture aka internalTexture.
  38763. */
  38764. releaseInternalTexture(): void;
  38765. /** @hidden */
  38766. get _lodTextureHigh(): Nullable<BaseTexture>;
  38767. /** @hidden */
  38768. get _lodTextureMid(): Nullable<BaseTexture>;
  38769. /** @hidden */
  38770. get _lodTextureLow(): Nullable<BaseTexture>;
  38771. /**
  38772. * Dispose the texture and release its associated resources.
  38773. */
  38774. dispose(): void;
  38775. /**
  38776. * Serialize the texture into a JSON representation that can be parsed later on.
  38777. * @returns the JSON representation of the texture
  38778. */
  38779. serialize(): any;
  38780. /**
  38781. * Helper function to be called back once a list of texture contains only ready textures.
  38782. * @param textures Define the list of textures to wait for
  38783. * @param callback Define the callback triggered once the entire list will be ready
  38784. */
  38785. static WhenAllReady(textures: BaseTexture[], callback: () => void): void;
  38786. private static _isScene;
  38787. }
  38788. }
  38789. declare module "babylonjs/Materials/effect" {
  38790. import { Observable } from "babylonjs/Misc/observable";
  38791. import { Nullable } from "babylonjs/types";
  38792. import { IDisposable } from "babylonjs/scene";
  38793. import { IPipelineContext } from "babylonjs/Engines/IPipelineContext";
  38794. import { DataBuffer } from "babylonjs/Meshes/dataBuffer";
  38795. import { IMatrixLike, IVector2Like, IVector3Like, IVector4Like, IColor3Like, IColor4Like } from "babylonjs/Maths/math.like";
  38796. import { ThinEngine } from "babylonjs/Engines/thinEngine";
  38797. import { IEffectFallbacks } from "babylonjs/Materials/iEffectFallbacks";
  38798. import { Engine } from "babylonjs/Engines/engine";
  38799. import { InternalTexture } from "babylonjs/Materials/Textures/internalTexture";
  38800. import { BaseTexture } from "babylonjs/Materials/Textures/baseTexture";
  38801. import { RenderTargetTexture } from "babylonjs/Materials/Textures/renderTargetTexture";
  38802. import { PostProcess } from "babylonjs/PostProcesses/postProcess";
  38803. /**
  38804. * Options to be used when creating an effect.
  38805. */
  38806. export interface IEffectCreationOptions {
  38807. /**
  38808. * Atrributes that will be used in the shader.
  38809. */
  38810. attributes: string[];
  38811. /**
  38812. * Uniform varible names that will be set in the shader.
  38813. */
  38814. uniformsNames: string[];
  38815. /**
  38816. * Uniform buffer variable names that will be set in the shader.
  38817. */
  38818. uniformBuffersNames: string[];
  38819. /**
  38820. * Sampler texture variable names that will be set in the shader.
  38821. */
  38822. samplers: string[];
  38823. /**
  38824. * Define statements that will be set in the shader.
  38825. */
  38826. defines: any;
  38827. /**
  38828. * Possible fallbacks for this effect to improve performance when needed.
  38829. */
  38830. fallbacks: Nullable<IEffectFallbacks>;
  38831. /**
  38832. * Callback that will be called when the shader is compiled.
  38833. */
  38834. onCompiled: Nullable<(effect: Effect) => void>;
  38835. /**
  38836. * Callback that will be called if an error occurs during shader compilation.
  38837. */
  38838. onError: Nullable<(effect: Effect, errors: string) => void>;
  38839. /**
  38840. * Parameters to be used with Babylons include syntax to iterate over an array (eg. {lights: 10})
  38841. */
  38842. indexParameters?: any;
  38843. /**
  38844. * Max number of lights that can be used in the shader.
  38845. */
  38846. maxSimultaneousLights?: number;
  38847. /**
  38848. * See https://developer.mozilla.org/en-US/docs/Web/API/WebGL2RenderingContext/transformFeedbackVaryings
  38849. */
  38850. transformFeedbackVaryings?: Nullable<string[]>;
  38851. /**
  38852. * 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
  38853. */
  38854. processFinalCode?: Nullable<(shaderType: string, code: string) => string>;
  38855. /**
  38856. * Is this effect rendering to several color attachments ?
  38857. */
  38858. multiTarget?: boolean;
  38859. }
  38860. /**
  38861. * Effect containing vertex and fragment shader that can be executed on an object.
  38862. */
  38863. export class Effect implements IDisposable {
  38864. /**
  38865. * Gets or sets the relative url used to load shaders if using the engine in non-minified mode
  38866. */
  38867. static ShadersRepository: string;
  38868. /**
  38869. * Enable logging of the shader code when a compilation error occurs
  38870. */
  38871. static LogShaderCodeOnCompilationError: boolean;
  38872. /**
  38873. * Name of the effect.
  38874. */
  38875. name: any;
  38876. /**
  38877. * String container all the define statements that should be set on the shader.
  38878. */
  38879. defines: string;
  38880. /**
  38881. * Callback that will be called when the shader is compiled.
  38882. */
  38883. onCompiled: Nullable<(effect: Effect) => void>;
  38884. /**
  38885. * Callback that will be called if an error occurs during shader compilation.
  38886. */
  38887. onError: Nullable<(effect: Effect, errors: string) => void>;
  38888. /**
  38889. * Callback that will be called when effect is bound.
  38890. */
  38891. onBind: Nullable<(effect: Effect) => void>;
  38892. /**
  38893. * Unique ID of the effect.
  38894. */
  38895. uniqueId: number;
  38896. /**
  38897. * Observable that will be called when the shader is compiled.
  38898. * It is recommended to use executeWhenCompile() or to make sure that scene.isReady() is called to get this observable raised.
  38899. */
  38900. onCompileObservable: Observable<Effect>;
  38901. /**
  38902. * Observable that will be called if an error occurs during shader compilation.
  38903. */
  38904. onErrorObservable: Observable<Effect>;
  38905. /** @hidden */
  38906. _onBindObservable: Nullable<Observable<Effect>>;
  38907. /**
  38908. * @hidden
  38909. * Specifies if the effect was previously ready
  38910. */
  38911. _wasPreviouslyReady: boolean;
  38912. /**
  38913. * Observable that will be called when effect is bound.
  38914. */
  38915. get onBindObservable(): Observable<Effect>;
  38916. /** @hidden */
  38917. _bonesComputationForcedToCPU: boolean;
  38918. /** @hidden */
  38919. _multiTarget: boolean;
  38920. private static _uniqueIdSeed;
  38921. private _engine;
  38922. private _uniformBuffersNames;
  38923. private _uniformBuffersNamesList;
  38924. private _uniformsNames;
  38925. private _samplerList;
  38926. private _samplers;
  38927. private _isReady;
  38928. private _compilationError;
  38929. private _allFallbacksProcessed;
  38930. private _attributesNames;
  38931. private _attributes;
  38932. private _attributeLocationByName;
  38933. private _uniforms;
  38934. /**
  38935. * Key for the effect.
  38936. * @hidden
  38937. */
  38938. _key: string;
  38939. private _indexParameters;
  38940. private _fallbacks;
  38941. private _vertexSourceCode;
  38942. private _fragmentSourceCode;
  38943. private _vertexSourceCodeOverride;
  38944. private _fragmentSourceCodeOverride;
  38945. private _transformFeedbackVaryings;
  38946. /**
  38947. * Compiled shader to webGL program.
  38948. * @hidden
  38949. */
  38950. _pipelineContext: Nullable<IPipelineContext>;
  38951. private _valueCache;
  38952. private static _baseCache;
  38953. /**
  38954. * Instantiates an effect.
  38955. * An effect can be used to create/manage/execute vertex and fragment shaders.
  38956. * @param baseName Name of the effect.
  38957. * @param attributesNamesOrOptions List of attribute names that will be passed to the shader or set of all options to create the effect.
  38958. * @param uniformsNamesOrEngine List of uniform variable names that will be passed to the shader or the engine that will be used to render effect.
  38959. * @param samplers List of sampler variables that will be passed to the shader.
  38960. * @param engine Engine to be used to render the effect
  38961. * @param defines Define statements to be added to the shader.
  38962. * @param fallbacks Possible fallbacks for this effect to improve performance when needed.
  38963. * @param onCompiled Callback that will be called when the shader is compiled.
  38964. * @param onError Callback that will be called if an error occurs during shader compilation.
  38965. * @param indexParameters Parameters to be used with Babylons include syntax to iterate over an array (eg. {lights: 10})
  38966. */
  38967. 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);
  38968. private _useFinalCode;
  38969. /**
  38970. * Unique key for this effect
  38971. */
  38972. get key(): string;
  38973. /**
  38974. * If the effect has been compiled and prepared.
  38975. * @returns if the effect is compiled and prepared.
  38976. */
  38977. isReady(): boolean;
  38978. private _isReadyInternal;
  38979. /**
  38980. * The engine the effect was initialized with.
  38981. * @returns the engine.
  38982. */
  38983. getEngine(): Engine;
  38984. /**
  38985. * The pipeline context for this effect
  38986. * @returns the associated pipeline context
  38987. */
  38988. getPipelineContext(): Nullable<IPipelineContext>;
  38989. /**
  38990. * The set of names of attribute variables for the shader.
  38991. * @returns An array of attribute names.
  38992. */
  38993. getAttributesNames(): string[];
  38994. /**
  38995. * Returns the attribute at the given index.
  38996. * @param index The index of the attribute.
  38997. * @returns The location of the attribute.
  38998. */
  38999. getAttributeLocation(index: number): number;
  39000. /**
  39001. * Returns the attribute based on the name of the variable.
  39002. * @param name of the attribute to look up.
  39003. * @returns the attribute location.
  39004. */
  39005. getAttributeLocationByName(name: string): number;
  39006. /**
  39007. * The number of attributes.
  39008. * @returns the numnber of attributes.
  39009. */
  39010. getAttributesCount(): number;
  39011. /**
  39012. * Gets the index of a uniform variable.
  39013. * @param uniformName of the uniform to look up.
  39014. * @returns the index.
  39015. */
  39016. getUniformIndex(uniformName: string): number;
  39017. /**
  39018. * Returns the attribute based on the name of the variable.
  39019. * @param uniformName of the uniform to look up.
  39020. * @returns the location of the uniform.
  39021. */
  39022. getUniform(uniformName: string): Nullable<WebGLUniformLocation>;
  39023. /**
  39024. * Returns an array of sampler variable names
  39025. * @returns The array of sampler variable names.
  39026. */
  39027. getSamplers(): string[];
  39028. /**
  39029. * Returns an array of uniform variable names
  39030. * @returns The array of uniform variable names.
  39031. */
  39032. getUniformNames(): string[];
  39033. /**
  39034. * Returns an array of uniform buffer variable names
  39035. * @returns The array of uniform buffer variable names.
  39036. */
  39037. getUniformBuffersNames(): string[];
  39038. /**
  39039. * Returns the index parameters used to create the effect
  39040. * @returns The index parameters object
  39041. */
  39042. getIndexParameters(): any;
  39043. /**
  39044. * The error from the last compilation.
  39045. * @returns the error string.
  39046. */
  39047. getCompilationError(): string;
  39048. /**
  39049. * Gets a boolean indicating that all fallbacks were used during compilation
  39050. * @returns true if all fallbacks were used
  39051. */
  39052. allFallbacksProcessed(): boolean;
  39053. /**
  39054. * Adds a callback to the onCompiled observable and call the callback imediatly if already ready.
  39055. * @param func The callback to be used.
  39056. */
  39057. executeWhenCompiled(func: (effect: Effect) => void): void;
  39058. private _checkIsReady;
  39059. private _loadShader;
  39060. /**
  39061. * Gets the vertex shader source code of this effect
  39062. */
  39063. get vertexSourceCode(): string;
  39064. /**
  39065. * Gets the fragment shader source code of this effect
  39066. */
  39067. get fragmentSourceCode(): string;
  39068. /**
  39069. * Recompiles the webGL program
  39070. * @param vertexSourceCode The source code for the vertex shader.
  39071. * @param fragmentSourceCode The source code for the fragment shader.
  39072. * @param onCompiled Callback called when completed.
  39073. * @param onError Callback called on error.
  39074. * @hidden
  39075. */
  39076. _rebuildProgram(vertexSourceCode: string, fragmentSourceCode: string, onCompiled: (pipelineContext: IPipelineContext) => void, onError: (message: string) => void): void;
  39077. /**
  39078. * Prepares the effect
  39079. * @hidden
  39080. */
  39081. _prepareEffect(): void;
  39082. private _getShaderCodeAndErrorLine;
  39083. private _processCompilationErrors;
  39084. /**
  39085. * Checks if the effect is supported. (Must be called after compilation)
  39086. */
  39087. get isSupported(): boolean;
  39088. /**
  39089. * Binds a texture to the engine to be used as output of the shader.
  39090. * @param channel Name of the output variable.
  39091. * @param texture Texture to bind.
  39092. * @hidden
  39093. */
  39094. _bindTexture(channel: string, texture: Nullable<InternalTexture>): void;
  39095. /**
  39096. * Sets a texture on the engine to be used in the shader.
  39097. * @param channel Name of the sampler variable.
  39098. * @param texture Texture to set.
  39099. */
  39100. setTexture(channel: string, texture: Nullable<BaseTexture>): void;
  39101. /**
  39102. * Sets a depth stencil texture from a render target on the engine to be used in the shader.
  39103. * @param channel Name of the sampler variable.
  39104. * @param texture Texture to set.
  39105. */
  39106. setDepthStencilTexture(channel: string, texture: Nullable<RenderTargetTexture>): void;
  39107. /**
  39108. * Sets an array of textures on the engine to be used in the shader.
  39109. * @param channel Name of the variable.
  39110. * @param textures Textures to set.
  39111. */
  39112. setTextureArray(channel: string, textures: BaseTexture[]): void;
  39113. /**
  39114. * 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)
  39115. * @param channel Name of the sampler variable.
  39116. * @param postProcess Post process to get the input texture from.
  39117. */
  39118. setTextureFromPostProcess(channel: string, postProcess: Nullable<PostProcess>): void;
  39119. /**
  39120. * (Warning! setTextureFromPostProcessOutput may be desired instead)
  39121. * 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)
  39122. * @param channel Name of the sampler variable.
  39123. * @param postProcess Post process to get the output texture from.
  39124. */
  39125. setTextureFromPostProcessOutput(channel: string, postProcess: Nullable<PostProcess>): void;
  39126. /** @hidden */
  39127. _cacheMatrix(uniformName: string, matrix: IMatrixLike): boolean;
  39128. /** @hidden */
  39129. _cacheFloat2(uniformName: string, x: number, y: number): boolean;
  39130. /** @hidden */
  39131. _cacheFloat3(uniformName: string, x: number, y: number, z: number): boolean;
  39132. /** @hidden */
  39133. _cacheFloat4(uniformName: string, x: number, y: number, z: number, w: number): boolean;
  39134. /**
  39135. * Binds a buffer to a uniform.
  39136. * @param buffer Buffer to bind.
  39137. * @param name Name of the uniform variable to bind to.
  39138. */
  39139. bindUniformBuffer(buffer: DataBuffer, name: string): void;
  39140. /**
  39141. * Binds block to a uniform.
  39142. * @param blockName Name of the block to bind.
  39143. * @param index Index to bind.
  39144. */
  39145. bindUniformBlock(blockName: string, index: number): void;
  39146. /**
  39147. * Sets an interger value on a uniform variable.
  39148. * @param uniformName Name of the variable.
  39149. * @param value Value to be set.
  39150. * @returns this effect.
  39151. */
  39152. setInt(uniformName: string, value: number): Effect;
  39153. /**
  39154. * Sets an int array on a uniform variable.
  39155. * @param uniformName Name of the variable.
  39156. * @param array array to be set.
  39157. * @returns this effect.
  39158. */
  39159. setIntArray(uniformName: string, array: Int32Array): Effect;
  39160. /**
  39161. * 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)
  39162. * @param uniformName Name of the variable.
  39163. * @param array array to be set.
  39164. * @returns this effect.
  39165. */
  39166. setIntArray2(uniformName: string, array: Int32Array): Effect;
  39167. /**
  39168. * 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)
  39169. * @param uniformName Name of the variable.
  39170. * @param array array to be set.
  39171. * @returns this effect.
  39172. */
  39173. setIntArray3(uniformName: string, array: Int32Array): Effect;
  39174. /**
  39175. * 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)
  39176. * @param uniformName Name of the variable.
  39177. * @param array array to be set.
  39178. * @returns this effect.
  39179. */
  39180. setIntArray4(uniformName: string, array: Int32Array): Effect;
  39181. /**
  39182. * Sets an float array on a uniform variable.
  39183. * @param uniformName Name of the variable.
  39184. * @param array array to be set.
  39185. * @returns this effect.
  39186. */
  39187. setFloatArray(uniformName: string, array: Float32Array): Effect;
  39188. /**
  39189. * 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)
  39190. * @param uniformName Name of the variable.
  39191. * @param array array to be set.
  39192. * @returns this effect.
  39193. */
  39194. setFloatArray2(uniformName: string, array: Float32Array): Effect;
  39195. /**
  39196. * 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)
  39197. * @param uniformName Name of the variable.
  39198. * @param array array to be set.
  39199. * @returns this effect.
  39200. */
  39201. setFloatArray3(uniformName: string, array: Float32Array): Effect;
  39202. /**
  39203. * 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)
  39204. * @param uniformName Name of the variable.
  39205. * @param array array to be set.
  39206. * @returns this effect.
  39207. */
  39208. setFloatArray4(uniformName: string, array: Float32Array): Effect;
  39209. /**
  39210. * Sets an array on a uniform variable.
  39211. * @param uniformName Name of the variable.
  39212. * @param array array to be set.
  39213. * @returns this effect.
  39214. */
  39215. setArray(uniformName: string, array: number[]): Effect;
  39216. /**
  39217. * 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)
  39218. * @param uniformName Name of the variable.
  39219. * @param array array to be set.
  39220. * @returns this effect.
  39221. */
  39222. setArray2(uniformName: string, array: number[]): Effect;
  39223. /**
  39224. * 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)
  39225. * @param uniformName Name of the variable.
  39226. * @param array array to be set.
  39227. * @returns this effect.
  39228. */
  39229. setArray3(uniformName: string, array: number[]): Effect;
  39230. /**
  39231. * 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)
  39232. * @param uniformName Name of the variable.
  39233. * @param array array to be set.
  39234. * @returns this effect.
  39235. */
  39236. setArray4(uniformName: string, array: number[]): Effect;
  39237. /**
  39238. * Sets matrices on a uniform variable.
  39239. * @param uniformName Name of the variable.
  39240. * @param matrices matrices to be set.
  39241. * @returns this effect.
  39242. */
  39243. setMatrices(uniformName: string, matrices: Float32Array | Array<number>): Effect;
  39244. /**
  39245. * Sets matrix on a uniform variable.
  39246. * @param uniformName Name of the variable.
  39247. * @param matrix matrix to be set.
  39248. * @returns this effect.
  39249. */
  39250. setMatrix(uniformName: string, matrix: IMatrixLike): Effect;
  39251. /**
  39252. * 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)
  39253. * @param uniformName Name of the variable.
  39254. * @param matrix matrix to be set.
  39255. * @returns this effect.
  39256. */
  39257. setMatrix3x3(uniformName: string, matrix: Float32Array | Array<number>): Effect;
  39258. /**
  39259. * Sets a 2x2 matrix on a uniform variable. (Speicified as [1,2,3,4] will result in [1,2][3,4] matrix)
  39260. * @param uniformName Name of the variable.
  39261. * @param matrix matrix to be set.
  39262. * @returns this effect.
  39263. */
  39264. setMatrix2x2(uniformName: string, matrix: Float32Array | Array<number>): Effect;
  39265. /**
  39266. * Sets a float on a uniform variable.
  39267. * @param uniformName Name of the variable.
  39268. * @param value value to be set.
  39269. * @returns this effect.
  39270. */
  39271. setFloat(uniformName: string, value: number): Effect;
  39272. /**
  39273. * Sets a boolean on a uniform variable.
  39274. * @param uniformName Name of the variable.
  39275. * @param bool value to be set.
  39276. * @returns this effect.
  39277. */
  39278. setBool(uniformName: string, bool: boolean): Effect;
  39279. /**
  39280. * Sets a Vector2 on a uniform variable.
  39281. * @param uniformName Name of the variable.
  39282. * @param vector2 vector2 to be set.
  39283. * @returns this effect.
  39284. */
  39285. setVector2(uniformName: string, vector2: IVector2Like): Effect;
  39286. /**
  39287. * Sets a float2 on a uniform variable.
  39288. * @param uniformName Name of the variable.
  39289. * @param x First float in float2.
  39290. * @param y Second float in float2.
  39291. * @returns this effect.
  39292. */
  39293. setFloat2(uniformName: string, x: number, y: number): Effect;
  39294. /**
  39295. * Sets a Vector3 on a uniform variable.
  39296. * @param uniformName Name of the variable.
  39297. * @param vector3 Value to be set.
  39298. * @returns this effect.
  39299. */
  39300. setVector3(uniformName: string, vector3: IVector3Like): Effect;
  39301. /**
  39302. * Sets a float3 on a uniform variable.
  39303. * @param uniformName Name of the variable.
  39304. * @param x First float in float3.
  39305. * @param y Second float in float3.
  39306. * @param z Third float in float3.
  39307. * @returns this effect.
  39308. */
  39309. setFloat3(uniformName: string, x: number, y: number, z: number): Effect;
  39310. /**
  39311. * Sets a Vector4 on a uniform variable.
  39312. * @param uniformName Name of the variable.
  39313. * @param vector4 Value to be set.
  39314. * @returns this effect.
  39315. */
  39316. setVector4(uniformName: string, vector4: IVector4Like): Effect;
  39317. /**
  39318. * Sets a float4 on a uniform variable.
  39319. * @param uniformName Name of the variable.
  39320. * @param x First float in float4.
  39321. * @param y Second float in float4.
  39322. * @param z Third float in float4.
  39323. * @param w Fourth float in float4.
  39324. * @returns this effect.
  39325. */
  39326. setFloat4(uniformName: string, x: number, y: number, z: number, w: number): Effect;
  39327. /**
  39328. * Sets a Color3 on a uniform variable.
  39329. * @param uniformName Name of the variable.
  39330. * @param color3 Value to be set.
  39331. * @returns this effect.
  39332. */
  39333. setColor3(uniformName: string, color3: IColor3Like): Effect;
  39334. /**
  39335. * Sets a Color4 on a uniform variable.
  39336. * @param uniformName Name of the variable.
  39337. * @param color3 Value to be set.
  39338. * @param alpha Alpha value to be set.
  39339. * @returns this effect.
  39340. */
  39341. setColor4(uniformName: string, color3: IColor3Like, alpha: number): Effect;
  39342. /**
  39343. * Sets a Color4 on a uniform variable
  39344. * @param uniformName defines the name of the variable
  39345. * @param color4 defines the value to be set
  39346. * @returns this effect.
  39347. */
  39348. setDirectColor4(uniformName: string, color4: IColor4Like): Effect;
  39349. /** Release all associated resources */
  39350. dispose(): void;
  39351. /**
  39352. * This function will add a new shader to the shader store
  39353. * @param name the name of the shader
  39354. * @param pixelShader optional pixel shader content
  39355. * @param vertexShader optional vertex shader content
  39356. */
  39357. static RegisterShader(name: string, pixelShader?: string, vertexShader?: string): void;
  39358. /**
  39359. * Store of each shader (The can be looked up using effect.key)
  39360. */
  39361. static ShadersStore: {
  39362. [key: string]: string;
  39363. };
  39364. /**
  39365. * Store of each included file for a shader (The can be looked up using effect.key)
  39366. */
  39367. static IncludesShadersStore: {
  39368. [key: string]: string;
  39369. };
  39370. /**
  39371. * Resets the cache of effects.
  39372. */
  39373. static ResetCache(): void;
  39374. }
  39375. }
  39376. declare module "babylonjs/Engines/engineCapabilities" {
  39377. /**
  39378. * Interface used to describe the capabilities of the engine relatively to the current browser
  39379. */
  39380. export interface EngineCapabilities {
  39381. /** Maximum textures units per fragment shader */
  39382. maxTexturesImageUnits: number;
  39383. /** Maximum texture units per vertex shader */
  39384. maxVertexTextureImageUnits: number;
  39385. /** Maximum textures units in the entire pipeline */
  39386. maxCombinedTexturesImageUnits: number;
  39387. /** Maximum texture size */
  39388. maxTextureSize: number;
  39389. /** Maximum texture samples */
  39390. maxSamples?: number;
  39391. /** Maximum cube texture size */
  39392. maxCubemapTextureSize: number;
  39393. /** Maximum render texture size */
  39394. maxRenderTextureSize: number;
  39395. /** Maximum number of vertex attributes */
  39396. maxVertexAttribs: number;
  39397. /** Maximum number of varyings */
  39398. maxVaryingVectors: number;
  39399. /** Maximum number of uniforms per vertex shader */
  39400. maxVertexUniformVectors: number;
  39401. /** Maximum number of uniforms per fragment shader */
  39402. maxFragmentUniformVectors: number;
  39403. /** Defines if standard derivates (dx/dy) are supported */
  39404. standardDerivatives: boolean;
  39405. /** Defines if s3tc texture compression is supported */
  39406. s3tc?: WEBGL_compressed_texture_s3tc;
  39407. /** Defines if pvrtc texture compression is supported */
  39408. pvrtc: any;
  39409. /** Defines if etc1 texture compression is supported */
  39410. etc1: any;
  39411. /** Defines if etc2 texture compression is supported */
  39412. etc2: any;
  39413. /** Defines if astc texture compression is supported */
  39414. astc: any;
  39415. /** Defines if bptc texture compression is supported */
  39416. bptc: any;
  39417. /** Defines if float textures are supported */
  39418. textureFloat: boolean;
  39419. /** Defines if vertex array objects are supported */
  39420. vertexArrayObject: boolean;
  39421. /** Gets the webgl extension for anisotropic filtering (null if not supported) */
  39422. textureAnisotropicFilterExtension?: EXT_texture_filter_anisotropic;
  39423. /** Gets the maximum level of anisotropy supported */
  39424. maxAnisotropy: number;
  39425. /** Defines if instancing is supported */
  39426. instancedArrays: boolean;
  39427. /** Defines if 32 bits indices are supported */
  39428. uintIndices: boolean;
  39429. /** Defines if high precision shaders are supported */
  39430. highPrecisionShaderSupported: boolean;
  39431. /** Defines if depth reading in the fragment shader is supported */
  39432. fragmentDepthSupported: boolean;
  39433. /** Defines if float texture linear filtering is supported*/
  39434. textureFloatLinearFiltering: boolean;
  39435. /** Defines if rendering to float textures is supported */
  39436. textureFloatRender: boolean;
  39437. /** Defines if half float textures are supported*/
  39438. textureHalfFloat: boolean;
  39439. /** Defines if half float texture linear filtering is supported*/
  39440. textureHalfFloatLinearFiltering: boolean;
  39441. /** Defines if rendering to half float textures is supported */
  39442. textureHalfFloatRender: boolean;
  39443. /** Defines if textureLOD shader command is supported */
  39444. textureLOD: boolean;
  39445. /** Defines if draw buffers extension is supported */
  39446. drawBuffersExtension: boolean;
  39447. /** Defines if depth textures are supported */
  39448. depthTextureExtension: boolean;
  39449. /** Defines if float color buffer are supported */
  39450. colorBufferFloat: boolean;
  39451. /** Gets disjoint timer query extension (null if not supported) */
  39452. timerQuery?: EXT_disjoint_timer_query;
  39453. /** Defines if timestamp can be used with timer query */
  39454. canUseTimestampForTimerQuery: boolean;
  39455. /** Defines if multiview is supported (https://www.khronos.org/registry/webgl/extensions/WEBGL_multiview/) */
  39456. multiview?: any;
  39457. /** Defines if oculus multiview is supported (https://developer.oculus.com/documentation/oculus-browser/latest/concepts/browser-multiview/) */
  39458. oculusMultiview?: any;
  39459. /** Function used to let the system compiles shaders in background */
  39460. parallelShaderCompile?: {
  39461. COMPLETION_STATUS_KHR: number;
  39462. };
  39463. /** Max number of texture samples for MSAA */
  39464. maxMSAASamples: number;
  39465. /** Defines if the blend min max extension is supported */
  39466. blendMinMax: boolean;
  39467. }
  39468. }
  39469. declare module "babylonjs/States/depthCullingState" {
  39470. import { Nullable } from "babylonjs/types";
  39471. /**
  39472. * @hidden
  39473. **/
  39474. export class DepthCullingState {
  39475. private _isDepthTestDirty;
  39476. private _isDepthMaskDirty;
  39477. private _isDepthFuncDirty;
  39478. private _isCullFaceDirty;
  39479. private _isCullDirty;
  39480. private _isZOffsetDirty;
  39481. private _isFrontFaceDirty;
  39482. private _depthTest;
  39483. private _depthMask;
  39484. private _depthFunc;
  39485. private _cull;
  39486. private _cullFace;
  39487. private _zOffset;
  39488. private _frontFace;
  39489. /**
  39490. * Initializes the state.
  39491. */
  39492. constructor();
  39493. get isDirty(): boolean;
  39494. get zOffset(): number;
  39495. set zOffset(value: number);
  39496. get cullFace(): Nullable<number>;
  39497. set cullFace(value: Nullable<number>);
  39498. get cull(): Nullable<boolean>;
  39499. set cull(value: Nullable<boolean>);
  39500. get depthFunc(): Nullable<number>;
  39501. set depthFunc(value: Nullable<number>);
  39502. get depthMask(): boolean;
  39503. set depthMask(value: boolean);
  39504. get depthTest(): boolean;
  39505. set depthTest(value: boolean);
  39506. get frontFace(): Nullable<number>;
  39507. set frontFace(value: Nullable<number>);
  39508. reset(): void;
  39509. apply(gl: WebGLRenderingContext): void;
  39510. }
  39511. }
  39512. declare module "babylonjs/States/stencilState" {
  39513. /**
  39514. * @hidden
  39515. **/
  39516. export class StencilState {
  39517. /** 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 */
  39518. static readonly ALWAYS: number;
  39519. /** Passed to stencilOperation to specify that stencil value must be kept */
  39520. static readonly KEEP: number;
  39521. /** Passed to stencilOperation to specify that stencil value must be replaced */
  39522. static readonly REPLACE: number;
  39523. private _isStencilTestDirty;
  39524. private _isStencilMaskDirty;
  39525. private _isStencilFuncDirty;
  39526. private _isStencilOpDirty;
  39527. private _stencilTest;
  39528. private _stencilMask;
  39529. private _stencilFunc;
  39530. private _stencilFuncRef;
  39531. private _stencilFuncMask;
  39532. private _stencilOpStencilFail;
  39533. private _stencilOpDepthFail;
  39534. private _stencilOpStencilDepthPass;
  39535. get isDirty(): boolean;
  39536. get stencilFunc(): number;
  39537. set stencilFunc(value: number);
  39538. get stencilFuncRef(): number;
  39539. set stencilFuncRef(value: number);
  39540. get stencilFuncMask(): number;
  39541. set stencilFuncMask(value: number);
  39542. get stencilOpStencilFail(): number;
  39543. set stencilOpStencilFail(value: number);
  39544. get stencilOpDepthFail(): number;
  39545. set stencilOpDepthFail(value: number);
  39546. get stencilOpStencilDepthPass(): number;
  39547. set stencilOpStencilDepthPass(value: number);
  39548. get stencilMask(): number;
  39549. set stencilMask(value: number);
  39550. get stencilTest(): boolean;
  39551. set stencilTest(value: boolean);
  39552. constructor();
  39553. reset(): void;
  39554. apply(gl: WebGLRenderingContext): void;
  39555. }
  39556. }
  39557. declare module "babylonjs/States/alphaCullingState" {
  39558. /**
  39559. * @hidden
  39560. **/
  39561. export class AlphaState {
  39562. private _isAlphaBlendDirty;
  39563. private _isBlendFunctionParametersDirty;
  39564. private _isBlendEquationParametersDirty;
  39565. private _isBlendConstantsDirty;
  39566. private _alphaBlend;
  39567. private _blendFunctionParameters;
  39568. private _blendEquationParameters;
  39569. private _blendConstants;
  39570. /**
  39571. * Initializes the state.
  39572. */
  39573. constructor();
  39574. get isDirty(): boolean;
  39575. get alphaBlend(): boolean;
  39576. set alphaBlend(value: boolean);
  39577. setAlphaBlendConstants(r: number, g: number, b: number, a: number): void;
  39578. setAlphaBlendFunctionParameters(value0: number, value1: number, value2: number, value3: number): void;
  39579. setAlphaEquationParameters(rgb: number, alpha: number): void;
  39580. reset(): void;
  39581. apply(gl: WebGLRenderingContext): void;
  39582. }
  39583. }
  39584. declare module "babylonjs/Engines/WebGL/webGL2ShaderProcessors" {
  39585. import { IShaderProcessor } from "babylonjs/Engines/Processors/iShaderProcessor";
  39586. /** @hidden */
  39587. export class WebGL2ShaderProcessor implements IShaderProcessor {
  39588. attributeProcessor(attribute: string): string;
  39589. varyingProcessor(varying: string, isFragment: boolean): string;
  39590. postProcessor(code: string, defines: string[], isFragment: boolean): string;
  39591. }
  39592. }
  39593. declare module "babylonjs/Engines/instancingAttributeInfo" {
  39594. /**
  39595. * Interface for attribute information associated with buffer instanciation
  39596. */
  39597. export interface InstancingAttributeInfo {
  39598. /**
  39599. * Name of the GLSL attribute
  39600. * if attribute index is not specified, this is used to retrieve the index from the effect
  39601. */
  39602. attributeName: string;
  39603. /**
  39604. * Index/offset of the attribute in the vertex shader
  39605. * if not specified, this will be computes from the name.
  39606. */
  39607. index?: number;
  39608. /**
  39609. * size of the attribute, 1, 2, 3 or 4
  39610. */
  39611. attributeSize: number;
  39612. /**
  39613. * Offset of the data in the Vertex Buffer acting as the instancing buffer
  39614. */
  39615. offset: number;
  39616. /**
  39617. * Modifies the rate at which generic vertex attributes advance when rendering multiple instances
  39618. * default to 1
  39619. */
  39620. divisor?: number;
  39621. /**
  39622. * type of the attribute, gl.BYTE, gl.UNSIGNED_BYTE, gl.SHORT, gl.UNSIGNED_SHORT, gl.FIXED, gl.FLOAT.
  39623. * default is FLOAT
  39624. */
  39625. attributeType?: number;
  39626. /**
  39627. * normalization of fixed-point data. behavior unclear, use FALSE, default is FALSE
  39628. */
  39629. normalized?: boolean;
  39630. }
  39631. }
  39632. declare module "babylonjs/Engines/Extensions/engine.videoTexture" {
  39633. import { InternalTexture } from "babylonjs/Materials/Textures/internalTexture";
  39634. import { Nullable } from "babylonjs/types";
  39635. module "babylonjs/Engines/thinEngine" {
  39636. interface ThinEngine {
  39637. /**
  39638. * Update a video texture
  39639. * @param texture defines the texture to update
  39640. * @param video defines the video element to use
  39641. * @param invertY defines if data must be stored with Y axis inverted
  39642. */
  39643. updateVideoTexture(texture: Nullable<InternalTexture>, video: HTMLVideoElement, invertY: boolean): void;
  39644. }
  39645. }
  39646. }
  39647. declare module "babylonjs/Engines/Extensions/engine.dynamicTexture" {
  39648. import { InternalTexture } from "babylonjs/Materials/Textures/internalTexture";
  39649. import { Nullable } from "babylonjs/types";
  39650. module "babylonjs/Engines/thinEngine" {
  39651. interface ThinEngine {
  39652. /**
  39653. * Creates a dynamic texture
  39654. * @param width defines the width of the texture
  39655. * @param height defines the height of the texture
  39656. * @param generateMipMaps defines if the engine should generate the mip levels
  39657. * @param samplingMode defines the required sampling mode (Texture.NEAREST_SAMPLINGMODE by default)
  39658. * @returns the dynamic texture inside an InternalTexture
  39659. */
  39660. createDynamicTexture(width: number, height: number, generateMipMaps: boolean, samplingMode: number): InternalTexture;
  39661. /**
  39662. * Update the content of a dynamic texture
  39663. * @param texture defines the texture to update
  39664. * @param canvas defines the canvas containing the source
  39665. * @param invertY defines if data must be stored with Y axis inverted
  39666. * @param premulAlpha defines if alpha is stored as premultiplied
  39667. * @param format defines the format of the data
  39668. * @param forceBindTexture if the texture should be forced to be bound eg. after a graphics context loss (Default: false)
  39669. */
  39670. updateDynamicTexture(texture: Nullable<InternalTexture>, canvas: HTMLCanvasElement | OffscreenCanvas, invertY: boolean, premulAlpha?: boolean, format?: number, forceBindTexture?: boolean): void;
  39671. }
  39672. }
  39673. }
  39674. declare module "babylonjs/Materials/Textures/videoTexture" {
  39675. import { Observable } from "babylonjs/Misc/observable";
  39676. import { Nullable } from "babylonjs/types";
  39677. import { Scene } from "babylonjs/scene";
  39678. import { Texture } from "babylonjs/Materials/Textures/texture";
  39679. import "babylonjs/Engines/Extensions/engine.videoTexture";
  39680. import "babylonjs/Engines/Extensions/engine.dynamicTexture";
  39681. /**
  39682. * Settings for finer control over video usage
  39683. */
  39684. export interface VideoTextureSettings {
  39685. /**
  39686. * Applies `autoplay` to video, if specified
  39687. */
  39688. autoPlay?: boolean;
  39689. /**
  39690. * Applies `muted` to video, if specified
  39691. */
  39692. muted?: boolean;
  39693. /**
  39694. * Applies `loop` to video, if specified
  39695. */
  39696. loop?: boolean;
  39697. /**
  39698. * Automatically updates internal texture from video at every frame in the render loop
  39699. */
  39700. autoUpdateTexture: boolean;
  39701. /**
  39702. * Image src displayed during the video loading or until the user interacts with the video.
  39703. */
  39704. poster?: string;
  39705. }
  39706. /**
  39707. * If you want to display a video in your scene, this is the special texture for that.
  39708. * This special texture works similar to other textures, with the exception of a few parameters.
  39709. * @see https://doc.babylonjs.com/how_to/video_texture
  39710. */
  39711. export class VideoTexture extends Texture {
  39712. /**
  39713. * Tells whether textures will be updated automatically or user is required to call `updateTexture` manually
  39714. */
  39715. readonly autoUpdateTexture: boolean;
  39716. /**
  39717. * The video instance used by the texture internally
  39718. */
  39719. readonly video: HTMLVideoElement;
  39720. private _onUserActionRequestedObservable;
  39721. /**
  39722. * Event triggerd when a dom action is required by the user to play the video.
  39723. * This happens due to recent changes in browser policies preventing video to auto start.
  39724. */
  39725. get onUserActionRequestedObservable(): Observable<Texture>;
  39726. private _generateMipMaps;
  39727. private _stillImageCaptured;
  39728. private _displayingPosterTexture;
  39729. private _settings;
  39730. private _createInternalTextureOnEvent;
  39731. private _frameId;
  39732. private _currentSrc;
  39733. /**
  39734. * Creates a video texture.
  39735. * If you want to display a video in your scene, this is the special texture for that.
  39736. * This special texture works similar to other textures, with the exception of a few parameters.
  39737. * @see https://doc.babylonjs.com/how_to/video_texture
  39738. * @param name optional name, will detect from video source, if not defined
  39739. * @param src can be used to provide an url, array of urls or an already setup HTML video element.
  39740. * @param scene is obviously the current scene.
  39741. * @param generateMipMaps can be used to turn on mipmaps (Can be expensive for videoTextures because they are often updated).
  39742. * @param invertY is false by default but can be used to invert video on Y axis
  39743. * @param samplingMode controls the sampling method and is set to TRILINEAR_SAMPLINGMODE by default
  39744. * @param settings allows finer control over video usage
  39745. */
  39746. constructor(name: Nullable<string>, src: string | string[] | HTMLVideoElement, scene: Nullable<Scene>, generateMipMaps?: boolean, invertY?: boolean, samplingMode?: number, settings?: VideoTextureSettings);
  39747. private _getName;
  39748. private _getVideo;
  39749. private _createInternalTexture;
  39750. private reset;
  39751. /**
  39752. * @hidden Internal method to initiate `update`.
  39753. */
  39754. _rebuild(): void;
  39755. /**
  39756. * Update Texture in the `auto` mode. Does not do anything if `settings.autoUpdateTexture` is false.
  39757. */
  39758. update(): void;
  39759. /**
  39760. * Update Texture in `manual` mode. Does not do anything if not visible or paused.
  39761. * @param isVisible Visibility state, detected by user using `scene.getActiveMeshes()` or othervise.
  39762. */
  39763. updateTexture(isVisible: boolean): void;
  39764. protected _updateInternalTexture: () => void;
  39765. /**
  39766. * Change video content. Changing video instance or setting multiple urls (as in constructor) is not supported.
  39767. * @param url New url.
  39768. */
  39769. updateURL(url: string): void;
  39770. /**
  39771. * Clones the texture.
  39772. * @returns the cloned texture
  39773. */
  39774. clone(): VideoTexture;
  39775. /**
  39776. * Dispose the texture and release its associated resources.
  39777. */
  39778. dispose(): void;
  39779. /**
  39780. * Creates a video texture straight from a stream.
  39781. * @param scene Define the scene the texture should be created in
  39782. * @param stream Define the stream the texture should be created from
  39783. * @returns The created video texture as a promise
  39784. */
  39785. static CreateFromStreamAsync(scene: Scene, stream: MediaStream): Promise<VideoTexture>;
  39786. /**
  39787. * Creates a video texture straight from your WebCam video feed.
  39788. * @param scene Define the scene the texture should be created in
  39789. * @param constraints Define the constraints to use to create the web cam feed from WebRTC
  39790. * @param audioConstaints Define the audio constraints to use to create the web cam feed from WebRTC
  39791. * @returns The created video texture as a promise
  39792. */
  39793. static CreateFromWebCamAsync(scene: Scene, constraints: {
  39794. minWidth: number;
  39795. maxWidth: number;
  39796. minHeight: number;
  39797. maxHeight: number;
  39798. deviceId: string;
  39799. } & MediaTrackConstraints, audioConstaints?: boolean | MediaTrackConstraints): Promise<VideoTexture>;
  39800. /**
  39801. * Creates a video texture straight from your WebCam video feed.
  39802. * @param scene Define the scene the texture should be created in
  39803. * @param onReady Define a callback to triggered once the texture will be ready
  39804. * @param constraints Define the constraints to use to create the web cam feed from WebRTC
  39805. * @param audioConstaints Define the audio constraints to use to create the web cam feed from WebRTC
  39806. */
  39807. static CreateFromWebCam(scene: Scene, onReady: (videoTexture: VideoTexture) => void, constraints: {
  39808. minWidth: number;
  39809. maxWidth: number;
  39810. minHeight: number;
  39811. maxHeight: number;
  39812. deviceId: string;
  39813. } & MediaTrackConstraints, audioConstaints?: boolean | MediaTrackConstraints): void;
  39814. }
  39815. }
  39816. declare module "babylonjs/Engines/thinEngine" {
  39817. import { IInternalTextureLoader } from "babylonjs/Materials/Textures/internalTextureLoader";
  39818. import { Effect, IEffectCreationOptions } from "babylonjs/Materials/effect";
  39819. import { IShaderProcessor } from "babylonjs/Engines/Processors/iShaderProcessor";
  39820. import { UniformBuffer } from "babylonjs/Materials/uniformBuffer";
  39821. import { Nullable, DataArray, IndicesArray } from "babylonjs/types";
  39822. import { EngineCapabilities } from "babylonjs/Engines/engineCapabilities";
  39823. import { Observable } from "babylonjs/Misc/observable";
  39824. import { DepthCullingState } from "babylonjs/States/depthCullingState";
  39825. import { StencilState } from "babylonjs/States/stencilState";
  39826. import { AlphaState } from "babylonjs/States/alphaCullingState";
  39827. import { InternalTexture } from "babylonjs/Materials/Textures/internalTexture";
  39828. import { IViewportLike, IColor4Like } from "babylonjs/Maths/math.like";
  39829. import { DataBuffer } from "babylonjs/Meshes/dataBuffer";
  39830. import { IFileRequest } from "babylonjs/Misc/fileRequest";
  39831. import { IPipelineContext } from "babylonjs/Engines/IPipelineContext";
  39832. import { WebGLPipelineContext } from "babylonjs/Engines/WebGL/webGLPipelineContext";
  39833. import { VertexBuffer } from "babylonjs/Meshes/buffer";
  39834. import { InstancingAttributeInfo } from "babylonjs/Engines/instancingAttributeInfo";
  39835. import { BaseTexture } from "babylonjs/Materials/Textures/baseTexture";
  39836. import { IOfflineProvider } from "babylonjs/Offline/IOfflineProvider";
  39837. import { IEffectFallbacks } from "babylonjs/Materials/iEffectFallbacks";
  39838. import { IWebRequest } from "babylonjs/Misc/interfaces/iWebRequest";
  39839. import { WebRequest } from "babylonjs/Misc/webRequest";
  39840. import { LoadFileError } from "babylonjs/Misc/fileTools";
  39841. /**
  39842. * Defines the interface used by objects working like Scene
  39843. * @hidden
  39844. */
  39845. export interface ISceneLike {
  39846. _addPendingData(data: any): void;
  39847. _removePendingData(data: any): void;
  39848. offlineProvider: IOfflineProvider;
  39849. }
  39850. /**
  39851. * Information about the current host
  39852. */
  39853. export interface HostInformation {
  39854. /**
  39855. * Defines if the current host is a mobile
  39856. */
  39857. isMobile: boolean;
  39858. }
  39859. /** Interface defining initialization parameters for Engine class */
  39860. export interface EngineOptions extends WebGLContextAttributes {
  39861. /**
  39862. * Defines if the engine should no exceed a specified device ratio
  39863. * @see https://developer.mozilla.org/en-US/docs/Web/API/Window/devicePixelRatio
  39864. */
  39865. limitDeviceRatio?: number;
  39866. /**
  39867. * Defines if webvr should be enabled automatically
  39868. * @see https://doc.babylonjs.com/how_to/webvr_camera
  39869. */
  39870. autoEnableWebVR?: boolean;
  39871. /**
  39872. * Defines if webgl2 should be turned off even if supported
  39873. * @see https://doc.babylonjs.com/features/webgl2
  39874. */
  39875. disableWebGL2Support?: boolean;
  39876. /**
  39877. * Defines if webaudio should be initialized as well
  39878. * @see https://doc.babylonjs.com/how_to/playing_sounds_and_music
  39879. */
  39880. audioEngine?: boolean;
  39881. /**
  39882. * Defines if animations should run using a deterministic lock step
  39883. * @see https://doc.babylonjs.com/babylon101/animations#deterministic-lockstep
  39884. */
  39885. deterministicLockstep?: boolean;
  39886. /** Defines the maximum steps to use with deterministic lock step mode */
  39887. lockstepMaxSteps?: number;
  39888. /** Defines the seconds between each deterministic lock step */
  39889. timeStep?: number;
  39890. /**
  39891. * Defines that engine should ignore context lost events
  39892. * If this event happens when this parameter is true, you will have to reload the page to restore rendering
  39893. */
  39894. doNotHandleContextLost?: boolean;
  39895. /**
  39896. * Defines that engine should ignore modifying touch action attribute and style
  39897. * If not handle, you might need to set it up on your side for expected touch devices behavior.
  39898. */
  39899. doNotHandleTouchAction?: boolean;
  39900. /**
  39901. * Defines that engine should compile shaders with high precision floats (if supported). True by default
  39902. */
  39903. useHighPrecisionFloats?: boolean;
  39904. /**
  39905. * Make the canvas XR Compatible for XR sessions
  39906. */
  39907. xrCompatible?: boolean;
  39908. /**
  39909. * Make the matrix computations to be performed in 64 bits instead of 32 bits. False by default
  39910. */
  39911. useHighPrecisionMatrix?: boolean;
  39912. /**
  39913. * Will prevent the system from falling back to software implementation if a hardware device cannot be created
  39914. */
  39915. failIfMajorPerformanceCaveat?: boolean;
  39916. }
  39917. /**
  39918. * The base engine class (root of all engines)
  39919. */
  39920. export class ThinEngine {
  39921. /** Use this array to turn off some WebGL2 features on known buggy browsers version */
  39922. static ExceptionList: ({
  39923. key: string;
  39924. capture: string;
  39925. captureConstraint: number;
  39926. targets: string[];
  39927. } | {
  39928. key: string;
  39929. capture: null;
  39930. captureConstraint: null;
  39931. targets: string[];
  39932. })[];
  39933. /** @hidden */
  39934. static _TextureLoaders: IInternalTextureLoader[];
  39935. /**
  39936. * Returns the current npm package of the sdk
  39937. */
  39938. static get NpmPackage(): string;
  39939. /**
  39940. * Returns the current version of the framework
  39941. */
  39942. static get Version(): string;
  39943. /**
  39944. * Returns a string describing the current engine
  39945. */
  39946. get description(): string;
  39947. /**
  39948. * Gets or sets the epsilon value used by collision engine
  39949. */
  39950. static CollisionsEpsilon: number;
  39951. /**
  39952. * Gets or sets the relative url used to load shaders if using the engine in non-minified mode
  39953. */
  39954. static get ShadersRepository(): string;
  39955. static set ShadersRepository(value: string);
  39956. /** @hidden */
  39957. _shaderProcessor: IShaderProcessor;
  39958. /**
  39959. * Gets or sets a boolean that indicates if textures must be forced to power of 2 size even if not required
  39960. */
  39961. forcePOTTextures: boolean;
  39962. /**
  39963. * Gets a boolean indicating if the engine is currently rendering in fullscreen mode
  39964. */
  39965. isFullscreen: boolean;
  39966. /**
  39967. * Gets or sets a boolean indicating if back faces must be culled (true by default)
  39968. */
  39969. cullBackFaces: boolean;
  39970. /**
  39971. * Gets or sets a boolean indicating if the engine must keep rendering even if the window is not in foregroun
  39972. */
  39973. renderEvenInBackground: boolean;
  39974. /**
  39975. * Gets or sets a boolean indicating that cache can be kept between frames
  39976. */
  39977. preventCacheWipeBetweenFrames: boolean;
  39978. /** Gets or sets a boolean indicating if the engine should validate programs after compilation */
  39979. validateShaderPrograms: boolean;
  39980. /**
  39981. * Gets or sets a boolean indicating if depth buffer should be reverse, going from far to near.
  39982. * This can provide greater z depth for distant objects.
  39983. */
  39984. useReverseDepthBuffer: boolean;
  39985. /**
  39986. * Gets or sets a boolean indicating that uniform buffers must be disabled even if they are supported
  39987. */
  39988. disableUniformBuffers: boolean;
  39989. /** @hidden */
  39990. _uniformBuffers: UniformBuffer[];
  39991. /**
  39992. * Gets a boolean indicating that the engine supports uniform buffers
  39993. * @see https://doc.babylonjs.com/features/webgl2#uniform-buffer-objets
  39994. */
  39995. get supportsUniformBuffers(): boolean;
  39996. /** @hidden */
  39997. _gl: WebGLRenderingContext;
  39998. /** @hidden */
  39999. _webGLVersion: number;
  40000. protected _renderingCanvas: Nullable<HTMLCanvasElement>;
  40001. protected _windowIsBackground: boolean;
  40002. protected _creationOptions: EngineOptions;
  40003. protected _highPrecisionShadersAllowed: boolean;
  40004. /** @hidden */
  40005. get _shouldUseHighPrecisionShader(): boolean;
  40006. /**
  40007. * Gets a boolean indicating that only power of 2 textures are supported
  40008. * Please note that you can still use non power of 2 textures but in this case the engine will forcefully convert them
  40009. */
  40010. get needPOTTextures(): boolean;
  40011. /** @hidden */
  40012. _badOS: boolean;
  40013. /** @hidden */
  40014. _badDesktopOS: boolean;
  40015. private _hardwareScalingLevel;
  40016. /** @hidden */
  40017. _caps: EngineCapabilities;
  40018. private _isStencilEnable;
  40019. private _glVersion;
  40020. private _glRenderer;
  40021. private _glVendor;
  40022. /** @hidden */
  40023. _videoTextureSupported: boolean;
  40024. protected _renderingQueueLaunched: boolean;
  40025. protected _activeRenderLoops: (() => void)[];
  40026. /**
  40027. * Observable signaled when a context lost event is raised
  40028. */
  40029. onContextLostObservable: Observable<ThinEngine>;
  40030. /**
  40031. * Observable signaled when a context restored event is raised
  40032. */
  40033. onContextRestoredObservable: Observable<ThinEngine>;
  40034. private _onContextLost;
  40035. private _onContextRestored;
  40036. protected _contextWasLost: boolean;
  40037. /** @hidden */
  40038. _doNotHandleContextLost: boolean;
  40039. /**
  40040. * Gets or sets a boolean indicating if resources should be retained to be able to handle context lost events
  40041. * @see https://doc.babylonjs.com/how_to/optimizing_your_scene#handling-webgl-context-lost
  40042. */
  40043. get doNotHandleContextLost(): boolean;
  40044. set doNotHandleContextLost(value: boolean);
  40045. /**
  40046. * Gets or sets a boolean indicating that vertex array object must be disabled even if they are supported
  40047. */
  40048. disableVertexArrayObjects: boolean;
  40049. /** @hidden */
  40050. protected _colorWrite: boolean;
  40051. /** @hidden */
  40052. protected _colorWriteChanged: boolean;
  40053. /** @hidden */
  40054. protected _depthCullingState: DepthCullingState;
  40055. /** @hidden */
  40056. protected _stencilState: StencilState;
  40057. /** @hidden */
  40058. _alphaState: AlphaState;
  40059. /** @hidden */
  40060. _alphaMode: number;
  40061. /** @hidden */
  40062. _alphaEquation: number;
  40063. /** @hidden */
  40064. _internalTexturesCache: InternalTexture[];
  40065. /** @hidden */
  40066. protected _activeChannel: number;
  40067. private _currentTextureChannel;
  40068. /** @hidden */
  40069. protected _boundTexturesCache: {
  40070. [key: string]: Nullable<InternalTexture>;
  40071. };
  40072. /** @hidden */
  40073. protected _currentEffect: Nullable<Effect>;
  40074. /** @hidden */
  40075. protected _currentProgram: Nullable<WebGLProgram>;
  40076. private _compiledEffects;
  40077. private _vertexAttribArraysEnabled;
  40078. /** @hidden */
  40079. protected _cachedViewport: Nullable<IViewportLike>;
  40080. private _cachedVertexArrayObject;
  40081. /** @hidden */
  40082. protected _cachedVertexBuffers: any;
  40083. /** @hidden */
  40084. protected _cachedIndexBuffer: Nullable<DataBuffer>;
  40085. /** @hidden */
  40086. protected _cachedEffectForVertexBuffers: Nullable<Effect>;
  40087. /** @hidden */
  40088. _currentRenderTarget: Nullable<InternalTexture>;
  40089. private _uintIndicesCurrentlySet;
  40090. protected _currentBoundBuffer: Nullable<WebGLBuffer>[];
  40091. /** @hidden */
  40092. _currentFramebuffer: Nullable<WebGLFramebuffer>;
  40093. /** @hidden */
  40094. _dummyFramebuffer: Nullable<WebGLFramebuffer>;
  40095. private _currentBufferPointers;
  40096. private _currentInstanceLocations;
  40097. private _currentInstanceBuffers;
  40098. private _textureUnits;
  40099. /** @hidden */
  40100. _workingCanvas: Nullable<HTMLCanvasElement | OffscreenCanvas>;
  40101. /** @hidden */
  40102. _workingContext: Nullable<CanvasRenderingContext2D | OffscreenCanvasRenderingContext2D>;
  40103. /** @hidden */
  40104. _boundRenderFunction: any;
  40105. private _vaoRecordInProgress;
  40106. private _mustWipeVertexAttributes;
  40107. private _emptyTexture;
  40108. private _emptyCubeTexture;
  40109. private _emptyTexture3D;
  40110. private _emptyTexture2DArray;
  40111. /** @hidden */
  40112. _frameHandler: number;
  40113. private _nextFreeTextureSlots;
  40114. private _maxSimultaneousTextures;
  40115. private _activeRequests;
  40116. /** @hidden */
  40117. _transformTextureUrl: Nullable<(url: string) => string>;
  40118. /**
  40119. * Gets information about the current host
  40120. */
  40121. hostInformation: HostInformation;
  40122. protected get _supportsHardwareTextureRescaling(): boolean;
  40123. private _framebufferDimensionsObject;
  40124. /**
  40125. * sets the object from which width and height will be taken from when getting render width and height
  40126. * Will fallback to the gl object
  40127. * @param dimensions the framebuffer width and height that will be used.
  40128. */
  40129. set framebufferDimensionsObject(dimensions: Nullable<{
  40130. framebufferWidth: number;
  40131. framebufferHeight: number;
  40132. }>);
  40133. /**
  40134. * Gets the current viewport
  40135. */
  40136. get currentViewport(): Nullable<IViewportLike>;
  40137. /**
  40138. * Gets the default empty texture
  40139. */
  40140. get emptyTexture(): InternalTexture;
  40141. /**
  40142. * Gets the default empty 3D texture
  40143. */
  40144. get emptyTexture3D(): InternalTexture;
  40145. /**
  40146. * Gets the default empty 2D array texture
  40147. */
  40148. get emptyTexture2DArray(): InternalTexture;
  40149. /**
  40150. * Gets the default empty cube texture
  40151. */
  40152. get emptyCubeTexture(): InternalTexture;
  40153. /**
  40154. * Defines whether the engine has been created with the premultipliedAlpha option on or not.
  40155. */
  40156. readonly premultipliedAlpha: boolean;
  40157. /**
  40158. * Observable event triggered before each texture is initialized
  40159. */
  40160. onBeforeTextureInitObservable: Observable<import("babylonjs/Materials/Textures/texture").Texture>;
  40161. /**
  40162. * Creates a new engine
  40163. * @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
  40164. * @param antialias defines enable antialiasing (default: false)
  40165. * @param options defines further options to be sent to the getContext() function
  40166. * @param adaptToDeviceRatio defines whether to adapt to the device's viewport characteristics (default: false)
  40167. */
  40168. constructor(canvasOrContext: Nullable<HTMLCanvasElement | WebGLRenderingContext | WebGL2RenderingContext>, antialias?: boolean, options?: EngineOptions, adaptToDeviceRatio?: boolean);
  40169. private _rebuildInternalTextures;
  40170. private _rebuildEffects;
  40171. /**
  40172. * Gets a boolean indicating if all created effects are ready
  40173. * @returns true if all effects are ready
  40174. */
  40175. areAllEffectsReady(): boolean;
  40176. protected _rebuildBuffers(): void;
  40177. protected _initGLContext(): void;
  40178. /**
  40179. * Gets version of the current webGL context
  40180. */
  40181. get webGLVersion(): number;
  40182. /**
  40183. * Gets a string identifying the name of the class
  40184. * @returns "Engine" string
  40185. */
  40186. getClassName(): string;
  40187. /**
  40188. * Returns true if the stencil buffer has been enabled through the creation option of the context.
  40189. */
  40190. get isStencilEnable(): boolean;
  40191. /** @hidden */
  40192. _prepareWorkingCanvas(): void;
  40193. /**
  40194. * Reset the texture cache to empty state
  40195. */
  40196. resetTextureCache(): void;
  40197. /**
  40198. * Gets an object containing information about the current webGL context
  40199. * @returns an object containing the vender, the renderer and the version of the current webGL context
  40200. */
  40201. getGlInfo(): {
  40202. vendor: string;
  40203. renderer: string;
  40204. version: string;
  40205. };
  40206. /**
  40207. * Defines the hardware scaling level.
  40208. * By default the hardware scaling level is computed from the window device ratio.
  40209. * 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.
  40210. * @param level defines the level to use
  40211. */
  40212. setHardwareScalingLevel(level: number): void;
  40213. /**
  40214. * Gets the current hardware scaling level.
  40215. * By default the hardware scaling level is computed from the window device ratio.
  40216. * 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.
  40217. * @returns a number indicating the current hardware scaling level
  40218. */
  40219. getHardwareScalingLevel(): number;
  40220. /**
  40221. * Gets the list of loaded textures
  40222. * @returns an array containing all loaded textures
  40223. */
  40224. getLoadedTexturesCache(): InternalTexture[];
  40225. /**
  40226. * Gets the object containing all engine capabilities
  40227. * @returns the EngineCapabilities object
  40228. */
  40229. getCaps(): EngineCapabilities;
  40230. /**
  40231. * stop executing a render loop function and remove it from the execution array
  40232. * @param renderFunction defines the function to be removed. If not provided all functions will be removed.
  40233. */
  40234. stopRenderLoop(renderFunction?: () => void): void;
  40235. /** @hidden */
  40236. _renderLoop(): void;
  40237. /**
  40238. * Gets the HTML canvas attached with the current webGL context
  40239. * @returns a HTML canvas
  40240. */
  40241. getRenderingCanvas(): Nullable<HTMLCanvasElement>;
  40242. /**
  40243. * Gets host window
  40244. * @returns the host window object
  40245. */
  40246. getHostWindow(): Nullable<Window>;
  40247. /**
  40248. * Gets the current render width
  40249. * @param useScreen defines if screen size must be used (or the current render target if any)
  40250. * @returns a number defining the current render width
  40251. */
  40252. getRenderWidth(useScreen?: boolean): number;
  40253. /**
  40254. * Gets the current render height
  40255. * @param useScreen defines if screen size must be used (or the current render target if any)
  40256. * @returns a number defining the current render height
  40257. */
  40258. getRenderHeight(useScreen?: boolean): number;
  40259. /**
  40260. * Can be used to override the current requestAnimationFrame requester.
  40261. * @hidden
  40262. */
  40263. protected _queueNewFrame(bindedRenderFunction: any, requester?: any): number;
  40264. /**
  40265. * Register and execute a render loop. The engine can have more than one render function
  40266. * @param renderFunction defines the function to continuously execute
  40267. */
  40268. runRenderLoop(renderFunction: () => void): void;
  40269. /**
  40270. * Clear the current render buffer or the current render target (if any is set up)
  40271. * @param color defines the color to use
  40272. * @param backBuffer defines if the back buffer must be cleared
  40273. * @param depth defines if the depth buffer must be cleared
  40274. * @param stencil defines if the stencil buffer must be cleared
  40275. */
  40276. clear(color: Nullable<IColor4Like>, backBuffer: boolean, depth: boolean, stencil?: boolean): void;
  40277. private _viewportCached;
  40278. /** @hidden */
  40279. _viewport(x: number, y: number, width: number, height: number): void;
  40280. /**
  40281. * Set the WebGL's viewport
  40282. * @param viewport defines the viewport element to be used
  40283. * @param requiredWidth defines the width required for rendering. If not provided the rendering canvas' width is used
  40284. * @param requiredHeight defines the height required for rendering. If not provided the rendering canvas' height is used
  40285. */
  40286. setViewport(viewport: IViewportLike, requiredWidth?: number, requiredHeight?: number): void;
  40287. /**
  40288. * Begin a new frame
  40289. */
  40290. beginFrame(): void;
  40291. /**
  40292. * Enf the current frame
  40293. */
  40294. endFrame(): void;
  40295. /**
  40296. * Resize the view according to the canvas' size
  40297. */
  40298. resize(): void;
  40299. /**
  40300. * Force a specific size of the canvas
  40301. * @param width defines the new canvas' width
  40302. * @param height defines the new canvas' height
  40303. * @returns true if the size was changed
  40304. */
  40305. setSize(width: number, height: number): boolean;
  40306. /**
  40307. * Binds the frame buffer to the specified texture.
  40308. * @param texture The texture to render to or null for the default canvas
  40309. * @param faceIndex The face of the texture to render to in case of cube texture
  40310. * @param requiredWidth The width of the target to render to
  40311. * @param requiredHeight The height of the target to render to
  40312. * @param forceFullscreenViewport Forces the viewport to be the entire texture/screen if true
  40313. * @param lodLevel defines the lod level to bind to the frame buffer
  40314. * @param layer defines the 2d array index to bind to frame buffer to
  40315. */
  40316. bindFramebuffer(texture: InternalTexture, faceIndex?: number, requiredWidth?: number, requiredHeight?: number, forceFullscreenViewport?: boolean, lodLevel?: number, layer?: number): void;
  40317. /** @hidden */
  40318. _bindUnboundFramebuffer(framebuffer: Nullable<WebGLFramebuffer>): void;
  40319. /**
  40320. * Unbind the current render target texture from the webGL context
  40321. * @param texture defines the render target texture to unbind
  40322. * @param disableGenerateMipMaps defines a boolean indicating that mipmaps must not be generated
  40323. * @param onBeforeUnbind defines a function which will be called before the effective unbind
  40324. */
  40325. unBindFramebuffer(texture: InternalTexture, disableGenerateMipMaps?: boolean, onBeforeUnbind?: () => void): void;
  40326. /**
  40327. * Force a webGL flush (ie. a flush of all waiting webGL commands)
  40328. */
  40329. flushFramebuffer(): void;
  40330. /**
  40331. * Unbind the current render target and bind the default framebuffer
  40332. */
  40333. restoreDefaultFramebuffer(): void;
  40334. /** @hidden */
  40335. protected _resetVertexBufferBinding(): void;
  40336. /**
  40337. * Creates a vertex buffer
  40338. * @param data the data for the vertex buffer
  40339. * @returns the new WebGL static buffer
  40340. */
  40341. createVertexBuffer(data: DataArray): DataBuffer;
  40342. private _createVertexBuffer;
  40343. /**
  40344. * Creates a dynamic vertex buffer
  40345. * @param data the data for the dynamic vertex buffer
  40346. * @returns the new WebGL dynamic buffer
  40347. */
  40348. createDynamicVertexBuffer(data: DataArray): DataBuffer;
  40349. protected _resetIndexBufferBinding(): void;
  40350. /**
  40351. * Creates a new index buffer
  40352. * @param indices defines the content of the index buffer
  40353. * @param updatable defines if the index buffer must be updatable
  40354. * @returns a new webGL buffer
  40355. */
  40356. createIndexBuffer(indices: IndicesArray, updatable?: boolean): DataBuffer;
  40357. protected _normalizeIndexData(indices: IndicesArray): Uint16Array | Uint32Array;
  40358. /**
  40359. * Bind a webGL buffer to the webGL context
  40360. * @param buffer defines the buffer to bind
  40361. */
  40362. bindArrayBuffer(buffer: Nullable<DataBuffer>): void;
  40363. protected bindIndexBuffer(buffer: Nullable<DataBuffer>): void;
  40364. private bindBuffer;
  40365. /**
  40366. * update the bound buffer with the given data
  40367. * @param data defines the data to update
  40368. */
  40369. updateArrayBuffer(data: Float32Array): void;
  40370. private _vertexAttribPointer;
  40371. /** @hidden */
  40372. _bindIndexBufferWithCache(indexBuffer: Nullable<DataBuffer>): void;
  40373. private _bindVertexBuffersAttributes;
  40374. /**
  40375. * Records a vertex array object
  40376. * @see https://doc.babylonjs.com/features/webgl2#vertex-array-objects
  40377. * @param vertexBuffers defines the list of vertex buffers to store
  40378. * @param indexBuffer defines the index buffer to store
  40379. * @param effect defines the effect to store
  40380. * @returns the new vertex array object
  40381. */
  40382. recordVertexArrayObject(vertexBuffers: {
  40383. [key: string]: VertexBuffer;
  40384. }, indexBuffer: Nullable<DataBuffer>, effect: Effect): WebGLVertexArrayObject;
  40385. /**
  40386. * Bind a specific vertex array object
  40387. * @see https://doc.babylonjs.com/features/webgl2#vertex-array-objects
  40388. * @param vertexArrayObject defines the vertex array object to bind
  40389. * @param indexBuffer defines the index buffer to bind
  40390. */
  40391. bindVertexArrayObject(vertexArrayObject: WebGLVertexArrayObject, indexBuffer: Nullable<DataBuffer>): void;
  40392. /**
  40393. * Bind webGl buffers directly to the webGL context
  40394. * @param vertexBuffer defines the vertex buffer to bind
  40395. * @param indexBuffer defines the index buffer to bind
  40396. * @param vertexDeclaration defines the vertex declaration to use with the vertex buffer
  40397. * @param vertexStrideSize defines the vertex stride of the vertex buffer
  40398. * @param effect defines the effect associated with the vertex buffer
  40399. */
  40400. bindBuffersDirectly(vertexBuffer: DataBuffer, indexBuffer: DataBuffer, vertexDeclaration: number[], vertexStrideSize: number, effect: Effect): void;
  40401. private _unbindVertexArrayObject;
  40402. /**
  40403. * Bind a list of vertex buffers to the webGL context
  40404. * @param vertexBuffers defines the list of vertex buffers to bind
  40405. * @param indexBuffer defines the index buffer to bind
  40406. * @param effect defines the effect associated with the vertex buffers
  40407. */
  40408. bindBuffers(vertexBuffers: {
  40409. [key: string]: Nullable<VertexBuffer>;
  40410. }, indexBuffer: Nullable<DataBuffer>, effect: Effect): void;
  40411. /**
  40412. * Unbind all instance attributes
  40413. */
  40414. unbindInstanceAttributes(): void;
  40415. /**
  40416. * Release and free the memory of a vertex array object
  40417. * @param vao defines the vertex array object to delete
  40418. */
  40419. releaseVertexArrayObject(vao: WebGLVertexArrayObject): void;
  40420. /** @hidden */
  40421. _releaseBuffer(buffer: DataBuffer): boolean;
  40422. protected _deleteBuffer(buffer: DataBuffer): void;
  40423. /**
  40424. * Update the content of a webGL buffer used with instanciation and bind it to the webGL context
  40425. * @param instancesBuffer defines the webGL buffer to update and bind
  40426. * @param data defines the data to store in the buffer
  40427. * @param offsetLocations defines the offsets or attributes information used to determine where data must be stored in the buffer
  40428. */
  40429. updateAndBindInstancesBuffer(instancesBuffer: DataBuffer, data: Float32Array, offsetLocations: number[] | InstancingAttributeInfo[]): void;
  40430. /**
  40431. * Bind the content of a webGL buffer used with instantiation
  40432. * @param instancesBuffer defines the webGL buffer to bind
  40433. * @param attributesInfo defines the offsets or attributes information used to determine where data must be stored in the buffer
  40434. * @param computeStride defines Whether to compute the strides from the info or use the default 0
  40435. */
  40436. bindInstancesBuffer(instancesBuffer: DataBuffer, attributesInfo: InstancingAttributeInfo[], computeStride?: boolean): void;
  40437. /**
  40438. * Disable the instance attribute corresponding to the name in parameter
  40439. * @param name defines the name of the attribute to disable
  40440. */
  40441. disableInstanceAttributeByName(name: string): void;
  40442. /**
  40443. * Disable the instance attribute corresponding to the location in parameter
  40444. * @param attributeLocation defines the attribute location of the attribute to disable
  40445. */
  40446. disableInstanceAttribute(attributeLocation: number): void;
  40447. /**
  40448. * Disable the attribute corresponding to the location in parameter
  40449. * @param attributeLocation defines the attribute location of the attribute to disable
  40450. */
  40451. disableAttributeByIndex(attributeLocation: number): void;
  40452. /**
  40453. * Send a draw order
  40454. * @param useTriangles defines if triangles must be used to draw (else wireframe will be used)
  40455. * @param indexStart defines the starting index
  40456. * @param indexCount defines the number of index to draw
  40457. * @param instancesCount defines the number of instances to draw (if instanciation is enabled)
  40458. */
  40459. draw(useTriangles: boolean, indexStart: number, indexCount: number, instancesCount?: number): void;
  40460. /**
  40461. * Draw a list of points
  40462. * @param verticesStart defines the index of first vertex to draw
  40463. * @param verticesCount defines the count of vertices to draw
  40464. * @param instancesCount defines the number of instances to draw (if instanciation is enabled)
  40465. */
  40466. drawPointClouds(verticesStart: number, verticesCount: number, instancesCount?: number): void;
  40467. /**
  40468. * Draw a list of unindexed primitives
  40469. * @param useTriangles defines if triangles must be used to draw (else wireframe will be used)
  40470. * @param verticesStart defines the index of first vertex to draw
  40471. * @param verticesCount defines the count of vertices to draw
  40472. * @param instancesCount defines the number of instances to draw (if instanciation is enabled)
  40473. */
  40474. drawUnIndexed(useTriangles: boolean, verticesStart: number, verticesCount: number, instancesCount?: number): void;
  40475. /**
  40476. * Draw a list of indexed primitives
  40477. * @param fillMode defines the primitive to use
  40478. * @param indexStart defines the starting index
  40479. * @param indexCount defines the number of index to draw
  40480. * @param instancesCount defines the number of instances to draw (if instanciation is enabled)
  40481. */
  40482. drawElementsType(fillMode: number, indexStart: number, indexCount: number, instancesCount?: number): void;
  40483. /**
  40484. * Draw a list of unindexed primitives
  40485. * @param fillMode defines the primitive to use
  40486. * @param verticesStart defines the index of first vertex to draw
  40487. * @param verticesCount defines the count of vertices to draw
  40488. * @param instancesCount defines the number of instances to draw (if instanciation is enabled)
  40489. */
  40490. drawArraysType(fillMode: number, verticesStart: number, verticesCount: number, instancesCount?: number): void;
  40491. private _drawMode;
  40492. /** @hidden */
  40493. protected _reportDrawCall(): void;
  40494. /** @hidden */
  40495. _releaseEffect(effect: Effect): void;
  40496. /** @hidden */
  40497. _deletePipelineContext(pipelineContext: IPipelineContext): void;
  40498. /**
  40499. * Create a new effect (used to store vertex/fragment shaders)
  40500. * @param baseName defines the base name of the effect (The name of file without .fragment.fx or .vertex.fx)
  40501. * @param attributesNamesOrOptions defines either a list of attribute names or an IEffectCreationOptions object
  40502. * @param uniformsNamesOrEngine defines either a list of uniform names or the engine to use
  40503. * @param samplers defines an array of string used to represent textures
  40504. * @param defines defines the string containing the defines to use to compile the shaders
  40505. * @param fallbacks defines the list of potential fallbacks to use if shader conmpilation fails
  40506. * @param onCompiled defines a function to call when the effect creation is successful
  40507. * @param onError defines a function to call when the effect creation has failed
  40508. * @param indexParameters defines an object containing the index values to use to compile shaders (like the maximum number of simultaneous lights)
  40509. * @returns the new Effect
  40510. */
  40511. 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;
  40512. protected static _ConcatenateShader(source: string, defines: Nullable<string>, shaderVersion?: string): string;
  40513. private _compileShader;
  40514. private _compileRawShader;
  40515. /** @hidden */
  40516. _getShaderSource(shader: WebGLShader): Nullable<string>;
  40517. /**
  40518. * Directly creates a webGL program
  40519. * @param pipelineContext defines the pipeline context to attach to
  40520. * @param vertexCode defines the vertex shader code to use
  40521. * @param fragmentCode defines the fragment shader code to use
  40522. * @param context defines the webGL context to use (if not set, the current one will be used)
  40523. * @param transformFeedbackVaryings defines the list of transform feedback varyings to use
  40524. * @returns the new webGL program
  40525. */
  40526. createRawShaderProgram(pipelineContext: IPipelineContext, vertexCode: string, fragmentCode: string, context?: WebGLRenderingContext, transformFeedbackVaryings?: Nullable<string[]>): WebGLProgram;
  40527. /**
  40528. * Creates a webGL program
  40529. * @param pipelineContext defines the pipeline context to attach to
  40530. * @param vertexCode defines the vertex shader code to use
  40531. * @param fragmentCode defines the fragment shader code to use
  40532. * @param defines defines the string containing the defines to use to compile the shaders
  40533. * @param context defines the webGL context to use (if not set, the current one will be used)
  40534. * @param transformFeedbackVaryings defines the list of transform feedback varyings to use
  40535. * @returns the new webGL program
  40536. */
  40537. createShaderProgram(pipelineContext: IPipelineContext, vertexCode: string, fragmentCode: string, defines: Nullable<string>, context?: WebGLRenderingContext, transformFeedbackVaryings?: Nullable<string[]>): WebGLProgram;
  40538. /**
  40539. * Creates a new pipeline context
  40540. * @returns the new pipeline
  40541. */
  40542. createPipelineContext(): IPipelineContext;
  40543. protected _createShaderProgram(pipelineContext: WebGLPipelineContext, vertexShader: WebGLShader, fragmentShader: WebGLShader, context: WebGLRenderingContext, transformFeedbackVaryings?: Nullable<string[]>): WebGLProgram;
  40544. protected _finalizePipelineContext(pipelineContext: WebGLPipelineContext): void;
  40545. /** @hidden */
  40546. _preparePipelineContext(pipelineContext: IPipelineContext, vertexSourceCode: string, fragmentSourceCode: string, createAsRaw: boolean, rebuildRebind: any, defines: Nullable<string>, transformFeedbackVaryings: Nullable<string[]>): void;
  40547. /** @hidden */
  40548. _isRenderingStateCompiled(pipelineContext: IPipelineContext): boolean;
  40549. /** @hidden */
  40550. _executeWhenRenderingStateIsCompiled(pipelineContext: IPipelineContext, action: () => void): void;
  40551. /**
  40552. * Gets the list of webGL uniform locations associated with a specific program based on a list of uniform names
  40553. * @param pipelineContext defines the pipeline context to use
  40554. * @param uniformsNames defines the list of uniform names
  40555. * @returns an array of webGL uniform locations
  40556. */
  40557. getUniforms(pipelineContext: IPipelineContext, uniformsNames: string[]): Nullable<WebGLUniformLocation>[];
  40558. /**
  40559. * Gets the lsit of active attributes for a given webGL program
  40560. * @param pipelineContext defines the pipeline context to use
  40561. * @param attributesNames defines the list of attribute names to get
  40562. * @returns an array of indices indicating the offset of each attribute
  40563. */
  40564. getAttributes(pipelineContext: IPipelineContext, attributesNames: string[]): number[];
  40565. /**
  40566. * Activates an effect, mkaing it the current one (ie. the one used for rendering)
  40567. * @param effect defines the effect to activate
  40568. */
  40569. enableEffect(effect: Nullable<Effect>): void;
  40570. /**
  40571. * Set the value of an uniform to a number (int)
  40572. * @param uniform defines the webGL uniform location where to store the value
  40573. * @param value defines the int number to store
  40574. * @returns true if the value was set
  40575. */
  40576. setInt(uniform: Nullable<WebGLUniformLocation>, value: number): boolean;
  40577. /**
  40578. * Set the value of an uniform to an array of int32
  40579. * @param uniform defines the webGL uniform location where to store the value
  40580. * @param array defines the array of int32 to store
  40581. * @returns true if the value was set
  40582. */
  40583. setIntArray(uniform: Nullable<WebGLUniformLocation>, array: Int32Array): boolean;
  40584. /**
  40585. * Set the value of an uniform to an array of int32 (stored as vec2)
  40586. * @param uniform defines the webGL uniform location where to store the value
  40587. * @param array defines the array of int32 to store
  40588. * @returns true if the value was set
  40589. */
  40590. setIntArray2(uniform: Nullable<WebGLUniformLocation>, array: Int32Array): boolean;
  40591. /**
  40592. * Set the value of an uniform to an array of int32 (stored as vec3)
  40593. * @param uniform defines the webGL uniform location where to store the value
  40594. * @param array defines the array of int32 to store
  40595. * @returns true if the value was set
  40596. */
  40597. setIntArray3(uniform: Nullable<WebGLUniformLocation>, array: Int32Array): boolean;
  40598. /**
  40599. * Set the value of an uniform to an array of int32 (stored as vec4)
  40600. * @param uniform defines the webGL uniform location where to store the value
  40601. * @param array defines the array of int32 to store
  40602. * @returns true if the value was set
  40603. */
  40604. setIntArray4(uniform: Nullable<WebGLUniformLocation>, array: Int32Array): boolean;
  40605. /**
  40606. * Set the value of an uniform to an array of number
  40607. * @param uniform defines the webGL uniform location where to store the value
  40608. * @param array defines the array of number to store
  40609. * @returns true if the value was set
  40610. */
  40611. setArray(uniform: Nullable<WebGLUniformLocation>, array: number[] | Float32Array): boolean;
  40612. /**
  40613. * Set the value of an uniform to an array of number (stored as vec2)
  40614. * @param uniform defines the webGL uniform location where to store the value
  40615. * @param array defines the array of number to store
  40616. * @returns true if the value was set
  40617. */
  40618. setArray2(uniform: Nullable<WebGLUniformLocation>, array: number[] | Float32Array): boolean;
  40619. /**
  40620. * Set the value of an uniform to an array of number (stored as vec3)
  40621. * @param uniform defines the webGL uniform location where to store the value
  40622. * @param array defines the array of number to store
  40623. * @returns true if the value was set
  40624. */
  40625. setArray3(uniform: Nullable<WebGLUniformLocation>, array: number[] | Float32Array): boolean;
  40626. /**
  40627. * Set the value of an uniform to an array of number (stored as vec4)
  40628. * @param uniform defines the webGL uniform location where to store the value
  40629. * @param array defines the array of number to store
  40630. * @returns true if the value was set
  40631. */
  40632. setArray4(uniform: Nullable<WebGLUniformLocation>, array: number[] | Float32Array): boolean;
  40633. /**
  40634. * Set the value of an uniform to an array of float32 (stored as matrices)
  40635. * @param uniform defines the webGL uniform location where to store the value
  40636. * @param matrices defines the array of float32 to store
  40637. * @returns true if the value was set
  40638. */
  40639. setMatrices(uniform: Nullable<WebGLUniformLocation>, matrices: Float32Array): boolean;
  40640. /**
  40641. * Set the value of an uniform to a matrix (3x3)
  40642. * @param uniform defines the webGL uniform location where to store the value
  40643. * @param matrix defines the Float32Array representing the 3x3 matrix to store
  40644. * @returns true if the value was set
  40645. */
  40646. setMatrix3x3(uniform: Nullable<WebGLUniformLocation>, matrix: Float32Array): boolean;
  40647. /**
  40648. * Set the value of an uniform to a matrix (2x2)
  40649. * @param uniform defines the webGL uniform location where to store the value
  40650. * @param matrix defines the Float32Array representing the 2x2 matrix to store
  40651. * @returns true if the value was set
  40652. */
  40653. setMatrix2x2(uniform: Nullable<WebGLUniformLocation>, matrix: Float32Array): boolean;
  40654. /**
  40655. * Set the value of an uniform to a number (float)
  40656. * @param uniform defines the webGL uniform location where to store the value
  40657. * @param value defines the float number to store
  40658. * @returns true if the value was transfered
  40659. */
  40660. setFloat(uniform: Nullable<WebGLUniformLocation>, value: number): boolean;
  40661. /**
  40662. * Set the value of an uniform to a vec2
  40663. * @param uniform defines the webGL uniform location where to store the value
  40664. * @param x defines the 1st component of the value
  40665. * @param y defines the 2nd component of the value
  40666. * @returns true if the value was set
  40667. */
  40668. setFloat2(uniform: Nullable<WebGLUniformLocation>, x: number, y: number): boolean;
  40669. /**
  40670. * Set the value of an uniform to a vec3
  40671. * @param uniform defines the webGL uniform location where to store the value
  40672. * @param x defines the 1st component of the value
  40673. * @param y defines the 2nd component of the value
  40674. * @param z defines the 3rd component of the value
  40675. * @returns true if the value was set
  40676. */
  40677. setFloat3(uniform: Nullable<WebGLUniformLocation>, x: number, y: number, z: number): boolean;
  40678. /**
  40679. * Set the value of an uniform to a vec4
  40680. * @param uniform defines the webGL uniform location where to store the value
  40681. * @param x defines the 1st component of the value
  40682. * @param y defines the 2nd component of the value
  40683. * @param z defines the 3rd component of the value
  40684. * @param w defines the 4th component of the value
  40685. * @returns true if the value was set
  40686. */
  40687. setFloat4(uniform: Nullable<WebGLUniformLocation>, x: number, y: number, z: number, w: number): boolean;
  40688. /**
  40689. * Apply all cached states (depth, culling, stencil and alpha)
  40690. */
  40691. applyStates(): void;
  40692. /**
  40693. * Enable or disable color writing
  40694. * @param enable defines the state to set
  40695. */
  40696. setColorWrite(enable: boolean): void;
  40697. /**
  40698. * Gets a boolean indicating if color writing is enabled
  40699. * @returns the current color writing state
  40700. */
  40701. getColorWrite(): boolean;
  40702. /**
  40703. * Gets the depth culling state manager
  40704. */
  40705. get depthCullingState(): DepthCullingState;
  40706. /**
  40707. * Gets the alpha state manager
  40708. */
  40709. get alphaState(): AlphaState;
  40710. /**
  40711. * Gets the stencil state manager
  40712. */
  40713. get stencilState(): StencilState;
  40714. /**
  40715. * Clears the list of texture accessible through engine.
  40716. * This can help preventing texture load conflict due to name collision.
  40717. */
  40718. clearInternalTexturesCache(): void;
  40719. /**
  40720. * Force the entire cache to be cleared
  40721. * You should not have to use this function unless your engine needs to share the webGL context with another engine
  40722. * @param bruteForce defines a boolean to force clearing ALL caches (including stencil, detoh and alpha states)
  40723. */
  40724. wipeCaches(bruteForce?: boolean): void;
  40725. /** @hidden */
  40726. _getSamplingParameters(samplingMode: number, generateMipMaps: boolean): {
  40727. min: number;
  40728. mag: number;
  40729. };
  40730. /** @hidden */
  40731. _createTexture(): WebGLTexture;
  40732. /**
  40733. * Usually called from Texture.ts.
  40734. * Passed information to create a WebGLTexture
  40735. * @param url defines a value which contains one of the following:
  40736. * * A conventional http URL, e.g. 'http://...' or 'file://...'
  40737. * * A base64 string of in-line texture data, e.g. 'data:image/jpg;base64,/...'
  40738. * * An indicator that data being passed using the buffer parameter, e.g. 'data:mytexture.jpg'
  40739. * @param noMipmap defines a boolean indicating that no mipmaps shall be generated. Ignored for compressed textures. They must be in the file
  40740. * @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)
  40741. * @param scene needed for loading to the correct scene
  40742. * @param samplingMode mode with should be used sample / access the texture (Default: Texture.TRILINEAR_SAMPLINGMODE)
  40743. * @param onLoad optional callback to be called upon successful completion
  40744. * @param onError optional callback to be called upon failure
  40745. * @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
  40746. * @param fallback an internal argument in case the function must be called again, due to etc1 not having alpha capabilities
  40747. * @param format internal format. Default: RGB when extension is '.jpg' else RGBA. Ignored for compressed textures
  40748. * @param forcedExtension defines the extension to use to pick the right loader
  40749. * @param mimeType defines an optional mime type
  40750. * @returns a InternalTexture for assignment back into BABYLON.Texture
  40751. */
  40752. 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;
  40753. /**
  40754. * Loads an image as an HTMLImageElement.
  40755. * @param input url string, ArrayBuffer, or Blob to load
  40756. * @param onLoad callback called when the image successfully loads
  40757. * @param onError callback called when the image fails to load
  40758. * @param offlineProvider offline provider for caching
  40759. * @param mimeType optional mime type
  40760. * @returns the HTMLImageElement of the loaded image
  40761. * @hidden
  40762. */
  40763. 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>;
  40764. /**
  40765. * @hidden
  40766. */
  40767. _rescaleTexture(source: InternalTexture, destination: InternalTexture, scene: Nullable<any>, internalFormat: number, onComplete: () => void): void;
  40768. private _unpackFlipYCached;
  40769. /**
  40770. * In case you are sharing the context with other applications, it might
  40771. * be interested to not cache the unpack flip y state to ensure a consistent
  40772. * value would be set.
  40773. */
  40774. enableUnpackFlipYCached: boolean;
  40775. /** @hidden */
  40776. _unpackFlipY(value: boolean): void;
  40777. /** @hidden */
  40778. _getUnpackAlignement(): number;
  40779. private _getTextureTarget;
  40780. /**
  40781. * Update the sampling mode of a given texture
  40782. * @param samplingMode defines the required sampling mode
  40783. * @param texture defines the texture to update
  40784. * @param generateMipMaps defines whether to generate mipmaps for the texture
  40785. */
  40786. updateTextureSamplingMode(samplingMode: number, texture: InternalTexture, generateMipMaps?: boolean): void;
  40787. /**
  40788. * Update the sampling mode of a given texture
  40789. * @param texture defines the texture to update
  40790. * @param wrapU defines the texture wrap mode of the u coordinates
  40791. * @param wrapV defines the texture wrap mode of the v coordinates
  40792. * @param wrapR defines the texture wrap mode of the r coordinates
  40793. */
  40794. updateTextureWrappingMode(texture: InternalTexture, wrapU: Nullable<number>, wrapV?: Nullable<number>, wrapR?: Nullable<number>): void;
  40795. /** @hidden */
  40796. _setupDepthStencilTexture(internalTexture: InternalTexture, size: number | {
  40797. width: number;
  40798. height: number;
  40799. layers?: number;
  40800. }, generateStencil: boolean, bilinearFiltering: boolean, comparisonFunction: number): void;
  40801. /** @hidden */
  40802. _uploadCompressedDataToTextureDirectly(texture: InternalTexture, internalFormat: number, width: number, height: number, data: ArrayBufferView, faceIndex?: number, lod?: number): void;
  40803. /** @hidden */
  40804. _uploadDataToTextureDirectly(texture: InternalTexture, imageData: ArrayBufferView, faceIndex?: number, lod?: number, babylonInternalFormat?: number, useTextureWidthAndHeight?: boolean): void;
  40805. /**
  40806. * Update a portion of an internal texture
  40807. * @param texture defines the texture to update
  40808. * @param imageData defines the data to store into the texture
  40809. * @param xOffset defines the x coordinates of the update rectangle
  40810. * @param yOffset defines the y coordinates of the update rectangle
  40811. * @param width defines the width of the update rectangle
  40812. * @param height defines the height of the update rectangle
  40813. * @param faceIndex defines the face index if texture is a cube (0 by default)
  40814. * @param lod defines the lod level to update (0 by default)
  40815. */
  40816. updateTextureData(texture: InternalTexture, imageData: ArrayBufferView, xOffset: number, yOffset: number, width: number, height: number, faceIndex?: number, lod?: number): void;
  40817. /** @hidden */
  40818. _uploadArrayBufferViewToTexture(texture: InternalTexture, imageData: ArrayBufferView, faceIndex?: number, lod?: number): void;
  40819. protected _prepareWebGLTextureContinuation(texture: InternalTexture, scene: Nullable<ISceneLike>, noMipmap: boolean, isCompressed: boolean, samplingMode: number): void;
  40820. private _prepareWebGLTexture;
  40821. /** @hidden */
  40822. _setupFramebufferDepthAttachments(generateStencilBuffer: boolean, generateDepthBuffer: boolean, width: number, height: number, samples?: number): Nullable<WebGLRenderbuffer>;
  40823. private _getDepthStencilBuffer;
  40824. /** @hidden */
  40825. _releaseFramebufferObjects(texture: InternalTexture): void;
  40826. /** @hidden */
  40827. _releaseTexture(texture: InternalTexture): void;
  40828. protected _deleteTexture(texture: Nullable<WebGLTexture>): void;
  40829. protected _setProgram(program: WebGLProgram): void;
  40830. protected _boundUniforms: {
  40831. [key: number]: WebGLUniformLocation;
  40832. };
  40833. /**
  40834. * Binds an effect to the webGL context
  40835. * @param effect defines the effect to bind
  40836. */
  40837. bindSamplers(effect: Effect): void;
  40838. private _activateCurrentTexture;
  40839. /** @hidden */
  40840. _bindTextureDirectly(target: number, texture: Nullable<InternalTexture>, forTextureDataUpdate?: boolean, force?: boolean): boolean;
  40841. /** @hidden */
  40842. _bindTexture(channel: number, texture: Nullable<InternalTexture>): void;
  40843. /**
  40844. * Unbind all textures from the webGL context
  40845. */
  40846. unbindAllTextures(): void;
  40847. /**
  40848. * Sets a texture to the according uniform.
  40849. * @param channel The texture channel
  40850. * @param uniform The uniform to set
  40851. * @param texture The texture to apply
  40852. */
  40853. setTexture(channel: number, uniform: Nullable<WebGLUniformLocation>, texture: Nullable<BaseTexture>): void;
  40854. private _bindSamplerUniformToChannel;
  40855. private _getTextureWrapMode;
  40856. protected _setTexture(channel: number, texture: Nullable<BaseTexture>, isPartOfTextureArray?: boolean, depthStencilTexture?: boolean): boolean;
  40857. /**
  40858. * Sets an array of texture to the webGL context
  40859. * @param channel defines the channel where the texture array must be set
  40860. * @param uniform defines the associated uniform location
  40861. * @param textures defines the array of textures to bind
  40862. */
  40863. setTextureArray(channel: number, uniform: Nullable<WebGLUniformLocation>, textures: BaseTexture[]): void;
  40864. /** @hidden */
  40865. _setAnisotropicLevel(target: number, internalTexture: InternalTexture, anisotropicFilteringLevel: number): void;
  40866. private _setTextureParameterFloat;
  40867. private _setTextureParameterInteger;
  40868. /**
  40869. * Unbind all vertex attributes from the webGL context
  40870. */
  40871. unbindAllAttributes(): void;
  40872. /**
  40873. * 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
  40874. */
  40875. releaseEffects(): void;
  40876. /**
  40877. * Dispose and release all associated resources
  40878. */
  40879. dispose(): void;
  40880. /**
  40881. * Attach a new callback raised when context lost event is fired
  40882. * @param callback defines the callback to call
  40883. */
  40884. attachContextLostEvent(callback: ((event: WebGLContextEvent) => void)): void;
  40885. /**
  40886. * Attach a new callback raised when context restored event is fired
  40887. * @param callback defines the callback to call
  40888. */
  40889. attachContextRestoredEvent(callback: ((event: WebGLContextEvent) => void)): void;
  40890. /**
  40891. * Get the current error code of the webGL context
  40892. * @returns the error code
  40893. * @see https://developer.mozilla.org/en-US/docs/Web/API/WebGLRenderingContext/getError
  40894. */
  40895. getError(): number;
  40896. private _canRenderToFloatFramebuffer;
  40897. private _canRenderToHalfFloatFramebuffer;
  40898. private _canRenderToFramebuffer;
  40899. /** @hidden */
  40900. _getWebGLTextureType(type: number): number;
  40901. /** @hidden */
  40902. _getInternalFormat(format: number): number;
  40903. /** @hidden */
  40904. _getRGBABufferInternalSizedFormat(type: number, format?: number): number;
  40905. /** @hidden */
  40906. _getRGBAMultiSampleBufferFormat(type: number): number;
  40907. /** @hidden */
  40908. _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;
  40909. /**
  40910. * Loads a file from a url
  40911. * @param url url to load
  40912. * @param onSuccess callback called when the file successfully loads
  40913. * @param onProgress callback called while file is loading (if the server supports this mode)
  40914. * @param offlineProvider defines the offline provider for caching
  40915. * @param useArrayBuffer defines a boolean indicating that date must be returned as ArrayBuffer
  40916. * @param onError callback called when the file fails to load
  40917. * @returns a file request object
  40918. * @hidden
  40919. */
  40920. 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;
  40921. /**
  40922. * Reads pixels from the current frame buffer. Please note that this function can be slow
  40923. * @param x defines the x coordinate of the rectangle where pixels must be read
  40924. * @param y defines the y coordinate of the rectangle where pixels must be read
  40925. * @param width defines the width of the rectangle where pixels must be read
  40926. * @param height defines the height of the rectangle where pixels must be read
  40927. * @param hasAlpha defines whether the output should have alpha or not (defaults to true)
  40928. * @returns a Uint8Array containing RGBA colors
  40929. */
  40930. readPixels(x: number, y: number, width: number, height: number, hasAlpha?: boolean): Uint8Array;
  40931. private static _IsSupported;
  40932. private static _HasMajorPerformanceCaveat;
  40933. /**
  40934. * Gets a boolean indicating if the engine can be instanciated (ie. if a webGL context can be found)
  40935. */
  40936. static get IsSupported(): boolean;
  40937. /**
  40938. * Gets a boolean indicating if the engine can be instanciated (ie. if a webGL context can be found)
  40939. * @returns true if the engine can be created
  40940. * @ignorenaming
  40941. */
  40942. static isSupported(): boolean;
  40943. /**
  40944. * Gets a boolean indicating if the engine can be instanciated on a performant device (ie. if a webGL context can be found and it does not use a slow implementation)
  40945. */
  40946. static get HasMajorPerformanceCaveat(): boolean;
  40947. /**
  40948. * Find the next highest power of two.
  40949. * @param x Number to start search from.
  40950. * @return Next highest power of two.
  40951. */
  40952. static CeilingPOT(x: number): number;
  40953. /**
  40954. * Find the next lowest power of two.
  40955. * @param x Number to start search from.
  40956. * @return Next lowest power of two.
  40957. */
  40958. static FloorPOT(x: number): number;
  40959. /**
  40960. * Find the nearest power of two.
  40961. * @param x Number to start search from.
  40962. * @return Next nearest power of two.
  40963. */
  40964. static NearestPOT(x: number): number;
  40965. /**
  40966. * Get the closest exponent of two
  40967. * @param value defines the value to approximate
  40968. * @param max defines the maximum value to return
  40969. * @param mode defines how to define the closest value
  40970. * @returns closest exponent of two of the given value
  40971. */
  40972. static GetExponentOfTwo(value: number, max: number, mode?: number): number;
  40973. /**
  40974. * Queue a new function into the requested animation frame pool (ie. this function will be executed byt the browser for the next frame)
  40975. * @param func - the function to be called
  40976. * @param requester - the object that will request the next frame. Falls back to window.
  40977. * @returns frame number
  40978. */
  40979. static QueueNewFrame(func: () => void, requester?: any): number;
  40980. /**
  40981. * Gets host document
  40982. * @returns the host document object
  40983. */
  40984. getHostDocument(): Nullable<Document>;
  40985. }
  40986. }
  40987. declare module "babylonjs/Materials/Textures/internalTexture" {
  40988. import { Observable } from "babylonjs/Misc/observable";
  40989. import { Nullable, int } from "babylonjs/types";
  40990. import { ThinEngine } from "babylonjs/Engines/thinEngine";
  40991. import { BaseTexture } from "babylonjs/Materials/Textures/baseTexture";
  40992. import { SphericalPolynomial } from "babylonjs/Maths/sphericalPolynomial";
  40993. /**
  40994. * Defines the source of the internal texture
  40995. */
  40996. export enum InternalTextureSource {
  40997. /**
  40998. * The source of the texture data is unknown
  40999. */
  41000. Unknown = 0,
  41001. /**
  41002. * Texture data comes from an URL
  41003. */
  41004. Url = 1,
  41005. /**
  41006. * Texture data is only used for temporary storage
  41007. */
  41008. Temp = 2,
  41009. /**
  41010. * Texture data comes from raw data (ArrayBuffer)
  41011. */
  41012. Raw = 3,
  41013. /**
  41014. * Texture content is dynamic (video or dynamic texture)
  41015. */
  41016. Dynamic = 4,
  41017. /**
  41018. * Texture content is generated by rendering to it
  41019. */
  41020. RenderTarget = 5,
  41021. /**
  41022. * Texture content is part of a multi render target process
  41023. */
  41024. MultiRenderTarget = 6,
  41025. /**
  41026. * Texture data comes from a cube data file
  41027. */
  41028. Cube = 7,
  41029. /**
  41030. * Texture data comes from a raw cube data
  41031. */
  41032. CubeRaw = 8,
  41033. /**
  41034. * Texture data come from a prefiltered cube data file
  41035. */
  41036. CubePrefiltered = 9,
  41037. /**
  41038. * Texture content is raw 3D data
  41039. */
  41040. Raw3D = 10,
  41041. /**
  41042. * Texture content is raw 2D array data
  41043. */
  41044. Raw2DArray = 11,
  41045. /**
  41046. * Texture content is a depth texture
  41047. */
  41048. Depth = 12,
  41049. /**
  41050. * Texture data comes from a raw cube data encoded with RGBD
  41051. */
  41052. CubeRawRGBD = 13
  41053. }
  41054. /**
  41055. * Class used to store data associated with WebGL texture data for the engine
  41056. * This class should not be used directly
  41057. */
  41058. export class InternalTexture {
  41059. /** @hidden */
  41060. static _UpdateRGBDAsync: (internalTexture: InternalTexture, data: ArrayBufferView[][], sphericalPolynomial: Nullable<SphericalPolynomial>, lodScale: number, lodOffset: number) => Promise<void>;
  41061. /**
  41062. * Defines if the texture is ready
  41063. */
  41064. isReady: boolean;
  41065. /**
  41066. * Defines if the texture is a cube texture
  41067. */
  41068. isCube: boolean;
  41069. /**
  41070. * Defines if the texture contains 3D data
  41071. */
  41072. is3D: boolean;
  41073. /**
  41074. * Defines if the texture contains 2D array data
  41075. */
  41076. is2DArray: boolean;
  41077. /**
  41078. * Defines if the texture contains multiview data
  41079. */
  41080. isMultiview: boolean;
  41081. /**
  41082. * Gets the URL used to load this texture
  41083. */
  41084. url: string;
  41085. /**
  41086. * Gets the sampling mode of the texture
  41087. */
  41088. samplingMode: number;
  41089. /**
  41090. * Gets a boolean indicating if the texture needs mipmaps generation
  41091. */
  41092. generateMipMaps: boolean;
  41093. /**
  41094. * Gets the number of samples used by the texture (WebGL2+ only)
  41095. */
  41096. samples: number;
  41097. /**
  41098. * Gets the type of the texture (int, float...)
  41099. */
  41100. type: number;
  41101. /**
  41102. * Gets the format of the texture (RGB, RGBA...)
  41103. */
  41104. format: number;
  41105. /**
  41106. * Observable called when the texture is loaded
  41107. */
  41108. onLoadedObservable: Observable<InternalTexture>;
  41109. /**
  41110. * Gets the width of the texture
  41111. */
  41112. width: number;
  41113. /**
  41114. * Gets the height of the texture
  41115. */
  41116. height: number;
  41117. /**
  41118. * Gets the depth of the texture
  41119. */
  41120. depth: number;
  41121. /**
  41122. * Gets the initial width of the texture (It could be rescaled if the current system does not support non power of two textures)
  41123. */
  41124. baseWidth: number;
  41125. /**
  41126. * Gets the initial height of the texture (It could be rescaled if the current system does not support non power of two textures)
  41127. */
  41128. baseHeight: number;
  41129. /**
  41130. * Gets the initial depth of the texture (It could be rescaled if the current system does not support non power of two textures)
  41131. */
  41132. baseDepth: number;
  41133. /**
  41134. * Gets a boolean indicating if the texture is inverted on Y axis
  41135. */
  41136. invertY: boolean;
  41137. /** @hidden */
  41138. _invertVScale: boolean;
  41139. /** @hidden */
  41140. _associatedChannel: number;
  41141. /** @hidden */
  41142. _source: InternalTextureSource;
  41143. /** @hidden */
  41144. _buffer: Nullable<string | ArrayBuffer | ArrayBufferView | HTMLImageElement | Blob | ImageBitmap>;
  41145. /** @hidden */
  41146. _bufferView: Nullable<ArrayBufferView>;
  41147. /** @hidden */
  41148. _bufferViewArray: Nullable<ArrayBufferView[]>;
  41149. /** @hidden */
  41150. _bufferViewArrayArray: Nullable<ArrayBufferView[][]>;
  41151. /** @hidden */
  41152. _size: number;
  41153. /** @hidden */
  41154. _extension: string;
  41155. /** @hidden */
  41156. _files: Nullable<string[]>;
  41157. /** @hidden */
  41158. _workingCanvas: Nullable<HTMLCanvasElement | OffscreenCanvas>;
  41159. /** @hidden */
  41160. _workingContext: Nullable<CanvasRenderingContext2D | OffscreenCanvasRenderingContext2D>;
  41161. /** @hidden */
  41162. _framebuffer: Nullable<WebGLFramebuffer>;
  41163. /** @hidden */
  41164. _depthStencilBuffer: Nullable<WebGLRenderbuffer>;
  41165. /** @hidden */
  41166. _MSAAFramebuffer: Nullable<WebGLFramebuffer>;
  41167. /** @hidden */
  41168. _MSAARenderBuffer: Nullable<WebGLRenderbuffer>;
  41169. /** @hidden */
  41170. _attachments: Nullable<number[]>;
  41171. /** @hidden */
  41172. _textureArray: Nullable<InternalTexture[]>;
  41173. /** @hidden */
  41174. _cachedCoordinatesMode: Nullable<number>;
  41175. /** @hidden */
  41176. _cachedWrapU: Nullable<number>;
  41177. /** @hidden */
  41178. _cachedWrapV: Nullable<number>;
  41179. /** @hidden */
  41180. _cachedWrapR: Nullable<number>;
  41181. /** @hidden */
  41182. _cachedAnisotropicFilteringLevel: Nullable<number>;
  41183. /** @hidden */
  41184. _isDisabled: boolean;
  41185. /** @hidden */
  41186. _compression: Nullable<string>;
  41187. /** @hidden */
  41188. _generateStencilBuffer: boolean;
  41189. /** @hidden */
  41190. _generateDepthBuffer: boolean;
  41191. /** @hidden */
  41192. _comparisonFunction: number;
  41193. /** @hidden */
  41194. _sphericalPolynomial: Nullable<SphericalPolynomial>;
  41195. /** @hidden */
  41196. _lodGenerationScale: number;
  41197. /** @hidden */
  41198. _lodGenerationOffset: number;
  41199. /** @hidden */
  41200. _depthStencilTexture: Nullable<InternalTexture>;
  41201. /** @hidden */
  41202. _colorTextureArray: Nullable<WebGLTexture>;
  41203. /** @hidden */
  41204. _depthStencilTextureArray: Nullable<WebGLTexture>;
  41205. /** @hidden */
  41206. _lodTextureHigh: Nullable<BaseTexture>;
  41207. /** @hidden */
  41208. _lodTextureMid: Nullable<BaseTexture>;
  41209. /** @hidden */
  41210. _lodTextureLow: Nullable<BaseTexture>;
  41211. /** @hidden */
  41212. _isRGBD: boolean;
  41213. /** @hidden */
  41214. _linearSpecularLOD: boolean;
  41215. /** @hidden */
  41216. _irradianceTexture: Nullable<BaseTexture>;
  41217. /** @hidden */
  41218. _webGLTexture: Nullable<WebGLTexture>;
  41219. /** @hidden */
  41220. _references: number;
  41221. /** @hidden */
  41222. _gammaSpace: Nullable<boolean>;
  41223. private _engine;
  41224. /**
  41225. * Gets the Engine the texture belongs to.
  41226. * @returns The babylon engine
  41227. */
  41228. getEngine(): ThinEngine;
  41229. /**
  41230. * Gets the data source type of the texture
  41231. */
  41232. get source(): InternalTextureSource;
  41233. /**
  41234. * Creates a new InternalTexture
  41235. * @param engine defines the engine to use
  41236. * @param source defines the type of data that will be used
  41237. * @param delayAllocation if the texture allocation should be delayed (default: false)
  41238. */
  41239. constructor(engine: ThinEngine, source: InternalTextureSource, delayAllocation?: boolean);
  41240. /**
  41241. * Increments the number of references (ie. the number of Texture that point to it)
  41242. */
  41243. incrementReferences(): void;
  41244. /**
  41245. * Change the size of the texture (not the size of the content)
  41246. * @param width defines the new width
  41247. * @param height defines the new height
  41248. * @param depth defines the new depth (1 by default)
  41249. */
  41250. updateSize(width: int, height: int, depth?: int): void;
  41251. /** @hidden */
  41252. _rebuild(): void;
  41253. /** @hidden */
  41254. _swapAndDie(target: InternalTexture): void;
  41255. /**
  41256. * Dispose the current allocated resources
  41257. */
  41258. dispose(): void;
  41259. }
  41260. }
  41261. declare module "babylonjs/Audio/analyser" {
  41262. import { Scene } from "babylonjs/scene";
  41263. /**
  41264. * Class used to work with sound analyzer using fast fourier transform (FFT)
  41265. * @see https://doc.babylonjs.com/how_to/playing_sounds_and_music
  41266. */
  41267. export class Analyser {
  41268. /**
  41269. * Gets or sets the smoothing
  41270. * @ignorenaming
  41271. */
  41272. SMOOTHING: number;
  41273. /**
  41274. * Gets or sets the FFT table size
  41275. * @ignorenaming
  41276. */
  41277. FFT_SIZE: number;
  41278. /**
  41279. * Gets or sets the bar graph amplitude
  41280. * @ignorenaming
  41281. */
  41282. BARGRAPHAMPLITUDE: number;
  41283. /**
  41284. * Gets or sets the position of the debug canvas
  41285. * @ignorenaming
  41286. */
  41287. DEBUGCANVASPOS: {
  41288. x: number;
  41289. y: number;
  41290. };
  41291. /**
  41292. * Gets or sets the debug canvas size
  41293. * @ignorenaming
  41294. */
  41295. DEBUGCANVASSIZE: {
  41296. width: number;
  41297. height: number;
  41298. };
  41299. private _byteFreqs;
  41300. private _byteTime;
  41301. private _floatFreqs;
  41302. private _webAudioAnalyser;
  41303. private _debugCanvas;
  41304. private _debugCanvasContext;
  41305. private _scene;
  41306. private _registerFunc;
  41307. private _audioEngine;
  41308. /**
  41309. * Creates a new analyser
  41310. * @param scene defines hosting scene
  41311. */
  41312. constructor(scene: Scene);
  41313. /**
  41314. * Get the number of data values you will have to play with for the visualization
  41315. * @see https://developer.mozilla.org/en-US/docs/Web/API/AnalyserNode/frequencyBinCount
  41316. * @returns a number
  41317. */
  41318. getFrequencyBinCount(): number;
  41319. /**
  41320. * Gets the current frequency data as a byte array
  41321. * @see https://developer.mozilla.org/en-US/docs/Web/API/AnalyserNode/getByteFrequencyData
  41322. * @returns a Uint8Array
  41323. */
  41324. getByteFrequencyData(): Uint8Array;
  41325. /**
  41326. * Gets the current waveform as a byte array
  41327. * @see https://developer.mozilla.org/en-US/docs/Web/API/AnalyserNode/getByteTimeDomainData
  41328. * @returns a Uint8Array
  41329. */
  41330. getByteTimeDomainData(): Uint8Array;
  41331. /**
  41332. * Gets the current frequency data as a float array
  41333. * @see https://developer.mozilla.org/en-US/docs/Web/API/AnalyserNode/getByteFrequencyData
  41334. * @returns a Float32Array
  41335. */
  41336. getFloatFrequencyData(): Float32Array;
  41337. /**
  41338. * Renders the debug canvas
  41339. */
  41340. drawDebugCanvas(): void;
  41341. /**
  41342. * Stops rendering the debug canvas and removes it
  41343. */
  41344. stopDebugCanvas(): void;
  41345. /**
  41346. * Connects two audio nodes
  41347. * @param inputAudioNode defines first node to connect
  41348. * @param outputAudioNode defines second node to connect
  41349. */
  41350. connectAudioNodes(inputAudioNode: AudioNode, outputAudioNode: AudioNode): void;
  41351. /**
  41352. * Releases all associated resources
  41353. */
  41354. dispose(): void;
  41355. }
  41356. }
  41357. declare module "babylonjs/Audio/audioEngine" {
  41358. import { IDisposable } from "babylonjs/scene";
  41359. import { Analyser } from "babylonjs/Audio/analyser";
  41360. import { Nullable } from "babylonjs/types";
  41361. import { Observable } from "babylonjs/Misc/observable";
  41362. /**
  41363. * This represents an audio engine and it is responsible
  41364. * to play, synchronize and analyse sounds throughout the application.
  41365. * @see https://doc.babylonjs.com/how_to/playing_sounds_and_music
  41366. */
  41367. export interface IAudioEngine extends IDisposable {
  41368. /**
  41369. * Gets whether the current host supports Web Audio and thus could create AudioContexts.
  41370. */
  41371. readonly canUseWebAudio: boolean;
  41372. /**
  41373. * Gets the current AudioContext if available.
  41374. */
  41375. readonly audioContext: Nullable<AudioContext>;
  41376. /**
  41377. * The master gain node defines the global audio volume of your audio engine.
  41378. */
  41379. readonly masterGain: GainNode;
  41380. /**
  41381. * Gets whether or not mp3 are supported by your browser.
  41382. */
  41383. readonly isMP3supported: boolean;
  41384. /**
  41385. * Gets whether or not ogg are supported by your browser.
  41386. */
  41387. readonly isOGGsupported: boolean;
  41388. /**
  41389. * Defines if Babylon should emit a warning if WebAudio is not supported.
  41390. * @ignoreNaming
  41391. */
  41392. WarnedWebAudioUnsupported: boolean;
  41393. /**
  41394. * Defines if the audio engine relies on a custom unlocked button.
  41395. * In this case, the embedded button will not be displayed.
  41396. */
  41397. useCustomUnlockedButton: boolean;
  41398. /**
  41399. * Gets whether or not the audio engine is unlocked (require first a user gesture on some browser).
  41400. */
  41401. readonly unlocked: boolean;
  41402. /**
  41403. * Event raised when audio has been unlocked on the browser.
  41404. */
  41405. onAudioUnlockedObservable: Observable<AudioEngine>;
  41406. /**
  41407. * Event raised when audio has been locked on the browser.
  41408. */
  41409. onAudioLockedObservable: Observable<AudioEngine>;
  41410. /**
  41411. * Flags the audio engine in Locked state.
  41412. * This happens due to new browser policies preventing audio to autoplay.
  41413. */
  41414. lock(): void;
  41415. /**
  41416. * Unlocks the audio engine once a user action has been done on the dom.
  41417. * This is helpful to resume play once browser policies have been satisfied.
  41418. */
  41419. unlock(): void;
  41420. /**
  41421. * Gets the global volume sets on the master gain.
  41422. * @returns the global volume if set or -1 otherwise
  41423. */
  41424. getGlobalVolume(): number;
  41425. /**
  41426. * Sets the global volume of your experience (sets on the master gain).
  41427. * @param newVolume Defines the new global volume of the application
  41428. */
  41429. setGlobalVolume(newVolume: number): void;
  41430. /**
  41431. * Connect the audio engine to an audio analyser allowing some amazing
  41432. * synchornization between the sounds/music and your visualization (VuMeter for instance).
  41433. * @see https://doc.babylonjs.com/how_to/playing_sounds_and_music#using-the-analyser
  41434. * @param analyser The analyser to connect to the engine
  41435. */
  41436. connectToAnalyser(analyser: Analyser): void;
  41437. }
  41438. /**
  41439. * This represents the default audio engine used in babylon.
  41440. * It is responsible to play, synchronize and analyse sounds throughout the application.
  41441. * @see https://doc.babylonjs.com/how_to/playing_sounds_and_music
  41442. */
  41443. export class AudioEngine implements IAudioEngine {
  41444. private _audioContext;
  41445. private _audioContextInitialized;
  41446. private _muteButton;
  41447. private _hostElement;
  41448. /**
  41449. * Gets whether the current host supports Web Audio and thus could create AudioContexts.
  41450. */
  41451. canUseWebAudio: boolean;
  41452. /**
  41453. * The master gain node defines the global audio volume of your audio engine.
  41454. */
  41455. masterGain: GainNode;
  41456. /**
  41457. * Defines if Babylon should emit a warning if WebAudio is not supported.
  41458. * @ignoreNaming
  41459. */
  41460. WarnedWebAudioUnsupported: boolean;
  41461. /**
  41462. * Gets whether or not mp3 are supported by your browser.
  41463. */
  41464. isMP3supported: boolean;
  41465. /**
  41466. * Gets whether or not ogg are supported by your browser.
  41467. */
  41468. isOGGsupported: boolean;
  41469. /**
  41470. * Gets whether audio has been unlocked on the device.
  41471. * Some Browsers have strong restrictions about Audio and won t autoplay unless
  41472. * a user interaction has happened.
  41473. */
  41474. unlocked: boolean;
  41475. /**
  41476. * Defines if the audio engine relies on a custom unlocked button.
  41477. * In this case, the embedded button will not be displayed.
  41478. */
  41479. useCustomUnlockedButton: boolean;
  41480. /**
  41481. * Event raised when audio has been unlocked on the browser.
  41482. */
  41483. onAudioUnlockedObservable: Observable<AudioEngine>;
  41484. /**
  41485. * Event raised when audio has been locked on the browser.
  41486. */
  41487. onAudioLockedObservable: Observable<AudioEngine>;
  41488. /**
  41489. * Gets the current AudioContext if available.
  41490. */
  41491. get audioContext(): Nullable<AudioContext>;
  41492. private _connectedAnalyser;
  41493. /**
  41494. * Instantiates a new audio engine.
  41495. *
  41496. * There should be only one per page as some browsers restrict the number
  41497. * of audio contexts you can create.
  41498. * @param hostElement defines the host element where to display the mute icon if necessary
  41499. */
  41500. constructor(hostElement?: Nullable<HTMLElement>);
  41501. /**
  41502. * Flags the audio engine in Locked state.
  41503. * This happens due to new browser policies preventing audio to autoplay.
  41504. */
  41505. lock(): void;
  41506. /**
  41507. * Unlocks the audio engine once a user action has been done on the dom.
  41508. * This is helpful to resume play once browser policies have been satisfied.
  41509. */
  41510. unlock(): void;
  41511. private _resumeAudioContext;
  41512. private _initializeAudioContext;
  41513. private _tryToRun;
  41514. private _triggerRunningState;
  41515. private _triggerSuspendedState;
  41516. private _displayMuteButton;
  41517. private _moveButtonToTopLeft;
  41518. private _onResize;
  41519. private _hideMuteButton;
  41520. /**
  41521. * Destroy and release the resources associated with the audio ccontext.
  41522. */
  41523. dispose(): void;
  41524. /**
  41525. * Gets the global volume sets on the master gain.
  41526. * @returns the global volume if set or -1 otherwise
  41527. */
  41528. getGlobalVolume(): number;
  41529. /**
  41530. * Sets the global volume of your experience (sets on the master gain).
  41531. * @param newVolume Defines the new global volume of the application
  41532. */
  41533. setGlobalVolume(newVolume: number): void;
  41534. /**
  41535. * Connect the audio engine to an audio analyser allowing some amazing
  41536. * synchornization between the sounds/music and your visualization (VuMeter for instance).
  41537. * @see https://doc.babylonjs.com/how_to/playing_sounds_and_music#using-the-analyser
  41538. * @param analyser The analyser to connect to the engine
  41539. */
  41540. connectToAnalyser(analyser: Analyser): void;
  41541. }
  41542. }
  41543. declare module "babylonjs/Loading/loadingScreen" {
  41544. /**
  41545. * Interface used to present a loading screen while loading a scene
  41546. * @see https://doc.babylonjs.com/how_to/creating_a_custom_loading_screen
  41547. */
  41548. export interface ILoadingScreen {
  41549. /**
  41550. * Function called to display the loading screen
  41551. */
  41552. displayLoadingUI: () => void;
  41553. /**
  41554. * Function called to hide the loading screen
  41555. */
  41556. hideLoadingUI: () => void;
  41557. /**
  41558. * Gets or sets the color to use for the background
  41559. */
  41560. loadingUIBackgroundColor: string;
  41561. /**
  41562. * Gets or sets the text to display while loading
  41563. */
  41564. loadingUIText: string;
  41565. }
  41566. /**
  41567. * Class used for the default loading screen
  41568. * @see https://doc.babylonjs.com/how_to/creating_a_custom_loading_screen
  41569. */
  41570. export class DefaultLoadingScreen implements ILoadingScreen {
  41571. private _renderingCanvas;
  41572. private _loadingText;
  41573. private _loadingDivBackgroundColor;
  41574. private _loadingDiv;
  41575. private _loadingTextDiv;
  41576. /** Gets or sets the logo url to use for the default loading screen */
  41577. static DefaultLogoUrl: string;
  41578. /** Gets or sets the spinner url to use for the default loading screen */
  41579. static DefaultSpinnerUrl: string;
  41580. /**
  41581. * Creates a new default loading screen
  41582. * @param _renderingCanvas defines the canvas used to render the scene
  41583. * @param _loadingText defines the default text to display
  41584. * @param _loadingDivBackgroundColor defines the default background color
  41585. */
  41586. constructor(_renderingCanvas: HTMLCanvasElement, _loadingText?: string, _loadingDivBackgroundColor?: string);
  41587. /**
  41588. * Function called to display the loading screen
  41589. */
  41590. displayLoadingUI(): void;
  41591. /**
  41592. * Function called to hide the loading screen
  41593. */
  41594. hideLoadingUI(): void;
  41595. /**
  41596. * Gets or sets the text to display while loading
  41597. */
  41598. set loadingUIText(text: string);
  41599. get loadingUIText(): string;
  41600. /**
  41601. * Gets or sets the color to use for the background
  41602. */
  41603. get loadingUIBackgroundColor(): string;
  41604. set loadingUIBackgroundColor(color: string);
  41605. private _resizeLoadingUI;
  41606. }
  41607. }
  41608. declare module "babylonjs/Misc/customAnimationFrameRequester" {
  41609. /**
  41610. * Interface for any object that can request an animation frame
  41611. */
  41612. export interface ICustomAnimationFrameRequester {
  41613. /**
  41614. * This function will be called when the render loop is ready. If this is not populated, the engine's renderloop function will be called
  41615. */
  41616. renderFunction?: Function;
  41617. /**
  41618. * Called to request the next frame to render to
  41619. * @see https://developer.mozilla.org/en-US/docs/Web/API/window/requestAnimationFrame
  41620. */
  41621. requestAnimationFrame: Function;
  41622. /**
  41623. * You can pass this value to cancelAnimationFrame() to cancel the refresh callback request
  41624. * @see https://developer.mozilla.org/en-US/docs/Web/API/window/requestAnimationFrame#Return_value
  41625. */
  41626. requestID?: number;
  41627. }
  41628. }
  41629. declare module "babylonjs/Misc/performanceMonitor" {
  41630. /**
  41631. * Performance monitor tracks rolling average frame-time and frame-time variance over a user defined sliding-window
  41632. */
  41633. export class PerformanceMonitor {
  41634. private _enabled;
  41635. private _rollingFrameTime;
  41636. private _lastFrameTimeMs;
  41637. /**
  41638. * constructor
  41639. * @param frameSampleSize The number of samples required to saturate the sliding window
  41640. */
  41641. constructor(frameSampleSize?: number);
  41642. /**
  41643. * Samples current frame
  41644. * @param timeMs A timestamp in milliseconds of the current frame to compare with other frames
  41645. */
  41646. sampleFrame(timeMs?: number): void;
  41647. /**
  41648. * Returns the average frame time in milliseconds over the sliding window (or the subset of frames sampled so far)
  41649. */
  41650. get averageFrameTime(): number;
  41651. /**
  41652. * Returns the variance frame time in milliseconds over the sliding window (or the subset of frames sampled so far)
  41653. */
  41654. get averageFrameTimeVariance(): number;
  41655. /**
  41656. * Returns the frame time of the most recent frame
  41657. */
  41658. get instantaneousFrameTime(): number;
  41659. /**
  41660. * Returns the average framerate in frames per second over the sliding window (or the subset of frames sampled so far)
  41661. */
  41662. get averageFPS(): number;
  41663. /**
  41664. * Returns the average framerate in frames per second using the most recent frame time
  41665. */
  41666. get instantaneousFPS(): number;
  41667. /**
  41668. * Returns true if enough samples have been taken to completely fill the sliding window
  41669. */
  41670. get isSaturated(): boolean;
  41671. /**
  41672. * Enables contributions to the sliding window sample set
  41673. */
  41674. enable(): void;
  41675. /**
  41676. * Disables contributions to the sliding window sample set
  41677. * Samples will not be interpolated over the disabled period
  41678. */
  41679. disable(): void;
  41680. /**
  41681. * Returns true if sampling is enabled
  41682. */
  41683. get isEnabled(): boolean;
  41684. /**
  41685. * Resets performance monitor
  41686. */
  41687. reset(): void;
  41688. }
  41689. /**
  41690. * RollingAverage
  41691. *
  41692. * Utility to efficiently compute the rolling average and variance over a sliding window of samples
  41693. */
  41694. export class RollingAverage {
  41695. /**
  41696. * Current average
  41697. */
  41698. average: number;
  41699. /**
  41700. * Current variance
  41701. */
  41702. variance: number;
  41703. protected _samples: Array<number>;
  41704. protected _sampleCount: number;
  41705. protected _pos: number;
  41706. protected _m2: number;
  41707. /**
  41708. * constructor
  41709. * @param length The number of samples required to saturate the sliding window
  41710. */
  41711. constructor(length: number);
  41712. /**
  41713. * Adds a sample to the sample set
  41714. * @param v The sample value
  41715. */
  41716. add(v: number): void;
  41717. /**
  41718. * Returns previously added values or null if outside of history or outside the sliding window domain
  41719. * @param i Index in history. For example, pass 0 for the most recent value and 1 for the value before that
  41720. * @return Value previously recorded with add() or null if outside of range
  41721. */
  41722. history(i: number): number;
  41723. /**
  41724. * Returns true if enough samples have been taken to completely fill the sliding window
  41725. * @return true if sample-set saturated
  41726. */
  41727. isSaturated(): boolean;
  41728. /**
  41729. * Resets the rolling average (equivalent to 0 samples taken so far)
  41730. */
  41731. reset(): void;
  41732. /**
  41733. * Wraps a value around the sample range boundaries
  41734. * @param i Position in sample range, for example if the sample length is 5, and i is -3, then 2 will be returned.
  41735. * @return Wrapped position in sample range
  41736. */
  41737. protected _wrapPosition(i: number): number;
  41738. }
  41739. }
  41740. declare module "babylonjs/Misc/perfCounter" {
  41741. /**
  41742. * This class is used to track a performance counter which is number based.
  41743. * The user has access to many properties which give statistics of different nature.
  41744. *
  41745. * The implementer can track two kinds of Performance Counter: time and count.
  41746. * 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.
  41747. * 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.
  41748. */
  41749. export class PerfCounter {
  41750. /**
  41751. * Gets or sets a global boolean to turn on and off all the counters
  41752. */
  41753. static Enabled: boolean;
  41754. /**
  41755. * Returns the smallest value ever
  41756. */
  41757. get min(): number;
  41758. /**
  41759. * Returns the biggest value ever
  41760. */
  41761. get max(): number;
  41762. /**
  41763. * Returns the average value since the performance counter is running
  41764. */
  41765. get average(): number;
  41766. /**
  41767. * Returns the average value of the last second the counter was monitored
  41768. */
  41769. get lastSecAverage(): number;
  41770. /**
  41771. * Returns the current value
  41772. */
  41773. get current(): number;
  41774. /**
  41775. * Gets the accumulated total
  41776. */
  41777. get total(): number;
  41778. /**
  41779. * Gets the total value count
  41780. */
  41781. get count(): number;
  41782. /**
  41783. * Creates a new counter
  41784. */
  41785. constructor();
  41786. /**
  41787. * Call this method to start monitoring a new frame.
  41788. * 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.
  41789. */
  41790. fetchNewFrame(): void;
  41791. /**
  41792. * Call this method to monitor a count of something (e.g. mesh drawn in viewport count)
  41793. * @param newCount the count value to add to the monitored count
  41794. * @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.
  41795. */
  41796. addCount(newCount: number, fetchResult: boolean): void;
  41797. /**
  41798. * Start monitoring this performance counter
  41799. */
  41800. beginMonitoring(): void;
  41801. /**
  41802. * Compute the time lapsed since the previous beginMonitoring() call.
  41803. * @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
  41804. */
  41805. endMonitoring(newFrame?: boolean): void;
  41806. private _fetchResult;
  41807. private _startMonitoringTime;
  41808. private _min;
  41809. private _max;
  41810. private _average;
  41811. private _current;
  41812. private _totalValueCount;
  41813. private _totalAccumulated;
  41814. private _lastSecAverage;
  41815. private _lastSecAccumulated;
  41816. private _lastSecTime;
  41817. private _lastSecValueCount;
  41818. }
  41819. }
  41820. declare module "babylonjs/Engines/Extensions/engine.readTexture" {
  41821. import { InternalTexture } from "babylonjs/Materials/Textures/internalTexture";
  41822. import { Nullable } from "babylonjs/types";
  41823. module "babylonjs/Engines/thinEngine" {
  41824. interface ThinEngine {
  41825. /** @hidden */
  41826. _readTexturePixels(texture: InternalTexture, width: number, height: number, faceIndex?: number, level?: number, buffer?: Nullable<ArrayBufferView>): ArrayBufferView;
  41827. }
  41828. }
  41829. }
  41830. declare module "babylonjs/Engines/engine" {
  41831. import { Observable } from "babylonjs/Misc/observable";
  41832. import { Nullable } from "babylonjs/types";
  41833. import { Scene } from "babylonjs/scene";
  41834. import { InternalTexture } from "babylonjs/Materials/Textures/internalTexture";
  41835. import { IAudioEngine } from "babylonjs/Audio/audioEngine";
  41836. import { IOfflineProvider } from "babylonjs/Offline/IOfflineProvider";
  41837. import { ILoadingScreen } from "babylonjs/Loading/loadingScreen";
  41838. import { WebGLPipelineContext } from "babylonjs/Engines/WebGL/webGLPipelineContext";
  41839. import { IPipelineContext } from "babylonjs/Engines/IPipelineContext";
  41840. import { ICustomAnimationFrameRequester } from "babylonjs/Misc/customAnimationFrameRequester";
  41841. import { ThinEngine, EngineOptions } from "babylonjs/Engines/thinEngine";
  41842. import { IViewportLike, IColor4Like } from "babylonjs/Maths/math.like";
  41843. import { RenderTargetTexture } from "babylonjs/Materials/Textures/renderTargetTexture";
  41844. import { PerformanceMonitor } from "babylonjs/Misc/performanceMonitor";
  41845. import { DataBuffer } from "babylonjs/Meshes/dataBuffer";
  41846. import { PerfCounter } from "babylonjs/Misc/perfCounter";
  41847. import "babylonjs/Engines/Extensions/engine.alpha";
  41848. import "babylonjs/Engines/Extensions/engine.readTexture";
  41849. import "babylonjs/Engines/Extensions/engine.dynamicBuffer";
  41850. import { Material } from "babylonjs/Materials/material";
  41851. import { PostProcess } from "babylonjs/PostProcesses/postProcess";
  41852. /**
  41853. * Defines the interface used by display changed events
  41854. */
  41855. export interface IDisplayChangedEventArgs {
  41856. /** Gets the vrDisplay object (if any) */
  41857. vrDisplay: Nullable<any>;
  41858. /** Gets a boolean indicating if webVR is supported */
  41859. vrSupported: boolean;
  41860. }
  41861. /**
  41862. * Defines the interface used by objects containing a viewport (like a camera)
  41863. */
  41864. interface IViewportOwnerLike {
  41865. /**
  41866. * Gets or sets the viewport
  41867. */
  41868. viewport: IViewportLike;
  41869. }
  41870. /**
  41871. * The engine class is responsible for interfacing with all lower-level APIs such as WebGL and Audio
  41872. */
  41873. export class Engine extends ThinEngine {
  41874. /** Defines that alpha blending is disabled */
  41875. static readonly ALPHA_DISABLE: number;
  41876. /** Defines that alpha blending to SRC ALPHA * SRC + DEST */
  41877. static readonly ALPHA_ADD: number;
  41878. /** Defines that alpha blending to SRC ALPHA * SRC + (1 - SRC ALPHA) * DEST */
  41879. static readonly ALPHA_COMBINE: number;
  41880. /** Defines that alpha blending to DEST - SRC * DEST */
  41881. static readonly ALPHA_SUBTRACT: number;
  41882. /** Defines that alpha blending to SRC * DEST */
  41883. static readonly ALPHA_MULTIPLY: number;
  41884. /** Defines that alpha blending to SRC ALPHA * SRC + (1 - SRC) * DEST */
  41885. static readonly ALPHA_MAXIMIZED: number;
  41886. /** Defines that alpha blending to SRC + DEST */
  41887. static readonly ALPHA_ONEONE: number;
  41888. /** Defines that alpha blending to SRC + (1 - SRC ALPHA) * DEST */
  41889. static readonly ALPHA_PREMULTIPLIED: number;
  41890. /**
  41891. * Defines that alpha blending to SRC + (1 - SRC ALPHA) * DEST
  41892. * Alpha will be set to (1 - SRC ALPHA) * DEST ALPHA
  41893. */
  41894. static readonly ALPHA_PREMULTIPLIED_PORTERDUFF: number;
  41895. /** Defines that alpha blending to CST * SRC + (1 - CST) * DEST */
  41896. static readonly ALPHA_INTERPOLATE: number;
  41897. /**
  41898. * Defines that alpha blending to SRC + (1 - SRC) * DEST
  41899. * Alpha will be set to SRC ALPHA + (1 - SRC ALPHA) * DEST ALPHA
  41900. */
  41901. static readonly ALPHA_SCREENMODE: number;
  41902. /** Defines that the ressource is not delayed*/
  41903. static readonly DELAYLOADSTATE_NONE: number;
  41904. /** Defines that the ressource was successfully delay loaded */
  41905. static readonly DELAYLOADSTATE_LOADED: number;
  41906. /** Defines that the ressource is currently delay loading */
  41907. static readonly DELAYLOADSTATE_LOADING: number;
  41908. /** Defines that the ressource is delayed and has not started loading */
  41909. static readonly DELAYLOADSTATE_NOTLOADED: number;
  41910. /** Passed to depthFunction or stencilFunction to specify depth or stencil tests will never pass. i.e. Nothing will be drawn */
  41911. static readonly NEVER: number;
  41912. /** 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 */
  41913. static readonly ALWAYS: number;
  41914. /** Passed to depthFunction or stencilFunction to specify depth or stencil tests will pass if the new depth value is less than the stored value */
  41915. static readonly LESS: number;
  41916. /** Passed to depthFunction or stencilFunction to specify depth or stencil tests will pass if the new depth value is equals to the stored value */
  41917. static readonly EQUAL: number;
  41918. /** 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 */
  41919. static readonly LEQUAL: number;
  41920. /** Passed to depthFunction or stencilFunction to specify depth or stencil tests will pass if the new depth value is greater than the stored value */
  41921. static readonly GREATER: number;
  41922. /** 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 */
  41923. static readonly GEQUAL: number;
  41924. /** 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 */
  41925. static readonly NOTEQUAL: number;
  41926. /** Passed to stencilOperation to specify that stencil value must be kept */
  41927. static readonly KEEP: number;
  41928. /** Passed to stencilOperation to specify that stencil value must be replaced */
  41929. static readonly REPLACE: number;
  41930. /** Passed to stencilOperation to specify that stencil value must be incremented */
  41931. static readonly INCR: number;
  41932. /** Passed to stencilOperation to specify that stencil value must be decremented */
  41933. static readonly DECR: number;
  41934. /** Passed to stencilOperation to specify that stencil value must be inverted */
  41935. static readonly INVERT: number;
  41936. /** Passed to stencilOperation to specify that stencil value must be incremented with wrapping */
  41937. static readonly INCR_WRAP: number;
  41938. /** Passed to stencilOperation to specify that stencil value must be decremented with wrapping */
  41939. static readonly DECR_WRAP: number;
  41940. /** Texture is not repeating outside of 0..1 UVs */
  41941. static readonly TEXTURE_CLAMP_ADDRESSMODE: number;
  41942. /** Texture is repeating outside of 0..1 UVs */
  41943. static readonly TEXTURE_WRAP_ADDRESSMODE: number;
  41944. /** Texture is repeating and mirrored */
  41945. static readonly TEXTURE_MIRROR_ADDRESSMODE: number;
  41946. /** ALPHA */
  41947. static readonly TEXTUREFORMAT_ALPHA: number;
  41948. /** LUMINANCE */
  41949. static readonly TEXTUREFORMAT_LUMINANCE: number;
  41950. /** LUMINANCE_ALPHA */
  41951. static readonly TEXTUREFORMAT_LUMINANCE_ALPHA: number;
  41952. /** RGB */
  41953. static readonly TEXTUREFORMAT_RGB: number;
  41954. /** RGBA */
  41955. static readonly TEXTUREFORMAT_RGBA: number;
  41956. /** RED */
  41957. static readonly TEXTUREFORMAT_RED: number;
  41958. /** RED (2nd reference) */
  41959. static readonly TEXTUREFORMAT_R: number;
  41960. /** RG */
  41961. static readonly TEXTUREFORMAT_RG: number;
  41962. /** RED_INTEGER */
  41963. static readonly TEXTUREFORMAT_RED_INTEGER: number;
  41964. /** RED_INTEGER (2nd reference) */
  41965. static readonly TEXTUREFORMAT_R_INTEGER: number;
  41966. /** RG_INTEGER */
  41967. static readonly TEXTUREFORMAT_RG_INTEGER: number;
  41968. /** RGB_INTEGER */
  41969. static readonly TEXTUREFORMAT_RGB_INTEGER: number;
  41970. /** RGBA_INTEGER */
  41971. static readonly TEXTUREFORMAT_RGBA_INTEGER: number;
  41972. /** UNSIGNED_BYTE */
  41973. static readonly TEXTURETYPE_UNSIGNED_BYTE: number;
  41974. /** UNSIGNED_BYTE (2nd reference) */
  41975. static readonly TEXTURETYPE_UNSIGNED_INT: number;
  41976. /** FLOAT */
  41977. static readonly TEXTURETYPE_FLOAT: number;
  41978. /** HALF_FLOAT */
  41979. static readonly TEXTURETYPE_HALF_FLOAT: number;
  41980. /** BYTE */
  41981. static readonly TEXTURETYPE_BYTE: number;
  41982. /** SHORT */
  41983. static readonly TEXTURETYPE_SHORT: number;
  41984. /** UNSIGNED_SHORT */
  41985. static readonly TEXTURETYPE_UNSIGNED_SHORT: number;
  41986. /** INT */
  41987. static readonly TEXTURETYPE_INT: number;
  41988. /** UNSIGNED_INT */
  41989. static readonly TEXTURETYPE_UNSIGNED_INTEGER: number;
  41990. /** UNSIGNED_SHORT_4_4_4_4 */
  41991. static readonly TEXTURETYPE_UNSIGNED_SHORT_4_4_4_4: number;
  41992. /** UNSIGNED_SHORT_5_5_5_1 */
  41993. static readonly TEXTURETYPE_UNSIGNED_SHORT_5_5_5_1: number;
  41994. /** UNSIGNED_SHORT_5_6_5 */
  41995. static readonly TEXTURETYPE_UNSIGNED_SHORT_5_6_5: number;
  41996. /** UNSIGNED_INT_2_10_10_10_REV */
  41997. static readonly TEXTURETYPE_UNSIGNED_INT_2_10_10_10_REV: number;
  41998. /** UNSIGNED_INT_24_8 */
  41999. static readonly TEXTURETYPE_UNSIGNED_INT_24_8: number;
  42000. /** UNSIGNED_INT_10F_11F_11F_REV */
  42001. static readonly TEXTURETYPE_UNSIGNED_INT_10F_11F_11F_REV: number;
  42002. /** UNSIGNED_INT_5_9_9_9_REV */
  42003. static readonly TEXTURETYPE_UNSIGNED_INT_5_9_9_9_REV: number;
  42004. /** FLOAT_32_UNSIGNED_INT_24_8_REV */
  42005. static readonly TEXTURETYPE_FLOAT_32_UNSIGNED_INT_24_8_REV: number;
  42006. /** nearest is mag = nearest and min = nearest and mip = linear */
  42007. static readonly TEXTURE_NEAREST_SAMPLINGMODE: number;
  42008. /** Bilinear is mag = linear and min = linear and mip = nearest */
  42009. static readonly TEXTURE_BILINEAR_SAMPLINGMODE: number;
  42010. /** Trilinear is mag = linear and min = linear and mip = linear */
  42011. static readonly TEXTURE_TRILINEAR_SAMPLINGMODE: number;
  42012. /** nearest is mag = nearest and min = nearest and mip = linear */
  42013. static readonly TEXTURE_NEAREST_NEAREST_MIPLINEAR: number;
  42014. /** Bilinear is mag = linear and min = linear and mip = nearest */
  42015. static readonly TEXTURE_LINEAR_LINEAR_MIPNEAREST: number;
  42016. /** Trilinear is mag = linear and min = linear and mip = linear */
  42017. static readonly TEXTURE_LINEAR_LINEAR_MIPLINEAR: number;
  42018. /** mag = nearest and min = nearest and mip = nearest */
  42019. static readonly TEXTURE_NEAREST_NEAREST_MIPNEAREST: number;
  42020. /** mag = nearest and min = linear and mip = nearest */
  42021. static readonly TEXTURE_NEAREST_LINEAR_MIPNEAREST: number;
  42022. /** mag = nearest and min = linear and mip = linear */
  42023. static readonly TEXTURE_NEAREST_LINEAR_MIPLINEAR: number;
  42024. /** mag = nearest and min = linear and mip = none */
  42025. static readonly TEXTURE_NEAREST_LINEAR: number;
  42026. /** mag = nearest and min = nearest and mip = none */
  42027. static readonly TEXTURE_NEAREST_NEAREST: number;
  42028. /** mag = linear and min = nearest and mip = nearest */
  42029. static readonly TEXTURE_LINEAR_NEAREST_MIPNEAREST: number;
  42030. /** mag = linear and min = nearest and mip = linear */
  42031. static readonly TEXTURE_LINEAR_NEAREST_MIPLINEAR: number;
  42032. /** mag = linear and min = linear and mip = none */
  42033. static readonly TEXTURE_LINEAR_LINEAR: number;
  42034. /** mag = linear and min = nearest and mip = none */
  42035. static readonly TEXTURE_LINEAR_NEAREST: number;
  42036. /** Explicit coordinates mode */
  42037. static readonly TEXTURE_EXPLICIT_MODE: number;
  42038. /** Spherical coordinates mode */
  42039. static readonly TEXTURE_SPHERICAL_MODE: number;
  42040. /** Planar coordinates mode */
  42041. static readonly TEXTURE_PLANAR_MODE: number;
  42042. /** Cubic coordinates mode */
  42043. static readonly TEXTURE_CUBIC_MODE: number;
  42044. /** Projection coordinates mode */
  42045. static readonly TEXTURE_PROJECTION_MODE: number;
  42046. /** Skybox coordinates mode */
  42047. static readonly TEXTURE_SKYBOX_MODE: number;
  42048. /** Inverse Cubic coordinates mode */
  42049. static readonly TEXTURE_INVCUBIC_MODE: number;
  42050. /** Equirectangular coordinates mode */
  42051. static readonly TEXTURE_EQUIRECTANGULAR_MODE: number;
  42052. /** Equirectangular Fixed coordinates mode */
  42053. static readonly TEXTURE_FIXED_EQUIRECTANGULAR_MODE: number;
  42054. /** Equirectangular Fixed Mirrored coordinates mode */
  42055. static readonly TEXTURE_FIXED_EQUIRECTANGULAR_MIRRORED_MODE: number;
  42056. /** Defines that texture rescaling will use a floor to find the closer power of 2 size */
  42057. static readonly SCALEMODE_FLOOR: number;
  42058. /** Defines that texture rescaling will look for the nearest power of 2 size */
  42059. static readonly SCALEMODE_NEAREST: number;
  42060. /** Defines that texture rescaling will use a ceil to find the closer power of 2 size */
  42061. static readonly SCALEMODE_CEILING: number;
  42062. /**
  42063. * Returns the current npm package of the sdk
  42064. */
  42065. static get NpmPackage(): string;
  42066. /**
  42067. * Returns the current version of the framework
  42068. */
  42069. static get Version(): string;
  42070. /** Gets the list of created engines */
  42071. static get Instances(): Engine[];
  42072. /**
  42073. * Gets the latest created engine
  42074. */
  42075. static get LastCreatedEngine(): Nullable<Engine>;
  42076. /**
  42077. * Gets the latest created scene
  42078. */
  42079. static get LastCreatedScene(): Nullable<Scene>;
  42080. /**
  42081. * Will flag all materials in all scenes in all engines as dirty to trigger new shader compilation
  42082. * @param flag defines which part of the materials must be marked as dirty
  42083. * @param predicate defines a predicate used to filter which materials should be affected
  42084. */
  42085. static MarkAllMaterialsAsDirty(flag: number, predicate?: (mat: Material) => boolean): void;
  42086. /**
  42087. * Method called to create the default loading screen.
  42088. * This can be overriden in your own app.
  42089. * @param canvas The rendering canvas element
  42090. * @returns The loading screen
  42091. */
  42092. static DefaultLoadingScreenFactory(canvas: HTMLCanvasElement): ILoadingScreen;
  42093. /**
  42094. * Method called to create the default rescale post process on each engine.
  42095. */
  42096. static _RescalePostProcessFactory: Nullable<(engine: Engine) => PostProcess>;
  42097. /**
  42098. * Gets or sets a boolean to enable/disable IndexedDB support and avoid XHR on .manifest
  42099. **/
  42100. enableOfflineSupport: boolean;
  42101. /**
  42102. * 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)
  42103. **/
  42104. disableManifestCheck: boolean;
  42105. /**
  42106. * Gets the list of created scenes
  42107. */
  42108. scenes: Scene[];
  42109. /**
  42110. * Event raised when a new scene is created
  42111. */
  42112. onNewSceneAddedObservable: Observable<Scene>;
  42113. /**
  42114. * Gets the list of created postprocesses
  42115. */
  42116. postProcesses: import("babylonjs/PostProcesses/postProcess").PostProcess[];
  42117. /**
  42118. * Gets a boolean indicating if the pointer is currently locked
  42119. */
  42120. isPointerLock: boolean;
  42121. /**
  42122. * Observable event triggered each time the rendering canvas is resized
  42123. */
  42124. onResizeObservable: Observable<Engine>;
  42125. /**
  42126. * Observable event triggered each time the canvas loses focus
  42127. */
  42128. onCanvasBlurObservable: Observable<Engine>;
  42129. /**
  42130. * Observable event triggered each time the canvas gains focus
  42131. */
  42132. onCanvasFocusObservable: Observable<Engine>;
  42133. /**
  42134. * Observable event triggered each time the canvas receives pointerout event
  42135. */
  42136. onCanvasPointerOutObservable: Observable<PointerEvent>;
  42137. /**
  42138. * Observable raised when the engine begins a new frame
  42139. */
  42140. onBeginFrameObservable: Observable<Engine>;
  42141. /**
  42142. * If set, will be used to request the next animation frame for the render loop
  42143. */
  42144. customAnimationFrameRequester: Nullable<ICustomAnimationFrameRequester>;
  42145. /**
  42146. * Observable raised when the engine ends the current frame
  42147. */
  42148. onEndFrameObservable: Observable<Engine>;
  42149. /**
  42150. * Observable raised when the engine is about to compile a shader
  42151. */
  42152. onBeforeShaderCompilationObservable: Observable<Engine>;
  42153. /**
  42154. * Observable raised when the engine has jsut compiled a shader
  42155. */
  42156. onAfterShaderCompilationObservable: Observable<Engine>;
  42157. /**
  42158. * Gets the audio engine
  42159. * @see https://doc.babylonjs.com/how_to/playing_sounds_and_music
  42160. * @ignorenaming
  42161. */
  42162. static audioEngine: IAudioEngine;
  42163. /**
  42164. * Default AudioEngine factory responsible of creating the Audio Engine.
  42165. * By default, this will create a BabylonJS Audio Engine if the workload has been embedded.
  42166. */
  42167. static AudioEngineFactory: (hostElement: Nullable<HTMLElement>) => IAudioEngine;
  42168. /**
  42169. * Default offline support factory responsible of creating a tool used to store data locally.
  42170. * By default, this will create a Database object if the workload has been embedded.
  42171. */
  42172. static OfflineProviderFactory: (urlToScene: string, callbackManifestChecked: (checked: boolean) => any, disableManifestCheck: boolean) => IOfflineProvider;
  42173. private _loadingScreen;
  42174. private _pointerLockRequested;
  42175. private _rescalePostProcess;
  42176. private _deterministicLockstep;
  42177. private _lockstepMaxSteps;
  42178. private _timeStep;
  42179. protected get _supportsHardwareTextureRescaling(): boolean;
  42180. private _fps;
  42181. private _deltaTime;
  42182. /** @hidden */
  42183. _drawCalls: PerfCounter;
  42184. /** 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 */
  42185. canvasTabIndex: number;
  42186. /**
  42187. * Turn this value on if you want to pause FPS computation when in background
  42188. */
  42189. disablePerformanceMonitorInBackground: boolean;
  42190. private _performanceMonitor;
  42191. /**
  42192. * Gets the performance monitor attached to this engine
  42193. * @see https://doc.babylonjs.com/how_to/optimizing_your_scene#engineinstrumentation
  42194. */
  42195. get performanceMonitor(): PerformanceMonitor;
  42196. private _onFocus;
  42197. private _onBlur;
  42198. private _onCanvasPointerOut;
  42199. private _onCanvasBlur;
  42200. private _onCanvasFocus;
  42201. private _onFullscreenChange;
  42202. private _onPointerLockChange;
  42203. /**
  42204. * Gets the HTML element used to attach event listeners
  42205. * @returns a HTML element
  42206. */
  42207. getInputElement(): Nullable<HTMLElement>;
  42208. /**
  42209. * Creates a new engine
  42210. * @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
  42211. * @param antialias defines enable antialiasing (default: false)
  42212. * @param options defines further options to be sent to the getContext() function
  42213. * @param adaptToDeviceRatio defines whether to adapt to the device's viewport characteristics (default: false)
  42214. */
  42215. constructor(canvasOrContext: Nullable<HTMLCanvasElement | WebGLRenderingContext>, antialias?: boolean, options?: EngineOptions, adaptToDeviceRatio?: boolean);
  42216. /**
  42217. * Gets current aspect ratio
  42218. * @param viewportOwner defines the camera to use to get the aspect ratio
  42219. * @param useScreen defines if screen size must be used (or the current render target if any)
  42220. * @returns a number defining the aspect ratio
  42221. */
  42222. getAspectRatio(viewportOwner: IViewportOwnerLike, useScreen?: boolean): number;
  42223. /**
  42224. * Gets current screen aspect ratio
  42225. * @returns a number defining the aspect ratio
  42226. */
  42227. getScreenAspectRatio(): number;
  42228. /**
  42229. * Gets the client rect of the HTML canvas attached with the current webGL context
  42230. * @returns a client rectanglee
  42231. */
  42232. getRenderingCanvasClientRect(): Nullable<ClientRect>;
  42233. /**
  42234. * Gets the client rect of the HTML element used for events
  42235. * @returns a client rectanglee
  42236. */
  42237. getInputElementClientRect(): Nullable<ClientRect>;
  42238. /**
  42239. * Gets a boolean indicating that the engine is running in deterministic lock step mode
  42240. * @see https://doc.babylonjs.com/babylon101/animations#deterministic-lockstep
  42241. * @returns true if engine is in deterministic lock step mode
  42242. */
  42243. isDeterministicLockStep(): boolean;
  42244. /**
  42245. * Gets the max steps when engine is running in deterministic lock step
  42246. * @see https://doc.babylonjs.com/babylon101/animations#deterministic-lockstep
  42247. * @returns the max steps
  42248. */
  42249. getLockstepMaxSteps(): number;
  42250. /**
  42251. * Returns the time in ms between steps when using deterministic lock step.
  42252. * @returns time step in (ms)
  42253. */
  42254. getTimeStep(): number;
  42255. /**
  42256. * Force the mipmap generation for the given render target texture
  42257. * @param texture defines the render target texture to use
  42258. * @param unbind defines whether or not to unbind the texture after generation. Defaults to true.
  42259. */
  42260. generateMipMapsForCubemap(texture: InternalTexture, unbind?: boolean): void;
  42261. /** States */
  42262. /**
  42263. * Set various states to the webGL context
  42264. * @param culling defines backface culling state
  42265. * @param zOffset defines the value to apply to zOffset (0 by default)
  42266. * @param force defines if states must be applied even if cache is up to date
  42267. * @param reverseSide defines if culling must be reversed (CCW instead of CW and CW instead of CCW)
  42268. */
  42269. setState(culling: boolean, zOffset?: number, force?: boolean, reverseSide?: boolean): void;
  42270. /**
  42271. * Set the z offset to apply to current rendering
  42272. * @param value defines the offset to apply
  42273. */
  42274. setZOffset(value: number): void;
  42275. /**
  42276. * Gets the current value of the zOffset
  42277. * @returns the current zOffset state
  42278. */
  42279. getZOffset(): number;
  42280. /**
  42281. * Enable or disable depth buffering
  42282. * @param enable defines the state to set
  42283. */
  42284. setDepthBuffer(enable: boolean): void;
  42285. /**
  42286. * Gets a boolean indicating if depth writing is enabled
  42287. * @returns the current depth writing state
  42288. */
  42289. getDepthWrite(): boolean;
  42290. /**
  42291. * Enable or disable depth writing
  42292. * @param enable defines the state to set
  42293. */
  42294. setDepthWrite(enable: boolean): void;
  42295. /**
  42296. * Gets a boolean indicating if stencil buffer is enabled
  42297. * @returns the current stencil buffer state
  42298. */
  42299. getStencilBuffer(): boolean;
  42300. /**
  42301. * Enable or disable the stencil buffer
  42302. * @param enable defines if the stencil buffer must be enabled or disabled
  42303. */
  42304. setStencilBuffer(enable: boolean): void;
  42305. /**
  42306. * Gets the current stencil mask
  42307. * @returns a number defining the new stencil mask to use
  42308. */
  42309. getStencilMask(): number;
  42310. /**
  42311. * Sets the current stencil mask
  42312. * @param mask defines the new stencil mask to use
  42313. */
  42314. setStencilMask(mask: number): void;
  42315. /**
  42316. * Gets the current stencil function
  42317. * @returns a number defining the stencil function to use
  42318. */
  42319. getStencilFunction(): number;
  42320. /**
  42321. * Gets the current stencil reference value
  42322. * @returns a number defining the stencil reference value to use
  42323. */
  42324. getStencilFunctionReference(): number;
  42325. /**
  42326. * Gets the current stencil mask
  42327. * @returns a number defining the stencil mask to use
  42328. */
  42329. getStencilFunctionMask(): number;
  42330. /**
  42331. * Sets the current stencil function
  42332. * @param stencilFunc defines the new stencil function to use
  42333. */
  42334. setStencilFunction(stencilFunc: number): void;
  42335. /**
  42336. * Sets the current stencil reference
  42337. * @param reference defines the new stencil reference to use
  42338. */
  42339. setStencilFunctionReference(reference: number): void;
  42340. /**
  42341. * Sets the current stencil mask
  42342. * @param mask defines the new stencil mask to use
  42343. */
  42344. setStencilFunctionMask(mask: number): void;
  42345. /**
  42346. * Gets the current stencil operation when stencil fails
  42347. * @returns a number defining stencil operation to use when stencil fails
  42348. */
  42349. getStencilOperationFail(): number;
  42350. /**
  42351. * Gets the current stencil operation when depth fails
  42352. * @returns a number defining stencil operation to use when depth fails
  42353. */
  42354. getStencilOperationDepthFail(): number;
  42355. /**
  42356. * Gets the current stencil operation when stencil passes
  42357. * @returns a number defining stencil operation to use when stencil passes
  42358. */
  42359. getStencilOperationPass(): number;
  42360. /**
  42361. * Sets the stencil operation to use when stencil fails
  42362. * @param operation defines the stencil operation to use when stencil fails
  42363. */
  42364. setStencilOperationFail(operation: number): void;
  42365. /**
  42366. * Sets the stencil operation to use when depth fails
  42367. * @param operation defines the stencil operation to use when depth fails
  42368. */
  42369. setStencilOperationDepthFail(operation: number): void;
  42370. /**
  42371. * Sets the stencil operation to use when stencil passes
  42372. * @param operation defines the stencil operation to use when stencil passes
  42373. */
  42374. setStencilOperationPass(operation: number): void;
  42375. /**
  42376. * Sets a boolean indicating if the dithering state is enabled or disabled
  42377. * @param value defines the dithering state
  42378. */
  42379. setDitheringState(value: boolean): void;
  42380. /**
  42381. * Sets a boolean indicating if the rasterizer state is enabled or disabled
  42382. * @param value defines the rasterizer state
  42383. */
  42384. setRasterizerState(value: boolean): void;
  42385. /**
  42386. * Gets the current depth function
  42387. * @returns a number defining the depth function
  42388. */
  42389. getDepthFunction(): Nullable<number>;
  42390. /**
  42391. * Sets the current depth function
  42392. * @param depthFunc defines the function to use
  42393. */
  42394. setDepthFunction(depthFunc: number): void;
  42395. /**
  42396. * Sets the current depth function to GREATER
  42397. */
  42398. setDepthFunctionToGreater(): void;
  42399. /**
  42400. * Sets the current depth function to GEQUAL
  42401. */
  42402. setDepthFunctionToGreaterOrEqual(): void;
  42403. /**
  42404. * Sets the current depth function to LESS
  42405. */
  42406. setDepthFunctionToLess(): void;
  42407. /**
  42408. * Sets the current depth function to LEQUAL
  42409. */
  42410. setDepthFunctionToLessOrEqual(): void;
  42411. private _cachedStencilBuffer;
  42412. private _cachedStencilFunction;
  42413. private _cachedStencilMask;
  42414. private _cachedStencilOperationPass;
  42415. private _cachedStencilOperationFail;
  42416. private _cachedStencilOperationDepthFail;
  42417. private _cachedStencilReference;
  42418. /**
  42419. * Caches the the state of the stencil buffer
  42420. */
  42421. cacheStencilState(): void;
  42422. /**
  42423. * Restores the state of the stencil buffer
  42424. */
  42425. restoreStencilState(): void;
  42426. /**
  42427. * Directly set the WebGL Viewport
  42428. * @param x defines the x coordinate of the viewport (in screen space)
  42429. * @param y defines the y coordinate of the viewport (in screen space)
  42430. * @param width defines the width of the viewport (in screen space)
  42431. * @param height defines the height of the viewport (in screen space)
  42432. * @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
  42433. */
  42434. setDirectViewport(x: number, y: number, width: number, height: number): Nullable<IViewportLike>;
  42435. /**
  42436. * Executes a scissor clear (ie. a clear on a specific portion of the screen)
  42437. * @param x defines the x-coordinate of the top left corner of the clear rectangle
  42438. * @param y defines the y-coordinate of the corner of the clear rectangle
  42439. * @param width defines the width of the clear rectangle
  42440. * @param height defines the height of the clear rectangle
  42441. * @param clearColor defines the clear color
  42442. */
  42443. scissorClear(x: number, y: number, width: number, height: number, clearColor: IColor4Like): void;
  42444. /**
  42445. * Enable scissor test on a specific rectangle (ie. render will only be executed on a specific portion of the screen)
  42446. * @param x defines the x-coordinate of the top left corner of the clear rectangle
  42447. * @param y defines the y-coordinate of the corner of the clear rectangle
  42448. * @param width defines the width of the clear rectangle
  42449. * @param height defines the height of the clear rectangle
  42450. */
  42451. enableScissor(x: number, y: number, width: number, height: number): void;
  42452. /**
  42453. * Disable previously set scissor test rectangle
  42454. */
  42455. disableScissor(): void;
  42456. protected _reportDrawCall(): void;
  42457. /**
  42458. * Initializes a webVR display and starts listening to display change events
  42459. * The onVRDisplayChangedObservable will be notified upon these changes
  42460. * @returns The onVRDisplayChangedObservable
  42461. */
  42462. initWebVR(): Observable<IDisplayChangedEventArgs>;
  42463. /** @hidden */
  42464. _prepareVRComponent(): void;
  42465. /** @hidden */
  42466. _connectVREvents(canvas?: HTMLCanvasElement, document?: any): void;
  42467. /** @hidden */
  42468. _submitVRFrame(): void;
  42469. /**
  42470. * Call this function to leave webVR mode
  42471. * Will do nothing if webVR is not supported or if there is no webVR device
  42472. * @see https://doc.babylonjs.com/how_to/webvr_camera
  42473. */
  42474. disableVR(): void;
  42475. /**
  42476. * Gets a boolean indicating that the system is in VR mode and is presenting
  42477. * @returns true if VR mode is engaged
  42478. */
  42479. isVRPresenting(): boolean;
  42480. /** @hidden */
  42481. _requestVRFrame(): void;
  42482. /** @hidden */
  42483. _loadFileAsync(url: string, offlineProvider?: IOfflineProvider, useArrayBuffer?: boolean): Promise<string | ArrayBuffer>;
  42484. /**
  42485. * Gets the source code of the vertex shader associated with a specific webGL program
  42486. * @param program defines the program to use
  42487. * @returns a string containing the source code of the vertex shader associated with the program
  42488. */
  42489. getVertexShaderSource(program: WebGLProgram): Nullable<string>;
  42490. /**
  42491. * Gets the source code of the fragment shader associated with a specific webGL program
  42492. * @param program defines the program to use
  42493. * @returns a string containing the source code of the fragment shader associated with the program
  42494. */
  42495. getFragmentShaderSource(program: WebGLProgram): Nullable<string>;
  42496. /**
  42497. * Sets a depth stencil texture from a render target to the according uniform.
  42498. * @param channel The texture channel
  42499. * @param uniform The uniform to set
  42500. * @param texture The render target texture containing the depth stencil texture to apply
  42501. */
  42502. setDepthStencilTexture(channel: number, uniform: Nullable<WebGLUniformLocation>, texture: Nullable<RenderTargetTexture>): void;
  42503. /**
  42504. * Sets a texture to the webGL context from a postprocess
  42505. * @param channel defines the channel to use
  42506. * @param postProcess defines the source postprocess
  42507. */
  42508. setTextureFromPostProcess(channel: number, postProcess: Nullable<PostProcess>): void;
  42509. /**
  42510. * Binds the output of the passed in post process to the texture channel specified
  42511. * @param channel The channel the texture should be bound to
  42512. * @param postProcess The post process which's output should be bound
  42513. */
  42514. setTextureFromPostProcessOutput(channel: number, postProcess: Nullable<PostProcess>): void;
  42515. protected _rebuildBuffers(): void;
  42516. /** @hidden */
  42517. _renderFrame(): void;
  42518. _renderLoop(): void;
  42519. /** @hidden */
  42520. _renderViews(): boolean;
  42521. /**
  42522. * Toggle full screen mode
  42523. * @param requestPointerLock defines if a pointer lock should be requested from the user
  42524. */
  42525. switchFullscreen(requestPointerLock: boolean): void;
  42526. /**
  42527. * Enters full screen mode
  42528. * @param requestPointerLock defines if a pointer lock should be requested from the user
  42529. */
  42530. enterFullscreen(requestPointerLock: boolean): void;
  42531. /**
  42532. * Exits full screen mode
  42533. */
  42534. exitFullscreen(): void;
  42535. /**
  42536. * Enters Pointerlock mode
  42537. */
  42538. enterPointerlock(): void;
  42539. /**
  42540. * Exits Pointerlock mode
  42541. */
  42542. exitPointerlock(): void;
  42543. /**
  42544. * Begin a new frame
  42545. */
  42546. beginFrame(): void;
  42547. /**
  42548. * Enf the current frame
  42549. */
  42550. endFrame(): void;
  42551. resize(): void;
  42552. /**
  42553. * Force a specific size of the canvas
  42554. * @param width defines the new canvas' width
  42555. * @param height defines the new canvas' height
  42556. * @returns true if the size was changed
  42557. */
  42558. setSize(width: number, height: number): boolean;
  42559. _deletePipelineContext(pipelineContext: IPipelineContext): void;
  42560. createShaderProgram(pipelineContext: IPipelineContext, vertexCode: string, fragmentCode: string, defines: Nullable<string>, context?: WebGLRenderingContext, transformFeedbackVaryings?: Nullable<string[]>): WebGLProgram;
  42561. protected _createShaderProgram(pipelineContext: WebGLPipelineContext, vertexShader: WebGLShader, fragmentShader: WebGLShader, context: WebGLRenderingContext, transformFeedbackVaryings?: Nullable<string[]>): WebGLProgram;
  42562. _releaseTexture(texture: InternalTexture): void;
  42563. /**
  42564. * @hidden
  42565. * Rescales a texture
  42566. * @param source input texutre
  42567. * @param destination destination texture
  42568. * @param scene scene to use to render the resize
  42569. * @param internalFormat format to use when resizing
  42570. * @param onComplete callback to be called when resize has completed
  42571. */
  42572. _rescaleTexture(source: InternalTexture, destination: InternalTexture, scene: Nullable<any>, internalFormat: number, onComplete: () => void): void;
  42573. /**
  42574. * Gets the current framerate
  42575. * @returns a number representing the framerate
  42576. */
  42577. getFps(): number;
  42578. /**
  42579. * Gets the time spent between current and previous frame
  42580. * @returns a number representing the delta time in ms
  42581. */
  42582. getDeltaTime(): number;
  42583. private _measureFps;
  42584. /** @hidden */
  42585. _uploadImageToTexture(texture: InternalTexture, image: HTMLImageElement | ImageBitmap, faceIndex?: number, lod?: number): void;
  42586. /**
  42587. * Updates the sample count of a render target texture
  42588. * @see https://doc.babylonjs.com/features/webgl2#multisample-render-targets
  42589. * @param texture defines the texture to update
  42590. * @param samples defines the sample count to set
  42591. * @returns the effective sample count (could be 0 if multisample render targets are not supported)
  42592. */
  42593. updateRenderTargetTextureSampleCount(texture: Nullable<InternalTexture>, samples: number): number;
  42594. /**
  42595. * Updates a depth texture Comparison Mode and Function.
  42596. * If the comparison Function is equal to 0, the mode will be set to none.
  42597. * Otherwise, this only works in webgl 2 and requires a shadow sampler in the shader.
  42598. * @param texture The texture to set the comparison function for
  42599. * @param comparisonFunction The comparison function to set, 0 if no comparison required
  42600. */
  42601. updateTextureComparisonFunction(texture: InternalTexture, comparisonFunction: number): void;
  42602. /**
  42603. * Creates a webGL buffer to use with instanciation
  42604. * @param capacity defines the size of the buffer
  42605. * @returns the webGL buffer
  42606. */
  42607. createInstancesBuffer(capacity: number): DataBuffer;
  42608. /**
  42609. * Delete a webGL buffer used with instanciation
  42610. * @param buffer defines the webGL buffer to delete
  42611. */
  42612. deleteInstancesBuffer(buffer: WebGLBuffer): void;
  42613. private _clientWaitAsync;
  42614. /** @hidden */
  42615. _readPixelsAsync(x: number, y: number, w: number, h: number, format: number, type: number, outputBuffer: ArrayBufferView): Promise<ArrayBufferView> | null;
  42616. dispose(): void;
  42617. private _disableTouchAction;
  42618. /**
  42619. * Display the loading screen
  42620. * @see https://doc.babylonjs.com/how_to/creating_a_custom_loading_screen
  42621. */
  42622. displayLoadingUI(): void;
  42623. /**
  42624. * Hide the loading screen
  42625. * @see https://doc.babylonjs.com/how_to/creating_a_custom_loading_screen
  42626. */
  42627. hideLoadingUI(): void;
  42628. /**
  42629. * Gets the current loading screen object
  42630. * @see https://doc.babylonjs.com/how_to/creating_a_custom_loading_screen
  42631. */
  42632. get loadingScreen(): ILoadingScreen;
  42633. /**
  42634. * Sets the current loading screen object
  42635. * @see https://doc.babylonjs.com/how_to/creating_a_custom_loading_screen
  42636. */
  42637. set loadingScreen(loadingScreen: ILoadingScreen);
  42638. /**
  42639. * Sets the current loading screen text
  42640. * @see https://doc.babylonjs.com/how_to/creating_a_custom_loading_screen
  42641. */
  42642. set loadingUIText(text: string);
  42643. /**
  42644. * Sets the current loading screen background color
  42645. * @see https://doc.babylonjs.com/how_to/creating_a_custom_loading_screen
  42646. */
  42647. set loadingUIBackgroundColor(color: string);
  42648. /** Pointerlock and fullscreen */
  42649. /**
  42650. * Ask the browser to promote the current element to pointerlock mode
  42651. * @param element defines the DOM element to promote
  42652. */
  42653. static _RequestPointerlock(element: HTMLElement): void;
  42654. /**
  42655. * Asks the browser to exit pointerlock mode
  42656. */
  42657. static _ExitPointerlock(): void;
  42658. /**
  42659. * Ask the browser to promote the current element to fullscreen rendering mode
  42660. * @param element defines the DOM element to promote
  42661. */
  42662. static _RequestFullscreen(element: HTMLElement): void;
  42663. /**
  42664. * Asks the browser to exit fullscreen mode
  42665. */
  42666. static _ExitFullscreen(): void;
  42667. }
  42668. }
  42669. declare module "babylonjs/Engines/engineStore" {
  42670. import { Nullable } from "babylonjs/types";
  42671. import { Engine } from "babylonjs/Engines/engine";
  42672. import { Scene } from "babylonjs/scene";
  42673. /**
  42674. * The engine store class is responsible to hold all the instances of Engine and Scene created
  42675. * during the life time of the application.
  42676. */
  42677. export class EngineStore {
  42678. /** Gets the list of created engines */
  42679. static Instances: import("babylonjs/Engines/engine").Engine[];
  42680. /** @hidden */
  42681. static _LastCreatedScene: Nullable<Scene>;
  42682. /**
  42683. * Gets the latest created engine
  42684. */
  42685. static get LastCreatedEngine(): Nullable<Engine>;
  42686. /**
  42687. * Gets the latest created scene
  42688. */
  42689. static get LastCreatedScene(): Nullable<Scene>;
  42690. /**
  42691. * Gets or sets a global variable indicating if fallback texture must be used when a texture cannot be loaded
  42692. * @ignorenaming
  42693. */
  42694. static UseFallbackTexture: boolean;
  42695. /**
  42696. * Texture content used if a texture cannot loaded
  42697. * @ignorenaming
  42698. */
  42699. static FallbackTexture: string;
  42700. }
  42701. }
  42702. declare module "babylonjs/Misc/promise" {
  42703. /**
  42704. * Helper class that provides a small promise polyfill
  42705. */
  42706. export class PromisePolyfill {
  42707. /**
  42708. * Static function used to check if the polyfill is required
  42709. * If this is the case then the function will inject the polyfill to window.Promise
  42710. * @param force defines a boolean used to force the injection (mostly for testing purposes)
  42711. */
  42712. static Apply(force?: boolean): void;
  42713. }
  42714. }
  42715. declare module "babylonjs/Misc/interfaces/screenshotSize" {
  42716. /**
  42717. * Interface for screenshot methods with describe argument called `size` as object with options
  42718. * @link https://doc.babylonjs.com/api/classes/babylon.screenshottools
  42719. */
  42720. export interface IScreenshotSize {
  42721. /**
  42722. * number in pixels for canvas height
  42723. */
  42724. height?: number;
  42725. /**
  42726. * multiplier allowing render at a higher or lower resolution
  42727. * If value is defined then height and width will be ignored and taken from camera
  42728. */
  42729. precision?: number;
  42730. /**
  42731. * number in pixels for canvas width
  42732. */
  42733. width?: number;
  42734. }
  42735. }
  42736. declare module "babylonjs/Misc/tools" {
  42737. import { Nullable, float } from "babylonjs/types";
  42738. import { DomManagement } from "babylonjs/Misc/domManagement";
  42739. import { WebRequest } from "babylonjs/Misc/webRequest";
  42740. import { IFileRequest } from "babylonjs/Misc/fileRequest";
  42741. import { ReadFileError } from "babylonjs/Misc/fileTools";
  42742. import { IOfflineProvider } from "babylonjs/Offline/IOfflineProvider";
  42743. import { IScreenshotSize } from "babylonjs/Misc/interfaces/screenshotSize";
  42744. import { Camera } from "babylonjs/Cameras/camera";
  42745. import { Engine } from "babylonjs/Engines/engine";
  42746. interface IColor4Like {
  42747. r: float;
  42748. g: float;
  42749. b: float;
  42750. a: float;
  42751. }
  42752. /**
  42753. * Class containing a set of static utilities functions
  42754. */
  42755. export class Tools {
  42756. /**
  42757. * Gets or sets the base URL to use to load assets
  42758. */
  42759. static get BaseUrl(): string;
  42760. static set BaseUrl(value: string);
  42761. /**
  42762. * Enable/Disable Custom HTTP Request Headers globally.
  42763. * default = false
  42764. * @see CustomRequestHeaders
  42765. */
  42766. static UseCustomRequestHeaders: boolean;
  42767. /**
  42768. * Custom HTTP Request Headers to be sent with XMLHttpRequests
  42769. * i.e. when loading files, where the server/service expects an Authorization header
  42770. */
  42771. static CustomRequestHeaders: {
  42772. [key: string]: string;
  42773. };
  42774. /**
  42775. * Gets or sets the retry strategy to apply when an error happens while loading an asset
  42776. */
  42777. static get DefaultRetryStrategy(): (url: string, request: WebRequest, retryIndex: number) => number;
  42778. static set DefaultRetryStrategy(strategy: (url: string, request: WebRequest, retryIndex: number) => number);
  42779. /**
  42780. * Default behaviour for cors in the application.
  42781. * It can be a string if the expected behavior is identical in the entire app.
  42782. * Or a callback to be able to set it per url or on a group of them (in case of Video source for instance)
  42783. */
  42784. static get CorsBehavior(): string | ((url: string | string[]) => string);
  42785. static set CorsBehavior(value: string | ((url: string | string[]) => string));
  42786. /**
  42787. * Gets or sets a global variable indicating if fallback texture must be used when a texture cannot be loaded
  42788. * @ignorenaming
  42789. */
  42790. static get UseFallbackTexture(): boolean;
  42791. static set UseFallbackTexture(value: boolean);
  42792. /**
  42793. * Use this object to register external classes like custom textures or material
  42794. * to allow the laoders to instantiate them
  42795. */
  42796. static get RegisteredExternalClasses(): {
  42797. [key: string]: Object;
  42798. };
  42799. static set RegisteredExternalClasses(classes: {
  42800. [key: string]: Object;
  42801. });
  42802. /**
  42803. * Texture content used if a texture cannot loaded
  42804. * @ignorenaming
  42805. */
  42806. static get fallbackTexture(): string;
  42807. static set fallbackTexture(value: string);
  42808. /**
  42809. * Read the content of a byte array at a specified coordinates (taking in account wrapping)
  42810. * @param u defines the coordinate on X axis
  42811. * @param v defines the coordinate on Y axis
  42812. * @param width defines the width of the source data
  42813. * @param height defines the height of the source data
  42814. * @param pixels defines the source byte array
  42815. * @param color defines the output color
  42816. */
  42817. static FetchToRef(u: number, v: number, width: number, height: number, pixels: Uint8Array, color: IColor4Like): void;
  42818. /**
  42819. * Interpolates between a and b via alpha
  42820. * @param a The lower value (returned when alpha = 0)
  42821. * @param b The upper value (returned when alpha = 1)
  42822. * @param alpha The interpolation-factor
  42823. * @return The mixed value
  42824. */
  42825. static Mix(a: number, b: number, alpha: number): number;
  42826. /**
  42827. * Tries to instantiate a new object from a given class name
  42828. * @param className defines the class name to instantiate
  42829. * @returns the new object or null if the system was not able to do the instantiation
  42830. */
  42831. static Instantiate(className: string): any;
  42832. /**
  42833. * Provides a slice function that will work even on IE
  42834. * @param data defines the array to slice
  42835. * @param start defines the start of the data (optional)
  42836. * @param end defines the end of the data (optional)
  42837. * @returns the new sliced array
  42838. */
  42839. static Slice<T>(data: T, start?: number, end?: number): T;
  42840. /**
  42841. * Polyfill for setImmediate
  42842. * @param action defines the action to execute after the current execution block
  42843. */
  42844. static SetImmediate(action: () => void): void;
  42845. /**
  42846. * Function indicating if a number is an exponent of 2
  42847. * @param value defines the value to test
  42848. * @returns true if the value is an exponent of 2
  42849. */
  42850. static IsExponentOfTwo(value: number): boolean;
  42851. private static _tmpFloatArray;
  42852. /**
  42853. * Returns the nearest 32-bit single precision float representation of a Number
  42854. * @param value A Number. If the parameter is of a different type, it will get converted
  42855. * to a number or to NaN if it cannot be converted
  42856. * @returns number
  42857. */
  42858. static FloatRound(value: number): number;
  42859. /**
  42860. * Extracts the filename from a path
  42861. * @param path defines the path to use
  42862. * @returns the filename
  42863. */
  42864. static GetFilename(path: string): string;
  42865. /**
  42866. * Extracts the "folder" part of a path (everything before the filename).
  42867. * @param uri The URI to extract the info from
  42868. * @param returnUnchangedIfNoSlash Do not touch the URI if no slashes are present
  42869. * @returns The "folder" part of the path
  42870. */
  42871. static GetFolderPath(uri: string, returnUnchangedIfNoSlash?: boolean): string;
  42872. /**
  42873. * Extracts text content from a DOM element hierarchy
  42874. * Back Compat only, please use DomManagement.GetDOMTextContent instead.
  42875. */
  42876. static GetDOMTextContent: typeof DomManagement.GetDOMTextContent;
  42877. /**
  42878. * Convert an angle in radians to degrees
  42879. * @param angle defines the angle to convert
  42880. * @returns the angle in degrees
  42881. */
  42882. static ToDegrees(angle: number): number;
  42883. /**
  42884. * Convert an angle in degrees to radians
  42885. * @param angle defines the angle to convert
  42886. * @returns the angle in radians
  42887. */
  42888. static ToRadians(angle: number): number;
  42889. /**
  42890. * Returns an array if obj is not an array
  42891. * @param obj defines the object to evaluate as an array
  42892. * @param allowsNullUndefined defines a boolean indicating if obj is allowed to be null or undefined
  42893. * @returns either obj directly if obj is an array or a new array containing obj
  42894. */
  42895. static MakeArray(obj: any, allowsNullUndefined?: boolean): Nullable<Array<any>>;
  42896. /**
  42897. * Gets the pointer prefix to use
  42898. * @param engine defines the engine we are finding the prefix for
  42899. * @returns "pointer" if touch is enabled. Else returns "mouse"
  42900. */
  42901. static GetPointerPrefix(engine: Engine): string;
  42902. /**
  42903. * Sets the cors behavior on a dom element. This will add the required Tools.CorsBehavior to the element.
  42904. * @param url define the url we are trying
  42905. * @param element define the dom element where to configure the cors policy
  42906. */
  42907. static SetCorsBehavior(url: string | string[], element: {
  42908. crossOrigin: string | null;
  42909. }): void;
  42910. /**
  42911. * Removes unwanted characters from an url
  42912. * @param url defines the url to clean
  42913. * @returns the cleaned url
  42914. */
  42915. static CleanUrl(url: string): string;
  42916. /**
  42917. * Gets or sets a function used to pre-process url before using them to load assets
  42918. */
  42919. static get PreprocessUrl(): (url: string) => string;
  42920. static set PreprocessUrl(processor: (url: string) => string);
  42921. /**
  42922. * Loads an image as an HTMLImageElement.
  42923. * @param input url string, ArrayBuffer, or Blob to load
  42924. * @param onLoad callback called when the image successfully loads
  42925. * @param onError callback called when the image fails to load
  42926. * @param offlineProvider offline provider for caching
  42927. * @param mimeType optional mime type
  42928. * @returns the HTMLImageElement of the loaded image
  42929. */
  42930. static LoadImage(input: string | ArrayBuffer | Blob, onLoad: (img: HTMLImageElement | ImageBitmap) => void, onError: (message?: string, exception?: any) => void, offlineProvider: Nullable<IOfflineProvider>, mimeType?: string): Nullable<HTMLImageElement>;
  42931. /**
  42932. * Loads a file from a url
  42933. * @param url url string, ArrayBuffer, or Blob to load
  42934. * @param onSuccess callback called when the file successfully loads
  42935. * @param onProgress callback called while file is loading (if the server supports this mode)
  42936. * @param offlineProvider defines the offline provider for caching
  42937. * @param useArrayBuffer defines a boolean indicating that date must be returned as ArrayBuffer
  42938. * @param onError callback called when the file fails to load
  42939. * @returns a file request object
  42940. */
  42941. 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;
  42942. /**
  42943. * Loads a file from a url
  42944. * @param url the file url to load
  42945. * @param useArrayBuffer defines a boolean indicating that date must be returned as ArrayBuffer
  42946. * @returns a promise containing an ArrayBuffer corresponding to the loaded file
  42947. */
  42948. static LoadFileAsync(url: string, useArrayBuffer?: boolean): Promise<ArrayBuffer | string>;
  42949. /**
  42950. * Load a script (identified by an url). When the url returns, the
  42951. * content of this file is added into a new script element, attached to the DOM (body element)
  42952. * @param scriptUrl defines the url of the script to laod
  42953. * @param onSuccess defines the callback called when the script is loaded
  42954. * @param onError defines the callback to call if an error occurs
  42955. * @param scriptId defines the id of the script element
  42956. */
  42957. static LoadScript(scriptUrl: string, onSuccess: () => void, onError?: (message?: string, exception?: any) => void, scriptId?: string): void;
  42958. /**
  42959. * Load an asynchronous script (identified by an url). When the url returns, the
  42960. * content of this file is added into a new script element, attached to the DOM (body element)
  42961. * @param scriptUrl defines the url of the script to laod
  42962. * @param scriptId defines the id of the script element
  42963. * @returns a promise request object
  42964. */
  42965. static LoadScriptAsync(scriptUrl: string, scriptId?: string): Promise<void>;
  42966. /**
  42967. * Loads a file from a blob
  42968. * @param fileToLoad defines the blob to use
  42969. * @param callback defines the callback to call when data is loaded
  42970. * @param progressCallback defines the callback to call during loading process
  42971. * @returns a file request object
  42972. */
  42973. static ReadFileAsDataURL(fileToLoad: Blob, callback: (data: any) => void, progressCallback: (ev: ProgressEvent) => any): IFileRequest;
  42974. /**
  42975. * Reads a file from a File object
  42976. * @param file defines the file to load
  42977. * @param onSuccess defines the callback to call when data is loaded
  42978. * @param onProgress defines the callback to call during loading process
  42979. * @param useArrayBuffer defines a boolean indicating that data must be returned as an ArrayBuffer
  42980. * @param onError defines the callback to call when an error occurs
  42981. * @returns a file request object
  42982. */
  42983. static ReadFile(file: File, onSuccess: (data: any) => void, onProgress?: (ev: ProgressEvent) => any, useArrayBuffer?: boolean, onError?: (error: ReadFileError) => void): IFileRequest;
  42984. /**
  42985. * Creates a data url from a given string content
  42986. * @param content defines the content to convert
  42987. * @returns the new data url link
  42988. */
  42989. static FileAsURL(content: string): string;
  42990. /**
  42991. * Format the given number to a specific decimal format
  42992. * @param value defines the number to format
  42993. * @param decimals defines the number of decimals to use
  42994. * @returns the formatted string
  42995. */
  42996. static Format(value: number, decimals?: number): string;
  42997. /**
  42998. * Tries to copy an object by duplicating every property
  42999. * @param source defines the source object
  43000. * @param destination defines the target object
  43001. * @param doNotCopyList defines a list of properties to avoid
  43002. * @param mustCopyList defines a list of properties to copy (even if they start with _)
  43003. */
  43004. static DeepCopy(source: any, destination: any, doNotCopyList?: string[], mustCopyList?: string[]): void;
  43005. /**
  43006. * Gets a boolean indicating if the given object has no own property
  43007. * @param obj defines the object to test
  43008. * @returns true if object has no own property
  43009. */
  43010. static IsEmpty(obj: any): boolean;
  43011. /**
  43012. * Function used to register events at window level
  43013. * @param windowElement defines the Window object to use
  43014. * @param events defines the events to register
  43015. */
  43016. static RegisterTopRootEvents(windowElement: Window, events: {
  43017. name: string;
  43018. handler: Nullable<(e: FocusEvent) => any>;
  43019. }[]): void;
  43020. /**
  43021. * Function used to unregister events from window level
  43022. * @param windowElement defines the Window object to use
  43023. * @param events defines the events to unregister
  43024. */
  43025. static UnregisterTopRootEvents(windowElement: Window, events: {
  43026. name: string;
  43027. handler: Nullable<(e: FocusEvent) => any>;
  43028. }[]): void;
  43029. /**
  43030. * @ignore
  43031. */
  43032. static _ScreenshotCanvas: HTMLCanvasElement;
  43033. /**
  43034. * Dumps the current bound framebuffer
  43035. * @param width defines the rendering width
  43036. * @param height defines the rendering height
  43037. * @param engine defines the hosting engine
  43038. * @param successCallback defines the callback triggered once the data are available
  43039. * @param mimeType defines the mime type of the result
  43040. * @param fileName defines the filename to download. If present, the result will automatically be downloaded
  43041. */
  43042. static DumpFramebuffer(width: number, height: number, engine: Engine, successCallback?: (data: string) => void, mimeType?: string, fileName?: string): void;
  43043. /**
  43044. * Converts the canvas data to blob.
  43045. * This acts as a polyfill for browsers not supporting the to blob function.
  43046. * @param canvas Defines the canvas to extract the data from
  43047. * @param successCallback Defines the callback triggered once the data are available
  43048. * @param mimeType Defines the mime type of the result
  43049. */
  43050. static ToBlob(canvas: HTMLCanvasElement, successCallback: (blob: Nullable<Blob>) => void, mimeType?: string): void;
  43051. /**
  43052. * Encodes the canvas data to base 64 or automatically download the result if filename is defined
  43053. * @param successCallback defines the callback triggered once the data are available
  43054. * @param mimeType defines the mime type of the result
  43055. * @param fileName defines he filename to download. If present, the result will automatically be downloaded
  43056. */
  43057. static EncodeScreenshotCanvasData(successCallback?: (data: string) => void, mimeType?: string, fileName?: string): void;
  43058. /**
  43059. * Downloads a blob in the browser
  43060. * @param blob defines the blob to download
  43061. * @param fileName defines the name of the downloaded file
  43062. */
  43063. static Download(blob: Blob, fileName: string): void;
  43064. /**
  43065. * Captures a screenshot of the current rendering
  43066. * @see https://doc.babylonjs.com/how_to/render_scene_on_a_png
  43067. * @param engine defines the rendering engine
  43068. * @param camera defines the source camera
  43069. * @param size This parameter can be set to a single number or to an object with the
  43070. * following (optional) properties: precision, width, height. If a single number is passed,
  43071. * it will be used for both width and height. If an object is passed, the screenshot size
  43072. * will be derived from the parameters. The precision property is a multiplier allowing
  43073. * rendering at a higher or lower resolution
  43074. * @param successCallback defines the callback receives a single parameter which contains the
  43075. * screenshot as a string of base64-encoded characters. This string can be assigned to the
  43076. * src parameter of an <img> to display it
  43077. * @param mimeType defines the MIME type of the screenshot image (default: image/png).
  43078. * Check your browser for supported MIME types
  43079. */
  43080. static CreateScreenshot(engine: Engine, camera: Camera, size: IScreenshotSize | number, successCallback?: (data: string) => void, mimeType?: string): void;
  43081. /**
  43082. * Captures a screenshot of the current rendering
  43083. * @see https://doc.babylonjs.com/how_to/render_scene_on_a_png
  43084. * @param engine defines the rendering engine
  43085. * @param camera defines the source camera
  43086. * @param size This parameter can be set to a single number or to an object with the
  43087. * following (optional) properties: precision, width, height. If a single number is passed,
  43088. * it will be used for both width and height. If an object is passed, the screenshot size
  43089. * will be derived from the parameters. The precision property is a multiplier allowing
  43090. * rendering at a higher or lower resolution
  43091. * @param mimeType defines the MIME type of the screenshot image (default: image/png).
  43092. * Check your browser for supported MIME types
  43093. * @returns screenshot as a string of base64-encoded characters. This string can be assigned
  43094. * to the src parameter of an <img> to display it
  43095. */
  43096. static CreateScreenshotAsync(engine: Engine, camera: Camera, size: IScreenshotSize | number, mimeType?: string): Promise<string>;
  43097. /**
  43098. * Generates an image screenshot from the specified camera.
  43099. * @see https://doc.babylonjs.com/how_to/render_scene_on_a_png
  43100. * @param engine The engine to use for rendering
  43101. * @param camera The camera to use for rendering
  43102. * @param size This parameter can be set to a single number or to an object with the
  43103. * following (optional) properties: precision, width, height. If a single number is passed,
  43104. * it will be used for both width and height. If an object is passed, the screenshot size
  43105. * will be derived from the parameters. The precision property is a multiplier allowing
  43106. * rendering at a higher or lower resolution
  43107. * @param successCallback The callback receives a single parameter which contains the
  43108. * screenshot as a string of base64-encoded characters. This string can be assigned to the
  43109. * src parameter of an <img> to display it
  43110. * @param mimeType The MIME type of the screenshot image (default: image/png).
  43111. * Check your browser for supported MIME types
  43112. * @param samples Texture samples (default: 1)
  43113. * @param antialiasing Whether antialiasing should be turned on or not (default: false)
  43114. * @param fileName A name for for the downloaded file.
  43115. */
  43116. static CreateScreenshotUsingRenderTarget(engine: Engine, camera: Camera, size: IScreenshotSize | number, successCallback?: (data: string) => void, mimeType?: string, samples?: number, antialiasing?: boolean, fileName?: string): void;
  43117. /**
  43118. * Generates an image screenshot from the specified camera.
  43119. * @see https://doc.babylonjs.com/how_to/render_scene_on_a_png
  43120. * @param engine The engine to use for rendering
  43121. * @param camera The camera to use for rendering
  43122. * @param size This parameter can be set to a single number or to an object with the
  43123. * following (optional) properties: precision, width, height. If a single number is passed,
  43124. * it will be used for both width and height. If an object is passed, the screenshot size
  43125. * will be derived from the parameters. The precision property is a multiplier allowing
  43126. * rendering at a higher or lower resolution
  43127. * @param mimeType The MIME type of the screenshot image (default: image/png).
  43128. * Check your browser for supported MIME types
  43129. * @param samples Texture samples (default: 1)
  43130. * @param antialiasing Whether antialiasing should be turned on or not (default: false)
  43131. * @param fileName A name for for the downloaded file.
  43132. * @returns screenshot as a string of base64-encoded characters. This string can be assigned
  43133. * to the src parameter of an <img> to display it
  43134. */
  43135. static CreateScreenshotUsingRenderTargetAsync(engine: Engine, camera: Camera, size: IScreenshotSize | number, mimeType?: string, samples?: number, antialiasing?: boolean, fileName?: string): Promise<string>;
  43136. /**
  43137. * Implementation from http://stackoverflow.com/questions/105034/how-to-create-a-guid-uuid-in-javascript/2117523#answer-2117523
  43138. * Be aware Math.random() could cause collisions, but:
  43139. * "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"
  43140. * @returns a pseudo random id
  43141. */
  43142. static RandomId(): string;
  43143. /**
  43144. * Test if the given uri is a base64 string
  43145. * @param uri The uri to test
  43146. * @return True if the uri is a base64 string or false otherwise
  43147. */
  43148. static IsBase64(uri: string): boolean;
  43149. /**
  43150. * Decode the given base64 uri.
  43151. * @param uri The uri to decode
  43152. * @return The decoded base64 data.
  43153. */
  43154. static DecodeBase64(uri: string): ArrayBuffer;
  43155. /**
  43156. * Gets the absolute url.
  43157. * @param url the input url
  43158. * @return the absolute url
  43159. */
  43160. static GetAbsoluteUrl(url: string): string;
  43161. /**
  43162. * No log
  43163. */
  43164. static readonly NoneLogLevel: number;
  43165. /**
  43166. * Only message logs
  43167. */
  43168. static readonly MessageLogLevel: number;
  43169. /**
  43170. * Only warning logs
  43171. */
  43172. static readonly WarningLogLevel: number;
  43173. /**
  43174. * Only error logs
  43175. */
  43176. static readonly ErrorLogLevel: number;
  43177. /**
  43178. * All logs
  43179. */
  43180. static readonly AllLogLevel: number;
  43181. /**
  43182. * Gets a value indicating the number of loading errors
  43183. * @ignorenaming
  43184. */
  43185. static get errorsCount(): number;
  43186. /**
  43187. * Callback called when a new log is added
  43188. */
  43189. static OnNewCacheEntry: (entry: string) => void;
  43190. /**
  43191. * Log a message to the console
  43192. * @param message defines the message to log
  43193. */
  43194. static Log(message: string): void;
  43195. /**
  43196. * Write a warning message to the console
  43197. * @param message defines the message to log
  43198. */
  43199. static Warn(message: string): void;
  43200. /**
  43201. * Write an error message to the console
  43202. * @param message defines the message to log
  43203. */
  43204. static Error(message: string): void;
  43205. /**
  43206. * Gets current log cache (list of logs)
  43207. */
  43208. static get LogCache(): string;
  43209. /**
  43210. * Clears the log cache
  43211. */
  43212. static ClearLogCache(): void;
  43213. /**
  43214. * Sets the current log level (MessageLogLevel / WarningLogLevel / ErrorLogLevel)
  43215. */
  43216. static set LogLevels(level: number);
  43217. /**
  43218. * Checks if the window object exists
  43219. * Back Compat only, please use DomManagement.IsWindowObjectExist instead.
  43220. */
  43221. static IsWindowObjectExist: typeof DomManagement.IsWindowObjectExist;
  43222. /**
  43223. * No performance log
  43224. */
  43225. static readonly PerformanceNoneLogLevel: number;
  43226. /**
  43227. * Use user marks to log performance
  43228. */
  43229. static readonly PerformanceUserMarkLogLevel: number;
  43230. /**
  43231. * Log performance to the console
  43232. */
  43233. static readonly PerformanceConsoleLogLevel: number;
  43234. private static _performance;
  43235. /**
  43236. * Sets the current performance log level
  43237. */
  43238. static set PerformanceLogLevel(level: number);
  43239. private static _StartPerformanceCounterDisabled;
  43240. private static _EndPerformanceCounterDisabled;
  43241. private static _StartUserMark;
  43242. private static _EndUserMark;
  43243. private static _StartPerformanceConsole;
  43244. private static _EndPerformanceConsole;
  43245. /**
  43246. * Starts a performance counter
  43247. */
  43248. static StartPerformanceCounter: (counterName: string, condition?: boolean) => void;
  43249. /**
  43250. * Ends a specific performance coutner
  43251. */
  43252. static EndPerformanceCounter: (counterName: string, condition?: boolean) => void;
  43253. /**
  43254. * Gets either window.performance.now() if supported or Date.now() else
  43255. */
  43256. static get Now(): number;
  43257. /**
  43258. * This method will return the name of the class used to create the instance of the given object.
  43259. * It will works only on Javascript basic data types (number, string, ...) and instance of class declared with the @className decorator.
  43260. * @param object the object to get the class name from
  43261. * @param isType defines if the object is actually a type
  43262. * @returns the name of the class, will be "object" for a custom data type not using the @className decorator
  43263. */
  43264. static GetClassName(object: any, isType?: boolean): string;
  43265. /**
  43266. * Gets the first element of an array satisfying a given predicate
  43267. * @param array defines the array to browse
  43268. * @param predicate defines the predicate to use
  43269. * @returns null if not found or the element
  43270. */
  43271. static First<T>(array: Array<T>, predicate: (item: T) => boolean): Nullable<T>;
  43272. /**
  43273. * This method will return the name of the full name of the class, including its owning module (if any).
  43274. * 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).
  43275. * @param object the object to get the class name from
  43276. * @param isType defines if the object is actually a type
  43277. * @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.
  43278. * @ignorenaming
  43279. */
  43280. static getFullClassName(object: any, isType?: boolean): Nullable<string>;
  43281. /**
  43282. * Returns a promise that resolves after the given amount of time.
  43283. * @param delay Number of milliseconds to delay
  43284. * @returns Promise that resolves after the given amount of time
  43285. */
  43286. static DelayAsync(delay: number): Promise<void>;
  43287. /**
  43288. * Utility function to detect if the current user agent is Safari
  43289. * @returns whether or not the current user agent is safari
  43290. */
  43291. static IsSafari(): boolean;
  43292. }
  43293. /**
  43294. * Use this className as a decorator on a given class definition to add it a name and optionally its module.
  43295. * You can then use the Tools.getClassName(obj) on an instance to retrieve its class name.
  43296. * This method is the only way to get it done in all cases, even if the .js file declaring the class is minified
  43297. * @param name The name of the class, case should be preserved
  43298. * @param module The name of the Module hosting the class, optional, but strongly recommended to specify if possible. Case should be preserved.
  43299. */
  43300. export function className(name: string, module?: string): (target: Object) => void;
  43301. /**
  43302. * An implementation of a loop for asynchronous functions.
  43303. */
  43304. export class AsyncLoop {
  43305. /**
  43306. * Defines the number of iterations for the loop
  43307. */
  43308. iterations: number;
  43309. /**
  43310. * Defines the current index of the loop.
  43311. */
  43312. index: number;
  43313. private _done;
  43314. private _fn;
  43315. private _successCallback;
  43316. /**
  43317. * Constructor.
  43318. * @param iterations the number of iterations.
  43319. * @param func the function to run each iteration
  43320. * @param successCallback the callback that will be called upon succesful execution
  43321. * @param offset starting offset.
  43322. */
  43323. constructor(
  43324. /**
  43325. * Defines the number of iterations for the loop
  43326. */
  43327. iterations: number, func: (asyncLoop: AsyncLoop) => void, successCallback: () => void, offset?: number);
  43328. /**
  43329. * Execute the next iteration. Must be called after the last iteration was finished.
  43330. */
  43331. executeNext(): void;
  43332. /**
  43333. * Break the loop and run the success callback.
  43334. */
  43335. breakLoop(): void;
  43336. /**
  43337. * Create and run an async loop.
  43338. * @param iterations the number of iterations.
  43339. * @param fn the function to run each iteration
  43340. * @param successCallback the callback that will be called upon succesful execution
  43341. * @param offset starting offset.
  43342. * @returns the created async loop object
  43343. */
  43344. static Run(iterations: number, fn: (asyncLoop: AsyncLoop) => void, successCallback: () => void, offset?: number): AsyncLoop;
  43345. /**
  43346. * A for-loop that will run a given number of iterations synchronous and the rest async.
  43347. * @param iterations total number of iterations
  43348. * @param syncedIterations number of synchronous iterations in each async iteration.
  43349. * @param fn the function to call each iteration.
  43350. * @param callback a success call back that will be called when iterating stops.
  43351. * @param breakFunction a break condition (optional)
  43352. * @param timeout timeout settings for the setTimeout function. default - 0.
  43353. * @returns the created async loop object
  43354. */
  43355. static SyncAsyncForLoop(iterations: number, syncedIterations: number, fn: (iteration: number) => void, callback: () => void, breakFunction?: () => boolean, timeout?: number): AsyncLoop;
  43356. }
  43357. }
  43358. declare module "babylonjs/Misc/stringDictionary" {
  43359. import { Nullable } from "babylonjs/types";
  43360. /**
  43361. * This class implement a typical dictionary using a string as key and the generic type T as value.
  43362. * The underlying implementation relies on an associative array to ensure the best performances.
  43363. * The value can be anything including 'null' but except 'undefined'
  43364. */
  43365. export class StringDictionary<T> {
  43366. /**
  43367. * This will clear this dictionary and copy the content from the 'source' one.
  43368. * If the T value is a custom object, it won't be copied/cloned, the same object will be used
  43369. * @param source the dictionary to take the content from and copy to this dictionary
  43370. */
  43371. copyFrom(source: StringDictionary<T>): void;
  43372. /**
  43373. * Get a value based from its key
  43374. * @param key the given key to get the matching value from
  43375. * @return the value if found, otherwise undefined is returned
  43376. */
  43377. get(key: string): T | undefined;
  43378. /**
  43379. * Get a value from its key or add it if it doesn't exist.
  43380. * This method will ensure you that a given key/data will be present in the dictionary.
  43381. * @param key the given key to get the matching value from
  43382. * @param factory the factory that will create the value if the key is not present in the dictionary.
  43383. * The factory will only be invoked if there's no data for the given key.
  43384. * @return the value corresponding to the key.
  43385. */
  43386. getOrAddWithFactory(key: string, factory: (key: string) => T): T;
  43387. /**
  43388. * Get a value from its key if present in the dictionary otherwise add it
  43389. * @param key the key to get the value from
  43390. * @param val if there's no such key/value pair in the dictionary add it with this value
  43391. * @return the value corresponding to the key
  43392. */
  43393. getOrAdd(key: string, val: T): T;
  43394. /**
  43395. * Check if there's a given key in the dictionary
  43396. * @param key the key to check for
  43397. * @return true if the key is present, false otherwise
  43398. */
  43399. contains(key: string): boolean;
  43400. /**
  43401. * Add a new key and its corresponding value
  43402. * @param key the key to add
  43403. * @param value the value corresponding to the key
  43404. * @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
  43405. */
  43406. add(key: string, value: T): boolean;
  43407. /**
  43408. * Update a specific value associated to a key
  43409. * @param key defines the key to use
  43410. * @param value defines the value to store
  43411. * @returns true if the value was updated (or false if the key was not found)
  43412. */
  43413. set(key: string, value: T): boolean;
  43414. /**
  43415. * Get the element of the given key and remove it from the dictionary
  43416. * @param key defines the key to search
  43417. * @returns the value associated with the key or null if not found
  43418. */
  43419. getAndRemove(key: string): Nullable<T>;
  43420. /**
  43421. * Remove a key/value from the dictionary.
  43422. * @param key the key to remove
  43423. * @return true if the item was successfully deleted, false if no item with such key exist in the dictionary
  43424. */
  43425. remove(key: string): boolean;
  43426. /**
  43427. * Clear the whole content of the dictionary
  43428. */
  43429. clear(): void;
  43430. /**
  43431. * Gets the current count
  43432. */
  43433. get count(): number;
  43434. /**
  43435. * Execute a callback on each key/val of the dictionary.
  43436. * Note that you can remove any element in this dictionary in the callback implementation
  43437. * @param callback the callback to execute on a given key/value pair
  43438. */
  43439. forEach(callback: (key: string, val: T) => void): void;
  43440. /**
  43441. * Execute a callback on every occurrence of the dictionary until it returns a valid TRes object.
  43442. * If the callback returns null or undefined the method will iterate to the next key/value pair
  43443. * Note that you can remove any element in this dictionary in the callback implementation
  43444. * @param callback the callback to execute, if it return a valid T instanced object the enumeration will stop and the object will be returned
  43445. * @returns the first item
  43446. */
  43447. first<TRes>(callback: (key: string, val: T) => TRes): TRes | null;
  43448. private _count;
  43449. private _data;
  43450. }
  43451. }
  43452. declare module "babylonjs/Collisions/collisionCoordinator" {
  43453. import { Nullable } from "babylonjs/types";
  43454. import { Scene } from "babylonjs/scene";
  43455. import { Vector3 } from "babylonjs/Maths/math.vector";
  43456. import { Collider } from "babylonjs/Collisions/collider";
  43457. import { AbstractMesh } from "babylonjs/Meshes/abstractMesh";
  43458. /** @hidden */
  43459. export interface ICollisionCoordinator {
  43460. createCollider(): Collider;
  43461. getNewPosition(position: Vector3, displacement: Vector3, collider: Collider, maximumRetry: number, excludedMesh: Nullable<AbstractMesh>, onNewPosition: (collisionIndex: number, newPosition: Vector3, collidedMesh: Nullable<AbstractMesh>) => void, collisionIndex: number): void;
  43462. init(scene: Scene): void;
  43463. }
  43464. /** @hidden */
  43465. export class DefaultCollisionCoordinator implements ICollisionCoordinator {
  43466. private _scene;
  43467. private _scaledPosition;
  43468. private _scaledVelocity;
  43469. private _finalPosition;
  43470. getNewPosition(position: Vector3, displacement: Vector3, collider: Collider, maximumRetry: number, excludedMesh: AbstractMesh, onNewPosition: (collisionIndex: number, newPosition: Vector3, collidedMesh: Nullable<AbstractMesh>) => void, collisionIndex: number): void;
  43471. createCollider(): Collider;
  43472. init(scene: Scene): void;
  43473. private _collideWithWorld;
  43474. }
  43475. }
  43476. declare module "babylonjs/Inputs/scene.inputManager" {
  43477. import { Nullable } from "babylonjs/types";
  43478. import { PickingInfo } from "babylonjs/Collisions/pickingInfo";
  43479. import { Vector2 } from "babylonjs/Maths/math.vector";
  43480. import { AbstractMesh } from "babylonjs/Meshes/abstractMesh";
  43481. import { Scene } from "babylonjs/scene";
  43482. /**
  43483. * Class used to manage all inputs for the scene.
  43484. */
  43485. export class InputManager {
  43486. /** The distance in pixel that you have to move to prevent some events */
  43487. static DragMovementThreshold: number;
  43488. /** Time in milliseconds to wait to raise long press events if button is still pressed */
  43489. static LongPressDelay: number;
  43490. /** Time in milliseconds with two consecutive clicks will be considered as a double click */
  43491. static DoubleClickDelay: number;
  43492. /** If you need to check double click without raising a single click at first click, enable this flag */
  43493. static ExclusiveDoubleClickMode: boolean;
  43494. /** 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. */
  43495. private _alreadyAttached;
  43496. private _alreadyAttachedTo;
  43497. private _wheelEventName;
  43498. private _onPointerMove;
  43499. private _onPointerDown;
  43500. private _onPointerUp;
  43501. private _initClickEvent;
  43502. private _initActionManager;
  43503. private _delayedSimpleClick;
  43504. private _delayedSimpleClickTimeout;
  43505. private _previousDelayedSimpleClickTimeout;
  43506. private _meshPickProceed;
  43507. private _previousButtonPressed;
  43508. private _currentPickResult;
  43509. private _previousPickResult;
  43510. private _totalPointersPressed;
  43511. private _doubleClickOccured;
  43512. private _pointerOverMesh;
  43513. private _pickedDownMesh;
  43514. private _pickedUpMesh;
  43515. private _pointerX;
  43516. private _pointerY;
  43517. private _unTranslatedPointerX;
  43518. private _unTranslatedPointerY;
  43519. private _startingPointerPosition;
  43520. private _previousStartingPointerPosition;
  43521. private _startingPointerTime;
  43522. private _previousStartingPointerTime;
  43523. private _pointerCaptures;
  43524. private _meshUnderPointerId;
  43525. private _onKeyDown;
  43526. private _onKeyUp;
  43527. private _keyboardIsAttached;
  43528. private _onCanvasFocusObserver;
  43529. private _onCanvasBlurObserver;
  43530. private _scene;
  43531. /**
  43532. * Creates a new InputManager
  43533. * @param scene defines the hosting scene
  43534. */
  43535. constructor(scene: Scene);
  43536. /**
  43537. * Gets the mesh that is currently under the pointer
  43538. */
  43539. get meshUnderPointer(): Nullable<AbstractMesh>;
  43540. /**
  43541. * When using more than one pointer (for example in XR) you can get the mesh under the specific pointer
  43542. * @param pointerId the pointer id to use
  43543. * @returns The mesh under this pointer id or null if not found
  43544. */
  43545. getMeshUnderPointerByPointerId(pointerId: number): Nullable<AbstractMesh>;
  43546. /**
  43547. * Gets the pointer coordinates in 2D without any translation (ie. straight out of the pointer event)
  43548. */
  43549. get unTranslatedPointer(): Vector2;
  43550. /**
  43551. * Gets or sets the current on-screen X position of the pointer
  43552. */
  43553. get pointerX(): number;
  43554. set pointerX(value: number);
  43555. /**
  43556. * Gets or sets the current on-screen Y position of the pointer
  43557. */
  43558. get pointerY(): number;
  43559. set pointerY(value: number);
  43560. private _updatePointerPosition;
  43561. private _processPointerMove;
  43562. private _setRayOnPointerInfo;
  43563. private _checkPrePointerObservable;
  43564. /**
  43565. * Use this method to simulate a pointer move on a mesh
  43566. * The pickResult parameter can be obtained from a scene.pick or scene.pickWithRay
  43567. * @param pickResult pickingInfo of the object wished to simulate pointer event on
  43568. * @param pointerEventInit pointer event state to be used when simulating the pointer event (eg. pointer id for multitouch)
  43569. */
  43570. simulatePointerMove(pickResult: PickingInfo, pointerEventInit?: PointerEventInit): void;
  43571. /**
  43572. * Use this method to simulate a pointer down on a mesh
  43573. * The pickResult parameter can be obtained from a scene.pick or scene.pickWithRay
  43574. * @param pickResult pickingInfo of the object wished to simulate pointer event on
  43575. * @param pointerEventInit pointer event state to be used when simulating the pointer event (eg. pointer id for multitouch)
  43576. */
  43577. simulatePointerDown(pickResult: PickingInfo, pointerEventInit?: PointerEventInit): void;
  43578. private _processPointerDown;
  43579. /** @hidden */
  43580. _isPointerSwiping(): boolean;
  43581. /**
  43582. * Use this method to simulate a pointer up on a mesh
  43583. * The pickResult parameter can be obtained from a scene.pick or scene.pickWithRay
  43584. * @param pickResult pickingInfo of the object wished to simulate pointer event on
  43585. * @param pointerEventInit pointer event state to be used when simulating the pointer event (eg. pointer id for multitouch)
  43586. * @param doubleTap indicates that the pointer up event should be considered as part of a double click (false by default)
  43587. */
  43588. simulatePointerUp(pickResult: PickingInfo, pointerEventInit?: PointerEventInit, doubleTap?: boolean): void;
  43589. private _processPointerUp;
  43590. /**
  43591. * Gets a boolean indicating if the current pointer event is captured (meaning that the scene has already handled the pointer down)
  43592. * @param pointerId defines the pointer id to use in a multi-touch scenario (0 by default)
  43593. * @returns true if the pointer was captured
  43594. */
  43595. isPointerCaptured(pointerId?: number): boolean;
  43596. /**
  43597. * Attach events to the canvas (To handle actionManagers triggers and raise onPointerMove, onPointerDown and onPointerUp
  43598. * @param attachUp defines if you want to attach events to pointerup
  43599. * @param attachDown defines if you want to attach events to pointerdown
  43600. * @param attachMove defines if you want to attach events to pointermove
  43601. * @param elementToAttachTo defines the target DOM element to attach to (will use the canvas by default)
  43602. */
  43603. attachControl(attachUp?: boolean, attachDown?: boolean, attachMove?: boolean, elementToAttachTo?: Nullable<HTMLElement>): void;
  43604. /**
  43605. * Detaches all event handlers
  43606. */
  43607. detachControl(): void;
  43608. /**
  43609. * Force the value of meshUnderPointer
  43610. * @param mesh defines the mesh to use
  43611. * @param pointerId optional pointer id when using more than one pointer. Defaults to 0
  43612. */
  43613. setPointerOverMesh(mesh: Nullable<AbstractMesh>, pointerId?: number): void;
  43614. /**
  43615. * Gets the mesh under the pointer
  43616. * @returns a Mesh or null if no mesh is under the pointer
  43617. */
  43618. getPointerOverMesh(): Nullable<AbstractMesh>;
  43619. }
  43620. }
  43621. declare module "babylonjs/Animations/animationGroup" {
  43622. import { Animatable } from "babylonjs/Animations/animatable";
  43623. import { Animation } from "babylonjs/Animations/animation";
  43624. import { Scene, IDisposable } from "babylonjs/scene";
  43625. import { Observable } from "babylonjs/Misc/observable";
  43626. import { Nullable } from "babylonjs/types";
  43627. import "babylonjs/Animations/animatable";
  43628. /**
  43629. * This class defines the direct association between an animation and a target
  43630. */
  43631. export class TargetedAnimation {
  43632. /**
  43633. * Animation to perform
  43634. */
  43635. animation: Animation;
  43636. /**
  43637. * Target to animate
  43638. */
  43639. target: any;
  43640. /**
  43641. * Returns the string "TargetedAnimation"
  43642. * @returns "TargetedAnimation"
  43643. */
  43644. getClassName(): string;
  43645. /**
  43646. * Serialize the object
  43647. * @returns the JSON object representing the current entity
  43648. */
  43649. serialize(): any;
  43650. }
  43651. /**
  43652. * Use this class to create coordinated animations on multiple targets
  43653. */
  43654. export class AnimationGroup implements IDisposable {
  43655. /** The name of the animation group */
  43656. name: string;
  43657. private _scene;
  43658. private _targetedAnimations;
  43659. private _animatables;
  43660. private _from;
  43661. private _to;
  43662. private _isStarted;
  43663. private _isPaused;
  43664. private _speedRatio;
  43665. private _loopAnimation;
  43666. private _isAdditive;
  43667. /**
  43668. * Gets or sets the unique id of the node
  43669. */
  43670. uniqueId: number;
  43671. /**
  43672. * This observable will notify when one animation have ended
  43673. */
  43674. onAnimationEndObservable: Observable<TargetedAnimation>;
  43675. /**
  43676. * Observer raised when one animation loops
  43677. */
  43678. onAnimationLoopObservable: Observable<TargetedAnimation>;
  43679. /**
  43680. * Observer raised when all animations have looped
  43681. */
  43682. onAnimationGroupLoopObservable: Observable<AnimationGroup>;
  43683. /**
  43684. * This observable will notify when all animations have ended.
  43685. */
  43686. onAnimationGroupEndObservable: Observable<AnimationGroup>;
  43687. /**
  43688. * This observable will notify when all animations have paused.
  43689. */
  43690. onAnimationGroupPauseObservable: Observable<AnimationGroup>;
  43691. /**
  43692. * This observable will notify when all animations are playing.
  43693. */
  43694. onAnimationGroupPlayObservable: Observable<AnimationGroup>;
  43695. /**
  43696. * Gets the first frame
  43697. */
  43698. get from(): number;
  43699. /**
  43700. * Gets the last frame
  43701. */
  43702. get to(): number;
  43703. /**
  43704. * Define if the animations are started
  43705. */
  43706. get isStarted(): boolean;
  43707. /**
  43708. * Gets a value indicating that the current group is playing
  43709. */
  43710. get isPlaying(): boolean;
  43711. /**
  43712. * Gets or sets the speed ratio to use for all animations
  43713. */
  43714. get speedRatio(): number;
  43715. /**
  43716. * Gets or sets the speed ratio to use for all animations
  43717. */
  43718. set speedRatio(value: number);
  43719. /**
  43720. * Gets or sets if all animations should loop or not
  43721. */
  43722. get loopAnimation(): boolean;
  43723. set loopAnimation(value: boolean);
  43724. /**
  43725. * Gets or sets if all animations should be evaluated additively
  43726. */
  43727. get isAdditive(): boolean;
  43728. set isAdditive(value: boolean);
  43729. /**
  43730. * Gets the targeted animations for this animation group
  43731. */
  43732. get targetedAnimations(): Array<TargetedAnimation>;
  43733. /**
  43734. * returning the list of animatables controlled by this animation group.
  43735. */
  43736. get animatables(): Array<Animatable>;
  43737. /**
  43738. * Gets the list of target animations
  43739. */
  43740. get children(): TargetedAnimation[];
  43741. /**
  43742. * Instantiates a new Animation Group.
  43743. * This helps managing several animations at once.
  43744. * @see https://doc.babylonjs.com/how_to/group
  43745. * @param name Defines the name of the group
  43746. * @param scene Defines the scene the group belongs to
  43747. */
  43748. constructor(
  43749. /** The name of the animation group */
  43750. name: string, scene?: Nullable<Scene>);
  43751. /**
  43752. * Add an animation (with its target) in the group
  43753. * @param animation defines the animation we want to add
  43754. * @param target defines the target of the animation
  43755. * @returns the TargetedAnimation object
  43756. */
  43757. addTargetedAnimation(animation: Animation, target: any): TargetedAnimation;
  43758. /**
  43759. * This function will normalize every animation in the group to make sure they all go from beginFrame to endFrame
  43760. * It can add constant keys at begin or end
  43761. * @param beginFrame defines the new begin frame for all animations or the smallest begin frame of all animations if null (defaults to null)
  43762. * @param endFrame defines the new end frame for all animations or the largest end frame of all animations if null (defaults to null)
  43763. * @returns the animation group
  43764. */
  43765. normalize(beginFrame?: Nullable<number>, endFrame?: Nullable<number>): AnimationGroup;
  43766. private _animationLoopCount;
  43767. private _animationLoopFlags;
  43768. private _processLoop;
  43769. /**
  43770. * Start all animations on given targets
  43771. * @param loop defines if animations must loop
  43772. * @param speedRatio defines the ratio to apply to animation speed (1 by default)
  43773. * @param from defines the from key (optional)
  43774. * @param to defines the to key (optional)
  43775. * @param isAdditive defines the additive state for the resulting animatables (optional)
  43776. * @returns the current animation group
  43777. */
  43778. start(loop?: boolean, speedRatio?: number, from?: number, to?: number, isAdditive?: boolean): AnimationGroup;
  43779. /**
  43780. * Pause all animations
  43781. * @returns the animation group
  43782. */
  43783. pause(): AnimationGroup;
  43784. /**
  43785. * Play all animations to initial state
  43786. * This function will start() the animations if they were not started or will restart() them if they were paused
  43787. * @param loop defines if animations must loop
  43788. * @returns the animation group
  43789. */
  43790. play(loop?: boolean): AnimationGroup;
  43791. /**
  43792. * Reset all animations to initial state
  43793. * @returns the animation group
  43794. */
  43795. reset(): AnimationGroup;
  43796. /**
  43797. * Restart animations from key 0
  43798. * @returns the animation group
  43799. */
  43800. restart(): AnimationGroup;
  43801. /**
  43802. * Stop all animations
  43803. * @returns the animation group
  43804. */
  43805. stop(): AnimationGroup;
  43806. /**
  43807. * Set animation weight for all animatables
  43808. * @param weight defines the weight to use
  43809. * @return the animationGroup
  43810. * @see https://doc.babylonjs.com/babylon101/animations#animation-weights
  43811. */
  43812. setWeightForAllAnimatables(weight: number): AnimationGroup;
  43813. /**
  43814. * Synchronize and normalize all animatables with a source animatable
  43815. * @param root defines the root animatable to synchronize with
  43816. * @return the animationGroup
  43817. * @see https://doc.babylonjs.com/babylon101/animations#animation-weights
  43818. */
  43819. syncAllAnimationsWith(root: Animatable): AnimationGroup;
  43820. /**
  43821. * Goes to a specific frame in this animation group
  43822. * @param frame the frame number to go to
  43823. * @return the animationGroup
  43824. */
  43825. goToFrame(frame: number): AnimationGroup;
  43826. /**
  43827. * Dispose all associated resources
  43828. */
  43829. dispose(): void;
  43830. private _checkAnimationGroupEnded;
  43831. /**
  43832. * Clone the current animation group and returns a copy
  43833. * @param newName defines the name of the new group
  43834. * @param targetConverter defines an optional function used to convert current animation targets to new ones
  43835. * @returns the new aniamtion group
  43836. */
  43837. clone(newName: string, targetConverter?: (oldTarget: any) => any): AnimationGroup;
  43838. /**
  43839. * Serializes the animationGroup to an object
  43840. * @returns Serialized object
  43841. */
  43842. serialize(): any;
  43843. /**
  43844. * Returns a new AnimationGroup object parsed from the source provided.
  43845. * @param parsedAnimationGroup defines the source
  43846. * @param scene defines the scene that will receive the animationGroup
  43847. * @returns a new AnimationGroup
  43848. */
  43849. static Parse(parsedAnimationGroup: any, scene: Scene): AnimationGroup;
  43850. /**
  43851. * Convert the keyframes for all animations belonging to the group to be relative to a given reference frame.
  43852. * @param sourceAnimationGroup defines the AnimationGroup containing animations to convert
  43853. * @param referenceFrame defines the frame that keyframes in the range will be relative to
  43854. * @param range defines the name of the AnimationRange belonging to the animations in the group to convert
  43855. * @param cloneOriginal defines whether or not to clone the group and convert the clone or convert the original group (default is false)
  43856. * @param clonedName defines the name of the resulting cloned AnimationGroup if cloneOriginal is true
  43857. * @returns a new AnimationGroup if cloneOriginal is true or the original AnimationGroup if cloneOriginal is false
  43858. */
  43859. static MakeAnimationAdditive(sourceAnimationGroup: AnimationGroup, referenceFrame?: number, range?: string, cloneOriginal?: boolean, clonedName?: string): AnimationGroup;
  43860. /**
  43861. * Returns the string "AnimationGroup"
  43862. * @returns "AnimationGroup"
  43863. */
  43864. getClassName(): string;
  43865. /**
  43866. * Creates a detailled string about the object
  43867. * @param fullDetails defines if the output string will support multiple levels of logging within scene loading
  43868. * @returns a string representing the object
  43869. */
  43870. toString(fullDetails?: boolean): string;
  43871. }
  43872. }
  43873. declare module "babylonjs/scene" {
  43874. import { Nullable } from "babylonjs/types";
  43875. import { IAnimatable } from "babylonjs/Animations/animatable.interface";
  43876. import { Observable } from "babylonjs/Misc/observable";
  43877. import { SmartArrayNoDuplicate, SmartArray, ISmartArrayLike } from "babylonjs/Misc/smartArray";
  43878. import { Vector2, Vector3, Matrix } from "babylonjs/Maths/math.vector";
  43879. import { Geometry } from "babylonjs/Meshes/geometry";
  43880. import { TransformNode } from "babylonjs/Meshes/transformNode";
  43881. import { SubMesh } from "babylonjs/Meshes/subMesh";
  43882. import { AbstractMesh } from "babylonjs/Meshes/abstractMesh";
  43883. import { Mesh } from "babylonjs/Meshes/mesh";
  43884. import { IParticleSystem } from "babylonjs/Particles/IParticleSystem";
  43885. import { Bone } from "babylonjs/Bones/bone";
  43886. import { Skeleton } from "babylonjs/Bones/skeleton";
  43887. import { MorphTargetManager } from "babylonjs/Morph/morphTargetManager";
  43888. import { Camera } from "babylonjs/Cameras/camera";
  43889. import { AbstractScene } from "babylonjs/abstractScene";
  43890. import { BaseTexture } from "babylonjs/Materials/Textures/baseTexture";
  43891. import { RenderTargetTexture } from "babylonjs/Materials/Textures/renderTargetTexture";
  43892. import { Material } from "babylonjs/Materials/material";
  43893. import { ImageProcessingConfiguration } from "babylonjs/Materials/imageProcessingConfiguration";
  43894. import { Effect } from "babylonjs/Materials/effect";
  43895. import { UniformBuffer } from "babylonjs/Materials/uniformBuffer";
  43896. import { MultiMaterial } from "babylonjs/Materials/multiMaterial";
  43897. import { Light } from "babylonjs/Lights/light";
  43898. import { PickingInfo } from "babylonjs/Collisions/pickingInfo";
  43899. import { ICollisionCoordinator } from "babylonjs/Collisions/collisionCoordinator";
  43900. import { PointerEventTypes, PointerInfoPre, PointerInfo } from "babylonjs/Events/pointerEvents";
  43901. import { KeyboardInfoPre, KeyboardInfo } from "babylonjs/Events/keyboardEvents";
  43902. import { PostProcessManager } from "babylonjs/PostProcesses/postProcessManager";
  43903. import { IOfflineProvider } from "babylonjs/Offline/IOfflineProvider";
  43904. import { RenderingGroupInfo, IRenderingManagerAutoClearSetup } from "babylonjs/Rendering/renderingManager";
  43905. import { ISceneComponent, ISceneSerializableComponent, Stage, SimpleStageAction, RenderTargetsStageAction, RenderTargetStageAction, MeshStageAction, EvaluateSubMeshStageAction, ActiveMeshStageAction, CameraStageAction, RenderingGroupStageAction, RenderingMeshStageAction, PointerMoveStageAction, PointerUpDownStageAction, CameraStageFrameBufferAction } from "babylonjs/sceneComponent";
  43906. import { Engine } from "babylonjs/Engines/engine";
  43907. import { Node } from "babylonjs/node";
  43908. import { MorphTarget } from "babylonjs/Morph/morphTarget";
  43909. import { AbstractActionManager } from "babylonjs/Actions/abstractActionManager";
  43910. import { WebRequest } from "babylonjs/Misc/webRequest";
  43911. import { InputManager } from "babylonjs/Inputs/scene.inputManager";
  43912. import { PerfCounter } from "babylonjs/Misc/perfCounter";
  43913. import { IFileRequest } from "babylonjs/Misc/fileRequest";
  43914. import { Color4, Color3 } from "babylonjs/Maths/math.color";
  43915. import { Plane } from "babylonjs/Maths/math.plane";
  43916. import { LoadFileError, RequestFileError, ReadFileError } from "babylonjs/Misc/fileTools";
  43917. import { IClipPlanesHolder } from "babylonjs/Misc/interfaces/iClipPlanesHolder";
  43918. import { Ray } from "babylonjs/Culling/ray";
  43919. import { TrianglePickingPredicate } from "babylonjs/Culling/ray";
  43920. import { Animation } from "babylonjs/Animations/animation";
  43921. import { Animatable } from "babylonjs/Animations/animatable";
  43922. import { AnimationGroup } from "babylonjs/Animations/animationGroup";
  43923. import { AnimationPropertiesOverride } from "babylonjs/Animations/animationPropertiesOverride";
  43924. import { Collider } from "babylonjs/Collisions/collider";
  43925. import { PostProcess } from "babylonjs/PostProcesses/postProcess";
  43926. /**
  43927. * Define an interface for all classes that will hold resources
  43928. */
  43929. export interface IDisposable {
  43930. /**
  43931. * Releases all held resources
  43932. */
  43933. dispose(): void;
  43934. }
  43935. /** Interface defining initialization parameters for Scene class */
  43936. export interface SceneOptions {
  43937. /**
  43938. * Defines that scene should keep up-to-date a map of geometry to enable fast look-up by uniqueId
  43939. * It will improve performance when the number of geometries becomes important.
  43940. */
  43941. useGeometryUniqueIdsMap?: boolean;
  43942. /**
  43943. * Defines that each material of the scene should keep up-to-date a map of referencing meshes for fast diposing
  43944. * It will improve performance when the number of mesh becomes important, but might consume a bit more memory
  43945. */
  43946. useMaterialMeshMap?: boolean;
  43947. /**
  43948. * Defines that each mesh of the scene should keep up-to-date a map of referencing cloned meshes for fast diposing
  43949. * It will improve performance when the number of mesh becomes important, but might consume a bit more memory
  43950. */
  43951. useClonedMeshMap?: boolean;
  43952. /** Defines if the creation of the scene should impact the engine (Eg. UtilityLayer's scene) */
  43953. virtual?: boolean;
  43954. }
  43955. /**
  43956. * Represents a scene to be rendered by the engine.
  43957. * @see https://doc.babylonjs.com/features/scene
  43958. */
  43959. export class Scene extends AbstractScene implements IAnimatable, IClipPlanesHolder {
  43960. /** The fog is deactivated */
  43961. static readonly FOGMODE_NONE: number;
  43962. /** The fog density is following an exponential function */
  43963. static readonly FOGMODE_EXP: number;
  43964. /** The fog density is following an exponential function faster than FOGMODE_EXP */
  43965. static readonly FOGMODE_EXP2: number;
  43966. /** The fog density is following a linear function. */
  43967. static readonly FOGMODE_LINEAR: number;
  43968. /**
  43969. * Gets or sets the minimum deltatime when deterministic lock step is enabled
  43970. * @see https://doc.babylonjs.com/babylon101/animations#deterministic-lockstep
  43971. */
  43972. static MinDeltaTime: number;
  43973. /**
  43974. * Gets or sets the maximum deltatime when deterministic lock step is enabled
  43975. * @see https://doc.babylonjs.com/babylon101/animations#deterministic-lockstep
  43976. */
  43977. static MaxDeltaTime: number;
  43978. /**
  43979. * Factory used to create the default material.
  43980. * @param name The name of the material to create
  43981. * @param scene The scene to create the material for
  43982. * @returns The default material
  43983. */
  43984. static DefaultMaterialFactory(scene: Scene): Material;
  43985. /**
  43986. * Factory used to create the a collision coordinator.
  43987. * @returns The collision coordinator
  43988. */
  43989. static CollisionCoordinatorFactory(): ICollisionCoordinator;
  43990. /** @hidden */
  43991. _inputManager: InputManager;
  43992. /** Define this parameter if you are using multiple cameras and you want to specify which one should be used for pointer position */
  43993. cameraToUseForPointers: Nullable<Camera>;
  43994. /** @hidden */
  43995. readonly _isScene: boolean;
  43996. /** @hidden */
  43997. _blockEntityCollection: boolean;
  43998. /**
  43999. * Gets or sets a boolean that indicates if the scene must clear the render buffer before rendering a frame
  44000. */
  44001. autoClear: boolean;
  44002. /**
  44003. * Gets or sets a boolean that indicates if the scene must clear the depth and stencil buffers before rendering a frame
  44004. */
  44005. autoClearDepthAndStencil: boolean;
  44006. /**
  44007. * Defines the color used to clear the render buffer (Default is (0.2, 0.2, 0.3, 1.0))
  44008. */
  44009. clearColor: Color4;
  44010. /**
  44011. * Defines the color used to simulate the ambient color (Default is (0, 0, 0))
  44012. */
  44013. ambientColor: Color3;
  44014. /**
  44015. * This is use to store the default BRDF lookup for PBR materials in your scene.
  44016. * It should only be one of the following (if not the default embedded one):
  44017. * * For uncorrelated BRDF (pbr.brdf.useEnergyConservation = false and pbr.brdf.useSmithVisibilityHeightCorrelated = false) : https://assets.babylonjs.com/environments/uncorrelatedBRDF.dds
  44018. * * For correlated BRDF (pbr.brdf.useEnergyConservation = false and pbr.brdf.useSmithVisibilityHeightCorrelated = true) : https://assets.babylonjs.com/environments/correlatedBRDF.dds
  44019. * * For correlated multi scattering BRDF (pbr.brdf.useEnergyConservation = true and pbr.brdf.useSmithVisibilityHeightCorrelated = true) : https://assets.babylonjs.com/environments/correlatedMSBRDF.dds
  44020. * The material properties need to be setup according to the type of texture in use.
  44021. */
  44022. environmentBRDFTexture: BaseTexture;
  44023. /**
  44024. * Texture used in all pbr material as the reflection texture.
  44025. * As in the majority of the scene they are the same (exception for multi room and so on),
  44026. * this is easier to reference from here than from all the materials.
  44027. */
  44028. get environmentTexture(): Nullable<BaseTexture>;
  44029. /**
  44030. * Texture used in all pbr material as the reflection texture.
  44031. * As in the majority of the scene they are the same (exception for multi room and so on),
  44032. * this is easier to set here than in all the materials.
  44033. */
  44034. set environmentTexture(value: Nullable<BaseTexture>);
  44035. /** @hidden */
  44036. protected _environmentIntensity: number;
  44037. /**
  44038. * Intensity of the environment in all pbr material.
  44039. * This dims or reinforces the IBL lighting overall (reflection and diffuse).
  44040. * As in the majority of the scene they are the same (exception for multi room and so on),
  44041. * this is easier to reference from here than from all the materials.
  44042. */
  44043. get environmentIntensity(): number;
  44044. /**
  44045. * Intensity of the environment in all pbr material.
  44046. * This dims or reinforces the IBL lighting overall (reflection and diffuse).
  44047. * As in the majority of the scene they are the same (exception for multi room and so on),
  44048. * this is easier to set here than in all the materials.
  44049. */
  44050. set environmentIntensity(value: number);
  44051. /** @hidden */
  44052. protected _imageProcessingConfiguration: ImageProcessingConfiguration;
  44053. /**
  44054. * Default image processing configuration used either in the rendering
  44055. * Forward main pass or through the imageProcessingPostProcess if present.
  44056. * As in the majority of the scene they are the same (exception for multi camera),
  44057. * this is easier to reference from here than from all the materials and post process.
  44058. *
  44059. * No setter as we it is a shared configuration, you can set the values instead.
  44060. */
  44061. get imageProcessingConfiguration(): ImageProcessingConfiguration;
  44062. private _forceWireframe;
  44063. /**
  44064. * Gets or sets a boolean indicating if all rendering must be done in wireframe
  44065. */
  44066. set forceWireframe(value: boolean);
  44067. get forceWireframe(): boolean;
  44068. private _skipFrustumClipping;
  44069. /**
  44070. * Gets or sets a boolean indicating if we should skip the frustum clipping part of the active meshes selection
  44071. */
  44072. set skipFrustumClipping(value: boolean);
  44073. get skipFrustumClipping(): boolean;
  44074. private _forcePointsCloud;
  44075. /**
  44076. * Gets or sets a boolean indicating if all rendering must be done in point cloud
  44077. */
  44078. set forcePointsCloud(value: boolean);
  44079. get forcePointsCloud(): boolean;
  44080. /**
  44081. * Gets or sets the active clipplane 1
  44082. */
  44083. clipPlane: Nullable<Plane>;
  44084. /**
  44085. * Gets or sets the active clipplane 2
  44086. */
  44087. clipPlane2: Nullable<Plane>;
  44088. /**
  44089. * Gets or sets the active clipplane 3
  44090. */
  44091. clipPlane3: Nullable<Plane>;
  44092. /**
  44093. * Gets or sets the active clipplane 4
  44094. */
  44095. clipPlane4: Nullable<Plane>;
  44096. /**
  44097. * Gets or sets the active clipplane 5
  44098. */
  44099. clipPlane5: Nullable<Plane>;
  44100. /**
  44101. * Gets or sets the active clipplane 6
  44102. */
  44103. clipPlane6: Nullable<Plane>;
  44104. /**
  44105. * Gets or sets a boolean indicating if animations are enabled
  44106. */
  44107. animationsEnabled: boolean;
  44108. private _animationPropertiesOverride;
  44109. /**
  44110. * Gets or sets the animation properties override
  44111. */
  44112. get animationPropertiesOverride(): Nullable<AnimationPropertiesOverride>;
  44113. set animationPropertiesOverride(value: Nullable<AnimationPropertiesOverride>);
  44114. /**
  44115. * Gets or sets a boolean indicating if a constant deltatime has to be used
  44116. * This is mostly useful for testing purposes when you do not want the animations to scale with the framerate
  44117. */
  44118. useConstantAnimationDeltaTime: boolean;
  44119. /**
  44120. * Gets or sets a boolean indicating if the scene must keep the meshUnderPointer property updated
  44121. * Please note that it requires to run a ray cast through the scene on every frame
  44122. */
  44123. constantlyUpdateMeshUnderPointer: boolean;
  44124. /**
  44125. * Defines the HTML cursor to use when hovering over interactive elements
  44126. */
  44127. hoverCursor: string;
  44128. /**
  44129. * Defines the HTML default cursor to use (empty by default)
  44130. */
  44131. defaultCursor: string;
  44132. /**
  44133. * Defines whether cursors are handled by the scene.
  44134. */
  44135. doNotHandleCursors: boolean;
  44136. /**
  44137. * This is used to call preventDefault() on pointer down
  44138. * in order to block unwanted artifacts like system double clicks
  44139. */
  44140. preventDefaultOnPointerDown: boolean;
  44141. /**
  44142. * This is used to call preventDefault() on pointer up
  44143. * in order to block unwanted artifacts like system double clicks
  44144. */
  44145. preventDefaultOnPointerUp: boolean;
  44146. /**
  44147. * Gets or sets user defined metadata
  44148. */
  44149. metadata: any;
  44150. /**
  44151. * For internal use only. Please do not use.
  44152. */
  44153. reservedDataStore: any;
  44154. /**
  44155. * Gets the name of the plugin used to load this scene (null by default)
  44156. */
  44157. loadingPluginName: string;
  44158. /**
  44159. * Use this array to add regular expressions used to disable offline support for specific urls
  44160. */
  44161. disableOfflineSupportExceptionRules: RegExp[];
  44162. /**
  44163. * An event triggered when the scene is disposed.
  44164. */
  44165. onDisposeObservable: Observable<Scene>;
  44166. private _onDisposeObserver;
  44167. /** Sets a function to be executed when this scene is disposed. */
  44168. set onDispose(callback: () => void);
  44169. /**
  44170. * An event triggered before rendering the scene (right after animations and physics)
  44171. */
  44172. onBeforeRenderObservable: Observable<Scene>;
  44173. private _onBeforeRenderObserver;
  44174. /** Sets a function to be executed before rendering this scene */
  44175. set beforeRender(callback: Nullable<() => void>);
  44176. /**
  44177. * An event triggered after rendering the scene
  44178. */
  44179. onAfterRenderObservable: Observable<Scene>;
  44180. /**
  44181. * An event triggered after rendering the scene for an active camera (When scene.render is called this will be called after each camera)
  44182. */
  44183. onAfterRenderCameraObservable: Observable<Camera>;
  44184. private _onAfterRenderObserver;
  44185. /** Sets a function to be executed after rendering this scene */
  44186. set afterRender(callback: Nullable<() => void>);
  44187. /**
  44188. * An event triggered before animating the scene
  44189. */
  44190. onBeforeAnimationsObservable: Observable<Scene>;
  44191. /**
  44192. * An event triggered after animations processing
  44193. */
  44194. onAfterAnimationsObservable: Observable<Scene>;
  44195. /**
  44196. * An event triggered before draw calls are ready to be sent
  44197. */
  44198. onBeforeDrawPhaseObservable: Observable<Scene>;
  44199. /**
  44200. * An event triggered after draw calls have been sent
  44201. */
  44202. onAfterDrawPhaseObservable: Observable<Scene>;
  44203. /**
  44204. * An event triggered when the scene is ready
  44205. */
  44206. onReadyObservable: Observable<Scene>;
  44207. /**
  44208. * An event triggered before rendering a camera
  44209. */
  44210. onBeforeCameraRenderObservable: Observable<Camera>;
  44211. private _onBeforeCameraRenderObserver;
  44212. /** Sets a function to be executed before rendering a camera*/
  44213. set beforeCameraRender(callback: () => void);
  44214. /**
  44215. * An event triggered after rendering a camera
  44216. */
  44217. onAfterCameraRenderObservable: Observable<Camera>;
  44218. private _onAfterCameraRenderObserver;
  44219. /** Sets a function to be executed after rendering a camera*/
  44220. set afterCameraRender(callback: () => void);
  44221. /**
  44222. * An event triggered when active meshes evaluation is about to start
  44223. */
  44224. onBeforeActiveMeshesEvaluationObservable: Observable<Scene>;
  44225. /**
  44226. * An event triggered when active meshes evaluation is done
  44227. */
  44228. onAfterActiveMeshesEvaluationObservable: Observable<Scene>;
  44229. /**
  44230. * An event triggered when particles rendering is about to start
  44231. * Note: This event can be trigger more than once per frame (because particles can be rendered by render target textures as well)
  44232. */
  44233. onBeforeParticlesRenderingObservable: Observable<Scene>;
  44234. /**
  44235. * An event triggered when particles rendering is done
  44236. * Note: This event can be trigger more than once per frame (because particles can be rendered by render target textures as well)
  44237. */
  44238. onAfterParticlesRenderingObservable: Observable<Scene>;
  44239. /**
  44240. * An event triggered when SceneLoader.Append or SceneLoader.Load or SceneLoader.ImportMesh were successfully executed
  44241. */
  44242. onDataLoadedObservable: Observable<Scene>;
  44243. /**
  44244. * An event triggered when a camera is created
  44245. */
  44246. onNewCameraAddedObservable: Observable<Camera>;
  44247. /**
  44248. * An event triggered when a camera is removed
  44249. */
  44250. onCameraRemovedObservable: Observable<Camera>;
  44251. /**
  44252. * An event triggered when a light is created
  44253. */
  44254. onNewLightAddedObservable: Observable<Light>;
  44255. /**
  44256. * An event triggered when a light is removed
  44257. */
  44258. onLightRemovedObservable: Observable<Light>;
  44259. /**
  44260. * An event triggered when a geometry is created
  44261. */
  44262. onNewGeometryAddedObservable: Observable<Geometry>;
  44263. /**
  44264. * An event triggered when a geometry is removed
  44265. */
  44266. onGeometryRemovedObservable: Observable<Geometry>;
  44267. /**
  44268. * An event triggered when a transform node is created
  44269. */
  44270. onNewTransformNodeAddedObservable: Observable<TransformNode>;
  44271. /**
  44272. * An event triggered when a transform node is removed
  44273. */
  44274. onTransformNodeRemovedObservable: Observable<TransformNode>;
  44275. /**
  44276. * An event triggered when a mesh is created
  44277. */
  44278. onNewMeshAddedObservable: Observable<AbstractMesh>;
  44279. /**
  44280. * An event triggered when a mesh is removed
  44281. */
  44282. onMeshRemovedObservable: Observable<AbstractMesh>;
  44283. /**
  44284. * An event triggered when a skeleton is created
  44285. */
  44286. onNewSkeletonAddedObservable: Observable<Skeleton>;
  44287. /**
  44288. * An event triggered when a skeleton is removed
  44289. */
  44290. onSkeletonRemovedObservable: Observable<Skeleton>;
  44291. /**
  44292. * An event triggered when a material is created
  44293. */
  44294. onNewMaterialAddedObservable: Observable<Material>;
  44295. /**
  44296. * An event triggered when a material is removed
  44297. */
  44298. onMaterialRemovedObservable: Observable<Material>;
  44299. /**
  44300. * An event triggered when a texture is created
  44301. */
  44302. onNewTextureAddedObservable: Observable<BaseTexture>;
  44303. /**
  44304. * An event triggered when a texture is removed
  44305. */
  44306. onTextureRemovedObservable: Observable<BaseTexture>;
  44307. /**
  44308. * An event triggered when render targets are about to be rendered
  44309. * Can happen multiple times per frame.
  44310. */
  44311. onBeforeRenderTargetsRenderObservable: Observable<Scene>;
  44312. /**
  44313. * An event triggered when render targets were rendered.
  44314. * Can happen multiple times per frame.
  44315. */
  44316. onAfterRenderTargetsRenderObservable: Observable<Scene>;
  44317. /**
  44318. * An event triggered before calculating deterministic simulation step
  44319. */
  44320. onBeforeStepObservable: Observable<Scene>;
  44321. /**
  44322. * An event triggered after calculating deterministic simulation step
  44323. */
  44324. onAfterStepObservable: Observable<Scene>;
  44325. /**
  44326. * An event triggered when the activeCamera property is updated
  44327. */
  44328. onActiveCameraChanged: Observable<Scene>;
  44329. /**
  44330. * This Observable will be triggered before rendering each renderingGroup of each rendered camera.
  44331. * The RenderinGroupInfo class contains all the information about the context in which the observable is called
  44332. * 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)
  44333. */
  44334. onBeforeRenderingGroupObservable: Observable<RenderingGroupInfo>;
  44335. /**
  44336. * This Observable will be triggered after rendering each renderingGroup of each rendered camera.
  44337. * The RenderinGroupInfo class contains all the information about the context in which the observable is called
  44338. * 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)
  44339. */
  44340. onAfterRenderingGroupObservable: Observable<RenderingGroupInfo>;
  44341. /**
  44342. * This Observable will when a mesh has been imported into the scene.
  44343. */
  44344. onMeshImportedObservable: Observable<AbstractMesh>;
  44345. /**
  44346. * This Observable will when an animation file has been imported into the scene.
  44347. */
  44348. onAnimationFileImportedObservable: Observable<Scene>;
  44349. /**
  44350. * Gets or sets a user defined funtion to select LOD from a mesh and a camera.
  44351. * By default this function is undefined and Babylon.js will select LOD based on distance to camera
  44352. */
  44353. customLODSelector: (mesh: AbstractMesh, camera: Camera) => Nullable<AbstractMesh>;
  44354. /** @hidden */
  44355. _registeredForLateAnimationBindings: SmartArrayNoDuplicate<any>;
  44356. /**
  44357. * Gets or sets a predicate used to select candidate meshes for a pointer down event
  44358. */
  44359. pointerDownPredicate: (Mesh: AbstractMesh) => boolean;
  44360. /**
  44361. * Gets or sets a predicate used to select candidate meshes for a pointer up event
  44362. */
  44363. pointerUpPredicate: (Mesh: AbstractMesh) => boolean;
  44364. /**
  44365. * Gets or sets a predicate used to select candidate meshes for a pointer move event
  44366. */
  44367. pointerMovePredicate: (Mesh: AbstractMesh) => boolean;
  44368. /** Callback called when a pointer move is detected */
  44369. onPointerMove: (evt: PointerEvent, pickInfo: PickingInfo, type: PointerEventTypes) => void;
  44370. /** Callback called when a pointer down is detected */
  44371. onPointerDown: (evt: PointerEvent, pickInfo: PickingInfo, type: PointerEventTypes) => void;
  44372. /** Callback called when a pointer up is detected */
  44373. onPointerUp: (evt: PointerEvent, pickInfo: Nullable<PickingInfo>, type: PointerEventTypes) => void;
  44374. /** Callback called when a pointer pick is detected */
  44375. onPointerPick: (evt: PointerEvent, pickInfo: PickingInfo) => void;
  44376. /**
  44377. * 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).
  44378. * You have the possibility to skip the process and the call to onPointerObservable by setting PointerInfoPre.skipOnPointerObservable to true
  44379. */
  44380. onPrePointerObservable: Observable<PointerInfoPre>;
  44381. /**
  44382. * Observable event triggered each time an input event is received from the rendering canvas
  44383. */
  44384. onPointerObservable: Observable<PointerInfo>;
  44385. /**
  44386. * Gets the pointer coordinates without any translation (ie. straight out of the pointer event)
  44387. */
  44388. get unTranslatedPointer(): Vector2;
  44389. /**
  44390. * Gets or sets the distance in pixel that you have to move to prevent some events. Default is 10 pixels
  44391. */
  44392. static get DragMovementThreshold(): number;
  44393. static set DragMovementThreshold(value: number);
  44394. /**
  44395. * Time in milliseconds to wait to raise long press events if button is still pressed. Default is 500 ms
  44396. */
  44397. static get LongPressDelay(): number;
  44398. static set LongPressDelay(value: number);
  44399. /**
  44400. * Time in milliseconds to wait to raise long press events if button is still pressed. Default is 300 ms
  44401. */
  44402. static get DoubleClickDelay(): number;
  44403. static set DoubleClickDelay(value: number);
  44404. /** If you need to check double click without raising a single click at first click, enable this flag */
  44405. static get ExclusiveDoubleClickMode(): boolean;
  44406. static set ExclusiveDoubleClickMode(value: boolean);
  44407. /** @hidden */
  44408. _mirroredCameraPosition: Nullable<Vector3>;
  44409. /**
  44410. * This observable event is triggered when any keyboard event si raised and registered during Scene.attachControl()
  44411. * You have the possibility to skip the process and the call to onKeyboardObservable by setting KeyboardInfoPre.skipOnPointerObservable to true
  44412. */
  44413. onPreKeyboardObservable: Observable<KeyboardInfoPre>;
  44414. /**
  44415. * Observable event triggered each time an keyboard event is received from the hosting window
  44416. */
  44417. onKeyboardObservable: Observable<KeyboardInfo>;
  44418. private _useRightHandedSystem;
  44419. /**
  44420. * Gets or sets a boolean indicating if the scene must use right-handed coordinates system
  44421. */
  44422. set useRightHandedSystem(value: boolean);
  44423. get useRightHandedSystem(): boolean;
  44424. private _timeAccumulator;
  44425. private _currentStepId;
  44426. private _currentInternalStep;
  44427. /**
  44428. * Sets the step Id used by deterministic lock step
  44429. * @see https://doc.babylonjs.com/babylon101/animations#deterministic-lockstep
  44430. * @param newStepId defines the step Id
  44431. */
  44432. setStepId(newStepId: number): void;
  44433. /**
  44434. * Gets the step Id used by deterministic lock step
  44435. * @see https://doc.babylonjs.com/babylon101/animations#deterministic-lockstep
  44436. * @returns the step Id
  44437. */
  44438. getStepId(): number;
  44439. /**
  44440. * Gets the internal step used by deterministic lock step
  44441. * @see https://doc.babylonjs.com/babylon101/animations#deterministic-lockstep
  44442. * @returns the internal step
  44443. */
  44444. getInternalStep(): number;
  44445. private _fogEnabled;
  44446. /**
  44447. * Gets or sets a boolean indicating if fog is enabled on this scene
  44448. * @see https://doc.babylonjs.com/babylon101/environment#fog
  44449. * (Default is true)
  44450. */
  44451. set fogEnabled(value: boolean);
  44452. get fogEnabled(): boolean;
  44453. private _fogMode;
  44454. /**
  44455. * Gets or sets the fog mode to use
  44456. * @see https://doc.babylonjs.com/babylon101/environment#fog
  44457. * | mode | value |
  44458. * | --- | --- |
  44459. * | FOGMODE_NONE | 0 |
  44460. * | FOGMODE_EXP | 1 |
  44461. * | FOGMODE_EXP2 | 2 |
  44462. * | FOGMODE_LINEAR | 3 |
  44463. */
  44464. set fogMode(value: number);
  44465. get fogMode(): number;
  44466. /**
  44467. * Gets or sets the fog color to use
  44468. * @see https://doc.babylonjs.com/babylon101/environment#fog
  44469. * (Default is Color3(0.2, 0.2, 0.3))
  44470. */
  44471. fogColor: Color3;
  44472. /**
  44473. * Gets or sets the fog density to use
  44474. * @see https://doc.babylonjs.com/babylon101/environment#fog
  44475. * (Default is 0.1)
  44476. */
  44477. fogDensity: number;
  44478. /**
  44479. * Gets or sets the fog start distance to use
  44480. * @see https://doc.babylonjs.com/babylon101/environment#fog
  44481. * (Default is 0)
  44482. */
  44483. fogStart: number;
  44484. /**
  44485. * Gets or sets the fog end distance to use
  44486. * @see https://doc.babylonjs.com/babylon101/environment#fog
  44487. * (Default is 1000)
  44488. */
  44489. fogEnd: number;
  44490. /**
  44491. * Flag indicating that the frame buffer binding is handled by another component
  44492. */
  44493. prePass: boolean;
  44494. private _shadowsEnabled;
  44495. /**
  44496. * Gets or sets a boolean indicating if shadows are enabled on this scene
  44497. */
  44498. set shadowsEnabled(value: boolean);
  44499. get shadowsEnabled(): boolean;
  44500. private _lightsEnabled;
  44501. /**
  44502. * Gets or sets a boolean indicating if lights are enabled on this scene
  44503. */
  44504. set lightsEnabled(value: boolean);
  44505. get lightsEnabled(): boolean;
  44506. /** All of the active cameras added to this scene. */
  44507. activeCameras: Camera[];
  44508. /** @hidden */
  44509. _activeCamera: Nullable<Camera>;
  44510. /** Gets or sets the current active camera */
  44511. get activeCamera(): Nullable<Camera>;
  44512. set activeCamera(value: Nullable<Camera>);
  44513. private _defaultMaterial;
  44514. /** The default material used on meshes when no material is affected */
  44515. get defaultMaterial(): Material;
  44516. /** The default material used on meshes when no material is affected */
  44517. set defaultMaterial(value: Material);
  44518. private _texturesEnabled;
  44519. /**
  44520. * Gets or sets a boolean indicating if textures are enabled on this scene
  44521. */
  44522. set texturesEnabled(value: boolean);
  44523. get texturesEnabled(): boolean;
  44524. /**
  44525. * Gets or sets a boolean indicating if physic engines are enabled on this scene
  44526. */
  44527. physicsEnabled: boolean;
  44528. /**
  44529. * Gets or sets a boolean indicating if particles are enabled on this scene
  44530. */
  44531. particlesEnabled: boolean;
  44532. /**
  44533. * Gets or sets a boolean indicating if sprites are enabled on this scene
  44534. */
  44535. spritesEnabled: boolean;
  44536. private _skeletonsEnabled;
  44537. /**
  44538. * Gets or sets a boolean indicating if skeletons are enabled on this scene
  44539. */
  44540. set skeletonsEnabled(value: boolean);
  44541. get skeletonsEnabled(): boolean;
  44542. /**
  44543. * Gets or sets a boolean indicating if lens flares are enabled on this scene
  44544. */
  44545. lensFlaresEnabled: boolean;
  44546. /**
  44547. * Gets or sets a boolean indicating if collisions are enabled on this scene
  44548. * @see https://doc.babylonjs.com/babylon101/cameras,_mesh_collisions_and_gravity
  44549. */
  44550. collisionsEnabled: boolean;
  44551. private _collisionCoordinator;
  44552. /** @hidden */
  44553. get collisionCoordinator(): ICollisionCoordinator;
  44554. /**
  44555. * Defines the gravity applied to this scene (used only for collisions)
  44556. * @see https://doc.babylonjs.com/babylon101/cameras,_mesh_collisions_and_gravity
  44557. */
  44558. gravity: Vector3;
  44559. /**
  44560. * Gets or sets a boolean indicating if postprocesses are enabled on this scene
  44561. */
  44562. postProcessesEnabled: boolean;
  44563. /**
  44564. * Gets the current postprocess manager
  44565. */
  44566. postProcessManager: PostProcessManager;
  44567. /**
  44568. * Gets or sets a boolean indicating if render targets are enabled on this scene
  44569. */
  44570. renderTargetsEnabled: boolean;
  44571. /**
  44572. * Gets or sets a boolean indicating if next render targets must be dumped as image for debugging purposes
  44573. * We recommend not using it and instead rely on Spector.js: http://spector.babylonjs.com
  44574. */
  44575. dumpNextRenderTargets: boolean;
  44576. /**
  44577. * The list of user defined render targets added to the scene
  44578. */
  44579. customRenderTargets: RenderTargetTexture[];
  44580. /**
  44581. * Defines if texture loading must be delayed
  44582. * If true, textures will only be loaded when they need to be rendered
  44583. */
  44584. useDelayedTextureLoading: boolean;
  44585. /**
  44586. * Gets the list of meshes imported to the scene through SceneLoader
  44587. */
  44588. importedMeshesFiles: String[];
  44589. /**
  44590. * Gets or sets a boolean indicating if probes are enabled on this scene
  44591. */
  44592. probesEnabled: boolean;
  44593. /**
  44594. * Gets or sets the current offline provider to use to store scene data
  44595. * @see https://doc.babylonjs.com/how_to/caching_resources_in_indexeddb
  44596. */
  44597. offlineProvider: IOfflineProvider;
  44598. /**
  44599. * Gets or sets the action manager associated with the scene
  44600. * @see https://doc.babylonjs.com/how_to/how_to_use_actions
  44601. */
  44602. actionManager: AbstractActionManager;
  44603. private _meshesForIntersections;
  44604. /**
  44605. * Gets or sets a boolean indicating if procedural textures are enabled on this scene
  44606. */
  44607. proceduralTexturesEnabled: boolean;
  44608. private _engine;
  44609. private _totalVertices;
  44610. /** @hidden */
  44611. _activeIndices: PerfCounter;
  44612. /** @hidden */
  44613. _activeParticles: PerfCounter;
  44614. /** @hidden */
  44615. _activeBones: PerfCounter;
  44616. private _animationRatio;
  44617. /** @hidden */
  44618. _animationTimeLast: number;
  44619. /** @hidden */
  44620. _animationTime: number;
  44621. /**
  44622. * Gets or sets a general scale for animation speed
  44623. * @see https://www.babylonjs-playground.com/#IBU2W7#3
  44624. */
  44625. animationTimeScale: number;
  44626. /** @hidden */
  44627. _cachedMaterial: Nullable<Material>;
  44628. /** @hidden */
  44629. _cachedEffect: Nullable<Effect>;
  44630. /** @hidden */
  44631. _cachedVisibility: Nullable<number>;
  44632. private _renderId;
  44633. private _frameId;
  44634. private _executeWhenReadyTimeoutId;
  44635. private _intermediateRendering;
  44636. private _viewUpdateFlag;
  44637. private _projectionUpdateFlag;
  44638. /** @hidden */
  44639. _toBeDisposed: Nullable<IDisposable>[];
  44640. private _activeRequests;
  44641. /** @hidden */
  44642. _pendingData: any[];
  44643. private _isDisposed;
  44644. /**
  44645. * Gets or sets a boolean indicating that all submeshes of active meshes must be rendered
  44646. * Use this boolean to avoid computing frustum clipping on submeshes (This could help when you are CPU bound)
  44647. */
  44648. dispatchAllSubMeshesOfActiveMeshes: boolean;
  44649. private _activeMeshes;
  44650. private _processedMaterials;
  44651. private _renderTargets;
  44652. /** @hidden */
  44653. _activeParticleSystems: SmartArray<IParticleSystem>;
  44654. private _activeSkeletons;
  44655. private _softwareSkinnedMeshes;
  44656. private _renderingManager;
  44657. /** @hidden */
  44658. _activeAnimatables: import("babylonjs/Animations/animatable").Animatable[];
  44659. private _transformMatrix;
  44660. private _sceneUbo;
  44661. /** @hidden */
  44662. _viewMatrix: Matrix;
  44663. private _projectionMatrix;
  44664. /** @hidden */
  44665. _forcedViewPosition: Nullable<Vector3>;
  44666. /** @hidden */
  44667. _frustumPlanes: Plane[];
  44668. /**
  44669. * Gets the list of frustum planes (built from the active camera)
  44670. */
  44671. get frustumPlanes(): Plane[];
  44672. /**
  44673. * Gets or sets a boolean indicating if lights must be sorted by priority (off by default)
  44674. * This is useful if there are more lights that the maximum simulteanous authorized
  44675. */
  44676. requireLightSorting: boolean;
  44677. /** @hidden */
  44678. readonly useMaterialMeshMap: boolean;
  44679. /** @hidden */
  44680. readonly useClonedMeshMap: boolean;
  44681. private _externalData;
  44682. private _uid;
  44683. /**
  44684. * @hidden
  44685. * Backing store of defined scene components.
  44686. */
  44687. _components: ISceneComponent[];
  44688. /**
  44689. * @hidden
  44690. * Backing store of defined scene components.
  44691. */
  44692. _serializableComponents: ISceneSerializableComponent[];
  44693. /**
  44694. * List of components to register on the next registration step.
  44695. */
  44696. private _transientComponents;
  44697. /**
  44698. * Registers the transient components if needed.
  44699. */
  44700. private _registerTransientComponents;
  44701. /**
  44702. * @hidden
  44703. * Add a component to the scene.
  44704. * Note that the ccomponent could be registered on th next frame if this is called after
  44705. * the register component stage.
  44706. * @param component Defines the component to add to the scene
  44707. */
  44708. _addComponent(component: ISceneComponent): void;
  44709. /**
  44710. * @hidden
  44711. * Gets a component from the scene.
  44712. * @param name defines the name of the component to retrieve
  44713. * @returns the component or null if not present
  44714. */
  44715. _getComponent(name: string): Nullable<ISceneComponent>;
  44716. /**
  44717. * @hidden
  44718. * Defines the actions happening before camera updates.
  44719. */
  44720. _beforeCameraUpdateStage: Stage<SimpleStageAction>;
  44721. /**
  44722. * @hidden
  44723. * Defines the actions happening before clear the canvas.
  44724. */
  44725. _beforeClearStage: Stage<SimpleStageAction>;
  44726. /**
  44727. * @hidden
  44728. * Defines the actions when collecting render targets for the frame.
  44729. */
  44730. _gatherRenderTargetsStage: Stage<RenderTargetsStageAction>;
  44731. /**
  44732. * @hidden
  44733. * Defines the actions happening for one camera in the frame.
  44734. */
  44735. _gatherActiveCameraRenderTargetsStage: Stage<RenderTargetsStageAction>;
  44736. /**
  44737. * @hidden
  44738. * Defines the actions happening during the per mesh ready checks.
  44739. */
  44740. _isReadyForMeshStage: Stage<MeshStageAction>;
  44741. /**
  44742. * @hidden
  44743. * Defines the actions happening before evaluate active mesh checks.
  44744. */
  44745. _beforeEvaluateActiveMeshStage: Stage<SimpleStageAction>;
  44746. /**
  44747. * @hidden
  44748. * Defines the actions happening during the evaluate sub mesh checks.
  44749. */
  44750. _evaluateSubMeshStage: Stage<EvaluateSubMeshStageAction>;
  44751. /**
  44752. * @hidden
  44753. * Defines the actions happening during the active mesh stage.
  44754. */
  44755. _activeMeshStage: Stage<ActiveMeshStageAction>;
  44756. /**
  44757. * @hidden
  44758. * Defines the actions happening during the per camera render target step.
  44759. */
  44760. _cameraDrawRenderTargetStage: Stage<CameraStageFrameBufferAction>;
  44761. /**
  44762. * @hidden
  44763. * Defines the actions happening just before the active camera is drawing.
  44764. */
  44765. _beforeCameraDrawStage: Stage<CameraStageAction>;
  44766. /**
  44767. * @hidden
  44768. * Defines the actions happening just before a render target is drawing.
  44769. */
  44770. _beforeRenderTargetDrawStage: Stage<RenderTargetStageAction>;
  44771. /**
  44772. * @hidden
  44773. * Defines the actions happening just before a rendering group is drawing.
  44774. */
  44775. _beforeRenderingGroupDrawStage: Stage<RenderingGroupStageAction>;
  44776. /**
  44777. * @hidden
  44778. * Defines the actions happening just before a mesh is drawing.
  44779. */
  44780. _beforeRenderingMeshStage: Stage<RenderingMeshStageAction>;
  44781. /**
  44782. * @hidden
  44783. * Defines the actions happening just after a mesh has been drawn.
  44784. */
  44785. _afterRenderingMeshStage: Stage<RenderingMeshStageAction>;
  44786. /**
  44787. * @hidden
  44788. * Defines the actions happening just after a rendering group has been drawn.
  44789. */
  44790. _afterRenderingGroupDrawStage: Stage<RenderingGroupStageAction>;
  44791. /**
  44792. * @hidden
  44793. * Defines the actions happening just after the active camera has been drawn.
  44794. */
  44795. _afterCameraDrawStage: Stage<CameraStageAction>;
  44796. /**
  44797. * @hidden
  44798. * Defines the actions happening just after a render target has been drawn.
  44799. */
  44800. _afterRenderTargetDrawStage: Stage<RenderTargetStageAction>;
  44801. /**
  44802. * @hidden
  44803. * Defines the actions happening just after rendering all cameras and computing intersections.
  44804. */
  44805. _afterRenderStage: Stage<SimpleStageAction>;
  44806. /**
  44807. * @hidden
  44808. * Defines the actions happening when a pointer move event happens.
  44809. */
  44810. _pointerMoveStage: Stage<PointerMoveStageAction>;
  44811. /**
  44812. * @hidden
  44813. * Defines the actions happening when a pointer down event happens.
  44814. */
  44815. _pointerDownStage: Stage<PointerUpDownStageAction>;
  44816. /**
  44817. * @hidden
  44818. * Defines the actions happening when a pointer up event happens.
  44819. */
  44820. _pointerUpStage: Stage<PointerUpDownStageAction>;
  44821. /**
  44822. * an optional map from Geometry Id to Geometry index in the 'geometries' array
  44823. */
  44824. private geometriesByUniqueId;
  44825. /**
  44826. * Creates a new Scene
  44827. * @param engine defines the engine to use to render this scene
  44828. * @param options defines the scene options
  44829. */
  44830. constructor(engine: Engine, options?: SceneOptions);
  44831. /**
  44832. * Gets a string identifying the name of the class
  44833. * @returns "Scene" string
  44834. */
  44835. getClassName(): string;
  44836. private _defaultMeshCandidates;
  44837. /**
  44838. * @hidden
  44839. */
  44840. _getDefaultMeshCandidates(): ISmartArrayLike<AbstractMesh>;
  44841. private _defaultSubMeshCandidates;
  44842. /**
  44843. * @hidden
  44844. */
  44845. _getDefaultSubMeshCandidates(mesh: AbstractMesh): ISmartArrayLike<SubMesh>;
  44846. /**
  44847. * Sets the default candidate providers for the scene.
  44848. * This sets the getActiveMeshCandidates, getActiveSubMeshCandidates, getIntersectingSubMeshCandidates
  44849. * and getCollidingSubMeshCandidates to their default function
  44850. */
  44851. setDefaultCandidateProviders(): void;
  44852. /**
  44853. * Gets the mesh that is currently under the pointer
  44854. */
  44855. get meshUnderPointer(): Nullable<AbstractMesh>;
  44856. /**
  44857. * Gets or sets the current on-screen X position of the pointer
  44858. */
  44859. get pointerX(): number;
  44860. set pointerX(value: number);
  44861. /**
  44862. * Gets or sets the current on-screen Y position of the pointer
  44863. */
  44864. get pointerY(): number;
  44865. set pointerY(value: number);
  44866. /**
  44867. * Gets the cached material (ie. the latest rendered one)
  44868. * @returns the cached material
  44869. */
  44870. getCachedMaterial(): Nullable<Material>;
  44871. /**
  44872. * Gets the cached effect (ie. the latest rendered one)
  44873. * @returns the cached effect
  44874. */
  44875. getCachedEffect(): Nullable<Effect>;
  44876. /**
  44877. * Gets the cached visibility state (ie. the latest rendered one)
  44878. * @returns the cached visibility state
  44879. */
  44880. getCachedVisibility(): Nullable<number>;
  44881. /**
  44882. * Gets a boolean indicating if the current material / effect / visibility must be bind again
  44883. * @param material defines the current material
  44884. * @param effect defines the current effect
  44885. * @param visibility defines the current visibility state
  44886. * @returns true if one parameter is not cached
  44887. */
  44888. isCachedMaterialInvalid(material: Material, effect: Effect, visibility?: number): boolean;
  44889. /**
  44890. * Gets the engine associated with the scene
  44891. * @returns an Engine
  44892. */
  44893. getEngine(): Engine;
  44894. /**
  44895. * Gets the total number of vertices rendered per frame
  44896. * @returns the total number of vertices rendered per frame
  44897. */
  44898. getTotalVertices(): number;
  44899. /**
  44900. * Gets the performance counter for total vertices
  44901. * @see https://doc.babylonjs.com/how_to/optimizing_your_scene#instrumentation
  44902. */
  44903. get totalVerticesPerfCounter(): PerfCounter;
  44904. /**
  44905. * Gets the total number of active indices rendered per frame (You can deduce the number of rendered triangles by dividing this number by 3)
  44906. * @returns the total number of active indices rendered per frame
  44907. */
  44908. getActiveIndices(): number;
  44909. /**
  44910. * Gets the performance counter for active indices
  44911. * @see https://doc.babylonjs.com/how_to/optimizing_your_scene#instrumentation
  44912. */
  44913. get totalActiveIndicesPerfCounter(): PerfCounter;
  44914. /**
  44915. * Gets the total number of active particles rendered per frame
  44916. * @returns the total number of active particles rendered per frame
  44917. */
  44918. getActiveParticles(): number;
  44919. /**
  44920. * Gets the performance counter for active particles
  44921. * @see https://doc.babylonjs.com/how_to/optimizing_your_scene#instrumentation
  44922. */
  44923. get activeParticlesPerfCounter(): PerfCounter;
  44924. /**
  44925. * Gets the total number of active bones rendered per frame
  44926. * @returns the total number of active bones rendered per frame
  44927. */
  44928. getActiveBones(): number;
  44929. /**
  44930. * Gets the performance counter for active bones
  44931. * @see https://doc.babylonjs.com/how_to/optimizing_your_scene#instrumentation
  44932. */
  44933. get activeBonesPerfCounter(): PerfCounter;
  44934. /**
  44935. * Gets the array of active meshes
  44936. * @returns an array of AbstractMesh
  44937. */
  44938. getActiveMeshes(): SmartArray<AbstractMesh>;
  44939. /**
  44940. * Gets the animation ratio (which is 1.0 is the scene renders at 60fps and 2 if the scene renders at 30fps, etc.)
  44941. * @returns a number
  44942. */
  44943. getAnimationRatio(): number;
  44944. /**
  44945. * Gets an unique Id for the current render phase
  44946. * @returns a number
  44947. */
  44948. getRenderId(): number;
  44949. /**
  44950. * Gets an unique Id for the current frame
  44951. * @returns a number
  44952. */
  44953. getFrameId(): number;
  44954. /** Call this function if you want to manually increment the render Id*/
  44955. incrementRenderId(): void;
  44956. private _createUbo;
  44957. /**
  44958. * Use this method to simulate a pointer move on a mesh
  44959. * The pickResult parameter can be obtained from a scene.pick or scene.pickWithRay
  44960. * @param pickResult pickingInfo of the object wished to simulate pointer event on
  44961. * @param pointerEventInit pointer event state to be used when simulating the pointer event (eg. pointer id for multitouch)
  44962. * @returns the current scene
  44963. */
  44964. simulatePointerMove(pickResult: PickingInfo, pointerEventInit?: PointerEventInit): Scene;
  44965. /**
  44966. * Use this method to simulate a pointer down on a mesh
  44967. * The pickResult parameter can be obtained from a scene.pick or scene.pickWithRay
  44968. * @param pickResult pickingInfo of the object wished to simulate pointer event on
  44969. * @param pointerEventInit pointer event state to be used when simulating the pointer event (eg. pointer id for multitouch)
  44970. * @returns the current scene
  44971. */
  44972. simulatePointerDown(pickResult: PickingInfo, pointerEventInit?: PointerEventInit): Scene;
  44973. /**
  44974. * Use this method to simulate a pointer up on a mesh
  44975. * The pickResult parameter can be obtained from a scene.pick or scene.pickWithRay
  44976. * @param pickResult pickingInfo of the object wished to simulate pointer event on
  44977. * @param pointerEventInit pointer event state to be used when simulating the pointer event (eg. pointer id for multitouch)
  44978. * @param doubleTap indicates that the pointer up event should be considered as part of a double click (false by default)
  44979. * @returns the current scene
  44980. */
  44981. simulatePointerUp(pickResult: PickingInfo, pointerEventInit?: PointerEventInit, doubleTap?: boolean): Scene;
  44982. /**
  44983. * Gets a boolean indicating if the current pointer event is captured (meaning that the scene has already handled the pointer down)
  44984. * @param pointerId defines the pointer id to use in a multi-touch scenario (0 by default)
  44985. * @returns true if the pointer was captured
  44986. */
  44987. isPointerCaptured(pointerId?: number): boolean;
  44988. /**
  44989. * Attach events to the canvas (To handle actionManagers triggers and raise onPointerMove, onPointerDown and onPointerUp
  44990. * @param attachUp defines if you want to attach events to pointerup
  44991. * @param attachDown defines if you want to attach events to pointerdown
  44992. * @param attachMove defines if you want to attach events to pointermove
  44993. */
  44994. attachControl(attachUp?: boolean, attachDown?: boolean, attachMove?: boolean): void;
  44995. /** Detaches all event handlers*/
  44996. detachControl(): void;
  44997. /**
  44998. * This function will check if the scene can be rendered (textures are loaded, shaders are compiled)
  44999. * Delay loaded resources are not taking in account
  45000. * @return true if all required resources are ready
  45001. */
  45002. isReady(): boolean;
  45003. /** Resets all cached information relative to material (including effect and visibility) */
  45004. resetCachedMaterial(): void;
  45005. /**
  45006. * Registers a function to be called before every frame render
  45007. * @param func defines the function to register
  45008. */
  45009. registerBeforeRender(func: () => void): void;
  45010. /**
  45011. * Unregisters a function called before every frame render
  45012. * @param func defines the function to unregister
  45013. */
  45014. unregisterBeforeRender(func: () => void): void;
  45015. /**
  45016. * Registers a function to be called after every frame render
  45017. * @param func defines the function to register
  45018. */
  45019. registerAfterRender(func: () => void): void;
  45020. /**
  45021. * Unregisters a function called after every frame render
  45022. * @param func defines the function to unregister
  45023. */
  45024. unregisterAfterRender(func: () => void): void;
  45025. private _executeOnceBeforeRender;
  45026. /**
  45027. * The provided function will run before render once and will be disposed afterwards.
  45028. * A timeout delay can be provided so that the function will be executed in N ms.
  45029. * The timeout is using the browser's native setTimeout so time percision cannot be guaranteed.
  45030. * @param func The function to be executed.
  45031. * @param timeout optional delay in ms
  45032. */
  45033. executeOnceBeforeRender(func: () => void, timeout?: number): void;
  45034. /** @hidden */
  45035. _addPendingData(data: any): void;
  45036. /** @hidden */
  45037. _removePendingData(data: any): void;
  45038. /**
  45039. * Returns the number of items waiting to be loaded
  45040. * @returns the number of items waiting to be loaded
  45041. */
  45042. getWaitingItemsCount(): number;
  45043. /**
  45044. * Returns a boolean indicating if the scene is still loading data
  45045. */
  45046. get isLoading(): boolean;
  45047. /**
  45048. * Registers a function to be executed when the scene is ready
  45049. * @param {Function} func - the function to be executed
  45050. */
  45051. executeWhenReady(func: () => void): void;
  45052. /**
  45053. * Returns a promise that resolves when the scene is ready
  45054. * @returns A promise that resolves when the scene is ready
  45055. */
  45056. whenReadyAsync(): Promise<void>;
  45057. /** @hidden */
  45058. _checkIsReady(): void;
  45059. /**
  45060. * Gets all animatable attached to the scene
  45061. */
  45062. get animatables(): Animatable[];
  45063. /**
  45064. * Resets the last animation time frame.
  45065. * Useful to override when animations start running when loading a scene for the first time.
  45066. */
  45067. resetLastAnimationTimeFrame(): void;
  45068. /**
  45069. * Gets the current view matrix
  45070. * @returns a Matrix
  45071. */
  45072. getViewMatrix(): Matrix;
  45073. /**
  45074. * Gets the current projection matrix
  45075. * @returns a Matrix
  45076. */
  45077. getProjectionMatrix(): Matrix;
  45078. /**
  45079. * Gets the current transform matrix
  45080. * @returns a Matrix made of View * Projection
  45081. */
  45082. getTransformMatrix(): Matrix;
  45083. /**
  45084. * Sets the current transform matrix
  45085. * @param viewL defines the View matrix to use
  45086. * @param projectionL defines the Projection matrix to use
  45087. * @param viewR defines the right View matrix to use (if provided)
  45088. * @param projectionR defines the right Projection matrix to use (if provided)
  45089. */
  45090. setTransformMatrix(viewL: Matrix, projectionL: Matrix, viewR?: Matrix, projectionR?: Matrix): void;
  45091. /**
  45092. * Gets the uniform buffer used to store scene data
  45093. * @returns a UniformBuffer
  45094. */
  45095. getSceneUniformBuffer(): UniformBuffer;
  45096. /**
  45097. * Gets an unique (relatively to the current scene) Id
  45098. * @returns an unique number for the scene
  45099. */
  45100. getUniqueId(): number;
  45101. /**
  45102. * Add a mesh to the list of scene's meshes
  45103. * @param newMesh defines the mesh to add
  45104. * @param recursive if all child meshes should also be added to the scene
  45105. */
  45106. addMesh(newMesh: AbstractMesh, recursive?: boolean): void;
  45107. /**
  45108. * Remove a mesh for the list of scene's meshes
  45109. * @param toRemove defines the mesh to remove
  45110. * @param recursive if all child meshes should also be removed from the scene
  45111. * @returns the index where the mesh was in the mesh list
  45112. */
  45113. removeMesh(toRemove: AbstractMesh, recursive?: boolean): number;
  45114. /**
  45115. * Add a transform node to the list of scene's transform nodes
  45116. * @param newTransformNode defines the transform node to add
  45117. */
  45118. addTransformNode(newTransformNode: TransformNode): void;
  45119. /**
  45120. * Remove a transform node for the list of scene's transform nodes
  45121. * @param toRemove defines the transform node to remove
  45122. * @returns the index where the transform node was in the transform node list
  45123. */
  45124. removeTransformNode(toRemove: TransformNode): number;
  45125. /**
  45126. * Remove a skeleton for the list of scene's skeletons
  45127. * @param toRemove defines the skeleton to remove
  45128. * @returns the index where the skeleton was in the skeleton list
  45129. */
  45130. removeSkeleton(toRemove: Skeleton): number;
  45131. /**
  45132. * Remove a morph target for the list of scene's morph targets
  45133. * @param toRemove defines the morph target to remove
  45134. * @returns the index where the morph target was in the morph target list
  45135. */
  45136. removeMorphTargetManager(toRemove: MorphTargetManager): number;
  45137. /**
  45138. * Remove a light for the list of scene's lights
  45139. * @param toRemove defines the light to remove
  45140. * @returns the index where the light was in the light list
  45141. */
  45142. removeLight(toRemove: Light): number;
  45143. /**
  45144. * Remove a camera for the list of scene's cameras
  45145. * @param toRemove defines the camera to remove
  45146. * @returns the index where the camera was in the camera list
  45147. */
  45148. removeCamera(toRemove: Camera): number;
  45149. /**
  45150. * Remove a particle system for the list of scene's particle systems
  45151. * @param toRemove defines the particle system to remove
  45152. * @returns the index where the particle system was in the particle system list
  45153. */
  45154. removeParticleSystem(toRemove: IParticleSystem): number;
  45155. /**
  45156. * Remove a animation for the list of scene's animations
  45157. * @param toRemove defines the animation to remove
  45158. * @returns the index where the animation was in the animation list
  45159. */
  45160. removeAnimation(toRemove: Animation): number;
  45161. /**
  45162. * Will stop the animation of the given target
  45163. * @param target - the target
  45164. * @param animationName - the name of the animation to stop (all animations will be stopped if both this and targetMask are empty)
  45165. * @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)
  45166. */
  45167. stopAnimation(target: any, animationName?: string, targetMask?: (target: any) => boolean): void;
  45168. /**
  45169. * Removes the given animation group from this scene.
  45170. * @param toRemove The animation group to remove
  45171. * @returns The index of the removed animation group
  45172. */
  45173. removeAnimationGroup(toRemove: AnimationGroup): number;
  45174. /**
  45175. * Removes the given multi-material from this scene.
  45176. * @param toRemove The multi-material to remove
  45177. * @returns The index of the removed multi-material
  45178. */
  45179. removeMultiMaterial(toRemove: MultiMaterial): number;
  45180. /**
  45181. * Removes the given material from this scene.
  45182. * @param toRemove The material to remove
  45183. * @returns The index of the removed material
  45184. */
  45185. removeMaterial(toRemove: Material): number;
  45186. /**
  45187. * Removes the given action manager from this scene.
  45188. * @param toRemove The action manager to remove
  45189. * @returns The index of the removed action manager
  45190. */
  45191. removeActionManager(toRemove: AbstractActionManager): number;
  45192. /**
  45193. * Removes the given texture from this scene.
  45194. * @param toRemove The texture to remove
  45195. * @returns The index of the removed texture
  45196. */
  45197. removeTexture(toRemove: BaseTexture): number;
  45198. /**
  45199. * Adds the given light to this scene
  45200. * @param newLight The light to add
  45201. */
  45202. addLight(newLight: Light): void;
  45203. /**
  45204. * Sorts the list list based on light priorities
  45205. */
  45206. sortLightsByPriority(): void;
  45207. /**
  45208. * Adds the given camera to this scene
  45209. * @param newCamera The camera to add
  45210. */
  45211. addCamera(newCamera: Camera): void;
  45212. /**
  45213. * Adds the given skeleton to this scene
  45214. * @param newSkeleton The skeleton to add
  45215. */
  45216. addSkeleton(newSkeleton: Skeleton): void;
  45217. /**
  45218. * Adds the given particle system to this scene
  45219. * @param newParticleSystem The particle system to add
  45220. */
  45221. addParticleSystem(newParticleSystem: IParticleSystem): void;
  45222. /**
  45223. * Adds the given animation to this scene
  45224. * @param newAnimation The animation to add
  45225. */
  45226. addAnimation(newAnimation: Animation): void;
  45227. /**
  45228. * Adds the given animation group to this scene.
  45229. * @param newAnimationGroup The animation group to add
  45230. */
  45231. addAnimationGroup(newAnimationGroup: AnimationGroup): void;
  45232. /**
  45233. * Adds the given multi-material to this scene
  45234. * @param newMultiMaterial The multi-material to add
  45235. */
  45236. addMultiMaterial(newMultiMaterial: MultiMaterial): void;
  45237. /**
  45238. * Adds the given material to this scene
  45239. * @param newMaterial The material to add
  45240. */
  45241. addMaterial(newMaterial: Material): void;
  45242. /**
  45243. * Adds the given morph target to this scene
  45244. * @param newMorphTargetManager The morph target to add
  45245. */
  45246. addMorphTargetManager(newMorphTargetManager: MorphTargetManager): void;
  45247. /**
  45248. * Adds the given geometry to this scene
  45249. * @param newGeometry The geometry to add
  45250. */
  45251. addGeometry(newGeometry: Geometry): void;
  45252. /**
  45253. * Adds the given action manager to this scene
  45254. * @param newActionManager The action manager to add
  45255. */
  45256. addActionManager(newActionManager: AbstractActionManager): void;
  45257. /**
  45258. * Adds the given texture to this scene.
  45259. * @param newTexture The texture to add
  45260. */
  45261. addTexture(newTexture: BaseTexture): void;
  45262. /**
  45263. * Switch active camera
  45264. * @param newCamera defines the new active camera
  45265. * @param attachControl defines if attachControl must be called for the new active camera (default: true)
  45266. */
  45267. switchActiveCamera(newCamera: Camera, attachControl?: boolean): void;
  45268. /**
  45269. * sets the active camera of the scene using its ID
  45270. * @param id defines the camera's ID
  45271. * @return the new active camera or null if none found.
  45272. */
  45273. setActiveCameraByID(id: string): Nullable<Camera>;
  45274. /**
  45275. * sets the active camera of the scene using its name
  45276. * @param name defines the camera's name
  45277. * @returns the new active camera or null if none found.
  45278. */
  45279. setActiveCameraByName(name: string): Nullable<Camera>;
  45280. /**
  45281. * get an animation group using its name
  45282. * @param name defines the material's name
  45283. * @return the animation group or null if none found.
  45284. */
  45285. getAnimationGroupByName(name: string): Nullable<AnimationGroup>;
  45286. /**
  45287. * Get a material using its unique id
  45288. * @param uniqueId defines the material's unique id
  45289. * @return the material or null if none found.
  45290. */
  45291. getMaterialByUniqueID(uniqueId: number): Nullable<Material>;
  45292. /**
  45293. * get a material using its id
  45294. * @param id defines the material's ID
  45295. * @return the material or null if none found.
  45296. */
  45297. getMaterialByID(id: string): Nullable<Material>;
  45298. /**
  45299. * Gets a the last added material using a given id
  45300. * @param id defines the material's ID
  45301. * @return the last material with the given id or null if none found.
  45302. */
  45303. getLastMaterialByID(id: string): Nullable<Material>;
  45304. /**
  45305. * Gets a material using its name
  45306. * @param name defines the material's name
  45307. * @return the material or null if none found.
  45308. */
  45309. getMaterialByName(name: string): Nullable<Material>;
  45310. /**
  45311. * Get a texture using its unique id
  45312. * @param uniqueId defines the texture's unique id
  45313. * @return the texture or null if none found.
  45314. */
  45315. getTextureByUniqueID(uniqueId: number): Nullable<BaseTexture>;
  45316. /**
  45317. * Gets a camera using its id
  45318. * @param id defines the id to look for
  45319. * @returns the camera or null if not found
  45320. */
  45321. getCameraByID(id: string): Nullable<Camera>;
  45322. /**
  45323. * Gets a camera using its unique id
  45324. * @param uniqueId defines the unique id to look for
  45325. * @returns the camera or null if not found
  45326. */
  45327. getCameraByUniqueID(uniqueId: number): Nullable<Camera>;
  45328. /**
  45329. * Gets a camera using its name
  45330. * @param name defines the camera's name
  45331. * @return the camera or null if none found.
  45332. */
  45333. getCameraByName(name: string): Nullable<Camera>;
  45334. /**
  45335. * Gets a bone using its id
  45336. * @param id defines the bone's id
  45337. * @return the bone or null if not found
  45338. */
  45339. getBoneByID(id: string): Nullable<Bone>;
  45340. /**
  45341. * Gets a bone using its id
  45342. * @param name defines the bone's name
  45343. * @return the bone or null if not found
  45344. */
  45345. getBoneByName(name: string): Nullable<Bone>;
  45346. /**
  45347. * Gets a light node using its name
  45348. * @param name defines the the light's name
  45349. * @return the light or null if none found.
  45350. */
  45351. getLightByName(name: string): Nullable<Light>;
  45352. /**
  45353. * Gets a light node using its id
  45354. * @param id defines the light's id
  45355. * @return the light or null if none found.
  45356. */
  45357. getLightByID(id: string): Nullable<Light>;
  45358. /**
  45359. * Gets a light node using its scene-generated unique ID
  45360. * @param uniqueId defines the light's unique id
  45361. * @return the light or null if none found.
  45362. */
  45363. getLightByUniqueID(uniqueId: number): Nullable<Light>;
  45364. /**
  45365. * Gets a particle system by id
  45366. * @param id defines the particle system id
  45367. * @return the corresponding system or null if none found
  45368. */
  45369. getParticleSystemByID(id: string): Nullable<IParticleSystem>;
  45370. /**
  45371. * Gets a geometry using its ID
  45372. * @param id defines the geometry's id
  45373. * @return the geometry or null if none found.
  45374. */
  45375. getGeometryByID(id: string): Nullable<Geometry>;
  45376. private _getGeometryByUniqueID;
  45377. /**
  45378. * Add a new geometry to this scene
  45379. * @param geometry defines the geometry to be added to the scene.
  45380. * @param force defines if the geometry must be pushed even if a geometry with this id already exists
  45381. * @return a boolean defining if the geometry was added or not
  45382. */
  45383. pushGeometry(geometry: Geometry, force?: boolean): boolean;
  45384. /**
  45385. * Removes an existing geometry
  45386. * @param geometry defines the geometry to be removed from the scene
  45387. * @return a boolean defining if the geometry was removed or not
  45388. */
  45389. removeGeometry(geometry: Geometry): boolean;
  45390. /**
  45391. * Gets the list of geometries attached to the scene
  45392. * @returns an array of Geometry
  45393. */
  45394. getGeometries(): Geometry[];
  45395. /**
  45396. * Gets the first added mesh found of a given ID
  45397. * @param id defines the id to search for
  45398. * @return the mesh found or null if not found at all
  45399. */
  45400. getMeshByID(id: string): Nullable<AbstractMesh>;
  45401. /**
  45402. * Gets a list of meshes using their id
  45403. * @param id defines the id to search for
  45404. * @returns a list of meshes
  45405. */
  45406. getMeshesByID(id: string): Array<AbstractMesh>;
  45407. /**
  45408. * Gets the first added transform node found of a given ID
  45409. * @param id defines the id to search for
  45410. * @return the found transform node or null if not found at all.
  45411. */
  45412. getTransformNodeByID(id: string): Nullable<TransformNode>;
  45413. /**
  45414. * Gets a transform node with its auto-generated unique id
  45415. * @param uniqueId efines the unique id to search for
  45416. * @return the found transform node or null if not found at all.
  45417. */
  45418. getTransformNodeByUniqueID(uniqueId: number): Nullable<TransformNode>;
  45419. /**
  45420. * Gets a list of transform nodes using their id
  45421. * @param id defines the id to search for
  45422. * @returns a list of transform nodes
  45423. */
  45424. getTransformNodesByID(id: string): Array<TransformNode>;
  45425. /**
  45426. * Gets a mesh with its auto-generated unique id
  45427. * @param uniqueId defines the unique id to search for
  45428. * @return the found mesh or null if not found at all.
  45429. */
  45430. getMeshByUniqueID(uniqueId: number): Nullable<AbstractMesh>;
  45431. /**
  45432. * Gets a the last added mesh using a given id
  45433. * @param id defines the id to search for
  45434. * @return the found mesh or null if not found at all.
  45435. */
  45436. getLastMeshByID(id: string): Nullable<AbstractMesh>;
  45437. /**
  45438. * Gets a the last added node (Mesh, Camera, Light) using a given id
  45439. * @param id defines the id to search for
  45440. * @return the found node or null if not found at all
  45441. */
  45442. getLastEntryByID(id: string): Nullable<Node>;
  45443. /**
  45444. * Gets a node (Mesh, Camera, Light) using a given id
  45445. * @param id defines the id to search for
  45446. * @return the found node or null if not found at all
  45447. */
  45448. getNodeByID(id: string): Nullable<Node>;
  45449. /**
  45450. * Gets a node (Mesh, Camera, Light) using a given name
  45451. * @param name defines the name to search for
  45452. * @return the found node or null if not found at all.
  45453. */
  45454. getNodeByName(name: string): Nullable<Node>;
  45455. /**
  45456. * Gets a mesh using a given name
  45457. * @param name defines the name to search for
  45458. * @return the found mesh or null if not found at all.
  45459. */
  45460. getMeshByName(name: string): Nullable<AbstractMesh>;
  45461. /**
  45462. * Gets a transform node using a given name
  45463. * @param name defines the name to search for
  45464. * @return the found transform node or null if not found at all.
  45465. */
  45466. getTransformNodeByName(name: string): Nullable<TransformNode>;
  45467. /**
  45468. * Gets a skeleton using a given id (if many are found, this function will pick the last one)
  45469. * @param id defines the id to search for
  45470. * @return the found skeleton or null if not found at all.
  45471. */
  45472. getLastSkeletonByID(id: string): Nullable<Skeleton>;
  45473. /**
  45474. * Gets a skeleton using a given auto generated unique id
  45475. * @param uniqueId defines the unique id to search for
  45476. * @return the found skeleton or null if not found at all.
  45477. */
  45478. getSkeletonByUniqueId(uniqueId: number): Nullable<Skeleton>;
  45479. /**
  45480. * Gets a skeleton using a given id (if many are found, this function will pick the first one)
  45481. * @param id defines the id to search for
  45482. * @return the found skeleton or null if not found at all.
  45483. */
  45484. getSkeletonById(id: string): Nullable<Skeleton>;
  45485. /**
  45486. * Gets a skeleton using a given name
  45487. * @param name defines the name to search for
  45488. * @return the found skeleton or null if not found at all.
  45489. */
  45490. getSkeletonByName(name: string): Nullable<Skeleton>;
  45491. /**
  45492. * Gets a morph target manager using a given id (if many are found, this function will pick the last one)
  45493. * @param id defines the id to search for
  45494. * @return the found morph target manager or null if not found at all.
  45495. */
  45496. getMorphTargetManagerById(id: number): Nullable<MorphTargetManager>;
  45497. /**
  45498. * Gets a morph target using a given id (if many are found, this function will pick the first one)
  45499. * @param id defines the id to search for
  45500. * @return the found morph target or null if not found at all.
  45501. */
  45502. getMorphTargetById(id: string): Nullable<MorphTarget>;
  45503. /**
  45504. * Gets a morph target using a given name (if many are found, this function will pick the first one)
  45505. * @param name defines the name to search for
  45506. * @return the found morph target or null if not found at all.
  45507. */
  45508. getMorphTargetByName(name: string): Nullable<MorphTarget>;
  45509. /**
  45510. * Gets a post process using a given name (if many are found, this function will pick the first one)
  45511. * @param name defines the name to search for
  45512. * @return the found post process or null if not found at all.
  45513. */
  45514. getPostProcessByName(name: string): Nullable<PostProcess>;
  45515. /**
  45516. * Gets a boolean indicating if the given mesh is active
  45517. * @param mesh defines the mesh to look for
  45518. * @returns true if the mesh is in the active list
  45519. */
  45520. isActiveMesh(mesh: AbstractMesh): boolean;
  45521. /**
  45522. * Return a unique id as a string which can serve as an identifier for the scene
  45523. */
  45524. get uid(): string;
  45525. /**
  45526. * Add an externaly attached data from its key.
  45527. * This method call will fail and return false, if such key already exists.
  45528. * If you don't care and just want to get the data no matter what, use the more convenient getOrAddExternalDataWithFactory() method.
  45529. * @param key the unique key that identifies the data
  45530. * @param data the data object to associate to the key for this Engine instance
  45531. * @return true if no such key were already present and the data was added successfully, false otherwise
  45532. */
  45533. addExternalData<T>(key: string, data: T): boolean;
  45534. /**
  45535. * Get an externaly attached data from its key
  45536. * @param key the unique key that identifies the data
  45537. * @return the associated data, if present (can be null), or undefined if not present
  45538. */
  45539. getExternalData<T>(key: string): Nullable<T>;
  45540. /**
  45541. * Get an externaly attached data from its key, create it using a factory if it's not already present
  45542. * @param key the unique key that identifies the data
  45543. * @param factory the factory that will be called to create the instance if and only if it doesn't exists
  45544. * @return the associated data, can be null if the factory returned null.
  45545. */
  45546. getOrAddExternalDataWithFactory<T>(key: string, factory: (k: string) => T): T;
  45547. /**
  45548. * Remove an externaly attached data from the Engine instance
  45549. * @param key the unique key that identifies the data
  45550. * @return true if the data was successfully removed, false if it doesn't exist
  45551. */
  45552. removeExternalData(key: string): boolean;
  45553. private _evaluateSubMesh;
  45554. /**
  45555. * Clear the processed materials smart array preventing retention point in material dispose.
  45556. */
  45557. freeProcessedMaterials(): void;
  45558. private _preventFreeActiveMeshesAndRenderingGroups;
  45559. /** Gets or sets a boolean blocking all the calls to freeActiveMeshes and freeRenderingGroups
  45560. * It can be used in order to prevent going through methods freeRenderingGroups and freeActiveMeshes several times to improve performance
  45561. * when disposing several meshes in a row or a hierarchy of meshes.
  45562. * When used, it is the responsability of the user to blockfreeActiveMeshesAndRenderingGroups back to false.
  45563. */
  45564. get blockfreeActiveMeshesAndRenderingGroups(): boolean;
  45565. set blockfreeActiveMeshesAndRenderingGroups(value: boolean);
  45566. /**
  45567. * Clear the active meshes smart array preventing retention point in mesh dispose.
  45568. */
  45569. freeActiveMeshes(): void;
  45570. /**
  45571. * Clear the info related to rendering groups preventing retention points during dispose.
  45572. */
  45573. freeRenderingGroups(): void;
  45574. /** @hidden */
  45575. _isInIntermediateRendering(): boolean;
  45576. /**
  45577. * Lambda returning the list of potentially active meshes.
  45578. */
  45579. getActiveMeshCandidates: () => ISmartArrayLike<AbstractMesh>;
  45580. /**
  45581. * Lambda returning the list of potentially active sub meshes.
  45582. */
  45583. getActiveSubMeshCandidates: (mesh: AbstractMesh) => ISmartArrayLike<SubMesh>;
  45584. /**
  45585. * Lambda returning the list of potentially intersecting sub meshes.
  45586. */
  45587. getIntersectingSubMeshCandidates: (mesh: AbstractMesh, localRay: Ray) => ISmartArrayLike<SubMesh>;
  45588. /**
  45589. * Lambda returning the list of potentially colliding sub meshes.
  45590. */
  45591. getCollidingSubMeshCandidates: (mesh: AbstractMesh, collider: Collider) => ISmartArrayLike<SubMesh>;
  45592. private _activeMeshesFrozen;
  45593. private _skipEvaluateActiveMeshesCompletely;
  45594. /**
  45595. * Use this function to stop evaluating active meshes. The current list will be keep alive between frames
  45596. * @param skipEvaluateActiveMeshes defines an optional boolean indicating that the evaluate active meshes step must be completely skipped
  45597. * @param onSuccess optional success callback
  45598. * @param onError optional error callback
  45599. * @returns the current scene
  45600. */
  45601. freezeActiveMeshes(skipEvaluateActiveMeshes?: boolean, onSuccess?: () => void, onError?: (message: string) => void): Scene;
  45602. /**
  45603. * Use this function to restart evaluating active meshes on every frame
  45604. * @returns the current scene
  45605. */
  45606. unfreezeActiveMeshes(): Scene;
  45607. private _evaluateActiveMeshes;
  45608. private _activeMesh;
  45609. /**
  45610. * Update the transform matrix to update from the current active camera
  45611. * @param force defines a boolean used to force the update even if cache is up to date
  45612. */
  45613. updateTransformMatrix(force?: boolean): void;
  45614. private _bindFrameBuffer;
  45615. /** @hidden */
  45616. _allowPostProcessClearColor: boolean;
  45617. /** @hidden */
  45618. _renderForCamera(camera: Camera, rigParent?: Camera): void;
  45619. private _processSubCameras;
  45620. private _checkIntersections;
  45621. /** @hidden */
  45622. _advancePhysicsEngineStep(step: number): void;
  45623. /**
  45624. * User updatable function that will return a deterministic frame time when engine is in deterministic lock step mode
  45625. */
  45626. getDeterministicFrameTime: () => number;
  45627. /** @hidden */
  45628. _animate(): void;
  45629. /** Execute all animations (for a frame) */
  45630. animate(): void;
  45631. /**
  45632. * Render the scene
  45633. * @param updateCameras defines a boolean indicating if cameras must update according to their inputs (true by default)
  45634. * @param ignoreAnimations defines a boolean indicating if animations should not be executed (false by default)
  45635. */
  45636. render(updateCameras?: boolean, ignoreAnimations?: boolean): void;
  45637. /**
  45638. * Freeze all materials
  45639. * A frozen material will not be updatable but should be faster to render
  45640. */
  45641. freezeMaterials(): void;
  45642. /**
  45643. * Unfreeze all materials
  45644. * A frozen material will not be updatable but should be faster to render
  45645. */
  45646. unfreezeMaterials(): void;
  45647. /**
  45648. * Releases all held ressources
  45649. */
  45650. dispose(): void;
  45651. /**
  45652. * Gets if the scene is already disposed
  45653. */
  45654. get isDisposed(): boolean;
  45655. /**
  45656. * Call this function to reduce memory footprint of the scene.
  45657. * Vertex buffers will not store CPU data anymore (this will prevent picking, collisions or physics to work correctly)
  45658. */
  45659. clearCachedVertexData(): void;
  45660. /**
  45661. * This function will remove the local cached buffer data from texture.
  45662. * It will save memory but will prevent the texture from being rebuilt
  45663. */
  45664. cleanCachedTextureBuffer(): void;
  45665. /**
  45666. * Get the world extend vectors with an optional filter
  45667. *
  45668. * @param filterPredicate the predicate - which meshes should be included when calculating the world size
  45669. * @returns {{ min: Vector3; max: Vector3 }} min and max vectors
  45670. */
  45671. getWorldExtends(filterPredicate?: (mesh: AbstractMesh) => boolean): {
  45672. min: Vector3;
  45673. max: Vector3;
  45674. };
  45675. /**
  45676. * Creates a ray that can be used to pick in the scene
  45677. * @param x defines the x coordinate of the origin (on-screen)
  45678. * @param y defines the y coordinate of the origin (on-screen)
  45679. * @param world defines the world matrix to use if you want to pick in object space (instead of world space)
  45680. * @param camera defines the camera to use for the picking
  45681. * @param cameraViewSpace defines if picking will be done in view space (false by default)
  45682. * @returns a Ray
  45683. */
  45684. createPickingRay(x: number, y: number, world: Matrix, camera: Nullable<Camera>, cameraViewSpace?: boolean): Ray;
  45685. /**
  45686. * Creates a ray that can be used to pick in the scene
  45687. * @param x defines the x coordinate of the origin (on-screen)
  45688. * @param y defines the y coordinate of the origin (on-screen)
  45689. * @param world defines the world matrix to use if you want to pick in object space (instead of world space)
  45690. * @param result defines the ray where to store the picking ray
  45691. * @param camera defines the camera to use for the picking
  45692. * @param cameraViewSpace defines if picking will be done in view space (false by default)
  45693. * @returns the current scene
  45694. */
  45695. createPickingRayToRef(x: number, y: number, world: Matrix, result: Ray, camera: Nullable<Camera>, cameraViewSpace?: boolean): Scene;
  45696. /**
  45697. * Creates a ray that can be used to pick in the scene
  45698. * @param x defines the x coordinate of the origin (on-screen)
  45699. * @param y defines the y coordinate of the origin (on-screen)
  45700. * @param camera defines the camera to use for the picking
  45701. * @returns a Ray
  45702. */
  45703. createPickingRayInCameraSpace(x: number, y: number, camera?: Camera): Ray;
  45704. /**
  45705. * Creates a ray that can be used to pick in the scene
  45706. * @param x defines the x coordinate of the origin (on-screen)
  45707. * @param y defines the y coordinate of the origin (on-screen)
  45708. * @param result defines the ray where to store the picking ray
  45709. * @param camera defines the camera to use for the picking
  45710. * @returns the current scene
  45711. */
  45712. createPickingRayInCameraSpaceToRef(x: number, y: number, result: Ray, camera?: Camera): Scene;
  45713. /** Launch a ray to try to pick a mesh in the scene
  45714. * @param x position on screen
  45715. * @param y position on screen
  45716. * @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
  45717. * @param fastCheck defines if the first intersection will be used (and not the closest)
  45718. * @param camera to use for computing the picking ray. Can be set to null. In this case, the scene.activeCamera will be used
  45719. * @param trianglePredicate defines an optional predicate used to select faces when a mesh intersection is detected
  45720. * @returns a PickingInfo
  45721. */
  45722. pick(x: number, y: number, predicate?: (mesh: AbstractMesh) => boolean, fastCheck?: boolean, camera?: Nullable<Camera>, trianglePredicate?: TrianglePickingPredicate): Nullable<PickingInfo>;
  45723. /** Launch a ray to try to pick a mesh in the scene using only bounding information of the main mesh (not using submeshes)
  45724. * @param x position on screen
  45725. * @param y position on screen
  45726. * @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
  45727. * @param fastCheck defines if the first intersection will be used (and not the closest)
  45728. * @param camera to use for computing the picking ray. Can be set to null. In this case, the scene.activeCamera will be used
  45729. * @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)
  45730. */
  45731. pickWithBoundingInfo(x: number, y: number, predicate?: (mesh: AbstractMesh) => boolean, fastCheck?: boolean, camera?: Nullable<Camera>): Nullable<PickingInfo>;
  45732. /** Use the given ray to pick a mesh in the scene
  45733. * @param ray The ray to use to pick meshes
  45734. * @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
  45735. * @param fastCheck defines if the first intersection will be used (and not the closest)
  45736. * @param trianglePredicate defines an optional predicate used to select faces when a mesh intersection is detected
  45737. * @returns a PickingInfo
  45738. */
  45739. pickWithRay(ray: Ray, predicate?: (mesh: AbstractMesh) => boolean, fastCheck?: boolean, trianglePredicate?: TrianglePickingPredicate): Nullable<PickingInfo>;
  45740. /**
  45741. * Launch a ray to try to pick a mesh in the scene
  45742. * @param x X position on screen
  45743. * @param y Y position on screen
  45744. * @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
  45745. * @param camera camera to use for computing the picking ray. Can be set to null. In this case, the scene.activeCamera will be used
  45746. * @param trianglePredicate defines an optional predicate used to select faces when a mesh intersection is detected
  45747. * @returns an array of PickingInfo
  45748. */
  45749. multiPick(x: number, y: number, predicate?: (mesh: AbstractMesh) => boolean, camera?: Camera, trianglePredicate?: TrianglePickingPredicate): Nullable<PickingInfo[]>;
  45750. /**
  45751. * Launch a ray to try to pick a mesh in the scene
  45752. * @param ray Ray to use
  45753. * @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
  45754. * @param trianglePredicate defines an optional predicate used to select faces when a mesh intersection is detected
  45755. * @returns an array of PickingInfo
  45756. */
  45757. multiPickWithRay(ray: Ray, predicate: (mesh: AbstractMesh) => boolean, trianglePredicate?: TrianglePickingPredicate): Nullable<PickingInfo[]>;
  45758. /**
  45759. * Force the value of meshUnderPointer
  45760. * @param mesh defines the mesh to use
  45761. * @param pointerId optional pointer id when using more than one pointer
  45762. */
  45763. setPointerOverMesh(mesh: Nullable<AbstractMesh>, pointerId?: number): void;
  45764. /**
  45765. * Gets the mesh under the pointer
  45766. * @returns a Mesh or null if no mesh is under the pointer
  45767. */
  45768. getPointerOverMesh(): Nullable<AbstractMesh>;
  45769. /** @hidden */
  45770. _rebuildGeometries(): void;
  45771. /** @hidden */
  45772. _rebuildTextures(): void;
  45773. private _getByTags;
  45774. /**
  45775. * Get a list of meshes by tags
  45776. * @param tagsQuery defines the tags query to use
  45777. * @param forEach defines a predicate used to filter results
  45778. * @returns an array of Mesh
  45779. */
  45780. getMeshesByTags(tagsQuery: string, forEach?: (mesh: AbstractMesh) => void): Mesh[];
  45781. /**
  45782. * Get a list of cameras by tags
  45783. * @param tagsQuery defines the tags query to use
  45784. * @param forEach defines a predicate used to filter results
  45785. * @returns an array of Camera
  45786. */
  45787. getCamerasByTags(tagsQuery: string, forEach?: (camera: Camera) => void): Camera[];
  45788. /**
  45789. * Get a list of lights by tags
  45790. * @param tagsQuery defines the tags query to use
  45791. * @param forEach defines a predicate used to filter results
  45792. * @returns an array of Light
  45793. */
  45794. getLightsByTags(tagsQuery: string, forEach?: (light: Light) => void): Light[];
  45795. /**
  45796. * Get a list of materials by tags
  45797. * @param tagsQuery defines the tags query to use
  45798. * @param forEach defines a predicate used to filter results
  45799. * @returns an array of Material
  45800. */
  45801. getMaterialByTags(tagsQuery: string, forEach?: (material: Material) => void): Material[];
  45802. /**
  45803. * Get a list of transform nodes by tags
  45804. * @param tagsQuery defines the tags query to use
  45805. * @param forEach defines a predicate used to filter results
  45806. * @returns an array of TransformNode
  45807. */
  45808. getTransformNodesByTags(tagsQuery: string, forEach?: (transform: TransformNode) => void): TransformNode[];
  45809. /**
  45810. * Overrides the default sort function applied in the renderging group to prepare the meshes.
  45811. * This allowed control for front to back rendering or reversly depending of the special needs.
  45812. *
  45813. * @param renderingGroupId The rendering group id corresponding to its index
  45814. * @param opaqueSortCompareFn The opaque queue comparison function use to sort.
  45815. * @param alphaTestSortCompareFn The alpha test queue comparison function use to sort.
  45816. * @param transparentSortCompareFn The transparent queue comparison function use to sort.
  45817. */
  45818. 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;
  45819. /**
  45820. * Specifies whether or not the stencil and depth buffer are cleared between two rendering groups.
  45821. *
  45822. * @param renderingGroupId The rendering group id corresponding to its index
  45823. * @param autoClearDepthStencil Automatically clears depth and stencil between groups if true.
  45824. * @param depth Automatically clears depth between groups if true and autoClear is true.
  45825. * @param stencil Automatically clears stencil between groups if true and autoClear is true.
  45826. */
  45827. setRenderingAutoClearDepthStencil(renderingGroupId: number, autoClearDepthStencil: boolean, depth?: boolean, stencil?: boolean): void;
  45828. /**
  45829. * Gets the current auto clear configuration for one rendering group of the rendering
  45830. * manager.
  45831. * @param index the rendering group index to get the information for
  45832. * @returns The auto clear setup for the requested rendering group
  45833. */
  45834. getAutoClearDepthStencilSetup(index: number): IRenderingManagerAutoClearSetup;
  45835. private _blockMaterialDirtyMechanism;
  45836. /** Gets or sets a boolean blocking all the calls to markAllMaterialsAsDirty (ie. the materials won't be updated if they are out of sync) */
  45837. get blockMaterialDirtyMechanism(): boolean;
  45838. set blockMaterialDirtyMechanism(value: boolean);
  45839. /**
  45840. * Will flag all materials as dirty to trigger new shader compilation
  45841. * @param flag defines the flag used to specify which material part must be marked as dirty
  45842. * @param predicate If not null, it will be used to specifiy if a material has to be marked as dirty
  45843. */
  45844. markAllMaterialsAsDirty(flag: number, predicate?: (mat: Material) => boolean): void;
  45845. /** @hidden */
  45846. _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;
  45847. /** @hidden */
  45848. _loadFileAsync(url: string, onProgress?: (data: any) => void, useOfflineSupport?: boolean, useArrayBuffer?: boolean): Promise<string | ArrayBuffer>;
  45849. /** @hidden */
  45850. _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;
  45851. /** @hidden */
  45852. _requestFileAsync(url: string, onProgress?: (ev: ProgressEvent) => void, useOfflineSupport?: boolean, useArrayBuffer?: boolean, onOpened?: (request: WebRequest) => void): Promise<string | ArrayBuffer>;
  45853. /** @hidden */
  45854. _readFile(file: File, onSuccess: (data: string | ArrayBuffer) => void, onProgress?: (ev: ProgressEvent) => any, useArrayBuffer?: boolean, onError?: (error: ReadFileError) => void): IFileRequest;
  45855. /** @hidden */
  45856. _readFileAsync(file: File, onProgress?: (ev: ProgressEvent) => any, useArrayBuffer?: boolean): Promise<string | ArrayBuffer>;
  45857. }
  45858. }
  45859. declare module "babylonjs/assetContainer" {
  45860. import { AbstractScene } from "babylonjs/abstractScene";
  45861. import { Scene } from "babylonjs/scene";
  45862. import { Mesh } from "babylonjs/Meshes/mesh";
  45863. import { TransformNode } from "babylonjs/Meshes/transformNode";
  45864. import { Skeleton } from "babylonjs/Bones/skeleton";
  45865. import { AnimationGroup } from "babylonjs/Animations/animationGroup";
  45866. import { Animatable } from "babylonjs/Animations/animatable";
  45867. import { Nullable } from "babylonjs/types";
  45868. import { Node } from "babylonjs/node";
  45869. /**
  45870. * Set of assets to keep when moving a scene into an asset container.
  45871. */
  45872. export class KeepAssets extends AbstractScene {
  45873. }
  45874. /**
  45875. * Class used to store the output of the AssetContainer.instantiateAllMeshesToScene function
  45876. */
  45877. export class InstantiatedEntries {
  45878. /**
  45879. * List of new root nodes (eg. nodes with no parent)
  45880. */
  45881. rootNodes: TransformNode[];
  45882. /**
  45883. * List of new skeletons
  45884. */
  45885. skeletons: Skeleton[];
  45886. /**
  45887. * List of new animation groups
  45888. */
  45889. animationGroups: AnimationGroup[];
  45890. }
  45891. /**
  45892. * Container with a set of assets that can be added or removed from a scene.
  45893. */
  45894. export class AssetContainer extends AbstractScene {
  45895. private _wasAddedToScene;
  45896. /**
  45897. * The scene the AssetContainer belongs to.
  45898. */
  45899. scene: Scene;
  45900. /**
  45901. * Instantiates an AssetContainer.
  45902. * @param scene The scene the AssetContainer belongs to.
  45903. */
  45904. constructor(scene: Scene);
  45905. /**
  45906. * Instantiate or clone all meshes and add the new ones to the scene.
  45907. * Skeletons and animation groups will all be cloned
  45908. * @param nameFunction defines an optional function used to get new names for clones
  45909. * @param cloneMaterials defines an optional boolean that defines if materials must be cloned as well (false by default)
  45910. * @returns a list of rootNodes, skeletons and aniamtion groups that were duplicated
  45911. */
  45912. instantiateModelsToScene(nameFunction?: (sourceName: string) => string, cloneMaterials?: boolean): InstantiatedEntries;
  45913. /**
  45914. * Adds all the assets from the container to the scene.
  45915. */
  45916. addAllToScene(): void;
  45917. /**
  45918. * Removes all the assets in the container from the scene
  45919. */
  45920. removeAllFromScene(): void;
  45921. /**
  45922. * Disposes all the assets in the container
  45923. */
  45924. dispose(): void;
  45925. private _moveAssets;
  45926. /**
  45927. * Removes all the assets contained in the scene and adds them to the container.
  45928. * @param keepAssets Set of assets to keep in the scene. (default: empty)
  45929. */
  45930. moveAllFromScene(keepAssets?: KeepAssets): void;
  45931. /**
  45932. * 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.
  45933. * @returns the root mesh
  45934. */
  45935. createRootMesh(): Mesh;
  45936. /**
  45937. * Merge animations (direct and animation groups) from this asset container into a scene
  45938. * @param scene is the instance of BABYLON.Scene to append to (default: last created scene)
  45939. * @param animatables set of animatables to retarget to a node from the scene
  45940. * @param targetConverter defines a function used to convert animation targets from the asset container to the scene (default: search node by name)
  45941. * @returns an array of the new AnimationGroup added to the scene (empty array if none)
  45942. */
  45943. mergeAnimationsTo(scene: Scene | null | undefined, animatables: Animatable[], targetConverter?: Nullable<(target: any) => Nullable<Node>>): AnimationGroup[];
  45944. }
  45945. }
  45946. declare module "babylonjs/abstractScene" {
  45947. import { Scene } from "babylonjs/scene";
  45948. import { Nullable } from "babylonjs/types";
  45949. import { AbstractMesh } from "babylonjs/Meshes/abstractMesh";
  45950. import { TransformNode } from "babylonjs/Meshes/transformNode";
  45951. import { Geometry } from "babylonjs/Meshes/geometry";
  45952. import { Skeleton } from "babylonjs/Bones/skeleton";
  45953. import { MorphTargetManager } from "babylonjs/Morph/morphTargetManager";
  45954. import { AssetContainer } from "babylonjs/assetContainer";
  45955. import { IParticleSystem } from "babylonjs/Particles/IParticleSystem";
  45956. import { AnimationGroup } from "babylonjs/Animations/animationGroup";
  45957. import { BaseTexture } from "babylonjs/Materials/Textures/baseTexture";
  45958. import { Material } from "babylonjs/Materials/material";
  45959. import { MultiMaterial } from "babylonjs/Materials/multiMaterial";
  45960. import { AbstractActionManager } from "babylonjs/Actions/abstractActionManager";
  45961. import { Camera } from "babylonjs/Cameras/camera";
  45962. import { Light } from "babylonjs/Lights/light";
  45963. import { Node } from "babylonjs/node";
  45964. import { Animation } from "babylonjs/Animations/animation";
  45965. /**
  45966. * Defines how the parser contract is defined.
  45967. * These parsers are used to parse a list of specific assets (like particle systems, etc..)
  45968. */
  45969. export type BabylonFileParser = (parsedData: any, scene: Scene, container: AssetContainer, rootUrl: string) => void;
  45970. /**
  45971. * Defines how the individual parser contract is defined.
  45972. * These parser can parse an individual asset
  45973. */
  45974. export type IndividualBabylonFileParser = (parsedData: any, scene: Scene, rootUrl: string) => any;
  45975. /**
  45976. * Base class of the scene acting as a container for the different elements composing a scene.
  45977. * This class is dynamically extended by the different components of the scene increasing
  45978. * flexibility and reducing coupling
  45979. */
  45980. export abstract class AbstractScene {
  45981. /**
  45982. * Stores the list of available parsers in the application.
  45983. */
  45984. private static _BabylonFileParsers;
  45985. /**
  45986. * Stores the list of available individual parsers in the application.
  45987. */
  45988. private static _IndividualBabylonFileParsers;
  45989. /**
  45990. * Adds a parser in the list of available ones
  45991. * @param name Defines the name of the parser
  45992. * @param parser Defines the parser to add
  45993. */
  45994. static AddParser(name: string, parser: BabylonFileParser): void;
  45995. /**
  45996. * Gets a general parser from the list of avaialble ones
  45997. * @param name Defines the name of the parser
  45998. * @returns the requested parser or null
  45999. */
  46000. static GetParser(name: string): Nullable<BabylonFileParser>;
  46001. /**
  46002. * Adds n individual parser in the list of available ones
  46003. * @param name Defines the name of the parser
  46004. * @param parser Defines the parser to add
  46005. */
  46006. static AddIndividualParser(name: string, parser: IndividualBabylonFileParser): void;
  46007. /**
  46008. * Gets an individual parser from the list of avaialble ones
  46009. * @param name Defines the name of the parser
  46010. * @returns the requested parser or null
  46011. */
  46012. static GetIndividualParser(name: string): Nullable<IndividualBabylonFileParser>;
  46013. /**
  46014. * Parser json data and populate both a scene and its associated container object
  46015. * @param jsonData Defines the data to parse
  46016. * @param scene Defines the scene to parse the data for
  46017. * @param container Defines the container attached to the parsing sequence
  46018. * @param rootUrl Defines the root url of the data
  46019. */
  46020. static Parse(jsonData: any, scene: Scene, container: AssetContainer, rootUrl: string): void;
  46021. /**
  46022. * Gets the list of root nodes (ie. nodes with no parent)
  46023. */
  46024. rootNodes: Node[];
  46025. /** All of the cameras added to this scene
  46026. * @see https://doc.babylonjs.com/babylon101/cameras
  46027. */
  46028. cameras: Camera[];
  46029. /**
  46030. * All of the lights added to this scene
  46031. * @see https://doc.babylonjs.com/babylon101/lights
  46032. */
  46033. lights: Light[];
  46034. /**
  46035. * All of the (abstract) meshes added to this scene
  46036. */
  46037. meshes: AbstractMesh[];
  46038. /**
  46039. * The list of skeletons added to the scene
  46040. * @see https://doc.babylonjs.com/how_to/how_to_use_bones_and_skeletons
  46041. */
  46042. skeletons: Skeleton[];
  46043. /**
  46044. * All of the particle systems added to this scene
  46045. * @see https://doc.babylonjs.com/babylon101/particles
  46046. */
  46047. particleSystems: IParticleSystem[];
  46048. /**
  46049. * Gets a list of Animations associated with the scene
  46050. */
  46051. animations: Animation[];
  46052. /**
  46053. * All of the animation groups added to this scene
  46054. * @see https://doc.babylonjs.com/how_to/group
  46055. */
  46056. animationGroups: AnimationGroup[];
  46057. /**
  46058. * All of the multi-materials added to this scene
  46059. * @see https://doc.babylonjs.com/how_to/multi_materials
  46060. */
  46061. multiMaterials: MultiMaterial[];
  46062. /**
  46063. * All of the materials added to this scene
  46064. * In the context of a Scene, it is not supposed to be modified manually.
  46065. * Any addition or removal should be done using the addMaterial and removeMaterial Scene methods.
  46066. * Note also that the order of the Material within the array is not significant and might change.
  46067. * @see https://doc.babylonjs.com/babylon101/materials
  46068. */
  46069. materials: Material[];
  46070. /**
  46071. * The list of morph target managers added to the scene
  46072. * @see https://doc.babylonjs.com/how_to/how_to_dynamically_morph_a_mesh
  46073. */
  46074. morphTargetManagers: MorphTargetManager[];
  46075. /**
  46076. * The list of geometries used in the scene.
  46077. */
  46078. geometries: Geometry[];
  46079. /**
  46080. * All of the tranform nodes added to this scene
  46081. * In the context of a Scene, it is not supposed to be modified manually.
  46082. * Any addition or removal should be done using the addTransformNode and removeTransformNode Scene methods.
  46083. * Note also that the order of the TransformNode wihin the array is not significant and might change.
  46084. * @see https://doc.babylonjs.com/how_to/transformnode
  46085. */
  46086. transformNodes: TransformNode[];
  46087. /**
  46088. * ActionManagers available on the scene.
  46089. */
  46090. actionManagers: AbstractActionManager[];
  46091. /**
  46092. * Textures to keep.
  46093. */
  46094. textures: BaseTexture[];
  46095. /** @hidden */
  46096. protected _environmentTexture: Nullable<BaseTexture>;
  46097. /**
  46098. * Texture used in all pbr material as the reflection texture.
  46099. * As in the majority of the scene they are the same (exception for multi room and so on),
  46100. * this is easier to reference from here than from all the materials.
  46101. */
  46102. get environmentTexture(): Nullable<BaseTexture>;
  46103. set environmentTexture(value: Nullable<BaseTexture>);
  46104. /**
  46105. * The list of postprocesses added to the scene
  46106. */
  46107. postProcesses: import("babylonjs/PostProcesses/postProcess").PostProcess[];
  46108. /**
  46109. * @returns all meshes, lights, cameras, transformNodes and bones
  46110. */
  46111. getNodes(): Array<Node>;
  46112. }
  46113. }
  46114. declare module "babylonjs/Audio/sound" {
  46115. import { Observable } from "babylonjs/Misc/observable";
  46116. import { Vector3 } from "babylonjs/Maths/math.vector";
  46117. import { Nullable } from "babylonjs/types";
  46118. import { Scene } from "babylonjs/scene";
  46119. import { TransformNode } from "babylonjs/Meshes/transformNode";
  46120. /**
  46121. * Interface used to define options for Sound class
  46122. */
  46123. export interface ISoundOptions {
  46124. /**
  46125. * Does the sound autoplay once loaded.
  46126. */
  46127. autoplay?: boolean;
  46128. /**
  46129. * Does the sound loop after it finishes playing once.
  46130. */
  46131. loop?: boolean;
  46132. /**
  46133. * Sound's volume
  46134. */
  46135. volume?: number;
  46136. /**
  46137. * Is it a spatial sound?
  46138. */
  46139. spatialSound?: boolean;
  46140. /**
  46141. * Maximum distance to hear that sound
  46142. */
  46143. maxDistance?: number;
  46144. /**
  46145. * Uses user defined attenuation function
  46146. */
  46147. useCustomAttenuation?: boolean;
  46148. /**
  46149. * Define the roll off factor of spatial sounds.
  46150. * @see https://doc.babylonjs.com/how_to/playing_sounds_and_music#creating-a-spatial-3d-sound
  46151. */
  46152. rolloffFactor?: number;
  46153. /**
  46154. * Define the reference distance the sound should be heard perfectly.
  46155. * @see https://doc.babylonjs.com/how_to/playing_sounds_and_music#creating-a-spatial-3d-sound
  46156. */
  46157. refDistance?: number;
  46158. /**
  46159. * Define the distance attenuation model the sound will follow.
  46160. * @see https://doc.babylonjs.com/how_to/playing_sounds_and_music#creating-a-spatial-3d-sound
  46161. */
  46162. distanceModel?: string;
  46163. /**
  46164. * Defines the playback speed (1 by default)
  46165. */
  46166. playbackRate?: number;
  46167. /**
  46168. * Defines if the sound is from a streaming source
  46169. */
  46170. streaming?: boolean;
  46171. /**
  46172. * Defines an optional length (in seconds) inside the sound file
  46173. */
  46174. length?: number;
  46175. /**
  46176. * Defines an optional offset (in seconds) inside the sound file
  46177. */
  46178. offset?: number;
  46179. /**
  46180. * If true, URLs will not be required to state the audio file codec to use.
  46181. */
  46182. skipCodecCheck?: boolean;
  46183. }
  46184. /**
  46185. * Defines a sound that can be played in the application.
  46186. * The sound can either be an ambient track or a simple sound played in reaction to a user action.
  46187. * @see https://doc.babylonjs.com/how_to/playing_sounds_and_music
  46188. */
  46189. export class Sound {
  46190. /**
  46191. * The name of the sound in the scene.
  46192. */
  46193. name: string;
  46194. /**
  46195. * Does the sound autoplay once loaded.
  46196. */
  46197. autoplay: boolean;
  46198. /**
  46199. * Does the sound loop after it finishes playing once.
  46200. */
  46201. loop: boolean;
  46202. /**
  46203. * Does the sound use a custom attenuation curve to simulate the falloff
  46204. * happening when the source gets further away from the camera.
  46205. * @see https://doc.babylonjs.com/how_to/playing_sounds_and_music#creating-your-own-custom-attenuation-function
  46206. */
  46207. useCustomAttenuation: boolean;
  46208. /**
  46209. * The sound track id this sound belongs to.
  46210. */
  46211. soundTrackId: number;
  46212. /**
  46213. * Is this sound currently played.
  46214. */
  46215. isPlaying: boolean;
  46216. /**
  46217. * Is this sound currently paused.
  46218. */
  46219. isPaused: boolean;
  46220. /**
  46221. * Does this sound enables spatial sound.
  46222. * @see https://doc.babylonjs.com/how_to/playing_sounds_and_music#creating-a-spatial-3d-sound
  46223. */
  46224. spatialSound: boolean;
  46225. /**
  46226. * Define the reference distance the sound should be heard perfectly.
  46227. * @see https://doc.babylonjs.com/how_to/playing_sounds_and_music#creating-a-spatial-3d-sound
  46228. */
  46229. refDistance: number;
  46230. /**
  46231. * Define the roll off factor of spatial sounds.
  46232. * @see https://doc.babylonjs.com/how_to/playing_sounds_and_music#creating-a-spatial-3d-sound
  46233. */
  46234. rolloffFactor: number;
  46235. /**
  46236. * Define the max distance the sound should be heard (intensity just became 0 at this point).
  46237. * @see https://doc.babylonjs.com/how_to/playing_sounds_and_music#creating-a-spatial-3d-sound
  46238. */
  46239. maxDistance: number;
  46240. /**
  46241. * Define the distance attenuation model the sound will follow.
  46242. * @see https://doc.babylonjs.com/how_to/playing_sounds_and_music#creating-a-spatial-3d-sound
  46243. */
  46244. distanceModel: string;
  46245. /**
  46246. * @hidden
  46247. * Back Compat
  46248. **/
  46249. onended: () => any;
  46250. /**
  46251. * Gets or sets an object used to store user defined information for the sound.
  46252. */
  46253. metadata: any;
  46254. /**
  46255. * Observable event when the current playing sound finishes.
  46256. */
  46257. onEndedObservable: Observable<Sound>;
  46258. private _panningModel;
  46259. private _playbackRate;
  46260. private _streaming;
  46261. private _startTime;
  46262. private _startOffset;
  46263. private _position;
  46264. /** @hidden */
  46265. _positionInEmitterSpace: boolean;
  46266. private _localDirection;
  46267. private _volume;
  46268. private _isReadyToPlay;
  46269. private _isDirectional;
  46270. private _readyToPlayCallback;
  46271. private _audioBuffer;
  46272. private _soundSource;
  46273. private _streamingSource;
  46274. private _soundPanner;
  46275. private _soundGain;
  46276. private _inputAudioNode;
  46277. private _outputAudioNode;
  46278. private _coneInnerAngle;
  46279. private _coneOuterAngle;
  46280. private _coneOuterGain;
  46281. private _scene;
  46282. private _connectedTransformNode;
  46283. private _customAttenuationFunction;
  46284. private _registerFunc;
  46285. private _isOutputConnected;
  46286. private _htmlAudioElement;
  46287. private _urlType;
  46288. private _length?;
  46289. private _offset?;
  46290. /** @hidden */
  46291. static _SceneComponentInitialization: (scene: Scene) => void;
  46292. /**
  46293. * Create a sound and attach it to a scene
  46294. * @param name Name of your sound
  46295. * @param urlOrArrayBuffer Url to the sound to load async or ArrayBuffer, it also works with MediaStreams
  46296. * @param scene defines the scene the sound belongs to
  46297. * @param readyToPlayCallback Provide a callback function if you'd like to load your code once the sound is ready to be played
  46298. * @param options Objects to provide with the current available options: autoplay, loop, volume, spatialSound, maxDistance, rolloffFactor, refDistance, distanceModel, panningModel, streaming
  46299. */
  46300. constructor(name: string, urlOrArrayBuffer: any, scene: Scene, readyToPlayCallback?: Nullable<() => void>, options?: ISoundOptions);
  46301. /**
  46302. * Release the sound and its associated resources
  46303. */
  46304. dispose(): void;
  46305. /**
  46306. * Gets if the sounds is ready to be played or not.
  46307. * @returns true if ready, otherwise false
  46308. */
  46309. isReady(): boolean;
  46310. private _soundLoaded;
  46311. /**
  46312. * Sets the data of the sound from an audiobuffer
  46313. * @param audioBuffer The audioBuffer containing the data
  46314. */
  46315. setAudioBuffer(audioBuffer: AudioBuffer): void;
  46316. /**
  46317. * Updates the current sounds options such as maxdistance, loop...
  46318. * @param options A JSON object containing values named as the object properties
  46319. */
  46320. updateOptions(options: ISoundOptions): void;
  46321. private _createSpatialParameters;
  46322. private _updateSpatialParameters;
  46323. /**
  46324. * Switch the panning model to HRTF:
  46325. * Renders a stereo output of higher quality than equalpower — it uses a convolution with measured impulse responses from human subjects.
  46326. * @see https://doc.babylonjs.com/how_to/playing_sounds_and_music#creating-a-spatial-3d-sound
  46327. */
  46328. switchPanningModelToHRTF(): void;
  46329. /**
  46330. * Switch the panning model to Equal Power:
  46331. * Represents the equal-power panning algorithm, generally regarded as simple and efficient. equalpower is the default value.
  46332. * @see https://doc.babylonjs.com/how_to/playing_sounds_and_music#creating-a-spatial-3d-sound
  46333. */
  46334. switchPanningModelToEqualPower(): void;
  46335. private _switchPanningModel;
  46336. /**
  46337. * Connect this sound to a sound track audio node like gain...
  46338. * @param soundTrackAudioNode the sound track audio node to connect to
  46339. */
  46340. connectToSoundTrackAudioNode(soundTrackAudioNode: AudioNode): void;
  46341. /**
  46342. * Transform this sound into a directional source
  46343. * @param coneInnerAngle Size of the inner cone in degree
  46344. * @param coneOuterAngle Size of the outer cone in degree
  46345. * @param coneOuterGain Volume of the sound outside the outer cone (between 0.0 and 1.0)
  46346. */
  46347. setDirectionalCone(coneInnerAngle: number, coneOuterAngle: number, coneOuterGain: number): void;
  46348. /**
  46349. * Gets or sets the inner angle for the directional cone.
  46350. */
  46351. get directionalConeInnerAngle(): number;
  46352. /**
  46353. * Gets or sets the inner angle for the directional cone.
  46354. */
  46355. set directionalConeInnerAngle(value: number);
  46356. /**
  46357. * Gets or sets the outer angle for the directional cone.
  46358. */
  46359. get directionalConeOuterAngle(): number;
  46360. /**
  46361. * Gets or sets the outer angle for the directional cone.
  46362. */
  46363. set directionalConeOuterAngle(value: number);
  46364. /**
  46365. * Sets the position of the emitter if spatial sound is enabled
  46366. * @param newPosition Defines the new posisiton
  46367. */
  46368. setPosition(newPosition: Vector3): void;
  46369. /**
  46370. * Sets the local direction of the emitter if spatial sound is enabled
  46371. * @param newLocalDirection Defines the new local direction
  46372. */
  46373. setLocalDirectionToMesh(newLocalDirection: Vector3): void;
  46374. private _updateDirection;
  46375. /** @hidden */
  46376. updateDistanceFromListener(): void;
  46377. /**
  46378. * Sets a new custom attenuation function for the sound.
  46379. * @param callback Defines the function used for the attenuation
  46380. * @see https://doc.babylonjs.com/how_to/playing_sounds_and_music#creating-your-own-custom-attenuation-function
  46381. */
  46382. setAttenuationFunction(callback: (currentVolume: number, currentDistance: number, maxDistance: number, refDistance: number, rolloffFactor: number) => number): void;
  46383. /**
  46384. * Play the sound
  46385. * @param time (optional) Start the sound after X seconds. Start immediately (0) by default.
  46386. * @param offset (optional) Start the sound at a specific time in seconds
  46387. * @param length (optional) Sound duration (in seconds)
  46388. */
  46389. play(time?: number, offset?: number, length?: number): void;
  46390. private _onended;
  46391. /**
  46392. * Stop the sound
  46393. * @param time (optional) Stop the sound after X seconds. Stop immediately (0) by default.
  46394. */
  46395. stop(time?: number): void;
  46396. /**
  46397. * Put the sound in pause
  46398. */
  46399. pause(): void;
  46400. /**
  46401. * Sets a dedicated volume for this sounds
  46402. * @param newVolume Define the new volume of the sound
  46403. * @param time Define time for gradual change to new volume
  46404. */
  46405. setVolume(newVolume: number, time?: number): void;
  46406. /**
  46407. * Set the sound play back rate
  46408. * @param newPlaybackRate Define the playback rate the sound should be played at
  46409. */
  46410. setPlaybackRate(newPlaybackRate: number): void;
  46411. /**
  46412. * Gets the volume of the sound.
  46413. * @returns the volume of the sound
  46414. */
  46415. getVolume(): number;
  46416. /**
  46417. * Attach the sound to a dedicated mesh
  46418. * @param transformNode The transform node to connect the sound with
  46419. * @see https://doc.babylonjs.com/how_to/playing_sounds_and_music#attaching-a-sound-to-a-mesh
  46420. */
  46421. attachToMesh(transformNode: TransformNode): void;
  46422. /**
  46423. * Detach the sound from the previously attached mesh
  46424. * @see https://doc.babylonjs.com/how_to/playing_sounds_and_music#attaching-a-sound-to-a-mesh
  46425. */
  46426. detachFromMesh(): void;
  46427. private _onRegisterAfterWorldMatrixUpdate;
  46428. /**
  46429. * Clone the current sound in the scene.
  46430. * @returns the new sound clone
  46431. */
  46432. clone(): Nullable<Sound>;
  46433. /**
  46434. * Gets the current underlying audio buffer containing the data
  46435. * @returns the audio buffer
  46436. */
  46437. getAudioBuffer(): Nullable<AudioBuffer>;
  46438. /**
  46439. * Gets the WebAudio AudioBufferSourceNode, lets you keep track of and stop instances of this Sound.
  46440. * @returns the source node
  46441. */
  46442. getSoundSource(): Nullable<AudioBufferSourceNode>;
  46443. /**
  46444. * Gets the WebAudio GainNode, gives you precise control over the gain of instances of this Sound.
  46445. * @returns the gain node
  46446. */
  46447. getSoundGain(): Nullable<GainNode>;
  46448. /**
  46449. * Serializes the Sound in a JSON representation
  46450. * @returns the JSON representation of the sound
  46451. */
  46452. serialize(): any;
  46453. /**
  46454. * Parse a JSON representation of a sound to innstantiate in a given scene
  46455. * @param parsedSound Define the JSON representation of the sound (usually coming from the serialize method)
  46456. * @param scene Define the scene the new parsed sound should be created in
  46457. * @param rootUrl Define the rooturl of the load in case we need to fetch relative dependencies
  46458. * @param sourceSound Define a cound place holder if do not need to instantiate a new one
  46459. * @returns the newly parsed sound
  46460. */
  46461. static Parse(parsedSound: any, scene: Scene, rootUrl: string, sourceSound?: Sound): Sound;
  46462. }
  46463. }
  46464. declare module "babylonjs/Actions/directAudioActions" {
  46465. import { Action } from "babylonjs/Actions/action";
  46466. import { Condition } from "babylonjs/Actions/condition";
  46467. import { Sound } from "babylonjs/Audio/sound";
  46468. /**
  46469. * This defines an action helpful to play a defined sound on a triggered action.
  46470. */
  46471. export class PlaySoundAction extends Action {
  46472. private _sound;
  46473. /**
  46474. * Instantiate the action
  46475. * @param triggerOptions defines the trigger options
  46476. * @param sound defines the sound to play
  46477. * @param condition defines the trigger related conditions
  46478. */
  46479. constructor(triggerOptions: any, sound: Sound, condition?: Condition);
  46480. /** @hidden */
  46481. _prepare(): void;
  46482. /**
  46483. * Execute the action and play the sound.
  46484. */
  46485. execute(): void;
  46486. /**
  46487. * Serializes the actions and its related information.
  46488. * @param parent defines the object to serialize in
  46489. * @returns the serialized object
  46490. */
  46491. serialize(parent: any): any;
  46492. }
  46493. /**
  46494. * This defines an action helpful to stop a defined sound on a triggered action.
  46495. */
  46496. export class StopSoundAction extends Action {
  46497. private _sound;
  46498. /**
  46499. * Instantiate the action
  46500. * @param triggerOptions defines the trigger options
  46501. * @param sound defines the sound to stop
  46502. * @param condition defines the trigger related conditions
  46503. */
  46504. constructor(triggerOptions: any, sound: Sound, condition?: Condition);
  46505. /** @hidden */
  46506. _prepare(): void;
  46507. /**
  46508. * Execute the action and stop the sound.
  46509. */
  46510. execute(): void;
  46511. /**
  46512. * Serializes the actions and its related information.
  46513. * @param parent defines the object to serialize in
  46514. * @returns the serialized object
  46515. */
  46516. serialize(parent: any): any;
  46517. }
  46518. }
  46519. declare module "babylonjs/Actions/interpolateValueAction" {
  46520. import { Action } from "babylonjs/Actions/action";
  46521. import { Condition } from "babylonjs/Actions/condition";
  46522. import { Observable } from "babylonjs/Misc/observable";
  46523. /**
  46524. * This defines an action responsible to change the value of a property
  46525. * by interpolating between its current value and the newly set one once triggered.
  46526. * @see https://doc.babylonjs.com/how_to/how_to_use_actions
  46527. */
  46528. export class InterpolateValueAction extends Action {
  46529. /**
  46530. * Defines the path of the property where the value should be interpolated
  46531. */
  46532. propertyPath: string;
  46533. /**
  46534. * Defines the target value at the end of the interpolation.
  46535. */
  46536. value: any;
  46537. /**
  46538. * Defines the time it will take for the property to interpolate to the value.
  46539. */
  46540. duration: number;
  46541. /**
  46542. * Defines if the other scene animations should be stopped when the action has been triggered
  46543. */
  46544. stopOtherAnimations?: boolean;
  46545. /**
  46546. * Defines a callback raised once the interpolation animation has been done.
  46547. */
  46548. onInterpolationDone?: () => void;
  46549. /**
  46550. * Observable triggered once the interpolation animation has been done.
  46551. */
  46552. onInterpolationDoneObservable: Observable<InterpolateValueAction>;
  46553. private _target;
  46554. private _effectiveTarget;
  46555. private _property;
  46556. /**
  46557. * Instantiate the action
  46558. * @param triggerOptions defines the trigger options
  46559. * @param target defines the object containing the value to interpolate
  46560. * @param propertyPath defines the path to the property in the target object
  46561. * @param value defines the target value at the end of the interpolation
  46562. * @param duration deines the time it will take for the property to interpolate to the value.
  46563. * @param condition defines the trigger related conditions
  46564. * @param stopOtherAnimations defines if the other scene animations should be stopped when the action has been triggered
  46565. * @param onInterpolationDone defines a callback raised once the interpolation animation has been done
  46566. */
  46567. constructor(triggerOptions: any, target: any, propertyPath: string, value: any, duration?: number, condition?: Condition, stopOtherAnimations?: boolean, onInterpolationDone?: () => void);
  46568. /** @hidden */
  46569. _prepare(): void;
  46570. /**
  46571. * Execute the action starts the value interpolation.
  46572. */
  46573. execute(): void;
  46574. /**
  46575. * Serializes the actions and its related information.
  46576. * @param parent defines the object to serialize in
  46577. * @returns the serialized object
  46578. */
  46579. serialize(parent: any): any;
  46580. }
  46581. }
  46582. declare module "babylonjs/Actions/index" {
  46583. export * from "babylonjs/Actions/abstractActionManager";
  46584. export * from "babylonjs/Actions/action";
  46585. export * from "babylonjs/Actions/actionEvent";
  46586. export * from "babylonjs/Actions/actionManager";
  46587. export * from "babylonjs/Actions/condition";
  46588. export * from "babylonjs/Actions/directActions";
  46589. export * from "babylonjs/Actions/directAudioActions";
  46590. export * from "babylonjs/Actions/interpolateValueAction";
  46591. }
  46592. declare module "babylonjs/Animations/index" {
  46593. export * from "babylonjs/Animations/animatable";
  46594. export * from "babylonjs/Animations/animation";
  46595. export * from "babylonjs/Animations/animationGroup";
  46596. export * from "babylonjs/Animations/animationPropertiesOverride";
  46597. export * from "babylonjs/Animations/easing";
  46598. export * from "babylonjs/Animations/runtimeAnimation";
  46599. export * from "babylonjs/Animations/animationEvent";
  46600. export * from "babylonjs/Animations/animationGroup";
  46601. export * from "babylonjs/Animations/animationKey";
  46602. export * from "babylonjs/Animations/animationRange";
  46603. export * from "babylonjs/Animations/animatable.interface";
  46604. }
  46605. declare module "babylonjs/Audio/soundTrack" {
  46606. import { Sound } from "babylonjs/Audio/sound";
  46607. import { Analyser } from "babylonjs/Audio/analyser";
  46608. import { Scene } from "babylonjs/scene";
  46609. /**
  46610. * Options allowed during the creation of a sound track.
  46611. */
  46612. export interface ISoundTrackOptions {
  46613. /**
  46614. * The volume the sound track should take during creation
  46615. */
  46616. volume?: number;
  46617. /**
  46618. * Define if the sound track is the main sound track of the scene
  46619. */
  46620. mainTrack?: boolean;
  46621. }
  46622. /**
  46623. * It could be useful to isolate your music & sounds on several tracks to better manage volume on a grouped instance of sounds.
  46624. * It will be also used in a future release to apply effects on a specific track.
  46625. * @see https://doc.babylonjs.com/how_to/playing_sounds_and_music#using-sound-tracks
  46626. */
  46627. export class SoundTrack {
  46628. /**
  46629. * The unique identifier of the sound track in the scene.
  46630. */
  46631. id: number;
  46632. /**
  46633. * The list of sounds included in the sound track.
  46634. */
  46635. soundCollection: Array<Sound>;
  46636. private _outputAudioNode;
  46637. private _scene;
  46638. private _connectedAnalyser;
  46639. private _options;
  46640. private _isInitialized;
  46641. /**
  46642. * Creates a new sound track.
  46643. * @see https://doc.babylonjs.com/how_to/playing_sounds_and_music#using-sound-tracks
  46644. * @param scene Define the scene the sound track belongs to
  46645. * @param options
  46646. */
  46647. constructor(scene: Scene, options?: ISoundTrackOptions);
  46648. private _initializeSoundTrackAudioGraph;
  46649. /**
  46650. * Release the sound track and its associated resources
  46651. */
  46652. dispose(): void;
  46653. /**
  46654. * Adds a sound to this sound track
  46655. * @param sound define the cound to add
  46656. * @ignoreNaming
  46657. */
  46658. AddSound(sound: Sound): void;
  46659. /**
  46660. * Removes a sound to this sound track
  46661. * @param sound define the cound to remove
  46662. * @ignoreNaming
  46663. */
  46664. RemoveSound(sound: Sound): void;
  46665. /**
  46666. * Set a global volume for the full sound track.
  46667. * @param newVolume Define the new volume of the sound track
  46668. */
  46669. setVolume(newVolume: number): void;
  46670. /**
  46671. * Switch the panning model to HRTF:
  46672. * Renders a stereo output of higher quality than equalpower — it uses a convolution with measured impulse responses from human subjects.
  46673. * @see https://doc.babylonjs.com/how_to/playing_sounds_and_music#creating-a-spatial-3d-sound
  46674. */
  46675. switchPanningModelToHRTF(): void;
  46676. /**
  46677. * Switch the panning model to Equal Power:
  46678. * Represents the equal-power panning algorithm, generally regarded as simple and efficient. equalpower is the default value.
  46679. * @see https://doc.babylonjs.com/how_to/playing_sounds_and_music#creating-a-spatial-3d-sound
  46680. */
  46681. switchPanningModelToEqualPower(): void;
  46682. /**
  46683. * Connect the sound track to an audio analyser allowing some amazing
  46684. * synchornization between the sounds/music and your visualization (VuMeter for instance).
  46685. * @see https://doc.babylonjs.com/how_to/playing_sounds_and_music#using-the-analyser
  46686. * @param analyser The analyser to connect to the engine
  46687. */
  46688. connectToAnalyser(analyser: Analyser): void;
  46689. }
  46690. }
  46691. declare module "babylonjs/Audio/audioSceneComponent" {
  46692. import { Sound } from "babylonjs/Audio/sound";
  46693. import { SoundTrack } from "babylonjs/Audio/soundTrack";
  46694. import { Nullable } from "babylonjs/types";
  46695. import { Vector3 } from "babylonjs/Maths/math.vector";
  46696. import { ISceneSerializableComponent } from "babylonjs/sceneComponent";
  46697. import { Scene } from "babylonjs/scene";
  46698. import { AbstractScene } from "babylonjs/abstractScene";
  46699. import "babylonjs/Audio/audioEngine";
  46700. module "babylonjs/abstractScene" {
  46701. interface AbstractScene {
  46702. /**
  46703. * The list of sounds used in the scene.
  46704. */
  46705. sounds: Nullable<Array<Sound>>;
  46706. }
  46707. }
  46708. module "babylonjs/scene" {
  46709. interface Scene {
  46710. /**
  46711. * @hidden
  46712. * Backing field
  46713. */
  46714. _mainSoundTrack: SoundTrack;
  46715. /**
  46716. * The main sound track played by the scene.
  46717. * It cotains your primary collection of sounds.
  46718. */
  46719. mainSoundTrack: SoundTrack;
  46720. /**
  46721. * The list of sound tracks added to the scene
  46722. * @see https://doc.babylonjs.com/how_to/playing_sounds_and_music
  46723. */
  46724. soundTracks: Nullable<Array<SoundTrack>>;
  46725. /**
  46726. * Gets a sound using a given name
  46727. * @param name defines the name to search for
  46728. * @return the found sound or null if not found at all.
  46729. */
  46730. getSoundByName(name: string): Nullable<Sound>;
  46731. /**
  46732. * Gets or sets if audio support is enabled
  46733. * @see https://doc.babylonjs.com/how_to/playing_sounds_and_music
  46734. */
  46735. audioEnabled: boolean;
  46736. /**
  46737. * Gets or sets if audio will be output to headphones
  46738. * @see https://doc.babylonjs.com/how_to/playing_sounds_and_music
  46739. */
  46740. headphone: boolean;
  46741. /**
  46742. * Gets or sets custom audio listener position provider
  46743. * @see https://doc.babylonjs.com/how_to/playing_sounds_and_music
  46744. */
  46745. audioListenerPositionProvider: Nullable<() => Vector3>;
  46746. /**
  46747. * Gets or sets a refresh rate when using 3D audio positioning
  46748. */
  46749. audioPositioningRefreshRate: number;
  46750. }
  46751. }
  46752. /**
  46753. * Defines the sound scene component responsible to manage any sounds
  46754. * in a given scene.
  46755. */
  46756. export class AudioSceneComponent implements ISceneSerializableComponent {
  46757. private static _CameraDirectionLH;
  46758. private static _CameraDirectionRH;
  46759. /**
  46760. * The component name helpfull to identify the component in the list of scene components.
  46761. */
  46762. readonly name: string;
  46763. /**
  46764. * The scene the component belongs to.
  46765. */
  46766. scene: Scene;
  46767. private _audioEnabled;
  46768. /**
  46769. * Gets whether audio is enabled or not.
  46770. * Please use related enable/disable method to switch state.
  46771. */
  46772. get audioEnabled(): boolean;
  46773. private _headphone;
  46774. /**
  46775. * Gets whether audio is outputing to headphone or not.
  46776. * Please use the according Switch methods to change output.
  46777. */
  46778. get headphone(): boolean;
  46779. /**
  46780. * Gets or sets a refresh rate when using 3D audio positioning
  46781. */
  46782. audioPositioningRefreshRate: number;
  46783. private _audioListenerPositionProvider;
  46784. /**
  46785. * Gets the current audio listener position provider
  46786. */
  46787. get audioListenerPositionProvider(): Nullable<() => Vector3>;
  46788. /**
  46789. * Sets a custom listener position for all sounds in the scene
  46790. * By default, this is the position of the first active camera
  46791. */
  46792. set audioListenerPositionProvider(value: Nullable<() => Vector3>);
  46793. /**
  46794. * Creates a new instance of the component for the given scene
  46795. * @param scene Defines the scene to register the component in
  46796. */
  46797. constructor(scene: Scene);
  46798. /**
  46799. * Registers the component in a given scene
  46800. */
  46801. register(): void;
  46802. /**
  46803. * Rebuilds the elements related to this component in case of
  46804. * context lost for instance.
  46805. */
  46806. rebuild(): void;
  46807. /**
  46808. * Serializes the component data to the specified json object
  46809. * @param serializationObject The object to serialize to
  46810. */
  46811. serialize(serializationObject: any): void;
  46812. /**
  46813. * Adds all the elements from the container to the scene
  46814. * @param container the container holding the elements
  46815. */
  46816. addFromContainer(container: AbstractScene): void;
  46817. /**
  46818. * Removes all the elements in the container from the scene
  46819. * @param container contains the elements to remove
  46820. * @param dispose if the removed element should be disposed (default: false)
  46821. */
  46822. removeFromContainer(container: AbstractScene, dispose?: boolean): void;
  46823. /**
  46824. * Disposes the component and the associated ressources.
  46825. */
  46826. dispose(): void;
  46827. /**
  46828. * Disables audio in the associated scene.
  46829. */
  46830. disableAudio(): void;
  46831. /**
  46832. * Enables audio in the associated scene.
  46833. */
  46834. enableAudio(): void;
  46835. /**
  46836. * Switch audio to headphone output.
  46837. */
  46838. switchAudioModeForHeadphones(): void;
  46839. /**
  46840. * Switch audio to normal speakers.
  46841. */
  46842. switchAudioModeForNormalSpeakers(): void;
  46843. private _cachedCameraDirection;
  46844. private _cachedCameraPosition;
  46845. private _lastCheck;
  46846. private _afterRender;
  46847. }
  46848. }
  46849. declare module "babylonjs/Audio/weightedsound" {
  46850. import { Sound } from "babylonjs/Audio/sound";
  46851. /**
  46852. * Wraps one or more Sound objects and selects one with random weight for playback.
  46853. */
  46854. export class WeightedSound {
  46855. /** When true a Sound will be selected and played when the current playing Sound completes. */
  46856. loop: boolean;
  46857. private _coneInnerAngle;
  46858. private _coneOuterAngle;
  46859. private _volume;
  46860. /** A Sound is currently playing. */
  46861. isPlaying: boolean;
  46862. /** A Sound is currently paused. */
  46863. isPaused: boolean;
  46864. private _sounds;
  46865. private _weights;
  46866. private _currentIndex?;
  46867. /**
  46868. * Creates a new WeightedSound from the list of sounds given.
  46869. * @param loop When true a Sound will be selected and played when the current playing Sound completes.
  46870. * @param sounds Array of Sounds that will be selected from.
  46871. * @param weights Array of number values for selection weights; length must equal sounds, values will be normalized to 1
  46872. */
  46873. constructor(loop: boolean, sounds: Sound[], weights: number[]);
  46874. /**
  46875. * The size of cone in degrees for a directional sound in which there will be no attenuation.
  46876. */
  46877. get directionalConeInnerAngle(): number;
  46878. /**
  46879. * The size of cone in degress for a directional sound in which there will be no attenuation.
  46880. */
  46881. set directionalConeInnerAngle(value: number);
  46882. /**
  46883. * Size of cone in degrees for a directional sound outside of which there will be no sound.
  46884. * Listener angles between innerAngle and outerAngle will falloff linearly.
  46885. */
  46886. get directionalConeOuterAngle(): number;
  46887. /**
  46888. * Size of cone in degrees for a directional sound outside of which there will be no sound.
  46889. * Listener angles between innerAngle and outerAngle will falloff linearly.
  46890. */
  46891. set directionalConeOuterAngle(value: number);
  46892. /**
  46893. * Playback volume.
  46894. */
  46895. get volume(): number;
  46896. /**
  46897. * Playback volume.
  46898. */
  46899. set volume(value: number);
  46900. private _onended;
  46901. /**
  46902. * Suspend playback
  46903. */
  46904. pause(): void;
  46905. /**
  46906. * Stop playback
  46907. */
  46908. stop(): void;
  46909. /**
  46910. * Start playback.
  46911. * @param startOffset Position the clip head at a specific time in seconds.
  46912. */
  46913. play(startOffset?: number): void;
  46914. }
  46915. }
  46916. declare module "babylonjs/Audio/index" {
  46917. export * from "babylonjs/Audio/analyser";
  46918. export * from "babylonjs/Audio/audioEngine";
  46919. export * from "babylonjs/Audio/audioSceneComponent";
  46920. export * from "babylonjs/Audio/sound";
  46921. export * from "babylonjs/Audio/soundTrack";
  46922. export * from "babylonjs/Audio/weightedsound";
  46923. }
  46924. declare module "babylonjs/Behaviors/Cameras/bouncingBehavior" {
  46925. import { Behavior } from "babylonjs/Behaviors/behavior";
  46926. import { ArcRotateCamera } from "babylonjs/Cameras/arcRotateCamera";
  46927. import { BackEase } from "babylonjs/Animations/easing";
  46928. /**
  46929. * Add a bouncing effect to an ArcRotateCamera when reaching a specified minimum and maximum radius
  46930. * @see https://doc.babylonjs.com/how_to/camera_behaviors#bouncing-behavior
  46931. */
  46932. export class BouncingBehavior implements Behavior<ArcRotateCamera> {
  46933. /**
  46934. * Gets the name of the behavior.
  46935. */
  46936. get name(): string;
  46937. /**
  46938. * The easing function used by animations
  46939. */
  46940. static EasingFunction: BackEase;
  46941. /**
  46942. * The easing mode used by animations
  46943. */
  46944. static EasingMode: number;
  46945. /**
  46946. * The duration of the animation, in milliseconds
  46947. */
  46948. transitionDuration: number;
  46949. /**
  46950. * Length of the distance animated by the transition when lower radius is reached
  46951. */
  46952. lowerRadiusTransitionRange: number;
  46953. /**
  46954. * Length of the distance animated by the transition when upper radius is reached
  46955. */
  46956. upperRadiusTransitionRange: number;
  46957. private _autoTransitionRange;
  46958. /**
  46959. * Gets a value indicating if the lowerRadiusTransitionRange and upperRadiusTransitionRange are defined automatically
  46960. */
  46961. get autoTransitionRange(): boolean;
  46962. /**
  46963. * Sets a value indicating if the lowerRadiusTransitionRange and upperRadiusTransitionRange are defined automatically
  46964. * Transition ranges will be set to 5% of the bounding box diagonal in world space
  46965. */
  46966. set autoTransitionRange(value: boolean);
  46967. private _attachedCamera;
  46968. private _onAfterCheckInputsObserver;
  46969. private _onMeshTargetChangedObserver;
  46970. /**
  46971. * Initializes the behavior.
  46972. */
  46973. init(): void;
  46974. /**
  46975. * Attaches the behavior to its arc rotate camera.
  46976. * @param camera Defines the camera to attach the behavior to
  46977. */
  46978. attach(camera: ArcRotateCamera): void;
  46979. /**
  46980. * Detaches the behavior from its current arc rotate camera.
  46981. */
  46982. detach(): void;
  46983. private _radiusIsAnimating;
  46984. private _radiusBounceTransition;
  46985. private _animatables;
  46986. private _cachedWheelPrecision;
  46987. /**
  46988. * Checks if the camera radius is at the specified limit. Takes into account animation locks.
  46989. * @param radiusLimit The limit to check against.
  46990. * @return Bool to indicate if at limit.
  46991. */
  46992. private _isRadiusAtLimit;
  46993. /**
  46994. * Applies an animation to the radius of the camera, extending by the radiusDelta.
  46995. * @param radiusDelta The delta by which to animate to. Can be negative.
  46996. */
  46997. private _applyBoundRadiusAnimation;
  46998. /**
  46999. * Removes all animation locks. Allows new animations to be added to any of the camera properties.
  47000. */
  47001. protected _clearAnimationLocks(): void;
  47002. /**
  47003. * Stops and removes all animations that have been applied to the camera
  47004. */
  47005. stopAllAnimations(): void;
  47006. }
  47007. }
  47008. declare module "babylonjs/Behaviors/Cameras/framingBehavior" {
  47009. import { Behavior } from "babylonjs/Behaviors/behavior";
  47010. import { ArcRotateCamera } from "babylonjs/Cameras/arcRotateCamera";
  47011. import { ExponentialEase } from "babylonjs/Animations/easing";
  47012. import { Nullable } from "babylonjs/types";
  47013. import { AbstractMesh } from "babylonjs/Meshes/abstractMesh";
  47014. import { Vector3 } from "babylonjs/Maths/math.vector";
  47015. /**
  47016. * 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.
  47017. * @see https://doc.babylonjs.com/how_to/camera_behaviors#framing-behavior
  47018. */
  47019. export class FramingBehavior implements Behavior<ArcRotateCamera> {
  47020. /**
  47021. * Gets the name of the behavior.
  47022. */
  47023. get name(): string;
  47024. private _mode;
  47025. private _radiusScale;
  47026. private _positionScale;
  47027. private _defaultElevation;
  47028. private _elevationReturnTime;
  47029. private _elevationReturnWaitTime;
  47030. private _zoomStopsAnimation;
  47031. private _framingTime;
  47032. /**
  47033. * The easing function used by animations
  47034. */
  47035. static EasingFunction: ExponentialEase;
  47036. /**
  47037. * The easing mode used by animations
  47038. */
  47039. static EasingMode: number;
  47040. /**
  47041. * Sets the current mode used by the behavior
  47042. */
  47043. set mode(mode: number);
  47044. /**
  47045. * Gets current mode used by the behavior.
  47046. */
  47047. get mode(): number;
  47048. /**
  47049. * Sets the scale applied to the radius (1 by default)
  47050. */
  47051. set radiusScale(radius: number);
  47052. /**
  47053. * Gets the scale applied to the radius
  47054. */
  47055. get radiusScale(): number;
  47056. /**
  47057. * Sets the scale to apply on Y axis to position camera focus. 0.5 by default which means the center of the bounding box.
  47058. */
  47059. set positionScale(scale: number);
  47060. /**
  47061. * Gets the scale to apply on Y axis to position camera focus. 0.5 by default which means the center of the bounding box.
  47062. */
  47063. get positionScale(): number;
  47064. /**
  47065. * Sets the angle above/below the horizontal plane to return to when the return to default elevation idle
  47066. * behaviour is triggered, in radians.
  47067. */
  47068. set defaultElevation(elevation: number);
  47069. /**
  47070. * Gets the angle above/below the horizontal plane to return to when the return to default elevation idle
  47071. * behaviour is triggered, in radians.
  47072. */
  47073. get defaultElevation(): number;
  47074. /**
  47075. * Sets the time (in milliseconds) taken to return to the default beta position.
  47076. * Negative value indicates camera should not return to default.
  47077. */
  47078. set elevationReturnTime(speed: number);
  47079. /**
  47080. * Gets the time (in milliseconds) taken to return to the default beta position.
  47081. * Negative value indicates camera should not return to default.
  47082. */
  47083. get elevationReturnTime(): number;
  47084. /**
  47085. * Sets the delay (in milliseconds) taken before the camera returns to the default beta position.
  47086. */
  47087. set elevationReturnWaitTime(time: number);
  47088. /**
  47089. * Gets the delay (in milliseconds) taken before the camera returns to the default beta position.
  47090. */
  47091. get elevationReturnWaitTime(): number;
  47092. /**
  47093. * Sets the flag that indicates if user zooming should stop animation.
  47094. */
  47095. set zoomStopsAnimation(flag: boolean);
  47096. /**
  47097. * Gets the flag that indicates if user zooming should stop animation.
  47098. */
  47099. get zoomStopsAnimation(): boolean;
  47100. /**
  47101. * Sets the transition time when framing the mesh, in milliseconds
  47102. */
  47103. set framingTime(time: number);
  47104. /**
  47105. * Gets the transition time when framing the mesh, in milliseconds
  47106. */
  47107. get framingTime(): number;
  47108. /**
  47109. * Define if the behavior should automatically change the configured
  47110. * camera limits and sensibilities.
  47111. */
  47112. autoCorrectCameraLimitsAndSensibility: boolean;
  47113. private _onPrePointerObservableObserver;
  47114. private _onAfterCheckInputsObserver;
  47115. private _onMeshTargetChangedObserver;
  47116. private _attachedCamera;
  47117. private _isPointerDown;
  47118. private _lastInteractionTime;
  47119. /**
  47120. * Initializes the behavior.
  47121. */
  47122. init(): void;
  47123. /**
  47124. * Attaches the behavior to its arc rotate camera.
  47125. * @param camera Defines the camera to attach the behavior to
  47126. */
  47127. attach(camera: ArcRotateCamera): void;
  47128. /**
  47129. * Detaches the behavior from its current arc rotate camera.
  47130. */
  47131. detach(): void;
  47132. private _animatables;
  47133. private _betaIsAnimating;
  47134. private _betaTransition;
  47135. private _radiusTransition;
  47136. private _vectorTransition;
  47137. /**
  47138. * Targets the given mesh and updates zoom level accordingly.
  47139. * @param mesh The mesh to target.
  47140. * @param focusOnOriginXZ Determines if the camera should focus on 0 in the X and Z axis instead of the mesh
  47141. * @param onAnimationEnd Callback triggered at the end of the framing animation
  47142. */
  47143. zoomOnMesh(mesh: AbstractMesh, focusOnOriginXZ?: boolean, onAnimationEnd?: Nullable<() => void>): void;
  47144. /**
  47145. * Targets the given mesh with its children and updates zoom level accordingly.
  47146. * @param mesh The mesh to target.
  47147. * @param focusOnOriginXZ Determines if the camera should focus on 0 in the X and Z axis instead of the mesh
  47148. * @param onAnimationEnd Callback triggered at the end of the framing animation
  47149. */
  47150. zoomOnMeshHierarchy(mesh: AbstractMesh, focusOnOriginXZ?: boolean, onAnimationEnd?: Nullable<() => void>): void;
  47151. /**
  47152. * Targets the given meshes with their children and updates zoom level accordingly.
  47153. * @param meshes The mesh to target.
  47154. * @param focusOnOriginXZ Determines if the camera should focus on 0 in the X and Z axis instead of the mesh
  47155. * @param onAnimationEnd Callback triggered at the end of the framing animation
  47156. */
  47157. zoomOnMeshesHierarchy(meshes: AbstractMesh[], focusOnOriginXZ?: boolean, onAnimationEnd?: Nullable<() => void>): void;
  47158. /**
  47159. * Targets the bounding box info defined by its extends and updates zoom level accordingly.
  47160. * @param minimumWorld Determines the smaller position of the bounding box extend
  47161. * @param maximumWorld Determines the bigger position of the bounding box extend
  47162. * @param focusOnOriginXZ Determines if the camera should focus on 0 in the X and Z axis instead of the mesh
  47163. * @param onAnimationEnd Callback triggered at the end of the framing animation
  47164. */
  47165. zoomOnBoundingInfo(minimumWorld: Vector3, maximumWorld: Vector3, focusOnOriginXZ?: boolean, onAnimationEnd?: Nullable<() => void>): void;
  47166. /**
  47167. * Calculates the lowest radius for the camera based on the bounding box of the mesh.
  47168. * @param mesh The mesh on which to base the calculation. mesh boundingInfo used to estimate necessary
  47169. * frustum width.
  47170. * @return The minimum distance from the primary mesh's center point at which the camera must be kept in order
  47171. * to fully enclose the mesh in the viewing frustum.
  47172. */
  47173. protected _calculateLowerRadiusFromModelBoundingSphere(minimumWorld: Vector3, maximumWorld: Vector3): number;
  47174. /**
  47175. * Keeps the camera above the ground plane. If the user pulls the camera below the ground plane, the camera
  47176. * is automatically returned to its default position (expected to be above ground plane).
  47177. */
  47178. private _maintainCameraAboveGround;
  47179. /**
  47180. * Returns the frustum slope based on the canvas ratio and camera FOV
  47181. * @returns The frustum slope represented as a Vector2 with X and Y slopes
  47182. */
  47183. private _getFrustumSlope;
  47184. /**
  47185. * Removes all animation locks. Allows new animations to be added to any of the arcCamera properties.
  47186. */
  47187. private _clearAnimationLocks;
  47188. /**
  47189. * Applies any current user interaction to the camera. Takes into account maximum alpha rotation.
  47190. */
  47191. private _applyUserInteraction;
  47192. /**
  47193. * Stops and removes all animations that have been applied to the camera
  47194. */
  47195. stopAllAnimations(): void;
  47196. /**
  47197. * Gets a value indicating if the user is moving the camera
  47198. */
  47199. get isUserIsMoving(): boolean;
  47200. /**
  47201. * The camera can move all the way towards the mesh.
  47202. */
  47203. static IgnoreBoundsSizeMode: number;
  47204. /**
  47205. * The camera is not allowed to zoom closer to the mesh than the point at which the adjusted bounding sphere touches the frustum sides
  47206. */
  47207. static FitFrustumSidesMode: number;
  47208. }
  47209. }
  47210. declare module "babylonjs/Cameras/Inputs/BaseCameraPointersInput" {
  47211. import { Nullable } from "babylonjs/types";
  47212. import { Camera } from "babylonjs/Cameras/camera";
  47213. import { ICameraInput } from "babylonjs/Cameras/cameraInputsManager";
  47214. import { PointerTouch } from "babylonjs/Events/pointerEvents";
  47215. /**
  47216. * Base class for Camera Pointer Inputs.
  47217. * See FollowCameraPointersInput in src/Cameras/Inputs/followCameraPointersInput.ts
  47218. * for example usage.
  47219. */
  47220. export abstract class BaseCameraPointersInput implements ICameraInput<Camera> {
  47221. /**
  47222. * Defines the camera the input is attached to.
  47223. */
  47224. abstract camera: Camera;
  47225. /**
  47226. * Whether keyboard modifier keys are pressed at time of last mouse event.
  47227. */
  47228. protected _altKey: boolean;
  47229. protected _ctrlKey: boolean;
  47230. protected _metaKey: boolean;
  47231. protected _shiftKey: boolean;
  47232. /**
  47233. * Which mouse buttons were pressed at time of last mouse event.
  47234. * https://developer.mozilla.org/en-US/docs/Web/API/MouseEvent/buttons
  47235. */
  47236. protected _buttonsPressed: number;
  47237. /**
  47238. * Defines the buttons associated with the input to handle camera move.
  47239. */
  47240. buttons: number[];
  47241. /**
  47242. * Attach the input controls to a specific dom element to get the input from.
  47243. * @param element Defines the element the controls should be listened from
  47244. * @param noPreventDefault Defines whether event caught by the controls should call preventdefault() (https://developer.mozilla.org/en-US/docs/Web/API/Event/preventDefault)
  47245. */
  47246. attachControl(element: HTMLElement, noPreventDefault?: boolean): void;
  47247. /**
  47248. * Detach the current controls from the specified dom element.
  47249. * @param element Defines the element to stop listening the inputs from
  47250. */
  47251. detachControl(element: Nullable<HTMLElement>): void;
  47252. /**
  47253. * Gets the class name of the current input.
  47254. * @returns the class name
  47255. */
  47256. getClassName(): string;
  47257. /**
  47258. * Get the friendly name associated with the input class.
  47259. * @returns the input friendly name
  47260. */
  47261. getSimpleName(): string;
  47262. /**
  47263. * Called on pointer POINTERDOUBLETAP event.
  47264. * Override this method to provide functionality on POINTERDOUBLETAP event.
  47265. */
  47266. protected onDoubleTap(type: string): void;
  47267. /**
  47268. * Called on pointer POINTERMOVE event if only a single touch is active.
  47269. * Override this method to provide functionality.
  47270. */
  47271. protected onTouch(point: Nullable<PointerTouch>, offsetX: number, offsetY: number): void;
  47272. /**
  47273. * Called on pointer POINTERMOVE event if multiple touches are active.
  47274. * Override this method to provide functionality.
  47275. */
  47276. protected onMultiTouch(pointA: Nullable<PointerTouch>, pointB: Nullable<PointerTouch>, previousPinchSquaredDistance: number, pinchSquaredDistance: number, previousMultiTouchPanPosition: Nullable<PointerTouch>, multiTouchPanPosition: Nullable<PointerTouch>): void;
  47277. /**
  47278. * Called on JS contextmenu event.
  47279. * Override this method to provide functionality.
  47280. */
  47281. protected onContextMenu(evt: PointerEvent): void;
  47282. /**
  47283. * Called each time a new POINTERDOWN event occurs. Ie, for each button
  47284. * press.
  47285. * Override this method to provide functionality.
  47286. */
  47287. protected onButtonDown(evt: PointerEvent): void;
  47288. /**
  47289. * Called each time a new POINTERUP event occurs. Ie, for each button
  47290. * release.
  47291. * Override this method to provide functionality.
  47292. */
  47293. protected onButtonUp(evt: PointerEvent): void;
  47294. /**
  47295. * Called when window becomes inactive.
  47296. * Override this method to provide functionality.
  47297. */
  47298. protected onLostFocus(): void;
  47299. private _pointerInput;
  47300. private _observer;
  47301. private _onLostFocus;
  47302. private pointA;
  47303. private pointB;
  47304. }
  47305. }
  47306. declare module "babylonjs/Cameras/Inputs/arcRotateCameraPointersInput" {
  47307. import { Nullable } from "babylonjs/types";
  47308. import { ArcRotateCamera } from "babylonjs/Cameras/arcRotateCamera";
  47309. import { BaseCameraPointersInput } from "babylonjs/Cameras/Inputs/BaseCameraPointersInput";
  47310. import { PointerTouch } from "babylonjs/Events/pointerEvents";
  47311. /**
  47312. * Manage the pointers inputs to control an arc rotate camera.
  47313. * @see https://doc.babylonjs.com/how_to/customizing_camera_inputs
  47314. */
  47315. export class ArcRotateCameraPointersInput extends BaseCameraPointersInput {
  47316. /**
  47317. * Defines the camera the input is attached to.
  47318. */
  47319. camera: ArcRotateCamera;
  47320. /**
  47321. * Gets the class name of the current input.
  47322. * @returns the class name
  47323. */
  47324. getClassName(): string;
  47325. /**
  47326. * Defines the buttons associated with the input to handle camera move.
  47327. */
  47328. buttons: number[];
  47329. /**
  47330. * Defines the pointer angular sensibility along the X axis or how fast is
  47331. * the camera rotating.
  47332. */
  47333. angularSensibilityX: number;
  47334. /**
  47335. * Defines the pointer angular sensibility along the Y axis or how fast is
  47336. * the camera rotating.
  47337. */
  47338. angularSensibilityY: number;
  47339. /**
  47340. * Defines the pointer pinch precision or how fast is the camera zooming.
  47341. */
  47342. pinchPrecision: number;
  47343. /**
  47344. * pinchDeltaPercentage will be used instead of pinchPrecision if different
  47345. * from 0.
  47346. * It defines the percentage of current camera.radius to use as delta when
  47347. * pinch zoom is used.
  47348. */
  47349. pinchDeltaPercentage: number;
  47350. /**
  47351. * When useNaturalPinchZoom is true, multi touch zoom will zoom in such
  47352. * that any object in the plane at the camera's target point will scale
  47353. * perfectly with finger motion.
  47354. * Overrides pinchDeltaPercentage and pinchPrecision.
  47355. */
  47356. useNaturalPinchZoom: boolean;
  47357. /**
  47358. * Defines the pointer panning sensibility or how fast is the camera moving.
  47359. */
  47360. panningSensibility: number;
  47361. /**
  47362. * Defines whether panning (2 fingers swipe) is enabled through multitouch.
  47363. */
  47364. multiTouchPanning: boolean;
  47365. /**
  47366. * Defines whether panning is enabled for both pan (2 fingers swipe) and
  47367. * zoom (pinch) through multitouch.
  47368. */
  47369. multiTouchPanAndZoom: boolean;
  47370. /**
  47371. * Revers pinch action direction.
  47372. */
  47373. pinchInwards: boolean;
  47374. private _isPanClick;
  47375. private _twoFingerActivityCount;
  47376. private _isPinching;
  47377. /**
  47378. * Called on pointer POINTERMOVE event if only a single touch is active.
  47379. */
  47380. protected onTouch(point: Nullable<PointerTouch>, offsetX: number, offsetY: number): void;
  47381. /**
  47382. * Called on pointer POINTERDOUBLETAP event.
  47383. */
  47384. protected onDoubleTap(type: string): void;
  47385. /**
  47386. * Called on pointer POINTERMOVE event if multiple touches are active.
  47387. */
  47388. protected onMultiTouch(pointA: Nullable<PointerTouch>, pointB: Nullable<PointerTouch>, previousPinchSquaredDistance: number, pinchSquaredDistance: number, previousMultiTouchPanPosition: Nullable<PointerTouch>, multiTouchPanPosition: Nullable<PointerTouch>): void;
  47389. /**
  47390. * Called each time a new POINTERDOWN event occurs. Ie, for each button
  47391. * press.
  47392. */
  47393. protected onButtonDown(evt: PointerEvent): void;
  47394. /**
  47395. * Called each time a new POINTERUP event occurs. Ie, for each button
  47396. * release.
  47397. */
  47398. protected onButtonUp(evt: PointerEvent): void;
  47399. /**
  47400. * Called when window becomes inactive.
  47401. */
  47402. protected onLostFocus(): void;
  47403. }
  47404. }
  47405. declare module "babylonjs/Cameras/Inputs/arcRotateCameraKeyboardMoveInput" {
  47406. import { Nullable } from "babylonjs/types";
  47407. import { ArcRotateCamera } from "babylonjs/Cameras/arcRotateCamera";
  47408. import { ICameraInput } from "babylonjs/Cameras/cameraInputsManager";
  47409. /**
  47410. * Manage the keyboard inputs to control the movement of an arc rotate camera.
  47411. * @see https://doc.babylonjs.com/how_to/customizing_camera_inputs
  47412. */
  47413. export class ArcRotateCameraKeyboardMoveInput implements ICameraInput<ArcRotateCamera> {
  47414. /**
  47415. * Defines the camera the input is attached to.
  47416. */
  47417. camera: ArcRotateCamera;
  47418. /**
  47419. * Defines the list of key codes associated with the up action (increase alpha)
  47420. */
  47421. keysUp: number[];
  47422. /**
  47423. * Defines the list of key codes associated with the down action (decrease alpha)
  47424. */
  47425. keysDown: number[];
  47426. /**
  47427. * Defines the list of key codes associated with the left action (increase beta)
  47428. */
  47429. keysLeft: number[];
  47430. /**
  47431. * Defines the list of key codes associated with the right action (decrease beta)
  47432. */
  47433. keysRight: number[];
  47434. /**
  47435. * Defines the list of key codes associated with the reset action.
  47436. * Those keys reset the camera to its last stored state (with the method camera.storeState())
  47437. */
  47438. keysReset: number[];
  47439. /**
  47440. * Defines the panning sensibility of the inputs.
  47441. * (How fast is the camera panning)
  47442. */
  47443. panningSensibility: number;
  47444. /**
  47445. * Defines the zooming sensibility of the inputs.
  47446. * (How fast is the camera zooming)
  47447. */
  47448. zoomingSensibility: number;
  47449. /**
  47450. * Defines whether maintaining the alt key down switch the movement mode from
  47451. * orientation to zoom.
  47452. */
  47453. useAltToZoom: boolean;
  47454. /**
  47455. * Rotation speed of the camera
  47456. */
  47457. angularSpeed: number;
  47458. private _keys;
  47459. private _ctrlPressed;
  47460. private _altPressed;
  47461. private _onCanvasBlurObserver;
  47462. private _onKeyboardObserver;
  47463. private _engine;
  47464. private _scene;
  47465. /**
  47466. * Attach the input controls to a specific dom element to get the input from.
  47467. * @param element Defines the element the controls should be listened from
  47468. * @param noPreventDefault Defines whether event caught by the controls should call preventdefault() (https://developer.mozilla.org/en-US/docs/Web/API/Event/preventDefault)
  47469. */
  47470. attachControl(element: HTMLElement, noPreventDefault?: boolean): void;
  47471. /**
  47472. * Detach the current controls from the specified dom element.
  47473. * @param element Defines the element to stop listening the inputs from
  47474. */
  47475. detachControl(element: Nullable<HTMLElement>): void;
  47476. /**
  47477. * Update the current camera state depending on the inputs that have been used this frame.
  47478. * This is a dynamically created lambda to avoid the performance penalty of looping for inputs in the render loop.
  47479. */
  47480. checkInputs(): void;
  47481. /**
  47482. * Gets the class name of the current intput.
  47483. * @returns the class name
  47484. */
  47485. getClassName(): string;
  47486. /**
  47487. * Get the friendly name associated with the input class.
  47488. * @returns the input friendly name
  47489. */
  47490. getSimpleName(): string;
  47491. }
  47492. }
  47493. declare module "babylonjs/Cameras/Inputs/arcRotateCameraMouseWheelInput" {
  47494. import { Nullable } from "babylonjs/types";
  47495. import { ArcRotateCamera } from "babylonjs/Cameras/arcRotateCamera";
  47496. import { ICameraInput } from "babylonjs/Cameras/cameraInputsManager";
  47497. /**
  47498. * Manage the mouse wheel inputs to control an arc rotate camera.
  47499. * @see https://doc.babylonjs.com/how_to/customizing_camera_inputs
  47500. */
  47501. export class ArcRotateCameraMouseWheelInput implements ICameraInput<ArcRotateCamera> {
  47502. /**
  47503. * Defines the camera the input is attached to.
  47504. */
  47505. camera: ArcRotateCamera;
  47506. /**
  47507. * Gets or Set the mouse wheel precision or how fast is the camera zooming.
  47508. */
  47509. wheelPrecision: number;
  47510. /**
  47511. * wheelDeltaPercentage will be used instead of wheelPrecision if different from 0.
  47512. * It defines the percentage of current camera.radius to use as delta when wheel is used.
  47513. */
  47514. wheelDeltaPercentage: number;
  47515. private _wheel;
  47516. private _observer;
  47517. private computeDeltaFromMouseWheelLegacyEvent;
  47518. /**
  47519. * Attach the input controls to a specific dom element to get the input from.
  47520. * @param element Defines the element the controls should be listened from
  47521. * @param noPreventDefault Defines whether event caught by the controls should call preventdefault() (https://developer.mozilla.org/en-US/docs/Web/API/Event/preventDefault)
  47522. */
  47523. attachControl(element: HTMLElement, noPreventDefault?: boolean): void;
  47524. /**
  47525. * Detach the current controls from the specified dom element.
  47526. * @param element Defines the element to stop listening the inputs from
  47527. */
  47528. detachControl(element: Nullable<HTMLElement>): void;
  47529. /**
  47530. * Gets the class name of the current intput.
  47531. * @returns the class name
  47532. */
  47533. getClassName(): string;
  47534. /**
  47535. * Get the friendly name associated with the input class.
  47536. * @returns the input friendly name
  47537. */
  47538. getSimpleName(): string;
  47539. }
  47540. }
  47541. declare module "babylonjs/Cameras/arcRotateCameraInputsManager" {
  47542. import { ArcRotateCamera } from "babylonjs/Cameras/arcRotateCamera";
  47543. import { CameraInputsManager } from "babylonjs/Cameras/cameraInputsManager";
  47544. /**
  47545. * Default Inputs manager for the ArcRotateCamera.
  47546. * It groups all the default supported inputs for ease of use.
  47547. * @see https://doc.babylonjs.com/how_to/customizing_camera_inputs
  47548. */
  47549. export class ArcRotateCameraInputsManager extends CameraInputsManager<ArcRotateCamera> {
  47550. /**
  47551. * Instantiates a new ArcRotateCameraInputsManager.
  47552. * @param camera Defines the camera the inputs belong to
  47553. */
  47554. constructor(camera: ArcRotateCamera);
  47555. /**
  47556. * Add mouse wheel input support to the input manager.
  47557. * @returns the current input manager
  47558. */
  47559. addMouseWheel(): ArcRotateCameraInputsManager;
  47560. /**
  47561. * Add pointers input support to the input manager.
  47562. * @returns the current input manager
  47563. */
  47564. addPointers(): ArcRotateCameraInputsManager;
  47565. /**
  47566. * Add keyboard input support to the input manager.
  47567. * @returns the current input manager
  47568. */
  47569. addKeyboard(): ArcRotateCameraInputsManager;
  47570. }
  47571. }
  47572. declare module "babylonjs/Cameras/arcRotateCamera" {
  47573. import { Observable } from "babylonjs/Misc/observable";
  47574. import { Nullable } from "babylonjs/types";
  47575. import { Scene } from "babylonjs/scene";
  47576. import { Matrix, Vector3, Vector2 } from "babylonjs/Maths/math.vector";
  47577. import { AbstractMesh } from "babylonjs/Meshes/abstractMesh";
  47578. import { AutoRotationBehavior } from "babylonjs/Behaviors/Cameras/autoRotationBehavior";
  47579. import { BouncingBehavior } from "babylonjs/Behaviors/Cameras/bouncingBehavior";
  47580. import { FramingBehavior } from "babylonjs/Behaviors/Cameras/framingBehavior";
  47581. import { Camera } from "babylonjs/Cameras/camera";
  47582. import { TargetCamera } from "babylonjs/Cameras/targetCamera";
  47583. import { ArcRotateCameraInputsManager } from "babylonjs/Cameras/arcRotateCameraInputsManager";
  47584. import { Collider } from "babylonjs/Collisions/collider";
  47585. /**
  47586. * This represents an orbital type of camera.
  47587. *
  47588. * 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.
  47589. * 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.
  47590. * @see https://doc.babylonjs.com/babylon101/cameras#arc-rotate-camera
  47591. */
  47592. export class ArcRotateCamera extends TargetCamera {
  47593. /**
  47594. * Defines the rotation angle of the camera along the longitudinal axis.
  47595. */
  47596. alpha: number;
  47597. /**
  47598. * Defines the rotation angle of the camera along the latitudinal axis.
  47599. */
  47600. beta: number;
  47601. /**
  47602. * Defines the radius of the camera from it s target point.
  47603. */
  47604. radius: number;
  47605. protected _target: Vector3;
  47606. protected _targetHost: Nullable<AbstractMesh>;
  47607. /**
  47608. * Defines the target point of the camera.
  47609. * The camera looks towards it form the radius distance.
  47610. * Please note that you can set the target to a mesh and thus the target will be copied from mesh.position
  47611. */
  47612. get target(): Vector3;
  47613. set target(value: Vector3);
  47614. /**
  47615. * Define the current local position of the camera in the scene
  47616. */
  47617. get position(): Vector3;
  47618. set position(newPosition: Vector3);
  47619. protected _upToYMatrix: Matrix;
  47620. protected _YToUpMatrix: Matrix;
  47621. /**
  47622. * The vector the camera should consider as up. (default is Vector3(0, 1, 0) as returned by Vector3.Up())
  47623. * Setting this will copy the given vector to the camera's upVector, and set rotation matrices to and from Y up.
  47624. * DO NOT set the up vector using copyFrom or copyFromFloats, as this bypasses setting the above matrices.
  47625. */
  47626. set upVector(vec: Vector3);
  47627. get upVector(): Vector3;
  47628. /**
  47629. * Sets the Y-up to camera up-vector rotation matrix, and the up-vector to Y-up rotation matrix.
  47630. */
  47631. setMatUp(): void;
  47632. /**
  47633. * Current inertia value on the longitudinal axis.
  47634. * The bigger this number the longer it will take for the camera to stop.
  47635. */
  47636. inertialAlphaOffset: number;
  47637. /**
  47638. * Current inertia value on the latitudinal axis.
  47639. * The bigger this number the longer it will take for the camera to stop.
  47640. */
  47641. inertialBetaOffset: number;
  47642. /**
  47643. * Current inertia value on the radius axis.
  47644. * The bigger this number the longer it will take for the camera to stop.
  47645. */
  47646. inertialRadiusOffset: number;
  47647. /**
  47648. * Minimum allowed angle on the longitudinal axis.
  47649. * This can help limiting how the Camera is able to move in the scene.
  47650. */
  47651. lowerAlphaLimit: Nullable<number>;
  47652. /**
  47653. * Maximum allowed angle on the longitudinal axis.
  47654. * This can help limiting how the Camera is able to move in the scene.
  47655. */
  47656. upperAlphaLimit: Nullable<number>;
  47657. /**
  47658. * Minimum allowed angle on the latitudinal axis.
  47659. * This can help limiting how the Camera is able to move in the scene.
  47660. */
  47661. lowerBetaLimit: number;
  47662. /**
  47663. * Maximum allowed angle on the latitudinal axis.
  47664. * This can help limiting how the Camera is able to move in the scene.
  47665. */
  47666. upperBetaLimit: number;
  47667. /**
  47668. * Minimum allowed distance of the camera to the target (The camera can not get closer).
  47669. * This can help limiting how the Camera is able to move in the scene.
  47670. */
  47671. lowerRadiusLimit: Nullable<number>;
  47672. /**
  47673. * Maximum allowed distance of the camera to the target (The camera can not get further).
  47674. * This can help limiting how the Camera is able to move in the scene.
  47675. */
  47676. upperRadiusLimit: Nullable<number>;
  47677. /**
  47678. * Defines the current inertia value used during panning of the camera along the X axis.
  47679. */
  47680. inertialPanningX: number;
  47681. /**
  47682. * Defines the current inertia value used during panning of the camera along the Y axis.
  47683. */
  47684. inertialPanningY: number;
  47685. /**
  47686. * Defines the distance used to consider the camera in pan mode vs pinch/zoom.
  47687. * Basically if your fingers moves away from more than this distance you will be considered
  47688. * in pinch mode.
  47689. */
  47690. pinchToPanMaxDistance: number;
  47691. /**
  47692. * Defines the maximum distance the camera can pan.
  47693. * This could help keeping the cammera always in your scene.
  47694. */
  47695. panningDistanceLimit: Nullable<number>;
  47696. /**
  47697. * Defines the target of the camera before paning.
  47698. */
  47699. panningOriginTarget: Vector3;
  47700. /**
  47701. * Defines the value of the inertia used during panning.
  47702. * 0 would mean stop inertia and one would mean no decelleration at all.
  47703. */
  47704. panningInertia: number;
  47705. /**
  47706. * Gets or Set the pointer angular sensibility along the X axis or how fast is the camera rotating.
  47707. */
  47708. get angularSensibilityX(): number;
  47709. set angularSensibilityX(value: number);
  47710. /**
  47711. * Gets or Set the pointer angular sensibility along the Y axis or how fast is the camera rotating.
  47712. */
  47713. get angularSensibilityY(): number;
  47714. set angularSensibilityY(value: number);
  47715. /**
  47716. * Gets or Set the pointer pinch precision or how fast is the camera zooming.
  47717. */
  47718. get pinchPrecision(): number;
  47719. set pinchPrecision(value: number);
  47720. /**
  47721. * Gets or Set the pointer pinch delta percentage or how fast is the camera zooming.
  47722. * It will be used instead of pinchDeltaPrecision if different from 0.
  47723. * It defines the percentage of current camera.radius to use as delta when pinch zoom is used.
  47724. */
  47725. get pinchDeltaPercentage(): number;
  47726. set pinchDeltaPercentage(value: number);
  47727. /**
  47728. * Gets or Set the pointer use natural pinch zoom to override the pinch precision
  47729. * and pinch delta percentage.
  47730. * When useNaturalPinchZoom is true, multi touch zoom will zoom in such
  47731. * that any object in the plane at the camera's target point will scale
  47732. * perfectly with finger motion.
  47733. */
  47734. get useNaturalPinchZoom(): boolean;
  47735. set useNaturalPinchZoom(value: boolean);
  47736. /**
  47737. * Gets or Set the pointer panning sensibility or how fast is the camera moving.
  47738. */
  47739. get panningSensibility(): number;
  47740. set panningSensibility(value: number);
  47741. /**
  47742. * Gets or Set the list of keyboard keys used to control beta angle in a positive direction.
  47743. */
  47744. get keysUp(): number[];
  47745. set keysUp(value: number[]);
  47746. /**
  47747. * Gets or Set the list of keyboard keys used to control beta angle in a negative direction.
  47748. */
  47749. get keysDown(): number[];
  47750. set keysDown(value: number[]);
  47751. /**
  47752. * Gets or Set the list of keyboard keys used to control alpha angle in a negative direction.
  47753. */
  47754. get keysLeft(): number[];
  47755. set keysLeft(value: number[]);
  47756. /**
  47757. * Gets or Set the list of keyboard keys used to control alpha angle in a positive direction.
  47758. */
  47759. get keysRight(): number[];
  47760. set keysRight(value: number[]);
  47761. /**
  47762. * Gets or Set the mouse wheel precision or how fast is the camera zooming.
  47763. */
  47764. get wheelPrecision(): number;
  47765. set wheelPrecision(value: number);
  47766. /**
  47767. * Gets or Set the mouse wheel delta percentage or how fast is the camera zooming.
  47768. * It will be used instead of pinchDeltaPrecision if different from 0.
  47769. * It defines the percentage of current camera.radius to use as delta when pinch zoom is used.
  47770. */
  47771. get wheelDeltaPercentage(): number;
  47772. set wheelDeltaPercentage(value: number);
  47773. /**
  47774. * Defines how much the radius should be scaled while zomming on a particular mesh (through the zoomOn function)
  47775. */
  47776. zoomOnFactor: number;
  47777. /**
  47778. * Defines a screen offset for the camera position.
  47779. */
  47780. targetScreenOffset: Vector2;
  47781. /**
  47782. * Allows the camera to be completely reversed.
  47783. * If false the camera can not arrive upside down.
  47784. */
  47785. allowUpsideDown: boolean;
  47786. /**
  47787. * Define if double tap/click is used to restore the previously saved state of the camera.
  47788. */
  47789. useInputToRestoreState: boolean;
  47790. /** @hidden */
  47791. _viewMatrix: Matrix;
  47792. /** @hidden */
  47793. _useCtrlForPanning: boolean;
  47794. /** @hidden */
  47795. _panningMouseButton: number;
  47796. /**
  47797. * Defines the input associated to the camera.
  47798. */
  47799. inputs: ArcRotateCameraInputsManager;
  47800. /** @hidden */
  47801. _reset: () => void;
  47802. /**
  47803. * Defines the allowed panning axis.
  47804. */
  47805. panningAxis: Vector3;
  47806. protected _localDirection: Vector3;
  47807. protected _transformedDirection: Vector3;
  47808. private _bouncingBehavior;
  47809. /**
  47810. * Gets the bouncing behavior of the camera if it has been enabled.
  47811. * @see https://doc.babylonjs.com/how_to/camera_behaviors#bouncing-behavior
  47812. */
  47813. get bouncingBehavior(): Nullable<BouncingBehavior>;
  47814. /**
  47815. * Defines if the bouncing behavior of the camera is enabled on the camera.
  47816. * @see https://doc.babylonjs.com/how_to/camera_behaviors#bouncing-behavior
  47817. */
  47818. get useBouncingBehavior(): boolean;
  47819. set useBouncingBehavior(value: boolean);
  47820. private _framingBehavior;
  47821. /**
  47822. * Gets the framing behavior of the camera if it has been enabled.
  47823. * @see https://doc.babylonjs.com/how_to/camera_behaviors#framing-behavior
  47824. */
  47825. get framingBehavior(): Nullable<FramingBehavior>;
  47826. /**
  47827. * Defines if the framing behavior of the camera is enabled on the camera.
  47828. * @see https://doc.babylonjs.com/how_to/camera_behaviors#framing-behavior
  47829. */
  47830. get useFramingBehavior(): boolean;
  47831. set useFramingBehavior(value: boolean);
  47832. private _autoRotationBehavior;
  47833. /**
  47834. * Gets the auto rotation behavior of the camera if it has been enabled.
  47835. * @see https://doc.babylonjs.com/how_to/camera_behaviors#autorotation-behavior
  47836. */
  47837. get autoRotationBehavior(): Nullable<AutoRotationBehavior>;
  47838. /**
  47839. * Defines if the auto rotation behavior of the camera is enabled on the camera.
  47840. * @see https://doc.babylonjs.com/how_to/camera_behaviors#autorotation-behavior
  47841. */
  47842. get useAutoRotationBehavior(): boolean;
  47843. set useAutoRotationBehavior(value: boolean);
  47844. /**
  47845. * Observable triggered when the mesh target has been changed on the camera.
  47846. */
  47847. onMeshTargetChangedObservable: Observable<Nullable<AbstractMesh>>;
  47848. /**
  47849. * Event raised when the camera is colliding with a mesh.
  47850. */
  47851. onCollide: (collidedMesh: AbstractMesh) => void;
  47852. /**
  47853. * Defines whether the camera should check collision with the objects oh the scene.
  47854. * @see https://doc.babylonjs.com/babylon101/cameras,_mesh_collisions_and_gravity#how-can-i-do-this
  47855. */
  47856. checkCollisions: boolean;
  47857. /**
  47858. * Defines the collision radius of the camera.
  47859. * This simulates a sphere around the camera.
  47860. * @see https://doc.babylonjs.com/babylon101/cameras,_mesh_collisions_and_gravity#arcrotatecamera
  47861. */
  47862. collisionRadius: Vector3;
  47863. protected _collider: Collider;
  47864. protected _previousPosition: Vector3;
  47865. protected _collisionVelocity: Vector3;
  47866. protected _newPosition: Vector3;
  47867. protected _previousAlpha: number;
  47868. protected _previousBeta: number;
  47869. protected _previousRadius: number;
  47870. protected _collisionTriggered: boolean;
  47871. protected _targetBoundingCenter: Nullable<Vector3>;
  47872. private _computationVector;
  47873. /**
  47874. * Instantiates a new ArcRotateCamera in a given scene
  47875. * @param name Defines the name of the camera
  47876. * @param alpha Defines the camera rotation along the logitudinal axis
  47877. * @param beta Defines the camera rotation along the latitudinal axis
  47878. * @param radius Defines the camera distance from its target
  47879. * @param target Defines the camera target
  47880. * @param scene Defines the scene the camera belongs to
  47881. * @param setActiveOnSceneIfNoneActive Defines wheter the camera should be marked as active if not other active cameras have been defined
  47882. */
  47883. constructor(name: string, alpha: number, beta: number, radius: number, target: Vector3, scene: Scene, setActiveOnSceneIfNoneActive?: boolean);
  47884. /** @hidden */
  47885. _initCache(): void;
  47886. /** @hidden */
  47887. _updateCache(ignoreParentClass?: boolean): void;
  47888. protected _getTargetPosition(): Vector3;
  47889. private _storedAlpha;
  47890. private _storedBeta;
  47891. private _storedRadius;
  47892. private _storedTarget;
  47893. private _storedTargetScreenOffset;
  47894. /**
  47895. * Stores the current state of the camera (alpha, beta, radius and target)
  47896. * @returns the camera itself
  47897. */
  47898. storeState(): Camera;
  47899. /**
  47900. * @hidden
  47901. * Restored camera state. You must call storeState() first
  47902. */
  47903. _restoreStateValues(): boolean;
  47904. /** @hidden */
  47905. _isSynchronizedViewMatrix(): boolean;
  47906. /**
  47907. * Attached controls to the current camera.
  47908. * @param element Defines the element the controls should be listened from
  47909. * @param noPreventDefault Defines whether event caught by the controls should call preventdefault() (https://developer.mozilla.org/en-US/docs/Web/API/Event/preventDefault)
  47910. * @param useCtrlForPanning Defines whether ctrl is used for paning within the controls
  47911. * @param panningMouseButton Defines whether panning is allowed through mouse click button
  47912. */
  47913. attachControl(element: HTMLElement, noPreventDefault?: boolean, useCtrlForPanning?: boolean, panningMouseButton?: number): void;
  47914. /**
  47915. * Detach the current controls from the camera.
  47916. * The camera will stop reacting to inputs.
  47917. * @param element Defines the element to stop listening the inputs from
  47918. */
  47919. detachControl(element: HTMLElement): void;
  47920. /** @hidden */
  47921. _checkInputs(): void;
  47922. protected _checkLimits(): void;
  47923. /**
  47924. * Rebuilds angles (alpha, beta) and radius from the give position and target
  47925. */
  47926. rebuildAnglesAndRadius(): void;
  47927. /**
  47928. * Use a position to define the current camera related information like alpha, beta and radius
  47929. * @param position Defines the position to set the camera at
  47930. */
  47931. setPosition(position: Vector3): void;
  47932. /**
  47933. * Defines the target the camera should look at.
  47934. * This will automatically adapt alpha beta and radius to fit within the new target.
  47935. * @param target Defines the new target as a Vector or a mesh
  47936. * @param toBoundingCenter In case of a mesh target, defines whether to target the mesh position or its bounding information center
  47937. * @param allowSamePosition If false, prevents reapplying the new computed position if it is identical to the current one (optim)
  47938. */
  47939. setTarget(target: AbstractMesh | Vector3, toBoundingCenter?: boolean, allowSamePosition?: boolean): void;
  47940. /** @hidden */
  47941. _getViewMatrix(): Matrix;
  47942. protected _onCollisionPositionChange: (collisionId: number, newPosition: Vector3, collidedMesh?: Nullable<AbstractMesh>) => void;
  47943. /**
  47944. * Zooms on a mesh to be at the min distance where we could see it fully in the current viewport.
  47945. * @param meshes Defines the mesh to zoom on
  47946. * @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)
  47947. */
  47948. zoomOn(meshes?: AbstractMesh[], doNotUpdateMaxZ?: boolean): void;
  47949. /**
  47950. * Focus on a mesh or a bounding box. This adapts the target and maxRadius if necessary but does not update the current radius.
  47951. * The target will be changed but the radius
  47952. * @param meshesOrMinMaxVectorAndDistance Defines the mesh or bounding info to focus on
  47953. * @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)
  47954. */
  47955. focusOn(meshesOrMinMaxVectorAndDistance: AbstractMesh[] | {
  47956. min: Vector3;
  47957. max: Vector3;
  47958. distance: number;
  47959. }, doNotUpdateMaxZ?: boolean): void;
  47960. /**
  47961. * @override
  47962. * Override Camera.createRigCamera
  47963. */
  47964. createRigCamera(name: string, cameraIndex: number): Camera;
  47965. /**
  47966. * @hidden
  47967. * @override
  47968. * Override Camera._updateRigCameras
  47969. */
  47970. _updateRigCameras(): void;
  47971. /**
  47972. * Destroy the camera and release the current resources hold by it.
  47973. */
  47974. dispose(): void;
  47975. /**
  47976. * Gets the current object class name.
  47977. * @return the class name
  47978. */
  47979. getClassName(): string;
  47980. }
  47981. }
  47982. declare module "babylonjs/Behaviors/Cameras/autoRotationBehavior" {
  47983. import { Behavior } from "babylonjs/Behaviors/behavior";
  47984. import { ArcRotateCamera } from "babylonjs/Cameras/arcRotateCamera";
  47985. /**
  47986. * The autoRotation behavior (AutoRotationBehavior) is designed to create a smooth rotation of an ArcRotateCamera when there is no user interaction.
  47987. * @see https://doc.babylonjs.com/how_to/camera_behaviors#autorotation-behavior
  47988. */
  47989. export class AutoRotationBehavior implements Behavior<ArcRotateCamera> {
  47990. /**
  47991. * Gets the name of the behavior.
  47992. */
  47993. get name(): string;
  47994. private _zoomStopsAnimation;
  47995. private _idleRotationSpeed;
  47996. private _idleRotationWaitTime;
  47997. private _idleRotationSpinupTime;
  47998. /**
  47999. * Sets the flag that indicates if user zooming should stop animation.
  48000. */
  48001. set zoomStopsAnimation(flag: boolean);
  48002. /**
  48003. * Gets the flag that indicates if user zooming should stop animation.
  48004. */
  48005. get zoomStopsAnimation(): boolean;
  48006. /**
  48007. * Sets the default speed at which the camera rotates around the model.
  48008. */
  48009. set idleRotationSpeed(speed: number);
  48010. /**
  48011. * Gets the default speed at which the camera rotates around the model.
  48012. */
  48013. get idleRotationSpeed(): number;
  48014. /**
  48015. * Sets the time (in milliseconds) to wait after user interaction before the camera starts rotating.
  48016. */
  48017. set idleRotationWaitTime(time: number);
  48018. /**
  48019. * Gets the time (milliseconds) to wait after user interaction before the camera starts rotating.
  48020. */
  48021. get idleRotationWaitTime(): number;
  48022. /**
  48023. * Sets the time (milliseconds) to take to spin up to the full idle rotation speed.
  48024. */
  48025. set idleRotationSpinupTime(time: number);
  48026. /**
  48027. * Gets the time (milliseconds) to take to spin up to the full idle rotation speed.
  48028. */
  48029. get idleRotationSpinupTime(): number;
  48030. /**
  48031. * Gets a value indicating if the camera is currently rotating because of this behavior
  48032. */
  48033. get rotationInProgress(): boolean;
  48034. private _onPrePointerObservableObserver;
  48035. private _onAfterCheckInputsObserver;
  48036. private _attachedCamera;
  48037. private _isPointerDown;
  48038. private _lastFrameTime;
  48039. private _lastInteractionTime;
  48040. private _cameraRotationSpeed;
  48041. /**
  48042. * Initializes the behavior.
  48043. */
  48044. init(): void;
  48045. /**
  48046. * Attaches the behavior to its arc rotate camera.
  48047. * @param camera Defines the camera to attach the behavior to
  48048. */
  48049. attach(camera: ArcRotateCamera): void;
  48050. /**
  48051. * Detaches the behavior from its current arc rotate camera.
  48052. */
  48053. detach(): void;
  48054. /**
  48055. * Returns true if user is scrolling.
  48056. * @return true if user is scrolling.
  48057. */
  48058. private _userIsZooming;
  48059. private _lastFrameRadius;
  48060. private _shouldAnimationStopForInteraction;
  48061. /**
  48062. * Applies any current user interaction to the camera. Takes into account maximum alpha rotation.
  48063. */
  48064. private _applyUserInteraction;
  48065. private _userIsMoving;
  48066. }
  48067. }
  48068. declare module "babylonjs/Behaviors/Cameras/index" {
  48069. export * from "babylonjs/Behaviors/Cameras/autoRotationBehavior";
  48070. export * from "babylonjs/Behaviors/Cameras/bouncingBehavior";
  48071. export * from "babylonjs/Behaviors/Cameras/framingBehavior";
  48072. }
  48073. declare module "babylonjs/Behaviors/Meshes/attachToBoxBehavior" {
  48074. import { Mesh } from "babylonjs/Meshes/mesh";
  48075. import { TransformNode } from "babylonjs/Meshes/transformNode";
  48076. import { Behavior } from "babylonjs/Behaviors/behavior";
  48077. /**
  48078. * A behavior that when attached to a mesh will will place a specified node on the meshes face pointing towards the camera
  48079. */
  48080. export class AttachToBoxBehavior implements Behavior<Mesh> {
  48081. private ui;
  48082. /**
  48083. * The name of the behavior
  48084. */
  48085. name: string;
  48086. /**
  48087. * The distance away from the face of the mesh that the UI should be attached to (default: 0.15)
  48088. */
  48089. distanceAwayFromFace: number;
  48090. /**
  48091. * The distance from the bottom of the face that the UI should be attached to (default: 0.15)
  48092. */
  48093. distanceAwayFromBottomOfFace: number;
  48094. private _faceVectors;
  48095. private _target;
  48096. private _scene;
  48097. private _onRenderObserver;
  48098. private _tmpMatrix;
  48099. private _tmpVector;
  48100. /**
  48101. * Creates the AttachToBoxBehavior, used to attach UI to the closest face of the box to a camera
  48102. * @param ui The transform node that should be attched to the mesh
  48103. */
  48104. constructor(ui: TransformNode);
  48105. /**
  48106. * Initializes the behavior
  48107. */
  48108. init(): void;
  48109. private _closestFace;
  48110. private _zeroVector;
  48111. private _lookAtTmpMatrix;
  48112. private _lookAtToRef;
  48113. /**
  48114. * Attaches the AttachToBoxBehavior to the passed in mesh
  48115. * @param target The mesh that the specified node will be attached to
  48116. */
  48117. attach(target: Mesh): void;
  48118. /**
  48119. * Detaches the behavior from the mesh
  48120. */
  48121. detach(): void;
  48122. }
  48123. }
  48124. declare module "babylonjs/Behaviors/Meshes/fadeInOutBehavior" {
  48125. import { Behavior } from "babylonjs/Behaviors/behavior";
  48126. import { Mesh } from "babylonjs/Meshes/mesh";
  48127. /**
  48128. * A behavior that when attached to a mesh will allow the mesh to fade in and out
  48129. */
  48130. export class FadeInOutBehavior implements Behavior<Mesh> {
  48131. /**
  48132. * Time in milliseconds to delay before fading in (Default: 0)
  48133. */
  48134. delay: number;
  48135. /**
  48136. * Time in milliseconds for the mesh to fade in (Default: 300)
  48137. */
  48138. fadeInTime: number;
  48139. private _millisecondsPerFrame;
  48140. private _hovered;
  48141. private _hoverValue;
  48142. private _ownerNode;
  48143. /**
  48144. * Instatiates the FadeInOutBehavior
  48145. */
  48146. constructor();
  48147. /**
  48148. * The name of the behavior
  48149. */
  48150. get name(): string;
  48151. /**
  48152. * Initializes the behavior
  48153. */
  48154. init(): void;
  48155. /**
  48156. * Attaches the fade behavior on the passed in mesh
  48157. * @param ownerNode The mesh that will be faded in/out once attached
  48158. */
  48159. attach(ownerNode: Mesh): void;
  48160. /**
  48161. * Detaches the behavior from the mesh
  48162. */
  48163. detach(): void;
  48164. /**
  48165. * Triggers the mesh to begin fading in or out
  48166. * @param value if the object should fade in or out (true to fade in)
  48167. */
  48168. fadeIn(value: boolean): void;
  48169. private _update;
  48170. private _setAllVisibility;
  48171. }
  48172. }
  48173. declare module "babylonjs/Misc/pivotTools" {
  48174. import { AbstractMesh } from "babylonjs/Meshes/abstractMesh";
  48175. /**
  48176. * Class containing a set of static utilities functions for managing Pivots
  48177. * @hidden
  48178. */
  48179. export class PivotTools {
  48180. private static _PivotCached;
  48181. private static _OldPivotPoint;
  48182. private static _PivotTranslation;
  48183. private static _PivotTmpVector;
  48184. private static _PivotPostMultiplyPivotMatrix;
  48185. /** @hidden */
  48186. static _RemoveAndStorePivotPoint(mesh: AbstractMesh): void;
  48187. /** @hidden */
  48188. static _RestorePivotPoint(mesh: AbstractMesh): void;
  48189. }
  48190. }
  48191. declare module "babylonjs/Meshes/Builders/planeBuilder" {
  48192. import { Scene } from "babylonjs/scene";
  48193. import { Vector4 } from "babylonjs/Maths/math.vector";
  48194. import { Mesh } from "babylonjs/Meshes/mesh";
  48195. import { Nullable } from "babylonjs/types";
  48196. import { Plane } from "babylonjs/Maths/math.plane";
  48197. /**
  48198. * Class containing static functions to help procedurally build meshes
  48199. */
  48200. export class PlaneBuilder {
  48201. /**
  48202. * Creates a plane mesh
  48203. * * The parameter `size` sets the size (float) of both sides of the plane at once (default 1)
  48204. * * You can set some different plane dimensions by using the parameters `width` and `height` (both by default have the same value of `size`)
  48205. * * The parameter `sourcePlane` is a Plane instance. It builds a mesh plane from a Math plane
  48206. * * You can also set the mesh side orientation with the values : BABYLON.Mesh.FRONTSIDE (default), BABYLON.Mesh.BACKSIDE or BABYLON.Mesh.DOUBLESIDE
  48207. * * If you create a double-sided mesh, you can choose what parts of the texture image to crop and stick respectively on the front and the back sides with the parameters `frontUVs` and `backUVs` (Vector4). Detail here : https://doc.babylonjs.com/babylon101/discover_basic_elements#side-orientation
  48208. * * The mesh can be set to updatable with the boolean parameter `updatable` (default false) if its internal geometry is supposed to change once created
  48209. * @param name defines the name of the mesh
  48210. * @param options defines the options used to create the mesh
  48211. * @param scene defines the hosting scene
  48212. * @returns the plane mesh
  48213. * @see https://doc.babylonjs.com/how_to/set_shapes#plane
  48214. */
  48215. static CreatePlane(name: string, options: {
  48216. size?: number;
  48217. width?: number;
  48218. height?: number;
  48219. sideOrientation?: number;
  48220. frontUVs?: Vector4;
  48221. backUVs?: Vector4;
  48222. updatable?: boolean;
  48223. sourcePlane?: Plane;
  48224. }, scene?: Nullable<Scene>): Mesh;
  48225. }
  48226. }
  48227. declare module "babylonjs/Behaviors/Meshes/pointerDragBehavior" {
  48228. import { Behavior } from "babylonjs/Behaviors/behavior";
  48229. import { AbstractMesh } from "babylonjs/Meshes/abstractMesh";
  48230. import { Observable } from "babylonjs/Misc/observable";
  48231. import { Vector3 } from "babylonjs/Maths/math.vector";
  48232. import { Ray } from "babylonjs/Culling/ray";
  48233. import "babylonjs/Meshes/Builders/planeBuilder";
  48234. /**
  48235. * A behavior that when attached to a mesh will allow the mesh to be dragged around the screen based on pointer events
  48236. */
  48237. export class PointerDragBehavior implements Behavior<AbstractMesh> {
  48238. private static _AnyMouseID;
  48239. /**
  48240. * Abstract mesh the behavior is set on
  48241. */
  48242. attachedNode: AbstractMesh;
  48243. private _dragPlane;
  48244. private _scene;
  48245. private _pointerObserver;
  48246. private _beforeRenderObserver;
  48247. private static _planeScene;
  48248. private _useAlternatePickedPointAboveMaxDragAngleDragSpeed;
  48249. /**
  48250. * 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)
  48251. */
  48252. maxDragAngle: number;
  48253. /**
  48254. * @hidden
  48255. */
  48256. _useAlternatePickedPointAboveMaxDragAngle: boolean;
  48257. /**
  48258. * The id of the pointer that is currently interacting with the behavior (-1 when no pointer is active)
  48259. */
  48260. currentDraggingPointerID: number;
  48261. /**
  48262. * The last position where the pointer hit the drag plane in world space
  48263. */
  48264. lastDragPosition: Vector3;
  48265. /**
  48266. * If the behavior is currently in a dragging state
  48267. */
  48268. dragging: boolean;
  48269. /**
  48270. * 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)
  48271. */
  48272. dragDeltaRatio: number;
  48273. /**
  48274. * If the drag plane orientation should be updated during the dragging (Default: true)
  48275. */
  48276. updateDragPlane: boolean;
  48277. private _debugMode;
  48278. private _moving;
  48279. /**
  48280. * Fires each time the attached mesh is dragged with the pointer
  48281. * * delta between last drag position and current drag position in world space
  48282. * * dragDistance along the drag axis
  48283. * * dragPlaneNormal normal of the current drag plane used during the drag
  48284. * * dragPlanePoint in world space where the drag intersects the drag plane
  48285. */
  48286. onDragObservable: Observable<{
  48287. delta: Vector3;
  48288. dragPlanePoint: Vector3;
  48289. dragPlaneNormal: Vector3;
  48290. dragDistance: number;
  48291. pointerId: number;
  48292. }>;
  48293. /**
  48294. * Fires each time a drag begins (eg. mouse down on mesh)
  48295. */
  48296. onDragStartObservable: Observable<{
  48297. dragPlanePoint: Vector3;
  48298. pointerId: number;
  48299. }>;
  48300. /**
  48301. * Fires each time a drag ends (eg. mouse release after drag)
  48302. */
  48303. onDragEndObservable: Observable<{
  48304. dragPlanePoint: Vector3;
  48305. pointerId: number;
  48306. }>;
  48307. /**
  48308. * If the attached mesh should be moved when dragged
  48309. */
  48310. moveAttached: boolean;
  48311. /**
  48312. * If the drag behavior will react to drag events (Default: true)
  48313. */
  48314. enabled: boolean;
  48315. /**
  48316. * If pointer events should start and release the drag (Default: true)
  48317. */
  48318. startAndReleaseDragOnPointerEvents: boolean;
  48319. /**
  48320. * If camera controls should be detached during the drag
  48321. */
  48322. detachCameraControls: boolean;
  48323. /**
  48324. * If set, the drag plane/axis will be rotated based on the attached mesh's world rotation (Default: true)
  48325. */
  48326. useObjectOrientationForDragging: boolean;
  48327. private _options;
  48328. /**
  48329. * Gets the options used by the behavior
  48330. */
  48331. get options(): {
  48332. dragAxis?: Vector3;
  48333. dragPlaneNormal?: Vector3;
  48334. };
  48335. /**
  48336. * Sets the options used by the behavior
  48337. */
  48338. set options(options: {
  48339. dragAxis?: Vector3;
  48340. dragPlaneNormal?: Vector3;
  48341. });
  48342. /**
  48343. * Creates a pointer drag behavior that can be attached to a mesh
  48344. * @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)
  48345. */
  48346. constructor(options?: {
  48347. dragAxis?: Vector3;
  48348. dragPlaneNormal?: Vector3;
  48349. });
  48350. /**
  48351. * Predicate to determine if it is valid to move the object to a new position when it is moved
  48352. */
  48353. validateDrag: (targetPosition: Vector3) => boolean;
  48354. /**
  48355. * The name of the behavior
  48356. */
  48357. get name(): string;
  48358. /**
  48359. * Initializes the behavior
  48360. */
  48361. init(): void;
  48362. private _tmpVector;
  48363. private _alternatePickedPoint;
  48364. private _worldDragAxis;
  48365. private _targetPosition;
  48366. private _attachedElement;
  48367. /**
  48368. * Attaches the drag behavior the passed in mesh
  48369. * @param ownerNode The mesh that will be dragged around once attached
  48370. * @param predicate Predicate to use for pick filtering
  48371. */
  48372. attach(ownerNode: AbstractMesh, predicate?: (m: AbstractMesh) => boolean): void;
  48373. /**
  48374. * Force relase the drag action by code.
  48375. */
  48376. releaseDrag(): void;
  48377. private _startDragRay;
  48378. private _lastPointerRay;
  48379. /**
  48380. * Simulates the start of a pointer drag event on the behavior
  48381. * @param pointerId pointerID of the pointer that should be simulated (Default: Any mouse pointer ID)
  48382. * @param fromRay initial ray of the pointer to be simulated (Default: Ray from camera to attached mesh)
  48383. * @param startPickedPoint picked point of the pointer to be simulated (Default: attached mesh position)
  48384. */
  48385. startDrag(pointerId?: number, fromRay?: Ray, startPickedPoint?: Vector3): void;
  48386. protected _startDrag(pointerId: number, fromRay?: Ray, startPickedPoint?: Vector3): void;
  48387. private _dragDelta;
  48388. protected _moveDrag(ray: Ray): void;
  48389. private _pickWithRayOnDragPlane;
  48390. private _pointA;
  48391. private _pointC;
  48392. private _localAxis;
  48393. private _lookAt;
  48394. private _updateDragPlanePosition;
  48395. /**
  48396. * Detaches the behavior from the mesh
  48397. */
  48398. detach(): void;
  48399. }
  48400. }
  48401. declare module "babylonjs/Behaviors/Meshes/multiPointerScaleBehavior" {
  48402. import { Mesh } from "babylonjs/Meshes/mesh";
  48403. import { Behavior } from "babylonjs/Behaviors/behavior";
  48404. /**
  48405. * A behavior that when attached to a mesh will allow the mesh to be scaled
  48406. */
  48407. export class MultiPointerScaleBehavior implements Behavior<Mesh> {
  48408. private _dragBehaviorA;
  48409. private _dragBehaviorB;
  48410. private _startDistance;
  48411. private _initialScale;
  48412. private _targetScale;
  48413. private _ownerNode;
  48414. private _sceneRenderObserver;
  48415. /**
  48416. * Instantiate a new behavior that when attached to a mesh will allow the mesh to be scaled
  48417. */
  48418. constructor();
  48419. /**
  48420. * The name of the behavior
  48421. */
  48422. get name(): string;
  48423. /**
  48424. * Initializes the behavior
  48425. */
  48426. init(): void;
  48427. private _getCurrentDistance;
  48428. /**
  48429. * Attaches the scale behavior the passed in mesh
  48430. * @param ownerNode The mesh that will be scaled around once attached
  48431. */
  48432. attach(ownerNode: Mesh): void;
  48433. /**
  48434. * Detaches the behavior from the mesh
  48435. */
  48436. detach(): void;
  48437. }
  48438. }
  48439. declare module "babylonjs/Behaviors/Meshes/sixDofDragBehavior" {
  48440. import { Behavior } from "babylonjs/Behaviors/behavior";
  48441. import { Mesh } from "babylonjs/Meshes/mesh";
  48442. import { Observable } from "babylonjs/Misc/observable";
  48443. /**
  48444. * 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
  48445. */
  48446. export class SixDofDragBehavior implements Behavior<Mesh> {
  48447. private static _virtualScene;
  48448. private _ownerNode;
  48449. private _sceneRenderObserver;
  48450. private _scene;
  48451. private _targetPosition;
  48452. private _virtualOriginMesh;
  48453. private _virtualDragMesh;
  48454. private _pointerObserver;
  48455. private _moving;
  48456. private _startingOrientation;
  48457. private _attachedElement;
  48458. /**
  48459. * 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)
  48460. */
  48461. private zDragFactor;
  48462. /**
  48463. * If the object should rotate to face the drag origin
  48464. */
  48465. rotateDraggedObject: boolean;
  48466. /**
  48467. * If the behavior is currently in a dragging state
  48468. */
  48469. dragging: boolean;
  48470. /**
  48471. * 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)
  48472. */
  48473. dragDeltaRatio: number;
  48474. /**
  48475. * The id of the pointer that is currently interacting with the behavior (-1 when no pointer is active)
  48476. */
  48477. currentDraggingPointerID: number;
  48478. /**
  48479. * If camera controls should be detached during the drag
  48480. */
  48481. detachCameraControls: boolean;
  48482. /**
  48483. * Fires each time a drag starts
  48484. */
  48485. onDragStartObservable: Observable<{}>;
  48486. /**
  48487. * Fires each time a drag ends (eg. mouse release after drag)
  48488. */
  48489. onDragEndObservable: Observable<{}>;
  48490. /**
  48491. * 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
  48492. */
  48493. constructor();
  48494. /**
  48495. * The name of the behavior
  48496. */
  48497. get name(): string;
  48498. /**
  48499. * Initializes the behavior
  48500. */
  48501. init(): void;
  48502. /**
  48503. * In the case of multiplea active cameras, the cameraToUseForPointers should be used if set instead of active camera
  48504. */
  48505. private get _pointerCamera();
  48506. /**
  48507. * Attaches the scale behavior the passed in mesh
  48508. * @param ownerNode The mesh that will be scaled around once attached
  48509. */
  48510. attach(ownerNode: Mesh): void;
  48511. /**
  48512. * Detaches the behavior from the mesh
  48513. */
  48514. detach(): void;
  48515. }
  48516. }
  48517. declare module "babylonjs/Behaviors/Meshes/index" {
  48518. export * from "babylonjs/Behaviors/Meshes/attachToBoxBehavior";
  48519. export * from "babylonjs/Behaviors/Meshes/fadeInOutBehavior";
  48520. export * from "babylonjs/Behaviors/Meshes/multiPointerScaleBehavior";
  48521. export * from "babylonjs/Behaviors/Meshes/pointerDragBehavior";
  48522. export * from "babylonjs/Behaviors/Meshes/sixDofDragBehavior";
  48523. }
  48524. declare module "babylonjs/Behaviors/index" {
  48525. export * from "babylonjs/Behaviors/behavior";
  48526. export * from "babylonjs/Behaviors/Cameras/index";
  48527. export * from "babylonjs/Behaviors/Meshes/index";
  48528. }
  48529. declare module "babylonjs/Bones/boneIKController" {
  48530. import { Bone } from "babylonjs/Bones/bone";
  48531. import { Vector3 } from "babylonjs/Maths/math.vector";
  48532. import { AbstractMesh } from "babylonjs/Meshes/abstractMesh";
  48533. import { Nullable } from "babylonjs/types";
  48534. /**
  48535. * Class used to apply inverse kinematics to bones
  48536. * @see https://doc.babylonjs.com/how_to/how_to_use_bones_and_skeletons#boneikcontroller
  48537. */
  48538. export class BoneIKController {
  48539. private static _tmpVecs;
  48540. private static _tmpQuat;
  48541. private static _tmpMats;
  48542. /**
  48543. * Gets or sets the target mesh
  48544. */
  48545. targetMesh: AbstractMesh;
  48546. /** Gets or sets the mesh used as pole */
  48547. poleTargetMesh: AbstractMesh;
  48548. /**
  48549. * Gets or sets the bone used as pole
  48550. */
  48551. poleTargetBone: Nullable<Bone>;
  48552. /**
  48553. * Gets or sets the target position
  48554. */
  48555. targetPosition: Vector3;
  48556. /**
  48557. * Gets or sets the pole target position
  48558. */
  48559. poleTargetPosition: Vector3;
  48560. /**
  48561. * Gets or sets the pole target local offset
  48562. */
  48563. poleTargetLocalOffset: Vector3;
  48564. /**
  48565. * Gets or sets the pole angle
  48566. */
  48567. poleAngle: number;
  48568. /**
  48569. * Gets or sets the mesh associated with the controller
  48570. */
  48571. mesh: AbstractMesh;
  48572. /**
  48573. * 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)
  48574. */
  48575. slerpAmount: number;
  48576. private _bone1Quat;
  48577. private _bone1Mat;
  48578. private _bone2Ang;
  48579. private _bone1;
  48580. private _bone2;
  48581. private _bone1Length;
  48582. private _bone2Length;
  48583. private _maxAngle;
  48584. private _maxReach;
  48585. private _rightHandedSystem;
  48586. private _bendAxis;
  48587. private _slerping;
  48588. private _adjustRoll;
  48589. /**
  48590. * Gets or sets maximum allowed angle
  48591. */
  48592. get maxAngle(): number;
  48593. set maxAngle(value: number);
  48594. /**
  48595. * Creates a new BoneIKController
  48596. * @param mesh defines the mesh to control
  48597. * @param bone defines the bone to control
  48598. * @param options defines options to set up the controller
  48599. */
  48600. constructor(mesh: AbstractMesh, bone: Bone, options?: {
  48601. targetMesh?: AbstractMesh;
  48602. poleTargetMesh?: AbstractMesh;
  48603. poleTargetBone?: Bone;
  48604. poleTargetLocalOffset?: Vector3;
  48605. poleAngle?: number;
  48606. bendAxis?: Vector3;
  48607. maxAngle?: number;
  48608. slerpAmount?: number;
  48609. });
  48610. private _setMaxAngle;
  48611. /**
  48612. * Force the controller to update the bones
  48613. */
  48614. update(): void;
  48615. }
  48616. }
  48617. declare module "babylonjs/Bones/boneLookController" {
  48618. import { Vector3 } from "babylonjs/Maths/math.vector";
  48619. import { AbstractMesh } from "babylonjs/Meshes/abstractMesh";
  48620. import { Bone } from "babylonjs/Bones/bone";
  48621. import { Space } from "babylonjs/Maths/math.axis";
  48622. /**
  48623. * Class used to make a bone look toward a point in space
  48624. * @see https://doc.babylonjs.com/how_to/how_to_use_bones_and_skeletons#bonelookcontroller
  48625. */
  48626. export class BoneLookController {
  48627. private static _tmpVecs;
  48628. private static _tmpQuat;
  48629. private static _tmpMats;
  48630. /**
  48631. * The target Vector3 that the bone will look at
  48632. */
  48633. target: Vector3;
  48634. /**
  48635. * The mesh that the bone is attached to
  48636. */
  48637. mesh: AbstractMesh;
  48638. /**
  48639. * The bone that will be looking to the target
  48640. */
  48641. bone: Bone;
  48642. /**
  48643. * The up axis of the coordinate system that is used when the bone is rotated
  48644. */
  48645. upAxis: Vector3;
  48646. /**
  48647. * The space that the up axis is in - Space.BONE, Space.LOCAL (default), or Space.WORLD
  48648. */
  48649. upAxisSpace: Space;
  48650. /**
  48651. * Used to make an adjustment to the yaw of the bone
  48652. */
  48653. adjustYaw: number;
  48654. /**
  48655. * Used to make an adjustment to the pitch of the bone
  48656. */
  48657. adjustPitch: number;
  48658. /**
  48659. * Used to make an adjustment to the roll of the bone
  48660. */
  48661. adjustRoll: number;
  48662. /**
  48663. * 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)
  48664. */
  48665. slerpAmount: number;
  48666. private _minYaw;
  48667. private _maxYaw;
  48668. private _minPitch;
  48669. private _maxPitch;
  48670. private _minYawSin;
  48671. private _minYawCos;
  48672. private _maxYawSin;
  48673. private _maxYawCos;
  48674. private _midYawConstraint;
  48675. private _minPitchTan;
  48676. private _maxPitchTan;
  48677. private _boneQuat;
  48678. private _slerping;
  48679. private _transformYawPitch;
  48680. private _transformYawPitchInv;
  48681. private _firstFrameSkipped;
  48682. private _yawRange;
  48683. private _fowardAxis;
  48684. /**
  48685. * Gets or sets the minimum yaw angle that the bone can look to
  48686. */
  48687. get minYaw(): number;
  48688. set minYaw(value: number);
  48689. /**
  48690. * Gets or sets the maximum yaw angle that the bone can look to
  48691. */
  48692. get maxYaw(): number;
  48693. set maxYaw(value: number);
  48694. /**
  48695. * Gets or sets the minimum pitch angle that the bone can look to
  48696. */
  48697. get minPitch(): number;
  48698. set minPitch(value: number);
  48699. /**
  48700. * Gets or sets the maximum pitch angle that the bone can look to
  48701. */
  48702. get maxPitch(): number;
  48703. set maxPitch(value: number);
  48704. /**
  48705. * Create a BoneLookController
  48706. * @param mesh the mesh that the bone belongs to
  48707. * @param bone the bone that will be looking to the target
  48708. * @param target the target Vector3 to look at
  48709. * @param options optional settings:
  48710. * * maxYaw: the maximum angle the bone will yaw to
  48711. * * minYaw: the minimum angle the bone will yaw to
  48712. * * maxPitch: the maximum angle the bone will pitch to
  48713. * * minPitch: the minimum angle the bone will yaw to
  48714. * * slerpAmount: set the between 0 and 1 to make the bone slerp to the target.
  48715. * * upAxis: the up axis of the coordinate system
  48716. * * upAxisSpace: the space that the up axis is in - Space.BONE, Space.LOCAL (default), or Space.WORLD.
  48717. * * yawAxis: set yawAxis if the bone does not yaw on the y axis
  48718. * * pitchAxis: set pitchAxis if the bone does not pitch on the x axis
  48719. * * adjustYaw: used to make an adjustment to the yaw of the bone
  48720. * * adjustPitch: used to make an adjustment to the pitch of the bone
  48721. * * adjustRoll: used to make an adjustment to the roll of the bone
  48722. **/
  48723. constructor(mesh: AbstractMesh, bone: Bone, target: Vector3, options?: {
  48724. maxYaw?: number;
  48725. minYaw?: number;
  48726. maxPitch?: number;
  48727. minPitch?: number;
  48728. slerpAmount?: number;
  48729. upAxis?: Vector3;
  48730. upAxisSpace?: Space;
  48731. yawAxis?: Vector3;
  48732. pitchAxis?: Vector3;
  48733. adjustYaw?: number;
  48734. adjustPitch?: number;
  48735. adjustRoll?: number;
  48736. });
  48737. /**
  48738. * Update the bone to look at the target. This should be called before the scene is rendered (use scene.registerBeforeRender())
  48739. */
  48740. update(): void;
  48741. private _getAngleDiff;
  48742. private _getAngleBetween;
  48743. private _isAngleBetween;
  48744. }
  48745. }
  48746. declare module "babylonjs/Bones/index" {
  48747. export * from "babylonjs/Bones/bone";
  48748. export * from "babylonjs/Bones/boneIKController";
  48749. export * from "babylonjs/Bones/boneLookController";
  48750. export * from "babylonjs/Bones/skeleton";
  48751. }
  48752. declare module "babylonjs/Cameras/Inputs/arcRotateCameraGamepadInput" {
  48753. import { Nullable } from "babylonjs/types";
  48754. import { ArcRotateCamera } from "babylonjs/Cameras/arcRotateCamera";
  48755. import { ICameraInput } from "babylonjs/Cameras/cameraInputsManager";
  48756. import { Gamepad } from "babylonjs/Gamepads/gamepad";
  48757. /**
  48758. * Manage the gamepad inputs to control an arc rotate camera.
  48759. * @see https://doc.babylonjs.com/how_to/customizing_camera_inputs
  48760. */
  48761. export class ArcRotateCameraGamepadInput implements ICameraInput<ArcRotateCamera> {
  48762. /**
  48763. * Defines the camera the input is attached to.
  48764. */
  48765. camera: ArcRotateCamera;
  48766. /**
  48767. * Defines the gamepad the input is gathering event from.
  48768. */
  48769. gamepad: Nullable<Gamepad>;
  48770. /**
  48771. * Defines the gamepad rotation sensiblity.
  48772. * This is the threshold from when rotation starts to be accounted for to prevent jittering.
  48773. */
  48774. gamepadRotationSensibility: number;
  48775. /**
  48776. * Defines the gamepad move sensiblity.
  48777. * This is the threshold from when moving starts to be accounted for for to prevent jittering.
  48778. */
  48779. gamepadMoveSensibility: number;
  48780. private _yAxisScale;
  48781. /**
  48782. * Gets or sets a boolean indicating that Yaxis (for right stick) should be inverted
  48783. */
  48784. get invertYAxis(): boolean;
  48785. set invertYAxis(value: boolean);
  48786. private _onGamepadConnectedObserver;
  48787. private _onGamepadDisconnectedObserver;
  48788. /**
  48789. * Attach the input controls to a specific dom element to get the input from.
  48790. * @param element Defines the element the controls should be listened from
  48791. * @param noPreventDefault Defines whether event caught by the controls should call preventdefault() (https://developer.mozilla.org/en-US/docs/Web/API/Event/preventDefault)
  48792. */
  48793. attachControl(element: HTMLElement, noPreventDefault?: boolean): void;
  48794. /**
  48795. * Detach the current controls from the specified dom element.
  48796. * @param element Defines the element to stop listening the inputs from
  48797. */
  48798. detachControl(element: Nullable<HTMLElement>): void;
  48799. /**
  48800. * Update the current camera state depending on the inputs that have been used this frame.
  48801. * This is a dynamically created lambda to avoid the performance penalty of looping for inputs in the render loop.
  48802. */
  48803. checkInputs(): void;
  48804. /**
  48805. * Gets the class name of the current intput.
  48806. * @returns the class name
  48807. */
  48808. getClassName(): string;
  48809. /**
  48810. * Get the friendly name associated with the input class.
  48811. * @returns the input friendly name
  48812. */
  48813. getSimpleName(): string;
  48814. }
  48815. }
  48816. declare module "babylonjs/Cameras/Inputs/arcRotateCameraVRDeviceOrientationInput" {
  48817. import { Nullable } from "babylonjs/types";
  48818. import { ArcRotateCamera } from "babylonjs/Cameras/arcRotateCamera";
  48819. import { ICameraInput } from "babylonjs/Cameras/cameraInputsManager";
  48820. module "babylonjs/Cameras/arcRotateCameraInputsManager" {
  48821. interface ArcRotateCameraInputsManager {
  48822. /**
  48823. * Add orientation input support to the input manager.
  48824. * @returns the current input manager
  48825. */
  48826. addVRDeviceOrientation(): ArcRotateCameraInputsManager;
  48827. }
  48828. }
  48829. /**
  48830. * Manage the device orientation inputs (gyroscope) to control an arc rotate camera.
  48831. * @see https://doc.babylonjs.com/how_to/customizing_camera_inputs
  48832. */
  48833. export class ArcRotateCameraVRDeviceOrientationInput implements ICameraInput<ArcRotateCamera> {
  48834. /**
  48835. * Defines the camera the input is attached to.
  48836. */
  48837. camera: ArcRotateCamera;
  48838. /**
  48839. * Defines a correction factor applied on the alpha value retrieved from the orientation events.
  48840. */
  48841. alphaCorrection: number;
  48842. /**
  48843. * Defines a correction factor applied on the gamma value retrieved from the orientation events.
  48844. */
  48845. gammaCorrection: number;
  48846. private _alpha;
  48847. private _gamma;
  48848. private _dirty;
  48849. private _deviceOrientationHandler;
  48850. /**
  48851. * Instantiate a new ArcRotateCameraVRDeviceOrientationInput.
  48852. */
  48853. constructor();
  48854. /**
  48855. * Attach the input controls to a specific dom element to get the input from.
  48856. * @param element Defines the element the controls should be listened from
  48857. * @param noPreventDefault Defines whether event caught by the controls should call preventdefault() (https://developer.mozilla.org/en-US/docs/Web/API/Event/preventDefault)
  48858. */
  48859. attachControl(element: HTMLElement, noPreventDefault?: boolean): void;
  48860. /** @hidden */
  48861. _onOrientationEvent(evt: DeviceOrientationEvent): void;
  48862. /**
  48863. * Update the current camera state depending on the inputs that have been used this frame.
  48864. * This is a dynamically created lambda to avoid the performance penalty of looping for inputs in the render loop.
  48865. */
  48866. checkInputs(): void;
  48867. /**
  48868. * Detach the current controls from the specified dom element.
  48869. * @param element Defines the element to stop listening the inputs from
  48870. */
  48871. detachControl(element: Nullable<HTMLElement>): void;
  48872. /**
  48873. * Gets the class name of the current intput.
  48874. * @returns the class name
  48875. */
  48876. getClassName(): string;
  48877. /**
  48878. * Get the friendly name associated with the input class.
  48879. * @returns the input friendly name
  48880. */
  48881. getSimpleName(): string;
  48882. }
  48883. }
  48884. declare module "babylonjs/Cameras/Inputs/flyCameraMouseInput" {
  48885. import { Nullable } from "babylonjs/types";
  48886. import { ICameraInput } from "babylonjs/Cameras/cameraInputsManager";
  48887. import { FlyCamera } from "babylonjs/Cameras/flyCamera";
  48888. /**
  48889. * Listen to mouse events to control the camera.
  48890. * @see https://doc.babylonjs.com/how_to/customizing_camera_inputs
  48891. */
  48892. export class FlyCameraMouseInput implements ICameraInput<FlyCamera> {
  48893. /**
  48894. * Defines the camera the input is attached to.
  48895. */
  48896. camera: FlyCamera;
  48897. /**
  48898. * Defines if touch is enabled. (Default is true.)
  48899. */
  48900. touchEnabled: boolean;
  48901. /**
  48902. * Defines the buttons associated with the input to handle camera rotation.
  48903. */
  48904. buttons: number[];
  48905. /**
  48906. * Assign buttons for Yaw control.
  48907. */
  48908. buttonsYaw: number[];
  48909. /**
  48910. * Assign buttons for Pitch control.
  48911. */
  48912. buttonsPitch: number[];
  48913. /**
  48914. * Assign buttons for Roll control.
  48915. */
  48916. buttonsRoll: number[];
  48917. /**
  48918. * Detect if any button is being pressed while mouse is moved.
  48919. * -1 = Mouse locked.
  48920. * 0 = Left button.
  48921. * 1 = Middle Button.
  48922. * 2 = Right Button.
  48923. */
  48924. activeButton: number;
  48925. /**
  48926. * Defines the pointer's angular sensibility, to control the camera rotation speed.
  48927. * Higher values reduce its sensitivity.
  48928. */
  48929. angularSensibility: number;
  48930. private _observer;
  48931. private _rollObserver;
  48932. private previousPosition;
  48933. private noPreventDefault;
  48934. private element;
  48935. /**
  48936. * Listen to mouse events to control the camera.
  48937. * @param touchEnabled Define if touch is enabled. (Default is true.)
  48938. * @see https://doc.babylonjs.com/how_to/customizing_camera_inputs
  48939. */
  48940. constructor(touchEnabled?: boolean);
  48941. /**
  48942. * Attach the mouse control to the HTML DOM element.
  48943. * @param element Defines the element that listens to the input events.
  48944. * @param noPreventDefault Defines whether events caught by the controls should call preventdefault().
  48945. */
  48946. attachControl(element: HTMLElement, noPreventDefault?: boolean): void;
  48947. /**
  48948. * Detach the current controls from the specified dom element.
  48949. * @param element Defines the element to stop listening the inputs from
  48950. */
  48951. detachControl(element: Nullable<HTMLElement>): void;
  48952. /**
  48953. * Gets the class name of the current input.
  48954. * @returns the class name.
  48955. */
  48956. getClassName(): string;
  48957. /**
  48958. * Get the friendly name associated with the input class.
  48959. * @returns the input's friendly name.
  48960. */
  48961. getSimpleName(): string;
  48962. private _pointerInput;
  48963. private _onMouseMove;
  48964. /**
  48965. * Rotate camera by mouse offset.
  48966. */
  48967. private rotateCamera;
  48968. }
  48969. }
  48970. declare module "babylonjs/Cameras/flyCameraInputsManager" {
  48971. import { FlyCamera } from "babylonjs/Cameras/flyCamera";
  48972. import { CameraInputsManager } from "babylonjs/Cameras/cameraInputsManager";
  48973. /**
  48974. * Default Inputs manager for the FlyCamera.
  48975. * It groups all the default supported inputs for ease of use.
  48976. * @see https://doc.babylonjs.com/how_to/customizing_camera_inputs
  48977. */
  48978. export class FlyCameraInputsManager extends CameraInputsManager<FlyCamera> {
  48979. /**
  48980. * Instantiates a new FlyCameraInputsManager.
  48981. * @param camera Defines the camera the inputs belong to.
  48982. */
  48983. constructor(camera: FlyCamera);
  48984. /**
  48985. * Add keyboard input support to the input manager.
  48986. * @returns the new FlyCameraKeyboardMoveInput().
  48987. */
  48988. addKeyboard(): FlyCameraInputsManager;
  48989. /**
  48990. * Add mouse input support to the input manager.
  48991. * @param touchEnabled Enable touch screen support.
  48992. * @returns the new FlyCameraMouseInput().
  48993. */
  48994. addMouse(touchEnabled?: boolean): FlyCameraInputsManager;
  48995. }
  48996. }
  48997. declare module "babylonjs/Cameras/flyCamera" {
  48998. import { Scene } from "babylonjs/scene";
  48999. import { Vector3, Quaternion } from "babylonjs/Maths/math.vector";
  49000. import { AbstractMesh } from "babylonjs/Meshes/abstractMesh";
  49001. import { TargetCamera } from "babylonjs/Cameras/targetCamera";
  49002. import { FlyCameraInputsManager } from "babylonjs/Cameras/flyCameraInputsManager";
  49003. /**
  49004. * This is a flying camera, designed for 3D movement and rotation in all directions,
  49005. * such as in a 3D Space Shooter or a Flight Simulator.
  49006. */
  49007. export class FlyCamera extends TargetCamera {
  49008. /**
  49009. * Define the collision ellipsoid of the camera.
  49010. * This is helpful for simulating a camera body, like a player's body.
  49011. * @see https://doc.babylonjs.com/babylon101/cameras,_mesh_collisions_and_gravity#arcrotatecamera
  49012. */
  49013. ellipsoid: Vector3;
  49014. /**
  49015. * Define an offset for the position of the ellipsoid around the camera.
  49016. * This can be helpful if the camera is attached away from the player's body center,
  49017. * such as at its head.
  49018. */
  49019. ellipsoidOffset: Vector3;
  49020. /**
  49021. * Enable or disable collisions of the camera with the rest of the scene objects.
  49022. */
  49023. checkCollisions: boolean;
  49024. /**
  49025. * Enable or disable gravity on the camera.
  49026. */
  49027. applyGravity: boolean;
  49028. /**
  49029. * Define the current direction the camera is moving to.
  49030. */
  49031. cameraDirection: Vector3;
  49032. /**
  49033. * Define the current local rotation of the camera as a quaternion to prevent Gimbal lock.
  49034. * This overrides and empties cameraRotation.
  49035. */
  49036. rotationQuaternion: Quaternion;
  49037. /**
  49038. * Track Roll to maintain the wanted Rolling when looking around.
  49039. */
  49040. _trackRoll: number;
  49041. /**
  49042. * Slowly correct the Roll to its original value after a Pitch+Yaw rotation.
  49043. */
  49044. rollCorrect: number;
  49045. /**
  49046. * Mimic a banked turn, Rolling the camera when Yawing.
  49047. * It's recommended to use rollCorrect = 10 for faster banking correction.
  49048. */
  49049. bankedTurn: boolean;
  49050. /**
  49051. * Limit in radians for how much Roll banking will add. (Default: 90°)
  49052. */
  49053. bankedTurnLimit: number;
  49054. /**
  49055. * Value of 0 disables the banked Roll.
  49056. * Value of 1 is equal to the Yaw angle in radians.
  49057. */
  49058. bankedTurnMultiplier: number;
  49059. /**
  49060. * The inputs manager loads all the input sources, such as keyboard and mouse.
  49061. */
  49062. inputs: FlyCameraInputsManager;
  49063. /**
  49064. * Gets the input sensibility for mouse input.
  49065. * Higher values reduce sensitivity.
  49066. */
  49067. get angularSensibility(): number;
  49068. /**
  49069. * Sets the input sensibility for a mouse input.
  49070. * Higher values reduce sensitivity.
  49071. */
  49072. set angularSensibility(value: number);
  49073. /**
  49074. * Get the keys for camera movement forward.
  49075. */
  49076. get keysForward(): number[];
  49077. /**
  49078. * Set the keys for camera movement forward.
  49079. */
  49080. set keysForward(value: number[]);
  49081. /**
  49082. * Get the keys for camera movement backward.
  49083. */
  49084. get keysBackward(): number[];
  49085. set keysBackward(value: number[]);
  49086. /**
  49087. * Get the keys for camera movement up.
  49088. */
  49089. get keysUp(): number[];
  49090. /**
  49091. * Set the keys for camera movement up.
  49092. */
  49093. set keysUp(value: number[]);
  49094. /**
  49095. * Get the keys for camera movement down.
  49096. */
  49097. get keysDown(): number[];
  49098. /**
  49099. * Set the keys for camera movement down.
  49100. */
  49101. set keysDown(value: number[]);
  49102. /**
  49103. * Get the keys for camera movement left.
  49104. */
  49105. get keysLeft(): number[];
  49106. /**
  49107. * Set the keys for camera movement left.
  49108. */
  49109. set keysLeft(value: number[]);
  49110. /**
  49111. * Set the keys for camera movement right.
  49112. */
  49113. get keysRight(): number[];
  49114. /**
  49115. * Set the keys for camera movement right.
  49116. */
  49117. set keysRight(value: number[]);
  49118. /**
  49119. * Event raised when the camera collides with a mesh in the scene.
  49120. */
  49121. onCollide: (collidedMesh: AbstractMesh) => void;
  49122. private _collider;
  49123. private _needMoveForGravity;
  49124. private _oldPosition;
  49125. private _diffPosition;
  49126. private _newPosition;
  49127. /** @hidden */
  49128. _localDirection: Vector3;
  49129. /** @hidden */
  49130. _transformedDirection: Vector3;
  49131. /**
  49132. * Instantiates a FlyCamera.
  49133. * This is a flying camera, designed for 3D movement and rotation in all directions,
  49134. * such as in a 3D Space Shooter or a Flight Simulator.
  49135. * @param name Define the name of the camera in the scene.
  49136. * @param position Define the starting position of the camera in the scene.
  49137. * @param scene Define the scene the camera belongs to.
  49138. * @param setActiveOnSceneIfNoneActive Defines wheter the camera should be marked as active, if no other camera has been defined as active.
  49139. */
  49140. constructor(name: string, position: Vector3, scene: Scene, setActiveOnSceneIfNoneActive?: boolean);
  49141. /**
  49142. * Attach a control to the HTML DOM element.
  49143. * @param element Defines the element that listens to the input events.
  49144. * @param noPreventDefault Defines whether events caught by the controls should call preventdefault(). https://developer.mozilla.org/en-US/docs/Web/API/Event/preventDefault
  49145. */
  49146. attachControl(element: HTMLElement, noPreventDefault?: boolean): void;
  49147. /**
  49148. * Detach a control from the HTML DOM element.
  49149. * The camera will stop reacting to that input.
  49150. * @param element Defines the element that listens to the input events.
  49151. */
  49152. detachControl(element: HTMLElement): void;
  49153. private _collisionMask;
  49154. /**
  49155. * Get the mask that the camera ignores in collision events.
  49156. */
  49157. get collisionMask(): number;
  49158. /**
  49159. * Set the mask that the camera ignores in collision events.
  49160. */
  49161. set collisionMask(mask: number);
  49162. /** @hidden */
  49163. _collideWithWorld(displacement: Vector3): void;
  49164. /** @hidden */
  49165. private _onCollisionPositionChange;
  49166. /** @hidden */
  49167. _checkInputs(): void;
  49168. /** @hidden */
  49169. _decideIfNeedsToMove(): boolean;
  49170. /** @hidden */
  49171. _updatePosition(): void;
  49172. /**
  49173. * Restore the Roll to its target value at the rate specified.
  49174. * @param rate - Higher means slower restoring.
  49175. * @hidden
  49176. */
  49177. restoreRoll(rate: number): void;
  49178. /**
  49179. * Destroy the camera and release the current resources held by it.
  49180. */
  49181. dispose(): void;
  49182. /**
  49183. * Get the current object class name.
  49184. * @returns the class name.
  49185. */
  49186. getClassName(): string;
  49187. }
  49188. }
  49189. declare module "babylonjs/Cameras/Inputs/flyCameraKeyboardInput" {
  49190. import { Nullable } from "babylonjs/types";
  49191. import { ICameraInput } from "babylonjs/Cameras/cameraInputsManager";
  49192. import { FlyCamera } from "babylonjs/Cameras/flyCamera";
  49193. /**
  49194. * Listen to keyboard events to control the camera.
  49195. * @see https://doc.babylonjs.com/how_to/customizing_camera_inputs
  49196. */
  49197. export class FlyCameraKeyboardInput implements ICameraInput<FlyCamera> {
  49198. /**
  49199. * Defines the camera the input is attached to.
  49200. */
  49201. camera: FlyCamera;
  49202. /**
  49203. * The list of keyboard keys used to control the forward move of the camera.
  49204. */
  49205. keysForward: number[];
  49206. /**
  49207. * The list of keyboard keys used to control the backward move of the camera.
  49208. */
  49209. keysBackward: number[];
  49210. /**
  49211. * The list of keyboard keys used to control the forward move of the camera.
  49212. */
  49213. keysUp: number[];
  49214. /**
  49215. * The list of keyboard keys used to control the backward move of the camera.
  49216. */
  49217. keysDown: number[];
  49218. /**
  49219. * The list of keyboard keys used to control the right strafe move of the camera.
  49220. */
  49221. keysRight: number[];
  49222. /**
  49223. * The list of keyboard keys used to control the left strafe move of the camera.
  49224. */
  49225. keysLeft: number[];
  49226. private _keys;
  49227. private _onCanvasBlurObserver;
  49228. private _onKeyboardObserver;
  49229. private _engine;
  49230. private _scene;
  49231. /**
  49232. * Attach the input controls to a specific dom element to get the input from.
  49233. * @param element Defines the element the controls should be listened from
  49234. * @param noPreventDefault Defines whether event caught by the controls should call preventdefault() (https://developer.mozilla.org/en-US/docs/Web/API/Event/preventDefault)
  49235. */
  49236. attachControl(element: HTMLElement, noPreventDefault?: boolean): void;
  49237. /**
  49238. * Detach the current controls from the specified dom element.
  49239. * @param element Defines the element to stop listening the inputs from
  49240. */
  49241. detachControl(element: Nullable<HTMLElement>): void;
  49242. /**
  49243. * Gets the class name of the current intput.
  49244. * @returns the class name
  49245. */
  49246. getClassName(): string;
  49247. /** @hidden */
  49248. _onLostFocus(e: FocusEvent): void;
  49249. /**
  49250. * Get the friendly name associated with the input class.
  49251. * @returns the input friendly name
  49252. */
  49253. getSimpleName(): string;
  49254. /**
  49255. * Update the current camera state depending on the inputs that have been used this frame.
  49256. * This is a dynamically created lambda to avoid the performance penalty of looping for inputs in the render loop.
  49257. */
  49258. checkInputs(): void;
  49259. }
  49260. }
  49261. declare module "babylonjs/Cameras/Inputs/followCameraMouseWheelInput" {
  49262. import { Nullable } from "babylonjs/types";
  49263. import { FollowCamera } from "babylonjs/Cameras/followCamera";
  49264. import { ICameraInput } from "babylonjs/Cameras/cameraInputsManager";
  49265. /**
  49266. * Manage the mouse wheel inputs to control a follow camera.
  49267. * @see https://doc.babylonjs.com/how_to/customizing_camera_inputs
  49268. */
  49269. export class FollowCameraMouseWheelInput implements ICameraInput<FollowCamera> {
  49270. /**
  49271. * Defines the camera the input is attached to.
  49272. */
  49273. camera: FollowCamera;
  49274. /**
  49275. * Moue wheel controls zoom. (Mouse wheel modifies camera.radius value.)
  49276. */
  49277. axisControlRadius: boolean;
  49278. /**
  49279. * Moue wheel controls height. (Mouse wheel modifies camera.heightOffset value.)
  49280. */
  49281. axisControlHeight: boolean;
  49282. /**
  49283. * Moue wheel controls angle. (Mouse wheel modifies camera.rotationOffset value.)
  49284. */
  49285. axisControlRotation: boolean;
  49286. /**
  49287. * Gets or Set the mouse wheel precision or how fast is the camera moves in
  49288. * relation to mouseWheel events.
  49289. */
  49290. wheelPrecision: number;
  49291. /**
  49292. * wheelDeltaPercentage will be used instead of wheelPrecision if different from 0.
  49293. * It defines the percentage of current camera.radius to use as delta when wheel is used.
  49294. */
  49295. wheelDeltaPercentage: number;
  49296. private _wheel;
  49297. private _observer;
  49298. /**
  49299. * Attach the input controls to a specific dom element to get the input from.
  49300. * @param element Defines the element the controls should be listened from
  49301. * @param noPreventDefault Defines whether event caught by the controls should call preventdefault() (https://developer.mozilla.org/en-US/docs/Web/API/Event/preventDefault)
  49302. */
  49303. attachControl(element: HTMLElement, noPreventDefault?: boolean): void;
  49304. /**
  49305. * Detach the current controls from the specified dom element.
  49306. * @param element Defines the element to stop listening the inputs from
  49307. */
  49308. detachControl(element: Nullable<HTMLElement>): void;
  49309. /**
  49310. * Gets the class name of the current intput.
  49311. * @returns the class name
  49312. */
  49313. getClassName(): string;
  49314. /**
  49315. * Get the friendly name associated with the input class.
  49316. * @returns the input friendly name
  49317. */
  49318. getSimpleName(): string;
  49319. }
  49320. }
  49321. declare module "babylonjs/Cameras/Inputs/followCameraPointersInput" {
  49322. import { Nullable } from "babylonjs/types";
  49323. import { FollowCamera } from "babylonjs/Cameras/followCamera";
  49324. import { BaseCameraPointersInput } from "babylonjs/Cameras/Inputs/BaseCameraPointersInput";
  49325. import { PointerTouch } from "babylonjs/Events/pointerEvents";
  49326. /**
  49327. * Manage the pointers inputs to control an follow camera.
  49328. * @see https://doc.babylonjs.com/how_to/customizing_camera_inputs
  49329. */
  49330. export class FollowCameraPointersInput extends BaseCameraPointersInput {
  49331. /**
  49332. * Defines the camera the input is attached to.
  49333. */
  49334. camera: FollowCamera;
  49335. /**
  49336. * Gets the class name of the current input.
  49337. * @returns the class name
  49338. */
  49339. getClassName(): string;
  49340. /**
  49341. * Defines the pointer angular sensibility along the X axis or how fast is
  49342. * the camera rotating.
  49343. * A negative number will reverse the axis direction.
  49344. */
  49345. angularSensibilityX: number;
  49346. /**
  49347. * Defines the pointer angular sensibility along the Y axis or how fast is
  49348. * the camera rotating.
  49349. * A negative number will reverse the axis direction.
  49350. */
  49351. angularSensibilityY: number;
  49352. /**
  49353. * Defines the pointer pinch precision or how fast is the camera zooming.
  49354. * A negative number will reverse the axis direction.
  49355. */
  49356. pinchPrecision: number;
  49357. /**
  49358. * pinchDeltaPercentage will be used instead of pinchPrecision if different
  49359. * from 0.
  49360. * It defines the percentage of current camera.radius to use as delta when
  49361. * pinch zoom is used.
  49362. */
  49363. pinchDeltaPercentage: number;
  49364. /**
  49365. * Pointer X axis controls zoom. (X axis modifies camera.radius value.)
  49366. */
  49367. axisXControlRadius: boolean;
  49368. /**
  49369. * Pointer X axis controls height. (X axis modifies camera.heightOffset value.)
  49370. */
  49371. axisXControlHeight: boolean;
  49372. /**
  49373. * Pointer X axis controls angle. (X axis modifies camera.rotationOffset value.)
  49374. */
  49375. axisXControlRotation: boolean;
  49376. /**
  49377. * Pointer Y axis controls zoom. (Y axis modifies camera.radius value.)
  49378. */
  49379. axisYControlRadius: boolean;
  49380. /**
  49381. * Pointer Y axis controls height. (Y axis modifies camera.heightOffset value.)
  49382. */
  49383. axisYControlHeight: boolean;
  49384. /**
  49385. * Pointer Y axis controls angle. (Y axis modifies camera.rotationOffset value.)
  49386. */
  49387. axisYControlRotation: boolean;
  49388. /**
  49389. * Pinch controls zoom. (Pinch modifies camera.radius value.)
  49390. */
  49391. axisPinchControlRadius: boolean;
  49392. /**
  49393. * Pinch controls height. (Pinch modifies camera.heightOffset value.)
  49394. */
  49395. axisPinchControlHeight: boolean;
  49396. /**
  49397. * Pinch controls angle. (Pinch modifies camera.rotationOffset value.)
  49398. */
  49399. axisPinchControlRotation: boolean;
  49400. /**
  49401. * Log error messages if basic misconfiguration has occurred.
  49402. */
  49403. warningEnable: boolean;
  49404. protected onTouch(pointA: Nullable<PointerTouch>, offsetX: number, offsetY: number): void;
  49405. protected onMultiTouch(pointA: Nullable<PointerTouch>, pointB: Nullable<PointerTouch>, previousPinchSquaredDistance: number, pinchSquaredDistance: number, previousMultiTouchPanPosition: Nullable<PointerTouch>, multiTouchPanPosition: Nullable<PointerTouch>): void;
  49406. private _warningCounter;
  49407. private _warning;
  49408. }
  49409. }
  49410. declare module "babylonjs/Cameras/followCameraInputsManager" {
  49411. import { CameraInputsManager } from "babylonjs/Cameras/cameraInputsManager";
  49412. import { FollowCamera } from "babylonjs/Cameras/followCamera";
  49413. /**
  49414. * Default Inputs manager for the FollowCamera.
  49415. * It groups all the default supported inputs for ease of use.
  49416. * @see https://doc.babylonjs.com/how_to/customizing_camera_inputs
  49417. */
  49418. export class FollowCameraInputsManager extends CameraInputsManager<FollowCamera> {
  49419. /**
  49420. * Instantiates a new FollowCameraInputsManager.
  49421. * @param camera Defines the camera the inputs belong to
  49422. */
  49423. constructor(camera: FollowCamera);
  49424. /**
  49425. * Add keyboard input support to the input manager.
  49426. * @returns the current input manager
  49427. */
  49428. addKeyboard(): FollowCameraInputsManager;
  49429. /**
  49430. * Add mouse wheel input support to the input manager.
  49431. * @returns the current input manager
  49432. */
  49433. addMouseWheel(): FollowCameraInputsManager;
  49434. /**
  49435. * Add pointers input support to the input manager.
  49436. * @returns the current input manager
  49437. */
  49438. addPointers(): FollowCameraInputsManager;
  49439. /**
  49440. * Add orientation input support to the input manager.
  49441. * @returns the current input manager
  49442. */
  49443. addVRDeviceOrientation(): FollowCameraInputsManager;
  49444. }
  49445. }
  49446. declare module "babylonjs/Cameras/followCamera" {
  49447. import { Nullable } from "babylonjs/types";
  49448. import { TargetCamera } from "babylonjs/Cameras/targetCamera";
  49449. import { Scene } from "babylonjs/scene";
  49450. import { Vector3 } from "babylonjs/Maths/math.vector";
  49451. import { AbstractMesh } from "babylonjs/Meshes/abstractMesh";
  49452. import { FollowCameraInputsManager } from "babylonjs/Cameras/followCameraInputsManager";
  49453. /**
  49454. * A follow camera takes a mesh as a target and follows it as it moves. Both a free camera version followCamera and
  49455. * an arc rotate version arcFollowCamera are available.
  49456. * @see https://doc.babylonjs.com/features/cameras#follow-camera
  49457. */
  49458. export class FollowCamera extends TargetCamera {
  49459. /**
  49460. * Distance the follow camera should follow an object at
  49461. */
  49462. radius: number;
  49463. /**
  49464. * Minimum allowed distance of the camera to the axis of rotation
  49465. * (The camera can not get closer).
  49466. * This can help limiting how the Camera is able to move in the scene.
  49467. */
  49468. lowerRadiusLimit: Nullable<number>;
  49469. /**
  49470. * Maximum allowed distance of the camera to the axis of rotation
  49471. * (The camera can not get further).
  49472. * This can help limiting how the Camera is able to move in the scene.
  49473. */
  49474. upperRadiusLimit: Nullable<number>;
  49475. /**
  49476. * Define a rotation offset between the camera and the object it follows
  49477. */
  49478. rotationOffset: number;
  49479. /**
  49480. * Minimum allowed angle to camera position relative to target object.
  49481. * This can help limiting how the Camera is able to move in the scene.
  49482. */
  49483. lowerRotationOffsetLimit: Nullable<number>;
  49484. /**
  49485. * Maximum allowed angle to camera position relative to target object.
  49486. * This can help limiting how the Camera is able to move in the scene.
  49487. */
  49488. upperRotationOffsetLimit: Nullable<number>;
  49489. /**
  49490. * Define a height offset between the camera and the object it follows.
  49491. * It can help following an object from the top (like a car chaing a plane)
  49492. */
  49493. heightOffset: number;
  49494. /**
  49495. * Minimum allowed height of camera position relative to target object.
  49496. * This can help limiting how the Camera is able to move in the scene.
  49497. */
  49498. lowerHeightOffsetLimit: Nullable<number>;
  49499. /**
  49500. * Maximum allowed height of camera position relative to target object.
  49501. * This can help limiting how the Camera is able to move in the scene.
  49502. */
  49503. upperHeightOffsetLimit: Nullable<number>;
  49504. /**
  49505. * Define how fast the camera can accelerate to follow it s target.
  49506. */
  49507. cameraAcceleration: number;
  49508. /**
  49509. * Define the speed limit of the camera following an object.
  49510. */
  49511. maxCameraSpeed: number;
  49512. /**
  49513. * Define the target of the camera.
  49514. */
  49515. lockedTarget: Nullable<AbstractMesh>;
  49516. /**
  49517. * Defines the input associated with the camera.
  49518. */
  49519. inputs: FollowCameraInputsManager;
  49520. /**
  49521. * Instantiates the follow camera.
  49522. * @see https://doc.babylonjs.com/features/cameras#follow-camera
  49523. * @param name Define the name of the camera in the scene
  49524. * @param position Define the position of the camera
  49525. * @param scene Define the scene the camera belong to
  49526. * @param lockedTarget Define the target of the camera
  49527. */
  49528. constructor(name: string, position: Vector3, scene: Scene, lockedTarget?: Nullable<AbstractMesh>);
  49529. private _follow;
  49530. /**
  49531. * Attached controls to the current camera.
  49532. * @param element Defines the element the controls should be listened from
  49533. * @param noPreventDefault Defines whether event caught by the controls should call preventdefault() (https://developer.mozilla.org/en-US/docs/Web/API/Event/preventDefault)
  49534. */
  49535. attachControl(element: HTMLElement, noPreventDefault?: boolean): void;
  49536. /**
  49537. * Detach the current controls from the camera.
  49538. * The camera will stop reacting to inputs.
  49539. * @param element Defines the element to stop listening the inputs from
  49540. */
  49541. detachControl(element: HTMLElement): void;
  49542. /** @hidden */
  49543. _checkInputs(): void;
  49544. private _checkLimits;
  49545. /**
  49546. * Gets the camera class name.
  49547. * @returns the class name
  49548. */
  49549. getClassName(): string;
  49550. }
  49551. /**
  49552. * Arc Rotate version of the follow camera.
  49553. * It still follows a Defined mesh but in an Arc Rotate Camera fashion.
  49554. * @see https://doc.babylonjs.com/features/cameras#follow-camera
  49555. */
  49556. export class ArcFollowCamera extends TargetCamera {
  49557. /** The longitudinal angle of the camera */
  49558. alpha: number;
  49559. /** The latitudinal angle of the camera */
  49560. beta: number;
  49561. /** The radius of the camera from its target */
  49562. radius: number;
  49563. private _cartesianCoordinates;
  49564. /** Define the camera target (the mesh it should follow) */
  49565. private _meshTarget;
  49566. /**
  49567. * Instantiates a new ArcFollowCamera
  49568. * @see https://doc.babylonjs.com/features/cameras#follow-camera
  49569. * @param name Define the name of the camera
  49570. * @param alpha Define the rotation angle of the camera around the logitudinal axis
  49571. * @param beta Define the rotation angle of the camera around the elevation axis
  49572. * @param radius Define the radius of the camera from its target point
  49573. * @param target Define the target of the camera
  49574. * @param scene Define the scene the camera belongs to
  49575. */
  49576. constructor(name: string,
  49577. /** The longitudinal angle of the camera */
  49578. alpha: number,
  49579. /** The latitudinal angle of the camera */
  49580. beta: number,
  49581. /** The radius of the camera from its target */
  49582. radius: number,
  49583. /** Define the camera target (the mesh it should follow) */
  49584. target: Nullable<AbstractMesh>, scene: Scene);
  49585. private _follow;
  49586. /** @hidden */
  49587. _checkInputs(): void;
  49588. /**
  49589. * Returns the class name of the object.
  49590. * It is mostly used internally for serialization purposes.
  49591. */
  49592. getClassName(): string;
  49593. }
  49594. }
  49595. declare module "babylonjs/Cameras/Inputs/followCameraKeyboardMoveInput" {
  49596. import { ICameraInput } from "babylonjs/Cameras/cameraInputsManager";
  49597. import { FollowCamera } from "babylonjs/Cameras/followCamera";
  49598. import { Nullable } from "babylonjs/types";
  49599. /**
  49600. * Manage the keyboard inputs to control the movement of a follow camera.
  49601. * @see https://doc.babylonjs.com/how_to/customizing_camera_inputs
  49602. */
  49603. export class FollowCameraKeyboardMoveInput implements ICameraInput<FollowCamera> {
  49604. /**
  49605. * Defines the camera the input is attached to.
  49606. */
  49607. camera: FollowCamera;
  49608. /**
  49609. * Defines the list of key codes associated with the up action (increase heightOffset)
  49610. */
  49611. keysHeightOffsetIncr: number[];
  49612. /**
  49613. * Defines the list of key codes associated with the down action (decrease heightOffset)
  49614. */
  49615. keysHeightOffsetDecr: number[];
  49616. /**
  49617. * Defines whether the Alt modifier key is required to move up/down (alter heightOffset)
  49618. */
  49619. keysHeightOffsetModifierAlt: boolean;
  49620. /**
  49621. * Defines whether the Ctrl modifier key is required to move up/down (alter heightOffset)
  49622. */
  49623. keysHeightOffsetModifierCtrl: boolean;
  49624. /**
  49625. * Defines whether the Shift modifier key is required to move up/down (alter heightOffset)
  49626. */
  49627. keysHeightOffsetModifierShift: boolean;
  49628. /**
  49629. * Defines the list of key codes associated with the left action (increase rotationOffset)
  49630. */
  49631. keysRotationOffsetIncr: number[];
  49632. /**
  49633. * Defines the list of key codes associated with the right action (decrease rotationOffset)
  49634. */
  49635. keysRotationOffsetDecr: number[];
  49636. /**
  49637. * Defines whether the Alt modifier key is required to move left/right (alter rotationOffset)
  49638. */
  49639. keysRotationOffsetModifierAlt: boolean;
  49640. /**
  49641. * Defines whether the Ctrl modifier key is required to move left/right (alter rotationOffset)
  49642. */
  49643. keysRotationOffsetModifierCtrl: boolean;
  49644. /**
  49645. * Defines whether the Shift modifier key is required to move left/right (alter rotationOffset)
  49646. */
  49647. keysRotationOffsetModifierShift: boolean;
  49648. /**
  49649. * Defines the list of key codes associated with the zoom-in action (decrease radius)
  49650. */
  49651. keysRadiusIncr: number[];
  49652. /**
  49653. * Defines the list of key codes associated with the zoom-out action (increase radius)
  49654. */
  49655. keysRadiusDecr: number[];
  49656. /**
  49657. * Defines whether the Alt modifier key is required to zoom in/out (alter radius value)
  49658. */
  49659. keysRadiusModifierAlt: boolean;
  49660. /**
  49661. * Defines whether the Ctrl modifier key is required to zoom in/out (alter radius value)
  49662. */
  49663. keysRadiusModifierCtrl: boolean;
  49664. /**
  49665. * Defines whether the Shift modifier key is required to zoom in/out (alter radius value)
  49666. */
  49667. keysRadiusModifierShift: boolean;
  49668. /**
  49669. * Defines the rate of change of heightOffset.
  49670. */
  49671. heightSensibility: number;
  49672. /**
  49673. * Defines the rate of change of rotationOffset.
  49674. */
  49675. rotationSensibility: number;
  49676. /**
  49677. * Defines the rate of change of radius.
  49678. */
  49679. radiusSensibility: number;
  49680. private _keys;
  49681. private _ctrlPressed;
  49682. private _altPressed;
  49683. private _shiftPressed;
  49684. private _onCanvasBlurObserver;
  49685. private _onKeyboardObserver;
  49686. private _engine;
  49687. private _scene;
  49688. /**
  49689. * Attach the input controls to a specific dom element to get the input from.
  49690. * @param element Defines the element the controls should be listened from
  49691. * @param noPreventDefault Defines whether event caught by the controls should call preventdefault() (https://developer.mozilla.org/en-US/docs/Web/API/Event/preventDefault)
  49692. */
  49693. attachControl(element: HTMLElement, noPreventDefault?: boolean): void;
  49694. /**
  49695. * Detach the current controls from the specified dom element.
  49696. * @param element Defines the element to stop listening the inputs from
  49697. */
  49698. detachControl(element: Nullable<HTMLElement>): void;
  49699. /**
  49700. * Update the current camera state depending on the inputs that have been used this frame.
  49701. * This is a dynamically created lambda to avoid the performance penalty of looping for inputs in the render loop.
  49702. */
  49703. checkInputs(): void;
  49704. /**
  49705. * Gets the class name of the current input.
  49706. * @returns the class name
  49707. */
  49708. getClassName(): string;
  49709. /**
  49710. * Get the friendly name associated with the input class.
  49711. * @returns the input friendly name
  49712. */
  49713. getSimpleName(): string;
  49714. /**
  49715. * Check if the pressed modifier keys (Alt/Ctrl/Shift) match those configured to
  49716. * allow modification of the heightOffset value.
  49717. */
  49718. private _modifierHeightOffset;
  49719. /**
  49720. * Check if the pressed modifier keys (Alt/Ctrl/Shift) match those configured to
  49721. * allow modification of the rotationOffset value.
  49722. */
  49723. private _modifierRotationOffset;
  49724. /**
  49725. * Check if the pressed modifier keys (Alt/Ctrl/Shift) match those configured to
  49726. * allow modification of the radius value.
  49727. */
  49728. private _modifierRadius;
  49729. }
  49730. }
  49731. declare module "babylonjs/Cameras/Inputs/freeCameraDeviceOrientationInput" {
  49732. import { Nullable } from "babylonjs/types";
  49733. import { ICameraInput } from "babylonjs/Cameras/cameraInputsManager";
  49734. import { FreeCamera } from "babylonjs/Cameras/freeCamera";
  49735. import { Observable } from "babylonjs/Misc/observable";
  49736. module "babylonjs/Cameras/freeCameraInputsManager" {
  49737. interface FreeCameraInputsManager {
  49738. /**
  49739. * @hidden
  49740. */
  49741. _deviceOrientationInput: Nullable<FreeCameraDeviceOrientationInput>;
  49742. /**
  49743. * Add orientation input support to the input manager.
  49744. * @returns the current input manager
  49745. */
  49746. addDeviceOrientation(): FreeCameraInputsManager;
  49747. }
  49748. }
  49749. /**
  49750. * Takes information about the orientation of the device as reported by the deviceorientation event to orient the camera.
  49751. * Screen rotation is taken into account.
  49752. * @see https://doc.babylonjs.com/how_to/customizing_camera_inputs
  49753. */
  49754. export class FreeCameraDeviceOrientationInput implements ICameraInput<FreeCamera> {
  49755. private _camera;
  49756. private _screenOrientationAngle;
  49757. private _constantTranform;
  49758. private _screenQuaternion;
  49759. private _alpha;
  49760. private _beta;
  49761. private _gamma;
  49762. /**
  49763. * Can be used to detect if a device orientation sensor is available on a device
  49764. * @param timeout amount of time in milliseconds to wait for a response from the sensor (default: infinite)
  49765. * @returns a promise that will resolve on orientation change
  49766. */
  49767. static WaitForOrientationChangeAsync(timeout?: number): Promise<unknown>;
  49768. /**
  49769. * @hidden
  49770. */
  49771. _onDeviceOrientationChangedObservable: Observable<void>;
  49772. /**
  49773. * Instantiates a new input
  49774. * @see https://doc.babylonjs.com/how_to/customizing_camera_inputs
  49775. */
  49776. constructor();
  49777. /**
  49778. * Define the camera controlled by the input.
  49779. */
  49780. get camera(): FreeCamera;
  49781. set camera(camera: FreeCamera);
  49782. /**
  49783. * Attach the input controls to a specific dom element to get the input from.
  49784. * @param element Defines the element the controls should be listened from
  49785. * @param noPreventDefault Defines whether event caught by the controls should call preventdefault() (https://developer.mozilla.org/en-US/docs/Web/API/Event/preventDefault)
  49786. */
  49787. attachControl(element: HTMLElement, noPreventDefault?: boolean): void;
  49788. private _orientationChanged;
  49789. private _deviceOrientation;
  49790. /**
  49791. * Detach the current controls from the specified dom element.
  49792. * @param element Defines the element to stop listening the inputs from
  49793. */
  49794. detachControl(element: Nullable<HTMLElement>): void;
  49795. /**
  49796. * Update the current camera state depending on the inputs that have been used this frame.
  49797. * This is a dynamically created lambda to avoid the performance penalty of looping for inputs in the render loop.
  49798. */
  49799. checkInputs(): void;
  49800. /**
  49801. * Gets the class name of the current intput.
  49802. * @returns the class name
  49803. */
  49804. getClassName(): string;
  49805. /**
  49806. * Get the friendly name associated with the input class.
  49807. * @returns the input friendly name
  49808. */
  49809. getSimpleName(): string;
  49810. }
  49811. }
  49812. declare module "babylonjs/Cameras/Inputs/freeCameraGamepadInput" {
  49813. import { Nullable } from "babylonjs/types";
  49814. import { ICameraInput } from "babylonjs/Cameras/cameraInputsManager";
  49815. import { FreeCamera } from "babylonjs/Cameras/freeCamera";
  49816. import { Gamepad } from "babylonjs/Gamepads/gamepad";
  49817. /**
  49818. * Manage the gamepad inputs to control a free camera.
  49819. * @see https://doc.babylonjs.com/how_to/customizing_camera_inputs
  49820. */
  49821. export class FreeCameraGamepadInput implements ICameraInput<FreeCamera> {
  49822. /**
  49823. * Define the camera the input is attached to.
  49824. */
  49825. camera: FreeCamera;
  49826. /**
  49827. * Define the Gamepad controlling the input
  49828. */
  49829. gamepad: Nullable<Gamepad>;
  49830. /**
  49831. * Defines the gamepad rotation sensiblity.
  49832. * This is the threshold from when rotation starts to be accounted for to prevent jittering.
  49833. */
  49834. gamepadAngularSensibility: number;
  49835. /**
  49836. * Defines the gamepad move sensiblity.
  49837. * This is the threshold from when moving starts to be accounted for for to prevent jittering.
  49838. */
  49839. gamepadMoveSensibility: number;
  49840. private _yAxisScale;
  49841. /**
  49842. * Gets or sets a boolean indicating that Yaxis (for right stick) should be inverted
  49843. */
  49844. get invertYAxis(): boolean;
  49845. set invertYAxis(value: boolean);
  49846. private _onGamepadConnectedObserver;
  49847. private _onGamepadDisconnectedObserver;
  49848. private _cameraTransform;
  49849. private _deltaTransform;
  49850. private _vector3;
  49851. private _vector2;
  49852. /**
  49853. * Attach the input controls to a specific dom element to get the input from.
  49854. * @param element Defines the element the controls should be listened from
  49855. * @param noPreventDefault Defines whether event caught by the controls should call preventdefault() (https://developer.mozilla.org/en-US/docs/Web/API/Event/preventDefault)
  49856. */
  49857. attachControl(element: HTMLElement, noPreventDefault?: boolean): void;
  49858. /**
  49859. * Detach the current controls from the specified dom element.
  49860. * @param element Defines the element to stop listening the inputs from
  49861. */
  49862. detachControl(element: Nullable<HTMLElement>): void;
  49863. /**
  49864. * Update the current camera state depending on the inputs that have been used this frame.
  49865. * This is a dynamically created lambda to avoid the performance penalty of looping for inputs in the render loop.
  49866. */
  49867. checkInputs(): void;
  49868. /**
  49869. * Gets the class name of the current intput.
  49870. * @returns the class name
  49871. */
  49872. getClassName(): string;
  49873. /**
  49874. * Get the friendly name associated with the input class.
  49875. * @returns the input friendly name
  49876. */
  49877. getSimpleName(): string;
  49878. }
  49879. }
  49880. declare module "babylonjs/Misc/virtualJoystick" {
  49881. import { Nullable } from "babylonjs/types";
  49882. import { Vector3 } from "babylonjs/Maths/math.vector";
  49883. /**
  49884. * Defines the potential axis of a Joystick
  49885. */
  49886. export enum JoystickAxis {
  49887. /** X axis */
  49888. X = 0,
  49889. /** Y axis */
  49890. Y = 1,
  49891. /** Z axis */
  49892. Z = 2
  49893. }
  49894. /**
  49895. * Represents the different customization options available
  49896. * for VirtualJoystick
  49897. */
  49898. interface VirtualJoystickCustomizations {
  49899. /**
  49900. * Size of the joystick's puck
  49901. */
  49902. puckSize: number;
  49903. /**
  49904. * Size of the joystick's container
  49905. */
  49906. containerSize: number;
  49907. /**
  49908. * Color of the joystick && puck
  49909. */
  49910. color: string;
  49911. /**
  49912. * Image URL for the joystick's puck
  49913. */
  49914. puckImage?: string;
  49915. /**
  49916. * Image URL for the joystick's container
  49917. */
  49918. containerImage?: string;
  49919. /**
  49920. * Defines the unmoving position of the joystick container
  49921. */
  49922. position?: {
  49923. x: number;
  49924. y: number;
  49925. };
  49926. /**
  49927. * Defines whether or not the joystick container is always visible
  49928. */
  49929. alwaysVisible: boolean;
  49930. /**
  49931. * Defines whether or not to limit the movement of the puck to the joystick's container
  49932. */
  49933. limitToContainer: boolean;
  49934. }
  49935. /**
  49936. * Class used to define virtual joystick (used in touch mode)
  49937. */
  49938. export class VirtualJoystick {
  49939. /**
  49940. * Gets or sets a boolean indicating that left and right values must be inverted
  49941. */
  49942. reverseLeftRight: boolean;
  49943. /**
  49944. * Gets or sets a boolean indicating that up and down values must be inverted
  49945. */
  49946. reverseUpDown: boolean;
  49947. /**
  49948. * Gets the offset value for the position (ie. the change of the position value)
  49949. */
  49950. deltaPosition: Vector3;
  49951. /**
  49952. * Gets a boolean indicating if the virtual joystick was pressed
  49953. */
  49954. pressed: boolean;
  49955. /**
  49956. * Canvas the virtual joystick will render onto, default z-index of this is 5
  49957. */
  49958. static Canvas: Nullable<HTMLCanvasElement>;
  49959. /**
  49960. * boolean indicating whether or not the joystick's puck's movement should be limited to the joystick's container area
  49961. */
  49962. limitToContainer: boolean;
  49963. private static _globalJoystickIndex;
  49964. private static _alwaysVisibleSticks;
  49965. private static vjCanvasContext;
  49966. private static vjCanvasWidth;
  49967. private static vjCanvasHeight;
  49968. private static halfWidth;
  49969. private static _GetDefaultOptions;
  49970. private _action;
  49971. private _axisTargetedByLeftAndRight;
  49972. private _axisTargetedByUpAndDown;
  49973. private _joystickSensibility;
  49974. private _inversedSensibility;
  49975. private _joystickPointerID;
  49976. private _joystickColor;
  49977. private _joystickPointerPos;
  49978. private _joystickPreviousPointerPos;
  49979. private _joystickPointerStartPos;
  49980. private _deltaJoystickVector;
  49981. private _leftJoystick;
  49982. private _touches;
  49983. private _joystickPosition;
  49984. private _alwaysVisible;
  49985. private _puckImage;
  49986. private _containerImage;
  49987. private _joystickPuckSize;
  49988. private _joystickContainerSize;
  49989. private _clearPuckSize;
  49990. private _clearContainerSize;
  49991. private _clearPuckSizeOffset;
  49992. private _clearContainerSizeOffset;
  49993. private _onPointerDownHandlerRef;
  49994. private _onPointerMoveHandlerRef;
  49995. private _onPointerUpHandlerRef;
  49996. private _onResize;
  49997. /**
  49998. * Creates a new virtual joystick
  49999. * @param leftJoystick defines that the joystick is for left hand (false by default)
  50000. * @param customizations Defines the options we want to customize the VirtualJoystick
  50001. */
  50002. constructor(leftJoystick?: boolean, customizations?: Partial<VirtualJoystickCustomizations>);
  50003. /**
  50004. * Defines joystick sensibility (ie. the ratio beteen a physical move and virtual joystick position change)
  50005. * @param newJoystickSensibility defines the new sensibility
  50006. */
  50007. setJoystickSensibility(newJoystickSensibility: number): void;
  50008. private _onPointerDown;
  50009. private _onPointerMove;
  50010. private _onPointerUp;
  50011. /**
  50012. * Change the color of the virtual joystick
  50013. * @param newColor a string that must be a CSS color value (like "red") or the hexa value (like "#FF0000")
  50014. */
  50015. setJoystickColor(newColor: string): void;
  50016. /**
  50017. * Size of the joystick's container
  50018. */
  50019. set containerSize(newSize: number);
  50020. get containerSize(): number;
  50021. /**
  50022. * Size of the joystick's puck
  50023. */
  50024. set puckSize(newSize: number);
  50025. get puckSize(): number;
  50026. /**
  50027. * Clears the set position of the joystick
  50028. */
  50029. clearPosition(): void;
  50030. /**
  50031. * Defines whether or not the joystick container is always visible
  50032. */
  50033. set alwaysVisible(value: boolean);
  50034. get alwaysVisible(): boolean;
  50035. /**
  50036. * Sets the constant position of the Joystick container
  50037. * @param x X axis coordinate
  50038. * @param y Y axis coordinate
  50039. */
  50040. setPosition(x: number, y: number): void;
  50041. /**
  50042. * Defines a callback to call when the joystick is touched
  50043. * @param action defines the callback
  50044. */
  50045. setActionOnTouch(action: () => any): void;
  50046. /**
  50047. * Defines which axis you'd like to control for left & right
  50048. * @param axis defines the axis to use
  50049. */
  50050. setAxisForLeftRight(axis: JoystickAxis): void;
  50051. /**
  50052. * Defines which axis you'd like to control for up & down
  50053. * @param axis defines the axis to use
  50054. */
  50055. setAxisForUpDown(axis: JoystickAxis): void;
  50056. /**
  50057. * Clears the canvas from the previous puck / container draw
  50058. */
  50059. private _clearPreviousDraw;
  50060. /**
  50061. * Loads `urlPath` to be used for the container's image
  50062. * @param urlPath defines the urlPath of an image to use
  50063. */
  50064. setContainerImage(urlPath: string): void;
  50065. /**
  50066. * Loads `urlPath` to be used for the puck's image
  50067. * @param urlPath defines the urlPath of an image to use
  50068. */
  50069. setPuckImage(urlPath: string): void;
  50070. /**
  50071. * Draws the Virtual Joystick's container
  50072. */
  50073. private _drawContainer;
  50074. /**
  50075. * Draws the Virtual Joystick's puck
  50076. */
  50077. private _drawPuck;
  50078. private _drawVirtualJoystick;
  50079. /**
  50080. * Release internal HTML canvas
  50081. */
  50082. releaseCanvas(): void;
  50083. }
  50084. }
  50085. declare module "babylonjs/Cameras/Inputs/freeCameraVirtualJoystickInput" {
  50086. import { VirtualJoystick } from "babylonjs/Misc/virtualJoystick";
  50087. import { Nullable } from "babylonjs/types";
  50088. import { ICameraInput } from "babylonjs/Cameras/cameraInputsManager";
  50089. import { FreeCamera } from "babylonjs/Cameras/freeCamera";
  50090. module "babylonjs/Cameras/freeCameraInputsManager" {
  50091. interface FreeCameraInputsManager {
  50092. /**
  50093. * Add virtual joystick input support to the input manager.
  50094. * @returns the current input manager
  50095. */
  50096. addVirtualJoystick(): FreeCameraInputsManager;
  50097. }
  50098. }
  50099. /**
  50100. * Manage the Virtual Joystick inputs to control the movement of a free camera.
  50101. * @see https://doc.babylonjs.com/how_to/customizing_camera_inputs
  50102. */
  50103. export class FreeCameraVirtualJoystickInput implements ICameraInput<FreeCamera> {
  50104. /**
  50105. * Defines the camera the input is attached to.
  50106. */
  50107. camera: FreeCamera;
  50108. private _leftjoystick;
  50109. private _rightjoystick;
  50110. /**
  50111. * Gets the left stick of the virtual joystick.
  50112. * @returns The virtual Joystick
  50113. */
  50114. getLeftJoystick(): VirtualJoystick;
  50115. /**
  50116. * Gets the right stick of the virtual joystick.
  50117. * @returns The virtual Joystick
  50118. */
  50119. getRightJoystick(): VirtualJoystick;
  50120. /**
  50121. * Update the current camera state depending on the inputs that have been used this frame.
  50122. * This is a dynamically created lambda to avoid the performance penalty of looping for inputs in the render loop.
  50123. */
  50124. checkInputs(): void;
  50125. /**
  50126. * Attach the input controls to a specific dom element to get the input from.
  50127. * @param element Defines the element the controls should be listened from
  50128. * @param noPreventDefault Defines whether event caught by the controls should call preventdefault() (https://developer.mozilla.org/en-US/docs/Web/API/Event/preventDefault)
  50129. */
  50130. attachControl(element: HTMLElement, noPreventDefault?: boolean): void;
  50131. /**
  50132. * Detach the current controls from the specified dom element.
  50133. * @param element Defines the element to stop listening the inputs from
  50134. */
  50135. detachControl(element: Nullable<HTMLElement>): void;
  50136. /**
  50137. * Gets the class name of the current intput.
  50138. * @returns the class name
  50139. */
  50140. getClassName(): string;
  50141. /**
  50142. * Get the friendly name associated with the input class.
  50143. * @returns the input friendly name
  50144. */
  50145. getSimpleName(): string;
  50146. }
  50147. }
  50148. declare module "babylonjs/Cameras/Inputs/index" {
  50149. export * from "babylonjs/Cameras/Inputs/arcRotateCameraGamepadInput";
  50150. export * from "babylonjs/Cameras/Inputs/arcRotateCameraKeyboardMoveInput";
  50151. export * from "babylonjs/Cameras/Inputs/arcRotateCameraMouseWheelInput";
  50152. export * from "babylonjs/Cameras/Inputs/arcRotateCameraPointersInput";
  50153. export * from "babylonjs/Cameras/Inputs/arcRotateCameraVRDeviceOrientationInput";
  50154. export * from "babylonjs/Cameras/Inputs/flyCameraKeyboardInput";
  50155. export * from "babylonjs/Cameras/Inputs/flyCameraMouseInput";
  50156. export * from "babylonjs/Cameras/Inputs/followCameraKeyboardMoveInput";
  50157. export * from "babylonjs/Cameras/Inputs/followCameraMouseWheelInput";
  50158. export * from "babylonjs/Cameras/Inputs/followCameraPointersInput";
  50159. export * from "babylonjs/Cameras/Inputs/freeCameraDeviceOrientationInput";
  50160. export * from "babylonjs/Cameras/Inputs/freeCameraGamepadInput";
  50161. export * from "babylonjs/Cameras/Inputs/freeCameraKeyboardMoveInput";
  50162. export * from "babylonjs/Cameras/Inputs/freeCameraMouseInput";
  50163. export * from "babylonjs/Cameras/Inputs/freeCameraTouchInput";
  50164. export * from "babylonjs/Cameras/Inputs/freeCameraVirtualJoystickInput";
  50165. }
  50166. declare module "babylonjs/Cameras/touchCamera" {
  50167. import { FreeCamera } from "babylonjs/Cameras/freeCamera";
  50168. import { Scene } from "babylonjs/scene";
  50169. import { Vector3 } from "babylonjs/Maths/math.vector";
  50170. /**
  50171. * This represents a FPS type of camera controlled by touch.
  50172. * This is like a universal camera minus the Gamepad controls.
  50173. * @see https://doc.babylonjs.com/features/cameras#universal-camera
  50174. */
  50175. export class TouchCamera extends FreeCamera {
  50176. /**
  50177. * Defines the touch sensibility for rotation.
  50178. * The higher the faster.
  50179. */
  50180. get touchAngularSensibility(): number;
  50181. set touchAngularSensibility(value: number);
  50182. /**
  50183. * Defines the touch sensibility for move.
  50184. * The higher the faster.
  50185. */
  50186. get touchMoveSensibility(): number;
  50187. set touchMoveSensibility(value: number);
  50188. /**
  50189. * Instantiates a new touch camera.
  50190. * This represents a FPS type of camera controlled by touch.
  50191. * This is like a universal camera minus the Gamepad controls.
  50192. * @see https://doc.babylonjs.com/features/cameras#universal-camera
  50193. * @param name Define the name of the camera in the scene
  50194. * @param position Define the start position of the camera in the scene
  50195. * @param scene Define the scene the camera belongs to
  50196. */
  50197. constructor(name: string, position: Vector3, scene: Scene);
  50198. /**
  50199. * Gets the current object class name.
  50200. * @return the class name
  50201. */
  50202. getClassName(): string;
  50203. /** @hidden */
  50204. _setupInputs(): void;
  50205. }
  50206. }
  50207. declare module "babylonjs/Cameras/deviceOrientationCamera" {
  50208. import { FreeCamera } from "babylonjs/Cameras/freeCamera";
  50209. import { Scene } from "babylonjs/scene";
  50210. import { Vector3 } from "babylonjs/Maths/math.vector";
  50211. import "babylonjs/Cameras/Inputs/freeCameraDeviceOrientationInput";
  50212. import { Axis } from "babylonjs/Maths/math.axis";
  50213. /**
  50214. * This is a camera specifically designed to react to device orientation events such as a modern mobile device
  50215. * being tilted forward or back and left or right.
  50216. */
  50217. export class DeviceOrientationCamera extends FreeCamera {
  50218. private _initialQuaternion;
  50219. private _quaternionCache;
  50220. private _tmpDragQuaternion;
  50221. private _disablePointerInputWhenUsingDeviceOrientation;
  50222. /**
  50223. * Creates a new device orientation camera
  50224. * @param name The name of the camera
  50225. * @param position The start position camera
  50226. * @param scene The scene the camera belongs to
  50227. */
  50228. constructor(name: string, position: Vector3, scene: Scene);
  50229. /**
  50230. * Gets or sets a boolean indicating that pointer input must be disabled on first orientation sensor update (Default: true)
  50231. */
  50232. get disablePointerInputWhenUsingDeviceOrientation(): boolean;
  50233. set disablePointerInputWhenUsingDeviceOrientation(value: boolean);
  50234. private _dragFactor;
  50235. /**
  50236. * Enabled turning on the y axis when the orientation sensor is active
  50237. * @param dragFactor the factor that controls the turn speed (default: 1/300)
  50238. */
  50239. enableHorizontalDragging(dragFactor?: number): void;
  50240. /**
  50241. * Gets the current instance class name ("DeviceOrientationCamera").
  50242. * This helps avoiding instanceof at run time.
  50243. * @returns the class name
  50244. */
  50245. getClassName(): string;
  50246. /**
  50247. * @hidden
  50248. * Checks and applies the current values of the inputs to the camera. (Internal use only)
  50249. */
  50250. _checkInputs(): void;
  50251. /**
  50252. * Reset the camera to its default orientation on the specified axis only.
  50253. * @param axis The axis to reset
  50254. */
  50255. resetToCurrentRotation(axis?: Axis): void;
  50256. }
  50257. }
  50258. declare module "babylonjs/Gamepads/xboxGamepad" {
  50259. import { Observable } from "babylonjs/Misc/observable";
  50260. import { Gamepad } from "babylonjs/Gamepads/gamepad";
  50261. /**
  50262. * Defines supported buttons for XBox360 compatible gamepads
  50263. */
  50264. export enum Xbox360Button {
  50265. /** A */
  50266. A = 0,
  50267. /** B */
  50268. B = 1,
  50269. /** X */
  50270. X = 2,
  50271. /** Y */
  50272. Y = 3,
  50273. /** Left button */
  50274. LB = 4,
  50275. /** Right button */
  50276. RB = 5,
  50277. /** Back */
  50278. Back = 8,
  50279. /** Start */
  50280. Start = 9,
  50281. /** Left stick */
  50282. LeftStick = 10,
  50283. /** Right stick */
  50284. RightStick = 11
  50285. }
  50286. /** Defines values for XBox360 DPad */
  50287. export enum Xbox360Dpad {
  50288. /** Up */
  50289. Up = 12,
  50290. /** Down */
  50291. Down = 13,
  50292. /** Left */
  50293. Left = 14,
  50294. /** Right */
  50295. Right = 15
  50296. }
  50297. /**
  50298. * Defines a XBox360 gamepad
  50299. */
  50300. export class Xbox360Pad extends Gamepad {
  50301. private _leftTrigger;
  50302. private _rightTrigger;
  50303. private _onlefttriggerchanged;
  50304. private _onrighttriggerchanged;
  50305. private _onbuttondown;
  50306. private _onbuttonup;
  50307. private _ondpaddown;
  50308. private _ondpadup;
  50309. /** Observable raised when a button is pressed */
  50310. onButtonDownObservable: Observable<Xbox360Button>;
  50311. /** Observable raised when a button is released */
  50312. onButtonUpObservable: Observable<Xbox360Button>;
  50313. /** Observable raised when a pad is pressed */
  50314. onPadDownObservable: Observable<Xbox360Dpad>;
  50315. /** Observable raised when a pad is released */
  50316. onPadUpObservable: Observable<Xbox360Dpad>;
  50317. private _buttonA;
  50318. private _buttonB;
  50319. private _buttonX;
  50320. private _buttonY;
  50321. private _buttonBack;
  50322. private _buttonStart;
  50323. private _buttonLB;
  50324. private _buttonRB;
  50325. private _buttonLeftStick;
  50326. private _buttonRightStick;
  50327. private _dPadUp;
  50328. private _dPadDown;
  50329. private _dPadLeft;
  50330. private _dPadRight;
  50331. private _isXboxOnePad;
  50332. /**
  50333. * Creates a new XBox360 gamepad object
  50334. * @param id defines the id of this gamepad
  50335. * @param index defines its index
  50336. * @param gamepad defines the internal HTML gamepad object
  50337. * @param xboxOne defines if it is a XBox One gamepad
  50338. */
  50339. constructor(id: string, index: number, gamepad: any, xboxOne?: boolean);
  50340. /**
  50341. * Defines the callback to call when left trigger is pressed
  50342. * @param callback defines the callback to use
  50343. */
  50344. onlefttriggerchanged(callback: (value: number) => void): void;
  50345. /**
  50346. * Defines the callback to call when right trigger is pressed
  50347. * @param callback defines the callback to use
  50348. */
  50349. onrighttriggerchanged(callback: (value: number) => void): void;
  50350. /**
  50351. * Gets the left trigger value
  50352. */
  50353. get leftTrigger(): number;
  50354. /**
  50355. * Sets the left trigger value
  50356. */
  50357. set leftTrigger(newValue: number);
  50358. /**
  50359. * Gets the right trigger value
  50360. */
  50361. get rightTrigger(): number;
  50362. /**
  50363. * Sets the right trigger value
  50364. */
  50365. set rightTrigger(newValue: number);
  50366. /**
  50367. * Defines the callback to call when a button is pressed
  50368. * @param callback defines the callback to use
  50369. */
  50370. onbuttondown(callback: (buttonPressed: Xbox360Button) => void): void;
  50371. /**
  50372. * Defines the callback to call when a button is released
  50373. * @param callback defines the callback to use
  50374. */
  50375. onbuttonup(callback: (buttonReleased: Xbox360Button) => void): void;
  50376. /**
  50377. * Defines the callback to call when a pad is pressed
  50378. * @param callback defines the callback to use
  50379. */
  50380. ondpaddown(callback: (dPadPressed: Xbox360Dpad) => void): void;
  50381. /**
  50382. * Defines the callback to call when a pad is released
  50383. * @param callback defines the callback to use
  50384. */
  50385. ondpadup(callback: (dPadReleased: Xbox360Dpad) => void): void;
  50386. private _setButtonValue;
  50387. private _setDPadValue;
  50388. /**
  50389. * Gets the value of the `A` button
  50390. */
  50391. get buttonA(): number;
  50392. /**
  50393. * Sets the value of the `A` button
  50394. */
  50395. set buttonA(value: number);
  50396. /**
  50397. * Gets the value of the `B` button
  50398. */
  50399. get buttonB(): number;
  50400. /**
  50401. * Sets the value of the `B` button
  50402. */
  50403. set buttonB(value: number);
  50404. /**
  50405. * Gets the value of the `X` button
  50406. */
  50407. get buttonX(): number;
  50408. /**
  50409. * Sets the value of the `X` button
  50410. */
  50411. set buttonX(value: number);
  50412. /**
  50413. * Gets the value of the `Y` button
  50414. */
  50415. get buttonY(): number;
  50416. /**
  50417. * Sets the value of the `Y` button
  50418. */
  50419. set buttonY(value: number);
  50420. /**
  50421. * Gets the value of the `Start` button
  50422. */
  50423. get buttonStart(): number;
  50424. /**
  50425. * Sets the value of the `Start` button
  50426. */
  50427. set buttonStart(value: number);
  50428. /**
  50429. * Gets the value of the `Back` button
  50430. */
  50431. get buttonBack(): number;
  50432. /**
  50433. * Sets the value of the `Back` button
  50434. */
  50435. set buttonBack(value: number);
  50436. /**
  50437. * Gets the value of the `Left` button
  50438. */
  50439. get buttonLB(): number;
  50440. /**
  50441. * Sets the value of the `Left` button
  50442. */
  50443. set buttonLB(value: number);
  50444. /**
  50445. * Gets the value of the `Right` button
  50446. */
  50447. get buttonRB(): number;
  50448. /**
  50449. * Sets the value of the `Right` button
  50450. */
  50451. set buttonRB(value: number);
  50452. /**
  50453. * Gets the value of the Left joystick
  50454. */
  50455. get buttonLeftStick(): number;
  50456. /**
  50457. * Sets the value of the Left joystick
  50458. */
  50459. set buttonLeftStick(value: number);
  50460. /**
  50461. * Gets the value of the Right joystick
  50462. */
  50463. get buttonRightStick(): number;
  50464. /**
  50465. * Sets the value of the Right joystick
  50466. */
  50467. set buttonRightStick(value: number);
  50468. /**
  50469. * Gets the value of D-pad up
  50470. */
  50471. get dPadUp(): number;
  50472. /**
  50473. * Sets the value of D-pad up
  50474. */
  50475. set dPadUp(value: number);
  50476. /**
  50477. * Gets the value of D-pad down
  50478. */
  50479. get dPadDown(): number;
  50480. /**
  50481. * Sets the value of D-pad down
  50482. */
  50483. set dPadDown(value: number);
  50484. /**
  50485. * Gets the value of D-pad left
  50486. */
  50487. get dPadLeft(): number;
  50488. /**
  50489. * Sets the value of D-pad left
  50490. */
  50491. set dPadLeft(value: number);
  50492. /**
  50493. * Gets the value of D-pad right
  50494. */
  50495. get dPadRight(): number;
  50496. /**
  50497. * Sets the value of D-pad right
  50498. */
  50499. set dPadRight(value: number);
  50500. /**
  50501. * Force the gamepad to synchronize with device values
  50502. */
  50503. update(): void;
  50504. /**
  50505. * Disposes the gamepad
  50506. */
  50507. dispose(): void;
  50508. }
  50509. }
  50510. declare module "babylonjs/Gamepads/dualShockGamepad" {
  50511. import { Observable } from "babylonjs/Misc/observable";
  50512. import { Gamepad } from "babylonjs/Gamepads/gamepad";
  50513. /**
  50514. * Defines supported buttons for DualShock compatible gamepads
  50515. */
  50516. export enum DualShockButton {
  50517. /** Cross */
  50518. Cross = 0,
  50519. /** Circle */
  50520. Circle = 1,
  50521. /** Square */
  50522. Square = 2,
  50523. /** Triangle */
  50524. Triangle = 3,
  50525. /** L1 */
  50526. L1 = 4,
  50527. /** R1 */
  50528. R1 = 5,
  50529. /** Share */
  50530. Share = 8,
  50531. /** Options */
  50532. Options = 9,
  50533. /** Left stick */
  50534. LeftStick = 10,
  50535. /** Right stick */
  50536. RightStick = 11
  50537. }
  50538. /** Defines values for DualShock DPad */
  50539. export enum DualShockDpad {
  50540. /** Up */
  50541. Up = 12,
  50542. /** Down */
  50543. Down = 13,
  50544. /** Left */
  50545. Left = 14,
  50546. /** Right */
  50547. Right = 15
  50548. }
  50549. /**
  50550. * Defines a DualShock gamepad
  50551. */
  50552. export class DualShockPad extends Gamepad {
  50553. private _leftTrigger;
  50554. private _rightTrigger;
  50555. private _onlefttriggerchanged;
  50556. private _onrighttriggerchanged;
  50557. private _onbuttondown;
  50558. private _onbuttonup;
  50559. private _ondpaddown;
  50560. private _ondpadup;
  50561. /** Observable raised when a button is pressed */
  50562. onButtonDownObservable: Observable<DualShockButton>;
  50563. /** Observable raised when a button is released */
  50564. onButtonUpObservable: Observable<DualShockButton>;
  50565. /** Observable raised when a pad is pressed */
  50566. onPadDownObservable: Observable<DualShockDpad>;
  50567. /** Observable raised when a pad is released */
  50568. onPadUpObservable: Observable<DualShockDpad>;
  50569. private _buttonCross;
  50570. private _buttonCircle;
  50571. private _buttonSquare;
  50572. private _buttonTriangle;
  50573. private _buttonShare;
  50574. private _buttonOptions;
  50575. private _buttonL1;
  50576. private _buttonR1;
  50577. private _buttonLeftStick;
  50578. private _buttonRightStick;
  50579. private _dPadUp;
  50580. private _dPadDown;
  50581. private _dPadLeft;
  50582. private _dPadRight;
  50583. /**
  50584. * Creates a new DualShock gamepad object
  50585. * @param id defines the id of this gamepad
  50586. * @param index defines its index
  50587. * @param gamepad defines the internal HTML gamepad object
  50588. */
  50589. constructor(id: string, index: number, gamepad: any);
  50590. /**
  50591. * Defines the callback to call when left trigger is pressed
  50592. * @param callback defines the callback to use
  50593. */
  50594. onlefttriggerchanged(callback: (value: number) => void): void;
  50595. /**
  50596. * Defines the callback to call when right trigger is pressed
  50597. * @param callback defines the callback to use
  50598. */
  50599. onrighttriggerchanged(callback: (value: number) => void): void;
  50600. /**
  50601. * Gets the left trigger value
  50602. */
  50603. get leftTrigger(): number;
  50604. /**
  50605. * Sets the left trigger value
  50606. */
  50607. set leftTrigger(newValue: number);
  50608. /**
  50609. * Gets the right trigger value
  50610. */
  50611. get rightTrigger(): number;
  50612. /**
  50613. * Sets the right trigger value
  50614. */
  50615. set rightTrigger(newValue: number);
  50616. /**
  50617. * Defines the callback to call when a button is pressed
  50618. * @param callback defines the callback to use
  50619. */
  50620. onbuttondown(callback: (buttonPressed: DualShockButton) => void): void;
  50621. /**
  50622. * Defines the callback to call when a button is released
  50623. * @param callback defines the callback to use
  50624. */
  50625. onbuttonup(callback: (buttonReleased: DualShockButton) => void): void;
  50626. /**
  50627. * Defines the callback to call when a pad is pressed
  50628. * @param callback defines the callback to use
  50629. */
  50630. ondpaddown(callback: (dPadPressed: DualShockDpad) => void): void;
  50631. /**
  50632. * Defines the callback to call when a pad is released
  50633. * @param callback defines the callback to use
  50634. */
  50635. ondpadup(callback: (dPadReleased: DualShockDpad) => void): void;
  50636. private _setButtonValue;
  50637. private _setDPadValue;
  50638. /**
  50639. * Gets the value of the `Cross` button
  50640. */
  50641. get buttonCross(): number;
  50642. /**
  50643. * Sets the value of the `Cross` button
  50644. */
  50645. set buttonCross(value: number);
  50646. /**
  50647. * Gets the value of the `Circle` button
  50648. */
  50649. get buttonCircle(): number;
  50650. /**
  50651. * Sets the value of the `Circle` button
  50652. */
  50653. set buttonCircle(value: number);
  50654. /**
  50655. * Gets the value of the `Square` button
  50656. */
  50657. get buttonSquare(): number;
  50658. /**
  50659. * Sets the value of the `Square` button
  50660. */
  50661. set buttonSquare(value: number);
  50662. /**
  50663. * Gets the value of the `Triangle` button
  50664. */
  50665. get buttonTriangle(): number;
  50666. /**
  50667. * Sets the value of the `Triangle` button
  50668. */
  50669. set buttonTriangle(value: number);
  50670. /**
  50671. * Gets the value of the `Options` button
  50672. */
  50673. get buttonOptions(): number;
  50674. /**
  50675. * Sets the value of the `Options` button
  50676. */
  50677. set buttonOptions(value: number);
  50678. /**
  50679. * Gets the value of the `Share` button
  50680. */
  50681. get buttonShare(): number;
  50682. /**
  50683. * Sets the value of the `Share` button
  50684. */
  50685. set buttonShare(value: number);
  50686. /**
  50687. * Gets the value of the `L1` button
  50688. */
  50689. get buttonL1(): number;
  50690. /**
  50691. * Sets the value of the `L1` button
  50692. */
  50693. set buttonL1(value: number);
  50694. /**
  50695. * Gets the value of the `R1` button
  50696. */
  50697. get buttonR1(): number;
  50698. /**
  50699. * Sets the value of the `R1` button
  50700. */
  50701. set buttonR1(value: number);
  50702. /**
  50703. * Gets the value of the Left joystick
  50704. */
  50705. get buttonLeftStick(): number;
  50706. /**
  50707. * Sets the value of the Left joystick
  50708. */
  50709. set buttonLeftStick(value: number);
  50710. /**
  50711. * Gets the value of the Right joystick
  50712. */
  50713. get buttonRightStick(): number;
  50714. /**
  50715. * Sets the value of the Right joystick
  50716. */
  50717. set buttonRightStick(value: number);
  50718. /**
  50719. * Gets the value of D-pad up
  50720. */
  50721. get dPadUp(): number;
  50722. /**
  50723. * Sets the value of D-pad up
  50724. */
  50725. set dPadUp(value: number);
  50726. /**
  50727. * Gets the value of D-pad down
  50728. */
  50729. get dPadDown(): number;
  50730. /**
  50731. * Sets the value of D-pad down
  50732. */
  50733. set dPadDown(value: number);
  50734. /**
  50735. * Gets the value of D-pad left
  50736. */
  50737. get dPadLeft(): number;
  50738. /**
  50739. * Sets the value of D-pad left
  50740. */
  50741. set dPadLeft(value: number);
  50742. /**
  50743. * Gets the value of D-pad right
  50744. */
  50745. get dPadRight(): number;
  50746. /**
  50747. * Sets the value of D-pad right
  50748. */
  50749. set dPadRight(value: number);
  50750. /**
  50751. * Force the gamepad to synchronize with device values
  50752. */
  50753. update(): void;
  50754. /**
  50755. * Disposes the gamepad
  50756. */
  50757. dispose(): void;
  50758. }
  50759. }
  50760. declare module "babylonjs/Gamepads/gamepadManager" {
  50761. import { Observable } from "babylonjs/Misc/observable";
  50762. import { Nullable } from "babylonjs/types";
  50763. import { Scene } from "babylonjs/scene";
  50764. import { Gamepad } from "babylonjs/Gamepads/gamepad";
  50765. /**
  50766. * Manager for handling gamepads
  50767. */
  50768. export class GamepadManager {
  50769. private _scene?;
  50770. private _babylonGamepads;
  50771. private _oneGamepadConnected;
  50772. /** @hidden */
  50773. _isMonitoring: boolean;
  50774. private _gamepadEventSupported;
  50775. private _gamepadSupport?;
  50776. /**
  50777. * observable to be triggered when the gamepad controller has been connected
  50778. */
  50779. onGamepadConnectedObservable: Observable<Gamepad>;
  50780. /**
  50781. * observable to be triggered when the gamepad controller has been disconnected
  50782. */
  50783. onGamepadDisconnectedObservable: Observable<Gamepad>;
  50784. private _onGamepadConnectedEvent;
  50785. private _onGamepadDisconnectedEvent;
  50786. /**
  50787. * Initializes the gamepad manager
  50788. * @param _scene BabylonJS scene
  50789. */
  50790. constructor(_scene?: Scene | undefined);
  50791. /**
  50792. * The gamepads in the game pad manager
  50793. */
  50794. get gamepads(): Gamepad[];
  50795. /**
  50796. * Get the gamepad controllers based on type
  50797. * @param type The type of gamepad controller
  50798. * @returns Nullable gamepad
  50799. */
  50800. getGamepadByType(type?: number): Nullable<Gamepad>;
  50801. /**
  50802. * Disposes the gamepad manager
  50803. */
  50804. dispose(): void;
  50805. private _addNewGamepad;
  50806. private _startMonitoringGamepads;
  50807. private _stopMonitoringGamepads;
  50808. /** @hidden */
  50809. _checkGamepadsStatus(): void;
  50810. private _updateGamepadObjects;
  50811. }
  50812. }
  50813. declare module "babylonjs/Gamepads/gamepadSceneComponent" {
  50814. import { Nullable } from "babylonjs/types";
  50815. import { Scene } from "babylonjs/scene";
  50816. import { ISceneComponent } from "babylonjs/sceneComponent";
  50817. import { GamepadManager } from "babylonjs/Gamepads/gamepadManager";
  50818. module "babylonjs/scene" {
  50819. interface Scene {
  50820. /** @hidden */
  50821. _gamepadManager: Nullable<GamepadManager>;
  50822. /**
  50823. * Gets the gamepad manager associated with the scene
  50824. * @see https://doc.babylonjs.com/how_to/how_to_use_gamepads
  50825. */
  50826. gamepadManager: GamepadManager;
  50827. }
  50828. }
  50829. module "babylonjs/Cameras/freeCameraInputsManager" {
  50830. /**
  50831. * Interface representing a free camera inputs manager
  50832. */
  50833. interface FreeCameraInputsManager {
  50834. /**
  50835. * Adds gamepad input support to the FreeCameraInputsManager.
  50836. * @returns the FreeCameraInputsManager
  50837. */
  50838. addGamepad(): FreeCameraInputsManager;
  50839. }
  50840. }
  50841. module "babylonjs/Cameras/arcRotateCameraInputsManager" {
  50842. /**
  50843. * Interface representing an arc rotate camera inputs manager
  50844. */
  50845. interface ArcRotateCameraInputsManager {
  50846. /**
  50847. * Adds gamepad input support to the ArcRotateCamera InputManager.
  50848. * @returns the camera inputs manager
  50849. */
  50850. addGamepad(): ArcRotateCameraInputsManager;
  50851. }
  50852. }
  50853. /**
  50854. * Defines the gamepad scene component responsible to manage gamepads in a given scene
  50855. */
  50856. export class GamepadSystemSceneComponent implements ISceneComponent {
  50857. /**
  50858. * The component name helpfull to identify the component in the list of scene components.
  50859. */
  50860. readonly name: string;
  50861. /**
  50862. * The scene the component belongs to.
  50863. */
  50864. scene: Scene;
  50865. /**
  50866. * Creates a new instance of the component for the given scene
  50867. * @param scene Defines the scene to register the component in
  50868. */
  50869. constructor(scene: Scene);
  50870. /**
  50871. * Registers the component in a given scene
  50872. */
  50873. register(): void;
  50874. /**
  50875. * Rebuilds the elements related to this component in case of
  50876. * context lost for instance.
  50877. */
  50878. rebuild(): void;
  50879. /**
  50880. * Disposes the component and the associated ressources
  50881. */
  50882. dispose(): void;
  50883. private _beforeCameraUpdate;
  50884. }
  50885. }
  50886. declare module "babylonjs/Cameras/universalCamera" {
  50887. import { TouchCamera } from "babylonjs/Cameras/touchCamera";
  50888. import { Scene } from "babylonjs/scene";
  50889. import { Vector3 } from "babylonjs/Maths/math.vector";
  50890. import "babylonjs/Gamepads/gamepadSceneComponent";
  50891. /**
  50892. * 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,
  50893. * which still works and will still be found in many Playgrounds.
  50894. * @see https://doc.babylonjs.com/features/cameras#universal-camera
  50895. */
  50896. export class UniversalCamera extends TouchCamera {
  50897. /**
  50898. * Defines the gamepad rotation sensiblity.
  50899. * This is the threshold from when rotation starts to be accounted for to prevent jittering.
  50900. */
  50901. get gamepadAngularSensibility(): number;
  50902. set gamepadAngularSensibility(value: number);
  50903. /**
  50904. * Defines the gamepad move sensiblity.
  50905. * This is the threshold from when moving starts to be accounted for for to prevent jittering.
  50906. */
  50907. get gamepadMoveSensibility(): number;
  50908. set gamepadMoveSensibility(value: number);
  50909. /**
  50910. * 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,
  50911. * which still works and will still be found in many Playgrounds.
  50912. * @see https://doc.babylonjs.com/features/cameras#universal-camera
  50913. * @param name Define the name of the camera in the scene
  50914. * @param position Define the start position of the camera in the scene
  50915. * @param scene Define the scene the camera belongs to
  50916. */
  50917. constructor(name: string, position: Vector3, scene: Scene);
  50918. /**
  50919. * Gets the current object class name.
  50920. * @return the class name
  50921. */
  50922. getClassName(): string;
  50923. }
  50924. }
  50925. declare module "babylonjs/Cameras/gamepadCamera" {
  50926. import { UniversalCamera } from "babylonjs/Cameras/universalCamera";
  50927. import { Scene } from "babylonjs/scene";
  50928. import { Vector3 } from "babylonjs/Maths/math.vector";
  50929. /**
  50930. * This represents a FPS type of camera. This is only here for back compat purpose.
  50931. * Please use the UniversalCamera instead as both are identical.
  50932. * @see https://doc.babylonjs.com/features/cameras#universal-camera
  50933. */
  50934. export class GamepadCamera extends UniversalCamera {
  50935. /**
  50936. * Instantiates a new Gamepad Camera
  50937. * This represents a FPS type of camera. This is only here for back compat purpose.
  50938. * Please use the UniversalCamera instead as both are identical.
  50939. * @see https://doc.babylonjs.com/features/cameras#universal-camera
  50940. * @param name Define the name of the camera in the scene
  50941. * @param position Define the start position of the camera in the scene
  50942. * @param scene Define the scene the camera belongs to
  50943. */
  50944. constructor(name: string, position: Vector3, scene: Scene);
  50945. /**
  50946. * Gets the current object class name.
  50947. * @return the class name
  50948. */
  50949. getClassName(): string;
  50950. }
  50951. }
  50952. declare module "babylonjs/Shaders/pass.fragment" {
  50953. /** @hidden */
  50954. export var passPixelShader: {
  50955. name: string;
  50956. shader: string;
  50957. };
  50958. }
  50959. declare module "babylonjs/Shaders/passCube.fragment" {
  50960. /** @hidden */
  50961. export var passCubePixelShader: {
  50962. name: string;
  50963. shader: string;
  50964. };
  50965. }
  50966. declare module "babylonjs/PostProcesses/passPostProcess" {
  50967. import { Nullable } from "babylonjs/types";
  50968. import { Camera } from "babylonjs/Cameras/camera";
  50969. import { PostProcess, PostProcessOptions } from "babylonjs/PostProcesses/postProcess";
  50970. import { Engine } from "babylonjs/Engines/engine";
  50971. import "babylonjs/Shaders/pass.fragment";
  50972. import "babylonjs/Shaders/passCube.fragment";
  50973. import { Scene } from "babylonjs/scene";
  50974. /**
  50975. * PassPostProcess which produces an output the same as it's input
  50976. */
  50977. export class PassPostProcess extends PostProcess {
  50978. /**
  50979. * Gets a string identifying the name of the class
  50980. * @returns "PassPostProcess" string
  50981. */
  50982. getClassName(): string;
  50983. /**
  50984. * Creates the PassPostProcess
  50985. * @param name The name of the effect.
  50986. * @param options The required width/height ratio to downsize to before computing the render pass.
  50987. * @param camera The camera to apply the render pass to.
  50988. * @param samplingMode The sampling mode to be used when computing the pass. (default: 0)
  50989. * @param engine The engine which the post process will be applied. (default: current engine)
  50990. * @param reusable If the post process can be reused on the same frame. (default: false)
  50991. * @param textureType The type of texture to be used when performing the post processing.
  50992. * @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)
  50993. */
  50994. constructor(name: string, options: number | PostProcessOptions, camera?: Nullable<Camera>, samplingMode?: number, engine?: Engine, reusable?: boolean, textureType?: number, blockCompilation?: boolean);
  50995. /** @hidden */
  50996. static _Parse(parsedPostProcess: any, targetCamera: Camera, scene: Scene, rootUrl: string): PassPostProcess;
  50997. }
  50998. /**
  50999. * PassCubePostProcess which produces an output the same as it's input (which must be a cube texture)
  51000. */
  51001. export class PassCubePostProcess extends PostProcess {
  51002. private _face;
  51003. /**
  51004. * Gets or sets the cube face to display.
  51005. * * 0 is +X
  51006. * * 1 is -X
  51007. * * 2 is +Y
  51008. * * 3 is -Y
  51009. * * 4 is +Z
  51010. * * 5 is -Z
  51011. */
  51012. get face(): number;
  51013. set face(value: number);
  51014. /**
  51015. * Gets a string identifying the name of the class
  51016. * @returns "PassCubePostProcess" string
  51017. */
  51018. getClassName(): string;
  51019. /**
  51020. * Creates the PassCubePostProcess
  51021. * @param name The name of the effect.
  51022. * @param options The required width/height ratio to downsize to before computing the render pass.
  51023. * @param camera The camera to apply the render pass to.
  51024. * @param samplingMode The sampling mode to be used when computing the pass. (default: 0)
  51025. * @param engine The engine which the post process will be applied. (default: current engine)
  51026. * @param reusable If the post process can be reused on the same frame. (default: false)
  51027. * @param textureType The type of texture to be used when performing the post processing.
  51028. * @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)
  51029. */
  51030. constructor(name: string, options: number | PostProcessOptions, camera?: Nullable<Camera>, samplingMode?: number, engine?: Engine, reusable?: boolean, textureType?: number, blockCompilation?: boolean);
  51031. /** @hidden */
  51032. static _Parse(parsedPostProcess: any, targetCamera: Camera, scene: Scene, rootUrl: string): PassCubePostProcess;
  51033. }
  51034. }
  51035. declare module "babylonjs/Shaders/anaglyph.fragment" {
  51036. /** @hidden */
  51037. export var anaglyphPixelShader: {
  51038. name: string;
  51039. shader: string;
  51040. };
  51041. }
  51042. declare module "babylonjs/PostProcesses/anaglyphPostProcess" {
  51043. import { Engine } from "babylonjs/Engines/engine";
  51044. import { PostProcess, PostProcessOptions } from "babylonjs/PostProcesses/postProcess";
  51045. import { Camera } from "babylonjs/Cameras/camera";
  51046. import "babylonjs/Shaders/anaglyph.fragment";
  51047. /**
  51048. * Postprocess used to generate anaglyphic rendering
  51049. */
  51050. export class AnaglyphPostProcess extends PostProcess {
  51051. private _passedProcess;
  51052. /**
  51053. * Gets a string identifying the name of the class
  51054. * @returns "AnaglyphPostProcess" string
  51055. */
  51056. getClassName(): string;
  51057. /**
  51058. * Creates a new AnaglyphPostProcess
  51059. * @param name defines postprocess name
  51060. * @param options defines creation options or target ratio scale
  51061. * @param rigCameras defines cameras using this postprocess
  51062. * @param samplingMode defines required sampling mode (BABYLON.Texture.NEAREST_SAMPLINGMODE by default)
  51063. * @param engine defines hosting engine
  51064. * @param reusable defines if the postprocess will be reused multiple times per frame
  51065. */
  51066. constructor(name: string, options: number | PostProcessOptions, rigCameras: Camera[], samplingMode?: number, engine?: Engine, reusable?: boolean);
  51067. }
  51068. }
  51069. declare module "babylonjs/Cameras/RigModes/stereoscopicAnaglyphRigMode" { }
  51070. declare module "babylonjs/Cameras/Stereoscopic/anaglyphArcRotateCamera" {
  51071. import { ArcRotateCamera } from "babylonjs/Cameras/arcRotateCamera";
  51072. import { Scene } from "babylonjs/scene";
  51073. import { Vector3 } from "babylonjs/Maths/math.vector";
  51074. import "babylonjs/Cameras/RigModes/stereoscopicAnaglyphRigMode";
  51075. /**
  51076. * Camera used to simulate anaglyphic rendering (based on ArcRotateCamera)
  51077. * @see https://doc.babylonjs.com/features/cameras#anaglyph-cameras
  51078. */
  51079. export class AnaglyphArcRotateCamera extends ArcRotateCamera {
  51080. /**
  51081. * Creates a new AnaglyphArcRotateCamera
  51082. * @param name defines camera name
  51083. * @param alpha defines alpha angle (in radians)
  51084. * @param beta defines beta angle (in radians)
  51085. * @param radius defines radius
  51086. * @param target defines camera target
  51087. * @param interaxialDistance defines distance between each color axis
  51088. * @param scene defines the hosting scene
  51089. */
  51090. constructor(name: string, alpha: number, beta: number, radius: number, target: Vector3, interaxialDistance: number, scene: Scene);
  51091. /**
  51092. * Gets camera class name
  51093. * @returns AnaglyphArcRotateCamera
  51094. */
  51095. getClassName(): string;
  51096. }
  51097. }
  51098. declare module "babylonjs/Cameras/Stereoscopic/anaglyphFreeCamera" {
  51099. import { FreeCamera } from "babylonjs/Cameras/freeCamera";
  51100. import { Scene } from "babylonjs/scene";
  51101. import { Vector3 } from "babylonjs/Maths/math.vector";
  51102. import "babylonjs/Cameras/RigModes/stereoscopicAnaglyphRigMode";
  51103. /**
  51104. * Camera used to simulate anaglyphic rendering (based on FreeCamera)
  51105. * @see https://doc.babylonjs.com/features/cameras#anaglyph-cameras
  51106. */
  51107. export class AnaglyphFreeCamera extends FreeCamera {
  51108. /**
  51109. * Creates a new AnaglyphFreeCamera
  51110. * @param name defines camera name
  51111. * @param position defines initial position
  51112. * @param interaxialDistance defines distance between each color axis
  51113. * @param scene defines the hosting scene
  51114. */
  51115. constructor(name: string, position: Vector3, interaxialDistance: number, scene: Scene);
  51116. /**
  51117. * Gets camera class name
  51118. * @returns AnaglyphFreeCamera
  51119. */
  51120. getClassName(): string;
  51121. }
  51122. }
  51123. declare module "babylonjs/Cameras/Stereoscopic/anaglyphGamepadCamera" {
  51124. import { GamepadCamera } from "babylonjs/Cameras/gamepadCamera";
  51125. import { Scene } from "babylonjs/scene";
  51126. import { Vector3 } from "babylonjs/Maths/math.vector";
  51127. import "babylonjs/Cameras/RigModes/stereoscopicAnaglyphRigMode";
  51128. /**
  51129. * Camera used to simulate anaglyphic rendering (based on GamepadCamera)
  51130. * @see https://doc.babylonjs.com/features/cameras#anaglyph-cameras
  51131. */
  51132. export class AnaglyphGamepadCamera extends GamepadCamera {
  51133. /**
  51134. * Creates a new AnaglyphGamepadCamera
  51135. * @param name defines camera name
  51136. * @param position defines initial position
  51137. * @param interaxialDistance defines distance between each color axis
  51138. * @param scene defines the hosting scene
  51139. */
  51140. constructor(name: string, position: Vector3, interaxialDistance: number, scene: Scene);
  51141. /**
  51142. * Gets camera class name
  51143. * @returns AnaglyphGamepadCamera
  51144. */
  51145. getClassName(): string;
  51146. }
  51147. }
  51148. declare module "babylonjs/Cameras/Stereoscopic/anaglyphUniversalCamera" {
  51149. import { UniversalCamera } from "babylonjs/Cameras/universalCamera";
  51150. import { Scene } from "babylonjs/scene";
  51151. import { Vector3 } from "babylonjs/Maths/math.vector";
  51152. import "babylonjs/Cameras/RigModes/stereoscopicAnaglyphRigMode";
  51153. /**
  51154. * Camera used to simulate anaglyphic rendering (based on UniversalCamera)
  51155. * @see https://doc.babylonjs.com/features/cameras#anaglyph-cameras
  51156. */
  51157. export class AnaglyphUniversalCamera extends UniversalCamera {
  51158. /**
  51159. * Creates a new AnaglyphUniversalCamera
  51160. * @param name defines camera name
  51161. * @param position defines initial position
  51162. * @param interaxialDistance defines distance between each color axis
  51163. * @param scene defines the hosting scene
  51164. */
  51165. constructor(name: string, position: Vector3, interaxialDistance: number, scene: Scene);
  51166. /**
  51167. * Gets camera class name
  51168. * @returns AnaglyphUniversalCamera
  51169. */
  51170. getClassName(): string;
  51171. }
  51172. }
  51173. declare module "babylonjs/Cameras/RigModes/stereoscopicRigMode" { }
  51174. declare module "babylonjs/Cameras/Stereoscopic/stereoscopicArcRotateCamera" {
  51175. import { ArcRotateCamera } from "babylonjs/Cameras/arcRotateCamera";
  51176. import { Scene } from "babylonjs/scene";
  51177. import { Vector3 } from "babylonjs/Maths/math.vector";
  51178. import "babylonjs/Cameras/RigModes/stereoscopicRigMode";
  51179. /**
  51180. * Camera used to simulate stereoscopic rendering (based on ArcRotateCamera)
  51181. * @see https://doc.babylonjs.com/features/cameras
  51182. */
  51183. export class StereoscopicArcRotateCamera extends ArcRotateCamera {
  51184. /**
  51185. * Creates a new StereoscopicArcRotateCamera
  51186. * @param name defines camera name
  51187. * @param alpha defines alpha angle (in radians)
  51188. * @param beta defines beta angle (in radians)
  51189. * @param radius defines radius
  51190. * @param target defines camera target
  51191. * @param interaxialDistance defines distance between each color axis
  51192. * @param isStereoscopicSideBySide defines is stereoscopic is done side by side or over under
  51193. * @param scene defines the hosting scene
  51194. */
  51195. constructor(name: string, alpha: number, beta: number, radius: number, target: Vector3, interaxialDistance: number, isStereoscopicSideBySide: boolean, scene: Scene);
  51196. /**
  51197. * Gets camera class name
  51198. * @returns StereoscopicArcRotateCamera
  51199. */
  51200. getClassName(): string;
  51201. }
  51202. }
  51203. declare module "babylonjs/Cameras/Stereoscopic/stereoscopicFreeCamera" {
  51204. import { FreeCamera } from "babylonjs/Cameras/freeCamera";
  51205. import { Scene } from "babylonjs/scene";
  51206. import { Vector3 } from "babylonjs/Maths/math.vector";
  51207. import "babylonjs/Cameras/RigModes/stereoscopicRigMode";
  51208. /**
  51209. * Camera used to simulate stereoscopic rendering (based on FreeCamera)
  51210. * @see https://doc.babylonjs.com/features/cameras
  51211. */
  51212. export class StereoscopicFreeCamera extends FreeCamera {
  51213. /**
  51214. * Creates a new StereoscopicFreeCamera
  51215. * @param name defines camera name
  51216. * @param position defines initial position
  51217. * @param interaxialDistance defines distance between each color axis
  51218. * @param isStereoscopicSideBySide defines is stereoscopic is done side by side or over under
  51219. * @param scene defines the hosting scene
  51220. */
  51221. constructor(name: string, position: Vector3, interaxialDistance: number, isStereoscopicSideBySide: boolean, scene: Scene);
  51222. /**
  51223. * Gets camera class name
  51224. * @returns StereoscopicFreeCamera
  51225. */
  51226. getClassName(): string;
  51227. }
  51228. }
  51229. declare module "babylonjs/Cameras/Stereoscopic/stereoscopicGamepadCamera" {
  51230. import { GamepadCamera } from "babylonjs/Cameras/gamepadCamera";
  51231. import { Scene } from "babylonjs/scene";
  51232. import { Vector3 } from "babylonjs/Maths/math.vector";
  51233. import "babylonjs/Cameras/RigModes/stereoscopicRigMode";
  51234. /**
  51235. * Camera used to simulate stereoscopic rendering (based on GamepadCamera)
  51236. * @see https://doc.babylonjs.com/features/cameras
  51237. */
  51238. export class StereoscopicGamepadCamera extends GamepadCamera {
  51239. /**
  51240. * Creates a new StereoscopicGamepadCamera
  51241. * @param name defines camera name
  51242. * @param position defines initial position
  51243. * @param interaxialDistance defines distance between each color axis
  51244. * @param isStereoscopicSideBySide defines is stereoscopic is done side by side or over under
  51245. * @param scene defines the hosting scene
  51246. */
  51247. constructor(name: string, position: Vector3, interaxialDistance: number, isStereoscopicSideBySide: boolean, scene: Scene);
  51248. /**
  51249. * Gets camera class name
  51250. * @returns StereoscopicGamepadCamera
  51251. */
  51252. getClassName(): string;
  51253. }
  51254. }
  51255. declare module "babylonjs/Cameras/Stereoscopic/stereoscopicUniversalCamera" {
  51256. import { UniversalCamera } from "babylonjs/Cameras/universalCamera";
  51257. import { Scene } from "babylonjs/scene";
  51258. import { Vector3 } from "babylonjs/Maths/math.vector";
  51259. import "babylonjs/Cameras/RigModes/stereoscopicRigMode";
  51260. /**
  51261. * Camera used to simulate stereoscopic rendering (based on UniversalCamera)
  51262. * @see https://doc.babylonjs.com/features/cameras
  51263. */
  51264. export class StereoscopicUniversalCamera extends UniversalCamera {
  51265. /**
  51266. * Creates a new StereoscopicUniversalCamera
  51267. * @param name defines camera name
  51268. * @param position defines initial position
  51269. * @param interaxialDistance defines distance between each color axis
  51270. * @param isStereoscopicSideBySide defines is stereoscopic is done side by side or over under
  51271. * @param scene defines the hosting scene
  51272. */
  51273. constructor(name: string, position: Vector3, interaxialDistance: number, isStereoscopicSideBySide: boolean, scene: Scene);
  51274. /**
  51275. * Gets camera class name
  51276. * @returns StereoscopicUniversalCamera
  51277. */
  51278. getClassName(): string;
  51279. }
  51280. }
  51281. declare module "babylonjs/Cameras/Stereoscopic/index" {
  51282. export * from "babylonjs/Cameras/Stereoscopic/anaglyphArcRotateCamera";
  51283. export * from "babylonjs/Cameras/Stereoscopic/anaglyphFreeCamera";
  51284. export * from "babylonjs/Cameras/Stereoscopic/anaglyphGamepadCamera";
  51285. export * from "babylonjs/Cameras/Stereoscopic/anaglyphUniversalCamera";
  51286. export * from "babylonjs/Cameras/Stereoscopic/stereoscopicArcRotateCamera";
  51287. export * from "babylonjs/Cameras/Stereoscopic/stereoscopicFreeCamera";
  51288. export * from "babylonjs/Cameras/Stereoscopic/stereoscopicGamepadCamera";
  51289. export * from "babylonjs/Cameras/Stereoscopic/stereoscopicUniversalCamera";
  51290. }
  51291. declare module "babylonjs/Cameras/virtualJoysticksCamera" {
  51292. import { FreeCamera } from "babylonjs/Cameras/freeCamera";
  51293. import { Scene } from "babylonjs/scene";
  51294. import { Vector3 } from "babylonjs/Maths/math.vector";
  51295. import "babylonjs/Cameras/Inputs/freeCameraVirtualJoystickInput";
  51296. /**
  51297. * This represents a free type of camera. It can be useful in First Person Shooter game for instance.
  51298. * It is identical to the Free Camera and simply adds by default a virtual joystick.
  51299. * Virtual Joysticks are on-screen 2D graphics that are used to control the camera or other scene items.
  51300. * @see https://doc.babylonjs.com/features/cameras#virtual-joysticks-camera
  51301. */
  51302. export class VirtualJoysticksCamera extends FreeCamera {
  51303. /**
  51304. * Intantiates a VirtualJoysticksCamera. It can be useful in First Person Shooter game for instance.
  51305. * It is identical to the Free Camera and simply adds by default a virtual joystick.
  51306. * Virtual Joysticks are on-screen 2D graphics that are used to control the camera or other scene items.
  51307. * @see https://doc.babylonjs.com/features/cameras#virtual-joysticks-camera
  51308. * @param name Define the name of the camera in the scene
  51309. * @param position Define the start position of the camera in the scene
  51310. * @param scene Define the scene the camera belongs to
  51311. */
  51312. constructor(name: string, position: Vector3, scene: Scene);
  51313. /**
  51314. * Gets the current object class name.
  51315. * @return the class name
  51316. */
  51317. getClassName(): string;
  51318. }
  51319. }
  51320. declare module "babylonjs/Cameras/VR/vrCameraMetrics" {
  51321. import { Matrix } from "babylonjs/Maths/math.vector";
  51322. /**
  51323. * This represents all the required metrics to create a VR camera.
  51324. * @see https://doc.babylonjs.com/babylon101/cameras#device-orientation-camera
  51325. */
  51326. export class VRCameraMetrics {
  51327. /**
  51328. * Define the horizontal resolution off the screen.
  51329. */
  51330. hResolution: number;
  51331. /**
  51332. * Define the vertical resolution off the screen.
  51333. */
  51334. vResolution: number;
  51335. /**
  51336. * Define the horizontal screen size.
  51337. */
  51338. hScreenSize: number;
  51339. /**
  51340. * Define the vertical screen size.
  51341. */
  51342. vScreenSize: number;
  51343. /**
  51344. * Define the vertical screen center position.
  51345. */
  51346. vScreenCenter: number;
  51347. /**
  51348. * Define the distance of the eyes to the screen.
  51349. */
  51350. eyeToScreenDistance: number;
  51351. /**
  51352. * Define the distance between both lenses
  51353. */
  51354. lensSeparationDistance: number;
  51355. /**
  51356. * Define the distance between both viewer's eyes.
  51357. */
  51358. interpupillaryDistance: number;
  51359. /**
  51360. * Define the distortion factor of the VR postprocess.
  51361. * Please, touch with care.
  51362. */
  51363. distortionK: number[];
  51364. /**
  51365. * Define the chromatic aberration correction factors for the VR post process.
  51366. */
  51367. chromaAbCorrection: number[];
  51368. /**
  51369. * Define the scale factor of the post process.
  51370. * The smaller the better but the slower.
  51371. */
  51372. postProcessScaleFactor: number;
  51373. /**
  51374. * Define an offset for the lens center.
  51375. */
  51376. lensCenterOffset: number;
  51377. /**
  51378. * Define if the current vr camera should compensate the distortion of the lense or not.
  51379. */
  51380. compensateDistortion: boolean;
  51381. /**
  51382. * Defines if multiview should be enabled when rendering (Default: false)
  51383. */
  51384. multiviewEnabled: boolean;
  51385. /**
  51386. * Gets the rendering aspect ratio based on the provided resolutions.
  51387. */
  51388. get aspectRatio(): number;
  51389. /**
  51390. * Gets the aspect ratio based on the FOV, scale factors, and real screen sizes.
  51391. */
  51392. get aspectRatioFov(): number;
  51393. /**
  51394. * @hidden
  51395. */
  51396. get leftHMatrix(): Matrix;
  51397. /**
  51398. * @hidden
  51399. */
  51400. get rightHMatrix(): Matrix;
  51401. /**
  51402. * @hidden
  51403. */
  51404. get leftPreViewMatrix(): Matrix;
  51405. /**
  51406. * @hidden
  51407. */
  51408. get rightPreViewMatrix(): Matrix;
  51409. /**
  51410. * Get the default VRMetrics based on the most generic setup.
  51411. * @returns the default vr metrics
  51412. */
  51413. static GetDefault(): VRCameraMetrics;
  51414. }
  51415. }
  51416. declare module "babylonjs/Shaders/vrDistortionCorrection.fragment" {
  51417. /** @hidden */
  51418. export var vrDistortionCorrectionPixelShader: {
  51419. name: string;
  51420. shader: string;
  51421. };
  51422. }
  51423. declare module "babylonjs/PostProcesses/vrDistortionCorrectionPostProcess" {
  51424. import { Camera } from "babylonjs/Cameras/camera";
  51425. import { VRCameraMetrics } from "babylonjs/Cameras/VR/vrCameraMetrics";
  51426. import { PostProcess } from "babylonjs/PostProcesses/postProcess";
  51427. import "babylonjs/Shaders/vrDistortionCorrection.fragment";
  51428. /**
  51429. * VRDistortionCorrectionPostProcess used for mobile VR
  51430. */
  51431. export class VRDistortionCorrectionPostProcess extends PostProcess {
  51432. private _isRightEye;
  51433. private _distortionFactors;
  51434. private _postProcessScaleFactor;
  51435. private _lensCenterOffset;
  51436. private _scaleIn;
  51437. private _scaleFactor;
  51438. private _lensCenter;
  51439. /**
  51440. * Gets a string identifying the name of the class
  51441. * @returns "VRDistortionCorrectionPostProcess" string
  51442. */
  51443. getClassName(): string;
  51444. /**
  51445. * Initializes the VRDistortionCorrectionPostProcess
  51446. * @param name The name of the effect.
  51447. * @param camera The camera to apply the render pass to.
  51448. * @param isRightEye If this is for the right eye distortion
  51449. * @param vrMetrics All the required metrics for the VR camera
  51450. */
  51451. constructor(name: string, camera: Camera, isRightEye: boolean, vrMetrics: VRCameraMetrics);
  51452. }
  51453. }
  51454. declare module "babylonjs/Cameras/RigModes/vrRigMode" { }
  51455. declare module "babylonjs/Cameras/VR/vrDeviceOrientationArcRotateCamera" {
  51456. import { ArcRotateCamera } from "babylonjs/Cameras/arcRotateCamera";
  51457. import { VRCameraMetrics } from "babylonjs/Cameras/VR/vrCameraMetrics";
  51458. import { Scene } from "babylonjs/scene";
  51459. import { Vector3 } from "babylonjs/Maths/math.vector";
  51460. import "babylonjs/Cameras/Inputs/arcRotateCameraVRDeviceOrientationInput";
  51461. import "babylonjs/Cameras/RigModes/vrRigMode";
  51462. /**
  51463. * Camera used to simulate VR rendering (based on ArcRotateCamera)
  51464. * @see https://doc.babylonjs.com/babylon101/cameras#vr-device-orientation-cameras
  51465. */
  51466. export class VRDeviceOrientationArcRotateCamera extends ArcRotateCamera {
  51467. /**
  51468. * Creates a new VRDeviceOrientationArcRotateCamera
  51469. * @param name defines camera name
  51470. * @param alpha defines the camera rotation along the logitudinal axis
  51471. * @param beta defines the camera rotation along the latitudinal axis
  51472. * @param radius defines the camera distance from its target
  51473. * @param target defines the camera target
  51474. * @param scene defines the scene the camera belongs to
  51475. * @param compensateDistortion defines if the camera needs to compensate the lens distorsion
  51476. * @param vrCameraMetrics defines the vr metrics associated to the camera
  51477. */
  51478. constructor(name: string, alpha: number, beta: number, radius: number, target: Vector3, scene: Scene, compensateDistortion?: boolean, vrCameraMetrics?: VRCameraMetrics);
  51479. /**
  51480. * Gets camera class name
  51481. * @returns VRDeviceOrientationArcRotateCamera
  51482. */
  51483. getClassName(): string;
  51484. }
  51485. }
  51486. declare module "babylonjs/Cameras/VR/vrDeviceOrientationFreeCamera" {
  51487. import { DeviceOrientationCamera } from "babylonjs/Cameras/deviceOrientationCamera";
  51488. import { VRCameraMetrics } from "babylonjs/Cameras/VR/vrCameraMetrics";
  51489. import { Scene } from "babylonjs/scene";
  51490. import { Vector3 } from "babylonjs/Maths/math.vector";
  51491. import "babylonjs/Cameras/RigModes/vrRigMode";
  51492. /**
  51493. * Camera used to simulate VR rendering (based on FreeCamera)
  51494. * @see https://doc.babylonjs.com/babylon101/cameras#vr-device-orientation-cameras
  51495. */
  51496. export class VRDeviceOrientationFreeCamera extends DeviceOrientationCamera {
  51497. /**
  51498. * Creates a new VRDeviceOrientationFreeCamera
  51499. * @param name defines camera name
  51500. * @param position defines the start position of the camera
  51501. * @param scene defines the scene the camera belongs to
  51502. * @param compensateDistortion defines if the camera needs to compensate the lens distorsion
  51503. * @param vrCameraMetrics defines the vr metrics associated to the camera
  51504. */
  51505. constructor(name: string, position: Vector3, scene: Scene, compensateDistortion?: boolean, vrCameraMetrics?: VRCameraMetrics);
  51506. /**
  51507. * Gets camera class name
  51508. * @returns VRDeviceOrientationFreeCamera
  51509. */
  51510. getClassName(): string;
  51511. }
  51512. }
  51513. declare module "babylonjs/Cameras/VR/vrDeviceOrientationGamepadCamera" {
  51514. import { VRDeviceOrientationFreeCamera } from "babylonjs/Cameras/VR/vrDeviceOrientationFreeCamera";
  51515. import { VRCameraMetrics } from "babylonjs/Cameras/VR/vrCameraMetrics";
  51516. import { Scene } from "babylonjs/scene";
  51517. import { Vector3 } from "babylonjs/Maths/math.vector";
  51518. import "babylonjs/Gamepads/gamepadSceneComponent";
  51519. /**
  51520. * Camera used to simulate VR rendering (based on VRDeviceOrientationFreeCamera)
  51521. * @see https://doc.babylonjs.com/babylon101/cameras#vr-device-orientation-cameras
  51522. */
  51523. export class VRDeviceOrientationGamepadCamera extends VRDeviceOrientationFreeCamera {
  51524. /**
  51525. * Creates a new VRDeviceOrientationGamepadCamera
  51526. * @param name defines camera name
  51527. * @param position defines the start position of the camera
  51528. * @param scene defines the scene the camera belongs to
  51529. * @param compensateDistortion defines if the camera needs to compensate the lens distorsion
  51530. * @param vrCameraMetrics defines the vr metrics associated to the camera
  51531. */
  51532. constructor(name: string, position: Vector3, scene: Scene, compensateDistortion?: boolean, vrCameraMetrics?: VRCameraMetrics);
  51533. /**
  51534. * Gets camera class name
  51535. * @returns VRDeviceOrientationGamepadCamera
  51536. */
  51537. getClassName(): string;
  51538. }
  51539. }
  51540. declare module "babylonjs/Materials/Textures/dynamicTexture" {
  51541. import { Scene } from "babylonjs/scene";
  51542. import { Texture } from "babylonjs/Materials/Textures/texture";
  51543. import "babylonjs/Engines/Extensions/engine.dynamicTexture";
  51544. /**
  51545. * A class extending Texture allowing drawing on a texture
  51546. * @see https://doc.babylonjs.com/how_to/dynamictexture
  51547. */
  51548. export class DynamicTexture extends Texture {
  51549. private _generateMipMaps;
  51550. private _canvas;
  51551. private _context;
  51552. /**
  51553. * Creates a DynamicTexture
  51554. * @param name defines the name of the texture
  51555. * @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
  51556. * @param scene defines the scene where you want the texture
  51557. * @param generateMipMaps defines the use of MinMaps or not (default is false)
  51558. * @param samplingMode defines the sampling mode to use (default is Texture.TRILINEAR_SAMPLINGMODE)
  51559. * @param format defines the texture format to use (default is Engine.TEXTUREFORMAT_RGBA)
  51560. * @param invertY defines if the texture needs to be inverted on the y axis during loading
  51561. */
  51562. constructor(name: string, options: any, scene: Scene | null | undefined, generateMipMaps: boolean, samplingMode?: number, format?: number, invertY?: boolean);
  51563. /**
  51564. * Get the current class name of the texture useful for serialization or dynamic coding.
  51565. * @returns "DynamicTexture"
  51566. */
  51567. getClassName(): string;
  51568. /**
  51569. * Gets the current state of canRescale
  51570. */
  51571. get canRescale(): boolean;
  51572. private _recreate;
  51573. /**
  51574. * Scales the texture
  51575. * @param ratio the scale factor to apply to both width and height
  51576. */
  51577. scale(ratio: number): void;
  51578. /**
  51579. * Resizes the texture
  51580. * @param width the new width
  51581. * @param height the new height
  51582. */
  51583. scaleTo(width: number, height: number): void;
  51584. /**
  51585. * Gets the context of the canvas used by the texture
  51586. * @returns the canvas context of the dynamic texture
  51587. */
  51588. getContext(): CanvasRenderingContext2D;
  51589. /**
  51590. * Clears the texture
  51591. */
  51592. clear(): void;
  51593. /**
  51594. * Updates the texture
  51595. * @param invertY defines the direction for the Y axis (default is true - y increases downwards)
  51596. * @param premulAlpha defines if alpha is stored as premultiplied (default is false)
  51597. */
  51598. update(invertY?: boolean, premulAlpha?: boolean): void;
  51599. /**
  51600. * Draws text onto the texture
  51601. * @param text defines the text to be drawn
  51602. * @param x defines the placement of the text from the left
  51603. * @param y defines the placement of the text from the top when invertY is true and from the bottom when false
  51604. * @param font defines the font to be used with font-style, font-size, font-name
  51605. * @param color defines the color used for the text
  51606. * @param clearColor defines the color for the canvas, use null to not overwrite canvas
  51607. * @param invertY defines the direction for the Y axis (default is true - y increases downwards)
  51608. * @param update defines whether texture is immediately update (default is true)
  51609. */
  51610. drawText(text: string, x: number | null | undefined, y: number | null | undefined, font: string, color: string | null, clearColor: string, invertY?: boolean, update?: boolean): void;
  51611. /**
  51612. * Clones the texture
  51613. * @returns the clone of the texture.
  51614. */
  51615. clone(): DynamicTexture;
  51616. /**
  51617. * Serializes the dynamic texture. The scene should be ready before the dynamic texture is serialized
  51618. * @returns a serialized dynamic texture object
  51619. */
  51620. serialize(): any;
  51621. private _IsCanvasElement;
  51622. /** @hidden */
  51623. _rebuild(): void;
  51624. }
  51625. }
  51626. declare module "babylonjs/Meshes/Builders/groundBuilder" {
  51627. import { Scene } from "babylonjs/scene";
  51628. import { Color3 } from "babylonjs/Maths/math.color";
  51629. import { Mesh } from "babylonjs/Meshes/mesh";
  51630. import { GroundMesh } from "babylonjs/Meshes/groundMesh";
  51631. import { Nullable } from "babylonjs/types";
  51632. /**
  51633. * Class containing static functions to help procedurally build meshes
  51634. */
  51635. export class GroundBuilder {
  51636. /**
  51637. * Creates a ground mesh
  51638. * * The parameters `width` and `height` (floats, default 1) set the width and height sizes of the ground
  51639. * * The parameter `subdivisions` (positive integer) sets the number of subdivisions per side
  51640. * * The mesh can be set to updatable with the boolean parameter `updatable` (default false) if its internal geometry is supposed to change once created
  51641. * @param name defines the name of the mesh
  51642. * @param options defines the options used to create the mesh
  51643. * @param scene defines the hosting scene
  51644. * @returns the ground mesh
  51645. * @see https://doc.babylonjs.com/how_to/set_shapes#ground
  51646. */
  51647. static CreateGround(name: string, options: {
  51648. width?: number;
  51649. height?: number;
  51650. subdivisions?: number;
  51651. subdivisionsX?: number;
  51652. subdivisionsY?: number;
  51653. updatable?: boolean;
  51654. }, scene: any): Mesh;
  51655. /**
  51656. * Creates a tiled ground mesh
  51657. * * The parameters `xmin` and `xmax` (floats, default -1 and 1) set the ground minimum and maximum X coordinates
  51658. * * The parameters `zmin` and `zmax` (floats, default -1 and 1) set the ground minimum and maximum Z coordinates
  51659. * * 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
  51660. * * 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
  51661. * * The mesh can be set to updatable with the boolean parameter `updatable` (default false) if its internal geometry is supposed to change once created.
  51662. * @param name defines the name of the mesh
  51663. * @param options defines the options used to create the mesh
  51664. * @param scene defines the hosting scene
  51665. * @returns the tiled ground mesh
  51666. * @see https://doc.babylonjs.com/how_to/set_shapes#tiled-ground
  51667. */
  51668. static CreateTiledGround(name: string, options: {
  51669. xmin: number;
  51670. zmin: number;
  51671. xmax: number;
  51672. zmax: number;
  51673. subdivisions?: {
  51674. w: number;
  51675. h: number;
  51676. };
  51677. precision?: {
  51678. w: number;
  51679. h: number;
  51680. };
  51681. updatable?: boolean;
  51682. }, scene?: Nullable<Scene>): Mesh;
  51683. /**
  51684. * Creates a ground mesh from a height map
  51685. * * The parameter `url` sets the URL of the height map image resource.
  51686. * * The parameters `width` and `height` (positive floats, default 10) set the ground width and height sizes.
  51687. * * The parameter `subdivisions` (positive integer, default 1) sets the number of subdivision per side.
  51688. * * The parameter `minHeight` (float, default 0) is the minimum altitude on the ground.
  51689. * * The parameter `maxHeight` (float, default 1) is the maximum altitude on the ground.
  51690. * * 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.
  51691. * * 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).
  51692. * * The parameter `alphaFilter` will filter any data where the alpha channel is below this value, defaults 0 (all data visible)
  51693. * * The mesh can be set to updatable with the boolean parameter `updatable` (default false) if its internal geometry is supposed to change once created.
  51694. * @param name defines the name of the mesh
  51695. * @param url defines the url to the height map
  51696. * @param options defines the options used to create the mesh
  51697. * @param scene defines the hosting scene
  51698. * @returns the ground mesh
  51699. * @see https://doc.babylonjs.com/babylon101/height_map
  51700. * @see https://doc.babylonjs.com/how_to/set_shapes#ground-from-a-height-map
  51701. */
  51702. static CreateGroundFromHeightMap(name: string, url: string, options: {
  51703. width?: number;
  51704. height?: number;
  51705. subdivisions?: number;
  51706. minHeight?: number;
  51707. maxHeight?: number;
  51708. colorFilter?: Color3;
  51709. alphaFilter?: number;
  51710. updatable?: boolean;
  51711. onReady?: (mesh: GroundMesh) => void;
  51712. }, scene?: Nullable<Scene>): GroundMesh;
  51713. }
  51714. }
  51715. declare module "babylonjs/Meshes/Builders/torusBuilder" {
  51716. import { Vector4 } from "babylonjs/Maths/math.vector";
  51717. import { Mesh } from "babylonjs/Meshes/mesh";
  51718. /**
  51719. * Class containing static functions to help procedurally build meshes
  51720. */
  51721. export class TorusBuilder {
  51722. /**
  51723. * Creates a torus mesh
  51724. * * The parameter `diameter` sets the diameter size (float) of the torus (default 1)
  51725. * * The parameter `thickness` sets the diameter size of the tube of the torus (float, default 0.5)
  51726. * * The parameter `tessellation` sets the number of torus sides (postive integer, default 16)
  51727. * * You can also set the mesh side orientation with the values : BABYLON.Mesh.FRONTSIDE (default), BABYLON.Mesh.BACKSIDE or BABYLON.Mesh.DOUBLESIDE
  51728. * * If you create a double-sided mesh, you can choose what parts of the texture image to crop and stick respectively on the front and the back sides with the parameters `frontUVs` and `backUVs` (Vector4). Detail here : https://doc.babylonjs.com/babylon101/discover_basic_elements#side-orientation
  51729. * * The mesh can be set to updatable with the boolean parameter `updatable` (default false) if its internal geometry is supposed to change once created.
  51730. * @param name defines the name of the mesh
  51731. * @param options defines the options used to create the mesh
  51732. * @param scene defines the hosting scene
  51733. * @returns the torus mesh
  51734. * @see https://doc.babylonjs.com/how_to/set_shapes#torus
  51735. */
  51736. static CreateTorus(name: string, options: {
  51737. diameter?: number;
  51738. thickness?: number;
  51739. tessellation?: number;
  51740. updatable?: boolean;
  51741. sideOrientation?: number;
  51742. frontUVs?: Vector4;
  51743. backUVs?: Vector4;
  51744. }, scene: any): Mesh;
  51745. }
  51746. }
  51747. declare module "babylonjs/Meshes/Builders/cylinderBuilder" {
  51748. import { Vector4 } from "babylonjs/Maths/math.vector";
  51749. import { Color4 } from "babylonjs/Maths/math.color";
  51750. import { Mesh } from "babylonjs/Meshes/mesh";
  51751. /**
  51752. * Class containing static functions to help procedurally build meshes
  51753. */
  51754. export class CylinderBuilder {
  51755. /**
  51756. * Creates a cylinder or a cone mesh
  51757. * * The parameter `height` sets the height size (float) of the cylinder/cone (float, default 2).
  51758. * * The parameter `diameter` sets the diameter of the top and bottom cap at once (float, default 1).
  51759. * * 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.
  51760. * * The parameter `tessellation` sets the number of cylinder sides (positive integer, default 24). Set it to 3 to get a prism for instance.
  51761. * * The parameter `subdivisions` sets the number of rings along the cylinder height (positive integer, default 1).
  51762. * * The parameter `hasRings` (boolean, default false) makes the subdivisions independent from each other, so they become different faces.
  51763. * * The parameter `enclose` (boolean, default false) adds two extra faces per subdivision to a sliced cylinder to close it around its height axis.
  51764. * * 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).
  51765. * * The parameter `arc` (float, default 1) is the ratio (max 1) to apply to the circumference to slice the cylinder.
  51766. * * 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).
  51767. * * 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
  51768. * * Now, if the cylinder has 5 independent subdivisions (hasRings = true), n equals : top face + 5 stripe surfaces + bottom face = 2 + 5 = 7
  51769. * * 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
  51770. * * 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.
  51771. * * If `enclose` is false, a ring surface is one element.
  51772. * * If `enclose` is true, a ring surface is 3 successive elements in the array : the tubular surface, then the two closing faces.
  51773. * * 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
  51774. * * You can also set the mesh side orientation with the values : BABYLON.Mesh.FRONTSIDE (default), BABYLON.Mesh.BACKSIDE or BABYLON.Mesh.DOUBLESIDE
  51775. * * If you create a double-sided mesh, you can choose what parts of the texture image to crop and stick respectively on the front and the back sides with the parameters `frontUVs` and `backUVs` (Vector4). Detail here : https://doc.babylonjs.com/babylon101/discover_basic_elements#side-orientation
  51776. * * The mesh can be set to updatable with the boolean parameter `updatable` (default false) if its internal geometry is supposed to change once created.
  51777. * @param name defines the name of the mesh
  51778. * @param options defines the options used to create the mesh
  51779. * @param scene defines the hosting scene
  51780. * @returns the cylinder mesh
  51781. * @see https://doc.babylonjs.com/how_to/set_shapes#cylinder-or-cone
  51782. */
  51783. static CreateCylinder(name: string, options: {
  51784. height?: number;
  51785. diameterTop?: number;
  51786. diameterBottom?: number;
  51787. diameter?: number;
  51788. tessellation?: number;
  51789. subdivisions?: number;
  51790. arc?: number;
  51791. faceColors?: Color4[];
  51792. faceUV?: Vector4[];
  51793. updatable?: boolean;
  51794. hasRings?: boolean;
  51795. enclose?: boolean;
  51796. cap?: number;
  51797. sideOrientation?: number;
  51798. frontUVs?: Vector4;
  51799. backUVs?: Vector4;
  51800. }, scene: any): Mesh;
  51801. }
  51802. }
  51803. declare module "babylonjs/XR/webXRTypes" {
  51804. import { Nullable } from "babylonjs/types";
  51805. import { IDisposable } from "babylonjs/scene";
  51806. /**
  51807. * States of the webXR experience
  51808. */
  51809. export enum WebXRState {
  51810. /**
  51811. * Transitioning to being in XR mode
  51812. */
  51813. ENTERING_XR = 0,
  51814. /**
  51815. * Transitioning to non XR mode
  51816. */
  51817. EXITING_XR = 1,
  51818. /**
  51819. * In XR mode and presenting
  51820. */
  51821. IN_XR = 2,
  51822. /**
  51823. * Not entered XR mode
  51824. */
  51825. NOT_IN_XR = 3
  51826. }
  51827. /**
  51828. * The state of the XR camera's tracking
  51829. */
  51830. export enum WebXRTrackingState {
  51831. /**
  51832. * No transformation received, device is not being tracked
  51833. */
  51834. NOT_TRACKING = 0,
  51835. /**
  51836. * Tracking lost - using emulated position
  51837. */
  51838. TRACKING_LOST = 1,
  51839. /**
  51840. * Transformation tracking works normally
  51841. */
  51842. TRACKING = 2
  51843. }
  51844. /**
  51845. * Abstraction of the XR render target
  51846. */
  51847. export interface WebXRRenderTarget extends IDisposable {
  51848. /**
  51849. * xrpresent context of the canvas which can be used to display/mirror xr content
  51850. */
  51851. canvasContext: WebGLRenderingContext;
  51852. /**
  51853. * xr layer for the canvas
  51854. */
  51855. xrLayer: Nullable<XRWebGLLayer>;
  51856. /**
  51857. * Initializes the xr layer for the session
  51858. * @param xrSession xr session
  51859. * @returns a promise that will resolve once the XR Layer has been created
  51860. */
  51861. initializeXRLayerAsync(xrSession: XRSession): Promise<XRWebGLLayer>;
  51862. }
  51863. }
  51864. declare module "babylonjs/XR/webXRManagedOutputCanvas" {
  51865. import { Nullable } from "babylonjs/types";
  51866. import { ThinEngine } from "babylonjs/Engines/thinEngine";
  51867. import { WebXRRenderTarget } from "babylonjs/XR/webXRTypes";
  51868. import { WebXRSessionManager } from "babylonjs/XR/webXRSessionManager";
  51869. import { Observable } from "babylonjs/Misc/observable";
  51870. /**
  51871. * COnfiguration object for WebXR output canvas
  51872. */
  51873. export class WebXRManagedOutputCanvasOptions {
  51874. /**
  51875. * An optional canvas in case you wish to create it yourself and provide it here.
  51876. * If not provided, a new canvas will be created
  51877. */
  51878. canvasElement?: HTMLCanvasElement;
  51879. /**
  51880. * Options for this XR Layer output
  51881. */
  51882. canvasOptions?: XRWebGLLayerOptions;
  51883. /**
  51884. * CSS styling for a newly created canvas (if not provided)
  51885. */
  51886. newCanvasCssStyle?: string;
  51887. /**
  51888. * Get the default values of the configuration object
  51889. * @param engine defines the engine to use (can be null)
  51890. * @returns default values of this configuration object
  51891. */
  51892. static GetDefaults(engine?: ThinEngine): WebXRManagedOutputCanvasOptions;
  51893. }
  51894. /**
  51895. * Creates a canvas that is added/removed from the webpage when entering/exiting XR
  51896. */
  51897. export class WebXRManagedOutputCanvas implements WebXRRenderTarget {
  51898. private _options;
  51899. private _canvas;
  51900. private _engine;
  51901. private _originalCanvasSize;
  51902. /**
  51903. * Rendering context of the canvas which can be used to display/mirror xr content
  51904. */
  51905. canvasContext: WebGLRenderingContext;
  51906. /**
  51907. * xr layer for the canvas
  51908. */
  51909. xrLayer: Nullable<XRWebGLLayer>;
  51910. /**
  51911. * Obseervers registered here will be triggered when the xr layer was initialized
  51912. */
  51913. onXRLayerInitObservable: Observable<XRWebGLLayer>;
  51914. /**
  51915. * Initializes the canvas to be added/removed upon entering/exiting xr
  51916. * @param _xrSessionManager The XR Session manager
  51917. * @param _options optional configuration for this canvas output. defaults will be used if not provided
  51918. */
  51919. constructor(_xrSessionManager: WebXRSessionManager, _options?: WebXRManagedOutputCanvasOptions);
  51920. /**
  51921. * Disposes of the object
  51922. */
  51923. dispose(): void;
  51924. /**
  51925. * Initializes the xr layer for the session
  51926. * @param xrSession xr session
  51927. * @returns a promise that will resolve once the XR Layer has been created
  51928. */
  51929. initializeXRLayerAsync(xrSession: XRSession): Promise<XRWebGLLayer>;
  51930. private _addCanvas;
  51931. private _removeCanvas;
  51932. private _setCanvasSize;
  51933. private _setManagedOutputCanvas;
  51934. }
  51935. }
  51936. declare module "babylonjs/XR/webXRSessionManager" {
  51937. import { Observable } from "babylonjs/Misc/observable";
  51938. import { Nullable } from "babylonjs/types";
  51939. import { IDisposable, Scene } from "babylonjs/scene";
  51940. import { RenderTargetTexture } from "babylonjs/Materials/Textures/renderTargetTexture";
  51941. import { WebXRRenderTarget } from "babylonjs/XR/webXRTypes";
  51942. import { WebXRManagedOutputCanvasOptions } from "babylonjs/XR/webXRManagedOutputCanvas";
  51943. /**
  51944. * Manages an XRSession to work with Babylon's engine
  51945. * @see https://doc.babylonjs.com/how_to/webxr_session_manager
  51946. */
  51947. export class WebXRSessionManager implements IDisposable {
  51948. /** The scene which the session should be created for */
  51949. scene: Scene;
  51950. private _referenceSpace;
  51951. private _rttProvider;
  51952. private _sessionEnded;
  51953. private _xrNavigator;
  51954. private baseLayer;
  51955. /**
  51956. * The base reference space from which the session started. good if you want to reset your
  51957. * reference space
  51958. */
  51959. baseReferenceSpace: XRReferenceSpace;
  51960. /**
  51961. * Current XR frame
  51962. */
  51963. currentFrame: Nullable<XRFrame>;
  51964. /** WebXR timestamp updated every frame */
  51965. currentTimestamp: number;
  51966. /**
  51967. * Used just in case of a failure to initialize an immersive session.
  51968. * The viewer reference space is compensated using this height, creating a kind of "viewer-floor" reference space
  51969. */
  51970. defaultHeightCompensation: number;
  51971. /**
  51972. * Fires every time a new xrFrame arrives which can be used to update the camera
  51973. */
  51974. onXRFrameObservable: Observable<XRFrame>;
  51975. /**
  51976. * Fires when the reference space changed
  51977. */
  51978. onXRReferenceSpaceChanged: Observable<XRReferenceSpace>;
  51979. /**
  51980. * Fires when the xr session is ended either by the device or manually done
  51981. */
  51982. onXRSessionEnded: Observable<any>;
  51983. /**
  51984. * Fires when the xr session is ended either by the device or manually done
  51985. */
  51986. onXRSessionInit: Observable<XRSession>;
  51987. /**
  51988. * Underlying xr session
  51989. */
  51990. session: XRSession;
  51991. /**
  51992. * The viewer (head position) reference space. This can be used to get the XR world coordinates
  51993. * or get the offset the player is currently at.
  51994. */
  51995. viewerReferenceSpace: XRReferenceSpace;
  51996. /**
  51997. * Constructs a WebXRSessionManager, this must be initialized within a user action before usage
  51998. * @param scene The scene which the session should be created for
  51999. */
  52000. constructor(
  52001. /** The scene which the session should be created for */
  52002. scene: Scene);
  52003. /**
  52004. * The current reference space used in this session. This reference space can constantly change!
  52005. * It is mainly used to offset the camera's position.
  52006. */
  52007. get referenceSpace(): XRReferenceSpace;
  52008. /**
  52009. * Set a new reference space and triggers the observable
  52010. */
  52011. set referenceSpace(newReferenceSpace: XRReferenceSpace);
  52012. /**
  52013. * Disposes of the session manager
  52014. */
  52015. dispose(): void;
  52016. /**
  52017. * Stops the xrSession and restores the render loop
  52018. * @returns Promise which resolves after it exits XR
  52019. */
  52020. exitXRAsync(): Promise<void>;
  52021. /**
  52022. * Gets the correct render target texture to be rendered this frame for this eye
  52023. * @param eye the eye for which to get the render target
  52024. * @returns the render target for the specified eye
  52025. */
  52026. getRenderTargetTextureForEye(eye: XREye): RenderTargetTexture;
  52027. /**
  52028. * Creates a WebXRRenderTarget object for the XR session
  52029. * @param onStateChangedObservable optional, mechanism for enabling/disabling XR rendering canvas, used only on Web
  52030. * @param options optional options to provide when creating a new render target
  52031. * @returns a WebXR render target to which the session can render
  52032. */
  52033. getWebXRRenderTarget(options?: WebXRManagedOutputCanvasOptions): WebXRRenderTarget;
  52034. /**
  52035. * Initializes the manager
  52036. * After initialization enterXR can be called to start an XR session
  52037. * @returns Promise which resolves after it is initialized
  52038. */
  52039. initializeAsync(): Promise<void>;
  52040. /**
  52041. * Initializes an xr session
  52042. * @param xrSessionMode mode to initialize
  52043. * @param xrSessionInit defines optional and required values to pass to the session builder
  52044. * @returns a promise which will resolve once the session has been initialized
  52045. */
  52046. initializeSessionAsync(xrSessionMode?: XRSessionMode, xrSessionInit?: XRSessionInit): Promise<XRSession>;
  52047. /**
  52048. * Checks if a session would be supported for the creation options specified
  52049. * @param sessionMode session mode to check if supported eg. immersive-vr
  52050. * @returns A Promise that resolves to true if supported and false if not
  52051. */
  52052. isSessionSupportedAsync(sessionMode: XRSessionMode): Promise<boolean>;
  52053. /**
  52054. * Resets the reference space to the one started the session
  52055. */
  52056. resetReferenceSpace(): void;
  52057. /**
  52058. * Starts rendering to the xr layer
  52059. */
  52060. runXRRenderLoop(): void;
  52061. /**
  52062. * Sets the reference space on the xr session
  52063. * @param referenceSpaceType space to set
  52064. * @returns a promise that will resolve once the reference space has been set
  52065. */
  52066. setReferenceSpaceTypeAsync(referenceSpaceType?: XRReferenceSpaceType): Promise<XRReferenceSpace>;
  52067. /**
  52068. * Updates the render state of the session
  52069. * @param state state to set
  52070. * @returns a promise that resolves once the render state has been updated
  52071. */
  52072. updateRenderStateAsync(state: XRRenderState): Promise<void>;
  52073. /**
  52074. * Returns a promise that resolves with a boolean indicating if the provided session mode is supported by this browser
  52075. * @param sessionMode defines the session to test
  52076. * @returns a promise with boolean as final value
  52077. */
  52078. static IsSessionSupportedAsync(sessionMode: XRSessionMode): Promise<boolean>;
  52079. private _createRenderTargetTexture;
  52080. }
  52081. }
  52082. declare module "babylonjs/XR/webXRCamera" {
  52083. import { Vector3 } from "babylonjs/Maths/math.vector";
  52084. import { Scene } from "babylonjs/scene";
  52085. import { Camera } from "babylonjs/Cameras/camera";
  52086. import { FreeCamera } from "babylonjs/Cameras/freeCamera";
  52087. import { WebXRSessionManager } from "babylonjs/XR/webXRSessionManager";
  52088. import { Observable } from "babylonjs/Misc/observable";
  52089. import { WebXRTrackingState } from "babylonjs/XR/webXRTypes";
  52090. /**
  52091. * WebXR Camera which holds the views for the xrSession
  52092. * @see https://doc.babylonjs.com/how_to/webxr_camera
  52093. */
  52094. export class WebXRCamera extends FreeCamera {
  52095. private _xrSessionManager;
  52096. private _firstFrame;
  52097. private _referenceQuaternion;
  52098. private _referencedPosition;
  52099. private _xrInvPositionCache;
  52100. private _xrInvQuaternionCache;
  52101. private _trackingState;
  52102. /**
  52103. * Observable raised before camera teleportation
  52104. */
  52105. onBeforeCameraTeleport: Observable<Vector3>;
  52106. /**
  52107. * Observable raised after camera teleportation
  52108. */
  52109. onAfterCameraTeleport: Observable<Vector3>;
  52110. /**
  52111. * Notifies when the camera's tracking state has changed.
  52112. * Notice - will also be triggered when tracking has started (at the beginning of the session)
  52113. */
  52114. onTrackingStateChanged: Observable<WebXRTrackingState>;
  52115. /**
  52116. * Should position compensation execute on first frame.
  52117. * This is used when copying the position from a native (non XR) camera
  52118. */
  52119. compensateOnFirstFrame: boolean;
  52120. /**
  52121. * Creates a new webXRCamera, this should only be set at the camera after it has been updated by the xrSessionManager
  52122. * @param name the name of the camera
  52123. * @param scene the scene to add the camera to
  52124. * @param _xrSessionManager a constructed xr session manager
  52125. */
  52126. constructor(name: string, scene: Scene, _xrSessionManager: WebXRSessionManager);
  52127. /**
  52128. * Get the current XR tracking state of the camera
  52129. */
  52130. get trackingState(): WebXRTrackingState;
  52131. private _setTrackingState;
  52132. /**
  52133. * Return the user's height, unrelated to the current ground.
  52134. * This will be the y position of this camera, when ground level is 0.
  52135. */
  52136. get realWorldHeight(): number;
  52137. /** @hidden */
  52138. _updateForDualEyeDebugging(): void;
  52139. /**
  52140. * Sets this camera's transformation based on a non-vr camera
  52141. * @param otherCamera the non-vr camera to copy the transformation from
  52142. * @param resetToBaseReferenceSpace should XR reset to the base reference space
  52143. */
  52144. setTransformationFromNonVRCamera(otherCamera?: Camera, resetToBaseReferenceSpace?: boolean): void;
  52145. /**
  52146. * Gets the current instance class name ("WebXRCamera").
  52147. * @returns the class name
  52148. */
  52149. getClassName(): string;
  52150. private _rotate180;
  52151. private _updateFromXRSession;
  52152. private _updateNumberOfRigCameras;
  52153. private _updateReferenceSpace;
  52154. private _updateReferenceSpaceOffset;
  52155. }
  52156. }
  52157. declare module "babylonjs/XR/webXRFeaturesManager" {
  52158. import { WebXRSessionManager } from "babylonjs/XR/webXRSessionManager";
  52159. import { IDisposable } from "babylonjs/scene";
  52160. /**
  52161. * Defining the interface required for a (webxr) feature
  52162. */
  52163. export interface IWebXRFeature extends IDisposable {
  52164. /**
  52165. * Is this feature attached
  52166. */
  52167. attached: boolean;
  52168. /**
  52169. * Should auto-attach be disabled?
  52170. */
  52171. disableAutoAttach: boolean;
  52172. /**
  52173. * Attach the feature to the session
  52174. * Will usually be called by the features manager
  52175. *
  52176. * @param force should attachment be forced (even when already attached)
  52177. * @returns true if successful.
  52178. */
  52179. attach(force?: boolean): boolean;
  52180. /**
  52181. * Detach the feature from the session
  52182. * Will usually be called by the features manager
  52183. *
  52184. * @returns true if successful.
  52185. */
  52186. detach(): boolean;
  52187. /**
  52188. * This function will be executed during before enabling the feature and can be used to not-allow enabling it.
  52189. * Note that at this point the session has NOT started, so this is purely checking if the browser supports it
  52190. *
  52191. * @returns whether or not the feature is compatible in this environment
  52192. */
  52193. isCompatible(): boolean;
  52194. /**
  52195. * Was this feature disposed;
  52196. */
  52197. isDisposed: boolean;
  52198. /**
  52199. * The name of the native xr feature name, if applicable (like anchor, hit-test, or hand-tracking)
  52200. */
  52201. xrNativeFeatureName?: string;
  52202. /**
  52203. * A list of (Babylon WebXR) features this feature depends on
  52204. */
  52205. dependsOn?: string[];
  52206. }
  52207. /**
  52208. * A list of the currently available features without referencing them
  52209. */
  52210. export class WebXRFeatureName {
  52211. /**
  52212. * The name of the anchor system feature
  52213. */
  52214. static readonly ANCHOR_SYSTEM: string;
  52215. /**
  52216. * The name of the background remover feature
  52217. */
  52218. static readonly BACKGROUND_REMOVER: string;
  52219. /**
  52220. * The name of the hit test feature
  52221. */
  52222. static readonly HIT_TEST: string;
  52223. /**
  52224. * physics impostors for xr controllers feature
  52225. */
  52226. static readonly PHYSICS_CONTROLLERS: string;
  52227. /**
  52228. * The name of the plane detection feature
  52229. */
  52230. static readonly PLANE_DETECTION: string;
  52231. /**
  52232. * The name of the pointer selection feature
  52233. */
  52234. static readonly POINTER_SELECTION: string;
  52235. /**
  52236. * The name of the teleportation feature
  52237. */
  52238. static readonly TELEPORTATION: string;
  52239. /**
  52240. * The name of the feature points feature.
  52241. */
  52242. static readonly FEATURE_POINTS: string;
  52243. /**
  52244. * The name of the hand tracking feature.
  52245. */
  52246. static readonly HAND_TRACKING: string;
  52247. }
  52248. /**
  52249. * Defining the constructor of a feature. Used to register the modules.
  52250. */
  52251. export type WebXRFeatureConstructor = (xrSessionManager: WebXRSessionManager, options?: any) => () => IWebXRFeature;
  52252. /**
  52253. * The WebXR features manager is responsible of enabling or disabling features required for the current XR session.
  52254. * It is mainly used in AR sessions.
  52255. *
  52256. * A feature can have a version that is defined by Babylon (and does not correspond with the webxr version).
  52257. */
  52258. export class WebXRFeaturesManager implements IDisposable {
  52259. private _xrSessionManager;
  52260. private static readonly _AvailableFeatures;
  52261. private _features;
  52262. /**
  52263. * constructs a new features manages.
  52264. *
  52265. * @param _xrSessionManager an instance of WebXRSessionManager
  52266. */
  52267. constructor(_xrSessionManager: WebXRSessionManager);
  52268. /**
  52269. * Used to register a module. After calling this function a developer can use this feature in the scene.
  52270. * Mainly used internally.
  52271. *
  52272. * @param featureName the name of the feature to register
  52273. * @param constructorFunction the function used to construct the module
  52274. * @param version the (babylon) version of the module
  52275. * @param stable is that a stable version of this module
  52276. */
  52277. static AddWebXRFeature(featureName: string, constructorFunction: WebXRFeatureConstructor, version?: number, stable?: boolean): void;
  52278. /**
  52279. * Returns a constructor of a specific feature.
  52280. *
  52281. * @param featureName the name of the feature to construct
  52282. * @param version the version of the feature to load
  52283. * @param xrSessionManager the xrSessionManager. Used to construct the module
  52284. * @param options optional options provided to the module.
  52285. * @returns a function that, when called, will return a new instance of this feature
  52286. */
  52287. static ConstructFeature(featureName: string, version: number | undefined, xrSessionManager: WebXRSessionManager, options?: any): () => IWebXRFeature;
  52288. /**
  52289. * Can be used to return the list of features currently registered
  52290. *
  52291. * @returns an Array of available features
  52292. */
  52293. static GetAvailableFeatures(): string[];
  52294. /**
  52295. * Gets the versions available for a specific feature
  52296. * @param featureName the name of the feature
  52297. * @returns an array with the available versions
  52298. */
  52299. static GetAvailableVersions(featureName: string): string[];
  52300. /**
  52301. * Return the latest unstable version of this feature
  52302. * @param featureName the name of the feature to search
  52303. * @returns the version number. if not found will return -1
  52304. */
  52305. static GetLatestVersionOfFeature(featureName: string): number;
  52306. /**
  52307. * Return the latest stable version of this feature
  52308. * @param featureName the name of the feature to search
  52309. * @returns the version number. if not found will return -1
  52310. */
  52311. static GetStableVersionOfFeature(featureName: string): number;
  52312. /**
  52313. * Attach a feature to the current session. Mainly used when session started to start the feature effect.
  52314. * Can be used during a session to start a feature
  52315. * @param featureName the name of feature to attach
  52316. */
  52317. attachFeature(featureName: string): void;
  52318. /**
  52319. * Can be used inside a session or when the session ends to detach a specific feature
  52320. * @param featureName the name of the feature to detach
  52321. */
  52322. detachFeature(featureName: string): void;
  52323. /**
  52324. * Used to disable an already-enabled feature
  52325. * The feature will be disposed and will be recreated once enabled.
  52326. * @param featureName the feature to disable
  52327. * @returns true if disable was successful
  52328. */
  52329. disableFeature(featureName: string | {
  52330. Name: string;
  52331. }): boolean;
  52332. /**
  52333. * dispose this features manager
  52334. */
  52335. dispose(): void;
  52336. /**
  52337. * 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.
  52338. * 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.
  52339. *
  52340. * @param featureName the name of the feature to load or the class of the feature
  52341. * @param version optional version to load. if not provided the latest version will be enabled
  52342. * @param moduleOptions options provided to the module. Ses the module documentation / constructor
  52343. * @param attachIfPossible if set to true (default) the feature will be automatically attached, if it is currently possible
  52344. * @param required is this feature required to the app. If set to true the session init will fail if the feature is not available.
  52345. * @returns a new constructed feature or throws an error if feature not found.
  52346. */
  52347. enableFeature(featureName: string | {
  52348. Name: string;
  52349. }, version?: number | string, moduleOptions?: any, attachIfPossible?: boolean, required?: boolean): IWebXRFeature;
  52350. /**
  52351. * get the implementation of an enabled feature.
  52352. * @param featureName the name of the feature to load
  52353. * @returns the feature class, if found
  52354. */
  52355. getEnabledFeature(featureName: string): IWebXRFeature;
  52356. /**
  52357. * Get the list of enabled features
  52358. * @returns an array of enabled features
  52359. */
  52360. getEnabledFeatures(): string[];
  52361. /**
  52362. * This function will exten the session creation configuration object with enabled features.
  52363. * If, for example, the anchors feature is enabled, it will be automatically added to the optional or required features list,
  52364. * according to the defined "required" variable, provided during enableFeature call
  52365. * @param xrSessionInit the xr Session init object to extend
  52366. *
  52367. * @returns an extended XRSessionInit object
  52368. */
  52369. extendXRSessionInitObject(xrSessionInit: XRSessionInit): XRSessionInit;
  52370. }
  52371. }
  52372. declare module "babylonjs/XR/webXRExperienceHelper" {
  52373. import { Observable } from "babylonjs/Misc/observable";
  52374. import { IDisposable, Scene } from "babylonjs/scene";
  52375. import { WebXRSessionManager } from "babylonjs/XR/webXRSessionManager";
  52376. import { WebXRCamera } from "babylonjs/XR/webXRCamera";
  52377. import { WebXRState, WebXRRenderTarget } from "babylonjs/XR/webXRTypes";
  52378. import { WebXRFeaturesManager } from "babylonjs/XR/webXRFeaturesManager";
  52379. /**
  52380. * Base set of functionality needed to create an XR experience (WebXRSessionManager, Camera, StateManagement, etc.)
  52381. * @see https://doc.babylonjs.com/how_to/webxr_experience_helpers
  52382. */
  52383. export class WebXRExperienceHelper implements IDisposable {
  52384. private scene;
  52385. private _nonVRCamera;
  52386. private _originalSceneAutoClear;
  52387. private _supported;
  52388. /**
  52389. * Camera used to render xr content
  52390. */
  52391. camera: WebXRCamera;
  52392. /** A features manager for this xr session */
  52393. featuresManager: WebXRFeaturesManager;
  52394. /**
  52395. * Observers registered here will be triggered after the camera's initial transformation is set
  52396. * This can be used to set a different ground level or an extra rotation.
  52397. *
  52398. * Note that ground level is considered to be at 0. The height defined by the XR camera will be added
  52399. * to the position set after this observable is done executing.
  52400. */
  52401. onInitialXRPoseSetObservable: Observable<WebXRCamera>;
  52402. /**
  52403. * Fires when the state of the experience helper has changed
  52404. */
  52405. onStateChangedObservable: Observable<WebXRState>;
  52406. /** Session manager used to keep track of xr session */
  52407. sessionManager: WebXRSessionManager;
  52408. /**
  52409. * The current state of the XR experience (eg. transitioning, in XR or not in XR)
  52410. */
  52411. state: WebXRState;
  52412. /**
  52413. * Creates a WebXRExperienceHelper
  52414. * @param scene The scene the helper should be created in
  52415. */
  52416. private constructor();
  52417. /**
  52418. * Creates the experience helper
  52419. * @param scene the scene to attach the experience helper to
  52420. * @returns a promise for the experience helper
  52421. */
  52422. static CreateAsync(scene: Scene): Promise<WebXRExperienceHelper>;
  52423. /**
  52424. * Disposes of the experience helper
  52425. */
  52426. dispose(): void;
  52427. /**
  52428. * Enters XR mode (This must be done within a user interaction in most browsers eg. button click)
  52429. * @param sessionMode options for the XR session
  52430. * @param referenceSpaceType frame of reference of the XR session
  52431. * @param renderTarget the output canvas that will be used to enter XR mode
  52432. * @param sessionCreationOptions optional XRSessionInit object to init the session with
  52433. * @returns promise that resolves after xr mode has entered
  52434. */
  52435. enterXRAsync(sessionMode: XRSessionMode, referenceSpaceType: XRReferenceSpaceType, renderTarget?: WebXRRenderTarget, sessionCreationOptions?: XRSessionInit): Promise<WebXRSessionManager>;
  52436. /**
  52437. * Exits XR mode and returns the scene to its original state
  52438. * @returns promise that resolves after xr mode has exited
  52439. */
  52440. exitXRAsync(): Promise<void>;
  52441. private _nonXRToXRCamera;
  52442. private _setState;
  52443. }
  52444. }
  52445. declare module "babylonjs/XR/motionController/webXRControllerComponent" {
  52446. import { IMinimalMotionControllerObject, MotionControllerComponentType } from "babylonjs/XR/motionController/webXRAbstractMotionController";
  52447. import { Observable } from "babylonjs/Misc/observable";
  52448. import { IDisposable } from "babylonjs/scene";
  52449. /**
  52450. * X-Y values for axes in WebXR
  52451. */
  52452. export interface IWebXRMotionControllerAxesValue {
  52453. /**
  52454. * The value of the x axis
  52455. */
  52456. x: number;
  52457. /**
  52458. * The value of the y-axis
  52459. */
  52460. y: number;
  52461. }
  52462. /**
  52463. * changed / previous values for the values of this component
  52464. */
  52465. export interface IWebXRMotionControllerComponentChangesValues<T> {
  52466. /**
  52467. * current (this frame) value
  52468. */
  52469. current: T;
  52470. /**
  52471. * previous (last change) value
  52472. */
  52473. previous: T;
  52474. }
  52475. /**
  52476. * Represents changes in the component between current frame and last values recorded
  52477. */
  52478. export interface IWebXRMotionControllerComponentChanges {
  52479. /**
  52480. * will be populated with previous and current values if axes changed
  52481. */
  52482. axes?: IWebXRMotionControllerComponentChangesValues<IWebXRMotionControllerAxesValue>;
  52483. /**
  52484. * will be populated with previous and current values if pressed changed
  52485. */
  52486. pressed?: IWebXRMotionControllerComponentChangesValues<boolean>;
  52487. /**
  52488. * will be populated with previous and current values if touched changed
  52489. */
  52490. touched?: IWebXRMotionControllerComponentChangesValues<boolean>;
  52491. /**
  52492. * will be populated with previous and current values if value changed
  52493. */
  52494. value?: IWebXRMotionControllerComponentChangesValues<number>;
  52495. }
  52496. /**
  52497. * This class represents a single component (for example button or thumbstick) of a motion controller
  52498. */
  52499. export class WebXRControllerComponent implements IDisposable {
  52500. /**
  52501. * the id of this component
  52502. */
  52503. id: string;
  52504. /**
  52505. * the type of the component
  52506. */
  52507. type: MotionControllerComponentType;
  52508. private _buttonIndex;
  52509. private _axesIndices;
  52510. private _axes;
  52511. private _changes;
  52512. private _currentValue;
  52513. private _hasChanges;
  52514. private _pressed;
  52515. private _touched;
  52516. /**
  52517. * button component type
  52518. */
  52519. static BUTTON_TYPE: MotionControllerComponentType;
  52520. /**
  52521. * squeeze component type
  52522. */
  52523. static SQUEEZE_TYPE: MotionControllerComponentType;
  52524. /**
  52525. * Thumbstick component type
  52526. */
  52527. static THUMBSTICK_TYPE: MotionControllerComponentType;
  52528. /**
  52529. * Touchpad component type
  52530. */
  52531. static TOUCHPAD_TYPE: MotionControllerComponentType;
  52532. /**
  52533. * trigger component type
  52534. */
  52535. static TRIGGER_TYPE: MotionControllerComponentType;
  52536. /**
  52537. * If axes are available for this component (like a touchpad or thumbstick) the observers will be notified when
  52538. * the axes data changes
  52539. */
  52540. onAxisValueChangedObservable: Observable<{
  52541. x: number;
  52542. y: number;
  52543. }>;
  52544. /**
  52545. * Observers registered here will be triggered when the state of a button changes
  52546. * State change is either pressed / touched / value
  52547. */
  52548. onButtonStateChangedObservable: Observable<WebXRControllerComponent>;
  52549. /**
  52550. * Creates a new component for a motion controller.
  52551. * It is created by the motion controller itself
  52552. *
  52553. * @param id the id of this component
  52554. * @param type the type of the component
  52555. * @param _buttonIndex index in the buttons array of the gamepad
  52556. * @param _axesIndices indices of the values in the axes array of the gamepad
  52557. */
  52558. constructor(
  52559. /**
  52560. * the id of this component
  52561. */
  52562. id: string,
  52563. /**
  52564. * the type of the component
  52565. */
  52566. type: MotionControllerComponentType, _buttonIndex?: number, _axesIndices?: number[]);
  52567. /**
  52568. * The current axes data. If this component has no axes it will still return an object { x: 0, y: 0 }
  52569. */
  52570. get axes(): IWebXRMotionControllerAxesValue;
  52571. /**
  52572. * Get the changes. Elements will be populated only if they changed with their previous and current value
  52573. */
  52574. get changes(): IWebXRMotionControllerComponentChanges;
  52575. /**
  52576. * Return whether or not the component changed the last frame
  52577. */
  52578. get hasChanges(): boolean;
  52579. /**
  52580. * is the button currently pressed
  52581. */
  52582. get pressed(): boolean;
  52583. /**
  52584. * is the button currently touched
  52585. */
  52586. get touched(): boolean;
  52587. /**
  52588. * Get the current value of this component
  52589. */
  52590. get value(): number;
  52591. /**
  52592. * Dispose this component
  52593. */
  52594. dispose(): void;
  52595. /**
  52596. * Are there axes correlating to this component
  52597. * @return true is axes data is available
  52598. */
  52599. isAxes(): boolean;
  52600. /**
  52601. * Is this component a button (hence - pressable)
  52602. * @returns true if can be pressed
  52603. */
  52604. isButton(): boolean;
  52605. /**
  52606. * update this component using the gamepad object it is in. Called on every frame
  52607. * @param nativeController the native gamepad controller object
  52608. */
  52609. update(nativeController: IMinimalMotionControllerObject): void;
  52610. }
  52611. }
  52612. declare module "babylonjs/Loading/sceneLoader" {
  52613. import { Observable } from "babylonjs/Misc/observable";
  52614. import { Nullable } from "babylonjs/types";
  52615. import { Scene } from "babylonjs/scene";
  52616. import { Engine } from "babylonjs/Engines/engine";
  52617. import { AbstractMesh } from "babylonjs/Meshes/abstractMesh";
  52618. import { AnimationGroup } from "babylonjs/Animations/animationGroup";
  52619. import { AssetContainer } from "babylonjs/assetContainer";
  52620. import { IParticleSystem } from "babylonjs/Particles/IParticleSystem";
  52621. import { Skeleton } from "babylonjs/Bones/skeleton";
  52622. import { IFileRequest } from "babylonjs/Misc/fileRequest";
  52623. import { WebRequest } from "babylonjs/Misc/webRequest";
  52624. /**
  52625. * Interface used to represent data loading progression
  52626. */
  52627. export interface ISceneLoaderProgressEvent {
  52628. /**
  52629. * Defines if data length to load can be evaluated
  52630. */
  52631. readonly lengthComputable: boolean;
  52632. /**
  52633. * Defines the loaded data length
  52634. */
  52635. readonly loaded: number;
  52636. /**
  52637. * Defines the data length to load
  52638. */
  52639. readonly total: number;
  52640. }
  52641. /**
  52642. * Interface used by SceneLoader plugins to define supported file extensions
  52643. */
  52644. export interface ISceneLoaderPluginExtensions {
  52645. /**
  52646. * Defines the list of supported extensions
  52647. */
  52648. [extension: string]: {
  52649. isBinary: boolean;
  52650. };
  52651. }
  52652. /**
  52653. * Interface used by SceneLoader plugin factory
  52654. */
  52655. export interface ISceneLoaderPluginFactory {
  52656. /**
  52657. * Defines the name of the factory
  52658. */
  52659. name: string;
  52660. /**
  52661. * Function called to create a new plugin
  52662. * @return the new plugin
  52663. */
  52664. createPlugin(): ISceneLoaderPlugin | ISceneLoaderPluginAsync;
  52665. /**
  52666. * The callback that returns true if the data can be directly loaded.
  52667. * @param data string containing the file data
  52668. * @returns if the data can be loaded directly
  52669. */
  52670. canDirectLoad?(data: string): boolean;
  52671. }
  52672. /**
  52673. * Interface used to define the base of ISceneLoaderPlugin and ISceneLoaderPluginAsync
  52674. */
  52675. export interface ISceneLoaderPluginBase {
  52676. /**
  52677. * The friendly name of this plugin.
  52678. */
  52679. name: string;
  52680. /**
  52681. * The file extensions supported by this plugin.
  52682. */
  52683. extensions: string | ISceneLoaderPluginExtensions;
  52684. /**
  52685. * The callback called when loading from a url.
  52686. * @param scene scene loading this url
  52687. * @param url url to load
  52688. * @param onSuccess callback called when the file successfully loads
  52689. * @param onProgress callback called while file is loading (if the server supports this mode)
  52690. * @param useArrayBuffer defines a boolean indicating that date must be returned as ArrayBuffer
  52691. * @param onError callback called when the file fails to load
  52692. * @returns a file request object
  52693. */
  52694. requestFile?(scene: Scene, url: string, onSuccess: (data: any, request?: WebRequest) => void, onProgress?: (ev: ISceneLoaderProgressEvent) => void, useArrayBuffer?: boolean, onError?: (error: any) => void): IFileRequest;
  52695. /**
  52696. * The callback called when loading from a file object.
  52697. * @param scene scene loading this file
  52698. * @param file defines the file to load
  52699. * @param onSuccess defines the callback to call when data is loaded
  52700. * @param onProgress defines the callback to call during loading process
  52701. * @param useArrayBuffer defines a boolean indicating that data must be returned as an ArrayBuffer
  52702. * @param onError defines the callback to call when an error occurs
  52703. * @returns a file request object
  52704. */
  52705. readFile?(scene: Scene, file: File, onSuccess: (data: any) => void, onProgress?: (ev: ISceneLoaderProgressEvent) => any, useArrayBuffer?: boolean, onError?: (error: any) => void): IFileRequest;
  52706. /**
  52707. * The callback that returns true if the data can be directly loaded.
  52708. * @param data string containing the file data
  52709. * @returns if the data can be loaded directly
  52710. */
  52711. canDirectLoad?(data: string): boolean;
  52712. /**
  52713. * The callback that returns the data to pass to the plugin if the data can be directly loaded.
  52714. * @param scene scene loading this data
  52715. * @param data string containing the data
  52716. * @returns data to pass to the plugin
  52717. */
  52718. directLoad?(scene: Scene, data: string): any;
  52719. /**
  52720. * The callback that allows custom handling of the root url based on the response url.
  52721. * @param rootUrl the original root url
  52722. * @param responseURL the response url if available
  52723. * @returns the new root url
  52724. */
  52725. rewriteRootURL?(rootUrl: string, responseURL?: string): string;
  52726. }
  52727. /**
  52728. * Interface used to define a SceneLoader plugin
  52729. */
  52730. export interface ISceneLoaderPlugin extends ISceneLoaderPluginBase {
  52731. /**
  52732. * Import meshes into a scene.
  52733. * @param meshesNames An array of mesh names, a single mesh name, or empty string for all meshes that filter what meshes are imported
  52734. * @param scene The scene to import into
  52735. * @param data The data to import
  52736. * @param rootUrl The root url for scene and resources
  52737. * @param meshes The meshes array to import into
  52738. * @param particleSystems The particle systems array to import into
  52739. * @param skeletons The skeletons array to import into
  52740. * @param onError The callback when import fails
  52741. * @returns True if successful or false otherwise
  52742. */
  52743. importMesh(meshesNames: any, scene: Scene, data: any, rootUrl: string, meshes: AbstractMesh[], particleSystems: IParticleSystem[], skeletons: Skeleton[], onError?: (message: string, exception?: any) => void): boolean;
  52744. /**
  52745. * Load into a scene.
  52746. * @param scene The scene to load into
  52747. * @param data The data to import
  52748. * @param rootUrl The root url for scene and resources
  52749. * @param onError The callback when import fails
  52750. * @returns True if successful or false otherwise
  52751. */
  52752. load(scene: Scene, data: any, rootUrl: string, onError?: (message: string, exception?: any) => void): boolean;
  52753. /**
  52754. * Load into an asset container.
  52755. * @param scene The scene to load into
  52756. * @param data The data to import
  52757. * @param rootUrl The root url for scene and resources
  52758. * @param onError The callback when import fails
  52759. * @returns The loaded asset container
  52760. */
  52761. loadAssetContainer(scene: Scene, data: any, rootUrl: string, onError?: (message: string, exception?: any) => void): AssetContainer;
  52762. }
  52763. /**
  52764. * Interface used to define an async SceneLoader plugin
  52765. */
  52766. export interface ISceneLoaderPluginAsync extends ISceneLoaderPluginBase {
  52767. /**
  52768. * Import meshes into a scene.
  52769. * @param meshesNames An array of mesh names, a single mesh name, or empty string for all meshes that filter what meshes are imported
  52770. * @param scene The scene to import into
  52771. * @param data The data to import
  52772. * @param rootUrl The root url for scene and resources
  52773. * @param onProgress The callback when the load progresses
  52774. * @param fileName Defines the name of the file to load
  52775. * @returns The loaded meshes, particle systems, skeletons, and animation groups
  52776. */
  52777. importMeshAsync(meshesNames: any, scene: Scene, data: any, rootUrl: string, onProgress?: (event: ISceneLoaderProgressEvent) => void, fileName?: string): Promise<{
  52778. meshes: AbstractMesh[];
  52779. particleSystems: IParticleSystem[];
  52780. skeletons: Skeleton[];
  52781. animationGroups: AnimationGroup[];
  52782. }>;
  52783. /**
  52784. * Load into a scene.
  52785. * @param scene The scene to load into
  52786. * @param data The data to import
  52787. * @param rootUrl The root url for scene and resources
  52788. * @param onProgress The callback when the load progresses
  52789. * @param fileName Defines the name of the file to load
  52790. * @returns Nothing
  52791. */
  52792. loadAsync(scene: Scene, data: any, rootUrl: string, onProgress?: (event: ISceneLoaderProgressEvent) => void, fileName?: string): Promise<void>;
  52793. /**
  52794. * Load into an asset container.
  52795. * @param scene The scene to load into
  52796. * @param data The data to import
  52797. * @param rootUrl The root url for scene and resources
  52798. * @param onProgress The callback when the load progresses
  52799. * @param fileName Defines the name of the file to load
  52800. * @returns The loaded asset container
  52801. */
  52802. loadAssetContainerAsync(scene: Scene, data: any, rootUrl: string, onProgress?: (event: ISceneLoaderProgressEvent) => void, fileName?: string): Promise<AssetContainer>;
  52803. }
  52804. /**
  52805. * Mode that determines how to handle old animation groups before loading new ones.
  52806. */
  52807. export enum SceneLoaderAnimationGroupLoadingMode {
  52808. /**
  52809. * Reset all old animations to initial state then dispose them.
  52810. */
  52811. Clean = 0,
  52812. /**
  52813. * Stop all old animations.
  52814. */
  52815. Stop = 1,
  52816. /**
  52817. * Restart old animations from first frame.
  52818. */
  52819. Sync = 2,
  52820. /**
  52821. * Old animations remains untouched.
  52822. */
  52823. NoSync = 3
  52824. }
  52825. /**
  52826. * Defines a plugin registered by the SceneLoader
  52827. */
  52828. interface IRegisteredPlugin {
  52829. /**
  52830. * Defines the plugin to use
  52831. */
  52832. plugin: ISceneLoaderPlugin | ISceneLoaderPluginAsync | ISceneLoaderPluginFactory;
  52833. /**
  52834. * Defines if the plugin supports binary data
  52835. */
  52836. isBinary: boolean;
  52837. }
  52838. /**
  52839. * Class used to load scene from various file formats using registered plugins
  52840. * @see https://doc.babylonjs.com/how_to/load_from_any_file_type
  52841. */
  52842. export class SceneLoader {
  52843. /**
  52844. * No logging while loading
  52845. */
  52846. static readonly NO_LOGGING: number;
  52847. /**
  52848. * Minimal logging while loading
  52849. */
  52850. static readonly MINIMAL_LOGGING: number;
  52851. /**
  52852. * Summary logging while loading
  52853. */
  52854. static readonly SUMMARY_LOGGING: number;
  52855. /**
  52856. * Detailled logging while loading
  52857. */
  52858. static readonly DETAILED_LOGGING: number;
  52859. /**
  52860. * Gets or sets a boolean indicating if entire scene must be loaded even if scene contains incremental data
  52861. */
  52862. static get ForceFullSceneLoadingForIncremental(): boolean;
  52863. static set ForceFullSceneLoadingForIncremental(value: boolean);
  52864. /**
  52865. * Gets or sets a boolean indicating if loading screen must be displayed while loading a scene
  52866. */
  52867. static get ShowLoadingScreen(): boolean;
  52868. static set ShowLoadingScreen(value: boolean);
  52869. /**
  52870. * Defines the current logging level (while loading the scene)
  52871. * @ignorenaming
  52872. */
  52873. static get loggingLevel(): number;
  52874. static set loggingLevel(value: number);
  52875. /**
  52876. * Gets or set a boolean indicating if matrix weights must be cleaned upon loading
  52877. */
  52878. static get CleanBoneMatrixWeights(): boolean;
  52879. static set CleanBoneMatrixWeights(value: boolean);
  52880. /**
  52881. * Event raised when a plugin is used to load a scene
  52882. */
  52883. static OnPluginActivatedObservable: Observable<ISceneLoaderPlugin | ISceneLoaderPluginAsync>;
  52884. private static _registeredPlugins;
  52885. private static _showingLoadingScreen;
  52886. /**
  52887. * Gets the default plugin (used to load Babylon files)
  52888. * @returns the .babylon plugin
  52889. */
  52890. static GetDefaultPlugin(): IRegisteredPlugin;
  52891. private static _GetPluginForExtension;
  52892. private static _GetPluginForDirectLoad;
  52893. private static _GetPluginForFilename;
  52894. private static _GetDirectLoad;
  52895. private static _LoadData;
  52896. private static _GetFileInfo;
  52897. /**
  52898. * Gets a plugin that can load the given extension
  52899. * @param extension defines the extension to load
  52900. * @returns a plugin or null if none works
  52901. */
  52902. static GetPluginForExtension(extension: string): ISceneLoaderPlugin | ISceneLoaderPluginAsync | ISceneLoaderPluginFactory;
  52903. /**
  52904. * Gets a boolean indicating that the given extension can be loaded
  52905. * @param extension defines the extension to load
  52906. * @returns true if the extension is supported
  52907. */
  52908. static IsPluginForExtensionAvailable(extension: string): boolean;
  52909. /**
  52910. * Adds a new plugin to the list of registered plugins
  52911. * @param plugin defines the plugin to add
  52912. */
  52913. static RegisterPlugin(plugin: ISceneLoaderPlugin | ISceneLoaderPluginAsync): void;
  52914. /**
  52915. * Import meshes into a scene
  52916. * @param meshNames an array of mesh names, a single mesh name, or empty string for all meshes that filter what meshes are imported
  52917. * @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)
  52918. * @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)
  52919. * @param scene the instance of BABYLON.Scene to append to
  52920. * @param onSuccess a callback with a list of imported meshes, particleSystems, skeletons, and animationGroups when import succeeds
  52921. * @param onProgress a callback with a progress event for each file being loaded
  52922. * @param onError a callback with the scene, a message, and possibly an exception when import fails
  52923. * @param pluginExtension the extension used to determine the plugin
  52924. * @returns The loaded plugin
  52925. */
  52926. 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>;
  52927. /**
  52928. * Import meshes into a scene
  52929. * @param meshNames an array of mesh names, a single mesh name, or empty string for all meshes that filter what meshes are imported
  52930. * @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)
  52931. * @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)
  52932. * @param scene the instance of BABYLON.Scene to append to
  52933. * @param onProgress a callback with a progress event for each file being loaded
  52934. * @param pluginExtension the extension used to determine the plugin
  52935. * @returns The loaded list of imported meshes, particle systems, skeletons, and animation groups
  52936. */
  52937. static ImportMeshAsync(meshNames: any, rootUrl: string, sceneFilename?: string | File, scene?: Nullable<Scene>, onProgress?: Nullable<(event: ISceneLoaderProgressEvent) => void>, pluginExtension?: Nullable<string>): Promise<{
  52938. meshes: AbstractMesh[];
  52939. particleSystems: IParticleSystem[];
  52940. skeletons: Skeleton[];
  52941. animationGroups: AnimationGroup[];
  52942. }>;
  52943. /**
  52944. * Load a scene
  52945. * @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)
  52946. * @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)
  52947. * @param engine is the instance of BABYLON.Engine to use to create the scene
  52948. * @param onSuccess a callback with the scene when import succeeds
  52949. * @param onProgress a callback with a progress event for each file being loaded
  52950. * @param onError a callback with the scene, a message, and possibly an exception when import fails
  52951. * @param pluginExtension the extension used to determine the plugin
  52952. * @returns The loaded plugin
  52953. */
  52954. 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>;
  52955. /**
  52956. * Load a scene
  52957. * @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)
  52958. * @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)
  52959. * @param engine is the instance of BABYLON.Engine to use to create the scene
  52960. * @param onProgress a callback with a progress event for each file being loaded
  52961. * @param pluginExtension the extension used to determine the plugin
  52962. * @returns The loaded scene
  52963. */
  52964. static LoadAsync(rootUrl: string, sceneFilename?: string | File, engine?: Nullable<Engine>, onProgress?: Nullable<(event: ISceneLoaderProgressEvent) => void>, pluginExtension?: Nullable<string>): Promise<Scene>;
  52965. /**
  52966. * Append a scene
  52967. * @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)
  52968. * @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)
  52969. * @param scene is the instance of BABYLON.Scene to append to
  52970. * @param onSuccess a callback with the scene when import succeeds
  52971. * @param onProgress a callback with a progress event for each file being loaded
  52972. * @param onError a callback with the scene, a message, and possibly an exception when import fails
  52973. * @param pluginExtension the extension used to determine the plugin
  52974. * @returns The loaded plugin
  52975. */
  52976. 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>;
  52977. /**
  52978. * Append a scene
  52979. * @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)
  52980. * @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)
  52981. * @param scene is the instance of BABYLON.Scene to append to
  52982. * @param onProgress a callback with a progress event for each file being loaded
  52983. * @param pluginExtension the extension used to determine the plugin
  52984. * @returns The given scene
  52985. */
  52986. static AppendAsync(rootUrl: string, sceneFilename?: string | File, scene?: Nullable<Scene>, onProgress?: Nullable<(event: ISceneLoaderProgressEvent) => void>, pluginExtension?: Nullable<string>): Promise<Scene>;
  52987. /**
  52988. * Load a scene into an asset container
  52989. * @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)
  52990. * @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)
  52991. * @param scene is the instance of BABYLON.Scene to append to (default: last created scene)
  52992. * @param onSuccess a callback with the scene when import succeeds
  52993. * @param onProgress a callback with a progress event for each file being loaded
  52994. * @param onError a callback with the scene, a message, and possibly an exception when import fails
  52995. * @param pluginExtension the extension used to determine the plugin
  52996. * @returns The loaded plugin
  52997. */
  52998. 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>;
  52999. /**
  53000. * Load a scene into an asset container
  53001. * @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)
  53002. * @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)
  53003. * @param scene is the instance of Scene to append to
  53004. * @param onProgress a callback with a progress event for each file being loaded
  53005. * @param pluginExtension the extension used to determine the plugin
  53006. * @returns The loaded asset container
  53007. */
  53008. static LoadAssetContainerAsync(rootUrl: string, sceneFilename?: string, scene?: Nullable<Scene>, onProgress?: Nullable<(event: ISceneLoaderProgressEvent) => void>, pluginExtension?: Nullable<string>): Promise<AssetContainer>;
  53009. /**
  53010. * Import animations from a file into a scene
  53011. * @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)
  53012. * @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)
  53013. * @param scene is the instance of BABYLON.Scene to append to (default: last created scene)
  53014. * @param overwriteAnimations when true, animations are cleaned before importing new ones. Animations are appended otherwise
  53015. * @param animationGroupLoadingMode defines how to handle old animations groups before importing new ones
  53016. * @param targetConverter defines a function used to convert animation targets from loaded scene to current scene (default: search node by name)
  53017. * @param onSuccess a callback with the scene when import succeeds
  53018. * @param onProgress a callback with a progress event for each file being loaded
  53019. * @param onError a callback with the scene, a message, and possibly an exception when import fails
  53020. * @param pluginExtension the extension used to determine the plugin
  53021. */
  53022. 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;
  53023. /**
  53024. * Import animations from a file into a scene
  53025. * @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)
  53026. * @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)
  53027. * @param scene is the instance of BABYLON.Scene to append to (default: last created scene)
  53028. * @param overwriteAnimations when true, animations are cleaned before importing new ones. Animations are appended otherwise
  53029. * @param animationGroupLoadingMode defines how to handle old animations groups before importing new ones
  53030. * @param targetConverter defines a function used to convert animation targets from loaded scene to current scene (default: search node by name)
  53031. * @param onSuccess a callback with the scene when import succeeds
  53032. * @param onProgress a callback with a progress event for each file being loaded
  53033. * @param onError a callback with the scene, a message, and possibly an exception when import fails
  53034. * @param pluginExtension the extension used to determine the plugin
  53035. * @returns the updated scene with imported animations
  53036. */
  53037. 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>;
  53038. }
  53039. }
  53040. declare module "babylonjs/XR/motionController/webXRAbstractMotionController" {
  53041. import { IDisposable, Scene } from "babylonjs/scene";
  53042. import { WebXRControllerComponent } from "babylonjs/XR/motionController/webXRControllerComponent";
  53043. import { Observable } from "babylonjs/Misc/observable";
  53044. import { AbstractMesh } from "babylonjs/Meshes/abstractMesh";
  53045. import { Nullable } from "babylonjs/types";
  53046. /**
  53047. * Handedness type in xrInput profiles. These can be used to define layouts in the Layout Map.
  53048. */
  53049. export type MotionControllerHandedness = "none" | "left" | "right";
  53050. /**
  53051. * The type of components available in motion controllers.
  53052. * This is not the name of the component.
  53053. */
  53054. export type MotionControllerComponentType = "trigger" | "squeeze" | "touchpad" | "thumbstick" | "button";
  53055. /**
  53056. * The state of a controller component
  53057. */
  53058. export type MotionControllerComponentStateType = "default" | "touched" | "pressed";
  53059. /**
  53060. * The schema of motion controller layout.
  53061. * No object will be initialized using this interface
  53062. * This is used just to define the profile.
  53063. */
  53064. export interface IMotionControllerLayout {
  53065. /**
  53066. * Path to load the assets. Usually relative to the base path
  53067. */
  53068. assetPath: string;
  53069. /**
  53070. * Available components (unsorted)
  53071. */
  53072. components: {
  53073. /**
  53074. * A map of component Ids
  53075. */
  53076. [componentId: string]: {
  53077. /**
  53078. * The type of input the component outputs
  53079. */
  53080. type: MotionControllerComponentType;
  53081. /**
  53082. * The indices of this component in the gamepad object
  53083. */
  53084. gamepadIndices: {
  53085. /**
  53086. * Index of button
  53087. */
  53088. button?: number;
  53089. /**
  53090. * If available, index of x-axis
  53091. */
  53092. xAxis?: number;
  53093. /**
  53094. * If available, index of y-axis
  53095. */
  53096. yAxis?: number;
  53097. };
  53098. /**
  53099. * The mesh's root node name
  53100. */
  53101. rootNodeName: string;
  53102. /**
  53103. * Animation definitions for this model
  53104. */
  53105. visualResponses: {
  53106. [stateKey: string]: {
  53107. /**
  53108. * What property will be animated
  53109. */
  53110. componentProperty: "xAxis" | "yAxis" | "button" | "state";
  53111. /**
  53112. * What states influence this visual response
  53113. */
  53114. states: MotionControllerComponentStateType[];
  53115. /**
  53116. * Type of animation - movement or visibility
  53117. */
  53118. valueNodeProperty: "transform" | "visibility";
  53119. /**
  53120. * Base node name to move. Its position will be calculated according to the min and max nodes
  53121. */
  53122. valueNodeName?: string;
  53123. /**
  53124. * Minimum movement node
  53125. */
  53126. minNodeName?: string;
  53127. /**
  53128. * Max movement node
  53129. */
  53130. maxNodeName?: string;
  53131. };
  53132. };
  53133. /**
  53134. * If touch enabled, what is the name of node to display user feedback
  53135. */
  53136. touchPointNodeName?: string;
  53137. };
  53138. };
  53139. /**
  53140. * Is it xr standard mapping or not
  53141. */
  53142. gamepadMapping: "" | "xr-standard";
  53143. /**
  53144. * Base root node of this entire model
  53145. */
  53146. rootNodeName: string;
  53147. /**
  53148. * Defines the main button component id
  53149. */
  53150. selectComponentId: string;
  53151. }
  53152. /**
  53153. * A definition for the layout map in the input profile
  53154. */
  53155. export interface IMotionControllerLayoutMap {
  53156. /**
  53157. * Layouts with handedness type as a key
  53158. */
  53159. [handedness: string]: IMotionControllerLayout;
  53160. }
  53161. /**
  53162. * The XR Input profile schema
  53163. * Profiles can be found here:
  53164. * https://github.com/immersive-web/webxr-input-profiles/tree/master/packages/registry/profiles
  53165. */
  53166. export interface IMotionControllerProfile {
  53167. /**
  53168. * fallback profiles for this profileId
  53169. */
  53170. fallbackProfileIds: string[];
  53171. /**
  53172. * The layout map, with handedness as key
  53173. */
  53174. layouts: IMotionControllerLayoutMap;
  53175. /**
  53176. * The id of this profile
  53177. * correlates to the profile(s) in the xrInput.profiles array
  53178. */
  53179. profileId: string;
  53180. }
  53181. /**
  53182. * A helper-interface for the 3 meshes needed for controller button animation
  53183. * The meshes are provided to the _lerpButtonTransform function to calculate the current position of the value mesh
  53184. */
  53185. export interface IMotionControllerButtonMeshMap {
  53186. /**
  53187. * the mesh that defines the pressed value mesh position.
  53188. * This is used to find the max-position of this button
  53189. */
  53190. pressedMesh: AbstractMesh;
  53191. /**
  53192. * the mesh that defines the unpressed value mesh position.
  53193. * This is used to find the min (or initial) position of this button
  53194. */
  53195. unpressedMesh: AbstractMesh;
  53196. /**
  53197. * The mesh that will be changed when value changes
  53198. */
  53199. valueMesh: AbstractMesh;
  53200. }
  53201. /**
  53202. * A helper-interface for the 3 meshes needed for controller axis animation.
  53203. * This will be expanded when touchpad animations are fully supported
  53204. * The meshes are provided to the _lerpAxisTransform function to calculate the current position of the value mesh
  53205. */
  53206. export interface IMotionControllerMeshMap {
  53207. /**
  53208. * the mesh that defines the maximum value mesh position.
  53209. */
  53210. maxMesh?: AbstractMesh;
  53211. /**
  53212. * the mesh that defines the minimum value mesh position.
  53213. */
  53214. minMesh?: AbstractMesh;
  53215. /**
  53216. * The mesh that will be changed when axis value changes
  53217. */
  53218. valueMesh?: AbstractMesh;
  53219. }
  53220. /**
  53221. * The elements needed for change-detection of the gamepad objects in motion controllers
  53222. */
  53223. export interface IMinimalMotionControllerObject {
  53224. /**
  53225. * Available axes of this controller
  53226. */
  53227. axes: number[];
  53228. /**
  53229. * An array of available buttons
  53230. */
  53231. buttons: Array<{
  53232. /**
  53233. * Value of the button/trigger
  53234. */
  53235. value: number;
  53236. /**
  53237. * If the button/trigger is currently touched
  53238. */
  53239. touched: boolean;
  53240. /**
  53241. * If the button/trigger is currently pressed
  53242. */
  53243. pressed: boolean;
  53244. }>;
  53245. /**
  53246. * EXPERIMENTAL haptic support.
  53247. */
  53248. hapticActuators?: Array<{
  53249. pulse: (value: number, duration: number) => Promise<boolean>;
  53250. }>;
  53251. }
  53252. /**
  53253. * An Abstract Motion controller
  53254. * This class receives an xrInput and a profile layout and uses those to initialize the components
  53255. * Each component has an observable to check for changes in value and state
  53256. */
  53257. export abstract class WebXRAbstractMotionController implements IDisposable {
  53258. protected scene: Scene;
  53259. protected layout: IMotionControllerLayout;
  53260. /**
  53261. * The gamepad object correlating to this controller
  53262. */
  53263. gamepadObject: IMinimalMotionControllerObject;
  53264. /**
  53265. * handedness (left/right/none) of this controller
  53266. */
  53267. handedness: MotionControllerHandedness;
  53268. private _initComponent;
  53269. private _modelReady;
  53270. /**
  53271. * A map of components (WebXRControllerComponent) in this motion controller
  53272. * Components have a ComponentType and can also have both button and axis definitions
  53273. */
  53274. readonly components: {
  53275. [id: string]: WebXRControllerComponent;
  53276. };
  53277. /**
  53278. * Disable the model's animation. Can be set at any time.
  53279. */
  53280. disableAnimation: boolean;
  53281. /**
  53282. * Observers registered here will be triggered when the model of this controller is done loading
  53283. */
  53284. onModelLoadedObservable: Observable<WebXRAbstractMotionController>;
  53285. /**
  53286. * The profile id of this motion controller
  53287. */
  53288. abstract profileId: string;
  53289. /**
  53290. * The root mesh of the model. It is null if the model was not yet initialized
  53291. */
  53292. rootMesh: Nullable<AbstractMesh>;
  53293. /**
  53294. * constructs a new abstract motion controller
  53295. * @param scene the scene to which the model of the controller will be added
  53296. * @param layout The profile layout to load
  53297. * @param gamepadObject The gamepad object correlating to this controller
  53298. * @param handedness handedness (left/right/none) of this controller
  53299. * @param _doNotLoadControllerMesh set this flag to ignore the mesh loading
  53300. */
  53301. constructor(scene: Scene, layout: IMotionControllerLayout,
  53302. /**
  53303. * The gamepad object correlating to this controller
  53304. */
  53305. gamepadObject: IMinimalMotionControllerObject,
  53306. /**
  53307. * handedness (left/right/none) of this controller
  53308. */
  53309. handedness: MotionControllerHandedness, _doNotLoadControllerMesh?: boolean);
  53310. /**
  53311. * Dispose this controller, the model mesh and all its components
  53312. */
  53313. dispose(): void;
  53314. /**
  53315. * Returns all components of specific type
  53316. * @param type the type to search for
  53317. * @return an array of components with this type
  53318. */
  53319. getAllComponentsOfType(type: MotionControllerComponentType): WebXRControllerComponent[];
  53320. /**
  53321. * get a component based an its component id as defined in layout.components
  53322. * @param id the id of the component
  53323. * @returns the component correlates to the id or undefined if not found
  53324. */
  53325. getComponent(id: string): WebXRControllerComponent;
  53326. /**
  53327. * Get the list of components available in this motion controller
  53328. * @returns an array of strings correlating to available components
  53329. */
  53330. getComponentIds(): string[];
  53331. /**
  53332. * Get the first component of specific type
  53333. * @param type type of component to find
  53334. * @return a controller component or null if not found
  53335. */
  53336. getComponentOfType(type: MotionControllerComponentType): Nullable<WebXRControllerComponent>;
  53337. /**
  53338. * Get the main (Select) component of this controller as defined in the layout
  53339. * @returns the main component of this controller
  53340. */
  53341. getMainComponent(): WebXRControllerComponent;
  53342. /**
  53343. * Loads the model correlating to this controller
  53344. * When the mesh is loaded, the onModelLoadedObservable will be triggered
  53345. * @returns A promise fulfilled with the result of the model loading
  53346. */
  53347. loadModel(): Promise<boolean>;
  53348. /**
  53349. * Update this model using the current XRFrame
  53350. * @param xrFrame the current xr frame to use and update the model
  53351. */
  53352. updateFromXRFrame(xrFrame: XRFrame): void;
  53353. /**
  53354. * Backwards compatibility due to a deeply-integrated typo
  53355. */
  53356. get handness(): XREye;
  53357. /**
  53358. * Pulse (vibrate) this controller
  53359. * If the controller does not support pulses, this function will fail silently and return Promise<false> directly after called
  53360. * Consecutive calls to this function will cancel the last pulse call
  53361. *
  53362. * @param value the strength of the pulse in 0.0...1.0 range
  53363. * @param duration Duration of the pulse in milliseconds
  53364. * @param hapticActuatorIndex optional index of actuator (will usually be 0)
  53365. * @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
  53366. */
  53367. pulse(value: number, duration: number, hapticActuatorIndex?: number): Promise<boolean>;
  53368. protected _getChildByName(node: AbstractMesh, name: string): AbstractMesh | undefined;
  53369. protected _getImmediateChildByName(node: AbstractMesh, name: string): AbstractMesh | undefined;
  53370. /**
  53371. * Moves the axis on the controller mesh based on its current state
  53372. * @param axis the index of the axis
  53373. * @param axisValue the value of the axis which determines the meshes new position
  53374. * @hidden
  53375. */
  53376. protected _lerpTransform(axisMap: IMotionControllerMeshMap, axisValue: number, fixValueCoordinates?: boolean): void;
  53377. /**
  53378. * Update the model itself with the current frame data
  53379. * @param xrFrame the frame to use for updating the model mesh
  53380. */
  53381. protected updateModel(xrFrame: XRFrame): void;
  53382. /**
  53383. * Get the filename and path for this controller's model
  53384. * @returns a map of filename and path
  53385. */
  53386. protected abstract _getFilenameAndPath(): {
  53387. filename: string;
  53388. path: string;
  53389. };
  53390. /**
  53391. * This function is called before the mesh is loaded. It checks for loading constraints.
  53392. * For example, this function can check if the GLB loader is available
  53393. * If this function returns false, the generic controller will be loaded instead
  53394. * @returns Is the client ready to load the mesh
  53395. */
  53396. protected abstract _getModelLoadingConstraints(): boolean;
  53397. /**
  53398. * This function will be called after the model was successfully loaded and can be used
  53399. * for mesh transformations before it is available for the user
  53400. * @param meshes the loaded meshes
  53401. */
  53402. protected abstract _processLoadedModel(meshes: AbstractMesh[]): void;
  53403. /**
  53404. * Set the root mesh for this controller. Important for the WebXR controller class
  53405. * @param meshes the loaded meshes
  53406. */
  53407. protected abstract _setRootMesh(meshes: AbstractMesh[]): void;
  53408. /**
  53409. * A function executed each frame that updates the mesh (if needed)
  53410. * @param xrFrame the current xrFrame
  53411. */
  53412. protected abstract _updateModel(xrFrame: XRFrame): void;
  53413. private _getGenericFilenameAndPath;
  53414. private _getGenericParentMesh;
  53415. }
  53416. }
  53417. declare module "babylonjs/XR/motionController/webXRGenericMotionController" {
  53418. import { WebXRAbstractMotionController, IMinimalMotionControllerObject, MotionControllerHandedness } from "babylonjs/XR/motionController/webXRAbstractMotionController";
  53419. import { AbstractMesh } from "babylonjs/Meshes/abstractMesh";
  53420. import { Scene } from "babylonjs/scene";
  53421. /**
  53422. * A generic trigger-only motion controller for WebXR
  53423. */
  53424. export class WebXRGenericTriggerMotionController extends WebXRAbstractMotionController {
  53425. /**
  53426. * Static version of the profile id of this controller
  53427. */
  53428. static ProfileId: string;
  53429. profileId: string;
  53430. constructor(scene: Scene, gamepadObject: IMinimalMotionControllerObject, handedness: MotionControllerHandedness);
  53431. protected _getFilenameAndPath(): {
  53432. filename: string;
  53433. path: string;
  53434. };
  53435. protected _getModelLoadingConstraints(): boolean;
  53436. protected _processLoadedModel(meshes: AbstractMesh[]): void;
  53437. protected _setRootMesh(meshes: AbstractMesh[]): void;
  53438. protected _updateModel(): void;
  53439. }
  53440. }
  53441. declare module "babylonjs/Meshes/Builders/sphereBuilder" {
  53442. import { Vector4 } from "babylonjs/Maths/math.vector";
  53443. import { Mesh } from "babylonjs/Meshes/mesh";
  53444. import { Scene } from "babylonjs/scene";
  53445. import { Nullable } from "babylonjs/types";
  53446. /**
  53447. * Class containing static functions to help procedurally build meshes
  53448. */
  53449. export class SphereBuilder {
  53450. /**
  53451. * Creates a sphere mesh
  53452. * * The parameter `diameter` sets the diameter size (float) of the sphere (default 1)
  53453. * * 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`)
  53454. * * The parameter `segments` sets the sphere number of horizontal stripes (positive integer, default 32)
  53455. * * 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
  53456. * * 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)
  53457. * * You can also set the mesh side orientation with the values : BABYLON.Mesh.FRONTSIDE (default), BABYLON.Mesh.BACKSIDE or BABYLON.Mesh.DOUBLESIDE
  53458. * * If you create a double-sided mesh, you can choose what parts of the texture image to crop and stick respectively on the front and the back sides with the parameters `frontUVs` and `backUVs` (Vector4). Detail here : https://doc.babylonjs.com/babylon101/discover_basic_elements#side-orientation
  53459. * * The mesh can be set to updatable with the boolean parameter `updatable` (default false) if its internal geometry is supposed to change once created
  53460. * @param name defines the name of the mesh
  53461. * @param options defines the options used to create the mesh
  53462. * @param scene defines the hosting scene
  53463. * @returns the sphere mesh
  53464. * @see https://doc.babylonjs.com/how_to/set_shapes#sphere
  53465. */
  53466. static CreateSphere(name: string, options: {
  53467. segments?: number;
  53468. diameter?: number;
  53469. diameterX?: number;
  53470. diameterY?: number;
  53471. diameterZ?: number;
  53472. arc?: number;
  53473. slice?: number;
  53474. sideOrientation?: number;
  53475. frontUVs?: Vector4;
  53476. backUVs?: Vector4;
  53477. updatable?: boolean;
  53478. }, scene?: Nullable<Scene>): Mesh;
  53479. }
  53480. }
  53481. declare module "babylonjs/XR/motionController/webXRProfiledMotionController" {
  53482. import { AbstractMesh } from "babylonjs/Meshes/abstractMesh";
  53483. import { WebXRAbstractMotionController, IMotionControllerProfile } from "babylonjs/XR/motionController/webXRAbstractMotionController";
  53484. import { Scene } from "babylonjs/scene";
  53485. /**
  53486. * A profiled motion controller has its profile loaded from an online repository.
  53487. * The class is responsible of loading the model, mapping the keys and enabling model-animations
  53488. */
  53489. export class WebXRProfiledMotionController extends WebXRAbstractMotionController {
  53490. private _repositoryUrl;
  53491. private _buttonMeshMapping;
  53492. private _touchDots;
  53493. /**
  53494. * The profile ID of this controller. Will be populated when the controller initializes.
  53495. */
  53496. profileId: string;
  53497. constructor(scene: Scene, xrInput: XRInputSource, _profile: IMotionControllerProfile, _repositoryUrl: string);
  53498. dispose(): void;
  53499. protected _getFilenameAndPath(): {
  53500. filename: string;
  53501. path: string;
  53502. };
  53503. protected _getModelLoadingConstraints(): boolean;
  53504. protected _processLoadedModel(_meshes: AbstractMesh[]): void;
  53505. protected _setRootMesh(meshes: AbstractMesh[]): void;
  53506. protected _updateModel(_xrFrame: XRFrame): void;
  53507. }
  53508. }
  53509. declare module "babylonjs/XR/motionController/webXRMotionControllerManager" {
  53510. import { WebXRAbstractMotionController } from "babylonjs/XR/motionController/webXRAbstractMotionController";
  53511. import { Scene } from "babylonjs/scene";
  53512. /**
  53513. * A construction function type to create a new controller based on an xrInput object
  53514. */
  53515. export type MotionControllerConstructor = (xrInput: XRInputSource, scene: Scene) => WebXRAbstractMotionController;
  53516. /**
  53517. * The MotionController Manager manages all registered motion controllers and loads the right one when needed.
  53518. *
  53519. * When this repository is complete: https://github.com/immersive-web/webxr-input-profiles/tree/master/packages/assets
  53520. * it should be replaced with auto-loaded controllers.
  53521. *
  53522. * When using a model try to stay as generic as possible. Eventually there will be no need in any of the controller classes
  53523. */
  53524. export class WebXRMotionControllerManager {
  53525. private static _AvailableControllers;
  53526. private static _Fallbacks;
  53527. private static _ProfileLoadingPromises;
  53528. private static _ProfilesList;
  53529. /**
  53530. * The base URL of the online controller repository. Can be changed at any time.
  53531. */
  53532. static BaseRepositoryUrl: string;
  53533. /**
  53534. * Which repository gets priority - local or online
  53535. */
  53536. static PrioritizeOnlineRepository: boolean;
  53537. /**
  53538. * Use the online repository, or use only locally-defined controllers
  53539. */
  53540. static UseOnlineRepository: boolean;
  53541. /**
  53542. * Clear the cache used for profile loading and reload when requested again
  53543. */
  53544. static ClearProfilesCache(): void;
  53545. /**
  53546. * Register the default fallbacks.
  53547. * This function is called automatically when this file is imported.
  53548. */
  53549. static DefaultFallbacks(): void;
  53550. /**
  53551. * Find a fallback profile if the profile was not found. There are a few predefined generic profiles.
  53552. * @param profileId the profile to which a fallback needs to be found
  53553. * @return an array with corresponding fallback profiles
  53554. */
  53555. static FindFallbackWithProfileId(profileId: string): string[];
  53556. /**
  53557. * When acquiring a new xrInput object (usually by the WebXRInput class), match it with the correct profile.
  53558. * The order of search:
  53559. *
  53560. * 1) Iterate the profiles array of the xr input and try finding a corresponding motion controller
  53561. * 2) (If not found) search in the gamepad id and try using it (legacy versions only)
  53562. * 3) search for registered fallbacks (should be redundant, nonetheless it makes sense to check)
  53563. * 4) return the generic trigger controller if none were found
  53564. *
  53565. * @param xrInput the xrInput to which a new controller is initialized
  53566. * @param scene the scene to which the model will be added
  53567. * @param forceProfile force a certain profile for this controller
  53568. * @return A promise that fulfils with the motion controller class for this profile id or the generic standard class if none was found
  53569. */
  53570. static GetMotionControllerWithXRInput(xrInput: XRInputSource, scene: Scene, forceProfile?: string): Promise<WebXRAbstractMotionController>;
  53571. /**
  53572. * Register a new controller based on its profile. This function will be called by the controller classes themselves.
  53573. *
  53574. * If you are missing a profile, make sure it is imported in your source, otherwise it will not register.
  53575. *
  53576. * @param type the profile type to register
  53577. * @param constructFunction the function to be called when loading this profile
  53578. */
  53579. static RegisterController(type: string, constructFunction: MotionControllerConstructor): void;
  53580. /**
  53581. * Register a fallback to a specific profile.
  53582. * @param profileId the profileId that will receive the fallbacks
  53583. * @param fallbacks A list of fallback profiles
  53584. */
  53585. static RegisterFallbacksForProfileId(profileId: string, fallbacks: string[]): void;
  53586. /**
  53587. * Will update the list of profiles available in the repository
  53588. * @return a promise that resolves to a map of profiles available online
  53589. */
  53590. static UpdateProfilesList(): Promise<{
  53591. [profile: string]: string;
  53592. }>;
  53593. private static _LoadProfileFromRepository;
  53594. private static _LoadProfilesFromAvailableControllers;
  53595. }
  53596. }
  53597. declare module "babylonjs/XR/webXRInputSource" {
  53598. import { Observable } from "babylonjs/Misc/observable";
  53599. import { AbstractMesh } from "babylonjs/Meshes/abstractMesh";
  53600. import { Ray } from "babylonjs/Culling/ray";
  53601. import { Scene } from "babylonjs/scene";
  53602. import { WebXRAbstractMotionController } from "babylonjs/XR/motionController/webXRAbstractMotionController";
  53603. /**
  53604. * Configuration options for the WebXR controller creation
  53605. */
  53606. export interface IWebXRControllerOptions {
  53607. /**
  53608. * Should the controller mesh be animated when a user interacts with it
  53609. * The pressed buttons / thumbstick and touchpad animations will be disabled
  53610. */
  53611. disableMotionControllerAnimation?: boolean;
  53612. /**
  53613. * Do not load the controller mesh, in case a different mesh needs to be loaded.
  53614. */
  53615. doNotLoadControllerMesh?: boolean;
  53616. /**
  53617. * Force a specific controller type for this controller.
  53618. * This can be used when creating your own profile or when testing different controllers
  53619. */
  53620. forceControllerProfile?: string;
  53621. /**
  53622. * Defines a rendering group ID for meshes that will be loaded.
  53623. * This is for the default controllers only.
  53624. */
  53625. renderingGroupId?: number;
  53626. }
  53627. /**
  53628. * Represents an XR controller
  53629. */
  53630. export class WebXRInputSource {
  53631. private _scene;
  53632. /** The underlying input source for the controller */
  53633. inputSource: XRInputSource;
  53634. private _options;
  53635. private _tmpVector;
  53636. private _uniqueId;
  53637. private _disposed;
  53638. /**
  53639. * 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
  53640. */
  53641. grip?: AbstractMesh;
  53642. /**
  53643. * If available, this is the gamepad object related to this controller.
  53644. * Using this object it is possible to get click events and trackpad changes of the
  53645. * webxr controller that is currently being used.
  53646. */
  53647. motionController?: WebXRAbstractMotionController;
  53648. /**
  53649. * Event that fires when the controller is removed/disposed.
  53650. * The object provided as event data is this controller, after associated assets were disposed.
  53651. * uniqueId is still available.
  53652. */
  53653. onDisposeObservable: Observable<WebXRInputSource>;
  53654. /**
  53655. * Will be triggered when the mesh associated with the motion controller is done loading.
  53656. * It is also possible that this will never trigger (!) if no mesh was loaded, or if the developer decides to load a different mesh
  53657. * A shortened version of controller -> motion controller -> on mesh loaded.
  53658. */
  53659. onMeshLoadedObservable: Observable<AbstractMesh>;
  53660. /**
  53661. * Observers registered here will trigger when a motion controller profile was assigned to this xr controller
  53662. */
  53663. onMotionControllerInitObservable: Observable<WebXRAbstractMotionController>;
  53664. /**
  53665. * Pointer which can be used to select objects or attach a visible laser to
  53666. */
  53667. pointer: AbstractMesh;
  53668. /**
  53669. * Creates the input source object
  53670. * @see https://doc.babylonjs.com/how_to/webxr_controllers_support
  53671. * @param _scene the scene which the controller should be associated to
  53672. * @param inputSource the underlying input source for the controller
  53673. * @param _options options for this controller creation
  53674. */
  53675. constructor(_scene: Scene,
  53676. /** The underlying input source for the controller */
  53677. inputSource: XRInputSource, _options?: IWebXRControllerOptions);
  53678. /**
  53679. * Get this controllers unique id
  53680. */
  53681. get uniqueId(): string;
  53682. /**
  53683. * Disposes of the object
  53684. */
  53685. dispose(): void;
  53686. /**
  53687. * Gets a world space ray coming from the pointer or grip
  53688. * @param result the resulting ray
  53689. * @param gripIfAvailable use the grip mesh instead of the pointer, if available
  53690. */
  53691. getWorldPointerRayToRef(result: Ray, gripIfAvailable?: boolean): void;
  53692. /**
  53693. * Updates the controller pose based on the given XRFrame
  53694. * @param xrFrame xr frame to update the pose with
  53695. * @param referenceSpace reference space to use
  53696. */
  53697. updateFromXRFrame(xrFrame: XRFrame, referenceSpace: XRReferenceSpace): void;
  53698. }
  53699. }
  53700. declare module "babylonjs/XR/webXRInput" {
  53701. import { Observable } from "babylonjs/Misc/observable";
  53702. import { IDisposable } from "babylonjs/scene";
  53703. import { WebXRInputSource, IWebXRControllerOptions } from "babylonjs/XR/webXRInputSource";
  53704. import { WebXRSessionManager } from "babylonjs/XR/webXRSessionManager";
  53705. import { WebXRCamera } from "babylonjs/XR/webXRCamera";
  53706. /**
  53707. * The schema for initialization options of the XR Input class
  53708. */
  53709. export interface IWebXRInputOptions {
  53710. /**
  53711. * If set to true no model will be automatically loaded
  53712. */
  53713. doNotLoadControllerMeshes?: boolean;
  53714. /**
  53715. * If set, this profile will be used for all controllers loaded (for example "microsoft-mixed-reality")
  53716. * If not found, the xr input profile data will be used.
  53717. * Profiles are defined here - https://github.com/immersive-web/webxr-input-profiles/
  53718. */
  53719. forceInputProfile?: string;
  53720. /**
  53721. * Do not send a request to the controller repository to load the profile.
  53722. *
  53723. * Instead, use the controllers available in babylon itself.
  53724. */
  53725. disableOnlineControllerRepository?: boolean;
  53726. /**
  53727. * A custom URL for the controllers repository
  53728. */
  53729. customControllersRepositoryURL?: string;
  53730. /**
  53731. * Should the controller model's components not move according to the user input
  53732. */
  53733. disableControllerAnimation?: boolean;
  53734. /**
  53735. * Optional options to pass to the controller. Will be overridden by the Input options where applicable
  53736. */
  53737. controllerOptions?: IWebXRControllerOptions;
  53738. }
  53739. /**
  53740. * XR input used to track XR inputs such as controllers/rays
  53741. */
  53742. export class WebXRInput implements IDisposable {
  53743. /**
  53744. * the xr session manager for this session
  53745. */
  53746. xrSessionManager: WebXRSessionManager;
  53747. /**
  53748. * the WebXR camera for this session. Mainly used for teleportation
  53749. */
  53750. xrCamera: WebXRCamera;
  53751. private readonly options;
  53752. /**
  53753. * XR controllers being tracked
  53754. */
  53755. controllers: Array<WebXRInputSource>;
  53756. private _frameObserver;
  53757. private _sessionEndedObserver;
  53758. private _sessionInitObserver;
  53759. /**
  53760. * Event when a controller has been connected/added
  53761. */
  53762. onControllerAddedObservable: Observable<WebXRInputSource>;
  53763. /**
  53764. * Event when a controller has been removed/disconnected
  53765. */
  53766. onControllerRemovedObservable: Observable<WebXRInputSource>;
  53767. /**
  53768. * Initializes the WebXRInput
  53769. * @param xrSessionManager the xr session manager for this session
  53770. * @param xrCamera the WebXR camera for this session. Mainly used for teleportation
  53771. * @param options = initialization options for this xr input
  53772. */
  53773. constructor(
  53774. /**
  53775. * the xr session manager for this session
  53776. */
  53777. xrSessionManager: WebXRSessionManager,
  53778. /**
  53779. * the WebXR camera for this session. Mainly used for teleportation
  53780. */
  53781. xrCamera: WebXRCamera, options?: IWebXRInputOptions);
  53782. private _onInputSourcesChange;
  53783. private _addAndRemoveControllers;
  53784. /**
  53785. * Disposes of the object
  53786. */
  53787. dispose(): void;
  53788. }
  53789. }
  53790. declare module "babylonjs/XR/features/WebXRAbstractFeature" {
  53791. import { IWebXRFeature } from "babylonjs/XR/webXRFeaturesManager";
  53792. import { Observable, EventState } from "babylonjs/Misc/observable";
  53793. import { WebXRSessionManager } from "babylonjs/XR/webXRSessionManager";
  53794. /**
  53795. * This is the base class for all WebXR features.
  53796. * Since most features require almost the same resources and callbacks, this class can be used to simplify the development
  53797. * Note that since the features manager is using the `IWebXRFeature` you are in no way obligated to use this class
  53798. */
  53799. export abstract class WebXRAbstractFeature implements IWebXRFeature {
  53800. protected _xrSessionManager: WebXRSessionManager;
  53801. private _attached;
  53802. private _removeOnDetach;
  53803. /**
  53804. * Is this feature disposed?
  53805. */
  53806. isDisposed: boolean;
  53807. /**
  53808. * Should auto-attach be disabled?
  53809. */
  53810. disableAutoAttach: boolean;
  53811. /**
  53812. * The name of the native xr feature name (like anchor, hit-test, or hand-tracking)
  53813. */
  53814. xrNativeFeatureName: string;
  53815. /**
  53816. * Construct a new (abstract) WebXR feature
  53817. * @param _xrSessionManager the xr session manager for this feature
  53818. */
  53819. constructor(_xrSessionManager: WebXRSessionManager);
  53820. /**
  53821. * Is this feature attached
  53822. */
  53823. get attached(): boolean;
  53824. /**
  53825. * attach this feature
  53826. *
  53827. * @param force should attachment be forced (even when already attached)
  53828. * @returns true if successful, false is failed or already attached
  53829. */
  53830. attach(force?: boolean): boolean;
  53831. /**
  53832. * detach this feature.
  53833. *
  53834. * @returns true if successful, false if failed or already detached
  53835. */
  53836. detach(): boolean;
  53837. /**
  53838. * Dispose this feature and all of the resources attached
  53839. */
  53840. dispose(): void;
  53841. /**
  53842. * This function will be executed during before enabling the feature and can be used to not-allow enabling it.
  53843. * Note that at this point the session has NOT started, so this is purely checking if the browser supports it
  53844. *
  53845. * @returns whether or not the feature is compatible in this environment
  53846. */
  53847. isCompatible(): boolean;
  53848. /**
  53849. * This is used to register callbacks that will automatically be removed when detach is called.
  53850. * @param observable the observable to which the observer will be attached
  53851. * @param callback the callback to register
  53852. */
  53853. protected _addNewAttachObserver<T>(observable: Observable<T>, callback: (eventData: T, eventState: EventState) => void): void;
  53854. /**
  53855. * Code in this function will be executed on each xrFrame received from the browser.
  53856. * This function will not execute after the feature is detached.
  53857. * @param _xrFrame the current frame
  53858. */
  53859. protected abstract _onXRFrame(_xrFrame: XRFrame): void;
  53860. }
  53861. }
  53862. declare module "babylonjs/Rendering/utilityLayerRenderer" {
  53863. import { IDisposable, Scene } from "babylonjs/scene";
  53864. import { Nullable } from "babylonjs/types";
  53865. import { Observable } from "babylonjs/Misc/observable";
  53866. import { AbstractMesh } from "babylonjs/Meshes/abstractMesh";
  53867. import { HemisphericLight } from "babylonjs/Lights/hemisphericLight";
  53868. import { Camera } from "babylonjs/Cameras/camera";
  53869. /**
  53870. * Renders a layer on top of an existing scene
  53871. */
  53872. export class UtilityLayerRenderer implements IDisposable {
  53873. /** the original scene that will be rendered on top of */
  53874. originalScene: Scene;
  53875. private _pointerCaptures;
  53876. private _lastPointerEvents;
  53877. private static _DefaultUtilityLayer;
  53878. private static _DefaultKeepDepthUtilityLayer;
  53879. private _sharedGizmoLight;
  53880. private _renderCamera;
  53881. /**
  53882. * Gets the camera that is used to render the utility layer (when not set, this will be the last active camera)
  53883. * @param getRigParentIfPossible if the current active camera is a rig camera, should its parent camera be returned
  53884. * @returns the camera that is used when rendering the utility layer
  53885. */
  53886. getRenderCamera(getRigParentIfPossible?: boolean): Camera;
  53887. /**
  53888. * Sets the camera that should be used when rendering the utility layer (If set to null the last active camera will be used)
  53889. * @param cam the camera that should be used when rendering the utility layer
  53890. */
  53891. setRenderCamera(cam: Nullable<Camera>): void;
  53892. /**
  53893. * @hidden
  53894. * Light which used by gizmos to get light shading
  53895. */
  53896. _getSharedGizmoLight(): HemisphericLight;
  53897. /**
  53898. * If the picking should be done on the utility layer prior to the actual scene (Default: true)
  53899. */
  53900. pickUtilitySceneFirst: boolean;
  53901. /**
  53902. * 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)
  53903. */
  53904. static get DefaultUtilityLayer(): UtilityLayerRenderer;
  53905. /**
  53906. * 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)
  53907. */
  53908. static get DefaultKeepDepthUtilityLayer(): UtilityLayerRenderer;
  53909. /**
  53910. * The scene that is rendered on top of the original scene
  53911. */
  53912. utilityLayerScene: Scene;
  53913. /**
  53914. * If the utility layer should automatically be rendered on top of existing scene
  53915. */
  53916. shouldRender: boolean;
  53917. /**
  53918. * If set to true, only pointer down onPointerObservable events will be blocked when picking is occluded by original scene
  53919. */
  53920. onlyCheckPointerDownEvents: boolean;
  53921. /**
  53922. * If set to false, only pointerUp, pointerDown and pointerMove will be sent to the utilityLayerScene (false by default)
  53923. */
  53924. processAllEvents: boolean;
  53925. /**
  53926. * Observable raised when the pointer move from the utility layer scene to the main scene
  53927. */
  53928. onPointerOutObservable: Observable<number>;
  53929. /** Gets or sets a predicate that will be used to indicate utility meshes present in the main scene */
  53930. mainSceneTrackerPredicate: (mesh: Nullable<AbstractMesh>) => boolean;
  53931. private _afterRenderObserver;
  53932. private _sceneDisposeObserver;
  53933. private _originalPointerObserver;
  53934. /**
  53935. * Instantiates a UtilityLayerRenderer
  53936. * @param originalScene the original scene that will be rendered on top of
  53937. * @param handleEvents boolean indicating if the utility layer should handle events
  53938. */
  53939. constructor(
  53940. /** the original scene that will be rendered on top of */
  53941. originalScene: Scene, handleEvents?: boolean);
  53942. private _notifyObservers;
  53943. /**
  53944. * Renders the utility layers scene on top of the original scene
  53945. */
  53946. render(): void;
  53947. /**
  53948. * Disposes of the renderer
  53949. */
  53950. dispose(): void;
  53951. private _updateCamera;
  53952. }
  53953. }
  53954. declare module "babylonjs/XR/features/WebXRControllerPointerSelection" {
  53955. import { WebXRSessionManager } from "babylonjs/XR/webXRSessionManager";
  53956. import { AbstractMesh } from "babylonjs/Meshes/abstractMesh";
  53957. import { WebXRInput } from "babylonjs/XR/webXRInput";
  53958. import { WebXRInputSource } from "babylonjs/XR/webXRInputSource";
  53959. import { Scene } from "babylonjs/scene";
  53960. import { Nullable } from "babylonjs/types";
  53961. import { Color3 } from "babylonjs/Maths/math.color";
  53962. import { WebXRAbstractFeature } from "babylonjs/XR/features/WebXRAbstractFeature";
  53963. import { WebXRCamera } from "babylonjs/XR/webXRCamera";
  53964. /**
  53965. * Options interface for the pointer selection module
  53966. */
  53967. export interface IWebXRControllerPointerSelectionOptions {
  53968. /**
  53969. * if provided, this scene will be used to render meshes.
  53970. */
  53971. customUtilityLayerScene?: Scene;
  53972. /**
  53973. * 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)
  53974. * If not disabled, the last picked point will be used to execute a pointer up event
  53975. * If disabled, pointer up event will be triggered right after the pointer down event.
  53976. * Used in screen and gaze target ray mode only
  53977. */
  53978. disablePointerUpOnTouchOut: boolean;
  53979. /**
  53980. * For gaze mode for tracked-pointer / controllers (time to select instead of button press)
  53981. */
  53982. forceGazeMode: boolean;
  53983. /**
  53984. * 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
  53985. * to start a new countdown to the pointer down event.
  53986. * Defaults to 1.
  53987. */
  53988. gazeModePointerMovedFactor?: number;
  53989. /**
  53990. * Different button type to use instead of the main component
  53991. */
  53992. overrideButtonId?: string;
  53993. /**
  53994. * use this rendering group id for the meshes (optional)
  53995. */
  53996. renderingGroupId?: number;
  53997. /**
  53998. * The amount of time in milliseconds it takes between pick found something to a pointer down event.
  53999. * Used in gaze modes. Tracked pointer uses the trigger, screen uses touch events
  54000. * 3000 means 3 seconds between pointing at something and selecting it
  54001. */
  54002. timeToSelect?: number;
  54003. /**
  54004. * Should meshes created here be added to a utility layer or the main scene
  54005. */
  54006. useUtilityLayer?: boolean;
  54007. /**
  54008. * Optional WebXR camera to be used for gaze selection
  54009. */
  54010. gazeCamera?: WebXRCamera;
  54011. /**
  54012. * the xr input to use with this pointer selection
  54013. */
  54014. xrInput: WebXRInput;
  54015. /**
  54016. * Should the scene pointerX and pointerY update be disabled
  54017. * This is required for fullscreen AR GUI, but might slow down other experiences.
  54018. * Disable in VR, if not needed.
  54019. * The first rig camera (left eye) will be used to calculate the projection
  54020. */
  54021. disableScenePointerVectorUpdate: boolean;
  54022. }
  54023. /**
  54024. * A module that will enable pointer selection for motion controllers of XR Input Sources
  54025. */
  54026. export class WebXRControllerPointerSelection extends WebXRAbstractFeature {
  54027. private readonly _options;
  54028. private static _idCounter;
  54029. private _attachController;
  54030. private _controllers;
  54031. private _scene;
  54032. private _tmpVectorForPickCompare;
  54033. /**
  54034. * The module's name
  54035. */
  54036. static readonly Name: string;
  54037. /**
  54038. * The (Babylon) version of this module.
  54039. * This is an integer representing the implementation version.
  54040. * This number does not correspond to the WebXR specs version
  54041. */
  54042. static readonly Version: number;
  54043. /**
  54044. * Disable lighting on the laser pointer (so it will always be visible)
  54045. */
  54046. disablePointerLighting: boolean;
  54047. /**
  54048. * Disable lighting on the selection mesh (so it will always be visible)
  54049. */
  54050. disableSelectionMeshLighting: boolean;
  54051. /**
  54052. * Should the laser pointer be displayed
  54053. */
  54054. displayLaserPointer: boolean;
  54055. /**
  54056. * Should the selection mesh be displayed (The ring at the end of the laser pointer)
  54057. */
  54058. displaySelectionMesh: boolean;
  54059. /**
  54060. * This color will be set to the laser pointer when selection is triggered
  54061. */
  54062. laserPointerPickedColor: Color3;
  54063. /**
  54064. * Default color of the laser pointer
  54065. */
  54066. laserPointerDefaultColor: Color3;
  54067. /**
  54068. * default color of the selection ring
  54069. */
  54070. selectionMeshDefaultColor: Color3;
  54071. /**
  54072. * This color will be applied to the selection ring when selection is triggered
  54073. */
  54074. selectionMeshPickedColor: Color3;
  54075. /**
  54076. * Optional filter to be used for ray selection. This predicate shares behavior with
  54077. * scene.pointerMovePredicate which takes priority if it is also assigned.
  54078. */
  54079. raySelectionPredicate: (mesh: AbstractMesh) => boolean;
  54080. /**
  54081. * constructs a new background remover module
  54082. * @param _xrSessionManager the session manager for this module
  54083. * @param _options read-only options to be used in this module
  54084. */
  54085. constructor(_xrSessionManager: WebXRSessionManager, _options: IWebXRControllerPointerSelectionOptions);
  54086. /**
  54087. * attach this feature
  54088. * Will usually be called by the features manager
  54089. *
  54090. * @returns true if successful.
  54091. */
  54092. attach(): boolean;
  54093. /**
  54094. * detach this feature.
  54095. * Will usually be called by the features manager
  54096. *
  54097. * @returns true if successful.
  54098. */
  54099. detach(): boolean;
  54100. /**
  54101. * Will get the mesh under a specific pointer.
  54102. * `scene.meshUnderPointer` will only return one mesh - either left or right.
  54103. * @param controllerId the controllerId to check
  54104. * @returns The mesh under pointer or null if no mesh is under the pointer
  54105. */
  54106. getMeshUnderPointer(controllerId: string): Nullable<AbstractMesh>;
  54107. /**
  54108. * Get the xr controller that correlates to the pointer id in the pointer event
  54109. *
  54110. * @param id the pointer id to search for
  54111. * @returns the controller that correlates to this id or null if not found
  54112. */
  54113. getXRControllerByPointerId(id: number): Nullable<WebXRInputSource>;
  54114. private _identityMatrix;
  54115. private _screenCoordinatesRef;
  54116. private _viewportRef;
  54117. protected _onXRFrame(_xrFrame: XRFrame): void;
  54118. private _attachGazeMode;
  54119. private _attachScreenRayMode;
  54120. private _attachTrackedPointerRayMode;
  54121. private _convertNormalToDirectionOfRay;
  54122. private _detachController;
  54123. private _generateNewMeshPair;
  54124. private _pickingMoved;
  54125. private _updatePointerDistance;
  54126. /** @hidden */
  54127. get lasterPointerDefaultColor(): Color3;
  54128. }
  54129. }
  54130. declare module "babylonjs/XR/webXREnterExitUI" {
  54131. import { Nullable } from "babylonjs/types";
  54132. import { Observable } from "babylonjs/Misc/observable";
  54133. import { IDisposable, Scene } from "babylonjs/scene";
  54134. import { WebXRExperienceHelper } from "babylonjs/XR/webXRExperienceHelper";
  54135. import { WebXRRenderTarget } from "babylonjs/XR/webXRTypes";
  54136. /**
  54137. * Button which can be used to enter a different mode of XR
  54138. */
  54139. export class WebXREnterExitUIButton {
  54140. /** button element */
  54141. element: HTMLElement;
  54142. /** XR initialization options for the button */
  54143. sessionMode: XRSessionMode;
  54144. /** Reference space type */
  54145. referenceSpaceType: XRReferenceSpaceType;
  54146. /**
  54147. * Creates a WebXREnterExitUIButton
  54148. * @param element button element
  54149. * @param sessionMode XR initialization session mode
  54150. * @param referenceSpaceType the type of reference space to be used
  54151. */
  54152. constructor(
  54153. /** button element */
  54154. element: HTMLElement,
  54155. /** XR initialization options for the button */
  54156. sessionMode: XRSessionMode,
  54157. /** Reference space type */
  54158. referenceSpaceType: XRReferenceSpaceType);
  54159. /**
  54160. * Extendable function which can be used to update the button's visuals when the state changes
  54161. * @param activeButton the current active button in the UI
  54162. */
  54163. update(activeButton: Nullable<WebXREnterExitUIButton>): void;
  54164. }
  54165. /**
  54166. * Options to create the webXR UI
  54167. */
  54168. export class WebXREnterExitUIOptions {
  54169. /**
  54170. * User provided buttons to enable/disable WebXR. The system will provide default if not set
  54171. */
  54172. customButtons?: Array<WebXREnterExitUIButton>;
  54173. /**
  54174. * A reference space type to use when creating the default button.
  54175. * Default is local-floor
  54176. */
  54177. referenceSpaceType?: XRReferenceSpaceType;
  54178. /**
  54179. * Context to enter xr with
  54180. */
  54181. renderTarget?: Nullable<WebXRRenderTarget>;
  54182. /**
  54183. * A session mode to use when creating the default button.
  54184. * Default is immersive-vr
  54185. */
  54186. sessionMode?: XRSessionMode;
  54187. /**
  54188. * A list of optional features to init the session with
  54189. */
  54190. optionalFeatures?: string[];
  54191. /**
  54192. * A list of optional features to init the session with
  54193. */
  54194. requiredFeatures?: string[];
  54195. }
  54196. /**
  54197. * UI to allow the user to enter/exit XR mode
  54198. */
  54199. export class WebXREnterExitUI implements IDisposable {
  54200. private scene;
  54201. /** version of the options passed to this UI */
  54202. options: WebXREnterExitUIOptions;
  54203. private _activeButton;
  54204. private _buttons;
  54205. /**
  54206. * The HTML Div Element to which buttons are added.
  54207. */
  54208. readonly overlay: HTMLDivElement;
  54209. /**
  54210. * Fired every time the active button is changed.
  54211. *
  54212. * When xr is entered via a button that launches xr that button will be the callback parameter
  54213. *
  54214. * When exiting xr the callback parameter will be null)
  54215. */
  54216. activeButtonChangedObservable: Observable<Nullable<WebXREnterExitUIButton>>;
  54217. /**
  54218. *
  54219. * @param scene babylon scene object to use
  54220. * @param options (read-only) version of the options passed to this UI
  54221. */
  54222. private constructor();
  54223. /**
  54224. * Creates UI to allow the user to enter/exit XR mode
  54225. * @param scene the scene to add the ui to
  54226. * @param helper the xr experience helper to enter/exit xr with
  54227. * @param options options to configure the UI
  54228. * @returns the created ui
  54229. */
  54230. static CreateAsync(scene: Scene, helper: WebXRExperienceHelper, options: WebXREnterExitUIOptions): Promise<WebXREnterExitUI>;
  54231. /**
  54232. * Disposes of the XR UI component
  54233. */
  54234. dispose(): void;
  54235. private _updateButtons;
  54236. }
  54237. }
  54238. declare module "babylonjs/Meshes/Builders/linesBuilder" {
  54239. import { Vector3 } from "babylonjs/Maths/math.vector";
  54240. import { Color4 } from "babylonjs/Maths/math.color";
  54241. import { Nullable } from "babylonjs/types";
  54242. import { LinesMesh } from "babylonjs/Meshes/linesMesh";
  54243. import { Scene } from "babylonjs/scene";
  54244. /**
  54245. * Class containing static functions to help procedurally build meshes
  54246. */
  54247. export class LinesBuilder {
  54248. /**
  54249. * Creates a line system mesh. A line system is a pool of many lines gathered in a single mesh
  54250. * * 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
  54251. * * Like every other parametric shape, it is dynamically updatable by passing an existing instance of LineSystem to this static function
  54252. * * The parameter `lines` is an array of lines, each line being an array of successive Vector3
  54253. * * The optional parameter `instance` is an instance of an existing LineSystem object to be updated with the passed `lines` parameter
  54254. * * The optional parameter `colors` is an array of line colors, each line colors being an array of successive Color4, one per line point
  54255. * * The optional parameter `useVertexAlpha` is to be set to `false` (default `true`) when you don't need the alpha blending (faster)
  54256. * * 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
  54257. * * When updating an instance, remember that only line point positions can change, not the number of points, neither the number of lines
  54258. * * The mesh can be set to updatable with the boolean parameter `updatable` (default false) if its internal geometry is supposed to change once created
  54259. * @see https://doc.babylonjs.com/how_to/parametric_shapes#line-system
  54260. * @param name defines the name of the new line system
  54261. * @param options defines the options used to create the line system
  54262. * @param scene defines the hosting scene
  54263. * @returns a new line system mesh
  54264. */
  54265. static CreateLineSystem(name: string, options: {
  54266. lines: Vector3[][];
  54267. updatable?: boolean;
  54268. instance?: Nullable<LinesMesh>;
  54269. colors?: Nullable<Color4[][]>;
  54270. useVertexAlpha?: boolean;
  54271. }, scene: Nullable<Scene>): LinesMesh;
  54272. /**
  54273. * Creates a line mesh
  54274. * 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
  54275. * * Like every other parametric shape, it is dynamically updatable by passing an existing instance of LineMesh to this static function
  54276. * * The parameter `points` is an array successive Vector3
  54277. * * 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
  54278. * * The optional parameter `colors` is an array of successive Color4, one per line point
  54279. * * The optional parameter `useVertexAlpha` is to be set to `false` (default `true`) when you don't need alpha blending (faster)
  54280. * * When updating an instance, remember that only point positions can change, not the number of points
  54281. * * The mesh can be set to updatable with the boolean parameter `updatable` (default false) if its internal geometry is supposed to change once created
  54282. * @see https://doc.babylonjs.com/how_to/parametric_shapes#lines
  54283. * @param name defines the name of the new line system
  54284. * @param options defines the options used to create the line system
  54285. * @param scene defines the hosting scene
  54286. * @returns a new line mesh
  54287. */
  54288. static CreateLines(name: string, options: {
  54289. points: Vector3[];
  54290. updatable?: boolean;
  54291. instance?: Nullable<LinesMesh>;
  54292. colors?: Color4[];
  54293. useVertexAlpha?: boolean;
  54294. }, scene?: Nullable<Scene>): LinesMesh;
  54295. /**
  54296. * Creates a dashed line mesh
  54297. * * 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
  54298. * * Like every other parametric shape, it is dynamically updatable by passing an existing instance of LineMesh to this static function
  54299. * * The parameter `points` is an array successive Vector3
  54300. * * The parameter `dashNb` is the intended total number of dashes (positive integer, default 200)
  54301. * * The parameter `dashSize` is the size of the dashes relatively the dash number (positive float, default 3)
  54302. * * The parameter `gapSize` is the size of the gap between two successive dashes relatively the dash number (positive float, default 1)
  54303. * * 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
  54304. * * The optional parameter `useVertexAlpha` is to be set to `false` (default `true`) when you don't need the alpha blending (faster)
  54305. * * When updating an instance, remember that only point positions can change, not the number of points
  54306. * * The mesh can be set to updatable with the boolean parameter `updatable` (default false) if its internal geometry is supposed to change once created
  54307. * @param name defines the name of the mesh
  54308. * @param options defines the options used to create the mesh
  54309. * @param scene defines the hosting scene
  54310. * @returns the dashed line mesh
  54311. * @see https://doc.babylonjs.com/how_to/parametric_shapes#dashed-lines
  54312. */
  54313. static CreateDashedLines(name: string, options: {
  54314. points: Vector3[];
  54315. dashSize?: number;
  54316. gapSize?: number;
  54317. dashNb?: number;
  54318. updatable?: boolean;
  54319. instance?: LinesMesh;
  54320. useVertexAlpha?: boolean;
  54321. }, scene?: Nullable<Scene>): LinesMesh;
  54322. }
  54323. }
  54324. declare module "babylonjs/Misc/timer" {
  54325. import { Observable, Observer } from "babylonjs/Misc/observable";
  54326. import { Nullable } from "babylonjs/types";
  54327. import { IDisposable } from "babylonjs/scene";
  54328. /**
  54329. * Construction options for a timer
  54330. */
  54331. export interface ITimerOptions<T> {
  54332. /**
  54333. * Time-to-end
  54334. */
  54335. timeout: number;
  54336. /**
  54337. * The context observable is used to calculate time deltas and provides the context of the timer's callbacks. Will usually be OnBeforeRenderObservable.
  54338. * Countdown calculation is done ONLY when the observable is notifying its observers, meaning that if
  54339. * you choose an observable that doesn't trigger too often, the wait time might extend further than the requested max time
  54340. */
  54341. contextObservable: Observable<T>;
  54342. /**
  54343. * Optional parameters when adding an observer to the observable
  54344. */
  54345. observableParameters?: {
  54346. mask?: number;
  54347. insertFirst?: boolean;
  54348. scope?: any;
  54349. };
  54350. /**
  54351. * An optional break condition that will stop the times prematurely. In this case onEnded will not be triggered!
  54352. */
  54353. breakCondition?: (data?: ITimerData<T>) => boolean;
  54354. /**
  54355. * Will be triggered when the time condition has met
  54356. */
  54357. onEnded?: (data: ITimerData<any>) => void;
  54358. /**
  54359. * Will be triggered when the break condition has met (prematurely ended)
  54360. */
  54361. onAborted?: (data: ITimerData<any>) => void;
  54362. /**
  54363. * Optional function to execute on each tick (or count)
  54364. */
  54365. onTick?: (data: ITimerData<any>) => void;
  54366. }
  54367. /**
  54368. * An interface defining the data sent by the timer
  54369. */
  54370. export interface ITimerData<T> {
  54371. /**
  54372. * When did it start
  54373. */
  54374. startTime: number;
  54375. /**
  54376. * Time now
  54377. */
  54378. currentTime: number;
  54379. /**
  54380. * Time passed since started
  54381. */
  54382. deltaTime: number;
  54383. /**
  54384. * How much is completed, in [0.0...1.0].
  54385. * Note that this CAN be higher than 1 due to the fact that we don't actually measure time but delta between observable calls
  54386. */
  54387. completeRate: number;
  54388. /**
  54389. * What the registered observable sent in the last count
  54390. */
  54391. payload: T;
  54392. }
  54393. /**
  54394. * The current state of the timer
  54395. */
  54396. export enum TimerState {
  54397. /**
  54398. * Timer initialized, not yet started
  54399. */
  54400. INIT = 0,
  54401. /**
  54402. * Timer started and counting
  54403. */
  54404. STARTED = 1,
  54405. /**
  54406. * Timer ended (whether aborted or time reached)
  54407. */
  54408. ENDED = 2
  54409. }
  54410. /**
  54411. * A simple version of the timer. Will take options and start the timer immediately after calling it
  54412. *
  54413. * @param options options with which to initialize this timer
  54414. */
  54415. export function setAndStartTimer(options: ITimerOptions<any>): Nullable<Observer<any>>;
  54416. /**
  54417. * An advanced implementation of a timer class
  54418. */
  54419. export class AdvancedTimer<T = any> implements IDisposable {
  54420. /**
  54421. * Will notify each time the timer calculates the remaining time
  54422. */
  54423. onEachCountObservable: Observable<ITimerData<T>>;
  54424. /**
  54425. * Will trigger when the timer was aborted due to the break condition
  54426. */
  54427. onTimerAbortedObservable: Observable<ITimerData<T>>;
  54428. /**
  54429. * Will trigger when the timer ended successfully
  54430. */
  54431. onTimerEndedObservable: Observable<ITimerData<T>>;
  54432. /**
  54433. * Will trigger when the timer state has changed
  54434. */
  54435. onStateChangedObservable: Observable<TimerState>;
  54436. private _observer;
  54437. private _contextObservable;
  54438. private _observableParameters;
  54439. private _startTime;
  54440. private _timer;
  54441. private _state;
  54442. private _breakCondition;
  54443. private _timeToEnd;
  54444. private _breakOnNextTick;
  54445. /**
  54446. * Will construct a new advanced timer based on the options provided. Timer will not start until start() is called.
  54447. * @param options construction options for this advanced timer
  54448. */
  54449. constructor(options: ITimerOptions<T>);
  54450. /**
  54451. * set a breaking condition for this timer. Default is to never break during count
  54452. * @param predicate the new break condition. Returns true to break, false otherwise
  54453. */
  54454. set breakCondition(predicate: (data: ITimerData<T>) => boolean);
  54455. /**
  54456. * Reset ALL associated observables in this advanced timer
  54457. */
  54458. clearObservables(): void;
  54459. /**
  54460. * Will start a new iteration of this timer. Only one instance of this timer can run at a time.
  54461. *
  54462. * @param timeToEnd how much time to measure until timer ended
  54463. */
  54464. start(timeToEnd?: number): void;
  54465. /**
  54466. * Will force a stop on the next tick.
  54467. */
  54468. stop(): void;
  54469. /**
  54470. * Dispose this timer, clearing all resources
  54471. */
  54472. dispose(): void;
  54473. private _setState;
  54474. private _tick;
  54475. private _stop;
  54476. }
  54477. }
  54478. declare module "babylonjs/XR/features/WebXRControllerTeleportation" {
  54479. import { IWebXRFeature } from "babylonjs/XR/webXRFeaturesManager";
  54480. import { WebXRSessionManager } from "babylonjs/XR/webXRSessionManager";
  54481. import { Nullable } from "babylonjs/types";
  54482. import { WebXRInput } from "babylonjs/XR/webXRInput";
  54483. import { AbstractMesh } from "babylonjs/Meshes/abstractMesh";
  54484. import { Vector3 } from "babylonjs/Maths/math.vector";
  54485. import { Material } from "babylonjs/Materials/material";
  54486. import { WebXRAbstractFeature } from "babylonjs/XR/features/WebXRAbstractFeature";
  54487. import { Scene } from "babylonjs/scene";
  54488. /**
  54489. * The options container for the teleportation module
  54490. */
  54491. export interface IWebXRTeleportationOptions {
  54492. /**
  54493. * if provided, this scene will be used to render meshes.
  54494. */
  54495. customUtilityLayerScene?: Scene;
  54496. /**
  54497. * Values to configure the default target mesh
  54498. */
  54499. defaultTargetMeshOptions?: {
  54500. /**
  54501. * Fill color of the teleportation area
  54502. */
  54503. teleportationFillColor?: string;
  54504. /**
  54505. * Border color for the teleportation area
  54506. */
  54507. teleportationBorderColor?: string;
  54508. /**
  54509. * Disable the mesh's animation sequence
  54510. */
  54511. disableAnimation?: boolean;
  54512. /**
  54513. * Disable lighting on the material or the ring and arrow
  54514. */
  54515. disableLighting?: boolean;
  54516. /**
  54517. * Override the default material of the torus and arrow
  54518. */
  54519. torusArrowMaterial?: Material;
  54520. };
  54521. /**
  54522. * A list of meshes to use as floor meshes.
  54523. * Meshes can be added and removed after initializing the feature using the
  54524. * addFloorMesh and removeFloorMesh functions
  54525. * If empty, rotation will still work
  54526. */
  54527. floorMeshes?: AbstractMesh[];
  54528. /**
  54529. * use this rendering group id for the meshes (optional)
  54530. */
  54531. renderingGroupId?: number;
  54532. /**
  54533. * Should teleportation move only to snap points
  54534. */
  54535. snapPointsOnly?: boolean;
  54536. /**
  54537. * An array of points to which the teleportation will snap to.
  54538. * If the teleportation ray is in the proximity of one of those points, it will be corrected to this point.
  54539. */
  54540. snapPositions?: Vector3[];
  54541. /**
  54542. * How close should the teleportation ray be in order to snap to position.
  54543. * Default to 0.8 units (meters)
  54544. */
  54545. snapToPositionRadius?: number;
  54546. /**
  54547. * Provide your own teleportation mesh instead of babylon's wonderful doughnut.
  54548. * If you want to support rotation, make sure your mesh has a direction indicator.
  54549. *
  54550. * When left untouched, the default mesh will be initialized.
  54551. */
  54552. teleportationTargetMesh?: AbstractMesh;
  54553. /**
  54554. * If main component is used (no thumbstick), how long should the "long press" take before teleport
  54555. */
  54556. timeToTeleport?: number;
  54557. /**
  54558. * Disable using the thumbstick and use the main component (usually trigger) on long press.
  54559. * This will be automatically true if the controller doesn't have a thumbstick or touchpad.
  54560. */
  54561. useMainComponentOnly?: boolean;
  54562. /**
  54563. * Should meshes created here be added to a utility layer or the main scene
  54564. */
  54565. useUtilityLayer?: boolean;
  54566. /**
  54567. * Babylon XR Input class for controller
  54568. */
  54569. xrInput: WebXRInput;
  54570. /**
  54571. * Meshes that the teleportation ray cannot go through
  54572. */
  54573. pickBlockerMeshes?: AbstractMesh[];
  54574. }
  54575. /**
  54576. * This is a teleportation feature to be used with WebXR-enabled motion controllers.
  54577. * When enabled and attached, the feature will allow a user to move around and rotate in the scene using
  54578. * the input of the attached controllers.
  54579. */
  54580. export class WebXRMotionControllerTeleportation extends WebXRAbstractFeature {
  54581. private _options;
  54582. private _controllers;
  54583. private _currentTeleportationControllerId;
  54584. private _floorMeshes;
  54585. private _quadraticBezierCurve;
  54586. private _selectionFeature;
  54587. private _snapToPositions;
  54588. private _snappedToPoint;
  54589. private _teleportationRingMaterial?;
  54590. private _tmpRay;
  54591. private _tmpVector;
  54592. private _tmpQuaternion;
  54593. /**
  54594. * The module's name
  54595. */
  54596. static readonly Name: string;
  54597. /**
  54598. * The (Babylon) version of this module.
  54599. * This is an integer representing the implementation version.
  54600. * This number does not correspond to the webxr specs version
  54601. */
  54602. static readonly Version: number;
  54603. /**
  54604. * Is movement backwards enabled
  54605. */
  54606. backwardsMovementEnabled: boolean;
  54607. /**
  54608. * Distance to travel when moving backwards
  54609. */
  54610. backwardsTeleportationDistance: number;
  54611. /**
  54612. * The distance from the user to the inspection point in the direction of the controller
  54613. * A higher number will allow the user to move further
  54614. * defaults to 5 (meters, in xr units)
  54615. */
  54616. parabolicCheckRadius: number;
  54617. /**
  54618. * Should the module support parabolic ray on top of direct ray
  54619. * If enabled, the user will be able to point "at the sky" and move according to predefined radius distance
  54620. * Very helpful when moving between floors / different heights
  54621. */
  54622. parabolicRayEnabled: boolean;
  54623. /**
  54624. * How much rotation should be applied when rotating right and left
  54625. */
  54626. rotationAngle: number;
  54627. /**
  54628. * Is rotation enabled when moving forward?
  54629. * Disabling this feature will prevent the user from deciding the direction when teleporting
  54630. */
  54631. rotationEnabled: boolean;
  54632. /**
  54633. * constructs a new anchor system
  54634. * @param _xrSessionManager an instance of WebXRSessionManager
  54635. * @param _options configuration object for this feature
  54636. */
  54637. constructor(_xrSessionManager: WebXRSessionManager, _options: IWebXRTeleportationOptions);
  54638. /**
  54639. * Get the snapPointsOnly flag
  54640. */
  54641. get snapPointsOnly(): boolean;
  54642. /**
  54643. * Sets the snapPointsOnly flag
  54644. * @param snapToPoints should teleportation be exclusively to snap points
  54645. */
  54646. set snapPointsOnly(snapToPoints: boolean);
  54647. /**
  54648. * Add a new mesh to the floor meshes array
  54649. * @param mesh the mesh to use as floor mesh
  54650. */
  54651. addFloorMesh(mesh: AbstractMesh): void;
  54652. /**
  54653. * Add a new snap-to point to fix teleportation to this position
  54654. * @param newSnapPoint The new Snap-To point
  54655. */
  54656. addSnapPoint(newSnapPoint: Vector3): void;
  54657. attach(): boolean;
  54658. detach(): boolean;
  54659. dispose(): void;
  54660. /**
  54661. * Remove a mesh from the floor meshes array
  54662. * @param mesh the mesh to remove
  54663. */
  54664. removeFloorMesh(mesh: AbstractMesh): void;
  54665. /**
  54666. * Remove a mesh from the floor meshes array using its name
  54667. * @param name the mesh name to remove
  54668. */
  54669. removeFloorMeshByName(name: string): void;
  54670. /**
  54671. * 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
  54672. * @param snapPointToRemove the point (or a clone of it) to be removed from the array
  54673. * @returns was the point found and removed or not
  54674. */
  54675. removeSnapPoint(snapPointToRemove: Vector3): boolean;
  54676. /**
  54677. * This function sets a selection feature that will be disabled when
  54678. * the forward ray is shown and will be reattached when hidden.
  54679. * This is used to remove the selection rays when moving.
  54680. * @param selectionFeature the feature to disable when forward movement is enabled
  54681. */
  54682. setSelectionFeature(selectionFeature: Nullable<IWebXRFeature>): void;
  54683. protected _onXRFrame(_xrFrame: XRFrame): void;
  54684. private _attachController;
  54685. private _createDefaultTargetMesh;
  54686. private _detachController;
  54687. private _findClosestSnapPointWithRadius;
  54688. private _setTargetMeshPosition;
  54689. private _setTargetMeshVisibility;
  54690. private _showParabolicPath;
  54691. private _teleportForward;
  54692. }
  54693. }
  54694. declare module "babylonjs/XR/webXRDefaultExperience" {
  54695. import { WebXRExperienceHelper } from "babylonjs/XR/webXRExperienceHelper";
  54696. import { Scene } from "babylonjs/scene";
  54697. import { WebXRInput, IWebXRInputOptions } from "babylonjs/XR/webXRInput";
  54698. import { WebXRControllerPointerSelection } from "babylonjs/XR/features/WebXRControllerPointerSelection";
  54699. import { WebXRRenderTarget } from "babylonjs/XR/webXRTypes";
  54700. import { WebXREnterExitUI, WebXREnterExitUIOptions } from "babylonjs/XR/webXREnterExitUI";
  54701. import { AbstractMesh } from "babylonjs/Meshes/abstractMesh";
  54702. import { WebXRManagedOutputCanvasOptions } from "babylonjs/XR/webXRManagedOutputCanvas";
  54703. import { WebXRMotionControllerTeleportation } from "babylonjs/XR/features/WebXRControllerTeleportation";
  54704. /**
  54705. * Options for the default xr helper
  54706. */
  54707. export class WebXRDefaultExperienceOptions {
  54708. /**
  54709. * Enable or disable default UI to enter XR
  54710. */
  54711. disableDefaultUI?: boolean;
  54712. /**
  54713. * Should teleportation not initialize. defaults to false.
  54714. */
  54715. disableTeleportation?: boolean;
  54716. /**
  54717. * Floor meshes that will be used for teleport
  54718. */
  54719. floorMeshes?: Array<AbstractMesh>;
  54720. /**
  54721. * If set to true, the first frame will not be used to reset position
  54722. * The first frame is mainly used when copying transformation from the old camera
  54723. * Mainly used in AR
  54724. */
  54725. ignoreNativeCameraTransformation?: boolean;
  54726. /**
  54727. * Disable the controller mesh-loading. Can be used if you want to load your own meshes
  54728. */
  54729. inputOptions?: IWebXRInputOptions;
  54730. /**
  54731. * optional configuration for the output canvas
  54732. */
  54733. outputCanvasOptions?: WebXRManagedOutputCanvasOptions;
  54734. /**
  54735. * optional UI options. This can be used among other to change session mode and reference space type
  54736. */
  54737. uiOptions?: WebXREnterExitUIOptions;
  54738. /**
  54739. * When loading teleportation and pointer select, use stable versions instead of latest.
  54740. */
  54741. useStablePlugins?: boolean;
  54742. /**
  54743. * An optional rendering group id that will be set globally for teleportation, pointer selection and default controller meshes
  54744. */
  54745. renderingGroupId?: number;
  54746. /**
  54747. * A list of optional features to init the session with
  54748. * If set to true, all features we support will be added
  54749. */
  54750. optionalFeatures?: boolean | string[];
  54751. }
  54752. /**
  54753. * Default experience which provides a similar setup to the previous webVRExperience
  54754. */
  54755. export class WebXRDefaultExperience {
  54756. /**
  54757. * Base experience
  54758. */
  54759. baseExperience: WebXRExperienceHelper;
  54760. /**
  54761. * Enables ui for entering/exiting xr
  54762. */
  54763. enterExitUI: WebXREnterExitUI;
  54764. /**
  54765. * Input experience extension
  54766. */
  54767. input: WebXRInput;
  54768. /**
  54769. * Enables laser pointer and selection
  54770. */
  54771. pointerSelection: WebXRControllerPointerSelection;
  54772. /**
  54773. * Default target xr should render to
  54774. */
  54775. renderTarget: WebXRRenderTarget;
  54776. /**
  54777. * Enables teleportation
  54778. */
  54779. teleportation: WebXRMotionControllerTeleportation;
  54780. private constructor();
  54781. /**
  54782. * Creates the default xr experience
  54783. * @param scene scene
  54784. * @param options options for basic configuration
  54785. * @returns resulting WebXRDefaultExperience
  54786. */
  54787. static CreateAsync(scene: Scene, options?: WebXRDefaultExperienceOptions): Promise<WebXRDefaultExperience>;
  54788. /**
  54789. * DIsposes of the experience helper
  54790. */
  54791. dispose(): void;
  54792. }
  54793. }
  54794. declare module "babylonjs/Cameras/VR/vrExperienceHelper" {
  54795. import { Observable } from "babylonjs/Misc/observable";
  54796. import { Nullable } from "babylonjs/types";
  54797. import { Camera } from "babylonjs/Cameras/camera";
  54798. import { DeviceOrientationCamera } from "babylonjs/Cameras/deviceOrientationCamera";
  54799. import { VRDeviceOrientationFreeCamera } from "babylonjs/Cameras/VR/vrDeviceOrientationFreeCamera";
  54800. import { WebVROptions, WebVRFreeCamera } from "babylonjs/Cameras/VR/webVRCamera";
  54801. import { Scene } from "babylonjs/scene";
  54802. import { Vector3 } from "babylonjs/Maths/math.vector";
  54803. import { Color3 } from "babylonjs/Maths/math.color";
  54804. import { WebVRController } from "babylonjs/Gamepads/Controllers/webVRController";
  54805. import { AbstractMesh } from "babylonjs/Meshes/abstractMesh";
  54806. import { Mesh } from "babylonjs/Meshes/mesh";
  54807. import { PickingInfo } from "babylonjs/Collisions/pickingInfo";
  54808. import { EasingFunction } from "babylonjs/Animations/easing";
  54809. import { VRCameraMetrics } from "babylonjs/Cameras/VR/vrCameraMetrics";
  54810. import "babylonjs/Meshes/Builders/groundBuilder";
  54811. import "babylonjs/Meshes/Builders/torusBuilder";
  54812. import "babylonjs/Meshes/Builders/cylinderBuilder";
  54813. import "babylonjs/Gamepads/gamepadSceneComponent";
  54814. import "babylonjs/Animations/animatable";
  54815. import { WebXRDefaultExperience } from "babylonjs/XR/webXRDefaultExperience";
  54816. /**
  54817. * Options to modify the vr teleportation behavior.
  54818. */
  54819. export interface VRTeleportationOptions {
  54820. /**
  54821. * The name of the mesh which should be used as the teleportation floor. (default: null)
  54822. */
  54823. floorMeshName?: string;
  54824. /**
  54825. * A list of meshes to be used as the teleportation floor. (default: empty)
  54826. */
  54827. floorMeshes?: Mesh[];
  54828. /**
  54829. * The teleportation mode. (default: TELEPORTATIONMODE_CONSTANTTIME)
  54830. */
  54831. teleportationMode?: number;
  54832. /**
  54833. * The duration of the animation in ms, apply when animationMode is TELEPORTATIONMODE_CONSTANTTIME. (default 122ms)
  54834. */
  54835. teleportationTime?: number;
  54836. /**
  54837. * The speed of the animation in distance/sec, apply when animationMode is TELEPORTATIONMODE_CONSTANTSPEED. (default 20 units / sec)
  54838. */
  54839. teleportationSpeed?: number;
  54840. /**
  54841. * The easing function used in the animation or null for Linear. (default CircleEase)
  54842. */
  54843. easingFunction?: EasingFunction;
  54844. }
  54845. /**
  54846. * Options to modify the vr experience helper's behavior.
  54847. */
  54848. export interface VRExperienceHelperOptions extends WebVROptions {
  54849. /**
  54850. * Create a DeviceOrientationCamera to be used as your out of vr camera. (default: true)
  54851. */
  54852. createDeviceOrientationCamera?: boolean;
  54853. /**
  54854. * Create a VRDeviceOrientationFreeCamera to be used for VR when no external HMD is found. (default: true)
  54855. */
  54856. createFallbackVRDeviceOrientationFreeCamera?: boolean;
  54857. /**
  54858. * Uses the main button on the controller to toggle the laser casted. (default: true)
  54859. */
  54860. laserToggle?: boolean;
  54861. /**
  54862. * A list of meshes to be used as the teleportation floor. If specified, teleportation will be enabled (default: undefined)
  54863. */
  54864. floorMeshes?: Mesh[];
  54865. /**
  54866. * Distortion metrics for the fallback vrDeviceOrientationCamera (default: VRCameraMetrics.Default)
  54867. */
  54868. vrDeviceOrientationCameraMetrics?: VRCameraMetrics;
  54869. /**
  54870. * Defines if WebXR should be used instead of WebVR (if available)
  54871. */
  54872. useXR?: boolean;
  54873. }
  54874. /**
  54875. * Event containing information after VR has been entered
  54876. */
  54877. export class OnAfterEnteringVRObservableEvent {
  54878. /**
  54879. * If entering vr was successful
  54880. */
  54881. success: boolean;
  54882. }
  54883. /**
  54884. * Helps to quickly add VR support to an existing scene.
  54885. * See https://doc.babylonjs.com/how_to/webvr_helper
  54886. */
  54887. export class VRExperienceHelper {
  54888. /** Options to modify the vr experience helper's behavior. */
  54889. webVROptions: VRExperienceHelperOptions;
  54890. private _scene;
  54891. private _position;
  54892. private _btnVR;
  54893. private _btnVRDisplayed;
  54894. private _webVRsupported;
  54895. private _webVRready;
  54896. private _webVRrequesting;
  54897. private _webVRpresenting;
  54898. private _hasEnteredVR;
  54899. private _fullscreenVRpresenting;
  54900. private _inputElement;
  54901. private _webVRCamera;
  54902. private _vrDeviceOrientationCamera;
  54903. private _deviceOrientationCamera;
  54904. private _existingCamera;
  54905. private _onKeyDown;
  54906. private _onVrDisplayPresentChange;
  54907. private _onVRDisplayChanged;
  54908. private _onVRRequestPresentStart;
  54909. private _onVRRequestPresentComplete;
  54910. /**
  54911. * 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)
  54912. */
  54913. enableGazeEvenWhenNoPointerLock: boolean;
  54914. /**
  54915. * Gets or sets a boolean indicating that the VREXperienceHelper will exit VR if double tap is detected
  54916. */
  54917. exitVROnDoubleTap: boolean;
  54918. /**
  54919. * Observable raised right before entering VR.
  54920. */
  54921. onEnteringVRObservable: Observable<VRExperienceHelper>;
  54922. /**
  54923. * Observable raised when entering VR has completed.
  54924. */
  54925. onAfterEnteringVRObservable: Observable<OnAfterEnteringVRObservableEvent>;
  54926. /**
  54927. * Observable raised when exiting VR.
  54928. */
  54929. onExitingVRObservable: Observable<VRExperienceHelper>;
  54930. /**
  54931. * Observable raised when controller mesh is loaded.
  54932. */
  54933. onControllerMeshLoadedObservable: Observable<WebVRController>;
  54934. /** Return this.onEnteringVRObservable
  54935. * Note: This one is for backward compatibility. Please use onEnteringVRObservable directly
  54936. */
  54937. get onEnteringVR(): Observable<VRExperienceHelper>;
  54938. /** Return this.onExitingVRObservable
  54939. * Note: This one is for backward compatibility. Please use onExitingVRObservable directly
  54940. */
  54941. get onExitingVR(): Observable<VRExperienceHelper>;
  54942. /** Return this.onControllerMeshLoadedObservable
  54943. * Note: This one is for backward compatibility. Please use onControllerMeshLoadedObservable directly
  54944. */
  54945. get onControllerMeshLoaded(): Observable<WebVRController>;
  54946. private _rayLength;
  54947. private _useCustomVRButton;
  54948. private _teleportationRequested;
  54949. private _teleportActive;
  54950. private _floorMeshName;
  54951. private _floorMeshesCollection;
  54952. private _teleportationMode;
  54953. private _teleportationTime;
  54954. private _teleportationSpeed;
  54955. private _teleportationEasing;
  54956. private _rotationAllowed;
  54957. private _teleportBackwardsVector;
  54958. private _teleportationTarget;
  54959. private _isDefaultTeleportationTarget;
  54960. private _postProcessMove;
  54961. private _teleportationFillColor;
  54962. private _teleportationBorderColor;
  54963. private _rotationAngle;
  54964. private _haloCenter;
  54965. private _cameraGazer;
  54966. private _padSensibilityUp;
  54967. private _padSensibilityDown;
  54968. private _leftController;
  54969. private _rightController;
  54970. private _gazeColor;
  54971. private _laserColor;
  54972. private _pickedLaserColor;
  54973. private _pickedGazeColor;
  54974. /**
  54975. * Observable raised when a new mesh is selected based on meshSelectionPredicate
  54976. */
  54977. onNewMeshSelected: Observable<AbstractMesh>;
  54978. /**
  54979. * Observable raised when a new mesh is selected based on meshSelectionPredicate.
  54980. * This observable will provide the mesh and the controller used to select the mesh
  54981. */
  54982. onMeshSelectedWithController: Observable<{
  54983. mesh: AbstractMesh;
  54984. controller: WebVRController;
  54985. }>;
  54986. /**
  54987. * Observable raised when a new mesh is picked based on meshSelectionPredicate
  54988. */
  54989. onNewMeshPicked: Observable<PickingInfo>;
  54990. private _circleEase;
  54991. /**
  54992. * Observable raised before camera teleportation
  54993. */
  54994. onBeforeCameraTeleport: Observable<Vector3>;
  54995. /**
  54996. * Observable raised after camera teleportation
  54997. */
  54998. onAfterCameraTeleport: Observable<Vector3>;
  54999. /**
  55000. * Observable raised when current selected mesh gets unselected
  55001. */
  55002. onSelectedMeshUnselected: Observable<AbstractMesh>;
  55003. private _raySelectionPredicate;
  55004. /**
  55005. * To be optionaly changed by user to define custom ray selection
  55006. */
  55007. raySelectionPredicate: (mesh: AbstractMesh) => boolean;
  55008. /**
  55009. * To be optionaly changed by user to define custom selection logic (after ray selection)
  55010. */
  55011. meshSelectionPredicate: (mesh: AbstractMesh) => boolean;
  55012. /**
  55013. * Set teleportation enabled. If set to false camera teleportation will be disabled but camera rotation will be kept.
  55014. */
  55015. teleportationEnabled: boolean;
  55016. private _defaultHeight;
  55017. private _teleportationInitialized;
  55018. private _interactionsEnabled;
  55019. private _interactionsRequested;
  55020. private _displayGaze;
  55021. private _displayLaserPointer;
  55022. /**
  55023. * The mesh used to display where the user is going to teleport.
  55024. */
  55025. get teleportationTarget(): Mesh;
  55026. /**
  55027. * Sets the mesh to be used to display where the user is going to teleport.
  55028. */
  55029. set teleportationTarget(value: Mesh);
  55030. /**
  55031. * 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
  55032. * when set bakeCurrentTransformIntoVertices will be called on the mesh.
  55033. * See https://doc.babylonjs.com/resources/baking_transformations
  55034. */
  55035. get gazeTrackerMesh(): Mesh;
  55036. set gazeTrackerMesh(value: Mesh);
  55037. /**
  55038. * If the gaze trackers scale should be updated to be constant size when pointing at near/far meshes
  55039. */
  55040. updateGazeTrackerScale: boolean;
  55041. /**
  55042. * If the gaze trackers color should be updated when selecting meshes
  55043. */
  55044. updateGazeTrackerColor: boolean;
  55045. /**
  55046. * If the controller laser color should be updated when selecting meshes
  55047. */
  55048. updateControllerLaserColor: boolean;
  55049. /**
  55050. * The gaze tracking mesh corresponding to the left controller
  55051. */
  55052. get leftControllerGazeTrackerMesh(): Nullable<Mesh>;
  55053. /**
  55054. * The gaze tracking mesh corresponding to the right controller
  55055. */
  55056. get rightControllerGazeTrackerMesh(): Nullable<Mesh>;
  55057. /**
  55058. * If the ray of the gaze should be displayed.
  55059. */
  55060. get displayGaze(): boolean;
  55061. /**
  55062. * Sets if the ray of the gaze should be displayed.
  55063. */
  55064. set displayGaze(value: boolean);
  55065. /**
  55066. * If the ray of the LaserPointer should be displayed.
  55067. */
  55068. get displayLaserPointer(): boolean;
  55069. /**
  55070. * Sets if the ray of the LaserPointer should be displayed.
  55071. */
  55072. set displayLaserPointer(value: boolean);
  55073. /**
  55074. * The deviceOrientationCamera used as the camera when not in VR.
  55075. */
  55076. get deviceOrientationCamera(): Nullable<DeviceOrientationCamera>;
  55077. /**
  55078. * Based on the current WebVR support, returns the current VR camera used.
  55079. */
  55080. get currentVRCamera(): Nullable<Camera>;
  55081. /**
  55082. * The webVRCamera which is used when in VR.
  55083. */
  55084. get webVRCamera(): WebVRFreeCamera;
  55085. /**
  55086. * The deviceOrientationCamera that is used as a fallback when vr device is not connected.
  55087. */
  55088. get vrDeviceOrientationCamera(): Nullable<VRDeviceOrientationFreeCamera>;
  55089. /**
  55090. * The html button that is used to trigger entering into VR.
  55091. */
  55092. get vrButton(): Nullable<HTMLButtonElement>;
  55093. private get _teleportationRequestInitiated();
  55094. /**
  55095. * Defines whether or not Pointer lock should be requested when switching to
  55096. * full screen.
  55097. */
  55098. requestPointerLockOnFullScreen: boolean;
  55099. /**
  55100. * If asking to force XR, this will be populated with the default xr experience
  55101. */
  55102. xr: WebXRDefaultExperience;
  55103. /**
  55104. * Was the XR test done already. If this is true AND this.xr exists, xr is initialized.
  55105. * If this is true and no this.xr, xr exists but is not supported, using WebVR.
  55106. */
  55107. xrTestDone: boolean;
  55108. /**
  55109. * Instantiates a VRExperienceHelper.
  55110. * Helps to quickly add VR support to an existing scene.
  55111. * @param scene The scene the VRExperienceHelper belongs to.
  55112. * @param webVROptions Options to modify the vr experience helper's behavior.
  55113. */
  55114. constructor(scene: Scene,
  55115. /** Options to modify the vr experience helper's behavior. */
  55116. webVROptions?: VRExperienceHelperOptions);
  55117. private completeVRInit;
  55118. private _onDefaultMeshLoaded;
  55119. private _onResize;
  55120. private _onFullscreenChange;
  55121. /**
  55122. * Gets a value indicating if we are currently in VR mode.
  55123. */
  55124. get isInVRMode(): boolean;
  55125. private onVrDisplayPresentChange;
  55126. private onVRDisplayChanged;
  55127. private moveButtonToBottomRight;
  55128. private displayVRButton;
  55129. private updateButtonVisibility;
  55130. private _cachedAngularSensibility;
  55131. /**
  55132. * Attempt to enter VR. If a headset is connected and ready, will request present on that.
  55133. * Otherwise, will use the fullscreen API.
  55134. */
  55135. enterVR(): void;
  55136. /**
  55137. * Attempt to exit VR, or fullscreen.
  55138. */
  55139. exitVR(): void;
  55140. /**
  55141. * The position of the vr experience helper.
  55142. */
  55143. get position(): Vector3;
  55144. /**
  55145. * Sets the position of the vr experience helper.
  55146. */
  55147. set position(value: Vector3);
  55148. /**
  55149. * Enables controllers and user interactions such as selecting and object or clicking on an object.
  55150. */
  55151. enableInteractions(): void;
  55152. private get _noControllerIsActive();
  55153. private beforeRender;
  55154. private _isTeleportationFloor;
  55155. /**
  55156. * Adds a floor mesh to be used for teleportation.
  55157. * @param floorMesh the mesh to be used for teleportation.
  55158. */
  55159. addFloorMesh(floorMesh: Mesh): void;
  55160. /**
  55161. * Removes a floor mesh from being used for teleportation.
  55162. * @param floorMesh the mesh to be removed.
  55163. */
  55164. removeFloorMesh(floorMesh: Mesh): void;
  55165. /**
  55166. * Enables interactions and teleportation using the VR controllers and gaze.
  55167. * @param vrTeleportationOptions options to modify teleportation behavior.
  55168. */
  55169. enableTeleportation(vrTeleportationOptions?: VRTeleportationOptions): void;
  55170. private _onNewGamepadConnected;
  55171. private _tryEnableInteractionOnController;
  55172. private _onNewGamepadDisconnected;
  55173. private _enableInteractionOnController;
  55174. private _checkTeleportWithRay;
  55175. private _checkRotate;
  55176. private _checkTeleportBackwards;
  55177. private _enableTeleportationOnController;
  55178. private _createTeleportationCircles;
  55179. private _displayTeleportationTarget;
  55180. private _hideTeleportationTarget;
  55181. private _rotateCamera;
  55182. private _moveTeleportationSelectorTo;
  55183. private _workingVector;
  55184. private _workingQuaternion;
  55185. private _workingMatrix;
  55186. /**
  55187. * Time Constant Teleportation Mode
  55188. */
  55189. static readonly TELEPORTATIONMODE_CONSTANTTIME: number;
  55190. /**
  55191. * Speed Constant Teleportation Mode
  55192. */
  55193. static readonly TELEPORTATIONMODE_CONSTANTSPEED: number;
  55194. /**
  55195. * Teleports the users feet to the desired location
  55196. * @param location The location where the user's feet should be placed
  55197. */
  55198. teleportCamera(location: Vector3): void;
  55199. private _convertNormalToDirectionOfRay;
  55200. private _castRayAndSelectObject;
  55201. private _notifySelectedMeshUnselected;
  55202. /**
  55203. * Permanently set new colors for the laser pointer
  55204. * @param color the new laser color
  55205. * @param pickedColor the new laser color when picked mesh detected
  55206. */
  55207. setLaserColor(color: Color3, pickedColor?: Color3): void;
  55208. /**
  55209. * Set lighting enabled / disabled on the laser pointer of both controllers
  55210. * @param enabled should the lighting be enabled on the laser pointer
  55211. */
  55212. setLaserLightingState(enabled?: boolean): void;
  55213. /**
  55214. * Permanently set new colors for the gaze pointer
  55215. * @param color the new gaze color
  55216. * @param pickedColor the new gaze color when picked mesh detected
  55217. */
  55218. setGazeColor(color: Color3, pickedColor?: Color3): void;
  55219. /**
  55220. * Sets the color of the laser ray from the vr controllers.
  55221. * @param color new color for the ray.
  55222. */
  55223. changeLaserColor(color: Color3): void;
  55224. /**
  55225. * Sets the color of the ray from the vr headsets gaze.
  55226. * @param color new color for the ray.
  55227. */
  55228. changeGazeColor(color: Color3): void;
  55229. /**
  55230. * Exits VR and disposes of the vr experience helper
  55231. */
  55232. dispose(): void;
  55233. /**
  55234. * Gets the name of the VRExperienceHelper class
  55235. * @returns "VRExperienceHelper"
  55236. */
  55237. getClassName(): string;
  55238. }
  55239. }
  55240. declare module "babylonjs/Cameras/VR/index" {
  55241. export * from "babylonjs/Cameras/VR/vrCameraMetrics";
  55242. export * from "babylonjs/Cameras/VR/vrDeviceOrientationArcRotateCamera";
  55243. export * from "babylonjs/Cameras/VR/vrDeviceOrientationFreeCamera";
  55244. export * from "babylonjs/Cameras/VR/vrDeviceOrientationGamepadCamera";
  55245. export * from "babylonjs/Cameras/VR/vrExperienceHelper";
  55246. export * from "babylonjs/Cameras/VR/webVRCamera";
  55247. }
  55248. declare module "babylonjs/Cameras/RigModes/index" {
  55249. export * from "babylonjs/Cameras/RigModes/stereoscopicAnaglyphRigMode";
  55250. export * from "babylonjs/Cameras/RigModes/stereoscopicRigMode";
  55251. export * from "babylonjs/Cameras/RigModes/vrRigMode";
  55252. export * from "babylonjs/Cameras/RigModes/webVRRigMode";
  55253. }
  55254. declare module "babylonjs/Cameras/index" {
  55255. export * from "babylonjs/Cameras/Inputs/index";
  55256. export * from "babylonjs/Cameras/cameraInputsManager";
  55257. export * from "babylonjs/Cameras/camera";
  55258. export * from "babylonjs/Cameras/targetCamera";
  55259. export * from "babylonjs/Cameras/freeCamera";
  55260. export * from "babylonjs/Cameras/freeCameraInputsManager";
  55261. export * from "babylonjs/Cameras/touchCamera";
  55262. export * from "babylonjs/Cameras/arcRotateCamera";
  55263. export * from "babylonjs/Cameras/arcRotateCameraInputsManager";
  55264. export * from "babylonjs/Cameras/deviceOrientationCamera";
  55265. export * from "babylonjs/Cameras/flyCamera";
  55266. export * from "babylonjs/Cameras/flyCameraInputsManager";
  55267. export * from "babylonjs/Cameras/followCamera";
  55268. export * from "babylonjs/Cameras/followCameraInputsManager";
  55269. export * from "babylonjs/Cameras/gamepadCamera";
  55270. export * from "babylonjs/Cameras/Stereoscopic/index";
  55271. export * from "babylonjs/Cameras/universalCamera";
  55272. export * from "babylonjs/Cameras/virtualJoysticksCamera";
  55273. export * from "babylonjs/Cameras/VR/index";
  55274. export * from "babylonjs/Cameras/RigModes/index";
  55275. }
  55276. declare module "babylonjs/Collisions/index" {
  55277. export * from "babylonjs/Collisions/collider";
  55278. export * from "babylonjs/Collisions/collisionCoordinator";
  55279. export * from "babylonjs/Collisions/pickingInfo";
  55280. export * from "babylonjs/Collisions/intersectionInfo";
  55281. export * from "babylonjs/Collisions/meshCollisionData";
  55282. }
  55283. declare module "babylonjs/Culling/Octrees/octreeBlock" {
  55284. import { SmartArrayNoDuplicate } from "babylonjs/Misc/smartArray";
  55285. import { Vector3 } from "babylonjs/Maths/math.vector";
  55286. import { Ray } from "babylonjs/Culling/ray";
  55287. import { Plane } from "babylonjs/Maths/math.plane";
  55288. /**
  55289. * Contains an array of blocks representing the octree
  55290. */
  55291. export interface IOctreeContainer<T> {
  55292. /**
  55293. * Blocks within the octree
  55294. */
  55295. blocks: Array<OctreeBlock<T>>;
  55296. }
  55297. /**
  55298. * Class used to store a cell in an octree
  55299. * @see https://doc.babylonjs.com/how_to/optimizing_your_scene_with_octrees
  55300. */
  55301. export class OctreeBlock<T> {
  55302. /**
  55303. * Gets the content of the current block
  55304. */
  55305. entries: T[];
  55306. /**
  55307. * Gets the list of block children
  55308. */
  55309. blocks: Array<OctreeBlock<T>>;
  55310. private _depth;
  55311. private _maxDepth;
  55312. private _capacity;
  55313. private _minPoint;
  55314. private _maxPoint;
  55315. private _boundingVectors;
  55316. private _creationFunc;
  55317. /**
  55318. * Creates a new block
  55319. * @param minPoint defines the minimum vector (in world space) of the block's bounding box
  55320. * @param maxPoint defines the maximum vector (in world space) of the block's bounding box
  55321. * @param capacity defines the maximum capacity of this block (if capacity is reached the block will be split into sub blocks)
  55322. * @param depth defines the current depth of this block in the octree
  55323. * @param maxDepth defines the maximal depth allowed (beyond this value, the capacity is ignored)
  55324. * @param creationFunc defines a callback to call when an element is added to the block
  55325. */
  55326. constructor(minPoint: Vector3, maxPoint: Vector3, capacity: number, depth: number, maxDepth: number, creationFunc: (entry: T, block: OctreeBlock<T>) => void);
  55327. /**
  55328. * Gets the maximum capacity of this block (if capacity is reached the block will be split into sub blocks)
  55329. */
  55330. get capacity(): number;
  55331. /**
  55332. * Gets the minimum vector (in world space) of the block's bounding box
  55333. */
  55334. get minPoint(): Vector3;
  55335. /**
  55336. * Gets the maximum vector (in world space) of the block's bounding box
  55337. */
  55338. get maxPoint(): Vector3;
  55339. /**
  55340. * Add a new element to this block
  55341. * @param entry defines the element to add
  55342. */
  55343. addEntry(entry: T): void;
  55344. /**
  55345. * Remove an element from this block
  55346. * @param entry defines the element to remove
  55347. */
  55348. removeEntry(entry: T): void;
  55349. /**
  55350. * Add an array of elements to this block
  55351. * @param entries defines the array of elements to add
  55352. */
  55353. addEntries(entries: T[]): void;
  55354. /**
  55355. * Test if the current block intersects the furstum planes and if yes, then add its content to the selection array
  55356. * @param frustumPlanes defines the frustum planes to test
  55357. * @param selection defines the array to store current content if selection is positive
  55358. * @param allowDuplicate defines if the selection array can contains duplicated entries
  55359. */
  55360. select(frustumPlanes: Plane[], selection: SmartArrayNoDuplicate<T>, allowDuplicate?: boolean): void;
  55361. /**
  55362. * Test if the current block intersect with the given bounding sphere and if yes, then add its content to the selection array
  55363. * @param sphereCenter defines the bounding sphere center
  55364. * @param sphereRadius defines the bounding sphere radius
  55365. * @param selection defines the array to store current content if selection is positive
  55366. * @param allowDuplicate defines if the selection array can contains duplicated entries
  55367. */
  55368. intersects(sphereCenter: Vector3, sphereRadius: number, selection: SmartArrayNoDuplicate<T>, allowDuplicate?: boolean): void;
  55369. /**
  55370. * Test if the current block intersect with the given ray and if yes, then add its content to the selection array
  55371. * @param ray defines the ray to test with
  55372. * @param selection defines the array to store current content if selection is positive
  55373. */
  55374. intersectsRay(ray: Ray, selection: SmartArrayNoDuplicate<T>): void;
  55375. /**
  55376. * Subdivide the content into child blocks (this block will then be empty)
  55377. */
  55378. createInnerBlocks(): void;
  55379. /**
  55380. * @hidden
  55381. */
  55382. 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;
  55383. }
  55384. }
  55385. declare module "babylonjs/Culling/Octrees/octree" {
  55386. import { SmartArray } from "babylonjs/Misc/smartArray";
  55387. import { Vector3 } from "babylonjs/Maths/math.vector";
  55388. import { SubMesh } from "babylonjs/Meshes/subMesh";
  55389. import { AbstractMesh } from "babylonjs/Meshes/abstractMesh";
  55390. import { Ray } from "babylonjs/Culling/ray";
  55391. import { OctreeBlock } from "babylonjs/Culling/Octrees/octreeBlock";
  55392. import { Plane } from "babylonjs/Maths/math.plane";
  55393. /**
  55394. * Octrees are a really powerful data structure that can quickly select entities based on space coordinates.
  55395. * @see https://doc.babylonjs.com/how_to/optimizing_your_scene_with_octrees
  55396. */
  55397. export class Octree<T> {
  55398. /** 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.) */
  55399. maxDepth: number;
  55400. /**
  55401. * Blocks within the octree containing objects
  55402. */
  55403. blocks: Array<OctreeBlock<T>>;
  55404. /**
  55405. * Content stored in the octree
  55406. */
  55407. dynamicContent: T[];
  55408. private _maxBlockCapacity;
  55409. private _selectionContent;
  55410. private _creationFunc;
  55411. /**
  55412. * Creates a octree
  55413. * @see https://doc.babylonjs.com/how_to/optimizing_your_scene_with_octrees
  55414. * @param creationFunc function to be used to instatiate the octree
  55415. * @param maxBlockCapacity defines the maximum number of meshes you want on your octree's leaves (default: 64)
  55416. * @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.)
  55417. */
  55418. constructor(creationFunc: (entry: T, block: OctreeBlock<T>) => void, maxBlockCapacity?: number,
  55419. /** 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.) */
  55420. maxDepth?: number);
  55421. /**
  55422. * Updates the octree by adding blocks for the passed in meshes within the min and max world parameters
  55423. * @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);
  55424. * @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);
  55425. * @param entries meshes to be added to the octree blocks
  55426. */
  55427. update(worldMin: Vector3, worldMax: Vector3, entries: T[]): void;
  55428. /**
  55429. * Adds a mesh to the octree
  55430. * @param entry Mesh to add to the octree
  55431. */
  55432. addMesh(entry: T): void;
  55433. /**
  55434. * Remove an element from the octree
  55435. * @param entry defines the element to remove
  55436. */
  55437. removeMesh(entry: T): void;
  55438. /**
  55439. * Selects an array of meshes within the frustum
  55440. * @param frustumPlanes The frustum planes to use which will select all meshes within it
  55441. * @param allowDuplicate If duplicate objects are allowed in the resulting object array
  55442. * @returns array of meshes within the frustum
  55443. */
  55444. select(frustumPlanes: Plane[], allowDuplicate?: boolean): SmartArray<T>;
  55445. /**
  55446. * Test if the octree intersect with the given bounding sphere and if yes, then add its content to the selection array
  55447. * @param sphereCenter defines the bounding sphere center
  55448. * @param sphereRadius defines the bounding sphere radius
  55449. * @param allowDuplicate defines if the selection array can contains duplicated entries
  55450. * @returns an array of objects that intersect the sphere
  55451. */
  55452. intersects(sphereCenter: Vector3, sphereRadius: number, allowDuplicate?: boolean): SmartArray<T>;
  55453. /**
  55454. * Test if the octree intersect with the given ray and if yes, then add its content to resulting array
  55455. * @param ray defines the ray to test with
  55456. * @returns array of intersected objects
  55457. */
  55458. intersectsRay(ray: Ray): SmartArray<T>;
  55459. /**
  55460. * Adds a mesh into the octree block if it intersects the block
  55461. */
  55462. static CreationFuncForMeshes: (entry: AbstractMesh, block: OctreeBlock<AbstractMesh>) => void;
  55463. /**
  55464. * Adds a submesh into the octree block if it intersects the block
  55465. */
  55466. static CreationFuncForSubMeshes: (entry: SubMesh, block: OctreeBlock<SubMesh>) => void;
  55467. }
  55468. }
  55469. declare module "babylonjs/Culling/Octrees/octreeSceneComponent" {
  55470. import { ISmartArrayLike } from "babylonjs/Misc/smartArray";
  55471. import { Scene } from "babylonjs/scene";
  55472. import { SubMesh } from "babylonjs/Meshes/subMesh";
  55473. import { AbstractMesh } from "babylonjs/Meshes/abstractMesh";
  55474. import { Ray } from "babylonjs/Culling/ray";
  55475. import { Octree } from "babylonjs/Culling/Octrees/octree";
  55476. import { Collider } from "babylonjs/Collisions/collider";
  55477. module "babylonjs/scene" {
  55478. interface Scene {
  55479. /**
  55480. * @hidden
  55481. * Backing Filed
  55482. */
  55483. _selectionOctree: Octree<AbstractMesh>;
  55484. /**
  55485. * Gets the octree used to boost mesh selection (picking)
  55486. * @see https://doc.babylonjs.com/how_to/optimizing_your_scene_with_octrees
  55487. */
  55488. selectionOctree: Octree<AbstractMesh>;
  55489. /**
  55490. * Creates or updates the octree used to boost selection (picking)
  55491. * @see https://doc.babylonjs.com/how_to/optimizing_your_scene_with_octrees
  55492. * @param maxCapacity defines the maximum capacity per leaf
  55493. * @param maxDepth defines the maximum depth of the octree
  55494. * @returns an octree of AbstractMesh
  55495. */
  55496. createOrUpdateSelectionOctree(maxCapacity?: number, maxDepth?: number): Octree<AbstractMesh>;
  55497. }
  55498. }
  55499. module "babylonjs/Meshes/abstractMesh" {
  55500. interface AbstractMesh {
  55501. /**
  55502. * @hidden
  55503. * Backing Field
  55504. */
  55505. _submeshesOctree: Octree<SubMesh>;
  55506. /**
  55507. * This function will create an octree to help to select the right submeshes for rendering, picking and collision computations.
  55508. * Please note that you must have a decent number of submeshes to get performance improvements when using an octree
  55509. * @param maxCapacity defines the maximum size of each block (64 by default)
  55510. * @param maxDepth defines the maximum depth to use (no more than 2 levels by default)
  55511. * @returns the new octree
  55512. * @see https://www.babylonjs-playground.com/#NA4OQ#12
  55513. * @see https://doc.babylonjs.com/how_to/optimizing_your_scene_with_octrees
  55514. */
  55515. createOrUpdateSubmeshesOctree(maxCapacity?: number, maxDepth?: number): Octree<SubMesh>;
  55516. }
  55517. }
  55518. /**
  55519. * Defines the octree scene component responsible to manage any octrees
  55520. * in a given scene.
  55521. */
  55522. export class OctreeSceneComponent {
  55523. /**
  55524. * The component name help to identify the component in the list of scene components.
  55525. */
  55526. readonly name: string;
  55527. /**
  55528. * The scene the component belongs to.
  55529. */
  55530. scene: Scene;
  55531. /**
  55532. * Indicates if the meshes have been checked to make sure they are isEnabled()
  55533. */
  55534. readonly checksIsEnabled: boolean;
  55535. /**
  55536. * Creates a new instance of the component for the given scene
  55537. * @param scene Defines the scene to register the component in
  55538. */
  55539. constructor(scene: Scene);
  55540. /**
  55541. * Registers the component in a given scene
  55542. */
  55543. register(): void;
  55544. /**
  55545. * Return the list of active meshes
  55546. * @returns the list of active meshes
  55547. */
  55548. getActiveMeshCandidates(): ISmartArrayLike<AbstractMesh>;
  55549. /**
  55550. * Return the list of active sub meshes
  55551. * @param mesh The mesh to get the candidates sub meshes from
  55552. * @returns the list of active sub meshes
  55553. */
  55554. getActiveSubMeshCandidates(mesh: AbstractMesh): ISmartArrayLike<SubMesh>;
  55555. private _tempRay;
  55556. /**
  55557. * Return the list of sub meshes intersecting with a given local ray
  55558. * @param mesh defines the mesh to find the submesh for
  55559. * @param localRay defines the ray in local space
  55560. * @returns the list of intersecting sub meshes
  55561. */
  55562. getIntersectingSubMeshCandidates(mesh: AbstractMesh, localRay: Ray): ISmartArrayLike<SubMesh>;
  55563. /**
  55564. * Return the list of sub meshes colliding with a collider
  55565. * @param mesh defines the mesh to find the submesh for
  55566. * @param collider defines the collider to evaluate the collision against
  55567. * @returns the list of colliding sub meshes
  55568. */
  55569. getCollidingSubMeshCandidates(mesh: AbstractMesh, collider: Collider): ISmartArrayLike<SubMesh>;
  55570. /**
  55571. * Rebuilds the elements related to this component in case of
  55572. * context lost for instance.
  55573. */
  55574. rebuild(): void;
  55575. /**
  55576. * Disposes the component and the associated ressources.
  55577. */
  55578. dispose(): void;
  55579. }
  55580. }
  55581. declare module "babylonjs/Culling/Octrees/index" {
  55582. export * from "babylonjs/Culling/Octrees/octree";
  55583. export * from "babylonjs/Culling/Octrees/octreeBlock";
  55584. export * from "babylonjs/Culling/Octrees/octreeSceneComponent";
  55585. }
  55586. declare module "babylonjs/Culling/index" {
  55587. export * from "babylonjs/Culling/boundingBox";
  55588. export * from "babylonjs/Culling/boundingInfo";
  55589. export * from "babylonjs/Culling/boundingSphere";
  55590. export * from "babylonjs/Culling/Octrees/index";
  55591. export * from "babylonjs/Culling/ray";
  55592. }
  55593. declare module "babylonjs/Gizmos/gizmo" {
  55594. import { Nullable } from "babylonjs/types";
  55595. import { IDisposable } from "babylonjs/scene";
  55596. import { AbstractMesh } from "babylonjs/Meshes/abstractMesh";
  55597. import { Mesh } from "babylonjs/Meshes/mesh";
  55598. import { Node } from "babylonjs/node";
  55599. import { UtilityLayerRenderer } from "babylonjs/Rendering/utilityLayerRenderer";
  55600. /**
  55601. * Renders gizmos on top of an existing scene which provide controls for position, rotation, etc.
  55602. */
  55603. export class Gizmo implements IDisposable {
  55604. /** The utility layer the gizmo will be added to */
  55605. gizmoLayer: UtilityLayerRenderer;
  55606. /**
  55607. * The root mesh of the gizmo
  55608. */
  55609. _rootMesh: Mesh;
  55610. private _attachedMesh;
  55611. private _attachedNode;
  55612. /**
  55613. * Ratio for the scale of the gizmo (Default: 1)
  55614. */
  55615. protected _scaleRatio: number;
  55616. /**
  55617. * boolean updated by pointermove when a gizmo mesh is hovered
  55618. */
  55619. protected _isHovered: boolean;
  55620. /**
  55621. * Ratio for the scale of the gizmo (Default: 1)
  55622. */
  55623. set scaleRatio(value: number);
  55624. get scaleRatio(): number;
  55625. /**
  55626. * True when the mouse pointer is hovered a gizmo mesh
  55627. */
  55628. get isHovered(): boolean;
  55629. /**
  55630. * If a custom mesh has been set (Default: false)
  55631. */
  55632. protected _customMeshSet: boolean;
  55633. /**
  55634. * Mesh that the gizmo will be attached to. (eg. on a drag gizmo the mesh that will be dragged)
  55635. * * When set, interactions will be enabled
  55636. */
  55637. get attachedMesh(): Nullable<AbstractMesh>;
  55638. set attachedMesh(value: Nullable<AbstractMesh>);
  55639. /**
  55640. * Node that the gizmo will be attached to. (eg. on a drag gizmo the mesh, bone or NodeTransform that will be dragged)
  55641. * * When set, interactions will be enabled
  55642. */
  55643. get attachedNode(): Nullable<Node>;
  55644. set attachedNode(value: Nullable<Node>);
  55645. /**
  55646. * Disposes and replaces the current meshes in the gizmo with the specified mesh
  55647. * @param mesh The mesh to replace the default mesh of the gizmo
  55648. */
  55649. setCustomMesh(mesh: Mesh): void;
  55650. protected _updateGizmoRotationToMatchAttachedMesh: boolean;
  55651. /**
  55652. * If set the gizmo's rotation will be updated to match the attached mesh each frame (Default: true)
  55653. */
  55654. set updateGizmoRotationToMatchAttachedMesh(value: boolean);
  55655. get updateGizmoRotationToMatchAttachedMesh(): boolean;
  55656. /**
  55657. * If set the gizmo's position will be updated to match the attached mesh each frame (Default: true)
  55658. */
  55659. updateGizmoPositionToMatchAttachedMesh: boolean;
  55660. /**
  55661. * When set, the gizmo will always appear the same size no matter where the camera is (default: true)
  55662. */
  55663. updateScale: boolean;
  55664. protected _interactionsEnabled: boolean;
  55665. protected _attachedNodeChanged(value: Nullable<Node>): void;
  55666. private _beforeRenderObserver;
  55667. private _tempQuaternion;
  55668. private _tempVector;
  55669. private _tempVector2;
  55670. private _tempMatrix1;
  55671. private _tempMatrix2;
  55672. private _rightHandtoLeftHandMatrix;
  55673. /**
  55674. * Creates a gizmo
  55675. * @param gizmoLayer The utility layer the gizmo will be added to
  55676. */
  55677. constructor(
  55678. /** The utility layer the gizmo will be added to */
  55679. gizmoLayer?: UtilityLayerRenderer);
  55680. /**
  55681. * Updates the gizmo to match the attached mesh's position/rotation
  55682. */
  55683. protected _update(): void;
  55684. /**
  55685. * computes the rotation/scaling/position of the transform once the Node world matrix has changed.
  55686. * @param value Node, TransformNode or mesh
  55687. */
  55688. protected _matrixChanged(): void;
  55689. /**
  55690. * Disposes of the gizmo
  55691. */
  55692. dispose(): void;
  55693. }
  55694. }
  55695. declare module "babylonjs/Gizmos/planeDragGizmo" {
  55696. import { Observable } from "babylonjs/Misc/observable";
  55697. import { Nullable } from "babylonjs/types";
  55698. import { Vector3 } from "babylonjs/Maths/math.vector";
  55699. import { Color3 } from "babylonjs/Maths/math.color";
  55700. import { TransformNode } from "babylonjs/Meshes/transformNode";
  55701. import { Node } from "babylonjs/node";
  55702. import { PointerDragBehavior } from "babylonjs/Behaviors/Meshes/pointerDragBehavior";
  55703. import { Gizmo } from "babylonjs/Gizmos/gizmo";
  55704. import { UtilityLayerRenderer } from "babylonjs/Rendering/utilityLayerRenderer";
  55705. import { StandardMaterial } from "babylonjs/Materials/standardMaterial";
  55706. import { Scene } from "babylonjs/scene";
  55707. import { PositionGizmo } from "babylonjs/Gizmos/positionGizmo";
  55708. /**
  55709. * Single plane drag gizmo
  55710. */
  55711. export class PlaneDragGizmo extends Gizmo {
  55712. /**
  55713. * Drag behavior responsible for the gizmos dragging interactions
  55714. */
  55715. dragBehavior: PointerDragBehavior;
  55716. private _pointerObserver;
  55717. /**
  55718. * Drag distance in babylon units that the gizmo will snap to when dragged (Default: 0)
  55719. */
  55720. snapDistance: number;
  55721. /**
  55722. * Event that fires each time the gizmo snaps to a new location.
  55723. * * snapDistance is the the change in distance
  55724. */
  55725. onSnapObservable: Observable<{
  55726. snapDistance: number;
  55727. }>;
  55728. private _plane;
  55729. private _coloredMaterial;
  55730. private _hoverMaterial;
  55731. private _isEnabled;
  55732. private _parent;
  55733. /** @hidden */
  55734. static _CreatePlane(scene: Scene, material: StandardMaterial): TransformNode;
  55735. /** @hidden */
  55736. static _CreateArrowInstance(scene: Scene, arrow: TransformNode): TransformNode;
  55737. /**
  55738. * Creates a PlaneDragGizmo
  55739. * @param gizmoLayer The utility layer the gizmo will be added to
  55740. * @param dragPlaneNormal The axis normal to which the gizmo will be able to drag on
  55741. * @param color The color of the gizmo
  55742. */
  55743. constructor(dragPlaneNormal: Vector3, color?: Color3, gizmoLayer?: UtilityLayerRenderer, parent?: Nullable<PositionGizmo>);
  55744. protected _attachedNodeChanged(value: Nullable<Node>): void;
  55745. /**
  55746. * If the gizmo is enabled
  55747. */
  55748. set isEnabled(value: boolean);
  55749. get isEnabled(): boolean;
  55750. /**
  55751. * Disposes of the gizmo
  55752. */
  55753. dispose(): void;
  55754. }
  55755. }
  55756. declare module "babylonjs/Gizmos/positionGizmo" {
  55757. import { Observable } from "babylonjs/Misc/observable";
  55758. import { Nullable } from "babylonjs/types";
  55759. import { AbstractMesh } from "babylonjs/Meshes/abstractMesh";
  55760. import { Node } from "babylonjs/node";
  55761. import { Mesh } from "babylonjs/Meshes/mesh";
  55762. import { Gizmo } from "babylonjs/Gizmos/gizmo";
  55763. import { AxisDragGizmo } from "babylonjs/Gizmos/axisDragGizmo";
  55764. import { PlaneDragGizmo } from "babylonjs/Gizmos/planeDragGizmo";
  55765. import { UtilityLayerRenderer } from "babylonjs/Rendering/utilityLayerRenderer";
  55766. /**
  55767. * Gizmo that enables dragging a mesh along 3 axis
  55768. */
  55769. export class PositionGizmo extends Gizmo {
  55770. /**
  55771. * Internal gizmo used for interactions on the x axis
  55772. */
  55773. xGizmo: AxisDragGizmo;
  55774. /**
  55775. * Internal gizmo used for interactions on the y axis
  55776. */
  55777. yGizmo: AxisDragGizmo;
  55778. /**
  55779. * Internal gizmo used for interactions on the z axis
  55780. */
  55781. zGizmo: AxisDragGizmo;
  55782. /**
  55783. * Internal gizmo used for interactions on the yz plane
  55784. */
  55785. xPlaneGizmo: PlaneDragGizmo;
  55786. /**
  55787. * Internal gizmo used for interactions on the xz plane
  55788. */
  55789. yPlaneGizmo: PlaneDragGizmo;
  55790. /**
  55791. * Internal gizmo used for interactions on the xy plane
  55792. */
  55793. zPlaneGizmo: PlaneDragGizmo;
  55794. /**
  55795. * private variables
  55796. */
  55797. private _meshAttached;
  55798. private _nodeAttached;
  55799. private _snapDistance;
  55800. /** Fires an event when any of it's sub gizmos are dragged */
  55801. onDragStartObservable: Observable<unknown>;
  55802. /** Fires an event when any of it's sub gizmos are released from dragging */
  55803. onDragEndObservable: Observable<unknown>;
  55804. /**
  55805. * If set to true, planar drag is enabled
  55806. */
  55807. private _planarGizmoEnabled;
  55808. get attachedMesh(): Nullable<AbstractMesh>;
  55809. set attachedMesh(mesh: Nullable<AbstractMesh>);
  55810. get attachedNode(): Nullable<Node>;
  55811. set attachedNode(node: Nullable<Node>);
  55812. /**
  55813. * True when the mouse pointer is hovering a gizmo mesh
  55814. */
  55815. get isHovered(): boolean;
  55816. /**
  55817. * Creates a PositionGizmo
  55818. * @param gizmoLayer The utility layer the gizmo will be added to
  55819. @param thickness display gizmo axis thickness
  55820. */
  55821. constructor(gizmoLayer?: UtilityLayerRenderer, thickness?: number);
  55822. /**
  55823. * If the planar drag gizmo is enabled
  55824. * setting this will enable/disable XY, XZ and YZ planes regardless of individual gizmo settings.
  55825. */
  55826. set planarGizmoEnabled(value: boolean);
  55827. get planarGizmoEnabled(): boolean;
  55828. set updateGizmoRotationToMatchAttachedMesh(value: boolean);
  55829. get updateGizmoRotationToMatchAttachedMesh(): boolean;
  55830. /**
  55831. * Drag distance in babylon units that the gizmo will snap to when dragged (Default: 0)
  55832. */
  55833. set snapDistance(value: number);
  55834. get snapDistance(): number;
  55835. /**
  55836. * Ratio for the scale of the gizmo (Default: 1)
  55837. */
  55838. set scaleRatio(value: number);
  55839. get scaleRatio(): number;
  55840. /**
  55841. * Disposes of the gizmo
  55842. */
  55843. dispose(): void;
  55844. /**
  55845. * CustomMeshes are not supported by this gizmo
  55846. * @param mesh The mesh to replace the default mesh of the gizmo
  55847. */
  55848. setCustomMesh(mesh: Mesh): void;
  55849. }
  55850. }
  55851. declare module "babylonjs/Gizmos/axisDragGizmo" {
  55852. import { Observable } from "babylonjs/Misc/observable";
  55853. import { Nullable } from "babylonjs/types";
  55854. import { Vector3 } from "babylonjs/Maths/math.vector";
  55855. import { TransformNode } from "babylonjs/Meshes/transformNode";
  55856. import { Node } from "babylonjs/node";
  55857. import { PointerDragBehavior } from "babylonjs/Behaviors/Meshes/pointerDragBehavior";
  55858. import { Gizmo } from "babylonjs/Gizmos/gizmo";
  55859. import { UtilityLayerRenderer } from "babylonjs/Rendering/utilityLayerRenderer";
  55860. import { StandardMaterial } from "babylonjs/Materials/standardMaterial";
  55861. import { Scene } from "babylonjs/scene";
  55862. import { PositionGizmo } from "babylonjs/Gizmos/positionGizmo";
  55863. import { Color3 } from "babylonjs/Maths/math.color";
  55864. /**
  55865. * Single axis drag gizmo
  55866. */
  55867. export class AxisDragGizmo extends Gizmo {
  55868. /**
  55869. * Drag behavior responsible for the gizmos dragging interactions
  55870. */
  55871. dragBehavior: PointerDragBehavior;
  55872. private _pointerObserver;
  55873. /**
  55874. * Drag distance in babylon units that the gizmo will snap to when dragged (Default: 0)
  55875. */
  55876. snapDistance: number;
  55877. /**
  55878. * Event that fires each time the gizmo snaps to a new location.
  55879. * * snapDistance is the the change in distance
  55880. */
  55881. onSnapObservable: Observable<{
  55882. snapDistance: number;
  55883. }>;
  55884. private _isEnabled;
  55885. private _parent;
  55886. private _arrow;
  55887. private _coloredMaterial;
  55888. private _hoverMaterial;
  55889. /** @hidden */
  55890. static _CreateArrow(scene: Scene, material: StandardMaterial, thickness?: number): TransformNode;
  55891. /** @hidden */
  55892. static _CreateArrowInstance(scene: Scene, arrow: TransformNode): TransformNode;
  55893. /**
  55894. * Creates an AxisDragGizmo
  55895. * @param gizmoLayer The utility layer the gizmo will be added to
  55896. * @param dragAxis The axis which the gizmo will be able to drag on
  55897. * @param color The color of the gizmo
  55898. * @param thickness display gizmo axis thickness
  55899. */
  55900. constructor(dragAxis: Vector3, color?: Color3, gizmoLayer?: UtilityLayerRenderer, parent?: Nullable<PositionGizmo>, thickness?: number);
  55901. protected _attachedNodeChanged(value: Nullable<Node>): void;
  55902. /**
  55903. * If the gizmo is enabled
  55904. */
  55905. set isEnabled(value: boolean);
  55906. get isEnabled(): boolean;
  55907. /**
  55908. * Disposes of the gizmo
  55909. */
  55910. dispose(): void;
  55911. }
  55912. }
  55913. declare module "babylonjs/Debug/axesViewer" {
  55914. import { Vector3 } from "babylonjs/Maths/math.vector";
  55915. import { Nullable } from "babylonjs/types";
  55916. import { Scene } from "babylonjs/scene";
  55917. import { TransformNode } from "babylonjs/Meshes/transformNode";
  55918. /**
  55919. * The Axes viewer will show 3 axes in a specific point in space
  55920. */
  55921. export class AxesViewer {
  55922. private _xAxis;
  55923. private _yAxis;
  55924. private _zAxis;
  55925. private _scaleLinesFactor;
  55926. private _instanced;
  55927. /**
  55928. * Gets the hosting scene
  55929. */
  55930. scene: Nullable<Scene>;
  55931. /**
  55932. * Gets or sets a number used to scale line length
  55933. */
  55934. scaleLines: number;
  55935. /** Gets the node hierarchy used to render x-axis */
  55936. get xAxis(): TransformNode;
  55937. /** Gets the node hierarchy used to render y-axis */
  55938. get yAxis(): TransformNode;
  55939. /** Gets the node hierarchy used to render z-axis */
  55940. get zAxis(): TransformNode;
  55941. /**
  55942. * Creates a new AxesViewer
  55943. * @param scene defines the hosting scene
  55944. * @param scaleLines defines a number used to scale line length (1 by default)
  55945. * @param renderingGroupId defines a number used to set the renderingGroupId of the meshes (2 by default)
  55946. * @param xAxis defines the node hierarchy used to render the x-axis
  55947. * @param yAxis defines the node hierarchy used to render the y-axis
  55948. * @param zAxis defines the node hierarchy used to render the z-axis
  55949. */
  55950. constructor(scene: Scene, scaleLines?: number, renderingGroupId?: Nullable<number>, xAxis?: TransformNode, yAxis?: TransformNode, zAxis?: TransformNode);
  55951. /**
  55952. * Force the viewer to update
  55953. * @param position defines the position of the viewer
  55954. * @param xaxis defines the x axis of the viewer
  55955. * @param yaxis defines the y axis of the viewer
  55956. * @param zaxis defines the z axis of the viewer
  55957. */
  55958. update(position: Vector3, xaxis: Vector3, yaxis: Vector3, zaxis: Vector3): void;
  55959. /**
  55960. * Creates an instance of this axes viewer.
  55961. * @returns a new axes viewer with instanced meshes
  55962. */
  55963. createInstance(): AxesViewer;
  55964. /** Releases resources */
  55965. dispose(): void;
  55966. private static _SetRenderingGroupId;
  55967. }
  55968. }
  55969. declare module "babylonjs/Debug/boneAxesViewer" {
  55970. import { Nullable } from "babylonjs/types";
  55971. import { AxesViewer } from "babylonjs/Debug/axesViewer";
  55972. import { Vector3 } from "babylonjs/Maths/math.vector";
  55973. import { Mesh } from "babylonjs/Meshes/mesh";
  55974. import { Bone } from "babylonjs/Bones/bone";
  55975. import { Scene } from "babylonjs/scene";
  55976. /**
  55977. * The BoneAxesViewer will attach 3 axes to a specific bone of a specific mesh
  55978. * @see demo here: https://www.babylonjs-playground.com/#0DE8F4#8
  55979. */
  55980. export class BoneAxesViewer extends AxesViewer {
  55981. /**
  55982. * Gets or sets the target mesh where to display the axes viewer
  55983. */
  55984. mesh: Nullable<Mesh>;
  55985. /**
  55986. * Gets or sets the target bone where to display the axes viewer
  55987. */
  55988. bone: Nullable<Bone>;
  55989. /** Gets current position */
  55990. pos: Vector3;
  55991. /** Gets direction of X axis */
  55992. xaxis: Vector3;
  55993. /** Gets direction of Y axis */
  55994. yaxis: Vector3;
  55995. /** Gets direction of Z axis */
  55996. zaxis: Vector3;
  55997. /**
  55998. * Creates a new BoneAxesViewer
  55999. * @param scene defines the hosting scene
  56000. * @param bone defines the target bone
  56001. * @param mesh defines the target mesh
  56002. * @param scaleLines defines a scaling factor for line length (1 by default)
  56003. */
  56004. constructor(scene: Scene, bone: Bone, mesh: Mesh, scaleLines?: number);
  56005. /**
  56006. * Force the viewer to update
  56007. */
  56008. update(): void;
  56009. /** Releases resources */
  56010. dispose(): void;
  56011. }
  56012. }
  56013. declare module "babylonjs/Debug/debugLayer" {
  56014. import { Scene } from "babylonjs/scene";
  56015. /**
  56016. * Interface used to define scene explorer extensibility option
  56017. */
  56018. export interface IExplorerExtensibilityOption {
  56019. /**
  56020. * Define the option label
  56021. */
  56022. label: string;
  56023. /**
  56024. * Defines the action to execute on click
  56025. */
  56026. action: (entity: any) => void;
  56027. }
  56028. /**
  56029. * Defines a group of actions associated with a predicate to use when extending the Inspector scene explorer
  56030. */
  56031. export interface IExplorerExtensibilityGroup {
  56032. /**
  56033. * Defines a predicate to test if a given type mut be extended
  56034. */
  56035. predicate: (entity: any) => boolean;
  56036. /**
  56037. * Gets the list of options added to a type
  56038. */
  56039. entries: IExplorerExtensibilityOption[];
  56040. }
  56041. /**
  56042. * Interface used to define the options to use to create the Inspector
  56043. */
  56044. export interface IInspectorOptions {
  56045. /**
  56046. * Display in overlay mode (default: false)
  56047. */
  56048. overlay?: boolean;
  56049. /**
  56050. * HTML element to use as root (the parent of the rendering canvas will be used as default value)
  56051. */
  56052. globalRoot?: HTMLElement;
  56053. /**
  56054. * Display the Scene explorer
  56055. */
  56056. showExplorer?: boolean;
  56057. /**
  56058. * Display the property inspector
  56059. */
  56060. showInspector?: boolean;
  56061. /**
  56062. * Display in embed mode (both panes on the right)
  56063. */
  56064. embedMode?: boolean;
  56065. /**
  56066. * let the Inspector handles resize of the canvas when panes are resized (default to true)
  56067. */
  56068. handleResize?: boolean;
  56069. /**
  56070. * Allow the panes to popup (default: true)
  56071. */
  56072. enablePopup?: boolean;
  56073. /**
  56074. * Allow the panes to be closed by users (default: true)
  56075. */
  56076. enableClose?: boolean;
  56077. /**
  56078. * Optional list of extensibility entries
  56079. */
  56080. explorerExtensibility?: IExplorerExtensibilityGroup[];
  56081. /**
  56082. * Optional URL to get the inspector script from (by default it uses the babylonjs CDN).
  56083. */
  56084. inspectorURL?: string;
  56085. /**
  56086. * Optional initial tab (default to DebugLayerTab.Properties)
  56087. */
  56088. initialTab?: DebugLayerTab;
  56089. }
  56090. module "babylonjs/scene" {
  56091. interface Scene {
  56092. /**
  56093. * @hidden
  56094. * Backing field
  56095. */
  56096. _debugLayer: DebugLayer;
  56097. /**
  56098. * Gets the debug layer (aka Inspector) associated with the scene
  56099. * @see https://doc.babylonjs.com/features/playground_debuglayer
  56100. */
  56101. debugLayer: DebugLayer;
  56102. }
  56103. }
  56104. /**
  56105. * Enum of inspector action tab
  56106. */
  56107. export enum DebugLayerTab {
  56108. /**
  56109. * Properties tag (default)
  56110. */
  56111. Properties = 0,
  56112. /**
  56113. * Debug tab
  56114. */
  56115. Debug = 1,
  56116. /**
  56117. * Statistics tab
  56118. */
  56119. Statistics = 2,
  56120. /**
  56121. * Tools tab
  56122. */
  56123. Tools = 3,
  56124. /**
  56125. * Settings tab
  56126. */
  56127. Settings = 4
  56128. }
  56129. /**
  56130. * The debug layer (aka Inspector) is the go to tool in order to better understand
  56131. * what is happening in your scene
  56132. * @see https://doc.babylonjs.com/features/playground_debuglayer
  56133. */
  56134. export class DebugLayer {
  56135. /**
  56136. * Define the url to get the inspector script from.
  56137. * By default it uses the babylonjs CDN.
  56138. * @ignoreNaming
  56139. */
  56140. static InspectorURL: string;
  56141. private _scene;
  56142. private BJSINSPECTOR;
  56143. private _onPropertyChangedObservable?;
  56144. /**
  56145. * Observable triggered when a property is changed through the inspector.
  56146. */
  56147. get onPropertyChangedObservable(): any;
  56148. /**
  56149. * Instantiates a new debug layer.
  56150. * The debug layer (aka Inspector) is the go to tool in order to better understand
  56151. * what is happening in your scene
  56152. * @see https://doc.babylonjs.com/features/playground_debuglayer
  56153. * @param scene Defines the scene to inspect
  56154. */
  56155. constructor(scene: Scene);
  56156. /** Creates the inspector window. */
  56157. private _createInspector;
  56158. /**
  56159. * Select a specific entity in the scene explorer and highlight a specific block in that entity property grid
  56160. * @param entity defines the entity to select
  56161. * @param lineContainerTitles defines the specific blocks to highlight (could be a string or an array of strings)
  56162. */
  56163. select(entity: any, lineContainerTitles?: string | string[]): void;
  56164. /** Get the inspector from bundle or global */
  56165. private _getGlobalInspector;
  56166. /**
  56167. * Get if the inspector is visible or not.
  56168. * @returns true if visible otherwise, false
  56169. */
  56170. isVisible(): boolean;
  56171. /**
  56172. * Hide the inspector and close its window.
  56173. */
  56174. hide(): void;
  56175. /**
  56176. * Update the scene in the inspector
  56177. */
  56178. setAsActiveScene(): void;
  56179. /**
  56180. * Launch the debugLayer.
  56181. * @param config Define the configuration of the inspector
  56182. * @return a promise fulfilled when the debug layer is visible
  56183. */
  56184. show(config?: IInspectorOptions): Promise<DebugLayer>;
  56185. }
  56186. }
  56187. declare module "babylonjs/Meshes/Builders/boxBuilder" {
  56188. import { Nullable } from "babylonjs/types";
  56189. import { Scene } from "babylonjs/scene";
  56190. import { Vector4 } from "babylonjs/Maths/math.vector";
  56191. import { Color4 } from "babylonjs/Maths/math.color";
  56192. import { Mesh } from "babylonjs/Meshes/mesh";
  56193. /**
  56194. * Class containing static functions to help procedurally build meshes
  56195. */
  56196. export class BoxBuilder {
  56197. /**
  56198. * Creates a box mesh
  56199. * * The parameter `size` sets the size (float) of each box side (default 1)
  56200. * * You can set some different box dimensions by using the parameters `width`, `height` and `depth` (all by default have the same value of `size`)
  56201. * * 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)
  56202. * * Please read this tutorial : https://doc.babylonjs.com/how_to/createbox_per_face_textures_and_colors
  56203. * * You can also set the mesh side orientation with the values : BABYLON.Mesh.FRONTSIDE (default), BABYLON.Mesh.BACKSIDE or BABYLON.Mesh.DOUBLESIDE
  56204. * * If you create a double-sided mesh, you can choose what parts of the texture image to crop and stick respectively on the front and the back sides with the parameters `frontUVs` and `backUVs` (Vector4). Detail here : https://doc.babylonjs.com/babylon101/discover_basic_elements#side-orientation
  56205. * * The mesh can be set to updatable with the boolean parameter `updatable` (default false) if its internal geometry is supposed to change once created
  56206. * @see https://doc.babylonjs.com/how_to/set_shapes#box
  56207. * @param name defines the name of the mesh
  56208. * @param options defines the options used to create the mesh
  56209. * @param scene defines the hosting scene
  56210. * @returns the box mesh
  56211. */
  56212. static CreateBox(name: string, options: {
  56213. size?: number;
  56214. width?: number;
  56215. height?: number;
  56216. depth?: number;
  56217. faceUV?: Vector4[];
  56218. faceColors?: Color4[];
  56219. sideOrientation?: number;
  56220. frontUVs?: Vector4;
  56221. backUVs?: Vector4;
  56222. wrap?: boolean;
  56223. topBaseAt?: number;
  56224. bottomBaseAt?: number;
  56225. updatable?: boolean;
  56226. }, scene?: Nullable<Scene>): Mesh;
  56227. }
  56228. }
  56229. declare module "babylonjs/Debug/physicsViewer" {
  56230. import { Nullable } from "babylonjs/types";
  56231. import { Scene } from "babylonjs/scene";
  56232. import { AbstractMesh } from "babylonjs/Meshes/abstractMesh";
  56233. import { Mesh } from "babylonjs/Meshes/mesh";
  56234. import { IPhysicsEnginePlugin } from "babylonjs/Physics/IPhysicsEngine";
  56235. import { PhysicsImpostor } from "babylonjs/Physics/physicsImpostor";
  56236. /**
  56237. * Used to show the physics impostor around the specific mesh
  56238. */
  56239. export class PhysicsViewer {
  56240. /** @hidden */
  56241. protected _impostors: Array<Nullable<PhysicsImpostor>>;
  56242. /** @hidden */
  56243. protected _meshes: Array<Nullable<AbstractMesh>>;
  56244. /** @hidden */
  56245. protected _scene: Nullable<Scene>;
  56246. /** @hidden */
  56247. protected _numMeshes: number;
  56248. /** @hidden */
  56249. protected _physicsEnginePlugin: Nullable<IPhysicsEnginePlugin>;
  56250. private _renderFunction;
  56251. private _utilityLayer;
  56252. private _debugBoxMesh;
  56253. private _debugSphereMesh;
  56254. private _debugCylinderMesh;
  56255. private _debugMaterial;
  56256. private _debugMeshMeshes;
  56257. /**
  56258. * Creates a new PhysicsViewer
  56259. * @param scene defines the hosting scene
  56260. */
  56261. constructor(scene: Scene);
  56262. /** @hidden */
  56263. protected _updateDebugMeshes(): void;
  56264. /**
  56265. * Renders a specified physic impostor
  56266. * @param impostor defines the impostor to render
  56267. * @param targetMesh defines the mesh represented by the impostor
  56268. * @returns the new debug mesh used to render the impostor
  56269. */
  56270. showImpostor(impostor: PhysicsImpostor, targetMesh?: Mesh): Nullable<AbstractMesh>;
  56271. /**
  56272. * Hides a specified physic impostor
  56273. * @param impostor defines the impostor to hide
  56274. */
  56275. hideImpostor(impostor: Nullable<PhysicsImpostor>): void;
  56276. private _getDebugMaterial;
  56277. private _getDebugBoxMesh;
  56278. private _getDebugSphereMesh;
  56279. private _getDebugCylinderMesh;
  56280. private _getDebugMeshMesh;
  56281. private _getDebugMesh;
  56282. /** Releases all resources */
  56283. dispose(): void;
  56284. }
  56285. }
  56286. declare module "babylonjs/Debug/rayHelper" {
  56287. import { Nullable } from "babylonjs/types";
  56288. import { Ray } from "babylonjs/Culling/ray";
  56289. import { Vector3 } from "babylonjs/Maths/math.vector";
  56290. import { Color3 } from "babylonjs/Maths/math.color";
  56291. import { Scene } from "babylonjs/scene";
  56292. import { AbstractMesh } from "babylonjs/Meshes/abstractMesh";
  56293. import "babylonjs/Meshes/Builders/linesBuilder";
  56294. /**
  56295. * As raycast might be hard to debug, the RayHelper can help rendering the different rays
  56296. * in order to better appreciate the issue one might have.
  56297. * @see https://doc.babylonjs.com/babylon101/raycasts#debugging
  56298. */
  56299. export class RayHelper {
  56300. /**
  56301. * Defines the ray we are currently tryin to visualize.
  56302. */
  56303. ray: Nullable<Ray>;
  56304. private _renderPoints;
  56305. private _renderLine;
  56306. private _renderFunction;
  56307. private _scene;
  56308. private _onAfterRenderObserver;
  56309. private _onAfterStepObserver;
  56310. private _attachedToMesh;
  56311. private _meshSpaceDirection;
  56312. private _meshSpaceOrigin;
  56313. /**
  56314. * Helper function to create a colored helper in a scene in one line.
  56315. * @param ray Defines the ray we are currently tryin to visualize
  56316. * @param scene Defines the scene the ray is used in
  56317. * @param color Defines the color we want to see the ray in
  56318. * @returns The newly created ray helper.
  56319. */
  56320. static CreateAndShow(ray: Ray, scene: Scene, color: Color3): RayHelper;
  56321. /**
  56322. * Instantiate a new ray helper.
  56323. * As raycast might be hard to debug, the RayHelper can help rendering the different rays
  56324. * in order to better appreciate the issue one might have.
  56325. * @see https://doc.babylonjs.com/babylon101/raycasts#debugging
  56326. * @param ray Defines the ray we are currently tryin to visualize
  56327. */
  56328. constructor(ray: Ray);
  56329. /**
  56330. * Shows the ray we are willing to debug.
  56331. * @param scene Defines the scene the ray needs to be rendered in
  56332. * @param color Defines the color the ray needs to be rendered in
  56333. */
  56334. show(scene: Scene, color?: Color3): void;
  56335. /**
  56336. * Hides the ray we are debugging.
  56337. */
  56338. hide(): void;
  56339. private _render;
  56340. /**
  56341. * Attach a ray helper to a mesh so that we can easily see its orientation for instance or information like its normals.
  56342. * @param mesh Defines the mesh we want the helper attached to
  56343. * @param meshSpaceDirection Defines the direction of the Ray in mesh space (local space of the mesh node)
  56344. * @param meshSpaceOrigin Defines the origin of the Ray in mesh space (local space of the mesh node)
  56345. * @param length Defines the length of the ray
  56346. */
  56347. attachToMesh(mesh: AbstractMesh, meshSpaceDirection?: Vector3, meshSpaceOrigin?: Vector3, length?: number): void;
  56348. /**
  56349. * Detach the ray helper from the mesh it has previously been attached to.
  56350. */
  56351. detachFromMesh(): void;
  56352. private _updateToMesh;
  56353. /**
  56354. * Dispose the helper and release its associated resources.
  56355. */
  56356. dispose(): void;
  56357. }
  56358. }
  56359. declare module "babylonjs/Debug/ISkeletonViewer" {
  56360. import { Skeleton } from "babylonjs/Bones/skeleton";
  56361. import { Color3 } from "babylonjs/Maths/math.color";
  56362. /**
  56363. * Defines the options associated with the creation of a SkeletonViewer.
  56364. */
  56365. export interface ISkeletonViewerOptions {
  56366. /** Should the system pause animations before building the Viewer? */
  56367. pauseAnimations: boolean;
  56368. /** Should the system return the skeleton to rest before building? */
  56369. returnToRest: boolean;
  56370. /** public Display Mode of the Viewer */
  56371. displayMode: number;
  56372. /** Flag to toggle if the Viewer should use the CPU for animations or not? */
  56373. displayOptions: ISkeletonViewerDisplayOptions;
  56374. /** Flag to toggle if the Viewer should use the CPU for animations or not? */
  56375. computeBonesUsingShaders: boolean;
  56376. /** Flag ignore non weighted bones */
  56377. useAllBones: boolean;
  56378. }
  56379. /**
  56380. * Defines how to display the various bone meshes for the viewer.
  56381. */
  56382. export interface ISkeletonViewerDisplayOptions {
  56383. /** How far down to start tapering the bone spurs */
  56384. midStep?: number;
  56385. /** How big is the midStep? */
  56386. midStepFactor?: number;
  56387. /** Base for the Sphere Size */
  56388. sphereBaseSize?: number;
  56389. /** The ratio of the sphere to the longest bone in units */
  56390. sphereScaleUnit?: number;
  56391. /** Ratio for the Sphere Size */
  56392. sphereFactor?: number;
  56393. /** Whether a spur should attach its far end to the child bone position */
  56394. spurFollowsChild?: boolean;
  56395. /** Whether to show local axes or not */
  56396. showLocalAxes?: boolean;
  56397. /** Length of each local axis */
  56398. localAxesSize?: number;
  56399. }
  56400. /**
  56401. * Defines the constructor options for the BoneWeight Shader.
  56402. */
  56403. export interface IBoneWeightShaderOptions {
  56404. /** Skeleton to Map */
  56405. skeleton: Skeleton;
  56406. /** Colors for Uninfluenced bones */
  56407. colorBase?: Color3;
  56408. /** Colors for 0.0-0.25 Weight bones */
  56409. colorZero?: Color3;
  56410. /** Color for 0.25-0.5 Weight Influence */
  56411. colorQuarter?: Color3;
  56412. /** Color for 0.5-0.75 Weight Influence */
  56413. colorHalf?: Color3;
  56414. /** Color for 0.75-1 Weight Influence */
  56415. colorFull?: Color3;
  56416. /** Color for Zero Weight Influence */
  56417. targetBoneIndex?: number;
  56418. }
  56419. /**
  56420. * Simple structure of the gradient steps for the Color Map.
  56421. */
  56422. export interface ISkeletonMapShaderColorMapKnot {
  56423. /** Color of the Knot */
  56424. color: Color3;
  56425. /** Location of the Knot */
  56426. location: number;
  56427. }
  56428. /**
  56429. * Defines the constructor options for the SkeletonMap Shader.
  56430. */
  56431. export interface ISkeletonMapShaderOptions {
  56432. /** Skeleton to Map */
  56433. skeleton: Skeleton;
  56434. /** Array of ColorMapKnots that make the gradient must be ordered with knot[i].location < knot[i+1].location*/
  56435. colorMap?: ISkeletonMapShaderColorMapKnot[];
  56436. }
  56437. }
  56438. declare module "babylonjs/Meshes/Builders/ribbonBuilder" {
  56439. import { Nullable } from "babylonjs/types";
  56440. import { Scene } from "babylonjs/scene";
  56441. import { Vector3, Vector2, Vector4 } from "babylonjs/Maths/math.vector";
  56442. import { Color4 } from "babylonjs/Maths/math.color";
  56443. import { Mesh } from "babylonjs/Meshes/mesh";
  56444. /**
  56445. * Class containing static functions to help procedurally build meshes
  56446. */
  56447. export class RibbonBuilder {
  56448. /**
  56449. * Creates a ribbon mesh. The ribbon is a parametric shape. It has no predefined shape. Its final shape will depend on the input parameters
  56450. * * The parameter `pathArray` is a required array of paths, what are each an array of successive Vector3. The pathArray parameter depicts the ribbon geometry
  56451. * * The parameter `closeArray` (boolean, default false) creates a seam between the first and the last paths of the path array
  56452. * * The parameter `closePath` (boolean, default false) creates a seam between the first and the last points of each path of the path array
  56453. * * 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
  56454. * * 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
  56455. * * 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
  56456. * * You can also set the mesh side orientation with the values : BABYLON.Mesh.FRONTSIDE (default), BABYLON.Mesh.BACKSIDE or BABYLON.Mesh.DOUBLESIDE
  56457. * * If you create a double-sided mesh, you can choose what parts of the texture image to crop and stick respectively on the front and the back sides with the parameters `frontUVs` and `backUVs` (Vector4). Detail here : https://doc.babylonjs.com/babylon101/discover_basic_elements#side-orientation
  56458. * * The optional parameter `invertUV` (boolean, default false) swaps in the geometry the U and V coordinates to apply a texture
  56459. * * 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
  56460. * * The parameters `colors` is an optional flat array of `Color4` to set/update each ribbon vertex with its own custom color values
  56461. * * 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
  56462. * * Moreover, you can use the parameter `color` with `instance` (to update the ribbon), only if you previously used it at creation time
  56463. * * The mesh can be set to updatable with the boolean parameter `updatable` (default false) if its internal geometry is supposed to change once created
  56464. * @param name defines the name of the mesh
  56465. * @param options defines the options used to create the mesh
  56466. * @param scene defines the hosting scene
  56467. * @returns the ribbon mesh
  56468. * @see https://doc.babylonjs.com/how_to/ribbon_tutorial
  56469. * @see https://doc.babylonjs.com/how_to/parametric_shapes
  56470. */
  56471. static CreateRibbon(name: string, options: {
  56472. pathArray: Vector3[][];
  56473. closeArray?: boolean;
  56474. closePath?: boolean;
  56475. offset?: number;
  56476. updatable?: boolean;
  56477. sideOrientation?: number;
  56478. frontUVs?: Vector4;
  56479. backUVs?: Vector4;
  56480. instance?: Mesh;
  56481. invertUV?: boolean;
  56482. uvs?: Vector2[];
  56483. colors?: Color4[];
  56484. }, scene?: Nullable<Scene>): Mesh;
  56485. }
  56486. }
  56487. declare module "babylonjs/Meshes/Builders/shapeBuilder" {
  56488. import { Nullable } from "babylonjs/types";
  56489. import { Scene } from "babylonjs/scene";
  56490. import { Vector3, Vector4 } from "babylonjs/Maths/math.vector";
  56491. import { Mesh } from "babylonjs/Meshes/mesh";
  56492. /**
  56493. * Class containing static functions to help procedurally build meshes
  56494. */
  56495. export class ShapeBuilder {
  56496. /**
  56497. * 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.
  56498. * * 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.
  56499. * * The parameter `path` is a required array of successive Vector3. This is the axis curve the shape is extruded along.
  56500. * * 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.
  56501. * * The parameter `scale` (float, default 1) is the value to scale the shape.
  56502. * * 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
  56503. * * 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
  56504. * * Remember you can only change the shape or path point positions, not their number when updating an extruded shape.
  56505. * * You can also set the mesh side orientation with the values : BABYLON.Mesh.FRONTSIDE (default), BABYLON.Mesh.BACKSIDE or BABYLON.Mesh.DOUBLESIDE
  56506. * * If you create a double-sided mesh, you can choose what parts of the texture image to crop and stick respectively on the front and the back sides with the parameters `frontUVs` and `backUVs` (Vector4). Detail here : https://doc.babylonjs.com/babylon101/discover_basic_elements#side-orientation
  56507. * * The optional parameter `invertUV` (boolean, default false) swaps in the geometry the U and V coordinates to apply a texture.
  56508. * * The mesh can be set to updatable with the boolean parameter `updatable` (default false) if its internal geometry is supposed to change once created.
  56509. * @param name defines the name of the mesh
  56510. * @param options defines the options used to create the mesh
  56511. * @param scene defines the hosting scene
  56512. * @returns the extruded shape mesh
  56513. * @see https://doc.babylonjs.com/how_to/parametric_shapes
  56514. * @see https://doc.babylonjs.com/how_to/parametric_shapes#extruded-shapes
  56515. */
  56516. static ExtrudeShape(name: string, options: {
  56517. shape: Vector3[];
  56518. path: Vector3[];
  56519. scale?: number;
  56520. rotation?: number;
  56521. cap?: number;
  56522. updatable?: boolean;
  56523. sideOrientation?: number;
  56524. frontUVs?: Vector4;
  56525. backUVs?: Vector4;
  56526. instance?: Mesh;
  56527. invertUV?: boolean;
  56528. }, scene?: Nullable<Scene>): Mesh;
  56529. /**
  56530. * Creates an custom extruded shape mesh.
  56531. * The custom extrusion is a parametric shape. It has no predefined shape. Its final shape will depend on the input parameters.
  56532. * * 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.
  56533. * * The parameter `path` is a required array of successive Vector3. This is the axis curve the shape is extruded along.
  56534. * * 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
  56535. * * It must returns a float value that will be the rotation in radians applied to the shape on each path point.
  56536. * * 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
  56537. * * It must returns a float value that will be the scale value applied to the shape on each path point
  56538. * * The parameter `ribbonClosePath` (boolean, default false) forces the extrusion underlying ribbon to close all the paths in its `pathArray`
  56539. * * The parameter `ribbonCloseArray` (boolean, default false) forces the extrusion underlying ribbon to close its `pathArray`
  56540. * * 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
  56541. * * 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
  56542. * * Remember you can only change the shape or path point positions, not their number when updating an extruded shape
  56543. * * You can also set the mesh side orientation with the values : BABYLON.Mesh.FRONTSIDE (default), BABYLON.Mesh.BACKSIDE or BABYLON.Mesh.DOUBLESIDE
  56544. * * If you create a double-sided mesh, you can choose what parts of the texture image to crop and stick respectively on the front and the back sides with the parameters `frontUVs` and `backUVs` (Vector4). Detail here : https://doc.babylonjs.com/babylon101/discover_basic_elements#side-orientation
  56545. * * The optional parameter `invertUV` (boolean, default false) swaps in the geometry the U and V coordinates to apply a texture
  56546. * * The mesh can be set to updatable with the boolean parameter `updatable` (default false) if its internal geometry is supposed to change once created
  56547. * @param name defines the name of the mesh
  56548. * @param options defines the options used to create the mesh
  56549. * @param scene defines the hosting scene
  56550. * @returns the custom extruded shape mesh
  56551. * @see https://doc.babylonjs.com/how_to/parametric_shapes#custom-extruded-shapes
  56552. * @see https://doc.babylonjs.com/how_to/parametric_shapes
  56553. * @see https://doc.babylonjs.com/how_to/parametric_shapes#extruded-shapes
  56554. */
  56555. static ExtrudeShapeCustom(name: string, options: {
  56556. shape: Vector3[];
  56557. path: Vector3[];
  56558. scaleFunction?: any;
  56559. rotationFunction?: any;
  56560. ribbonCloseArray?: boolean;
  56561. ribbonClosePath?: boolean;
  56562. cap?: number;
  56563. updatable?: boolean;
  56564. sideOrientation?: number;
  56565. frontUVs?: Vector4;
  56566. backUVs?: Vector4;
  56567. instance?: Mesh;
  56568. invertUV?: boolean;
  56569. }, scene?: Nullable<Scene>): Mesh;
  56570. private static _ExtrudeShapeGeneric;
  56571. }
  56572. }
  56573. declare module "babylonjs/Debug/skeletonViewer" {
  56574. import { Color3 } from "babylonjs/Maths/math.color";
  56575. import { Scene } from "babylonjs/scene";
  56576. import { Nullable } from "babylonjs/types";
  56577. import { Skeleton } from "babylonjs/Bones/skeleton";
  56578. import { AbstractMesh } from "babylonjs/Meshes/abstractMesh";
  56579. import { LinesMesh } from "babylonjs/Meshes/linesMesh";
  56580. import { UtilityLayerRenderer } from "babylonjs/Rendering/utilityLayerRenderer";
  56581. import { ShaderMaterial } from "babylonjs/Materials/shaderMaterial";
  56582. import { ISkeletonViewerOptions, IBoneWeightShaderOptions, ISkeletonMapShaderOptions } from "babylonjs/Debug/ISkeletonViewer";
  56583. /**
  56584. * Class used to render a debug view of a given skeleton
  56585. * @see http://www.babylonjs-playground.com/#1BZJVJ#8
  56586. */
  56587. export class SkeletonViewer {
  56588. /** defines the skeleton to render */
  56589. skeleton: Skeleton;
  56590. /** defines the mesh attached to the skeleton */
  56591. mesh: AbstractMesh;
  56592. /** defines a boolean indicating if bones matrices must be forced to update before rendering (true by default) */
  56593. autoUpdateBonesMatrices: boolean;
  56594. /** defines the rendering group id to use with the viewer */
  56595. renderingGroupId: number;
  56596. /** is the options for the viewer */
  56597. options: Partial<ISkeletonViewerOptions>;
  56598. /** public Display constants BABYLON.SkeletonViewer.DISPLAY_LINES */
  56599. static readonly DISPLAY_LINES: number;
  56600. /** public Display constants BABYLON.SkeletonViewer.DISPLAY_SPHERES */
  56601. static readonly DISPLAY_SPHERES: number;
  56602. /** public Display constants BABYLON.SkeletonViewer.DISPLAY_SPHERE_AND_SPURS */
  56603. static readonly DISPLAY_SPHERE_AND_SPURS: number;
  56604. /** public static method to create a BoneWeight Shader
  56605. * @param options The constructor options
  56606. * @param scene The scene that the shader is scoped to
  56607. * @returns The created ShaderMaterial
  56608. * @see http://www.babylonjs-playground.com/#1BZJVJ#395
  56609. */
  56610. static CreateBoneWeightShader(options: IBoneWeightShaderOptions, scene: Scene): ShaderMaterial;
  56611. /** public static method to create a BoneWeight Shader
  56612. * @param options The constructor options
  56613. * @param scene The scene that the shader is scoped to
  56614. * @returns The created ShaderMaterial
  56615. */
  56616. static CreateSkeletonMapShader(options: ISkeletonMapShaderOptions, scene: Scene): ShaderMaterial;
  56617. /** private static method to create a BoneWeight Shader
  56618. * @param size The size of the buffer to create (usually the bone count)
  56619. * @param colorMap The gradient data to generate
  56620. * @param scene The scene that the shader is scoped to
  56621. * @returns an Array of floats from the color gradient values
  56622. */
  56623. private static _CreateBoneMapColorBuffer;
  56624. /** If SkeletonViewer scene scope. */
  56625. private _scene;
  56626. /** Gets or sets the color used to render the skeleton */
  56627. color: Color3;
  56628. /** Array of the points of the skeleton fo the line view. */
  56629. private _debugLines;
  56630. /** The SkeletonViewers Mesh. */
  56631. private _debugMesh;
  56632. /** The local axes Meshes. */
  56633. private _localAxes;
  56634. /** If SkeletonViewer is enabled. */
  56635. private _isEnabled;
  56636. /** If SkeletonViewer is ready. */
  56637. private _ready;
  56638. /** SkeletonViewer render observable. */
  56639. private _obs;
  56640. /** The Utility Layer to render the gizmos in. */
  56641. private _utilityLayer;
  56642. private _boneIndices;
  56643. /** Gets the Scene. */
  56644. get scene(): Scene;
  56645. /** Gets the utilityLayer. */
  56646. get utilityLayer(): Nullable<UtilityLayerRenderer>;
  56647. /** Checks Ready Status. */
  56648. get isReady(): Boolean;
  56649. /** Sets Ready Status. */
  56650. set ready(value: boolean);
  56651. /** Gets the debugMesh */
  56652. get debugMesh(): Nullable<AbstractMesh> | Nullable<LinesMesh>;
  56653. /** Sets the debugMesh */
  56654. set debugMesh(value: Nullable<AbstractMesh> | Nullable<LinesMesh>);
  56655. /** Gets the displayMode */
  56656. get displayMode(): number;
  56657. /** Sets the displayMode */
  56658. set displayMode(value: number);
  56659. /**
  56660. * Creates a new SkeletonViewer
  56661. * @param skeleton defines the skeleton to render
  56662. * @param mesh defines the mesh attached to the skeleton
  56663. * @param scene defines the hosting scene
  56664. * @param autoUpdateBonesMatrices defines a boolean indicating if bones matrices must be forced to update before rendering (true by default)
  56665. * @param renderingGroupId defines the rendering group id to use with the viewer
  56666. * @param options All of the extra constructor options for the SkeletonViewer
  56667. */
  56668. constructor(
  56669. /** defines the skeleton to render */
  56670. skeleton: Skeleton,
  56671. /** defines the mesh attached to the skeleton */
  56672. mesh: AbstractMesh,
  56673. /** The Scene scope*/
  56674. scene: Scene,
  56675. /** defines a boolean indicating if bones matrices must be forced to update before rendering (true by default) */
  56676. autoUpdateBonesMatrices?: boolean,
  56677. /** defines the rendering group id to use with the viewer */
  56678. renderingGroupId?: number,
  56679. /** is the options for the viewer */
  56680. options?: Partial<ISkeletonViewerOptions>);
  56681. /** The Dynamic bindings for the update functions */
  56682. private _bindObs;
  56683. /** Update the viewer to sync with current skeleton state, only used to manually update. */
  56684. update(): void;
  56685. /** Gets or sets a boolean indicating if the viewer is enabled */
  56686. set isEnabled(value: boolean);
  56687. get isEnabled(): boolean;
  56688. private _getBonePosition;
  56689. private _getLinesForBonesWithLength;
  56690. private _getLinesForBonesNoLength;
  56691. /** function to revert the mesh and scene back to the initial state. */
  56692. private _revert;
  56693. /** function to get the absolute bind pose of a bone by accumulating transformations up the bone hierarchy. */
  56694. private _getAbsoluteBindPoseToRef;
  56695. /** function to build and bind sphere joint points and spur bone representations. */
  56696. private _buildSpheresAndSpurs;
  56697. private _buildLocalAxes;
  56698. /** Update the viewer to sync with current skeleton state, only used for the line display. */
  56699. private _displayLinesUpdate;
  56700. /** Changes the displayMode of the skeleton viewer
  56701. * @param mode The displayMode numerical value
  56702. */
  56703. changeDisplayMode(mode: number): void;
  56704. /** Sets a display option of the skeleton viewer
  56705. *
  56706. * | Option | Type | Default | Description |
  56707. * | ---------------- | ------- | ------- | ----------- |
  56708. * | midStep | float | 0.235 | A percentage between a bone and its child that determines the widest part of a spur. Only used when `displayMode` is set to `DISPLAY_SPHERE_AND_SPURS`. |
  56709. * | midStepFactor | float | 0.15 | Mid step width expressed as a factor of the length. A value of 0.5 makes the spur width half of the spur length. Only used when `displayMode` is set to `DISPLAY_SPHERE_AND_SPURS`. |
  56710. * | sphereBaseSize | float | 2 | Sphere base size. Only used when `displayMode` is set to `DISPLAY_SPHERE_AND_SPURS`. |
  56711. * | sphereScaleUnit | float | 0.865 | Sphere scale factor used to scale spheres in relation to the longest bone. Only used when `displayMode` is set to `DISPLAY_SPHERE_AND_SPURS`. |
  56712. * | spurFollowsChild | boolean | false | Whether a spur should attach its far end to the child bone. |
  56713. * | showLocalAxes | boolean | false | Displays local axes on all bones. |
  56714. * | localAxesSize | float | 0.075 | Determines the length of each local axis. |
  56715. *
  56716. * @param option String of the option name
  56717. * @param value The numerical option value
  56718. */
  56719. changeDisplayOptions(option: string, value: number): void;
  56720. /** Release associated resources */
  56721. dispose(): void;
  56722. }
  56723. }
  56724. declare module "babylonjs/Debug/index" {
  56725. export * from "babylonjs/Debug/axesViewer";
  56726. export * from "babylonjs/Debug/boneAxesViewer";
  56727. export * from "babylonjs/Debug/debugLayer";
  56728. export * from "babylonjs/Debug/physicsViewer";
  56729. export * from "babylonjs/Debug/rayHelper";
  56730. export * from "babylonjs/Debug/skeletonViewer";
  56731. export * from "babylonjs/Debug/ISkeletonViewer";
  56732. }
  56733. declare module "babylonjs/DeviceInput/InputDevices/deviceEnums" {
  56734. /**
  56735. * Enum for Device Types
  56736. */
  56737. export enum DeviceType {
  56738. /** Generic */
  56739. Generic = 0,
  56740. /** Keyboard */
  56741. Keyboard = 1,
  56742. /** Mouse */
  56743. Mouse = 2,
  56744. /** Touch Pointers */
  56745. Touch = 3,
  56746. /** PS4 Dual Shock */
  56747. DualShock = 4,
  56748. /** Xbox */
  56749. Xbox = 5,
  56750. /** Switch Controller */
  56751. Switch = 6
  56752. }
  56753. /**
  56754. * Enum for All Pointers (Touch/Mouse)
  56755. */
  56756. export enum PointerInput {
  56757. /** Horizontal Axis */
  56758. Horizontal = 0,
  56759. /** Vertical Axis */
  56760. Vertical = 1,
  56761. /** Left Click or Touch */
  56762. LeftClick = 2,
  56763. /** Middle Click */
  56764. MiddleClick = 3,
  56765. /** Right Click */
  56766. RightClick = 4,
  56767. /** Browser Back */
  56768. BrowserBack = 5,
  56769. /** Browser Forward */
  56770. BrowserForward = 6
  56771. }
  56772. /**
  56773. * Enum for Dual Shock Gamepad
  56774. */
  56775. export enum DualShockInput {
  56776. /** Cross */
  56777. Cross = 0,
  56778. /** Circle */
  56779. Circle = 1,
  56780. /** Square */
  56781. Square = 2,
  56782. /** Triangle */
  56783. Triangle = 3,
  56784. /** L1 */
  56785. L1 = 4,
  56786. /** R1 */
  56787. R1 = 5,
  56788. /** L2 */
  56789. L2 = 6,
  56790. /** R2 */
  56791. R2 = 7,
  56792. /** Share */
  56793. Share = 8,
  56794. /** Options */
  56795. Options = 9,
  56796. /** L3 */
  56797. L3 = 10,
  56798. /** R3 */
  56799. R3 = 11,
  56800. /** DPadUp */
  56801. DPadUp = 12,
  56802. /** DPadDown */
  56803. DPadDown = 13,
  56804. /** DPadLeft */
  56805. DPadLeft = 14,
  56806. /** DRight */
  56807. DPadRight = 15,
  56808. /** Home */
  56809. Home = 16,
  56810. /** TouchPad */
  56811. TouchPad = 17,
  56812. /** LStickXAxis */
  56813. LStickXAxis = 18,
  56814. /** LStickYAxis */
  56815. LStickYAxis = 19,
  56816. /** RStickXAxis */
  56817. RStickXAxis = 20,
  56818. /** RStickYAxis */
  56819. RStickYAxis = 21
  56820. }
  56821. /**
  56822. * Enum for Xbox Gamepad
  56823. */
  56824. export enum XboxInput {
  56825. /** A */
  56826. A = 0,
  56827. /** B */
  56828. B = 1,
  56829. /** X */
  56830. X = 2,
  56831. /** Y */
  56832. Y = 3,
  56833. /** LB */
  56834. LB = 4,
  56835. /** RB */
  56836. RB = 5,
  56837. /** LT */
  56838. LT = 6,
  56839. /** RT */
  56840. RT = 7,
  56841. /** Back */
  56842. Back = 8,
  56843. /** Start */
  56844. Start = 9,
  56845. /** LS */
  56846. LS = 10,
  56847. /** RS */
  56848. RS = 11,
  56849. /** DPadUp */
  56850. DPadUp = 12,
  56851. /** DPadDown */
  56852. DPadDown = 13,
  56853. /** DPadLeft */
  56854. DPadLeft = 14,
  56855. /** DRight */
  56856. DPadRight = 15,
  56857. /** Home */
  56858. Home = 16,
  56859. /** LStickXAxis */
  56860. LStickXAxis = 17,
  56861. /** LStickYAxis */
  56862. LStickYAxis = 18,
  56863. /** RStickXAxis */
  56864. RStickXAxis = 19,
  56865. /** RStickYAxis */
  56866. RStickYAxis = 20
  56867. }
  56868. /**
  56869. * Enum for Switch (Pro/JoyCon L+R) Gamepad
  56870. */
  56871. export enum SwitchInput {
  56872. /** B */
  56873. B = 0,
  56874. /** A */
  56875. A = 1,
  56876. /** Y */
  56877. Y = 2,
  56878. /** X */
  56879. X = 3,
  56880. /** L */
  56881. L = 4,
  56882. /** R */
  56883. R = 5,
  56884. /** ZL */
  56885. ZL = 6,
  56886. /** ZR */
  56887. ZR = 7,
  56888. /** Minus */
  56889. Minus = 8,
  56890. /** Plus */
  56891. Plus = 9,
  56892. /** LS */
  56893. LS = 10,
  56894. /** RS */
  56895. RS = 11,
  56896. /** DPadUp */
  56897. DPadUp = 12,
  56898. /** DPadDown */
  56899. DPadDown = 13,
  56900. /** DPadLeft */
  56901. DPadLeft = 14,
  56902. /** DRight */
  56903. DPadRight = 15,
  56904. /** Home */
  56905. Home = 16,
  56906. /** Capture */
  56907. Capture = 17,
  56908. /** LStickXAxis */
  56909. LStickXAxis = 18,
  56910. /** LStickYAxis */
  56911. LStickYAxis = 19,
  56912. /** RStickXAxis */
  56913. RStickXAxis = 20,
  56914. /** RStickYAxis */
  56915. RStickYAxis = 21
  56916. }
  56917. }
  56918. declare module "babylonjs/DeviceInput/deviceInputSystem" {
  56919. import { Engine } from "babylonjs/Engines/engine";
  56920. import { IDisposable } from "babylonjs/scene";
  56921. import { Nullable } from "babylonjs/types";
  56922. import { DeviceType } from "babylonjs/DeviceInput/InputDevices/deviceEnums";
  56923. /**
  56924. * This class will take all inputs from Keyboard, Pointer, and
  56925. * any Gamepads and provide a polling system that all devices
  56926. * will use. This class assumes that there will only be one
  56927. * pointer device and one keyboard.
  56928. */
  56929. export class DeviceInputSystem implements IDisposable {
  56930. /**
  56931. * Callback to be triggered when a device is connected
  56932. */
  56933. onDeviceConnected: (deviceType: DeviceType, deviceSlot: number) => void;
  56934. /**
  56935. * Callback to be triggered when a device is disconnected
  56936. */
  56937. onDeviceDisconnected: (deviceType: DeviceType, deviceSlot: number) => void;
  56938. /**
  56939. * Callback to be triggered when event driven input is updated
  56940. */
  56941. onInputChanged: (deviceType: DeviceType, deviceSlot: number, inputIndex: number, previousState: Nullable<number>, currentState: Nullable<number>) => void;
  56942. private _inputs;
  56943. private _gamepads;
  56944. private _keyboardActive;
  56945. private _pointerActive;
  56946. private _elementToAttachTo;
  56947. private _keyboardDownEvent;
  56948. private _keyboardUpEvent;
  56949. private _pointerMoveEvent;
  56950. private _pointerDownEvent;
  56951. private _pointerUpEvent;
  56952. private _gamepadConnectedEvent;
  56953. private _gamepadDisconnectedEvent;
  56954. private static _MAX_KEYCODES;
  56955. private static _MAX_POINTER_INPUTS;
  56956. private constructor();
  56957. /**
  56958. * Creates a new DeviceInputSystem instance
  56959. * @param engine Engine to pull input element from
  56960. * @returns The new instance
  56961. */
  56962. static Create(engine: Engine): DeviceInputSystem;
  56963. /**
  56964. * Checks for current device input value, given an id and input index
  56965. * @param deviceName Id of connected device
  56966. * @param inputIndex Index of device input
  56967. * @returns Current value of input
  56968. */
  56969. /**
  56970. * Checks for current device input value, given an id and input index. Throws exception if requested device not initialized.
  56971. * @param deviceType Enum specifiying device type
  56972. * @param deviceSlot "Slot" or index that device is referenced in
  56973. * @param inputIndex Id of input to be checked
  56974. * @returns Current value of input
  56975. */
  56976. pollInput(deviceType: DeviceType, deviceSlot: number, inputIndex: number): number;
  56977. /**
  56978. * Dispose of all the eventlisteners
  56979. */
  56980. dispose(): void;
  56981. /**
  56982. * Add device and inputs to device array
  56983. * @param deviceType Enum specifiying device type
  56984. * @param deviceSlot "Slot" or index that device is referenced in
  56985. * @param numberOfInputs Number of input entries to create for given device
  56986. */
  56987. private _registerDevice;
  56988. /**
  56989. * Given a specific device name, remove that device from the device map
  56990. * @param deviceType Enum specifiying device type
  56991. * @param deviceSlot "Slot" or index that device is referenced in
  56992. */
  56993. private _unregisterDevice;
  56994. /**
  56995. * Handle all actions that come from keyboard interaction
  56996. */
  56997. private _handleKeyActions;
  56998. /**
  56999. * Handle all actions that come from pointer interaction
  57000. */
  57001. private _handlePointerActions;
  57002. /**
  57003. * Handle all actions that come from gamepad interaction
  57004. */
  57005. private _handleGamepadActions;
  57006. /**
  57007. * Update all non-event based devices with each frame
  57008. * @param deviceType Enum specifiying device type
  57009. * @param deviceSlot "Slot" or index that device is referenced in
  57010. * @param inputIndex Id of input to be checked
  57011. */
  57012. private _updateDevice;
  57013. /**
  57014. * Gets DeviceType from the device name
  57015. * @param deviceName Name of Device from DeviceInputSystem
  57016. * @returns DeviceType enum value
  57017. */
  57018. private _getGamepadDeviceType;
  57019. }
  57020. }
  57021. declare module "babylonjs/DeviceInput/InputDevices/deviceTypes" {
  57022. import { DeviceType, PointerInput, DualShockInput, XboxInput, SwitchInput } from "babylonjs/DeviceInput/InputDevices/deviceEnums";
  57023. /**
  57024. * Type to handle enforcement of inputs
  57025. */
  57026. 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;
  57027. }
  57028. declare module "babylonjs/DeviceInput/InputDevices/deviceSourceManager" {
  57029. import { DeviceInputSystem } from "babylonjs/DeviceInput/deviceInputSystem";
  57030. import { Engine } from "babylonjs/Engines/engine";
  57031. import { IDisposable } from "babylonjs/scene";
  57032. import { DeviceType } from "babylonjs/DeviceInput/InputDevices/deviceEnums";
  57033. import { Nullable } from "babylonjs/types";
  57034. import { Observable } from "babylonjs/Misc/observable";
  57035. import { DeviceInput } from "babylonjs/DeviceInput/InputDevices/deviceTypes";
  57036. /**
  57037. * Class that handles all input for a specific device
  57038. */
  57039. export class DeviceSource<T extends DeviceType> {
  57040. /** Type of device */
  57041. readonly deviceType: DeviceType;
  57042. /** "Slot" or index that device is referenced in */
  57043. readonly deviceSlot: number;
  57044. /**
  57045. * Observable to handle device input changes per device
  57046. */
  57047. readonly onInputChangedObservable: Observable<{
  57048. inputIndex: DeviceInput<T>;
  57049. previousState: Nullable<number>;
  57050. currentState: Nullable<number>;
  57051. }>;
  57052. private readonly _deviceInputSystem;
  57053. /**
  57054. * Default Constructor
  57055. * @param deviceInputSystem Reference to DeviceInputSystem
  57056. * @param deviceType Type of device
  57057. * @param deviceSlot "Slot" or index that device is referenced in
  57058. */
  57059. constructor(deviceInputSystem: DeviceInputSystem,
  57060. /** Type of device */
  57061. deviceType: DeviceType,
  57062. /** "Slot" or index that device is referenced in */
  57063. deviceSlot?: number);
  57064. /**
  57065. * Get input for specific input
  57066. * @param inputIndex index of specific input on device
  57067. * @returns Input value from DeviceInputSystem
  57068. */
  57069. getInput(inputIndex: DeviceInput<T>): number;
  57070. }
  57071. /**
  57072. * Class to keep track of devices
  57073. */
  57074. export class DeviceSourceManager implements IDisposable {
  57075. /**
  57076. * Observable to be triggered when before a device is connected
  57077. */
  57078. readonly onBeforeDeviceConnectedObservable: Observable<{
  57079. deviceType: DeviceType;
  57080. deviceSlot: number;
  57081. }>;
  57082. /**
  57083. * Observable to be triggered when before a device is disconnected
  57084. */
  57085. readonly onBeforeDeviceDisconnectedObservable: Observable<{
  57086. deviceType: DeviceType;
  57087. deviceSlot: number;
  57088. }>;
  57089. /**
  57090. * Observable to be triggered when after a device is connected
  57091. */
  57092. readonly onAfterDeviceConnectedObservable: Observable<{
  57093. deviceType: DeviceType;
  57094. deviceSlot: number;
  57095. }>;
  57096. /**
  57097. * Observable to be triggered when after a device is disconnected
  57098. */
  57099. readonly onAfterDeviceDisconnectedObservable: Observable<{
  57100. deviceType: DeviceType;
  57101. deviceSlot: number;
  57102. }>;
  57103. private readonly _devices;
  57104. private readonly _firstDevice;
  57105. private readonly _deviceInputSystem;
  57106. /**
  57107. * Default Constructor
  57108. * @param engine engine to pull input element from
  57109. */
  57110. constructor(engine: Engine);
  57111. /**
  57112. * Gets a DeviceSource, given a type and slot
  57113. * @param deviceType Enum specifying device type
  57114. * @param deviceSlot "Slot" or index that device is referenced in
  57115. * @returns DeviceSource object
  57116. */
  57117. getDeviceSource<T extends DeviceType>(deviceType: T, deviceSlot?: number): Nullable<DeviceSource<T>>;
  57118. /**
  57119. * Gets an array of DeviceSource objects for a given device type
  57120. * @param deviceType Enum specifying device type
  57121. * @returns Array of DeviceSource objects
  57122. */
  57123. getDeviceSources<T extends DeviceType>(deviceType: T): ReadonlyArray<DeviceSource<T>>;
  57124. /**
  57125. * Dispose of DeviceInputSystem and other parts
  57126. */
  57127. dispose(): void;
  57128. /**
  57129. * Function to add device name to device list
  57130. * @param deviceType Enum specifying device type
  57131. * @param deviceSlot "Slot" or index that device is referenced in
  57132. */
  57133. private _addDevice;
  57134. /**
  57135. * Function to remove device name to device list
  57136. * @param deviceType Enum specifying device type
  57137. * @param deviceSlot "Slot" or index that device is referenced in
  57138. */
  57139. private _removeDevice;
  57140. /**
  57141. * Updates array storing first connected device of each type
  57142. * @param type Type of Device
  57143. */
  57144. private _updateFirstDevices;
  57145. }
  57146. }
  57147. declare module "babylonjs/DeviceInput/index" {
  57148. export * from "babylonjs/DeviceInput/deviceInputSystem";
  57149. export * from "babylonjs/DeviceInput/InputDevices/deviceEnums";
  57150. export * from "babylonjs/DeviceInput/InputDevices/deviceTypes";
  57151. import "babylonjs/DeviceInput/InputDevices/deviceSourceManager";
  57152. export * from "babylonjs/DeviceInput/InputDevices/deviceSourceManager";
  57153. }
  57154. declare module "babylonjs/Engines/nullEngine" {
  57155. import { Nullable, FloatArray, IndicesArray } from "babylonjs/types";
  57156. import { Engine } from "babylonjs/Engines/engine";
  57157. import { RenderTargetCreationOptions } from "babylonjs/Materials/Textures/renderTargetCreationOptions";
  57158. import { VertexBuffer } from "babylonjs/Meshes/buffer";
  57159. import { InternalTexture } from "babylonjs/Materials/Textures/internalTexture";
  57160. import { Effect } from "babylonjs/Materials/effect";
  57161. import { IPipelineContext } from "babylonjs/Engines/IPipelineContext";
  57162. import { DataBuffer } from "babylonjs/Meshes/dataBuffer";
  57163. import { IColor4Like, IViewportLike } from "babylonjs/Maths/math.like";
  57164. import { ISceneLike } from "babylonjs/Engines/thinEngine";
  57165. /**
  57166. * Options to create the null engine
  57167. */
  57168. export class NullEngineOptions {
  57169. /**
  57170. * Render width (Default: 512)
  57171. */
  57172. renderWidth: number;
  57173. /**
  57174. * Render height (Default: 256)
  57175. */
  57176. renderHeight: number;
  57177. /**
  57178. * Texture size (Default: 512)
  57179. */
  57180. textureSize: number;
  57181. /**
  57182. * If delta time between frames should be constant
  57183. * @see https://doc.babylonjs.com/babylon101/animations#deterministic-lockstep
  57184. */
  57185. deterministicLockstep: boolean;
  57186. /**
  57187. * Maximum about of steps between frames (Default: 4)
  57188. * @see https://doc.babylonjs.com/babylon101/animations#deterministic-lockstep
  57189. */
  57190. lockstepMaxSteps: number;
  57191. /**
  57192. * Make the matrix computations to be performed in 64 bits instead of 32 bits. False by default
  57193. */
  57194. useHighPrecisionMatrix?: boolean;
  57195. }
  57196. /**
  57197. * The null engine class provides support for headless version of babylon.js.
  57198. * This can be used in server side scenario or for testing purposes
  57199. */
  57200. export class NullEngine extends Engine {
  57201. private _options;
  57202. /**
  57203. * Gets a boolean indicating that the engine is running in deterministic lock step mode
  57204. * @see https://doc.babylonjs.com/babylon101/animations#deterministic-lockstep
  57205. * @returns true if engine is in deterministic lock step mode
  57206. */
  57207. isDeterministicLockStep(): boolean;
  57208. /**
  57209. * Gets the max steps when engine is running in deterministic lock step
  57210. * @see https://doc.babylonjs.com/babylon101/animations#deterministic-lockstep
  57211. * @returns the max steps
  57212. */
  57213. getLockstepMaxSteps(): number;
  57214. /**
  57215. * Gets the current hardware scaling level.
  57216. * By default the hardware scaling level is computed from the window device ratio.
  57217. * 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.
  57218. * @returns a number indicating the current hardware scaling level
  57219. */
  57220. getHardwareScalingLevel(): number;
  57221. constructor(options?: NullEngineOptions);
  57222. /**
  57223. * Creates a vertex buffer
  57224. * @param vertices the data for the vertex buffer
  57225. * @returns the new WebGL static buffer
  57226. */
  57227. createVertexBuffer(vertices: FloatArray): DataBuffer;
  57228. /**
  57229. * Creates a new index buffer
  57230. * @param indices defines the content of the index buffer
  57231. * @param updatable defines if the index buffer must be updatable
  57232. * @returns a new webGL buffer
  57233. */
  57234. createIndexBuffer(indices: IndicesArray): DataBuffer;
  57235. /**
  57236. * Clear the current render buffer or the current render target (if any is set up)
  57237. * @param color defines the color to use
  57238. * @param backBuffer defines if the back buffer must be cleared
  57239. * @param depth defines if the depth buffer must be cleared
  57240. * @param stencil defines if the stencil buffer must be cleared
  57241. */
  57242. clear(color: IColor4Like, backBuffer: boolean, depth: boolean, stencil?: boolean): void;
  57243. /**
  57244. * Gets the current render width
  57245. * @param useScreen defines if screen size must be used (or the current render target if any)
  57246. * @returns a number defining the current render width
  57247. */
  57248. getRenderWidth(useScreen?: boolean): number;
  57249. /**
  57250. * Gets the current render height
  57251. * @param useScreen defines if screen size must be used (or the current render target if any)
  57252. * @returns a number defining the current render height
  57253. */
  57254. getRenderHeight(useScreen?: boolean): number;
  57255. /**
  57256. * Set the WebGL's viewport
  57257. * @param viewport defines the viewport element to be used
  57258. * @param requiredWidth defines the width required for rendering. If not provided the rendering canvas' width is used
  57259. * @param requiredHeight defines the height required for rendering. If not provided the rendering canvas' height is used
  57260. */
  57261. setViewport(viewport: IViewportLike, requiredWidth?: number, requiredHeight?: number): void;
  57262. createShaderProgram(pipelineContext: IPipelineContext, vertexCode: string, fragmentCode: string, defines: string, context?: WebGLRenderingContext): WebGLProgram;
  57263. /**
  57264. * Gets the list of webGL uniform locations associated with a specific program based on a list of uniform names
  57265. * @param pipelineContext defines the pipeline context to use
  57266. * @param uniformsNames defines the list of uniform names
  57267. * @returns an array of webGL uniform locations
  57268. */
  57269. getUniforms(pipelineContext: IPipelineContext, uniformsNames: string[]): Nullable<WebGLUniformLocation>[];
  57270. /**
  57271. * Gets the lsit of active attributes for a given webGL program
  57272. * @param pipelineContext defines the pipeline context to use
  57273. * @param attributesNames defines the list of attribute names to get
  57274. * @returns an array of indices indicating the offset of each attribute
  57275. */
  57276. getAttributes(pipelineContext: IPipelineContext, attributesNames: string[]): number[];
  57277. /**
  57278. * Binds an effect to the webGL context
  57279. * @param effect defines the effect to bind
  57280. */
  57281. bindSamplers(effect: Effect): void;
  57282. /**
  57283. * Activates an effect, mkaing it the current one (ie. the one used for rendering)
  57284. * @param effect defines the effect to activate
  57285. */
  57286. enableEffect(effect: Effect): void;
  57287. /**
  57288. * Set various states to the webGL context
  57289. * @param culling defines backface culling state
  57290. * @param zOffset defines the value to apply to zOffset (0 by default)
  57291. * @param force defines if states must be applied even if cache is up to date
  57292. * @param reverseSide defines if culling must be reversed (CCW instead of CW and CW instead of CCW)
  57293. */
  57294. setState(culling: boolean, zOffset?: number, force?: boolean, reverseSide?: boolean): void;
  57295. /**
  57296. * Set the value of an uniform to an array of int32
  57297. * @param uniform defines the webGL uniform location where to store the value
  57298. * @param array defines the array of int32 to store
  57299. * @returns true if value was set
  57300. */
  57301. setIntArray(uniform: WebGLUniformLocation, array: Int32Array): boolean;
  57302. /**
  57303. * Set the value of an uniform to an array of int32 (stored as vec2)
  57304. * @param uniform defines the webGL uniform location where to store the value
  57305. * @param array defines the array of int32 to store
  57306. * @returns true if value was set
  57307. */
  57308. setIntArray2(uniform: WebGLUniformLocation, array: Int32Array): boolean;
  57309. /**
  57310. * Set the value of an uniform to an array of int32 (stored as vec3)
  57311. * @param uniform defines the webGL uniform location where to store the value
  57312. * @param array defines the array of int32 to store
  57313. * @returns true if value was set
  57314. */
  57315. setIntArray3(uniform: WebGLUniformLocation, array: Int32Array): boolean;
  57316. /**
  57317. * Set the value of an uniform to an array of int32 (stored as vec4)
  57318. * @param uniform defines the webGL uniform location where to store the value
  57319. * @param array defines the array of int32 to store
  57320. * @returns true if value was set
  57321. */
  57322. setIntArray4(uniform: WebGLUniformLocation, array: Int32Array): boolean;
  57323. /**
  57324. * Set the value of an uniform to an array of float32
  57325. * @param uniform defines the webGL uniform location where to store the value
  57326. * @param array defines the array of float32 to store
  57327. * @returns true if value was set
  57328. */
  57329. setFloatArray(uniform: WebGLUniformLocation, array: Float32Array): boolean;
  57330. /**
  57331. * Set the value of an uniform to an array of float32 (stored as vec2)
  57332. * @param uniform defines the webGL uniform location where to store the value
  57333. * @param array defines the array of float32 to store
  57334. * @returns true if value was set
  57335. */
  57336. setFloatArray2(uniform: WebGLUniformLocation, array: Float32Array): boolean;
  57337. /**
  57338. * Set the value of an uniform to an array of float32 (stored as vec3)
  57339. * @param uniform defines the webGL uniform location where to store the value
  57340. * @param array defines the array of float32 to store
  57341. * @returns true if value was set
  57342. */
  57343. setFloatArray3(uniform: WebGLUniformLocation, array: Float32Array): boolean;
  57344. /**
  57345. * Set the value of an uniform to an array of float32 (stored as vec4)
  57346. * @param uniform defines the webGL uniform location where to store the value
  57347. * @param array defines the array of float32 to store
  57348. * @returns true if value was set
  57349. */
  57350. setFloatArray4(uniform: WebGLUniformLocation, array: Float32Array): boolean;
  57351. /**
  57352. * Set the value of an uniform to an array of number
  57353. * @param uniform defines the webGL uniform location where to store the value
  57354. * @param array defines the array of number to store
  57355. * @returns true if value was set
  57356. */
  57357. setArray(uniform: WebGLUniformLocation, array: number[]): boolean;
  57358. /**
  57359. * Set the value of an uniform to an array of number (stored as vec2)
  57360. * @param uniform defines the webGL uniform location where to store the value
  57361. * @param array defines the array of number to store
  57362. * @returns true if value was set
  57363. */
  57364. setArray2(uniform: WebGLUniformLocation, array: number[]): boolean;
  57365. /**
  57366. * Set the value of an uniform to an array of number (stored as vec3)
  57367. * @param uniform defines the webGL uniform location where to store the value
  57368. * @param array defines the array of number to store
  57369. * @returns true if value was set
  57370. */
  57371. setArray3(uniform: WebGLUniformLocation, array: number[]): boolean;
  57372. /**
  57373. * Set the value of an uniform to an array of number (stored as vec4)
  57374. * @param uniform defines the webGL uniform location where to store the value
  57375. * @param array defines the array of number to store
  57376. * @returns true if value was set
  57377. */
  57378. setArray4(uniform: WebGLUniformLocation, array: number[]): boolean;
  57379. /**
  57380. * Set the value of an uniform to an array of float32 (stored as matrices)
  57381. * @param uniform defines the webGL uniform location where to store the value
  57382. * @param matrices defines the array of float32 to store
  57383. * @returns true if value was set
  57384. */
  57385. setMatrices(uniform: WebGLUniformLocation, matrices: Float32Array): boolean;
  57386. /**
  57387. * Set the value of an uniform to a matrix (3x3)
  57388. * @param uniform defines the webGL uniform location where to store the value
  57389. * @param matrix defines the Float32Array representing the 3x3 matrix to store
  57390. * @returns true if value was set
  57391. */
  57392. setMatrix3x3(uniform: WebGLUniformLocation, matrix: Float32Array): boolean;
  57393. /**
  57394. * Set the value of an uniform to a matrix (2x2)
  57395. * @param uniform defines the webGL uniform location where to store the value
  57396. * @param matrix defines the Float32Array representing the 2x2 matrix to store
  57397. * @returns true if value was set
  57398. */
  57399. setMatrix2x2(uniform: WebGLUniformLocation, matrix: Float32Array): boolean;
  57400. /**
  57401. * Set the value of an uniform to a number (float)
  57402. * @param uniform defines the webGL uniform location where to store the value
  57403. * @param value defines the float number to store
  57404. * @returns true if value was set
  57405. */
  57406. setFloat(uniform: WebGLUniformLocation, value: number): boolean;
  57407. /**
  57408. * Set the value of an uniform to a vec2
  57409. * @param uniform defines the webGL uniform location where to store the value
  57410. * @param x defines the 1st component of the value
  57411. * @param y defines the 2nd component of the value
  57412. * @returns true if value was set
  57413. */
  57414. setFloat2(uniform: WebGLUniformLocation, x: number, y: number): boolean;
  57415. /**
  57416. * Set the value of an uniform to a vec3
  57417. * @param uniform defines the webGL uniform location where to store the value
  57418. * @param x defines the 1st component of the value
  57419. * @param y defines the 2nd component of the value
  57420. * @param z defines the 3rd component of the value
  57421. * @returns true if value was set
  57422. */
  57423. setFloat3(uniform: WebGLUniformLocation, x: number, y: number, z: number): boolean;
  57424. /**
  57425. * Set the value of an uniform to a boolean
  57426. * @param uniform defines the webGL uniform location where to store the value
  57427. * @param bool defines the boolean to store
  57428. * @returns true if value was set
  57429. */
  57430. setBool(uniform: WebGLUniformLocation, bool: number): boolean;
  57431. /**
  57432. * Set the value of an uniform to a vec4
  57433. * @param uniform defines the webGL uniform location where to store the value
  57434. * @param x defines the 1st component of the value
  57435. * @param y defines the 2nd component of the value
  57436. * @param z defines the 3rd component of the value
  57437. * @param w defines the 4th component of the value
  57438. * @returns true if value was set
  57439. */
  57440. setFloat4(uniform: WebGLUniformLocation, x: number, y: number, z: number, w: number): boolean;
  57441. /**
  57442. * Sets the current alpha mode
  57443. * @param mode defines the mode to use (one of the Engine.ALPHA_XXX)
  57444. * @param noDepthWriteChange defines if depth writing state should remains unchanged (false by default)
  57445. * @see https://doc.babylonjs.com/resources/transparency_and_how_meshes_are_rendered
  57446. */
  57447. setAlphaMode(mode: number, noDepthWriteChange?: boolean): void;
  57448. /**
  57449. * Bind webGl buffers directly to the webGL context
  57450. * @param vertexBuffers defines the vertex buffer to bind
  57451. * @param indexBuffer defines the index buffer to bind
  57452. * @param vertexDeclaration defines the vertex declaration to use with the vertex buffer
  57453. * @param vertexStrideSize defines the vertex stride of the vertex buffer
  57454. * @param effect defines the effect associated with the vertex buffer
  57455. */
  57456. bindBuffers(vertexBuffers: {
  57457. [key: string]: VertexBuffer;
  57458. }, indexBuffer: DataBuffer, effect: Effect): void;
  57459. /**
  57460. * Force the entire cache to be cleared
  57461. * You should not have to use this function unless your engine needs to share the webGL context with another engine
  57462. * @param bruteForce defines a boolean to force clearing ALL caches (including stencil, detoh and alpha states)
  57463. */
  57464. wipeCaches(bruteForce?: boolean): void;
  57465. /**
  57466. * Send a draw order
  57467. * @param useTriangles defines if triangles must be used to draw (else wireframe will be used)
  57468. * @param indexStart defines the starting index
  57469. * @param indexCount defines the number of index to draw
  57470. * @param instancesCount defines the number of instances to draw (if instanciation is enabled)
  57471. */
  57472. draw(useTriangles: boolean, indexStart: number, indexCount: number, instancesCount?: number): void;
  57473. /**
  57474. * Draw a list of indexed primitives
  57475. * @param fillMode defines the primitive to use
  57476. * @param indexStart defines the starting index
  57477. * @param indexCount defines the number of index to draw
  57478. * @param instancesCount defines the number of instances to draw (if instanciation is enabled)
  57479. */
  57480. drawElementsType(fillMode: number, indexStart: number, indexCount: number, instancesCount?: number): void;
  57481. /**
  57482. * Draw a list of unindexed primitives
  57483. * @param fillMode defines the primitive to use
  57484. * @param verticesStart defines the index of first vertex to draw
  57485. * @param verticesCount defines the count of vertices to draw
  57486. * @param instancesCount defines the number of instances to draw (if instanciation is enabled)
  57487. */
  57488. drawArraysType(fillMode: number, verticesStart: number, verticesCount: number, instancesCount?: number): void;
  57489. /** @hidden */
  57490. _createTexture(): WebGLTexture;
  57491. /** @hidden */
  57492. _releaseTexture(texture: InternalTexture): void;
  57493. /**
  57494. * Usually called from Texture.ts.
  57495. * Passed information to create a WebGLTexture
  57496. * @param urlArg defines a value which contains one of the following:
  57497. * * A conventional http URL, e.g. 'http://...' or 'file://...'
  57498. * * A base64 string of in-line texture data, e.g. 'data:image/jpg;base64,/...'
  57499. * * An indicator that data being passed using the buffer parameter, e.g. 'data:mytexture.jpg'
  57500. * @param noMipmap defines a boolean indicating that no mipmaps shall be generated. Ignored for compressed textures. They must be in the file
  57501. * @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)
  57502. * @param scene needed for loading to the correct scene
  57503. * @param samplingMode mode with should be used sample / access the texture (Default: Texture.TRILINEAR_SAMPLINGMODE)
  57504. * @param onLoad optional callback to be called upon successful completion
  57505. * @param onError optional callback to be called upon failure
  57506. * @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
  57507. * @param fallback an internal argument in case the function must be called again, due to etc1 not having alpha capabilities
  57508. * @param format internal format. Default: RGB when extension is '.jpg' else RGBA. Ignored for compressed textures
  57509. * @param forcedExtension defines the extension to use to pick the right loader
  57510. * @param mimeType defines an optional mime type
  57511. * @returns a InternalTexture for assignment back into BABYLON.Texture
  57512. */
  57513. 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;
  57514. /**
  57515. * Creates a new render target texture
  57516. * @param size defines the size of the texture
  57517. * @param options defines the options used to create the texture
  57518. * @returns a new render target texture stored in an InternalTexture
  57519. */
  57520. createRenderTargetTexture(size: any, options: boolean | RenderTargetCreationOptions): InternalTexture;
  57521. /**
  57522. * Update the sampling mode of a given texture
  57523. * @param samplingMode defines the required sampling mode
  57524. * @param texture defines the texture to update
  57525. */
  57526. updateTextureSamplingMode(samplingMode: number, texture: InternalTexture): void;
  57527. /**
  57528. * Binds the frame buffer to the specified texture.
  57529. * @param texture The texture to render to or null for the default canvas
  57530. * @param faceIndex The face of the texture to render to in case of cube texture
  57531. * @param requiredWidth The width of the target to render to
  57532. * @param requiredHeight The height of the target to render to
  57533. * @param forceFullscreenViewport Forces the viewport to be the entire texture/screen if true
  57534. * @param lodLevel defines le lod level to bind to the frame buffer
  57535. */
  57536. bindFramebuffer(texture: InternalTexture, faceIndex?: number, requiredWidth?: number, requiredHeight?: number, forceFullscreenViewport?: boolean): void;
  57537. /**
  57538. * Unbind the current render target texture from the webGL context
  57539. * @param texture defines the render target texture to unbind
  57540. * @param disableGenerateMipMaps defines a boolean indicating that mipmaps must not be generated
  57541. * @param onBeforeUnbind defines a function which will be called before the effective unbind
  57542. */
  57543. unBindFramebuffer(texture: InternalTexture, disableGenerateMipMaps?: boolean, onBeforeUnbind?: () => void): void;
  57544. /**
  57545. * Creates a dynamic vertex buffer
  57546. * @param vertices the data for the dynamic vertex buffer
  57547. * @returns the new WebGL dynamic buffer
  57548. */
  57549. createDynamicVertexBuffer(vertices: FloatArray): DataBuffer;
  57550. /**
  57551. * Update the content of a dynamic texture
  57552. * @param texture defines the texture to update
  57553. * @param canvas defines the canvas containing the source
  57554. * @param invertY defines if data must be stored with Y axis inverted
  57555. * @param premulAlpha defines if alpha is stored as premultiplied
  57556. * @param format defines the format of the data
  57557. * @param forceBindTexture if the texture should be forced to be bound eg. after a graphics context loss (Default: false)
  57558. */
  57559. updateDynamicTexture(texture: Nullable<InternalTexture>, canvas: HTMLCanvasElement, invertY: boolean, premulAlpha?: boolean, format?: number): void;
  57560. /**
  57561. * Gets a boolean indicating if all created effects are ready
  57562. * @returns true if all effects are ready
  57563. */
  57564. areAllEffectsReady(): boolean;
  57565. /**
  57566. * @hidden
  57567. * Get the current error code of the webGL context
  57568. * @returns the error code
  57569. * @see https://developer.mozilla.org/en-US/docs/Web/API/WebGLRenderingContext/getError
  57570. */
  57571. getError(): number;
  57572. /** @hidden */
  57573. _getUnpackAlignement(): number;
  57574. /** @hidden */
  57575. _unpackFlipY(value: boolean): void;
  57576. /**
  57577. * Update a dynamic index buffer
  57578. * @param indexBuffer defines the target index buffer
  57579. * @param indices defines the data to update
  57580. * @param offset defines the offset in the target index buffer where update should start
  57581. */
  57582. updateDynamicIndexBuffer(indexBuffer: WebGLBuffer, indices: IndicesArray, offset?: number): void;
  57583. /**
  57584. * Updates a dynamic vertex buffer.
  57585. * @param vertexBuffer the vertex buffer to update
  57586. * @param vertices the data used to update the vertex buffer
  57587. * @param byteOffset the byte offset of the data (optional)
  57588. * @param byteLength the byte length of the data (optional)
  57589. */
  57590. updateDynamicVertexBuffer(vertexBuffer: WebGLBuffer, vertices: FloatArray, byteOffset?: number, byteLength?: number): void;
  57591. /** @hidden */
  57592. _bindTextureDirectly(target: number, texture: InternalTexture): boolean;
  57593. /** @hidden */
  57594. _bindTexture(channel: number, texture: InternalTexture): void;
  57595. protected _deleteBuffer(buffer: WebGLBuffer): void;
  57596. /**
  57597. * 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
  57598. */
  57599. releaseEffects(): void;
  57600. displayLoadingUI(): void;
  57601. hideLoadingUI(): void;
  57602. /** @hidden */
  57603. _uploadCompressedDataToTextureDirectly(texture: InternalTexture, internalFormat: number, width: number, height: number, data: ArrayBufferView, faceIndex?: number, lod?: number): void;
  57604. /** @hidden */
  57605. _uploadDataToTextureDirectly(texture: InternalTexture, imageData: ArrayBufferView, faceIndex?: number, lod?: number): void;
  57606. /** @hidden */
  57607. _uploadArrayBufferViewToTexture(texture: InternalTexture, imageData: ArrayBufferView, faceIndex?: number, lod?: number): void;
  57608. /** @hidden */
  57609. _uploadImageToTexture(texture: InternalTexture, image: HTMLImageElement, faceIndex?: number, lod?: number): void;
  57610. }
  57611. }
  57612. declare module "babylonjs/Instrumentation/timeToken" {
  57613. import { Nullable } from "babylonjs/types";
  57614. /**
  57615. * @hidden
  57616. **/
  57617. export class _TimeToken {
  57618. _startTimeQuery: Nullable<WebGLQuery>;
  57619. _endTimeQuery: Nullable<WebGLQuery>;
  57620. _timeElapsedQuery: Nullable<WebGLQuery>;
  57621. _timeElapsedQueryEnded: boolean;
  57622. }
  57623. }
  57624. declare module "babylonjs/Engines/Extensions/engine.occlusionQuery" {
  57625. import { Nullable, int } from "babylonjs/types";
  57626. import { _TimeToken } from "babylonjs/Instrumentation/timeToken";
  57627. /** @hidden */
  57628. export class _OcclusionDataStorage {
  57629. /** @hidden */
  57630. occlusionInternalRetryCounter: number;
  57631. /** @hidden */
  57632. isOcclusionQueryInProgress: boolean;
  57633. /** @hidden */
  57634. isOccluded: boolean;
  57635. /** @hidden */
  57636. occlusionRetryCount: number;
  57637. /** @hidden */
  57638. occlusionType: number;
  57639. /** @hidden */
  57640. occlusionQueryAlgorithmType: number;
  57641. }
  57642. module "babylonjs/Engines/engine" {
  57643. interface Engine {
  57644. /**
  57645. * Create a new webGL query (you must be sure that queries are supported by checking getCaps() function)
  57646. * @return the new query
  57647. */
  57648. createQuery(): WebGLQuery;
  57649. /**
  57650. * Delete and release a webGL query
  57651. * @param query defines the query to delete
  57652. * @return the current engine
  57653. */
  57654. deleteQuery(query: WebGLQuery): Engine;
  57655. /**
  57656. * Check if a given query has resolved and got its value
  57657. * @param query defines the query to check
  57658. * @returns true if the query got its value
  57659. */
  57660. isQueryResultAvailable(query: WebGLQuery): boolean;
  57661. /**
  57662. * Gets the value of a given query
  57663. * @param query defines the query to check
  57664. * @returns the value of the query
  57665. */
  57666. getQueryResult(query: WebGLQuery): number;
  57667. /**
  57668. * Initiates an occlusion query
  57669. * @param algorithmType defines the algorithm to use
  57670. * @param query defines the query to use
  57671. * @returns the current engine
  57672. * @see https://doc.babylonjs.com/features/occlusionquery
  57673. */
  57674. beginOcclusionQuery(algorithmType: number, query: WebGLQuery): Engine;
  57675. /**
  57676. * Ends an occlusion query
  57677. * @see https://doc.babylonjs.com/features/occlusionquery
  57678. * @param algorithmType defines the algorithm to use
  57679. * @returns the current engine
  57680. */
  57681. endOcclusionQuery(algorithmType: number): Engine;
  57682. /**
  57683. * Starts a time query (used to measure time spent by the GPU on a specific frame)
  57684. * Please note that only one query can be issued at a time
  57685. * @returns a time token used to track the time span
  57686. */
  57687. startTimeQuery(): Nullable<_TimeToken>;
  57688. /**
  57689. * Ends a time query
  57690. * @param token defines the token used to measure the time span
  57691. * @returns the time spent (in ns)
  57692. */
  57693. endTimeQuery(token: _TimeToken): int;
  57694. /** @hidden */
  57695. _currentNonTimestampToken: Nullable<_TimeToken>;
  57696. /** @hidden */
  57697. _createTimeQuery(): WebGLQuery;
  57698. /** @hidden */
  57699. _deleteTimeQuery(query: WebGLQuery): void;
  57700. /** @hidden */
  57701. _getGlAlgorithmType(algorithmType: number): number;
  57702. /** @hidden */
  57703. _getTimeQueryResult(query: WebGLQuery): any;
  57704. /** @hidden */
  57705. _getTimeQueryAvailability(query: WebGLQuery): any;
  57706. }
  57707. }
  57708. module "babylonjs/Meshes/abstractMesh" {
  57709. interface AbstractMesh {
  57710. /**
  57711. * Backing filed
  57712. * @hidden
  57713. */
  57714. __occlusionDataStorage: _OcclusionDataStorage;
  57715. /**
  57716. * Access property
  57717. * @hidden
  57718. */
  57719. _occlusionDataStorage: _OcclusionDataStorage;
  57720. /**
  57721. * 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.
  57722. * The default value is -1 which means don't break the query and wait till the result
  57723. * @see https://doc.babylonjs.com/features/occlusionquery
  57724. */
  57725. occlusionRetryCount: number;
  57726. /**
  57727. * 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:
  57728. * * OCCLUSION_TYPE_NONE (Default Value): this option means no occlusion query whith the Mesh.
  57729. * * OCCLUSION_TYPE_OPTIMISTIC: this option is means use occlusion query and if occlusionRetryCount is reached and the query is broken show the mesh.
  57730. * * 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.
  57731. * @see https://doc.babylonjs.com/features/occlusionquery
  57732. */
  57733. occlusionType: number;
  57734. /**
  57735. * This property determines the type of occlusion query algorithm to run in WebGl, you can use:
  57736. * * AbstractMesh.OCCLUSION_ALGORITHM_TYPE_ACCURATE which is mapped to GL_ANY_SAMPLES_PASSED.
  57737. * * 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.
  57738. * @see https://doc.babylonjs.com/features/occlusionquery
  57739. */
  57740. occlusionQueryAlgorithmType: number;
  57741. /**
  57742. * 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
  57743. * @see https://doc.babylonjs.com/features/occlusionquery
  57744. */
  57745. isOccluded: boolean;
  57746. /**
  57747. * Flag to check the progress status of the query
  57748. * @see https://doc.babylonjs.com/features/occlusionquery
  57749. */
  57750. isOcclusionQueryInProgress: boolean;
  57751. }
  57752. }
  57753. }
  57754. declare module "babylonjs/Engines/Extensions/engine.transformFeedback" {
  57755. import { Nullable } from "babylonjs/types";
  57756. import { DataBuffer } from "babylonjs/Meshes/dataBuffer";
  57757. /** @hidden */
  57758. export var _forceTransformFeedbackToBundle: boolean;
  57759. module "babylonjs/Engines/engine" {
  57760. interface Engine {
  57761. /**
  57762. * Creates a webGL transform feedback object
  57763. * Please makes sure to check webGLVersion property to check if you are running webGL 2+
  57764. * @returns the webGL transform feedback object
  57765. */
  57766. createTransformFeedback(): WebGLTransformFeedback;
  57767. /**
  57768. * Delete a webGL transform feedback object
  57769. * @param value defines the webGL transform feedback object to delete
  57770. */
  57771. deleteTransformFeedback(value: WebGLTransformFeedback): void;
  57772. /**
  57773. * Bind a webGL transform feedback object to the webgl context
  57774. * @param value defines the webGL transform feedback object to bind
  57775. */
  57776. bindTransformFeedback(value: Nullable<WebGLTransformFeedback>): void;
  57777. /**
  57778. * Begins a transform feedback operation
  57779. * @param usePoints defines if points or triangles must be used
  57780. */
  57781. beginTransformFeedback(usePoints: boolean): void;
  57782. /**
  57783. * Ends a transform feedback operation
  57784. */
  57785. endTransformFeedback(): void;
  57786. /**
  57787. * Specify the varyings to use with transform feedback
  57788. * @param program defines the associated webGL program
  57789. * @param value defines the list of strings representing the varying names
  57790. */
  57791. setTranformFeedbackVaryings(program: WebGLProgram, value: string[]): void;
  57792. /**
  57793. * Bind a webGL buffer for a transform feedback operation
  57794. * @param value defines the webGL buffer to bind
  57795. */
  57796. bindTransformFeedbackBuffer(value: Nullable<DataBuffer>): void;
  57797. }
  57798. }
  57799. }
  57800. declare module "babylonjs/Engines/Extensions/engine.views" {
  57801. import { Camera } from "babylonjs/Cameras/camera";
  57802. import { Nullable } from "babylonjs/types";
  57803. /**
  57804. * Class used to define an additional view for the engine
  57805. * @see https://doc.babylonjs.com/how_to/multi_canvases
  57806. */
  57807. export class EngineView {
  57808. /** Defines the canvas where to render the view */
  57809. target: HTMLCanvasElement;
  57810. /** Defines an optional camera used to render the view (will use active camera else) */
  57811. camera?: Camera;
  57812. }
  57813. module "babylonjs/Engines/engine" {
  57814. interface Engine {
  57815. /**
  57816. * Gets or sets the HTML element to use for attaching events
  57817. */
  57818. inputElement: Nullable<HTMLElement>;
  57819. /**
  57820. * Gets the current engine view
  57821. * @see https://doc.babylonjs.com/how_to/multi_canvases
  57822. */
  57823. activeView: Nullable<EngineView>;
  57824. /** Gets or sets the list of views */
  57825. views: EngineView[];
  57826. /**
  57827. * Register a new child canvas
  57828. * @param canvas defines the canvas to register
  57829. * @param camera defines an optional camera to use with this canvas (it will overwrite the scene.camera for this view)
  57830. * @returns the associated view
  57831. */
  57832. registerView(canvas: HTMLCanvasElement, camera?: Camera): EngineView;
  57833. /**
  57834. * Remove a registered child canvas
  57835. * @param canvas defines the canvas to remove
  57836. * @returns the current engine
  57837. */
  57838. unRegisterView(canvas: HTMLCanvasElement): Engine;
  57839. }
  57840. }
  57841. }
  57842. declare module "babylonjs/Engines/Extensions/engine.textureSelector" {
  57843. import { Nullable } from "babylonjs/types";
  57844. module "babylonjs/Engines/engine" {
  57845. interface Engine {
  57846. /** @hidden */
  57847. _excludedCompressedTextures: string[];
  57848. /** @hidden */
  57849. _textureFormatInUse: string;
  57850. /**
  57851. * Gets the list of texture formats supported
  57852. */
  57853. readonly texturesSupported: Array<string>;
  57854. /**
  57855. * Gets the texture format in use
  57856. */
  57857. readonly textureFormatInUse: Nullable<string>;
  57858. /**
  57859. * Set the compressed texture extensions or file names to skip.
  57860. *
  57861. * @param skippedFiles defines the list of those texture files you want to skip
  57862. * Example: [".dds", ".env", "myfile.png"]
  57863. */
  57864. setCompressedTextureExclusions(skippedFiles: Array<string>): void;
  57865. /**
  57866. * Set the compressed texture format to use, based on the formats you have, and the formats
  57867. * supported by the hardware / browser.
  57868. *
  57869. * Khronos Texture Container (.ktx) files are used to support this. This format has the
  57870. * advantage of being specifically designed for OpenGL. Header elements directly correspond
  57871. * to API arguments needed to compressed textures. This puts the burden on the container
  57872. * generator to house the arcane code for determining these for current & future formats.
  57873. *
  57874. * for description see https://www.khronos.org/opengles/sdk/tools/KTX/
  57875. * for file layout see https://www.khronos.org/opengles/sdk/tools/KTX/file_format_spec/
  57876. *
  57877. * Note: The result of this call is not taken into account when a texture is base64.
  57878. *
  57879. * @param formatsAvailable defines the list of those format families you have created
  57880. * on your server. Syntax: '-' + format family + '.ktx'. (Case and order do not matter.)
  57881. *
  57882. * Current families are astc, dxt, pvrtc, etc2, & etc1.
  57883. * @returns The extension selected.
  57884. */
  57885. setTextureFormatToUse(formatsAvailable: Array<string>): Nullable<string>;
  57886. }
  57887. }
  57888. }
  57889. declare module "babylonjs/Engines/Extensions/index" {
  57890. export * from "babylonjs/Engines/Extensions/engine.alpha";
  57891. export * from "babylonjs/Engines/Extensions/engine.occlusionQuery";
  57892. export * from "babylonjs/Engines/Extensions/engine.transformFeedback";
  57893. export * from "babylonjs/Engines/Extensions/engine.multiview";
  57894. export * from "babylonjs/Engines/Extensions/engine.rawTexture";
  57895. export * from "babylonjs/Engines/Extensions/engine.dynamicTexture";
  57896. export * from "babylonjs/Engines/Extensions/engine.videoTexture";
  57897. export * from "babylonjs/Engines/Extensions/engine.multiRender";
  57898. export * from "babylonjs/Engines/Extensions/engine.cubeTexture";
  57899. export * from "babylonjs/Engines/Extensions/engine.renderTarget";
  57900. export * from "babylonjs/Engines/Extensions/engine.renderTargetCube";
  57901. export * from "babylonjs/Engines/Extensions/engine.webVR";
  57902. export * from "babylonjs/Engines/Extensions/engine.uniformBuffer";
  57903. export * from "babylonjs/Engines/Extensions/engine.dynamicBuffer";
  57904. export * from "babylonjs/Engines/Extensions/engine.views";
  57905. export * from "babylonjs/Engines/Extensions/engine.readTexture";
  57906. import "babylonjs/Engines/Extensions/engine.textureSelector";
  57907. export * from "babylonjs/Engines/Extensions/engine.textureSelector";
  57908. }
  57909. declare module "babylonjs/Shaders/rgbdEncode.fragment" {
  57910. import "babylonjs/Shaders/ShadersInclude/helperFunctions";
  57911. /** @hidden */
  57912. export var rgbdEncodePixelShader: {
  57913. name: string;
  57914. shader: string;
  57915. };
  57916. }
  57917. declare module "babylonjs/Misc/environmentTextureTools" {
  57918. import { Nullable } from "babylonjs/types";
  57919. import { SphericalPolynomial } from "babylonjs/Maths/sphericalPolynomial";
  57920. import { InternalTexture } from "babylonjs/Materials/Textures/internalTexture";
  57921. import { BaseTexture } from "babylonjs/Materials/Textures/baseTexture";
  57922. import "babylonjs/Engines/Extensions/engine.renderTargetCube";
  57923. import "babylonjs/Engines/Extensions/engine.readTexture";
  57924. import "babylonjs/Materials/Textures/baseTexture.polynomial";
  57925. import "babylonjs/Shaders/rgbdEncode.fragment";
  57926. import "babylonjs/Shaders/rgbdDecode.fragment";
  57927. /**
  57928. * Raw texture data and descriptor sufficient for WebGL texture upload
  57929. */
  57930. export interface EnvironmentTextureInfo {
  57931. /**
  57932. * Version of the environment map
  57933. */
  57934. version: number;
  57935. /**
  57936. * Width of image
  57937. */
  57938. width: number;
  57939. /**
  57940. * Irradiance information stored in the file.
  57941. */
  57942. irradiance: any;
  57943. /**
  57944. * Specular information stored in the file.
  57945. */
  57946. specular: any;
  57947. }
  57948. /**
  57949. * Defines One Image in the file. It requires only the position in the file
  57950. * as well as the length.
  57951. */
  57952. interface BufferImageData {
  57953. /**
  57954. * Length of the image data.
  57955. */
  57956. length: number;
  57957. /**
  57958. * Position of the data from the null terminator delimiting the end of the JSON.
  57959. */
  57960. position: number;
  57961. }
  57962. /**
  57963. * Defines the specular data enclosed in the file.
  57964. * This corresponds to the version 1 of the data.
  57965. */
  57966. export interface EnvironmentTextureSpecularInfoV1 {
  57967. /**
  57968. * Defines where the specular Payload is located. It is a runtime value only not stored in the file.
  57969. */
  57970. specularDataPosition?: number;
  57971. /**
  57972. * This contains all the images data needed to reconstruct the cubemap.
  57973. */
  57974. mipmaps: Array<BufferImageData>;
  57975. /**
  57976. * Defines the scale applied to environment texture. This manages the range of LOD level used for IBL according to the roughness.
  57977. */
  57978. lodGenerationScale: number;
  57979. }
  57980. /**
  57981. * Sets of helpers addressing the serialization and deserialization of environment texture
  57982. * stored in a BabylonJS env file.
  57983. * Those files are usually stored as .env files.
  57984. */
  57985. export class EnvironmentTextureTools {
  57986. /**
  57987. * Magic number identifying the env file.
  57988. */
  57989. private static _MagicBytes;
  57990. /**
  57991. * Gets the environment info from an env file.
  57992. * @param data The array buffer containing the .env bytes.
  57993. * @returns the environment file info (the json header) if successfully parsed.
  57994. */
  57995. static GetEnvInfo(data: ArrayBufferView): Nullable<EnvironmentTextureInfo>;
  57996. /**
  57997. * Creates an environment texture from a loaded cube texture.
  57998. * @param texture defines the cube texture to convert in env file
  57999. * @return a promise containing the environment data if succesfull.
  58000. */
  58001. static CreateEnvTextureAsync(texture: BaseTexture): Promise<ArrayBuffer>;
  58002. /**
  58003. * Creates a JSON representation of the spherical data.
  58004. * @param texture defines the texture containing the polynomials
  58005. * @return the JSON representation of the spherical info
  58006. */
  58007. private static _CreateEnvTextureIrradiance;
  58008. /**
  58009. * Creates the ArrayBufferViews used for initializing environment texture image data.
  58010. * @param data the image data
  58011. * @param info parameters that determine what views will be created for accessing the underlying buffer
  58012. * @return the views described by info providing access to the underlying buffer
  58013. */
  58014. static CreateImageDataArrayBufferViews(data: ArrayBufferView, info: EnvironmentTextureInfo): Array<Array<ArrayBufferView>>;
  58015. /**
  58016. * Uploads the texture info contained in the env file to the GPU.
  58017. * @param texture defines the internal texture to upload to
  58018. * @param data defines the data to load
  58019. * @param info defines the texture info retrieved through the GetEnvInfo method
  58020. * @returns a promise
  58021. */
  58022. static UploadEnvLevelsAsync(texture: InternalTexture, data: ArrayBufferView, info: EnvironmentTextureInfo): Promise<void>;
  58023. private static _OnImageReadyAsync;
  58024. /**
  58025. * Uploads the levels of image data to the GPU.
  58026. * @param texture defines the internal texture to upload to
  58027. * @param imageData defines the array buffer views of image data [mipmap][face]
  58028. * @returns a promise
  58029. */
  58030. static UploadLevelsAsync(texture: InternalTexture, imageData: ArrayBufferView[][]): Promise<void>;
  58031. /**
  58032. * Uploads spherical polynomials information to the texture.
  58033. * @param texture defines the texture we are trying to upload the information to
  58034. * @param info defines the environment texture info retrieved through the GetEnvInfo method
  58035. */
  58036. static UploadEnvSpherical(texture: InternalTexture, info: EnvironmentTextureInfo): void;
  58037. /** @hidden */
  58038. static _UpdateRGBDAsync(internalTexture: InternalTexture, data: ArrayBufferView[][], sphericalPolynomial: Nullable<SphericalPolynomial>, lodScale: number, lodOffset: number): Promise<void>;
  58039. }
  58040. }
  58041. declare module "babylonjs/Engines/Processors/shaderCodeInliner" {
  58042. /**
  58043. * Class used to inline functions in shader code
  58044. */
  58045. export class ShaderCodeInliner {
  58046. private static readonly _RegexpFindFunctionNameAndType;
  58047. private _sourceCode;
  58048. private _functionDescr;
  58049. private _numMaxIterations;
  58050. /** Gets or sets the token used to mark the functions to inline */
  58051. inlineToken: string;
  58052. /** Gets or sets the debug mode */
  58053. debug: boolean;
  58054. /** Gets the code after the inlining process */
  58055. get code(): string;
  58056. /**
  58057. * Initializes the inliner
  58058. * @param sourceCode shader code source to inline
  58059. * @param numMaxIterations maximum number of iterations (used to detect recursive calls)
  58060. */
  58061. constructor(sourceCode: string, numMaxIterations?: number);
  58062. /**
  58063. * Start the processing of the shader code
  58064. */
  58065. processCode(): void;
  58066. private _collectFunctions;
  58067. private _processInlining;
  58068. private _extractBetweenMarkers;
  58069. private _skipWhitespaces;
  58070. private _removeComments;
  58071. private _replaceFunctionCallsByCode;
  58072. private _findBackward;
  58073. private _escapeRegExp;
  58074. private _replaceNames;
  58075. }
  58076. }
  58077. declare module "babylonjs/Engines/nativeEngine" {
  58078. import { Nullable, IndicesArray, DataArray } from "babylonjs/types";
  58079. import { Engine } from "babylonjs/Engines/engine";
  58080. import { VertexBuffer } from "babylonjs/Meshes/buffer";
  58081. import { InternalTexture } from "babylonjs/Materials/Textures/internalTexture";
  58082. import { BaseTexture } from "babylonjs/Materials/Textures/baseTexture";
  58083. import { Effect } from "babylonjs/Materials/effect";
  58084. import { DataBuffer } from "babylonjs/Meshes/dataBuffer";
  58085. import { Matrix, Viewport, Color3 } from "babylonjs/Maths/math";
  58086. import { IColor4Like } from "babylonjs/Maths/math.like";
  58087. import { Scene } from "babylonjs/scene";
  58088. import { RenderTargetCreationOptions } from "babylonjs/Materials/Textures/renderTargetCreationOptions";
  58089. import { IPipelineContext } from "babylonjs/Engines/IPipelineContext";
  58090. import { ISceneLike } from "babylonjs/Engines/thinEngine";
  58091. import { RenderTargetTextureSize } from "babylonjs/Engines/Extensions/engine.renderTarget";
  58092. import { DepthTextureCreationOptions } from "babylonjs/Engines/depthTextureCreationOptions";
  58093. /**
  58094. * Container for accessors for natively-stored mesh data buffers.
  58095. */
  58096. class NativeDataBuffer extends DataBuffer {
  58097. /**
  58098. * Accessor value used to identify/retrieve a natively-stored index buffer.
  58099. */
  58100. nativeIndexBuffer?: any;
  58101. /**
  58102. * Accessor value used to identify/retrieve a natively-stored vertex buffer.
  58103. */
  58104. nativeVertexBuffer?: any;
  58105. }
  58106. /** @hidden */
  58107. class NativeTexture extends InternalTexture {
  58108. getInternalTexture(): InternalTexture;
  58109. getViewCount(): number;
  58110. }
  58111. /** @hidden */
  58112. export class NativeEngine extends Engine {
  58113. private readonly _native;
  58114. /** Defines the invalid handle returned by bgfx when resource creation goes wrong */
  58115. private readonly INVALID_HANDLE;
  58116. private _boundBuffersVertexArray;
  58117. private _currentDepthTest;
  58118. getHardwareScalingLevel(): number;
  58119. constructor();
  58120. dispose(): void;
  58121. /**
  58122. * Can be used to override the current requestAnimationFrame requester.
  58123. * @hidden
  58124. */
  58125. protected _queueNewFrame(bindedRenderFunction: any, requester?: any): number;
  58126. /**
  58127. * Override default engine behavior.
  58128. * @param color
  58129. * @param backBuffer
  58130. * @param depth
  58131. * @param stencil
  58132. */
  58133. _bindUnboundFramebuffer(framebuffer: Nullable<WebGLFramebuffer>): void;
  58134. /**
  58135. * Gets host document
  58136. * @returns the host document object
  58137. */
  58138. getHostDocument(): Nullable<Document>;
  58139. clear(color: Nullable<IColor4Like>, backBuffer: boolean, depth: boolean, stencil?: boolean): void;
  58140. createIndexBuffer(indices: IndicesArray, updateable?: boolean): NativeDataBuffer;
  58141. createVertexBuffer(data: DataArray, updateable?: boolean): NativeDataBuffer;
  58142. protected _recordVertexArrayObject(vertexArray: any, vertexBuffers: {
  58143. [key: string]: VertexBuffer;
  58144. }, indexBuffer: Nullable<NativeDataBuffer>, effect: Effect): void;
  58145. bindBuffers(vertexBuffers: {
  58146. [key: string]: VertexBuffer;
  58147. }, indexBuffer: Nullable<NativeDataBuffer>, effect: Effect): void;
  58148. recordVertexArrayObject(vertexBuffers: {
  58149. [key: string]: VertexBuffer;
  58150. }, indexBuffer: Nullable<NativeDataBuffer>, effect: Effect): WebGLVertexArrayObject;
  58151. bindVertexArrayObject(vertexArray: WebGLVertexArrayObject): void;
  58152. releaseVertexArrayObject(vertexArray: WebGLVertexArrayObject): void;
  58153. getAttributes(pipelineContext: IPipelineContext, attributesNames: string[]): number[];
  58154. /**
  58155. * Draw a list of indexed primitives
  58156. * @param fillMode defines the primitive to use
  58157. * @param indexStart defines the starting index
  58158. * @param indexCount defines the number of index to draw
  58159. * @param instancesCount defines the number of instances to draw (if instanciation is enabled)
  58160. */
  58161. drawElementsType(fillMode: number, indexStart: number, indexCount: number, instancesCount?: number): void;
  58162. /**
  58163. * Draw a list of unindexed primitives
  58164. * @param fillMode defines the primitive to use
  58165. * @param verticesStart defines the index of first vertex to draw
  58166. * @param verticesCount defines the count of vertices to draw
  58167. * @param instancesCount defines the number of instances to draw (if instanciation is enabled)
  58168. */
  58169. drawArraysType(fillMode: number, verticesStart: number, verticesCount: number, instancesCount?: number): void;
  58170. createPipelineContext(): IPipelineContext;
  58171. _preparePipelineContext(pipelineContext: IPipelineContext, vertexSourceCode: string, fragmentSourceCode: string, createAsRaw: boolean, rebuildRebind: any, defines: Nullable<string>, transformFeedbackVaryings: Nullable<string[]>): void;
  58172. /** @hidden */
  58173. _isRenderingStateCompiled(pipelineContext: IPipelineContext): boolean;
  58174. /** @hidden */
  58175. _executeWhenRenderingStateIsCompiled(pipelineContext: IPipelineContext, action: () => void): void;
  58176. createRawShaderProgram(pipelineContext: IPipelineContext, vertexCode: string, fragmentCode: string, context?: WebGLRenderingContext, transformFeedbackVaryings?: Nullable<string[]>): any;
  58177. createShaderProgram(pipelineContext: IPipelineContext, vertexCode: string, fragmentCode: string, defines: Nullable<string>, context?: WebGLRenderingContext, transformFeedbackVaryings?: Nullable<string[]>): any;
  58178. protected _setProgram(program: WebGLProgram): void;
  58179. _releaseEffect(effect: Effect): void;
  58180. _deletePipelineContext(pipelineContext: IPipelineContext): void;
  58181. getUniforms(pipelineContext: IPipelineContext, uniformsNames: string[]): WebGLUniformLocation[];
  58182. bindUniformBlock(pipelineContext: IPipelineContext, blockName: string, index: number): void;
  58183. bindSamplers(effect: Effect): void;
  58184. setMatrix(uniform: WebGLUniformLocation, matrix: Matrix): void;
  58185. getRenderWidth(useScreen?: boolean): number;
  58186. getRenderHeight(useScreen?: boolean): number;
  58187. setViewport(viewport: Viewport, requiredWidth?: number, requiredHeight?: number): void;
  58188. setState(culling: boolean, zOffset?: number, force?: boolean, reverseSide?: boolean): void;
  58189. /**
  58190. * Set the z offset to apply to current rendering
  58191. * @param value defines the offset to apply
  58192. */
  58193. setZOffset(value: number): void;
  58194. /**
  58195. * Gets the current value of the zOffset
  58196. * @returns the current zOffset state
  58197. */
  58198. getZOffset(): number;
  58199. /**
  58200. * Enable or disable depth buffering
  58201. * @param enable defines the state to set
  58202. */
  58203. setDepthBuffer(enable: boolean): void;
  58204. /**
  58205. * Gets a boolean indicating if depth writing is enabled
  58206. * @returns the current depth writing state
  58207. */
  58208. getDepthWrite(): boolean;
  58209. setDepthFunctionToGreater(): void;
  58210. setDepthFunctionToGreaterOrEqual(): void;
  58211. setDepthFunctionToLess(): void;
  58212. setDepthFunctionToLessOrEqual(): void;
  58213. /**
  58214. * Enable or disable depth writing
  58215. * @param enable defines the state to set
  58216. */
  58217. setDepthWrite(enable: boolean): void;
  58218. /**
  58219. * Enable or disable color writing
  58220. * @param enable defines the state to set
  58221. */
  58222. setColorWrite(enable: boolean): void;
  58223. /**
  58224. * Gets a boolean indicating if color writing is enabled
  58225. * @returns the current color writing state
  58226. */
  58227. getColorWrite(): boolean;
  58228. /**
  58229. * Sets alpha constants used by some alpha blending modes
  58230. * @param r defines the red component
  58231. * @param g defines the green component
  58232. * @param b defines the blue component
  58233. * @param a defines the alpha component
  58234. */
  58235. setAlphaConstants(r: number, g: number, b: number, a: number): void;
  58236. /**
  58237. * Sets the current alpha mode
  58238. * @param mode defines the mode to use (one of the BABYLON.Constants.ALPHA_XXX)
  58239. * @param noDepthWriteChange defines if depth writing state should remains unchanged (false by default)
  58240. * @see https://doc.babylonjs.com/resources/transparency_and_how_meshes_are_rendered
  58241. */
  58242. setAlphaMode(mode: number, noDepthWriteChange?: boolean): void;
  58243. /**
  58244. * Gets the current alpha mode
  58245. * @see https://doc.babylonjs.com/resources/transparency_and_how_meshes_are_rendered
  58246. * @returns the current alpha mode
  58247. */
  58248. getAlphaMode(): number;
  58249. setInt(uniform: WebGLUniformLocation, int: number): boolean;
  58250. setIntArray(uniform: WebGLUniformLocation, array: Int32Array): boolean;
  58251. setIntArray2(uniform: WebGLUniformLocation, array: Int32Array): boolean;
  58252. setIntArray3(uniform: WebGLUniformLocation, array: Int32Array): boolean;
  58253. setIntArray4(uniform: WebGLUniformLocation, array: Int32Array): boolean;
  58254. setFloatArray(uniform: WebGLUniformLocation, array: Float32Array): boolean;
  58255. setFloatArray2(uniform: WebGLUniformLocation, array: Float32Array): boolean;
  58256. setFloatArray3(uniform: WebGLUniformLocation, array: Float32Array): boolean;
  58257. setFloatArray4(uniform: WebGLUniformLocation, array: Float32Array): boolean;
  58258. setArray(uniform: WebGLUniformLocation, array: number[]): boolean;
  58259. setArray2(uniform: WebGLUniformLocation, array: number[]): boolean;
  58260. setArray3(uniform: WebGLUniformLocation, array: number[]): boolean;
  58261. setArray4(uniform: WebGLUniformLocation, array: number[]): boolean;
  58262. setMatrices(uniform: WebGLUniformLocation, matrices: Float32Array): boolean;
  58263. setMatrix3x3(uniform: WebGLUniformLocation, matrix: Float32Array): boolean;
  58264. setMatrix2x2(uniform: WebGLUniformLocation, matrix: Float32Array): boolean;
  58265. setFloat(uniform: WebGLUniformLocation, value: number): boolean;
  58266. setFloat2(uniform: WebGLUniformLocation, x: number, y: number): boolean;
  58267. setFloat3(uniform: WebGLUniformLocation, x: number, y: number, z: number): boolean;
  58268. setFloat4(uniform: WebGLUniformLocation, x: number, y: number, z: number, w: number): boolean;
  58269. setColor3(uniform: WebGLUniformLocation, color3: Color3): boolean;
  58270. setColor4(uniform: WebGLUniformLocation, color3: Color3, alpha: number): boolean;
  58271. wipeCaches(bruteForce?: boolean): void;
  58272. _createTexture(): WebGLTexture;
  58273. protected _deleteTexture(texture: Nullable<WebGLTexture>): void;
  58274. /**
  58275. * Update the content of a dynamic texture
  58276. * @param texture defines the texture to update
  58277. * @param canvas defines the canvas containing the source
  58278. * @param invertY defines if data must be stored with Y axis inverted
  58279. * @param premulAlpha defines if alpha is stored as premultiplied
  58280. * @param format defines the format of the data
  58281. * @param forceBindTexture if the texture should be forced to be bound eg. after a graphics context loss (Default: false)
  58282. */
  58283. updateDynamicTexture(texture: Nullable<InternalTexture>, canvas: HTMLCanvasElement, invertY: boolean, premulAlpha?: boolean, format?: number): void;
  58284. /**
  58285. * Usually called from Texture.ts.
  58286. * Passed information to create a WebGLTexture
  58287. * @param url defines a value which contains one of the following:
  58288. * * A conventional http URL, e.g. 'http://...' or 'file://...'
  58289. * * A base64 string of in-line texture data, e.g. 'data:image/jpg;base64,/...'
  58290. * * An indicator that data being passed using the buffer parameter, e.g. 'data:mytexture.jpg'
  58291. * @param noMipmap defines a boolean indicating that no mipmaps shall be generated. Ignored for compressed textures. They must be in the file
  58292. * @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)
  58293. * @param scene needed for loading to the correct scene
  58294. * @param samplingMode mode with should be used sample / access the texture (Default: Texture.TRILINEAR_SAMPLINGMODE)
  58295. * @param onLoad optional callback to be called upon successful completion
  58296. * @param onError optional callback to be called upon failure
  58297. * @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
  58298. * @param fallback an internal argument in case the function must be called again, due to etc1 not having alpha capabilities
  58299. * @param format internal format. Default: RGB when extension is '.jpg' else RGBA. Ignored for compressed textures
  58300. * @param forcedExtension defines the extension to use to pick the right loader
  58301. * @param mimeType defines an optional mime type
  58302. * @returns a InternalTexture for assignment back into BABYLON.Texture
  58303. */
  58304. 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;
  58305. _createDepthStencilTexture(size: RenderTargetTextureSize, options: DepthTextureCreationOptions): NativeTexture;
  58306. _releaseFramebufferObjects(texture: InternalTexture): void;
  58307. /**
  58308. * Creates a cube texture
  58309. * @param rootUrl defines the url where the files to load is located
  58310. * @param scene defines the current scene
  58311. * @param files defines the list of files to load (1 per face)
  58312. * @param noMipmap defines a boolean indicating that no mipmaps shall be generated (false by default)
  58313. * @param onLoad defines an optional callback raised when the texture is loaded
  58314. * @param onError defines an optional callback raised if there is an issue to load the texture
  58315. * @param format defines the format of the data
  58316. * @param forcedExtension defines the extension to use to pick the right loader
  58317. * @param createPolynomials if a polynomial sphere should be created for the cube texture
  58318. * @param lodScale defines the scale applied to environment texture. This manages the range of LOD level used for IBL according to the roughness
  58319. * @param lodOffset defines the offset applied to environment texture. This manages first LOD level used for IBL according to the roughness
  58320. * @param fallback defines texture to use while falling back when (compressed) texture file not found.
  58321. * @returns the cube texture as an InternalTexture
  58322. */
  58323. 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;
  58324. createRenderTargetTexture(size: number | {
  58325. width: number;
  58326. height: number;
  58327. }, options: boolean | RenderTargetCreationOptions): NativeTexture;
  58328. updateTextureSamplingMode(samplingMode: number, texture: InternalTexture): void;
  58329. bindFramebuffer(texture: InternalTexture, faceIndex?: number, requiredWidth?: number, requiredHeight?: number, forceFullscreenViewport?: boolean): void;
  58330. unBindFramebuffer(texture: InternalTexture, disableGenerateMipMaps?: boolean, onBeforeUnbind?: () => void): void;
  58331. createDynamicVertexBuffer(data: DataArray): DataBuffer;
  58332. updateDynamicIndexBuffer(indexBuffer: DataBuffer, indices: IndicesArray, offset?: number): void;
  58333. /**
  58334. * Updates a dynamic vertex buffer.
  58335. * @param vertexBuffer the vertex buffer to update
  58336. * @param data the data used to update the vertex buffer
  58337. * @param byteOffset the byte offset of the data (optional)
  58338. * @param byteLength the byte length of the data (optional)
  58339. */
  58340. updateDynamicVertexBuffer(vertexBuffer: DataBuffer, data: DataArray, byteOffset?: number, byteLength?: number): void;
  58341. protected _setTexture(channel: number, texture: Nullable<BaseTexture>, isPartOfTextureArray?: boolean, depthStencilTexture?: boolean): boolean;
  58342. private _updateAnisotropicLevel;
  58343. private _getAddressMode;
  58344. /** @hidden */
  58345. _bindTexture(channel: number, texture: InternalTexture): void;
  58346. protected _deleteBuffer(buffer: NativeDataBuffer): void;
  58347. releaseEffects(): void;
  58348. /** @hidden */
  58349. _uploadCompressedDataToTextureDirectly(texture: InternalTexture, internalFormat: number, width: number, height: number, data: ArrayBufferView, faceIndex?: number, lod?: number): void;
  58350. /** @hidden */
  58351. _uploadDataToTextureDirectly(texture: InternalTexture, imageData: ArrayBufferView, faceIndex?: number, lod?: number): void;
  58352. /** @hidden */
  58353. _uploadArrayBufferViewToTexture(texture: InternalTexture, imageData: ArrayBufferView, faceIndex?: number, lod?: number): void;
  58354. /** @hidden */
  58355. _uploadImageToTexture(texture: InternalTexture, image: HTMLImageElement, faceIndex?: number, lod?: number): void;
  58356. private _getNativeSamplingMode;
  58357. private _getNativeTextureFormat;
  58358. private _getNativeAlphaMode;
  58359. private _getNativeAttribType;
  58360. }
  58361. }
  58362. declare module "babylonjs/Engines/index" {
  58363. export * from "babylonjs/Engines/constants";
  58364. export * from "babylonjs/Engines/engineCapabilities";
  58365. export * from "babylonjs/Engines/instancingAttributeInfo";
  58366. export * from "babylonjs/Engines/thinEngine";
  58367. export * from "babylonjs/Engines/engine";
  58368. export * from "babylonjs/Engines/engineStore";
  58369. export * from "babylonjs/Engines/nullEngine";
  58370. export * from "babylonjs/Engines/Extensions/index";
  58371. export * from "babylonjs/Engines/IPipelineContext";
  58372. export * from "babylonjs/Engines/WebGL/webGLPipelineContext";
  58373. export * from "babylonjs/Engines/WebGL/webGL2ShaderProcessors";
  58374. export * from "babylonjs/Engines/nativeEngine";
  58375. export * from "babylonjs/Engines/Processors/shaderCodeInliner";
  58376. export * from "babylonjs/Engines/performanceConfigurator";
  58377. }
  58378. declare module "babylonjs/Events/clipboardEvents" {
  58379. /**
  58380. * Gather the list of clipboard event types as constants.
  58381. */
  58382. export class ClipboardEventTypes {
  58383. /**
  58384. * The clipboard event is fired when a copy command is active (pressed).
  58385. */
  58386. static readonly COPY: number;
  58387. /**
  58388. * The clipboard event is fired when a cut command is active (pressed).
  58389. */
  58390. static readonly CUT: number;
  58391. /**
  58392. * The clipboard event is fired when a paste command is active (pressed).
  58393. */
  58394. static readonly PASTE: number;
  58395. }
  58396. /**
  58397. * This class is used to store clipboard related info for the onClipboardObservable event.
  58398. */
  58399. export class ClipboardInfo {
  58400. /**
  58401. * Defines the type of event (BABYLON.ClipboardEventTypes)
  58402. */
  58403. type: number;
  58404. /**
  58405. * Defines the related dom event
  58406. */
  58407. event: ClipboardEvent;
  58408. /**
  58409. *Creates an instance of ClipboardInfo.
  58410. * @param type Defines the type of event (BABYLON.ClipboardEventTypes)
  58411. * @param event Defines the related dom event
  58412. */
  58413. constructor(
  58414. /**
  58415. * Defines the type of event (BABYLON.ClipboardEventTypes)
  58416. */
  58417. type: number,
  58418. /**
  58419. * Defines the related dom event
  58420. */
  58421. event: ClipboardEvent);
  58422. /**
  58423. * Get the clipboard event's type from the keycode.
  58424. * @param keyCode Defines the keyCode for the current keyboard event.
  58425. * @return {number}
  58426. */
  58427. static GetTypeFromCharacter(keyCode: number): number;
  58428. }
  58429. }
  58430. declare module "babylonjs/Events/index" {
  58431. export * from "babylonjs/Events/keyboardEvents";
  58432. export * from "babylonjs/Events/pointerEvents";
  58433. export * from "babylonjs/Events/clipboardEvents";
  58434. }
  58435. declare module "babylonjs/Gamepads/Controllers/daydreamController" {
  58436. import { Scene } from "babylonjs/scene";
  58437. import { AbstractMesh } from "babylonjs/Meshes/abstractMesh";
  58438. import { GamepadButtonChanges } from "babylonjs/Gamepads/gamepad";
  58439. import { WebVRController } from "babylonjs/Gamepads/Controllers/webVRController";
  58440. import { ExtendedGamepadButton } from "babylonjs/Gamepads/Controllers/poseEnabledController";
  58441. /**
  58442. * Google Daydream controller
  58443. */
  58444. export class DaydreamController extends WebVRController {
  58445. /**
  58446. * Base Url for the controller model.
  58447. */
  58448. static MODEL_BASE_URL: string;
  58449. /**
  58450. * File name for the controller model.
  58451. */
  58452. static MODEL_FILENAME: string;
  58453. /**
  58454. * Gamepad Id prefix used to identify Daydream Controller.
  58455. */
  58456. static readonly GAMEPAD_ID_PREFIX: string;
  58457. /**
  58458. * Creates a new DaydreamController from a gamepad
  58459. * @param vrGamepad the gamepad that the controller should be created from
  58460. */
  58461. constructor(vrGamepad: any);
  58462. /**
  58463. * Implements abstract method on WebVRController class, loading controller meshes and calling this.attachToMesh if successful.
  58464. * @param scene scene in which to add meshes
  58465. * @param meshLoaded optional callback function that will be called if the mesh loads successfully.
  58466. */
  58467. initControllerMesh(scene: Scene, meshLoaded?: (mesh: AbstractMesh) => void): void;
  58468. /**
  58469. * Called once for each button that changed state since the last frame
  58470. * @param buttonIdx Which button index changed
  58471. * @param state New state of the button
  58472. * @param changes Which properties on the state changed since last frame
  58473. */
  58474. protected _handleButtonChange(buttonIdx: number, state: ExtendedGamepadButton, changes: GamepadButtonChanges): void;
  58475. }
  58476. }
  58477. declare module "babylonjs/Gamepads/Controllers/gearVRController" {
  58478. import { Scene } from "babylonjs/scene";
  58479. import { AbstractMesh } from "babylonjs/Meshes/abstractMesh";
  58480. import { GamepadButtonChanges } from "babylonjs/Gamepads/gamepad";
  58481. import { WebVRController } from "babylonjs/Gamepads/Controllers/webVRController";
  58482. import { ExtendedGamepadButton } from "babylonjs/Gamepads/Controllers/poseEnabledController";
  58483. /**
  58484. * Gear VR Controller
  58485. */
  58486. export class GearVRController extends WebVRController {
  58487. /**
  58488. * Base Url for the controller model.
  58489. */
  58490. static MODEL_BASE_URL: string;
  58491. /**
  58492. * File name for the controller model.
  58493. */
  58494. static MODEL_FILENAME: string;
  58495. /**
  58496. * Gamepad Id prefix used to identify this controller.
  58497. */
  58498. static readonly GAMEPAD_ID_PREFIX: string;
  58499. private readonly _buttonIndexToObservableNameMap;
  58500. /**
  58501. * Creates a new GearVRController from a gamepad
  58502. * @param vrGamepad the gamepad that the controller should be created from
  58503. */
  58504. constructor(vrGamepad: any);
  58505. /**
  58506. * Implements abstract method on WebVRController class, loading controller meshes and calling this.attachToMesh if successful.
  58507. * @param scene scene in which to add meshes
  58508. * @param meshLoaded optional callback function that will be called if the mesh loads successfully.
  58509. */
  58510. initControllerMesh(scene: Scene, meshLoaded?: (mesh: AbstractMesh) => void): void;
  58511. /**
  58512. * Called once for each button that changed state since the last frame
  58513. * @param buttonIdx Which button index changed
  58514. * @param state New state of the button
  58515. * @param changes Which properties on the state changed since last frame
  58516. */
  58517. protected _handleButtonChange(buttonIdx: number, state: ExtendedGamepadButton, changes: GamepadButtonChanges): void;
  58518. }
  58519. }
  58520. declare module "babylonjs/Gamepads/Controllers/genericController" {
  58521. import { Scene } from "babylonjs/scene";
  58522. import { AbstractMesh } from "babylonjs/Meshes/abstractMesh";
  58523. import { WebVRController } from "babylonjs/Gamepads/Controllers/webVRController";
  58524. import { ExtendedGamepadButton } from "babylonjs/Gamepads/Controllers/poseEnabledController";
  58525. import { GamepadButtonChanges } from "babylonjs/Gamepads/gamepad";
  58526. /**
  58527. * Generic Controller
  58528. */
  58529. export class GenericController extends WebVRController {
  58530. /**
  58531. * Base Url for the controller model.
  58532. */
  58533. static readonly MODEL_BASE_URL: string;
  58534. /**
  58535. * File name for the controller model.
  58536. */
  58537. static readonly MODEL_FILENAME: string;
  58538. /**
  58539. * Creates a new GenericController from a gamepad
  58540. * @param vrGamepad the gamepad that the controller should be created from
  58541. */
  58542. constructor(vrGamepad: any);
  58543. /**
  58544. * Implements abstract method on WebVRController class, loading controller meshes and calling this.attachToMesh if successful.
  58545. * @param scene scene in which to add meshes
  58546. * @param meshLoaded optional callback function that will be called if the mesh loads successfully.
  58547. */
  58548. initControllerMesh(scene: Scene, meshLoaded?: (mesh: AbstractMesh) => void): void;
  58549. /**
  58550. * Called once for each button that changed state since the last frame
  58551. * @param buttonIdx Which button index changed
  58552. * @param state New state of the button
  58553. * @param changes Which properties on the state changed since last frame
  58554. */
  58555. protected _handleButtonChange(buttonIdx: number, state: ExtendedGamepadButton, changes: GamepadButtonChanges): void;
  58556. }
  58557. }
  58558. declare module "babylonjs/Gamepads/Controllers/oculusTouchController" {
  58559. import { Observable } from "babylonjs/Misc/observable";
  58560. import { Scene } from "babylonjs/scene";
  58561. import { AbstractMesh } from "babylonjs/Meshes/abstractMesh";
  58562. import { WebVRController } from "babylonjs/Gamepads/Controllers/webVRController";
  58563. import { ExtendedGamepadButton } from "babylonjs/Gamepads/Controllers/poseEnabledController";
  58564. import { GamepadButtonChanges } from "babylonjs/Gamepads/gamepad";
  58565. /**
  58566. * Oculus Touch Controller
  58567. */
  58568. export class OculusTouchController extends WebVRController {
  58569. /**
  58570. * Base Url for the controller model.
  58571. */
  58572. static MODEL_BASE_URL: string;
  58573. /**
  58574. * File name for the left controller model.
  58575. */
  58576. static MODEL_LEFT_FILENAME: string;
  58577. /**
  58578. * File name for the right controller model.
  58579. */
  58580. static MODEL_RIGHT_FILENAME: string;
  58581. /**
  58582. * Base Url for the Quest controller model.
  58583. */
  58584. static QUEST_MODEL_BASE_URL: string;
  58585. /**
  58586. * @hidden
  58587. * If the controllers are running on a device that needs the updated Quest controller models
  58588. */
  58589. static _IsQuest: boolean;
  58590. /**
  58591. * Fired when the secondary trigger on this controller is modified
  58592. */
  58593. onSecondaryTriggerStateChangedObservable: Observable<ExtendedGamepadButton>;
  58594. /**
  58595. * Fired when the thumb rest on this controller is modified
  58596. */
  58597. onThumbRestChangedObservable: Observable<ExtendedGamepadButton>;
  58598. /**
  58599. * Creates a new OculusTouchController from a gamepad
  58600. * @param vrGamepad the gamepad that the controller should be created from
  58601. */
  58602. constructor(vrGamepad: any);
  58603. /**
  58604. * Implements abstract method on WebVRController class, loading controller meshes and calling this.attachToMesh if successful.
  58605. * @param scene scene in which to add meshes
  58606. * @param meshLoaded optional callback function that will be called if the mesh loads successfully.
  58607. */
  58608. initControllerMesh(scene: Scene, meshLoaded?: (mesh: AbstractMesh) => void): void;
  58609. /**
  58610. * Fired when the A button on this controller is modified
  58611. */
  58612. get onAButtonStateChangedObservable(): Observable<ExtendedGamepadButton>;
  58613. /**
  58614. * Fired when the B button on this controller is modified
  58615. */
  58616. get onBButtonStateChangedObservable(): Observable<ExtendedGamepadButton>;
  58617. /**
  58618. * Fired when the X button on this controller is modified
  58619. */
  58620. get onXButtonStateChangedObservable(): Observable<ExtendedGamepadButton>;
  58621. /**
  58622. * Fired when the Y button on this controller is modified
  58623. */
  58624. get onYButtonStateChangedObservable(): Observable<ExtendedGamepadButton>;
  58625. /**
  58626. * Called once for each button that changed state since the last frame
  58627. * 0) thumb stick (touch, press, value = pressed (0,1)). value is in this.leftStick
  58628. * 1) index trigger (touch (?), press (only when value > 0.1), value 0 to 1)
  58629. * 2) secondary trigger (same)
  58630. * 3) A (right) X (left), touch, pressed = value
  58631. * 4) B / Y
  58632. * 5) thumb rest
  58633. * @param buttonIdx Which button index changed
  58634. * @param state New state of the button
  58635. * @param changes Which properties on the state changed since last frame
  58636. */
  58637. protected _handleButtonChange(buttonIdx: number, state: ExtendedGamepadButton, changes: GamepadButtonChanges): void;
  58638. }
  58639. }
  58640. declare module "babylonjs/Gamepads/Controllers/viveController" {
  58641. import { Scene } from "babylonjs/scene";
  58642. import { AbstractMesh } from "babylonjs/Meshes/abstractMesh";
  58643. import { WebVRController } from "babylonjs/Gamepads/Controllers/webVRController";
  58644. import { ExtendedGamepadButton } from "babylonjs/Gamepads/Controllers/poseEnabledController";
  58645. import { GamepadButtonChanges } from "babylonjs/Gamepads/gamepad";
  58646. import { Observable } from "babylonjs/Misc/observable";
  58647. /**
  58648. * Vive Controller
  58649. */
  58650. export class ViveController extends WebVRController {
  58651. /**
  58652. * Base Url for the controller model.
  58653. */
  58654. static MODEL_BASE_URL: string;
  58655. /**
  58656. * File name for the controller model.
  58657. */
  58658. static MODEL_FILENAME: string;
  58659. /**
  58660. * Creates a new ViveController from a gamepad
  58661. * @param vrGamepad the gamepad that the controller should be created from
  58662. */
  58663. constructor(vrGamepad: any);
  58664. /**
  58665. * Implements abstract method on WebVRController class, loading controller meshes and calling this.attachToMesh if successful.
  58666. * @param scene scene in which to add meshes
  58667. * @param meshLoaded optional callback function that will be called if the mesh loads successfully.
  58668. */
  58669. initControllerMesh(scene: Scene, meshLoaded?: (mesh: AbstractMesh) => void): void;
  58670. /**
  58671. * Fired when the left button on this controller is modified
  58672. */
  58673. get onLeftButtonStateChangedObservable(): Observable<ExtendedGamepadButton>;
  58674. /**
  58675. * Fired when the right button on this controller is modified
  58676. */
  58677. get onRightButtonStateChangedObservable(): Observable<ExtendedGamepadButton>;
  58678. /**
  58679. * Fired when the menu button on this controller is modified
  58680. */
  58681. get onMenuButtonStateChangedObservable(): Observable<ExtendedGamepadButton>;
  58682. /**
  58683. * Called once for each button that changed state since the last frame
  58684. * Vive mapping:
  58685. * 0: touchpad
  58686. * 1: trigger
  58687. * 2: left AND right buttons
  58688. * 3: menu button
  58689. * @param buttonIdx Which button index changed
  58690. * @param state New state of the button
  58691. * @param changes Which properties on the state changed since last frame
  58692. */
  58693. protected _handleButtonChange(buttonIdx: number, state: ExtendedGamepadButton, changes: GamepadButtonChanges): void;
  58694. }
  58695. }
  58696. declare module "babylonjs/Gamepads/Controllers/windowsMotionController" {
  58697. import { Observable } from "babylonjs/Misc/observable";
  58698. import { Scene } from "babylonjs/scene";
  58699. import { AbstractMesh } from "babylonjs/Meshes/abstractMesh";
  58700. import { Ray } from "babylonjs/Culling/ray";
  58701. import { WebVRController } from "babylonjs/Gamepads/Controllers/webVRController";
  58702. import { ExtendedGamepadButton } from "babylonjs/Gamepads/Controllers/poseEnabledController";
  58703. import { StickValues, GamepadButtonChanges } from "babylonjs/Gamepads/gamepad";
  58704. /**
  58705. * Defines the WindowsMotionController object that the state of the windows motion controller
  58706. */
  58707. export class WindowsMotionController extends WebVRController {
  58708. /**
  58709. * The base url used to load the left and right controller models
  58710. */
  58711. static MODEL_BASE_URL: string;
  58712. /**
  58713. * The name of the left controller model file
  58714. */
  58715. static MODEL_LEFT_FILENAME: string;
  58716. /**
  58717. * The name of the right controller model file
  58718. */
  58719. static MODEL_RIGHT_FILENAME: string;
  58720. /**
  58721. * The controller name prefix for this controller type
  58722. */
  58723. static readonly GAMEPAD_ID_PREFIX: string;
  58724. /**
  58725. * The controller id pattern for this controller type
  58726. */
  58727. private static readonly GAMEPAD_ID_PATTERN;
  58728. private _loadedMeshInfo;
  58729. protected readonly _mapping: {
  58730. buttons: string[];
  58731. buttonMeshNames: {
  58732. trigger: string;
  58733. menu: string;
  58734. grip: string;
  58735. thumbstick: string;
  58736. trackpad: string;
  58737. };
  58738. buttonObservableNames: {
  58739. trigger: string;
  58740. menu: string;
  58741. grip: string;
  58742. thumbstick: string;
  58743. trackpad: string;
  58744. };
  58745. axisMeshNames: string[];
  58746. pointingPoseMeshName: string;
  58747. };
  58748. /**
  58749. * Fired when the trackpad on this controller is clicked
  58750. */
  58751. onTrackpadChangedObservable: Observable<ExtendedGamepadButton>;
  58752. /**
  58753. * Fired when the trackpad on this controller is modified
  58754. */
  58755. onTrackpadValuesChangedObservable: Observable<StickValues>;
  58756. /**
  58757. * The current x and y values of this controller's trackpad
  58758. */
  58759. trackpad: StickValues;
  58760. /**
  58761. * Creates a new WindowsMotionController from a gamepad
  58762. * @param vrGamepad the gamepad that the controller should be created from
  58763. */
  58764. constructor(vrGamepad: any);
  58765. /**
  58766. * Fired when the trigger on this controller is modified
  58767. */
  58768. get onTriggerButtonStateChangedObservable(): Observable<ExtendedGamepadButton>;
  58769. /**
  58770. * Fired when the menu button on this controller is modified
  58771. */
  58772. get onMenuButtonStateChangedObservable(): Observable<ExtendedGamepadButton>;
  58773. /**
  58774. * Fired when the grip button on this controller is modified
  58775. */
  58776. get onGripButtonStateChangedObservable(): Observable<ExtendedGamepadButton>;
  58777. /**
  58778. * Fired when the thumbstick button on this controller is modified
  58779. */
  58780. get onThumbstickButtonStateChangedObservable(): Observable<ExtendedGamepadButton>;
  58781. /**
  58782. * Fired when the touchpad button on this controller is modified
  58783. */
  58784. get onTouchpadButtonStateChangedObservable(): Observable<ExtendedGamepadButton>;
  58785. /**
  58786. * Fired when the touchpad values on this controller are modified
  58787. */
  58788. get onTouchpadValuesChangedObservable(): Observable<StickValues>;
  58789. protected _updateTrackpad(): void;
  58790. /**
  58791. * Called once per frame by the engine.
  58792. */
  58793. update(): void;
  58794. /**
  58795. * Called once for each button that changed state since the last frame
  58796. * @param buttonIdx Which button index changed
  58797. * @param state New state of the button
  58798. * @param changes Which properties on the state changed since last frame
  58799. */
  58800. protected _handleButtonChange(buttonIdx: number, state: ExtendedGamepadButton, changes: GamepadButtonChanges): void;
  58801. /**
  58802. * Moves the buttons on the controller mesh based on their current state
  58803. * @param buttonName the name of the button to move
  58804. * @param buttonValue the value of the button which determines the buttons new position
  58805. */
  58806. protected _lerpButtonTransform(buttonName: string, buttonValue: number): void;
  58807. /**
  58808. * Moves the axis on the controller mesh based on its current state
  58809. * @param axis the index of the axis
  58810. * @param axisValue the value of the axis which determines the meshes new position
  58811. * @hidden
  58812. */
  58813. protected _lerpAxisTransform(axis: number, axisValue: number): void;
  58814. /**
  58815. * Implements abstract method on WebVRController class, loading controller meshes and calling this.attachToMesh if successful.
  58816. * @param scene scene in which to add meshes
  58817. * @param meshLoaded optional callback function that will be called if the mesh loads successfully.
  58818. */
  58819. initControllerMesh(scene: Scene, meshLoaded?: (mesh: AbstractMesh) => void, forceDefault?: boolean): void;
  58820. /**
  58821. * Takes a list of meshes (as loaded from the glTF file) and finds the root node, as well as nodes that
  58822. * can be transformed by button presses and axes values, based on this._mapping.
  58823. *
  58824. * @param scene scene in which the meshes exist
  58825. * @param meshes list of meshes that make up the controller model to process
  58826. * @return structured view of the given meshes, with mapping of buttons and axes to meshes that can be transformed.
  58827. */
  58828. private processModel;
  58829. private createMeshInfo;
  58830. /**
  58831. * Gets the ray of the controller in the direction the controller is pointing
  58832. * @param length the length the resulting ray should be
  58833. * @returns a ray in the direction the controller is pointing
  58834. */
  58835. getForwardRay(length?: number): Ray;
  58836. /**
  58837. * Disposes of the controller
  58838. */
  58839. dispose(): void;
  58840. }
  58841. /**
  58842. * This class represents a new windows motion controller in XR.
  58843. */
  58844. export class XRWindowsMotionController extends WindowsMotionController {
  58845. /**
  58846. * Changing the original WIndowsMotionController mapping to fir the new mapping
  58847. */
  58848. protected readonly _mapping: {
  58849. buttons: string[];
  58850. buttonMeshNames: {
  58851. trigger: string;
  58852. menu: string;
  58853. grip: string;
  58854. thumbstick: string;
  58855. trackpad: string;
  58856. };
  58857. buttonObservableNames: {
  58858. trigger: string;
  58859. menu: string;
  58860. grip: string;
  58861. thumbstick: string;
  58862. trackpad: string;
  58863. };
  58864. axisMeshNames: string[];
  58865. pointingPoseMeshName: string;
  58866. };
  58867. /**
  58868. * Construct a new XR-Based windows motion controller
  58869. *
  58870. * @param gamepadInfo the gamepad object from the browser
  58871. */
  58872. constructor(gamepadInfo: any);
  58873. /**
  58874. * holds the thumbstick values (X,Y)
  58875. */
  58876. thumbstickValues: StickValues;
  58877. /**
  58878. * Fired when the thumbstick on this controller is clicked
  58879. */
  58880. onThumbstickStateChangedObservable: Observable<ExtendedGamepadButton>;
  58881. /**
  58882. * Fired when the thumbstick on this controller is modified
  58883. */
  58884. onThumbstickValuesChangedObservable: Observable<StickValues>;
  58885. /**
  58886. * Fired when the touchpad button on this controller is modified
  58887. */
  58888. onTrackpadChangedObservable: Observable<ExtendedGamepadButton>;
  58889. /**
  58890. * Fired when the touchpad values on this controller are modified
  58891. */
  58892. onTrackpadValuesChangedObservable: Observable<StickValues>;
  58893. /**
  58894. * Fired when the thumbstick button on this controller is modified
  58895. * here to prevent breaking changes
  58896. */
  58897. get onThumbstickButtonStateChangedObservable(): Observable<ExtendedGamepadButton>;
  58898. /**
  58899. * updating the thumbstick(!) and not the trackpad.
  58900. * This is named this way due to the difference between WebVR and XR and to avoid
  58901. * changing the parent class.
  58902. */
  58903. protected _updateTrackpad(): void;
  58904. /**
  58905. * Disposes the class with joy
  58906. */
  58907. dispose(): void;
  58908. }
  58909. }
  58910. declare module "babylonjs/Gamepads/Controllers/index" {
  58911. export * from "babylonjs/Gamepads/Controllers/daydreamController";
  58912. export * from "babylonjs/Gamepads/Controllers/gearVRController";
  58913. export * from "babylonjs/Gamepads/Controllers/genericController";
  58914. export * from "babylonjs/Gamepads/Controllers/oculusTouchController";
  58915. export * from "babylonjs/Gamepads/Controllers/poseEnabledController";
  58916. export * from "babylonjs/Gamepads/Controllers/viveController";
  58917. export * from "babylonjs/Gamepads/Controllers/webVRController";
  58918. export * from "babylonjs/Gamepads/Controllers/windowsMotionController";
  58919. }
  58920. declare module "babylonjs/Gamepads/index" {
  58921. export * from "babylonjs/Gamepads/Controllers/index";
  58922. export * from "babylonjs/Gamepads/gamepad";
  58923. export * from "babylonjs/Gamepads/gamepadManager";
  58924. export * from "babylonjs/Gamepads/gamepadSceneComponent";
  58925. export * from "babylonjs/Gamepads/xboxGamepad";
  58926. export * from "babylonjs/Gamepads/dualShockGamepad";
  58927. }
  58928. declare module "babylonjs/Meshes/Builders/polyhedronBuilder" {
  58929. import { Scene } from "babylonjs/scene";
  58930. import { Vector4 } from "babylonjs/Maths/math.vector";
  58931. import { Color4 } from "babylonjs/Maths/math.color";
  58932. import { Mesh } from "babylonjs/Meshes/mesh";
  58933. import { Nullable } from "babylonjs/types";
  58934. /**
  58935. * Class containing static functions to help procedurally build meshes
  58936. */
  58937. export class PolyhedronBuilder {
  58938. /**
  58939. * Creates a polyhedron mesh
  58940. * * 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
  58941. * * The parameter `size` (positive float, default 1) sets the polygon size
  58942. * * You can overwrite the `size` on each dimension bu using the parameters `sizeX`, `sizeY` or `sizeZ` (positive floats, default to `size` value)
  58943. * * 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`
  58944. * * 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
  58945. * * 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)`)
  58946. * * 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
  58947. * * 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
  58948. * * You can also set the mesh side orientation with the values : BABYLON.Mesh.FRONTSIDE (default), BABYLON.Mesh.BACKSIDE or BABYLON.Mesh.DOUBLESIDE
  58949. * * If you create a double-sided mesh, you can choose what parts of the texture image to crop and stick respectively on the front and the back sides with the parameters `frontUVs` and `backUVs` (Vector4). Detail here : https://doc.babylonjs.com/babylon101/discover_basic_elements#side-orientation
  58950. * * The mesh can be set to updatable with the boolean parameter `updatable` (default false) if its internal geometry is supposed to change once created
  58951. * @param name defines the name of the mesh
  58952. * @param options defines the options used to create the mesh
  58953. * @param scene defines the hosting scene
  58954. * @returns the polyhedron mesh
  58955. * @see https://doc.babylonjs.com/how_to/polyhedra_shapes
  58956. */
  58957. static CreatePolyhedron(name: string, options: {
  58958. type?: number;
  58959. size?: number;
  58960. sizeX?: number;
  58961. sizeY?: number;
  58962. sizeZ?: number;
  58963. custom?: any;
  58964. faceUV?: Vector4[];
  58965. faceColors?: Color4[];
  58966. flat?: boolean;
  58967. updatable?: boolean;
  58968. sideOrientation?: number;
  58969. frontUVs?: Vector4;
  58970. backUVs?: Vector4;
  58971. }, scene?: Nullable<Scene>): Mesh;
  58972. }
  58973. }
  58974. declare module "babylonjs/Gizmos/scaleGizmo" {
  58975. import { Observable } from "babylonjs/Misc/observable";
  58976. import { Nullable } from "babylonjs/types";
  58977. import { AbstractMesh } from "babylonjs/Meshes/abstractMesh";
  58978. import { Gizmo } from "babylonjs/Gizmos/gizmo";
  58979. import { AxisScaleGizmo } from "babylonjs/Gizmos/axisScaleGizmo";
  58980. import { UtilityLayerRenderer } from "babylonjs/Rendering/utilityLayerRenderer";
  58981. import { Node } from "babylonjs/node";
  58982. /**
  58983. * Gizmo that enables scaling a mesh along 3 axis
  58984. */
  58985. export class ScaleGizmo extends Gizmo {
  58986. /**
  58987. * Internal gizmo used for interactions on the x axis
  58988. */
  58989. xGizmo: AxisScaleGizmo;
  58990. /**
  58991. * Internal gizmo used for interactions on the y axis
  58992. */
  58993. yGizmo: AxisScaleGizmo;
  58994. /**
  58995. * Internal gizmo used for interactions on the z axis
  58996. */
  58997. zGizmo: AxisScaleGizmo;
  58998. /**
  58999. * Internal gizmo used to scale all axis equally
  59000. */
  59001. uniformScaleGizmo: AxisScaleGizmo;
  59002. private _meshAttached;
  59003. private _nodeAttached;
  59004. private _snapDistance;
  59005. private _uniformScalingMesh;
  59006. private _octahedron;
  59007. private _sensitivity;
  59008. /** Fires an event when any of it's sub gizmos are dragged */
  59009. onDragStartObservable: Observable<unknown>;
  59010. /** Fires an event when any of it's sub gizmos are released from dragging */
  59011. onDragEndObservable: Observable<unknown>;
  59012. get attachedMesh(): Nullable<AbstractMesh>;
  59013. set attachedMesh(mesh: Nullable<AbstractMesh>);
  59014. get attachedNode(): Nullable<Node>;
  59015. set attachedNode(node: Nullable<Node>);
  59016. /**
  59017. * True when the mouse pointer is hovering a gizmo mesh
  59018. */
  59019. get isHovered(): boolean;
  59020. /**
  59021. * Creates a ScaleGizmo
  59022. * @param gizmoLayer The utility layer the gizmo will be added to
  59023. * @param thickness display gizmo axis thickness
  59024. */
  59025. constructor(gizmoLayer?: UtilityLayerRenderer, thickness?: number);
  59026. set updateGizmoRotationToMatchAttachedMesh(value: boolean);
  59027. get updateGizmoRotationToMatchAttachedMesh(): boolean;
  59028. /**
  59029. * Drag distance in babylon units that the gizmo will snap to when dragged (Default: 0)
  59030. */
  59031. set snapDistance(value: number);
  59032. get snapDistance(): number;
  59033. /**
  59034. * Ratio for the scale of the gizmo (Default: 1)
  59035. */
  59036. set scaleRatio(value: number);
  59037. get scaleRatio(): number;
  59038. /**
  59039. * Sensitivity factor for dragging (Default: 1)
  59040. */
  59041. set sensitivity(value: number);
  59042. get sensitivity(): number;
  59043. /**
  59044. * Disposes of the gizmo
  59045. */
  59046. dispose(): void;
  59047. }
  59048. }
  59049. declare module "babylonjs/Gizmos/axisScaleGizmo" {
  59050. import { Observable } from "babylonjs/Misc/observable";
  59051. import { Nullable } from "babylonjs/types";
  59052. import { Vector3 } from "babylonjs/Maths/math.vector";
  59053. import { Node } from "babylonjs/node";
  59054. import { Mesh } from "babylonjs/Meshes/mesh";
  59055. import { PointerDragBehavior } from "babylonjs/Behaviors/Meshes/pointerDragBehavior";
  59056. import { Gizmo } from "babylonjs/Gizmos/gizmo";
  59057. import { UtilityLayerRenderer } from "babylonjs/Rendering/utilityLayerRenderer";
  59058. import { ScaleGizmo } from "babylonjs/Gizmos/scaleGizmo";
  59059. import { Color3 } from "babylonjs/Maths/math.color";
  59060. /**
  59061. * Single axis scale gizmo
  59062. */
  59063. export class AxisScaleGizmo extends Gizmo {
  59064. /**
  59065. * Drag behavior responsible for the gizmos dragging interactions
  59066. */
  59067. dragBehavior: PointerDragBehavior;
  59068. private _pointerObserver;
  59069. /**
  59070. * Scale distance in babylon units that the gizmo will snap to when dragged (Default: 0)
  59071. */
  59072. snapDistance: number;
  59073. /**
  59074. * Event that fires each time the gizmo snaps to a new location.
  59075. * * snapDistance is the the change in distance
  59076. */
  59077. onSnapObservable: Observable<{
  59078. snapDistance: number;
  59079. }>;
  59080. /**
  59081. * If the scaling operation should be done on all axis (default: false)
  59082. */
  59083. uniformScaling: boolean;
  59084. /**
  59085. * Custom sensitivity value for the drag strength
  59086. */
  59087. sensitivity: number;
  59088. private _isEnabled;
  59089. private _parent;
  59090. private _arrow;
  59091. private _coloredMaterial;
  59092. private _hoverMaterial;
  59093. /**
  59094. * Creates an AxisScaleGizmo
  59095. * @param gizmoLayer The utility layer the gizmo will be added to
  59096. * @param dragAxis The axis which the gizmo will be able to scale on
  59097. * @param color The color of the gizmo
  59098. * @param thickness display gizmo axis thickness
  59099. */
  59100. constructor(dragAxis: Vector3, color?: Color3, gizmoLayer?: UtilityLayerRenderer, parent?: Nullable<ScaleGizmo>, thickness?: number);
  59101. protected _attachedNodeChanged(value: Nullable<Node>): void;
  59102. /**
  59103. * If the gizmo is enabled
  59104. */
  59105. set isEnabled(value: boolean);
  59106. get isEnabled(): boolean;
  59107. /**
  59108. * Disposes of the gizmo
  59109. */
  59110. dispose(): void;
  59111. /**
  59112. * Disposes and replaces the current meshes in the gizmo with the specified mesh
  59113. * @param mesh The mesh to replace the default mesh of the gizmo
  59114. * @param useGizmoMaterial If the gizmo's default material should be used (default: false)
  59115. */
  59116. setCustomMesh(mesh: Mesh, useGizmoMaterial?: boolean): void;
  59117. }
  59118. }
  59119. declare module "babylonjs/Gizmos/boundingBoxGizmo" {
  59120. import { Observable } from "babylonjs/Misc/observable";
  59121. import { Nullable } from "babylonjs/types";
  59122. import { Vector3 } from "babylonjs/Maths/math.vector";
  59123. import { AbstractMesh } from "babylonjs/Meshes/abstractMesh";
  59124. import { Mesh } from "babylonjs/Meshes/mesh";
  59125. import { Gizmo } from "babylonjs/Gizmos/gizmo";
  59126. import { UtilityLayerRenderer } from "babylonjs/Rendering/utilityLayerRenderer";
  59127. import { Color3 } from "babylonjs/Maths/math.color";
  59128. import "babylonjs/Meshes/Builders/boxBuilder";
  59129. /**
  59130. * Bounding box gizmo
  59131. */
  59132. export class BoundingBoxGizmo extends Gizmo {
  59133. private _lineBoundingBox;
  59134. private _rotateSpheresParent;
  59135. private _scaleBoxesParent;
  59136. private _boundingDimensions;
  59137. private _renderObserver;
  59138. private _pointerObserver;
  59139. private _scaleDragSpeed;
  59140. private _tmpQuaternion;
  59141. private _tmpVector;
  59142. private _tmpRotationMatrix;
  59143. /**
  59144. * 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)
  59145. */
  59146. ignoreChildren: boolean;
  59147. /**
  59148. * 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)
  59149. */
  59150. includeChildPredicate: Nullable<(abstractMesh: AbstractMesh) => boolean>;
  59151. /**
  59152. * The size of the rotation spheres attached to the bounding box (Default: 0.1)
  59153. */
  59154. rotationSphereSize: number;
  59155. /**
  59156. * The size of the scale boxes attached to the bounding box (Default: 0.1)
  59157. */
  59158. scaleBoxSize: number;
  59159. /**
  59160. * 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)
  59161. */
  59162. fixedDragMeshScreenSize: boolean;
  59163. /**
  59164. * The distance away from the object which the draggable meshes should appear world sized when fixedDragMeshScreenSize is set to true (default: 10)
  59165. */
  59166. fixedDragMeshScreenSizeDistanceFactor: number;
  59167. /**
  59168. * Fired when a rotation sphere or scale box is dragged
  59169. */
  59170. onDragStartObservable: Observable<{}>;
  59171. /**
  59172. * Fired when a scale box is dragged
  59173. */
  59174. onScaleBoxDragObservable: Observable<{}>;
  59175. /**
  59176. * Fired when a scale box drag is ended
  59177. */
  59178. onScaleBoxDragEndObservable: Observable<{}>;
  59179. /**
  59180. * Fired when a rotation sphere is dragged
  59181. */
  59182. onRotationSphereDragObservable: Observable<{}>;
  59183. /**
  59184. * Fired when a rotation sphere drag is ended
  59185. */
  59186. onRotationSphereDragEndObservable: Observable<{}>;
  59187. /**
  59188. * 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)
  59189. */
  59190. scalePivot: Nullable<Vector3>;
  59191. /**
  59192. * Mesh used as a pivot to rotate the attached node
  59193. */
  59194. private _anchorMesh;
  59195. private _existingMeshScale;
  59196. private _dragMesh;
  59197. private pointerDragBehavior;
  59198. private coloredMaterial;
  59199. private hoverColoredMaterial;
  59200. /**
  59201. * Sets the color of the bounding box gizmo
  59202. * @param color the color to set
  59203. */
  59204. setColor(color: Color3): void;
  59205. /**
  59206. * Creates an BoundingBoxGizmo
  59207. * @param gizmoLayer The utility layer the gizmo will be added to
  59208. * @param color The color of the gizmo
  59209. */
  59210. constructor(color?: Color3, gizmoLayer?: UtilityLayerRenderer);
  59211. protected _attachedNodeChanged(value: Nullable<AbstractMesh>): void;
  59212. private _selectNode;
  59213. /**
  59214. * Updates the bounding box information for the Gizmo
  59215. */
  59216. updateBoundingBox(): void;
  59217. private _updateRotationSpheres;
  59218. private _updateScaleBoxes;
  59219. /**
  59220. * Enables rotation on the specified axis and disables rotation on the others
  59221. * @param axis The list of axis that should be enabled (eg. "xy" or "xyz")
  59222. */
  59223. setEnabledRotationAxis(axis: string): void;
  59224. /**
  59225. * Enables/disables scaling
  59226. * @param enable if scaling should be enabled
  59227. * @param homogeneousScaling defines if scaling should only be homogeneous
  59228. */
  59229. setEnabledScaling(enable: boolean, homogeneousScaling?: boolean): void;
  59230. private _updateDummy;
  59231. /**
  59232. * Enables a pointer drag behavior on the bounding box of the gizmo
  59233. */
  59234. enableDragBehavior(): void;
  59235. /**
  59236. * Disposes of the gizmo
  59237. */
  59238. dispose(): void;
  59239. /**
  59240. * 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)
  59241. * @param mesh the mesh to wrap in the bounding box mesh and make not pickable
  59242. * @returns the bounding box mesh with the passed in mesh as a child
  59243. */
  59244. static MakeNotPickableAndWrapInBoundingBox(mesh: Mesh): Mesh;
  59245. /**
  59246. * CustomMeshes are not supported by this gizmo
  59247. * @param mesh The mesh to replace the default mesh of the gizmo
  59248. */
  59249. setCustomMesh(mesh: Mesh): void;
  59250. }
  59251. }
  59252. declare module "babylonjs/Gizmos/planeRotationGizmo" {
  59253. import { Observable } from "babylonjs/Misc/observable";
  59254. import { Nullable } from "babylonjs/types";
  59255. import { Vector3 } from "babylonjs/Maths/math.vector";
  59256. import { Color3 } from "babylonjs/Maths/math.color";
  59257. import { Node } from "babylonjs/node";
  59258. import { PointerDragBehavior } from "babylonjs/Behaviors/Meshes/pointerDragBehavior";
  59259. import { Gizmo } from "babylonjs/Gizmos/gizmo";
  59260. import { UtilityLayerRenderer } from "babylonjs/Rendering/utilityLayerRenderer";
  59261. import "babylonjs/Meshes/Builders/linesBuilder";
  59262. import { RotationGizmo } from "babylonjs/Gizmos/rotationGizmo";
  59263. /**
  59264. * Single plane rotation gizmo
  59265. */
  59266. export class PlaneRotationGizmo extends Gizmo {
  59267. /**
  59268. * Drag behavior responsible for the gizmos dragging interactions
  59269. */
  59270. dragBehavior: PointerDragBehavior;
  59271. private _pointerObserver;
  59272. /**
  59273. * Rotation distance in radians that the gizmo will snap to (Default: 0)
  59274. */
  59275. snapDistance: number;
  59276. /**
  59277. * Event that fires each time the gizmo snaps to a new location.
  59278. * * snapDistance is the the change in distance
  59279. */
  59280. onSnapObservable: Observable<{
  59281. snapDistance: number;
  59282. }>;
  59283. private _isEnabled;
  59284. private _parent;
  59285. /**
  59286. * Creates a PlaneRotationGizmo
  59287. * @param gizmoLayer The utility layer the gizmo will be added to
  59288. * @param planeNormal The normal of the plane which the gizmo will be able to rotate on
  59289. * @param color The color of the gizmo
  59290. * @param tessellation Amount of tessellation to be used when creating rotation circles
  59291. * @param useEulerRotation Use and update Euler angle instead of quaternion
  59292. * @param thickness display gizmo axis thickness
  59293. */
  59294. constructor(planeNormal: Vector3, color?: Color3, gizmoLayer?: UtilityLayerRenderer, tessellation?: number, parent?: Nullable<RotationGizmo>, useEulerRotation?: boolean, thickness?: number);
  59295. protected _attachedNodeChanged(value: Nullable<Node>): void;
  59296. /**
  59297. * If the gizmo is enabled
  59298. */
  59299. set isEnabled(value: boolean);
  59300. get isEnabled(): boolean;
  59301. /**
  59302. * Disposes of the gizmo
  59303. */
  59304. dispose(): void;
  59305. }
  59306. }
  59307. declare module "babylonjs/Gizmos/rotationGizmo" {
  59308. import { Observable } from "babylonjs/Misc/observable";
  59309. import { Nullable } from "babylonjs/types";
  59310. import { AbstractMesh } from "babylonjs/Meshes/abstractMesh";
  59311. import { Mesh } from "babylonjs/Meshes/mesh";
  59312. import { Gizmo } from "babylonjs/Gizmos/gizmo";
  59313. import { PlaneRotationGizmo } from "babylonjs/Gizmos/planeRotationGizmo";
  59314. import { UtilityLayerRenderer } from "babylonjs/Rendering/utilityLayerRenderer";
  59315. import { Node } from "babylonjs/node";
  59316. /**
  59317. * Gizmo that enables rotating a mesh along 3 axis
  59318. */
  59319. export class RotationGizmo extends Gizmo {
  59320. /**
  59321. * Internal gizmo used for interactions on the x axis
  59322. */
  59323. xGizmo: PlaneRotationGizmo;
  59324. /**
  59325. * Internal gizmo used for interactions on the y axis
  59326. */
  59327. yGizmo: PlaneRotationGizmo;
  59328. /**
  59329. * Internal gizmo used for interactions on the z axis
  59330. */
  59331. zGizmo: PlaneRotationGizmo;
  59332. /** Fires an event when any of it's sub gizmos are dragged */
  59333. onDragStartObservable: Observable<unknown>;
  59334. /** Fires an event when any of it's sub gizmos are released from dragging */
  59335. onDragEndObservable: Observable<unknown>;
  59336. private _meshAttached;
  59337. private _nodeAttached;
  59338. get attachedMesh(): Nullable<AbstractMesh>;
  59339. set attachedMesh(mesh: Nullable<AbstractMesh>);
  59340. get attachedNode(): Nullable<Node>;
  59341. set attachedNode(node: Nullable<Node>);
  59342. protected _checkBillboardTransform(): void;
  59343. /**
  59344. * True when the mouse pointer is hovering a gizmo mesh
  59345. */
  59346. get isHovered(): boolean;
  59347. /**
  59348. * Creates a RotationGizmo
  59349. * @param gizmoLayer The utility layer the gizmo will be added to
  59350. * @param tessellation Amount of tessellation to be used when creating rotation circles
  59351. * @param useEulerRotation Use and update Euler angle instead of quaternion
  59352. * @param thickness display gizmo axis thickness
  59353. */
  59354. constructor(gizmoLayer?: UtilityLayerRenderer, tessellation?: number, useEulerRotation?: boolean, thickness?: number);
  59355. set updateGizmoRotationToMatchAttachedMesh(value: boolean);
  59356. get updateGizmoRotationToMatchAttachedMesh(): boolean;
  59357. /**
  59358. * Drag distance in babylon units that the gizmo will snap to when dragged (Default: 0)
  59359. */
  59360. set snapDistance(value: number);
  59361. get snapDistance(): number;
  59362. /**
  59363. * Ratio for the scale of the gizmo (Default: 1)
  59364. */
  59365. set scaleRatio(value: number);
  59366. get scaleRatio(): number;
  59367. /**
  59368. * Disposes of the gizmo
  59369. */
  59370. dispose(): void;
  59371. /**
  59372. * CustomMeshes are not supported by this gizmo
  59373. * @param mesh The mesh to replace the default mesh of the gizmo
  59374. */
  59375. setCustomMesh(mesh: Mesh): void;
  59376. }
  59377. }
  59378. declare module "babylonjs/Gizmos/gizmoManager" {
  59379. import { Observable } from "babylonjs/Misc/observable";
  59380. import { Nullable } from "babylonjs/types";
  59381. import { Scene, IDisposable } from "babylonjs/scene";
  59382. import { Node } from "babylonjs/node";
  59383. import { AbstractMesh } from "babylonjs/Meshes/abstractMesh";
  59384. import { UtilityLayerRenderer } from "babylonjs/Rendering/utilityLayerRenderer";
  59385. import { SixDofDragBehavior } from "babylonjs/Behaviors/Meshes/sixDofDragBehavior";
  59386. import { RotationGizmo } from "babylonjs/Gizmos/rotationGizmo";
  59387. import { PositionGizmo } from "babylonjs/Gizmos/positionGizmo";
  59388. import { ScaleGizmo } from "babylonjs/Gizmos/scaleGizmo";
  59389. import { BoundingBoxGizmo } from "babylonjs/Gizmos/boundingBoxGizmo";
  59390. /**
  59391. * Helps setup gizmo's in the scene to rotate/scale/position nodes
  59392. */
  59393. export class GizmoManager implements IDisposable {
  59394. private scene;
  59395. /**
  59396. * Gizmo's created by the gizmo manager, gizmo will be null until gizmo has been enabled for the first time
  59397. */
  59398. gizmos: {
  59399. positionGizmo: Nullable<PositionGizmo>;
  59400. rotationGizmo: Nullable<RotationGizmo>;
  59401. scaleGizmo: Nullable<ScaleGizmo>;
  59402. boundingBoxGizmo: Nullable<BoundingBoxGizmo>;
  59403. };
  59404. /** When true, the gizmo will be detached from the current object when a pointer down occurs with an empty picked mesh */
  59405. clearGizmoOnEmptyPointerEvent: boolean;
  59406. /** Fires an event when the manager is attached to a mesh */
  59407. onAttachedToMeshObservable: Observable<Nullable<AbstractMesh>>;
  59408. /** Fires an event when the manager is attached to a node */
  59409. onAttachedToNodeObservable: Observable<Nullable<Node>>;
  59410. private _gizmosEnabled;
  59411. private _pointerObserver;
  59412. private _attachedMesh;
  59413. private _attachedNode;
  59414. private _boundingBoxColor;
  59415. private _defaultUtilityLayer;
  59416. private _defaultKeepDepthUtilityLayer;
  59417. private _thickness;
  59418. /**
  59419. * When bounding box gizmo is enabled, this can be used to track drag/end events
  59420. */
  59421. boundingBoxDragBehavior: SixDofDragBehavior;
  59422. /**
  59423. * Array of meshes which will have the gizmo attached when a pointer selected them. If null, all meshes are attachable. (Default: null)
  59424. */
  59425. attachableMeshes: Nullable<Array<AbstractMesh>>;
  59426. /**
  59427. * Array of nodes which will have the gizmo attached when a pointer selected them. If null, all nodes are attachable. (Default: null)
  59428. */
  59429. attachableNodes: Nullable<Array<Node>>;
  59430. /**
  59431. * If pointer events should perform attaching/detaching a gizmo, if false this can be done manually via attachToMesh/attachToNode. (Default: true)
  59432. */
  59433. usePointerToAttachGizmos: boolean;
  59434. /**
  59435. * Utility layer that the bounding box gizmo belongs to
  59436. */
  59437. get keepDepthUtilityLayer(): UtilityLayerRenderer;
  59438. /**
  59439. * Utility layer that all gizmos besides bounding box belong to
  59440. */
  59441. get utilityLayer(): UtilityLayerRenderer;
  59442. /**
  59443. * True when the mouse pointer is hovering a gizmo mesh
  59444. */
  59445. get isHovered(): boolean;
  59446. /**
  59447. * Instatiates a gizmo manager
  59448. * @param scene the scene to overlay the gizmos on top of
  59449. * @param thickness display gizmo axis thickness
  59450. */
  59451. constructor(scene: Scene, thickness?: number);
  59452. /**
  59453. * Attaches a set of gizmos to the specified mesh
  59454. * @param mesh The mesh the gizmo's should be attached to
  59455. */
  59456. attachToMesh(mesh: Nullable<AbstractMesh>): void;
  59457. /**
  59458. * Attaches a set of gizmos to the specified node
  59459. * @param node The node the gizmo's should be attached to
  59460. */
  59461. attachToNode(node: Nullable<Node>): void;
  59462. /**
  59463. * If the position gizmo is enabled
  59464. */
  59465. set positionGizmoEnabled(value: boolean);
  59466. get positionGizmoEnabled(): boolean;
  59467. /**
  59468. * If the rotation gizmo is enabled
  59469. */
  59470. set rotationGizmoEnabled(value: boolean);
  59471. get rotationGizmoEnabled(): boolean;
  59472. /**
  59473. * If the scale gizmo is enabled
  59474. */
  59475. set scaleGizmoEnabled(value: boolean);
  59476. get scaleGizmoEnabled(): boolean;
  59477. /**
  59478. * If the boundingBox gizmo is enabled
  59479. */
  59480. set boundingBoxGizmoEnabled(value: boolean);
  59481. get boundingBoxGizmoEnabled(): boolean;
  59482. /**
  59483. * Disposes of the gizmo manager
  59484. */
  59485. dispose(): void;
  59486. }
  59487. }
  59488. declare module "babylonjs/Lights/directionalLight" {
  59489. import { Camera } from "babylonjs/Cameras/camera";
  59490. import { Scene } from "babylonjs/scene";
  59491. import { Matrix, Vector3 } from "babylonjs/Maths/math.vector";
  59492. import { AbstractMesh } from "babylonjs/Meshes/abstractMesh";
  59493. import { Light } from "babylonjs/Lights/light";
  59494. import { ShadowLight } from "babylonjs/Lights/shadowLight";
  59495. import { Effect } from "babylonjs/Materials/effect";
  59496. /**
  59497. * A directional light is defined by a direction (what a surprise!).
  59498. * The light is emitted from everywhere in the specified direction, and has an infinite range.
  59499. * 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.
  59500. * Documentation: https://doc.babylonjs.com/babylon101/lights
  59501. */
  59502. export class DirectionalLight extends ShadowLight {
  59503. private _shadowFrustumSize;
  59504. /**
  59505. * Fix frustum size for the shadow generation. This is disabled if the value is 0.
  59506. */
  59507. get shadowFrustumSize(): number;
  59508. /**
  59509. * Specifies a fix frustum size for the shadow generation.
  59510. */
  59511. set shadowFrustumSize(value: number);
  59512. private _shadowOrthoScale;
  59513. /**
  59514. * Gets the shadow projection scale against the optimal computed one.
  59515. * 0.1 by default which means that the projection window is increase by 10% from the optimal size.
  59516. * This does not impact in fixed frustum size (shadowFrustumSize being set)
  59517. */
  59518. get shadowOrthoScale(): number;
  59519. /**
  59520. * Sets the shadow projection scale against the optimal computed one.
  59521. * 0.1 by default which means that the projection window is increase by 10% from the optimal size.
  59522. * This does not impact in fixed frustum size (shadowFrustumSize being set)
  59523. */
  59524. set shadowOrthoScale(value: number);
  59525. /**
  59526. * Automatically compute the projection matrix to best fit (including all the casters)
  59527. * on each frame.
  59528. */
  59529. autoUpdateExtends: boolean;
  59530. /**
  59531. * Automatically compute the shadowMinZ and shadowMaxZ for the projection matrix to best fit (including all the casters)
  59532. * on each frame. autoUpdateExtends must be set to true for this to work
  59533. */
  59534. autoCalcShadowZBounds: boolean;
  59535. private _orthoLeft;
  59536. private _orthoRight;
  59537. private _orthoTop;
  59538. private _orthoBottom;
  59539. /**
  59540. * Creates a DirectionalLight object in the scene, oriented towards the passed direction (Vector3).
  59541. * The directional light is emitted from everywhere in the given direction.
  59542. * It can cast shadows.
  59543. * Documentation : https://doc.babylonjs.com/babylon101/lights
  59544. * @param name The friendly name of the light
  59545. * @param direction The direction of the light
  59546. * @param scene The scene the light belongs to
  59547. */
  59548. constructor(name: string, direction: Vector3, scene: Scene);
  59549. /**
  59550. * Returns the string "DirectionalLight".
  59551. * @return The class name
  59552. */
  59553. getClassName(): string;
  59554. /**
  59555. * Returns the integer 1.
  59556. * @return The light Type id as a constant defines in Light.LIGHTTYPEID_x
  59557. */
  59558. getTypeID(): number;
  59559. /**
  59560. * Sets the passed matrix "matrix" as projection matrix for the shadows cast by the light according to the passed view matrix.
  59561. * Returns the DirectionalLight Shadow projection matrix.
  59562. */
  59563. protected _setDefaultShadowProjectionMatrix(matrix: Matrix, viewMatrix: Matrix, renderList: Array<AbstractMesh>): void;
  59564. /**
  59565. * Sets the passed matrix "matrix" as fixed frustum projection matrix for the shadows cast by the light according to the passed view matrix.
  59566. * Returns the DirectionalLight Shadow projection matrix.
  59567. */
  59568. protected _setDefaultFixedFrustumShadowProjectionMatrix(matrix: Matrix): void;
  59569. /**
  59570. * Sets the passed matrix "matrix" as auto extend projection matrix for the shadows cast by the light according to the passed view matrix.
  59571. * Returns the DirectionalLight Shadow projection matrix.
  59572. */
  59573. protected _setDefaultAutoExtendShadowProjectionMatrix(matrix: Matrix, viewMatrix: Matrix, renderList: Array<AbstractMesh>): void;
  59574. protected _buildUniformLayout(): void;
  59575. /**
  59576. * Sets the passed Effect object with the DirectionalLight transformed position (or position if not parented) and the passed name.
  59577. * @param effect The effect to update
  59578. * @param lightIndex The index of the light in the effect to update
  59579. * @returns The directional light
  59580. */
  59581. transferToEffect(effect: Effect, lightIndex: string): DirectionalLight;
  59582. transferToNodeMaterialEffect(effect: Effect, lightDataUniformName: string): Light;
  59583. /**
  59584. * Gets the minZ used for shadow according to both the scene and the light.
  59585. *
  59586. * Values are fixed on directional lights as it relies on an ortho projection hence the need to convert being
  59587. * -1 and 1 to 0 and 1 doing (depth + min) / (min + max) -> (depth + 1) / (1 + 1) -> (depth * 0.5) + 0.5.
  59588. * @param activeCamera The camera we are returning the min for
  59589. * @returns the depth min z
  59590. */
  59591. getDepthMinZ(activeCamera: Camera): number;
  59592. /**
  59593. * Gets the maxZ used for shadow according to both the scene and the light.
  59594. *
  59595. * Values are fixed on directional lights as it relies on an ortho projection hence the need to convert being
  59596. * -1 and 1 to 0 and 1 doing (depth + min) / (min + max) -> (depth + 1) / (1 + 1) -> (depth * 0.5) + 0.5.
  59597. * @param activeCamera The camera we are returning the max for
  59598. * @returns the depth max z
  59599. */
  59600. getDepthMaxZ(activeCamera: Camera): number;
  59601. /**
  59602. * Prepares the list of defines specific to the light type.
  59603. * @param defines the list of defines
  59604. * @param lightIndex defines the index of the light for the effect
  59605. */
  59606. prepareLightSpecificDefines(defines: any, lightIndex: number): void;
  59607. }
  59608. }
  59609. declare module "babylonjs/Meshes/Builders/hemisphereBuilder" {
  59610. import { Mesh } from "babylonjs/Meshes/mesh";
  59611. /**
  59612. * Class containing static functions to help procedurally build meshes
  59613. */
  59614. export class HemisphereBuilder {
  59615. /**
  59616. * Creates a hemisphere mesh
  59617. * @param name defines the name of the mesh
  59618. * @param options defines the options used to create the mesh
  59619. * @param scene defines the hosting scene
  59620. * @returns the hemisphere mesh
  59621. */
  59622. static CreateHemisphere(name: string, options: {
  59623. segments?: number;
  59624. diameter?: number;
  59625. sideOrientation?: number;
  59626. }, scene: any): Mesh;
  59627. }
  59628. }
  59629. declare module "babylonjs/Lights/spotLight" {
  59630. import { Nullable } from "babylonjs/types";
  59631. import { Scene } from "babylonjs/scene";
  59632. import { Matrix, Vector3 } from "babylonjs/Maths/math.vector";
  59633. import { AbstractMesh } from "babylonjs/Meshes/abstractMesh";
  59634. import { Effect } from "babylonjs/Materials/effect";
  59635. import { BaseTexture } from "babylonjs/Materials/Textures/baseTexture";
  59636. import { Light } from "babylonjs/Lights/light";
  59637. import { ShadowLight } from "babylonjs/Lights/shadowLight";
  59638. /**
  59639. * A spot light is defined by a position, a direction, an angle, and an exponent.
  59640. * These values define a cone of light starting from the position, emitting toward the direction.
  59641. * The angle, in radians, defines the size (field of illumination) of the spotlight's conical beam,
  59642. * and the exponent defines the speed of the decay of the light with distance (reach).
  59643. * Documentation: https://doc.babylonjs.com/babylon101/lights
  59644. */
  59645. export class SpotLight extends ShadowLight {
  59646. private _angle;
  59647. private _innerAngle;
  59648. private _cosHalfAngle;
  59649. private _lightAngleScale;
  59650. private _lightAngleOffset;
  59651. /**
  59652. * Gets the cone angle of the spot light in Radians.
  59653. */
  59654. get angle(): number;
  59655. /**
  59656. * Sets the cone angle of the spot light in Radians.
  59657. */
  59658. set angle(value: number);
  59659. /**
  59660. * Only used in gltf falloff mode, this defines the angle where
  59661. * the directional falloff will start before cutting at angle which could be seen
  59662. * as outer angle.
  59663. */
  59664. get innerAngle(): number;
  59665. /**
  59666. * Only used in gltf falloff mode, this defines the angle where
  59667. * the directional falloff will start before cutting at angle which could be seen
  59668. * as outer angle.
  59669. */
  59670. set innerAngle(value: number);
  59671. private _shadowAngleScale;
  59672. /**
  59673. * Allows scaling the angle of the light for shadow generation only.
  59674. */
  59675. get shadowAngleScale(): number;
  59676. /**
  59677. * Allows scaling the angle of the light for shadow generation only.
  59678. */
  59679. set shadowAngleScale(value: number);
  59680. /**
  59681. * The light decay speed with the distance from the emission spot.
  59682. */
  59683. exponent: number;
  59684. private _projectionTextureMatrix;
  59685. /**
  59686. * Allows reading the projecton texture
  59687. */
  59688. get projectionTextureMatrix(): Matrix;
  59689. protected _projectionTextureLightNear: number;
  59690. /**
  59691. * Gets the near clip of the Spotlight for texture projection.
  59692. */
  59693. get projectionTextureLightNear(): number;
  59694. /**
  59695. * Sets the near clip of the Spotlight for texture projection.
  59696. */
  59697. set projectionTextureLightNear(value: number);
  59698. protected _projectionTextureLightFar: number;
  59699. /**
  59700. * Gets the far clip of the Spotlight for texture projection.
  59701. */
  59702. get projectionTextureLightFar(): number;
  59703. /**
  59704. * Sets the far clip of the Spotlight for texture projection.
  59705. */
  59706. set projectionTextureLightFar(value: number);
  59707. protected _projectionTextureUpDirection: Vector3;
  59708. /**
  59709. * Gets the Up vector of the Spotlight for texture projection.
  59710. */
  59711. get projectionTextureUpDirection(): Vector3;
  59712. /**
  59713. * Sets the Up vector of the Spotlight for texture projection.
  59714. */
  59715. set projectionTextureUpDirection(value: Vector3);
  59716. private _projectionTexture;
  59717. /**
  59718. * Gets the projection texture of the light.
  59719. */
  59720. get projectionTexture(): Nullable<BaseTexture>;
  59721. /**
  59722. * Sets the projection texture of the light.
  59723. */
  59724. set projectionTexture(value: Nullable<BaseTexture>);
  59725. private _projectionTextureViewLightDirty;
  59726. private _projectionTextureProjectionLightDirty;
  59727. private _projectionTextureDirty;
  59728. private _projectionTextureViewTargetVector;
  59729. private _projectionTextureViewLightMatrix;
  59730. private _projectionTextureProjectionLightMatrix;
  59731. private _projectionTextureScalingMatrix;
  59732. /**
  59733. * Creates a SpotLight object in the scene. A spot light is a simply light oriented cone.
  59734. * It can cast shadows.
  59735. * Documentation : https://doc.babylonjs.com/babylon101/lights
  59736. * @param name The light friendly name
  59737. * @param position The position of the spot light in the scene
  59738. * @param direction The direction of the light in the scene
  59739. * @param angle The cone angle of the light in Radians
  59740. * @param exponent The light decay speed with the distance from the emission spot
  59741. * @param scene The scene the lights belongs to
  59742. */
  59743. constructor(name: string, position: Vector3, direction: Vector3, angle: number, exponent: number, scene: Scene);
  59744. /**
  59745. * Returns the string "SpotLight".
  59746. * @returns the class name
  59747. */
  59748. getClassName(): string;
  59749. /**
  59750. * Returns the integer 2.
  59751. * @returns The light Type id as a constant defines in Light.LIGHTTYPEID_x
  59752. */
  59753. getTypeID(): number;
  59754. /**
  59755. * Overrides the direction setter to recompute the projection texture view light Matrix.
  59756. */
  59757. protected _setDirection(value: Vector3): void;
  59758. /**
  59759. * Overrides the position setter to recompute the projection texture view light Matrix.
  59760. */
  59761. protected _setPosition(value: Vector3): void;
  59762. /**
  59763. * 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.
  59764. * Returns the SpotLight.
  59765. */
  59766. protected _setDefaultShadowProjectionMatrix(matrix: Matrix, viewMatrix: Matrix, renderList: Array<AbstractMesh>): void;
  59767. protected _computeProjectionTextureViewLightMatrix(): void;
  59768. protected _computeProjectionTextureProjectionLightMatrix(): void;
  59769. /**
  59770. * Main function for light texture projection matrix computing.
  59771. */
  59772. protected _computeProjectionTextureMatrix(): void;
  59773. protected _buildUniformLayout(): void;
  59774. private _computeAngleValues;
  59775. /**
  59776. * Sets the passed Effect "effect" with the Light textures.
  59777. * @param effect The effect to update
  59778. * @param lightIndex The index of the light in the effect to update
  59779. * @returns The light
  59780. */
  59781. transferTexturesToEffect(effect: Effect, lightIndex: string): Light;
  59782. /**
  59783. * Sets the passed Effect object with the SpotLight transfomed position (or position if not parented) and normalized direction.
  59784. * @param effect The effect to update
  59785. * @param lightIndex The index of the light in the effect to update
  59786. * @returns The spot light
  59787. */
  59788. transferToEffect(effect: Effect, lightIndex: string): SpotLight;
  59789. transferToNodeMaterialEffect(effect: Effect, lightDataUniformName: string): this;
  59790. /**
  59791. * Disposes the light and the associated resources.
  59792. */
  59793. dispose(): void;
  59794. /**
  59795. * Prepares the list of defines specific to the light type.
  59796. * @param defines the list of defines
  59797. * @param lightIndex defines the index of the light for the effect
  59798. */
  59799. prepareLightSpecificDefines(defines: any, lightIndex: number): void;
  59800. }
  59801. }
  59802. declare module "babylonjs/Gizmos/lightGizmo" {
  59803. import { Nullable } from "babylonjs/types";
  59804. import { Gizmo } from "babylonjs/Gizmos/gizmo";
  59805. import { UtilityLayerRenderer } from "babylonjs/Rendering/utilityLayerRenderer";
  59806. import { StandardMaterial } from "babylonjs/Materials/standardMaterial";
  59807. import { Light } from "babylonjs/Lights/light";
  59808. import { Observable } from "babylonjs/Misc/observable";
  59809. /**
  59810. * Gizmo that enables viewing a light
  59811. */
  59812. export class LightGizmo extends Gizmo {
  59813. private _lightMesh;
  59814. private _material;
  59815. private _cachedPosition;
  59816. private _cachedForward;
  59817. private _attachedMeshParent;
  59818. private _pointerObserver;
  59819. /**
  59820. * Event that fires each time the gizmo is clicked
  59821. */
  59822. onClickedObservable: Observable<Light>;
  59823. /**
  59824. * Creates a LightGizmo
  59825. * @param gizmoLayer The utility layer the gizmo will be added to
  59826. */
  59827. constructor(gizmoLayer?: UtilityLayerRenderer);
  59828. private _light;
  59829. /**
  59830. * The light that the gizmo is attached to
  59831. */
  59832. set light(light: Nullable<Light>);
  59833. get light(): Nullable<Light>;
  59834. /**
  59835. * Gets the material used to render the light gizmo
  59836. */
  59837. get material(): StandardMaterial;
  59838. /**
  59839. * @hidden
  59840. * Updates the gizmo to match the attached mesh's position/rotation
  59841. */
  59842. protected _update(): void;
  59843. private static _Scale;
  59844. /**
  59845. * Creates the lines for a light mesh
  59846. */
  59847. private static _CreateLightLines;
  59848. /**
  59849. * Disposes of the light gizmo
  59850. */
  59851. dispose(): void;
  59852. private static _CreateHemisphericLightMesh;
  59853. private static _CreatePointLightMesh;
  59854. private static _CreateSpotLightMesh;
  59855. private static _CreateDirectionalLightMesh;
  59856. }
  59857. }
  59858. declare module "babylonjs/Gizmos/cameraGizmo" {
  59859. import { Nullable } from "babylonjs/types";
  59860. import { Gizmo } from "babylonjs/Gizmos/gizmo";
  59861. import { UtilityLayerRenderer } from "babylonjs/Rendering/utilityLayerRenderer";
  59862. import { StandardMaterial } from "babylonjs/Materials/standardMaterial";
  59863. import { Camera } from "babylonjs/Cameras/camera";
  59864. import { Observable } from "babylonjs/Misc/observable";
  59865. /**
  59866. * Gizmo that enables viewing a camera
  59867. */
  59868. export class CameraGizmo extends Gizmo {
  59869. private _cameraMesh;
  59870. private _cameraLinesMesh;
  59871. private _material;
  59872. private _pointerObserver;
  59873. /**
  59874. * Event that fires each time the gizmo is clicked
  59875. */
  59876. onClickedObservable: Observable<Camera>;
  59877. /**
  59878. * Creates a CameraGizmo
  59879. * @param gizmoLayer The utility layer the gizmo will be added to
  59880. */
  59881. constructor(gizmoLayer?: UtilityLayerRenderer);
  59882. private _camera;
  59883. /** Gets or sets a boolean indicating if frustum lines must be rendered (true by default)) */
  59884. get displayFrustum(): boolean;
  59885. set displayFrustum(value: boolean);
  59886. /**
  59887. * The camera that the gizmo is attached to
  59888. */
  59889. set camera(camera: Nullable<Camera>);
  59890. get camera(): Nullable<Camera>;
  59891. /**
  59892. * Gets the material used to render the camera gizmo
  59893. */
  59894. get material(): StandardMaterial;
  59895. /**
  59896. * @hidden
  59897. * Updates the gizmo to match the attached mesh's position/rotation
  59898. */
  59899. protected _update(): void;
  59900. private static _Scale;
  59901. private _invProjection;
  59902. /**
  59903. * Disposes of the camera gizmo
  59904. */
  59905. dispose(): void;
  59906. private static _CreateCameraMesh;
  59907. private static _CreateCameraFrustum;
  59908. }
  59909. }
  59910. declare module "babylonjs/Gizmos/index" {
  59911. export * from "babylonjs/Gizmos/axisDragGizmo";
  59912. export * from "babylonjs/Gizmos/axisScaleGizmo";
  59913. export * from "babylonjs/Gizmos/boundingBoxGizmo";
  59914. export * from "babylonjs/Gizmos/gizmo";
  59915. export * from "babylonjs/Gizmos/gizmoManager";
  59916. export * from "babylonjs/Gizmos/planeRotationGizmo";
  59917. export * from "babylonjs/Gizmos/positionGizmo";
  59918. export * from "babylonjs/Gizmos/rotationGizmo";
  59919. export * from "babylonjs/Gizmos/scaleGizmo";
  59920. export * from "babylonjs/Gizmos/lightGizmo";
  59921. export * from "babylonjs/Gizmos/cameraGizmo";
  59922. export * from "babylonjs/Gizmos/planeDragGizmo";
  59923. }
  59924. declare module "babylonjs/Shaders/ShadersInclude/backgroundFragmentDeclaration" {
  59925. /** @hidden */
  59926. export var backgroundFragmentDeclaration: {
  59927. name: string;
  59928. shader: string;
  59929. };
  59930. }
  59931. declare module "babylonjs/Shaders/ShadersInclude/backgroundUboDeclaration" {
  59932. /** @hidden */
  59933. export var backgroundUboDeclaration: {
  59934. name: string;
  59935. shader: string;
  59936. };
  59937. }
  59938. declare module "babylonjs/Shaders/background.fragment" {
  59939. import "babylonjs/Shaders/ShadersInclude/backgroundFragmentDeclaration";
  59940. import "babylonjs/Shaders/ShadersInclude/backgroundUboDeclaration";
  59941. import "babylonjs/Shaders/ShadersInclude/reflectionFunction";
  59942. import "babylonjs/Shaders/ShadersInclude/imageProcessingDeclaration";
  59943. import "babylonjs/Shaders/ShadersInclude/lightFragmentDeclaration";
  59944. import "babylonjs/Shaders/ShadersInclude/lightUboDeclaration";
  59945. import "babylonjs/Shaders/ShadersInclude/helperFunctions";
  59946. import "babylonjs/Shaders/ShadersInclude/lightsFragmentFunctions";
  59947. import "babylonjs/Shaders/ShadersInclude/shadowsFragmentFunctions";
  59948. import "babylonjs/Shaders/ShadersInclude/imageProcessingFunctions";
  59949. import "babylonjs/Shaders/ShadersInclude/clipPlaneFragmentDeclaration";
  59950. import "babylonjs/Shaders/ShadersInclude/fogFragmentDeclaration";
  59951. import "babylonjs/Shaders/ShadersInclude/clipPlaneFragment";
  59952. import "babylonjs/Shaders/ShadersInclude/lightFragment";
  59953. import "babylonjs/Shaders/ShadersInclude/fogFragment";
  59954. /** @hidden */
  59955. export var backgroundPixelShader: {
  59956. name: string;
  59957. shader: string;
  59958. };
  59959. }
  59960. declare module "babylonjs/Shaders/ShadersInclude/backgroundVertexDeclaration" {
  59961. /** @hidden */
  59962. export var backgroundVertexDeclaration: {
  59963. name: string;
  59964. shader: string;
  59965. };
  59966. }
  59967. declare module "babylonjs/Shaders/background.vertex" {
  59968. import "babylonjs/Shaders/ShadersInclude/backgroundVertexDeclaration";
  59969. import "babylonjs/Shaders/ShadersInclude/backgroundUboDeclaration";
  59970. import "babylonjs/Shaders/ShadersInclude/helperFunctions";
  59971. import "babylonjs/Shaders/ShadersInclude/bonesDeclaration";
  59972. import "babylonjs/Shaders/ShadersInclude/instancesDeclaration";
  59973. import "babylonjs/Shaders/ShadersInclude/clipPlaneVertexDeclaration";
  59974. import "babylonjs/Shaders/ShadersInclude/fogVertexDeclaration";
  59975. import "babylonjs/Shaders/ShadersInclude/lightFragmentDeclaration";
  59976. import "babylonjs/Shaders/ShadersInclude/lightUboDeclaration";
  59977. import "babylonjs/Shaders/ShadersInclude/instancesVertex";
  59978. import "babylonjs/Shaders/ShadersInclude/bonesVertex";
  59979. import "babylonjs/Shaders/ShadersInclude/clipPlaneVertex";
  59980. import "babylonjs/Shaders/ShadersInclude/fogVertex";
  59981. import "babylonjs/Shaders/ShadersInclude/shadowsVertex";
  59982. /** @hidden */
  59983. export var backgroundVertexShader: {
  59984. name: string;
  59985. shader: string;
  59986. };
  59987. }
  59988. declare module "babylonjs/Materials/Background/backgroundMaterial" {
  59989. import { Nullable, int, float } from "babylonjs/types";
  59990. import { Scene } from "babylonjs/scene";
  59991. import { Matrix, Vector3 } from "babylonjs/Maths/math.vector";
  59992. import { SubMesh } from "babylonjs/Meshes/subMesh";
  59993. import { AbstractMesh } from "babylonjs/Meshes/abstractMesh";
  59994. import { Mesh } from "babylonjs/Meshes/mesh";
  59995. import { PushMaterial } from "babylonjs/Materials/pushMaterial";
  59996. import { ColorCurves } from "babylonjs/Materials/colorCurves";
  59997. import { ImageProcessingConfiguration } from "babylonjs/Materials/imageProcessingConfiguration";
  59998. import { BaseTexture } from "babylonjs/Materials/Textures/baseTexture";
  59999. import { IShadowLight } from "babylonjs/Lights/shadowLight";
  60000. import { Color3 } from "babylonjs/Maths/math.color";
  60001. import "babylonjs/Shaders/background.fragment";
  60002. import "babylonjs/Shaders/background.vertex";
  60003. /**
  60004. * Background material used to create an efficient environement around your scene.
  60005. */
  60006. export class BackgroundMaterial extends PushMaterial {
  60007. /**
  60008. * Standard reflectance value at parallel view angle.
  60009. */
  60010. static StandardReflectance0: number;
  60011. /**
  60012. * Standard reflectance value at grazing angle.
  60013. */
  60014. static StandardReflectance90: number;
  60015. protected _primaryColor: Color3;
  60016. /**
  60017. * Key light Color (multiply against the environement texture)
  60018. */
  60019. primaryColor: Color3;
  60020. protected __perceptualColor: Nullable<Color3>;
  60021. /**
  60022. * Experimental Internal Use Only.
  60023. *
  60024. * Key light Color in "perceptual value" meaning the color you would like to see on screen.
  60025. * This acts as a helper to set the primary color to a more "human friendly" value.
  60026. * Conversion to linear space as well as exposure and tone mapping correction will be applied to keep the
  60027. * output color as close as possible from the chosen value.
  60028. * (This does not account for contrast color grading and color curves as they are considered post effect and not directly
  60029. * part of lighting setup.)
  60030. */
  60031. get _perceptualColor(): Nullable<Color3>;
  60032. set _perceptualColor(value: Nullable<Color3>);
  60033. protected _primaryColorShadowLevel: float;
  60034. /**
  60035. * Defines the level of the shadows (dark area of the reflection map) in order to help scaling the colors.
  60036. * The color opposite to the primary color is used at the level chosen to define what the black area would look.
  60037. */
  60038. get primaryColorShadowLevel(): float;
  60039. set primaryColorShadowLevel(value: float);
  60040. protected _primaryColorHighlightLevel: float;
  60041. /**
  60042. * Defines the level of the highliights (highlight area of the reflection map) in order to help scaling the colors.
  60043. * The primary color is used at the level chosen to define what the white area would look.
  60044. */
  60045. get primaryColorHighlightLevel(): float;
  60046. set primaryColorHighlightLevel(value: float);
  60047. protected _reflectionTexture: Nullable<BaseTexture>;
  60048. /**
  60049. * Reflection Texture used in the material.
  60050. * Should be author in a specific way for the best result (refer to the documentation).
  60051. */
  60052. reflectionTexture: Nullable<BaseTexture>;
  60053. protected _reflectionBlur: float;
  60054. /**
  60055. * Reflection Texture level of blur.
  60056. *
  60057. * Can be use to reuse an existing HDR Texture and target a specific LOD to prevent authoring the
  60058. * texture twice.
  60059. */
  60060. reflectionBlur: float;
  60061. protected _diffuseTexture: Nullable<BaseTexture>;
  60062. /**
  60063. * Diffuse Texture used in the material.
  60064. * Should be author in a specific way for the best result (refer to the documentation).
  60065. */
  60066. diffuseTexture: Nullable<BaseTexture>;
  60067. protected _shadowLights: Nullable<IShadowLight[]>;
  60068. /**
  60069. * Specify the list of lights casting shadow on the material.
  60070. * All scene shadow lights will be included if null.
  60071. */
  60072. shadowLights: Nullable<IShadowLight[]>;
  60073. protected _shadowLevel: float;
  60074. /**
  60075. * Helps adjusting the shadow to a softer level if required.
  60076. * 0 means black shadows and 1 means no shadows.
  60077. */
  60078. shadowLevel: float;
  60079. protected _sceneCenter: Vector3;
  60080. /**
  60081. * In case of opacity Fresnel or reflection falloff, this is use as a scene center.
  60082. * It is usually zero but might be interesting to modify according to your setup.
  60083. */
  60084. sceneCenter: Vector3;
  60085. protected _opacityFresnel: boolean;
  60086. /**
  60087. * This helps specifying that the material is falling off to the sky box at grazing angle.
  60088. * This helps ensuring a nice transition when the camera goes under the ground.
  60089. */
  60090. opacityFresnel: boolean;
  60091. protected _reflectionFresnel: boolean;
  60092. /**
  60093. * This helps specifying that the material is falling off from diffuse to the reflection texture at grazing angle.
  60094. * This helps adding a mirror texture on the ground.
  60095. */
  60096. reflectionFresnel: boolean;
  60097. protected _reflectionFalloffDistance: number;
  60098. /**
  60099. * This helps specifying the falloff radius off the reflection texture from the sceneCenter.
  60100. * This helps adding a nice falloff effect to the reflection if used as a mirror for instance.
  60101. */
  60102. reflectionFalloffDistance: number;
  60103. protected _reflectionAmount: number;
  60104. /**
  60105. * This specifies the weight of the reflection against the background in case of reflection Fresnel.
  60106. */
  60107. reflectionAmount: number;
  60108. protected _reflectionReflectance0: number;
  60109. /**
  60110. * This specifies the weight of the reflection at grazing angle.
  60111. */
  60112. reflectionReflectance0: number;
  60113. protected _reflectionReflectance90: number;
  60114. /**
  60115. * This specifies the weight of the reflection at a perpendicular point of view.
  60116. */
  60117. reflectionReflectance90: number;
  60118. /**
  60119. * Sets the reflection reflectance fresnel values according to the default standard
  60120. * empirically know to work well :-)
  60121. */
  60122. set reflectionStandardFresnelWeight(value: number);
  60123. protected _useRGBColor: boolean;
  60124. /**
  60125. * Helps to directly use the maps channels instead of their level.
  60126. */
  60127. useRGBColor: boolean;
  60128. protected _enableNoise: boolean;
  60129. /**
  60130. * This helps reducing the banding effect that could occur on the background.
  60131. */
  60132. enableNoise: boolean;
  60133. /**
  60134. * The current fov(field of view) multiplier, 0.0 - 2.0. Defaults to 1.0. Lower values "zoom in" and higher values "zoom out".
  60135. * Best used when trying to implement visual zoom effects like fish-eye or binoculars while not adjusting camera fov.
  60136. * Recommended to be keep at 1.0 except for special cases.
  60137. */
  60138. get fovMultiplier(): number;
  60139. set fovMultiplier(value: number);
  60140. private _fovMultiplier;
  60141. /**
  60142. * Enable the FOV adjustment feature controlled by fovMultiplier.
  60143. */
  60144. useEquirectangularFOV: boolean;
  60145. private _maxSimultaneousLights;
  60146. /**
  60147. * Number of Simultaneous lights allowed on the material.
  60148. */
  60149. maxSimultaneousLights: int;
  60150. private _shadowOnly;
  60151. /**
  60152. * Make the material only render shadows
  60153. */
  60154. shadowOnly: boolean;
  60155. /**
  60156. * Default configuration related to image processing available in the Background Material.
  60157. */
  60158. protected _imageProcessingConfiguration: ImageProcessingConfiguration;
  60159. /**
  60160. * Keep track of the image processing observer to allow dispose and replace.
  60161. */
  60162. private _imageProcessingObserver;
  60163. /**
  60164. * Attaches a new image processing configuration to the PBR Material.
  60165. * @param configuration (if null the scene configuration will be use)
  60166. */
  60167. protected _attachImageProcessingConfiguration(configuration: Nullable<ImageProcessingConfiguration>): void;
  60168. /**
  60169. * Gets the image processing configuration used either in this material.
  60170. */
  60171. get imageProcessingConfiguration(): Nullable<ImageProcessingConfiguration>;
  60172. /**
  60173. * Sets the Default image processing configuration used either in the this material.
  60174. *
  60175. * If sets to null, the scene one is in use.
  60176. */
  60177. set imageProcessingConfiguration(value: Nullable<ImageProcessingConfiguration>);
  60178. /**
  60179. * Gets wether the color curves effect is enabled.
  60180. */
  60181. get cameraColorCurvesEnabled(): boolean;
  60182. /**
  60183. * Sets wether the color curves effect is enabled.
  60184. */
  60185. set cameraColorCurvesEnabled(value: boolean);
  60186. /**
  60187. * Gets wether the color grading effect is enabled.
  60188. */
  60189. get cameraColorGradingEnabled(): boolean;
  60190. /**
  60191. * Gets wether the color grading effect is enabled.
  60192. */
  60193. set cameraColorGradingEnabled(value: boolean);
  60194. /**
  60195. * Gets wether tonemapping is enabled or not.
  60196. */
  60197. get cameraToneMappingEnabled(): boolean;
  60198. /**
  60199. * Sets wether tonemapping is enabled or not
  60200. */
  60201. set cameraToneMappingEnabled(value: boolean);
  60202. /**
  60203. * The camera exposure used on this material.
  60204. * This property is here and not in the camera to allow controlling exposure without full screen post process.
  60205. * This corresponds to a photographic exposure.
  60206. */
  60207. get cameraExposure(): float;
  60208. /**
  60209. * The camera exposure used on this material.
  60210. * This property is here and not in the camera to allow controlling exposure without full screen post process.
  60211. * This corresponds to a photographic exposure.
  60212. */
  60213. set cameraExposure(value: float);
  60214. /**
  60215. * Gets The camera contrast used on this material.
  60216. */
  60217. get cameraContrast(): float;
  60218. /**
  60219. * Sets The camera contrast used on this material.
  60220. */
  60221. set cameraContrast(value: float);
  60222. /**
  60223. * Gets the Color Grading 2D Lookup Texture.
  60224. */
  60225. get cameraColorGradingTexture(): Nullable<BaseTexture>;
  60226. /**
  60227. * Sets the Color Grading 2D Lookup Texture.
  60228. */
  60229. set cameraColorGradingTexture(value: Nullable<BaseTexture>);
  60230. /**
  60231. * The color grading curves provide additional color adjustmnent that is applied after any color grading transform (3D LUT).
  60232. * They allow basic adjustment of saturation and small exposure adjustments, along with color filter tinting to provide white balance adjustment or more stylistic effects.
  60233. * 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;
  60234. * corresponding to low luminance, medium luminance, and high luminance areas respectively.
  60235. */
  60236. get cameraColorCurves(): Nullable<ColorCurves>;
  60237. /**
  60238. * The color grading curves provide additional color adjustmnent that is applied after any color grading transform (3D LUT).
  60239. * They allow basic adjustment of saturation and small exposure adjustments, along with color filter tinting to provide white balance adjustment or more stylistic effects.
  60240. * 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;
  60241. * corresponding to low luminance, medium luminance, and high luminance areas respectively.
  60242. */
  60243. set cameraColorCurves(value: Nullable<ColorCurves>);
  60244. /**
  60245. * Due to a bug in iOS10, video tags (which are using the background material) are in BGR and not RGB.
  60246. * Setting this flag to true (not done automatically!) will convert it back to RGB.
  60247. */
  60248. switchToBGR: boolean;
  60249. private _renderTargets;
  60250. private _reflectionControls;
  60251. private _white;
  60252. private _primaryShadowColor;
  60253. private _primaryHighlightColor;
  60254. /**
  60255. * Instantiates a Background Material in the given scene
  60256. * @param name The friendly name of the material
  60257. * @param scene The scene to add the material to
  60258. */
  60259. constructor(name: string, scene: Scene);
  60260. /**
  60261. * Gets a boolean indicating that current material needs to register RTT
  60262. */
  60263. get hasRenderTargetTextures(): boolean;
  60264. /**
  60265. * The entire material has been created in order to prevent overdraw.
  60266. * @returns false
  60267. */
  60268. needAlphaTesting(): boolean;
  60269. /**
  60270. * The entire material has been created in order to prevent overdraw.
  60271. * @returns true if blending is enable
  60272. */
  60273. needAlphaBlending(): boolean;
  60274. /**
  60275. * Checks wether the material is ready to be rendered for a given mesh.
  60276. * @param mesh The mesh to render
  60277. * @param subMesh The submesh to check against
  60278. * @param useInstances Specify wether or not the material is used with instances
  60279. * @returns true if all the dependencies are ready (Textures, Effects...)
  60280. */
  60281. isReadyForSubMesh(mesh: AbstractMesh, subMesh: SubMesh, useInstances?: boolean): boolean;
  60282. /**
  60283. * Compute the primary color according to the chosen perceptual color.
  60284. */
  60285. private _computePrimaryColorFromPerceptualColor;
  60286. /**
  60287. * Compute the highlights and shadow colors according to their chosen levels.
  60288. */
  60289. private _computePrimaryColors;
  60290. /**
  60291. * Build the uniform buffer used in the material.
  60292. */
  60293. buildUniformLayout(): void;
  60294. /**
  60295. * Unbind the material.
  60296. */
  60297. unbind(): void;
  60298. /**
  60299. * Bind only the world matrix to the material.
  60300. * @param world The world matrix to bind.
  60301. */
  60302. bindOnlyWorldMatrix(world: Matrix): void;
  60303. /**
  60304. * Bind the material for a dedicated submeh (every used meshes will be considered opaque).
  60305. * @param world The world matrix to bind.
  60306. * @param subMesh The submesh to bind for.
  60307. */
  60308. bindForSubMesh(world: Matrix, mesh: Mesh, subMesh: SubMesh): void;
  60309. /**
  60310. * Checks to see if a texture is used in the material.
  60311. * @param texture - Base texture to use.
  60312. * @returns - Boolean specifying if a texture is used in the material.
  60313. */
  60314. hasTexture(texture: BaseTexture): boolean;
  60315. /**
  60316. * Dispose the material.
  60317. * @param forceDisposeEffect Force disposal of the associated effect.
  60318. * @param forceDisposeTextures Force disposal of the associated textures.
  60319. */
  60320. dispose(forceDisposeEffect?: boolean, forceDisposeTextures?: boolean): void;
  60321. /**
  60322. * Clones the material.
  60323. * @param name The cloned name.
  60324. * @returns The cloned material.
  60325. */
  60326. clone(name: string): BackgroundMaterial;
  60327. /**
  60328. * Serializes the current material to its JSON representation.
  60329. * @returns The JSON representation.
  60330. */
  60331. serialize(): any;
  60332. /**
  60333. * Gets the class name of the material
  60334. * @returns "BackgroundMaterial"
  60335. */
  60336. getClassName(): string;
  60337. /**
  60338. * Parse a JSON input to create back a background material.
  60339. * @param source The JSON data to parse
  60340. * @param scene The scene to create the parsed material in
  60341. * @param rootUrl The root url of the assets the material depends upon
  60342. * @returns the instantiated BackgroundMaterial.
  60343. */
  60344. static Parse(source: any, scene: Scene, rootUrl: string): BackgroundMaterial;
  60345. }
  60346. }
  60347. declare module "babylonjs/Helpers/environmentHelper" {
  60348. import { Observable } from "babylonjs/Misc/observable";
  60349. import { Nullable } from "babylonjs/types";
  60350. import { Scene } from "babylonjs/scene";
  60351. import { Vector3 } from "babylonjs/Maths/math.vector";
  60352. import { Color3 } from "babylonjs/Maths/math.color";
  60353. import { AbstractMesh } from "babylonjs/Meshes/abstractMesh";
  60354. import { Mesh } from "babylonjs/Meshes/mesh";
  60355. import { BaseTexture } from "babylonjs/Materials/Textures/baseTexture";
  60356. import { MirrorTexture } from "babylonjs/Materials/Textures/mirrorTexture";
  60357. import { BackgroundMaterial } from "babylonjs/Materials/Background/backgroundMaterial";
  60358. import "babylonjs/Meshes/Builders/planeBuilder";
  60359. import "babylonjs/Meshes/Builders/boxBuilder";
  60360. /**
  60361. * Represents the different options available during the creation of
  60362. * a Environment helper.
  60363. *
  60364. * This can control the default ground, skybox and image processing setup of your scene.
  60365. */
  60366. export interface IEnvironmentHelperOptions {
  60367. /**
  60368. * Specifies whether or not to create a ground.
  60369. * True by default.
  60370. */
  60371. createGround: boolean;
  60372. /**
  60373. * Specifies the ground size.
  60374. * 15 by default.
  60375. */
  60376. groundSize: number;
  60377. /**
  60378. * The texture used on the ground for the main color.
  60379. * Comes from the BabylonJS CDN by default.
  60380. *
  60381. * Remarks: Can be either a texture or a url.
  60382. */
  60383. groundTexture: string | BaseTexture;
  60384. /**
  60385. * The color mixed in the ground texture by default.
  60386. * BabylonJS clearColor by default.
  60387. */
  60388. groundColor: Color3;
  60389. /**
  60390. * Specifies the ground opacity.
  60391. * 1 by default.
  60392. */
  60393. groundOpacity: number;
  60394. /**
  60395. * Enables the ground to receive shadows.
  60396. * True by default.
  60397. */
  60398. enableGroundShadow: boolean;
  60399. /**
  60400. * Helps preventing the shadow to be fully black on the ground.
  60401. * 0.5 by default.
  60402. */
  60403. groundShadowLevel: number;
  60404. /**
  60405. * Creates a mirror texture attach to the ground.
  60406. * false by default.
  60407. */
  60408. enableGroundMirror: boolean;
  60409. /**
  60410. * Specifies the ground mirror size ratio.
  60411. * 0.3 by default as the default kernel is 64.
  60412. */
  60413. groundMirrorSizeRatio: number;
  60414. /**
  60415. * Specifies the ground mirror blur kernel size.
  60416. * 64 by default.
  60417. */
  60418. groundMirrorBlurKernel: number;
  60419. /**
  60420. * Specifies the ground mirror visibility amount.
  60421. * 1 by default
  60422. */
  60423. groundMirrorAmount: number;
  60424. /**
  60425. * Specifies the ground mirror reflectance weight.
  60426. * This uses the standard weight of the background material to setup the fresnel effect
  60427. * of the mirror.
  60428. * 1 by default.
  60429. */
  60430. groundMirrorFresnelWeight: number;
  60431. /**
  60432. * Specifies the ground mirror Falloff distance.
  60433. * This can helps reducing the size of the reflection.
  60434. * 0 by Default.
  60435. */
  60436. groundMirrorFallOffDistance: number;
  60437. /**
  60438. * Specifies the ground mirror texture type.
  60439. * Unsigned Int by Default.
  60440. */
  60441. groundMirrorTextureType: number;
  60442. /**
  60443. * Specifies a bias applied to the ground vertical position to prevent z-fighting with
  60444. * the shown objects.
  60445. */
  60446. groundYBias: number;
  60447. /**
  60448. * Specifies whether or not to create a skybox.
  60449. * True by default.
  60450. */
  60451. createSkybox: boolean;
  60452. /**
  60453. * Specifies the skybox size.
  60454. * 20 by default.
  60455. */
  60456. skyboxSize: number;
  60457. /**
  60458. * The texture used on the skybox for the main color.
  60459. * Comes from the BabylonJS CDN by default.
  60460. *
  60461. * Remarks: Can be either a texture or a url.
  60462. */
  60463. skyboxTexture: string | BaseTexture;
  60464. /**
  60465. * The color mixed in the skybox texture by default.
  60466. * BabylonJS clearColor by default.
  60467. */
  60468. skyboxColor: Color3;
  60469. /**
  60470. * The background rotation around the Y axis of the scene.
  60471. * This helps aligning the key lights of your scene with the background.
  60472. * 0 by default.
  60473. */
  60474. backgroundYRotation: number;
  60475. /**
  60476. * Compute automatically the size of the elements to best fit with the scene.
  60477. */
  60478. sizeAuto: boolean;
  60479. /**
  60480. * Default position of the rootMesh if autoSize is not true.
  60481. */
  60482. rootPosition: Vector3;
  60483. /**
  60484. * Sets up the image processing in the scene.
  60485. * true by default.
  60486. */
  60487. setupImageProcessing: boolean;
  60488. /**
  60489. * The texture used as your environment texture in the scene.
  60490. * Comes from the BabylonJS CDN by default and in use if setupImageProcessing is true.
  60491. *
  60492. * Remarks: Can be either a texture or a url.
  60493. */
  60494. environmentTexture: string | BaseTexture;
  60495. /**
  60496. * The value of the exposure to apply to the scene.
  60497. * 0.6 by default if setupImageProcessing is true.
  60498. */
  60499. cameraExposure: number;
  60500. /**
  60501. * The value of the contrast to apply to the scene.
  60502. * 1.6 by default if setupImageProcessing is true.
  60503. */
  60504. cameraContrast: number;
  60505. /**
  60506. * Specifies whether or not tonemapping should be enabled in the scene.
  60507. * true by default if setupImageProcessing is true.
  60508. */
  60509. toneMappingEnabled: boolean;
  60510. }
  60511. /**
  60512. * The Environment helper class can be used to add a fully featuread none expensive background to your scene.
  60513. * It includes by default a skybox and a ground relying on the BackgroundMaterial.
  60514. * It also helps with the default setup of your imageProcessing configuration.
  60515. */
  60516. export class EnvironmentHelper {
  60517. /**
  60518. * Default ground texture URL.
  60519. */
  60520. private static _groundTextureCDNUrl;
  60521. /**
  60522. * Default skybox texture URL.
  60523. */
  60524. private static _skyboxTextureCDNUrl;
  60525. /**
  60526. * Default environment texture URL.
  60527. */
  60528. private static _environmentTextureCDNUrl;
  60529. /**
  60530. * Creates the default options for the helper.
  60531. */
  60532. private static _getDefaultOptions;
  60533. private _rootMesh;
  60534. /**
  60535. * Gets the root mesh created by the helper.
  60536. */
  60537. get rootMesh(): Mesh;
  60538. private _skybox;
  60539. /**
  60540. * Gets the skybox created by the helper.
  60541. */
  60542. get skybox(): Nullable<Mesh>;
  60543. private _skyboxTexture;
  60544. /**
  60545. * Gets the skybox texture created by the helper.
  60546. */
  60547. get skyboxTexture(): Nullable<BaseTexture>;
  60548. private _skyboxMaterial;
  60549. /**
  60550. * Gets the skybox material created by the helper.
  60551. */
  60552. get skyboxMaterial(): Nullable<BackgroundMaterial>;
  60553. private _ground;
  60554. /**
  60555. * Gets the ground mesh created by the helper.
  60556. */
  60557. get ground(): Nullable<Mesh>;
  60558. private _groundTexture;
  60559. /**
  60560. * Gets the ground texture created by the helper.
  60561. */
  60562. get groundTexture(): Nullable<BaseTexture>;
  60563. private _groundMirror;
  60564. /**
  60565. * Gets the ground mirror created by the helper.
  60566. */
  60567. get groundMirror(): Nullable<MirrorTexture>;
  60568. /**
  60569. * Gets the ground mirror render list to helps pushing the meshes
  60570. * you wish in the ground reflection.
  60571. */
  60572. get groundMirrorRenderList(): Nullable<AbstractMesh[]>;
  60573. private _groundMaterial;
  60574. /**
  60575. * Gets the ground material created by the helper.
  60576. */
  60577. get groundMaterial(): Nullable<BackgroundMaterial>;
  60578. /**
  60579. * Stores the creation options.
  60580. */
  60581. private readonly _scene;
  60582. private _options;
  60583. /**
  60584. * This observable will be notified with any error during the creation of the environment,
  60585. * mainly texture creation errors.
  60586. */
  60587. onErrorObservable: Observable<{
  60588. message?: string;
  60589. exception?: any;
  60590. }>;
  60591. /**
  60592. * constructor
  60593. * @param options Defines the options we want to customize the helper
  60594. * @param scene The scene to add the material to
  60595. */
  60596. constructor(options: Partial<IEnvironmentHelperOptions>, scene: Scene);
  60597. /**
  60598. * Updates the background according to the new options
  60599. * @param options
  60600. */
  60601. updateOptions(options: Partial<IEnvironmentHelperOptions>): void;
  60602. /**
  60603. * Sets the primary color of all the available elements.
  60604. * @param color the main color to affect to the ground and the background
  60605. */
  60606. setMainColor(color: Color3): void;
  60607. /**
  60608. * Setup the image processing according to the specified options.
  60609. */
  60610. private _setupImageProcessing;
  60611. /**
  60612. * Setup the environment texture according to the specified options.
  60613. */
  60614. private _setupEnvironmentTexture;
  60615. /**
  60616. * Setup the background according to the specified options.
  60617. */
  60618. private _setupBackground;
  60619. /**
  60620. * Get the scene sizes according to the setup.
  60621. */
  60622. private _getSceneSize;
  60623. /**
  60624. * Setup the ground according to the specified options.
  60625. */
  60626. private _setupGround;
  60627. /**
  60628. * Setup the ground material according to the specified options.
  60629. */
  60630. private _setupGroundMaterial;
  60631. /**
  60632. * Setup the ground diffuse texture according to the specified options.
  60633. */
  60634. private _setupGroundDiffuseTexture;
  60635. /**
  60636. * Setup the ground mirror texture according to the specified options.
  60637. */
  60638. private _setupGroundMirrorTexture;
  60639. /**
  60640. * Setup the ground to receive the mirror texture.
  60641. */
  60642. private _setupMirrorInGroundMaterial;
  60643. /**
  60644. * Setup the skybox according to the specified options.
  60645. */
  60646. private _setupSkybox;
  60647. /**
  60648. * Setup the skybox material according to the specified options.
  60649. */
  60650. private _setupSkyboxMaterial;
  60651. /**
  60652. * Setup the skybox reflection texture according to the specified options.
  60653. */
  60654. private _setupSkyboxReflectionTexture;
  60655. private _errorHandler;
  60656. /**
  60657. * Dispose all the elements created by the Helper.
  60658. */
  60659. dispose(): void;
  60660. }
  60661. }
  60662. declare module "babylonjs/Helpers/textureDome" {
  60663. import { Scene } from "babylonjs/scene";
  60664. import { TransformNode } from "babylonjs/Meshes/transformNode";
  60665. import { Mesh } from "babylonjs/Meshes/mesh";
  60666. import { Texture } from "babylonjs/Materials/Textures/texture";
  60667. import { BackgroundMaterial } from "babylonjs/Materials/Background/backgroundMaterial";
  60668. import "babylonjs/Meshes/Builders/sphereBuilder";
  60669. import { Nullable } from "babylonjs/types";
  60670. import { Observable } from "babylonjs/Misc/observable";
  60671. /**
  60672. * Display a 360/180 degree texture on an approximately spherical surface, useful for VR applications or skyboxes.
  60673. * As a subclass of TransformNode, this allow parenting to the camera or multiple textures with different locations in the scene.
  60674. * This class achieves its effect with a Texture and a correctly configured BackgroundMaterial on an inverted sphere.
  60675. * Potential additions to this helper include zoom and and non-infinite distance rendering effects.
  60676. */
  60677. export abstract class TextureDome<T extends Texture> extends TransformNode {
  60678. protected onError: Nullable<(message?: string, exception?: any) => void>;
  60679. /**
  60680. * Define the source as a Monoscopic panoramic 360/180.
  60681. */
  60682. static readonly MODE_MONOSCOPIC: number;
  60683. /**
  60684. * Define the source as a Stereoscopic TopBottom/OverUnder panoramic 360/180.
  60685. */
  60686. static readonly MODE_TOPBOTTOM: number;
  60687. /**
  60688. * Define the source as a Stereoscopic Side by Side panoramic 360/180.
  60689. */
  60690. static readonly MODE_SIDEBYSIDE: number;
  60691. private _halfDome;
  60692. private _crossEye;
  60693. protected _useDirectMapping: boolean;
  60694. /**
  60695. * The texture being displayed on the sphere
  60696. */
  60697. protected _texture: T;
  60698. /**
  60699. * Gets the texture being displayed on the sphere
  60700. */
  60701. get texture(): T;
  60702. /**
  60703. * Sets the texture being displayed on the sphere
  60704. */
  60705. set texture(newTexture: T);
  60706. /**
  60707. * The skybox material
  60708. */
  60709. protected _material: BackgroundMaterial;
  60710. /**
  60711. * The surface used for the dome
  60712. */
  60713. protected _mesh: Mesh;
  60714. /**
  60715. * Gets the mesh used for the dome.
  60716. */
  60717. get mesh(): Mesh;
  60718. /**
  60719. * A mesh that will be used to mask the back of the dome in case it is a 180 degree movie.
  60720. */
  60721. private _halfDomeMask;
  60722. /**
  60723. * The current fov(field of view) multiplier, 0.0 - 2.0. Defaults to 1.0. Lower values "zoom in" and higher values "zoom out".
  60724. * Also see the options.resolution property.
  60725. */
  60726. get fovMultiplier(): number;
  60727. set fovMultiplier(value: number);
  60728. protected _textureMode: number;
  60729. /**
  60730. * Gets or set the current texture mode for the texture. It can be:
  60731. * * TextureDome.MODE_MONOSCOPIC : Define the texture source as a Monoscopic panoramic 360.
  60732. * * TextureDome.MODE_TOPBOTTOM : Define the texture source as a Stereoscopic TopBottom/OverUnder panoramic 360.
  60733. * * TextureDome.MODE_SIDEBYSIDE : Define the texture source as a Stereoscopic Side by Side panoramic 360.
  60734. */
  60735. get textureMode(): number;
  60736. /**
  60737. * Sets the current texture mode for the texture. It can be:
  60738. * * TextureDome.MODE_MONOSCOPIC : Define the texture source as a Monoscopic panoramic 360.
  60739. * * TextureDome.MODE_TOPBOTTOM : Define the texture source as a Stereoscopic TopBottom/OverUnder panoramic 360.
  60740. * * TextureDome.MODE_SIDEBYSIDE : Define the texture source as a Stereoscopic Side by Side panoramic 360.
  60741. */
  60742. set textureMode(value: number);
  60743. /**
  60744. * Is it a 180 degrees dome (half dome) or 360 texture (full dome)
  60745. */
  60746. get halfDome(): boolean;
  60747. /**
  60748. * Set the halfDome mode. If set, only the front (180 degrees) will be displayed and the back will be blacked out.
  60749. */
  60750. set halfDome(enabled: boolean);
  60751. /**
  60752. * Set the cross-eye mode. If set, images that can be seen when crossing eyes will render correctly
  60753. */
  60754. set crossEye(enabled: boolean);
  60755. /**
  60756. * Is it a cross-eye texture?
  60757. */
  60758. get crossEye(): boolean;
  60759. /**
  60760. * The background material of this dome.
  60761. */
  60762. get material(): BackgroundMaterial;
  60763. /**
  60764. * Oberserver used in Stereoscopic VR Mode.
  60765. */
  60766. private _onBeforeCameraRenderObserver;
  60767. /**
  60768. * Observable raised when an error occured while loading the 360 image
  60769. */
  60770. onLoadErrorObservable: Observable<string>;
  60771. /**
  60772. * Create an instance of this class and pass through the parameters to the relevant classes- Texture, StandardMaterial, and Mesh.
  60773. * @param name Element's name, child elements will append suffixes for their own names.
  60774. * @param textureUrlOrElement defines the url(s) or the (video) HTML element to use
  60775. * @param options An object containing optional or exposed sub element properties
  60776. */
  60777. constructor(name: string, textureUrlOrElement: string | string[] | HTMLVideoElement, options: {
  60778. resolution?: number;
  60779. clickToPlay?: boolean;
  60780. autoPlay?: boolean;
  60781. loop?: boolean;
  60782. size?: number;
  60783. poster?: string;
  60784. faceForward?: boolean;
  60785. useDirectMapping?: boolean;
  60786. halfDomeMode?: boolean;
  60787. crossEyeMode?: boolean;
  60788. generateMipMaps?: boolean;
  60789. }, scene: Scene, onError?: Nullable<(message?: string, exception?: any) => void>);
  60790. protected abstract _initTexture(urlsOrElement: string | string[] | HTMLElement, scene: Scene, options: any): T;
  60791. protected _changeTextureMode(value: number): void;
  60792. /**
  60793. * Releases resources associated with this node.
  60794. * @param doNotRecurse Set to true to not recurse into each children (recurse into each children by default)
  60795. * @param disposeMaterialAndTextures Set to true to also dispose referenced materials and textures (false by default)
  60796. */
  60797. dispose(doNotRecurse?: boolean, disposeMaterialAndTextures?: boolean): void;
  60798. }
  60799. }
  60800. declare module "babylonjs/Helpers/photoDome" {
  60801. import { Scene } from "babylonjs/scene";
  60802. import { Texture } from "babylonjs/Materials/Textures/texture";
  60803. import { TextureDome } from "babylonjs/Helpers/textureDome";
  60804. /**
  60805. * Display a 360 degree photo on an approximately spherical surface, useful for VR applications or skyboxes.
  60806. * As a subclass of TransformNode, this allow parenting to the camera with different locations in the scene.
  60807. * This class achieves its effect with a Texture and a correctly configured BackgroundMaterial on an inverted sphere.
  60808. * Potential additions to this helper include zoom and and non-infinite distance rendering effects.
  60809. */
  60810. export class PhotoDome extends TextureDome<Texture> {
  60811. /**
  60812. * Define the image as a Monoscopic panoramic 360 image.
  60813. */
  60814. static readonly MODE_MONOSCOPIC: number;
  60815. /**
  60816. * Define the image as a Stereoscopic TopBottom/OverUnder panoramic 360 image.
  60817. */
  60818. static readonly MODE_TOPBOTTOM: number;
  60819. /**
  60820. * Define the image as a Stereoscopic Side by Side panoramic 360 image.
  60821. */
  60822. static readonly MODE_SIDEBYSIDE: number;
  60823. /**
  60824. * Gets or sets the texture being displayed on the sphere
  60825. */
  60826. get photoTexture(): Texture;
  60827. /**
  60828. * sets the texture being displayed on the sphere
  60829. */
  60830. set photoTexture(value: Texture);
  60831. /**
  60832. * Gets the current video mode for the video. It can be:
  60833. * * TextureDome.MODE_MONOSCOPIC : Define the texture source as a Monoscopic panoramic 360.
  60834. * * TextureDome.MODE_TOPBOTTOM : Define the texture source as a Stereoscopic TopBottom/OverUnder panoramic 360.
  60835. * * TextureDome.MODE_SIDEBYSIDE : Define the texture source as a Stereoscopic Side by Side panoramic 360.
  60836. */
  60837. get imageMode(): number;
  60838. /**
  60839. * Sets the current video mode for the video. It can be:
  60840. * * TextureDome.MODE_MONOSCOPIC : Define the texture source as a Monoscopic panoramic 360.
  60841. * * TextureDome.MODE_TOPBOTTOM : Define the texture source as a Stereoscopic TopBottom/OverUnder panoramic 360.
  60842. * * TextureDome.MODE_SIDEBYSIDE : Define the texture source as a Stereoscopic Side by Side panoramic 360.
  60843. */
  60844. set imageMode(value: number);
  60845. protected _initTexture(urlsOrElement: string, scene: Scene, options: any): Texture;
  60846. }
  60847. }
  60848. declare module "babylonjs/Misc/dds" {
  60849. import { SphericalPolynomial } from "babylonjs/Maths/sphericalPolynomial";
  60850. import { InternalTexture } from "babylonjs/Materials/Textures/internalTexture";
  60851. import { Nullable } from "babylonjs/types";
  60852. import { Scene } from "babylonjs/scene";
  60853. import "babylonjs/Engines/Extensions/engine.cubeTexture";
  60854. import { ThinEngine } from "babylonjs/Engines/thinEngine";
  60855. /**
  60856. * Direct draw surface info
  60857. * @see https://docs.microsoft.com/en-us/windows/desktop/direct3ddds/dx-graphics-dds-pguide
  60858. */
  60859. export interface DDSInfo {
  60860. /**
  60861. * Width of the texture
  60862. */
  60863. width: number;
  60864. /**
  60865. * Width of the texture
  60866. */
  60867. height: number;
  60868. /**
  60869. * Number of Mipmaps for the texture
  60870. * @see https://en.wikipedia.org/wiki/Mipmap
  60871. */
  60872. mipmapCount: number;
  60873. /**
  60874. * If the textures format is a known fourCC format
  60875. * @see https://www.fourcc.org/
  60876. */
  60877. isFourCC: boolean;
  60878. /**
  60879. * If the texture is an RGB format eg. DXGI_FORMAT_B8G8R8X8_UNORM format
  60880. */
  60881. isRGB: boolean;
  60882. /**
  60883. * If the texture is a lumincance format
  60884. */
  60885. isLuminance: boolean;
  60886. /**
  60887. * If this is a cube texture
  60888. * @see https://docs.microsoft.com/en-us/windows/desktop/direct3ddds/dds-file-layout-for-cubic-environment-maps
  60889. */
  60890. isCube: boolean;
  60891. /**
  60892. * If the texture is a compressed format eg. FOURCC_DXT1
  60893. */
  60894. isCompressed: boolean;
  60895. /**
  60896. * The dxgiFormat of the texture
  60897. * @see https://docs.microsoft.com/en-us/windows/desktop/api/dxgiformat/ne-dxgiformat-dxgi_format
  60898. */
  60899. dxgiFormat: number;
  60900. /**
  60901. * Texture type eg. Engine.TEXTURETYPE_UNSIGNED_INT, Engine.TEXTURETYPE_FLOAT
  60902. */
  60903. textureType: number;
  60904. /**
  60905. * Sphericle polynomial created for the dds texture
  60906. */
  60907. sphericalPolynomial?: SphericalPolynomial;
  60908. }
  60909. /**
  60910. * Class used to provide DDS decompression tools
  60911. */
  60912. export class DDSTools {
  60913. /**
  60914. * Gets or sets a boolean indicating that LOD info is stored in alpha channel (false by default)
  60915. */
  60916. static StoreLODInAlphaChannel: boolean;
  60917. /**
  60918. * Gets DDS information from an array buffer
  60919. * @param data defines the array buffer view to read data from
  60920. * @returns the DDS information
  60921. */
  60922. static GetDDSInfo(data: ArrayBufferView): DDSInfo;
  60923. private static _FloatView;
  60924. private static _Int32View;
  60925. private static _ToHalfFloat;
  60926. private static _FromHalfFloat;
  60927. private static _GetHalfFloatAsFloatRGBAArrayBuffer;
  60928. private static _GetHalfFloatRGBAArrayBuffer;
  60929. private static _GetFloatRGBAArrayBuffer;
  60930. private static _GetFloatAsUIntRGBAArrayBuffer;
  60931. private static _GetHalfFloatAsUIntRGBAArrayBuffer;
  60932. private static _GetRGBAArrayBuffer;
  60933. private static _ExtractLongWordOrder;
  60934. private static _GetRGBArrayBuffer;
  60935. private static _GetLuminanceArrayBuffer;
  60936. /**
  60937. * Uploads DDS Levels to a Babylon Texture
  60938. * @hidden
  60939. */
  60940. static UploadDDSLevels(engine: ThinEngine, texture: InternalTexture, data: ArrayBufferView, info: DDSInfo, loadMipmaps: boolean, faces: number, lodIndex?: number, currentFace?: number): void;
  60941. }
  60942. module "babylonjs/Engines/thinEngine" {
  60943. interface ThinEngine {
  60944. /**
  60945. * Create a cube texture from prefiltered data (ie. the mipmaps contain ready to use data for PBR reflection)
  60946. * @param rootUrl defines the url where the file to load is located
  60947. * @param scene defines the current scene
  60948. * @param lodScale defines scale to apply to the mip map selection
  60949. * @param lodOffset defines offset to apply to the mip map selection
  60950. * @param onLoad defines an optional callback raised when the texture is loaded
  60951. * @param onError defines an optional callback raised if there is an issue to load the texture
  60952. * @param format defines the format of the data
  60953. * @param forcedExtension defines the extension to use to pick the right loader
  60954. * @param createPolynomials defines wheter or not to create polynomails harmonics for the texture
  60955. * @returns the cube texture as an InternalTexture
  60956. */
  60957. 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;
  60958. }
  60959. }
  60960. }
  60961. declare module "babylonjs/Materials/Textures/Loaders/ddsTextureLoader" {
  60962. import { Nullable } from "babylonjs/types";
  60963. import { InternalTexture } from "babylonjs/Materials/Textures/internalTexture";
  60964. import { IInternalTextureLoader } from "babylonjs/Materials/Textures/internalTextureLoader";
  60965. /**
  60966. * Implementation of the DDS Texture Loader.
  60967. * @hidden
  60968. */
  60969. export class _DDSTextureLoader implements IInternalTextureLoader {
  60970. /**
  60971. * Defines wether the loader supports cascade loading the different faces.
  60972. */
  60973. readonly supportCascades: boolean;
  60974. /**
  60975. * This returns if the loader support the current file information.
  60976. * @param extension defines the file extension of the file being loaded
  60977. * @returns true if the loader can load the specified file
  60978. */
  60979. canLoad(extension: string): boolean;
  60980. /**
  60981. * Uploads the cube texture data to the WebGL texture. It has already been bound.
  60982. * @param data contains the texture data
  60983. * @param texture defines the BabylonJS internal texture
  60984. * @param createPolynomials will be true if polynomials have been requested
  60985. * @param onLoad defines the callback to trigger once the texture is ready
  60986. * @param onError defines the callback to trigger in case of error
  60987. */
  60988. loadCubeData(imgs: ArrayBufferView | ArrayBufferView[], texture: InternalTexture, createPolynomials: boolean, onLoad: Nullable<(data?: any) => void>, onError: Nullable<(message?: string, exception?: any) => void>): void;
  60989. /**
  60990. * Uploads the 2D texture data to the WebGL texture. It has already been bound once in the callback.
  60991. * @param data contains the texture data
  60992. * @param texture defines the BabylonJS internal texture
  60993. * @param callback defines the method to call once ready to upload
  60994. */
  60995. loadData(data: ArrayBufferView, texture: InternalTexture, callback: (width: number, height: number, loadMipmap: boolean, isCompressed: boolean, done: () => void) => void): void;
  60996. }
  60997. }
  60998. declare module "babylonjs/Materials/Textures/Loaders/envTextureLoader" {
  60999. import { Nullable } from "babylonjs/types";
  61000. import { InternalTexture } from "babylonjs/Materials/Textures/internalTexture";
  61001. import { IInternalTextureLoader } from "babylonjs/Materials/Textures/internalTextureLoader";
  61002. /**
  61003. * Implementation of the ENV Texture Loader.
  61004. * @hidden
  61005. */
  61006. export class _ENVTextureLoader implements IInternalTextureLoader {
  61007. /**
  61008. * Defines wether the loader supports cascade loading the different faces.
  61009. */
  61010. readonly supportCascades: boolean;
  61011. /**
  61012. * This returns if the loader support the current file information.
  61013. * @param extension defines the file extension of the file being loaded
  61014. * @returns true if the loader can load the specified file
  61015. */
  61016. canLoad(extension: string): boolean;
  61017. /**
  61018. * Uploads the cube texture data to the WebGL texture. It has already been bound.
  61019. * @param data contains the texture data
  61020. * @param texture defines the BabylonJS internal texture
  61021. * @param createPolynomials will be true if polynomials have been requested
  61022. * @param onLoad defines the callback to trigger once the texture is ready
  61023. * @param onError defines the callback to trigger in case of error
  61024. */
  61025. loadCubeData(data: ArrayBufferView | ArrayBufferView[], texture: InternalTexture, createPolynomials: boolean, onLoad: Nullable<(data?: any) => void>, onError: Nullable<(message?: string, exception?: any) => void>): void;
  61026. /**
  61027. * Uploads the 2D texture data to the WebGL texture. It has already been bound once in the callback.
  61028. * @param data contains the texture data
  61029. * @param texture defines the BabylonJS internal texture
  61030. * @param callback defines the method to call once ready to upload
  61031. */
  61032. loadData(data: ArrayBufferView, texture: InternalTexture, callback: (width: number, height: number, loadMipmap: boolean, isCompressed: boolean, done: () => void) => void): void;
  61033. }
  61034. }
  61035. declare module "babylonjs/Misc/khronosTextureContainer" {
  61036. import { InternalTexture } from "babylonjs/Materials/Textures/internalTexture";
  61037. /**
  61038. * for description see https://www.khronos.org/opengles/sdk/tools/KTX/
  61039. * for file layout see https://www.khronos.org/opengles/sdk/tools/KTX/file_format_spec/
  61040. */
  61041. export class KhronosTextureContainer {
  61042. /** contents of the KTX container file */
  61043. data: ArrayBufferView;
  61044. private static HEADER_LEN;
  61045. private static COMPRESSED_2D;
  61046. private static COMPRESSED_3D;
  61047. private static TEX_2D;
  61048. private static TEX_3D;
  61049. /**
  61050. * Gets the openGL type
  61051. */
  61052. glType: number;
  61053. /**
  61054. * Gets the openGL type size
  61055. */
  61056. glTypeSize: number;
  61057. /**
  61058. * Gets the openGL format
  61059. */
  61060. glFormat: number;
  61061. /**
  61062. * Gets the openGL internal format
  61063. */
  61064. glInternalFormat: number;
  61065. /**
  61066. * Gets the base internal format
  61067. */
  61068. glBaseInternalFormat: number;
  61069. /**
  61070. * Gets image width in pixel
  61071. */
  61072. pixelWidth: number;
  61073. /**
  61074. * Gets image height in pixel
  61075. */
  61076. pixelHeight: number;
  61077. /**
  61078. * Gets image depth in pixels
  61079. */
  61080. pixelDepth: number;
  61081. /**
  61082. * Gets the number of array elements
  61083. */
  61084. numberOfArrayElements: number;
  61085. /**
  61086. * Gets the number of faces
  61087. */
  61088. numberOfFaces: number;
  61089. /**
  61090. * Gets the number of mipmap levels
  61091. */
  61092. numberOfMipmapLevels: number;
  61093. /**
  61094. * Gets the bytes of key value data
  61095. */
  61096. bytesOfKeyValueData: number;
  61097. /**
  61098. * Gets the load type
  61099. */
  61100. loadType: number;
  61101. /**
  61102. * If the container has been made invalid (eg. constructor failed to correctly load array buffer)
  61103. */
  61104. isInvalid: boolean;
  61105. /**
  61106. * Creates a new KhronosTextureContainer
  61107. * @param data contents of the KTX container file
  61108. * @param facesExpected should be either 1 or 6, based whether a cube texture or or
  61109. * @param threeDExpected provision for indicating that data should be a 3D texture, not implemented
  61110. * @param textureArrayExpected provision for indicating that data should be a texture array, not implemented
  61111. */
  61112. constructor(
  61113. /** contents of the KTX container file */
  61114. data: ArrayBufferView, facesExpected: number, threeDExpected?: boolean, textureArrayExpected?: boolean);
  61115. /**
  61116. * Uploads KTX content to a Babylon Texture.
  61117. * It is assumed that the texture has already been created & is currently bound
  61118. * @hidden
  61119. */
  61120. uploadLevels(texture: InternalTexture, loadMipmaps: boolean): void;
  61121. private _upload2DCompressedLevels;
  61122. /**
  61123. * Checks if the given data starts with a KTX file identifier.
  61124. * @param data the data to check
  61125. * @returns true if the data is a KTX file or false otherwise
  61126. */
  61127. static IsValid(data: ArrayBufferView): boolean;
  61128. }
  61129. }
  61130. declare module "babylonjs/Misc/workerPool" {
  61131. import { IDisposable } from "babylonjs/scene";
  61132. /**
  61133. * Helper class to push actions to a pool of workers.
  61134. */
  61135. export class WorkerPool implements IDisposable {
  61136. private _workerInfos;
  61137. private _pendingActions;
  61138. /**
  61139. * Constructor
  61140. * @param workers Array of workers to use for actions
  61141. */
  61142. constructor(workers: Array<Worker>);
  61143. /**
  61144. * Terminates all workers and clears any pending actions.
  61145. */
  61146. dispose(): void;
  61147. /**
  61148. * Pushes an action to the worker pool. If all the workers are active, the action will be
  61149. * pended until a worker has completed its action.
  61150. * @param action The action to perform. Call onComplete when the action is complete.
  61151. */
  61152. push(action: (worker: Worker, onComplete: () => void) => void): void;
  61153. private _execute;
  61154. }
  61155. }
  61156. declare module "babylonjs/Misc/khronosTextureContainer2" {
  61157. import { InternalTexture } from "babylonjs/Materials/Textures/internalTexture";
  61158. import { ThinEngine } from "babylonjs/Engines/thinEngine";
  61159. /**
  61160. * Class for loading KTX2 files
  61161. */
  61162. export class KhronosTextureContainer2 {
  61163. private static _WorkerPoolPromise?;
  61164. private static _Initialized;
  61165. private static _Ktx2Decoder;
  61166. /**
  61167. * URLs to use when loading the KTX2 decoder module as well as its dependencies
  61168. * If a url is null, the default url is used (pointing to https://preview.babylonjs.com)
  61169. * Note that jsDecoderModule can't be null and that the other dependencies will only be loaded if necessary
  61170. * Urls you can change:
  61171. * URLConfig.jsDecoderModule
  61172. * URLConfig.wasmUASTCToASTC
  61173. * URLConfig.wasmUASTCToBC7
  61174. * URLConfig.jsMSCTranscoder
  61175. * URLConfig.wasmMSCTranscoder
  61176. * You can see their default values in this PG: https://playground.babylonjs.com/#EIJH8L#9
  61177. */
  61178. static URLConfig: {
  61179. jsDecoderModule: string;
  61180. wasmUASTCToASTC: null;
  61181. wasmUASTCToBC7: null;
  61182. jsMSCTranscoder: null;
  61183. wasmMSCTranscoder: null;
  61184. };
  61185. /**
  61186. * Default number of workers used to handle data decoding
  61187. */
  61188. static DefaultNumWorkers: number;
  61189. private static GetDefaultNumWorkers;
  61190. private _engine;
  61191. private static _CreateWorkerPool;
  61192. /**
  61193. * Constructor
  61194. * @param engine The engine to use
  61195. * @param numWorkers The number of workers for async operations. Specify `0` to disable web workers and run synchronously in the current context.
  61196. */
  61197. constructor(engine: ThinEngine, numWorkers?: number);
  61198. /** @hidden */
  61199. uploadAsync(data: ArrayBufferView, internalTexture: InternalTexture): Promise<void>;
  61200. /**
  61201. * Stop all async operations and release resources.
  61202. */
  61203. dispose(): void;
  61204. protected _createTexture(data: any, internalTexture: InternalTexture): void;
  61205. /**
  61206. * Checks if the given data starts with a KTX2 file identifier.
  61207. * @param data the data to check
  61208. * @returns true if the data is a KTX2 file or false otherwise
  61209. */
  61210. static IsValid(data: ArrayBufferView): boolean;
  61211. }
  61212. }
  61213. declare module "babylonjs/Materials/Textures/Loaders/ktxTextureLoader" {
  61214. import { Nullable } from "babylonjs/types";
  61215. import { InternalTexture } from "babylonjs/Materials/Textures/internalTexture";
  61216. import { IInternalTextureLoader } from "babylonjs/Materials/Textures/internalTextureLoader";
  61217. /**
  61218. * Implementation of the KTX Texture Loader.
  61219. * @hidden
  61220. */
  61221. export class _KTXTextureLoader implements IInternalTextureLoader {
  61222. /**
  61223. * Defines wether the loader supports cascade loading the different faces.
  61224. */
  61225. readonly supportCascades: boolean;
  61226. /**
  61227. * This returns if the loader support the current file information.
  61228. * @param extension defines the file extension of the file being loaded
  61229. * @param mimeType defines the optional mime type of the file being loaded
  61230. * @returns true if the loader can load the specified file
  61231. */
  61232. canLoad(extension: string, mimeType?: string): boolean;
  61233. /**
  61234. * Uploads the cube texture data to the WebGL texture. It has already been bound.
  61235. * @param data contains the texture data
  61236. * @param texture defines the BabylonJS internal texture
  61237. * @param createPolynomials will be true if polynomials have been requested
  61238. * @param onLoad defines the callback to trigger once the texture is ready
  61239. * @param onError defines the callback to trigger in case of error
  61240. */
  61241. loadCubeData(data: ArrayBufferView | ArrayBufferView[], texture: InternalTexture, createPolynomials: boolean, onLoad: Nullable<(data?: any) => void>, onError: Nullable<(message?: string, exception?: any) => void>): void;
  61242. /**
  61243. * Uploads the 2D texture data to the WebGL texture. It has already been bound once in the callback.
  61244. * @param data contains the texture data
  61245. * @param texture defines the BabylonJS internal texture
  61246. * @param callback defines the method to call once ready to upload
  61247. */
  61248. loadData(data: ArrayBufferView, texture: InternalTexture, callback: (width: number, height: number, loadMipmap: boolean, isCompressed: boolean, done: () => void, loadFailed: boolean) => void): void;
  61249. }
  61250. }
  61251. declare module "babylonjs/Helpers/sceneHelpers" {
  61252. import { Nullable } from "babylonjs/types";
  61253. import { Mesh } from "babylonjs/Meshes/mesh";
  61254. import { BaseTexture } from "babylonjs/Materials/Textures/baseTexture";
  61255. import { IEnvironmentHelperOptions, EnvironmentHelper } from "babylonjs/Helpers/environmentHelper";
  61256. import { VRExperienceHelperOptions, VRExperienceHelper } from "babylonjs/Cameras/VR/vrExperienceHelper";
  61257. import "babylonjs/Materials/Textures/Loaders/ddsTextureLoader";
  61258. import "babylonjs/Materials/Textures/Loaders/envTextureLoader";
  61259. import "babylonjs/Materials/Textures/Loaders/ktxTextureLoader";
  61260. import "babylonjs/Meshes/Builders/boxBuilder";
  61261. import { WebXRDefaultExperience, WebXRDefaultExperienceOptions } from "babylonjs/XR/webXRDefaultExperience";
  61262. /** @hidden */
  61263. export var _forceSceneHelpersToBundle: boolean;
  61264. module "babylonjs/scene" {
  61265. interface Scene {
  61266. /**
  61267. * Creates a default light for the scene.
  61268. * @see https://doc.babylonjs.com/How_To/Fast_Build#create-default-light
  61269. * @param replace has the default false, when true replaces the existing lights in the scene with a hemispheric light
  61270. */
  61271. createDefaultLight(replace?: boolean): void;
  61272. /**
  61273. * Creates a default camera for the scene.
  61274. * @see https://doc.babylonjs.com/How_To/Fast_Build#create-default-camera
  61275. * @param createArcRotateCamera has the default false which creates a free camera, when true creates an arc rotate camera
  61276. * @param replace has default false, when true replaces the active camera in the scene
  61277. * @param attachCameraControls has default false, when true attaches camera controls to the canvas.
  61278. */
  61279. createDefaultCamera(createArcRotateCamera?: boolean, replace?: boolean, attachCameraControls?: boolean): void;
  61280. /**
  61281. * Creates a default camera and a default light.
  61282. * @see https://doc.babylonjs.com/how_to/Fast_Build#create-default-camera-or-light
  61283. * @param createArcRotateCamera has the default false which creates a free camera, when true creates an arc rotate camera
  61284. * @param replace has the default false, when true replaces the active camera/light in the scene
  61285. * @param attachCameraControls has the default false, when true attaches camera controls to the canvas.
  61286. */
  61287. createDefaultCameraOrLight(createArcRotateCamera?: boolean, replace?: boolean, attachCameraControls?: boolean): void;
  61288. /**
  61289. * Creates a new sky box
  61290. * @see https://doc.babylonjs.com/how_to/Fast_Build#create-default-skybox
  61291. * @param environmentTexture defines the texture to use as environment texture
  61292. * @param pbr has default false which requires the StandardMaterial to be used, when true PBRMaterial must be used
  61293. * @param scale defines the overall scale of the skybox
  61294. * @param blur is only available when pbr is true, default is 0, no blur, maximum value is 1
  61295. * @param setGlobalEnvTexture has default true indicating that scene.environmentTexture must match the current skybox texture
  61296. * @returns a new mesh holding the sky box
  61297. */
  61298. createDefaultSkybox(environmentTexture?: BaseTexture, pbr?: boolean, scale?: number, blur?: number, setGlobalEnvTexture?: boolean): Nullable<Mesh>;
  61299. /**
  61300. * Creates a new environment
  61301. * @see https://doc.babylonjs.com/How_To/Fast_Build#create-default-environment
  61302. * @param options defines the options you can use to configure the environment
  61303. * @returns the new EnvironmentHelper
  61304. */
  61305. createDefaultEnvironment(options?: Partial<IEnvironmentHelperOptions>): Nullable<EnvironmentHelper>;
  61306. /**
  61307. * Creates a new VREXperienceHelper
  61308. * @see https://doc.babylonjs.com/how_to/webvr_helper
  61309. * @param webVROptions defines the options used to create the new VREXperienceHelper
  61310. * @returns a new VREXperienceHelper
  61311. */
  61312. createDefaultVRExperience(webVROptions?: VRExperienceHelperOptions): VRExperienceHelper;
  61313. /**
  61314. * Creates a new WebXRDefaultExperience
  61315. * @see https://doc.babylonjs.com/how_to/introduction_to_webxr
  61316. * @param options experience options
  61317. * @returns a promise for a new WebXRDefaultExperience
  61318. */
  61319. createDefaultXRExperienceAsync(options: WebXRDefaultExperienceOptions): Promise<WebXRDefaultExperience>;
  61320. }
  61321. }
  61322. }
  61323. declare module "babylonjs/Helpers/videoDome" {
  61324. import { Scene } from "babylonjs/scene";
  61325. import { VideoTexture } from "babylonjs/Materials/Textures/videoTexture";
  61326. import { TextureDome } from "babylonjs/Helpers/textureDome";
  61327. /**
  61328. * Display a 360/180 degree video on an approximately spherical surface, useful for VR applications or skyboxes.
  61329. * As a subclass of TransformNode, this allow parenting to the camera or multiple videos with different locations in the scene.
  61330. * This class achieves its effect with a VideoTexture and a correctly configured BackgroundMaterial on an inverted sphere.
  61331. * Potential additions to this helper include zoom and and non-infinite distance rendering effects.
  61332. */
  61333. export class VideoDome extends TextureDome<VideoTexture> {
  61334. /**
  61335. * Define the video source as a Monoscopic panoramic 360 video.
  61336. */
  61337. static readonly MODE_MONOSCOPIC: number;
  61338. /**
  61339. * Define the video source as a Stereoscopic TopBottom/OverUnder panoramic 360 video.
  61340. */
  61341. static readonly MODE_TOPBOTTOM: number;
  61342. /**
  61343. * Define the video source as a Stereoscopic Side by Side panoramic 360 video.
  61344. */
  61345. static readonly MODE_SIDEBYSIDE: number;
  61346. /**
  61347. * Get the video texture associated with this video dome
  61348. */
  61349. get videoTexture(): VideoTexture;
  61350. /**
  61351. * Get the video mode of this dome
  61352. */
  61353. get videoMode(): number;
  61354. /**
  61355. * Set the video mode of this dome.
  61356. * @see textureMode
  61357. */
  61358. set videoMode(value: number);
  61359. protected _initTexture(urlsOrElement: string | string[] | HTMLVideoElement, scene: Scene, options: any): VideoTexture;
  61360. }
  61361. }
  61362. declare module "babylonjs/Helpers/index" {
  61363. export * from "babylonjs/Helpers/environmentHelper";
  61364. export * from "babylonjs/Helpers/photoDome";
  61365. export * from "babylonjs/Helpers/sceneHelpers";
  61366. export * from "babylonjs/Helpers/videoDome";
  61367. }
  61368. declare module "babylonjs/Instrumentation/engineInstrumentation" {
  61369. import { PerfCounter } from "babylonjs/Misc/perfCounter";
  61370. import { IDisposable } from "babylonjs/scene";
  61371. import { Engine } from "babylonjs/Engines/engine";
  61372. /**
  61373. * This class can be used to get instrumentation data from a Babylon engine
  61374. * @see https://doc.babylonjs.com/how_to/optimizing_your_scene#engineinstrumentation
  61375. */
  61376. export class EngineInstrumentation implements IDisposable {
  61377. /**
  61378. * Define the instrumented engine.
  61379. */
  61380. engine: Engine;
  61381. private _captureGPUFrameTime;
  61382. private _gpuFrameTimeToken;
  61383. private _gpuFrameTime;
  61384. private _captureShaderCompilationTime;
  61385. private _shaderCompilationTime;
  61386. private _onBeginFrameObserver;
  61387. private _onEndFrameObserver;
  61388. private _onBeforeShaderCompilationObserver;
  61389. private _onAfterShaderCompilationObserver;
  61390. /**
  61391. * Gets the perf counter used for GPU frame time
  61392. */
  61393. get gpuFrameTimeCounter(): PerfCounter;
  61394. /**
  61395. * Gets the GPU frame time capture status
  61396. */
  61397. get captureGPUFrameTime(): boolean;
  61398. /**
  61399. * Enable or disable the GPU frame time capture
  61400. */
  61401. set captureGPUFrameTime(value: boolean);
  61402. /**
  61403. * Gets the perf counter used for shader compilation time
  61404. */
  61405. get shaderCompilationTimeCounter(): PerfCounter;
  61406. /**
  61407. * Gets the shader compilation time capture status
  61408. */
  61409. get captureShaderCompilationTime(): boolean;
  61410. /**
  61411. * Enable or disable the shader compilation time capture
  61412. */
  61413. set captureShaderCompilationTime(value: boolean);
  61414. /**
  61415. * Instantiates a new engine instrumentation.
  61416. * This class can be used to get instrumentation data from a Babylon engine
  61417. * @see https://doc.babylonjs.com/how_to/optimizing_your_scene#engineinstrumentation
  61418. * @param engine Defines the engine to instrument
  61419. */
  61420. constructor(
  61421. /**
  61422. * Define the instrumented engine.
  61423. */
  61424. engine: Engine);
  61425. /**
  61426. * Dispose and release associated resources.
  61427. */
  61428. dispose(): void;
  61429. }
  61430. }
  61431. declare module "babylonjs/Instrumentation/sceneInstrumentation" {
  61432. import { Scene, IDisposable } from "babylonjs/scene";
  61433. import { PerfCounter } from "babylonjs/Misc/perfCounter";
  61434. /**
  61435. * This class can be used to get instrumentation data from a Babylon engine
  61436. * @see https://doc.babylonjs.com/how_to/optimizing_your_scene#sceneinstrumentation
  61437. */
  61438. export class SceneInstrumentation implements IDisposable {
  61439. /**
  61440. * Defines the scene to instrument
  61441. */
  61442. scene: Scene;
  61443. private _captureActiveMeshesEvaluationTime;
  61444. private _activeMeshesEvaluationTime;
  61445. private _captureRenderTargetsRenderTime;
  61446. private _renderTargetsRenderTime;
  61447. private _captureFrameTime;
  61448. private _frameTime;
  61449. private _captureRenderTime;
  61450. private _renderTime;
  61451. private _captureInterFrameTime;
  61452. private _interFrameTime;
  61453. private _captureParticlesRenderTime;
  61454. private _particlesRenderTime;
  61455. private _captureSpritesRenderTime;
  61456. private _spritesRenderTime;
  61457. private _capturePhysicsTime;
  61458. private _physicsTime;
  61459. private _captureAnimationsTime;
  61460. private _animationsTime;
  61461. private _captureCameraRenderTime;
  61462. private _cameraRenderTime;
  61463. private _onBeforeActiveMeshesEvaluationObserver;
  61464. private _onAfterActiveMeshesEvaluationObserver;
  61465. private _onBeforeRenderTargetsRenderObserver;
  61466. private _onAfterRenderTargetsRenderObserver;
  61467. private _onAfterRenderObserver;
  61468. private _onBeforeDrawPhaseObserver;
  61469. private _onAfterDrawPhaseObserver;
  61470. private _onBeforeAnimationsObserver;
  61471. private _onBeforeParticlesRenderingObserver;
  61472. private _onAfterParticlesRenderingObserver;
  61473. private _onBeforeSpritesRenderingObserver;
  61474. private _onAfterSpritesRenderingObserver;
  61475. private _onBeforePhysicsObserver;
  61476. private _onAfterPhysicsObserver;
  61477. private _onAfterAnimationsObserver;
  61478. private _onBeforeCameraRenderObserver;
  61479. private _onAfterCameraRenderObserver;
  61480. /**
  61481. * Gets the perf counter used for active meshes evaluation time
  61482. */
  61483. get activeMeshesEvaluationTimeCounter(): PerfCounter;
  61484. /**
  61485. * Gets the active meshes evaluation time capture status
  61486. */
  61487. get captureActiveMeshesEvaluationTime(): boolean;
  61488. /**
  61489. * Enable or disable the active meshes evaluation time capture
  61490. */
  61491. set captureActiveMeshesEvaluationTime(value: boolean);
  61492. /**
  61493. * Gets the perf counter used for render targets render time
  61494. */
  61495. get renderTargetsRenderTimeCounter(): PerfCounter;
  61496. /**
  61497. * Gets the render targets render time capture status
  61498. */
  61499. get captureRenderTargetsRenderTime(): boolean;
  61500. /**
  61501. * Enable or disable the render targets render time capture
  61502. */
  61503. set captureRenderTargetsRenderTime(value: boolean);
  61504. /**
  61505. * Gets the perf counter used for particles render time
  61506. */
  61507. get particlesRenderTimeCounter(): PerfCounter;
  61508. /**
  61509. * Gets the particles render time capture status
  61510. */
  61511. get captureParticlesRenderTime(): boolean;
  61512. /**
  61513. * Enable or disable the particles render time capture
  61514. */
  61515. set captureParticlesRenderTime(value: boolean);
  61516. /**
  61517. * Gets the perf counter used for sprites render time
  61518. */
  61519. get spritesRenderTimeCounter(): PerfCounter;
  61520. /**
  61521. * Gets the sprites render time capture status
  61522. */
  61523. get captureSpritesRenderTime(): boolean;
  61524. /**
  61525. * Enable or disable the sprites render time capture
  61526. */
  61527. set captureSpritesRenderTime(value: boolean);
  61528. /**
  61529. * Gets the perf counter used for physics time
  61530. */
  61531. get physicsTimeCounter(): PerfCounter;
  61532. /**
  61533. * Gets the physics time capture status
  61534. */
  61535. get capturePhysicsTime(): boolean;
  61536. /**
  61537. * Enable or disable the physics time capture
  61538. */
  61539. set capturePhysicsTime(value: boolean);
  61540. /**
  61541. * Gets the perf counter used for animations time
  61542. */
  61543. get animationsTimeCounter(): PerfCounter;
  61544. /**
  61545. * Gets the animations time capture status
  61546. */
  61547. get captureAnimationsTime(): boolean;
  61548. /**
  61549. * Enable or disable the animations time capture
  61550. */
  61551. set captureAnimationsTime(value: boolean);
  61552. /**
  61553. * Gets the perf counter used for frame time capture
  61554. */
  61555. get frameTimeCounter(): PerfCounter;
  61556. /**
  61557. * Gets the frame time capture status
  61558. */
  61559. get captureFrameTime(): boolean;
  61560. /**
  61561. * Enable or disable the frame time capture
  61562. */
  61563. set captureFrameTime(value: boolean);
  61564. /**
  61565. * Gets the perf counter used for inter-frames time capture
  61566. */
  61567. get interFrameTimeCounter(): PerfCounter;
  61568. /**
  61569. * Gets the inter-frames time capture status
  61570. */
  61571. get captureInterFrameTime(): boolean;
  61572. /**
  61573. * Enable or disable the inter-frames time capture
  61574. */
  61575. set captureInterFrameTime(value: boolean);
  61576. /**
  61577. * Gets the perf counter used for render time capture
  61578. */
  61579. get renderTimeCounter(): PerfCounter;
  61580. /**
  61581. * Gets the render time capture status
  61582. */
  61583. get captureRenderTime(): boolean;
  61584. /**
  61585. * Enable or disable the render time capture
  61586. */
  61587. set captureRenderTime(value: boolean);
  61588. /**
  61589. * Gets the perf counter used for camera render time capture
  61590. */
  61591. get cameraRenderTimeCounter(): PerfCounter;
  61592. /**
  61593. * Gets the camera render time capture status
  61594. */
  61595. get captureCameraRenderTime(): boolean;
  61596. /**
  61597. * Enable or disable the camera render time capture
  61598. */
  61599. set captureCameraRenderTime(value: boolean);
  61600. /**
  61601. * Gets the perf counter used for draw calls
  61602. */
  61603. get drawCallsCounter(): PerfCounter;
  61604. /**
  61605. * Instantiates a new scene instrumentation.
  61606. * This class can be used to get instrumentation data from a Babylon engine
  61607. * @see https://doc.babylonjs.com/how_to/optimizing_your_scene#sceneinstrumentation
  61608. * @param scene Defines the scene to instrument
  61609. */
  61610. constructor(
  61611. /**
  61612. * Defines the scene to instrument
  61613. */
  61614. scene: Scene);
  61615. /**
  61616. * Dispose and release associated resources.
  61617. */
  61618. dispose(): void;
  61619. }
  61620. }
  61621. declare module "babylonjs/Instrumentation/index" {
  61622. export * from "babylonjs/Instrumentation/engineInstrumentation";
  61623. export * from "babylonjs/Instrumentation/sceneInstrumentation";
  61624. export * from "babylonjs/Instrumentation/timeToken";
  61625. }
  61626. declare module "babylonjs/Shaders/glowMapGeneration.fragment" {
  61627. /** @hidden */
  61628. export var glowMapGenerationPixelShader: {
  61629. name: string;
  61630. shader: string;
  61631. };
  61632. }
  61633. declare module "babylonjs/Shaders/glowMapGeneration.vertex" {
  61634. import "babylonjs/Shaders/ShadersInclude/bonesDeclaration";
  61635. import "babylonjs/Shaders/ShadersInclude/morphTargetsVertexGlobalDeclaration";
  61636. import "babylonjs/Shaders/ShadersInclude/morphTargetsVertexDeclaration";
  61637. import "babylonjs/Shaders/ShadersInclude/instancesDeclaration";
  61638. import "babylonjs/Shaders/ShadersInclude/morphTargetsVertex";
  61639. import "babylonjs/Shaders/ShadersInclude/instancesVertex";
  61640. import "babylonjs/Shaders/ShadersInclude/bonesVertex";
  61641. /** @hidden */
  61642. export var glowMapGenerationVertexShader: {
  61643. name: string;
  61644. shader: string;
  61645. };
  61646. }
  61647. declare module "babylonjs/Layers/effectLayer" {
  61648. import { Observable } from "babylonjs/Misc/observable";
  61649. import { Nullable } from "babylonjs/types";
  61650. import { Camera } from "babylonjs/Cameras/camera";
  61651. import { Scene } from "babylonjs/scene";
  61652. import { ISize } from "babylonjs/Maths/math.size";
  61653. import { Color4 } from "babylonjs/Maths/math.color";
  61654. import { Engine } from "babylonjs/Engines/engine";
  61655. import { SubMesh } from "babylonjs/Meshes/subMesh";
  61656. import { AbstractMesh } from "babylonjs/Meshes/abstractMesh";
  61657. import { Mesh } from "babylonjs/Meshes/mesh";
  61658. import { PostProcess } from "babylonjs/PostProcesses/postProcess";
  61659. import { BaseTexture } from "babylonjs/Materials/Textures/baseTexture";
  61660. import { RenderTargetTexture } from "babylonjs/Materials/Textures/renderTargetTexture";
  61661. import { Effect } from "babylonjs/Materials/effect";
  61662. import { Material } from "babylonjs/Materials/material";
  61663. import "babylonjs/Shaders/glowMapGeneration.fragment";
  61664. import "babylonjs/Shaders/glowMapGeneration.vertex";
  61665. /**
  61666. * Effect layer options. This helps customizing the behaviour
  61667. * of the effect layer.
  61668. */
  61669. export interface IEffectLayerOptions {
  61670. /**
  61671. * Multiplication factor apply to the canvas size to compute the render target size
  61672. * used to generated the objects (the smaller the faster).
  61673. */
  61674. mainTextureRatio: number;
  61675. /**
  61676. * Enforces a fixed size texture to ensure effect stability across devices.
  61677. */
  61678. mainTextureFixedSize?: number;
  61679. /**
  61680. * Alpha blending mode used to apply the blur. Default depends of the implementation.
  61681. */
  61682. alphaBlendingMode: number;
  61683. /**
  61684. * The camera attached to the layer.
  61685. */
  61686. camera: Nullable<Camera>;
  61687. /**
  61688. * The rendering group to draw the layer in.
  61689. */
  61690. renderingGroupId: number;
  61691. }
  61692. /**
  61693. * The effect layer Helps adding post process effect blended with the main pass.
  61694. *
  61695. * This can be for instance use to generate glow or higlight effects on the scene.
  61696. *
  61697. * The effect layer class can not be used directly and is intented to inherited from to be
  61698. * customized per effects.
  61699. */
  61700. export abstract class EffectLayer {
  61701. private _vertexBuffers;
  61702. private _indexBuffer;
  61703. private _cachedDefines;
  61704. private _effectLayerMapGenerationEffect;
  61705. private _effectLayerOptions;
  61706. private _mergeEffect;
  61707. protected _scene: Scene;
  61708. protected _engine: Engine;
  61709. protected _maxSize: number;
  61710. protected _mainTextureDesiredSize: ISize;
  61711. protected _mainTexture: RenderTargetTexture;
  61712. protected _shouldRender: boolean;
  61713. protected _postProcesses: PostProcess[];
  61714. protected _textures: BaseTexture[];
  61715. protected _emissiveTextureAndColor: {
  61716. texture: Nullable<BaseTexture>;
  61717. color: Color4;
  61718. };
  61719. /**
  61720. * The name of the layer
  61721. */
  61722. name: string;
  61723. /**
  61724. * The clear color of the texture used to generate the glow map.
  61725. */
  61726. neutralColor: Color4;
  61727. /**
  61728. * Specifies whether the highlight layer is enabled or not.
  61729. */
  61730. isEnabled: boolean;
  61731. /**
  61732. * Gets the camera attached to the layer.
  61733. */
  61734. get camera(): Nullable<Camera>;
  61735. /**
  61736. * Gets the rendering group id the layer should render in.
  61737. */
  61738. get renderingGroupId(): number;
  61739. set renderingGroupId(renderingGroupId: number);
  61740. /**
  61741. * An event triggered when the effect layer has been disposed.
  61742. */
  61743. onDisposeObservable: Observable<EffectLayer>;
  61744. /**
  61745. * An event triggered when the effect layer is about rendering the main texture with the glowy parts.
  61746. */
  61747. onBeforeRenderMainTextureObservable: Observable<EffectLayer>;
  61748. /**
  61749. * An event triggered when the generated texture is being merged in the scene.
  61750. */
  61751. onBeforeComposeObservable: Observable<EffectLayer>;
  61752. /**
  61753. * An event triggered when the mesh is rendered into the effect render target.
  61754. */
  61755. onBeforeRenderMeshToEffect: Observable<AbstractMesh>;
  61756. /**
  61757. * An event triggered after the mesh has been rendered into the effect render target.
  61758. */
  61759. onAfterRenderMeshToEffect: Observable<AbstractMesh>;
  61760. /**
  61761. * An event triggered when the generated texture has been merged in the scene.
  61762. */
  61763. onAfterComposeObservable: Observable<EffectLayer>;
  61764. /**
  61765. * An event triggered when the efffect layer changes its size.
  61766. */
  61767. onSizeChangedObservable: Observable<EffectLayer>;
  61768. /** @hidden */
  61769. static _SceneComponentInitialization: (scene: Scene) => void;
  61770. /**
  61771. * Instantiates a new effect Layer and references it in the scene.
  61772. * @param name The name of the layer
  61773. * @param scene The scene to use the layer in
  61774. */
  61775. constructor(
  61776. /** The Friendly of the effect in the scene */
  61777. name: string, scene: Scene);
  61778. /**
  61779. * Get the effect name of the layer.
  61780. * @return The effect name
  61781. */
  61782. abstract getEffectName(): string;
  61783. /**
  61784. * Checks for the readiness of the element composing the layer.
  61785. * @param subMesh the mesh to check for
  61786. * @param useInstances specify whether or not to use instances to render the mesh
  61787. * @return true if ready otherwise, false
  61788. */
  61789. abstract isReady(subMesh: SubMesh, useInstances: boolean): boolean;
  61790. /**
  61791. * Returns whether or nood the layer needs stencil enabled during the mesh rendering.
  61792. * @returns true if the effect requires stencil during the main canvas render pass.
  61793. */
  61794. abstract needStencil(): boolean;
  61795. /**
  61796. * Create the merge effect. This is the shader use to blit the information back
  61797. * to the main canvas at the end of the scene rendering.
  61798. * @returns The effect containing the shader used to merge the effect on the main canvas
  61799. */
  61800. protected abstract _createMergeEffect(): Effect;
  61801. /**
  61802. * Creates the render target textures and post processes used in the effect layer.
  61803. */
  61804. protected abstract _createTextureAndPostProcesses(): void;
  61805. /**
  61806. * Implementation specific of rendering the generating effect on the main canvas.
  61807. * @param effect The effect used to render through
  61808. */
  61809. protected abstract _internalRender(effect: Effect): void;
  61810. /**
  61811. * Sets the required values for both the emissive texture and and the main color.
  61812. */
  61813. protected abstract _setEmissiveTextureAndColor(mesh: Mesh, subMesh: SubMesh, material: Material): void;
  61814. /**
  61815. * Free any resources and references associated to a mesh.
  61816. * Internal use
  61817. * @param mesh The mesh to free.
  61818. */
  61819. abstract _disposeMesh(mesh: Mesh): void;
  61820. /**
  61821. * Serializes this layer (Glow or Highlight for example)
  61822. * @returns a serialized layer object
  61823. */
  61824. abstract serialize?(): any;
  61825. /**
  61826. * Initializes the effect layer with the required options.
  61827. * @param options Sets of none mandatory options to use with the layer (see IEffectLayerOptions for more information)
  61828. */
  61829. protected _init(options: Partial<IEffectLayerOptions>): void;
  61830. /**
  61831. * Generates the index buffer of the full screen quad blending to the main canvas.
  61832. */
  61833. private _generateIndexBuffer;
  61834. /**
  61835. * Generates the vertex buffer of the full screen quad blending to the main canvas.
  61836. */
  61837. private _generateVertexBuffer;
  61838. /**
  61839. * Sets the main texture desired size which is the closest power of two
  61840. * of the engine canvas size.
  61841. */
  61842. private _setMainTextureSize;
  61843. /**
  61844. * Creates the main texture for the effect layer.
  61845. */
  61846. protected _createMainTexture(): void;
  61847. /**
  61848. * Adds specific effects defines.
  61849. * @param defines The defines to add specifics to.
  61850. */
  61851. protected _addCustomEffectDefines(defines: string[]): void;
  61852. /**
  61853. * Checks for the readiness of the element composing the layer.
  61854. * @param subMesh the mesh to check for
  61855. * @param useInstances specify whether or not to use instances to render the mesh
  61856. * @param emissiveTexture the associated emissive texture used to generate the glow
  61857. * @return true if ready otherwise, false
  61858. */
  61859. protected _isReady(subMesh: SubMesh, useInstances: boolean, emissiveTexture: Nullable<BaseTexture>): boolean;
  61860. /**
  61861. * Renders the glowing part of the scene by blending the blurred glowing meshes on top of the rendered scene.
  61862. */
  61863. render(): void;
  61864. /**
  61865. * Determine if a given mesh will be used in the current effect.
  61866. * @param mesh mesh to test
  61867. * @returns true if the mesh will be used
  61868. */
  61869. hasMesh(mesh: AbstractMesh): boolean;
  61870. /**
  61871. * Returns true if the layer contains information to display, otherwise false.
  61872. * @returns true if the glow layer should be rendered
  61873. */
  61874. shouldRender(): boolean;
  61875. /**
  61876. * Returns true if the mesh should render, otherwise false.
  61877. * @param mesh The mesh to render
  61878. * @returns true if it should render otherwise false
  61879. */
  61880. protected _shouldRenderMesh(mesh: AbstractMesh): boolean;
  61881. /**
  61882. * Returns true if the mesh can be rendered, otherwise false.
  61883. * @param mesh The mesh to render
  61884. * @param material The material used on the mesh
  61885. * @returns true if it can be rendered otherwise false
  61886. */
  61887. protected _canRenderMesh(mesh: AbstractMesh, material: Material): boolean;
  61888. /**
  61889. * Returns true if the mesh should render, otherwise false.
  61890. * @param mesh The mesh to render
  61891. * @returns true if it should render otherwise false
  61892. */
  61893. protected _shouldRenderEmissiveTextureForMesh(): boolean;
  61894. /**
  61895. * Renders the submesh passed in parameter to the generation map.
  61896. */
  61897. protected _renderSubMesh(subMesh: SubMesh, enableAlphaMode?: boolean): void;
  61898. /**
  61899. * Defines whether the current material of the mesh should be use to render the effect.
  61900. * @param mesh defines the current mesh to render
  61901. */
  61902. protected _useMeshMaterial(mesh: AbstractMesh): boolean;
  61903. /**
  61904. * Rebuild the required buffers.
  61905. * @hidden Internal use only.
  61906. */
  61907. _rebuild(): void;
  61908. /**
  61909. * Dispose only the render target textures and post process.
  61910. */
  61911. private _disposeTextureAndPostProcesses;
  61912. /**
  61913. * Dispose the highlight layer and free resources.
  61914. */
  61915. dispose(): void;
  61916. /**
  61917. * Gets the class name of the effect layer
  61918. * @returns the string with the class name of the effect layer
  61919. */
  61920. getClassName(): string;
  61921. /**
  61922. * Creates an effect layer from parsed effect layer data
  61923. * @param parsedEffectLayer defines effect layer data
  61924. * @param scene defines the current scene
  61925. * @param rootUrl defines the root URL containing the effect layer information
  61926. * @returns a parsed effect Layer
  61927. */
  61928. static Parse(parsedEffectLayer: any, scene: Scene, rootUrl: string): EffectLayer;
  61929. }
  61930. }
  61931. declare module "babylonjs/Layers/effectLayerSceneComponent" {
  61932. import { Scene } from "babylonjs/scene";
  61933. import { ISceneSerializableComponent } from "babylonjs/sceneComponent";
  61934. import { EffectLayer } from "babylonjs/Layers/effectLayer";
  61935. import { AbstractScene } from "babylonjs/abstractScene";
  61936. module "babylonjs/abstractScene" {
  61937. interface AbstractScene {
  61938. /**
  61939. * The list of effect layers (highlights/glow) added to the scene
  61940. * @see https://doc.babylonjs.com/how_to/highlight_layer
  61941. * @see https://doc.babylonjs.com/how_to/glow_layer
  61942. */
  61943. effectLayers: Array<EffectLayer>;
  61944. /**
  61945. * Removes the given effect layer from this scene.
  61946. * @param toRemove defines the effect layer to remove
  61947. * @returns the index of the removed effect layer
  61948. */
  61949. removeEffectLayer(toRemove: EffectLayer): number;
  61950. /**
  61951. * Adds the given effect layer to this scene
  61952. * @param newEffectLayer defines the effect layer to add
  61953. */
  61954. addEffectLayer(newEffectLayer: EffectLayer): void;
  61955. }
  61956. }
  61957. /**
  61958. * Defines the layer scene component responsible to manage any effect layers
  61959. * in a given scene.
  61960. */
  61961. export class EffectLayerSceneComponent implements ISceneSerializableComponent {
  61962. /**
  61963. * The component name helpfull to identify the component in the list of scene components.
  61964. */
  61965. readonly name: string;
  61966. /**
  61967. * The scene the component belongs to.
  61968. */
  61969. scene: Scene;
  61970. private _engine;
  61971. private _renderEffects;
  61972. private _needStencil;
  61973. private _previousStencilState;
  61974. /**
  61975. * Creates a new instance of the component for the given scene
  61976. * @param scene Defines the scene to register the component in
  61977. */
  61978. constructor(scene: Scene);
  61979. /**
  61980. * Registers the component in a given scene
  61981. */
  61982. register(): void;
  61983. /**
  61984. * Rebuilds the elements related to this component in case of
  61985. * context lost for instance.
  61986. */
  61987. rebuild(): void;
  61988. /**
  61989. * Serializes the component data to the specified json object
  61990. * @param serializationObject The object to serialize to
  61991. */
  61992. serialize(serializationObject: any): void;
  61993. /**
  61994. * Adds all the elements from the container to the scene
  61995. * @param container the container holding the elements
  61996. */
  61997. addFromContainer(container: AbstractScene): void;
  61998. /**
  61999. * Removes all the elements in the container from the scene
  62000. * @param container contains the elements to remove
  62001. * @param dispose if the removed element should be disposed (default: false)
  62002. */
  62003. removeFromContainer(container: AbstractScene, dispose?: boolean): void;
  62004. /**
  62005. * Disposes the component and the associated ressources.
  62006. */
  62007. dispose(): void;
  62008. private _isReadyForMesh;
  62009. private _renderMainTexture;
  62010. private _setStencil;
  62011. private _setStencilBack;
  62012. private _draw;
  62013. private _drawCamera;
  62014. private _drawRenderingGroup;
  62015. }
  62016. }
  62017. declare module "babylonjs/Shaders/glowMapMerge.fragment" {
  62018. /** @hidden */
  62019. export var glowMapMergePixelShader: {
  62020. name: string;
  62021. shader: string;
  62022. };
  62023. }
  62024. declare module "babylonjs/Shaders/glowMapMerge.vertex" {
  62025. /** @hidden */
  62026. export var glowMapMergeVertexShader: {
  62027. name: string;
  62028. shader: string;
  62029. };
  62030. }
  62031. declare module "babylonjs/Layers/glowLayer" {
  62032. import { Nullable } from "babylonjs/types";
  62033. import { Camera } from "babylonjs/Cameras/camera";
  62034. import { Scene } from "babylonjs/scene";
  62035. import { SubMesh } from "babylonjs/Meshes/subMesh";
  62036. import { AbstractMesh } from "babylonjs/Meshes/abstractMesh";
  62037. import { Mesh } from "babylonjs/Meshes/mesh";
  62038. import { Texture } from "babylonjs/Materials/Textures/texture";
  62039. import { Effect } from "babylonjs/Materials/effect";
  62040. import { Material } from "babylonjs/Materials/material";
  62041. import { EffectLayer } from "babylonjs/Layers/effectLayer";
  62042. import { Color4 } from "babylonjs/Maths/math.color";
  62043. import "babylonjs/Shaders/glowMapMerge.fragment";
  62044. import "babylonjs/Shaders/glowMapMerge.vertex";
  62045. import "babylonjs/Layers/effectLayerSceneComponent";
  62046. module "babylonjs/abstractScene" {
  62047. interface AbstractScene {
  62048. /**
  62049. * Return a the first highlight layer of the scene with a given name.
  62050. * @param name The name of the highlight layer to look for.
  62051. * @return The highlight layer if found otherwise null.
  62052. */
  62053. getGlowLayerByName(name: string): Nullable<GlowLayer>;
  62054. }
  62055. }
  62056. /**
  62057. * Glow layer options. This helps customizing the behaviour
  62058. * of the glow layer.
  62059. */
  62060. export interface IGlowLayerOptions {
  62061. /**
  62062. * Multiplication factor apply to the canvas size to compute the render target size
  62063. * used to generated the glowing objects (the smaller the faster).
  62064. */
  62065. mainTextureRatio: number;
  62066. /**
  62067. * Enforces a fixed size texture to ensure resize independant blur.
  62068. */
  62069. mainTextureFixedSize?: number;
  62070. /**
  62071. * How big is the kernel of the blur texture.
  62072. */
  62073. blurKernelSize: number;
  62074. /**
  62075. * The camera attached to the layer.
  62076. */
  62077. camera: Nullable<Camera>;
  62078. /**
  62079. * Enable MSAA by chosing the number of samples.
  62080. */
  62081. mainTextureSamples?: number;
  62082. /**
  62083. * The rendering group to draw the layer in.
  62084. */
  62085. renderingGroupId: number;
  62086. }
  62087. /**
  62088. * The glow layer Helps adding a glow effect around the emissive parts of a mesh.
  62089. *
  62090. * Once instantiated in a scene, by default, all the emissive meshes will glow.
  62091. *
  62092. * Documentation: https://doc.babylonjs.com/how_to/glow_layer
  62093. */
  62094. export class GlowLayer extends EffectLayer {
  62095. /**
  62096. * Effect Name of the layer.
  62097. */
  62098. static readonly EffectName: string;
  62099. /**
  62100. * The default blur kernel size used for the glow.
  62101. */
  62102. static DefaultBlurKernelSize: number;
  62103. /**
  62104. * The default texture size ratio used for the glow.
  62105. */
  62106. static DefaultTextureRatio: number;
  62107. /**
  62108. * Sets the kernel size of the blur.
  62109. */
  62110. set blurKernelSize(value: number);
  62111. /**
  62112. * Gets the kernel size of the blur.
  62113. */
  62114. get blurKernelSize(): number;
  62115. /**
  62116. * Sets the glow intensity.
  62117. */
  62118. set intensity(value: number);
  62119. /**
  62120. * Gets the glow intensity.
  62121. */
  62122. get intensity(): number;
  62123. private _options;
  62124. private _intensity;
  62125. private _horizontalBlurPostprocess1;
  62126. private _verticalBlurPostprocess1;
  62127. private _horizontalBlurPostprocess2;
  62128. private _verticalBlurPostprocess2;
  62129. private _blurTexture1;
  62130. private _blurTexture2;
  62131. private _postProcesses1;
  62132. private _postProcesses2;
  62133. private _includedOnlyMeshes;
  62134. private _excludedMeshes;
  62135. private _meshesUsingTheirOwnMaterials;
  62136. /**
  62137. * Callback used to let the user override the color selection on a per mesh basis
  62138. */
  62139. customEmissiveColorSelector: (mesh: Mesh, subMesh: SubMesh, material: Material, result: Color4) => void;
  62140. /**
  62141. * Callback used to let the user override the texture selection on a per mesh basis
  62142. */
  62143. customEmissiveTextureSelector: (mesh: Mesh, subMesh: SubMesh, material: Material) => Texture;
  62144. /**
  62145. * Instantiates a new glow Layer and references it to the scene.
  62146. * @param name The name of the layer
  62147. * @param scene The scene to use the layer in
  62148. * @param options Sets of none mandatory options to use with the layer (see IGlowLayerOptions for more information)
  62149. */
  62150. constructor(name: string, scene: Scene, options?: Partial<IGlowLayerOptions>);
  62151. /**
  62152. * Get the effect name of the layer.
  62153. * @return The effect name
  62154. */
  62155. getEffectName(): string;
  62156. /**
  62157. * Create the merge effect. This is the shader use to blit the information back
  62158. * to the main canvas at the end of the scene rendering.
  62159. */
  62160. protected _createMergeEffect(): Effect;
  62161. /**
  62162. * Creates the render target textures and post processes used in the glow layer.
  62163. */
  62164. protected _createTextureAndPostProcesses(): void;
  62165. /**
  62166. * Checks for the readiness of the element composing the layer.
  62167. * @param subMesh the mesh to check for
  62168. * @param useInstances specify wether or not to use instances to render the mesh
  62169. * @param emissiveTexture the associated emissive texture used to generate the glow
  62170. * @return true if ready otherwise, false
  62171. */
  62172. isReady(subMesh: SubMesh, useInstances: boolean): boolean;
  62173. /**
  62174. * Returns whether or nood the layer needs stencil enabled during the mesh rendering.
  62175. */
  62176. needStencil(): boolean;
  62177. /**
  62178. * Returns true if the mesh can be rendered, otherwise false.
  62179. * @param mesh The mesh to render
  62180. * @param material The material used on the mesh
  62181. * @returns true if it can be rendered otherwise false
  62182. */
  62183. protected _canRenderMesh(mesh: AbstractMesh, material: Material): boolean;
  62184. /**
  62185. * Implementation specific of rendering the generating effect on the main canvas.
  62186. * @param effect The effect used to render through
  62187. */
  62188. protected _internalRender(effect: Effect): void;
  62189. /**
  62190. * Sets the required values for both the emissive texture and and the main color.
  62191. */
  62192. protected _setEmissiveTextureAndColor(mesh: Mesh, subMesh: SubMesh, material: Material): void;
  62193. /**
  62194. * Returns true if the mesh should render, otherwise false.
  62195. * @param mesh The mesh to render
  62196. * @returns true if it should render otherwise false
  62197. */
  62198. protected _shouldRenderMesh(mesh: Mesh): boolean;
  62199. /**
  62200. * Adds specific effects defines.
  62201. * @param defines The defines to add specifics to.
  62202. */
  62203. protected _addCustomEffectDefines(defines: string[]): void;
  62204. /**
  62205. * Add a mesh in the exclusion list to prevent it to impact or being impacted by the glow layer.
  62206. * @param mesh The mesh to exclude from the glow layer
  62207. */
  62208. addExcludedMesh(mesh: Mesh): void;
  62209. /**
  62210. * Remove a mesh from the exclusion list to let it impact or being impacted by the glow layer.
  62211. * @param mesh The mesh to remove
  62212. */
  62213. removeExcludedMesh(mesh: Mesh): void;
  62214. /**
  62215. * Add a mesh in the inclusion list to impact or being impacted by the glow layer.
  62216. * @param mesh The mesh to include in the glow layer
  62217. */
  62218. addIncludedOnlyMesh(mesh: Mesh): void;
  62219. /**
  62220. * Remove a mesh from the Inclusion list to prevent it to impact or being impacted by the glow layer.
  62221. * @param mesh The mesh to remove
  62222. */
  62223. removeIncludedOnlyMesh(mesh: Mesh): void;
  62224. /**
  62225. * Determine if a given mesh will be used in the glow layer
  62226. * @param mesh The mesh to test
  62227. * @returns true if the mesh will be highlighted by the current glow layer
  62228. */
  62229. hasMesh(mesh: AbstractMesh): boolean;
  62230. /**
  62231. * Defines whether the current material of the mesh should be use to render the effect.
  62232. * @param mesh defines the current mesh to render
  62233. */
  62234. protected _useMeshMaterial(mesh: AbstractMesh): boolean;
  62235. /**
  62236. * Add a mesh to be rendered through its own material and not with emissive only.
  62237. * @param mesh The mesh for which we need to use its material
  62238. */
  62239. referenceMeshToUseItsOwnMaterial(mesh: AbstractMesh): void;
  62240. /**
  62241. * Remove a mesh from being rendered through its own material and not with emissive only.
  62242. * @param mesh The mesh for which we need to not use its material
  62243. */
  62244. unReferenceMeshFromUsingItsOwnMaterial(mesh: AbstractMesh): void;
  62245. /**
  62246. * Free any resources and references associated to a mesh.
  62247. * Internal use
  62248. * @param mesh The mesh to free.
  62249. * @hidden
  62250. */
  62251. _disposeMesh(mesh: Mesh): void;
  62252. /**
  62253. * Gets the class name of the effect layer
  62254. * @returns the string with the class name of the effect layer
  62255. */
  62256. getClassName(): string;
  62257. /**
  62258. * Serializes this glow layer
  62259. * @returns a serialized glow layer object
  62260. */
  62261. serialize(): any;
  62262. /**
  62263. * Creates a Glow Layer from parsed glow layer data
  62264. * @param parsedGlowLayer defines glow layer data
  62265. * @param scene defines the current scene
  62266. * @param rootUrl defines the root URL containing the glow layer information
  62267. * @returns a parsed Glow Layer
  62268. */
  62269. static Parse(parsedGlowLayer: any, scene: Scene, rootUrl: string): GlowLayer;
  62270. }
  62271. }
  62272. declare module "babylonjs/Shaders/glowBlurPostProcess.fragment" {
  62273. /** @hidden */
  62274. export var glowBlurPostProcessPixelShader: {
  62275. name: string;
  62276. shader: string;
  62277. };
  62278. }
  62279. declare module "babylonjs/Layers/highlightLayer" {
  62280. import { Observable } from "babylonjs/Misc/observable";
  62281. import { Nullable } from "babylonjs/types";
  62282. import { Camera } from "babylonjs/Cameras/camera";
  62283. import { Scene } from "babylonjs/scene";
  62284. import { SubMesh } from "babylonjs/Meshes/subMesh";
  62285. import { AbstractMesh } from "babylonjs/Meshes/abstractMesh";
  62286. import { Mesh } from "babylonjs/Meshes/mesh";
  62287. import { Effect } from "babylonjs/Materials/effect";
  62288. import { Material } from "babylonjs/Materials/material";
  62289. import { EffectLayer } from "babylonjs/Layers/effectLayer";
  62290. import { Color4, Color3 } from "babylonjs/Maths/math.color";
  62291. import "babylonjs/Shaders/glowMapMerge.fragment";
  62292. import "babylonjs/Shaders/glowMapMerge.vertex";
  62293. import "babylonjs/Shaders/glowBlurPostProcess.fragment";
  62294. module "babylonjs/abstractScene" {
  62295. interface AbstractScene {
  62296. /**
  62297. * Return a the first highlight layer of the scene with a given name.
  62298. * @param name The name of the highlight layer to look for.
  62299. * @return The highlight layer if found otherwise null.
  62300. */
  62301. getHighlightLayerByName(name: string): Nullable<HighlightLayer>;
  62302. }
  62303. }
  62304. /**
  62305. * Highlight layer options. This helps customizing the behaviour
  62306. * of the highlight layer.
  62307. */
  62308. export interface IHighlightLayerOptions {
  62309. /**
  62310. * Multiplication factor apply to the canvas size to compute the render target size
  62311. * used to generated the glowing objects (the smaller the faster).
  62312. */
  62313. mainTextureRatio: number;
  62314. /**
  62315. * Enforces a fixed size texture to ensure resize independant blur.
  62316. */
  62317. mainTextureFixedSize?: number;
  62318. /**
  62319. * Multiplication factor apply to the main texture size in the first step of the blur to reduce the size
  62320. * of the picture to blur (the smaller the faster).
  62321. */
  62322. blurTextureSizeRatio: number;
  62323. /**
  62324. * How big in texel of the blur texture is the vertical blur.
  62325. */
  62326. blurVerticalSize: number;
  62327. /**
  62328. * How big in texel of the blur texture is the horizontal blur.
  62329. */
  62330. blurHorizontalSize: number;
  62331. /**
  62332. * Alpha blending mode used to apply the blur. Default is combine.
  62333. */
  62334. alphaBlendingMode: number;
  62335. /**
  62336. * The camera attached to the layer.
  62337. */
  62338. camera: Nullable<Camera>;
  62339. /**
  62340. * Should we display highlight as a solid stroke?
  62341. */
  62342. isStroke?: boolean;
  62343. /**
  62344. * The rendering group to draw the layer in.
  62345. */
  62346. renderingGroupId: number;
  62347. }
  62348. /**
  62349. * The highlight layer Helps adding a glow effect around a mesh.
  62350. *
  62351. * Once instantiated in a scene, simply use the addMesh or removeMesh method to add or remove
  62352. * glowy meshes to your scene.
  62353. *
  62354. * !!! THIS REQUIRES AN ACTIVE STENCIL BUFFER ON THE CANVAS !!!
  62355. */
  62356. export class HighlightLayer extends EffectLayer {
  62357. name: string;
  62358. /**
  62359. * Effect Name of the highlight layer.
  62360. */
  62361. static readonly EffectName: string;
  62362. /**
  62363. * The neutral color used during the preparation of the glow effect.
  62364. * This is black by default as the blend operation is a blend operation.
  62365. */
  62366. static NeutralColor: Color4;
  62367. /**
  62368. * Stencil value used for glowing meshes.
  62369. */
  62370. static GlowingMeshStencilReference: number;
  62371. /**
  62372. * Stencil value used for the other meshes in the scene.
  62373. */
  62374. static NormalMeshStencilReference: number;
  62375. /**
  62376. * Specifies whether or not the inner glow is ACTIVE in the layer.
  62377. */
  62378. innerGlow: boolean;
  62379. /**
  62380. * Specifies whether or not the outer glow is ACTIVE in the layer.
  62381. */
  62382. outerGlow: boolean;
  62383. /**
  62384. * Specifies the horizontal size of the blur.
  62385. */
  62386. set blurHorizontalSize(value: number);
  62387. /**
  62388. * Specifies the vertical size of the blur.
  62389. */
  62390. set blurVerticalSize(value: number);
  62391. /**
  62392. * Gets the horizontal size of the blur.
  62393. */
  62394. get blurHorizontalSize(): number;
  62395. /**
  62396. * Gets the vertical size of the blur.
  62397. */
  62398. get blurVerticalSize(): number;
  62399. /**
  62400. * An event triggered when the highlight layer is being blurred.
  62401. */
  62402. onBeforeBlurObservable: Observable<HighlightLayer>;
  62403. /**
  62404. * An event triggered when the highlight layer has been blurred.
  62405. */
  62406. onAfterBlurObservable: Observable<HighlightLayer>;
  62407. private _instanceGlowingMeshStencilReference;
  62408. private _options;
  62409. private _downSamplePostprocess;
  62410. private _horizontalBlurPostprocess;
  62411. private _verticalBlurPostprocess;
  62412. private _blurTexture;
  62413. private _meshes;
  62414. private _excludedMeshes;
  62415. /**
  62416. * Instantiates a new highlight Layer and references it to the scene..
  62417. * @param name The name of the layer
  62418. * @param scene The scene to use the layer in
  62419. * @param options Sets of none mandatory options to use with the layer (see IHighlightLayerOptions for more information)
  62420. */
  62421. constructor(name: string, scene: Scene, options?: Partial<IHighlightLayerOptions>);
  62422. /**
  62423. * Get the effect name of the layer.
  62424. * @return The effect name
  62425. */
  62426. getEffectName(): string;
  62427. /**
  62428. * Create the merge effect. This is the shader use to blit the information back
  62429. * to the main canvas at the end of the scene rendering.
  62430. */
  62431. protected _createMergeEffect(): Effect;
  62432. /**
  62433. * Creates the render target textures and post processes used in the highlight layer.
  62434. */
  62435. protected _createTextureAndPostProcesses(): void;
  62436. /**
  62437. * Returns wether or nood the layer needs stencil enabled during the mesh rendering.
  62438. */
  62439. needStencil(): boolean;
  62440. /**
  62441. * Checks for the readiness of the element composing the layer.
  62442. * @param subMesh the mesh to check for
  62443. * @param useInstances specify wether or not to use instances to render the mesh
  62444. * @param emissiveTexture the associated emissive texture used to generate the glow
  62445. * @return true if ready otherwise, false
  62446. */
  62447. isReady(subMesh: SubMesh, useInstances: boolean): boolean;
  62448. /**
  62449. * Implementation specific of rendering the generating effect on the main canvas.
  62450. * @param effect The effect used to render through
  62451. */
  62452. protected _internalRender(effect: Effect): void;
  62453. /**
  62454. * Returns true if the layer contains information to display, otherwise false.
  62455. */
  62456. shouldRender(): boolean;
  62457. /**
  62458. * Returns true if the mesh should render, otherwise false.
  62459. * @param mesh The mesh to render
  62460. * @returns true if it should render otherwise false
  62461. */
  62462. protected _shouldRenderMesh(mesh: Mesh): boolean;
  62463. /**
  62464. * Returns true if the mesh can be rendered, otherwise false.
  62465. * @param mesh The mesh to render
  62466. * @param material The material used on the mesh
  62467. * @returns true if it can be rendered otherwise false
  62468. */
  62469. protected _canRenderMesh(mesh: AbstractMesh, material: Material): boolean;
  62470. /**
  62471. * Adds specific effects defines.
  62472. * @param defines The defines to add specifics to.
  62473. */
  62474. protected _addCustomEffectDefines(defines: string[]): void;
  62475. /**
  62476. * Sets the required values for both the emissive texture and and the main color.
  62477. */
  62478. protected _setEmissiveTextureAndColor(mesh: Mesh, subMesh: SubMesh, material: Material): void;
  62479. /**
  62480. * Add a mesh in the exclusion list to prevent it to impact or being impacted by the highlight layer.
  62481. * @param mesh The mesh to exclude from the highlight layer
  62482. */
  62483. addExcludedMesh(mesh: Mesh): void;
  62484. /**
  62485. * Remove a mesh from the exclusion list to let it impact or being impacted by the highlight layer.
  62486. * @param mesh The mesh to highlight
  62487. */
  62488. removeExcludedMesh(mesh: Mesh): void;
  62489. /**
  62490. * Determine if a given mesh will be highlighted by the current HighlightLayer
  62491. * @param mesh mesh to test
  62492. * @returns true if the mesh will be highlighted by the current HighlightLayer
  62493. */
  62494. hasMesh(mesh: AbstractMesh): boolean;
  62495. /**
  62496. * Add a mesh in the highlight layer in order to make it glow with the chosen color.
  62497. * @param mesh The mesh to highlight
  62498. * @param color The color of the highlight
  62499. * @param glowEmissiveOnly Extract the glow from the emissive texture
  62500. */
  62501. addMesh(mesh: Mesh, color: Color3, glowEmissiveOnly?: boolean): void;
  62502. /**
  62503. * Remove a mesh from the highlight layer in order to make it stop glowing.
  62504. * @param mesh The mesh to highlight
  62505. */
  62506. removeMesh(mesh: Mesh): void;
  62507. /**
  62508. * Remove all the meshes currently referenced in the highlight layer
  62509. */
  62510. removeAllMeshes(): void;
  62511. /**
  62512. * Force the stencil to the normal expected value for none glowing parts
  62513. */
  62514. private _defaultStencilReference;
  62515. /**
  62516. * Free any resources and references associated to a mesh.
  62517. * Internal use
  62518. * @param mesh The mesh to free.
  62519. * @hidden
  62520. */
  62521. _disposeMesh(mesh: Mesh): void;
  62522. /**
  62523. * Dispose the highlight layer and free resources.
  62524. */
  62525. dispose(): void;
  62526. /**
  62527. * Gets the class name of the effect layer
  62528. * @returns the string with the class name of the effect layer
  62529. */
  62530. getClassName(): string;
  62531. /**
  62532. * Serializes this Highlight layer
  62533. * @returns a serialized Highlight layer object
  62534. */
  62535. serialize(): any;
  62536. /**
  62537. * Creates a Highlight layer from parsed Highlight layer data
  62538. * @param parsedHightlightLayer defines the Highlight layer data
  62539. * @param scene defines the current scene
  62540. * @param rootUrl defines the root URL containing the Highlight layer information
  62541. * @returns a parsed Highlight layer
  62542. */
  62543. static Parse(parsedHightlightLayer: any, scene: Scene, rootUrl: string): HighlightLayer;
  62544. }
  62545. }
  62546. declare module "babylonjs/Layers/layerSceneComponent" {
  62547. import { Scene } from "babylonjs/scene";
  62548. import { ISceneComponent } from "babylonjs/sceneComponent";
  62549. import { Layer } from "babylonjs/Layers/layer";
  62550. import { AbstractScene } from "babylonjs/abstractScene";
  62551. module "babylonjs/abstractScene" {
  62552. interface AbstractScene {
  62553. /**
  62554. * The list of layers (background and foreground) of the scene
  62555. */
  62556. layers: Array<Layer>;
  62557. }
  62558. }
  62559. /**
  62560. * Defines the layer scene component responsible to manage any layers
  62561. * in a given scene.
  62562. */
  62563. export class LayerSceneComponent implements ISceneComponent {
  62564. /**
  62565. * The component name helpfull to identify the component in the list of scene components.
  62566. */
  62567. readonly name: string;
  62568. /**
  62569. * The scene the component belongs to.
  62570. */
  62571. scene: Scene;
  62572. private _engine;
  62573. /**
  62574. * Creates a new instance of the component for the given scene
  62575. * @param scene Defines the scene to register the component in
  62576. */
  62577. constructor(scene: Scene);
  62578. /**
  62579. * Registers the component in a given scene
  62580. */
  62581. register(): void;
  62582. /**
  62583. * Rebuilds the elements related to this component in case of
  62584. * context lost for instance.
  62585. */
  62586. rebuild(): void;
  62587. /**
  62588. * Disposes the component and the associated ressources.
  62589. */
  62590. dispose(): void;
  62591. private _draw;
  62592. private _drawCameraPredicate;
  62593. private _drawCameraBackground;
  62594. private _drawCameraForeground;
  62595. private _drawRenderTargetPredicate;
  62596. private _drawRenderTargetBackground;
  62597. private _drawRenderTargetForeground;
  62598. /**
  62599. * Adds all the elements from the container to the scene
  62600. * @param container the container holding the elements
  62601. */
  62602. addFromContainer(container: AbstractScene): void;
  62603. /**
  62604. * Removes all the elements in the container from the scene
  62605. * @param container contains the elements to remove
  62606. * @param dispose if the removed element should be disposed (default: false)
  62607. */
  62608. removeFromContainer(container: AbstractScene, dispose?: boolean): void;
  62609. }
  62610. }
  62611. declare module "babylonjs/Shaders/layer.fragment" {
  62612. import "babylonjs/Shaders/ShadersInclude/helperFunctions";
  62613. /** @hidden */
  62614. export var layerPixelShader: {
  62615. name: string;
  62616. shader: string;
  62617. };
  62618. }
  62619. declare module "babylonjs/Shaders/layer.vertex" {
  62620. /** @hidden */
  62621. export var layerVertexShader: {
  62622. name: string;
  62623. shader: string;
  62624. };
  62625. }
  62626. declare module "babylonjs/Layers/layer" {
  62627. import { Observable } from "babylonjs/Misc/observable";
  62628. import { Nullable } from "babylonjs/types";
  62629. import { Scene } from "babylonjs/scene";
  62630. import { Vector2 } from "babylonjs/Maths/math.vector";
  62631. import { Color4 } from "babylonjs/Maths/math.color";
  62632. import { Texture } from "babylonjs/Materials/Textures/texture";
  62633. import { RenderTargetTexture } from "babylonjs/Materials/Textures/renderTargetTexture";
  62634. import "babylonjs/Shaders/layer.fragment";
  62635. import "babylonjs/Shaders/layer.vertex";
  62636. /**
  62637. * This represents a full screen 2d layer.
  62638. * This can be useful to display a picture in the background of your scene for instance.
  62639. * @see https://www.babylonjs-playground.com/#08A2BS#1
  62640. */
  62641. export class Layer {
  62642. /**
  62643. * Define the name of the layer.
  62644. */
  62645. name: string;
  62646. /**
  62647. * Define the texture the layer should display.
  62648. */
  62649. texture: Nullable<Texture>;
  62650. /**
  62651. * Is the layer in background or foreground.
  62652. */
  62653. isBackground: boolean;
  62654. /**
  62655. * Define the color of the layer (instead of texture).
  62656. */
  62657. color: Color4;
  62658. /**
  62659. * Define the scale of the layer in order to zoom in out of the texture.
  62660. */
  62661. scale: Vector2;
  62662. /**
  62663. * Define an offset for the layer in order to shift the texture.
  62664. */
  62665. offset: Vector2;
  62666. /**
  62667. * Define the alpha blending mode used in the layer in case the texture or color has an alpha.
  62668. */
  62669. alphaBlendingMode: number;
  62670. /**
  62671. * Define if the layer should alpha test or alpha blend with the rest of the scene.
  62672. * Alpha test will not mix with the background color in case of transparency.
  62673. * It will either use the texture color or the background depending on the alpha value of the current pixel.
  62674. */
  62675. alphaTest: boolean;
  62676. /**
  62677. * Define a mask to restrict the layer to only some of the scene cameras.
  62678. */
  62679. layerMask: number;
  62680. /**
  62681. * Define the list of render target the layer is visible into.
  62682. */
  62683. renderTargetTextures: RenderTargetTexture[];
  62684. /**
  62685. * Define if the layer is only used in renderTarget or if it also
  62686. * renders in the main frame buffer of the canvas.
  62687. */
  62688. renderOnlyInRenderTargetTextures: boolean;
  62689. private _scene;
  62690. private _vertexBuffers;
  62691. private _indexBuffer;
  62692. private _effect;
  62693. private _previousDefines;
  62694. /**
  62695. * An event triggered when the layer is disposed.
  62696. */
  62697. onDisposeObservable: Observable<Layer>;
  62698. private _onDisposeObserver;
  62699. /**
  62700. * Back compatibility with callback before the onDisposeObservable existed.
  62701. * The set callback will be triggered when the layer has been disposed.
  62702. */
  62703. set onDispose(callback: () => void);
  62704. /**
  62705. * An event triggered before rendering the scene
  62706. */
  62707. onBeforeRenderObservable: Observable<Layer>;
  62708. private _onBeforeRenderObserver;
  62709. /**
  62710. * Back compatibility with callback before the onBeforeRenderObservable existed.
  62711. * The set callback will be triggered just before rendering the layer.
  62712. */
  62713. set onBeforeRender(callback: () => void);
  62714. /**
  62715. * An event triggered after rendering the scene
  62716. */
  62717. onAfterRenderObservable: Observable<Layer>;
  62718. private _onAfterRenderObserver;
  62719. /**
  62720. * Back compatibility with callback before the onAfterRenderObservable existed.
  62721. * The set callback will be triggered just after rendering the layer.
  62722. */
  62723. set onAfterRender(callback: () => void);
  62724. /**
  62725. * Instantiates a new layer.
  62726. * This represents a full screen 2d layer.
  62727. * This can be useful to display a picture in the background of your scene for instance.
  62728. * @see https://www.babylonjs-playground.com/#08A2BS#1
  62729. * @param name Define the name of the layer in the scene
  62730. * @param imgUrl Define the url of the texture to display in the layer
  62731. * @param scene Define the scene the layer belongs to
  62732. * @param isBackground Defines whether the layer is displayed in front or behind the scene
  62733. * @param color Defines a color for the layer
  62734. */
  62735. constructor(
  62736. /**
  62737. * Define the name of the layer.
  62738. */
  62739. name: string, imgUrl: Nullable<string>, scene: Nullable<Scene>, isBackground?: boolean, color?: Color4);
  62740. private _createIndexBuffer;
  62741. /** @hidden */
  62742. _rebuild(): void;
  62743. /**
  62744. * Renders the layer in the scene.
  62745. */
  62746. render(): void;
  62747. /**
  62748. * Disposes and releases the associated ressources.
  62749. */
  62750. dispose(): void;
  62751. }
  62752. }
  62753. declare module "babylonjs/Layers/index" {
  62754. export * from "babylonjs/Layers/effectLayer";
  62755. export * from "babylonjs/Layers/effectLayerSceneComponent";
  62756. export * from "babylonjs/Layers/glowLayer";
  62757. export * from "babylonjs/Layers/highlightLayer";
  62758. export * from "babylonjs/Layers/layer";
  62759. export * from "babylonjs/Layers/layerSceneComponent";
  62760. }
  62761. declare module "babylonjs/Shaders/lensFlare.fragment" {
  62762. /** @hidden */
  62763. export var lensFlarePixelShader: {
  62764. name: string;
  62765. shader: string;
  62766. };
  62767. }
  62768. declare module "babylonjs/Shaders/lensFlare.vertex" {
  62769. /** @hidden */
  62770. export var lensFlareVertexShader: {
  62771. name: string;
  62772. shader: string;
  62773. };
  62774. }
  62775. declare module "babylonjs/LensFlares/lensFlareSystem" {
  62776. import { Scene } from "babylonjs/scene";
  62777. import { Vector3 } from "babylonjs/Maths/math.vector";
  62778. import { AbstractMesh } from "babylonjs/Meshes/abstractMesh";
  62779. import { LensFlare } from "babylonjs/LensFlares/lensFlare";
  62780. import "babylonjs/Shaders/lensFlare.fragment";
  62781. import "babylonjs/Shaders/lensFlare.vertex";
  62782. import { Viewport } from "babylonjs/Maths/math.viewport";
  62783. /**
  62784. * This represents a Lens Flare System or the shiny effect created by the light reflection on the camera lenses.
  62785. * It is usually composed of several `lensFlare`.
  62786. * @see https://doc.babylonjs.com/how_to/how_to_use_lens_flares
  62787. */
  62788. export class LensFlareSystem {
  62789. /**
  62790. * Define the name of the lens flare system
  62791. */
  62792. name: string;
  62793. /**
  62794. * List of lens flares used in this system.
  62795. */
  62796. lensFlares: LensFlare[];
  62797. /**
  62798. * Define a limit from the border the lens flare can be visible.
  62799. */
  62800. borderLimit: number;
  62801. /**
  62802. * Define a viewport border we do not want to see the lens flare in.
  62803. */
  62804. viewportBorder: number;
  62805. /**
  62806. * Define a predicate which could limit the list of meshes able to occlude the effect.
  62807. */
  62808. meshesSelectionPredicate: (mesh: AbstractMesh) => boolean;
  62809. /**
  62810. * Restricts the rendering of the effect to only the camera rendering this layer mask.
  62811. */
  62812. layerMask: number;
  62813. /**
  62814. * Define the id of the lens flare system in the scene.
  62815. * (equal to name by default)
  62816. */
  62817. id: string;
  62818. private _scene;
  62819. private _emitter;
  62820. private _vertexBuffers;
  62821. private _indexBuffer;
  62822. private _effect;
  62823. private _positionX;
  62824. private _positionY;
  62825. private _isEnabled;
  62826. /** @hidden */
  62827. static _SceneComponentInitialization: (scene: Scene) => void;
  62828. /**
  62829. * Instantiates a lens flare system.
  62830. * This represents a Lens Flare System or the shiny effect created by the light reflection on the camera lenses.
  62831. * It is usually composed of several `lensFlare`.
  62832. * @see https://doc.babylonjs.com/how_to/how_to_use_lens_flares
  62833. * @param name Define the name of the lens flare system in the scene
  62834. * @param emitter Define the source (the emitter) of the lens flares (it can be a camera, a light or a mesh).
  62835. * @param scene Define the scene the lens flare system belongs to
  62836. */
  62837. constructor(
  62838. /**
  62839. * Define the name of the lens flare system
  62840. */
  62841. name: string, emitter: any, scene: Scene);
  62842. /**
  62843. * Define if the lens flare system is enabled.
  62844. */
  62845. get isEnabled(): boolean;
  62846. set isEnabled(value: boolean);
  62847. /**
  62848. * Get the scene the effects belongs to.
  62849. * @returns the scene holding the lens flare system
  62850. */
  62851. getScene(): Scene;
  62852. /**
  62853. * Get the emitter of the lens flare system.
  62854. * It defines the source of the lens flares (it can be a camera, a light or a mesh).
  62855. * @returns the emitter of the lens flare system
  62856. */
  62857. getEmitter(): any;
  62858. /**
  62859. * Set the emitter of the lens flare system.
  62860. * It defines the source of the lens flares (it can be a camera, a light or a mesh).
  62861. * @param newEmitter Define the new emitter of the system
  62862. */
  62863. setEmitter(newEmitter: any): void;
  62864. /**
  62865. * Get the lens flare system emitter position.
  62866. * The emitter defines the source of the lens flares (it can be a camera, a light or a mesh).
  62867. * @returns the position
  62868. */
  62869. getEmitterPosition(): Vector3;
  62870. /**
  62871. * @hidden
  62872. */
  62873. computeEffectivePosition(globalViewport: Viewport): boolean;
  62874. /** @hidden */
  62875. _isVisible(): boolean;
  62876. /**
  62877. * @hidden
  62878. */
  62879. render(): boolean;
  62880. /**
  62881. * Dispose and release the lens flare with its associated resources.
  62882. */
  62883. dispose(): void;
  62884. /**
  62885. * Parse a lens flare system from a JSON repressentation
  62886. * @param parsedLensFlareSystem Define the JSON to parse
  62887. * @param scene Define the scene the parsed system should be instantiated in
  62888. * @param rootUrl Define the rootUrl of the load sequence to easily find a load relative dependencies such as textures
  62889. * @returns the parsed system
  62890. */
  62891. static Parse(parsedLensFlareSystem: any, scene: Scene, rootUrl: string): LensFlareSystem;
  62892. /**
  62893. * Serialize the current Lens Flare System into a JSON representation.
  62894. * @returns the serialized JSON
  62895. */
  62896. serialize(): any;
  62897. }
  62898. }
  62899. declare module "babylonjs/LensFlares/lensFlare" {
  62900. import { Nullable } from "babylonjs/types";
  62901. import { Color3 } from "babylonjs/Maths/math.color";
  62902. import { Texture } from "babylonjs/Materials/Textures/texture";
  62903. import { LensFlareSystem } from "babylonjs/LensFlares/lensFlareSystem";
  62904. /**
  62905. * This represents one of the lens effect in a `lensFlareSystem`.
  62906. * It controls one of the indiviual texture used in the effect.
  62907. * @see https://doc.babylonjs.com/how_to/how_to_use_lens_flares
  62908. */
  62909. export class LensFlare {
  62910. /**
  62911. * Define the size of the lens flare in the system (a floating value between 0 and 1)
  62912. */
  62913. size: number;
  62914. /**
  62915. * 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.
  62916. */
  62917. position: number;
  62918. /**
  62919. * Define the lens color.
  62920. */
  62921. color: Color3;
  62922. /**
  62923. * Define the lens texture.
  62924. */
  62925. texture: Nullable<Texture>;
  62926. /**
  62927. * Define the alpha mode to render this particular lens.
  62928. */
  62929. alphaMode: number;
  62930. private _system;
  62931. /**
  62932. * Creates a new Lens Flare.
  62933. * This represents one of the lens effect in a `lensFlareSystem`.
  62934. * It controls one of the indiviual texture used in the effect.
  62935. * @see https://doc.babylonjs.com/how_to/how_to_use_lens_flares
  62936. * @param size Define the size of the lens flare (a floating value between 0 and 1)
  62937. * @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.
  62938. * @param color Define the lens color
  62939. * @param imgUrl Define the lens texture url
  62940. * @param system Define the `lensFlareSystem` this flare is part of
  62941. * @returns The newly created Lens Flare
  62942. */
  62943. static AddFlare(size: number, position: number, color: Color3, imgUrl: string, system: LensFlareSystem): LensFlare;
  62944. /**
  62945. * Instantiates a new Lens Flare.
  62946. * This represents one of the lens effect in a `lensFlareSystem`.
  62947. * It controls one of the indiviual texture used in the effect.
  62948. * @see https://doc.babylonjs.com/how_to/how_to_use_lens_flares
  62949. * @param size Define the size of the lens flare in the system (a floating value between 0 and 1)
  62950. * @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.
  62951. * @param color Define the lens color
  62952. * @param imgUrl Define the lens texture url
  62953. * @param system Define the `lensFlareSystem` this flare is part of
  62954. */
  62955. constructor(
  62956. /**
  62957. * Define the size of the lens flare in the system (a floating value between 0 and 1)
  62958. */
  62959. size: number,
  62960. /**
  62961. * 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.
  62962. */
  62963. position: number, color: Color3, imgUrl: string, system: LensFlareSystem);
  62964. /**
  62965. * Dispose and release the lens flare with its associated resources.
  62966. */
  62967. dispose(): void;
  62968. }
  62969. }
  62970. declare module "babylonjs/LensFlares/lensFlareSystemSceneComponent" {
  62971. import { Nullable } from "babylonjs/types";
  62972. import { Scene } from "babylonjs/scene";
  62973. import { ISceneSerializableComponent } from "babylonjs/sceneComponent";
  62974. import { AbstractScene } from "babylonjs/abstractScene";
  62975. import { LensFlareSystem } from "babylonjs/LensFlares/lensFlareSystem";
  62976. module "babylonjs/abstractScene" {
  62977. interface AbstractScene {
  62978. /**
  62979. * The list of lens flare system added to the scene
  62980. * @see https://doc.babylonjs.com/how_to/how_to_use_lens_flares
  62981. */
  62982. lensFlareSystems: Array<LensFlareSystem>;
  62983. /**
  62984. * Removes the given lens flare system from this scene.
  62985. * @param toRemove The lens flare system to remove
  62986. * @returns The index of the removed lens flare system
  62987. */
  62988. removeLensFlareSystem(toRemove: LensFlareSystem): number;
  62989. /**
  62990. * Adds the given lens flare system to this scene
  62991. * @param newLensFlareSystem The lens flare system to add
  62992. */
  62993. addLensFlareSystem(newLensFlareSystem: LensFlareSystem): void;
  62994. /**
  62995. * Gets a lens flare system using its name
  62996. * @param name defines the name to look for
  62997. * @returns the lens flare system or null if not found
  62998. */
  62999. getLensFlareSystemByName(name: string): Nullable<LensFlareSystem>;
  63000. /**
  63001. * Gets a lens flare system using its id
  63002. * @param id defines the id to look for
  63003. * @returns the lens flare system or null if not found
  63004. */
  63005. getLensFlareSystemByID(id: string): Nullable<LensFlareSystem>;
  63006. }
  63007. }
  63008. /**
  63009. * Defines the lens flare scene component responsible to manage any lens flares
  63010. * in a given scene.
  63011. */
  63012. export class LensFlareSystemSceneComponent implements ISceneSerializableComponent {
  63013. /**
  63014. * The component name helpfull to identify the component in the list of scene components.
  63015. */
  63016. readonly name: string;
  63017. /**
  63018. * The scene the component belongs to.
  63019. */
  63020. scene: Scene;
  63021. /**
  63022. * Creates a new instance of the component for the given scene
  63023. * @param scene Defines the scene to register the component in
  63024. */
  63025. constructor(scene: Scene);
  63026. /**
  63027. * Registers the component in a given scene
  63028. */
  63029. register(): void;
  63030. /**
  63031. * Rebuilds the elements related to this component in case of
  63032. * context lost for instance.
  63033. */
  63034. rebuild(): void;
  63035. /**
  63036. * Adds all the elements from the container to the scene
  63037. * @param container the container holding the elements
  63038. */
  63039. addFromContainer(container: AbstractScene): void;
  63040. /**
  63041. * Removes all the elements in the container from the scene
  63042. * @param container contains the elements to remove
  63043. * @param dispose if the removed element should be disposed (default: false)
  63044. */
  63045. removeFromContainer(container: AbstractScene, dispose?: boolean): void;
  63046. /**
  63047. * Serializes the component data to the specified json object
  63048. * @param serializationObject The object to serialize to
  63049. */
  63050. serialize(serializationObject: any): void;
  63051. /**
  63052. * Disposes the component and the associated ressources.
  63053. */
  63054. dispose(): void;
  63055. private _draw;
  63056. }
  63057. }
  63058. declare module "babylonjs/LensFlares/index" {
  63059. export * from "babylonjs/LensFlares/lensFlare";
  63060. export * from "babylonjs/LensFlares/lensFlareSystem";
  63061. export * from "babylonjs/LensFlares/lensFlareSystemSceneComponent";
  63062. }
  63063. declare module "babylonjs/Shaders/depth.fragment" {
  63064. import "babylonjs/Shaders/ShadersInclude/packingFunctions";
  63065. /** @hidden */
  63066. export var depthPixelShader: {
  63067. name: string;
  63068. shader: string;
  63069. };
  63070. }
  63071. declare module "babylonjs/Shaders/depth.vertex" {
  63072. import "babylonjs/Shaders/ShadersInclude/bonesDeclaration";
  63073. import "babylonjs/Shaders/ShadersInclude/morphTargetsVertexGlobalDeclaration";
  63074. import "babylonjs/Shaders/ShadersInclude/morphTargetsVertexDeclaration";
  63075. import "babylonjs/Shaders/ShadersInclude/instancesDeclaration";
  63076. import "babylonjs/Shaders/ShadersInclude/morphTargetsVertex";
  63077. import "babylonjs/Shaders/ShadersInclude/instancesVertex";
  63078. import "babylonjs/Shaders/ShadersInclude/bonesVertex";
  63079. /** @hidden */
  63080. export var depthVertexShader: {
  63081. name: string;
  63082. shader: string;
  63083. };
  63084. }
  63085. declare module "babylonjs/Rendering/depthRenderer" {
  63086. import { Nullable } from "babylonjs/types";
  63087. import { SubMesh } from "babylonjs/Meshes/subMesh";
  63088. import { Scene } from "babylonjs/scene";
  63089. import { RenderTargetTexture } from "babylonjs/Materials/Textures/renderTargetTexture";
  63090. import { Camera } from "babylonjs/Cameras/camera";
  63091. import "babylonjs/Shaders/depth.fragment";
  63092. import "babylonjs/Shaders/depth.vertex";
  63093. /**
  63094. * This represents a depth renderer in Babylon.
  63095. * A depth renderer will render to it's depth map every frame which can be displayed or used in post processing
  63096. */
  63097. export class DepthRenderer {
  63098. private _scene;
  63099. private _depthMap;
  63100. private _effect;
  63101. private readonly _storeNonLinearDepth;
  63102. private readonly _clearColor;
  63103. /** Get if the depth renderer is using packed depth or not */
  63104. readonly isPacked: boolean;
  63105. private _cachedDefines;
  63106. private _camera;
  63107. /** Enable or disable the depth renderer. When disabled, the depth texture is not updated */
  63108. enabled: boolean;
  63109. /**
  63110. * Specifiess that the depth renderer will only be used within
  63111. * the camera it is created for.
  63112. * This can help forcing its rendering during the camera processing.
  63113. */
  63114. useOnlyInActiveCamera: boolean;
  63115. /** @hidden */
  63116. static _SceneComponentInitialization: (scene: Scene) => void;
  63117. /**
  63118. * Instantiates a depth renderer
  63119. * @param scene The scene the renderer belongs to
  63120. * @param type The texture type of the depth map (default: Engine.TEXTURETYPE_FLOAT)
  63121. * @param camera The camera to be used to render the depth map (default: scene's active camera)
  63122. * @param storeNonLinearDepth Defines whether the depth is stored linearly like in Babylon Shadows or directly like glFragCoord.z
  63123. */
  63124. constructor(scene: Scene, type?: number, camera?: Nullable<Camera>, storeNonLinearDepth?: boolean);
  63125. /**
  63126. * Creates the depth rendering effect and checks if the effect is ready.
  63127. * @param subMesh The submesh to be used to render the depth map of
  63128. * @param useInstances If multiple world instances should be used
  63129. * @returns if the depth renderer is ready to render the depth map
  63130. */
  63131. isReady(subMesh: SubMesh, useInstances: boolean): boolean;
  63132. /**
  63133. * Gets the texture which the depth map will be written to.
  63134. * @returns The depth map texture
  63135. */
  63136. getDepthMap(): RenderTargetTexture;
  63137. /**
  63138. * Disposes of the depth renderer.
  63139. */
  63140. dispose(): void;
  63141. }
  63142. }
  63143. declare module "babylonjs/Shaders/minmaxRedux.fragment" {
  63144. /** @hidden */
  63145. export var minmaxReduxPixelShader: {
  63146. name: string;
  63147. shader: string;
  63148. };
  63149. }
  63150. declare module "babylonjs/Misc/minMaxReducer" {
  63151. import { Nullable } from "babylonjs/types";
  63152. import { RenderTargetTexture } from "babylonjs/Materials/Textures/renderTargetTexture";
  63153. import { Camera } from "babylonjs/Cameras/camera";
  63154. import { Observer } from "babylonjs/Misc/observable";
  63155. import { PostProcess } from "babylonjs/PostProcesses/postProcess";
  63156. import { PostProcessManager } from "babylonjs/PostProcesses/postProcessManager";
  63157. import { Observable } from "babylonjs/Misc/observable";
  63158. import "babylonjs/Shaders/minmaxRedux.fragment";
  63159. /**
  63160. * This class computes a min/max reduction from a texture: it means it computes the minimum
  63161. * and maximum values from all values of the texture.
  63162. * It is performed on the GPU for better performances, thanks to a succession of post processes.
  63163. * The source values are read from the red channel of the texture.
  63164. */
  63165. export class MinMaxReducer {
  63166. /**
  63167. * Observable triggered when the computation has been performed
  63168. */
  63169. onAfterReductionPerformed: Observable<{
  63170. min: number;
  63171. max: number;
  63172. }>;
  63173. protected _camera: Camera;
  63174. protected _sourceTexture: Nullable<RenderTargetTexture>;
  63175. protected _reductionSteps: Nullable<Array<PostProcess>>;
  63176. protected _postProcessManager: PostProcessManager;
  63177. protected _onAfterUnbindObserver: Nullable<Observer<RenderTargetTexture>>;
  63178. protected _forceFullscreenViewport: boolean;
  63179. /**
  63180. * Creates a min/max reducer
  63181. * @param camera The camera to use for the post processes
  63182. */
  63183. constructor(camera: Camera);
  63184. /**
  63185. * Gets the texture used to read the values from.
  63186. */
  63187. get sourceTexture(): Nullable<RenderTargetTexture>;
  63188. /**
  63189. * Sets the source texture to read the values from.
  63190. * One must indicate if the texture is a depth texture or not through the depthRedux parameter
  63191. * because in such textures '1' value must not be taken into account to compute the maximum
  63192. * as this value is used to clear the texture.
  63193. * Note that the computation is not activated by calling this function, you must call activate() for that!
  63194. * @param sourceTexture The texture to read the values from. The values should be in the red channel.
  63195. * @param depthRedux Indicates if the texture is a depth texture or not
  63196. * @param type The type of the textures created for the reduction (defaults to TEXTURETYPE_HALF_FLOAT)
  63197. * @param forceFullscreenViewport Forces the post processes used for the reduction to be applied without taking into account viewport (defaults to true)
  63198. */
  63199. setSourceTexture(sourceTexture: RenderTargetTexture, depthRedux: boolean, type?: number, forceFullscreenViewport?: boolean): void;
  63200. /**
  63201. * Defines the refresh rate of the computation.
  63202. * Use 0 to compute just once, 1 to compute on every frame, 2 to compute every two frames and so on...
  63203. */
  63204. get refreshRate(): number;
  63205. set refreshRate(value: number);
  63206. protected _activated: boolean;
  63207. /**
  63208. * Gets the activation status of the reducer
  63209. */
  63210. get activated(): boolean;
  63211. /**
  63212. * Activates the reduction computation.
  63213. * When activated, the observers registered in onAfterReductionPerformed are
  63214. * called after the compuation is performed
  63215. */
  63216. activate(): void;
  63217. /**
  63218. * Deactivates the reduction computation.
  63219. */
  63220. deactivate(): void;
  63221. /**
  63222. * Disposes the min/max reducer
  63223. * @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.
  63224. */
  63225. dispose(disposeAll?: boolean): void;
  63226. }
  63227. }
  63228. declare module "babylonjs/Misc/depthReducer" {
  63229. import { Nullable } from "babylonjs/types";
  63230. import { RenderTargetTexture } from "babylonjs/Materials/Textures/renderTargetTexture";
  63231. import { Camera } from "babylonjs/Cameras/camera";
  63232. import { DepthRenderer } from "babylonjs/Rendering/depthRenderer";
  63233. import { MinMaxReducer } from "babylonjs/Misc/minMaxReducer";
  63234. /**
  63235. * This class is a small wrapper around the MinMaxReducer class to compute the min/max values of a depth texture
  63236. */
  63237. export class DepthReducer extends MinMaxReducer {
  63238. private _depthRenderer;
  63239. private _depthRendererId;
  63240. /**
  63241. * Gets the depth renderer used for the computation.
  63242. * Note that the result is null if you provide your own renderer when calling setDepthRenderer.
  63243. */
  63244. get depthRenderer(): Nullable<DepthRenderer>;
  63245. /**
  63246. * Creates a depth reducer
  63247. * @param camera The camera used to render the depth texture
  63248. */
  63249. constructor(camera: Camera);
  63250. /**
  63251. * Sets the depth renderer to use to generate the depth map
  63252. * @param depthRenderer The depth renderer to use. If not provided, a new one will be created automatically
  63253. * @param type The texture type of the depth map (default: TEXTURETYPE_HALF_FLOAT)
  63254. * @param forceFullscreenViewport Forces the post processes used for the reduction to be applied without taking into account viewport (defaults to true)
  63255. */
  63256. setDepthRenderer(depthRenderer?: Nullable<DepthRenderer>, type?: number, forceFullscreenViewport?: boolean): void;
  63257. /** @hidden */
  63258. setSourceTexture(sourceTexture: RenderTargetTexture, depthRedux: boolean, type?: number, forceFullscreenViewport?: boolean): void;
  63259. /**
  63260. * Activates the reduction computation.
  63261. * When activated, the observers registered in onAfterReductionPerformed are
  63262. * called after the compuation is performed
  63263. */
  63264. activate(): void;
  63265. /**
  63266. * Deactivates the reduction computation.
  63267. */
  63268. deactivate(): void;
  63269. /**
  63270. * Disposes the depth reducer
  63271. * @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.
  63272. */
  63273. dispose(disposeAll?: boolean): void;
  63274. }
  63275. }
  63276. declare module "babylonjs/Lights/Shadows/cascadedShadowGenerator" {
  63277. import { Nullable } from "babylonjs/types";
  63278. import { Scene } from "babylonjs/scene";
  63279. import { Matrix, Vector3 } from "babylonjs/Maths/math.vector";
  63280. import { SubMesh } from "babylonjs/Meshes/subMesh";
  63281. import { AbstractMesh } from "babylonjs/Meshes/abstractMesh";
  63282. import { Effect } from "babylonjs/Materials/effect";
  63283. import "babylonjs/Shaders/shadowMap.fragment";
  63284. import "babylonjs/Shaders/shadowMap.vertex";
  63285. import "babylonjs/Shaders/depthBoxBlur.fragment";
  63286. import { ShadowGenerator } from "babylonjs/Lights/Shadows/shadowGenerator";
  63287. import { DirectionalLight } from "babylonjs/Lights/directionalLight";
  63288. import { BoundingInfo } from "babylonjs/Culling/boundingInfo";
  63289. import { DepthRenderer } from "babylonjs/Rendering/depthRenderer";
  63290. /**
  63291. * A CSM implementation allowing casting shadows on large scenes.
  63292. * Documentation : https://doc.babylonjs.com/babylon101/cascadedShadows
  63293. * Based on: https://github.com/TheRealMJP/Shadows and https://johanmedestrom.wordpress.com/2016/03/18/opengl-cascaded-shadow-maps/
  63294. */
  63295. export class CascadedShadowGenerator extends ShadowGenerator {
  63296. private static readonly frustumCornersNDCSpace;
  63297. /**
  63298. * Name of the CSM class
  63299. */
  63300. static CLASSNAME: string;
  63301. /**
  63302. * Defines the default number of cascades used by the CSM.
  63303. */
  63304. static readonly DEFAULT_CASCADES_COUNT: number;
  63305. /**
  63306. * Defines the minimum number of cascades used by the CSM.
  63307. */
  63308. static readonly MIN_CASCADES_COUNT: number;
  63309. /**
  63310. * Defines the maximum number of cascades used by the CSM.
  63311. */
  63312. static readonly MAX_CASCADES_COUNT: number;
  63313. protected _validateFilter(filter: number): number;
  63314. /**
  63315. * Gets or sets the actual darkness of the soft shadows while using PCSS filtering (value between 0. and 1.)
  63316. */
  63317. penumbraDarkness: number;
  63318. private _numCascades;
  63319. /**
  63320. * Gets or set the number of cascades used by the CSM.
  63321. */
  63322. get numCascades(): number;
  63323. set numCascades(value: number);
  63324. /**
  63325. * Sets this to true if you want that the edges of the shadows don't "swimm" / "shimmer" when rotating the camera.
  63326. * The trade off is that you lose some precision in the shadow rendering when enabling this setting.
  63327. */
  63328. stabilizeCascades: boolean;
  63329. private _freezeShadowCastersBoundingInfo;
  63330. private _freezeShadowCastersBoundingInfoObservable;
  63331. /**
  63332. * Enables or disables the shadow casters bounding info computation.
  63333. * If your shadow casters don't move, you can disable this feature.
  63334. * If it is enabled, the bounding box computation is done every frame.
  63335. */
  63336. get freezeShadowCastersBoundingInfo(): boolean;
  63337. set freezeShadowCastersBoundingInfo(freeze: boolean);
  63338. private _scbiMin;
  63339. private _scbiMax;
  63340. protected _computeShadowCastersBoundingInfo(): void;
  63341. protected _shadowCastersBoundingInfo: BoundingInfo;
  63342. /**
  63343. * Gets or sets the shadow casters bounding info.
  63344. * If you provide your own shadow casters bounding info, first enable freezeShadowCastersBoundingInfo
  63345. * so that the system won't overwrite the bounds you provide
  63346. */
  63347. get shadowCastersBoundingInfo(): BoundingInfo;
  63348. set shadowCastersBoundingInfo(boundingInfo: BoundingInfo);
  63349. protected _breaksAreDirty: boolean;
  63350. protected _minDistance: number;
  63351. protected _maxDistance: number;
  63352. /**
  63353. * Sets the minimal and maximal distances to use when computing the cascade breaks.
  63354. *
  63355. * The values of min / max are typically the depth zmin and zmax values of your scene, for a given frame.
  63356. * If you don't know these values, simply leave them to their defaults and don't call this function.
  63357. * @param min minimal distance for the breaks (default to 0.)
  63358. * @param max maximal distance for the breaks (default to 1.)
  63359. */
  63360. setMinMaxDistance(min: number, max: number): void;
  63361. /** Gets the minimal distance used in the cascade break computation */
  63362. get minDistance(): number;
  63363. /** Gets the maximal distance used in the cascade break computation */
  63364. get maxDistance(): number;
  63365. /**
  63366. * Gets the class name of that object
  63367. * @returns "CascadedShadowGenerator"
  63368. */
  63369. getClassName(): string;
  63370. private _cascadeMinExtents;
  63371. private _cascadeMaxExtents;
  63372. /**
  63373. * Gets a cascade minimum extents
  63374. * @param cascadeIndex index of the cascade
  63375. * @returns the minimum cascade extents
  63376. */
  63377. getCascadeMinExtents(cascadeIndex: number): Nullable<Vector3>;
  63378. /**
  63379. * Gets a cascade maximum extents
  63380. * @param cascadeIndex index of the cascade
  63381. * @returns the maximum cascade extents
  63382. */
  63383. getCascadeMaxExtents(cascadeIndex: number): Nullable<Vector3>;
  63384. private _cascades;
  63385. private _currentLayer;
  63386. private _viewSpaceFrustumsZ;
  63387. private _viewMatrices;
  63388. private _projectionMatrices;
  63389. private _transformMatrices;
  63390. private _transformMatricesAsArray;
  63391. private _frustumLengths;
  63392. private _lightSizeUVCorrection;
  63393. private _depthCorrection;
  63394. private _frustumCornersWorldSpace;
  63395. private _frustumCenter;
  63396. private _shadowCameraPos;
  63397. private _shadowMaxZ;
  63398. /**
  63399. * Gets the shadow max z distance. It's the limit beyond which shadows are not displayed.
  63400. * It defaults to camera.maxZ
  63401. */
  63402. get shadowMaxZ(): number;
  63403. /**
  63404. * Sets the shadow max z distance.
  63405. */
  63406. set shadowMaxZ(value: number);
  63407. protected _debug: boolean;
  63408. /**
  63409. * Gets or sets the debug flag.
  63410. * When enabled, the cascades are materialized by different colors on the screen.
  63411. */
  63412. get debug(): boolean;
  63413. set debug(dbg: boolean);
  63414. private _depthClamp;
  63415. /**
  63416. * Gets or sets the depth clamping value.
  63417. *
  63418. * When enabled, it improves the shadow quality because the near z plane of the light frustum don't need to be adjusted
  63419. * to account for the shadow casters far away.
  63420. *
  63421. * Note that this property is incompatible with PCSS filtering, so it won't be used in that case.
  63422. */
  63423. get depthClamp(): boolean;
  63424. set depthClamp(value: boolean);
  63425. private _cascadeBlendPercentage;
  63426. /**
  63427. * Gets or sets the percentage of blending between two cascades (value between 0. and 1.).
  63428. * It defaults to 0.1 (10% blending).
  63429. */
  63430. get cascadeBlendPercentage(): number;
  63431. set cascadeBlendPercentage(value: number);
  63432. private _lambda;
  63433. /**
  63434. * Gets or set the lambda parameter.
  63435. * This parameter is used to split the camera frustum and create the cascades.
  63436. * 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.
  63437. * For all values in-between, it's a linear combination of the uniform and logarithm split algorithm.
  63438. */
  63439. get lambda(): number;
  63440. set lambda(value: number);
  63441. /**
  63442. * Gets the view matrix corresponding to a given cascade
  63443. * @param cascadeNum cascade to retrieve the view matrix from
  63444. * @returns the cascade view matrix
  63445. */
  63446. getCascadeViewMatrix(cascadeNum: number): Nullable<Matrix>;
  63447. /**
  63448. * Gets the projection matrix corresponding to a given cascade
  63449. * @param cascadeNum cascade to retrieve the projection matrix from
  63450. * @returns the cascade projection matrix
  63451. */
  63452. getCascadeProjectionMatrix(cascadeNum: number): Nullable<Matrix>;
  63453. /**
  63454. * Gets the transformation matrix corresponding to a given cascade
  63455. * @param cascadeNum cascade to retrieve the transformation matrix from
  63456. * @returns the cascade transformation matrix
  63457. */
  63458. getCascadeTransformMatrix(cascadeNum: number): Nullable<Matrix>;
  63459. private _depthRenderer;
  63460. /**
  63461. * Sets the depth renderer to use when autoCalcDepthBounds is enabled.
  63462. *
  63463. * Note that if no depth renderer is set, a new one will be automatically created internally when necessary.
  63464. *
  63465. * You should call this function if you already have a depth renderer enabled in your scene, to avoid
  63466. * doing multiple depth rendering each frame. If you provide your own depth renderer, make sure it stores linear depth!
  63467. * @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
  63468. */
  63469. setDepthRenderer(depthRenderer: Nullable<DepthRenderer>): void;
  63470. private _depthReducer;
  63471. private _autoCalcDepthBounds;
  63472. /**
  63473. * Gets or sets the autoCalcDepthBounds property.
  63474. *
  63475. * When enabled, a depth rendering pass is first performed (with an internally created depth renderer or with the one
  63476. * you provide by calling setDepthRenderer). Then, a min/max reducing is applied on the depth map to compute the
  63477. * minimal and maximal depth of the map and those values are used as inputs for the setMinMaxDistance() function.
  63478. * It can greatly enhance the shadow quality, at the expense of more GPU works.
  63479. * When using this option, you should increase the value of the lambda parameter, and even set it to 1 for best results.
  63480. */
  63481. get autoCalcDepthBounds(): boolean;
  63482. set autoCalcDepthBounds(value: boolean);
  63483. /**
  63484. * Defines the refresh rate of the min/max computation used when autoCalcDepthBounds is set to true
  63485. * Use 0 to compute just once, 1 to compute on every frame, 2 to compute every two frames and so on...
  63486. * Note that if you provided your own depth renderer through a call to setDepthRenderer, you are responsible
  63487. * for setting the refresh rate on the renderer yourself!
  63488. */
  63489. get autoCalcDepthBoundsRefreshRate(): number;
  63490. set autoCalcDepthBoundsRefreshRate(value: number);
  63491. /**
  63492. * Create the cascade breaks according to the lambda, shadowMaxZ and min/max distance properties, as well as the camera near and far planes.
  63493. * This function is automatically called when updating lambda, shadowMaxZ and min/max distances, however you should call it yourself if
  63494. * you change the camera near/far planes!
  63495. */
  63496. splitFrustum(): void;
  63497. private _splitFrustum;
  63498. private _computeMatrices;
  63499. private _computeFrustumInWorldSpace;
  63500. private _computeCascadeFrustum;
  63501. /**
  63502. * Support test.
  63503. */
  63504. static get IsSupported(): boolean;
  63505. /** @hidden */
  63506. static _SceneComponentInitialization: (scene: Scene) => void;
  63507. /**
  63508. * Creates a Cascaded Shadow Generator object.
  63509. * A ShadowGenerator is the required tool to use the shadows.
  63510. * Each directional light casting shadows needs to use its own ShadowGenerator.
  63511. * Documentation : https://doc.babylonjs.com/babylon101/cascadedShadows
  63512. * @param mapSize The size of the texture what stores the shadows. Example : 1024.
  63513. * @param light The directional light object generating the shadows.
  63514. * @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.
  63515. */
  63516. constructor(mapSize: number, light: DirectionalLight, usefulFloatFirst?: boolean);
  63517. protected _initializeGenerator(): void;
  63518. protected _createTargetRenderTexture(): void;
  63519. protected _initializeShadowMap(): void;
  63520. protected _bindCustomEffectForRenderSubMeshForShadowMap(subMesh: SubMesh, effect: Effect, matriceNames: any, mesh: AbstractMesh): void;
  63521. protected _isReadyCustomDefines(defines: any, subMesh: SubMesh, useInstances: boolean): void;
  63522. /**
  63523. * Prepare all the defines in a material relying on a shadow map at the specified light index.
  63524. * @param defines Defines of the material we want to update
  63525. * @param lightIndex Index of the light in the enabled light list of the material
  63526. */
  63527. prepareDefines(defines: any, lightIndex: number): void;
  63528. /**
  63529. * Binds the shadow related information inside of an effect (information like near, far, darkness...
  63530. * defined in the generator but impacting the effect).
  63531. * @param lightIndex Index of the light in the enabled light list of the material owning the effect
  63532. * @param effect The effect we are binfing the information for
  63533. */
  63534. bindShadowLight(lightIndex: string, effect: Effect): void;
  63535. /**
  63536. * Gets the transformation matrix of the first cascade used to project the meshes into the map from the light point of view.
  63537. * (eq to view projection * shadow projection matrices)
  63538. * @returns The transform matrix used to create the shadow map
  63539. */
  63540. getTransformMatrix(): Matrix;
  63541. /**
  63542. * Disposes the ShadowGenerator.
  63543. * Returns nothing.
  63544. */
  63545. dispose(): void;
  63546. /**
  63547. * Serializes the shadow generator setup to a json object.
  63548. * @returns The serialized JSON object
  63549. */
  63550. serialize(): any;
  63551. /**
  63552. * Parses a serialized ShadowGenerator and returns a new ShadowGenerator.
  63553. * @param parsedShadowGenerator The JSON object to parse
  63554. * @param scene The scene to create the shadow map for
  63555. * @returns The parsed shadow generator
  63556. */
  63557. static Parse(parsedShadowGenerator: any, scene: Scene): ShadowGenerator;
  63558. }
  63559. }
  63560. declare module "babylonjs/Lights/Shadows/shadowGeneratorSceneComponent" {
  63561. import { Scene } from "babylonjs/scene";
  63562. import { ISceneSerializableComponent } from "babylonjs/sceneComponent";
  63563. import { AbstractScene } from "babylonjs/abstractScene";
  63564. /**
  63565. * Defines the shadow generator component responsible to manage any shadow generators
  63566. * in a given scene.
  63567. */
  63568. export class ShadowGeneratorSceneComponent implements ISceneSerializableComponent {
  63569. /**
  63570. * The component name helpfull to identify the component in the list of scene components.
  63571. */
  63572. readonly name: string;
  63573. /**
  63574. * The scene the component belongs to.
  63575. */
  63576. scene: Scene;
  63577. /**
  63578. * Creates a new instance of the component for the given scene
  63579. * @param scene Defines the scene to register the component in
  63580. */
  63581. constructor(scene: Scene);
  63582. /**
  63583. * Registers the component in a given scene
  63584. */
  63585. register(): void;
  63586. /**
  63587. * Rebuilds the elements related to this component in case of
  63588. * context lost for instance.
  63589. */
  63590. rebuild(): void;
  63591. /**
  63592. * Serializes the component data to the specified json object
  63593. * @param serializationObject The object to serialize to
  63594. */
  63595. serialize(serializationObject: any): void;
  63596. /**
  63597. * Adds all the elements from the container to the scene
  63598. * @param container the container holding the elements
  63599. */
  63600. addFromContainer(container: AbstractScene): void;
  63601. /**
  63602. * Removes all the elements in the container from the scene
  63603. * @param container contains the elements to remove
  63604. * @param dispose if the removed element should be disposed (default: false)
  63605. */
  63606. removeFromContainer(container: AbstractScene, dispose?: boolean): void;
  63607. /**
  63608. * Rebuilds the elements related to this component in case of
  63609. * context lost for instance.
  63610. */
  63611. dispose(): void;
  63612. private _gatherRenderTargets;
  63613. }
  63614. }
  63615. declare module "babylonjs/Lights/Shadows/index" {
  63616. export * from "babylonjs/Lights/Shadows/shadowGenerator";
  63617. export * from "babylonjs/Lights/Shadows/cascadedShadowGenerator";
  63618. export * from "babylonjs/Lights/Shadows/shadowGeneratorSceneComponent";
  63619. }
  63620. declare module "babylonjs/Lights/pointLight" {
  63621. import { Scene } from "babylonjs/scene";
  63622. import { Matrix, Vector3 } from "babylonjs/Maths/math.vector";
  63623. import { AbstractMesh } from "babylonjs/Meshes/abstractMesh";
  63624. import { ShadowLight } from "babylonjs/Lights/shadowLight";
  63625. import { Effect } from "babylonjs/Materials/effect";
  63626. /**
  63627. * A point light is a light defined by an unique point in world space.
  63628. * The light is emitted in every direction from this point.
  63629. * A good example of a point light is a standard light bulb.
  63630. * Documentation: https://doc.babylonjs.com/babylon101/lights
  63631. */
  63632. export class PointLight extends ShadowLight {
  63633. private _shadowAngle;
  63634. /**
  63635. * Getter: In case of direction provided, the shadow will not use a cube texture but simulate a spot shadow as a fallback
  63636. * This specifies what angle the shadow will use to be created.
  63637. *
  63638. * It default to 90 degrees to work nicely with the cube texture generation for point lights shadow maps.
  63639. */
  63640. get shadowAngle(): number;
  63641. /**
  63642. * Setter: In case of direction provided, the shadow will not use a cube texture but simulate a spot shadow as a fallback
  63643. * This specifies what angle the shadow will use to be created.
  63644. *
  63645. * It default to 90 degrees to work nicely with the cube texture generation for point lights shadow maps.
  63646. */
  63647. set shadowAngle(value: number);
  63648. /**
  63649. * Gets the direction if it has been set.
  63650. * In case of direction provided, the shadow will not use a cube texture but simulate a spot shadow as a fallback
  63651. */
  63652. get direction(): Vector3;
  63653. /**
  63654. * In case of direction provided, the shadow will not use a cube texture but simulate a spot shadow as a fallback
  63655. */
  63656. set direction(value: Vector3);
  63657. /**
  63658. * Creates a PointLight object from the passed name and position (Vector3) and adds it in the scene.
  63659. * A PointLight emits the light in every direction.
  63660. * It can cast shadows.
  63661. * If the scene camera is already defined and you want to set your PointLight at the camera position, just set it :
  63662. * ```javascript
  63663. * var pointLight = new PointLight("pl", camera.position, scene);
  63664. * ```
  63665. * Documentation : https://doc.babylonjs.com/babylon101/lights
  63666. * @param name The light friendly name
  63667. * @param position The position of the point light in the scene
  63668. * @param scene The scene the lights belongs to
  63669. */
  63670. constructor(name: string, position: Vector3, scene: Scene);
  63671. /**
  63672. * Returns the string "PointLight"
  63673. * @returns the class name
  63674. */
  63675. getClassName(): string;
  63676. /**
  63677. * Returns the integer 0.
  63678. * @returns The light Type id as a constant defines in Light.LIGHTTYPEID_x
  63679. */
  63680. getTypeID(): number;
  63681. /**
  63682. * Specifies wether or not the shadowmap should be a cube texture.
  63683. * @returns true if the shadowmap needs to be a cube texture.
  63684. */
  63685. needCube(): boolean;
  63686. /**
  63687. * Returns a new Vector3 aligned with the PointLight cube system according to the passed cube face index (integer).
  63688. * @param faceIndex The index of the face we are computed the direction to generate shadow
  63689. * @returns The set direction in 2d mode otherwise the direction to the cubemap face if needCube() is true
  63690. */
  63691. getShadowDirection(faceIndex?: number): Vector3;
  63692. /**
  63693. * Sets the passed matrix "matrix" as a left-handed perspective projection matrix with the following settings :
  63694. * - fov = PI / 2
  63695. * - aspect ratio : 1.0
  63696. * - z-near and far equal to the active camera minZ and maxZ.
  63697. * Returns the PointLight.
  63698. */
  63699. protected _setDefaultShadowProjectionMatrix(matrix: Matrix, viewMatrix: Matrix, renderList: Array<AbstractMesh>): void;
  63700. protected _buildUniformLayout(): void;
  63701. /**
  63702. * Sets the passed Effect "effect" with the PointLight transformed position (or position, if none) and passed name (string).
  63703. * @param effect The effect to update
  63704. * @param lightIndex The index of the light in the effect to update
  63705. * @returns The point light
  63706. */
  63707. transferToEffect(effect: Effect, lightIndex: string): PointLight;
  63708. transferToNodeMaterialEffect(effect: Effect, lightDataUniformName: string): this;
  63709. /**
  63710. * Prepares the list of defines specific to the light type.
  63711. * @param defines the list of defines
  63712. * @param lightIndex defines the index of the light for the effect
  63713. */
  63714. prepareLightSpecificDefines(defines: any, lightIndex: number): void;
  63715. }
  63716. }
  63717. declare module "babylonjs/Lights/index" {
  63718. export * from "babylonjs/Lights/light";
  63719. export * from "babylonjs/Lights/shadowLight";
  63720. export * from "babylonjs/Lights/Shadows/index";
  63721. export * from "babylonjs/Lights/directionalLight";
  63722. export * from "babylonjs/Lights/hemisphericLight";
  63723. export * from "babylonjs/Lights/pointLight";
  63724. export * from "babylonjs/Lights/spotLight";
  63725. }
  63726. declare module "babylonjs/Misc/HighDynamicRange/hdr" {
  63727. import { CubeMapInfo } from "babylonjs/Misc/HighDynamicRange/panoramaToCubemap";
  63728. /**
  63729. * Header information of HDR texture files.
  63730. */
  63731. export interface HDRInfo {
  63732. /**
  63733. * The height of the texture in pixels.
  63734. */
  63735. height: number;
  63736. /**
  63737. * The width of the texture in pixels.
  63738. */
  63739. width: number;
  63740. /**
  63741. * The index of the beginning of the data in the binary file.
  63742. */
  63743. dataPosition: number;
  63744. }
  63745. /**
  63746. * This groups tools to convert HDR texture to native colors array.
  63747. */
  63748. export class HDRTools {
  63749. private static Ldexp;
  63750. private static Rgbe2float;
  63751. private static readStringLine;
  63752. /**
  63753. * Reads header information from an RGBE texture stored in a native array.
  63754. * More information on this format are available here:
  63755. * https://en.wikipedia.org/wiki/RGBE_image_format
  63756. *
  63757. * @param uint8array The binary file stored in native array.
  63758. * @return The header information.
  63759. */
  63760. static RGBE_ReadHeader(uint8array: Uint8Array): HDRInfo;
  63761. /**
  63762. * Returns the cubemap information (each faces texture data) extracted from an RGBE texture.
  63763. * This RGBE texture needs to store the information as a panorama.
  63764. *
  63765. * More information on this format are available here:
  63766. * https://en.wikipedia.org/wiki/RGBE_image_format
  63767. *
  63768. * @param buffer The binary file stored in an array buffer.
  63769. * @param size The expected size of the extracted cubemap.
  63770. * @return The Cube Map information.
  63771. */
  63772. static GetCubeMapTextureData(buffer: ArrayBuffer, size: number): CubeMapInfo;
  63773. /**
  63774. * Returns the pixels data extracted from an RGBE texture.
  63775. * This pixels will be stored left to right up to down in the R G B order in one array.
  63776. *
  63777. * More information on this format are available here:
  63778. * https://en.wikipedia.org/wiki/RGBE_image_format
  63779. *
  63780. * @param uint8array The binary file stored in an array buffer.
  63781. * @param hdrInfo The header information of the file.
  63782. * @return The pixels data in RGB right to left up to down order.
  63783. */
  63784. static RGBE_ReadPixels(uint8array: Uint8Array, hdrInfo: HDRInfo): Float32Array;
  63785. private static RGBE_ReadPixels_RLE;
  63786. private static RGBE_ReadPixels_NOT_RLE;
  63787. }
  63788. }
  63789. declare module "babylonjs/Materials/effectRenderer" {
  63790. import { Nullable } from "babylonjs/types";
  63791. import { InternalTexture } from "babylonjs/Materials/Textures/internalTexture";
  63792. import { RenderTargetTexture } from "babylonjs/Materials/Textures/renderTargetTexture";
  63793. import { ThinEngine } from "babylonjs/Engines/thinEngine";
  63794. import { Viewport } from "babylonjs/Maths/math.viewport";
  63795. import { Observable } from "babylonjs/Misc/observable";
  63796. import { Effect } from "babylonjs/Materials/effect";
  63797. import "babylonjs/Shaders/postprocess.vertex";
  63798. /**
  63799. * Effect Render Options
  63800. */
  63801. export interface IEffectRendererOptions {
  63802. /**
  63803. * Defines the vertices positions.
  63804. */
  63805. positions?: number[];
  63806. /**
  63807. * Defines the indices.
  63808. */
  63809. indices?: number[];
  63810. }
  63811. /**
  63812. * Helper class to render one or more effects.
  63813. * You can access the previous rendering in your shader by declaring a sampler named textureSampler
  63814. */
  63815. export class EffectRenderer {
  63816. private engine;
  63817. private static _DefaultOptions;
  63818. private _vertexBuffers;
  63819. private _indexBuffer;
  63820. private _fullscreenViewport;
  63821. /**
  63822. * Creates an effect renderer
  63823. * @param engine the engine to use for rendering
  63824. * @param options defines the options of the effect renderer
  63825. */
  63826. constructor(engine: ThinEngine, options?: IEffectRendererOptions);
  63827. /**
  63828. * Sets the current viewport in normalized coordinates 0-1
  63829. * @param viewport Defines the viewport to set (defaults to 0 0 1 1)
  63830. */
  63831. setViewport(viewport?: Viewport): void;
  63832. /**
  63833. * Binds the embedded attributes buffer to the effect.
  63834. * @param effect Defines the effect to bind the attributes for
  63835. */
  63836. bindBuffers(effect: Effect): void;
  63837. /**
  63838. * Sets the current effect wrapper to use during draw.
  63839. * The effect needs to be ready before calling this api.
  63840. * This also sets the default full screen position attribute.
  63841. * @param effectWrapper Defines the effect to draw with
  63842. */
  63843. applyEffectWrapper(effectWrapper: EffectWrapper): void;
  63844. /**
  63845. * Restores engine states
  63846. */
  63847. restoreStates(): void;
  63848. /**
  63849. * Draws a full screen quad.
  63850. */
  63851. draw(): void;
  63852. private isRenderTargetTexture;
  63853. /**
  63854. * renders one or more effects to a specified texture
  63855. * @param effectWrapper the effect to renderer
  63856. * @param outputTexture texture to draw to, if null it will render to the screen.
  63857. */
  63858. render(effectWrapper: EffectWrapper, outputTexture?: Nullable<InternalTexture | RenderTargetTexture>): void;
  63859. /**
  63860. * Disposes of the effect renderer
  63861. */
  63862. dispose(): void;
  63863. }
  63864. /**
  63865. * Options to create an EffectWrapper
  63866. */
  63867. interface EffectWrapperCreationOptions {
  63868. /**
  63869. * Engine to use to create the effect
  63870. */
  63871. engine: ThinEngine;
  63872. /**
  63873. * Fragment shader for the effect
  63874. */
  63875. fragmentShader: string;
  63876. /**
  63877. * Use the shader store instead of direct source code
  63878. */
  63879. useShaderStore?: boolean;
  63880. /**
  63881. * Vertex shader for the effect
  63882. */
  63883. vertexShader?: string;
  63884. /**
  63885. * Attributes to use in the shader
  63886. */
  63887. attributeNames?: Array<string>;
  63888. /**
  63889. * Uniforms to use in the shader
  63890. */
  63891. uniformNames?: Array<string>;
  63892. /**
  63893. * Texture sampler names to use in the shader
  63894. */
  63895. samplerNames?: Array<string>;
  63896. /**
  63897. * Defines to use in the shader
  63898. */
  63899. defines?: Array<string>;
  63900. /**
  63901. * Callback when effect is compiled
  63902. */
  63903. onCompiled?: Nullable<(effect: Effect) => void>;
  63904. /**
  63905. * The friendly name of the effect displayed in Spector.
  63906. */
  63907. name?: string;
  63908. }
  63909. /**
  63910. * Wraps an effect to be used for rendering
  63911. */
  63912. export class EffectWrapper {
  63913. /**
  63914. * Event that is fired right before the effect is drawn (should be used to update uniforms)
  63915. */
  63916. onApplyObservable: Observable<{}>;
  63917. /**
  63918. * The underlying effect
  63919. */
  63920. effect: Effect;
  63921. /**
  63922. * Creates an effect to be renderer
  63923. * @param creationOptions options to create the effect
  63924. */
  63925. constructor(creationOptions: EffectWrapperCreationOptions);
  63926. /**
  63927. * Disposes of the effect wrapper
  63928. */
  63929. dispose(): void;
  63930. }
  63931. }
  63932. declare module "babylonjs/Shaders/hdrFiltering.vertex" {
  63933. /** @hidden */
  63934. export var hdrFilteringVertexShader: {
  63935. name: string;
  63936. shader: string;
  63937. };
  63938. }
  63939. declare module "babylonjs/Shaders/hdrFiltering.fragment" {
  63940. import "babylonjs/Shaders/ShadersInclude/helperFunctions";
  63941. import "babylonjs/Shaders/ShadersInclude/importanceSampling";
  63942. import "babylonjs/Shaders/ShadersInclude/pbrBRDFFunctions";
  63943. import "babylonjs/Shaders/ShadersInclude/hdrFilteringFunctions";
  63944. /** @hidden */
  63945. export var hdrFilteringPixelShader: {
  63946. name: string;
  63947. shader: string;
  63948. };
  63949. }
  63950. declare module "babylonjs/Materials/Textures/Filtering/hdrFiltering" {
  63951. import { BaseTexture } from "babylonjs/Materials/Textures/baseTexture";
  63952. import { ThinEngine } from "babylonjs/Engines/thinEngine";
  63953. import { Nullable } from "babylonjs/types";
  63954. import "babylonjs/Shaders/hdrFiltering.vertex";
  63955. import "babylonjs/Shaders/hdrFiltering.fragment";
  63956. /**
  63957. * Options for texture filtering
  63958. */
  63959. interface IHDRFilteringOptions {
  63960. /**
  63961. * Scales pixel intensity for the input HDR map.
  63962. */
  63963. hdrScale?: number;
  63964. /**
  63965. * Quality of the filter. Should be `Constants.TEXTURE_FILTERING_QUALITY_OFFLINE` for prefiltering
  63966. */
  63967. quality?: number;
  63968. }
  63969. /**
  63970. * Filters HDR maps to get correct renderings of PBR reflections
  63971. */
  63972. export class HDRFiltering {
  63973. private _engine;
  63974. private _effectRenderer;
  63975. private _effectWrapper;
  63976. private _lodGenerationOffset;
  63977. private _lodGenerationScale;
  63978. /**
  63979. * Quality switch for prefiltering. Should be set to `Constants.TEXTURE_FILTERING_QUALITY_OFFLINE` unless
  63980. * you care about baking speed.
  63981. */
  63982. quality: number;
  63983. /**
  63984. * Scales pixel intensity for the input HDR map.
  63985. */
  63986. hdrScale: number;
  63987. /**
  63988. * Instantiates HDR filter for reflection maps
  63989. *
  63990. * @param engine Thin engine
  63991. * @param options Options
  63992. */
  63993. constructor(engine: ThinEngine, options?: IHDRFilteringOptions);
  63994. private _createRenderTarget;
  63995. private _prefilterInternal;
  63996. private _createEffect;
  63997. /**
  63998. * Get a value indicating if the filter is ready to be used
  63999. * @param texture Texture to filter
  64000. * @returns true if the filter is ready
  64001. */
  64002. isReady(texture: BaseTexture): boolean;
  64003. /**
  64004. * Prefilters a cube texture to have mipmap levels representing roughness values.
  64005. * Prefiltering will be invoked at the end of next rendering pass.
  64006. * This has to be done once the map is loaded, and has not been prefiltered by a third party software.
  64007. * See http://blog.selfshadow.com/publications/s2013-shading-course/karis/s2013_pbs_epic_notes_v2.pdf for more information
  64008. * @param texture Texture to filter
  64009. * @param onFinished Callback when filtering is done
  64010. * @return Promise called when prefiltering is done
  64011. */
  64012. prefilter(texture: BaseTexture, onFinished?: Nullable<() => void>): Promise<unknown> | undefined;
  64013. }
  64014. }
  64015. declare module "babylonjs/Materials/Textures/hdrCubeTexture" {
  64016. import { Nullable } from "babylonjs/types";
  64017. import { Scene } from "babylonjs/scene";
  64018. import { Matrix, Vector3 } from "babylonjs/Maths/math.vector";
  64019. import { BaseTexture } from "babylonjs/Materials/Textures/baseTexture";
  64020. import { ThinEngine } from "babylonjs/Engines/thinEngine";
  64021. import "babylonjs/Engines/Extensions/engine.rawTexture";
  64022. import "babylonjs/Materials/Textures/baseTexture.polynomial";
  64023. /**
  64024. * This represents a texture coming from an HDR input.
  64025. *
  64026. * The only supported format is currently panorama picture stored in RGBE format.
  64027. * Example of such files can be found on HDRLib: http://hdrlib.com/
  64028. */
  64029. export class HDRCubeTexture extends BaseTexture {
  64030. private static _facesMapping;
  64031. private _generateHarmonics;
  64032. private _noMipmap;
  64033. private _prefilterOnLoad;
  64034. private _textureMatrix;
  64035. private _size;
  64036. private _onLoad;
  64037. private _onError;
  64038. /**
  64039. * The texture URL.
  64040. */
  64041. url: string;
  64042. protected _isBlocking: boolean;
  64043. /**
  64044. * Sets wether or not the texture is blocking during loading.
  64045. */
  64046. set isBlocking(value: boolean);
  64047. /**
  64048. * Gets wether or not the texture is blocking during loading.
  64049. */
  64050. get isBlocking(): boolean;
  64051. protected _rotationY: number;
  64052. /**
  64053. * Sets texture matrix rotation angle around Y axis in radians.
  64054. */
  64055. set rotationY(value: number);
  64056. /**
  64057. * Gets texture matrix rotation angle around Y axis radians.
  64058. */
  64059. get rotationY(): number;
  64060. /**
  64061. * Gets or sets the center of the bounding box associated with the cube texture
  64062. * It must define where the camera used to render the texture was set
  64063. */
  64064. boundingBoxPosition: Vector3;
  64065. private _boundingBoxSize;
  64066. /**
  64067. * Gets or sets the size of the bounding box associated with the cube texture
  64068. * When defined, the cubemap will switch to local mode
  64069. * @see https://community.arm.com/graphics/b/blog/posts/reflections-based-on-local-cubemaps-in-unity
  64070. * @example https://www.babylonjs-playground.com/#RNASML
  64071. */
  64072. set boundingBoxSize(value: Vector3);
  64073. get boundingBoxSize(): Vector3;
  64074. /**
  64075. * Instantiates an HDRTexture from the following parameters.
  64076. *
  64077. * @param url The location of the HDR raw data (Panorama stored in RGBE format)
  64078. * @param sceneOrEngine The scene or engine the texture will be used in
  64079. * @param size The cubemap desired size (the more it increases the longer the generation will be)
  64080. * @param noMipmap Forces to not generate the mipmap if true
  64081. * @param generateHarmonics Specifies whether you want to extract the polynomial harmonics during the generation process
  64082. * @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)
  64083. * @param prefilterOnLoad Prefilters HDR texture to allow use of this texture as a PBR reflection texture.
  64084. */
  64085. 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>);
  64086. /**
  64087. * Get the current class name of the texture useful for serialization or dynamic coding.
  64088. * @returns "HDRCubeTexture"
  64089. */
  64090. getClassName(): string;
  64091. /**
  64092. * Occurs when the file is raw .hdr file.
  64093. */
  64094. private loadTexture;
  64095. clone(): HDRCubeTexture;
  64096. delayLoad(): void;
  64097. /**
  64098. * Get the texture reflection matrix used to rotate/transform the reflection.
  64099. * @returns the reflection matrix
  64100. */
  64101. getReflectionTextureMatrix(): Matrix;
  64102. /**
  64103. * Set the texture reflection matrix used to rotate/transform the reflection.
  64104. * @param value Define the reflection matrix to set
  64105. */
  64106. setReflectionTextureMatrix(value: Matrix): void;
  64107. /**
  64108. * Parses a JSON representation of an HDR Texture in order to create the texture
  64109. * @param parsedTexture Define the JSON representation
  64110. * @param scene Define the scene the texture should be created in
  64111. * @param rootUrl Define the root url in case we need to load relative dependencies
  64112. * @returns the newly created texture after parsing
  64113. */
  64114. static Parse(parsedTexture: any, scene: Scene, rootUrl: string): Nullable<HDRCubeTexture>;
  64115. serialize(): any;
  64116. }
  64117. }
  64118. declare module "babylonjs/Physics/physicsEngine" {
  64119. import { Nullable } from "babylonjs/types";
  64120. import { Vector3 } from "babylonjs/Maths/math.vector";
  64121. import { IPhysicsEngine, IPhysicsEnginePlugin } from "babylonjs/Physics/IPhysicsEngine";
  64122. import { PhysicsImpostor, IPhysicsEnabledObject } from "babylonjs/Physics/physicsImpostor";
  64123. import { PhysicsJoint } from "babylonjs/Physics/physicsJoint";
  64124. import { PhysicsRaycastResult } from "babylonjs/Physics/physicsRaycastResult";
  64125. /**
  64126. * Class used to control physics engine
  64127. * @see https://doc.babylonjs.com/how_to/using_the_physics_engine
  64128. */
  64129. export class PhysicsEngine implements IPhysicsEngine {
  64130. private _physicsPlugin;
  64131. /**
  64132. * Global value used to control the smallest number supported by the simulation
  64133. */
  64134. static Epsilon: number;
  64135. private _impostors;
  64136. private _joints;
  64137. private _subTimeStep;
  64138. /**
  64139. * Gets the gravity vector used by the simulation
  64140. */
  64141. gravity: Vector3;
  64142. /**
  64143. * Factory used to create the default physics plugin.
  64144. * @returns The default physics plugin
  64145. */
  64146. static DefaultPluginFactory(): IPhysicsEnginePlugin;
  64147. /**
  64148. * Creates a new Physics Engine
  64149. * @param gravity defines the gravity vector used by the simulation
  64150. * @param _physicsPlugin defines the plugin to use (CannonJS by default)
  64151. */
  64152. constructor(gravity: Nullable<Vector3>, _physicsPlugin?: IPhysicsEnginePlugin);
  64153. /**
  64154. * Sets the gravity vector used by the simulation
  64155. * @param gravity defines the gravity vector to use
  64156. */
  64157. setGravity(gravity: Vector3): void;
  64158. /**
  64159. * Set the time step of the physics engine.
  64160. * Default is 1/60.
  64161. * To slow it down, enter 1/600 for example.
  64162. * To speed it up, 1/30
  64163. * @param newTimeStep defines the new timestep to apply to this world.
  64164. */
  64165. setTimeStep(newTimeStep?: number): void;
  64166. /**
  64167. * Get the time step of the physics engine.
  64168. * @returns the current time step
  64169. */
  64170. getTimeStep(): number;
  64171. /**
  64172. * Set the sub time step of the physics engine.
  64173. * Default is 0 meaning there is no sub steps
  64174. * To increase physics resolution precision, set a small value (like 1 ms)
  64175. * @param subTimeStep defines the new sub timestep used for physics resolution.
  64176. */
  64177. setSubTimeStep(subTimeStep?: number): void;
  64178. /**
  64179. * Get the sub time step of the physics engine.
  64180. * @returns the current sub time step
  64181. */
  64182. getSubTimeStep(): number;
  64183. /**
  64184. * Release all resources
  64185. */
  64186. dispose(): void;
  64187. /**
  64188. * Gets the name of the current physics plugin
  64189. * @returns the name of the plugin
  64190. */
  64191. getPhysicsPluginName(): string;
  64192. /**
  64193. * Adding a new impostor for the impostor tracking.
  64194. * This will be done by the impostor itself.
  64195. * @param impostor the impostor to add
  64196. */
  64197. addImpostor(impostor: PhysicsImpostor): void;
  64198. /**
  64199. * Remove an impostor from the engine.
  64200. * This impostor and its mesh will not longer be updated by the physics engine.
  64201. * @param impostor the impostor to remove
  64202. */
  64203. removeImpostor(impostor: PhysicsImpostor): void;
  64204. /**
  64205. * Add a joint to the physics engine
  64206. * @param mainImpostor defines the main impostor to which the joint is added.
  64207. * @param connectedImpostor defines the impostor that is connected to the main impostor using this joint
  64208. * @param joint defines the joint that will connect both impostors.
  64209. */
  64210. addJoint(mainImpostor: PhysicsImpostor, connectedImpostor: PhysicsImpostor, joint: PhysicsJoint): void;
  64211. /**
  64212. * Removes a joint from the simulation
  64213. * @param mainImpostor defines the impostor used with the joint
  64214. * @param connectedImpostor defines the other impostor connected to the main one by the joint
  64215. * @param joint defines the joint to remove
  64216. */
  64217. removeJoint(mainImpostor: PhysicsImpostor, connectedImpostor: PhysicsImpostor, joint: PhysicsJoint): void;
  64218. /**
  64219. * Called by the scene. No need to call it.
  64220. * @param delta defines the timespam between frames
  64221. */
  64222. _step(delta: number): void;
  64223. /**
  64224. * Gets the current plugin used to run the simulation
  64225. * @returns current plugin
  64226. */
  64227. getPhysicsPlugin(): IPhysicsEnginePlugin;
  64228. /**
  64229. * Gets the list of physic impostors
  64230. * @returns an array of PhysicsImpostor
  64231. */
  64232. getImpostors(): Array<PhysicsImpostor>;
  64233. /**
  64234. * Gets the impostor for a physics enabled object
  64235. * @param object defines the object impersonated by the impostor
  64236. * @returns the PhysicsImpostor or null if not found
  64237. */
  64238. getImpostorForPhysicsObject(object: IPhysicsEnabledObject): Nullable<PhysicsImpostor>;
  64239. /**
  64240. * Gets the impostor for a physics body object
  64241. * @param body defines physics body used by the impostor
  64242. * @returns the PhysicsImpostor or null if not found
  64243. */
  64244. getImpostorWithPhysicsBody(body: any): Nullable<PhysicsImpostor>;
  64245. /**
  64246. * Does a raycast in the physics world
  64247. * @param from when should the ray start?
  64248. * @param to when should the ray end?
  64249. * @returns PhysicsRaycastResult
  64250. */
  64251. raycast(from: Vector3, to: Vector3): PhysicsRaycastResult;
  64252. }
  64253. }
  64254. declare module "babylonjs/Physics/Plugins/cannonJSPlugin" {
  64255. import { Nullable } from "babylonjs/types";
  64256. import { Vector3, Quaternion } from "babylonjs/Maths/math.vector";
  64257. import { AbstractMesh } from "babylonjs/Meshes/abstractMesh";
  64258. import { IPhysicsEnginePlugin, PhysicsImpostorJoint } from "babylonjs/Physics/IPhysicsEngine";
  64259. import { PhysicsImpostor } from "babylonjs/Physics/physicsImpostor";
  64260. import { PhysicsJoint, IMotorEnabledJoint } from "babylonjs/Physics/physicsJoint";
  64261. import { PhysicsRaycastResult } from "babylonjs/Physics/physicsRaycastResult";
  64262. /** @hidden */
  64263. export class CannonJSPlugin implements IPhysicsEnginePlugin {
  64264. private _useDeltaForWorldStep;
  64265. world: any;
  64266. name: string;
  64267. private _physicsMaterials;
  64268. private _fixedTimeStep;
  64269. private _cannonRaycastResult;
  64270. private _raycastResult;
  64271. private _physicsBodysToRemoveAfterStep;
  64272. private _firstFrame;
  64273. BJSCANNON: any;
  64274. constructor(_useDeltaForWorldStep?: boolean, iterations?: number, cannonInjection?: any);
  64275. setGravity(gravity: Vector3): void;
  64276. setTimeStep(timeStep: number): void;
  64277. getTimeStep(): number;
  64278. executeStep(delta: number, impostors: Array<PhysicsImpostor>): void;
  64279. private _removeMarkedPhysicsBodiesFromWorld;
  64280. applyImpulse(impostor: PhysicsImpostor, force: Vector3, contactPoint: Vector3): void;
  64281. applyForce(impostor: PhysicsImpostor, force: Vector3, contactPoint: Vector3): void;
  64282. generatePhysicsBody(impostor: PhysicsImpostor): void;
  64283. private _processChildMeshes;
  64284. removePhysicsBody(impostor: PhysicsImpostor): void;
  64285. generateJoint(impostorJoint: PhysicsImpostorJoint): void;
  64286. removeJoint(impostorJoint: PhysicsImpostorJoint): void;
  64287. private _addMaterial;
  64288. private _checkWithEpsilon;
  64289. private _createShape;
  64290. private _createHeightmap;
  64291. private _minus90X;
  64292. private _plus90X;
  64293. private _tmpPosition;
  64294. private _tmpDeltaPosition;
  64295. private _tmpUnityRotation;
  64296. private _updatePhysicsBodyTransformation;
  64297. setTransformationFromPhysicsBody(impostor: PhysicsImpostor): void;
  64298. setPhysicsBodyTransformation(impostor: PhysicsImpostor, newPosition: Vector3, newRotation: Quaternion): void;
  64299. isSupported(): boolean;
  64300. setLinearVelocity(impostor: PhysicsImpostor, velocity: Vector3): void;
  64301. setAngularVelocity(impostor: PhysicsImpostor, velocity: Vector3): void;
  64302. getLinearVelocity(impostor: PhysicsImpostor): Nullable<Vector3>;
  64303. getAngularVelocity(impostor: PhysicsImpostor): Nullable<Vector3>;
  64304. setBodyMass(impostor: PhysicsImpostor, mass: number): void;
  64305. getBodyMass(impostor: PhysicsImpostor): number;
  64306. getBodyFriction(impostor: PhysicsImpostor): number;
  64307. setBodyFriction(impostor: PhysicsImpostor, friction: number): void;
  64308. getBodyRestitution(impostor: PhysicsImpostor): number;
  64309. setBodyRestitution(impostor: PhysicsImpostor, restitution: number): void;
  64310. sleepBody(impostor: PhysicsImpostor): void;
  64311. wakeUpBody(impostor: PhysicsImpostor): void;
  64312. updateDistanceJoint(joint: PhysicsJoint, maxDistance: number): void;
  64313. setMotor(joint: IMotorEnabledJoint, speed?: number, maxForce?: number, motorIndex?: number): void;
  64314. setLimit(joint: IMotorEnabledJoint, upperLimit: number, lowerLimit?: number): void;
  64315. syncMeshWithImpostor(mesh: AbstractMesh, impostor: PhysicsImpostor): void;
  64316. getRadius(impostor: PhysicsImpostor): number;
  64317. getBoxSizeToRef(impostor: PhysicsImpostor, result: Vector3): void;
  64318. dispose(): void;
  64319. private _extendNamespace;
  64320. /**
  64321. * Does a raycast in the physics world
  64322. * @param from when should the ray start?
  64323. * @param to when should the ray end?
  64324. * @returns PhysicsRaycastResult
  64325. */
  64326. raycast(from: Vector3, to: Vector3): PhysicsRaycastResult;
  64327. }
  64328. }
  64329. declare module "babylonjs/Physics/Plugins/oimoJSPlugin" {
  64330. import { IPhysicsEnginePlugin, PhysicsImpostorJoint } from "babylonjs/Physics/IPhysicsEngine";
  64331. import { PhysicsImpostor } from "babylonjs/Physics/physicsImpostor";
  64332. import { PhysicsJoint, IMotorEnabledJoint } from "babylonjs/Physics/physicsJoint";
  64333. import { AbstractMesh } from "babylonjs/Meshes/abstractMesh";
  64334. import { Vector3, Quaternion } from "babylonjs/Maths/math.vector";
  64335. import { Nullable } from "babylonjs/types";
  64336. import { PhysicsRaycastResult } from "babylonjs/Physics/physicsRaycastResult";
  64337. /** @hidden */
  64338. export class OimoJSPlugin implements IPhysicsEnginePlugin {
  64339. private _useDeltaForWorldStep;
  64340. world: any;
  64341. name: string;
  64342. BJSOIMO: any;
  64343. private _raycastResult;
  64344. private _fixedTimeStep;
  64345. constructor(_useDeltaForWorldStep?: boolean, iterations?: number, oimoInjection?: any);
  64346. setGravity(gravity: Vector3): void;
  64347. setTimeStep(timeStep: number): void;
  64348. getTimeStep(): number;
  64349. private _tmpImpostorsArray;
  64350. executeStep(delta: number, impostors: Array<PhysicsImpostor>): void;
  64351. applyImpulse(impostor: PhysicsImpostor, force: Vector3, contactPoint: Vector3): void;
  64352. applyForce(impostor: PhysicsImpostor, force: Vector3, contactPoint: Vector3): void;
  64353. generatePhysicsBody(impostor: PhysicsImpostor): void;
  64354. private _tmpPositionVector;
  64355. removePhysicsBody(impostor: PhysicsImpostor): void;
  64356. generateJoint(impostorJoint: PhysicsImpostorJoint): void;
  64357. removeJoint(impostorJoint: PhysicsImpostorJoint): void;
  64358. isSupported(): boolean;
  64359. setTransformationFromPhysicsBody(impostor: PhysicsImpostor): void;
  64360. setPhysicsBodyTransformation(impostor: PhysicsImpostor, newPosition: Vector3, newRotation: Quaternion): void;
  64361. setLinearVelocity(impostor: PhysicsImpostor, velocity: Vector3): void;
  64362. setAngularVelocity(impostor: PhysicsImpostor, velocity: Vector3): void;
  64363. getLinearVelocity(impostor: PhysicsImpostor): Nullable<Vector3>;
  64364. getAngularVelocity(impostor: PhysicsImpostor): Nullable<Vector3>;
  64365. setBodyMass(impostor: PhysicsImpostor, mass: number): void;
  64366. getBodyMass(impostor: PhysicsImpostor): number;
  64367. getBodyFriction(impostor: PhysicsImpostor): number;
  64368. setBodyFriction(impostor: PhysicsImpostor, friction: number): void;
  64369. getBodyRestitution(impostor: PhysicsImpostor): number;
  64370. setBodyRestitution(impostor: PhysicsImpostor, restitution: number): void;
  64371. sleepBody(impostor: PhysicsImpostor): void;
  64372. wakeUpBody(impostor: PhysicsImpostor): void;
  64373. updateDistanceJoint(joint: PhysicsJoint, maxDistance: number, minDistance?: number): void;
  64374. setMotor(joint: IMotorEnabledJoint, speed: number, force?: number, motorIndex?: number): void;
  64375. setLimit(joint: IMotorEnabledJoint, upperLimit: number, lowerLimit?: number, motorIndex?: number): void;
  64376. syncMeshWithImpostor(mesh: AbstractMesh, impostor: PhysicsImpostor): void;
  64377. getRadius(impostor: PhysicsImpostor): number;
  64378. getBoxSizeToRef(impostor: PhysicsImpostor, result: Vector3): void;
  64379. dispose(): void;
  64380. /**
  64381. * Does a raycast in the physics world
  64382. * @param from when should the ray start?
  64383. * @param to when should the ray end?
  64384. * @returns PhysicsRaycastResult
  64385. */
  64386. raycast(from: Vector3, to: Vector3): PhysicsRaycastResult;
  64387. }
  64388. }
  64389. declare module "babylonjs/Physics/Plugins/ammoJSPlugin" {
  64390. import { Quaternion, Vector3 } from "babylonjs/Maths/math.vector";
  64391. import { IPhysicsEnginePlugin, PhysicsImpostorJoint } from "babylonjs/Physics/IPhysicsEngine";
  64392. import { PhysicsImpostor } from "babylonjs/Physics/physicsImpostor";
  64393. import { PhysicsJoint, IMotorEnabledJoint } from "babylonjs/Physics/physicsJoint";
  64394. import { Nullable } from "babylonjs/types";
  64395. import { AbstractMesh } from "babylonjs/Meshes/abstractMesh";
  64396. import { PhysicsRaycastResult } from "babylonjs/Physics/physicsRaycastResult";
  64397. /**
  64398. * AmmoJS Physics plugin
  64399. * @see https://doc.babylonjs.com/how_to/using_the_physics_engine
  64400. * @see https://github.com/kripken/ammo.js/
  64401. */
  64402. export class AmmoJSPlugin implements IPhysicsEnginePlugin {
  64403. private _useDeltaForWorldStep;
  64404. /**
  64405. * Reference to the Ammo library
  64406. */
  64407. bjsAMMO: any;
  64408. /**
  64409. * Created ammoJS world which physics bodies are added to
  64410. */
  64411. world: any;
  64412. /**
  64413. * Name of the plugin
  64414. */
  64415. name: string;
  64416. private _timeStep;
  64417. private _fixedTimeStep;
  64418. private _maxSteps;
  64419. private _tmpQuaternion;
  64420. private _tmpAmmoTransform;
  64421. private _tmpAmmoQuaternion;
  64422. private _tmpAmmoConcreteContactResultCallback;
  64423. private _collisionConfiguration;
  64424. private _dispatcher;
  64425. private _overlappingPairCache;
  64426. private _solver;
  64427. private _softBodySolver;
  64428. private _tmpAmmoVectorA;
  64429. private _tmpAmmoVectorB;
  64430. private _tmpAmmoVectorC;
  64431. private _tmpAmmoVectorD;
  64432. private _tmpContactCallbackResult;
  64433. private _tmpAmmoVectorRCA;
  64434. private _tmpAmmoVectorRCB;
  64435. private _raycastResult;
  64436. private _tmpContactPoint;
  64437. private static readonly DISABLE_COLLISION_FLAG;
  64438. private static readonly KINEMATIC_FLAG;
  64439. private static readonly DISABLE_DEACTIVATION_FLAG;
  64440. /**
  64441. * Initializes the ammoJS plugin
  64442. * @param _useDeltaForWorldStep if the time between frames should be used when calculating physics steps (Default: true)
  64443. * @param ammoInjection can be used to inject your own ammo reference
  64444. * @param overlappingPairCache can be used to specify your own overlapping pair cache
  64445. */
  64446. constructor(_useDeltaForWorldStep?: boolean, ammoInjection?: any, overlappingPairCache?: any);
  64447. /**
  64448. * Sets the gravity of the physics world (m/(s^2))
  64449. * @param gravity Gravity to set
  64450. */
  64451. setGravity(gravity: Vector3): void;
  64452. /**
  64453. * Amount of time to step forward on each frame (only used if useDeltaForWorldStep is false in the constructor)
  64454. * @param timeStep timestep to use in seconds
  64455. */
  64456. setTimeStep(timeStep: number): void;
  64457. /**
  64458. * 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)
  64459. * @param fixedTimeStep fixedTimeStep to use in seconds
  64460. */
  64461. setFixedTimeStep(fixedTimeStep: number): void;
  64462. /**
  64463. * Sets the maximum number of steps by the physics engine per frame (Default: 5)
  64464. * @param maxSteps the maximum number of steps by the physics engine per frame
  64465. */
  64466. setMaxSteps(maxSteps: number): void;
  64467. /**
  64468. * Gets the current timestep (only used if useDeltaForWorldStep is false in the constructor)
  64469. * @returns the current timestep in seconds
  64470. */
  64471. getTimeStep(): number;
  64472. /**
  64473. * The create custom shape handler function to be called when using BABYLON.PhysicsImposter.CustomImpostor
  64474. */
  64475. onCreateCustomShape: (impostor: PhysicsImpostor) => any;
  64476. private _isImpostorInContact;
  64477. private _isImpostorPairInContact;
  64478. private _stepSimulation;
  64479. /**
  64480. * Moves the physics simulation forward delta seconds and updates the given physics imposters
  64481. * Prior to the step the imposters physics location is set to the position of the babylon meshes
  64482. * After the step the babylon meshes are set to the position of the physics imposters
  64483. * @param delta amount of time to step forward
  64484. * @param impostors array of imposters to update before/after the step
  64485. */
  64486. executeStep(delta: number, impostors: Array<PhysicsImpostor>): void;
  64487. /**
  64488. * Update babylon mesh to match physics world object
  64489. * @param impostor imposter to match
  64490. */
  64491. private _afterSoftStep;
  64492. /**
  64493. * Update babylon mesh vertices vertices to match physics world softbody or cloth
  64494. * @param impostor imposter to match
  64495. */
  64496. private _ropeStep;
  64497. /**
  64498. * Update babylon mesh vertices vertices to match physics world softbody or cloth
  64499. * @param impostor imposter to match
  64500. */
  64501. private _softbodyOrClothStep;
  64502. private _tmpMatrix;
  64503. /**
  64504. * Applies an impulse on the imposter
  64505. * @param impostor imposter to apply impulse to
  64506. * @param force amount of force to be applied to the imposter
  64507. * @param contactPoint the location to apply the impulse on the imposter
  64508. */
  64509. applyImpulse(impostor: PhysicsImpostor, force: Vector3, contactPoint: Vector3): void;
  64510. /**
  64511. * Applies a force on the imposter
  64512. * @param impostor imposter to apply force
  64513. * @param force amount of force to be applied to the imposter
  64514. * @param contactPoint the location to apply the force on the imposter
  64515. */
  64516. applyForce(impostor: PhysicsImpostor, force: Vector3, contactPoint: Vector3): void;
  64517. /**
  64518. * Creates a physics body using the plugin
  64519. * @param impostor the imposter to create the physics body on
  64520. */
  64521. generatePhysicsBody(impostor: PhysicsImpostor): void;
  64522. /**
  64523. * Removes the physics body from the imposter and disposes of the body's memory
  64524. * @param impostor imposter to remove the physics body from
  64525. */
  64526. removePhysicsBody(impostor: PhysicsImpostor): void;
  64527. /**
  64528. * Generates a joint
  64529. * @param impostorJoint the imposter joint to create the joint with
  64530. */
  64531. generateJoint(impostorJoint: PhysicsImpostorJoint): void;
  64532. /**
  64533. * Removes a joint
  64534. * @param impostorJoint the imposter joint to remove the joint from
  64535. */
  64536. removeJoint(impostorJoint: PhysicsImpostorJoint): void;
  64537. private _addMeshVerts;
  64538. /**
  64539. * Initialise the soft body vertices to match its object's (mesh) vertices
  64540. * Softbody vertices (nodes) are in world space and to match this
  64541. * The object's position and rotation is set to zero and so its vertices are also then set in world space
  64542. * @param impostor to create the softbody for
  64543. */
  64544. private _softVertexData;
  64545. /**
  64546. * Create an impostor's soft body
  64547. * @param impostor to create the softbody for
  64548. */
  64549. private _createSoftbody;
  64550. /**
  64551. * Create cloth for an impostor
  64552. * @param impostor to create the softbody for
  64553. */
  64554. private _createCloth;
  64555. /**
  64556. * Create rope for an impostor
  64557. * @param impostor to create the softbody for
  64558. */
  64559. private _createRope;
  64560. /**
  64561. * Create a custom physics impostor shape using the plugin's onCreateCustomShape handler
  64562. * @param impostor to create the custom physics shape for
  64563. */
  64564. private _createCustom;
  64565. private _addHullVerts;
  64566. private _createShape;
  64567. /**
  64568. * Sets the physics body position/rotation from the babylon mesh's position/rotation
  64569. * @param impostor imposter containing the physics body and babylon object
  64570. */
  64571. setTransformationFromPhysicsBody(impostor: PhysicsImpostor): void;
  64572. /**
  64573. * Sets the babylon object's position/rotation from the physics body's position/rotation
  64574. * @param impostor imposter containing the physics body and babylon object
  64575. * @param newPosition new position
  64576. * @param newRotation new rotation
  64577. */
  64578. setPhysicsBodyTransformation(impostor: PhysicsImpostor, newPosition: Vector3, newRotation: Quaternion): void;
  64579. /**
  64580. * If this plugin is supported
  64581. * @returns true if its supported
  64582. */
  64583. isSupported(): boolean;
  64584. /**
  64585. * Sets the linear velocity of the physics body
  64586. * @param impostor imposter to set the velocity on
  64587. * @param velocity velocity to set
  64588. */
  64589. setLinearVelocity(impostor: PhysicsImpostor, velocity: Vector3): void;
  64590. /**
  64591. * Sets the angular velocity of the physics body
  64592. * @param impostor imposter to set the velocity on
  64593. * @param velocity velocity to set
  64594. */
  64595. setAngularVelocity(impostor: PhysicsImpostor, velocity: Vector3): void;
  64596. /**
  64597. * gets the linear velocity
  64598. * @param impostor imposter to get linear velocity from
  64599. * @returns linear velocity
  64600. */
  64601. getLinearVelocity(impostor: PhysicsImpostor): Nullable<Vector3>;
  64602. /**
  64603. * gets the angular velocity
  64604. * @param impostor imposter to get angular velocity from
  64605. * @returns angular velocity
  64606. */
  64607. getAngularVelocity(impostor: PhysicsImpostor): Nullable<Vector3>;
  64608. /**
  64609. * Sets the mass of physics body
  64610. * @param impostor imposter to set the mass on
  64611. * @param mass mass to set
  64612. */
  64613. setBodyMass(impostor: PhysicsImpostor, mass: number): void;
  64614. /**
  64615. * Gets the mass of the physics body
  64616. * @param impostor imposter to get the mass from
  64617. * @returns mass
  64618. */
  64619. getBodyMass(impostor: PhysicsImpostor): number;
  64620. /**
  64621. * Gets friction of the impostor
  64622. * @param impostor impostor to get friction from
  64623. * @returns friction value
  64624. */
  64625. getBodyFriction(impostor: PhysicsImpostor): number;
  64626. /**
  64627. * Sets friction of the impostor
  64628. * @param impostor impostor to set friction on
  64629. * @param friction friction value
  64630. */
  64631. setBodyFriction(impostor: PhysicsImpostor, friction: number): void;
  64632. /**
  64633. * Gets restitution of the impostor
  64634. * @param impostor impostor to get restitution from
  64635. * @returns restitution value
  64636. */
  64637. getBodyRestitution(impostor: PhysicsImpostor): number;
  64638. /**
  64639. * Sets resitution of the impostor
  64640. * @param impostor impostor to set resitution on
  64641. * @param restitution resitution value
  64642. */
  64643. setBodyRestitution(impostor: PhysicsImpostor, restitution: number): void;
  64644. /**
  64645. * Gets pressure inside the impostor
  64646. * @param impostor impostor to get pressure from
  64647. * @returns pressure value
  64648. */
  64649. getBodyPressure(impostor: PhysicsImpostor): number;
  64650. /**
  64651. * Sets pressure inside a soft body impostor
  64652. * Cloth and rope must remain 0 pressure
  64653. * @param impostor impostor to set pressure on
  64654. * @param pressure pressure value
  64655. */
  64656. setBodyPressure(impostor: PhysicsImpostor, pressure: number): void;
  64657. /**
  64658. * Gets stiffness of the impostor
  64659. * @param impostor impostor to get stiffness from
  64660. * @returns pressure value
  64661. */
  64662. getBodyStiffness(impostor: PhysicsImpostor): number;
  64663. /**
  64664. * Sets stiffness of the impostor
  64665. * @param impostor impostor to set stiffness on
  64666. * @param stiffness stiffness value from 0 to 1
  64667. */
  64668. setBodyStiffness(impostor: PhysicsImpostor, stiffness: number): void;
  64669. /**
  64670. * Gets velocityIterations of the impostor
  64671. * @param impostor impostor to get velocity iterations from
  64672. * @returns velocityIterations value
  64673. */
  64674. getBodyVelocityIterations(impostor: PhysicsImpostor): number;
  64675. /**
  64676. * Sets velocityIterations of the impostor
  64677. * @param impostor impostor to set velocity iterations on
  64678. * @param velocityIterations velocityIterations value
  64679. */
  64680. setBodyVelocityIterations(impostor: PhysicsImpostor, velocityIterations: number): void;
  64681. /**
  64682. * Gets positionIterations of the impostor
  64683. * @param impostor impostor to get position iterations from
  64684. * @returns positionIterations value
  64685. */
  64686. getBodyPositionIterations(impostor: PhysicsImpostor): number;
  64687. /**
  64688. * Sets positionIterations of the impostor
  64689. * @param impostor impostor to set position on
  64690. * @param positionIterations positionIterations value
  64691. */
  64692. setBodyPositionIterations(impostor: PhysicsImpostor, positionIterations: number): void;
  64693. /**
  64694. * Append an anchor to a cloth object
  64695. * @param impostor is the cloth impostor to add anchor to
  64696. * @param otherImpostor is the rigid impostor to anchor to
  64697. * @param width ratio across width from 0 to 1
  64698. * @param height ratio up height from 0 to 1
  64699. * @param influence the elasticity between cloth impostor and anchor from 0, very stretchy to 1, little strech
  64700. * @param noCollisionBetweenLinkedBodies when true collisions between soft impostor and anchor are ignored; default false
  64701. */
  64702. appendAnchor(impostor: PhysicsImpostor, otherImpostor: PhysicsImpostor, width: number, height: number, influence?: number, noCollisionBetweenLinkedBodies?: boolean): void;
  64703. /**
  64704. * Append an hook to a rope object
  64705. * @param impostor is the rope impostor to add hook to
  64706. * @param otherImpostor is the rigid impostor to hook to
  64707. * @param length ratio along the rope from 0 to 1
  64708. * @param influence the elasticity between soft impostor and anchor from 0, very stretchy to 1, little strech
  64709. * @param noCollisionBetweenLinkedBodies when true collisions between soft impostor and anchor are ignored; default false
  64710. */
  64711. appendHook(impostor: PhysicsImpostor, otherImpostor: PhysicsImpostor, length: number, influence?: number, noCollisionBetweenLinkedBodies?: boolean): void;
  64712. /**
  64713. * Sleeps the physics body and stops it from being active
  64714. * @param impostor impostor to sleep
  64715. */
  64716. sleepBody(impostor: PhysicsImpostor): void;
  64717. /**
  64718. * Activates the physics body
  64719. * @param impostor impostor to activate
  64720. */
  64721. wakeUpBody(impostor: PhysicsImpostor): void;
  64722. /**
  64723. * Updates the distance parameters of the joint
  64724. * @param joint joint to update
  64725. * @param maxDistance maximum distance of the joint
  64726. * @param minDistance minimum distance of the joint
  64727. */
  64728. updateDistanceJoint(joint: PhysicsJoint, maxDistance: number, minDistance?: number): void;
  64729. /**
  64730. * Sets a motor on the joint
  64731. * @param joint joint to set motor on
  64732. * @param speed speed of the motor
  64733. * @param maxForce maximum force of the motor
  64734. * @param motorIndex index of the motor
  64735. */
  64736. setMotor(joint: IMotorEnabledJoint, speed?: number, maxForce?: number, motorIndex?: number): void;
  64737. /**
  64738. * Sets the motors limit
  64739. * @param joint joint to set limit on
  64740. * @param upperLimit upper limit
  64741. * @param lowerLimit lower limit
  64742. */
  64743. setLimit(joint: IMotorEnabledJoint, upperLimit: number, lowerLimit?: number): void;
  64744. /**
  64745. * Syncs the position and rotation of a mesh with the impostor
  64746. * @param mesh mesh to sync
  64747. * @param impostor impostor to update the mesh with
  64748. */
  64749. syncMeshWithImpostor(mesh: AbstractMesh, impostor: PhysicsImpostor): void;
  64750. /**
  64751. * Gets the radius of the impostor
  64752. * @param impostor impostor to get radius from
  64753. * @returns the radius
  64754. */
  64755. getRadius(impostor: PhysicsImpostor): number;
  64756. /**
  64757. * Gets the box size of the impostor
  64758. * @param impostor impostor to get box size from
  64759. * @param result the resulting box size
  64760. */
  64761. getBoxSizeToRef(impostor: PhysicsImpostor, result: Vector3): void;
  64762. /**
  64763. * Disposes of the impostor
  64764. */
  64765. dispose(): void;
  64766. /**
  64767. * Does a raycast in the physics world
  64768. * @param from when should the ray start?
  64769. * @param to when should the ray end?
  64770. * @returns PhysicsRaycastResult
  64771. */
  64772. raycast(from: Vector3, to: Vector3): PhysicsRaycastResult;
  64773. }
  64774. }
  64775. declare module "babylonjs/Probes/reflectionProbe" {
  64776. import { RenderTargetTexture } from "babylonjs/Materials/Textures/renderTargetTexture";
  64777. import { Vector3 } from "babylonjs/Maths/math.vector";
  64778. import { AbstractMesh } from "babylonjs/Meshes/abstractMesh";
  64779. import { Nullable } from "babylonjs/types";
  64780. import { Scene } from "babylonjs/scene";
  64781. module "babylonjs/abstractScene" {
  64782. interface AbstractScene {
  64783. /**
  64784. * The list of reflection probes added to the scene
  64785. * @see https://doc.babylonjs.com/how_to/how_to_use_reflection_probes
  64786. */
  64787. reflectionProbes: Array<ReflectionProbe>;
  64788. /**
  64789. * Removes the given reflection probe from this scene.
  64790. * @param toRemove The reflection probe to remove
  64791. * @returns The index of the removed reflection probe
  64792. */
  64793. removeReflectionProbe(toRemove: ReflectionProbe): number;
  64794. /**
  64795. * Adds the given reflection probe to this scene.
  64796. * @param newReflectionProbe The reflection probe to add
  64797. */
  64798. addReflectionProbe(newReflectionProbe: ReflectionProbe): void;
  64799. }
  64800. }
  64801. /**
  64802. * Class used to generate realtime reflection / refraction cube textures
  64803. * @see https://doc.babylonjs.com/how_to/how_to_use_reflection_probes
  64804. */
  64805. export class ReflectionProbe {
  64806. /** defines the name of the probe */
  64807. name: string;
  64808. private _scene;
  64809. private _renderTargetTexture;
  64810. private _projectionMatrix;
  64811. private _viewMatrix;
  64812. private _target;
  64813. private _add;
  64814. private _attachedMesh;
  64815. private _invertYAxis;
  64816. /** Gets or sets probe position (center of the cube map) */
  64817. position: Vector3;
  64818. /**
  64819. * Creates a new reflection probe
  64820. * @param name defines the name of the probe
  64821. * @param size defines the texture resolution (for each face)
  64822. * @param scene defines the hosting scene
  64823. * @param generateMipMaps defines if mip maps should be generated automatically (true by default)
  64824. * @param useFloat defines if HDR data (flaot data) should be used to store colors (false by default)
  64825. */
  64826. constructor(
  64827. /** defines the name of the probe */
  64828. name: string, size: number, scene: Scene, generateMipMaps?: boolean, useFloat?: boolean);
  64829. /** Gets or sets the number of samples to use for multi-sampling (0 by default). Required WebGL2 */
  64830. get samples(): number;
  64831. set samples(value: number);
  64832. /** Gets or sets the refresh rate to use (on every frame by default) */
  64833. get refreshRate(): number;
  64834. set refreshRate(value: number);
  64835. /**
  64836. * Gets the hosting scene
  64837. * @returns a Scene
  64838. */
  64839. getScene(): Scene;
  64840. /** Gets the internal CubeTexture used to render to */
  64841. get cubeTexture(): RenderTargetTexture;
  64842. /** Gets the list of meshes to render */
  64843. get renderList(): Nullable<AbstractMesh[]>;
  64844. /**
  64845. * Attach the probe to a specific mesh (Rendering will be done from attached mesh's position)
  64846. * @param mesh defines the mesh to attach to
  64847. */
  64848. attachToMesh(mesh: Nullable<AbstractMesh>): void;
  64849. /**
  64850. * Specifies whether or not the stencil and depth buffer are cleared between two rendering groups
  64851. * @param renderingGroupId The rendering group id corresponding to its index
  64852. * @param autoClearDepthStencil Automatically clears depth and stencil between groups if true.
  64853. */
  64854. setRenderingAutoClearDepthStencil(renderingGroupId: number, autoClearDepthStencil: boolean): void;
  64855. /**
  64856. * Clean all associated resources
  64857. */
  64858. dispose(): void;
  64859. /**
  64860. * Converts the reflection probe information to a readable string for debug purpose.
  64861. * @param fullDetails Supports for multiple levels of logging within scene loading
  64862. * @returns the human readable reflection probe info
  64863. */
  64864. toString(fullDetails?: boolean): string;
  64865. /**
  64866. * Get the class name of the relfection probe.
  64867. * @returns "ReflectionProbe"
  64868. */
  64869. getClassName(): string;
  64870. /**
  64871. * Serialize the reflection probe to a JSON representation we can easily use in the resepective Parse function.
  64872. * @returns The JSON representation of the texture
  64873. */
  64874. serialize(): any;
  64875. /**
  64876. * Parse the JSON representation of a reflection probe in order to recreate the reflection probe in the given scene.
  64877. * @param parsedReflectionProbe Define the JSON representation of the reflection probe
  64878. * @param scene Define the scene the parsed reflection probe should be instantiated in
  64879. * @param rootUrl Define the root url of the parsing sequence in the case of relative dependencies
  64880. * @returns The parsed reflection probe if successful
  64881. */
  64882. static Parse(parsedReflectionProbe: any, scene: Scene, rootUrl: string): Nullable<ReflectionProbe>;
  64883. }
  64884. }
  64885. declare module "babylonjs/Loading/Plugins/babylonFileLoader" {
  64886. /** @hidden */
  64887. export var _BabylonLoaderRegistered: boolean;
  64888. /**
  64889. * Helps setting up some configuration for the babylon file loader.
  64890. */
  64891. export class BabylonFileLoaderConfiguration {
  64892. /**
  64893. * The loader does not allow injecting custom physix engine into the plugins.
  64894. * Unfortunately in ES6, we need to manually inject them into the plugin.
  64895. * So you could set this variable to your engine import to make it work.
  64896. */
  64897. static LoaderInjectedPhysicsEngine: any;
  64898. }
  64899. }
  64900. declare module "babylonjs/Loading/Plugins/index" {
  64901. export * from "babylonjs/Loading/Plugins/babylonFileLoader";
  64902. }
  64903. declare module "babylonjs/Loading/index" {
  64904. export * from "babylonjs/Loading/loadingScreen";
  64905. export * from "babylonjs/Loading/Plugins/index";
  64906. export * from "babylonjs/Loading/sceneLoader";
  64907. export * from "babylonjs/Loading/sceneLoaderFlags";
  64908. }
  64909. declare module "babylonjs/Materials/Background/index" {
  64910. export * from "babylonjs/Materials/Background/backgroundMaterial";
  64911. }
  64912. declare module "babylonjs/Materials/PBR/pbrBaseSimpleMaterial" {
  64913. import { Scene } from "babylonjs/scene";
  64914. import { Color3 } from "babylonjs/Maths/math.color";
  64915. import { PBRBaseMaterial } from "babylonjs/Materials/PBR/pbrBaseMaterial";
  64916. import { BaseTexture } from "babylonjs/Materials/Textures/baseTexture";
  64917. /**
  64918. * The Physically based simple base material of BJS.
  64919. *
  64920. * This enables better naming and convention enforcements on top of the pbrMaterial.
  64921. * It is used as the base class for both the specGloss and metalRough conventions.
  64922. */
  64923. export abstract class PBRBaseSimpleMaterial extends PBRBaseMaterial {
  64924. /**
  64925. * Number of Simultaneous lights allowed on the material.
  64926. */
  64927. maxSimultaneousLights: number;
  64928. /**
  64929. * If sets to true, disables all the lights affecting the material.
  64930. */
  64931. disableLighting: boolean;
  64932. /**
  64933. * Environment Texture used in the material (this is use for both reflection and environment lighting).
  64934. */
  64935. environmentTexture: BaseTexture;
  64936. /**
  64937. * If sets to true, x component of normal map value will invert (x = 1.0 - x).
  64938. */
  64939. invertNormalMapX: boolean;
  64940. /**
  64941. * If sets to true, y component of normal map value will invert (y = 1.0 - y).
  64942. */
  64943. invertNormalMapY: boolean;
  64944. /**
  64945. * Normal map used in the model.
  64946. */
  64947. normalTexture: BaseTexture;
  64948. /**
  64949. * Emissivie color used to self-illuminate the model.
  64950. */
  64951. emissiveColor: Color3;
  64952. /**
  64953. * Emissivie texture used to self-illuminate the model.
  64954. */
  64955. emissiveTexture: BaseTexture;
  64956. /**
  64957. * Occlusion Channel Strenght.
  64958. */
  64959. occlusionStrength: number;
  64960. /**
  64961. * Occlusion Texture of the material (adding extra occlusion effects).
  64962. */
  64963. occlusionTexture: BaseTexture;
  64964. /**
  64965. * Defines the alpha limits in alpha test mode.
  64966. */
  64967. alphaCutOff: number;
  64968. /**
  64969. * Gets the current double sided mode.
  64970. */
  64971. get doubleSided(): boolean;
  64972. /**
  64973. * If sets to true and backfaceCulling is false, normals will be flipped on the backside.
  64974. */
  64975. set doubleSided(value: boolean);
  64976. /**
  64977. * Stores the pre-calculated light information of a mesh in a texture.
  64978. */
  64979. lightmapTexture: BaseTexture;
  64980. /**
  64981. * If true, the light map contains occlusion information instead of lighting info.
  64982. */
  64983. useLightmapAsShadowmap: boolean;
  64984. /**
  64985. * Instantiates a new PBRMaterial instance.
  64986. *
  64987. * @param name The material name
  64988. * @param scene The scene the material will be use in.
  64989. */
  64990. constructor(name: string, scene: Scene);
  64991. getClassName(): string;
  64992. }
  64993. }
  64994. declare module "babylonjs/Materials/PBR/pbrMetallicRoughnessMaterial" {
  64995. import { Scene } from "babylonjs/scene";
  64996. import { Color3 } from "babylonjs/Maths/math.color";
  64997. import { BaseTexture } from "babylonjs/Materials/Textures/baseTexture";
  64998. import { PBRBaseSimpleMaterial } from "babylonjs/Materials/PBR/pbrBaseSimpleMaterial";
  64999. /**
  65000. * The PBR material of BJS following the metal roughness convention.
  65001. *
  65002. * This fits to the PBR convention in the GLTF definition:
  65003. * https://github.com/KhronosGroup/glTF/tree/2.0/specification/2.0
  65004. */
  65005. export class PBRMetallicRoughnessMaterial extends PBRBaseSimpleMaterial {
  65006. /**
  65007. * The base color has two different interpretations depending on the value of metalness.
  65008. * When the material is a metal, the base color is the specific measured reflectance value
  65009. * at normal incidence (F0). For a non-metal the base color represents the reflected diffuse color
  65010. * of the material.
  65011. */
  65012. baseColor: Color3;
  65013. /**
  65014. * Base texture of the metallic workflow. It contains both the baseColor information in RGB as
  65015. * well as opacity information in the alpha channel.
  65016. */
  65017. baseTexture: BaseTexture;
  65018. /**
  65019. * Specifies the metallic scalar value of the material.
  65020. * Can also be used to scale the metalness values of the metallic texture.
  65021. */
  65022. metallic: number;
  65023. /**
  65024. * Specifies the roughness scalar value of the material.
  65025. * Can also be used to scale the roughness values of the metallic texture.
  65026. */
  65027. roughness: number;
  65028. /**
  65029. * Texture containing both the metallic value in the B channel and the
  65030. * roughness value in the G channel to keep better precision.
  65031. */
  65032. metallicRoughnessTexture: BaseTexture;
  65033. /**
  65034. * Instantiates a new PBRMetalRoughnessMaterial instance.
  65035. *
  65036. * @param name The material name
  65037. * @param scene The scene the material will be use in.
  65038. */
  65039. constructor(name: string, scene: Scene);
  65040. /**
  65041. * Return the currrent class name of the material.
  65042. */
  65043. getClassName(): string;
  65044. /**
  65045. * Makes a duplicate of the current material.
  65046. * @param name - name to use for the new material.
  65047. */
  65048. clone(name: string): PBRMetallicRoughnessMaterial;
  65049. /**
  65050. * Serialize the material to a parsable JSON object.
  65051. */
  65052. serialize(): any;
  65053. /**
  65054. * Parses a JSON object correponding to the serialize function.
  65055. */
  65056. static Parse(source: any, scene: Scene, rootUrl: string): PBRMetallicRoughnessMaterial;
  65057. }
  65058. }
  65059. declare module "babylonjs/Materials/PBR/pbrSpecularGlossinessMaterial" {
  65060. import { Scene } from "babylonjs/scene";
  65061. import { Color3 } from "babylonjs/Maths/math.color";
  65062. import { BaseTexture } from "babylonjs/Materials/Textures/baseTexture";
  65063. import { PBRBaseSimpleMaterial } from "babylonjs/Materials/PBR/pbrBaseSimpleMaterial";
  65064. /**
  65065. * The PBR material of BJS following the specular glossiness convention.
  65066. *
  65067. * This fits to the PBR convention in the GLTF definition:
  65068. * https://github.com/KhronosGroup/glTF/tree/2.0/extensions/Khronos/KHR_materials_pbrSpecularGlossiness
  65069. */
  65070. export class PBRSpecularGlossinessMaterial extends PBRBaseSimpleMaterial {
  65071. /**
  65072. * Specifies the diffuse color of the material.
  65073. */
  65074. diffuseColor: Color3;
  65075. /**
  65076. * Specifies the diffuse texture of the material. This can also contains the opcity value in its alpha
  65077. * channel.
  65078. */
  65079. diffuseTexture: BaseTexture;
  65080. /**
  65081. * Specifies the specular color of the material. This indicates how reflective is the material (none to mirror).
  65082. */
  65083. specularColor: Color3;
  65084. /**
  65085. * Specifies the glossiness of the material. This indicates "how sharp is the reflection".
  65086. */
  65087. glossiness: number;
  65088. /**
  65089. * Specifies both the specular color RGB and the glossiness A of the material per pixels.
  65090. */
  65091. specularGlossinessTexture: BaseTexture;
  65092. /**
  65093. * Instantiates a new PBRSpecularGlossinessMaterial instance.
  65094. *
  65095. * @param name The material name
  65096. * @param scene The scene the material will be use in.
  65097. */
  65098. constructor(name: string, scene: Scene);
  65099. /**
  65100. * Return the currrent class name of the material.
  65101. */
  65102. getClassName(): string;
  65103. /**
  65104. * Makes a duplicate of the current material.
  65105. * @param name - name to use for the new material.
  65106. */
  65107. clone(name: string): PBRSpecularGlossinessMaterial;
  65108. /**
  65109. * Serialize the material to a parsable JSON object.
  65110. */
  65111. serialize(): any;
  65112. /**
  65113. * Parses a JSON object correponding to the serialize function.
  65114. */
  65115. static Parse(source: any, scene: Scene, rootUrl: string): PBRSpecularGlossinessMaterial;
  65116. }
  65117. }
  65118. declare module "babylonjs/Materials/PBR/index" {
  65119. export * from "babylonjs/Materials/PBR/pbrBaseMaterial";
  65120. export * from "babylonjs/Materials/PBR/pbrBaseSimpleMaterial";
  65121. export * from "babylonjs/Materials/PBR/pbrMaterial";
  65122. export * from "babylonjs/Materials/PBR/pbrMetallicRoughnessMaterial";
  65123. export * from "babylonjs/Materials/PBR/pbrSpecularGlossinessMaterial";
  65124. }
  65125. declare module "babylonjs/Materials/Textures/colorGradingTexture" {
  65126. import { Nullable } from "babylonjs/types";
  65127. import { Scene } from "babylonjs/scene";
  65128. import { Matrix } from "babylonjs/Maths/math.vector";
  65129. import { BaseTexture } from "babylonjs/Materials/Textures/baseTexture";
  65130. import { ThinEngine } from "babylonjs/Engines/thinEngine";
  65131. import "babylonjs/Engines/Extensions/engine.rawTexture";
  65132. /**
  65133. * This represents a color grading texture. This acts as a lookup table LUT, useful during post process
  65134. * It can help converting any input color in a desired output one. This can then be used to create effects
  65135. * from sepia, black and white to sixties or futuristic rendering...
  65136. *
  65137. * The only supported format is currently 3dl.
  65138. * More information on LUT: https://en.wikipedia.org/wiki/3D_lookup_table
  65139. */
  65140. export class ColorGradingTexture extends BaseTexture {
  65141. /**
  65142. * The texture URL.
  65143. */
  65144. url: string;
  65145. /**
  65146. * Empty line regex stored for GC.
  65147. */
  65148. private static _noneEmptyLineRegex;
  65149. private _textureMatrix;
  65150. private _onLoad;
  65151. /**
  65152. * Instantiates a ColorGradingTexture from the following parameters.
  65153. *
  65154. * @param url The location of the color gradind data (currently only supporting 3dl)
  65155. * @param sceneOrEngine The scene or engine the texture will be used in
  65156. * @param onLoad defines a callback triggered when the texture has been loaded
  65157. */
  65158. constructor(url: string, sceneOrEngine: Scene | ThinEngine, onLoad?: Nullable<() => void>);
  65159. /**
  65160. * Fires the onload event from the constructor if requested.
  65161. */
  65162. private _triggerOnLoad;
  65163. /**
  65164. * Returns the texture matrix used in most of the material.
  65165. * This is not used in color grading but keep for troubleshooting purpose (easily swap diffuse by colorgrading to look in).
  65166. */
  65167. getTextureMatrix(): Matrix;
  65168. /**
  65169. * Occurs when the file being loaded is a .3dl LUT file.
  65170. */
  65171. private load3dlTexture;
  65172. /**
  65173. * Starts the loading process of the texture.
  65174. */
  65175. private loadTexture;
  65176. /**
  65177. * Clones the color gradind texture.
  65178. */
  65179. clone(): ColorGradingTexture;
  65180. /**
  65181. * Called during delayed load for textures.
  65182. */
  65183. delayLoad(): void;
  65184. /**
  65185. * Parses a color grading texture serialized by Babylon.
  65186. * @param parsedTexture The texture information being parsedTexture
  65187. * @param scene The scene to load the texture in
  65188. * @param rootUrl The root url of the data assets to load
  65189. * @return A color gradind texture
  65190. */
  65191. static Parse(parsedTexture: any, scene: Scene): Nullable<ColorGradingTexture>;
  65192. /**
  65193. * Serializes the LUT texture to json format.
  65194. */
  65195. serialize(): any;
  65196. }
  65197. }
  65198. declare module "babylonjs/Materials/Textures/equiRectangularCubeTexture" {
  65199. import { BaseTexture } from "babylonjs/Materials/Textures/baseTexture";
  65200. import { Scene } from "babylonjs/scene";
  65201. import { Nullable } from "babylonjs/types";
  65202. import "babylonjs/Engines/Extensions/engine.rawTexture";
  65203. /**
  65204. * This represents a texture coming from an equirectangular image supported by the web browser canvas.
  65205. */
  65206. export class EquiRectangularCubeTexture extends BaseTexture {
  65207. /** The six faces of the cube. */
  65208. private static _FacesMapping;
  65209. private _noMipmap;
  65210. private _onLoad;
  65211. private _onError;
  65212. /** The size of the cubemap. */
  65213. private _size;
  65214. /** The buffer of the image. */
  65215. private _buffer;
  65216. /** The width of the input image. */
  65217. private _width;
  65218. /** The height of the input image. */
  65219. private _height;
  65220. /** The URL to the image. */
  65221. url: string;
  65222. /**
  65223. * Instantiates an EquiRectangularCubeTexture from the following parameters.
  65224. * @param url The location of the image
  65225. * @param scene The scene the texture will be used in
  65226. * @param size The cubemap desired size (the more it increases the longer the generation will be)
  65227. * @param noMipmap Forces to not generate the mipmap if true
  65228. * @param gammaSpace Specifies if the texture will be used in gamma or linear space
  65229. * (the PBR material requires those textures in linear space, but the standard material would require them in Gamma space)
  65230. * @param onLoad — defines a callback called when texture is loaded
  65231. * @param onError — defines a callback called if there is an error
  65232. */
  65233. constructor(url: string, scene: Scene, size: number, noMipmap?: boolean, gammaSpace?: boolean, onLoad?: Nullable<() => void>, onError?: Nullable<(message?: string, exception?: any) => void>);
  65234. /**
  65235. * Load the image data, by putting the image on a canvas and extracting its buffer.
  65236. */
  65237. private loadImage;
  65238. /**
  65239. * Convert the image buffer into a cubemap and create a CubeTexture.
  65240. */
  65241. private loadTexture;
  65242. /**
  65243. * Convert the ArrayBuffer into a Float32Array and drop the transparency channel.
  65244. * @param buffer The ArrayBuffer that should be converted.
  65245. * @returns The buffer as Float32Array.
  65246. */
  65247. private getFloat32ArrayFromArrayBuffer;
  65248. /**
  65249. * Get the current class name of the texture useful for serialization or dynamic coding.
  65250. * @returns "EquiRectangularCubeTexture"
  65251. */
  65252. getClassName(): string;
  65253. /**
  65254. * Create a clone of the current EquiRectangularCubeTexture and return it.
  65255. * @returns A clone of the current EquiRectangularCubeTexture.
  65256. */
  65257. clone(): EquiRectangularCubeTexture;
  65258. }
  65259. }
  65260. declare module "babylonjs/Materials/Textures/htmlElementTexture" {
  65261. import { Nullable } from "babylonjs/types";
  65262. import { BaseTexture } from "babylonjs/Materials/Textures/baseTexture";
  65263. import { Matrix } from "babylonjs/Maths/math.vector";
  65264. import "babylonjs/Engines/Extensions/engine.dynamicTexture";
  65265. import "babylonjs/Engines/Extensions/engine.videoTexture";
  65266. import { ThinEngine } from "babylonjs/Engines/thinEngine";
  65267. import { Scene } from "babylonjs/scene";
  65268. /**
  65269. * Defines the options related to the creation of an HtmlElementTexture
  65270. */
  65271. export interface IHtmlElementTextureOptions {
  65272. /**
  65273. * Defines wether mip maps should be created or not.
  65274. */
  65275. generateMipMaps?: boolean;
  65276. /**
  65277. * Defines the sampling mode of the texture.
  65278. */
  65279. samplingMode?: number;
  65280. /**
  65281. * Defines the engine instance to use the texture with. It is not mandatory if you define a scene.
  65282. */
  65283. engine: Nullable<ThinEngine>;
  65284. /**
  65285. * Defines the scene the texture belongs to. It is not mandatory if you define an engine.
  65286. */
  65287. scene: Nullable<Scene>;
  65288. }
  65289. /**
  65290. * This represents the smallest workload to use an already existing element (Canvas or Video) as a texture.
  65291. * To be as efficient as possible depending on your constraints nothing aside the first upload
  65292. * is automatically managed.
  65293. * It is a cheap VideoTexture or DynamicTexture if you prefer to keep full control of the elements
  65294. * in your application.
  65295. *
  65296. * As the update is not automatic, you need to call them manually.
  65297. */
  65298. export class HtmlElementTexture extends BaseTexture {
  65299. /**
  65300. * The texture URL.
  65301. */
  65302. element: HTMLVideoElement | HTMLCanvasElement;
  65303. private static readonly DefaultOptions;
  65304. private _textureMatrix;
  65305. private _isVideo;
  65306. private _generateMipMaps;
  65307. private _samplingMode;
  65308. /**
  65309. * Instantiates a HtmlElementTexture from the following parameters.
  65310. *
  65311. * @param name Defines the name of the texture
  65312. * @param element Defines the video or canvas the texture is filled with
  65313. * @param options Defines the other none mandatory texture creation options
  65314. */
  65315. constructor(name: string, element: HTMLVideoElement | HTMLCanvasElement, options: IHtmlElementTextureOptions);
  65316. private _createInternalTexture;
  65317. /**
  65318. * Returns the texture matrix used in most of the material.
  65319. */
  65320. getTextureMatrix(): Matrix;
  65321. /**
  65322. * Updates the content of the texture.
  65323. * @param invertY Defines wether the texture should be inverted on Y (false by default on video and true on canvas)
  65324. */
  65325. update(invertY?: Nullable<boolean>): void;
  65326. }
  65327. }
  65328. declare module "babylonjs/Misc/tga" {
  65329. import { InternalTexture } from "babylonjs/Materials/Textures/internalTexture";
  65330. /**
  65331. * Based on jsTGALoader - Javascript loader for TGA file
  65332. * By Vincent Thibault
  65333. * @see http://blog.robrowser.com/javascript-tga-loader.html
  65334. */
  65335. export class TGATools {
  65336. private static _TYPE_INDEXED;
  65337. private static _TYPE_RGB;
  65338. private static _TYPE_GREY;
  65339. private static _TYPE_RLE_INDEXED;
  65340. private static _TYPE_RLE_RGB;
  65341. private static _TYPE_RLE_GREY;
  65342. private static _ORIGIN_MASK;
  65343. private static _ORIGIN_SHIFT;
  65344. private static _ORIGIN_BL;
  65345. private static _ORIGIN_BR;
  65346. private static _ORIGIN_UL;
  65347. private static _ORIGIN_UR;
  65348. /**
  65349. * Gets the header of a TGA file
  65350. * @param data defines the TGA data
  65351. * @returns the header
  65352. */
  65353. static GetTGAHeader(data: Uint8Array): any;
  65354. /**
  65355. * Uploads TGA content to a Babylon Texture
  65356. * @hidden
  65357. */
  65358. static UploadContent(texture: InternalTexture, data: Uint8Array): void;
  65359. /** @hidden */
  65360. 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;
  65361. /** @hidden */
  65362. 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;
  65363. /** @hidden */
  65364. 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;
  65365. /** @hidden */
  65366. 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;
  65367. /** @hidden */
  65368. 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;
  65369. /** @hidden */
  65370. 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;
  65371. }
  65372. }
  65373. declare module "babylonjs/Materials/Textures/Loaders/tgaTextureLoader" {
  65374. import { Nullable } from "babylonjs/types";
  65375. import { InternalTexture } from "babylonjs/Materials/Textures/internalTexture";
  65376. import { IInternalTextureLoader } from "babylonjs/Materials/Textures/internalTextureLoader";
  65377. /**
  65378. * Implementation of the TGA Texture Loader.
  65379. * @hidden
  65380. */
  65381. export class _TGATextureLoader implements IInternalTextureLoader {
  65382. /**
  65383. * Defines wether the loader supports cascade loading the different faces.
  65384. */
  65385. readonly supportCascades: boolean;
  65386. /**
  65387. * This returns if the loader support the current file information.
  65388. * @param extension defines the file extension of the file being loaded
  65389. * @returns true if the loader can load the specified file
  65390. */
  65391. canLoad(extension: string): boolean;
  65392. /**
  65393. * Uploads the cube texture data to the WebGL texture. It has already been bound.
  65394. * @param data contains the texture data
  65395. * @param texture defines the BabylonJS internal texture
  65396. * @param createPolynomials will be true if polynomials have been requested
  65397. * @param onLoad defines the callback to trigger once the texture is ready
  65398. * @param onError defines the callback to trigger in case of error
  65399. */
  65400. loadCubeData(data: ArrayBufferView | ArrayBufferView[], texture: InternalTexture, createPolynomials: boolean, onLoad: Nullable<(data?: any) => void>, onError: Nullable<(message?: string, exception?: any) => void>): void;
  65401. /**
  65402. * Uploads the 2D texture data to the WebGL texture. It has already been bound once in the callback.
  65403. * @param data contains the texture data
  65404. * @param texture defines the BabylonJS internal texture
  65405. * @param callback defines the method to call once ready to upload
  65406. */
  65407. loadData(data: ArrayBufferView, texture: InternalTexture, callback: (width: number, height: number, loadMipmap: boolean, isCompressed: boolean, done: () => void) => void): void;
  65408. }
  65409. }
  65410. declare module "babylonjs/Misc/basis" {
  65411. import { InternalTexture } from "babylonjs/Materials/Textures/internalTexture";
  65412. /**
  65413. * Info about the .basis files
  65414. */
  65415. class BasisFileInfo {
  65416. /**
  65417. * If the file has alpha
  65418. */
  65419. hasAlpha: boolean;
  65420. /**
  65421. * Info about each image of the basis file
  65422. */
  65423. images: Array<{
  65424. levels: Array<{
  65425. width: number;
  65426. height: number;
  65427. transcodedPixels: ArrayBufferView;
  65428. }>;
  65429. }>;
  65430. }
  65431. /**
  65432. * Result of transcoding a basis file
  65433. */
  65434. class TranscodeResult {
  65435. /**
  65436. * Info about the .basis file
  65437. */
  65438. fileInfo: BasisFileInfo;
  65439. /**
  65440. * Format to use when loading the file
  65441. */
  65442. format: number;
  65443. }
  65444. /**
  65445. * Configuration options for the Basis transcoder
  65446. */
  65447. export class BasisTranscodeConfiguration {
  65448. /**
  65449. * Supported compression formats used to determine the supported output format of the transcoder
  65450. */
  65451. supportedCompressionFormats?: {
  65452. /**
  65453. * etc1 compression format
  65454. */
  65455. etc1?: boolean;
  65456. /**
  65457. * s3tc compression format
  65458. */
  65459. s3tc?: boolean;
  65460. /**
  65461. * pvrtc compression format
  65462. */
  65463. pvrtc?: boolean;
  65464. /**
  65465. * etc2 compression format
  65466. */
  65467. etc2?: boolean;
  65468. };
  65469. /**
  65470. * If mipmap levels should be loaded for transcoded images (Default: true)
  65471. */
  65472. loadMipmapLevels?: boolean;
  65473. /**
  65474. * Index of a single image to load (Default: all images)
  65475. */
  65476. loadSingleImage?: number;
  65477. }
  65478. /**
  65479. * Used to load .Basis files
  65480. * See https://github.com/BinomialLLC/basis_universal/tree/master/webgl
  65481. */
  65482. export class BasisTools {
  65483. private static _IgnoreSupportedFormats;
  65484. /**
  65485. * URL to use when loading the basis transcoder
  65486. */
  65487. static JSModuleURL: string;
  65488. /**
  65489. * URL to use when loading the wasm module for the transcoder
  65490. */
  65491. static WasmModuleURL: string;
  65492. /**
  65493. * Get the internal format to be passed to texImage2D corresponding to the .basis format value
  65494. * @param basisFormat format chosen from GetSupportedTranscodeFormat
  65495. * @returns internal format corresponding to the Basis format
  65496. */
  65497. static GetInternalFormatFromBasisFormat(basisFormat: number): number;
  65498. private static _WorkerPromise;
  65499. private static _Worker;
  65500. private static _actionId;
  65501. private static _CreateWorkerAsync;
  65502. /**
  65503. * Transcodes a loaded image file to compressed pixel data
  65504. * @param data image data to transcode
  65505. * @param config configuration options for the transcoding
  65506. * @returns a promise resulting in the transcoded image
  65507. */
  65508. static TranscodeAsync(data: ArrayBuffer | ArrayBufferView, config: BasisTranscodeConfiguration): Promise<TranscodeResult>;
  65509. /**
  65510. * Loads a texture from the transcode result
  65511. * @param texture texture load to
  65512. * @param transcodeResult the result of transcoding the basis file to load from
  65513. */
  65514. static LoadTextureFromTranscodeResult(texture: InternalTexture, transcodeResult: TranscodeResult): void;
  65515. }
  65516. }
  65517. declare module "babylonjs/Materials/Textures/Loaders/basisTextureLoader" {
  65518. import { Nullable } from "babylonjs/types";
  65519. import { InternalTexture } from "babylonjs/Materials/Textures/internalTexture";
  65520. import { IInternalTextureLoader } from "babylonjs/Materials/Textures/internalTextureLoader";
  65521. /**
  65522. * Loader for .basis file format
  65523. */
  65524. export class _BasisTextureLoader implements IInternalTextureLoader {
  65525. /**
  65526. * Defines whether the loader supports cascade loading the different faces.
  65527. */
  65528. readonly supportCascades: boolean;
  65529. /**
  65530. * This returns if the loader support the current file information.
  65531. * @param extension defines the file extension of the file being loaded
  65532. * @returns true if the loader can load the specified file
  65533. */
  65534. canLoad(extension: string): boolean;
  65535. /**
  65536. * Uploads the cube texture data to the WebGL texture. It has already been bound.
  65537. * @param data contains the texture data
  65538. * @param texture defines the BabylonJS internal texture
  65539. * @param createPolynomials will be true if polynomials have been requested
  65540. * @param onLoad defines the callback to trigger once the texture is ready
  65541. * @param onError defines the callback to trigger in case of error
  65542. */
  65543. loadCubeData(data: ArrayBufferView | ArrayBufferView[], texture: InternalTexture, createPolynomials: boolean, onLoad: Nullable<(data?: any) => void>, onError: Nullable<(message?: string, exception?: any) => void>): void;
  65544. /**
  65545. * Uploads the 2D texture data to the WebGL texture. It has already been bound once in the callback.
  65546. * @param data contains the texture data
  65547. * @param texture defines the BabylonJS internal texture
  65548. * @param callback defines the method to call once ready to upload
  65549. */
  65550. loadData(data: ArrayBufferView, texture: InternalTexture, callback: (width: number, height: number, loadMipmap: boolean, isCompressed: boolean, done: () => void) => void): void;
  65551. }
  65552. }
  65553. declare module "babylonjs/Materials/Textures/Loaders/index" {
  65554. export * from "babylonjs/Materials/Textures/Loaders/ddsTextureLoader";
  65555. export * from "babylonjs/Materials/Textures/Loaders/envTextureLoader";
  65556. export * from "babylonjs/Materials/Textures/Loaders/ktxTextureLoader";
  65557. export * from "babylonjs/Materials/Textures/Loaders/tgaTextureLoader";
  65558. export * from "babylonjs/Materials/Textures/Loaders/basisTextureLoader";
  65559. }
  65560. declare module "babylonjs/Materials/Textures/Packer/frame" {
  65561. import { Vector2 } from "babylonjs/Maths/math.vector";
  65562. /**
  65563. * Defines the basic options interface of a TexturePacker Frame
  65564. */
  65565. export interface ITexturePackerFrame {
  65566. /**
  65567. * The frame ID
  65568. */
  65569. id: number;
  65570. /**
  65571. * The frames Scale
  65572. */
  65573. scale: Vector2;
  65574. /**
  65575. * The Frames offset
  65576. */
  65577. offset: Vector2;
  65578. }
  65579. /**
  65580. * This is a support class for frame Data on texture packer sets.
  65581. */
  65582. export class TexturePackerFrame implements ITexturePackerFrame {
  65583. /**
  65584. * The frame ID
  65585. */
  65586. id: number;
  65587. /**
  65588. * The frames Scale
  65589. */
  65590. scale: Vector2;
  65591. /**
  65592. * The Frames offset
  65593. */
  65594. offset: Vector2;
  65595. /**
  65596. * Initializes a texture package frame.
  65597. * @param id The numerical frame identifier
  65598. * @param scale Scalar Vector2 for UV frame
  65599. * @param offset Vector2 for the frame position in UV units.
  65600. * @returns TexturePackerFrame
  65601. */
  65602. constructor(id: number, scale: Vector2, offset: Vector2);
  65603. }
  65604. }
  65605. declare module "babylonjs/Materials/Textures/Packer/packer" {
  65606. import { AbstractMesh } from "babylonjs/Meshes/abstractMesh";
  65607. import { Scene } from "babylonjs/scene";
  65608. import { Nullable } from "babylonjs/types";
  65609. import { Color3, Color4 } from "babylonjs/Maths/math.color";
  65610. import { TexturePackerFrame } from "babylonjs/Materials/Textures/Packer/frame";
  65611. /**
  65612. * Defines the basic options interface of a TexturePacker
  65613. */
  65614. export interface ITexturePackerOptions {
  65615. /**
  65616. * Custom targets for the channels of a texture packer. Default is all the channels of the Standard Material
  65617. */
  65618. map?: string[];
  65619. /**
  65620. * the UV input targets, as a single value for all meshes. Defaults to VertexBuffer.UVKind
  65621. */
  65622. uvsIn?: string;
  65623. /**
  65624. * the UV output targets, as a single value for all meshes. Defaults to VertexBuffer.UVKind
  65625. */
  65626. uvsOut?: string;
  65627. /**
  65628. * number representing the layout style. Defaults to LAYOUT_STRIP
  65629. */
  65630. layout?: number;
  65631. /**
  65632. * number of columns if using custom column count layout(2). This defaults to 4.
  65633. */
  65634. colnum?: number;
  65635. /**
  65636. * flag to update the input meshes to the new packed texture after compilation. Defaults to true.
  65637. */
  65638. updateInputMeshes?: boolean;
  65639. /**
  65640. * boolean flag to dispose all the source textures. Defaults to true.
  65641. */
  65642. disposeSources?: boolean;
  65643. /**
  65644. * Fills the blank cells in a set to the customFillColor. Defaults to true.
  65645. */
  65646. fillBlanks?: boolean;
  65647. /**
  65648. * string value representing the context fill style color. Defaults to 'black'.
  65649. */
  65650. customFillColor?: string;
  65651. /**
  65652. * Width and Height Value of each Frame in the TexturePacker Sets
  65653. */
  65654. frameSize?: number;
  65655. /**
  65656. * Ratio of the value to add padding wise to each cell. Defaults to 0.0115
  65657. */
  65658. paddingRatio?: number;
  65659. /**
  65660. * Number that declares the fill method for the padding gutter.
  65661. */
  65662. paddingMode?: number;
  65663. /**
  65664. * If in SUBUV_COLOR padding mode what color to use.
  65665. */
  65666. paddingColor?: Color3 | Color4;
  65667. }
  65668. /**
  65669. * Defines the basic interface of a TexturePacker JSON File
  65670. */
  65671. export interface ITexturePackerJSON {
  65672. /**
  65673. * The frame ID
  65674. */
  65675. name: string;
  65676. /**
  65677. * The base64 channel data
  65678. */
  65679. sets: any;
  65680. /**
  65681. * The options of the Packer
  65682. */
  65683. options: ITexturePackerOptions;
  65684. /**
  65685. * The frame data of the Packer
  65686. */
  65687. frames: Array<number>;
  65688. }
  65689. /**
  65690. * This is a support class that generates a series of packed texture sets.
  65691. * @see https://doc.babylonjs.com/babylon101/materials
  65692. */
  65693. export class TexturePacker {
  65694. /** Packer Layout Constant 0 */
  65695. static readonly LAYOUT_STRIP: number;
  65696. /** Packer Layout Constant 1 */
  65697. static readonly LAYOUT_POWER2: number;
  65698. /** Packer Layout Constant 2 */
  65699. static readonly LAYOUT_COLNUM: number;
  65700. /** Packer Layout Constant 0 */
  65701. static readonly SUBUV_WRAP: number;
  65702. /** Packer Layout Constant 1 */
  65703. static readonly SUBUV_EXTEND: number;
  65704. /** Packer Layout Constant 2 */
  65705. static readonly SUBUV_COLOR: number;
  65706. /** The Name of the Texture Package */
  65707. name: string;
  65708. /** The scene scope of the TexturePacker */
  65709. scene: Scene;
  65710. /** The Meshes to target */
  65711. meshes: AbstractMesh[];
  65712. /** Arguments passed with the Constructor */
  65713. options: ITexturePackerOptions;
  65714. /** The promise that is started upon initialization */
  65715. promise: Nullable<Promise<TexturePacker | string>>;
  65716. /** The Container object for the channel sets that are generated */
  65717. sets: object;
  65718. /** The Container array for the frames that are generated */
  65719. frames: TexturePackerFrame[];
  65720. /** The expected number of textures the system is parsing. */
  65721. private _expecting;
  65722. /** The padding value from Math.ceil(frameSize * paddingRatio) */
  65723. private _paddingValue;
  65724. /**
  65725. * Initializes a texture package series from an array of meshes or a single mesh.
  65726. * @param name The name of the package
  65727. * @param meshes The target meshes to compose the package from
  65728. * @param options The arguments that texture packer should follow while building.
  65729. * @param scene The scene which the textures are scoped to.
  65730. * @returns TexturePacker
  65731. */
  65732. constructor(name: string, meshes: AbstractMesh[], options: ITexturePackerOptions, scene: Scene);
  65733. /**
  65734. * Starts the package process
  65735. * @param resolve The promises resolution function
  65736. * @returns TexturePacker
  65737. */
  65738. private _createFrames;
  65739. /**
  65740. * Calculates the Size of the Channel Sets
  65741. * @returns Vector2
  65742. */
  65743. private _calculateSize;
  65744. /**
  65745. * Calculates the UV data for the frames.
  65746. * @param baseSize the base frameSize
  65747. * @param padding the base frame padding
  65748. * @param dtSize size of the Dynamic Texture for that channel
  65749. * @param dtUnits is 1/dtSize
  65750. * @param update flag to update the input meshes
  65751. */
  65752. private _calculateMeshUVFrames;
  65753. /**
  65754. * Calculates the frames Offset.
  65755. * @param index of the frame
  65756. * @returns Vector2
  65757. */
  65758. private _getFrameOffset;
  65759. /**
  65760. * Updates a Mesh to the frame data
  65761. * @param mesh that is the target
  65762. * @param frameID or the frame index
  65763. */
  65764. private _updateMeshUV;
  65765. /**
  65766. * Updates a Meshes materials to use the texture packer channels
  65767. * @param m is the mesh to target
  65768. * @param force all channels on the packer to be set.
  65769. */
  65770. private _updateTextureReferences;
  65771. /**
  65772. * Public method to set a Mesh to a frame
  65773. * @param m that is the target
  65774. * @param frameID or the frame index
  65775. * @param updateMaterial trigger for if the Meshes attached Material be updated?
  65776. */
  65777. setMeshToFrame(m: AbstractMesh, frameID: number, updateMaterial?: boolean): void;
  65778. /**
  65779. * Starts the async promise to compile the texture packer.
  65780. * @returns Promise<void>
  65781. */
  65782. processAsync(): Promise<void>;
  65783. /**
  65784. * Disposes all textures associated with this packer
  65785. */
  65786. dispose(): void;
  65787. /**
  65788. * Starts the download process for all the channels converting them to base64 data and embedding it all in a JSON file.
  65789. * @param imageType is the image type to use.
  65790. * @param quality of the image if downloading as jpeg, Ranges from >0 to 1.
  65791. */
  65792. download(imageType?: string, quality?: number): void;
  65793. /**
  65794. * Public method to load a texturePacker JSON file.
  65795. * @param data of the JSON file in string format.
  65796. */
  65797. updateFromJSON(data: string): void;
  65798. }
  65799. }
  65800. declare module "babylonjs/Materials/Textures/Packer/index" {
  65801. export * from "babylonjs/Materials/Textures/Packer/packer";
  65802. export * from "babylonjs/Materials/Textures/Packer/frame";
  65803. }
  65804. declare module "babylonjs/Materials/Textures/Procedurals/customProceduralTexture" {
  65805. import { Scene } from "babylonjs/scene";
  65806. import { Texture } from "babylonjs/Materials/Textures/texture";
  65807. import { ProceduralTexture } from "babylonjs/Materials/Textures/Procedurals/proceduralTexture";
  65808. /**
  65809. * 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.
  65810. * Custom Procedural textures are the easiest way to create your own procedural in your application.
  65811. * @see https://doc.babylonjs.com/how_to/how_to_use_procedural_textures#creating-custom-procedural-textures
  65812. */
  65813. export class CustomProceduralTexture extends ProceduralTexture {
  65814. private _animate;
  65815. private _time;
  65816. private _config;
  65817. private _texturePath;
  65818. /**
  65819. * Instantiates a new Custom Procedural Texture.
  65820. * 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.
  65821. * Custom Procedural textures are the easiest way to create your own procedural in your application.
  65822. * @see https://doc.babylonjs.com/how_to/how_to_use_procedural_textures#creating-custom-procedural-textures
  65823. * @param name Define the name of the texture
  65824. * @param texturePath Define the folder path containing all the cutom texture related files (config, shaders...)
  65825. * @param size Define the size of the texture to create
  65826. * @param scene Define the scene the texture belongs to
  65827. * @param fallbackTexture Define a fallback texture in case there were issues to create the custom texture
  65828. * @param generateMipMaps Define if the texture should creates mip maps or not
  65829. */
  65830. constructor(name: string, texturePath: string, size: number, scene: Scene, fallbackTexture?: Texture, generateMipMaps?: boolean);
  65831. private _loadJson;
  65832. /**
  65833. * Is the texture ready to be used ? (rendered at least once)
  65834. * @returns true if ready, otherwise, false.
  65835. */
  65836. isReady(): boolean;
  65837. /**
  65838. * Render the texture to its associated render target.
  65839. * @param useCameraPostProcess Define if camera post process should be applied to the texture
  65840. */
  65841. render(useCameraPostProcess?: boolean): void;
  65842. /**
  65843. * Update the list of dependant textures samplers in the shader.
  65844. */
  65845. updateTextures(): void;
  65846. /**
  65847. * Update the uniform values of the procedural texture in the shader.
  65848. */
  65849. updateShaderUniforms(): void;
  65850. /**
  65851. * Define if the texture animates or not.
  65852. */
  65853. get animate(): boolean;
  65854. set animate(value: boolean);
  65855. }
  65856. }
  65857. declare module "babylonjs/Shaders/noise.fragment" {
  65858. /** @hidden */
  65859. export var noisePixelShader: {
  65860. name: string;
  65861. shader: string;
  65862. };
  65863. }
  65864. declare module "babylonjs/Materials/Textures/Procedurals/noiseProceduralTexture" {
  65865. import { Nullable } from "babylonjs/types";
  65866. import { Scene } from "babylonjs/scene";
  65867. import { Texture } from "babylonjs/Materials/Textures/texture";
  65868. import { ProceduralTexture } from "babylonjs/Materials/Textures/Procedurals/proceduralTexture";
  65869. import "babylonjs/Shaders/noise.fragment";
  65870. /**
  65871. * Class used to generate noise procedural textures
  65872. */
  65873. export class NoiseProceduralTexture extends ProceduralTexture {
  65874. /** Gets or sets the start time (default is 0) */
  65875. time: number;
  65876. /** Gets or sets a value between 0 and 1 indicating the overall brightness of the texture (default is 0.2) */
  65877. brightness: number;
  65878. /** Defines the number of octaves to process */
  65879. octaves: number;
  65880. /** Defines the level of persistence (0.8 by default) */
  65881. persistence: number;
  65882. /** Gets or sets animation speed factor (default is 1) */
  65883. animationSpeedFactor: number;
  65884. /**
  65885. * Creates a new NoiseProceduralTexture
  65886. * @param name defines the name fo the texture
  65887. * @param size defines the size of the texture (default is 256)
  65888. * @param scene defines the hosting scene
  65889. * @param fallbackTexture defines the texture to use if the NoiseProceduralTexture can't be created
  65890. * @param generateMipMaps defines if mipmaps must be generated (true by default)
  65891. */
  65892. constructor(name: string, size?: number, scene?: Nullable<Scene>, fallbackTexture?: Texture, generateMipMaps?: boolean);
  65893. private _updateShaderUniforms;
  65894. protected _getDefines(): string;
  65895. /** Generate the current state of the procedural texture */
  65896. render(useCameraPostProcess?: boolean): void;
  65897. /**
  65898. * Serializes this noise procedural texture
  65899. * @returns a serialized noise procedural texture object
  65900. */
  65901. serialize(): any;
  65902. /**
  65903. * Clone the texture.
  65904. * @returns the cloned texture
  65905. */
  65906. clone(): NoiseProceduralTexture;
  65907. /**
  65908. * Creates a NoiseProceduralTexture from parsed noise procedural texture data
  65909. * @param parsedTexture defines parsed texture data
  65910. * @param scene defines the current scene
  65911. * @param rootUrl defines the root URL containing noise procedural texture information
  65912. * @returns a parsed NoiseProceduralTexture
  65913. */
  65914. static Parse(parsedTexture: any, scene: Scene): NoiseProceduralTexture;
  65915. }
  65916. }
  65917. declare module "babylonjs/Materials/Textures/Procedurals/index" {
  65918. export * from "babylonjs/Materials/Textures/Procedurals/customProceduralTexture";
  65919. export * from "babylonjs/Materials/Textures/Procedurals/noiseProceduralTexture";
  65920. export * from "babylonjs/Materials/Textures/Procedurals/proceduralTexture";
  65921. export * from "babylonjs/Materials/Textures/Procedurals/proceduralTextureSceneComponent";
  65922. }
  65923. declare module "babylonjs/Materials/Textures/rawCubeTexture" {
  65924. import { Nullable } from "babylonjs/types";
  65925. import { Scene } from "babylonjs/scene";
  65926. import { SphericalPolynomial } from "babylonjs/Maths/sphericalPolynomial";
  65927. import { InternalTexture } from "babylonjs/Materials/Textures/internalTexture";
  65928. import { CubeTexture } from "babylonjs/Materials/Textures/cubeTexture";
  65929. import "babylonjs/Engines/Extensions/engine.rawTexture";
  65930. /**
  65931. * Raw cube texture where the raw buffers are passed in
  65932. */
  65933. export class RawCubeTexture extends CubeTexture {
  65934. /**
  65935. * Creates a cube texture where the raw buffers are passed in.
  65936. * @param scene defines the scene the texture is attached to
  65937. * @param data defines the array of data to use to create each face
  65938. * @param size defines the size of the textures
  65939. * @param format defines the format of the data
  65940. * @param type defines the type of the data (like Engine.TEXTURETYPE_UNSIGNED_INT)
  65941. * @param generateMipMaps defines if the engine should generate the mip levels
  65942. * @param invertY defines if data must be stored with Y axis inverted
  65943. * @param samplingMode defines the required sampling mode (like Texture.NEAREST_SAMPLINGMODE)
  65944. * @param compression defines the compression used (null by default)
  65945. */
  65946. constructor(scene: Scene, data: Nullable<ArrayBufferView[]>, size: number, format?: number, type?: number, generateMipMaps?: boolean, invertY?: boolean, samplingMode?: number, compression?: Nullable<string>);
  65947. /**
  65948. * Updates the raw cube texture.
  65949. * @param data defines the data to store
  65950. * @param format defines the data format
  65951. * @param type defines the type fo the data (Engine.TEXTURETYPE_UNSIGNED_INT by default)
  65952. * @param invertY defines if data must be stored with Y axis inverted
  65953. * @param compression defines the compression used (null by default)
  65954. * @param level defines which level of the texture to update
  65955. */
  65956. update(data: ArrayBufferView[], format: number, type: number, invertY: boolean, compression?: Nullable<string>): void;
  65957. /**
  65958. * Updates a raw cube texture with RGBD encoded data.
  65959. * @param data defines the array of data [mipmap][face] to use to create each face
  65960. * @param sphericalPolynomial defines the spherical polynomial for irradiance
  65961. * @param lodScale defines the scale applied to environment texture. This manages the range of LOD level used for IBL according to the roughness
  65962. * @param lodOffset defines the offset applied to environment texture. This manages first LOD level used for IBL according to the roughness
  65963. * @returns a promsie that resolves when the operation is complete
  65964. */
  65965. updateRGBDAsync(data: ArrayBufferView[][], sphericalPolynomial?: Nullable<SphericalPolynomial>, lodScale?: number, lodOffset?: number): Promise<void>;
  65966. /**
  65967. * Clones the raw cube texture.
  65968. * @return a new cube texture
  65969. */
  65970. clone(): CubeTexture;
  65971. /** @hidden */
  65972. static _UpdateRGBDAsync(internalTexture: InternalTexture, data: ArrayBufferView[][], sphericalPolynomial: Nullable<SphericalPolynomial>, lodScale: number, lodOffset: number): Promise<void>;
  65973. }
  65974. }
  65975. declare module "babylonjs/Materials/Textures/rawTexture2DArray" {
  65976. import { Scene } from "babylonjs/scene";
  65977. import { Texture } from "babylonjs/Materials/Textures/texture";
  65978. import "babylonjs/Engines/Extensions/engine.rawTexture";
  65979. /**
  65980. * Class used to store 2D array textures containing user data
  65981. */
  65982. export class RawTexture2DArray extends Texture {
  65983. /** Gets or sets the texture format to use */
  65984. format: number;
  65985. /**
  65986. * Create a new RawTexture2DArray
  65987. * @param data defines the data of the texture
  65988. * @param width defines the width of the texture
  65989. * @param height defines the height of the texture
  65990. * @param depth defines the number of layers of the texture
  65991. * @param format defines the texture format to use
  65992. * @param scene defines the hosting scene
  65993. * @param generateMipMaps defines a boolean indicating if mip levels should be generated (true by default)
  65994. * @param invertY defines if texture must be stored with Y axis inverted
  65995. * @param samplingMode defines the sampling mode to use (Texture.TRILINEAR_SAMPLINGMODE by default)
  65996. * @param textureType defines the texture Type (Engine.TEXTURETYPE_UNSIGNED_INT, Engine.TEXTURETYPE_FLOAT...)
  65997. */
  65998. constructor(data: ArrayBufferView, width: number, height: number, depth: number,
  65999. /** Gets or sets the texture format to use */
  66000. format: number, scene: Scene, generateMipMaps?: boolean, invertY?: boolean, samplingMode?: number, textureType?: number);
  66001. /**
  66002. * Update the texture with new data
  66003. * @param data defines the data to store in the texture
  66004. */
  66005. update(data: ArrayBufferView): void;
  66006. }
  66007. }
  66008. declare module "babylonjs/Materials/Textures/rawTexture3D" {
  66009. import { Scene } from "babylonjs/scene";
  66010. import { Texture } from "babylonjs/Materials/Textures/texture";
  66011. import "babylonjs/Engines/Extensions/engine.rawTexture";
  66012. /**
  66013. * Class used to store 3D textures containing user data
  66014. */
  66015. export class RawTexture3D extends Texture {
  66016. /** Gets or sets the texture format to use */
  66017. format: number;
  66018. /**
  66019. * Create a new RawTexture3D
  66020. * @param data defines the data of the texture
  66021. * @param width defines the width of the texture
  66022. * @param height defines the height of the texture
  66023. * @param depth defines the depth of the texture
  66024. * @param format defines the texture format to use
  66025. * @param scene defines the hosting scene
  66026. * @param generateMipMaps defines a boolean indicating if mip levels should be generated (true by default)
  66027. * @param invertY defines if texture must be stored with Y axis inverted
  66028. * @param samplingMode defines the sampling mode to use (Texture.TRILINEAR_SAMPLINGMODE by default)
  66029. * @param textureType defines the texture Type (Engine.TEXTURETYPE_UNSIGNED_INT, Engine.TEXTURETYPE_FLOAT...)
  66030. */
  66031. constructor(data: ArrayBufferView, width: number, height: number, depth: number,
  66032. /** Gets or sets the texture format to use */
  66033. format: number, scene: Scene, generateMipMaps?: boolean, invertY?: boolean, samplingMode?: number, textureType?: number);
  66034. /**
  66035. * Update the texture with new data
  66036. * @param data defines the data to store in the texture
  66037. */
  66038. update(data: ArrayBufferView): void;
  66039. }
  66040. }
  66041. declare module "babylonjs/Materials/Textures/refractionTexture" {
  66042. import { Scene } from "babylonjs/scene";
  66043. import { Plane } from "babylonjs/Maths/math.plane";
  66044. import { RenderTargetTexture } from "babylonjs/Materials/Textures/renderTargetTexture";
  66045. /**
  66046. * Creates a refraction texture used by refraction channel of the standard material.
  66047. * It is like a mirror but to see through a material.
  66048. * @see https://doc.babylonjs.com/how_to/reflect#refraction
  66049. */
  66050. export class RefractionTexture extends RenderTargetTexture {
  66051. /**
  66052. * Define the reflection plane we want to use. The refractionPlane is usually set to the constructed refractor.
  66053. * 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.
  66054. * @see https://doc.babylonjs.com/how_to/reflect#refraction
  66055. */
  66056. refractionPlane: Plane;
  66057. /**
  66058. * Define how deep under the surface we should see.
  66059. */
  66060. depth: number;
  66061. /**
  66062. * Creates a refraction texture used by refraction channel of the standard material.
  66063. * It is like a mirror but to see through a material.
  66064. * @see https://doc.babylonjs.com/how_to/reflect#refraction
  66065. * @param name Define the texture name
  66066. * @param size Define the size of the underlying texture
  66067. * @param scene Define the scene the refraction belongs to
  66068. * @param generateMipMaps Define if we need to generate mips level for the refraction
  66069. */
  66070. constructor(name: string, size: number, scene: Scene, generateMipMaps?: boolean);
  66071. /**
  66072. * Clone the refraction texture.
  66073. * @returns the cloned texture
  66074. */
  66075. clone(): RefractionTexture;
  66076. /**
  66077. * Serialize the texture to a JSON representation you could use in Parse later on
  66078. * @returns the serialized JSON representation
  66079. */
  66080. serialize(): any;
  66081. }
  66082. }
  66083. declare module "babylonjs/Materials/Textures/index" {
  66084. export * from "babylonjs/Materials/Textures/baseTexture";
  66085. export * from "babylonjs/Materials/Textures/baseTexture.polynomial";
  66086. export * from "babylonjs/Materials/Textures/colorGradingTexture";
  66087. export * from "babylonjs/Materials/Textures/cubeTexture";
  66088. export * from "babylonjs/Materials/Textures/dynamicTexture";
  66089. export * from "babylonjs/Materials/Textures/equiRectangularCubeTexture";
  66090. export * from "babylonjs/Materials/Textures/Filtering/hdrFiltering";
  66091. export * from "babylonjs/Materials/Textures/hdrCubeTexture";
  66092. export * from "babylonjs/Materials/Textures/htmlElementTexture";
  66093. export * from "babylonjs/Materials/Textures/internalTexture";
  66094. export * from "babylonjs/Materials/Textures/internalTextureLoader";
  66095. export * from "babylonjs/Materials/Textures/Loaders/index";
  66096. export * from "babylonjs/Materials/Textures/mirrorTexture";
  66097. export * from "babylonjs/Materials/Textures/multiRenderTarget";
  66098. export * from "babylonjs/Materials/Textures/Packer/index";
  66099. export * from "babylonjs/Materials/Textures/Procedurals/index";
  66100. export * from "babylonjs/Materials/Textures/rawCubeTexture";
  66101. export * from "babylonjs/Materials/Textures/rawTexture";
  66102. export * from "babylonjs/Materials/Textures/rawTexture2DArray";
  66103. export * from "babylonjs/Materials/Textures/rawTexture3D";
  66104. export * from "babylonjs/Materials/Textures/refractionTexture";
  66105. export * from "babylonjs/Materials/Textures/renderTargetTexture";
  66106. export * from "babylonjs/Materials/Textures/texture";
  66107. export * from "babylonjs/Materials/Textures/videoTexture";
  66108. }
  66109. declare module "babylonjs/Materials/Node/Enums/index" {
  66110. export * from "babylonjs/Materials/Node/Enums/nodeMaterialBlockTargets";
  66111. export * from "babylonjs/Materials/Node/Enums/nodeMaterialBlockConnectionPointTypes";
  66112. export * from "babylonjs/Materials/Node/Enums/nodeMaterialBlockConnectionPointMode";
  66113. export * from "babylonjs/Materials/Node/Enums/nodeMaterialSystemValues";
  66114. export * from "babylonjs/Materials/Node/Enums/nodeMaterialModes";
  66115. }
  66116. declare module "babylonjs/Materials/Node/Blocks/Vertex/bonesBlock" {
  66117. import { NodeMaterialBlock } from "babylonjs/Materials/Node/nodeMaterialBlock";
  66118. import { NodeMaterialBuildState } from "babylonjs/Materials/Node/nodeMaterialBuildState";
  66119. import { AbstractMesh } from "babylonjs/Meshes/abstractMesh";
  66120. import { Mesh } from "babylonjs/Meshes/mesh";
  66121. import { Effect } from "babylonjs/Materials/effect";
  66122. import { NodeMaterialConnectionPoint } from "babylonjs/Materials/Node/nodeMaterialBlockConnectionPoint";
  66123. import { NodeMaterial, NodeMaterialDefines } from "babylonjs/Materials/Node/nodeMaterial";
  66124. import "babylonjs/Shaders/ShadersInclude/bonesDeclaration";
  66125. import "babylonjs/Shaders/ShadersInclude/bonesVertex";
  66126. import { EffectFallbacks } from "babylonjs/Materials/effectFallbacks";
  66127. /**
  66128. * Block used to add support for vertex skinning (bones)
  66129. */
  66130. export class BonesBlock extends NodeMaterialBlock {
  66131. /**
  66132. * Creates a new BonesBlock
  66133. * @param name defines the block name
  66134. */
  66135. constructor(name: string);
  66136. /**
  66137. * Initialize the block and prepare the context for build
  66138. * @param state defines the state that will be used for the build
  66139. */
  66140. initialize(state: NodeMaterialBuildState): void;
  66141. /**
  66142. * Gets the current class name
  66143. * @returns the class name
  66144. */
  66145. getClassName(): string;
  66146. /**
  66147. * Gets the matrix indices input component
  66148. */
  66149. get matricesIndices(): NodeMaterialConnectionPoint;
  66150. /**
  66151. * Gets the matrix weights input component
  66152. */
  66153. get matricesWeights(): NodeMaterialConnectionPoint;
  66154. /**
  66155. * Gets the extra matrix indices input component
  66156. */
  66157. get matricesIndicesExtra(): NodeMaterialConnectionPoint;
  66158. /**
  66159. * Gets the extra matrix weights input component
  66160. */
  66161. get matricesWeightsExtra(): NodeMaterialConnectionPoint;
  66162. /**
  66163. * Gets the world input component
  66164. */
  66165. get world(): NodeMaterialConnectionPoint;
  66166. /**
  66167. * Gets the output component
  66168. */
  66169. get output(): NodeMaterialConnectionPoint;
  66170. autoConfigure(material: NodeMaterial): void;
  66171. provideFallbacks(mesh: AbstractMesh, fallbacks: EffectFallbacks): void;
  66172. bind(effect: Effect, nodeMaterial: NodeMaterial, mesh?: Mesh): void;
  66173. prepareDefines(mesh: AbstractMesh, nodeMaterial: NodeMaterial, defines: NodeMaterialDefines): void;
  66174. protected _buildBlock(state: NodeMaterialBuildState): this;
  66175. }
  66176. }
  66177. declare module "babylonjs/Materials/Node/Blocks/Vertex/instancesBlock" {
  66178. import { NodeMaterialBlock } from "babylonjs/Materials/Node/nodeMaterialBlock";
  66179. import { NodeMaterialConnectionPoint } from "babylonjs/Materials/Node/nodeMaterialBlockConnectionPoint";
  66180. import { NodeMaterialBuildState } from "babylonjs/Materials/Node/nodeMaterialBuildState";
  66181. import { AbstractMesh } from "babylonjs/Meshes/abstractMesh";
  66182. import { NodeMaterial, NodeMaterialDefines } from "babylonjs/Materials/Node/nodeMaterial";
  66183. import { SubMesh } from "babylonjs/Meshes/subMesh";
  66184. /**
  66185. * Block used to add support for instances
  66186. * @see https://doc.babylonjs.com/how_to/how_to_use_instances
  66187. */
  66188. export class InstancesBlock extends NodeMaterialBlock {
  66189. /**
  66190. * Creates a new InstancesBlock
  66191. * @param name defines the block name
  66192. */
  66193. constructor(name: string);
  66194. /**
  66195. * Gets the current class name
  66196. * @returns the class name
  66197. */
  66198. getClassName(): string;
  66199. /**
  66200. * Gets the first world row input component
  66201. */
  66202. get world0(): NodeMaterialConnectionPoint;
  66203. /**
  66204. * Gets the second world row input component
  66205. */
  66206. get world1(): NodeMaterialConnectionPoint;
  66207. /**
  66208. * Gets the third world row input component
  66209. */
  66210. get world2(): NodeMaterialConnectionPoint;
  66211. /**
  66212. * Gets the forth world row input component
  66213. */
  66214. get world3(): NodeMaterialConnectionPoint;
  66215. /**
  66216. * Gets the world input component
  66217. */
  66218. get world(): NodeMaterialConnectionPoint;
  66219. /**
  66220. * Gets the output component
  66221. */
  66222. get output(): NodeMaterialConnectionPoint;
  66223. /**
  66224. * Gets the isntanceID component
  66225. */
  66226. get instanceID(): NodeMaterialConnectionPoint;
  66227. autoConfigure(material: NodeMaterial): void;
  66228. prepareDefines(mesh: AbstractMesh, nodeMaterial: NodeMaterial, defines: NodeMaterialDefines, useInstances?: boolean, subMesh?: SubMesh): void;
  66229. protected _buildBlock(state: NodeMaterialBuildState): this;
  66230. }
  66231. }
  66232. declare module "babylonjs/Materials/Node/Blocks/Vertex/morphTargetsBlock" {
  66233. import { NodeMaterialBlock } from "babylonjs/Materials/Node/nodeMaterialBlock";
  66234. import { NodeMaterialBuildState } from "babylonjs/Materials/Node/nodeMaterialBuildState";
  66235. import { NodeMaterialConnectionPoint } from "babylonjs/Materials/Node/nodeMaterialBlockConnectionPoint";
  66236. import { AbstractMesh } from "babylonjs/Meshes/abstractMesh";
  66237. import { NodeMaterial, NodeMaterialDefines } from "babylonjs/Materials/Node/nodeMaterial";
  66238. import { Effect } from "babylonjs/Materials/effect";
  66239. import { Mesh } from "babylonjs/Meshes/mesh";
  66240. import "babylonjs/Shaders/ShadersInclude/morphTargetsVertexDeclaration";
  66241. import "babylonjs/Shaders/ShadersInclude/morphTargetsVertexGlobalDeclaration";
  66242. /**
  66243. * Block used to add morph targets support to vertex shader
  66244. */
  66245. export class MorphTargetsBlock extends NodeMaterialBlock {
  66246. private _repeatableContentAnchor;
  66247. /**
  66248. * Create a new MorphTargetsBlock
  66249. * @param name defines the block name
  66250. */
  66251. constructor(name: string);
  66252. /**
  66253. * Gets the current class name
  66254. * @returns the class name
  66255. */
  66256. getClassName(): string;
  66257. /**
  66258. * Gets the position input component
  66259. */
  66260. get position(): NodeMaterialConnectionPoint;
  66261. /**
  66262. * Gets the normal input component
  66263. */
  66264. get normal(): NodeMaterialConnectionPoint;
  66265. /**
  66266. * Gets the tangent input component
  66267. */
  66268. get tangent(): NodeMaterialConnectionPoint;
  66269. /**
  66270. * Gets the tangent input component
  66271. */
  66272. get uv(): NodeMaterialConnectionPoint;
  66273. /**
  66274. * Gets the position output component
  66275. */
  66276. get positionOutput(): NodeMaterialConnectionPoint;
  66277. /**
  66278. * Gets the normal output component
  66279. */
  66280. get normalOutput(): NodeMaterialConnectionPoint;
  66281. /**
  66282. * Gets the tangent output component
  66283. */
  66284. get tangentOutput(): NodeMaterialConnectionPoint;
  66285. /**
  66286. * Gets the tangent output component
  66287. */
  66288. get uvOutput(): NodeMaterialConnectionPoint;
  66289. initialize(state: NodeMaterialBuildState): void;
  66290. autoConfigure(material: NodeMaterial): void;
  66291. prepareDefines(mesh: AbstractMesh, nodeMaterial: NodeMaterial, defines: NodeMaterialDefines): void;
  66292. bind(effect: Effect, nodeMaterial: NodeMaterial, mesh?: Mesh): void;
  66293. replaceRepeatableContent(vertexShaderState: NodeMaterialBuildState, fragmentShaderState: NodeMaterialBuildState, mesh: AbstractMesh, defines: NodeMaterialDefines): void;
  66294. protected _buildBlock(state: NodeMaterialBuildState): this;
  66295. }
  66296. }
  66297. declare module "babylonjs/Materials/Node/Blocks/Vertex/lightInformationBlock" {
  66298. import { NodeMaterialBlock } from "babylonjs/Materials/Node/nodeMaterialBlock";
  66299. import { NodeMaterialBuildState } from "babylonjs/Materials/Node/nodeMaterialBuildState";
  66300. import { NodeMaterialConnectionPoint } from "babylonjs/Materials/Node/nodeMaterialBlockConnectionPoint";
  66301. import { Nullable } from "babylonjs/types";
  66302. import { Scene } from "babylonjs/scene";
  66303. import { Effect } from "babylonjs/Materials/effect";
  66304. import { NodeMaterial, NodeMaterialDefines } from "babylonjs/Materials/Node/nodeMaterial";
  66305. import { Mesh } from "babylonjs/Meshes/mesh";
  66306. import { Light } from "babylonjs/Lights/light";
  66307. import { AbstractMesh } from "babylonjs/Meshes/abstractMesh";
  66308. /**
  66309. * Block used to get data information from a light
  66310. */
  66311. export class LightInformationBlock extends NodeMaterialBlock {
  66312. private _lightDataUniformName;
  66313. private _lightColorUniformName;
  66314. private _lightTypeDefineName;
  66315. /**
  66316. * Gets or sets the light associated with this block
  66317. */
  66318. light: Nullable<Light>;
  66319. /**
  66320. * Creates a new LightInformationBlock
  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 world position input component
  66331. */
  66332. get worldPosition(): NodeMaterialConnectionPoint;
  66333. /**
  66334. * Gets the direction output component
  66335. */
  66336. get direction(): NodeMaterialConnectionPoint;
  66337. /**
  66338. * Gets the direction output component
  66339. */
  66340. get color(): NodeMaterialConnectionPoint;
  66341. /**
  66342. * Gets the direction output component
  66343. */
  66344. get intensity(): NodeMaterialConnectionPoint;
  66345. bind(effect: Effect, nodeMaterial: NodeMaterial, mesh?: Mesh): void;
  66346. prepareDefines(mesh: AbstractMesh, nodeMaterial: NodeMaterial, defines: NodeMaterialDefines): void;
  66347. protected _buildBlock(state: NodeMaterialBuildState): this;
  66348. serialize(): any;
  66349. _deserialize(serializationObject: any, scene: Scene, rootUrl: string): void;
  66350. }
  66351. }
  66352. declare module "babylonjs/Materials/Node/Blocks/Vertex/index" {
  66353. export * from "babylonjs/Materials/Node/Blocks/Vertex/vertexOutputBlock";
  66354. export * from "babylonjs/Materials/Node/Blocks/Vertex/bonesBlock";
  66355. export * from "babylonjs/Materials/Node/Blocks/Vertex/instancesBlock";
  66356. export * from "babylonjs/Materials/Node/Blocks/Vertex/morphTargetsBlock";
  66357. export * from "babylonjs/Materials/Node/Blocks/Vertex/lightInformationBlock";
  66358. }
  66359. declare module "babylonjs/Materials/Node/Blocks/Fragment/imageProcessingBlock" {
  66360. import { NodeMaterialBlock } from "babylonjs/Materials/Node/nodeMaterialBlock";
  66361. import { NodeMaterialBuildState } from "babylonjs/Materials/Node/nodeMaterialBuildState";
  66362. import { NodeMaterialConnectionPoint } from "babylonjs/Materials/Node/nodeMaterialBlockConnectionPoint";
  66363. import { AbstractMesh } from "babylonjs/Meshes/abstractMesh";
  66364. import { NodeMaterial, NodeMaterialDefines } from "babylonjs/Materials/Node/nodeMaterial";
  66365. import { Effect } from "babylonjs/Materials/effect";
  66366. import { Mesh } from "babylonjs/Meshes/mesh";
  66367. import "babylonjs/Shaders/ShadersInclude/helperFunctions";
  66368. import "babylonjs/Shaders/ShadersInclude/imageProcessingDeclaration";
  66369. import "babylonjs/Shaders/ShadersInclude/imageProcessingFunctions";
  66370. /**
  66371. * Block used to add image processing support to fragment shader
  66372. */
  66373. export class ImageProcessingBlock extends NodeMaterialBlock {
  66374. /**
  66375. * Create a new ImageProcessingBlock
  66376. * @param name defines the block name
  66377. */
  66378. constructor(name: string);
  66379. /**
  66380. * Gets the current class name
  66381. * @returns the class name
  66382. */
  66383. getClassName(): string;
  66384. /**
  66385. * Gets the color input component
  66386. */
  66387. get color(): NodeMaterialConnectionPoint;
  66388. /**
  66389. * Gets the output component
  66390. */
  66391. get output(): NodeMaterialConnectionPoint;
  66392. /**
  66393. * Initialize the block and prepare the context for build
  66394. * @param state defines the state that will be used for the build
  66395. */
  66396. initialize(state: NodeMaterialBuildState): void;
  66397. isReady(mesh: AbstractMesh, nodeMaterial: NodeMaterial, defines: NodeMaterialDefines): boolean;
  66398. prepareDefines(mesh: AbstractMesh, nodeMaterial: NodeMaterial, defines: NodeMaterialDefines): void;
  66399. bind(effect: Effect, nodeMaterial: NodeMaterial, mesh?: Mesh): void;
  66400. protected _buildBlock(state: NodeMaterialBuildState): this;
  66401. }
  66402. }
  66403. declare module "babylonjs/Materials/Node/Blocks/Fragment/perturbNormalBlock" {
  66404. import { NodeMaterialBlock } from "babylonjs/Materials/Node/nodeMaterialBlock";
  66405. import { NodeMaterialBuildState } from "babylonjs/Materials/Node/nodeMaterialBuildState";
  66406. import { NodeMaterialConnectionPoint } from "babylonjs/Materials/Node/nodeMaterialBlockConnectionPoint";
  66407. import { NodeMaterial, NodeMaterialDefines } from "babylonjs/Materials/Node/nodeMaterial";
  66408. import { AbstractMesh } from "babylonjs/Meshes/abstractMesh";
  66409. import { Effect } from "babylonjs/Materials/effect";
  66410. import { Mesh } from "babylonjs/Meshes/mesh";
  66411. import { Scene } from "babylonjs/scene";
  66412. import "babylonjs/Shaders/ShadersInclude/bumpFragmentMainFunctions";
  66413. import "babylonjs/Shaders/ShadersInclude/bumpFragmentFunctions";
  66414. import "babylonjs/Shaders/ShadersInclude/bumpFragment";
  66415. /**
  66416. * Block used to pertub normals based on a normal map
  66417. */
  66418. export class PerturbNormalBlock extends NodeMaterialBlock {
  66419. private _tangentSpaceParameterName;
  66420. /** Gets or sets a boolean indicating that normal should be inverted on X axis */
  66421. invertX: boolean;
  66422. /** Gets or sets a boolean indicating that normal should be inverted on Y axis */
  66423. invertY: boolean;
  66424. /**
  66425. * Create a new PerturbNormalBlock
  66426. * @param name defines the block name
  66427. */
  66428. constructor(name: string);
  66429. /**
  66430. * Gets the current class name
  66431. * @returns the class name
  66432. */
  66433. getClassName(): string;
  66434. /**
  66435. * Gets the world position input component
  66436. */
  66437. get worldPosition(): NodeMaterialConnectionPoint;
  66438. /**
  66439. * Gets the world normal input component
  66440. */
  66441. get worldNormal(): NodeMaterialConnectionPoint;
  66442. /**
  66443. * Gets the world tangent input component
  66444. */
  66445. get worldTangent(): NodeMaterialConnectionPoint;
  66446. /**
  66447. * Gets the uv input component
  66448. */
  66449. get uv(): NodeMaterialConnectionPoint;
  66450. /**
  66451. * Gets the normal map color input component
  66452. */
  66453. get normalMapColor(): NodeMaterialConnectionPoint;
  66454. /**
  66455. * Gets the strength input component
  66456. */
  66457. get strength(): NodeMaterialConnectionPoint;
  66458. /**
  66459. * Gets the output component
  66460. */
  66461. get output(): NodeMaterialConnectionPoint;
  66462. prepareDefines(mesh: AbstractMesh, nodeMaterial: NodeMaterial, defines: NodeMaterialDefines): void;
  66463. bind(effect: Effect, nodeMaterial: NodeMaterial, mesh?: Mesh): void;
  66464. autoConfigure(material: NodeMaterial): void;
  66465. protected _buildBlock(state: NodeMaterialBuildState): this;
  66466. protected _dumpPropertiesCode(): string;
  66467. serialize(): any;
  66468. _deserialize(serializationObject: any, scene: Scene, rootUrl: string): void;
  66469. }
  66470. }
  66471. declare module "babylonjs/Materials/Node/Blocks/Fragment/discardBlock" {
  66472. import { NodeMaterialBlock } from "babylonjs/Materials/Node/nodeMaterialBlock";
  66473. import { NodeMaterialBuildState } from "babylonjs/Materials/Node/nodeMaterialBuildState";
  66474. import { NodeMaterialConnectionPoint } from "babylonjs/Materials/Node/nodeMaterialBlockConnectionPoint";
  66475. /**
  66476. * Block used to discard a pixel if a value is smaller than a cutoff
  66477. */
  66478. export class DiscardBlock extends NodeMaterialBlock {
  66479. /**
  66480. * Create a new DiscardBlock
  66481. * @param name defines the block name
  66482. */
  66483. constructor(name: string);
  66484. /**
  66485. * Gets the current class name
  66486. * @returns the class name
  66487. */
  66488. getClassName(): string;
  66489. /**
  66490. * Gets the color input component
  66491. */
  66492. get value(): NodeMaterialConnectionPoint;
  66493. /**
  66494. * Gets the cutoff input component
  66495. */
  66496. get cutoff(): NodeMaterialConnectionPoint;
  66497. protected _buildBlock(state: NodeMaterialBuildState): this;
  66498. }
  66499. }
  66500. declare module "babylonjs/Materials/Node/Blocks/Fragment/frontFacingBlock" {
  66501. import { NodeMaterialBlock } from "babylonjs/Materials/Node/nodeMaterialBlock";
  66502. import { NodeMaterialBuildState } from "babylonjs/Materials/Node/nodeMaterialBuildState";
  66503. import { NodeMaterialConnectionPoint } from "babylonjs/Materials/Node/nodeMaterialBlockConnectionPoint";
  66504. /**
  66505. * Block used to test if the fragment shader is front facing
  66506. */
  66507. export class FrontFacingBlock extends NodeMaterialBlock {
  66508. /**
  66509. * Creates a new FrontFacingBlock
  66510. * @param name defines the block name
  66511. */
  66512. constructor(name: string);
  66513. /**
  66514. * Gets the current class name
  66515. * @returns the class name
  66516. */
  66517. getClassName(): string;
  66518. /**
  66519. * Gets the output component
  66520. */
  66521. get output(): NodeMaterialConnectionPoint;
  66522. protected _buildBlock(state: NodeMaterialBuildState): this;
  66523. }
  66524. }
  66525. declare module "babylonjs/Materials/Node/Blocks/Fragment/derivativeBlock" {
  66526. import { NodeMaterialBlock } from "babylonjs/Materials/Node/nodeMaterialBlock";
  66527. import { NodeMaterialBuildState } from "babylonjs/Materials/Node/nodeMaterialBuildState";
  66528. import { NodeMaterialConnectionPoint } from "babylonjs/Materials/Node/nodeMaterialBlockConnectionPoint";
  66529. /**
  66530. * Block used to get the derivative value on x and y of a given input
  66531. */
  66532. export class DerivativeBlock extends NodeMaterialBlock {
  66533. /**
  66534. * Create a new DerivativeBlock
  66535. * @param name defines the block name
  66536. */
  66537. constructor(name: string);
  66538. /**
  66539. * Gets the current class name
  66540. * @returns the class name
  66541. */
  66542. getClassName(): string;
  66543. /**
  66544. * Gets the input component
  66545. */
  66546. get input(): NodeMaterialConnectionPoint;
  66547. /**
  66548. * Gets the derivative output on x
  66549. */
  66550. get dx(): NodeMaterialConnectionPoint;
  66551. /**
  66552. * Gets the derivative output on y
  66553. */
  66554. get dy(): NodeMaterialConnectionPoint;
  66555. protected _buildBlock(state: NodeMaterialBuildState): this;
  66556. }
  66557. }
  66558. declare module "babylonjs/Materials/Node/Blocks/Fragment/fragCoordBlock" {
  66559. import { NodeMaterialBlock } from "babylonjs/Materials/Node/nodeMaterialBlock";
  66560. import { NodeMaterialBuildState } from "babylonjs/Materials/Node/nodeMaterialBuildState";
  66561. import { NodeMaterialConnectionPoint } from "babylonjs/Materials/Node/nodeMaterialBlockConnectionPoint";
  66562. /**
  66563. * Block used to make gl_FragCoord available
  66564. */
  66565. export class FragCoordBlock extends NodeMaterialBlock {
  66566. /**
  66567. * Creates a new FragCoordBlock
  66568. * @param name defines the block name
  66569. */
  66570. constructor(name: string);
  66571. /**
  66572. * Gets the current class name
  66573. * @returns the class name
  66574. */
  66575. getClassName(): string;
  66576. /**
  66577. * Gets the xy component
  66578. */
  66579. get xy(): NodeMaterialConnectionPoint;
  66580. /**
  66581. * Gets the xyz component
  66582. */
  66583. get xyz(): NodeMaterialConnectionPoint;
  66584. /**
  66585. * Gets the xyzw component
  66586. */
  66587. get xyzw(): NodeMaterialConnectionPoint;
  66588. /**
  66589. * Gets the x component
  66590. */
  66591. get x(): NodeMaterialConnectionPoint;
  66592. /**
  66593. * Gets the y component
  66594. */
  66595. get y(): NodeMaterialConnectionPoint;
  66596. /**
  66597. * Gets the z component
  66598. */
  66599. get z(): NodeMaterialConnectionPoint;
  66600. /**
  66601. * Gets the w component
  66602. */
  66603. get output(): NodeMaterialConnectionPoint;
  66604. protected writeOutputs(state: NodeMaterialBuildState): string;
  66605. protected _buildBlock(state: NodeMaterialBuildState): this;
  66606. }
  66607. }
  66608. declare module "babylonjs/Materials/Node/Blocks/Fragment/screenSizeBlock" {
  66609. import { NodeMaterialBlock } from "babylonjs/Materials/Node/nodeMaterialBlock";
  66610. import { NodeMaterialBuildState } from "babylonjs/Materials/Node/nodeMaterialBuildState";
  66611. import { NodeMaterialConnectionPoint } from "babylonjs/Materials/Node/nodeMaterialBlockConnectionPoint";
  66612. import { Effect } from "babylonjs/Materials/effect";
  66613. import { NodeMaterial } from "babylonjs/Materials/Node/nodeMaterial";
  66614. import { Mesh } from "babylonjs/Meshes/mesh";
  66615. /**
  66616. * Block used to get the screen sizes
  66617. */
  66618. export class ScreenSizeBlock extends NodeMaterialBlock {
  66619. private _varName;
  66620. private _scene;
  66621. /**
  66622. * Creates a new ScreenSizeBlock
  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 xy component
  66633. */
  66634. get xy(): NodeMaterialConnectionPoint;
  66635. /**
  66636. * Gets the x component
  66637. */
  66638. get x(): NodeMaterialConnectionPoint;
  66639. /**
  66640. * Gets the y component
  66641. */
  66642. get y(): NodeMaterialConnectionPoint;
  66643. bind(effect: Effect, nodeMaterial: NodeMaterial, mesh?: Mesh): void;
  66644. protected writeOutputs(state: NodeMaterialBuildState, varName: string): string;
  66645. protected _buildBlock(state: NodeMaterialBuildState): this;
  66646. }
  66647. }
  66648. declare module "babylonjs/Materials/Node/Blocks/Fragment/index" {
  66649. export * from "babylonjs/Materials/Node/Blocks/Fragment/fragmentOutputBlock";
  66650. export * from "babylonjs/Materials/Node/Blocks/Fragment/imageProcessingBlock";
  66651. export * from "babylonjs/Materials/Node/Blocks/Fragment/perturbNormalBlock";
  66652. export * from "babylonjs/Materials/Node/Blocks/Fragment/discardBlock";
  66653. export * from "babylonjs/Materials/Node/Blocks/Fragment/frontFacingBlock";
  66654. export * from "babylonjs/Materials/Node/Blocks/Fragment/derivativeBlock";
  66655. export * from "babylonjs/Materials/Node/Blocks/Fragment/fragCoordBlock";
  66656. export * from "babylonjs/Materials/Node/Blocks/Fragment/screenSizeBlock";
  66657. }
  66658. declare module "babylonjs/Materials/Node/Blocks/Dual/fogBlock" {
  66659. import { NodeMaterialBlock } from "babylonjs/Materials/Node/nodeMaterialBlock";
  66660. import { NodeMaterialBuildState } from "babylonjs/Materials/Node/nodeMaterialBuildState";
  66661. import { Mesh } from "babylonjs/Meshes/mesh";
  66662. import { Effect } from "babylonjs/Materials/effect";
  66663. import { NodeMaterialConnectionPoint } from "babylonjs/Materials/Node/nodeMaterialBlockConnectionPoint";
  66664. import { AbstractMesh } from "babylonjs/Meshes/abstractMesh";
  66665. import { NodeMaterial, NodeMaterialDefines } from "babylonjs/Materials/Node/nodeMaterial";
  66666. import "babylonjs/Shaders/ShadersInclude/fogFragmentDeclaration";
  66667. /**
  66668. * Block used to add support for scene fog
  66669. */
  66670. export class FogBlock extends NodeMaterialBlock {
  66671. private _fogDistanceName;
  66672. private _fogParameters;
  66673. /**
  66674. * Create a new FogBlock
  66675. * @param name defines the block name
  66676. */
  66677. constructor(name: string);
  66678. /**
  66679. * Gets the current class name
  66680. * @returns the class name
  66681. */
  66682. getClassName(): string;
  66683. /**
  66684. * Gets the world position input component
  66685. */
  66686. get worldPosition(): NodeMaterialConnectionPoint;
  66687. /**
  66688. * Gets the view input component
  66689. */
  66690. get view(): NodeMaterialConnectionPoint;
  66691. /**
  66692. * Gets the color input component
  66693. */
  66694. get input(): NodeMaterialConnectionPoint;
  66695. /**
  66696. * Gets the fog color input component
  66697. */
  66698. get fogColor(): NodeMaterialConnectionPoint;
  66699. /**
  66700. * Gets the output component
  66701. */
  66702. get output(): NodeMaterialConnectionPoint;
  66703. autoConfigure(material: NodeMaterial): void;
  66704. prepareDefines(mesh: AbstractMesh, nodeMaterial: NodeMaterial, defines: NodeMaterialDefines): void;
  66705. bind(effect: Effect, nodeMaterial: NodeMaterial, mesh?: Mesh): void;
  66706. protected _buildBlock(state: NodeMaterialBuildState): this;
  66707. }
  66708. }
  66709. declare module "babylonjs/Materials/Node/Blocks/Dual/lightBlock" {
  66710. import { NodeMaterialBlock } from "babylonjs/Materials/Node/nodeMaterialBlock";
  66711. import { NodeMaterialBuildState } from "babylonjs/Materials/Node/nodeMaterialBuildState";
  66712. import { NodeMaterialConnectionPoint } from "babylonjs/Materials/Node/nodeMaterialBlockConnectionPoint";
  66713. import { AbstractMesh } from "babylonjs/Meshes/abstractMesh";
  66714. import { NodeMaterial, NodeMaterialDefines } from "babylonjs/Materials/Node/nodeMaterial";
  66715. import { Effect } from "babylonjs/Materials/effect";
  66716. import { Mesh } from "babylonjs/Meshes/mesh";
  66717. import { Light } from "babylonjs/Lights/light";
  66718. import { Nullable } from "babylonjs/types";
  66719. import { Scene } from "babylonjs/scene";
  66720. import "babylonjs/Shaders/ShadersInclude/lightFragmentDeclaration";
  66721. import "babylonjs/Shaders/ShadersInclude/lightUboDeclaration";
  66722. import "babylonjs/Shaders/ShadersInclude/lightFragment";
  66723. import "babylonjs/Shaders/ShadersInclude/helperFunctions";
  66724. import "babylonjs/Shaders/ShadersInclude/lightsFragmentFunctions";
  66725. import "babylonjs/Shaders/ShadersInclude/shadowsFragmentFunctions";
  66726. import "babylonjs/Shaders/ShadersInclude/shadowsVertex";
  66727. /**
  66728. * Block used to add light in the fragment shader
  66729. */
  66730. export class LightBlock extends NodeMaterialBlock {
  66731. private _lightId;
  66732. /**
  66733. * Gets or sets the light associated with this block
  66734. */
  66735. light: Nullable<Light>;
  66736. /**
  66737. * Create a new LightBlock
  66738. * @param name defines the block name
  66739. */
  66740. constructor(name: string);
  66741. /**
  66742. * Gets the current class name
  66743. * @returns the class name
  66744. */
  66745. getClassName(): string;
  66746. /**
  66747. * Gets the world position input component
  66748. */
  66749. get worldPosition(): NodeMaterialConnectionPoint;
  66750. /**
  66751. * Gets the world normal input component
  66752. */
  66753. get worldNormal(): NodeMaterialConnectionPoint;
  66754. /**
  66755. * Gets the camera (or eye) position component
  66756. */
  66757. get cameraPosition(): NodeMaterialConnectionPoint;
  66758. /**
  66759. * Gets the glossiness component
  66760. */
  66761. get glossiness(): NodeMaterialConnectionPoint;
  66762. /**
  66763. * Gets the glossinness power component
  66764. */
  66765. get glossPower(): NodeMaterialConnectionPoint;
  66766. /**
  66767. * Gets the diffuse color component
  66768. */
  66769. get diffuseColor(): NodeMaterialConnectionPoint;
  66770. /**
  66771. * Gets the specular color component
  66772. */
  66773. get specularColor(): NodeMaterialConnectionPoint;
  66774. /**
  66775. * Gets the diffuse output component
  66776. */
  66777. get diffuseOutput(): NodeMaterialConnectionPoint;
  66778. /**
  66779. * Gets the specular output component
  66780. */
  66781. get specularOutput(): NodeMaterialConnectionPoint;
  66782. /**
  66783. * Gets the shadow output component
  66784. */
  66785. get shadow(): NodeMaterialConnectionPoint;
  66786. autoConfigure(material: NodeMaterial): void;
  66787. prepareDefines(mesh: AbstractMesh, nodeMaterial: NodeMaterial, defines: NodeMaterialDefines): void;
  66788. updateUniformsAndSamples(state: NodeMaterialBuildState, nodeMaterial: NodeMaterial, defines: NodeMaterialDefines, uniformBuffers: string[]): void;
  66789. bind(effect: Effect, nodeMaterial: NodeMaterial, mesh?: Mesh): void;
  66790. private _injectVertexCode;
  66791. protected _buildBlock(state: NodeMaterialBuildState): this | undefined;
  66792. serialize(): any;
  66793. _deserialize(serializationObject: any, scene: Scene, rootUrl: string): void;
  66794. }
  66795. }
  66796. declare module "babylonjs/Materials/Node/Blocks/Dual/reflectionTextureBlock" {
  66797. import { NodeMaterialBuildState } from "babylonjs/Materials/Node/nodeMaterialBuildState";
  66798. import { NodeMaterialConnectionPoint } from "babylonjs/Materials/Node/nodeMaterialBlockConnectionPoint";
  66799. import { NodeMaterial } from "babylonjs/Materials/Node/nodeMaterial";
  66800. import { ReflectionTextureBaseBlock } from "babylonjs/Materials/Node/Blocks/Dual/reflectionTextureBaseBlock";
  66801. /**
  66802. * Block used to read a reflection texture from a sampler
  66803. */
  66804. export class ReflectionTextureBlock extends ReflectionTextureBaseBlock {
  66805. /**
  66806. * Create a new ReflectionTextureBlock
  66807. * @param name defines the block name
  66808. */
  66809. constructor(name: string);
  66810. /**
  66811. * Gets the current class name
  66812. * @returns the class name
  66813. */
  66814. getClassName(): string;
  66815. /**
  66816. * Gets the world position input component
  66817. */
  66818. get position(): NodeMaterialConnectionPoint;
  66819. /**
  66820. * Gets the world position input component
  66821. */
  66822. get worldPosition(): NodeMaterialConnectionPoint;
  66823. /**
  66824. * Gets the world normal input component
  66825. */
  66826. get worldNormal(): NodeMaterialConnectionPoint;
  66827. /**
  66828. * Gets the world input component
  66829. */
  66830. get world(): NodeMaterialConnectionPoint;
  66831. /**
  66832. * Gets the camera (or eye) position component
  66833. */
  66834. get cameraPosition(): NodeMaterialConnectionPoint;
  66835. /**
  66836. * Gets the view input component
  66837. */
  66838. get view(): NodeMaterialConnectionPoint;
  66839. /**
  66840. * Gets the rgb output component
  66841. */
  66842. get rgb(): NodeMaterialConnectionPoint;
  66843. /**
  66844. * Gets the rgba output component
  66845. */
  66846. get rgba(): NodeMaterialConnectionPoint;
  66847. /**
  66848. * Gets the r output component
  66849. */
  66850. get r(): NodeMaterialConnectionPoint;
  66851. /**
  66852. * Gets the g output component
  66853. */
  66854. get g(): NodeMaterialConnectionPoint;
  66855. /**
  66856. * Gets the b output component
  66857. */
  66858. get b(): NodeMaterialConnectionPoint;
  66859. /**
  66860. * Gets the a output component
  66861. */
  66862. get a(): NodeMaterialConnectionPoint;
  66863. autoConfigure(material: NodeMaterial): void;
  66864. protected _buildBlock(state: NodeMaterialBuildState): this;
  66865. }
  66866. }
  66867. declare module "babylonjs/Materials/Node/Blocks/Dual/index" {
  66868. export * from "babylonjs/Materials/Node/Blocks/Dual/fogBlock";
  66869. export * from "babylonjs/Materials/Node/Blocks/Dual/lightBlock";
  66870. export * from "babylonjs/Materials/Node/Blocks/Dual/textureBlock";
  66871. export * from "babylonjs/Materials/Node/Blocks/Dual/reflectionTextureBlock";
  66872. export * from "babylonjs/Materials/Node/Blocks/Dual/currentScreenBlock";
  66873. }
  66874. declare module "babylonjs/Materials/Node/Blocks/Input/index" {
  66875. export * from "babylonjs/Materials/Node/Blocks/Input/inputBlock";
  66876. export * from "babylonjs/Materials/Node/Blocks/Input/animatedInputBlockTypes";
  66877. }
  66878. declare module "babylonjs/Materials/Node/Blocks/addBlock" {
  66879. import { NodeMaterialBlock } from "babylonjs/Materials/Node/nodeMaterialBlock";
  66880. import { NodeMaterialBuildState } from "babylonjs/Materials/Node/nodeMaterialBuildState";
  66881. import { NodeMaterialConnectionPoint } from "babylonjs/Materials/Node/nodeMaterialBlockConnectionPoint";
  66882. /**
  66883. * Block used to add 2 vectors
  66884. */
  66885. export class AddBlock extends NodeMaterialBlock {
  66886. /**
  66887. * Creates a new AddBlock
  66888. * @param name defines the block name
  66889. */
  66890. constructor(name: string);
  66891. /**
  66892. * Gets the current class name
  66893. * @returns the class name
  66894. */
  66895. getClassName(): string;
  66896. /**
  66897. * Gets the left operand input component
  66898. */
  66899. get left(): NodeMaterialConnectionPoint;
  66900. /**
  66901. * Gets the right operand input component
  66902. */
  66903. get right(): NodeMaterialConnectionPoint;
  66904. /**
  66905. * Gets the output component
  66906. */
  66907. get output(): NodeMaterialConnectionPoint;
  66908. protected _buildBlock(state: NodeMaterialBuildState): this;
  66909. }
  66910. }
  66911. declare module "babylonjs/Materials/Node/Blocks/scaleBlock" {
  66912. import { NodeMaterialBlock } from "babylonjs/Materials/Node/nodeMaterialBlock";
  66913. import { NodeMaterialBuildState } from "babylonjs/Materials/Node/nodeMaterialBuildState";
  66914. import { NodeMaterialConnectionPoint } from "babylonjs/Materials/Node/nodeMaterialBlockConnectionPoint";
  66915. /**
  66916. * Block used to scale a vector by a float
  66917. */
  66918. export class ScaleBlock extends NodeMaterialBlock {
  66919. /**
  66920. * Creates a new ScaleBlock
  66921. * @param name defines the block name
  66922. */
  66923. constructor(name: string);
  66924. /**
  66925. * Gets the current class name
  66926. * @returns the class name
  66927. */
  66928. getClassName(): string;
  66929. /**
  66930. * Gets the input component
  66931. */
  66932. get input(): NodeMaterialConnectionPoint;
  66933. /**
  66934. * Gets the factor input component
  66935. */
  66936. get factor(): NodeMaterialConnectionPoint;
  66937. /**
  66938. * Gets the output component
  66939. */
  66940. get output(): NodeMaterialConnectionPoint;
  66941. protected _buildBlock(state: NodeMaterialBuildState): this;
  66942. }
  66943. }
  66944. declare module "babylonjs/Materials/Node/Blocks/clampBlock" {
  66945. import { NodeMaterialBlock } from "babylonjs/Materials/Node/nodeMaterialBlock";
  66946. import { NodeMaterialBuildState } from "babylonjs/Materials/Node/nodeMaterialBuildState";
  66947. import { NodeMaterialConnectionPoint } from "babylonjs/Materials/Node/nodeMaterialBlockConnectionPoint";
  66948. import { Scene } from "babylonjs/scene";
  66949. /**
  66950. * Block used to clamp a float
  66951. */
  66952. export class ClampBlock extends NodeMaterialBlock {
  66953. /** Gets or sets the minimum range */
  66954. minimum: number;
  66955. /** Gets or sets the maximum range */
  66956. maximum: number;
  66957. /**
  66958. * Creates a new ClampBlock
  66959. * @param name defines the block name
  66960. */
  66961. constructor(name: string);
  66962. /**
  66963. * Gets the current class name
  66964. * @returns the class name
  66965. */
  66966. getClassName(): string;
  66967. /**
  66968. * Gets the value input component
  66969. */
  66970. get value(): NodeMaterialConnectionPoint;
  66971. /**
  66972. * Gets the output component
  66973. */
  66974. get output(): NodeMaterialConnectionPoint;
  66975. protected _buildBlock(state: NodeMaterialBuildState): this;
  66976. protected _dumpPropertiesCode(): string;
  66977. serialize(): any;
  66978. _deserialize(serializationObject: any, scene: Scene, rootUrl: string): void;
  66979. }
  66980. }
  66981. declare module "babylonjs/Materials/Node/Blocks/crossBlock" {
  66982. import { NodeMaterialBlock } from "babylonjs/Materials/Node/nodeMaterialBlock";
  66983. import { NodeMaterialBuildState } from "babylonjs/Materials/Node/nodeMaterialBuildState";
  66984. import { NodeMaterialConnectionPoint } from "babylonjs/Materials/Node/nodeMaterialBlockConnectionPoint";
  66985. /**
  66986. * Block used to apply a cross product between 2 vectors
  66987. */
  66988. export class CrossBlock extends NodeMaterialBlock {
  66989. /**
  66990. * Creates a new CrossBlock
  66991. * @param name defines the block name
  66992. */
  66993. constructor(name: string);
  66994. /**
  66995. * Gets the current class name
  66996. * @returns the class name
  66997. */
  66998. getClassName(): string;
  66999. /**
  67000. * Gets the left operand input component
  67001. */
  67002. get left(): NodeMaterialConnectionPoint;
  67003. /**
  67004. * Gets the right operand input component
  67005. */
  67006. get right(): NodeMaterialConnectionPoint;
  67007. /**
  67008. * Gets the output component
  67009. */
  67010. get output(): NodeMaterialConnectionPoint;
  67011. protected _buildBlock(state: NodeMaterialBuildState): this;
  67012. }
  67013. }
  67014. declare module "babylonjs/Materials/Node/Blocks/dotBlock" {
  67015. import { NodeMaterialBlock } from "babylonjs/Materials/Node/nodeMaterialBlock";
  67016. import { NodeMaterialBuildState } from "babylonjs/Materials/Node/nodeMaterialBuildState";
  67017. import { NodeMaterialConnectionPoint } from "babylonjs/Materials/Node/nodeMaterialBlockConnectionPoint";
  67018. /**
  67019. * Block used to apply a dot product between 2 vectors
  67020. */
  67021. export class DotBlock extends NodeMaterialBlock {
  67022. /**
  67023. * Creates a new DotBlock
  67024. * @param name defines the block name
  67025. */
  67026. constructor(name: string);
  67027. /**
  67028. * Gets the current class name
  67029. * @returns the class name
  67030. */
  67031. getClassName(): string;
  67032. /**
  67033. * Gets the left operand input component
  67034. */
  67035. get left(): NodeMaterialConnectionPoint;
  67036. /**
  67037. * Gets the right operand input component
  67038. */
  67039. get right(): NodeMaterialConnectionPoint;
  67040. /**
  67041. * Gets the output component
  67042. */
  67043. get output(): NodeMaterialConnectionPoint;
  67044. protected _buildBlock(state: NodeMaterialBuildState): this;
  67045. }
  67046. }
  67047. declare module "babylonjs/Materials/Node/Blocks/normalizeBlock" {
  67048. import { NodeMaterialBlock } from "babylonjs/Materials/Node/nodeMaterialBlock";
  67049. import { NodeMaterialBuildState } from "babylonjs/Materials/Node/nodeMaterialBuildState";
  67050. import { NodeMaterialConnectionPoint } from "babylonjs/Materials/Node/nodeMaterialBlockConnectionPoint";
  67051. /**
  67052. * Block used to normalize a vector
  67053. */
  67054. export class NormalizeBlock extends NodeMaterialBlock {
  67055. /**
  67056. * Creates a new NormalizeBlock
  67057. * @param name defines the block name
  67058. */
  67059. constructor(name: string);
  67060. /**
  67061. * Gets the current class name
  67062. * @returns the class name
  67063. */
  67064. getClassName(): string;
  67065. /**
  67066. * Gets the input component
  67067. */
  67068. get input(): NodeMaterialConnectionPoint;
  67069. /**
  67070. * Gets the output component
  67071. */
  67072. get output(): NodeMaterialConnectionPoint;
  67073. protected _buildBlock(state: NodeMaterialBuildState): this;
  67074. }
  67075. }
  67076. declare module "babylonjs/Materials/Node/Blocks/colorMergerBlock" {
  67077. import { NodeMaterialBlock } from "babylonjs/Materials/Node/nodeMaterialBlock";
  67078. import { NodeMaterialBuildState } from "babylonjs/Materials/Node/nodeMaterialBuildState";
  67079. import { NodeMaterialConnectionPoint } from "babylonjs/Materials/Node/nodeMaterialBlockConnectionPoint";
  67080. /**
  67081. * Block used to create a Color3/4 out of individual inputs (one for each component)
  67082. */
  67083. export class ColorMergerBlock extends NodeMaterialBlock {
  67084. /**
  67085. * Create a new ColorMergerBlock
  67086. * @param name defines the block name
  67087. */
  67088. constructor(name: string);
  67089. /**
  67090. * Gets the current class name
  67091. * @returns the class name
  67092. */
  67093. getClassName(): string;
  67094. /**
  67095. * Gets the rgb component (input)
  67096. */
  67097. get rgbIn(): NodeMaterialConnectionPoint;
  67098. /**
  67099. * Gets the r component (input)
  67100. */
  67101. get r(): NodeMaterialConnectionPoint;
  67102. /**
  67103. * Gets the g component (input)
  67104. */
  67105. get g(): NodeMaterialConnectionPoint;
  67106. /**
  67107. * Gets the b component (input)
  67108. */
  67109. get b(): NodeMaterialConnectionPoint;
  67110. /**
  67111. * Gets the a component (input)
  67112. */
  67113. get a(): NodeMaterialConnectionPoint;
  67114. /**
  67115. * Gets the rgba component (output)
  67116. */
  67117. get rgba(): NodeMaterialConnectionPoint;
  67118. /**
  67119. * Gets the rgb component (output)
  67120. */
  67121. get rgbOut(): NodeMaterialConnectionPoint;
  67122. /**
  67123. * Gets the rgb component (output)
  67124. * @deprecated Please use rgbOut instead.
  67125. */
  67126. get rgb(): NodeMaterialConnectionPoint;
  67127. protected _buildBlock(state: NodeMaterialBuildState): this;
  67128. }
  67129. }
  67130. declare module "babylonjs/Materials/Node/Blocks/vectorSplitterBlock" {
  67131. import { NodeMaterialBlock } from "babylonjs/Materials/Node/nodeMaterialBlock";
  67132. import { NodeMaterialBuildState } from "babylonjs/Materials/Node/nodeMaterialBuildState";
  67133. import { NodeMaterialConnectionPoint } from "babylonjs/Materials/Node/nodeMaterialBlockConnectionPoint";
  67134. /**
  67135. * Block used to expand a Vector3/4 into 4 outputs (one for each component)
  67136. */
  67137. export class VectorSplitterBlock extends NodeMaterialBlock {
  67138. /**
  67139. * Create a new VectorSplitterBlock
  67140. * @param name defines the block name
  67141. */
  67142. constructor(name: string);
  67143. /**
  67144. * Gets the current class name
  67145. * @returns the class name
  67146. */
  67147. getClassName(): string;
  67148. /**
  67149. * Gets the xyzw component (input)
  67150. */
  67151. get xyzw(): NodeMaterialConnectionPoint;
  67152. /**
  67153. * Gets the xyz component (input)
  67154. */
  67155. get xyzIn(): NodeMaterialConnectionPoint;
  67156. /**
  67157. * Gets the xy component (input)
  67158. */
  67159. get xyIn(): NodeMaterialConnectionPoint;
  67160. /**
  67161. * Gets the xyz component (output)
  67162. */
  67163. get xyzOut(): NodeMaterialConnectionPoint;
  67164. /**
  67165. * Gets the xy component (output)
  67166. */
  67167. get xyOut(): NodeMaterialConnectionPoint;
  67168. /**
  67169. * Gets the x component (output)
  67170. */
  67171. get x(): NodeMaterialConnectionPoint;
  67172. /**
  67173. * Gets the y component (output)
  67174. */
  67175. get y(): NodeMaterialConnectionPoint;
  67176. /**
  67177. * Gets the z component (output)
  67178. */
  67179. get z(): NodeMaterialConnectionPoint;
  67180. /**
  67181. * Gets the w component (output)
  67182. */
  67183. get w(): NodeMaterialConnectionPoint;
  67184. protected _inputRename(name: string): string;
  67185. protected _outputRename(name: string): string;
  67186. protected _buildBlock(state: NodeMaterialBuildState): this;
  67187. }
  67188. }
  67189. declare module "babylonjs/Materials/Node/Blocks/lerpBlock" {
  67190. import { NodeMaterialBlock } from "babylonjs/Materials/Node/nodeMaterialBlock";
  67191. import { NodeMaterialBuildState } from "babylonjs/Materials/Node/nodeMaterialBuildState";
  67192. import { NodeMaterialConnectionPoint } from "babylonjs/Materials/Node/nodeMaterialBlockConnectionPoint";
  67193. /**
  67194. * Block used to lerp between 2 values
  67195. */
  67196. export class LerpBlock extends NodeMaterialBlock {
  67197. /**
  67198. * Creates a new LerpBlock
  67199. * @param name defines the block name
  67200. */
  67201. constructor(name: string);
  67202. /**
  67203. * Gets the current class name
  67204. * @returns the class name
  67205. */
  67206. getClassName(): string;
  67207. /**
  67208. * Gets the left operand input component
  67209. */
  67210. get left(): NodeMaterialConnectionPoint;
  67211. /**
  67212. * Gets the right operand input component
  67213. */
  67214. get right(): NodeMaterialConnectionPoint;
  67215. /**
  67216. * Gets the gradient operand input component
  67217. */
  67218. get gradient(): NodeMaterialConnectionPoint;
  67219. /**
  67220. * Gets the output component
  67221. */
  67222. get output(): NodeMaterialConnectionPoint;
  67223. protected _buildBlock(state: NodeMaterialBuildState): this;
  67224. }
  67225. }
  67226. declare module "babylonjs/Materials/Node/Blocks/divideBlock" {
  67227. import { NodeMaterialBlock } from "babylonjs/Materials/Node/nodeMaterialBlock";
  67228. import { NodeMaterialBuildState } from "babylonjs/Materials/Node/nodeMaterialBuildState";
  67229. import { NodeMaterialConnectionPoint } from "babylonjs/Materials/Node/nodeMaterialBlockConnectionPoint";
  67230. /**
  67231. * Block used to divide 2 vectors
  67232. */
  67233. export class DivideBlock extends NodeMaterialBlock {
  67234. /**
  67235. * Creates a new DivideBlock
  67236. * @param name defines the block name
  67237. */
  67238. constructor(name: string);
  67239. /**
  67240. * Gets the current class name
  67241. * @returns the class name
  67242. */
  67243. getClassName(): string;
  67244. /**
  67245. * Gets the left operand input component
  67246. */
  67247. get left(): NodeMaterialConnectionPoint;
  67248. /**
  67249. * Gets the right operand input component
  67250. */
  67251. get right(): NodeMaterialConnectionPoint;
  67252. /**
  67253. * Gets the output component
  67254. */
  67255. get output(): NodeMaterialConnectionPoint;
  67256. protected _buildBlock(state: NodeMaterialBuildState): this;
  67257. }
  67258. }
  67259. declare module "babylonjs/Materials/Node/Blocks/subtractBlock" {
  67260. import { NodeMaterialBlock } from "babylonjs/Materials/Node/nodeMaterialBlock";
  67261. import { NodeMaterialBuildState } from "babylonjs/Materials/Node/nodeMaterialBuildState";
  67262. import { NodeMaterialConnectionPoint } from "babylonjs/Materials/Node/nodeMaterialBlockConnectionPoint";
  67263. /**
  67264. * Block used to subtract 2 vectors
  67265. */
  67266. export class SubtractBlock extends NodeMaterialBlock {
  67267. /**
  67268. * Creates a new SubtractBlock
  67269. * @param name defines the block name
  67270. */
  67271. constructor(name: string);
  67272. /**
  67273. * Gets the current class name
  67274. * @returns the class name
  67275. */
  67276. getClassName(): string;
  67277. /**
  67278. * Gets the left operand input component
  67279. */
  67280. get left(): NodeMaterialConnectionPoint;
  67281. /**
  67282. * Gets the right operand input component
  67283. */
  67284. get right(): NodeMaterialConnectionPoint;
  67285. /**
  67286. * Gets the output component
  67287. */
  67288. get output(): NodeMaterialConnectionPoint;
  67289. protected _buildBlock(state: NodeMaterialBuildState): this;
  67290. }
  67291. }
  67292. declare module "babylonjs/Materials/Node/Blocks/stepBlock" {
  67293. import { NodeMaterialBlock } from "babylonjs/Materials/Node/nodeMaterialBlock";
  67294. import { NodeMaterialBuildState } from "babylonjs/Materials/Node/nodeMaterialBuildState";
  67295. import { NodeMaterialConnectionPoint } from "babylonjs/Materials/Node/nodeMaterialBlockConnectionPoint";
  67296. /**
  67297. * Block used to step a value
  67298. */
  67299. export class StepBlock extends NodeMaterialBlock {
  67300. /**
  67301. * Creates a new StepBlock
  67302. * @param name defines the block name
  67303. */
  67304. constructor(name: string);
  67305. /**
  67306. * Gets the current class name
  67307. * @returns the class name
  67308. */
  67309. getClassName(): string;
  67310. /**
  67311. * Gets the value operand input component
  67312. */
  67313. get value(): NodeMaterialConnectionPoint;
  67314. /**
  67315. * Gets the edge operand input component
  67316. */
  67317. get edge(): NodeMaterialConnectionPoint;
  67318. /**
  67319. * Gets the output component
  67320. */
  67321. get output(): NodeMaterialConnectionPoint;
  67322. protected _buildBlock(state: NodeMaterialBuildState): this;
  67323. }
  67324. }
  67325. declare module "babylonjs/Materials/Node/Blocks/oneMinusBlock" {
  67326. import { NodeMaterialBlock } from "babylonjs/Materials/Node/nodeMaterialBlock";
  67327. import { NodeMaterialBuildState } from "babylonjs/Materials/Node/nodeMaterialBuildState";
  67328. import { NodeMaterialConnectionPoint } from "babylonjs/Materials/Node/nodeMaterialBlockConnectionPoint";
  67329. /**
  67330. * Block used to get the opposite (1 - x) of a value
  67331. */
  67332. export class OneMinusBlock extends NodeMaterialBlock {
  67333. /**
  67334. * Creates a new OneMinusBlock
  67335. * @param name defines the block name
  67336. */
  67337. constructor(name: string);
  67338. /**
  67339. * Gets the current class name
  67340. * @returns the class name
  67341. */
  67342. getClassName(): string;
  67343. /**
  67344. * Gets the input component
  67345. */
  67346. get input(): NodeMaterialConnectionPoint;
  67347. /**
  67348. * Gets the output component
  67349. */
  67350. get output(): NodeMaterialConnectionPoint;
  67351. protected _buildBlock(state: NodeMaterialBuildState): this;
  67352. }
  67353. }
  67354. declare module "babylonjs/Materials/Node/Blocks/viewDirectionBlock" {
  67355. import { NodeMaterialBlock } from "babylonjs/Materials/Node/nodeMaterialBlock";
  67356. import { NodeMaterialBuildState } from "babylonjs/Materials/Node/nodeMaterialBuildState";
  67357. import { NodeMaterialConnectionPoint } from "babylonjs/Materials/Node/nodeMaterialBlockConnectionPoint";
  67358. import { NodeMaterial } from "babylonjs/Materials/Node/nodeMaterial";
  67359. /**
  67360. * Block used to get the view direction
  67361. */
  67362. export class ViewDirectionBlock extends NodeMaterialBlock {
  67363. /**
  67364. * Creates a new ViewDirectionBlock
  67365. * @param name defines the block name
  67366. */
  67367. constructor(name: string);
  67368. /**
  67369. * Gets the current class name
  67370. * @returns the class name
  67371. */
  67372. getClassName(): string;
  67373. /**
  67374. * Gets the world position component
  67375. */
  67376. get worldPosition(): NodeMaterialConnectionPoint;
  67377. /**
  67378. * Gets the camera position component
  67379. */
  67380. get cameraPosition(): NodeMaterialConnectionPoint;
  67381. /**
  67382. * Gets the output component
  67383. */
  67384. get output(): NodeMaterialConnectionPoint;
  67385. autoConfigure(material: NodeMaterial): void;
  67386. protected _buildBlock(state: NodeMaterialBuildState): this;
  67387. }
  67388. }
  67389. declare module "babylonjs/Materials/Node/Blocks/fresnelBlock" {
  67390. import { NodeMaterialBlock } from "babylonjs/Materials/Node/nodeMaterialBlock";
  67391. import { NodeMaterialBuildState } from "babylonjs/Materials/Node/nodeMaterialBuildState";
  67392. import { NodeMaterialConnectionPoint } from "babylonjs/Materials/Node/nodeMaterialBlockConnectionPoint";
  67393. import { NodeMaterial } from "babylonjs/Materials/Node/nodeMaterial";
  67394. import "babylonjs/Shaders/ShadersInclude/fresnelFunction";
  67395. /**
  67396. * Block used to compute fresnel value
  67397. */
  67398. export class FresnelBlock extends NodeMaterialBlock {
  67399. /**
  67400. * Create a new FresnelBlock
  67401. * @param name defines the block name
  67402. */
  67403. constructor(name: string);
  67404. /**
  67405. * Gets the current class name
  67406. * @returns the class name
  67407. */
  67408. getClassName(): string;
  67409. /**
  67410. * Gets the world normal input component
  67411. */
  67412. get worldNormal(): NodeMaterialConnectionPoint;
  67413. /**
  67414. * Gets the view direction input component
  67415. */
  67416. get viewDirection(): NodeMaterialConnectionPoint;
  67417. /**
  67418. * Gets the bias input component
  67419. */
  67420. get bias(): NodeMaterialConnectionPoint;
  67421. /**
  67422. * Gets the camera (or eye) position component
  67423. */
  67424. get power(): NodeMaterialConnectionPoint;
  67425. /**
  67426. * Gets the fresnel output component
  67427. */
  67428. get fresnel(): NodeMaterialConnectionPoint;
  67429. autoConfigure(material: NodeMaterial): void;
  67430. protected _buildBlock(state: NodeMaterialBuildState): this;
  67431. }
  67432. }
  67433. declare module "babylonjs/Materials/Node/Blocks/maxBlock" {
  67434. import { NodeMaterialBlock } from "babylonjs/Materials/Node/nodeMaterialBlock";
  67435. import { NodeMaterialBuildState } from "babylonjs/Materials/Node/nodeMaterialBuildState";
  67436. import { NodeMaterialConnectionPoint } from "babylonjs/Materials/Node/nodeMaterialBlockConnectionPoint";
  67437. /**
  67438. * Block used to get the max of 2 values
  67439. */
  67440. export class MaxBlock extends NodeMaterialBlock {
  67441. /**
  67442. * Creates a new MaxBlock
  67443. * @param name defines the block name
  67444. */
  67445. constructor(name: string);
  67446. /**
  67447. * Gets the current class name
  67448. * @returns the class name
  67449. */
  67450. getClassName(): string;
  67451. /**
  67452. * Gets the left operand input component
  67453. */
  67454. get left(): NodeMaterialConnectionPoint;
  67455. /**
  67456. * Gets the right operand input component
  67457. */
  67458. get right(): NodeMaterialConnectionPoint;
  67459. /**
  67460. * Gets the output component
  67461. */
  67462. get output(): NodeMaterialConnectionPoint;
  67463. protected _buildBlock(state: NodeMaterialBuildState): this;
  67464. }
  67465. }
  67466. declare module "babylonjs/Materials/Node/Blocks/minBlock" {
  67467. import { NodeMaterialBlock } from "babylonjs/Materials/Node/nodeMaterialBlock";
  67468. import { NodeMaterialBuildState } from "babylonjs/Materials/Node/nodeMaterialBuildState";
  67469. import { NodeMaterialConnectionPoint } from "babylonjs/Materials/Node/nodeMaterialBlockConnectionPoint";
  67470. /**
  67471. * Block used to get the min of 2 values
  67472. */
  67473. export class MinBlock extends NodeMaterialBlock {
  67474. /**
  67475. * Creates a new MinBlock
  67476. * @param name defines the block name
  67477. */
  67478. constructor(name: string);
  67479. /**
  67480. * Gets the current class name
  67481. * @returns the class name
  67482. */
  67483. getClassName(): string;
  67484. /**
  67485. * Gets the left operand input component
  67486. */
  67487. get left(): NodeMaterialConnectionPoint;
  67488. /**
  67489. * Gets the right operand input component
  67490. */
  67491. get right(): NodeMaterialConnectionPoint;
  67492. /**
  67493. * Gets the output component
  67494. */
  67495. get output(): NodeMaterialConnectionPoint;
  67496. protected _buildBlock(state: NodeMaterialBuildState): this;
  67497. }
  67498. }
  67499. declare module "babylonjs/Materials/Node/Blocks/distanceBlock" {
  67500. import { NodeMaterialBlock } from "babylonjs/Materials/Node/nodeMaterialBlock";
  67501. import { NodeMaterialBuildState } from "babylonjs/Materials/Node/nodeMaterialBuildState";
  67502. import { NodeMaterialConnectionPoint } from "babylonjs/Materials/Node/nodeMaterialBlockConnectionPoint";
  67503. /**
  67504. * Block used to get the distance between 2 values
  67505. */
  67506. export class DistanceBlock extends NodeMaterialBlock {
  67507. /**
  67508. * Creates a new DistanceBlock
  67509. * @param name defines the block name
  67510. */
  67511. constructor(name: string);
  67512. /**
  67513. * Gets the current class name
  67514. * @returns the class name
  67515. */
  67516. getClassName(): string;
  67517. /**
  67518. * Gets the left operand input component
  67519. */
  67520. get left(): NodeMaterialConnectionPoint;
  67521. /**
  67522. * Gets the right operand input component
  67523. */
  67524. get right(): NodeMaterialConnectionPoint;
  67525. /**
  67526. * Gets the output component
  67527. */
  67528. get output(): NodeMaterialConnectionPoint;
  67529. protected _buildBlock(state: NodeMaterialBuildState): this;
  67530. }
  67531. }
  67532. declare module "babylonjs/Materials/Node/Blocks/lengthBlock" {
  67533. import { NodeMaterialBlock } from "babylonjs/Materials/Node/nodeMaterialBlock";
  67534. import { NodeMaterialBuildState } from "babylonjs/Materials/Node/nodeMaterialBuildState";
  67535. import { NodeMaterialConnectionPoint } from "babylonjs/Materials/Node/nodeMaterialBlockConnectionPoint";
  67536. /**
  67537. * Block used to get the length of a vector
  67538. */
  67539. export class LengthBlock extends NodeMaterialBlock {
  67540. /**
  67541. * Creates a new LengthBlock
  67542. * @param name defines the block name
  67543. */
  67544. constructor(name: string);
  67545. /**
  67546. * Gets the current class name
  67547. * @returns the class name
  67548. */
  67549. getClassName(): string;
  67550. /**
  67551. * Gets the value input component
  67552. */
  67553. get value(): NodeMaterialConnectionPoint;
  67554. /**
  67555. * Gets the output component
  67556. */
  67557. get output(): NodeMaterialConnectionPoint;
  67558. protected _buildBlock(state: NodeMaterialBuildState): this;
  67559. }
  67560. }
  67561. declare module "babylonjs/Materials/Node/Blocks/negateBlock" {
  67562. import { NodeMaterialBlock } from "babylonjs/Materials/Node/nodeMaterialBlock";
  67563. import { NodeMaterialBuildState } from "babylonjs/Materials/Node/nodeMaterialBuildState";
  67564. import { NodeMaterialConnectionPoint } from "babylonjs/Materials/Node/nodeMaterialBlockConnectionPoint";
  67565. /**
  67566. * Block used to get negative version of a value (i.e. x * -1)
  67567. */
  67568. export class NegateBlock extends NodeMaterialBlock {
  67569. /**
  67570. * Creates a new NegateBlock
  67571. * @param name defines the block name
  67572. */
  67573. constructor(name: string);
  67574. /**
  67575. * Gets the current class name
  67576. * @returns the class name
  67577. */
  67578. getClassName(): string;
  67579. /**
  67580. * Gets the value input component
  67581. */
  67582. get value(): NodeMaterialConnectionPoint;
  67583. /**
  67584. * Gets the output component
  67585. */
  67586. get output(): NodeMaterialConnectionPoint;
  67587. protected _buildBlock(state: NodeMaterialBuildState): this;
  67588. }
  67589. }
  67590. declare module "babylonjs/Materials/Node/Blocks/powBlock" {
  67591. import { NodeMaterialBlock } from "babylonjs/Materials/Node/nodeMaterialBlock";
  67592. import { NodeMaterialBuildState } from "babylonjs/Materials/Node/nodeMaterialBuildState";
  67593. import { NodeMaterialConnectionPoint } from "babylonjs/Materials/Node/nodeMaterialBlockConnectionPoint";
  67594. /**
  67595. * Block used to get the value of the first parameter raised to the power of the second
  67596. */
  67597. export class PowBlock extends NodeMaterialBlock {
  67598. /**
  67599. * Creates a new PowBlock
  67600. * @param name defines the block name
  67601. */
  67602. constructor(name: string);
  67603. /**
  67604. * Gets the current class name
  67605. * @returns the class name
  67606. */
  67607. getClassName(): string;
  67608. /**
  67609. * Gets the value operand input component
  67610. */
  67611. get value(): NodeMaterialConnectionPoint;
  67612. /**
  67613. * Gets the power operand input component
  67614. */
  67615. get power(): NodeMaterialConnectionPoint;
  67616. /**
  67617. * Gets the output component
  67618. */
  67619. get output(): NodeMaterialConnectionPoint;
  67620. protected _buildBlock(state: NodeMaterialBuildState): this;
  67621. }
  67622. }
  67623. declare module "babylonjs/Materials/Node/Blocks/randomNumberBlock" {
  67624. import { NodeMaterialBlock } from "babylonjs/Materials/Node/nodeMaterialBlock";
  67625. import { NodeMaterialBuildState } from "babylonjs/Materials/Node/nodeMaterialBuildState";
  67626. import { NodeMaterialConnectionPoint } from "babylonjs/Materials/Node/nodeMaterialBlockConnectionPoint";
  67627. import "babylonjs/Shaders/ShadersInclude/helperFunctions";
  67628. /**
  67629. * Block used to get a random number
  67630. */
  67631. export class RandomNumberBlock extends NodeMaterialBlock {
  67632. /**
  67633. * Creates a new RandomNumberBlock
  67634. * @param name defines the block name
  67635. */
  67636. constructor(name: string);
  67637. /**
  67638. * Gets the current class name
  67639. * @returns the class name
  67640. */
  67641. getClassName(): string;
  67642. /**
  67643. * Gets the seed input component
  67644. */
  67645. get seed(): NodeMaterialConnectionPoint;
  67646. /**
  67647. * Gets the output component
  67648. */
  67649. get output(): NodeMaterialConnectionPoint;
  67650. protected _buildBlock(state: NodeMaterialBuildState): this;
  67651. }
  67652. }
  67653. declare module "babylonjs/Materials/Node/Blocks/arcTan2Block" {
  67654. import { NodeMaterialBlock } from "babylonjs/Materials/Node/nodeMaterialBlock";
  67655. import { NodeMaterialBuildState } from "babylonjs/Materials/Node/nodeMaterialBuildState";
  67656. import { NodeMaterialConnectionPoint } from "babylonjs/Materials/Node/nodeMaterialBlockConnectionPoint";
  67657. /**
  67658. * Block used to compute arc tangent of 2 values
  67659. */
  67660. export class ArcTan2Block extends NodeMaterialBlock {
  67661. /**
  67662. * Creates a new ArcTan2Block
  67663. * @param name defines the block name
  67664. */
  67665. constructor(name: string);
  67666. /**
  67667. * Gets the current class name
  67668. * @returns the class name
  67669. */
  67670. getClassName(): string;
  67671. /**
  67672. * Gets the x operand input component
  67673. */
  67674. get x(): NodeMaterialConnectionPoint;
  67675. /**
  67676. * Gets the y operand input component
  67677. */
  67678. get y(): NodeMaterialConnectionPoint;
  67679. /**
  67680. * Gets the output component
  67681. */
  67682. get output(): NodeMaterialConnectionPoint;
  67683. protected _buildBlock(state: NodeMaterialBuildState): this;
  67684. }
  67685. }
  67686. declare module "babylonjs/Materials/Node/Blocks/smoothStepBlock" {
  67687. import { NodeMaterialBlock } from "babylonjs/Materials/Node/nodeMaterialBlock";
  67688. import { NodeMaterialBuildState } from "babylonjs/Materials/Node/nodeMaterialBuildState";
  67689. import { NodeMaterialConnectionPoint } from "babylonjs/Materials/Node/nodeMaterialBlockConnectionPoint";
  67690. /**
  67691. * Block used to smooth step a value
  67692. */
  67693. export class SmoothStepBlock extends NodeMaterialBlock {
  67694. /**
  67695. * Creates a new SmoothStepBlock
  67696. * @param name defines the block name
  67697. */
  67698. constructor(name: string);
  67699. /**
  67700. * Gets the current class name
  67701. * @returns the class name
  67702. */
  67703. getClassName(): string;
  67704. /**
  67705. * Gets the value operand input component
  67706. */
  67707. get value(): NodeMaterialConnectionPoint;
  67708. /**
  67709. * Gets the first edge operand input component
  67710. */
  67711. get edge0(): NodeMaterialConnectionPoint;
  67712. /**
  67713. * Gets the second edge operand input component
  67714. */
  67715. get edge1(): NodeMaterialConnectionPoint;
  67716. /**
  67717. * Gets the output component
  67718. */
  67719. get output(): NodeMaterialConnectionPoint;
  67720. protected _buildBlock(state: NodeMaterialBuildState): this;
  67721. }
  67722. }
  67723. declare module "babylonjs/Materials/Node/Blocks/reciprocalBlock" {
  67724. import { NodeMaterialBlock } from "babylonjs/Materials/Node/nodeMaterialBlock";
  67725. import { NodeMaterialBuildState } from "babylonjs/Materials/Node/nodeMaterialBuildState";
  67726. import { NodeMaterialConnectionPoint } from "babylonjs/Materials/Node/nodeMaterialBlockConnectionPoint";
  67727. /**
  67728. * Block used to get the reciprocal (1 / x) of a value
  67729. */
  67730. export class ReciprocalBlock extends NodeMaterialBlock {
  67731. /**
  67732. * Creates a new ReciprocalBlock
  67733. * @param name defines the block name
  67734. */
  67735. constructor(name: string);
  67736. /**
  67737. * Gets the current class name
  67738. * @returns the class name
  67739. */
  67740. getClassName(): string;
  67741. /**
  67742. * Gets the input component
  67743. */
  67744. get input(): NodeMaterialConnectionPoint;
  67745. /**
  67746. * Gets the output component
  67747. */
  67748. get output(): NodeMaterialConnectionPoint;
  67749. protected _buildBlock(state: NodeMaterialBuildState): this;
  67750. }
  67751. }
  67752. declare module "babylonjs/Materials/Node/Blocks/replaceColorBlock" {
  67753. import { NodeMaterialBlock } from "babylonjs/Materials/Node/nodeMaterialBlock";
  67754. import { NodeMaterialBuildState } from "babylonjs/Materials/Node/nodeMaterialBuildState";
  67755. import { NodeMaterialConnectionPoint } from "babylonjs/Materials/Node/nodeMaterialBlockConnectionPoint";
  67756. /**
  67757. * Block used to replace a color by another one
  67758. */
  67759. export class ReplaceColorBlock extends NodeMaterialBlock {
  67760. /**
  67761. * Creates a new ReplaceColorBlock
  67762. * @param name defines the block name
  67763. */
  67764. constructor(name: string);
  67765. /**
  67766. * Gets the current class name
  67767. * @returns the class name
  67768. */
  67769. getClassName(): string;
  67770. /**
  67771. * Gets the value input component
  67772. */
  67773. get value(): NodeMaterialConnectionPoint;
  67774. /**
  67775. * Gets the reference input component
  67776. */
  67777. get reference(): NodeMaterialConnectionPoint;
  67778. /**
  67779. * Gets the distance input component
  67780. */
  67781. get distance(): NodeMaterialConnectionPoint;
  67782. /**
  67783. * Gets the replacement input component
  67784. */
  67785. get replacement(): NodeMaterialConnectionPoint;
  67786. /**
  67787. * Gets the output component
  67788. */
  67789. get output(): NodeMaterialConnectionPoint;
  67790. protected _buildBlock(state: NodeMaterialBuildState): this;
  67791. }
  67792. }
  67793. declare module "babylonjs/Materials/Node/Blocks/posterizeBlock" {
  67794. import { NodeMaterialBlock } from "babylonjs/Materials/Node/nodeMaterialBlock";
  67795. import { NodeMaterialBuildState } from "babylonjs/Materials/Node/nodeMaterialBuildState";
  67796. import { NodeMaterialConnectionPoint } from "babylonjs/Materials/Node/nodeMaterialBlockConnectionPoint";
  67797. /**
  67798. * Block used to posterize a value
  67799. * @see https://en.wikipedia.org/wiki/Posterization
  67800. */
  67801. export class PosterizeBlock extends NodeMaterialBlock {
  67802. /**
  67803. * Creates a new PosterizeBlock
  67804. * @param name defines the block name
  67805. */
  67806. constructor(name: string);
  67807. /**
  67808. * Gets the current class name
  67809. * @returns the class name
  67810. */
  67811. getClassName(): string;
  67812. /**
  67813. * Gets the value input component
  67814. */
  67815. get value(): NodeMaterialConnectionPoint;
  67816. /**
  67817. * Gets the steps input component
  67818. */
  67819. get steps(): NodeMaterialConnectionPoint;
  67820. /**
  67821. * Gets the output component
  67822. */
  67823. get output(): NodeMaterialConnectionPoint;
  67824. protected _buildBlock(state: NodeMaterialBuildState): this;
  67825. }
  67826. }
  67827. declare module "babylonjs/Materials/Node/Blocks/waveBlock" {
  67828. import { NodeMaterialBlock } from "babylonjs/Materials/Node/nodeMaterialBlock";
  67829. import { NodeMaterialBuildState } from "babylonjs/Materials/Node/nodeMaterialBuildState";
  67830. import { NodeMaterialConnectionPoint } from "babylonjs/Materials/Node/nodeMaterialBlockConnectionPoint";
  67831. import { Scene } from "babylonjs/scene";
  67832. /**
  67833. * Operations supported by the Wave block
  67834. */
  67835. export enum WaveBlockKind {
  67836. /** SawTooth */
  67837. SawTooth = 0,
  67838. /** Square */
  67839. Square = 1,
  67840. /** Triangle */
  67841. Triangle = 2
  67842. }
  67843. /**
  67844. * Block used to apply wave operation to floats
  67845. */
  67846. export class WaveBlock extends NodeMaterialBlock {
  67847. /**
  67848. * Gets or sets the kibnd of wave to be applied by the block
  67849. */
  67850. kind: WaveBlockKind;
  67851. /**
  67852. * Creates a new WaveBlock
  67853. * @param name defines the block name
  67854. */
  67855. constructor(name: string);
  67856. /**
  67857. * Gets the current class name
  67858. * @returns the class name
  67859. */
  67860. getClassName(): string;
  67861. /**
  67862. * Gets the input component
  67863. */
  67864. get input(): NodeMaterialConnectionPoint;
  67865. /**
  67866. * Gets the output component
  67867. */
  67868. get output(): NodeMaterialConnectionPoint;
  67869. protected _buildBlock(state: NodeMaterialBuildState): this;
  67870. serialize(): any;
  67871. _deserialize(serializationObject: any, scene: Scene, rootUrl: string): void;
  67872. }
  67873. }
  67874. declare module "babylonjs/Materials/Node/Blocks/gradientBlock" {
  67875. import { NodeMaterialBlock } from "babylonjs/Materials/Node/nodeMaterialBlock";
  67876. import { NodeMaterialBuildState } from "babylonjs/Materials/Node/nodeMaterialBuildState";
  67877. import { NodeMaterialConnectionPoint } from "babylonjs/Materials/Node/nodeMaterialBlockConnectionPoint";
  67878. import { Color3 } from "babylonjs/Maths/math.color";
  67879. import { Scene } from "babylonjs/scene";
  67880. import { Observable } from "babylonjs/Misc/observable";
  67881. /**
  67882. * Class used to store a color step for the GradientBlock
  67883. */
  67884. export class GradientBlockColorStep {
  67885. private _step;
  67886. /**
  67887. * Gets value indicating which step this color is associated with (between 0 and 1)
  67888. */
  67889. get step(): number;
  67890. /**
  67891. * Sets a value indicating which step this color is associated with (between 0 and 1)
  67892. */
  67893. set step(val: number);
  67894. private _color;
  67895. /**
  67896. * Gets the color associated with this step
  67897. */
  67898. get color(): Color3;
  67899. /**
  67900. * Sets the color associated with this step
  67901. */
  67902. set color(val: Color3);
  67903. /**
  67904. * Creates a new GradientBlockColorStep
  67905. * @param step defines a value indicating which step this color is associated with (between 0 and 1)
  67906. * @param color defines the color associated with this step
  67907. */
  67908. constructor(step: number, color: Color3);
  67909. }
  67910. /**
  67911. * Block used to return a color from a gradient based on an input value between 0 and 1
  67912. */
  67913. export class GradientBlock extends NodeMaterialBlock {
  67914. /**
  67915. * Gets or sets the list of color steps
  67916. */
  67917. colorSteps: GradientBlockColorStep[];
  67918. /** Gets an observable raised when the value is changed */
  67919. onValueChangedObservable: Observable<GradientBlock>;
  67920. /** calls observable when the value is changed*/
  67921. colorStepsUpdated(): void;
  67922. /**
  67923. * Creates a new GradientBlock
  67924. * @param name defines the block name
  67925. */
  67926. constructor(name: string);
  67927. /**
  67928. * Gets the current class name
  67929. * @returns the class name
  67930. */
  67931. getClassName(): string;
  67932. /**
  67933. * Gets the gradient input component
  67934. */
  67935. get gradient(): NodeMaterialConnectionPoint;
  67936. /**
  67937. * Gets the output component
  67938. */
  67939. get output(): NodeMaterialConnectionPoint;
  67940. private _writeColorConstant;
  67941. protected _buildBlock(state: NodeMaterialBuildState): this | undefined;
  67942. serialize(): any;
  67943. _deserialize(serializationObject: any, scene: Scene, rootUrl: string): void;
  67944. protected _dumpPropertiesCode(): string;
  67945. }
  67946. }
  67947. declare module "babylonjs/Materials/Node/Blocks/nLerpBlock" {
  67948. import { NodeMaterialBlock } from "babylonjs/Materials/Node/nodeMaterialBlock";
  67949. import { NodeMaterialBuildState } from "babylonjs/Materials/Node/nodeMaterialBuildState";
  67950. import { NodeMaterialConnectionPoint } from "babylonjs/Materials/Node/nodeMaterialBlockConnectionPoint";
  67951. /**
  67952. * Block used to normalize lerp between 2 values
  67953. */
  67954. export class NLerpBlock extends NodeMaterialBlock {
  67955. /**
  67956. * Creates a new NLerpBlock
  67957. * @param name defines the block name
  67958. */
  67959. constructor(name: string);
  67960. /**
  67961. * Gets the current class name
  67962. * @returns the class name
  67963. */
  67964. getClassName(): string;
  67965. /**
  67966. * Gets the left operand input component
  67967. */
  67968. get left(): NodeMaterialConnectionPoint;
  67969. /**
  67970. * Gets the right operand input component
  67971. */
  67972. get right(): NodeMaterialConnectionPoint;
  67973. /**
  67974. * Gets the gradient operand input component
  67975. */
  67976. get gradient(): NodeMaterialConnectionPoint;
  67977. /**
  67978. * Gets the output component
  67979. */
  67980. get output(): NodeMaterialConnectionPoint;
  67981. protected _buildBlock(state: NodeMaterialBuildState): this;
  67982. }
  67983. }
  67984. declare module "babylonjs/Materials/Node/Blocks/worleyNoise3DBlock" {
  67985. import { NodeMaterialBlock } from "babylonjs/Materials/Node/nodeMaterialBlock";
  67986. import { NodeMaterialBuildState } from "babylonjs/Materials/Node/nodeMaterialBuildState";
  67987. import { NodeMaterialConnectionPoint } from "babylonjs/Materials/Node/nodeMaterialBlockConnectionPoint";
  67988. import { Scene } from "babylonjs/scene";
  67989. /**
  67990. * block used to Generate a Worley Noise 3D Noise Pattern
  67991. */
  67992. export class WorleyNoise3DBlock extends NodeMaterialBlock {
  67993. /** Gets or sets a boolean indicating that normal should be inverted on X axis */
  67994. manhattanDistance: boolean;
  67995. /**
  67996. * Creates a new WorleyNoise3DBlock
  67997. * @param name defines the block name
  67998. */
  67999. constructor(name: string);
  68000. /**
  68001. * Gets the current class name
  68002. * @returns the class name
  68003. */
  68004. getClassName(): string;
  68005. /**
  68006. * Gets the seed input component
  68007. */
  68008. get seed(): NodeMaterialConnectionPoint;
  68009. /**
  68010. * Gets the jitter input component
  68011. */
  68012. get jitter(): NodeMaterialConnectionPoint;
  68013. /**
  68014. * Gets the output component
  68015. */
  68016. get output(): NodeMaterialConnectionPoint;
  68017. protected _buildBlock(state: NodeMaterialBuildState): this | undefined;
  68018. /**
  68019. * Exposes the properties to the UI?
  68020. */
  68021. protected _dumpPropertiesCode(): string;
  68022. /**
  68023. * Exposes the properties to the Seralize?
  68024. */
  68025. serialize(): any;
  68026. /**
  68027. * Exposes the properties to the deseralize?
  68028. */
  68029. _deserialize(serializationObject: any, scene: Scene, rootUrl: string): void;
  68030. }
  68031. }
  68032. declare module "babylonjs/Materials/Node/Blocks/simplexPerlin3DBlock" {
  68033. import { NodeMaterialBlock } from "babylonjs/Materials/Node/nodeMaterialBlock";
  68034. import { NodeMaterialBuildState } from "babylonjs/Materials/Node/nodeMaterialBuildState";
  68035. import { NodeMaterialConnectionPoint } from "babylonjs/Materials/Node/nodeMaterialBlockConnectionPoint";
  68036. /**
  68037. * block used to Generate a Simplex Perlin 3d Noise Pattern
  68038. */
  68039. export class SimplexPerlin3DBlock extends NodeMaterialBlock {
  68040. /**
  68041. * Creates a new SimplexPerlin3DBlock
  68042. * @param name defines the block name
  68043. */
  68044. constructor(name: string);
  68045. /**
  68046. * Gets the current class name
  68047. * @returns the class name
  68048. */
  68049. getClassName(): string;
  68050. /**
  68051. * Gets the seed operand input component
  68052. */
  68053. get seed(): NodeMaterialConnectionPoint;
  68054. /**
  68055. * Gets the output component
  68056. */
  68057. get output(): NodeMaterialConnectionPoint;
  68058. protected _buildBlock(state: NodeMaterialBuildState): this | undefined;
  68059. }
  68060. }
  68061. declare module "babylonjs/Materials/Node/Blocks/normalBlendBlock" {
  68062. import { NodeMaterialBlock } from "babylonjs/Materials/Node/nodeMaterialBlock";
  68063. import { NodeMaterialBuildState } from "babylonjs/Materials/Node/nodeMaterialBuildState";
  68064. import { NodeMaterialConnectionPoint } from "babylonjs/Materials/Node/nodeMaterialBlockConnectionPoint";
  68065. /**
  68066. * Block used to blend normals
  68067. */
  68068. export class NormalBlendBlock extends NodeMaterialBlock {
  68069. /**
  68070. * Creates a new NormalBlendBlock
  68071. * @param name defines the block name
  68072. */
  68073. constructor(name: string);
  68074. /**
  68075. * Gets the current class name
  68076. * @returns the class name
  68077. */
  68078. getClassName(): string;
  68079. /**
  68080. * Gets the first input component
  68081. */
  68082. get normalMap0(): NodeMaterialConnectionPoint;
  68083. /**
  68084. * Gets the second input component
  68085. */
  68086. get normalMap1(): NodeMaterialConnectionPoint;
  68087. /**
  68088. * Gets the output component
  68089. */
  68090. get output(): NodeMaterialConnectionPoint;
  68091. protected _buildBlock(state: NodeMaterialBuildState): this;
  68092. }
  68093. }
  68094. declare module "babylonjs/Materials/Node/Blocks/rotate2dBlock" {
  68095. import { NodeMaterialBlock } from "babylonjs/Materials/Node/nodeMaterialBlock";
  68096. import { NodeMaterialBuildState } from "babylonjs/Materials/Node/nodeMaterialBuildState";
  68097. import { NodeMaterialConnectionPoint } from "babylonjs/Materials/Node/nodeMaterialBlockConnectionPoint";
  68098. import { NodeMaterial } from "babylonjs/Materials/Node/nodeMaterial";
  68099. /**
  68100. * Block used to rotate a 2d vector by a given angle
  68101. */
  68102. export class Rotate2dBlock extends NodeMaterialBlock {
  68103. /**
  68104. * Creates a new Rotate2dBlock
  68105. * @param name defines the block name
  68106. */
  68107. constructor(name: string);
  68108. /**
  68109. * Gets the current class name
  68110. * @returns the class name
  68111. */
  68112. getClassName(): string;
  68113. /**
  68114. * Gets the input vector
  68115. */
  68116. get input(): NodeMaterialConnectionPoint;
  68117. /**
  68118. * Gets the input angle
  68119. */
  68120. get angle(): NodeMaterialConnectionPoint;
  68121. /**
  68122. * Gets the output component
  68123. */
  68124. get output(): NodeMaterialConnectionPoint;
  68125. autoConfigure(material: NodeMaterial): void;
  68126. protected _buildBlock(state: NodeMaterialBuildState): this;
  68127. }
  68128. }
  68129. declare module "babylonjs/Materials/Node/Blocks/reflectBlock" {
  68130. import { NodeMaterialBlock } from "babylonjs/Materials/Node/nodeMaterialBlock";
  68131. import { NodeMaterialBuildState } from "babylonjs/Materials/Node/nodeMaterialBuildState";
  68132. import { NodeMaterialConnectionPoint } from "babylonjs/Materials/Node/nodeMaterialBlockConnectionPoint";
  68133. /**
  68134. * Block used to get the reflected vector from a direction and a normal
  68135. */
  68136. export class ReflectBlock extends NodeMaterialBlock {
  68137. /**
  68138. * Creates a new ReflectBlock
  68139. * @param name defines the block name
  68140. */
  68141. constructor(name: string);
  68142. /**
  68143. * Gets the current class name
  68144. * @returns the class name
  68145. */
  68146. getClassName(): string;
  68147. /**
  68148. * Gets the incident component
  68149. */
  68150. get incident(): NodeMaterialConnectionPoint;
  68151. /**
  68152. * Gets the normal component
  68153. */
  68154. get normal(): NodeMaterialConnectionPoint;
  68155. /**
  68156. * Gets the output component
  68157. */
  68158. get output(): NodeMaterialConnectionPoint;
  68159. protected _buildBlock(state: NodeMaterialBuildState): this;
  68160. }
  68161. }
  68162. declare module "babylonjs/Materials/Node/Blocks/refractBlock" {
  68163. import { NodeMaterialBlock } from "babylonjs/Materials/Node/nodeMaterialBlock";
  68164. import { NodeMaterialBuildState } from "babylonjs/Materials/Node/nodeMaterialBuildState";
  68165. import { NodeMaterialConnectionPoint } from "babylonjs/Materials/Node/nodeMaterialBlockConnectionPoint";
  68166. /**
  68167. * Block used to get the refracted vector from a direction and a normal
  68168. */
  68169. export class RefractBlock extends NodeMaterialBlock {
  68170. /**
  68171. * Creates a new RefractBlock
  68172. * @param name defines the block name
  68173. */
  68174. constructor(name: string);
  68175. /**
  68176. * Gets the current class name
  68177. * @returns the class name
  68178. */
  68179. getClassName(): string;
  68180. /**
  68181. * Gets the incident component
  68182. */
  68183. get incident(): NodeMaterialConnectionPoint;
  68184. /**
  68185. * Gets the normal component
  68186. */
  68187. get normal(): NodeMaterialConnectionPoint;
  68188. /**
  68189. * Gets the index of refraction component
  68190. */
  68191. get ior(): NodeMaterialConnectionPoint;
  68192. /**
  68193. * Gets the output component
  68194. */
  68195. get output(): NodeMaterialConnectionPoint;
  68196. protected _buildBlock(state: NodeMaterialBuildState): this;
  68197. }
  68198. }
  68199. declare module "babylonjs/Materials/Node/Blocks/desaturateBlock" {
  68200. import { NodeMaterialBlock } from "babylonjs/Materials/Node/nodeMaterialBlock";
  68201. import { NodeMaterialBuildState } from "babylonjs/Materials/Node/nodeMaterialBuildState";
  68202. import { NodeMaterialConnectionPoint } from "babylonjs/Materials/Node/nodeMaterialBlockConnectionPoint";
  68203. /**
  68204. * Block used to desaturate a color
  68205. */
  68206. export class DesaturateBlock extends NodeMaterialBlock {
  68207. /**
  68208. * Creates a new DesaturateBlock
  68209. * @param name defines the block name
  68210. */
  68211. constructor(name: string);
  68212. /**
  68213. * Gets the current class name
  68214. * @returns the class name
  68215. */
  68216. getClassName(): string;
  68217. /**
  68218. * Gets the color operand input component
  68219. */
  68220. get color(): NodeMaterialConnectionPoint;
  68221. /**
  68222. * Gets the level operand input component
  68223. */
  68224. get level(): NodeMaterialConnectionPoint;
  68225. /**
  68226. * Gets the output component
  68227. */
  68228. get output(): NodeMaterialConnectionPoint;
  68229. protected _buildBlock(state: NodeMaterialBuildState): this;
  68230. }
  68231. }
  68232. declare module "babylonjs/Materials/Node/Blocks/PBR/ambientOcclusionBlock" {
  68233. import { NodeMaterialBlock } from "babylonjs/Materials/Node/nodeMaterialBlock";
  68234. import { NodeMaterialBuildState } from "babylonjs/Materials/Node/nodeMaterialBuildState";
  68235. import { NodeMaterialConnectionPoint } from "babylonjs/Materials/Node/nodeMaterialBlockConnectionPoint";
  68236. import { NodeMaterial, NodeMaterialDefines } from "babylonjs/Materials/Node/nodeMaterial";
  68237. import { Nullable } from "babylonjs/types";
  68238. import { AbstractMesh } from "babylonjs/Meshes/abstractMesh";
  68239. import { Scene } from "babylonjs/scene";
  68240. /**
  68241. * Block used to implement the ambient occlusion module of the PBR material
  68242. */
  68243. export class AmbientOcclusionBlock extends NodeMaterialBlock {
  68244. /**
  68245. * Create a new AmbientOcclusionBlock
  68246. * @param name defines the block name
  68247. */
  68248. constructor(name: string);
  68249. /**
  68250. * Specifies if the ambient texture contains the ambient occlusion information in its red channel only.
  68251. */
  68252. useAmbientInGrayScale: boolean;
  68253. /**
  68254. * Initialize the block and prepare the context for build
  68255. * @param state defines the state that will be used for the build
  68256. */
  68257. initialize(state: NodeMaterialBuildState): void;
  68258. /**
  68259. * Gets the current class name
  68260. * @returns the class name
  68261. */
  68262. getClassName(): string;
  68263. /**
  68264. * Gets the texture input component
  68265. */
  68266. get texture(): NodeMaterialConnectionPoint;
  68267. /**
  68268. * Gets the texture intensity component
  68269. */
  68270. get intensity(): NodeMaterialConnectionPoint;
  68271. /**
  68272. * Gets the direct light intensity input component
  68273. */
  68274. get directLightIntensity(): NodeMaterialConnectionPoint;
  68275. /**
  68276. * Gets the ambient occlusion object output component
  68277. */
  68278. get ambientOcc(): NodeMaterialConnectionPoint;
  68279. /**
  68280. * Gets the main code of the block (fragment side)
  68281. * @param block instance of an AmbientOcclusionBlock or null if the code must be generated without an active ambient occlusion module
  68282. * @returns the shader code
  68283. */
  68284. static GetCode(block: Nullable<AmbientOcclusionBlock>): string;
  68285. prepareDefines(mesh: AbstractMesh, nodeMaterial: NodeMaterial, defines: NodeMaterialDefines): void;
  68286. protected _buildBlock(state: NodeMaterialBuildState): this;
  68287. protected _dumpPropertiesCode(): string;
  68288. serialize(): any;
  68289. _deserialize(serializationObject: any, scene: Scene, rootUrl: string): void;
  68290. }
  68291. }
  68292. declare module "babylonjs/Materials/Node/Blocks/PBR/reflectionBlock" {
  68293. import { NodeMaterialBuildState } from "babylonjs/Materials/Node/nodeMaterialBuildState";
  68294. import { NodeMaterialConnectionPoint } from "babylonjs/Materials/Node/nodeMaterialBlockConnectionPoint";
  68295. import { NodeMaterial, NodeMaterialDefines } from "babylonjs/Materials/Node/nodeMaterial";
  68296. import { ReflectionTextureBaseBlock } from "babylonjs/Materials/Node/Blocks/Dual/reflectionTextureBaseBlock";
  68297. import { AbstractMesh } from "babylonjs/Meshes/abstractMesh";
  68298. import { Nullable } from "babylonjs/types";
  68299. import { BaseTexture } from "babylonjs/Materials/Textures/baseTexture";
  68300. import { Mesh } from "babylonjs/Meshes/mesh";
  68301. import { SubMesh } from "babylonjs/Meshes/subMesh";
  68302. import { Effect } from "babylonjs/Materials/effect";
  68303. import { Scene } from "babylonjs/scene";
  68304. /**
  68305. * Block used to implement the reflection module of the PBR material
  68306. */
  68307. export class ReflectionBlock extends ReflectionTextureBaseBlock {
  68308. /** @hidden */
  68309. _defineLODReflectionAlpha: string;
  68310. /** @hidden */
  68311. _defineLinearSpecularReflection: string;
  68312. private _vEnvironmentIrradianceName;
  68313. /** @hidden */
  68314. _vReflectionMicrosurfaceInfosName: string;
  68315. /** @hidden */
  68316. _vReflectionInfosName: string;
  68317. /** @hidden */
  68318. _vReflectionFilteringInfoName: string;
  68319. private _scene;
  68320. /**
  68321. * The three properties below are set by the main PBR block prior to calling methods of this class.
  68322. * This is to avoid having to add them as inputs here whereas they are already inputs of the main block, so already known.
  68323. * It's less burden on the user side in the editor part.
  68324. */
  68325. /** @hidden */
  68326. worldPositionConnectionPoint: NodeMaterialConnectionPoint;
  68327. /** @hidden */
  68328. worldNormalConnectionPoint: NodeMaterialConnectionPoint;
  68329. /** @hidden */
  68330. cameraPositionConnectionPoint: NodeMaterialConnectionPoint;
  68331. /**
  68332. * Defines if the material uses spherical harmonics vs spherical polynomials for the
  68333. * diffuse part of the IBL.
  68334. */
  68335. useSphericalHarmonics: boolean;
  68336. /**
  68337. * Force the shader to compute irradiance in the fragment shader in order to take bump in account.
  68338. */
  68339. forceIrradianceInFragment: boolean;
  68340. /**
  68341. * Create a new ReflectionBlock
  68342. * @param name defines the block name
  68343. */
  68344. constructor(name: string);
  68345. /**
  68346. * Gets the current class name
  68347. * @returns the class name
  68348. */
  68349. getClassName(): string;
  68350. /**
  68351. * Gets the position input component
  68352. */
  68353. get position(): NodeMaterialConnectionPoint;
  68354. /**
  68355. * Gets the world position input component
  68356. */
  68357. get worldPosition(): NodeMaterialConnectionPoint;
  68358. /**
  68359. * Gets the world normal input component
  68360. */
  68361. get worldNormal(): NodeMaterialConnectionPoint;
  68362. /**
  68363. * Gets the world input component
  68364. */
  68365. get world(): NodeMaterialConnectionPoint;
  68366. /**
  68367. * Gets the camera (or eye) position component
  68368. */
  68369. get cameraPosition(): NodeMaterialConnectionPoint;
  68370. /**
  68371. * Gets the view input component
  68372. */
  68373. get view(): NodeMaterialConnectionPoint;
  68374. /**
  68375. * Gets the color input component
  68376. */
  68377. get color(): NodeMaterialConnectionPoint;
  68378. /**
  68379. * Gets the reflection object output component
  68380. */
  68381. get reflection(): NodeMaterialConnectionPoint;
  68382. /**
  68383. * Returns true if the block has a texture (either its own texture or the environment texture from the scene, if set)
  68384. */
  68385. get hasTexture(): boolean;
  68386. /**
  68387. * Gets the reflection color (either the name of the variable if the color input is connected, else a default value)
  68388. */
  68389. get reflectionColor(): string;
  68390. protected _getTexture(): Nullable<BaseTexture>;
  68391. prepareDefines(mesh: AbstractMesh, nodeMaterial: NodeMaterial, defines: NodeMaterialDefines): void;
  68392. bind(effect: Effect, nodeMaterial: NodeMaterial, mesh?: Mesh, subMesh?: SubMesh): void;
  68393. /**
  68394. * Gets the code to inject in the vertex shader
  68395. * @param state current state of the node material building
  68396. * @returns the shader code
  68397. */
  68398. handleVertexSide(state: NodeMaterialBuildState): string;
  68399. /**
  68400. * Gets the main code of the block (fragment side)
  68401. * @param state current state of the node material building
  68402. * @param normalVarName name of the existing variable corresponding to the normal
  68403. * @returns the shader code
  68404. */
  68405. getCode(state: NodeMaterialBuildState, normalVarName: string): string;
  68406. protected _buildBlock(state: NodeMaterialBuildState): this;
  68407. protected _dumpPropertiesCode(): string;
  68408. serialize(): any;
  68409. _deserialize(serializationObject: any, scene: Scene, rootUrl: string): void;
  68410. }
  68411. }
  68412. declare module "babylonjs/Materials/Node/Blocks/PBR/sheenBlock" {
  68413. import { NodeMaterialBlock } from "babylonjs/Materials/Node/nodeMaterialBlock";
  68414. import { NodeMaterialBuildState } from "babylonjs/Materials/Node/nodeMaterialBuildState";
  68415. import { NodeMaterialConnectionPoint } from "babylonjs/Materials/Node/nodeMaterialBlockConnectionPoint";
  68416. import { NodeMaterial, NodeMaterialDefines } from "babylonjs/Materials/Node/nodeMaterial";
  68417. import { AbstractMesh } from "babylonjs/Meshes/abstractMesh";
  68418. import { ReflectionBlock } from "babylonjs/Materials/Node/Blocks/PBR/reflectionBlock";
  68419. import { Scene } from "babylonjs/scene";
  68420. import { Nullable } from "babylonjs/types";
  68421. /**
  68422. * Block used to implement the sheen module of the PBR material
  68423. */
  68424. export class SheenBlock extends NodeMaterialBlock {
  68425. /**
  68426. * Create a new SheenBlock
  68427. * @param name defines the block name
  68428. */
  68429. constructor(name: string);
  68430. /**
  68431. * If true, the sheen effect is layered above the base BRDF with the albedo-scaling technique.
  68432. * It allows the strength of the sheen effect to not depend on the base color of the material,
  68433. * making it easier to setup and tweak the effect
  68434. */
  68435. albedoScaling: boolean;
  68436. /**
  68437. * Defines if the sheen is linked to the sheen color.
  68438. */
  68439. linkSheenWithAlbedo: boolean;
  68440. /**
  68441. * Initialize the block and prepare the context for build
  68442. * @param state defines the state that will be used for the build
  68443. */
  68444. initialize(state: NodeMaterialBuildState): void;
  68445. /**
  68446. * Gets the current class name
  68447. * @returns the class name
  68448. */
  68449. getClassName(): string;
  68450. /**
  68451. * Gets the intensity input component
  68452. */
  68453. get intensity(): NodeMaterialConnectionPoint;
  68454. /**
  68455. * Gets the color input component
  68456. */
  68457. get color(): NodeMaterialConnectionPoint;
  68458. /**
  68459. * Gets the roughness input component
  68460. */
  68461. get roughness(): NodeMaterialConnectionPoint;
  68462. /**
  68463. * Gets the sheen object output component
  68464. */
  68465. get sheen(): NodeMaterialConnectionPoint;
  68466. prepareDefines(mesh: AbstractMesh, nodeMaterial: NodeMaterial, defines: NodeMaterialDefines): void;
  68467. /**
  68468. * Gets the main code of the block (fragment side)
  68469. * @param reflectionBlock instance of a ReflectionBlock null if the code must be generated without an active reflection module
  68470. * @returns the shader code
  68471. */
  68472. getCode(reflectionBlock: Nullable<ReflectionBlock>): string;
  68473. protected _buildBlock(state: NodeMaterialBuildState): this;
  68474. protected _dumpPropertiesCode(): string;
  68475. serialize(): any;
  68476. _deserialize(serializationObject: any, scene: Scene, rootUrl: string): void;
  68477. }
  68478. }
  68479. declare module "babylonjs/Materials/Node/Blocks/PBR/reflectivityBlock" {
  68480. import { NodeMaterial, NodeMaterialDefines } from "babylonjs/Materials/Node/nodeMaterial";
  68481. import { NodeMaterialBuildState } from "babylonjs/Materials/Node/nodeMaterialBuildState";
  68482. import { NodeMaterialBlock } from "babylonjs/Materials/Node/nodeMaterialBlock";
  68483. import { AbstractMesh } from "babylonjs/Meshes/abstractMesh";
  68484. import { NodeMaterialConnectionPoint } from "babylonjs/Materials/Node/nodeMaterialBlockConnectionPoint";
  68485. import { Scene } from "babylonjs/scene";
  68486. import { Nullable } from "babylonjs/types";
  68487. import { Mesh } from "babylonjs/Meshes/mesh";
  68488. import { SubMesh } from "babylonjs/Meshes/subMesh";
  68489. import { Effect } from "babylonjs/Materials/effect";
  68490. /**
  68491. * Block used to implement the reflectivity module of the PBR material
  68492. */
  68493. export class ReflectivityBlock extends NodeMaterialBlock {
  68494. private _metallicReflectanceColor;
  68495. private _metallicF0Factor;
  68496. /** @hidden */
  68497. _vMetallicReflectanceFactorsName: string;
  68498. /**
  68499. * The property below is set by the main PBR block prior to calling methods of this class.
  68500. */
  68501. /** @hidden */
  68502. indexOfRefractionConnectionPoint: Nullable<NodeMaterialConnectionPoint>;
  68503. /**
  68504. * Specifies if the metallic texture contains the ambient occlusion information in its red channel.
  68505. */
  68506. useAmbientOcclusionFromMetallicTextureRed: boolean;
  68507. /**
  68508. * Specifies if the metallic texture contains the metallness information in its blue channel.
  68509. */
  68510. useMetallnessFromMetallicTextureBlue: boolean;
  68511. /**
  68512. * Specifies if the metallic texture contains the roughness information in its alpha channel.
  68513. */
  68514. useRoughnessFromMetallicTextureAlpha: boolean;
  68515. /**
  68516. * Specifies if the metallic texture contains the roughness information in its green channel.
  68517. */
  68518. useRoughnessFromMetallicTextureGreen: boolean;
  68519. /**
  68520. * Create a new ReflectivityBlock
  68521. * @param name defines the block name
  68522. */
  68523. constructor(name: string);
  68524. /**
  68525. * Initialize the block and prepare the context for build
  68526. * @param state defines the state that will be used for the build
  68527. */
  68528. initialize(state: NodeMaterialBuildState): void;
  68529. /**
  68530. * Gets the current class name
  68531. * @returns the class name
  68532. */
  68533. getClassName(): string;
  68534. /**
  68535. * Gets the metallic input component
  68536. */
  68537. get metallic(): NodeMaterialConnectionPoint;
  68538. /**
  68539. * Gets the roughness input component
  68540. */
  68541. get roughness(): NodeMaterialConnectionPoint;
  68542. /**
  68543. * Gets the texture input component
  68544. */
  68545. get texture(): NodeMaterialConnectionPoint;
  68546. /**
  68547. * Gets the reflectivity object output component
  68548. */
  68549. get reflectivity(): NodeMaterialConnectionPoint;
  68550. bind(effect: Effect, nodeMaterial: NodeMaterial, mesh?: Mesh, subMesh?: SubMesh): void;
  68551. /**
  68552. * Gets the main code of the block (fragment side)
  68553. * @param state current state of the node material building
  68554. * @param aoIntensityVarName name of the variable with the ambient occlusion intensity
  68555. * @returns the shader code
  68556. */
  68557. getCode(state: NodeMaterialBuildState, aoIntensityVarName: string): string;
  68558. prepareDefines(mesh: AbstractMesh, nodeMaterial: NodeMaterial, defines: NodeMaterialDefines): void;
  68559. protected _buildBlock(state: NodeMaterialBuildState): this;
  68560. protected _dumpPropertiesCode(): string;
  68561. serialize(): any;
  68562. _deserialize(serializationObject: any, scene: Scene, rootUrl: string): void;
  68563. }
  68564. }
  68565. declare module "babylonjs/Materials/Node/Blocks/PBR/anisotropyBlock" {
  68566. import { NodeMaterial, NodeMaterialDefines } from "babylonjs/Materials/Node/nodeMaterial";
  68567. import { NodeMaterialBlock } from "babylonjs/Materials/Node/nodeMaterialBlock";
  68568. import { NodeMaterialBuildState } from "babylonjs/Materials/Node/nodeMaterialBuildState";
  68569. import { NodeMaterialConnectionPoint } from "babylonjs/Materials/Node/nodeMaterialBlockConnectionPoint";
  68570. import { AbstractMesh } from "babylonjs/Meshes/abstractMesh";
  68571. /**
  68572. * Block used to implement the anisotropy module of the PBR material
  68573. */
  68574. export class AnisotropyBlock extends NodeMaterialBlock {
  68575. /**
  68576. * The two properties below are set by the main PBR block prior to calling methods of this class.
  68577. * This is to avoid having to add them as inputs here whereas they are already inputs of the main block, so already known.
  68578. * It's less burden on the user side in the editor part.
  68579. */
  68580. /** @hidden */
  68581. worldPositionConnectionPoint: NodeMaterialConnectionPoint;
  68582. /** @hidden */
  68583. worldNormalConnectionPoint: NodeMaterialConnectionPoint;
  68584. /**
  68585. * Create a new AnisotropyBlock
  68586. * @param name defines the block name
  68587. */
  68588. constructor(name: string);
  68589. /**
  68590. * Initialize the block and prepare the context for build
  68591. * @param state defines the state that will be used for the build
  68592. */
  68593. initialize(state: NodeMaterialBuildState): void;
  68594. /**
  68595. * Gets the current class name
  68596. * @returns the class name
  68597. */
  68598. getClassName(): string;
  68599. /**
  68600. * Gets the intensity input component
  68601. */
  68602. get intensity(): NodeMaterialConnectionPoint;
  68603. /**
  68604. * Gets the direction input component
  68605. */
  68606. get direction(): NodeMaterialConnectionPoint;
  68607. /**
  68608. * Gets the texture input component
  68609. */
  68610. get texture(): NodeMaterialConnectionPoint;
  68611. /**
  68612. * Gets the uv input component
  68613. */
  68614. get uv(): NodeMaterialConnectionPoint;
  68615. /**
  68616. * Gets the worldTangent input component
  68617. */
  68618. get worldTangent(): NodeMaterialConnectionPoint;
  68619. /**
  68620. * Gets the anisotropy object output component
  68621. */
  68622. get anisotropy(): NodeMaterialConnectionPoint;
  68623. private _generateTBNSpace;
  68624. /**
  68625. * Gets the main code of the block (fragment side)
  68626. * @param state current state of the node material building
  68627. * @param generateTBNSpace if true, the code needed to create the TBN coordinate space is generated
  68628. * @returns the shader code
  68629. */
  68630. getCode(state: NodeMaterialBuildState, generateTBNSpace?: boolean): string;
  68631. prepareDefines(mesh: AbstractMesh, nodeMaterial: NodeMaterial, defines: NodeMaterialDefines): void;
  68632. protected _buildBlock(state: NodeMaterialBuildState): this;
  68633. }
  68634. }
  68635. declare module "babylonjs/Materials/Node/Blocks/PBR/clearCoatBlock" {
  68636. import { NodeMaterialBlock } from "babylonjs/Materials/Node/nodeMaterialBlock";
  68637. import { NodeMaterialBuildState } from "babylonjs/Materials/Node/nodeMaterialBuildState";
  68638. import { NodeMaterialConnectionPoint } from "babylonjs/Materials/Node/nodeMaterialBlockConnectionPoint";
  68639. import { NodeMaterial, NodeMaterialDefines } from "babylonjs/Materials/Node/nodeMaterial";
  68640. import { AbstractMesh } from "babylonjs/Meshes/abstractMesh";
  68641. import { ReflectionBlock } from "babylonjs/Materials/Node/Blocks/PBR/reflectionBlock";
  68642. import { Nullable } from "babylonjs/types";
  68643. import { Mesh } from "babylonjs/Meshes/mesh";
  68644. import { SubMesh } from "babylonjs/Meshes/subMesh";
  68645. import { Effect } from "babylonjs/Materials/effect";
  68646. /**
  68647. * Block used to implement the clear coat module of the PBR material
  68648. */
  68649. export class ClearCoatBlock extends NodeMaterialBlock {
  68650. private _scene;
  68651. /**
  68652. * Create a new ClearCoatBlock
  68653. * @param name defines the block name
  68654. */
  68655. constructor(name: string);
  68656. /**
  68657. * Initialize the block and prepare the context for build
  68658. * @param state defines the state that will be used for the build
  68659. */
  68660. initialize(state: NodeMaterialBuildState): void;
  68661. /**
  68662. * Gets the current class name
  68663. * @returns the class name
  68664. */
  68665. getClassName(): string;
  68666. /**
  68667. * Gets the intensity input component
  68668. */
  68669. get intensity(): NodeMaterialConnectionPoint;
  68670. /**
  68671. * Gets the roughness input component
  68672. */
  68673. get roughness(): NodeMaterialConnectionPoint;
  68674. /**
  68675. * Gets the ior input component
  68676. */
  68677. get ior(): NodeMaterialConnectionPoint;
  68678. /**
  68679. * Gets the texture input component
  68680. */
  68681. get texture(): NodeMaterialConnectionPoint;
  68682. /**
  68683. * Gets the bump texture input component
  68684. */
  68685. get bumpTexture(): NodeMaterialConnectionPoint;
  68686. /**
  68687. * Gets the uv input component
  68688. */
  68689. get uv(): NodeMaterialConnectionPoint;
  68690. /**
  68691. * Gets the tint color input component
  68692. */
  68693. get tintColor(): NodeMaterialConnectionPoint;
  68694. /**
  68695. * Gets the tint "at distance" input component
  68696. */
  68697. get tintAtDistance(): NodeMaterialConnectionPoint;
  68698. /**
  68699. * Gets the tint thickness input component
  68700. */
  68701. get tintThickness(): NodeMaterialConnectionPoint;
  68702. /**
  68703. * Gets the world tangent input component
  68704. */
  68705. get worldTangent(): NodeMaterialConnectionPoint;
  68706. /**
  68707. * Gets the clear coat object output component
  68708. */
  68709. get clearcoat(): NodeMaterialConnectionPoint;
  68710. autoConfigure(material: NodeMaterial): void;
  68711. prepareDefines(mesh: AbstractMesh, nodeMaterial: NodeMaterial, defines: NodeMaterialDefines): void;
  68712. bind(effect: Effect, nodeMaterial: NodeMaterial, mesh?: Mesh, subMesh?: SubMesh): void;
  68713. private _generateTBNSpace;
  68714. /**
  68715. * Gets the main code of the block (fragment side)
  68716. * @param state current state of the node material building
  68717. * @param ccBlock instance of a ClearCoatBlock or null if the code must be generated without an active clear coat module
  68718. * @param reflectionBlock instance of a ReflectionBlock null if the code must be generated without an active reflection module
  68719. * @param worldPosVarName name of the variable holding the world position
  68720. * @param generateTBNSpace if true, the code needed to create the TBN coordinate space is generated
  68721. * @param vTBNAvailable indicate that the vTBN variable is already existing because it has already been generated by another block (PerturbNormal or Anisotropy)
  68722. * @param worldNormalVarName name of the variable holding the world normal
  68723. * @returns the shader code
  68724. */
  68725. static GetCode(state: NodeMaterialBuildState, ccBlock: Nullable<ClearCoatBlock>, reflectionBlock: Nullable<ReflectionBlock>, worldPosVarName: string, generateTBNSpace: boolean, vTBNAvailable: boolean, worldNormalVarName: string): string;
  68726. protected _buildBlock(state: NodeMaterialBuildState): this;
  68727. }
  68728. }
  68729. declare module "babylonjs/Materials/Node/Blocks/PBR/subSurfaceBlock" {
  68730. import { NodeMaterialBlock } from "babylonjs/Materials/Node/nodeMaterialBlock";
  68731. import { NodeMaterialBuildState } from "babylonjs/Materials/Node/nodeMaterialBuildState";
  68732. import { NodeMaterialConnectionPoint } from "babylonjs/Materials/Node/nodeMaterialBlockConnectionPoint";
  68733. import { NodeMaterial, NodeMaterialDefines } from "babylonjs/Materials/Node/nodeMaterial";
  68734. import { AbstractMesh } from "babylonjs/Meshes/abstractMesh";
  68735. import { ReflectionBlock } from "babylonjs/Materials/Node/Blocks/PBR/reflectionBlock";
  68736. import { Nullable } from "babylonjs/types";
  68737. /**
  68738. * Block used to implement the sub surface module of the PBR material
  68739. */
  68740. export class SubSurfaceBlock extends NodeMaterialBlock {
  68741. /**
  68742. * Create a new SubSurfaceBlock
  68743. * @param name defines the block name
  68744. */
  68745. constructor(name: string);
  68746. /**
  68747. * Stores the intensity of the different subsurface effects in the thickness texture.
  68748. * * the green channel is the translucency intensity.
  68749. * * the blue channel is the scattering intensity.
  68750. * * the alpha channel is the refraction intensity.
  68751. */
  68752. useMaskFromThicknessTexture: boolean;
  68753. /**
  68754. * Initialize the block and prepare the context for build
  68755. * @param state defines the state that will be used for the build
  68756. */
  68757. initialize(state: NodeMaterialBuildState): void;
  68758. /**
  68759. * Gets the current class name
  68760. * @returns the class name
  68761. */
  68762. getClassName(): string;
  68763. /**
  68764. * Gets the min thickness input component
  68765. */
  68766. get minThickness(): NodeMaterialConnectionPoint;
  68767. /**
  68768. * Gets the max thickness input component
  68769. */
  68770. get maxThickness(): NodeMaterialConnectionPoint;
  68771. /**
  68772. * Gets the thickness texture component
  68773. */
  68774. get thicknessTexture(): NodeMaterialConnectionPoint;
  68775. /**
  68776. * Gets the tint color input component
  68777. */
  68778. get tintColor(): NodeMaterialConnectionPoint;
  68779. /**
  68780. * Gets the translucency intensity input component
  68781. */
  68782. get translucencyIntensity(): NodeMaterialConnectionPoint;
  68783. /**
  68784. * Gets the translucency diffusion distance input component
  68785. */
  68786. get translucencyDiffusionDistance(): NodeMaterialConnectionPoint;
  68787. /**
  68788. * Gets the refraction object parameters
  68789. */
  68790. get refraction(): NodeMaterialConnectionPoint;
  68791. /**
  68792. * Gets the sub surface object output component
  68793. */
  68794. get subsurface(): NodeMaterialConnectionPoint;
  68795. autoConfigure(material: NodeMaterial): void;
  68796. prepareDefines(mesh: AbstractMesh, nodeMaterial: NodeMaterial, defines: NodeMaterialDefines): void;
  68797. /**
  68798. * Gets the main code of the block (fragment side)
  68799. * @param state current state of the node material building
  68800. * @param ssBlock instance of a SubSurfaceBlock or null if the code must be generated without an active sub surface module
  68801. * @param reflectionBlock instance of a ReflectionBlock null if the code must be generated without an active reflection module
  68802. * @param worldPosVarName name of the variable holding the world position
  68803. * @returns the shader code
  68804. */
  68805. static GetCode(state: NodeMaterialBuildState, ssBlock: Nullable<SubSurfaceBlock>, reflectionBlock: Nullable<ReflectionBlock>, worldPosVarName: string): string;
  68806. protected _buildBlock(state: NodeMaterialBuildState): this;
  68807. }
  68808. }
  68809. declare module "babylonjs/Materials/Node/Blocks/PBR/pbrMetallicRoughnessBlock" {
  68810. import { NodeMaterialBlock } from "babylonjs/Materials/Node/nodeMaterialBlock";
  68811. import { NodeMaterialBuildState } from "babylonjs/Materials/Node/nodeMaterialBuildState";
  68812. import { NodeMaterialConnectionPoint } from "babylonjs/Materials/Node/nodeMaterialBlockConnectionPoint";
  68813. import { NodeMaterial, NodeMaterialDefines } from "babylonjs/Materials/Node/nodeMaterial";
  68814. import { Light } from "babylonjs/Lights/light";
  68815. import { Nullable } from "babylonjs/types";
  68816. import { AbstractMesh } from "babylonjs/Meshes/abstractMesh";
  68817. import { Effect } from "babylonjs/Materials/effect";
  68818. import { Mesh } from "babylonjs/Meshes/mesh";
  68819. import { Scene } from "babylonjs/scene";
  68820. /**
  68821. * Block used to implement the PBR metallic/roughness model
  68822. */
  68823. export class PBRMetallicRoughnessBlock extends NodeMaterialBlock {
  68824. /**
  68825. * Gets or sets the light associated with this block
  68826. */
  68827. light: Nullable<Light>;
  68828. private _lightId;
  68829. private _scene;
  68830. private _environmentBRDFTexture;
  68831. private _environmentBrdfSamplerName;
  68832. private _vNormalWName;
  68833. private _invertNormalName;
  68834. /**
  68835. * Create a new ReflectionBlock
  68836. * @param name defines the block name
  68837. */
  68838. constructor(name: string);
  68839. /**
  68840. * Intensity of the direct lights e.g. the four lights available in your scene.
  68841. * This impacts both the direct diffuse and specular highlights.
  68842. */
  68843. directIntensity: number;
  68844. /**
  68845. * Intensity of the environment e.g. how much the environment will light the object
  68846. * either through harmonics for rough material or through the refelction for shiny ones.
  68847. */
  68848. environmentIntensity: number;
  68849. /**
  68850. * This is a special control allowing the reduction of the specular highlights coming from the
  68851. * four lights of the scene. Those highlights may not be needed in full environment lighting.
  68852. */
  68853. specularIntensity: number;
  68854. /**
  68855. * Defines the falloff type used in this material.
  68856. * It by default is Physical.
  68857. */
  68858. lightFalloff: number;
  68859. /**
  68860. * Specifies that the alpha is coming form the albedo channel alpha channel for alpha blending.
  68861. */
  68862. useAlphaFromAlbedoTexture: boolean;
  68863. /**
  68864. * Specifies that alpha test should be used
  68865. */
  68866. useAlphaTest: boolean;
  68867. /**
  68868. * Defines the alpha limits in alpha test mode.
  68869. */
  68870. alphaTestCutoff: number;
  68871. /**
  68872. * Specifies that alpha blending should be used
  68873. */
  68874. useAlphaBlending: boolean;
  68875. /**
  68876. * Defines if the alpha value should be determined via the rgb values.
  68877. * If true the luminance of the pixel might be used to find the corresponding alpha value.
  68878. */
  68879. opacityRGB: boolean;
  68880. /**
  68881. * Specifies that the material will keeps the reflection highlights over a transparent surface (only the most luminous ones).
  68882. * A car glass is a good exemple of that. When the street lights reflects on it you can not see what is behind.
  68883. */
  68884. useRadianceOverAlpha: boolean;
  68885. /**
  68886. * Specifies that the material will keeps the specular highlights over a transparent surface (only the most luminous ones).
  68887. * A car glass is a good exemple of that. When sun reflects on it you can not see what is behind.
  68888. */
  68889. useSpecularOverAlpha: boolean;
  68890. /**
  68891. * Enables specular anti aliasing in the PBR shader.
  68892. * It will both interacts on the Geometry for analytical and IBL lighting.
  68893. * It also prefilter the roughness map based on the bump values.
  68894. */
  68895. enableSpecularAntiAliasing: boolean;
  68896. /**
  68897. * Enables realtime filtering on the texture.
  68898. */
  68899. realTimeFiltering: boolean;
  68900. /**
  68901. * Quality switch for realtime filtering
  68902. */
  68903. realTimeFilteringQuality: number;
  68904. /**
  68905. * Defines if the material uses energy conservation.
  68906. */
  68907. useEnergyConservation: boolean;
  68908. /**
  68909. * This parameters will enable/disable radiance occlusion by preventing the radiance to lit
  68910. * too much the area relying on ambient texture to define their ambient occlusion.
  68911. */
  68912. useRadianceOcclusion: boolean;
  68913. /**
  68914. * This parameters will enable/disable Horizon occlusion to prevent normal maps to look shiny when the normal
  68915. * makes the reflect vector face the model (under horizon).
  68916. */
  68917. useHorizonOcclusion: boolean;
  68918. /**
  68919. * If set to true, no lighting calculations will be applied.
  68920. */
  68921. unlit: boolean;
  68922. /**
  68923. * Force normal to face away from face.
  68924. */
  68925. forceNormalForward: boolean;
  68926. /**
  68927. * Defines the material debug mode.
  68928. * It helps seeing only some components of the material while troubleshooting.
  68929. */
  68930. debugMode: number;
  68931. /**
  68932. * Specify from where on screen the debug mode should start.
  68933. * The value goes from -1 (full screen) to 1 (not visible)
  68934. * It helps with side by side comparison against the final render
  68935. * This defaults to 0
  68936. */
  68937. debugLimit: number;
  68938. /**
  68939. * As the default viewing range might not be enough (if the ambient is really small for instance)
  68940. * You can use the factor to better multiply the final value.
  68941. */
  68942. debugFactor: number;
  68943. /**
  68944. * Initialize the block and prepare the context for build
  68945. * @param state defines the state that will be used for the build
  68946. */
  68947. initialize(state: NodeMaterialBuildState): void;
  68948. /**
  68949. * Gets the current class name
  68950. * @returns the class name
  68951. */
  68952. getClassName(): string;
  68953. /**
  68954. * Gets the world position input component
  68955. */
  68956. get worldPosition(): NodeMaterialConnectionPoint;
  68957. /**
  68958. * Gets the world normal input component
  68959. */
  68960. get worldNormal(): NodeMaterialConnectionPoint;
  68961. /**
  68962. * Gets the perturbed normal input component
  68963. */
  68964. get perturbedNormal(): NodeMaterialConnectionPoint;
  68965. /**
  68966. * Gets the camera position input component
  68967. */
  68968. get cameraPosition(): NodeMaterialConnectionPoint;
  68969. /**
  68970. * Gets the base color input component
  68971. */
  68972. get baseColor(): NodeMaterialConnectionPoint;
  68973. /**
  68974. * Gets the opacity texture input component
  68975. */
  68976. get opacityTexture(): NodeMaterialConnectionPoint;
  68977. /**
  68978. * Gets the ambient color input component
  68979. */
  68980. get ambientColor(): NodeMaterialConnectionPoint;
  68981. /**
  68982. * Gets the reflectivity object parameters
  68983. */
  68984. get reflectivity(): NodeMaterialConnectionPoint;
  68985. /**
  68986. * Gets the ambient occlusion object parameters
  68987. */
  68988. get ambientOcc(): NodeMaterialConnectionPoint;
  68989. /**
  68990. * Gets the reflection object parameters
  68991. */
  68992. get reflection(): NodeMaterialConnectionPoint;
  68993. /**
  68994. * Gets the sheen object parameters
  68995. */
  68996. get sheen(): NodeMaterialConnectionPoint;
  68997. /**
  68998. * Gets the clear coat object parameters
  68999. */
  69000. get clearcoat(): NodeMaterialConnectionPoint;
  69001. /**
  69002. * Gets the sub surface object parameters
  69003. */
  69004. get subsurface(): NodeMaterialConnectionPoint;
  69005. /**
  69006. * Gets the anisotropy object parameters
  69007. */
  69008. get anisotropy(): NodeMaterialConnectionPoint;
  69009. /**
  69010. * Gets the ambient output component
  69011. */
  69012. get ambient(): NodeMaterialConnectionPoint;
  69013. /**
  69014. * Gets the diffuse output component
  69015. */
  69016. get diffuse(): NodeMaterialConnectionPoint;
  69017. /**
  69018. * Gets the specular output component
  69019. */
  69020. get specular(): NodeMaterialConnectionPoint;
  69021. /**
  69022. * Gets the sheen output component
  69023. */
  69024. get sheenDir(): NodeMaterialConnectionPoint;
  69025. /**
  69026. * Gets the clear coat output component
  69027. */
  69028. get clearcoatDir(): NodeMaterialConnectionPoint;
  69029. /**
  69030. * Gets the indirect diffuse output component
  69031. */
  69032. get diffuseIndirect(): NodeMaterialConnectionPoint;
  69033. /**
  69034. * Gets the indirect specular output component
  69035. */
  69036. get specularIndirect(): NodeMaterialConnectionPoint;
  69037. /**
  69038. * Gets the indirect sheen output component
  69039. */
  69040. get sheenIndirect(): NodeMaterialConnectionPoint;
  69041. /**
  69042. * Gets the indirect clear coat output component
  69043. */
  69044. get clearcoatIndirect(): NodeMaterialConnectionPoint;
  69045. /**
  69046. * Gets the refraction output component
  69047. */
  69048. get refraction(): NodeMaterialConnectionPoint;
  69049. /**
  69050. * Gets the global lighting output component
  69051. */
  69052. get lighting(): NodeMaterialConnectionPoint;
  69053. /**
  69054. * Gets the shadow output component
  69055. */
  69056. get shadow(): NodeMaterialConnectionPoint;
  69057. /**
  69058. * Gets the alpha output component
  69059. */
  69060. get alpha(): NodeMaterialConnectionPoint;
  69061. autoConfigure(material: NodeMaterial): void;
  69062. prepareDefines(mesh: AbstractMesh, nodeMaterial: NodeMaterial, defines: NodeMaterialDefines): void;
  69063. updateUniformsAndSamples(state: NodeMaterialBuildState, nodeMaterial: NodeMaterial, defines: NodeMaterialDefines, uniformBuffers: string[]): void;
  69064. bind(effect: Effect, nodeMaterial: NodeMaterial, mesh?: Mesh): void;
  69065. private _injectVertexCode;
  69066. /**
  69067. * Gets the code corresponding to the albedo/opacity module
  69068. * @returns the shader code
  69069. */
  69070. getAlbedoOpacityCode(): string;
  69071. protected _buildBlock(state: NodeMaterialBuildState): this;
  69072. protected _dumpPropertiesCode(): string;
  69073. serialize(): any;
  69074. _deserialize(serializationObject: any, scene: Scene, rootUrl: string): void;
  69075. }
  69076. }
  69077. declare module "babylonjs/Materials/Node/Blocks/PBR/index" {
  69078. export * from "babylonjs/Materials/Node/Blocks/PBR/pbrMetallicRoughnessBlock";
  69079. export * from "babylonjs/Materials/Node/Blocks/PBR/sheenBlock";
  69080. export * from "babylonjs/Materials/Node/Blocks/PBR/ambientOcclusionBlock";
  69081. export * from "babylonjs/Materials/Node/Blocks/PBR/reflectivityBlock";
  69082. export * from "babylonjs/Materials/Node/Blocks/PBR/anisotropyBlock";
  69083. export * from "babylonjs/Materials/Node/Blocks/PBR/reflectionBlock";
  69084. export * from "babylonjs/Materials/Node/Blocks/PBR/clearCoatBlock";
  69085. export * from "babylonjs/Materials/Node/Blocks/PBR/refractionBlock";
  69086. export * from "babylonjs/Materials/Node/Blocks/PBR/subSurfaceBlock";
  69087. }
  69088. declare module "babylonjs/Materials/Node/Blocks/Particle/index" {
  69089. export * from "babylonjs/Materials/Node/Blocks/Particle/particleTextureBlock";
  69090. export * from "babylonjs/Materials/Node/Blocks/Particle/particleRampGradientBlock";
  69091. export * from "babylonjs/Materials/Node/Blocks/Particle/particleBlendMultiplyBlock";
  69092. }
  69093. declare module "babylonjs/Materials/Node/Blocks/modBlock" {
  69094. import { NodeMaterialBlock } from "babylonjs/Materials/Node/nodeMaterialBlock";
  69095. import { NodeMaterialBuildState } from "babylonjs/Materials/Node/nodeMaterialBuildState";
  69096. import { NodeMaterialConnectionPoint } from "babylonjs/Materials/Node/nodeMaterialBlockConnectionPoint";
  69097. /**
  69098. * Block used to compute value of one parameter modulo another
  69099. */
  69100. export class ModBlock extends NodeMaterialBlock {
  69101. /**
  69102. * Creates a new ModBlock
  69103. * @param name defines the block name
  69104. */
  69105. constructor(name: string);
  69106. /**
  69107. * Gets the current class name
  69108. * @returns the class name
  69109. */
  69110. getClassName(): string;
  69111. /**
  69112. * Gets the left operand input component
  69113. */
  69114. get left(): NodeMaterialConnectionPoint;
  69115. /**
  69116. * Gets the right operand input component
  69117. */
  69118. get right(): NodeMaterialConnectionPoint;
  69119. /**
  69120. * Gets the output component
  69121. */
  69122. get output(): NodeMaterialConnectionPoint;
  69123. protected _buildBlock(state: NodeMaterialBuildState): this;
  69124. }
  69125. }
  69126. declare module "babylonjs/Materials/Node/Blocks/index" {
  69127. export * from "babylonjs/Materials/Node/Blocks/Vertex/index";
  69128. export * from "babylonjs/Materials/Node/Blocks/Fragment/index";
  69129. export * from "babylonjs/Materials/Node/Blocks/Dual/index";
  69130. export * from "babylonjs/Materials/Node/Blocks/Input/index";
  69131. export * from "babylonjs/Materials/Node/Blocks/multiplyBlock";
  69132. export * from "babylonjs/Materials/Node/Blocks/addBlock";
  69133. export * from "babylonjs/Materials/Node/Blocks/scaleBlock";
  69134. export * from "babylonjs/Materials/Node/Blocks/clampBlock";
  69135. export * from "babylonjs/Materials/Node/Blocks/crossBlock";
  69136. export * from "babylonjs/Materials/Node/Blocks/dotBlock";
  69137. export * from "babylonjs/Materials/Node/Blocks/transformBlock";
  69138. export * from "babylonjs/Materials/Node/Blocks/remapBlock";
  69139. export * from "babylonjs/Materials/Node/Blocks/normalizeBlock";
  69140. export * from "babylonjs/Materials/Node/Blocks/trigonometryBlock";
  69141. export * from "babylonjs/Materials/Node/Blocks/colorMergerBlock";
  69142. export * from "babylonjs/Materials/Node/Blocks/vectorMergerBlock";
  69143. export * from "babylonjs/Materials/Node/Blocks/colorSplitterBlock";
  69144. export * from "babylonjs/Materials/Node/Blocks/vectorSplitterBlock";
  69145. export * from "babylonjs/Materials/Node/Blocks/lerpBlock";
  69146. export * from "babylonjs/Materials/Node/Blocks/divideBlock";
  69147. export * from "babylonjs/Materials/Node/Blocks/subtractBlock";
  69148. export * from "babylonjs/Materials/Node/Blocks/stepBlock";
  69149. export * from "babylonjs/Materials/Node/Blocks/oneMinusBlock";
  69150. export * from "babylonjs/Materials/Node/Blocks/viewDirectionBlock";
  69151. export * from "babylonjs/Materials/Node/Blocks/fresnelBlock";
  69152. export * from "babylonjs/Materials/Node/Blocks/maxBlock";
  69153. export * from "babylonjs/Materials/Node/Blocks/minBlock";
  69154. export * from "babylonjs/Materials/Node/Blocks/distanceBlock";
  69155. export * from "babylonjs/Materials/Node/Blocks/lengthBlock";
  69156. export * from "babylonjs/Materials/Node/Blocks/negateBlock";
  69157. export * from "babylonjs/Materials/Node/Blocks/powBlock";
  69158. export * from "babylonjs/Materials/Node/Blocks/randomNumberBlock";
  69159. export * from "babylonjs/Materials/Node/Blocks/arcTan2Block";
  69160. export * from "babylonjs/Materials/Node/Blocks/smoothStepBlock";
  69161. export * from "babylonjs/Materials/Node/Blocks/reciprocalBlock";
  69162. export * from "babylonjs/Materials/Node/Blocks/replaceColorBlock";
  69163. export * from "babylonjs/Materials/Node/Blocks/posterizeBlock";
  69164. export * from "babylonjs/Materials/Node/Blocks/waveBlock";
  69165. export * from "babylonjs/Materials/Node/Blocks/gradientBlock";
  69166. export * from "babylonjs/Materials/Node/Blocks/nLerpBlock";
  69167. export * from "babylonjs/Materials/Node/Blocks/worleyNoise3DBlock";
  69168. export * from "babylonjs/Materials/Node/Blocks/simplexPerlin3DBlock";
  69169. export * from "babylonjs/Materials/Node/Blocks/normalBlendBlock";
  69170. export * from "babylonjs/Materials/Node/Blocks/rotate2dBlock";
  69171. export * from "babylonjs/Materials/Node/Blocks/reflectBlock";
  69172. export * from "babylonjs/Materials/Node/Blocks/refractBlock";
  69173. export * from "babylonjs/Materials/Node/Blocks/desaturateBlock";
  69174. export * from "babylonjs/Materials/Node/Blocks/PBR/index";
  69175. export * from "babylonjs/Materials/Node/Blocks/Particle/index";
  69176. export * from "babylonjs/Materials/Node/Blocks/modBlock";
  69177. }
  69178. declare module "babylonjs/Materials/Node/Optimizers/index" {
  69179. export * from "babylonjs/Materials/Node/Optimizers/nodeMaterialOptimizer";
  69180. }
  69181. declare module "babylonjs/Materials/Node/index" {
  69182. export * from "babylonjs/Materials/Node/Enums/index";
  69183. export * from "babylonjs/Materials/Node/nodeMaterialBlockConnectionPoint";
  69184. export * from "babylonjs/Materials/Node/nodeMaterialBlock";
  69185. export * from "babylonjs/Materials/Node/nodeMaterial";
  69186. export * from "babylonjs/Materials/Node/Blocks/index";
  69187. export * from "babylonjs/Materials/Node/Optimizers/index";
  69188. export * from "babylonjs/Materials/Node/nodeMaterialDecorator";
  69189. }
  69190. declare module "babylonjs/Materials/index" {
  69191. export * from "babylonjs/Materials/Background/index";
  69192. export * from "babylonjs/Materials/colorCurves";
  69193. export * from "babylonjs/Materials/iEffectFallbacks";
  69194. export * from "babylonjs/Materials/effectFallbacks";
  69195. export * from "babylonjs/Materials/effect";
  69196. export * from "babylonjs/Materials/fresnelParameters";
  69197. export * from "babylonjs/Materials/imageProcessingConfiguration";
  69198. export * from "babylonjs/Materials/material";
  69199. export * from "babylonjs/Materials/materialDefines";
  69200. export * from "babylonjs/Materials/thinMaterialHelper";
  69201. export * from "babylonjs/Materials/materialHelper";
  69202. export * from "babylonjs/Materials/multiMaterial";
  69203. export * from "babylonjs/Materials/PBR/index";
  69204. export * from "babylonjs/Materials/pushMaterial";
  69205. export * from "babylonjs/Materials/shaderMaterial";
  69206. export * from "babylonjs/Materials/standardMaterial";
  69207. export * from "babylonjs/Materials/Textures/index";
  69208. export * from "babylonjs/Materials/uniformBuffer";
  69209. export * from "babylonjs/Materials/materialFlags";
  69210. export * from "babylonjs/Materials/Node/index";
  69211. export * from "babylonjs/Materials/effectRenderer";
  69212. export * from "babylonjs/Materials/shadowDepthWrapper";
  69213. }
  69214. declare module "babylonjs/Maths/index" {
  69215. export * from "babylonjs/Maths/math.scalar";
  69216. export * from "babylonjs/Maths/math";
  69217. export * from "babylonjs/Maths/sphericalPolynomial";
  69218. }
  69219. declare module "babylonjs/Meshes/Compression/dracoCompression" {
  69220. import { IDisposable } from "babylonjs/scene";
  69221. import { VertexData } from "babylonjs/Meshes/mesh.vertexData";
  69222. /**
  69223. * Configuration for Draco compression
  69224. */
  69225. export interface IDracoCompressionConfiguration {
  69226. /**
  69227. * Configuration for the decoder.
  69228. */
  69229. decoder: {
  69230. /**
  69231. * The url to the WebAssembly module.
  69232. */
  69233. wasmUrl?: string;
  69234. /**
  69235. * The url to the WebAssembly binary.
  69236. */
  69237. wasmBinaryUrl?: string;
  69238. /**
  69239. * The url to the fallback JavaScript module.
  69240. */
  69241. fallbackUrl?: string;
  69242. };
  69243. }
  69244. /**
  69245. * Draco compression (https://google.github.io/draco/)
  69246. *
  69247. * This class wraps the Draco module.
  69248. *
  69249. * **Encoder**
  69250. *
  69251. * The encoder is not currently implemented.
  69252. *
  69253. * **Decoder**
  69254. *
  69255. * 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.
  69256. *
  69257. * To update the configuration, use the following code:
  69258. * ```javascript
  69259. * DracoCompression.Configuration = {
  69260. * decoder: {
  69261. * wasmUrl: "<url to the WebAssembly library>",
  69262. * wasmBinaryUrl: "<url to the WebAssembly binary>",
  69263. * fallbackUrl: "<url to the fallback JavaScript library>",
  69264. * }
  69265. * };
  69266. * ```
  69267. *
  69268. * 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.
  69269. * Decoding will automatically fallback to the JavaScript version if WebAssembly version is not configured or if WebAssembly is not supported by the browser.
  69270. * Use `DracoCompression.DecoderAvailable` to determine if the decoder configuration is available for the current context.
  69271. *
  69272. * To decode Draco compressed data, get the default DracoCompression object and call decodeMeshAsync:
  69273. * ```javascript
  69274. * var vertexData = await DracoCompression.Default.decodeMeshAsync(data);
  69275. * ```
  69276. *
  69277. * @see https://www.babylonjs-playground.com/#N3EK4B#0
  69278. */
  69279. export class DracoCompression implements IDisposable {
  69280. private _workerPoolPromise?;
  69281. private _decoderModulePromise?;
  69282. /**
  69283. * The configuration. Defaults to the following urls:
  69284. * - wasmUrl: "https://preview.babylonjs.com/draco_wasm_wrapper_gltf.js"
  69285. * - wasmBinaryUrl: "https://preview.babylonjs.com/draco_decoder_gltf.wasm"
  69286. * - fallbackUrl: "https://preview.babylonjs.com/draco_decoder_gltf.js"
  69287. */
  69288. static Configuration: IDracoCompressionConfiguration;
  69289. /**
  69290. * Returns true if the decoder configuration is available.
  69291. */
  69292. static get DecoderAvailable(): boolean;
  69293. /**
  69294. * Default number of workers to create when creating the draco compression object.
  69295. */
  69296. static DefaultNumWorkers: number;
  69297. private static GetDefaultNumWorkers;
  69298. private static _Default;
  69299. /**
  69300. * Default instance for the draco compression object.
  69301. */
  69302. static get Default(): DracoCompression;
  69303. /**
  69304. * Constructor
  69305. * @param numWorkers The number of workers for async operations. Specify `0` to disable web workers and run synchronously in the current context.
  69306. */
  69307. constructor(numWorkers?: number);
  69308. /**
  69309. * Stop all async operations and release resources.
  69310. */
  69311. dispose(): void;
  69312. /**
  69313. * Returns a promise that resolves when ready. Call this manually to ensure draco compression is ready before use.
  69314. * @returns a promise that resolves when ready
  69315. */
  69316. whenReadyAsync(): Promise<void>;
  69317. /**
  69318. * Decode Draco compressed mesh data to vertex data.
  69319. * @param data The ArrayBuffer or ArrayBufferView for the Draco compression data
  69320. * @param attributes A map of attributes from vertex buffer kinds to Draco unique ids
  69321. * @returns A promise that resolves with the decoded vertex data
  69322. */
  69323. decodeMeshAsync(data: ArrayBuffer | ArrayBufferView, attributes?: {
  69324. [kind: string]: number;
  69325. }): Promise<VertexData>;
  69326. }
  69327. }
  69328. declare module "babylonjs/Meshes/Compression/index" {
  69329. export * from "babylonjs/Meshes/Compression/dracoCompression";
  69330. }
  69331. declare module "babylonjs/Meshes/csg" {
  69332. import { Nullable } from "babylonjs/types";
  69333. import { Scene } from "babylonjs/scene";
  69334. import { Quaternion, Matrix, Vector3 } from "babylonjs/Maths/math.vector";
  69335. import { Mesh } from "babylonjs/Meshes/mesh";
  69336. import { Material } from "babylonjs/Materials/material";
  69337. /**
  69338. * Class for building Constructive Solid Geometry
  69339. */
  69340. export class CSG {
  69341. private polygons;
  69342. /**
  69343. * The world matrix
  69344. */
  69345. matrix: Matrix;
  69346. /**
  69347. * Stores the position
  69348. */
  69349. position: Vector3;
  69350. /**
  69351. * Stores the rotation
  69352. */
  69353. rotation: Vector3;
  69354. /**
  69355. * Stores the rotation quaternion
  69356. */
  69357. rotationQuaternion: Nullable<Quaternion>;
  69358. /**
  69359. * Stores the scaling vector
  69360. */
  69361. scaling: Vector3;
  69362. /**
  69363. * Convert the Mesh to CSG
  69364. * @param mesh The Mesh to convert to CSG
  69365. * @returns A new CSG from the Mesh
  69366. */
  69367. static FromMesh(mesh: Mesh): CSG;
  69368. /**
  69369. * Construct a CSG solid from a list of `CSG.Polygon` instances.
  69370. * @param polygons Polygons used to construct a CSG solid
  69371. */
  69372. private static FromPolygons;
  69373. /**
  69374. * Clones, or makes a deep copy, of the CSG
  69375. * @returns A new CSG
  69376. */
  69377. clone(): CSG;
  69378. /**
  69379. * Unions this CSG with another CSG
  69380. * @param csg The CSG to union against this CSG
  69381. * @returns The unioned CSG
  69382. */
  69383. union(csg: CSG): CSG;
  69384. /**
  69385. * Unions this CSG with another CSG in place
  69386. * @param csg The CSG to union against this CSG
  69387. */
  69388. unionInPlace(csg: CSG): void;
  69389. /**
  69390. * Subtracts this CSG with another CSG
  69391. * @param csg The CSG to subtract against this CSG
  69392. * @returns A new CSG
  69393. */
  69394. subtract(csg: CSG): CSG;
  69395. /**
  69396. * Subtracts this CSG with another CSG in place
  69397. * @param csg The CSG to subtact against this CSG
  69398. */
  69399. subtractInPlace(csg: CSG): void;
  69400. /**
  69401. * Intersect this CSG with another CSG
  69402. * @param csg The CSG to intersect against this CSG
  69403. * @returns A new CSG
  69404. */
  69405. intersect(csg: CSG): CSG;
  69406. /**
  69407. * Intersects this CSG with another CSG in place
  69408. * @param csg The CSG to intersect against this CSG
  69409. */
  69410. intersectInPlace(csg: CSG): void;
  69411. /**
  69412. * Return a new CSG solid with solid and empty space switched. This solid is
  69413. * not modified.
  69414. * @returns A new CSG solid with solid and empty space switched
  69415. */
  69416. inverse(): CSG;
  69417. /**
  69418. * Inverses the CSG in place
  69419. */
  69420. inverseInPlace(): void;
  69421. /**
  69422. * This is used to keep meshes transformations so they can be restored
  69423. * when we build back a Babylon Mesh
  69424. * NB : All CSG operations are performed in world coordinates
  69425. * @param csg The CSG to copy the transform attributes from
  69426. * @returns This CSG
  69427. */
  69428. copyTransformAttributes(csg: CSG): CSG;
  69429. /**
  69430. * Build Raw mesh from CSG
  69431. * Coordinates here are in world space
  69432. * @param name The name of the mesh geometry
  69433. * @param scene The Scene
  69434. * @param keepSubMeshes Specifies if the submeshes should be kept
  69435. * @returns A new Mesh
  69436. */
  69437. buildMeshGeometry(name: string, scene?: Scene, keepSubMeshes?: boolean): Mesh;
  69438. /**
  69439. * Build Mesh from CSG taking material and transforms into account
  69440. * @param name The name of the Mesh
  69441. * @param material The material of the Mesh
  69442. * @param scene The Scene
  69443. * @param keepSubMeshes Specifies if submeshes should be kept
  69444. * @returns The new Mesh
  69445. */
  69446. toMesh(name: string, material?: Nullable<Material>, scene?: Scene, keepSubMeshes?: boolean): Mesh;
  69447. }
  69448. }
  69449. declare module "babylonjs/Meshes/trailMesh" {
  69450. import { Mesh } from "babylonjs/Meshes/mesh";
  69451. import { Scene } from "babylonjs/scene";
  69452. import { TransformNode } from "babylonjs/Meshes/transformNode";
  69453. /**
  69454. * Class used to create a trail following a mesh
  69455. */
  69456. export class TrailMesh extends Mesh {
  69457. private _generator;
  69458. private _autoStart;
  69459. private _running;
  69460. private _diameter;
  69461. private _length;
  69462. private _sectionPolygonPointsCount;
  69463. private _sectionVectors;
  69464. private _sectionNormalVectors;
  69465. private _beforeRenderObserver;
  69466. /**
  69467. * @constructor
  69468. * @param name The value used by scene.getMeshByName() to do a lookup.
  69469. * @param generator The mesh or transform node to generate a trail.
  69470. * @param scene The scene to add this mesh to.
  69471. * @param diameter Diameter of trailing mesh. Default is 1.
  69472. * @param length Length of trailing mesh. Default is 60.
  69473. * @param autoStart Automatically start trailing mesh. Default true.
  69474. */
  69475. constructor(name: string, generator: TransformNode, scene: Scene, diameter?: number, length?: number, autoStart?: boolean);
  69476. /**
  69477. * "TrailMesh"
  69478. * @returns "TrailMesh"
  69479. */
  69480. getClassName(): string;
  69481. private _createMesh;
  69482. /**
  69483. * Start trailing mesh.
  69484. */
  69485. start(): void;
  69486. /**
  69487. * Stop trailing mesh.
  69488. */
  69489. stop(): void;
  69490. /**
  69491. * Update trailing mesh geometry.
  69492. */
  69493. update(): void;
  69494. /**
  69495. * Returns a new TrailMesh object.
  69496. * @param name is a string, the name given to the new mesh
  69497. * @param newGenerator use new generator object for cloned trail mesh
  69498. * @returns a new mesh
  69499. */
  69500. clone(name: string | undefined, newGenerator: TransformNode): TrailMesh;
  69501. /**
  69502. * Serializes this trail mesh
  69503. * @param serializationObject object to write serialization to
  69504. */
  69505. serialize(serializationObject: any): void;
  69506. /**
  69507. * Parses a serialized trail mesh
  69508. * @param parsedMesh the serialized mesh
  69509. * @param scene the scene to create the trail mesh in
  69510. * @returns the created trail mesh
  69511. */
  69512. static Parse(parsedMesh: any, scene: Scene): TrailMesh;
  69513. }
  69514. }
  69515. declare module "babylonjs/Meshes/Builders/tiledBoxBuilder" {
  69516. import { Nullable } from "babylonjs/types";
  69517. import { Scene } from "babylonjs/scene";
  69518. import { Vector4 } from "babylonjs/Maths/math.vector";
  69519. import { Color4 } from "babylonjs/Maths/math.color";
  69520. import { Mesh } from "babylonjs/Meshes/mesh";
  69521. /**
  69522. * Class containing static functions to help procedurally build meshes
  69523. */
  69524. export class TiledBoxBuilder {
  69525. /**
  69526. * Creates a box mesh
  69527. * 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)
  69528. * * Please read this tutorial : https://doc.babylonjs.com/how_to/createbox_per_face_textures_and_colors
  69529. * * You can also set the mesh side orientation with the values : BABYLON.Mesh.FRONTSIDE (default), BABYLON.Mesh.BACKSIDE or BABYLON.Mesh.DOUBLESIDE
  69530. * * If you create a double-sided mesh, you can choose what parts of the texture image to crop and stick respectively on the front and the back sides with the parameters `frontUVs` and `backUVs` (Vector4). Detail here : https://doc.babylonjs.com/babylon101/discover_basic_elements#side-orientation
  69531. * * The mesh can be set to updatable with the boolean parameter `updatable` (default false) if its internal geometry is supposed to change once created
  69532. * @param name defines the name of the mesh
  69533. * @param options defines the options used to create the mesh
  69534. * @param scene defines the hosting scene
  69535. * @returns the box mesh
  69536. */
  69537. static CreateTiledBox(name: string, options: {
  69538. pattern?: number;
  69539. width?: number;
  69540. height?: number;
  69541. depth?: number;
  69542. tileSize?: number;
  69543. tileWidth?: number;
  69544. tileHeight?: number;
  69545. alignHorizontal?: number;
  69546. alignVertical?: number;
  69547. faceUV?: Vector4[];
  69548. faceColors?: Color4[];
  69549. sideOrientation?: number;
  69550. updatable?: boolean;
  69551. }, scene?: Nullable<Scene>): Mesh;
  69552. }
  69553. }
  69554. declare module "babylonjs/Meshes/Builders/torusKnotBuilder" {
  69555. import { Vector4 } from "babylonjs/Maths/math.vector";
  69556. import { Mesh } from "babylonjs/Meshes/mesh";
  69557. /**
  69558. * Class containing static functions to help procedurally build meshes
  69559. */
  69560. export class TorusKnotBuilder {
  69561. /**
  69562. * Creates a torus knot mesh
  69563. * * The parameter `radius` sets the global radius size (float) of the torus knot (default 2)
  69564. * * The parameter `radialSegments` sets the number of sides on each tube segments (positive integer, default 32)
  69565. * * The parameter `tubularSegments` sets the number of tubes to decompose the knot into (positive integer, default 32)
  69566. * * The parameters `p` and `q` are the number of windings on each axis (positive integers, default 2 and 3)
  69567. * * You can also set the mesh side orientation with the values : BABYLON.Mesh.FRONTSIDE (default), BABYLON.Mesh.BACKSIDE or BABYLON.Mesh.DOUBLESIDE
  69568. * * If you create a double-sided mesh, you can choose what parts of the texture image to crop and stick respectively on the front and the back sides with the parameters `frontUVs` and `backUVs` (Vector4). Detail here : https://doc.babylonjs.com/babylon101/discover_basic_elements#side-orientation
  69569. * * The mesh can be set to updatable with the boolean parameter `updatable` (default false) if its internal geometry is supposed to change once created.
  69570. * @param name defines the name of the mesh
  69571. * @param options defines the options used to create the mesh
  69572. * @param scene defines the hosting scene
  69573. * @returns the torus knot mesh
  69574. * @see https://doc.babylonjs.com/how_to/set_shapes#torus-knot
  69575. */
  69576. static CreateTorusKnot(name: string, options: {
  69577. radius?: number;
  69578. tube?: number;
  69579. radialSegments?: number;
  69580. tubularSegments?: number;
  69581. p?: number;
  69582. q?: number;
  69583. updatable?: boolean;
  69584. sideOrientation?: number;
  69585. frontUVs?: Vector4;
  69586. backUVs?: Vector4;
  69587. }, scene: any): Mesh;
  69588. }
  69589. }
  69590. declare module "babylonjs/Meshes/polygonMesh" {
  69591. import { Scene } from "babylonjs/scene";
  69592. import { Vector2 } from "babylonjs/Maths/math.vector";
  69593. import { Mesh } from "babylonjs/Meshes/mesh";
  69594. import { VertexData } from "babylonjs/Meshes/mesh.vertexData";
  69595. import { Path2 } from "babylonjs/Maths/math.path";
  69596. /**
  69597. * Polygon
  69598. * @see https://doc.babylonjs.com/how_to/parametric_shapes#non-regular-polygon
  69599. */
  69600. export class Polygon {
  69601. /**
  69602. * Creates a rectangle
  69603. * @param xmin bottom X coord
  69604. * @param ymin bottom Y coord
  69605. * @param xmax top X coord
  69606. * @param ymax top Y coord
  69607. * @returns points that make the resulting rectation
  69608. */
  69609. static Rectangle(xmin: number, ymin: number, xmax: number, ymax: number): Vector2[];
  69610. /**
  69611. * Creates a circle
  69612. * @param radius radius of circle
  69613. * @param cx scale in x
  69614. * @param cy scale in y
  69615. * @param numberOfSides number of sides that make up the circle
  69616. * @returns points that make the resulting circle
  69617. */
  69618. static Circle(radius: number, cx?: number, cy?: number, numberOfSides?: number): Vector2[];
  69619. /**
  69620. * Creates a polygon from input string
  69621. * @param input Input polygon data
  69622. * @returns the parsed points
  69623. */
  69624. static Parse(input: string): Vector2[];
  69625. /**
  69626. * Starts building a polygon from x and y coordinates
  69627. * @param x x coordinate
  69628. * @param y y coordinate
  69629. * @returns the started path2
  69630. */
  69631. static StartingAt(x: number, y: number): Path2;
  69632. }
  69633. /**
  69634. * Builds a polygon
  69635. * @see https://doc.babylonjs.com/how_to/polygonmeshbuilder
  69636. */
  69637. export class PolygonMeshBuilder {
  69638. private _points;
  69639. private _outlinepoints;
  69640. private _holes;
  69641. private _name;
  69642. private _scene;
  69643. private _epoints;
  69644. private _eholes;
  69645. private _addToepoint;
  69646. /**
  69647. * Babylon reference to the earcut plugin.
  69648. */
  69649. bjsEarcut: any;
  69650. /**
  69651. * Creates a PolygonMeshBuilder
  69652. * @param name name of the builder
  69653. * @param contours Path of the polygon
  69654. * @param scene scene to add to when creating the mesh
  69655. * @param earcutInjection can be used to inject your own earcut reference
  69656. */
  69657. constructor(name: string, contours: Path2 | Vector2[] | any, scene?: Scene, earcutInjection?: any);
  69658. /**
  69659. * Adds a whole within the polygon
  69660. * @param hole Array of points defining the hole
  69661. * @returns this
  69662. */
  69663. addHole(hole: Vector2[]): PolygonMeshBuilder;
  69664. /**
  69665. * Creates the polygon
  69666. * @param updatable If the mesh should be updatable
  69667. * @param depth The depth of the mesh created
  69668. * @returns the created mesh
  69669. */
  69670. build(updatable?: boolean, depth?: number): Mesh;
  69671. /**
  69672. * Creates the polygon
  69673. * @param depth The depth of the mesh created
  69674. * @returns the created VertexData
  69675. */
  69676. buildVertexData(depth?: number): VertexData;
  69677. /**
  69678. * Adds a side to the polygon
  69679. * @param positions points that make the polygon
  69680. * @param normals normals of the polygon
  69681. * @param uvs uvs of the polygon
  69682. * @param indices indices of the polygon
  69683. * @param bounds bounds of the polygon
  69684. * @param points points of the polygon
  69685. * @param depth depth of the polygon
  69686. * @param flip flip of the polygon
  69687. */
  69688. private addSide;
  69689. }
  69690. }
  69691. declare module "babylonjs/Meshes/Builders/polygonBuilder" {
  69692. import { Scene } from "babylonjs/scene";
  69693. import { Vector3, Vector4 } from "babylonjs/Maths/math.vector";
  69694. import { Color4 } from "babylonjs/Maths/math.color";
  69695. import { Mesh } from "babylonjs/Meshes/mesh";
  69696. import { Nullable } from "babylonjs/types";
  69697. /**
  69698. * Class containing static functions to help procedurally build meshes
  69699. */
  69700. export class PolygonBuilder {
  69701. /**
  69702. * Creates a polygon mesh
  69703. * The polygon's shape will depend on the input parameters and is constructed parallel to a ground mesh
  69704. * * 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
  69705. * * You can set the mesh side orientation with the values : Mesh.FRONTSIDE (default), Mesh.BACKSIDE or Mesh.DOUBLESIDE
  69706. * * The mesh can be set to updatable with the boolean parameter `updatable` (default false) if its internal geometry is supposed to change once created
  69707. * * If you create a double-sided mesh, you can choose what parts of the texture image to crop and stick respectively on the front and the back sides with the parameters `frontUVs` and `backUVs` (Vector4)
  69708. * * Remember you can only change the shape positions, not their number when updating a polygon
  69709. * @param name defines the name of the mesh
  69710. * @param options defines the options used to create the mesh
  69711. * @param scene defines the hosting scene
  69712. * @param earcutInjection can be used to inject your own earcut reference
  69713. * @returns the polygon mesh
  69714. */
  69715. static CreatePolygon(name: string, options: {
  69716. shape: Vector3[];
  69717. holes?: Vector3[][];
  69718. depth?: number;
  69719. faceUV?: Vector4[];
  69720. faceColors?: Color4[];
  69721. updatable?: boolean;
  69722. sideOrientation?: number;
  69723. frontUVs?: Vector4;
  69724. backUVs?: Vector4;
  69725. wrap?: boolean;
  69726. }, scene?: Nullable<Scene>, earcutInjection?: any): Mesh;
  69727. /**
  69728. * Creates an extruded polygon mesh, with depth in the Y direction.
  69729. * * 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)
  69730. * @see https://doc.babylonjs.com/how_to/createbox_per_face_textures_and_colors
  69731. * @param name defines the name of the mesh
  69732. * @param options defines the options used to create the mesh
  69733. * @param scene defines the hosting scene
  69734. * @param earcutInjection can be used to inject your own earcut reference
  69735. * @returns the polygon mesh
  69736. */
  69737. static ExtrudePolygon(name: string, options: {
  69738. shape: Vector3[];
  69739. holes?: Vector3[][];
  69740. depth?: number;
  69741. faceUV?: Vector4[];
  69742. faceColors?: Color4[];
  69743. updatable?: boolean;
  69744. sideOrientation?: number;
  69745. frontUVs?: Vector4;
  69746. backUVs?: Vector4;
  69747. wrap?: boolean;
  69748. }, scene?: Nullable<Scene>, earcutInjection?: any): Mesh;
  69749. }
  69750. }
  69751. declare module "babylonjs/Meshes/Builders/latheBuilder" {
  69752. import { Scene } from "babylonjs/scene";
  69753. import { Vector3, Vector4 } from "babylonjs/Maths/math.vector";
  69754. import { Mesh } from "babylonjs/Meshes/mesh";
  69755. import { Nullable } from "babylonjs/types";
  69756. /**
  69757. * Class containing static functions to help procedurally build meshes
  69758. */
  69759. export class LatheBuilder {
  69760. /**
  69761. * Creates lathe mesh.
  69762. * The lathe is a shape with a symetry axis : a 2D model shape is rotated around this axis to design the lathe
  69763. * * 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
  69764. * * The parameter `radius` (positive float, default 1) is the radius value of the lathe
  69765. * * The parameter `tessellation` (positive integer, default 64) is the side number of the lathe
  69766. * * The parameter `clip` (positive integer, default 0) is the number of sides to not create without effecting the general shape of the sides
  69767. * * 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
  69768. * * The parameter `closed` (boolean, default true) opens/closes the lathe circumference. This should be set to false when used with the parameter "arc"
  69769. * * 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
  69770. * * You can also set the mesh side orientation with the values : BABYLON.Mesh.FRONTSIDE (default), BABYLON.Mesh.BACKSIDE or BABYLON.Mesh.DOUBLESIDE
  69771. * * If you create a double-sided mesh, you can choose what parts of the texture image to crop and stick respectively on the front and the back sides with the parameters `frontUVs` and `backUVs` (Vector4). Detail here : https://doc.babylonjs.com/babylon101/discover_basic_elements#side-orientation
  69772. * * The optional parameter `invertUV` (boolean, default false) swaps in the geometry the U and V coordinates to apply a texture
  69773. * * The mesh can be set to updatable with the boolean parameter `updatable` (default false) if its internal geometry is supposed to change once created
  69774. * @param name defines the name of the mesh
  69775. * @param options defines the options used to create the mesh
  69776. * @param scene defines the hosting scene
  69777. * @returns the lathe mesh
  69778. * @see https://doc.babylonjs.com/how_to/parametric_shapes#lathe
  69779. */
  69780. static CreateLathe(name: string, options: {
  69781. shape: Vector3[];
  69782. radius?: number;
  69783. tessellation?: number;
  69784. clip?: number;
  69785. arc?: number;
  69786. closed?: boolean;
  69787. updatable?: boolean;
  69788. sideOrientation?: number;
  69789. frontUVs?: Vector4;
  69790. backUVs?: Vector4;
  69791. cap?: number;
  69792. invertUV?: boolean;
  69793. }, scene?: Nullable<Scene>): Mesh;
  69794. }
  69795. }
  69796. declare module "babylonjs/Meshes/Builders/tiledPlaneBuilder" {
  69797. import { Nullable } from "babylonjs/types";
  69798. import { Scene } from "babylonjs/scene";
  69799. import { Vector4 } from "babylonjs/Maths/math.vector";
  69800. import { Mesh } from "babylonjs/Meshes/mesh";
  69801. /**
  69802. * Class containing static functions to help procedurally build meshes
  69803. */
  69804. export class TiledPlaneBuilder {
  69805. /**
  69806. * Creates a tiled plane mesh
  69807. * * The parameter `pattern` will, depending on value, do nothing or
  69808. * * * flip (reflect about central vertical) alternate tiles across and up
  69809. * * * flip every tile on alternate rows
  69810. * * * rotate (180 degs) alternate tiles across and up
  69811. * * * rotate every tile on alternate rows
  69812. * * * flip and rotate alternate tiles across and up
  69813. * * * flip and rotate every tile on alternate rows
  69814. * * The parameter `tileSize` sets the size (float) of each tile side (default 1)
  69815. * * You can set some different tile dimensions by using the parameters `tileWidth` and `tileHeight` (both by default have the same value of `tileSize`)
  69816. * * If you create a double-sided mesh, you can choose what parts of the texture image to crop and stick respectively on the front and the back sides with the parameters `frontUVs` and `backUVs` (Vector4). Detail here : https://doc.babylonjs.com/babylon101/discover_basic_elements#side-orientation
  69817. * * sideOrientation optional and takes the values : Mesh.FRONTSIDE (default), Mesh.BACKSIDE or Mesh.DOUBLESIDE
  69818. * * 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)
  69819. * * 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)
  69820. * @see https://doc.babylonjs.com/how_to/set_shapes#box
  69821. * @param name defines the name of the mesh
  69822. * @param options defines the options used to create the mesh
  69823. * @param scene defines the hosting scene
  69824. * @returns the box mesh
  69825. */
  69826. static CreateTiledPlane(name: string, options: {
  69827. pattern?: number;
  69828. tileSize?: number;
  69829. tileWidth?: number;
  69830. tileHeight?: number;
  69831. size?: number;
  69832. width?: number;
  69833. height?: number;
  69834. alignHorizontal?: number;
  69835. alignVertical?: number;
  69836. sideOrientation?: number;
  69837. frontUVs?: Vector4;
  69838. backUVs?: Vector4;
  69839. updatable?: boolean;
  69840. }, scene?: Nullable<Scene>): Mesh;
  69841. }
  69842. }
  69843. declare module "babylonjs/Meshes/Builders/tubeBuilder" {
  69844. import { Nullable } from "babylonjs/types";
  69845. import { Scene } from "babylonjs/scene";
  69846. import { Vector3, Vector4 } from "babylonjs/Maths/math.vector";
  69847. import { Mesh } from "babylonjs/Meshes/mesh";
  69848. /**
  69849. * Class containing static functions to help procedurally build meshes
  69850. */
  69851. export class TubeBuilder {
  69852. /**
  69853. * Creates a tube mesh.
  69854. * The tube is a parametric shape. It has no predefined shape. Its final shape will depend on the input parameters
  69855. * * The parameter `path` is a required array of successive Vector3. It is the curve used as the axis of the tube
  69856. * * The parameter `radius` (positive float, default 1) sets the tube radius size
  69857. * * The parameter `tessellation` (positive float, default 64) is the number of sides on the tubular surface
  69858. * * The parameter `radiusFunction` (javascript function, default null) is a vanilla javascript function. If it is not null, it overwrittes the parameter `radius`
  69859. * * 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)
  69860. * * The parameter `arc` (positive float, maximum 1, default 1) is the ratio to apply to the tube circumference : 2 x PI x arc
  69861. * * 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
  69862. * * 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
  69863. * * You can also set the mesh side orientation with the values : BABYLON.Mesh.FRONTSIDE (default), BABYLON.Mesh.BACKSIDE or BABYLON.Mesh.DOUBLESIDE
  69864. * * If you create a double-sided mesh, you can choose what parts of the texture image to crop and stick respectively on the front and the back sides with the parameters `frontUVs` and `backUVs` (Vector4). Detail here : https://doc.babylonjs.com/babylon101/discover_basic_elements#side-orientation
  69865. * * The optional parameter `invertUV` (boolean, default false) swaps in the geometry the U and V coordinates to apply a texture
  69866. * * The mesh can be set to updatable with the boolean parameter `updatable` (default false) if its internal geometry is supposed to change once created
  69867. * @param name defines the name of the mesh
  69868. * @param options defines the options used to create the mesh
  69869. * @param scene defines the hosting scene
  69870. * @returns the tube mesh
  69871. * @see https://doc.babylonjs.com/how_to/parametric_shapes
  69872. * @see https://doc.babylonjs.com/how_to/set_shapes#tube
  69873. */
  69874. static CreateTube(name: string, options: {
  69875. path: Vector3[];
  69876. radius?: number;
  69877. tessellation?: number;
  69878. radiusFunction?: {
  69879. (i: number, distance: number): number;
  69880. };
  69881. cap?: number;
  69882. arc?: number;
  69883. updatable?: boolean;
  69884. sideOrientation?: number;
  69885. frontUVs?: Vector4;
  69886. backUVs?: Vector4;
  69887. instance?: Mesh;
  69888. invertUV?: boolean;
  69889. }, scene?: Nullable<Scene>): Mesh;
  69890. }
  69891. }
  69892. declare module "babylonjs/Meshes/Builders/icoSphereBuilder" {
  69893. import { Scene } from "babylonjs/scene";
  69894. import { Vector4 } from "babylonjs/Maths/math.vector";
  69895. import { Mesh } from "babylonjs/Meshes/mesh";
  69896. import { Nullable } from "babylonjs/types";
  69897. /**
  69898. * Class containing static functions to help procedurally build meshes
  69899. */
  69900. export class IcoSphereBuilder {
  69901. /**
  69902. * Creates a sphere based upon an icosahedron with 20 triangular faces which can be subdivided
  69903. * * The parameter `radius` sets the radius size (float) of the icosphere (default 1)
  69904. * * 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`)
  69905. * * The parameter `subdivisions` sets the number of subdivisions (postive integer, default 4). The more subdivisions, the more faces on the icosphere whatever its size
  69906. * * 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
  69907. * * You can also set the mesh side orientation with the values : BABYLON.Mesh.FRONTSIDE (default), BABYLON.Mesh.BACKSIDE or BABYLON.Mesh.DOUBLESIDE
  69908. * * If you create a double-sided mesh, you can choose what parts of the texture image to crop and stick respectively on the front and the back sides with the parameters `frontUVs` and `backUVs` (Vector4). Detail here : https://doc.babylonjs.com/babylon101/discover_basic_elements#side-orientation
  69909. * * The mesh can be set to updatable with the boolean parameter `updatable` (default false) if its internal geometry is supposed to change once created
  69910. * @param name defines the name of the mesh
  69911. * @param options defines the options used to create the mesh
  69912. * @param scene defines the hosting scene
  69913. * @returns the icosahedron mesh
  69914. * @see https://doc.babylonjs.com/how_to/polyhedra_shapes#icosphere
  69915. */
  69916. static CreateIcoSphere(name: string, options: {
  69917. radius?: number;
  69918. radiusX?: number;
  69919. radiusY?: number;
  69920. radiusZ?: number;
  69921. flat?: boolean;
  69922. subdivisions?: number;
  69923. sideOrientation?: number;
  69924. frontUVs?: Vector4;
  69925. backUVs?: Vector4;
  69926. updatable?: boolean;
  69927. }, scene?: Nullable<Scene>): Mesh;
  69928. }
  69929. }
  69930. declare module "babylonjs/Meshes/Builders/decalBuilder" {
  69931. import { Vector3 } from "babylonjs/Maths/math.vector";
  69932. import { Mesh } from "babylonjs/Meshes/mesh";
  69933. import { AbstractMesh } from "babylonjs/Meshes/abstractMesh";
  69934. /**
  69935. * Class containing static functions to help procedurally build meshes
  69936. */
  69937. export class DecalBuilder {
  69938. /**
  69939. * Creates a decal mesh.
  69940. * 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
  69941. * * The parameter `position` (Vector3, default `(0, 0, 0)`) sets the position of the decal in World coordinates
  69942. * * The parameter `normal` (Vector3, default `Vector3.Up`) sets the normal of the mesh where the decal is applied onto in World coordinates
  69943. * * The parameter `size` (Vector3, default `(1, 1, 1)`) sets the decal scaling
  69944. * * The parameter `angle` (float in radian, default 0) sets the angle to rotate the decal
  69945. * @param name defines the name of the mesh
  69946. * @param sourceMesh defines the mesh where the decal must be applied
  69947. * @param options defines the options used to create the mesh
  69948. * @param scene defines the hosting scene
  69949. * @returns the decal mesh
  69950. * @see https://doc.babylonjs.com/how_to/decals
  69951. */
  69952. static CreateDecal(name: string, sourceMesh: AbstractMesh, options: {
  69953. position?: Vector3;
  69954. normal?: Vector3;
  69955. size?: Vector3;
  69956. angle?: number;
  69957. }): Mesh;
  69958. }
  69959. }
  69960. declare module "babylonjs/Meshes/meshBuilder" {
  69961. import { ICreateCapsuleOptions } from "babylonjs/Meshes/Builders/capsuleBuilder";
  69962. import { Vector4, Vector3, Vector2 } from "babylonjs/Maths/math.vector";
  69963. import { Nullable } from "babylonjs/types";
  69964. import { Scene } from "babylonjs/scene";
  69965. import { Mesh } from "babylonjs/Meshes/mesh";
  69966. import { LinesMesh } from "babylonjs/Meshes/linesMesh";
  69967. import { GroundMesh } from "babylonjs/Meshes/groundMesh";
  69968. import { AbstractMesh } from "babylonjs/Meshes/abstractMesh";
  69969. import { Color4, Color3 } from "babylonjs/Maths/math.color";
  69970. import { Plane } from "babylonjs/Maths/math.plane";
  69971. /**
  69972. * Class containing static functions to help procedurally build meshes
  69973. */
  69974. export class MeshBuilder {
  69975. /**
  69976. * Creates a box mesh
  69977. * * The parameter `size` sets the size (float) of each box side (default 1)
  69978. * * You can set some different box dimensions by using the parameters `width`, `height` and `depth` (all by default have the same value of `size`)
  69979. * * 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)
  69980. * * Please read this tutorial : https://doc.babylonjs.com/how_to/createbox_per_face_textures_and_colors
  69981. * * You can also set the mesh side orientation with the values : BABYLON.Mesh.FRONTSIDE (default), BABYLON.Mesh.BACKSIDE or BABYLON.Mesh.DOUBLESIDE
  69982. * * If you create a double-sided mesh, you can choose what parts of the texture image to crop and stick respectively on the front and the back sides with the parameters `frontUVs` and `backUVs` (Vector4). Detail here : https://doc.babylonjs.com/babylon101/discover_basic_elements#side-orientation
  69983. * * The mesh can be set to updatable with the boolean parameter `updatable` (default false) if its internal geometry is supposed to change once created
  69984. * @see https://doc.babylonjs.com/how_to/set_shapes#box
  69985. * @param name defines the name of the mesh
  69986. * @param options defines the options used to create the mesh
  69987. * @param scene defines the hosting scene
  69988. * @returns the box mesh
  69989. */
  69990. static CreateBox(name: string, options: {
  69991. size?: number;
  69992. width?: number;
  69993. height?: number;
  69994. depth?: number;
  69995. faceUV?: Vector4[];
  69996. faceColors?: Color4[];
  69997. sideOrientation?: number;
  69998. frontUVs?: Vector4;
  69999. backUVs?: Vector4;
  70000. wrap?: boolean;
  70001. topBaseAt?: number;
  70002. bottomBaseAt?: number;
  70003. updatable?: boolean;
  70004. }, scene?: Nullable<Scene>): Mesh;
  70005. /**
  70006. * Creates a tiled box mesh
  70007. * * faceTiles sets the pattern, tile size and number of tiles for a face
  70008. * * The mesh can be set to updatable with the boolean parameter `updatable` (default false) if its internal geometry is supposed to change once created
  70009. * @param name defines the name of the mesh
  70010. * @param options defines the options used to create the mesh
  70011. * @param scene defines the hosting scene
  70012. * @returns the tiled box mesh
  70013. */
  70014. static CreateTiledBox(name: string, options: {
  70015. pattern?: number;
  70016. size?: number;
  70017. width?: number;
  70018. height?: number;
  70019. depth: number;
  70020. tileSize?: number;
  70021. tileWidth?: number;
  70022. tileHeight?: number;
  70023. faceUV?: Vector4[];
  70024. faceColors?: Color4[];
  70025. alignHorizontal?: number;
  70026. alignVertical?: number;
  70027. sideOrientation?: number;
  70028. updatable?: boolean;
  70029. }, scene?: Nullable<Scene>): Mesh;
  70030. /**
  70031. * Creates a sphere mesh
  70032. * * The parameter `diameter` sets the diameter size (float) of the sphere (default 1)
  70033. * * 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`)
  70034. * * The parameter `segments` sets the sphere number of horizontal stripes (positive integer, default 32)
  70035. * * 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
  70036. * * 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)
  70037. * * You can also set the mesh side orientation with the values : BABYLON.Mesh.FRONTSIDE (default), BABYLON.Mesh.BACKSIDE or BABYLON.Mesh.DOUBLESIDE
  70038. * * If you create a double-sided mesh, you can choose what parts of the texture image to crop and stick respectively on the front and the back sides with the parameters `frontUVs` and `backUVs` (Vector4). Detail here : https://doc.babylonjs.com/babylon101/discover_basic_elements#side-orientation
  70039. * * The mesh can be set to updatable with the boolean parameter `updatable` (default false) if its internal geometry is supposed to change once created
  70040. * @param name defines the name of the mesh
  70041. * @param options defines the options used to create the mesh
  70042. * @param scene defines the hosting scene
  70043. * @returns the sphere mesh
  70044. * @see https://doc.babylonjs.com/how_to/set_shapes#sphere
  70045. */
  70046. static CreateSphere(name: string, options: {
  70047. segments?: number;
  70048. diameter?: number;
  70049. diameterX?: number;
  70050. diameterY?: number;
  70051. diameterZ?: number;
  70052. arc?: number;
  70053. slice?: number;
  70054. sideOrientation?: number;
  70055. frontUVs?: Vector4;
  70056. backUVs?: Vector4;
  70057. updatable?: boolean;
  70058. }, scene?: Nullable<Scene>): Mesh;
  70059. /**
  70060. * Creates a plane polygonal mesh. By default, this is a disc
  70061. * * The parameter `radius` sets the radius size (float) of the polygon (default 0.5)
  70062. * * 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
  70063. * * 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
  70064. * * You can also set the mesh side orientation with the values : BABYLON.Mesh.FRONTSIDE (default), BABYLON.Mesh.BACKSIDE or BABYLON.Mesh.DOUBLESIDE
  70065. * * If you create a double-sided mesh, you can choose what parts of the texture image to crop and stick respectively on the front and the back sides with the parameters `frontUVs` and `backUVs` (Vector4). Detail here : https://doc.babylonjs.com/babylon101/discover_basic_elements#side-orientation
  70066. * * The mesh can be set to updatable with the boolean parameter `updatable` (default false) if its internal geometry is supposed to change once created
  70067. * @param name defines the name of the mesh
  70068. * @param options defines the options used to create the mesh
  70069. * @param scene defines the hosting scene
  70070. * @returns the plane polygonal mesh
  70071. * @see https://doc.babylonjs.com/how_to/set_shapes#disc-or-regular-polygon
  70072. */
  70073. static CreateDisc(name: string, options: {
  70074. radius?: number;
  70075. tessellation?: number;
  70076. arc?: number;
  70077. updatable?: boolean;
  70078. sideOrientation?: number;
  70079. frontUVs?: Vector4;
  70080. backUVs?: Vector4;
  70081. }, scene?: Nullable<Scene>): Mesh;
  70082. /**
  70083. * Creates a sphere based upon an icosahedron with 20 triangular faces which can be subdivided
  70084. * * The parameter `radius` sets the radius size (float) of the icosphere (default 1)
  70085. * * 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`)
  70086. * * The parameter `subdivisions` sets the number of subdivisions (postive integer, default 4). The more subdivisions, the more faces on the icosphere whatever its size
  70087. * * 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
  70088. * * You can also set the mesh side orientation with the values : BABYLON.Mesh.FRONTSIDE (default), BABYLON.Mesh.BACKSIDE or BABYLON.Mesh.DOUBLESIDE
  70089. * * If you create a double-sided mesh, you can choose what parts of the texture image to crop and stick respectively on the front and the back sides with the parameters `frontUVs` and `backUVs` (Vector4). Detail here : https://doc.babylonjs.com/babylon101/discover_basic_elements#side-orientation
  70090. * * The mesh can be set to updatable with the boolean parameter `updatable` (default false) if its internal geometry is supposed to change once created
  70091. * @param name defines the name of the mesh
  70092. * @param options defines the options used to create the mesh
  70093. * @param scene defines the hosting scene
  70094. * @returns the icosahedron mesh
  70095. * @see https://doc.babylonjs.com/how_to/polyhedra_shapes#icosphere
  70096. */
  70097. static CreateIcoSphere(name: string, options: {
  70098. radius?: number;
  70099. radiusX?: number;
  70100. radiusY?: number;
  70101. radiusZ?: number;
  70102. flat?: boolean;
  70103. subdivisions?: number;
  70104. sideOrientation?: number;
  70105. frontUVs?: Vector4;
  70106. backUVs?: Vector4;
  70107. updatable?: boolean;
  70108. }, scene?: Nullable<Scene>): Mesh;
  70109. /**
  70110. * Creates a ribbon mesh. The ribbon is a parametric shape. It has no predefined shape. Its final shape will depend on the input parameters
  70111. * * The parameter `pathArray` is a required array of paths, what are each an array of successive Vector3. The pathArray parameter depicts the ribbon geometry
  70112. * * The parameter `closeArray` (boolean, default false) creates a seam between the first and the last paths of the path array
  70113. * * The parameter `closePath` (boolean, default false) creates a seam between the first and the last points of each path of the path array
  70114. * * 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
  70115. * * 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
  70116. * * 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
  70117. * * You can also set the mesh side orientation with the values : BABYLON.Mesh.FRONTSIDE (default), BABYLON.Mesh.BACKSIDE or BABYLON.Mesh.DOUBLESIDE
  70118. * * If you create a double-sided mesh, you can choose what parts of the texture image to crop and stick respectively on the front and the back sides with the parameters `frontUVs` and `backUVs` (Vector4). Detail here : https://doc.babylonjs.com/babylon101/discover_basic_elements#side-orientation
  70119. * * The optional parameter `invertUV` (boolean, default false) swaps in the geometry the U and V coordinates to apply a texture
  70120. * * 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
  70121. * * The parameters `colors` is an optional flat array of `Color4` to set/update each ribbon vertex with its own custom color values
  70122. * * 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
  70123. * * Moreover, you can use the parameter `color` with `instance` (to update the ribbon), only if you previously used it at creation time
  70124. * * The mesh can be set to updatable with the boolean parameter `updatable` (default false) if its internal geometry is supposed to change once created
  70125. * @param name defines the name of the mesh
  70126. * @param options defines the options used to create the mesh
  70127. * @param scene defines the hosting scene
  70128. * @returns the ribbon mesh
  70129. * @see https://doc.babylonjs.com/how_to/ribbon_tutorial
  70130. * @see https://doc.babylonjs.com/how_to/parametric_shapes
  70131. */
  70132. static CreateRibbon(name: string, options: {
  70133. pathArray: Vector3[][];
  70134. closeArray?: boolean;
  70135. closePath?: boolean;
  70136. offset?: number;
  70137. updatable?: boolean;
  70138. sideOrientation?: number;
  70139. frontUVs?: Vector4;
  70140. backUVs?: Vector4;
  70141. instance?: Mesh;
  70142. invertUV?: boolean;
  70143. uvs?: Vector2[];
  70144. colors?: Color4[];
  70145. }, scene?: Nullable<Scene>): Mesh;
  70146. /**
  70147. * Creates a cylinder or a cone mesh
  70148. * * The parameter `height` sets the height size (float) of the cylinder/cone (float, default 2).
  70149. * * The parameter `diameter` sets the diameter of the top and bottom cap at once (float, default 1).
  70150. * * 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.
  70151. * * The parameter `tessellation` sets the number of cylinder sides (positive integer, default 24). Set it to 3 to get a prism for instance.
  70152. * * The parameter `subdivisions` sets the number of rings along the cylinder height (positive integer, default 1).
  70153. * * The parameter `hasRings` (boolean, default false) makes the subdivisions independent from each other, so they become different faces.
  70154. * * The parameter `enclose` (boolean, default false) adds two extra faces per subdivision to a sliced cylinder to close it around its height axis.
  70155. * * 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).
  70156. * * The parameter `arc` (float, default 1) is the ratio (max 1) to apply to the circumference to slice the cylinder.
  70157. * * 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).
  70158. * * 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
  70159. * * Now, if the cylinder has 5 independent subdivisions (hasRings = true), n equals : top face + 5 stripe surfaces + bottom face = 2 + 5 = 7
  70160. * * 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
  70161. * * 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.
  70162. * * If `enclose` is false, a ring surface is one element.
  70163. * * If `enclose` is true, a ring surface is 3 successive elements in the array : the tubular surface, then the two closing faces.
  70164. * * 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
  70165. * * You can also set the mesh side orientation with the values : BABYLON.Mesh.FRONTSIDE (default), BABYLON.Mesh.BACKSIDE or BABYLON.Mesh.DOUBLESIDE
  70166. * * If you create a double-sided mesh, you can choose what parts of the texture image to crop and stick respectively on the front and the back sides with the parameters `frontUVs` and `backUVs` (Vector4). Detail here : https://doc.babylonjs.com/babylon101/discover_basic_elements#side-orientation
  70167. * * The mesh can be set to updatable with the boolean parameter `updatable` (default false) if its internal geometry is supposed to change once created.
  70168. * @param name defines the name of the mesh
  70169. * @param options defines the options used to create the mesh
  70170. * @param scene defines the hosting scene
  70171. * @returns the cylinder mesh
  70172. * @see https://doc.babylonjs.com/how_to/set_shapes#cylinder-or-cone
  70173. */
  70174. static CreateCylinder(name: string, options: {
  70175. height?: number;
  70176. diameterTop?: number;
  70177. diameterBottom?: number;
  70178. diameter?: number;
  70179. tessellation?: number;
  70180. subdivisions?: number;
  70181. arc?: number;
  70182. faceColors?: Color4[];
  70183. faceUV?: Vector4[];
  70184. updatable?: boolean;
  70185. hasRings?: boolean;
  70186. enclose?: boolean;
  70187. cap?: number;
  70188. sideOrientation?: number;
  70189. frontUVs?: Vector4;
  70190. backUVs?: Vector4;
  70191. }, scene?: Nullable<Scene>): Mesh;
  70192. /**
  70193. * Creates a torus mesh
  70194. * * The parameter `diameter` sets the diameter size (float) of the torus (default 1)
  70195. * * The parameter `thickness` sets the diameter size of the tube of the torus (float, default 0.5)
  70196. * * The parameter `tessellation` sets the number of torus sides (postive integer, default 16)
  70197. * * You can also set the mesh side orientation with the values : BABYLON.Mesh.FRONTSIDE (default), BABYLON.Mesh.BACKSIDE or BABYLON.Mesh.DOUBLESIDE
  70198. * * If you create a double-sided mesh, you can choose what parts of the texture image to crop and stick respectively on the front and the back sides with the parameters `frontUVs` and `backUVs` (Vector4). Detail here : https://doc.babylonjs.com/babylon101/discover_basic_elements#side-orientation
  70199. * * The mesh can be set to updatable with the boolean parameter `updatable` (default false) if its internal geometry is supposed to change once created.
  70200. * @param name defines the name of the mesh
  70201. * @param options defines the options used to create the mesh
  70202. * @param scene defines the hosting scene
  70203. * @returns the torus mesh
  70204. * @see https://doc.babylonjs.com/how_to/set_shapes#torus
  70205. */
  70206. static CreateTorus(name: string, options: {
  70207. diameter?: number;
  70208. thickness?: number;
  70209. tessellation?: number;
  70210. updatable?: boolean;
  70211. sideOrientation?: number;
  70212. frontUVs?: Vector4;
  70213. backUVs?: Vector4;
  70214. }, scene?: Nullable<Scene>): Mesh;
  70215. /**
  70216. * Creates a torus knot mesh
  70217. * * The parameter `radius` sets the global radius size (float) of the torus knot (default 2)
  70218. * * The parameter `radialSegments` sets the number of sides on each tube segments (positive integer, default 32)
  70219. * * The parameter `tubularSegments` sets the number of tubes to decompose the knot into (positive integer, default 32)
  70220. * * The parameters `p` and `q` are the number of windings on each axis (positive integers, default 2 and 3)
  70221. * * You can also set the mesh side orientation with the values : BABYLON.Mesh.FRONTSIDE (default), BABYLON.Mesh.BACKSIDE or BABYLON.Mesh.DOUBLESIDE
  70222. * * If you create a double-sided mesh, you can choose what parts of the texture image to crop and stick respectively on the front and the back sides with the parameters `frontUVs` and `backUVs` (Vector4). Detail here : https://doc.babylonjs.com/babylon101/discover_basic_elements#side-orientation
  70223. * * The mesh can be set to updatable with the boolean parameter `updatable` (default false) if its internal geometry is supposed to change once created.
  70224. * @param name defines the name of the mesh
  70225. * @param options defines the options used to create the mesh
  70226. * @param scene defines the hosting scene
  70227. * @returns the torus knot mesh
  70228. * @see https://doc.babylonjs.com/how_to/set_shapes#torus-knot
  70229. */
  70230. static CreateTorusKnot(name: string, options: {
  70231. radius?: number;
  70232. tube?: number;
  70233. radialSegments?: number;
  70234. tubularSegments?: number;
  70235. p?: number;
  70236. q?: number;
  70237. updatable?: boolean;
  70238. sideOrientation?: number;
  70239. frontUVs?: Vector4;
  70240. backUVs?: Vector4;
  70241. }, scene?: Nullable<Scene>): Mesh;
  70242. /**
  70243. * Creates a line system mesh. A line system is a pool of many lines gathered in a single mesh
  70244. * * 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
  70245. * * Like every other parametric shape, it is dynamically updatable by passing an existing instance of LineSystem to this static function
  70246. * * The parameter `lines` is an array of lines, each line being an array of successive Vector3
  70247. * * The optional parameter `instance` is an instance of an existing LineSystem object to be updated with the passed `lines` parameter
  70248. * * The optional parameter `colors` is an array of line colors, each line colors being an array of successive Color4, one per line point
  70249. * * The optional parameter `useVertexAlpha` is to be set to `false` (default `true`) when you don't need the alpha blending (faster)
  70250. * * 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
  70251. * * When updating an instance, remember that only line point positions can change, not the number of points, neither the number of lines
  70252. * * The mesh can be set to updatable with the boolean parameter `updatable` (default false) if its internal geometry is supposed to change once created
  70253. * @see https://doc.babylonjs.com/how_to/parametric_shapes#line-system
  70254. * @param name defines the name of the new line system
  70255. * @param options defines the options used to create the line system
  70256. * @param scene defines the hosting scene
  70257. * @returns a new line system mesh
  70258. */
  70259. static CreateLineSystem(name: string, options: {
  70260. lines: Vector3[][];
  70261. updatable?: boolean;
  70262. instance?: Nullable<LinesMesh>;
  70263. colors?: Nullable<Color4[][]>;
  70264. useVertexAlpha?: boolean;
  70265. }, scene: Nullable<Scene>): LinesMesh;
  70266. /**
  70267. * Creates a line mesh
  70268. * 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
  70269. * * Like every other parametric shape, it is dynamically updatable by passing an existing instance of LineMesh to this static function
  70270. * * The parameter `points` is an array successive Vector3
  70271. * * 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
  70272. * * The optional parameter `colors` is an array of successive Color4, one per line point
  70273. * * The optional parameter `useVertexAlpha` is to be set to `false` (default `true`) when you don't need alpha blending (faster)
  70274. * * When updating an instance, remember that only point positions can change, not the number of points
  70275. * * The mesh can be set to updatable with the boolean parameter `updatable` (default false) if its internal geometry is supposed to change once created
  70276. * @see https://doc.babylonjs.com/how_to/parametric_shapes#lines
  70277. * @param name defines the name of the new line system
  70278. * @param options defines the options used to create the line system
  70279. * @param scene defines the hosting scene
  70280. * @returns a new line mesh
  70281. */
  70282. static CreateLines(name: string, options: {
  70283. points: Vector3[];
  70284. updatable?: boolean;
  70285. instance?: Nullable<LinesMesh>;
  70286. colors?: Color4[];
  70287. useVertexAlpha?: boolean;
  70288. }, scene?: Nullable<Scene>): LinesMesh;
  70289. /**
  70290. * Creates a dashed line mesh
  70291. * * 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
  70292. * * Like every other parametric shape, it is dynamically updatable by passing an existing instance of LineMesh to this static function
  70293. * * The parameter `points` is an array successive Vector3
  70294. * * The parameter `dashNb` is the intended total number of dashes (positive integer, default 200)
  70295. * * The parameter `dashSize` is the size of the dashes relatively the dash number (positive float, default 3)
  70296. * * The parameter `gapSize` is the size of the gap between two successive dashes relatively the dash number (positive float, default 1)
  70297. * * 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
  70298. * * When updating an instance, remember that only point positions can change, not the number of points
  70299. * * The mesh can be set to updatable with the boolean parameter `updatable` (default false) if its internal geometry is supposed to change once created
  70300. * @param name defines the name of the mesh
  70301. * @param options defines the options used to create the mesh
  70302. * @param scene defines the hosting scene
  70303. * @returns the dashed line mesh
  70304. * @see https://doc.babylonjs.com/how_to/parametric_shapes#dashed-lines
  70305. */
  70306. static CreateDashedLines(name: string, options: {
  70307. points: Vector3[];
  70308. dashSize?: number;
  70309. gapSize?: number;
  70310. dashNb?: number;
  70311. updatable?: boolean;
  70312. instance?: LinesMesh;
  70313. }, scene?: Nullable<Scene>): LinesMesh;
  70314. /**
  70315. * 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.
  70316. * * 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.
  70317. * * The parameter `path` is a required array of successive Vector3. This is the axis curve the shape is extruded along.
  70318. * * 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.
  70319. * * The parameter `scale` (float, default 1) is the value to scale the shape.
  70320. * * 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
  70321. * * 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
  70322. * * Remember you can only change the shape or path point positions, not their number when updating an extruded shape.
  70323. * * You can also set the mesh side orientation with the values : BABYLON.Mesh.FRONTSIDE (default), BABYLON.Mesh.BACKSIDE or BABYLON.Mesh.DOUBLESIDE
  70324. * * If you create a double-sided mesh, you can choose what parts of the texture image to crop and stick respectively on the front and the back sides with the parameters `frontUVs` and `backUVs` (Vector4). Detail here : https://doc.babylonjs.com/babylon101/discover_basic_elements#side-orientation
  70325. * * The optional parameter `invertUV` (boolean, default false) swaps in the geometry the U and V coordinates to apply a texture.
  70326. * * The mesh can be set to updatable with the boolean parameter `updatable` (default false) if its internal geometry is supposed to change once created.
  70327. * @param name defines the name of the mesh
  70328. * @param options defines the options used to create the mesh
  70329. * @param scene defines the hosting scene
  70330. * @returns the extruded shape mesh
  70331. * @see https://doc.babylonjs.com/how_to/parametric_shapes
  70332. * @see https://doc.babylonjs.com/how_to/parametric_shapes#extruded-shapes
  70333. */
  70334. static ExtrudeShape(name: string, options: {
  70335. shape: Vector3[];
  70336. path: Vector3[];
  70337. scale?: number;
  70338. rotation?: number;
  70339. cap?: number;
  70340. updatable?: boolean;
  70341. sideOrientation?: number;
  70342. frontUVs?: Vector4;
  70343. backUVs?: Vector4;
  70344. instance?: Mesh;
  70345. invertUV?: boolean;
  70346. }, scene?: Nullable<Scene>): Mesh;
  70347. /**
  70348. * Creates an custom extruded shape mesh.
  70349. * The custom extrusion is a parametric shape. It has no predefined shape. Its final shape will depend on the input parameters.
  70350. * * 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.
  70351. * * The parameter `path` is a required array of successive Vector3. This is the axis curve the shape is extruded along.
  70352. * * 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
  70353. * * It must returns a float value that will be the rotation in radians applied to the shape on each path point.
  70354. * * 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
  70355. * * It must returns a float value that will be the scale value applied to the shape on each path point
  70356. * * The parameter `ribbonClosePath` (boolean, default false) forces the extrusion underlying ribbon to close all the paths in its `pathArray`
  70357. * * The parameter `ribbonCloseArray` (boolean, default false) forces the extrusion underlying ribbon to close its `pathArray`
  70358. * * 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
  70359. * * 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
  70360. * * Remember you can only change the shape or path point positions, not their number when updating an extruded shape
  70361. * * You can also set the mesh side orientation with the values : BABYLON.Mesh.FRONTSIDE (default), BABYLON.Mesh.BACKSIDE or BABYLON.Mesh.DOUBLESIDE
  70362. * * If you create a double-sided mesh, you can choose what parts of the texture image to crop and stick respectively on the front and the back sides with the parameters `frontUVs` and `backUVs` (Vector4). Detail here : https://doc.babylonjs.com/babylon101/discover_basic_elements#side-orientation
  70363. * * The optional parameter `invertUV` (boolean, default false) swaps in the geometry the U and V coordinates to apply a texture
  70364. * * The mesh can be set to updatable with the boolean parameter `updatable` (default false) if its internal geometry is supposed to change once created
  70365. * @param name defines the name of the mesh
  70366. * @param options defines the options used to create the mesh
  70367. * @param scene defines the hosting scene
  70368. * @returns the custom extruded shape mesh
  70369. * @see https://doc.babylonjs.com/how_to/parametric_shapes#custom-extruded-shapes
  70370. * @see https://doc.babylonjs.com/how_to/parametric_shapes
  70371. * @see https://doc.babylonjs.com/how_to/parametric_shapes#extruded-shapes
  70372. */
  70373. static ExtrudeShapeCustom(name: string, options: {
  70374. shape: Vector3[];
  70375. path: Vector3[];
  70376. scaleFunction?: any;
  70377. rotationFunction?: any;
  70378. ribbonCloseArray?: boolean;
  70379. ribbonClosePath?: boolean;
  70380. cap?: number;
  70381. updatable?: boolean;
  70382. sideOrientation?: number;
  70383. frontUVs?: Vector4;
  70384. backUVs?: Vector4;
  70385. instance?: Mesh;
  70386. invertUV?: boolean;
  70387. }, scene?: Nullable<Scene>): Mesh;
  70388. /**
  70389. * Creates lathe mesh.
  70390. * The lathe is a shape with a symetry axis : a 2D model shape is rotated around this axis to design the lathe
  70391. * * 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
  70392. * * The parameter `radius` (positive float, default 1) is the radius value of the lathe
  70393. * * The parameter `tessellation` (positive integer, default 64) is the side number of the lathe
  70394. * * The parameter `clip` (positive integer, default 0) is the number of sides to not create without effecting the general shape of the sides
  70395. * * 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
  70396. * * The parameter `closed` (boolean, default true) opens/closes the lathe circumference. This should be set to false when used with the parameter "arc"
  70397. * * 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
  70398. * * You can also set the mesh side orientation with the values : BABYLON.Mesh.FRONTSIDE (default), BABYLON.Mesh.BACKSIDE or BABYLON.Mesh.DOUBLESIDE
  70399. * * If you create a double-sided mesh, you can choose what parts of the texture image to crop and stick respectively on the front and the back sides with the parameters `frontUVs` and `backUVs` (Vector4). Detail here : https://doc.babylonjs.com/babylon101/discover_basic_elements#side-orientation
  70400. * * The optional parameter `invertUV` (boolean, default false) swaps in the geometry the U and V coordinates to apply a texture
  70401. * * The mesh can be set to updatable with the boolean parameter `updatable` (default false) if its internal geometry is supposed to change once created
  70402. * @param name defines the name of the mesh
  70403. * @param options defines the options used to create the mesh
  70404. * @param scene defines the hosting scene
  70405. * @returns the lathe mesh
  70406. * @see https://doc.babylonjs.com/how_to/parametric_shapes#lathe
  70407. */
  70408. static CreateLathe(name: string, options: {
  70409. shape: Vector3[];
  70410. radius?: number;
  70411. tessellation?: number;
  70412. clip?: number;
  70413. arc?: number;
  70414. closed?: boolean;
  70415. updatable?: boolean;
  70416. sideOrientation?: number;
  70417. frontUVs?: Vector4;
  70418. backUVs?: Vector4;
  70419. cap?: number;
  70420. invertUV?: boolean;
  70421. }, scene?: Nullable<Scene>): Mesh;
  70422. /**
  70423. * Creates a tiled plane mesh
  70424. * * You can set a limited pattern arrangement with the tiles
  70425. * * You can also set the mesh side orientation with the values : BABYLON.Mesh.FRONTSIDE (default), BABYLON.Mesh.BACKSIDE or BABYLON.Mesh.DOUBLESIDE
  70426. * * If you create a double-sided mesh, you can choose what parts of the texture image to crop and stick respectively on the front and the back sides with the parameters `frontUVs` and `backUVs` (Vector4). Detail here : https://doc.babylonjs.com/babylon101/discover_basic_elements#side-orientation
  70427. * * The mesh can be set to updatable with the boolean parameter `updatable` (default false) if its internal geometry is supposed to change once created
  70428. * @param name defines the name of the mesh
  70429. * @param options defines the options used to create the mesh
  70430. * @param scene defines the hosting scene
  70431. * @returns the plane mesh
  70432. * @see https://doc.babylonjs.com/how_to/set_shapes#plane
  70433. */
  70434. static CreateTiledPlane(name: string, options: {
  70435. pattern?: number;
  70436. tileSize?: number;
  70437. tileWidth?: number;
  70438. tileHeight?: number;
  70439. size?: number;
  70440. width?: number;
  70441. height?: number;
  70442. alignHorizontal?: number;
  70443. alignVertical?: number;
  70444. sideOrientation?: number;
  70445. frontUVs?: Vector4;
  70446. backUVs?: Vector4;
  70447. updatable?: boolean;
  70448. }, scene?: Nullable<Scene>): Mesh;
  70449. /**
  70450. * Creates a plane mesh
  70451. * * The parameter `size` sets the size (float) of both sides of the plane at once (default 1)
  70452. * * You can set some different plane dimensions by using the parameters `width` and `height` (both by default have the same value of `size`)
  70453. * * The parameter `sourcePlane` is a Plane instance. It builds a mesh plane from a Math plane
  70454. * * You can also set the mesh side orientation with the values : BABYLON.Mesh.FRONTSIDE (default), BABYLON.Mesh.BACKSIDE or BABYLON.Mesh.DOUBLESIDE
  70455. * * If you create a double-sided mesh, you can choose what parts of the texture image to crop and stick respectively on the front and the back sides with the parameters `frontUVs` and `backUVs` (Vector4). Detail here : https://doc.babylonjs.com/babylon101/discover_basic_elements#side-orientation
  70456. * * The mesh can be set to updatable with the boolean parameter `updatable` (default false) if its internal geometry is supposed to change once created
  70457. * @param name defines the name of the mesh
  70458. * @param options defines the options used to create the mesh
  70459. * @param scene defines the hosting scene
  70460. * @returns the plane mesh
  70461. * @see https://doc.babylonjs.com/how_to/set_shapes#plane
  70462. */
  70463. static CreatePlane(name: string, options: {
  70464. size?: number;
  70465. width?: number;
  70466. height?: number;
  70467. sideOrientation?: number;
  70468. frontUVs?: Vector4;
  70469. backUVs?: Vector4;
  70470. updatable?: boolean;
  70471. sourcePlane?: Plane;
  70472. }, scene?: Nullable<Scene>): Mesh;
  70473. /**
  70474. * Creates a ground mesh
  70475. * * The parameters `width` and `height` (floats, default 1) set the width and height sizes of the ground
  70476. * * The parameter `subdivisions` (positive integer) sets the number of subdivisions per side
  70477. * * The mesh can be set to updatable with the boolean parameter `updatable` (default false) if its internal geometry is supposed to change once created
  70478. * @param name defines the name of the mesh
  70479. * @param options defines the options used to create the mesh
  70480. * @param scene defines the hosting scene
  70481. * @returns the ground mesh
  70482. * @see https://doc.babylonjs.com/how_to/set_shapes#ground
  70483. */
  70484. static CreateGround(name: string, options: {
  70485. width?: number;
  70486. height?: number;
  70487. subdivisions?: number;
  70488. subdivisionsX?: number;
  70489. subdivisionsY?: number;
  70490. updatable?: boolean;
  70491. }, scene?: Nullable<Scene>): Mesh;
  70492. /**
  70493. * Creates a tiled ground mesh
  70494. * * The parameters `xmin` and `xmax` (floats, default -1 and 1) set the ground minimum and maximum X coordinates
  70495. * * The parameters `zmin` and `zmax` (floats, default -1 and 1) set the ground minimum and maximum Z coordinates
  70496. * * 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
  70497. * * 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
  70498. * * The mesh can be set to updatable with the boolean parameter `updatable` (default false) if its internal geometry is supposed to change once created.
  70499. * @param name defines the name of the mesh
  70500. * @param options defines the options used to create the mesh
  70501. * @param scene defines the hosting scene
  70502. * @returns the tiled ground mesh
  70503. * @see https://doc.babylonjs.com/how_to/set_shapes#tiled-ground
  70504. */
  70505. static CreateTiledGround(name: string, options: {
  70506. xmin: number;
  70507. zmin: number;
  70508. xmax: number;
  70509. zmax: number;
  70510. subdivisions?: {
  70511. w: number;
  70512. h: number;
  70513. };
  70514. precision?: {
  70515. w: number;
  70516. h: number;
  70517. };
  70518. updatable?: boolean;
  70519. }, scene?: Nullable<Scene>): Mesh;
  70520. /**
  70521. * Creates a ground mesh from a height map
  70522. * * The parameter `url` sets the URL of the height map image resource.
  70523. * * The parameters `width` and `height` (positive floats, default 10) set the ground width and height sizes.
  70524. * * The parameter `subdivisions` (positive integer, default 1) sets the number of subdivision per side.
  70525. * * The parameter `minHeight` (float, default 0) is the minimum altitude on the ground.
  70526. * * The parameter `maxHeight` (float, default 1) is the maximum altitude on the ground.
  70527. * * 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.
  70528. * * 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).
  70529. * * The parameter `alphaFilter` will filter any data where the alpha channel is below this value, defaults 0 (all data visible)
  70530. * * The mesh can be set to updatable with the boolean parameter `updatable` (default false) if its internal geometry is supposed to change once created.
  70531. * @param name defines the name of the mesh
  70532. * @param url defines the url to the height map
  70533. * @param options defines the options used to create the mesh
  70534. * @param scene defines the hosting scene
  70535. * @returns the ground mesh
  70536. * @see https://doc.babylonjs.com/babylon101/height_map
  70537. * @see https://doc.babylonjs.com/how_to/set_shapes#ground-from-a-height-map
  70538. */
  70539. static CreateGroundFromHeightMap(name: string, url: string, options: {
  70540. width?: number;
  70541. height?: number;
  70542. subdivisions?: number;
  70543. minHeight?: number;
  70544. maxHeight?: number;
  70545. colorFilter?: Color3;
  70546. alphaFilter?: number;
  70547. updatable?: boolean;
  70548. onReady?: (mesh: GroundMesh) => void;
  70549. }, scene?: Nullable<Scene>): GroundMesh;
  70550. /**
  70551. * Creates a polygon mesh
  70552. * The polygon's shape will depend on the input parameters and is constructed parallel to a ground mesh
  70553. * * 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
  70554. * * You can set the mesh side orientation with the values : Mesh.FRONTSIDE (default), Mesh.BACKSIDE or Mesh.DOUBLESIDE
  70555. * * The mesh can be set to updatable with the boolean parameter `updatable` (default false) if its internal geometry is supposed to change once created
  70556. * * If you create a double-sided mesh, you can choose what parts of the texture image to crop and stick respectively on the front and the back sides with the parameters `frontUVs` and `backUVs` (Vector4)
  70557. * * Remember you can only change the shape positions, not their number when updating a polygon
  70558. * @param name defines the name of the mesh
  70559. * @param options defines the options used to create the mesh
  70560. * @param scene defines the hosting scene
  70561. * @param earcutInjection can be used to inject your own earcut reference
  70562. * @returns the polygon mesh
  70563. */
  70564. static CreatePolygon(name: string, options: {
  70565. shape: Vector3[];
  70566. holes?: Vector3[][];
  70567. depth?: number;
  70568. faceUV?: Vector4[];
  70569. faceColors?: Color4[];
  70570. updatable?: boolean;
  70571. sideOrientation?: number;
  70572. frontUVs?: Vector4;
  70573. backUVs?: Vector4;
  70574. }, scene?: Nullable<Scene>, earcutInjection?: any): Mesh;
  70575. /**
  70576. * Creates an extruded polygon mesh, with depth in the Y direction.
  70577. * * 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)
  70578. * @see https://doc.babylonjs.com/how_to/createbox_per_face_textures_and_colors
  70579. * @param name defines the name of the mesh
  70580. * @param options defines the options used to create the mesh
  70581. * @param scene defines the hosting scene
  70582. * @param earcutInjection can be used to inject your own earcut reference
  70583. * @returns the polygon mesh
  70584. */
  70585. static ExtrudePolygon(name: string, options: {
  70586. shape: Vector3[];
  70587. holes?: Vector3[][];
  70588. depth?: number;
  70589. faceUV?: Vector4[];
  70590. faceColors?: Color4[];
  70591. updatable?: boolean;
  70592. sideOrientation?: number;
  70593. frontUVs?: Vector4;
  70594. backUVs?: Vector4;
  70595. wrap?: boolean;
  70596. }, scene?: Nullable<Scene>, earcutInjection?: any): Mesh;
  70597. /**
  70598. * Creates a tube mesh.
  70599. * The tube is a parametric shape. It has no predefined shape. Its final shape will depend on the input parameters
  70600. * * The parameter `path` is a required array of successive Vector3. It is the curve used as the axis of the tube
  70601. * * The parameter `radius` (positive float, default 1) sets the tube radius size
  70602. * * The parameter `tessellation` (positive float, default 64) is the number of sides on the tubular surface
  70603. * * The parameter `radiusFunction` (javascript function, default null) is a vanilla javascript function. If it is not null, it overwrittes the parameter `radius`
  70604. * * 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)
  70605. * * The parameter `arc` (positive float, maximum 1, default 1) is the ratio to apply to the tube circumference : 2 x PI x arc
  70606. * * 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
  70607. * * 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
  70608. * * You can also set the mesh side orientation with the values : BABYLON.Mesh.FRONTSIDE (default), BABYLON.Mesh.BACKSIDE or BABYLON.Mesh.DOUBLESIDE
  70609. * * If you create a double-sided mesh, you can choose what parts of the texture image to crop and stick respectively on the front and the back sides with the parameters `frontUVs` and `backUVs` (Vector4). Detail here : https://doc.babylonjs.com/babylon101/discover_basic_elements#side-orientation
  70610. * * The optional parameter `invertUV` (boolean, default false) swaps in the geometry the U and V coordinates to apply a texture
  70611. * * The mesh can be set to updatable with the boolean parameter `updatable` (default false) if its internal geometry is supposed to change once created
  70612. * @param name defines the name of the mesh
  70613. * @param options defines the options used to create the mesh
  70614. * @param scene defines the hosting scene
  70615. * @returns the tube mesh
  70616. * @see https://doc.babylonjs.com/how_to/parametric_shapes
  70617. * @see https://doc.babylonjs.com/how_to/set_shapes#tube
  70618. */
  70619. static CreateTube(name: string, options: {
  70620. path: Vector3[];
  70621. radius?: number;
  70622. tessellation?: number;
  70623. radiusFunction?: {
  70624. (i: number, distance: number): number;
  70625. };
  70626. cap?: number;
  70627. arc?: number;
  70628. updatable?: boolean;
  70629. sideOrientation?: number;
  70630. frontUVs?: Vector4;
  70631. backUVs?: Vector4;
  70632. instance?: Mesh;
  70633. invertUV?: boolean;
  70634. }, scene?: Nullable<Scene>): Mesh;
  70635. /**
  70636. * Creates a polyhedron mesh
  70637. * * 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
  70638. * * The parameter `size` (positive float, default 1) sets the polygon size
  70639. * * You can overwrite the `size` on each dimension bu using the parameters `sizeX`, `sizeY` or `sizeZ` (positive floats, default to `size` value)
  70640. * * 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`
  70641. * * 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
  70642. * * 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)`)
  70643. * * 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
  70644. * * 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
  70645. * * You can also set the mesh side orientation with the values : BABYLON.Mesh.FRONTSIDE (default), BABYLON.Mesh.BACKSIDE or BABYLON.Mesh.DOUBLESIDE
  70646. * * If you create a double-sided mesh, you can choose what parts of the texture image to crop and stick respectively on the front and the back sides with the parameters `frontUVs` and `backUVs` (Vector4). Detail here : https://doc.babylonjs.com/babylon101/discover_basic_elements#side-orientation
  70647. * * The mesh can be set to updatable with the boolean parameter `updatable` (default false) if its internal geometry is supposed to change once created
  70648. * @param name defines the name of the mesh
  70649. * @param options defines the options used to create the mesh
  70650. * @param scene defines the hosting scene
  70651. * @returns the polyhedron mesh
  70652. * @see https://doc.babylonjs.com/how_to/polyhedra_shapes
  70653. */
  70654. static CreatePolyhedron(name: string, options: {
  70655. type?: number;
  70656. size?: number;
  70657. sizeX?: number;
  70658. sizeY?: number;
  70659. sizeZ?: number;
  70660. custom?: any;
  70661. faceUV?: Vector4[];
  70662. faceColors?: Color4[];
  70663. flat?: boolean;
  70664. updatable?: boolean;
  70665. sideOrientation?: number;
  70666. frontUVs?: Vector4;
  70667. backUVs?: Vector4;
  70668. }, scene?: Nullable<Scene>): Mesh;
  70669. /**
  70670. * Creates a decal mesh.
  70671. * 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
  70672. * * The parameter `position` (Vector3, default `(0, 0, 0)`) sets the position of the decal in World coordinates
  70673. * * The parameter `normal` (Vector3, default `Vector3.Up`) sets the normal of the mesh where the decal is applied onto in World coordinates
  70674. * * The parameter `size` (Vector3, default `(1, 1, 1)`) sets the decal scaling
  70675. * * The parameter `angle` (float in radian, default 0) sets the angle to rotate the decal
  70676. * @param name defines the name of the mesh
  70677. * @param sourceMesh defines the mesh where the decal must be applied
  70678. * @param options defines the options used to create the mesh
  70679. * @param scene defines the hosting scene
  70680. * @returns the decal mesh
  70681. * @see https://doc.babylonjs.com/how_to/decals
  70682. */
  70683. static CreateDecal(name: string, sourceMesh: AbstractMesh, options: {
  70684. position?: Vector3;
  70685. normal?: Vector3;
  70686. size?: Vector3;
  70687. angle?: number;
  70688. }): Mesh;
  70689. /**
  70690. * Creates a Capsule Mesh
  70691. * @param name defines the name of the mesh.
  70692. * @param options the constructors options used to shape the mesh.
  70693. * @param scene defines the scene the mesh is scoped to.
  70694. * @returns the capsule mesh
  70695. * @see https://doc.babylonjs.com/how_to/capsule_shape
  70696. */
  70697. static CreateCapsule(name: string, options?: ICreateCapsuleOptions, scene?: Nullable<Scene>): Mesh;
  70698. }
  70699. }
  70700. declare module "babylonjs/Meshes/meshSimplification" {
  70701. import { Mesh } from "babylonjs/Meshes/mesh";
  70702. /**
  70703. * A simplifier interface for future simplification implementations
  70704. * @see https://doc.babylonjs.com/how_to/in-browser_mesh_simplification
  70705. */
  70706. export interface ISimplifier {
  70707. /**
  70708. * Simplification of a given mesh according to the given settings.
  70709. * Since this requires computation, it is assumed that the function runs async.
  70710. * @param settings The settings of the simplification, including quality and distance
  70711. * @param successCallback A callback that will be called after the mesh was simplified.
  70712. * @param errorCallback in case of an error, this callback will be called. optional.
  70713. */
  70714. simplify(settings: ISimplificationSettings, successCallback: (simplifiedMeshes: Mesh) => void, errorCallback?: () => void): void;
  70715. }
  70716. /**
  70717. * Expected simplification settings.
  70718. * Quality should be between 0 and 1 (1 being 100%, 0 being 0%)
  70719. * @see https://doc.babylonjs.com/how_to/in-browser_mesh_simplification
  70720. */
  70721. export interface ISimplificationSettings {
  70722. /**
  70723. * Gets or sets the expected quality
  70724. */
  70725. quality: number;
  70726. /**
  70727. * Gets or sets the distance when this optimized version should be used
  70728. */
  70729. distance: number;
  70730. /**
  70731. * Gets an already optimized mesh
  70732. */
  70733. optimizeMesh?: boolean;
  70734. }
  70735. /**
  70736. * Class used to specify simplification options
  70737. * @see https://doc.babylonjs.com/how_to/in-browser_mesh_simplification
  70738. */
  70739. export class SimplificationSettings implements ISimplificationSettings {
  70740. /** expected quality */
  70741. quality: number;
  70742. /** distance when this optimized version should be used */
  70743. distance: number;
  70744. /** already optimized mesh */
  70745. optimizeMesh?: boolean | undefined;
  70746. /**
  70747. * Creates a SimplificationSettings
  70748. * @param quality expected quality
  70749. * @param distance distance when this optimized version should be used
  70750. * @param optimizeMesh already optimized mesh
  70751. */
  70752. constructor(
  70753. /** expected quality */
  70754. quality: number,
  70755. /** distance when this optimized version should be used */
  70756. distance: number,
  70757. /** already optimized mesh */
  70758. optimizeMesh?: boolean | undefined);
  70759. }
  70760. /**
  70761. * Interface used to define a simplification task
  70762. */
  70763. export interface ISimplificationTask {
  70764. /**
  70765. * Array of settings
  70766. */
  70767. settings: Array<ISimplificationSettings>;
  70768. /**
  70769. * Simplification type
  70770. */
  70771. simplificationType: SimplificationType;
  70772. /**
  70773. * Mesh to simplify
  70774. */
  70775. mesh: Mesh;
  70776. /**
  70777. * Callback called on success
  70778. */
  70779. successCallback?: () => void;
  70780. /**
  70781. * Defines if parallel processing can be used
  70782. */
  70783. parallelProcessing: boolean;
  70784. }
  70785. /**
  70786. * Queue used to order the simplification tasks
  70787. * @see https://doc.babylonjs.com/how_to/in-browser_mesh_simplification
  70788. */
  70789. export class SimplificationQueue {
  70790. private _simplificationArray;
  70791. /**
  70792. * Gets a boolean indicating that the process is still running
  70793. */
  70794. running: boolean;
  70795. /**
  70796. * Creates a new queue
  70797. */
  70798. constructor();
  70799. /**
  70800. * Adds a new simplification task
  70801. * @param task defines a task to add
  70802. */
  70803. addTask(task: ISimplificationTask): void;
  70804. /**
  70805. * Execute next task
  70806. */
  70807. executeNext(): void;
  70808. /**
  70809. * Execute a simplification task
  70810. * @param task defines the task to run
  70811. */
  70812. runSimplification(task: ISimplificationTask): void;
  70813. private getSimplifier;
  70814. }
  70815. /**
  70816. * The implemented types of simplification
  70817. * At the moment only Quadratic Error Decimation is implemented
  70818. * @see https://doc.babylonjs.com/how_to/in-browser_mesh_simplification
  70819. */
  70820. export enum SimplificationType {
  70821. /** Quadratic error decimation */
  70822. QUADRATIC = 0
  70823. }
  70824. /**
  70825. * An implementation of the Quadratic Error simplification algorithm.
  70826. * Original paper : http://www1.cs.columbia.edu/~cs4162/html05s/garland97.pdf
  70827. * Ported mostly from QSlim and http://voxels.blogspot.de/2014/05/quadric-mesh-simplification-with-source.html to babylon JS
  70828. * @author RaananW
  70829. * @see https://doc.babylonjs.com/how_to/in-browser_mesh_simplification
  70830. */
  70831. export class QuadraticErrorSimplification implements ISimplifier {
  70832. private _mesh;
  70833. private triangles;
  70834. private vertices;
  70835. private references;
  70836. private _reconstructedMesh;
  70837. /** Gets or sets the number pf sync interations */
  70838. syncIterations: number;
  70839. /** Gets or sets the aggressiveness of the simplifier */
  70840. aggressiveness: number;
  70841. /** Gets or sets the number of allowed iterations for decimation */
  70842. decimationIterations: number;
  70843. /** Gets or sets the espilon to use for bounding box computation */
  70844. boundingBoxEpsilon: number;
  70845. /**
  70846. * Creates a new QuadraticErrorSimplification
  70847. * @param _mesh defines the target mesh
  70848. */
  70849. constructor(_mesh: Mesh);
  70850. /**
  70851. * Simplification of a given mesh according to the given settings.
  70852. * Since this requires computation, it is assumed that the function runs async.
  70853. * @param settings The settings of the simplification, including quality and distance
  70854. * @param successCallback A callback that will be called after the mesh was simplified.
  70855. */
  70856. simplify(settings: ISimplificationSettings, successCallback: (simplifiedMesh: Mesh) => void): void;
  70857. private runDecimation;
  70858. private initWithMesh;
  70859. private init;
  70860. private reconstructMesh;
  70861. private initDecimatedMesh;
  70862. private isFlipped;
  70863. private updateTriangles;
  70864. private identifyBorder;
  70865. private updateMesh;
  70866. private vertexError;
  70867. private calculateError;
  70868. }
  70869. }
  70870. declare module "babylonjs/Meshes/meshSimplificationSceneComponent" {
  70871. import { Scene } from "babylonjs/scene";
  70872. import { SimplificationQueue, ISimplificationSettings, SimplificationType } from "babylonjs/Meshes/meshSimplification";
  70873. import { ISceneComponent } from "babylonjs/sceneComponent";
  70874. module "babylonjs/scene" {
  70875. interface Scene {
  70876. /** @hidden (Backing field) */
  70877. _simplificationQueue: SimplificationQueue;
  70878. /**
  70879. * Gets or sets the simplification queue attached to the scene
  70880. * @see https://doc.babylonjs.com/how_to/in-browser_mesh_simplification
  70881. */
  70882. simplificationQueue: SimplificationQueue;
  70883. }
  70884. }
  70885. module "babylonjs/Meshes/mesh" {
  70886. interface Mesh {
  70887. /**
  70888. * Simplify the mesh according to the given array of settings.
  70889. * Function will return immediately and will simplify async
  70890. * @param settings a collection of simplification settings
  70891. * @param parallelProcessing should all levels calculate parallel or one after the other
  70892. * @param simplificationType the type of simplification to run
  70893. * @param successCallback optional success callback to be called after the simplification finished processing all settings
  70894. * @returns the current mesh
  70895. */
  70896. simplify(settings: Array<ISimplificationSettings>, parallelProcessing?: boolean, simplificationType?: SimplificationType, successCallback?: (mesh?: Mesh, submeshIndex?: number) => void): Mesh;
  70897. }
  70898. }
  70899. /**
  70900. * Defines the simplification queue scene component responsible to help scheduling the various simplification task
  70901. * created in a scene
  70902. */
  70903. export class SimplicationQueueSceneComponent implements ISceneComponent {
  70904. /**
  70905. * The component name helpfull to identify the component in the list of scene components.
  70906. */
  70907. readonly name: string;
  70908. /**
  70909. * The scene the component belongs to.
  70910. */
  70911. scene: Scene;
  70912. /**
  70913. * Creates a new instance of the component for the given scene
  70914. * @param scene Defines the scene to register the component in
  70915. */
  70916. constructor(scene: Scene);
  70917. /**
  70918. * Registers the component in a given scene
  70919. */
  70920. register(): void;
  70921. /**
  70922. * Rebuilds the elements related to this component in case of
  70923. * context lost for instance.
  70924. */
  70925. rebuild(): void;
  70926. /**
  70927. * Disposes the component and the associated ressources
  70928. */
  70929. dispose(): void;
  70930. private _beforeCameraUpdate;
  70931. }
  70932. }
  70933. declare module "babylonjs/Meshes/Builders/index" {
  70934. export * from "babylonjs/Meshes/Builders/boxBuilder";
  70935. export * from "babylonjs/Meshes/Builders/tiledBoxBuilder";
  70936. export * from "babylonjs/Meshes/Builders/discBuilder";
  70937. export * from "babylonjs/Meshes/Builders/ribbonBuilder";
  70938. export * from "babylonjs/Meshes/Builders/sphereBuilder";
  70939. export * from "babylonjs/Meshes/Builders/hemisphereBuilder";
  70940. export * from "babylonjs/Meshes/Builders/cylinderBuilder";
  70941. export * from "babylonjs/Meshes/Builders/torusBuilder";
  70942. export * from "babylonjs/Meshes/Builders/torusKnotBuilder";
  70943. export * from "babylonjs/Meshes/Builders/linesBuilder";
  70944. export * from "babylonjs/Meshes/Builders/polygonBuilder";
  70945. export * from "babylonjs/Meshes/Builders/shapeBuilder";
  70946. export * from "babylonjs/Meshes/Builders/latheBuilder";
  70947. export * from "babylonjs/Meshes/Builders/planeBuilder";
  70948. export * from "babylonjs/Meshes/Builders/tiledPlaneBuilder";
  70949. export * from "babylonjs/Meshes/Builders/groundBuilder";
  70950. export * from "babylonjs/Meshes/Builders/tubeBuilder";
  70951. export * from "babylonjs/Meshes/Builders/polyhedronBuilder";
  70952. export * from "babylonjs/Meshes/Builders/icoSphereBuilder";
  70953. export * from "babylonjs/Meshes/Builders/decalBuilder";
  70954. export * from "babylonjs/Meshes/Builders/icoSphereBuilder";
  70955. export * from "babylonjs/Meshes/Builders/capsuleBuilder";
  70956. }
  70957. declare module "babylonjs/Meshes/thinInstanceMesh" {
  70958. import { Nullable, DeepImmutableObject } from "babylonjs/types";
  70959. import { VertexBuffer } from "babylonjs/Meshes/buffer";
  70960. import { Matrix } from "babylonjs/Maths/math.vector";
  70961. module "babylonjs/Meshes/mesh" {
  70962. interface Mesh {
  70963. /**
  70964. * Gets or sets a boolean defining if we want picking to pick thin instances as well
  70965. */
  70966. thinInstanceEnablePicking: boolean;
  70967. /**
  70968. * Creates a new thin instance
  70969. * @param matrix the matrix or array of matrices (position, rotation, scale) of the thin instance(s) to create
  70970. * @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
  70971. * @returns the thin instance index number. If you pass an array of matrices, other instance indexes are index+1, index+2, etc
  70972. */
  70973. thinInstanceAdd(matrix: DeepImmutableObject<Matrix> | Array<DeepImmutableObject<Matrix>>, refresh: boolean): number;
  70974. /**
  70975. * Adds the transformation (matrix) of the current mesh as a thin instance
  70976. * @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
  70977. * @returns the thin instance index number
  70978. */
  70979. thinInstanceAddSelf(refresh: boolean): number;
  70980. /**
  70981. * Registers a custom attribute to be used with thin instances
  70982. * @param kind name of the attribute
  70983. * @param stride size in floats of the attribute
  70984. */
  70985. thinInstanceRegisterAttribute(kind: string, stride: number): void;
  70986. /**
  70987. * Sets the matrix of a thin instance
  70988. * @param index index of the thin instance
  70989. * @param matrix matrix to set
  70990. * @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
  70991. */
  70992. thinInstanceSetMatrixAt(index: number, matrix: DeepImmutableObject<Matrix>, refresh: boolean): void;
  70993. /**
  70994. * Sets the value of a custom attribute for a thin instance
  70995. * @param kind name of the attribute
  70996. * @param index index of the thin instance
  70997. * @param value value to set
  70998. * @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
  70999. */
  71000. thinInstanceSetAttributeAt(kind: string, index: number, value: Array<number>, refresh: boolean): void;
  71001. /**
  71002. * 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.
  71003. */
  71004. thinInstanceCount: number;
  71005. /**
  71006. * Sets a buffer to be used with thin instances. This method is a faster way to setup multiple instances than calling thinInstanceAdd repeatedly
  71007. * @param kind name of the attribute. Use "matrix" to setup the buffer of matrices
  71008. * @param buffer buffer to set
  71009. * @param stride size in floats of each value of the buffer
  71010. * @param staticBuffer indicates that the buffer is static, so that you won't change it after it is set (better performances - false by default)
  71011. */
  71012. thinInstanceSetBuffer(kind: string, buffer: Nullable<Float32Array>, stride: number, staticBuffer: boolean): void;
  71013. /**
  71014. * Gets the list of world matrices
  71015. * @return an array containing all the world matrices from the thin instances
  71016. */
  71017. thinInstanceGetWorldMatrices(): Matrix[];
  71018. /**
  71019. * Synchronize the gpu buffers with a thin instance buffer. Call this method if you update later on the buffers passed to thinInstanceSetBuffer
  71020. * @param kind name of the attribute to update. Use "matrix" to update the buffer of matrices
  71021. */
  71022. thinInstanceBufferUpdated(kind: string): void;
  71023. /**
  71024. * Applies a partial update to a buffer directly on the GPU
  71025. * Note that the buffer located on the CPU is NOT updated! It's up to you to update it (or not) with the same data you pass to this method
  71026. * @param kind name of the attribute to update. Use "matrix" to update the buffer of matrices
  71027. * @param data the data to set in the GPU buffer
  71028. * @param offset the offset in the GPU buffer where to update the data
  71029. */
  71030. thinInstancePartialBufferUpdate(kind: string, data: Float32Array, offset: number): void;
  71031. /**
  71032. * Refreshes the bounding info, taking into account all the thin instances defined
  71033. * @param forceRefreshParentInfo true to force recomputing the mesh bounding info and use it to compute the aggregated bounding info
  71034. */
  71035. thinInstanceRefreshBoundingInfo(forceRefreshParentInfo: boolean): void;
  71036. /** @hidden */
  71037. _thinInstanceInitializeUserStorage(): void;
  71038. /** @hidden */
  71039. _thinInstanceUpdateBufferSize(kind: string, numInstances: number): void;
  71040. /** @hidden */
  71041. _userThinInstanceBuffersStorage: {
  71042. data: {
  71043. [key: string]: Float32Array;
  71044. };
  71045. sizes: {
  71046. [key: string]: number;
  71047. };
  71048. vertexBuffers: {
  71049. [key: string]: Nullable<VertexBuffer>;
  71050. };
  71051. strides: {
  71052. [key: string]: number;
  71053. };
  71054. };
  71055. }
  71056. }
  71057. }
  71058. declare module "babylonjs/Meshes/index" {
  71059. export * from "babylonjs/Meshes/abstractMesh";
  71060. export * from "babylonjs/Meshes/buffer";
  71061. export * from "babylonjs/Meshes/Compression/index";
  71062. export * from "babylonjs/Meshes/csg";
  71063. export * from "babylonjs/Meshes/geometry";
  71064. export * from "babylonjs/Meshes/groundMesh";
  71065. export * from "babylonjs/Meshes/trailMesh";
  71066. export * from "babylonjs/Meshes/instancedMesh";
  71067. export * from "babylonjs/Meshes/linesMesh";
  71068. export * from "babylonjs/Meshes/mesh";
  71069. export * from "babylonjs/Meshes/mesh.vertexData";
  71070. export * from "babylonjs/Meshes/meshBuilder";
  71071. export * from "babylonjs/Meshes/meshSimplification";
  71072. export * from "babylonjs/Meshes/meshSimplificationSceneComponent";
  71073. export * from "babylonjs/Meshes/polygonMesh";
  71074. export * from "babylonjs/Meshes/subMesh";
  71075. export * from "babylonjs/Meshes/meshLODLevel";
  71076. export * from "babylonjs/Meshes/transformNode";
  71077. export * from "babylonjs/Meshes/Builders/index";
  71078. export * from "babylonjs/Meshes/dataBuffer";
  71079. export * from "babylonjs/Meshes/WebGL/webGLDataBuffer";
  71080. import "babylonjs/Meshes/thinInstanceMesh";
  71081. export * from "babylonjs/Meshes/thinInstanceMesh";
  71082. }
  71083. declare module "babylonjs/Morph/index" {
  71084. export * from "babylonjs/Morph/morphTarget";
  71085. export * from "babylonjs/Morph/morphTargetManager";
  71086. }
  71087. declare module "babylonjs/Navigation/INavigationEngine" {
  71088. import { TransformNode } from "babylonjs/Meshes/transformNode";
  71089. import { Vector3 } from "babylonjs/Maths/math";
  71090. import { Mesh } from "babylonjs/Meshes/mesh";
  71091. import { Scene } from "babylonjs/scene";
  71092. /**
  71093. * Navigation plugin interface to add navigation constrained by a navigation mesh
  71094. */
  71095. export interface INavigationEnginePlugin {
  71096. /**
  71097. * plugin name
  71098. */
  71099. name: string;
  71100. /**
  71101. * Creates a navigation mesh
  71102. * @param meshes array of all the geometry used to compute the navigatio mesh
  71103. * @param parameters bunch of parameters used to filter geometry
  71104. */
  71105. createNavMesh(meshes: Array<Mesh>, parameters: INavMeshParameters): void;
  71106. /**
  71107. * Create a navigation mesh debug mesh
  71108. * @param scene is where the mesh will be added
  71109. * @returns debug display mesh
  71110. */
  71111. createDebugNavMesh(scene: Scene): Mesh;
  71112. /**
  71113. * Get a navigation mesh constrained position, closest to the parameter position
  71114. * @param position world position
  71115. * @returns the closest point to position constrained by the navigation mesh
  71116. */
  71117. getClosestPoint(position: Vector3): Vector3;
  71118. /**
  71119. * Get a navigation mesh constrained position, closest to the parameter position
  71120. * @param position world position
  71121. * @param result output the closest point to position constrained by the navigation mesh
  71122. */
  71123. getClosestPointToRef(position: Vector3, result: Vector3): void;
  71124. /**
  71125. * Get a navigation mesh constrained position, within a particular radius
  71126. * @param position world position
  71127. * @param maxRadius the maximum distance to the constrained world position
  71128. * @returns the closest point to position constrained by the navigation mesh
  71129. */
  71130. getRandomPointAround(position: Vector3, maxRadius: number): Vector3;
  71131. /**
  71132. * Get a navigation mesh constrained position, within a particular radius
  71133. * @param position world position
  71134. * @param maxRadius the maximum distance to the constrained world position
  71135. * @param result output the closest point to position constrained by the navigation mesh
  71136. */
  71137. getRandomPointAroundToRef(position: Vector3, maxRadius: number, result: Vector3): void;
  71138. /**
  71139. * Compute the final position from a segment made of destination-position
  71140. * @param position world position
  71141. * @param destination world position
  71142. * @returns the resulting point along the navmesh
  71143. */
  71144. moveAlong(position: Vector3, destination: Vector3): Vector3;
  71145. /**
  71146. * Compute the final position from a segment made of destination-position
  71147. * @param position world position
  71148. * @param destination world position
  71149. * @param result output the resulting point along the navmesh
  71150. */
  71151. moveAlongToRef(position: Vector3, destination: Vector3, result: Vector3): void;
  71152. /**
  71153. * Compute a navigation path from start to end. Returns an empty array if no path can be computed
  71154. * @param start world position
  71155. * @param end world position
  71156. * @returns array containing world position composing the path
  71157. */
  71158. computePath(start: Vector3, end: Vector3): Vector3[];
  71159. /**
  71160. * If this plugin is supported
  71161. * @returns true if plugin is supported
  71162. */
  71163. isSupported(): boolean;
  71164. /**
  71165. * Create a new Crowd so you can add agents
  71166. * @param maxAgents the maximum agent count in the crowd
  71167. * @param maxAgentRadius the maximum radius an agent can have
  71168. * @param scene to attach the crowd to
  71169. * @returns the crowd you can add agents to
  71170. */
  71171. createCrowd(maxAgents: number, maxAgentRadius: number, scene: Scene): ICrowd;
  71172. /**
  71173. * Set the Bounding box extent for doing spatial queries (getClosestPoint, getRandomPointAround, ...)
  71174. * The queries will try to find a solution within those bounds
  71175. * default is (1,1,1)
  71176. * @param extent x,y,z value that define the extent around the queries point of reference
  71177. */
  71178. setDefaultQueryExtent(extent: Vector3): void;
  71179. /**
  71180. * Get the Bounding box extent specified by setDefaultQueryExtent
  71181. * @returns the box extent values
  71182. */
  71183. getDefaultQueryExtent(): Vector3;
  71184. /**
  71185. * build the navmesh from a previously saved state using getNavmeshData
  71186. * @param data the Uint8Array returned by getNavmeshData
  71187. */
  71188. buildFromNavmeshData(data: Uint8Array): void;
  71189. /**
  71190. * returns the navmesh data that can be used later. The navmesh must be built before retrieving the data
  71191. * @returns data the Uint8Array that can be saved and reused
  71192. */
  71193. getNavmeshData(): Uint8Array;
  71194. /**
  71195. * Get the Bounding box extent result specified by setDefaultQueryExtent
  71196. * @param result output the box extent values
  71197. */
  71198. getDefaultQueryExtentToRef(result: Vector3): void;
  71199. /**
  71200. * Release all resources
  71201. */
  71202. dispose(): void;
  71203. }
  71204. /**
  71205. * Crowd Interface. A Crowd is a collection of moving agents constrained by a navigation mesh
  71206. */
  71207. export interface ICrowd {
  71208. /**
  71209. * Add a new agent to the crowd with the specified parameter a corresponding transformNode.
  71210. * You can attach anything to that node. The node position is updated in the scene update tick.
  71211. * @param pos world position that will be constrained by the navigation mesh
  71212. * @param parameters agent parameters
  71213. * @param transform hooked to the agent that will be update by the scene
  71214. * @returns agent index
  71215. */
  71216. addAgent(pos: Vector3, parameters: IAgentParameters, transform: TransformNode): number;
  71217. /**
  71218. * Returns the agent position in world space
  71219. * @param index agent index returned by addAgent
  71220. * @returns world space position
  71221. */
  71222. getAgentPosition(index: number): Vector3;
  71223. /**
  71224. * Gets the agent position result in world space
  71225. * @param index agent index returned by addAgent
  71226. * @param result output world space position
  71227. */
  71228. getAgentPositionToRef(index: number, result: Vector3): void;
  71229. /**
  71230. * Gets the agent velocity in world space
  71231. * @param index agent index returned by addAgent
  71232. * @returns world space velocity
  71233. */
  71234. getAgentVelocity(index: number): Vector3;
  71235. /**
  71236. * Gets the agent velocity result in world space
  71237. * @param index agent index returned by addAgent
  71238. * @param result output world space velocity
  71239. */
  71240. getAgentVelocityToRef(index: number, result: Vector3): void;
  71241. /**
  71242. * remove a particular agent previously created
  71243. * @param index agent index returned by addAgent
  71244. */
  71245. removeAgent(index: number): void;
  71246. /**
  71247. * get the list of all agents attached to this crowd
  71248. * @returns list of agent indices
  71249. */
  71250. getAgents(): number[];
  71251. /**
  71252. * Tick update done by the Scene. Agent position/velocity/acceleration is updated by this function
  71253. * @param deltaTime in seconds
  71254. */
  71255. update(deltaTime: number): void;
  71256. /**
  71257. * Asks a particular agent to go to a destination. That destination is constrained by the navigation mesh
  71258. * @param index agent index returned by addAgent
  71259. * @param destination targeted world position
  71260. */
  71261. agentGoto(index: number, destination: Vector3): void;
  71262. /**
  71263. * Teleport the agent to a new position
  71264. * @param index agent index returned by addAgent
  71265. * @param destination targeted world position
  71266. */
  71267. agentTeleport(index: number, destination: Vector3): void;
  71268. /**
  71269. * Update agent parameters
  71270. * @param index agent index returned by addAgent
  71271. * @param parameters agent parameters
  71272. */
  71273. updateAgentParameters(index: number, parameters: IAgentParameters): void;
  71274. /**
  71275. * Set the Bounding box extent for doing spatial queries (getClosestPoint, getRandomPointAround, ...)
  71276. * The queries will try to find a solution within those bounds
  71277. * default is (1,1,1)
  71278. * @param extent x,y,z value that define the extent around the queries point of reference
  71279. */
  71280. setDefaultQueryExtent(extent: Vector3): void;
  71281. /**
  71282. * Get the Bounding box extent specified by setDefaultQueryExtent
  71283. * @returns the box extent values
  71284. */
  71285. getDefaultQueryExtent(): Vector3;
  71286. /**
  71287. * Get the Bounding box extent result specified by setDefaultQueryExtent
  71288. * @param result output the box extent values
  71289. */
  71290. getDefaultQueryExtentToRef(result: Vector3): void;
  71291. /**
  71292. * Release all resources
  71293. */
  71294. dispose(): void;
  71295. }
  71296. /**
  71297. * Configures an agent
  71298. */
  71299. export interface IAgentParameters {
  71300. /**
  71301. * Agent radius. [Limit: >= 0]
  71302. */
  71303. radius: number;
  71304. /**
  71305. * Agent height. [Limit: > 0]
  71306. */
  71307. height: number;
  71308. /**
  71309. * Maximum allowed acceleration. [Limit: >= 0]
  71310. */
  71311. maxAcceleration: number;
  71312. /**
  71313. * Maximum allowed speed. [Limit: >= 0]
  71314. */
  71315. maxSpeed: number;
  71316. /**
  71317. * Defines how close a collision element must be before it is considered for steering behaviors. [Limits: > 0]
  71318. */
  71319. collisionQueryRange: number;
  71320. /**
  71321. * The path visibility optimization range. [Limit: > 0]
  71322. */
  71323. pathOptimizationRange: number;
  71324. /**
  71325. * How aggresive the agent manager should be at avoiding collisions with this agent. [Limit: >= 0]
  71326. */
  71327. separationWeight: number;
  71328. }
  71329. /**
  71330. * Configures the navigation mesh creation
  71331. */
  71332. export interface INavMeshParameters {
  71333. /**
  71334. * The xz-plane cell size to use for fields. [Limit: > 0] [Units: wu]
  71335. */
  71336. cs: number;
  71337. /**
  71338. * The y-axis cell size to use for fields. [Limit: > 0] [Units: wu]
  71339. */
  71340. ch: number;
  71341. /**
  71342. * The maximum slope that is considered walkable. [Limits: 0 <= value < 90] [Units: Degrees]
  71343. */
  71344. walkableSlopeAngle: number;
  71345. /**
  71346. * Minimum floor to 'ceiling' height that will still allow the floor area to
  71347. * be considered walkable. [Limit: >= 3] [Units: vx]
  71348. */
  71349. walkableHeight: number;
  71350. /**
  71351. * Maximum ledge height that is considered to still be traversable. [Limit: >=0] [Units: vx]
  71352. */
  71353. walkableClimb: number;
  71354. /**
  71355. * The distance to erode/shrink the walkable area of the heightfield away from
  71356. * obstructions. [Limit: >=0] [Units: vx]
  71357. */
  71358. walkableRadius: number;
  71359. /**
  71360. * The maximum allowed length for contour edges along the border of the mesh. [Limit: >=0] [Units: vx]
  71361. */
  71362. maxEdgeLen: number;
  71363. /**
  71364. * The maximum distance a simplfied contour's border edges should deviate
  71365. * the original raw contour. [Limit: >=0] [Units: vx]
  71366. */
  71367. maxSimplificationError: number;
  71368. /**
  71369. * The minimum number of cells allowed to form isolated island areas. [Limit: >=0] [Units: vx]
  71370. */
  71371. minRegionArea: number;
  71372. /**
  71373. * Any regions with a span count smaller than this value will, if possible,
  71374. * be merged with larger regions. [Limit: >=0] [Units: vx]
  71375. */
  71376. mergeRegionArea: number;
  71377. /**
  71378. * The maximum number of vertices allowed for polygons generated during the
  71379. * contour to polygon conversion process. [Limit: >= 3]
  71380. */
  71381. maxVertsPerPoly: number;
  71382. /**
  71383. * Sets the sampling distance to use when generating the detail mesh.
  71384. * (For height detail only.) [Limits: 0 or >= 0.9] [Units: wu]
  71385. */
  71386. detailSampleDist: number;
  71387. /**
  71388. * The maximum distance the detail mesh surface should deviate from heightfield
  71389. * data. (For height detail only.) [Limit: >=0] [Units: wu]
  71390. */
  71391. detailSampleMaxError: number;
  71392. }
  71393. }
  71394. declare module "babylonjs/Navigation/Plugins/recastJSPlugin" {
  71395. import { INavigationEnginePlugin, ICrowd, IAgentParameters, INavMeshParameters } from "babylonjs/Navigation/INavigationEngine";
  71396. import { Mesh } from "babylonjs/Meshes/mesh";
  71397. import { Scene } from "babylonjs/scene";
  71398. import { Vector3 } from "babylonjs/Maths/math";
  71399. import { TransformNode } from "babylonjs/Meshes/transformNode";
  71400. /**
  71401. * RecastJS navigation plugin
  71402. */
  71403. export class RecastJSPlugin implements INavigationEnginePlugin {
  71404. /**
  71405. * Reference to the Recast library
  71406. */
  71407. bjsRECAST: any;
  71408. /**
  71409. * plugin name
  71410. */
  71411. name: string;
  71412. /**
  71413. * the first navmesh created. We might extend this to support multiple navmeshes
  71414. */
  71415. navMesh: any;
  71416. /**
  71417. * Initializes the recastJS plugin
  71418. * @param recastInjection can be used to inject your own recast reference
  71419. */
  71420. constructor(recastInjection?: any);
  71421. /**
  71422. * Creates a navigation mesh
  71423. * @param meshes array of all the geometry used to compute the navigatio mesh
  71424. * @param parameters bunch of parameters used to filter geometry
  71425. */
  71426. createNavMesh(meshes: Array<Mesh>, parameters: INavMeshParameters): void;
  71427. /**
  71428. * Create a navigation mesh debug mesh
  71429. * @param scene is where the mesh will be added
  71430. * @returns debug display mesh
  71431. */
  71432. createDebugNavMesh(scene: Scene): Mesh;
  71433. /**
  71434. * Get a navigation mesh constrained position, closest to the parameter position
  71435. * @param position world position
  71436. * @returns the closest point to position constrained by the navigation mesh
  71437. */
  71438. getClosestPoint(position: Vector3): Vector3;
  71439. /**
  71440. * Get a navigation mesh constrained position, closest to the parameter position
  71441. * @param position world position
  71442. * @param result output the closest point to position constrained by the navigation mesh
  71443. */
  71444. getClosestPointToRef(position: Vector3, result: Vector3): void;
  71445. /**
  71446. * Get a navigation mesh constrained position, within a particular radius
  71447. * @param position world position
  71448. * @param maxRadius the maximum distance to the constrained world position
  71449. * @returns the closest point to position constrained by the navigation mesh
  71450. */
  71451. getRandomPointAround(position: Vector3, maxRadius: number): Vector3;
  71452. /**
  71453. * Get a navigation mesh constrained position, within a particular radius
  71454. * @param position world position
  71455. * @param maxRadius the maximum distance to the constrained world position
  71456. * @param result output the closest point to position constrained by the navigation mesh
  71457. */
  71458. getRandomPointAroundToRef(position: Vector3, maxRadius: number, result: Vector3): void;
  71459. /**
  71460. * Compute the final position from a segment made of destination-position
  71461. * @param position world position
  71462. * @param destination world position
  71463. * @returns the resulting point along the navmesh
  71464. */
  71465. moveAlong(position: Vector3, destination: Vector3): Vector3;
  71466. /**
  71467. * Compute the final position from a segment made of destination-position
  71468. * @param position world position
  71469. * @param destination world position
  71470. * @param result output the resulting point along the navmesh
  71471. */
  71472. moveAlongToRef(position: Vector3, destination: Vector3, result: Vector3): void;
  71473. /**
  71474. * Compute a navigation path from start to end. Returns an empty array if no path can be computed
  71475. * @param start world position
  71476. * @param end world position
  71477. * @returns array containing world position composing the path
  71478. */
  71479. computePath(start: Vector3, end: Vector3): Vector3[];
  71480. /**
  71481. * Create a new Crowd so you can add agents
  71482. * @param maxAgents the maximum agent count in the crowd
  71483. * @param maxAgentRadius the maximum radius an agent can have
  71484. * @param scene to attach the crowd to
  71485. * @returns the crowd you can add agents to
  71486. */
  71487. createCrowd(maxAgents: number, maxAgentRadius: number, scene: Scene): ICrowd;
  71488. /**
  71489. * Set the Bounding box extent for doing spatial queries (getClosestPoint, getRandomPointAround, ...)
  71490. * The queries will try to find a solution within those bounds
  71491. * default is (1,1,1)
  71492. * @param extent x,y,z value that define the extent around the queries point of reference
  71493. */
  71494. setDefaultQueryExtent(extent: Vector3): void;
  71495. /**
  71496. * Get the Bounding box extent specified by setDefaultQueryExtent
  71497. * @returns the box extent values
  71498. */
  71499. getDefaultQueryExtent(): Vector3;
  71500. /**
  71501. * build the navmesh from a previously saved state using getNavmeshData
  71502. * @param data the Uint8Array returned by getNavmeshData
  71503. */
  71504. buildFromNavmeshData(data: Uint8Array): void;
  71505. /**
  71506. * returns the navmesh data that can be used later. The navmesh must be built before retrieving the data
  71507. * @returns data the Uint8Array that can be saved and reused
  71508. */
  71509. getNavmeshData(): Uint8Array;
  71510. /**
  71511. * Get the Bounding box extent result specified by setDefaultQueryExtent
  71512. * @param result output the box extent values
  71513. */
  71514. getDefaultQueryExtentToRef(result: Vector3): void;
  71515. /**
  71516. * Disposes
  71517. */
  71518. dispose(): void;
  71519. /**
  71520. * If this plugin is supported
  71521. * @returns true if plugin is supported
  71522. */
  71523. isSupported(): boolean;
  71524. }
  71525. /**
  71526. * Recast detour crowd implementation
  71527. */
  71528. export class RecastJSCrowd implements ICrowd {
  71529. /**
  71530. * Recast/detour plugin
  71531. */
  71532. bjsRECASTPlugin: RecastJSPlugin;
  71533. /**
  71534. * Link to the detour crowd
  71535. */
  71536. recastCrowd: any;
  71537. /**
  71538. * One transform per agent
  71539. */
  71540. transforms: TransformNode[];
  71541. /**
  71542. * All agents created
  71543. */
  71544. agents: number[];
  71545. /**
  71546. * Link to the scene is kept to unregister the crowd from the scene
  71547. */
  71548. private _scene;
  71549. /**
  71550. * Observer for crowd updates
  71551. */
  71552. private _onBeforeAnimationsObserver;
  71553. /**
  71554. * Constructor
  71555. * @param plugin recastJS plugin
  71556. * @param maxAgents the maximum agent count in the crowd
  71557. * @param maxAgentRadius the maximum radius an agent can have
  71558. * @param scene to attach the crowd to
  71559. * @returns the crowd you can add agents to
  71560. */
  71561. constructor(plugin: RecastJSPlugin, maxAgents: number, maxAgentRadius: number, scene: Scene);
  71562. /**
  71563. * Add a new agent to the crowd with the specified parameter a corresponding transformNode.
  71564. * You can attach anything to that node. The node position is updated in the scene update tick.
  71565. * @param pos world position that will be constrained by the navigation mesh
  71566. * @param parameters agent parameters
  71567. * @param transform hooked to the agent that will be update by the scene
  71568. * @returns agent index
  71569. */
  71570. addAgent(pos: Vector3, parameters: IAgentParameters, transform: TransformNode): number;
  71571. /**
  71572. * Returns the agent position in world space
  71573. * @param index agent index returned by addAgent
  71574. * @returns world space position
  71575. */
  71576. getAgentPosition(index: number): Vector3;
  71577. /**
  71578. * Returns the agent position result in world space
  71579. * @param index agent index returned by addAgent
  71580. * @param result output world space position
  71581. */
  71582. getAgentPositionToRef(index: number, result: Vector3): void;
  71583. /**
  71584. * Returns the agent velocity in world space
  71585. * @param index agent index returned by addAgent
  71586. * @returns world space velocity
  71587. */
  71588. getAgentVelocity(index: number): Vector3;
  71589. /**
  71590. * Returns the agent velocity result in world space
  71591. * @param index agent index returned by addAgent
  71592. * @param result output world space velocity
  71593. */
  71594. getAgentVelocityToRef(index: number, result: Vector3): void;
  71595. /**
  71596. * Asks a particular agent to go to a destination. That destination is constrained by the navigation mesh
  71597. * @param index agent index returned by addAgent
  71598. * @param destination targeted world position
  71599. */
  71600. agentGoto(index: number, destination: Vector3): void;
  71601. /**
  71602. * Teleport the agent to a new position
  71603. * @param index agent index returned by addAgent
  71604. * @param destination targeted world position
  71605. */
  71606. agentTeleport(index: number, destination: Vector3): void;
  71607. /**
  71608. * Update agent parameters
  71609. * @param index agent index returned by addAgent
  71610. * @param parameters agent parameters
  71611. */
  71612. updateAgentParameters(index: number, parameters: IAgentParameters): void;
  71613. /**
  71614. * remove a particular agent previously created
  71615. * @param index agent index returned by addAgent
  71616. */
  71617. removeAgent(index: number): void;
  71618. /**
  71619. * get the list of all agents attached to this crowd
  71620. * @returns list of agent indices
  71621. */
  71622. getAgents(): number[];
  71623. /**
  71624. * Tick update done by the Scene. Agent position/velocity/acceleration is updated by this function
  71625. * @param deltaTime in seconds
  71626. */
  71627. update(deltaTime: number): void;
  71628. /**
  71629. * Set the Bounding box extent for doing spatial queries (getClosestPoint, getRandomPointAround, ...)
  71630. * The queries will try to find a solution within those bounds
  71631. * default is (1,1,1)
  71632. * @param extent x,y,z value that define the extent around the queries point of reference
  71633. */
  71634. setDefaultQueryExtent(extent: Vector3): void;
  71635. /**
  71636. * Get the Bounding box extent specified by setDefaultQueryExtent
  71637. * @returns the box extent values
  71638. */
  71639. getDefaultQueryExtent(): Vector3;
  71640. /**
  71641. * Get the Bounding box extent result specified by setDefaultQueryExtent
  71642. * @param result output the box extent values
  71643. */
  71644. getDefaultQueryExtentToRef(result: Vector3): void;
  71645. /**
  71646. * Release all resources
  71647. */
  71648. dispose(): void;
  71649. }
  71650. }
  71651. declare module "babylonjs/Navigation/Plugins/index" {
  71652. export * from "babylonjs/Navigation/Plugins/recastJSPlugin";
  71653. }
  71654. declare module "babylonjs/Navigation/index" {
  71655. export * from "babylonjs/Navigation/INavigationEngine";
  71656. export * from "babylonjs/Navigation/Plugins/index";
  71657. }
  71658. declare module "babylonjs/Offline/database" {
  71659. import { IOfflineProvider } from "babylonjs/Offline/IOfflineProvider";
  71660. /**
  71661. * Class used to enable access to IndexedDB
  71662. * @see https://doc.babylonjs.com/how_to/caching_resources_in_indexeddb
  71663. */
  71664. export class Database implements IOfflineProvider {
  71665. private _callbackManifestChecked;
  71666. private _currentSceneUrl;
  71667. private _db;
  71668. private _enableSceneOffline;
  71669. private _enableTexturesOffline;
  71670. private _manifestVersionFound;
  71671. private _mustUpdateRessources;
  71672. private _hasReachedQuota;
  71673. private _isSupported;
  71674. private _idbFactory;
  71675. /** Gets a boolean indicating if the user agent supports blob storage (this value will be updated after creating the first Database object) */
  71676. private static IsUASupportingBlobStorage;
  71677. /**
  71678. * Gets a boolean indicating if Database storate is enabled (off by default)
  71679. */
  71680. static IDBStorageEnabled: boolean;
  71681. /**
  71682. * Gets a boolean indicating if scene must be saved in the database
  71683. */
  71684. get enableSceneOffline(): boolean;
  71685. /**
  71686. * Gets a boolean indicating if textures must be saved in the database
  71687. */
  71688. get enableTexturesOffline(): boolean;
  71689. /**
  71690. * Creates a new Database
  71691. * @param urlToScene defines the url to load the scene
  71692. * @param callbackManifestChecked defines the callback to use when manifest is checked
  71693. * @param disableManifestCheck defines a boolean indicating that we want to skip the manifest validation (it will be considered validated and up to date)
  71694. */
  71695. constructor(urlToScene: string, callbackManifestChecked: (checked: boolean) => any, disableManifestCheck?: boolean);
  71696. private static _ParseURL;
  71697. private static _ReturnFullUrlLocation;
  71698. private _checkManifestFile;
  71699. /**
  71700. * Open the database and make it available
  71701. * @param successCallback defines the callback to call on success
  71702. * @param errorCallback defines the callback to call on error
  71703. */
  71704. open(successCallback: () => void, errorCallback: () => void): void;
  71705. /**
  71706. * Loads an image from the database
  71707. * @param url defines the url to load from
  71708. * @param image defines the target DOM image
  71709. */
  71710. loadImage(url: string, image: HTMLImageElement): void;
  71711. private _loadImageFromDBAsync;
  71712. private _saveImageIntoDBAsync;
  71713. private _checkVersionFromDB;
  71714. private _loadVersionFromDBAsync;
  71715. private _saveVersionIntoDBAsync;
  71716. /**
  71717. * Loads a file from database
  71718. * @param url defines the URL to load from
  71719. * @param sceneLoaded defines a callback to call on success
  71720. * @param progressCallBack defines a callback to call when progress changed
  71721. * @param errorCallback defines a callback to call on error
  71722. * @param useArrayBuffer defines a boolean to use array buffer instead of text string
  71723. */
  71724. loadFile(url: string, sceneLoaded: (data: any) => void, progressCallBack?: (data: any) => void, errorCallback?: () => void, useArrayBuffer?: boolean): void;
  71725. private _loadFileAsync;
  71726. private _saveFileAsync;
  71727. /**
  71728. * Validates if xhr data is correct
  71729. * @param xhr defines the request to validate
  71730. * @param dataType defines the expected data type
  71731. * @returns true if data is correct
  71732. */
  71733. private static _ValidateXHRData;
  71734. }
  71735. }
  71736. declare module "babylonjs/Offline/index" {
  71737. export * from "babylonjs/Offline/database";
  71738. export * from "babylonjs/Offline/IOfflineProvider";
  71739. }
  71740. declare module "babylonjs/Shaders/gpuUpdateParticles.fragment" {
  71741. /** @hidden */
  71742. export var gpuUpdateParticlesPixelShader: {
  71743. name: string;
  71744. shader: string;
  71745. };
  71746. }
  71747. declare module "babylonjs/Shaders/gpuUpdateParticles.vertex" {
  71748. /** @hidden */
  71749. export var gpuUpdateParticlesVertexShader: {
  71750. name: string;
  71751. shader: string;
  71752. };
  71753. }
  71754. declare module "babylonjs/Shaders/ShadersInclude/clipPlaneFragmentDeclaration2" {
  71755. /** @hidden */
  71756. export var clipPlaneFragmentDeclaration2: {
  71757. name: string;
  71758. shader: string;
  71759. };
  71760. }
  71761. declare module "babylonjs/Shaders/gpuRenderParticles.fragment" {
  71762. import "babylonjs/Shaders/ShadersInclude/clipPlaneFragmentDeclaration2";
  71763. import "babylonjs/Shaders/ShadersInclude/imageProcessingDeclaration";
  71764. import "babylonjs/Shaders/ShadersInclude/helperFunctions";
  71765. import "babylonjs/Shaders/ShadersInclude/imageProcessingFunctions";
  71766. import "babylonjs/Shaders/ShadersInclude/clipPlaneFragment";
  71767. /** @hidden */
  71768. export var gpuRenderParticlesPixelShader: {
  71769. name: string;
  71770. shader: string;
  71771. };
  71772. }
  71773. declare module "babylonjs/Shaders/ShadersInclude/clipPlaneVertexDeclaration2" {
  71774. /** @hidden */
  71775. export var clipPlaneVertexDeclaration2: {
  71776. name: string;
  71777. shader: string;
  71778. };
  71779. }
  71780. declare module "babylonjs/Shaders/gpuRenderParticles.vertex" {
  71781. import "babylonjs/Shaders/ShadersInclude/clipPlaneVertexDeclaration2";
  71782. import "babylonjs/Shaders/ShadersInclude/clipPlaneVertex";
  71783. /** @hidden */
  71784. export var gpuRenderParticlesVertexShader: {
  71785. name: string;
  71786. shader: string;
  71787. };
  71788. }
  71789. declare module "babylonjs/Particles/gpuParticleSystem" {
  71790. import { Nullable } from "babylonjs/types";
  71791. import { Color3Gradient, IValueGradient } from "babylonjs/Misc/gradients";
  71792. import { Observable } from "babylonjs/Misc/observable";
  71793. import { Matrix } from "babylonjs/Maths/math.vector";
  71794. import { Color4, Color3 } from "babylonjs/Maths/math.color";
  71795. import { IParticleSystem } from "babylonjs/Particles/IParticleSystem";
  71796. import { BaseParticleSystem } from "babylonjs/Particles/baseParticleSystem";
  71797. import { IDisposable } from "babylonjs/scene";
  71798. import { Effect } from "babylonjs/Materials/effect";
  71799. import { RawTexture } from "babylonjs/Materials/Textures/rawTexture";
  71800. import { IAnimatable } from "babylonjs/Animations/animatable.interface";
  71801. import { ThinEngine } from "babylonjs/Engines/thinEngine";
  71802. import { Scene } from "babylonjs/scene";
  71803. import "babylonjs/Shaders/gpuUpdateParticles.fragment";
  71804. import "babylonjs/Shaders/gpuUpdateParticles.vertex";
  71805. import "babylonjs/Shaders/gpuRenderParticles.fragment";
  71806. import "babylonjs/Shaders/gpuRenderParticles.vertex";
  71807. /**
  71808. * This represents a GPU particle system in Babylon
  71809. * This is the fastest particle system in Babylon as it uses the GPU to update the individual particle data
  71810. * @see https://www.babylonjs-playground.com/#PU4WYI#4
  71811. */
  71812. export class GPUParticleSystem extends BaseParticleSystem implements IDisposable, IParticleSystem, IAnimatable {
  71813. /**
  71814. * The layer mask we are rendering the particles through.
  71815. */
  71816. layerMask: number;
  71817. private _capacity;
  71818. private _activeCount;
  71819. private _currentActiveCount;
  71820. private _accumulatedCount;
  71821. private _renderEffect;
  71822. private _updateEffect;
  71823. private _buffer0;
  71824. private _buffer1;
  71825. private _spriteBuffer;
  71826. private _updateVAO;
  71827. private _renderVAO;
  71828. private _targetIndex;
  71829. private _sourceBuffer;
  71830. private _targetBuffer;
  71831. private _currentRenderId;
  71832. private _started;
  71833. private _stopped;
  71834. private _timeDelta;
  71835. private _randomTexture;
  71836. private _randomTexture2;
  71837. private _attributesStrideSize;
  71838. private _updateEffectOptions;
  71839. private _randomTextureSize;
  71840. private _actualFrame;
  71841. private _customEffect;
  71842. private readonly _rawTextureWidth;
  71843. /**
  71844. * Gets a boolean indicating if the GPU particles can be rendered on current browser
  71845. */
  71846. static get IsSupported(): boolean;
  71847. /**
  71848. * An event triggered when the system is disposed.
  71849. */
  71850. onDisposeObservable: Observable<IParticleSystem>;
  71851. /**
  71852. * An event triggered when the system is stopped
  71853. */
  71854. onStoppedObservable: Observable<IParticleSystem>;
  71855. /**
  71856. * Gets the maximum number of particles active at the same time.
  71857. * @returns The max number of active particles.
  71858. */
  71859. getCapacity(): number;
  71860. /**
  71861. * Forces the particle to write their depth information to the depth buffer. This can help preventing other draw calls
  71862. * to override the particles.
  71863. */
  71864. forceDepthWrite: boolean;
  71865. /**
  71866. * Gets or set the number of active particles
  71867. */
  71868. get activeParticleCount(): number;
  71869. set activeParticleCount(value: number);
  71870. private _preWarmDone;
  71871. /**
  71872. * Specifies if the particles are updated in emitter local space or world space.
  71873. */
  71874. isLocal: boolean;
  71875. /** Gets or sets a matrix to use to compute projection */
  71876. defaultProjectionMatrix: Matrix;
  71877. /**
  71878. * Is this system ready to be used/rendered
  71879. * @return true if the system is ready
  71880. */
  71881. isReady(): boolean;
  71882. /**
  71883. * Gets if the system has been started. (Note: this will still be true after stop is called)
  71884. * @returns True if it has been started, otherwise false.
  71885. */
  71886. isStarted(): boolean;
  71887. /**
  71888. * Gets if the system has been stopped. (Note: rendering is still happening but the system is frozen)
  71889. * @returns True if it has been stopped, otherwise false.
  71890. */
  71891. isStopped(): boolean;
  71892. /**
  71893. * Gets a boolean indicating that the system is stopping
  71894. * @returns true if the system is currently stopping
  71895. */
  71896. isStopping(): boolean;
  71897. /**
  71898. * Gets the number of particles active at the same time.
  71899. * @returns The number of active particles.
  71900. */
  71901. getActiveCount(): number;
  71902. /**
  71903. * Starts the particle system and begins to emit
  71904. * @param delay defines the delay in milliseconds before starting the system (this.startDelay by default)
  71905. */
  71906. start(delay?: number): void;
  71907. /**
  71908. * Stops the particle system.
  71909. */
  71910. stop(): void;
  71911. /**
  71912. * Remove all active particles
  71913. */
  71914. reset(): void;
  71915. /**
  71916. * Returns the string "GPUParticleSystem"
  71917. * @returns a string containing the class name
  71918. */
  71919. getClassName(): string;
  71920. /**
  71921. * Gets the custom effect used to render the particles
  71922. * @param blendMode Blend mode for which the effect should be retrieved
  71923. * @returns The effect
  71924. */
  71925. getCustomEffect(blendMode?: number): Nullable<Effect>;
  71926. /**
  71927. * Sets the custom effect used to render the particles
  71928. * @param effect The effect to set
  71929. * @param blendMode Blend mode for which the effect should be set
  71930. */
  71931. setCustomEffect(effect: Nullable<Effect>, blendMode?: number): void;
  71932. /** @hidden */
  71933. protected _onBeforeDrawParticlesObservable: Nullable<Observable<Nullable<Effect>>>;
  71934. /**
  71935. * Observable that will be called just before the particles are drawn
  71936. */
  71937. get onBeforeDrawParticlesObservable(): Observable<Nullable<Effect>>;
  71938. /**
  71939. * Gets the name of the particle vertex shader
  71940. */
  71941. get vertexShaderName(): string;
  71942. private _colorGradientsTexture;
  71943. protected _removeGradientAndTexture(gradient: number, gradients: Nullable<IValueGradient[]>, texture: RawTexture): BaseParticleSystem;
  71944. /**
  71945. * Adds a new color gradient
  71946. * @param gradient defines the gradient to use (between 0 and 1)
  71947. * @param color1 defines the color to affect to the specified gradient
  71948. * @param color2 defines an additional color used to define a range ([color, color2]) with main color to pick the final color from
  71949. * @returns the current particle system
  71950. */
  71951. addColorGradient(gradient: number, color1: Color4, color2?: Color4): GPUParticleSystem;
  71952. private _refreshColorGradient;
  71953. /** Force the system to rebuild all gradients that need to be resync */
  71954. forceRefreshGradients(): void;
  71955. /**
  71956. * Remove a specific color gradient
  71957. * @param gradient defines the gradient to remove
  71958. * @returns the current particle system
  71959. */
  71960. removeColorGradient(gradient: number): GPUParticleSystem;
  71961. private _angularSpeedGradientsTexture;
  71962. private _sizeGradientsTexture;
  71963. private _velocityGradientsTexture;
  71964. private _limitVelocityGradientsTexture;
  71965. private _dragGradientsTexture;
  71966. private _addFactorGradient;
  71967. /**
  71968. * Adds a new size gradient
  71969. * @param gradient defines the gradient to use (between 0 and 1)
  71970. * @param factor defines the size factor to affect to the specified gradient
  71971. * @returns the current particle system
  71972. */
  71973. addSizeGradient(gradient: number, factor: number): GPUParticleSystem;
  71974. /**
  71975. * Remove a specific size gradient
  71976. * @param gradient defines the gradient to remove
  71977. * @returns the current particle system
  71978. */
  71979. removeSizeGradient(gradient: number): GPUParticleSystem;
  71980. private _refreshFactorGradient;
  71981. /**
  71982. * Adds a new angular speed gradient
  71983. * @param gradient defines the gradient to use (between 0 and 1)
  71984. * @param factor defines the angular speed to affect to the specified gradient
  71985. * @returns the current particle system
  71986. */
  71987. addAngularSpeedGradient(gradient: number, factor: number): GPUParticleSystem;
  71988. /**
  71989. * Remove a specific angular speed gradient
  71990. * @param gradient defines the gradient to remove
  71991. * @returns the current particle system
  71992. */
  71993. removeAngularSpeedGradient(gradient: number): GPUParticleSystem;
  71994. /**
  71995. * Adds a new velocity gradient
  71996. * @param gradient defines the gradient to use (between 0 and 1)
  71997. * @param factor defines the velocity to affect to the specified gradient
  71998. * @returns the current particle system
  71999. */
  72000. addVelocityGradient(gradient: number, factor: number): GPUParticleSystem;
  72001. /**
  72002. * Remove a specific velocity gradient
  72003. * @param gradient defines the gradient to remove
  72004. * @returns the current particle system
  72005. */
  72006. removeVelocityGradient(gradient: number): GPUParticleSystem;
  72007. /**
  72008. * Adds a new limit velocity gradient
  72009. * @param gradient defines the gradient to use (between 0 and 1)
  72010. * @param factor defines the limit velocity value to affect to the specified gradient
  72011. * @returns the current particle system
  72012. */
  72013. addLimitVelocityGradient(gradient: number, factor: number): GPUParticleSystem;
  72014. /**
  72015. * Remove a specific limit velocity gradient
  72016. * @param gradient defines the gradient to remove
  72017. * @returns the current particle system
  72018. */
  72019. removeLimitVelocityGradient(gradient: number): GPUParticleSystem;
  72020. /**
  72021. * Adds a new drag gradient
  72022. * @param gradient defines the gradient to use (between 0 and 1)
  72023. * @param factor defines the drag value to affect to the specified gradient
  72024. * @returns the current particle system
  72025. */
  72026. addDragGradient(gradient: number, factor: number): GPUParticleSystem;
  72027. /**
  72028. * Remove a specific drag gradient
  72029. * @param gradient defines the gradient to remove
  72030. * @returns the current particle system
  72031. */
  72032. removeDragGradient(gradient: number): GPUParticleSystem;
  72033. /**
  72034. * Not supported by GPUParticleSystem
  72035. * @param gradient defines the gradient to use (between 0 and 1)
  72036. * @param factor defines the emit rate value to affect to the specified gradient
  72037. * @param factor2 defines an additional factor used to define a range ([factor, factor2]) with main value to pick the final value from
  72038. * @returns the current particle system
  72039. */
  72040. addEmitRateGradient(gradient: number, factor: number, factor2?: number): IParticleSystem;
  72041. /**
  72042. * Not supported by GPUParticleSystem
  72043. * @param gradient defines the gradient to remove
  72044. * @returns the current particle system
  72045. */
  72046. removeEmitRateGradient(gradient: number): IParticleSystem;
  72047. /**
  72048. * Not supported by GPUParticleSystem
  72049. * @param gradient defines the gradient to use (between 0 and 1)
  72050. * @param factor defines the start size value to affect to the specified gradient
  72051. * @param factor2 defines an additional factor used to define a range ([factor, factor2]) with main value to pick the final value from
  72052. * @returns the current particle system
  72053. */
  72054. addStartSizeGradient(gradient: number, factor: number, factor2?: number): IParticleSystem;
  72055. /**
  72056. * Not supported by GPUParticleSystem
  72057. * @param gradient defines the gradient to remove
  72058. * @returns the current particle system
  72059. */
  72060. removeStartSizeGradient(gradient: number): IParticleSystem;
  72061. /**
  72062. * Not supported by GPUParticleSystem
  72063. * @param gradient defines the gradient to use (between 0 and 1)
  72064. * @param min defines the color remap minimal range
  72065. * @param max defines the color remap maximal range
  72066. * @returns the current particle system
  72067. */
  72068. addColorRemapGradient(gradient: number, min: number, max: number): IParticleSystem;
  72069. /**
  72070. * Not supported by GPUParticleSystem
  72071. * @param gradient defines the gradient to remove
  72072. * @returns the current particle system
  72073. */
  72074. removeColorRemapGradient(): IParticleSystem;
  72075. /**
  72076. * Not supported by GPUParticleSystem
  72077. * @param gradient defines the gradient to use (between 0 and 1)
  72078. * @param min defines the alpha remap minimal range
  72079. * @param max defines the alpha remap maximal range
  72080. * @returns the current particle system
  72081. */
  72082. addAlphaRemapGradient(gradient: number, min: number, max: number): IParticleSystem;
  72083. /**
  72084. * Not supported by GPUParticleSystem
  72085. * @param gradient defines the gradient to remove
  72086. * @returns the current particle system
  72087. */
  72088. removeAlphaRemapGradient(): IParticleSystem;
  72089. /**
  72090. * Not supported by GPUParticleSystem
  72091. * @param gradient defines the gradient to use (between 0 and 1)
  72092. * @param color defines the color to affect to the specified gradient
  72093. * @returns the current particle system
  72094. */
  72095. addRampGradient(gradient: number, color: Color3): IParticleSystem;
  72096. /**
  72097. * Not supported by GPUParticleSystem
  72098. * @param gradient defines the gradient to remove
  72099. * @returns the current particle system
  72100. */
  72101. removeRampGradient(): IParticleSystem;
  72102. /**
  72103. * Not supported by GPUParticleSystem
  72104. * @returns the list of ramp gradients
  72105. */
  72106. getRampGradients(): Nullable<Array<Color3Gradient>>;
  72107. /**
  72108. * Not supported by GPUParticleSystem
  72109. * Gets or sets a boolean indicating that ramp gradients must be used
  72110. * @see https://doc.babylonjs.com/babylon101/particles#ramp-gradients
  72111. */
  72112. get useRampGradients(): boolean;
  72113. set useRampGradients(value: boolean);
  72114. /**
  72115. * Not supported by GPUParticleSystem
  72116. * @param gradient defines the gradient to use (between 0 and 1)
  72117. * @param factor defines the life time factor to affect to the specified gradient
  72118. * @param factor2 defines an additional factor used to define a range ([factor, factor2]) with main value to pick the final value from
  72119. * @returns the current particle system
  72120. */
  72121. addLifeTimeGradient(gradient: number, factor: number, factor2?: number): IParticleSystem;
  72122. /**
  72123. * Not supported by GPUParticleSystem
  72124. * @param gradient defines the gradient to remove
  72125. * @returns the current particle system
  72126. */
  72127. removeLifeTimeGradient(gradient: number): IParticleSystem;
  72128. /**
  72129. * Instantiates a GPU particle system.
  72130. * 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.
  72131. * @param name The name of the particle system
  72132. * @param options The options used to create the system
  72133. * @param sceneOrEngine The scene the particle system belongs to or the engine to use if no scene
  72134. * @param isAnimationSheetEnabled Must be true if using a spritesheet to animate the particles texture
  72135. * @param customEffect a custom effect used to change the way particles are rendered by default
  72136. */
  72137. constructor(name: string, options: Partial<{
  72138. capacity: number;
  72139. randomTextureSize: number;
  72140. }>, sceneOrEngine: Scene | ThinEngine, isAnimationSheetEnabled?: boolean, customEffect?: Nullable<Effect>);
  72141. protected _reset(): void;
  72142. private _createUpdateVAO;
  72143. private _createRenderVAO;
  72144. private _initialize;
  72145. /** @hidden */
  72146. _recreateUpdateEffect(): void;
  72147. private _getEffect;
  72148. /**
  72149. * Fill the defines array according to the current settings of the particle system
  72150. * @param defines Array to be updated
  72151. * @param blendMode blend mode to take into account when updating the array
  72152. */
  72153. fillDefines(defines: Array<string>, blendMode?: number): void;
  72154. /**
  72155. * Fill the uniforms, attributes and samplers arrays according to the current settings of the particle system
  72156. * @param uniforms Uniforms array to fill
  72157. * @param attributes Attributes array to fill
  72158. * @param samplers Samplers array to fill
  72159. */
  72160. fillUniformsAttributesAndSamplerNames(uniforms: Array<string>, attributes: Array<string>, samplers: Array<string>): void;
  72161. /** @hidden */
  72162. _recreateRenderEffect(): Effect;
  72163. /**
  72164. * Animates the particle system for the current frame by emitting new particles and or animating the living ones.
  72165. * @param preWarm defines if we are in the pre-warmimg phase
  72166. */
  72167. animate(preWarm?: boolean): void;
  72168. private _createFactorGradientTexture;
  72169. private _createSizeGradientTexture;
  72170. private _createAngularSpeedGradientTexture;
  72171. private _createVelocityGradientTexture;
  72172. private _createLimitVelocityGradientTexture;
  72173. private _createDragGradientTexture;
  72174. private _createColorGradientTexture;
  72175. /**
  72176. * Renders the particle system in its current state
  72177. * @param preWarm defines if the system should only update the particles but not render them
  72178. * @returns the current number of particles
  72179. */
  72180. render(preWarm?: boolean): number;
  72181. /**
  72182. * Rebuilds the particle system
  72183. */
  72184. rebuild(): void;
  72185. private _releaseBuffers;
  72186. private _releaseVAOs;
  72187. /**
  72188. * Disposes the particle system and free the associated resources
  72189. * @param disposeTexture defines if the particule texture must be disposed as well (true by default)
  72190. */
  72191. dispose(disposeTexture?: boolean): void;
  72192. /**
  72193. * Clones the particle system.
  72194. * @param name The name of the cloned object
  72195. * @param newEmitter The new emitter to use
  72196. * @returns the cloned particle system
  72197. */
  72198. clone(name: string, newEmitter: any): GPUParticleSystem;
  72199. /**
  72200. * Serializes the particle system to a JSON object
  72201. * @param serializeTexture defines if the texture must be serialized as well
  72202. * @returns the JSON object
  72203. */
  72204. serialize(serializeTexture?: boolean): any;
  72205. /**
  72206. * Parses a JSON object to create a GPU particle system.
  72207. * @param parsedParticleSystem The JSON object to parse
  72208. * @param sceneOrEngine The scene or the engine to create the particle system in
  72209. * @param rootUrl The root url to use to load external dependencies like texture
  72210. * @param doNotStart Ignore the preventAutoStart attribute and does not start
  72211. * @returns the parsed GPU particle system
  72212. */
  72213. static Parse(parsedParticleSystem: any, sceneOrEngine: Scene | ThinEngine, rootUrl: string, doNotStart?: boolean): GPUParticleSystem;
  72214. }
  72215. }
  72216. declare module "babylonjs/Particles/particleSystemSet" {
  72217. import { Nullable } from "babylonjs/types";
  72218. import { Color3 } from "babylonjs/Maths/math.color";
  72219. import { TransformNode } from "babylonjs/Meshes/transformNode";
  72220. import { AbstractMesh } from "babylonjs/Meshes/abstractMesh";
  72221. import { IParticleSystem } from "babylonjs/Particles/IParticleSystem";
  72222. import { Scene, IDisposable } from "babylonjs/scene";
  72223. /**
  72224. * Represents a set of particle systems working together to create a specific effect
  72225. */
  72226. export class ParticleSystemSet implements IDisposable {
  72227. /**
  72228. * Gets or sets base Assets URL
  72229. */
  72230. static BaseAssetsUrl: string;
  72231. private _emitterCreationOptions;
  72232. private _emitterNode;
  72233. /**
  72234. * Gets the particle system list
  72235. */
  72236. systems: IParticleSystem[];
  72237. /**
  72238. * Gets the emitter node used with this set
  72239. */
  72240. get emitterNode(): Nullable<TransformNode>;
  72241. /**
  72242. * Creates a new emitter mesh as a sphere
  72243. * @param options defines the options used to create the sphere
  72244. * @param renderingGroupId defines the renderingGroupId to use for the sphere
  72245. * @param scene defines the hosting scene
  72246. */
  72247. setEmitterAsSphere(options: {
  72248. diameter: number;
  72249. segments: number;
  72250. color: Color3;
  72251. }, renderingGroupId: number, scene: Scene): void;
  72252. /**
  72253. * Starts all particle systems of the set
  72254. * @param emitter defines an optional mesh to use as emitter for the particle systems
  72255. */
  72256. start(emitter?: AbstractMesh): void;
  72257. /**
  72258. * Release all associated resources
  72259. */
  72260. dispose(): void;
  72261. /**
  72262. * Serialize the set into a JSON compatible object
  72263. * @param serializeTexture defines if the texture must be serialized as well
  72264. * @returns a JSON compatible representation of the set
  72265. */
  72266. serialize(serializeTexture?: boolean): any;
  72267. /**
  72268. * Parse a new ParticleSystemSet from a serialized source
  72269. * @param data defines a JSON compatible representation of the set
  72270. * @param scene defines the hosting scene
  72271. * @param gpu defines if we want GPU particles or CPU particles
  72272. * @returns a new ParticleSystemSet
  72273. */
  72274. static Parse(data: any, scene: Scene, gpu?: boolean): ParticleSystemSet;
  72275. }
  72276. }
  72277. declare module "babylonjs/Particles/particleHelper" {
  72278. import { Nullable } from "babylonjs/types";
  72279. import { Scene } from "babylonjs/scene";
  72280. import { Vector3 } from "babylonjs/Maths/math.vector";
  72281. import { AbstractMesh } from "babylonjs/Meshes/abstractMesh";
  72282. import { IParticleSystem } from "babylonjs/Particles/IParticleSystem";
  72283. import { ParticleSystemSet } from "babylonjs/Particles/particleSystemSet";
  72284. /**
  72285. * This class is made for on one-liner static method to help creating particle system set.
  72286. */
  72287. export class ParticleHelper {
  72288. /**
  72289. * Gets or sets base Assets URL
  72290. */
  72291. static BaseAssetsUrl: string;
  72292. /** Define the Url to load snippets */
  72293. static SnippetUrl: string;
  72294. /**
  72295. * Create a default particle system that you can tweak
  72296. * @param emitter defines the emitter to use
  72297. * @param capacity defines the system capacity (default is 500 particles)
  72298. * @param scene defines the hosting scene
  72299. * @param useGPU defines if a GPUParticleSystem must be created (default is false)
  72300. * @returns the new Particle system
  72301. */
  72302. static CreateDefault(emitter: Nullable<AbstractMesh | Vector3>, capacity?: number, scene?: Scene, useGPU?: boolean): IParticleSystem;
  72303. /**
  72304. * This is the main static method (one-liner) of this helper to create different particle systems
  72305. * @param type This string represents the type to the particle system to create
  72306. * @param scene The scene where the particle system should live
  72307. * @param gpu If the system will use gpu
  72308. * @returns the ParticleSystemSet created
  72309. */
  72310. static CreateAsync(type: string, scene: Nullable<Scene>, gpu?: boolean): Promise<ParticleSystemSet>;
  72311. /**
  72312. * Static function used to export a particle system to a ParticleSystemSet variable.
  72313. * Please note that the emitter shape is not exported
  72314. * @param systems defines the particle systems to export
  72315. * @returns the created particle system set
  72316. */
  72317. static ExportSet(systems: IParticleSystem[]): ParticleSystemSet;
  72318. /**
  72319. * Creates a particle system from a snippet saved in a remote file
  72320. * @param name defines the name of the particle system to create (can be null or empty to use the one from the json data)
  72321. * @param url defines the url to load from
  72322. * @param scene defines the hosting scene
  72323. * @param gpu If the system will use gpu
  72324. * @param rootUrl defines the root URL to use to load textures and relative dependencies
  72325. * @returns a promise that will resolve to the new particle system
  72326. */
  72327. static ParseFromFileAsync(name: Nullable<string>, url: string, scene: Scene, gpu?: boolean, rootUrl?: string): Promise<IParticleSystem>;
  72328. /**
  72329. * Creates a particle system from a snippet saved by the particle system editor
  72330. * @param snippetId defines the snippet to load (can be set to _BLANK to create a default one)
  72331. * @param scene defines the hosting scene
  72332. * @param gpu If the system will use gpu
  72333. * @param rootUrl defines the root URL to use to load textures and relative dependencies
  72334. * @returns a promise that will resolve to the new particle system
  72335. */
  72336. static CreateFromSnippetAsync(snippetId: string, scene: Scene, gpu?: boolean, rootUrl?: string): Promise<IParticleSystem>;
  72337. }
  72338. }
  72339. declare module "babylonjs/Particles/particleSystemComponent" {
  72340. import { IParticleSystem } from "babylonjs/Particles/IParticleSystem";
  72341. import { Effect } from "babylonjs/Materials/effect";
  72342. import "babylonjs/Shaders/particles.vertex";
  72343. import { EffectFallbacks } from "babylonjs/Materials/effectFallbacks";
  72344. module "babylonjs/Engines/engine" {
  72345. interface Engine {
  72346. /**
  72347. * Create an effect to use with particle systems.
  72348. * Please note that some parameters like animation sheets or not being billboard are not supported in this configuration, except if you pass
  72349. * the particle system for which you want to create a custom effect in the last parameter
  72350. * @param fragmentName defines the base name of the effect (The name of file without .fragment.fx)
  72351. * @param uniformsNames defines a list of attribute names
  72352. * @param samplers defines an array of string used to represent textures
  72353. * @param defines defines the string containing the defines to use to compile the shaders
  72354. * @param fallbacks defines the list of potential fallbacks to use if shader conmpilation fails
  72355. * @param onCompiled defines a function to call when the effect creation is successful
  72356. * @param onError defines a function to call when the effect creation has failed
  72357. * @param particleSystem the particle system you want to create the effect for
  72358. * @returns the new Effect
  72359. */
  72360. createEffectForParticles(fragmentName: string, uniformsNames: string[], samplers: string[], defines: string, fallbacks?: EffectFallbacks, onCompiled?: (effect: Effect) => void, onError?: (effect: Effect, errors: string) => void, particleSystem?: IParticleSystem): Effect;
  72361. }
  72362. }
  72363. module "babylonjs/Meshes/mesh" {
  72364. interface Mesh {
  72365. /**
  72366. * Returns an array populated with IParticleSystem objects whose the mesh is the emitter
  72367. * @returns an array of IParticleSystem
  72368. */
  72369. getEmittedParticleSystems(): IParticleSystem[];
  72370. /**
  72371. * Returns an array populated with IParticleSystem objects whose the mesh or its children are the emitter
  72372. * @returns an array of IParticleSystem
  72373. */
  72374. getHierarchyEmittedParticleSystems(): IParticleSystem[];
  72375. }
  72376. }
  72377. }
  72378. declare module "babylonjs/Particles/pointsCloudSystem" {
  72379. import { Color4 } from "babylonjs/Maths/math";
  72380. import { Mesh } from "babylonjs/Meshes/mesh";
  72381. import { Scene, IDisposable } from "babylonjs/scene";
  72382. import { CloudPoint } from "babylonjs/Particles/cloudPoint";
  72383. /** Defines the 4 color options */
  72384. export enum PointColor {
  72385. /** color value */
  72386. Color = 2,
  72387. /** uv value */
  72388. UV = 1,
  72389. /** random value */
  72390. Random = 0,
  72391. /** stated value */
  72392. Stated = 3
  72393. }
  72394. /**
  72395. * The PointCloudSystem (PCS) is a single updatable mesh. The points corresponding to the vertices of this big mesh.
  72396. * 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.
  72397. * The PointCloudSytem is also a particle system, with each point being a particle. It provides some methods to manage the particles.
  72398. * However it is behavior agnostic. This means it has no emitter, no particle physics, no particle recycler. You have to implement your own behavior.
  72399. *
  72400. * Full documentation here : TO BE ENTERED
  72401. */
  72402. export class PointsCloudSystem implements IDisposable {
  72403. /**
  72404. * The PCS array of cloud point objects. Just access each particle as with any classic array.
  72405. * Example : var p = SPS.particles[i];
  72406. */
  72407. particles: CloudPoint[];
  72408. /**
  72409. * The PCS total number of particles. Read only. Use PCS.counter instead if you need to set your own value.
  72410. */
  72411. nbParticles: number;
  72412. /**
  72413. * This a counter for your own usage. It's not set by any SPS functions.
  72414. */
  72415. counter: number;
  72416. /**
  72417. * The PCS name. This name is also given to the underlying mesh.
  72418. */
  72419. name: string;
  72420. /**
  72421. * The PCS mesh. It's a standard BJS Mesh, so all the methods from the Mesh class are avalaible.
  72422. */
  72423. mesh: Mesh;
  72424. /**
  72425. * This empty object is intended to store some PCS specific or temporary values in order to lower the Garbage Collector activity.
  72426. * Please read :
  72427. */
  72428. vars: any;
  72429. /**
  72430. * @hidden
  72431. */
  72432. _size: number;
  72433. private _scene;
  72434. private _promises;
  72435. private _positions;
  72436. private _indices;
  72437. private _normals;
  72438. private _colors;
  72439. private _uvs;
  72440. private _indices32;
  72441. private _positions32;
  72442. private _colors32;
  72443. private _uvs32;
  72444. private _updatable;
  72445. private _isVisibilityBoxLocked;
  72446. private _alwaysVisible;
  72447. private _groups;
  72448. private _groupCounter;
  72449. private _computeParticleColor;
  72450. private _computeParticleTexture;
  72451. private _computeParticleRotation;
  72452. private _computeBoundingBox;
  72453. private _isReady;
  72454. /**
  72455. * Creates a PCS (Points Cloud System) object
  72456. * @param name (String) is the PCS name, this will be the underlying mesh name
  72457. * @param pointSize (number) is the size for each point
  72458. * @param scene (Scene) is the scene in which the PCS is added
  72459. * @param options defines the options of the PCS e.g.
  72460. * * updatable (optional boolean, default true) : if the PCS must be updatable or immutable
  72461. */
  72462. constructor(name: string, pointSize: number, scene: Scene, options?: {
  72463. updatable?: boolean;
  72464. });
  72465. /**
  72466. * Builds the PCS underlying mesh. Returns a standard Mesh.
  72467. * If no points were added to the PCS, the returned mesh is just a single point.
  72468. * @returns a promise for the created mesh
  72469. */
  72470. buildMeshAsync(): Promise<Mesh>;
  72471. /**
  72472. * @hidden
  72473. */
  72474. private _buildMesh;
  72475. private _addParticle;
  72476. private _randomUnitVector;
  72477. private _getColorIndicesForCoord;
  72478. private _setPointsColorOrUV;
  72479. private _colorFromTexture;
  72480. private _calculateDensity;
  72481. /**
  72482. * Adds points to the PCS in random positions within a unit sphere
  72483. * @param nb (positive integer) the number of particles to be created from this model
  72484. * @param pointFunction is an optional javascript function to be called for each particle on PCS creation
  72485. * @returns the number of groups in the system
  72486. */
  72487. addPoints(nb: number, pointFunction?: any): number;
  72488. /**
  72489. * Adds points to the PCS from the surface of the model shape
  72490. * @param mesh is any Mesh object that will be used as a surface model for the points
  72491. * @param nb (positive integer) the number of particles to be created from this model
  72492. * @param colorWith determines whether a point is colored using color (default), uv, random, stated or none (invisible)
  72493. * @param color (color4) to be used when colorWith is stated or color (number) when used to specify texture position
  72494. * @param range (number from 0 to 1) to determine the variation in shape and tone for a stated color
  72495. * @returns the number of groups in the system
  72496. */
  72497. addSurfacePoints(mesh: Mesh, nb: number, colorWith?: number, color?: Color4 | number, range?: number): number;
  72498. /**
  72499. * Adds points to the PCS inside the model shape
  72500. * @param mesh is any Mesh object that will be used as a surface model for the points
  72501. * @param nb (positive integer) the number of particles to be created from this model
  72502. * @param colorWith determines whether a point is colored using color (default), uv, random, stated or none (invisible)
  72503. * @param color (color4) to be used when colorWith is stated or color (number) when used to specify texture position
  72504. * @param range (number from 0 to 1) to determine the variation in shape and tone for a stated color
  72505. * @returns the number of groups in the system
  72506. */
  72507. addVolumePoints(mesh: Mesh, nb: number, colorWith?: number, color?: Color4 | number, range?: number): number;
  72508. /**
  72509. * Sets all the particles : this method actually really updates the mesh according to the particle positions, rotations, colors, textures, etc.
  72510. * This method calls `updateParticle()` for each particle of the SPS.
  72511. * For an animated SPS, it is usually called within the render loop.
  72512. * @param start The particle index in the particle array where to start to compute the particle property values _(default 0)_
  72513. * @param end The particle index in the particle array where to stop to compute the particle property values _(default nbParticle - 1)_
  72514. * @param update If the mesh must be finally updated on this call after all the particle computations _(default true)_
  72515. * @returns the PCS.
  72516. */
  72517. setParticles(start?: number, end?: number, update?: boolean): PointsCloudSystem;
  72518. /**
  72519. * Disposes the PCS.
  72520. */
  72521. dispose(): void;
  72522. /**
  72523. * Visibilty helper : Recomputes the visible size according to the mesh bounding box
  72524. * doc :
  72525. * @returns the PCS.
  72526. */
  72527. refreshVisibleSize(): PointsCloudSystem;
  72528. /**
  72529. * Visibility helper : Sets the size of a visibility box, this sets the underlying mesh bounding box.
  72530. * @param size the size (float) of the visibility box
  72531. * note : this doesn't lock the PCS mesh bounding box.
  72532. * doc :
  72533. */
  72534. setVisibilityBox(size: number): void;
  72535. /**
  72536. * Gets whether the PCS is always visible or not
  72537. * doc :
  72538. */
  72539. get isAlwaysVisible(): boolean;
  72540. /**
  72541. * Sets the PCS as always visible or not
  72542. * doc :
  72543. */
  72544. set isAlwaysVisible(val: boolean);
  72545. /**
  72546. * Tells to `setParticles()` to compute the particle rotations or not
  72547. * Default value : false. The PCS is faster when it's set to false
  72548. * Note : particle rotations are only applied to parent particles
  72549. * Note : the particle rotations aren't stored values, so setting `computeParticleRotation` to false will prevents the particle to rotate
  72550. */
  72551. set computeParticleRotation(val: boolean);
  72552. /**
  72553. * Tells to `setParticles()` to compute the particle colors or not.
  72554. * Default value : true. The PCS is faster when it's set to false.
  72555. * Note : the particle colors are stored values, so setting `computeParticleColor` to false will keep yet the last colors set.
  72556. */
  72557. set computeParticleColor(val: boolean);
  72558. set computeParticleTexture(val: boolean);
  72559. /**
  72560. * Gets if `setParticles()` computes the particle colors or not.
  72561. * Default value : false. The PCS is faster when it's set to false.
  72562. * Note : the particle colors are stored values, so setting `computeParticleColor` to false will keep yet the last colors set.
  72563. */
  72564. get computeParticleColor(): boolean;
  72565. /**
  72566. * Gets if `setParticles()` computes the particle textures or not.
  72567. * Default value : false. The PCS is faster when it's set to false.
  72568. * Note : the particle textures are stored values, so setting `computeParticleTexture` to false will keep yet the last colors set.
  72569. */
  72570. get computeParticleTexture(): boolean;
  72571. /**
  72572. * Tells to `setParticles()` to compute or not the mesh bounding box when computing the particle positions.
  72573. */
  72574. set computeBoundingBox(val: boolean);
  72575. /**
  72576. * Gets if `setParticles()` computes or not the mesh bounding box when computing the particle positions.
  72577. */
  72578. get computeBoundingBox(): boolean;
  72579. /**
  72580. * This function does nothing. It may be overwritten to set all the particle first values.
  72581. * The PCS doesn't call this function, you may have to call it by your own.
  72582. * doc :
  72583. */
  72584. initParticles(): void;
  72585. /**
  72586. * This function does nothing. It may be overwritten to recycle a particle
  72587. * The PCS doesn't call this function, you can to call it
  72588. * doc :
  72589. * @param particle The particle to recycle
  72590. * @returns the recycled particle
  72591. */
  72592. recycleParticle(particle: CloudPoint): CloudPoint;
  72593. /**
  72594. * Updates a particle : this function should be overwritten by the user.
  72595. * It is called on each particle by `setParticles()`. This is the place to code each particle behavior.
  72596. * doc :
  72597. * @example : just set a particle position or velocity and recycle conditions
  72598. * @param particle The particle to update
  72599. * @returns the updated particle
  72600. */
  72601. updateParticle(particle: CloudPoint): CloudPoint;
  72602. /**
  72603. * This will be called before any other treatment by `setParticles()` and will be passed three parameters.
  72604. * This does nothing and may be overwritten by the user.
  72605. * @param start the particle index in the particle array where to start to iterate, same than the value passed to setParticle()
  72606. * @param stop the particle index in the particle array where to stop to iterate, same than the value passed to setParticle()
  72607. * @param update the boolean update value actually passed to setParticles()
  72608. */
  72609. beforeUpdateParticles(start?: number, stop?: number, update?: boolean): void;
  72610. /**
  72611. * This will be called by `setParticles()` after all the other treatments and just before the actual mesh update.
  72612. * This will be passed three parameters.
  72613. * This does nothing and may be overwritten by the user.
  72614. * @param start the particle index in the particle array where to start to iterate, same than the value passed to setParticle()
  72615. * @param stop the particle index in the particle array where to stop to iterate, same than the value passed to setParticle()
  72616. * @param update the boolean update value actually passed to setParticles()
  72617. */
  72618. afterUpdateParticles(start?: number, stop?: number, update?: boolean): void;
  72619. }
  72620. }
  72621. declare module "babylonjs/Particles/cloudPoint" {
  72622. import { Nullable } from "babylonjs/types";
  72623. import { Color4, Vector2, Vector3, Matrix, Quaternion } from "babylonjs/Maths/math";
  72624. import { Mesh } from "babylonjs/Meshes/mesh";
  72625. import { BoundingInfo } from "babylonjs/Culling/boundingInfo";
  72626. import { PointsCloudSystem } from "babylonjs/Particles/pointsCloudSystem";
  72627. /**
  72628. * Represents one particle of a points cloud system.
  72629. */
  72630. export class CloudPoint {
  72631. /**
  72632. * particle global index
  72633. */
  72634. idx: number;
  72635. /**
  72636. * The color of the particle
  72637. */
  72638. color: Nullable<Color4>;
  72639. /**
  72640. * The world space position of the particle.
  72641. */
  72642. position: Vector3;
  72643. /**
  72644. * The world space rotation of the particle. (Not use if rotationQuaternion is set)
  72645. */
  72646. rotation: Vector3;
  72647. /**
  72648. * The world space rotation quaternion of the particle.
  72649. */
  72650. rotationQuaternion: Nullable<Quaternion>;
  72651. /**
  72652. * The uv of the particle.
  72653. */
  72654. uv: Nullable<Vector2>;
  72655. /**
  72656. * The current speed of the particle.
  72657. */
  72658. velocity: Vector3;
  72659. /**
  72660. * The pivot point in the particle local space.
  72661. */
  72662. pivot: Vector3;
  72663. /**
  72664. * Must the particle be translated from its pivot point in its local space ?
  72665. * In this case, the pivot point is set at the origin of the particle local space and the particle is translated.
  72666. * Default : false
  72667. */
  72668. translateFromPivot: boolean;
  72669. /**
  72670. * Index of this particle in the global "positions" array (Internal use)
  72671. * @hidden
  72672. */
  72673. _pos: number;
  72674. /**
  72675. * @hidden Index of this particle in the global "indices" array (Internal use)
  72676. */
  72677. _ind: number;
  72678. /**
  72679. * Group this particle belongs to
  72680. */
  72681. _group: PointsGroup;
  72682. /**
  72683. * Group id of this particle
  72684. */
  72685. groupId: number;
  72686. /**
  72687. * Index of the particle in its group id (Internal use)
  72688. */
  72689. idxInGroup: number;
  72690. /**
  72691. * @hidden Particle BoundingInfo object (Internal use)
  72692. */
  72693. _boundingInfo: BoundingInfo;
  72694. /**
  72695. * @hidden Reference to the PCS that the particle belongs to (Internal use)
  72696. */
  72697. _pcs: PointsCloudSystem;
  72698. /**
  72699. * @hidden Still set as invisible in order to skip useless computations (Internal use)
  72700. */
  72701. _stillInvisible: boolean;
  72702. /**
  72703. * @hidden Last computed particle rotation matrix
  72704. */
  72705. _rotationMatrix: number[];
  72706. /**
  72707. * Parent particle Id, if any.
  72708. * Default null.
  72709. */
  72710. parentId: Nullable<number>;
  72711. /**
  72712. * @hidden Internal global position in the PCS.
  72713. */
  72714. _globalPosition: Vector3;
  72715. /**
  72716. * Creates a Point Cloud object.
  72717. * Don't create particles manually, use instead the PCS internal tools like _addParticle()
  72718. * @param particleIndex (integer) is the particle index in the PCS pool. It's also the particle identifier.
  72719. * @param group (PointsGroup) is the group the particle belongs to
  72720. * @param groupId (integer) is the group identifier in the PCS.
  72721. * @param idxInGroup (integer) is the index of the particle in the current point group (ex: the 10th point of addPoints(30))
  72722. * @param pcs defines the PCS it is associated to
  72723. */
  72724. constructor(particleIndex: number, group: PointsGroup, groupId: number, idxInGroup: number, pcs: PointsCloudSystem);
  72725. /**
  72726. * get point size
  72727. */
  72728. get size(): Vector3;
  72729. /**
  72730. * Set point size
  72731. */
  72732. set size(scale: Vector3);
  72733. /**
  72734. * Legacy support, changed quaternion to rotationQuaternion
  72735. */
  72736. get quaternion(): Nullable<Quaternion>;
  72737. /**
  72738. * Legacy support, changed quaternion to rotationQuaternion
  72739. */
  72740. set quaternion(q: Nullable<Quaternion>);
  72741. /**
  72742. * Returns a boolean. True if the particle intersects a mesh, else false
  72743. * The intersection is computed on the particle position and Axis Aligned Bounding Box (AABB) or Sphere
  72744. * @param target is the object (point or mesh) what the intersection is computed against
  72745. * @param isSphere is boolean flag when false (default) bounding box of mesh is used, when true the bouding sphere is used
  72746. * @returns true if it intersects
  72747. */
  72748. intersectsMesh(target: Mesh, isSphere: boolean): boolean;
  72749. /**
  72750. * get the rotation matrix of the particle
  72751. * @hidden
  72752. */
  72753. getRotationMatrix(m: Matrix): void;
  72754. }
  72755. /**
  72756. * Represents a group of points in a points cloud system
  72757. * * PCS internal tool, don't use it manually.
  72758. */
  72759. export class PointsGroup {
  72760. /**
  72761. * The group id
  72762. * @hidden
  72763. */
  72764. groupID: number;
  72765. /**
  72766. * image data for group (internal use)
  72767. * @hidden
  72768. */
  72769. _groupImageData: Nullable<ArrayBufferView>;
  72770. /**
  72771. * Image Width (internal use)
  72772. * @hidden
  72773. */
  72774. _groupImgWidth: number;
  72775. /**
  72776. * Image Height (internal use)
  72777. * @hidden
  72778. */
  72779. _groupImgHeight: number;
  72780. /**
  72781. * Custom position function (internal use)
  72782. * @hidden
  72783. */
  72784. _positionFunction: Nullable<(particle: CloudPoint, i?: number, s?: number) => void>;
  72785. /**
  72786. * density per facet for surface points
  72787. * @hidden
  72788. */
  72789. _groupDensity: number[];
  72790. /**
  72791. * Only when points are colored by texture carries pointer to texture list array
  72792. * @hidden
  72793. */
  72794. _textureNb: number;
  72795. /**
  72796. * Creates a points group object. This is an internal reference to produce particles for the PCS.
  72797. * PCS internal tool, don't use it manually.
  72798. * @hidden
  72799. */
  72800. constructor(id: number, posFunction: Nullable<(particle: CloudPoint, i?: number, s?: number) => void>);
  72801. }
  72802. }
  72803. declare module "babylonjs/Particles/index" {
  72804. export * from "babylonjs/Particles/baseParticleSystem";
  72805. export * from "babylonjs/Particles/EmitterTypes/index";
  72806. export * from "babylonjs/Particles/gpuParticleSystem";
  72807. export * from "babylonjs/Particles/IParticleSystem";
  72808. export * from "babylonjs/Particles/particle";
  72809. export * from "babylonjs/Particles/particleHelper";
  72810. export * from "babylonjs/Particles/particleSystem";
  72811. import "babylonjs/Particles/particleSystemComponent";
  72812. export * from "babylonjs/Particles/particleSystemComponent";
  72813. export * from "babylonjs/Particles/particleSystemSet";
  72814. export * from "babylonjs/Particles/solidParticle";
  72815. export * from "babylonjs/Particles/solidParticleSystem";
  72816. export * from "babylonjs/Particles/cloudPoint";
  72817. export * from "babylonjs/Particles/pointsCloudSystem";
  72818. export * from "babylonjs/Particles/subEmitter";
  72819. }
  72820. declare module "babylonjs/Physics/physicsEngineComponent" {
  72821. import { Nullable } from "babylonjs/types";
  72822. import { Observable, Observer } from "babylonjs/Misc/observable";
  72823. import { Vector3 } from "babylonjs/Maths/math.vector";
  72824. import { Mesh } from "babylonjs/Meshes/mesh";
  72825. import { ISceneComponent } from "babylonjs/sceneComponent";
  72826. import { Scene } from "babylonjs/scene";
  72827. import { Node } from "babylonjs/node";
  72828. import { IPhysicsEngine, IPhysicsEnginePlugin } from "babylonjs/Physics/IPhysicsEngine";
  72829. import { PhysicsImpostor } from "babylonjs/Physics/physicsImpostor";
  72830. module "babylonjs/scene" {
  72831. interface Scene {
  72832. /** @hidden (Backing field) */
  72833. _physicsEngine: Nullable<IPhysicsEngine>;
  72834. /** @hidden */
  72835. _physicsTimeAccumulator: number;
  72836. /**
  72837. * Gets the current physics engine
  72838. * @returns a IPhysicsEngine or null if none attached
  72839. */
  72840. getPhysicsEngine(): Nullable<IPhysicsEngine>;
  72841. /**
  72842. * Enables physics to the current scene
  72843. * @param gravity defines the scene's gravity for the physics engine
  72844. * @param plugin defines the physics engine to be used. defaults to OimoJS.
  72845. * @return a boolean indicating if the physics engine was initialized
  72846. */
  72847. enablePhysics(gravity: Nullable<Vector3>, plugin?: IPhysicsEnginePlugin): boolean;
  72848. /**
  72849. * Disables and disposes the physics engine associated with the scene
  72850. */
  72851. disablePhysicsEngine(): void;
  72852. /**
  72853. * Gets a boolean indicating if there is an active physics engine
  72854. * @returns a boolean indicating if there is an active physics engine
  72855. */
  72856. isPhysicsEnabled(): boolean;
  72857. /**
  72858. * Deletes a physics compound impostor
  72859. * @param compound defines the compound to delete
  72860. */
  72861. deleteCompoundImpostor(compound: any): void;
  72862. /**
  72863. * An event triggered when physic simulation is about to be run
  72864. */
  72865. onBeforePhysicsObservable: Observable<Scene>;
  72866. /**
  72867. * An event triggered when physic simulation has been done
  72868. */
  72869. onAfterPhysicsObservable: Observable<Scene>;
  72870. }
  72871. }
  72872. module "babylonjs/Meshes/abstractMesh" {
  72873. interface AbstractMesh {
  72874. /** @hidden */
  72875. _physicsImpostor: Nullable<PhysicsImpostor>;
  72876. /**
  72877. * Gets or sets impostor used for physic simulation
  72878. * @see https://doc.babylonjs.com/features/physics_engine
  72879. */
  72880. physicsImpostor: Nullable<PhysicsImpostor>;
  72881. /**
  72882. * Gets the current physics impostor
  72883. * @see https://doc.babylonjs.com/features/physics_engine
  72884. * @returns a physics impostor or null
  72885. */
  72886. getPhysicsImpostor(): Nullable<PhysicsImpostor>;
  72887. /** Apply a physic impulse to the mesh
  72888. * @param force defines the force to apply
  72889. * @param contactPoint defines where to apply the force
  72890. * @returns the current mesh
  72891. * @see https://doc.babylonjs.com/how_to/using_the_physics_engine
  72892. */
  72893. applyImpulse(force: Vector3, contactPoint: Vector3): AbstractMesh;
  72894. /**
  72895. * Creates a physic joint between two meshes
  72896. * @param otherMesh defines the other mesh to use
  72897. * @param pivot1 defines the pivot to use on this mesh
  72898. * @param pivot2 defines the pivot to use on the other mesh
  72899. * @param options defines additional options (can be plugin dependent)
  72900. * @returns the current mesh
  72901. * @see https://www.babylonjs-playground.com/#0BS5U0#0
  72902. */
  72903. setPhysicsLinkWith(otherMesh: Mesh, pivot1: Vector3, pivot2: Vector3, options?: any): AbstractMesh;
  72904. /** @hidden */
  72905. _disposePhysicsObserver: Nullable<Observer<Node>>;
  72906. }
  72907. }
  72908. /**
  72909. * Defines the physics engine scene component responsible to manage a physics engine
  72910. */
  72911. export class PhysicsEngineSceneComponent implements ISceneComponent {
  72912. /**
  72913. * The component name helpful to identify the component in the list of scene components.
  72914. */
  72915. readonly name: string;
  72916. /**
  72917. * The scene the component belongs to.
  72918. */
  72919. scene: Scene;
  72920. /**
  72921. * Creates a new instance of the component for the given scene
  72922. * @param scene Defines the scene to register the component in
  72923. */
  72924. constructor(scene: Scene);
  72925. /**
  72926. * Registers the component in a given scene
  72927. */
  72928. register(): void;
  72929. /**
  72930. * Rebuilds the elements related to this component in case of
  72931. * context lost for instance.
  72932. */
  72933. rebuild(): void;
  72934. /**
  72935. * Disposes the component and the associated ressources
  72936. */
  72937. dispose(): void;
  72938. }
  72939. }
  72940. declare module "babylonjs/Physics/physicsHelper" {
  72941. import { Nullable } from "babylonjs/types";
  72942. import { Vector3 } from "babylonjs/Maths/math.vector";
  72943. import { Mesh } from "babylonjs/Meshes/mesh";
  72944. import { Scene } from "babylonjs/scene";
  72945. import { PhysicsImpostor } from "babylonjs/Physics/physicsImpostor";
  72946. /**
  72947. * A helper for physics simulations
  72948. * @see https://doc.babylonjs.com/how_to/using_the_physics_engine#further-functionality-of-the-impostor-class
  72949. */
  72950. export class PhysicsHelper {
  72951. private _scene;
  72952. private _physicsEngine;
  72953. /**
  72954. * Initializes the Physics helper
  72955. * @param scene Babylon.js scene
  72956. */
  72957. constructor(scene: Scene);
  72958. /**
  72959. * Applies a radial explosion impulse
  72960. * @param origin the origin of the explosion
  72961. * @param radiusOrEventOptions the radius or the options of radial explosion
  72962. * @param strength the explosion strength
  72963. * @param falloff possible options: Constant & Linear. Defaults to Constant
  72964. * @returns A physics radial explosion event, or null
  72965. */
  72966. applyRadialExplosionImpulse(origin: Vector3, radiusOrEventOptions: number | PhysicsRadialExplosionEventOptions, strength?: number, falloff?: PhysicsRadialImpulseFalloff): Nullable<PhysicsRadialExplosionEvent>;
  72967. /**
  72968. * Applies a radial explosion force
  72969. * @param origin the origin of the explosion
  72970. * @param radiusOrEventOptions the radius or the options of radial explosion
  72971. * @param strength the explosion strength
  72972. * @param falloff possible options: Constant & Linear. Defaults to Constant
  72973. * @returns A physics radial explosion event, or null
  72974. */
  72975. applyRadialExplosionForce(origin: Vector3, radiusOrEventOptions: number | PhysicsRadialExplosionEventOptions, strength?: number, falloff?: PhysicsRadialImpulseFalloff): Nullable<PhysicsRadialExplosionEvent>;
  72976. /**
  72977. * Creates a gravitational field
  72978. * @param origin the origin of the explosion
  72979. * @param radiusOrEventOptions the radius or the options of radial explosion
  72980. * @param strength the explosion strength
  72981. * @param falloff possible options: Constant & Linear. Defaults to Constant
  72982. * @returns A physics gravitational field event, or null
  72983. */
  72984. gravitationalField(origin: Vector3, radiusOrEventOptions: number | PhysicsRadialExplosionEventOptions, strength?: number, falloff?: PhysicsRadialImpulseFalloff): Nullable<PhysicsGravitationalFieldEvent>;
  72985. /**
  72986. * Creates a physics updraft event
  72987. * @param origin the origin of the updraft
  72988. * @param radiusOrEventOptions the radius or the options of the updraft
  72989. * @param strength the strength of the updraft
  72990. * @param height the height of the updraft
  72991. * @param updraftMode possible options: Center & Perpendicular. Defaults to Center
  72992. * @returns A physics updraft event, or null
  72993. */
  72994. updraft(origin: Vector3, radiusOrEventOptions: number | PhysicsUpdraftEventOptions, strength?: number, height?: number, updraftMode?: PhysicsUpdraftMode): Nullable<PhysicsUpdraftEvent>;
  72995. /**
  72996. * Creates a physics vortex event
  72997. * @param origin the of the vortex
  72998. * @param radiusOrEventOptions the radius or the options of the vortex
  72999. * @param strength the strength of the vortex
  73000. * @param height the height of the vortex
  73001. * @returns a Physics vortex event, or null
  73002. * A physics vortex event or null
  73003. */
  73004. vortex(origin: Vector3, radiusOrEventOptions: number | PhysicsVortexEventOptions, strength?: number, height?: number): Nullable<PhysicsVortexEvent>;
  73005. }
  73006. /**
  73007. * Represents a physics radial explosion event
  73008. */
  73009. class PhysicsRadialExplosionEvent {
  73010. private _scene;
  73011. private _options;
  73012. private _sphere;
  73013. private _dataFetched;
  73014. /**
  73015. * Initializes a radial explosioin event
  73016. * @param _scene BabylonJS scene
  73017. * @param _options The options for the vortex event
  73018. */
  73019. constructor(_scene: Scene, _options: PhysicsRadialExplosionEventOptions);
  73020. /**
  73021. * Returns the data related to the radial explosion event (sphere).
  73022. * @returns The radial explosion event data
  73023. */
  73024. getData(): PhysicsRadialExplosionEventData;
  73025. /**
  73026. * Returns the force and contact point of the impostor or false, if the impostor is not affected by the force/impulse.
  73027. * @param impostor A physics imposter
  73028. * @param origin the origin of the explosion
  73029. * @returns {Nullable<PhysicsHitData>} A physics force and contact point, or null
  73030. */
  73031. getImpostorHitData(impostor: PhysicsImpostor, origin: Vector3): Nullable<PhysicsHitData>;
  73032. /**
  73033. * Triggers affecterd impostors callbacks
  73034. * @param affectedImpostorsWithData defines the list of affected impostors (including associated data)
  73035. */
  73036. triggerAffectedImpostorsCallback(affectedImpostorsWithData: Array<PhysicsAffectedImpostorWithData>): void;
  73037. /**
  73038. * Disposes the sphere.
  73039. * @param force Specifies if the sphere should be disposed by force
  73040. */
  73041. dispose(force?: boolean): void;
  73042. /*** Helpers ***/
  73043. private _prepareSphere;
  73044. private _intersectsWithSphere;
  73045. }
  73046. /**
  73047. * Represents a gravitational field event
  73048. */
  73049. class PhysicsGravitationalFieldEvent {
  73050. private _physicsHelper;
  73051. private _scene;
  73052. private _origin;
  73053. private _options;
  73054. private _tickCallback;
  73055. private _sphere;
  73056. private _dataFetched;
  73057. /**
  73058. * Initializes the physics gravitational field event
  73059. * @param _physicsHelper A physics helper
  73060. * @param _scene BabylonJS scene
  73061. * @param _origin The origin position of the gravitational field event
  73062. * @param _options The options for the vortex event
  73063. */
  73064. constructor(_physicsHelper: PhysicsHelper, _scene: Scene, _origin: Vector3, _options: PhysicsRadialExplosionEventOptions);
  73065. /**
  73066. * Returns the data related to the gravitational field event (sphere).
  73067. * @returns A gravitational field event
  73068. */
  73069. getData(): PhysicsGravitationalFieldEventData;
  73070. /**
  73071. * Enables the gravitational field.
  73072. */
  73073. enable(): void;
  73074. /**
  73075. * Disables the gravitational field.
  73076. */
  73077. disable(): void;
  73078. /**
  73079. * Disposes the sphere.
  73080. * @param force The force to dispose from the gravitational field event
  73081. */
  73082. dispose(force?: boolean): void;
  73083. private _tick;
  73084. }
  73085. /**
  73086. * Represents a physics updraft event
  73087. */
  73088. class PhysicsUpdraftEvent {
  73089. private _scene;
  73090. private _origin;
  73091. private _options;
  73092. private _physicsEngine;
  73093. private _originTop;
  73094. private _originDirection;
  73095. private _tickCallback;
  73096. private _cylinder;
  73097. private _cylinderPosition;
  73098. private _dataFetched;
  73099. /**
  73100. * Initializes the physics updraft event
  73101. * @param _scene BabylonJS scene
  73102. * @param _origin The origin position of the updraft
  73103. * @param _options The options for the updraft event
  73104. */
  73105. constructor(_scene: Scene, _origin: Vector3, _options: PhysicsUpdraftEventOptions);
  73106. /**
  73107. * Returns the data related to the updraft event (cylinder).
  73108. * @returns A physics updraft event
  73109. */
  73110. getData(): PhysicsUpdraftEventData;
  73111. /**
  73112. * Enables the updraft.
  73113. */
  73114. enable(): void;
  73115. /**
  73116. * Disables the updraft.
  73117. */
  73118. disable(): void;
  73119. /**
  73120. * Disposes the cylinder.
  73121. * @param force Specifies if the updraft should be disposed by force
  73122. */
  73123. dispose(force?: boolean): void;
  73124. private getImpostorHitData;
  73125. private _tick;
  73126. /*** Helpers ***/
  73127. private _prepareCylinder;
  73128. private _intersectsWithCylinder;
  73129. }
  73130. /**
  73131. * Represents a physics vortex event
  73132. */
  73133. class PhysicsVortexEvent {
  73134. private _scene;
  73135. private _origin;
  73136. private _options;
  73137. private _physicsEngine;
  73138. private _originTop;
  73139. private _tickCallback;
  73140. private _cylinder;
  73141. private _cylinderPosition;
  73142. private _dataFetched;
  73143. /**
  73144. * Initializes the physics vortex event
  73145. * @param _scene The BabylonJS scene
  73146. * @param _origin The origin position of the vortex
  73147. * @param _options The options for the vortex event
  73148. */
  73149. constructor(_scene: Scene, _origin: Vector3, _options: PhysicsVortexEventOptions);
  73150. /**
  73151. * Returns the data related to the vortex event (cylinder).
  73152. * @returns The physics vortex event data
  73153. */
  73154. getData(): PhysicsVortexEventData;
  73155. /**
  73156. * Enables the vortex.
  73157. */
  73158. enable(): void;
  73159. /**
  73160. * Disables the cortex.
  73161. */
  73162. disable(): void;
  73163. /**
  73164. * Disposes the sphere.
  73165. * @param force
  73166. */
  73167. dispose(force?: boolean): void;
  73168. private getImpostorHitData;
  73169. private _tick;
  73170. /*** Helpers ***/
  73171. private _prepareCylinder;
  73172. private _intersectsWithCylinder;
  73173. }
  73174. /**
  73175. * Options fot the radial explosion event
  73176. * @see https://doc.babylonjs.com/how_to/using_the_physics_engine#further-functionality-of-the-impostor-class
  73177. */
  73178. export class PhysicsRadialExplosionEventOptions {
  73179. /**
  73180. * The radius of the sphere for the radial explosion.
  73181. */
  73182. radius: number;
  73183. /**
  73184. * The strenth of the explosion.
  73185. */
  73186. strength: number;
  73187. /**
  73188. * The strenght of the force in correspondence to the distance of the affected object
  73189. */
  73190. falloff: PhysicsRadialImpulseFalloff;
  73191. /**
  73192. * Sphere options for the radial explosion.
  73193. */
  73194. sphere: {
  73195. segments: number;
  73196. diameter: number;
  73197. };
  73198. /**
  73199. * Sphere options for the radial explosion.
  73200. */
  73201. affectedImpostorsCallback: (affectedImpostorsWithData: Array<PhysicsAffectedImpostorWithData>) => void;
  73202. }
  73203. /**
  73204. * Options fot the updraft event
  73205. * @see https://doc.babylonjs.com/how_to/using_the_physics_engine#further-functionality-of-the-impostor-class
  73206. */
  73207. export class PhysicsUpdraftEventOptions {
  73208. /**
  73209. * The radius of the cylinder for the vortex
  73210. */
  73211. radius: number;
  73212. /**
  73213. * The strenth of the updraft.
  73214. */
  73215. strength: number;
  73216. /**
  73217. * The height of the cylinder for the updraft.
  73218. */
  73219. height: number;
  73220. /**
  73221. * The mode for the the updraft.
  73222. */
  73223. updraftMode: PhysicsUpdraftMode;
  73224. }
  73225. /**
  73226. * Options fot the vortex event
  73227. * @see https://doc.babylonjs.com/how_to/using_the_physics_engine#further-functionality-of-the-impostor-class
  73228. */
  73229. export class PhysicsVortexEventOptions {
  73230. /**
  73231. * The radius of the cylinder for the vortex
  73232. */
  73233. radius: number;
  73234. /**
  73235. * The strenth of the vortex.
  73236. */
  73237. strength: number;
  73238. /**
  73239. * The height of the cylinder for the vortex.
  73240. */
  73241. height: number;
  73242. /**
  73243. * At which distance, relative to the radius the centripetal forces should kick in? Range: 0-1
  73244. */
  73245. centripetalForceThreshold: number;
  73246. /**
  73247. * This multiplier determines with how much force the objects will be pushed sideways/around the vortex, when below the treshold.
  73248. */
  73249. centripetalForceMultiplier: number;
  73250. /**
  73251. * This multiplier determines with how much force the objects will be pushed sideways/around the vortex, when above the treshold.
  73252. */
  73253. centrifugalForceMultiplier: number;
  73254. /**
  73255. * This multiplier determines with how much force the objects will be pushed upwards, when in the vortex.
  73256. */
  73257. updraftForceMultiplier: number;
  73258. }
  73259. /**
  73260. * The strenght of the force in correspondence to the distance of the affected object
  73261. * @see https://doc.babylonjs.com/how_to/using_the_physics_engine#further-functionality-of-the-impostor-class
  73262. */
  73263. export enum PhysicsRadialImpulseFalloff {
  73264. /** Defines that impulse is constant in strength across it's whole radius */
  73265. Constant = 0,
  73266. /** Defines that impulse gets weaker if it's further from the origin */
  73267. Linear = 1
  73268. }
  73269. /**
  73270. * The strength of the force in correspondence to the distance of the affected object
  73271. * @see https://doc.babylonjs.com/how_to/using_the_physics_engine#further-functionality-of-the-impostor-class
  73272. */
  73273. export enum PhysicsUpdraftMode {
  73274. /** Defines that the upstream forces will pull towards the top center of the cylinder */
  73275. Center = 0,
  73276. /** Defines that once a impostor is inside the cylinder, it will shoot out perpendicular from the ground of the cylinder */
  73277. Perpendicular = 1
  73278. }
  73279. /**
  73280. * Interface for a physics hit data
  73281. * @see https://doc.babylonjs.com/how_to/using_the_physics_engine#further-functionality-of-the-impostor-class
  73282. */
  73283. export interface PhysicsHitData {
  73284. /**
  73285. * The force applied at the contact point
  73286. */
  73287. force: Vector3;
  73288. /**
  73289. * The contact point
  73290. */
  73291. contactPoint: Vector3;
  73292. /**
  73293. * The distance from the origin to the contact point
  73294. */
  73295. distanceFromOrigin: number;
  73296. }
  73297. /**
  73298. * Interface for radial explosion event data
  73299. * @see https://doc.babylonjs.com/how_to/using_the_physics_engine#further-functionality-of-the-impostor-class
  73300. */
  73301. export interface PhysicsRadialExplosionEventData {
  73302. /**
  73303. * A sphere used for the radial explosion event
  73304. */
  73305. sphere: Mesh;
  73306. }
  73307. /**
  73308. * Interface for gravitational field event data
  73309. * @see https://doc.babylonjs.com/how_to/using_the_physics_engine#further-functionality-of-the-impostor-class
  73310. */
  73311. export interface PhysicsGravitationalFieldEventData {
  73312. /**
  73313. * A sphere mesh used for the gravitational field event
  73314. */
  73315. sphere: Mesh;
  73316. }
  73317. /**
  73318. * Interface for updraft event data
  73319. * @see https://doc.babylonjs.com/how_to/using_the_physics_engine#further-functionality-of-the-impostor-class
  73320. */
  73321. export interface PhysicsUpdraftEventData {
  73322. /**
  73323. * A cylinder used for the updraft event
  73324. */
  73325. cylinder: Mesh;
  73326. }
  73327. /**
  73328. * Interface for vortex event data
  73329. * @see https://doc.babylonjs.com/how_to/using_the_physics_engine#further-functionality-of-the-impostor-class
  73330. */
  73331. export interface PhysicsVortexEventData {
  73332. /**
  73333. * A cylinder used for the vortex event
  73334. */
  73335. cylinder: Mesh;
  73336. }
  73337. /**
  73338. * Interface for an affected physics impostor
  73339. * @see https://doc.babylonjs.com/how_to/using_the_physics_engine#further-functionality-of-the-impostor-class
  73340. */
  73341. export interface PhysicsAffectedImpostorWithData {
  73342. /**
  73343. * The impostor affected by the effect
  73344. */
  73345. impostor: PhysicsImpostor;
  73346. /**
  73347. * The data about the hit/horce from the explosion
  73348. */
  73349. hitData: PhysicsHitData;
  73350. }
  73351. }
  73352. declare module "babylonjs/Physics/Plugins/index" {
  73353. export * from "babylonjs/Physics/Plugins/cannonJSPlugin";
  73354. export * from "babylonjs/Physics/Plugins/ammoJSPlugin";
  73355. export * from "babylonjs/Physics/Plugins/oimoJSPlugin";
  73356. }
  73357. declare module "babylonjs/Physics/index" {
  73358. export * from "babylonjs/Physics/IPhysicsEngine";
  73359. export * from "babylonjs/Physics/physicsEngine";
  73360. export * from "babylonjs/Physics/physicsEngineComponent";
  73361. export * from "babylonjs/Physics/physicsHelper";
  73362. export * from "babylonjs/Physics/physicsImpostor";
  73363. export * from "babylonjs/Physics/physicsJoint";
  73364. export * from "babylonjs/Physics/Plugins/index";
  73365. }
  73366. declare module "babylonjs/Shaders/blackAndWhite.fragment" {
  73367. /** @hidden */
  73368. export var blackAndWhitePixelShader: {
  73369. name: string;
  73370. shader: string;
  73371. };
  73372. }
  73373. declare module "babylonjs/PostProcesses/blackAndWhitePostProcess" {
  73374. import { PostProcess, PostProcessOptions } from "babylonjs/PostProcesses/postProcess";
  73375. import { Camera } from "babylonjs/Cameras/camera";
  73376. import { Engine } from "babylonjs/Engines/engine";
  73377. import "babylonjs/Shaders/blackAndWhite.fragment";
  73378. import { Nullable } from "babylonjs/types";
  73379. import { Scene } from "babylonjs/scene";
  73380. /**
  73381. * Post process used to render in black and white
  73382. */
  73383. export class BlackAndWhitePostProcess extends PostProcess {
  73384. /**
  73385. * Linear about to convert he result to black and white (default: 1)
  73386. */
  73387. degree: number;
  73388. /**
  73389. * Gets a string identifying the name of the class
  73390. * @returns "BlackAndWhitePostProcess" string
  73391. */
  73392. getClassName(): string;
  73393. /**
  73394. * Creates a black and white post process
  73395. * @see https://doc.babylonjs.com/how_to/how_to_use_postprocesses#black-and-white
  73396. * @param name The name of the effect.
  73397. * @param options The required width/height ratio to downsize to before computing the render pass.
  73398. * @param camera The camera to apply the render pass to.
  73399. * @param samplingMode The sampling mode to be used when computing the pass. (default: 0)
  73400. * @param engine The engine which the post process will be applied. (default: current engine)
  73401. * @param reusable If the post process can be reused on the same frame. (default: false)
  73402. */
  73403. constructor(name: string, options: number | PostProcessOptions, camera: Camera, samplingMode?: number, engine?: Engine, reusable?: boolean);
  73404. /** @hidden */
  73405. static _Parse(parsedPostProcess: any, targetCamera: Camera, scene: Scene, rootUrl: string): Nullable<BlackAndWhitePostProcess>;
  73406. }
  73407. }
  73408. declare module "babylonjs/PostProcesses/RenderPipeline/postProcessRenderEffect" {
  73409. import { Nullable } from "babylonjs/types";
  73410. import { Camera } from "babylonjs/Cameras/camera";
  73411. import { PostProcess } from "babylonjs/PostProcesses/postProcess";
  73412. import { Engine } from "babylonjs/Engines/engine";
  73413. /**
  73414. * This represents a set of one or more post processes in Babylon.
  73415. * A post process can be used to apply a shader to a texture after it is rendered.
  73416. * @example https://doc.babylonjs.com/how_to/how_to_use_postprocessrenderpipeline
  73417. */
  73418. export class PostProcessRenderEffect {
  73419. private _postProcesses;
  73420. private _getPostProcesses;
  73421. private _singleInstance;
  73422. private _cameras;
  73423. private _indicesForCamera;
  73424. /**
  73425. * Name of the effect
  73426. * @hidden
  73427. */
  73428. _name: string;
  73429. /**
  73430. * Instantiates a post process render effect.
  73431. * A post process can be used to apply a shader to a texture after it is rendered.
  73432. * @param engine The engine the effect is tied to
  73433. * @param name The name of the effect
  73434. * @param getPostProcesses A function that returns a set of post processes which the effect will run in order to be run.
  73435. * @param singleInstance False if this post process can be run on multiple cameras. (default: true)
  73436. */
  73437. constructor(engine: Engine, name: string, getPostProcesses: () => Nullable<PostProcess | Array<PostProcess>>, singleInstance?: boolean);
  73438. /**
  73439. * Checks if all the post processes in the effect are supported.
  73440. */
  73441. get isSupported(): boolean;
  73442. /**
  73443. * Updates the current state of the effect
  73444. * @hidden
  73445. */
  73446. _update(): void;
  73447. /**
  73448. * Attaches the effect on cameras
  73449. * @param cameras The camera to attach to.
  73450. * @hidden
  73451. */
  73452. _attachCameras(cameras: Camera): void;
  73453. /**
  73454. * Attaches the effect on cameras
  73455. * @param cameras The camera to attach to.
  73456. * @hidden
  73457. */
  73458. _attachCameras(cameras: Camera[]): void;
  73459. /**
  73460. * Detaches the effect on cameras
  73461. * @param cameras The camera to detatch from.
  73462. * @hidden
  73463. */
  73464. _detachCameras(cameras: Camera): void;
  73465. /**
  73466. * Detatches the effect on cameras
  73467. * @param cameras The camera to detatch from.
  73468. * @hidden
  73469. */
  73470. _detachCameras(cameras: Camera[]): void;
  73471. /**
  73472. * Enables the effect on given cameras
  73473. * @param cameras The camera to enable.
  73474. * @hidden
  73475. */
  73476. _enable(cameras: Camera): void;
  73477. /**
  73478. * Enables the effect on given cameras
  73479. * @param cameras The camera to enable.
  73480. * @hidden
  73481. */
  73482. _enable(cameras: Nullable<Camera[]>): void;
  73483. /**
  73484. * Disables the effect on the given cameras
  73485. * @param cameras The camera to disable.
  73486. * @hidden
  73487. */
  73488. _disable(cameras: Camera): void;
  73489. /**
  73490. * Disables the effect on the given cameras
  73491. * @param cameras The camera to disable.
  73492. * @hidden
  73493. */
  73494. _disable(cameras: Nullable<Camera[]>): void;
  73495. /**
  73496. * Gets a list of the post processes contained in the effect.
  73497. * @param camera The camera to get the post processes on.
  73498. * @returns The list of the post processes in the effect.
  73499. */
  73500. getPostProcesses(camera?: Camera): Nullable<Array<PostProcess>>;
  73501. }
  73502. }
  73503. declare module "babylonjs/Shaders/extractHighlights.fragment" {
  73504. import "babylonjs/Shaders/ShadersInclude/helperFunctions";
  73505. /** @hidden */
  73506. export var extractHighlightsPixelShader: {
  73507. name: string;
  73508. shader: string;
  73509. };
  73510. }
  73511. declare module "babylonjs/PostProcesses/extractHighlightsPostProcess" {
  73512. import { Nullable } from "babylonjs/types";
  73513. import { Camera } from "babylonjs/Cameras/camera";
  73514. import { PostProcess, PostProcessOptions } from "babylonjs/PostProcesses/postProcess";
  73515. import { Engine } from "babylonjs/Engines/engine";
  73516. import "babylonjs/Shaders/extractHighlights.fragment";
  73517. /**
  73518. * 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.
  73519. */
  73520. export class ExtractHighlightsPostProcess extends PostProcess {
  73521. /**
  73522. * The luminance threshold, pixels below this value will be set to black.
  73523. */
  73524. threshold: number;
  73525. /** @hidden */
  73526. _exposure: number;
  73527. /**
  73528. * Post process which has the input texture to be used when performing highlight extraction
  73529. * @hidden
  73530. */
  73531. _inputPostProcess: Nullable<PostProcess>;
  73532. /**
  73533. * Gets a string identifying the name of the class
  73534. * @returns "ExtractHighlightsPostProcess" string
  73535. */
  73536. getClassName(): string;
  73537. constructor(name: string, options: number | PostProcessOptions, camera: Nullable<Camera>, samplingMode?: number, engine?: Engine, reusable?: boolean, textureType?: number, blockCompilation?: boolean);
  73538. }
  73539. }
  73540. declare module "babylonjs/Shaders/bloomMerge.fragment" {
  73541. /** @hidden */
  73542. export var bloomMergePixelShader: {
  73543. name: string;
  73544. shader: string;
  73545. };
  73546. }
  73547. declare module "babylonjs/PostProcesses/bloomMergePostProcess" {
  73548. import { PostProcess, PostProcessOptions } from "babylonjs/PostProcesses/postProcess";
  73549. import { Nullable } from "babylonjs/types";
  73550. import { Engine } from "babylonjs/Engines/engine";
  73551. import { Camera } from "babylonjs/Cameras/camera";
  73552. import "babylonjs/Shaders/bloomMerge.fragment";
  73553. /**
  73554. * The BloomMergePostProcess merges blurred images with the original based on the values of the circle of confusion.
  73555. */
  73556. export class BloomMergePostProcess extends PostProcess {
  73557. /** Weight of the bloom to be added to the original input. */
  73558. weight: number;
  73559. /**
  73560. * Gets a string identifying the name of the class
  73561. * @returns "BloomMergePostProcess" string
  73562. */
  73563. getClassName(): string;
  73564. /**
  73565. * Creates a new instance of @see BloomMergePostProcess
  73566. * @param name The name of the effect.
  73567. * @param originalFromInput Post process which's input will be used for the merge.
  73568. * @param blurred Blurred highlights post process which's output will be used.
  73569. * @param weight Weight of the bloom to be added to the original input.
  73570. * @param options The required width/height ratio to downsize to before computing the render pass.
  73571. * @param camera The camera to apply the render pass to.
  73572. * @param samplingMode The sampling mode to be used when computing the pass. (default: 0)
  73573. * @param engine The engine which the post process will be applied. (default: current engine)
  73574. * @param reusable If the post process can be reused on the same frame. (default: false)
  73575. * @param textureType Type of textures used when performing the post process. (default: 0)
  73576. * @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)
  73577. */
  73578. constructor(name: string, originalFromInput: PostProcess, blurred: PostProcess,
  73579. /** Weight of the bloom to be added to the original input. */
  73580. weight: number, options: number | PostProcessOptions, camera: Nullable<Camera>, samplingMode?: number, engine?: Engine, reusable?: boolean, textureType?: number, blockCompilation?: boolean);
  73581. }
  73582. }
  73583. declare module "babylonjs/PostProcesses/bloomEffect" {
  73584. import { PostProcessRenderEffect } from "babylonjs/PostProcesses/RenderPipeline/postProcessRenderEffect";
  73585. import { PostProcess } from "babylonjs/PostProcesses/postProcess";
  73586. import { ExtractHighlightsPostProcess } from "babylonjs/PostProcesses/extractHighlightsPostProcess";
  73587. import { Camera } from "babylonjs/Cameras/camera";
  73588. import { Scene } from "babylonjs/scene";
  73589. /**
  73590. * The bloom effect spreads bright areas of an image to simulate artifacts seen in cameras
  73591. */
  73592. export class BloomEffect extends PostProcessRenderEffect {
  73593. private bloomScale;
  73594. /**
  73595. * @hidden Internal
  73596. */
  73597. _effects: Array<PostProcess>;
  73598. /**
  73599. * @hidden Internal
  73600. */
  73601. _downscale: ExtractHighlightsPostProcess;
  73602. private _blurX;
  73603. private _blurY;
  73604. private _merge;
  73605. /**
  73606. * The luminance threshold to find bright areas of the image to bloom.
  73607. */
  73608. get threshold(): number;
  73609. set threshold(value: number);
  73610. /**
  73611. * The strength of the bloom.
  73612. */
  73613. get weight(): number;
  73614. set weight(value: number);
  73615. /**
  73616. * Specifies the size of the bloom blur kernel, relative to the final output size
  73617. */
  73618. get kernel(): number;
  73619. set kernel(value: number);
  73620. /**
  73621. * Creates a new instance of @see BloomEffect
  73622. * @param scene The scene the effect belongs to.
  73623. * @param bloomScale The ratio of the blur texture to the input texture that should be used to compute the bloom.
  73624. * @param bloomKernel The size of the kernel to be used when applying the blur.
  73625. * @param bloomWeight The the strength of bloom.
  73626. * @param pipelineTextureType The type of texture to be used when performing the post processing.
  73627. * @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)
  73628. */
  73629. constructor(scene: Scene, bloomScale: number, bloomWeight: number, bloomKernel: number, pipelineTextureType?: number, blockCompilation?: boolean);
  73630. /**
  73631. * Disposes each of the internal effects for a given camera.
  73632. * @param camera The camera to dispose the effect on.
  73633. */
  73634. disposeEffects(camera: Camera): void;
  73635. /**
  73636. * @hidden Internal
  73637. */
  73638. _updateEffects(): void;
  73639. /**
  73640. * Internal
  73641. * @returns if all the contained post processes are ready.
  73642. * @hidden
  73643. */
  73644. _isReady(): boolean;
  73645. }
  73646. }
  73647. declare module "babylonjs/Shaders/chromaticAberration.fragment" {
  73648. /** @hidden */
  73649. export var chromaticAberrationPixelShader: {
  73650. name: string;
  73651. shader: string;
  73652. };
  73653. }
  73654. declare module "babylonjs/PostProcesses/chromaticAberrationPostProcess" {
  73655. import { Vector2 } from "babylonjs/Maths/math.vector";
  73656. import { Nullable } from "babylonjs/types";
  73657. import { PostProcess, PostProcessOptions } from "babylonjs/PostProcesses/postProcess";
  73658. import { Camera } from "babylonjs/Cameras/camera";
  73659. import { Engine } from "babylonjs/Engines/engine";
  73660. import "babylonjs/Shaders/chromaticAberration.fragment";
  73661. import { Scene } from "babylonjs/scene";
  73662. /**
  73663. * The ChromaticAberrationPostProcess separates the rgb channels in an image to produce chromatic distortion around the edges of the screen
  73664. */
  73665. export class ChromaticAberrationPostProcess extends PostProcess {
  73666. /**
  73667. * The amount of seperation of rgb channels (default: 30)
  73668. */
  73669. aberrationAmount: number;
  73670. /**
  73671. * The amount the effect will increase for pixels closer to the edge of the screen. (default: 0)
  73672. */
  73673. radialIntensity: number;
  73674. /**
  73675. * 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))
  73676. */
  73677. direction: Vector2;
  73678. /**
  73679. * 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))
  73680. */
  73681. centerPosition: Vector2;
  73682. /** The width of the screen to apply the effect on */
  73683. screenWidth: number;
  73684. /** The height of the screen to apply the effect on */
  73685. screenHeight: number;
  73686. /**
  73687. * Gets a string identifying the name of the class
  73688. * @returns "ChromaticAberrationPostProcess" string
  73689. */
  73690. getClassName(): string;
  73691. /**
  73692. * Creates a new instance ChromaticAberrationPostProcess
  73693. * @param name The name of the effect.
  73694. * @param screenWidth The width of the screen to apply the effect on.
  73695. * @param screenHeight The height of the screen to apply the effect on.
  73696. * @param options The required width/height ratio to downsize to before computing the render pass.
  73697. * @param camera The camera to apply the render pass to.
  73698. * @param samplingMode The sampling mode to be used when computing the pass. (default: 0)
  73699. * @param engine The engine which the post process will be applied. (default: current engine)
  73700. * @param reusable If the post process can be reused on the same frame. (default: false)
  73701. * @param textureType Type of textures used when performing the post process. (default: 0)
  73702. * @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)
  73703. */
  73704. constructor(name: string, screenWidth: number, screenHeight: number, options: number | PostProcessOptions, camera: Nullable<Camera>, samplingMode?: number, engine?: Engine, reusable?: boolean, textureType?: number, blockCompilation?: boolean);
  73705. /** @hidden */
  73706. static _Parse(parsedPostProcess: any, targetCamera: Camera, scene: Scene, rootUrl: string): Nullable<ChromaticAberrationPostProcess>;
  73707. }
  73708. }
  73709. declare module "babylonjs/Shaders/circleOfConfusion.fragment" {
  73710. /** @hidden */
  73711. export var circleOfConfusionPixelShader: {
  73712. name: string;
  73713. shader: string;
  73714. };
  73715. }
  73716. declare module "babylonjs/PostProcesses/circleOfConfusionPostProcess" {
  73717. import { Nullable } from "babylonjs/types";
  73718. import { Engine } from "babylonjs/Engines/engine";
  73719. import { PostProcess, PostProcessOptions } from "babylonjs/PostProcesses/postProcess";
  73720. import { RenderTargetTexture } from "babylonjs/Materials/Textures/renderTargetTexture";
  73721. import { Camera } from "babylonjs/Cameras/camera";
  73722. import "babylonjs/Shaders/circleOfConfusion.fragment";
  73723. /**
  73724. * The CircleOfConfusionPostProcess computes the circle of confusion value for each pixel given required lens parameters. See https://en.wikipedia.org/wiki/Circle_of_confusion
  73725. */
  73726. export class CircleOfConfusionPostProcess extends PostProcess {
  73727. /**
  73728. * 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.
  73729. */
  73730. lensSize: number;
  73731. /**
  73732. * F-Stop of the effect's camera. The diamater of the resulting aperture can be computed by lensSize/fStop. (default: 1.4)
  73733. */
  73734. fStop: number;
  73735. /**
  73736. * Distance away from the camera to focus on in scene units/1000 (eg. millimeter). (default: 2000)
  73737. */
  73738. focusDistance: number;
  73739. /**
  73740. * Focal length of the effect's camera in scene units/1000 (eg. millimeter). (default: 50)
  73741. */
  73742. focalLength: number;
  73743. /**
  73744. * Gets a string identifying the name of the class
  73745. * @returns "CircleOfConfusionPostProcess" string
  73746. */
  73747. getClassName(): string;
  73748. private _depthTexture;
  73749. /**
  73750. * Creates a new instance CircleOfConfusionPostProcess
  73751. * @param name The name of the effect.
  73752. * @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.
  73753. * @param options The required width/height ratio to downsize to before computing the render pass.
  73754. * @param camera The camera to apply the render pass to.
  73755. * @param samplingMode The sampling mode to be used when computing the pass. (default: 0)
  73756. * @param engine The engine which the post process will be applied. (default: current engine)
  73757. * @param reusable If the post process can be reused on the same frame. (default: false)
  73758. * @param textureType Type of textures used when performing the post process. (default: 0)
  73759. * @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)
  73760. */
  73761. constructor(name: string, depthTexture: Nullable<RenderTargetTexture>, options: number | PostProcessOptions, camera: Nullable<Camera>, samplingMode?: number, engine?: Engine, reusable?: boolean, textureType?: number, blockCompilation?: boolean);
  73762. /**
  73763. * 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.
  73764. */
  73765. set depthTexture(value: RenderTargetTexture);
  73766. }
  73767. }
  73768. declare module "babylonjs/Shaders/colorCorrection.fragment" {
  73769. /** @hidden */
  73770. export var colorCorrectionPixelShader: {
  73771. name: string;
  73772. shader: string;
  73773. };
  73774. }
  73775. declare module "babylonjs/PostProcesses/colorCorrectionPostProcess" {
  73776. import { PostProcess, PostProcessOptions } from "babylonjs/PostProcesses/postProcess";
  73777. import { Engine } from "babylonjs/Engines/engine";
  73778. import { Camera } from "babylonjs/Cameras/camera";
  73779. import "babylonjs/Shaders/colorCorrection.fragment";
  73780. import { Nullable } from "babylonjs/types";
  73781. import { Scene } from "babylonjs/scene";
  73782. /**
  73783. *
  73784. * This post-process allows the modification of rendered colors by using
  73785. * a 'look-up table' (LUT). This effect is also called Color Grading.
  73786. *
  73787. * The object needs to be provided an url to a texture containing the color
  73788. * look-up table: the texture must be 256 pixels wide and 16 pixels high.
  73789. * Use an image editing software to tweak the LUT to match your needs.
  73790. *
  73791. * For an example of a color LUT, see here:
  73792. * @see http://udn.epicgames.com/Three/rsrc/Three/ColorGrading/RGBTable16x1.png
  73793. * For explanations on color grading, see here:
  73794. * @see http://udn.epicgames.com/Three/ColorGrading.html
  73795. *
  73796. */
  73797. export class ColorCorrectionPostProcess extends PostProcess {
  73798. private _colorTableTexture;
  73799. /**
  73800. * Gets the color table url used to create the LUT texture
  73801. */
  73802. colorTableUrl: string;
  73803. /**
  73804. * Gets a string identifying the name of the class
  73805. * @returns "ColorCorrectionPostProcess" string
  73806. */
  73807. getClassName(): string;
  73808. constructor(name: string, colorTableUrl: string, options: number | PostProcessOptions, camera: Camera, samplingMode?: number, engine?: Engine, reusable?: boolean);
  73809. /** @hidden */
  73810. static _Parse(parsedPostProcess: any, targetCamera: Camera, scene: Scene, rootUrl: string): Nullable<ColorCorrectionPostProcess>;
  73811. }
  73812. }
  73813. declare module "babylonjs/Shaders/convolution.fragment" {
  73814. /** @hidden */
  73815. export var convolutionPixelShader: {
  73816. name: string;
  73817. shader: string;
  73818. };
  73819. }
  73820. declare module "babylonjs/PostProcesses/convolutionPostProcess" {
  73821. import { PostProcess, PostProcessOptions } from "babylonjs/PostProcesses/postProcess";
  73822. import { Nullable } from "babylonjs/types";
  73823. import { Camera } from "babylonjs/Cameras/camera";
  73824. import { Engine } from "babylonjs/Engines/engine";
  73825. import "babylonjs/Shaders/convolution.fragment";
  73826. import { Scene } from "babylonjs/scene";
  73827. /**
  73828. * The ConvolutionPostProcess applies a 3x3 kernel to every pixel of the
  73829. * input texture to perform effects such as edge detection or sharpening
  73830. * See http://en.wikipedia.org/wiki/Kernel_(image_processing)
  73831. */
  73832. export class ConvolutionPostProcess extends PostProcess {
  73833. /** Array of 9 values corresponding to the 3x3 kernel to be applied */
  73834. kernel: number[];
  73835. /**
  73836. * Gets a string identifying the name of the class
  73837. * @returns "ConvolutionPostProcess" string
  73838. */
  73839. getClassName(): string;
  73840. /**
  73841. * Creates a new instance ConvolutionPostProcess
  73842. * @param name The name of the effect.
  73843. * @param kernel Array of 9 values corresponding to the 3x3 kernel to be applied
  73844. * @param options The required width/height ratio to downsize to before computing the render pass.
  73845. * @param camera The camera to apply the render pass to.
  73846. * @param samplingMode The sampling mode to be used when computing the pass. (default: 0)
  73847. * @param engine The engine which the post process will be applied. (default: current engine)
  73848. * @param reusable If the post process can be reused on the same frame. (default: false)
  73849. * @param textureType Type of textures used when performing the post process. (default: 0)
  73850. */
  73851. constructor(name: string, kernel: number[], options: number | PostProcessOptions, camera: Nullable<Camera>, samplingMode?: number, engine?: Engine, reusable?: boolean, textureType?: number);
  73852. /** @hidden */
  73853. static _Parse(parsedPostProcess: any, targetCamera: Camera, scene: Scene, rootUrl: string): Nullable<ConvolutionPostProcess>;
  73854. /**
  73855. * Edge detection 0 see https://en.wikipedia.org/wiki/Kernel_(image_processing)
  73856. */
  73857. static EdgeDetect0Kernel: number[];
  73858. /**
  73859. * Edge detection 1 see https://en.wikipedia.org/wiki/Kernel_(image_processing)
  73860. */
  73861. static EdgeDetect1Kernel: number[];
  73862. /**
  73863. * Edge detection 2 see https://en.wikipedia.org/wiki/Kernel_(image_processing)
  73864. */
  73865. static EdgeDetect2Kernel: number[];
  73866. /**
  73867. * Kernel to sharpen an image see https://en.wikipedia.org/wiki/Kernel_(image_processing)
  73868. */
  73869. static SharpenKernel: number[];
  73870. /**
  73871. * Kernel to emboss an image see https://en.wikipedia.org/wiki/Kernel_(image_processing)
  73872. */
  73873. static EmbossKernel: number[];
  73874. /**
  73875. * Kernel to blur an image see https://en.wikipedia.org/wiki/Kernel_(image_processing)
  73876. */
  73877. static GaussianKernel: number[];
  73878. }
  73879. }
  73880. declare module "babylonjs/PostProcesses/depthOfFieldBlurPostProcess" {
  73881. import { Nullable } from "babylonjs/types";
  73882. import { Vector2 } from "babylonjs/Maths/math.vector";
  73883. import { Camera } from "babylonjs/Cameras/camera";
  73884. import { PostProcess, PostProcessOptions } from "babylonjs/PostProcesses/postProcess";
  73885. import { BlurPostProcess } from "babylonjs/PostProcesses/blurPostProcess";
  73886. import { Engine } from "babylonjs/Engines/engine";
  73887. import { Scene } from "babylonjs/scene";
  73888. /**
  73889. * The DepthOfFieldBlurPostProcess applied a blur in a give direction.
  73890. * This blur differs from the standard BlurPostProcess as it attempts to avoid blurring pixels
  73891. * based on samples that have a large difference in distance than the center pixel.
  73892. * See section 2.6.2 http://fileadmin.cs.lth.se/cs/education/edan35/lectures/12dof.pdf
  73893. */
  73894. export class DepthOfFieldBlurPostProcess extends BlurPostProcess {
  73895. /**
  73896. * The direction the blur should be applied
  73897. */
  73898. direction: Vector2;
  73899. /**
  73900. * Gets a string identifying the name of the class
  73901. * @returns "DepthOfFieldBlurPostProcess" string
  73902. */
  73903. getClassName(): string;
  73904. /**
  73905. * Creates a new instance CircleOfConfusionPostProcess
  73906. * @param name The name of the effect.
  73907. * @param scene The scene the effect belongs to.
  73908. * @param direction The direction the blur should be applied.
  73909. * @param kernel The size of the kernel used to blur.
  73910. * @param options The required width/height ratio to downsize to before computing the render pass.
  73911. * @param camera The camera to apply the render pass to.
  73912. * @param circleOfConfusion The circle of confusion + depth map to be used to avoid blurring accross edges
  73913. * @param imageToBlur The image to apply the blur to (default: Current rendered frame)
  73914. * @param samplingMode The sampling mode to be used when computing the pass. (default: 0)
  73915. * @param engine The engine which the post process will be applied. (default: current engine)
  73916. * @param reusable If the post process can be reused on the same frame. (default: false)
  73917. * @param textureType Type of textures used when performing the post process. (default: 0)
  73918. * @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)
  73919. */
  73920. 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);
  73921. }
  73922. }
  73923. declare module "babylonjs/Shaders/depthOfFieldMerge.fragment" {
  73924. /** @hidden */
  73925. export var depthOfFieldMergePixelShader: {
  73926. name: string;
  73927. shader: string;
  73928. };
  73929. }
  73930. declare module "babylonjs/PostProcesses/depthOfFieldMergePostProcess" {
  73931. import { Nullable } from "babylonjs/types";
  73932. import { Camera } from "babylonjs/Cameras/camera";
  73933. import { Effect } from "babylonjs/Materials/effect";
  73934. import { PostProcess, PostProcessOptions } from "babylonjs/PostProcesses/postProcess";
  73935. import { Engine } from "babylonjs/Engines/engine";
  73936. import "babylonjs/Shaders/depthOfFieldMerge.fragment";
  73937. /**
  73938. * Options to be set when merging outputs from the default pipeline.
  73939. */
  73940. export class DepthOfFieldMergePostProcessOptions {
  73941. /**
  73942. * The original image to merge on top of
  73943. */
  73944. originalFromInput: PostProcess;
  73945. /**
  73946. * Parameters to perform the merge of the depth of field effect
  73947. */
  73948. depthOfField?: {
  73949. circleOfConfusion: PostProcess;
  73950. blurSteps: Array<PostProcess>;
  73951. };
  73952. /**
  73953. * Parameters to perform the merge of bloom effect
  73954. */
  73955. bloom?: {
  73956. blurred: PostProcess;
  73957. weight: number;
  73958. };
  73959. }
  73960. /**
  73961. * The DepthOfFieldMergePostProcess merges blurred images with the original based on the values of the circle of confusion.
  73962. */
  73963. export class DepthOfFieldMergePostProcess extends PostProcess {
  73964. private blurSteps;
  73965. /**
  73966. * Gets a string identifying the name of the class
  73967. * @returns "DepthOfFieldMergePostProcess" string
  73968. */
  73969. getClassName(): string;
  73970. /**
  73971. * Creates a new instance of DepthOfFieldMergePostProcess
  73972. * @param name The name of the effect.
  73973. * @param originalFromInput Post process which's input will be used for the merge.
  73974. * @param circleOfConfusion Circle of confusion post process which's output will be used to blur each pixel.
  73975. * @param blurSteps Blur post processes from low to high which will be mixed with the original image.
  73976. * @param options The required width/height ratio to downsize to before computing the render pass.
  73977. * @param camera The camera to apply the render pass to.
  73978. * @param samplingMode The sampling mode to be used when computing the pass. (default: 0)
  73979. * @param engine The engine which the post process will be applied. (default: current engine)
  73980. * @param reusable If the post process can be reused on the same frame. (default: false)
  73981. * @param textureType Type of textures used when performing the post process. (default: 0)
  73982. * @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)
  73983. */
  73984. 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);
  73985. /**
  73986. * Updates the effect with the current post process compile time values and recompiles the shader.
  73987. * @param defines Define statements that should be added at the beginning of the shader. (default: null)
  73988. * @param uniforms Set of uniform variables that will be passed to the shader. (default: null)
  73989. * @param samplers Set of Texture2D variables that will be passed to the shader. (default: null)
  73990. * @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
  73991. * @param onCompiled Called when the shader has been compiled.
  73992. * @param onError Called if there is an error when compiling a shader.
  73993. */
  73994. updateEffect(defines?: Nullable<string>, uniforms?: Nullable<string[]>, samplers?: Nullable<string[]>, indexParameters?: any, onCompiled?: (effect: Effect) => void, onError?: (effect: Effect, errors: string) => void): void;
  73995. }
  73996. }
  73997. declare module "babylonjs/PostProcesses/depthOfFieldEffect" {
  73998. import { Nullable } from "babylonjs/types";
  73999. import { Camera } from "babylonjs/Cameras/camera";
  74000. import { RenderTargetTexture } from "babylonjs/Materials/Textures/renderTargetTexture";
  74001. import { PostProcess } from "babylonjs/PostProcesses/postProcess";
  74002. import { PostProcessRenderEffect } from "babylonjs/PostProcesses/RenderPipeline/postProcessRenderEffect";
  74003. import { DepthOfFieldBlurPostProcess } from "babylonjs/PostProcesses/depthOfFieldBlurPostProcess";
  74004. import { Scene } from "babylonjs/scene";
  74005. /**
  74006. * Specifies the level of max blur that should be applied when using the depth of field effect
  74007. */
  74008. export enum DepthOfFieldEffectBlurLevel {
  74009. /**
  74010. * Subtle blur
  74011. */
  74012. Low = 0,
  74013. /**
  74014. * Medium blur
  74015. */
  74016. Medium = 1,
  74017. /**
  74018. * Large blur
  74019. */
  74020. High = 2
  74021. }
  74022. /**
  74023. * The depth of field effect applies a blur to objects that are closer or further from where the camera is focusing.
  74024. */
  74025. export class DepthOfFieldEffect extends PostProcessRenderEffect {
  74026. private _circleOfConfusion;
  74027. /**
  74028. * @hidden Internal, blurs from high to low
  74029. */
  74030. _depthOfFieldBlurX: Array<DepthOfFieldBlurPostProcess>;
  74031. private _depthOfFieldBlurY;
  74032. private _dofMerge;
  74033. /**
  74034. * @hidden Internal post processes in depth of field effect
  74035. */
  74036. _effects: Array<PostProcess>;
  74037. /**
  74038. * The focal the length of the camera used in the effect in scene units/1000 (eg. millimeter)
  74039. */
  74040. set focalLength(value: number);
  74041. get focalLength(): number;
  74042. /**
  74043. * F-Stop of the effect's camera. The diameter of the resulting aperture can be computed by lensSize/fStop. (default: 1.4)
  74044. */
  74045. set fStop(value: number);
  74046. get fStop(): number;
  74047. /**
  74048. * Distance away from the camera to focus on in scene units/1000 (eg. millimeter). (default: 2000)
  74049. */
  74050. set focusDistance(value: number);
  74051. get focusDistance(): number;
  74052. /**
  74053. * 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.
  74054. */
  74055. set lensSize(value: number);
  74056. get lensSize(): number;
  74057. /**
  74058. * Creates a new instance DepthOfFieldEffect
  74059. * @param scene The scene the effect belongs to.
  74060. * @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.
  74061. * @param pipelineTextureType The type of texture to be used when performing the post processing.
  74062. * @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)
  74063. */
  74064. constructor(scene: Scene, depthTexture: Nullable<RenderTargetTexture>, blurLevel?: DepthOfFieldEffectBlurLevel, pipelineTextureType?: number, blockCompilation?: boolean);
  74065. /**
  74066. * Get the current class name of the current effet
  74067. * @returns "DepthOfFieldEffect"
  74068. */
  74069. getClassName(): string;
  74070. /**
  74071. * 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.
  74072. */
  74073. set depthTexture(value: RenderTargetTexture);
  74074. /**
  74075. * Disposes each of the internal effects for a given camera.
  74076. * @param camera The camera to dispose the effect on.
  74077. */
  74078. disposeEffects(camera: Camera): void;
  74079. /**
  74080. * @hidden Internal
  74081. */
  74082. _updateEffects(): void;
  74083. /**
  74084. * Internal
  74085. * @returns if all the contained post processes are ready.
  74086. * @hidden
  74087. */
  74088. _isReady(): boolean;
  74089. }
  74090. }
  74091. declare module "babylonjs/Shaders/displayPass.fragment" {
  74092. /** @hidden */
  74093. export var displayPassPixelShader: {
  74094. name: string;
  74095. shader: string;
  74096. };
  74097. }
  74098. declare module "babylonjs/PostProcesses/displayPassPostProcess" {
  74099. import { Nullable } from "babylonjs/types";
  74100. import { Camera } from "babylonjs/Cameras/camera";
  74101. import { PostProcess, PostProcessOptions } from "babylonjs/PostProcesses/postProcess";
  74102. import { Engine } from "babylonjs/Engines/engine";
  74103. import "babylonjs/Shaders/displayPass.fragment";
  74104. import { Scene } from "babylonjs/scene";
  74105. /**
  74106. * DisplayPassPostProcess which produces an output the same as it's input
  74107. */
  74108. export class DisplayPassPostProcess extends PostProcess {
  74109. /**
  74110. * Gets a string identifying the name of the class
  74111. * @returns "DisplayPassPostProcess" string
  74112. */
  74113. getClassName(): string;
  74114. /**
  74115. * Creates the DisplayPassPostProcess
  74116. * @param name The name of the effect.
  74117. * @param options The required width/height ratio to downsize to before computing the render pass.
  74118. * @param camera The camera to apply the render pass to.
  74119. * @param samplingMode The sampling mode to be used when computing the pass. (default: 0)
  74120. * @param engine The engine which the post process will be applied. (default: current engine)
  74121. * @param reusable If the post process can be reused on the same frame. (default: false)
  74122. */
  74123. constructor(name: string, options: number | PostProcessOptions, camera: Nullable<Camera>, samplingMode?: number, engine?: Engine, reusable?: boolean);
  74124. /** @hidden */
  74125. static _Parse(parsedPostProcess: any, targetCamera: Camera, scene: Scene, rootUrl: string): Nullable<DisplayPassPostProcess>;
  74126. }
  74127. }
  74128. declare module "babylonjs/Shaders/filter.fragment" {
  74129. /** @hidden */
  74130. export var filterPixelShader: {
  74131. name: string;
  74132. shader: string;
  74133. };
  74134. }
  74135. declare module "babylonjs/PostProcesses/filterPostProcess" {
  74136. import { Nullable } from "babylonjs/types";
  74137. import { Matrix } from "babylonjs/Maths/math.vector";
  74138. import { Camera } from "babylonjs/Cameras/camera";
  74139. import { PostProcess, PostProcessOptions } from "babylonjs/PostProcesses/postProcess";
  74140. import { Engine } from "babylonjs/Engines/engine";
  74141. import "babylonjs/Shaders/filter.fragment";
  74142. import { Scene } from "babylonjs/scene";
  74143. /**
  74144. * Applies a kernel filter to the image
  74145. */
  74146. export class FilterPostProcess extends PostProcess {
  74147. /** The matrix to be applied to the image */
  74148. kernelMatrix: Matrix;
  74149. /**
  74150. * Gets a string identifying the name of the class
  74151. * @returns "FilterPostProcess" string
  74152. */
  74153. getClassName(): string;
  74154. /**
  74155. *
  74156. * @param name The name of the effect.
  74157. * @param kernelMatrix The matrix to be applied to the image
  74158. * @param options The required width/height ratio to downsize to before computing the render pass.
  74159. * @param camera The camera to apply the render pass to.
  74160. * @param samplingMode The sampling mode to be used when computing the pass. (default: 0)
  74161. * @param engine The engine which the post process will be applied. (default: current engine)
  74162. * @param reusable If the post process can be reused on the same frame. (default: false)
  74163. */
  74164. constructor(name: string, kernelMatrix: Matrix, options: number | PostProcessOptions, camera: Nullable<Camera>, samplingMode?: number, engine?: Engine, reusable?: boolean);
  74165. /** @hidden */
  74166. static _Parse(parsedPostProcess: any, targetCamera: Camera, scene: Scene, rootUrl: string): Nullable<FilterPostProcess>;
  74167. }
  74168. }
  74169. declare module "babylonjs/Shaders/fxaa.fragment" {
  74170. /** @hidden */
  74171. export var fxaaPixelShader: {
  74172. name: string;
  74173. shader: string;
  74174. };
  74175. }
  74176. declare module "babylonjs/Shaders/fxaa.vertex" {
  74177. /** @hidden */
  74178. export var fxaaVertexShader: {
  74179. name: string;
  74180. shader: string;
  74181. };
  74182. }
  74183. declare module "babylonjs/PostProcesses/fxaaPostProcess" {
  74184. import { Nullable } from "babylonjs/types";
  74185. import { Camera } from "babylonjs/Cameras/camera";
  74186. import { PostProcess, PostProcessOptions } from "babylonjs/PostProcesses/postProcess";
  74187. import { Engine } from "babylonjs/Engines/engine";
  74188. import "babylonjs/Shaders/fxaa.fragment";
  74189. import "babylonjs/Shaders/fxaa.vertex";
  74190. import { Scene } from "babylonjs/scene";
  74191. /**
  74192. * Fxaa post process
  74193. * @see https://doc.babylonjs.com/how_to/how_to_use_postprocesses#fxaa
  74194. */
  74195. export class FxaaPostProcess extends PostProcess {
  74196. /**
  74197. * Gets a string identifying the name of the class
  74198. * @returns "FxaaPostProcess" string
  74199. */
  74200. getClassName(): string;
  74201. constructor(name: string, options: number | PostProcessOptions, camera?: Nullable<Camera>, samplingMode?: number, engine?: Engine, reusable?: boolean, textureType?: number);
  74202. private _getDefines;
  74203. /** @hidden */
  74204. static _Parse(parsedPostProcess: any, targetCamera: Camera, scene: Scene, rootUrl: string): FxaaPostProcess;
  74205. }
  74206. }
  74207. declare module "babylonjs/Shaders/grain.fragment" {
  74208. import "babylonjs/Shaders/ShadersInclude/helperFunctions";
  74209. /** @hidden */
  74210. export var grainPixelShader: {
  74211. name: string;
  74212. shader: string;
  74213. };
  74214. }
  74215. declare module "babylonjs/PostProcesses/grainPostProcess" {
  74216. import { Nullable } from "babylonjs/types";
  74217. import { Camera } from "babylonjs/Cameras/camera";
  74218. import { PostProcess, PostProcessOptions } from "babylonjs/PostProcesses/postProcess";
  74219. import { Engine } from "babylonjs/Engines/engine";
  74220. import "babylonjs/Shaders/grain.fragment";
  74221. import { Scene } from "babylonjs/scene";
  74222. /**
  74223. * The GrainPostProcess adds noise to the image at mid luminance levels
  74224. */
  74225. export class GrainPostProcess extends PostProcess {
  74226. /**
  74227. * The intensity of the grain added (default: 30)
  74228. */
  74229. intensity: number;
  74230. /**
  74231. * If the grain should be randomized on every frame
  74232. */
  74233. animated: boolean;
  74234. /**
  74235. * Gets a string identifying the name of the class
  74236. * @returns "GrainPostProcess" string
  74237. */
  74238. getClassName(): string;
  74239. /**
  74240. * Creates a new instance of @see GrainPostProcess
  74241. * @param name The name of the effect.
  74242. * @param options The required width/height ratio to downsize to before computing the render pass.
  74243. * @param camera The camera to apply the render pass to.
  74244. * @param samplingMode The sampling mode to be used when computing the pass. (default: 0)
  74245. * @param engine The engine which the post process will be applied. (default: current engine)
  74246. * @param reusable If the post process can be reused on the same frame. (default: false)
  74247. * @param textureType Type of textures used when performing the post process. (default: 0)
  74248. * @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)
  74249. */
  74250. constructor(name: string, options: number | PostProcessOptions, camera: Nullable<Camera>, samplingMode?: number, engine?: Engine, reusable?: boolean, textureType?: number, blockCompilation?: boolean);
  74251. /** @hidden */
  74252. static _Parse(parsedPostProcess: any, targetCamera: Camera, scene: Scene, rootUrl: string): GrainPostProcess;
  74253. }
  74254. }
  74255. declare module "babylonjs/Shaders/highlights.fragment" {
  74256. /** @hidden */
  74257. export var highlightsPixelShader: {
  74258. name: string;
  74259. shader: string;
  74260. };
  74261. }
  74262. declare module "babylonjs/PostProcesses/highlightsPostProcess" {
  74263. import { Nullable } from "babylonjs/types";
  74264. import { Camera } from "babylonjs/Cameras/camera";
  74265. import { PostProcess, PostProcessOptions } from "babylonjs/PostProcesses/postProcess";
  74266. import { Engine } from "babylonjs/Engines/engine";
  74267. import "babylonjs/Shaders/highlights.fragment";
  74268. /**
  74269. * Extracts highlights from the image
  74270. * @see https://doc.babylonjs.com/how_to/how_to_use_postprocesses
  74271. */
  74272. export class HighlightsPostProcess extends PostProcess {
  74273. /**
  74274. * Gets a string identifying the name of the class
  74275. * @returns "HighlightsPostProcess" string
  74276. */
  74277. getClassName(): string;
  74278. /**
  74279. * Extracts highlights from the image
  74280. * @see https://doc.babylonjs.com/how_to/how_to_use_postprocesses
  74281. * @param name The name of the effect.
  74282. * @param options The required width/height ratio to downsize to before computing the render pass.
  74283. * @param camera The camera to apply the render pass to.
  74284. * @param samplingMode The sampling mode to be used when computing the pass. (default: 0)
  74285. * @param engine The engine which the post process will be applied. (default: current engine)
  74286. * @param reusable If the post process can be reused on the same frame. (default: false)
  74287. * @param textureType Type of texture for the post process (default: Engine.TEXTURETYPE_UNSIGNED_INT)
  74288. */
  74289. constructor(name: string, options: number | PostProcessOptions, camera: Nullable<Camera>, samplingMode?: number, engine?: Engine, reusable?: boolean, textureType?: number);
  74290. }
  74291. }
  74292. declare module "babylonjs/Rendering/motionBlurConfiguration" {
  74293. import { PrePassEffectConfiguration } from "babylonjs/Rendering/prePassEffectConfiguration";
  74294. /**
  74295. * Contains all parameters needed for the prepass to perform
  74296. * motion blur
  74297. */
  74298. export class MotionBlurConfiguration implements PrePassEffectConfiguration {
  74299. /**
  74300. * Is motion blur enabled
  74301. */
  74302. enabled: boolean;
  74303. /**
  74304. * Name of the configuration
  74305. */
  74306. name: string;
  74307. /**
  74308. * Textures that should be present in the MRT for this effect to work
  74309. */
  74310. readonly texturesRequired: number[];
  74311. }
  74312. }
  74313. declare module "babylonjs/Rendering/geometryBufferRendererSceneComponent" {
  74314. import { Nullable } from "babylonjs/types";
  74315. import { Scene } from "babylonjs/scene";
  74316. import { ISceneComponent } from "babylonjs/sceneComponent";
  74317. import { GeometryBufferRenderer } from "babylonjs/Rendering/geometryBufferRenderer";
  74318. module "babylonjs/scene" {
  74319. interface Scene {
  74320. /** @hidden (Backing field) */
  74321. _geometryBufferRenderer: Nullable<GeometryBufferRenderer>;
  74322. /**
  74323. * Gets or Sets the current geometry buffer associated to the scene.
  74324. */
  74325. geometryBufferRenderer: Nullable<GeometryBufferRenderer>;
  74326. /**
  74327. * Enables a GeometryBufferRender and associates it with the scene
  74328. * @param ratio defines the scaling ratio to apply to the renderer (1 by default which means same resolution)
  74329. * @returns the GeometryBufferRenderer
  74330. */
  74331. enableGeometryBufferRenderer(ratio?: number): Nullable<GeometryBufferRenderer>;
  74332. /**
  74333. * Disables the GeometryBufferRender associated with the scene
  74334. */
  74335. disableGeometryBufferRenderer(): void;
  74336. }
  74337. }
  74338. /**
  74339. * Defines the Geometry Buffer scene component responsible to manage a G-Buffer useful
  74340. * in several rendering techniques.
  74341. */
  74342. export class GeometryBufferRendererSceneComponent implements ISceneComponent {
  74343. /**
  74344. * The component name helpful to identify the component in the list of scene components.
  74345. */
  74346. readonly name: string;
  74347. /**
  74348. * The scene the component belongs to.
  74349. */
  74350. scene: Scene;
  74351. /**
  74352. * Creates a new instance of the component for the given scene
  74353. * @param scene Defines the scene to register the component in
  74354. */
  74355. constructor(scene: Scene);
  74356. /**
  74357. * Registers the component in a given scene
  74358. */
  74359. register(): void;
  74360. /**
  74361. * Rebuilds the elements related to this component in case of
  74362. * context lost for instance.
  74363. */
  74364. rebuild(): void;
  74365. /**
  74366. * Disposes the component and the associated ressources
  74367. */
  74368. dispose(): void;
  74369. private _gatherRenderTargets;
  74370. }
  74371. }
  74372. declare module "babylonjs/Shaders/motionBlur.fragment" {
  74373. /** @hidden */
  74374. export var motionBlurPixelShader: {
  74375. name: string;
  74376. shader: string;
  74377. };
  74378. }
  74379. declare module "babylonjs/PostProcesses/motionBlurPostProcess" {
  74380. import { Nullable } from "babylonjs/types";
  74381. import { Camera } from "babylonjs/Cameras/camera";
  74382. import { PostProcess, PostProcessOptions } from "babylonjs/PostProcesses/postProcess";
  74383. import { AbstractMesh } from "babylonjs/Meshes/abstractMesh";
  74384. import "babylonjs/Animations/animatable";
  74385. import "babylonjs/Rendering/geometryBufferRendererSceneComponent";
  74386. import "babylonjs/Shaders/motionBlur.fragment";
  74387. import { Engine } from "babylonjs/Engines/engine";
  74388. import { Scene } from "babylonjs/scene";
  74389. /**
  74390. * The Motion Blur Post Process which blurs an image based on the objects velocity in scene.
  74391. * Velocity can be affected by each object's rotation, position and scale depending on the transformation speed.
  74392. * As an example, all you have to do is to create the post-process:
  74393. * var mb = new BABYLON.MotionBlurPostProcess(
  74394. * 'mb', // The name of the effect.
  74395. * scene, // The scene containing the objects to blur according to their velocity.
  74396. * 1.0, // The required width/height ratio to downsize to before computing the render pass.
  74397. * camera // The camera to apply the render pass to.
  74398. * );
  74399. * Then, all objects moving, rotating and/or scaling will be blurred depending on the transformation speed.
  74400. */
  74401. export class MotionBlurPostProcess extends PostProcess {
  74402. /**
  74403. * Defines how much the image is blurred by the movement. Default value is equal to 1
  74404. */
  74405. motionStrength: number;
  74406. /**
  74407. * Gets the number of iterations are used for motion blur quality. Default value is equal to 32
  74408. */
  74409. get motionBlurSamples(): number;
  74410. /**
  74411. * Sets the number of iterations to be used for motion blur quality
  74412. */
  74413. set motionBlurSamples(samples: number);
  74414. private _motionBlurSamples;
  74415. private _forceGeometryBuffer;
  74416. private _geometryBufferRenderer;
  74417. private _prePassRenderer;
  74418. /**
  74419. * Gets a string identifying the name of the class
  74420. * @returns "MotionBlurPostProcess" string
  74421. */
  74422. getClassName(): string;
  74423. /**
  74424. * Creates a new instance MotionBlurPostProcess
  74425. * @param name The name of the effect.
  74426. * @param scene The scene containing the objects to blur according to their velocity.
  74427. * @param options The required width/height ratio to downsize to before computing the render pass.
  74428. * @param camera The camera to apply the render pass to.
  74429. * @param samplingMode The sampling mode to be used when computing the pass. (default: 0)
  74430. * @param engine The engine which the post process will be applied. (default: current engine)
  74431. * @param reusable If the post process can be reused on the same frame. (default: false)
  74432. * @param textureType Type of textures used when performing the post process. (default: 0)
  74433. * @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)
  74434. * @param forceGeometryBuffer If this post process should use geometry buffer instead of prepass (default: false)
  74435. */
  74436. constructor(name: string, scene: Scene, options: number | PostProcessOptions, camera: Nullable<Camera>, samplingMode?: number, engine?: Engine, reusable?: boolean, textureType?: number, blockCompilation?: boolean, forceGeometryBuffer?: boolean);
  74437. /**
  74438. * Excludes the given skinned mesh from computing bones velocities.
  74439. * 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.
  74440. * @param skinnedMesh The mesh containing the skeleton to ignore when computing the velocity map.
  74441. */
  74442. excludeSkinnedMesh(skinnedMesh: AbstractMesh): void;
  74443. /**
  74444. * Removes the given skinned mesh from the excluded meshes to integrate bones velocities while rendering the velocity map.
  74445. * @param skinnedMesh The mesh containing the skeleton that has been ignored previously.
  74446. * @see excludeSkinnedMesh to exclude a skinned mesh from bones velocity computation.
  74447. */
  74448. removeExcludedSkinnedMesh(skinnedMesh: AbstractMesh): void;
  74449. /**
  74450. * Disposes the post process.
  74451. * @param camera The camera to dispose the post process on.
  74452. */
  74453. dispose(camera?: Camera): void;
  74454. /** @hidden */
  74455. static _Parse(parsedPostProcess: any, targetCamera: Camera, scene: Scene, rootUrl: string): Nullable<MotionBlurPostProcess>;
  74456. }
  74457. }
  74458. declare module "babylonjs/Shaders/refraction.fragment" {
  74459. /** @hidden */
  74460. export var refractionPixelShader: {
  74461. name: string;
  74462. shader: string;
  74463. };
  74464. }
  74465. declare module "babylonjs/PostProcesses/refractionPostProcess" {
  74466. import { Color3 } from "babylonjs/Maths/math.color";
  74467. import { Camera } from "babylonjs/Cameras/camera";
  74468. import { Texture } from "babylonjs/Materials/Textures/texture";
  74469. import { PostProcess, PostProcessOptions } from "babylonjs/PostProcesses/postProcess";
  74470. import { Engine } from "babylonjs/Engines/engine";
  74471. import "babylonjs/Shaders/refraction.fragment";
  74472. import { Scene } from "babylonjs/scene";
  74473. /**
  74474. * Post process which applies a refractin texture
  74475. * @see https://doc.babylonjs.com/how_to/how_to_use_postprocesses#refraction
  74476. */
  74477. export class RefractionPostProcess extends PostProcess {
  74478. private _refTexture;
  74479. private _ownRefractionTexture;
  74480. /** the base color of the refraction (used to taint the rendering) */
  74481. color: Color3;
  74482. /** simulated refraction depth */
  74483. depth: number;
  74484. /** the coefficient of the base color (0 to remove base color tainting) */
  74485. colorLevel: number;
  74486. /** Gets the url used to load the refraction texture */
  74487. refractionTextureUrl: string;
  74488. /**
  74489. * Gets or sets the refraction texture
  74490. * Please note that you are responsible for disposing the texture if you set it manually
  74491. */
  74492. get refractionTexture(): Texture;
  74493. set refractionTexture(value: Texture);
  74494. /**
  74495. * Gets a string identifying the name of the class
  74496. * @returns "RefractionPostProcess" string
  74497. */
  74498. getClassName(): string;
  74499. /**
  74500. * Initializes the RefractionPostProcess
  74501. * @see https://doc.babylonjs.com/how_to/how_to_use_postprocesses#refraction
  74502. * @param name The name of the effect.
  74503. * @param refractionTextureUrl Url of the refraction texture to use
  74504. * @param color the base color of the refraction (used to taint the rendering)
  74505. * @param depth simulated refraction depth
  74506. * @param colorLevel the coefficient of the base color (0 to remove base color tainting)
  74507. * @param camera The camera to apply the render pass to.
  74508. * @param options The required width/height ratio to downsize to before computing the render pass.
  74509. * @param samplingMode The sampling mode to be used when computing the pass. (default: 0)
  74510. * @param engine The engine which the post process will be applied. (default: current engine)
  74511. * @param reusable If the post process can be reused on the same frame. (default: false)
  74512. */
  74513. constructor(name: string, refractionTextureUrl: string, color: Color3, depth: number, colorLevel: number, options: number | PostProcessOptions, camera: Camera, samplingMode?: number, engine?: Engine, reusable?: boolean);
  74514. /**
  74515. * Disposes of the post process
  74516. * @param camera Camera to dispose post process on
  74517. */
  74518. dispose(camera: Camera): void;
  74519. /** @hidden */
  74520. static _Parse(parsedPostProcess: any, targetCamera: Camera, scene: Scene, rootUrl: string): RefractionPostProcess;
  74521. }
  74522. }
  74523. declare module "babylonjs/Shaders/sharpen.fragment" {
  74524. /** @hidden */
  74525. export var sharpenPixelShader: {
  74526. name: string;
  74527. shader: string;
  74528. };
  74529. }
  74530. declare module "babylonjs/PostProcesses/sharpenPostProcess" {
  74531. import { Nullable } from "babylonjs/types";
  74532. import { Camera } from "babylonjs/Cameras/camera";
  74533. import { PostProcess, PostProcessOptions } from "babylonjs/PostProcesses/postProcess";
  74534. import "babylonjs/Shaders/sharpen.fragment";
  74535. import { Engine } from "babylonjs/Engines/engine";
  74536. import { Scene } from "babylonjs/scene";
  74537. /**
  74538. * The SharpenPostProcess applies a sharpen kernel to every pixel
  74539. * See http://en.wikipedia.org/wiki/Kernel_(image_processing)
  74540. */
  74541. export class SharpenPostProcess extends PostProcess {
  74542. /**
  74543. * How much of the original color should be applied. Setting this to 0 will display edge detection. (default: 1)
  74544. */
  74545. colorAmount: number;
  74546. /**
  74547. * How much sharpness should be applied (default: 0.3)
  74548. */
  74549. edgeAmount: number;
  74550. /**
  74551. * Gets a string identifying the name of the class
  74552. * @returns "SharpenPostProcess" string
  74553. */
  74554. getClassName(): string;
  74555. /**
  74556. * Creates a new instance ConvolutionPostProcess
  74557. * @param name The name of the effect.
  74558. * @param options The required width/height ratio to downsize to before computing the render pass.
  74559. * @param camera The camera to apply the render pass to.
  74560. * @param samplingMode The sampling mode to be used when computing the pass. (default: 0)
  74561. * @param engine The engine which the post process will be applied. (default: current engine)
  74562. * @param reusable If the post process can be reused on the same frame. (default: false)
  74563. * @param textureType Type of textures used when performing the post process. (default: 0)
  74564. * @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)
  74565. */
  74566. constructor(name: string, options: number | PostProcessOptions, camera: Nullable<Camera>, samplingMode?: number, engine?: Engine, reusable?: boolean, textureType?: number, blockCompilation?: boolean);
  74567. /** @hidden */
  74568. static _Parse(parsedPostProcess: any, targetCamera: Camera, scene: Scene, rootUrl: string): SharpenPostProcess;
  74569. }
  74570. }
  74571. declare module "babylonjs/PostProcesses/RenderPipeline/postProcessRenderPipeline" {
  74572. import { Nullable } from "babylonjs/types";
  74573. import { Camera } from "babylonjs/Cameras/camera";
  74574. import { Engine } from "babylonjs/Engines/engine";
  74575. import { PostProcessRenderEffect } from "babylonjs/PostProcesses/RenderPipeline/postProcessRenderEffect";
  74576. import { IInspectable } from "babylonjs/Misc/iInspectable";
  74577. import { PrePassRenderer } from "babylonjs/Rendering/prePassRenderer";
  74578. /**
  74579. * PostProcessRenderPipeline
  74580. * @see https://doc.babylonjs.com/how_to/how_to_use_postprocessrenderpipeline
  74581. */
  74582. export class PostProcessRenderPipeline {
  74583. private engine;
  74584. private _renderEffects;
  74585. private _renderEffectsForIsolatedPass;
  74586. /**
  74587. * List of inspectable custom properties (used by the Inspector)
  74588. * @see https://doc.babylonjs.com/how_to/debug_layer#extensibility
  74589. */
  74590. inspectableCustomProperties: IInspectable[];
  74591. /**
  74592. * @hidden
  74593. */
  74594. protected _cameras: Camera[];
  74595. /** @hidden */
  74596. _name: string;
  74597. /**
  74598. * Gets pipeline name
  74599. */
  74600. get name(): string;
  74601. /** Gets the list of attached cameras */
  74602. get cameras(): Camera[];
  74603. /**
  74604. * Initializes a PostProcessRenderPipeline
  74605. * @param engine engine to add the pipeline to
  74606. * @param name name of the pipeline
  74607. */
  74608. constructor(engine: Engine, name: string);
  74609. /**
  74610. * Gets the class name
  74611. * @returns "PostProcessRenderPipeline"
  74612. */
  74613. getClassName(): string;
  74614. /**
  74615. * If all the render effects in the pipeline are supported
  74616. */
  74617. get isSupported(): boolean;
  74618. /**
  74619. * Adds an effect to the pipeline
  74620. * @param renderEffect the effect to add
  74621. */
  74622. addEffect(renderEffect: PostProcessRenderEffect): void;
  74623. /** @hidden */
  74624. _rebuild(): void;
  74625. /** @hidden */
  74626. _enableEffect(renderEffectName: string, cameras: Camera): void;
  74627. /** @hidden */
  74628. _enableEffect(renderEffectName: string, cameras: Camera[]): void;
  74629. /** @hidden */
  74630. _disableEffect(renderEffectName: string, cameras: Nullable<Camera[]>): void;
  74631. /** @hidden */
  74632. _disableEffect(renderEffectName: string, cameras: Nullable<Camera[]>): void;
  74633. /** @hidden */
  74634. _attachCameras(cameras: Camera, unique: boolean): void;
  74635. /** @hidden */
  74636. _attachCameras(cameras: Camera[], unique: boolean): void;
  74637. /** @hidden */
  74638. _detachCameras(cameras: Camera): void;
  74639. /** @hidden */
  74640. _detachCameras(cameras: Nullable<Camera[]>): void;
  74641. /** @hidden */
  74642. _update(): void;
  74643. /** @hidden */
  74644. _reset(): void;
  74645. protected _enableMSAAOnFirstPostProcess(sampleCount: number): boolean;
  74646. /**
  74647. * Sets the required values to the prepass renderer.
  74648. * @param prePassRenderer defines the prepass renderer to setup.
  74649. * @returns true if the pre pass is needed.
  74650. */
  74651. setPrePassRenderer(prePassRenderer: PrePassRenderer): boolean;
  74652. /**
  74653. * Disposes of the pipeline
  74654. */
  74655. dispose(): void;
  74656. }
  74657. }
  74658. declare module "babylonjs/PostProcesses/RenderPipeline/postProcessRenderPipelineManager" {
  74659. import { Camera } from "babylonjs/Cameras/camera";
  74660. import { PostProcessRenderPipeline } from "babylonjs/PostProcesses/RenderPipeline/postProcessRenderPipeline";
  74661. /**
  74662. * PostProcessRenderPipelineManager class
  74663. * @see https://doc.babylonjs.com/how_to/how_to_use_postprocessrenderpipeline
  74664. */
  74665. export class PostProcessRenderPipelineManager {
  74666. private _renderPipelines;
  74667. /**
  74668. * Initializes a PostProcessRenderPipelineManager
  74669. * @see https://doc.babylonjs.com/how_to/how_to_use_postprocessrenderpipeline
  74670. */
  74671. constructor();
  74672. /**
  74673. * Gets the list of supported render pipelines
  74674. */
  74675. get supportedPipelines(): PostProcessRenderPipeline[];
  74676. /**
  74677. * Adds a pipeline to the manager
  74678. * @param renderPipeline The pipeline to add
  74679. */
  74680. addPipeline(renderPipeline: PostProcessRenderPipeline): void;
  74681. /**
  74682. * Attaches a camera to the pipeline
  74683. * @param renderPipelineName The name of the pipeline to attach to
  74684. * @param cameras the camera to attach
  74685. * @param unique if the camera can be attached multiple times to the pipeline
  74686. */
  74687. attachCamerasToRenderPipeline(renderPipelineName: string, cameras: any | Camera[] | Camera, unique?: boolean): void;
  74688. /**
  74689. * Detaches a camera from the pipeline
  74690. * @param renderPipelineName The name of the pipeline to detach from
  74691. * @param cameras the camera to detach
  74692. */
  74693. detachCamerasFromRenderPipeline(renderPipelineName: string, cameras: any | Camera[] | Camera): void;
  74694. /**
  74695. * Enables an effect by name on a pipeline
  74696. * @param renderPipelineName the name of the pipeline to enable the effect in
  74697. * @param renderEffectName the name of the effect to enable
  74698. * @param cameras the cameras that the effect should be enabled on
  74699. */
  74700. enableEffectInPipeline(renderPipelineName: string, renderEffectName: string, cameras: any | Camera[] | Camera): void;
  74701. /**
  74702. * Disables an effect by name on a pipeline
  74703. * @param renderPipelineName the name of the pipeline to disable the effect in
  74704. * @param renderEffectName the name of the effect to disable
  74705. * @param cameras the cameras that the effect should be disabled on
  74706. */
  74707. disableEffectInPipeline(renderPipelineName: string, renderEffectName: string, cameras: any | Camera[] | Camera): void;
  74708. /**
  74709. * Updates the state of all contained render pipelines and disposes of any non supported pipelines
  74710. */
  74711. update(): void;
  74712. /** @hidden */
  74713. _rebuild(): void;
  74714. /**
  74715. * Disposes of the manager and pipelines
  74716. */
  74717. dispose(): void;
  74718. }
  74719. }
  74720. declare module "babylonjs/PostProcesses/RenderPipeline/postProcessRenderPipelineManagerSceneComponent" {
  74721. import { ISceneComponent } from "babylonjs/sceneComponent";
  74722. import { PostProcessRenderPipelineManager } from "babylonjs/PostProcesses/RenderPipeline/postProcessRenderPipelineManager";
  74723. import { Scene } from "babylonjs/scene";
  74724. module "babylonjs/scene" {
  74725. interface Scene {
  74726. /** @hidden (Backing field) */
  74727. _postProcessRenderPipelineManager: PostProcessRenderPipelineManager;
  74728. /**
  74729. * Gets the postprocess render pipeline manager
  74730. * @see https://doc.babylonjs.com/how_to/how_to_use_postprocessrenderpipeline
  74731. * @see https://doc.babylonjs.com/how_to/using_default_rendering_pipeline
  74732. */
  74733. readonly postProcessRenderPipelineManager: PostProcessRenderPipelineManager;
  74734. }
  74735. }
  74736. /**
  74737. * Defines the Render Pipeline scene component responsible to rendering pipelines
  74738. */
  74739. export class PostProcessRenderPipelineManagerSceneComponent implements ISceneComponent {
  74740. /**
  74741. * The component name helpfull to identify the component in the list of scene components.
  74742. */
  74743. readonly name: string;
  74744. /**
  74745. * The scene the component belongs to.
  74746. */
  74747. scene: Scene;
  74748. /**
  74749. * Creates a new instance of the component for the given scene
  74750. * @param scene Defines the scene to register the component in
  74751. */
  74752. constructor(scene: Scene);
  74753. /**
  74754. * Registers the component in a given scene
  74755. */
  74756. register(): void;
  74757. /**
  74758. * Rebuilds the elements related to this component in case of
  74759. * context lost for instance.
  74760. */
  74761. rebuild(): void;
  74762. /**
  74763. * Disposes the component and the associated ressources
  74764. */
  74765. dispose(): void;
  74766. private _gatherRenderTargets;
  74767. }
  74768. }
  74769. declare module "babylonjs/PostProcesses/RenderPipeline/Pipelines/defaultRenderingPipeline" {
  74770. import { Nullable } from "babylonjs/types";
  74771. import { IAnimatable } from "babylonjs/Animations/animatable.interface";
  74772. import { Camera } from "babylonjs/Cameras/camera";
  74773. import { IDisposable } from "babylonjs/scene";
  74774. import { GlowLayer } from "babylonjs/Layers/glowLayer";
  74775. import { Scene } from "babylonjs/scene";
  74776. import { SharpenPostProcess } from "babylonjs/PostProcesses/sharpenPostProcess";
  74777. import { ImageProcessingPostProcess } from "babylonjs/PostProcesses/imageProcessingPostProcess";
  74778. import { ChromaticAberrationPostProcess } from "babylonjs/PostProcesses/chromaticAberrationPostProcess";
  74779. import { GrainPostProcess } from "babylonjs/PostProcesses/grainPostProcess";
  74780. import { FxaaPostProcess } from "babylonjs/PostProcesses/fxaaPostProcess";
  74781. import { PostProcessRenderPipeline } from "babylonjs/PostProcesses/RenderPipeline/postProcessRenderPipeline";
  74782. import { DepthOfFieldEffect, DepthOfFieldEffectBlurLevel } from "babylonjs/PostProcesses/depthOfFieldEffect";
  74783. import "babylonjs/PostProcesses/RenderPipeline/postProcessRenderPipelineManagerSceneComponent";
  74784. import { Animation } from "babylonjs/Animations/animation";
  74785. /**
  74786. * The default rendering pipeline can be added to a scene to apply common post processing effects such as anti-aliasing or depth of field.
  74787. * See https://doc.babylonjs.com/how_to/using_default_rendering_pipeline
  74788. */
  74789. export class DefaultRenderingPipeline extends PostProcessRenderPipeline implements IDisposable, IAnimatable {
  74790. private _scene;
  74791. private _camerasToBeAttached;
  74792. /**
  74793. * ID of the sharpen post process,
  74794. */
  74795. private readonly SharpenPostProcessId;
  74796. /**
  74797. * @ignore
  74798. * ID of the image processing post process;
  74799. */
  74800. readonly ImageProcessingPostProcessId: string;
  74801. /**
  74802. * @ignore
  74803. * ID of the Fast Approximate Anti-Aliasing post process;
  74804. */
  74805. readonly FxaaPostProcessId: string;
  74806. /**
  74807. * ID of the chromatic aberration post process,
  74808. */
  74809. private readonly ChromaticAberrationPostProcessId;
  74810. /**
  74811. * ID of the grain post process
  74812. */
  74813. private readonly GrainPostProcessId;
  74814. /**
  74815. * Sharpen post process which will apply a sharpen convolution to enhance edges
  74816. */
  74817. sharpen: SharpenPostProcess;
  74818. private _sharpenEffect;
  74819. private bloom;
  74820. /**
  74821. * Depth of field effect, applies a blur based on how far away objects are from the focus distance.
  74822. */
  74823. depthOfField: DepthOfFieldEffect;
  74824. /**
  74825. * The Fast Approximate Anti-Aliasing post process which attemps to remove aliasing from an image.
  74826. */
  74827. fxaa: FxaaPostProcess;
  74828. /**
  74829. * Image post processing pass used to perform operations such as tone mapping or color grading.
  74830. */
  74831. imageProcessing: ImageProcessingPostProcess;
  74832. /**
  74833. * Chromatic aberration post process which will shift rgb colors in the image
  74834. */
  74835. chromaticAberration: ChromaticAberrationPostProcess;
  74836. private _chromaticAberrationEffect;
  74837. /**
  74838. * Grain post process which add noise to the image
  74839. */
  74840. grain: GrainPostProcess;
  74841. private _grainEffect;
  74842. /**
  74843. * Glow post process which adds a glow to emissive areas of the image
  74844. */
  74845. private _glowLayer;
  74846. /**
  74847. * Animations which can be used to tweak settings over a period of time
  74848. */
  74849. animations: Animation[];
  74850. private _imageProcessingConfigurationObserver;
  74851. private _sharpenEnabled;
  74852. private _bloomEnabled;
  74853. private _depthOfFieldEnabled;
  74854. private _depthOfFieldBlurLevel;
  74855. private _fxaaEnabled;
  74856. private _imageProcessingEnabled;
  74857. private _defaultPipelineTextureType;
  74858. private _bloomScale;
  74859. private _chromaticAberrationEnabled;
  74860. private _grainEnabled;
  74861. private _buildAllowed;
  74862. /**
  74863. * Gets active scene
  74864. */
  74865. get scene(): Scene;
  74866. /**
  74867. * Enable or disable the sharpen process from the pipeline
  74868. */
  74869. set sharpenEnabled(enabled: boolean);
  74870. get sharpenEnabled(): boolean;
  74871. private _resizeObserver;
  74872. private _hardwareScaleLevel;
  74873. private _bloomKernel;
  74874. /**
  74875. * Specifies the size of the bloom blur kernel, relative to the final output size
  74876. */
  74877. get bloomKernel(): number;
  74878. set bloomKernel(value: number);
  74879. /**
  74880. * Specifies the weight of the bloom in the final rendering
  74881. */
  74882. private _bloomWeight;
  74883. /**
  74884. * Specifies the luma threshold for the area that will be blurred by the bloom
  74885. */
  74886. private _bloomThreshold;
  74887. private _hdr;
  74888. /**
  74889. * The strength of the bloom.
  74890. */
  74891. set bloomWeight(value: number);
  74892. get bloomWeight(): number;
  74893. /**
  74894. * The strength of the bloom.
  74895. */
  74896. set bloomThreshold(value: number);
  74897. get bloomThreshold(): number;
  74898. /**
  74899. * The scale of the bloom, lower value will provide better performance.
  74900. */
  74901. set bloomScale(value: number);
  74902. get bloomScale(): number;
  74903. /**
  74904. * Enable or disable the bloom from the pipeline
  74905. */
  74906. set bloomEnabled(enabled: boolean);
  74907. get bloomEnabled(): boolean;
  74908. private _rebuildBloom;
  74909. /**
  74910. * If the depth of field is enabled.
  74911. */
  74912. get depthOfFieldEnabled(): boolean;
  74913. set depthOfFieldEnabled(enabled: boolean);
  74914. /**
  74915. * Blur level of the depth of field effect. (Higher blur will effect performance)
  74916. */
  74917. get depthOfFieldBlurLevel(): DepthOfFieldEffectBlurLevel;
  74918. set depthOfFieldBlurLevel(value: DepthOfFieldEffectBlurLevel);
  74919. /**
  74920. * If the anti aliasing is enabled.
  74921. */
  74922. set fxaaEnabled(enabled: boolean);
  74923. get fxaaEnabled(): boolean;
  74924. private _samples;
  74925. /**
  74926. * MSAA sample count, setting this to 4 will provide 4x anti aliasing. (default: 1)
  74927. */
  74928. set samples(sampleCount: number);
  74929. get samples(): number;
  74930. /**
  74931. * If image processing is enabled.
  74932. */
  74933. set imageProcessingEnabled(enabled: boolean);
  74934. get imageProcessingEnabled(): boolean;
  74935. /**
  74936. * If glow layer is enabled. (Adds a glow effect to emmissive materials)
  74937. */
  74938. set glowLayerEnabled(enabled: boolean);
  74939. get glowLayerEnabled(): boolean;
  74940. /**
  74941. * Gets the glow layer (or null if not defined)
  74942. */
  74943. get glowLayer(): Nullable<GlowLayer>;
  74944. /**
  74945. * Enable or disable the chromaticAberration process from the pipeline
  74946. */
  74947. set chromaticAberrationEnabled(enabled: boolean);
  74948. get chromaticAberrationEnabled(): boolean;
  74949. /**
  74950. * Enable or disable the grain process from the pipeline
  74951. */
  74952. set grainEnabled(enabled: boolean);
  74953. get grainEnabled(): boolean;
  74954. /**
  74955. * @constructor
  74956. * @param name - The rendering pipeline name (default: "")
  74957. * @param hdr - If high dynamic range textures should be used (default: true)
  74958. * @param scene - The scene linked to this pipeline (default: the last created scene)
  74959. * @param cameras - The array of cameras that the rendering pipeline will be attached to (default: scene.cameras)
  74960. * @param automaticBuild - if false, you will have to manually call prepare() to update the pipeline (default: true)
  74961. */
  74962. constructor(name?: string, hdr?: boolean, scene?: Scene, cameras?: Camera[], automaticBuild?: boolean);
  74963. /**
  74964. * Get the class name
  74965. * @returns "DefaultRenderingPipeline"
  74966. */
  74967. getClassName(): string;
  74968. /**
  74969. * Force the compilation of the entire pipeline.
  74970. */
  74971. prepare(): void;
  74972. private _hasCleared;
  74973. private _prevPostProcess;
  74974. private _prevPrevPostProcess;
  74975. private _setAutoClearAndTextureSharing;
  74976. private _depthOfFieldSceneObserver;
  74977. private _buildPipeline;
  74978. private _disposePostProcesses;
  74979. /**
  74980. * Adds a camera to the pipeline
  74981. * @param camera the camera to be added
  74982. */
  74983. addCamera(camera: Camera): void;
  74984. /**
  74985. * Removes a camera from the pipeline
  74986. * @param camera the camera to remove
  74987. */
  74988. removeCamera(camera: Camera): void;
  74989. /**
  74990. * Dispose of the pipeline and stop all post processes
  74991. */
  74992. dispose(): void;
  74993. /**
  74994. * Serialize the rendering pipeline (Used when exporting)
  74995. * @returns the serialized object
  74996. */
  74997. serialize(): any;
  74998. /**
  74999. * Parse the serialized pipeline
  75000. * @param source Source pipeline.
  75001. * @param scene The scene to load the pipeline to.
  75002. * @param rootUrl The URL of the serialized pipeline.
  75003. * @returns An instantiated pipeline from the serialized object.
  75004. */
  75005. static Parse(source: any, scene: Scene, rootUrl: string): DefaultRenderingPipeline;
  75006. }
  75007. }
  75008. declare module "babylonjs/Shaders/lensHighlights.fragment" {
  75009. /** @hidden */
  75010. export var lensHighlightsPixelShader: {
  75011. name: string;
  75012. shader: string;
  75013. };
  75014. }
  75015. declare module "babylonjs/Shaders/depthOfField.fragment" {
  75016. /** @hidden */
  75017. export var depthOfFieldPixelShader: {
  75018. name: string;
  75019. shader: string;
  75020. };
  75021. }
  75022. declare module "babylonjs/PostProcesses/RenderPipeline/Pipelines/lensRenderingPipeline" {
  75023. import { Camera } from "babylonjs/Cameras/camera";
  75024. import { PostProcessRenderPipeline } from "babylonjs/PostProcesses/RenderPipeline/postProcessRenderPipeline";
  75025. import { Scene } from "babylonjs/scene";
  75026. import "babylonjs/PostProcesses/RenderPipeline/postProcessRenderPipelineManagerSceneComponent";
  75027. import "babylonjs/Shaders/chromaticAberration.fragment";
  75028. import "babylonjs/Shaders/lensHighlights.fragment";
  75029. import "babylonjs/Shaders/depthOfField.fragment";
  75030. /**
  75031. * BABYLON.JS Chromatic Aberration GLSL Shader
  75032. * Author: Olivier Guyot
  75033. * Separates very slightly R, G and B colors on the edges of the screen
  75034. * Inspired by Francois Tarlier & Martins Upitis
  75035. */
  75036. export class LensRenderingPipeline extends PostProcessRenderPipeline {
  75037. /**
  75038. * @ignore
  75039. * The chromatic aberration PostProcess id in the pipeline
  75040. */
  75041. LensChromaticAberrationEffect: string;
  75042. /**
  75043. * @ignore
  75044. * The highlights enhancing PostProcess id in the pipeline
  75045. */
  75046. HighlightsEnhancingEffect: string;
  75047. /**
  75048. * @ignore
  75049. * The depth-of-field PostProcess id in the pipeline
  75050. */
  75051. LensDepthOfFieldEffect: string;
  75052. private _scene;
  75053. private _depthTexture;
  75054. private _grainTexture;
  75055. private _chromaticAberrationPostProcess;
  75056. private _highlightsPostProcess;
  75057. private _depthOfFieldPostProcess;
  75058. private _edgeBlur;
  75059. private _grainAmount;
  75060. private _chromaticAberration;
  75061. private _distortion;
  75062. private _highlightsGain;
  75063. private _highlightsThreshold;
  75064. private _dofDistance;
  75065. private _dofAperture;
  75066. private _dofDarken;
  75067. private _dofPentagon;
  75068. private _blurNoise;
  75069. /**
  75070. * @constructor
  75071. *
  75072. * Effect parameters are as follow:
  75073. * {
  75074. * chromatic_aberration: number; // from 0 to x (1 for realism)
  75075. * edge_blur: number; // from 0 to x (1 for realism)
  75076. * distortion: number; // from 0 to x (1 for realism)
  75077. * grain_amount: number; // from 0 to 1
  75078. * grain_texture: BABYLON.Texture; // texture to use for grain effect; if unset, use random B&W noise
  75079. * dof_focus_distance: number; // depth-of-field: focus distance; unset to disable (disabled by default)
  75080. * dof_aperture: number; // depth-of-field: focus blur bias (default: 1)
  75081. * dof_darken: number; // depth-of-field: darken that which is out of focus (from 0 to 1, disabled by default)
  75082. * dof_pentagon: boolean; // depth-of-field: makes a pentagon-like "bokeh" effect
  75083. * dof_gain: number; // depth-of-field: highlights gain; unset to disable (disabled by default)
  75084. * dof_threshold: number; // depth-of-field: highlights threshold (default: 1)
  75085. * blur_noise: boolean; // add a little bit of noise to the blur (default: true)
  75086. * }
  75087. * Note: if an effect parameter is unset, effect is disabled
  75088. *
  75089. * @param name The rendering pipeline name
  75090. * @param parameters - An object containing all parameters (see above)
  75091. * @param scene The scene linked to this pipeline
  75092. * @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)
  75093. * @param cameras The array of cameras that the rendering pipeline will be attached to
  75094. */
  75095. constructor(name: string, parameters: any, scene: Scene, ratio?: number, cameras?: Camera[]);
  75096. /**
  75097. * Get the class name
  75098. * @returns "LensRenderingPipeline"
  75099. */
  75100. getClassName(): string;
  75101. /**
  75102. * Gets associated scene
  75103. */
  75104. get scene(): Scene;
  75105. /**
  75106. * Gets or sets the edge blur
  75107. */
  75108. get edgeBlur(): number;
  75109. set edgeBlur(value: number);
  75110. /**
  75111. * Gets or sets the grain amount
  75112. */
  75113. get grainAmount(): number;
  75114. set grainAmount(value: number);
  75115. /**
  75116. * Gets or sets the chromatic aberration amount
  75117. */
  75118. get chromaticAberration(): number;
  75119. set chromaticAberration(value: number);
  75120. /**
  75121. * Gets or sets the depth of field aperture
  75122. */
  75123. get dofAperture(): number;
  75124. set dofAperture(value: number);
  75125. /**
  75126. * Gets or sets the edge distortion
  75127. */
  75128. get edgeDistortion(): number;
  75129. set edgeDistortion(value: number);
  75130. /**
  75131. * Gets or sets the depth of field distortion
  75132. */
  75133. get dofDistortion(): number;
  75134. set dofDistortion(value: number);
  75135. /**
  75136. * Gets or sets the darken out of focus amount
  75137. */
  75138. get darkenOutOfFocus(): number;
  75139. set darkenOutOfFocus(value: number);
  75140. /**
  75141. * Gets or sets a boolean indicating if blur noise is enabled
  75142. */
  75143. get blurNoise(): boolean;
  75144. set blurNoise(value: boolean);
  75145. /**
  75146. * Gets or sets a boolean indicating if pentagon bokeh is enabled
  75147. */
  75148. get pentagonBokeh(): boolean;
  75149. set pentagonBokeh(value: boolean);
  75150. /**
  75151. * Gets or sets the highlight grain amount
  75152. */
  75153. get highlightsGain(): number;
  75154. set highlightsGain(value: number);
  75155. /**
  75156. * Gets or sets the highlight threshold
  75157. */
  75158. get highlightsThreshold(): number;
  75159. set highlightsThreshold(value: number);
  75160. /**
  75161. * Sets the amount of blur at the edges
  75162. * @param amount blur amount
  75163. */
  75164. setEdgeBlur(amount: number): void;
  75165. /**
  75166. * Sets edge blur to 0
  75167. */
  75168. disableEdgeBlur(): void;
  75169. /**
  75170. * Sets the amout of grain
  75171. * @param amount Amount of grain
  75172. */
  75173. setGrainAmount(amount: number): void;
  75174. /**
  75175. * Set grain amount to 0
  75176. */
  75177. disableGrain(): void;
  75178. /**
  75179. * Sets the chromatic aberration amount
  75180. * @param amount amount of chromatic aberration
  75181. */
  75182. setChromaticAberration(amount: number): void;
  75183. /**
  75184. * Sets chromatic aberration amount to 0
  75185. */
  75186. disableChromaticAberration(): void;
  75187. /**
  75188. * Sets the EdgeDistortion amount
  75189. * @param amount amount of EdgeDistortion
  75190. */
  75191. setEdgeDistortion(amount: number): void;
  75192. /**
  75193. * Sets edge distortion to 0
  75194. */
  75195. disableEdgeDistortion(): void;
  75196. /**
  75197. * Sets the FocusDistance amount
  75198. * @param amount amount of FocusDistance
  75199. */
  75200. setFocusDistance(amount: number): void;
  75201. /**
  75202. * Disables depth of field
  75203. */
  75204. disableDepthOfField(): void;
  75205. /**
  75206. * Sets the Aperture amount
  75207. * @param amount amount of Aperture
  75208. */
  75209. setAperture(amount: number): void;
  75210. /**
  75211. * Sets the DarkenOutOfFocus amount
  75212. * @param amount amount of DarkenOutOfFocus
  75213. */
  75214. setDarkenOutOfFocus(amount: number): void;
  75215. private _pentagonBokehIsEnabled;
  75216. /**
  75217. * Creates a pentagon bokeh effect
  75218. */
  75219. enablePentagonBokeh(): void;
  75220. /**
  75221. * Disables the pentagon bokeh effect
  75222. */
  75223. disablePentagonBokeh(): void;
  75224. /**
  75225. * Enables noise blur
  75226. */
  75227. enableNoiseBlur(): void;
  75228. /**
  75229. * Disables noise blur
  75230. */
  75231. disableNoiseBlur(): void;
  75232. /**
  75233. * Sets the HighlightsGain amount
  75234. * @param amount amount of HighlightsGain
  75235. */
  75236. setHighlightsGain(amount: number): void;
  75237. /**
  75238. * Sets the HighlightsThreshold amount
  75239. * @param amount amount of HighlightsThreshold
  75240. */
  75241. setHighlightsThreshold(amount: number): void;
  75242. /**
  75243. * Disables highlights
  75244. */
  75245. disableHighlights(): void;
  75246. /**
  75247. * Removes the internal pipeline assets and detaches the pipeline from the scene cameras
  75248. * @param disableDepthRender If the scens depth rendering should be disabled (default: false)
  75249. */
  75250. dispose(disableDepthRender?: boolean): void;
  75251. private _createChromaticAberrationPostProcess;
  75252. private _createHighlightsPostProcess;
  75253. private _createDepthOfFieldPostProcess;
  75254. private _createGrainTexture;
  75255. }
  75256. }
  75257. declare module "babylonjs/Rendering/ssao2Configuration" {
  75258. import { PrePassEffectConfiguration } from "babylonjs/Rendering/prePassEffectConfiguration";
  75259. /**
  75260. * Contains all parameters needed for the prepass to perform
  75261. * screen space subsurface scattering
  75262. */
  75263. export class SSAO2Configuration implements PrePassEffectConfiguration {
  75264. /**
  75265. * Is subsurface enabled
  75266. */
  75267. enabled: boolean;
  75268. /**
  75269. * Name of the configuration
  75270. */
  75271. name: string;
  75272. /**
  75273. * Textures that should be present in the MRT for this effect to work
  75274. */
  75275. readonly texturesRequired: number[];
  75276. }
  75277. }
  75278. declare module "babylonjs/Shaders/ssao2.fragment" {
  75279. /** @hidden */
  75280. export var ssao2PixelShader: {
  75281. name: string;
  75282. shader: string;
  75283. };
  75284. }
  75285. declare module "babylonjs/Shaders/ssaoCombine.fragment" {
  75286. /** @hidden */
  75287. export var ssaoCombinePixelShader: {
  75288. name: string;
  75289. shader: string;
  75290. };
  75291. }
  75292. declare module "babylonjs/PostProcesses/RenderPipeline/Pipelines/ssao2RenderingPipeline" {
  75293. import { Camera } from "babylonjs/Cameras/camera";
  75294. import { PostProcessRenderPipeline } from "babylonjs/PostProcesses/RenderPipeline/postProcessRenderPipeline";
  75295. import { Scene } from "babylonjs/scene";
  75296. import "babylonjs/PostProcesses/RenderPipeline/postProcessRenderPipelineManagerSceneComponent";
  75297. import "babylonjs/Shaders/ssao2.fragment";
  75298. import "babylonjs/Shaders/ssaoCombine.fragment";
  75299. /**
  75300. * Render pipeline to produce ssao effect
  75301. */
  75302. export class SSAO2RenderingPipeline extends PostProcessRenderPipeline {
  75303. /**
  75304. * @ignore
  75305. * The PassPostProcess id in the pipeline that contains the original scene color
  75306. */
  75307. SSAOOriginalSceneColorEffect: string;
  75308. /**
  75309. * @ignore
  75310. * The SSAO PostProcess id in the pipeline
  75311. */
  75312. SSAORenderEffect: string;
  75313. /**
  75314. * @ignore
  75315. * The horizontal blur PostProcess id in the pipeline
  75316. */
  75317. SSAOBlurHRenderEffect: string;
  75318. /**
  75319. * @ignore
  75320. * The vertical blur PostProcess id in the pipeline
  75321. */
  75322. SSAOBlurVRenderEffect: string;
  75323. /**
  75324. * @ignore
  75325. * The PostProcess id in the pipeline that combines the SSAO-Blur output with the original scene color (SSAOOriginalSceneColorEffect)
  75326. */
  75327. SSAOCombineRenderEffect: string;
  75328. /**
  75329. * The output strength of the SSAO post-process. Default value is 1.0.
  75330. */
  75331. totalStrength: number;
  75332. /**
  75333. * Maximum depth value to still render AO. A smooth falloff makes the dimming more natural, so there will be no abrupt shading change.
  75334. */
  75335. maxZ: number;
  75336. /**
  75337. * In order to save performances, SSAO radius is clamped on close geometry. This ratio changes by how much
  75338. */
  75339. minZAspect: number;
  75340. private _samples;
  75341. /**
  75342. * Number of samples used for the SSAO calculations. Default value is 8
  75343. */
  75344. set samples(n: number);
  75345. get samples(): number;
  75346. private _textureSamples;
  75347. /**
  75348. * Number of samples to use for antialiasing
  75349. */
  75350. set textureSamples(n: number);
  75351. get textureSamples(): number;
  75352. /**
  75353. * Force rendering the geometry through geometry buffer
  75354. */
  75355. private _forceGeometryBuffer;
  75356. /**
  75357. * Ratio object used for SSAO ratio and blur ratio
  75358. */
  75359. private _ratio;
  75360. /**
  75361. * Dynamically generated sphere sampler.
  75362. */
  75363. private _sampleSphere;
  75364. /**
  75365. * Blur filter offsets
  75366. */
  75367. private _samplerOffsets;
  75368. private _expensiveBlur;
  75369. /**
  75370. * If bilateral blur should be used
  75371. */
  75372. set expensiveBlur(b: boolean);
  75373. get expensiveBlur(): boolean;
  75374. /**
  75375. * The radius around the analyzed pixel used by the SSAO post-process. Default value is 2.0
  75376. */
  75377. radius: number;
  75378. /**
  75379. * The base color of the SSAO post-process
  75380. * The final result is "base + ssao" between [0, 1]
  75381. */
  75382. base: number;
  75383. /**
  75384. * Support test.
  75385. */
  75386. static get IsSupported(): boolean;
  75387. private _scene;
  75388. private _randomTexture;
  75389. private _originalColorPostProcess;
  75390. private _ssaoPostProcess;
  75391. private _blurHPostProcess;
  75392. private _blurVPostProcess;
  75393. private _ssaoCombinePostProcess;
  75394. private _prePassRenderer;
  75395. /**
  75396. * Gets active scene
  75397. */
  75398. get scene(): Scene;
  75399. /**
  75400. * @constructor
  75401. * @param name The rendering pipeline name
  75402. * @param scene The scene linked to this pipeline
  75403. * @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 }
  75404. * @param cameras The array of cameras that the rendering pipeline will be attached to
  75405. * @param forceGeometryBuffer Set to true if you want to use the legacy geometry buffer renderer
  75406. */
  75407. constructor(name: string, scene: Scene, ratio: any, cameras?: Camera[], forceGeometryBuffer?: boolean);
  75408. /**
  75409. * Get the class name
  75410. * @returns "SSAO2RenderingPipeline"
  75411. */
  75412. getClassName(): string;
  75413. /**
  75414. * Removes the internal pipeline assets and detatches the pipeline from the scene cameras
  75415. */
  75416. dispose(disableGeometryBufferRenderer?: boolean): void;
  75417. private _createBlurPostProcess;
  75418. /** @hidden */
  75419. _rebuild(): void;
  75420. private _bits;
  75421. private _radicalInverse_VdC;
  75422. private _hammersley;
  75423. private _hemisphereSample_uniform;
  75424. private _generateHemisphere;
  75425. private _getDefinesForSSAO;
  75426. private _createSSAOPostProcess;
  75427. private _createSSAOCombinePostProcess;
  75428. private _createRandomTexture;
  75429. /**
  75430. * Serialize the rendering pipeline (Used when exporting)
  75431. * @returns the serialized object
  75432. */
  75433. serialize(): any;
  75434. /**
  75435. * Parse the serialized pipeline
  75436. * @param source Source pipeline.
  75437. * @param scene The scene to load the pipeline to.
  75438. * @param rootUrl The URL of the serialized pipeline.
  75439. * @returns An instantiated pipeline from the serialized object.
  75440. */
  75441. static Parse(source: any, scene: Scene, rootUrl: string): SSAO2RenderingPipeline;
  75442. }
  75443. }
  75444. declare module "babylonjs/Shaders/ssao.fragment" {
  75445. /** @hidden */
  75446. export var ssaoPixelShader: {
  75447. name: string;
  75448. shader: string;
  75449. };
  75450. }
  75451. declare module "babylonjs/PostProcesses/RenderPipeline/Pipelines/ssaoRenderingPipeline" {
  75452. import { Camera } from "babylonjs/Cameras/camera";
  75453. import { PostProcessRenderPipeline } from "babylonjs/PostProcesses/RenderPipeline/postProcessRenderPipeline";
  75454. import { Scene } from "babylonjs/scene";
  75455. import "babylonjs/PostProcesses/RenderPipeline/postProcessRenderPipelineManagerSceneComponent";
  75456. import "babylonjs/Shaders/ssao.fragment";
  75457. import "babylonjs/Shaders/ssaoCombine.fragment";
  75458. /**
  75459. * Render pipeline to produce ssao effect
  75460. */
  75461. export class SSAORenderingPipeline extends PostProcessRenderPipeline {
  75462. /**
  75463. * @ignore
  75464. * The PassPostProcess id in the pipeline that contains the original scene color
  75465. */
  75466. SSAOOriginalSceneColorEffect: string;
  75467. /**
  75468. * @ignore
  75469. * The SSAO PostProcess id in the pipeline
  75470. */
  75471. SSAORenderEffect: string;
  75472. /**
  75473. * @ignore
  75474. * The horizontal blur PostProcess id in the pipeline
  75475. */
  75476. SSAOBlurHRenderEffect: string;
  75477. /**
  75478. * @ignore
  75479. * The vertical blur PostProcess id in the pipeline
  75480. */
  75481. SSAOBlurVRenderEffect: string;
  75482. /**
  75483. * @ignore
  75484. * The PostProcess id in the pipeline that combines the SSAO-Blur output with the original scene color (SSAOOriginalSceneColorEffect)
  75485. */
  75486. SSAOCombineRenderEffect: string;
  75487. /**
  75488. * The output strength of the SSAO post-process. Default value is 1.0.
  75489. */
  75490. totalStrength: number;
  75491. /**
  75492. * The radius around the analyzed pixel used by the SSAO post-process. Default value is 0.0006
  75493. */
  75494. radius: number;
  75495. /**
  75496. * Related to fallOff, used to interpolate SSAO samples (first interpolate function input) based on the occlusion difference of each pixel
  75497. * Must not be equal to fallOff and superior to fallOff.
  75498. * Default value is 0.0075
  75499. */
  75500. area: number;
  75501. /**
  75502. * Related to area, used to interpolate SSAO samples (second interpolate function input) based on the occlusion difference of each pixel
  75503. * Must not be equal to area and inferior to area.
  75504. * Default value is 0.000001
  75505. */
  75506. fallOff: number;
  75507. /**
  75508. * The base color of the SSAO post-process
  75509. * The final result is "base + ssao" between [0, 1]
  75510. */
  75511. base: number;
  75512. private _scene;
  75513. private _depthTexture;
  75514. private _randomTexture;
  75515. private _originalColorPostProcess;
  75516. private _ssaoPostProcess;
  75517. private _blurHPostProcess;
  75518. private _blurVPostProcess;
  75519. private _ssaoCombinePostProcess;
  75520. private _firstUpdate;
  75521. /**
  75522. * Gets active scene
  75523. */
  75524. get scene(): Scene;
  75525. /**
  75526. * @constructor
  75527. * @param name - The rendering pipeline name
  75528. * @param scene - The scene linked to this pipeline
  75529. * @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 }
  75530. * @param cameras - The array of cameras that the rendering pipeline will be attached to
  75531. */
  75532. constructor(name: string, scene: Scene, ratio: any, cameras?: Camera[]);
  75533. /**
  75534. * Get the class name
  75535. * @returns "SSAORenderingPipeline"
  75536. */
  75537. getClassName(): string;
  75538. /**
  75539. * Removes the internal pipeline assets and detatches the pipeline from the scene cameras
  75540. */
  75541. dispose(disableDepthRender?: boolean): void;
  75542. private _createBlurPostProcess;
  75543. /** @hidden */
  75544. _rebuild(): void;
  75545. private _createSSAOPostProcess;
  75546. private _createSSAOCombinePostProcess;
  75547. private _createRandomTexture;
  75548. }
  75549. }
  75550. declare module "babylonjs/Rendering/screenSpaceReflectionsConfiguration" {
  75551. import { PrePassEffectConfiguration } from "babylonjs/Rendering/prePassEffectConfiguration";
  75552. /**
  75553. * Contains all parameters needed for the prepass to perform
  75554. * screen space reflections
  75555. */
  75556. export class ScreenSpaceReflectionsConfiguration implements PrePassEffectConfiguration {
  75557. /**
  75558. * Is ssr enabled
  75559. */
  75560. enabled: boolean;
  75561. /**
  75562. * Name of the configuration
  75563. */
  75564. name: string;
  75565. /**
  75566. * Textures that should be present in the MRT for this effect to work
  75567. */
  75568. readonly texturesRequired: number[];
  75569. }
  75570. }
  75571. declare module "babylonjs/Shaders/screenSpaceReflection.fragment" {
  75572. /** @hidden */
  75573. export var screenSpaceReflectionPixelShader: {
  75574. name: string;
  75575. shader: string;
  75576. };
  75577. }
  75578. declare module "babylonjs/PostProcesses/screenSpaceReflectionPostProcess" {
  75579. import { Nullable } from "babylonjs/types";
  75580. import { Camera } from "babylonjs/Cameras/camera";
  75581. import { PostProcess, PostProcessOptions } from "babylonjs/PostProcesses/postProcess";
  75582. import "babylonjs/Shaders/screenSpaceReflection.fragment";
  75583. import { Engine } from "babylonjs/Engines/engine";
  75584. import { Scene } from "babylonjs/scene";
  75585. /**
  75586. * The ScreenSpaceReflectionPostProcess performs realtime reflections using only and only the available informations on the screen (positions and normals).
  75587. * Basically, the screen space reflection post-process will compute reflections according the material's reflectivity.
  75588. */
  75589. export class ScreenSpaceReflectionPostProcess extends PostProcess {
  75590. /**
  75591. * Gets or sets a reflection threshold mainly used to adjust the reflection's height.
  75592. */
  75593. threshold: number;
  75594. /**
  75595. * Gets or sets the current reflection strength. 1.0 is an ideal value but can be increased/decreased for particular results.
  75596. */
  75597. strength: number;
  75598. /**
  75599. * Gets or sets the falloff exponent used while computing fresnel. More the exponent is high, more the reflections will be discrete.
  75600. */
  75601. reflectionSpecularFalloffExponent: number;
  75602. /**
  75603. * 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]
  75604. */
  75605. step: number;
  75606. /**
  75607. * Gets or sets the factor applied when computing roughness. Default value is 0.2.
  75608. */
  75609. roughnessFactor: number;
  75610. private _forceGeometryBuffer;
  75611. private _geometryBufferRenderer;
  75612. private _prePassRenderer;
  75613. private _enableSmoothReflections;
  75614. private _reflectionSamples;
  75615. private _smoothSteps;
  75616. /**
  75617. * Gets a string identifying the name of the class
  75618. * @returns "ScreenSpaceReflectionPostProcess" string
  75619. */
  75620. getClassName(): string;
  75621. /**
  75622. * Creates a new instance of ScreenSpaceReflectionPostProcess.
  75623. * @param name The name of the effect.
  75624. * @param scene The scene containing the objects to calculate reflections.
  75625. * @param options The required width/height ratio to downsize to before computing the render pass.
  75626. * @param camera The camera to apply the render pass to.
  75627. * @param samplingMode The sampling mode to be used when computing the pass. (default: 0)
  75628. * @param engine The engine which the post process will be applied. (default: current engine)
  75629. * @param reusable If the post process can be reused on the same frame. (default: false)
  75630. * @param textureType Type of textures used when performing the post process. (default: 0)
  75631. * @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)
  75632. * @param forceGeometryBuffer If this post process should use geometry buffer instead of prepass (default: false)
  75633. */
  75634. constructor(name: string, scene: Scene, options: number | PostProcessOptions, camera: Nullable<Camera>, samplingMode?: number, engine?: Engine, reusable?: boolean, textureType?: number, blockCompilation?: boolean, forceGeometryBuffer?: boolean);
  75635. /**
  75636. * Gets wether or not smoothing reflections is enabled.
  75637. * Enabling smoothing will require more GPU power and can generate a drop in FPS.
  75638. */
  75639. get enableSmoothReflections(): boolean;
  75640. /**
  75641. * Sets wether or not smoothing reflections is enabled.
  75642. * Enabling smoothing will require more GPU power and can generate a drop in FPS.
  75643. */
  75644. set enableSmoothReflections(enabled: boolean);
  75645. /**
  75646. * Gets the number of samples taken while computing reflections. More samples count is high,
  75647. * more the post-process wil require GPU power and can generate a drop in FPS. Basically in interval [25, 100].
  75648. */
  75649. get reflectionSamples(): number;
  75650. /**
  75651. * Sets the number of samples taken while computing reflections. More samples count is high,
  75652. * more the post-process wil require GPU power and can generate a drop in FPS. Basically in interval [25, 100].
  75653. */
  75654. set reflectionSamples(samples: number);
  75655. /**
  75656. * Gets the number of samples taken while smoothing reflections. More samples count is high,
  75657. * more the post-process will require GPU power and can generate a drop in FPS.
  75658. * Default value (5.0) work pretty well in all cases but can be adjusted.
  75659. */
  75660. get smoothSteps(): number;
  75661. set smoothSteps(steps: number);
  75662. private _updateEffectDefines;
  75663. /** @hidden */
  75664. static _Parse(parsedPostProcess: any, targetCamera: Camera, scene: Scene, rootUrl: string): ScreenSpaceReflectionPostProcess;
  75665. }
  75666. }
  75667. declare module "babylonjs/Shaders/standard.fragment" {
  75668. import "babylonjs/Shaders/ShadersInclude/packingFunctions";
  75669. /** @hidden */
  75670. export var standardPixelShader: {
  75671. name: string;
  75672. shader: string;
  75673. };
  75674. }
  75675. declare module "babylonjs/PostProcesses/RenderPipeline/Pipelines/standardRenderingPipeline" {
  75676. import { Nullable } from "babylonjs/types";
  75677. import { IAnimatable } from "babylonjs/Animations/animatable.interface";
  75678. import { Camera } from "babylonjs/Cameras/camera";
  75679. import { Texture } from "babylonjs/Materials/Textures/texture";
  75680. import { PostProcess } from "babylonjs/PostProcesses/postProcess";
  75681. import { PostProcessRenderPipeline } from "babylonjs/PostProcesses/RenderPipeline/postProcessRenderPipeline";
  75682. import { BlurPostProcess } from "babylonjs/PostProcesses/blurPostProcess";
  75683. import { FxaaPostProcess } from "babylonjs/PostProcesses/fxaaPostProcess";
  75684. import { IDisposable } from "babylonjs/scene";
  75685. import { SpotLight } from "babylonjs/Lights/spotLight";
  75686. import { DirectionalLight } from "babylonjs/Lights/directionalLight";
  75687. import { Scene } from "babylonjs/scene";
  75688. import { ScreenSpaceReflectionPostProcess } from "babylonjs/PostProcesses/screenSpaceReflectionPostProcess";
  75689. import { Animation } from "babylonjs/Animations/animation";
  75690. import "babylonjs/PostProcesses/RenderPipeline/postProcessRenderPipelineManagerSceneComponent";
  75691. import "babylonjs/Shaders/standard.fragment";
  75692. /**
  75693. * Standard rendering pipeline
  75694. * Default pipeline should be used going forward but the standard pipeline will be kept for backwards compatibility.
  75695. * @see https://doc.babylonjs.com/how_to/using_standard_rendering_pipeline
  75696. */
  75697. export class StandardRenderingPipeline extends PostProcessRenderPipeline implements IDisposable, IAnimatable {
  75698. /**
  75699. * Public members
  75700. */
  75701. /**
  75702. * Post-process which contains the original scene color before the pipeline applies all the effects
  75703. */
  75704. originalPostProcess: Nullable<PostProcess>;
  75705. /**
  75706. * Post-process used to down scale an image x4
  75707. */
  75708. downSampleX4PostProcess: Nullable<PostProcess>;
  75709. /**
  75710. * Post-process used to calculate the illuminated surfaces controlled by a threshold
  75711. */
  75712. brightPassPostProcess: Nullable<PostProcess>;
  75713. /**
  75714. * Post-process array storing all the horizontal blur post-processes used by the pipeline
  75715. */
  75716. blurHPostProcesses: PostProcess[];
  75717. /**
  75718. * Post-process array storing all the vertical blur post-processes used by the pipeline
  75719. */
  75720. blurVPostProcesses: PostProcess[];
  75721. /**
  75722. * Post-process used to add colors of 2 textures (typically brightness + real scene color)
  75723. */
  75724. textureAdderPostProcess: Nullable<PostProcess>;
  75725. /**
  75726. * Post-process used to create volumetric lighting effect
  75727. */
  75728. volumetricLightPostProcess: Nullable<PostProcess>;
  75729. /**
  75730. * Post-process used to smooth the previous volumetric light post-process on the X axis
  75731. */
  75732. volumetricLightSmoothXPostProcess: Nullable<BlurPostProcess>;
  75733. /**
  75734. * Post-process used to smooth the previous volumetric light post-process on the Y axis
  75735. */
  75736. volumetricLightSmoothYPostProcess: Nullable<BlurPostProcess>;
  75737. /**
  75738. * Post-process used to merge the volumetric light effect and the real scene color
  75739. */
  75740. volumetricLightMergePostProces: Nullable<PostProcess>;
  75741. /**
  75742. * Post-process used to store the final volumetric light post-process (attach/detach for debug purpose)
  75743. */
  75744. volumetricLightFinalPostProcess: Nullable<PostProcess>;
  75745. /**
  75746. * Base post-process used to calculate the average luminance of the final image for HDR
  75747. */
  75748. luminancePostProcess: Nullable<PostProcess>;
  75749. /**
  75750. * Post-processes used to create down sample post-processes in order to get
  75751. * the average luminance of the final image for HDR
  75752. * Array of length "StandardRenderingPipeline.LuminanceSteps"
  75753. */
  75754. luminanceDownSamplePostProcesses: PostProcess[];
  75755. /**
  75756. * Post-process used to create a HDR effect (light adaptation)
  75757. */
  75758. hdrPostProcess: Nullable<PostProcess>;
  75759. /**
  75760. * Post-process used to store the final texture adder post-process (attach/detach for debug purpose)
  75761. */
  75762. textureAdderFinalPostProcess: Nullable<PostProcess>;
  75763. /**
  75764. * Post-process used to store the final lens flare post-process (attach/detach for debug purpose)
  75765. */
  75766. lensFlareFinalPostProcess: Nullable<PostProcess>;
  75767. /**
  75768. * Post-process used to merge the final HDR post-process and the real scene color
  75769. */
  75770. hdrFinalPostProcess: Nullable<PostProcess>;
  75771. /**
  75772. * Post-process used to create a lens flare effect
  75773. */
  75774. lensFlarePostProcess: Nullable<PostProcess>;
  75775. /**
  75776. * Post-process that merges the result of the lens flare post-process and the real scene color
  75777. */
  75778. lensFlareComposePostProcess: Nullable<PostProcess>;
  75779. /**
  75780. * Post-process used to create a motion blur effect
  75781. */
  75782. motionBlurPostProcess: Nullable<PostProcess>;
  75783. /**
  75784. * Post-process used to create a depth of field effect
  75785. */
  75786. depthOfFieldPostProcess: Nullable<PostProcess>;
  75787. /**
  75788. * The Fast Approximate Anti-Aliasing post process which attemps to remove aliasing from an image.
  75789. */
  75790. fxaaPostProcess: Nullable<FxaaPostProcess>;
  75791. /**
  75792. * Post-process used to simulate realtime reflections using the screen space and geometry renderer.
  75793. */
  75794. screenSpaceReflectionPostProcess: Nullable<ScreenSpaceReflectionPostProcess>;
  75795. /**
  75796. * Represents the brightness threshold in order to configure the illuminated surfaces
  75797. */
  75798. brightThreshold: number;
  75799. /**
  75800. * Configures the blur intensity used for surexposed surfaces are highlighted surfaces (light halo)
  75801. */
  75802. blurWidth: number;
  75803. /**
  75804. * Sets if the blur for highlighted surfaces must be only horizontal
  75805. */
  75806. horizontalBlur: boolean;
  75807. /**
  75808. * Gets the overall exposure used by the pipeline
  75809. */
  75810. get exposure(): number;
  75811. /**
  75812. * Sets the overall exposure used by the pipeline
  75813. */
  75814. set exposure(value: number);
  75815. /**
  75816. * Texture used typically to simulate "dirty" on camera lens
  75817. */
  75818. lensTexture: Nullable<Texture>;
  75819. /**
  75820. * Represents the offset coefficient based on Rayleigh principle. Typically in interval [-0.2, 0.2]
  75821. */
  75822. volumetricLightCoefficient: number;
  75823. /**
  75824. * The overall power of volumetric lights, typically in interval [0, 10] maximum
  75825. */
  75826. volumetricLightPower: number;
  75827. /**
  75828. * Used the set the blur intensity to smooth the volumetric lights
  75829. */
  75830. volumetricLightBlurScale: number;
  75831. /**
  75832. * Light (spot or directional) used to generate the volumetric lights rays
  75833. * The source light must have a shadow generate so the pipeline can get its
  75834. * depth map
  75835. */
  75836. sourceLight: Nullable<SpotLight | DirectionalLight>;
  75837. /**
  75838. * For eye adaptation, represents the minimum luminance the eye can see
  75839. */
  75840. hdrMinimumLuminance: number;
  75841. /**
  75842. * For eye adaptation, represents the decrease luminance speed
  75843. */
  75844. hdrDecreaseRate: number;
  75845. /**
  75846. * For eye adaptation, represents the increase luminance speed
  75847. */
  75848. hdrIncreaseRate: number;
  75849. /**
  75850. * Gets wether or not the exposure of the overall pipeline should be automatically adjusted by the HDR post-process
  75851. */
  75852. get hdrAutoExposure(): boolean;
  75853. /**
  75854. * Sets wether or not the exposure of the overall pipeline should be automatically adjusted by the HDR post-process
  75855. */
  75856. set hdrAutoExposure(value: boolean);
  75857. /**
  75858. * Lens color texture used by the lens flare effect. Mandatory if lens flare effect enabled
  75859. */
  75860. lensColorTexture: Nullable<Texture>;
  75861. /**
  75862. * The overall strengh for the lens flare effect
  75863. */
  75864. lensFlareStrength: number;
  75865. /**
  75866. * Dispersion coefficient for lens flare ghosts
  75867. */
  75868. lensFlareGhostDispersal: number;
  75869. /**
  75870. * Main lens flare halo width
  75871. */
  75872. lensFlareHaloWidth: number;
  75873. /**
  75874. * Based on the lens distortion effect, defines how much the lens flare result
  75875. * is distorted
  75876. */
  75877. lensFlareDistortionStrength: number;
  75878. /**
  75879. * Configures the blur intensity used for for lens flare (halo)
  75880. */
  75881. lensFlareBlurWidth: number;
  75882. /**
  75883. * Lens star texture must be used to simulate rays on the flares and is available
  75884. * in the documentation
  75885. */
  75886. lensStarTexture: Nullable<Texture>;
  75887. /**
  75888. * As the "lensTexture" (can be the same texture or different), it is used to apply the lens
  75889. * flare effect by taking account of the dirt texture
  75890. */
  75891. lensFlareDirtTexture: Nullable<Texture>;
  75892. /**
  75893. * Represents the focal length for the depth of field effect
  75894. */
  75895. depthOfFieldDistance: number;
  75896. /**
  75897. * Represents the blur intensity for the blurred part of the depth of field effect
  75898. */
  75899. depthOfFieldBlurWidth: number;
  75900. /**
  75901. * Gets how much the image is blurred by the movement while using the motion blur post-process
  75902. */
  75903. get motionStrength(): number;
  75904. /**
  75905. * Sets how much the image is blurred by the movement while using the motion blur post-process
  75906. */
  75907. set motionStrength(strength: number);
  75908. /**
  75909. * Gets wether or not the motion blur post-process is object based or screen based.
  75910. */
  75911. get objectBasedMotionBlur(): boolean;
  75912. /**
  75913. * Sets wether or not the motion blur post-process should be object based or screen based
  75914. */
  75915. set objectBasedMotionBlur(value: boolean);
  75916. /**
  75917. * List of animations for the pipeline (IAnimatable implementation)
  75918. */
  75919. animations: Animation[];
  75920. /**
  75921. * Private members
  75922. */
  75923. private _scene;
  75924. private _currentDepthOfFieldSource;
  75925. private _basePostProcess;
  75926. private _fixedExposure;
  75927. private _currentExposure;
  75928. private _hdrAutoExposure;
  75929. private _hdrCurrentLuminance;
  75930. private _motionStrength;
  75931. private _isObjectBasedMotionBlur;
  75932. private _floatTextureType;
  75933. private _camerasToBeAttached;
  75934. private _ratio;
  75935. private _bloomEnabled;
  75936. private _depthOfFieldEnabled;
  75937. private _vlsEnabled;
  75938. private _lensFlareEnabled;
  75939. private _hdrEnabled;
  75940. private _motionBlurEnabled;
  75941. private _fxaaEnabled;
  75942. private _screenSpaceReflectionsEnabled;
  75943. private _motionBlurSamples;
  75944. private _volumetricLightStepsCount;
  75945. private _samples;
  75946. /**
  75947. * @ignore
  75948. * Specifies if the bloom pipeline is enabled
  75949. */
  75950. get BloomEnabled(): boolean;
  75951. set BloomEnabled(enabled: boolean);
  75952. /**
  75953. * @ignore
  75954. * Specifies if the depth of field pipeline is enabed
  75955. */
  75956. get DepthOfFieldEnabled(): boolean;
  75957. set DepthOfFieldEnabled(enabled: boolean);
  75958. /**
  75959. * @ignore
  75960. * Specifies if the lens flare pipeline is enabed
  75961. */
  75962. get LensFlareEnabled(): boolean;
  75963. set LensFlareEnabled(enabled: boolean);
  75964. /**
  75965. * @ignore
  75966. * Specifies if the HDR pipeline is enabled
  75967. */
  75968. get HDREnabled(): boolean;
  75969. set HDREnabled(enabled: boolean);
  75970. /**
  75971. * @ignore
  75972. * Specifies if the volumetric lights scattering effect is enabled
  75973. */
  75974. get VLSEnabled(): boolean;
  75975. set VLSEnabled(enabled: boolean);
  75976. /**
  75977. * @ignore
  75978. * Specifies if the motion blur effect is enabled
  75979. */
  75980. get MotionBlurEnabled(): boolean;
  75981. set MotionBlurEnabled(enabled: boolean);
  75982. /**
  75983. * Specifies if anti-aliasing is enabled
  75984. */
  75985. get fxaaEnabled(): boolean;
  75986. set fxaaEnabled(enabled: boolean);
  75987. /**
  75988. * Specifies if screen space reflections are enabled.
  75989. */
  75990. get screenSpaceReflectionsEnabled(): boolean;
  75991. set screenSpaceReflectionsEnabled(enabled: boolean);
  75992. /**
  75993. * Specifies the number of steps used to calculate the volumetric lights
  75994. * Typically in interval [50, 200]
  75995. */
  75996. get volumetricLightStepsCount(): number;
  75997. set volumetricLightStepsCount(count: number);
  75998. /**
  75999. * Specifies the number of samples used for the motion blur effect
  76000. * Typically in interval [16, 64]
  76001. */
  76002. get motionBlurSamples(): number;
  76003. set motionBlurSamples(samples: number);
  76004. /**
  76005. * Specifies MSAA sample count, setting this to 4 will provide 4x anti aliasing. (default: 1)
  76006. */
  76007. get samples(): number;
  76008. set samples(sampleCount: number);
  76009. /**
  76010. * Default pipeline should be used going forward but the standard pipeline will be kept for backwards compatibility.
  76011. * @constructor
  76012. * @param name The rendering pipeline name
  76013. * @param scene The scene linked to this pipeline
  76014. * @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)
  76015. * @param originalPostProcess the custom original color post-process. Must be "reusable". Can be null.
  76016. * @param cameras The array of cameras that the rendering pipeline will be attached to
  76017. */
  76018. constructor(name: string, scene: Scene, ratio: number, originalPostProcess?: Nullable<PostProcess>, cameras?: Camera[]);
  76019. private _buildPipeline;
  76020. private _createDownSampleX4PostProcess;
  76021. private _createBrightPassPostProcess;
  76022. private _createBlurPostProcesses;
  76023. private _createTextureAdderPostProcess;
  76024. private _createVolumetricLightPostProcess;
  76025. private _createLuminancePostProcesses;
  76026. private _createHdrPostProcess;
  76027. private _createLensFlarePostProcess;
  76028. private _createDepthOfFieldPostProcess;
  76029. private _createMotionBlurPostProcess;
  76030. private _getDepthTexture;
  76031. private _disposePostProcesses;
  76032. /**
  76033. * Dispose of the pipeline and stop all post processes
  76034. */
  76035. dispose(): void;
  76036. /**
  76037. * Serialize the rendering pipeline (Used when exporting)
  76038. * @returns the serialized object
  76039. */
  76040. serialize(): any;
  76041. /**
  76042. * Parse the serialized pipeline
  76043. * @param source Source pipeline.
  76044. * @param scene The scene to load the pipeline to.
  76045. * @param rootUrl The URL of the serialized pipeline.
  76046. * @returns An instantiated pipeline from the serialized object.
  76047. */
  76048. static Parse(source: any, scene: Scene, rootUrl: string): StandardRenderingPipeline;
  76049. /**
  76050. * Luminance steps
  76051. */
  76052. static LuminanceSteps: number;
  76053. }
  76054. }
  76055. declare module "babylonjs/PostProcesses/RenderPipeline/Pipelines/index" {
  76056. export * from "babylonjs/PostProcesses/RenderPipeline/Pipelines/defaultRenderingPipeline";
  76057. export * from "babylonjs/PostProcesses/RenderPipeline/Pipelines/lensRenderingPipeline";
  76058. export * from "babylonjs/PostProcesses/RenderPipeline/Pipelines/ssao2RenderingPipeline";
  76059. export * from "babylonjs/PostProcesses/RenderPipeline/Pipelines/ssaoRenderingPipeline";
  76060. export * from "babylonjs/PostProcesses/RenderPipeline/Pipelines/standardRenderingPipeline";
  76061. }
  76062. declare module "babylonjs/PostProcesses/RenderPipeline/index" {
  76063. export * from "babylonjs/PostProcesses/RenderPipeline/Pipelines/index";
  76064. export * from "babylonjs/PostProcesses/RenderPipeline/postProcessRenderEffect";
  76065. export * from "babylonjs/PostProcesses/RenderPipeline/postProcessRenderPipeline";
  76066. export * from "babylonjs/PostProcesses/RenderPipeline/postProcessRenderPipelineManager";
  76067. export * from "babylonjs/PostProcesses/RenderPipeline/postProcessRenderPipelineManagerSceneComponent";
  76068. }
  76069. declare module "babylonjs/Shaders/stereoscopicInterlace.fragment" {
  76070. /** @hidden */
  76071. export var stereoscopicInterlacePixelShader: {
  76072. name: string;
  76073. shader: string;
  76074. };
  76075. }
  76076. declare module "babylonjs/PostProcesses/stereoscopicInterlacePostProcess" {
  76077. import { Camera } from "babylonjs/Cameras/camera";
  76078. import { PostProcess } from "babylonjs/PostProcesses/postProcess";
  76079. import { Engine } from "babylonjs/Engines/engine";
  76080. import "babylonjs/Shaders/stereoscopicInterlace.fragment";
  76081. /**
  76082. * StereoscopicInterlacePostProcessI used to render stereo views from a rigged camera with support for alternate line interlacing
  76083. */
  76084. export class StereoscopicInterlacePostProcessI extends PostProcess {
  76085. private _stepSize;
  76086. private _passedProcess;
  76087. /**
  76088. * Gets a string identifying the name of the class
  76089. * @returns "StereoscopicInterlacePostProcessI" string
  76090. */
  76091. getClassName(): string;
  76092. /**
  76093. * Initializes a StereoscopicInterlacePostProcessI
  76094. * @param name The name of the effect.
  76095. * @param rigCameras The rig cameras to be appled to the post process
  76096. * @param isStereoscopicHoriz If the rendered results are horizontal or vertical
  76097. * @param isStereoscopicInterlaced If the rendered results are alternate line interlaced
  76098. * @param samplingMode The sampling mode to be used when computing the pass. (default: 0)
  76099. * @param engine The engine which the post process will be applied. (default: current engine)
  76100. * @param reusable If the post process can be reused on the same frame. (default: false)
  76101. */
  76102. constructor(name: string, rigCameras: Camera[], isStereoscopicHoriz: boolean, isStereoscopicInterlaced: boolean, samplingMode?: number, engine?: Engine, reusable?: boolean);
  76103. }
  76104. /**
  76105. * StereoscopicInterlacePostProcess used to render stereo views from a rigged camera
  76106. */
  76107. export class StereoscopicInterlacePostProcess extends PostProcess {
  76108. private _stepSize;
  76109. private _passedProcess;
  76110. /**
  76111. * Gets a string identifying the name of the class
  76112. * @returns "StereoscopicInterlacePostProcess" string
  76113. */
  76114. getClassName(): string;
  76115. /**
  76116. * Initializes a StereoscopicInterlacePostProcess
  76117. * @param name The name of the effect.
  76118. * @param rigCameras The rig cameras to be appled to the post process
  76119. * @param isStereoscopicHoriz If the rendered results are horizontal or verticle
  76120. * @param samplingMode The sampling mode to be used when computing the pass. (default: 0)
  76121. * @param engine The engine which the post process will be applied. (default: current engine)
  76122. * @param reusable If the post process can be reused on the same frame. (default: false)
  76123. */
  76124. constructor(name: string, rigCameras: Camera[], isStereoscopicHoriz: boolean, samplingMode?: number, engine?: Engine, reusable?: boolean);
  76125. }
  76126. }
  76127. declare module "babylonjs/Shaders/tonemap.fragment" {
  76128. /** @hidden */
  76129. export var tonemapPixelShader: {
  76130. name: string;
  76131. shader: string;
  76132. };
  76133. }
  76134. declare module "babylonjs/PostProcesses/tonemapPostProcess" {
  76135. import { Camera } from "babylonjs/Cameras/camera";
  76136. import { PostProcess } from "babylonjs/PostProcesses/postProcess";
  76137. import "babylonjs/Shaders/tonemap.fragment";
  76138. import { Engine } from "babylonjs/Engines/engine";
  76139. /** Defines operator used for tonemapping */
  76140. export enum TonemappingOperator {
  76141. /** Hable */
  76142. Hable = 0,
  76143. /** Reinhard */
  76144. Reinhard = 1,
  76145. /** HejiDawson */
  76146. HejiDawson = 2,
  76147. /** Photographic */
  76148. Photographic = 3
  76149. }
  76150. /**
  76151. * Defines a post process to apply tone mapping
  76152. */
  76153. export class TonemapPostProcess extends PostProcess {
  76154. private _operator;
  76155. /** Defines the required exposure adjustement */
  76156. exposureAdjustment: number;
  76157. /**
  76158. * Gets a string identifying the name of the class
  76159. * @returns "TonemapPostProcess" string
  76160. */
  76161. getClassName(): string;
  76162. /**
  76163. * Creates a new TonemapPostProcess
  76164. * @param name defines the name of the postprocess
  76165. * @param _operator defines the operator to use
  76166. * @param exposureAdjustment defines the required exposure adjustement
  76167. * @param camera defines the camera to use (can be null)
  76168. * @param samplingMode defines the required sampling mode (BABYLON.Texture.BILINEAR_SAMPLINGMODE by default)
  76169. * @param engine defines the hosting engine (can be ignore if camera is set)
  76170. * @param textureFormat defines the texture format to use (BABYLON.Engine.TEXTURETYPE_UNSIGNED_INT by default)
  76171. */
  76172. constructor(name: string, _operator: TonemappingOperator,
  76173. /** Defines the required exposure adjustement */
  76174. exposureAdjustment: number, camera: Camera, samplingMode?: number, engine?: Engine, textureFormat?: number);
  76175. }
  76176. }
  76177. declare module "babylonjs/Shaders/volumetricLightScattering.fragment" {
  76178. /** @hidden */
  76179. export var volumetricLightScatteringPixelShader: {
  76180. name: string;
  76181. shader: string;
  76182. };
  76183. }
  76184. declare module "babylonjs/Shaders/volumetricLightScatteringPass.vertex" {
  76185. import "babylonjs/Shaders/ShadersInclude/bonesDeclaration";
  76186. import "babylonjs/Shaders/ShadersInclude/morphTargetsVertexGlobalDeclaration";
  76187. import "babylonjs/Shaders/ShadersInclude/morphTargetsVertexDeclaration";
  76188. import "babylonjs/Shaders/ShadersInclude/instancesDeclaration";
  76189. import "babylonjs/Shaders/ShadersInclude/morphTargetsVertex";
  76190. import "babylonjs/Shaders/ShadersInclude/instancesVertex";
  76191. import "babylonjs/Shaders/ShadersInclude/bonesVertex";
  76192. /** @hidden */
  76193. export var volumetricLightScatteringPassVertexShader: {
  76194. name: string;
  76195. shader: string;
  76196. };
  76197. }
  76198. declare module "babylonjs/Shaders/volumetricLightScatteringPass.fragment" {
  76199. /** @hidden */
  76200. export var volumetricLightScatteringPassPixelShader: {
  76201. name: string;
  76202. shader: string;
  76203. };
  76204. }
  76205. declare module "babylonjs/PostProcesses/volumetricLightScatteringPostProcess" {
  76206. import { Vector3 } from "babylonjs/Maths/math.vector";
  76207. import { AbstractMesh } from "babylonjs/Meshes/abstractMesh";
  76208. import { Mesh } from "babylonjs/Meshes/mesh";
  76209. import { Camera } from "babylonjs/Cameras/camera";
  76210. import { RenderTargetTexture } from "babylonjs/Materials/Textures/renderTargetTexture";
  76211. import { PostProcess } from "babylonjs/PostProcesses/postProcess";
  76212. import { Scene } from "babylonjs/scene";
  76213. import "babylonjs/Meshes/Builders/planeBuilder";
  76214. import "babylonjs/Shaders/depth.vertex";
  76215. import "babylonjs/Shaders/volumetricLightScattering.fragment";
  76216. import "babylonjs/Shaders/volumetricLightScatteringPass.vertex";
  76217. import "babylonjs/Shaders/volumetricLightScatteringPass.fragment";
  76218. import { Engine } from "babylonjs/Engines/engine";
  76219. /**
  76220. * Inspired by http://http.developer.nvidia.com/GPUGems3/gpugems3_ch13.html
  76221. */
  76222. export class VolumetricLightScatteringPostProcess extends PostProcess {
  76223. private _volumetricLightScatteringPass;
  76224. private _volumetricLightScatteringRTT;
  76225. private _viewPort;
  76226. private _screenCoordinates;
  76227. private _cachedDefines;
  76228. /**
  76229. * If not undefined, the mesh position is computed from the attached node position
  76230. */
  76231. attachedNode: {
  76232. position: Vector3;
  76233. };
  76234. /**
  76235. * Custom position of the mesh. Used if "useCustomMeshPosition" is set to "true"
  76236. */
  76237. customMeshPosition: Vector3;
  76238. /**
  76239. * Set if the post-process should use a custom position for the light source (true) or the internal mesh position (false)
  76240. */
  76241. useCustomMeshPosition: boolean;
  76242. /**
  76243. * If the post-process should inverse the light scattering direction
  76244. */
  76245. invert: boolean;
  76246. /**
  76247. * The internal mesh used by the post-process
  76248. */
  76249. mesh: Mesh;
  76250. /**
  76251. * @hidden
  76252. * VolumetricLightScatteringPostProcess.useDiffuseColor is no longer used, use the mesh material directly instead
  76253. */
  76254. get useDiffuseColor(): boolean;
  76255. set useDiffuseColor(useDiffuseColor: boolean);
  76256. /**
  76257. * Array containing the excluded meshes not rendered in the internal pass
  76258. */
  76259. excludedMeshes: AbstractMesh[];
  76260. /**
  76261. * Controls the overall intensity of the post-process
  76262. */
  76263. exposure: number;
  76264. /**
  76265. * Dissipates each sample's contribution in range [0, 1]
  76266. */
  76267. decay: number;
  76268. /**
  76269. * Controls the overall intensity of each sample
  76270. */
  76271. weight: number;
  76272. /**
  76273. * Controls the density of each sample
  76274. */
  76275. density: number;
  76276. /**
  76277. * @constructor
  76278. * @param name The post-process name
  76279. * @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)
  76280. * @param camera The camera that the post-process will be attached to
  76281. * @param mesh The mesh used to create the light scattering
  76282. * @param samples The post-process quality, default 100
  76283. * @param samplingModeThe post-process filtering mode
  76284. * @param engine The babylon engine
  76285. * @param reusable If the post-process is reusable
  76286. * @param scene The constructor needs a scene reference to initialize internal components. If "camera" is null a "scene" must be provided
  76287. */
  76288. constructor(name: string, ratio: any, camera: Camera, mesh?: Mesh, samples?: number, samplingMode?: number, engine?: Engine, reusable?: boolean, scene?: Scene);
  76289. /**
  76290. * Returns the string "VolumetricLightScatteringPostProcess"
  76291. * @returns "VolumetricLightScatteringPostProcess"
  76292. */
  76293. getClassName(): string;
  76294. private _isReady;
  76295. /**
  76296. * Sets the new light position for light scattering effect
  76297. * @param position The new custom light position
  76298. */
  76299. setCustomMeshPosition(position: Vector3): void;
  76300. /**
  76301. * Returns the light position for light scattering effect
  76302. * @return Vector3 The custom light position
  76303. */
  76304. getCustomMeshPosition(): Vector3;
  76305. /**
  76306. * Disposes the internal assets and detaches the post-process from the camera
  76307. */
  76308. dispose(camera: Camera): void;
  76309. /**
  76310. * Returns the render target texture used by the post-process
  76311. * @return the render target texture used by the post-process
  76312. */
  76313. getPass(): RenderTargetTexture;
  76314. private _meshExcluded;
  76315. private _createPass;
  76316. private _updateMeshScreenCoordinates;
  76317. /**
  76318. * Creates a default mesh for the Volumeric Light Scattering post-process
  76319. * @param name The mesh name
  76320. * @param scene The scene where to create the mesh
  76321. * @return the default mesh
  76322. */
  76323. static CreateDefaultMesh(name: string, scene: Scene): Mesh;
  76324. }
  76325. }
  76326. declare module "babylonjs/Shaders/screenSpaceCurvature.fragment" {
  76327. /** @hidden */
  76328. export var screenSpaceCurvaturePixelShader: {
  76329. name: string;
  76330. shader: string;
  76331. };
  76332. }
  76333. declare module "babylonjs/PostProcesses/screenSpaceCurvaturePostProcess" {
  76334. import { Nullable } from "babylonjs/types";
  76335. import { Camera } from "babylonjs/Cameras/camera";
  76336. import { PostProcess, PostProcessOptions } from "babylonjs/PostProcesses/postProcess";
  76337. import "babylonjs/Rendering/geometryBufferRendererSceneComponent";
  76338. import "babylonjs/Shaders/screenSpaceCurvature.fragment";
  76339. import { Engine } from "babylonjs/Engines/engine";
  76340. import { Scene } from "babylonjs/scene";
  76341. /**
  76342. * The Screen Space curvature effect can help highlighting ridge and valley of a model.
  76343. */
  76344. export class ScreenSpaceCurvaturePostProcess extends PostProcess {
  76345. /**
  76346. * Defines how much ridge the curvature effect displays.
  76347. */
  76348. ridge: number;
  76349. /**
  76350. * Defines how much valley the curvature effect displays.
  76351. */
  76352. valley: number;
  76353. private _geometryBufferRenderer;
  76354. /**
  76355. * Gets a string identifying the name of the class
  76356. * @returns "ScreenSpaceCurvaturePostProcess" string
  76357. */
  76358. getClassName(): string;
  76359. /**
  76360. * Creates a new instance ScreenSpaceCurvaturePostProcess
  76361. * @param name The name of the effect.
  76362. * @param scene The scene containing the objects to blur according to their velocity.
  76363. * @param options The required width/height ratio to downsize to before computing the render pass.
  76364. * @param camera The camera to apply the render pass to.
  76365. * @param samplingMode The sampling mode to be used when computing the pass. (default: 0)
  76366. * @param engine The engine which the post process will be applied. (default: current engine)
  76367. * @param reusable If the post process can be reused on the same frame. (default: false)
  76368. * @param textureType Type of textures used when performing the post process. (default: 0)
  76369. * @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)
  76370. */
  76371. constructor(name: string, scene: Scene, options: number | PostProcessOptions, camera: Nullable<Camera>, samplingMode?: number, engine?: Engine, reusable?: boolean, textureType?: number, blockCompilation?: boolean);
  76372. /**
  76373. * Support test.
  76374. */
  76375. static get IsSupported(): boolean;
  76376. /** @hidden */
  76377. static _Parse(parsedPostProcess: any, targetCamera: Camera, scene: Scene, rootUrl: string): ScreenSpaceCurvaturePostProcess;
  76378. }
  76379. }
  76380. declare module "babylonjs/PostProcesses/index" {
  76381. export * from "babylonjs/PostProcesses/anaglyphPostProcess";
  76382. export * from "babylonjs/PostProcesses/blackAndWhitePostProcess";
  76383. export * from "babylonjs/PostProcesses/bloomEffect";
  76384. export * from "babylonjs/PostProcesses/bloomMergePostProcess";
  76385. export * from "babylonjs/PostProcesses/blurPostProcess";
  76386. export * from "babylonjs/PostProcesses/chromaticAberrationPostProcess";
  76387. export * from "babylonjs/PostProcesses/circleOfConfusionPostProcess";
  76388. export * from "babylonjs/PostProcesses/colorCorrectionPostProcess";
  76389. export * from "babylonjs/PostProcesses/convolutionPostProcess";
  76390. export * from "babylonjs/PostProcesses/depthOfFieldBlurPostProcess";
  76391. export * from "babylonjs/PostProcesses/depthOfFieldEffect";
  76392. export * from "babylonjs/PostProcesses/depthOfFieldMergePostProcess";
  76393. export * from "babylonjs/PostProcesses/displayPassPostProcess";
  76394. export * from "babylonjs/PostProcesses/extractHighlightsPostProcess";
  76395. export * from "babylonjs/PostProcesses/filterPostProcess";
  76396. export * from "babylonjs/PostProcesses/fxaaPostProcess";
  76397. export * from "babylonjs/PostProcesses/grainPostProcess";
  76398. export * from "babylonjs/PostProcesses/highlightsPostProcess";
  76399. export * from "babylonjs/PostProcesses/imageProcessingPostProcess";
  76400. export * from "babylonjs/PostProcesses/motionBlurPostProcess";
  76401. export * from "babylonjs/PostProcesses/passPostProcess";
  76402. export * from "babylonjs/PostProcesses/postProcess";
  76403. export * from "babylonjs/PostProcesses/postProcessManager";
  76404. export * from "babylonjs/PostProcesses/refractionPostProcess";
  76405. export * from "babylonjs/PostProcesses/RenderPipeline/index";
  76406. export * from "babylonjs/PostProcesses/sharpenPostProcess";
  76407. export * from "babylonjs/PostProcesses/stereoscopicInterlacePostProcess";
  76408. export * from "babylonjs/PostProcesses/tonemapPostProcess";
  76409. export * from "babylonjs/PostProcesses/volumetricLightScatteringPostProcess";
  76410. export * from "babylonjs/PostProcesses/vrDistortionCorrectionPostProcess";
  76411. export * from "babylonjs/PostProcesses/vrMultiviewToSingleviewPostProcess";
  76412. export * from "babylonjs/PostProcesses/screenSpaceReflectionPostProcess";
  76413. export * from "babylonjs/PostProcesses/screenSpaceCurvaturePostProcess";
  76414. }
  76415. declare module "babylonjs/Probes/index" {
  76416. export * from "babylonjs/Probes/reflectionProbe";
  76417. }
  76418. declare module "babylonjs/Rendering/boundingBoxRenderer" {
  76419. import { Scene } from "babylonjs/scene";
  76420. import { AbstractMesh } from "babylonjs/Meshes/abstractMesh";
  76421. import { SmartArray } from "babylonjs/Misc/smartArray";
  76422. import { ISceneComponent } from "babylonjs/sceneComponent";
  76423. import { BoundingBox } from "babylonjs/Culling/boundingBox";
  76424. import "babylonjs/Meshes/Builders/boxBuilder";
  76425. import "babylonjs/Shaders/color.fragment";
  76426. import "babylonjs/Shaders/color.vertex";
  76427. import { Color3 } from "babylonjs/Maths/math.color";
  76428. import { Observable } from "babylonjs/Misc/observable";
  76429. module "babylonjs/scene" {
  76430. interface Scene {
  76431. /** @hidden (Backing field) */
  76432. _boundingBoxRenderer: BoundingBoxRenderer;
  76433. /** @hidden (Backing field) */
  76434. _forceShowBoundingBoxes: boolean;
  76435. /**
  76436. * Gets or sets a boolean indicating if all bounding boxes must be rendered
  76437. */
  76438. forceShowBoundingBoxes: boolean;
  76439. /**
  76440. * Gets the bounding box renderer associated with the scene
  76441. * @returns a BoundingBoxRenderer
  76442. */
  76443. getBoundingBoxRenderer(): BoundingBoxRenderer;
  76444. }
  76445. }
  76446. module "babylonjs/Meshes/abstractMesh" {
  76447. interface AbstractMesh {
  76448. /** @hidden (Backing field) */
  76449. _showBoundingBox: boolean;
  76450. /**
  76451. * Gets or sets a boolean indicating if the bounding box must be rendered as well (false by default)
  76452. */
  76453. showBoundingBox: boolean;
  76454. }
  76455. }
  76456. /**
  76457. * Component responsible of rendering the bounding box of the meshes in a scene.
  76458. * This is usually used through the mesh.showBoundingBox or the scene.forceShowBoundingBoxes properties
  76459. */
  76460. export class BoundingBoxRenderer implements ISceneComponent {
  76461. /**
  76462. * The component name helpfull to identify the component in the list of scene components.
  76463. */
  76464. readonly name: string;
  76465. /**
  76466. * The scene the component belongs to.
  76467. */
  76468. scene: Scene;
  76469. /**
  76470. * Color of the bounding box lines placed in front of an object
  76471. */
  76472. frontColor: Color3;
  76473. /**
  76474. * Color of the bounding box lines placed behind an object
  76475. */
  76476. backColor: Color3;
  76477. /**
  76478. * Defines if the renderer should show the back lines or not
  76479. */
  76480. showBackLines: boolean;
  76481. /**
  76482. * Observable raised before rendering a bounding box
  76483. */
  76484. onBeforeBoxRenderingObservable: Observable<BoundingBox>;
  76485. /**
  76486. * Observable raised after rendering a bounding box
  76487. */
  76488. onAfterBoxRenderingObservable: Observable<BoundingBox>;
  76489. /**
  76490. * @hidden
  76491. */
  76492. renderList: SmartArray<BoundingBox>;
  76493. private _colorShader;
  76494. private _vertexBuffers;
  76495. private _indexBuffer;
  76496. private _fillIndexBuffer;
  76497. private _fillIndexData;
  76498. /**
  76499. * Instantiates a new bounding box renderer in a scene.
  76500. * @param scene the scene the renderer renders in
  76501. */
  76502. constructor(scene: Scene);
  76503. /**
  76504. * Registers the component in a given scene
  76505. */
  76506. register(): void;
  76507. private _evaluateSubMesh;
  76508. private _activeMesh;
  76509. private _prepareRessources;
  76510. private _createIndexBuffer;
  76511. /**
  76512. * Rebuilds the elements related to this component in case of
  76513. * context lost for instance.
  76514. */
  76515. rebuild(): void;
  76516. /**
  76517. * @hidden
  76518. */
  76519. reset(): void;
  76520. /**
  76521. * Render the bounding boxes of a specific rendering group
  76522. * @param renderingGroupId defines the rendering group to render
  76523. */
  76524. render(renderingGroupId: number): void;
  76525. /**
  76526. * In case of occlusion queries, we can render the occlusion bounding box through this method
  76527. * @param mesh Define the mesh to render the occlusion bounding box for
  76528. */
  76529. renderOcclusionBoundingBox(mesh: AbstractMesh): void;
  76530. /**
  76531. * Dispose and release the resources attached to this renderer.
  76532. */
  76533. dispose(): void;
  76534. }
  76535. }
  76536. declare module "babylonjs/Rendering/depthRendererSceneComponent" {
  76537. import { Nullable } from "babylonjs/types";
  76538. import { Scene } from "babylonjs/scene";
  76539. import { DepthRenderer } from "babylonjs/Rendering/depthRenderer";
  76540. import { Camera } from "babylonjs/Cameras/camera";
  76541. import { ISceneComponent } from "babylonjs/sceneComponent";
  76542. module "babylonjs/scene" {
  76543. interface Scene {
  76544. /** @hidden (Backing field) */
  76545. _depthRenderer: {
  76546. [id: string]: DepthRenderer;
  76547. };
  76548. /**
  76549. * Creates a depth renderer a given camera which contains a depth map which can be used for post processing.
  76550. * @param camera The camera to create the depth renderer on (default: scene's active camera)
  76551. * @param storeNonLinearDepth Defines whether the depth is stored linearly like in Babylon Shadows or directly like glFragCoord.z
  76552. * @param force32bitsFloat Forces 32 bits float when supported (else 16 bits float is prioritized over 32 bits float if supported)
  76553. * @returns the created depth renderer
  76554. */
  76555. enableDepthRenderer(camera?: Nullable<Camera>, storeNonLinearDepth?: boolean, force32bitsFloat?: boolean): DepthRenderer;
  76556. /**
  76557. * Disables a depth renderer for a given camera
  76558. * @param camera The camera to disable the depth renderer on (default: scene's active camera)
  76559. */
  76560. disableDepthRenderer(camera?: Nullable<Camera>): void;
  76561. }
  76562. }
  76563. /**
  76564. * Defines the Depth Renderer scene component responsible to manage a depth buffer useful
  76565. * in several rendering techniques.
  76566. */
  76567. export class DepthRendererSceneComponent implements ISceneComponent {
  76568. /**
  76569. * The component name helpfull to identify the component in the list of scene components.
  76570. */
  76571. readonly name: string;
  76572. /**
  76573. * The scene the component belongs to.
  76574. */
  76575. scene: Scene;
  76576. /**
  76577. * Creates a new instance of the component for the given scene
  76578. * @param scene Defines the scene to register the component in
  76579. */
  76580. constructor(scene: Scene);
  76581. /**
  76582. * Registers the component in a given scene
  76583. */
  76584. register(): void;
  76585. /**
  76586. * Rebuilds the elements related to this component in case of
  76587. * context lost for instance.
  76588. */
  76589. rebuild(): void;
  76590. /**
  76591. * Disposes the component and the associated ressources
  76592. */
  76593. dispose(): void;
  76594. private _gatherRenderTargets;
  76595. private _gatherActiveCameraRenderTargets;
  76596. }
  76597. }
  76598. declare module "babylonjs/Rendering/prePassRendererSceneComponent" {
  76599. import { Nullable } from "babylonjs/types";
  76600. import { Scene } from "babylonjs/scene";
  76601. import { ISceneComponent } from "babylonjs/sceneComponent";
  76602. import { PrePassRenderer } from "babylonjs/Rendering/prePassRenderer";
  76603. module "babylonjs/abstractScene" {
  76604. interface AbstractScene {
  76605. /** @hidden (Backing field) */
  76606. _prePassRenderer: Nullable<PrePassRenderer>;
  76607. /**
  76608. * Gets or Sets the current prepass renderer associated to the scene.
  76609. */
  76610. prePassRenderer: Nullable<PrePassRenderer>;
  76611. /**
  76612. * Enables the prepass and associates it with the scene
  76613. * @returns the PrePassRenderer
  76614. */
  76615. enablePrePassRenderer(): Nullable<PrePassRenderer>;
  76616. /**
  76617. * Disables the prepass associated with the scene
  76618. */
  76619. disablePrePassRenderer(): void;
  76620. }
  76621. }
  76622. /**
  76623. * Defines the Geometry Buffer scene component responsible to manage a G-Buffer useful
  76624. * in several rendering techniques.
  76625. */
  76626. export class PrePassRendererSceneComponent implements ISceneComponent {
  76627. /**
  76628. * The component name helpful to identify the component in the list of scene components.
  76629. */
  76630. readonly name: string;
  76631. /**
  76632. * The scene the component belongs to.
  76633. */
  76634. scene: Scene;
  76635. /**
  76636. * Creates a new instance of the component for the given scene
  76637. * @param scene Defines the scene to register the component in
  76638. */
  76639. constructor(scene: Scene);
  76640. /**
  76641. * Registers the component in a given scene
  76642. */
  76643. register(): void;
  76644. private _beforeCameraDraw;
  76645. private _afterCameraDraw;
  76646. private _beforeClearStage;
  76647. /**
  76648. * Rebuilds the elements related to this component in case of
  76649. * context lost for instance.
  76650. */
  76651. rebuild(): void;
  76652. /**
  76653. * Disposes the component and the associated ressources
  76654. */
  76655. dispose(): void;
  76656. }
  76657. }
  76658. declare module "babylonjs/Shaders/ShadersInclude/fibonacci" {
  76659. /** @hidden */
  76660. export var fibonacci: {
  76661. name: string;
  76662. shader: string;
  76663. };
  76664. }
  76665. declare module "babylonjs/Shaders/ShadersInclude/diffusionProfile" {
  76666. /** @hidden */
  76667. export var diffusionProfile: {
  76668. name: string;
  76669. shader: string;
  76670. };
  76671. }
  76672. declare module "babylonjs/Shaders/subSurfaceScattering.fragment" {
  76673. import "babylonjs/Shaders/ShadersInclude/fibonacci";
  76674. import "babylonjs/Shaders/ShadersInclude/helperFunctions";
  76675. import "babylonjs/Shaders/ShadersInclude/subSurfaceScatteringFunctions";
  76676. import "babylonjs/Shaders/ShadersInclude/diffusionProfile";
  76677. /** @hidden */
  76678. export var subSurfaceScatteringPixelShader: {
  76679. name: string;
  76680. shader: string;
  76681. };
  76682. }
  76683. declare module "babylonjs/PostProcesses/subSurfaceScatteringPostProcess" {
  76684. import { Nullable } from "babylonjs/types";
  76685. import { Camera } from "babylonjs/Cameras/camera";
  76686. import { PostProcess, PostProcessOptions } from "babylonjs/PostProcesses/postProcess";
  76687. import { Engine } from "babylonjs/Engines/engine";
  76688. import { Scene } from "babylonjs/scene";
  76689. import "babylonjs/Shaders/imageProcessing.fragment";
  76690. import "babylonjs/Shaders/subSurfaceScattering.fragment";
  76691. import "babylonjs/Shaders/postprocess.vertex";
  76692. /**
  76693. * Sub surface scattering post process
  76694. */
  76695. export class SubSurfaceScatteringPostProcess extends PostProcess {
  76696. /**
  76697. * Gets a string identifying the name of the class
  76698. * @returns "SubSurfaceScatteringPostProcess" string
  76699. */
  76700. getClassName(): string;
  76701. constructor(name: string, scene: Scene, options: number | PostProcessOptions, camera?: Nullable<Camera>, samplingMode?: number, engine?: Engine, reusable?: boolean, textureType?: number);
  76702. }
  76703. }
  76704. declare module "babylonjs/Rendering/subSurfaceConfiguration" {
  76705. import { Scene } from "babylonjs/scene";
  76706. import { Color3 } from "babylonjs/Maths/math.color";
  76707. import { SubSurfaceScatteringPostProcess } from "babylonjs/PostProcesses/subSurfaceScatteringPostProcess";
  76708. import { PrePassEffectConfiguration } from "babylonjs/Rendering/prePassEffectConfiguration";
  76709. /**
  76710. * Contains all parameters needed for the prepass to perform
  76711. * screen space subsurface scattering
  76712. */
  76713. export class SubSurfaceConfiguration implements PrePassEffectConfiguration {
  76714. /** @hidden */
  76715. static _SceneComponentInitialization: (scene: Scene) => void;
  76716. private _ssDiffusionS;
  76717. private _ssFilterRadii;
  76718. private _ssDiffusionD;
  76719. /**
  76720. * Post process to attach for screen space subsurface scattering
  76721. */
  76722. postProcess: SubSurfaceScatteringPostProcess;
  76723. /**
  76724. * Diffusion profile color for subsurface scattering
  76725. */
  76726. get ssDiffusionS(): number[];
  76727. /**
  76728. * Diffusion profile max color channel value for subsurface scattering
  76729. */
  76730. get ssDiffusionD(): number[];
  76731. /**
  76732. * Diffusion profile filter radius for subsurface scattering
  76733. */
  76734. get ssFilterRadii(): number[];
  76735. /**
  76736. * Is subsurface enabled
  76737. */
  76738. enabled: boolean;
  76739. /**
  76740. * Name of the configuration
  76741. */
  76742. name: string;
  76743. /**
  76744. * Diffusion profile colors for subsurface scattering
  76745. * You can add one diffusion color using `addDiffusionProfile` on `scene.prePassRenderer`
  76746. * See ...
  76747. * Note that you can only store up to 5 of them
  76748. */
  76749. ssDiffusionProfileColors: Color3[];
  76750. /**
  76751. * Defines the ratio real world => scene units.
  76752. * Used for subsurface scattering
  76753. */
  76754. metersPerUnit: number;
  76755. /**
  76756. * Textures that should be present in the MRT for this effect to work
  76757. */
  76758. readonly texturesRequired: number[];
  76759. private _scene;
  76760. /**
  76761. * Builds a subsurface configuration object
  76762. * @param scene The scene
  76763. */
  76764. constructor(scene: Scene);
  76765. /**
  76766. * Adds a new diffusion profile.
  76767. * Useful for more realistic subsurface scattering on diverse materials.
  76768. * @param color The color of the diffusion profile. Should be the average color of the material.
  76769. * @return The index of the diffusion profile for the material subsurface configuration
  76770. */
  76771. addDiffusionProfile(color: Color3): number;
  76772. /**
  76773. * Creates the sss post process
  76774. * @return The created post process
  76775. */
  76776. createPostProcess(): SubSurfaceScatteringPostProcess;
  76777. /**
  76778. * Deletes all diffusion profiles.
  76779. * Note that in order to render subsurface scattering, you should have at least 1 diffusion profile.
  76780. */
  76781. clearAllDiffusionProfiles(): void;
  76782. /**
  76783. * Disposes this object
  76784. */
  76785. dispose(): void;
  76786. /**
  76787. * @hidden
  76788. * https://zero-radiance.github.io/post/sampling-diffusion/
  76789. *
  76790. * Importance sample the normalized diffuse reflectance profile for the computed value of 's'.
  76791. * ------------------------------------------------------------------------------------
  76792. * R[r, phi, s] = s * (Exp[-r * s] + Exp[-r * s / 3]) / (8 * Pi * r)
  76793. * PDF[r, phi, s] = r * R[r, phi, s]
  76794. * CDF[r, s] = 1 - 1/4 * Exp[-r * s] - 3/4 * Exp[-r * s / 3]
  76795. * ------------------------------------------------------------------------------------
  76796. * We importance sample the color channel with the widest scattering distance.
  76797. */
  76798. getDiffusionProfileParameters(color: Color3): number;
  76799. /**
  76800. * Performs sampling of a Normalized Burley diffusion profile in polar coordinates.
  76801. * 'u' is the random number (the value of the CDF): [0, 1).
  76802. * rcp(s) = 1 / ShapeParam = ScatteringDistance.
  76803. * Returns the sampled radial distance, s.t. (u = 0 -> r = 0) and (u = 1 -> r = Inf).
  76804. */
  76805. private _sampleBurleyDiffusionProfile;
  76806. }
  76807. }
  76808. declare module "babylonjs/Rendering/subSurfaceSceneComponent" {
  76809. import { Nullable } from "babylonjs/types";
  76810. import { Scene } from "babylonjs/scene";
  76811. import { ISceneSerializableComponent } from "babylonjs/sceneComponent";
  76812. import { SubSurfaceConfiguration } from "babylonjs/Rendering/subSurfaceConfiguration";
  76813. import { AbstractScene } from "babylonjs/abstractScene";
  76814. module "babylonjs/abstractScene" {
  76815. interface AbstractScene {
  76816. /** @hidden (Backing field) */
  76817. _subSurfaceConfiguration: Nullable<SubSurfaceConfiguration>;
  76818. /**
  76819. * Gets or Sets the current prepass renderer associated to the scene.
  76820. */
  76821. subSurfaceConfiguration: Nullable<SubSurfaceConfiguration>;
  76822. /**
  76823. * Enables the subsurface effect for prepass
  76824. * @returns the SubSurfaceConfiguration
  76825. */
  76826. enableSubSurfaceForPrePass(): Nullable<SubSurfaceConfiguration>;
  76827. /**
  76828. * Disables the subsurface effect for prepass
  76829. */
  76830. disableSubSurfaceForPrePass(): void;
  76831. }
  76832. }
  76833. /**
  76834. * Defines the Geometry Buffer scene component responsible to manage a G-Buffer useful
  76835. * in several rendering techniques.
  76836. */
  76837. export class SubSurfaceSceneComponent implements ISceneSerializableComponent {
  76838. /**
  76839. * The component name helpful to identify the component in the list of scene components.
  76840. */
  76841. readonly name: string;
  76842. /**
  76843. * The scene the component belongs to.
  76844. */
  76845. scene: Scene;
  76846. /**
  76847. * Creates a new instance of the component for the given scene
  76848. * @param scene Defines the scene to register the component in
  76849. */
  76850. constructor(scene: Scene);
  76851. /**
  76852. * Registers the component in a given scene
  76853. */
  76854. register(): void;
  76855. /**
  76856. * Serializes the component data to the specified json object
  76857. * @param serializationObject The object to serialize to
  76858. */
  76859. serialize(serializationObject: any): void;
  76860. /**
  76861. * Adds all the elements from the container to the scene
  76862. * @param container the container holding the elements
  76863. */
  76864. addFromContainer(container: AbstractScene): void;
  76865. /**
  76866. * Removes all the elements in the container from the scene
  76867. * @param container contains the elements to remove
  76868. * @param dispose if the removed element should be disposed (default: false)
  76869. */
  76870. removeFromContainer(container: AbstractScene, dispose?: boolean): void;
  76871. /**
  76872. * Rebuilds the elements related to this component in case of
  76873. * context lost for instance.
  76874. */
  76875. rebuild(): void;
  76876. /**
  76877. * Disposes the component and the associated ressources
  76878. */
  76879. dispose(): void;
  76880. }
  76881. }
  76882. declare module "babylonjs/Shaders/outline.fragment" {
  76883. import "babylonjs/Shaders/ShadersInclude/logDepthDeclaration";
  76884. import "babylonjs/Shaders/ShadersInclude/logDepthFragment";
  76885. /** @hidden */
  76886. export var outlinePixelShader: {
  76887. name: string;
  76888. shader: string;
  76889. };
  76890. }
  76891. declare module "babylonjs/Shaders/outline.vertex" {
  76892. import "babylonjs/Shaders/ShadersInclude/bonesDeclaration";
  76893. import "babylonjs/Shaders/ShadersInclude/morphTargetsVertexGlobalDeclaration";
  76894. import "babylonjs/Shaders/ShadersInclude/morphTargetsVertexDeclaration";
  76895. import "babylonjs/Shaders/ShadersInclude/instancesDeclaration";
  76896. import "babylonjs/Shaders/ShadersInclude/logDepthDeclaration";
  76897. import "babylonjs/Shaders/ShadersInclude/morphTargetsVertex";
  76898. import "babylonjs/Shaders/ShadersInclude/instancesVertex";
  76899. import "babylonjs/Shaders/ShadersInclude/bonesVertex";
  76900. import "babylonjs/Shaders/ShadersInclude/logDepthVertex";
  76901. /** @hidden */
  76902. export var outlineVertexShader: {
  76903. name: string;
  76904. shader: string;
  76905. };
  76906. }
  76907. declare module "babylonjs/Rendering/outlineRenderer" {
  76908. import { SubMesh } from "babylonjs/Meshes/subMesh";
  76909. import { _InstancesBatch } from "babylonjs/Meshes/mesh";
  76910. import { Scene } from "babylonjs/scene";
  76911. import { ISceneComponent } from "babylonjs/sceneComponent";
  76912. import "babylonjs/Shaders/outline.fragment";
  76913. import "babylonjs/Shaders/outline.vertex";
  76914. module "babylonjs/scene" {
  76915. interface Scene {
  76916. /** @hidden */
  76917. _outlineRenderer: OutlineRenderer;
  76918. /**
  76919. * Gets the outline renderer associated with the scene
  76920. * @returns a OutlineRenderer
  76921. */
  76922. getOutlineRenderer(): OutlineRenderer;
  76923. }
  76924. }
  76925. module "babylonjs/Meshes/abstractMesh" {
  76926. interface AbstractMesh {
  76927. /** @hidden (Backing field) */
  76928. _renderOutline: boolean;
  76929. /**
  76930. * Gets or sets a boolean indicating if the outline must be rendered as well
  76931. * @see https://www.babylonjs-playground.com/#10WJ5S#3
  76932. */
  76933. renderOutline: boolean;
  76934. /** @hidden (Backing field) */
  76935. _renderOverlay: boolean;
  76936. /**
  76937. * Gets or sets a boolean indicating if the overlay must be rendered as well
  76938. * @see https://www.babylonjs-playground.com/#10WJ5S#2
  76939. */
  76940. renderOverlay: boolean;
  76941. }
  76942. }
  76943. /**
  76944. * This class is responsible to draw bothe outline/overlay of meshes.
  76945. * It should not be used directly but through the available method on mesh.
  76946. */
  76947. export class OutlineRenderer implements ISceneComponent {
  76948. /**
  76949. * Stencil value used to avoid outline being seen within the mesh when the mesh is transparent
  76950. */
  76951. private static _StencilReference;
  76952. /**
  76953. * The name of the component. Each component must have a unique name.
  76954. */
  76955. name: string;
  76956. /**
  76957. * The scene the component belongs to.
  76958. */
  76959. scene: Scene;
  76960. /**
  76961. * Defines a zOffset to prevent zFighting between the overlay and the mesh.
  76962. */
  76963. zOffset: number;
  76964. private _engine;
  76965. private _effect;
  76966. private _cachedDefines;
  76967. private _savedDepthWrite;
  76968. /**
  76969. * Instantiates a new outline renderer. (There could be only one per scene).
  76970. * @param scene Defines the scene it belongs to
  76971. */
  76972. constructor(scene: Scene);
  76973. /**
  76974. * Register the component to one instance of a scene.
  76975. */
  76976. register(): void;
  76977. /**
  76978. * Rebuilds the elements related to this component in case of
  76979. * context lost for instance.
  76980. */
  76981. rebuild(): void;
  76982. /**
  76983. * Disposes the component and the associated ressources.
  76984. */
  76985. dispose(): void;
  76986. /**
  76987. * Renders the outline in the canvas.
  76988. * @param subMesh Defines the sumesh to render
  76989. * @param batch Defines the batch of meshes in case of instances
  76990. * @param useOverlay Defines if the rendering is for the overlay or the outline
  76991. */
  76992. render(subMesh: SubMesh, batch: _InstancesBatch, useOverlay?: boolean): void;
  76993. /**
  76994. * Returns whether or not the outline renderer is ready for a given submesh.
  76995. * All the dependencies e.g. submeshes, texture, effect... mus be ready
  76996. * @param subMesh Defines the submesh to check readyness for
  76997. * @param useInstances Defines wheter wee are trying to render instances or not
  76998. * @returns true if ready otherwise false
  76999. */
  77000. isReady(subMesh: SubMesh, useInstances: boolean): boolean;
  77001. private _beforeRenderingMesh;
  77002. private _afterRenderingMesh;
  77003. }
  77004. }
  77005. declare module "babylonjs/Rendering/index" {
  77006. export * from "babylonjs/Rendering/boundingBoxRenderer";
  77007. export * from "babylonjs/Rendering/depthRenderer";
  77008. export * from "babylonjs/Rendering/depthRendererSceneComponent";
  77009. export * from "babylonjs/Rendering/edgesRenderer";
  77010. export * from "babylonjs/Rendering/geometryBufferRenderer";
  77011. export * from "babylonjs/Rendering/geometryBufferRendererSceneComponent";
  77012. export * from "babylonjs/Rendering/prePassRenderer";
  77013. export * from "babylonjs/Rendering/prePassRendererSceneComponent";
  77014. export * from "babylonjs/Rendering/subSurfaceSceneComponent";
  77015. export * from "babylonjs/Rendering/outlineRenderer";
  77016. export * from "babylonjs/Rendering/renderingGroup";
  77017. export * from "babylonjs/Rendering/renderingManager";
  77018. export * from "babylonjs/Rendering/utilityLayerRenderer";
  77019. }
  77020. declare module "babylonjs/Sprites/ISprites" {
  77021. /**
  77022. * Defines the basic options interface of a Sprite Frame Source Size.
  77023. */
  77024. export interface ISpriteJSONSpriteSourceSize {
  77025. /**
  77026. * number of the original width of the Frame
  77027. */
  77028. w: number;
  77029. /**
  77030. * number of the original height of the Frame
  77031. */
  77032. h: number;
  77033. }
  77034. /**
  77035. * Defines the basic options interface of a Sprite Frame Data.
  77036. */
  77037. export interface ISpriteJSONSpriteFrameData {
  77038. /**
  77039. * number of the x offset of the Frame
  77040. */
  77041. x: number;
  77042. /**
  77043. * number of the y offset of the Frame
  77044. */
  77045. y: number;
  77046. /**
  77047. * number of the width of the Frame
  77048. */
  77049. w: number;
  77050. /**
  77051. * number of the height of the Frame
  77052. */
  77053. h: number;
  77054. }
  77055. /**
  77056. * Defines the basic options interface of a JSON Sprite.
  77057. */
  77058. export interface ISpriteJSONSprite {
  77059. /**
  77060. * string name of the Frame
  77061. */
  77062. filename: string;
  77063. /**
  77064. * ISpriteJSONSpriteFrame basic object of the frame data
  77065. */
  77066. frame: ISpriteJSONSpriteFrameData;
  77067. /**
  77068. * boolean to flag is the frame was rotated.
  77069. */
  77070. rotated: boolean;
  77071. /**
  77072. * boolean to flag is the frame was trimmed.
  77073. */
  77074. trimmed: boolean;
  77075. /**
  77076. * ISpriteJSONSpriteFrame basic object of the source data
  77077. */
  77078. spriteSourceSize: ISpriteJSONSpriteFrameData;
  77079. /**
  77080. * ISpriteJSONSpriteFrame basic object of the source data
  77081. */
  77082. sourceSize: ISpriteJSONSpriteSourceSize;
  77083. }
  77084. /**
  77085. * Defines the basic options interface of a JSON atlas.
  77086. */
  77087. export interface ISpriteJSONAtlas {
  77088. /**
  77089. * Array of objects that contain the frame data.
  77090. */
  77091. frames: Array<ISpriteJSONSprite>;
  77092. /**
  77093. * object basic object containing the sprite meta data.
  77094. */
  77095. meta?: object;
  77096. }
  77097. }
  77098. declare module "babylonjs/Shaders/spriteMap.fragment" {
  77099. /** @hidden */
  77100. export var spriteMapPixelShader: {
  77101. name: string;
  77102. shader: string;
  77103. };
  77104. }
  77105. declare module "babylonjs/Shaders/spriteMap.vertex" {
  77106. /** @hidden */
  77107. export var spriteMapVertexShader: {
  77108. name: string;
  77109. shader: string;
  77110. };
  77111. }
  77112. declare module "babylonjs/Sprites/spriteMap" {
  77113. import { IDisposable, Scene } from "babylonjs/scene";
  77114. import { Vector2, Vector3 } from "babylonjs/Maths/math.vector";
  77115. import { Texture } from "babylonjs/Materials/Textures/texture";
  77116. import { RawTexture } from "babylonjs/Materials/Textures/rawTexture";
  77117. import { ISpriteJSONSprite, ISpriteJSONAtlas } from "babylonjs/Sprites/ISprites";
  77118. import "babylonjs/Meshes/Builders/planeBuilder";
  77119. import "babylonjs/Shaders/spriteMap.fragment";
  77120. import "babylonjs/Shaders/spriteMap.vertex";
  77121. /**
  77122. * Defines the basic options interface of a SpriteMap
  77123. */
  77124. export interface ISpriteMapOptions {
  77125. /**
  77126. * Vector2 of the number of cells in the grid.
  77127. */
  77128. stageSize?: Vector2;
  77129. /**
  77130. * Vector2 of the size of the output plane in World Units.
  77131. */
  77132. outputSize?: Vector2;
  77133. /**
  77134. * Vector3 of the position of the output plane in World Units.
  77135. */
  77136. outputPosition?: Vector3;
  77137. /**
  77138. * Vector3 of the rotation of the output plane.
  77139. */
  77140. outputRotation?: Vector3;
  77141. /**
  77142. * number of layers that the system will reserve in resources.
  77143. */
  77144. layerCount?: number;
  77145. /**
  77146. * number of max animation frames a single cell will reserve in resources.
  77147. */
  77148. maxAnimationFrames?: number;
  77149. /**
  77150. * number cell index of the base tile when the system compiles.
  77151. */
  77152. baseTile?: number;
  77153. /**
  77154. * boolean flip the sprite after its been repositioned by the framing data.
  77155. */
  77156. flipU?: boolean;
  77157. /**
  77158. * Vector3 scalar of the global RGB values of the SpriteMap.
  77159. */
  77160. colorMultiply?: Vector3;
  77161. }
  77162. /**
  77163. * Defines the IDisposable interface in order to be cleanable from resources.
  77164. */
  77165. export interface ISpriteMap extends IDisposable {
  77166. /**
  77167. * String name of the SpriteMap.
  77168. */
  77169. name: string;
  77170. /**
  77171. * The JSON Array file from a https://www.codeandweb.com/texturepacker export. Or similar structure.
  77172. */
  77173. atlasJSON: ISpriteJSONAtlas;
  77174. /**
  77175. * Texture of the SpriteMap.
  77176. */
  77177. spriteSheet: Texture;
  77178. /**
  77179. * The parameters to initialize the SpriteMap with.
  77180. */
  77181. options: ISpriteMapOptions;
  77182. }
  77183. /**
  77184. * Class used to manage a grid restricted sprite deployment on an Output plane.
  77185. */
  77186. export class SpriteMap implements ISpriteMap {
  77187. /** The Name of the spriteMap */
  77188. name: string;
  77189. /** The JSON file with the frame and meta data */
  77190. atlasJSON: ISpriteJSONAtlas;
  77191. /** The systems Sprite Sheet Texture */
  77192. spriteSheet: Texture;
  77193. /** Arguments passed with the Constructor */
  77194. options: ISpriteMapOptions;
  77195. /** Public Sprite Storage array, parsed from atlasJSON */
  77196. sprites: Array<ISpriteJSONSprite>;
  77197. /** Returns the Number of Sprites in the System */
  77198. get spriteCount(): number;
  77199. /** Returns the Position of Output Plane*/
  77200. get position(): Vector3;
  77201. /** Returns the Position of Output Plane*/
  77202. set position(v: Vector3);
  77203. /** Returns the Rotation of Output Plane*/
  77204. get rotation(): Vector3;
  77205. /** Returns the Rotation of Output Plane*/
  77206. set rotation(v: Vector3);
  77207. /** Sets the AnimationMap*/
  77208. get animationMap(): RawTexture;
  77209. /** Sets the AnimationMap*/
  77210. set animationMap(v: RawTexture);
  77211. /** Scene that the SpriteMap was created in */
  77212. private _scene;
  77213. /** Texture Buffer of Float32 that holds tile frame data*/
  77214. private _frameMap;
  77215. /** Texture Buffers of Float32 that holds tileMap data*/
  77216. private _tileMaps;
  77217. /** Texture Buffer of Float32 that holds Animation Data*/
  77218. private _animationMap;
  77219. /** Custom ShaderMaterial Central to the System*/
  77220. private _material;
  77221. /** Custom ShaderMaterial Central to the System*/
  77222. private _output;
  77223. /** Systems Time Ticker*/
  77224. private _time;
  77225. /**
  77226. * Creates a new SpriteMap
  77227. * @param name defines the SpriteMaps Name
  77228. * @param atlasJSON is the JSON file that controls the Sprites Frames and Meta
  77229. * @param spriteSheet is the Texture that the Sprites are on.
  77230. * @param options a basic deployment configuration
  77231. * @param scene The Scene that the map is deployed on
  77232. */
  77233. constructor(name: string, atlasJSON: ISpriteJSONAtlas, spriteSheet: Texture, options: ISpriteMapOptions, scene: Scene);
  77234. /**
  77235. * Returns tileID location
  77236. * @returns Vector2 the cell position ID
  77237. */
  77238. getTileID(): Vector2;
  77239. /**
  77240. * Gets the UV location of the mouse over the SpriteMap.
  77241. * @returns Vector2 the UV position of the mouse interaction
  77242. */
  77243. getMousePosition(): Vector2;
  77244. /**
  77245. * Creates the "frame" texture Buffer
  77246. * -------------------------------------
  77247. * Structure of frames
  77248. * "filename": "Falling-Water-2.png",
  77249. * "frame": {"x":69,"y":103,"w":24,"h":32},
  77250. * "rotated": true,
  77251. * "trimmed": true,
  77252. * "spriteSourceSize": {"x":4,"y":0,"w":24,"h":32},
  77253. * "sourceSize": {"w":32,"h":32}
  77254. * @returns RawTexture of the frameMap
  77255. */
  77256. private _createFrameBuffer;
  77257. /**
  77258. * Creates the tileMap texture Buffer
  77259. * @param buffer normally and array of numbers, or a false to generate from scratch
  77260. * @param _layer indicates what layer for a logic trigger dealing with the baseTile. The system uses this
  77261. * @returns RawTexture of the tileMap
  77262. */
  77263. private _createTileBuffer;
  77264. /**
  77265. * Modifies the data of the tileMaps
  77266. * @param _layer is the ID of the layer you want to edit on the SpriteMap
  77267. * @param pos is the iVector2 Coordinates of the Tile
  77268. * @param tile The SpriteIndex of the new Tile
  77269. */
  77270. changeTiles(_layer: number | undefined, pos: Vector2 | Vector2[], tile?: number): void;
  77271. /**
  77272. * Creates the animationMap texture Buffer
  77273. * @param buffer normally and array of numbers, or a false to generate from scratch
  77274. * @returns RawTexture of the animationMap
  77275. */
  77276. private _createTileAnimationBuffer;
  77277. /**
  77278. * Modifies the data of the animationMap
  77279. * @param cellID is the Index of the Sprite
  77280. * @param _frame is the target Animation frame
  77281. * @param toCell is the Target Index of the next frame of the animation
  77282. * @param time is a value between 0-1 that is the trigger for when the frame should change tiles
  77283. * @param speed is a global scalar of the time variable on the map.
  77284. */
  77285. addAnimationToTile(cellID?: number, _frame?: number, toCell?: number, time?: number, speed?: number): void;
  77286. /**
  77287. * Exports the .tilemaps file
  77288. */
  77289. saveTileMaps(): void;
  77290. /**
  77291. * Imports the .tilemaps file
  77292. * @param url of the .tilemaps file
  77293. */
  77294. loadTileMaps(url: string): void;
  77295. /**
  77296. * Release associated resources
  77297. */
  77298. dispose(): void;
  77299. }
  77300. }
  77301. declare module "babylonjs/Sprites/spritePackedManager" {
  77302. import { SpriteManager } from "babylonjs/Sprites/spriteManager";
  77303. import { Scene } from "babylonjs/scene";
  77304. /**
  77305. * Class used to manage multiple sprites of different sizes on the same spritesheet
  77306. * @see https://doc.babylonjs.com/babylon101/sprites
  77307. */
  77308. export class SpritePackedManager extends SpriteManager {
  77309. /** defines the packed manager's name */
  77310. name: string;
  77311. /**
  77312. * Creates a new sprite manager from a packed sprite sheet
  77313. * @param name defines the manager's name
  77314. * @param imgUrl defines the sprite sheet url
  77315. * @param capacity defines the maximum allowed number of sprites
  77316. * @param scene defines the hosting scene
  77317. * @param spriteJSON null otherwise a JSON object defining sprite sheet data
  77318. * @param epsilon defines the epsilon value to align texture (0.01 by default)
  77319. * @param samplingMode defines the smapling mode to use with spritesheet
  77320. * @param fromPacked set to true; do not alter
  77321. */
  77322. constructor(
  77323. /** defines the packed manager's name */
  77324. name: string, imgUrl: string, capacity: number, scene: Scene, spriteJSON?: string | null, epsilon?: number, samplingMode?: number);
  77325. }
  77326. }
  77327. declare module "babylonjs/Sprites/index" {
  77328. export * from "babylonjs/Sprites/sprite";
  77329. export * from "babylonjs/Sprites/ISprites";
  77330. export * from "babylonjs/Sprites/spriteManager";
  77331. export * from "babylonjs/Sprites/spriteMap";
  77332. export * from "babylonjs/Sprites/spritePackedManager";
  77333. export * from "babylonjs/Sprites/spriteSceneComponent";
  77334. }
  77335. declare module "babylonjs/States/index" {
  77336. export * from "babylonjs/States/alphaCullingState";
  77337. export * from "babylonjs/States/depthCullingState";
  77338. export * from "babylonjs/States/stencilState";
  77339. }
  77340. declare module "babylonjs/Misc/assetsManager" {
  77341. import { Scene } from "babylonjs/scene";
  77342. import { AbstractMesh } from "babylonjs/Meshes/abstractMesh";
  77343. import { IParticleSystem } from "babylonjs/Particles/IParticleSystem";
  77344. import { Skeleton } from "babylonjs/Bones/skeleton";
  77345. import { Observable } from "babylonjs/Misc/observable";
  77346. import { BaseTexture } from "babylonjs/Materials/Textures/baseTexture";
  77347. import { Texture } from "babylonjs/Materials/Textures/texture";
  77348. import { CubeTexture } from "babylonjs/Materials/Textures/cubeTexture";
  77349. import { HDRCubeTexture } from "babylonjs/Materials/Textures/hdrCubeTexture";
  77350. import { EquiRectangularCubeTexture } from "babylonjs/Materials/Textures/equiRectangularCubeTexture";
  77351. import { AnimationGroup } from "babylonjs/Animations/animationGroup";
  77352. import { AssetContainer } from "babylonjs/assetContainer";
  77353. /**
  77354. * Defines the list of states available for a task inside a AssetsManager
  77355. */
  77356. export enum AssetTaskState {
  77357. /**
  77358. * Initialization
  77359. */
  77360. INIT = 0,
  77361. /**
  77362. * Running
  77363. */
  77364. RUNNING = 1,
  77365. /**
  77366. * Done
  77367. */
  77368. DONE = 2,
  77369. /**
  77370. * Error
  77371. */
  77372. ERROR = 3
  77373. }
  77374. /**
  77375. * Define an abstract asset task used with a AssetsManager class to load assets into a scene
  77376. */
  77377. export abstract class AbstractAssetTask {
  77378. /**
  77379. * Task name
  77380. */ name: string;
  77381. /**
  77382. * Callback called when the task is successful
  77383. */
  77384. onSuccess: (task: any) => void;
  77385. /**
  77386. * Callback called when the task is not successful
  77387. */
  77388. onError: (task: any, message?: string, exception?: any) => void;
  77389. /**
  77390. * Creates a new AssetsManager
  77391. * @param name defines the name of the task
  77392. */
  77393. constructor(
  77394. /**
  77395. * Task name
  77396. */ name: string);
  77397. private _isCompleted;
  77398. private _taskState;
  77399. private _errorObject;
  77400. /**
  77401. * Get if the task is completed
  77402. */
  77403. get isCompleted(): boolean;
  77404. /**
  77405. * Gets the current state of the task
  77406. */
  77407. get taskState(): AssetTaskState;
  77408. /**
  77409. * Gets the current error object (if task is in error)
  77410. */
  77411. get errorObject(): {
  77412. message?: string;
  77413. exception?: any;
  77414. };
  77415. /**
  77416. * Internal only
  77417. * @hidden
  77418. */
  77419. _setErrorObject(message?: string, exception?: any): void;
  77420. /**
  77421. * Execute the current task
  77422. * @param scene defines the scene where you want your assets to be loaded
  77423. * @param onSuccess is a callback called when the task is successfully executed
  77424. * @param onError is a callback called if an error occurs
  77425. */
  77426. run(scene: Scene, onSuccess: () => void, onError: (message?: string, exception?: any) => void): void;
  77427. /**
  77428. * Execute the current task
  77429. * @param scene defines the scene where you want your assets to be loaded
  77430. * @param onSuccess is a callback called when the task is successfully executed
  77431. * @param onError is a callback called if an error occurs
  77432. */
  77433. runTask(scene: Scene, onSuccess: () => void, onError: (message?: string, exception?: any) => void): void;
  77434. /**
  77435. * Reset will set the task state back to INIT, so the next load call of the assets manager will execute this task again.
  77436. * This can be used with failed tasks that have the reason for failure fixed.
  77437. */
  77438. reset(): void;
  77439. private onErrorCallback;
  77440. private onDoneCallback;
  77441. }
  77442. /**
  77443. * Define the interface used by progress events raised during assets loading
  77444. */
  77445. export interface IAssetsProgressEvent {
  77446. /**
  77447. * Defines the number of remaining tasks to process
  77448. */
  77449. remainingCount: number;
  77450. /**
  77451. * Defines the total number of tasks
  77452. */
  77453. totalCount: number;
  77454. /**
  77455. * Defines the task that was just processed
  77456. */
  77457. task: AbstractAssetTask;
  77458. }
  77459. /**
  77460. * Class used to share progress information about assets loading
  77461. */
  77462. export class AssetsProgressEvent implements IAssetsProgressEvent {
  77463. /**
  77464. * Defines the number of remaining tasks to process
  77465. */
  77466. remainingCount: number;
  77467. /**
  77468. * Defines the total number of tasks
  77469. */
  77470. totalCount: number;
  77471. /**
  77472. * Defines the task that was just processed
  77473. */
  77474. task: AbstractAssetTask;
  77475. /**
  77476. * Creates a AssetsProgressEvent
  77477. * @param remainingCount defines the number of remaining tasks to process
  77478. * @param totalCount defines the total number of tasks
  77479. * @param task defines the task that was just processed
  77480. */
  77481. constructor(remainingCount: number, totalCount: number, task: AbstractAssetTask);
  77482. }
  77483. /**
  77484. * Define a task used by AssetsManager to load assets into a container
  77485. */
  77486. export class ContainerAssetTask extends AbstractAssetTask {
  77487. /**
  77488. * Defines the name of the task
  77489. */
  77490. name: string;
  77491. /**
  77492. * Defines the list of mesh's names you want to load
  77493. */
  77494. meshesNames: any;
  77495. /**
  77496. * Defines the root url to use as a base to load your meshes and associated resources
  77497. */
  77498. rootUrl: string;
  77499. /**
  77500. * Defines the filename or File of the scene to load from
  77501. */
  77502. sceneFilename: string | File;
  77503. /**
  77504. * Get the loaded asset container
  77505. */
  77506. loadedContainer: AssetContainer;
  77507. /**
  77508. * Gets the list of loaded meshes
  77509. */
  77510. loadedMeshes: Array<AbstractMesh>;
  77511. /**
  77512. * Gets the list of loaded particle systems
  77513. */
  77514. loadedParticleSystems: Array<IParticleSystem>;
  77515. /**
  77516. * Gets the list of loaded skeletons
  77517. */
  77518. loadedSkeletons: Array<Skeleton>;
  77519. /**
  77520. * Gets the list of loaded animation groups
  77521. */
  77522. loadedAnimationGroups: Array<AnimationGroup>;
  77523. /**
  77524. * Callback called when the task is successful
  77525. */
  77526. onSuccess: (task: ContainerAssetTask) => void;
  77527. /**
  77528. * Callback called when the task is successful
  77529. */
  77530. onError: (task: ContainerAssetTask, message?: string, exception?: any) => void;
  77531. /**
  77532. * Creates a new ContainerAssetTask
  77533. * @param name defines the name of the task
  77534. * @param meshesNames defines the list of mesh's names you want to load
  77535. * @param rootUrl defines the root url to use as a base to load your meshes and associated resources
  77536. * @param sceneFilename defines the filename or File of the scene to load from
  77537. */
  77538. constructor(
  77539. /**
  77540. * Defines the name of the task
  77541. */
  77542. name: string,
  77543. /**
  77544. * Defines the list of mesh's names you want to load
  77545. */
  77546. meshesNames: any,
  77547. /**
  77548. * Defines the root url to use as a base to load your meshes and associated resources
  77549. */
  77550. rootUrl: string,
  77551. /**
  77552. * Defines the filename or File of the scene to load from
  77553. */
  77554. sceneFilename: string | File);
  77555. /**
  77556. * Execute the current task
  77557. * @param scene defines the scene where you want your assets to be loaded
  77558. * @param onSuccess is a callback called when the task is successfully executed
  77559. * @param onError is a callback called if an error occurs
  77560. */
  77561. runTask(scene: Scene, onSuccess: () => void, onError: (message?: string, exception?: any) => void): void;
  77562. }
  77563. /**
  77564. * Define a task used by AssetsManager to load meshes
  77565. */
  77566. export class MeshAssetTask extends AbstractAssetTask {
  77567. /**
  77568. * Defines the name of the task
  77569. */
  77570. name: string;
  77571. /**
  77572. * Defines the list of mesh's names you want to load
  77573. */
  77574. meshesNames: any;
  77575. /**
  77576. * Defines the root url to use as a base to load your meshes and associated resources
  77577. */
  77578. rootUrl: string;
  77579. /**
  77580. * Defines the filename or File of the scene to load from
  77581. */
  77582. sceneFilename: string | File;
  77583. /**
  77584. * Gets the list of loaded meshes
  77585. */
  77586. loadedMeshes: Array<AbstractMesh>;
  77587. /**
  77588. * Gets the list of loaded particle systems
  77589. */
  77590. loadedParticleSystems: Array<IParticleSystem>;
  77591. /**
  77592. * Gets the list of loaded skeletons
  77593. */
  77594. loadedSkeletons: Array<Skeleton>;
  77595. /**
  77596. * Gets the list of loaded animation groups
  77597. */
  77598. loadedAnimationGroups: Array<AnimationGroup>;
  77599. /**
  77600. * Callback called when the task is successful
  77601. */
  77602. onSuccess: (task: MeshAssetTask) => void;
  77603. /**
  77604. * Callback called when the task is successful
  77605. */
  77606. onError: (task: MeshAssetTask, message?: string, exception?: any) => void;
  77607. /**
  77608. * Creates a new MeshAssetTask
  77609. * @param name defines the name of the task
  77610. * @param meshesNames defines the list of mesh's names you want to load
  77611. * @param rootUrl defines the root url to use as a base to load your meshes and associated resources
  77612. * @param sceneFilename defines the filename or File of the scene to load from
  77613. */
  77614. constructor(
  77615. /**
  77616. * Defines the name of the task
  77617. */
  77618. name: string,
  77619. /**
  77620. * Defines the list of mesh's names you want to load
  77621. */
  77622. meshesNames: any,
  77623. /**
  77624. * Defines the root url to use as a base to load your meshes and associated resources
  77625. */
  77626. rootUrl: string,
  77627. /**
  77628. * Defines the filename or File of the scene to load from
  77629. */
  77630. sceneFilename: string | File);
  77631. /**
  77632. * Execute the current task
  77633. * @param scene defines the scene where you want your assets to be loaded
  77634. * @param onSuccess is a callback called when the task is successfully executed
  77635. * @param onError is a callback called if an error occurs
  77636. */
  77637. runTask(scene: Scene, onSuccess: () => void, onError: (message?: string, exception?: any) => void): void;
  77638. }
  77639. /**
  77640. * Define a task used by AssetsManager to load text content
  77641. */
  77642. export class TextFileAssetTask extends AbstractAssetTask {
  77643. /**
  77644. * Defines the name of the task
  77645. */
  77646. name: string;
  77647. /**
  77648. * Defines the location of the file to load
  77649. */
  77650. url: string;
  77651. /**
  77652. * Gets the loaded text string
  77653. */
  77654. text: string;
  77655. /**
  77656. * Callback called when the task is successful
  77657. */
  77658. onSuccess: (task: TextFileAssetTask) => void;
  77659. /**
  77660. * Callback called when the task is successful
  77661. */
  77662. onError: (task: TextFileAssetTask, message?: string, exception?: any) => void;
  77663. /**
  77664. * Creates a new TextFileAssetTask object
  77665. * @param name defines the name of the task
  77666. * @param url defines the location of the file to load
  77667. */
  77668. constructor(
  77669. /**
  77670. * Defines the name of the task
  77671. */
  77672. name: string,
  77673. /**
  77674. * Defines the location of the file to load
  77675. */
  77676. url: string);
  77677. /**
  77678. * Execute the current task
  77679. * @param scene defines the scene where you want your assets to be loaded
  77680. * @param onSuccess is a callback called when the task is successfully executed
  77681. * @param onError is a callback called if an error occurs
  77682. */
  77683. runTask(scene: Scene, onSuccess: () => void, onError: (message?: string, exception?: any) => void): void;
  77684. }
  77685. /**
  77686. * Define a task used by AssetsManager to load binary data
  77687. */
  77688. export class BinaryFileAssetTask extends AbstractAssetTask {
  77689. /**
  77690. * Defines the name of the task
  77691. */
  77692. name: string;
  77693. /**
  77694. * Defines the location of the file to load
  77695. */
  77696. url: string;
  77697. /**
  77698. * Gets the lodaded data (as an array buffer)
  77699. */
  77700. data: ArrayBuffer;
  77701. /**
  77702. * Callback called when the task is successful
  77703. */
  77704. onSuccess: (task: BinaryFileAssetTask) => void;
  77705. /**
  77706. * Callback called when the task is successful
  77707. */
  77708. onError: (task: BinaryFileAssetTask, message?: string, exception?: any) => void;
  77709. /**
  77710. * Creates a new BinaryFileAssetTask object
  77711. * @param name defines the name of the new task
  77712. * @param url defines the location of the file to load
  77713. */
  77714. constructor(
  77715. /**
  77716. * Defines the name of the task
  77717. */
  77718. name: string,
  77719. /**
  77720. * Defines the location of the file to load
  77721. */
  77722. url: string);
  77723. /**
  77724. * Execute the current task
  77725. * @param scene defines the scene where you want your assets to be loaded
  77726. * @param onSuccess is a callback called when the task is successfully executed
  77727. * @param onError is a callback called if an error occurs
  77728. */
  77729. runTask(scene: Scene, onSuccess: () => void, onError: (message?: string, exception?: any) => void): void;
  77730. }
  77731. /**
  77732. * Define a task used by AssetsManager to load images
  77733. */
  77734. export class ImageAssetTask extends AbstractAssetTask {
  77735. /**
  77736. * Defines the name of the task
  77737. */
  77738. name: string;
  77739. /**
  77740. * Defines the location of the image to load
  77741. */
  77742. url: string;
  77743. /**
  77744. * Gets the loaded images
  77745. */
  77746. image: HTMLImageElement;
  77747. /**
  77748. * Callback called when the task is successful
  77749. */
  77750. onSuccess: (task: ImageAssetTask) => void;
  77751. /**
  77752. * Callback called when the task is successful
  77753. */
  77754. onError: (task: ImageAssetTask, message?: string, exception?: any) => void;
  77755. /**
  77756. * Creates a new ImageAssetTask
  77757. * @param name defines the name of the task
  77758. * @param url defines the location of the image to load
  77759. */
  77760. constructor(
  77761. /**
  77762. * Defines the name of the task
  77763. */
  77764. name: string,
  77765. /**
  77766. * Defines the location of the image to load
  77767. */
  77768. url: string);
  77769. /**
  77770. * Execute the current task
  77771. * @param scene defines the scene where you want your assets to be loaded
  77772. * @param onSuccess is a callback called when the task is successfully executed
  77773. * @param onError is a callback called if an error occurs
  77774. */
  77775. runTask(scene: Scene, onSuccess: () => void, onError: (message?: string, exception?: any) => void): void;
  77776. }
  77777. /**
  77778. * Defines the interface used by texture loading tasks
  77779. */
  77780. export interface ITextureAssetTask<TEX extends BaseTexture> {
  77781. /**
  77782. * Gets the loaded texture
  77783. */
  77784. texture: TEX;
  77785. }
  77786. /**
  77787. * Define a task used by AssetsManager to load 2D textures
  77788. */
  77789. export class TextureAssetTask extends AbstractAssetTask implements ITextureAssetTask<Texture> {
  77790. /**
  77791. * Defines the name of the task
  77792. */
  77793. name: string;
  77794. /**
  77795. * Defines the location of the file to load
  77796. */
  77797. url: string;
  77798. /**
  77799. * Defines if mipmap should not be generated (default is false)
  77800. */
  77801. noMipmap?: boolean | undefined;
  77802. /**
  77803. * Defines if texture must be inverted on Y axis (default is true)
  77804. */
  77805. invertY: boolean;
  77806. /**
  77807. * Defines the sampling mode to use (default is Texture.TRILINEAR_SAMPLINGMODE)
  77808. */
  77809. samplingMode: number;
  77810. /**
  77811. * Gets the loaded texture
  77812. */
  77813. texture: Texture;
  77814. /**
  77815. * Callback called when the task is successful
  77816. */
  77817. onSuccess: (task: TextureAssetTask) => void;
  77818. /**
  77819. * Callback called when the task is successful
  77820. */
  77821. onError: (task: TextureAssetTask, message?: string, exception?: any) => void;
  77822. /**
  77823. * Creates a new TextureAssetTask object
  77824. * @param name defines the name of the task
  77825. * @param url defines the location of the file to load
  77826. * @param noMipmap defines if mipmap should not be generated (default is false)
  77827. * @param invertY defines if texture must be inverted on Y axis (default is true)
  77828. * @param samplingMode defines the sampling mode to use (default is Texture.TRILINEAR_SAMPLINGMODE)
  77829. */
  77830. constructor(
  77831. /**
  77832. * Defines the name of the task
  77833. */
  77834. name: string,
  77835. /**
  77836. * Defines the location of the file to load
  77837. */
  77838. url: string,
  77839. /**
  77840. * Defines if mipmap should not be generated (default is false)
  77841. */
  77842. noMipmap?: boolean | undefined,
  77843. /**
  77844. * Defines if texture must be inverted on Y axis (default is true)
  77845. */
  77846. invertY?: boolean,
  77847. /**
  77848. * Defines the sampling mode to use (default is Texture.TRILINEAR_SAMPLINGMODE)
  77849. */
  77850. samplingMode?: number);
  77851. /**
  77852. * Execute the current task
  77853. * @param scene defines the scene where you want your assets to be loaded
  77854. * @param onSuccess is a callback called when the task is successfully executed
  77855. * @param onError is a callback called if an error occurs
  77856. */
  77857. runTask(scene: Scene, onSuccess: () => void, onError: (message?: string, exception?: any) => void): void;
  77858. }
  77859. /**
  77860. * Define a task used by AssetsManager to load cube textures
  77861. */
  77862. export class CubeTextureAssetTask extends AbstractAssetTask implements ITextureAssetTask<CubeTexture> {
  77863. /**
  77864. * Defines the name of the task
  77865. */
  77866. name: string;
  77867. /**
  77868. * Defines the location of the files to load (You have to specify the folder where the files are + filename with no extension)
  77869. */
  77870. url: string;
  77871. /**
  77872. * Defines the extensions to use to load files (["_px", "_py", "_pz", "_nx", "_ny", "_nz"] by default)
  77873. */
  77874. extensions?: string[] | undefined;
  77875. /**
  77876. * Defines if mipmaps should not be generated (default is false)
  77877. */
  77878. noMipmap?: boolean | undefined;
  77879. /**
  77880. * Defines the explicit list of files (undefined by default)
  77881. */
  77882. files?: string[] | undefined;
  77883. /**
  77884. * Gets the loaded texture
  77885. */
  77886. texture: CubeTexture;
  77887. /**
  77888. * Callback called when the task is successful
  77889. */
  77890. onSuccess: (task: CubeTextureAssetTask) => void;
  77891. /**
  77892. * Callback called when the task is successful
  77893. */
  77894. onError: (task: CubeTextureAssetTask, message?: string, exception?: any) => void;
  77895. /**
  77896. * Creates a new CubeTextureAssetTask
  77897. * @param name defines the name of the task
  77898. * @param url defines the location of the files to load (You have to specify the folder where the files are + filename with no extension)
  77899. * @param extensions defines the extensions to use to load files (["_px", "_py", "_pz", "_nx", "_ny", "_nz"] by default)
  77900. * @param noMipmap defines if mipmaps should not be generated (default is false)
  77901. * @param files defines the explicit list of files (undefined by default)
  77902. */
  77903. constructor(
  77904. /**
  77905. * Defines the name of the task
  77906. */
  77907. name: string,
  77908. /**
  77909. * Defines the location of the files to load (You have to specify the folder where the files are + filename with no extension)
  77910. */
  77911. url: string,
  77912. /**
  77913. * Defines the extensions to use to load files (["_px", "_py", "_pz", "_nx", "_ny", "_nz"] by default)
  77914. */
  77915. extensions?: string[] | undefined,
  77916. /**
  77917. * Defines if mipmaps should not be generated (default is false)
  77918. */
  77919. noMipmap?: boolean | undefined,
  77920. /**
  77921. * Defines the explicit list of files (undefined by default)
  77922. */
  77923. files?: string[] | undefined);
  77924. /**
  77925. * Execute the current task
  77926. * @param scene defines the scene where you want your assets to be loaded
  77927. * @param onSuccess is a callback called when the task is successfully executed
  77928. * @param onError is a callback called if an error occurs
  77929. */
  77930. runTask(scene: Scene, onSuccess: () => void, onError: (message?: string, exception?: any) => void): void;
  77931. }
  77932. /**
  77933. * Define a task used by AssetsManager to load HDR cube textures
  77934. */
  77935. export class HDRCubeTextureAssetTask extends AbstractAssetTask implements ITextureAssetTask<HDRCubeTexture> {
  77936. /**
  77937. * Defines the name of the task
  77938. */
  77939. name: string;
  77940. /**
  77941. * Defines the location of the file to load
  77942. */
  77943. url: string;
  77944. /**
  77945. * Defines the desired size (the more it increases the longer the generation will be)
  77946. */
  77947. size: number;
  77948. /**
  77949. * Defines if mipmaps should not be generated (default is false)
  77950. */
  77951. noMipmap: boolean;
  77952. /**
  77953. * Specifies whether you want to extract the polynomial harmonics during the generation process (default is true)
  77954. */
  77955. generateHarmonics: boolean;
  77956. /**
  77957. * 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)
  77958. */
  77959. gammaSpace: boolean;
  77960. /**
  77961. * Internal Use Only
  77962. */
  77963. reserved: boolean;
  77964. /**
  77965. * Gets the loaded texture
  77966. */
  77967. texture: HDRCubeTexture;
  77968. /**
  77969. * Callback called when the task is successful
  77970. */
  77971. onSuccess: (task: HDRCubeTextureAssetTask) => void;
  77972. /**
  77973. * Callback called when the task is successful
  77974. */
  77975. onError: (task: HDRCubeTextureAssetTask, message?: string, exception?: any) => void;
  77976. /**
  77977. * Creates a new HDRCubeTextureAssetTask object
  77978. * @param name defines the name of the task
  77979. * @param url defines the location of the file to load
  77980. * @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.
  77981. * @param noMipmap defines if mipmaps should not be generated (default is false)
  77982. * @param generateHarmonics specifies whether you want to extract the polynomial harmonics during the generation process (default is true)
  77983. * @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)
  77984. * @param reserved Internal use only
  77985. */
  77986. constructor(
  77987. /**
  77988. * Defines the name of the task
  77989. */
  77990. name: string,
  77991. /**
  77992. * Defines the location of the file to load
  77993. */
  77994. url: string,
  77995. /**
  77996. * Defines the desired size (the more it increases the longer the generation will be)
  77997. */
  77998. size: number,
  77999. /**
  78000. * Defines if mipmaps should not be generated (default is false)
  78001. */
  78002. noMipmap?: boolean,
  78003. /**
  78004. * Specifies whether you want to extract the polynomial harmonics during the generation process (default is true)
  78005. */
  78006. generateHarmonics?: boolean,
  78007. /**
  78008. * 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)
  78009. */
  78010. gammaSpace?: boolean,
  78011. /**
  78012. * Internal Use Only
  78013. */
  78014. reserved?: boolean);
  78015. /**
  78016. * Execute the current task
  78017. * @param scene defines the scene where you want your assets to be loaded
  78018. * @param onSuccess is a callback called when the task is successfully executed
  78019. * @param onError is a callback called if an error occurs
  78020. */
  78021. runTask(scene: Scene, onSuccess: () => void, onError: (message?: string, exception?: any) => void): void;
  78022. }
  78023. /**
  78024. * Define a task used by AssetsManager to load Equirectangular cube textures
  78025. */
  78026. export class EquiRectangularCubeTextureAssetTask extends AbstractAssetTask implements ITextureAssetTask<EquiRectangularCubeTexture> {
  78027. /**
  78028. * Defines the name of the task
  78029. */
  78030. name: string;
  78031. /**
  78032. * Defines the location of the file to load
  78033. */
  78034. url: string;
  78035. /**
  78036. * Defines the desired size (the more it increases the longer the generation will be)
  78037. */
  78038. size: number;
  78039. /**
  78040. * Defines if mipmaps should not be generated (default is false)
  78041. */
  78042. noMipmap: boolean;
  78043. /**
  78044. * Specifies if the texture will be use in gamma or linear space (the PBR material requires those texture in linear space,
  78045. * but the standard material would require them in Gamma space) (default is true)
  78046. */
  78047. gammaSpace: boolean;
  78048. /**
  78049. * Gets the loaded texture
  78050. */
  78051. texture: EquiRectangularCubeTexture;
  78052. /**
  78053. * Callback called when the task is successful
  78054. */
  78055. onSuccess: (task: EquiRectangularCubeTextureAssetTask) => void;
  78056. /**
  78057. * Callback called when the task is successful
  78058. */
  78059. onError: (task: EquiRectangularCubeTextureAssetTask, message?: string, exception?: any) => void;
  78060. /**
  78061. * Creates a new EquiRectangularCubeTextureAssetTask object
  78062. * @param name defines the name of the task
  78063. * @param url defines the location of the file to load
  78064. * @param size defines the desired size (the more it increases the longer the generation will be)
  78065. * If the size is omitted this implies you are using a preprocessed cubemap.
  78066. * @param noMipmap defines if mipmaps should not be generated (default is false)
  78067. * @param gammaSpace specifies if the texture will be used in gamma or linear space
  78068. * (the PBR material requires those texture in linear space, but the standard material would require them in Gamma space)
  78069. * (default is true)
  78070. */
  78071. constructor(
  78072. /**
  78073. * Defines the name of the task
  78074. */
  78075. name: string,
  78076. /**
  78077. * Defines the location of the file to load
  78078. */
  78079. url: string,
  78080. /**
  78081. * Defines the desired size (the more it increases the longer the generation will be)
  78082. */
  78083. size: number,
  78084. /**
  78085. * Defines if mipmaps should not be generated (default is false)
  78086. */
  78087. noMipmap?: boolean,
  78088. /**
  78089. * Specifies if the texture will be use in gamma or linear space (the PBR material requires those texture in linear space,
  78090. * but the standard material would require them in Gamma space) (default is true)
  78091. */
  78092. gammaSpace?: boolean);
  78093. /**
  78094. * Execute the current task
  78095. * @param scene defines the scene where you want your assets to be loaded
  78096. * @param onSuccess is a callback called when the task is successfully executed
  78097. * @param onError is a callback called if an error occurs
  78098. */
  78099. runTask(scene: Scene, onSuccess: () => void, onError: (message?: string, exception?: any) => void): void;
  78100. }
  78101. /**
  78102. * This class can be used to easily import assets into a scene
  78103. * @see https://doc.babylonjs.com/how_to/how_to_use_assetsmanager
  78104. */
  78105. export class AssetsManager {
  78106. private _scene;
  78107. private _isLoading;
  78108. protected _tasks: AbstractAssetTask[];
  78109. protected _waitingTasksCount: number;
  78110. protected _totalTasksCount: number;
  78111. /**
  78112. * Callback called when all tasks are processed
  78113. */
  78114. onFinish: (tasks: AbstractAssetTask[]) => void;
  78115. /**
  78116. * Callback called when a task is successful
  78117. */
  78118. onTaskSuccess: (task: AbstractAssetTask) => void;
  78119. /**
  78120. * Callback called when a task had an error
  78121. */
  78122. onTaskError: (task: AbstractAssetTask) => void;
  78123. /**
  78124. * Callback called when a task is done (whatever the result is)
  78125. */
  78126. onProgress: (remainingCount: number, totalCount: number, task: AbstractAssetTask) => void;
  78127. /**
  78128. * Observable called when all tasks are processed
  78129. */
  78130. onTaskSuccessObservable: Observable<AbstractAssetTask>;
  78131. /**
  78132. * Observable called when a task had an error
  78133. */
  78134. onTaskErrorObservable: Observable<AbstractAssetTask>;
  78135. /**
  78136. * Observable called when all tasks were executed
  78137. */
  78138. onTasksDoneObservable: Observable<AbstractAssetTask[]>;
  78139. /**
  78140. * Observable called when a task is done (whatever the result is)
  78141. */
  78142. onProgressObservable: Observable<IAssetsProgressEvent>;
  78143. /**
  78144. * Gets or sets a boolean defining if the AssetsManager should use the default loading screen
  78145. * @see https://doc.babylonjs.com/how_to/creating_a_custom_loading_screen
  78146. */
  78147. useDefaultLoadingScreen: boolean;
  78148. /**
  78149. * Gets or sets a boolean defining if the AssetsManager should automatically hide the loading screen
  78150. * when all assets have been downloaded.
  78151. * If set to false, you need to manually call in hideLoadingUI() once your scene is ready.
  78152. */
  78153. autoHideLoadingUI: boolean;
  78154. /**
  78155. * Creates a new AssetsManager
  78156. * @param scene defines the scene to work on
  78157. */
  78158. constructor(scene: Scene);
  78159. /**
  78160. * Add a ContainerAssetTask to the list of active tasks
  78161. * @param taskName defines the name of the new task
  78162. * @param meshesNames defines the name of meshes to load
  78163. * @param rootUrl defines the root url to use to locate files
  78164. * @param sceneFilename defines the filename of the scene file
  78165. * @returns a new ContainerAssetTask object
  78166. */
  78167. addContainerTask(taskName: string, meshesNames: any, rootUrl: string, sceneFilename: string): ContainerAssetTask;
  78168. /**
  78169. * Add a MeshAssetTask to the list of active tasks
  78170. * @param taskName defines the name of the new task
  78171. * @param meshesNames defines the name of meshes to load
  78172. * @param rootUrl defines the root url to use to locate files
  78173. * @param sceneFilename defines the filename of the scene file
  78174. * @returns a new MeshAssetTask object
  78175. */
  78176. addMeshTask(taskName: string, meshesNames: any, rootUrl: string, sceneFilename: string): MeshAssetTask;
  78177. /**
  78178. * Add a TextFileAssetTask to the list of active tasks
  78179. * @param taskName defines the name of the new task
  78180. * @param url defines the url of the file to load
  78181. * @returns a new TextFileAssetTask object
  78182. */
  78183. addTextFileTask(taskName: string, url: string): TextFileAssetTask;
  78184. /**
  78185. * Add a BinaryFileAssetTask to the list of active tasks
  78186. * @param taskName defines the name of the new task
  78187. * @param url defines the url of the file to load
  78188. * @returns a new BinaryFileAssetTask object
  78189. */
  78190. addBinaryFileTask(taskName: string, url: string): BinaryFileAssetTask;
  78191. /**
  78192. * Add a ImageAssetTask to the list of active tasks
  78193. * @param taskName defines the name of the new task
  78194. * @param url defines the url of the file to load
  78195. * @returns a new ImageAssetTask object
  78196. */
  78197. addImageTask(taskName: string, url: string): ImageAssetTask;
  78198. /**
  78199. * Add a TextureAssetTask to the list of active tasks
  78200. * @param taskName defines the name of the new task
  78201. * @param url defines the url of the file to load
  78202. * @param noMipmap defines if the texture must not receive mipmaps (false by default)
  78203. * @param invertY defines if you want to invert Y axis of the loaded texture (false by default)
  78204. * @param samplingMode defines the sampling mode to use (Texture.TRILINEAR_SAMPLINGMODE by default)
  78205. * @returns a new TextureAssetTask object
  78206. */
  78207. addTextureTask(taskName: string, url: string, noMipmap?: boolean, invertY?: boolean, samplingMode?: number): TextureAssetTask;
  78208. /**
  78209. * Add a CubeTextureAssetTask to the list of active tasks
  78210. * @param taskName defines the name of the new task
  78211. * @param url defines the url of the file to load
  78212. * @param extensions defines the extension to use to load the cube map (can be null)
  78213. * @param noMipmap defines if the texture must not receive mipmaps (false by default)
  78214. * @param files defines the list of files to load (can be null)
  78215. * @returns a new CubeTextureAssetTask object
  78216. */
  78217. addCubeTextureTask(taskName: string, url: string, extensions?: string[], noMipmap?: boolean, files?: string[]): CubeTextureAssetTask;
  78218. /**
  78219. *
  78220. * Add a HDRCubeTextureAssetTask to the list of active tasks
  78221. * @param taskName defines the name of the new task
  78222. * @param url defines the url of the file to load
  78223. * @param size defines the size you want for the cubemap (can be null)
  78224. * @param noMipmap defines if the texture must not receive mipmaps (false by default)
  78225. * @param generateHarmonics defines if you want to automatically generate (true by default)
  78226. * @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)
  78227. * @param reserved Internal use only
  78228. * @returns a new HDRCubeTextureAssetTask object
  78229. */
  78230. addHDRCubeTextureTask(taskName: string, url: string, size: number, noMipmap?: boolean, generateHarmonics?: boolean, gammaSpace?: boolean, reserved?: boolean): HDRCubeTextureAssetTask;
  78231. /**
  78232. *
  78233. * Add a EquiRectangularCubeTextureAssetTask to the list of active tasks
  78234. * @param taskName defines the name of the new task
  78235. * @param url defines the url of the file to load
  78236. * @param size defines the size you want for the cubemap (can be null)
  78237. * @param noMipmap defines if the texture must not receive mipmaps (false by default)
  78238. * @param gammaSpace Specifies if the texture will be used in gamma or linear space
  78239. * (the PBR material requires those textures in linear space, but the standard material would require them in Gamma space)
  78240. * @returns a new EquiRectangularCubeTextureAssetTask object
  78241. */
  78242. addEquiRectangularCubeTextureAssetTask(taskName: string, url: string, size: number, noMipmap?: boolean, gammaSpace?: boolean): EquiRectangularCubeTextureAssetTask;
  78243. /**
  78244. * Remove a task from the assets manager.
  78245. * @param task the task to remove
  78246. */
  78247. removeTask(task: AbstractAssetTask): void;
  78248. private _decreaseWaitingTasksCount;
  78249. private _runTask;
  78250. /**
  78251. * Reset the AssetsManager and remove all tasks
  78252. * @return the current instance of the AssetsManager
  78253. */
  78254. reset(): AssetsManager;
  78255. /**
  78256. * Start the loading process
  78257. * @return the current instance of the AssetsManager
  78258. */
  78259. load(): AssetsManager;
  78260. /**
  78261. * Start the loading process as an async operation
  78262. * @return a promise returning the list of failed tasks
  78263. */
  78264. loadAsync(): Promise<void>;
  78265. }
  78266. }
  78267. declare module "babylonjs/Misc/deferred" {
  78268. /**
  78269. * Wrapper class for promise with external resolve and reject.
  78270. */
  78271. export class Deferred<T> {
  78272. /**
  78273. * The promise associated with this deferred object.
  78274. */
  78275. readonly promise: Promise<T>;
  78276. private _resolve;
  78277. private _reject;
  78278. /**
  78279. * The resolve method of the promise associated with this deferred object.
  78280. */
  78281. get resolve(): (value?: T | PromiseLike<T> | undefined) => void;
  78282. /**
  78283. * The reject method of the promise associated with this deferred object.
  78284. */
  78285. get reject(): (reason?: any) => void;
  78286. /**
  78287. * Constructor for this deferred object.
  78288. */
  78289. constructor();
  78290. }
  78291. }
  78292. declare module "babylonjs/Misc/meshExploder" {
  78293. import { Mesh } from "babylonjs/Meshes/mesh";
  78294. /**
  78295. * Class used to explode meshes (ie. to have a center and move them away from that center to better see the overall organization)
  78296. */
  78297. export class MeshExploder {
  78298. private _centerMesh;
  78299. private _meshes;
  78300. private _meshesOrigins;
  78301. private _toCenterVectors;
  78302. private _scaledDirection;
  78303. private _newPosition;
  78304. private _centerPosition;
  78305. /**
  78306. * Explodes meshes from a center mesh.
  78307. * @param meshes The meshes to explode.
  78308. * @param centerMesh The mesh to be center of explosion.
  78309. */
  78310. constructor(meshes: Array<Mesh>, centerMesh?: Mesh);
  78311. private _setCenterMesh;
  78312. /**
  78313. * Get class name
  78314. * @returns "MeshExploder"
  78315. */
  78316. getClassName(): string;
  78317. /**
  78318. * "Exploded meshes"
  78319. * @returns Array of meshes with the centerMesh at index 0.
  78320. */
  78321. getMeshes(): Array<Mesh>;
  78322. /**
  78323. * Explodes meshes giving a specific direction
  78324. * @param direction Number to multiply distance of each mesh's origin from center. Use a negative number to implode, or zero to reset.
  78325. */
  78326. explode(direction?: number): void;
  78327. }
  78328. }
  78329. declare module "babylonjs/Misc/filesInput" {
  78330. import { Engine } from "babylonjs/Engines/engine";
  78331. import { Scene } from "babylonjs/scene";
  78332. import { ISceneLoaderProgressEvent } from "babylonjs/Loading/sceneLoader";
  78333. import { Nullable } from "babylonjs/types";
  78334. /**
  78335. * Class used to help managing file picking and drag'n'drop
  78336. */
  78337. export class FilesInput {
  78338. /**
  78339. * List of files ready to be loaded
  78340. */
  78341. static get FilesToLoad(): {
  78342. [key: string]: File;
  78343. };
  78344. /**
  78345. * Callback called when a file is processed
  78346. */
  78347. onProcessFileCallback: (file: File, name: string, extension: string) => boolean;
  78348. private _engine;
  78349. private _currentScene;
  78350. private _sceneLoadedCallback;
  78351. private _progressCallback;
  78352. private _additionalRenderLoopLogicCallback;
  78353. private _textureLoadingCallback;
  78354. private _startingProcessingFilesCallback;
  78355. private _onReloadCallback;
  78356. private _errorCallback;
  78357. private _elementToMonitor;
  78358. private _sceneFileToLoad;
  78359. private _filesToLoad;
  78360. /**
  78361. * Creates a new FilesInput
  78362. * @param engine defines the rendering engine
  78363. * @param scene defines the hosting scene
  78364. * @param sceneLoadedCallback callback called when scene is loaded
  78365. * @param progressCallback callback called to track progress
  78366. * @param additionalRenderLoopLogicCallback callback called to add user logic to the rendering loop
  78367. * @param textureLoadingCallback callback called when a texture is loading
  78368. * @param startingProcessingFilesCallback callback called when the system is about to process all files
  78369. * @param onReloadCallback callback called when a reload is requested
  78370. * @param errorCallback callback call if an error occurs
  78371. */
  78372. 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>);
  78373. private _dragEnterHandler;
  78374. private _dragOverHandler;
  78375. private _dropHandler;
  78376. /**
  78377. * Calls this function to listen to drag'n'drop events on a specific DOM element
  78378. * @param elementToMonitor defines the DOM element to track
  78379. */
  78380. monitorElementForDragNDrop(elementToMonitor: HTMLElement): void;
  78381. /** Gets the current list of files to load */
  78382. get filesToLoad(): File[];
  78383. /**
  78384. * Release all associated resources
  78385. */
  78386. dispose(): void;
  78387. private renderFunction;
  78388. private drag;
  78389. private drop;
  78390. private _traverseFolder;
  78391. private _processFiles;
  78392. /**
  78393. * Load files from a drop event
  78394. * @param event defines the drop event to use as source
  78395. */
  78396. loadFiles(event: any): void;
  78397. private _processReload;
  78398. /**
  78399. * Reload the current scene from the loaded files
  78400. */
  78401. reload(): void;
  78402. }
  78403. }
  78404. declare module "babylonjs/Misc/HighDynamicRange/index" {
  78405. export * from "babylonjs/Misc/HighDynamicRange/cubemapToSphericalPolynomial";
  78406. export * from "babylonjs/Misc/HighDynamicRange/hdr";
  78407. export * from "babylonjs/Misc/HighDynamicRange/panoramaToCubemap";
  78408. }
  78409. declare module "babylonjs/Misc/sceneOptimizer" {
  78410. import { Scene, IDisposable } from "babylonjs/scene";
  78411. import { Observable } from "babylonjs/Misc/observable";
  78412. /**
  78413. * Defines the root class used to create scene optimization to use with SceneOptimizer
  78414. * @description More details at https://doc.babylonjs.com/how_to/how_to_use_sceneoptimizer
  78415. */
  78416. export class SceneOptimization {
  78417. /**
  78418. * Defines the priority of this optimization (0 by default which means first in the list)
  78419. */
  78420. priority: number;
  78421. /**
  78422. * Gets a string describing the action executed by the current optimization
  78423. * @returns description string
  78424. */
  78425. getDescription(): string;
  78426. /**
  78427. * This function will be called by the SceneOptimizer when its priority is reached in order to apply the change required by the current optimization
  78428. * @param scene defines the current scene where to apply this optimization
  78429. * @param optimizer defines the current optimizer
  78430. * @returns true if everything that can be done was applied
  78431. */
  78432. apply(scene: Scene, optimizer: SceneOptimizer): boolean;
  78433. /**
  78434. * Creates the SceneOptimization object
  78435. * @param priority defines the priority of this optimization (0 by default which means first in the list)
  78436. * @param desc defines the description associated with the optimization
  78437. */
  78438. constructor(
  78439. /**
  78440. * Defines the priority of this optimization (0 by default which means first in the list)
  78441. */
  78442. priority?: number);
  78443. }
  78444. /**
  78445. * Defines an optimization used to reduce the size of render target textures
  78446. * @description More details at https://doc.babylonjs.com/how_to/how_to_use_sceneoptimizer
  78447. */
  78448. export class TextureOptimization extends SceneOptimization {
  78449. /**
  78450. * Defines the priority of this optimization (0 by default which means first in the list)
  78451. */
  78452. priority: number;
  78453. /**
  78454. * 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
  78455. */
  78456. maximumSize: number;
  78457. /**
  78458. * Defines the factor (0.5 by default) used to scale down textures bigger than maximum sized allowed.
  78459. */
  78460. step: number;
  78461. /**
  78462. * Gets a string describing the action executed by the current optimization
  78463. * @returns description string
  78464. */
  78465. getDescription(): string;
  78466. /**
  78467. * Creates the TextureOptimization object
  78468. * @param priority defines the priority of this optimization (0 by default which means first in the list)
  78469. * @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
  78470. * @param step defines the factor (0.5 by default) used to scale down textures bigger than maximum sized allowed.
  78471. */
  78472. constructor(
  78473. /**
  78474. * Defines the priority of this optimization (0 by default which means first in the list)
  78475. */
  78476. priority?: number,
  78477. /**
  78478. * 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
  78479. */
  78480. maximumSize?: number,
  78481. /**
  78482. * Defines the factor (0.5 by default) used to scale down textures bigger than maximum sized allowed.
  78483. */
  78484. step?: number);
  78485. /**
  78486. * This function will be called by the SceneOptimizer when its priority is reached in order to apply the change required by the current optimization
  78487. * @param scene defines the current scene where to apply this optimization
  78488. * @param optimizer defines the current optimizer
  78489. * @returns true if everything that can be done was applied
  78490. */
  78491. apply(scene: Scene, optimizer: SceneOptimizer): boolean;
  78492. }
  78493. /**
  78494. * Defines an optimization used to increase or decrease the rendering resolution
  78495. * @description More details at https://doc.babylonjs.com/how_to/how_to_use_sceneoptimizer
  78496. */
  78497. export class HardwareScalingOptimization extends SceneOptimization {
  78498. /**
  78499. * Defines the priority of this optimization (0 by default which means first in the list)
  78500. */
  78501. priority: number;
  78502. /**
  78503. * Defines the maximum scale to use (2 by default)
  78504. */
  78505. maximumScale: number;
  78506. /**
  78507. * Defines the step to use between two passes (0.5 by default)
  78508. */
  78509. step: number;
  78510. private _currentScale;
  78511. private _directionOffset;
  78512. /**
  78513. * Gets a string describing the action executed by the current optimization
  78514. * @return description string
  78515. */
  78516. getDescription(): string;
  78517. /**
  78518. * Creates the HardwareScalingOptimization object
  78519. * @param priority defines the priority of this optimization (0 by default which means first in the list)
  78520. * @param maximumScale defines the maximum scale to use (2 by default)
  78521. * @param step defines the step to use between two passes (0.5 by default)
  78522. */
  78523. constructor(
  78524. /**
  78525. * Defines the priority of this optimization (0 by default which means first in the list)
  78526. */
  78527. priority?: number,
  78528. /**
  78529. * Defines the maximum scale to use (2 by default)
  78530. */
  78531. maximumScale?: number,
  78532. /**
  78533. * Defines the step to use between two passes (0.5 by default)
  78534. */
  78535. step?: number);
  78536. /**
  78537. * This function will be called by the SceneOptimizer when its priority is reached in order to apply the change required by the current optimization
  78538. * @param scene defines the current scene where to apply this optimization
  78539. * @param optimizer defines the current optimizer
  78540. * @returns true if everything that can be done was applied
  78541. */
  78542. apply(scene: Scene, optimizer: SceneOptimizer): boolean;
  78543. }
  78544. /**
  78545. * Defines an optimization used to remove shadows
  78546. * @description More details at https://doc.babylonjs.com/how_to/how_to_use_sceneoptimizer
  78547. */
  78548. export class ShadowsOptimization extends SceneOptimization {
  78549. /**
  78550. * Gets a string describing the action executed by the current optimization
  78551. * @return description string
  78552. */
  78553. getDescription(): string;
  78554. /**
  78555. * This function will be called by the SceneOptimizer when its priority is reached in order to apply the change required by the current optimization
  78556. * @param scene defines the current scene where to apply this optimization
  78557. * @param optimizer defines the current optimizer
  78558. * @returns true if everything that can be done was applied
  78559. */
  78560. apply(scene: Scene, optimizer: SceneOptimizer): boolean;
  78561. }
  78562. /**
  78563. * Defines an optimization used to turn post-processes off
  78564. * @description More details at https://doc.babylonjs.com/how_to/how_to_use_sceneoptimizer
  78565. */
  78566. export class PostProcessesOptimization extends SceneOptimization {
  78567. /**
  78568. * Gets a string describing the action executed by the current optimization
  78569. * @return description string
  78570. */
  78571. getDescription(): string;
  78572. /**
  78573. * This function will be called by the SceneOptimizer when its priority is reached in order to apply the change required by the current optimization
  78574. * @param scene defines the current scene where to apply this optimization
  78575. * @param optimizer defines the current optimizer
  78576. * @returns true if everything that can be done was applied
  78577. */
  78578. apply(scene: Scene, optimizer: SceneOptimizer): boolean;
  78579. }
  78580. /**
  78581. * Defines an optimization used to turn lens flares off
  78582. * @description More details at https://doc.babylonjs.com/how_to/how_to_use_sceneoptimizer
  78583. */
  78584. export class LensFlaresOptimization extends SceneOptimization {
  78585. /**
  78586. * Gets a string describing the action executed by the current optimization
  78587. * @return description string
  78588. */
  78589. getDescription(): string;
  78590. /**
  78591. * This function will be called by the SceneOptimizer when its priority is reached in order to apply the change required by the current optimization
  78592. * @param scene defines the current scene where to apply this optimization
  78593. * @param optimizer defines the current optimizer
  78594. * @returns true if everything that can be done was applied
  78595. */
  78596. apply(scene: Scene, optimizer: SceneOptimizer): boolean;
  78597. }
  78598. /**
  78599. * Defines an optimization based on user defined callback.
  78600. * @description More details at https://doc.babylonjs.com/how_to/how_to_use_sceneoptimizer
  78601. */
  78602. export class CustomOptimization extends SceneOptimization {
  78603. /**
  78604. * Callback called to apply the custom optimization.
  78605. */
  78606. onApply: (scene: Scene, optimizer: SceneOptimizer) => boolean;
  78607. /**
  78608. * Callback called to get custom description
  78609. */
  78610. onGetDescription: () => string;
  78611. /**
  78612. * Gets a string describing the action executed by the current optimization
  78613. * @returns description string
  78614. */
  78615. getDescription(): string;
  78616. /**
  78617. * This function will be called by the SceneOptimizer when its priority is reached in order to apply the change required by the current optimization
  78618. * @param scene defines the current scene where to apply this optimization
  78619. * @param optimizer defines the current optimizer
  78620. * @returns true if everything that can be done was applied
  78621. */
  78622. apply(scene: Scene, optimizer: SceneOptimizer): boolean;
  78623. }
  78624. /**
  78625. * Defines an optimization used to turn particles off
  78626. * @description More details at https://doc.babylonjs.com/how_to/how_to_use_sceneoptimizer
  78627. */
  78628. export class ParticlesOptimization extends SceneOptimization {
  78629. /**
  78630. * Gets a string describing the action executed by the current optimization
  78631. * @return description string
  78632. */
  78633. getDescription(): string;
  78634. /**
  78635. * This function will be called by the SceneOptimizer when its priority is reached in order to apply the change required by the current optimization
  78636. * @param scene defines the current scene where to apply this optimization
  78637. * @param optimizer defines the current optimizer
  78638. * @returns true if everything that can be done was applied
  78639. */
  78640. apply(scene: Scene, optimizer: SceneOptimizer): boolean;
  78641. }
  78642. /**
  78643. * Defines an optimization used to turn render targets off
  78644. * @description More details at https://doc.babylonjs.com/how_to/how_to_use_sceneoptimizer
  78645. */
  78646. export class RenderTargetsOptimization extends SceneOptimization {
  78647. /**
  78648. * Gets a string describing the action executed by the current optimization
  78649. * @return description string
  78650. */
  78651. getDescription(): string;
  78652. /**
  78653. * This function will be called by the SceneOptimizer when its priority is reached in order to apply the change required by the current optimization
  78654. * @param scene defines the current scene where to apply this optimization
  78655. * @param optimizer defines the current optimizer
  78656. * @returns true if everything that can be done was applied
  78657. */
  78658. apply(scene: Scene, optimizer: SceneOptimizer): boolean;
  78659. }
  78660. /**
  78661. * Defines an optimization used to merge meshes with compatible materials
  78662. * @description More details at https://doc.babylonjs.com/how_to/how_to_use_sceneoptimizer
  78663. */
  78664. export class MergeMeshesOptimization extends SceneOptimization {
  78665. private static _UpdateSelectionTree;
  78666. /**
  78667. * Gets or sets a boolean which defines if optimization octree has to be updated
  78668. */
  78669. static get UpdateSelectionTree(): boolean;
  78670. /**
  78671. * Gets or sets a boolean which defines if optimization octree has to be updated
  78672. */
  78673. static set UpdateSelectionTree(value: boolean);
  78674. /**
  78675. * Gets a string describing the action executed by the current optimization
  78676. * @return description string
  78677. */
  78678. getDescription(): string;
  78679. private _canBeMerged;
  78680. /**
  78681. * This function will be called by the SceneOptimizer when its priority is reached in order to apply the change required by the current optimization
  78682. * @param scene defines the current scene where to apply this optimization
  78683. * @param optimizer defines the current optimizer
  78684. * @param updateSelectionTree defines that the selection octree has to be updated (false by default)
  78685. * @returns true if everything that can be done was applied
  78686. */
  78687. apply(scene: Scene, optimizer: SceneOptimizer, updateSelectionTree?: boolean): boolean;
  78688. }
  78689. /**
  78690. * Defines a list of options used by SceneOptimizer
  78691. * @description More details at https://doc.babylonjs.com/how_to/how_to_use_sceneoptimizer
  78692. */
  78693. export class SceneOptimizerOptions {
  78694. /**
  78695. * Defines the target frame rate to reach (60 by default)
  78696. */
  78697. targetFrameRate: number;
  78698. /**
  78699. * Defines the interval between two checkes (2000ms by default)
  78700. */
  78701. trackerDuration: number;
  78702. /**
  78703. * Gets the list of optimizations to apply
  78704. */
  78705. optimizations: SceneOptimization[];
  78706. /**
  78707. * Creates a new list of options used by SceneOptimizer
  78708. * @param targetFrameRate defines the target frame rate to reach (60 by default)
  78709. * @param trackerDuration defines the interval between two checkes (2000ms by default)
  78710. */
  78711. constructor(
  78712. /**
  78713. * Defines the target frame rate to reach (60 by default)
  78714. */
  78715. targetFrameRate?: number,
  78716. /**
  78717. * Defines the interval between two checkes (2000ms by default)
  78718. */
  78719. trackerDuration?: number);
  78720. /**
  78721. * Add a new optimization
  78722. * @param optimization defines the SceneOptimization to add to the list of active optimizations
  78723. * @returns the current SceneOptimizerOptions
  78724. */
  78725. addOptimization(optimization: SceneOptimization): SceneOptimizerOptions;
  78726. /**
  78727. * Add a new custom optimization
  78728. * @param onApply defines the callback called to apply the custom optimization (true if everything that can be done was applied)
  78729. * @param onGetDescription defines the callback called to get the description attached with the optimization.
  78730. * @param priority defines the priority of this optimization (0 by default which means first in the list)
  78731. * @returns the current SceneOptimizerOptions
  78732. */
  78733. addCustomOptimization(onApply: (scene: Scene) => boolean, onGetDescription: () => string, priority?: number): SceneOptimizerOptions;
  78734. /**
  78735. * Creates a list of pre-defined optimizations aimed to reduce the visual impact on the scene
  78736. * @param targetFrameRate defines the target frame rate (60 by default)
  78737. * @returns a SceneOptimizerOptions object
  78738. */
  78739. static LowDegradationAllowed(targetFrameRate?: number): SceneOptimizerOptions;
  78740. /**
  78741. * Creates a list of pre-defined optimizations aimed to have a moderate impact on the scene visual
  78742. * @param targetFrameRate defines the target frame rate (60 by default)
  78743. * @returns a SceneOptimizerOptions object
  78744. */
  78745. static ModerateDegradationAllowed(targetFrameRate?: number): SceneOptimizerOptions;
  78746. /**
  78747. * Creates a list of pre-defined optimizations aimed to have a big impact on the scene visual
  78748. * @param targetFrameRate defines the target frame rate (60 by default)
  78749. * @returns a SceneOptimizerOptions object
  78750. */
  78751. static HighDegradationAllowed(targetFrameRate?: number): SceneOptimizerOptions;
  78752. }
  78753. /**
  78754. * Class used to run optimizations in order to reach a target frame rate
  78755. * @description More details at https://doc.babylonjs.com/how_to/how_to_use_sceneoptimizer
  78756. */
  78757. export class SceneOptimizer implements IDisposable {
  78758. private _isRunning;
  78759. private _options;
  78760. private _scene;
  78761. private _currentPriorityLevel;
  78762. private _targetFrameRate;
  78763. private _trackerDuration;
  78764. private _currentFrameRate;
  78765. private _sceneDisposeObserver;
  78766. private _improvementMode;
  78767. /**
  78768. * Defines an observable called when the optimizer reaches the target frame rate
  78769. */
  78770. onSuccessObservable: Observable<SceneOptimizer>;
  78771. /**
  78772. * Defines an observable called when the optimizer enables an optimization
  78773. */
  78774. onNewOptimizationAppliedObservable: Observable<SceneOptimization>;
  78775. /**
  78776. * Defines an observable called when the optimizer is not able to reach the target frame rate
  78777. */
  78778. onFailureObservable: Observable<SceneOptimizer>;
  78779. /**
  78780. * Gets a boolean indicating if the optimizer is in improvement mode
  78781. */
  78782. get isInImprovementMode(): boolean;
  78783. /**
  78784. * Gets the current priority level (0 at start)
  78785. */
  78786. get currentPriorityLevel(): number;
  78787. /**
  78788. * Gets the current frame rate checked by the SceneOptimizer
  78789. */
  78790. get currentFrameRate(): number;
  78791. /**
  78792. * Gets or sets the current target frame rate (60 by default)
  78793. */
  78794. get targetFrameRate(): number;
  78795. /**
  78796. * Gets or sets the current target frame rate (60 by default)
  78797. */
  78798. set targetFrameRate(value: number);
  78799. /**
  78800. * Gets or sets the current interval between two checks (every 2000ms by default)
  78801. */
  78802. get trackerDuration(): number;
  78803. /**
  78804. * Gets or sets the current interval between two checks (every 2000ms by default)
  78805. */
  78806. set trackerDuration(value: number);
  78807. /**
  78808. * Gets the list of active optimizations
  78809. */
  78810. get optimizations(): SceneOptimization[];
  78811. /**
  78812. * Creates a new SceneOptimizer
  78813. * @param scene defines the scene to work on
  78814. * @param options defines the options to use with the SceneOptimizer
  78815. * @param autoGeneratePriorities defines if priorities must be generated and not read from SceneOptimization property (true by default)
  78816. * @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)
  78817. */
  78818. constructor(scene: Scene, options?: SceneOptimizerOptions, autoGeneratePriorities?: boolean, improvementMode?: boolean);
  78819. /**
  78820. * Stops the current optimizer
  78821. */
  78822. stop(): void;
  78823. /**
  78824. * Reset the optimizer to initial step (current priority level = 0)
  78825. */
  78826. reset(): void;
  78827. /**
  78828. * Start the optimizer. By default it will try to reach a specific framerate
  78829. * but if the optimizer is set with improvementMode === true then it will run all optimiatiation while frame rate is above the target frame rate
  78830. */
  78831. start(): void;
  78832. private _checkCurrentState;
  78833. /**
  78834. * Release all resources
  78835. */
  78836. dispose(): void;
  78837. /**
  78838. * Helper function to create a SceneOptimizer with one single line of code
  78839. * @param scene defines the scene to work on
  78840. * @param options defines the options to use with the SceneOptimizer
  78841. * @param onSuccess defines a callback to call on success
  78842. * @param onFailure defines a callback to call on failure
  78843. * @returns the new SceneOptimizer object
  78844. */
  78845. static OptimizeAsync(scene: Scene, options?: SceneOptimizerOptions, onSuccess?: () => void, onFailure?: () => void): SceneOptimizer;
  78846. }
  78847. }
  78848. declare module "babylonjs/Misc/sceneSerializer" {
  78849. import { Scene } from "babylonjs/scene";
  78850. /**
  78851. * Class used to serialize a scene into a string
  78852. */
  78853. export class SceneSerializer {
  78854. /**
  78855. * Clear cache used by a previous serialization
  78856. */
  78857. static ClearCache(): void;
  78858. /**
  78859. * Serialize a scene into a JSON compatible object
  78860. * @param scene defines the scene to serialize
  78861. * @returns a JSON compatible object
  78862. */
  78863. static Serialize(scene: Scene): any;
  78864. /**
  78865. * Serialize a mesh into a JSON compatible object
  78866. * @param toSerialize defines the mesh to serialize
  78867. * @param withParents defines if parents must be serialized as well
  78868. * @param withChildren defines if children must be serialized as well
  78869. * @returns a JSON compatible object
  78870. */
  78871. static SerializeMesh(toSerialize: any, withParents?: boolean, withChildren?: boolean): any;
  78872. }
  78873. }
  78874. declare module "babylonjs/Misc/textureTools" {
  78875. import { Texture } from "babylonjs/Materials/Textures/texture";
  78876. /**
  78877. * Class used to host texture specific utilities
  78878. */
  78879. export class TextureTools {
  78880. /**
  78881. * Uses the GPU to create a copy texture rescaled at a given size
  78882. * @param texture Texture to copy from
  78883. * @param width defines the desired width
  78884. * @param height defines the desired height
  78885. * @param useBilinearMode defines if bilinear mode has to be used
  78886. * @return the generated texture
  78887. */
  78888. static CreateResizedCopy(texture: Texture, width: number, height: number, useBilinearMode?: boolean): Texture;
  78889. }
  78890. }
  78891. declare module "babylonjs/Misc/videoRecorder" {
  78892. import { Nullable } from "babylonjs/types";
  78893. import { Engine } from "babylonjs/Engines/engine";
  78894. /**
  78895. * This represents the different options available for the video capture.
  78896. */
  78897. export interface VideoRecorderOptions {
  78898. /** Defines the mime type of the video. */
  78899. mimeType: string;
  78900. /** Defines the FPS the video should be recorded at. */
  78901. fps: number;
  78902. /** Defines the chunk size for the recording data. */
  78903. recordChunckSize: number;
  78904. /** The audio tracks to attach to the recording. */
  78905. audioTracks?: MediaStreamTrack[];
  78906. }
  78907. /**
  78908. * This can help with recording videos from BabylonJS.
  78909. * This is based on the available WebRTC functionalities of the browser.
  78910. *
  78911. * @see https://doc.babylonjs.com/how_to/render_scene_on_a_video
  78912. */
  78913. export class VideoRecorder {
  78914. private static readonly _defaultOptions;
  78915. /**
  78916. * Returns whether or not the VideoRecorder is available in your browser.
  78917. * @param engine Defines the Babylon Engine.
  78918. * @returns true if supported otherwise false.
  78919. */
  78920. static IsSupported(engine: Engine): boolean;
  78921. private readonly _options;
  78922. private _canvas;
  78923. private _mediaRecorder;
  78924. private _recordedChunks;
  78925. private _fileName;
  78926. private _resolve;
  78927. private _reject;
  78928. /**
  78929. * True when a recording is already in progress.
  78930. */
  78931. get isRecording(): boolean;
  78932. /**
  78933. * Create a new VideoCapture object which can help converting what you see in Babylon to a video file.
  78934. * @param engine Defines the BabylonJS Engine you wish to record.
  78935. * @param options Defines options that can be used to customize the capture.
  78936. */
  78937. constructor(engine: Engine, options?: Nullable<VideoRecorderOptions>);
  78938. /**
  78939. * Stops the current recording before the default capture timeout passed in the startRecording function.
  78940. */
  78941. stopRecording(): void;
  78942. /**
  78943. * Starts recording the canvas for a max duration specified in parameters.
  78944. * @param fileName Defines the name of the file to be downloaded when the recording stop.
  78945. * If null no automatic download will start and you can rely on the promise to get the data back.
  78946. * @param maxDuration Defines the maximum recording time in seconds.
  78947. * It defaults to 7 seconds. A value of zero will not stop automatically, you would need to call stopRecording manually.
  78948. * @return A promise callback at the end of the recording with the video data in Blob.
  78949. */
  78950. startRecording(fileName?: Nullable<string>, maxDuration?: number): Promise<Blob>;
  78951. /**
  78952. * Releases internal resources used during the recording.
  78953. */
  78954. dispose(): void;
  78955. private _handleDataAvailable;
  78956. private _handleError;
  78957. private _handleStop;
  78958. }
  78959. }
  78960. declare module "babylonjs/Misc/screenshotTools" {
  78961. import { Camera } from "babylonjs/Cameras/camera";
  78962. import { IScreenshotSize } from "babylonjs/Misc/interfaces/screenshotSize";
  78963. import { Engine } from "babylonjs/Engines/engine";
  78964. /**
  78965. * Class containing a set of static utilities functions for screenshots
  78966. */
  78967. export class ScreenshotTools {
  78968. /**
  78969. * Captures a screenshot of the current rendering
  78970. * @see https://doc.babylonjs.com/how_to/render_scene_on_a_png
  78971. * @param engine defines the rendering engine
  78972. * @param camera defines the source camera
  78973. * @param size This parameter can be set to a single number or to an object with the
  78974. * following (optional) properties: precision, width, height. If a single number is passed,
  78975. * it will be used for both width and height. If an object is passed, the screenshot size
  78976. * will be derived from the parameters. The precision property is a multiplier allowing
  78977. * rendering at a higher or lower resolution
  78978. * @param successCallback defines the callback receives a single parameter which contains the
  78979. * screenshot as a string of base64-encoded characters. This string can be assigned to the
  78980. * src parameter of an <img> to display it
  78981. * @param mimeType defines the MIME type of the screenshot image (default: image/png).
  78982. * Check your browser for supported MIME types
  78983. */
  78984. static CreateScreenshot(engine: Engine, camera: Camera, size: IScreenshotSize | number, successCallback?: (data: string) => void, mimeType?: string): void;
  78985. /**
  78986. * Captures a screenshot of the current rendering
  78987. * @see https://doc.babylonjs.com/how_to/render_scene_on_a_png
  78988. * @param engine defines the rendering engine
  78989. * @param camera defines the source camera
  78990. * @param size This parameter can be set to a single number or to an object with the
  78991. * following (optional) properties: precision, width, height. If a single number is passed,
  78992. * it will be used for both width and height. If an object is passed, the screenshot size
  78993. * will be derived from the parameters. The precision property is a multiplier allowing
  78994. * rendering at a higher or lower resolution
  78995. * @param mimeType defines the MIME type of the screenshot image (default: image/png).
  78996. * Check your browser for supported MIME types
  78997. * @returns screenshot as a string of base64-encoded characters. This string can be assigned
  78998. * to the src parameter of an <img> to display it
  78999. */
  79000. static CreateScreenshotAsync(engine: Engine, camera: Camera, size: any, mimeType?: string): Promise<string>;
  79001. /**
  79002. * Generates an image screenshot from the specified camera.
  79003. * @see https://doc.babylonjs.com/how_to/render_scene_on_a_png
  79004. * @param engine The engine to use for rendering
  79005. * @param camera The camera to use for rendering
  79006. * @param size This parameter can be set to a single number or to an object with the
  79007. * following (optional) properties: precision, width, height. If a single number is passed,
  79008. * it will be used for both width and height. If an object is passed, the screenshot size
  79009. * will be derived from the parameters. The precision property is a multiplier allowing
  79010. * rendering at a higher or lower resolution
  79011. * @param successCallback The callback receives a single parameter which contains the
  79012. * screenshot as a string of base64-encoded characters. This string can be assigned to the
  79013. * src parameter of an <img> to display it
  79014. * @param mimeType The MIME type of the screenshot image (default: image/png).
  79015. * Check your browser for supported MIME types
  79016. * @param samples Texture samples (default: 1)
  79017. * @param antialiasing Whether antialiasing should be turned on or not (default: false)
  79018. * @param fileName A name for for the downloaded file.
  79019. * @param renderSprites Whether the sprites should be rendered or not (default: false)
  79020. * @param enableStencilBuffer Whether the stencil buffer should be enabled or not (default: false)
  79021. */
  79022. 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;
  79023. /**
  79024. * Generates an image screenshot from the specified camera.
  79025. * @see https://doc.babylonjs.com/how_to/render_scene_on_a_png
  79026. * @param engine The engine to use for rendering
  79027. * @param camera The camera to use for rendering
  79028. * @param size This parameter can be set to a single number or to an object with the
  79029. * following (optional) properties: precision, width, height. If a single number is passed,
  79030. * it will be used for both width and height. If an object is passed, the screenshot size
  79031. * will be derived from the parameters. The precision property is a multiplier allowing
  79032. * rendering at a higher or lower resolution
  79033. * @param mimeType The MIME type of the screenshot image (default: image/png).
  79034. * Check your browser for supported MIME types
  79035. * @param samples Texture samples (default: 1)
  79036. * @param antialiasing Whether antialiasing should be turned on or not (default: false)
  79037. * @param fileName A name for for the downloaded file.
  79038. * @param renderSprites Whether the sprites should be rendered or not (default: false)
  79039. * @returns screenshot as a string of base64-encoded characters. This string can be assigned
  79040. * to the src parameter of an <img> to display it
  79041. */
  79042. static CreateScreenshotUsingRenderTargetAsync(engine: Engine, camera: Camera, size: any, mimeType?: string, samples?: number, antialiasing?: boolean, fileName?: string, renderSprites?: boolean): Promise<string>;
  79043. /**
  79044. * Gets height and width for screenshot size
  79045. * @private
  79046. */
  79047. private static _getScreenshotSize;
  79048. }
  79049. }
  79050. declare module "babylonjs/Misc/dataReader" {
  79051. /**
  79052. * Interface for a data buffer
  79053. */
  79054. export interface IDataBuffer {
  79055. /**
  79056. * Reads bytes from the data buffer.
  79057. * @param byteOffset The byte offset to read
  79058. * @param byteLength The byte length to read
  79059. * @returns A promise that resolves when the bytes are read
  79060. */
  79061. readAsync(byteOffset: number, byteLength: number): Promise<ArrayBufferView>;
  79062. /**
  79063. * The byte length of the buffer.
  79064. */
  79065. readonly byteLength: number;
  79066. }
  79067. /**
  79068. * Utility class for reading from a data buffer
  79069. */
  79070. export class DataReader {
  79071. /**
  79072. * The data buffer associated with this data reader.
  79073. */
  79074. readonly buffer: IDataBuffer;
  79075. /**
  79076. * The current byte offset from the beginning of the data buffer.
  79077. */
  79078. byteOffset: number;
  79079. private _dataView;
  79080. private _dataByteOffset;
  79081. /**
  79082. * Constructor
  79083. * @param buffer The buffer to read
  79084. */
  79085. constructor(buffer: IDataBuffer);
  79086. /**
  79087. * Loads the given byte length.
  79088. * @param byteLength The byte length to load
  79089. * @returns A promise that resolves when the load is complete
  79090. */
  79091. loadAsync(byteLength: number): Promise<void>;
  79092. /**
  79093. * Read a unsigned 32-bit integer from the currently loaded data range.
  79094. * @returns The 32-bit integer read
  79095. */
  79096. readUint32(): number;
  79097. /**
  79098. * Read a byte array from the currently loaded data range.
  79099. * @param byteLength The byte length to read
  79100. * @returns The byte array read
  79101. */
  79102. readUint8Array(byteLength: number): Uint8Array;
  79103. /**
  79104. * Read a string from the currently loaded data range.
  79105. * @param byteLength The byte length to read
  79106. * @returns The string read
  79107. */
  79108. readString(byteLength: number): string;
  79109. /**
  79110. * Skips the given byte length the currently loaded data range.
  79111. * @param byteLength The byte length to skip
  79112. */
  79113. skipBytes(byteLength: number): void;
  79114. }
  79115. }
  79116. declare module "babylonjs/Misc/dataStorage" {
  79117. /**
  79118. * Class for storing data to local storage if available or in-memory storage otherwise
  79119. */
  79120. export class DataStorage {
  79121. private static _Storage;
  79122. private static _GetStorage;
  79123. /**
  79124. * Reads a string from the data storage
  79125. * @param key The key to read
  79126. * @param defaultValue The value if the key doesn't exist
  79127. * @returns The string value
  79128. */
  79129. static ReadString(key: string, defaultValue: string): string;
  79130. /**
  79131. * Writes a string to the data storage
  79132. * @param key The key to write
  79133. * @param value The value to write
  79134. */
  79135. static WriteString(key: string, value: string): void;
  79136. /**
  79137. * Reads a boolean from the data storage
  79138. * @param key The key to read
  79139. * @param defaultValue The value if the key doesn't exist
  79140. * @returns The boolean value
  79141. */
  79142. static ReadBoolean(key: string, defaultValue: boolean): boolean;
  79143. /**
  79144. * Writes a boolean to the data storage
  79145. * @param key The key to write
  79146. * @param value The value to write
  79147. */
  79148. static WriteBoolean(key: string, value: boolean): void;
  79149. /**
  79150. * Reads a number from the data storage
  79151. * @param key The key to read
  79152. * @param defaultValue The value if the key doesn't exist
  79153. * @returns The number value
  79154. */
  79155. static ReadNumber(key: string, defaultValue: number): number;
  79156. /**
  79157. * Writes a number to the data storage
  79158. * @param key The key to write
  79159. * @param value The value to write
  79160. */
  79161. static WriteNumber(key: string, value: number): void;
  79162. }
  79163. }
  79164. declare module "babylonjs/Misc/sceneRecorder" {
  79165. import { Scene } from "babylonjs/scene";
  79166. /**
  79167. * Class used to record delta files between 2 scene states
  79168. */
  79169. export class SceneRecorder {
  79170. private _trackedScene;
  79171. private _savedJSON;
  79172. /**
  79173. * Track a given scene. This means the current scene state will be considered the original state
  79174. * @param scene defines the scene to track
  79175. */
  79176. track(scene: Scene): void;
  79177. /**
  79178. * Get the delta between current state and original state
  79179. * @returns a string containing the delta
  79180. */
  79181. getDelta(): any;
  79182. private _compareArray;
  79183. private _compareObjects;
  79184. private _compareCollections;
  79185. private static GetShadowGeneratorById;
  79186. /**
  79187. * Apply a given delta to a given scene
  79188. * @param deltaJSON defines the JSON containing the delta
  79189. * @param scene defines the scene to apply the delta to
  79190. */
  79191. static ApplyDelta(deltaJSON: any | string, scene: Scene): void;
  79192. private static _ApplyPropertiesToEntity;
  79193. private static _ApplyDeltaForEntity;
  79194. }
  79195. }
  79196. declare module "babylonjs/Misc/trajectoryClassifier" {
  79197. import { DeepImmutable, Nullable } from "babylonjs/types";
  79198. import { Vector3 } from "babylonjs/Maths/math.vector";
  79199. /**
  79200. * A 3D trajectory consisting of an order list of vectors describing a
  79201. * path of motion through 3D space.
  79202. */
  79203. export class Trajectory {
  79204. private _points;
  79205. private readonly _segmentLength;
  79206. /**
  79207. * Serialize to JSON.
  79208. * @returns serialized JSON string
  79209. */
  79210. serialize(): string;
  79211. /**
  79212. * Deserialize from JSON.
  79213. * @param json serialized JSON string
  79214. * @returns deserialized Trajectory
  79215. */
  79216. static Deserialize(json: string): Trajectory;
  79217. /**
  79218. * Create a new empty Trajectory.
  79219. * @param segmentLength radius of discretization for Trajectory points
  79220. */
  79221. constructor(segmentLength?: number);
  79222. /**
  79223. * Get the length of the Trajectory.
  79224. * @returns length of the Trajectory
  79225. */
  79226. getLength(): number;
  79227. /**
  79228. * Append a new point to the Trajectory.
  79229. * NOTE: This implementation has many allocations.
  79230. * @param point point to append to the Trajectory
  79231. */
  79232. add(point: DeepImmutable<Vector3>): void;
  79233. /**
  79234. * Create a new Trajectory with a segment length chosen to make it
  79235. * probable that the new Trajectory will have a specified number of
  79236. * segments. This operation is imprecise.
  79237. * @param targetResolution number of segments desired
  79238. * @returns new Trajectory with approximately the requested number of segments
  79239. */
  79240. resampleAtTargetResolution(targetResolution: number): Trajectory;
  79241. /**
  79242. * Convert Trajectory segments into tokenized representation. This
  79243. * representation is an array of numbers where each nth number is the
  79244. * index of the token which is most similar to the nth segment of the
  79245. * Trajectory.
  79246. * @param tokens list of vectors which serve as discrete tokens
  79247. * @returns list of indices of most similar token per segment
  79248. */
  79249. tokenize(tokens: DeepImmutable<Vector3[]>): number[];
  79250. private static _forwardDir;
  79251. private static _inverseFromVec;
  79252. private static _upDir;
  79253. private static _fromToVec;
  79254. private static _lookMatrix;
  79255. /**
  79256. * Transform the rotation (i.e., direction) of a segment to isolate
  79257. * the relative transformation represented by the segment. This operation
  79258. * may or may not succeed due to singularities in the equations that define
  79259. * motion relativity in this context.
  79260. * @param priorVec the origin of the prior segment
  79261. * @param fromVec the origin of the current segment
  79262. * @param toVec the destination of the current segment
  79263. * @param result reference to output variable
  79264. * @returns whether or not transformation was successful
  79265. */
  79266. private static _transformSegmentDirToRef;
  79267. private static _bestMatch;
  79268. private static _score;
  79269. private static _bestScore;
  79270. /**
  79271. * Determine which token vector is most similar to the
  79272. * segment vector.
  79273. * @param segment segment vector
  79274. * @param tokens token vector list
  79275. * @returns index of the most similar token to the segment
  79276. */
  79277. private static _tokenizeSegment;
  79278. }
  79279. /**
  79280. * Class representing a set of known, named trajectories to which Trajectories can be
  79281. * added and using which Trajectories can be recognized.
  79282. */
  79283. export class TrajectoryClassifier {
  79284. private _maximumAllowableMatchCost;
  79285. private _vector3Alphabet;
  79286. private _levenshteinAlphabet;
  79287. private _nameToDescribedTrajectory;
  79288. /**
  79289. * Serialize to JSON.
  79290. * @returns JSON serialization
  79291. */
  79292. serialize(): string;
  79293. /**
  79294. * Deserialize from JSON.
  79295. * @param json JSON serialization
  79296. * @returns deserialized TrajectorySet
  79297. */
  79298. static Deserialize(json: string): TrajectoryClassifier;
  79299. /**
  79300. * Initialize a new empty TrajectorySet with auto-generated Alphabets.
  79301. * VERY naive, need to be generating these things from known
  79302. * sets. Better version later, probably eliminating this one.
  79303. * @returns auto-generated TrajectorySet
  79304. */
  79305. static Generate(): TrajectoryClassifier;
  79306. private constructor();
  79307. /**
  79308. * Add a new Trajectory to the set with a given name.
  79309. * @param trajectory new Trajectory to be added
  79310. * @param classification name to which to add the Trajectory
  79311. */
  79312. addTrajectoryToClassification(trajectory: Trajectory, classification: string): void;
  79313. /**
  79314. * Remove a known named trajectory and all Trajectories associated with it.
  79315. * @param classification name to remove
  79316. * @returns whether anything was removed
  79317. */
  79318. deleteClassification(classification: string): boolean;
  79319. /**
  79320. * Attempt to recognize a Trajectory from among all the classifications
  79321. * already known to the classifier.
  79322. * @param trajectory Trajectory to be recognized
  79323. * @returns classification of Trajectory if recognized, null otherwise
  79324. */
  79325. classifyTrajectory(trajectory: Trajectory): Nullable<string>;
  79326. }
  79327. }
  79328. declare module "babylonjs/Misc/index" {
  79329. export * from "babylonjs/Misc/andOrNotEvaluator";
  79330. export * from "babylonjs/Misc/assetsManager";
  79331. export * from "babylonjs/Misc/basis";
  79332. export * from "babylonjs/Misc/dds";
  79333. export * from "babylonjs/Misc/decorators";
  79334. export * from "babylonjs/Misc/deferred";
  79335. export * from "babylonjs/Misc/environmentTextureTools";
  79336. export * from "babylonjs/Misc/meshExploder";
  79337. export * from "babylonjs/Misc/filesInput";
  79338. export * from "babylonjs/Misc/HighDynamicRange/index";
  79339. export * from "babylonjs/Misc/khronosTextureContainer";
  79340. export * from "babylonjs/Misc/observable";
  79341. export * from "babylonjs/Misc/performanceMonitor";
  79342. export * from "babylonjs/Misc/promise";
  79343. export * from "babylonjs/Misc/sceneOptimizer";
  79344. export * from "babylonjs/Misc/sceneSerializer";
  79345. export * from "babylonjs/Misc/smartArray";
  79346. export * from "babylonjs/Misc/stringDictionary";
  79347. export * from "babylonjs/Misc/tags";
  79348. export * from "babylonjs/Misc/textureTools";
  79349. export * from "babylonjs/Misc/tga";
  79350. export * from "babylonjs/Misc/tools";
  79351. export * from "babylonjs/Misc/videoRecorder";
  79352. export * from "babylonjs/Misc/virtualJoystick";
  79353. export * from "babylonjs/Misc/workerPool";
  79354. export * from "babylonjs/Misc/logger";
  79355. export * from "babylonjs/Misc/typeStore";
  79356. export * from "babylonjs/Misc/filesInputStore";
  79357. export * from "babylonjs/Misc/deepCopier";
  79358. export * from "babylonjs/Misc/pivotTools";
  79359. export * from "babylonjs/Misc/precisionDate";
  79360. export * from "babylonjs/Misc/screenshotTools";
  79361. export * from "babylonjs/Misc/typeStore";
  79362. export * from "babylonjs/Misc/webRequest";
  79363. export * from "babylonjs/Misc/iInspectable";
  79364. export * from "babylonjs/Misc/brdfTextureTools";
  79365. export * from "babylonjs/Misc/rgbdTextureTools";
  79366. export * from "babylonjs/Misc/gradients";
  79367. export * from "babylonjs/Misc/perfCounter";
  79368. export * from "babylonjs/Misc/fileRequest";
  79369. export * from "babylonjs/Misc/customAnimationFrameRequester";
  79370. export * from "babylonjs/Misc/retryStrategy";
  79371. export * from "babylonjs/Misc/interfaces/screenshotSize";
  79372. export * from "babylonjs/Misc/canvasGenerator";
  79373. export * from "babylonjs/Misc/fileTools";
  79374. export * from "babylonjs/Misc/stringTools";
  79375. export * from "babylonjs/Misc/dataReader";
  79376. export * from "babylonjs/Misc/minMaxReducer";
  79377. export * from "babylonjs/Misc/depthReducer";
  79378. export * from "babylonjs/Misc/dataStorage";
  79379. export * from "babylonjs/Misc/sceneRecorder";
  79380. export * from "babylonjs/Misc/khronosTextureContainer2";
  79381. export * from "babylonjs/Misc/trajectoryClassifier";
  79382. export * from "babylonjs/Misc/timer";
  79383. }
  79384. declare module "babylonjs/XR/features/WebXRHitTestLegacy" {
  79385. import { IWebXRFeature } from "babylonjs/XR/webXRFeaturesManager";
  79386. import { WebXRSessionManager } from "babylonjs/XR/webXRSessionManager";
  79387. import { Observable } from "babylonjs/Misc/observable";
  79388. import { Matrix } from "babylonjs/Maths/math.vector";
  79389. import { TransformNode } from "babylonjs/Meshes/transformNode";
  79390. import { WebXRAbstractFeature } from "babylonjs/XR/features/WebXRAbstractFeature";
  79391. /**
  79392. * An interface for all Hit test features
  79393. */
  79394. export interface IWebXRHitTestFeature<T extends IWebXRLegacyHitResult> extends IWebXRFeature {
  79395. /**
  79396. * Triggered when new babylon (transformed) hit test results are available
  79397. */
  79398. onHitTestResultObservable: Observable<T[]>;
  79399. }
  79400. /**
  79401. * Options used for hit testing
  79402. */
  79403. export interface IWebXRLegacyHitTestOptions {
  79404. /**
  79405. * Only test when user interacted with the scene. Default - hit test every frame
  79406. */
  79407. testOnPointerDownOnly?: boolean;
  79408. /**
  79409. * The node to use to transform the local results to world coordinates
  79410. */
  79411. worldParentNode?: TransformNode;
  79412. }
  79413. /**
  79414. * Interface defining the babylon result of raycasting/hit-test
  79415. */
  79416. export interface IWebXRLegacyHitResult {
  79417. /**
  79418. * Transformation matrix that can be applied to a node that will put it in the hit point location
  79419. */
  79420. transformationMatrix: Matrix;
  79421. /**
  79422. * The native hit test result
  79423. */
  79424. xrHitResult: XRHitResult | XRHitTestResult;
  79425. }
  79426. /**
  79427. * The currently-working hit-test module.
  79428. * Hit test (or Ray-casting) is used to interact with the real world.
  79429. * For further information read here - https://github.com/immersive-web/hit-test
  79430. */
  79431. export class WebXRHitTestLegacy extends WebXRAbstractFeature implements IWebXRHitTestFeature<IWebXRLegacyHitResult> {
  79432. /**
  79433. * options to use when constructing this feature
  79434. */
  79435. readonly options: IWebXRLegacyHitTestOptions;
  79436. private _direction;
  79437. private _mat;
  79438. private _onSelectEnabled;
  79439. private _origin;
  79440. /**
  79441. * The module's name
  79442. */
  79443. static readonly Name: string;
  79444. /**
  79445. * The (Babylon) version of this module.
  79446. * This is an integer representing the implementation version.
  79447. * This number does not correspond to the WebXR specs version
  79448. */
  79449. static readonly Version: number;
  79450. /**
  79451. * Populated with the last native XR Hit Results
  79452. */
  79453. lastNativeXRHitResults: XRHitResult[];
  79454. /**
  79455. * Triggered when new babylon (transformed) hit test results are available
  79456. */
  79457. onHitTestResultObservable: Observable<IWebXRLegacyHitResult[]>;
  79458. /**
  79459. * Creates a new instance of the (legacy version) hit test feature
  79460. * @param _xrSessionManager an instance of WebXRSessionManager
  79461. * @param options options to use when constructing this feature
  79462. */
  79463. constructor(_xrSessionManager: WebXRSessionManager,
  79464. /**
  79465. * options to use when constructing this feature
  79466. */
  79467. options?: IWebXRLegacyHitTestOptions);
  79468. /**
  79469. * execute a hit test with an XR Ray
  79470. *
  79471. * @param xrSession a native xrSession that will execute this hit test
  79472. * @param xrRay the ray (position and direction) to use for ray-casting
  79473. * @param referenceSpace native XR reference space to use for the hit-test
  79474. * @param filter filter function that will filter the results
  79475. * @returns a promise that resolves with an array of native XR hit result in xr coordinates system
  79476. */
  79477. static XRHitTestWithRay(xrSession: XRSession, xrRay: XRRay, referenceSpace: XRReferenceSpace, filter?: (result: XRHitResult) => boolean): Promise<XRHitResult[]>;
  79478. /**
  79479. * Execute a hit test on the current running session using a select event returned from a transient input (such as touch)
  79480. * @param event the (select) event to use to select with
  79481. * @param referenceSpace the reference space to use for this hit test
  79482. * @returns a promise that resolves with an array of native XR hit result in xr coordinates system
  79483. */
  79484. static XRHitTestWithSelectEvent(event: XRInputSourceEvent, referenceSpace: XRReferenceSpace): Promise<XRHitResult[]>;
  79485. /**
  79486. * attach this feature
  79487. * Will usually be called by the features manager
  79488. *
  79489. * @returns true if successful.
  79490. */
  79491. attach(): boolean;
  79492. /**
  79493. * detach this feature.
  79494. * Will usually be called by the features manager
  79495. *
  79496. * @returns true if successful.
  79497. */
  79498. detach(): boolean;
  79499. /**
  79500. * Dispose this feature and all of the resources attached
  79501. */
  79502. dispose(): void;
  79503. protected _onXRFrame(frame: XRFrame): void;
  79504. private _onHitTestResults;
  79505. private _onSelect;
  79506. }
  79507. }
  79508. declare module "babylonjs/XR/features/WebXRHitTest" {
  79509. import { WebXRSessionManager } from "babylonjs/XR/webXRSessionManager";
  79510. import { Observable } from "babylonjs/Misc/observable";
  79511. import { Vector3, Quaternion } from "babylonjs/Maths/math.vector";
  79512. import { WebXRAbstractFeature } from "babylonjs/XR/features/WebXRAbstractFeature";
  79513. import { IWebXRLegacyHitTestOptions, IWebXRLegacyHitResult, IWebXRHitTestFeature } from "babylonjs/XR/features/WebXRHitTestLegacy";
  79514. /**
  79515. * Options used for hit testing (version 2)
  79516. */
  79517. export interface IWebXRHitTestOptions extends IWebXRLegacyHitTestOptions {
  79518. /**
  79519. * Do not create a permanent hit test. Will usually be used when only
  79520. * transient inputs are needed.
  79521. */
  79522. disablePermanentHitTest?: boolean;
  79523. /**
  79524. * Enable transient (for example touch-based) hit test inspections
  79525. */
  79526. enableTransientHitTest?: boolean;
  79527. /**
  79528. * Offset ray for the permanent hit test
  79529. */
  79530. offsetRay?: Vector3;
  79531. /**
  79532. * Offset ray for the transient hit test
  79533. */
  79534. transientOffsetRay?: Vector3;
  79535. /**
  79536. * Instead of using viewer space for hit tests, use the reference space defined in the session manager
  79537. */
  79538. useReferenceSpace?: boolean;
  79539. /**
  79540. * Override the default entity type(s) of the hit-test result
  79541. */
  79542. entityTypes?: XRHitTestTrackableType[];
  79543. }
  79544. /**
  79545. * Interface defining the babylon result of hit-test
  79546. */
  79547. export interface IWebXRHitResult extends IWebXRLegacyHitResult {
  79548. /**
  79549. * The input source that generated this hit test (if transient)
  79550. */
  79551. inputSource?: XRInputSource;
  79552. /**
  79553. * Is this a transient hit test
  79554. */
  79555. isTransient?: boolean;
  79556. /**
  79557. * Position of the hit test result
  79558. */
  79559. position: Vector3;
  79560. /**
  79561. * Rotation of the hit test result
  79562. */
  79563. rotationQuaternion: Quaternion;
  79564. /**
  79565. * The native hit test result
  79566. */
  79567. xrHitResult: XRHitTestResult;
  79568. }
  79569. /**
  79570. * The currently-working hit-test module.
  79571. * Hit test (or Ray-casting) is used to interact with the real world.
  79572. * For further information read here - https://github.com/immersive-web/hit-test
  79573. *
  79574. * Tested on chrome (mobile) 80.
  79575. */
  79576. export class WebXRHitTest extends WebXRAbstractFeature implements IWebXRHitTestFeature<IWebXRHitResult> {
  79577. /**
  79578. * options to use when constructing this feature
  79579. */
  79580. readonly options: IWebXRHitTestOptions;
  79581. private _tmpMat;
  79582. private _tmpPos;
  79583. private _tmpQuat;
  79584. private _transientXrHitTestSource;
  79585. private _xrHitTestSource;
  79586. private initHitTestSource;
  79587. /**
  79588. * The module's name
  79589. */
  79590. static readonly Name: string;
  79591. /**
  79592. * The (Babylon) version of this module.
  79593. * This is an integer representing the implementation version.
  79594. * This number does not correspond to the WebXR specs version
  79595. */
  79596. static readonly Version: number;
  79597. /**
  79598. * When set to true, each hit test will have its own position/rotation objects
  79599. * When set to false, position and rotation objects will be reused for each hit test. It is expected that
  79600. * the developers will clone them or copy them as they see fit.
  79601. */
  79602. autoCloneTransformation: boolean;
  79603. /**
  79604. * Triggered when new babylon (transformed) hit test results are available
  79605. * Note - this will be called when results come back from the device. It can be an empty array!!
  79606. */
  79607. onHitTestResultObservable: Observable<IWebXRHitResult[]>;
  79608. /**
  79609. * Use this to temporarily pause hit test checks.
  79610. */
  79611. paused: boolean;
  79612. /**
  79613. * Creates a new instance of the hit test feature
  79614. * @param _xrSessionManager an instance of WebXRSessionManager
  79615. * @param options options to use when constructing this feature
  79616. */
  79617. constructor(_xrSessionManager: WebXRSessionManager,
  79618. /**
  79619. * options to use when constructing this feature
  79620. */
  79621. options?: IWebXRHitTestOptions);
  79622. /**
  79623. * attach this feature
  79624. * Will usually be called by the features manager
  79625. *
  79626. * @returns true if successful.
  79627. */
  79628. attach(): boolean;
  79629. /**
  79630. * detach this feature.
  79631. * Will usually be called by the features manager
  79632. *
  79633. * @returns true if successful.
  79634. */
  79635. detach(): boolean;
  79636. /**
  79637. * Dispose this feature and all of the resources attached
  79638. */
  79639. dispose(): void;
  79640. protected _onXRFrame(frame: XRFrame): void;
  79641. private _processWebXRHitTestResult;
  79642. }
  79643. }
  79644. declare module "babylonjs/XR/features/WebXRAnchorSystem" {
  79645. import { WebXRSessionManager } from "babylonjs/XR/webXRSessionManager";
  79646. import { Observable } from "babylonjs/Misc/observable";
  79647. import { Matrix, Vector3, Quaternion } from "babylonjs/Maths/math.vector";
  79648. import { TransformNode } from "babylonjs/Meshes/transformNode";
  79649. import { WebXRAbstractFeature } from "babylonjs/XR/features/WebXRAbstractFeature";
  79650. import { IWebXRHitResult } from "babylonjs/XR/features/WebXRHitTest";
  79651. /**
  79652. * Configuration options of the anchor system
  79653. */
  79654. export interface IWebXRAnchorSystemOptions {
  79655. /**
  79656. * a node that will be used to convert local to world coordinates
  79657. */
  79658. worldParentNode?: TransformNode;
  79659. /**
  79660. * If set to true a reference of the created anchors will be kept until the next session starts
  79661. * If not defined, anchors will be removed from the array when the feature is detached or the session ended.
  79662. */
  79663. doNotRemoveAnchorsOnSessionEnded?: boolean;
  79664. }
  79665. /**
  79666. * A babylon container for an XR Anchor
  79667. */
  79668. export interface IWebXRAnchor {
  79669. /**
  79670. * A babylon-assigned ID for this anchor
  79671. */
  79672. id: number;
  79673. /**
  79674. * Transformation matrix to apply to an object attached to this anchor
  79675. */
  79676. transformationMatrix: Matrix;
  79677. /**
  79678. * The native anchor object
  79679. */
  79680. xrAnchor: XRAnchor;
  79681. /**
  79682. * if defined, this object will be constantly updated by the anchor's position and rotation
  79683. */
  79684. attachedNode?: TransformNode;
  79685. }
  79686. /**
  79687. * An implementation of the anchor system for WebXR.
  79688. * For further information see https://github.com/immersive-web/anchors/
  79689. */
  79690. export class WebXRAnchorSystem extends WebXRAbstractFeature {
  79691. private _options;
  79692. private _lastFrameDetected;
  79693. private _trackedAnchors;
  79694. private _referenceSpaceForFrameAnchors;
  79695. private _futureAnchors;
  79696. /**
  79697. * The module's name
  79698. */
  79699. static readonly Name: string;
  79700. /**
  79701. * The (Babylon) version of this module.
  79702. * This is an integer representing the implementation version.
  79703. * This number does not correspond to the WebXR specs version
  79704. */
  79705. static readonly Version: number;
  79706. /**
  79707. * Observers registered here will be executed when a new anchor was added to the session
  79708. */
  79709. onAnchorAddedObservable: Observable<IWebXRAnchor>;
  79710. /**
  79711. * Observers registered here will be executed when an anchor was removed from the session
  79712. */
  79713. onAnchorRemovedObservable: Observable<IWebXRAnchor>;
  79714. /**
  79715. * Observers registered here will be executed when an existing anchor updates
  79716. * This can execute N times every frame
  79717. */
  79718. onAnchorUpdatedObservable: Observable<IWebXRAnchor>;
  79719. /**
  79720. * Set the reference space to use for anchor creation, when not using a hit test.
  79721. * Will default to the session's reference space if not defined
  79722. */
  79723. set referenceSpaceForFrameAnchors(referenceSpace: XRReferenceSpace);
  79724. /**
  79725. * constructs a new anchor system
  79726. * @param _xrSessionManager an instance of WebXRSessionManager
  79727. * @param _options configuration object for this feature
  79728. */
  79729. constructor(_xrSessionManager: WebXRSessionManager, _options?: IWebXRAnchorSystemOptions);
  79730. private _tmpVector;
  79731. private _tmpQuaternion;
  79732. private _populateTmpTransformation;
  79733. /**
  79734. * Create a new anchor point using a hit test result at a specific point in the scene
  79735. * An anchor is tracked only after it is added to the trackerAnchors in xrFrame. The promise returned here does not yet guaranty that.
  79736. * Use onAnchorAddedObservable to get newly added anchors if you require tracking guaranty.
  79737. *
  79738. * @param hitTestResult The hit test result to use for this anchor creation
  79739. * @param position an optional position offset for this anchor
  79740. * @param rotationQuaternion an optional rotation offset for this anchor
  79741. * @returns A promise that fulfills when the XR anchor was registered in the system (but not necessarily added to the tracked anchors)
  79742. */
  79743. addAnchorPointUsingHitTestResultAsync(hitTestResult: IWebXRHitResult, position?: Vector3, rotationQuaternion?: Quaternion): Promise<XRAnchor>;
  79744. /**
  79745. * Add a new anchor at a specific position and rotation
  79746. * This function will add a new anchor per default in the next available frame. Unless forced, the createAnchor function
  79747. * will be called in the next xrFrame loop to make sure that the anchor can be created correctly.
  79748. * An anchor is tracked only after it is added to the trackerAnchors in xrFrame. The promise returned here does not yet guaranty that.
  79749. * Use onAnchorAddedObservable to get newly added anchors if you require tracking guaranty.
  79750. *
  79751. * @param position the position in which to add an anchor
  79752. * @param rotationQuaternion an optional rotation for the anchor transformation
  79753. * @param forceCreateInCurrentFrame force the creation of this anchor in the current frame. Must be called inside xrFrame loop!
  79754. * @returns A promise that fulfills when the XR anchor was registered in the system (but not necessarily added to the tracked anchors)
  79755. */
  79756. addAnchorAtPositionAndRotationAsync(position: Vector3, rotationQuaternion?: Quaternion, forceCreateInCurrentFrame?: boolean): Promise<XRAnchor>;
  79757. /**
  79758. * detach this feature.
  79759. * Will usually be called by the features manager
  79760. *
  79761. * @returns true if successful.
  79762. */
  79763. detach(): boolean;
  79764. /**
  79765. * Dispose this feature and all of the resources attached
  79766. */
  79767. dispose(): void;
  79768. protected _onXRFrame(frame: XRFrame): void;
  79769. /**
  79770. * avoiding using Array.find for global support.
  79771. * @param xrAnchor the plane to find in the array
  79772. */
  79773. private _findIndexInAnchorArray;
  79774. private _updateAnchorWithXRFrame;
  79775. private _createAnchorAtTransformation;
  79776. }
  79777. }
  79778. declare module "babylonjs/XR/features/WebXRPlaneDetector" {
  79779. import { TransformNode } from "babylonjs/Meshes/transformNode";
  79780. import { WebXRSessionManager } from "babylonjs/XR/webXRSessionManager";
  79781. import { Observable } from "babylonjs/Misc/observable";
  79782. import { Vector3, Matrix } from "babylonjs/Maths/math.vector";
  79783. import { WebXRAbstractFeature } from "babylonjs/XR/features/WebXRAbstractFeature";
  79784. /**
  79785. * Options used in the plane detector module
  79786. */
  79787. export interface IWebXRPlaneDetectorOptions {
  79788. /**
  79789. * The node to use to transform the local results to world coordinates
  79790. */
  79791. worldParentNode?: TransformNode;
  79792. /**
  79793. * If set to true a reference of the created planes will be kept until the next session starts
  79794. * If not defined, planes will be removed from the array when the feature is detached or the session ended.
  79795. */
  79796. doNotRemovePlanesOnSessionEnded?: boolean;
  79797. }
  79798. /**
  79799. * A babylon interface for a WebXR plane.
  79800. * A Plane is actually a polygon, built from N points in space
  79801. *
  79802. * Supported in chrome 79, not supported in canary 81 ATM
  79803. */
  79804. export interface IWebXRPlane {
  79805. /**
  79806. * a babylon-assigned ID for this polygon
  79807. */
  79808. id: number;
  79809. /**
  79810. * an array of vector3 points in babylon space. right/left hand system is taken into account.
  79811. */
  79812. polygonDefinition: Array<Vector3>;
  79813. /**
  79814. * A transformation matrix to apply on the mesh that will be built using the polygonDefinition
  79815. * Local vs. World are decided if worldParentNode was provided or not in the options when constructing the module
  79816. */
  79817. transformationMatrix: Matrix;
  79818. /**
  79819. * the native xr-plane object
  79820. */
  79821. xrPlane: XRPlane;
  79822. }
  79823. /**
  79824. * The plane detector is used to detect planes in the real world when in AR
  79825. * For more information see https://github.com/immersive-web/real-world-geometry/
  79826. */
  79827. export class WebXRPlaneDetector extends WebXRAbstractFeature {
  79828. private _options;
  79829. private _detectedPlanes;
  79830. private _enabled;
  79831. private _lastFrameDetected;
  79832. /**
  79833. * The module's name
  79834. */
  79835. static readonly Name: string;
  79836. /**
  79837. * The (Babylon) version of this module.
  79838. * This is an integer representing the implementation version.
  79839. * This number does not correspond to the WebXR specs version
  79840. */
  79841. static readonly Version: number;
  79842. /**
  79843. * Observers registered here will be executed when a new plane was added to the session
  79844. */
  79845. onPlaneAddedObservable: Observable<IWebXRPlane>;
  79846. /**
  79847. * Observers registered here will be executed when a plane is no longer detected in the session
  79848. */
  79849. onPlaneRemovedObservable: Observable<IWebXRPlane>;
  79850. /**
  79851. * Observers registered here will be executed when an existing plane updates (for example - expanded)
  79852. * This can execute N times every frame
  79853. */
  79854. onPlaneUpdatedObservable: Observable<IWebXRPlane>;
  79855. /**
  79856. * construct a new Plane Detector
  79857. * @param _xrSessionManager an instance of xr Session manager
  79858. * @param _options configuration to use when constructing this feature
  79859. */
  79860. constructor(_xrSessionManager: WebXRSessionManager, _options?: IWebXRPlaneDetectorOptions);
  79861. /**
  79862. * detach this feature.
  79863. * Will usually be called by the features manager
  79864. *
  79865. * @returns true if successful.
  79866. */
  79867. detach(): boolean;
  79868. /**
  79869. * Dispose this feature and all of the resources attached
  79870. */
  79871. dispose(): void;
  79872. protected _onXRFrame(frame: XRFrame): void;
  79873. private _init;
  79874. private _updatePlaneWithXRPlane;
  79875. /**
  79876. * avoiding using Array.find for global support.
  79877. * @param xrPlane the plane to find in the array
  79878. */
  79879. private findIndexInPlaneArray;
  79880. }
  79881. }
  79882. declare module "babylonjs/XR/features/WebXRBackgroundRemover" {
  79883. import { WebXRSessionManager } from "babylonjs/XR/webXRSessionManager";
  79884. import { AbstractMesh } from "babylonjs/Meshes/abstractMesh";
  79885. import { Observable } from "babylonjs/Misc/observable";
  79886. import { WebXRAbstractFeature } from "babylonjs/XR/features/WebXRAbstractFeature";
  79887. /**
  79888. * Options interface for the background remover plugin
  79889. */
  79890. export interface IWebXRBackgroundRemoverOptions {
  79891. /**
  79892. * Further background meshes to disable when entering AR
  79893. */
  79894. backgroundMeshes?: AbstractMesh[];
  79895. /**
  79896. * flags to configure the removal of the environment helper.
  79897. * If not set, the entire background will be removed. If set, flags should be set as well.
  79898. */
  79899. environmentHelperRemovalFlags?: {
  79900. /**
  79901. * Should the skybox be removed (default false)
  79902. */
  79903. skyBox?: boolean;
  79904. /**
  79905. * Should the ground be removed (default false)
  79906. */
  79907. ground?: boolean;
  79908. };
  79909. /**
  79910. * don't disable the environment helper
  79911. */
  79912. ignoreEnvironmentHelper?: boolean;
  79913. }
  79914. /**
  79915. * A module that will automatically disable background meshes when entering AR and will enable them when leaving AR.
  79916. */
  79917. export class WebXRBackgroundRemover extends WebXRAbstractFeature {
  79918. /**
  79919. * read-only options to be used in this module
  79920. */
  79921. readonly options: IWebXRBackgroundRemoverOptions;
  79922. /**
  79923. * The module's name
  79924. */
  79925. static readonly Name: string;
  79926. /**
  79927. * The (Babylon) version of this module.
  79928. * This is an integer representing the implementation version.
  79929. * This number does not correspond to the WebXR specs version
  79930. */
  79931. static readonly Version: number;
  79932. /**
  79933. * registered observers will be triggered when the background state changes
  79934. */
  79935. onBackgroundStateChangedObservable: Observable<boolean>;
  79936. /**
  79937. * constructs a new background remover module
  79938. * @param _xrSessionManager the session manager for this module
  79939. * @param options read-only options to be used in this module
  79940. */
  79941. constructor(_xrSessionManager: WebXRSessionManager,
  79942. /**
  79943. * read-only options to be used in this module
  79944. */
  79945. options?: IWebXRBackgroundRemoverOptions);
  79946. /**
  79947. * attach this feature
  79948. * Will usually be called by the features manager
  79949. *
  79950. * @returns true if successful.
  79951. */
  79952. attach(): boolean;
  79953. /**
  79954. * detach this feature.
  79955. * Will usually be called by the features manager
  79956. *
  79957. * @returns true if successful.
  79958. */
  79959. detach(): boolean;
  79960. /**
  79961. * Dispose this feature and all of the resources attached
  79962. */
  79963. dispose(): void;
  79964. protected _onXRFrame(_xrFrame: XRFrame): void;
  79965. private _setBackgroundState;
  79966. }
  79967. }
  79968. declare module "babylonjs/XR/features/WebXRControllerPhysics" {
  79969. import { WebXRAbstractFeature } from "babylonjs/XR/features/WebXRAbstractFeature";
  79970. import { WebXRInputSource } from "babylonjs/XR/webXRInputSource";
  79971. import { PhysicsImpostor } from "babylonjs/Physics/physicsImpostor";
  79972. import { WebXRInput } from "babylonjs/XR/webXRInput";
  79973. import { WebXRSessionManager } from "babylonjs/XR/webXRSessionManager";
  79974. import { Nullable } from "babylonjs/types";
  79975. /**
  79976. * Options for the controller physics feature
  79977. */
  79978. export class IWebXRControllerPhysicsOptions {
  79979. /**
  79980. * Should the headset get its own impostor
  79981. */
  79982. enableHeadsetImpostor?: boolean;
  79983. /**
  79984. * Optional parameters for the headset impostor
  79985. */
  79986. headsetImpostorParams?: {
  79987. /**
  79988. * The type of impostor to create. Default is sphere
  79989. */
  79990. impostorType: number;
  79991. /**
  79992. * the size of the impostor. Defaults to 10cm
  79993. */
  79994. impostorSize?: number | {
  79995. width: number;
  79996. height: number;
  79997. depth: number;
  79998. };
  79999. /**
  80000. * Friction definitions
  80001. */
  80002. friction?: number;
  80003. /**
  80004. * Restitution
  80005. */
  80006. restitution?: number;
  80007. };
  80008. /**
  80009. * The physics properties of the future impostors
  80010. */
  80011. physicsProperties?: {
  80012. /**
  80013. * If set to true, a mesh impostor will be created when the controller mesh was loaded
  80014. * Note that this requires a physics engine that supports mesh impostors!
  80015. */
  80016. useControllerMesh?: boolean;
  80017. /**
  80018. * The type of impostor to create. Default is sphere
  80019. */
  80020. impostorType?: number;
  80021. /**
  80022. * the size of the impostor. Defaults to 10cm
  80023. */
  80024. impostorSize?: number | {
  80025. width: number;
  80026. height: number;
  80027. depth: number;
  80028. };
  80029. /**
  80030. * Friction definitions
  80031. */
  80032. friction?: number;
  80033. /**
  80034. * Restitution
  80035. */
  80036. restitution?: number;
  80037. };
  80038. /**
  80039. * the xr input to use with this pointer selection
  80040. */
  80041. xrInput: WebXRInput;
  80042. }
  80043. /**
  80044. * Add physics impostor to your webxr controllers,
  80045. * including naive calculation of their linear and angular velocity
  80046. */
  80047. export class WebXRControllerPhysics extends WebXRAbstractFeature {
  80048. private readonly _options;
  80049. private _attachController;
  80050. private _controllers;
  80051. private _debugMode;
  80052. private _delta;
  80053. private _headsetImpostor?;
  80054. private _headsetMesh?;
  80055. private _lastTimestamp;
  80056. private _tmpQuaternion;
  80057. private _tmpVector;
  80058. /**
  80059. * The module's name
  80060. */
  80061. static readonly Name: string;
  80062. /**
  80063. * The (Babylon) version of this module.
  80064. * This is an integer representing the implementation version.
  80065. * This number does not correspond to the webxr specs version
  80066. */
  80067. static readonly Version: number;
  80068. /**
  80069. * Construct a new Controller Physics Feature
  80070. * @param _xrSessionManager the corresponding xr session manager
  80071. * @param _options options to create this feature with
  80072. */
  80073. constructor(_xrSessionManager: WebXRSessionManager, _options: IWebXRControllerPhysicsOptions);
  80074. /**
  80075. * @hidden
  80076. * enable debugging - will show console outputs and the impostor mesh
  80077. */
  80078. _enablePhysicsDebug(): void;
  80079. /**
  80080. * Manually add a controller (if no xrInput was provided or physics engine was not enabled)
  80081. * @param xrController the controller to add
  80082. */
  80083. addController(xrController: WebXRInputSource): void;
  80084. /**
  80085. * attach this feature
  80086. * Will usually be called by the features manager
  80087. *
  80088. * @returns true if successful.
  80089. */
  80090. attach(): boolean;
  80091. /**
  80092. * detach this feature.
  80093. * Will usually be called by the features manager
  80094. *
  80095. * @returns true if successful.
  80096. */
  80097. detach(): boolean;
  80098. /**
  80099. * Get the headset impostor, if enabled
  80100. * @returns the impostor
  80101. */
  80102. getHeadsetImpostor(): PhysicsImpostor | undefined;
  80103. /**
  80104. * Get the physics impostor of a specific controller.
  80105. * The impostor is not attached to a mesh because a mesh for each controller is not obligatory
  80106. * @param controller the controller or the controller id of which to get the impostor
  80107. * @returns the impostor or null
  80108. */
  80109. getImpostorForController(controller: WebXRInputSource | string): Nullable<PhysicsImpostor>;
  80110. /**
  80111. * Update the physics properties provided in the constructor
  80112. * @param newProperties the new properties object
  80113. */
  80114. setPhysicsProperties(newProperties: {
  80115. impostorType?: number;
  80116. impostorSize?: number | {
  80117. width: number;
  80118. height: number;
  80119. depth: number;
  80120. };
  80121. friction?: number;
  80122. restitution?: number;
  80123. }): void;
  80124. protected _onXRFrame(_xrFrame: any): void;
  80125. private _detachController;
  80126. }
  80127. }
  80128. declare module "babylonjs/XR/features/WebXRFeaturePointSystem" {
  80129. import { WebXRSessionManager } from "babylonjs/XR/webXRSessionManager";
  80130. import { Observable } from "babylonjs/Misc/observable";
  80131. import { Vector3 } from "babylonjs/Maths/math.vector";
  80132. import { WebXRAbstractFeature } from "babylonjs/XR/features/WebXRAbstractFeature";
  80133. /**
  80134. * A babylon interface for a "WebXR" feature point.
  80135. * Represents the position and confidence value of a given feature point.
  80136. */
  80137. export interface IWebXRFeaturePoint {
  80138. /**
  80139. * Represents the position of the feature point in world space.
  80140. */
  80141. position: Vector3;
  80142. /**
  80143. * Represents the confidence value of the feature point in world space. 0 being least confident, and 1 being most confident.
  80144. */
  80145. confidenceValue: number;
  80146. }
  80147. /**
  80148. * The feature point system is used to detect feature points from real world geometry.
  80149. * This feature is currently experimental and only supported on BabylonNative, and should not be used in the browser.
  80150. * The newly introduced API can be seen in webxr.nativeextensions.d.ts and described in FeaturePoints.md.
  80151. */
  80152. export class WebXRFeaturePointSystem extends WebXRAbstractFeature {
  80153. private _enabled;
  80154. private _featurePointCloud;
  80155. /**
  80156. * The module's name
  80157. */
  80158. static readonly Name: string;
  80159. /**
  80160. * The (Babylon) version of this module.
  80161. * This is an integer representing the implementation version.
  80162. * This number does not correspond to the WebXR specs version
  80163. */
  80164. static readonly Version: number;
  80165. /**
  80166. * Observers registered here will be executed whenever new feature points are added (on XRFrame while the session is tracking).
  80167. * Will notify the observers about which feature points have been added.
  80168. */
  80169. readonly onFeaturePointsAddedObservable: Observable<number[]>;
  80170. /**
  80171. * Observers registered here will be executed whenever a feature point has been updated (on XRFrame while the session is tracking).
  80172. * Will notify the observers about which feature points have been updated.
  80173. */
  80174. readonly onFeaturePointsUpdatedObservable: Observable<number[]>;
  80175. /**
  80176. * The current feature point cloud maintained across frames.
  80177. */
  80178. get featurePointCloud(): Array<IWebXRFeaturePoint>;
  80179. /**
  80180. * construct the feature point system
  80181. * @param _xrSessionManager an instance of xr Session manager
  80182. */
  80183. constructor(_xrSessionManager: WebXRSessionManager);
  80184. /**
  80185. * Detach this feature.
  80186. * Will usually be called by the features manager
  80187. *
  80188. * @returns true if successful.
  80189. */
  80190. detach(): boolean;
  80191. /**
  80192. * Dispose this feature and all of the resources attached
  80193. */
  80194. dispose(): void;
  80195. /**
  80196. * On receiving a new XR frame if this feature is attached notify observers new feature point data is available.
  80197. */
  80198. protected _onXRFrame(frame: XRFrame): void;
  80199. /**
  80200. * Initializes the feature. If the feature point feature is not available for this environment do not mark the feature as enabled.
  80201. */
  80202. private _init;
  80203. }
  80204. }
  80205. declare module "babylonjs/XR/features/WebXRHandTracking" {
  80206. import { WebXRAbstractFeature } from "babylonjs/XR/features/WebXRAbstractFeature";
  80207. import { WebXRSessionManager } from "babylonjs/XR/webXRSessionManager";
  80208. import { AbstractMesh } from "babylonjs/Meshes/abstractMesh";
  80209. import { Mesh } from "babylonjs/Meshes/mesh";
  80210. import { WebXRInput } from "babylonjs/XR/webXRInput";
  80211. import { WebXRInputSource } from "babylonjs/XR/webXRInputSource";
  80212. import { Nullable } from "babylonjs/types";
  80213. import { IDisposable } from "babylonjs/scene";
  80214. import { Observable } from "babylonjs/Misc/observable";
  80215. import { InstancedMesh } from "babylonjs/Meshes/instancedMesh";
  80216. /**
  80217. * Configuration interface for the hand tracking feature
  80218. */
  80219. export interface IWebXRHandTrackingOptions {
  80220. /**
  80221. * The xrInput that will be used as source for new hands
  80222. */
  80223. xrInput: WebXRInput;
  80224. /**
  80225. * Configuration object for the joint meshes
  80226. */
  80227. jointMeshes?: {
  80228. /**
  80229. * Should the meshes created be invisible (defaults to false)
  80230. */
  80231. invisible?: boolean;
  80232. /**
  80233. * A source mesh to be used to create instances. Defaults to a sphere.
  80234. * This mesh will be the source for all other (25) meshes.
  80235. * It should have the general size of a single unit, as the instances will be scaled according to the provided radius
  80236. */
  80237. sourceMesh?: Mesh;
  80238. /**
  80239. * This function will be called after a mesh was created for a specific joint.
  80240. * Using this function you can either manipulate the instance or return a new mesh.
  80241. * When returning a new mesh the instance created before will be disposed
  80242. */
  80243. onHandJointMeshGenerated?: (meshInstance: InstancedMesh, jointId: number, controllerId: string) => Mesh | undefined;
  80244. /**
  80245. * Should the source mesh stay visible. Defaults to false
  80246. */
  80247. keepOriginalVisible?: boolean;
  80248. /**
  80249. * Scale factor for all instances (defaults to 2)
  80250. */
  80251. scaleFactor?: number;
  80252. /**
  80253. * Should each instance have its own physics impostor
  80254. */
  80255. enablePhysics?: boolean;
  80256. /**
  80257. * If enabled, override default physics properties
  80258. */
  80259. physicsProps?: {
  80260. friction?: number;
  80261. restitution?: number;
  80262. impostorType?: number;
  80263. };
  80264. /**
  80265. * For future use - a single hand-mesh that will be updated according to the XRHand data provided
  80266. */
  80267. handMesh?: AbstractMesh;
  80268. };
  80269. }
  80270. /**
  80271. * Parts of the hands divided to writs and finger names
  80272. */
  80273. export const enum HandPart {
  80274. /**
  80275. * HandPart - Wrist
  80276. */
  80277. WRIST = "wrist",
  80278. /**
  80279. * HandPart - The THumb
  80280. */
  80281. THUMB = "thumb",
  80282. /**
  80283. * HandPart - Index finger
  80284. */
  80285. INDEX = "index",
  80286. /**
  80287. * HandPart - Middle finger
  80288. */
  80289. MIDDLE = "middle",
  80290. /**
  80291. * HandPart - Ring finger
  80292. */
  80293. RING = "ring",
  80294. /**
  80295. * HandPart - Little finger
  80296. */
  80297. LITTLE = "little"
  80298. }
  80299. /**
  80300. * Representing a single hand (with its corresponding native XRHand object)
  80301. */
  80302. export class WebXRHand implements IDisposable {
  80303. /** the controller to which the hand correlates */
  80304. readonly xrController: WebXRInputSource;
  80305. /** the meshes to be used to track the hand joints */
  80306. readonly trackedMeshes: AbstractMesh[];
  80307. /**
  80308. * Hand-parts definition (key is HandPart)
  80309. */
  80310. handPartsDefinition: {
  80311. [key: string]: number[];
  80312. };
  80313. /**
  80314. * Populate the HandPartsDefinition object.
  80315. * This is called as a side effect since certain browsers don't have XRHand defined.
  80316. */
  80317. private generateHandPartsDefinition;
  80318. /**
  80319. * Construct a new hand object
  80320. * @param xrController the controller to which the hand correlates
  80321. * @param trackedMeshes the meshes to be used to track the hand joints
  80322. */
  80323. constructor(
  80324. /** the controller to which the hand correlates */
  80325. xrController: WebXRInputSource,
  80326. /** the meshes to be used to track the hand joints */
  80327. trackedMeshes: AbstractMesh[]);
  80328. /**
  80329. * Update this hand from the latest xr frame
  80330. * @param xrFrame xrFrame to update from
  80331. * @param referenceSpace The current viewer reference space
  80332. * @param scaleFactor optional scale factor for the meshes
  80333. */
  80334. updateFromXRFrame(xrFrame: XRFrame, referenceSpace: XRReferenceSpace, scaleFactor?: number): void;
  80335. /**
  80336. * Get meshes of part of the hand
  80337. * @param part the part of hand to get
  80338. * @returns An array of meshes that correlate to the hand part requested
  80339. */
  80340. getHandPartMeshes(part: HandPart): AbstractMesh[];
  80341. /**
  80342. * Dispose this Hand object
  80343. */
  80344. dispose(): void;
  80345. }
  80346. /**
  80347. * WebXR Hand Joint tracking feature, available for selected browsers and devices
  80348. */
  80349. export class WebXRHandTracking extends WebXRAbstractFeature {
  80350. /**
  80351. * options to use when constructing this feature
  80352. */
  80353. readonly options: IWebXRHandTrackingOptions;
  80354. private static _idCounter;
  80355. /**
  80356. * The module's name
  80357. */
  80358. static readonly Name: string;
  80359. /**
  80360. * The (Babylon) version of this module.
  80361. * This is an integer representing the implementation version.
  80362. * This number does not correspond to the WebXR specs version
  80363. */
  80364. static readonly Version: number;
  80365. /**
  80366. * This observable will notify registered observers when a new hand object was added and initialized
  80367. */
  80368. onHandAddedObservable: Observable<WebXRHand>;
  80369. /**
  80370. * This observable will notify its observers right before the hand object is disposed
  80371. */
  80372. onHandRemovedObservable: Observable<WebXRHand>;
  80373. private _hands;
  80374. /**
  80375. * Creates a new instance of the hit test feature
  80376. * @param _xrSessionManager an instance of WebXRSessionManager
  80377. * @param options options to use when constructing this feature
  80378. */
  80379. constructor(_xrSessionManager: WebXRSessionManager,
  80380. /**
  80381. * options to use when constructing this feature
  80382. */
  80383. options: IWebXRHandTrackingOptions);
  80384. /**
  80385. * Check if the needed objects are defined.
  80386. * This does not mean that the feature is enabled, but that the objects needed are well defined.
  80387. */
  80388. isCompatible(): boolean;
  80389. /**
  80390. * attach this feature
  80391. * Will usually be called by the features manager
  80392. *
  80393. * @returns true if successful.
  80394. */
  80395. attach(): boolean;
  80396. /**
  80397. * detach this feature.
  80398. * Will usually be called by the features manager
  80399. *
  80400. * @returns true if successful.
  80401. */
  80402. detach(): boolean;
  80403. /**
  80404. * Dispose this feature and all of the resources attached
  80405. */
  80406. dispose(): void;
  80407. /**
  80408. * Get the hand object according to the controller id
  80409. * @param controllerId the controller id to which we want to get the hand
  80410. * @returns null if not found or the WebXRHand object if found
  80411. */
  80412. getHandByControllerId(controllerId: string): Nullable<WebXRHand>;
  80413. /**
  80414. * Get a hand object according to the requested handedness
  80415. * @param handedness the handedness to request
  80416. * @returns null if not found or the WebXRHand object if found
  80417. */
  80418. getHandByHandedness(handedness: XRHandedness): Nullable<WebXRHand>;
  80419. protected _onXRFrame(_xrFrame: XRFrame): void;
  80420. private _attachHand;
  80421. private _detachHand;
  80422. }
  80423. }
  80424. declare module "babylonjs/XR/features/index" {
  80425. export * from "babylonjs/XR/features/WebXRHitTestLegacy";
  80426. export * from "babylonjs/XR/features/WebXRAnchorSystem";
  80427. export * from "babylonjs/XR/features/WebXRPlaneDetector";
  80428. export * from "babylonjs/XR/features/WebXRBackgroundRemover";
  80429. export * from "babylonjs/XR/features/WebXRControllerTeleportation";
  80430. export * from "babylonjs/XR/features/WebXRControllerPointerSelection";
  80431. export * from "babylonjs/XR/features/WebXRControllerPhysics";
  80432. export * from "babylonjs/XR/features/WebXRHitTest";
  80433. export * from "babylonjs/XR/features/WebXRFeaturePointSystem";
  80434. export * from "babylonjs/XR/features/WebXRHandTracking";
  80435. }
  80436. declare module "babylonjs/XR/motionController/webXRMicrosoftMixedRealityController" {
  80437. import { WebXRAbstractMotionController, IMinimalMotionControllerObject, MotionControllerHandedness } from "babylonjs/XR/motionController/webXRAbstractMotionController";
  80438. import { AbstractMesh } from "babylonjs/Meshes/abstractMesh";
  80439. import { Scene } from "babylonjs/scene";
  80440. /**
  80441. * The motion controller class for all microsoft mixed reality controllers
  80442. */
  80443. export class WebXRMicrosoftMixedRealityController extends WebXRAbstractMotionController {
  80444. protected readonly _mapping: {
  80445. defaultButton: {
  80446. valueNodeName: string;
  80447. unpressedNodeName: string;
  80448. pressedNodeName: string;
  80449. };
  80450. defaultAxis: {
  80451. valueNodeName: string;
  80452. minNodeName: string;
  80453. maxNodeName: string;
  80454. };
  80455. buttons: {
  80456. "xr-standard-trigger": {
  80457. rootNodeName: string;
  80458. componentProperty: string;
  80459. states: string[];
  80460. };
  80461. "xr-standard-squeeze": {
  80462. rootNodeName: string;
  80463. componentProperty: string;
  80464. states: string[];
  80465. };
  80466. "xr-standard-touchpad": {
  80467. rootNodeName: string;
  80468. labelAnchorNodeName: string;
  80469. touchPointNodeName: string;
  80470. };
  80471. "xr-standard-thumbstick": {
  80472. rootNodeName: string;
  80473. componentProperty: string;
  80474. states: string[];
  80475. };
  80476. };
  80477. axes: {
  80478. "xr-standard-touchpad": {
  80479. "x-axis": {
  80480. rootNodeName: string;
  80481. };
  80482. "y-axis": {
  80483. rootNodeName: string;
  80484. };
  80485. };
  80486. "xr-standard-thumbstick": {
  80487. "x-axis": {
  80488. rootNodeName: string;
  80489. };
  80490. "y-axis": {
  80491. rootNodeName: string;
  80492. };
  80493. };
  80494. };
  80495. };
  80496. /**
  80497. * The base url used to load the left and right controller models
  80498. */
  80499. static MODEL_BASE_URL: string;
  80500. /**
  80501. * The name of the left controller model file
  80502. */
  80503. static MODEL_LEFT_FILENAME: string;
  80504. /**
  80505. * The name of the right controller model file
  80506. */
  80507. static MODEL_RIGHT_FILENAME: string;
  80508. profileId: string;
  80509. constructor(scene: Scene, gamepadObject: IMinimalMotionControllerObject, handedness: MotionControllerHandedness);
  80510. protected _getFilenameAndPath(): {
  80511. filename: string;
  80512. path: string;
  80513. };
  80514. protected _getModelLoadingConstraints(): boolean;
  80515. protected _processLoadedModel(_meshes: AbstractMesh[]): void;
  80516. protected _setRootMesh(meshes: AbstractMesh[]): void;
  80517. protected _updateModel(): void;
  80518. }
  80519. }
  80520. declare module "babylonjs/XR/motionController/webXROculusTouchMotionController" {
  80521. import { WebXRAbstractMotionController, IMinimalMotionControllerObject, MotionControllerHandedness } from "babylonjs/XR/motionController/webXRAbstractMotionController";
  80522. import { AbstractMesh } from "babylonjs/Meshes/abstractMesh";
  80523. import { Scene } from "babylonjs/scene";
  80524. /**
  80525. * The motion controller class for oculus touch (quest, rift).
  80526. * This class supports legacy mapping as well the standard xr mapping
  80527. */
  80528. export class WebXROculusTouchMotionController extends WebXRAbstractMotionController {
  80529. private _forceLegacyControllers;
  80530. private _modelRootNode;
  80531. /**
  80532. * The base url used to load the left and right controller models
  80533. */
  80534. static MODEL_BASE_URL: string;
  80535. /**
  80536. * The name of the left controller model file
  80537. */
  80538. static MODEL_LEFT_FILENAME: string;
  80539. /**
  80540. * The name of the right controller model file
  80541. */
  80542. static MODEL_RIGHT_FILENAME: string;
  80543. /**
  80544. * Base Url for the Quest controller model.
  80545. */
  80546. static QUEST_MODEL_BASE_URL: string;
  80547. profileId: string;
  80548. constructor(scene: Scene, gamepadObject: IMinimalMotionControllerObject, handedness: MotionControllerHandedness, legacyMapping?: boolean, _forceLegacyControllers?: boolean);
  80549. protected _getFilenameAndPath(): {
  80550. filename: string;
  80551. path: string;
  80552. };
  80553. protected _getModelLoadingConstraints(): boolean;
  80554. protected _processLoadedModel(_meshes: AbstractMesh[]): void;
  80555. protected _setRootMesh(meshes: AbstractMesh[]): void;
  80556. protected _updateModel(): void;
  80557. /**
  80558. * Is this the new type of oculus touch. At the moment both have the same profile and it is impossible to differentiate
  80559. * between the touch and touch 2.
  80560. */
  80561. private _isQuest;
  80562. }
  80563. }
  80564. declare module "babylonjs/XR/motionController/webXRHTCViveMotionController" {
  80565. import { IMinimalMotionControllerObject, MotionControllerHandedness, WebXRAbstractMotionController } from "babylonjs/XR/motionController/webXRAbstractMotionController";
  80566. import { Scene } from "babylonjs/scene";
  80567. import { AbstractMesh } from "babylonjs/Meshes/abstractMesh";
  80568. /**
  80569. * The motion controller class for the standard HTC-Vive controllers
  80570. */
  80571. export class WebXRHTCViveMotionController extends WebXRAbstractMotionController {
  80572. private _modelRootNode;
  80573. /**
  80574. * The base url used to load the left and right controller models
  80575. */
  80576. static MODEL_BASE_URL: string;
  80577. /**
  80578. * File name for the controller model.
  80579. */
  80580. static MODEL_FILENAME: string;
  80581. profileId: string;
  80582. /**
  80583. * Create a new Vive motion controller object
  80584. * @param scene the scene to use to create this controller
  80585. * @param gamepadObject the corresponding gamepad object
  80586. * @param handedness the handedness of the controller
  80587. */
  80588. constructor(scene: Scene, gamepadObject: IMinimalMotionControllerObject, handedness: MotionControllerHandedness);
  80589. protected _getFilenameAndPath(): {
  80590. filename: string;
  80591. path: string;
  80592. };
  80593. protected _getModelLoadingConstraints(): boolean;
  80594. protected _processLoadedModel(_meshes: AbstractMesh[]): void;
  80595. protected _setRootMesh(meshes: AbstractMesh[]): void;
  80596. protected _updateModel(): void;
  80597. }
  80598. }
  80599. declare module "babylonjs/XR/motionController/index" {
  80600. export * from "babylonjs/XR/motionController/webXRAbstractMotionController";
  80601. export * from "babylonjs/XR/motionController/webXRControllerComponent";
  80602. export * from "babylonjs/XR/motionController/webXRGenericMotionController";
  80603. export * from "babylonjs/XR/motionController/webXRMicrosoftMixedRealityController";
  80604. export * from "babylonjs/XR/motionController/webXRMotionControllerManager";
  80605. export * from "babylonjs/XR/motionController/webXROculusTouchMotionController";
  80606. export * from "babylonjs/XR/motionController/webXRHTCViveMotionController";
  80607. export * from "babylonjs/XR/motionController/webXRProfiledMotionController";
  80608. }
  80609. declare module "babylonjs/XR/index" {
  80610. export * from "babylonjs/XR/webXRCamera";
  80611. export * from "babylonjs/XR/webXREnterExitUI";
  80612. export * from "babylonjs/XR/webXRExperienceHelper";
  80613. export * from "babylonjs/XR/webXRInput";
  80614. export * from "babylonjs/XR/webXRInputSource";
  80615. export * from "babylonjs/XR/webXRManagedOutputCanvas";
  80616. export * from "babylonjs/XR/webXRTypes";
  80617. export * from "babylonjs/XR/webXRSessionManager";
  80618. export * from "babylonjs/XR/webXRDefaultExperience";
  80619. export * from "babylonjs/XR/webXRFeaturesManager";
  80620. export * from "babylonjs/XR/features/index";
  80621. export * from "babylonjs/XR/motionController/index";
  80622. }
  80623. declare module "babylonjs/index" {
  80624. export * from "babylonjs/abstractScene";
  80625. export * from "babylonjs/Actions/index";
  80626. export * from "babylonjs/Animations/index";
  80627. export * from "babylonjs/assetContainer";
  80628. export * from "babylonjs/Audio/index";
  80629. export * from "babylonjs/Behaviors/index";
  80630. export * from "babylonjs/Bones/index";
  80631. export * from "babylonjs/Cameras/index";
  80632. export * from "babylonjs/Collisions/index";
  80633. export * from "babylonjs/Culling/index";
  80634. export * from "babylonjs/Debug/index";
  80635. export * from "babylonjs/DeviceInput/index";
  80636. export * from "babylonjs/Engines/index";
  80637. export * from "babylonjs/Events/index";
  80638. export * from "babylonjs/Gamepads/index";
  80639. export * from "babylonjs/Gizmos/index";
  80640. export * from "babylonjs/Helpers/index";
  80641. export * from "babylonjs/Instrumentation/index";
  80642. export * from "babylonjs/Layers/index";
  80643. export * from "babylonjs/LensFlares/index";
  80644. export * from "babylonjs/Lights/index";
  80645. export * from "babylonjs/Loading/index";
  80646. export * from "babylonjs/Materials/index";
  80647. export * from "babylonjs/Maths/index";
  80648. export * from "babylonjs/Meshes/index";
  80649. export * from "babylonjs/Morph/index";
  80650. export * from "babylonjs/Navigation/index";
  80651. export * from "babylonjs/node";
  80652. export * from "babylonjs/Offline/index";
  80653. export * from "babylonjs/Particles/index";
  80654. export * from "babylonjs/Physics/index";
  80655. export * from "babylonjs/PostProcesses/index";
  80656. export * from "babylonjs/Probes/index";
  80657. export * from "babylonjs/Rendering/index";
  80658. export * from "babylonjs/scene";
  80659. export * from "babylonjs/sceneComponent";
  80660. export * from "babylonjs/Sprites/index";
  80661. export * from "babylonjs/States/index";
  80662. export * from "babylonjs/Misc/index";
  80663. export * from "babylonjs/XR/index";
  80664. export * from "babylonjs/types";
  80665. }
  80666. declare module "babylonjs/Animations/pathCursor" {
  80667. import { Vector3 } from "babylonjs/Maths/math.vector";
  80668. import { Path2 } from "babylonjs/Maths/math.path";
  80669. /**
  80670. * A cursor which tracks a point on a path
  80671. */
  80672. export class PathCursor {
  80673. private path;
  80674. /**
  80675. * Stores path cursor callbacks for when an onchange event is triggered
  80676. */
  80677. private _onchange;
  80678. /**
  80679. * The value of the path cursor
  80680. */
  80681. value: number;
  80682. /**
  80683. * The animation array of the path cursor
  80684. */
  80685. animations: Animation[];
  80686. /**
  80687. * Initializes the path cursor
  80688. * @param path The path to track
  80689. */
  80690. constructor(path: Path2);
  80691. /**
  80692. * Gets the cursor point on the path
  80693. * @returns A point on the path cursor at the cursor location
  80694. */
  80695. getPoint(): Vector3;
  80696. /**
  80697. * Moves the cursor ahead by the step amount
  80698. * @param step The amount to move the cursor forward
  80699. * @returns This path cursor
  80700. */
  80701. moveAhead(step?: number): PathCursor;
  80702. /**
  80703. * Moves the cursor behind by the step amount
  80704. * @param step The amount to move the cursor back
  80705. * @returns This path cursor
  80706. */
  80707. moveBack(step?: number): PathCursor;
  80708. /**
  80709. * Moves the cursor by the step amount
  80710. * If the step amount is greater than one, an exception is thrown
  80711. * @param step The amount to move the cursor
  80712. * @returns This path cursor
  80713. */
  80714. move(step: number): PathCursor;
  80715. /**
  80716. * Ensures that the value is limited between zero and one
  80717. * @returns This path cursor
  80718. */
  80719. private ensureLimits;
  80720. /**
  80721. * Runs onchange callbacks on change (used by the animation engine)
  80722. * @returns This path cursor
  80723. */
  80724. private raiseOnChange;
  80725. /**
  80726. * Executes a function on change
  80727. * @param f A path cursor onchange callback
  80728. * @returns This path cursor
  80729. */
  80730. onchange(f: (cursor: PathCursor) => void): PathCursor;
  80731. }
  80732. }
  80733. declare module "babylonjs/Engines/Processors/Expressions/Operators/index" {
  80734. export * from "babylonjs/Engines/Processors/Expressions/Operators/shaderDefineAndOperator";
  80735. export * from "babylonjs/Engines/Processors/Expressions/Operators/shaderDefineArithmeticOperator";
  80736. export * from "babylonjs/Engines/Processors/Expressions/Operators/shaderDefineIsDefinedOperator";
  80737. export * from "babylonjs/Engines/Processors/Expressions/Operators/shaderDefineOrOperator";
  80738. }
  80739. declare module "babylonjs/Engines/Processors/Expressions/index" {
  80740. export * from "babylonjs/Engines/Processors/Expressions/shaderDefineExpression";
  80741. export * from "babylonjs/Engines/Processors/Expressions/Operators/index";
  80742. }
  80743. declare module "babylonjs/Engines/Processors/index" {
  80744. export * from "babylonjs/Engines/Processors/iShaderProcessor";
  80745. export * from "babylonjs/Engines/Processors/Expressions/index";
  80746. export * from "babylonjs/Engines/Processors/shaderCodeConditionNode";
  80747. export * from "babylonjs/Engines/Processors/shaderCodeCursor";
  80748. export * from "babylonjs/Engines/Processors/shaderCodeNode";
  80749. export * from "babylonjs/Engines/Processors/shaderCodeTestNode";
  80750. export * from "babylonjs/Engines/Processors/shaderProcessingOptions";
  80751. export * from "babylonjs/Engines/Processors/shaderProcessor";
  80752. export * from "babylonjs/Engines/Processors/shaderCodeInliner";
  80753. }
  80754. declare module "babylonjs/Legacy/legacy" {
  80755. import * as Babylon from "babylonjs/index";
  80756. export * from "babylonjs/index";
  80757. }
  80758. declare module "babylonjs/Shaders/blur.fragment" {
  80759. /** @hidden */
  80760. export var blurPixelShader: {
  80761. name: string;
  80762. shader: string;
  80763. };
  80764. }
  80765. declare module "babylonjs/Shaders/ShadersInclude/pointCloudVertexDeclaration" {
  80766. /** @hidden */
  80767. export var pointCloudVertexDeclaration: {
  80768. name: string;
  80769. shader: string;
  80770. };
  80771. }
  80772. declare module "babylonjs" {
  80773. export * from "babylonjs/Legacy/legacy";
  80774. }
  80775. declare module BABYLON {
  80776. /** Alias type for value that can be null */
  80777. export type Nullable<T> = T | null;
  80778. /**
  80779. * Alias type for number that are floats
  80780. * @ignorenaming
  80781. */
  80782. export type float = number;
  80783. /**
  80784. * Alias type for number that are doubles.
  80785. * @ignorenaming
  80786. */
  80787. export type double = number;
  80788. /**
  80789. * Alias type for number that are integer
  80790. * @ignorenaming
  80791. */
  80792. export type int = number;
  80793. /** Alias type for number array or Float32Array */
  80794. export type FloatArray = number[] | Float32Array;
  80795. /** Alias type for number array or Float32Array or Int32Array or Uint32Array or Uint16Array */
  80796. export type IndicesArray = number[] | Int32Array | Uint32Array | Uint16Array;
  80797. /**
  80798. * Alias for types that can be used by a Buffer or VertexBuffer.
  80799. */
  80800. export type DataArray = number[] | ArrayBuffer | ArrayBufferView;
  80801. /**
  80802. * Alias type for primitive types
  80803. * @ignorenaming
  80804. */
  80805. type Primitive = undefined | null | boolean | string | number | Function;
  80806. /**
  80807. * Type modifier to make all the properties of an object Readonly
  80808. */
  80809. export type Immutable<T> = T extends Primitive ? T : T extends Array<infer U> ? ReadonlyArray<U> : DeepImmutable<T>;
  80810. /**
  80811. * Type modifier to make all the properties of an object Readonly recursively
  80812. */
  80813. export type DeepImmutable<T> = T extends Primitive ? T : T extends Array<infer U> ? DeepImmutableArray<U> : DeepImmutableObject<T>;
  80814. /**
  80815. * Type modifier to make object properties readonly.
  80816. */
  80817. export type DeepImmutableObject<T> = {
  80818. readonly [K in keyof T]: DeepImmutable<T[K]>;
  80819. };
  80820. /** @hidden */
  80821. interface DeepImmutableArray<T> extends ReadonlyArray<DeepImmutable<T>> {
  80822. }
  80823. }
  80824. declare module BABYLON {
  80825. /**
  80826. * A class serves as a medium between the observable and its observers
  80827. */
  80828. export class EventState {
  80829. /**
  80830. * Create a new EventState
  80831. * @param mask defines the mask associated with this state
  80832. * @param skipNextObservers defines a flag which will instruct the observable to skip following observers when set to true
  80833. * @param target defines the original target of the state
  80834. * @param currentTarget defines the current target of the state
  80835. */
  80836. constructor(mask: number, skipNextObservers?: boolean, target?: any, currentTarget?: any);
  80837. /**
  80838. * Initialize the current event state
  80839. * @param mask defines the mask associated with this state
  80840. * @param skipNextObservers defines a flag which will instruct the observable to skip following observers when set to true
  80841. * @param target defines the original target of the state
  80842. * @param currentTarget defines the current target of the state
  80843. * @returns the current event state
  80844. */
  80845. initalize(mask: number, skipNextObservers?: boolean, target?: any, currentTarget?: any): EventState;
  80846. /**
  80847. * An Observer can set this property to true to prevent subsequent observers of being notified
  80848. */
  80849. skipNextObservers: boolean;
  80850. /**
  80851. * Get the mask value that were used to trigger the event corresponding to this EventState object
  80852. */
  80853. mask: number;
  80854. /**
  80855. * The object that originally notified the event
  80856. */
  80857. target?: any;
  80858. /**
  80859. * The current object in the bubbling phase
  80860. */
  80861. currentTarget?: any;
  80862. /**
  80863. * This will be populated with the return value of the last function that was executed.
  80864. * If it is the first function in the callback chain it will be the event data.
  80865. */
  80866. lastReturnValue?: any;
  80867. /**
  80868. * User defined information that will be sent to observers
  80869. */
  80870. userInfo?: any;
  80871. }
  80872. /**
  80873. * Represent an Observer registered to a given Observable object.
  80874. */
  80875. export class Observer<T> {
  80876. /**
  80877. * Defines the callback to call when the observer is notified
  80878. */
  80879. callback: (eventData: T, eventState: EventState) => void;
  80880. /**
  80881. * Defines the mask of the observer (used to filter notifications)
  80882. */
  80883. mask: number;
  80884. /**
  80885. * Defines the current scope used to restore the JS context
  80886. */
  80887. scope: any;
  80888. /** @hidden */
  80889. _willBeUnregistered: boolean;
  80890. /**
  80891. * Gets or sets a property defining that the observer as to be unregistered after the next notification
  80892. */
  80893. unregisterOnNextCall: boolean;
  80894. /**
  80895. * Creates a new observer
  80896. * @param callback defines the callback to call when the observer is notified
  80897. * @param mask defines the mask of the observer (used to filter notifications)
  80898. * @param scope defines the current scope used to restore the JS context
  80899. */
  80900. constructor(
  80901. /**
  80902. * Defines the callback to call when the observer is notified
  80903. */
  80904. callback: (eventData: T, eventState: EventState) => void,
  80905. /**
  80906. * Defines the mask of the observer (used to filter notifications)
  80907. */
  80908. mask: number,
  80909. /**
  80910. * Defines the current scope used to restore the JS context
  80911. */
  80912. scope?: any);
  80913. }
  80914. /**
  80915. * Represent a list of observers registered to multiple Observables object.
  80916. */
  80917. export class MultiObserver<T> {
  80918. private _observers;
  80919. private _observables;
  80920. /**
  80921. * Release associated resources
  80922. */
  80923. dispose(): void;
  80924. /**
  80925. * Raise a callback when one of the observable will notify
  80926. * @param observables defines a list of observables to watch
  80927. * @param callback defines the callback to call on notification
  80928. * @param mask defines the mask used to filter notifications
  80929. * @param scope defines the current scope used to restore the JS context
  80930. * @returns the new MultiObserver
  80931. */
  80932. static Watch<T>(observables: Observable<T>[], callback: (eventData: T, eventState: EventState) => void, mask?: number, scope?: any): MultiObserver<T>;
  80933. }
  80934. /**
  80935. * The Observable class is a simple implementation of the Observable pattern.
  80936. *
  80937. * 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.
  80938. * This enable a more fine grained execution without having to rely on multiple different Observable objects.
  80939. * 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).
  80940. * 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.
  80941. */
  80942. export class Observable<T> {
  80943. private _observers;
  80944. private _eventState;
  80945. private _onObserverAdded;
  80946. /**
  80947. * Gets the list of observers
  80948. */
  80949. get observers(): Array<Observer<T>>;
  80950. /**
  80951. * Creates a new observable
  80952. * @param onObserverAdded defines a callback to call when a new observer is added
  80953. */
  80954. constructor(onObserverAdded?: (observer: Observer<T>) => void);
  80955. /**
  80956. * Create a new Observer with the specified callback
  80957. * @param callback the callback that will be executed for that Observer
  80958. * @param mask the mask used to filter observers
  80959. * @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.
  80960. * @param scope optional scope for the callback to be called from
  80961. * @param unregisterOnFirstCall defines if the observer as to be unregistered after the next notification
  80962. * @returns the new observer created for the callback
  80963. */
  80964. add(callback: (eventData: T, eventState: EventState) => void, mask?: number, insertFirst?: boolean, scope?: any, unregisterOnFirstCall?: boolean): Nullable<Observer<T>>;
  80965. /**
  80966. * Create a new Observer with the specified callback and unregisters after the next notification
  80967. * @param callback the callback that will be executed for that Observer
  80968. * @returns the new observer created for the callback
  80969. */
  80970. addOnce(callback: (eventData: T, eventState: EventState) => void): Nullable<Observer<T>>;
  80971. /**
  80972. * Remove an Observer from the Observable object
  80973. * @param observer the instance of the Observer to remove
  80974. * @returns false if it doesn't belong to this Observable
  80975. */
  80976. remove(observer: Nullable<Observer<T>>): boolean;
  80977. /**
  80978. * Remove a callback from the Observable object
  80979. * @param callback the callback to remove
  80980. * @param scope optional scope. If used only the callbacks with this scope will be removed
  80981. * @returns false if it doesn't belong to this Observable
  80982. */
  80983. removeCallback(callback: (eventData: T, eventState: EventState) => void, scope?: any): boolean;
  80984. private _deferUnregister;
  80985. private _remove;
  80986. /**
  80987. * Moves the observable to the top of the observer list making it get called first when notified
  80988. * @param observer the observer to move
  80989. */
  80990. makeObserverTopPriority(observer: Observer<T>): void;
  80991. /**
  80992. * Moves the observable to the bottom of the observer list making it get called last when notified
  80993. * @param observer the observer to move
  80994. */
  80995. makeObserverBottomPriority(observer: Observer<T>): void;
  80996. /**
  80997. * Notify all Observers by calling their respective callback with the given data
  80998. * Will return true if all observers were executed, false if an observer set skipNextObservers to true, then prevent the subsequent ones to execute
  80999. * @param eventData defines the data to send to all observers
  81000. * @param mask defines the mask of the current notification (observers with incompatible mask (ie mask & observer.mask === 0) will not be notified)
  81001. * @param target defines the original target of the state
  81002. * @param currentTarget defines the current target of the state
  81003. * @param userInfo defines any user info to send to observers
  81004. * @returns false if the complete observer chain was not processed (because one observer set the skipNextObservers to true)
  81005. */
  81006. notifyObservers(eventData: T, mask?: number, target?: any, currentTarget?: any, userInfo?: any): boolean;
  81007. /**
  81008. * Calling this will execute each callback, expecting it to be a promise or return a value.
  81009. * If at any point in the chain one function fails, the promise will fail and the execution will not continue.
  81010. * This is useful when a chain of events (sometimes async events) is needed to initialize a certain object
  81011. * and it is crucial that all callbacks will be executed.
  81012. * The order of the callbacks is kept, callbacks are not executed parallel.
  81013. *
  81014. * @param eventData The data to be sent to each callback
  81015. * @param mask is used to filter observers defaults to -1
  81016. * @param target defines the callback target (see EventState)
  81017. * @param currentTarget defines he current object in the bubbling phase
  81018. * @param userInfo defines any user info to send to observers
  81019. * @returns {Promise<T>} will return a Promise than resolves when all callbacks executed successfully.
  81020. */
  81021. notifyObserversWithPromise(eventData: T, mask?: number, target?: any, currentTarget?: any, userInfo?: any): Promise<T>;
  81022. /**
  81023. * Notify a specific observer
  81024. * @param observer defines the observer to notify
  81025. * @param eventData defines the data to be sent to each callback
  81026. * @param mask is used to filter observers defaults to -1
  81027. */
  81028. notifyObserver(observer: Observer<T>, eventData: T, mask?: number): void;
  81029. /**
  81030. * Gets a boolean indicating if the observable has at least one observer
  81031. * @returns true is the Observable has at least one Observer registered
  81032. */
  81033. hasObservers(): boolean;
  81034. /**
  81035. * Clear the list of observers
  81036. */
  81037. clear(): void;
  81038. /**
  81039. * Clone the current observable
  81040. * @returns a new observable
  81041. */
  81042. clone(): Observable<T>;
  81043. /**
  81044. * Does this observable handles observer registered with a given mask
  81045. * @param mask defines the mask to be tested
  81046. * @return whether or not one observer registered with the given mask is handeled
  81047. **/
  81048. hasSpecificMask(mask?: number): boolean;
  81049. }
  81050. }
  81051. declare module BABYLON {
  81052. /**
  81053. * Sets of helpers dealing with the DOM and some of the recurrent functions needed in
  81054. * Babylon.js
  81055. */
  81056. export class DomManagement {
  81057. /**
  81058. * Checks if the window object exists
  81059. * @returns true if the window object exists
  81060. */
  81061. static IsWindowObjectExist(): boolean;
  81062. /**
  81063. * Checks if the navigator object exists
  81064. * @returns true if the navigator object exists
  81065. */
  81066. static IsNavigatorAvailable(): boolean;
  81067. /**
  81068. * Check if the document object exists
  81069. * @returns true if the document object exists
  81070. */
  81071. static IsDocumentAvailable(): boolean;
  81072. /**
  81073. * Extracts text content from a DOM element hierarchy
  81074. * @param element defines the root element
  81075. * @returns a string
  81076. */
  81077. static GetDOMTextContent(element: HTMLElement): string;
  81078. }
  81079. }
  81080. declare module BABYLON {
  81081. /**
  81082. * Logger used througouht the application to allow configuration of
  81083. * the log level required for the messages.
  81084. */
  81085. export class Logger {
  81086. /**
  81087. * No log
  81088. */
  81089. static readonly NoneLogLevel: number;
  81090. /**
  81091. * Only message logs
  81092. */
  81093. static readonly MessageLogLevel: number;
  81094. /**
  81095. * Only warning logs
  81096. */
  81097. static readonly WarningLogLevel: number;
  81098. /**
  81099. * Only error logs
  81100. */
  81101. static readonly ErrorLogLevel: number;
  81102. /**
  81103. * All logs
  81104. */
  81105. static readonly AllLogLevel: number;
  81106. private static _LogCache;
  81107. /**
  81108. * Gets a value indicating the number of loading errors
  81109. * @ignorenaming
  81110. */
  81111. static errorsCount: number;
  81112. /**
  81113. * Callback called when a new log is added
  81114. */
  81115. static OnNewCacheEntry: (entry: string) => void;
  81116. private static _AddLogEntry;
  81117. private static _FormatMessage;
  81118. private static _LogDisabled;
  81119. private static _LogEnabled;
  81120. private static _WarnDisabled;
  81121. private static _WarnEnabled;
  81122. private static _ErrorDisabled;
  81123. private static _ErrorEnabled;
  81124. /**
  81125. * Log a message to the console
  81126. */
  81127. static Log: (message: string) => void;
  81128. /**
  81129. * Write a warning message to the console
  81130. */
  81131. static Warn: (message: string) => void;
  81132. /**
  81133. * Write an error message to the console
  81134. */
  81135. static Error: (message: string) => void;
  81136. /**
  81137. * Gets current log cache (list of logs)
  81138. */
  81139. static get LogCache(): string;
  81140. /**
  81141. * Clears the log cache
  81142. */
  81143. static ClearLogCache(): void;
  81144. /**
  81145. * Sets the current log level (MessageLogLevel / WarningLogLevel / ErrorLogLevel)
  81146. */
  81147. static set LogLevels(level: number);
  81148. }
  81149. }
  81150. declare module BABYLON {
  81151. /** @hidden */
  81152. export class _TypeStore {
  81153. /** @hidden */
  81154. static RegisteredTypes: {
  81155. [key: string]: Object;
  81156. };
  81157. /** @hidden */
  81158. static GetClass(fqdn: string): any;
  81159. }
  81160. }
  81161. declare module BABYLON {
  81162. /**
  81163. * Helper to manipulate strings
  81164. */
  81165. export class StringTools {
  81166. /**
  81167. * Checks for a matching suffix at the end of a string (for ES5 and lower)
  81168. * @param str Source string
  81169. * @param suffix Suffix to search for in the source string
  81170. * @returns Boolean indicating whether the suffix was found (true) or not (false)
  81171. */
  81172. static EndsWith(str: string, suffix: string): boolean;
  81173. /**
  81174. * Checks for a matching suffix at the beginning of a string (for ES5 and lower)
  81175. * @param str Source string
  81176. * @param suffix Suffix to search for in the source string
  81177. * @returns Boolean indicating whether the suffix was found (true) or not (false)
  81178. */
  81179. static StartsWith(str: string, suffix: string): boolean;
  81180. /**
  81181. * Decodes a buffer into a string
  81182. * @param buffer The buffer to decode
  81183. * @returns The decoded string
  81184. */
  81185. static Decode(buffer: Uint8Array | Uint16Array): string;
  81186. /**
  81187. * Encode a buffer to a base64 string
  81188. * @param buffer defines the buffer to encode
  81189. * @returns the encoded string
  81190. */
  81191. static EncodeArrayBufferToBase64(buffer: ArrayBuffer | ArrayBufferView): string;
  81192. /**
  81193. * Converts a number to string and pads with preceeding zeroes until it is of specified length.
  81194. * @param num the number to convert and pad
  81195. * @param length the expected length of the string
  81196. * @returns the padded string
  81197. */
  81198. static PadNumber(num: number, length: number): string;
  81199. }
  81200. }
  81201. declare module BABYLON {
  81202. /**
  81203. * Class containing a set of static utilities functions for deep copy.
  81204. */
  81205. export class DeepCopier {
  81206. /**
  81207. * Tries to copy an object by duplicating every property
  81208. * @param source defines the source object
  81209. * @param destination defines the target object
  81210. * @param doNotCopyList defines a list of properties to avoid
  81211. * @param mustCopyList defines a list of properties to copy (even if they start with _)
  81212. */
  81213. static DeepCopy(source: any, destination: any, doNotCopyList?: string[], mustCopyList?: string[]): void;
  81214. }
  81215. }
  81216. declare module BABYLON {
  81217. /**
  81218. * Class containing a set of static utilities functions for precision date
  81219. */
  81220. export class PrecisionDate {
  81221. /**
  81222. * Gets either window.performance.now() if supported or Date.now() else
  81223. */
  81224. static get Now(): number;
  81225. }
  81226. }
  81227. declare module BABYLON {
  81228. /** @hidden */
  81229. export class _DevTools {
  81230. static WarnImport(name: string): string;
  81231. }
  81232. }
  81233. declare module BABYLON {
  81234. /**
  81235. * Interface used to define the mechanism to get data from the network
  81236. */
  81237. export interface IWebRequest {
  81238. /**
  81239. * Returns client's response url
  81240. */
  81241. responseURL: string;
  81242. /**
  81243. * Returns client's status
  81244. */
  81245. status: number;
  81246. /**
  81247. * Returns client's status as a text
  81248. */
  81249. statusText: string;
  81250. }
  81251. }
  81252. declare module BABYLON {
  81253. /**
  81254. * Extended version of XMLHttpRequest with support for customizations (headers, ...)
  81255. */
  81256. export class WebRequest implements IWebRequest {
  81257. private _xhr;
  81258. /**
  81259. * Custom HTTP Request Headers to be sent with XMLHttpRequests
  81260. * i.e. when loading files, where the server/service expects an Authorization header
  81261. */
  81262. static CustomRequestHeaders: {
  81263. [key: string]: string;
  81264. };
  81265. /**
  81266. * Add callback functions in this array to update all the requests before they get sent to the network
  81267. */
  81268. static CustomRequestModifiers: ((request: XMLHttpRequest, url: string) => void)[];
  81269. private _injectCustomRequestHeaders;
  81270. /**
  81271. * Gets or sets a function to be called when loading progress changes
  81272. */
  81273. get onprogress(): ((this: XMLHttpRequest, ev: ProgressEvent) => any) | null;
  81274. set onprogress(value: ((this: XMLHttpRequest, ev: ProgressEvent) => any) | null);
  81275. /**
  81276. * Returns client's state
  81277. */
  81278. get readyState(): number;
  81279. /**
  81280. * Returns client's status
  81281. */
  81282. get status(): number;
  81283. /**
  81284. * Returns client's status as a text
  81285. */
  81286. get statusText(): string;
  81287. /**
  81288. * Returns client's response
  81289. */
  81290. get response(): any;
  81291. /**
  81292. * Returns client's response url
  81293. */
  81294. get responseURL(): string;
  81295. /**
  81296. * Returns client's response as text
  81297. */
  81298. get responseText(): string;
  81299. /**
  81300. * Gets or sets the expected response type
  81301. */
  81302. get responseType(): XMLHttpRequestResponseType;
  81303. set responseType(value: XMLHttpRequestResponseType);
  81304. /** @hidden */
  81305. addEventListener<K extends keyof XMLHttpRequestEventMap>(type: K, listener: (this: XMLHttpRequest, ev: XMLHttpRequestEventMap[K]) => any, options?: boolean | AddEventListenerOptions): void;
  81306. /** @hidden */
  81307. removeEventListener<K extends keyof XMLHttpRequestEventMap>(type: K, listener: (this: XMLHttpRequest, ev: XMLHttpRequestEventMap[K]) => any, options?: boolean | EventListenerOptions): void;
  81308. /**
  81309. * Cancels any network activity
  81310. */
  81311. abort(): void;
  81312. /**
  81313. * Initiates the request. The optional argument provides the request body. The argument is ignored if request method is GET or HEAD
  81314. * @param body defines an optional request body
  81315. */
  81316. send(body?: Document | BodyInit | null): void;
  81317. /**
  81318. * Sets the request method, request URL
  81319. * @param method defines the method to use (GET, POST, etc..)
  81320. * @param url defines the url to connect with
  81321. */
  81322. open(method: string, url: string): void;
  81323. /**
  81324. * Sets the value of a request header.
  81325. * @param name The name of the header whose value is to be set
  81326. * @param value The value to set as the body of the header
  81327. */
  81328. setRequestHeader(name: string, value: string): void;
  81329. /**
  81330. * Get the string containing the text of a particular header's value.
  81331. * @param name The name of the header
  81332. * @returns The string containing the text of the given header name
  81333. */
  81334. getResponseHeader(name: string): Nullable<string>;
  81335. }
  81336. }
  81337. declare module BABYLON {
  81338. /**
  81339. * File request interface
  81340. */
  81341. export interface IFileRequest {
  81342. /**
  81343. * Raised when the request is complete (success or error).
  81344. */
  81345. onCompleteObservable: Observable<IFileRequest>;
  81346. /**
  81347. * Aborts the request for a file.
  81348. */
  81349. abort: () => void;
  81350. }
  81351. }
  81352. declare module BABYLON {
  81353. /**
  81354. * Define options used to create a render target texture
  81355. */
  81356. export class RenderTargetCreationOptions {
  81357. /**
  81358. * Specifies is mipmaps must be generated
  81359. */
  81360. generateMipMaps?: boolean;
  81361. /** Specifies whether or not a depth should be allocated in the texture (true by default) */
  81362. generateDepthBuffer?: boolean;
  81363. /** Specifies whether or not a stencil should be allocated in the texture (false by default)*/
  81364. generateStencilBuffer?: boolean;
  81365. /** Defines texture type (int by default) */
  81366. type?: number;
  81367. /** Defines sampling mode (trilinear by default) */
  81368. samplingMode?: number;
  81369. /** Defines format (RGBA by default) */
  81370. format?: number;
  81371. }
  81372. }
  81373. declare module BABYLON {
  81374. /** Defines the cross module used constants to avoid circular dependncies */
  81375. export class Constants {
  81376. /** Defines that alpha blending is disabled */
  81377. static readonly ALPHA_DISABLE: number;
  81378. /** Defines that alpha blending is SRC ALPHA * SRC + DEST */
  81379. static readonly ALPHA_ADD: number;
  81380. /** Defines that alpha blending is SRC ALPHA * SRC + (1 - SRC ALPHA) * DEST */
  81381. static readonly ALPHA_COMBINE: number;
  81382. /** Defines that alpha blending is DEST - SRC * DEST */
  81383. static readonly ALPHA_SUBTRACT: number;
  81384. /** Defines that alpha blending is SRC * DEST */
  81385. static readonly ALPHA_MULTIPLY: number;
  81386. /** Defines that alpha blending is SRC ALPHA * SRC + (1 - SRC) * DEST */
  81387. static readonly ALPHA_MAXIMIZED: number;
  81388. /** Defines that alpha blending is SRC + DEST */
  81389. static readonly ALPHA_ONEONE: number;
  81390. /** Defines that alpha blending is SRC + (1 - SRC ALPHA) * DEST */
  81391. static readonly ALPHA_PREMULTIPLIED: number;
  81392. /**
  81393. * Defines that alpha blending is SRC + (1 - SRC ALPHA) * DEST
  81394. * Alpha will be set to (1 - SRC ALPHA) * DEST ALPHA
  81395. */
  81396. static readonly ALPHA_PREMULTIPLIED_PORTERDUFF: number;
  81397. /** Defines that alpha blending is CST * SRC + (1 - CST) * DEST */
  81398. static readonly ALPHA_INTERPOLATE: number;
  81399. /**
  81400. * Defines that alpha blending is SRC + (1 - SRC) * DEST
  81401. * Alpha will be set to SRC ALPHA + (1 - SRC ALPHA) * DEST ALPHA
  81402. */
  81403. static readonly ALPHA_SCREENMODE: number;
  81404. /**
  81405. * Defines that alpha blending is SRC + DST
  81406. * Alpha will be set to SRC ALPHA + DST ALPHA
  81407. */
  81408. static readonly ALPHA_ONEONE_ONEONE: number;
  81409. /**
  81410. * Defines that alpha blending is SRC * DST ALPHA + DST
  81411. * Alpha will be set to 0
  81412. */
  81413. static readonly ALPHA_ALPHATOCOLOR: number;
  81414. /**
  81415. * Defines that alpha blending is SRC * (1 - DST) + DST * (1 - SRC)
  81416. */
  81417. static readonly ALPHA_REVERSEONEMINUS: number;
  81418. /**
  81419. * Defines that alpha blending is SRC + DST * (1 - SRC ALPHA)
  81420. * Alpha will be set to SRC ALPHA + DST ALPHA * (1 - SRC ALPHA)
  81421. */
  81422. static readonly ALPHA_SRC_DSTONEMINUSSRCALPHA: number;
  81423. /**
  81424. * Defines that alpha blending is SRC + DST
  81425. * Alpha will be set to SRC ALPHA
  81426. */
  81427. static readonly ALPHA_ONEONE_ONEZERO: number;
  81428. /**
  81429. * Defines that alpha blending is SRC * (1 - DST) + DST * (1 - SRC)
  81430. * Alpha will be set to DST ALPHA
  81431. */
  81432. static readonly ALPHA_EXCLUSION: number;
  81433. /** Defines that alpha blending equation a SUM */
  81434. static readonly ALPHA_EQUATION_ADD: number;
  81435. /** Defines that alpha blending equation a SUBSTRACTION */
  81436. static readonly ALPHA_EQUATION_SUBSTRACT: number;
  81437. /** Defines that alpha blending equation a REVERSE SUBSTRACTION */
  81438. static readonly ALPHA_EQUATION_REVERSE_SUBTRACT: number;
  81439. /** Defines that alpha blending equation a MAX operation */
  81440. static readonly ALPHA_EQUATION_MAX: number;
  81441. /** Defines that alpha blending equation a MIN operation */
  81442. static readonly ALPHA_EQUATION_MIN: number;
  81443. /**
  81444. * Defines that alpha blending equation a DARKEN operation:
  81445. * It takes the min of the src and sums the alpha channels.
  81446. */
  81447. static readonly ALPHA_EQUATION_DARKEN: number;
  81448. /** Defines that the ressource is not delayed*/
  81449. static readonly DELAYLOADSTATE_NONE: number;
  81450. /** Defines that the ressource was successfully delay loaded */
  81451. static readonly DELAYLOADSTATE_LOADED: number;
  81452. /** Defines that the ressource is currently delay loading */
  81453. static readonly DELAYLOADSTATE_LOADING: number;
  81454. /** Defines that the ressource is delayed and has not started loading */
  81455. static readonly DELAYLOADSTATE_NOTLOADED: number;
  81456. /** Passed to depthFunction or stencilFunction to specify depth or stencil tests will never pass. i.e. Nothing will be drawn */
  81457. static readonly NEVER: number;
  81458. /** 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 */
  81459. static readonly ALWAYS: number;
  81460. /** Passed to depthFunction or stencilFunction to specify depth or stencil tests will pass if the new depth value is less than the stored value */
  81461. static readonly LESS: number;
  81462. /** Passed to depthFunction or stencilFunction to specify depth or stencil tests will pass if the new depth value is equals to the stored value */
  81463. static readonly EQUAL: number;
  81464. /** 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 */
  81465. static readonly LEQUAL: number;
  81466. /** Passed to depthFunction or stencilFunction to specify depth or stencil tests will pass if the new depth value is greater than the stored value */
  81467. static readonly GREATER: number;
  81468. /** 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 */
  81469. static readonly GEQUAL: number;
  81470. /** 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 */
  81471. static readonly NOTEQUAL: number;
  81472. /** Passed to stencilOperation to specify that stencil value must be kept */
  81473. static readonly KEEP: number;
  81474. /** Passed to stencilOperation to specify that stencil value must be replaced */
  81475. static readonly REPLACE: number;
  81476. /** Passed to stencilOperation to specify that stencil value must be incremented */
  81477. static readonly INCR: number;
  81478. /** Passed to stencilOperation to specify that stencil value must be decremented */
  81479. static readonly DECR: number;
  81480. /** Passed to stencilOperation to specify that stencil value must be inverted */
  81481. static readonly INVERT: number;
  81482. /** Passed to stencilOperation to specify that stencil value must be incremented with wrapping */
  81483. static readonly INCR_WRAP: number;
  81484. /** Passed to stencilOperation to specify that stencil value must be decremented with wrapping */
  81485. static readonly DECR_WRAP: number;
  81486. /** Texture is not repeating outside of 0..1 UVs */
  81487. static readonly TEXTURE_CLAMP_ADDRESSMODE: number;
  81488. /** Texture is repeating outside of 0..1 UVs */
  81489. static readonly TEXTURE_WRAP_ADDRESSMODE: number;
  81490. /** Texture is repeating and mirrored */
  81491. static readonly TEXTURE_MIRROR_ADDRESSMODE: number;
  81492. /** ALPHA */
  81493. static readonly TEXTUREFORMAT_ALPHA: number;
  81494. /** LUMINANCE */
  81495. static readonly TEXTUREFORMAT_LUMINANCE: number;
  81496. /** LUMINANCE_ALPHA */
  81497. static readonly TEXTUREFORMAT_LUMINANCE_ALPHA: number;
  81498. /** RGB */
  81499. static readonly TEXTUREFORMAT_RGB: number;
  81500. /** RGBA */
  81501. static readonly TEXTUREFORMAT_RGBA: number;
  81502. /** RED */
  81503. static readonly TEXTUREFORMAT_RED: number;
  81504. /** RED (2nd reference) */
  81505. static readonly TEXTUREFORMAT_R: number;
  81506. /** RG */
  81507. static readonly TEXTUREFORMAT_RG: number;
  81508. /** RED_INTEGER */
  81509. static readonly TEXTUREFORMAT_RED_INTEGER: number;
  81510. /** RED_INTEGER (2nd reference) */
  81511. static readonly TEXTUREFORMAT_R_INTEGER: number;
  81512. /** RG_INTEGER */
  81513. static readonly TEXTUREFORMAT_RG_INTEGER: number;
  81514. /** RGB_INTEGER */
  81515. static readonly TEXTUREFORMAT_RGB_INTEGER: number;
  81516. /** RGBA_INTEGER */
  81517. static readonly TEXTUREFORMAT_RGBA_INTEGER: number;
  81518. /** UNSIGNED_BYTE */
  81519. static readonly TEXTURETYPE_UNSIGNED_BYTE: number;
  81520. /** UNSIGNED_BYTE (2nd reference) */
  81521. static readonly TEXTURETYPE_UNSIGNED_INT: number;
  81522. /** FLOAT */
  81523. static readonly TEXTURETYPE_FLOAT: number;
  81524. /** HALF_FLOAT */
  81525. static readonly TEXTURETYPE_HALF_FLOAT: number;
  81526. /** BYTE */
  81527. static readonly TEXTURETYPE_BYTE: number;
  81528. /** SHORT */
  81529. static readonly TEXTURETYPE_SHORT: number;
  81530. /** UNSIGNED_SHORT */
  81531. static readonly TEXTURETYPE_UNSIGNED_SHORT: number;
  81532. /** INT */
  81533. static readonly TEXTURETYPE_INT: number;
  81534. /** UNSIGNED_INT */
  81535. static readonly TEXTURETYPE_UNSIGNED_INTEGER: number;
  81536. /** UNSIGNED_SHORT_4_4_4_4 */
  81537. static readonly TEXTURETYPE_UNSIGNED_SHORT_4_4_4_4: number;
  81538. /** UNSIGNED_SHORT_5_5_5_1 */
  81539. static readonly TEXTURETYPE_UNSIGNED_SHORT_5_5_5_1: number;
  81540. /** UNSIGNED_SHORT_5_6_5 */
  81541. static readonly TEXTURETYPE_UNSIGNED_SHORT_5_6_5: number;
  81542. /** UNSIGNED_INT_2_10_10_10_REV */
  81543. static readonly TEXTURETYPE_UNSIGNED_INT_2_10_10_10_REV: number;
  81544. /** UNSIGNED_INT_24_8 */
  81545. static readonly TEXTURETYPE_UNSIGNED_INT_24_8: number;
  81546. /** UNSIGNED_INT_10F_11F_11F_REV */
  81547. static readonly TEXTURETYPE_UNSIGNED_INT_10F_11F_11F_REV: number;
  81548. /** UNSIGNED_INT_5_9_9_9_REV */
  81549. static readonly TEXTURETYPE_UNSIGNED_INT_5_9_9_9_REV: number;
  81550. /** FLOAT_32_UNSIGNED_INT_24_8_REV */
  81551. static readonly TEXTURETYPE_FLOAT_32_UNSIGNED_INT_24_8_REV: number;
  81552. /** nearest is mag = nearest and min = nearest and no mip */
  81553. static readonly TEXTURE_NEAREST_SAMPLINGMODE: number;
  81554. /** mag = nearest and min = nearest and mip = none */
  81555. static readonly TEXTURE_NEAREST_NEAREST: number;
  81556. /** Bilinear is mag = linear and min = linear and no mip */
  81557. static readonly TEXTURE_BILINEAR_SAMPLINGMODE: number;
  81558. /** mag = linear and min = linear and mip = none */
  81559. static readonly TEXTURE_LINEAR_LINEAR: number;
  81560. /** Trilinear is mag = linear and min = linear and mip = linear */
  81561. static readonly TEXTURE_TRILINEAR_SAMPLINGMODE: number;
  81562. /** Trilinear is mag = linear and min = linear and mip = linear */
  81563. static readonly TEXTURE_LINEAR_LINEAR_MIPLINEAR: number;
  81564. /** mag = nearest and min = nearest and mip = nearest */
  81565. static readonly TEXTURE_NEAREST_NEAREST_MIPNEAREST: number;
  81566. /** mag = nearest and min = linear and mip = nearest */
  81567. static readonly TEXTURE_NEAREST_LINEAR_MIPNEAREST: number;
  81568. /** mag = nearest and min = linear and mip = linear */
  81569. static readonly TEXTURE_NEAREST_LINEAR_MIPLINEAR: number;
  81570. /** mag = nearest and min = linear and mip = none */
  81571. static readonly TEXTURE_NEAREST_LINEAR: number;
  81572. /** nearest is mag = nearest and min = nearest and mip = linear */
  81573. static readonly TEXTURE_NEAREST_NEAREST_MIPLINEAR: number;
  81574. /** mag = linear and min = nearest and mip = nearest */
  81575. static readonly TEXTURE_LINEAR_NEAREST_MIPNEAREST: number;
  81576. /** mag = linear and min = nearest and mip = linear */
  81577. static readonly TEXTURE_LINEAR_NEAREST_MIPLINEAR: number;
  81578. /** Bilinear is mag = linear and min = linear and mip = nearest */
  81579. static readonly TEXTURE_LINEAR_LINEAR_MIPNEAREST: number;
  81580. /** mag = linear and min = nearest and mip = none */
  81581. static readonly TEXTURE_LINEAR_NEAREST: number;
  81582. /** Explicit coordinates mode */
  81583. static readonly TEXTURE_EXPLICIT_MODE: number;
  81584. /** Spherical coordinates mode */
  81585. static readonly TEXTURE_SPHERICAL_MODE: number;
  81586. /** Planar coordinates mode */
  81587. static readonly TEXTURE_PLANAR_MODE: number;
  81588. /** Cubic coordinates mode */
  81589. static readonly TEXTURE_CUBIC_MODE: number;
  81590. /** Projection coordinates mode */
  81591. static readonly TEXTURE_PROJECTION_MODE: number;
  81592. /** Skybox coordinates mode */
  81593. static readonly TEXTURE_SKYBOX_MODE: number;
  81594. /** Inverse Cubic coordinates mode */
  81595. static readonly TEXTURE_INVCUBIC_MODE: number;
  81596. /** Equirectangular coordinates mode */
  81597. static readonly TEXTURE_EQUIRECTANGULAR_MODE: number;
  81598. /** Equirectangular Fixed coordinates mode */
  81599. static readonly TEXTURE_FIXED_EQUIRECTANGULAR_MODE: number;
  81600. /** Equirectangular Fixed Mirrored coordinates mode */
  81601. static readonly TEXTURE_FIXED_EQUIRECTANGULAR_MIRRORED_MODE: number;
  81602. /** Offline (baking) quality for texture filtering */
  81603. static readonly TEXTURE_FILTERING_QUALITY_OFFLINE: number;
  81604. /** High quality for texture filtering */
  81605. static readonly TEXTURE_FILTERING_QUALITY_HIGH: number;
  81606. /** Medium quality for texture filtering */
  81607. static readonly TEXTURE_FILTERING_QUALITY_MEDIUM: number;
  81608. /** Low quality for texture filtering */
  81609. static readonly TEXTURE_FILTERING_QUALITY_LOW: number;
  81610. /** Defines that texture rescaling will use a floor to find the closer power of 2 size */
  81611. static readonly SCALEMODE_FLOOR: number;
  81612. /** Defines that texture rescaling will look for the nearest power of 2 size */
  81613. static readonly SCALEMODE_NEAREST: number;
  81614. /** Defines that texture rescaling will use a ceil to find the closer power of 2 size */
  81615. static readonly SCALEMODE_CEILING: number;
  81616. /**
  81617. * The dirty texture flag value
  81618. */
  81619. static readonly MATERIAL_TextureDirtyFlag: number;
  81620. /**
  81621. * The dirty light flag value
  81622. */
  81623. static readonly MATERIAL_LightDirtyFlag: number;
  81624. /**
  81625. * The dirty fresnel flag value
  81626. */
  81627. static readonly MATERIAL_FresnelDirtyFlag: number;
  81628. /**
  81629. * The dirty attribute flag value
  81630. */
  81631. static readonly MATERIAL_AttributesDirtyFlag: number;
  81632. /**
  81633. * The dirty misc flag value
  81634. */
  81635. static readonly MATERIAL_MiscDirtyFlag: number;
  81636. /**
  81637. * The dirty prepass flag value
  81638. */
  81639. static readonly MATERIAL_PrePassDirtyFlag: number;
  81640. /**
  81641. * The all dirty flag value
  81642. */
  81643. static readonly MATERIAL_AllDirtyFlag: number;
  81644. /**
  81645. * Returns the triangle fill mode
  81646. */
  81647. static readonly MATERIAL_TriangleFillMode: number;
  81648. /**
  81649. * Returns the wireframe mode
  81650. */
  81651. static readonly MATERIAL_WireFrameFillMode: number;
  81652. /**
  81653. * Returns the point fill mode
  81654. */
  81655. static readonly MATERIAL_PointFillMode: number;
  81656. /**
  81657. * Returns the point list draw mode
  81658. */
  81659. static readonly MATERIAL_PointListDrawMode: number;
  81660. /**
  81661. * Returns the line list draw mode
  81662. */
  81663. static readonly MATERIAL_LineListDrawMode: number;
  81664. /**
  81665. * Returns the line loop draw mode
  81666. */
  81667. static readonly MATERIAL_LineLoopDrawMode: number;
  81668. /**
  81669. * Returns the line strip draw mode
  81670. */
  81671. static readonly MATERIAL_LineStripDrawMode: number;
  81672. /**
  81673. * Returns the triangle strip draw mode
  81674. */
  81675. static readonly MATERIAL_TriangleStripDrawMode: number;
  81676. /**
  81677. * Returns the triangle fan draw mode
  81678. */
  81679. static readonly MATERIAL_TriangleFanDrawMode: number;
  81680. /**
  81681. * Stores the clock-wise side orientation
  81682. */
  81683. static readonly MATERIAL_ClockWiseSideOrientation: number;
  81684. /**
  81685. * Stores the counter clock-wise side orientation
  81686. */
  81687. static readonly MATERIAL_CounterClockWiseSideOrientation: number;
  81688. /**
  81689. * Nothing
  81690. * @see https://doc.babylonjs.com/how_to/how_to_use_actions#triggers
  81691. */
  81692. static readonly ACTION_NothingTrigger: number;
  81693. /**
  81694. * On pick
  81695. * @see https://doc.babylonjs.com/how_to/how_to_use_actions#triggers
  81696. */
  81697. static readonly ACTION_OnPickTrigger: number;
  81698. /**
  81699. * On left pick
  81700. * @see https://doc.babylonjs.com/how_to/how_to_use_actions#triggers
  81701. */
  81702. static readonly ACTION_OnLeftPickTrigger: number;
  81703. /**
  81704. * On right pick
  81705. * @see https://doc.babylonjs.com/how_to/how_to_use_actions#triggers
  81706. */
  81707. static readonly ACTION_OnRightPickTrigger: number;
  81708. /**
  81709. * On center pick
  81710. * @see https://doc.babylonjs.com/how_to/how_to_use_actions#triggers
  81711. */
  81712. static readonly ACTION_OnCenterPickTrigger: number;
  81713. /**
  81714. * On pick down
  81715. * @see https://doc.babylonjs.com/how_to/how_to_use_actions#triggers
  81716. */
  81717. static readonly ACTION_OnPickDownTrigger: number;
  81718. /**
  81719. * On double pick
  81720. * @see https://doc.babylonjs.com/how_to/how_to_use_actions#triggers
  81721. */
  81722. static readonly ACTION_OnDoublePickTrigger: number;
  81723. /**
  81724. * On pick up
  81725. * @see https://doc.babylonjs.com/how_to/how_to_use_actions#triggers
  81726. */
  81727. static readonly ACTION_OnPickUpTrigger: number;
  81728. /**
  81729. * On pick out.
  81730. * This trigger will only be raised if you also declared a OnPickDown
  81731. * @see https://doc.babylonjs.com/how_to/how_to_use_actions#triggers
  81732. */
  81733. static readonly ACTION_OnPickOutTrigger: number;
  81734. /**
  81735. * On long press
  81736. * @see https://doc.babylonjs.com/how_to/how_to_use_actions#triggers
  81737. */
  81738. static readonly ACTION_OnLongPressTrigger: number;
  81739. /**
  81740. * On pointer over
  81741. * @see https://doc.babylonjs.com/how_to/how_to_use_actions#triggers
  81742. */
  81743. static readonly ACTION_OnPointerOverTrigger: number;
  81744. /**
  81745. * On pointer out
  81746. * @see https://doc.babylonjs.com/how_to/how_to_use_actions#triggers
  81747. */
  81748. static readonly ACTION_OnPointerOutTrigger: number;
  81749. /**
  81750. * On every frame
  81751. * @see https://doc.babylonjs.com/how_to/how_to_use_actions#triggers
  81752. */
  81753. static readonly ACTION_OnEveryFrameTrigger: number;
  81754. /**
  81755. * On intersection enter
  81756. * @see https://doc.babylonjs.com/how_to/how_to_use_actions#triggers
  81757. */
  81758. static readonly ACTION_OnIntersectionEnterTrigger: number;
  81759. /**
  81760. * On intersection exit
  81761. * @see https://doc.babylonjs.com/how_to/how_to_use_actions#triggers
  81762. */
  81763. static readonly ACTION_OnIntersectionExitTrigger: number;
  81764. /**
  81765. * On key down
  81766. * @see https://doc.babylonjs.com/how_to/how_to_use_actions#triggers
  81767. */
  81768. static readonly ACTION_OnKeyDownTrigger: number;
  81769. /**
  81770. * On key up
  81771. * @see https://doc.babylonjs.com/how_to/how_to_use_actions#triggers
  81772. */
  81773. static readonly ACTION_OnKeyUpTrigger: number;
  81774. /**
  81775. * Billboard mode will only apply to Y axis
  81776. */
  81777. static readonly PARTICLES_BILLBOARDMODE_Y: number;
  81778. /**
  81779. * Billboard mode will apply to all axes
  81780. */
  81781. static readonly PARTICLES_BILLBOARDMODE_ALL: number;
  81782. /**
  81783. * Special billboard mode where the particle will be biilboard to the camera but rotated to align with direction
  81784. */
  81785. static readonly PARTICLES_BILLBOARDMODE_STRETCHED: number;
  81786. /** Default culling strategy : this is an exclusion test and it's the more accurate.
  81787. * Test order :
  81788. * Is the bounding sphere outside the frustum ?
  81789. * If not, are the bounding box vertices outside the frustum ?
  81790. * It not, then the cullable object is in the frustum.
  81791. */
  81792. static readonly MESHES_CULLINGSTRATEGY_STANDARD: number;
  81793. /** Culling strategy : Bounding Sphere Only.
  81794. * This is an exclusion test. It's faster than the standard strategy because the bounding box is not tested.
  81795. * It's also less accurate than the standard because some not visible objects can still be selected.
  81796. * Test : is the bounding sphere outside the frustum ?
  81797. * If not, then the cullable object is in the frustum.
  81798. */
  81799. static readonly MESHES_CULLINGSTRATEGY_BOUNDINGSPHERE_ONLY: number;
  81800. /** Culling strategy : Optimistic Inclusion.
  81801. * This in an inclusion test first, then the standard exclusion test.
  81802. * This can be faster when a cullable object is expected to be almost always in the camera frustum.
  81803. * 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.
  81804. * Anyway, it's as accurate as the standard strategy.
  81805. * Test :
  81806. * Is the cullable object bounding sphere center in the frustum ?
  81807. * If not, apply the default culling strategy.
  81808. */
  81809. static readonly MESHES_CULLINGSTRATEGY_OPTIMISTIC_INCLUSION: number;
  81810. /** Culling strategy : Optimistic Inclusion then Bounding Sphere Only.
  81811. * This in an inclusion test first, then the bounding sphere only exclusion test.
  81812. * This can be the fastest test when a cullable object is expected to be almost always in the camera frustum.
  81813. * 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.
  81814. * It's less accurate than the standard strategy and as accurate as the BoundingSphereOnly strategy.
  81815. * Test :
  81816. * Is the cullable object bounding sphere center in the frustum ?
  81817. * If not, apply the Bounding Sphere Only strategy. No Bounding Box is tested here.
  81818. */
  81819. static readonly MESHES_CULLINGSTRATEGY_OPTIMISTIC_INCLUSION_THEN_BSPHERE_ONLY: number;
  81820. /**
  81821. * No logging while loading
  81822. */
  81823. static readonly SCENELOADER_NO_LOGGING: number;
  81824. /**
  81825. * Minimal logging while loading
  81826. */
  81827. static readonly SCENELOADER_MINIMAL_LOGGING: number;
  81828. /**
  81829. * Summary logging while loading
  81830. */
  81831. static readonly SCENELOADER_SUMMARY_LOGGING: number;
  81832. /**
  81833. * Detailled logging while loading
  81834. */
  81835. static readonly SCENELOADER_DETAILED_LOGGING: number;
  81836. /**
  81837. * Constant used to retrieve the irradiance texture index in the textures array in the prepass
  81838. * using getIndex(Constants.PREPASS_IRRADIANCE_TEXTURE_TYPE)
  81839. */
  81840. static readonly PREPASS_IRRADIANCE_TEXTURE_TYPE: number;
  81841. /**
  81842. * Constant used to retrieve the position texture index in the textures array in the prepass
  81843. * using getIndex(Constants.PREPASS_POSITION_TEXTURE_INDEX)
  81844. */
  81845. static readonly PREPASS_POSITION_TEXTURE_TYPE: number;
  81846. /**
  81847. * Constant used to retrieve the velocity texture index in the textures array in the prepass
  81848. * using getIndex(Constants.PREPASS_VELOCITY_TEXTURE_INDEX)
  81849. */
  81850. static readonly PREPASS_VELOCITY_TEXTURE_TYPE: number;
  81851. /**
  81852. * Constant used to retrieve the reflectivity texture index in the textures array in the prepass
  81853. * using the getIndex(Constants.PREPASS_REFLECTIVITY_TEXTURE_TYPE)
  81854. */
  81855. static readonly PREPASS_REFLECTIVITY_TEXTURE_TYPE: number;
  81856. /**
  81857. * Constant used to retrieve the lit color texture index in the textures array in the prepass
  81858. * using the getIndex(Constants.PREPASS_COLOR_TEXTURE_TYPE)
  81859. */
  81860. static readonly PREPASS_COLOR_TEXTURE_TYPE: number;
  81861. /**
  81862. * Constant used to retrieve depth + normal index in the textures array in the prepass
  81863. * using the getIndex(Constants.PREPASS_DEPTHNORMAL_TEXTURE_TYPE)
  81864. */
  81865. static readonly PREPASS_DEPTHNORMAL_TEXTURE_TYPE: number;
  81866. /**
  81867. * Constant used to retrieve albedo index in the textures array in the prepass
  81868. * using the getIndex(Constants.PREPASS_ALBEDO_TEXTURE_TYPE)
  81869. */
  81870. static readonly PREPASS_ALBEDO_TEXTURE_TYPE: number;
  81871. }
  81872. }
  81873. declare module BABYLON {
  81874. /**
  81875. * This represents the required contract to create a new type of texture loader.
  81876. */
  81877. export interface IInternalTextureLoader {
  81878. /**
  81879. * Defines wether the loader supports cascade loading the different faces.
  81880. */
  81881. supportCascades: boolean;
  81882. /**
  81883. * This returns if the loader support the current file information.
  81884. * @param extension defines the file extension of the file being loaded
  81885. * @param mimeType defines the optional mime type of the file being loaded
  81886. * @returns true if the loader can load the specified file
  81887. */
  81888. canLoad(extension: string, mimeType?: string): boolean;
  81889. /**
  81890. * Uploads the cube texture data to the WebGL texture. It has already been bound.
  81891. * @param data contains the texture data
  81892. * @param texture defines the BabylonJS internal texture
  81893. * @param createPolynomials will be true if polynomials have been requested
  81894. * @param onLoad defines the callback to trigger once the texture is ready
  81895. * @param onError defines the callback to trigger in case of error
  81896. */
  81897. loadCubeData(data: ArrayBufferView | ArrayBufferView[], texture: InternalTexture, createPolynomials: boolean, onLoad: Nullable<(data?: any) => void>, onError: Nullable<(message?: string, exception?: any) => void>): void;
  81898. /**
  81899. * Uploads the 2D texture data to the WebGL texture. It has already been bound once in the callback.
  81900. * @param data contains the texture data
  81901. * @param texture defines the BabylonJS internal texture
  81902. * @param callback defines the method to call once ready to upload
  81903. */
  81904. loadData(data: ArrayBufferView, texture: InternalTexture, callback: (width: number, height: number, loadMipmap: boolean, isCompressed: boolean, done: () => void, loadFailed?: boolean) => void): void;
  81905. }
  81906. }
  81907. declare module BABYLON {
  81908. /**
  81909. * Class used to store and describe the pipeline context associated with an effect
  81910. */
  81911. export interface IPipelineContext {
  81912. /**
  81913. * Gets a boolean indicating that this pipeline context is supporting asynchronous creating
  81914. */
  81915. isAsync: boolean;
  81916. /**
  81917. * Gets a boolean indicating that the context is ready to be used (like shaders / pipelines are compiled and ready for instance)
  81918. */
  81919. isReady: boolean;
  81920. /** @hidden */
  81921. _getVertexShaderCode(): string | null;
  81922. /** @hidden */
  81923. _getFragmentShaderCode(): string | null;
  81924. /** @hidden */
  81925. _handlesSpectorRebuildCallback(onCompiled: (compiledObject: any) => void): void;
  81926. }
  81927. }
  81928. declare module BABYLON {
  81929. /**
  81930. * Class used to store gfx data (like WebGLBuffer)
  81931. */
  81932. export class DataBuffer {
  81933. /**
  81934. * Gets or sets the number of objects referencing this buffer
  81935. */
  81936. references: number;
  81937. /** Gets or sets the size of the underlying buffer */
  81938. capacity: number;
  81939. /**
  81940. * Gets or sets a boolean indicating if the buffer contains 32bits indices
  81941. */
  81942. is32Bits: boolean;
  81943. /**
  81944. * Gets the underlying buffer
  81945. */
  81946. get underlyingResource(): any;
  81947. }
  81948. }
  81949. declare module BABYLON {
  81950. /** @hidden */
  81951. export interface IShaderProcessor {
  81952. attributeProcessor?: (attribute: string) => string;
  81953. varyingProcessor?: (varying: string, isFragment: boolean) => string;
  81954. uniformProcessor?: (uniform: string, isFragment: boolean) => string;
  81955. uniformBufferProcessor?: (uniformBuffer: string, isFragment: boolean) => string;
  81956. endOfUniformBufferProcessor?: (closingBracketLine: string, isFragment: boolean) => string;
  81957. lineProcessor?: (line: string, isFragment: boolean) => string;
  81958. preProcessor?: (code: string, defines: string[], isFragment: boolean) => string;
  81959. postProcessor?: (code: string, defines: string[], isFragment: boolean) => string;
  81960. }
  81961. }
  81962. declare module BABYLON {
  81963. /** @hidden */
  81964. export interface ProcessingOptions {
  81965. defines: string[];
  81966. indexParameters: any;
  81967. isFragment: boolean;
  81968. shouldUseHighPrecisionShader: boolean;
  81969. supportsUniformBuffers: boolean;
  81970. shadersRepository: string;
  81971. includesShadersStore: {
  81972. [key: string]: string;
  81973. };
  81974. processor?: IShaderProcessor;
  81975. version: string;
  81976. platformName: string;
  81977. lookForClosingBracketForUniformBuffer?: boolean;
  81978. }
  81979. }
  81980. declare module BABYLON {
  81981. /** @hidden */
  81982. export class ShaderCodeNode {
  81983. line: string;
  81984. children: ShaderCodeNode[];
  81985. additionalDefineKey?: string;
  81986. additionalDefineValue?: string;
  81987. isValid(preprocessors: {
  81988. [key: string]: string;
  81989. }): boolean;
  81990. process(preprocessors: {
  81991. [key: string]: string;
  81992. }, options: ProcessingOptions): string;
  81993. }
  81994. }
  81995. declare module BABYLON {
  81996. /** @hidden */
  81997. export class ShaderCodeCursor {
  81998. private _lines;
  81999. lineIndex: number;
  82000. get currentLine(): string;
  82001. get canRead(): boolean;
  82002. set lines(value: string[]);
  82003. }
  82004. }
  82005. declare module BABYLON {
  82006. /** @hidden */
  82007. export class ShaderCodeConditionNode extends ShaderCodeNode {
  82008. process(preprocessors: {
  82009. [key: string]: string;
  82010. }, options: ProcessingOptions): string;
  82011. }
  82012. }
  82013. declare module BABYLON {
  82014. /** @hidden */
  82015. export class ShaderDefineExpression {
  82016. isTrue(preprocessors: {
  82017. [key: string]: string;
  82018. }): boolean;
  82019. private static _OperatorPriority;
  82020. private static _Stack;
  82021. static postfixToInfix(postfix: string[]): string;
  82022. static infixToPostfix(infix: string): string[];
  82023. }
  82024. }
  82025. declare module BABYLON {
  82026. /** @hidden */
  82027. export class ShaderCodeTestNode extends ShaderCodeNode {
  82028. testExpression: ShaderDefineExpression;
  82029. isValid(preprocessors: {
  82030. [key: string]: string;
  82031. }): boolean;
  82032. }
  82033. }
  82034. declare module BABYLON {
  82035. /** @hidden */
  82036. export class ShaderDefineIsDefinedOperator extends ShaderDefineExpression {
  82037. define: string;
  82038. not: boolean;
  82039. constructor(define: string, not?: boolean);
  82040. isTrue(preprocessors: {
  82041. [key: string]: string;
  82042. }): boolean;
  82043. }
  82044. }
  82045. declare module BABYLON {
  82046. /** @hidden */
  82047. export class ShaderDefineOrOperator extends ShaderDefineExpression {
  82048. leftOperand: ShaderDefineExpression;
  82049. rightOperand: ShaderDefineExpression;
  82050. isTrue(preprocessors: {
  82051. [key: string]: string;
  82052. }): boolean;
  82053. }
  82054. }
  82055. declare module BABYLON {
  82056. /** @hidden */
  82057. export class ShaderDefineAndOperator extends ShaderDefineExpression {
  82058. leftOperand: ShaderDefineExpression;
  82059. rightOperand: ShaderDefineExpression;
  82060. isTrue(preprocessors: {
  82061. [key: string]: string;
  82062. }): boolean;
  82063. }
  82064. }
  82065. declare module BABYLON {
  82066. /** @hidden */
  82067. export class ShaderDefineArithmeticOperator extends ShaderDefineExpression {
  82068. define: string;
  82069. operand: string;
  82070. testValue: string;
  82071. constructor(define: string, operand: string, testValue: string);
  82072. isTrue(preprocessors: {
  82073. [key: string]: string;
  82074. }): boolean;
  82075. }
  82076. }
  82077. declare module BABYLON {
  82078. /**
  82079. * Class used to enable access to offline support
  82080. * @see https://doc.babylonjs.com/how_to/caching_resources_in_indexeddb
  82081. */
  82082. export interface IOfflineProvider {
  82083. /**
  82084. * Gets a boolean indicating if scene must be saved in the database
  82085. */
  82086. enableSceneOffline: boolean;
  82087. /**
  82088. * Gets a boolean indicating if textures must be saved in the database
  82089. */
  82090. enableTexturesOffline: boolean;
  82091. /**
  82092. * Open the offline support and make it available
  82093. * @param successCallback defines the callback to call on success
  82094. * @param errorCallback defines the callback to call on error
  82095. */
  82096. open(successCallback: () => void, errorCallback: () => void): void;
  82097. /**
  82098. * Loads an image from the offline support
  82099. * @param url defines the url to load from
  82100. * @param image defines the target DOM image
  82101. */
  82102. loadImage(url: string, image: HTMLImageElement): void;
  82103. /**
  82104. * Loads a file from offline support
  82105. * @param url defines the URL to load from
  82106. * @param sceneLoaded defines a callback to call on success
  82107. * @param progressCallBack defines a callback to call when progress changed
  82108. * @param errorCallback defines a callback to call on error
  82109. * @param useArrayBuffer defines a boolean to use array buffer instead of text string
  82110. */
  82111. loadFile(url: string, sceneLoaded: (data: any) => void, progressCallBack?: (data: any) => void, errorCallback?: () => void, useArrayBuffer?: boolean): void;
  82112. }
  82113. }
  82114. declare module BABYLON {
  82115. /**
  82116. * Class used to help managing file picking and drag'n'drop
  82117. * File Storage
  82118. */
  82119. export class FilesInputStore {
  82120. /**
  82121. * List of files ready to be loaded
  82122. */
  82123. static FilesToLoad: {
  82124. [key: string]: File;
  82125. };
  82126. }
  82127. }
  82128. declare module BABYLON {
  82129. /**
  82130. * Class used to define a retry strategy when error happens while loading assets
  82131. */
  82132. export class RetryStrategy {
  82133. /**
  82134. * Function used to defines an exponential back off strategy
  82135. * @param maxRetries defines the maximum number of retries (3 by default)
  82136. * @param baseInterval defines the interval between retries
  82137. * @returns the strategy function to use
  82138. */
  82139. static ExponentialBackoff(maxRetries?: number, baseInterval?: number): (url: string, request: WebRequest, retryIndex: number) => number;
  82140. }
  82141. }
  82142. declare module BABYLON {
  82143. /**
  82144. * @ignore
  82145. * Application error to support additional information when loading a file
  82146. */
  82147. export abstract class BaseError extends Error {
  82148. protected static _setPrototypeOf: (o: any, proto: object | null) => any;
  82149. }
  82150. }
  82151. declare module BABYLON {
  82152. /** @ignore */
  82153. export class LoadFileError extends BaseError {
  82154. request?: WebRequest;
  82155. file?: File;
  82156. /**
  82157. * Creates a new LoadFileError
  82158. * @param message defines the message of the error
  82159. * @param request defines the optional web request
  82160. * @param file defines the optional file
  82161. */
  82162. constructor(message: string, object?: WebRequest | File);
  82163. }
  82164. /** @ignore */
  82165. export class RequestFileError extends BaseError {
  82166. request: WebRequest;
  82167. /**
  82168. * Creates a new LoadFileError
  82169. * @param message defines the message of the error
  82170. * @param request defines the optional web request
  82171. */
  82172. constructor(message: string, request: WebRequest);
  82173. }
  82174. /** @ignore */
  82175. export class ReadFileError extends BaseError {
  82176. file: File;
  82177. /**
  82178. * Creates a new ReadFileError
  82179. * @param message defines the message of the error
  82180. * @param file defines the optional file
  82181. */
  82182. constructor(message: string, file: File);
  82183. }
  82184. /**
  82185. * @hidden
  82186. */
  82187. export class FileTools {
  82188. /**
  82189. * Gets or sets the retry strategy to apply when an error happens while loading an asset
  82190. */
  82191. static DefaultRetryStrategy: (url: string, request: WebRequest, retryIndex: number) => number;
  82192. /**
  82193. * Gets or sets the base URL to use to load assets
  82194. */
  82195. static BaseUrl: string;
  82196. /**
  82197. * Default behaviour for cors in the application.
  82198. * It can be a string if the expected behavior is identical in the entire app.
  82199. * Or a callback to be able to set it per url or on a group of them (in case of Video source for instance)
  82200. */
  82201. static CorsBehavior: string | ((url: string | string[]) => string);
  82202. /**
  82203. * Gets or sets a function used to pre-process url before using them to load assets
  82204. */
  82205. static PreprocessUrl: (url: string) => string;
  82206. /**
  82207. * Removes unwanted characters from an url
  82208. * @param url defines the url to clean
  82209. * @returns the cleaned url
  82210. */
  82211. private static _CleanUrl;
  82212. /**
  82213. * Sets the cors behavior on a dom element. This will add the required Tools.CorsBehavior to the element.
  82214. * @param url define the url we are trying
  82215. * @param element define the dom element where to configure the cors policy
  82216. */
  82217. static SetCorsBehavior(url: string | string[], element: {
  82218. crossOrigin: string | null;
  82219. }): void;
  82220. /**
  82221. * Loads an image as an HTMLImageElement.
  82222. * @param input url string, ArrayBuffer, or Blob to load
  82223. * @param onLoad callback called when the image successfully loads
  82224. * @param onError callback called when the image fails to load
  82225. * @param offlineProvider offline provider for caching
  82226. * @param mimeType optional mime type
  82227. * @returns the HTMLImageElement of the loaded image
  82228. */
  82229. 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>;
  82230. /**
  82231. * Reads a file from a File object
  82232. * @param file defines the file to load
  82233. * @param onSuccess defines the callback to call when data is loaded
  82234. * @param onProgress defines the callback to call during loading process
  82235. * @param useArrayBuffer defines a boolean indicating that data must be returned as an ArrayBuffer
  82236. * @param onError defines the callback to call when an error occurs
  82237. * @returns a file request object
  82238. */
  82239. static ReadFile(file: File, onSuccess: (data: any) => void, onProgress?: (ev: ProgressEvent) => any, useArrayBuffer?: boolean, onError?: (error: ReadFileError) => void): IFileRequest;
  82240. /**
  82241. * Loads a file from a url
  82242. * @param url url to load
  82243. * @param onSuccess callback called when the file successfully loads
  82244. * @param onProgress callback called while file is loading (if the server supports this mode)
  82245. * @param offlineProvider defines the offline provider for caching
  82246. * @param useArrayBuffer defines a boolean indicating that date must be returned as ArrayBuffer
  82247. * @param onError callback called when the file fails to load
  82248. * @returns a file request object
  82249. */
  82250. 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;
  82251. /**
  82252. * Loads a file
  82253. * @param url url to load
  82254. * @param onSuccess callback called when the file successfully loads
  82255. * @param onProgress callback called while file is loading (if the server supports this mode)
  82256. * @param useArrayBuffer defines a boolean indicating that date must be returned as ArrayBuffer
  82257. * @param onError callback called when the file fails to load
  82258. * @param onOpened callback called when the web request is opened
  82259. * @returns a file request object
  82260. */
  82261. 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;
  82262. /**
  82263. * Checks if the loaded document was accessed via `file:`-Protocol.
  82264. * @returns boolean
  82265. */
  82266. static IsFileURL(): boolean;
  82267. }
  82268. }
  82269. declare module BABYLON {
  82270. /** @hidden */
  82271. export class ShaderProcessor {
  82272. static Process(sourceCode: string, options: ProcessingOptions, callback: (migratedCode: string) => void): void;
  82273. private static _ProcessPrecision;
  82274. private static _ExtractOperation;
  82275. private static _BuildSubExpression;
  82276. private static _BuildExpression;
  82277. private static _MoveCursorWithinIf;
  82278. private static _MoveCursor;
  82279. private static _EvaluatePreProcessors;
  82280. private static _PreparePreProcessors;
  82281. private static _ProcessShaderConversion;
  82282. private static _ProcessIncludes;
  82283. /**
  82284. * Loads a file from a url
  82285. * @param url url to load
  82286. * @param onSuccess callback called when the file successfully loads
  82287. * @param onProgress callback called while file is loading (if the server supports this mode)
  82288. * @param offlineProvider defines the offline provider for caching
  82289. * @param useArrayBuffer defines a boolean indicating that date must be returned as ArrayBuffer
  82290. * @param onError callback called when the file fails to load
  82291. * @returns a file request object
  82292. * @hidden
  82293. */
  82294. 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;
  82295. }
  82296. }
  82297. declare module BABYLON {
  82298. /**
  82299. * @hidden
  82300. */
  82301. export interface IColor4Like {
  82302. r: float;
  82303. g: float;
  82304. b: float;
  82305. a: float;
  82306. }
  82307. /**
  82308. * @hidden
  82309. */
  82310. export interface IColor3Like {
  82311. r: float;
  82312. g: float;
  82313. b: float;
  82314. }
  82315. /**
  82316. * @hidden
  82317. */
  82318. export interface IVector4Like {
  82319. x: float;
  82320. y: float;
  82321. z: float;
  82322. w: float;
  82323. }
  82324. /**
  82325. * @hidden
  82326. */
  82327. export interface IVector3Like {
  82328. x: float;
  82329. y: float;
  82330. z: float;
  82331. }
  82332. /**
  82333. * @hidden
  82334. */
  82335. export interface IVector2Like {
  82336. x: float;
  82337. y: float;
  82338. }
  82339. /**
  82340. * @hidden
  82341. */
  82342. export interface IMatrixLike {
  82343. toArray(): DeepImmutable<Float32Array | Array<number>>;
  82344. updateFlag: int;
  82345. }
  82346. /**
  82347. * @hidden
  82348. */
  82349. export interface IViewportLike {
  82350. x: float;
  82351. y: float;
  82352. width: float;
  82353. height: float;
  82354. }
  82355. /**
  82356. * @hidden
  82357. */
  82358. export interface IPlaneLike {
  82359. normal: IVector3Like;
  82360. d: float;
  82361. normalize(): void;
  82362. }
  82363. }
  82364. declare module BABYLON {
  82365. /**
  82366. * Interface used to define common properties for effect fallbacks
  82367. */
  82368. export interface IEffectFallbacks {
  82369. /**
  82370. * Removes the defines that should be removed when falling back.
  82371. * @param currentDefines defines the current define statements for the shader.
  82372. * @param effect defines the current effect we try to compile
  82373. * @returns The resulting defines with defines of the current rank removed.
  82374. */
  82375. reduce(currentDefines: string, effect: Effect): string;
  82376. /**
  82377. * Removes the fallback from the bound mesh.
  82378. */
  82379. unBindMesh(): void;
  82380. /**
  82381. * Checks to see if more fallbacks are still availible.
  82382. */
  82383. hasMoreFallbacks: boolean;
  82384. }
  82385. }
  82386. declare module BABYLON {
  82387. /**
  82388. * Class used to evalaute queries containing `and` and `or` operators
  82389. */
  82390. export class AndOrNotEvaluator {
  82391. /**
  82392. * Evaluate a query
  82393. * @param query defines the query to evaluate
  82394. * @param evaluateCallback defines the callback used to filter result
  82395. * @returns true if the query matches
  82396. */
  82397. static Eval(query: string, evaluateCallback: (val: any) => boolean): boolean;
  82398. private static _HandleParenthesisContent;
  82399. private static _SimplifyNegation;
  82400. }
  82401. }
  82402. declare module BABYLON {
  82403. /**
  82404. * Class used to store custom tags
  82405. */
  82406. export class Tags {
  82407. /**
  82408. * Adds support for tags on the given object
  82409. * @param obj defines the object to use
  82410. */
  82411. static EnableFor(obj: any): void;
  82412. /**
  82413. * Removes tags support
  82414. * @param obj defines the object to use
  82415. */
  82416. static DisableFor(obj: any): void;
  82417. /**
  82418. * Gets a boolean indicating if the given object has tags
  82419. * @param obj defines the object to use
  82420. * @returns a boolean
  82421. */
  82422. static HasTags(obj: any): boolean;
  82423. /**
  82424. * Gets the tags available on a given object
  82425. * @param obj defines the object to use
  82426. * @param asString defines if the tags must be returned as a string instead of an array of strings
  82427. * @returns the tags
  82428. */
  82429. static GetTags(obj: any, asString?: boolean): any;
  82430. /**
  82431. * Adds tags to an object
  82432. * @param obj defines the object to use
  82433. * @param tagsString defines the tag string. The tags 'true' and 'false' are reserved and cannot be used as tags.
  82434. * A tag cannot start with '||', '&&', and '!'. It cannot contain whitespaces
  82435. */
  82436. static AddTagsTo(obj: any, tagsString: string): void;
  82437. /**
  82438. * @hidden
  82439. */
  82440. static _AddTagTo(obj: any, tag: string): void;
  82441. /**
  82442. * Removes specific tags from a specific object
  82443. * @param obj defines the object to use
  82444. * @param tagsString defines the tags to remove
  82445. */
  82446. static RemoveTagsFrom(obj: any, tagsString: string): void;
  82447. /**
  82448. * @hidden
  82449. */
  82450. static _RemoveTagFrom(obj: any, tag: string): void;
  82451. /**
  82452. * Defines if tags hosted on an object match a given query
  82453. * @param obj defines the object to use
  82454. * @param tagsQuery defines the tag query
  82455. * @returns a boolean
  82456. */
  82457. static MatchesQuery(obj: any, tagsQuery: string): boolean;
  82458. }
  82459. }
  82460. declare module BABYLON {
  82461. /**
  82462. * Scalar computation library
  82463. */
  82464. export class Scalar {
  82465. /**
  82466. * Two pi constants convenient for computation.
  82467. */
  82468. static TwoPi: number;
  82469. /**
  82470. * Boolean : true if the absolute difference between a and b is lower than epsilon (default = 1.401298E-45)
  82471. * @param a number
  82472. * @param b number
  82473. * @param epsilon (default = 1.401298E-45)
  82474. * @returns true if the absolute difference between a and b is lower than epsilon (default = 1.401298E-45)
  82475. */
  82476. static WithinEpsilon(a: number, b: number, epsilon?: number): boolean;
  82477. /**
  82478. * Returns a string : the upper case translation of the number i to hexadecimal.
  82479. * @param i number
  82480. * @returns the upper case translation of the number i to hexadecimal.
  82481. */
  82482. static ToHex(i: number): string;
  82483. /**
  82484. * Returns -1 if value is negative and +1 is value is positive.
  82485. * @param value the value
  82486. * @returns the value itself if it's equal to zero.
  82487. */
  82488. static Sign(value: number): number;
  82489. /**
  82490. * Returns the value itself if it's between min and max.
  82491. * Returns min if the value is lower than min.
  82492. * Returns max if the value is greater than max.
  82493. * @param value the value to clmap
  82494. * @param min the min value to clamp to (default: 0)
  82495. * @param max the max value to clamp to (default: 1)
  82496. * @returns the clamped value
  82497. */
  82498. static Clamp(value: number, min?: number, max?: number): number;
  82499. /**
  82500. * the log2 of value.
  82501. * @param value the value to compute log2 of
  82502. * @returns the log2 of value.
  82503. */
  82504. static Log2(value: number): number;
  82505. /**
  82506. * Loops the value, so that it is never larger than length and never smaller than 0.
  82507. *
  82508. * This is similar to the modulo operator but it works with floating point numbers.
  82509. * For example, using 3.0 for t and 2.5 for length, the result would be 0.5.
  82510. * With t = 5 and length = 2.5, the result would be 0.0.
  82511. * Note, however, that the behaviour is not defined for negative numbers as it is for the modulo operator
  82512. * @param value the value
  82513. * @param length the length
  82514. * @returns the looped value
  82515. */
  82516. static Repeat(value: number, length: number): number;
  82517. /**
  82518. * Normalize the value between 0.0 and 1.0 using min and max values
  82519. * @param value value to normalize
  82520. * @param min max to normalize between
  82521. * @param max min to normalize between
  82522. * @returns the normalized value
  82523. */
  82524. static Normalize(value: number, min: number, max: number): number;
  82525. /**
  82526. * Denormalize the value from 0.0 and 1.0 using min and max values
  82527. * @param normalized value to denormalize
  82528. * @param min max to denormalize between
  82529. * @param max min to denormalize between
  82530. * @returns the denormalized value
  82531. */
  82532. static Denormalize(normalized: number, min: number, max: number): number;
  82533. /**
  82534. * Calculates the shortest difference between two given angles given in degrees.
  82535. * @param current current angle in degrees
  82536. * @param target target angle in degrees
  82537. * @returns the delta
  82538. */
  82539. static DeltaAngle(current: number, target: number): number;
  82540. /**
  82541. * PingPongs the value t, so that it is never larger than length and never smaller than 0.
  82542. * @param tx value
  82543. * @param length length
  82544. * @returns The returned value will move back and forth between 0 and length
  82545. */
  82546. static PingPong(tx: number, length: number): number;
  82547. /**
  82548. * Interpolates between min and max with smoothing at the limits.
  82549. *
  82550. * This function interpolates between min and max in a similar way to Lerp. However, the interpolation will gradually speed up
  82551. * from the start and slow down toward the end. This is useful for creating natural-looking animation, fading and other transitions.
  82552. * @param from from
  82553. * @param to to
  82554. * @param tx value
  82555. * @returns the smooth stepped value
  82556. */
  82557. static SmoothStep(from: number, to: number, tx: number): number;
  82558. /**
  82559. * Moves a value current towards target.
  82560. *
  82561. * This is essentially the same as Mathf.Lerp but instead the function will ensure that the speed never exceeds maxDelta.
  82562. * Negative values of maxDelta pushes the value away from target.
  82563. * @param current current value
  82564. * @param target target value
  82565. * @param maxDelta max distance to move
  82566. * @returns resulting value
  82567. */
  82568. static MoveTowards(current: number, target: number, maxDelta: number): number;
  82569. /**
  82570. * Same as MoveTowards but makes sure the values interpolate correctly when they wrap around 360 degrees.
  82571. *
  82572. * Variables current and target are assumed to be in degrees. For optimization reasons, negative values of maxDelta
  82573. * are not supported and may cause oscillation. To push current away from a target angle, add 180 to that angle instead.
  82574. * @param current current value
  82575. * @param target target value
  82576. * @param maxDelta max distance to move
  82577. * @returns resulting angle
  82578. */
  82579. static MoveTowardsAngle(current: number, target: number, maxDelta: number): number;
  82580. /**
  82581. * Creates a new scalar with values linearly interpolated of "amount" between the start scalar and the end scalar.
  82582. * @param start start value
  82583. * @param end target value
  82584. * @param amount amount to lerp between
  82585. * @returns the lerped value
  82586. */
  82587. static Lerp(start: number, end: number, amount: number): number;
  82588. /**
  82589. * Same as Lerp but makes sure the values interpolate correctly when they wrap around 360 degrees.
  82590. * The parameter t is clamped to the range [0, 1]. Variables a and b are assumed to be in degrees.
  82591. * @param start start value
  82592. * @param end target value
  82593. * @param amount amount to lerp between
  82594. * @returns the lerped value
  82595. */
  82596. static LerpAngle(start: number, end: number, amount: number): number;
  82597. /**
  82598. * Calculates the linear parameter t that produces the interpolant value within the range [a, b].
  82599. * @param a start value
  82600. * @param b target value
  82601. * @param value value between a and b
  82602. * @returns the inverseLerp value
  82603. */
  82604. static InverseLerp(a: number, b: number, value: number): number;
  82605. /**
  82606. * Returns a new scalar located for "amount" (float) on the Hermite spline defined by the scalars "value1", "value3", "tangent1", "tangent2".
  82607. * @see http://mathworld.wolfram.com/HermitePolynomial.html
  82608. * @param value1 spline value
  82609. * @param tangent1 spline value
  82610. * @param value2 spline value
  82611. * @param tangent2 spline value
  82612. * @param amount input value
  82613. * @returns hermite result
  82614. */
  82615. static Hermite(value1: number, tangent1: number, value2: number, tangent2: number, amount: number): number;
  82616. /**
  82617. * Returns a random float number between and min and max values
  82618. * @param min min value of random
  82619. * @param max max value of random
  82620. * @returns random value
  82621. */
  82622. static RandomRange(min: number, max: number): number;
  82623. /**
  82624. * This function returns percentage of a number in a given range.
  82625. *
  82626. * RangeToPercent(40,20,60) will return 0.5 (50%)
  82627. * RangeToPercent(34,0,100) will return 0.34 (34%)
  82628. * @param number to convert to percentage
  82629. * @param min min range
  82630. * @param max max range
  82631. * @returns the percentage
  82632. */
  82633. static RangeToPercent(number: number, min: number, max: number): number;
  82634. /**
  82635. * This function returns number that corresponds to the percentage in a given range.
  82636. *
  82637. * PercentToRange(0.34,0,100) will return 34.
  82638. * @param percent to convert to number
  82639. * @param min min range
  82640. * @param max max range
  82641. * @returns the number
  82642. */
  82643. static PercentToRange(percent: number, min: number, max: number): number;
  82644. /**
  82645. * Returns the angle converted to equivalent value between -Math.PI and Math.PI radians.
  82646. * @param angle The angle to normalize in radian.
  82647. * @return The converted angle.
  82648. */
  82649. static NormalizeRadians(angle: number): number;
  82650. }
  82651. }
  82652. declare module BABYLON {
  82653. /**
  82654. * Constant used to convert a value to gamma space
  82655. * @ignorenaming
  82656. */
  82657. export const ToGammaSpace: number;
  82658. /**
  82659. * Constant used to convert a value to linear space
  82660. * @ignorenaming
  82661. */
  82662. export const ToLinearSpace = 2.2;
  82663. /**
  82664. * Constant used to define the minimal number value in Babylon.js
  82665. * @ignorenaming
  82666. */
  82667. let Epsilon: number;
  82668. }
  82669. declare module BABYLON {
  82670. /**
  82671. * Class used to represent a viewport on screen
  82672. */
  82673. export class Viewport {
  82674. /** viewport left coordinate */
  82675. x: number;
  82676. /** viewport top coordinate */
  82677. y: number;
  82678. /**viewport width */
  82679. width: number;
  82680. /** viewport height */
  82681. height: number;
  82682. /**
  82683. * Creates a Viewport object located at (x, y) and sized (width, height)
  82684. * @param x defines viewport left coordinate
  82685. * @param y defines viewport top coordinate
  82686. * @param width defines the viewport width
  82687. * @param height defines the viewport height
  82688. */
  82689. constructor(
  82690. /** viewport left coordinate */
  82691. x: number,
  82692. /** viewport top coordinate */
  82693. y: number,
  82694. /**viewport width */
  82695. width: number,
  82696. /** viewport height */
  82697. height: number);
  82698. /**
  82699. * Creates a new viewport using absolute sizing (from 0-> width, 0-> height instead of 0->1)
  82700. * @param renderWidth defines the rendering width
  82701. * @param renderHeight defines the rendering height
  82702. * @returns a new Viewport
  82703. */
  82704. toGlobal(renderWidth: number, renderHeight: number): Viewport;
  82705. /**
  82706. * Stores absolute viewport value into a target viewport (from 0-> width, 0-> height instead of 0->1)
  82707. * @param renderWidth defines the rendering width
  82708. * @param renderHeight defines the rendering height
  82709. * @param ref defines the target viewport
  82710. * @returns the current viewport
  82711. */
  82712. toGlobalToRef(renderWidth: number, renderHeight: number, ref: Viewport): Viewport;
  82713. /**
  82714. * Returns a new Viewport copied from the current one
  82715. * @returns a new Viewport
  82716. */
  82717. clone(): Viewport;
  82718. }
  82719. }
  82720. declare module BABYLON {
  82721. /**
  82722. * Class containing a set of static utilities functions for arrays.
  82723. */
  82724. export class ArrayTools {
  82725. /**
  82726. * Returns an array of the given size filled with element built from the given constructor and the paramters
  82727. * @param size the number of element to construct and put in the array
  82728. * @param itemBuilder a callback responsible for creating new instance of item. Called once per array entry.
  82729. * @returns a new array filled with new objects
  82730. */
  82731. static BuildArray<T>(size: number, itemBuilder: () => T): Array<T>;
  82732. }
  82733. }
  82734. declare module BABYLON {
  82735. /**
  82736. * Represents a plane by the equation ax + by + cz + d = 0
  82737. */
  82738. export class Plane {
  82739. private static _TmpMatrix;
  82740. /**
  82741. * Normal of the plane (a,b,c)
  82742. */
  82743. normal: Vector3;
  82744. /**
  82745. * d component of the plane
  82746. */
  82747. d: number;
  82748. /**
  82749. * Creates a Plane object according to the given floats a, b, c, d and the plane equation : ax + by + cz + d = 0
  82750. * @param a a component of the plane
  82751. * @param b b component of the plane
  82752. * @param c c component of the plane
  82753. * @param d d component of the plane
  82754. */
  82755. constructor(a: number, b: number, c: number, d: number);
  82756. /**
  82757. * @returns the plane coordinates as a new array of 4 elements [a, b, c, d].
  82758. */
  82759. asArray(): number[];
  82760. /**
  82761. * @returns a new plane copied from the current Plane.
  82762. */
  82763. clone(): Plane;
  82764. /**
  82765. * @returns the string "Plane".
  82766. */
  82767. getClassName(): string;
  82768. /**
  82769. * @returns the Plane hash code.
  82770. */
  82771. getHashCode(): number;
  82772. /**
  82773. * Normalize the current Plane in place.
  82774. * @returns the updated Plane.
  82775. */
  82776. normalize(): Plane;
  82777. /**
  82778. * Applies a transformation the plane and returns the result
  82779. * @param transformation the transformation matrix to be applied to the plane
  82780. * @returns a new Plane as the result of the transformation of the current Plane by the given matrix.
  82781. */
  82782. transform(transformation: DeepImmutable<Matrix>): Plane;
  82783. /**
  82784. * Compute the dot product between the point and the plane normal
  82785. * @param point point to calculate the dot product with
  82786. * @returns the dot product (float) of the point coordinates and the plane normal.
  82787. */
  82788. dotCoordinate(point: DeepImmutable<Vector3>): number;
  82789. /**
  82790. * Updates the current Plane from the plane defined by the three given points.
  82791. * @param point1 one of the points used to contruct the plane
  82792. * @param point2 one of the points used to contruct the plane
  82793. * @param point3 one of the points used to contruct the plane
  82794. * @returns the updated Plane.
  82795. */
  82796. copyFromPoints(point1: DeepImmutable<Vector3>, point2: DeepImmutable<Vector3>, point3: DeepImmutable<Vector3>): Plane;
  82797. /**
  82798. * Checks if the plane is facing a given direction
  82799. * @param direction the direction to check if the plane is facing
  82800. * @param epsilon value the dot product is compared against (returns true if dot <= epsilon)
  82801. * @returns True is the vector "direction" is the same side than the plane normal.
  82802. */
  82803. isFrontFacingTo(direction: DeepImmutable<Vector3>, epsilon: number): boolean;
  82804. /**
  82805. * Calculates the distance to a point
  82806. * @param point point to calculate distance to
  82807. * @returns the signed distance (float) from the given point to the Plane.
  82808. */
  82809. signedDistanceTo(point: DeepImmutable<Vector3>): number;
  82810. /**
  82811. * Creates a plane from an array
  82812. * @param array the array to create a plane from
  82813. * @returns a new Plane from the given array.
  82814. */
  82815. static FromArray(array: DeepImmutable<ArrayLike<number>>): Plane;
  82816. /**
  82817. * Creates a plane from three points
  82818. * @param point1 point used to create the plane
  82819. * @param point2 point used to create the plane
  82820. * @param point3 point used to create the plane
  82821. * @returns a new Plane defined by the three given points.
  82822. */
  82823. static FromPoints(point1: DeepImmutable<Vector3>, point2: DeepImmutable<Vector3>, point3: DeepImmutable<Vector3>): Plane;
  82824. /**
  82825. * Creates a plane from an origin point and a normal
  82826. * @param origin origin of the plane to be constructed
  82827. * @param normal normal of the plane to be constructed
  82828. * @returns a new Plane the normal vector to this plane at the given origin point.
  82829. * Note : the vector "normal" is updated because normalized.
  82830. */
  82831. static FromPositionAndNormal(origin: DeepImmutable<Vector3>, normal: Vector3): Plane;
  82832. /**
  82833. * Calculates the distance from a plane and a point
  82834. * @param origin origin of the plane to be constructed
  82835. * @param normal normal of the plane to be constructed
  82836. * @param point point to calculate distance to
  82837. * @returns the signed distance between the plane defined by the normal vector at the "origin"" point and the given other point.
  82838. */
  82839. static SignedDistanceToPlaneFromPositionAndNormal(origin: DeepImmutable<Vector3>, normal: DeepImmutable<Vector3>, point: DeepImmutable<Vector3>): number;
  82840. }
  82841. }
  82842. declare module BABYLON {
  82843. /** @hidden */
  82844. export class PerformanceConfigurator {
  82845. /** @hidden */
  82846. static MatrixUse64Bits: boolean;
  82847. /** @hidden */
  82848. static MatrixTrackPrecisionChange: boolean;
  82849. /** @hidden */
  82850. static MatrixCurrentType: any;
  82851. /** @hidden */
  82852. static MatrixTrackedMatrices: Array<any> | null;
  82853. /** @hidden */
  82854. static SetMatrixPrecision(use64bits: boolean): void;
  82855. }
  82856. }
  82857. declare module BABYLON {
  82858. /**
  82859. * Class representing a vector containing 2 coordinates
  82860. */
  82861. export class Vector2 {
  82862. /** defines the first coordinate */
  82863. x: number;
  82864. /** defines the second coordinate */
  82865. y: number;
  82866. /**
  82867. * Creates a new Vector2 from the given x and y coordinates
  82868. * @param x defines the first coordinate
  82869. * @param y defines the second coordinate
  82870. */
  82871. constructor(
  82872. /** defines the first coordinate */
  82873. x?: number,
  82874. /** defines the second coordinate */
  82875. y?: number);
  82876. /**
  82877. * Gets a string with the Vector2 coordinates
  82878. * @returns a string with the Vector2 coordinates
  82879. */
  82880. toString(): string;
  82881. /**
  82882. * Gets class name
  82883. * @returns the string "Vector2"
  82884. */
  82885. getClassName(): string;
  82886. /**
  82887. * Gets current vector hash code
  82888. * @returns the Vector2 hash code as a number
  82889. */
  82890. getHashCode(): number;
  82891. /**
  82892. * Sets the Vector2 coordinates in the given array or Float32Array from the given index.
  82893. * @param array defines the source array
  82894. * @param index defines the offset in source array
  82895. * @returns the current Vector2
  82896. */
  82897. toArray(array: FloatArray, index?: number): Vector2;
  82898. /**
  82899. * Update the current vector from an array
  82900. * @param array defines the destination array
  82901. * @param index defines the offset in the destination array
  82902. * @returns the current Vector3
  82903. */
  82904. fromArray(array: FloatArray, index?: number): Vector2;
  82905. /**
  82906. * Copy the current vector to an array
  82907. * @returns a new array with 2 elements: the Vector2 coordinates.
  82908. */
  82909. asArray(): number[];
  82910. /**
  82911. * Sets the Vector2 coordinates with the given Vector2 coordinates
  82912. * @param source defines the source Vector2
  82913. * @returns the current updated Vector2
  82914. */
  82915. copyFrom(source: DeepImmutable<Vector2>): Vector2;
  82916. /**
  82917. * Sets the Vector2 coordinates with the given floats
  82918. * @param x defines the first coordinate
  82919. * @param y defines the second coordinate
  82920. * @returns the current updated Vector2
  82921. */
  82922. copyFromFloats(x: number, y: number): Vector2;
  82923. /**
  82924. * Sets the Vector2 coordinates with the given floats
  82925. * @param x defines the first coordinate
  82926. * @param y defines the second coordinate
  82927. * @returns the current updated Vector2
  82928. */
  82929. set(x: number, y: number): Vector2;
  82930. /**
  82931. * Add another vector with the current one
  82932. * @param otherVector defines the other vector
  82933. * @returns a new Vector2 set with the addition of the current Vector2 and the given one coordinates
  82934. */
  82935. add(otherVector: DeepImmutable<Vector2>): Vector2;
  82936. /**
  82937. * Sets the "result" coordinates with the addition of the current Vector2 and the given one coordinates
  82938. * @param otherVector defines the other vector
  82939. * @param result defines the target vector
  82940. * @returns the unmodified current Vector2
  82941. */
  82942. addToRef(otherVector: DeepImmutable<Vector2>, result: Vector2): Vector2;
  82943. /**
  82944. * Set the Vector2 coordinates by adding the given Vector2 coordinates
  82945. * @param otherVector defines the other vector
  82946. * @returns the current updated Vector2
  82947. */
  82948. addInPlace(otherVector: DeepImmutable<Vector2>): Vector2;
  82949. /**
  82950. * Gets a new Vector2 by adding the current Vector2 coordinates to the given Vector3 x, y coordinates
  82951. * @param otherVector defines the other vector
  82952. * @returns a new Vector2
  82953. */
  82954. addVector3(otherVector: Vector3): Vector2;
  82955. /**
  82956. * Gets a new Vector2 set with the subtracted coordinates of the given one from the current Vector2
  82957. * @param otherVector defines the other vector
  82958. * @returns a new Vector2
  82959. */
  82960. subtract(otherVector: Vector2): Vector2;
  82961. /**
  82962. * Sets the "result" coordinates with the subtraction of the given one from the current Vector2 coordinates.
  82963. * @param otherVector defines the other vector
  82964. * @param result defines the target vector
  82965. * @returns the unmodified current Vector2
  82966. */
  82967. subtractToRef(otherVector: DeepImmutable<Vector2>, result: Vector2): Vector2;
  82968. /**
  82969. * Sets the current Vector2 coordinates by subtracting from it the given one coordinates
  82970. * @param otherVector defines the other vector
  82971. * @returns the current updated Vector2
  82972. */
  82973. subtractInPlace(otherVector: DeepImmutable<Vector2>): Vector2;
  82974. /**
  82975. * Multiplies in place the current Vector2 coordinates by the given ones
  82976. * @param otherVector defines the other vector
  82977. * @returns the current updated Vector2
  82978. */
  82979. multiplyInPlace(otherVector: DeepImmutable<Vector2>): Vector2;
  82980. /**
  82981. * Returns a new Vector2 set with the multiplication of the current Vector2 and the given one coordinates
  82982. * @param otherVector defines the other vector
  82983. * @returns a new Vector2
  82984. */
  82985. multiply(otherVector: DeepImmutable<Vector2>): Vector2;
  82986. /**
  82987. * Sets "result" coordinates with the multiplication of the current Vector2 and the given one coordinates
  82988. * @param otherVector defines the other vector
  82989. * @param result defines the target vector
  82990. * @returns the unmodified current Vector2
  82991. */
  82992. multiplyToRef(otherVector: DeepImmutable<Vector2>, result: Vector2): Vector2;
  82993. /**
  82994. * Gets a new Vector2 set with the Vector2 coordinates multiplied by the given floats
  82995. * @param x defines the first coordinate
  82996. * @param y defines the second coordinate
  82997. * @returns a new Vector2
  82998. */
  82999. multiplyByFloats(x: number, y: number): Vector2;
  83000. /**
  83001. * Returns a new Vector2 set with the Vector2 coordinates divided by the given one coordinates
  83002. * @param otherVector defines the other vector
  83003. * @returns a new Vector2
  83004. */
  83005. divide(otherVector: Vector2): Vector2;
  83006. /**
  83007. * Sets the "result" coordinates with the Vector2 divided by the given one coordinates
  83008. * @param otherVector defines the other vector
  83009. * @param result defines the target vector
  83010. * @returns the unmodified current Vector2
  83011. */
  83012. divideToRef(otherVector: DeepImmutable<Vector2>, result: Vector2): Vector2;
  83013. /**
  83014. * Divides the current Vector2 coordinates by the given ones
  83015. * @param otherVector defines the other vector
  83016. * @returns the current updated Vector2
  83017. */
  83018. divideInPlace(otherVector: DeepImmutable<Vector2>): Vector2;
  83019. /**
  83020. * Gets a new Vector2 with current Vector2 negated coordinates
  83021. * @returns a new Vector2
  83022. */
  83023. negate(): Vector2;
  83024. /**
  83025. * Negate this vector in place
  83026. * @returns this
  83027. */
  83028. negateInPlace(): Vector2;
  83029. /**
  83030. * Negate the current Vector2 and stores the result in the given vector "result" coordinates
  83031. * @param result defines the Vector3 object where to store the result
  83032. * @returns the current Vector2
  83033. */
  83034. negateToRef(result: Vector2): Vector2;
  83035. /**
  83036. * Multiply the Vector2 coordinates by scale
  83037. * @param scale defines the scaling factor
  83038. * @returns the current updated Vector2
  83039. */
  83040. scaleInPlace(scale: number): Vector2;
  83041. /**
  83042. * Returns a new Vector2 scaled by "scale" from the current Vector2
  83043. * @param scale defines the scaling factor
  83044. * @returns a new Vector2
  83045. */
  83046. scale(scale: number): Vector2;
  83047. /**
  83048. * Scale the current Vector2 values by a factor to a given Vector2
  83049. * @param scale defines the scale factor
  83050. * @param result defines the Vector2 object where to store the result
  83051. * @returns the unmodified current Vector2
  83052. */
  83053. scaleToRef(scale: number, result: Vector2): Vector2;
  83054. /**
  83055. * Scale the current Vector2 values by a factor and add the result to a given Vector2
  83056. * @param scale defines the scale factor
  83057. * @param result defines the Vector2 object where to store the result
  83058. * @returns the unmodified current Vector2
  83059. */
  83060. scaleAndAddToRef(scale: number, result: Vector2): Vector2;
  83061. /**
  83062. * Gets a boolean if two vectors are equals
  83063. * @param otherVector defines the other vector
  83064. * @returns true if the given vector coordinates strictly equal the current Vector2 ones
  83065. */
  83066. equals(otherVector: DeepImmutable<Vector2>): boolean;
  83067. /**
  83068. * Gets a boolean if two vectors are equals (using an epsilon value)
  83069. * @param otherVector defines the other vector
  83070. * @param epsilon defines the minimal distance to consider equality
  83071. * @returns true if the given vector coordinates are close to the current ones by a distance of epsilon.
  83072. */
  83073. equalsWithEpsilon(otherVector: DeepImmutable<Vector2>, epsilon?: number): boolean;
  83074. /**
  83075. * Gets a new Vector2 from current Vector2 floored values
  83076. * @returns a new Vector2
  83077. */
  83078. floor(): Vector2;
  83079. /**
  83080. * Gets a new Vector2 from current Vector2 floored values
  83081. * @returns a new Vector2
  83082. */
  83083. fract(): Vector2;
  83084. /**
  83085. * Gets the length of the vector
  83086. * @returns the vector length (float)
  83087. */
  83088. length(): number;
  83089. /**
  83090. * Gets the vector squared length
  83091. * @returns the vector squared length (float)
  83092. */
  83093. lengthSquared(): number;
  83094. /**
  83095. * Normalize the vector
  83096. * @returns the current updated Vector2
  83097. */
  83098. normalize(): Vector2;
  83099. /**
  83100. * Gets a new Vector2 copied from the Vector2
  83101. * @returns a new Vector2
  83102. */
  83103. clone(): Vector2;
  83104. /**
  83105. * Gets a new Vector2(0, 0)
  83106. * @returns a new Vector2
  83107. */
  83108. static Zero(): Vector2;
  83109. /**
  83110. * Gets a new Vector2(1, 1)
  83111. * @returns a new Vector2
  83112. */
  83113. static One(): Vector2;
  83114. /**
  83115. * Gets a new Vector2 set from the given index element of the given array
  83116. * @param array defines the data source
  83117. * @param offset defines the offset in the data source
  83118. * @returns a new Vector2
  83119. */
  83120. static FromArray(array: DeepImmutable<ArrayLike<number>>, offset?: number): Vector2;
  83121. /**
  83122. * Sets "result" from the given index element of the given array
  83123. * @param array defines the data source
  83124. * @param offset defines the offset in the data source
  83125. * @param result defines the target vector
  83126. */
  83127. static FromArrayToRef(array: DeepImmutable<ArrayLike<number>>, offset: number, result: Vector2): void;
  83128. /**
  83129. * Gets a new Vector2 located for "amount" (float) on the CatmullRom spline defined by the given four Vector2
  83130. * @param value1 defines 1st point of control
  83131. * @param value2 defines 2nd point of control
  83132. * @param value3 defines 3rd point of control
  83133. * @param value4 defines 4th point of control
  83134. * @param amount defines the interpolation factor
  83135. * @returns a new Vector2
  83136. */
  83137. static CatmullRom(value1: DeepImmutable<Vector2>, value2: DeepImmutable<Vector2>, value3: DeepImmutable<Vector2>, value4: DeepImmutable<Vector2>, amount: number): Vector2;
  83138. /**
  83139. * 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".
  83140. * If a coordinate of "value" is lower than "min" coordinates, the returned Vector2 is given this "min" coordinate.
  83141. * If a coordinate of "value" is greater than "max" coordinates, the returned Vector2 is given this "max" coordinate
  83142. * @param value defines the value to clamp
  83143. * @param min defines the lower limit
  83144. * @param max defines the upper limit
  83145. * @returns a new Vector2
  83146. */
  83147. static Clamp(value: DeepImmutable<Vector2>, min: DeepImmutable<Vector2>, max: DeepImmutable<Vector2>): Vector2;
  83148. /**
  83149. * Returns a new Vector2 located for "amount" (float) on the Hermite spline defined by the vectors "value1", "value3", "tangent1", "tangent2"
  83150. * @param value1 defines the 1st control point
  83151. * @param tangent1 defines the outgoing tangent
  83152. * @param value2 defines the 2nd control point
  83153. * @param tangent2 defines the incoming tangent
  83154. * @param amount defines the interpolation factor
  83155. * @returns a new Vector2
  83156. */
  83157. static Hermite(value1: DeepImmutable<Vector2>, tangent1: DeepImmutable<Vector2>, value2: DeepImmutable<Vector2>, tangent2: DeepImmutable<Vector2>, amount: number): Vector2;
  83158. /**
  83159. * Returns a new Vector2 located for "amount" (float) on the linear interpolation between the vector "start" adn the vector "end".
  83160. * @param start defines the start vector
  83161. * @param end defines the end vector
  83162. * @param amount defines the interpolation factor
  83163. * @returns a new Vector2
  83164. */
  83165. static Lerp(start: DeepImmutable<Vector2>, end: DeepImmutable<Vector2>, amount: number): Vector2;
  83166. /**
  83167. * Gets the dot product of the vector "left" and the vector "right"
  83168. * @param left defines first vector
  83169. * @param right defines second vector
  83170. * @returns the dot product (float)
  83171. */
  83172. static Dot(left: DeepImmutable<Vector2>, right: DeepImmutable<Vector2>): number;
  83173. /**
  83174. * Returns a new Vector2 equal to the normalized given vector
  83175. * @param vector defines the vector to normalize
  83176. * @returns a new Vector2
  83177. */
  83178. static Normalize(vector: DeepImmutable<Vector2>): Vector2;
  83179. /**
  83180. * Gets a new Vector2 set with the minimal coordinate values from the "left" and "right" vectors
  83181. * @param left defines 1st vector
  83182. * @param right defines 2nd vector
  83183. * @returns a new Vector2
  83184. */
  83185. static Minimize(left: DeepImmutable<Vector2>, right: DeepImmutable<Vector2>): Vector2;
  83186. /**
  83187. * Gets a new Vecto2 set with the maximal coordinate values from the "left" and "right" vectors
  83188. * @param left defines 1st vector
  83189. * @param right defines 2nd vector
  83190. * @returns a new Vector2
  83191. */
  83192. static Maximize(left: DeepImmutable<Vector2>, right: DeepImmutable<Vector2>): Vector2;
  83193. /**
  83194. * Gets a new Vector2 set with the transformed coordinates of the given vector by the given transformation matrix
  83195. * @param vector defines the vector to transform
  83196. * @param transformation defines the matrix to apply
  83197. * @returns a new Vector2
  83198. */
  83199. static Transform(vector: DeepImmutable<Vector2>, transformation: DeepImmutable<Matrix>): Vector2;
  83200. /**
  83201. * Transforms the given vector coordinates by the given transformation matrix and stores the result in the vector "result" coordinates
  83202. * @param vector defines the vector to transform
  83203. * @param transformation defines the matrix to apply
  83204. * @param result defines the target vector
  83205. */
  83206. static TransformToRef(vector: DeepImmutable<Vector2>, transformation: DeepImmutable<Matrix>, result: Vector2): void;
  83207. /**
  83208. * Determines if a given vector is included in a triangle
  83209. * @param p defines the vector to test
  83210. * @param p0 defines 1st triangle point
  83211. * @param p1 defines 2nd triangle point
  83212. * @param p2 defines 3rd triangle point
  83213. * @returns true if the point "p" is in the triangle defined by the vertors "p0", "p1", "p2"
  83214. */
  83215. static PointInTriangle(p: DeepImmutable<Vector2>, p0: DeepImmutable<Vector2>, p1: DeepImmutable<Vector2>, p2: DeepImmutable<Vector2>): boolean;
  83216. /**
  83217. * Gets the distance between the vectors "value1" and "value2"
  83218. * @param value1 defines first vector
  83219. * @param value2 defines second vector
  83220. * @returns the distance between vectors
  83221. */
  83222. static Distance(value1: DeepImmutable<Vector2>, value2: DeepImmutable<Vector2>): number;
  83223. /**
  83224. * Returns the squared distance between the vectors "value1" and "value2"
  83225. * @param value1 defines first vector
  83226. * @param value2 defines second vector
  83227. * @returns the squared distance between vectors
  83228. */
  83229. static DistanceSquared(value1: DeepImmutable<Vector2>, value2: DeepImmutable<Vector2>): number;
  83230. /**
  83231. * Gets a new Vector2 located at the center of the vectors "value1" and "value2"
  83232. * @param value1 defines first vector
  83233. * @param value2 defines second vector
  83234. * @returns a new Vector2
  83235. */
  83236. static Center(value1: DeepImmutable<Vector2>, value2: DeepImmutable<Vector2>): Vector2;
  83237. /**
  83238. * Gets the shortest distance (float) between the point "p" and the segment defined by the two points "segA" and "segB".
  83239. * @param p defines the middle point
  83240. * @param segA defines one point of the segment
  83241. * @param segB defines the other point of the segment
  83242. * @returns the shortest distance
  83243. */
  83244. static DistanceOfPointFromSegment(p: DeepImmutable<Vector2>, segA: DeepImmutable<Vector2>, segB: DeepImmutable<Vector2>): number;
  83245. }
  83246. /**
  83247. * Class used to store (x,y,z) vector representation
  83248. * A Vector3 is the main object used in 3D geometry
  83249. * It can represent etiher the coordinates of a point the space, either a direction
  83250. * Reminder: js uses a left handed forward facing system
  83251. */
  83252. export class Vector3 {
  83253. private static _UpReadOnly;
  83254. private static _ZeroReadOnly;
  83255. /** @hidden */
  83256. _x: number;
  83257. /** @hidden */
  83258. _y: number;
  83259. /** @hidden */
  83260. _z: number;
  83261. /** @hidden */
  83262. _isDirty: boolean;
  83263. /** Gets or sets the x coordinate */
  83264. get x(): number;
  83265. set x(value: number);
  83266. /** Gets or sets the y coordinate */
  83267. get y(): number;
  83268. set y(value: number);
  83269. /** Gets or sets the z coordinate */
  83270. get z(): number;
  83271. set z(value: number);
  83272. /**
  83273. * Creates a new Vector3 object from the given x, y, z (floats) coordinates.
  83274. * @param x defines the first coordinates (on X axis)
  83275. * @param y defines the second coordinates (on Y axis)
  83276. * @param z defines the third coordinates (on Z axis)
  83277. */
  83278. constructor(x?: number, y?: number, z?: number);
  83279. /**
  83280. * Creates a string representation of the Vector3
  83281. * @returns a string with the Vector3 coordinates.
  83282. */
  83283. toString(): string;
  83284. /**
  83285. * Gets the class name
  83286. * @returns the string "Vector3"
  83287. */
  83288. getClassName(): string;
  83289. /**
  83290. * Creates the Vector3 hash code
  83291. * @returns a number which tends to be unique between Vector3 instances
  83292. */
  83293. getHashCode(): number;
  83294. /**
  83295. * Creates an array containing three elements : the coordinates of the Vector3
  83296. * @returns a new array of numbers
  83297. */
  83298. asArray(): number[];
  83299. /**
  83300. * Populates the given array or Float32Array from the given index with the successive coordinates of the Vector3
  83301. * @param array defines the destination array
  83302. * @param index defines the offset in the destination array
  83303. * @returns the current Vector3
  83304. */
  83305. toArray(array: FloatArray, index?: number): Vector3;
  83306. /**
  83307. * Update the current vector from an array
  83308. * @param array defines the destination array
  83309. * @param index defines the offset in the destination array
  83310. * @returns the current Vector3
  83311. */
  83312. fromArray(array: FloatArray, index?: number): Vector3;
  83313. /**
  83314. * Converts the current Vector3 into a quaternion (considering that the Vector3 contains Euler angles representation of a rotation)
  83315. * @returns a new Quaternion object, computed from the Vector3 coordinates
  83316. */
  83317. toQuaternion(): Quaternion;
  83318. /**
  83319. * Adds the given vector to the current Vector3
  83320. * @param otherVector defines the second operand
  83321. * @returns the current updated Vector3
  83322. */
  83323. addInPlace(otherVector: DeepImmutable<Vector3>): Vector3;
  83324. /**
  83325. * Adds the given coordinates to the current Vector3
  83326. * @param x defines the x coordinate of the operand
  83327. * @param y defines the y coordinate of the operand
  83328. * @param z defines the z coordinate of the operand
  83329. * @returns the current updated Vector3
  83330. */
  83331. addInPlaceFromFloats(x: number, y: number, z: number): Vector3;
  83332. /**
  83333. * Gets a new Vector3, result of the addition the current Vector3 and the given vector
  83334. * @param otherVector defines the second operand
  83335. * @returns the resulting Vector3
  83336. */
  83337. add(otherVector: DeepImmutable<Vector3>): Vector3;
  83338. /**
  83339. * Adds the current Vector3 to the given one and stores the result in the vector "result"
  83340. * @param otherVector defines the second operand
  83341. * @param result defines the Vector3 object where to store the result
  83342. * @returns the current Vector3
  83343. */
  83344. addToRef(otherVector: DeepImmutable<Vector3>, result: Vector3): Vector3;
  83345. /**
  83346. * Subtract the given vector from the current Vector3
  83347. * @param otherVector defines the second operand
  83348. * @returns the current updated Vector3
  83349. */
  83350. subtractInPlace(otherVector: DeepImmutable<Vector3>): Vector3;
  83351. /**
  83352. * Returns a new Vector3, result of the subtraction of the given vector from the current Vector3
  83353. * @param otherVector defines the second operand
  83354. * @returns the resulting Vector3
  83355. */
  83356. subtract(otherVector: DeepImmutable<Vector3>): Vector3;
  83357. /**
  83358. * Subtracts the given vector from the current Vector3 and stores the result in the vector "result".
  83359. * @param otherVector defines the second operand
  83360. * @param result defines the Vector3 object where to store the result
  83361. * @returns the current Vector3
  83362. */
  83363. subtractToRef(otherVector: DeepImmutable<Vector3>, result: Vector3): Vector3;
  83364. /**
  83365. * Returns a new Vector3 set with the subtraction of the given floats from the current Vector3 coordinates
  83366. * @param x defines the x coordinate of the operand
  83367. * @param y defines the y coordinate of the operand
  83368. * @param z defines the z coordinate of the operand
  83369. * @returns the resulting Vector3
  83370. */
  83371. subtractFromFloats(x: number, y: number, z: number): Vector3;
  83372. /**
  83373. * Subtracts the given floats from the current Vector3 coordinates and set the given vector "result" with this result
  83374. * @param x defines the x coordinate of the operand
  83375. * @param y defines the y coordinate of the operand
  83376. * @param z defines the z coordinate of the operand
  83377. * @param result defines the Vector3 object where to store the result
  83378. * @returns the current Vector3
  83379. */
  83380. subtractFromFloatsToRef(x: number, y: number, z: number, result: Vector3): Vector3;
  83381. /**
  83382. * Gets a new Vector3 set with the current Vector3 negated coordinates
  83383. * @returns a new Vector3
  83384. */
  83385. negate(): Vector3;
  83386. /**
  83387. * Negate this vector in place
  83388. * @returns this
  83389. */
  83390. negateInPlace(): Vector3;
  83391. /**
  83392. * Negate the current Vector3 and stores the result in the given vector "result" coordinates
  83393. * @param result defines the Vector3 object where to store the result
  83394. * @returns the current Vector3
  83395. */
  83396. negateToRef(result: Vector3): Vector3;
  83397. /**
  83398. * Multiplies the Vector3 coordinates by the float "scale"
  83399. * @param scale defines the multiplier factor
  83400. * @returns the current updated Vector3
  83401. */
  83402. scaleInPlace(scale: number): Vector3;
  83403. /**
  83404. * Returns a new Vector3 set with the current Vector3 coordinates multiplied by the float "scale"
  83405. * @param scale defines the multiplier factor
  83406. * @returns a new Vector3
  83407. */
  83408. scale(scale: number): Vector3;
  83409. /**
  83410. * Multiplies the current Vector3 coordinates by the float "scale" and stores the result in the given vector "result" coordinates
  83411. * @param scale defines the multiplier factor
  83412. * @param result defines the Vector3 object where to store the result
  83413. * @returns the current Vector3
  83414. */
  83415. scaleToRef(scale: number, result: Vector3): Vector3;
  83416. /**
  83417. * Scale the current Vector3 values by a factor and add the result to a given Vector3
  83418. * @param scale defines the scale factor
  83419. * @param result defines the Vector3 object where to store the result
  83420. * @returns the unmodified current Vector3
  83421. */
  83422. scaleAndAddToRef(scale: number, result: Vector3): Vector3;
  83423. /**
  83424. * Projects the current vector3 to a plane along a ray starting from a specified origin and directed towards the point.
  83425. * @param origin defines the origin of the projection ray
  83426. * @param plane defines the plane to project to
  83427. * @returns the projected vector3
  83428. */
  83429. projectOnPlane(plane: Plane, origin: Vector3): Vector3;
  83430. /**
  83431. * Projects the current vector3 to a plane along a ray starting from a specified origin and directed towards the point.
  83432. * @param origin defines the origin of the projection ray
  83433. * @param plane defines the plane to project to
  83434. * @param result defines the Vector3 where to store the result
  83435. */
  83436. projectOnPlaneToRef(plane: Plane, origin: Vector3, result: Vector3): void;
  83437. /**
  83438. * Returns true if the current Vector3 and the given vector coordinates are strictly equal
  83439. * @param otherVector defines the second operand
  83440. * @returns true if both vectors are equals
  83441. */
  83442. equals(otherVector: DeepImmutable<Vector3>): boolean;
  83443. /**
  83444. * Returns true if the current Vector3 and the given vector coordinates are distant less than epsilon
  83445. * @param otherVector defines the second operand
  83446. * @param epsilon defines the minimal distance to define values as equals
  83447. * @returns true if both vectors are distant less than epsilon
  83448. */
  83449. equalsWithEpsilon(otherVector: DeepImmutable<Vector3>, epsilon?: number): boolean;
  83450. /**
  83451. * Returns true if the current Vector3 coordinates equals the given floats
  83452. * @param x defines the x coordinate of the operand
  83453. * @param y defines the y coordinate of the operand
  83454. * @param z defines the z coordinate of the operand
  83455. * @returns true if both vectors are equals
  83456. */
  83457. equalsToFloats(x: number, y: number, z: number): boolean;
  83458. /**
  83459. * Multiplies the current Vector3 coordinates by the given ones
  83460. * @param otherVector defines the second operand
  83461. * @returns the current updated Vector3
  83462. */
  83463. multiplyInPlace(otherVector: DeepImmutable<Vector3>): Vector3;
  83464. /**
  83465. * Returns a new Vector3, result of the multiplication of the current Vector3 by the given vector
  83466. * @param otherVector defines the second operand
  83467. * @returns the new Vector3
  83468. */
  83469. multiply(otherVector: DeepImmutable<Vector3>): Vector3;
  83470. /**
  83471. * Multiplies the current Vector3 by the given one and stores the result in the given vector "result"
  83472. * @param otherVector defines the second operand
  83473. * @param result defines the Vector3 object where to store the result
  83474. * @returns the current Vector3
  83475. */
  83476. multiplyToRef(otherVector: DeepImmutable<Vector3>, result: Vector3): Vector3;
  83477. /**
  83478. * Returns a new Vector3 set with the result of the mulliplication of the current Vector3 coordinates by the given floats
  83479. * @param x defines the x coordinate of the operand
  83480. * @param y defines the y coordinate of the operand
  83481. * @param z defines the z coordinate of the operand
  83482. * @returns the new Vector3
  83483. */
  83484. multiplyByFloats(x: number, y: number, z: number): Vector3;
  83485. /**
  83486. * Returns a new Vector3 set with the result of the division of the current Vector3 coordinates by the given ones
  83487. * @param otherVector defines the second operand
  83488. * @returns the new Vector3
  83489. */
  83490. divide(otherVector: DeepImmutable<Vector3>): Vector3;
  83491. /**
  83492. * Divides the current Vector3 coordinates by the given ones and stores the result in the given vector "result"
  83493. * @param otherVector defines the second operand
  83494. * @param result defines the Vector3 object where to store the result
  83495. * @returns the current Vector3
  83496. */
  83497. divideToRef(otherVector: DeepImmutable<Vector3>, result: Vector3): Vector3;
  83498. /**
  83499. * Divides the current Vector3 coordinates by the given ones.
  83500. * @param otherVector defines the second operand
  83501. * @returns the current updated Vector3
  83502. */
  83503. divideInPlace(otherVector: Vector3): Vector3;
  83504. /**
  83505. * Updates the current Vector3 with the minimal coordinate values between its and the given vector ones
  83506. * @param other defines the second operand
  83507. * @returns the current updated Vector3
  83508. */
  83509. minimizeInPlace(other: DeepImmutable<Vector3>): Vector3;
  83510. /**
  83511. * Updates the current Vector3 with the maximal coordinate values between its and the given vector ones.
  83512. * @param other defines the second operand
  83513. * @returns the current updated Vector3
  83514. */
  83515. maximizeInPlace(other: DeepImmutable<Vector3>): Vector3;
  83516. /**
  83517. * Updates the current Vector3 with the minimal coordinate values between its and the given coordinates
  83518. * @param x defines the x coordinate of the operand
  83519. * @param y defines the y coordinate of the operand
  83520. * @param z defines the z coordinate of the operand
  83521. * @returns the current updated Vector3
  83522. */
  83523. minimizeInPlaceFromFloats(x: number, y: number, z: number): Vector3;
  83524. /**
  83525. * Updates the current Vector3 with the maximal coordinate values between its and the given coordinates.
  83526. * @param x defines the x coordinate of the operand
  83527. * @param y defines the y coordinate of the operand
  83528. * @param z defines the z coordinate of the operand
  83529. * @returns the current updated Vector3
  83530. */
  83531. maximizeInPlaceFromFloats(x: number, y: number, z: number): Vector3;
  83532. /**
  83533. * Due to float precision, scale of a mesh could be uniform but float values are off by a small fraction
  83534. * Check if is non uniform within a certain amount of decimal places to account for this
  83535. * @param epsilon the amount the values can differ
  83536. * @returns if the the vector is non uniform to a certain number of decimal places
  83537. */
  83538. isNonUniformWithinEpsilon(epsilon: number): boolean;
  83539. /**
  83540. * Gets a boolean indicating that the vector is non uniform meaning x, y or z are not all the same
  83541. */
  83542. get isNonUniform(): boolean;
  83543. /**
  83544. * Gets a new Vector3 from current Vector3 floored values
  83545. * @returns a new Vector3
  83546. */
  83547. floor(): Vector3;
  83548. /**
  83549. * Gets a new Vector3 from current Vector3 floored values
  83550. * @returns a new Vector3
  83551. */
  83552. fract(): Vector3;
  83553. /**
  83554. * Gets the length of the Vector3
  83555. * @returns the length of the Vector3
  83556. */
  83557. length(): number;
  83558. /**
  83559. * Gets the squared length of the Vector3
  83560. * @returns squared length of the Vector3
  83561. */
  83562. lengthSquared(): number;
  83563. /**
  83564. * Normalize the current Vector3.
  83565. * Please note that this is an in place operation.
  83566. * @returns the current updated Vector3
  83567. */
  83568. normalize(): Vector3;
  83569. /**
  83570. * Reorders the x y z properties of the vector in place
  83571. * @param order new ordering of the properties (eg. for vector 1,2,3 with "ZYX" will produce 3,2,1)
  83572. * @returns the current updated vector
  83573. */
  83574. reorderInPlace(order: string): this;
  83575. /**
  83576. * Rotates the vector around 0,0,0 by a quaternion
  83577. * @param quaternion the rotation quaternion
  83578. * @param result vector to store the result
  83579. * @returns the resulting vector
  83580. */
  83581. rotateByQuaternionToRef(quaternion: Quaternion, result: Vector3): Vector3;
  83582. /**
  83583. * Rotates a vector around a given point
  83584. * @param quaternion the rotation quaternion
  83585. * @param point the point to rotate around
  83586. * @param result vector to store the result
  83587. * @returns the resulting vector
  83588. */
  83589. rotateByQuaternionAroundPointToRef(quaternion: Quaternion, point: Vector3, result: Vector3): Vector3;
  83590. /**
  83591. * Returns a new Vector3 as the cross product of the current vector and the "other" one
  83592. * The cross product is then orthogonal to both current and "other"
  83593. * @param other defines the right operand
  83594. * @returns the cross product
  83595. */
  83596. cross(other: Vector3): Vector3;
  83597. /**
  83598. * Normalize the current Vector3 with the given input length.
  83599. * Please note that this is an in place operation.
  83600. * @param len the length of the vector
  83601. * @returns the current updated Vector3
  83602. */
  83603. normalizeFromLength(len: number): Vector3;
  83604. /**
  83605. * Normalize the current Vector3 to a new vector
  83606. * @returns the new Vector3
  83607. */
  83608. normalizeToNew(): Vector3;
  83609. /**
  83610. * Normalize the current Vector3 to the reference
  83611. * @param reference define the Vector3 to update
  83612. * @returns the updated Vector3
  83613. */
  83614. normalizeToRef(reference: Vector3): Vector3;
  83615. /**
  83616. * Creates a new Vector3 copied from the current Vector3
  83617. * @returns the new Vector3
  83618. */
  83619. clone(): Vector3;
  83620. /**
  83621. * Copies the given vector coordinates to the current Vector3 ones
  83622. * @param source defines the source Vector3
  83623. * @returns the current updated Vector3
  83624. */
  83625. copyFrom(source: DeepImmutable<Vector3>): Vector3;
  83626. /**
  83627. * Copies the given floats to the current Vector3 coordinates
  83628. * @param x defines the x coordinate of the operand
  83629. * @param y defines the y coordinate of the operand
  83630. * @param z defines the z coordinate of the operand
  83631. * @returns the current updated Vector3
  83632. */
  83633. copyFromFloats(x: number, y: number, z: number): Vector3;
  83634. /**
  83635. * Copies the given floats to the current Vector3 coordinates
  83636. * @param x defines the x coordinate of the operand
  83637. * @param y defines the y coordinate of the operand
  83638. * @param z defines the z coordinate of the operand
  83639. * @returns the current updated Vector3
  83640. */
  83641. set(x: number, y: number, z: number): Vector3;
  83642. /**
  83643. * Copies the given float to the current Vector3 coordinates
  83644. * @param v defines the x, y and z coordinates of the operand
  83645. * @returns the current updated Vector3
  83646. */
  83647. setAll(v: number): Vector3;
  83648. /**
  83649. * Get the clip factor between two vectors
  83650. * @param vector0 defines the first operand
  83651. * @param vector1 defines the second operand
  83652. * @param axis defines the axis to use
  83653. * @param size defines the size along the axis
  83654. * @returns the clip factor
  83655. */
  83656. static GetClipFactor(vector0: DeepImmutable<Vector3>, vector1: DeepImmutable<Vector3>, axis: DeepImmutable<Vector3>, size: number): number;
  83657. /**
  83658. * Get angle between two vectors
  83659. * @param vector0 angle between vector0 and vector1
  83660. * @param vector1 angle between vector0 and vector1
  83661. * @param normal direction of the normal
  83662. * @return the angle between vector0 and vector1
  83663. */
  83664. static GetAngleBetweenVectors(vector0: DeepImmutable<Vector3>, vector1: DeepImmutable<Vector3>, normal: DeepImmutable<Vector3>): number;
  83665. /**
  83666. * Returns a new Vector3 set from the index "offset" of the given array
  83667. * @param array defines the source array
  83668. * @param offset defines the offset in the source array
  83669. * @returns the new Vector3
  83670. */
  83671. static FromArray(array: DeepImmutable<ArrayLike<number>>, offset?: number): Vector3;
  83672. /**
  83673. * Returns a new Vector3 set from the index "offset" of the given Float32Array
  83674. * @param array defines the source array
  83675. * @param offset defines the offset in the source array
  83676. * @returns the new Vector3
  83677. * @deprecated Please use FromArray instead.
  83678. */
  83679. static FromFloatArray(array: DeepImmutable<Float32Array>, offset?: number): Vector3;
  83680. /**
  83681. * Sets the given vector "result" with the element values from the index "offset" of the given array
  83682. * @param array defines the source array
  83683. * @param offset defines the offset in the source array
  83684. * @param result defines the Vector3 where to store the result
  83685. */
  83686. static FromArrayToRef(array: DeepImmutable<ArrayLike<number>>, offset: number, result: Vector3): void;
  83687. /**
  83688. * Sets the given vector "result" with the element values from the index "offset" of the given Float32Array
  83689. * @param array defines the source array
  83690. * @param offset defines the offset in the source array
  83691. * @param result defines the Vector3 where to store the result
  83692. * @deprecated Please use FromArrayToRef instead.
  83693. */
  83694. static FromFloatArrayToRef(array: DeepImmutable<Float32Array>, offset: number, result: Vector3): void;
  83695. /**
  83696. * Sets the given vector "result" with the given floats.
  83697. * @param x defines the x coordinate of the source
  83698. * @param y defines the y coordinate of the source
  83699. * @param z defines the z coordinate of the source
  83700. * @param result defines the Vector3 where to store the result
  83701. */
  83702. static FromFloatsToRef(x: number, y: number, z: number, result: Vector3): void;
  83703. /**
  83704. * Returns a new Vector3 set to (0.0, 0.0, 0.0)
  83705. * @returns a new empty Vector3
  83706. */
  83707. static Zero(): Vector3;
  83708. /**
  83709. * Returns a new Vector3 set to (1.0, 1.0, 1.0)
  83710. * @returns a new unit Vector3
  83711. */
  83712. static One(): Vector3;
  83713. /**
  83714. * Returns a new Vector3 set to (0.0, 1.0, 0.0)
  83715. * @returns a new up Vector3
  83716. */
  83717. static Up(): Vector3;
  83718. /**
  83719. * Gets a up Vector3 that must not be updated
  83720. */
  83721. static get UpReadOnly(): DeepImmutable<Vector3>;
  83722. /**
  83723. * Gets a zero Vector3 that must not be updated
  83724. */
  83725. static get ZeroReadOnly(): DeepImmutable<Vector3>;
  83726. /**
  83727. * Returns a new Vector3 set to (0.0, -1.0, 0.0)
  83728. * @returns a new down Vector3
  83729. */
  83730. static Down(): Vector3;
  83731. /**
  83732. * Returns a new Vector3 set to (0.0, 0.0, 1.0)
  83733. * @param rightHandedSystem is the scene right-handed (negative z)
  83734. * @returns a new forward Vector3
  83735. */
  83736. static Forward(rightHandedSystem?: boolean): Vector3;
  83737. /**
  83738. * Returns a new Vector3 set to (0.0, 0.0, -1.0)
  83739. * @param rightHandedSystem is the scene right-handed (negative-z)
  83740. * @returns a new forward Vector3
  83741. */
  83742. static Backward(rightHandedSystem?: boolean): Vector3;
  83743. /**
  83744. * Returns a new Vector3 set to (1.0, 0.0, 0.0)
  83745. * @returns a new right Vector3
  83746. */
  83747. static Right(): Vector3;
  83748. /**
  83749. * Returns a new Vector3 set to (-1.0, 0.0, 0.0)
  83750. * @returns a new left Vector3
  83751. */
  83752. static Left(): Vector3;
  83753. /**
  83754. * Returns a new Vector3 set with the result of the transformation by the given matrix of the given vector.
  83755. * This method computes tranformed coordinates only, not transformed direction vectors (ie. it takes translation in account)
  83756. * @param vector defines the Vector3 to transform
  83757. * @param transformation defines the transformation matrix
  83758. * @returns the transformed Vector3
  83759. */
  83760. static TransformCoordinates(vector: DeepImmutable<Vector3>, transformation: DeepImmutable<Matrix>): Vector3;
  83761. /**
  83762. * Sets the given vector "result" coordinates with the result of the transformation by the given matrix of the given vector
  83763. * This method computes tranformed coordinates only, not transformed direction vectors (ie. it takes translation in account)
  83764. * @param vector defines the Vector3 to transform
  83765. * @param transformation defines the transformation matrix
  83766. * @param result defines the Vector3 where to store the result
  83767. */
  83768. static TransformCoordinatesToRef(vector: DeepImmutable<Vector3>, transformation: DeepImmutable<Matrix>, result: Vector3): void;
  83769. /**
  83770. * Sets the given vector "result" coordinates with the result of the transformation by the given matrix of the given floats (x, y, z)
  83771. * This method computes tranformed coordinates only, not transformed direction vectors
  83772. * @param x define the x coordinate of the source vector
  83773. * @param y define the y coordinate of the source vector
  83774. * @param z define the z coordinate of the source vector
  83775. * @param transformation defines the transformation matrix
  83776. * @param result defines the Vector3 where to store the result
  83777. */
  83778. static TransformCoordinatesFromFloatsToRef(x: number, y: number, z: number, transformation: DeepImmutable<Matrix>, result: Vector3): void;
  83779. /**
  83780. * Returns a new Vector3 set with the result of the normal transformation by the given matrix of the given vector
  83781. * This methods computes transformed normalized direction vectors only (ie. it does not apply translation)
  83782. * @param vector defines the Vector3 to transform
  83783. * @param transformation defines the transformation matrix
  83784. * @returns the new Vector3
  83785. */
  83786. static TransformNormal(vector: DeepImmutable<Vector3>, transformation: DeepImmutable<Matrix>): Vector3;
  83787. /**
  83788. * Sets the given vector "result" with the result of the normal transformation by the given matrix of the given vector
  83789. * This methods computes transformed normalized direction vectors only (ie. it does not apply translation)
  83790. * @param vector defines the Vector3 to transform
  83791. * @param transformation defines the transformation matrix
  83792. * @param result defines the Vector3 where to store the result
  83793. */
  83794. static TransformNormalToRef(vector: DeepImmutable<Vector3>, transformation: DeepImmutable<Matrix>, result: Vector3): void;
  83795. /**
  83796. * Sets the given vector "result" with the result of the normal transformation by the given matrix of the given floats (x, y, z)
  83797. * This methods computes transformed normalized direction vectors only (ie. it does not apply translation)
  83798. * @param x define the x coordinate of the source vector
  83799. * @param y define the y coordinate of the source vector
  83800. * @param z define the z coordinate of the source vector
  83801. * @param transformation defines the transformation matrix
  83802. * @param result defines the Vector3 where to store the result
  83803. */
  83804. static TransformNormalFromFloatsToRef(x: number, y: number, z: number, transformation: DeepImmutable<Matrix>, result: Vector3): void;
  83805. /**
  83806. * Returns a new Vector3 located for "amount" on the CatmullRom interpolation spline defined by the vectors "value1", "value2", "value3", "value4"
  83807. * @param value1 defines the first control point
  83808. * @param value2 defines the second control point
  83809. * @param value3 defines the third control point
  83810. * @param value4 defines the fourth control point
  83811. * @param amount defines the amount on the spline to use
  83812. * @returns the new Vector3
  83813. */
  83814. static CatmullRom(value1: DeepImmutable<Vector3>, value2: DeepImmutable<Vector3>, value3: DeepImmutable<Vector3>, value4: DeepImmutable<Vector3>, amount: number): Vector3;
  83815. /**
  83816. * 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"
  83817. * If a coordinate value of "value" is lower than one of the "min" coordinate, then this "value" coordinate is set with the "min" one
  83818. * If a coordinate value of "value" is greater than one of the "max" coordinate, then this "value" coordinate is set with the "max" one
  83819. * @param value defines the current value
  83820. * @param min defines the lower range value
  83821. * @param max defines the upper range value
  83822. * @returns the new Vector3
  83823. */
  83824. static Clamp(value: DeepImmutable<Vector3>, min: DeepImmutable<Vector3>, max: DeepImmutable<Vector3>): Vector3;
  83825. /**
  83826. * 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"
  83827. * If a coordinate value of "value" is lower than one of the "min" coordinate, then this "value" coordinate is set with the "min" one
  83828. * If a coordinate value of "value" is greater than one of the "max" coordinate, then this "value" coordinate is set with the "max" one
  83829. * @param value defines the current value
  83830. * @param min defines the lower range value
  83831. * @param max defines the upper range value
  83832. * @param result defines the Vector3 where to store the result
  83833. */
  83834. static ClampToRef(value: DeepImmutable<Vector3>, min: DeepImmutable<Vector3>, max: DeepImmutable<Vector3>, result: Vector3): void;
  83835. /**
  83836. * Checks if a given vector is inside a specific range
  83837. * @param v defines the vector to test
  83838. * @param min defines the minimum range
  83839. * @param max defines the maximum range
  83840. */
  83841. static CheckExtends(v: Vector3, min: Vector3, max: Vector3): void;
  83842. /**
  83843. * Returns a new Vector3 located for "amount" (float) on the Hermite interpolation spline defined by the vectors "value1", "tangent1", "value2", "tangent2"
  83844. * @param value1 defines the first control point
  83845. * @param tangent1 defines the first tangent vector
  83846. * @param value2 defines the second control point
  83847. * @param tangent2 defines the second tangent vector
  83848. * @param amount defines the amount on the interpolation spline (between 0 and 1)
  83849. * @returns the new Vector3
  83850. */
  83851. static Hermite(value1: DeepImmutable<Vector3>, tangent1: DeepImmutable<Vector3>, value2: DeepImmutable<Vector3>, tangent2: DeepImmutable<Vector3>, amount: number): Vector3;
  83852. /**
  83853. * Returns a new Vector3 located for "amount" (float) on the linear interpolation between the vectors "start" and "end"
  83854. * @param start defines the start value
  83855. * @param end defines the end value
  83856. * @param amount max defines amount between both (between 0 and 1)
  83857. * @returns the new Vector3
  83858. */
  83859. static Lerp(start: DeepImmutable<Vector3>, end: DeepImmutable<Vector3>, amount: number): Vector3;
  83860. /**
  83861. * Sets the given vector "result" with the result of the linear interpolation from the vector "start" for "amount" to the vector "end"
  83862. * @param start defines the start value
  83863. * @param end defines the end value
  83864. * @param amount max defines amount between both (between 0 and 1)
  83865. * @param result defines the Vector3 where to store the result
  83866. */
  83867. static LerpToRef(start: DeepImmutable<Vector3>, end: DeepImmutable<Vector3>, amount: number, result: Vector3): void;
  83868. /**
  83869. * Returns the dot product (float) between the vectors "left" and "right"
  83870. * @param left defines the left operand
  83871. * @param right defines the right operand
  83872. * @returns the dot product
  83873. */
  83874. static Dot(left: DeepImmutable<Vector3>, right: DeepImmutable<Vector3>): number;
  83875. /**
  83876. * Returns a new Vector3 as the cross product of the vectors "left" and "right"
  83877. * The cross product is then orthogonal to both "left" and "right"
  83878. * @param left defines the left operand
  83879. * @param right defines the right operand
  83880. * @returns the cross product
  83881. */
  83882. static Cross(left: DeepImmutable<Vector3>, right: DeepImmutable<Vector3>): Vector3;
  83883. /**
  83884. * Sets the given vector "result" with the cross product of "left" and "right"
  83885. * The cross product is then orthogonal to both "left" and "right"
  83886. * @param left defines the left operand
  83887. * @param right defines the right operand
  83888. * @param result defines the Vector3 where to store the result
  83889. */
  83890. static CrossToRef(left: DeepImmutable<Vector3>, right: DeepImmutable<Vector3>, result: Vector3): void;
  83891. /**
  83892. * Returns a new Vector3 as the normalization of the given vector
  83893. * @param vector defines the Vector3 to normalize
  83894. * @returns the new Vector3
  83895. */
  83896. static Normalize(vector: DeepImmutable<Vector3>): Vector3;
  83897. /**
  83898. * Sets the given vector "result" with the normalization of the given first vector
  83899. * @param vector defines the Vector3 to normalize
  83900. * @param result defines the Vector3 where to store the result
  83901. */
  83902. static NormalizeToRef(vector: DeepImmutable<Vector3>, result: Vector3): void;
  83903. /**
  83904. * Project a Vector3 onto screen space
  83905. * @param vector defines the Vector3 to project
  83906. * @param world defines the world matrix to use
  83907. * @param transform defines the transform (view x projection) matrix to use
  83908. * @param viewport defines the screen viewport to use
  83909. * @returns the new Vector3
  83910. */
  83911. static Project(vector: DeepImmutable<Vector3>, world: DeepImmutable<Matrix>, transform: DeepImmutable<Matrix>, viewport: DeepImmutable<Viewport>): Vector3;
  83912. /**
  83913. * Project a Vector3 onto screen space to reference
  83914. * @param vector defines the Vector3 to project
  83915. * @param world defines the world matrix to use
  83916. * @param transform defines the transform (view x projection) matrix to use
  83917. * @param viewport defines the screen viewport to use
  83918. * @param result the vector in which the screen space will be stored
  83919. * @returns the new Vector3
  83920. */
  83921. static ProjectToRef(vector: DeepImmutable<Vector3>, world: DeepImmutable<Matrix>, transform: DeepImmutable<Matrix>, viewport: DeepImmutable<Viewport>, result: DeepImmutable<Vector3>): Vector3;
  83922. /** @hidden */
  83923. static _UnprojectFromInvertedMatrixToRef(source: DeepImmutable<Vector3>, matrix: DeepImmutable<Matrix>, result: Vector3): void;
  83924. /**
  83925. * Unproject from screen space to object space
  83926. * @param source defines the screen space Vector3 to use
  83927. * @param viewportWidth defines the current width of the viewport
  83928. * @param viewportHeight defines the current height of the viewport
  83929. * @param world defines the world matrix to use (can be set to Identity to go to world space)
  83930. * @param transform defines the transform (view x projection) matrix to use
  83931. * @returns the new Vector3
  83932. */
  83933. static UnprojectFromTransform(source: Vector3, viewportWidth: number, viewportHeight: number, world: DeepImmutable<Matrix>, transform: DeepImmutable<Matrix>): Vector3;
  83934. /**
  83935. * Unproject from screen space to object space
  83936. * @param source defines the screen space Vector3 to use
  83937. * @param viewportWidth defines the current width of the viewport
  83938. * @param viewportHeight defines the current height of the viewport
  83939. * @param world defines the world matrix to use (can be set to Identity to go to world space)
  83940. * @param view defines the view matrix to use
  83941. * @param projection defines the projection matrix to use
  83942. * @returns the new Vector3
  83943. */
  83944. static Unproject(source: DeepImmutable<Vector3>, viewportWidth: number, viewportHeight: number, world: DeepImmutable<Matrix>, view: DeepImmutable<Matrix>, projection: DeepImmutable<Matrix>): Vector3;
  83945. /**
  83946. * Unproject from screen space to object space
  83947. * @param source defines the screen space Vector3 to use
  83948. * @param viewportWidth defines the current width of the viewport
  83949. * @param viewportHeight defines the current height of the viewport
  83950. * @param world defines the world matrix to use (can be set to Identity to go to world space)
  83951. * @param view defines the view matrix to use
  83952. * @param projection defines the projection matrix to use
  83953. * @param result defines the Vector3 where to store the result
  83954. */
  83955. static UnprojectToRef(source: DeepImmutable<Vector3>, viewportWidth: number, viewportHeight: number, world: DeepImmutable<Matrix>, view: DeepImmutable<Matrix>, projection: DeepImmutable<Matrix>, result: Vector3): void;
  83956. /**
  83957. * Unproject from screen space to object space
  83958. * @param sourceX defines the screen space x coordinate to use
  83959. * @param sourceY defines the screen space y coordinate to use
  83960. * @param sourceZ defines the screen space z coordinate to use
  83961. * @param viewportWidth defines the current width of the viewport
  83962. * @param viewportHeight defines the current height of the viewport
  83963. * @param world defines the world matrix to use (can be set to Identity to go to world space)
  83964. * @param view defines the view matrix to use
  83965. * @param projection defines the projection matrix to use
  83966. * @param result defines the Vector3 where to store the result
  83967. */
  83968. static UnprojectFloatsToRef(sourceX: float, sourceY: float, sourceZ: float, viewportWidth: number, viewportHeight: number, world: DeepImmutable<Matrix>, view: DeepImmutable<Matrix>, projection: DeepImmutable<Matrix>, result: Vector3): void;
  83969. /**
  83970. * Gets the minimal coordinate values between two Vector3
  83971. * @param left defines the first operand
  83972. * @param right defines the second operand
  83973. * @returns the new Vector3
  83974. */
  83975. static Minimize(left: DeepImmutable<Vector3>, right: DeepImmutable<Vector3>): Vector3;
  83976. /**
  83977. * Gets the maximal coordinate values between two Vector3
  83978. * @param left defines the first operand
  83979. * @param right defines the second operand
  83980. * @returns the new Vector3
  83981. */
  83982. static Maximize(left: DeepImmutable<Vector3>, right: DeepImmutable<Vector3>): Vector3;
  83983. /**
  83984. * Returns the distance between the vectors "value1" and "value2"
  83985. * @param value1 defines the first operand
  83986. * @param value2 defines the second operand
  83987. * @returns the distance
  83988. */
  83989. static Distance(value1: DeepImmutable<Vector3>, value2: DeepImmutable<Vector3>): number;
  83990. /**
  83991. * Returns the squared distance between the vectors "value1" and "value2"
  83992. * @param value1 defines the first operand
  83993. * @param value2 defines the second operand
  83994. * @returns the squared distance
  83995. */
  83996. static DistanceSquared(value1: DeepImmutable<Vector3>, value2: DeepImmutable<Vector3>): number;
  83997. /**
  83998. * Returns a new Vector3 located at the center between "value1" and "value2"
  83999. * @param value1 defines the first operand
  84000. * @param value2 defines the second operand
  84001. * @returns the new Vector3
  84002. */
  84003. static Center(value1: DeepImmutable<Vector3>, value2: DeepImmutable<Vector3>): Vector3;
  84004. /**
  84005. * Given three orthogonal normalized left-handed oriented Vector3 axis in space (target system),
  84006. * RotationFromAxis() returns the rotation Euler angles (ex : rotation.x, rotation.y, rotation.z) to apply
  84007. * to something in order to rotate it from its local system to the given target system
  84008. * Note: axis1, axis2 and axis3 are normalized during this operation
  84009. * @param axis1 defines the first axis
  84010. * @param axis2 defines the second axis
  84011. * @param axis3 defines the third axis
  84012. * @returns a new Vector3
  84013. */
  84014. static RotationFromAxis(axis1: DeepImmutable<Vector3>, axis2: DeepImmutable<Vector3>, axis3: DeepImmutable<Vector3>): Vector3;
  84015. /**
  84016. * The same than RotationFromAxis but updates the given ref Vector3 parameter instead of returning a new Vector3
  84017. * @param axis1 defines the first axis
  84018. * @param axis2 defines the second axis
  84019. * @param axis3 defines the third axis
  84020. * @param ref defines the Vector3 where to store the result
  84021. */
  84022. static RotationFromAxisToRef(axis1: DeepImmutable<Vector3>, axis2: DeepImmutable<Vector3>, axis3: DeepImmutable<Vector3>, ref: Vector3): void;
  84023. }
  84024. /**
  84025. * Vector4 class created for EulerAngle class conversion to Quaternion
  84026. */
  84027. export class Vector4 {
  84028. /** x value of the vector */
  84029. x: number;
  84030. /** y value of the vector */
  84031. y: number;
  84032. /** z value of the vector */
  84033. z: number;
  84034. /** w value of the vector */
  84035. w: number;
  84036. /**
  84037. * Creates a Vector4 object from the given floats.
  84038. * @param x x value of the vector
  84039. * @param y y value of the vector
  84040. * @param z z value of the vector
  84041. * @param w w value of the vector
  84042. */
  84043. constructor(
  84044. /** x value of the vector */
  84045. x: number,
  84046. /** y value of the vector */
  84047. y: number,
  84048. /** z value of the vector */
  84049. z: number,
  84050. /** w value of the vector */
  84051. w: number);
  84052. /**
  84053. * Returns the string with the Vector4 coordinates.
  84054. * @returns a string containing all the vector values
  84055. */
  84056. toString(): string;
  84057. /**
  84058. * Returns the string "Vector4".
  84059. * @returns "Vector4"
  84060. */
  84061. getClassName(): string;
  84062. /**
  84063. * Returns the Vector4 hash code.
  84064. * @returns a unique hash code
  84065. */
  84066. getHashCode(): number;
  84067. /**
  84068. * Returns a new array populated with 4 elements : the Vector4 coordinates.
  84069. * @returns the resulting array
  84070. */
  84071. asArray(): number[];
  84072. /**
  84073. * Populates the given array from the given index with the Vector4 coordinates.
  84074. * @param array array to populate
  84075. * @param index index of the array to start at (default: 0)
  84076. * @returns the Vector4.
  84077. */
  84078. toArray(array: FloatArray, index?: number): Vector4;
  84079. /**
  84080. * Update the current vector from an array
  84081. * @param array defines the destination array
  84082. * @param index defines the offset in the destination array
  84083. * @returns the current Vector3
  84084. */
  84085. fromArray(array: FloatArray, index?: number): Vector4;
  84086. /**
  84087. * Adds the given vector to the current Vector4.
  84088. * @param otherVector the vector to add
  84089. * @returns the updated Vector4.
  84090. */
  84091. addInPlace(otherVector: DeepImmutable<Vector4>): Vector4;
  84092. /**
  84093. * Returns a new Vector4 as the result of the addition of the current Vector4 and the given one.
  84094. * @param otherVector the vector to add
  84095. * @returns the resulting vector
  84096. */
  84097. add(otherVector: DeepImmutable<Vector4>): Vector4;
  84098. /**
  84099. * Updates the given vector "result" with the result of the addition of the current Vector4 and the given one.
  84100. * @param otherVector the vector to add
  84101. * @param result the vector to store the result
  84102. * @returns the current Vector4.
  84103. */
  84104. addToRef(otherVector: DeepImmutable<Vector4>, result: Vector4): Vector4;
  84105. /**
  84106. * Subtract in place the given vector from the current Vector4.
  84107. * @param otherVector the vector to subtract
  84108. * @returns the updated Vector4.
  84109. */
  84110. subtractInPlace(otherVector: DeepImmutable<Vector4>): Vector4;
  84111. /**
  84112. * Returns a new Vector4 with the result of the subtraction of the given vector from the current Vector4.
  84113. * @param otherVector the vector to add
  84114. * @returns the new vector with the result
  84115. */
  84116. subtract(otherVector: DeepImmutable<Vector4>): Vector4;
  84117. /**
  84118. * Sets the given vector "result" with the result of the subtraction of the given vector from the current Vector4.
  84119. * @param otherVector the vector to subtract
  84120. * @param result the vector to store the result
  84121. * @returns the current Vector4.
  84122. */
  84123. subtractToRef(otherVector: DeepImmutable<Vector4>, result: Vector4): Vector4;
  84124. /**
  84125. * Returns a new Vector4 set with the result of the subtraction of the given floats from the current Vector4 coordinates.
  84126. */
  84127. /**
  84128. * Returns a new Vector4 set with the result of the subtraction of the given floats from the current Vector4 coordinates.
  84129. * @param x value to subtract
  84130. * @param y value to subtract
  84131. * @param z value to subtract
  84132. * @param w value to subtract
  84133. * @returns new vector containing the result
  84134. */
  84135. subtractFromFloats(x: number, y: number, z: number, w: number): Vector4;
  84136. /**
  84137. * Sets the given vector "result" set with the result of the subtraction of the given floats from the current Vector4 coordinates.
  84138. * @param x value to subtract
  84139. * @param y value to subtract
  84140. * @param z value to subtract
  84141. * @param w value to subtract
  84142. * @param result the vector to store the result in
  84143. * @returns the current Vector4.
  84144. */
  84145. subtractFromFloatsToRef(x: number, y: number, z: number, w: number, result: Vector4): Vector4;
  84146. /**
  84147. * Returns a new Vector4 set with the current Vector4 negated coordinates.
  84148. * @returns a new vector with the negated values
  84149. */
  84150. negate(): Vector4;
  84151. /**
  84152. * Negate this vector in place
  84153. * @returns this
  84154. */
  84155. negateInPlace(): Vector4;
  84156. /**
  84157. * Negate the current Vector4 and stores the result in the given vector "result" coordinates
  84158. * @param result defines the Vector3 object where to store the result
  84159. * @returns the current Vector4
  84160. */
  84161. negateToRef(result: Vector4): Vector4;
  84162. /**
  84163. * Multiplies the current Vector4 coordinates by scale (float).
  84164. * @param scale the number to scale with
  84165. * @returns the updated Vector4.
  84166. */
  84167. scaleInPlace(scale: number): Vector4;
  84168. /**
  84169. * Returns a new Vector4 set with the current Vector4 coordinates multiplied by scale (float).
  84170. * @param scale the number to scale with
  84171. * @returns a new vector with the result
  84172. */
  84173. scale(scale: number): Vector4;
  84174. /**
  84175. * Sets the given vector "result" with the current Vector4 coordinates multiplied by scale (float).
  84176. * @param scale the number to scale with
  84177. * @param result a vector to store the result in
  84178. * @returns the current Vector4.
  84179. */
  84180. scaleToRef(scale: number, result: Vector4): Vector4;
  84181. /**
  84182. * Scale the current Vector4 values by a factor and add the result to a given Vector4
  84183. * @param scale defines the scale factor
  84184. * @param result defines the Vector4 object where to store the result
  84185. * @returns the unmodified current Vector4
  84186. */
  84187. scaleAndAddToRef(scale: number, result: Vector4): Vector4;
  84188. /**
  84189. * Boolean : True if the current Vector4 coordinates are stricly equal to the given ones.
  84190. * @param otherVector the vector to compare against
  84191. * @returns true if they are equal
  84192. */
  84193. equals(otherVector: DeepImmutable<Vector4>): boolean;
  84194. /**
  84195. * Boolean : True if the current Vector4 coordinates are each beneath the distance "epsilon" from the given vector ones.
  84196. * @param otherVector vector to compare against
  84197. * @param epsilon (Default: very small number)
  84198. * @returns true if they are equal
  84199. */
  84200. equalsWithEpsilon(otherVector: DeepImmutable<Vector4>, epsilon?: number): boolean;
  84201. /**
  84202. * Boolean : True if the given floats are strictly equal to the current Vector4 coordinates.
  84203. * @param x x value to compare against
  84204. * @param y y value to compare against
  84205. * @param z z value to compare against
  84206. * @param w w value to compare against
  84207. * @returns true if equal
  84208. */
  84209. equalsToFloats(x: number, y: number, z: number, w: number): boolean;
  84210. /**
  84211. * Multiplies in place the current Vector4 by the given one.
  84212. * @param otherVector vector to multiple with
  84213. * @returns the updated Vector4.
  84214. */
  84215. multiplyInPlace(otherVector: Vector4): Vector4;
  84216. /**
  84217. * Returns a new Vector4 set with the multiplication result of the current Vector4 and the given one.
  84218. * @param otherVector vector to multiple with
  84219. * @returns resulting new vector
  84220. */
  84221. multiply(otherVector: DeepImmutable<Vector4>): Vector4;
  84222. /**
  84223. * Updates the given vector "result" with the multiplication result of the current Vector4 and the given one.
  84224. * @param otherVector vector to multiple with
  84225. * @param result vector to store the result
  84226. * @returns the current Vector4.
  84227. */
  84228. multiplyToRef(otherVector: DeepImmutable<Vector4>, result: Vector4): Vector4;
  84229. /**
  84230. * Returns a new Vector4 set with the multiplication result of the given floats and the current Vector4 coordinates.
  84231. * @param x x value multiply with
  84232. * @param y y value multiply with
  84233. * @param z z value multiply with
  84234. * @param w w value multiply with
  84235. * @returns resulting new vector
  84236. */
  84237. multiplyByFloats(x: number, y: number, z: number, w: number): Vector4;
  84238. /**
  84239. * Returns a new Vector4 set with the division result of the current Vector4 by the given one.
  84240. * @param otherVector vector to devide with
  84241. * @returns resulting new vector
  84242. */
  84243. divide(otherVector: DeepImmutable<Vector4>): Vector4;
  84244. /**
  84245. * Updates the given vector "result" with the division result of the current Vector4 by the given one.
  84246. * @param otherVector vector to devide with
  84247. * @param result vector to store the result
  84248. * @returns the current Vector4.
  84249. */
  84250. divideToRef(otherVector: DeepImmutable<Vector4>, result: Vector4): Vector4;
  84251. /**
  84252. * Divides the current Vector3 coordinates by the given ones.
  84253. * @param otherVector vector to devide with
  84254. * @returns the updated Vector3.
  84255. */
  84256. divideInPlace(otherVector: DeepImmutable<Vector4>): Vector4;
  84257. /**
  84258. * Updates the Vector4 coordinates with the minimum values between its own and the given vector ones
  84259. * @param other defines the second operand
  84260. * @returns the current updated Vector4
  84261. */
  84262. minimizeInPlace(other: DeepImmutable<Vector4>): Vector4;
  84263. /**
  84264. * Updates the Vector4 coordinates with the maximum values between its own and the given vector ones
  84265. * @param other defines the second operand
  84266. * @returns the current updated Vector4
  84267. */
  84268. maximizeInPlace(other: DeepImmutable<Vector4>): Vector4;
  84269. /**
  84270. * Gets a new Vector4 from current Vector4 floored values
  84271. * @returns a new Vector4
  84272. */
  84273. floor(): Vector4;
  84274. /**
  84275. * Gets a new Vector4 from current Vector3 floored values
  84276. * @returns a new Vector4
  84277. */
  84278. fract(): Vector4;
  84279. /**
  84280. * Returns the Vector4 length (float).
  84281. * @returns the length
  84282. */
  84283. length(): number;
  84284. /**
  84285. * Returns the Vector4 squared length (float).
  84286. * @returns the length squared
  84287. */
  84288. lengthSquared(): number;
  84289. /**
  84290. * Normalizes in place the Vector4.
  84291. * @returns the updated Vector4.
  84292. */
  84293. normalize(): Vector4;
  84294. /**
  84295. * Returns a new Vector3 from the Vector4 (x, y, z) coordinates.
  84296. * @returns this converted to a new vector3
  84297. */
  84298. toVector3(): Vector3;
  84299. /**
  84300. * Returns a new Vector4 copied from the current one.
  84301. * @returns the new cloned vector
  84302. */
  84303. clone(): Vector4;
  84304. /**
  84305. * Updates the current Vector4 with the given one coordinates.
  84306. * @param source the source vector to copy from
  84307. * @returns the updated Vector4.
  84308. */
  84309. copyFrom(source: DeepImmutable<Vector4>): Vector4;
  84310. /**
  84311. * Updates the current Vector4 coordinates with the given floats.
  84312. * @param x float to copy from
  84313. * @param y float to copy from
  84314. * @param z float to copy from
  84315. * @param w float to copy from
  84316. * @returns the updated Vector4.
  84317. */
  84318. copyFromFloats(x: number, y: number, z: number, w: number): Vector4;
  84319. /**
  84320. * Updates the current Vector4 coordinates with the given floats.
  84321. * @param x float to set from
  84322. * @param y float to set from
  84323. * @param z float to set from
  84324. * @param w float to set from
  84325. * @returns the updated Vector4.
  84326. */
  84327. set(x: number, y: number, z: number, w: number): Vector4;
  84328. /**
  84329. * Copies the given float to the current Vector3 coordinates
  84330. * @param v defines the x, y, z and w coordinates of the operand
  84331. * @returns the current updated Vector3
  84332. */
  84333. setAll(v: number): Vector4;
  84334. /**
  84335. * Returns a new Vector4 set from the starting index of the given array.
  84336. * @param array the array to pull values from
  84337. * @param offset the offset into the array to start at
  84338. * @returns the new vector
  84339. */
  84340. static FromArray(array: DeepImmutable<ArrayLike<number>>, offset?: number): Vector4;
  84341. /**
  84342. * Updates the given vector "result" from the starting index of the given array.
  84343. * @param array the array to pull values from
  84344. * @param offset the offset into the array to start at
  84345. * @param result the vector to store the result in
  84346. */
  84347. static FromArrayToRef(array: DeepImmutable<ArrayLike<number>>, offset: number, result: Vector4): void;
  84348. /**
  84349. * Updates the given vector "result" from the starting index of the given Float32Array.
  84350. * @param array the array to pull values from
  84351. * @param offset the offset into the array to start at
  84352. * @param result the vector to store the result in
  84353. */
  84354. static FromFloatArrayToRef(array: DeepImmutable<Float32Array>, offset: number, result: Vector4): void;
  84355. /**
  84356. * Updates the given vector "result" coordinates from the given floats.
  84357. * @param x float to set from
  84358. * @param y float to set from
  84359. * @param z float to set from
  84360. * @param w float to set from
  84361. * @param result the vector to the floats in
  84362. */
  84363. static FromFloatsToRef(x: number, y: number, z: number, w: number, result: Vector4): void;
  84364. /**
  84365. * Returns a new Vector4 set to (0.0, 0.0, 0.0, 0.0)
  84366. * @returns the new vector
  84367. */
  84368. static Zero(): Vector4;
  84369. /**
  84370. * Returns a new Vector4 set to (1.0, 1.0, 1.0, 1.0)
  84371. * @returns the new vector
  84372. */
  84373. static One(): Vector4;
  84374. /**
  84375. * Returns a new normalized Vector4 from the given one.
  84376. * @param vector the vector to normalize
  84377. * @returns the vector
  84378. */
  84379. static Normalize(vector: DeepImmutable<Vector4>): Vector4;
  84380. /**
  84381. * Updates the given vector "result" from the normalization of the given one.
  84382. * @param vector the vector to normalize
  84383. * @param result the vector to store the result in
  84384. */
  84385. static NormalizeToRef(vector: DeepImmutable<Vector4>, result: Vector4): void;
  84386. /**
  84387. * Returns a vector with the minimum values from the left and right vectors
  84388. * @param left left vector to minimize
  84389. * @param right right vector to minimize
  84390. * @returns a new vector with the minimum of the left and right vector values
  84391. */
  84392. static Minimize(left: DeepImmutable<Vector4>, right: DeepImmutable<Vector4>): Vector4;
  84393. /**
  84394. * Returns a vector with the maximum values from the left and right vectors
  84395. * @param left left vector to maximize
  84396. * @param right right vector to maximize
  84397. * @returns a new vector with the maximum of the left and right vector values
  84398. */
  84399. static Maximize(left: DeepImmutable<Vector4>, right: DeepImmutable<Vector4>): Vector4;
  84400. /**
  84401. * Returns the distance (float) between the vectors "value1" and "value2".
  84402. * @param value1 value to calulate the distance between
  84403. * @param value2 value to calulate the distance between
  84404. * @return the distance between the two vectors
  84405. */
  84406. static Distance(value1: DeepImmutable<Vector4>, value2: DeepImmutable<Vector4>): number;
  84407. /**
  84408. * Returns the squared distance (float) between the vectors "value1" and "value2".
  84409. * @param value1 value to calulate the distance between
  84410. * @param value2 value to calulate the distance between
  84411. * @return the distance between the two vectors squared
  84412. */
  84413. static DistanceSquared(value1: DeepImmutable<Vector4>, value2: DeepImmutable<Vector4>): number;
  84414. /**
  84415. * Returns a new Vector4 located at the center between the vectors "value1" and "value2".
  84416. * @param value1 value to calulate the center between
  84417. * @param value2 value to calulate the center between
  84418. * @return the center between the two vectors
  84419. */
  84420. static Center(value1: DeepImmutable<Vector4>, value2: DeepImmutable<Vector4>): Vector4;
  84421. /**
  84422. * Returns a new Vector4 set with the result of the normal transformation by the given matrix of the given vector.
  84423. * This methods computes transformed normalized direction vectors only.
  84424. * @param vector the vector to transform
  84425. * @param transformation the transformation matrix to apply
  84426. * @returns the new vector
  84427. */
  84428. static TransformNormal(vector: DeepImmutable<Vector4>, transformation: DeepImmutable<Matrix>): Vector4;
  84429. /**
  84430. * Sets the given vector "result" with the result of the normal transformation by the given matrix of the given vector.
  84431. * This methods computes transformed normalized direction vectors only.
  84432. * @param vector the vector to transform
  84433. * @param transformation the transformation matrix to apply
  84434. * @param result the vector to store the result in
  84435. */
  84436. static TransformNormalToRef(vector: DeepImmutable<Vector4>, transformation: DeepImmutable<Matrix>, result: Vector4): void;
  84437. /**
  84438. * Sets the given vector "result" with the result of the normal transformation by the given matrix of the given floats (x, y, z, w).
  84439. * This methods computes transformed normalized direction vectors only.
  84440. * @param x value to transform
  84441. * @param y value to transform
  84442. * @param z value to transform
  84443. * @param w value to transform
  84444. * @param transformation the transformation matrix to apply
  84445. * @param result the vector to store the results in
  84446. */
  84447. static TransformNormalFromFloatsToRef(x: number, y: number, z: number, w: number, transformation: DeepImmutable<Matrix>, result: Vector4): void;
  84448. /**
  84449. * Creates a new Vector4 from a Vector3
  84450. * @param source defines the source data
  84451. * @param w defines the 4th component (default is 0)
  84452. * @returns a new Vector4
  84453. */
  84454. static FromVector3(source: Vector3, w?: number): Vector4;
  84455. }
  84456. /**
  84457. * Class used to store quaternion data
  84458. * @see https://en.wikipedia.org/wiki/Quaternion
  84459. * @see https://doc.babylonjs.com/features/position,_rotation,_scaling
  84460. */
  84461. export class Quaternion {
  84462. /** @hidden */
  84463. _x: number;
  84464. /** @hidden */
  84465. _y: number;
  84466. /** @hidden */
  84467. _z: number;
  84468. /** @hidden */
  84469. _w: number;
  84470. /** @hidden */
  84471. _isDirty: boolean;
  84472. /** Gets or sets the x coordinate */
  84473. get x(): number;
  84474. set x(value: number);
  84475. /** Gets or sets the y coordinate */
  84476. get y(): number;
  84477. set y(value: number);
  84478. /** Gets or sets the z coordinate */
  84479. get z(): number;
  84480. set z(value: number);
  84481. /** Gets or sets the w coordinate */
  84482. get w(): number;
  84483. set w(value: number);
  84484. /**
  84485. * Creates a new Quaternion from the given floats
  84486. * @param x defines the first component (0 by default)
  84487. * @param y defines the second component (0 by default)
  84488. * @param z defines the third component (0 by default)
  84489. * @param w defines the fourth component (1.0 by default)
  84490. */
  84491. constructor(x?: number, y?: number, z?: number, w?: number);
  84492. /**
  84493. * Gets a string representation for the current quaternion
  84494. * @returns a string with the Quaternion coordinates
  84495. */
  84496. toString(): string;
  84497. /**
  84498. * Gets the class name of the quaternion
  84499. * @returns the string "Quaternion"
  84500. */
  84501. getClassName(): string;
  84502. /**
  84503. * Gets a hash code for this quaternion
  84504. * @returns the quaternion hash code
  84505. */
  84506. getHashCode(): number;
  84507. /**
  84508. * Copy the quaternion to an array
  84509. * @returns a new array populated with 4 elements from the quaternion coordinates
  84510. */
  84511. asArray(): number[];
  84512. /**
  84513. * Check if two quaternions are equals
  84514. * @param otherQuaternion defines the second operand
  84515. * @return true if the current quaternion and the given one coordinates are strictly equals
  84516. */
  84517. equals(otherQuaternion: DeepImmutable<Quaternion>): boolean;
  84518. /**
  84519. * Gets a boolean if two quaternions are equals (using an epsilon value)
  84520. * @param otherQuaternion defines the other quaternion
  84521. * @param epsilon defines the minimal distance to consider equality
  84522. * @returns true if the given quaternion coordinates are close to the current ones by a distance of epsilon.
  84523. */
  84524. equalsWithEpsilon(otherQuaternion: DeepImmutable<Quaternion>, epsilon?: number): boolean;
  84525. /**
  84526. * Clone the current quaternion
  84527. * @returns a new quaternion copied from the current one
  84528. */
  84529. clone(): Quaternion;
  84530. /**
  84531. * Copy a quaternion to the current one
  84532. * @param other defines the other quaternion
  84533. * @returns the updated current quaternion
  84534. */
  84535. copyFrom(other: DeepImmutable<Quaternion>): Quaternion;
  84536. /**
  84537. * Updates the current quaternion with the given float coordinates
  84538. * @param x defines the x coordinate
  84539. * @param y defines the y coordinate
  84540. * @param z defines the z coordinate
  84541. * @param w defines the w coordinate
  84542. * @returns the updated current quaternion
  84543. */
  84544. copyFromFloats(x: number, y: number, z: number, w: number): Quaternion;
  84545. /**
  84546. * Updates the current quaternion from the given float coordinates
  84547. * @param x defines the x coordinate
  84548. * @param y defines the y coordinate
  84549. * @param z defines the z coordinate
  84550. * @param w defines the w coordinate
  84551. * @returns the updated current quaternion
  84552. */
  84553. set(x: number, y: number, z: number, w: number): Quaternion;
  84554. /**
  84555. * Adds two quaternions
  84556. * @param other defines the second operand
  84557. * @returns a new quaternion as the addition result of the given one and the current quaternion
  84558. */
  84559. add(other: DeepImmutable<Quaternion>): Quaternion;
  84560. /**
  84561. * Add a quaternion to the current one
  84562. * @param other defines the quaternion to add
  84563. * @returns the current quaternion
  84564. */
  84565. addInPlace(other: DeepImmutable<Quaternion>): Quaternion;
  84566. /**
  84567. * Subtract two quaternions
  84568. * @param other defines the second operand
  84569. * @returns a new quaternion as the subtraction result of the given one from the current one
  84570. */
  84571. subtract(other: Quaternion): Quaternion;
  84572. /**
  84573. * Multiplies the current quaternion by a scale factor
  84574. * @param value defines the scale factor
  84575. * @returns a new quaternion set by multiplying the current quaternion coordinates by the float "scale"
  84576. */
  84577. scale(value: number): Quaternion;
  84578. /**
  84579. * Scale the current quaternion values by a factor and stores the result to a given quaternion
  84580. * @param scale defines the scale factor
  84581. * @param result defines the Quaternion object where to store the result
  84582. * @returns the unmodified current quaternion
  84583. */
  84584. scaleToRef(scale: number, result: Quaternion): Quaternion;
  84585. /**
  84586. * Multiplies in place the current quaternion by a scale factor
  84587. * @param value defines the scale factor
  84588. * @returns the current modified quaternion
  84589. */
  84590. scaleInPlace(value: number): Quaternion;
  84591. /**
  84592. * Scale the current quaternion values by a factor and add the result to a given quaternion
  84593. * @param scale defines the scale factor
  84594. * @param result defines the Quaternion object where to store the result
  84595. * @returns the unmodified current quaternion
  84596. */
  84597. scaleAndAddToRef(scale: number, result: Quaternion): Quaternion;
  84598. /**
  84599. * Multiplies two quaternions
  84600. * @param q1 defines the second operand
  84601. * @returns a new quaternion set as the multiplication result of the current one with the given one "q1"
  84602. */
  84603. multiply(q1: DeepImmutable<Quaternion>): Quaternion;
  84604. /**
  84605. * Sets the given "result" as the the multiplication result of the current one with the given one "q1"
  84606. * @param q1 defines the second operand
  84607. * @param result defines the target quaternion
  84608. * @returns the current quaternion
  84609. */
  84610. multiplyToRef(q1: DeepImmutable<Quaternion>, result: Quaternion): Quaternion;
  84611. /**
  84612. * Updates the current quaternion with the multiplication of itself with the given one "q1"
  84613. * @param q1 defines the second operand
  84614. * @returns the currentupdated quaternion
  84615. */
  84616. multiplyInPlace(q1: DeepImmutable<Quaternion>): Quaternion;
  84617. /**
  84618. * Conjugates (1-q) the current quaternion and stores the result in the given quaternion
  84619. * @param ref defines the target quaternion
  84620. * @returns the current quaternion
  84621. */
  84622. conjugateToRef(ref: Quaternion): Quaternion;
  84623. /**
  84624. * Conjugates in place (1-q) the current quaternion
  84625. * @returns the current updated quaternion
  84626. */
  84627. conjugateInPlace(): Quaternion;
  84628. /**
  84629. * Conjugates in place (1-q) the current quaternion
  84630. * @returns a new quaternion
  84631. */
  84632. conjugate(): Quaternion;
  84633. /**
  84634. * Gets length of current quaternion
  84635. * @returns the quaternion length (float)
  84636. */
  84637. length(): number;
  84638. /**
  84639. * Normalize in place the current quaternion
  84640. * @returns the current updated quaternion
  84641. */
  84642. normalize(): Quaternion;
  84643. /**
  84644. * Returns a new Vector3 set with the Euler angles translated from the current quaternion
  84645. * @param order is a reserved parameter and is ignored for now
  84646. * @returns a new Vector3 containing the Euler angles
  84647. */
  84648. toEulerAngles(order?: string): Vector3;
  84649. /**
  84650. * Sets the given vector3 "result" with the Euler angles translated from the current quaternion
  84651. * @param result defines the vector which will be filled with the Euler angles
  84652. * @returns the current unchanged quaternion
  84653. */
  84654. toEulerAnglesToRef(result: Vector3): Quaternion;
  84655. /**
  84656. * Updates the given rotation matrix with the current quaternion values
  84657. * @param result defines the target matrix
  84658. * @returns the current unchanged quaternion
  84659. */
  84660. toRotationMatrix(result: Matrix): Quaternion;
  84661. /**
  84662. * Updates the current quaternion from the given rotation matrix values
  84663. * @param matrix defines the source matrix
  84664. * @returns the current updated quaternion
  84665. */
  84666. fromRotationMatrix(matrix: DeepImmutable<Matrix>): Quaternion;
  84667. /**
  84668. * Creates a new quaternion from a rotation matrix
  84669. * @param matrix defines the source matrix
  84670. * @returns a new quaternion created from the given rotation matrix values
  84671. */
  84672. static FromRotationMatrix(matrix: DeepImmutable<Matrix>): Quaternion;
  84673. /**
  84674. * Updates the given quaternion with the given rotation matrix values
  84675. * @param matrix defines the source matrix
  84676. * @param result defines the target quaternion
  84677. */
  84678. static FromRotationMatrixToRef(matrix: DeepImmutable<Matrix>, result: Quaternion): void;
  84679. /**
  84680. * Returns the dot product (float) between the quaternions "left" and "right"
  84681. * @param left defines the left operand
  84682. * @param right defines the right operand
  84683. * @returns the dot product
  84684. */
  84685. static Dot(left: DeepImmutable<Quaternion>, right: DeepImmutable<Quaternion>): number;
  84686. /**
  84687. * Checks if the two quaternions are close to each other
  84688. * @param quat0 defines the first quaternion to check
  84689. * @param quat1 defines the second quaternion to check
  84690. * @returns true if the two quaternions are close to each other
  84691. */
  84692. static AreClose(quat0: DeepImmutable<Quaternion>, quat1: DeepImmutable<Quaternion>): boolean;
  84693. /**
  84694. * Creates an empty quaternion
  84695. * @returns a new quaternion set to (0.0, 0.0, 0.0)
  84696. */
  84697. static Zero(): Quaternion;
  84698. /**
  84699. * Inverse a given quaternion
  84700. * @param q defines the source quaternion
  84701. * @returns a new quaternion as the inverted current quaternion
  84702. */
  84703. static Inverse(q: DeepImmutable<Quaternion>): Quaternion;
  84704. /**
  84705. * Inverse a given quaternion
  84706. * @param q defines the source quaternion
  84707. * @param result the quaternion the result will be stored in
  84708. * @returns the result quaternion
  84709. */
  84710. static InverseToRef(q: Quaternion, result: Quaternion): Quaternion;
  84711. /**
  84712. * Creates an identity quaternion
  84713. * @returns the identity quaternion
  84714. */
  84715. static Identity(): Quaternion;
  84716. /**
  84717. * Gets a boolean indicating if the given quaternion is identity
  84718. * @param quaternion defines the quaternion to check
  84719. * @returns true if the quaternion is identity
  84720. */
  84721. static IsIdentity(quaternion: DeepImmutable<Quaternion>): boolean;
  84722. /**
  84723. * Creates a quaternion from a rotation around an axis
  84724. * @param axis defines the axis to use
  84725. * @param angle defines the angle to use
  84726. * @returns a new quaternion created from the given axis (Vector3) and angle in radians (float)
  84727. */
  84728. static RotationAxis(axis: DeepImmutable<Vector3>, angle: number): Quaternion;
  84729. /**
  84730. * Creates a rotation around an axis and stores it into the given quaternion
  84731. * @param axis defines the axis to use
  84732. * @param angle defines the angle to use
  84733. * @param result defines the target quaternion
  84734. * @returns the target quaternion
  84735. */
  84736. static RotationAxisToRef(axis: DeepImmutable<Vector3>, angle: number, result: Quaternion): Quaternion;
  84737. /**
  84738. * Creates a new quaternion from data stored into an array
  84739. * @param array defines the data source
  84740. * @param offset defines the offset in the source array where the data starts
  84741. * @returns a new quaternion
  84742. */
  84743. static FromArray(array: DeepImmutable<ArrayLike<number>>, offset?: number): Quaternion;
  84744. /**
  84745. * Updates the given quaternion "result" from the starting index of the given array.
  84746. * @param array the array to pull values from
  84747. * @param offset the offset into the array to start at
  84748. * @param result the quaternion to store the result in
  84749. */
  84750. static FromArrayToRef(array: DeepImmutable<ArrayLike<number>>, offset: number, result: Quaternion): void;
  84751. /**
  84752. * Create a quaternion from Euler rotation angles
  84753. * @param x Pitch
  84754. * @param y Yaw
  84755. * @param z Roll
  84756. * @returns the new Quaternion
  84757. */
  84758. static FromEulerAngles(x: number, y: number, z: number): Quaternion;
  84759. /**
  84760. * Updates a quaternion from Euler rotation angles
  84761. * @param x Pitch
  84762. * @param y Yaw
  84763. * @param z Roll
  84764. * @param result the quaternion to store the result
  84765. * @returns the updated quaternion
  84766. */
  84767. static FromEulerAnglesToRef(x: number, y: number, z: number, result: Quaternion): Quaternion;
  84768. /**
  84769. * Create a quaternion from Euler rotation vector
  84770. * @param vec the Euler vector (x Pitch, y Yaw, z Roll)
  84771. * @returns the new Quaternion
  84772. */
  84773. static FromEulerVector(vec: DeepImmutable<Vector3>): Quaternion;
  84774. /**
  84775. * Updates a quaternion from Euler rotation vector
  84776. * @param vec the Euler vector (x Pitch, y Yaw, z Roll)
  84777. * @param result the quaternion to store the result
  84778. * @returns the updated quaternion
  84779. */
  84780. static FromEulerVectorToRef(vec: DeepImmutable<Vector3>, result: Quaternion): Quaternion;
  84781. /**
  84782. * Creates a new quaternion from the given Euler float angles (y, x, z)
  84783. * @param yaw defines the rotation around Y axis
  84784. * @param pitch defines the rotation around X axis
  84785. * @param roll defines the rotation around Z axis
  84786. * @returns the new quaternion
  84787. */
  84788. static RotationYawPitchRoll(yaw: number, pitch: number, roll: number): Quaternion;
  84789. /**
  84790. * Creates a new rotation from the given Euler float angles (y, x, z) and stores it in the target quaternion
  84791. * @param yaw defines the rotation around Y axis
  84792. * @param pitch defines the rotation around X axis
  84793. * @param roll defines the rotation around Z axis
  84794. * @param result defines the target quaternion
  84795. */
  84796. static RotationYawPitchRollToRef(yaw: number, pitch: number, roll: number, result: Quaternion): void;
  84797. /**
  84798. * Creates a new quaternion from the given Euler float angles expressed in z-x-z orientation
  84799. * @param alpha defines the rotation around first axis
  84800. * @param beta defines the rotation around second axis
  84801. * @param gamma defines the rotation around third axis
  84802. * @returns the new quaternion
  84803. */
  84804. static RotationAlphaBetaGamma(alpha: number, beta: number, gamma: number): Quaternion;
  84805. /**
  84806. * Creates a new quaternion from the given Euler float angles expressed in z-x-z orientation and stores it in the target quaternion
  84807. * @param alpha defines the rotation around first axis
  84808. * @param beta defines the rotation around second axis
  84809. * @param gamma defines the rotation around third axis
  84810. * @param result defines the target quaternion
  84811. */
  84812. static RotationAlphaBetaGammaToRef(alpha: number, beta: number, gamma: number, result: Quaternion): void;
  84813. /**
  84814. * 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)
  84815. * @param axis1 defines the first axis
  84816. * @param axis2 defines the second axis
  84817. * @param axis3 defines the third axis
  84818. * @returns the new quaternion
  84819. */
  84820. static RotationQuaternionFromAxis(axis1: DeepImmutable<Vector3>, axis2: DeepImmutable<Vector3>, axis3: DeepImmutable<Vector3>): Quaternion;
  84821. /**
  84822. * 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
  84823. * @param axis1 defines the first axis
  84824. * @param axis2 defines the second axis
  84825. * @param axis3 defines the third axis
  84826. * @param ref defines the target quaternion
  84827. */
  84828. static RotationQuaternionFromAxisToRef(axis1: DeepImmutable<Vector3>, axis2: DeepImmutable<Vector3>, axis3: DeepImmutable<Vector3>, ref: Quaternion): void;
  84829. /**
  84830. * Interpolates between two quaternions
  84831. * @param left defines first quaternion
  84832. * @param right defines second quaternion
  84833. * @param amount defines the gradient to use
  84834. * @returns the new interpolated quaternion
  84835. */
  84836. static Slerp(left: DeepImmutable<Quaternion>, right: DeepImmutable<Quaternion>, amount: number): Quaternion;
  84837. /**
  84838. * Interpolates between two quaternions and stores it into a target quaternion
  84839. * @param left defines first quaternion
  84840. * @param right defines second quaternion
  84841. * @param amount defines the gradient to use
  84842. * @param result defines the target quaternion
  84843. */
  84844. static SlerpToRef(left: DeepImmutable<Quaternion>, right: DeepImmutable<Quaternion>, amount: number, result: Quaternion): void;
  84845. /**
  84846. * Interpolate between two quaternions using Hermite interpolation
  84847. * @param value1 defines first quaternion
  84848. * @param tangent1 defines the incoming tangent
  84849. * @param value2 defines second quaternion
  84850. * @param tangent2 defines the outgoing tangent
  84851. * @param amount defines the target quaternion
  84852. * @returns the new interpolated quaternion
  84853. */
  84854. static Hermite(value1: DeepImmutable<Quaternion>, tangent1: DeepImmutable<Quaternion>, value2: DeepImmutable<Quaternion>, tangent2: DeepImmutable<Quaternion>, amount: number): Quaternion;
  84855. }
  84856. /**
  84857. * Class used to store matrix data (4x4)
  84858. */
  84859. export class Matrix {
  84860. /**
  84861. * Gets the precision of matrix computations
  84862. */
  84863. static get Use64Bits(): boolean;
  84864. private static _updateFlagSeed;
  84865. private static _identityReadOnly;
  84866. private _isIdentity;
  84867. private _isIdentityDirty;
  84868. private _isIdentity3x2;
  84869. private _isIdentity3x2Dirty;
  84870. /**
  84871. * Gets the update flag of the matrix which is an unique number for the matrix.
  84872. * It will be incremented every time the matrix data change.
  84873. * You can use it to speed the comparison between two versions of the same matrix.
  84874. */
  84875. updateFlag: number;
  84876. private readonly _m;
  84877. /**
  84878. * Gets the internal data of the matrix
  84879. */
  84880. get m(): DeepImmutable<Float32Array | Array<number>>;
  84881. /** @hidden */
  84882. _markAsUpdated(): void;
  84883. /** @hidden */
  84884. private _updateIdentityStatus;
  84885. /**
  84886. * Creates an empty matrix (filled with zeros)
  84887. */
  84888. constructor();
  84889. /**
  84890. * Check if the current matrix is identity
  84891. * @returns true is the matrix is the identity matrix
  84892. */
  84893. isIdentity(): boolean;
  84894. /**
  84895. * Check if the current matrix is identity as a texture matrix (3x2 store in 4x4)
  84896. * @returns true is the matrix is the identity matrix
  84897. */
  84898. isIdentityAs3x2(): boolean;
  84899. /**
  84900. * Gets the determinant of the matrix
  84901. * @returns the matrix determinant
  84902. */
  84903. determinant(): number;
  84904. /**
  84905. * Returns the matrix as a Float32Array or Array<number>
  84906. * @returns the matrix underlying array
  84907. */
  84908. toArray(): DeepImmutable<Float32Array | Array<number>>;
  84909. /**
  84910. * Returns the matrix as a Float32Array or Array<number>
  84911. * @returns the matrix underlying array.
  84912. */
  84913. asArray(): DeepImmutable<Float32Array | Array<number>>;
  84914. /**
  84915. * Inverts the current matrix in place
  84916. * @returns the current inverted matrix
  84917. */
  84918. invert(): Matrix;
  84919. /**
  84920. * Sets all the matrix elements to zero
  84921. * @returns the current matrix
  84922. */
  84923. reset(): Matrix;
  84924. /**
  84925. * Adds the current matrix with a second one
  84926. * @param other defines the matrix to add
  84927. * @returns a new matrix as the addition of the current matrix and the given one
  84928. */
  84929. add(other: DeepImmutable<Matrix>): Matrix;
  84930. /**
  84931. * Sets the given matrix "result" to the addition of the current matrix and the given one
  84932. * @param other defines the matrix to add
  84933. * @param result defines the target matrix
  84934. * @returns the current matrix
  84935. */
  84936. addToRef(other: DeepImmutable<Matrix>, result: Matrix): Matrix;
  84937. /**
  84938. * Adds in place the given matrix to the current matrix
  84939. * @param other defines the second operand
  84940. * @returns the current updated matrix
  84941. */
  84942. addToSelf(other: DeepImmutable<Matrix>): Matrix;
  84943. /**
  84944. * Sets the given matrix to the current inverted Matrix
  84945. * @param other defines the target matrix
  84946. * @returns the unmodified current matrix
  84947. */
  84948. invertToRef(other: Matrix): Matrix;
  84949. /**
  84950. * add a value at the specified position in the current Matrix
  84951. * @param index the index of the value within the matrix. between 0 and 15.
  84952. * @param value the value to be added
  84953. * @returns the current updated matrix
  84954. */
  84955. addAtIndex(index: number, value: number): Matrix;
  84956. /**
  84957. * mutiply the specified position in the current Matrix by a value
  84958. * @param index the index of the value within the matrix. between 0 and 15.
  84959. * @param value the value to be added
  84960. * @returns the current updated matrix
  84961. */
  84962. multiplyAtIndex(index: number, value: number): Matrix;
  84963. /**
  84964. * Inserts the translation vector (using 3 floats) in the current matrix
  84965. * @param x defines the 1st component of the translation
  84966. * @param y defines the 2nd component of the translation
  84967. * @param z defines the 3rd component of the translation
  84968. * @returns the current updated matrix
  84969. */
  84970. setTranslationFromFloats(x: number, y: number, z: number): Matrix;
  84971. /**
  84972. * Adds the translation vector (using 3 floats) in the current matrix
  84973. * @param x defines the 1st component of the translation
  84974. * @param y defines the 2nd component of the translation
  84975. * @param z defines the 3rd component of the translation
  84976. * @returns the current updated matrix
  84977. */
  84978. addTranslationFromFloats(x: number, y: number, z: number): Matrix;
  84979. /**
  84980. * Inserts the translation vector in the current matrix
  84981. * @param vector3 defines the translation to insert
  84982. * @returns the current updated matrix
  84983. */
  84984. setTranslation(vector3: DeepImmutable<Vector3>): Matrix;
  84985. /**
  84986. * Gets the translation value of the current matrix
  84987. * @returns a new Vector3 as the extracted translation from the matrix
  84988. */
  84989. getTranslation(): Vector3;
  84990. /**
  84991. * Fill a Vector3 with the extracted translation from the matrix
  84992. * @param result defines the Vector3 where to store the translation
  84993. * @returns the current matrix
  84994. */
  84995. getTranslationToRef(result: Vector3): Matrix;
  84996. /**
  84997. * Remove rotation and scaling part from the matrix
  84998. * @returns the updated matrix
  84999. */
  85000. removeRotationAndScaling(): Matrix;
  85001. /**
  85002. * Multiply two matrices
  85003. * @param other defines the second operand
  85004. * @returns a new matrix set with the multiplication result of the current Matrix and the given one
  85005. */
  85006. multiply(other: DeepImmutable<Matrix>): Matrix;
  85007. /**
  85008. * Copy the current matrix from the given one
  85009. * @param other defines the source matrix
  85010. * @returns the current updated matrix
  85011. */
  85012. copyFrom(other: DeepImmutable<Matrix>): Matrix;
  85013. /**
  85014. * Populates the given array from the starting index with the current matrix values
  85015. * @param array defines the target array
  85016. * @param offset defines the offset in the target array where to start storing values
  85017. * @returns the current matrix
  85018. */
  85019. copyToArray(array: Float32Array | Array<number>, offset?: number): Matrix;
  85020. /**
  85021. * Sets the given matrix "result" with the multiplication result of the current Matrix and the given one
  85022. * @param other defines the second operand
  85023. * @param result defines the matrix where to store the multiplication
  85024. * @returns the current matrix
  85025. */
  85026. multiplyToRef(other: DeepImmutable<Matrix>, result: Matrix): Matrix;
  85027. /**
  85028. * Sets the Float32Array "result" from the given index "offset" with the multiplication of the current matrix and the given one
  85029. * @param other defines the second operand
  85030. * @param result defines the array where to store the multiplication
  85031. * @param offset defines the offset in the target array where to start storing values
  85032. * @returns the current matrix
  85033. */
  85034. multiplyToArray(other: DeepImmutable<Matrix>, result: Float32Array | Array<number>, offset: number): Matrix;
  85035. /**
  85036. * Check equality between this matrix and a second one
  85037. * @param value defines the second matrix to compare
  85038. * @returns true is the current matrix and the given one values are strictly equal
  85039. */
  85040. equals(value: DeepImmutable<Matrix>): boolean;
  85041. /**
  85042. * Clone the current matrix
  85043. * @returns a new matrix from the current matrix
  85044. */
  85045. clone(): Matrix;
  85046. /**
  85047. * Returns the name of the current matrix class
  85048. * @returns the string "Matrix"
  85049. */
  85050. getClassName(): string;
  85051. /**
  85052. * Gets the hash code of the current matrix
  85053. * @returns the hash code
  85054. */
  85055. getHashCode(): number;
  85056. /**
  85057. * Decomposes the current Matrix into a translation, rotation and scaling components
  85058. * @param scale defines the scale vector3 given as a reference to update
  85059. * @param rotation defines the rotation quaternion given as a reference to update
  85060. * @param translation defines the translation vector3 given as a reference to update
  85061. * @returns true if operation was successful
  85062. */
  85063. decompose(scale?: Vector3, rotation?: Quaternion, translation?: Vector3): boolean;
  85064. /**
  85065. * Gets specific row of the matrix
  85066. * @param index defines the number of the row to get
  85067. * @returns the index-th row of the current matrix as a new Vector4
  85068. */
  85069. getRow(index: number): Nullable<Vector4>;
  85070. /**
  85071. * Sets the index-th row of the current matrix to the vector4 values
  85072. * @param index defines the number of the row to set
  85073. * @param row defines the target vector4
  85074. * @returns the updated current matrix
  85075. */
  85076. setRow(index: number, row: Vector4): Matrix;
  85077. /**
  85078. * Compute the transpose of the matrix
  85079. * @returns the new transposed matrix
  85080. */
  85081. transpose(): Matrix;
  85082. /**
  85083. * Compute the transpose of the matrix and store it in a given matrix
  85084. * @param result defines the target matrix
  85085. * @returns the current matrix
  85086. */
  85087. transposeToRef(result: Matrix): Matrix;
  85088. /**
  85089. * Sets the index-th row of the current matrix with the given 4 x float values
  85090. * @param index defines the row index
  85091. * @param x defines the x component to set
  85092. * @param y defines the y component to set
  85093. * @param z defines the z component to set
  85094. * @param w defines the w component to set
  85095. * @returns the updated current matrix
  85096. */
  85097. setRowFromFloats(index: number, x: number, y: number, z: number, w: number): Matrix;
  85098. /**
  85099. * Compute a new matrix set with the current matrix values multiplied by scale (float)
  85100. * @param scale defines the scale factor
  85101. * @returns a new matrix
  85102. */
  85103. scale(scale: number): Matrix;
  85104. /**
  85105. * Scale the current matrix values by a factor to a given result matrix
  85106. * @param scale defines the scale factor
  85107. * @param result defines the matrix to store the result
  85108. * @returns the current matrix
  85109. */
  85110. scaleToRef(scale: number, result: Matrix): Matrix;
  85111. /**
  85112. * Scale the current matrix values by a factor and add the result to a given matrix
  85113. * @param scale defines the scale factor
  85114. * @param result defines the Matrix to store the result
  85115. * @returns the current matrix
  85116. */
  85117. scaleAndAddToRef(scale: number, result: Matrix): Matrix;
  85118. /**
  85119. * Writes to the given matrix a normal matrix, computed from this one (using values from identity matrix for fourth row and column).
  85120. * @param ref matrix to store the result
  85121. */
  85122. toNormalMatrix(ref: Matrix): void;
  85123. /**
  85124. * Gets only rotation part of the current matrix
  85125. * @returns a new matrix sets to the extracted rotation matrix from the current one
  85126. */
  85127. getRotationMatrix(): Matrix;
  85128. /**
  85129. * Extracts the rotation matrix from the current one and sets it as the given "result"
  85130. * @param result defines the target matrix to store data to
  85131. * @returns the current matrix
  85132. */
  85133. getRotationMatrixToRef(result: Matrix): Matrix;
  85134. /**
  85135. * Toggles model matrix from being right handed to left handed in place and vice versa
  85136. */
  85137. toggleModelMatrixHandInPlace(): void;
  85138. /**
  85139. * Toggles projection matrix from being right handed to left handed in place and vice versa
  85140. */
  85141. toggleProjectionMatrixHandInPlace(): void;
  85142. /**
  85143. * Creates a matrix from an array
  85144. * @param array defines the source array
  85145. * @param offset defines an offset in the source array
  85146. * @returns a new Matrix set from the starting index of the given array
  85147. */
  85148. static FromArray(array: DeepImmutable<ArrayLike<number>>, offset?: number): Matrix;
  85149. /**
  85150. * Copy the content of an array into a given matrix
  85151. * @param array defines the source array
  85152. * @param offset defines an offset in the source array
  85153. * @param result defines the target matrix
  85154. */
  85155. static FromArrayToRef(array: DeepImmutable<ArrayLike<number>>, offset: number, result: Matrix): void;
  85156. /**
  85157. * Stores an array into a matrix after having multiplied each component by a given factor
  85158. * @param array defines the source array
  85159. * @param offset defines the offset in the source array
  85160. * @param scale defines the scaling factor
  85161. * @param result defines the target matrix
  85162. */
  85163. static FromFloat32ArrayToRefScaled(array: DeepImmutable<Float32Array | Array<number>>, offset: number, scale: number, result: Matrix): void;
  85164. /**
  85165. * Gets an identity matrix that must not be updated
  85166. */
  85167. static get IdentityReadOnly(): DeepImmutable<Matrix>;
  85168. /**
  85169. * Stores a list of values (16) inside a given matrix
  85170. * @param initialM11 defines 1st value of 1st row
  85171. * @param initialM12 defines 2nd value of 1st row
  85172. * @param initialM13 defines 3rd value of 1st row
  85173. * @param initialM14 defines 4th value of 1st row
  85174. * @param initialM21 defines 1st value of 2nd row
  85175. * @param initialM22 defines 2nd value of 2nd row
  85176. * @param initialM23 defines 3rd value of 2nd row
  85177. * @param initialM24 defines 4th value of 2nd row
  85178. * @param initialM31 defines 1st value of 3rd row
  85179. * @param initialM32 defines 2nd value of 3rd row
  85180. * @param initialM33 defines 3rd value of 3rd row
  85181. * @param initialM34 defines 4th value of 3rd row
  85182. * @param initialM41 defines 1st value of 4th row
  85183. * @param initialM42 defines 2nd value of 4th row
  85184. * @param initialM43 defines 3rd value of 4th row
  85185. * @param initialM44 defines 4th value of 4th row
  85186. * @param result defines the target matrix
  85187. */
  85188. 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;
  85189. /**
  85190. * Creates new matrix from a list of values (16)
  85191. * @param initialM11 defines 1st value of 1st row
  85192. * @param initialM12 defines 2nd value of 1st row
  85193. * @param initialM13 defines 3rd value of 1st row
  85194. * @param initialM14 defines 4th value of 1st row
  85195. * @param initialM21 defines 1st value of 2nd row
  85196. * @param initialM22 defines 2nd value of 2nd row
  85197. * @param initialM23 defines 3rd value of 2nd row
  85198. * @param initialM24 defines 4th value of 2nd row
  85199. * @param initialM31 defines 1st value of 3rd row
  85200. * @param initialM32 defines 2nd value of 3rd row
  85201. * @param initialM33 defines 3rd value of 3rd row
  85202. * @param initialM34 defines 4th value of 3rd row
  85203. * @param initialM41 defines 1st value of 4th row
  85204. * @param initialM42 defines 2nd value of 4th row
  85205. * @param initialM43 defines 3rd value of 4th row
  85206. * @param initialM44 defines 4th value of 4th row
  85207. * @returns the new matrix
  85208. */
  85209. 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;
  85210. /**
  85211. * Creates a new matrix composed by merging scale (vector3), rotation (quaternion) and translation (vector3)
  85212. * @param scale defines the scale vector3
  85213. * @param rotation defines the rotation quaternion
  85214. * @param translation defines the translation vector3
  85215. * @returns a new matrix
  85216. */
  85217. static Compose(scale: DeepImmutable<Vector3>, rotation: DeepImmutable<Quaternion>, translation: DeepImmutable<Vector3>): Matrix;
  85218. /**
  85219. * Sets a matrix to a value composed by merging scale (vector3), rotation (quaternion) and translation (vector3)
  85220. * @param scale defines the scale vector3
  85221. * @param rotation defines the rotation quaternion
  85222. * @param translation defines the translation vector3
  85223. * @param result defines the target matrix
  85224. */
  85225. static ComposeToRef(scale: DeepImmutable<Vector3>, rotation: DeepImmutable<Quaternion>, translation: DeepImmutable<Vector3>, result: Matrix): void;
  85226. /**
  85227. * Creates a new identity matrix
  85228. * @returns a new identity matrix
  85229. */
  85230. static Identity(): Matrix;
  85231. /**
  85232. * Creates a new identity matrix and stores the result in a given matrix
  85233. * @param result defines the target matrix
  85234. */
  85235. static IdentityToRef(result: Matrix): void;
  85236. /**
  85237. * Creates a new zero matrix
  85238. * @returns a new zero matrix
  85239. */
  85240. static Zero(): Matrix;
  85241. /**
  85242. * Creates a new rotation matrix for "angle" radians around the X axis
  85243. * @param angle defines the angle (in radians) to use
  85244. * @return the new matrix
  85245. */
  85246. static RotationX(angle: number): Matrix;
  85247. /**
  85248. * Creates a new matrix as the invert of a given matrix
  85249. * @param source defines the source matrix
  85250. * @returns the new matrix
  85251. */
  85252. static Invert(source: DeepImmutable<Matrix>): Matrix;
  85253. /**
  85254. * Creates a new rotation matrix for "angle" radians around the X axis and stores it in a given matrix
  85255. * @param angle defines the angle (in radians) to use
  85256. * @param result defines the target matrix
  85257. */
  85258. static RotationXToRef(angle: number, result: Matrix): void;
  85259. /**
  85260. * Creates a new rotation matrix for "angle" radians around the Y axis
  85261. * @param angle defines the angle (in radians) to use
  85262. * @return the new matrix
  85263. */
  85264. static RotationY(angle: number): Matrix;
  85265. /**
  85266. * Creates a new rotation matrix for "angle" radians around the Y axis and stores it in a given matrix
  85267. * @param angle defines the angle (in radians) to use
  85268. * @param result defines the target matrix
  85269. */
  85270. static RotationYToRef(angle: number, result: Matrix): void;
  85271. /**
  85272. * Creates a new rotation matrix for "angle" radians around the Z axis
  85273. * @param angle defines the angle (in radians) to use
  85274. * @return the new matrix
  85275. */
  85276. static RotationZ(angle: number): Matrix;
  85277. /**
  85278. * Creates a new rotation matrix for "angle" radians around the Z axis and stores it in a given matrix
  85279. * @param angle defines the angle (in radians) to use
  85280. * @param result defines the target matrix
  85281. */
  85282. static RotationZToRef(angle: number, result: Matrix): void;
  85283. /**
  85284. * Creates a new rotation matrix for "angle" radians around the given axis
  85285. * @param axis defines the axis to use
  85286. * @param angle defines the angle (in radians) to use
  85287. * @return the new matrix
  85288. */
  85289. static RotationAxis(axis: DeepImmutable<Vector3>, angle: number): Matrix;
  85290. /**
  85291. * Creates a new rotation matrix for "angle" radians around the given axis and stores it in a given matrix
  85292. * @param axis defines the axis to use
  85293. * @param angle defines the angle (in radians) to use
  85294. * @param result defines the target matrix
  85295. */
  85296. static RotationAxisToRef(axis: DeepImmutable<Vector3>, angle: number, result: Matrix): void;
  85297. /**
  85298. * Takes normalised vectors and returns a rotation matrix to align "from" with "to".
  85299. * Taken from http://www.iquilezles.org/www/articles/noacos/noacos.htm
  85300. * @param from defines the vector to align
  85301. * @param to defines the vector to align to
  85302. * @param result defines the target matrix
  85303. */
  85304. static RotationAlignToRef(from: DeepImmutable<Vector3>, to: DeepImmutable<Vector3>, result: Matrix): void;
  85305. /**
  85306. * Creates a rotation matrix
  85307. * @param yaw defines the yaw angle in radians (Y axis)
  85308. * @param pitch defines the pitch angle in radians (X axis)
  85309. * @param roll defines the roll angle in radians (Z axis)
  85310. * @returns the new rotation matrix
  85311. */
  85312. static RotationYawPitchRoll(yaw: number, pitch: number, roll: number): Matrix;
  85313. /**
  85314. * Creates a rotation matrix and stores it in a given matrix
  85315. * @param yaw defines the yaw angle in radians (Y axis)
  85316. * @param pitch defines the pitch angle in radians (X axis)
  85317. * @param roll defines the roll angle in radians (Z axis)
  85318. * @param result defines the target matrix
  85319. */
  85320. static RotationYawPitchRollToRef(yaw: number, pitch: number, roll: number, result: Matrix): void;
  85321. /**
  85322. * Creates a scaling matrix
  85323. * @param x defines the scale factor on X axis
  85324. * @param y defines the scale factor on Y axis
  85325. * @param z defines the scale factor on Z axis
  85326. * @returns the new matrix
  85327. */
  85328. static Scaling(x: number, y: number, z: number): Matrix;
  85329. /**
  85330. * Creates a scaling matrix and stores it in a given matrix
  85331. * @param x defines the scale factor on X axis
  85332. * @param y defines the scale factor on Y axis
  85333. * @param z defines the scale factor on Z axis
  85334. * @param result defines the target matrix
  85335. */
  85336. static ScalingToRef(x: number, y: number, z: number, result: Matrix): void;
  85337. /**
  85338. * Creates a translation matrix
  85339. * @param x defines the translation on X axis
  85340. * @param y defines the translation on Y axis
  85341. * @param z defines the translationon Z axis
  85342. * @returns the new matrix
  85343. */
  85344. static Translation(x: number, y: number, z: number): Matrix;
  85345. /**
  85346. * Creates a translation matrix and stores it in a given matrix
  85347. * @param x defines the translation on X axis
  85348. * @param y defines the translation on Y axis
  85349. * @param z defines the translationon Z axis
  85350. * @param result defines the target matrix
  85351. */
  85352. static TranslationToRef(x: number, y: number, z: number, result: Matrix): void;
  85353. /**
  85354. * Returns a new Matrix whose values are the interpolated values for "gradient" (float) between the ones of the matrices "startValue" and "endValue".
  85355. * @param startValue defines the start value
  85356. * @param endValue defines the end value
  85357. * @param gradient defines the gradient factor
  85358. * @returns the new matrix
  85359. */
  85360. static Lerp(startValue: DeepImmutable<Matrix>, endValue: DeepImmutable<Matrix>, gradient: number): Matrix;
  85361. /**
  85362. * Set the given matrix "result" as the interpolated values for "gradient" (float) between the ones of the matrices "startValue" and "endValue".
  85363. * @param startValue defines the start value
  85364. * @param endValue defines the end value
  85365. * @param gradient defines the gradient factor
  85366. * @param result defines the Matrix object where to store data
  85367. */
  85368. static LerpToRef(startValue: DeepImmutable<Matrix>, endValue: DeepImmutable<Matrix>, gradient: number, result: Matrix): void;
  85369. /**
  85370. * Builds a new matrix whose values are computed by:
  85371. * * decomposing the the "startValue" and "endValue" matrices into their respective scale, rotation and translation matrices
  85372. * * interpolating for "gradient" (float) the values between each of these decomposed matrices between the start and the end
  85373. * * recomposing a new matrix from these 3 interpolated scale, rotation and translation matrices
  85374. * @param startValue defines the first matrix
  85375. * @param endValue defines the second matrix
  85376. * @param gradient defines the gradient between the two matrices
  85377. * @returns the new matrix
  85378. */
  85379. static DecomposeLerp(startValue: DeepImmutable<Matrix>, endValue: DeepImmutable<Matrix>, gradient: number): Matrix;
  85380. /**
  85381. * Update a matrix to values which are computed by:
  85382. * * decomposing the the "startValue" and "endValue" matrices into their respective scale, rotation and translation matrices
  85383. * * interpolating for "gradient" (float) the values between each of these decomposed matrices between the start and the end
  85384. * * recomposing a new matrix from these 3 interpolated scale, rotation and translation matrices
  85385. * @param startValue defines the first matrix
  85386. * @param endValue defines the second matrix
  85387. * @param gradient defines the gradient between the two matrices
  85388. * @param result defines the target matrix
  85389. */
  85390. static DecomposeLerpToRef(startValue: DeepImmutable<Matrix>, endValue: DeepImmutable<Matrix>, gradient: number, result: Matrix): void;
  85391. /**
  85392. * 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"
  85393. * This function works in left handed mode
  85394. * @param eye defines the final position of the entity
  85395. * @param target defines where the entity should look at
  85396. * @param up defines the up vector for the entity
  85397. * @returns the new matrix
  85398. */
  85399. static LookAtLH(eye: DeepImmutable<Vector3>, target: DeepImmutable<Vector3>, up: DeepImmutable<Vector3>): Matrix;
  85400. /**
  85401. * 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".
  85402. * This function works in left handed mode
  85403. * @param eye defines the final position of the entity
  85404. * @param target defines where the entity should look at
  85405. * @param up defines the up vector for the entity
  85406. * @param result defines the target matrix
  85407. */
  85408. static LookAtLHToRef(eye: DeepImmutable<Vector3>, target: DeepImmutable<Vector3>, up: DeepImmutable<Vector3>, result: Matrix): void;
  85409. /**
  85410. * 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"
  85411. * This function works in right handed mode
  85412. * @param eye defines the final position of the entity
  85413. * @param target defines where the entity should look at
  85414. * @param up defines the up vector for the entity
  85415. * @returns the new matrix
  85416. */
  85417. static LookAtRH(eye: DeepImmutable<Vector3>, target: DeepImmutable<Vector3>, up: DeepImmutable<Vector3>): Matrix;
  85418. /**
  85419. * 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".
  85420. * This function works in right handed mode
  85421. * @param eye defines the final position of the entity
  85422. * @param target defines where the entity should look at
  85423. * @param up defines the up vector for the entity
  85424. * @param result defines the target matrix
  85425. */
  85426. static LookAtRHToRef(eye: DeepImmutable<Vector3>, target: DeepImmutable<Vector3>, up: DeepImmutable<Vector3>, result: Matrix): void;
  85427. /**
  85428. * Create a left-handed orthographic projection matrix
  85429. * @param width defines the viewport width
  85430. * @param height defines the viewport height
  85431. * @param znear defines the near clip plane
  85432. * @param zfar defines the far clip plane
  85433. * @returns a new matrix as a left-handed orthographic projection matrix
  85434. */
  85435. static OrthoLH(width: number, height: number, znear: number, zfar: number): Matrix;
  85436. /**
  85437. * Store a left-handed orthographic projection to a given matrix
  85438. * @param width defines the viewport width
  85439. * @param height defines the viewport height
  85440. * @param znear defines the near clip plane
  85441. * @param zfar defines the far clip plane
  85442. * @param result defines the target matrix
  85443. */
  85444. static OrthoLHToRef(width: number, height: number, znear: number, zfar: number, result: Matrix): void;
  85445. /**
  85446. * Create a left-handed orthographic projection matrix
  85447. * @param left defines the viewport left coordinate
  85448. * @param right defines the viewport right coordinate
  85449. * @param bottom defines the viewport bottom coordinate
  85450. * @param top defines the viewport top coordinate
  85451. * @param znear defines the near clip plane
  85452. * @param zfar defines the far clip plane
  85453. * @returns a new matrix as a left-handed orthographic projection matrix
  85454. */
  85455. static OrthoOffCenterLH(left: number, right: number, bottom: number, top: number, znear: number, zfar: number): Matrix;
  85456. /**
  85457. * Stores a left-handed orthographic projection into a given matrix
  85458. * @param left defines the viewport left coordinate
  85459. * @param right defines the viewport right coordinate
  85460. * @param bottom defines the viewport bottom coordinate
  85461. * @param top defines the viewport top coordinate
  85462. * @param znear defines the near clip plane
  85463. * @param zfar defines the far clip plane
  85464. * @param result defines the target matrix
  85465. */
  85466. static OrthoOffCenterLHToRef(left: number, right: number, bottom: number, top: number, znear: number, zfar: number, result: Matrix): void;
  85467. /**
  85468. * Creates a right-handed orthographic projection matrix
  85469. * @param left defines the viewport left coordinate
  85470. * @param right defines the viewport right coordinate
  85471. * @param bottom defines the viewport bottom coordinate
  85472. * @param top defines the viewport top coordinate
  85473. * @param znear defines the near clip plane
  85474. * @param zfar defines the far clip plane
  85475. * @returns a new matrix as a right-handed orthographic projection matrix
  85476. */
  85477. static OrthoOffCenterRH(left: number, right: number, bottom: number, top: number, znear: number, zfar: number): Matrix;
  85478. /**
  85479. * Stores a right-handed orthographic projection into a given matrix
  85480. * @param left defines the viewport left coordinate
  85481. * @param right defines the viewport right coordinate
  85482. * @param bottom defines the viewport bottom coordinate
  85483. * @param top defines the viewport top coordinate
  85484. * @param znear defines the near clip plane
  85485. * @param zfar defines the far clip plane
  85486. * @param result defines the target matrix
  85487. */
  85488. static OrthoOffCenterRHToRef(left: number, right: number, bottom: number, top: number, znear: number, zfar: number, result: Matrix): void;
  85489. /**
  85490. * Creates a left-handed perspective projection matrix
  85491. * @param width defines the viewport width
  85492. * @param height defines the viewport height
  85493. * @param znear defines the near clip plane
  85494. * @param zfar defines the far clip plane
  85495. * @returns a new matrix as a left-handed perspective projection matrix
  85496. */
  85497. static PerspectiveLH(width: number, height: number, znear: number, zfar: number): Matrix;
  85498. /**
  85499. * Creates a left-handed perspective projection matrix
  85500. * @param fov defines the horizontal field of view
  85501. * @param aspect defines the aspect ratio
  85502. * @param znear defines the near clip plane
  85503. * @param zfar defines the far clip plane
  85504. * @returns a new matrix as a left-handed perspective projection matrix
  85505. */
  85506. static PerspectiveFovLH(fov: number, aspect: number, znear: number, zfar: number): Matrix;
  85507. /**
  85508. * Stores a left-handed perspective projection into a given matrix
  85509. * @param fov defines the horizontal field of view
  85510. * @param aspect defines the aspect ratio
  85511. * @param znear defines the near clip plane
  85512. * @param zfar defines the far clip plane
  85513. * @param result defines the target matrix
  85514. * @param isVerticalFovFixed defines it the fov is vertically fixed (default) or horizontally
  85515. */
  85516. static PerspectiveFovLHToRef(fov: number, aspect: number, znear: number, zfar: number, result: Matrix, isVerticalFovFixed?: boolean): void;
  85517. /**
  85518. * Stores a left-handed perspective projection into a given matrix with depth reversed
  85519. * @param fov defines the horizontal field of view
  85520. * @param aspect defines the aspect ratio
  85521. * @param znear defines the near clip plane
  85522. * @param zfar not used as infinity is used as far clip
  85523. * @param result defines the target matrix
  85524. * @param isVerticalFovFixed defines it the fov is vertically fixed (default) or horizontally
  85525. */
  85526. static PerspectiveFovReverseLHToRef(fov: number, aspect: number, znear: number, zfar: number, result: Matrix, isVerticalFovFixed?: boolean): void;
  85527. /**
  85528. * Creates a right-handed perspective projection matrix
  85529. * @param fov defines the horizontal field of view
  85530. * @param aspect defines the aspect ratio
  85531. * @param znear defines the near clip plane
  85532. * @param zfar defines the far clip plane
  85533. * @returns a new matrix as a right-handed perspective projection matrix
  85534. */
  85535. static PerspectiveFovRH(fov: number, aspect: number, znear: number, zfar: number): Matrix;
  85536. /**
  85537. * Stores a right-handed perspective projection into a given matrix
  85538. * @param fov defines the horizontal field of view
  85539. * @param aspect defines the aspect ratio
  85540. * @param znear defines the near clip plane
  85541. * @param zfar defines the far clip plane
  85542. * @param result defines the target matrix
  85543. * @param isVerticalFovFixed defines it the fov is vertically fixed (default) or horizontally
  85544. */
  85545. static PerspectiveFovRHToRef(fov: number, aspect: number, znear: number, zfar: number, result: Matrix, isVerticalFovFixed?: boolean): void;
  85546. /**
  85547. * Stores a right-handed perspective projection into a given matrix
  85548. * @param fov defines the horizontal field of view
  85549. * @param aspect defines the aspect ratio
  85550. * @param znear defines the near clip plane
  85551. * @param zfar not used as infinity is used as far clip
  85552. * @param result defines the target matrix
  85553. * @param isVerticalFovFixed defines it the fov is vertically fixed (default) or horizontally
  85554. */
  85555. static PerspectiveFovReverseRHToRef(fov: number, aspect: number, znear: number, zfar: number, result: Matrix, isVerticalFovFixed?: boolean): void;
  85556. /**
  85557. * Stores a perspective projection for WebVR info a given matrix
  85558. * @param fov defines the field of view
  85559. * @param znear defines the near clip plane
  85560. * @param zfar defines the far clip plane
  85561. * @param result defines the target matrix
  85562. * @param rightHanded defines if the matrix must be in right-handed mode (false by default)
  85563. */
  85564. static PerspectiveFovWebVRToRef(fov: {
  85565. upDegrees: number;
  85566. downDegrees: number;
  85567. leftDegrees: number;
  85568. rightDegrees: number;
  85569. }, znear: number, zfar: number, result: Matrix, rightHanded?: boolean): void;
  85570. /**
  85571. * Computes a complete transformation matrix
  85572. * @param viewport defines the viewport to use
  85573. * @param world defines the world matrix
  85574. * @param view defines the view matrix
  85575. * @param projection defines the projection matrix
  85576. * @param zmin defines the near clip plane
  85577. * @param zmax defines the far clip plane
  85578. * @returns the transformation matrix
  85579. */
  85580. static GetFinalMatrix(viewport: DeepImmutable<Viewport>, world: DeepImmutable<Matrix>, view: DeepImmutable<Matrix>, projection: DeepImmutable<Matrix>, zmin: number, zmax: number): Matrix;
  85581. /**
  85582. * Extracts a 2x2 matrix from a given matrix and store the result in a Float32Array
  85583. * @param matrix defines the matrix to use
  85584. * @returns a new Float32Array array with 4 elements : the 2x2 matrix extracted from the given matrix
  85585. */
  85586. static GetAsMatrix2x2(matrix: DeepImmutable<Matrix>): Float32Array | Array<number>;
  85587. /**
  85588. * Extracts a 3x3 matrix from a given matrix and store the result in a Float32Array
  85589. * @param matrix defines the matrix to use
  85590. * @returns a new Float32Array array with 9 elements : the 3x3 matrix extracted from the given matrix
  85591. */
  85592. static GetAsMatrix3x3(matrix: DeepImmutable<Matrix>): Float32Array | Array<number>;
  85593. /**
  85594. * Compute the transpose of a given matrix
  85595. * @param matrix defines the matrix to transpose
  85596. * @returns the new matrix
  85597. */
  85598. static Transpose(matrix: DeepImmutable<Matrix>): Matrix;
  85599. /**
  85600. * Compute the transpose of a matrix and store it in a target matrix
  85601. * @param matrix defines the matrix to transpose
  85602. * @param result defines the target matrix
  85603. */
  85604. static TransposeToRef(matrix: DeepImmutable<Matrix>, result: Matrix): void;
  85605. /**
  85606. * Computes a reflection matrix from a plane
  85607. * @param plane defines the reflection plane
  85608. * @returns a new matrix
  85609. */
  85610. static Reflection(plane: DeepImmutable<IPlaneLike>): Matrix;
  85611. /**
  85612. * Computes a reflection matrix from a plane
  85613. * @param plane defines the reflection plane
  85614. * @param result defines the target matrix
  85615. */
  85616. static ReflectionToRef(plane: DeepImmutable<IPlaneLike>, result: Matrix): void;
  85617. /**
  85618. * Sets the given matrix as a rotation matrix composed from the 3 left handed axes
  85619. * @param xaxis defines the value of the 1st axis
  85620. * @param yaxis defines the value of the 2nd axis
  85621. * @param zaxis defines the value of the 3rd axis
  85622. * @param result defines the target matrix
  85623. */
  85624. static FromXYZAxesToRef(xaxis: DeepImmutable<Vector3>, yaxis: DeepImmutable<Vector3>, zaxis: DeepImmutable<Vector3>, result: Matrix): void;
  85625. /**
  85626. * Creates a rotation matrix from a quaternion and stores it in a target matrix
  85627. * @param quat defines the quaternion to use
  85628. * @param result defines the target matrix
  85629. */
  85630. static FromQuaternionToRef(quat: DeepImmutable<Quaternion>, result: Matrix): void;
  85631. }
  85632. /**
  85633. * @hidden
  85634. */
  85635. export class TmpVectors {
  85636. static Vector2: Vector2[];
  85637. static Vector3: Vector3[];
  85638. static Vector4: Vector4[];
  85639. static Quaternion: Quaternion[];
  85640. static Matrix: Matrix[];
  85641. }
  85642. }
  85643. declare module BABYLON {
  85644. /**
  85645. * Defines potential orientation for back face culling
  85646. */
  85647. export enum Orientation {
  85648. /**
  85649. * Clockwise
  85650. */
  85651. CW = 0,
  85652. /** Counter clockwise */
  85653. CCW = 1
  85654. }
  85655. /** Class used to represent a Bezier curve */
  85656. export class BezierCurve {
  85657. /**
  85658. * Returns the cubic Bezier interpolated value (float) at "t" (float) from the given x1, y1, x2, y2 floats
  85659. * @param t defines the time
  85660. * @param x1 defines the left coordinate on X axis
  85661. * @param y1 defines the left coordinate on Y axis
  85662. * @param x2 defines the right coordinate on X axis
  85663. * @param y2 defines the right coordinate on Y axis
  85664. * @returns the interpolated value
  85665. */
  85666. static Interpolate(t: number, x1: number, y1: number, x2: number, y2: number): number;
  85667. }
  85668. /**
  85669. * Defines angle representation
  85670. */
  85671. export class Angle {
  85672. private _radians;
  85673. /**
  85674. * Creates an Angle object of "radians" radians (float).
  85675. * @param radians the angle in radians
  85676. */
  85677. constructor(radians: number);
  85678. /**
  85679. * Get value in degrees
  85680. * @returns the Angle value in degrees (float)
  85681. */
  85682. degrees(): number;
  85683. /**
  85684. * Get value in radians
  85685. * @returns the Angle value in radians (float)
  85686. */
  85687. radians(): number;
  85688. /**
  85689. * Gets a new Angle object valued with the gradient angle, in radians, of the line joining two points
  85690. * @param a defines first point as the origin
  85691. * @param b defines point
  85692. * @returns a new Angle
  85693. */
  85694. static BetweenTwoPoints(a: DeepImmutable<Vector2>, b: DeepImmutable<Vector2>): Angle;
  85695. /**
  85696. * Gets a new Angle object from the given float in radians
  85697. * @param radians defines the angle value in radians
  85698. * @returns a new Angle
  85699. */
  85700. static FromRadians(radians: number): Angle;
  85701. /**
  85702. * Gets a new Angle object from the given float in degrees
  85703. * @param degrees defines the angle value in degrees
  85704. * @returns a new Angle
  85705. */
  85706. static FromDegrees(degrees: number): Angle;
  85707. }
  85708. /**
  85709. * This represents an arc in a 2d space.
  85710. */
  85711. export class Arc2 {
  85712. /** Defines the start point of the arc */
  85713. startPoint: Vector2;
  85714. /** Defines the mid point of the arc */
  85715. midPoint: Vector2;
  85716. /** Defines the end point of the arc */
  85717. endPoint: Vector2;
  85718. /**
  85719. * Defines the center point of the arc.
  85720. */
  85721. centerPoint: Vector2;
  85722. /**
  85723. * Defines the radius of the arc.
  85724. */
  85725. radius: number;
  85726. /**
  85727. * Defines the angle of the arc (from mid point to end point).
  85728. */
  85729. angle: Angle;
  85730. /**
  85731. * Defines the start angle of the arc (from start point to middle point).
  85732. */
  85733. startAngle: Angle;
  85734. /**
  85735. * Defines the orientation of the arc (clock wise/counter clock wise).
  85736. */
  85737. orientation: Orientation;
  85738. /**
  85739. * Creates an Arc object from the three given points : start, middle and end.
  85740. * @param startPoint Defines the start point of the arc
  85741. * @param midPoint Defines the midlle point of the arc
  85742. * @param endPoint Defines the end point of the arc
  85743. */
  85744. constructor(
  85745. /** Defines the start point of the arc */
  85746. startPoint: Vector2,
  85747. /** Defines the mid point of the arc */
  85748. midPoint: Vector2,
  85749. /** Defines the end point of the arc */
  85750. endPoint: Vector2);
  85751. }
  85752. /**
  85753. * Represents a 2D path made up of multiple 2D points
  85754. */
  85755. export class Path2 {
  85756. private _points;
  85757. private _length;
  85758. /**
  85759. * If the path start and end point are the same
  85760. */
  85761. closed: boolean;
  85762. /**
  85763. * Creates a Path2 object from the starting 2D coordinates x and y.
  85764. * @param x the starting points x value
  85765. * @param y the starting points y value
  85766. */
  85767. constructor(x: number, y: number);
  85768. /**
  85769. * Adds a new segment until the given coordinates (x, y) to the current Path2.
  85770. * @param x the added points x value
  85771. * @param y the added points y value
  85772. * @returns the updated Path2.
  85773. */
  85774. addLineTo(x: number, y: number): Path2;
  85775. /**
  85776. * 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.
  85777. * @param midX middle point x value
  85778. * @param midY middle point y value
  85779. * @param endX end point x value
  85780. * @param endY end point y value
  85781. * @param numberOfSegments (default: 36)
  85782. * @returns the updated Path2.
  85783. */
  85784. addArcTo(midX: number, midY: number, endX: number, endY: number, numberOfSegments?: number): Path2;
  85785. /**
  85786. * Closes the Path2.
  85787. * @returns the Path2.
  85788. */
  85789. close(): Path2;
  85790. /**
  85791. * Gets the sum of the distance between each sequential point in the path
  85792. * @returns the Path2 total length (float).
  85793. */
  85794. length(): number;
  85795. /**
  85796. * Gets the points which construct the path
  85797. * @returns the Path2 internal array of points.
  85798. */
  85799. getPoints(): Vector2[];
  85800. /**
  85801. * Retreives the point at the distance aways from the starting point
  85802. * @param normalizedLengthPosition the length along the path to retreive the point from
  85803. * @returns a new Vector2 located at a percentage of the Path2 total length on this path.
  85804. */
  85805. getPointAtLengthPosition(normalizedLengthPosition: number): Vector2;
  85806. /**
  85807. * Creates a new path starting from an x and y position
  85808. * @param x starting x value
  85809. * @param y starting y value
  85810. * @returns a new Path2 starting at the coordinates (x, y).
  85811. */
  85812. static StartingAt(x: number, y: number): Path2;
  85813. }
  85814. /**
  85815. * Represents a 3D path made up of multiple 3D points
  85816. */
  85817. export class Path3D {
  85818. /**
  85819. * an array of Vector3, the curve axis of the Path3D
  85820. */
  85821. path: Vector3[];
  85822. private _curve;
  85823. private _distances;
  85824. private _tangents;
  85825. private _normals;
  85826. private _binormals;
  85827. private _raw;
  85828. private _alignTangentsWithPath;
  85829. private readonly _pointAtData;
  85830. /**
  85831. * new Path3D(path, normal, raw)
  85832. * Creates a Path3D. A Path3D is a logical math object, so not a mesh.
  85833. * please read the description in the tutorial : https://doc.babylonjs.com/how_to/how_to_use_path3d
  85834. * @param path an array of Vector3, the curve axis of the Path3D
  85835. * @param firstNormal (options) Vector3, the first wanted normal to the curve. Ex (0, 1, 0) for a vertical normal.
  85836. * @param raw (optional, default false) : boolean, if true the returned Path3D isn't normalized. Useful to depict path acceleration or speed.
  85837. * @param alignTangentsWithPath (optional, default false) : boolean, if true the tangents will be aligned with the path.
  85838. */
  85839. constructor(
  85840. /**
  85841. * an array of Vector3, the curve axis of the Path3D
  85842. */
  85843. path: Vector3[], firstNormal?: Nullable<Vector3>, raw?: boolean, alignTangentsWithPath?: boolean);
  85844. /**
  85845. * Returns the Path3D array of successive Vector3 designing its curve.
  85846. * @returns the Path3D array of successive Vector3 designing its curve.
  85847. */
  85848. getCurve(): Vector3[];
  85849. /**
  85850. * Returns the Path3D array of successive Vector3 designing its curve.
  85851. * @returns the Path3D array of successive Vector3 designing its curve.
  85852. */
  85853. getPoints(): Vector3[];
  85854. /**
  85855. * @returns the computed length (float) of the path.
  85856. */
  85857. length(): number;
  85858. /**
  85859. * Returns an array populated with tangent vectors on each Path3D curve point.
  85860. * @returns an array populated with tangent vectors on each Path3D curve point.
  85861. */
  85862. getTangents(): Vector3[];
  85863. /**
  85864. * Returns an array populated with normal vectors on each Path3D curve point.
  85865. * @returns an array populated with normal vectors on each Path3D curve point.
  85866. */
  85867. getNormals(): Vector3[];
  85868. /**
  85869. * Returns an array populated with binormal vectors on each Path3D curve point.
  85870. * @returns an array populated with binormal vectors on each Path3D curve point.
  85871. */
  85872. getBinormals(): Vector3[];
  85873. /**
  85874. * Returns an array populated with distances (float) of the i-th point from the first curve point.
  85875. * @returns an array populated with distances (float) of the i-th point from the first curve point.
  85876. */
  85877. getDistances(): number[];
  85878. /**
  85879. * Returns an interpolated point along this path
  85880. * @param position the position of the point along this path, from 0.0 to 1.0
  85881. * @returns a new Vector3 as the point
  85882. */
  85883. getPointAt(position: number): Vector3;
  85884. /**
  85885. * Returns the tangent vector of an interpolated Path3D curve point at the specified position along this path.
  85886. * @param position the position of the point along this path, from 0.0 to 1.0
  85887. * @param interpolated (optional, default false) : boolean, if true returns an interpolated tangent instead of the tangent of the previous path point.
  85888. * @returns a tangent vector corresponding to the interpolated Path3D curve point, if not interpolated, the tangent is taken from the precomputed tangents array.
  85889. */
  85890. getTangentAt(position: number, interpolated?: boolean): Vector3;
  85891. /**
  85892. * Returns the tangent vector of an interpolated Path3D curve point at the specified position along this path.
  85893. * @param position the position of the point along this path, from 0.0 to 1.0
  85894. * @param interpolated (optional, default false) : boolean, if true returns an interpolated normal instead of the normal of the previous path point.
  85895. * @returns a normal vector corresponding to the interpolated Path3D curve point, if not interpolated, the normal is taken from the precomputed normals array.
  85896. */
  85897. getNormalAt(position: number, interpolated?: boolean): Vector3;
  85898. /**
  85899. * Returns the binormal vector of an interpolated Path3D curve point at the specified position along this path.
  85900. * @param position the position of the point along this path, from 0.0 to 1.0
  85901. * @param interpolated (optional, default false) : boolean, if true returns an interpolated binormal instead of the binormal of the previous path point.
  85902. * @returns a binormal vector corresponding to the interpolated Path3D curve point, if not interpolated, the binormal is taken from the precomputed binormals array.
  85903. */
  85904. getBinormalAt(position: number, interpolated?: boolean): Vector3;
  85905. /**
  85906. * Returns the distance (float) of an interpolated Path3D curve point at the specified position along this path.
  85907. * @param position the position of the point along this path, from 0.0 to 1.0
  85908. * @returns the distance of the interpolated Path3D curve point at the specified position along this path.
  85909. */
  85910. getDistanceAt(position: number): number;
  85911. /**
  85912. * Returns the array index of the previous point of an interpolated point along this path
  85913. * @param position the position of the point to interpolate along this path, from 0.0 to 1.0
  85914. * @returns the array index
  85915. */
  85916. getPreviousPointIndexAt(position: number): number;
  85917. /**
  85918. * 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)
  85919. * @param position the position of the point to interpolate along this path, from 0.0 to 1.0
  85920. * @returns the sub position
  85921. */
  85922. getSubPositionAt(position: number): number;
  85923. /**
  85924. * Returns the position of the closest virtual point on this path to an arbitrary Vector3, from 0.0 to 1.0
  85925. * @param target the vector of which to get the closest position to
  85926. * @returns the position of the closest virtual point on this path to the target vector
  85927. */
  85928. getClosestPositionTo(target: Vector3): number;
  85929. /**
  85930. * Returns a sub path (slice) of this path
  85931. * @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
  85932. * @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
  85933. * @returns a sub path (slice) of this path
  85934. */
  85935. slice(start?: number, end?: number): Path3D;
  85936. /**
  85937. * Forces the Path3D tangent, normal, binormal and distance recomputation.
  85938. * @param path path which all values are copied into the curves points
  85939. * @param firstNormal which should be projected onto the curve
  85940. * @param alignTangentsWithPath (optional, default false) : boolean, if true the tangents will be aligned with the path
  85941. * @returns the same object updated.
  85942. */
  85943. update(path: Vector3[], firstNormal?: Nullable<Vector3>, alignTangentsWithPath?: boolean): Path3D;
  85944. private _compute;
  85945. private _getFirstNonNullVector;
  85946. private _getLastNonNullVector;
  85947. private _normalVector;
  85948. /**
  85949. * Updates the point at data for an interpolated point along this curve
  85950. * @param position the position of the point along this curve, from 0.0 to 1.0
  85951. * @interpolateTNB wether to compute the interpolated tangent, normal and binormal
  85952. * @returns the (updated) point at data
  85953. */
  85954. private _updatePointAtData;
  85955. /**
  85956. * Updates the point at data from the specified parameters
  85957. * @param position where along the path the interpolated point is, from 0.0 to 1.0
  85958. * @param point the interpolated point
  85959. * @param parentIndex the index of an existing curve point that is on, or else positionally the first behind, the interpolated point
  85960. */
  85961. private _setPointAtData;
  85962. /**
  85963. * Updates the point at interpolation matrix for the tangents, normals and binormals
  85964. */
  85965. private _updateInterpolationMatrix;
  85966. }
  85967. /**
  85968. * A Curve3 object is a logical object, so not a mesh, to handle curves in the 3D geometric space.
  85969. * A Curve3 is designed from a series of successive Vector3.
  85970. * @see https://doc.babylonjs.com/how_to/how_to_use_curve3
  85971. */
  85972. export class Curve3 {
  85973. private _points;
  85974. private _length;
  85975. /**
  85976. * Returns a Curve3 object along a Quadratic Bezier curve : https://doc.babylonjs.com/how_to/how_to_use_curve3#quadratic-bezier-curve
  85977. * @param v0 (Vector3) the origin point of the Quadratic Bezier
  85978. * @param v1 (Vector3) the control point
  85979. * @param v2 (Vector3) the end point of the Quadratic Bezier
  85980. * @param nbPoints (integer) the wanted number of points in the curve
  85981. * @returns the created Curve3
  85982. */
  85983. static CreateQuadraticBezier(v0: DeepImmutable<Vector3>, v1: DeepImmutable<Vector3>, v2: DeepImmutable<Vector3>, nbPoints: number): Curve3;
  85984. /**
  85985. * Returns a Curve3 object along a Cubic Bezier curve : https://doc.babylonjs.com/how_to/how_to_use_curve3#cubic-bezier-curve
  85986. * @param v0 (Vector3) the origin point of the Cubic Bezier
  85987. * @param v1 (Vector3) the first control point
  85988. * @param v2 (Vector3) the second control point
  85989. * @param v3 (Vector3) the end point of the Cubic Bezier
  85990. * @param nbPoints (integer) the wanted number of points in the curve
  85991. * @returns the created Curve3
  85992. */
  85993. static CreateCubicBezier(v0: DeepImmutable<Vector3>, v1: DeepImmutable<Vector3>, v2: DeepImmutable<Vector3>, v3: DeepImmutable<Vector3>, nbPoints: number): Curve3;
  85994. /**
  85995. * Returns a Curve3 object along a Hermite Spline curve : https://doc.babylonjs.com/how_to/how_to_use_curve3#hermite-spline
  85996. * @param p1 (Vector3) the origin point of the Hermite Spline
  85997. * @param t1 (Vector3) the tangent vector at the origin point
  85998. * @param p2 (Vector3) the end point of the Hermite Spline
  85999. * @param t2 (Vector3) the tangent vector at the end point
  86000. * @param nbPoints (integer) the wanted number of points in the curve
  86001. * @returns the created Curve3
  86002. */
  86003. static CreateHermiteSpline(p1: DeepImmutable<Vector3>, t1: DeepImmutable<Vector3>, p2: DeepImmutable<Vector3>, t2: DeepImmutable<Vector3>, nbPoints: number): Curve3;
  86004. /**
  86005. * Returns a Curve3 object along a CatmullRom Spline curve :
  86006. * @param points (array of Vector3) the points the spline must pass through. At least, four points required
  86007. * @param nbPoints (integer) the wanted number of points between each curve control points
  86008. * @param closed (boolean) optional with default false, when true forms a closed loop from the points
  86009. * @returns the created Curve3
  86010. */
  86011. static CreateCatmullRomSpline(points: DeepImmutable<Vector3[]>, nbPoints: number, closed?: boolean): Curve3;
  86012. /**
  86013. * A Curve3 object is a logical object, so not a mesh, to handle curves in the 3D geometric space.
  86014. * A Curve3 is designed from a series of successive Vector3.
  86015. * Tuto : https://doc.babylonjs.com/how_to/how_to_use_curve3#curve3-object
  86016. * @param points points which make up the curve
  86017. */
  86018. constructor(points: Vector3[]);
  86019. /**
  86020. * @returns the Curve3 stored array of successive Vector3
  86021. */
  86022. getPoints(): Vector3[];
  86023. /**
  86024. * @returns the computed length (float) of the curve.
  86025. */
  86026. length(): number;
  86027. /**
  86028. * Returns a new instance of Curve3 object : var curve = curveA.continue(curveB);
  86029. * This new Curve3 is built by translating and sticking the curveB at the end of the curveA.
  86030. * curveA and curveB keep unchanged.
  86031. * @param curve the curve to continue from this curve
  86032. * @returns the newly constructed curve
  86033. */
  86034. continue(curve: DeepImmutable<Curve3>): Curve3;
  86035. private _computeLength;
  86036. }
  86037. }
  86038. declare module BABYLON {
  86039. /**
  86040. * This represents the main contract an easing function should follow.
  86041. * Easing functions are used throughout the animation system.
  86042. * @see https://doc.babylonjs.com/babylon101/animations#easing-functions
  86043. */
  86044. export interface IEasingFunction {
  86045. /**
  86046. * Given an input gradient between 0 and 1, this returns the corrseponding value
  86047. * of the easing function.
  86048. * The link below provides some of the most common examples of easing functions.
  86049. * @see https://easings.net/
  86050. * @param gradient Defines the value between 0 and 1 we want the easing value for
  86051. * @returns the corresponding value on the curve defined by the easing function
  86052. */
  86053. ease(gradient: number): number;
  86054. }
  86055. /**
  86056. * Base class used for every default easing function.
  86057. * @see https://doc.babylonjs.com/babylon101/animations#easing-functions
  86058. */
  86059. export class EasingFunction implements IEasingFunction {
  86060. /**
  86061. * Interpolation follows the mathematical formula associated with the easing function.
  86062. */
  86063. static readonly EASINGMODE_EASEIN: number;
  86064. /**
  86065. * Interpolation follows 100% interpolation minus the output of the formula associated with the easing function.
  86066. */
  86067. static readonly EASINGMODE_EASEOUT: number;
  86068. /**
  86069. * Interpolation uses EaseIn for the first half of the animation and EaseOut for the second half.
  86070. */
  86071. static readonly EASINGMODE_EASEINOUT: number;
  86072. private _easingMode;
  86073. /**
  86074. * Sets the easing mode of the current function.
  86075. * @param easingMode Defines the willing mode (EASINGMODE_EASEIN, EASINGMODE_EASEOUT or EASINGMODE_EASEINOUT)
  86076. */
  86077. setEasingMode(easingMode: number): void;
  86078. /**
  86079. * Gets the current easing mode.
  86080. * @returns the easing mode
  86081. */
  86082. getEasingMode(): number;
  86083. /**
  86084. * @hidden
  86085. */
  86086. easeInCore(gradient: number): number;
  86087. /**
  86088. * Given an input gradient between 0 and 1, this returns the corresponding value
  86089. * of the easing function.
  86090. * @param gradient Defines the value between 0 and 1 we want the easing value for
  86091. * @returns the corresponding value on the curve defined by the easing function
  86092. */
  86093. ease(gradient: number): number;
  86094. }
  86095. /**
  86096. * Easing function with a circle shape (see link below).
  86097. * @see https://easings.net/#easeInCirc
  86098. * @see https://doc.babylonjs.com/babylon101/animations#easing-functions
  86099. */
  86100. export class CircleEase extends EasingFunction implements IEasingFunction {
  86101. /** @hidden */
  86102. easeInCore(gradient: number): number;
  86103. }
  86104. /**
  86105. * Easing function with a ease back shape (see link below).
  86106. * @see https://easings.net/#easeInBack
  86107. * @see https://doc.babylonjs.com/babylon101/animations#easing-functions
  86108. */
  86109. export class BackEase extends EasingFunction implements IEasingFunction {
  86110. /** Defines the amplitude of the function */
  86111. amplitude: number;
  86112. /**
  86113. * Instantiates a back ease easing
  86114. * @see https://easings.net/#easeInBack
  86115. * @param amplitude Defines the amplitude of the function
  86116. */
  86117. constructor(
  86118. /** Defines the amplitude of the function */
  86119. amplitude?: number);
  86120. /** @hidden */
  86121. easeInCore(gradient: number): number;
  86122. }
  86123. /**
  86124. * Easing function with a bouncing shape (see link below).
  86125. * @see https://easings.net/#easeInBounce
  86126. * @see https://doc.babylonjs.com/babylon101/animations#easing-functions
  86127. */
  86128. export class BounceEase extends EasingFunction implements IEasingFunction {
  86129. /** Defines the number of bounces */
  86130. bounces: number;
  86131. /** Defines the amplitude of the bounce */
  86132. bounciness: number;
  86133. /**
  86134. * Instantiates a bounce easing
  86135. * @see https://easings.net/#easeInBounce
  86136. * @param bounces Defines the number of bounces
  86137. * @param bounciness Defines the amplitude of the bounce
  86138. */
  86139. constructor(
  86140. /** Defines the number of bounces */
  86141. bounces?: number,
  86142. /** Defines the amplitude of the bounce */
  86143. bounciness?: number);
  86144. /** @hidden */
  86145. easeInCore(gradient: number): number;
  86146. }
  86147. /**
  86148. * Easing function with a power of 3 shape (see link below).
  86149. * @see https://easings.net/#easeInCubic
  86150. * @see https://doc.babylonjs.com/babylon101/animations#easing-functions
  86151. */
  86152. export class CubicEase extends EasingFunction implements IEasingFunction {
  86153. /** @hidden */
  86154. easeInCore(gradient: number): number;
  86155. }
  86156. /**
  86157. * Easing function with an elastic shape (see link below).
  86158. * @see https://easings.net/#easeInElastic
  86159. * @see https://doc.babylonjs.com/babylon101/animations#easing-functions
  86160. */
  86161. export class ElasticEase extends EasingFunction implements IEasingFunction {
  86162. /** Defines the number of oscillations*/
  86163. oscillations: number;
  86164. /** Defines the amplitude of the oscillations*/
  86165. springiness: number;
  86166. /**
  86167. * Instantiates an elastic easing function
  86168. * @see https://easings.net/#easeInElastic
  86169. * @param oscillations Defines the number of oscillations
  86170. * @param springiness Defines the amplitude of the oscillations
  86171. */
  86172. constructor(
  86173. /** Defines the number of oscillations*/
  86174. oscillations?: number,
  86175. /** Defines the amplitude of the oscillations*/
  86176. springiness?: number);
  86177. /** @hidden */
  86178. easeInCore(gradient: number): number;
  86179. }
  86180. /**
  86181. * Easing function with an exponential shape (see link below).
  86182. * @see https://easings.net/#easeInExpo
  86183. * @see https://doc.babylonjs.com/babylon101/animations#easing-functions
  86184. */
  86185. export class ExponentialEase extends EasingFunction implements IEasingFunction {
  86186. /** Defines the exponent of the function */
  86187. exponent: number;
  86188. /**
  86189. * Instantiates an exponential easing function
  86190. * @see https://easings.net/#easeInExpo
  86191. * @param exponent Defines the exponent of the function
  86192. */
  86193. constructor(
  86194. /** Defines the exponent of the function */
  86195. exponent?: number);
  86196. /** @hidden */
  86197. easeInCore(gradient: number): number;
  86198. }
  86199. /**
  86200. * Easing function with a power shape (see link below).
  86201. * @see https://easings.net/#easeInQuad
  86202. * @see https://doc.babylonjs.com/babylon101/animations#easing-functions
  86203. */
  86204. export class PowerEase extends EasingFunction implements IEasingFunction {
  86205. /** Defines the power of the function */
  86206. power: number;
  86207. /**
  86208. * Instantiates an power base easing function
  86209. * @see https://easings.net/#easeInQuad
  86210. * @param power Defines the power of the function
  86211. */
  86212. constructor(
  86213. /** Defines the power of the function */
  86214. power?: number);
  86215. /** @hidden */
  86216. easeInCore(gradient: number): number;
  86217. }
  86218. /**
  86219. * Easing function with a power of 2 shape (see link below).
  86220. * @see https://easings.net/#easeInQuad
  86221. * @see https://doc.babylonjs.com/babylon101/animations#easing-functions
  86222. */
  86223. export class QuadraticEase extends EasingFunction implements IEasingFunction {
  86224. /** @hidden */
  86225. easeInCore(gradient: number): number;
  86226. }
  86227. /**
  86228. * Easing function with a power of 4 shape (see link below).
  86229. * @see https://easings.net/#easeInQuart
  86230. * @see https://doc.babylonjs.com/babylon101/animations#easing-functions
  86231. */
  86232. export class QuarticEase extends EasingFunction implements IEasingFunction {
  86233. /** @hidden */
  86234. easeInCore(gradient: number): number;
  86235. }
  86236. /**
  86237. * Easing function with a power of 5 shape (see link below).
  86238. * @see https://easings.net/#easeInQuint
  86239. * @see https://doc.babylonjs.com/babylon101/animations#easing-functions
  86240. */
  86241. export class QuinticEase extends EasingFunction implements IEasingFunction {
  86242. /** @hidden */
  86243. easeInCore(gradient: number): number;
  86244. }
  86245. /**
  86246. * Easing function with a sin shape (see link below).
  86247. * @see https://easings.net/#easeInSine
  86248. * @see https://doc.babylonjs.com/babylon101/animations#easing-functions
  86249. */
  86250. export class SineEase extends EasingFunction implements IEasingFunction {
  86251. /** @hidden */
  86252. easeInCore(gradient: number): number;
  86253. }
  86254. /**
  86255. * Easing function with a bezier shape (see link below).
  86256. * @see http://cubic-bezier.com/#.17,.67,.83,.67
  86257. * @see https://doc.babylonjs.com/babylon101/animations#easing-functions
  86258. */
  86259. export class BezierCurveEase extends EasingFunction implements IEasingFunction {
  86260. /** Defines the x component of the start tangent in the bezier curve */
  86261. x1: number;
  86262. /** Defines the y component of the start tangent in the bezier curve */
  86263. y1: number;
  86264. /** Defines the x component of the end tangent in the bezier curve */
  86265. x2: number;
  86266. /** Defines the y component of the end tangent in the bezier curve */
  86267. y2: number;
  86268. /**
  86269. * Instantiates a bezier function
  86270. * @see http://cubic-bezier.com/#.17,.67,.83,.67
  86271. * @param x1 Defines the x component of the start tangent in the bezier curve
  86272. * @param y1 Defines the y component of the start tangent in the bezier curve
  86273. * @param x2 Defines the x component of the end tangent in the bezier curve
  86274. * @param y2 Defines the y component of the end tangent in the bezier curve
  86275. */
  86276. constructor(
  86277. /** Defines the x component of the start tangent in the bezier curve */
  86278. x1?: number,
  86279. /** Defines the y component of the start tangent in the bezier curve */
  86280. y1?: number,
  86281. /** Defines the x component of the end tangent in the bezier curve */
  86282. x2?: number,
  86283. /** Defines the y component of the end tangent in the bezier curve */
  86284. y2?: number);
  86285. /** @hidden */
  86286. easeInCore(gradient: number): number;
  86287. }
  86288. }
  86289. declare module BABYLON {
  86290. /**
  86291. * Class used to hold a RBG color
  86292. */
  86293. export class Color3 {
  86294. /**
  86295. * Defines the red component (between 0 and 1, default is 0)
  86296. */
  86297. r: number;
  86298. /**
  86299. * Defines the green component (between 0 and 1, default is 0)
  86300. */
  86301. g: number;
  86302. /**
  86303. * Defines the blue component (between 0 and 1, default is 0)
  86304. */
  86305. b: number;
  86306. /**
  86307. * Creates a new Color3 object from red, green, blue values, all between 0 and 1
  86308. * @param r defines the red component (between 0 and 1, default is 0)
  86309. * @param g defines the green component (between 0 and 1, default is 0)
  86310. * @param b defines the blue component (between 0 and 1, default is 0)
  86311. */
  86312. constructor(
  86313. /**
  86314. * Defines the red component (between 0 and 1, default is 0)
  86315. */
  86316. r?: number,
  86317. /**
  86318. * Defines the green component (between 0 and 1, default is 0)
  86319. */
  86320. g?: number,
  86321. /**
  86322. * Defines the blue component (between 0 and 1, default is 0)
  86323. */
  86324. b?: number);
  86325. /**
  86326. * Creates a string with the Color3 current values
  86327. * @returns the string representation of the Color3 object
  86328. */
  86329. toString(): string;
  86330. /**
  86331. * Returns the string "Color3"
  86332. * @returns "Color3"
  86333. */
  86334. getClassName(): string;
  86335. /**
  86336. * Compute the Color3 hash code
  86337. * @returns an unique number that can be used to hash Color3 objects
  86338. */
  86339. getHashCode(): number;
  86340. /**
  86341. * Stores in the given array from the given starting index the red, green, blue values as successive elements
  86342. * @param array defines the array where to store the r,g,b components
  86343. * @param index defines an optional index in the target array to define where to start storing values
  86344. * @returns the current Color3 object
  86345. */
  86346. toArray(array: FloatArray, index?: number): Color3;
  86347. /**
  86348. * Update the current color with values stored in an array from the starting index of the given array
  86349. * @param array defines the source array
  86350. * @param offset defines an offset in the source array
  86351. * @returns the current Color3 object
  86352. */
  86353. fromArray(array: DeepImmutable<ArrayLike<number>>, offset?: number): Color3;
  86354. /**
  86355. * Returns a new Color4 object from the current Color3 and the given alpha
  86356. * @param alpha defines the alpha component on the new Color4 object (default is 1)
  86357. * @returns a new Color4 object
  86358. */
  86359. toColor4(alpha?: number): Color4;
  86360. /**
  86361. * Returns a new array populated with 3 numeric elements : red, green and blue values
  86362. * @returns the new array
  86363. */
  86364. asArray(): number[];
  86365. /**
  86366. * Returns the luminance value
  86367. * @returns a float value
  86368. */
  86369. toLuminance(): number;
  86370. /**
  86371. * Multiply each Color3 rgb values by the given Color3 rgb values in a new Color3 object
  86372. * @param otherColor defines the second operand
  86373. * @returns the new Color3 object
  86374. */
  86375. multiply(otherColor: DeepImmutable<Color3>): Color3;
  86376. /**
  86377. * Multiply the rgb values of the Color3 and the given Color3 and stores the result in the object "result"
  86378. * @param otherColor defines the second operand
  86379. * @param result defines the Color3 object where to store the result
  86380. * @returns the current Color3
  86381. */
  86382. multiplyToRef(otherColor: DeepImmutable<Color3>, result: Color3): Color3;
  86383. /**
  86384. * Determines equality between Color3 objects
  86385. * @param otherColor defines the second operand
  86386. * @returns true if the rgb values are equal to the given ones
  86387. */
  86388. equals(otherColor: DeepImmutable<Color3>): boolean;
  86389. /**
  86390. * Determines equality between the current Color3 object and a set of r,b,g values
  86391. * @param r defines the red component to check
  86392. * @param g defines the green component to check
  86393. * @param b defines the blue component to check
  86394. * @returns true if the rgb values are equal to the given ones
  86395. */
  86396. equalsFloats(r: number, g: number, b: number): boolean;
  86397. /**
  86398. * Multiplies in place each rgb value by scale
  86399. * @param scale defines the scaling factor
  86400. * @returns the updated Color3
  86401. */
  86402. scale(scale: number): Color3;
  86403. /**
  86404. * Multiplies the rgb values by scale and stores the result into "result"
  86405. * @param scale defines the scaling factor
  86406. * @param result defines the Color3 object where to store the result
  86407. * @returns the unmodified current Color3
  86408. */
  86409. scaleToRef(scale: number, result: Color3): Color3;
  86410. /**
  86411. * Scale the current Color3 values by a factor and add the result to a given Color3
  86412. * @param scale defines the scale factor
  86413. * @param result defines color to store the result into
  86414. * @returns the unmodified current Color3
  86415. */
  86416. scaleAndAddToRef(scale: number, result: Color3): Color3;
  86417. /**
  86418. * Clamps the rgb values by the min and max values and stores the result into "result"
  86419. * @param min defines minimum clamping value (default is 0)
  86420. * @param max defines maximum clamping value (default is 1)
  86421. * @param result defines color to store the result into
  86422. * @returns the original Color3
  86423. */
  86424. clampToRef(min: number | undefined, max: number | undefined, result: Color3): Color3;
  86425. /**
  86426. * Creates a new Color3 set with the added values of the current Color3 and of the given one
  86427. * @param otherColor defines the second operand
  86428. * @returns the new Color3
  86429. */
  86430. add(otherColor: DeepImmutable<Color3>): Color3;
  86431. /**
  86432. * Stores the result of the addition of the current Color3 and given one rgb values into "result"
  86433. * @param otherColor defines the second operand
  86434. * @param result defines Color3 object to store the result into
  86435. * @returns the unmodified current Color3
  86436. */
  86437. addToRef(otherColor: DeepImmutable<Color3>, result: Color3): Color3;
  86438. /**
  86439. * Returns a new Color3 set with the subtracted values of the given one from the current Color3
  86440. * @param otherColor defines the second operand
  86441. * @returns the new Color3
  86442. */
  86443. subtract(otherColor: DeepImmutable<Color3>): Color3;
  86444. /**
  86445. * Stores the result of the subtraction of given one from the current Color3 rgb values into "result"
  86446. * @param otherColor defines the second operand
  86447. * @param result defines Color3 object to store the result into
  86448. * @returns the unmodified current Color3
  86449. */
  86450. subtractToRef(otherColor: DeepImmutable<Color3>, result: Color3): Color3;
  86451. /**
  86452. * Copy the current object
  86453. * @returns a new Color3 copied the current one
  86454. */
  86455. clone(): Color3;
  86456. /**
  86457. * Copies the rgb values from the source in the current Color3
  86458. * @param source defines the source Color3 object
  86459. * @returns the updated Color3 object
  86460. */
  86461. copyFrom(source: DeepImmutable<Color3>): Color3;
  86462. /**
  86463. * Updates the Color3 rgb values from the given floats
  86464. * @param r defines the red component to read from
  86465. * @param g defines the green component to read from
  86466. * @param b defines the blue component to read from
  86467. * @returns the current Color3 object
  86468. */
  86469. copyFromFloats(r: number, g: number, b: number): Color3;
  86470. /**
  86471. * Updates the Color3 rgb values from the given floats
  86472. * @param r defines the red component to read from
  86473. * @param g defines the green component to read from
  86474. * @param b defines the blue component to read from
  86475. * @returns the current Color3 object
  86476. */
  86477. set(r: number, g: number, b: number): Color3;
  86478. /**
  86479. * Compute the Color3 hexadecimal code as a string
  86480. * @returns a string containing the hexadecimal representation of the Color3 object
  86481. */
  86482. toHexString(): string;
  86483. /**
  86484. * Computes a new Color3 converted from the current one to linear space
  86485. * @returns a new Color3 object
  86486. */
  86487. toLinearSpace(): Color3;
  86488. /**
  86489. * Converts current color in rgb space to HSV values
  86490. * @returns a new color3 representing the HSV values
  86491. */
  86492. toHSV(): Color3;
  86493. /**
  86494. * Converts current color in rgb space to HSV values
  86495. * @param result defines the Color3 where to store the HSV values
  86496. */
  86497. toHSVToRef(result: Color3): void;
  86498. /**
  86499. * Converts the Color3 values to linear space and stores the result in "convertedColor"
  86500. * @param convertedColor defines the Color3 object where to store the linear space version
  86501. * @returns the unmodified Color3
  86502. */
  86503. toLinearSpaceToRef(convertedColor: Color3): Color3;
  86504. /**
  86505. * Computes a new Color3 converted from the current one to gamma space
  86506. * @returns a new Color3 object
  86507. */
  86508. toGammaSpace(): Color3;
  86509. /**
  86510. * Converts the Color3 values to gamma space and stores the result in "convertedColor"
  86511. * @param convertedColor defines the Color3 object where to store the gamma space version
  86512. * @returns the unmodified Color3
  86513. */
  86514. toGammaSpaceToRef(convertedColor: Color3): Color3;
  86515. private static _BlackReadOnly;
  86516. /**
  86517. * Convert Hue, saturation and value to a Color3 (RGB)
  86518. * @param hue defines the hue
  86519. * @param saturation defines the saturation
  86520. * @param value defines the value
  86521. * @param result defines the Color3 where to store the RGB values
  86522. */
  86523. static HSVtoRGBToRef(hue: number, saturation: number, value: number, result: Color3): void;
  86524. /**
  86525. * Creates a new Color3 from the string containing valid hexadecimal values
  86526. * @param hex defines a string containing valid hexadecimal values
  86527. * @returns a new Color3 object
  86528. */
  86529. static FromHexString(hex: string): Color3;
  86530. /**
  86531. * Creates a new Color3 from the starting index of the given array
  86532. * @param array defines the source array
  86533. * @param offset defines an offset in the source array
  86534. * @returns a new Color3 object
  86535. */
  86536. static FromArray(array: DeepImmutable<ArrayLike<number>>, offset?: number): Color3;
  86537. /**
  86538. * Creates a new Color3 from the starting index element of the given array
  86539. * @param array defines the source array to read from
  86540. * @param offset defines the offset in the source array
  86541. * @param result defines the target Color3 object
  86542. */
  86543. static FromArrayToRef(array: DeepImmutable<ArrayLike<number>>, offset: number | undefined, result: Color3): void;
  86544. /**
  86545. * Creates a new Color3 from integer values (< 256)
  86546. * @param r defines the red component to read from (value between 0 and 255)
  86547. * @param g defines the green component to read from (value between 0 and 255)
  86548. * @param b defines the blue component to read from (value between 0 and 255)
  86549. * @returns a new Color3 object
  86550. */
  86551. static FromInts(r: number, g: number, b: number): Color3;
  86552. /**
  86553. * Creates a new Color3 with values linearly interpolated of "amount" between the start Color3 and the end Color3
  86554. * @param start defines the start Color3 value
  86555. * @param end defines the end Color3 value
  86556. * @param amount defines the gradient value between start and end
  86557. * @returns a new Color3 object
  86558. */
  86559. static Lerp(start: DeepImmutable<Color3>, end: DeepImmutable<Color3>, amount: number): Color3;
  86560. /**
  86561. * Creates a new Color3 with values linearly interpolated of "amount" between the start Color3 and the end Color3
  86562. * @param left defines the start value
  86563. * @param right defines the end value
  86564. * @param amount defines the gradient factor
  86565. * @param result defines the Color3 object where to store the result
  86566. */
  86567. static LerpToRef(left: DeepImmutable<Color3>, right: DeepImmutable<Color3>, amount: number, result: Color3): void;
  86568. /**
  86569. * Returns a Color3 value containing a red color
  86570. * @returns a new Color3 object
  86571. */
  86572. static Red(): Color3;
  86573. /**
  86574. * Returns a Color3 value containing a green color
  86575. * @returns a new Color3 object
  86576. */
  86577. static Green(): Color3;
  86578. /**
  86579. * Returns a Color3 value containing a blue color
  86580. * @returns a new Color3 object
  86581. */
  86582. static Blue(): Color3;
  86583. /**
  86584. * Returns a Color3 value containing a black color
  86585. * @returns a new Color3 object
  86586. */
  86587. static Black(): Color3;
  86588. /**
  86589. * Gets a Color3 value containing a black color that must not be updated
  86590. */
  86591. static get BlackReadOnly(): DeepImmutable<Color3>;
  86592. /**
  86593. * Returns a Color3 value containing a white color
  86594. * @returns a new Color3 object
  86595. */
  86596. static White(): Color3;
  86597. /**
  86598. * Returns a Color3 value containing a purple color
  86599. * @returns a new Color3 object
  86600. */
  86601. static Purple(): Color3;
  86602. /**
  86603. * Returns a Color3 value containing a magenta color
  86604. * @returns a new Color3 object
  86605. */
  86606. static Magenta(): Color3;
  86607. /**
  86608. * Returns a Color3 value containing a yellow color
  86609. * @returns a new Color3 object
  86610. */
  86611. static Yellow(): Color3;
  86612. /**
  86613. * Returns a Color3 value containing a gray color
  86614. * @returns a new Color3 object
  86615. */
  86616. static Gray(): Color3;
  86617. /**
  86618. * Returns a Color3 value containing a teal color
  86619. * @returns a new Color3 object
  86620. */
  86621. static Teal(): Color3;
  86622. /**
  86623. * Returns a Color3 value containing a random color
  86624. * @returns a new Color3 object
  86625. */
  86626. static Random(): Color3;
  86627. }
  86628. /**
  86629. * Class used to hold a RBGA color
  86630. */
  86631. export class Color4 {
  86632. /**
  86633. * Defines the red component (between 0 and 1, default is 0)
  86634. */
  86635. r: number;
  86636. /**
  86637. * Defines the green component (between 0 and 1, default is 0)
  86638. */
  86639. g: number;
  86640. /**
  86641. * Defines the blue component (between 0 and 1, default is 0)
  86642. */
  86643. b: number;
  86644. /**
  86645. * Defines the alpha component (between 0 and 1, default is 1)
  86646. */
  86647. a: number;
  86648. /**
  86649. * Creates a new Color4 object from red, green, blue values, all between 0 and 1
  86650. * @param r defines the red component (between 0 and 1, default is 0)
  86651. * @param g defines the green component (between 0 and 1, default is 0)
  86652. * @param b defines the blue component (between 0 and 1, default is 0)
  86653. * @param a defines the alpha component (between 0 and 1, default is 1)
  86654. */
  86655. constructor(
  86656. /**
  86657. * Defines the red component (between 0 and 1, default is 0)
  86658. */
  86659. r?: number,
  86660. /**
  86661. * Defines the green component (between 0 and 1, default is 0)
  86662. */
  86663. g?: number,
  86664. /**
  86665. * Defines the blue component (between 0 and 1, default is 0)
  86666. */
  86667. b?: number,
  86668. /**
  86669. * Defines the alpha component (between 0 and 1, default is 1)
  86670. */
  86671. a?: number);
  86672. /**
  86673. * Adds in place the given Color4 values to the current Color4 object
  86674. * @param right defines the second operand
  86675. * @returns the current updated Color4 object
  86676. */
  86677. addInPlace(right: DeepImmutable<Color4>): Color4;
  86678. /**
  86679. * Creates a new array populated with 4 numeric elements : red, green, blue, alpha values
  86680. * @returns the new array
  86681. */
  86682. asArray(): number[];
  86683. /**
  86684. * Stores from the starting index in the given array the Color4 successive values
  86685. * @param array defines the array where to store the r,g,b components
  86686. * @param index defines an optional index in the target array to define where to start storing values
  86687. * @returns the current Color4 object
  86688. */
  86689. toArray(array: number[], index?: number): Color4;
  86690. /**
  86691. * Update the current color with values stored in an array from the starting index of the given array
  86692. * @param array defines the source array
  86693. * @param offset defines an offset in the source array
  86694. * @returns the current Color4 object
  86695. */
  86696. fromArray(array: DeepImmutable<ArrayLike<number>>, offset?: number): Color4;
  86697. /**
  86698. * Determines equality between Color4 objects
  86699. * @param otherColor defines the second operand
  86700. * @returns true if the rgba values are equal to the given ones
  86701. */
  86702. equals(otherColor: DeepImmutable<Color4>): boolean;
  86703. /**
  86704. * Creates a new Color4 set with the added values of the current Color4 and of the given one
  86705. * @param right defines the second operand
  86706. * @returns a new Color4 object
  86707. */
  86708. add(right: DeepImmutable<Color4>): Color4;
  86709. /**
  86710. * Creates a new Color4 set with the subtracted values of the given one from the current Color4
  86711. * @param right defines the second operand
  86712. * @returns a new Color4 object
  86713. */
  86714. subtract(right: DeepImmutable<Color4>): Color4;
  86715. /**
  86716. * Subtracts the given ones from the current Color4 values and stores the results in "result"
  86717. * @param right defines the second operand
  86718. * @param result defines the Color4 object where to store the result
  86719. * @returns the current Color4 object
  86720. */
  86721. subtractToRef(right: DeepImmutable<Color4>, result: Color4): Color4;
  86722. /**
  86723. * Creates a new Color4 with the current Color4 values multiplied by scale
  86724. * @param scale defines the scaling factor to apply
  86725. * @returns a new Color4 object
  86726. */
  86727. scale(scale: number): Color4;
  86728. /**
  86729. * Multiplies the current Color4 values by scale and stores the result in "result"
  86730. * @param scale defines the scaling factor to apply
  86731. * @param result defines the Color4 object where to store the result
  86732. * @returns the current unmodified Color4
  86733. */
  86734. scaleToRef(scale: number, result: Color4): Color4;
  86735. /**
  86736. * Scale the current Color4 values by a factor and add the result to a given Color4
  86737. * @param scale defines the scale factor
  86738. * @param result defines the Color4 object where to store the result
  86739. * @returns the unmodified current Color4
  86740. */
  86741. scaleAndAddToRef(scale: number, result: Color4): Color4;
  86742. /**
  86743. * Clamps the rgb values by the min and max values and stores the result into "result"
  86744. * @param min defines minimum clamping value (default is 0)
  86745. * @param max defines maximum clamping value (default is 1)
  86746. * @param result defines color to store the result into.
  86747. * @returns the cuurent Color4
  86748. */
  86749. clampToRef(min: number | undefined, max: number | undefined, result: Color4): Color4;
  86750. /**
  86751. * Multipy an Color4 value by another and return a new Color4 object
  86752. * @param color defines the Color4 value to multiply by
  86753. * @returns a new Color4 object
  86754. */
  86755. multiply(color: Color4): Color4;
  86756. /**
  86757. * Multipy a Color4 value by another and push the result in a reference value
  86758. * @param color defines the Color4 value to multiply by
  86759. * @param result defines the Color4 to fill the result in
  86760. * @returns the result Color4
  86761. */
  86762. multiplyToRef(color: Color4, result: Color4): Color4;
  86763. /**
  86764. * Creates a string with the Color4 current values
  86765. * @returns the string representation of the Color4 object
  86766. */
  86767. toString(): string;
  86768. /**
  86769. * Returns the string "Color4"
  86770. * @returns "Color4"
  86771. */
  86772. getClassName(): string;
  86773. /**
  86774. * Compute the Color4 hash code
  86775. * @returns an unique number that can be used to hash Color4 objects
  86776. */
  86777. getHashCode(): number;
  86778. /**
  86779. * Creates a new Color4 copied from the current one
  86780. * @returns a new Color4 object
  86781. */
  86782. clone(): Color4;
  86783. /**
  86784. * Copies the given Color4 values into the current one
  86785. * @param source defines the source Color4 object
  86786. * @returns the current updated Color4 object
  86787. */
  86788. copyFrom(source: Color4): Color4;
  86789. /**
  86790. * Copies the given float values into the current one
  86791. * @param r defines the red component to read from
  86792. * @param g defines the green component to read from
  86793. * @param b defines the blue component to read from
  86794. * @param a defines the alpha component to read from
  86795. * @returns the current updated Color4 object
  86796. */
  86797. copyFromFloats(r: number, g: number, b: number, a: number): Color4;
  86798. /**
  86799. * Copies the given float values into the current one
  86800. * @param r defines the red component to read from
  86801. * @param g defines the green component to read from
  86802. * @param b defines the blue component to read from
  86803. * @param a defines the alpha component to read from
  86804. * @returns the current updated Color4 object
  86805. */
  86806. set(r: number, g: number, b: number, a: number): Color4;
  86807. /**
  86808. * Compute the Color4 hexadecimal code as a string
  86809. * @param returnAsColor3 defines if the string should only contains RGB values (off by default)
  86810. * @returns a string containing the hexadecimal representation of the Color4 object
  86811. */
  86812. toHexString(returnAsColor3?: boolean): string;
  86813. /**
  86814. * Computes a new Color4 converted from the current one to linear space
  86815. * @returns a new Color4 object
  86816. */
  86817. toLinearSpace(): Color4;
  86818. /**
  86819. * Converts the Color4 values to linear space and stores the result in "convertedColor"
  86820. * @param convertedColor defines the Color4 object where to store the linear space version
  86821. * @returns the unmodified Color4
  86822. */
  86823. toLinearSpaceToRef(convertedColor: Color4): Color4;
  86824. /**
  86825. * Computes a new Color4 converted from the current one to gamma space
  86826. * @returns a new Color4 object
  86827. */
  86828. toGammaSpace(): Color4;
  86829. /**
  86830. * Converts the Color4 values to gamma space and stores the result in "convertedColor"
  86831. * @param convertedColor defines the Color4 object where to store the gamma space version
  86832. * @returns the unmodified Color4
  86833. */
  86834. toGammaSpaceToRef(convertedColor: Color4): Color4;
  86835. /**
  86836. * Creates a new Color4 from the string containing valid hexadecimal values
  86837. * @param hex defines a string containing valid hexadecimal values
  86838. * @returns a new Color4 object
  86839. */
  86840. static FromHexString(hex: string): Color4;
  86841. /**
  86842. * Creates a new Color4 object set with the linearly interpolated values of "amount" between the left Color4 object and the right Color4 object
  86843. * @param left defines the start value
  86844. * @param right defines the end value
  86845. * @param amount defines the gradient factor
  86846. * @returns a new Color4 object
  86847. */
  86848. static Lerp(left: DeepImmutable<Color4>, right: DeepImmutable<Color4>, amount: number): Color4;
  86849. /**
  86850. * Set the given "result" with the linearly interpolated values of "amount" between the left Color4 object and the right Color4 object
  86851. * @param left defines the start value
  86852. * @param right defines the end value
  86853. * @param amount defines the gradient factor
  86854. * @param result defines the Color4 object where to store data
  86855. */
  86856. static LerpToRef(left: DeepImmutable<Color4>, right: DeepImmutable<Color4>, amount: number, result: Color4): void;
  86857. /**
  86858. * Creates a new Color4 from a Color3 and an alpha value
  86859. * @param color3 defines the source Color3 to read from
  86860. * @param alpha defines the alpha component (1.0 by default)
  86861. * @returns a new Color4 object
  86862. */
  86863. static FromColor3(color3: DeepImmutable<Color3>, alpha?: number): Color4;
  86864. /**
  86865. * Creates a new Color4 from the starting index element of the given array
  86866. * @param array defines the source array to read from
  86867. * @param offset defines the offset in the source array
  86868. * @returns a new Color4 object
  86869. */
  86870. static FromArray(array: DeepImmutable<ArrayLike<number>>, offset?: number): Color4;
  86871. /**
  86872. * Creates a new Color4 from the starting index element of the given array
  86873. * @param array defines the source array to read from
  86874. * @param offset defines the offset in the source array
  86875. * @param result defines the target Color4 object
  86876. */
  86877. static FromArrayToRef(array: DeepImmutable<ArrayLike<number>>, offset: number | undefined, result: Color4): void;
  86878. /**
  86879. * Creates a new Color3 from integer values (< 256)
  86880. * @param r defines the red component to read from (value between 0 and 255)
  86881. * @param g defines the green component to read from (value between 0 and 255)
  86882. * @param b defines the blue component to read from (value between 0 and 255)
  86883. * @param a defines the alpha component to read from (value between 0 and 255)
  86884. * @returns a new Color3 object
  86885. */
  86886. static FromInts(r: number, g: number, b: number, a: number): Color4;
  86887. /**
  86888. * Check the content of a given array and convert it to an array containing RGBA data
  86889. * If the original array was already containing count * 4 values then it is returned directly
  86890. * @param colors defines the array to check
  86891. * @param count defines the number of RGBA data to expect
  86892. * @returns an array containing count * 4 values (RGBA)
  86893. */
  86894. static CheckColors4(colors: number[], count: number): number[];
  86895. }
  86896. /**
  86897. * @hidden
  86898. */
  86899. export class TmpColors {
  86900. static Color3: Color3[];
  86901. static Color4: Color4[];
  86902. }
  86903. }
  86904. declare module BABYLON {
  86905. /**
  86906. * Defines an interface which represents an animation key frame
  86907. */
  86908. export interface IAnimationKey {
  86909. /**
  86910. * Frame of the key frame
  86911. */
  86912. frame: number;
  86913. /**
  86914. * Value at the specifies key frame
  86915. */
  86916. value: any;
  86917. /**
  86918. * The input tangent for the cubic hermite spline
  86919. */
  86920. inTangent?: any;
  86921. /**
  86922. * The output tangent for the cubic hermite spline
  86923. */
  86924. outTangent?: any;
  86925. /**
  86926. * The animation interpolation type
  86927. */
  86928. interpolation?: AnimationKeyInterpolation;
  86929. }
  86930. /**
  86931. * Enum for the animation key frame interpolation type
  86932. */
  86933. export enum AnimationKeyInterpolation {
  86934. /**
  86935. * Do not interpolate between keys and use the start key value only. Tangents are ignored
  86936. */
  86937. STEP = 1
  86938. }
  86939. }
  86940. declare module BABYLON {
  86941. /**
  86942. * Represents the range of an animation
  86943. */
  86944. export class AnimationRange {
  86945. /**The name of the animation range**/
  86946. name: string;
  86947. /**The starting frame of the animation */
  86948. from: number;
  86949. /**The ending frame of the animation*/
  86950. to: number;
  86951. /**
  86952. * Initializes the range of an animation
  86953. * @param name The name of the animation range
  86954. * @param from The starting frame of the animation
  86955. * @param to The ending frame of the animation
  86956. */
  86957. constructor(
  86958. /**The name of the animation range**/
  86959. name: string,
  86960. /**The starting frame of the animation */
  86961. from: number,
  86962. /**The ending frame of the animation*/
  86963. to: number);
  86964. /**
  86965. * Makes a copy of the animation range
  86966. * @returns A copy of the animation range
  86967. */
  86968. clone(): AnimationRange;
  86969. }
  86970. }
  86971. declare module BABYLON {
  86972. /**
  86973. * Composed of a frame, and an action function
  86974. */
  86975. export class AnimationEvent {
  86976. /** The frame for which the event is triggered **/
  86977. frame: number;
  86978. /** The event to perform when triggered **/
  86979. action: (currentFrame: number) => void;
  86980. /** Specifies if the event should be triggered only once**/
  86981. onlyOnce?: boolean | undefined;
  86982. /**
  86983. * Specifies if the animation event is done
  86984. */
  86985. isDone: boolean;
  86986. /**
  86987. * Initializes the animation event
  86988. * @param frame The frame for which the event is triggered
  86989. * @param action The event to perform when triggered
  86990. * @param onlyOnce Specifies if the event should be triggered only once
  86991. */
  86992. constructor(
  86993. /** The frame for which the event is triggered **/
  86994. frame: number,
  86995. /** The event to perform when triggered **/
  86996. action: (currentFrame: number) => void,
  86997. /** Specifies if the event should be triggered only once**/
  86998. onlyOnce?: boolean | undefined);
  86999. /** @hidden */
  87000. _clone(): AnimationEvent;
  87001. }
  87002. }
  87003. declare module BABYLON {
  87004. /**
  87005. * Interface used to define a behavior
  87006. */
  87007. export interface Behavior<T> {
  87008. /** gets or sets behavior's name */
  87009. name: string;
  87010. /**
  87011. * Function called when the behavior needs to be initialized (after attaching it to a target)
  87012. */
  87013. init(): void;
  87014. /**
  87015. * Called when the behavior is attached to a target
  87016. * @param target defines the target where the behavior is attached to
  87017. */
  87018. attach(target: T): void;
  87019. /**
  87020. * Called when the behavior is detached from its target
  87021. */
  87022. detach(): void;
  87023. }
  87024. /**
  87025. * Interface implemented by classes supporting behaviors
  87026. */
  87027. export interface IBehaviorAware<T> {
  87028. /**
  87029. * Attach a behavior
  87030. * @param behavior defines the behavior to attach
  87031. * @returns the current host
  87032. */
  87033. addBehavior(behavior: Behavior<T>): T;
  87034. /**
  87035. * Remove a behavior from the current object
  87036. * @param behavior defines the behavior to detach
  87037. * @returns the current host
  87038. */
  87039. removeBehavior(behavior: Behavior<T>): T;
  87040. /**
  87041. * Gets a behavior using its name to search
  87042. * @param name defines the name to search
  87043. * @returns the behavior or null if not found
  87044. */
  87045. getBehaviorByName(name: string): Nullable<Behavior<T>>;
  87046. }
  87047. }
  87048. declare module BABYLON {
  87049. /**
  87050. * Defines an array and its length.
  87051. * It can be helpfull to group result from both Arrays and smart arrays in one structure.
  87052. */
  87053. export interface ISmartArrayLike<T> {
  87054. /**
  87055. * The data of the array.
  87056. */
  87057. data: Array<T>;
  87058. /**
  87059. * The active length of the array.
  87060. */
  87061. length: number;
  87062. }
  87063. /**
  87064. * Defines an GC Friendly array where the backfield array do not shrink to prevent over allocations.
  87065. */
  87066. export class SmartArray<T> implements ISmartArrayLike<T> {
  87067. /**
  87068. * The full set of data from the array.
  87069. */
  87070. data: Array<T>;
  87071. /**
  87072. * The active length of the array.
  87073. */
  87074. length: number;
  87075. protected _id: number;
  87076. /**
  87077. * Instantiates a Smart Array.
  87078. * @param capacity defines the default capacity of the array.
  87079. */
  87080. constructor(capacity: number);
  87081. /**
  87082. * Pushes a value at the end of the active data.
  87083. * @param value defines the object to push in the array.
  87084. */
  87085. push(value: T): void;
  87086. /**
  87087. * Iterates over the active data and apply the lambda to them.
  87088. * @param func defines the action to apply on each value.
  87089. */
  87090. forEach(func: (content: T) => void): void;
  87091. /**
  87092. * Sorts the full sets of data.
  87093. * @param compareFn defines the comparison function to apply.
  87094. */
  87095. sort(compareFn: (a: T, b: T) => number): void;
  87096. /**
  87097. * Resets the active data to an empty array.
  87098. */
  87099. reset(): void;
  87100. /**
  87101. * Releases all the data from the array as well as the array.
  87102. */
  87103. dispose(): void;
  87104. /**
  87105. * Concats the active data with a given array.
  87106. * @param array defines the data to concatenate with.
  87107. */
  87108. concat(array: any): void;
  87109. /**
  87110. * Returns the position of a value in the active data.
  87111. * @param value defines the value to find the index for
  87112. * @returns the index if found in the active data otherwise -1
  87113. */
  87114. indexOf(value: T): number;
  87115. /**
  87116. * Returns whether an element is part of the active data.
  87117. * @param value defines the value to look for
  87118. * @returns true if found in the active data otherwise false
  87119. */
  87120. contains(value: T): boolean;
  87121. private static _GlobalId;
  87122. }
  87123. /**
  87124. * Defines an GC Friendly array where the backfield array do not shrink to prevent over allocations.
  87125. * The data in this array can only be present once
  87126. */
  87127. export class SmartArrayNoDuplicate<T> extends SmartArray<T> {
  87128. private _duplicateId;
  87129. /**
  87130. * Pushes a value at the end of the active data.
  87131. * THIS DOES NOT PREVENT DUPPLICATE DATA
  87132. * @param value defines the object to push in the array.
  87133. */
  87134. push(value: T): void;
  87135. /**
  87136. * Pushes a value at the end of the active data.
  87137. * If the data is already present, it won t be added again
  87138. * @param value defines the object to push in the array.
  87139. * @returns true if added false if it was already present
  87140. */
  87141. pushNoDuplicate(value: T): boolean;
  87142. /**
  87143. * Resets the active data to an empty array.
  87144. */
  87145. reset(): void;
  87146. /**
  87147. * Concats the active data with a given array.
  87148. * This ensures no dupplicate will be present in the result.
  87149. * @param array defines the data to concatenate with.
  87150. */
  87151. concatWithNoDuplicate(array: any): void;
  87152. }
  87153. }
  87154. declare module BABYLON {
  87155. /**
  87156. * @ignore
  87157. * This is a list of all the different input types that are available in the application.
  87158. * Fo instance: ArcRotateCameraGamepadInput...
  87159. */
  87160. export var CameraInputTypes: {};
  87161. /**
  87162. * This is the contract to implement in order to create a new input class.
  87163. * Inputs are dealing with listening to user actions and moving the camera accordingly.
  87164. */
  87165. export interface ICameraInput<TCamera extends Camera> {
  87166. /**
  87167. * Defines the camera the input is attached to.
  87168. */
  87169. camera: Nullable<TCamera>;
  87170. /**
  87171. * Gets the class name of the current intput.
  87172. * @returns the class name
  87173. */
  87174. getClassName(): string;
  87175. /**
  87176. * Get the friendly name associated with the input class.
  87177. * @returns the input friendly name
  87178. */
  87179. getSimpleName(): string;
  87180. /**
  87181. * Attach the input controls to a specific dom element to get the input from.
  87182. * @param element Defines the element the controls should be listened from
  87183. * @param noPreventDefault Defines whether event caught by the controls should call preventdefault() (https://developer.mozilla.org/en-US/docs/Web/API/Event/preventDefault)
  87184. */
  87185. attachControl(element: HTMLElement, noPreventDefault?: boolean): void;
  87186. /**
  87187. * Detach the current controls from the specified dom element.
  87188. * @param element Defines the element to stop listening the inputs from
  87189. */
  87190. detachControl(element: Nullable<HTMLElement>): void;
  87191. /**
  87192. * Update the current camera state depending on the inputs that have been used this frame.
  87193. * This is a dynamically created lambda to avoid the performance penalty of looping for inputs in the render loop.
  87194. */
  87195. checkInputs?: () => void;
  87196. }
  87197. /**
  87198. * Represents a map of input types to input instance or input index to input instance.
  87199. */
  87200. export interface CameraInputsMap<TCamera extends Camera> {
  87201. /**
  87202. * Accessor to the input by input type.
  87203. */
  87204. [name: string]: ICameraInput<TCamera>;
  87205. /**
  87206. * Accessor to the input by input index.
  87207. */
  87208. [idx: number]: ICameraInput<TCamera>;
  87209. }
  87210. /**
  87211. * This represents the input manager used within a camera.
  87212. * It helps dealing with all the different kind of input attached to a camera.
  87213. * @see https://doc.babylonjs.com/how_to/customizing_camera_inputs
  87214. */
  87215. export class CameraInputsManager<TCamera extends Camera> {
  87216. /**
  87217. * Defines the list of inputs attahed to the camera.
  87218. */
  87219. attached: CameraInputsMap<TCamera>;
  87220. /**
  87221. * Defines the dom element the camera is collecting inputs from.
  87222. * This is null if the controls have not been attached.
  87223. */
  87224. attachedElement: Nullable<HTMLElement>;
  87225. /**
  87226. * Defines whether event caught by the controls should call preventdefault() (https://developer.mozilla.org/en-US/docs/Web/API/Event/preventDefault)
  87227. */
  87228. noPreventDefault: boolean;
  87229. /**
  87230. * Defined the camera the input manager belongs to.
  87231. */
  87232. camera: TCamera;
  87233. /**
  87234. * Update the current camera state depending on the inputs that have been used this frame.
  87235. * This is a dynamically created lambda to avoid the performance penalty of looping for inputs in the render loop.
  87236. */
  87237. checkInputs: () => void;
  87238. /**
  87239. * Instantiate a new Camera Input Manager.
  87240. * @param camera Defines the camera the input manager blongs to
  87241. */
  87242. constructor(camera: TCamera);
  87243. /**
  87244. * Add an input method to a camera
  87245. * @see https://doc.babylonjs.com/how_to/customizing_camera_inputs
  87246. * @param input camera input method
  87247. */
  87248. add(input: ICameraInput<TCamera>): void;
  87249. /**
  87250. * Remove a specific input method from a camera
  87251. * example: camera.inputs.remove(camera.inputs.attached.mouse);
  87252. * @param inputToRemove camera input method
  87253. */
  87254. remove(inputToRemove: ICameraInput<TCamera>): void;
  87255. /**
  87256. * Remove a specific input type from a camera
  87257. * example: camera.inputs.remove("ArcRotateCameraGamepadInput");
  87258. * @param inputType the type of the input to remove
  87259. */
  87260. removeByType(inputType: string): void;
  87261. private _addCheckInputs;
  87262. /**
  87263. * Attach the input controls to the currently attached dom element to listen the events from.
  87264. * @param input Defines the input to attach
  87265. */
  87266. attachInput(input: ICameraInput<TCamera>): void;
  87267. /**
  87268. * Attach the current manager inputs controls to a specific dom element to listen the events from.
  87269. * @param element Defines the dom element to collect the events from
  87270. * @param noPreventDefault Defines whether event caught by the controls should call preventdefault() (https://developer.mozilla.org/en-US/docs/Web/API/Event/preventDefault)
  87271. */
  87272. attachElement(element: HTMLElement, noPreventDefault?: boolean): void;
  87273. /**
  87274. * Detach the current manager inputs controls from a specific dom element.
  87275. * @param element Defines the dom element to collect the events from
  87276. * @param disconnect Defines whether the input should be removed from the current list of attached inputs
  87277. */
  87278. detachElement(element: HTMLElement, disconnect?: boolean): void;
  87279. /**
  87280. * Rebuild the dynamic inputCheck function from the current list of
  87281. * defined inputs in the manager.
  87282. */
  87283. rebuildInputCheck(): void;
  87284. /**
  87285. * Remove all attached input methods from a camera
  87286. */
  87287. clear(): void;
  87288. /**
  87289. * Serialize the current input manager attached to a camera.
  87290. * This ensures than once parsed,
  87291. * the input associated to the camera will be identical to the current ones
  87292. * @param serializedCamera Defines the camera serialization JSON the input serialization should write to
  87293. */
  87294. serialize(serializedCamera: any): void;
  87295. /**
  87296. * Parses an input manager serialized JSON to restore the previous list of inputs
  87297. * and states associated to a camera.
  87298. * @param parsedCamera Defines the JSON to parse
  87299. */
  87300. parse(parsedCamera: any): void;
  87301. }
  87302. }
  87303. declare module BABYLON {
  87304. /**
  87305. * Class used to store data that will be store in GPU memory
  87306. */
  87307. export class Buffer {
  87308. private _engine;
  87309. private _buffer;
  87310. /** @hidden */
  87311. _data: Nullable<DataArray>;
  87312. private _updatable;
  87313. private _instanced;
  87314. private _divisor;
  87315. /**
  87316. * Gets the byte stride.
  87317. */
  87318. readonly byteStride: number;
  87319. /**
  87320. * Constructor
  87321. * @param engine the engine
  87322. * @param data the data to use for this buffer
  87323. * @param updatable whether the data is updatable
  87324. * @param stride the stride (optional)
  87325. * @param postponeInternalCreation whether to postpone creating the internal WebGL buffer (optional)
  87326. * @param instanced whether the buffer is instanced (optional)
  87327. * @param useBytes set to true if the stride in in bytes (optional)
  87328. * @param divisor sets an optional divisor for instances (1 by default)
  87329. */
  87330. constructor(engine: any, data: DataArray, updatable: boolean, stride?: number, postponeInternalCreation?: boolean, instanced?: boolean, useBytes?: boolean, divisor?: number);
  87331. /**
  87332. * Create a new VertexBuffer based on the current buffer
  87333. * @param kind defines the vertex buffer kind (position, normal, etc.)
  87334. * @param offset defines offset in the buffer (0 by default)
  87335. * @param size defines the size in floats of attributes (position is 3 for instance)
  87336. * @param stride defines the stride size in floats in the buffer (the offset to apply to reach next value when data is interleaved)
  87337. * @param instanced defines if the vertex buffer contains indexed data
  87338. * @param useBytes defines if the offset and stride are in bytes *
  87339. * @param divisor sets an optional divisor for instances (1 by default)
  87340. * @returns the new vertex buffer
  87341. */
  87342. createVertexBuffer(kind: string, offset: number, size: number, stride?: number, instanced?: boolean, useBytes?: boolean, divisor?: number): VertexBuffer;
  87343. /**
  87344. * Gets a boolean indicating if the Buffer is updatable?
  87345. * @returns true if the buffer is updatable
  87346. */
  87347. isUpdatable(): boolean;
  87348. /**
  87349. * Gets current buffer's data
  87350. * @returns a DataArray or null
  87351. */
  87352. getData(): Nullable<DataArray>;
  87353. /**
  87354. * Gets underlying native buffer
  87355. * @returns underlying native buffer
  87356. */
  87357. getBuffer(): Nullable<DataBuffer>;
  87358. /**
  87359. * Gets the stride in float32 units (i.e. byte stride / 4).
  87360. * May not be an integer if the byte stride is not divisible by 4.
  87361. * @returns the stride in float32 units
  87362. * @deprecated Please use byteStride instead.
  87363. */
  87364. getStrideSize(): number;
  87365. /**
  87366. * Store data into the buffer. If the buffer was already used it will be either recreated or updated depending on isUpdatable property
  87367. * @param data defines the data to store
  87368. */
  87369. create(data?: Nullable<DataArray>): void;
  87370. /** @hidden */
  87371. _rebuild(): void;
  87372. /**
  87373. * Update current buffer data
  87374. * @param data defines the data to store
  87375. */
  87376. update(data: DataArray): void;
  87377. /**
  87378. * Updates the data directly.
  87379. * @param data the new data
  87380. * @param offset the new offset
  87381. * @param vertexCount the vertex count (optional)
  87382. * @param useBytes set to true if the offset is in bytes
  87383. */
  87384. updateDirectly(data: DataArray, offset: number, vertexCount?: number, useBytes?: boolean): void;
  87385. /**
  87386. * Release all resources
  87387. */
  87388. dispose(): void;
  87389. }
  87390. /**
  87391. * Specialized buffer used to store vertex data
  87392. */
  87393. export class VertexBuffer {
  87394. /** @hidden */
  87395. _buffer: Buffer;
  87396. private _kind;
  87397. private _size;
  87398. private _ownsBuffer;
  87399. private _instanced;
  87400. private _instanceDivisor;
  87401. /**
  87402. * The byte type.
  87403. */
  87404. static readonly BYTE: number;
  87405. /**
  87406. * The unsigned byte type.
  87407. */
  87408. static readonly UNSIGNED_BYTE: number;
  87409. /**
  87410. * The short type.
  87411. */
  87412. static readonly SHORT: number;
  87413. /**
  87414. * The unsigned short type.
  87415. */
  87416. static readonly UNSIGNED_SHORT: number;
  87417. /**
  87418. * The integer type.
  87419. */
  87420. static readonly INT: number;
  87421. /**
  87422. * The unsigned integer type.
  87423. */
  87424. static readonly UNSIGNED_INT: number;
  87425. /**
  87426. * The float type.
  87427. */
  87428. static readonly FLOAT: number;
  87429. /**
  87430. * Gets or sets the instance divisor when in instanced mode
  87431. */
  87432. get instanceDivisor(): number;
  87433. set instanceDivisor(value: number);
  87434. /**
  87435. * Gets the byte stride.
  87436. */
  87437. readonly byteStride: number;
  87438. /**
  87439. * Gets the byte offset.
  87440. */
  87441. readonly byteOffset: number;
  87442. /**
  87443. * Gets whether integer data values should be normalized into a certain range when being casted to a float.
  87444. */
  87445. readonly normalized: boolean;
  87446. /**
  87447. * Gets the data type of each component in the array.
  87448. */
  87449. readonly type: number;
  87450. /**
  87451. * Constructor
  87452. * @param engine the engine
  87453. * @param data the data to use for this vertex buffer
  87454. * @param kind the vertex buffer kind
  87455. * @param updatable whether the data is updatable
  87456. * @param postponeInternalCreation whether to postpone creating the internal WebGL buffer (optional)
  87457. * @param stride the stride (optional)
  87458. * @param instanced whether the buffer is instanced (optional)
  87459. * @param offset the offset of the data (optional)
  87460. * @param size the number of components (optional)
  87461. * @param type the type of the component (optional)
  87462. * @param normalized whether the data contains normalized data (optional)
  87463. * @param useBytes set to true if stride and offset are in bytes (optional)
  87464. * @param divisor defines the instance divisor to use (1 by default)
  87465. */
  87466. 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);
  87467. /** @hidden */
  87468. _rebuild(): void;
  87469. /**
  87470. * Returns the kind of the VertexBuffer (string)
  87471. * @returns a string
  87472. */
  87473. getKind(): string;
  87474. /**
  87475. * Gets a boolean indicating if the VertexBuffer is updatable?
  87476. * @returns true if the buffer is updatable
  87477. */
  87478. isUpdatable(): boolean;
  87479. /**
  87480. * Gets current buffer's data
  87481. * @returns a DataArray or null
  87482. */
  87483. getData(): Nullable<DataArray>;
  87484. /**
  87485. * Gets underlying native buffer
  87486. * @returns underlying native buffer
  87487. */
  87488. getBuffer(): Nullable<DataBuffer>;
  87489. /**
  87490. * Gets the stride in float32 units (i.e. byte stride / 4).
  87491. * May not be an integer if the byte stride is not divisible by 4.
  87492. * @returns the stride in float32 units
  87493. * @deprecated Please use byteStride instead.
  87494. */
  87495. getStrideSize(): number;
  87496. /**
  87497. * Returns the offset as a multiple of the type byte length.
  87498. * @returns the offset in bytes
  87499. * @deprecated Please use byteOffset instead.
  87500. */
  87501. getOffset(): number;
  87502. /**
  87503. * Returns the number of components per vertex attribute (integer)
  87504. * @returns the size in float
  87505. */
  87506. getSize(): number;
  87507. /**
  87508. * Gets a boolean indicating is the internal buffer of the VertexBuffer is instanced
  87509. * @returns true if this buffer is instanced
  87510. */
  87511. getIsInstanced(): boolean;
  87512. /**
  87513. * Returns the instancing divisor, zero for non-instanced (integer).
  87514. * @returns a number
  87515. */
  87516. getInstanceDivisor(): number;
  87517. /**
  87518. * Store data into the buffer. If the buffer was already used it will be either recreated or updated depending on isUpdatable property
  87519. * @param data defines the data to store
  87520. */
  87521. create(data?: DataArray): void;
  87522. /**
  87523. * Updates the underlying buffer according to the passed numeric array or Float32Array.
  87524. * This function will create a new buffer if the current one is not updatable
  87525. * @param data defines the data to store
  87526. */
  87527. update(data: DataArray): void;
  87528. /**
  87529. * Updates directly the underlying WebGLBuffer according to the passed numeric array or Float32Array.
  87530. * Returns the directly updated WebGLBuffer.
  87531. * @param data the new data
  87532. * @param offset the new offset
  87533. * @param useBytes set to true if the offset is in bytes
  87534. */
  87535. updateDirectly(data: DataArray, offset: number, useBytes?: boolean): void;
  87536. /**
  87537. * Disposes the VertexBuffer and the underlying WebGLBuffer.
  87538. */
  87539. dispose(): void;
  87540. /**
  87541. * Enumerates each value of this vertex buffer as numbers.
  87542. * @param count the number of values to enumerate
  87543. * @param callback the callback function called for each value
  87544. */
  87545. forEach(count: number, callback: (value: number, index: number) => void): void;
  87546. /**
  87547. * Positions
  87548. */
  87549. static readonly PositionKind: string;
  87550. /**
  87551. * Normals
  87552. */
  87553. static readonly NormalKind: string;
  87554. /**
  87555. * Tangents
  87556. */
  87557. static readonly TangentKind: string;
  87558. /**
  87559. * Texture coordinates
  87560. */
  87561. static readonly UVKind: string;
  87562. /**
  87563. * Texture coordinates 2
  87564. */
  87565. static readonly UV2Kind: string;
  87566. /**
  87567. * Texture coordinates 3
  87568. */
  87569. static readonly UV3Kind: string;
  87570. /**
  87571. * Texture coordinates 4
  87572. */
  87573. static readonly UV4Kind: string;
  87574. /**
  87575. * Texture coordinates 5
  87576. */
  87577. static readonly UV5Kind: string;
  87578. /**
  87579. * Texture coordinates 6
  87580. */
  87581. static readonly UV6Kind: string;
  87582. /**
  87583. * Colors
  87584. */
  87585. static readonly ColorKind: string;
  87586. /**
  87587. * Matrix indices (for bones)
  87588. */
  87589. static readonly MatricesIndicesKind: string;
  87590. /**
  87591. * Matrix weights (for bones)
  87592. */
  87593. static readonly MatricesWeightsKind: string;
  87594. /**
  87595. * Additional matrix indices (for bones)
  87596. */
  87597. static readonly MatricesIndicesExtraKind: string;
  87598. /**
  87599. * Additional matrix weights (for bones)
  87600. */
  87601. static readonly MatricesWeightsExtraKind: string;
  87602. /**
  87603. * Deduces the stride given a kind.
  87604. * @param kind The kind string to deduce
  87605. * @returns The deduced stride
  87606. */
  87607. static DeduceStride(kind: string): number;
  87608. /**
  87609. * Gets the byte length of the given type.
  87610. * @param type the type
  87611. * @returns the number of bytes
  87612. */
  87613. static GetTypeByteLength(type: number): number;
  87614. /**
  87615. * Enumerates each value of the given parameters as numbers.
  87616. * @param data the data to enumerate
  87617. * @param byteOffset the byte offset of the data
  87618. * @param byteStride the byte stride of the data
  87619. * @param componentCount the number of components per element
  87620. * @param componentType the type of the component
  87621. * @param count the number of values to enumerate
  87622. * @param normalized whether the data is normalized
  87623. * @param callback the callback function called for each value
  87624. */
  87625. static ForEach(data: DataArray, byteOffset: number, byteStride: number, componentCount: number, componentType: number, count: number, normalized: boolean, callback: (value: number, index: number) => void): void;
  87626. private static _GetFloatValue;
  87627. }
  87628. }
  87629. declare module BABYLON {
  87630. /**
  87631. * The options Interface for creating a Capsule Mesh
  87632. */
  87633. export interface ICreateCapsuleOptions {
  87634. /** The Orientation of the capsule. Default : Vector3.Up() */
  87635. orientation?: Vector3;
  87636. /** Number of sub segments on the tube section of the capsule running parallel to orientation. */
  87637. subdivisions: number;
  87638. /** Number of cylindrical segments on the capsule. */
  87639. tessellation: number;
  87640. /** Height or Length of the capsule. */
  87641. height: number;
  87642. /** Radius of the capsule. */
  87643. radius: number;
  87644. /** Number of sub segments on the cap sections of the capsule running parallel to orientation. */
  87645. capSubdivisions: number;
  87646. /** Overwrite for the top radius. */
  87647. radiusTop?: number;
  87648. /** Overwrite for the bottom radius. */
  87649. radiusBottom?: number;
  87650. /** Overwrite for the top capSubdivisions. */
  87651. topCapSubdivisions?: number;
  87652. /** Overwrite for the bottom capSubdivisions. */
  87653. bottomCapSubdivisions?: number;
  87654. }
  87655. /**
  87656. * Class containing static functions to help procedurally build meshes
  87657. */
  87658. export class CapsuleBuilder {
  87659. /**
  87660. * Creates a capsule or a pill mesh
  87661. * @param name defines the name of the mesh
  87662. * @param options The constructors options.
  87663. * @param scene The scene the mesh is scoped to.
  87664. * @returns Capsule Mesh
  87665. */
  87666. static CreateCapsule(name: string, options: ICreateCapsuleOptions | undefined, scene: any): Mesh;
  87667. }
  87668. }
  87669. declare module BABYLON {
  87670. /**
  87671. * @hidden
  87672. */
  87673. export class IntersectionInfo {
  87674. bu: Nullable<number>;
  87675. bv: Nullable<number>;
  87676. distance: number;
  87677. faceId: number;
  87678. subMeshId: number;
  87679. constructor(bu: Nullable<number>, bv: Nullable<number>, distance: number);
  87680. }
  87681. }
  87682. declare module BABYLON {
  87683. /**
  87684. * Class used to store bounding sphere information
  87685. */
  87686. export class BoundingSphere {
  87687. /**
  87688. * Gets the center of the bounding sphere in local space
  87689. */
  87690. readonly center: Vector3;
  87691. /**
  87692. * Radius of the bounding sphere in local space
  87693. */
  87694. radius: number;
  87695. /**
  87696. * Gets the center of the bounding sphere in world space
  87697. */
  87698. readonly centerWorld: Vector3;
  87699. /**
  87700. * Radius of the bounding sphere in world space
  87701. */
  87702. radiusWorld: number;
  87703. /**
  87704. * Gets the minimum vector in local space
  87705. */
  87706. readonly minimum: Vector3;
  87707. /**
  87708. * Gets the maximum vector in local space
  87709. */
  87710. readonly maximum: Vector3;
  87711. private _worldMatrix;
  87712. private static readonly TmpVector3;
  87713. /**
  87714. * Creates a new bounding sphere
  87715. * @param min defines the minimum vector (in local space)
  87716. * @param max defines the maximum vector (in local space)
  87717. * @param worldMatrix defines the new world matrix
  87718. */
  87719. constructor(min: DeepImmutable<Vector3>, max: DeepImmutable<Vector3>, worldMatrix?: DeepImmutable<Matrix>);
  87720. /**
  87721. * Recreates the entire bounding sphere from scratch as if we call the constructor in place
  87722. * @param min defines the new minimum vector (in local space)
  87723. * @param max defines the new maximum vector (in local space)
  87724. * @param worldMatrix defines the new world matrix
  87725. */
  87726. reConstruct(min: DeepImmutable<Vector3>, max: DeepImmutable<Vector3>, worldMatrix?: DeepImmutable<Matrix>): void;
  87727. /**
  87728. * Scale the current bounding sphere by applying a scale factor
  87729. * @param factor defines the scale factor to apply
  87730. * @returns the current bounding box
  87731. */
  87732. scale(factor: number): BoundingSphere;
  87733. /**
  87734. * Gets the world matrix of the bounding box
  87735. * @returns a matrix
  87736. */
  87737. getWorldMatrix(): DeepImmutable<Matrix>;
  87738. /** @hidden */
  87739. _update(worldMatrix: DeepImmutable<Matrix>): void;
  87740. /**
  87741. * Tests if the bounding sphere is intersecting the frustum planes
  87742. * @param frustumPlanes defines the frustum planes to test
  87743. * @returns true if there is an intersection
  87744. */
  87745. isInFrustum(frustumPlanes: Array<DeepImmutable<Plane>>): boolean;
  87746. /**
  87747. * Tests if the bounding sphere center is in between the frustum planes.
  87748. * Used for optimistic fast inclusion.
  87749. * @param frustumPlanes defines the frustum planes to test
  87750. * @returns true if the sphere center is in between the frustum planes
  87751. */
  87752. isCenterInFrustum(frustumPlanes: Array<DeepImmutable<Plane>>): boolean;
  87753. /**
  87754. * Tests if a point is inside the bounding sphere
  87755. * @param point defines the point to test
  87756. * @returns true if the point is inside the bounding sphere
  87757. */
  87758. intersectsPoint(point: DeepImmutable<Vector3>): boolean;
  87759. /**
  87760. * Checks if two sphere intersct
  87761. * @param sphere0 sphere 0
  87762. * @param sphere1 sphere 1
  87763. * @returns true if the speres intersect
  87764. */
  87765. static Intersects(sphere0: DeepImmutable<BoundingSphere>, sphere1: DeepImmutable<BoundingSphere>): boolean;
  87766. }
  87767. }
  87768. declare module BABYLON {
  87769. /**
  87770. * Class used to store bounding box information
  87771. */
  87772. export class BoundingBox implements ICullable {
  87773. /**
  87774. * Gets the 8 vectors representing the bounding box in local space
  87775. */
  87776. readonly vectors: Vector3[];
  87777. /**
  87778. * Gets the center of the bounding box in local space
  87779. */
  87780. readonly center: Vector3;
  87781. /**
  87782. * Gets the center of the bounding box in world space
  87783. */
  87784. readonly centerWorld: Vector3;
  87785. /**
  87786. * Gets the extend size in local space
  87787. */
  87788. readonly extendSize: Vector3;
  87789. /**
  87790. * Gets the extend size in world space
  87791. */
  87792. readonly extendSizeWorld: Vector3;
  87793. /**
  87794. * Gets the OBB (object bounding box) directions
  87795. */
  87796. readonly directions: Vector3[];
  87797. /**
  87798. * Gets the 8 vectors representing the bounding box in world space
  87799. */
  87800. readonly vectorsWorld: Vector3[];
  87801. /**
  87802. * Gets the minimum vector in world space
  87803. */
  87804. readonly minimumWorld: Vector3;
  87805. /**
  87806. * Gets the maximum vector in world space
  87807. */
  87808. readonly maximumWorld: Vector3;
  87809. /**
  87810. * Gets the minimum vector in local space
  87811. */
  87812. readonly minimum: Vector3;
  87813. /**
  87814. * Gets the maximum vector in local space
  87815. */
  87816. readonly maximum: Vector3;
  87817. private _worldMatrix;
  87818. private static readonly TmpVector3;
  87819. /**
  87820. * @hidden
  87821. */
  87822. _tag: number;
  87823. /**
  87824. * Creates a new bounding box
  87825. * @param min defines the minimum vector (in local space)
  87826. * @param max defines the maximum vector (in local space)
  87827. * @param worldMatrix defines the new world matrix
  87828. */
  87829. constructor(min: DeepImmutable<Vector3>, max: DeepImmutable<Vector3>, worldMatrix?: DeepImmutable<Matrix>);
  87830. /**
  87831. * Recreates the entire bounding box from scratch as if we call the constructor in place
  87832. * @param min defines the new minimum vector (in local space)
  87833. * @param max defines the new maximum vector (in local space)
  87834. * @param worldMatrix defines the new world matrix
  87835. */
  87836. reConstruct(min: DeepImmutable<Vector3>, max: DeepImmutable<Vector3>, worldMatrix?: DeepImmutable<Matrix>): void;
  87837. /**
  87838. * Scale the current bounding box by applying a scale factor
  87839. * @param factor defines the scale factor to apply
  87840. * @returns the current bounding box
  87841. */
  87842. scale(factor: number): BoundingBox;
  87843. /**
  87844. * Gets the world matrix of the bounding box
  87845. * @returns a matrix
  87846. */
  87847. getWorldMatrix(): DeepImmutable<Matrix>;
  87848. /** @hidden */
  87849. _update(world: DeepImmutable<Matrix>): void;
  87850. /**
  87851. * Tests if the bounding box is intersecting the frustum planes
  87852. * @param frustumPlanes defines the frustum planes to test
  87853. * @returns true if there is an intersection
  87854. */
  87855. isInFrustum(frustumPlanes: Array<DeepImmutable<Plane>>): boolean;
  87856. /**
  87857. * Tests if the bounding box is entirely inside the frustum planes
  87858. * @param frustumPlanes defines the frustum planes to test
  87859. * @returns true if there is an inclusion
  87860. */
  87861. isCompletelyInFrustum(frustumPlanes: Array<DeepImmutable<Plane>>): boolean;
  87862. /**
  87863. * Tests if a point is inside the bounding box
  87864. * @param point defines the point to test
  87865. * @returns true if the point is inside the bounding box
  87866. */
  87867. intersectsPoint(point: DeepImmutable<Vector3>): boolean;
  87868. /**
  87869. * Tests if the bounding box intersects with a bounding sphere
  87870. * @param sphere defines the sphere to test
  87871. * @returns true if there is an intersection
  87872. */
  87873. intersectsSphere(sphere: DeepImmutable<BoundingSphere>): boolean;
  87874. /**
  87875. * Tests if the bounding box intersects with a box defined by a min and max vectors
  87876. * @param min defines the min vector to use
  87877. * @param max defines the max vector to use
  87878. * @returns true if there is an intersection
  87879. */
  87880. intersectsMinMax(min: DeepImmutable<Vector3>, max: DeepImmutable<Vector3>): boolean;
  87881. /**
  87882. * Tests if two bounding boxes are intersections
  87883. * @param box0 defines the first box to test
  87884. * @param box1 defines the second box to test
  87885. * @returns true if there is an intersection
  87886. */
  87887. static Intersects(box0: DeepImmutable<BoundingBox>, box1: DeepImmutable<BoundingBox>): boolean;
  87888. /**
  87889. * Tests if a bounding box defines by a min/max vectors intersects a sphere
  87890. * @param minPoint defines the minimum vector of the bounding box
  87891. * @param maxPoint defines the maximum vector of the bounding box
  87892. * @param sphereCenter defines the sphere center
  87893. * @param sphereRadius defines the sphere radius
  87894. * @returns true if there is an intersection
  87895. */
  87896. static IntersectsSphere(minPoint: DeepImmutable<Vector3>, maxPoint: DeepImmutable<Vector3>, sphereCenter: DeepImmutable<Vector3>, sphereRadius: number): boolean;
  87897. /**
  87898. * Tests if a bounding box defined with 8 vectors is entirely inside frustum planes
  87899. * @param boundingVectors defines an array of 8 vectors representing a bounding box
  87900. * @param frustumPlanes defines the frustum planes to test
  87901. * @return true if there is an inclusion
  87902. */
  87903. static IsCompletelyInFrustum(boundingVectors: Array<DeepImmutable<Vector3>>, frustumPlanes: Array<DeepImmutable<Plane>>): boolean;
  87904. /**
  87905. * Tests if a bounding box defined with 8 vectors intersects frustum planes
  87906. * @param boundingVectors defines an array of 8 vectors representing a bounding box
  87907. * @param frustumPlanes defines the frustum planes to test
  87908. * @return true if there is an intersection
  87909. */
  87910. static IsInFrustum(boundingVectors: Array<DeepImmutable<Vector3>>, frustumPlanes: Array<DeepImmutable<Plane>>): boolean;
  87911. }
  87912. }
  87913. declare module BABYLON {
  87914. /** @hidden */
  87915. export class Collider {
  87916. /** Define if a collision was found */
  87917. collisionFound: boolean;
  87918. /**
  87919. * Define last intersection point in local space
  87920. */
  87921. intersectionPoint: Vector3;
  87922. /**
  87923. * Define last collided mesh
  87924. */
  87925. collidedMesh: Nullable<AbstractMesh>;
  87926. private _collisionPoint;
  87927. private _planeIntersectionPoint;
  87928. private _tempVector;
  87929. private _tempVector2;
  87930. private _tempVector3;
  87931. private _tempVector4;
  87932. private _edge;
  87933. private _baseToVertex;
  87934. private _destinationPoint;
  87935. private _slidePlaneNormal;
  87936. private _displacementVector;
  87937. /** @hidden */
  87938. _radius: Vector3;
  87939. /** @hidden */
  87940. _retry: number;
  87941. private _velocity;
  87942. private _basePoint;
  87943. private _epsilon;
  87944. /** @hidden */
  87945. _velocityWorldLength: number;
  87946. /** @hidden */
  87947. _basePointWorld: Vector3;
  87948. private _velocityWorld;
  87949. private _normalizedVelocity;
  87950. /** @hidden */
  87951. _initialVelocity: Vector3;
  87952. /** @hidden */
  87953. _initialPosition: Vector3;
  87954. private _nearestDistance;
  87955. private _collisionMask;
  87956. get collisionMask(): number;
  87957. set collisionMask(mask: number);
  87958. /**
  87959. * Gets the plane normal used to compute the sliding response (in local space)
  87960. */
  87961. get slidePlaneNormal(): Vector3;
  87962. /** @hidden */
  87963. _initialize(source: Vector3, dir: Vector3, e: number): void;
  87964. /** @hidden */
  87965. _checkPointInTriangle(point: Vector3, pa: Vector3, pb: Vector3, pc: Vector3, n: Vector3): boolean;
  87966. /** @hidden */
  87967. _canDoCollision(sphereCenter: Vector3, sphereRadius: number, vecMin: Vector3, vecMax: Vector3): boolean;
  87968. /** @hidden */
  87969. _testTriangle(faceIndex: number, trianglePlaneArray: Array<Plane>, p1: Vector3, p2: Vector3, p3: Vector3, hasMaterial: boolean, hostMesh: AbstractMesh): void;
  87970. /** @hidden */
  87971. _collide(trianglePlaneArray: Array<Plane>, pts: Vector3[], indices: IndicesArray, indexStart: number, indexEnd: number, decal: number, hasMaterial: boolean, hostMesh: AbstractMesh): void;
  87972. /** @hidden */
  87973. _getResponse(pos: Vector3, vel: Vector3): void;
  87974. }
  87975. }
  87976. declare module BABYLON {
  87977. /**
  87978. * Interface for cullable objects
  87979. * @see https://doc.babylonjs.com/babylon101/materials#back-face-culling
  87980. */
  87981. export interface ICullable {
  87982. /**
  87983. * Checks if the object or part of the object is in the frustum
  87984. * @param frustumPlanes Camera near/planes
  87985. * @returns true if the object is in frustum otherwise false
  87986. */
  87987. isInFrustum(frustumPlanes: Plane[]): boolean;
  87988. /**
  87989. * Checks if a cullable object (mesh...) is in the camera frustum
  87990. * Unlike isInFrustum this cheks the full bounding box
  87991. * @param frustumPlanes Camera near/planes
  87992. * @returns true if the object is in frustum otherwise false
  87993. */
  87994. isCompletelyInFrustum(frustumPlanes: Plane[]): boolean;
  87995. }
  87996. /**
  87997. * Info for a bounding data of a mesh
  87998. */
  87999. export class BoundingInfo implements ICullable {
  88000. /**
  88001. * Bounding box for the mesh
  88002. */
  88003. readonly boundingBox: BoundingBox;
  88004. /**
  88005. * Bounding sphere for the mesh
  88006. */
  88007. readonly boundingSphere: BoundingSphere;
  88008. private _isLocked;
  88009. private static readonly TmpVector3;
  88010. /**
  88011. * Constructs bounding info
  88012. * @param minimum min vector of the bounding box/sphere
  88013. * @param maximum max vector of the bounding box/sphere
  88014. * @param worldMatrix defines the new world matrix
  88015. */
  88016. constructor(minimum: DeepImmutable<Vector3>, maximum: DeepImmutable<Vector3>, worldMatrix?: DeepImmutable<Matrix>);
  88017. /**
  88018. * Recreates the entire bounding info from scratch as if we call the constructor in place
  88019. * @param min defines the new minimum vector (in local space)
  88020. * @param max defines the new maximum vector (in local space)
  88021. * @param worldMatrix defines the new world matrix
  88022. */
  88023. reConstruct(min: DeepImmutable<Vector3>, max: DeepImmutable<Vector3>, worldMatrix?: DeepImmutable<Matrix>): void;
  88024. /**
  88025. * min vector of the bounding box/sphere
  88026. */
  88027. get minimum(): Vector3;
  88028. /**
  88029. * max vector of the bounding box/sphere
  88030. */
  88031. get maximum(): Vector3;
  88032. /**
  88033. * If the info is locked and won't be updated to avoid perf overhead
  88034. */
  88035. get isLocked(): boolean;
  88036. set isLocked(value: boolean);
  88037. /**
  88038. * Updates the bounding sphere and box
  88039. * @param world world matrix to be used to update
  88040. */
  88041. update(world: DeepImmutable<Matrix>): void;
  88042. /**
  88043. * Recreate the bounding info to be centered around a specific point given a specific extend.
  88044. * @param center New center of the bounding info
  88045. * @param extend New extend of the bounding info
  88046. * @returns the current bounding info
  88047. */
  88048. centerOn(center: DeepImmutable<Vector3>, extend: DeepImmutable<Vector3>): BoundingInfo;
  88049. /**
  88050. * Scale the current bounding info by applying a scale factor
  88051. * @param factor defines the scale factor to apply
  88052. * @returns the current bounding info
  88053. */
  88054. scale(factor: number): BoundingInfo;
  88055. /**
  88056. * Returns `true` if the bounding info is within the frustum defined by the passed array of planes.
  88057. * @param frustumPlanes defines the frustum to test
  88058. * @param strategy defines the strategy to use for the culling (default is BABYLON.AbstractMesh.CULLINGSTRATEGY_STANDARD)
  88059. * @returns true if the bounding info is in the frustum planes
  88060. */
  88061. isInFrustum(frustumPlanes: Array<DeepImmutable<Plane>>, strategy?: number): boolean;
  88062. /**
  88063. * Gets the world distance between the min and max points of the bounding box
  88064. */
  88065. get diagonalLength(): number;
  88066. /**
  88067. * Checks if a cullable object (mesh...) is in the camera frustum
  88068. * Unlike isInFrustum this cheks the full bounding box
  88069. * @param frustumPlanes Camera near/planes
  88070. * @returns true if the object is in frustum otherwise false
  88071. */
  88072. isCompletelyInFrustum(frustumPlanes: Array<DeepImmutable<Plane>>): boolean;
  88073. /** @hidden */
  88074. _checkCollision(collider: Collider): boolean;
  88075. /**
  88076. * Checks if a point is inside the bounding box and bounding sphere or the mesh
  88077. * @see https://doc.babylonjs.com/babylon101/intersect_collisions_-_mesh
  88078. * @param point the point to check intersection with
  88079. * @returns if the point intersects
  88080. */
  88081. intersectsPoint(point: DeepImmutable<Vector3>): boolean;
  88082. /**
  88083. * Checks if another bounding info intersects the bounding box and bounding sphere or the mesh
  88084. * @see https://doc.babylonjs.com/babylon101/intersect_collisions_-_mesh
  88085. * @param boundingInfo the bounding info to check intersection with
  88086. * @param precise if the intersection should be done using OBB
  88087. * @returns if the bounding info intersects
  88088. */
  88089. intersects(boundingInfo: DeepImmutable<BoundingInfo>, precise: boolean): boolean;
  88090. }
  88091. }
  88092. declare module BABYLON {
  88093. /**
  88094. * Extracts minimum and maximum values from a list of indexed positions
  88095. * @param positions defines the positions to use
  88096. * @param indices defines the indices to the positions
  88097. * @param indexStart defines the start index
  88098. * @param indexCount defines the end index
  88099. * @param bias defines bias value to add to the result
  88100. * @return minimum and maximum values
  88101. */
  88102. export function extractMinAndMaxIndexed(positions: FloatArray, indices: IndicesArray, indexStart: number, indexCount: number, bias?: Nullable<Vector2>): {
  88103. minimum: Vector3;
  88104. maximum: Vector3;
  88105. };
  88106. /**
  88107. * Extracts minimum and maximum values from a list of positions
  88108. * @param positions defines the positions to use
  88109. * @param start defines the start index in the positions array
  88110. * @param count defines the number of positions to handle
  88111. * @param bias defines bias value to add to the result
  88112. * @param stride defines the stride size to use (distance between two positions in the positions array)
  88113. * @return minimum and maximum values
  88114. */
  88115. export function extractMinAndMax(positions: FloatArray, start: number, count: number, bias?: Nullable<Vector2>, stride?: number): {
  88116. minimum: Vector3;
  88117. maximum: Vector3;
  88118. };
  88119. }
  88120. declare module BABYLON {
  88121. /** @hidden */
  88122. export class WebGLDataBuffer extends DataBuffer {
  88123. private _buffer;
  88124. constructor(resource: WebGLBuffer);
  88125. get underlyingResource(): any;
  88126. }
  88127. }
  88128. declare module BABYLON {
  88129. /** @hidden */
  88130. export class WebGLPipelineContext implements IPipelineContext {
  88131. engine: ThinEngine;
  88132. program: Nullable<WebGLProgram>;
  88133. context?: WebGLRenderingContext;
  88134. vertexShader?: WebGLShader;
  88135. fragmentShader?: WebGLShader;
  88136. isParallelCompiled: boolean;
  88137. onCompiled?: () => void;
  88138. transformFeedback?: WebGLTransformFeedback | null;
  88139. vertexCompilationError: Nullable<string>;
  88140. fragmentCompilationError: Nullable<string>;
  88141. programLinkError: Nullable<string>;
  88142. programValidationError: Nullable<string>;
  88143. get isAsync(): boolean;
  88144. get isReady(): boolean;
  88145. _handlesSpectorRebuildCallback(onCompiled: (program: WebGLProgram) => void): void;
  88146. _getVertexShaderCode(): string | null;
  88147. _getFragmentShaderCode(): string | null;
  88148. }
  88149. }
  88150. declare module BABYLON {
  88151. interface ThinEngine {
  88152. /**
  88153. * Create an uniform buffer
  88154. * @see https://doc.babylonjs.com/features/webgl2#uniform-buffer-objets
  88155. * @param elements defines the content of the uniform buffer
  88156. * @returns the webGL uniform buffer
  88157. */
  88158. createUniformBuffer(elements: FloatArray): DataBuffer;
  88159. /**
  88160. * Create a dynamic uniform buffer
  88161. * @see https://doc.babylonjs.com/features/webgl2#uniform-buffer-objets
  88162. * @param elements defines the content of the uniform buffer
  88163. * @returns the webGL uniform buffer
  88164. */
  88165. createDynamicUniformBuffer(elements: FloatArray): DataBuffer;
  88166. /**
  88167. * Update an existing uniform buffer
  88168. * @see https://doc.babylonjs.com/features/webgl2#uniform-buffer-objets
  88169. * @param uniformBuffer defines the target uniform buffer
  88170. * @param elements defines the content to update
  88171. * @param offset defines the offset in the uniform buffer where update should start
  88172. * @param count defines the size of the data to update
  88173. */
  88174. updateUniformBuffer(uniformBuffer: DataBuffer, elements: FloatArray, offset?: number, count?: number): void;
  88175. /**
  88176. * Bind an uniform buffer to the current webGL context
  88177. * @param buffer defines the buffer to bind
  88178. */
  88179. bindUniformBuffer(buffer: Nullable<DataBuffer>): void;
  88180. /**
  88181. * Bind a buffer to the current webGL context at a given location
  88182. * @param buffer defines the buffer to bind
  88183. * @param location defines the index where to bind the buffer
  88184. */
  88185. bindUniformBufferBase(buffer: DataBuffer, location: number): void;
  88186. /**
  88187. * Bind a specific block at a given index in a specific shader program
  88188. * @param pipelineContext defines the pipeline context to use
  88189. * @param blockName defines the block name
  88190. * @param index defines the index where to bind the block
  88191. */
  88192. bindUniformBlock(pipelineContext: IPipelineContext, blockName: string, index: number): void;
  88193. }
  88194. }
  88195. declare module BABYLON {
  88196. /**
  88197. * Uniform buffer objects.
  88198. *
  88199. * Handles blocks of uniform on the GPU.
  88200. *
  88201. * If WebGL 2 is not available, this class falls back on traditionnal setUniformXXX calls.
  88202. *
  88203. * For more information, please refer to :
  88204. * https://www.khronos.org/opengl/wiki/Uniform_Buffer_Object
  88205. */
  88206. export class UniformBuffer {
  88207. private _engine;
  88208. private _buffer;
  88209. private _data;
  88210. private _bufferData;
  88211. private _dynamic?;
  88212. private _uniformLocations;
  88213. private _uniformSizes;
  88214. private _uniformLocationPointer;
  88215. private _needSync;
  88216. private _noUBO;
  88217. private _currentEffect;
  88218. /** @hidden */
  88219. _alreadyBound: boolean;
  88220. private static _MAX_UNIFORM_SIZE;
  88221. private static _tempBuffer;
  88222. /**
  88223. * Lambda to Update a 3x3 Matrix in a uniform buffer.
  88224. * This is dynamic to allow compat with webgl 1 and 2.
  88225. * You will need to pass the name of the uniform as well as the value.
  88226. */
  88227. updateMatrix3x3: (name: string, matrix: Float32Array) => void;
  88228. /**
  88229. * Lambda to Update a 2x2 Matrix in a uniform buffer.
  88230. * This is dynamic to allow compat with webgl 1 and 2.
  88231. * You will need to pass the name of the uniform as well as the value.
  88232. */
  88233. updateMatrix2x2: (name: string, matrix: Float32Array) => void;
  88234. /**
  88235. * Lambda to Update a single float in a uniform buffer.
  88236. * This is dynamic to allow compat with webgl 1 and 2.
  88237. * You will need to pass the name of the uniform as well as the value.
  88238. */
  88239. updateFloat: (name: string, x: number) => void;
  88240. /**
  88241. * Lambda to Update a vec2 of float in a uniform buffer.
  88242. * This is dynamic to allow compat with webgl 1 and 2.
  88243. * You will need to pass the name of the uniform as well as the value.
  88244. */
  88245. updateFloat2: (name: string, x: number, y: number, suffix?: string) => void;
  88246. /**
  88247. * Lambda to Update a vec3 of float in a uniform buffer.
  88248. * This is dynamic to allow compat with webgl 1 and 2.
  88249. * You will need to pass the name of the uniform as well as the value.
  88250. */
  88251. updateFloat3: (name: string, x: number, y: number, z: number, suffix?: string) => void;
  88252. /**
  88253. * Lambda to Update a vec4 of float in a uniform buffer.
  88254. * This is dynamic to allow compat with webgl 1 and 2.
  88255. * You will need to pass the name of the uniform as well as the value.
  88256. */
  88257. updateFloat4: (name: string, x: number, y: number, z: number, w: number, suffix?: string) => void;
  88258. /**
  88259. * Lambda to Update a 4x4 Matrix in a uniform buffer.
  88260. * This is dynamic to allow compat with webgl 1 and 2.
  88261. * You will need to pass the name of the uniform as well as the value.
  88262. */
  88263. updateMatrix: (name: string, mat: Matrix) => void;
  88264. /**
  88265. * Lambda to Update vec3 of float from a Vector in a uniform buffer.
  88266. * This is dynamic to allow compat with webgl 1 and 2.
  88267. * You will need to pass the name of the uniform as well as the value.
  88268. */
  88269. updateVector3: (name: string, vector: Vector3) => void;
  88270. /**
  88271. * Lambda to Update vec4 of float from a Vector in a uniform buffer.
  88272. * This is dynamic to allow compat with webgl 1 and 2.
  88273. * You will need to pass the name of the uniform as well as the value.
  88274. */
  88275. updateVector4: (name: string, vector: Vector4) => void;
  88276. /**
  88277. * Lambda to Update vec3 of float from a Color in a uniform buffer.
  88278. * This is dynamic to allow compat with webgl 1 and 2.
  88279. * You will need to pass the name of the uniform as well as the value.
  88280. */
  88281. updateColor3: (name: string, color: Color3, suffix?: string) => void;
  88282. /**
  88283. * Lambda to Update vec4 of float from a Color in a uniform buffer.
  88284. * This is dynamic to allow compat with webgl 1 and 2.
  88285. * You will need to pass the name of the uniform as well as the value.
  88286. */
  88287. updateColor4: (name: string, color: Color3, alpha: number, suffix?: string) => void;
  88288. /**
  88289. * Instantiates a new Uniform buffer objects.
  88290. *
  88291. * Handles blocks of uniform on the GPU.
  88292. *
  88293. * If WebGL 2 is not available, this class falls back on traditionnal setUniformXXX calls.
  88294. *
  88295. * For more information, please refer to :
  88296. * @see https://www.khronos.org/opengl/wiki/Uniform_Buffer_Object
  88297. * @param engine Define the engine the buffer is associated with
  88298. * @param data Define the data contained in the buffer
  88299. * @param dynamic Define if the buffer is updatable
  88300. */
  88301. constructor(engine: Engine, data?: number[], dynamic?: boolean);
  88302. /**
  88303. * Indicates if the buffer is using the WebGL2 UBO implementation,
  88304. * or just falling back on setUniformXXX calls.
  88305. */
  88306. get useUbo(): boolean;
  88307. /**
  88308. * Indicates if the WebGL underlying uniform buffer is in sync
  88309. * with the javascript cache data.
  88310. */
  88311. get isSync(): boolean;
  88312. /**
  88313. * Indicates if the WebGL underlying uniform buffer is dynamic.
  88314. * Also, a dynamic UniformBuffer will disable cache verification and always
  88315. * update the underlying WebGL uniform buffer to the GPU.
  88316. * @returns if Dynamic, otherwise false
  88317. */
  88318. isDynamic(): boolean;
  88319. /**
  88320. * The data cache on JS side.
  88321. * @returns the underlying data as a float array
  88322. */
  88323. getData(): Float32Array;
  88324. /**
  88325. * The underlying WebGL Uniform buffer.
  88326. * @returns the webgl buffer
  88327. */
  88328. getBuffer(): Nullable<DataBuffer>;
  88329. /**
  88330. * std140 layout specifies how to align data within an UBO structure.
  88331. * See https://khronos.org/registry/OpenGL/specs/gl/glspec45.core.pdf#page=159
  88332. * for specs.
  88333. */
  88334. private _fillAlignment;
  88335. /**
  88336. * Adds an uniform in the buffer.
  88337. * Warning : the subsequents calls of this function must be in the same order as declared in the shader
  88338. * for the layout to be correct !
  88339. * @param name Name of the uniform, as used in the uniform block in the shader.
  88340. * @param size Data size, or data directly.
  88341. */
  88342. addUniform(name: string, size: number | number[]): void;
  88343. /**
  88344. * Adds a Matrix 4x4 to the uniform buffer.
  88345. * @param name Name of the uniform, as used in the uniform block in the shader.
  88346. * @param mat A 4x4 matrix.
  88347. */
  88348. addMatrix(name: string, mat: Matrix): void;
  88349. /**
  88350. * Adds a vec2 to the uniform buffer.
  88351. * @param name Name of the uniform, as used in the uniform block in the shader.
  88352. * @param x Define the x component value of the vec2
  88353. * @param y Define the y component value of the vec2
  88354. */
  88355. addFloat2(name: string, x: number, y: number): void;
  88356. /**
  88357. * Adds a vec3 to the uniform buffer.
  88358. * @param name Name of the uniform, as used in the uniform block in the shader.
  88359. * @param x Define the x component value of the vec3
  88360. * @param y Define the y component value of the vec3
  88361. * @param z Define the z component value of the vec3
  88362. */
  88363. addFloat3(name: string, x: number, y: number, z: number): void;
  88364. /**
  88365. * Adds a vec3 to the uniform buffer.
  88366. * @param name Name of the uniform, as used in the uniform block in the shader.
  88367. * @param color Define the vec3 from a Color
  88368. */
  88369. addColor3(name: string, color: Color3): void;
  88370. /**
  88371. * Adds a vec4 to the uniform buffer.
  88372. * @param name Name of the uniform, as used in the uniform block in the shader.
  88373. * @param color Define the rgb components from a Color
  88374. * @param alpha Define the a component of the vec4
  88375. */
  88376. addColor4(name: string, color: Color3, alpha: number): void;
  88377. /**
  88378. * Adds a vec3 to the uniform buffer.
  88379. * @param name Name of the uniform, as used in the uniform block in the shader.
  88380. * @param vector Define the vec3 components from a Vector
  88381. */
  88382. addVector3(name: string, vector: Vector3): void;
  88383. /**
  88384. * Adds a Matrix 3x3 to the uniform buffer.
  88385. * @param name Name of the uniform, as used in the uniform block in the shader.
  88386. */
  88387. addMatrix3x3(name: string): void;
  88388. /**
  88389. * Adds a Matrix 2x2 to the uniform buffer.
  88390. * @param name Name of the uniform, as used in the uniform block in the shader.
  88391. */
  88392. addMatrix2x2(name: string): void;
  88393. /**
  88394. * Effectively creates the WebGL Uniform Buffer, once layout is completed with `addUniform`.
  88395. */
  88396. create(): void;
  88397. /** @hidden */
  88398. _rebuild(): void;
  88399. /**
  88400. * Updates the WebGL Uniform Buffer on the GPU.
  88401. * If the `dynamic` flag is set to true, no cache comparison is done.
  88402. * Otherwise, the buffer will be updated only if the cache differs.
  88403. */
  88404. update(): void;
  88405. /**
  88406. * Updates the value of an uniform. The `update` method must be called afterwards to make it effective in the GPU.
  88407. * @param uniformName Define the name of the uniform, as used in the uniform block in the shader.
  88408. * @param data Define the flattened data
  88409. * @param size Define the size of the data.
  88410. */
  88411. updateUniform(uniformName: string, data: FloatArray, size: number): void;
  88412. private _valueCache;
  88413. private _cacheMatrix;
  88414. private _updateMatrix3x3ForUniform;
  88415. private _updateMatrix3x3ForEffect;
  88416. private _updateMatrix2x2ForEffect;
  88417. private _updateMatrix2x2ForUniform;
  88418. private _updateFloatForEffect;
  88419. private _updateFloatForUniform;
  88420. private _updateFloat2ForEffect;
  88421. private _updateFloat2ForUniform;
  88422. private _updateFloat3ForEffect;
  88423. private _updateFloat3ForUniform;
  88424. private _updateFloat4ForEffect;
  88425. private _updateFloat4ForUniform;
  88426. private _updateMatrixForEffect;
  88427. private _updateMatrixForUniform;
  88428. private _updateVector3ForEffect;
  88429. private _updateVector3ForUniform;
  88430. private _updateVector4ForEffect;
  88431. private _updateVector4ForUniform;
  88432. private _updateColor3ForEffect;
  88433. private _updateColor3ForUniform;
  88434. private _updateColor4ForEffect;
  88435. private _updateColor4ForUniform;
  88436. /**
  88437. * Sets a sampler uniform on the effect.
  88438. * @param name Define the name of the sampler.
  88439. * @param texture Define the texture to set in the sampler
  88440. */
  88441. setTexture(name: string, texture: Nullable<BaseTexture>): void;
  88442. /**
  88443. * Directly updates the value of the uniform in the cache AND on the GPU.
  88444. * @param uniformName Define the name of the uniform, as used in the uniform block in the shader.
  88445. * @param data Define the flattened data
  88446. */
  88447. updateUniformDirectly(uniformName: string, data: FloatArray): void;
  88448. /**
  88449. * Binds this uniform buffer to an effect.
  88450. * @param effect Define the effect to bind the buffer to
  88451. * @param name Name of the uniform block in the shader.
  88452. */
  88453. bindToEffect(effect: Effect, name: string): void;
  88454. /**
  88455. * Disposes the uniform buffer.
  88456. */
  88457. dispose(): void;
  88458. }
  88459. }
  88460. declare module BABYLON {
  88461. /**
  88462. * Enum that determines the text-wrapping mode to use.
  88463. */
  88464. export enum InspectableType {
  88465. /**
  88466. * Checkbox for booleans
  88467. */
  88468. Checkbox = 0,
  88469. /**
  88470. * Sliders for numbers
  88471. */
  88472. Slider = 1,
  88473. /**
  88474. * Vector3
  88475. */
  88476. Vector3 = 2,
  88477. /**
  88478. * Quaternions
  88479. */
  88480. Quaternion = 3,
  88481. /**
  88482. * Color3
  88483. */
  88484. Color3 = 4,
  88485. /**
  88486. * String
  88487. */
  88488. String = 5
  88489. }
  88490. /**
  88491. * Interface used to define custom inspectable properties.
  88492. * This interface is used by the inspector to display custom property grids
  88493. * @see https://doc.babylonjs.com/how_to/debug_layer#extensibility
  88494. */
  88495. export interface IInspectable {
  88496. /**
  88497. * Gets the label to display
  88498. */
  88499. label: string;
  88500. /**
  88501. * Gets the name of the property to edit
  88502. */
  88503. propertyName: string;
  88504. /**
  88505. * Gets the type of the editor to use
  88506. */
  88507. type: InspectableType;
  88508. /**
  88509. * Gets the minimum value of the property when using in "slider" mode
  88510. */
  88511. min?: number;
  88512. /**
  88513. * Gets the maximum value of the property when using in "slider" mode
  88514. */
  88515. max?: number;
  88516. /**
  88517. * Gets the setp to use when using in "slider" mode
  88518. */
  88519. step?: number;
  88520. }
  88521. }
  88522. declare module BABYLON {
  88523. /**
  88524. * Class used to provide helper for timing
  88525. */
  88526. export class TimingTools {
  88527. /**
  88528. * Polyfill for setImmediate
  88529. * @param action defines the action to execute after the current execution block
  88530. */
  88531. static SetImmediate(action: () => void): void;
  88532. }
  88533. }
  88534. declare module BABYLON {
  88535. /**
  88536. * Class used to enable instatition of objects by class name
  88537. */
  88538. export class InstantiationTools {
  88539. /**
  88540. * Use this object to register external classes like custom textures or material
  88541. * to allow the laoders to instantiate them
  88542. */
  88543. static RegisteredExternalClasses: {
  88544. [key: string]: Object;
  88545. };
  88546. /**
  88547. * Tries to instantiate a new object from a given class name
  88548. * @param className defines the class name to instantiate
  88549. * @returns the new object or null if the system was not able to do the instantiation
  88550. */
  88551. static Instantiate(className: string): any;
  88552. }
  88553. }
  88554. declare module BABYLON {
  88555. /**
  88556. * Define options used to create a depth texture
  88557. */
  88558. export class DepthTextureCreationOptions {
  88559. /** Specifies whether or not a stencil should be allocated in the texture */
  88560. generateStencil?: boolean;
  88561. /** Specifies whether or not bilinear filtering is enable on the texture */
  88562. bilinearFiltering?: boolean;
  88563. /** Specifies the comparison function to set on the texture. If 0 or undefined, the texture is not in comparison mode */
  88564. comparisonFunction?: number;
  88565. /** Specifies if the created texture is a cube texture */
  88566. isCube?: boolean;
  88567. }
  88568. }
  88569. declare module BABYLON {
  88570. interface ThinEngine {
  88571. /**
  88572. * Creates a depth stencil cube texture.
  88573. * This is only available in WebGL 2.
  88574. * @param size The size of face edge in the cube texture.
  88575. * @param options The options defining the cube texture.
  88576. * @returns The cube texture
  88577. */
  88578. _createDepthStencilCubeTexture(size: number, options: DepthTextureCreationOptions): InternalTexture;
  88579. /**
  88580. * Creates a cube texture
  88581. * @param rootUrl defines the url where the files to load is located
  88582. * @param scene defines the current scene
  88583. * @param files defines the list of files to load (1 per face)
  88584. * @param noMipmap defines a boolean indicating that no mipmaps shall be generated (false by default)
  88585. * @param onLoad defines an optional callback raised when the texture is loaded
  88586. * @param onError defines an optional callback raised if there is an issue to load the texture
  88587. * @param format defines the format of the data
  88588. * @param forcedExtension defines the extension to use to pick the right loader
  88589. * @param createPolynomials if a polynomial sphere should be created for the cube texture
  88590. * @param lodScale defines the scale applied to environment texture. This manages the range of LOD level used for IBL according to the roughness
  88591. * @param lodOffset defines the offset applied to environment texture. This manages first LOD level used for IBL according to the roughness
  88592. * @param fallback defines texture to use while falling back when (compressed) texture file not found.
  88593. * @returns the cube texture as an InternalTexture
  88594. */
  88595. 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;
  88596. /**
  88597. * Creates a cube texture
  88598. * @param rootUrl defines the url where the files to load is located
  88599. * @param scene defines the current scene
  88600. * @param files defines the list of files to load (1 per face)
  88601. * @param noMipmap defines a boolean indicating that no mipmaps shall be generated (false by default)
  88602. * @param onLoad defines an optional callback raised when the texture is loaded
  88603. * @param onError defines an optional callback raised if there is an issue to load the texture
  88604. * @param format defines the format of the data
  88605. * @param forcedExtension defines the extension to use to pick the right loader
  88606. * @returns the cube texture as an InternalTexture
  88607. */
  88608. 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;
  88609. /**
  88610. * Creates a cube texture
  88611. * @param rootUrl defines the url where the files to load is located
  88612. * @param scene defines the current scene
  88613. * @param files defines the list of files to load (1 per face)
  88614. * @param noMipmap defines a boolean indicating that no mipmaps shall be generated (false by default)
  88615. * @param onLoad defines an optional callback raised when the texture is loaded
  88616. * @param onError defines an optional callback raised if there is an issue to load the texture
  88617. * @param format defines the format of the data
  88618. * @param forcedExtension defines the extension to use to pick the right loader
  88619. * @param createPolynomials if a polynomial sphere should be created for the cube texture
  88620. * @param lodScale defines the scale applied to environment texture. This manages the range of LOD level used for IBL according to the roughness
  88621. * @param lodOffset defines the offset applied to environment texture. This manages first LOD level used for IBL according to the roughness
  88622. * @returns the cube texture as an InternalTexture
  88623. */
  88624. 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;
  88625. /** @hidden */
  88626. _partialLoadFile(url: string, index: number, loadedFiles: ArrayBuffer[], onfinish: (files: ArrayBuffer[]) => void, onErrorCallBack: Nullable<(message?: string, exception?: any) => void>): void;
  88627. /** @hidden */
  88628. _cascadeLoadFiles(scene: Nullable<Scene>, onfinish: (images: ArrayBuffer[]) => void, files: string[], onError: Nullable<(message?: string, exception?: any) => void>): void;
  88629. /** @hidden */
  88630. _cascadeLoadImgs(scene: Nullable<Scene>, onfinish: (images: HTMLImageElement[]) => void, files: string[], onError: Nullable<(message?: string, exception?: any) => void>, mimeType?: string): void;
  88631. /** @hidden */
  88632. _partialLoadImg(url: string, index: number, loadedImages: HTMLImageElement[], scene: Nullable<Scene>, onfinish: (images: HTMLImageElement[]) => void, onErrorCallBack: Nullable<(message?: string, exception?: any) => void>, mimeType?: string): void;
  88633. /**
  88634. * @hidden
  88635. */
  88636. _setCubeMapTextureParams(loadMipmap: boolean): void;
  88637. }
  88638. }
  88639. declare module BABYLON {
  88640. /**
  88641. * Class for creating a cube texture
  88642. */
  88643. export class CubeTexture extends BaseTexture {
  88644. private _delayedOnLoad;
  88645. /**
  88646. * Observable triggered once the texture has been loaded.
  88647. */
  88648. onLoadObservable: Observable<CubeTexture>;
  88649. /**
  88650. * The url of the texture
  88651. */
  88652. url: string;
  88653. /**
  88654. * Gets or sets the center of the bounding box associated with the cube texture.
  88655. * It must define where the camera used to render the texture was set
  88656. * @see https://doc.babylonjs.com/how_to/reflect#using-local-cubemap-mode
  88657. */
  88658. boundingBoxPosition: Vector3;
  88659. private _boundingBoxSize;
  88660. /**
  88661. * Gets or sets the size of the bounding box associated with the cube texture
  88662. * When defined, the cubemap will switch to local mode
  88663. * @see https://community.arm.com/graphics/b/blog/posts/reflections-based-on-local-cubemaps-in-unity
  88664. * @example https://www.babylonjs-playground.com/#RNASML
  88665. */
  88666. set boundingBoxSize(value: Vector3);
  88667. /**
  88668. * Returns the bounding box size
  88669. * @see https://doc.babylonjs.com/how_to/reflect#using-local-cubemap-mode
  88670. */
  88671. get boundingBoxSize(): Vector3;
  88672. protected _rotationY: number;
  88673. /**
  88674. * Sets texture matrix rotation angle around Y axis in radians.
  88675. */
  88676. set rotationY(value: number);
  88677. /**
  88678. * Gets texture matrix rotation angle around Y axis radians.
  88679. */
  88680. get rotationY(): number;
  88681. /**
  88682. * Are mip maps generated for this texture or not.
  88683. */
  88684. get noMipmap(): boolean;
  88685. private _noMipmap;
  88686. private _files;
  88687. protected _forcedExtension: Nullable<string>;
  88688. private _extensions;
  88689. private _textureMatrix;
  88690. private _format;
  88691. private _createPolynomials;
  88692. /**
  88693. * Creates a cube texture from an array of image urls
  88694. * @param files defines an array of image urls
  88695. * @param scene defines the hosting scene
  88696. * @param noMipmap specifies if mip maps are not used
  88697. * @returns a cube texture
  88698. */
  88699. static CreateFromImages(files: string[], scene: Scene, noMipmap?: boolean): CubeTexture;
  88700. /**
  88701. * Creates and return a texture created from prefilterd data by tools like IBL Baker or Lys.
  88702. * @param url defines the url of the prefiltered texture
  88703. * @param scene defines the scene the texture is attached to
  88704. * @param forcedExtension defines the extension of the file if different from the url
  88705. * @param createPolynomials defines whether or not to create polynomial harmonics from the texture data if necessary
  88706. * @return the prefiltered texture
  88707. */
  88708. static CreateFromPrefilteredData(url: string, scene: Scene, forcedExtension?: any, createPolynomials?: boolean): CubeTexture;
  88709. /**
  88710. * Creates a cube texture to use with reflection for instance. It can be based upon dds or six images as well
  88711. * as prefiltered data.
  88712. * @param rootUrl defines the url of the texture or the root name of the six images
  88713. * @param null defines the scene or engine the texture is attached to
  88714. * @param extensions defines the suffixes add to the picture name in case six images are in use like _px.jpg...
  88715. * @param noMipmap defines if mipmaps should be created or not
  88716. * @param files defines the six files to load for the different faces in that order: px, py, pz, nx, ny, nz
  88717. * @param onLoad defines a callback triggered at the end of the file load if no errors occured
  88718. * @param onError defines a callback triggered in case of error during load
  88719. * @param format defines the internal format to use for the texture once loaded
  88720. * @param prefiltered defines whether or not the texture is created from prefiltered data
  88721. * @param forcedExtension defines the extensions to use (force a special type of file to load) in case it is different from the file name
  88722. * @param createPolynomials defines whether or not to create polynomial harmonics from the texture data if necessary
  88723. * @param lodScale defines the scale applied to environment texture. This manages the range of LOD level used for IBL according to the roughness
  88724. * @param lodOffset defines the offset applied to environment texture. This manages first LOD level used for IBL according to the roughness
  88725. * @return the cube texture
  88726. */
  88727. 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);
  88728. /**
  88729. * Get the current class name of the texture useful for serialization or dynamic coding.
  88730. * @returns "CubeTexture"
  88731. */
  88732. getClassName(): string;
  88733. /**
  88734. * Update the url (and optional buffer) of this texture if url was null during construction.
  88735. * @param url the url of the texture
  88736. * @param forcedExtension defines the extension to use
  88737. * @param onLoad callback called when the texture is loaded (defaults to null)
  88738. * @param prefiltered Defines whether the updated texture is prefiltered or not
  88739. */
  88740. updateURL(url: string, forcedExtension?: string, onLoad?: () => void, prefiltered?: boolean): void;
  88741. /**
  88742. * Delays loading of the cube texture
  88743. * @param forcedExtension defines the extension to use
  88744. */
  88745. delayLoad(forcedExtension?: string): void;
  88746. /**
  88747. * Returns the reflection texture matrix
  88748. * @returns the reflection texture matrix
  88749. */
  88750. getReflectionTextureMatrix(): Matrix;
  88751. /**
  88752. * Sets the reflection texture matrix
  88753. * @param value Reflection texture matrix
  88754. */
  88755. setReflectionTextureMatrix(value: Matrix): void;
  88756. /**
  88757. * Parses text to create a cube texture
  88758. * @param parsedTexture define the serialized text to read from
  88759. * @param scene defines the hosting scene
  88760. * @param rootUrl defines the root url of the cube texture
  88761. * @returns a cube texture
  88762. */
  88763. static Parse(parsedTexture: any, scene: Scene, rootUrl: string): CubeTexture;
  88764. /**
  88765. * Makes a clone, or deep copy, of the cube texture
  88766. * @returns a new cube texture
  88767. */
  88768. clone(): CubeTexture;
  88769. }
  88770. }
  88771. declare module BABYLON {
  88772. /**
  88773. * Manages the defines for the Material
  88774. */
  88775. export class MaterialDefines {
  88776. /** @hidden */
  88777. protected _keys: string[];
  88778. private _isDirty;
  88779. /** @hidden */
  88780. _renderId: number;
  88781. /** @hidden */
  88782. _areLightsDirty: boolean;
  88783. /** @hidden */
  88784. _areLightsDisposed: boolean;
  88785. /** @hidden */
  88786. _areAttributesDirty: boolean;
  88787. /** @hidden */
  88788. _areTexturesDirty: boolean;
  88789. /** @hidden */
  88790. _areFresnelDirty: boolean;
  88791. /** @hidden */
  88792. _areMiscDirty: boolean;
  88793. /** @hidden */
  88794. _arePrePassDirty: boolean;
  88795. /** @hidden */
  88796. _areImageProcessingDirty: boolean;
  88797. /** @hidden */
  88798. _normals: boolean;
  88799. /** @hidden */
  88800. _uvs: boolean;
  88801. /** @hidden */
  88802. _needNormals: boolean;
  88803. /** @hidden */
  88804. _needUVs: boolean;
  88805. [id: string]: any;
  88806. /**
  88807. * Specifies if the material needs to be re-calculated
  88808. */
  88809. get isDirty(): boolean;
  88810. /**
  88811. * Marks the material to indicate that it has been re-calculated
  88812. */
  88813. markAsProcessed(): void;
  88814. /**
  88815. * Marks the material to indicate that it needs to be re-calculated
  88816. */
  88817. markAsUnprocessed(): void;
  88818. /**
  88819. * Marks the material to indicate all of its defines need to be re-calculated
  88820. */
  88821. markAllAsDirty(): void;
  88822. /**
  88823. * Marks the material to indicate that image processing needs to be re-calculated
  88824. */
  88825. markAsImageProcessingDirty(): void;
  88826. /**
  88827. * Marks the material to indicate the lights need to be re-calculated
  88828. * @param disposed Defines whether the light is dirty due to dispose or not
  88829. */
  88830. markAsLightDirty(disposed?: boolean): void;
  88831. /**
  88832. * Marks the attribute state as changed
  88833. */
  88834. markAsAttributesDirty(): void;
  88835. /**
  88836. * Marks the texture state as changed
  88837. */
  88838. markAsTexturesDirty(): void;
  88839. /**
  88840. * Marks the fresnel state as changed
  88841. */
  88842. markAsFresnelDirty(): void;
  88843. /**
  88844. * Marks the misc state as changed
  88845. */
  88846. markAsMiscDirty(): void;
  88847. /**
  88848. * Marks the prepass state as changed
  88849. */
  88850. markAsPrePassDirty(): void;
  88851. /**
  88852. * Rebuilds the material defines
  88853. */
  88854. rebuild(): void;
  88855. /**
  88856. * Specifies if two material defines are equal
  88857. * @param other - A material define instance to compare to
  88858. * @returns - Boolean indicating if the material defines are equal (true) or not (false)
  88859. */
  88860. isEqual(other: MaterialDefines): boolean;
  88861. /**
  88862. * Clones this instance's defines to another instance
  88863. * @param other - material defines to clone values to
  88864. */
  88865. cloneTo(other: MaterialDefines): void;
  88866. /**
  88867. * Resets the material define values
  88868. */
  88869. reset(): void;
  88870. /**
  88871. * Converts the material define values to a string
  88872. * @returns - String of material define information
  88873. */
  88874. toString(): string;
  88875. }
  88876. }
  88877. declare module BABYLON {
  88878. /**
  88879. * The color grading curves provide additional color adjustmnent that is applied after any color grading transform (3D LUT).
  88880. * They allow basic adjustment of saturation and small exposure adjustments, along with color filter tinting to provide white balance adjustment or more stylistic effects.
  88881. * 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;
  88882. * corresponding to low luminance, medium luminance, and high luminance areas respectively.
  88883. */
  88884. export class ColorCurves {
  88885. private _dirty;
  88886. private _tempColor;
  88887. private _globalCurve;
  88888. private _highlightsCurve;
  88889. private _midtonesCurve;
  88890. private _shadowsCurve;
  88891. private _positiveCurve;
  88892. private _negativeCurve;
  88893. private _globalHue;
  88894. private _globalDensity;
  88895. private _globalSaturation;
  88896. private _globalExposure;
  88897. /**
  88898. * Gets the global Hue value.
  88899. * 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).
  88900. */
  88901. get globalHue(): number;
  88902. /**
  88903. * Sets the global Hue value.
  88904. * 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).
  88905. */
  88906. set globalHue(value: number);
  88907. /**
  88908. * Gets the global Density value.
  88909. * 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.
  88910. * Values less than zero provide a filter of opposite hue.
  88911. */
  88912. get globalDensity(): number;
  88913. /**
  88914. * Sets the global Density value.
  88915. * 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.
  88916. * Values less than zero provide a filter of opposite hue.
  88917. */
  88918. set globalDensity(value: number);
  88919. /**
  88920. * Gets the global Saturation value.
  88921. * 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.
  88922. */
  88923. get globalSaturation(): number;
  88924. /**
  88925. * Sets the global Saturation value.
  88926. * 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.
  88927. */
  88928. set globalSaturation(value: number);
  88929. /**
  88930. * Gets the global Exposure value.
  88931. * 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.
  88932. */
  88933. get globalExposure(): number;
  88934. /**
  88935. * Sets the global Exposure value.
  88936. * 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.
  88937. */
  88938. set globalExposure(value: number);
  88939. private _highlightsHue;
  88940. private _highlightsDensity;
  88941. private _highlightsSaturation;
  88942. private _highlightsExposure;
  88943. /**
  88944. * Gets the highlights Hue value.
  88945. * 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).
  88946. */
  88947. get highlightsHue(): number;
  88948. /**
  88949. * Sets the highlights Hue value.
  88950. * 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).
  88951. */
  88952. set highlightsHue(value: number);
  88953. /**
  88954. * Gets the highlights Density value.
  88955. * 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.
  88956. * Values less than zero provide a filter of opposite hue.
  88957. */
  88958. get highlightsDensity(): number;
  88959. /**
  88960. * Sets the highlights Density value.
  88961. * 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.
  88962. * Values less than zero provide a filter of opposite hue.
  88963. */
  88964. set highlightsDensity(value: number);
  88965. /**
  88966. * Gets the highlights Saturation value.
  88967. * 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.
  88968. */
  88969. get highlightsSaturation(): number;
  88970. /**
  88971. * Sets the highlights Saturation value.
  88972. * 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.
  88973. */
  88974. set highlightsSaturation(value: number);
  88975. /**
  88976. * Gets the highlights Exposure value.
  88977. * 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.
  88978. */
  88979. get highlightsExposure(): number;
  88980. /**
  88981. * Sets the highlights Exposure value.
  88982. * 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.
  88983. */
  88984. set highlightsExposure(value: number);
  88985. private _midtonesHue;
  88986. private _midtonesDensity;
  88987. private _midtonesSaturation;
  88988. private _midtonesExposure;
  88989. /**
  88990. * Gets the midtones Hue value.
  88991. * 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).
  88992. */
  88993. get midtonesHue(): number;
  88994. /**
  88995. * Sets the midtones Hue value.
  88996. * 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).
  88997. */
  88998. set midtonesHue(value: number);
  88999. /**
  89000. * Gets the midtones Density value.
  89001. * 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.
  89002. * Values less than zero provide a filter of opposite hue.
  89003. */
  89004. get midtonesDensity(): number;
  89005. /**
  89006. * Sets the midtones Density value.
  89007. * 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.
  89008. * Values less than zero provide a filter of opposite hue.
  89009. */
  89010. set midtonesDensity(value: number);
  89011. /**
  89012. * Gets the midtones Saturation value.
  89013. * 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.
  89014. */
  89015. get midtonesSaturation(): number;
  89016. /**
  89017. * Sets the midtones Saturation value.
  89018. * 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.
  89019. */
  89020. set midtonesSaturation(value: number);
  89021. /**
  89022. * Gets the midtones Exposure value.
  89023. * 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.
  89024. */
  89025. get midtonesExposure(): number;
  89026. /**
  89027. * Sets the midtones Exposure value.
  89028. * 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.
  89029. */
  89030. set midtonesExposure(value: number);
  89031. private _shadowsHue;
  89032. private _shadowsDensity;
  89033. private _shadowsSaturation;
  89034. private _shadowsExposure;
  89035. /**
  89036. * Gets the shadows Hue value.
  89037. * 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).
  89038. */
  89039. get shadowsHue(): number;
  89040. /**
  89041. * Sets the shadows Hue value.
  89042. * 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).
  89043. */
  89044. set shadowsHue(value: number);
  89045. /**
  89046. * Gets the shadows Density value.
  89047. * 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.
  89048. * Values less than zero provide a filter of opposite hue.
  89049. */
  89050. get shadowsDensity(): number;
  89051. /**
  89052. * Sets the shadows Density value.
  89053. * 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.
  89054. * Values less than zero provide a filter of opposite hue.
  89055. */
  89056. set shadowsDensity(value: number);
  89057. /**
  89058. * Gets the shadows Saturation value.
  89059. * 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.
  89060. */
  89061. get shadowsSaturation(): number;
  89062. /**
  89063. * Sets the shadows Saturation value.
  89064. * 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.
  89065. */
  89066. set shadowsSaturation(value: number);
  89067. /**
  89068. * Gets the shadows Exposure value.
  89069. * 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.
  89070. */
  89071. get shadowsExposure(): number;
  89072. /**
  89073. * Sets the shadows Exposure value.
  89074. * 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.
  89075. */
  89076. set shadowsExposure(value: number);
  89077. /**
  89078. * Returns the class name
  89079. * @returns The class name
  89080. */
  89081. getClassName(): string;
  89082. /**
  89083. * Binds the color curves to the shader.
  89084. * @param colorCurves The color curve to bind
  89085. * @param effect The effect to bind to
  89086. * @param positiveUniform The positive uniform shader parameter
  89087. * @param neutralUniform The neutral uniform shader parameter
  89088. * @param negativeUniform The negative uniform shader parameter
  89089. */
  89090. static Bind(colorCurves: ColorCurves, effect: Effect, positiveUniform?: string, neutralUniform?: string, negativeUniform?: string): void;
  89091. /**
  89092. * Prepare the list of uniforms associated with the ColorCurves effects.
  89093. * @param uniformsList The list of uniforms used in the effect
  89094. */
  89095. static PrepareUniforms(uniformsList: string[]): void;
  89096. /**
  89097. * Returns color grading data based on a hue, density, saturation and exposure value.
  89098. * @param filterHue The hue of the color filter.
  89099. * @param filterDensity The density of the color filter.
  89100. * @param saturation The saturation.
  89101. * @param exposure The exposure.
  89102. * @param result The result data container.
  89103. */
  89104. private getColorGradingDataToRef;
  89105. /**
  89106. * Takes an input slider value and returns an adjusted value that provides extra control near the centre.
  89107. * @param value The input slider value in range [-100,100].
  89108. * @returns Adjusted value.
  89109. */
  89110. private static applyColorGradingSliderNonlinear;
  89111. /**
  89112. * Returns an RGBA Color4 based on Hue, Saturation and Brightness (also referred to as value, HSV).
  89113. * @param hue The hue (H) input.
  89114. * @param saturation The saturation (S) input.
  89115. * @param brightness The brightness (B) input.
  89116. * @result An RGBA color represented as Vector4.
  89117. */
  89118. private static fromHSBToRef;
  89119. /**
  89120. * Returns a value clamped between min and max
  89121. * @param value The value to clamp
  89122. * @param min The minimum of value
  89123. * @param max The maximum of value
  89124. * @returns The clamped value.
  89125. */
  89126. private static clamp;
  89127. /**
  89128. * Clones the current color curve instance.
  89129. * @return The cloned curves
  89130. */
  89131. clone(): ColorCurves;
  89132. /**
  89133. * Serializes the current color curve instance to a json representation.
  89134. * @return a JSON representation
  89135. */
  89136. serialize(): any;
  89137. /**
  89138. * Parses the color curve from a json representation.
  89139. * @param source the JSON source to parse
  89140. * @return The parsed curves
  89141. */
  89142. static Parse(source: any): ColorCurves;
  89143. }
  89144. }
  89145. declare module BABYLON {
  89146. /**
  89147. * Interface to follow in your material defines to integrate easily the
  89148. * Image proccessing functions.
  89149. * @hidden
  89150. */
  89151. export interface IImageProcessingConfigurationDefines {
  89152. IMAGEPROCESSING: boolean;
  89153. VIGNETTE: boolean;
  89154. VIGNETTEBLENDMODEMULTIPLY: boolean;
  89155. VIGNETTEBLENDMODEOPAQUE: boolean;
  89156. TONEMAPPING: boolean;
  89157. TONEMAPPING_ACES: boolean;
  89158. CONTRAST: boolean;
  89159. EXPOSURE: boolean;
  89160. COLORCURVES: boolean;
  89161. COLORGRADING: boolean;
  89162. COLORGRADING3D: boolean;
  89163. SAMPLER3DGREENDEPTH: boolean;
  89164. SAMPLER3DBGRMAP: boolean;
  89165. IMAGEPROCESSINGPOSTPROCESS: boolean;
  89166. }
  89167. /**
  89168. * @hidden
  89169. */
  89170. export class ImageProcessingConfigurationDefines extends MaterialDefines implements IImageProcessingConfigurationDefines {
  89171. IMAGEPROCESSING: boolean;
  89172. VIGNETTE: boolean;
  89173. VIGNETTEBLENDMODEMULTIPLY: boolean;
  89174. VIGNETTEBLENDMODEOPAQUE: boolean;
  89175. TONEMAPPING: boolean;
  89176. TONEMAPPING_ACES: boolean;
  89177. CONTRAST: boolean;
  89178. COLORCURVES: boolean;
  89179. COLORGRADING: boolean;
  89180. COLORGRADING3D: boolean;
  89181. SAMPLER3DGREENDEPTH: boolean;
  89182. SAMPLER3DBGRMAP: boolean;
  89183. IMAGEPROCESSINGPOSTPROCESS: boolean;
  89184. EXPOSURE: boolean;
  89185. constructor();
  89186. }
  89187. /**
  89188. * This groups together the common properties used for image processing either in direct forward pass
  89189. * or through post processing effect depending on the use of the image processing pipeline in your scene
  89190. * or not.
  89191. */
  89192. export class ImageProcessingConfiguration {
  89193. /**
  89194. * Default tone mapping applied in BabylonJS.
  89195. */
  89196. static readonly TONEMAPPING_STANDARD: number;
  89197. /**
  89198. * ACES Tone mapping (used by default in unreal and unity). This can help getting closer
  89199. * to other engines rendering to increase portability.
  89200. */
  89201. static readonly TONEMAPPING_ACES: number;
  89202. /**
  89203. * Color curves setup used in the effect if colorCurvesEnabled is set to true
  89204. */
  89205. colorCurves: Nullable<ColorCurves>;
  89206. private _colorCurvesEnabled;
  89207. /**
  89208. * Gets wether the color curves effect is enabled.
  89209. */
  89210. get colorCurvesEnabled(): boolean;
  89211. /**
  89212. * Sets wether the color curves effect is enabled.
  89213. */
  89214. set colorCurvesEnabled(value: boolean);
  89215. private _colorGradingTexture;
  89216. /**
  89217. * Color grading LUT texture used in the effect if colorGradingEnabled is set to true
  89218. */
  89219. get colorGradingTexture(): Nullable<BaseTexture>;
  89220. /**
  89221. * Color grading LUT texture used in the effect if colorGradingEnabled is set to true
  89222. */
  89223. set colorGradingTexture(value: Nullable<BaseTexture>);
  89224. private _colorGradingEnabled;
  89225. /**
  89226. * Gets wether the color grading effect is enabled.
  89227. */
  89228. get colorGradingEnabled(): boolean;
  89229. /**
  89230. * Sets wether the color grading effect is enabled.
  89231. */
  89232. set colorGradingEnabled(value: boolean);
  89233. private _colorGradingWithGreenDepth;
  89234. /**
  89235. * Gets wether the color grading effect is using a green depth for the 3d Texture.
  89236. */
  89237. get colorGradingWithGreenDepth(): boolean;
  89238. /**
  89239. * Sets wether the color grading effect is using a green depth for the 3d Texture.
  89240. */
  89241. set colorGradingWithGreenDepth(value: boolean);
  89242. private _colorGradingBGR;
  89243. /**
  89244. * Gets wether the color grading texture contains BGR values.
  89245. */
  89246. get colorGradingBGR(): boolean;
  89247. /**
  89248. * Sets wether the color grading texture contains BGR values.
  89249. */
  89250. set colorGradingBGR(value: boolean);
  89251. /** @hidden */
  89252. _exposure: number;
  89253. /**
  89254. * Gets the Exposure used in the effect.
  89255. */
  89256. get exposure(): number;
  89257. /**
  89258. * Sets the Exposure used in the effect.
  89259. */
  89260. set exposure(value: number);
  89261. private _toneMappingEnabled;
  89262. /**
  89263. * Gets wether the tone mapping effect is enabled.
  89264. */
  89265. get toneMappingEnabled(): boolean;
  89266. /**
  89267. * Sets wether the tone mapping effect is enabled.
  89268. */
  89269. set toneMappingEnabled(value: boolean);
  89270. private _toneMappingType;
  89271. /**
  89272. * Gets the type of tone mapping effect.
  89273. */
  89274. get toneMappingType(): number;
  89275. /**
  89276. * Sets the type of tone mapping effect used in BabylonJS.
  89277. */
  89278. set toneMappingType(value: number);
  89279. protected _contrast: number;
  89280. /**
  89281. * Gets the contrast used in the effect.
  89282. */
  89283. get contrast(): number;
  89284. /**
  89285. * Sets the contrast used in the effect.
  89286. */
  89287. set contrast(value: number);
  89288. /**
  89289. * Vignette stretch size.
  89290. */
  89291. vignetteStretch: number;
  89292. /**
  89293. * Vignette centre X Offset.
  89294. */
  89295. vignetteCentreX: number;
  89296. /**
  89297. * Vignette centre Y Offset.
  89298. */
  89299. vignetteCentreY: number;
  89300. /**
  89301. * Vignette weight or intensity of the vignette effect.
  89302. */
  89303. vignetteWeight: number;
  89304. /**
  89305. * Color of the vignette applied on the screen through the chosen blend mode (vignetteBlendMode)
  89306. * if vignetteEnabled is set to true.
  89307. */
  89308. vignetteColor: Color4;
  89309. /**
  89310. * Camera field of view used by the Vignette effect.
  89311. */
  89312. vignetteCameraFov: number;
  89313. private _vignetteBlendMode;
  89314. /**
  89315. * Gets the vignette blend mode allowing different kind of effect.
  89316. */
  89317. get vignetteBlendMode(): number;
  89318. /**
  89319. * Sets the vignette blend mode allowing different kind of effect.
  89320. */
  89321. set vignetteBlendMode(value: number);
  89322. private _vignetteEnabled;
  89323. /**
  89324. * Gets wether the vignette effect is enabled.
  89325. */
  89326. get vignetteEnabled(): boolean;
  89327. /**
  89328. * Sets wether the vignette effect is enabled.
  89329. */
  89330. set vignetteEnabled(value: boolean);
  89331. private _applyByPostProcess;
  89332. /**
  89333. * Gets wether the image processing is applied through a post process or not.
  89334. */
  89335. get applyByPostProcess(): boolean;
  89336. /**
  89337. * Sets wether the image processing is applied through a post process or not.
  89338. */
  89339. set applyByPostProcess(value: boolean);
  89340. private _isEnabled;
  89341. /**
  89342. * Gets wether the image processing is enabled or not.
  89343. */
  89344. get isEnabled(): boolean;
  89345. /**
  89346. * Sets wether the image processing is enabled or not.
  89347. */
  89348. set isEnabled(value: boolean);
  89349. /**
  89350. * An event triggered when the configuration changes and requires Shader to Update some parameters.
  89351. */
  89352. onUpdateParameters: Observable<ImageProcessingConfiguration>;
  89353. /**
  89354. * Method called each time the image processing information changes requires to recompile the effect.
  89355. */
  89356. protected _updateParameters(): void;
  89357. /**
  89358. * Gets the current class name.
  89359. * @return "ImageProcessingConfiguration"
  89360. */
  89361. getClassName(): string;
  89362. /**
  89363. * Prepare the list of uniforms associated with the Image Processing effects.
  89364. * @param uniforms The list of uniforms used in the effect
  89365. * @param defines the list of defines currently in use
  89366. */
  89367. static PrepareUniforms(uniforms: string[], defines: IImageProcessingConfigurationDefines): void;
  89368. /**
  89369. * Prepare the list of samplers associated with the Image Processing effects.
  89370. * @param samplersList The list of uniforms used in the effect
  89371. * @param defines the list of defines currently in use
  89372. */
  89373. static PrepareSamplers(samplersList: string[], defines: IImageProcessingConfigurationDefines): void;
  89374. /**
  89375. * Prepare the list of defines associated to the shader.
  89376. * @param defines the list of defines to complete
  89377. * @param forPostProcess Define if we are currently in post process mode or not
  89378. */
  89379. prepareDefines(defines: IImageProcessingConfigurationDefines, forPostProcess?: boolean): void;
  89380. /**
  89381. * Returns true if all the image processing information are ready.
  89382. * @returns True if ready, otherwise, false
  89383. */
  89384. isReady(): boolean;
  89385. /**
  89386. * Binds the image processing to the shader.
  89387. * @param effect The effect to bind to
  89388. * @param overrideAspectRatio Override the aspect ratio of the effect
  89389. */
  89390. bind(effect: Effect, overrideAspectRatio?: number): void;
  89391. /**
  89392. * Clones the current image processing instance.
  89393. * @return The cloned image processing
  89394. */
  89395. clone(): ImageProcessingConfiguration;
  89396. /**
  89397. * Serializes the current image processing instance to a json representation.
  89398. * @return a JSON representation
  89399. */
  89400. serialize(): any;
  89401. /**
  89402. * Parses the image processing from a json representation.
  89403. * @param source the JSON source to parse
  89404. * @return The parsed image processing
  89405. */
  89406. static Parse(source: any): ImageProcessingConfiguration;
  89407. private static _VIGNETTEMODE_MULTIPLY;
  89408. private static _VIGNETTEMODE_OPAQUE;
  89409. /**
  89410. * Used to apply the vignette as a mix with the pixel color.
  89411. */
  89412. static get VIGNETTEMODE_MULTIPLY(): number;
  89413. /**
  89414. * Used to apply the vignette as a replacement of the pixel color.
  89415. */
  89416. static get VIGNETTEMODE_OPAQUE(): number;
  89417. }
  89418. }
  89419. declare module BABYLON {
  89420. /** @hidden */
  89421. export var postprocessVertexShader: {
  89422. name: string;
  89423. shader: string;
  89424. };
  89425. }
  89426. declare module BABYLON {
  89427. /**
  89428. * Type used to define a render target texture size (either with a number or with a rect width and height)
  89429. */
  89430. export type RenderTargetTextureSize = number | {
  89431. width: number;
  89432. height: number;
  89433. layers?: number;
  89434. };
  89435. interface ThinEngine {
  89436. /**
  89437. * Creates a new render target texture
  89438. * @param size defines the size of the texture
  89439. * @param options defines the options used to create the texture
  89440. * @returns a new render target texture stored in an InternalTexture
  89441. */
  89442. createRenderTargetTexture(size: RenderTargetTextureSize, options: boolean | RenderTargetCreationOptions): InternalTexture;
  89443. /**
  89444. * Creates a depth stencil texture.
  89445. * This is only available in WebGL 2 or with the depth texture extension available.
  89446. * @param size The size of face edge in the texture.
  89447. * @param options The options defining the texture.
  89448. * @returns The texture
  89449. */
  89450. createDepthStencilTexture(size: RenderTargetTextureSize, options: DepthTextureCreationOptions): InternalTexture;
  89451. /** @hidden */
  89452. _createDepthStencilTexture(size: RenderTargetTextureSize, options: DepthTextureCreationOptions): InternalTexture;
  89453. }
  89454. }
  89455. declare module BABYLON {
  89456. /**
  89457. * Defines the kind of connection point for node based material
  89458. */
  89459. export enum NodeMaterialBlockConnectionPointTypes {
  89460. /** Float */
  89461. Float = 1,
  89462. /** Int */
  89463. Int = 2,
  89464. /** Vector2 */
  89465. Vector2 = 4,
  89466. /** Vector3 */
  89467. Vector3 = 8,
  89468. /** Vector4 */
  89469. Vector4 = 16,
  89470. /** Color3 */
  89471. Color3 = 32,
  89472. /** Color4 */
  89473. Color4 = 64,
  89474. /** Matrix */
  89475. Matrix = 128,
  89476. /** Custom object */
  89477. Object = 256,
  89478. /** Detect type based on connection */
  89479. AutoDetect = 1024,
  89480. /** Output type that will be defined by input type */
  89481. BasedOnInput = 2048
  89482. }
  89483. }
  89484. declare module BABYLON {
  89485. /**
  89486. * Enum used to define the target of a block
  89487. */
  89488. export enum NodeMaterialBlockTargets {
  89489. /** Vertex shader */
  89490. Vertex = 1,
  89491. /** Fragment shader */
  89492. Fragment = 2,
  89493. /** Neutral */
  89494. Neutral = 4,
  89495. /** Vertex and Fragment */
  89496. VertexAndFragment = 3
  89497. }
  89498. }
  89499. declare module BABYLON {
  89500. /**
  89501. * Enum defining the mode of a NodeMaterialBlockConnectionPoint
  89502. */
  89503. export enum NodeMaterialBlockConnectionPointMode {
  89504. /** Value is an uniform */
  89505. Uniform = 0,
  89506. /** Value is a mesh attribute */
  89507. Attribute = 1,
  89508. /** Value is a varying between vertex and fragment shaders */
  89509. Varying = 2,
  89510. /** Mode is undefined */
  89511. Undefined = 3
  89512. }
  89513. }
  89514. declare module BABYLON {
  89515. /**
  89516. * Enum used to define system values e.g. values automatically provided by the system
  89517. */
  89518. export enum NodeMaterialSystemValues {
  89519. /** World */
  89520. World = 1,
  89521. /** View */
  89522. View = 2,
  89523. /** Projection */
  89524. Projection = 3,
  89525. /** ViewProjection */
  89526. ViewProjection = 4,
  89527. /** WorldView */
  89528. WorldView = 5,
  89529. /** WorldViewProjection */
  89530. WorldViewProjection = 6,
  89531. /** CameraPosition */
  89532. CameraPosition = 7,
  89533. /** Fog Color */
  89534. FogColor = 8,
  89535. /** Delta time */
  89536. DeltaTime = 9
  89537. }
  89538. }
  89539. declare module BABYLON {
  89540. /** Defines supported spaces */
  89541. export enum Space {
  89542. /** Local (object) space */
  89543. LOCAL = 0,
  89544. /** World space */
  89545. WORLD = 1,
  89546. /** Bone space */
  89547. BONE = 2
  89548. }
  89549. /** Defines the 3 main axes */
  89550. export class Axis {
  89551. /** X axis */
  89552. static X: Vector3;
  89553. /** Y axis */
  89554. static Y: Vector3;
  89555. /** Z axis */
  89556. static Z: Vector3;
  89557. }
  89558. }
  89559. declare module BABYLON {
  89560. /**
  89561. * Represents a camera frustum
  89562. */
  89563. export class Frustum {
  89564. /**
  89565. * Gets the planes representing the frustum
  89566. * @param transform matrix to be applied to the returned planes
  89567. * @returns a new array of 6 Frustum planes computed by the given transformation matrix.
  89568. */
  89569. static GetPlanes(transform: DeepImmutable<Matrix>): Plane[];
  89570. /**
  89571. * Gets the near frustum plane transformed by the transform matrix
  89572. * @param transform transformation matrix to be applied to the resulting frustum plane
  89573. * @param frustumPlane the resuling frustum plane
  89574. */
  89575. static GetNearPlaneToRef(transform: DeepImmutable<Matrix>, frustumPlane: Plane): void;
  89576. /**
  89577. * Gets the far frustum plane transformed by the transform matrix
  89578. * @param transform transformation matrix to be applied to the resulting frustum plane
  89579. * @param frustumPlane the resuling frustum plane
  89580. */
  89581. static GetFarPlaneToRef(transform: DeepImmutable<Matrix>, frustumPlane: Plane): void;
  89582. /**
  89583. * Gets the left frustum plane transformed by the transform matrix
  89584. * @param transform transformation matrix to be applied to the resulting frustum plane
  89585. * @param frustumPlane the resuling frustum plane
  89586. */
  89587. static GetLeftPlaneToRef(transform: DeepImmutable<Matrix>, frustumPlane: Plane): void;
  89588. /**
  89589. * Gets the right frustum plane transformed by the transform matrix
  89590. * @param transform transformation matrix to be applied to the resulting frustum plane
  89591. * @param frustumPlane the resuling frustum plane
  89592. */
  89593. static GetRightPlaneToRef(transform: DeepImmutable<Matrix>, frustumPlane: Plane): void;
  89594. /**
  89595. * Gets the top frustum plane transformed by the transform matrix
  89596. * @param transform transformation matrix to be applied to the resulting frustum plane
  89597. * @param frustumPlane the resuling frustum plane
  89598. */
  89599. static GetTopPlaneToRef(transform: DeepImmutable<Matrix>, frustumPlane: Plane): void;
  89600. /**
  89601. * Gets the bottom frustum plane transformed by the transform matrix
  89602. * @param transform transformation matrix to be applied to the resulting frustum plane
  89603. * @param frustumPlane the resuling frustum plane
  89604. */
  89605. static GetBottomPlaneToRef(transform: DeepImmutable<Matrix>, frustumPlane: Plane): void;
  89606. /**
  89607. * Sets the given array "frustumPlanes" with the 6 Frustum planes computed by the given transformation matrix.
  89608. * @param transform transformation matrix to be applied to the resulting frustum planes
  89609. * @param frustumPlanes the resuling frustum planes
  89610. */
  89611. static GetPlanesToRef(transform: DeepImmutable<Matrix>, frustumPlanes: Plane[]): void;
  89612. }
  89613. }
  89614. declare module BABYLON {
  89615. /**
  89616. * Interface for the size containing width and height
  89617. */
  89618. export interface ISize {
  89619. /**
  89620. * Width
  89621. */
  89622. width: number;
  89623. /**
  89624. * Heighht
  89625. */
  89626. height: number;
  89627. }
  89628. /**
  89629. * Size containing widht and height
  89630. */
  89631. export class Size implements ISize {
  89632. /**
  89633. * Width
  89634. */
  89635. width: number;
  89636. /**
  89637. * Height
  89638. */
  89639. height: number;
  89640. /**
  89641. * Creates a Size object from the given width and height (floats).
  89642. * @param width width of the new size
  89643. * @param height height of the new size
  89644. */
  89645. constructor(width: number, height: number);
  89646. /**
  89647. * Returns a string with the Size width and height
  89648. * @returns a string with the Size width and height
  89649. */
  89650. toString(): string;
  89651. /**
  89652. * "Size"
  89653. * @returns the string "Size"
  89654. */
  89655. getClassName(): string;
  89656. /**
  89657. * Returns the Size hash code.
  89658. * @returns a hash code for a unique width and height
  89659. */
  89660. getHashCode(): number;
  89661. /**
  89662. * Updates the current size from the given one.
  89663. * @param src the given size
  89664. */
  89665. copyFrom(src: Size): void;
  89666. /**
  89667. * Updates in place the current Size from the given floats.
  89668. * @param width width of the new size
  89669. * @param height height of the new size
  89670. * @returns the updated Size.
  89671. */
  89672. copyFromFloats(width: number, height: number): Size;
  89673. /**
  89674. * Updates in place the current Size from the given floats.
  89675. * @param width width to set
  89676. * @param height height to set
  89677. * @returns the updated Size.
  89678. */
  89679. set(width: number, height: number): Size;
  89680. /**
  89681. * Multiplies the width and height by numbers
  89682. * @param w factor to multiple the width by
  89683. * @param h factor to multiple the height by
  89684. * @returns a new Size set with the multiplication result of the current Size and the given floats.
  89685. */
  89686. multiplyByFloats(w: number, h: number): Size;
  89687. /**
  89688. * Clones the size
  89689. * @returns a new Size copied from the given one.
  89690. */
  89691. clone(): Size;
  89692. /**
  89693. * True if the current Size and the given one width and height are strictly equal.
  89694. * @param other the other size to compare against
  89695. * @returns True if the current Size and the given one width and height are strictly equal.
  89696. */
  89697. equals(other: Size): boolean;
  89698. /**
  89699. * The surface of the Size : width * height (float).
  89700. */
  89701. get surface(): number;
  89702. /**
  89703. * Create a new size of zero
  89704. * @returns a new Size set to (0.0, 0.0)
  89705. */
  89706. static Zero(): Size;
  89707. /**
  89708. * Sums the width and height of two sizes
  89709. * @param otherSize size to add to this size
  89710. * @returns a new Size set as the addition result of the current Size and the given one.
  89711. */
  89712. add(otherSize: Size): Size;
  89713. /**
  89714. * Subtracts the width and height of two
  89715. * @param otherSize size to subtract to this size
  89716. * @returns a new Size set as the subtraction result of the given one from the current Size.
  89717. */
  89718. subtract(otherSize: Size): Size;
  89719. /**
  89720. * Creates a new Size set at the linear interpolation "amount" between "start" and "end"
  89721. * @param start starting size to lerp between
  89722. * @param end end size to lerp between
  89723. * @param amount amount to lerp between the start and end values
  89724. * @returns a new Size set at the linear interpolation "amount" between "start" and "end"
  89725. */
  89726. static Lerp(start: Size, end: Size, amount: number): Size;
  89727. }
  89728. }
  89729. declare module BABYLON {
  89730. /**
  89731. * Contains position and normal vectors for a vertex
  89732. */
  89733. export class PositionNormalVertex {
  89734. /** the position of the vertex (defaut: 0,0,0) */
  89735. position: Vector3;
  89736. /** the normal of the vertex (defaut: 0,1,0) */
  89737. normal: Vector3;
  89738. /**
  89739. * Creates a PositionNormalVertex
  89740. * @param position the position of the vertex (defaut: 0,0,0)
  89741. * @param normal the normal of the vertex (defaut: 0,1,0)
  89742. */
  89743. constructor(
  89744. /** the position of the vertex (defaut: 0,0,0) */
  89745. position?: Vector3,
  89746. /** the normal of the vertex (defaut: 0,1,0) */
  89747. normal?: Vector3);
  89748. /**
  89749. * Clones the PositionNormalVertex
  89750. * @returns the cloned PositionNormalVertex
  89751. */
  89752. clone(): PositionNormalVertex;
  89753. }
  89754. /**
  89755. * Contains position, normal and uv vectors for a vertex
  89756. */
  89757. export class PositionNormalTextureVertex {
  89758. /** the position of the vertex (defaut: 0,0,0) */
  89759. position: Vector3;
  89760. /** the normal of the vertex (defaut: 0,1,0) */
  89761. normal: Vector3;
  89762. /** the uv of the vertex (default: 0,0) */
  89763. uv: Vector2;
  89764. /**
  89765. * Creates a PositionNormalTextureVertex
  89766. * @param position the position of the vertex (defaut: 0,0,0)
  89767. * @param normal the normal of the vertex (defaut: 0,1,0)
  89768. * @param uv the uv of the vertex (default: 0,0)
  89769. */
  89770. constructor(
  89771. /** the position of the vertex (defaut: 0,0,0) */
  89772. position?: Vector3,
  89773. /** the normal of the vertex (defaut: 0,1,0) */
  89774. normal?: Vector3,
  89775. /** the uv of the vertex (default: 0,0) */
  89776. uv?: Vector2);
  89777. /**
  89778. * Clones the PositionNormalTextureVertex
  89779. * @returns the cloned PositionNormalTextureVertex
  89780. */
  89781. clone(): PositionNormalTextureVertex;
  89782. }
  89783. }
  89784. declare module BABYLON {
  89785. /**
  89786. * Enum defining the type of animations supported by InputBlock
  89787. */
  89788. export enum AnimatedInputBlockTypes {
  89789. /** No animation */
  89790. None = 0,
  89791. /** Time based animation. Will only work for floats */
  89792. Time = 1
  89793. }
  89794. }
  89795. declare module BABYLON {
  89796. /**
  89797. * Interface describing all the common properties and methods a shadow light needs to implement.
  89798. * This helps both the shadow generator and materials to genrate the corresponding shadow maps
  89799. * as well as binding the different shadow properties to the effects.
  89800. */
  89801. export interface IShadowLight extends Light {
  89802. /**
  89803. * The light id in the scene (used in scene.findLighById for instance)
  89804. */
  89805. id: string;
  89806. /**
  89807. * The position the shdow will be casted from.
  89808. */
  89809. position: Vector3;
  89810. /**
  89811. * In 2d mode (needCube being false), the direction used to cast the shadow.
  89812. */
  89813. direction: Vector3;
  89814. /**
  89815. * The transformed position. Position of the light in world space taking parenting in account.
  89816. */
  89817. transformedPosition: Vector3;
  89818. /**
  89819. * The transformed direction. Direction of the light in world space taking parenting in account.
  89820. */
  89821. transformedDirection: Vector3;
  89822. /**
  89823. * The friendly name of the light in the scene.
  89824. */
  89825. name: string;
  89826. /**
  89827. * Defines the shadow projection clipping minimum z value.
  89828. */
  89829. shadowMinZ: number;
  89830. /**
  89831. * Defines the shadow projection clipping maximum z value.
  89832. */
  89833. shadowMaxZ: number;
  89834. /**
  89835. * Computes the transformed information (transformedPosition and transformedDirection in World space) of the current light
  89836. * @returns true if the information has been computed, false if it does not need to (no parenting)
  89837. */
  89838. computeTransformedInformation(): boolean;
  89839. /**
  89840. * Gets the scene the light belongs to.
  89841. * @returns The scene
  89842. */
  89843. getScene(): Scene;
  89844. /**
  89845. * Callback defining a custom Projection Matrix Builder.
  89846. * This can be used to override the default projection matrix computation.
  89847. */
  89848. customProjectionMatrixBuilder: (viewMatrix: Matrix, renderList: Array<AbstractMesh>, result: Matrix) => void;
  89849. /**
  89850. * Sets the shadow projection matrix in parameter to the generated projection matrix.
  89851. * @param matrix The materix to updated with the projection information
  89852. * @param viewMatrix The transform matrix of the light
  89853. * @param renderList The list of mesh to render in the map
  89854. * @returns The current light
  89855. */
  89856. setShadowProjectionMatrix(matrix: Matrix, viewMatrix: Matrix, renderList: Array<AbstractMesh>): IShadowLight;
  89857. /**
  89858. * Gets the current depth scale used in ESM.
  89859. * @returns The scale
  89860. */
  89861. getDepthScale(): number;
  89862. /**
  89863. * Returns whether or not the shadow generation require a cube texture or a 2d texture.
  89864. * @returns true if a cube texture needs to be use
  89865. */
  89866. needCube(): boolean;
  89867. /**
  89868. * Detects if the projection matrix requires to be recomputed this frame.
  89869. * @returns true if it requires to be recomputed otherwise, false.
  89870. */
  89871. needProjectionMatrixCompute(): boolean;
  89872. /**
  89873. * Forces the shadow generator to recompute the projection matrix even if position and direction did not changed.
  89874. */
  89875. forceProjectionMatrixCompute(): void;
  89876. /**
  89877. * Get the direction to use to render the shadow map. In case of cube texture, the face index can be passed.
  89878. * @param faceIndex The index of the face we are computed the direction to generate shadow
  89879. * @returns The set direction in 2d mode otherwise the direction to the cubemap face if needCube() is true
  89880. */
  89881. getShadowDirection(faceIndex?: number): Vector3;
  89882. /**
  89883. * Gets the minZ used for shadow according to both the scene and the light.
  89884. * @param activeCamera The camera we are returning the min for
  89885. * @returns the depth min z
  89886. */
  89887. getDepthMinZ(activeCamera: Camera): number;
  89888. /**
  89889. * Gets the maxZ used for shadow according to both the scene and the light.
  89890. * @param activeCamera The camera we are returning the max for
  89891. * @returns the depth max z
  89892. */
  89893. getDepthMaxZ(activeCamera: Camera): number;
  89894. }
  89895. /**
  89896. * Base implementation IShadowLight
  89897. * It groups all the common behaviour in order to reduce dupplication and better follow the DRY pattern.
  89898. */
  89899. export abstract class ShadowLight extends Light implements IShadowLight {
  89900. protected abstract _setDefaultShadowProjectionMatrix(matrix: Matrix, viewMatrix: Matrix, renderList: Array<AbstractMesh>): void;
  89901. protected _position: Vector3;
  89902. protected _setPosition(value: Vector3): void;
  89903. /**
  89904. * Sets the position the shadow will be casted from. Also use as the light position for both
  89905. * point and spot lights.
  89906. */
  89907. get position(): Vector3;
  89908. /**
  89909. * Sets the position the shadow will be casted from. Also use as the light position for both
  89910. * point and spot lights.
  89911. */
  89912. set position(value: Vector3);
  89913. protected _direction: Vector3;
  89914. protected _setDirection(value: Vector3): void;
  89915. /**
  89916. * In 2d mode (needCube being false), gets the direction used to cast the shadow.
  89917. * Also use as the light direction on spot and directional lights.
  89918. */
  89919. get direction(): Vector3;
  89920. /**
  89921. * In 2d mode (needCube being false), sets the direction used to cast the shadow.
  89922. * Also use as the light direction on spot and directional lights.
  89923. */
  89924. set direction(value: Vector3);
  89925. protected _shadowMinZ: number;
  89926. /**
  89927. * Gets the shadow projection clipping minimum z value.
  89928. */
  89929. get shadowMinZ(): number;
  89930. /**
  89931. * Sets the shadow projection clipping minimum z value.
  89932. */
  89933. set shadowMinZ(value: number);
  89934. protected _shadowMaxZ: number;
  89935. /**
  89936. * Sets the shadow projection clipping maximum z value.
  89937. */
  89938. get shadowMaxZ(): number;
  89939. /**
  89940. * Gets the shadow projection clipping maximum z value.
  89941. */
  89942. set shadowMaxZ(value: number);
  89943. /**
  89944. * Callback defining a custom Projection Matrix Builder.
  89945. * This can be used to override the default projection matrix computation.
  89946. */
  89947. customProjectionMatrixBuilder: (viewMatrix: Matrix, renderList: Array<AbstractMesh>, result: Matrix) => void;
  89948. /**
  89949. * The transformed position. Position of the light in world space taking parenting in account.
  89950. */
  89951. transformedPosition: Vector3;
  89952. /**
  89953. * The transformed direction. Direction of the light in world space taking parenting in account.
  89954. */
  89955. transformedDirection: Vector3;
  89956. private _needProjectionMatrixCompute;
  89957. /**
  89958. * Computes the transformed information (transformedPosition and transformedDirection in World space) of the current light
  89959. * @returns true if the information has been computed, false if it does not need to (no parenting)
  89960. */
  89961. computeTransformedInformation(): boolean;
  89962. /**
  89963. * Return the depth scale used for the shadow map.
  89964. * @returns the depth scale.
  89965. */
  89966. getDepthScale(): number;
  89967. /**
  89968. * Get the direction to use to render the shadow map. In case of cube texture, the face index can be passed.
  89969. * @param faceIndex The index of the face we are computed the direction to generate shadow
  89970. * @returns The set direction in 2d mode otherwise the direction to the cubemap face if needCube() is true
  89971. */
  89972. getShadowDirection(faceIndex?: number): Vector3;
  89973. /**
  89974. * Returns the ShadowLight absolute position in the World.
  89975. * @returns the position vector in world space
  89976. */
  89977. getAbsolutePosition(): Vector3;
  89978. /**
  89979. * Sets the ShadowLight direction toward the passed target.
  89980. * @param target The point to target in local space
  89981. * @returns the updated ShadowLight direction
  89982. */
  89983. setDirectionToTarget(target: Vector3): Vector3;
  89984. /**
  89985. * Returns the light rotation in euler definition.
  89986. * @returns the x y z rotation in local space.
  89987. */
  89988. getRotation(): Vector3;
  89989. /**
  89990. * Returns whether or not the shadow generation require a cube texture or a 2d texture.
  89991. * @returns true if a cube texture needs to be use
  89992. */
  89993. needCube(): boolean;
  89994. /**
  89995. * Detects if the projection matrix requires to be recomputed this frame.
  89996. * @returns true if it requires to be recomputed otherwise, false.
  89997. */
  89998. needProjectionMatrixCompute(): boolean;
  89999. /**
  90000. * Forces the shadow generator to recompute the projection matrix even if position and direction did not changed.
  90001. */
  90002. forceProjectionMatrixCompute(): void;
  90003. /** @hidden */
  90004. _initCache(): void;
  90005. /** @hidden */
  90006. _isSynchronized(): boolean;
  90007. /**
  90008. * Computes the world matrix of the node
  90009. * @param force defines if the cache version should be invalidated forcing the world matrix to be created from scratch
  90010. * @returns the world matrix
  90011. */
  90012. computeWorldMatrix(force?: boolean): Matrix;
  90013. /**
  90014. * Gets the minZ used for shadow according to both the scene and the light.
  90015. * @param activeCamera The camera we are returning the min for
  90016. * @returns the depth min z
  90017. */
  90018. getDepthMinZ(activeCamera: Camera): number;
  90019. /**
  90020. * Gets the maxZ used for shadow according to both the scene and the light.
  90021. * @param activeCamera The camera we are returning the max for
  90022. * @returns the depth max z
  90023. */
  90024. getDepthMaxZ(activeCamera: Camera): number;
  90025. /**
  90026. * Sets the shadow projection matrix in parameter to the generated projection matrix.
  90027. * @param matrix The materix to updated with the projection information
  90028. * @param viewMatrix The transform matrix of the light
  90029. * @param renderList The list of mesh to render in the map
  90030. * @returns The current light
  90031. */
  90032. setShadowProjectionMatrix(matrix: Matrix, viewMatrix: Matrix, renderList: Array<AbstractMesh>): IShadowLight;
  90033. }
  90034. }
  90035. declare module BABYLON {
  90036. /** @hidden */
  90037. export var packingFunctions: {
  90038. name: string;
  90039. shader: string;
  90040. };
  90041. }
  90042. declare module BABYLON {
  90043. /** @hidden */
  90044. export var bayerDitherFunctions: {
  90045. name: string;
  90046. shader: string;
  90047. };
  90048. }
  90049. declare module BABYLON {
  90050. /** @hidden */
  90051. export var shadowMapFragmentDeclaration: {
  90052. name: string;
  90053. shader: string;
  90054. };
  90055. }
  90056. declare module BABYLON {
  90057. /** @hidden */
  90058. export var clipPlaneFragmentDeclaration: {
  90059. name: string;
  90060. shader: string;
  90061. };
  90062. }
  90063. declare module BABYLON {
  90064. /** @hidden */
  90065. export var clipPlaneFragment: {
  90066. name: string;
  90067. shader: string;
  90068. };
  90069. }
  90070. declare module BABYLON {
  90071. /** @hidden */
  90072. export var shadowMapFragment: {
  90073. name: string;
  90074. shader: string;
  90075. };
  90076. }
  90077. declare module BABYLON {
  90078. /** @hidden */
  90079. export var shadowMapPixelShader: {
  90080. name: string;
  90081. shader: string;
  90082. };
  90083. }
  90084. declare module BABYLON {
  90085. /** @hidden */
  90086. export var bonesDeclaration: {
  90087. name: string;
  90088. shader: string;
  90089. };
  90090. }
  90091. declare module BABYLON {
  90092. /** @hidden */
  90093. export var morphTargetsVertexGlobalDeclaration: {
  90094. name: string;
  90095. shader: string;
  90096. };
  90097. }
  90098. declare module BABYLON {
  90099. /** @hidden */
  90100. export var morphTargetsVertexDeclaration: {
  90101. name: string;
  90102. shader: string;
  90103. };
  90104. }
  90105. declare module BABYLON {
  90106. /** @hidden */
  90107. export var instancesDeclaration: {
  90108. name: string;
  90109. shader: string;
  90110. };
  90111. }
  90112. declare module BABYLON {
  90113. /** @hidden */
  90114. export var helperFunctions: {
  90115. name: string;
  90116. shader: string;
  90117. };
  90118. }
  90119. declare module BABYLON {
  90120. /** @hidden */
  90121. export var shadowMapVertexDeclaration: {
  90122. name: string;
  90123. shader: string;
  90124. };
  90125. }
  90126. declare module BABYLON {
  90127. /** @hidden */
  90128. export var clipPlaneVertexDeclaration: {
  90129. name: string;
  90130. shader: string;
  90131. };
  90132. }
  90133. declare module BABYLON {
  90134. /** @hidden */
  90135. export var morphTargetsVertex: {
  90136. name: string;
  90137. shader: string;
  90138. };
  90139. }
  90140. declare module BABYLON {
  90141. /** @hidden */
  90142. export var instancesVertex: {
  90143. name: string;
  90144. shader: string;
  90145. };
  90146. }
  90147. declare module BABYLON {
  90148. /** @hidden */
  90149. export var bonesVertex: {
  90150. name: string;
  90151. shader: string;
  90152. };
  90153. }
  90154. declare module BABYLON {
  90155. /** @hidden */
  90156. export var shadowMapVertexNormalBias: {
  90157. name: string;
  90158. shader: string;
  90159. };
  90160. }
  90161. declare module BABYLON {
  90162. /** @hidden */
  90163. export var shadowMapVertexMetric: {
  90164. name: string;
  90165. shader: string;
  90166. };
  90167. }
  90168. declare module BABYLON {
  90169. /** @hidden */
  90170. export var clipPlaneVertex: {
  90171. name: string;
  90172. shader: string;
  90173. };
  90174. }
  90175. declare module BABYLON {
  90176. /** @hidden */
  90177. export var shadowMapVertexShader: {
  90178. name: string;
  90179. shader: string;
  90180. };
  90181. }
  90182. declare module BABYLON {
  90183. /** @hidden */
  90184. export var depthBoxBlurPixelShader: {
  90185. name: string;
  90186. shader: string;
  90187. };
  90188. }
  90189. declare module BABYLON {
  90190. /** @hidden */
  90191. export var shadowMapFragmentSoftTransparentShadow: {
  90192. name: string;
  90193. shader: string;
  90194. };
  90195. }
  90196. declare module BABYLON {
  90197. /**
  90198. * EffectFallbacks can be used to add fallbacks (properties to disable) to certain properties when desired to improve performance.
  90199. * (Eg. Start at high quality with reflection and fog, if fps is low, remove reflection, if still low remove fog)
  90200. */
  90201. export class EffectFallbacks implements IEffectFallbacks {
  90202. private _defines;
  90203. private _currentRank;
  90204. private _maxRank;
  90205. private _mesh;
  90206. /**
  90207. * Removes the fallback from the bound mesh.
  90208. */
  90209. unBindMesh(): void;
  90210. /**
  90211. * Adds a fallback on the specified property.
  90212. * @param rank The rank of the fallback (Lower ranks will be fallbacked to first)
  90213. * @param define The name of the define in the shader
  90214. */
  90215. addFallback(rank: number, define: string): void;
  90216. /**
  90217. * Sets the mesh to use CPU skinning when needing to fallback.
  90218. * @param rank The rank of the fallback (Lower ranks will be fallbacked to first)
  90219. * @param mesh The mesh to use the fallbacks.
  90220. */
  90221. addCPUSkinningFallback(rank: number, mesh: AbstractMesh): void;
  90222. /**
  90223. * Checks to see if more fallbacks are still availible.
  90224. */
  90225. get hasMoreFallbacks(): boolean;
  90226. /**
  90227. * Removes the defines that should be removed when falling back.
  90228. * @param currentDefines defines the current define statements for the shader.
  90229. * @param effect defines the current effect we try to compile
  90230. * @returns The resulting defines with defines of the current rank removed.
  90231. */
  90232. reduce(currentDefines: string, effect: Effect): string;
  90233. }
  90234. }
  90235. declare module BABYLON {
  90236. /**
  90237. * Interface used to define Action
  90238. */
  90239. export interface IAction {
  90240. /**
  90241. * Trigger for the action
  90242. */
  90243. trigger: number;
  90244. /** Options of the trigger */
  90245. triggerOptions: any;
  90246. /**
  90247. * Gets the trigger parameters
  90248. * @returns the trigger parameters
  90249. */
  90250. getTriggerParameter(): any;
  90251. /**
  90252. * Internal only - executes current action event
  90253. * @hidden
  90254. */
  90255. _executeCurrent(evt?: ActionEvent): void;
  90256. /**
  90257. * Serialize placeholder for child classes
  90258. * @param parent of child
  90259. * @returns the serialized object
  90260. */
  90261. serialize(parent: any): any;
  90262. /**
  90263. * Internal only
  90264. * @hidden
  90265. */
  90266. _prepare(): void;
  90267. /**
  90268. * Internal only - manager for action
  90269. * @hidden
  90270. */
  90271. _actionManager: Nullable<AbstractActionManager>;
  90272. /**
  90273. * Adds action to chain of actions, may be a DoNothingAction
  90274. * @param action defines the next action to execute
  90275. * @returns The action passed in
  90276. * @see https://www.babylonjs-playground.com/#1T30HR#0
  90277. */
  90278. then(action: IAction): IAction;
  90279. }
  90280. /**
  90281. * The action to be carried out following a trigger
  90282. * @see https://doc.babylonjs.com/how_to/how_to_use_actions#available-actions
  90283. */
  90284. export class Action implements IAction {
  90285. /** the trigger, with or without parameters, for the action */
  90286. triggerOptions: any;
  90287. /**
  90288. * Trigger for the action
  90289. */
  90290. trigger: number;
  90291. /**
  90292. * Internal only - manager for action
  90293. * @hidden
  90294. */
  90295. _actionManager: ActionManager;
  90296. private _nextActiveAction;
  90297. private _child;
  90298. private _condition?;
  90299. private _triggerParameter;
  90300. /**
  90301. * An event triggered prior to action being executed.
  90302. */
  90303. onBeforeExecuteObservable: Observable<Action>;
  90304. /**
  90305. * Creates a new Action
  90306. * @param triggerOptions the trigger, with or without parameters, for the action
  90307. * @param condition an optional determinant of action
  90308. */
  90309. constructor(
  90310. /** the trigger, with or without parameters, for the action */
  90311. triggerOptions: any, condition?: Condition);
  90312. /**
  90313. * Internal only
  90314. * @hidden
  90315. */
  90316. _prepare(): void;
  90317. /**
  90318. * Gets the trigger parameters
  90319. * @returns the trigger parameters
  90320. */
  90321. getTriggerParameter(): any;
  90322. /**
  90323. * Internal only - executes current action event
  90324. * @hidden
  90325. */
  90326. _executeCurrent(evt?: ActionEvent): void;
  90327. /**
  90328. * Execute placeholder for child classes
  90329. * @param evt optional action event
  90330. */
  90331. execute(evt?: ActionEvent): void;
  90332. /**
  90333. * Skips to next active action
  90334. */
  90335. skipToNextActiveAction(): void;
  90336. /**
  90337. * Adds action to chain of actions, may be a DoNothingAction
  90338. * @param action defines the next action to execute
  90339. * @returns The action passed in
  90340. * @see https://www.babylonjs-playground.com/#1T30HR#0
  90341. */
  90342. then(action: Action): Action;
  90343. /**
  90344. * Internal only
  90345. * @hidden
  90346. */
  90347. _getProperty(propertyPath: string): string;
  90348. /**
  90349. * Internal only
  90350. * @hidden
  90351. */
  90352. _getEffectiveTarget(target: any, propertyPath: string): any;
  90353. /**
  90354. * Serialize placeholder for child classes
  90355. * @param parent of child
  90356. * @returns the serialized object
  90357. */
  90358. serialize(parent: any): any;
  90359. /**
  90360. * Internal only called by serialize
  90361. * @hidden
  90362. */
  90363. protected _serialize(serializedAction: any, parent?: any): any;
  90364. /**
  90365. * Internal only
  90366. * @hidden
  90367. */
  90368. static _SerializeValueAsString: (value: any) => string;
  90369. /**
  90370. * Internal only
  90371. * @hidden
  90372. */
  90373. static _GetTargetProperty: (target: Scene | Node) => {
  90374. name: string;
  90375. targetType: string;
  90376. value: string;
  90377. };
  90378. }
  90379. }
  90380. declare module BABYLON {
  90381. /**
  90382. * A Condition applied to an Action
  90383. */
  90384. export class Condition {
  90385. /**
  90386. * Internal only - manager for action
  90387. * @hidden
  90388. */
  90389. _actionManager: ActionManager;
  90390. /**
  90391. * Internal only
  90392. * @hidden
  90393. */
  90394. _evaluationId: number;
  90395. /**
  90396. * Internal only
  90397. * @hidden
  90398. */
  90399. _currentResult: boolean;
  90400. /**
  90401. * Creates a new Condition
  90402. * @param actionManager the manager of the action the condition is applied to
  90403. */
  90404. constructor(actionManager: ActionManager);
  90405. /**
  90406. * Check if the current condition is valid
  90407. * @returns a boolean
  90408. */
  90409. isValid(): boolean;
  90410. /**
  90411. * Internal only
  90412. * @hidden
  90413. */
  90414. _getProperty(propertyPath: string): string;
  90415. /**
  90416. * Internal only
  90417. * @hidden
  90418. */
  90419. _getEffectiveTarget(target: any, propertyPath: string): any;
  90420. /**
  90421. * Serialize placeholder for child classes
  90422. * @returns the serialized object
  90423. */
  90424. serialize(): any;
  90425. /**
  90426. * Internal only
  90427. * @hidden
  90428. */
  90429. protected _serialize(serializedCondition: any): any;
  90430. }
  90431. /**
  90432. * Defines specific conditional operators as extensions of Condition
  90433. */
  90434. export class ValueCondition extends Condition {
  90435. /** path to specify the property of the target the conditional operator uses */
  90436. propertyPath: string;
  90437. /** the value compared by the conditional operator against the current value of the property */
  90438. value: any;
  90439. /** the conditional operator, default ValueCondition.IsEqual */
  90440. operator: number;
  90441. /**
  90442. * Internal only
  90443. * @hidden
  90444. */
  90445. private static _IsEqual;
  90446. /**
  90447. * Internal only
  90448. * @hidden
  90449. */
  90450. private static _IsDifferent;
  90451. /**
  90452. * Internal only
  90453. * @hidden
  90454. */
  90455. private static _IsGreater;
  90456. /**
  90457. * Internal only
  90458. * @hidden
  90459. */
  90460. private static _IsLesser;
  90461. /**
  90462. * returns the number for IsEqual
  90463. */
  90464. static get IsEqual(): number;
  90465. /**
  90466. * Returns the number for IsDifferent
  90467. */
  90468. static get IsDifferent(): number;
  90469. /**
  90470. * Returns the number for IsGreater
  90471. */
  90472. static get IsGreater(): number;
  90473. /**
  90474. * Returns the number for IsLesser
  90475. */
  90476. static get IsLesser(): number;
  90477. /**
  90478. * Internal only The action manager for the condition
  90479. * @hidden
  90480. */
  90481. _actionManager: ActionManager;
  90482. /**
  90483. * Internal only
  90484. * @hidden
  90485. */
  90486. private _target;
  90487. /**
  90488. * Internal only
  90489. * @hidden
  90490. */
  90491. private _effectiveTarget;
  90492. /**
  90493. * Internal only
  90494. * @hidden
  90495. */
  90496. private _property;
  90497. /**
  90498. * Creates a new ValueCondition
  90499. * @param actionManager manager for the action the condition applies to
  90500. * @param target for the action
  90501. * @param propertyPath path to specify the property of the target the conditional operator uses
  90502. * @param value the value compared by the conditional operator against the current value of the property
  90503. * @param operator the conditional operator, default ValueCondition.IsEqual
  90504. */
  90505. constructor(actionManager: ActionManager, target: any,
  90506. /** path to specify the property of the target the conditional operator uses */
  90507. propertyPath: string,
  90508. /** the value compared by the conditional operator against the current value of the property */
  90509. value: any,
  90510. /** the conditional operator, default ValueCondition.IsEqual */
  90511. operator?: number);
  90512. /**
  90513. * Compares the given value with the property value for the specified conditional operator
  90514. * @returns the result of the comparison
  90515. */
  90516. isValid(): boolean;
  90517. /**
  90518. * Serialize the ValueCondition into a JSON compatible object
  90519. * @returns serialization object
  90520. */
  90521. serialize(): any;
  90522. /**
  90523. * Gets the name of the conditional operator for the ValueCondition
  90524. * @param operator the conditional operator
  90525. * @returns the name
  90526. */
  90527. static GetOperatorName(operator: number): string;
  90528. }
  90529. /**
  90530. * Defines a predicate condition as an extension of Condition
  90531. */
  90532. export class PredicateCondition extends Condition {
  90533. /** defines the predicate function used to validate the condition */
  90534. predicate: () => boolean;
  90535. /**
  90536. * Internal only - manager for action
  90537. * @hidden
  90538. */
  90539. _actionManager: ActionManager;
  90540. /**
  90541. * Creates a new PredicateCondition
  90542. * @param actionManager manager for the action the condition applies to
  90543. * @param predicate defines the predicate function used to validate the condition
  90544. */
  90545. constructor(actionManager: ActionManager,
  90546. /** defines the predicate function used to validate the condition */
  90547. predicate: () => boolean);
  90548. /**
  90549. * @returns the validity of the predicate condition
  90550. */
  90551. isValid(): boolean;
  90552. }
  90553. /**
  90554. * Defines a state condition as an extension of Condition
  90555. */
  90556. export class StateCondition extends Condition {
  90557. /** Value to compare with target state */
  90558. value: string;
  90559. /**
  90560. * Internal only - manager for action
  90561. * @hidden
  90562. */
  90563. _actionManager: ActionManager;
  90564. /**
  90565. * Internal only
  90566. * @hidden
  90567. */
  90568. private _target;
  90569. /**
  90570. * Creates a new StateCondition
  90571. * @param actionManager manager for the action the condition applies to
  90572. * @param target of the condition
  90573. * @param value to compare with target state
  90574. */
  90575. constructor(actionManager: ActionManager, target: any,
  90576. /** Value to compare with target state */
  90577. value: string);
  90578. /**
  90579. * Gets a boolean indicating if the current condition is met
  90580. * @returns the validity of the state
  90581. */
  90582. isValid(): boolean;
  90583. /**
  90584. * Serialize the StateCondition into a JSON compatible object
  90585. * @returns serialization object
  90586. */
  90587. serialize(): any;
  90588. }
  90589. }
  90590. declare module BABYLON {
  90591. /**
  90592. * This defines an action responsible to toggle a boolean once triggered.
  90593. * @see https://doc.babylonjs.com/how_to/how_to_use_actions
  90594. */
  90595. export class SwitchBooleanAction extends Action {
  90596. /**
  90597. * The path to the boolean property in the target object
  90598. */
  90599. propertyPath: string;
  90600. private _target;
  90601. private _effectiveTarget;
  90602. private _property;
  90603. /**
  90604. * Instantiate the action
  90605. * @param triggerOptions defines the trigger options
  90606. * @param target defines the object containing the boolean
  90607. * @param propertyPath defines the path to the boolean property in the target object
  90608. * @param condition defines the trigger related conditions
  90609. */
  90610. constructor(triggerOptions: any, target: any, propertyPath: string, condition?: Condition);
  90611. /** @hidden */
  90612. _prepare(): void;
  90613. /**
  90614. * Execute the action toggle the boolean value.
  90615. */
  90616. execute(): void;
  90617. /**
  90618. * Serializes the actions and its related information.
  90619. * @param parent defines the object to serialize in
  90620. * @returns the serialized object
  90621. */
  90622. serialize(parent: any): any;
  90623. }
  90624. /**
  90625. * This defines an action responsible to set a the state field of the target
  90626. * to a desired value once triggered.
  90627. * @see https://doc.babylonjs.com/how_to/how_to_use_actions
  90628. */
  90629. export class SetStateAction extends Action {
  90630. /**
  90631. * The value to store in the state field.
  90632. */
  90633. value: string;
  90634. private _target;
  90635. /**
  90636. * Instantiate the action
  90637. * @param triggerOptions defines the trigger options
  90638. * @param target defines the object containing the state property
  90639. * @param value defines the value to store in the state field
  90640. * @param condition defines the trigger related conditions
  90641. */
  90642. constructor(triggerOptions: any, target: any, value: string, condition?: Condition);
  90643. /**
  90644. * Execute the action and store the value on the target state property.
  90645. */
  90646. execute(): void;
  90647. /**
  90648. * Serializes the actions and its related information.
  90649. * @param parent defines the object to serialize in
  90650. * @returns the serialized object
  90651. */
  90652. serialize(parent: any): any;
  90653. }
  90654. /**
  90655. * This defines an action responsible to set a property of the target
  90656. * to a desired value once triggered.
  90657. * @see https://doc.babylonjs.com/how_to/how_to_use_actions
  90658. */
  90659. export class SetValueAction extends Action {
  90660. /**
  90661. * The path of the property to set in the target.
  90662. */
  90663. propertyPath: string;
  90664. /**
  90665. * The value to set in the property
  90666. */
  90667. value: any;
  90668. private _target;
  90669. private _effectiveTarget;
  90670. private _property;
  90671. /**
  90672. * Instantiate the action
  90673. * @param triggerOptions defines the trigger options
  90674. * @param target defines the object containing the property
  90675. * @param propertyPath defines the path of the property to set in the target
  90676. * @param value defines the value to set in the property
  90677. * @param condition defines the trigger related conditions
  90678. */
  90679. constructor(triggerOptions: any, target: any, propertyPath: string, value: any, condition?: Condition);
  90680. /** @hidden */
  90681. _prepare(): void;
  90682. /**
  90683. * Execute the action and set the targetted property to the desired value.
  90684. */
  90685. execute(): void;
  90686. /**
  90687. * Serializes the actions and its related information.
  90688. * @param parent defines the object to serialize in
  90689. * @returns the serialized object
  90690. */
  90691. serialize(parent: any): any;
  90692. }
  90693. /**
  90694. * This defines an action responsible to increment the target value
  90695. * to a desired value once triggered.
  90696. * @see https://doc.babylonjs.com/how_to/how_to_use_actions
  90697. */
  90698. export class IncrementValueAction extends Action {
  90699. /**
  90700. * The path of the property to increment in the target.
  90701. */
  90702. propertyPath: string;
  90703. /**
  90704. * The value we should increment the property by.
  90705. */
  90706. value: any;
  90707. private _target;
  90708. private _effectiveTarget;
  90709. private _property;
  90710. /**
  90711. * Instantiate the action
  90712. * @param triggerOptions defines the trigger options
  90713. * @param target defines the object containing the property
  90714. * @param propertyPath defines the path of the property to increment in the target
  90715. * @param value defines the value value we should increment the property by
  90716. * @param condition defines the trigger related conditions
  90717. */
  90718. constructor(triggerOptions: any, target: any, propertyPath: string, value: any, condition?: Condition);
  90719. /** @hidden */
  90720. _prepare(): void;
  90721. /**
  90722. * Execute the action and increment the target of the value amount.
  90723. */
  90724. execute(): void;
  90725. /**
  90726. * Serializes the actions and its related information.
  90727. * @param parent defines the object to serialize in
  90728. * @returns the serialized object
  90729. */
  90730. serialize(parent: any): any;
  90731. }
  90732. /**
  90733. * This defines an action responsible to start an animation once triggered.
  90734. * @see https://doc.babylonjs.com/how_to/how_to_use_actions
  90735. */
  90736. export class PlayAnimationAction extends Action {
  90737. /**
  90738. * Where the animation should start (animation frame)
  90739. */
  90740. from: number;
  90741. /**
  90742. * Where the animation should stop (animation frame)
  90743. */
  90744. to: number;
  90745. /**
  90746. * Define if the animation should loop or stop after the first play.
  90747. */
  90748. loop?: boolean;
  90749. private _target;
  90750. /**
  90751. * Instantiate the action
  90752. * @param triggerOptions defines the trigger options
  90753. * @param target defines the target animation or animation name
  90754. * @param from defines from where the animation should start (animation frame)
  90755. * @param end defines where the animation should stop (animation frame)
  90756. * @param loop defines if the animation should loop or stop after the first play
  90757. * @param condition defines the trigger related conditions
  90758. */
  90759. constructor(triggerOptions: any, target: any, from: number, to: number, loop?: boolean, condition?: Condition);
  90760. /** @hidden */
  90761. _prepare(): void;
  90762. /**
  90763. * Execute the action and play the animation.
  90764. */
  90765. execute(): void;
  90766. /**
  90767. * Serializes the actions and its related information.
  90768. * @param parent defines the object to serialize in
  90769. * @returns the serialized object
  90770. */
  90771. serialize(parent: any): any;
  90772. }
  90773. /**
  90774. * This defines an action responsible to stop an animation once triggered.
  90775. * @see https://doc.babylonjs.com/how_to/how_to_use_actions
  90776. */
  90777. export class StopAnimationAction extends Action {
  90778. private _target;
  90779. /**
  90780. * Instantiate the action
  90781. * @param triggerOptions defines the trigger options
  90782. * @param target defines the target animation or animation name
  90783. * @param condition defines the trigger related conditions
  90784. */
  90785. constructor(triggerOptions: any, target: any, condition?: Condition);
  90786. /** @hidden */
  90787. _prepare(): void;
  90788. /**
  90789. * Execute the action and stop the animation.
  90790. */
  90791. execute(): void;
  90792. /**
  90793. * Serializes the actions and its related information.
  90794. * @param parent defines the object to serialize in
  90795. * @returns the serialized object
  90796. */
  90797. serialize(parent: any): any;
  90798. }
  90799. /**
  90800. * This defines an action responsible that does nothing once triggered.
  90801. * @see https://doc.babylonjs.com/how_to/how_to_use_actions
  90802. */
  90803. export class DoNothingAction extends Action {
  90804. /**
  90805. * Instantiate the action
  90806. * @param triggerOptions defines the trigger options
  90807. * @param condition defines the trigger related conditions
  90808. */
  90809. constructor(triggerOptions?: any, condition?: Condition);
  90810. /**
  90811. * Execute the action and do nothing.
  90812. */
  90813. execute(): void;
  90814. /**
  90815. * Serializes the actions and its related information.
  90816. * @param parent defines the object to serialize in
  90817. * @returns the serialized object
  90818. */
  90819. serialize(parent: any): any;
  90820. }
  90821. /**
  90822. * This defines an action responsible to trigger several actions once triggered.
  90823. * @see https://doc.babylonjs.com/how_to/how_to_use_actions
  90824. */
  90825. export class CombineAction extends Action {
  90826. /**
  90827. * The list of aggregated animations to run.
  90828. */
  90829. children: Action[];
  90830. /**
  90831. * Instantiate the action
  90832. * @param triggerOptions defines the trigger options
  90833. * @param children defines the list of aggregated animations to run
  90834. * @param condition defines the trigger related conditions
  90835. */
  90836. constructor(triggerOptions: any, children: Action[], condition?: Condition);
  90837. /** @hidden */
  90838. _prepare(): void;
  90839. /**
  90840. * Execute the action and executes all the aggregated actions.
  90841. */
  90842. execute(evt: ActionEvent): void;
  90843. /**
  90844. * Serializes the actions and its related information.
  90845. * @param parent defines the object to serialize in
  90846. * @returns the serialized object
  90847. */
  90848. serialize(parent: any): any;
  90849. }
  90850. /**
  90851. * This defines an action responsible to run code (external event) once triggered.
  90852. * @see https://doc.babylonjs.com/how_to/how_to_use_actions
  90853. */
  90854. export class ExecuteCodeAction extends Action {
  90855. /**
  90856. * The callback function to run.
  90857. */
  90858. func: (evt: ActionEvent) => void;
  90859. /**
  90860. * Instantiate the action
  90861. * @param triggerOptions defines the trigger options
  90862. * @param func defines the callback function to run
  90863. * @param condition defines the trigger related conditions
  90864. */
  90865. constructor(triggerOptions: any, func: (evt: ActionEvent) => void, condition?: Condition);
  90866. /**
  90867. * Execute the action and run the attached code.
  90868. */
  90869. execute(evt: ActionEvent): void;
  90870. }
  90871. /**
  90872. * This defines an action responsible to set the parent property of the target once triggered.
  90873. * @see https://doc.babylonjs.com/how_to/how_to_use_actions
  90874. */
  90875. export class SetParentAction extends Action {
  90876. private _parent;
  90877. private _target;
  90878. /**
  90879. * Instantiate the action
  90880. * @param triggerOptions defines the trigger options
  90881. * @param target defines the target containing the parent property
  90882. * @param parent defines from where the animation should start (animation frame)
  90883. * @param condition defines the trigger related conditions
  90884. */
  90885. constructor(triggerOptions: any, target: any, parent: any, condition?: Condition);
  90886. /** @hidden */
  90887. _prepare(): void;
  90888. /**
  90889. * Execute the action and set the parent property.
  90890. */
  90891. execute(): void;
  90892. /**
  90893. * Serializes the actions and its related information.
  90894. * @param parent defines the object to serialize in
  90895. * @returns the serialized object
  90896. */
  90897. serialize(parent: any): any;
  90898. }
  90899. }
  90900. declare module BABYLON {
  90901. /**
  90902. * Action Manager manages all events to be triggered on a given mesh or the global scene.
  90903. * A single scene can have many Action Managers to handle predefined actions on specific meshes.
  90904. * @see https://doc.babylonjs.com/how_to/how_to_use_actions
  90905. */
  90906. export class ActionManager extends AbstractActionManager {
  90907. /**
  90908. * Nothing
  90909. * @see https://doc.babylonjs.com/how_to/how_to_use_actions#triggers
  90910. */
  90911. static readonly NothingTrigger: number;
  90912. /**
  90913. * On pick
  90914. * @see https://doc.babylonjs.com/how_to/how_to_use_actions#triggers
  90915. */
  90916. static readonly OnPickTrigger: number;
  90917. /**
  90918. * On left pick
  90919. * @see https://doc.babylonjs.com/how_to/how_to_use_actions#triggers
  90920. */
  90921. static readonly OnLeftPickTrigger: number;
  90922. /**
  90923. * On right pick
  90924. * @see https://doc.babylonjs.com/how_to/how_to_use_actions#triggers
  90925. */
  90926. static readonly OnRightPickTrigger: number;
  90927. /**
  90928. * On center pick
  90929. * @see https://doc.babylonjs.com/how_to/how_to_use_actions#triggers
  90930. */
  90931. static readonly OnCenterPickTrigger: number;
  90932. /**
  90933. * On pick down
  90934. * @see https://doc.babylonjs.com/how_to/how_to_use_actions#triggers
  90935. */
  90936. static readonly OnPickDownTrigger: number;
  90937. /**
  90938. * On double pick
  90939. * @see https://doc.babylonjs.com/how_to/how_to_use_actions#triggers
  90940. */
  90941. static readonly OnDoublePickTrigger: number;
  90942. /**
  90943. * On pick up
  90944. * @see https://doc.babylonjs.com/how_to/how_to_use_actions#triggers
  90945. */
  90946. static readonly OnPickUpTrigger: number;
  90947. /**
  90948. * On pick out.
  90949. * This trigger will only be raised if you also declared a OnPickDown
  90950. * @see https://doc.babylonjs.com/how_to/how_to_use_actions#triggers
  90951. */
  90952. static readonly OnPickOutTrigger: number;
  90953. /**
  90954. * On long press
  90955. * @see https://doc.babylonjs.com/how_to/how_to_use_actions#triggers
  90956. */
  90957. static readonly OnLongPressTrigger: number;
  90958. /**
  90959. * On pointer over
  90960. * @see https://doc.babylonjs.com/how_to/how_to_use_actions#triggers
  90961. */
  90962. static readonly OnPointerOverTrigger: number;
  90963. /**
  90964. * On pointer out
  90965. * @see https://doc.babylonjs.com/how_to/how_to_use_actions#triggers
  90966. */
  90967. static readonly OnPointerOutTrigger: number;
  90968. /**
  90969. * On every frame
  90970. * @see https://doc.babylonjs.com/how_to/how_to_use_actions#triggers
  90971. */
  90972. static readonly OnEveryFrameTrigger: number;
  90973. /**
  90974. * On intersection enter
  90975. * @see https://doc.babylonjs.com/how_to/how_to_use_actions#triggers
  90976. */
  90977. static readonly OnIntersectionEnterTrigger: number;
  90978. /**
  90979. * On intersection exit
  90980. * @see https://doc.babylonjs.com/how_to/how_to_use_actions#triggers
  90981. */
  90982. static readonly OnIntersectionExitTrigger: number;
  90983. /**
  90984. * On key down
  90985. * @see https://doc.babylonjs.com/how_to/how_to_use_actions#triggers
  90986. */
  90987. static readonly OnKeyDownTrigger: number;
  90988. /**
  90989. * On key up
  90990. * @see https://doc.babylonjs.com/how_to/how_to_use_actions#triggers
  90991. */
  90992. static readonly OnKeyUpTrigger: number;
  90993. private _scene;
  90994. /**
  90995. * Creates a new action manager
  90996. * @param scene defines the hosting scene
  90997. */
  90998. constructor(scene: Scene);
  90999. /**
  91000. * Releases all associated resources
  91001. */
  91002. dispose(): void;
  91003. /**
  91004. * Gets hosting scene
  91005. * @returns the hosting scene
  91006. */
  91007. getScene(): Scene;
  91008. /**
  91009. * Does this action manager handles actions of any of the given triggers
  91010. * @param triggers defines the triggers to be tested
  91011. * @return a boolean indicating whether one (or more) of the triggers is handled
  91012. */
  91013. hasSpecificTriggers(triggers: number[]): boolean;
  91014. /**
  91015. * Does this action manager handles actions of any of the given triggers. This function takes two arguments for
  91016. * speed.
  91017. * @param triggerA defines the trigger to be tested
  91018. * @param triggerB defines the trigger to be tested
  91019. * @return a boolean indicating whether one (or more) of the triggers is handled
  91020. */
  91021. hasSpecificTriggers2(triggerA: number, triggerB: number): boolean;
  91022. /**
  91023. * Does this action manager handles actions of a given trigger
  91024. * @param trigger defines the trigger to be tested
  91025. * @param parameterPredicate defines an optional predicate to filter triggers by parameter
  91026. * @return whether the trigger is handled
  91027. */
  91028. hasSpecificTrigger(trigger: number, parameterPredicate?: (parameter: any) => boolean): boolean;
  91029. /**
  91030. * Does this action manager has pointer triggers
  91031. */
  91032. get hasPointerTriggers(): boolean;
  91033. /**
  91034. * Does this action manager has pick triggers
  91035. */
  91036. get hasPickTriggers(): boolean;
  91037. /**
  91038. * Registers an action to this action manager
  91039. * @param action defines the action to be registered
  91040. * @return the action amended (prepared) after registration
  91041. */
  91042. registerAction(action: IAction): Nullable<IAction>;
  91043. /**
  91044. * Unregisters an action to this action manager
  91045. * @param action defines the action to be unregistered
  91046. * @return a boolean indicating whether the action has been unregistered
  91047. */
  91048. unregisterAction(action: IAction): Boolean;
  91049. /**
  91050. * Process a specific trigger
  91051. * @param trigger defines the trigger to process
  91052. * @param evt defines the event details to be processed
  91053. */
  91054. processTrigger(trigger: number, evt?: IActionEvent): void;
  91055. /** @hidden */
  91056. _getEffectiveTarget(target: any, propertyPath: string): any;
  91057. /** @hidden */
  91058. _getProperty(propertyPath: string): string;
  91059. /**
  91060. * Serialize this manager to a JSON object
  91061. * @param name defines the property name to store this manager
  91062. * @returns a JSON representation of this manager
  91063. */
  91064. serialize(name: string): any;
  91065. /**
  91066. * Creates a new ActionManager from a JSON data
  91067. * @param parsedActions defines the JSON data to read from
  91068. * @param object defines the hosting mesh
  91069. * @param scene defines the hosting scene
  91070. */
  91071. static Parse(parsedActions: any, object: Nullable<AbstractMesh>, scene: Scene): void;
  91072. /**
  91073. * Get a trigger name by index
  91074. * @param trigger defines the trigger index
  91075. * @returns a trigger name
  91076. */
  91077. static GetTriggerName(trigger: number): string;
  91078. }
  91079. }
  91080. declare module BABYLON {
  91081. /**
  91082. * Class used to represent a sprite
  91083. * @see https://doc.babylonjs.com/babylon101/sprites
  91084. */
  91085. export class Sprite implements IAnimatable {
  91086. /** defines the name */
  91087. name: string;
  91088. /** Gets or sets the current world position */
  91089. position: Vector3;
  91090. /** Gets or sets the main color */
  91091. color: Color4;
  91092. /** Gets or sets the width */
  91093. width: number;
  91094. /** Gets or sets the height */
  91095. height: number;
  91096. /** Gets or sets rotation angle */
  91097. angle: number;
  91098. /** Gets or sets the cell index in the sprite sheet */
  91099. cellIndex: number;
  91100. /** Gets or sets the cell reference in the sprite sheet, uses sprite's filename when added to sprite sheet */
  91101. cellRef: string;
  91102. /** Gets or sets a boolean indicating if UV coordinates should be inverted in U axis */
  91103. invertU: boolean;
  91104. /** Gets or sets a boolean indicating if UV coordinates should be inverted in B axis */
  91105. invertV: boolean;
  91106. /** Gets or sets a boolean indicating that this sprite should be disposed after animation ends */
  91107. disposeWhenFinishedAnimating: boolean;
  91108. /** Gets the list of attached animations */
  91109. animations: Nullable<Array<Animation>>;
  91110. /** Gets or sets a boolean indicating if the sprite can be picked */
  91111. isPickable: boolean;
  91112. /** Gets or sets a boolean indicating that sprite texture alpha will be used for precise picking (false by default) */
  91113. useAlphaForPicking: boolean;
  91114. /** @hidden */
  91115. _xOffset: number;
  91116. /** @hidden */
  91117. _yOffset: number;
  91118. /** @hidden */
  91119. _xSize: number;
  91120. /** @hidden */
  91121. _ySize: number;
  91122. /**
  91123. * Gets or sets the associated action manager
  91124. */
  91125. actionManager: Nullable<ActionManager>;
  91126. /**
  91127. * An event triggered when the control has been disposed
  91128. */
  91129. onDisposeObservable: Observable<Sprite>;
  91130. private _animationStarted;
  91131. private _loopAnimation;
  91132. private _fromIndex;
  91133. private _toIndex;
  91134. private _delay;
  91135. private _direction;
  91136. private _manager;
  91137. private _time;
  91138. private _onAnimationEnd;
  91139. /**
  91140. * Gets or sets a boolean indicating if the sprite is visible (renderable). Default is true
  91141. */
  91142. isVisible: boolean;
  91143. /**
  91144. * Gets or sets the sprite size
  91145. */
  91146. get size(): number;
  91147. set size(value: number);
  91148. /**
  91149. * Returns a boolean indicating if the animation is started
  91150. */
  91151. get animationStarted(): boolean;
  91152. /**
  91153. * Gets or sets the unique id of the sprite
  91154. */
  91155. uniqueId: number;
  91156. /**
  91157. * Gets the manager of this sprite
  91158. */
  91159. get manager(): ISpriteManager;
  91160. /**
  91161. * Creates a new Sprite
  91162. * @param name defines the name
  91163. * @param manager defines the manager
  91164. */
  91165. constructor(
  91166. /** defines the name */
  91167. name: string, manager: ISpriteManager);
  91168. /**
  91169. * Returns the string "Sprite"
  91170. * @returns "Sprite"
  91171. */
  91172. getClassName(): string;
  91173. /** Gets or sets the initial key for the animation (setting it will restart the animation) */
  91174. get fromIndex(): number;
  91175. set fromIndex(value: number);
  91176. /** Gets or sets the end key for the animation (setting it will restart the animation) */
  91177. get toIndex(): number;
  91178. set toIndex(value: number);
  91179. /** Gets or sets a boolean indicating if the animation is looping (setting it will restart the animation) */
  91180. get loopAnimation(): boolean;
  91181. set loopAnimation(value: boolean);
  91182. /** Gets or sets the delay between cell changes (setting it will restart the animation) */
  91183. get delay(): number;
  91184. set delay(value: number);
  91185. /**
  91186. * Starts an animation
  91187. * @param from defines the initial key
  91188. * @param to defines the end key
  91189. * @param loop defines if the animation must loop
  91190. * @param delay defines the start delay (in ms)
  91191. * @param onAnimationEnd defines a callback to call when animation ends
  91192. */
  91193. playAnimation(from: number, to: number, loop: boolean, delay: number, onAnimationEnd?: Nullable<() => void>): void;
  91194. /** Stops current animation (if any) */
  91195. stopAnimation(): void;
  91196. /** @hidden */
  91197. _animate(deltaTime: number): void;
  91198. /** Release associated resources */
  91199. dispose(): void;
  91200. /**
  91201. * Serializes the sprite to a JSON object
  91202. * @returns the JSON object
  91203. */
  91204. serialize(): any;
  91205. /**
  91206. * Parses a JSON object to create a new sprite
  91207. * @param parsedSprite The JSON object to parse
  91208. * @param manager defines the hosting manager
  91209. * @returns the new sprite
  91210. */
  91211. static Parse(parsedSprite: any, manager: SpriteManager): Sprite;
  91212. }
  91213. }
  91214. declare module BABYLON {
  91215. /**
  91216. * Information about the result of picking within a scene
  91217. * @see https://doc.babylonjs.com/babylon101/picking_collisions
  91218. */
  91219. export class PickingInfo {
  91220. /** @hidden */
  91221. _pickingUnavailable: boolean;
  91222. /**
  91223. * If the pick collided with an object
  91224. */
  91225. hit: boolean;
  91226. /**
  91227. * Distance away where the pick collided
  91228. */
  91229. distance: number;
  91230. /**
  91231. * The location of pick collision
  91232. */
  91233. pickedPoint: Nullable<Vector3>;
  91234. /**
  91235. * The mesh corresponding the the pick collision
  91236. */
  91237. pickedMesh: Nullable<AbstractMesh>;
  91238. /** (See getTextureCoordinates) The barycentric U coordinate that is used when calculating the texture coordinates of the collision.*/
  91239. bu: number;
  91240. /** (See getTextureCoordinates) The barycentric V coordinate that is used when calculating the texture coordinates of the collision.*/
  91241. bv: number;
  91242. /** The index of the face on the mesh that was picked, or the index of the Line if the picked Mesh is a LinesMesh */
  91243. faceId: number;
  91244. /** The index of the face on the subMesh that was picked, or the index of the Line if the picked Mesh is a LinesMesh */
  91245. subMeshFaceId: number;
  91246. /** Id of the the submesh that was picked */
  91247. subMeshId: number;
  91248. /** If a sprite was picked, this will be the sprite the pick collided with */
  91249. pickedSprite: Nullable<Sprite>;
  91250. /** If we are pikcing a mesh with thin instance, this will give you the picked thin instance */
  91251. thinInstanceIndex: number;
  91252. /**
  91253. * If a mesh was used to do the picking (eg. 6dof controller) this will be populated.
  91254. */
  91255. originMesh: Nullable<AbstractMesh>;
  91256. /**
  91257. * The ray that was used to perform the picking.
  91258. */
  91259. ray: Nullable<Ray>;
  91260. /**
  91261. * Gets the normal correspodning to the face the pick collided with
  91262. * @param useWorldCoordinates If the resulting normal should be relative to the world (default: false)
  91263. * @param useVerticesNormals If the vertices normals should be used to calculate the normal instead of the normal map
  91264. * @returns The normal correspodning to the face the pick collided with
  91265. */
  91266. getNormal(useWorldCoordinates?: boolean, useVerticesNormals?: boolean): Nullable<Vector3>;
  91267. /**
  91268. * Gets the texture coordinates of where the pick occured
  91269. * @returns the vector containing the coordnates of the texture
  91270. */
  91271. getTextureCoordinates(): Nullable<Vector2>;
  91272. }
  91273. }
  91274. declare module BABYLON {
  91275. /**
  91276. * Class representing a ray with position and direction
  91277. */
  91278. export class Ray {
  91279. /** origin point */
  91280. origin: Vector3;
  91281. /** direction */
  91282. direction: Vector3;
  91283. /** length of the ray */
  91284. length: number;
  91285. private static readonly _TmpVector3;
  91286. private _tmpRay;
  91287. /**
  91288. * Creates a new ray
  91289. * @param origin origin point
  91290. * @param direction direction
  91291. * @param length length of the ray
  91292. */
  91293. constructor(
  91294. /** origin point */
  91295. origin: Vector3,
  91296. /** direction */
  91297. direction: Vector3,
  91298. /** length of the ray */
  91299. length?: number);
  91300. /**
  91301. * Checks if the ray intersects a box
  91302. * This does not account for the ray lenght by design to improve perfs.
  91303. * @param minimum bound of the box
  91304. * @param maximum bound of the box
  91305. * @param intersectionTreshold extra extend to be added to the box in all direction
  91306. * @returns if the box was hit
  91307. */
  91308. intersectsBoxMinMax(minimum: DeepImmutable<Vector3>, maximum: DeepImmutable<Vector3>, intersectionTreshold?: number): boolean;
  91309. /**
  91310. * Checks if the ray intersects a box
  91311. * This does not account for the ray lenght by design to improve perfs.
  91312. * @param box the bounding box to check
  91313. * @param intersectionTreshold extra extend to be added to the BoundingBox in all direction
  91314. * @returns if the box was hit
  91315. */
  91316. intersectsBox(box: DeepImmutable<BoundingBox>, intersectionTreshold?: number): boolean;
  91317. /**
  91318. * If the ray hits a sphere
  91319. * @param sphere the bounding sphere to check
  91320. * @param intersectionTreshold extra extend to be added to the BoundingSphere in all direction
  91321. * @returns true if it hits the sphere
  91322. */
  91323. intersectsSphere(sphere: DeepImmutable<BoundingSphere>, intersectionTreshold?: number): boolean;
  91324. /**
  91325. * If the ray hits a triange
  91326. * @param vertex0 triangle vertex
  91327. * @param vertex1 triangle vertex
  91328. * @param vertex2 triangle vertex
  91329. * @returns intersection information if hit
  91330. */
  91331. intersectsTriangle(vertex0: DeepImmutable<Vector3>, vertex1: DeepImmutable<Vector3>, vertex2: DeepImmutable<Vector3>): Nullable<IntersectionInfo>;
  91332. /**
  91333. * Checks if ray intersects a plane
  91334. * @param plane the plane to check
  91335. * @returns the distance away it was hit
  91336. */
  91337. intersectsPlane(plane: DeepImmutable<Plane>): Nullable<number>;
  91338. /**
  91339. * Calculate the intercept of a ray on a given axis
  91340. * @param axis to check 'x' | 'y' | 'z'
  91341. * @param offset from axis interception (i.e. an offset of 1y is intercepted above ground)
  91342. * @returns a vector containing the coordinates where 'axis' is equal to zero (else offset), or null if there is no intercept.
  91343. */
  91344. intersectsAxis(axis: string, offset?: number): Nullable<Vector3>;
  91345. /**
  91346. * Checks if ray intersects a mesh
  91347. * @param mesh the mesh to check
  91348. * @param fastCheck defines if the first intersection will be used (and not the closest)
  91349. * @returns picking info of the intersecton
  91350. */
  91351. intersectsMesh(mesh: DeepImmutable<AbstractMesh>, fastCheck?: boolean): PickingInfo;
  91352. /**
  91353. * Checks if ray intersects a mesh
  91354. * @param meshes the meshes to check
  91355. * @param fastCheck defines if the first intersection will be used (and not the closest)
  91356. * @param results array to store result in
  91357. * @returns Array of picking infos
  91358. */
  91359. intersectsMeshes(meshes: Array<DeepImmutable<AbstractMesh>>, fastCheck?: boolean, results?: Array<PickingInfo>): Array<PickingInfo>;
  91360. private _comparePickingInfo;
  91361. private static smallnum;
  91362. private static rayl;
  91363. /**
  91364. * Intersection test between the ray and a given segment whithin a given tolerance (threshold)
  91365. * @param sega the first point of the segment to test the intersection against
  91366. * @param segb the second point of the segment to test the intersection against
  91367. * @param threshold the tolerance margin, if the ray doesn't intersect the segment but is close to the given threshold, the intersection is successful
  91368. * @return the distance from the ray origin to the intersection point if there's intersection, or -1 if there's no intersection
  91369. */
  91370. intersectionSegment(sega: DeepImmutable<Vector3>, segb: DeepImmutable<Vector3>, threshold: number): number;
  91371. /**
  91372. * Update the ray from viewport position
  91373. * @param x position
  91374. * @param y y position
  91375. * @param viewportWidth viewport width
  91376. * @param viewportHeight viewport height
  91377. * @param world world matrix
  91378. * @param view view matrix
  91379. * @param projection projection matrix
  91380. * @returns this ray updated
  91381. */
  91382. update(x: number, y: number, viewportWidth: number, viewportHeight: number, world: DeepImmutable<Matrix>, view: DeepImmutable<Matrix>, projection: DeepImmutable<Matrix>): Ray;
  91383. /**
  91384. * Creates a ray with origin and direction of 0,0,0
  91385. * @returns the new ray
  91386. */
  91387. static Zero(): Ray;
  91388. /**
  91389. * Creates a new ray from screen space and viewport
  91390. * @param x position
  91391. * @param y y position
  91392. * @param viewportWidth viewport width
  91393. * @param viewportHeight viewport height
  91394. * @param world world matrix
  91395. * @param view view matrix
  91396. * @param projection projection matrix
  91397. * @returns new ray
  91398. */
  91399. static CreateNew(x: number, y: number, viewportWidth: number, viewportHeight: number, world: DeepImmutable<Matrix>, view: DeepImmutable<Matrix>, projection: DeepImmutable<Matrix>): Ray;
  91400. /**
  91401. * 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
  91402. * transformed to the given world matrix.
  91403. * @param origin The origin point
  91404. * @param end The end point
  91405. * @param world a matrix to transform the ray to. Default is the identity matrix.
  91406. * @returns the new ray
  91407. */
  91408. static CreateNewFromTo(origin: Vector3, end: Vector3, world?: DeepImmutable<Matrix>): Ray;
  91409. /**
  91410. * Transforms a ray by a matrix
  91411. * @param ray ray to transform
  91412. * @param matrix matrix to apply
  91413. * @returns the resulting new ray
  91414. */
  91415. static Transform(ray: DeepImmutable<Ray>, matrix: DeepImmutable<Matrix>): Ray;
  91416. /**
  91417. * Transforms a ray by a matrix
  91418. * @param ray ray to transform
  91419. * @param matrix matrix to apply
  91420. * @param result ray to store result in
  91421. */
  91422. static TransformToRef(ray: DeepImmutable<Ray>, matrix: DeepImmutable<Matrix>, result: Ray): void;
  91423. /**
  91424. * Unproject a ray from screen space to object space
  91425. * @param sourceX defines the screen space x coordinate to use
  91426. * @param sourceY defines the screen space y coordinate to use
  91427. * @param viewportWidth defines the current width of the viewport
  91428. * @param viewportHeight defines the current height of the viewport
  91429. * @param world defines the world matrix to use (can be set to Identity to go to world space)
  91430. * @param view defines the view matrix to use
  91431. * @param projection defines the projection matrix to use
  91432. */
  91433. unprojectRayToRef(sourceX: float, sourceY: float, viewportWidth: number, viewportHeight: number, world: DeepImmutable<Matrix>, view: DeepImmutable<Matrix>, projection: DeepImmutable<Matrix>): void;
  91434. }
  91435. /**
  91436. * Type used to define predicate used to select faces when a mesh intersection is detected
  91437. */
  91438. export type TrianglePickingPredicate = (p0: Vector3, p1: Vector3, p2: Vector3, ray: Ray) => boolean;
  91439. interface Scene {
  91440. /** @hidden */
  91441. _tempPickingRay: Nullable<Ray>;
  91442. /** @hidden */
  91443. _cachedRayForTransform: Ray;
  91444. /** @hidden */
  91445. _pickWithRayInverseMatrix: Matrix;
  91446. /** @hidden */
  91447. _internalPick(rayFunction: (world: Matrix) => Ray, predicate?: (mesh: AbstractMesh) => boolean, fastCheck?: boolean, onlyBoundingInfo?: boolean, trianglePredicate?: TrianglePickingPredicate): Nullable<PickingInfo>;
  91448. /** @hidden */
  91449. _internalMultiPick(rayFunction: (world: Matrix) => Ray, predicate?: (mesh: AbstractMesh) => boolean, trianglePredicate?: TrianglePickingPredicate): Nullable<PickingInfo[]>;
  91450. /** @hidden */
  91451. _internalPickForMesh(pickingInfo: Nullable<PickingInfo>, rayFunction: (world: Matrix) => Ray, mesh: AbstractMesh, world: Matrix, fastCheck?: boolean, onlyBoundingInfo?: boolean, trianglePredicate?: TrianglePickingPredicate): Nullable<PickingInfo>;
  91452. }
  91453. }
  91454. declare module BABYLON {
  91455. /**
  91456. * Groups all the scene component constants in one place to ease maintenance.
  91457. * @hidden
  91458. */
  91459. export class SceneComponentConstants {
  91460. static readonly NAME_EFFECTLAYER: string;
  91461. static readonly NAME_LAYER: string;
  91462. static readonly NAME_LENSFLARESYSTEM: string;
  91463. static readonly NAME_BOUNDINGBOXRENDERER: string;
  91464. static readonly NAME_PARTICLESYSTEM: string;
  91465. static readonly NAME_GAMEPAD: string;
  91466. static readonly NAME_SIMPLIFICATIONQUEUE: string;
  91467. static readonly NAME_GEOMETRYBUFFERRENDERER: string;
  91468. static readonly NAME_PREPASSRENDERER: string;
  91469. static readonly NAME_DEPTHRENDERER: string;
  91470. static readonly NAME_POSTPROCESSRENDERPIPELINEMANAGER: string;
  91471. static readonly NAME_SPRITE: string;
  91472. static readonly NAME_SUBSURFACE: string;
  91473. static readonly NAME_OUTLINERENDERER: string;
  91474. static readonly NAME_PROCEDURALTEXTURE: string;
  91475. static readonly NAME_SHADOWGENERATOR: string;
  91476. static readonly NAME_OCTREE: string;
  91477. static readonly NAME_PHYSICSENGINE: string;
  91478. static readonly NAME_AUDIO: string;
  91479. static readonly STEP_ISREADYFORMESH_EFFECTLAYER: number;
  91480. static readonly STEP_BEFOREEVALUATEACTIVEMESH_BOUNDINGBOXRENDERER: number;
  91481. static readonly STEP_EVALUATESUBMESH_BOUNDINGBOXRENDERER: number;
  91482. static readonly STEP_ACTIVEMESH_BOUNDINGBOXRENDERER: number;
  91483. static readonly STEP_CAMERADRAWRENDERTARGET_EFFECTLAYER: number;
  91484. static readonly STEP_BEFORECAMERADRAW_EFFECTLAYER: number;
  91485. static readonly STEP_BEFORECAMERADRAW_LAYER: number;
  91486. static readonly STEP_BEFORECAMERADRAW_PREPASS: number;
  91487. static readonly STEP_BEFORERENDERTARGETDRAW_LAYER: number;
  91488. static readonly STEP_BEFORERENDERINGMESH_OUTLINE: number;
  91489. static readonly STEP_AFTERRENDERINGMESH_OUTLINE: number;
  91490. static readonly STEP_AFTERRENDERINGGROUPDRAW_EFFECTLAYER_DRAW: number;
  91491. static readonly STEP_AFTERRENDERINGGROUPDRAW_BOUNDINGBOXRENDERER: number;
  91492. static readonly STEP_BEFORECAMERAUPDATE_SIMPLIFICATIONQUEUE: number;
  91493. static readonly STEP_BEFORECAMERAUPDATE_GAMEPAD: number;
  91494. static readonly STEP_BEFORECLEAR_PROCEDURALTEXTURE: number;
  91495. static readonly STEP_AFTERRENDERTARGETDRAW_LAYER: number;
  91496. static readonly STEP_AFTERCAMERADRAW_EFFECTLAYER: number;
  91497. static readonly STEP_AFTERCAMERADRAW_LENSFLARESYSTEM: number;
  91498. static readonly STEP_AFTERCAMERADRAW_EFFECTLAYER_DRAW: number;
  91499. static readonly STEP_AFTERCAMERADRAW_LAYER: number;
  91500. static readonly STEP_AFTERCAMERADRAW_PREPASS: number;
  91501. static readonly STEP_AFTERRENDER_AUDIO: number;
  91502. static readonly STEP_GATHERRENDERTARGETS_DEPTHRENDERER: number;
  91503. static readonly STEP_GATHERRENDERTARGETS_GEOMETRYBUFFERRENDERER: number;
  91504. static readonly STEP_GATHERRENDERTARGETS_SHADOWGENERATOR: number;
  91505. static readonly STEP_GATHERRENDERTARGETS_POSTPROCESSRENDERPIPELINEMANAGER: number;
  91506. static readonly STEP_GATHERACTIVECAMERARENDERTARGETS_DEPTHRENDERER: number;
  91507. static readonly STEP_BEFORECLEARSTAGE_PREPASS: number;
  91508. static readonly STEP_POINTERMOVE_SPRITE: number;
  91509. static readonly STEP_POINTERDOWN_SPRITE: number;
  91510. static readonly STEP_POINTERUP_SPRITE: number;
  91511. }
  91512. /**
  91513. * This represents a scene component.
  91514. *
  91515. * This is used to decouple the dependency the scene is having on the different workloads like
  91516. * layers, post processes...
  91517. */
  91518. export interface ISceneComponent {
  91519. /**
  91520. * The name of the component. Each component must have a unique name.
  91521. */
  91522. name: string;
  91523. /**
  91524. * The scene the component belongs to.
  91525. */
  91526. scene: Scene;
  91527. /**
  91528. * Register the component to one instance of a scene.
  91529. */
  91530. register(): void;
  91531. /**
  91532. * Rebuilds the elements related to this component in case of
  91533. * context lost for instance.
  91534. */
  91535. rebuild(): void;
  91536. /**
  91537. * Disposes the component and the associated ressources.
  91538. */
  91539. dispose(): void;
  91540. }
  91541. /**
  91542. * This represents a SERIALIZABLE scene component.
  91543. *
  91544. * This extends Scene Component to add Serialization methods on top.
  91545. */
  91546. export interface ISceneSerializableComponent extends ISceneComponent {
  91547. /**
  91548. * Adds all the elements from the container to the scene
  91549. * @param container the container holding the elements
  91550. */
  91551. addFromContainer(container: AbstractScene): void;
  91552. /**
  91553. * Removes all the elements in the container from the scene
  91554. * @param container contains the elements to remove
  91555. * @param dispose if the removed element should be disposed (default: false)
  91556. */
  91557. removeFromContainer(container: AbstractScene, dispose?: boolean): void;
  91558. /**
  91559. * Serializes the component data to the specified json object
  91560. * @param serializationObject The object to serialize to
  91561. */
  91562. serialize(serializationObject: any): void;
  91563. }
  91564. /**
  91565. * Strong typing of a Mesh related stage step action
  91566. */
  91567. export type MeshStageAction = (mesh: AbstractMesh, hardwareInstancedRendering: boolean) => boolean;
  91568. /**
  91569. * Strong typing of a Evaluate Sub Mesh related stage step action
  91570. */
  91571. export type EvaluateSubMeshStageAction = (mesh: AbstractMesh, subMesh: SubMesh) => void;
  91572. /**
  91573. * Strong typing of a Active Mesh related stage step action
  91574. */
  91575. export type ActiveMeshStageAction = (sourceMesh: AbstractMesh, mesh: AbstractMesh) => void;
  91576. /**
  91577. * Strong typing of a Camera related stage step action
  91578. */
  91579. export type CameraStageAction = (camera: Camera) => void;
  91580. /**
  91581. * Strong typing of a Camera Frame buffer related stage step action
  91582. */
  91583. export type CameraStageFrameBufferAction = (camera: Camera) => boolean;
  91584. /**
  91585. * Strong typing of a Render Target related stage step action
  91586. */
  91587. export type RenderTargetStageAction = (renderTarget: RenderTargetTexture) => void;
  91588. /**
  91589. * Strong typing of a RenderingGroup related stage step action
  91590. */
  91591. export type RenderingGroupStageAction = (renderingGroupId: number) => void;
  91592. /**
  91593. * Strong typing of a Mesh Render related stage step action
  91594. */
  91595. export type RenderingMeshStageAction = (mesh: Mesh, subMesh: SubMesh, batch: _InstancesBatch) => void;
  91596. /**
  91597. * Strong typing of a simple stage step action
  91598. */
  91599. export type SimpleStageAction = () => void;
  91600. /**
  91601. * Strong typing of a render target action.
  91602. */
  91603. export type RenderTargetsStageAction = (renderTargets: SmartArrayNoDuplicate<RenderTargetTexture>) => void;
  91604. /**
  91605. * Strong typing of a pointer move action.
  91606. */
  91607. export type PointerMoveStageAction = (unTranslatedPointerX: number, unTranslatedPointerY: number, pickResult: Nullable<PickingInfo>, isMeshPicked: boolean, element: HTMLElement) => Nullable<PickingInfo>;
  91608. /**
  91609. * Strong typing of a pointer up/down action.
  91610. */
  91611. export type PointerUpDownStageAction = (unTranslatedPointerX: number, unTranslatedPointerY: number, pickResult: Nullable<PickingInfo>, evt: PointerEvent) => Nullable<PickingInfo>;
  91612. /**
  91613. * Representation of a stage in the scene (Basically a list of ordered steps)
  91614. * @hidden
  91615. */
  91616. export class Stage<T extends Function> extends Array<{
  91617. index: number;
  91618. component: ISceneComponent;
  91619. action: T;
  91620. }> {
  91621. /**
  91622. * Hide ctor from the rest of the world.
  91623. * @param items The items to add.
  91624. */
  91625. private constructor();
  91626. /**
  91627. * Creates a new Stage.
  91628. * @returns A new instance of a Stage
  91629. */
  91630. static Create<T extends Function>(): Stage<T>;
  91631. /**
  91632. * Registers a step in an ordered way in the targeted stage.
  91633. * @param index Defines the position to register the step in
  91634. * @param component Defines the component attached to the step
  91635. * @param action Defines the action to launch during the step
  91636. */
  91637. registerStep(index: number, component: ISceneComponent, action: T): void;
  91638. /**
  91639. * Clears all the steps from the stage.
  91640. */
  91641. clear(): void;
  91642. }
  91643. }
  91644. declare module BABYLON {
  91645. interface Scene {
  91646. /** @hidden */
  91647. _pointerOverSprite: Nullable<Sprite>;
  91648. /** @hidden */
  91649. _pickedDownSprite: Nullable<Sprite>;
  91650. /** @hidden */
  91651. _tempSpritePickingRay: Nullable<Ray>;
  91652. /**
  91653. * All of the sprite managers added to this scene
  91654. * @see https://doc.babylonjs.com/babylon101/sprites
  91655. */
  91656. spriteManagers: Array<ISpriteManager>;
  91657. /**
  91658. * An event triggered when sprites rendering is about to start
  91659. * Note: This event can be trigger more than once per frame (because sprites can be rendered by render target textures as well)
  91660. */
  91661. onBeforeSpritesRenderingObservable: Observable<Scene>;
  91662. /**
  91663. * An event triggered when sprites rendering is done
  91664. * Note: This event can be trigger more than once per frame (because sprites can be rendered by render target textures as well)
  91665. */
  91666. onAfterSpritesRenderingObservable: Observable<Scene>;
  91667. /** @hidden */
  91668. _internalPickSprites(ray: Ray, predicate?: (sprite: Sprite) => boolean, fastCheck?: boolean, camera?: Camera): Nullable<PickingInfo>;
  91669. /** Launch a ray to try to pick a sprite in the scene
  91670. * @param x position on screen
  91671. * @param y position on screen
  91672. * @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
  91673. * @param fastCheck defines if the first intersection will be used (and not the closest)
  91674. * @param camera camera to use for computing the picking ray. Can be set to null. In this case, the scene.activeCamera will be used
  91675. * @returns a PickingInfo
  91676. */
  91677. pickSprite(x: number, y: number, predicate?: (sprite: Sprite) => boolean, fastCheck?: boolean, camera?: Camera): Nullable<PickingInfo>;
  91678. /** Use the given ray to pick a sprite in the scene
  91679. * @param ray The ray (in world space) to use to pick meshes
  91680. * @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
  91681. * @param fastCheck defines if the first intersection will be used (and not the closest)
  91682. * @param camera camera to use. Can be set to null. In this case, the scene.activeCamera will be used
  91683. * @returns a PickingInfo
  91684. */
  91685. pickSpriteWithRay(ray: Ray, predicate?: (sprite: Sprite) => boolean, fastCheck?: boolean, camera?: Camera): Nullable<PickingInfo>;
  91686. /** @hidden */
  91687. _internalMultiPickSprites(ray: Ray, predicate?: (sprite: Sprite) => boolean, camera?: Camera): Nullable<PickingInfo[]>;
  91688. /** Launch a ray to try to pick sprites in the scene
  91689. * @param x position on screen
  91690. * @param y position on screen
  91691. * @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
  91692. * @param camera camera to use for computing the picking ray. Can be set to null. In this case, the scene.activeCamera will be used
  91693. * @returns a PickingInfo array
  91694. */
  91695. multiPickSprite(x: number, y: number, predicate?: (sprite: Sprite) => boolean, camera?: Camera): Nullable<PickingInfo[]>;
  91696. /** Use the given ray to pick sprites in the scene
  91697. * @param ray The ray (in world space) to use to pick meshes
  91698. * @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
  91699. * @param camera camera to use. Can be set to null. In this case, the scene.activeCamera will be used
  91700. * @returns a PickingInfo array
  91701. */
  91702. multiPickSpriteWithRay(ray: Ray, predicate?: (sprite: Sprite) => boolean, camera?: Camera): Nullable<PickingInfo[]>;
  91703. /**
  91704. * Force the sprite under the pointer
  91705. * @param sprite defines the sprite to use
  91706. */
  91707. setPointerOverSprite(sprite: Nullable<Sprite>): void;
  91708. /**
  91709. * Gets the sprite under the pointer
  91710. * @returns a Sprite or null if no sprite is under the pointer
  91711. */
  91712. getPointerOverSprite(): Nullable<Sprite>;
  91713. }
  91714. /**
  91715. * Defines the sprite scene component responsible to manage sprites
  91716. * in a given scene.
  91717. */
  91718. export class SpriteSceneComponent implements ISceneComponent {
  91719. /**
  91720. * The component name helpfull to identify the component in the list of scene components.
  91721. */
  91722. readonly name: string;
  91723. /**
  91724. * The scene the component belongs to.
  91725. */
  91726. scene: Scene;
  91727. /** @hidden */
  91728. private _spritePredicate;
  91729. /**
  91730. * Creates a new instance of the component for the given scene
  91731. * @param scene Defines the scene to register the component in
  91732. */
  91733. constructor(scene: Scene);
  91734. /**
  91735. * Registers the component in a given scene
  91736. */
  91737. register(): void;
  91738. /**
  91739. * Rebuilds the elements related to this component in case of
  91740. * context lost for instance.
  91741. */
  91742. rebuild(): void;
  91743. /**
  91744. * Disposes the component and the associated ressources.
  91745. */
  91746. dispose(): void;
  91747. private _pickSpriteButKeepRay;
  91748. private _pointerMove;
  91749. private _pointerDown;
  91750. private _pointerUp;
  91751. }
  91752. }
  91753. declare module BABYLON {
  91754. /** @hidden */
  91755. export var fogFragmentDeclaration: {
  91756. name: string;
  91757. shader: string;
  91758. };
  91759. }
  91760. declare module BABYLON {
  91761. /** @hidden */
  91762. export var fogFragment: {
  91763. name: string;
  91764. shader: string;
  91765. };
  91766. }
  91767. declare module BABYLON {
  91768. /** @hidden */
  91769. export var imageProcessingCompatibility: {
  91770. name: string;
  91771. shader: string;
  91772. };
  91773. }
  91774. declare module BABYLON {
  91775. /** @hidden */
  91776. export var spritesPixelShader: {
  91777. name: string;
  91778. shader: string;
  91779. };
  91780. }
  91781. declare module BABYLON {
  91782. /** @hidden */
  91783. export var fogVertexDeclaration: {
  91784. name: string;
  91785. shader: string;
  91786. };
  91787. }
  91788. declare module BABYLON {
  91789. /** @hidden */
  91790. export var spritesVertexShader: {
  91791. name: string;
  91792. shader: string;
  91793. };
  91794. }
  91795. declare module BABYLON {
  91796. /**
  91797. * Defines the minimum interface to fullfil in order to be a sprite manager.
  91798. */
  91799. export interface ISpriteManager extends IDisposable {
  91800. /**
  91801. * Gets manager's name
  91802. */
  91803. name: string;
  91804. /**
  91805. * Restricts the camera to viewing objects with the same layerMask.
  91806. * A camera with a layerMask of 1 will render spriteManager.layerMask & camera.layerMask!== 0
  91807. */
  91808. layerMask: number;
  91809. /**
  91810. * Gets or sets a boolean indicating if the mesh can be picked (by scene.pick for instance or through actions). Default is true
  91811. */
  91812. isPickable: boolean;
  91813. /**
  91814. * Gets the hosting scene
  91815. */
  91816. scene: Scene;
  91817. /**
  91818. * Specifies the rendering group id for this mesh (0 by default)
  91819. * @see https://doc.babylonjs.com/resources/transparency_and_how_meshes_are_rendered#rendering-groups
  91820. */
  91821. renderingGroupId: number;
  91822. /**
  91823. * Defines the list of sprites managed by the manager.
  91824. */
  91825. sprites: Array<Sprite>;
  91826. /**
  91827. * Gets or sets the spritesheet texture
  91828. */
  91829. texture: Texture;
  91830. /** Defines the default width of a cell in the spritesheet */
  91831. cellWidth: number;
  91832. /** Defines the default height of a cell in the spritesheet */
  91833. cellHeight: number;
  91834. /**
  91835. * Tests the intersection of a sprite with a specific ray.
  91836. * @param ray The ray we are sending to test the collision
  91837. * @param camera The camera space we are sending rays in
  91838. * @param predicate A predicate allowing excluding sprites from the list of object to test
  91839. * @param fastCheck defines if the first intersection will be used (and not the closest)
  91840. * @returns picking info or null.
  91841. */
  91842. intersects(ray: Ray, camera: Camera, predicate?: (sprite: Sprite) => boolean, fastCheck?: boolean): Nullable<PickingInfo>;
  91843. /**
  91844. * Intersects the sprites with a ray
  91845. * @param ray defines the ray to intersect with
  91846. * @param camera defines the current active camera
  91847. * @param predicate defines a predicate used to select candidate sprites
  91848. * @returns null if no hit or a PickingInfo array
  91849. */
  91850. multiIntersects(ray: Ray, camera: Camera, predicate?: (sprite: Sprite) => boolean): Nullable<PickingInfo[]>;
  91851. /**
  91852. * Renders the list of sprites on screen.
  91853. */
  91854. render(): void;
  91855. }
  91856. /**
  91857. * Class used to manage multiple sprites on the same spritesheet
  91858. * @see https://doc.babylonjs.com/babylon101/sprites
  91859. */
  91860. export class SpriteManager implements ISpriteManager {
  91861. /** defines the manager's name */
  91862. name: string;
  91863. /** Define the Url to load snippets */
  91864. static SnippetUrl: string;
  91865. /** Snippet ID if the manager was created from the snippet server */
  91866. snippetId: string;
  91867. /** Gets the list of sprites */
  91868. sprites: Sprite[];
  91869. /** Gets or sets the rendering group id (0 by default) */
  91870. renderingGroupId: number;
  91871. /** Gets or sets camera layer mask */
  91872. layerMask: number;
  91873. /** Gets or sets a boolean indicating if the manager must consider scene fog when rendering */
  91874. fogEnabled: boolean;
  91875. /** Gets or sets a boolean indicating if the sprites are pickable */
  91876. isPickable: boolean;
  91877. /** Defines the default width of a cell in the spritesheet */
  91878. cellWidth: number;
  91879. /** Defines the default height of a cell in the spritesheet */
  91880. cellHeight: number;
  91881. /** Associative array from JSON sprite data file */
  91882. private _cellData;
  91883. /** Array of sprite names from JSON sprite data file */
  91884. private _spriteMap;
  91885. /** True when packed cell data from JSON file is ready*/
  91886. private _packedAndReady;
  91887. private _textureContent;
  91888. private _useInstancing;
  91889. /**
  91890. * An event triggered when the manager is disposed.
  91891. */
  91892. onDisposeObservable: Observable<SpriteManager>;
  91893. private _onDisposeObserver;
  91894. /**
  91895. * Callback called when the manager is disposed
  91896. */
  91897. set onDispose(callback: () => void);
  91898. private _capacity;
  91899. private _fromPacked;
  91900. private _spriteTexture;
  91901. private _epsilon;
  91902. private _scene;
  91903. private _vertexData;
  91904. private _buffer;
  91905. private _vertexBuffers;
  91906. private _spriteBuffer;
  91907. private _indexBuffer;
  91908. private _effectBase;
  91909. private _effectFog;
  91910. private _vertexBufferSize;
  91911. /**
  91912. * Gets or sets the unique id of the sprite
  91913. */
  91914. uniqueId: number;
  91915. /**
  91916. * Gets the array of sprites
  91917. */
  91918. get children(): Sprite[];
  91919. /**
  91920. * Gets the hosting scene
  91921. */
  91922. get scene(): Scene;
  91923. /**
  91924. * Gets the capacity of the manager
  91925. */
  91926. get capacity(): number;
  91927. /**
  91928. * Gets or sets the spritesheet texture
  91929. */
  91930. get texture(): Texture;
  91931. set texture(value: Texture);
  91932. private _blendMode;
  91933. /**
  91934. * Blend mode use to render the particle, it can be any of
  91935. * the static Constants.ALPHA_x properties provided in this class.
  91936. * Default value is Constants.ALPHA_COMBINE
  91937. */
  91938. get blendMode(): number;
  91939. set blendMode(blendMode: number);
  91940. /** Disables writing to the depth buffer when rendering the sprites.
  91941. * It can be handy to disable depth writing when using textures without alpha channel
  91942. * and setting some specific blend modes.
  91943. */
  91944. disableDepthWrite: boolean;
  91945. /**
  91946. * Creates a new sprite manager
  91947. * @param name defines the manager's name
  91948. * @param imgUrl defines the sprite sheet url
  91949. * @param capacity defines the maximum allowed number of sprites
  91950. * @param cellSize defines the size of a sprite cell
  91951. * @param scene defines the hosting scene
  91952. * @param epsilon defines the epsilon value to align texture (0.01 by default)
  91953. * @param samplingMode defines the smapling mode to use with spritesheet
  91954. * @param fromPacked set to false; do not alter
  91955. * @param spriteJSON null otherwise a JSON object defining sprite sheet data; do not alter
  91956. */
  91957. constructor(
  91958. /** defines the manager's name */
  91959. name: string, imgUrl: string, capacity: number, cellSize: any, scene: Scene, epsilon?: number, samplingMode?: number, fromPacked?: boolean, spriteJSON?: any | null);
  91960. /**
  91961. * Returns the string "SpriteManager"
  91962. * @returns "SpriteManager"
  91963. */
  91964. getClassName(): string;
  91965. private _makePacked;
  91966. private _appendSpriteVertex;
  91967. private _checkTextureAlpha;
  91968. /**
  91969. * Intersects the sprites with a ray
  91970. * @param ray defines the ray to intersect with
  91971. * @param camera defines the current active camera
  91972. * @param predicate defines a predicate used to select candidate sprites
  91973. * @param fastCheck defines if a fast check only must be done (the first potential sprite is will be used and not the closer)
  91974. * @returns null if no hit or a PickingInfo
  91975. */
  91976. intersects(ray: Ray, camera: Camera, predicate?: (sprite: Sprite) => boolean, fastCheck?: boolean): Nullable<PickingInfo>;
  91977. /**
  91978. * Intersects the sprites with a ray
  91979. * @param ray defines the ray to intersect with
  91980. * @param camera defines the current active camera
  91981. * @param predicate defines a predicate used to select candidate sprites
  91982. * @returns null if no hit or a PickingInfo array
  91983. */
  91984. multiIntersects(ray: Ray, camera: Camera, predicate?: (sprite: Sprite) => boolean): Nullable<PickingInfo[]>;
  91985. /**
  91986. * Render all child sprites
  91987. */
  91988. render(): void;
  91989. /**
  91990. * Release associated resources
  91991. */
  91992. dispose(): void;
  91993. /**
  91994. * Serializes the sprite manager to a JSON object
  91995. * @param serializeTexture defines if the texture must be serialized as well
  91996. * @returns the JSON object
  91997. */
  91998. serialize(serializeTexture?: boolean): any;
  91999. /**
  92000. * Parses a JSON object to create a new sprite manager.
  92001. * @param parsedManager The JSON object to parse
  92002. * @param scene The scene to create the sprite managerin
  92003. * @param rootUrl The root url to use to load external dependencies like texture
  92004. * @returns the new sprite manager
  92005. */
  92006. static Parse(parsedManager: any, scene: Scene, rootUrl: string): SpriteManager;
  92007. /**
  92008. * Creates a sprite manager from a snippet saved in a remote file
  92009. * @param name defines the name of the sprite manager to create (can be null or empty to use the one from the json data)
  92010. * @param url defines the url to load from
  92011. * @param scene defines the hosting scene
  92012. * @param rootUrl defines the root URL to use to load textures and relative dependencies
  92013. * @returns a promise that will resolve to the new sprite manager
  92014. */
  92015. static ParseFromFileAsync(name: Nullable<string>, url: string, scene: Scene, rootUrl?: string): Promise<SpriteManager>;
  92016. /**
  92017. * Creates a sprite manager from a snippet saved by the sprite editor
  92018. * @param snippetId defines the snippet to load (can be set to _BLANK to create a default one)
  92019. * @param scene defines the hosting scene
  92020. * @param rootUrl defines the root URL to use to load textures and relative dependencies
  92021. * @returns a promise that will resolve to the new sprite manager
  92022. */
  92023. static CreateFromSnippetAsync(snippetId: string, scene: Scene, rootUrl?: string): Promise<SpriteManager>;
  92024. }
  92025. }
  92026. declare module BABYLON {
  92027. /** Interface used by value gradients (color, factor, ...) */
  92028. export interface IValueGradient {
  92029. /**
  92030. * Gets or sets the gradient value (between 0 and 1)
  92031. */
  92032. gradient: number;
  92033. }
  92034. /** Class used to store color4 gradient */
  92035. export class ColorGradient implements IValueGradient {
  92036. /**
  92037. * Gets or sets the gradient value (between 0 and 1)
  92038. */
  92039. gradient: number;
  92040. /**
  92041. * Gets or sets first associated color
  92042. */
  92043. color1: Color4;
  92044. /**
  92045. * Gets or sets second associated color
  92046. */
  92047. color2?: Color4 | undefined;
  92048. /**
  92049. * Creates a new color4 gradient
  92050. * @param gradient gets or sets the gradient value (between 0 and 1)
  92051. * @param color1 gets or sets first associated color
  92052. * @param color2 gets or sets first second color
  92053. */
  92054. constructor(
  92055. /**
  92056. * Gets or sets the gradient value (between 0 and 1)
  92057. */
  92058. gradient: number,
  92059. /**
  92060. * Gets or sets first associated color
  92061. */
  92062. color1: Color4,
  92063. /**
  92064. * Gets or sets second associated color
  92065. */
  92066. color2?: Color4 | undefined);
  92067. /**
  92068. * Will get a color picked randomly between color1 and color2.
  92069. * If color2 is undefined then color1 will be used
  92070. * @param result defines the target Color4 to store the result in
  92071. */
  92072. getColorToRef(result: Color4): void;
  92073. }
  92074. /** Class used to store color 3 gradient */
  92075. export class Color3Gradient implements IValueGradient {
  92076. /**
  92077. * Gets or sets the gradient value (between 0 and 1)
  92078. */
  92079. gradient: number;
  92080. /**
  92081. * Gets or sets the associated color
  92082. */
  92083. color: Color3;
  92084. /**
  92085. * Creates a new color3 gradient
  92086. * @param gradient gets or sets the gradient value (between 0 and 1)
  92087. * @param color gets or sets associated color
  92088. */
  92089. constructor(
  92090. /**
  92091. * Gets or sets the gradient value (between 0 and 1)
  92092. */
  92093. gradient: number,
  92094. /**
  92095. * Gets or sets the associated color
  92096. */
  92097. color: Color3);
  92098. }
  92099. /** Class used to store factor gradient */
  92100. export class FactorGradient implements IValueGradient {
  92101. /**
  92102. * Gets or sets the gradient value (between 0 and 1)
  92103. */
  92104. gradient: number;
  92105. /**
  92106. * Gets or sets first associated factor
  92107. */
  92108. factor1: number;
  92109. /**
  92110. * Gets or sets second associated factor
  92111. */
  92112. factor2?: number | undefined;
  92113. /**
  92114. * Creates a new factor gradient
  92115. * @param gradient gets or sets the gradient value (between 0 and 1)
  92116. * @param factor1 gets or sets first associated factor
  92117. * @param factor2 gets or sets second associated factor
  92118. */
  92119. constructor(
  92120. /**
  92121. * Gets or sets the gradient value (between 0 and 1)
  92122. */
  92123. gradient: number,
  92124. /**
  92125. * Gets or sets first associated factor
  92126. */
  92127. factor1: number,
  92128. /**
  92129. * Gets or sets second associated factor
  92130. */
  92131. factor2?: number | undefined);
  92132. /**
  92133. * Will get a number picked randomly between factor1 and factor2.
  92134. * If factor2 is undefined then factor1 will be used
  92135. * @returns the picked number
  92136. */
  92137. getFactor(): number;
  92138. }
  92139. /**
  92140. * Helper used to simplify some generic gradient tasks
  92141. */
  92142. export class GradientHelper {
  92143. /**
  92144. * Gets the current gradient from an array of IValueGradient
  92145. * @param ratio defines the current ratio to get
  92146. * @param gradients defines the array of IValueGradient
  92147. * @param updateFunc defines the callback function used to get the final value from the selected gradients
  92148. */
  92149. static GetCurrentGradient(ratio: number, gradients: IValueGradient[], updateFunc: (current: IValueGradient, next: IValueGradient, scale: number) => void): void;
  92150. }
  92151. }
  92152. declare module BABYLON {
  92153. interface ThinEngine {
  92154. /**
  92155. * Creates a raw texture
  92156. * @param data defines the data to store in the texture
  92157. * @param width defines the width of the texture
  92158. * @param height defines the height of the texture
  92159. * @param format defines the format of the data
  92160. * @param generateMipMaps defines if the engine should generate the mip levels
  92161. * @param invertY defines if data must be stored with Y axis inverted
  92162. * @param samplingMode defines the required sampling mode (Texture.NEAREST_SAMPLINGMODE by default)
  92163. * @param compression defines the compression used (null by default)
  92164. * @param type defines the type fo the data (Engine.TEXTURETYPE_UNSIGNED_INT by default)
  92165. * @returns the raw texture inside an InternalTexture
  92166. */
  92167. createRawTexture(data: Nullable<ArrayBufferView>, width: number, height: number, format: number, generateMipMaps: boolean, invertY: boolean, samplingMode: number, compression: Nullable<string>, type: number): InternalTexture;
  92168. /**
  92169. * Update a raw texture
  92170. * @param texture defines the texture to update
  92171. * @param data defines the data to store in the texture
  92172. * @param format defines the format of the data
  92173. * @param invertY defines if data must be stored with Y axis inverted
  92174. */
  92175. updateRawTexture(texture: Nullable<InternalTexture>, data: Nullable<ArrayBufferView>, format: number, invertY: boolean): void;
  92176. /**
  92177. * Update a raw texture
  92178. * @param texture defines the texture to update
  92179. * @param data defines the data to store in the texture
  92180. * @param format defines the format of the data
  92181. * @param invertY defines if data must be stored with Y axis inverted
  92182. * @param compression defines the compression used (null by default)
  92183. * @param type defines the type fo the data (Engine.TEXTURETYPE_UNSIGNED_INT by default)
  92184. */
  92185. updateRawTexture(texture: Nullable<InternalTexture>, data: Nullable<ArrayBufferView>, format: number, invertY: boolean, compression: Nullable<string>, type: number): void;
  92186. /**
  92187. * Creates a new raw cube texture
  92188. * @param data defines the array of data to use to create each face
  92189. * @param size defines the size of the textures
  92190. * @param format defines the format of the data
  92191. * @param type defines the type of the data (like Engine.TEXTURETYPE_UNSIGNED_INT)
  92192. * @param generateMipMaps defines if the engine should generate the mip levels
  92193. * @param invertY defines if data must be stored with Y axis inverted
  92194. * @param samplingMode defines the required sampling mode (like Texture.NEAREST_SAMPLINGMODE)
  92195. * @param compression defines the compression used (null by default)
  92196. * @returns the cube texture as an InternalTexture
  92197. */
  92198. createRawCubeTexture(data: Nullable<ArrayBufferView[]>, size: number, format: number, type: number, generateMipMaps: boolean, invertY: boolean, samplingMode: number, compression: Nullable<string>): InternalTexture;
  92199. /**
  92200. * Update a raw cube texture
  92201. * @param texture defines the texture to udpdate
  92202. * @param data defines the data to store
  92203. * @param format defines the data format
  92204. * @param type defines the type fo the data (Engine.TEXTURETYPE_UNSIGNED_INT by default)
  92205. * @param invertY defines if data must be stored with Y axis inverted
  92206. */
  92207. updateRawCubeTexture(texture: InternalTexture, data: ArrayBufferView[], format: number, type: number, invertY: boolean): void;
  92208. /**
  92209. * Update a raw cube texture
  92210. * @param texture defines the texture to udpdate
  92211. * @param data defines the data to store
  92212. * @param format defines the data format
  92213. * @param type defines the type fo the data (Engine.TEXTURETYPE_UNSIGNED_INT by default)
  92214. * @param invertY defines if data must be stored with Y axis inverted
  92215. * @param compression defines the compression used (null by default)
  92216. */
  92217. updateRawCubeTexture(texture: InternalTexture, data: ArrayBufferView[], format: number, type: number, invertY: boolean, compression: Nullable<string>): void;
  92218. /**
  92219. * Update a raw cube texture
  92220. * @param texture defines the texture to udpdate
  92221. * @param data defines the data to store
  92222. * @param format defines the data format
  92223. * @param type defines the type fo the data (Engine.TEXTURETYPE_UNSIGNED_INT by default)
  92224. * @param invertY defines if data must be stored with Y axis inverted
  92225. * @param compression defines the compression used (null by default)
  92226. * @param level defines which level of the texture to update
  92227. */
  92228. updateRawCubeTexture(texture: InternalTexture, data: ArrayBufferView[], format: number, type: number, invertY: boolean, compression: Nullable<string>, level: number): void;
  92229. /**
  92230. * Creates a new raw cube texture from a specified url
  92231. * @param url defines the url where the data is located
  92232. * @param scene defines the current scene
  92233. * @param size defines the size of the textures
  92234. * @param format defines the format of the data
  92235. * @param type defines the type fo the data (like Engine.TEXTURETYPE_UNSIGNED_INT)
  92236. * @param noMipmap defines if the engine should avoid generating the mip levels
  92237. * @param callback defines a callback used to extract texture data from loaded data
  92238. * @param mipmapGenerator defines to provide an optional tool to generate mip levels
  92239. * @param onLoad defines a callback called when texture is loaded
  92240. * @param onError defines a callback called if there is an error
  92241. * @returns the cube texture as an InternalTexture
  92242. */
  92243. 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;
  92244. /**
  92245. * Creates a new raw cube texture from a specified url
  92246. * @param url defines the url where the data is located
  92247. * @param scene defines the current scene
  92248. * @param size defines the size of the textures
  92249. * @param format defines the format of the data
  92250. * @param type defines the type fo the data (like Engine.TEXTURETYPE_UNSIGNED_INT)
  92251. * @param noMipmap defines if the engine should avoid generating the mip levels
  92252. * @param callback defines a callback used to extract texture data from loaded data
  92253. * @param mipmapGenerator defines to provide an optional tool to generate mip levels
  92254. * @param onLoad defines a callback called when texture is loaded
  92255. * @param onError defines a callback called if there is an error
  92256. * @param samplingMode defines the required sampling mode (like Texture.NEAREST_SAMPLINGMODE)
  92257. * @param invertY defines if data must be stored with Y axis inverted
  92258. * @returns the cube texture as an InternalTexture
  92259. */
  92260. 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;
  92261. /**
  92262. * Creates a new raw 3D texture
  92263. * @param data defines the data used to create the texture
  92264. * @param width defines the width of the texture
  92265. * @param height defines the height of the texture
  92266. * @param depth defines the depth of the texture
  92267. * @param format defines the format of the texture
  92268. * @param generateMipMaps defines if the engine must generate mip levels
  92269. * @param invertY defines if data must be stored with Y axis inverted
  92270. * @param samplingMode defines the required sampling mode (like Texture.NEAREST_SAMPLINGMODE)
  92271. * @param compression defines the compressed used (can be null)
  92272. * @param textureType defines the compressed used (can be null)
  92273. * @returns a new raw 3D texture (stored in an InternalTexture)
  92274. */
  92275. createRawTexture3D(data: Nullable<ArrayBufferView>, width: number, height: number, depth: number, format: number, generateMipMaps: boolean, invertY: boolean, samplingMode: number, compression: Nullable<string>, textureType: number): InternalTexture;
  92276. /**
  92277. * Update a raw 3D texture
  92278. * @param texture defines the texture to update
  92279. * @param data defines the data to store
  92280. * @param format defines the data format
  92281. * @param invertY defines if data must be stored with Y axis inverted
  92282. */
  92283. updateRawTexture3D(texture: InternalTexture, data: Nullable<ArrayBufferView>, format: number, invertY: boolean): void;
  92284. /**
  92285. * Update a raw 3D texture
  92286. * @param texture defines the texture to update
  92287. * @param data defines the data to store
  92288. * @param format defines the data format
  92289. * @param invertY defines if data must be stored with Y axis inverted
  92290. * @param compression defines the used compression (can be null)
  92291. * @param textureType defines the texture Type (Engine.TEXTURETYPE_UNSIGNED_INT, Engine.TEXTURETYPE_FLOAT...)
  92292. */
  92293. updateRawTexture3D(texture: InternalTexture, data: Nullable<ArrayBufferView>, format: number, invertY: boolean, compression: Nullable<string>, textureType: number): void;
  92294. /**
  92295. * Creates a new raw 2D array texture
  92296. * @param data defines the data used to create the texture
  92297. * @param width defines the width of the texture
  92298. * @param height defines the height of the texture
  92299. * @param depth defines the number of layers of the texture
  92300. * @param format defines the format of the texture
  92301. * @param generateMipMaps defines if the engine must generate mip levels
  92302. * @param invertY defines if data must be stored with Y axis inverted
  92303. * @param samplingMode defines the required sampling mode (like Texture.NEAREST_SAMPLINGMODE)
  92304. * @param compression defines the compressed used (can be null)
  92305. * @param textureType defines the compressed used (can be null)
  92306. * @returns a new raw 2D array texture (stored in an InternalTexture)
  92307. */
  92308. createRawTexture2DArray(data: Nullable<ArrayBufferView>, width: number, height: number, depth: number, format: number, generateMipMaps: boolean, invertY: boolean, samplingMode: number, compression: Nullable<string>, textureType: number): InternalTexture;
  92309. /**
  92310. * Update a raw 2D array texture
  92311. * @param texture defines the texture to update
  92312. * @param data defines the data to store
  92313. * @param format defines the data format
  92314. * @param invertY defines if data must be stored with Y axis inverted
  92315. */
  92316. updateRawTexture2DArray(texture: InternalTexture, data: Nullable<ArrayBufferView>, format: number, invertY: boolean): void;
  92317. /**
  92318. * Update a raw 2D array texture
  92319. * @param texture defines the texture to update
  92320. * @param data defines the data to store
  92321. * @param format defines the data format
  92322. * @param invertY defines if data must be stored with Y axis inverted
  92323. * @param compression defines the used compression (can be null)
  92324. * @param textureType defines the texture Type (Engine.TEXTURETYPE_UNSIGNED_INT, Engine.TEXTURETYPE_FLOAT...)
  92325. */
  92326. updateRawTexture2DArray(texture: InternalTexture, data: Nullable<ArrayBufferView>, format: number, invertY: boolean, compression: Nullable<string>, textureType: number): void;
  92327. }
  92328. }
  92329. declare module BABYLON {
  92330. /**
  92331. * Raw texture can help creating a texture directly from an array of data.
  92332. * This can be super useful if you either get the data from an uncompressed source or
  92333. * if you wish to create your texture pixel by pixel.
  92334. */
  92335. export class RawTexture extends Texture {
  92336. /**
  92337. * Define the format of the data (RGB, RGBA... Engine.TEXTUREFORMAT_xxx)
  92338. */
  92339. format: number;
  92340. /**
  92341. * Instantiates a new RawTexture.
  92342. * Raw texture can help creating a texture directly from an array of data.
  92343. * This can be super useful if you either get the data from an uncompressed source or
  92344. * if you wish to create your texture pixel by pixel.
  92345. * @param data define the array of data to use to create the texture
  92346. * @param width define the width of the texture
  92347. * @param height define the height of the texture
  92348. * @param format define the format of the data (RGB, RGBA... Engine.TEXTUREFORMAT_xxx)
  92349. * @param sceneOrEngine defines the scene or engine the texture will belong to
  92350. * @param generateMipMaps define whether mip maps should be generated or not
  92351. * @param invertY define if the data should be flipped on Y when uploaded to the GPU
  92352. * @param samplingMode define the texture sampling mode (Texture.xxx_SAMPLINGMODE)
  92353. * @param type define the format of the data (int, float... Engine.TEXTURETYPE_xxx)
  92354. */
  92355. constructor(data: ArrayBufferView, width: number, height: number,
  92356. /**
  92357. * Define the format of the data (RGB, RGBA... Engine.TEXTUREFORMAT_xxx)
  92358. */
  92359. format: number, sceneOrEngine: Nullable<Scene | ThinEngine>, generateMipMaps?: boolean, invertY?: boolean, samplingMode?: number, type?: number);
  92360. /**
  92361. * Updates the texture underlying data.
  92362. * @param data Define the new data of the texture
  92363. */
  92364. update(data: ArrayBufferView): void;
  92365. /**
  92366. * Creates a luminance texture from some data.
  92367. * @param data Define the texture data
  92368. * @param width Define the width of the texture
  92369. * @param height Define the height of the texture
  92370. * @param sceneOrEngine defines the scene or engine the texture will belong to
  92371. * @param generateMipMaps Define whether or not to create mip maps for the texture
  92372. * @param invertY define if the data should be flipped on Y when uploaded to the GPU
  92373. * @param samplingMode define the texture sampling mode (Texture.xxx_SAMPLINGMODE)
  92374. * @returns the luminance texture
  92375. */
  92376. static CreateLuminanceTexture(data: ArrayBufferView, width: number, height: number, sceneOrEngine: Nullable<Scene | ThinEngine>, generateMipMaps?: boolean, invertY?: boolean, samplingMode?: number): RawTexture;
  92377. /**
  92378. * Creates a luminance alpha texture from some data.
  92379. * @param data Define the texture data
  92380. * @param width Define the width of the texture
  92381. * @param height Define the height of the texture
  92382. * @param sceneOrEngine defines the scene or engine the texture will belong to
  92383. * @param generateMipMaps Define whether or not to create mip maps for the texture
  92384. * @param invertY define if the data should be flipped on Y when uploaded to the GPU
  92385. * @param samplingMode define the texture sampling mode (Texture.xxx_SAMPLINGMODE)
  92386. * @returns the luminance alpha texture
  92387. */
  92388. static CreateLuminanceAlphaTexture(data: ArrayBufferView, width: number, height: number, sceneOrEngine: Nullable<Scene | ThinEngine>, generateMipMaps?: boolean, invertY?: boolean, samplingMode?: number): RawTexture;
  92389. /**
  92390. * Creates an alpha texture from some data.
  92391. * @param data Define the texture data
  92392. * @param width Define the width of the texture
  92393. * @param height Define the height of the texture
  92394. * @param sceneOrEngine defines the scene or engine the texture will belong to
  92395. * @param generateMipMaps Define whether or not to create mip maps for the texture
  92396. * @param invertY define if the data should be flipped on Y when uploaded to the GPU
  92397. * @param samplingMode define the texture sampling mode (Texture.xxx_SAMPLINGMODE)
  92398. * @returns the alpha texture
  92399. */
  92400. static CreateAlphaTexture(data: ArrayBufferView, width: number, height: number, sceneOrEngine: Nullable<Scene | ThinEngine>, generateMipMaps?: boolean, invertY?: boolean, samplingMode?: number): RawTexture;
  92401. /**
  92402. * Creates a RGB texture from some data.
  92403. * @param data Define the texture data
  92404. * @param width Define the width of the texture
  92405. * @param height Define the height of the texture
  92406. * @param sceneOrEngine defines the scene or engine the texture will belong to
  92407. * @param generateMipMaps Define whether or not to create mip maps for the texture
  92408. * @param invertY define if the data should be flipped on Y when uploaded to the GPU
  92409. * @param samplingMode define the texture sampling mode (Texture.xxx_SAMPLINGMODE)
  92410. * @param type define the format of the data (int, float... Engine.TEXTURETYPE_xxx)
  92411. * @returns the RGB alpha texture
  92412. */
  92413. static CreateRGBTexture(data: ArrayBufferView, width: number, height: number, sceneOrEngine: Nullable<Scene | ThinEngine>, generateMipMaps?: boolean, invertY?: boolean, samplingMode?: number, type?: number): RawTexture;
  92414. /**
  92415. * Creates a RGBA texture from some data.
  92416. * @param data Define the texture data
  92417. * @param width Define the width of the texture
  92418. * @param height Define the height of the texture
  92419. * @param sceneOrEngine defines the scene or engine the texture will belong to
  92420. * @param generateMipMaps Define whether or not to create mip maps for the texture
  92421. * @param invertY define if the data should be flipped on Y when uploaded to the GPU
  92422. * @param samplingMode define the texture sampling mode (Texture.xxx_SAMPLINGMODE)
  92423. * @param type define the format of the data (int, float... Engine.TEXTURETYPE_xxx)
  92424. * @returns the RGBA texture
  92425. */
  92426. static CreateRGBATexture(data: ArrayBufferView, width: number, height: number, sceneOrEngine: Nullable<Scene | ThinEngine>, generateMipMaps?: boolean, invertY?: boolean, samplingMode?: number, type?: number): RawTexture;
  92427. /**
  92428. * Creates a R texture from some data.
  92429. * @param data Define the texture data
  92430. * @param width Define the width of the texture
  92431. * @param height Define the height of the texture
  92432. * @param sceneOrEngine defines the scene or engine the texture will belong to
  92433. * @param generateMipMaps Define whether or not to create mip maps for the texture
  92434. * @param invertY define if the data should be flipped on Y when uploaded to the GPU
  92435. * @param samplingMode define the texture sampling mode (Texture.xxx_SAMPLINGMODE)
  92436. * @param type define the format of the data (int, float... Engine.TEXTURETYPE_xxx)
  92437. * @returns the R texture
  92438. */
  92439. static CreateRTexture(data: ArrayBufferView, width: number, height: number, sceneOrEngine: Nullable<Scene | ThinEngine>, generateMipMaps?: boolean, invertY?: boolean, samplingMode?: number, type?: number): RawTexture;
  92440. }
  92441. }
  92442. declare module BABYLON {
  92443. interface ThinEngine {
  92444. /**
  92445. * Update a dynamic index buffer
  92446. * @param indexBuffer defines the target index buffer
  92447. * @param indices defines the data to update
  92448. * @param offset defines the offset in the target index buffer where update should start
  92449. */
  92450. updateDynamicIndexBuffer(indexBuffer: DataBuffer, indices: IndicesArray, offset?: number): void;
  92451. /**
  92452. * Updates a dynamic vertex buffer.
  92453. * @param vertexBuffer the vertex buffer to update
  92454. * @param data the data used to update the vertex buffer
  92455. * @param byteOffset the byte offset of the data
  92456. * @param byteLength the byte length of the data
  92457. */
  92458. updateDynamicVertexBuffer(vertexBuffer: DataBuffer, data: DataArray, byteOffset?: number, byteLength?: number): void;
  92459. }
  92460. }
  92461. declare module BABYLON {
  92462. interface AbstractScene {
  92463. /**
  92464. * The list of procedural textures added to the scene
  92465. * @see https://doc.babylonjs.com/how_to/how_to_use_procedural_textures
  92466. */
  92467. proceduralTextures: Array<ProceduralTexture>;
  92468. }
  92469. /**
  92470. * Defines the Procedural Texture scene component responsible to manage any Procedural Texture
  92471. * in a given scene.
  92472. */
  92473. export class ProceduralTextureSceneComponent implements ISceneComponent {
  92474. /**
  92475. * The component name helpfull to identify the component in the list of scene components.
  92476. */
  92477. readonly name: string;
  92478. /**
  92479. * The scene the component belongs to.
  92480. */
  92481. scene: Scene;
  92482. /**
  92483. * Creates a new instance of the component for the given scene
  92484. * @param scene Defines the scene to register the component in
  92485. */
  92486. constructor(scene: Scene);
  92487. /**
  92488. * Registers the component in a given scene
  92489. */
  92490. register(): void;
  92491. /**
  92492. * Rebuilds the elements related to this component in case of
  92493. * context lost for instance.
  92494. */
  92495. rebuild(): void;
  92496. /**
  92497. * Disposes the component and the associated ressources.
  92498. */
  92499. dispose(): void;
  92500. private _beforeClear;
  92501. }
  92502. }
  92503. declare module BABYLON {
  92504. interface ThinEngine {
  92505. /**
  92506. * Creates a new render target cube texture
  92507. * @param size defines the size of the texture
  92508. * @param options defines the options used to create the texture
  92509. * @returns a new render target cube texture stored in an InternalTexture
  92510. */
  92511. createRenderTargetCubeTexture(size: number, options?: Partial<RenderTargetCreationOptions>): InternalTexture;
  92512. }
  92513. }
  92514. declare module BABYLON {
  92515. /** @hidden */
  92516. export var proceduralVertexShader: {
  92517. name: string;
  92518. shader: string;
  92519. };
  92520. }
  92521. declare module BABYLON {
  92522. /**
  92523. * 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.
  92524. * This is the base class of any Procedural texture and contains most of the shareable code.
  92525. * @see https://doc.babylonjs.com/how_to/how_to_use_procedural_textures
  92526. */
  92527. export class ProceduralTexture extends Texture {
  92528. /**
  92529. * Define if the texture is enabled or not (disabled texture will not render)
  92530. */
  92531. isEnabled: boolean;
  92532. /**
  92533. * Define if the texture must be cleared before rendering (default is true)
  92534. */
  92535. autoClear: boolean;
  92536. /**
  92537. * Callback called when the texture is generated
  92538. */
  92539. onGenerated: () => void;
  92540. /**
  92541. * Event raised when the texture is generated
  92542. */
  92543. onGeneratedObservable: Observable<ProceduralTexture>;
  92544. /**
  92545. * Event raised before the texture is generated
  92546. */
  92547. onBeforeGenerationObservable: Observable<ProceduralTexture>;
  92548. /**
  92549. * Gets or sets the node material used to create this texture (null if the texture was manually created)
  92550. */
  92551. nodeMaterialSource: Nullable<NodeMaterial>;
  92552. /** @hidden */
  92553. _generateMipMaps: boolean;
  92554. /** @hidden **/
  92555. _effect: Effect;
  92556. /** @hidden */
  92557. _textures: {
  92558. [key: string]: Texture;
  92559. };
  92560. /** @hidden */
  92561. protected _fallbackTexture: Nullable<Texture>;
  92562. private _size;
  92563. private _currentRefreshId;
  92564. private _frameId;
  92565. private _refreshRate;
  92566. private _vertexBuffers;
  92567. private _indexBuffer;
  92568. private _uniforms;
  92569. private _samplers;
  92570. private _fragment;
  92571. private _floats;
  92572. private _ints;
  92573. private _floatsArrays;
  92574. private _colors3;
  92575. private _colors4;
  92576. private _vectors2;
  92577. private _vectors3;
  92578. private _matrices;
  92579. private _fallbackTextureUsed;
  92580. private _fullEngine;
  92581. private _cachedDefines;
  92582. private _contentUpdateId;
  92583. private _contentData;
  92584. /**
  92585. * Instantiates a new procedural texture.
  92586. * 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.
  92587. * This is the base class of any Procedural texture and contains most of the shareable code.
  92588. * @see https://doc.babylonjs.com/how_to/how_to_use_procedural_textures
  92589. * @param name Define the name of the texture
  92590. * @param size Define the size of the texture to create
  92591. * @param fragment Define the fragment shader to use to generate the texture or null if it is defined later
  92592. * @param scene Define the scene the texture belongs to
  92593. * @param fallbackTexture Define a fallback texture in case there were issues to create the custom texture
  92594. * @param generateMipMaps Define if the texture should creates mip maps or not
  92595. * @param isCube Define if the texture is a cube texture or not (this will render each faces of the cube)
  92596. * @param textureType The FBO internal texture type
  92597. */
  92598. constructor(name: string, size: RenderTargetTextureSize, fragment: any, scene: Nullable<Scene>, fallbackTexture?: Nullable<Texture>, generateMipMaps?: boolean, isCube?: boolean, textureType?: number);
  92599. /**
  92600. * The effect that is created when initializing the post process.
  92601. * @returns The created effect corresponding the the postprocess.
  92602. */
  92603. getEffect(): Effect;
  92604. /**
  92605. * Gets texture content (Use this function wisely as reading from a texture can be slow)
  92606. * @returns an ArrayBufferView (Uint8Array or Float32Array)
  92607. */
  92608. getContent(): Nullable<ArrayBufferView>;
  92609. private _createIndexBuffer;
  92610. /** @hidden */
  92611. _rebuild(): void;
  92612. /**
  92613. * Resets the texture in order to recreate its associated resources.
  92614. * This can be called in case of context loss
  92615. */
  92616. reset(): void;
  92617. protected _getDefines(): string;
  92618. /**
  92619. * Is the texture ready to be used ? (rendered at least once)
  92620. * @returns true if ready, otherwise, false.
  92621. */
  92622. isReady(): boolean;
  92623. /**
  92624. * Resets the refresh counter of the texture and start bak from scratch.
  92625. * Could be useful to regenerate the texture if it is setup to render only once.
  92626. */
  92627. resetRefreshCounter(): void;
  92628. /**
  92629. * Set the fragment shader to use in order to render the texture.
  92630. * @param fragment This can be set to a path (into the shader store) or to a json object containing a fragmentElement property.
  92631. */
  92632. setFragment(fragment: any): void;
  92633. /**
  92634. * Define the refresh rate of the texture or the rendering frequency.
  92635. * Use 0 to render just once, 1 to render on every frame, 2 to render every two frames and so on...
  92636. */
  92637. get refreshRate(): number;
  92638. set refreshRate(value: number);
  92639. /** @hidden */
  92640. _shouldRender(): boolean;
  92641. /**
  92642. * Get the size the texture is rendering at.
  92643. * @returns the size (on cube texture it is always squared)
  92644. */
  92645. getRenderSize(): RenderTargetTextureSize;
  92646. /**
  92647. * Resize the texture to new value.
  92648. * @param size Define the new size the texture should have
  92649. * @param generateMipMaps Define whether the new texture should create mip maps
  92650. */
  92651. resize(size: number, generateMipMaps: boolean): void;
  92652. private _checkUniform;
  92653. /**
  92654. * Set a texture in the shader program used to render.
  92655. * @param name Define the name of the uniform samplers as defined in the shader
  92656. * @param texture Define the texture to bind to this sampler
  92657. * @return the texture itself allowing "fluent" like uniform updates
  92658. */
  92659. setTexture(name: string, texture: Texture): ProceduralTexture;
  92660. /**
  92661. * Set a float in the shader.
  92662. * @param name Define the name of the uniform as defined in the shader
  92663. * @param value Define the value to give to the uniform
  92664. * @return the texture itself allowing "fluent" like uniform updates
  92665. */
  92666. setFloat(name: string, value: number): ProceduralTexture;
  92667. /**
  92668. * Set a int in the shader.
  92669. * @param name Define the name of the uniform as defined in the shader
  92670. * @param value Define the value to give to the uniform
  92671. * @return the texture itself allowing "fluent" like uniform updates
  92672. */
  92673. setInt(name: string, value: number): ProceduralTexture;
  92674. /**
  92675. * Set an array of floats in the shader.
  92676. * @param name Define the name of the uniform as defined in the shader
  92677. * @param value Define the value to give to the uniform
  92678. * @return the texture itself allowing "fluent" like uniform updates
  92679. */
  92680. setFloats(name: string, value: number[]): ProceduralTexture;
  92681. /**
  92682. * Set a vec3 in the shader from a Color3.
  92683. * @param name Define the name of the uniform as defined in the shader
  92684. * @param value Define the value to give to the uniform
  92685. * @return the texture itself allowing "fluent" like uniform updates
  92686. */
  92687. setColor3(name: string, value: Color3): ProceduralTexture;
  92688. /**
  92689. * Set a vec4 in the shader from a Color4.
  92690. * @param name Define the name of the uniform as defined in the shader
  92691. * @param value Define the value to give to the uniform
  92692. * @return the texture itself allowing "fluent" like uniform updates
  92693. */
  92694. setColor4(name: string, value: Color4): ProceduralTexture;
  92695. /**
  92696. * Set a vec2 in the shader from a Vector2.
  92697. * @param name Define the name of the uniform as defined in the shader
  92698. * @param value Define the value to give to the uniform
  92699. * @return the texture itself allowing "fluent" like uniform updates
  92700. */
  92701. setVector2(name: string, value: Vector2): ProceduralTexture;
  92702. /**
  92703. * Set a vec3 in the shader from a Vector3.
  92704. * @param name Define the name of the uniform as defined in the shader
  92705. * @param value Define the value to give to the uniform
  92706. * @return the texture itself allowing "fluent" like uniform updates
  92707. */
  92708. setVector3(name: string, value: Vector3): ProceduralTexture;
  92709. /**
  92710. * Set a mat4 in the shader from a MAtrix.
  92711. * @param name Define the name of the uniform as defined in the shader
  92712. * @param value Define the value to give to the uniform
  92713. * @return the texture itself allowing "fluent" like uniform updates
  92714. */
  92715. setMatrix(name: string, value: Matrix): ProceduralTexture;
  92716. /**
  92717. * Render the texture to its associated render target.
  92718. * @param useCameraPostProcess Define if camera post process should be applied to the texture
  92719. */
  92720. render(useCameraPostProcess?: boolean): void;
  92721. /**
  92722. * Clone the texture.
  92723. * @returns the cloned texture
  92724. */
  92725. clone(): ProceduralTexture;
  92726. /**
  92727. * Dispose the texture and release its asoociated resources.
  92728. */
  92729. dispose(): void;
  92730. }
  92731. }
  92732. declare module BABYLON {
  92733. /**
  92734. * This represents the base class for particle system in Babylon.
  92735. * 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.
  92736. * Particles can take different shapes while emitted like box, sphere, cone or you can write your custom function.
  92737. * @example https://doc.babylonjs.com/babylon101/particles
  92738. */
  92739. export class BaseParticleSystem {
  92740. /**
  92741. * Source color is added to the destination color without alpha affecting the result
  92742. */
  92743. static BLENDMODE_ONEONE: number;
  92744. /**
  92745. * Blend current color and particle color using particle’s alpha
  92746. */
  92747. static BLENDMODE_STANDARD: number;
  92748. /**
  92749. * Add current color and particle color multiplied by particle’s alpha
  92750. */
  92751. static BLENDMODE_ADD: number;
  92752. /**
  92753. * Multiply current color with particle color
  92754. */
  92755. static BLENDMODE_MULTIPLY: number;
  92756. /**
  92757. * Multiply current color with particle color then add current color and particle color multiplied by particle’s alpha
  92758. */
  92759. static BLENDMODE_MULTIPLYADD: number;
  92760. /**
  92761. * List of animations used by the particle system.
  92762. */
  92763. animations: Animation[];
  92764. /**
  92765. * Gets or sets the unique id of the particle system
  92766. */
  92767. uniqueId: number;
  92768. /**
  92769. * The id of the Particle system.
  92770. */
  92771. id: string;
  92772. /**
  92773. * The friendly name of the Particle system.
  92774. */
  92775. name: string;
  92776. /**
  92777. * Snippet ID if the particle system was created from the snippet server
  92778. */
  92779. snippetId: string;
  92780. /**
  92781. * The rendering group used by the Particle system to chose when to render.
  92782. */
  92783. renderingGroupId: number;
  92784. /**
  92785. * The emitter represents the Mesh or position we are attaching the particle system to.
  92786. */
  92787. emitter: Nullable<AbstractMesh | Vector3>;
  92788. /**
  92789. * The maximum number of particles to emit per frame
  92790. */
  92791. emitRate: number;
  92792. /**
  92793. * If you want to launch only a few particles at once, that can be done, as well.
  92794. */
  92795. manualEmitCount: number;
  92796. /**
  92797. * The overall motion speed (0.01 is default update speed, faster updates = faster animation)
  92798. */
  92799. updateSpeed: number;
  92800. /**
  92801. * The amount of time the particle system is running (depends of the overall update speed).
  92802. */
  92803. targetStopDuration: number;
  92804. /**
  92805. * Specifies whether the particle system will be disposed once it reaches the end of the animation.
  92806. */
  92807. disposeOnStop: boolean;
  92808. /**
  92809. * Minimum power of emitting particles.
  92810. */
  92811. minEmitPower: number;
  92812. /**
  92813. * Maximum power of emitting particles.
  92814. */
  92815. maxEmitPower: number;
  92816. /**
  92817. * Minimum life time of emitting particles.
  92818. */
  92819. minLifeTime: number;
  92820. /**
  92821. * Maximum life time of emitting particles.
  92822. */
  92823. maxLifeTime: number;
  92824. /**
  92825. * Minimum Size of emitting particles.
  92826. */
  92827. minSize: number;
  92828. /**
  92829. * Maximum Size of emitting particles.
  92830. */
  92831. maxSize: number;
  92832. /**
  92833. * Minimum scale of emitting particles on X axis.
  92834. */
  92835. minScaleX: number;
  92836. /**
  92837. * Maximum scale of emitting particles on X axis.
  92838. */
  92839. maxScaleX: number;
  92840. /**
  92841. * Minimum scale of emitting particles on Y axis.
  92842. */
  92843. minScaleY: number;
  92844. /**
  92845. * Maximum scale of emitting particles on Y axis.
  92846. */
  92847. maxScaleY: number;
  92848. /**
  92849. * Gets or sets the minimal initial rotation in radians.
  92850. */
  92851. minInitialRotation: number;
  92852. /**
  92853. * Gets or sets the maximal initial rotation in radians.
  92854. */
  92855. maxInitialRotation: number;
  92856. /**
  92857. * Minimum angular speed of emitting particles (Z-axis rotation for each particle).
  92858. */
  92859. minAngularSpeed: number;
  92860. /**
  92861. * Maximum angular speed of emitting particles (Z-axis rotation for each particle).
  92862. */
  92863. maxAngularSpeed: number;
  92864. /**
  92865. * The texture used to render each particle. (this can be a spritesheet)
  92866. */
  92867. particleTexture: Nullable<BaseTexture>;
  92868. /**
  92869. * The layer mask we are rendering the particles through.
  92870. */
  92871. layerMask: number;
  92872. /**
  92873. * This can help using your own shader to render the particle system.
  92874. * The according effect will be created
  92875. */
  92876. customShader: any;
  92877. /**
  92878. * By default particle system starts as soon as they are created. This prevents the
  92879. * automatic start to happen and let you decide when to start emitting particles.
  92880. */
  92881. preventAutoStart: boolean;
  92882. private _noiseTexture;
  92883. /**
  92884. * Gets or sets a texture used to add random noise to particle positions
  92885. */
  92886. get noiseTexture(): Nullable<ProceduralTexture>;
  92887. set noiseTexture(value: Nullable<ProceduralTexture>);
  92888. /** Gets or sets the strength to apply to the noise value (default is (10, 10, 10)) */
  92889. noiseStrength: Vector3;
  92890. /**
  92891. * Callback triggered when the particle animation is ending.
  92892. */
  92893. onAnimationEnd: Nullable<() => void>;
  92894. /**
  92895. * Blend mode use to render the particle, it can be either ParticleSystem.BLENDMODE_ONEONE or ParticleSystem.BLENDMODE_STANDARD.
  92896. */
  92897. blendMode: number;
  92898. /**
  92899. * Forces the particle to write their depth information to the depth buffer. This can help preventing other draw calls
  92900. * to override the particles.
  92901. */
  92902. forceDepthWrite: boolean;
  92903. /** 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 */
  92904. preWarmCycles: number;
  92905. /** Gets or sets a value indicating the time step multiplier to use in pre-warm mode (default is 1) */
  92906. preWarmStepOffset: number;
  92907. /**
  92908. * 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)
  92909. */
  92910. spriteCellChangeSpeed: number;
  92911. /**
  92912. * If using a spritesheet (isAnimationSheetEnabled) defines the first sprite cell to display
  92913. */
  92914. startSpriteCellID: number;
  92915. /**
  92916. * If using a spritesheet (isAnimationSheetEnabled) defines the last sprite cell to display
  92917. */
  92918. endSpriteCellID: number;
  92919. /**
  92920. * If using a spritesheet (isAnimationSheetEnabled), defines the sprite cell width to use
  92921. */
  92922. spriteCellWidth: number;
  92923. /**
  92924. * If using a spritesheet (isAnimationSheetEnabled), defines the sprite cell height to use
  92925. */
  92926. spriteCellHeight: number;
  92927. /**
  92928. * This allows the system to random pick the start cell ID between startSpriteCellID and endSpriteCellID
  92929. */
  92930. spriteRandomStartCell: boolean;
  92931. /** Gets or sets a Vector2 used to move the pivot (by default (0,0)) */
  92932. translationPivot: Vector2;
  92933. /** @hidden */
  92934. protected _isAnimationSheetEnabled: boolean;
  92935. /**
  92936. * Gets or sets a boolean indicating that hosted animations (in the system.animations array) must be started when system.start() is called
  92937. */
  92938. beginAnimationOnStart: boolean;
  92939. /**
  92940. * Gets or sets the frame to start the animation from when beginAnimationOnStart is true
  92941. */
  92942. beginAnimationFrom: number;
  92943. /**
  92944. * Gets or sets the frame to end the animation on when beginAnimationOnStart is true
  92945. */
  92946. beginAnimationTo: number;
  92947. /**
  92948. * Gets or sets a boolean indicating if animations must loop when beginAnimationOnStart is true
  92949. */
  92950. beginAnimationLoop: boolean;
  92951. /**
  92952. * Gets or sets a world offset applied to all particles
  92953. */
  92954. worldOffset: Vector3;
  92955. /**
  92956. * Gets or sets whether an animation sprite sheet is enabled or not on the particle system
  92957. */
  92958. get isAnimationSheetEnabled(): boolean;
  92959. set isAnimationSheetEnabled(value: boolean);
  92960. /**
  92961. * Get hosting scene
  92962. * @returns the scene
  92963. */
  92964. getScene(): Nullable<Scene>;
  92965. /**
  92966. * You can use gravity if you want to give an orientation to your particles.
  92967. */
  92968. gravity: Vector3;
  92969. protected _colorGradients: Nullable<Array<ColorGradient>>;
  92970. protected _sizeGradients: Nullable<Array<FactorGradient>>;
  92971. protected _lifeTimeGradients: Nullable<Array<FactorGradient>>;
  92972. protected _angularSpeedGradients: Nullable<Array<FactorGradient>>;
  92973. protected _velocityGradients: Nullable<Array<FactorGradient>>;
  92974. protected _limitVelocityGradients: Nullable<Array<FactorGradient>>;
  92975. protected _dragGradients: Nullable<Array<FactorGradient>>;
  92976. protected _emitRateGradients: Nullable<Array<FactorGradient>>;
  92977. protected _startSizeGradients: Nullable<Array<FactorGradient>>;
  92978. protected _rampGradients: Nullable<Array<Color3Gradient>>;
  92979. protected _colorRemapGradients: Nullable<Array<FactorGradient>>;
  92980. protected _alphaRemapGradients: Nullable<Array<FactorGradient>>;
  92981. protected _hasTargetStopDurationDependantGradient(): boolean | null;
  92982. /**
  92983. * Defines the delay in milliseconds before starting the system (0 by default)
  92984. */
  92985. startDelay: number;
  92986. /**
  92987. * Gets the current list of drag gradients.
  92988. * You must use addDragGradient and removeDragGradient to udpate this list
  92989. * @returns the list of drag gradients
  92990. */
  92991. getDragGradients(): Nullable<Array<FactorGradient>>;
  92992. /** Gets or sets a value indicating the damping to apply if the limit velocity factor is reached */
  92993. limitVelocityDamping: number;
  92994. /**
  92995. * Gets the current list of limit velocity gradients.
  92996. * You must use addLimitVelocityGradient and removeLimitVelocityGradient to udpate this list
  92997. * @returns the list of limit velocity gradients
  92998. */
  92999. getLimitVelocityGradients(): Nullable<Array<FactorGradient>>;
  93000. /**
  93001. * Gets the current list of color gradients.
  93002. * You must use addColorGradient and removeColorGradient to udpate this list
  93003. * @returns the list of color gradients
  93004. */
  93005. getColorGradients(): Nullable<Array<ColorGradient>>;
  93006. /**
  93007. * Gets the current list of size gradients.
  93008. * You must use addSizeGradient and removeSizeGradient to udpate this list
  93009. * @returns the list of size gradients
  93010. */
  93011. getSizeGradients(): Nullable<Array<FactorGradient>>;
  93012. /**
  93013. * Gets the current list of color remap gradients.
  93014. * You must use addColorRemapGradient and removeColorRemapGradient to udpate this list
  93015. * @returns the list of color remap gradients
  93016. */
  93017. getColorRemapGradients(): Nullable<Array<FactorGradient>>;
  93018. /**
  93019. * Gets the current list of alpha remap gradients.
  93020. * You must use addAlphaRemapGradient and removeAlphaRemapGradient to udpate this list
  93021. * @returns the list of alpha remap gradients
  93022. */
  93023. getAlphaRemapGradients(): Nullable<Array<FactorGradient>>;
  93024. /**
  93025. * Gets the current list of life time gradients.
  93026. * You must use addLifeTimeGradient and removeLifeTimeGradient to udpate this list
  93027. * @returns the list of life time gradients
  93028. */
  93029. getLifeTimeGradients(): Nullable<Array<FactorGradient>>;
  93030. /**
  93031. * Gets the current list of angular speed gradients.
  93032. * You must use addAngularSpeedGradient and removeAngularSpeedGradient to udpate this list
  93033. * @returns the list of angular speed gradients
  93034. */
  93035. getAngularSpeedGradients(): Nullable<Array<FactorGradient>>;
  93036. /**
  93037. * Gets the current list of velocity gradients.
  93038. * You must use addVelocityGradient and removeVelocityGradient to udpate this list
  93039. * @returns the list of velocity gradients
  93040. */
  93041. getVelocityGradients(): Nullable<Array<FactorGradient>>;
  93042. /**
  93043. * Gets the current list of start size gradients.
  93044. * You must use addStartSizeGradient and removeStartSizeGradient to udpate this list
  93045. * @returns the list of start size gradients
  93046. */
  93047. getStartSizeGradients(): Nullable<Array<FactorGradient>>;
  93048. /**
  93049. * Gets the current list of emit rate gradients.
  93050. * You must use addEmitRateGradient and removeEmitRateGradient to udpate this list
  93051. * @returns the list of emit rate gradients
  93052. */
  93053. getEmitRateGradients(): Nullable<Array<FactorGradient>>;
  93054. /**
  93055. * Random direction of each particle after it has been emitted, between direction1 and direction2 vectors.
  93056. * This only works when particleEmitterTyps is a BoxParticleEmitter
  93057. */
  93058. get direction1(): Vector3;
  93059. set direction1(value: Vector3);
  93060. /**
  93061. * Random direction of each particle after it has been emitted, between direction1 and direction2 vectors.
  93062. * This only works when particleEmitterTyps is a BoxParticleEmitter
  93063. */
  93064. get direction2(): Vector3;
  93065. set direction2(value: Vector3);
  93066. /**
  93067. * 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.
  93068. * This only works when particleEmitterTyps is a BoxParticleEmitter
  93069. */
  93070. get minEmitBox(): Vector3;
  93071. set minEmitBox(value: Vector3);
  93072. /**
  93073. * 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.
  93074. * This only works when particleEmitterTyps is a BoxParticleEmitter
  93075. */
  93076. get maxEmitBox(): Vector3;
  93077. set maxEmitBox(value: Vector3);
  93078. /**
  93079. * Random color of each particle after it has been emitted, between color1 and color2 vectors
  93080. */
  93081. color1: Color4;
  93082. /**
  93083. * Random color of each particle after it has been emitted, between color1 and color2 vectors
  93084. */
  93085. color2: Color4;
  93086. /**
  93087. * Color the particle will have at the end of its lifetime
  93088. */
  93089. colorDead: Color4;
  93090. /**
  93091. * An optional mask to filter some colors out of the texture, or filter a part of the alpha channel
  93092. */
  93093. textureMask: Color4;
  93094. /**
  93095. * The particle emitter type defines the emitter used by the particle system.
  93096. * It can be for example box, sphere, or cone...
  93097. */
  93098. particleEmitterType: IParticleEmitterType;
  93099. /** @hidden */
  93100. _isSubEmitter: boolean;
  93101. /**
  93102. * Gets or sets the billboard mode to use when isBillboardBased = true.
  93103. * Value can be: ParticleSystem.BILLBOARDMODE_ALL, ParticleSystem.BILLBOARDMODE_Y, ParticleSystem.BILLBOARDMODE_STRETCHED
  93104. */
  93105. billboardMode: number;
  93106. protected _isBillboardBased: boolean;
  93107. /**
  93108. * Gets or sets a boolean indicating if the particles must be rendered as billboard or aligned with the direction
  93109. */
  93110. get isBillboardBased(): boolean;
  93111. set isBillboardBased(value: boolean);
  93112. /**
  93113. * The scene the particle system belongs to.
  93114. */
  93115. protected _scene: Nullable<Scene>;
  93116. /**
  93117. * The engine the particle system belongs to.
  93118. */
  93119. protected _engine: ThinEngine;
  93120. /**
  93121. * Local cache of defines for image processing.
  93122. */
  93123. protected _imageProcessingConfigurationDefines: ImageProcessingConfigurationDefines;
  93124. /**
  93125. * Default configuration related to image processing available in the standard Material.
  93126. */
  93127. protected _imageProcessingConfiguration: Nullable<ImageProcessingConfiguration>;
  93128. /**
  93129. * Gets the image processing configuration used either in this material.
  93130. */
  93131. get imageProcessingConfiguration(): Nullable<ImageProcessingConfiguration>;
  93132. /**
  93133. * Sets the Default image processing configuration used either in the this material.
  93134. *
  93135. * If sets to null, the scene one is in use.
  93136. */
  93137. set imageProcessingConfiguration(value: Nullable<ImageProcessingConfiguration>);
  93138. /**
  93139. * Attaches a new image processing configuration to the Standard Material.
  93140. * @param configuration
  93141. */
  93142. protected _attachImageProcessingConfiguration(configuration: Nullable<ImageProcessingConfiguration>): void;
  93143. /** @hidden */
  93144. protected _reset(): void;
  93145. /** @hidden */
  93146. protected _removeGradientAndTexture(gradient: number, gradients: Nullable<IValueGradient[]>, texture: Nullable<RawTexture>): BaseParticleSystem;
  93147. /**
  93148. * Instantiates a particle system.
  93149. * 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.
  93150. * @param name The name of the particle system
  93151. */
  93152. constructor(name: string);
  93153. /**
  93154. * Creates a Point Emitter for the particle system (emits directly from the emitter position)
  93155. * @param direction1 Particles are emitted between the direction1 and direction2 from within the box
  93156. * @param direction2 Particles are emitted between the direction1 and direction2 from within the box
  93157. * @returns the emitter
  93158. */
  93159. createPointEmitter(direction1: Vector3, direction2: Vector3): PointParticleEmitter;
  93160. /**
  93161. * Creates a Hemisphere Emitter for the particle system (emits along the hemisphere radius)
  93162. * @param radius The radius of the hemisphere to emit from
  93163. * @param radiusRange The range of the hemisphere to emit from [0-1] 0 Surface Only, 1 Entire Radius
  93164. * @returns the emitter
  93165. */
  93166. createHemisphericEmitter(radius?: number, radiusRange?: number): HemisphericParticleEmitter;
  93167. /**
  93168. * Creates a Sphere Emitter for the particle system (emits along the sphere radius)
  93169. * @param radius The radius of the sphere to emit from
  93170. * @param radiusRange The range of the sphere to emit from [0-1] 0 Surface Only, 1 Entire Radius
  93171. * @returns the emitter
  93172. */
  93173. createSphereEmitter(radius?: number, radiusRange?: number): SphereParticleEmitter;
  93174. /**
  93175. * Creates a Directed Sphere Emitter for the particle system (emits between direction1 and direction2)
  93176. * @param radius The radius of the sphere to emit from
  93177. * @param direction1 Particles are emitted between the direction1 and direction2 from within the sphere
  93178. * @param direction2 Particles are emitted between the direction1 and direction2 from within the sphere
  93179. * @returns the emitter
  93180. */
  93181. createDirectedSphereEmitter(radius?: number, direction1?: Vector3, direction2?: Vector3): SphereDirectedParticleEmitter;
  93182. /**
  93183. * Creates a Cylinder Emitter for the particle system (emits from the cylinder to the particle position)
  93184. * @param radius The radius of the emission cylinder
  93185. * @param height The height of the emission cylinder
  93186. * @param radiusRange The range of emission [0-1] 0 Surface only, 1 Entire Radius
  93187. * @param directionRandomizer How much to randomize the particle direction [0-1]
  93188. * @returns the emitter
  93189. */
  93190. createCylinderEmitter(radius?: number, height?: number, radiusRange?: number, directionRandomizer?: number): CylinderParticleEmitter;
  93191. /**
  93192. * Creates a Directed Cylinder Emitter for the particle system (emits between direction1 and direction2)
  93193. * @param radius The radius of the cylinder to emit from
  93194. * @param height The height of the emission cylinder
  93195. * @param radiusRange the range of the emission cylinder [0-1] 0 Surface only, 1 Entire Radius (1 by default)
  93196. * @param direction1 Particles are emitted between the direction1 and direction2 from within the cylinder
  93197. * @param direction2 Particles are emitted between the direction1 and direction2 from within the cylinder
  93198. * @returns the emitter
  93199. */
  93200. createDirectedCylinderEmitter(radius?: number, height?: number, radiusRange?: number, direction1?: Vector3, direction2?: Vector3): CylinderDirectedParticleEmitter;
  93201. /**
  93202. * Creates a Cone Emitter for the particle system (emits from the cone to the particle position)
  93203. * @param radius The radius of the cone to emit from
  93204. * @param angle The base angle of the cone
  93205. * @returns the emitter
  93206. */
  93207. createConeEmitter(radius?: number, angle?: number): ConeParticleEmitter;
  93208. /**
  93209. * Creates a Box Emitter for the particle system. (emits between direction1 and direction2 from withing the box defined by minEmitBox and maxEmitBox)
  93210. * @param direction1 Particles are emitted between the direction1 and direction2 from within the box
  93211. * @param direction2 Particles are emitted between the direction1 and direction2 from within the box
  93212. * @param minEmitBox Particles are emitted from the box between minEmitBox and maxEmitBox
  93213. * @param maxEmitBox Particles are emitted from the box between minEmitBox and maxEmitBox
  93214. * @returns the emitter
  93215. */
  93216. createBoxEmitter(direction1: Vector3, direction2: Vector3, minEmitBox: Vector3, maxEmitBox: Vector3): BoxParticleEmitter;
  93217. }
  93218. }
  93219. declare module BABYLON {
  93220. /**
  93221. * Type of sub emitter
  93222. */
  93223. export enum SubEmitterType {
  93224. /**
  93225. * Attached to the particle over it's lifetime
  93226. */
  93227. ATTACHED = 0,
  93228. /**
  93229. * Created when the particle dies
  93230. */
  93231. END = 1
  93232. }
  93233. /**
  93234. * Sub emitter class used to emit particles from an existing particle
  93235. */
  93236. export class SubEmitter {
  93237. /**
  93238. * the particle system to be used by the sub emitter
  93239. */
  93240. particleSystem: ParticleSystem;
  93241. /**
  93242. * Type of the submitter (Default: END)
  93243. */
  93244. type: SubEmitterType;
  93245. /**
  93246. * 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)
  93247. * Note: This only is supported when using an emitter of type Mesh
  93248. */
  93249. inheritDirection: boolean;
  93250. /**
  93251. * How much of the attached particles speed should be added to the sub emitted particle (default: 0)
  93252. */
  93253. inheritedVelocityAmount: number;
  93254. /**
  93255. * Creates a sub emitter
  93256. * @param particleSystem the particle system to be used by the sub emitter
  93257. */
  93258. constructor(
  93259. /**
  93260. * the particle system to be used by the sub emitter
  93261. */
  93262. particleSystem: ParticleSystem);
  93263. /**
  93264. * Clones the sub emitter
  93265. * @returns the cloned sub emitter
  93266. */
  93267. clone(): SubEmitter;
  93268. /**
  93269. * Serialize current object to a JSON object
  93270. * @returns the serialized object
  93271. */
  93272. serialize(): any;
  93273. /** @hidden */
  93274. static _ParseParticleSystem(system: any, sceneOrEngine: Scene | ThinEngine, rootUrl: string): ParticleSystem;
  93275. /**
  93276. * Creates a new SubEmitter from a serialized JSON version
  93277. * @param serializationObject defines the JSON object to read from
  93278. * @param sceneOrEngine defines the hosting scene or the hosting engine
  93279. * @param rootUrl defines the rootUrl for data loading
  93280. * @returns a new SubEmitter
  93281. */
  93282. static Parse(serializationObject: any, sceneOrEngine: Scene | ThinEngine, rootUrl: string): SubEmitter;
  93283. /** Release associated resources */
  93284. dispose(): void;
  93285. }
  93286. }
  93287. declare module BABYLON {
  93288. /** @hidden */
  93289. export var imageProcessingDeclaration: {
  93290. name: string;
  93291. shader: string;
  93292. };
  93293. }
  93294. declare module BABYLON {
  93295. /** @hidden */
  93296. export var imageProcessingFunctions: {
  93297. name: string;
  93298. shader: string;
  93299. };
  93300. }
  93301. declare module BABYLON {
  93302. /** @hidden */
  93303. export var particlesPixelShader: {
  93304. name: string;
  93305. shader: string;
  93306. };
  93307. }
  93308. declare module BABYLON {
  93309. /** @hidden */
  93310. export var particlesVertexShader: {
  93311. name: string;
  93312. shader: string;
  93313. };
  93314. }
  93315. declare module BABYLON {
  93316. /**
  93317. * Interface used to define entities containing multiple clip planes
  93318. */
  93319. export interface IClipPlanesHolder {
  93320. /**
  93321. * Gets or sets the active clipplane 1
  93322. */
  93323. clipPlane: Nullable<Plane>;
  93324. /**
  93325. * Gets or sets the active clipplane 2
  93326. */
  93327. clipPlane2: Nullable<Plane>;
  93328. /**
  93329. * Gets or sets the active clipplane 3
  93330. */
  93331. clipPlane3: Nullable<Plane>;
  93332. /**
  93333. * Gets or sets the active clipplane 4
  93334. */
  93335. clipPlane4: Nullable<Plane>;
  93336. /**
  93337. * Gets or sets the active clipplane 5
  93338. */
  93339. clipPlane5: Nullable<Plane>;
  93340. /**
  93341. * Gets or sets the active clipplane 6
  93342. */
  93343. clipPlane6: Nullable<Plane>;
  93344. }
  93345. }
  93346. declare module BABYLON {
  93347. /**
  93348. * "Static Class" containing a few commonly used helper while dealing with material for rendering purpose.
  93349. *
  93350. * It is complementary with MaterialHelper but provides completely independent functions (for tree shaking sake)
  93351. *
  93352. * This works by convention in BabylonJS but is meant to be use only with shader following the in place naming rules and conventions.
  93353. */
  93354. export class ThinMaterialHelper {
  93355. /**
  93356. * Binds the clip plane information from the holder to the effect.
  93357. * @param effect The effect we are binding the data to
  93358. * @param holder The entity containing the clip plane information
  93359. */
  93360. static BindClipPlane(effect: Effect, holder: IClipPlanesHolder): void;
  93361. }
  93362. }
  93363. declare module BABYLON {
  93364. interface ThinEngine {
  93365. /**
  93366. * Sets alpha constants used by some alpha blending modes
  93367. * @param r defines the red component
  93368. * @param g defines the green component
  93369. * @param b defines the blue component
  93370. * @param a defines the alpha component
  93371. */
  93372. setAlphaConstants(r: number, g: number, b: number, a: number): void;
  93373. /**
  93374. * Sets the current alpha mode
  93375. * @param mode defines the mode to use (one of the Engine.ALPHA_XXX)
  93376. * @param noDepthWriteChange defines if depth writing state should remains unchanged (false by default)
  93377. * @see https://doc.babylonjs.com/resources/transparency_and_how_meshes_are_rendered
  93378. */
  93379. setAlphaMode(mode: number, noDepthWriteChange?: boolean): void;
  93380. /**
  93381. * Gets the current alpha mode
  93382. * @see https://doc.babylonjs.com/resources/transparency_and_how_meshes_are_rendered
  93383. * @returns the current alpha mode
  93384. */
  93385. getAlphaMode(): number;
  93386. /**
  93387. * Sets the current alpha equation
  93388. * @param equation defines the equation to use (one of the Engine.ALPHA_EQUATION_XXX)
  93389. */
  93390. setAlphaEquation(equation: number): void;
  93391. /**
  93392. * Gets the current alpha equation.
  93393. * @returns the current alpha equation
  93394. */
  93395. getAlphaEquation(): number;
  93396. }
  93397. }
  93398. declare module BABYLON {
  93399. /**
  93400. * This represents a particle system in Babylon.
  93401. * 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.
  93402. * Particles can take different shapes while emitted like box, sphere, cone or you can write your custom function.
  93403. * @example https://doc.babylonjs.com/babylon101/particles
  93404. */
  93405. export class ParticleSystem extends BaseParticleSystem implements IDisposable, IAnimatable, IParticleSystem {
  93406. /**
  93407. * Billboard mode will only apply to Y axis
  93408. */
  93409. static readonly BILLBOARDMODE_Y: number;
  93410. /**
  93411. * Billboard mode will apply to all axes
  93412. */
  93413. static readonly BILLBOARDMODE_ALL: number;
  93414. /**
  93415. * Special billboard mode where the particle will be biilboard to the camera but rotated to align with direction
  93416. */
  93417. static readonly BILLBOARDMODE_STRETCHED: number;
  93418. /**
  93419. * This function can be defined to provide custom update for active particles.
  93420. * This function will be called instead of regular update (age, position, color, etc.).
  93421. * Do not forget that this function will be called on every frame so try to keep it simple and fast :)
  93422. */
  93423. updateFunction: (particles: Particle[]) => void;
  93424. private _emitterWorldMatrix;
  93425. /**
  93426. * This function can be defined to specify initial direction for every new particle.
  93427. * It by default use the emitterType defined function
  93428. */
  93429. startDirectionFunction: (worldMatrix: Matrix, directionToUpdate: Vector3, particle: Particle, isLocal: boolean) => void;
  93430. /**
  93431. * This function can be defined to specify initial position for every new particle.
  93432. * It by default use the emitterType defined function
  93433. */
  93434. startPositionFunction: (worldMatrix: Matrix, positionToUpdate: Vector3, particle: Particle, isLocal: boolean) => void;
  93435. /**
  93436. * @hidden
  93437. */
  93438. _inheritedVelocityOffset: Vector3;
  93439. /**
  93440. * An event triggered when the system is disposed
  93441. */
  93442. onDisposeObservable: Observable<IParticleSystem>;
  93443. /**
  93444. * An event triggered when the system is stopped
  93445. */
  93446. onStoppedObservable: Observable<IParticleSystem>;
  93447. private _onDisposeObserver;
  93448. /**
  93449. * Sets a callback that will be triggered when the system is disposed
  93450. */
  93451. set onDispose(callback: () => void);
  93452. private _particles;
  93453. private _epsilon;
  93454. private _capacity;
  93455. private _stockParticles;
  93456. private _newPartsExcess;
  93457. private _vertexData;
  93458. private _vertexBuffer;
  93459. private _vertexBuffers;
  93460. private _spriteBuffer;
  93461. private _indexBuffer;
  93462. private _effect;
  93463. private _customEffect;
  93464. private _cachedDefines;
  93465. private _scaledColorStep;
  93466. private _colorDiff;
  93467. private _scaledDirection;
  93468. private _scaledGravity;
  93469. private _currentRenderId;
  93470. private _alive;
  93471. private _useInstancing;
  93472. private _vertexArrayObject;
  93473. private _started;
  93474. private _stopped;
  93475. private _actualFrame;
  93476. private _scaledUpdateSpeed;
  93477. private _vertexBufferSize;
  93478. /** @hidden */
  93479. _currentEmitRateGradient: Nullable<FactorGradient>;
  93480. /** @hidden */
  93481. _currentEmitRate1: number;
  93482. /** @hidden */
  93483. _currentEmitRate2: number;
  93484. /** @hidden */
  93485. _currentStartSizeGradient: Nullable<FactorGradient>;
  93486. /** @hidden */
  93487. _currentStartSize1: number;
  93488. /** @hidden */
  93489. _currentStartSize2: number;
  93490. private readonly _rawTextureWidth;
  93491. private _rampGradientsTexture;
  93492. private _useRampGradients;
  93493. /** Gets or sets a matrix to use to compute projection */
  93494. defaultProjectionMatrix: Matrix;
  93495. /** Gets or sets a matrix to use to compute view */
  93496. defaultViewMatrix: Matrix;
  93497. /** Gets or sets a boolean indicating that ramp gradients must be used
  93498. * @see https://doc.babylonjs.com/babylon101/particles#ramp-gradients
  93499. */
  93500. get useRampGradients(): boolean;
  93501. set useRampGradients(value: boolean);
  93502. /**
  93503. * 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.
  93504. * 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: [])
  93505. */
  93506. subEmitters: Array<ParticleSystem | SubEmitter | Array<SubEmitter>>;
  93507. private _subEmitters;
  93508. /**
  93509. * @hidden
  93510. * If the particle systems emitter should be disposed when the particle system is disposed
  93511. */
  93512. _disposeEmitterOnDispose: boolean;
  93513. /**
  93514. * The current active Sub-systems, this property is used by the root particle system only.
  93515. */
  93516. activeSubSystems: Array<ParticleSystem>;
  93517. /**
  93518. * Specifies if the particles are updated in emitter local space or world space
  93519. */
  93520. isLocal: boolean;
  93521. private _rootParticleSystem;
  93522. /**
  93523. * Gets the current list of active particles
  93524. */
  93525. get particles(): Particle[];
  93526. /**
  93527. * Gets the number of particles active at the same time.
  93528. * @returns The number of active particles.
  93529. */
  93530. getActiveCount(): number;
  93531. /**
  93532. * Returns the string "ParticleSystem"
  93533. * @returns a string containing the class name
  93534. */
  93535. getClassName(): string;
  93536. /**
  93537. * Gets a boolean indicating that the system is stopping
  93538. * @returns true if the system is currently stopping
  93539. */
  93540. isStopping(): boolean;
  93541. /**
  93542. * Gets the custom effect used to render the particles
  93543. * @param blendMode Blend mode for which the effect should be retrieved
  93544. * @returns The effect
  93545. */
  93546. getCustomEffect(blendMode?: number): Nullable<Effect>;
  93547. /**
  93548. * Sets the custom effect used to render the particles
  93549. * @param effect The effect to set
  93550. * @param blendMode Blend mode for which the effect should be set
  93551. */
  93552. setCustomEffect(effect: Nullable<Effect>, blendMode?: number): void;
  93553. /** @hidden */
  93554. private _onBeforeDrawParticlesObservable;
  93555. /**
  93556. * Observable that will be called just before the particles are drawn
  93557. */
  93558. get onBeforeDrawParticlesObservable(): Observable<Nullable<Effect>>;
  93559. /**
  93560. * Gets the name of the particle vertex shader
  93561. */
  93562. get vertexShaderName(): string;
  93563. /**
  93564. * Instantiates a particle system.
  93565. * 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.
  93566. * @param name The name of the particle system
  93567. * @param capacity The max number of particles alive at the same time
  93568. * @param sceneOrEngine The scene the particle system belongs to or the engine to use if no scene
  93569. * @param customEffect a custom effect used to change the way particles are rendered by default
  93570. * @param isAnimationSheetEnabled Must be true if using a spritesheet to animate the particles texture
  93571. * @param epsilon Offset used to render the particles
  93572. */
  93573. constructor(name: string, capacity: number, sceneOrEngine: Scene | ThinEngine, customEffect?: Nullable<Effect>, isAnimationSheetEnabled?: boolean, epsilon?: number);
  93574. private _addFactorGradient;
  93575. private _removeFactorGradient;
  93576. /**
  93577. * Adds a new life time gradient
  93578. * @param gradient defines the gradient to use (between 0 and 1)
  93579. * @param factor defines the life time factor to affect to the specified gradient
  93580. * @param factor2 defines an additional factor used to define a range ([factor, factor2]) with main value to pick the final value from
  93581. * @returns the current particle system
  93582. */
  93583. addLifeTimeGradient(gradient: number, factor: number, factor2?: number): IParticleSystem;
  93584. /**
  93585. * Remove a specific life time gradient
  93586. * @param gradient defines the gradient to remove
  93587. * @returns the current particle system
  93588. */
  93589. removeLifeTimeGradient(gradient: number): IParticleSystem;
  93590. /**
  93591. * Adds a new size gradient
  93592. * @param gradient defines the gradient to use (between 0 and 1)
  93593. * @param factor defines the size factor to affect to the specified gradient
  93594. * @param factor2 defines an additional factor used to define a range ([factor, factor2]) with main value to pick the final value from
  93595. * @returns the current particle system
  93596. */
  93597. addSizeGradient(gradient: number, factor: number, factor2?: number): IParticleSystem;
  93598. /**
  93599. * Remove a specific size gradient
  93600. * @param gradient defines the gradient to remove
  93601. * @returns the current particle system
  93602. */
  93603. removeSizeGradient(gradient: number): IParticleSystem;
  93604. /**
  93605. * Adds a new color remap gradient
  93606. * @param gradient defines the gradient to use (between 0 and 1)
  93607. * @param min defines the color remap minimal range
  93608. * @param max defines the color remap maximal range
  93609. * @returns the current particle system
  93610. */
  93611. addColorRemapGradient(gradient: number, min: number, max: number): IParticleSystem;
  93612. /**
  93613. * Remove a specific color remap gradient
  93614. * @param gradient defines the gradient to remove
  93615. * @returns the current particle system
  93616. */
  93617. removeColorRemapGradient(gradient: number): IParticleSystem;
  93618. /**
  93619. * Adds a new alpha remap gradient
  93620. * @param gradient defines the gradient to use (between 0 and 1)
  93621. * @param min defines the alpha remap minimal range
  93622. * @param max defines the alpha remap maximal range
  93623. * @returns the current particle system
  93624. */
  93625. addAlphaRemapGradient(gradient: number, min: number, max: number): IParticleSystem;
  93626. /**
  93627. * Remove a specific alpha remap gradient
  93628. * @param gradient defines the gradient to remove
  93629. * @returns the current particle system
  93630. */
  93631. removeAlphaRemapGradient(gradient: number): IParticleSystem;
  93632. /**
  93633. * Adds a new angular speed gradient
  93634. * @param gradient defines the gradient to use (between 0 and 1)
  93635. * @param factor defines the angular speed to affect to the specified gradient
  93636. * @param factor2 defines an additional factor used to define a range ([factor, factor2]) with main value to pick the final value from
  93637. * @returns the current particle system
  93638. */
  93639. addAngularSpeedGradient(gradient: number, factor: number, factor2?: number): IParticleSystem;
  93640. /**
  93641. * Remove a specific angular speed gradient
  93642. * @param gradient defines the gradient to remove
  93643. * @returns the current particle system
  93644. */
  93645. removeAngularSpeedGradient(gradient: number): IParticleSystem;
  93646. /**
  93647. * Adds a new velocity gradient
  93648. * @param gradient defines the gradient to use (between 0 and 1)
  93649. * @param factor defines the velocity to affect to the specified gradient
  93650. * @param factor2 defines an additional factor used to define a range ([factor, factor2]) with main value to pick the final value from
  93651. * @returns the current particle system
  93652. */
  93653. addVelocityGradient(gradient: number, factor: number, factor2?: number): IParticleSystem;
  93654. /**
  93655. * Remove a specific velocity gradient
  93656. * @param gradient defines the gradient to remove
  93657. * @returns the current particle system
  93658. */
  93659. removeVelocityGradient(gradient: number): IParticleSystem;
  93660. /**
  93661. * Adds a new limit velocity gradient
  93662. * @param gradient defines the gradient to use (between 0 and 1)
  93663. * @param factor defines the limit velocity value to affect to the specified gradient
  93664. * @param factor2 defines an additional factor used to define a range ([factor, factor2]) with main value to pick the final value from
  93665. * @returns the current particle system
  93666. */
  93667. addLimitVelocityGradient(gradient: number, factor: number, factor2?: number): IParticleSystem;
  93668. /**
  93669. * Remove a specific limit velocity gradient
  93670. * @param gradient defines the gradient to remove
  93671. * @returns the current particle system
  93672. */
  93673. removeLimitVelocityGradient(gradient: number): IParticleSystem;
  93674. /**
  93675. * Adds a new drag gradient
  93676. * @param gradient defines the gradient to use (between 0 and 1)
  93677. * @param factor defines the drag value to affect to the specified gradient
  93678. * @param factor2 defines an additional factor used to define a range ([factor, factor2]) with main value to pick the final value from
  93679. * @returns the current particle system
  93680. */
  93681. addDragGradient(gradient: number, factor: number, factor2?: number): IParticleSystem;
  93682. /**
  93683. * Remove a specific drag gradient
  93684. * @param gradient defines the gradient to remove
  93685. * @returns the current particle system
  93686. */
  93687. removeDragGradient(gradient: number): IParticleSystem;
  93688. /**
  93689. * Adds a new emit rate gradient (please note that this will only work if you set the targetStopDuration property)
  93690. * @param gradient defines the gradient to use (between 0 and 1)
  93691. * @param factor defines the emit rate value to affect to the specified gradient
  93692. * @param factor2 defines an additional factor used to define a range ([factor, factor2]) with main value to pick the final value from
  93693. * @returns the current particle system
  93694. */
  93695. addEmitRateGradient(gradient: number, factor: number, factor2?: number): IParticleSystem;
  93696. /**
  93697. * Remove a specific emit rate gradient
  93698. * @param gradient defines the gradient to remove
  93699. * @returns the current particle system
  93700. */
  93701. removeEmitRateGradient(gradient: number): IParticleSystem;
  93702. /**
  93703. * Adds a new start size gradient (please note that this will only work if you set the targetStopDuration property)
  93704. * @param gradient defines the gradient to use (between 0 and 1)
  93705. * @param factor defines the start size value to affect to the specified gradient
  93706. * @param factor2 defines an additional factor used to define a range ([factor, factor2]) with main value to pick the final value from
  93707. * @returns the current particle system
  93708. */
  93709. addStartSizeGradient(gradient: number, factor: number, factor2?: number): IParticleSystem;
  93710. /**
  93711. * Remove a specific start size gradient
  93712. * @param gradient defines the gradient to remove
  93713. * @returns the current particle system
  93714. */
  93715. removeStartSizeGradient(gradient: number): IParticleSystem;
  93716. private _createRampGradientTexture;
  93717. /**
  93718. * Gets the current list of ramp gradients.
  93719. * You must use addRampGradient and removeRampGradient to udpate this list
  93720. * @returns the list of ramp gradients
  93721. */
  93722. getRampGradients(): Nullable<Array<Color3Gradient>>;
  93723. /** Force the system to rebuild all gradients that need to be resync */
  93724. forceRefreshGradients(): void;
  93725. private _syncRampGradientTexture;
  93726. /**
  93727. * Adds a new ramp gradient used to remap particle colors
  93728. * @param gradient defines the gradient to use (between 0 and 1)
  93729. * @param color defines the color to affect to the specified gradient
  93730. * @returns the current particle system
  93731. */
  93732. addRampGradient(gradient: number, color: Color3): ParticleSystem;
  93733. /**
  93734. * Remove a specific ramp gradient
  93735. * @param gradient defines the gradient to remove
  93736. * @returns the current particle system
  93737. */
  93738. removeRampGradient(gradient: number): ParticleSystem;
  93739. /**
  93740. * Adds a new color gradient
  93741. * @param gradient defines the gradient to use (between 0 and 1)
  93742. * @param color1 defines the color to affect to the specified gradient
  93743. * @param color2 defines an additional color used to define a range ([color, color2]) with main color to pick the final color from
  93744. * @returns this particle system
  93745. */
  93746. addColorGradient(gradient: number, color1: Color4, color2?: Color4): IParticleSystem;
  93747. /**
  93748. * Remove a specific color gradient
  93749. * @param gradient defines the gradient to remove
  93750. * @returns this particle system
  93751. */
  93752. removeColorGradient(gradient: number): IParticleSystem;
  93753. private _fetchR;
  93754. protected _reset(): void;
  93755. private _resetEffect;
  93756. private _createVertexBuffers;
  93757. private _createIndexBuffer;
  93758. /**
  93759. * Gets the maximum number of particles active at the same time.
  93760. * @returns The max number of active particles.
  93761. */
  93762. getCapacity(): number;
  93763. /**
  93764. * Gets whether there are still active particles in the system.
  93765. * @returns True if it is alive, otherwise false.
  93766. */
  93767. isAlive(): boolean;
  93768. /**
  93769. * Gets if the system has been started. (Note: this will still be true after stop is called)
  93770. * @returns True if it has been started, otherwise false.
  93771. */
  93772. isStarted(): boolean;
  93773. private _prepareSubEmitterInternalArray;
  93774. /**
  93775. * Starts the particle system and begins to emit
  93776. * @param delay defines the delay in milliseconds before starting the system (this.startDelay by default)
  93777. */
  93778. start(delay?: number): void;
  93779. /**
  93780. * Stops the particle system.
  93781. * @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.
  93782. */
  93783. stop(stopSubEmitters?: boolean): void;
  93784. /**
  93785. * Remove all active particles
  93786. */
  93787. reset(): void;
  93788. /**
  93789. * @hidden (for internal use only)
  93790. */
  93791. _appendParticleVertex(index: number, particle: Particle, offsetX: number, offsetY: number): void;
  93792. /**
  93793. * "Recycles" one of the particle by copying it back to the "stock" of particles and removing it from the active list.
  93794. * Its lifetime will start back at 0.
  93795. */
  93796. recycleParticle: (particle: Particle) => void;
  93797. private _stopSubEmitters;
  93798. private _createParticle;
  93799. private _removeFromRoot;
  93800. private _emitFromParticle;
  93801. private _update;
  93802. /** @hidden */
  93803. static _GetAttributeNamesOrOptions(isAnimationSheetEnabled?: boolean, isBillboardBased?: boolean, useRampGradients?: boolean): string[];
  93804. /** @hidden */
  93805. static _GetEffectCreationOptions(isAnimationSheetEnabled?: boolean): string[];
  93806. /**
  93807. * Fill the defines array according to the current settings of the particle system
  93808. * @param defines Array to be updated
  93809. * @param blendMode blend mode to take into account when updating the array
  93810. */
  93811. fillDefines(defines: Array<string>, blendMode: number): void;
  93812. /**
  93813. * Fill the uniforms, attributes and samplers arrays according to the current settings of the particle system
  93814. * @param uniforms Uniforms array to fill
  93815. * @param attributes Attributes array to fill
  93816. * @param samplers Samplers array to fill
  93817. */
  93818. fillUniformsAttributesAndSamplerNames(uniforms: Array<string>, attributes: Array<string>, samplers: Array<string>): void;
  93819. /** @hidden */
  93820. private _getEffect;
  93821. /**
  93822. * Animates the particle system for the current frame by emitting new particles and or animating the living ones.
  93823. * @param preWarmOnly will prevent the system from updating the vertex buffer (default is false)
  93824. */
  93825. animate(preWarmOnly?: boolean): void;
  93826. private _appendParticleVertices;
  93827. /**
  93828. * Rebuilds the particle system.
  93829. */
  93830. rebuild(): void;
  93831. /**
  93832. * Is this system ready to be used/rendered
  93833. * @return true if the system is ready
  93834. */
  93835. isReady(): boolean;
  93836. private _render;
  93837. /**
  93838. * Renders the particle system in its current state.
  93839. * @returns the current number of particles
  93840. */
  93841. render(): number;
  93842. /**
  93843. * Disposes the particle system and free the associated resources
  93844. * @param disposeTexture defines if the particule texture must be disposed as well (true by default)
  93845. */
  93846. dispose(disposeTexture?: boolean): void;
  93847. /**
  93848. * Clones the particle system.
  93849. * @param name The name of the cloned object
  93850. * @param newEmitter The new emitter to use
  93851. * @returns the cloned particle system
  93852. */
  93853. clone(name: string, newEmitter: any): ParticleSystem;
  93854. /**
  93855. * Serializes the particle system to a JSON object
  93856. * @param serializeTexture defines if the texture must be serialized as well
  93857. * @returns the JSON object
  93858. */
  93859. serialize(serializeTexture?: boolean): any;
  93860. /** @hidden */
  93861. static _Serialize(serializationObject: any, particleSystem: IParticleSystem, serializeTexture: boolean): void;
  93862. /** @hidden */
  93863. static _Parse(parsedParticleSystem: any, particleSystem: IParticleSystem, sceneOrEngine: Scene | ThinEngine, rootUrl: string): void;
  93864. /**
  93865. * Parses a JSON object to create a particle system.
  93866. * @param parsedParticleSystem The JSON object to parse
  93867. * @param sceneOrEngine The scene or the engine to create the particle system in
  93868. * @param rootUrl The root url to use to load external dependencies like texture
  93869. * @param doNotStart Ignore the preventAutoStart attribute and does not start
  93870. * @returns the Parsed particle system
  93871. */
  93872. static Parse(parsedParticleSystem: any, sceneOrEngine: Scene | ThinEngine, rootUrl: string, doNotStart?: boolean): ParticleSystem;
  93873. }
  93874. }
  93875. declare module BABYLON {
  93876. /**
  93877. * A particle represents one of the element emitted by a particle system.
  93878. * This is mainly define by its coordinates, direction, velocity and age.
  93879. */
  93880. export class Particle {
  93881. /**
  93882. * The particle system the particle belongs to.
  93883. */
  93884. particleSystem: ParticleSystem;
  93885. private static _Count;
  93886. /**
  93887. * Unique ID of the particle
  93888. */
  93889. id: number;
  93890. /**
  93891. * The world position of the particle in the scene.
  93892. */
  93893. position: Vector3;
  93894. /**
  93895. * The world direction of the particle in the scene.
  93896. */
  93897. direction: Vector3;
  93898. /**
  93899. * The color of the particle.
  93900. */
  93901. color: Color4;
  93902. /**
  93903. * The color change of the particle per step.
  93904. */
  93905. colorStep: Color4;
  93906. /**
  93907. * Defines how long will the life of the particle be.
  93908. */
  93909. lifeTime: number;
  93910. /**
  93911. * The current age of the particle.
  93912. */
  93913. age: number;
  93914. /**
  93915. * The current size of the particle.
  93916. */
  93917. size: number;
  93918. /**
  93919. * The current scale of the particle.
  93920. */
  93921. scale: Vector2;
  93922. /**
  93923. * The current angle of the particle.
  93924. */
  93925. angle: number;
  93926. /**
  93927. * Defines how fast is the angle changing.
  93928. */
  93929. angularSpeed: number;
  93930. /**
  93931. * Defines the cell index used by the particle to be rendered from a sprite.
  93932. */
  93933. cellIndex: number;
  93934. /**
  93935. * The information required to support color remapping
  93936. */
  93937. remapData: Vector4;
  93938. /** @hidden */
  93939. _randomCellOffset?: number;
  93940. /** @hidden */
  93941. _initialDirection: Nullable<Vector3>;
  93942. /** @hidden */
  93943. _attachedSubEmitters: Nullable<Array<SubEmitter>>;
  93944. /** @hidden */
  93945. _initialStartSpriteCellID: number;
  93946. /** @hidden */
  93947. _initialEndSpriteCellID: number;
  93948. /** @hidden */
  93949. _currentColorGradient: Nullable<ColorGradient>;
  93950. /** @hidden */
  93951. _currentColor1: Color4;
  93952. /** @hidden */
  93953. _currentColor2: Color4;
  93954. /** @hidden */
  93955. _currentSizeGradient: Nullable<FactorGradient>;
  93956. /** @hidden */
  93957. _currentSize1: number;
  93958. /** @hidden */
  93959. _currentSize2: number;
  93960. /** @hidden */
  93961. _currentAngularSpeedGradient: Nullable<FactorGradient>;
  93962. /** @hidden */
  93963. _currentAngularSpeed1: number;
  93964. /** @hidden */
  93965. _currentAngularSpeed2: number;
  93966. /** @hidden */
  93967. _currentVelocityGradient: Nullable<FactorGradient>;
  93968. /** @hidden */
  93969. _currentVelocity1: number;
  93970. /** @hidden */
  93971. _currentVelocity2: number;
  93972. /** @hidden */
  93973. _currentLimitVelocityGradient: Nullable<FactorGradient>;
  93974. /** @hidden */
  93975. _currentLimitVelocity1: number;
  93976. /** @hidden */
  93977. _currentLimitVelocity2: number;
  93978. /** @hidden */
  93979. _currentDragGradient: Nullable<FactorGradient>;
  93980. /** @hidden */
  93981. _currentDrag1: number;
  93982. /** @hidden */
  93983. _currentDrag2: number;
  93984. /** @hidden */
  93985. _randomNoiseCoordinates1: Vector3;
  93986. /** @hidden */
  93987. _randomNoiseCoordinates2: Vector3;
  93988. /** @hidden */
  93989. _localPosition?: Vector3;
  93990. /**
  93991. * Creates a new instance Particle
  93992. * @param particleSystem the particle system the particle belongs to
  93993. */
  93994. constructor(
  93995. /**
  93996. * The particle system the particle belongs to.
  93997. */
  93998. particleSystem: ParticleSystem);
  93999. private updateCellInfoFromSystem;
  94000. /**
  94001. * Defines how the sprite cell index is updated for the particle
  94002. */
  94003. updateCellIndex(): void;
  94004. /** @hidden */
  94005. _inheritParticleInfoToSubEmitter(subEmitter: SubEmitter): void;
  94006. /** @hidden */
  94007. _inheritParticleInfoToSubEmitters(): void;
  94008. /** @hidden */
  94009. _reset(): void;
  94010. /**
  94011. * Copy the properties of particle to another one.
  94012. * @param other the particle to copy the information to.
  94013. */
  94014. copyTo(other: Particle): void;
  94015. }
  94016. }
  94017. declare module BABYLON {
  94018. /**
  94019. * Particle emitter represents a volume emitting particles.
  94020. * This is the responsibility of the implementation to define the volume shape like cone/sphere/box.
  94021. */
  94022. export interface IParticleEmitterType {
  94023. /**
  94024. * Called by the particle System when the direction is computed for the created particle.
  94025. * @param worldMatrix is the world matrix of the particle system
  94026. * @param directionToUpdate is the direction vector to update with the result
  94027. * @param particle is the particle we are computed the direction for
  94028. * @param isLocal defines if the direction should be set in local space
  94029. */
  94030. startDirectionFunction(worldMatrix: Matrix, directionToUpdate: Vector3, particle: Particle, isLocal: boolean): void;
  94031. /**
  94032. * Called by the particle System when the position is computed for the created particle.
  94033. * @param worldMatrix is the world matrix of the particle system
  94034. * @param positionToUpdate is the position vector to update with the result
  94035. * @param particle is the particle we are computed the position for
  94036. * @param isLocal defines if the position should be set in local space
  94037. */
  94038. startPositionFunction(worldMatrix: Matrix, positionToUpdate: Vector3, particle: Particle, isLocal: boolean): void;
  94039. /**
  94040. * Clones the current emitter and returns a copy of it
  94041. * @returns the new emitter
  94042. */
  94043. clone(): IParticleEmitterType;
  94044. /**
  94045. * Called by the GPUParticleSystem to setup the update shader
  94046. * @param effect defines the update shader
  94047. */
  94048. applyToShader(effect: Effect): void;
  94049. /**
  94050. * Returns a string to use to update the GPU particles update shader
  94051. * @returns the effect defines string
  94052. */
  94053. getEffectDefines(): string;
  94054. /**
  94055. * Returns a string representing the class name
  94056. * @returns a string containing the class name
  94057. */
  94058. getClassName(): string;
  94059. /**
  94060. * Serializes the particle system to a JSON object.
  94061. * @returns the JSON object
  94062. */
  94063. serialize(): any;
  94064. /**
  94065. * Parse properties from a JSON object
  94066. * @param serializationObject defines the JSON object
  94067. * @param scene defines the hosting scene
  94068. */
  94069. parse(serializationObject: any, scene: Nullable<Scene>): void;
  94070. }
  94071. }
  94072. declare module BABYLON {
  94073. /**
  94074. * Particle emitter emitting particles from the inside of a box.
  94075. * It emits the particles randomly between 2 given directions.
  94076. */
  94077. export class BoxParticleEmitter implements IParticleEmitterType {
  94078. /**
  94079. * Random direction of each particle after it has been emitted, between direction1 and direction2 vectors.
  94080. */
  94081. direction1: Vector3;
  94082. /**
  94083. * Random direction of each particle after it has been emitted, between direction1 and direction2 vectors.
  94084. */
  94085. direction2: Vector3;
  94086. /**
  94087. * 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.
  94088. */
  94089. minEmitBox: Vector3;
  94090. /**
  94091. * 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.
  94092. */
  94093. maxEmitBox: Vector3;
  94094. /**
  94095. * Creates a new instance BoxParticleEmitter
  94096. */
  94097. constructor();
  94098. /**
  94099. * Called by the particle System when the direction is computed for the created particle.
  94100. * @param worldMatrix is the world matrix of the particle system
  94101. * @param directionToUpdate is the direction vector to update with the result
  94102. * @param particle is the particle we are computed the direction for
  94103. * @param isLocal defines if the direction should be set in local space
  94104. */
  94105. startDirectionFunction(worldMatrix: Matrix, directionToUpdate: Vector3, particle: Particle, isLocal: boolean): void;
  94106. /**
  94107. * Called by the particle System when the position is computed for the created particle.
  94108. * @param worldMatrix is the world matrix of the particle system
  94109. * @param positionToUpdate is the position vector to update with the result
  94110. * @param particle is the particle we are computed the position for
  94111. * @param isLocal defines if the position should be set in local space
  94112. */
  94113. startPositionFunction(worldMatrix: Matrix, positionToUpdate: Vector3, particle: Particle, isLocal: boolean): void;
  94114. /**
  94115. * Clones the current emitter and returns a copy of it
  94116. * @returns the new emitter
  94117. */
  94118. clone(): BoxParticleEmitter;
  94119. /**
  94120. * Called by the GPUParticleSystem to setup the update shader
  94121. * @param effect defines the update shader
  94122. */
  94123. applyToShader(effect: Effect): void;
  94124. /**
  94125. * Returns a string to use to update the GPU particles update shader
  94126. * @returns a string containng the defines string
  94127. */
  94128. getEffectDefines(): string;
  94129. /**
  94130. * Returns the string "BoxParticleEmitter"
  94131. * @returns a string containing the class name
  94132. */
  94133. getClassName(): string;
  94134. /**
  94135. * Serializes the particle system to a JSON object.
  94136. * @returns the JSON object
  94137. */
  94138. serialize(): any;
  94139. /**
  94140. * Parse properties from a JSON object
  94141. * @param serializationObject defines the JSON object
  94142. */
  94143. parse(serializationObject: any): void;
  94144. }
  94145. }
  94146. declare module BABYLON {
  94147. /**
  94148. * Particle emitter emitting particles from the inside of a cone.
  94149. * It emits the particles alongside the cone volume from the base to the particle.
  94150. * The emission direction might be randomized.
  94151. */
  94152. export class ConeParticleEmitter implements IParticleEmitterType {
  94153. /** defines how much to randomize the particle direction [0-1] (default is 0) */
  94154. directionRandomizer: number;
  94155. private _radius;
  94156. private _angle;
  94157. private _height;
  94158. /**
  94159. * Gets or sets a value indicating where on the radius the start position should be picked (1 = everywhere, 0 = only surface)
  94160. */
  94161. radiusRange: number;
  94162. /**
  94163. * Gets or sets a value indicating where on the height the start position should be picked (1 = everywhere, 0 = only surface)
  94164. */
  94165. heightRange: number;
  94166. /**
  94167. * Gets or sets a value indicating if all the particles should be emitted from the spawn point only (the base of the cone)
  94168. */
  94169. emitFromSpawnPointOnly: boolean;
  94170. /**
  94171. * Gets or sets the radius of the emission cone
  94172. */
  94173. get radius(): number;
  94174. set radius(value: number);
  94175. /**
  94176. * Gets or sets the angle of the emission cone
  94177. */
  94178. get angle(): number;
  94179. set angle(value: number);
  94180. private _buildHeight;
  94181. /**
  94182. * Creates a new instance ConeParticleEmitter
  94183. * @param radius the radius of the emission cone (1 by default)
  94184. * @param angle the cone base angle (PI by default)
  94185. * @param directionRandomizer defines how much to randomize the particle direction [0-1] (default is 0)
  94186. */
  94187. constructor(radius?: number, angle?: number,
  94188. /** defines how much to randomize the particle direction [0-1] (default is 0) */
  94189. directionRandomizer?: number);
  94190. /**
  94191. * Called by the particle System when the direction is computed for the created particle.
  94192. * @param worldMatrix is the world matrix of the particle system
  94193. * @param directionToUpdate is the direction vector to update with the result
  94194. * @param particle is the particle we are computed the direction for
  94195. * @param isLocal defines if the direction should be set in local space
  94196. */
  94197. startDirectionFunction(worldMatrix: Matrix, directionToUpdate: Vector3, particle: Particle, isLocal: boolean): void;
  94198. /**
  94199. * Called by the particle System when the position is computed for the created particle.
  94200. * @param worldMatrix is the world matrix of the particle system
  94201. * @param positionToUpdate is the position vector to update with the result
  94202. * @param particle is the particle we are computed the position for
  94203. * @param isLocal defines if the position should be set in local space
  94204. */
  94205. startPositionFunction(worldMatrix: Matrix, positionToUpdate: Vector3, particle: Particle, isLocal: boolean): void;
  94206. /**
  94207. * Clones the current emitter and returns a copy of it
  94208. * @returns the new emitter
  94209. */
  94210. clone(): ConeParticleEmitter;
  94211. /**
  94212. * Called by the GPUParticleSystem to setup the update shader
  94213. * @param effect defines the update shader
  94214. */
  94215. applyToShader(effect: Effect): void;
  94216. /**
  94217. * Returns a string to use to update the GPU particles update shader
  94218. * @returns a string containng the defines string
  94219. */
  94220. getEffectDefines(): string;
  94221. /**
  94222. * Returns the string "ConeParticleEmitter"
  94223. * @returns a string containing the class name
  94224. */
  94225. getClassName(): string;
  94226. /**
  94227. * Serializes the particle system to a JSON object.
  94228. * @returns the JSON object
  94229. */
  94230. serialize(): any;
  94231. /**
  94232. * Parse properties from a JSON object
  94233. * @param serializationObject defines the JSON object
  94234. */
  94235. parse(serializationObject: any): void;
  94236. }
  94237. }
  94238. declare module BABYLON {
  94239. /**
  94240. * Particle emitter emitting particles from the inside of a cylinder.
  94241. * It emits the particles alongside the cylinder radius. The emission direction might be randomized.
  94242. */
  94243. export class CylinderParticleEmitter implements IParticleEmitterType {
  94244. /**
  94245. * The radius of the emission cylinder.
  94246. */
  94247. radius: number;
  94248. /**
  94249. * The height of the emission cylinder.
  94250. */
  94251. height: number;
  94252. /**
  94253. * The range of emission [0-1] 0 Surface only, 1 Entire Radius.
  94254. */
  94255. radiusRange: number;
  94256. /**
  94257. * How much to randomize the particle direction [0-1].
  94258. */
  94259. directionRandomizer: number;
  94260. /**
  94261. * Creates a new instance CylinderParticleEmitter
  94262. * @param radius the radius of the emission cylinder (1 by default)
  94263. * @param height the height of the emission cylinder (1 by default)
  94264. * @param radiusRange the range of the emission cylinder [0-1] 0 Surface only, 1 Entire Radius (1 by default)
  94265. * @param directionRandomizer defines how much to randomize the particle direction [0-1]
  94266. */
  94267. constructor(
  94268. /**
  94269. * The radius of the emission cylinder.
  94270. */
  94271. radius?: number,
  94272. /**
  94273. * The height of the emission cylinder.
  94274. */
  94275. height?: number,
  94276. /**
  94277. * The range of emission [0-1] 0 Surface only, 1 Entire Radius.
  94278. */
  94279. radiusRange?: number,
  94280. /**
  94281. * How much to randomize the particle direction [0-1].
  94282. */
  94283. directionRandomizer?: number);
  94284. /**
  94285. * Called by the particle System when the direction is computed for the created particle.
  94286. * @param worldMatrix is the world matrix of the particle system
  94287. * @param directionToUpdate is the direction vector to update with the result
  94288. * @param particle is the particle we are computed the direction for
  94289. * @param isLocal defines if the direction should be set in local space
  94290. */
  94291. startDirectionFunction(worldMatrix: Matrix, directionToUpdate: Vector3, particle: Particle, isLocal: boolean): void;
  94292. /**
  94293. * Called by the particle System when the position is computed for the created particle.
  94294. * @param worldMatrix is the world matrix of the particle system
  94295. * @param positionToUpdate is the position vector to update with the result
  94296. * @param particle is the particle we are computed the position for
  94297. * @param isLocal defines if the position should be set in local space
  94298. */
  94299. startPositionFunction(worldMatrix: Matrix, positionToUpdate: Vector3, particle: Particle, isLocal: boolean): void;
  94300. /**
  94301. * Clones the current emitter and returns a copy of it
  94302. * @returns the new emitter
  94303. */
  94304. clone(): CylinderParticleEmitter;
  94305. /**
  94306. * Called by the GPUParticleSystem to setup the update shader
  94307. * @param effect defines the update shader
  94308. */
  94309. applyToShader(effect: Effect): void;
  94310. /**
  94311. * Returns a string to use to update the GPU particles update shader
  94312. * @returns a string containng the defines string
  94313. */
  94314. getEffectDefines(): string;
  94315. /**
  94316. * Returns the string "CylinderParticleEmitter"
  94317. * @returns a string containing the class name
  94318. */
  94319. getClassName(): string;
  94320. /**
  94321. * Serializes the particle system to a JSON object.
  94322. * @returns the JSON object
  94323. */
  94324. serialize(): any;
  94325. /**
  94326. * Parse properties from a JSON object
  94327. * @param serializationObject defines the JSON object
  94328. */
  94329. parse(serializationObject: any): void;
  94330. }
  94331. /**
  94332. * Particle emitter emitting particles from the inside of a cylinder.
  94333. * It emits the particles randomly between two vectors.
  94334. */
  94335. export class CylinderDirectedParticleEmitter extends CylinderParticleEmitter {
  94336. /**
  94337. * The min limit of the emission direction.
  94338. */
  94339. direction1: Vector3;
  94340. /**
  94341. * The max limit of the emission direction.
  94342. */
  94343. direction2: Vector3;
  94344. /**
  94345. * Creates a new instance CylinderDirectedParticleEmitter
  94346. * @param radius the radius of the emission cylinder (1 by default)
  94347. * @param height the height of the emission cylinder (1 by default)
  94348. * @param radiusRange the range of the emission cylinder [0-1] 0 Surface only, 1 Entire Radius (1 by default)
  94349. * @param direction1 the min limit of the emission direction (up vector by default)
  94350. * @param direction2 the max limit of the emission direction (up vector by default)
  94351. */
  94352. constructor(radius?: number, height?: number, radiusRange?: number,
  94353. /**
  94354. * The min limit of the emission direction.
  94355. */
  94356. direction1?: Vector3,
  94357. /**
  94358. * The max limit of the emission direction.
  94359. */
  94360. direction2?: Vector3);
  94361. /**
  94362. * Called by the particle System when the direction is computed for the created particle.
  94363. * @param worldMatrix is the world matrix of the particle system
  94364. * @param directionToUpdate is the direction vector to update with the result
  94365. * @param particle is the particle we are computed the direction for
  94366. */
  94367. startDirectionFunction(worldMatrix: Matrix, directionToUpdate: Vector3, particle: Particle): void;
  94368. /**
  94369. * Clones the current emitter and returns a copy of it
  94370. * @returns the new emitter
  94371. */
  94372. clone(): CylinderDirectedParticleEmitter;
  94373. /**
  94374. * Called by the GPUParticleSystem to setup the update shader
  94375. * @param effect defines the update shader
  94376. */
  94377. applyToShader(effect: Effect): void;
  94378. /**
  94379. * Returns a string to use to update the GPU particles update shader
  94380. * @returns a string containng the defines string
  94381. */
  94382. getEffectDefines(): string;
  94383. /**
  94384. * Returns the string "CylinderDirectedParticleEmitter"
  94385. * @returns a string containing the class name
  94386. */
  94387. getClassName(): string;
  94388. /**
  94389. * Serializes the particle system to a JSON object.
  94390. * @returns the JSON object
  94391. */
  94392. serialize(): any;
  94393. /**
  94394. * Parse properties from a JSON object
  94395. * @param serializationObject defines the JSON object
  94396. */
  94397. parse(serializationObject: any): void;
  94398. }
  94399. }
  94400. declare module BABYLON {
  94401. /**
  94402. * Particle emitter emitting particles from the inside of a hemisphere.
  94403. * It emits the particles alongside the hemisphere radius. The emission direction might be randomized.
  94404. */
  94405. export class HemisphericParticleEmitter implements IParticleEmitterType {
  94406. /**
  94407. * The radius of the emission hemisphere.
  94408. */
  94409. radius: number;
  94410. /**
  94411. * The range of emission [0-1] 0 Surface only, 1 Entire Radius.
  94412. */
  94413. radiusRange: number;
  94414. /**
  94415. * How much to randomize the particle direction [0-1].
  94416. */
  94417. directionRandomizer: number;
  94418. /**
  94419. * Creates a new instance HemisphericParticleEmitter
  94420. * @param radius the radius of the emission hemisphere (1 by default)
  94421. * @param radiusRange the range of the emission hemisphere [0-1] 0 Surface only, 1 Entire Radius (1 by default)
  94422. * @param directionRandomizer defines how much to randomize the particle direction [0-1]
  94423. */
  94424. constructor(
  94425. /**
  94426. * The radius of the emission hemisphere.
  94427. */
  94428. radius?: number,
  94429. /**
  94430. * The range of emission [0-1] 0 Surface only, 1 Entire Radius.
  94431. */
  94432. radiusRange?: number,
  94433. /**
  94434. * How much to randomize the particle direction [0-1].
  94435. */
  94436. directionRandomizer?: number);
  94437. /**
  94438. * Called by the particle System when the direction is computed for the created particle.
  94439. * @param worldMatrix is the world matrix of the particle system
  94440. * @param directionToUpdate is the direction vector to update with the result
  94441. * @param particle is the particle we are computed the direction for
  94442. * @param isLocal defines if the direction should be set in local space
  94443. */
  94444. startDirectionFunction(worldMatrix: Matrix, directionToUpdate: Vector3, particle: Particle, isLocal: boolean): void;
  94445. /**
  94446. * Called by the particle System when the position is computed for the created particle.
  94447. * @param worldMatrix is the world matrix of the particle system
  94448. * @param positionToUpdate is the position vector to update with the result
  94449. * @param particle is the particle we are computed the position for
  94450. * @param isLocal defines if the position should be set in local space
  94451. */
  94452. startPositionFunction(worldMatrix: Matrix, positionToUpdate: Vector3, particle: Particle, isLocal: boolean): void;
  94453. /**
  94454. * Clones the current emitter and returns a copy of it
  94455. * @returns the new emitter
  94456. */
  94457. clone(): HemisphericParticleEmitter;
  94458. /**
  94459. * Called by the GPUParticleSystem to setup the update shader
  94460. * @param effect defines the update shader
  94461. */
  94462. applyToShader(effect: Effect): void;
  94463. /**
  94464. * Returns a string to use to update the GPU particles update shader
  94465. * @returns a string containng the defines string
  94466. */
  94467. getEffectDefines(): string;
  94468. /**
  94469. * Returns the string "HemisphericParticleEmitter"
  94470. * @returns a string containing the class name
  94471. */
  94472. getClassName(): string;
  94473. /**
  94474. * Serializes the particle system to a JSON object.
  94475. * @returns the JSON object
  94476. */
  94477. serialize(): any;
  94478. /**
  94479. * Parse properties from a JSON object
  94480. * @param serializationObject defines the JSON object
  94481. */
  94482. parse(serializationObject: any): void;
  94483. }
  94484. }
  94485. declare module BABYLON {
  94486. /**
  94487. * Particle emitter emitting particles from a point.
  94488. * It emits the particles randomly between 2 given directions.
  94489. */
  94490. export class PointParticleEmitter implements IParticleEmitterType {
  94491. /**
  94492. * Random direction of each particle after it has been emitted, between direction1 and direction2 vectors.
  94493. */
  94494. direction1: Vector3;
  94495. /**
  94496. * Random direction of each particle after it has been emitted, between direction1 and direction2 vectors.
  94497. */
  94498. direction2: Vector3;
  94499. /**
  94500. * Creates a new instance PointParticleEmitter
  94501. */
  94502. constructor();
  94503. /**
  94504. * Called by the particle System when the direction is computed for the created particle.
  94505. * @param worldMatrix is the world matrix of the particle system
  94506. * @param directionToUpdate is the direction vector to update with the result
  94507. * @param particle is the particle we are computed the direction for
  94508. * @param isLocal defines if the direction should be set in local space
  94509. */
  94510. startDirectionFunction(worldMatrix: Matrix, directionToUpdate: Vector3, particle: Particle, isLocal: boolean): void;
  94511. /**
  94512. * Called by the particle System when the position is computed for the created particle.
  94513. * @param worldMatrix is the world matrix of the particle system
  94514. * @param positionToUpdate is the position vector to update with the result
  94515. * @param particle is the particle we are computed the position for
  94516. * @param isLocal defines if the position should be set in local space
  94517. */
  94518. startPositionFunction(worldMatrix: Matrix, positionToUpdate: Vector3, particle: Particle, isLocal: boolean): void;
  94519. /**
  94520. * Clones the current emitter and returns a copy of it
  94521. * @returns the new emitter
  94522. */
  94523. clone(): PointParticleEmitter;
  94524. /**
  94525. * Called by the GPUParticleSystem to setup the update shader
  94526. * @param effect defines the update shader
  94527. */
  94528. applyToShader(effect: Effect): void;
  94529. /**
  94530. * Returns a string to use to update the GPU particles update shader
  94531. * @returns a string containng the defines string
  94532. */
  94533. getEffectDefines(): string;
  94534. /**
  94535. * Returns the string "PointParticleEmitter"
  94536. * @returns a string containing the class name
  94537. */
  94538. getClassName(): string;
  94539. /**
  94540. * Serializes the particle system to a JSON object.
  94541. * @returns the JSON object
  94542. */
  94543. serialize(): any;
  94544. /**
  94545. * Parse properties from a JSON object
  94546. * @param serializationObject defines the JSON object
  94547. */
  94548. parse(serializationObject: any): void;
  94549. }
  94550. }
  94551. declare module BABYLON {
  94552. /**
  94553. * Particle emitter emitting particles from the inside of a sphere.
  94554. * It emits the particles alongside the sphere radius. The emission direction might be randomized.
  94555. */
  94556. export class SphereParticleEmitter implements IParticleEmitterType {
  94557. /**
  94558. * The radius of the emission sphere.
  94559. */
  94560. radius: number;
  94561. /**
  94562. * The range of emission [0-1] 0 Surface only, 1 Entire Radius.
  94563. */
  94564. radiusRange: number;
  94565. /**
  94566. * How much to randomize the particle direction [0-1].
  94567. */
  94568. directionRandomizer: number;
  94569. /**
  94570. * Creates a new instance SphereParticleEmitter
  94571. * @param radius the radius of the emission sphere (1 by default)
  94572. * @param radiusRange the range of the emission sphere [0-1] 0 Surface only, 1 Entire Radius (1 by default)
  94573. * @param directionRandomizer defines how much to randomize the particle direction [0-1]
  94574. */
  94575. constructor(
  94576. /**
  94577. * The radius of the emission sphere.
  94578. */
  94579. radius?: number,
  94580. /**
  94581. * The range of emission [0-1] 0 Surface only, 1 Entire Radius.
  94582. */
  94583. radiusRange?: number,
  94584. /**
  94585. * How much to randomize the particle direction [0-1].
  94586. */
  94587. directionRandomizer?: number);
  94588. /**
  94589. * Called by the particle System when the direction is computed for the created particle.
  94590. * @param worldMatrix is the world matrix of the particle system
  94591. * @param directionToUpdate is the direction vector to update with the result
  94592. * @param particle is the particle we are computed the direction for
  94593. * @param isLocal defines if the direction should be set in local space
  94594. */
  94595. startDirectionFunction(worldMatrix: Matrix, directionToUpdate: Vector3, particle: Particle, isLocal: boolean): void;
  94596. /**
  94597. * Called by the particle System when the position is computed for the created particle.
  94598. * @param worldMatrix is the world matrix of the particle system
  94599. * @param positionToUpdate is the position vector to update with the result
  94600. * @param particle is the particle we are computed the position for
  94601. * @param isLocal defines if the position should be set in local space
  94602. */
  94603. startPositionFunction(worldMatrix: Matrix, positionToUpdate: Vector3, particle: Particle, isLocal: boolean): void;
  94604. /**
  94605. * Clones the current emitter and returns a copy of it
  94606. * @returns the new emitter
  94607. */
  94608. clone(): SphereParticleEmitter;
  94609. /**
  94610. * Called by the GPUParticleSystem to setup the update shader
  94611. * @param effect defines the update shader
  94612. */
  94613. applyToShader(effect: Effect): void;
  94614. /**
  94615. * Returns a string to use to update the GPU particles update shader
  94616. * @returns a string containng the defines string
  94617. */
  94618. getEffectDefines(): string;
  94619. /**
  94620. * Returns the string "SphereParticleEmitter"
  94621. * @returns a string containing the class name
  94622. */
  94623. getClassName(): string;
  94624. /**
  94625. * Serializes the particle system to a JSON object.
  94626. * @returns the JSON object
  94627. */
  94628. serialize(): any;
  94629. /**
  94630. * Parse properties from a JSON object
  94631. * @param serializationObject defines the JSON object
  94632. */
  94633. parse(serializationObject: any): void;
  94634. }
  94635. /**
  94636. * Particle emitter emitting particles from the inside of a sphere.
  94637. * It emits the particles randomly between two vectors.
  94638. */
  94639. export class SphereDirectedParticleEmitter extends SphereParticleEmitter {
  94640. /**
  94641. * The min limit of the emission direction.
  94642. */
  94643. direction1: Vector3;
  94644. /**
  94645. * The max limit of the emission direction.
  94646. */
  94647. direction2: Vector3;
  94648. /**
  94649. * Creates a new instance SphereDirectedParticleEmitter
  94650. * @param radius the radius of the emission sphere (1 by default)
  94651. * @param direction1 the min limit of the emission direction (up vector by default)
  94652. * @param direction2 the max limit of the emission direction (up vector by default)
  94653. */
  94654. constructor(radius?: number,
  94655. /**
  94656. * The min limit of the emission direction.
  94657. */
  94658. direction1?: Vector3,
  94659. /**
  94660. * The max limit of the emission direction.
  94661. */
  94662. direction2?: Vector3);
  94663. /**
  94664. * Called by the particle System when the direction is computed for the created particle.
  94665. * @param worldMatrix is the world matrix of the particle system
  94666. * @param directionToUpdate is the direction vector to update with the result
  94667. * @param particle is the particle we are computed the direction for
  94668. */
  94669. startDirectionFunction(worldMatrix: Matrix, directionToUpdate: Vector3, particle: Particle): void;
  94670. /**
  94671. * Clones the current emitter and returns a copy of it
  94672. * @returns the new emitter
  94673. */
  94674. clone(): SphereDirectedParticleEmitter;
  94675. /**
  94676. * Called by the GPUParticleSystem to setup the update shader
  94677. * @param effect defines the update shader
  94678. */
  94679. applyToShader(effect: Effect): void;
  94680. /**
  94681. * Returns a string to use to update the GPU particles update shader
  94682. * @returns a string containng the defines string
  94683. */
  94684. getEffectDefines(): string;
  94685. /**
  94686. * Returns the string "SphereDirectedParticleEmitter"
  94687. * @returns a string containing the class name
  94688. */
  94689. getClassName(): string;
  94690. /**
  94691. * Serializes the particle system to a JSON object.
  94692. * @returns the JSON object
  94693. */
  94694. serialize(): any;
  94695. /**
  94696. * Parse properties from a JSON object
  94697. * @param serializationObject defines the JSON object
  94698. */
  94699. parse(serializationObject: any): void;
  94700. }
  94701. }
  94702. declare module BABYLON {
  94703. /**
  94704. * Particle emitter emitting particles from a custom list of positions.
  94705. */
  94706. export class CustomParticleEmitter implements IParticleEmitterType {
  94707. /**
  94708. * Gets or sets the position generator that will create the inital position of each particle.
  94709. * Index will be provided when used with GPU particle. Particle will be provided when used with CPU particles
  94710. */
  94711. particlePositionGenerator: (index: number, particle: Nullable<Particle>, outPosition: Vector3) => void;
  94712. /**
  94713. * Gets or sets the destination generator that will create the final destination of each particle.
  94714. * * Index will be provided when used with GPU particle. Particle will be provided when used with CPU particles
  94715. */
  94716. particleDestinationGenerator: (index: number, particle: Nullable<Particle>, outDestination: Vector3) => void;
  94717. /**
  94718. * Creates a new instance CustomParticleEmitter
  94719. */
  94720. constructor();
  94721. /**
  94722. * Called by the particle System when the direction is computed for the created particle.
  94723. * @param worldMatrix is the world matrix of the particle system
  94724. * @param directionToUpdate is the direction vector to update with the result
  94725. * @param particle is the particle we are computed the direction for
  94726. * @param isLocal defines if the direction should be set in local space
  94727. */
  94728. startDirectionFunction(worldMatrix: Matrix, directionToUpdate: Vector3, particle: Particle, isLocal: boolean): void;
  94729. /**
  94730. * Called by the particle System when the position is computed for the created particle.
  94731. * @param worldMatrix is the world matrix of the particle system
  94732. * @param positionToUpdate is the position vector to update with the result
  94733. * @param particle is the particle we are computed the position for
  94734. * @param isLocal defines if the position should be set in local space
  94735. */
  94736. startPositionFunction(worldMatrix: Matrix, positionToUpdate: Vector3, particle: Particle, isLocal: boolean): void;
  94737. /**
  94738. * Clones the current emitter and returns a copy of it
  94739. * @returns the new emitter
  94740. */
  94741. clone(): CustomParticleEmitter;
  94742. /**
  94743. * Called by the GPUParticleSystem to setup the update shader
  94744. * @param effect defines the update shader
  94745. */
  94746. applyToShader(effect: Effect): void;
  94747. /**
  94748. * Returns a string to use to update the GPU particles update shader
  94749. * @returns a string containng the defines string
  94750. */
  94751. getEffectDefines(): string;
  94752. /**
  94753. * Returns the string "PointParticleEmitter"
  94754. * @returns a string containing the class name
  94755. */
  94756. getClassName(): string;
  94757. /**
  94758. * Serializes the particle system to a JSON object.
  94759. * @returns the JSON object
  94760. */
  94761. serialize(): any;
  94762. /**
  94763. * Parse properties from a JSON object
  94764. * @param serializationObject defines the JSON object
  94765. */
  94766. parse(serializationObject: any): void;
  94767. }
  94768. }
  94769. declare module BABYLON {
  94770. /**
  94771. * Particle emitter emitting particles from the inside of a box.
  94772. * It emits the particles randomly between 2 given directions.
  94773. */
  94774. export class MeshParticleEmitter implements IParticleEmitterType {
  94775. private _indices;
  94776. private _positions;
  94777. private _normals;
  94778. private _storedNormal;
  94779. private _mesh;
  94780. /**
  94781. * Random direction of each particle after it has been emitted, between direction1 and direction2 vectors.
  94782. */
  94783. direction1: Vector3;
  94784. /**
  94785. * Random direction of each particle after it has been emitted, between direction1 and direction2 vectors.
  94786. */
  94787. direction2: Vector3;
  94788. /**
  94789. * Gets or sets a boolean indicating that particle directions must be built from mesh face normals
  94790. */
  94791. useMeshNormalsForDirection: boolean;
  94792. /** Defines the mesh to use as source */
  94793. get mesh(): Nullable<AbstractMesh>;
  94794. set mesh(value: Nullable<AbstractMesh>);
  94795. /**
  94796. * Creates a new instance MeshParticleEmitter
  94797. * @param mesh defines the mesh to use as source
  94798. */
  94799. constructor(mesh?: Nullable<AbstractMesh>);
  94800. /**
  94801. * Called by the particle System when the direction is computed for the created particle.
  94802. * @param worldMatrix is the world matrix of the particle system
  94803. * @param directionToUpdate is the direction vector to update with the result
  94804. * @param particle is the particle we are computed the direction for
  94805. * @param isLocal defines if the direction should be set in local space
  94806. */
  94807. startDirectionFunction(worldMatrix: Matrix, directionToUpdate: Vector3, particle: Particle, isLocal: boolean): void;
  94808. /**
  94809. * Called by the particle System when the position is computed for the created particle.
  94810. * @param worldMatrix is the world matrix of the particle system
  94811. * @param positionToUpdate is the position vector to update with the result
  94812. * @param particle is the particle we are computed the position for
  94813. * @param isLocal defines if the position should be set in local space
  94814. */
  94815. startPositionFunction(worldMatrix: Matrix, positionToUpdate: Vector3, particle: Particle, isLocal: boolean): void;
  94816. /**
  94817. * Clones the current emitter and returns a copy of it
  94818. * @returns the new emitter
  94819. */
  94820. clone(): MeshParticleEmitter;
  94821. /**
  94822. * Called by the GPUParticleSystem to setup the update shader
  94823. * @param effect defines the update shader
  94824. */
  94825. applyToShader(effect: Effect): void;
  94826. /**
  94827. * Returns a string to use to update the GPU particles update shader
  94828. * @returns a string containng the defines string
  94829. */
  94830. getEffectDefines(): string;
  94831. /**
  94832. * Returns the string "BoxParticleEmitter"
  94833. * @returns a string containing the class name
  94834. */
  94835. getClassName(): string;
  94836. /**
  94837. * Serializes the particle system to a JSON object.
  94838. * @returns the JSON object
  94839. */
  94840. serialize(): any;
  94841. /**
  94842. * Parse properties from a JSON object
  94843. * @param serializationObject defines the JSON object
  94844. * @param scene defines the hosting scene
  94845. */
  94846. parse(serializationObject: any, scene: Nullable<Scene>): void;
  94847. }
  94848. }
  94849. declare module BABYLON {
  94850. /**
  94851. * Interface representing a particle system in Babylon.js.
  94852. * This groups the common functionalities that needs to be implemented in order to create a particle system.
  94853. * A particle system represents a way to manage particles from their emission to their animation and rendering.
  94854. */
  94855. export interface IParticleSystem {
  94856. /**
  94857. * List of animations used by the particle system.
  94858. */
  94859. animations: Animation[];
  94860. /**
  94861. * The id of the Particle system.
  94862. */
  94863. id: string;
  94864. /**
  94865. * The name of the Particle system.
  94866. */
  94867. name: string;
  94868. /**
  94869. * The emitter represents the Mesh or position we are attaching the particle system to.
  94870. */
  94871. emitter: Nullable<AbstractMesh | Vector3>;
  94872. /**
  94873. * Gets or sets a boolean indicating if the particles must be rendered as billboard or aligned with the direction
  94874. */
  94875. isBillboardBased: boolean;
  94876. /**
  94877. * The rendering group used by the Particle system to chose when to render.
  94878. */
  94879. renderingGroupId: number;
  94880. /**
  94881. * The layer mask we are rendering the particles through.
  94882. */
  94883. layerMask: number;
  94884. /**
  94885. * The overall motion speed (0.01 is default update speed, faster updates = faster animation)
  94886. */
  94887. updateSpeed: number;
  94888. /**
  94889. * The amount of time the particle system is running (depends of the overall update speed).
  94890. */
  94891. targetStopDuration: number;
  94892. /**
  94893. * The texture used to render each particle. (this can be a spritesheet)
  94894. */
  94895. particleTexture: Nullable<BaseTexture>;
  94896. /**
  94897. * Blend mode use to render the particle, it can be either ParticleSystem.BLENDMODE_ONEONE, ParticleSystem.BLENDMODE_STANDARD or ParticleSystem.BLENDMODE_ADD.
  94898. */
  94899. blendMode: number;
  94900. /**
  94901. * Minimum life time of emitting particles.
  94902. */
  94903. minLifeTime: number;
  94904. /**
  94905. * Maximum life time of emitting particles.
  94906. */
  94907. maxLifeTime: number;
  94908. /**
  94909. * Minimum Size of emitting particles.
  94910. */
  94911. minSize: number;
  94912. /**
  94913. * Maximum Size of emitting particles.
  94914. */
  94915. maxSize: number;
  94916. /**
  94917. * Minimum scale of emitting particles on X axis.
  94918. */
  94919. minScaleX: number;
  94920. /**
  94921. * Maximum scale of emitting particles on X axis.
  94922. */
  94923. maxScaleX: number;
  94924. /**
  94925. * Minimum scale of emitting particles on Y axis.
  94926. */
  94927. minScaleY: number;
  94928. /**
  94929. * Maximum scale of emitting particles on Y axis.
  94930. */
  94931. maxScaleY: number;
  94932. /**
  94933. * Random color of each particle after it has been emitted, between color1 and color2 vectors.
  94934. */
  94935. color1: Color4;
  94936. /**
  94937. * Random color of each particle after it has been emitted, between color1 and color2 vectors.
  94938. */
  94939. color2: Color4;
  94940. /**
  94941. * Color the particle will have at the end of its lifetime.
  94942. */
  94943. colorDead: Color4;
  94944. /**
  94945. * The maximum number of particles to emit per frame until we reach the activeParticleCount value
  94946. */
  94947. emitRate: number;
  94948. /**
  94949. * You can use gravity if you want to give an orientation to your particles.
  94950. */
  94951. gravity: Vector3;
  94952. /**
  94953. * Minimum power of emitting particles.
  94954. */
  94955. minEmitPower: number;
  94956. /**
  94957. * Maximum power of emitting particles.
  94958. */
  94959. maxEmitPower: number;
  94960. /**
  94961. * Minimum angular speed of emitting particles (Z-axis rotation for each particle).
  94962. */
  94963. minAngularSpeed: number;
  94964. /**
  94965. * Maximum angular speed of emitting particles (Z-axis rotation for each particle).
  94966. */
  94967. maxAngularSpeed: number;
  94968. /**
  94969. * Gets or sets the minimal initial rotation in radians.
  94970. */
  94971. minInitialRotation: number;
  94972. /**
  94973. * Gets or sets the maximal initial rotation in radians.
  94974. */
  94975. maxInitialRotation: number;
  94976. /**
  94977. * The particle emitter type defines the emitter used by the particle system.
  94978. * It can be for example box, sphere, or cone...
  94979. */
  94980. particleEmitterType: Nullable<IParticleEmitterType>;
  94981. /**
  94982. * Defines the delay in milliseconds before starting the system (0 by default)
  94983. */
  94984. startDelay: number;
  94985. /**
  94986. * 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
  94987. */
  94988. preWarmCycles: number;
  94989. /**
  94990. * Gets or sets a value indicating the time step multiplier to use in pre-warm mode (default is 1)
  94991. */
  94992. preWarmStepOffset: number;
  94993. /**
  94994. * 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)
  94995. */
  94996. spriteCellChangeSpeed: number;
  94997. /**
  94998. * If using a spritesheet (isAnimationSheetEnabled) defines the first sprite cell to display
  94999. */
  95000. startSpriteCellID: number;
  95001. /**
  95002. * If using a spritesheet (isAnimationSheetEnabled) defines the last sprite cell to display
  95003. */
  95004. endSpriteCellID: number;
  95005. /**
  95006. * If using a spritesheet (isAnimationSheetEnabled), defines the sprite cell width to use
  95007. */
  95008. spriteCellWidth: number;
  95009. /**
  95010. * If using a spritesheet (isAnimationSheetEnabled), defines the sprite cell height to use
  95011. */
  95012. spriteCellHeight: number;
  95013. /**
  95014. * This allows the system to random pick the start cell ID between startSpriteCellID and endSpriteCellID
  95015. */
  95016. spriteRandomStartCell: boolean;
  95017. /**
  95018. * Gets or sets a boolean indicating if a spritesheet is used to animate the particles texture
  95019. */
  95020. isAnimationSheetEnabled: boolean;
  95021. /** Gets or sets a Vector2 used to move the pivot (by default (0,0)) */
  95022. translationPivot: Vector2;
  95023. /**
  95024. * Gets or sets a texture used to add random noise to particle positions
  95025. */
  95026. noiseTexture: Nullable<BaseTexture>;
  95027. /** Gets or sets the strength to apply to the noise value (default is (10, 10, 10)) */
  95028. noiseStrength: Vector3;
  95029. /**
  95030. * Gets or sets the billboard mode to use when isBillboardBased = true.
  95031. * Value can be: ParticleSystem.BILLBOARDMODE_ALL, ParticleSystem.BILLBOARDMODE_Y, ParticleSystem.BILLBOARDMODE_STRETCHED
  95032. */
  95033. billboardMode: number;
  95034. /** Gets or sets a value indicating the damping to apply if the limit velocity factor is reached */
  95035. limitVelocityDamping: number;
  95036. /**
  95037. * Gets or sets a boolean indicating that hosted animations (in the system.animations array) must be started when system.start() is called
  95038. */
  95039. beginAnimationOnStart: boolean;
  95040. /**
  95041. * Gets or sets the frame to start the animation from when beginAnimationOnStart is true
  95042. */
  95043. beginAnimationFrom: number;
  95044. /**
  95045. * Gets or sets the frame to end the animation on when beginAnimationOnStart is true
  95046. */
  95047. beginAnimationTo: number;
  95048. /**
  95049. * Gets or sets a boolean indicating if animations must loop when beginAnimationOnStart is true
  95050. */
  95051. beginAnimationLoop: boolean;
  95052. /**
  95053. * Specifies whether the particle system will be disposed once it reaches the end of the animation.
  95054. */
  95055. disposeOnStop: boolean;
  95056. /**
  95057. * Specifies if the particles are updated in emitter local space or world space
  95058. */
  95059. isLocal: boolean;
  95060. /** Snippet ID if the particle system was created from the snippet server */
  95061. snippetId: string;
  95062. /** Gets or sets a matrix to use to compute projection */
  95063. defaultProjectionMatrix: Matrix;
  95064. /**
  95065. * Gets the maximum number of particles active at the same time.
  95066. * @returns The max number of active particles.
  95067. */
  95068. getCapacity(): number;
  95069. /**
  95070. * Gets the number of particles active at the same time.
  95071. * @returns The number of active particles.
  95072. */
  95073. getActiveCount(): number;
  95074. /**
  95075. * Gets if the system has been started. (Note: this will still be true after stop is called)
  95076. * @returns True if it has been started, otherwise false.
  95077. */
  95078. isStarted(): boolean;
  95079. /**
  95080. * Animates the particle system for this frame.
  95081. */
  95082. animate(): void;
  95083. /**
  95084. * Renders the particle system in its current state.
  95085. * @returns the current number of particles
  95086. */
  95087. render(): number;
  95088. /**
  95089. * Dispose the particle system and frees its associated resources.
  95090. * @param disposeTexture defines if the particule texture must be disposed as well (true by default)
  95091. */
  95092. dispose(disposeTexture?: boolean): void;
  95093. /**
  95094. * An event triggered when the system is disposed
  95095. */
  95096. onDisposeObservable: Observable<IParticleSystem>;
  95097. /**
  95098. * An event triggered when the system is stopped
  95099. */
  95100. onStoppedObservable: Observable<IParticleSystem>;
  95101. /**
  95102. * Clones the particle system.
  95103. * @param name The name of the cloned object
  95104. * @param newEmitter The new emitter to use
  95105. * @returns the cloned particle system
  95106. */
  95107. clone(name: string, newEmitter: any): Nullable<IParticleSystem>;
  95108. /**
  95109. * Serializes the particle system to a JSON object
  95110. * @param serializeTexture defines if the texture must be serialized as well
  95111. * @returns the JSON object
  95112. */
  95113. serialize(serializeTexture: boolean): any;
  95114. /**
  95115. * Rebuild the particle system
  95116. */
  95117. rebuild(): void;
  95118. /** Force the system to rebuild all gradients that need to be resync */
  95119. forceRefreshGradients(): void;
  95120. /**
  95121. * Starts the particle system and begins to emit
  95122. * @param delay defines the delay in milliseconds before starting the system (0 by default)
  95123. */
  95124. start(delay?: number): void;
  95125. /**
  95126. * Stops the particle system.
  95127. */
  95128. stop(): void;
  95129. /**
  95130. * Remove all active particles
  95131. */
  95132. reset(): void;
  95133. /**
  95134. * Gets a boolean indicating that the system is stopping
  95135. * @returns true if the system is currently stopping
  95136. */
  95137. isStopping(): boolean;
  95138. /**
  95139. * Is this system ready to be used/rendered
  95140. * @return true if the system is ready
  95141. */
  95142. isReady(): boolean;
  95143. /**
  95144. * Returns the string "ParticleSystem"
  95145. * @returns a string containing the class name
  95146. */
  95147. getClassName(): string;
  95148. /**
  95149. * Gets the custom effect used to render the particles
  95150. * @param blendMode Blend mode for which the effect should be retrieved
  95151. * @returns The effect
  95152. */
  95153. getCustomEffect(blendMode: number): Nullable<Effect>;
  95154. /**
  95155. * Sets the custom effect used to render the particles
  95156. * @param effect The effect to set
  95157. * @param blendMode Blend mode for which the effect should be set
  95158. */
  95159. setCustomEffect(effect: Nullable<Effect>, blendMode: number): void;
  95160. /**
  95161. * Fill the defines array according to the current settings of the particle system
  95162. * @param defines Array to be updated
  95163. * @param blendMode blend mode to take into account when updating the array
  95164. */
  95165. fillDefines(defines: Array<string>, blendMode: number): void;
  95166. /**
  95167. * Fill the uniforms, attributes and samplers arrays according to the current settings of the particle system
  95168. * @param uniforms Uniforms array to fill
  95169. * @param attributes Attributes array to fill
  95170. * @param samplers Samplers array to fill
  95171. */
  95172. fillUniformsAttributesAndSamplerNames(uniforms: Array<string>, attributes: Array<string>, samplers: Array<string>): void;
  95173. /**
  95174. * Observable that will be called just before the particles are drawn
  95175. */
  95176. onBeforeDrawParticlesObservable: Observable<Nullable<Effect>>;
  95177. /**
  95178. * Gets the name of the particle vertex shader
  95179. */
  95180. vertexShaderName: string;
  95181. /**
  95182. * Adds a new color gradient
  95183. * @param gradient defines the gradient to use (between 0 and 1)
  95184. * @param color1 defines the color to affect to the specified gradient
  95185. * @param color2 defines an additional color used to define a range ([color, color2]) with main color to pick the final color from
  95186. * @returns the current particle system
  95187. */
  95188. addColorGradient(gradient: number, color1: Color4, color2?: Color4): IParticleSystem;
  95189. /**
  95190. * Remove a specific color gradient
  95191. * @param gradient defines the gradient to remove
  95192. * @returns the current particle system
  95193. */
  95194. removeColorGradient(gradient: number): IParticleSystem;
  95195. /**
  95196. * Adds a new size gradient
  95197. * @param gradient defines the gradient to use (between 0 and 1)
  95198. * @param factor defines the size factor to affect to the specified gradient
  95199. * @param factor2 defines an additional factor used to define a range ([factor, factor2]) with main value to pick the final value from
  95200. * @returns the current particle system
  95201. */
  95202. addSizeGradient(gradient: number, factor: number, factor2?: number): IParticleSystem;
  95203. /**
  95204. * Remove a specific size gradient
  95205. * @param gradient defines the gradient to remove
  95206. * @returns the current particle system
  95207. */
  95208. removeSizeGradient(gradient: number): IParticleSystem;
  95209. /**
  95210. * Gets the current list of color gradients.
  95211. * You must use addColorGradient and removeColorGradient to udpate this list
  95212. * @returns the list of color gradients
  95213. */
  95214. getColorGradients(): Nullable<Array<ColorGradient>>;
  95215. /**
  95216. * Gets the current list of size gradients.
  95217. * You must use addSizeGradient and removeSizeGradient to udpate this list
  95218. * @returns the list of size gradients
  95219. */
  95220. getSizeGradients(): Nullable<Array<FactorGradient>>;
  95221. /**
  95222. * Gets the current list of angular speed gradients.
  95223. * You must use addAngularSpeedGradient and removeAngularSpeedGradient to udpate this list
  95224. * @returns the list of angular speed gradients
  95225. */
  95226. getAngularSpeedGradients(): Nullable<Array<FactorGradient>>;
  95227. /**
  95228. * Adds a new angular speed gradient
  95229. * @param gradient defines the gradient to use (between 0 and 1)
  95230. * @param factor defines the angular speed to affect to the specified gradient
  95231. * @param factor2 defines an additional factor used to define a range ([factor, factor2]) with main value to pick the final value from
  95232. * @returns the current particle system
  95233. */
  95234. addAngularSpeedGradient(gradient: number, factor: number, factor2?: number): IParticleSystem;
  95235. /**
  95236. * Remove a specific angular speed gradient
  95237. * @param gradient defines the gradient to remove
  95238. * @returns the current particle system
  95239. */
  95240. removeAngularSpeedGradient(gradient: number): IParticleSystem;
  95241. /**
  95242. * Gets the current list of velocity gradients.
  95243. * You must use addVelocityGradient and removeVelocityGradient to udpate this list
  95244. * @returns the list of velocity gradients
  95245. */
  95246. getVelocityGradients(): Nullable<Array<FactorGradient>>;
  95247. /**
  95248. * Adds a new velocity gradient
  95249. * @param gradient defines the gradient to use (between 0 and 1)
  95250. * @param factor defines the velocity to affect to the specified gradient
  95251. * @param factor2 defines an additional factor used to define a range ([factor, factor2]) with main value to pick the final value from
  95252. * @returns the current particle system
  95253. */
  95254. addVelocityGradient(gradient: number, factor: number, factor2?: number): IParticleSystem;
  95255. /**
  95256. * Remove a specific velocity gradient
  95257. * @param gradient defines the gradient to remove
  95258. * @returns the current particle system
  95259. */
  95260. removeVelocityGradient(gradient: number): IParticleSystem;
  95261. /**
  95262. * Gets the current list of limit velocity gradients.
  95263. * You must use addLimitVelocityGradient and removeLimitVelocityGradient to udpate this list
  95264. * @returns the list of limit velocity gradients
  95265. */
  95266. getLimitVelocityGradients(): Nullable<Array<FactorGradient>>;
  95267. /**
  95268. * Adds a new limit velocity gradient
  95269. * @param gradient defines the gradient to use (between 0 and 1)
  95270. * @param factor defines the limit velocity to affect to the specified gradient
  95271. * @param factor2 defines an additional factor used to define a range ([factor, factor2]) with main value to pick the final value from
  95272. * @returns the current particle system
  95273. */
  95274. addLimitVelocityGradient(gradient: number, factor: number, factor2?: number): IParticleSystem;
  95275. /**
  95276. * Remove a specific limit velocity gradient
  95277. * @param gradient defines the gradient to remove
  95278. * @returns the current particle system
  95279. */
  95280. removeLimitVelocityGradient(gradient: number): IParticleSystem;
  95281. /**
  95282. * Adds a new drag gradient
  95283. * @param gradient defines the gradient to use (between 0 and 1)
  95284. * @param factor defines the drag to affect to the specified gradient
  95285. * @param factor2 defines an additional factor used to define a range ([factor, factor2]) with main value to pick the final value from
  95286. * @returns the current particle system
  95287. */
  95288. addDragGradient(gradient: number, factor: number, factor2?: number): IParticleSystem;
  95289. /**
  95290. * Remove a specific drag gradient
  95291. * @param gradient defines the gradient to remove
  95292. * @returns the current particle system
  95293. */
  95294. removeDragGradient(gradient: number): IParticleSystem;
  95295. /**
  95296. * Gets the current list of drag gradients.
  95297. * You must use addDragGradient and removeDragGradient to udpate this list
  95298. * @returns the list of drag gradients
  95299. */
  95300. getDragGradients(): Nullable<Array<FactorGradient>>;
  95301. /**
  95302. * Adds a new emit rate gradient (please note that this will only work if you set the targetStopDuration property)
  95303. * @param gradient defines the gradient to use (between 0 and 1)
  95304. * @param factor defines the emit rate to affect to the specified gradient
  95305. * @param factor2 defines an additional factor used to define a range ([factor, factor2]) with main value to pick the final value from
  95306. * @returns the current particle system
  95307. */
  95308. addEmitRateGradient(gradient: number, factor: number, factor2?: number): IParticleSystem;
  95309. /**
  95310. * Remove a specific emit rate gradient
  95311. * @param gradient defines the gradient to remove
  95312. * @returns the current particle system
  95313. */
  95314. removeEmitRateGradient(gradient: number): IParticleSystem;
  95315. /**
  95316. * Gets the current list of emit rate gradients.
  95317. * You must use addEmitRateGradient and removeEmitRateGradient to udpate this list
  95318. * @returns the list of emit rate gradients
  95319. */
  95320. getEmitRateGradients(): Nullable<Array<FactorGradient>>;
  95321. /**
  95322. * Adds a new start size gradient (please note that this will only work if you set the targetStopDuration property)
  95323. * @param gradient defines the gradient to use (between 0 and 1)
  95324. * @param factor defines the start size to affect to the specified gradient
  95325. * @param factor2 defines an additional factor used to define a range ([factor, factor2]) with main value to pick the final value from
  95326. * @returns the current particle system
  95327. */
  95328. addStartSizeGradient(gradient: number, factor: number, factor2?: number): IParticleSystem;
  95329. /**
  95330. * Remove a specific start size gradient
  95331. * @param gradient defines the gradient to remove
  95332. * @returns the current particle system
  95333. */
  95334. removeStartSizeGradient(gradient: number): IParticleSystem;
  95335. /**
  95336. * Gets the current list of start size gradients.
  95337. * You must use addStartSizeGradient and removeStartSizeGradient to udpate this list
  95338. * @returns the list of start size gradients
  95339. */
  95340. getStartSizeGradients(): Nullable<Array<FactorGradient>>;
  95341. /**
  95342. * Adds a new life time gradient
  95343. * @param gradient defines the gradient to use (between 0 and 1)
  95344. * @param factor defines the life time factor to affect to the specified gradient
  95345. * @param factor2 defines an additional factor used to define a range ([factor, factor2]) with main value to pick the final value from
  95346. * @returns the current particle system
  95347. */
  95348. addLifeTimeGradient(gradient: number, factor: number, factor2?: number): IParticleSystem;
  95349. /**
  95350. * Remove a specific life time gradient
  95351. * @param gradient defines the gradient to remove
  95352. * @returns the current particle system
  95353. */
  95354. removeLifeTimeGradient(gradient: number): IParticleSystem;
  95355. /**
  95356. * Gets the current list of life time gradients.
  95357. * You must use addLifeTimeGradient and removeLifeTimeGradient to udpate this list
  95358. * @returns the list of life time gradients
  95359. */
  95360. getLifeTimeGradients(): Nullable<Array<FactorGradient>>;
  95361. /**
  95362. * Gets the current list of color gradients.
  95363. * You must use addColorGradient and removeColorGradient to udpate this list
  95364. * @returns the list of color gradients
  95365. */
  95366. getColorGradients(): Nullable<Array<ColorGradient>>;
  95367. /**
  95368. * Adds a new ramp gradient used to remap particle colors
  95369. * @param gradient defines the gradient to use (between 0 and 1)
  95370. * @param color defines the color to affect to the specified gradient
  95371. * @returns the current particle system
  95372. */
  95373. addRampGradient(gradient: number, color: Color3): IParticleSystem;
  95374. /**
  95375. * Gets the current list of ramp gradients.
  95376. * You must use addRampGradient and removeRampGradient to udpate this list
  95377. * @returns the list of ramp gradients
  95378. */
  95379. getRampGradients(): Nullable<Array<Color3Gradient>>;
  95380. /** Gets or sets a boolean indicating that ramp gradients must be used
  95381. * @see https://doc.babylonjs.com/babylon101/particles#ramp-gradients
  95382. */
  95383. useRampGradients: boolean;
  95384. /**
  95385. * Adds a new color remap gradient
  95386. * @param gradient defines the gradient to use (between 0 and 1)
  95387. * @param min defines the color remap minimal range
  95388. * @param max defines the color remap maximal range
  95389. * @returns the current particle system
  95390. */
  95391. addColorRemapGradient(gradient: number, min: number, max: number): IParticleSystem;
  95392. /**
  95393. * Gets the current list of color remap gradients.
  95394. * You must use addColorRemapGradient and removeColorRemapGradient to udpate this list
  95395. * @returns the list of color remap gradients
  95396. */
  95397. getColorRemapGradients(): Nullable<Array<FactorGradient>>;
  95398. /**
  95399. * Adds a new alpha remap gradient
  95400. * @param gradient defines the gradient to use (between 0 and 1)
  95401. * @param min defines the alpha remap minimal range
  95402. * @param max defines the alpha remap maximal range
  95403. * @returns the current particle system
  95404. */
  95405. addAlphaRemapGradient(gradient: number, min: number, max: number): IParticleSystem;
  95406. /**
  95407. * Gets the current list of alpha remap gradients.
  95408. * You must use addAlphaRemapGradient and removeAlphaRemapGradient to udpate this list
  95409. * @returns the list of alpha remap gradients
  95410. */
  95411. getAlphaRemapGradients(): Nullable<Array<FactorGradient>>;
  95412. /**
  95413. * Creates a Point Emitter for the particle system (emits directly from the emitter position)
  95414. * @param direction1 Particles are emitted between the direction1 and direction2 from within the box
  95415. * @param direction2 Particles are emitted between the direction1 and direction2 from within the box
  95416. * @returns the emitter
  95417. */
  95418. createPointEmitter(direction1: Vector3, direction2: Vector3): PointParticleEmitter;
  95419. /**
  95420. * Creates a Hemisphere Emitter for the particle system (emits along the hemisphere radius)
  95421. * @param radius The radius of the hemisphere to emit from
  95422. * @param radiusRange The range of the hemisphere to emit from [0-1] 0 Surface Only, 1 Entire Radius
  95423. * @returns the emitter
  95424. */
  95425. createHemisphericEmitter(radius: number, radiusRange: number): HemisphericParticleEmitter;
  95426. /**
  95427. * Creates a Sphere Emitter for the particle system (emits along the sphere radius)
  95428. * @param radius The radius of the sphere to emit from
  95429. * @param radiusRange The range of the sphere to emit from [0-1] 0 Surface Only, 1 Entire Radius
  95430. * @returns the emitter
  95431. */
  95432. createSphereEmitter(radius: number, radiusRange: number): SphereParticleEmitter;
  95433. /**
  95434. * Creates a Directed Sphere Emitter for the particle system (emits between direction1 and direction2)
  95435. * @param radius The radius of the sphere to emit from
  95436. * @param direction1 Particles are emitted between the direction1 and direction2 from within the sphere
  95437. * @param direction2 Particles are emitted between the direction1 and direction2 from within the sphere
  95438. * @returns the emitter
  95439. */
  95440. createDirectedSphereEmitter(radius: number, direction1: Vector3, direction2: Vector3): SphereDirectedParticleEmitter;
  95441. /**
  95442. * Creates a Cylinder Emitter for the particle system (emits from the cylinder to the particle position)
  95443. * @param radius The radius of the emission cylinder
  95444. * @param height The height of the emission cylinder
  95445. * @param radiusRange The range of emission [0-1] 0 Surface only, 1 Entire Radius
  95446. * @param directionRandomizer How much to randomize the particle direction [0-1]
  95447. * @returns the emitter
  95448. */
  95449. createCylinderEmitter(radius: number, height: number, radiusRange: number, directionRandomizer: number): CylinderParticleEmitter;
  95450. /**
  95451. * Creates a Directed Cylinder Emitter for the particle system (emits between direction1 and direction2)
  95452. * @param radius The radius of the cylinder to emit from
  95453. * @param height The height of the emission cylinder
  95454. * @param radiusRange the range of the emission cylinder [0-1] 0 Surface only, 1 Entire Radius (1 by default)
  95455. * @param direction1 Particles are emitted between the direction1 and direction2 from within the cylinder
  95456. * @param direction2 Particles are emitted between the direction1 and direction2 from within the cylinder
  95457. * @returns the emitter
  95458. */
  95459. createDirectedCylinderEmitter(radius: number, height: number, radiusRange: number, direction1: Vector3, direction2: Vector3): SphereDirectedParticleEmitter;
  95460. /**
  95461. * Creates a Cone Emitter for the particle system (emits from the cone to the particle position)
  95462. * @param radius The radius of the cone to emit from
  95463. * @param angle The base angle of the cone
  95464. * @returns the emitter
  95465. */
  95466. createConeEmitter(radius: number, angle: number): ConeParticleEmitter;
  95467. /**
  95468. * Creates a Box Emitter for the particle system. (emits between direction1 and direction2 from withing the box defined by minEmitBox and maxEmitBox)
  95469. * @param direction1 Particles are emitted between the direction1 and direction2 from within the box
  95470. * @param direction2 Particles are emitted between the direction1 and direction2 from within the box
  95471. * @param minEmitBox Particles are emitted from the box between minEmitBox and maxEmitBox
  95472. * @param maxEmitBox Particles are emitted from the box between minEmitBox and maxEmitBox
  95473. * @returns the emitter
  95474. */
  95475. createBoxEmitter(direction1: Vector3, direction2: Vector3, minEmitBox: Vector3, maxEmitBox: Vector3): BoxParticleEmitter;
  95476. /**
  95477. * Get hosting scene
  95478. * @returns the scene
  95479. */
  95480. getScene(): Nullable<Scene>;
  95481. }
  95482. }
  95483. declare module BABYLON {
  95484. /**
  95485. * 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.
  95486. * @see https://doc.babylonjs.com/how_to/transformnode
  95487. */
  95488. export class TransformNode extends Node {
  95489. /**
  95490. * Object will not rotate to face the camera
  95491. */
  95492. static BILLBOARDMODE_NONE: number;
  95493. /**
  95494. * Object will rotate to face the camera but only on the x axis
  95495. */
  95496. static BILLBOARDMODE_X: number;
  95497. /**
  95498. * Object will rotate to face the camera but only on the y axis
  95499. */
  95500. static BILLBOARDMODE_Y: number;
  95501. /**
  95502. * Object will rotate to face the camera but only on the z axis
  95503. */
  95504. static BILLBOARDMODE_Z: number;
  95505. /**
  95506. * Object will rotate to face the camera
  95507. */
  95508. static BILLBOARDMODE_ALL: number;
  95509. /**
  95510. * Object will rotate to face the camera's position instead of orientation
  95511. */
  95512. static BILLBOARDMODE_USE_POSITION: number;
  95513. private static _TmpRotation;
  95514. private static _TmpScaling;
  95515. private static _TmpTranslation;
  95516. private _forward;
  95517. private _forwardInverted;
  95518. private _up;
  95519. private _right;
  95520. private _rightInverted;
  95521. private _position;
  95522. private _rotation;
  95523. private _rotationQuaternion;
  95524. protected _scaling: Vector3;
  95525. protected _isDirty: boolean;
  95526. private _transformToBoneReferal;
  95527. private _isAbsoluteSynced;
  95528. private _billboardMode;
  95529. /**
  95530. * Gets or sets the billboard mode. Default is 0.
  95531. *
  95532. * | Value | Type | Description |
  95533. * | --- | --- | --- |
  95534. * | 0 | BILLBOARDMODE_NONE | |
  95535. * | 1 | BILLBOARDMODE_X | |
  95536. * | 2 | BILLBOARDMODE_Y | |
  95537. * | 4 | BILLBOARDMODE_Z | |
  95538. * | 7 | BILLBOARDMODE_ALL | |
  95539. *
  95540. */
  95541. get billboardMode(): number;
  95542. set billboardMode(value: number);
  95543. private _preserveParentRotationForBillboard;
  95544. /**
  95545. * Gets or sets a boolean indicating that parent rotation should be preserved when using billboards.
  95546. * This could be useful for glTF objects where parent rotation helps converting from right handed to left handed
  95547. */
  95548. get preserveParentRotationForBillboard(): boolean;
  95549. set preserveParentRotationForBillboard(value: boolean);
  95550. /**
  95551. * 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
  95552. */
  95553. scalingDeterminant: number;
  95554. private _infiniteDistance;
  95555. /**
  95556. * Gets or sets the distance of the object to max, often used by skybox
  95557. */
  95558. get infiniteDistance(): boolean;
  95559. set infiniteDistance(value: boolean);
  95560. /**
  95561. * Gets or sets a boolean indicating that non uniform scaling (when at least one component is different from others) should be ignored.
  95562. * By default the system will update normals to compensate
  95563. */
  95564. ignoreNonUniformScaling: boolean;
  95565. /**
  95566. * 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
  95567. */
  95568. reIntegrateRotationIntoRotationQuaternion: boolean;
  95569. /** @hidden */
  95570. _poseMatrix: Nullable<Matrix>;
  95571. /** @hidden */
  95572. _localMatrix: Matrix;
  95573. private _usePivotMatrix;
  95574. private _absolutePosition;
  95575. private _absoluteScaling;
  95576. private _absoluteRotationQuaternion;
  95577. private _pivotMatrix;
  95578. private _pivotMatrixInverse;
  95579. /** @hidden */
  95580. _postMultiplyPivotMatrix: boolean;
  95581. protected _isWorldMatrixFrozen: boolean;
  95582. /** @hidden */
  95583. _indexInSceneTransformNodesArray: number;
  95584. /**
  95585. * An event triggered after the world matrix is updated
  95586. */
  95587. onAfterWorldMatrixUpdateObservable: Observable<TransformNode>;
  95588. constructor(name: string, scene?: Nullable<Scene>, isPure?: boolean);
  95589. /**
  95590. * Gets a string identifying the name of the class
  95591. * @returns "TransformNode" string
  95592. */
  95593. getClassName(): string;
  95594. /**
  95595. * Gets or set the node position (default is (0.0, 0.0, 0.0))
  95596. */
  95597. get position(): Vector3;
  95598. set position(newPosition: Vector3);
  95599. /**
  95600. * 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)).
  95601. * If rotation quaternion is set, this Vector3 will be ignored and copy from the quaternion
  95602. */
  95603. get rotation(): Vector3;
  95604. set rotation(newRotation: Vector3);
  95605. /**
  95606. * 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)).
  95607. */
  95608. get scaling(): Vector3;
  95609. set scaling(newScaling: Vector3);
  95610. /**
  95611. * 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).
  95612. * If set, only the rotationQuaternion is then used to compute the node rotation (ie. node.rotation will be ignored)
  95613. */
  95614. get rotationQuaternion(): Nullable<Quaternion>;
  95615. set rotationQuaternion(quaternion: Nullable<Quaternion>);
  95616. /**
  95617. * The forward direction of that transform in world space.
  95618. */
  95619. get forward(): Vector3;
  95620. /**
  95621. * The up direction of that transform in world space.
  95622. */
  95623. get up(): Vector3;
  95624. /**
  95625. * The right direction of that transform in world space.
  95626. */
  95627. get right(): Vector3;
  95628. /**
  95629. * Copies the parameter passed Matrix into the mesh Pose matrix.
  95630. * @param matrix the matrix to copy the pose from
  95631. * @returns this TransformNode.
  95632. */
  95633. updatePoseMatrix(matrix: Matrix): TransformNode;
  95634. /**
  95635. * Returns the mesh Pose matrix.
  95636. * @returns the pose matrix
  95637. */
  95638. getPoseMatrix(): Matrix;
  95639. /** @hidden */
  95640. _isSynchronized(): boolean;
  95641. /** @hidden */
  95642. _initCache(): void;
  95643. /**
  95644. * Flag the transform node as dirty (Forcing it to update everything)
  95645. * @param property if set to "rotation" the objects rotationQuaternion will be set to null
  95646. * @returns this transform node
  95647. */
  95648. markAsDirty(property: string): TransformNode;
  95649. /**
  95650. * Returns the current mesh absolute position.
  95651. * Returns a Vector3.
  95652. */
  95653. get absolutePosition(): Vector3;
  95654. /**
  95655. * Returns the current mesh absolute scaling.
  95656. * Returns a Vector3.
  95657. */
  95658. get absoluteScaling(): Vector3;
  95659. /**
  95660. * Returns the current mesh absolute rotation.
  95661. * Returns a Quaternion.
  95662. */
  95663. get absoluteRotationQuaternion(): Quaternion;
  95664. /**
  95665. * Sets a new matrix to apply before all other transformation
  95666. * @param matrix defines the transform matrix
  95667. * @returns the current TransformNode
  95668. */
  95669. setPreTransformMatrix(matrix: Matrix): TransformNode;
  95670. /**
  95671. * Sets a new pivot matrix to the current node
  95672. * @param matrix defines the new pivot matrix to use
  95673. * @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
  95674. * @returns the current TransformNode
  95675. */
  95676. setPivotMatrix(matrix: DeepImmutable<Matrix>, postMultiplyPivotMatrix?: boolean): TransformNode;
  95677. /**
  95678. * Returns the mesh pivot matrix.
  95679. * Default : Identity.
  95680. * @returns the matrix
  95681. */
  95682. getPivotMatrix(): Matrix;
  95683. /**
  95684. * Instantiate (when possible) or clone that node with its hierarchy
  95685. * @param newParent defines the new parent to use for the instance (or clone)
  95686. * @param options defines options to configure how copy is done
  95687. * @param onNewNodeCreated defines an option callback to call when a clone or an instance is created
  95688. * @returns an instance (or a clone) of the current node with its hiearchy
  95689. */
  95690. instantiateHierarchy(newParent?: Nullable<TransformNode>, options?: {
  95691. doNotInstantiate: boolean;
  95692. }, onNewNodeCreated?: (source: TransformNode, clone: TransformNode) => void): Nullable<TransformNode>;
  95693. /**
  95694. * Prevents the World matrix to be computed any longer
  95695. * @param newWorldMatrix defines an optional matrix to use as world matrix
  95696. * @returns the TransformNode.
  95697. */
  95698. freezeWorldMatrix(newWorldMatrix?: Nullable<Matrix>): TransformNode;
  95699. /**
  95700. * Allows back the World matrix computation.
  95701. * @returns the TransformNode.
  95702. */
  95703. unfreezeWorldMatrix(): this;
  95704. /**
  95705. * True if the World matrix has been frozen.
  95706. */
  95707. get isWorldMatrixFrozen(): boolean;
  95708. /**
  95709. * Retuns the mesh absolute position in the World.
  95710. * @returns a Vector3.
  95711. */
  95712. getAbsolutePosition(): Vector3;
  95713. /**
  95714. * Sets the mesh absolute position in the World from a Vector3 or an Array(3).
  95715. * @param absolutePosition the absolute position to set
  95716. * @returns the TransformNode.
  95717. */
  95718. setAbsolutePosition(absolutePosition: Vector3): TransformNode;
  95719. /**
  95720. * Sets the mesh position in its local space.
  95721. * @param vector3 the position to set in localspace
  95722. * @returns the TransformNode.
  95723. */
  95724. setPositionWithLocalVector(vector3: Vector3): TransformNode;
  95725. /**
  95726. * Returns the mesh position in the local space from the current World matrix values.
  95727. * @returns a new Vector3.
  95728. */
  95729. getPositionExpressedInLocalSpace(): Vector3;
  95730. /**
  95731. * Translates the mesh along the passed Vector3 in its local space.
  95732. * @param vector3 the distance to translate in localspace
  95733. * @returns the TransformNode.
  95734. */
  95735. locallyTranslate(vector3: Vector3): TransformNode;
  95736. private static _lookAtVectorCache;
  95737. /**
  95738. * Orients a mesh towards a target point. Mesh must be drawn facing user.
  95739. * @param targetPoint the position (must be in same space as current mesh) to look at
  95740. * @param yawCor optional yaw (y-axis) correction in radians
  95741. * @param pitchCor optional pitch (x-axis) correction in radians
  95742. * @param rollCor optional roll (z-axis) correction in radians
  95743. * @param space the choosen space of the target
  95744. * @returns the TransformNode.
  95745. */
  95746. lookAt(targetPoint: Vector3, yawCor?: number, pitchCor?: number, rollCor?: number, space?: Space): TransformNode;
  95747. /**
  95748. * Returns a new Vector3 that is the localAxis, expressed in the mesh local space, rotated like the mesh.
  95749. * This Vector3 is expressed in the World space.
  95750. * @param localAxis axis to rotate
  95751. * @returns a new Vector3 that is the localAxis, expressed in the mesh local space, rotated like the mesh.
  95752. */
  95753. getDirection(localAxis: Vector3): Vector3;
  95754. /**
  95755. * Sets the Vector3 "result" as the rotated Vector3 "localAxis" in the same rotation than the mesh.
  95756. * localAxis is expressed in the mesh local space.
  95757. * result is computed in the Wordl space from the mesh World matrix.
  95758. * @param localAxis axis to rotate
  95759. * @param result the resulting transformnode
  95760. * @returns this TransformNode.
  95761. */
  95762. getDirectionToRef(localAxis: Vector3, result: Vector3): TransformNode;
  95763. /**
  95764. * Sets this transform node rotation to the given local axis.
  95765. * @param localAxis the axis in local space
  95766. * @param yawCor optional yaw (y-axis) correction in radians
  95767. * @param pitchCor optional pitch (x-axis) correction in radians
  95768. * @param rollCor optional roll (z-axis) correction in radians
  95769. * @returns this TransformNode
  95770. */
  95771. setDirection(localAxis: Vector3, yawCor?: number, pitchCor?: number, rollCor?: number): TransformNode;
  95772. /**
  95773. * Sets a new pivot point to the current node
  95774. * @param point defines the new pivot point to use
  95775. * @param space defines if the point is in world or local space (local by default)
  95776. * @returns the current TransformNode
  95777. */
  95778. setPivotPoint(point: Vector3, space?: Space): TransformNode;
  95779. /**
  95780. * Returns a new Vector3 set with the mesh pivot point coordinates in the local space.
  95781. * @returns the pivot point
  95782. */
  95783. getPivotPoint(): Vector3;
  95784. /**
  95785. * Sets the passed Vector3 "result" with the coordinates of the mesh pivot point in the local space.
  95786. * @param result the vector3 to store the result
  95787. * @returns this TransformNode.
  95788. */
  95789. getPivotPointToRef(result: Vector3): TransformNode;
  95790. /**
  95791. * Returns a new Vector3 set with the mesh pivot point World coordinates.
  95792. * @returns a new Vector3 set with the mesh pivot point World coordinates.
  95793. */
  95794. getAbsolutePivotPoint(): Vector3;
  95795. /**
  95796. * Sets the Vector3 "result" coordinates with the mesh pivot point World coordinates.
  95797. * @param result vector3 to store the result
  95798. * @returns this TransformNode.
  95799. */
  95800. getAbsolutePivotPointToRef(result: Vector3): TransformNode;
  95801. /**
  95802. * Defines the passed node as the parent of the current node.
  95803. * The node will remain exactly where it is and its position / rotation will be updated accordingly
  95804. * @see https://doc.babylonjs.com/how_to/parenting
  95805. * @param node the node ot set as the parent
  95806. * @returns this TransformNode.
  95807. */
  95808. setParent(node: Nullable<Node>): TransformNode;
  95809. private _nonUniformScaling;
  95810. /**
  95811. * True if the scaling property of this object is non uniform eg. (1,2,1)
  95812. */
  95813. get nonUniformScaling(): boolean;
  95814. /** @hidden */
  95815. _updateNonUniformScalingState(value: boolean): boolean;
  95816. /**
  95817. * Attach the current TransformNode to another TransformNode associated with a bone
  95818. * @param bone Bone affecting the TransformNode
  95819. * @param affectedTransformNode TransformNode associated with the bone
  95820. * @returns this object
  95821. */
  95822. attachToBone(bone: Bone, affectedTransformNode: TransformNode): TransformNode;
  95823. /**
  95824. * Detach the transform node if its associated with a bone
  95825. * @returns this object
  95826. */
  95827. detachFromBone(): TransformNode;
  95828. private static _rotationAxisCache;
  95829. /**
  95830. * Rotates the mesh around the axis vector for the passed angle (amount) expressed in radians, in the given space.
  95831. * space (default LOCAL) can be either Space.LOCAL, either Space.WORLD.
  95832. * Note that the property `rotationQuaternion` is then automatically updated and the property `rotation` is set to (0,0,0) and no longer used.
  95833. * The passed axis is also normalized.
  95834. * @param axis the axis to rotate around
  95835. * @param amount the amount to rotate in radians
  95836. * @param space Space to rotate in (Default: local)
  95837. * @returns the TransformNode.
  95838. */
  95839. rotate(axis: Vector3, amount: number, space?: Space): TransformNode;
  95840. /**
  95841. * Rotates the mesh around the axis vector for the passed angle (amount) expressed in radians, in world space.
  95842. * Note that the property `rotationQuaternion` is then automatically updated and the property `rotation` is set to (0,0,0) and no longer used.
  95843. * The passed axis is also normalized. .
  95844. * Method is based on http://www.euclideanspace.com/maths/geometry/affine/aroundPoint/index.htm
  95845. * @param point the point to rotate around
  95846. * @param axis the axis to rotate around
  95847. * @param amount the amount to rotate in radians
  95848. * @returns the TransformNode
  95849. */
  95850. rotateAround(point: Vector3, axis: Vector3, amount: number): TransformNode;
  95851. /**
  95852. * Translates the mesh along the axis vector for the passed distance in the given space.
  95853. * space (default LOCAL) can be either Space.LOCAL, either Space.WORLD.
  95854. * @param axis the axis to translate in
  95855. * @param distance the distance to translate
  95856. * @param space Space to rotate in (Default: local)
  95857. * @returns the TransformNode.
  95858. */
  95859. translate(axis: Vector3, distance: number, space?: Space): TransformNode;
  95860. /**
  95861. * Adds a rotation step to the mesh current rotation.
  95862. * x, y, z are Euler angles expressed in radians.
  95863. * This methods updates the current mesh rotation, either mesh.rotation, either mesh.rotationQuaternion if it's set.
  95864. * This means this rotation is made in the mesh local space only.
  95865. * It's useful to set a custom rotation order different from the BJS standard one YXZ.
  95866. * Example : this rotates the mesh first around its local X axis, then around its local Z axis, finally around its local Y axis.
  95867. * ```javascript
  95868. * mesh.addRotation(x1, 0, 0).addRotation(0, 0, z2).addRotation(0, 0, y3);
  95869. * ```
  95870. * Note that `addRotation()` accumulates the passed rotation values to the current ones and computes the .rotation or .rotationQuaternion updated values.
  95871. * 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.
  95872. * @param x Rotation to add
  95873. * @param y Rotation to add
  95874. * @param z Rotation to add
  95875. * @returns the TransformNode.
  95876. */
  95877. addRotation(x: number, y: number, z: number): TransformNode;
  95878. /**
  95879. * @hidden
  95880. */
  95881. protected _getEffectiveParent(): Nullable<Node>;
  95882. /**
  95883. * Computes the world matrix of the node
  95884. * @param force defines if the cache version should be invalidated forcing the world matrix to be created from scratch
  95885. * @returns the world matrix
  95886. */
  95887. computeWorldMatrix(force?: boolean): Matrix;
  95888. /**
  95889. * Resets this nodeTransform's local matrix to Matrix.Identity().
  95890. * @param independentOfChildren indicates if all child nodeTransform's world-space transform should be preserved.
  95891. */
  95892. resetLocalMatrix(independentOfChildren?: boolean): void;
  95893. protected _afterComputeWorldMatrix(): void;
  95894. /**
  95895. * If you'd like to be called back after the mesh position, rotation or scaling has been updated.
  95896. * @param func callback function to add
  95897. *
  95898. * @returns the TransformNode.
  95899. */
  95900. registerAfterWorldMatrixUpdate(func: (mesh: TransformNode) => void): TransformNode;
  95901. /**
  95902. * Removes a registered callback function.
  95903. * @param func callback function to remove
  95904. * @returns the TransformNode.
  95905. */
  95906. unregisterAfterWorldMatrixUpdate(func: (mesh: TransformNode) => void): TransformNode;
  95907. /**
  95908. * Gets the position of the current mesh in camera space
  95909. * @param camera defines the camera to use
  95910. * @returns a position
  95911. */
  95912. getPositionInCameraSpace(camera?: Nullable<Camera>): Vector3;
  95913. /**
  95914. * Returns the distance from the mesh to the active camera
  95915. * @param camera defines the camera to use
  95916. * @returns the distance
  95917. */
  95918. getDistanceToCamera(camera?: Nullable<Camera>): number;
  95919. /**
  95920. * Clone the current transform node
  95921. * @param name Name of the new clone
  95922. * @param newParent New parent for the clone
  95923. * @param doNotCloneChildren Do not clone children hierarchy
  95924. * @returns the new transform node
  95925. */
  95926. clone(name: string, newParent: Nullable<Node>, doNotCloneChildren?: boolean): Nullable<TransformNode>;
  95927. /**
  95928. * Serializes the objects information.
  95929. * @param currentSerializationObject defines the object to serialize in
  95930. * @returns the serialized object
  95931. */
  95932. serialize(currentSerializationObject?: any): any;
  95933. /**
  95934. * Returns a new TransformNode object parsed from the source provided.
  95935. * @param parsedTransformNode is the source.
  95936. * @param scene the scne the object belongs to
  95937. * @param rootUrl is a string, it's the root URL to prefix the `delayLoadingFile` property with
  95938. * @returns a new TransformNode object parsed from the source provided.
  95939. */
  95940. static Parse(parsedTransformNode: any, scene: Scene, rootUrl: string): TransformNode;
  95941. /**
  95942. * Get all child-transformNodes of this node
  95943. * @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
  95944. * @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
  95945. * @returns an array of TransformNode
  95946. */
  95947. getChildTransformNodes(directDescendantsOnly?: boolean, predicate?: (node: Node) => boolean): TransformNode[];
  95948. /**
  95949. * Releases resources associated with this transform node.
  95950. * @param doNotRecurse Set to true to not recurse into each children (recurse into each children by default)
  95951. * @param disposeMaterialAndTextures Set to true to also dispose referenced materials and textures (false by default)
  95952. */
  95953. dispose(doNotRecurse?: boolean, disposeMaterialAndTextures?: boolean): void;
  95954. /**
  95955. * Uniformly scales the mesh to fit inside of a unit cube (1 X 1 X 1 units)
  95956. * @param includeDescendants Use the hierarchy's bounding box instead of the mesh's bounding box. Default is false
  95957. * @param ignoreRotation ignore rotation when computing the scale (ie. object will be axis aligned). Default is false
  95958. * @param predicate predicate that is passed in to getHierarchyBoundingVectors when selecting which object should be included when scaling
  95959. * @returns the current mesh
  95960. */
  95961. normalizeToUnitCube(includeDescendants?: boolean, ignoreRotation?: boolean, predicate?: Nullable<(node: AbstractMesh) => boolean>): TransformNode;
  95962. private _syncAbsoluteScalingAndRotation;
  95963. }
  95964. }
  95965. declare module BABYLON {
  95966. /**
  95967. * Class used to override all child animations of a given target
  95968. */
  95969. export class AnimationPropertiesOverride {
  95970. /**
  95971. * Gets or sets a value indicating if animation blending must be used
  95972. */
  95973. enableBlending: boolean;
  95974. /**
  95975. * Gets or sets the blending speed to use when enableBlending is true
  95976. */
  95977. blendingSpeed: number;
  95978. /**
  95979. * Gets or sets the default loop mode to use
  95980. */
  95981. loopMode: number;
  95982. }
  95983. }
  95984. declare module BABYLON {
  95985. /**
  95986. * Class used to store bone information
  95987. * @see https://doc.babylonjs.com/how_to/how_to_use_bones_and_skeletons
  95988. */
  95989. export class Bone extends Node {
  95990. /**
  95991. * defines the bone name
  95992. */
  95993. name: string;
  95994. private static _tmpVecs;
  95995. private static _tmpQuat;
  95996. private static _tmpMats;
  95997. /**
  95998. * Gets the list of child bones
  95999. */
  96000. children: Bone[];
  96001. /** Gets the animations associated with this bone */
  96002. animations: Animation[];
  96003. /**
  96004. * Gets or sets bone length
  96005. */
  96006. length: number;
  96007. /**
  96008. * @hidden Internal only
  96009. * Set this value to map this bone to a different index in the transform matrices
  96010. * Set this value to -1 to exclude the bone from the transform matrices
  96011. */
  96012. _index: Nullable<number>;
  96013. private _skeleton;
  96014. private _localMatrix;
  96015. private _restPose;
  96016. private _bindPose;
  96017. private _baseMatrix;
  96018. private _absoluteTransform;
  96019. private _invertedAbsoluteTransform;
  96020. private _parent;
  96021. private _scalingDeterminant;
  96022. private _worldTransform;
  96023. private _localScaling;
  96024. private _localRotation;
  96025. private _localPosition;
  96026. private _needToDecompose;
  96027. private _needToCompose;
  96028. /** @hidden */
  96029. _linkedTransformNode: Nullable<TransformNode>;
  96030. /** @hidden */
  96031. _waitingTransformNodeId: Nullable<string>;
  96032. /** @hidden */
  96033. get _matrix(): Matrix;
  96034. /** @hidden */
  96035. set _matrix(value: Matrix);
  96036. /**
  96037. * Create a new bone
  96038. * @param name defines the bone name
  96039. * @param skeleton defines the parent skeleton
  96040. * @param parentBone defines the parent (can be null if the bone is the root)
  96041. * @param localMatrix defines the local matrix
  96042. * @param restPose defines the rest pose matrix
  96043. * @param baseMatrix defines the base matrix
  96044. * @param index defines index of the bone in the hiearchy
  96045. */
  96046. constructor(
  96047. /**
  96048. * defines the bone name
  96049. */
  96050. name: string, skeleton: Skeleton, parentBone?: Nullable<Bone>, localMatrix?: Nullable<Matrix>, restPose?: Nullable<Matrix>, baseMatrix?: Nullable<Matrix>, index?: Nullable<number>);
  96051. /**
  96052. * Gets the current object class name.
  96053. * @return the class name
  96054. */
  96055. getClassName(): string;
  96056. /**
  96057. * Gets the parent skeleton
  96058. * @returns a skeleton
  96059. */
  96060. getSkeleton(): Skeleton;
  96061. /**
  96062. * Gets parent bone
  96063. * @returns a bone or null if the bone is the root of the bone hierarchy
  96064. */
  96065. getParent(): Nullable<Bone>;
  96066. /**
  96067. * Returns an array containing the root bones
  96068. * @returns an array containing the root bones
  96069. */
  96070. getChildren(): Array<Bone>;
  96071. /**
  96072. * Gets the node index in matrix array generated for rendering
  96073. * @returns the node index
  96074. */
  96075. getIndex(): number;
  96076. /**
  96077. * Sets the parent bone
  96078. * @param parent defines the parent (can be null if the bone is the root)
  96079. * @param updateDifferenceMatrix defines if the difference matrix must be updated
  96080. */
  96081. setParent(parent: Nullable<Bone>, updateDifferenceMatrix?: boolean): void;
  96082. /**
  96083. * Gets the local matrix
  96084. * @returns a matrix
  96085. */
  96086. getLocalMatrix(): Matrix;
  96087. /**
  96088. * Gets the base matrix (initial matrix which remains unchanged)
  96089. * @returns a matrix
  96090. */
  96091. getBaseMatrix(): Matrix;
  96092. /**
  96093. * Gets the rest pose matrix
  96094. * @returns a matrix
  96095. */
  96096. getRestPose(): Matrix;
  96097. /**
  96098. * Sets the rest pose matrix
  96099. * @param matrix the local-space rest pose to set for this bone
  96100. */
  96101. setRestPose(matrix: Matrix): void;
  96102. /**
  96103. * Gets the bind pose matrix
  96104. * @returns the bind pose matrix
  96105. */
  96106. getBindPose(): Matrix;
  96107. /**
  96108. * Sets the bind pose matrix
  96109. * @param matrix the local-space bind pose to set for this bone
  96110. */
  96111. setBindPose(matrix: Matrix): void;
  96112. /**
  96113. * Gets a matrix used to store world matrix (ie. the matrix sent to shaders)
  96114. */
  96115. getWorldMatrix(): Matrix;
  96116. /**
  96117. * Sets the local matrix to rest pose matrix
  96118. */
  96119. returnToRest(): void;
  96120. /**
  96121. * Gets the inverse of the absolute transform matrix.
  96122. * This matrix will be multiplied by local matrix to get the difference matrix (ie. the difference between original state and current state)
  96123. * @returns a matrix
  96124. */
  96125. getInvertedAbsoluteTransform(): Matrix;
  96126. /**
  96127. * Gets the absolute transform matrix (ie base matrix * parent world matrix)
  96128. * @returns a matrix
  96129. */
  96130. getAbsoluteTransform(): Matrix;
  96131. /**
  96132. * Links with the given transform node.
  96133. * The local matrix of this bone is copied from the transform node every frame.
  96134. * @param transformNode defines the transform node to link to
  96135. */
  96136. linkTransformNode(transformNode: Nullable<TransformNode>): void;
  96137. /**
  96138. * Gets the node used to drive the bone's transformation
  96139. * @returns a transform node or null
  96140. */
  96141. getTransformNode(): Nullable<TransformNode>;
  96142. /** Gets or sets current position (in local space) */
  96143. get position(): Vector3;
  96144. set position(newPosition: Vector3);
  96145. /** Gets or sets current rotation (in local space) */
  96146. get rotation(): Vector3;
  96147. set rotation(newRotation: Vector3);
  96148. /** Gets or sets current rotation quaternion (in local space) */
  96149. get rotationQuaternion(): Quaternion;
  96150. set rotationQuaternion(newRotation: Quaternion);
  96151. /** Gets or sets current scaling (in local space) */
  96152. get scaling(): Vector3;
  96153. set scaling(newScaling: Vector3);
  96154. /**
  96155. * Gets the animation properties override
  96156. */
  96157. get animationPropertiesOverride(): Nullable<AnimationPropertiesOverride>;
  96158. private _decompose;
  96159. private _compose;
  96160. /**
  96161. * Update the base and local matrices
  96162. * @param matrix defines the new base or local matrix
  96163. * @param updateDifferenceMatrix defines if the difference matrix must be updated
  96164. * @param updateLocalMatrix defines if the local matrix should be updated
  96165. */
  96166. updateMatrix(matrix: Matrix, updateDifferenceMatrix?: boolean, updateLocalMatrix?: boolean): void;
  96167. /** @hidden */
  96168. _updateDifferenceMatrix(rootMatrix?: Matrix, updateChildren?: boolean): void;
  96169. /**
  96170. * Flag the bone as dirty (Forcing it to update everything)
  96171. */
  96172. markAsDirty(): void;
  96173. /** @hidden */
  96174. _markAsDirtyAndCompose(): void;
  96175. private _markAsDirtyAndDecompose;
  96176. /**
  96177. * Translate the bone in local or world space
  96178. * @param vec The amount to translate the bone
  96179. * @param space The space that the translation is in
  96180. * @param mesh The mesh that this bone is attached to. This is only used in world space
  96181. */
  96182. translate(vec: Vector3, space?: Space, mesh?: AbstractMesh): void;
  96183. /**
  96184. * Set the postion of the bone in local or world space
  96185. * @param position The position to set the bone
  96186. * @param space The space that the position is in
  96187. * @param mesh The mesh that this bone is attached to. This is only used in world space
  96188. */
  96189. setPosition(position: Vector3, space?: Space, mesh?: AbstractMesh): void;
  96190. /**
  96191. * Set the absolute position of the bone (world space)
  96192. * @param position The position to set the bone
  96193. * @param mesh The mesh that this bone is attached to
  96194. */
  96195. setAbsolutePosition(position: Vector3, mesh?: AbstractMesh): void;
  96196. /**
  96197. * Scale the bone on the x, y and z axes (in local space)
  96198. * @param x The amount to scale the bone on the x axis
  96199. * @param y The amount to scale the bone on the y axis
  96200. * @param z The amount to scale the bone on the z axis
  96201. * @param scaleChildren sets this to true if children of the bone should be scaled as well (false by default)
  96202. */
  96203. scale(x: number, y: number, z: number, scaleChildren?: boolean): void;
  96204. /**
  96205. * Set the bone scaling in local space
  96206. * @param scale defines the scaling vector
  96207. */
  96208. setScale(scale: Vector3): void;
  96209. /**
  96210. * Gets the current scaling in local space
  96211. * @returns the current scaling vector
  96212. */
  96213. getScale(): Vector3;
  96214. /**
  96215. * Gets the current scaling in local space and stores it in a target vector
  96216. * @param result defines the target vector
  96217. */
  96218. getScaleToRef(result: Vector3): void;
  96219. /**
  96220. * Set the yaw, pitch, and roll of the bone in local or world space
  96221. * @param yaw The rotation of the bone on the y axis
  96222. * @param pitch The rotation of the bone on the x axis
  96223. * @param roll The rotation of the bone on the z axis
  96224. * @param space The space that the axes of rotation are in
  96225. * @param mesh The mesh that this bone is attached to. This is only used in world space
  96226. */
  96227. setYawPitchRoll(yaw: number, pitch: number, roll: number, space?: Space, mesh?: AbstractMesh): void;
  96228. /**
  96229. * Add a rotation to the bone on an axis in local or world space
  96230. * @param axis The axis to rotate the bone on
  96231. * @param amount The amount to rotate the bone
  96232. * @param space The space that the axis is in
  96233. * @param mesh The mesh that this bone is attached to. This is only used in world space
  96234. */
  96235. rotate(axis: Vector3, amount: number, space?: Space, mesh?: AbstractMesh): void;
  96236. /**
  96237. * Set the rotation of the bone to a particular axis angle in local or world space
  96238. * @param axis The axis to rotate the bone on
  96239. * @param angle The angle that the bone should be rotated to
  96240. * @param space The space that the axis is in
  96241. * @param mesh The mesh that this bone is attached to. This is only used in world space
  96242. */
  96243. setAxisAngle(axis: Vector3, angle: number, space?: Space, mesh?: AbstractMesh): void;
  96244. /**
  96245. * Set the euler rotation of the bone in local or world space
  96246. * @param rotation The euler rotation that the bone should be set to
  96247. * @param space The space that the rotation is in
  96248. * @param mesh The mesh that this bone is attached to. This is only used in world space
  96249. */
  96250. setRotation(rotation: Vector3, space?: Space, mesh?: AbstractMesh): void;
  96251. /**
  96252. * Set the quaternion rotation of the bone in local or world space
  96253. * @param quat The quaternion rotation that the bone should be set to
  96254. * @param space The space that the rotation is in
  96255. * @param mesh The mesh that this bone is attached to. This is only used in world space
  96256. */
  96257. setRotationQuaternion(quat: Quaternion, space?: Space, mesh?: AbstractMesh): void;
  96258. /**
  96259. * Set the rotation matrix of the bone in local or world space
  96260. * @param rotMat The rotation matrix that the bone should be set to
  96261. * @param space The space that the rotation is in
  96262. * @param mesh The mesh that this bone is attached to. This is only used in world space
  96263. */
  96264. setRotationMatrix(rotMat: Matrix, space?: Space, mesh?: AbstractMesh): void;
  96265. private _rotateWithMatrix;
  96266. private _getNegativeRotationToRef;
  96267. /**
  96268. * Get the position of the bone in local or world space
  96269. * @param space The space that the returned position is in
  96270. * @param mesh The mesh that this bone is attached to. This is only used in world space
  96271. * @returns The position of the bone
  96272. */
  96273. getPosition(space?: Space, mesh?: Nullable<AbstractMesh>): Vector3;
  96274. /**
  96275. * Copy the position of the bone to a vector3 in local or world space
  96276. * @param space The space that the returned position is in
  96277. * @param mesh The mesh that this bone is attached to. This is only used in world space
  96278. * @param result The vector3 to copy the position to
  96279. */
  96280. getPositionToRef(space: Space | undefined, mesh: Nullable<AbstractMesh>, result: Vector3): void;
  96281. /**
  96282. * Get the absolute position of the bone (world space)
  96283. * @param mesh The mesh that this bone is attached to
  96284. * @returns The absolute position of the bone
  96285. */
  96286. getAbsolutePosition(mesh?: Nullable<AbstractMesh>): Vector3;
  96287. /**
  96288. * Copy the absolute position of the bone (world space) to the result param
  96289. * @param mesh The mesh that this bone is attached to
  96290. * @param result The vector3 to copy the absolute position to
  96291. */
  96292. getAbsolutePositionToRef(mesh: AbstractMesh, result: Vector3): void;
  96293. /**
  96294. * Compute the absolute transforms of this bone and its children
  96295. */
  96296. computeAbsoluteTransforms(): void;
  96297. /**
  96298. * Get the world direction from an axis that is in the local space of the bone
  96299. * @param localAxis The local direction that is used to compute the world direction
  96300. * @param mesh The mesh that this bone is attached to
  96301. * @returns The world direction
  96302. */
  96303. getDirection(localAxis: Vector3, mesh?: Nullable<AbstractMesh>): Vector3;
  96304. /**
  96305. * Copy the world direction to a vector3 from an axis that is in the local space of the bone
  96306. * @param localAxis The local direction that is used to compute the world direction
  96307. * @param mesh The mesh that this bone is attached to
  96308. * @param result The vector3 that the world direction will be copied to
  96309. */
  96310. getDirectionToRef(localAxis: Vector3, mesh: AbstractMesh | null | undefined, result: Vector3): void;
  96311. /**
  96312. * Get the euler rotation of the bone in local or world space
  96313. * @param space The space that the rotation should be in
  96314. * @param mesh The mesh that this bone is attached to. This is only used in world space
  96315. * @returns The euler rotation
  96316. */
  96317. getRotation(space?: Space, mesh?: Nullable<AbstractMesh>): Vector3;
  96318. /**
  96319. * Copy the euler rotation of the bone to a vector3. The rotation can be in either local or world space
  96320. * @param space The space that the rotation should be in
  96321. * @param mesh The mesh that this bone is attached to. This is only used in world space
  96322. * @param result The vector3 that the rotation should be copied to
  96323. */
  96324. getRotationToRef(space: Space | undefined, mesh: AbstractMesh | null | undefined, result: Vector3): void;
  96325. /**
  96326. * Get the quaternion rotation of the bone in either local or world space
  96327. * @param space The space that the rotation should be in
  96328. * @param mesh The mesh that this bone is attached to. This is only used in world space
  96329. * @returns The quaternion rotation
  96330. */
  96331. getRotationQuaternion(space?: Space, mesh?: Nullable<AbstractMesh>): Quaternion;
  96332. /**
  96333. * Copy the quaternion rotation of the bone to a quaternion. The rotation can be in either local or world space
  96334. * @param space The space that the rotation should be in
  96335. * @param mesh The mesh that this bone is attached to. This is only used in world space
  96336. * @param result The quaternion that the rotation should be copied to
  96337. */
  96338. getRotationQuaternionToRef(space: Space | undefined, mesh: AbstractMesh | null | undefined, result: Quaternion): void;
  96339. /**
  96340. * Get the rotation matrix of the bone in local or world space
  96341. * @param space The space that the rotation should be in
  96342. * @param mesh The mesh that this bone is attached to. This is only used in world space
  96343. * @returns The rotation matrix
  96344. */
  96345. getRotationMatrix(space: Space | undefined, mesh: AbstractMesh): Matrix;
  96346. /**
  96347. * Copy the rotation matrix of the bone to a matrix. The rotation can be in either local or world space
  96348. * @param space The space that the rotation should be in
  96349. * @param mesh The mesh that this bone is attached to. This is only used in world space
  96350. * @param result The quaternion that the rotation should be copied to
  96351. */
  96352. getRotationMatrixToRef(space: Space | undefined, mesh: AbstractMesh, result: Matrix): void;
  96353. /**
  96354. * Get the world position of a point that is in the local space of the bone
  96355. * @param position The local position
  96356. * @param mesh The mesh that this bone is attached to
  96357. * @returns The world position
  96358. */
  96359. getAbsolutePositionFromLocal(position: Vector3, mesh?: Nullable<AbstractMesh>): Vector3;
  96360. /**
  96361. * Get the world position of a point that is in the local space of the bone and copy it to the result param
  96362. * @param position The local position
  96363. * @param mesh The mesh that this bone is attached to
  96364. * @param result The vector3 that the world position should be copied to
  96365. */
  96366. getAbsolutePositionFromLocalToRef(position: Vector3, mesh: AbstractMesh | null | undefined, result: Vector3): void;
  96367. /**
  96368. * Get the local position of a point that is in world space
  96369. * @param position The world position
  96370. * @param mesh The mesh that this bone is attached to
  96371. * @returns The local position
  96372. */
  96373. getLocalPositionFromAbsolute(position: Vector3, mesh?: Nullable<AbstractMesh>): Vector3;
  96374. /**
  96375. * Get the local position of a point that is in world space and copy it to the result param
  96376. * @param position The world position
  96377. * @param mesh The mesh that this bone is attached to
  96378. * @param result The vector3 that the local position should be copied to
  96379. */
  96380. getLocalPositionFromAbsoluteToRef(position: Vector3, mesh: AbstractMesh | null | undefined, result: Vector3): void;
  96381. /**
  96382. * Set the current local matrix as the restPose for this bone.
  96383. */
  96384. setCurrentPoseAsRest(): void;
  96385. }
  96386. }
  96387. declare module BABYLON {
  96388. /**
  96389. * Defines a runtime animation
  96390. */
  96391. export class RuntimeAnimation {
  96392. private _events;
  96393. /**
  96394. * The current frame of the runtime animation
  96395. */
  96396. private _currentFrame;
  96397. /**
  96398. * The animation used by the runtime animation
  96399. */
  96400. private _animation;
  96401. /**
  96402. * The target of the runtime animation
  96403. */
  96404. private _target;
  96405. /**
  96406. * The initiating animatable
  96407. */
  96408. private _host;
  96409. /**
  96410. * The original value of the runtime animation
  96411. */
  96412. private _originalValue;
  96413. /**
  96414. * The original blend value of the runtime animation
  96415. */
  96416. private _originalBlendValue;
  96417. /**
  96418. * The offsets cache of the runtime animation
  96419. */
  96420. private _offsetsCache;
  96421. /**
  96422. * The high limits cache of the runtime animation
  96423. */
  96424. private _highLimitsCache;
  96425. /**
  96426. * Specifies if the runtime animation has been stopped
  96427. */
  96428. private _stopped;
  96429. /**
  96430. * The blending factor of the runtime animation
  96431. */
  96432. private _blendingFactor;
  96433. /**
  96434. * The BabylonJS scene
  96435. */
  96436. private _scene;
  96437. /**
  96438. * The current value of the runtime animation
  96439. */
  96440. private _currentValue;
  96441. /** @hidden */
  96442. _animationState: _IAnimationState;
  96443. /**
  96444. * The active target of the runtime animation
  96445. */
  96446. private _activeTargets;
  96447. private _currentActiveTarget;
  96448. private _directTarget;
  96449. /**
  96450. * The target path of the runtime animation
  96451. */
  96452. private _targetPath;
  96453. /**
  96454. * The weight of the runtime animation
  96455. */
  96456. private _weight;
  96457. /**
  96458. * The ratio offset of the runtime animation
  96459. */
  96460. private _ratioOffset;
  96461. /**
  96462. * The previous delay of the runtime animation
  96463. */
  96464. private _previousDelay;
  96465. /**
  96466. * The previous ratio of the runtime animation
  96467. */
  96468. private _previousRatio;
  96469. private _enableBlending;
  96470. private _keys;
  96471. private _minFrame;
  96472. private _maxFrame;
  96473. private _minValue;
  96474. private _maxValue;
  96475. private _targetIsArray;
  96476. /**
  96477. * Gets the current frame of the runtime animation
  96478. */
  96479. get currentFrame(): number;
  96480. /**
  96481. * Gets the weight of the runtime animation
  96482. */
  96483. get weight(): number;
  96484. /**
  96485. * Gets the current value of the runtime animation
  96486. */
  96487. get currentValue(): any;
  96488. /**
  96489. * Gets the target path of the runtime animation
  96490. */
  96491. get targetPath(): string;
  96492. /**
  96493. * Gets the actual target of the runtime animation
  96494. */
  96495. get target(): any;
  96496. /**
  96497. * Gets the additive state of the runtime animation
  96498. */
  96499. get isAdditive(): boolean;
  96500. /** @hidden */
  96501. _onLoop: () => void;
  96502. /**
  96503. * Create a new RuntimeAnimation object
  96504. * @param target defines the target of the animation
  96505. * @param animation defines the source animation object
  96506. * @param scene defines the hosting scene
  96507. * @param host defines the initiating Animatable
  96508. */
  96509. constructor(target: any, animation: Animation, scene: Scene, host: Animatable);
  96510. private _preparePath;
  96511. /**
  96512. * Gets the animation from the runtime animation
  96513. */
  96514. get animation(): Animation;
  96515. /**
  96516. * Resets the runtime animation to the beginning
  96517. * @param restoreOriginal defines whether to restore the target property to the original value
  96518. */
  96519. reset(restoreOriginal?: boolean): void;
  96520. /**
  96521. * Specifies if the runtime animation is stopped
  96522. * @returns Boolean specifying if the runtime animation is stopped
  96523. */
  96524. isStopped(): boolean;
  96525. /**
  96526. * Disposes of the runtime animation
  96527. */
  96528. dispose(): void;
  96529. /**
  96530. * Apply the interpolated value to the target
  96531. * @param currentValue defines the value computed by the animation
  96532. * @param weight defines the weight to apply to this value (Defaults to 1.0)
  96533. */
  96534. setValue(currentValue: any, weight: number): void;
  96535. private _getOriginalValues;
  96536. private _setValue;
  96537. /**
  96538. * Gets the loop pmode of the runtime animation
  96539. * @returns Loop Mode
  96540. */
  96541. private _getCorrectLoopMode;
  96542. /**
  96543. * Move the current animation to a given frame
  96544. * @param frame defines the frame to move to
  96545. */
  96546. goToFrame(frame: number): void;
  96547. /**
  96548. * @hidden Internal use only
  96549. */
  96550. _prepareForSpeedRatioChange(newSpeedRatio: number): void;
  96551. /**
  96552. * Execute the current animation
  96553. * @param delay defines the delay to add to the current frame
  96554. * @param from defines the lower bound of the animation range
  96555. * @param to defines the upper bound of the animation range
  96556. * @param loop defines if the current animation must loop
  96557. * @param speedRatio defines the current speed ratio
  96558. * @param weight defines the weight of the animation (default is -1 so no weight)
  96559. * @param onLoop optional callback called when animation loops
  96560. * @returns a boolean indicating if the animation is running
  96561. */
  96562. animate(delay: number, from: number, to: number, loop: boolean, speedRatio: number, weight?: number): boolean;
  96563. }
  96564. }
  96565. declare module BABYLON {
  96566. /**
  96567. * Class used to store an actual running animation
  96568. */
  96569. export class Animatable {
  96570. /** defines the target object */
  96571. target: any;
  96572. /** defines the starting frame number (default is 0) */
  96573. fromFrame: number;
  96574. /** defines the ending frame number (default is 100) */
  96575. toFrame: number;
  96576. /** defines if the animation must loop (default is false) */
  96577. loopAnimation: boolean;
  96578. /** defines a callback to call when animation ends if it is not looping */
  96579. onAnimationEnd?: (() => void) | null | undefined;
  96580. /** defines a callback to call when animation loops */
  96581. onAnimationLoop?: (() => void) | null | undefined;
  96582. /** defines whether the animation should be evaluated additively */
  96583. isAdditive: boolean;
  96584. private _localDelayOffset;
  96585. private _pausedDelay;
  96586. private _runtimeAnimations;
  96587. private _paused;
  96588. private _scene;
  96589. private _speedRatio;
  96590. private _weight;
  96591. private _syncRoot;
  96592. /**
  96593. * Gets or sets a boolean indicating if the animatable must be disposed and removed at the end of the animation.
  96594. * This will only apply for non looping animation (default is true)
  96595. */
  96596. disposeOnEnd: boolean;
  96597. /**
  96598. * Gets a boolean indicating if the animation has started
  96599. */
  96600. animationStarted: boolean;
  96601. /**
  96602. * Observer raised when the animation ends
  96603. */
  96604. onAnimationEndObservable: Observable<Animatable>;
  96605. /**
  96606. * Observer raised when the animation loops
  96607. */
  96608. onAnimationLoopObservable: Observable<Animatable>;
  96609. /**
  96610. * Gets the root Animatable used to synchronize and normalize animations
  96611. */
  96612. get syncRoot(): Nullable<Animatable>;
  96613. /**
  96614. * Gets the current frame of the first RuntimeAnimation
  96615. * Used to synchronize Animatables
  96616. */
  96617. get masterFrame(): number;
  96618. /**
  96619. * Gets or sets the animatable weight (-1.0 by default meaning not weighted)
  96620. */
  96621. get weight(): number;
  96622. set weight(value: number);
  96623. /**
  96624. * Gets or sets the speed ratio to apply to the animatable (1.0 by default)
  96625. */
  96626. get speedRatio(): number;
  96627. set speedRatio(value: number);
  96628. /**
  96629. * Creates a new Animatable
  96630. * @param scene defines the hosting scene
  96631. * @param target defines the target object
  96632. * @param fromFrame defines the starting frame number (default is 0)
  96633. * @param toFrame defines the ending frame number (default is 100)
  96634. * @param loopAnimation defines if the animation must loop (default is false)
  96635. * @param speedRatio defines the factor to apply to animation speed (default is 1)
  96636. * @param onAnimationEnd defines a callback to call when animation ends if it is not looping
  96637. * @param animations defines a group of animation to add to the new Animatable
  96638. * @param onAnimationLoop defines a callback to call when animation loops
  96639. * @param isAdditive defines whether the animation should be evaluated additively
  96640. */
  96641. constructor(scene: Scene,
  96642. /** defines the target object */
  96643. target: any,
  96644. /** defines the starting frame number (default is 0) */
  96645. fromFrame?: number,
  96646. /** defines the ending frame number (default is 100) */
  96647. toFrame?: number,
  96648. /** defines if the animation must loop (default is false) */
  96649. loopAnimation?: boolean, speedRatio?: number,
  96650. /** defines a callback to call when animation ends if it is not looping */
  96651. onAnimationEnd?: (() => void) | null | undefined, animations?: Animation[],
  96652. /** defines a callback to call when animation loops */
  96653. onAnimationLoop?: (() => void) | null | undefined,
  96654. /** defines whether the animation should be evaluated additively */
  96655. isAdditive?: boolean);
  96656. /**
  96657. * Synchronize and normalize current Animatable with a source Animatable
  96658. * This is useful when using animation weights and when animations are not of the same length
  96659. * @param root defines the root Animatable to synchronize with
  96660. * @returns the current Animatable
  96661. */
  96662. syncWith(root: Animatable): Animatable;
  96663. /**
  96664. * Gets the list of runtime animations
  96665. * @returns an array of RuntimeAnimation
  96666. */
  96667. getAnimations(): RuntimeAnimation[];
  96668. /**
  96669. * Adds more animations to the current animatable
  96670. * @param target defines the target of the animations
  96671. * @param animations defines the new animations to add
  96672. */
  96673. appendAnimations(target: any, animations: Animation[]): void;
  96674. /**
  96675. * Gets the source animation for a specific property
  96676. * @param property defines the propertyu to look for
  96677. * @returns null or the source animation for the given property
  96678. */
  96679. getAnimationByTargetProperty(property: string): Nullable<Animation>;
  96680. /**
  96681. * Gets the runtime animation for a specific property
  96682. * @param property defines the propertyu to look for
  96683. * @returns null or the runtime animation for the given property
  96684. */
  96685. getRuntimeAnimationByTargetProperty(property: string): Nullable<RuntimeAnimation>;
  96686. /**
  96687. * Resets the animatable to its original state
  96688. */
  96689. reset(): void;
  96690. /**
  96691. * Allows the animatable to blend with current running animations
  96692. * @see https://doc.babylonjs.com/babylon101/animations#animation-blending
  96693. * @param blendingSpeed defines the blending speed to use
  96694. */
  96695. enableBlending(blendingSpeed: number): void;
  96696. /**
  96697. * Disable animation blending
  96698. * @see https://doc.babylonjs.com/babylon101/animations#animation-blending
  96699. */
  96700. disableBlending(): void;
  96701. /**
  96702. * Jump directly to a given frame
  96703. * @param frame defines the frame to jump to
  96704. */
  96705. goToFrame(frame: number): void;
  96706. /**
  96707. * Pause the animation
  96708. */
  96709. pause(): void;
  96710. /**
  96711. * Restart the animation
  96712. */
  96713. restart(): void;
  96714. private _raiseOnAnimationEnd;
  96715. /**
  96716. * Stop and delete the current animation
  96717. * @param animationName defines a string used to only stop some of the runtime animations instead of all
  96718. * @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)
  96719. */
  96720. stop(animationName?: string, targetMask?: (target: any) => boolean): void;
  96721. /**
  96722. * Wait asynchronously for the animation to end
  96723. * @returns a promise which will be fullfilled when the animation ends
  96724. */
  96725. waitAsync(): Promise<Animatable>;
  96726. /** @hidden */
  96727. _animate(delay: number): boolean;
  96728. }
  96729. interface Scene {
  96730. /** @hidden */
  96731. _registerTargetForLateAnimationBinding(runtimeAnimation: RuntimeAnimation, originalValue: any): void;
  96732. /** @hidden */
  96733. _processLateAnimationBindingsForMatrices(holder: {
  96734. totalWeight: number;
  96735. totalAdditiveWeight: number;
  96736. animations: RuntimeAnimation[];
  96737. additiveAnimations: RuntimeAnimation[];
  96738. originalValue: Matrix;
  96739. }): any;
  96740. /** @hidden */
  96741. _processLateAnimationBindingsForQuaternions(holder: {
  96742. totalWeight: number;
  96743. totalAdditiveWeight: number;
  96744. animations: RuntimeAnimation[];
  96745. additiveAnimations: RuntimeAnimation[];
  96746. originalValue: Quaternion;
  96747. }, refQuaternion: Quaternion): Quaternion;
  96748. /** @hidden */
  96749. _processLateAnimationBindings(): void;
  96750. /**
  96751. * Will start the animation sequence of a given target
  96752. * @param target defines the target
  96753. * @param from defines from which frame should animation start
  96754. * @param to defines until which frame should animation run.
  96755. * @param weight defines the weight to apply to the animation (1.0 by default)
  96756. * @param loop defines if the animation loops
  96757. * @param speedRatio defines the speed in which to run the animation (1.0 by default)
  96758. * @param onAnimationEnd defines the function to be executed when the animation ends
  96759. * @param animatable defines an animatable object. If not provided a new one will be created from the given params
  96760. * @param targetMask defines if the target should be animated if animations are present (this is called recursively on descendant animatables regardless of return value)
  96761. * @param onAnimationLoop defines the callback to call when an animation loops
  96762. * @param isAdditive defines whether the animation should be evaluated additively (false by default)
  96763. * @returns the animatable object created for this animation
  96764. */
  96765. 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;
  96766. /**
  96767. * Will start the animation sequence of a given target
  96768. * @param target defines the target
  96769. * @param from defines from which frame should animation start
  96770. * @param to defines until which frame should animation run.
  96771. * @param loop defines if the animation loops
  96772. * @param speedRatio defines the speed in which to run the animation (1.0 by default)
  96773. * @param onAnimationEnd defines the function to be executed when the animation ends
  96774. * @param animatable defines an animatable object. If not provided a new one will be created from the given params
  96775. * @param stopCurrent defines if the current animations must be stopped first (true by default)
  96776. * @param targetMask defines if the target should be animate if animations are present (this is called recursively on descendant animatables regardless of return value)
  96777. * @param onAnimationLoop defines the callback to call when an animation loops
  96778. * @param isAdditive defines whether the animation should be evaluated additively (false by default)
  96779. * @returns the animatable object created for this animation
  96780. */
  96781. 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;
  96782. /**
  96783. * Will start the animation sequence of a given target and its hierarchy
  96784. * @param target defines the target
  96785. * @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.
  96786. * @param from defines from which frame should animation start
  96787. * @param to defines until which frame should animation run.
  96788. * @param loop defines if the animation loops
  96789. * @param speedRatio defines the speed in which to run the animation (1.0 by default)
  96790. * @param onAnimationEnd defines the function to be executed when the animation ends
  96791. * @param animatable defines an animatable object. If not provided a new one will be created from the given params
  96792. * @param stopCurrent defines if the current animations must be stopped first (true by default)
  96793. * @param targetMask defines if the target should be animated if animations are present (this is called recursively on descendant animatables regardless of return value)
  96794. * @param onAnimationLoop defines the callback to call when an animation loops
  96795. * @param isAdditive defines whether the animation should be evaluated additively (false by default)
  96796. * @returns the list of created animatables
  96797. */
  96798. 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[];
  96799. /**
  96800. * Begin a new animation on a given node
  96801. * @param target defines the target where the animation will take place
  96802. * @param animations defines the list of animations to start
  96803. * @param from defines the initial value
  96804. * @param to defines the final value
  96805. * @param loop defines if you want animation to loop (off by default)
  96806. * @param speedRatio defines the speed ratio to apply to all animations
  96807. * @param onAnimationEnd defines the callback to call when an animation ends (will be called once per node)
  96808. * @param onAnimationLoop defines the callback to call when an animation loops
  96809. * @param isAdditive defines whether the animation should be evaluated additively (false by default)
  96810. * @returns the list of created animatables
  96811. */
  96812. beginDirectAnimation(target: any, animations: Animation[], from: number, to: number, loop?: boolean, speedRatio?: number, onAnimationEnd?: () => void, onAnimationLoop?: () => void, isAdditive?: boolean): Animatable;
  96813. /**
  96814. * Begin a new animation on a given node and its hierarchy
  96815. * @param target defines the root node where the animation will take place
  96816. * @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.
  96817. * @param animations defines the list of animations to start
  96818. * @param from defines the initial value
  96819. * @param to defines the final value
  96820. * @param loop defines if you want animation to loop (off by default)
  96821. * @param speedRatio defines the speed ratio to apply to all animations
  96822. * @param onAnimationEnd defines the callback to call when an animation ends (will be called once per node)
  96823. * @param onAnimationLoop defines the callback to call when an animation loops
  96824. * @param isAdditive defines whether the animation should be evaluated additively (false by default)
  96825. * @returns the list of animatables created for all nodes
  96826. */
  96827. beginDirectHierarchyAnimation(target: Node, directDescendantsOnly: boolean, animations: Animation[], from: number, to: number, loop?: boolean, speedRatio?: number, onAnimationEnd?: () => void, onAnimationLoop?: () => void, isAdditive?: boolean): Animatable[];
  96828. /**
  96829. * Gets the animatable associated with a specific target
  96830. * @param target defines the target of the animatable
  96831. * @returns the required animatable if found
  96832. */
  96833. getAnimatableByTarget(target: any): Nullable<Animatable>;
  96834. /**
  96835. * Gets all animatables associated with a given target
  96836. * @param target defines the target to look animatables for
  96837. * @returns an array of Animatables
  96838. */
  96839. getAllAnimatablesByTarget(target: any): Array<Animatable>;
  96840. /**
  96841. * Stops and removes all animations that have been applied to the scene
  96842. */
  96843. stopAllAnimations(): void;
  96844. /**
  96845. * Gets the current delta time used by animation engine
  96846. */
  96847. deltaTime: number;
  96848. }
  96849. interface Bone {
  96850. /**
  96851. * Copy an animation range from another bone
  96852. * @param source defines the source bone
  96853. * @param rangeName defines the range name to copy
  96854. * @param frameOffset defines the frame offset
  96855. * @param rescaleAsRequired defines if rescaling must be applied if required
  96856. * @param skelDimensionsRatio defines the scaling ratio
  96857. * @returns true if operation was successful
  96858. */
  96859. copyAnimationRange(source: Bone, rangeName: string, frameOffset: number, rescaleAsRequired: boolean, skelDimensionsRatio: Nullable<Vector3>): boolean;
  96860. }
  96861. }
  96862. declare module BABYLON {
  96863. /**
  96864. * Class used to handle skinning animations
  96865. * @see https://doc.babylonjs.com/how_to/how_to_use_bones_and_skeletons
  96866. */
  96867. export class Skeleton implements IAnimatable {
  96868. /** defines the skeleton name */
  96869. name: string;
  96870. /** defines the skeleton Id */
  96871. id: string;
  96872. /**
  96873. * Defines the list of child bones
  96874. */
  96875. bones: Bone[];
  96876. /**
  96877. * Defines an estimate of the dimension of the skeleton at rest
  96878. */
  96879. dimensionsAtRest: Vector3;
  96880. /**
  96881. * Defines a boolean indicating if the root matrix is provided by meshes or by the current skeleton (this is the default value)
  96882. */
  96883. needInitialSkinMatrix: boolean;
  96884. /**
  96885. * Defines a mesh that override the matrix used to get the world matrix (null by default).
  96886. */
  96887. overrideMesh: Nullable<AbstractMesh>;
  96888. /**
  96889. * Gets the list of animations attached to this skeleton
  96890. */
  96891. animations: Array<Animation>;
  96892. private _scene;
  96893. private _isDirty;
  96894. private _transformMatrices;
  96895. private _transformMatrixTexture;
  96896. private _meshesWithPoseMatrix;
  96897. private _animatables;
  96898. private _identity;
  96899. private _synchronizedWithMesh;
  96900. private _ranges;
  96901. private _lastAbsoluteTransformsUpdateId;
  96902. private _canUseTextureForBones;
  96903. private _uniqueId;
  96904. /** @hidden */
  96905. _numBonesWithLinkedTransformNode: number;
  96906. /** @hidden */
  96907. _hasWaitingData: Nullable<boolean>;
  96908. /** @hidden */
  96909. _waitingOverrideMeshId: Nullable<string>;
  96910. /**
  96911. * Specifies if the skeleton should be serialized
  96912. */
  96913. doNotSerialize: boolean;
  96914. private _useTextureToStoreBoneMatrices;
  96915. /**
  96916. * Gets or sets a boolean indicating that bone matrices should be stored as a texture instead of using shader uniforms (default is true).
  96917. * Please note that this option is not available if the hardware does not support it
  96918. */
  96919. get useTextureToStoreBoneMatrices(): boolean;
  96920. set useTextureToStoreBoneMatrices(value: boolean);
  96921. private _animationPropertiesOverride;
  96922. /**
  96923. * Gets or sets the animation properties override
  96924. */
  96925. get animationPropertiesOverride(): Nullable<AnimationPropertiesOverride>;
  96926. set animationPropertiesOverride(value: Nullable<AnimationPropertiesOverride>);
  96927. /**
  96928. * List of inspectable custom properties (used by the Inspector)
  96929. * @see https://doc.babylonjs.com/how_to/debug_layer#extensibility
  96930. */
  96931. inspectableCustomProperties: IInspectable[];
  96932. /**
  96933. * An observable triggered before computing the skeleton's matrices
  96934. */
  96935. onBeforeComputeObservable: Observable<Skeleton>;
  96936. /**
  96937. * Gets a boolean indicating that the skeleton effectively stores matrices into a texture
  96938. */
  96939. get isUsingTextureForMatrices(): boolean;
  96940. /**
  96941. * Gets the unique ID of this skeleton
  96942. */
  96943. get uniqueId(): number;
  96944. /**
  96945. * Creates a new skeleton
  96946. * @param name defines the skeleton name
  96947. * @param id defines the skeleton Id
  96948. * @param scene defines the hosting scene
  96949. */
  96950. constructor(
  96951. /** defines the skeleton name */
  96952. name: string,
  96953. /** defines the skeleton Id */
  96954. id: string, scene: Scene);
  96955. /**
  96956. * Gets the current object class name.
  96957. * @return the class name
  96958. */
  96959. getClassName(): string;
  96960. /**
  96961. * Returns an array containing the root bones
  96962. * @returns an array containing the root bones
  96963. */
  96964. getChildren(): Array<Bone>;
  96965. /**
  96966. * Gets the list of transform matrices to send to shaders (one matrix per bone)
  96967. * @param mesh defines the mesh to use to get the root matrix (if needInitialSkinMatrix === true)
  96968. * @returns a Float32Array containing matrices data
  96969. */
  96970. getTransformMatrices(mesh: AbstractMesh): Float32Array;
  96971. /**
  96972. * Gets the list of transform matrices to send to shaders inside a texture (one matrix per bone)
  96973. * @param mesh defines the mesh to use to get the root matrix (if needInitialSkinMatrix === true)
  96974. * @returns a raw texture containing the data
  96975. */
  96976. getTransformMatrixTexture(mesh: AbstractMesh): Nullable<RawTexture>;
  96977. /**
  96978. * Gets the current hosting scene
  96979. * @returns a scene object
  96980. */
  96981. getScene(): Scene;
  96982. /**
  96983. * Gets a string representing the current skeleton data
  96984. * @param fullDetails defines a boolean indicating if we want a verbose version
  96985. * @returns a string representing the current skeleton data
  96986. */
  96987. toString(fullDetails?: boolean): string;
  96988. /**
  96989. * Get bone's index searching by name
  96990. * @param name defines bone's name to search for
  96991. * @return the indice of the bone. Returns -1 if not found
  96992. */
  96993. getBoneIndexByName(name: string): number;
  96994. /**
  96995. * Creater a new animation range
  96996. * @param name defines the name of the range
  96997. * @param from defines the start key
  96998. * @param to defines the end key
  96999. */
  97000. createAnimationRange(name: string, from: number, to: number): void;
  97001. /**
  97002. * Delete a specific animation range
  97003. * @param name defines the name of the range
  97004. * @param deleteFrames defines if frames must be removed as well
  97005. */
  97006. deleteAnimationRange(name: string, deleteFrames?: boolean): void;
  97007. /**
  97008. * Gets a specific animation range
  97009. * @param name defines the name of the range to look for
  97010. * @returns the requested animation range or null if not found
  97011. */
  97012. getAnimationRange(name: string): Nullable<AnimationRange>;
  97013. /**
  97014. * Gets the list of all animation ranges defined on this skeleton
  97015. * @returns an array
  97016. */
  97017. getAnimationRanges(): Nullable<AnimationRange>[];
  97018. /**
  97019. * Copy animation range from a source skeleton.
  97020. * This is not for a complete retargeting, only between very similar skeleton's with only possible bone length differences
  97021. * @param source defines the source skeleton
  97022. * @param name defines the name of the range to copy
  97023. * @param rescaleAsRequired defines if rescaling must be applied if required
  97024. * @returns true if operation was successful
  97025. */
  97026. copyAnimationRange(source: Skeleton, name: string, rescaleAsRequired?: boolean): boolean;
  97027. /**
  97028. * Forces the skeleton to go to rest pose
  97029. */
  97030. returnToRest(): void;
  97031. private _getHighestAnimationFrame;
  97032. /**
  97033. * Begin a specific animation range
  97034. * @param name defines the name of the range to start
  97035. * @param loop defines if looping must be turned on (false by default)
  97036. * @param speedRatio defines the speed ratio to apply (1 by default)
  97037. * @param onAnimationEnd defines a callback which will be called when animation will end
  97038. * @returns a new animatable
  97039. */
  97040. beginAnimation(name: string, loop?: boolean, speedRatio?: number, onAnimationEnd?: () => void): Nullable<Animatable>;
  97041. /**
  97042. * Convert the keyframes for a range of animation on a skeleton to be relative to a given reference frame.
  97043. * @param skeleton defines the Skeleton containing the animation range to convert
  97044. * @param referenceFrame defines the frame that keyframes in the range will be relative to
  97045. * @param range defines the name of the AnimationRange belonging to the Skeleton to convert
  97046. * @returns the original skeleton
  97047. */
  97048. static MakeAnimationAdditive(skeleton: Skeleton, referenceFrame: number | undefined, range: string): Nullable<Skeleton>;
  97049. /** @hidden */
  97050. _markAsDirty(): void;
  97051. /** @hidden */
  97052. _registerMeshWithPoseMatrix(mesh: AbstractMesh): void;
  97053. /** @hidden */
  97054. _unregisterMeshWithPoseMatrix(mesh: AbstractMesh): void;
  97055. private _computeTransformMatrices;
  97056. /**
  97057. * Build all resources required to render a skeleton
  97058. */
  97059. prepare(): void;
  97060. /**
  97061. * Gets the list of animatables currently running for this skeleton
  97062. * @returns an array of animatables
  97063. */
  97064. getAnimatables(): IAnimatable[];
  97065. /**
  97066. * Clone the current skeleton
  97067. * @param name defines the name of the new skeleton
  97068. * @param id defines the id of the new skeleton
  97069. * @returns the new skeleton
  97070. */
  97071. clone(name: string, id?: string): Skeleton;
  97072. /**
  97073. * Enable animation blending for this skeleton
  97074. * @param blendingSpeed defines the blending speed to apply
  97075. * @see https://doc.babylonjs.com/babylon101/animations#animation-blending
  97076. */
  97077. enableBlending(blendingSpeed?: number): void;
  97078. /**
  97079. * Releases all resources associated with the current skeleton
  97080. */
  97081. dispose(): void;
  97082. /**
  97083. * Serialize the skeleton in a JSON object
  97084. * @returns a JSON object
  97085. */
  97086. serialize(): any;
  97087. /**
  97088. * Creates a new skeleton from serialized data
  97089. * @param parsedSkeleton defines the serialized data
  97090. * @param scene defines the hosting scene
  97091. * @returns a new skeleton
  97092. */
  97093. static Parse(parsedSkeleton: any, scene: Scene): Skeleton;
  97094. /**
  97095. * Compute all node absolute transforms
  97096. * @param forceUpdate defines if computation must be done even if cache is up to date
  97097. */
  97098. computeAbsoluteTransforms(forceUpdate?: boolean): void;
  97099. /**
  97100. * Gets the root pose matrix
  97101. * @returns a matrix
  97102. */
  97103. getPoseMatrix(): Nullable<Matrix>;
  97104. /**
  97105. * Sorts bones per internal index
  97106. */
  97107. sortBones(): void;
  97108. private _sortBones;
  97109. /**
  97110. * Set the current local matrix as the restPose for all bones in the skeleton.
  97111. */
  97112. setCurrentPoseAsRest(): void;
  97113. }
  97114. }
  97115. declare module BABYLON {
  97116. /**
  97117. * Creates an instance based on a source mesh.
  97118. */
  97119. export class InstancedMesh extends AbstractMesh {
  97120. private _sourceMesh;
  97121. private _currentLOD;
  97122. /** @hidden */
  97123. _indexInSourceMeshInstanceArray: number;
  97124. constructor(name: string, source: Mesh);
  97125. /**
  97126. * Returns the string "InstancedMesh".
  97127. */
  97128. getClassName(): string;
  97129. /** Gets the list of lights affecting that mesh */
  97130. get lightSources(): Light[];
  97131. _resyncLightSources(): void;
  97132. _resyncLightSource(light: Light): void;
  97133. _removeLightSource(light: Light, dispose: boolean): void;
  97134. /**
  97135. * If the source mesh receives shadows
  97136. */
  97137. get receiveShadows(): boolean;
  97138. /**
  97139. * The material of the source mesh
  97140. */
  97141. get material(): Nullable<Material>;
  97142. /**
  97143. * Visibility of the source mesh
  97144. */
  97145. get visibility(): number;
  97146. /**
  97147. * Skeleton of the source mesh
  97148. */
  97149. get skeleton(): Nullable<Skeleton>;
  97150. /**
  97151. * Rendering ground id of the source mesh
  97152. */
  97153. get renderingGroupId(): number;
  97154. set renderingGroupId(value: number);
  97155. /**
  97156. * Returns the total number of vertices (integer).
  97157. */
  97158. getTotalVertices(): number;
  97159. /**
  97160. * Returns a positive integer : the total number of indices in this mesh geometry.
  97161. * @returns the numner of indices or zero if the mesh has no geometry.
  97162. */
  97163. getTotalIndices(): number;
  97164. /**
  97165. * The source mesh of the instance
  97166. */
  97167. get sourceMesh(): Mesh;
  97168. /**
  97169. * Creates a new InstancedMesh object from the mesh model.
  97170. * @see https://doc.babylonjs.com/how_to/how_to_use_instances
  97171. * @param name defines the name of the new instance
  97172. * @returns a new InstancedMesh
  97173. */
  97174. createInstance(name: string): InstancedMesh;
  97175. /**
  97176. * Is this node ready to be used/rendered
  97177. * @param completeCheck defines if a complete check (including materials and lights) has to be done (false by default)
  97178. * @return {boolean} is it ready
  97179. */
  97180. isReady(completeCheck?: boolean): boolean;
  97181. /**
  97182. * Returns an array of integers or a typed array (Int32Array, Uint32Array, Uint16Array) populated with the mesh indices.
  97183. * @param kind kind of verticies to retreive (eg. positons, normals, uvs, etc.)
  97184. * @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.
  97185. * @returns a float array or a Float32Array of the requested kind of data : positons, normals, uvs, etc.
  97186. */
  97187. getVerticesData(kind: string, copyWhenShared?: boolean): Nullable<FloatArray>;
  97188. /**
  97189. * Sets the vertex data of the mesh geometry for the requested `kind`.
  97190. * If the mesh has no geometry, a new Geometry object is set to the mesh and then passed this vertex data.
  97191. * The `data` are either a numeric array either a Float32Array.
  97192. * The parameter `updatable` is passed as is to the underlying Geometry object constructor (if initianilly none) or updater.
  97193. * 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).
  97194. * Note that a new underlying VertexBuffer object is created each call.
  97195. * If the `kind` is the `PositionKind`, the mesh BoundingInfo is renewed, so the bounding box and sphere, and the mesh World Matrix is recomputed.
  97196. *
  97197. * Possible `kind` values :
  97198. * - VertexBuffer.PositionKind
  97199. * - VertexBuffer.UVKind
  97200. * - VertexBuffer.UV2Kind
  97201. * - VertexBuffer.UV3Kind
  97202. * - VertexBuffer.UV4Kind
  97203. * - VertexBuffer.UV5Kind
  97204. * - VertexBuffer.UV6Kind
  97205. * - VertexBuffer.ColorKind
  97206. * - VertexBuffer.MatricesIndicesKind
  97207. * - VertexBuffer.MatricesIndicesExtraKind
  97208. * - VertexBuffer.MatricesWeightsKind
  97209. * - VertexBuffer.MatricesWeightsExtraKind
  97210. *
  97211. * Returns the Mesh.
  97212. */
  97213. setVerticesData(kind: string, data: FloatArray, updatable?: boolean, stride?: number): AbstractMesh;
  97214. /**
  97215. * Updates the existing vertex data of the mesh geometry for the requested `kind`.
  97216. * If the mesh has no geometry, it is simply returned as it is.
  97217. * The `data` are either a numeric array either a Float32Array.
  97218. * No new underlying VertexBuffer object is created.
  97219. * 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.
  97220. * If the parameter `makeItUnique` is true, a new global geometry is created from this positions and is set to the mesh.
  97221. *
  97222. * Possible `kind` values :
  97223. * - VertexBuffer.PositionKind
  97224. * - VertexBuffer.UVKind
  97225. * - VertexBuffer.UV2Kind
  97226. * - VertexBuffer.UV3Kind
  97227. * - VertexBuffer.UV4Kind
  97228. * - VertexBuffer.UV5Kind
  97229. * - VertexBuffer.UV6Kind
  97230. * - VertexBuffer.ColorKind
  97231. * - VertexBuffer.MatricesIndicesKind
  97232. * - VertexBuffer.MatricesIndicesExtraKind
  97233. * - VertexBuffer.MatricesWeightsKind
  97234. * - VertexBuffer.MatricesWeightsExtraKind
  97235. *
  97236. * Returns the Mesh.
  97237. */
  97238. updateVerticesData(kind: string, data: FloatArray, updateExtends?: boolean, makeItUnique?: boolean): Mesh;
  97239. /**
  97240. * Sets the mesh indices.
  97241. * Expects an array populated with integers or a typed array (Int32Array, Uint32Array, Uint16Array).
  97242. * If the mesh has no geometry, a new Geometry object is created and set to the mesh.
  97243. * This method creates a new index buffer each call.
  97244. * Returns the Mesh.
  97245. */
  97246. setIndices(indices: IndicesArray, totalVertices?: Nullable<number>): Mesh;
  97247. /**
  97248. * Boolean : True if the mesh owns the requested kind of data.
  97249. */
  97250. isVerticesDataPresent(kind: string): boolean;
  97251. /**
  97252. * Returns an array of indices (IndicesArray).
  97253. */
  97254. getIndices(): Nullable<IndicesArray>;
  97255. get _positions(): Nullable<Vector3[]>;
  97256. /**
  97257. * This method recomputes and sets a new BoundingInfo to the mesh unless it is locked.
  97258. * This means the mesh underlying bounding box and sphere are recomputed.
  97259. * @param applySkeleton defines whether to apply the skeleton before computing the bounding info
  97260. * @returns the current mesh
  97261. */
  97262. refreshBoundingInfo(applySkeleton?: boolean): InstancedMesh;
  97263. /** @hidden */
  97264. _preActivate(): InstancedMesh;
  97265. /** @hidden */
  97266. _activate(renderId: number, intermediateRendering: boolean): boolean;
  97267. /** @hidden */
  97268. _postActivate(): void;
  97269. getWorldMatrix(): Matrix;
  97270. get isAnInstance(): boolean;
  97271. /**
  97272. * Returns the current associated LOD AbstractMesh.
  97273. */
  97274. getLOD(camera: Camera): AbstractMesh;
  97275. /** @hidden */
  97276. _preActivateForIntermediateRendering(renderId: number): Mesh;
  97277. /** @hidden */
  97278. _syncSubMeshes(): InstancedMesh;
  97279. /** @hidden */
  97280. _generatePointsArray(): boolean;
  97281. /** @hidden */
  97282. _updateBoundingInfo(): AbstractMesh;
  97283. /**
  97284. * Creates a new InstancedMesh from the current mesh.
  97285. * - name (string) : the cloned mesh name
  97286. * - newParent (optional Node) : the optional Node to parent the clone to.
  97287. * - doNotCloneChildren (optional boolean, default `false`) : if `true` the model children aren't cloned.
  97288. *
  97289. * Returns the clone.
  97290. */
  97291. clone(name: string, newParent?: Nullable<Node>, doNotCloneChildren?: boolean): InstancedMesh;
  97292. /**
  97293. * Disposes the InstancedMesh.
  97294. * Returns nothing.
  97295. */
  97296. dispose(doNotRecurse?: boolean, disposeMaterialAndTextures?: boolean): void;
  97297. }
  97298. interface Mesh {
  97299. /**
  97300. * Register a custom buffer that will be instanced
  97301. * @see https://doc.babylonjs.com/how_to/how_to_use_instances#custom-buffers
  97302. * @param kind defines the buffer kind
  97303. * @param stride defines the stride in floats
  97304. */
  97305. registerInstancedBuffer(kind: string, stride: number): void;
  97306. /**
  97307. * true to use the edge renderer for all instances of this mesh
  97308. */
  97309. edgesShareWithInstances: boolean;
  97310. /** @hidden */
  97311. _userInstancedBuffersStorage: {
  97312. data: {
  97313. [key: string]: Float32Array;
  97314. };
  97315. sizes: {
  97316. [key: string]: number;
  97317. };
  97318. vertexBuffers: {
  97319. [key: string]: Nullable<VertexBuffer>;
  97320. };
  97321. strides: {
  97322. [key: string]: number;
  97323. };
  97324. };
  97325. }
  97326. interface AbstractMesh {
  97327. /**
  97328. * Object used to store instanced buffers defined by user
  97329. * @see https://doc.babylonjs.com/how_to/how_to_use_instances#custom-buffers
  97330. */
  97331. instancedBuffers: {
  97332. [key: string]: any;
  97333. };
  97334. }
  97335. }
  97336. declare module BABYLON {
  97337. /**
  97338. * Defines the options associated with the creation of a shader material.
  97339. */
  97340. export interface IShaderMaterialOptions {
  97341. /**
  97342. * Does the material work in alpha blend mode
  97343. */
  97344. needAlphaBlending: boolean;
  97345. /**
  97346. * Does the material work in alpha test mode
  97347. */
  97348. needAlphaTesting: boolean;
  97349. /**
  97350. * The list of attribute names used in the shader
  97351. */
  97352. attributes: string[];
  97353. /**
  97354. * The list of unifrom names used in the shader
  97355. */
  97356. uniforms: string[];
  97357. /**
  97358. * The list of UBO names used in the shader
  97359. */
  97360. uniformBuffers: string[];
  97361. /**
  97362. * The list of sampler names used in the shader
  97363. */
  97364. samplers: string[];
  97365. /**
  97366. * The list of defines used in the shader
  97367. */
  97368. defines: string[];
  97369. }
  97370. /**
  97371. * 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.
  97372. *
  97373. * This returned material effects how the mesh will look based on the code in the shaders.
  97374. *
  97375. * @see https://doc.babylonjs.com/how_to/shader_material
  97376. */
  97377. export class ShaderMaterial extends Material {
  97378. private _shaderPath;
  97379. private _options;
  97380. private _textures;
  97381. private _textureArrays;
  97382. private _floats;
  97383. private _ints;
  97384. private _floatsArrays;
  97385. private _colors3;
  97386. private _colors3Arrays;
  97387. private _colors4;
  97388. private _colors4Arrays;
  97389. private _vectors2;
  97390. private _vectors3;
  97391. private _vectors4;
  97392. private _matrices;
  97393. private _matrixArrays;
  97394. private _matrices3x3;
  97395. private _matrices2x2;
  97396. private _vectors2Arrays;
  97397. private _vectors3Arrays;
  97398. private _vectors4Arrays;
  97399. private _cachedWorldViewMatrix;
  97400. private _cachedWorldViewProjectionMatrix;
  97401. private _renderId;
  97402. private _multiview;
  97403. private _cachedDefines;
  97404. /** Define the Url to load snippets */
  97405. static SnippetUrl: string;
  97406. /** Snippet ID if the material was created from the snippet server */
  97407. snippetId: string;
  97408. /**
  97409. * Instantiate a new shader material.
  97410. * 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.
  97411. * This returned material effects how the mesh will look based on the code in the shaders.
  97412. * @see https://doc.babylonjs.com/how_to/shader_material
  97413. * @param name Define the name of the material in the scene
  97414. * @param scene Define the scene the material belongs to
  97415. * @param shaderPath Defines the route to the shader code in one of three ways:
  97416. * * object: { vertex: "custom", fragment: "custom" }, used with Effect.ShadersStore["customVertexShader"] and Effect.ShadersStore["customFragmentShader"]
  97417. * * object: { vertexElement: "vertexShaderCode", fragmentElement: "fragmentShaderCode" }, used with shader code in script tags
  97418. * * object: { vertexSource: "vertex shader code string", fragmentSource: "fragment shader code string" } using with strings containing the shaders code
  97419. * * string: "./COMMON_NAME", used with external files COMMON_NAME.vertex.fx and COMMON_NAME.fragment.fx in index.html folder.
  97420. * @param options Define the options used to create the shader
  97421. */
  97422. constructor(name: string, scene: Scene, shaderPath: any, options?: Partial<IShaderMaterialOptions>);
  97423. /**
  97424. * Gets the shader path used to define the shader code
  97425. * It can be modified to trigger a new compilation
  97426. */
  97427. get shaderPath(): any;
  97428. /**
  97429. * Sets the shader path used to define the shader code
  97430. * It can be modified to trigger a new compilation
  97431. */
  97432. set shaderPath(shaderPath: any);
  97433. /**
  97434. * Gets the options used to compile the shader.
  97435. * They can be modified to trigger a new compilation
  97436. */
  97437. get options(): IShaderMaterialOptions;
  97438. /**
  97439. * Gets the current class name of the material e.g. "ShaderMaterial"
  97440. * Mainly use in serialization.
  97441. * @returns the class name
  97442. */
  97443. getClassName(): string;
  97444. /**
  97445. * Specifies if the material will require alpha blending
  97446. * @returns a boolean specifying if alpha blending is needed
  97447. */
  97448. needAlphaBlending(): boolean;
  97449. /**
  97450. * Specifies if this material should be rendered in alpha test mode
  97451. * @returns a boolean specifying if an alpha test is needed.
  97452. */
  97453. needAlphaTesting(): boolean;
  97454. private _checkUniform;
  97455. /**
  97456. * Set a texture in the shader.
  97457. * @param name Define the name of the uniform samplers as defined in the shader
  97458. * @param texture Define the texture to bind to this sampler
  97459. * @return the material itself allowing "fluent" like uniform updates
  97460. */
  97461. setTexture(name: string, texture: BaseTexture): ShaderMaterial;
  97462. /**
  97463. * Set a texture array in the shader.
  97464. * @param name Define the name of the uniform sampler array as defined in the shader
  97465. * @param textures Define the list of textures to bind to this sampler
  97466. * @return the material itself allowing "fluent" like uniform updates
  97467. */
  97468. setTextureArray(name: string, textures: BaseTexture[]): ShaderMaterial;
  97469. /**
  97470. * Set a float in the shader.
  97471. * @param name Define the name of the uniform as defined in the shader
  97472. * @param value Define the value to give to the uniform
  97473. * @return the material itself allowing "fluent" like uniform updates
  97474. */
  97475. setFloat(name: string, value: number): ShaderMaterial;
  97476. /**
  97477. * Set a int in the shader.
  97478. * @param name Define the name of the uniform as defined in the shader
  97479. * @param value Define the value to give to the uniform
  97480. * @return the material itself allowing "fluent" like uniform updates
  97481. */
  97482. setInt(name: string, value: number): ShaderMaterial;
  97483. /**
  97484. * Set an array of floats in the shader.
  97485. * @param name Define the name of the uniform as defined in the shader
  97486. * @param value Define the value to give to the uniform
  97487. * @return the material itself allowing "fluent" like uniform updates
  97488. */
  97489. setFloats(name: string, value: number[]): ShaderMaterial;
  97490. /**
  97491. * Set a vec3 in the shader from a Color3.
  97492. * @param name Define the name of the uniform as defined in the shader
  97493. * @param value Define the value to give to the uniform
  97494. * @return the material itself allowing "fluent" like uniform updates
  97495. */
  97496. setColor3(name: string, value: Color3): ShaderMaterial;
  97497. /**
  97498. * Set a vec3 array in the shader from a Color3 array.
  97499. * @param name Define the name of the uniform as defined in the shader
  97500. * @param value Define the value to give to the uniform
  97501. * @return the material itself allowing "fluent" like uniform updates
  97502. */
  97503. setColor3Array(name: string, value: Color3[]): ShaderMaterial;
  97504. /**
  97505. * Set a vec4 in the shader from a Color4.
  97506. * @param name Define the name of the uniform as defined in the shader
  97507. * @param value Define the value to give to the uniform
  97508. * @return the material itself allowing "fluent" like uniform updates
  97509. */
  97510. setColor4(name: string, value: Color4): ShaderMaterial;
  97511. /**
  97512. * Set a vec4 array in the shader from a Color4 array.
  97513. * @param name Define the name of the uniform as defined in the shader
  97514. * @param value Define the value to give to the uniform
  97515. * @return the material itself allowing "fluent" like uniform updates
  97516. */
  97517. setColor4Array(name: string, value: Color4[]): ShaderMaterial;
  97518. /**
  97519. * Set a vec2 in the shader from a Vector2.
  97520. * @param name Define the name of the uniform as defined in the shader
  97521. * @param value Define the value to give to the uniform
  97522. * @return the material itself allowing "fluent" like uniform updates
  97523. */
  97524. setVector2(name: string, value: Vector2): ShaderMaterial;
  97525. /**
  97526. * Set a vec3 in the shader from a Vector3.
  97527. * @param name Define the name of the uniform as defined in the shader
  97528. * @param value Define the value to give to the uniform
  97529. * @return the material itself allowing "fluent" like uniform updates
  97530. */
  97531. setVector3(name: string, value: Vector3): ShaderMaterial;
  97532. /**
  97533. * Set a vec4 in the shader from a Vector4.
  97534. * @param name Define the name of the uniform as defined in the shader
  97535. * @param value Define the value to give to the uniform
  97536. * @return the material itself allowing "fluent" like uniform updates
  97537. */
  97538. setVector4(name: string, value: Vector4): ShaderMaterial;
  97539. /**
  97540. * Set a mat4 in the shader from a Matrix.
  97541. * @param name Define the name of the uniform as defined in the shader
  97542. * @param value Define the value to give to the uniform
  97543. * @return the material itself allowing "fluent" like uniform updates
  97544. */
  97545. setMatrix(name: string, value: Matrix): ShaderMaterial;
  97546. /**
  97547. * Set a float32Array in the shader from a matrix array.
  97548. * @param name Define the name of the uniform as defined in the shader
  97549. * @param value Define the value to give to the uniform
  97550. * @return the material itself allowing "fluent" like uniform updates
  97551. */
  97552. setMatrices(name: string, value: Matrix[]): ShaderMaterial;
  97553. /**
  97554. * Set a mat3 in the shader from a Float32Array.
  97555. * @param name Define the name of the uniform as defined in the shader
  97556. * @param value Define the value to give to the uniform
  97557. * @return the material itself allowing "fluent" like uniform updates
  97558. */
  97559. setMatrix3x3(name: string, value: Float32Array | Array<number>): ShaderMaterial;
  97560. /**
  97561. * Set a mat2 in the shader from a Float32Array.
  97562. * @param name Define the name of the uniform as defined in the shader
  97563. * @param value Define the value to give to the uniform
  97564. * @return the material itself allowing "fluent" like uniform updates
  97565. */
  97566. setMatrix2x2(name: string, value: Float32Array | Array<number>): ShaderMaterial;
  97567. /**
  97568. * Set a vec2 array in the shader from a number array.
  97569. * @param name Define the name of the uniform as defined in the shader
  97570. * @param value Define the value to give to the uniform
  97571. * @return the material itself allowing "fluent" like uniform updates
  97572. */
  97573. setArray2(name: string, value: number[]): ShaderMaterial;
  97574. /**
  97575. * Set a vec3 array in the shader from a number array.
  97576. * @param name Define the name of the uniform as defined in the shader
  97577. * @param value Define the value to give to the uniform
  97578. * @return the material itself allowing "fluent" like uniform updates
  97579. */
  97580. setArray3(name: string, value: number[]): ShaderMaterial;
  97581. /**
  97582. * Set a vec4 array in the shader from a number array.
  97583. * @param name Define the name of the uniform as defined in the shader
  97584. * @param value Define the value to give to the uniform
  97585. * @return the material itself allowing "fluent" like uniform updates
  97586. */
  97587. setArray4(name: string, value: number[]): ShaderMaterial;
  97588. private _checkCache;
  97589. /**
  97590. * Specifies that the submesh is ready to be used
  97591. * @param mesh defines the mesh to check
  97592. * @param subMesh defines which submesh to check
  97593. * @param useInstances specifies that instances should be used
  97594. * @returns a boolean indicating that the submesh is ready or not
  97595. */
  97596. isReadyForSubMesh(mesh: AbstractMesh, subMesh: SubMesh, useInstances?: boolean): boolean;
  97597. /**
  97598. * Checks if the material is ready to render the requested mesh
  97599. * @param mesh Define the mesh to render
  97600. * @param useInstances Define whether or not the material is used with instances
  97601. * @returns true if ready, otherwise false
  97602. */
  97603. isReady(mesh?: AbstractMesh, useInstances?: boolean): boolean;
  97604. /**
  97605. * Binds the world matrix to the material
  97606. * @param world defines the world transformation matrix
  97607. * @param effectOverride - If provided, use this effect instead of internal effect
  97608. */
  97609. bindOnlyWorldMatrix(world: Matrix, effectOverride?: Nullable<Effect>): void;
  97610. /**
  97611. * Binds the submesh to this material by preparing the effect and shader to draw
  97612. * @param world defines the world transformation matrix
  97613. * @param mesh defines the mesh containing the submesh
  97614. * @param subMesh defines the submesh to bind the material to
  97615. */
  97616. bindForSubMesh(world: Matrix, mesh: Mesh, subMesh: SubMesh): void;
  97617. /**
  97618. * Binds the material to the mesh
  97619. * @param world defines the world transformation matrix
  97620. * @param mesh defines the mesh to bind the material to
  97621. * @param effectOverride - If provided, use this effect instead of internal effect
  97622. */
  97623. bind(world: Matrix, mesh?: Mesh, effectOverride?: Nullable<Effect>): void;
  97624. protected _afterBind(mesh?: Mesh): void;
  97625. /**
  97626. * Gets the active textures from the material
  97627. * @returns an array of textures
  97628. */
  97629. getActiveTextures(): BaseTexture[];
  97630. /**
  97631. * Specifies if the material uses a texture
  97632. * @param texture defines the texture to check against the material
  97633. * @returns a boolean specifying if the material uses the texture
  97634. */
  97635. hasTexture(texture: BaseTexture): boolean;
  97636. /**
  97637. * Makes a duplicate of the material, and gives it a new name
  97638. * @param name defines the new name for the duplicated material
  97639. * @returns the cloned material
  97640. */
  97641. clone(name: string): ShaderMaterial;
  97642. /**
  97643. * Disposes the material
  97644. * @param forceDisposeEffect specifies if effects should be forcefully disposed
  97645. * @param forceDisposeTextures specifies if textures should be forcefully disposed
  97646. * @param notBoundToMesh specifies if the material that is being disposed is known to be not bound to any mesh
  97647. */
  97648. dispose(forceDisposeEffect?: boolean, forceDisposeTextures?: boolean, notBoundToMesh?: boolean): void;
  97649. /**
  97650. * Serializes this material in a JSON representation
  97651. * @returns the serialized material object
  97652. */
  97653. serialize(): any;
  97654. /**
  97655. * Creates a shader material from parsed shader material data
  97656. * @param source defines the JSON represnetation of the material
  97657. * @param scene defines the hosting scene
  97658. * @param rootUrl defines the root URL to use to load textures and relative dependencies
  97659. * @returns a new material
  97660. */
  97661. static Parse(source: any, scene: Scene, rootUrl: string): ShaderMaterial;
  97662. /**
  97663. * Creates a new ShaderMaterial from a snippet saved in a remote file
  97664. * @param name defines the name of the ShaderMaterial to create (can be null or empty to use the one from the json data)
  97665. * @param url defines the url to load from
  97666. * @param scene defines the hosting scene
  97667. * @param rootUrl defines the root URL to use to load textures and relative dependencies
  97668. * @returns a promise that will resolve to the new ShaderMaterial
  97669. */
  97670. static ParseFromFileAsync(name: Nullable<string>, url: string, scene: Scene, rootUrl?: string): Promise<ShaderMaterial>;
  97671. /**
  97672. * Creates a ShaderMaterial from a snippet saved by the Inspector
  97673. * @param snippetId defines the snippet to load
  97674. * @param scene defines the hosting scene
  97675. * @param rootUrl defines the root URL to use to load textures and relative dependencies
  97676. * @returns a promise that will resolve to the new ShaderMaterial
  97677. */
  97678. static CreateFromSnippetAsync(snippetId: string, scene: Scene, rootUrl?: string): Promise<ShaderMaterial>;
  97679. }
  97680. }
  97681. declare module BABYLON {
  97682. /** @hidden */
  97683. export var colorPixelShader: {
  97684. name: string;
  97685. shader: string;
  97686. };
  97687. }
  97688. declare module BABYLON {
  97689. /** @hidden */
  97690. export var colorVertexShader: {
  97691. name: string;
  97692. shader: string;
  97693. };
  97694. }
  97695. declare module BABYLON {
  97696. /**
  97697. * Line mesh
  97698. * @see https://doc.babylonjs.com/babylon101/parametric_shapes
  97699. */
  97700. export class LinesMesh extends Mesh {
  97701. /**
  97702. * If vertex color should be applied to the mesh
  97703. */
  97704. readonly useVertexColor?: boolean | undefined;
  97705. /**
  97706. * If vertex alpha should be applied to the mesh
  97707. */
  97708. readonly useVertexAlpha?: boolean | undefined;
  97709. /**
  97710. * Color of the line (Default: White)
  97711. */
  97712. color: Color3;
  97713. /**
  97714. * Alpha of the line (Default: 1)
  97715. */
  97716. alpha: number;
  97717. /**
  97718. * The intersection Threshold is the margin applied when intersection a segment of the LinesMesh with a Ray.
  97719. * This margin is expressed in world space coordinates, so its value may vary.
  97720. * Default value is 0.1
  97721. */
  97722. intersectionThreshold: number;
  97723. private _colorShader;
  97724. private color4;
  97725. /**
  97726. * Creates a new LinesMesh
  97727. * @param name defines the name
  97728. * @param scene defines the hosting scene
  97729. * @param parent defines the parent mesh if any
  97730. * @param source defines the optional source LinesMesh used to clone data from
  97731. * @param doNotCloneChildren When cloning, skip cloning child meshes of source, default False.
  97732. * When false, achieved by calling a clone(), also passing False.
  97733. * This will make creation of children, recursive.
  97734. * @param useVertexColor defines if this LinesMesh supports vertex color
  97735. * @param useVertexAlpha defines if this LinesMesh supports vertex alpha
  97736. */
  97737. constructor(name: string, scene?: Nullable<Scene>, parent?: Nullable<Node>, source?: Nullable<LinesMesh>, doNotCloneChildren?: boolean,
  97738. /**
  97739. * If vertex color should be applied to the mesh
  97740. */
  97741. useVertexColor?: boolean | undefined,
  97742. /**
  97743. * If vertex alpha should be applied to the mesh
  97744. */
  97745. useVertexAlpha?: boolean | undefined);
  97746. private _addClipPlaneDefine;
  97747. private _removeClipPlaneDefine;
  97748. isReady(): boolean;
  97749. /**
  97750. * Returns the string "LineMesh"
  97751. */
  97752. getClassName(): string;
  97753. /**
  97754. * @hidden
  97755. */
  97756. get material(): Material;
  97757. /**
  97758. * @hidden
  97759. */
  97760. set material(value: Material);
  97761. /**
  97762. * @hidden
  97763. */
  97764. get checkCollisions(): boolean;
  97765. /** @hidden */
  97766. _bind(subMesh: SubMesh, effect: Effect, fillMode: number): Mesh;
  97767. /** @hidden */
  97768. _draw(subMesh: SubMesh, fillMode: number, instancesCount?: number): Mesh;
  97769. /**
  97770. * Disposes of the line mesh
  97771. * @param doNotRecurse If children should be disposed
  97772. */
  97773. dispose(doNotRecurse?: boolean): void;
  97774. /**
  97775. * Returns a new LineMesh object cloned from the current one.
  97776. */
  97777. clone(name: string, newParent?: Nullable<Node>, doNotCloneChildren?: boolean): LinesMesh;
  97778. /**
  97779. * Creates a new InstancedLinesMesh object from the mesh model.
  97780. * @see https://doc.babylonjs.com/how_to/how_to_use_instances
  97781. * @param name defines the name of the new instance
  97782. * @returns a new InstancedLinesMesh
  97783. */
  97784. createInstance(name: string): InstancedLinesMesh;
  97785. }
  97786. /**
  97787. * Creates an instance based on a source LinesMesh
  97788. */
  97789. export class InstancedLinesMesh extends InstancedMesh {
  97790. /**
  97791. * The intersection Threshold is the margin applied when intersection a segment of the LinesMesh with a Ray.
  97792. * This margin is expressed in world space coordinates, so its value may vary.
  97793. * Initilized with the intersectionThreshold value of the source LinesMesh
  97794. */
  97795. intersectionThreshold: number;
  97796. constructor(name: string, source: LinesMesh);
  97797. /**
  97798. * Returns the string "InstancedLinesMesh".
  97799. */
  97800. getClassName(): string;
  97801. }
  97802. }
  97803. declare module BABYLON {
  97804. /** @hidden */
  97805. export var linePixelShader: {
  97806. name: string;
  97807. shader: string;
  97808. };
  97809. }
  97810. declare module BABYLON {
  97811. /** @hidden */
  97812. export var lineVertexShader: {
  97813. name: string;
  97814. shader: string;
  97815. };
  97816. }
  97817. declare module BABYLON {
  97818. interface Scene {
  97819. /** @hidden */
  97820. _edgeRenderLineShader: Nullable<ShaderMaterial>;
  97821. }
  97822. interface AbstractMesh {
  97823. /**
  97824. * Gets the edgesRenderer associated with the mesh
  97825. */
  97826. edgesRenderer: Nullable<EdgesRenderer>;
  97827. }
  97828. interface LinesMesh {
  97829. /**
  97830. * Enables the edge rendering mode on the mesh.
  97831. * This mode makes the mesh edges visible
  97832. * @param epsilon defines the maximal distance between two angles to detect a face
  97833. * @param checkVerticesInsteadOfIndices indicates that we should check vertex list directly instead of faces
  97834. * @returns the currentAbstractMesh
  97835. * @see https://www.babylonjs-playground.com/#19O9TU#0
  97836. */
  97837. enableEdgesRendering(epsilon?: number, checkVerticesInsteadOfIndices?: boolean): AbstractMesh;
  97838. }
  97839. interface InstancedLinesMesh {
  97840. /**
  97841. * Enables the edge rendering mode on the mesh.
  97842. * This mode makes the mesh edges visible
  97843. * @param epsilon defines the maximal distance between two angles to detect a face
  97844. * @param checkVerticesInsteadOfIndices indicates that we should check vertex list directly instead of faces
  97845. * @returns the current InstancedLinesMesh
  97846. * @see https://www.babylonjs-playground.com/#19O9TU#0
  97847. */
  97848. enableEdgesRendering(epsilon?: number, checkVerticesInsteadOfIndices?: boolean): InstancedLinesMesh;
  97849. }
  97850. /**
  97851. * Defines the minimum contract an Edges renderer should follow.
  97852. */
  97853. export interface IEdgesRenderer extends IDisposable {
  97854. /**
  97855. * Gets or sets a boolean indicating if the edgesRenderer is active
  97856. */
  97857. isEnabled: boolean;
  97858. /**
  97859. * Renders the edges of the attached mesh,
  97860. */
  97861. render(): void;
  97862. /**
  97863. * Checks wether or not the edges renderer is ready to render.
  97864. * @return true if ready, otherwise false.
  97865. */
  97866. isReady(): boolean;
  97867. /**
  97868. * List of instances to render in case the source mesh has instances
  97869. */
  97870. customInstances: SmartArray<Matrix>;
  97871. }
  97872. /**
  97873. * Defines the additional options of the edges renderer
  97874. */
  97875. export interface IEdgesRendererOptions {
  97876. /**
  97877. * Gets or sets a boolean indicating that the alternate edge finder algorithm must be used
  97878. * If not defined, the default value is true
  97879. */
  97880. useAlternateEdgeFinder?: boolean;
  97881. /**
  97882. * Gets or sets a boolean indicating that the vertex merger fast processing must be used.
  97883. * If not defined, the default value is true.
  97884. * 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)
  97885. * This option is used only if useAlternateEdgeFinder = true
  97886. */
  97887. useFastVertexMerger?: boolean;
  97888. /**
  97889. * During edges processing, the vertices are merged if they are close enough: epsilonVertexMerge is the limit whithin which vertices are considered to be equal.
  97890. * The default value is 1e-6
  97891. * This option is used only if useAlternateEdgeFinder = true
  97892. */
  97893. epsilonVertexMerge?: number;
  97894. /**
  97895. * 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
  97896. * 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.
  97897. * This option is used only if useAlternateEdgeFinder = true
  97898. */
  97899. applyTessellation?: boolean;
  97900. /**
  97901. * 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
  97902. * The default value is 1e-6
  97903. * This option is used only if useAlternateEdgeFinder = true
  97904. */
  97905. epsilonVertexAligned?: number;
  97906. }
  97907. /**
  97908. * This class is used to generate edges of the mesh that could then easily be rendered in a scene.
  97909. */
  97910. export class EdgesRenderer implements IEdgesRenderer {
  97911. /**
  97912. * Define the size of the edges with an orthographic camera
  97913. */
  97914. edgesWidthScalerForOrthographic: number;
  97915. /**
  97916. * Define the size of the edges with a perspective camera
  97917. */
  97918. edgesWidthScalerForPerspective: number;
  97919. protected _source: AbstractMesh;
  97920. protected _linesPositions: number[];
  97921. protected _linesNormals: number[];
  97922. protected _linesIndices: number[];
  97923. protected _epsilon: number;
  97924. protected _indicesCount: number;
  97925. protected _lineShader: ShaderMaterial;
  97926. protected _ib: DataBuffer;
  97927. protected _buffers: {
  97928. [key: string]: Nullable<VertexBuffer>;
  97929. };
  97930. protected _buffersForInstances: {
  97931. [key: string]: Nullable<VertexBuffer>;
  97932. };
  97933. protected _checkVerticesInsteadOfIndices: boolean;
  97934. protected _options: Nullable<IEdgesRendererOptions>;
  97935. private _meshRebuildObserver;
  97936. private _meshDisposeObserver;
  97937. /** Gets or sets a boolean indicating if the edgesRenderer is active */
  97938. isEnabled: boolean;
  97939. /**
  97940. * List of instances to render in case the source mesh has instances
  97941. */
  97942. customInstances: SmartArray<Matrix>;
  97943. private static GetShader;
  97944. /**
  97945. * Creates an instance of the EdgesRenderer. It is primarily use to display edges of a mesh.
  97946. * Beware when you use this class with complex objects as the adjacencies computation can be really long
  97947. * @param source Mesh used to create edges
  97948. * @param epsilon sum of angles in adjacency to check for edge
  97949. * @param checkVerticesInsteadOfIndices bases the edges detection on vertices vs indices. Note that this parameter is not used if options.useAlternateEdgeFinder = true
  97950. * @param generateEdgesLines - should generate Lines or only prepare resources.
  97951. * @param options The options to apply when generating the edges
  97952. */
  97953. constructor(source: AbstractMesh, epsilon?: number, checkVerticesInsteadOfIndices?: boolean, generateEdgesLines?: boolean, options?: IEdgesRendererOptions);
  97954. protected _prepareRessources(): void;
  97955. /** @hidden */
  97956. _rebuild(): void;
  97957. /**
  97958. * Releases the required resources for the edges renderer
  97959. */
  97960. dispose(): void;
  97961. protected _processEdgeForAdjacencies(pa: number, pb: number, p0: number, p1: number, p2: number): number;
  97962. protected _processEdgeForAdjacenciesWithVertices(pa: Vector3, pb: Vector3, p0: Vector3, p1: Vector3, p2: Vector3): number;
  97963. /**
  97964. * Checks if the pair of p0 and p1 is en edge
  97965. * @param faceIndex
  97966. * @param edge
  97967. * @param faceNormals
  97968. * @param p0
  97969. * @param p1
  97970. * @private
  97971. */
  97972. protected _checkEdge(faceIndex: number, edge: number, faceNormals: Array<Vector3>, p0: Vector3, p1: Vector3): void;
  97973. /**
  97974. * push line into the position, normal and index buffer
  97975. * @protected
  97976. */
  97977. protected createLine(p0: Vector3, p1: Vector3, offset: number): void;
  97978. /**
  97979. * See https://playground.babylonjs.com/#R3JR6V#1 for a visual display of the algorithm
  97980. */
  97981. private _tessellateTriangle;
  97982. private _generateEdgesLinesAlternate;
  97983. /**
  97984. * Generates lines edges from adjacencjes
  97985. * @private
  97986. */
  97987. _generateEdgesLines(): void;
  97988. /**
  97989. * Checks wether or not the edges renderer is ready to render.
  97990. * @return true if ready, otherwise false.
  97991. */
  97992. isReady(): boolean;
  97993. /**
  97994. * Renders the edges of the attached mesh,
  97995. */
  97996. render(): void;
  97997. }
  97998. /**
  97999. * LineEdgesRenderer for LineMeshes to remove unnecessary triangulation
  98000. */
  98001. export class LineEdgesRenderer extends EdgesRenderer {
  98002. /**
  98003. * This constructor turns off auto generating edges line in Edges Renderer to make it here.
  98004. * @param source LineMesh used to generate edges
  98005. * @param epsilon not important (specified angle for edge detection)
  98006. * @param checkVerticesInsteadOfIndices not important for LineMesh
  98007. */
  98008. constructor(source: AbstractMesh, epsilon?: number, checkVerticesInsteadOfIndices?: boolean);
  98009. /**
  98010. * Generate edges for each line in LinesMesh. Every Line should be rendered as edge.
  98011. */
  98012. _generateEdgesLines(): void;
  98013. }
  98014. }
  98015. declare module BABYLON {
  98016. /**
  98017. * This represents the object necessary to create a rendering group.
  98018. * This is exclusively used and created by the rendering manager.
  98019. * To modify the behavior, you use the available helpers in your scene or meshes.
  98020. * @hidden
  98021. */
  98022. export class RenderingGroup {
  98023. index: number;
  98024. private static _zeroVector;
  98025. private _scene;
  98026. private _opaqueSubMeshes;
  98027. private _transparentSubMeshes;
  98028. private _alphaTestSubMeshes;
  98029. private _depthOnlySubMeshes;
  98030. private _particleSystems;
  98031. private _spriteManagers;
  98032. private _opaqueSortCompareFn;
  98033. private _alphaTestSortCompareFn;
  98034. private _transparentSortCompareFn;
  98035. private _renderOpaque;
  98036. private _renderAlphaTest;
  98037. private _renderTransparent;
  98038. /** @hidden */
  98039. _edgesRenderers: SmartArrayNoDuplicate<IEdgesRenderer>;
  98040. onBeforeTransparentRendering: () => void;
  98041. /**
  98042. * Set the opaque sort comparison function.
  98043. * If null the sub meshes will be render in the order they were created
  98044. */
  98045. set opaqueSortCompareFn(value: Nullable<(a: SubMesh, b: SubMesh) => number>);
  98046. /**
  98047. * Set the alpha test sort comparison function.
  98048. * If null the sub meshes will be render in the order they were created
  98049. */
  98050. set alphaTestSortCompareFn(value: Nullable<(a: SubMesh, b: SubMesh) => number>);
  98051. /**
  98052. * Set the transparent sort comparison function.
  98053. * If null the sub meshes will be render in the order they were created
  98054. */
  98055. set transparentSortCompareFn(value: Nullable<(a: SubMesh, b: SubMesh) => number>);
  98056. /**
  98057. * Creates a new rendering group.
  98058. * @param index The rendering group index
  98059. * @param opaqueSortCompareFn The opaque sort comparison function. If null no order is applied
  98060. * @param alphaTestSortCompareFn The alpha test sort comparison function. If null no order is applied
  98061. * @param transparentSortCompareFn The transparent sort comparison function. If null back to front + alpha index sort is applied
  98062. */
  98063. 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>);
  98064. /**
  98065. * Render all the sub meshes contained in the group.
  98066. * @param customRenderFunction Used to override the default render behaviour of the group.
  98067. * @returns true if rendered some submeshes.
  98068. */
  98069. render(customRenderFunction: Nullable<(opaqueSubMeshes: SmartArray<SubMesh>, transparentSubMeshes: SmartArray<SubMesh>, alphaTestSubMeshes: SmartArray<SubMesh>, depthOnlySubMeshes: SmartArray<SubMesh>) => void>, renderSprites: boolean, renderParticles: boolean, activeMeshes: Nullable<AbstractMesh[]>): void;
  98070. /**
  98071. * Renders the opaque submeshes in the order from the opaqueSortCompareFn.
  98072. * @param subMeshes The submeshes to render
  98073. */
  98074. private renderOpaqueSorted;
  98075. /**
  98076. * Renders the opaque submeshes in the order from the alphatestSortCompareFn.
  98077. * @param subMeshes The submeshes to render
  98078. */
  98079. private renderAlphaTestSorted;
  98080. /**
  98081. * Renders the opaque submeshes in the order from the transparentSortCompareFn.
  98082. * @param subMeshes The submeshes to render
  98083. */
  98084. private renderTransparentSorted;
  98085. /**
  98086. * Renders the submeshes in a specified order.
  98087. * @param subMeshes The submeshes to sort before render
  98088. * @param sortCompareFn The comparison function use to sort
  98089. * @param cameraPosition The camera position use to preprocess the submeshes to help sorting
  98090. * @param transparent Specifies to activate blending if true
  98091. */
  98092. private static renderSorted;
  98093. /**
  98094. * Renders the submeshes in the order they were dispatched (no sort applied).
  98095. * @param subMeshes The submeshes to render
  98096. */
  98097. private static renderUnsorted;
  98098. /**
  98099. * Build in function which can be applied to ensure meshes of a special queue (opaque, alpha test, transparent)
  98100. * are rendered back to front if in the same alpha index.
  98101. *
  98102. * @param a The first submesh
  98103. * @param b The second submesh
  98104. * @returns The result of the comparison
  98105. */
  98106. static defaultTransparentSortCompare(a: SubMesh, b: SubMesh): number;
  98107. /**
  98108. * Build in function which can be applied to ensure meshes of a special queue (opaque, alpha test, transparent)
  98109. * are rendered back to front.
  98110. *
  98111. * @param a The first submesh
  98112. * @param b The second submesh
  98113. * @returns The result of the comparison
  98114. */
  98115. static backToFrontSortCompare(a: SubMesh, b: SubMesh): number;
  98116. /**
  98117. * Build in function which can be applied to ensure meshes of a special queue (opaque, alpha test, transparent)
  98118. * are rendered front to back (prevent overdraw).
  98119. *
  98120. * @param a The first submesh
  98121. * @param b The second submesh
  98122. * @returns The result of the comparison
  98123. */
  98124. static frontToBackSortCompare(a: SubMesh, b: SubMesh): number;
  98125. /**
  98126. * Resets the different lists of submeshes to prepare a new frame.
  98127. */
  98128. prepare(): void;
  98129. dispose(): void;
  98130. /**
  98131. * Inserts the submesh in its correct queue depending on its material.
  98132. * @param subMesh The submesh to dispatch
  98133. * @param [mesh] Optional reference to the submeshes's mesh. Provide if you have an exiting reference to improve performance.
  98134. * @param [material] Optional reference to the submeshes's material. Provide if you have an exiting reference to improve performance.
  98135. */
  98136. dispatch(subMesh: SubMesh, mesh?: AbstractMesh, material?: Nullable<Material>): void;
  98137. dispatchSprites(spriteManager: ISpriteManager): void;
  98138. dispatchParticles(particleSystem: IParticleSystem): void;
  98139. private _renderParticles;
  98140. private _renderSprites;
  98141. }
  98142. }
  98143. declare module BABYLON {
  98144. /**
  98145. * Interface describing the different options available in the rendering manager
  98146. * regarding Auto Clear between groups.
  98147. */
  98148. export interface IRenderingManagerAutoClearSetup {
  98149. /**
  98150. * Defines whether or not autoclear is enable.
  98151. */
  98152. autoClear: boolean;
  98153. /**
  98154. * Defines whether or not to autoclear the depth buffer.
  98155. */
  98156. depth: boolean;
  98157. /**
  98158. * Defines whether or not to autoclear the stencil buffer.
  98159. */
  98160. stencil: boolean;
  98161. }
  98162. /**
  98163. * This class is used by the onRenderingGroupObservable
  98164. */
  98165. export class RenderingGroupInfo {
  98166. /**
  98167. * The Scene that being rendered
  98168. */
  98169. scene: Scene;
  98170. /**
  98171. * The camera currently used for the rendering pass
  98172. */
  98173. camera: Nullable<Camera>;
  98174. /**
  98175. * The ID of the renderingGroup being processed
  98176. */
  98177. renderingGroupId: number;
  98178. }
  98179. /**
  98180. * This is the manager responsible of all the rendering for meshes sprites and particles.
  98181. * It is enable to manage the different groups as well as the different necessary sort functions.
  98182. * This should not be used directly aside of the few static configurations
  98183. */
  98184. export class RenderingManager {
  98185. /**
  98186. * The max id used for rendering groups (not included)
  98187. */
  98188. static MAX_RENDERINGGROUPS: number;
  98189. /**
  98190. * The min id used for rendering groups (included)
  98191. */
  98192. static MIN_RENDERINGGROUPS: number;
  98193. /**
  98194. * Used to globally prevent autoclearing scenes.
  98195. */
  98196. static AUTOCLEAR: boolean;
  98197. /**
  98198. * @hidden
  98199. */
  98200. _useSceneAutoClearSetup: boolean;
  98201. private _scene;
  98202. private _renderingGroups;
  98203. private _depthStencilBufferAlreadyCleaned;
  98204. private _autoClearDepthStencil;
  98205. private _customOpaqueSortCompareFn;
  98206. private _customAlphaTestSortCompareFn;
  98207. private _customTransparentSortCompareFn;
  98208. private _renderingGroupInfo;
  98209. /**
  98210. * Instantiates a new rendering group for a particular scene
  98211. * @param scene Defines the scene the groups belongs to
  98212. */
  98213. constructor(scene: Scene);
  98214. private _clearDepthStencilBuffer;
  98215. /**
  98216. * Renders the entire managed groups. This is used by the scene or the different rennder targets.
  98217. * @hidden
  98218. */
  98219. render(customRenderFunction: Nullable<(opaqueSubMeshes: SmartArray<SubMesh>, transparentSubMeshes: SmartArray<SubMesh>, alphaTestSubMeshes: SmartArray<SubMesh>, depthOnlySubMeshes: SmartArray<SubMesh>) => void>, activeMeshes: Nullable<AbstractMesh[]>, renderParticles: boolean, renderSprites: boolean): void;
  98220. /**
  98221. * Resets the different information of the group to prepare a new frame
  98222. * @hidden
  98223. */
  98224. reset(): void;
  98225. /**
  98226. * Dispose and release the group and its associated resources.
  98227. * @hidden
  98228. */
  98229. dispose(): void;
  98230. /**
  98231. * Clear the info related to rendering groups preventing retention points during dispose.
  98232. */
  98233. freeRenderingGroups(): void;
  98234. private _prepareRenderingGroup;
  98235. /**
  98236. * Add a sprite manager to the rendering manager in order to render it this frame.
  98237. * @param spriteManager Define the sprite manager to render
  98238. */
  98239. dispatchSprites(spriteManager: ISpriteManager): void;
  98240. /**
  98241. * Add a particle system to the rendering manager in order to render it this frame.
  98242. * @param particleSystem Define the particle system to render
  98243. */
  98244. dispatchParticles(particleSystem: IParticleSystem): void;
  98245. /**
  98246. * Add a submesh to the manager in order to render it this frame
  98247. * @param subMesh The submesh to dispatch
  98248. * @param mesh Optional reference to the submeshes's mesh. Provide if you have an exiting reference to improve performance.
  98249. * @param material Optional reference to the submeshes's material. Provide if you have an exiting reference to improve performance.
  98250. */
  98251. dispatch(subMesh: SubMesh, mesh?: AbstractMesh, material?: Nullable<Material>): void;
  98252. /**
  98253. * Overrides the default sort function applied in the renderging group to prepare the meshes.
  98254. * This allowed control for front to back rendering or reversly depending of the special needs.
  98255. *
  98256. * @param renderingGroupId The rendering group id corresponding to its index
  98257. * @param opaqueSortCompareFn The opaque queue comparison function use to sort.
  98258. * @param alphaTestSortCompareFn The alpha test queue comparison function use to sort.
  98259. * @param transparentSortCompareFn The transparent queue comparison function use to sort.
  98260. */
  98261. 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;
  98262. /**
  98263. * Specifies whether or not the stencil and depth buffer are cleared between two rendering groups.
  98264. *
  98265. * @param renderingGroupId The rendering group id corresponding to its index
  98266. * @param autoClearDepthStencil Automatically clears depth and stencil between groups if true.
  98267. * @param depth Automatically clears depth between groups if true and autoClear is true.
  98268. * @param stencil Automatically clears stencil between groups if true and autoClear is true.
  98269. */
  98270. setRenderingAutoClearDepthStencil(renderingGroupId: number, autoClearDepthStencil: boolean, depth?: boolean, stencil?: boolean): void;
  98271. /**
  98272. * Gets the current auto clear configuration for one rendering group of the rendering
  98273. * manager.
  98274. * @param index the rendering group index to get the information for
  98275. * @returns The auto clear setup for the requested rendering group
  98276. */
  98277. getAutoClearDepthStencilSetup(index: number): IRenderingManagerAutoClearSetup;
  98278. }
  98279. }
  98280. declare module BABYLON {
  98281. /**
  98282. * Defines the options associated with the creation of a custom shader for a shadow generator.
  98283. */
  98284. export interface ICustomShaderOptions {
  98285. /**
  98286. * Gets or sets the custom shader name to use
  98287. */
  98288. shaderName: string;
  98289. /**
  98290. * The list of attribute names used in the shader
  98291. */
  98292. attributes?: string[];
  98293. /**
  98294. * The list of unifrom names used in the shader
  98295. */
  98296. uniforms?: string[];
  98297. /**
  98298. * The list of sampler names used in the shader
  98299. */
  98300. samplers?: string[];
  98301. /**
  98302. * The list of defines used in the shader
  98303. */
  98304. defines?: string[];
  98305. }
  98306. /**
  98307. * Interface to implement to create a shadow generator compatible with BJS.
  98308. */
  98309. export interface IShadowGenerator {
  98310. /** Gets or set the id of the shadow generator. It will be the one from the light if not defined */
  98311. id: string;
  98312. /**
  98313. * Gets the main RTT containing the shadow map (usually storing depth from the light point of view).
  98314. * @returns The render target texture if present otherwise, null
  98315. */
  98316. getShadowMap(): Nullable<RenderTargetTexture>;
  98317. /**
  98318. * Determine wheter the shadow generator is ready or not (mainly all effects and related post processes needs to be ready).
  98319. * @param subMesh The submesh we want to render in the shadow map
  98320. * @param useInstances Defines wether will draw in the map using instances
  98321. * @param isTransparent Indicates that isReady is called for a transparent subMesh
  98322. * @returns true if ready otherwise, false
  98323. */
  98324. isReady(subMesh: SubMesh, useInstances: boolean, isTransparent: boolean): boolean;
  98325. /**
  98326. * Prepare all the defines in a material relying on a shadow map at the specified light index.
  98327. * @param defines Defines of the material we want to update
  98328. * @param lightIndex Index of the light in the enabled light list of the material
  98329. */
  98330. prepareDefines(defines: MaterialDefines, lightIndex: number): void;
  98331. /**
  98332. * Binds the shadow related information inside of an effect (information like near, far, darkness...
  98333. * defined in the generator but impacting the effect).
  98334. * It implies the unifroms available on the materials are the standard BJS ones.
  98335. * @param lightIndex Index of the light in the enabled light list of the material owning the effect
  98336. * @param effect The effect we are binfing the information for
  98337. */
  98338. bindShadowLight(lightIndex: string, effect: Effect): void;
  98339. /**
  98340. * Gets the transformation matrix used to project the meshes into the map from the light point of view.
  98341. * (eq to shadow prjection matrix * light transform matrix)
  98342. * @returns The transform matrix used to create the shadow map
  98343. */
  98344. getTransformMatrix(): Matrix;
  98345. /**
  98346. * Recreates the shadow map dependencies like RTT and post processes. This can be used during the switch between
  98347. * Cube and 2D textures for instance.
  98348. */
  98349. recreateShadowMap(): void;
  98350. /**
  98351. * Forces all the attached effect to compile to enable rendering only once ready vs. lazyly compiling effects.
  98352. * @param onCompiled Callback triggered at the and of the effects compilation
  98353. * @param options Sets of optional options forcing the compilation with different modes
  98354. */
  98355. forceCompilation(onCompiled?: (generator: IShadowGenerator) => void, options?: Partial<{
  98356. useInstances: boolean;
  98357. }>): void;
  98358. /**
  98359. * Forces all the attached effect to compile to enable rendering only once ready vs. lazyly compiling effects.
  98360. * @param options Sets of optional options forcing the compilation with different modes
  98361. * @returns A promise that resolves when the compilation completes
  98362. */
  98363. forceCompilationAsync(options?: Partial<{
  98364. useInstances: boolean;
  98365. }>): Promise<void>;
  98366. /**
  98367. * Serializes the shadow generator setup to a json object.
  98368. * @returns The serialized JSON object
  98369. */
  98370. serialize(): any;
  98371. /**
  98372. * Disposes the Shadow map and related Textures and effects.
  98373. */
  98374. dispose(): void;
  98375. }
  98376. /**
  98377. * Default implementation IShadowGenerator.
  98378. * This is the main object responsible of generating shadows in the framework.
  98379. * Documentation: https://doc.babylonjs.com/babylon101/shadows
  98380. */
  98381. export class ShadowGenerator implements IShadowGenerator {
  98382. /**
  98383. * Name of the shadow generator class
  98384. */
  98385. static CLASSNAME: string;
  98386. /**
  98387. * Shadow generator mode None: no filtering applied.
  98388. */
  98389. static readonly FILTER_NONE: number;
  98390. /**
  98391. * Shadow generator mode ESM: Exponential Shadow Mapping.
  98392. * (http://developer.download.nvidia.com/presentations/2008/GDC/GDC08_SoftShadowMapping.pdf)
  98393. */
  98394. static readonly FILTER_EXPONENTIALSHADOWMAP: number;
  98395. /**
  98396. * Shadow generator mode Poisson Sampling: Percentage Closer Filtering.
  98397. * (Multiple Tap around evenly distributed around the pixel are used to evaluate the shadow strength)
  98398. */
  98399. static readonly FILTER_POISSONSAMPLING: number;
  98400. /**
  98401. * Shadow generator mode ESM: Blurred Exponential Shadow Mapping.
  98402. * (http://developer.download.nvidia.com/presentations/2008/GDC/GDC08_SoftShadowMapping.pdf)
  98403. */
  98404. static readonly FILTER_BLUREXPONENTIALSHADOWMAP: number;
  98405. /**
  98406. * Shadow generator mode ESM: Exponential Shadow Mapping using the inverse of the exponential preventing
  98407. * edge artifacts on steep falloff.
  98408. * (http://developer.download.nvidia.com/presentations/2008/GDC/GDC08_SoftShadowMapping.pdf)
  98409. */
  98410. static readonly FILTER_CLOSEEXPONENTIALSHADOWMAP: number;
  98411. /**
  98412. * Shadow generator mode ESM: Blurred Exponential Shadow Mapping using the inverse of the exponential preventing
  98413. * edge artifacts on steep falloff.
  98414. * (http://developer.download.nvidia.com/presentations/2008/GDC/GDC08_SoftShadowMapping.pdf)
  98415. */
  98416. static readonly FILTER_BLURCLOSEEXPONENTIALSHADOWMAP: number;
  98417. /**
  98418. * Shadow generator mode PCF: Percentage Closer Filtering
  98419. * benefits from Webgl 2 shadow samplers. Fallback to Poisson Sampling in Webgl 1
  98420. * (https://developer.nvidia.com/gpugems/GPUGems/gpugems_ch11.html)
  98421. */
  98422. static readonly FILTER_PCF: number;
  98423. /**
  98424. * Shadow generator mode PCSS: Percentage Closering Soft Shadow.
  98425. * benefits from Webgl 2 shadow samplers. Fallback to Poisson Sampling in Webgl 1
  98426. * Contact Hardening
  98427. */
  98428. static readonly FILTER_PCSS: number;
  98429. /**
  98430. * Reserved for PCF and PCSS
  98431. * Highest Quality.
  98432. *
  98433. * Execute PCF on a 5*5 kernel improving a lot the shadow aliasing artifacts.
  98434. *
  98435. * Execute PCSS with 32 taps blocker search and 64 taps PCF.
  98436. */
  98437. static readonly QUALITY_HIGH: number;
  98438. /**
  98439. * Reserved for PCF and PCSS
  98440. * Good tradeoff for quality/perf cross devices
  98441. *
  98442. * Execute PCF on a 3*3 kernel.
  98443. *
  98444. * Execute PCSS with 16 taps blocker search and 32 taps PCF.
  98445. */
  98446. static readonly QUALITY_MEDIUM: number;
  98447. /**
  98448. * Reserved for PCF and PCSS
  98449. * The lowest quality but the fastest.
  98450. *
  98451. * Execute PCF on a 1*1 kernel.
  98452. *
  98453. * Execute PCSS with 16 taps blocker search and 16 taps PCF.
  98454. */
  98455. static readonly QUALITY_LOW: number;
  98456. /** Gets or set the id of the shadow generator. It will be the one from the light if not defined */
  98457. id: string;
  98458. /** Gets or sets the custom shader name to use */
  98459. customShaderOptions: ICustomShaderOptions;
  98460. /**
  98461. * Observable triggered before the shadow is rendered. Can be used to update internal effect state
  98462. */
  98463. onBeforeShadowMapRenderObservable: Observable<Effect>;
  98464. /**
  98465. * Observable triggered after the shadow is rendered. Can be used to restore internal effect state
  98466. */
  98467. onAfterShadowMapRenderObservable: Observable<Effect>;
  98468. /**
  98469. * Observable triggered before a mesh is rendered in the shadow map.
  98470. * Can be used to update internal effect state (that you can get from the onBeforeShadowMapRenderObservable)
  98471. */
  98472. onBeforeShadowMapRenderMeshObservable: Observable<Mesh>;
  98473. /**
  98474. * Observable triggered after a mesh is rendered in the shadow map.
  98475. * Can be used to update internal effect state (that you can get from the onAfterShadowMapRenderObservable)
  98476. */
  98477. onAfterShadowMapRenderMeshObservable: Observable<Mesh>;
  98478. protected _bias: number;
  98479. /**
  98480. * Gets the bias: offset applied on the depth preventing acnea (in light direction).
  98481. */
  98482. get bias(): number;
  98483. /**
  98484. * Sets the bias: offset applied on the depth preventing acnea (in light direction).
  98485. */
  98486. set bias(bias: number);
  98487. protected _normalBias: number;
  98488. /**
  98489. * Gets the normalBias: offset applied on the depth preventing acnea (along side the normal direction and proportinal to the light/normal angle).
  98490. */
  98491. get normalBias(): number;
  98492. /**
  98493. * Sets the normalBias: offset applied on the depth preventing acnea (along side the normal direction and proportinal to the light/normal angle).
  98494. */
  98495. set normalBias(normalBias: number);
  98496. protected _blurBoxOffset: number;
  98497. /**
  98498. * Gets the blur box offset: offset applied during the blur pass.
  98499. * Only useful if useKernelBlur = false
  98500. */
  98501. get blurBoxOffset(): number;
  98502. /**
  98503. * Sets the blur box offset: offset applied during the blur pass.
  98504. * Only useful if useKernelBlur = false
  98505. */
  98506. set blurBoxOffset(value: number);
  98507. protected _blurScale: number;
  98508. /**
  98509. * Gets the blur scale: scale of the blurred texture compared to the main shadow map.
  98510. * 2 means half of the size.
  98511. */
  98512. get blurScale(): number;
  98513. /**
  98514. * Sets the blur scale: scale of the blurred texture compared to the main shadow map.
  98515. * 2 means half of the size.
  98516. */
  98517. set blurScale(value: number);
  98518. protected _blurKernel: number;
  98519. /**
  98520. * Gets the blur kernel: kernel size of the blur pass.
  98521. * Only useful if useKernelBlur = true
  98522. */
  98523. get blurKernel(): number;
  98524. /**
  98525. * Sets the blur kernel: kernel size of the blur pass.
  98526. * Only useful if useKernelBlur = true
  98527. */
  98528. set blurKernel(value: number);
  98529. protected _useKernelBlur: boolean;
  98530. /**
  98531. * Gets whether the blur pass is a kernel blur (if true) or box blur.
  98532. * Only useful in filtered mode (useBlurExponentialShadowMap...)
  98533. */
  98534. get useKernelBlur(): boolean;
  98535. /**
  98536. * Sets whether the blur pass is a kernel blur (if true) or box blur.
  98537. * Only useful in filtered mode (useBlurExponentialShadowMap...)
  98538. */
  98539. set useKernelBlur(value: boolean);
  98540. protected _depthScale: number;
  98541. /**
  98542. * Gets the depth scale used in ESM mode.
  98543. */
  98544. get depthScale(): number;
  98545. /**
  98546. * Sets the depth scale used in ESM mode.
  98547. * This can override the scale stored on the light.
  98548. */
  98549. set depthScale(value: number);
  98550. protected _validateFilter(filter: number): number;
  98551. protected _filter: number;
  98552. /**
  98553. * Gets the current mode of the shadow generator (normal, PCF, ESM...).
  98554. * The returned value is a number equal to one of the available mode defined in ShadowMap.FILTER_x like _FILTER_NONE
  98555. */
  98556. get filter(): number;
  98557. /**
  98558. * Sets the current mode of the shadow generator (normal, PCF, ESM...).
  98559. * The returned value is a number equal to one of the available mode defined in ShadowMap.FILTER_x like _FILTER_NONE
  98560. */
  98561. set filter(value: number);
  98562. /**
  98563. * Gets if the current filter is set to Poisson Sampling.
  98564. */
  98565. get usePoissonSampling(): boolean;
  98566. /**
  98567. * Sets the current filter to Poisson Sampling.
  98568. */
  98569. set usePoissonSampling(value: boolean);
  98570. /**
  98571. * Gets if the current filter is set to ESM.
  98572. */
  98573. get useExponentialShadowMap(): boolean;
  98574. /**
  98575. * Sets the current filter is to ESM.
  98576. */
  98577. set useExponentialShadowMap(value: boolean);
  98578. /**
  98579. * Gets if the current filter is set to filtered ESM.
  98580. */
  98581. get useBlurExponentialShadowMap(): boolean;
  98582. /**
  98583. * Gets if the current filter is set to filtered ESM.
  98584. */
  98585. set useBlurExponentialShadowMap(value: boolean);
  98586. /**
  98587. * Gets if the current filter is set to "close ESM" (using the inverse of the
  98588. * exponential to prevent steep falloff artifacts).
  98589. */
  98590. get useCloseExponentialShadowMap(): boolean;
  98591. /**
  98592. * Sets the current filter to "close ESM" (using the inverse of the
  98593. * exponential to prevent steep falloff artifacts).
  98594. */
  98595. set useCloseExponentialShadowMap(value: boolean);
  98596. /**
  98597. * Gets if the current filter is set to filtered "close ESM" (using the inverse of the
  98598. * exponential to prevent steep falloff artifacts).
  98599. */
  98600. get useBlurCloseExponentialShadowMap(): boolean;
  98601. /**
  98602. * Sets the current filter to filtered "close ESM" (using the inverse of the
  98603. * exponential to prevent steep falloff artifacts).
  98604. */
  98605. set useBlurCloseExponentialShadowMap(value: boolean);
  98606. /**
  98607. * Gets if the current filter is set to "PCF" (percentage closer filtering).
  98608. */
  98609. get usePercentageCloserFiltering(): boolean;
  98610. /**
  98611. * Sets the current filter to "PCF" (percentage closer filtering).
  98612. */
  98613. set usePercentageCloserFiltering(value: boolean);
  98614. protected _filteringQuality: number;
  98615. /**
  98616. * Gets the PCF or PCSS Quality.
  98617. * Only valid if usePercentageCloserFiltering or usePercentageCloserFiltering is true.
  98618. */
  98619. get filteringQuality(): number;
  98620. /**
  98621. * Sets the PCF or PCSS Quality.
  98622. * Only valid if usePercentageCloserFiltering or usePercentageCloserFiltering is true.
  98623. */
  98624. set filteringQuality(filteringQuality: number);
  98625. /**
  98626. * Gets if the current filter is set to "PCSS" (contact hardening).
  98627. */
  98628. get useContactHardeningShadow(): boolean;
  98629. /**
  98630. * Sets the current filter to "PCSS" (contact hardening).
  98631. */
  98632. set useContactHardeningShadow(value: boolean);
  98633. protected _contactHardeningLightSizeUVRatio: number;
  98634. /**
  98635. * Gets the Light Size (in shadow map uv unit) used in PCSS to determine the blocker search area and the penumbra size.
  98636. * Using a ratio helps keeping shape stability independently of the map size.
  98637. *
  98638. * It does not account for the light projection as it was having too much
  98639. * instability during the light setup or during light position changes.
  98640. *
  98641. * Only valid if useContactHardeningShadow is true.
  98642. */
  98643. get contactHardeningLightSizeUVRatio(): number;
  98644. /**
  98645. * Sets the Light Size (in shadow map uv unit) used in PCSS to determine the blocker search area and the penumbra size.
  98646. * Using a ratio helps keeping shape stability independently of the map size.
  98647. *
  98648. * It does not account for the light projection as it was having too much
  98649. * instability during the light setup or during light position changes.
  98650. *
  98651. * Only valid if useContactHardeningShadow is true.
  98652. */
  98653. set contactHardeningLightSizeUVRatio(contactHardeningLightSizeUVRatio: number);
  98654. protected _darkness: number;
  98655. /** Gets or sets the actual darkness of a shadow */
  98656. get darkness(): number;
  98657. set darkness(value: number);
  98658. /**
  98659. * Returns the darkness value (float). This can only decrease the actual darkness of a shadow.
  98660. * 0 means strongest and 1 would means no shadow.
  98661. * @returns the darkness.
  98662. */
  98663. getDarkness(): number;
  98664. /**
  98665. * Sets the darkness value (float). This can only decrease the actual darkness of a shadow.
  98666. * @param darkness The darkness value 0 means strongest and 1 would means no shadow.
  98667. * @returns the shadow generator allowing fluent coding.
  98668. */
  98669. setDarkness(darkness: number): ShadowGenerator;
  98670. protected _transparencyShadow: boolean;
  98671. /** Gets or sets the ability to have transparent shadow */
  98672. get transparencyShadow(): boolean;
  98673. set transparencyShadow(value: boolean);
  98674. /**
  98675. * Sets the ability to have transparent shadow (boolean).
  98676. * @param transparent True if transparent else False
  98677. * @returns the shadow generator allowing fluent coding
  98678. */
  98679. setTransparencyShadow(transparent: boolean): ShadowGenerator;
  98680. /**
  98681. * Enables or disables shadows with varying strength based on the transparency
  98682. * When it is enabled, the strength of the shadow is taken equal to mesh.visibility
  98683. * If you enabled an alpha texture on your material, the alpha value red from the texture is also combined to compute the strength:
  98684. * mesh.visibility * alphaTexture.a
  98685. * Note that by definition transparencyShadow must be set to true for enableSoftTransparentShadow to work!
  98686. */
  98687. enableSoftTransparentShadow: boolean;
  98688. protected _shadowMap: Nullable<RenderTargetTexture>;
  98689. protected _shadowMap2: Nullable<RenderTargetTexture>;
  98690. /**
  98691. * Gets the main RTT containing the shadow map (usually storing depth from the light point of view).
  98692. * @returns The render target texture if present otherwise, null
  98693. */
  98694. getShadowMap(): Nullable<RenderTargetTexture>;
  98695. /**
  98696. * Gets the RTT used during rendering (can be a blurred version of the shadow map or the shadow map itself).
  98697. * @returns The render target texture if the shadow map is present otherwise, null
  98698. */
  98699. getShadowMapForRendering(): Nullable<RenderTargetTexture>;
  98700. /**
  98701. * Gets the class name of that object
  98702. * @returns "ShadowGenerator"
  98703. */
  98704. getClassName(): string;
  98705. /**
  98706. * Helper function to add a mesh and its descendants to the list of shadow casters.
  98707. * @param mesh Mesh to add
  98708. * @param includeDescendants boolean indicating if the descendants should be added. Default to true
  98709. * @returns the Shadow Generator itself
  98710. */
  98711. addShadowCaster(mesh: AbstractMesh, includeDescendants?: boolean): ShadowGenerator;
  98712. /**
  98713. * Helper function to remove a mesh and its descendants from the list of shadow casters
  98714. * @param mesh Mesh to remove
  98715. * @param includeDescendants boolean indicating if the descendants should be removed. Default to true
  98716. * @returns the Shadow Generator itself
  98717. */
  98718. removeShadowCaster(mesh: AbstractMesh, includeDescendants?: boolean): ShadowGenerator;
  98719. /**
  98720. * Controls the extent to which the shadows fade out at the edge of the frustum
  98721. */
  98722. frustumEdgeFalloff: number;
  98723. protected _light: IShadowLight;
  98724. /**
  98725. * Returns the associated light object.
  98726. * @returns the light generating the shadow
  98727. */
  98728. getLight(): IShadowLight;
  98729. /**
  98730. * If true the shadow map is generated by rendering the back face of the mesh instead of the front face.
  98731. * This can help with self-shadowing as the geometry making up the back of objects is slightly offset.
  98732. * It might on the other hand introduce peter panning.
  98733. */
  98734. forceBackFacesOnly: boolean;
  98735. protected _scene: Scene;
  98736. protected _lightDirection: Vector3;
  98737. protected _effect: Effect;
  98738. protected _viewMatrix: Matrix;
  98739. protected _projectionMatrix: Matrix;
  98740. protected _transformMatrix: Matrix;
  98741. protected _cachedPosition: Vector3;
  98742. protected _cachedDirection: Vector3;
  98743. protected _cachedDefines: string;
  98744. protected _currentRenderID: number;
  98745. protected _boxBlurPostprocess: Nullable<PostProcess>;
  98746. protected _kernelBlurXPostprocess: Nullable<PostProcess>;
  98747. protected _kernelBlurYPostprocess: Nullable<PostProcess>;
  98748. protected _blurPostProcesses: PostProcess[];
  98749. protected _mapSize: number;
  98750. protected _currentFaceIndex: number;
  98751. protected _currentFaceIndexCache: number;
  98752. protected _textureType: number;
  98753. protected _defaultTextureMatrix: Matrix;
  98754. protected _storedUniqueId: Nullable<number>;
  98755. /** @hidden */
  98756. static _SceneComponentInitialization: (scene: Scene) => void;
  98757. /**
  98758. * Gets or sets the size of the texture what stores the shadows
  98759. */
  98760. get mapSize(): number;
  98761. set mapSize(size: number);
  98762. /**
  98763. * Creates a ShadowGenerator object.
  98764. * A ShadowGenerator is the required tool to use the shadows.
  98765. * Each light casting shadows needs to use its own ShadowGenerator.
  98766. * Documentation : https://doc.babylonjs.com/babylon101/shadows
  98767. * @param mapSize The size of the texture what stores the shadows. Example : 1024.
  98768. * @param light The light object generating the shadows.
  98769. * @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.
  98770. */
  98771. constructor(mapSize: number, light: IShadowLight, usefulFloatFirst?: boolean);
  98772. protected _initializeGenerator(): void;
  98773. protected _createTargetRenderTexture(): void;
  98774. protected _initializeShadowMap(): void;
  98775. protected _initializeBlurRTTAndPostProcesses(): void;
  98776. protected _renderForShadowMap(opaqueSubMeshes: SmartArray<SubMesh>, alphaTestSubMeshes: SmartArray<SubMesh>, transparentSubMeshes: SmartArray<SubMesh>, depthOnlySubMeshes: SmartArray<SubMesh>): void;
  98777. protected _bindCustomEffectForRenderSubMeshForShadowMap(subMesh: SubMesh, effect: Effect, matriceNames: any, mesh: AbstractMesh): void;
  98778. protected _renderSubMeshForShadowMap(subMesh: SubMesh, isTransparent?: boolean): void;
  98779. protected _applyFilterValues(): void;
  98780. /**
  98781. * Forces all the attached effect to compile to enable rendering only once ready vs. lazyly compiling effects.
  98782. * @param onCompiled Callback triggered at the and of the effects compilation
  98783. * @param options Sets of optional options forcing the compilation with different modes
  98784. */
  98785. forceCompilation(onCompiled?: (generator: IShadowGenerator) => void, options?: Partial<{
  98786. useInstances: boolean;
  98787. }>): void;
  98788. /**
  98789. * Forces all the attached effect to compile to enable rendering only once ready vs. lazyly compiling effects.
  98790. * @param options Sets of optional options forcing the compilation with different modes
  98791. * @returns A promise that resolves when the compilation completes
  98792. */
  98793. forceCompilationAsync(options?: Partial<{
  98794. useInstances: boolean;
  98795. }>): Promise<void>;
  98796. protected _isReadyCustomDefines(defines: any, subMesh: SubMesh, useInstances: boolean): void;
  98797. private _prepareShadowDefines;
  98798. /**
  98799. * Determine wheter the shadow generator is ready or not (mainly all effects and related post processes needs to be ready).
  98800. * @param subMesh The submesh we want to render in the shadow map
  98801. * @param useInstances Defines wether will draw in the map using instances
  98802. * @param isTransparent Indicates that isReady is called for a transparent subMesh
  98803. * @returns true if ready otherwise, false
  98804. */
  98805. isReady(subMesh: SubMesh, useInstances: boolean, isTransparent: boolean): boolean;
  98806. /**
  98807. * Prepare all the defines in a material relying on a shadow map at the specified light index.
  98808. * @param defines Defines of the material we want to update
  98809. * @param lightIndex Index of the light in the enabled light list of the material
  98810. */
  98811. prepareDefines(defines: any, lightIndex: number): void;
  98812. /**
  98813. * Binds the shadow related information inside of an effect (information like near, far, darkness...
  98814. * defined in the generator but impacting the effect).
  98815. * @param lightIndex Index of the light in the enabled light list of the material owning the effect
  98816. * @param effect The effect we are binfing the information for
  98817. */
  98818. bindShadowLight(lightIndex: string, effect: Effect): void;
  98819. /**
  98820. * Gets the transformation matrix used to project the meshes into the map from the light point of view.
  98821. * (eq to shadow prjection matrix * light transform matrix)
  98822. * @returns The transform matrix used to create the shadow map
  98823. */
  98824. getTransformMatrix(): Matrix;
  98825. /**
  98826. * Recreates the shadow map dependencies like RTT and post processes. This can be used during the switch between
  98827. * Cube and 2D textures for instance.
  98828. */
  98829. recreateShadowMap(): void;
  98830. protected _disposeBlurPostProcesses(): void;
  98831. protected _disposeRTTandPostProcesses(): void;
  98832. /**
  98833. * Disposes the ShadowGenerator.
  98834. * Returns nothing.
  98835. */
  98836. dispose(): void;
  98837. /**
  98838. * Serializes the shadow generator setup to a json object.
  98839. * @returns The serialized JSON object
  98840. */
  98841. serialize(): any;
  98842. /**
  98843. * Parses a serialized ShadowGenerator and returns a new ShadowGenerator.
  98844. * @param parsedShadowGenerator The JSON object to parse
  98845. * @param scene The scene to create the shadow map for
  98846. * @param constr A function that builds a shadow generator or undefined to create an instance of the default shadow generator
  98847. * @returns The parsed shadow generator
  98848. */
  98849. static Parse(parsedShadowGenerator: any, scene: Scene, constr?: (mapSize: number, light: IShadowLight) => ShadowGenerator): ShadowGenerator;
  98850. }
  98851. }
  98852. declare module BABYLON {
  98853. /**
  98854. * Base class of all the lights in Babylon. It groups all the generic information about lights.
  98855. * Lights are used, as you would expect, to affect how meshes are seen, in terms of both illumination and colour.
  98856. * 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.
  98857. */
  98858. export abstract class Light extends Node {
  98859. /**
  98860. * Falloff Default: light is falling off following the material specification:
  98861. * standard material is using standard falloff whereas pbr material can request special falloff per materials.
  98862. */
  98863. static readonly FALLOFF_DEFAULT: number;
  98864. /**
  98865. * Falloff Physical: light is falling off following the inverse squared distance law.
  98866. */
  98867. static readonly FALLOFF_PHYSICAL: number;
  98868. /**
  98869. * Falloff gltf: light is falling off as described in the gltf moving to PBR document
  98870. * to enhance interoperability with other engines.
  98871. */
  98872. static readonly FALLOFF_GLTF: number;
  98873. /**
  98874. * Falloff Standard: light is falling off like in the standard material
  98875. * to enhance interoperability with other materials.
  98876. */
  98877. static readonly FALLOFF_STANDARD: number;
  98878. /**
  98879. * If every light affecting the material is in this lightmapMode,
  98880. * material.lightmapTexture adds or multiplies
  98881. * (depends on material.useLightmapAsShadowmap)
  98882. * after every other light calculations.
  98883. */
  98884. static readonly LIGHTMAP_DEFAULT: number;
  98885. /**
  98886. * material.lightmapTexture as only diffuse lighting from this light
  98887. * adds only specular lighting from this light
  98888. * adds dynamic shadows
  98889. */
  98890. static readonly LIGHTMAP_SPECULAR: number;
  98891. /**
  98892. * material.lightmapTexture as only lighting
  98893. * no light calculation from this light
  98894. * only adds dynamic shadows from this light
  98895. */
  98896. static readonly LIGHTMAP_SHADOWSONLY: number;
  98897. /**
  98898. * Each light type uses the default quantity according to its type:
  98899. * point/spot lights use luminous intensity
  98900. * directional lights use illuminance
  98901. */
  98902. static readonly INTENSITYMODE_AUTOMATIC: number;
  98903. /**
  98904. * lumen (lm)
  98905. */
  98906. static readonly INTENSITYMODE_LUMINOUSPOWER: number;
  98907. /**
  98908. * candela (lm/sr)
  98909. */
  98910. static readonly INTENSITYMODE_LUMINOUSINTENSITY: number;
  98911. /**
  98912. * lux (lm/m^2)
  98913. */
  98914. static readonly INTENSITYMODE_ILLUMINANCE: number;
  98915. /**
  98916. * nit (cd/m^2)
  98917. */
  98918. static readonly INTENSITYMODE_LUMINANCE: number;
  98919. /**
  98920. * Light type const id of the point light.
  98921. */
  98922. static readonly LIGHTTYPEID_POINTLIGHT: number;
  98923. /**
  98924. * Light type const id of the directional light.
  98925. */
  98926. static readonly LIGHTTYPEID_DIRECTIONALLIGHT: number;
  98927. /**
  98928. * Light type const id of the spot light.
  98929. */
  98930. static readonly LIGHTTYPEID_SPOTLIGHT: number;
  98931. /**
  98932. * Light type const id of the hemispheric light.
  98933. */
  98934. static readonly LIGHTTYPEID_HEMISPHERICLIGHT: number;
  98935. /**
  98936. * Diffuse gives the basic color to an object.
  98937. */
  98938. diffuse: Color3;
  98939. /**
  98940. * Specular produces a highlight color on an object.
  98941. * Note: This is note affecting PBR materials.
  98942. */
  98943. specular: Color3;
  98944. /**
  98945. * Defines the falloff type for this light. This lets overrriding how punctual light are
  98946. * falling off base on range or angle.
  98947. * This can be set to any values in Light.FALLOFF_x.
  98948. *
  98949. * Note: This is only useful for PBR Materials at the moment. This could be extended if required to
  98950. * other types of materials.
  98951. */
  98952. falloffType: number;
  98953. /**
  98954. * Strength of the light.
  98955. * Note: By default it is define in the framework own unit.
  98956. * Note: In PBR materials the intensityMode can be use to chose what unit the intensity is defined in.
  98957. */
  98958. intensity: number;
  98959. private _range;
  98960. protected _inverseSquaredRange: number;
  98961. /**
  98962. * Defines how far from the source the light is impacting in scene units.
  98963. * Note: Unused in PBR material as the distance light falloff is defined following the inverse squared falloff.
  98964. */
  98965. get range(): number;
  98966. /**
  98967. * Defines how far from the source the light is impacting in scene units.
  98968. * Note: Unused in PBR material as the distance light falloff is defined following the inverse squared falloff.
  98969. */
  98970. set range(value: number);
  98971. /**
  98972. * Cached photometric scale default to 1.0 as the automatic intensity mode defaults to 1.0 for every type
  98973. * of light.
  98974. */
  98975. private _photometricScale;
  98976. private _intensityMode;
  98977. /**
  98978. * Gets the photometric scale used to interpret the intensity.
  98979. * This is only relevant with PBR Materials where the light intensity can be defined in a physical way.
  98980. */
  98981. get intensityMode(): number;
  98982. /**
  98983. * Sets the photometric scale used to interpret the intensity.
  98984. * This is only relevant with PBR Materials where the light intensity can be defined in a physical way.
  98985. */
  98986. set intensityMode(value: number);
  98987. private _radius;
  98988. /**
  98989. * Gets the light radius used by PBR Materials to simulate soft area lights.
  98990. */
  98991. get radius(): number;
  98992. /**
  98993. * sets the light radius used by PBR Materials to simulate soft area lights.
  98994. */
  98995. set radius(value: number);
  98996. private _renderPriority;
  98997. /**
  98998. * Defines the rendering priority of the lights. It can help in case of fallback or number of lights
  98999. * exceeding the number allowed of the materials.
  99000. */
  99001. renderPriority: number;
  99002. private _shadowEnabled;
  99003. /**
  99004. * Gets wether or not the shadows are enabled for this light. This can help turning off/on shadow without detaching
  99005. * the current shadow generator.
  99006. */
  99007. get shadowEnabled(): boolean;
  99008. /**
  99009. * Sets wether or not the shadows are enabled for this light. This can help turning off/on shadow without detaching
  99010. * the current shadow generator.
  99011. */
  99012. set shadowEnabled(value: boolean);
  99013. private _includedOnlyMeshes;
  99014. /**
  99015. * Gets the only meshes impacted by this light.
  99016. */
  99017. get includedOnlyMeshes(): AbstractMesh[];
  99018. /**
  99019. * Sets the only meshes impacted by this light.
  99020. */
  99021. set includedOnlyMeshes(value: AbstractMesh[]);
  99022. private _excludedMeshes;
  99023. /**
  99024. * Gets the meshes not impacted by this light.
  99025. */
  99026. get excludedMeshes(): AbstractMesh[];
  99027. /**
  99028. * Sets the meshes not impacted by this light.
  99029. */
  99030. set excludedMeshes(value: AbstractMesh[]);
  99031. private _excludeWithLayerMask;
  99032. /**
  99033. * Gets the layer id use to find what meshes are not impacted by the light.
  99034. * Inactive if 0
  99035. */
  99036. get excludeWithLayerMask(): number;
  99037. /**
  99038. * Sets the layer id use to find what meshes are not impacted by the light.
  99039. * Inactive if 0
  99040. */
  99041. set excludeWithLayerMask(value: number);
  99042. private _includeOnlyWithLayerMask;
  99043. /**
  99044. * Gets the layer id use to find what meshes are impacted by the light.
  99045. * Inactive if 0
  99046. */
  99047. get includeOnlyWithLayerMask(): number;
  99048. /**
  99049. * Sets the layer id use to find what meshes are impacted by the light.
  99050. * Inactive if 0
  99051. */
  99052. set includeOnlyWithLayerMask(value: number);
  99053. private _lightmapMode;
  99054. /**
  99055. * Gets the lightmap mode of this light (should be one of the constants defined by Light.LIGHTMAP_x)
  99056. */
  99057. get lightmapMode(): number;
  99058. /**
  99059. * Sets the lightmap mode of this light (should be one of the constants defined by Light.LIGHTMAP_x)
  99060. */
  99061. set lightmapMode(value: number);
  99062. /**
  99063. * Shadow generator associted to the light.
  99064. * @hidden Internal use only.
  99065. */
  99066. _shadowGenerator: Nullable<IShadowGenerator>;
  99067. /**
  99068. * @hidden Internal use only.
  99069. */
  99070. _excludedMeshesIds: string[];
  99071. /**
  99072. * @hidden Internal use only.
  99073. */
  99074. _includedOnlyMeshesIds: string[];
  99075. /**
  99076. * The current light unifom buffer.
  99077. * @hidden Internal use only.
  99078. */
  99079. _uniformBuffer: UniformBuffer;
  99080. /** @hidden */
  99081. _renderId: number;
  99082. /**
  99083. * Creates a Light object in the scene.
  99084. * Documentation : https://doc.babylonjs.com/babylon101/lights
  99085. * @param name The firendly name of the light
  99086. * @param scene The scene the light belongs too
  99087. */
  99088. constructor(name: string, scene: Scene);
  99089. protected abstract _buildUniformLayout(): void;
  99090. /**
  99091. * Sets the passed Effect "effect" with the Light information.
  99092. * @param effect The effect to update
  99093. * @param lightIndex The index of the light in the effect to update
  99094. * @returns The light
  99095. */
  99096. abstract transferToEffect(effect: Effect, lightIndex: string): Light;
  99097. /**
  99098. * Sets the passed Effect "effect" with the Light textures.
  99099. * @param effect The effect to update
  99100. * @param lightIndex The index of the light in the effect to update
  99101. * @returns The light
  99102. */
  99103. transferTexturesToEffect(effect: Effect, lightIndex: string): Light;
  99104. /**
  99105. * Binds the lights information from the scene to the effect for the given mesh.
  99106. * @param lightIndex Light index
  99107. * @param scene The scene where the light belongs to
  99108. * @param effect The effect we are binding the data to
  99109. * @param useSpecular Defines if specular is supported
  99110. * @param rebuildInParallel Specifies whether the shader is rebuilding in parallel
  99111. */
  99112. _bindLight(lightIndex: number, scene: Scene, effect: Effect, useSpecular: boolean, rebuildInParallel?: boolean): void;
  99113. /**
  99114. * Sets the passed Effect "effect" with the Light information.
  99115. * @param effect The effect to update
  99116. * @param lightDataUniformName The uniform used to store light data (position or direction)
  99117. * @returns The light
  99118. */
  99119. abstract transferToNodeMaterialEffect(effect: Effect, lightDataUniformName: string): Light;
  99120. /**
  99121. * Returns the string "Light".
  99122. * @returns the class name
  99123. */
  99124. getClassName(): string;
  99125. /** @hidden */
  99126. readonly _isLight: boolean;
  99127. /**
  99128. * Converts the light information to a readable string for debug purpose.
  99129. * @param fullDetails Supports for multiple levels of logging within scene loading
  99130. * @returns the human readable light info
  99131. */
  99132. toString(fullDetails?: boolean): string;
  99133. /** @hidden */
  99134. protected _syncParentEnabledState(): void;
  99135. /**
  99136. * Set the enabled state of this node.
  99137. * @param value - the new enabled state
  99138. */
  99139. setEnabled(value: boolean): void;
  99140. /**
  99141. * Returns the Light associated shadow generator if any.
  99142. * @return the associated shadow generator.
  99143. */
  99144. getShadowGenerator(): Nullable<IShadowGenerator>;
  99145. /**
  99146. * Returns a Vector3, the absolute light position in the World.
  99147. * @returns the world space position of the light
  99148. */
  99149. getAbsolutePosition(): Vector3;
  99150. /**
  99151. * Specifies if the light will affect the passed mesh.
  99152. * @param mesh The mesh to test against the light
  99153. * @return true the mesh is affected otherwise, false.
  99154. */
  99155. canAffectMesh(mesh: AbstractMesh): boolean;
  99156. /**
  99157. * Sort function to order lights for rendering.
  99158. * @param a First Light object to compare to second.
  99159. * @param b Second Light object to compare first.
  99160. * @return -1 to reduce's a's index relative to be, 0 for no change, 1 to increase a's index relative to b.
  99161. */
  99162. static CompareLightsPriority(a: Light, b: Light): number;
  99163. /**
  99164. * Releases resources associated with this node.
  99165. * @param doNotRecurse Set to true to not recurse into each children (recurse into each children by default)
  99166. * @param disposeMaterialAndTextures Set to true to also dispose referenced materials and textures (false by default)
  99167. */
  99168. dispose(doNotRecurse?: boolean, disposeMaterialAndTextures?: boolean): void;
  99169. /**
  99170. * Returns the light type ID (integer).
  99171. * @returns The light Type id as a constant defines in Light.LIGHTTYPEID_x
  99172. */
  99173. getTypeID(): number;
  99174. /**
  99175. * Returns the intensity scaled by the Photometric Scale according to the light type and intensity mode.
  99176. * @returns the scaled intensity in intensity mode unit
  99177. */
  99178. getScaledIntensity(): number;
  99179. /**
  99180. * Returns a new Light object, named "name", from the current one.
  99181. * @param name The name of the cloned light
  99182. * @param newParent The parent of this light, if it has one
  99183. * @returns the new created light
  99184. */
  99185. clone(name: string, newParent?: Nullable<Node>): Nullable<Light>;
  99186. /**
  99187. * Serializes the current light into a Serialization object.
  99188. * @returns the serialized object.
  99189. */
  99190. serialize(): any;
  99191. /**
  99192. * Creates a new typed light from the passed type (integer) : point light = 0, directional light = 1, spot light = 2, hemispheric light = 3.
  99193. * This new light is named "name" and added to the passed scene.
  99194. * @param type Type according to the types available in Light.LIGHTTYPEID_x
  99195. * @param name The friendly name of the light
  99196. * @param scene The scene the new light will belong to
  99197. * @returns the constructor function
  99198. */
  99199. static GetConstructorFromName(type: number, name: string, scene: Scene): Nullable<() => Light>;
  99200. /**
  99201. * Parses the passed "parsedLight" and returns a new instanced Light from this parsing.
  99202. * @param parsedLight The JSON representation of the light
  99203. * @param scene The scene to create the parsed light in
  99204. * @returns the created light after parsing
  99205. */
  99206. static Parse(parsedLight: any, scene: Scene): Nullable<Light>;
  99207. private _hookArrayForExcluded;
  99208. private _hookArrayForIncludedOnly;
  99209. private _resyncMeshes;
  99210. /**
  99211. * Forces the meshes to update their light related information in their rendering used effects
  99212. * @hidden Internal Use Only
  99213. */
  99214. _markMeshesAsLightDirty(): void;
  99215. /**
  99216. * Recomputes the cached photometric scale if needed.
  99217. */
  99218. private _computePhotometricScale;
  99219. /**
  99220. * Returns the Photometric Scale according to the light type and intensity mode.
  99221. */
  99222. private _getPhotometricScale;
  99223. /**
  99224. * Reorder the light in the scene according to their defined priority.
  99225. * @hidden Internal Use Only
  99226. */
  99227. _reorderLightsInScene(): void;
  99228. /**
  99229. * Prepares the list of defines specific to the light type.
  99230. * @param defines the list of defines
  99231. * @param lightIndex defines the index of the light for the effect
  99232. */
  99233. abstract prepareLightSpecificDefines(defines: any, lightIndex: number): void;
  99234. }
  99235. }
  99236. declare module BABYLON {
  99237. /**
  99238. * Configuration needed for prepass-capable materials
  99239. */
  99240. export class PrePassConfiguration {
  99241. /**
  99242. * Previous world matrices of meshes carrying this material
  99243. * Used for computing velocity
  99244. */
  99245. previousWorldMatrices: {
  99246. [index: number]: Matrix;
  99247. };
  99248. /**
  99249. * Previous view project matrix
  99250. * Used for computing velocity
  99251. */
  99252. previousViewProjection: Matrix;
  99253. /**
  99254. * Previous bones of meshes carrying this material
  99255. * Used for computing velocity
  99256. */
  99257. previousBones: {
  99258. [index: number]: Float32Array;
  99259. };
  99260. /**
  99261. * Add the required uniforms to the current list.
  99262. * @param uniforms defines the current uniform list.
  99263. */
  99264. static AddUniforms(uniforms: string[]): void;
  99265. /**
  99266. * Add the required samplers to the current list.
  99267. * @param samplers defines the current sampler list.
  99268. */
  99269. static AddSamplers(samplers: string[]): void;
  99270. /**
  99271. * Binds the material data.
  99272. * @param effect defines the effect to update
  99273. * @param scene defines the scene the material belongs to.
  99274. * @param mesh The mesh
  99275. * @param world World matrix of this mesh
  99276. * @param isFrozen Is the material frozen
  99277. */
  99278. bindForSubMesh(effect: Effect, scene: Scene, mesh: Mesh, world: Matrix, isFrozen: boolean): void;
  99279. }
  99280. }
  99281. declare module BABYLON {
  99282. /**
  99283. * A target camera takes a mesh or position as a target and continues to look at it while it moves.
  99284. * This is the base of the follow, arc rotate cameras and Free camera
  99285. * @see https://doc.babylonjs.com/features/cameras
  99286. */
  99287. export class TargetCamera extends Camera {
  99288. private static _RigCamTransformMatrix;
  99289. private static _TargetTransformMatrix;
  99290. private static _TargetFocalPoint;
  99291. private _tmpUpVector;
  99292. private _tmpTargetVector;
  99293. /**
  99294. * Define the current direction the camera is moving to
  99295. */
  99296. cameraDirection: Vector3;
  99297. /**
  99298. * Define the current rotation the camera is rotating to
  99299. */
  99300. cameraRotation: Vector2;
  99301. /** Gets or sets a boolean indicating that the scaling of the parent hierarchy will not be taken in account by the camera */
  99302. ignoreParentScaling: boolean;
  99303. /**
  99304. * When set, the up vector of the camera will be updated by the rotation of the camera
  99305. */
  99306. updateUpVectorFromRotation: boolean;
  99307. private _tmpQuaternion;
  99308. /**
  99309. * Define the current rotation of the camera
  99310. */
  99311. rotation: Vector3;
  99312. /**
  99313. * Define the current rotation of the camera as a quaternion to prevent Gimbal lock
  99314. */
  99315. rotationQuaternion: Quaternion;
  99316. /**
  99317. * Define the current speed of the camera
  99318. */
  99319. speed: number;
  99320. /**
  99321. * Add constraint to the camera to prevent it to move freely in all directions and
  99322. * around all axis.
  99323. */
  99324. noRotationConstraint: boolean;
  99325. /**
  99326. * Reverses mouselook direction to 'natural' panning as opposed to traditional direct
  99327. * panning
  99328. */
  99329. invertRotation: boolean;
  99330. /**
  99331. * Speed multiplier for inverse camera panning
  99332. */
  99333. inverseRotationSpeed: number;
  99334. /**
  99335. * Define the current target of the camera as an object or a position.
  99336. */
  99337. lockedTarget: any;
  99338. /** @hidden */
  99339. _currentTarget: Vector3;
  99340. /** @hidden */
  99341. _initialFocalDistance: number;
  99342. /** @hidden */
  99343. _viewMatrix: Matrix;
  99344. /** @hidden */
  99345. _camMatrix: Matrix;
  99346. /** @hidden */
  99347. _cameraTransformMatrix: Matrix;
  99348. /** @hidden */
  99349. _cameraRotationMatrix: Matrix;
  99350. /** @hidden */
  99351. _referencePoint: Vector3;
  99352. /** @hidden */
  99353. _transformedReferencePoint: Vector3;
  99354. /** @hidden */
  99355. _reset: () => void;
  99356. private _defaultUp;
  99357. /**
  99358. * Instantiates a target camera that takes a mesh or position as a target and continues to look at it while it moves.
  99359. * This is the base of the follow, arc rotate cameras and Free camera
  99360. * @see https://doc.babylonjs.com/features/cameras
  99361. * @param name Defines the name of the camera in the scene
  99362. * @param position Defines the start position of the camera in the scene
  99363. * @param scene Defines the scene the camera belongs to
  99364. * @param setActiveOnSceneIfNoneActive Defines wheter the camera should be marked as active if not other active cameras have been defined
  99365. */
  99366. constructor(name: string, position: Vector3, scene: Scene, setActiveOnSceneIfNoneActive?: boolean);
  99367. /**
  99368. * Gets the position in front of the camera at a given distance.
  99369. * @param distance The distance from the camera we want the position to be
  99370. * @returns the position
  99371. */
  99372. getFrontPosition(distance: number): Vector3;
  99373. /** @hidden */
  99374. _getLockedTargetPosition(): Nullable<Vector3>;
  99375. private _storedPosition;
  99376. private _storedRotation;
  99377. private _storedRotationQuaternion;
  99378. /**
  99379. * Store current camera state of the camera (fov, position, rotation, etc..)
  99380. * @returns the camera
  99381. */
  99382. storeState(): Camera;
  99383. /**
  99384. * Restored camera state. You must call storeState() first
  99385. * @returns whether it was successful or not
  99386. * @hidden
  99387. */
  99388. _restoreStateValues(): boolean;
  99389. /** @hidden */
  99390. _initCache(): void;
  99391. /** @hidden */
  99392. _updateCache(ignoreParentClass?: boolean): void;
  99393. /** @hidden */
  99394. _isSynchronizedViewMatrix(): boolean;
  99395. /** @hidden */
  99396. _computeLocalCameraSpeed(): number;
  99397. /**
  99398. * Defines the target the camera should look at.
  99399. * @param target Defines the new target as a Vector or a mesh
  99400. */
  99401. setTarget(target: Vector3): void;
  99402. /**
  99403. * Defines the target point of the camera.
  99404. * The camera looks towards it form the radius distance.
  99405. */
  99406. get target(): Vector3;
  99407. set target(value: Vector3);
  99408. /**
  99409. * Return the current target position of the camera. This value is expressed in local space.
  99410. * @returns the target position
  99411. */
  99412. getTarget(): Vector3;
  99413. /** @hidden */
  99414. _decideIfNeedsToMove(): boolean;
  99415. /** @hidden */
  99416. _updatePosition(): void;
  99417. /** @hidden */
  99418. _checkInputs(): void;
  99419. protected _updateCameraRotationMatrix(): void;
  99420. /**
  99421. * 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)
  99422. * @returns the current camera
  99423. */
  99424. private _rotateUpVectorWithCameraRotationMatrix;
  99425. private _cachedRotationZ;
  99426. private _cachedQuaternionRotationZ;
  99427. /** @hidden */
  99428. _getViewMatrix(): Matrix;
  99429. protected _computeViewMatrix(position: Vector3, target: Vector3, up: Vector3): void;
  99430. /**
  99431. * @hidden
  99432. */
  99433. createRigCamera(name: string, cameraIndex: number): Nullable<Camera>;
  99434. /**
  99435. * @hidden
  99436. */
  99437. _updateRigCameras(): void;
  99438. private _getRigCamPositionAndTarget;
  99439. /**
  99440. * Gets the current object class name.
  99441. * @return the class name
  99442. */
  99443. getClassName(): string;
  99444. }
  99445. }
  99446. declare module BABYLON {
  99447. /**
  99448. * Gather the list of keyboard event types as constants.
  99449. */
  99450. export class KeyboardEventTypes {
  99451. /**
  99452. * The keydown event is fired when a key becomes active (pressed).
  99453. */
  99454. static readonly KEYDOWN: number;
  99455. /**
  99456. * The keyup event is fired when a key has been released.
  99457. */
  99458. static readonly KEYUP: number;
  99459. }
  99460. /**
  99461. * This class is used to store keyboard related info for the onKeyboardObservable event.
  99462. */
  99463. export class KeyboardInfo {
  99464. /**
  99465. * Defines the type of event (KeyboardEventTypes)
  99466. */
  99467. type: number;
  99468. /**
  99469. * Defines the related dom event
  99470. */
  99471. event: KeyboardEvent;
  99472. /**
  99473. * Instantiates a new keyboard info.
  99474. * This class is used to store keyboard related info for the onKeyboardObservable event.
  99475. * @param type Defines the type of event (KeyboardEventTypes)
  99476. * @param event Defines the related dom event
  99477. */
  99478. constructor(
  99479. /**
  99480. * Defines the type of event (KeyboardEventTypes)
  99481. */
  99482. type: number,
  99483. /**
  99484. * Defines the related dom event
  99485. */
  99486. event: KeyboardEvent);
  99487. }
  99488. /**
  99489. * This class is used to store keyboard related info for the onPreKeyboardObservable event.
  99490. * Set the skipOnKeyboardObservable property to true if you want the engine to stop any process after this event is triggered, even not calling onKeyboardObservable
  99491. */
  99492. export class KeyboardInfoPre extends KeyboardInfo {
  99493. /**
  99494. * Defines the type of event (KeyboardEventTypes)
  99495. */
  99496. type: number;
  99497. /**
  99498. * Defines the related dom event
  99499. */
  99500. event: KeyboardEvent;
  99501. /**
  99502. * Defines whether the engine should skip the next onKeyboardObservable associated to this pre.
  99503. */
  99504. skipOnPointerObservable: boolean;
  99505. /**
  99506. * Instantiates a new keyboard pre info.
  99507. * This class is used to store keyboard related info for the onPreKeyboardObservable event.
  99508. * @param type Defines the type of event (KeyboardEventTypes)
  99509. * @param event Defines the related dom event
  99510. */
  99511. constructor(
  99512. /**
  99513. * Defines the type of event (KeyboardEventTypes)
  99514. */
  99515. type: number,
  99516. /**
  99517. * Defines the related dom event
  99518. */
  99519. event: KeyboardEvent);
  99520. }
  99521. }
  99522. declare module BABYLON {
  99523. /**
  99524. * Manage the keyboard inputs to control the movement of a free camera.
  99525. * @see https://doc.babylonjs.com/how_to/customizing_camera_inputs
  99526. */
  99527. export class FreeCameraKeyboardMoveInput implements ICameraInput<FreeCamera> {
  99528. /**
  99529. * Defines the camera the input is attached to.
  99530. */
  99531. camera: FreeCamera;
  99532. /**
  99533. * Gets or Set the list of keyboard keys used to control the forward move of the camera.
  99534. */
  99535. keysUp: number[];
  99536. /**
  99537. * Gets or Set the list of keyboard keys used to control the upward move of the camera.
  99538. */
  99539. keysUpward: number[];
  99540. /**
  99541. * Gets or Set the list of keyboard keys used to control the backward move of the camera.
  99542. */
  99543. keysDown: number[];
  99544. /**
  99545. * Gets or Set the list of keyboard keys used to control the downward move of the camera.
  99546. */
  99547. keysDownward: number[];
  99548. /**
  99549. * Gets or Set the list of keyboard keys used to control the left strafe move of the camera.
  99550. */
  99551. keysLeft: number[];
  99552. /**
  99553. * Gets or Set the list of keyboard keys used to control the right strafe move of the camera.
  99554. */
  99555. keysRight: number[];
  99556. private _keys;
  99557. private _onCanvasBlurObserver;
  99558. private _onKeyboardObserver;
  99559. private _engine;
  99560. private _scene;
  99561. /**
  99562. * Attach the input controls to a specific dom element to get the input from.
  99563. * @param element Defines the element the controls should be listened from
  99564. * @param noPreventDefault Defines whether event caught by the controls should call preventdefault() (https://developer.mozilla.org/en-US/docs/Web/API/Event/preventDefault)
  99565. */
  99566. attachControl(element: HTMLElement, noPreventDefault?: boolean): void;
  99567. /**
  99568. * Detach the current controls from the specified dom element.
  99569. * @param element Defines the element to stop listening the inputs from
  99570. */
  99571. detachControl(element: Nullable<HTMLElement>): void;
  99572. /**
  99573. * Update the current camera state depending on the inputs that have been used this frame.
  99574. * This is a dynamically created lambda to avoid the performance penalty of looping for inputs in the render loop.
  99575. */
  99576. checkInputs(): void;
  99577. /**
  99578. * Gets the class name of the current intput.
  99579. * @returns the class name
  99580. */
  99581. getClassName(): string;
  99582. /** @hidden */
  99583. _onLostFocus(): void;
  99584. /**
  99585. * Get the friendly name associated with the input class.
  99586. * @returns the input friendly name
  99587. */
  99588. getSimpleName(): string;
  99589. }
  99590. }
  99591. declare module BABYLON {
  99592. /**
  99593. * Gather the list of pointer event types as constants.
  99594. */
  99595. export class PointerEventTypes {
  99596. /**
  99597. * 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.
  99598. */
  99599. static readonly POINTERDOWN: number;
  99600. /**
  99601. * The pointerup event is fired when a pointer is no longer active.
  99602. */
  99603. static readonly POINTERUP: number;
  99604. /**
  99605. * The pointermove event is fired when a pointer changes coordinates.
  99606. */
  99607. static readonly POINTERMOVE: number;
  99608. /**
  99609. * The pointerwheel event is fired when a mouse wheel has been rotated.
  99610. */
  99611. static readonly POINTERWHEEL: number;
  99612. /**
  99613. * The pointerpick event is fired when a mesh or sprite has been picked by the pointer.
  99614. */
  99615. static readonly POINTERPICK: number;
  99616. /**
  99617. * The pointertap event is fired when a the object has been touched and released without drag.
  99618. */
  99619. static readonly POINTERTAP: number;
  99620. /**
  99621. * The pointerdoubletap event is fired when a the object has been touched and released twice without drag.
  99622. */
  99623. static readonly POINTERDOUBLETAP: number;
  99624. }
  99625. /**
  99626. * Base class of pointer info types.
  99627. */
  99628. export class PointerInfoBase {
  99629. /**
  99630. * Defines the type of event (PointerEventTypes)
  99631. */
  99632. type: number;
  99633. /**
  99634. * Defines the related dom event
  99635. */
  99636. event: PointerEvent | MouseWheelEvent;
  99637. /**
  99638. * Instantiates the base class of pointers info.
  99639. * @param type Defines the type of event (PointerEventTypes)
  99640. * @param event Defines the related dom event
  99641. */
  99642. constructor(
  99643. /**
  99644. * Defines the type of event (PointerEventTypes)
  99645. */
  99646. type: number,
  99647. /**
  99648. * Defines the related dom event
  99649. */
  99650. event: PointerEvent | MouseWheelEvent);
  99651. }
  99652. /**
  99653. * This class is used to store pointer related info for the onPrePointerObservable event.
  99654. * Set the skipOnPointerObservable property to true if you want the engine to stop any process after this event is triggered, even not calling onPointerObservable
  99655. */
  99656. export class PointerInfoPre extends PointerInfoBase {
  99657. /**
  99658. * Ray from a pointer if availible (eg. 6dof controller)
  99659. */
  99660. ray: Nullable<Ray>;
  99661. /**
  99662. * Defines the local position of the pointer on the canvas.
  99663. */
  99664. localPosition: Vector2;
  99665. /**
  99666. * Defines whether the engine should skip the next OnPointerObservable associated to this pre.
  99667. */
  99668. skipOnPointerObservable: boolean;
  99669. /**
  99670. * Instantiates a PointerInfoPre to store pointer related info to the onPrePointerObservable event.
  99671. * @param type Defines the type of event (PointerEventTypes)
  99672. * @param event Defines the related dom event
  99673. * @param localX Defines the local x coordinates of the pointer when the event occured
  99674. * @param localY Defines the local y coordinates of the pointer when the event occured
  99675. */
  99676. constructor(type: number, event: PointerEvent | MouseWheelEvent, localX: number, localY: number);
  99677. }
  99678. /**
  99679. * This type contains all the data related to a pointer event in Babylon.js.
  99680. * 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.
  99681. */
  99682. export class PointerInfo extends PointerInfoBase {
  99683. /**
  99684. * Defines the picking info associated to the info (if any)\
  99685. */
  99686. pickInfo: Nullable<PickingInfo>;
  99687. /**
  99688. * Instantiates a PointerInfo to store pointer related info to the onPointerObservable event.
  99689. * @param type Defines the type of event (PointerEventTypes)
  99690. * @param event Defines the related dom event
  99691. * @param pickInfo Defines the picking info associated to the info (if any)\
  99692. */
  99693. constructor(type: number, event: PointerEvent | MouseWheelEvent,
  99694. /**
  99695. * Defines the picking info associated to the info (if any)\
  99696. */
  99697. pickInfo: Nullable<PickingInfo>);
  99698. }
  99699. /**
  99700. * Data relating to a touch event on the screen.
  99701. */
  99702. export interface PointerTouch {
  99703. /**
  99704. * X coordinate of touch.
  99705. */
  99706. x: number;
  99707. /**
  99708. * Y coordinate of touch.
  99709. */
  99710. y: number;
  99711. /**
  99712. * Id of touch. Unique for each finger.
  99713. */
  99714. pointerId: number;
  99715. /**
  99716. * Event type passed from DOM.
  99717. */
  99718. type: any;
  99719. }
  99720. }
  99721. declare module BABYLON {
  99722. /**
  99723. * Manage the mouse inputs to control the movement of a free camera.
  99724. * @see https://doc.babylonjs.com/how_to/customizing_camera_inputs
  99725. */
  99726. export class FreeCameraMouseInput implements ICameraInput<FreeCamera> {
  99727. /**
  99728. * Define if touch is enabled in the mouse input
  99729. */
  99730. touchEnabled: boolean;
  99731. /**
  99732. * Defines the camera the input is attached to.
  99733. */
  99734. camera: FreeCamera;
  99735. /**
  99736. * Defines the buttons associated with the input to handle camera move.
  99737. */
  99738. buttons: number[];
  99739. /**
  99740. * Defines the pointer angular sensibility along the X and Y axis or how fast is the camera rotating.
  99741. */
  99742. angularSensibility: number;
  99743. private _pointerInput;
  99744. private _onMouseMove;
  99745. private _observer;
  99746. private previousPosition;
  99747. /**
  99748. * Observable for when a pointer move event occurs containing the move offset
  99749. */
  99750. onPointerMovedObservable: Observable<{
  99751. offsetX: number;
  99752. offsetY: number;
  99753. }>;
  99754. /**
  99755. * @hidden
  99756. * If the camera should be rotated automatically based on pointer movement
  99757. */
  99758. _allowCameraRotation: boolean;
  99759. /**
  99760. * Manage the mouse inputs to control the movement of a free camera.
  99761. * @see https://doc.babylonjs.com/how_to/customizing_camera_inputs
  99762. * @param touchEnabled Defines if touch is enabled or not
  99763. */
  99764. constructor(
  99765. /**
  99766. * Define if touch is enabled in the mouse input
  99767. */
  99768. touchEnabled?: boolean);
  99769. /**
  99770. * Attach the input controls to a specific dom element to get the input from.
  99771. * @param element Defines the element the controls should be listened from
  99772. * @param noPreventDefault Defines whether event caught by the controls should call preventdefault() (https://developer.mozilla.org/en-US/docs/Web/API/Event/preventDefault)
  99773. */
  99774. attachControl(element: HTMLElement, noPreventDefault?: boolean): void;
  99775. /**
  99776. * Called on JS contextmenu event.
  99777. * Override this method to provide functionality.
  99778. */
  99779. protected onContextMenu(evt: PointerEvent): void;
  99780. /**
  99781. * Detach the current controls from the specified dom element.
  99782. * @param element Defines the element to stop listening the inputs from
  99783. */
  99784. detachControl(element: Nullable<HTMLElement>): void;
  99785. /**
  99786. * Gets the class name of the current intput.
  99787. * @returns the class name
  99788. */
  99789. getClassName(): string;
  99790. /**
  99791. * Get the friendly name associated with the input class.
  99792. * @returns the input friendly name
  99793. */
  99794. getSimpleName(): string;
  99795. }
  99796. }
  99797. declare module BABYLON {
  99798. /**
  99799. * Manage the touch inputs to control the movement of a free camera.
  99800. * @see https://doc.babylonjs.com/how_to/customizing_camera_inputs
  99801. */
  99802. export class FreeCameraTouchInput implements ICameraInput<FreeCamera> {
  99803. /**
  99804. * Define if mouse events can be treated as touch events
  99805. */
  99806. allowMouse: boolean;
  99807. /**
  99808. * Defines the camera the input is attached to.
  99809. */
  99810. camera: FreeCamera;
  99811. /**
  99812. * Defines the touch sensibility for rotation.
  99813. * The higher the faster.
  99814. */
  99815. touchAngularSensibility: number;
  99816. /**
  99817. * Defines the touch sensibility for move.
  99818. * The higher the faster.
  99819. */
  99820. touchMoveSensibility: number;
  99821. private _offsetX;
  99822. private _offsetY;
  99823. private _pointerPressed;
  99824. private _pointerInput;
  99825. private _observer;
  99826. private _onLostFocus;
  99827. /**
  99828. * Manage the touch inputs to control the movement of a free camera.
  99829. * @see https://doc.babylonjs.com/how_to/customizing_camera_inputs
  99830. * @param allowMouse Defines if mouse events can be treated as touch events
  99831. */
  99832. constructor(
  99833. /**
  99834. * Define if mouse events can be treated as touch events
  99835. */
  99836. allowMouse?: boolean);
  99837. /**
  99838. * Attach the input controls to a specific dom element to get the input from.
  99839. * @param element Defines the element the controls should be listened from
  99840. * @param noPreventDefault Defines whether event caught by the controls should call preventdefault() (https://developer.mozilla.org/en-US/docs/Web/API/Event/preventDefault)
  99841. */
  99842. attachControl(element: HTMLElement, noPreventDefault?: boolean): void;
  99843. /**
  99844. * Detach the current controls from the specified dom element.
  99845. * @param element Defines the element to stop listening the inputs from
  99846. */
  99847. detachControl(element: Nullable<HTMLElement>): void;
  99848. /**
  99849. * Update the current camera state depending on the inputs that have been used this frame.
  99850. * This is a dynamically created lambda to avoid the performance penalty of looping for inputs in the render loop.
  99851. */
  99852. checkInputs(): void;
  99853. /**
  99854. * Gets the class name of the current intput.
  99855. * @returns the class name
  99856. */
  99857. getClassName(): string;
  99858. /**
  99859. * Get the friendly name associated with the input class.
  99860. * @returns the input friendly name
  99861. */
  99862. getSimpleName(): string;
  99863. }
  99864. }
  99865. declare module BABYLON {
  99866. /**
  99867. * Default Inputs manager for the FreeCamera.
  99868. * It groups all the default supported inputs for ease of use.
  99869. * @see https://doc.babylonjs.com/how_to/customizing_camera_inputs
  99870. */
  99871. export class FreeCameraInputsManager extends CameraInputsManager<FreeCamera> {
  99872. /**
  99873. * @hidden
  99874. */
  99875. _mouseInput: Nullable<FreeCameraMouseInput>;
  99876. /**
  99877. * Instantiates a new FreeCameraInputsManager.
  99878. * @param camera Defines the camera the inputs belong to
  99879. */
  99880. constructor(camera: FreeCamera);
  99881. /**
  99882. * Add keyboard input support to the input manager.
  99883. * @returns the current input manager
  99884. */
  99885. addKeyboard(): FreeCameraInputsManager;
  99886. /**
  99887. * Add mouse input support to the input manager.
  99888. * @param touchEnabled if the FreeCameraMouseInput should support touch (default: true)
  99889. * @returns the current input manager
  99890. */
  99891. addMouse(touchEnabled?: boolean): FreeCameraInputsManager;
  99892. /**
  99893. * Removes the mouse input support from the manager
  99894. * @returns the current input manager
  99895. */
  99896. removeMouse(): FreeCameraInputsManager;
  99897. /**
  99898. * Add touch input support to the input manager.
  99899. * @returns the current input manager
  99900. */
  99901. addTouch(): FreeCameraInputsManager;
  99902. /**
  99903. * Remove all attached input methods from a camera
  99904. */
  99905. clear(): void;
  99906. }
  99907. }
  99908. declare module BABYLON {
  99909. /**
  99910. * This represents a free type of camera. It can be useful in First Person Shooter game for instance.
  99911. * Please consider using the new UniversalCamera instead as it adds more functionality like the gamepad.
  99912. * @see https://doc.babylonjs.com/features/cameras#universal-camera
  99913. */
  99914. export class FreeCamera extends TargetCamera {
  99915. /**
  99916. * Define the collision ellipsoid of the camera.
  99917. * This is helpful to simulate a camera body like the player body around the camera
  99918. * @see https://doc.babylonjs.com/babylon101/cameras,_mesh_collisions_and_gravity#arcrotatecamera
  99919. */
  99920. ellipsoid: Vector3;
  99921. /**
  99922. * Define an offset for the position of the ellipsoid around the camera.
  99923. * This can be helpful to determine the center of the body near the gravity center of the body
  99924. * instead of its head.
  99925. */
  99926. ellipsoidOffset: Vector3;
  99927. /**
  99928. * Enable or disable collisions of the camera with the rest of the scene objects.
  99929. */
  99930. checkCollisions: boolean;
  99931. /**
  99932. * Enable or disable gravity on the camera.
  99933. */
  99934. applyGravity: boolean;
  99935. /**
  99936. * Define the input manager associated to the camera.
  99937. */
  99938. inputs: FreeCameraInputsManager;
  99939. /**
  99940. * Gets the input sensibility for a mouse input. (default is 2000.0)
  99941. * Higher values reduce sensitivity.
  99942. */
  99943. get angularSensibility(): number;
  99944. /**
  99945. * Sets the input sensibility for a mouse input. (default is 2000.0)
  99946. * Higher values reduce sensitivity.
  99947. */
  99948. set angularSensibility(value: number);
  99949. /**
  99950. * Gets or Set the list of keyboard keys used to control the forward move of the camera.
  99951. */
  99952. get keysUp(): number[];
  99953. set keysUp(value: number[]);
  99954. /**
  99955. * Gets or Set the list of keyboard keys used to control the upward move of the camera.
  99956. */
  99957. get keysUpward(): number[];
  99958. set keysUpward(value: number[]);
  99959. /**
  99960. * Gets or Set the list of keyboard keys used to control the backward move of the camera.
  99961. */
  99962. get keysDown(): number[];
  99963. set keysDown(value: number[]);
  99964. /**
  99965. * Gets or Set the list of keyboard keys used to control the downward move of the camera.
  99966. */
  99967. get keysDownward(): number[];
  99968. set keysDownward(value: number[]);
  99969. /**
  99970. * Gets or Set the list of keyboard keys used to control the left strafe move of the camera.
  99971. */
  99972. get keysLeft(): number[];
  99973. set keysLeft(value: number[]);
  99974. /**
  99975. * Gets or Set the list of keyboard keys used to control the right strafe move of the camera.
  99976. */
  99977. get keysRight(): number[];
  99978. set keysRight(value: number[]);
  99979. /**
  99980. * Event raised when the camera collide with a mesh in the scene.
  99981. */
  99982. onCollide: (collidedMesh: AbstractMesh) => void;
  99983. private _collider;
  99984. private _needMoveForGravity;
  99985. private _oldPosition;
  99986. private _diffPosition;
  99987. private _newPosition;
  99988. /** @hidden */
  99989. _localDirection: Vector3;
  99990. /** @hidden */
  99991. _transformedDirection: Vector3;
  99992. /**
  99993. * Instantiates a Free Camera.
  99994. * This represents a free type of camera. It can be useful in First Person Shooter game for instance.
  99995. * Please consider using the new UniversalCamera instead as it adds more functionality like touch to this camera.
  99996. * @see https://doc.babylonjs.com/features/cameras#universal-camera
  99997. * @param name Define the name of the camera in the scene
  99998. * @param position Define the start position of the camera in the scene
  99999. * @param scene Define the scene the camera belongs to
  100000. * @param setActiveOnSceneIfNoneActive Defines wheter the camera should be marked as active if not other active cameras have been defined
  100001. */
  100002. constructor(name: string, position: Vector3, scene: Scene, setActiveOnSceneIfNoneActive?: boolean);
  100003. /**
  100004. * Attached controls to the current camera.
  100005. * @param element Defines the element the controls should be listened from
  100006. * @param noPreventDefault Defines whether event caught by the controls should call preventdefault() (https://developer.mozilla.org/en-US/docs/Web/API/Event/preventDefault)
  100007. */
  100008. attachControl(element: HTMLElement, noPreventDefault?: boolean): void;
  100009. /**
  100010. * Detach the current controls from the camera.
  100011. * The camera will stop reacting to inputs.
  100012. * @param element Defines the element to stop listening the inputs from
  100013. */
  100014. detachControl(element: HTMLElement): void;
  100015. private _collisionMask;
  100016. /**
  100017. * Define a collision mask to limit the list of object the camera can collide with
  100018. */
  100019. get collisionMask(): number;
  100020. set collisionMask(mask: number);
  100021. /** @hidden */
  100022. _collideWithWorld(displacement: Vector3): void;
  100023. private _onCollisionPositionChange;
  100024. /** @hidden */
  100025. _checkInputs(): void;
  100026. /** @hidden */
  100027. _decideIfNeedsToMove(): boolean;
  100028. /** @hidden */
  100029. _updatePosition(): void;
  100030. /**
  100031. * Destroy the camera and release the current resources hold by it.
  100032. */
  100033. dispose(): void;
  100034. /**
  100035. * Gets the current object class name.
  100036. * @return the class name
  100037. */
  100038. getClassName(): string;
  100039. }
  100040. }
  100041. declare module BABYLON {
  100042. /**
  100043. * Represents a gamepad control stick position
  100044. */
  100045. export class StickValues {
  100046. /**
  100047. * The x component of the control stick
  100048. */
  100049. x: number;
  100050. /**
  100051. * The y component of the control stick
  100052. */
  100053. y: number;
  100054. /**
  100055. * Initializes the gamepad x and y control stick values
  100056. * @param x The x component of the gamepad control stick value
  100057. * @param y The y component of the gamepad control stick value
  100058. */
  100059. constructor(
  100060. /**
  100061. * The x component of the control stick
  100062. */
  100063. x: number,
  100064. /**
  100065. * The y component of the control stick
  100066. */
  100067. y: number);
  100068. }
  100069. /**
  100070. * An interface which manages callbacks for gamepad button changes
  100071. */
  100072. export interface GamepadButtonChanges {
  100073. /**
  100074. * Called when a gamepad has been changed
  100075. */
  100076. changed: boolean;
  100077. /**
  100078. * Called when a gamepad press event has been triggered
  100079. */
  100080. pressChanged: boolean;
  100081. /**
  100082. * Called when a touch event has been triggered
  100083. */
  100084. touchChanged: boolean;
  100085. /**
  100086. * Called when a value has changed
  100087. */
  100088. valueChanged: boolean;
  100089. }
  100090. /**
  100091. * Represents a gamepad
  100092. */
  100093. export class Gamepad {
  100094. /**
  100095. * The id of the gamepad
  100096. */
  100097. id: string;
  100098. /**
  100099. * The index of the gamepad
  100100. */
  100101. index: number;
  100102. /**
  100103. * The browser gamepad
  100104. */
  100105. browserGamepad: any;
  100106. /**
  100107. * Specifies what type of gamepad this represents
  100108. */
  100109. type: number;
  100110. private _leftStick;
  100111. private _rightStick;
  100112. /** @hidden */
  100113. _isConnected: boolean;
  100114. private _leftStickAxisX;
  100115. private _leftStickAxisY;
  100116. private _rightStickAxisX;
  100117. private _rightStickAxisY;
  100118. /**
  100119. * Triggered when the left control stick has been changed
  100120. */
  100121. private _onleftstickchanged;
  100122. /**
  100123. * Triggered when the right control stick has been changed
  100124. */
  100125. private _onrightstickchanged;
  100126. /**
  100127. * Represents a gamepad controller
  100128. */
  100129. static GAMEPAD: number;
  100130. /**
  100131. * Represents a generic controller
  100132. */
  100133. static GENERIC: number;
  100134. /**
  100135. * Represents an XBox controller
  100136. */
  100137. static XBOX: number;
  100138. /**
  100139. * Represents a pose-enabled controller
  100140. */
  100141. static POSE_ENABLED: number;
  100142. /**
  100143. * Represents an Dual Shock controller
  100144. */
  100145. static DUALSHOCK: number;
  100146. /**
  100147. * Specifies whether the left control stick should be Y-inverted
  100148. */
  100149. protected _invertLeftStickY: boolean;
  100150. /**
  100151. * Specifies if the gamepad has been connected
  100152. */
  100153. get isConnected(): boolean;
  100154. /**
  100155. * Initializes the gamepad
  100156. * @param id The id of the gamepad
  100157. * @param index The index of the gamepad
  100158. * @param browserGamepad The browser gamepad
  100159. * @param leftStickX The x component of the left joystick
  100160. * @param leftStickY The y component of the left joystick
  100161. * @param rightStickX The x component of the right joystick
  100162. * @param rightStickY The y component of the right joystick
  100163. */
  100164. constructor(
  100165. /**
  100166. * The id of the gamepad
  100167. */
  100168. id: string,
  100169. /**
  100170. * The index of the gamepad
  100171. */
  100172. index: number,
  100173. /**
  100174. * The browser gamepad
  100175. */
  100176. browserGamepad: any, leftStickX?: number, leftStickY?: number, rightStickX?: number, rightStickY?: number);
  100177. /**
  100178. * Callback triggered when the left joystick has changed
  100179. * @param callback
  100180. */
  100181. onleftstickchanged(callback: (values: StickValues) => void): void;
  100182. /**
  100183. * Callback triggered when the right joystick has changed
  100184. * @param callback
  100185. */
  100186. onrightstickchanged(callback: (values: StickValues) => void): void;
  100187. /**
  100188. * Gets the left joystick
  100189. */
  100190. get leftStick(): StickValues;
  100191. /**
  100192. * Sets the left joystick values
  100193. */
  100194. set leftStick(newValues: StickValues);
  100195. /**
  100196. * Gets the right joystick
  100197. */
  100198. get rightStick(): StickValues;
  100199. /**
  100200. * Sets the right joystick value
  100201. */
  100202. set rightStick(newValues: StickValues);
  100203. /**
  100204. * Updates the gamepad joystick positions
  100205. */
  100206. update(): void;
  100207. /**
  100208. * Disposes the gamepad
  100209. */
  100210. dispose(): void;
  100211. }
  100212. /**
  100213. * Represents a generic gamepad
  100214. */
  100215. export class GenericPad extends Gamepad {
  100216. private _buttons;
  100217. private _onbuttondown;
  100218. private _onbuttonup;
  100219. /**
  100220. * Observable triggered when a button has been pressed
  100221. */
  100222. onButtonDownObservable: Observable<number>;
  100223. /**
  100224. * Observable triggered when a button has been released
  100225. */
  100226. onButtonUpObservable: Observable<number>;
  100227. /**
  100228. * Callback triggered when a button has been pressed
  100229. * @param callback Called when a button has been pressed
  100230. */
  100231. onbuttondown(callback: (buttonPressed: number) => void): void;
  100232. /**
  100233. * Callback triggered when a button has been released
  100234. * @param callback Called when a button has been released
  100235. */
  100236. onbuttonup(callback: (buttonReleased: number) => void): void;
  100237. /**
  100238. * Initializes the generic gamepad
  100239. * @param id The id of the generic gamepad
  100240. * @param index The index of the generic gamepad
  100241. * @param browserGamepad The browser gamepad
  100242. */
  100243. constructor(id: string, index: number, browserGamepad: any);
  100244. private _setButtonValue;
  100245. /**
  100246. * Updates the generic gamepad
  100247. */
  100248. update(): void;
  100249. /**
  100250. * Disposes the generic gamepad
  100251. */
  100252. dispose(): void;
  100253. }
  100254. }
  100255. declare module BABYLON {
  100256. /**
  100257. * Defines the types of pose enabled controllers that are supported
  100258. */
  100259. export enum PoseEnabledControllerType {
  100260. /**
  100261. * HTC Vive
  100262. */
  100263. VIVE = 0,
  100264. /**
  100265. * Oculus Rift
  100266. */
  100267. OCULUS = 1,
  100268. /**
  100269. * Windows mixed reality
  100270. */
  100271. WINDOWS = 2,
  100272. /**
  100273. * Samsung gear VR
  100274. */
  100275. GEAR_VR = 3,
  100276. /**
  100277. * Google Daydream
  100278. */
  100279. DAYDREAM = 4,
  100280. /**
  100281. * Generic
  100282. */
  100283. GENERIC = 5
  100284. }
  100285. /**
  100286. * Defines the MutableGamepadButton interface for the state of a gamepad button
  100287. */
  100288. export interface MutableGamepadButton {
  100289. /**
  100290. * Value of the button/trigger
  100291. */
  100292. value: number;
  100293. /**
  100294. * If the button/trigger is currently touched
  100295. */
  100296. touched: boolean;
  100297. /**
  100298. * If the button/trigger is currently pressed
  100299. */
  100300. pressed: boolean;
  100301. }
  100302. /**
  100303. * Defines the ExtendedGamepadButton interface for a gamepad button which includes state provided by a pose controller
  100304. * @hidden
  100305. */
  100306. export interface ExtendedGamepadButton extends GamepadButton {
  100307. /**
  100308. * If the button/trigger is currently pressed
  100309. */
  100310. readonly pressed: boolean;
  100311. /**
  100312. * If the button/trigger is currently touched
  100313. */
  100314. readonly touched: boolean;
  100315. /**
  100316. * Value of the button/trigger
  100317. */
  100318. readonly value: number;
  100319. }
  100320. /** @hidden */
  100321. export interface _GamePadFactory {
  100322. /**
  100323. * Returns whether or not the current gamepad can be created for this type of controller.
  100324. * @param gamepadInfo Defines the gamepad info as received from the controller APIs.
  100325. * @returns true if it can be created, otherwise false
  100326. */
  100327. canCreate(gamepadInfo: any): boolean;
  100328. /**
  100329. * Creates a new instance of the Gamepad.
  100330. * @param gamepadInfo Defines the gamepad info as received from the controller APIs.
  100331. * @returns the new gamepad instance
  100332. */
  100333. create(gamepadInfo: any): Gamepad;
  100334. }
  100335. /**
  100336. * Defines the PoseEnabledControllerHelper object that is used initialize a gamepad as the controller type it is specified as (eg. windows mixed reality controller)
  100337. */
  100338. export class PoseEnabledControllerHelper {
  100339. /** @hidden */
  100340. static _ControllerFactories: _GamePadFactory[];
  100341. /** @hidden */
  100342. static _DefaultControllerFactory: Nullable<(gamepadInfo: any) => Gamepad>;
  100343. /**
  100344. * Initializes a gamepad as the controller type it is specified as (eg. windows mixed reality controller)
  100345. * @param vrGamepad the gamepad to initialized
  100346. * @returns a vr controller of the type the gamepad identified as
  100347. */
  100348. static InitiateController(vrGamepad: any): Gamepad;
  100349. }
  100350. /**
  100351. * Defines the PoseEnabledController object that contains state of a vr capable controller
  100352. */
  100353. export class PoseEnabledController extends Gamepad implements PoseControlled {
  100354. /**
  100355. * If the controller is used in a webXR session
  100356. */
  100357. isXR: boolean;
  100358. private _deviceRoomPosition;
  100359. private _deviceRoomRotationQuaternion;
  100360. /**
  100361. * The device position in babylon space
  100362. */
  100363. devicePosition: Vector3;
  100364. /**
  100365. * The device rotation in babylon space
  100366. */
  100367. deviceRotationQuaternion: Quaternion;
  100368. /**
  100369. * The scale factor of the device in babylon space
  100370. */
  100371. deviceScaleFactor: number;
  100372. /**
  100373. * (Likely devicePosition should be used instead) The device position in its room space
  100374. */
  100375. position: Vector3;
  100376. /**
  100377. * (Likely deviceRotationQuaternion should be used instead) The device rotation in its room space
  100378. */
  100379. rotationQuaternion: Quaternion;
  100380. /**
  100381. * The type of controller (Eg. Windows mixed reality)
  100382. */
  100383. controllerType: PoseEnabledControllerType;
  100384. protected _calculatedPosition: Vector3;
  100385. private _calculatedRotation;
  100386. /**
  100387. * The raw pose from the device
  100388. */
  100389. rawPose: DevicePose;
  100390. private _trackPosition;
  100391. private _maxRotationDistFromHeadset;
  100392. private _draggedRoomRotation;
  100393. /**
  100394. * @hidden
  100395. */
  100396. _disableTrackPosition(fixedPosition: Vector3): void;
  100397. /**
  100398. * Internal, the mesh attached to the controller
  100399. * @hidden
  100400. */
  100401. _mesh: Nullable<AbstractMesh>;
  100402. private _poseControlledCamera;
  100403. private _leftHandSystemQuaternion;
  100404. /**
  100405. * Internal, matrix used to convert room space to babylon space
  100406. * @hidden
  100407. */
  100408. _deviceToWorld: Matrix;
  100409. /**
  100410. * Node to be used when casting a ray from the controller
  100411. * @hidden
  100412. */
  100413. _pointingPoseNode: Nullable<TransformNode>;
  100414. /**
  100415. * Name of the child mesh that can be used to cast a ray from the controller
  100416. */
  100417. static readonly POINTING_POSE: string;
  100418. /**
  100419. * Creates a new PoseEnabledController from a gamepad
  100420. * @param browserGamepad the gamepad that the PoseEnabledController should be created from
  100421. */
  100422. constructor(browserGamepad: any);
  100423. private _workingMatrix;
  100424. /**
  100425. * Updates the state of the pose enbaled controller and mesh based on the current position and rotation of the controller
  100426. */
  100427. update(): void;
  100428. /**
  100429. * Updates only the pose device and mesh without doing any button event checking
  100430. */
  100431. protected _updatePoseAndMesh(): void;
  100432. /**
  100433. * Updates the state of the pose enbaled controller based on the raw pose data from the device
  100434. * @param poseData raw pose fromthe device
  100435. */
  100436. updateFromDevice(poseData: DevicePose): void;
  100437. /**
  100438. * @hidden
  100439. */
  100440. _meshAttachedObservable: Observable<AbstractMesh>;
  100441. /**
  100442. * Attaches a mesh to the controller
  100443. * @param mesh the mesh to be attached
  100444. */
  100445. attachToMesh(mesh: AbstractMesh): void;
  100446. /**
  100447. * Attaches the controllers mesh to a camera
  100448. * @param camera the camera the mesh should be attached to
  100449. */
  100450. attachToPoseControlledCamera(camera: TargetCamera): void;
  100451. /**
  100452. * Disposes of the controller
  100453. */
  100454. dispose(): void;
  100455. /**
  100456. * The mesh that is attached to the controller
  100457. */
  100458. get mesh(): Nullable<AbstractMesh>;
  100459. /**
  100460. * Gets the ray of the controller in the direction the controller is pointing
  100461. * @param length the length the resulting ray should be
  100462. * @returns a ray in the direction the controller is pointing
  100463. */
  100464. getForwardRay(length?: number): Ray;
  100465. }
  100466. }
  100467. declare module BABYLON {
  100468. /**
  100469. * Defines the WebVRController object that represents controllers tracked in 3D space
  100470. */
  100471. export abstract class WebVRController extends PoseEnabledController {
  100472. /**
  100473. * Internal, the default controller model for the controller
  100474. */
  100475. protected _defaultModel: Nullable<AbstractMesh>;
  100476. /**
  100477. * Fired when the trigger state has changed
  100478. */
  100479. onTriggerStateChangedObservable: Observable<ExtendedGamepadButton>;
  100480. /**
  100481. * Fired when the main button state has changed
  100482. */
  100483. onMainButtonStateChangedObservable: Observable<ExtendedGamepadButton>;
  100484. /**
  100485. * Fired when the secondary button state has changed
  100486. */
  100487. onSecondaryButtonStateChangedObservable: Observable<ExtendedGamepadButton>;
  100488. /**
  100489. * Fired when the pad state has changed
  100490. */
  100491. onPadStateChangedObservable: Observable<ExtendedGamepadButton>;
  100492. /**
  100493. * Fired when controllers stick values have changed
  100494. */
  100495. onPadValuesChangedObservable: Observable<StickValues>;
  100496. /**
  100497. * Array of button availible on the controller
  100498. */
  100499. protected _buttons: Array<MutableGamepadButton>;
  100500. private _onButtonStateChange;
  100501. /**
  100502. * Fired when a controller button's state has changed
  100503. * @param callback the callback containing the button that was modified
  100504. */
  100505. onButtonStateChange(callback: (controlledIndex: number, buttonIndex: number, state: ExtendedGamepadButton) => void): void;
  100506. /**
  100507. * X and Y axis corresponding to the controllers joystick
  100508. */
  100509. pad: StickValues;
  100510. /**
  100511. * 'left' or 'right', see https://w3c.github.io/gamepad/extensions.html#gamepadhand-enum
  100512. */
  100513. hand: string;
  100514. /**
  100515. * The default controller model for the controller
  100516. */
  100517. get defaultModel(): Nullable<AbstractMesh>;
  100518. /**
  100519. * Creates a new WebVRController from a gamepad
  100520. * @param vrGamepad the gamepad that the WebVRController should be created from
  100521. */
  100522. constructor(vrGamepad: any);
  100523. /**
  100524. * Updates the state of the controller and mesh based on the current position and rotation of the controller
  100525. */
  100526. update(): void;
  100527. /**
  100528. * Function to be called when a button is modified
  100529. */
  100530. protected abstract _handleButtonChange(buttonIdx: number, value: ExtendedGamepadButton, changes: GamepadButtonChanges): void;
  100531. /**
  100532. * Loads a mesh and attaches it to the controller
  100533. * @param scene the scene the mesh should be added to
  100534. * @param meshLoaded callback for when the mesh has been loaded
  100535. */
  100536. abstract initControllerMesh(scene: Scene, meshLoaded?: (mesh: AbstractMesh) => void): void;
  100537. private _setButtonValue;
  100538. private _changes;
  100539. private _checkChanges;
  100540. /**
  100541. * Disposes of th webVRCOntroller
  100542. */
  100543. dispose(): void;
  100544. }
  100545. }
  100546. declare module BABYLON {
  100547. /**
  100548. * The HemisphericLight simulates the ambient environment light,
  100549. * so the passed direction is the light reflection direction, not the incoming direction.
  100550. */
  100551. export class HemisphericLight extends Light {
  100552. /**
  100553. * The groundColor is the light in the opposite direction to the one specified during creation.
  100554. * 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.
  100555. */
  100556. groundColor: Color3;
  100557. /**
  100558. * The light reflection direction, not the incoming direction.
  100559. */
  100560. direction: Vector3;
  100561. /**
  100562. * Creates a HemisphericLight object in the scene according to the passed direction (Vector3).
  100563. * The HemisphericLight simulates the ambient environment light, so the passed direction is the light reflection direction, not the incoming direction.
  100564. * The HemisphericLight can't cast shadows.
  100565. * Documentation : https://doc.babylonjs.com/babylon101/lights
  100566. * @param name The friendly name of the light
  100567. * @param direction The direction of the light reflection
  100568. * @param scene The scene the light belongs to
  100569. */
  100570. constructor(name: string, direction: Vector3, scene: Scene);
  100571. protected _buildUniformLayout(): void;
  100572. /**
  100573. * Returns the string "HemisphericLight".
  100574. * @return The class name
  100575. */
  100576. getClassName(): string;
  100577. /**
  100578. * Sets the HemisphericLight direction towards the passed target (Vector3).
  100579. * Returns the updated direction.
  100580. * @param target The target the direction should point to
  100581. * @return The computed direction
  100582. */
  100583. setDirectionToTarget(target: Vector3): Vector3;
  100584. /**
  100585. * Returns the shadow generator associated to the light.
  100586. * @returns Always null for hemispheric lights because it does not support shadows.
  100587. */
  100588. getShadowGenerator(): Nullable<IShadowGenerator>;
  100589. /**
  100590. * Sets the passed Effect object with the HemisphericLight normalized direction and color and the passed name (string).
  100591. * @param effect The effect to update
  100592. * @param lightIndex The index of the light in the effect to update
  100593. * @returns The hemispheric light
  100594. */
  100595. transferToEffect(effect: Effect, lightIndex: string): HemisphericLight;
  100596. transferToNodeMaterialEffect(effect: Effect, lightDataUniformName: string): this;
  100597. /**
  100598. * Computes the world matrix of the node
  100599. * @param force defines if the cache version should be invalidated forcing the world matrix to be created from scratch
  100600. * @param useWasUpdatedFlag defines a reserved property
  100601. * @returns the world matrix
  100602. */
  100603. computeWorldMatrix(): Matrix;
  100604. /**
  100605. * Returns the integer 3.
  100606. * @return The light Type id as a constant defines in Light.LIGHTTYPEID_x
  100607. */
  100608. getTypeID(): number;
  100609. /**
  100610. * Prepares the list of defines specific to the light type.
  100611. * @param defines the list of defines
  100612. * @param lightIndex defines the index of the light for the effect
  100613. */
  100614. prepareLightSpecificDefines(defines: any, lightIndex: number): void;
  100615. }
  100616. }
  100617. declare module BABYLON {
  100618. /** @hidden */
  100619. export var vrMultiviewToSingleviewPixelShader: {
  100620. name: string;
  100621. shader: string;
  100622. };
  100623. }
  100624. declare module BABYLON {
  100625. /**
  100626. * Renders to multiple views with a single draw call
  100627. * @see https://www.khronos.org/registry/webgl/extensions/WEBGL_multiview/
  100628. */
  100629. export class MultiviewRenderTarget extends RenderTargetTexture {
  100630. /**
  100631. * Creates a multiview render target
  100632. * @param scene scene used with the render target
  100633. * @param size the size of the render target (used for each view)
  100634. */
  100635. constructor(scene: Scene, size?: number | {
  100636. width: number;
  100637. height: number;
  100638. } | {
  100639. ratio: number;
  100640. });
  100641. /**
  100642. * @hidden
  100643. * @param faceIndex the face index, if its a cube texture
  100644. */
  100645. _bindFrameBuffer(faceIndex?: number): void;
  100646. /**
  100647. * Gets the number of views the corresponding to the texture (eg. a MultiviewRenderTarget will have > 1)
  100648. * @returns the view count
  100649. */
  100650. getViewCount(): number;
  100651. }
  100652. }
  100653. declare module BABYLON {
  100654. interface Engine {
  100655. /**
  100656. * Creates a new multiview render target
  100657. * @param width defines the width of the texture
  100658. * @param height defines the height of the texture
  100659. * @returns the created multiview texture
  100660. */
  100661. createMultiviewRenderTargetTexture(width: number, height: number): InternalTexture;
  100662. /**
  100663. * Binds a multiview framebuffer to be drawn to
  100664. * @param multiviewTexture texture to bind
  100665. */
  100666. bindMultiviewFramebuffer(multiviewTexture: InternalTexture): void;
  100667. }
  100668. interface Camera {
  100669. /**
  100670. * @hidden
  100671. * 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)
  100672. */
  100673. _useMultiviewToSingleView: boolean;
  100674. /**
  100675. * @hidden
  100676. * 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)
  100677. */
  100678. _multiviewTexture: Nullable<RenderTargetTexture>;
  100679. /**
  100680. * @hidden
  100681. * ensures the multiview texture of the camera exists and has the specified width/height
  100682. * @param width height to set on the multiview texture
  100683. * @param height width to set on the multiview texture
  100684. */
  100685. _resizeOrCreateMultiviewTexture(width: number, height: number): void;
  100686. }
  100687. interface Scene {
  100688. /** @hidden */
  100689. _transformMatrixR: Matrix;
  100690. /** @hidden */
  100691. _multiviewSceneUbo: Nullable<UniformBuffer>;
  100692. /** @hidden */
  100693. _createMultiviewUbo(): void;
  100694. /** @hidden */
  100695. _updateMultiviewUbo(viewR?: Matrix, projectionR?: Matrix): void;
  100696. /** @hidden */
  100697. _renderMultiviewToSingleView(camera: Camera): void;
  100698. }
  100699. }
  100700. declare module BABYLON {
  100701. /**
  100702. * VRMultiviewToSingleview used to convert multiview texture arrays to standard textures for scenarios such as webVR
  100703. * This will not be used for webXR as it supports displaying texture arrays directly
  100704. */
  100705. export class VRMultiviewToSingleviewPostProcess extends PostProcess {
  100706. /**
  100707. * Gets a string identifying the name of the class
  100708. * @returns "VRMultiviewToSingleviewPostProcess" string
  100709. */
  100710. getClassName(): string;
  100711. /**
  100712. * Initializes a VRMultiviewToSingleview
  100713. * @param name name of the post process
  100714. * @param camera camera to be applied to
  100715. * @param scaleFactor scaling factor to the size of the output texture
  100716. */
  100717. constructor(name: string, camera: Camera, scaleFactor: number);
  100718. }
  100719. }
  100720. declare module BABYLON {
  100721. /**
  100722. * Interface used to define additional presentation attributes
  100723. */
  100724. export interface IVRPresentationAttributes {
  100725. /**
  100726. * Defines a boolean indicating that we want to get 72hz mode on Oculus Browser (default is off eg. 60hz)
  100727. */
  100728. highRefreshRate: boolean;
  100729. /**
  100730. * Enables foveation in VR to improve perf. 0 none, 1 low, 2 medium, 3 high (Default is 1)
  100731. */
  100732. foveationLevel: number;
  100733. }
  100734. interface Engine {
  100735. /** @hidden */
  100736. _vrDisplay: any;
  100737. /** @hidden */
  100738. _vrSupported: boolean;
  100739. /** @hidden */
  100740. _oldSize: Size;
  100741. /** @hidden */
  100742. _oldHardwareScaleFactor: number;
  100743. /** @hidden */
  100744. _vrExclusivePointerMode: boolean;
  100745. /** @hidden */
  100746. _webVRInitPromise: Promise<IDisplayChangedEventArgs>;
  100747. /** @hidden */
  100748. _onVRDisplayPointerRestricted: () => void;
  100749. /** @hidden */
  100750. _onVRDisplayPointerUnrestricted: () => void;
  100751. /** @hidden */
  100752. _onVrDisplayConnect: Nullable<(display: any) => void>;
  100753. /** @hidden */
  100754. _onVrDisplayDisconnect: Nullable<() => void>;
  100755. /** @hidden */
  100756. _onVrDisplayPresentChange: Nullable<() => void>;
  100757. /**
  100758. * Observable signaled when VR display mode changes
  100759. */
  100760. onVRDisplayChangedObservable: Observable<IDisplayChangedEventArgs>;
  100761. /**
  100762. * Observable signaled when VR request present is complete
  100763. */
  100764. onVRRequestPresentComplete: Observable<boolean>;
  100765. /**
  100766. * Observable signaled when VR request present starts
  100767. */
  100768. onVRRequestPresentStart: Observable<Engine>;
  100769. /**
  100770. * Gets a boolean indicating that the engine is currently in VR exclusive mode for the pointers
  100771. * @see https://docs.microsoft.com/en-us/microsoft-edge/webvr/essentials#mouse-input
  100772. */
  100773. isInVRExclusivePointerMode: boolean;
  100774. /**
  100775. * Gets a boolean indicating if a webVR device was detected
  100776. * @returns true if a webVR device was detected
  100777. */
  100778. isVRDevicePresent(): boolean;
  100779. /**
  100780. * Gets the current webVR device
  100781. * @returns the current webVR device (or null)
  100782. */
  100783. getVRDevice(): any;
  100784. /**
  100785. * Initializes a webVR display and starts listening to display change events
  100786. * The onVRDisplayChangedObservable will be notified upon these changes
  100787. * @returns A promise containing a VRDisplay and if vr is supported
  100788. */
  100789. initWebVRAsync(): Promise<IDisplayChangedEventArgs>;
  100790. /** @hidden */
  100791. _getVRDisplaysAsync(): Promise<IDisplayChangedEventArgs>;
  100792. /**
  100793. * Gets or sets the presentation attributes used to configure VR rendering
  100794. */
  100795. vrPresentationAttributes?: IVRPresentationAttributes;
  100796. /**
  100797. * Call this function to switch to webVR mode
  100798. * Will do nothing if webVR is not supported or if there is no webVR device
  100799. * @param options the webvr options provided to the camera. mainly used for multiview
  100800. * @see https://doc.babylonjs.com/how_to/webvr_camera
  100801. */
  100802. enableVR(options: WebVROptions): void;
  100803. /** @hidden */
  100804. _onVRFullScreenTriggered(): void;
  100805. }
  100806. }
  100807. declare module BABYLON {
  100808. /**
  100809. * This is a copy of VRPose. See https://developer.mozilla.org/en-US/docs/Web/API/VRPose
  100810. * IMPORTANT!! The data is right-hand data.
  100811. * @export
  100812. * @interface DevicePose
  100813. */
  100814. export interface DevicePose {
  100815. /**
  100816. * The position of the device, values in array are [x,y,z].
  100817. */
  100818. readonly position: Nullable<Float32Array>;
  100819. /**
  100820. * The linearVelocity of the device, values in array are [x,y,z].
  100821. */
  100822. readonly linearVelocity: Nullable<Float32Array>;
  100823. /**
  100824. * The linearAcceleration of the device, values in array are [x,y,z].
  100825. */
  100826. readonly linearAcceleration: Nullable<Float32Array>;
  100827. /**
  100828. * The orientation of the device in a quaternion array, values in array are [x,y,z,w].
  100829. */
  100830. readonly orientation: Nullable<Float32Array>;
  100831. /**
  100832. * The angularVelocity of the device, values in array are [x,y,z].
  100833. */
  100834. readonly angularVelocity: Nullable<Float32Array>;
  100835. /**
  100836. * The angularAcceleration of the device, values in array are [x,y,z].
  100837. */
  100838. readonly angularAcceleration: Nullable<Float32Array>;
  100839. }
  100840. /**
  100841. * Interface representing a pose controlled object in Babylon.
  100842. * A pose controlled object has both regular pose values as well as pose values
  100843. * from an external device such as a VR head mounted display
  100844. */
  100845. export interface PoseControlled {
  100846. /**
  100847. * The position of the object in babylon space.
  100848. */
  100849. position: Vector3;
  100850. /**
  100851. * The rotation quaternion of the object in babylon space.
  100852. */
  100853. rotationQuaternion: Quaternion;
  100854. /**
  100855. * The position of the device in babylon space.
  100856. */
  100857. devicePosition?: Vector3;
  100858. /**
  100859. * The rotation quaternion of the device in babylon space.
  100860. */
  100861. deviceRotationQuaternion: Quaternion;
  100862. /**
  100863. * The raw pose coming from the device.
  100864. */
  100865. rawPose: Nullable<DevicePose>;
  100866. /**
  100867. * The scale of the device to be used when translating from device space to babylon space.
  100868. */
  100869. deviceScaleFactor: number;
  100870. /**
  100871. * Updates the poseControlled values based on the input device pose.
  100872. * @param poseData the pose data to update the object with
  100873. */
  100874. updateFromDevice(poseData: DevicePose): void;
  100875. }
  100876. /**
  100877. * Set of options to customize the webVRCamera
  100878. */
  100879. export interface WebVROptions {
  100880. /**
  100881. * Sets if the webVR camera should be tracked to the vrDevice. (default: true)
  100882. */
  100883. trackPosition?: boolean;
  100884. /**
  100885. * Sets the scale of the vrDevice in babylon space. (default: 1)
  100886. */
  100887. positionScale?: number;
  100888. /**
  100889. * If there are more than one VRDisplays, this will choose the display matching this name. (default: pick first vrDisplay)
  100890. */
  100891. displayName?: string;
  100892. /**
  100893. * Should the native controller meshes be initialized. (default: true)
  100894. */
  100895. controllerMeshes?: boolean;
  100896. /**
  100897. * Creating a default HemiLight only on controllers. (default: true)
  100898. */
  100899. defaultLightingOnControllers?: boolean;
  100900. /**
  100901. * If you don't want to use the default VR button of the helper. (default: false)
  100902. */
  100903. useCustomVRButton?: boolean;
  100904. /**
  100905. * If you'd like to provide your own button to the VRHelper. (default: standard babylon vr button)
  100906. */
  100907. customVRButton?: HTMLButtonElement;
  100908. /**
  100909. * To change the length of the ray for gaze/controllers. Will be scaled by positionScale. (default: 100)
  100910. */
  100911. rayLength?: number;
  100912. /**
  100913. * To change the default offset from the ground to account for user's height in meters. Will be scaled by positionScale. (default: 1.7)
  100914. */
  100915. defaultHeight?: number;
  100916. /**
  100917. * If multiview should be used if availible (default: false)
  100918. */
  100919. useMultiview?: boolean;
  100920. }
  100921. /**
  100922. * This represents a WebVR camera.
  100923. * The WebVR camera is Babylon's simple interface to interaction with Windows Mixed Reality, HTC Vive and Oculus Rift.
  100924. * @example https://doc.babylonjs.com/how_to/webvr_camera
  100925. */
  100926. export class WebVRFreeCamera extends FreeCamera implements PoseControlled {
  100927. private webVROptions;
  100928. /**
  100929. * @hidden
  100930. * The vrDisplay tied to the camera. See https://developer.mozilla.org/en-US/docs/Web/API/VRDisplay
  100931. */
  100932. _vrDevice: any;
  100933. /**
  100934. * The rawPose of the vrDevice.
  100935. */
  100936. rawPose: Nullable<DevicePose>;
  100937. private _onVREnabled;
  100938. private _specsVersion;
  100939. private _attached;
  100940. private _frameData;
  100941. protected _descendants: Array<Node>;
  100942. private _deviceRoomPosition;
  100943. /** @hidden */
  100944. _deviceRoomRotationQuaternion: Quaternion;
  100945. private _standingMatrix;
  100946. /**
  100947. * Represents device position in babylon space.
  100948. */
  100949. devicePosition: Vector3;
  100950. /**
  100951. * Represents device rotation in babylon space.
  100952. */
  100953. deviceRotationQuaternion: Quaternion;
  100954. /**
  100955. * The scale of the device to be used when translating from device space to babylon space.
  100956. */
  100957. deviceScaleFactor: number;
  100958. private _deviceToWorld;
  100959. private _worldToDevice;
  100960. /**
  100961. * References to the webVR controllers for the vrDevice.
  100962. */
  100963. controllers: Array<WebVRController>;
  100964. /**
  100965. * Emits an event when a controller is attached.
  100966. */
  100967. onControllersAttachedObservable: Observable<WebVRController[]>;
  100968. /**
  100969. * Emits an event when a controller's mesh has been loaded;
  100970. */
  100971. onControllerMeshLoadedObservable: Observable<WebVRController>;
  100972. /**
  100973. * Emits an event when the HMD's pose has been updated.
  100974. */
  100975. onPoseUpdatedFromDeviceObservable: Observable<any>;
  100976. private _poseSet;
  100977. /**
  100978. * If the rig cameras be used as parent instead of this camera.
  100979. */
  100980. rigParenting: boolean;
  100981. private _lightOnControllers;
  100982. private _defaultHeight?;
  100983. /**
  100984. * Instantiates a WebVRFreeCamera.
  100985. * @param name The name of the WebVRFreeCamera
  100986. * @param position The starting anchor position for the camera
  100987. * @param scene The scene the camera belongs to
  100988. * @param webVROptions a set of customizable options for the webVRCamera
  100989. */
  100990. constructor(name: string, position: Vector3, scene: Scene, webVROptions?: WebVROptions);
  100991. /**
  100992. * Gets the device distance from the ground in meters.
  100993. * @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.
  100994. */
  100995. deviceDistanceToRoomGround(): number;
  100996. /**
  100997. * Enables the standing matrix when supported. This can be used to position the user's view the correct height from the ground.
  100998. * @param callback will be called when the standing matrix is set. Callback parameter is if the standing matrix is supported.
  100999. */
  101000. useStandingMatrix(callback?: (bool: boolean) => void): void;
  101001. /**
  101002. * Enables the standing matrix when supported. This can be used to position the user's view the correct height from the ground.
  101003. * @returns A promise with a boolean set to if the standing matrix is supported.
  101004. */
  101005. useStandingMatrixAsync(): Promise<boolean>;
  101006. /**
  101007. * Disposes the camera
  101008. */
  101009. dispose(): void;
  101010. /**
  101011. * Gets a vrController by name.
  101012. * @param name The name of the controller to retreive
  101013. * @returns the controller matching the name specified or null if not found
  101014. */
  101015. getControllerByName(name: string): Nullable<WebVRController>;
  101016. private _leftController;
  101017. /**
  101018. * The controller corresponding to the users left hand.
  101019. */
  101020. get leftController(): Nullable<WebVRController>;
  101021. private _rightController;
  101022. /**
  101023. * The controller corresponding to the users right hand.
  101024. */
  101025. get rightController(): Nullable<WebVRController>;
  101026. /**
  101027. * Casts a ray forward from the vrCamera's gaze.
  101028. * @param length Length of the ray (default: 100)
  101029. * @returns the ray corresponding to the gaze
  101030. */
  101031. getForwardRay(length?: number): Ray;
  101032. /**
  101033. * @hidden
  101034. * Updates the camera based on device's frame data
  101035. */
  101036. _checkInputs(): void;
  101037. /**
  101038. * Updates the poseControlled values based on the input device pose.
  101039. * @param poseData Pose coming from the device
  101040. */
  101041. updateFromDevice(poseData: DevicePose): void;
  101042. private _htmlElementAttached;
  101043. private _detachIfAttached;
  101044. /**
  101045. * WebVR's attach control will start broadcasting frames to the device.
  101046. * Note that in certain browsers (chrome for example) this function must be called
  101047. * within a user-interaction callback. Example:
  101048. * <pre> scene.onPointerDown = function() { camera.attachControl(canvas); }</pre>
  101049. *
  101050. * @param element html element to attach the vrDevice to
  101051. * @param noPreventDefault prevent the default html element operation when attaching the vrDevice
  101052. */
  101053. attachControl(element: HTMLElement, noPreventDefault?: boolean): void;
  101054. /**
  101055. * Detaches the camera from the html element and disables VR
  101056. *
  101057. * @param element html element to detach from
  101058. */
  101059. detachControl(element: HTMLElement): void;
  101060. /**
  101061. * @returns the name of this class
  101062. */
  101063. getClassName(): string;
  101064. /**
  101065. * Calls resetPose on the vrDisplay
  101066. * See: https://developer.mozilla.org/en-US/docs/Web/API/VRDisplay/resetPose
  101067. */
  101068. resetToCurrentRotation(): void;
  101069. /**
  101070. * @hidden
  101071. * Updates the rig cameras (left and right eye)
  101072. */
  101073. _updateRigCameras(): void;
  101074. private _workingVector;
  101075. private _oneVector;
  101076. private _workingMatrix;
  101077. private updateCacheCalled;
  101078. private _correctPositionIfNotTrackPosition;
  101079. /**
  101080. * @hidden
  101081. * Updates the cached values of the camera
  101082. * @param ignoreParentClass ignores updating the parent class's cache (default: false)
  101083. */
  101084. _updateCache(ignoreParentClass?: boolean): void;
  101085. /**
  101086. * @hidden
  101087. * Get current device position in babylon world
  101088. */
  101089. _computeDevicePosition(): void;
  101090. /**
  101091. * Updates the current device position and rotation in the babylon world
  101092. */
  101093. update(): void;
  101094. /**
  101095. * @hidden
  101096. * Gets the view matrix of this camera (Always set to identity as left and right eye cameras contain the actual view matrix)
  101097. * @returns an identity matrix
  101098. */
  101099. _getViewMatrix(): Matrix;
  101100. private _tmpMatrix;
  101101. /**
  101102. * This function is called by the two RIG cameras.
  101103. * 'this' is the left or right camera (and NOT (!!!) the WebVRFreeCamera instance)
  101104. * @hidden
  101105. */
  101106. _getWebVRViewMatrix(): Matrix;
  101107. /** @hidden */
  101108. _getWebVRProjectionMatrix(): Matrix;
  101109. private _onGamepadConnectedObserver;
  101110. private _onGamepadDisconnectedObserver;
  101111. private _updateCacheWhenTrackingDisabledObserver;
  101112. /**
  101113. * Initializes the controllers and their meshes
  101114. */
  101115. initControllers(): void;
  101116. }
  101117. }
  101118. declare module BABYLON {
  101119. /**
  101120. * "Static Class" containing the most commonly used helper while dealing with material for rendering purpose.
  101121. *
  101122. * It contains the basic tools to help defining defines, binding uniform for the common part of the materials.
  101123. *
  101124. * This works by convention in BabylonJS but is meant to be use only with shader following the in place naming rules and conventions.
  101125. */
  101126. export class MaterialHelper {
  101127. /**
  101128. * Bind the current view position to an effect.
  101129. * @param effect The effect to be bound
  101130. * @param scene The scene the eyes position is used from
  101131. * @param variableName name of the shader variable that will hold the eye position
  101132. */
  101133. static BindEyePosition(effect: Effect, scene: Scene, variableName?: string): void;
  101134. /**
  101135. * Helps preparing the defines values about the UVs in used in the effect.
  101136. * UVs are shared as much as we can accross channels in the shaders.
  101137. * @param texture The texture we are preparing the UVs for
  101138. * @param defines The defines to update
  101139. * @param key The channel key "diffuse", "specular"... used in the shader
  101140. */
  101141. static PrepareDefinesForMergedUV(texture: BaseTexture, defines: any, key: string): void;
  101142. /**
  101143. * Binds a texture matrix value to its corrsponding uniform
  101144. * @param texture The texture to bind the matrix for
  101145. * @param uniformBuffer The uniform buffer receivin the data
  101146. * @param key The channel key "diffuse", "specular"... used in the shader
  101147. */
  101148. static BindTextureMatrix(texture: BaseTexture, uniformBuffer: UniformBuffer, key: string): void;
  101149. /**
  101150. * Gets the current status of the fog (should it be enabled?)
  101151. * @param mesh defines the mesh to evaluate for fog support
  101152. * @param scene defines the hosting scene
  101153. * @returns true if fog must be enabled
  101154. */
  101155. static GetFogState(mesh: AbstractMesh, scene: Scene): boolean;
  101156. /**
  101157. * Helper used to prepare the list of defines associated with misc. values for shader compilation
  101158. * @param mesh defines the current mesh
  101159. * @param scene defines the current scene
  101160. * @param useLogarithmicDepth defines if logarithmic depth has to be turned on
  101161. * @param pointsCloud defines if point cloud rendering has to be turned on
  101162. * @param fogEnabled defines if fog has to be turned on
  101163. * @param alphaTest defines if alpha testing has to be turned on
  101164. * @param defines defines the current list of defines
  101165. */
  101166. static PrepareDefinesForMisc(mesh: AbstractMesh, scene: Scene, useLogarithmicDepth: boolean, pointsCloud: boolean, fogEnabled: boolean, alphaTest: boolean, defines: any): void;
  101167. /**
  101168. * Helper used to prepare the list of defines associated with frame values for shader compilation
  101169. * @param scene defines the current scene
  101170. * @param engine defines the current engine
  101171. * @param defines specifies the list of active defines
  101172. * @param useInstances defines if instances have to be turned on
  101173. * @param useClipPlane defines if clip plane have to be turned on
  101174. * @param useInstances defines if instances have to be turned on
  101175. * @param useThinInstances defines if thin instances have to be turned on
  101176. */
  101177. static PrepareDefinesForFrameBoundValues(scene: Scene, engine: Engine, defines: any, useInstances: boolean, useClipPlane?: Nullable<boolean>, useThinInstances?: boolean): void;
  101178. /**
  101179. * Prepares the defines for bones
  101180. * @param mesh The mesh containing the geometry data we will draw
  101181. * @param defines The defines to update
  101182. */
  101183. static PrepareDefinesForBones(mesh: AbstractMesh, defines: any): void;
  101184. /**
  101185. * Prepares the defines for morph targets
  101186. * @param mesh The mesh containing the geometry data we will draw
  101187. * @param defines The defines to update
  101188. */
  101189. static PrepareDefinesForMorphTargets(mesh: AbstractMesh, defines: any): void;
  101190. /**
  101191. * Prepares the defines used in the shader depending on the attributes data available in the mesh
  101192. * @param mesh The mesh containing the geometry data we will draw
  101193. * @param defines The defines to update
  101194. * @param useVertexColor Precise whether vertex colors should be used or not (override mesh info)
  101195. * @param useBones Precise whether bones should be used or not (override mesh info)
  101196. * @param useMorphTargets Precise whether morph targets should be used or not (override mesh info)
  101197. * @param useVertexAlpha Precise whether vertex alpha should be used or not (override mesh info)
  101198. * @returns false if defines are considered not dirty and have not been checked
  101199. */
  101200. static PrepareDefinesForAttributes(mesh: AbstractMesh, defines: any, useVertexColor: boolean, useBones: boolean, useMorphTargets?: boolean, useVertexAlpha?: boolean): boolean;
  101201. /**
  101202. * Prepares the defines related to multiview
  101203. * @param scene The scene we are intending to draw
  101204. * @param defines The defines to update
  101205. */
  101206. static PrepareDefinesForMultiview(scene: Scene, defines: any): void;
  101207. /**
  101208. * Prepares the defines related to the prepass
  101209. * @param scene The scene we are intending to draw
  101210. * @param defines The defines to update
  101211. * @param canRenderToMRT Indicates if this material renders to several textures in the prepass
  101212. */
  101213. static PrepareDefinesForPrePass(scene: Scene, defines: any, canRenderToMRT: boolean): void;
  101214. /**
  101215. * Prepares the defines related to the light information passed in parameter
  101216. * @param scene The scene we are intending to draw
  101217. * @param mesh The mesh the effect is compiling for
  101218. * @param light The light the effect is compiling for
  101219. * @param lightIndex The index of the light
  101220. * @param defines The defines to update
  101221. * @param specularSupported Specifies whether specular is supported or not (override lights data)
  101222. * @param state Defines the current state regarding what is needed (normals, etc...)
  101223. */
  101224. static PrepareDefinesForLight(scene: Scene, mesh: AbstractMesh, light: Light, lightIndex: number, defines: any, specularSupported: boolean, state: {
  101225. needNormals: boolean;
  101226. needRebuild: boolean;
  101227. shadowEnabled: boolean;
  101228. specularEnabled: boolean;
  101229. lightmapMode: boolean;
  101230. }): void;
  101231. /**
  101232. * Prepares the defines related to the light information passed in parameter
  101233. * @param scene The scene we are intending to draw
  101234. * @param mesh The mesh the effect is compiling for
  101235. * @param defines The defines to update
  101236. * @param specularSupported Specifies whether specular is supported or not (override lights data)
  101237. * @param maxSimultaneousLights Specfies how manuy lights can be added to the effect at max
  101238. * @param disableLighting Specifies whether the lighting is disabled (override scene and light)
  101239. * @returns true if normals will be required for the rest of the effect
  101240. */
  101241. static PrepareDefinesForLights(scene: Scene, mesh: AbstractMesh, defines: any, specularSupported: boolean, maxSimultaneousLights?: number, disableLighting?: boolean): boolean;
  101242. /**
  101243. * Prepares the uniforms and samplers list to be used in the effect (for a specific light)
  101244. * @param lightIndex defines the light index
  101245. * @param uniformsList The uniform list
  101246. * @param samplersList The sampler list
  101247. * @param projectedLightTexture defines if projected texture must be used
  101248. * @param uniformBuffersList defines an optional list of uniform buffers
  101249. */
  101250. static PrepareUniformsAndSamplersForLight(lightIndex: number, uniformsList: string[], samplersList: string[], projectedLightTexture?: any, uniformBuffersList?: Nullable<string[]>): void;
  101251. /**
  101252. * Prepares the uniforms and samplers list to be used in the effect
  101253. * @param uniformsListOrOptions The uniform names to prepare or an EffectCreationOptions containing the liist and extra information
  101254. * @param samplersList The sampler list
  101255. * @param defines The defines helping in the list generation
  101256. * @param maxSimultaneousLights The maximum number of simultanous light allowed in the effect
  101257. */
  101258. static PrepareUniformsAndSamplersList(uniformsListOrOptions: string[] | IEffectCreationOptions, samplersList?: string[], defines?: any, maxSimultaneousLights?: number): void;
  101259. /**
  101260. * This helps decreasing rank by rank the shadow quality (0 being the highest rank and quality)
  101261. * @param defines The defines to update while falling back
  101262. * @param fallbacks The authorized effect fallbacks
  101263. * @param maxSimultaneousLights The maximum number of lights allowed
  101264. * @param rank the current rank of the Effect
  101265. * @returns The newly affected rank
  101266. */
  101267. static HandleFallbacksForShadows(defines: any, fallbacks: EffectFallbacks, maxSimultaneousLights?: number, rank?: number): number;
  101268. private static _TmpMorphInfluencers;
  101269. /**
  101270. * Prepares the list of attributes required for morph targets according to the effect defines.
  101271. * @param attribs The current list of supported attribs
  101272. * @param mesh The mesh to prepare the morph targets attributes for
  101273. * @param influencers The number of influencers
  101274. */
  101275. static PrepareAttributesForMorphTargetsInfluencers(attribs: string[], mesh: AbstractMesh, influencers: number): void;
  101276. /**
  101277. * Prepares the list of attributes required for morph targets according to the effect defines.
  101278. * @param attribs The current list of supported attribs
  101279. * @param mesh The mesh to prepare the morph targets attributes for
  101280. * @param defines The current Defines of the effect
  101281. */
  101282. static PrepareAttributesForMorphTargets(attribs: string[], mesh: AbstractMesh, defines: any): void;
  101283. /**
  101284. * Prepares the list of attributes required for bones according to the effect defines.
  101285. * @param attribs The current list of supported attribs
  101286. * @param mesh The mesh to prepare the bones attributes for
  101287. * @param defines The current Defines of the effect
  101288. * @param fallbacks The current efffect fallback strategy
  101289. */
  101290. static PrepareAttributesForBones(attribs: string[], mesh: AbstractMesh, defines: any, fallbacks: EffectFallbacks): void;
  101291. /**
  101292. * Check and prepare the list of attributes required for instances according to the effect defines.
  101293. * @param attribs The current list of supported attribs
  101294. * @param defines The current MaterialDefines of the effect
  101295. */
  101296. static PrepareAttributesForInstances(attribs: string[], defines: MaterialDefines): void;
  101297. /**
  101298. * Add the list of attributes required for instances to the attribs array.
  101299. * @param attribs The current list of supported attribs
  101300. */
  101301. static PushAttributesForInstances(attribs: string[]): void;
  101302. /**
  101303. * Binds the light information to the effect.
  101304. * @param light The light containing the generator
  101305. * @param effect The effect we are binding the data to
  101306. * @param lightIndex The light index in the effect used to render
  101307. */
  101308. static BindLightProperties(light: Light, effect: Effect, lightIndex: number): void;
  101309. /**
  101310. * Binds the lights information from the scene to the effect for the given mesh.
  101311. * @param light Light to bind
  101312. * @param lightIndex Light index
  101313. * @param scene The scene where the light belongs to
  101314. * @param effect The effect we are binding the data to
  101315. * @param useSpecular Defines if specular is supported
  101316. * @param rebuildInParallel Specifies whether the shader is rebuilding in parallel
  101317. */
  101318. static BindLight(light: Light, lightIndex: number, scene: Scene, effect: Effect, useSpecular: boolean, rebuildInParallel?: boolean): void;
  101319. /**
  101320. * Binds the lights information from the scene to the effect for the given mesh.
  101321. * @param scene The scene the lights belongs to
  101322. * @param mesh The mesh we are binding the information to render
  101323. * @param effect The effect we are binding the data to
  101324. * @param defines The generated defines for the effect
  101325. * @param maxSimultaneousLights The maximum number of light that can be bound to the effect
  101326. * @param rebuildInParallel Specifies whether the shader is rebuilding in parallel
  101327. */
  101328. static BindLights(scene: Scene, mesh: AbstractMesh, effect: Effect, defines: any, maxSimultaneousLights?: number, rebuildInParallel?: boolean): void;
  101329. private static _tempFogColor;
  101330. /**
  101331. * Binds the fog information from the scene to the effect for the given mesh.
  101332. * @param scene The scene the lights belongs to
  101333. * @param mesh The mesh we are binding the information to render
  101334. * @param effect The effect we are binding the data to
  101335. * @param linearSpace Defines if the fog effect is applied in linear space
  101336. */
  101337. static BindFogParameters(scene: Scene, mesh: AbstractMesh, effect: Effect, linearSpace?: boolean): void;
  101338. /**
  101339. * Binds the bones information from the mesh to the effect.
  101340. * @param mesh The mesh we are binding the information to render
  101341. * @param effect The effect we are binding the data to
  101342. * @param prePassConfiguration Configuration for the prepass, in case prepass is activated
  101343. */
  101344. static BindBonesParameters(mesh?: AbstractMesh, effect?: Effect, prePassConfiguration?: PrePassConfiguration): void;
  101345. private static _CopyBonesTransformationMatrices;
  101346. /**
  101347. * Binds the morph targets information from the mesh to the effect.
  101348. * @param abstractMesh The mesh we are binding the information to render
  101349. * @param effect The effect we are binding the data to
  101350. */
  101351. static BindMorphTargetParameters(abstractMesh: AbstractMesh, effect: Effect): void;
  101352. /**
  101353. * Binds the logarithmic depth information from the scene to the effect for the given defines.
  101354. * @param defines The generated defines used in the effect
  101355. * @param effect The effect we are binding the data to
  101356. * @param scene The scene we are willing to render with logarithmic scale for
  101357. */
  101358. static BindLogDepth(defines: any, effect: Effect, scene: Scene): void;
  101359. /**
  101360. * Binds the clip plane information from the scene to the effect.
  101361. * @param scene The scene the clip plane information are extracted from
  101362. * @param effect The effect we are binding the data to
  101363. */
  101364. static BindClipPlane(effect: Effect, scene: Scene): void;
  101365. }
  101366. }
  101367. declare module BABYLON {
  101368. /**
  101369. * Block used to expose an input value
  101370. */
  101371. export class InputBlock extends NodeMaterialBlock {
  101372. private _mode;
  101373. private _associatedVariableName;
  101374. private _storedValue;
  101375. private _valueCallback;
  101376. private _type;
  101377. private _animationType;
  101378. /** Gets or set a value used to limit the range of float values */
  101379. min: number;
  101380. /** Gets or set a value used to limit the range of float values */
  101381. max: number;
  101382. /** Gets or set a value indicating that this input can only get 0 and 1 values */
  101383. isBoolean: boolean;
  101384. /** Gets or sets a value used by the Node Material editor to determine how to configure the current value if it is a matrix */
  101385. matrixMode: number;
  101386. /** @hidden */
  101387. _systemValue: Nullable<NodeMaterialSystemValues>;
  101388. /** Gets or sets a boolean indicating that the value of this input will not change after a build */
  101389. isConstant: boolean;
  101390. /** Gets or sets the group to use to display this block in the Inspector */
  101391. groupInInspector: string;
  101392. /** Gets an observable raised when the value is changed */
  101393. onValueChangedObservable: Observable<InputBlock>;
  101394. /**
  101395. * Gets or sets the connection point type (default is float)
  101396. */
  101397. get type(): NodeMaterialBlockConnectionPointTypes;
  101398. /**
  101399. * Creates a new InputBlock
  101400. * @param name defines the block name
  101401. * @param target defines the target of that block (Vertex by default)
  101402. * @param type defines the type of the input (can be set to NodeMaterialBlockConnectionPointTypes.AutoDetect)
  101403. */
  101404. constructor(name: string, target?: NodeMaterialBlockTargets, type?: NodeMaterialBlockConnectionPointTypes);
  101405. /**
  101406. * Validates if a name is a reserve word.
  101407. * @param newName the new name to be given to the node.
  101408. * @returns false if the name is a reserve word, else true.
  101409. */
  101410. validateBlockName(newName: string): boolean;
  101411. /**
  101412. * Gets the output component
  101413. */
  101414. get output(): NodeMaterialConnectionPoint;
  101415. /**
  101416. * Set the source of this connection point to a vertex attribute
  101417. * @param attributeName defines the attribute name (position, uv, normal, etc...). If not specified it will take the connection point name
  101418. * @returns the current connection point
  101419. */
  101420. setAsAttribute(attributeName?: string): InputBlock;
  101421. /**
  101422. * Set the source of this connection point to a system value
  101423. * @param value define the system value to use (world, view, etc...) or null to switch to manual value
  101424. * @returns the current connection point
  101425. */
  101426. setAsSystemValue(value: Nullable<NodeMaterialSystemValues>): InputBlock;
  101427. /**
  101428. * Gets or sets the value of that point.
  101429. * Please note that this value will be ignored if valueCallback is defined
  101430. */
  101431. get value(): any;
  101432. set value(value: any);
  101433. /**
  101434. * Gets or sets a callback used to get the value of that point.
  101435. * Please note that setting this value will force the connection point to ignore the value property
  101436. */
  101437. get valueCallback(): () => any;
  101438. set valueCallback(value: () => any);
  101439. /**
  101440. * Gets or sets the associated variable name in the shader
  101441. */
  101442. get associatedVariableName(): string;
  101443. set associatedVariableName(value: string);
  101444. /** Gets or sets the type of animation applied to the input */
  101445. get animationType(): AnimatedInputBlockTypes;
  101446. set animationType(value: AnimatedInputBlockTypes);
  101447. /**
  101448. * Gets a boolean indicating that this connection point not defined yet
  101449. */
  101450. get isUndefined(): boolean;
  101451. /**
  101452. * Gets or sets a boolean indicating that this connection point is coming from an uniform.
  101453. * In this case the connection point name must be the name of the uniform to use.
  101454. * Can only be set on inputs
  101455. */
  101456. get isUniform(): boolean;
  101457. set isUniform(value: boolean);
  101458. /**
  101459. * Gets or sets a boolean indicating that this connection point is coming from an attribute.
  101460. * In this case the connection point name must be the name of the attribute to use
  101461. * Can only be set on inputs
  101462. */
  101463. get isAttribute(): boolean;
  101464. set isAttribute(value: boolean);
  101465. /**
  101466. * Gets or sets a boolean indicating that this connection point is generating a varying variable.
  101467. * Can only be set on exit points
  101468. */
  101469. get isVarying(): boolean;
  101470. set isVarying(value: boolean);
  101471. /**
  101472. * Gets a boolean indicating that the current connection point is a system value
  101473. */
  101474. get isSystemValue(): boolean;
  101475. /**
  101476. * Gets or sets the current well known value or null if not defined as a system value
  101477. */
  101478. get systemValue(): Nullable<NodeMaterialSystemValues>;
  101479. set systemValue(value: Nullable<NodeMaterialSystemValues>);
  101480. /**
  101481. * Gets the current class name
  101482. * @returns the class name
  101483. */
  101484. getClassName(): string;
  101485. /**
  101486. * Animate the input if animationType !== None
  101487. * @param scene defines the rendering scene
  101488. */
  101489. animate(scene: Scene): void;
  101490. private _emitDefine;
  101491. initialize(state: NodeMaterialBuildState): void;
  101492. /**
  101493. * Set the input block to its default value (based on its type)
  101494. */
  101495. setDefaultValue(): void;
  101496. private _emitConstant;
  101497. /** @hidden */
  101498. get _noContextSwitch(): boolean;
  101499. private _emit;
  101500. /** @hidden */
  101501. _transmitWorld(effect: Effect, world: Matrix, worldView: Matrix, worldViewProjection: Matrix): void;
  101502. /** @hidden */
  101503. _transmit(effect: Effect, scene: Scene): void;
  101504. protected _buildBlock(state: NodeMaterialBuildState): void;
  101505. protected _dumpPropertiesCode(): string;
  101506. dispose(): void;
  101507. serialize(): any;
  101508. _deserialize(serializationObject: any, scene: Scene, rootUrl: string): void;
  101509. }
  101510. }
  101511. declare module BABYLON {
  101512. /**
  101513. * Enum used to define the compatibility state between two connection points
  101514. */
  101515. export enum NodeMaterialConnectionPointCompatibilityStates {
  101516. /** Points are compatibles */
  101517. Compatible = 0,
  101518. /** Points are incompatible because of their types */
  101519. TypeIncompatible = 1,
  101520. /** Points are incompatible because of their targets (vertex vs fragment) */
  101521. TargetIncompatible = 2
  101522. }
  101523. /**
  101524. * Defines the direction of a connection point
  101525. */
  101526. export enum NodeMaterialConnectionPointDirection {
  101527. /** Input */
  101528. Input = 0,
  101529. /** Output */
  101530. Output = 1
  101531. }
  101532. /**
  101533. * Defines a connection point for a block
  101534. */
  101535. export class NodeMaterialConnectionPoint {
  101536. /** @hidden */
  101537. _ownerBlock: NodeMaterialBlock;
  101538. /** @hidden */
  101539. _connectedPoint: Nullable<NodeMaterialConnectionPoint>;
  101540. private _endpoints;
  101541. private _associatedVariableName;
  101542. private _direction;
  101543. /** @hidden */
  101544. _typeConnectionSource: Nullable<NodeMaterialConnectionPoint>;
  101545. /** @hidden */
  101546. _linkedConnectionSource: Nullable<NodeMaterialConnectionPoint>;
  101547. private _type;
  101548. /** @hidden */
  101549. _enforceAssociatedVariableName: boolean;
  101550. /** Gets the direction of the point */
  101551. get direction(): NodeMaterialConnectionPointDirection;
  101552. /** Indicates that this connection point needs dual validation before being connected to another point */
  101553. needDualDirectionValidation: boolean;
  101554. /**
  101555. * Gets or sets the additional types supported by this connection point
  101556. */
  101557. acceptedConnectionPointTypes: NodeMaterialBlockConnectionPointTypes[];
  101558. /**
  101559. * Gets or sets the additional types excluded by this connection point
  101560. */
  101561. excludedConnectionPointTypes: NodeMaterialBlockConnectionPointTypes[];
  101562. /**
  101563. * Observable triggered when this point is connected
  101564. */
  101565. onConnectionObservable: Observable<NodeMaterialConnectionPoint>;
  101566. /**
  101567. * Gets or sets the associated variable name in the shader
  101568. */
  101569. get associatedVariableName(): string;
  101570. set associatedVariableName(value: string);
  101571. /** Get the inner type (ie AutoDetect for instance instead of the inferred one) */
  101572. get innerType(): NodeMaterialBlockConnectionPointTypes;
  101573. /**
  101574. * Gets or sets the connection point type (default is float)
  101575. */
  101576. get type(): NodeMaterialBlockConnectionPointTypes;
  101577. set type(value: NodeMaterialBlockConnectionPointTypes);
  101578. /**
  101579. * Gets or sets the connection point name
  101580. */
  101581. name: string;
  101582. /**
  101583. * Gets or sets the connection point name
  101584. */
  101585. displayName: string;
  101586. /**
  101587. * Gets or sets a boolean indicating that this connection point can be omitted
  101588. */
  101589. isOptional: boolean;
  101590. /**
  101591. * Gets or sets a boolean indicating that this connection point is exposed on a frame
  101592. */
  101593. isExposedOnFrame: boolean;
  101594. /**
  101595. * Gets or sets number indicating the position that the port is exposed to on a frame
  101596. */
  101597. exposedPortPosition: number;
  101598. /**
  101599. * Gets or sets a string indicating that this uniform must be defined under a #ifdef
  101600. */
  101601. define: string;
  101602. /** @hidden */
  101603. _prioritizeVertex: boolean;
  101604. private _target;
  101605. /** Gets or sets the target of that connection point */
  101606. get target(): NodeMaterialBlockTargets;
  101607. set target(value: NodeMaterialBlockTargets);
  101608. /**
  101609. * Gets a boolean indicating that the current point is connected to another NodeMaterialBlock
  101610. */
  101611. get isConnected(): boolean;
  101612. /**
  101613. * Gets a boolean indicating that the current point is connected to an input block
  101614. */
  101615. get isConnectedToInputBlock(): boolean;
  101616. /**
  101617. * Gets a the connected input block (if any)
  101618. */
  101619. get connectInputBlock(): Nullable<InputBlock>;
  101620. /** Get the other side of the connection (if any) */
  101621. get connectedPoint(): Nullable<NodeMaterialConnectionPoint>;
  101622. /** Get the block that owns this connection point */
  101623. get ownerBlock(): NodeMaterialBlock;
  101624. /** Get the block connected on the other side of this connection (if any) */
  101625. get sourceBlock(): Nullable<NodeMaterialBlock>;
  101626. /** Get the block connected on the endpoints of this connection (if any) */
  101627. get connectedBlocks(): Array<NodeMaterialBlock>;
  101628. /** Gets the list of connected endpoints */
  101629. get endpoints(): NodeMaterialConnectionPoint[];
  101630. /** Gets a boolean indicating if that output point is connected to at least one input */
  101631. get hasEndpoints(): boolean;
  101632. /** Gets a boolean indicating that this connection will be used in the vertex shader */
  101633. get isConnectedInVertexShader(): boolean;
  101634. /** Gets a boolean indicating that this connection will be used in the fragment shader */
  101635. get isConnectedInFragmentShader(): boolean;
  101636. /**
  101637. * Creates a block suitable to be used as an input for this input point.
  101638. * If null is returned, a block based on the point type will be created.
  101639. * @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
  101640. */
  101641. createCustomInputBlock(): Nullable<[NodeMaterialBlock, string]>;
  101642. /**
  101643. * Creates a new connection point
  101644. * @param name defines the connection point name
  101645. * @param ownerBlock defines the block hosting this connection point
  101646. * @param direction defines the direction of the connection point
  101647. */
  101648. constructor(name: string, ownerBlock: NodeMaterialBlock, direction: NodeMaterialConnectionPointDirection);
  101649. /**
  101650. * Gets the current class name e.g. "NodeMaterialConnectionPoint"
  101651. * @returns the class name
  101652. */
  101653. getClassName(): string;
  101654. /**
  101655. * Gets a boolean indicating if the current point can be connected to another point
  101656. * @param connectionPoint defines the other connection point
  101657. * @returns a boolean
  101658. */
  101659. canConnectTo(connectionPoint: NodeMaterialConnectionPoint): boolean;
  101660. /**
  101661. * Gets a number indicating if the current point can be connected to another point
  101662. * @param connectionPoint defines the other connection point
  101663. * @returns a number defining the compatibility state
  101664. */
  101665. checkCompatibilityState(connectionPoint: NodeMaterialConnectionPoint): NodeMaterialConnectionPointCompatibilityStates;
  101666. /**
  101667. * Connect this point to another connection point
  101668. * @param connectionPoint defines the other connection point
  101669. * @param ignoreConstraints defines if the system will ignore connection type constraints (default is false)
  101670. * @returns the current connection point
  101671. */
  101672. connectTo(connectionPoint: NodeMaterialConnectionPoint, ignoreConstraints?: boolean): NodeMaterialConnectionPoint;
  101673. /**
  101674. * Disconnect this point from one of his endpoint
  101675. * @param endpoint defines the other connection point
  101676. * @returns the current connection point
  101677. */
  101678. disconnectFrom(endpoint: NodeMaterialConnectionPoint): NodeMaterialConnectionPoint;
  101679. /**
  101680. * Serializes this point in a JSON representation
  101681. * @param isInput defines if the connection point is an input (default is true)
  101682. * @returns the serialized point object
  101683. */
  101684. serialize(isInput?: boolean): any;
  101685. /**
  101686. * Release resources
  101687. */
  101688. dispose(): void;
  101689. }
  101690. }
  101691. declare module BABYLON {
  101692. /**
  101693. * Enum used to define the material modes
  101694. */
  101695. export enum NodeMaterialModes {
  101696. /** Regular material */
  101697. Material = 0,
  101698. /** For post process */
  101699. PostProcess = 1,
  101700. /** For particle system */
  101701. Particle = 2,
  101702. /** For procedural texture */
  101703. ProceduralTexture = 3
  101704. }
  101705. }
  101706. declare module BABYLON {
  101707. /**
  101708. * Block used to read a texture from a sampler
  101709. */
  101710. export class TextureBlock extends NodeMaterialBlock {
  101711. private _defineName;
  101712. private _linearDefineName;
  101713. private _gammaDefineName;
  101714. private _tempTextureRead;
  101715. private _samplerName;
  101716. private _transformedUVName;
  101717. private _textureTransformName;
  101718. private _textureInfoName;
  101719. private _mainUVName;
  101720. private _mainUVDefineName;
  101721. private _fragmentOnly;
  101722. /**
  101723. * Gets or sets the texture associated with the node
  101724. */
  101725. texture: Nullable<Texture>;
  101726. /**
  101727. * Gets or sets a boolean indicating if content needs to be converted to gamma space
  101728. */
  101729. convertToGammaSpace: boolean;
  101730. /**
  101731. * Gets or sets a boolean indicating if content needs to be converted to linear space
  101732. */
  101733. convertToLinearSpace: boolean;
  101734. /**
  101735. * Create a new TextureBlock
  101736. * @param name defines the block name
  101737. */
  101738. constructor(name: string, fragmentOnly?: boolean);
  101739. /**
  101740. * Gets the current class name
  101741. * @returns the class name
  101742. */
  101743. getClassName(): string;
  101744. /**
  101745. * Gets the uv input component
  101746. */
  101747. get uv(): NodeMaterialConnectionPoint;
  101748. /**
  101749. * Gets the rgba output component
  101750. */
  101751. get rgba(): NodeMaterialConnectionPoint;
  101752. /**
  101753. * Gets the rgb output component
  101754. */
  101755. get rgb(): NodeMaterialConnectionPoint;
  101756. /**
  101757. * Gets the r output component
  101758. */
  101759. get r(): NodeMaterialConnectionPoint;
  101760. /**
  101761. * Gets the g output component
  101762. */
  101763. get g(): NodeMaterialConnectionPoint;
  101764. /**
  101765. * Gets the b output component
  101766. */
  101767. get b(): NodeMaterialConnectionPoint;
  101768. /**
  101769. * Gets the a output component
  101770. */
  101771. get a(): NodeMaterialConnectionPoint;
  101772. get target(): NodeMaterialBlockTargets;
  101773. autoConfigure(material: NodeMaterial): void;
  101774. initializeDefines(mesh: AbstractMesh, nodeMaterial: NodeMaterial, defines: NodeMaterialDefines, useInstances?: boolean): void;
  101775. prepareDefines(mesh: AbstractMesh, nodeMaterial: NodeMaterial, defines: NodeMaterialDefines): void;
  101776. isReady(): boolean;
  101777. bind(effect: Effect, nodeMaterial: NodeMaterial, mesh?: Mesh): void;
  101778. private get _isMixed();
  101779. private _injectVertexCode;
  101780. private _writeTextureRead;
  101781. private _writeOutput;
  101782. protected _buildBlock(state: NodeMaterialBuildState): this | undefined;
  101783. protected _dumpPropertiesCode(): string;
  101784. serialize(): any;
  101785. _deserialize(serializationObject: any, scene: Scene, rootUrl: string): void;
  101786. }
  101787. }
  101788. declare module BABYLON {
  101789. /** @hidden */
  101790. export var reflectionFunction: {
  101791. name: string;
  101792. shader: string;
  101793. };
  101794. }
  101795. declare module BABYLON {
  101796. /**
  101797. * Base block used to read a reflection texture from a sampler
  101798. */
  101799. export abstract class ReflectionTextureBaseBlock extends NodeMaterialBlock {
  101800. /** @hidden */
  101801. _define3DName: string;
  101802. /** @hidden */
  101803. _defineCubicName: string;
  101804. /** @hidden */
  101805. _defineExplicitName: string;
  101806. /** @hidden */
  101807. _defineProjectionName: string;
  101808. /** @hidden */
  101809. _defineLocalCubicName: string;
  101810. /** @hidden */
  101811. _defineSphericalName: string;
  101812. /** @hidden */
  101813. _definePlanarName: string;
  101814. /** @hidden */
  101815. _defineEquirectangularName: string;
  101816. /** @hidden */
  101817. _defineMirroredEquirectangularFixedName: string;
  101818. /** @hidden */
  101819. _defineEquirectangularFixedName: string;
  101820. /** @hidden */
  101821. _defineSkyboxName: string;
  101822. /** @hidden */
  101823. _defineOppositeZ: string;
  101824. /** @hidden */
  101825. _cubeSamplerName: string;
  101826. /** @hidden */
  101827. _2DSamplerName: string;
  101828. protected _positionUVWName: string;
  101829. protected _directionWName: string;
  101830. protected _reflectionVectorName: string;
  101831. /** @hidden */
  101832. _reflectionCoordsName: string;
  101833. /** @hidden */
  101834. _reflectionMatrixName: string;
  101835. protected _reflectionColorName: string;
  101836. /**
  101837. * Gets or sets the texture associated with the node
  101838. */
  101839. texture: Nullable<BaseTexture>;
  101840. /**
  101841. * Create a new ReflectionTextureBaseBlock
  101842. * @param name defines the block name
  101843. */
  101844. constructor(name: string);
  101845. /**
  101846. * Gets the current class name
  101847. * @returns the class name
  101848. */
  101849. getClassName(): string;
  101850. /**
  101851. * Gets the world position input component
  101852. */
  101853. abstract get position(): NodeMaterialConnectionPoint;
  101854. /**
  101855. * Gets the world position input component
  101856. */
  101857. abstract get worldPosition(): NodeMaterialConnectionPoint;
  101858. /**
  101859. * Gets the world normal input component
  101860. */
  101861. abstract get worldNormal(): NodeMaterialConnectionPoint;
  101862. /**
  101863. * Gets the world input component
  101864. */
  101865. abstract get world(): NodeMaterialConnectionPoint;
  101866. /**
  101867. * Gets the camera (or eye) position component
  101868. */
  101869. abstract get cameraPosition(): NodeMaterialConnectionPoint;
  101870. /**
  101871. * Gets the view input component
  101872. */
  101873. abstract get view(): NodeMaterialConnectionPoint;
  101874. protected _getTexture(): Nullable<BaseTexture>;
  101875. autoConfigure(material: NodeMaterial): void;
  101876. prepareDefines(mesh: AbstractMesh, nodeMaterial: NodeMaterial, defines: NodeMaterialDefines): void;
  101877. isReady(): boolean;
  101878. bind(effect: Effect, nodeMaterial: NodeMaterial, mesh?: Mesh): void;
  101879. /**
  101880. * Gets the code to inject in the vertex shader
  101881. * @param state current state of the node material building
  101882. * @returns the shader code
  101883. */
  101884. handleVertexSide(state: NodeMaterialBuildState): string;
  101885. /**
  101886. * Handles the inits for the fragment code path
  101887. * @param state node material build state
  101888. */
  101889. handleFragmentSideInits(state: NodeMaterialBuildState): void;
  101890. /**
  101891. * Generates the reflection coords code for the fragment code path
  101892. * @param worldNormalVarName name of the world normal variable
  101893. * @param worldPos name of the world position variable. If not provided, will use the world position connected to this block
  101894. * @param onlyReflectionVector if true, generates code only for the reflection vector computation, not for the reflection coordinates
  101895. * @returns the shader code
  101896. */
  101897. handleFragmentSideCodeReflectionCoords(worldNormalVarName: string, worldPos?: string, onlyReflectionVector?: boolean): string;
  101898. /**
  101899. * Generates the reflection color code for the fragment code path
  101900. * @param lodVarName name of the lod variable
  101901. * @param swizzleLookupTexture swizzle to use for the final color variable
  101902. * @returns the shader code
  101903. */
  101904. handleFragmentSideCodeReflectionColor(lodVarName?: string, swizzleLookupTexture?: string): string;
  101905. /**
  101906. * Generates the code corresponding to the connected output points
  101907. * @param state node material build state
  101908. * @param varName name of the variable to output
  101909. * @returns the shader code
  101910. */
  101911. writeOutputs(state: NodeMaterialBuildState, varName: string): string;
  101912. protected _buildBlock(state: NodeMaterialBuildState): this;
  101913. protected _dumpPropertiesCode(): string;
  101914. serialize(): any;
  101915. _deserialize(serializationObject: any, scene: Scene, rootUrl: string): void;
  101916. }
  101917. }
  101918. declare module BABYLON {
  101919. /**
  101920. * Defines a connection point to be used for points with a custom object type
  101921. */
  101922. export class NodeMaterialConnectionPointCustomObject<T extends NodeMaterialBlock> extends NodeMaterialConnectionPoint {
  101923. private _blockType;
  101924. private _blockName;
  101925. private _nameForCheking?;
  101926. /**
  101927. * Creates a new connection point
  101928. * @param name defines the connection point name
  101929. * @param ownerBlock defines the block hosting this connection point
  101930. * @param direction defines the direction of the connection point
  101931. */
  101932. constructor(name: string, ownerBlock: NodeMaterialBlock, direction: NodeMaterialConnectionPointDirection, _blockType: new (...args: any[]) => T, _blockName: string, _nameForCheking?: string | undefined);
  101933. /**
  101934. * Gets a number indicating if the current point can be connected to another point
  101935. * @param connectionPoint defines the other connection point
  101936. * @returns a number defining the compatibility state
  101937. */
  101938. checkCompatibilityState(connectionPoint: NodeMaterialConnectionPoint): NodeMaterialConnectionPointCompatibilityStates;
  101939. /**
  101940. * Creates a block suitable to be used as an input for this input point.
  101941. * If null is returned, a block based on the point type will be created.
  101942. * @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
  101943. */
  101944. createCustomInputBlock(): Nullable<[NodeMaterialBlock, string]>;
  101945. }
  101946. }
  101947. declare module BABYLON {
  101948. /**
  101949. * Enum defining the type of properties that can be edited in the property pages in the NME
  101950. */
  101951. export enum PropertyTypeForEdition {
  101952. /** property is a boolean */
  101953. Boolean = 0,
  101954. /** property is a float */
  101955. Float = 1,
  101956. /** property is a Vector2 */
  101957. Vector2 = 2,
  101958. /** property is a list of values */
  101959. List = 3
  101960. }
  101961. /**
  101962. * Interface that defines an option in a variable of type list
  101963. */
  101964. export interface IEditablePropertyListOption {
  101965. /** label of the option */
  101966. "label": string;
  101967. /** value of the option */
  101968. "value": number;
  101969. }
  101970. /**
  101971. * Interface that defines the options available for an editable property
  101972. */
  101973. export interface IEditablePropertyOption {
  101974. /** min value */
  101975. "min"?: number;
  101976. /** max value */
  101977. "max"?: number;
  101978. /** notifiers: indicates which actions to take when the property is changed */
  101979. "notifiers"?: {
  101980. /** the material should be rebuilt */
  101981. "rebuild"?: boolean;
  101982. /** the preview should be updated */
  101983. "update"?: boolean;
  101984. };
  101985. /** list of the options for a variable of type list */
  101986. "options"?: IEditablePropertyListOption[];
  101987. }
  101988. /**
  101989. * Interface that describes an editable property
  101990. */
  101991. export interface IPropertyDescriptionForEdition {
  101992. /** name of the property */
  101993. "propertyName": string;
  101994. /** display name of the property */
  101995. "displayName": string;
  101996. /** type of the property */
  101997. "type": PropertyTypeForEdition;
  101998. /** group of the property - all properties with the same group value will be displayed in a specific section */
  101999. "groupName": string;
  102000. /** options for the property */
  102001. "options": IEditablePropertyOption;
  102002. }
  102003. /**
  102004. * Decorator that flags a property in a node material block as being editable
  102005. */
  102006. export function editableInPropertyPage(displayName: string, propertyType?: PropertyTypeForEdition, groupName?: string, options?: IEditablePropertyOption): (target: any, propertyKey: string) => void;
  102007. }
  102008. declare module BABYLON {
  102009. /**
  102010. * Block used to implement the refraction part of the sub surface module of the PBR material
  102011. */
  102012. export class RefractionBlock extends NodeMaterialBlock {
  102013. /** @hidden */
  102014. _define3DName: string;
  102015. /** @hidden */
  102016. _refractionMatrixName: string;
  102017. /** @hidden */
  102018. _defineLODRefractionAlpha: string;
  102019. /** @hidden */
  102020. _defineLinearSpecularRefraction: string;
  102021. /** @hidden */
  102022. _defineOppositeZ: string;
  102023. /** @hidden */
  102024. _cubeSamplerName: string;
  102025. /** @hidden */
  102026. _2DSamplerName: string;
  102027. /** @hidden */
  102028. _vRefractionMicrosurfaceInfosName: string;
  102029. /** @hidden */
  102030. _vRefractionInfosName: string;
  102031. private _scene;
  102032. /**
  102033. * This parameters will make the material used its opacity to control how much it is refracting aginst not.
  102034. * Materials half opaque for instance using refraction could benefit from this control.
  102035. */
  102036. linkRefractionWithTransparency: boolean;
  102037. /**
  102038. * Controls if refraction needs to be inverted on Y. This could be useful for procedural texture.
  102039. */
  102040. invertRefractionY: boolean;
  102041. /**
  102042. * Gets or sets the texture associated with the node
  102043. */
  102044. texture: Nullable<BaseTexture>;
  102045. /**
  102046. * Create a new RefractionBlock
  102047. * @param name defines the block name
  102048. */
  102049. constructor(name: string);
  102050. /**
  102051. * Gets the current class name
  102052. * @returns the class name
  102053. */
  102054. getClassName(): string;
  102055. /**
  102056. * Gets the intensity input component
  102057. */
  102058. get intensity(): NodeMaterialConnectionPoint;
  102059. /**
  102060. * Gets the index of refraction input component
  102061. */
  102062. get indexOfRefraction(): NodeMaterialConnectionPoint;
  102063. /**
  102064. * Gets the tint at distance input component
  102065. */
  102066. get tintAtDistance(): NodeMaterialConnectionPoint;
  102067. /**
  102068. * Gets the view input component
  102069. */
  102070. get view(): NodeMaterialConnectionPoint;
  102071. /**
  102072. * Gets the refraction object output component
  102073. */
  102074. get refraction(): NodeMaterialConnectionPoint;
  102075. /**
  102076. * Returns true if the block has a texture
  102077. */
  102078. get hasTexture(): boolean;
  102079. protected _getTexture(): Nullable<BaseTexture>;
  102080. autoConfigure(material: NodeMaterial): void;
  102081. prepareDefines(mesh: AbstractMesh, nodeMaterial: NodeMaterial, defines: NodeMaterialDefines): void;
  102082. isReady(): boolean;
  102083. bind(effect: Effect, nodeMaterial: NodeMaterial, mesh?: Mesh, subMesh?: SubMesh): void;
  102084. /**
  102085. * Gets the main code of the block (fragment side)
  102086. * @param state current state of the node material building
  102087. * @returns the shader code
  102088. */
  102089. getCode(state: NodeMaterialBuildState): string;
  102090. protected _buildBlock(state: NodeMaterialBuildState): this;
  102091. protected _dumpPropertiesCode(): string;
  102092. serialize(): any;
  102093. _deserialize(serializationObject: any, scene: Scene, rootUrl: string): void;
  102094. }
  102095. }
  102096. declare module BABYLON {
  102097. /**
  102098. * Base block used as input for post process
  102099. */
  102100. export class CurrentScreenBlock extends NodeMaterialBlock {
  102101. private _samplerName;
  102102. private _linearDefineName;
  102103. private _gammaDefineName;
  102104. private _mainUVName;
  102105. private _tempTextureRead;
  102106. /**
  102107. * Gets or sets the texture associated with the node
  102108. */
  102109. texture: Nullable<BaseTexture>;
  102110. /**
  102111. * Gets or sets a boolean indicating if content needs to be converted to gamma space
  102112. */
  102113. convertToGammaSpace: boolean;
  102114. /**
  102115. * Gets or sets a boolean indicating if content needs to be converted to linear space
  102116. */
  102117. convertToLinearSpace: boolean;
  102118. /**
  102119. * Create a new CurrentScreenBlock
  102120. * @param name defines the block name
  102121. */
  102122. constructor(name: string);
  102123. /**
  102124. * Gets the current class name
  102125. * @returns the class name
  102126. */
  102127. getClassName(): string;
  102128. /**
  102129. * Gets the uv input component
  102130. */
  102131. get uv(): NodeMaterialConnectionPoint;
  102132. /**
  102133. * Gets the rgba output component
  102134. */
  102135. get rgba(): NodeMaterialConnectionPoint;
  102136. /**
  102137. * Gets the rgb output component
  102138. */
  102139. get rgb(): NodeMaterialConnectionPoint;
  102140. /**
  102141. * Gets the r output component
  102142. */
  102143. get r(): NodeMaterialConnectionPoint;
  102144. /**
  102145. * Gets the g output component
  102146. */
  102147. get g(): NodeMaterialConnectionPoint;
  102148. /**
  102149. * Gets the b output component
  102150. */
  102151. get b(): NodeMaterialConnectionPoint;
  102152. /**
  102153. * Gets the a output component
  102154. */
  102155. get a(): NodeMaterialConnectionPoint;
  102156. /**
  102157. * Initialize the block and prepare the context for build
  102158. * @param state defines the state that will be used for the build
  102159. */
  102160. initialize(state: NodeMaterialBuildState): void;
  102161. get target(): NodeMaterialBlockTargets;
  102162. prepareDefines(mesh: AbstractMesh, nodeMaterial: NodeMaterial, defines: NodeMaterialDefines): void;
  102163. isReady(): boolean;
  102164. private _injectVertexCode;
  102165. private _writeTextureRead;
  102166. private _writeOutput;
  102167. protected _buildBlock(state: NodeMaterialBuildState): this | undefined;
  102168. serialize(): any;
  102169. _deserialize(serializationObject: any, scene: Scene, rootUrl: string): void;
  102170. }
  102171. }
  102172. declare module BABYLON {
  102173. /**
  102174. * Base block used for the particle texture
  102175. */
  102176. export class ParticleTextureBlock extends NodeMaterialBlock {
  102177. private _samplerName;
  102178. private _linearDefineName;
  102179. private _gammaDefineName;
  102180. private _tempTextureRead;
  102181. /**
  102182. * Gets or sets the texture associated with the node
  102183. */
  102184. texture: Nullable<BaseTexture>;
  102185. /**
  102186. * Gets or sets a boolean indicating if content needs to be converted to gamma space
  102187. */
  102188. convertToGammaSpace: boolean;
  102189. /**
  102190. * Gets or sets a boolean indicating if content needs to be converted to linear space
  102191. */
  102192. convertToLinearSpace: boolean;
  102193. /**
  102194. * Create a new ParticleTextureBlock
  102195. * @param name defines the block name
  102196. */
  102197. constructor(name: string);
  102198. /**
  102199. * Gets the current class name
  102200. * @returns the class name
  102201. */
  102202. getClassName(): string;
  102203. /**
  102204. * Gets the uv input component
  102205. */
  102206. get uv(): NodeMaterialConnectionPoint;
  102207. /**
  102208. * Gets the rgba output component
  102209. */
  102210. get rgba(): NodeMaterialConnectionPoint;
  102211. /**
  102212. * Gets the rgb output component
  102213. */
  102214. get rgb(): NodeMaterialConnectionPoint;
  102215. /**
  102216. * Gets the r output component
  102217. */
  102218. get r(): NodeMaterialConnectionPoint;
  102219. /**
  102220. * Gets the g output component
  102221. */
  102222. get g(): NodeMaterialConnectionPoint;
  102223. /**
  102224. * Gets the b output component
  102225. */
  102226. get b(): NodeMaterialConnectionPoint;
  102227. /**
  102228. * Gets the a output component
  102229. */
  102230. get a(): NodeMaterialConnectionPoint;
  102231. /**
  102232. * Initialize the block and prepare the context for build
  102233. * @param state defines the state that will be used for the build
  102234. */
  102235. initialize(state: NodeMaterialBuildState): void;
  102236. autoConfigure(material: NodeMaterial): void;
  102237. prepareDefines(mesh: AbstractMesh, nodeMaterial: NodeMaterial, defines: NodeMaterialDefines): void;
  102238. isReady(): boolean;
  102239. private _writeOutput;
  102240. protected _buildBlock(state: NodeMaterialBuildState): this | undefined;
  102241. serialize(): any;
  102242. _deserialize(serializationObject: any, scene: Scene, rootUrl: string): void;
  102243. }
  102244. }
  102245. declare module BABYLON {
  102246. /**
  102247. * Class used to store shared data between 2 NodeMaterialBuildState
  102248. */
  102249. export class NodeMaterialBuildStateSharedData {
  102250. /**
  102251. * Gets the list of emitted varyings
  102252. */
  102253. temps: string[];
  102254. /**
  102255. * Gets the list of emitted varyings
  102256. */
  102257. varyings: string[];
  102258. /**
  102259. * Gets the varying declaration string
  102260. */
  102261. varyingDeclaration: string;
  102262. /**
  102263. * Input blocks
  102264. */
  102265. inputBlocks: InputBlock[];
  102266. /**
  102267. * Input blocks
  102268. */
  102269. textureBlocks: (TextureBlock | ReflectionTextureBaseBlock | RefractionBlock | CurrentScreenBlock | ParticleTextureBlock)[];
  102270. /**
  102271. * Bindable blocks (Blocks that need to set data to the effect)
  102272. */
  102273. bindableBlocks: NodeMaterialBlock[];
  102274. /**
  102275. * List of blocks that can provide a compilation fallback
  102276. */
  102277. blocksWithFallbacks: NodeMaterialBlock[];
  102278. /**
  102279. * List of blocks that can provide a define update
  102280. */
  102281. blocksWithDefines: NodeMaterialBlock[];
  102282. /**
  102283. * List of blocks that can provide a repeatable content
  102284. */
  102285. repeatableContentBlocks: NodeMaterialBlock[];
  102286. /**
  102287. * List of blocks that can provide a dynamic list of uniforms
  102288. */
  102289. dynamicUniformBlocks: NodeMaterialBlock[];
  102290. /**
  102291. * List of blocks that can block the isReady function for the material
  102292. */
  102293. blockingBlocks: NodeMaterialBlock[];
  102294. /**
  102295. * Gets the list of animated inputs
  102296. */
  102297. animatedInputs: InputBlock[];
  102298. /**
  102299. * Build Id used to avoid multiple recompilations
  102300. */
  102301. buildId: number;
  102302. /** List of emitted variables */
  102303. variableNames: {
  102304. [key: string]: number;
  102305. };
  102306. /** List of emitted defines */
  102307. defineNames: {
  102308. [key: string]: number;
  102309. };
  102310. /** Should emit comments? */
  102311. emitComments: boolean;
  102312. /** Emit build activity */
  102313. verbose: boolean;
  102314. /** Gets or sets the hosting scene */
  102315. scene: Scene;
  102316. /**
  102317. * Gets the compilation hints emitted at compilation time
  102318. */
  102319. hints: {
  102320. needWorldViewMatrix: boolean;
  102321. needWorldViewProjectionMatrix: boolean;
  102322. needAlphaBlending: boolean;
  102323. needAlphaTesting: boolean;
  102324. };
  102325. /**
  102326. * List of compilation checks
  102327. */
  102328. checks: {
  102329. emitVertex: boolean;
  102330. emitFragment: boolean;
  102331. notConnectedNonOptionalInputs: NodeMaterialConnectionPoint[];
  102332. };
  102333. /**
  102334. * Is vertex program allowed to be empty?
  102335. */
  102336. allowEmptyVertexProgram: boolean;
  102337. /** Creates a new shared data */
  102338. constructor();
  102339. /**
  102340. * Emits console errors and exceptions if there is a failing check
  102341. */
  102342. emitErrors(): void;
  102343. }
  102344. }
  102345. declare module BABYLON {
  102346. /**
  102347. * Class used to store node based material build state
  102348. */
  102349. export class NodeMaterialBuildState {
  102350. /** Gets or sets a boolean indicating if the current state can emit uniform buffers */
  102351. supportUniformBuffers: boolean;
  102352. /**
  102353. * Gets the list of emitted attributes
  102354. */
  102355. attributes: string[];
  102356. /**
  102357. * Gets the list of emitted uniforms
  102358. */
  102359. uniforms: string[];
  102360. /**
  102361. * Gets the list of emitted constants
  102362. */
  102363. constants: string[];
  102364. /**
  102365. * Gets the list of emitted samplers
  102366. */
  102367. samplers: string[];
  102368. /**
  102369. * Gets the list of emitted functions
  102370. */
  102371. functions: {
  102372. [key: string]: string;
  102373. };
  102374. /**
  102375. * Gets the list of emitted extensions
  102376. */
  102377. extensions: {
  102378. [key: string]: string;
  102379. };
  102380. /**
  102381. * Gets the target of the compilation state
  102382. */
  102383. target: NodeMaterialBlockTargets;
  102384. /**
  102385. * Gets the list of emitted counters
  102386. */
  102387. counters: {
  102388. [key: string]: number;
  102389. };
  102390. /**
  102391. * Shared data between multiple NodeMaterialBuildState instances
  102392. */
  102393. sharedData: NodeMaterialBuildStateSharedData;
  102394. /** @hidden */
  102395. _vertexState: NodeMaterialBuildState;
  102396. /** @hidden */
  102397. _attributeDeclaration: string;
  102398. /** @hidden */
  102399. _uniformDeclaration: string;
  102400. /** @hidden */
  102401. _constantDeclaration: string;
  102402. /** @hidden */
  102403. _samplerDeclaration: string;
  102404. /** @hidden */
  102405. _varyingTransfer: string;
  102406. /** @hidden */
  102407. _injectAtEnd: string;
  102408. private _repeatableContentAnchorIndex;
  102409. /** @hidden */
  102410. _builtCompilationString: string;
  102411. /**
  102412. * Gets the emitted compilation strings
  102413. */
  102414. compilationString: string;
  102415. /**
  102416. * Finalize the compilation strings
  102417. * @param state defines the current compilation state
  102418. */
  102419. finalize(state: NodeMaterialBuildState): void;
  102420. /** @hidden */
  102421. get _repeatableContentAnchor(): string;
  102422. /** @hidden */
  102423. _getFreeVariableName(prefix: string): string;
  102424. /** @hidden */
  102425. _getFreeDefineName(prefix: string): string;
  102426. /** @hidden */
  102427. _excludeVariableName(name: string): void;
  102428. /** @hidden */
  102429. _emit2DSampler(name: string): void;
  102430. /** @hidden */
  102431. _getGLType(type: NodeMaterialBlockConnectionPointTypes): string;
  102432. /** @hidden */
  102433. _emitExtension(name: string, extension: string, define?: string): void;
  102434. /** @hidden */
  102435. _emitFunction(name: string, code: string, comments: string): void;
  102436. /** @hidden */
  102437. _emitCodeFromInclude(includeName: string, comments: string, options?: {
  102438. replaceStrings?: {
  102439. search: RegExp;
  102440. replace: string;
  102441. }[];
  102442. repeatKey?: string;
  102443. }): string;
  102444. /** @hidden */
  102445. _emitFunctionFromInclude(includeName: string, comments: string, options?: {
  102446. repeatKey?: string;
  102447. removeAttributes?: boolean;
  102448. removeUniforms?: boolean;
  102449. removeVaryings?: boolean;
  102450. removeIfDef?: boolean;
  102451. replaceStrings?: {
  102452. search: RegExp;
  102453. replace: string;
  102454. }[];
  102455. }, storeKey?: string): void;
  102456. /** @hidden */
  102457. _registerTempVariable(name: string): boolean;
  102458. /** @hidden */
  102459. _emitVaryingFromString(name: string, type: string, define?: string, notDefine?: boolean): boolean;
  102460. /** @hidden */
  102461. _emitUniformFromString(name: string, type: string, define?: string, notDefine?: boolean): void;
  102462. /** @hidden */
  102463. _emitFloat(value: number): string;
  102464. }
  102465. }
  102466. declare module BABYLON {
  102467. /**
  102468. * Helper class used to generate session unique ID
  102469. */
  102470. export class UniqueIdGenerator {
  102471. private static _UniqueIdCounter;
  102472. /**
  102473. * Gets an unique (relatively to the current scene) Id
  102474. */
  102475. static get UniqueId(): number;
  102476. }
  102477. }
  102478. declare module BABYLON {
  102479. /**
  102480. * Defines a block that can be used inside a node based material
  102481. */
  102482. export class NodeMaterialBlock {
  102483. private _buildId;
  102484. private _buildTarget;
  102485. private _target;
  102486. private _isFinalMerger;
  102487. private _isInput;
  102488. private _name;
  102489. protected _isUnique: boolean;
  102490. /** Gets or sets a boolean indicating that only one input can be connected at a time */
  102491. inputsAreExclusive: boolean;
  102492. /** @hidden */
  102493. _codeVariableName: string;
  102494. /** @hidden */
  102495. _inputs: NodeMaterialConnectionPoint[];
  102496. /** @hidden */
  102497. _outputs: NodeMaterialConnectionPoint[];
  102498. /** @hidden */
  102499. _preparationId: number;
  102500. /**
  102501. * Gets the name of the block
  102502. */
  102503. get name(): string;
  102504. /**
  102505. * Sets the name of the block. Will check if the name is valid.
  102506. */
  102507. set name(newName: string);
  102508. /**
  102509. * Gets or sets the unique id of the node
  102510. */
  102511. uniqueId: number;
  102512. /**
  102513. * Gets or sets the comments associated with this block
  102514. */
  102515. comments: string;
  102516. /**
  102517. * Gets a boolean indicating that this block can only be used once per NodeMaterial
  102518. */
  102519. get isUnique(): boolean;
  102520. /**
  102521. * Gets a boolean indicating that this block is an end block (e.g. it is generating a system value)
  102522. */
  102523. get isFinalMerger(): boolean;
  102524. /**
  102525. * Gets a boolean indicating that this block is an input (e.g. it sends data to the shader)
  102526. */
  102527. get isInput(): boolean;
  102528. /**
  102529. * Gets or sets the build Id
  102530. */
  102531. get buildId(): number;
  102532. set buildId(value: number);
  102533. /**
  102534. * Gets or sets the target of the block
  102535. */
  102536. get target(): NodeMaterialBlockTargets;
  102537. set target(value: NodeMaterialBlockTargets);
  102538. /**
  102539. * Gets the list of input points
  102540. */
  102541. get inputs(): NodeMaterialConnectionPoint[];
  102542. /** Gets the list of output points */
  102543. get outputs(): NodeMaterialConnectionPoint[];
  102544. /**
  102545. * Find an input by its name
  102546. * @param name defines the name of the input to look for
  102547. * @returns the input or null if not found
  102548. */
  102549. getInputByName(name: string): Nullable<NodeMaterialConnectionPoint>;
  102550. /**
  102551. * Find an output by its name
  102552. * @param name defines the name of the outputto look for
  102553. * @returns the output or null if not found
  102554. */
  102555. getOutputByName(name: string): Nullable<NodeMaterialConnectionPoint>;
  102556. /** Gets or sets a boolean indicating that this input can be edited in the Inspector (false by default) */
  102557. visibleInInspector: boolean;
  102558. /**
  102559. * Creates a new NodeMaterialBlock
  102560. * @param name defines the block name
  102561. * @param target defines the target of that block (Vertex by default)
  102562. * @param isFinalMerger defines a boolean indicating that this block is an end block (e.g. it is generating a system value). Default is false
  102563. * @param isInput defines a boolean indicating that this block is an input (e.g. it sends data to the shader). Default is false
  102564. */
  102565. constructor(name: string, target?: NodeMaterialBlockTargets, isFinalMerger?: boolean, isInput?: boolean);
  102566. /**
  102567. * Initialize the block and prepare the context for build
  102568. * @param state defines the state that will be used for the build
  102569. */
  102570. initialize(state: NodeMaterialBuildState): void;
  102571. /**
  102572. * Bind data to effect. Will only be called for blocks with isBindable === true
  102573. * @param effect defines the effect to bind data to
  102574. * @param nodeMaterial defines the hosting NodeMaterial
  102575. * @param mesh defines the mesh that will be rendered
  102576. * @param subMesh defines the submesh that will be rendered
  102577. */
  102578. bind(effect: Effect, nodeMaterial: NodeMaterial, mesh?: Mesh, subMesh?: SubMesh): void;
  102579. protected _declareOutput(output: NodeMaterialConnectionPoint, state: NodeMaterialBuildState): string;
  102580. protected _writeVariable(currentPoint: NodeMaterialConnectionPoint): string;
  102581. protected _writeFloat(value: number): string;
  102582. /**
  102583. * Gets the current class name e.g. "NodeMaterialBlock"
  102584. * @returns the class name
  102585. */
  102586. getClassName(): string;
  102587. /**
  102588. * Register a new input. Must be called inside a block constructor
  102589. * @param name defines the connection point name
  102590. * @param type defines the connection point type
  102591. * @param isOptional defines a boolean indicating that this input can be omitted
  102592. * @param target defines the target to use to limit the connection point (will be VertexAndFragment by default)
  102593. * @param point an already created connection point. If not provided, create a new one
  102594. * @returns the current block
  102595. */
  102596. registerInput(name: string, type: NodeMaterialBlockConnectionPointTypes, isOptional?: boolean, target?: NodeMaterialBlockTargets, point?: NodeMaterialConnectionPoint): this;
  102597. /**
  102598. * Register a new output. Must be called inside a block constructor
  102599. * @param name defines the connection point name
  102600. * @param type defines the connection point type
  102601. * @param target defines the target to use to limit the connection point (will be VertexAndFragment by default)
  102602. * @param point an already created connection point. If not provided, create a new one
  102603. * @returns the current block
  102604. */
  102605. registerOutput(name: string, type: NodeMaterialBlockConnectionPointTypes, target?: NodeMaterialBlockTargets, point?: NodeMaterialConnectionPoint): this;
  102606. /**
  102607. * Will return the first available input e.g. the first one which is not an uniform or an attribute
  102608. * @param forOutput defines an optional connection point to check compatibility with
  102609. * @returns the first available input or null
  102610. */
  102611. getFirstAvailableInput(forOutput?: Nullable<NodeMaterialConnectionPoint>): Nullable<NodeMaterialConnectionPoint>;
  102612. /**
  102613. * Will return the first available output e.g. the first one which is not yet connected and not a varying
  102614. * @param forBlock defines an optional block to check compatibility with
  102615. * @returns the first available input or null
  102616. */
  102617. getFirstAvailableOutput(forBlock?: Nullable<NodeMaterialBlock>): Nullable<NodeMaterialConnectionPoint>;
  102618. /**
  102619. * Gets the sibling of the given output
  102620. * @param current defines the current output
  102621. * @returns the next output in the list or null
  102622. */
  102623. getSiblingOutput(current: NodeMaterialConnectionPoint): Nullable<NodeMaterialConnectionPoint>;
  102624. /**
  102625. * Connect current block with another block
  102626. * @param other defines the block to connect with
  102627. * @param options define the various options to help pick the right connections
  102628. * @returns the current block
  102629. */
  102630. connectTo(other: NodeMaterialBlock, options?: {
  102631. input?: string;
  102632. output?: string;
  102633. outputSwizzle?: string;
  102634. }): this | undefined;
  102635. protected _buildBlock(state: NodeMaterialBuildState): void;
  102636. /**
  102637. * Add uniforms, samplers and uniform buffers at compilation time
  102638. * @param state defines the state to update
  102639. * @param nodeMaterial defines the node material requesting the update
  102640. * @param defines defines the material defines to update
  102641. * @param uniformBuffers defines the list of uniform buffer names
  102642. */
  102643. updateUniformsAndSamples(state: NodeMaterialBuildState, nodeMaterial: NodeMaterial, defines: NodeMaterialDefines, uniformBuffers: string[]): void;
  102644. /**
  102645. * Add potential fallbacks if shader compilation fails
  102646. * @param mesh defines the mesh to be rendered
  102647. * @param fallbacks defines the current prioritized list of fallbacks
  102648. */
  102649. provideFallbacks(mesh: AbstractMesh, fallbacks: EffectFallbacks): void;
  102650. /**
  102651. * Initialize defines for shader compilation
  102652. * @param mesh defines the mesh to be rendered
  102653. * @param nodeMaterial defines the node material requesting the update
  102654. * @param defines defines the material defines to update
  102655. * @param useInstances specifies that instances should be used
  102656. */
  102657. initializeDefines(mesh: AbstractMesh, nodeMaterial: NodeMaterial, defines: NodeMaterialDefines, useInstances?: boolean): void;
  102658. /**
  102659. * Update defines for shader compilation
  102660. * @param mesh defines the mesh to be rendered
  102661. * @param nodeMaterial defines the node material requesting the update
  102662. * @param defines defines the material defines to update
  102663. * @param useInstances specifies that instances should be used
  102664. * @param subMesh defines which submesh to render
  102665. */
  102666. prepareDefines(mesh: AbstractMesh, nodeMaterial: NodeMaterial, defines: NodeMaterialDefines, useInstances?: boolean, subMesh?: SubMesh): void;
  102667. /**
  102668. * Lets the block try to connect some inputs automatically
  102669. * @param material defines the hosting NodeMaterial
  102670. */
  102671. autoConfigure(material: NodeMaterial): void;
  102672. /**
  102673. * Function called when a block is declared as repeatable content generator
  102674. * @param vertexShaderState defines the current compilation state for the vertex shader
  102675. * @param fragmentShaderState defines the current compilation state for the fragment shader
  102676. * @param mesh defines the mesh to be rendered
  102677. * @param defines defines the material defines to update
  102678. */
  102679. replaceRepeatableContent(vertexShaderState: NodeMaterialBuildState, fragmentShaderState: NodeMaterialBuildState, mesh: AbstractMesh, defines: NodeMaterialDefines): void;
  102680. /**
  102681. * Checks if the block is ready
  102682. * @param mesh defines the mesh to be rendered
  102683. * @param nodeMaterial defines the node material requesting the update
  102684. * @param defines defines the material defines to update
  102685. * @param useInstances specifies that instances should be used
  102686. * @returns true if the block is ready
  102687. */
  102688. isReady(mesh: AbstractMesh, nodeMaterial: NodeMaterial, defines: NodeMaterialDefines, useInstances?: boolean): boolean;
  102689. protected _linkConnectionTypes(inputIndex0: number, inputIndex1: number): void;
  102690. private _processBuild;
  102691. /**
  102692. * Validates the new name for the block node.
  102693. * @param newName the new name to be given to the node.
  102694. * @returns false if the name is a reserve word, else true.
  102695. */
  102696. validateBlockName(newName: string): boolean;
  102697. /**
  102698. * Compile the current node and generate the shader code
  102699. * @param state defines the current compilation state (uniforms, samplers, current string)
  102700. * @param activeBlocks defines the list of active blocks (i.e. blocks to compile)
  102701. * @returns true if already built
  102702. */
  102703. build(state: NodeMaterialBuildState, activeBlocks: NodeMaterialBlock[]): boolean;
  102704. protected _inputRename(name: string): string;
  102705. protected _outputRename(name: string): string;
  102706. protected _dumpPropertiesCode(): string;
  102707. /** @hidden */
  102708. _dumpCode(uniqueNames: string[], alreadyDumped: NodeMaterialBlock[]): string;
  102709. /** @hidden */
  102710. _dumpCodeForOutputConnections(alreadyDumped: NodeMaterialBlock[]): string;
  102711. /**
  102712. * Clone the current block to a new identical block
  102713. * @param scene defines the hosting scene
  102714. * @param rootUrl defines the root URL to use to load textures and relative dependencies
  102715. * @returns a copy of the current block
  102716. */
  102717. clone(scene: Scene, rootUrl?: string): Nullable<NodeMaterialBlock>;
  102718. /**
  102719. * Serializes this block in a JSON representation
  102720. * @returns the serialized block object
  102721. */
  102722. serialize(): any;
  102723. /** @hidden */
  102724. _deserialize(serializationObject: any, scene: Scene, rootUrl: string): void;
  102725. private _deserializePortDisplayNamesAndExposedOnFrame;
  102726. /**
  102727. * Release resources
  102728. */
  102729. dispose(): void;
  102730. }
  102731. }
  102732. declare module BABYLON {
  102733. /**
  102734. * Base class of materials working in push mode in babylon JS
  102735. * @hidden
  102736. */
  102737. export class PushMaterial extends Material {
  102738. protected _activeEffect: Effect;
  102739. protected _normalMatrix: Matrix;
  102740. constructor(name: string, scene: Scene);
  102741. getEffect(): Effect;
  102742. isReady(mesh?: AbstractMesh, useInstances?: boolean): boolean;
  102743. protected _isReadyForSubMesh(subMesh: SubMesh): boolean;
  102744. /**
  102745. * Binds the given world matrix to the active effect
  102746. *
  102747. * @param world the matrix to bind
  102748. */
  102749. bindOnlyWorldMatrix(world: Matrix): void;
  102750. /**
  102751. * Binds the given normal matrix to the active effect
  102752. *
  102753. * @param normalMatrix the matrix to bind
  102754. */
  102755. bindOnlyNormalMatrix(normalMatrix: Matrix): void;
  102756. bind(world: Matrix, mesh?: Mesh): void;
  102757. protected _afterBind(mesh: Mesh, effect?: Nullable<Effect>): void;
  102758. protected _mustRebind(scene: Scene, effect: Effect, visibility?: number): boolean;
  102759. }
  102760. }
  102761. declare module BABYLON {
  102762. /**
  102763. * Root class for all node material optimizers
  102764. */
  102765. export class NodeMaterialOptimizer {
  102766. /**
  102767. * Function used to optimize a NodeMaterial graph
  102768. * @param vertexOutputNodes defines the list of output nodes for the vertex shader
  102769. * @param fragmentOutputNodes defines the list of output nodes for the fragment shader
  102770. */
  102771. optimize(vertexOutputNodes: NodeMaterialBlock[], fragmentOutputNodes: NodeMaterialBlock[]): void;
  102772. }
  102773. }
  102774. declare module BABYLON {
  102775. /**
  102776. * Block used to transform a vector (2, 3 or 4) with a matrix. It will generate a Vector4
  102777. */
  102778. export class TransformBlock extends NodeMaterialBlock {
  102779. /**
  102780. * Defines the value to use to complement W value to transform it to a Vector4
  102781. */
  102782. complementW: number;
  102783. /**
  102784. * Defines the value to use to complement z value to transform it to a Vector4
  102785. */
  102786. complementZ: number;
  102787. /**
  102788. * Creates a new TransformBlock
  102789. * @param name defines the block name
  102790. */
  102791. constructor(name: string);
  102792. /**
  102793. * Gets the current class name
  102794. * @returns the class name
  102795. */
  102796. getClassName(): string;
  102797. /**
  102798. * Gets the vector input
  102799. */
  102800. get vector(): NodeMaterialConnectionPoint;
  102801. /**
  102802. * Gets the output component
  102803. */
  102804. get output(): NodeMaterialConnectionPoint;
  102805. /**
  102806. * Gets the xyz output component
  102807. */
  102808. get xyz(): NodeMaterialConnectionPoint;
  102809. /**
  102810. * Gets the matrix transform input
  102811. */
  102812. get transform(): NodeMaterialConnectionPoint;
  102813. protected _buildBlock(state: NodeMaterialBuildState): this;
  102814. /**
  102815. * Update defines for shader compilation
  102816. * @param mesh defines the mesh to be rendered
  102817. * @param nodeMaterial defines the node material requesting the update
  102818. * @param defines defines the material defines to update
  102819. * @param useInstances specifies that instances should be used
  102820. * @param subMesh defines which submesh to render
  102821. */
  102822. prepareDefines(mesh: AbstractMesh, nodeMaterial: NodeMaterial, defines: NodeMaterialDefines, useInstances?: boolean, subMesh?: SubMesh): void;
  102823. serialize(): any;
  102824. _deserialize(serializationObject: any, scene: Scene, rootUrl: string): void;
  102825. protected _dumpPropertiesCode(): string;
  102826. }
  102827. }
  102828. declare module BABYLON {
  102829. /**
  102830. * Block used to output the vertex position
  102831. */
  102832. export class VertexOutputBlock extends NodeMaterialBlock {
  102833. /**
  102834. * Creates a new VertexOutputBlock
  102835. * @param name defines the block name
  102836. */
  102837. constructor(name: string);
  102838. /**
  102839. * Gets the current class name
  102840. * @returns the class name
  102841. */
  102842. getClassName(): string;
  102843. /**
  102844. * Gets the vector input component
  102845. */
  102846. get vector(): NodeMaterialConnectionPoint;
  102847. protected _buildBlock(state: NodeMaterialBuildState): this;
  102848. }
  102849. }
  102850. declare module BABYLON {
  102851. /**
  102852. * Block used to output the final color
  102853. */
  102854. export class FragmentOutputBlock extends NodeMaterialBlock {
  102855. /**
  102856. * Create a new FragmentOutputBlock
  102857. * @param name defines the block name
  102858. */
  102859. constructor(name: string);
  102860. /**
  102861. * Gets the current class name
  102862. * @returns the class name
  102863. */
  102864. getClassName(): string;
  102865. /**
  102866. * Gets the rgba input component
  102867. */
  102868. get rgba(): NodeMaterialConnectionPoint;
  102869. /**
  102870. * Gets the rgb input component
  102871. */
  102872. get rgb(): NodeMaterialConnectionPoint;
  102873. /**
  102874. * Gets the a input component
  102875. */
  102876. get a(): NodeMaterialConnectionPoint;
  102877. protected _buildBlock(state: NodeMaterialBuildState): this;
  102878. }
  102879. }
  102880. declare module BABYLON {
  102881. /**
  102882. * Block used for the particle ramp gradient section
  102883. */
  102884. export class ParticleRampGradientBlock extends NodeMaterialBlock {
  102885. /**
  102886. * Create a new ParticleRampGradientBlock
  102887. * @param name defines the block name
  102888. */
  102889. constructor(name: string);
  102890. /**
  102891. * Gets the current class name
  102892. * @returns the class name
  102893. */
  102894. getClassName(): string;
  102895. /**
  102896. * Gets the color input component
  102897. */
  102898. get color(): NodeMaterialConnectionPoint;
  102899. /**
  102900. * Gets the rampColor output component
  102901. */
  102902. get rampColor(): NodeMaterialConnectionPoint;
  102903. /**
  102904. * Initialize the block and prepare the context for build
  102905. * @param state defines the state that will be used for the build
  102906. */
  102907. initialize(state: NodeMaterialBuildState): void;
  102908. protected _buildBlock(state: NodeMaterialBuildState): this | undefined;
  102909. }
  102910. }
  102911. declare module BABYLON {
  102912. /**
  102913. * Block used for the particle blend multiply section
  102914. */
  102915. export class ParticleBlendMultiplyBlock extends NodeMaterialBlock {
  102916. /**
  102917. * Create a new ParticleBlendMultiplyBlock
  102918. * @param name defines the block name
  102919. */
  102920. constructor(name: string);
  102921. /**
  102922. * Gets the current class name
  102923. * @returns the class name
  102924. */
  102925. getClassName(): string;
  102926. /**
  102927. * Gets the color input component
  102928. */
  102929. get color(): NodeMaterialConnectionPoint;
  102930. /**
  102931. * Gets the alphaTexture input component
  102932. */
  102933. get alphaTexture(): NodeMaterialConnectionPoint;
  102934. /**
  102935. * Gets the alphaColor input component
  102936. */
  102937. get alphaColor(): NodeMaterialConnectionPoint;
  102938. /**
  102939. * Gets the blendColor output component
  102940. */
  102941. get blendColor(): NodeMaterialConnectionPoint;
  102942. /**
  102943. * Initialize the block and prepare the context for build
  102944. * @param state defines the state that will be used for the build
  102945. */
  102946. initialize(state: NodeMaterialBuildState): void;
  102947. protected _buildBlock(state: NodeMaterialBuildState): this | undefined;
  102948. }
  102949. }
  102950. declare module BABYLON {
  102951. /**
  102952. * Block used to create a Vector2/3/4 out of individual inputs (one for each component)
  102953. */
  102954. export class VectorMergerBlock extends NodeMaterialBlock {
  102955. /**
  102956. * Create a new VectorMergerBlock
  102957. * @param name defines the block name
  102958. */
  102959. constructor(name: string);
  102960. /**
  102961. * Gets the current class name
  102962. * @returns the class name
  102963. */
  102964. getClassName(): string;
  102965. /**
  102966. * Gets the xyz component (input)
  102967. */
  102968. get xyzIn(): NodeMaterialConnectionPoint;
  102969. /**
  102970. * Gets the xy component (input)
  102971. */
  102972. get xyIn(): NodeMaterialConnectionPoint;
  102973. /**
  102974. * Gets the x component (input)
  102975. */
  102976. get x(): NodeMaterialConnectionPoint;
  102977. /**
  102978. * Gets the y component (input)
  102979. */
  102980. get y(): NodeMaterialConnectionPoint;
  102981. /**
  102982. * Gets the z component (input)
  102983. */
  102984. get z(): NodeMaterialConnectionPoint;
  102985. /**
  102986. * Gets the w component (input)
  102987. */
  102988. get w(): NodeMaterialConnectionPoint;
  102989. /**
  102990. * Gets the xyzw component (output)
  102991. */
  102992. get xyzw(): NodeMaterialConnectionPoint;
  102993. /**
  102994. * Gets the xyz component (output)
  102995. */
  102996. get xyzOut(): NodeMaterialConnectionPoint;
  102997. /**
  102998. * Gets the xy component (output)
  102999. */
  103000. get xyOut(): NodeMaterialConnectionPoint;
  103001. /**
  103002. * Gets the xy component (output)
  103003. * @deprecated Please use xyOut instead.
  103004. */
  103005. get xy(): NodeMaterialConnectionPoint;
  103006. /**
  103007. * Gets the xyz component (output)
  103008. * @deprecated Please use xyzOut instead.
  103009. */
  103010. get xyz(): NodeMaterialConnectionPoint;
  103011. protected _buildBlock(state: NodeMaterialBuildState): this;
  103012. }
  103013. }
  103014. declare module BABYLON {
  103015. /**
  103016. * Block used to remap a float from a range to a new one
  103017. */
  103018. export class RemapBlock extends NodeMaterialBlock {
  103019. /**
  103020. * Gets or sets the source range
  103021. */
  103022. sourceRange: Vector2;
  103023. /**
  103024. * Gets or sets the target range
  103025. */
  103026. targetRange: Vector2;
  103027. /**
  103028. * Creates a new RemapBlock
  103029. * @param name defines the block name
  103030. */
  103031. constructor(name: string);
  103032. /**
  103033. * Gets the current class name
  103034. * @returns the class name
  103035. */
  103036. getClassName(): string;
  103037. /**
  103038. * Gets the input component
  103039. */
  103040. get input(): NodeMaterialConnectionPoint;
  103041. /**
  103042. * Gets the source min input component
  103043. */
  103044. get sourceMin(): NodeMaterialConnectionPoint;
  103045. /**
  103046. * Gets the source max input component
  103047. */
  103048. get sourceMax(): NodeMaterialConnectionPoint;
  103049. /**
  103050. * Gets the target min input component
  103051. */
  103052. get targetMin(): NodeMaterialConnectionPoint;
  103053. /**
  103054. * Gets the target max input component
  103055. */
  103056. get targetMax(): NodeMaterialConnectionPoint;
  103057. /**
  103058. * Gets the output component
  103059. */
  103060. get output(): NodeMaterialConnectionPoint;
  103061. protected _buildBlock(state: NodeMaterialBuildState): this;
  103062. protected _dumpPropertiesCode(): string;
  103063. serialize(): any;
  103064. _deserialize(serializationObject: any, scene: Scene, rootUrl: string): void;
  103065. }
  103066. }
  103067. declare module BABYLON {
  103068. /**
  103069. * Block used to multiply 2 values
  103070. */
  103071. export class MultiplyBlock extends NodeMaterialBlock {
  103072. /**
  103073. * Creates a new MultiplyBlock
  103074. * @param name defines the block name
  103075. */
  103076. constructor(name: string);
  103077. /**
  103078. * Gets the current class name
  103079. * @returns the class name
  103080. */
  103081. getClassName(): string;
  103082. /**
  103083. * Gets the left operand input component
  103084. */
  103085. get left(): NodeMaterialConnectionPoint;
  103086. /**
  103087. * Gets the right operand input component
  103088. */
  103089. get right(): NodeMaterialConnectionPoint;
  103090. /**
  103091. * Gets the output component
  103092. */
  103093. get output(): NodeMaterialConnectionPoint;
  103094. protected _buildBlock(state: NodeMaterialBuildState): this;
  103095. }
  103096. }
  103097. declare module BABYLON {
  103098. /**
  103099. * Block used to expand a Color3/4 into 4 outputs (one for each component)
  103100. */
  103101. export class ColorSplitterBlock extends NodeMaterialBlock {
  103102. /**
  103103. * Create a new ColorSplitterBlock
  103104. * @param name defines the block name
  103105. */
  103106. constructor(name: string);
  103107. /**
  103108. * Gets the current class name
  103109. * @returns the class name
  103110. */
  103111. getClassName(): string;
  103112. /**
  103113. * Gets the rgba component (input)
  103114. */
  103115. get rgba(): NodeMaterialConnectionPoint;
  103116. /**
  103117. * Gets the rgb component (input)
  103118. */
  103119. get rgbIn(): NodeMaterialConnectionPoint;
  103120. /**
  103121. * Gets the rgb component (output)
  103122. */
  103123. get rgbOut(): NodeMaterialConnectionPoint;
  103124. /**
  103125. * Gets the r component (output)
  103126. */
  103127. get r(): NodeMaterialConnectionPoint;
  103128. /**
  103129. * Gets the g component (output)
  103130. */
  103131. get g(): NodeMaterialConnectionPoint;
  103132. /**
  103133. * Gets the b component (output)
  103134. */
  103135. get b(): NodeMaterialConnectionPoint;
  103136. /**
  103137. * Gets the a component (output)
  103138. */
  103139. get a(): NodeMaterialConnectionPoint;
  103140. protected _inputRename(name: string): string;
  103141. protected _outputRename(name: string): string;
  103142. protected _buildBlock(state: NodeMaterialBuildState): this | undefined;
  103143. }
  103144. }
  103145. declare module BABYLON {
  103146. /**
  103147. * Operations supported by the Trigonometry block
  103148. */
  103149. export enum TrigonometryBlockOperations {
  103150. /** Cos */
  103151. Cos = 0,
  103152. /** Sin */
  103153. Sin = 1,
  103154. /** Abs */
  103155. Abs = 2,
  103156. /** Exp */
  103157. Exp = 3,
  103158. /** Exp2 */
  103159. Exp2 = 4,
  103160. /** Round */
  103161. Round = 5,
  103162. /** Floor */
  103163. Floor = 6,
  103164. /** Ceiling */
  103165. Ceiling = 7,
  103166. /** Square root */
  103167. Sqrt = 8,
  103168. /** Log */
  103169. Log = 9,
  103170. /** Tangent */
  103171. Tan = 10,
  103172. /** Arc tangent */
  103173. ArcTan = 11,
  103174. /** Arc cosinus */
  103175. ArcCos = 12,
  103176. /** Arc sinus */
  103177. ArcSin = 13,
  103178. /** Fraction */
  103179. Fract = 14,
  103180. /** Sign */
  103181. Sign = 15,
  103182. /** To radians (from degrees) */
  103183. Radians = 16,
  103184. /** To degrees (from radians) */
  103185. Degrees = 17
  103186. }
  103187. /**
  103188. * Block used to apply trigonometry operation to floats
  103189. */
  103190. export class TrigonometryBlock extends NodeMaterialBlock {
  103191. /**
  103192. * Gets or sets the operation applied by the block
  103193. */
  103194. operation: TrigonometryBlockOperations;
  103195. /**
  103196. * Creates a new TrigonometryBlock
  103197. * @param name defines the block name
  103198. */
  103199. constructor(name: string);
  103200. /**
  103201. * Gets the current class name
  103202. * @returns the class name
  103203. */
  103204. getClassName(): string;
  103205. /**
  103206. * Gets the input component
  103207. */
  103208. get input(): NodeMaterialConnectionPoint;
  103209. /**
  103210. * Gets the output component
  103211. */
  103212. get output(): NodeMaterialConnectionPoint;
  103213. protected _buildBlock(state: NodeMaterialBuildState): this;
  103214. serialize(): any;
  103215. _deserialize(serializationObject: any, scene: Scene, rootUrl: string): void;
  103216. protected _dumpPropertiesCode(): string;
  103217. }
  103218. }
  103219. declare module BABYLON {
  103220. /**
  103221. * Interface used to configure the node material editor
  103222. */
  103223. export interface INodeMaterialEditorOptions {
  103224. /** Define the URl to load node editor script */
  103225. editorURL?: string;
  103226. }
  103227. /** @hidden */
  103228. export class NodeMaterialDefines extends MaterialDefines implements IImageProcessingConfigurationDefines {
  103229. NORMAL: boolean;
  103230. TANGENT: boolean;
  103231. UV1: boolean;
  103232. /** BONES */
  103233. NUM_BONE_INFLUENCERS: number;
  103234. BonesPerMesh: number;
  103235. BONETEXTURE: boolean;
  103236. /** MORPH TARGETS */
  103237. MORPHTARGETS: boolean;
  103238. MORPHTARGETS_NORMAL: boolean;
  103239. MORPHTARGETS_TANGENT: boolean;
  103240. MORPHTARGETS_UV: boolean;
  103241. NUM_MORPH_INFLUENCERS: number;
  103242. /** IMAGE PROCESSING */
  103243. IMAGEPROCESSING: boolean;
  103244. VIGNETTE: boolean;
  103245. VIGNETTEBLENDMODEMULTIPLY: boolean;
  103246. VIGNETTEBLENDMODEOPAQUE: boolean;
  103247. TONEMAPPING: boolean;
  103248. TONEMAPPING_ACES: boolean;
  103249. CONTRAST: boolean;
  103250. EXPOSURE: boolean;
  103251. COLORCURVES: boolean;
  103252. COLORGRADING: boolean;
  103253. COLORGRADING3D: boolean;
  103254. SAMPLER3DGREENDEPTH: boolean;
  103255. SAMPLER3DBGRMAP: boolean;
  103256. IMAGEPROCESSINGPOSTPROCESS: boolean;
  103257. /** MISC. */
  103258. BUMPDIRECTUV: number;
  103259. constructor();
  103260. setValue(name: string, value: any, markAsUnprocessedIfDirty?: boolean): void;
  103261. }
  103262. /**
  103263. * Class used to configure NodeMaterial
  103264. */
  103265. export interface INodeMaterialOptions {
  103266. /**
  103267. * Defines if blocks should emit comments
  103268. */
  103269. emitComments: boolean;
  103270. }
  103271. /**
  103272. * Class used to create a node based material built by assembling shader blocks
  103273. */
  103274. export class NodeMaterial extends PushMaterial {
  103275. private static _BuildIdGenerator;
  103276. private _options;
  103277. private _vertexCompilationState;
  103278. private _fragmentCompilationState;
  103279. private _sharedData;
  103280. private _buildId;
  103281. private _buildWasSuccessful;
  103282. private _cachedWorldViewMatrix;
  103283. private _cachedWorldViewProjectionMatrix;
  103284. private _optimizers;
  103285. private _animationFrame;
  103286. /** Define the Url to load node editor script */
  103287. static EditorURL: string;
  103288. /** Define the Url to load snippets */
  103289. static SnippetUrl: string;
  103290. /** Gets or sets a boolean indicating that node materials should not deserialize textures from json / snippet content */
  103291. static IgnoreTexturesAtLoadTime: boolean;
  103292. private BJSNODEMATERIALEDITOR;
  103293. /** Get the inspector from bundle or global */
  103294. private _getGlobalNodeMaterialEditor;
  103295. /**
  103296. * Snippet ID if the material was created from the snippet server
  103297. */
  103298. snippetId: string;
  103299. /**
  103300. * Gets or sets data used by visual editor
  103301. * @see https://nme.babylonjs.com
  103302. */
  103303. editorData: any;
  103304. /**
  103305. * 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)
  103306. */
  103307. ignoreAlpha: boolean;
  103308. /**
  103309. * Defines the maximum number of lights that can be used in the material
  103310. */
  103311. maxSimultaneousLights: number;
  103312. /**
  103313. * Observable raised when the material is built
  103314. */
  103315. onBuildObservable: Observable<NodeMaterial>;
  103316. /**
  103317. * Gets or sets the root nodes of the material vertex shader
  103318. */
  103319. _vertexOutputNodes: NodeMaterialBlock[];
  103320. /**
  103321. * Gets or sets the root nodes of the material fragment (pixel) shader
  103322. */
  103323. _fragmentOutputNodes: NodeMaterialBlock[];
  103324. /** Gets or sets options to control the node material overall behavior */
  103325. get options(): INodeMaterialOptions;
  103326. set options(options: INodeMaterialOptions);
  103327. /**
  103328. * Default configuration related to image processing available in the standard Material.
  103329. */
  103330. protected _imageProcessingConfiguration: ImageProcessingConfiguration;
  103331. /**
  103332. * Gets the image processing configuration used either in this material.
  103333. */
  103334. get imageProcessingConfiguration(): ImageProcessingConfiguration;
  103335. /**
  103336. * Sets the Default image processing configuration used either in the this material.
  103337. *
  103338. * If sets to null, the scene one is in use.
  103339. */
  103340. set imageProcessingConfiguration(value: ImageProcessingConfiguration);
  103341. /**
  103342. * Gets an array of blocks that needs to be serialized even if they are not yet connected
  103343. */
  103344. attachedBlocks: NodeMaterialBlock[];
  103345. /**
  103346. * Specifies the mode of the node material
  103347. * @hidden
  103348. */
  103349. _mode: NodeMaterialModes;
  103350. /**
  103351. * Gets the mode property
  103352. */
  103353. get mode(): NodeMaterialModes;
  103354. /**
  103355. * Create a new node based material
  103356. * @param name defines the material name
  103357. * @param scene defines the hosting scene
  103358. * @param options defines creation option
  103359. */
  103360. constructor(name: string, scene?: Scene, options?: Partial<INodeMaterialOptions>);
  103361. /**
  103362. * Gets the current class name of the material e.g. "NodeMaterial"
  103363. * @returns the class name
  103364. */
  103365. getClassName(): string;
  103366. /**
  103367. * Keep track of the image processing observer to allow dispose and replace.
  103368. */
  103369. private _imageProcessingObserver;
  103370. /**
  103371. * Attaches a new image processing configuration to the Standard Material.
  103372. * @param configuration
  103373. */
  103374. protected _attachImageProcessingConfiguration(configuration: Nullable<ImageProcessingConfiguration>): void;
  103375. /**
  103376. * Get a block by its name
  103377. * @param name defines the name of the block to retrieve
  103378. * @returns the required block or null if not found
  103379. */
  103380. getBlockByName(name: string): Nullable<NodeMaterialBlock>;
  103381. /**
  103382. * Get a block by its name
  103383. * @param predicate defines the predicate used to find the good candidate
  103384. * @returns the required block or null if not found
  103385. */
  103386. getBlockByPredicate(predicate: (block: NodeMaterialBlock) => boolean): Nullable<NodeMaterialBlock>;
  103387. /**
  103388. * Get an input block by its name
  103389. * @param predicate defines the predicate used to find the good candidate
  103390. * @returns the required input block or null if not found
  103391. */
  103392. getInputBlockByPredicate(predicate: (block: InputBlock) => boolean): Nullable<InputBlock>;
  103393. /**
  103394. * Gets the list of input blocks attached to this material
  103395. * @returns an array of InputBlocks
  103396. */
  103397. getInputBlocks(): InputBlock[];
  103398. /**
  103399. * Adds a new optimizer to the list of optimizers
  103400. * @param optimizer defines the optimizers to add
  103401. * @returns the current material
  103402. */
  103403. registerOptimizer(optimizer: NodeMaterialOptimizer): this | undefined;
  103404. /**
  103405. * Remove an optimizer from the list of optimizers
  103406. * @param optimizer defines the optimizers to remove
  103407. * @returns the current material
  103408. */
  103409. unregisterOptimizer(optimizer: NodeMaterialOptimizer): this | undefined;
  103410. /**
  103411. * Add a new block to the list of output nodes
  103412. * @param node defines the node to add
  103413. * @returns the current material
  103414. */
  103415. addOutputNode(node: NodeMaterialBlock): this;
  103416. /**
  103417. * Remove a block from the list of root nodes
  103418. * @param node defines the node to remove
  103419. * @returns the current material
  103420. */
  103421. removeOutputNode(node: NodeMaterialBlock): this;
  103422. private _addVertexOutputNode;
  103423. private _removeVertexOutputNode;
  103424. private _addFragmentOutputNode;
  103425. private _removeFragmentOutputNode;
  103426. /**
  103427. * Specifies if the material will require alpha blending
  103428. * @returns a boolean specifying if alpha blending is needed
  103429. */
  103430. needAlphaBlending(): boolean;
  103431. /**
  103432. * Specifies if this material should be rendered in alpha test mode
  103433. * @returns a boolean specifying if an alpha test is needed.
  103434. */
  103435. needAlphaTesting(): boolean;
  103436. private _initializeBlock;
  103437. private _resetDualBlocks;
  103438. /**
  103439. * Remove a block from the current node material
  103440. * @param block defines the block to remove
  103441. */
  103442. removeBlock(block: NodeMaterialBlock): void;
  103443. /**
  103444. * Build the material and generates the inner effect
  103445. * @param verbose defines if the build should log activity
  103446. */
  103447. build(verbose?: boolean): void;
  103448. /**
  103449. * Runs an otpimization phase to try to improve the shader code
  103450. */
  103451. optimize(): void;
  103452. private _prepareDefinesForAttributes;
  103453. /**
  103454. * Create a post process from the material
  103455. * @param camera The camera to apply the render pass to.
  103456. * @param options The required width/height ratio to downsize to before computing the render pass. (Use 1.0 for full size)
  103457. * @param samplingMode The sampling mode to be used when computing the pass. (default: 0)
  103458. * @param engine The engine which the post process will be applied. (default: current engine)
  103459. * @param reusable If the post process can be reused on the same frame. (default: false)
  103460. * @param textureType Type of textures used when performing the post process. (default: 0)
  103461. * @param textureFormat Format of textures used when performing the post process. (default: TEXTUREFORMAT_RGBA)
  103462. * @returns the post process created
  103463. */
  103464. createPostProcess(camera: Nullable<Camera>, options?: number | PostProcessOptions, samplingMode?: number, engine?: Engine, reusable?: boolean, textureType?: number, textureFormat?: number): Nullable<PostProcess>;
  103465. /**
  103466. * Create the post process effect from the material
  103467. * @param postProcess The post process to create the effect for
  103468. */
  103469. createEffectForPostProcess(postProcess: PostProcess): void;
  103470. private _createEffectForPostProcess;
  103471. /**
  103472. * Create a new procedural texture based on this node material
  103473. * @param size defines the size of the texture
  103474. * @param scene defines the hosting scene
  103475. * @returns the new procedural texture attached to this node material
  103476. */
  103477. createProceduralTexture(size: number | {
  103478. width: number;
  103479. height: number;
  103480. layers?: number;
  103481. }, scene: Scene): Nullable<ProceduralTexture>;
  103482. private _createEffectForParticles;
  103483. private _checkInternals;
  103484. /**
  103485. * Create the effect to be used as the custom effect for a particle system
  103486. * @param particleSystem Particle system to create the effect for
  103487. * @param onCompiled defines a function to call when the effect creation is successful
  103488. * @param onError defines a function to call when the effect creation has failed
  103489. */
  103490. createEffectForParticles(particleSystem: IParticleSystem, onCompiled?: (effect: Effect) => void, onError?: (effect: Effect, errors: string) => void): void;
  103491. private _processDefines;
  103492. /**
  103493. * Get if the submesh is ready to be used and all its information available.
  103494. * Child classes can use it to update shaders
  103495. * @param mesh defines the mesh to check
  103496. * @param subMesh defines which submesh to check
  103497. * @param useInstances specifies that instances should be used
  103498. * @returns a boolean indicating that the submesh is ready or not
  103499. */
  103500. isReadyForSubMesh(mesh: AbstractMesh, subMesh: SubMesh, useInstances?: boolean): boolean;
  103501. /**
  103502. * Get a string representing the shaders built by the current node graph
  103503. */
  103504. get compiledShaders(): string;
  103505. /**
  103506. * Binds the world matrix to the material
  103507. * @param world defines the world transformation matrix
  103508. */
  103509. bindOnlyWorldMatrix(world: Matrix): void;
  103510. /**
  103511. * Binds the submesh to this material by preparing the effect and shader to draw
  103512. * @param world defines the world transformation matrix
  103513. * @param mesh defines the mesh containing the submesh
  103514. * @param subMesh defines the submesh to bind the material to
  103515. */
  103516. bindForSubMesh(world: Matrix, mesh: Mesh, subMesh: SubMesh): void;
  103517. /**
  103518. * Gets the active textures from the material
  103519. * @returns an array of textures
  103520. */
  103521. getActiveTextures(): BaseTexture[];
  103522. /**
  103523. * Gets the list of texture blocks
  103524. * @returns an array of texture blocks
  103525. */
  103526. getTextureBlocks(): (TextureBlock | ReflectionTextureBaseBlock | RefractionBlock | CurrentScreenBlock | ParticleTextureBlock)[];
  103527. /**
  103528. * Specifies if the material uses a texture
  103529. * @param texture defines the texture to check against the material
  103530. * @returns a boolean specifying if the material uses the texture
  103531. */
  103532. hasTexture(texture: BaseTexture): boolean;
  103533. /**
  103534. * Disposes the material
  103535. * @param forceDisposeEffect specifies if effects should be forcefully disposed
  103536. * @param forceDisposeTextures specifies if textures should be forcefully disposed
  103537. * @param notBoundToMesh specifies if the material that is being disposed is known to be not bound to any mesh
  103538. */
  103539. dispose(forceDisposeEffect?: boolean, forceDisposeTextures?: boolean, notBoundToMesh?: boolean): void;
  103540. /** Creates the node editor window. */
  103541. private _createNodeEditor;
  103542. /**
  103543. * Launch the node material editor
  103544. * @param config Define the configuration of the editor
  103545. * @return a promise fulfilled when the node editor is visible
  103546. */
  103547. edit(config?: INodeMaterialEditorOptions): Promise<void>;
  103548. /**
  103549. * Clear the current material
  103550. */
  103551. clear(): void;
  103552. /**
  103553. * Clear the current material and set it to a default state
  103554. */
  103555. setToDefault(): void;
  103556. /**
  103557. * Clear the current material and set it to a default state for post process
  103558. */
  103559. setToDefaultPostProcess(): void;
  103560. /**
  103561. * Clear the current material and set it to a default state for procedural texture
  103562. */
  103563. setToDefaultProceduralTexture(): void;
  103564. /**
  103565. * Clear the current material and set it to a default state for particle
  103566. */
  103567. setToDefaultParticle(): void;
  103568. /**
  103569. * Loads the current Node Material from a url pointing to a file save by the Node Material Editor
  103570. * @param url defines the url to load from
  103571. * @returns a promise that will fullfil when the material is fully loaded
  103572. */
  103573. loadAsync(url: string): Promise<void>;
  103574. private _gatherBlocks;
  103575. /**
  103576. * Generate a string containing the code declaration required to create an equivalent of this material
  103577. * @returns a string
  103578. */
  103579. generateCode(): string;
  103580. /**
  103581. * Serializes this material in a JSON representation
  103582. * @returns the serialized material object
  103583. */
  103584. serialize(selectedBlocks?: NodeMaterialBlock[]): any;
  103585. private _restoreConnections;
  103586. /**
  103587. * Clear the current graph and load a new one from a serialization object
  103588. * @param source defines the JSON representation of the material
  103589. * @param rootUrl defines the root URL to use to load textures and relative dependencies
  103590. * @param merge defines whether or not the source must be merged or replace the current content
  103591. */
  103592. loadFromSerialization(source: any, rootUrl?: string, merge?: boolean): void;
  103593. /**
  103594. * Makes a duplicate of the current material.
  103595. * @param name - name to use for the new material.
  103596. */
  103597. clone(name: string): NodeMaterial;
  103598. /**
  103599. * Creates a node material from parsed material data
  103600. * @param source defines the JSON representation of the material
  103601. * @param scene defines the hosting scene
  103602. * @param rootUrl defines the root URL to use to load textures and relative dependencies
  103603. * @returns a new node material
  103604. */
  103605. static Parse(source: any, scene: Scene, rootUrl?: string): NodeMaterial;
  103606. /**
  103607. * Creates a node material from a snippet saved in a remote file
  103608. * @param name defines the name of the material to create
  103609. * @param url defines the url to load from
  103610. * @param scene defines the hosting scene
  103611. * @returns a promise that will resolve to the new node material
  103612. */
  103613. static ParseFromFileAsync(name: string, url: string, scene: Scene): Promise<NodeMaterial>;
  103614. /**
  103615. * Creates a node material from a snippet saved by the node material editor
  103616. * @param snippetId defines the snippet to load
  103617. * @param scene defines the hosting scene
  103618. * @param rootUrl defines the root URL to use to load textures and relative dependencies
  103619. * @param nodeMaterial defines a node material to update (instead of creating a new one)
  103620. * @returns a promise that will resolve to the new node material
  103621. */
  103622. static ParseFromSnippetAsync(snippetId: string, scene: Scene, rootUrl?: string, nodeMaterial?: NodeMaterial): Promise<NodeMaterial>;
  103623. /**
  103624. * Creates a new node material set to default basic configuration
  103625. * @param name defines the name of the material
  103626. * @param scene defines the hosting scene
  103627. * @returns a new NodeMaterial
  103628. */
  103629. static CreateDefault(name: string, scene?: Scene): NodeMaterial;
  103630. }
  103631. }
  103632. declare module BABYLON {
  103633. interface ThinEngine {
  103634. /**
  103635. * Unbind a list of render target textures from the webGL context
  103636. * This is used only when drawBuffer extension or webGL2 are active
  103637. * @param textures defines the render target textures to unbind
  103638. * @param disableGenerateMipMaps defines a boolean indicating that mipmaps must not be generated
  103639. * @param onBeforeUnbind defines a function which will be called before the effective unbind
  103640. */
  103641. unBindMultiColorAttachmentFramebuffer(textures: InternalTexture[], disableGenerateMipMaps: boolean, onBeforeUnbind?: () => void): void;
  103642. /**
  103643. * Create a multi render target texture
  103644. * @see https://doc.babylonjs.com/features/webgl2#multiple-render-target
  103645. * @param size defines the size of the texture
  103646. * @param options defines the creation options
  103647. * @returns the cube texture as an InternalTexture
  103648. */
  103649. createMultipleRenderTarget(size: any, options: IMultiRenderTargetOptions): InternalTexture[];
  103650. /**
  103651. * Update the sample count for a given multiple render target texture
  103652. * @see https://doc.babylonjs.com/features/webgl2#multisample-render-targets
  103653. * @param textures defines the textures to update
  103654. * @param samples defines the sample count to set
  103655. * @returns the effective sample count (could be 0 if multisample render targets are not supported)
  103656. */
  103657. updateMultipleRenderTargetTextureSampleCount(textures: Nullable<InternalTexture[]>, samples: number): number;
  103658. /**
  103659. * Select a subsets of attachments to draw to.
  103660. * @param attachments gl attachments
  103661. */
  103662. bindAttachments(attachments: number[]): void;
  103663. /**
  103664. * Creates a layout object to draw/clear on specific textures in a MRT
  103665. * @param textureStatus textureStatus[i] indicates if the i-th is active
  103666. * @returns A layout to be fed to the engine, calling `bindAttachments`.
  103667. */
  103668. buildTextureLayout(textureStatus: boolean[]): number[];
  103669. /**
  103670. * Restores the webgl state to only draw on the main color attachment
  103671. */
  103672. restoreSingleAttachment(): void;
  103673. }
  103674. }
  103675. declare module BABYLON {
  103676. /**
  103677. * Creation options of the multi render target texture.
  103678. */
  103679. export interface IMultiRenderTargetOptions {
  103680. /**
  103681. * Define if the texture needs to create mip maps after render.
  103682. */
  103683. generateMipMaps?: boolean;
  103684. /**
  103685. * Define the types of all the draw buffers we want to create
  103686. */
  103687. types?: number[];
  103688. /**
  103689. * Define the sampling modes of all the draw buffers we want to create
  103690. */
  103691. samplingModes?: number[];
  103692. /**
  103693. * Define if a depth buffer is required
  103694. */
  103695. generateDepthBuffer?: boolean;
  103696. /**
  103697. * Define if a stencil buffer is required
  103698. */
  103699. generateStencilBuffer?: boolean;
  103700. /**
  103701. * Define if a depth texture is required instead of a depth buffer
  103702. */
  103703. generateDepthTexture?: boolean;
  103704. /**
  103705. * Define the number of desired draw buffers
  103706. */
  103707. textureCount?: number;
  103708. /**
  103709. * Define if aspect ratio should be adapted to the texture or stay the scene one
  103710. */
  103711. doNotChangeAspectRatio?: boolean;
  103712. /**
  103713. * Define the default type of the buffers we are creating
  103714. */
  103715. defaultType?: number;
  103716. }
  103717. /**
  103718. * A multi render target, like a render target provides the ability to render to a texture.
  103719. * Unlike the render target, it can render to several draw buffers in one draw.
  103720. * This is specially interesting in deferred rendering or for any effects requiring more than
  103721. * just one color from a single pass.
  103722. */
  103723. export class MultiRenderTarget extends RenderTargetTexture {
  103724. private _internalTextures;
  103725. private _textures;
  103726. private _multiRenderTargetOptions;
  103727. private _count;
  103728. /**
  103729. * Get if draw buffers are currently supported by the used hardware and browser.
  103730. */
  103731. get isSupported(): boolean;
  103732. /**
  103733. * Get the list of textures generated by the multi render target.
  103734. */
  103735. get textures(): Texture[];
  103736. /**
  103737. * Gets the number of textures in this MRT. This number can be different from `_textures.length` in case a depth texture is generated.
  103738. */
  103739. get count(): number;
  103740. /**
  103741. * Get the depth texture generated by the multi render target if options.generateDepthTexture has been set
  103742. */
  103743. get depthTexture(): Texture;
  103744. /**
  103745. * Set the wrapping mode on U of all the textures we are rendering to.
  103746. * Can be any of the Texture. (CLAMP_ADDRESSMODE, MIRROR_ADDRESSMODE or WRAP_ADDRESSMODE)
  103747. */
  103748. set wrapU(wrap: number);
  103749. /**
  103750. * Set the wrapping mode on V of all the textures we are rendering to.
  103751. * Can be any of the Texture. (CLAMP_ADDRESSMODE, MIRROR_ADDRESSMODE or WRAP_ADDRESSMODE)
  103752. */
  103753. set wrapV(wrap: number);
  103754. /**
  103755. * Instantiate a new multi render target texture.
  103756. * A multi render target, like a render target provides the ability to render to a texture.
  103757. * Unlike the render target, it can render to several draw buffers in one draw.
  103758. * This is specially interesting in deferred rendering or for any effects requiring more than
  103759. * just one color from a single pass.
  103760. * @param name Define the name of the texture
  103761. * @param size Define the size of the buffers to render to
  103762. * @param count Define the number of target we are rendering into
  103763. * @param scene Define the scene the texture belongs to
  103764. * @param options Define the options used to create the multi render target
  103765. */
  103766. constructor(name: string, size: any, count: number, scene: Scene, options?: IMultiRenderTargetOptions);
  103767. private _initTypes;
  103768. /** @hidden */
  103769. _rebuild(forceFullRebuild?: boolean): void;
  103770. private _createInternalTextures;
  103771. private _createTextures;
  103772. /**
  103773. * Replaces a texture within the MRT.
  103774. * @param texture The new texture to insert in the MRT
  103775. * @param index The index of the texture to replace
  103776. */
  103777. replaceTexture(texture: Texture, index: number): void;
  103778. /**
  103779. * Define the number of samples used if MSAA is enabled.
  103780. */
  103781. get samples(): number;
  103782. set samples(value: number);
  103783. /**
  103784. * Resize all the textures in the multi render target.
  103785. * Be careful as it will recreate all the data in the new texture.
  103786. * @param size Define the new size
  103787. */
  103788. resize(size: any): void;
  103789. /**
  103790. * Changes the number of render targets in this MRT
  103791. * Be careful as it will recreate all the data in the new texture.
  103792. * @param count new texture count
  103793. * @param options Specifies texture types and sampling modes for new textures
  103794. */
  103795. updateCount(count: number, options?: IMultiRenderTargetOptions): void;
  103796. protected unbindFrameBuffer(engine: Engine, faceIndex: number): void;
  103797. /**
  103798. * Dispose the render targets and their associated resources
  103799. */
  103800. dispose(): void;
  103801. /**
  103802. * Release all the underlying texture used as draw buffers.
  103803. */
  103804. releaseInternalTextures(): void;
  103805. }
  103806. }
  103807. declare module BABYLON {
  103808. /** @hidden */
  103809. export var imageProcessingPixelShader: {
  103810. name: string;
  103811. shader: string;
  103812. };
  103813. }
  103814. declare module BABYLON {
  103815. /**
  103816. * ImageProcessingPostProcess
  103817. * @see https://doc.babylonjs.com/how_to/how_to_use_postprocesses#imageprocessing
  103818. */
  103819. export class ImageProcessingPostProcess extends PostProcess {
  103820. /**
  103821. * Default configuration related to image processing available in the PBR Material.
  103822. */
  103823. protected _imageProcessingConfiguration: ImageProcessingConfiguration;
  103824. /**
  103825. * Gets the image processing configuration used either in this material.
  103826. */
  103827. get imageProcessingConfiguration(): ImageProcessingConfiguration;
  103828. /**
  103829. * Sets the Default image processing configuration used either in the this material.
  103830. *
  103831. * If sets to null, the scene one is in use.
  103832. */
  103833. set imageProcessingConfiguration(value: ImageProcessingConfiguration);
  103834. /**
  103835. * Keep track of the image processing observer to allow dispose and replace.
  103836. */
  103837. private _imageProcessingObserver;
  103838. /**
  103839. * Attaches a new image processing configuration to the PBR Material.
  103840. * @param configuration
  103841. */
  103842. protected _attachImageProcessingConfiguration(configuration: Nullable<ImageProcessingConfiguration>, doNotBuild?: boolean): void;
  103843. /**
  103844. * If the post process is supported.
  103845. */
  103846. get isSupported(): boolean;
  103847. /**
  103848. * Gets Color curves setup used in the effect if colorCurvesEnabled is set to true .
  103849. */
  103850. get colorCurves(): Nullable<ColorCurves>;
  103851. /**
  103852. * Sets Color curves setup used in the effect if colorCurvesEnabled is set to true .
  103853. */
  103854. set colorCurves(value: Nullable<ColorCurves>);
  103855. /**
  103856. * Gets wether the color curves effect is enabled.
  103857. */
  103858. get colorCurvesEnabled(): boolean;
  103859. /**
  103860. * Sets wether the color curves effect is enabled.
  103861. */
  103862. set colorCurvesEnabled(value: boolean);
  103863. /**
  103864. * Gets Color grading LUT texture used in the effect if colorGradingEnabled is set to true.
  103865. */
  103866. get colorGradingTexture(): Nullable<BaseTexture>;
  103867. /**
  103868. * Sets Color grading LUT texture used in the effect if colorGradingEnabled is set to true.
  103869. */
  103870. set colorGradingTexture(value: Nullable<BaseTexture>);
  103871. /**
  103872. * Gets wether the color grading effect is enabled.
  103873. */
  103874. get colorGradingEnabled(): boolean;
  103875. /**
  103876. * Gets wether the color grading effect is enabled.
  103877. */
  103878. set colorGradingEnabled(value: boolean);
  103879. /**
  103880. * Gets exposure used in the effect.
  103881. */
  103882. get exposure(): number;
  103883. /**
  103884. * Sets exposure used in the effect.
  103885. */
  103886. set exposure(value: number);
  103887. /**
  103888. * Gets wether tonemapping is enabled or not.
  103889. */
  103890. get toneMappingEnabled(): boolean;
  103891. /**
  103892. * Sets wether tonemapping is enabled or not
  103893. */
  103894. set toneMappingEnabled(value: boolean);
  103895. /**
  103896. * Gets the type of tone mapping effect.
  103897. */
  103898. get toneMappingType(): number;
  103899. /**
  103900. * Sets the type of tone mapping effect.
  103901. */
  103902. set toneMappingType(value: number);
  103903. /**
  103904. * Gets contrast used in the effect.
  103905. */
  103906. get contrast(): number;
  103907. /**
  103908. * Sets contrast used in the effect.
  103909. */
  103910. set contrast(value: number);
  103911. /**
  103912. * Gets Vignette stretch size.
  103913. */
  103914. get vignetteStretch(): number;
  103915. /**
  103916. * Sets Vignette stretch size.
  103917. */
  103918. set vignetteStretch(value: number);
  103919. /**
  103920. * Gets Vignette centre X Offset.
  103921. */
  103922. get vignetteCentreX(): number;
  103923. /**
  103924. * Sets Vignette centre X Offset.
  103925. */
  103926. set vignetteCentreX(value: number);
  103927. /**
  103928. * Gets Vignette centre Y Offset.
  103929. */
  103930. get vignetteCentreY(): number;
  103931. /**
  103932. * Sets Vignette centre Y Offset.
  103933. */
  103934. set vignetteCentreY(value: number);
  103935. /**
  103936. * Gets Vignette weight or intensity of the vignette effect.
  103937. */
  103938. get vignetteWeight(): number;
  103939. /**
  103940. * Sets Vignette weight or intensity of the vignette effect.
  103941. */
  103942. set vignetteWeight(value: number);
  103943. /**
  103944. * Gets Color of the vignette applied on the screen through the chosen blend mode (vignetteBlendMode)
  103945. * if vignetteEnabled is set to true.
  103946. */
  103947. get vignetteColor(): Color4;
  103948. /**
  103949. * Sets Color of the vignette applied on the screen through the chosen blend mode (vignetteBlendMode)
  103950. * if vignetteEnabled is set to true.
  103951. */
  103952. set vignetteColor(value: Color4);
  103953. /**
  103954. * Gets Camera field of view used by the Vignette effect.
  103955. */
  103956. get vignetteCameraFov(): number;
  103957. /**
  103958. * Sets Camera field of view used by the Vignette effect.
  103959. */
  103960. set vignetteCameraFov(value: number);
  103961. /**
  103962. * Gets the vignette blend mode allowing different kind of effect.
  103963. */
  103964. get vignetteBlendMode(): number;
  103965. /**
  103966. * Sets the vignette blend mode allowing different kind of effect.
  103967. */
  103968. set vignetteBlendMode(value: number);
  103969. /**
  103970. * Gets wether the vignette effect is enabled.
  103971. */
  103972. get vignetteEnabled(): boolean;
  103973. /**
  103974. * Sets wether the vignette effect is enabled.
  103975. */
  103976. set vignetteEnabled(value: boolean);
  103977. private _fromLinearSpace;
  103978. /**
  103979. * Gets wether the input of the processing is in Gamma or Linear Space.
  103980. */
  103981. get fromLinearSpace(): boolean;
  103982. /**
  103983. * Sets wether the input of the processing is in Gamma or Linear Space.
  103984. */
  103985. set fromLinearSpace(value: boolean);
  103986. /**
  103987. * Defines cache preventing GC.
  103988. */
  103989. private _defines;
  103990. constructor(name: string, options: number | PostProcessOptions, camera?: Nullable<Camera>, samplingMode?: number, engine?: Engine, reusable?: boolean, textureType?: number, imageProcessingConfiguration?: ImageProcessingConfiguration);
  103991. /**
  103992. * "ImageProcessingPostProcess"
  103993. * @returns "ImageProcessingPostProcess"
  103994. */
  103995. getClassName(): string;
  103996. /**
  103997. * @hidden
  103998. */
  103999. _updateParameters(): void;
  104000. dispose(camera?: Camera): void;
  104001. }
  104002. }
  104003. declare module BABYLON {
  104004. /**
  104005. * Interface for defining prepass effects in the prepass post-process pipeline
  104006. */
  104007. export interface PrePassEffectConfiguration {
  104008. /**
  104009. * Name of the effect
  104010. */
  104011. name: string;
  104012. /**
  104013. * Post process to attach for this effect
  104014. */
  104015. postProcess?: PostProcess;
  104016. /**
  104017. * Textures required in the MRT
  104018. */
  104019. texturesRequired: number[];
  104020. /**
  104021. * Is the effect enabled
  104022. */
  104023. enabled: boolean;
  104024. /**
  104025. * Disposes the effect configuration
  104026. */
  104027. dispose?: () => void;
  104028. /**
  104029. * Creates the associated post process
  104030. */
  104031. createPostProcess?: () => PostProcess;
  104032. }
  104033. }
  104034. declare module BABYLON {
  104035. /**
  104036. * Options to be used when creating a FresnelParameters.
  104037. */
  104038. export type IFresnelParametersCreationOptions = {
  104039. /**
  104040. * Define the color used on edges (grazing angle)
  104041. */
  104042. leftColor?: Color3;
  104043. /**
  104044. * Define the color used on center
  104045. */
  104046. rightColor?: Color3;
  104047. /**
  104048. * Define bias applied to computed fresnel term
  104049. */
  104050. bias?: number;
  104051. /**
  104052. * Defined the power exponent applied to fresnel term
  104053. */
  104054. power?: number;
  104055. /**
  104056. * Define if the fresnel effect is enable or not.
  104057. */
  104058. isEnabled?: boolean;
  104059. };
  104060. /**
  104061. * Serialized format for FresnelParameters.
  104062. */
  104063. export type IFresnelParametersSerialized = {
  104064. /**
  104065. * Define the color used on edges (grazing angle) [as an array]
  104066. */
  104067. leftColor: number[];
  104068. /**
  104069. * Define the color used on center [as an array]
  104070. */
  104071. rightColor: number[];
  104072. /**
  104073. * Define bias applied to computed fresnel term
  104074. */
  104075. bias: number;
  104076. /**
  104077. * Defined the power exponent applied to fresnel term
  104078. */
  104079. power?: number;
  104080. /**
  104081. * Define if the fresnel effect is enable or not.
  104082. */
  104083. isEnabled: boolean;
  104084. };
  104085. /**
  104086. * This represents all the required information to add a fresnel effect on a material:
  104087. * @see https://doc.babylonjs.com/how_to/how_to_use_fresnelparameters
  104088. */
  104089. export class FresnelParameters {
  104090. private _isEnabled;
  104091. /**
  104092. * Define if the fresnel effect is enable or not.
  104093. */
  104094. get isEnabled(): boolean;
  104095. set isEnabled(value: boolean);
  104096. /**
  104097. * Define the color used on edges (grazing angle)
  104098. */
  104099. leftColor: Color3;
  104100. /**
  104101. * Define the color used on center
  104102. */
  104103. rightColor: Color3;
  104104. /**
  104105. * Define bias applied to computed fresnel term
  104106. */
  104107. bias: number;
  104108. /**
  104109. * Defined the power exponent applied to fresnel term
  104110. */
  104111. power: number;
  104112. /**
  104113. * Creates a new FresnelParameters object.
  104114. *
  104115. * @param options provide your own settings to optionally to override defaults
  104116. */
  104117. constructor(options?: IFresnelParametersCreationOptions);
  104118. /**
  104119. * Clones the current fresnel and its valuues
  104120. * @returns a clone fresnel configuration
  104121. */
  104122. clone(): FresnelParameters;
  104123. /**
  104124. * Determines equality between FresnelParameters objects
  104125. * @param otherFresnelParameters defines the second operand
  104126. * @returns true if the power, bias, leftColor, rightColor and isEnabled values are equal to the given ones
  104127. */
  104128. equals(otherFresnelParameters: DeepImmutable<FresnelParameters>): boolean;
  104129. /**
  104130. * Serializes the current fresnel parameters to a JSON representation.
  104131. * @return the JSON serialization
  104132. */
  104133. serialize(): IFresnelParametersSerialized;
  104134. /**
  104135. * Parse a JSON object and deserialize it to a new Fresnel parameter object.
  104136. * @param parsedFresnelParameters Define the JSON representation
  104137. * @returns the parsed parameters
  104138. */
  104139. static Parse(parsedFresnelParameters: IFresnelParametersSerialized): FresnelParameters;
  104140. }
  104141. }
  104142. declare module BABYLON {
  104143. /**
  104144. * This groups all the flags used to control the materials channel.
  104145. */
  104146. export class MaterialFlags {
  104147. private static _DiffuseTextureEnabled;
  104148. /**
  104149. * Are diffuse textures enabled in the application.
  104150. */
  104151. static get DiffuseTextureEnabled(): boolean;
  104152. static set DiffuseTextureEnabled(value: boolean);
  104153. private static _DetailTextureEnabled;
  104154. /**
  104155. * Are detail textures enabled in the application.
  104156. */
  104157. static get DetailTextureEnabled(): boolean;
  104158. static set DetailTextureEnabled(value: boolean);
  104159. private static _AmbientTextureEnabled;
  104160. /**
  104161. * Are ambient textures enabled in the application.
  104162. */
  104163. static get AmbientTextureEnabled(): boolean;
  104164. static set AmbientTextureEnabled(value: boolean);
  104165. private static _OpacityTextureEnabled;
  104166. /**
  104167. * Are opacity textures enabled in the application.
  104168. */
  104169. static get OpacityTextureEnabled(): boolean;
  104170. static set OpacityTextureEnabled(value: boolean);
  104171. private static _ReflectionTextureEnabled;
  104172. /**
  104173. * Are reflection textures enabled in the application.
  104174. */
  104175. static get ReflectionTextureEnabled(): boolean;
  104176. static set ReflectionTextureEnabled(value: boolean);
  104177. private static _EmissiveTextureEnabled;
  104178. /**
  104179. * Are emissive textures enabled in the application.
  104180. */
  104181. static get EmissiveTextureEnabled(): boolean;
  104182. static set EmissiveTextureEnabled(value: boolean);
  104183. private static _SpecularTextureEnabled;
  104184. /**
  104185. * Are specular textures enabled in the application.
  104186. */
  104187. static get SpecularTextureEnabled(): boolean;
  104188. static set SpecularTextureEnabled(value: boolean);
  104189. private static _BumpTextureEnabled;
  104190. /**
  104191. * Are bump textures enabled in the application.
  104192. */
  104193. static get BumpTextureEnabled(): boolean;
  104194. static set BumpTextureEnabled(value: boolean);
  104195. private static _LightmapTextureEnabled;
  104196. /**
  104197. * Are lightmap textures enabled in the application.
  104198. */
  104199. static get LightmapTextureEnabled(): boolean;
  104200. static set LightmapTextureEnabled(value: boolean);
  104201. private static _RefractionTextureEnabled;
  104202. /**
  104203. * Are refraction textures enabled in the application.
  104204. */
  104205. static get RefractionTextureEnabled(): boolean;
  104206. static set RefractionTextureEnabled(value: boolean);
  104207. private static _ColorGradingTextureEnabled;
  104208. /**
  104209. * Are color grading textures enabled in the application.
  104210. */
  104211. static get ColorGradingTextureEnabled(): boolean;
  104212. static set ColorGradingTextureEnabled(value: boolean);
  104213. private static _FresnelEnabled;
  104214. /**
  104215. * Are fresnels enabled in the application.
  104216. */
  104217. static get FresnelEnabled(): boolean;
  104218. static set FresnelEnabled(value: boolean);
  104219. private static _ClearCoatTextureEnabled;
  104220. /**
  104221. * Are clear coat textures enabled in the application.
  104222. */
  104223. static get ClearCoatTextureEnabled(): boolean;
  104224. static set ClearCoatTextureEnabled(value: boolean);
  104225. private static _ClearCoatBumpTextureEnabled;
  104226. /**
  104227. * Are clear coat bump textures enabled in the application.
  104228. */
  104229. static get ClearCoatBumpTextureEnabled(): boolean;
  104230. static set ClearCoatBumpTextureEnabled(value: boolean);
  104231. private static _ClearCoatTintTextureEnabled;
  104232. /**
  104233. * Are clear coat tint textures enabled in the application.
  104234. */
  104235. static get ClearCoatTintTextureEnabled(): boolean;
  104236. static set ClearCoatTintTextureEnabled(value: boolean);
  104237. private static _SheenTextureEnabled;
  104238. /**
  104239. * Are sheen textures enabled in the application.
  104240. */
  104241. static get SheenTextureEnabled(): boolean;
  104242. static set SheenTextureEnabled(value: boolean);
  104243. private static _AnisotropicTextureEnabled;
  104244. /**
  104245. * Are anisotropic textures enabled in the application.
  104246. */
  104247. static get AnisotropicTextureEnabled(): boolean;
  104248. static set AnisotropicTextureEnabled(value: boolean);
  104249. private static _ThicknessTextureEnabled;
  104250. /**
  104251. * Are thickness textures enabled in the application.
  104252. */
  104253. static get ThicknessTextureEnabled(): boolean;
  104254. static set ThicknessTextureEnabled(value: boolean);
  104255. }
  104256. }
  104257. declare module BABYLON {
  104258. /** @hidden */
  104259. export var defaultFragmentDeclaration: {
  104260. name: string;
  104261. shader: string;
  104262. };
  104263. }
  104264. declare module BABYLON {
  104265. /** @hidden */
  104266. export var defaultUboDeclaration: {
  104267. name: string;
  104268. shader: string;
  104269. };
  104270. }
  104271. declare module BABYLON {
  104272. /** @hidden */
  104273. export var prePassDeclaration: {
  104274. name: string;
  104275. shader: string;
  104276. };
  104277. }
  104278. declare module BABYLON {
  104279. /** @hidden */
  104280. export var lightFragmentDeclaration: {
  104281. name: string;
  104282. shader: string;
  104283. };
  104284. }
  104285. declare module BABYLON {
  104286. /** @hidden */
  104287. export var lightUboDeclaration: {
  104288. name: string;
  104289. shader: string;
  104290. };
  104291. }
  104292. declare module BABYLON {
  104293. /** @hidden */
  104294. export var lightsFragmentFunctions: {
  104295. name: string;
  104296. shader: string;
  104297. };
  104298. }
  104299. declare module BABYLON {
  104300. /** @hidden */
  104301. export var shadowsFragmentFunctions: {
  104302. name: string;
  104303. shader: string;
  104304. };
  104305. }
  104306. declare module BABYLON {
  104307. /** @hidden */
  104308. export var fresnelFunction: {
  104309. name: string;
  104310. shader: string;
  104311. };
  104312. }
  104313. declare module BABYLON {
  104314. /** @hidden */
  104315. export var bumpFragmentMainFunctions: {
  104316. name: string;
  104317. shader: string;
  104318. };
  104319. }
  104320. declare module BABYLON {
  104321. /** @hidden */
  104322. export var bumpFragmentFunctions: {
  104323. name: string;
  104324. shader: string;
  104325. };
  104326. }
  104327. declare module BABYLON {
  104328. /** @hidden */
  104329. export var logDepthDeclaration: {
  104330. name: string;
  104331. shader: string;
  104332. };
  104333. }
  104334. declare module BABYLON {
  104335. /** @hidden */
  104336. export var bumpFragment: {
  104337. name: string;
  104338. shader: string;
  104339. };
  104340. }
  104341. declare module BABYLON {
  104342. /** @hidden */
  104343. export var depthPrePass: {
  104344. name: string;
  104345. shader: string;
  104346. };
  104347. }
  104348. declare module BABYLON {
  104349. /** @hidden */
  104350. export var lightFragment: {
  104351. name: string;
  104352. shader: string;
  104353. };
  104354. }
  104355. declare module BABYLON {
  104356. /** @hidden */
  104357. export var logDepthFragment: {
  104358. name: string;
  104359. shader: string;
  104360. };
  104361. }
  104362. declare module BABYLON {
  104363. /** @hidden */
  104364. export var defaultPixelShader: {
  104365. name: string;
  104366. shader: string;
  104367. };
  104368. }
  104369. declare module BABYLON {
  104370. /** @hidden */
  104371. export var defaultVertexDeclaration: {
  104372. name: string;
  104373. shader: string;
  104374. };
  104375. }
  104376. declare module BABYLON {
  104377. /** @hidden */
  104378. export var prePassVertexDeclaration: {
  104379. name: string;
  104380. shader: string;
  104381. };
  104382. }
  104383. declare module BABYLON {
  104384. /** @hidden */
  104385. export var bumpVertexDeclaration: {
  104386. name: string;
  104387. shader: string;
  104388. };
  104389. }
  104390. declare module BABYLON {
  104391. /** @hidden */
  104392. export var prePassVertex: {
  104393. name: string;
  104394. shader: string;
  104395. };
  104396. }
  104397. declare module BABYLON {
  104398. /** @hidden */
  104399. export var bumpVertex: {
  104400. name: string;
  104401. shader: string;
  104402. };
  104403. }
  104404. declare module BABYLON {
  104405. /** @hidden */
  104406. export var fogVertex: {
  104407. name: string;
  104408. shader: string;
  104409. };
  104410. }
  104411. declare module BABYLON {
  104412. /** @hidden */
  104413. export var shadowsVertex: {
  104414. name: string;
  104415. shader: string;
  104416. };
  104417. }
  104418. declare module BABYLON {
  104419. /** @hidden */
  104420. export var pointCloudVertex: {
  104421. name: string;
  104422. shader: string;
  104423. };
  104424. }
  104425. declare module BABYLON {
  104426. /** @hidden */
  104427. export var logDepthVertex: {
  104428. name: string;
  104429. shader: string;
  104430. };
  104431. }
  104432. declare module BABYLON {
  104433. /** @hidden */
  104434. export var defaultVertexShader: {
  104435. name: string;
  104436. shader: string;
  104437. };
  104438. }
  104439. declare module BABYLON {
  104440. /**
  104441. * @hidden
  104442. */
  104443. export interface IMaterialDetailMapDefines {
  104444. DETAIL: boolean;
  104445. DETAILDIRECTUV: number;
  104446. DETAIL_NORMALBLENDMETHOD: number;
  104447. /** @hidden */
  104448. _areTexturesDirty: boolean;
  104449. }
  104450. /**
  104451. * Define the code related to the detail map parameters of a material
  104452. *
  104453. * Inspired from:
  104454. * 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
  104455. * Unreal: https://docs.unrealengine.com/en-US/Engine/Rendering/Materials/HowTo/DetailTexturing/index.html
  104456. * Cryengine: https://docs.cryengine.com/display/SDKDOC2/Detail+Maps
  104457. */
  104458. export class DetailMapConfiguration {
  104459. private _texture;
  104460. /**
  104461. * The detail texture of the material.
  104462. */
  104463. texture: Nullable<BaseTexture>;
  104464. /**
  104465. * Defines how strongly the detail diffuse/albedo channel is blended with the regular diffuse/albedo texture
  104466. * Bigger values mean stronger blending
  104467. */
  104468. diffuseBlendLevel: number;
  104469. /**
  104470. * Defines how strongly the detail roughness channel is blended with the regular roughness value
  104471. * Bigger values mean stronger blending. Only used with PBR materials
  104472. */
  104473. roughnessBlendLevel: number;
  104474. /**
  104475. * Defines how strong the bump effect from the detail map is
  104476. * Bigger values mean stronger effect
  104477. */
  104478. bumpLevel: number;
  104479. private _normalBlendMethod;
  104480. /**
  104481. * The method used to blend the bump and detail normals together
  104482. */
  104483. normalBlendMethod: number;
  104484. private _isEnabled;
  104485. /**
  104486. * Enable or disable the detail map on this material
  104487. */
  104488. isEnabled: boolean;
  104489. /** @hidden */
  104490. private _internalMarkAllSubMeshesAsTexturesDirty;
  104491. /** @hidden */
  104492. _markAllSubMeshesAsTexturesDirty(): void;
  104493. /**
  104494. * Instantiate a new detail map
  104495. * @param markAllSubMeshesAsTexturesDirty Callback to flag the material to dirty
  104496. */
  104497. constructor(markAllSubMeshesAsTexturesDirty: () => void);
  104498. /**
  104499. * Gets whether the submesh is ready to be used or not.
  104500. * @param defines the list of "defines" to update.
  104501. * @param scene defines the scene the material belongs to.
  104502. * @returns - boolean indicating that the submesh is ready or not.
  104503. */
  104504. isReadyForSubMesh(defines: IMaterialDetailMapDefines, scene: Scene): boolean;
  104505. /**
  104506. * Update the defines for detail map usage
  104507. * @param defines the list of "defines" to update.
  104508. * @param scene defines the scene the material belongs to.
  104509. */
  104510. prepareDefines(defines: IMaterialDetailMapDefines, scene: Scene): void;
  104511. /**
  104512. * Binds the material data.
  104513. * @param uniformBuffer defines the Uniform buffer to fill in.
  104514. * @param scene defines the scene the material belongs to.
  104515. * @param isFrozen defines whether the material is frozen or not.
  104516. */
  104517. bindForSubMesh(uniformBuffer: UniformBuffer, scene: Scene, isFrozen: boolean): void;
  104518. /**
  104519. * Checks to see if a texture is used in the material.
  104520. * @param texture - Base texture to use.
  104521. * @returns - Boolean specifying if a texture is used in the material.
  104522. */
  104523. hasTexture(texture: BaseTexture): boolean;
  104524. /**
  104525. * Returns an array of the actively used textures.
  104526. * @param activeTextures Array of BaseTextures
  104527. */
  104528. getActiveTextures(activeTextures: BaseTexture[]): void;
  104529. /**
  104530. * Returns the animatable textures.
  104531. * @param animatables Array of animatable textures.
  104532. */
  104533. getAnimatables(animatables: IAnimatable[]): void;
  104534. /**
  104535. * Disposes the resources of the material.
  104536. * @param forceDisposeTextures - Forces the disposal of all textures.
  104537. */
  104538. dispose(forceDisposeTextures?: boolean): void;
  104539. /**
  104540. * Get the current class name useful for serialization or dynamic coding.
  104541. * @returns "DetailMap"
  104542. */
  104543. getClassName(): string;
  104544. /**
  104545. * Add the required uniforms to the current list.
  104546. * @param uniforms defines the current uniform list.
  104547. */
  104548. static AddUniforms(uniforms: string[]): void;
  104549. /**
  104550. * Add the required samplers to the current list.
  104551. * @param samplers defines the current sampler list.
  104552. */
  104553. static AddSamplers(samplers: string[]): void;
  104554. /**
  104555. * Add the required uniforms to the current buffer.
  104556. * @param uniformBuffer defines the current uniform buffer.
  104557. */
  104558. static PrepareUniformBuffer(uniformBuffer: UniformBuffer): void;
  104559. /**
  104560. * Makes a duplicate of the current instance into another one.
  104561. * @param detailMap define the instance where to copy the info
  104562. */
  104563. copyTo(detailMap: DetailMapConfiguration): void;
  104564. /**
  104565. * Serializes this detail map instance
  104566. * @returns - An object with the serialized instance.
  104567. */
  104568. serialize(): any;
  104569. /**
  104570. * Parses a detail map setting from a serialized object.
  104571. * @param source - Serialized object.
  104572. * @param scene Defines the scene we are parsing for
  104573. * @param rootUrl Defines the rootUrl to load from
  104574. */
  104575. parse(source: any, scene: Scene, rootUrl: string): void;
  104576. }
  104577. }
  104578. declare module BABYLON {
  104579. /** @hidden */
  104580. export class StandardMaterialDefines extends MaterialDefines implements IImageProcessingConfigurationDefines, IMaterialDetailMapDefines {
  104581. MAINUV1: boolean;
  104582. MAINUV2: boolean;
  104583. DIFFUSE: boolean;
  104584. DIFFUSEDIRECTUV: number;
  104585. DETAIL: boolean;
  104586. DETAILDIRECTUV: number;
  104587. DETAIL_NORMALBLENDMETHOD: number;
  104588. AMBIENT: boolean;
  104589. AMBIENTDIRECTUV: number;
  104590. OPACITY: boolean;
  104591. OPACITYDIRECTUV: number;
  104592. OPACITYRGB: boolean;
  104593. REFLECTION: boolean;
  104594. EMISSIVE: boolean;
  104595. EMISSIVEDIRECTUV: number;
  104596. SPECULAR: boolean;
  104597. SPECULARDIRECTUV: number;
  104598. BUMP: boolean;
  104599. BUMPDIRECTUV: number;
  104600. PARALLAX: boolean;
  104601. PARALLAXOCCLUSION: boolean;
  104602. SPECULAROVERALPHA: boolean;
  104603. CLIPPLANE: boolean;
  104604. CLIPPLANE2: boolean;
  104605. CLIPPLANE3: boolean;
  104606. CLIPPLANE4: boolean;
  104607. CLIPPLANE5: boolean;
  104608. CLIPPLANE6: boolean;
  104609. ALPHATEST: boolean;
  104610. DEPTHPREPASS: boolean;
  104611. ALPHAFROMDIFFUSE: boolean;
  104612. POINTSIZE: boolean;
  104613. FOG: boolean;
  104614. SPECULARTERM: boolean;
  104615. DIFFUSEFRESNEL: boolean;
  104616. OPACITYFRESNEL: boolean;
  104617. REFLECTIONFRESNEL: boolean;
  104618. REFRACTIONFRESNEL: boolean;
  104619. EMISSIVEFRESNEL: boolean;
  104620. FRESNEL: boolean;
  104621. NORMAL: boolean;
  104622. UV1: boolean;
  104623. UV2: boolean;
  104624. VERTEXCOLOR: boolean;
  104625. VERTEXALPHA: boolean;
  104626. NUM_BONE_INFLUENCERS: number;
  104627. BonesPerMesh: number;
  104628. BONETEXTURE: boolean;
  104629. BONES_VELOCITY_ENABLED: boolean;
  104630. INSTANCES: boolean;
  104631. THIN_INSTANCES: boolean;
  104632. GLOSSINESS: boolean;
  104633. ROUGHNESS: boolean;
  104634. EMISSIVEASILLUMINATION: boolean;
  104635. LINKEMISSIVEWITHDIFFUSE: boolean;
  104636. REFLECTIONFRESNELFROMSPECULAR: boolean;
  104637. LIGHTMAP: boolean;
  104638. LIGHTMAPDIRECTUV: number;
  104639. OBJECTSPACE_NORMALMAP: boolean;
  104640. USELIGHTMAPASSHADOWMAP: boolean;
  104641. REFLECTIONMAP_3D: boolean;
  104642. REFLECTIONMAP_SPHERICAL: boolean;
  104643. REFLECTIONMAP_PLANAR: boolean;
  104644. REFLECTIONMAP_CUBIC: boolean;
  104645. USE_LOCAL_REFLECTIONMAP_CUBIC: boolean;
  104646. REFLECTIONMAP_PROJECTION: boolean;
  104647. REFLECTIONMAP_SKYBOX: boolean;
  104648. REFLECTIONMAP_EXPLICIT: boolean;
  104649. REFLECTIONMAP_EQUIRECTANGULAR: boolean;
  104650. REFLECTIONMAP_EQUIRECTANGULAR_FIXED: boolean;
  104651. REFLECTIONMAP_MIRROREDEQUIRECTANGULAR_FIXED: boolean;
  104652. INVERTCUBICMAP: boolean;
  104653. LOGARITHMICDEPTH: boolean;
  104654. REFRACTION: boolean;
  104655. REFRACTIONMAP_3D: boolean;
  104656. REFLECTIONOVERALPHA: boolean;
  104657. TWOSIDEDLIGHTING: boolean;
  104658. SHADOWFLOAT: boolean;
  104659. MORPHTARGETS: boolean;
  104660. MORPHTARGETS_NORMAL: boolean;
  104661. MORPHTARGETS_TANGENT: boolean;
  104662. MORPHTARGETS_UV: boolean;
  104663. NUM_MORPH_INFLUENCERS: number;
  104664. NONUNIFORMSCALING: boolean;
  104665. PREMULTIPLYALPHA: boolean;
  104666. ALPHATEST_AFTERALLALPHACOMPUTATIONS: boolean;
  104667. ALPHABLEND: boolean;
  104668. PREPASS: boolean;
  104669. PREPASS_IRRADIANCE: boolean;
  104670. PREPASS_IRRADIANCE_INDEX: number;
  104671. PREPASS_ALBEDO: boolean;
  104672. PREPASS_ALBEDO_INDEX: number;
  104673. PREPASS_DEPTHNORMAL: boolean;
  104674. PREPASS_DEPTHNORMAL_INDEX: number;
  104675. PREPASS_POSITION: boolean;
  104676. PREPASS_POSITION_INDEX: number;
  104677. PREPASS_VELOCITY: boolean;
  104678. PREPASS_VELOCITY_INDEX: number;
  104679. PREPASS_REFLECTIVITY: boolean;
  104680. PREPASS_REFLECTIVITY_INDEX: number;
  104681. SCENE_MRT_COUNT: number;
  104682. RGBDLIGHTMAP: boolean;
  104683. RGBDREFLECTION: boolean;
  104684. RGBDREFRACTION: boolean;
  104685. IMAGEPROCESSING: boolean;
  104686. VIGNETTE: boolean;
  104687. VIGNETTEBLENDMODEMULTIPLY: boolean;
  104688. VIGNETTEBLENDMODEOPAQUE: boolean;
  104689. TONEMAPPING: boolean;
  104690. TONEMAPPING_ACES: boolean;
  104691. CONTRAST: boolean;
  104692. COLORCURVES: boolean;
  104693. COLORGRADING: boolean;
  104694. COLORGRADING3D: boolean;
  104695. SAMPLER3DGREENDEPTH: boolean;
  104696. SAMPLER3DBGRMAP: boolean;
  104697. IMAGEPROCESSINGPOSTPROCESS: boolean;
  104698. MULTIVIEW: boolean;
  104699. /**
  104700. * If the reflection texture on this material is in linear color space
  104701. * @hidden
  104702. */
  104703. IS_REFLECTION_LINEAR: boolean;
  104704. /**
  104705. * If the refraction texture on this material is in linear color space
  104706. * @hidden
  104707. */
  104708. IS_REFRACTION_LINEAR: boolean;
  104709. EXPOSURE: boolean;
  104710. constructor();
  104711. setReflectionMode(modeToEnable: string): void;
  104712. }
  104713. /**
  104714. * This is the default material used in Babylon. It is the best trade off between quality
  104715. * and performances.
  104716. * @see https://doc.babylonjs.com/babylon101/materials
  104717. */
  104718. export class StandardMaterial extends PushMaterial {
  104719. private _diffuseTexture;
  104720. /**
  104721. * The basic texture of the material as viewed under a light.
  104722. */
  104723. diffuseTexture: Nullable<BaseTexture>;
  104724. private _ambientTexture;
  104725. /**
  104726. * AKA Occlusion Texture in other nomenclature, it helps adding baked shadows into your material.
  104727. */
  104728. ambientTexture: Nullable<BaseTexture>;
  104729. private _opacityTexture;
  104730. /**
  104731. * Define the transparency of the material from a texture.
  104732. * The final alpha value can be read either from the red channel (if texture.getAlphaFromRGB is false)
  104733. * or from the luminance or the current texel (if texture.getAlphaFromRGB is true)
  104734. */
  104735. opacityTexture: Nullable<BaseTexture>;
  104736. private _reflectionTexture;
  104737. /**
  104738. * Define the texture used to display the reflection.
  104739. * @see https://doc.babylonjs.com/how_to/reflect#how-to-obtain-reflections-and-refractions
  104740. */
  104741. reflectionTexture: Nullable<BaseTexture>;
  104742. private _emissiveTexture;
  104743. /**
  104744. * Define texture of the material as if self lit.
  104745. * This will be mixed in the final result even in the absence of light.
  104746. */
  104747. emissiveTexture: Nullable<BaseTexture>;
  104748. private _specularTexture;
  104749. /**
  104750. * Define how the color and intensity of the highlight given by the light in the material.
  104751. */
  104752. specularTexture: Nullable<BaseTexture>;
  104753. private _bumpTexture;
  104754. /**
  104755. * Bump mapping is a technique to simulate bump and dents on a rendered surface.
  104756. * 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.
  104757. * @see https://doc.babylonjs.com/how_to/more_materials#bump-map
  104758. */
  104759. bumpTexture: Nullable<BaseTexture>;
  104760. private _lightmapTexture;
  104761. /**
  104762. * Complex lighting can be computationally expensive to compute at runtime.
  104763. * To save on computation, lightmaps may be used to store calculated lighting in a texture which will be applied to a given mesh.
  104764. * @see https://doc.babylonjs.com/babylon101/lights#lightmaps
  104765. */
  104766. lightmapTexture: Nullable<BaseTexture>;
  104767. private _refractionTexture;
  104768. /**
  104769. * Define the texture used to display the refraction.
  104770. * @see https://doc.babylonjs.com/how_to/reflect#how-to-obtain-reflections-and-refractions
  104771. */
  104772. refractionTexture: Nullable<BaseTexture>;
  104773. /**
  104774. * The color of the material lit by the environmental background lighting.
  104775. * @see https://doc.babylonjs.com/babylon101/materials#ambient-color-example
  104776. */
  104777. ambientColor: Color3;
  104778. /**
  104779. * The basic color of the material as viewed under a light.
  104780. */
  104781. diffuseColor: Color3;
  104782. /**
  104783. * Define how the color and intensity of the highlight given by the light in the material.
  104784. */
  104785. specularColor: Color3;
  104786. /**
  104787. * Define the color of the material as if self lit.
  104788. * This will be mixed in the final result even in the absence of light.
  104789. */
  104790. emissiveColor: Color3;
  104791. /**
  104792. * Defines how sharp are the highlights in the material.
  104793. * The bigger the value the sharper giving a more glossy feeling to the result.
  104794. * Reversely, the smaller the value the blurrier giving a more rough feeling to the result.
  104795. */
  104796. specularPower: number;
  104797. private _useAlphaFromDiffuseTexture;
  104798. /**
  104799. * Does the transparency come from the diffuse texture alpha channel.
  104800. */
  104801. useAlphaFromDiffuseTexture: boolean;
  104802. private _useEmissiveAsIllumination;
  104803. /**
  104804. * If true, the emissive value is added into the end result, otherwise it is multiplied in.
  104805. */
  104806. useEmissiveAsIllumination: boolean;
  104807. private _linkEmissiveWithDiffuse;
  104808. /**
  104809. * If true, some kind of energy conservation will prevent the end result to be more than 1 by reducing
  104810. * the emissive level when the final color is close to one.
  104811. */
  104812. linkEmissiveWithDiffuse: boolean;
  104813. private _useSpecularOverAlpha;
  104814. /**
  104815. * Specifies that the material will keep the specular highlights over a transparent surface (only the most limunous ones).
  104816. * A car glass is a good exemple of that. When sun reflects on it you can not see what is behind.
  104817. */
  104818. useSpecularOverAlpha: boolean;
  104819. private _useReflectionOverAlpha;
  104820. /**
  104821. * Specifies that the material will keeps the reflection highlights over a transparent surface (only the most limunous ones).
  104822. * A car glass is a good exemple of that. When the street lights reflects on it you can not see what is behind.
  104823. */
  104824. useReflectionOverAlpha: boolean;
  104825. private _disableLighting;
  104826. /**
  104827. * Does lights from the scene impacts this material.
  104828. * It can be a nice trick for performance to disable lighting on a fully emissive material.
  104829. */
  104830. disableLighting: boolean;
  104831. private _useObjectSpaceNormalMap;
  104832. /**
  104833. * Allows using an object space normal map (instead of tangent space).
  104834. */
  104835. useObjectSpaceNormalMap: boolean;
  104836. private _useParallax;
  104837. /**
  104838. * Is parallax enabled or not.
  104839. * @see https://doc.babylonjs.com/how_to/using_parallax_mapping
  104840. */
  104841. useParallax: boolean;
  104842. private _useParallaxOcclusion;
  104843. /**
  104844. * Is parallax occlusion enabled or not.
  104845. * If true, the outcome is way more realistic than traditional Parallax but you can expect a performance hit that worthes consideration.
  104846. * @see https://doc.babylonjs.com/how_to/using_parallax_mapping
  104847. */
  104848. useParallaxOcclusion: boolean;
  104849. /**
  104850. * 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.
  104851. */
  104852. parallaxScaleBias: number;
  104853. private _roughness;
  104854. /**
  104855. * Helps to define how blurry the reflections should appears in the material.
  104856. */
  104857. roughness: number;
  104858. /**
  104859. * In case of refraction, define the value of the index of refraction.
  104860. * @see https://doc.babylonjs.com/how_to/reflect#how-to-obtain-reflections-and-refractions
  104861. */
  104862. indexOfRefraction: number;
  104863. /**
  104864. * Invert the refraction texture alongside the y axis.
  104865. * It can be useful with procedural textures or probe for instance.
  104866. * @see https://doc.babylonjs.com/how_to/reflect#how-to-obtain-reflections-and-refractions
  104867. */
  104868. invertRefractionY: boolean;
  104869. /**
  104870. * Defines the alpha limits in alpha test mode.
  104871. */
  104872. alphaCutOff: number;
  104873. private _useLightmapAsShadowmap;
  104874. /**
  104875. * In case of light mapping, define whether the map contains light or shadow informations.
  104876. */
  104877. useLightmapAsShadowmap: boolean;
  104878. private _diffuseFresnelParameters;
  104879. /**
  104880. * Define the diffuse fresnel parameters of the material.
  104881. * @see https://doc.babylonjs.com/how_to/how_to_use_fresnelparameters
  104882. */
  104883. diffuseFresnelParameters: FresnelParameters;
  104884. private _opacityFresnelParameters;
  104885. /**
  104886. * Define the opacity fresnel parameters of the material.
  104887. * @see https://doc.babylonjs.com/how_to/how_to_use_fresnelparameters
  104888. */
  104889. opacityFresnelParameters: FresnelParameters;
  104890. private _reflectionFresnelParameters;
  104891. /**
  104892. * Define the reflection fresnel parameters of the material.
  104893. * @see https://doc.babylonjs.com/how_to/how_to_use_fresnelparameters
  104894. */
  104895. reflectionFresnelParameters: FresnelParameters;
  104896. private _refractionFresnelParameters;
  104897. /**
  104898. * Define the refraction fresnel parameters of the material.
  104899. * @see https://doc.babylonjs.com/how_to/how_to_use_fresnelparameters
  104900. */
  104901. refractionFresnelParameters: FresnelParameters;
  104902. private _emissiveFresnelParameters;
  104903. /**
  104904. * Define the emissive fresnel parameters of the material.
  104905. * @see https://doc.babylonjs.com/how_to/how_to_use_fresnelparameters
  104906. */
  104907. emissiveFresnelParameters: FresnelParameters;
  104908. private _useReflectionFresnelFromSpecular;
  104909. /**
  104910. * If true automatically deducts the fresnels values from the material specularity.
  104911. * @see https://doc.babylonjs.com/how_to/how_to_use_fresnelparameters
  104912. */
  104913. useReflectionFresnelFromSpecular: boolean;
  104914. private _useGlossinessFromSpecularMapAlpha;
  104915. /**
  104916. * Defines if the glossiness/roughness of the material should be read from the specular map alpha channel
  104917. */
  104918. useGlossinessFromSpecularMapAlpha: boolean;
  104919. private _maxSimultaneousLights;
  104920. /**
  104921. * Defines the maximum number of lights that can be used in the material
  104922. */
  104923. maxSimultaneousLights: number;
  104924. private _invertNormalMapX;
  104925. /**
  104926. * If sets to true, x component of normal map value will invert (x = 1.0 - x).
  104927. */
  104928. invertNormalMapX: boolean;
  104929. private _invertNormalMapY;
  104930. /**
  104931. * If sets to true, y component of normal map value will invert (y = 1.0 - y).
  104932. */
  104933. invertNormalMapY: boolean;
  104934. private _twoSidedLighting;
  104935. /**
  104936. * If sets to true and backfaceCulling is false, normals will be flipped on the backside.
  104937. */
  104938. twoSidedLighting: boolean;
  104939. /**
  104940. * Default configuration related to image processing available in the standard Material.
  104941. */
  104942. protected _imageProcessingConfiguration: ImageProcessingConfiguration;
  104943. /**
  104944. * Gets the image processing configuration used either in this material.
  104945. */
  104946. get imageProcessingConfiguration(): ImageProcessingConfiguration;
  104947. /**
  104948. * Sets the Default image processing configuration used either in the this material.
  104949. *
  104950. * If sets to null, the scene one is in use.
  104951. */
  104952. set imageProcessingConfiguration(value: ImageProcessingConfiguration);
  104953. /**
  104954. * Keep track of the image processing observer to allow dispose and replace.
  104955. */
  104956. private _imageProcessingObserver;
  104957. /**
  104958. * Attaches a new image processing configuration to the Standard Material.
  104959. * @param configuration
  104960. */
  104961. protected _attachImageProcessingConfiguration(configuration: Nullable<ImageProcessingConfiguration>): void;
  104962. /**
  104963. * Defines additionnal PrePass parameters for the material.
  104964. */
  104965. readonly prePassConfiguration: PrePassConfiguration;
  104966. /**
  104967. * Gets wether the color curves effect is enabled.
  104968. */
  104969. get cameraColorCurvesEnabled(): boolean;
  104970. /**
  104971. * Sets wether the color curves effect is enabled.
  104972. */
  104973. set cameraColorCurvesEnabled(value: boolean);
  104974. /**
  104975. * Gets wether the color grading effect is enabled.
  104976. */
  104977. get cameraColorGradingEnabled(): boolean;
  104978. /**
  104979. * Gets wether the color grading effect is enabled.
  104980. */
  104981. set cameraColorGradingEnabled(value: boolean);
  104982. /**
  104983. * Gets wether tonemapping is enabled or not.
  104984. */
  104985. get cameraToneMappingEnabled(): boolean;
  104986. /**
  104987. * Sets wether tonemapping is enabled or not
  104988. */
  104989. set cameraToneMappingEnabled(value: boolean);
  104990. /**
  104991. * The camera exposure used on this material.
  104992. * This property is here and not in the camera to allow controlling exposure without full screen post process.
  104993. * This corresponds to a photographic exposure.
  104994. */
  104995. get cameraExposure(): number;
  104996. /**
  104997. * The camera exposure used on this material.
  104998. * This property is here and not in the camera to allow controlling exposure without full screen post process.
  104999. * This corresponds to a photographic exposure.
  105000. */
  105001. set cameraExposure(value: number);
  105002. /**
  105003. * Gets The camera contrast used on this material.
  105004. */
  105005. get cameraContrast(): number;
  105006. /**
  105007. * Sets The camera contrast used on this material.
  105008. */
  105009. set cameraContrast(value: number);
  105010. /**
  105011. * Gets the Color Grading 2D Lookup Texture.
  105012. */
  105013. get cameraColorGradingTexture(): Nullable<BaseTexture>;
  105014. /**
  105015. * Sets the Color Grading 2D Lookup Texture.
  105016. */
  105017. set cameraColorGradingTexture(value: Nullable<BaseTexture>);
  105018. /**
  105019. * The color grading curves provide additional color adjustmnent that is applied after any color grading transform (3D LUT).
  105020. * They allow basic adjustment of saturation and small exposure adjustments, along with color filter tinting to provide white balance adjustment or more stylistic effects.
  105021. * 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;
  105022. * corresponding to low luminance, medium luminance, and high luminance areas respectively.
  105023. */
  105024. get cameraColorCurves(): Nullable<ColorCurves>;
  105025. /**
  105026. * The color grading curves provide additional color adjustmnent that is applied after any color grading transform (3D LUT).
  105027. * They allow basic adjustment of saturation and small exposure adjustments, along with color filter tinting to provide white balance adjustment or more stylistic effects.
  105028. * 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;
  105029. * corresponding to low luminance, medium luminance, and high luminance areas respectively.
  105030. */
  105031. set cameraColorCurves(value: Nullable<ColorCurves>);
  105032. /**
  105033. * Can this material render to several textures at once
  105034. */
  105035. get canRenderToMRT(): boolean;
  105036. /**
  105037. * Defines the detail map parameters for the material.
  105038. */
  105039. readonly detailMap: DetailMapConfiguration;
  105040. protected _renderTargets: SmartArray<RenderTargetTexture>;
  105041. protected _worldViewProjectionMatrix: Matrix;
  105042. protected _globalAmbientColor: Color3;
  105043. protected _useLogarithmicDepth: boolean;
  105044. protected _rebuildInParallel: boolean;
  105045. /**
  105046. * Instantiates a new standard material.
  105047. * This is the default material used in Babylon. It is the best trade off between quality
  105048. * and performances.
  105049. * @see https://doc.babylonjs.com/babylon101/materials
  105050. * @param name Define the name of the material in the scene
  105051. * @param scene Define the scene the material belong to
  105052. */
  105053. constructor(name: string, scene: Scene);
  105054. /**
  105055. * Gets a boolean indicating that current material needs to register RTT
  105056. */
  105057. get hasRenderTargetTextures(): boolean;
  105058. /**
  105059. * Gets the current class name of the material e.g. "StandardMaterial"
  105060. * Mainly use in serialization.
  105061. * @returns the class name
  105062. */
  105063. getClassName(): string;
  105064. /**
  105065. * In case the depth buffer does not allow enough depth precision for your scene (might be the case in large scenes)
  105066. * You can try switching to logarithmic depth.
  105067. * @see https://doc.babylonjs.com/how_to/using_logarithmic_depth_buffer
  105068. */
  105069. get useLogarithmicDepth(): boolean;
  105070. set useLogarithmicDepth(value: boolean);
  105071. /**
  105072. * Specifies if the material will require alpha blending
  105073. * @returns a boolean specifying if alpha blending is needed
  105074. */
  105075. needAlphaBlending(): boolean;
  105076. /**
  105077. * Specifies if this material should be rendered in alpha test mode
  105078. * @returns a boolean specifying if an alpha test is needed.
  105079. */
  105080. needAlphaTesting(): boolean;
  105081. /**
  105082. * Specifies whether or not the alpha value of the diffuse texture should be used for alpha blending.
  105083. */
  105084. protected _shouldUseAlphaFromDiffuseTexture(): boolean;
  105085. /**
  105086. * Specifies whether or not there is a usable alpha channel for transparency.
  105087. */
  105088. protected _hasAlphaChannel(): boolean;
  105089. /**
  105090. * Get the texture used for alpha test purpose.
  105091. * @returns the diffuse texture in case of the standard material.
  105092. */
  105093. getAlphaTestTexture(): Nullable<BaseTexture>;
  105094. /**
  105095. * Get if the submesh is ready to be used and all its information available.
  105096. * Child classes can use it to update shaders
  105097. * @param mesh defines the mesh to check
  105098. * @param subMesh defines which submesh to check
  105099. * @param useInstances specifies that instances should be used
  105100. * @returns a boolean indicating that the submesh is ready or not
  105101. */
  105102. isReadyForSubMesh(mesh: AbstractMesh, subMesh: SubMesh, useInstances?: boolean): boolean;
  105103. /**
  105104. * Builds the material UBO layouts.
  105105. * Used internally during the effect preparation.
  105106. */
  105107. buildUniformLayout(): void;
  105108. /**
  105109. * Unbinds the material from the mesh
  105110. */
  105111. unbind(): void;
  105112. /**
  105113. * Binds the submesh to this material by preparing the effect and shader to draw
  105114. * @param world defines the world transformation matrix
  105115. * @param mesh defines the mesh containing the submesh
  105116. * @param subMesh defines the submesh to bind the material to
  105117. */
  105118. bindForSubMesh(world: Matrix, mesh: Mesh, subMesh: SubMesh): void;
  105119. /**
  105120. * Get the list of animatables in the material.
  105121. * @returns the list of animatables object used in the material
  105122. */
  105123. getAnimatables(): IAnimatable[];
  105124. /**
  105125. * Gets the active textures from the material
  105126. * @returns an array of textures
  105127. */
  105128. getActiveTextures(): BaseTexture[];
  105129. /**
  105130. * Specifies if the material uses a texture
  105131. * @param texture defines the texture to check against the material
  105132. * @returns a boolean specifying if the material uses the texture
  105133. */
  105134. hasTexture(texture: BaseTexture): boolean;
  105135. /**
  105136. * Disposes the material
  105137. * @param forceDisposeEffect specifies if effects should be forcefully disposed
  105138. * @param forceDisposeTextures specifies if textures should be forcefully disposed
  105139. */
  105140. dispose(forceDisposeEffect?: boolean, forceDisposeTextures?: boolean): void;
  105141. /**
  105142. * Makes a duplicate of the material, and gives it a new name
  105143. * @param name defines the new name for the duplicated material
  105144. * @returns the cloned material
  105145. */
  105146. clone(name: string): StandardMaterial;
  105147. /**
  105148. * Serializes this material in a JSON representation
  105149. * @returns the serialized material object
  105150. */
  105151. serialize(): any;
  105152. /**
  105153. * Creates a standard material from parsed material data
  105154. * @param source defines the JSON representation of the material
  105155. * @param scene defines the hosting scene
  105156. * @param rootUrl defines the root URL to use to load textures and relative dependencies
  105157. * @returns a new standard material
  105158. */
  105159. static Parse(source: any, scene: Scene, rootUrl: string): StandardMaterial;
  105160. /**
  105161. * Are diffuse textures enabled in the application.
  105162. */
  105163. static get DiffuseTextureEnabled(): boolean;
  105164. static set DiffuseTextureEnabled(value: boolean);
  105165. /**
  105166. * Are detail textures enabled in the application.
  105167. */
  105168. static get DetailTextureEnabled(): boolean;
  105169. static set DetailTextureEnabled(value: boolean);
  105170. /**
  105171. * Are ambient textures enabled in the application.
  105172. */
  105173. static get AmbientTextureEnabled(): boolean;
  105174. static set AmbientTextureEnabled(value: boolean);
  105175. /**
  105176. * Are opacity textures enabled in the application.
  105177. */
  105178. static get OpacityTextureEnabled(): boolean;
  105179. static set OpacityTextureEnabled(value: boolean);
  105180. /**
  105181. * Are reflection textures enabled in the application.
  105182. */
  105183. static get ReflectionTextureEnabled(): boolean;
  105184. static set ReflectionTextureEnabled(value: boolean);
  105185. /**
  105186. * Are emissive textures enabled in the application.
  105187. */
  105188. static get EmissiveTextureEnabled(): boolean;
  105189. static set EmissiveTextureEnabled(value: boolean);
  105190. /**
  105191. * Are specular textures enabled in the application.
  105192. */
  105193. static get SpecularTextureEnabled(): boolean;
  105194. static set SpecularTextureEnabled(value: boolean);
  105195. /**
  105196. * Are bump textures enabled in the application.
  105197. */
  105198. static get BumpTextureEnabled(): boolean;
  105199. static set BumpTextureEnabled(value: boolean);
  105200. /**
  105201. * Are lightmap textures enabled in the application.
  105202. */
  105203. static get LightmapTextureEnabled(): boolean;
  105204. static set LightmapTextureEnabled(value: boolean);
  105205. /**
  105206. * Are refraction textures enabled in the application.
  105207. */
  105208. static get RefractionTextureEnabled(): boolean;
  105209. static set RefractionTextureEnabled(value: boolean);
  105210. /**
  105211. * Are color grading textures enabled in the application.
  105212. */
  105213. static get ColorGradingTextureEnabled(): boolean;
  105214. static set ColorGradingTextureEnabled(value: boolean);
  105215. /**
  105216. * Are fresnels enabled in the application.
  105217. */
  105218. static get FresnelEnabled(): boolean;
  105219. static set FresnelEnabled(value: boolean);
  105220. }
  105221. }
  105222. declare module BABYLON {
  105223. /** @hidden */
  105224. export var rgbdDecodePixelShader: {
  105225. name: string;
  105226. shader: string;
  105227. };
  105228. }
  105229. declare module BABYLON {
  105230. /**
  105231. * Class used to host RGBD texture specific utilities
  105232. */
  105233. export class RGBDTextureTools {
  105234. /**
  105235. * Expand the RGBD Texture from RGBD to Half Float if possible.
  105236. * @param texture the texture to expand.
  105237. */
  105238. static ExpandRGBDTexture(texture: Texture): void;
  105239. }
  105240. }
  105241. declare module BABYLON {
  105242. /**
  105243. * Class used to host texture specific utilities
  105244. */
  105245. export class BRDFTextureTools {
  105246. /**
  105247. * Prevents texture cache collision
  105248. */
  105249. private static _instanceNumber;
  105250. /**
  105251. * Gets a default environment BRDF for MS-BRDF Height Correlated BRDF
  105252. * @param scene defines the hosting scene
  105253. * @returns the environment BRDF texture
  105254. */
  105255. static GetEnvironmentBRDFTexture(scene: Scene): BaseTexture;
  105256. private static _environmentBRDFBase64Texture;
  105257. }
  105258. }
  105259. declare module BABYLON {
  105260. /**
  105261. * @hidden
  105262. */
  105263. export interface IMaterialClearCoatDefines {
  105264. CLEARCOAT: boolean;
  105265. CLEARCOAT_DEFAULTIOR: boolean;
  105266. CLEARCOAT_TEXTURE: boolean;
  105267. CLEARCOAT_TEXTURE_ROUGHNESS: boolean;
  105268. CLEARCOAT_TEXTUREDIRECTUV: number;
  105269. CLEARCOAT_TEXTURE_ROUGHNESSDIRECTUV: number;
  105270. CLEARCOAT_BUMP: boolean;
  105271. CLEARCOAT_BUMPDIRECTUV: number;
  105272. CLEARCOAT_USE_ROUGHNESS_FROM_MAINTEXTURE: boolean;
  105273. CLEARCOAT_TEXTURE_ROUGHNESS_IDENTICAL: boolean;
  105274. CLEARCOAT_REMAP_F0: boolean;
  105275. CLEARCOAT_TINT: boolean;
  105276. CLEARCOAT_TINT_TEXTURE: boolean;
  105277. CLEARCOAT_TINT_TEXTUREDIRECTUV: number;
  105278. /** @hidden */
  105279. _areTexturesDirty: boolean;
  105280. }
  105281. /**
  105282. * Define the code related to the clear coat parameters of the pbr material.
  105283. */
  105284. export class PBRClearCoatConfiguration {
  105285. /**
  105286. * This defaults to 1.5 corresponding to a 0.04 f0 or a 4% reflectance at normal incidence
  105287. * The default fits with a polyurethane material.
  105288. */
  105289. private static readonly _DefaultIndexOfRefraction;
  105290. private _isEnabled;
  105291. /**
  105292. * Defines if the clear coat is enabled in the material.
  105293. */
  105294. isEnabled: boolean;
  105295. /**
  105296. * Defines the clear coat layer strength (between 0 and 1) it defaults to 1.
  105297. */
  105298. intensity: number;
  105299. /**
  105300. * Defines the clear coat layer roughness.
  105301. */
  105302. roughness: number;
  105303. private _indexOfRefraction;
  105304. /**
  105305. * Defines the index of refraction of the clear coat.
  105306. * This defaults to 1.5 corresponding to a 0.04 f0 or a 4% reflectance at normal incidence
  105307. * The default fits with a polyurethane material.
  105308. * Changing the default value is more performance intensive.
  105309. */
  105310. indexOfRefraction: number;
  105311. private _texture;
  105312. /**
  105313. * Stores the clear coat values in a texture (red channel is intensity and green channel is roughness)
  105314. * If useRoughnessFromMainTexture is false, the green channel of texture is not used and the green channel of textureRoughness is used instead
  105315. * if textureRoughness is not empty, else no texture roughness is used
  105316. */
  105317. texture: Nullable<BaseTexture>;
  105318. private _useRoughnessFromMainTexture;
  105319. /**
  105320. * Indicates that the green channel of the texture property will be used for roughness (default: true)
  105321. * If false, the green channel from textureRoughness is used for roughness
  105322. */
  105323. useRoughnessFromMainTexture: boolean;
  105324. private _textureRoughness;
  105325. /**
  105326. * Stores the clear coat roughness in a texture (green channel)
  105327. * Not used if useRoughnessFromMainTexture is true
  105328. */
  105329. textureRoughness: Nullable<BaseTexture>;
  105330. private _remapF0OnInterfaceChange;
  105331. /**
  105332. * Defines if the F0 value should be remapped to account for the interface change in the material.
  105333. */
  105334. remapF0OnInterfaceChange: boolean;
  105335. private _bumpTexture;
  105336. /**
  105337. * Define the clear coat specific bump texture.
  105338. */
  105339. bumpTexture: Nullable<BaseTexture>;
  105340. private _isTintEnabled;
  105341. /**
  105342. * Defines if the clear coat tint is enabled in the material.
  105343. */
  105344. isTintEnabled: boolean;
  105345. /**
  105346. * Defines the clear coat tint of the material.
  105347. * This is only use if tint is enabled
  105348. */
  105349. tintColor: Color3;
  105350. /**
  105351. * Defines the distance at which the tint color should be found in the
  105352. * clear coat media.
  105353. * This is only use if tint is enabled
  105354. */
  105355. tintColorAtDistance: number;
  105356. /**
  105357. * Defines the clear coat layer thickness.
  105358. * This is only use if tint is enabled
  105359. */
  105360. tintThickness: number;
  105361. private _tintTexture;
  105362. /**
  105363. * Stores the clear tint values in a texture.
  105364. * rgb is tint
  105365. * a is a thickness factor
  105366. */
  105367. tintTexture: Nullable<BaseTexture>;
  105368. /** @hidden */
  105369. private _internalMarkAllSubMeshesAsTexturesDirty;
  105370. /** @hidden */
  105371. _markAllSubMeshesAsTexturesDirty(): void;
  105372. /**
  105373. * Instantiate a new istance of clear coat configuration.
  105374. * @param markAllSubMeshesAsTexturesDirty Callback to flag the material to dirty
  105375. */
  105376. constructor(markAllSubMeshesAsTexturesDirty: () => void);
  105377. /**
  105378. * Gets wehter the submesh is ready to be used or not.
  105379. * @param defines the list of "defines" to update.
  105380. * @param scene defines the scene the material belongs to.
  105381. * @param engine defines the engine the material belongs to.
  105382. * @param disableBumpMap defines wether the material disables bump or not.
  105383. * @returns - boolean indicating that the submesh is ready or not.
  105384. */
  105385. isReadyForSubMesh(defines: IMaterialClearCoatDefines, scene: Scene, engine: Engine, disableBumpMap: boolean): boolean;
  105386. /**
  105387. * Checks to see if a texture is used in the material.
  105388. * @param defines the list of "defines" to update.
  105389. * @param scene defines the scene to the material belongs to.
  105390. */
  105391. prepareDefines(defines: IMaterialClearCoatDefines, scene: Scene): void;
  105392. /**
  105393. * Binds the material data.
  105394. * @param uniformBuffer defines the Uniform buffer to fill in.
  105395. * @param scene defines the scene the material belongs to.
  105396. * @param engine defines the engine the material belongs to.
  105397. * @param disableBumpMap defines wether the material disables bump or not.
  105398. * @param isFrozen defines wether the material is frozen or not.
  105399. * @param invertNormalMapX If sets to true, x component of normal map value will be inverted (x = 1.0 - x).
  105400. * @param invertNormalMapY If sets to true, y component of normal map value will be inverted (y = 1.0 - y).
  105401. * @param subMesh the submesh to bind data for
  105402. */
  105403. bindForSubMesh(uniformBuffer: UniformBuffer, scene: Scene, engine: Engine, disableBumpMap: boolean, isFrozen: boolean, invertNormalMapX: boolean, invertNormalMapY: boolean, subMesh?: SubMesh): void;
  105404. /**
  105405. * Checks to see if a texture is used in the material.
  105406. * @param texture - Base texture to use.
  105407. * @returns - Boolean specifying if a texture is used in the material.
  105408. */
  105409. hasTexture(texture: BaseTexture): boolean;
  105410. /**
  105411. * Returns an array of the actively used textures.
  105412. * @param activeTextures Array of BaseTextures
  105413. */
  105414. getActiveTextures(activeTextures: BaseTexture[]): void;
  105415. /**
  105416. * Returns the animatable textures.
  105417. * @param animatables Array of animatable textures.
  105418. */
  105419. getAnimatables(animatables: IAnimatable[]): void;
  105420. /**
  105421. * Disposes the resources of the material.
  105422. * @param forceDisposeTextures - Forces the disposal of all textures.
  105423. */
  105424. dispose(forceDisposeTextures?: boolean): void;
  105425. /**
  105426. * Get the current class name of the texture useful for serialization or dynamic coding.
  105427. * @returns "PBRClearCoatConfiguration"
  105428. */
  105429. getClassName(): string;
  105430. /**
  105431. * Add fallbacks to the effect fallbacks list.
  105432. * @param defines defines the Base texture to use.
  105433. * @param fallbacks defines the current fallback list.
  105434. * @param currentRank defines the current fallback rank.
  105435. * @returns the new fallback rank.
  105436. */
  105437. static AddFallbacks(defines: IMaterialClearCoatDefines, fallbacks: EffectFallbacks, currentRank: number): number;
  105438. /**
  105439. * Add the required uniforms to the current list.
  105440. * @param uniforms defines the current uniform list.
  105441. */
  105442. static AddUniforms(uniforms: string[]): void;
  105443. /**
  105444. * Add the required samplers to the current list.
  105445. * @param samplers defines the current sampler list.
  105446. */
  105447. static AddSamplers(samplers: string[]): void;
  105448. /**
  105449. * Add the required uniforms to the current buffer.
  105450. * @param uniformBuffer defines the current uniform buffer.
  105451. */
  105452. static PrepareUniformBuffer(uniformBuffer: UniformBuffer): void;
  105453. /**
  105454. * Makes a duplicate of the current configuration into another one.
  105455. * @param clearCoatConfiguration define the config where to copy the info
  105456. */
  105457. copyTo(clearCoatConfiguration: PBRClearCoatConfiguration): void;
  105458. /**
  105459. * Serializes this clear coat configuration.
  105460. * @returns - An object with the serialized config.
  105461. */
  105462. serialize(): any;
  105463. /**
  105464. * Parses a anisotropy Configuration from a serialized object.
  105465. * @param source - Serialized object.
  105466. * @param scene Defines the scene we are parsing for
  105467. * @param rootUrl Defines the rootUrl to load from
  105468. */
  105469. parse(source: any, scene: Scene, rootUrl: string): void;
  105470. }
  105471. }
  105472. declare module BABYLON {
  105473. /**
  105474. * @hidden
  105475. */
  105476. export interface IMaterialAnisotropicDefines {
  105477. ANISOTROPIC: boolean;
  105478. ANISOTROPIC_TEXTURE: boolean;
  105479. ANISOTROPIC_TEXTUREDIRECTUV: number;
  105480. MAINUV1: boolean;
  105481. _areTexturesDirty: boolean;
  105482. _needUVs: boolean;
  105483. }
  105484. /**
  105485. * Define the code related to the anisotropic parameters of the pbr material.
  105486. */
  105487. export class PBRAnisotropicConfiguration {
  105488. private _isEnabled;
  105489. /**
  105490. * Defines if the anisotropy is enabled in the material.
  105491. */
  105492. isEnabled: boolean;
  105493. /**
  105494. * Defines the anisotropy strength (between 0 and 1) it defaults to 1.
  105495. */
  105496. intensity: number;
  105497. /**
  105498. * Defines if the effect is along the tangents, bitangents or in between.
  105499. * By default, the effect is "strectching" the highlights along the tangents.
  105500. */
  105501. direction: Vector2;
  105502. private _texture;
  105503. /**
  105504. * Stores the anisotropy values in a texture.
  105505. * rg is direction (like normal from -1 to 1)
  105506. * b is a intensity
  105507. */
  105508. texture: Nullable<BaseTexture>;
  105509. /** @hidden */
  105510. private _internalMarkAllSubMeshesAsTexturesDirty;
  105511. /** @hidden */
  105512. _markAllSubMeshesAsTexturesDirty(): void;
  105513. /**
  105514. * Instantiate a new istance of anisotropy configuration.
  105515. * @param markAllSubMeshesAsTexturesDirty Callback to flag the material to dirty
  105516. */
  105517. constructor(markAllSubMeshesAsTexturesDirty: () => void);
  105518. /**
  105519. * Specifies that the submesh is ready to be used.
  105520. * @param defines the list of "defines" to update.
  105521. * @param scene defines the scene the material belongs to.
  105522. * @returns - boolean indicating that the submesh is ready or not.
  105523. */
  105524. isReadyForSubMesh(defines: IMaterialAnisotropicDefines, scene: Scene): boolean;
  105525. /**
  105526. * Checks to see if a texture is used in the material.
  105527. * @param defines the list of "defines" to update.
  105528. * @param mesh the mesh we are preparing the defines for.
  105529. * @param scene defines the scene the material belongs to.
  105530. */
  105531. prepareDefines(defines: IMaterialAnisotropicDefines, mesh: AbstractMesh, scene: Scene): void;
  105532. /**
  105533. * Binds the material data.
  105534. * @param uniformBuffer defines the Uniform buffer to fill in.
  105535. * @param scene defines the scene the material belongs to.
  105536. * @param isFrozen defines wether the material is frozen or not.
  105537. */
  105538. bindForSubMesh(uniformBuffer: UniformBuffer, scene: Scene, isFrozen: boolean): void;
  105539. /**
  105540. * Checks to see if a texture is used in the material.
  105541. * @param texture - Base texture to use.
  105542. * @returns - Boolean specifying if a texture is used in the material.
  105543. */
  105544. hasTexture(texture: BaseTexture): boolean;
  105545. /**
  105546. * Returns an array of the actively used textures.
  105547. * @param activeTextures Array of BaseTextures
  105548. */
  105549. getActiveTextures(activeTextures: BaseTexture[]): void;
  105550. /**
  105551. * Returns the animatable textures.
  105552. * @param animatables Array of animatable textures.
  105553. */
  105554. getAnimatables(animatables: IAnimatable[]): void;
  105555. /**
  105556. * Disposes the resources of the material.
  105557. * @param forceDisposeTextures - Forces the disposal of all textures.
  105558. */
  105559. dispose(forceDisposeTextures?: boolean): void;
  105560. /**
  105561. * Get the current class name of the texture useful for serialization or dynamic coding.
  105562. * @returns "PBRAnisotropicConfiguration"
  105563. */
  105564. getClassName(): string;
  105565. /**
  105566. * Add fallbacks to the effect fallbacks list.
  105567. * @param defines defines the Base texture to use.
  105568. * @param fallbacks defines the current fallback list.
  105569. * @param currentRank defines the current fallback rank.
  105570. * @returns the new fallback rank.
  105571. */
  105572. static AddFallbacks(defines: IMaterialAnisotropicDefines, fallbacks: EffectFallbacks, currentRank: number): number;
  105573. /**
  105574. * Add the required uniforms to the current list.
  105575. * @param uniforms defines the current uniform list.
  105576. */
  105577. static AddUniforms(uniforms: string[]): void;
  105578. /**
  105579. * Add the required uniforms to the current buffer.
  105580. * @param uniformBuffer defines the current uniform buffer.
  105581. */
  105582. static PrepareUniformBuffer(uniformBuffer: UniformBuffer): void;
  105583. /**
  105584. * Add the required samplers to the current list.
  105585. * @param samplers defines the current sampler list.
  105586. */
  105587. static AddSamplers(samplers: string[]): void;
  105588. /**
  105589. * Makes a duplicate of the current configuration into another one.
  105590. * @param anisotropicConfiguration define the config where to copy the info
  105591. */
  105592. copyTo(anisotropicConfiguration: PBRAnisotropicConfiguration): void;
  105593. /**
  105594. * Serializes this anisotropy configuration.
  105595. * @returns - An object with the serialized config.
  105596. */
  105597. serialize(): any;
  105598. /**
  105599. * Parses a anisotropy Configuration from a serialized object.
  105600. * @param source - Serialized object.
  105601. * @param scene Defines the scene we are parsing for
  105602. * @param rootUrl Defines the rootUrl to load from
  105603. */
  105604. parse(source: any, scene: Scene, rootUrl: string): void;
  105605. }
  105606. }
  105607. declare module BABYLON {
  105608. /**
  105609. * @hidden
  105610. */
  105611. export interface IMaterialBRDFDefines {
  105612. BRDF_V_HEIGHT_CORRELATED: boolean;
  105613. MS_BRDF_ENERGY_CONSERVATION: boolean;
  105614. SPHERICAL_HARMONICS: boolean;
  105615. SPECULAR_GLOSSINESS_ENERGY_CONSERVATION: boolean;
  105616. /** @hidden */
  105617. _areMiscDirty: boolean;
  105618. }
  105619. /**
  105620. * Define the code related to the BRDF parameters of the pbr material.
  105621. */
  105622. export class PBRBRDFConfiguration {
  105623. /**
  105624. * Default value used for the energy conservation.
  105625. * This should only be changed to adapt to the type of texture in scene.environmentBRDFTexture.
  105626. */
  105627. static DEFAULT_USE_ENERGY_CONSERVATION: boolean;
  105628. /**
  105629. * Default value used for the Smith Visibility Height Correlated mode.
  105630. * This should only be changed to adapt to the type of texture in scene.environmentBRDFTexture.
  105631. */
  105632. static DEFAULT_USE_SMITH_VISIBILITY_HEIGHT_CORRELATED: boolean;
  105633. /**
  105634. * Default value used for the IBL diffuse part.
  105635. * This can help switching back to the polynomials mode globally which is a tiny bit
  105636. * less GPU intensive at the drawback of a lower quality.
  105637. */
  105638. static DEFAULT_USE_SPHERICAL_HARMONICS: boolean;
  105639. /**
  105640. * Default value used for activating energy conservation for the specular workflow.
  105641. * If activated, the albedo color is multiplied with (1. - maxChannel(specular color)).
  105642. * If deactivated, a material is only physically plausible, when (albedo color + specular color) < 1.
  105643. */
  105644. static DEFAULT_USE_SPECULAR_GLOSSINESS_INPUT_ENERGY_CONSERVATION: boolean;
  105645. private _useEnergyConservation;
  105646. /**
  105647. * Defines if the material uses energy conservation.
  105648. */
  105649. useEnergyConservation: boolean;
  105650. private _useSmithVisibilityHeightCorrelated;
  105651. /**
  105652. * LEGACY Mode set to false
  105653. * Defines if the material uses height smith correlated visibility term.
  105654. * If you intent to not use our default BRDF, you need to load a separate BRDF Texture for the PBR
  105655. * You can either load https://assets.babylonjs.com/environments/uncorrelatedBRDF.png
  105656. * or https://assets.babylonjs.com/environments/uncorrelatedBRDF.dds to have more precision
  105657. * Not relying on height correlated will also disable energy conservation.
  105658. */
  105659. useSmithVisibilityHeightCorrelated: boolean;
  105660. private _useSphericalHarmonics;
  105661. /**
  105662. * LEGACY Mode set to false
  105663. * Defines if the material uses spherical harmonics vs spherical polynomials for the
  105664. * diffuse part of the IBL.
  105665. * The harmonics despite a tiny bigger cost has been proven to provide closer results
  105666. * to the ground truth.
  105667. */
  105668. useSphericalHarmonics: boolean;
  105669. private _useSpecularGlossinessInputEnergyConservation;
  105670. /**
  105671. * Defines if the material uses energy conservation, when the specular workflow is active.
  105672. * If activated, the albedo color is multiplied with (1. - maxChannel(specular color)).
  105673. * If deactivated, a material is only physically plausible, when (albedo color + specular color) < 1.
  105674. * In the deactivated case, the material author has to ensure energy conservation, for a physically plausible rendering.
  105675. */
  105676. useSpecularGlossinessInputEnergyConservation: boolean;
  105677. /** @hidden */
  105678. private _internalMarkAllSubMeshesAsMiscDirty;
  105679. /** @hidden */
  105680. _markAllSubMeshesAsMiscDirty(): void;
  105681. /**
  105682. * Instantiate a new istance of clear coat configuration.
  105683. * @param markAllSubMeshesAsMiscDirty Callback to flag the material to dirty
  105684. */
  105685. constructor(markAllSubMeshesAsMiscDirty: () => void);
  105686. /**
  105687. * Checks to see if a texture is used in the material.
  105688. * @param defines the list of "defines" to update.
  105689. */
  105690. prepareDefines(defines: IMaterialBRDFDefines): void;
  105691. /**
  105692. * Get the current class name of the texture useful for serialization or dynamic coding.
  105693. * @returns "PBRClearCoatConfiguration"
  105694. */
  105695. getClassName(): string;
  105696. /**
  105697. * Makes a duplicate of the current configuration into another one.
  105698. * @param brdfConfiguration define the config where to copy the info
  105699. */
  105700. copyTo(brdfConfiguration: PBRBRDFConfiguration): void;
  105701. /**
  105702. * Serializes this BRDF configuration.
  105703. * @returns - An object with the serialized config.
  105704. */
  105705. serialize(): any;
  105706. /**
  105707. * Parses a anisotropy Configuration from a serialized object.
  105708. * @param source - Serialized object.
  105709. * @param scene Defines the scene we are parsing for
  105710. * @param rootUrl Defines the rootUrl to load from
  105711. */
  105712. parse(source: any, scene: Scene, rootUrl: string): void;
  105713. }
  105714. }
  105715. declare module BABYLON {
  105716. /**
  105717. * @hidden
  105718. */
  105719. export interface IMaterialSheenDefines {
  105720. SHEEN: boolean;
  105721. SHEEN_TEXTURE: boolean;
  105722. SHEEN_TEXTURE_ROUGHNESS: boolean;
  105723. SHEEN_TEXTUREDIRECTUV: number;
  105724. SHEEN_TEXTURE_ROUGHNESSDIRECTUV: number;
  105725. SHEEN_LINKWITHALBEDO: boolean;
  105726. SHEEN_ROUGHNESS: boolean;
  105727. SHEEN_ALBEDOSCALING: boolean;
  105728. SHEEN_USE_ROUGHNESS_FROM_MAINTEXTURE: boolean;
  105729. SHEEN_TEXTURE_ROUGHNESS_IDENTICAL: boolean;
  105730. /** @hidden */
  105731. _areTexturesDirty: boolean;
  105732. }
  105733. /**
  105734. * Define the code related to the Sheen parameters of the pbr material.
  105735. */
  105736. export class PBRSheenConfiguration {
  105737. private _isEnabled;
  105738. /**
  105739. * Defines if the material uses sheen.
  105740. */
  105741. isEnabled: boolean;
  105742. private _linkSheenWithAlbedo;
  105743. /**
  105744. * Defines if the sheen is linked to the sheen color.
  105745. */
  105746. linkSheenWithAlbedo: boolean;
  105747. /**
  105748. * Defines the sheen intensity.
  105749. */
  105750. intensity: number;
  105751. /**
  105752. * Defines the sheen color.
  105753. */
  105754. color: Color3;
  105755. private _texture;
  105756. /**
  105757. * Stores the sheen tint values in a texture.
  105758. * rgb is tint
  105759. * a is a intensity or roughness if the roughness property has been defined and useRoughnessFromTexture is true (in that case, textureRoughness won't be used)
  105760. * If the roughness property has been defined and useRoughnessFromTexture is false then the alpha channel is not used to modulate roughness
  105761. */
  105762. texture: Nullable<BaseTexture>;
  105763. private _useRoughnessFromMainTexture;
  105764. /**
  105765. * Indicates that the alpha channel of the texture property will be used for roughness.
  105766. * Has no effect if the roughness (and texture!) property is not defined
  105767. */
  105768. useRoughnessFromMainTexture: boolean;
  105769. private _roughness;
  105770. /**
  105771. * Defines the sheen roughness.
  105772. * It is not taken into account if linkSheenWithAlbedo is true.
  105773. * To stay backward compatible, material roughness is used instead if sheen roughness = null
  105774. */
  105775. roughness: Nullable<number>;
  105776. private _textureRoughness;
  105777. /**
  105778. * Stores the sheen roughness in a texture.
  105779. * alpha channel is the roughness. This texture won't be used if the texture property is not empty and useRoughnessFromTexture is true
  105780. */
  105781. textureRoughness: Nullable<BaseTexture>;
  105782. private _albedoScaling;
  105783. /**
  105784. * If true, the sheen effect is layered above the base BRDF with the albedo-scaling technique.
  105785. * It allows the strength of the sheen effect to not depend on the base color of the material,
  105786. * making it easier to setup and tweak the effect
  105787. */
  105788. albedoScaling: boolean;
  105789. /** @hidden */
  105790. private _internalMarkAllSubMeshesAsTexturesDirty;
  105791. /** @hidden */
  105792. _markAllSubMeshesAsTexturesDirty(): void;
  105793. /**
  105794. * Instantiate a new istance of clear coat configuration.
  105795. * @param markAllSubMeshesAsTexturesDirty Callback to flag the material to dirty
  105796. */
  105797. constructor(markAllSubMeshesAsTexturesDirty: () => void);
  105798. /**
  105799. * Specifies that the submesh is ready to be used.
  105800. * @param defines the list of "defines" to update.
  105801. * @param scene defines the scene the material belongs to.
  105802. * @returns - boolean indicating that the submesh is ready or not.
  105803. */
  105804. isReadyForSubMesh(defines: IMaterialSheenDefines, scene: Scene): boolean;
  105805. /**
  105806. * Checks to see if a texture is used in the material.
  105807. * @param defines the list of "defines" to update.
  105808. * @param scene defines the scene the material belongs to.
  105809. */
  105810. prepareDefines(defines: IMaterialSheenDefines, scene: Scene): void;
  105811. /**
  105812. * Binds the material data.
  105813. * @param uniformBuffer defines the Uniform buffer to fill in.
  105814. * @param scene defines the scene the material belongs to.
  105815. * @param isFrozen defines wether the material is frozen or not.
  105816. * @param subMesh the submesh to bind data for
  105817. */
  105818. bindForSubMesh(uniformBuffer: UniformBuffer, scene: Scene, isFrozen: boolean, subMesh?: SubMesh): void;
  105819. /**
  105820. * Checks to see if a texture is used in the material.
  105821. * @param texture - Base texture to use.
  105822. * @returns - Boolean specifying if a texture is used in the material.
  105823. */
  105824. hasTexture(texture: BaseTexture): boolean;
  105825. /**
  105826. * Returns an array of the actively used textures.
  105827. * @param activeTextures Array of BaseTextures
  105828. */
  105829. getActiveTextures(activeTextures: BaseTexture[]): void;
  105830. /**
  105831. * Returns the animatable textures.
  105832. * @param animatables Array of animatable textures.
  105833. */
  105834. getAnimatables(animatables: IAnimatable[]): void;
  105835. /**
  105836. * Disposes the resources of the material.
  105837. * @param forceDisposeTextures - Forces the disposal of all textures.
  105838. */
  105839. dispose(forceDisposeTextures?: boolean): void;
  105840. /**
  105841. * Get the current class name of the texture useful for serialization or dynamic coding.
  105842. * @returns "PBRSheenConfiguration"
  105843. */
  105844. getClassName(): string;
  105845. /**
  105846. * Add fallbacks to the effect fallbacks list.
  105847. * @param defines defines the Base texture to use.
  105848. * @param fallbacks defines the current fallback list.
  105849. * @param currentRank defines the current fallback rank.
  105850. * @returns the new fallback rank.
  105851. */
  105852. static AddFallbacks(defines: IMaterialSheenDefines, fallbacks: EffectFallbacks, currentRank: number): number;
  105853. /**
  105854. * Add the required uniforms to the current list.
  105855. * @param uniforms defines the current uniform list.
  105856. */
  105857. static AddUniforms(uniforms: string[]): void;
  105858. /**
  105859. * Add the required uniforms to the current buffer.
  105860. * @param uniformBuffer defines the current uniform buffer.
  105861. */
  105862. static PrepareUniformBuffer(uniformBuffer: UniformBuffer): void;
  105863. /**
  105864. * Add the required samplers to the current list.
  105865. * @param samplers defines the current sampler list.
  105866. */
  105867. static AddSamplers(samplers: string[]): void;
  105868. /**
  105869. * Makes a duplicate of the current configuration into another one.
  105870. * @param sheenConfiguration define the config where to copy the info
  105871. */
  105872. copyTo(sheenConfiguration: PBRSheenConfiguration): void;
  105873. /**
  105874. * Serializes this BRDF configuration.
  105875. * @returns - An object with the serialized config.
  105876. */
  105877. serialize(): any;
  105878. /**
  105879. * Parses a anisotropy Configuration from a serialized object.
  105880. * @param source - Serialized object.
  105881. * @param scene Defines the scene we are parsing for
  105882. * @param rootUrl Defines the rootUrl to load from
  105883. */
  105884. parse(source: any, scene: Scene, rootUrl: string): void;
  105885. }
  105886. }
  105887. declare module BABYLON {
  105888. /**
  105889. * @hidden
  105890. */
  105891. export interface IMaterialSubSurfaceDefines {
  105892. SUBSURFACE: boolean;
  105893. SS_REFRACTION: boolean;
  105894. SS_TRANSLUCENCY: boolean;
  105895. SS_SCATTERING: boolean;
  105896. SS_THICKNESSANDMASK_TEXTURE: boolean;
  105897. SS_THICKNESSANDMASK_TEXTUREDIRECTUV: number;
  105898. SS_REFRACTIONMAP_3D: boolean;
  105899. SS_REFRACTIONMAP_OPPOSITEZ: boolean;
  105900. SS_LODINREFRACTIONALPHA: boolean;
  105901. SS_GAMMAREFRACTION: boolean;
  105902. SS_RGBDREFRACTION: boolean;
  105903. SS_LINEARSPECULARREFRACTION: boolean;
  105904. SS_LINKREFRACTIONTOTRANSPARENCY: boolean;
  105905. SS_ALBEDOFORREFRACTIONTINT: boolean;
  105906. SS_MASK_FROM_THICKNESS_TEXTURE: boolean;
  105907. /** @hidden */
  105908. _areTexturesDirty: boolean;
  105909. }
  105910. /**
  105911. * Define the code related to the sub surface parameters of the pbr material.
  105912. */
  105913. export class PBRSubSurfaceConfiguration {
  105914. private _isRefractionEnabled;
  105915. /**
  105916. * Defines if the refraction is enabled in the material.
  105917. */
  105918. isRefractionEnabled: boolean;
  105919. private _isTranslucencyEnabled;
  105920. /**
  105921. * Defines if the translucency is enabled in the material.
  105922. */
  105923. isTranslucencyEnabled: boolean;
  105924. private _isScatteringEnabled;
  105925. /**
  105926. * Defines if the sub surface scattering is enabled in the material.
  105927. */
  105928. isScatteringEnabled: boolean;
  105929. private _scatteringDiffusionProfileIndex;
  105930. /**
  105931. * Diffusion profile for subsurface scattering.
  105932. * Useful for better scattering in the skins or foliages.
  105933. */
  105934. get scatteringDiffusionProfile(): Nullable<Color3>;
  105935. set scatteringDiffusionProfile(c: Nullable<Color3>);
  105936. /**
  105937. * Defines the refraction intensity of the material.
  105938. * The refraction when enabled replaces the Diffuse part of the material.
  105939. * The intensity helps transitionning between diffuse and refraction.
  105940. */
  105941. refractionIntensity: number;
  105942. /**
  105943. * Defines the translucency intensity of the material.
  105944. * When translucency has been enabled, this defines how much of the "translucency"
  105945. * is addded to the diffuse part of the material.
  105946. */
  105947. translucencyIntensity: number;
  105948. /**
  105949. * When enabled, transparent surfaces will be tinted with the albedo colour (independent of thickness)
  105950. */
  105951. useAlbedoToTintRefraction: boolean;
  105952. private _thicknessTexture;
  105953. /**
  105954. * Stores the average thickness of a mesh in a texture (The texture is holding the values linearly).
  105955. * The red channel of the texture should contain the thickness remapped between 0 and 1.
  105956. * 0 would mean minimumThickness
  105957. * 1 would mean maximumThickness
  105958. * The other channels might be use as a mask to vary the different effects intensity.
  105959. */
  105960. thicknessTexture: Nullable<BaseTexture>;
  105961. private _refractionTexture;
  105962. /**
  105963. * Defines the texture to use for refraction.
  105964. */
  105965. refractionTexture: Nullable<BaseTexture>;
  105966. private _indexOfRefraction;
  105967. /**
  105968. * Index of refraction of the material base layer.
  105969. * https://en.wikipedia.org/wiki/List_of_refractive_indices
  105970. *
  105971. * This does not only impact refraction but also the Base F0 of Dielectric Materials.
  105972. *
  105973. * From dielectric fresnel rules: F0 = square((iorT - iorI) / (iorT + iorI))
  105974. */
  105975. indexOfRefraction: number;
  105976. private _volumeIndexOfRefraction;
  105977. /**
  105978. * Index of refraction of the material's volume.
  105979. * https://en.wikipedia.org/wiki/List_of_refractive_indices
  105980. *
  105981. * This ONLY impacts refraction. If not provided or given a non-valid value,
  105982. * the volume will use the same IOR as the surface.
  105983. */
  105984. get volumeIndexOfRefraction(): number;
  105985. set volumeIndexOfRefraction(value: number);
  105986. private _invertRefractionY;
  105987. /**
  105988. * Controls if refraction needs to be inverted on Y. This could be useful for procedural texture.
  105989. */
  105990. invertRefractionY: boolean;
  105991. private _linkRefractionWithTransparency;
  105992. /**
  105993. * This parameters will make the material used its opacity to control how much it is refracting aginst not.
  105994. * Materials half opaque for instance using refraction could benefit from this control.
  105995. */
  105996. linkRefractionWithTransparency: boolean;
  105997. /**
  105998. * Defines the minimum thickness stored in the thickness map.
  105999. * If no thickness map is defined, this value will be used to simulate thickness.
  106000. */
  106001. minimumThickness: number;
  106002. /**
  106003. * Defines the maximum thickness stored in the thickness map.
  106004. */
  106005. maximumThickness: number;
  106006. /**
  106007. * Defines the volume tint of the material.
  106008. * This is used for both translucency and scattering.
  106009. */
  106010. tintColor: Color3;
  106011. /**
  106012. * Defines the distance at which the tint color should be found in the media.
  106013. * This is used for refraction only.
  106014. */
  106015. tintColorAtDistance: number;
  106016. /**
  106017. * Defines how far each channel transmit through the media.
  106018. * It is defined as a color to simplify it selection.
  106019. */
  106020. diffusionDistance: Color3;
  106021. private _useMaskFromThicknessTexture;
  106022. /**
  106023. * Stores the intensity of the different subsurface effects in the thickness texture.
  106024. * * the green channel is the translucency intensity.
  106025. * * the blue channel is the scattering intensity.
  106026. * * the alpha channel is the refraction intensity.
  106027. */
  106028. useMaskFromThicknessTexture: boolean;
  106029. private _scene;
  106030. /** @hidden */
  106031. private _internalMarkAllSubMeshesAsTexturesDirty;
  106032. private _internalMarkScenePrePassDirty;
  106033. /** @hidden */
  106034. _markAllSubMeshesAsTexturesDirty(): void;
  106035. /** @hidden */
  106036. _markScenePrePassDirty(): void;
  106037. /**
  106038. * Instantiate a new istance of sub surface configuration.
  106039. * @param markAllSubMeshesAsTexturesDirty Callback to flag the material to dirty
  106040. * @param markScenePrePassDirty Callback to flag the scene as prepass dirty
  106041. * @param scene The scene
  106042. */
  106043. constructor(markAllSubMeshesAsTexturesDirty: () => void, markScenePrePassDirty: () => void, scene: Scene);
  106044. /**
  106045. * Gets wehter the submesh is ready to be used or not.
  106046. * @param defines the list of "defines" to update.
  106047. * @param scene defines the scene the material belongs to.
  106048. * @returns - boolean indicating that the submesh is ready or not.
  106049. */
  106050. isReadyForSubMesh(defines: IMaterialSubSurfaceDefines, scene: Scene): boolean;
  106051. /**
  106052. * Checks to see if a texture is used in the material.
  106053. * @param defines the list of "defines" to update.
  106054. * @param scene defines the scene to the material belongs to.
  106055. */
  106056. prepareDefines(defines: IMaterialSubSurfaceDefines, scene: Scene): void;
  106057. /**
  106058. * Binds the material data.
  106059. * @param uniformBuffer defines the Uniform buffer to fill in.
  106060. * @param scene defines the scene the material belongs to.
  106061. * @param engine defines the engine the material belongs to.
  106062. * @param isFrozen defines whether the material is frozen or not.
  106063. * @param lodBasedMicrosurface defines whether the material relies on lod based microsurface or not.
  106064. * @param realTimeFiltering defines whether the textures should be filtered on the fly.
  106065. */
  106066. bindForSubMesh(uniformBuffer: UniformBuffer, scene: Scene, engine: Engine, isFrozen: boolean, lodBasedMicrosurface: boolean, realTimeFiltering: boolean): void;
  106067. /**
  106068. * Unbinds the material from the mesh.
  106069. * @param activeEffect defines the effect that should be unbound from.
  106070. * @returns true if unbound, otherwise false
  106071. */
  106072. unbind(activeEffect: Effect): boolean;
  106073. /**
  106074. * Returns the texture used for refraction or null if none is used.
  106075. * @param scene defines the scene the material belongs to.
  106076. * @returns - Refraction texture if present. If no refraction texture and refraction
  106077. * is linked with transparency, returns environment texture. Otherwise, returns null.
  106078. */
  106079. private _getRefractionTexture;
  106080. /**
  106081. * Returns true if alpha blending should be disabled.
  106082. */
  106083. get disableAlphaBlending(): boolean;
  106084. /**
  106085. * Fills the list of render target textures.
  106086. * @param renderTargets the list of render targets to update
  106087. */
  106088. fillRenderTargetTextures(renderTargets: SmartArray<RenderTargetTexture>): void;
  106089. /**
  106090. * Checks to see if a texture is used in the material.
  106091. * @param texture - Base texture to use.
  106092. * @returns - Boolean specifying if a texture is used in the material.
  106093. */
  106094. hasTexture(texture: BaseTexture): boolean;
  106095. /**
  106096. * Gets a boolean indicating that current material needs to register RTT
  106097. * @returns true if this uses a render target otherwise false.
  106098. */
  106099. hasRenderTargetTextures(): boolean;
  106100. /**
  106101. * Returns an array of the actively used textures.
  106102. * @param activeTextures Array of BaseTextures
  106103. */
  106104. getActiveTextures(activeTextures: BaseTexture[]): void;
  106105. /**
  106106. * Returns the animatable textures.
  106107. * @param animatables Array of animatable textures.
  106108. */
  106109. getAnimatables(animatables: IAnimatable[]): void;
  106110. /**
  106111. * Disposes the resources of the material.
  106112. * @param forceDisposeTextures - Forces the disposal of all textures.
  106113. */
  106114. dispose(forceDisposeTextures?: boolean): void;
  106115. /**
  106116. * Get the current class name of the texture useful for serialization or dynamic coding.
  106117. * @returns "PBRSubSurfaceConfiguration"
  106118. */
  106119. getClassName(): string;
  106120. /**
  106121. * Add fallbacks to the effect fallbacks list.
  106122. * @param defines defines the Base texture to use.
  106123. * @param fallbacks defines the current fallback list.
  106124. * @param currentRank defines the current fallback rank.
  106125. * @returns the new fallback rank.
  106126. */
  106127. static AddFallbacks(defines: IMaterialSubSurfaceDefines, fallbacks: EffectFallbacks, currentRank: number): number;
  106128. /**
  106129. * Add the required uniforms to the current list.
  106130. * @param uniforms defines the current uniform list.
  106131. */
  106132. static AddUniforms(uniforms: string[]): void;
  106133. /**
  106134. * Add the required samplers to the current list.
  106135. * @param samplers defines the current sampler list.
  106136. */
  106137. static AddSamplers(samplers: string[]): void;
  106138. /**
  106139. * Add the required uniforms to the current buffer.
  106140. * @param uniformBuffer defines the current uniform buffer.
  106141. */
  106142. static PrepareUniformBuffer(uniformBuffer: UniformBuffer): void;
  106143. /**
  106144. * Makes a duplicate of the current configuration into another one.
  106145. * @param configuration define the config where to copy the info
  106146. */
  106147. copyTo(configuration: PBRSubSurfaceConfiguration): void;
  106148. /**
  106149. * Serializes this Sub Surface configuration.
  106150. * @returns - An object with the serialized config.
  106151. */
  106152. serialize(): any;
  106153. /**
  106154. * Parses a anisotropy Configuration from a serialized object.
  106155. * @param source - Serialized object.
  106156. * @param scene Defines the scene we are parsing for
  106157. * @param rootUrl Defines the rootUrl to load from
  106158. */
  106159. parse(source: any, scene: Scene, rootUrl: string): void;
  106160. }
  106161. }
  106162. declare module BABYLON {
  106163. /**
  106164. * Class representing spherical harmonics coefficients to the 3rd degree
  106165. */
  106166. export class SphericalHarmonics {
  106167. /**
  106168. * Defines whether or not the harmonics have been prescaled for rendering.
  106169. */
  106170. preScaled: boolean;
  106171. /**
  106172. * The l0,0 coefficients of the spherical harmonics
  106173. */
  106174. l00: Vector3;
  106175. /**
  106176. * The l1,-1 coefficients of the spherical harmonics
  106177. */
  106178. l1_1: Vector3;
  106179. /**
  106180. * The l1,0 coefficients of the spherical harmonics
  106181. */
  106182. l10: Vector3;
  106183. /**
  106184. * The l1,1 coefficients of the spherical harmonics
  106185. */
  106186. l11: Vector3;
  106187. /**
  106188. * The l2,-2 coefficients of the spherical harmonics
  106189. */
  106190. l2_2: Vector3;
  106191. /**
  106192. * The l2,-1 coefficients of the spherical harmonics
  106193. */
  106194. l2_1: Vector3;
  106195. /**
  106196. * The l2,0 coefficients of the spherical harmonics
  106197. */
  106198. l20: Vector3;
  106199. /**
  106200. * The l2,1 coefficients of the spherical harmonics
  106201. */
  106202. l21: Vector3;
  106203. /**
  106204. * The l2,2 coefficients of the spherical harmonics
  106205. */
  106206. l22: Vector3;
  106207. /**
  106208. * Adds a light to the spherical harmonics
  106209. * @param direction the direction of the light
  106210. * @param color the color of the light
  106211. * @param deltaSolidAngle the delta solid angle of the light
  106212. */
  106213. addLight(direction: Vector3, color: Color3, deltaSolidAngle: number): void;
  106214. /**
  106215. * Scales the spherical harmonics by the given amount
  106216. * @param scale the amount to scale
  106217. */
  106218. scaleInPlace(scale: number): void;
  106219. /**
  106220. * Convert from incident radiance (Li) to irradiance (E) by applying convolution with the cosine-weighted hemisphere.
  106221. *
  106222. * ```
  106223. * E_lm = A_l * L_lm
  106224. * ```
  106225. *
  106226. * In spherical harmonics this convolution amounts to scaling factors for each frequency band.
  106227. * This corresponds to equation 5 in "An Efficient Representation for Irradiance Environment Maps", where
  106228. * the scaling factors are given in equation 9.
  106229. */
  106230. convertIncidentRadianceToIrradiance(): void;
  106231. /**
  106232. * Convert from irradiance to outgoing radiance for Lambertian BDRF, suitable for efficient shader evaluation.
  106233. *
  106234. * ```
  106235. * L = (1/pi) * E * rho
  106236. * ```
  106237. *
  106238. * This is done by an additional scale by 1/pi, so is a fairly trivial operation but important conceptually.
  106239. */
  106240. convertIrradianceToLambertianRadiance(): void;
  106241. /**
  106242. * Integrates the reconstruction coefficients directly in to the SH preventing further
  106243. * required operations at run time.
  106244. *
  106245. * This is simply done by scaling back the SH with Ylm constants parameter.
  106246. * The trigonometric part being applied by the shader at run time.
  106247. */
  106248. preScaleForRendering(): void;
  106249. /**
  106250. * Constructs a spherical harmonics from an array.
  106251. * @param data defines the 9x3 coefficients (l00, l1-1, l10, l11, l2-2, l2-1, l20, l21, l22)
  106252. * @returns the spherical harmonics
  106253. */
  106254. static FromArray(data: ArrayLike<ArrayLike<number>>): SphericalHarmonics;
  106255. /**
  106256. * Gets the spherical harmonics from polynomial
  106257. * @param polynomial the spherical polynomial
  106258. * @returns the spherical harmonics
  106259. */
  106260. static FromPolynomial(polynomial: SphericalPolynomial): SphericalHarmonics;
  106261. }
  106262. /**
  106263. * Class representing spherical polynomial coefficients to the 3rd degree
  106264. */
  106265. export class SphericalPolynomial {
  106266. private _harmonics;
  106267. /**
  106268. * The spherical harmonics used to create the polynomials.
  106269. */
  106270. get preScaledHarmonics(): SphericalHarmonics;
  106271. /**
  106272. * The x coefficients of the spherical polynomial
  106273. */
  106274. x: Vector3;
  106275. /**
  106276. * The y coefficients of the spherical polynomial
  106277. */
  106278. y: Vector3;
  106279. /**
  106280. * The z coefficients of the spherical polynomial
  106281. */
  106282. z: Vector3;
  106283. /**
  106284. * The xx coefficients of the spherical polynomial
  106285. */
  106286. xx: Vector3;
  106287. /**
  106288. * The yy coefficients of the spherical polynomial
  106289. */
  106290. yy: Vector3;
  106291. /**
  106292. * The zz coefficients of the spherical polynomial
  106293. */
  106294. zz: Vector3;
  106295. /**
  106296. * The xy coefficients of the spherical polynomial
  106297. */
  106298. xy: Vector3;
  106299. /**
  106300. * The yz coefficients of the spherical polynomial
  106301. */
  106302. yz: Vector3;
  106303. /**
  106304. * The zx coefficients of the spherical polynomial
  106305. */
  106306. zx: Vector3;
  106307. /**
  106308. * Adds an ambient color to the spherical polynomial
  106309. * @param color the color to add
  106310. */
  106311. addAmbient(color: Color3): void;
  106312. /**
  106313. * Scales the spherical polynomial by the given amount
  106314. * @param scale the amount to scale
  106315. */
  106316. scaleInPlace(scale: number): void;
  106317. /**
  106318. * Gets the spherical polynomial from harmonics
  106319. * @param harmonics the spherical harmonics
  106320. * @returns the spherical polynomial
  106321. */
  106322. static FromHarmonics(harmonics: SphericalHarmonics): SphericalPolynomial;
  106323. /**
  106324. * Constructs a spherical polynomial from an array.
  106325. * @param data defines the 9x3 coefficients (x, y, z, xx, yy, zz, yz, zx, xy)
  106326. * @returns the spherical polynomial
  106327. */
  106328. static FromArray(data: ArrayLike<ArrayLike<number>>): SphericalPolynomial;
  106329. }
  106330. }
  106331. declare module BABYLON {
  106332. /**
  106333. * CubeMap information grouping all the data for each faces as well as the cubemap size.
  106334. */
  106335. export interface CubeMapInfo {
  106336. /**
  106337. * The pixel array for the front face.
  106338. * This is stored in format, left to right, up to down format.
  106339. */
  106340. front: Nullable<ArrayBufferView>;
  106341. /**
  106342. * The pixel array for the back face.
  106343. * This is stored in format, left to right, up to down format.
  106344. */
  106345. back: Nullable<ArrayBufferView>;
  106346. /**
  106347. * The pixel array for the left face.
  106348. * This is stored in format, left to right, up to down format.
  106349. */
  106350. left: Nullable<ArrayBufferView>;
  106351. /**
  106352. * The pixel array for the right face.
  106353. * This is stored in format, left to right, up to down format.
  106354. */
  106355. right: Nullable<ArrayBufferView>;
  106356. /**
  106357. * The pixel array for the up face.
  106358. * This is stored in format, left to right, up to down format.
  106359. */
  106360. up: Nullable<ArrayBufferView>;
  106361. /**
  106362. * The pixel array for the down face.
  106363. * This is stored in format, left to right, up to down format.
  106364. */
  106365. down: Nullable<ArrayBufferView>;
  106366. /**
  106367. * The size of the cubemap stored.
  106368. *
  106369. * Each faces will be size * size pixels.
  106370. */
  106371. size: number;
  106372. /**
  106373. * The format of the texture.
  106374. *
  106375. * RGBA, RGB.
  106376. */
  106377. format: number;
  106378. /**
  106379. * The type of the texture data.
  106380. *
  106381. * UNSIGNED_INT, FLOAT.
  106382. */
  106383. type: number;
  106384. /**
  106385. * Specifies whether the texture is in gamma space.
  106386. */
  106387. gammaSpace: boolean;
  106388. }
  106389. /**
  106390. * Helper class useful to convert panorama picture to their cubemap representation in 6 faces.
  106391. */
  106392. export class PanoramaToCubeMapTools {
  106393. private static FACE_LEFT;
  106394. private static FACE_RIGHT;
  106395. private static FACE_FRONT;
  106396. private static FACE_BACK;
  106397. private static FACE_DOWN;
  106398. private static FACE_UP;
  106399. /**
  106400. * Converts a panorma stored in RGB right to left up to down format into a cubemap (6 faces).
  106401. *
  106402. * @param float32Array The source data.
  106403. * @param inputWidth The width of the input panorama.
  106404. * @param inputHeight The height of the input panorama.
  106405. * @param size The willing size of the generated cubemap (each faces will be size * size pixels)
  106406. * @return The cubemap data
  106407. */
  106408. static ConvertPanoramaToCubemap(float32Array: Float32Array, inputWidth: number, inputHeight: number, size: number): CubeMapInfo;
  106409. private static CreateCubemapTexture;
  106410. private static CalcProjectionSpherical;
  106411. }
  106412. }
  106413. declare module BABYLON {
  106414. /**
  106415. * Helper class dealing with the extraction of spherical polynomial dataArray
  106416. * from a cube map.
  106417. */
  106418. export class CubeMapToSphericalPolynomialTools {
  106419. private static FileFaces;
  106420. /**
  106421. * Converts a texture to the according Spherical Polynomial data.
  106422. * This extracts the first 3 orders only as they are the only one used in the lighting.
  106423. *
  106424. * @param texture The texture to extract the information from.
  106425. * @return The Spherical Polynomial data.
  106426. */
  106427. static ConvertCubeMapTextureToSphericalPolynomial(texture: BaseTexture): Nullable<SphericalPolynomial>;
  106428. /**
  106429. * Converts a cubemap to the according Spherical Polynomial data.
  106430. * This extracts the first 3 orders only as they are the only one used in the lighting.
  106431. *
  106432. * @param cubeInfo The Cube map to extract the information from.
  106433. * @return The Spherical Polynomial data.
  106434. */
  106435. static ConvertCubeMapToSphericalPolynomial(cubeInfo: CubeMapInfo): SphericalPolynomial;
  106436. }
  106437. }
  106438. declare module BABYLON {
  106439. interface BaseTexture {
  106440. /**
  106441. * Get the polynomial representation of the texture data.
  106442. * This is mainly use as a fast way to recover IBL Diffuse irradiance data.
  106443. * @see https://learnopengl.com/PBR/IBL/Diffuse-irradiance
  106444. */
  106445. sphericalPolynomial: Nullable<SphericalPolynomial>;
  106446. }
  106447. }
  106448. declare module BABYLON {
  106449. /** @hidden */
  106450. export var pbrFragmentDeclaration: {
  106451. name: string;
  106452. shader: string;
  106453. };
  106454. }
  106455. declare module BABYLON {
  106456. /** @hidden */
  106457. export var pbrUboDeclaration: {
  106458. name: string;
  106459. shader: string;
  106460. };
  106461. }
  106462. declare module BABYLON {
  106463. /** @hidden */
  106464. export var pbrFragmentExtraDeclaration: {
  106465. name: string;
  106466. shader: string;
  106467. };
  106468. }
  106469. declare module BABYLON {
  106470. /** @hidden */
  106471. export var pbrFragmentSamplersDeclaration: {
  106472. name: string;
  106473. shader: string;
  106474. };
  106475. }
  106476. declare module BABYLON {
  106477. /** @hidden */
  106478. export var subSurfaceScatteringFunctions: {
  106479. name: string;
  106480. shader: string;
  106481. };
  106482. }
  106483. declare module BABYLON {
  106484. /** @hidden */
  106485. export var importanceSampling: {
  106486. name: string;
  106487. shader: string;
  106488. };
  106489. }
  106490. declare module BABYLON {
  106491. /** @hidden */
  106492. export var pbrHelperFunctions: {
  106493. name: string;
  106494. shader: string;
  106495. };
  106496. }
  106497. declare module BABYLON {
  106498. /** @hidden */
  106499. export var harmonicsFunctions: {
  106500. name: string;
  106501. shader: string;
  106502. };
  106503. }
  106504. declare module BABYLON {
  106505. /** @hidden */
  106506. export var pbrDirectLightingSetupFunctions: {
  106507. name: string;
  106508. shader: string;
  106509. };
  106510. }
  106511. declare module BABYLON {
  106512. /** @hidden */
  106513. export var pbrDirectLightingFalloffFunctions: {
  106514. name: string;
  106515. shader: string;
  106516. };
  106517. }
  106518. declare module BABYLON {
  106519. /** @hidden */
  106520. export var pbrBRDFFunctions: {
  106521. name: string;
  106522. shader: string;
  106523. };
  106524. }
  106525. declare module BABYLON {
  106526. /** @hidden */
  106527. export var hdrFilteringFunctions: {
  106528. name: string;
  106529. shader: string;
  106530. };
  106531. }
  106532. declare module BABYLON {
  106533. /** @hidden */
  106534. export var pbrDirectLightingFunctions: {
  106535. name: string;
  106536. shader: string;
  106537. };
  106538. }
  106539. declare module BABYLON {
  106540. /** @hidden */
  106541. export var pbrIBLFunctions: {
  106542. name: string;
  106543. shader: string;
  106544. };
  106545. }
  106546. declare module BABYLON {
  106547. /** @hidden */
  106548. export var pbrBlockAlbedoOpacity: {
  106549. name: string;
  106550. shader: string;
  106551. };
  106552. }
  106553. declare module BABYLON {
  106554. /** @hidden */
  106555. export var pbrBlockReflectivity: {
  106556. name: string;
  106557. shader: string;
  106558. };
  106559. }
  106560. declare module BABYLON {
  106561. /** @hidden */
  106562. export var pbrBlockAmbientOcclusion: {
  106563. name: string;
  106564. shader: string;
  106565. };
  106566. }
  106567. declare module BABYLON {
  106568. /** @hidden */
  106569. export var pbrBlockAlphaFresnel: {
  106570. name: string;
  106571. shader: string;
  106572. };
  106573. }
  106574. declare module BABYLON {
  106575. /** @hidden */
  106576. export var pbrBlockAnisotropic: {
  106577. name: string;
  106578. shader: string;
  106579. };
  106580. }
  106581. declare module BABYLON {
  106582. /** @hidden */
  106583. export var pbrBlockReflection: {
  106584. name: string;
  106585. shader: string;
  106586. };
  106587. }
  106588. declare module BABYLON {
  106589. /** @hidden */
  106590. export var pbrBlockSheen: {
  106591. name: string;
  106592. shader: string;
  106593. };
  106594. }
  106595. declare module BABYLON {
  106596. /** @hidden */
  106597. export var pbrBlockClearcoat: {
  106598. name: string;
  106599. shader: string;
  106600. };
  106601. }
  106602. declare module BABYLON {
  106603. /** @hidden */
  106604. export var pbrBlockSubSurface: {
  106605. name: string;
  106606. shader: string;
  106607. };
  106608. }
  106609. declare module BABYLON {
  106610. /** @hidden */
  106611. export var pbrBlockNormalGeometric: {
  106612. name: string;
  106613. shader: string;
  106614. };
  106615. }
  106616. declare module BABYLON {
  106617. /** @hidden */
  106618. export var pbrBlockNormalFinal: {
  106619. name: string;
  106620. shader: string;
  106621. };
  106622. }
  106623. declare module BABYLON {
  106624. /** @hidden */
  106625. export var pbrBlockLightmapInit: {
  106626. name: string;
  106627. shader: string;
  106628. };
  106629. }
  106630. declare module BABYLON {
  106631. /** @hidden */
  106632. export var pbrBlockGeometryInfo: {
  106633. name: string;
  106634. shader: string;
  106635. };
  106636. }
  106637. declare module BABYLON {
  106638. /** @hidden */
  106639. export var pbrBlockReflectance0: {
  106640. name: string;
  106641. shader: string;
  106642. };
  106643. }
  106644. declare module BABYLON {
  106645. /** @hidden */
  106646. export var pbrBlockReflectance: {
  106647. name: string;
  106648. shader: string;
  106649. };
  106650. }
  106651. declare module BABYLON {
  106652. /** @hidden */
  106653. export var pbrBlockDirectLighting: {
  106654. name: string;
  106655. shader: string;
  106656. };
  106657. }
  106658. declare module BABYLON {
  106659. /** @hidden */
  106660. export var pbrBlockFinalLitComponents: {
  106661. name: string;
  106662. shader: string;
  106663. };
  106664. }
  106665. declare module BABYLON {
  106666. /** @hidden */
  106667. export var pbrBlockFinalUnlitComponents: {
  106668. name: string;
  106669. shader: string;
  106670. };
  106671. }
  106672. declare module BABYLON {
  106673. /** @hidden */
  106674. export var pbrBlockFinalColorComposition: {
  106675. name: string;
  106676. shader: string;
  106677. };
  106678. }
  106679. declare module BABYLON {
  106680. /** @hidden */
  106681. export var pbrBlockImageProcessing: {
  106682. name: string;
  106683. shader: string;
  106684. };
  106685. }
  106686. declare module BABYLON {
  106687. /** @hidden */
  106688. export var pbrDebug: {
  106689. name: string;
  106690. shader: string;
  106691. };
  106692. }
  106693. declare module BABYLON {
  106694. /** @hidden */
  106695. export var pbrPixelShader: {
  106696. name: string;
  106697. shader: string;
  106698. };
  106699. }
  106700. declare module BABYLON {
  106701. /** @hidden */
  106702. export var pbrVertexDeclaration: {
  106703. name: string;
  106704. shader: string;
  106705. };
  106706. }
  106707. declare module BABYLON {
  106708. /** @hidden */
  106709. export var pbrVertexShader: {
  106710. name: string;
  106711. shader: string;
  106712. };
  106713. }
  106714. declare module BABYLON {
  106715. /**
  106716. * Manages the defines for the PBR Material.
  106717. * @hidden
  106718. */
  106719. export class PBRMaterialDefines extends MaterialDefines implements IImageProcessingConfigurationDefines, IMaterialClearCoatDefines, IMaterialAnisotropicDefines, IMaterialBRDFDefines, IMaterialSheenDefines, IMaterialSubSurfaceDefines, IMaterialDetailMapDefines {
  106720. PBR: boolean;
  106721. NUM_SAMPLES: string;
  106722. REALTIME_FILTERING: boolean;
  106723. MAINUV1: boolean;
  106724. MAINUV2: boolean;
  106725. UV1: boolean;
  106726. UV2: boolean;
  106727. ALBEDO: boolean;
  106728. GAMMAALBEDO: boolean;
  106729. ALBEDODIRECTUV: number;
  106730. VERTEXCOLOR: boolean;
  106731. DETAIL: boolean;
  106732. DETAILDIRECTUV: number;
  106733. DETAIL_NORMALBLENDMETHOD: number;
  106734. AMBIENT: boolean;
  106735. AMBIENTDIRECTUV: number;
  106736. AMBIENTINGRAYSCALE: boolean;
  106737. OPACITY: boolean;
  106738. VERTEXALPHA: boolean;
  106739. OPACITYDIRECTUV: number;
  106740. OPACITYRGB: boolean;
  106741. ALPHATEST: boolean;
  106742. DEPTHPREPASS: boolean;
  106743. ALPHABLEND: boolean;
  106744. ALPHAFROMALBEDO: boolean;
  106745. ALPHATESTVALUE: string;
  106746. SPECULAROVERALPHA: boolean;
  106747. RADIANCEOVERALPHA: boolean;
  106748. ALPHAFRESNEL: boolean;
  106749. LINEARALPHAFRESNEL: boolean;
  106750. PREMULTIPLYALPHA: boolean;
  106751. EMISSIVE: boolean;
  106752. EMISSIVEDIRECTUV: number;
  106753. REFLECTIVITY: boolean;
  106754. REFLECTIVITYDIRECTUV: number;
  106755. SPECULARTERM: boolean;
  106756. MICROSURFACEFROMREFLECTIVITYMAP: boolean;
  106757. MICROSURFACEAUTOMATIC: boolean;
  106758. LODBASEDMICROSFURACE: boolean;
  106759. MICROSURFACEMAP: boolean;
  106760. MICROSURFACEMAPDIRECTUV: number;
  106761. METALLICWORKFLOW: boolean;
  106762. ROUGHNESSSTOREINMETALMAPALPHA: boolean;
  106763. ROUGHNESSSTOREINMETALMAPGREEN: boolean;
  106764. METALLNESSSTOREINMETALMAPBLUE: boolean;
  106765. AOSTOREINMETALMAPRED: boolean;
  106766. METALLIC_REFLECTANCE: boolean;
  106767. METALLIC_REFLECTANCEDIRECTUV: number;
  106768. ENVIRONMENTBRDF: boolean;
  106769. ENVIRONMENTBRDF_RGBD: boolean;
  106770. NORMAL: boolean;
  106771. TANGENT: boolean;
  106772. BUMP: boolean;
  106773. BUMPDIRECTUV: number;
  106774. OBJECTSPACE_NORMALMAP: boolean;
  106775. PARALLAX: boolean;
  106776. PARALLAXOCCLUSION: boolean;
  106777. NORMALXYSCALE: boolean;
  106778. LIGHTMAP: boolean;
  106779. LIGHTMAPDIRECTUV: number;
  106780. USELIGHTMAPASSHADOWMAP: boolean;
  106781. GAMMALIGHTMAP: boolean;
  106782. RGBDLIGHTMAP: boolean;
  106783. REFLECTION: boolean;
  106784. REFLECTIONMAP_3D: boolean;
  106785. REFLECTIONMAP_SPHERICAL: boolean;
  106786. REFLECTIONMAP_PLANAR: boolean;
  106787. REFLECTIONMAP_CUBIC: boolean;
  106788. USE_LOCAL_REFLECTIONMAP_CUBIC: boolean;
  106789. REFLECTIONMAP_PROJECTION: boolean;
  106790. REFLECTIONMAP_SKYBOX: boolean;
  106791. REFLECTIONMAP_EXPLICIT: boolean;
  106792. REFLECTIONMAP_EQUIRECTANGULAR: boolean;
  106793. REFLECTIONMAP_EQUIRECTANGULAR_FIXED: boolean;
  106794. REFLECTIONMAP_MIRROREDEQUIRECTANGULAR_FIXED: boolean;
  106795. INVERTCUBICMAP: boolean;
  106796. USESPHERICALFROMREFLECTIONMAP: boolean;
  106797. USEIRRADIANCEMAP: boolean;
  106798. SPHERICAL_HARMONICS: boolean;
  106799. USESPHERICALINVERTEX: boolean;
  106800. REFLECTIONMAP_OPPOSITEZ: boolean;
  106801. LODINREFLECTIONALPHA: boolean;
  106802. GAMMAREFLECTION: boolean;
  106803. RGBDREFLECTION: boolean;
  106804. LINEARSPECULARREFLECTION: boolean;
  106805. RADIANCEOCCLUSION: boolean;
  106806. HORIZONOCCLUSION: boolean;
  106807. INSTANCES: boolean;
  106808. THIN_INSTANCES: boolean;
  106809. PREPASS: boolean;
  106810. PREPASS_IRRADIANCE: boolean;
  106811. PREPASS_IRRADIANCE_INDEX: number;
  106812. PREPASS_ALBEDO: boolean;
  106813. PREPASS_ALBEDO_INDEX: number;
  106814. PREPASS_DEPTHNORMAL: boolean;
  106815. PREPASS_DEPTHNORMAL_INDEX: number;
  106816. PREPASS_POSITION: boolean;
  106817. PREPASS_POSITION_INDEX: number;
  106818. PREPASS_VELOCITY: boolean;
  106819. PREPASS_VELOCITY_INDEX: number;
  106820. PREPASS_REFLECTIVITY: boolean;
  106821. PREPASS_REFLECTIVITY_INDEX: number;
  106822. SCENE_MRT_COUNT: number;
  106823. NUM_BONE_INFLUENCERS: number;
  106824. BonesPerMesh: number;
  106825. BONETEXTURE: boolean;
  106826. BONES_VELOCITY_ENABLED: boolean;
  106827. NONUNIFORMSCALING: boolean;
  106828. MORPHTARGETS: boolean;
  106829. MORPHTARGETS_NORMAL: boolean;
  106830. MORPHTARGETS_TANGENT: boolean;
  106831. MORPHTARGETS_UV: boolean;
  106832. NUM_MORPH_INFLUENCERS: number;
  106833. IMAGEPROCESSING: boolean;
  106834. VIGNETTE: boolean;
  106835. VIGNETTEBLENDMODEMULTIPLY: boolean;
  106836. VIGNETTEBLENDMODEOPAQUE: boolean;
  106837. TONEMAPPING: boolean;
  106838. TONEMAPPING_ACES: boolean;
  106839. CONTRAST: boolean;
  106840. COLORCURVES: boolean;
  106841. COLORGRADING: boolean;
  106842. COLORGRADING3D: boolean;
  106843. SAMPLER3DGREENDEPTH: boolean;
  106844. SAMPLER3DBGRMAP: boolean;
  106845. IMAGEPROCESSINGPOSTPROCESS: boolean;
  106846. EXPOSURE: boolean;
  106847. MULTIVIEW: boolean;
  106848. USEPHYSICALLIGHTFALLOFF: boolean;
  106849. USEGLTFLIGHTFALLOFF: boolean;
  106850. TWOSIDEDLIGHTING: boolean;
  106851. SHADOWFLOAT: boolean;
  106852. CLIPPLANE: boolean;
  106853. CLIPPLANE2: boolean;
  106854. CLIPPLANE3: boolean;
  106855. CLIPPLANE4: boolean;
  106856. CLIPPLANE5: boolean;
  106857. CLIPPLANE6: boolean;
  106858. POINTSIZE: boolean;
  106859. FOG: boolean;
  106860. LOGARITHMICDEPTH: boolean;
  106861. FORCENORMALFORWARD: boolean;
  106862. SPECULARAA: boolean;
  106863. CLEARCOAT: boolean;
  106864. CLEARCOAT_DEFAULTIOR: boolean;
  106865. CLEARCOAT_TEXTURE: boolean;
  106866. CLEARCOAT_TEXTURE_ROUGHNESS: boolean;
  106867. CLEARCOAT_TEXTUREDIRECTUV: number;
  106868. CLEARCOAT_TEXTURE_ROUGHNESSDIRECTUV: number;
  106869. CLEARCOAT_USE_ROUGHNESS_FROM_MAINTEXTURE: boolean;
  106870. CLEARCOAT_TEXTURE_ROUGHNESS_IDENTICAL: boolean;
  106871. CLEARCOAT_BUMP: boolean;
  106872. CLEARCOAT_BUMPDIRECTUV: number;
  106873. CLEARCOAT_REMAP_F0: boolean;
  106874. CLEARCOAT_TINT: boolean;
  106875. CLEARCOAT_TINT_TEXTURE: boolean;
  106876. CLEARCOAT_TINT_TEXTUREDIRECTUV: number;
  106877. ANISOTROPIC: boolean;
  106878. ANISOTROPIC_TEXTURE: boolean;
  106879. ANISOTROPIC_TEXTUREDIRECTUV: number;
  106880. BRDF_V_HEIGHT_CORRELATED: boolean;
  106881. MS_BRDF_ENERGY_CONSERVATION: boolean;
  106882. SPECULAR_GLOSSINESS_ENERGY_CONSERVATION: boolean;
  106883. SHEEN: boolean;
  106884. SHEEN_TEXTURE: boolean;
  106885. SHEEN_TEXTURE_ROUGHNESS: boolean;
  106886. SHEEN_TEXTUREDIRECTUV: number;
  106887. SHEEN_TEXTURE_ROUGHNESSDIRECTUV: number;
  106888. SHEEN_LINKWITHALBEDO: boolean;
  106889. SHEEN_ROUGHNESS: boolean;
  106890. SHEEN_ALBEDOSCALING: boolean;
  106891. SHEEN_USE_ROUGHNESS_FROM_MAINTEXTURE: boolean;
  106892. SHEEN_TEXTURE_ROUGHNESS_IDENTICAL: boolean;
  106893. SUBSURFACE: boolean;
  106894. SS_REFRACTION: boolean;
  106895. SS_TRANSLUCENCY: boolean;
  106896. SS_SCATTERING: boolean;
  106897. SS_THICKNESSANDMASK_TEXTURE: boolean;
  106898. SS_THICKNESSANDMASK_TEXTUREDIRECTUV: number;
  106899. SS_REFRACTIONMAP_3D: boolean;
  106900. SS_REFRACTIONMAP_OPPOSITEZ: boolean;
  106901. SS_LODINREFRACTIONALPHA: boolean;
  106902. SS_GAMMAREFRACTION: boolean;
  106903. SS_RGBDREFRACTION: boolean;
  106904. SS_LINEARSPECULARREFRACTION: boolean;
  106905. SS_LINKREFRACTIONTOTRANSPARENCY: boolean;
  106906. SS_ALBEDOFORREFRACTIONTINT: boolean;
  106907. SS_MASK_FROM_THICKNESS_TEXTURE: boolean;
  106908. UNLIT: boolean;
  106909. DEBUGMODE: number;
  106910. /**
  106911. * Initializes the PBR Material defines.
  106912. */
  106913. constructor();
  106914. /**
  106915. * Resets the PBR Material defines.
  106916. */
  106917. reset(): void;
  106918. }
  106919. /**
  106920. * The Physically based material base class of BJS.
  106921. *
  106922. * This offers the main features of a standard PBR material.
  106923. * For more information, please refer to the documentation :
  106924. * https://doc.babylonjs.com/how_to/physically_based_rendering
  106925. */
  106926. export abstract class PBRBaseMaterial extends PushMaterial {
  106927. /**
  106928. * PBRMaterialTransparencyMode: No transparency mode, Alpha channel is not use.
  106929. */
  106930. static readonly PBRMATERIAL_OPAQUE: number;
  106931. /**
  106932. * PBRMaterialTransparencyMode: Alpha Test mode, pixel are discarded below a certain threshold defined by the alpha cutoff value.
  106933. */
  106934. static readonly PBRMATERIAL_ALPHATEST: number;
  106935. /**
  106936. * PBRMaterialTransparencyMode: Pixels are blended (according to the alpha mode) with the already drawn pixels in the current frame buffer.
  106937. */
  106938. static readonly PBRMATERIAL_ALPHABLEND: number;
  106939. /**
  106940. * PBRMaterialTransparencyMode: Pixels are blended (according to the alpha mode) with the already drawn pixels in the current frame buffer.
  106941. * They are also discarded below the alpha cutoff threshold to improve performances.
  106942. */
  106943. static readonly PBRMATERIAL_ALPHATESTANDBLEND: number;
  106944. /**
  106945. * Defines the default value of how much AO map is occluding the analytical lights
  106946. * (point spot...).
  106947. */
  106948. static DEFAULT_AO_ON_ANALYTICAL_LIGHTS: number;
  106949. /**
  106950. * PBRMaterialLightFalloff Physical: light is falling off following the inverse squared distance law.
  106951. */
  106952. static readonly LIGHTFALLOFF_PHYSICAL: number;
  106953. /**
  106954. * PBRMaterialLightFalloff gltf: light is falling off as described in the gltf moving to PBR document
  106955. * to enhance interoperability with other engines.
  106956. */
  106957. static readonly LIGHTFALLOFF_GLTF: number;
  106958. /**
  106959. * PBRMaterialLightFalloff Standard: light is falling off like in the standard material
  106960. * to enhance interoperability with other materials.
  106961. */
  106962. static readonly LIGHTFALLOFF_STANDARD: number;
  106963. /**
  106964. * Intensity of the direct lights e.g. the four lights available in your scene.
  106965. * This impacts both the direct diffuse and specular highlights.
  106966. */
  106967. protected _directIntensity: number;
  106968. /**
  106969. * Intensity of the emissive part of the material.
  106970. * This helps controlling the emissive effect without modifying the emissive color.
  106971. */
  106972. protected _emissiveIntensity: number;
  106973. /**
  106974. * Intensity of the environment e.g. how much the environment will light the object
  106975. * either through harmonics for rough material or through the refelction for shiny ones.
  106976. */
  106977. protected _environmentIntensity: number;
  106978. /**
  106979. * This is a special control allowing the reduction of the specular highlights coming from the
  106980. * four lights of the scene. Those highlights may not be needed in full environment lighting.
  106981. */
  106982. protected _specularIntensity: number;
  106983. /**
  106984. * This stores the direct, emissive, environment, and specular light intensities into a Vector4.
  106985. */
  106986. private _lightingInfos;
  106987. /**
  106988. * Debug Control allowing disabling the bump map on this material.
  106989. */
  106990. protected _disableBumpMap: boolean;
  106991. /**
  106992. * AKA Diffuse Texture in standard nomenclature.
  106993. */
  106994. protected _albedoTexture: Nullable<BaseTexture>;
  106995. /**
  106996. * AKA Occlusion Texture in other nomenclature.
  106997. */
  106998. protected _ambientTexture: Nullable<BaseTexture>;
  106999. /**
  107000. * AKA Occlusion Texture Intensity in other nomenclature.
  107001. */
  107002. protected _ambientTextureStrength: number;
  107003. /**
  107004. * Defines how much the AO map is occluding the analytical lights (point spot...).
  107005. * 1 means it completely occludes it
  107006. * 0 mean it has no impact
  107007. */
  107008. protected _ambientTextureImpactOnAnalyticalLights: number;
  107009. /**
  107010. * Stores the alpha values in a texture.
  107011. */
  107012. protected _opacityTexture: Nullable<BaseTexture>;
  107013. /**
  107014. * Stores the reflection values in a texture.
  107015. */
  107016. protected _reflectionTexture: Nullable<BaseTexture>;
  107017. /**
  107018. * Stores the emissive values in a texture.
  107019. */
  107020. protected _emissiveTexture: Nullable<BaseTexture>;
  107021. /**
  107022. * AKA Specular texture in other nomenclature.
  107023. */
  107024. protected _reflectivityTexture: Nullable<BaseTexture>;
  107025. /**
  107026. * Used to switch from specular/glossiness to metallic/roughness workflow.
  107027. */
  107028. protected _metallicTexture: Nullable<BaseTexture>;
  107029. /**
  107030. * Specifies the metallic scalar of the metallic/roughness workflow.
  107031. * Can also be used to scale the metalness values of the metallic texture.
  107032. */
  107033. protected _metallic: Nullable<number>;
  107034. /**
  107035. * Specifies the roughness scalar of the metallic/roughness workflow.
  107036. * Can also be used to scale the roughness values of the metallic texture.
  107037. */
  107038. protected _roughness: Nullable<number>;
  107039. /**
  107040. * In metallic workflow, specifies an F0 factor to help configuring the material F0.
  107041. * By default the indexOfrefraction is used to compute F0;
  107042. *
  107043. * This is used as a factor against the default reflectance at normal incidence to tweak it.
  107044. *
  107045. * F0 = defaultF0 * metallicF0Factor * metallicReflectanceColor;
  107046. * F90 = metallicReflectanceColor;
  107047. */
  107048. protected _metallicF0Factor: number;
  107049. /**
  107050. * In metallic workflow, specifies an F90 color to help configuring the material F90.
  107051. * By default the F90 is always 1;
  107052. *
  107053. * Please note that this factor is also used as a factor against the default reflectance at normal incidence.
  107054. *
  107055. * F0 = defaultF0 * metallicF0Factor * metallicReflectanceColor
  107056. * F90 = metallicReflectanceColor;
  107057. */
  107058. protected _metallicReflectanceColor: Color3;
  107059. /**
  107060. * Defines to store metallicReflectanceColor in RGB and metallicF0Factor in A
  107061. * This is multiply against the scalar values defined in the material.
  107062. */
  107063. protected _metallicReflectanceTexture: Nullable<BaseTexture>;
  107064. /**
  107065. * Used to enable roughness/glossiness fetch from a separate channel depending on the current mode.
  107066. * Gray Scale represents roughness in metallic mode and glossiness in specular mode.
  107067. */
  107068. protected _microSurfaceTexture: Nullable<BaseTexture>;
  107069. /**
  107070. * Stores surface normal data used to displace a mesh in a texture.
  107071. */
  107072. protected _bumpTexture: Nullable<BaseTexture>;
  107073. /**
  107074. * Stores the pre-calculated light information of a mesh in a texture.
  107075. */
  107076. protected _lightmapTexture: Nullable<BaseTexture>;
  107077. /**
  107078. * The color of a material in ambient lighting.
  107079. */
  107080. protected _ambientColor: Color3;
  107081. /**
  107082. * AKA Diffuse Color in other nomenclature.
  107083. */
  107084. protected _albedoColor: Color3;
  107085. /**
  107086. * AKA Specular Color in other nomenclature.
  107087. */
  107088. protected _reflectivityColor: Color3;
  107089. /**
  107090. * The color applied when light is reflected from a material.
  107091. */
  107092. protected _reflectionColor: Color3;
  107093. /**
  107094. * The color applied when light is emitted from a material.
  107095. */
  107096. protected _emissiveColor: Color3;
  107097. /**
  107098. * AKA Glossiness in other nomenclature.
  107099. */
  107100. protected _microSurface: number;
  107101. /**
  107102. * Specifies that the material will use the light map as a show map.
  107103. */
  107104. protected _useLightmapAsShadowmap: boolean;
  107105. /**
  107106. * This parameters will enable/disable Horizon occlusion to prevent normal maps to look shiny when the normal
  107107. * makes the reflect vector face the model (under horizon).
  107108. */
  107109. protected _useHorizonOcclusion: boolean;
  107110. /**
  107111. * This parameters will enable/disable radiance occlusion by preventing the radiance to lit
  107112. * too much the area relying on ambient texture to define their ambient occlusion.
  107113. */
  107114. protected _useRadianceOcclusion: boolean;
  107115. /**
  107116. * Specifies that the alpha is coming form the albedo channel alpha channel for alpha blending.
  107117. */
  107118. protected _useAlphaFromAlbedoTexture: boolean;
  107119. /**
  107120. * Specifies that the material will keeps the specular highlights over a transparent surface (only the most limunous ones).
  107121. * A car glass is a good exemple of that. When sun reflects on it you can not see what is behind.
  107122. */
  107123. protected _useSpecularOverAlpha: boolean;
  107124. /**
  107125. * Specifies if the reflectivity texture contains the glossiness information in its alpha channel.
  107126. */
  107127. protected _useMicroSurfaceFromReflectivityMapAlpha: boolean;
  107128. /**
  107129. * Specifies if the metallic texture contains the roughness information in its alpha channel.
  107130. */
  107131. protected _useRoughnessFromMetallicTextureAlpha: boolean;
  107132. /**
  107133. * Specifies if the metallic texture contains the roughness information in its green channel.
  107134. */
  107135. protected _useRoughnessFromMetallicTextureGreen: boolean;
  107136. /**
  107137. * Specifies if the metallic texture contains the metallness information in its blue channel.
  107138. */
  107139. protected _useMetallnessFromMetallicTextureBlue: boolean;
  107140. /**
  107141. * Specifies if the metallic texture contains the ambient occlusion information in its red channel.
  107142. */
  107143. protected _useAmbientOcclusionFromMetallicTextureRed: boolean;
  107144. /**
  107145. * Specifies if the ambient texture contains the ambient occlusion information in its red channel only.
  107146. */
  107147. protected _useAmbientInGrayScale: boolean;
  107148. /**
  107149. * In case the reflectivity map does not contain the microsurface information in its alpha channel,
  107150. * The material will try to infer what glossiness each pixel should be.
  107151. */
  107152. protected _useAutoMicroSurfaceFromReflectivityMap: boolean;
  107153. /**
  107154. * Defines the falloff type used in this material.
  107155. * It by default is Physical.
  107156. */
  107157. protected _lightFalloff: number;
  107158. /**
  107159. * Specifies that the material will keeps the reflection highlights over a transparent surface (only the most limunous ones).
  107160. * A car glass is a good exemple of that. When the street lights reflects on it you can not see what is behind.
  107161. */
  107162. protected _useRadianceOverAlpha: boolean;
  107163. /**
  107164. * Allows using an object space normal map (instead of tangent space).
  107165. */
  107166. protected _useObjectSpaceNormalMap: boolean;
  107167. /**
  107168. * Allows using the bump map in parallax mode.
  107169. */
  107170. protected _useParallax: boolean;
  107171. /**
  107172. * Allows using the bump map in parallax occlusion mode.
  107173. */
  107174. protected _useParallaxOcclusion: boolean;
  107175. /**
  107176. * Controls the scale bias of the parallax mode.
  107177. */
  107178. protected _parallaxScaleBias: number;
  107179. /**
  107180. * If sets to true, disables all the lights affecting the material.
  107181. */
  107182. protected _disableLighting: boolean;
  107183. /**
  107184. * Number of Simultaneous lights allowed on the material.
  107185. */
  107186. protected _maxSimultaneousLights: number;
  107187. /**
  107188. * If sets to true, x component of normal map value will be inverted (x = 1.0 - x).
  107189. */
  107190. protected _invertNormalMapX: boolean;
  107191. /**
  107192. * If sets to true, y component of normal map value will be inverted (y = 1.0 - y).
  107193. */
  107194. protected _invertNormalMapY: boolean;
  107195. /**
  107196. * If sets to true and backfaceCulling is false, normals will be flipped on the backside.
  107197. */
  107198. protected _twoSidedLighting: boolean;
  107199. /**
  107200. * Defines the alpha limits in alpha test mode.
  107201. */
  107202. protected _alphaCutOff: number;
  107203. /**
  107204. * Enforces alpha test in opaque or blend mode in order to improve the performances of some situations.
  107205. */
  107206. protected _forceAlphaTest: boolean;
  107207. /**
  107208. * A fresnel is applied to the alpha of the model to ensure grazing angles edges are not alpha tested.
  107209. * And/Or occlude the blended part. (alpha is converted to gamma to compute the fresnel)
  107210. */
  107211. protected _useAlphaFresnel: boolean;
  107212. /**
  107213. * A fresnel is applied to the alpha of the model to ensure grazing angles edges are not alpha tested.
  107214. * And/Or occlude the blended part. (alpha stays linear to compute the fresnel)
  107215. */
  107216. protected _useLinearAlphaFresnel: boolean;
  107217. /**
  107218. * Specifies the environment BRDF texture used to comput the scale and offset roughness values
  107219. * from cos thetav and roughness:
  107220. * http://blog.selfshadow.com/publications/s2013-shading-course/karis/s2013_pbs_epic_notes_v2.pdf
  107221. */
  107222. protected _environmentBRDFTexture: Nullable<BaseTexture>;
  107223. /**
  107224. * Force the shader to compute irradiance in the fragment shader in order to take bump in account.
  107225. */
  107226. protected _forceIrradianceInFragment: boolean;
  107227. private _realTimeFiltering;
  107228. /**
  107229. * Enables realtime filtering on the texture.
  107230. */
  107231. get realTimeFiltering(): boolean;
  107232. set realTimeFiltering(b: boolean);
  107233. private _realTimeFilteringQuality;
  107234. /**
  107235. * Quality switch for realtime filtering
  107236. */
  107237. get realTimeFilteringQuality(): number;
  107238. set realTimeFilteringQuality(n: number);
  107239. /**
  107240. * Can this material render to several textures at once
  107241. */
  107242. get canRenderToMRT(): boolean;
  107243. /**
  107244. * Force normal to face away from face.
  107245. */
  107246. protected _forceNormalForward: boolean;
  107247. /**
  107248. * Enables specular anti aliasing in the PBR shader.
  107249. * It will both interacts on the Geometry for analytical and IBL lighting.
  107250. * It also prefilter the roughness map based on the bump values.
  107251. */
  107252. protected _enableSpecularAntiAliasing: boolean;
  107253. /**
  107254. * Default configuration related to image processing available in the PBR Material.
  107255. */
  107256. protected _imageProcessingConfiguration: ImageProcessingConfiguration;
  107257. /**
  107258. * Keep track of the image processing observer to allow dispose and replace.
  107259. */
  107260. private _imageProcessingObserver;
  107261. /**
  107262. * Attaches a new image processing configuration to the PBR Material.
  107263. * @param configuration
  107264. */
  107265. protected _attachImageProcessingConfiguration(configuration: Nullable<ImageProcessingConfiguration>): void;
  107266. /**
  107267. * Stores the available render targets.
  107268. */
  107269. private _renderTargets;
  107270. /**
  107271. * Sets the global ambient color for the material used in lighting calculations.
  107272. */
  107273. private _globalAmbientColor;
  107274. /**
  107275. * Enables the use of logarithmic depth buffers, which is good for wide depth buffers.
  107276. */
  107277. private _useLogarithmicDepth;
  107278. /**
  107279. * If set to true, no lighting calculations will be applied.
  107280. */
  107281. private _unlit;
  107282. private _debugMode;
  107283. /**
  107284. * @hidden
  107285. * This is reserved for the inspector.
  107286. * Defines the material debug mode.
  107287. * It helps seeing only some components of the material while troubleshooting.
  107288. */
  107289. debugMode: number;
  107290. /**
  107291. * @hidden
  107292. * This is reserved for the inspector.
  107293. * Specify from where on screen the debug mode should start.
  107294. * The value goes from -1 (full screen) to 1 (not visible)
  107295. * It helps with side by side comparison against the final render
  107296. * This defaults to -1
  107297. */
  107298. private debugLimit;
  107299. /**
  107300. * @hidden
  107301. * This is reserved for the inspector.
  107302. * As the default viewing range might not be enough (if the ambient is really small for instance)
  107303. * You can use the factor to better multiply the final value.
  107304. */
  107305. private debugFactor;
  107306. /**
  107307. * Defines the clear coat layer parameters for the material.
  107308. */
  107309. readonly clearCoat: PBRClearCoatConfiguration;
  107310. /**
  107311. * Defines the anisotropic parameters for the material.
  107312. */
  107313. readonly anisotropy: PBRAnisotropicConfiguration;
  107314. /**
  107315. * Defines the BRDF parameters for the material.
  107316. */
  107317. readonly brdf: PBRBRDFConfiguration;
  107318. /**
  107319. * Defines the Sheen parameters for the material.
  107320. */
  107321. readonly sheen: PBRSheenConfiguration;
  107322. /**
  107323. * Defines the SubSurface parameters for the material.
  107324. */
  107325. readonly subSurface: PBRSubSurfaceConfiguration;
  107326. /**
  107327. * Defines additionnal PrePass parameters for the material.
  107328. */
  107329. readonly prePassConfiguration: PrePassConfiguration;
  107330. /**
  107331. * Defines the detail map parameters for the material.
  107332. */
  107333. readonly detailMap: DetailMapConfiguration;
  107334. protected _rebuildInParallel: boolean;
  107335. /**
  107336. * Instantiates a new PBRMaterial instance.
  107337. *
  107338. * @param name The material name
  107339. * @param scene The scene the material will be use in.
  107340. */
  107341. constructor(name: string, scene: Scene);
  107342. /**
  107343. * Gets a boolean indicating that current material needs to register RTT
  107344. */
  107345. get hasRenderTargetTextures(): boolean;
  107346. /**
  107347. * Gets the name of the material class.
  107348. */
  107349. getClassName(): string;
  107350. /**
  107351. * Enabled the use of logarithmic depth buffers, which is good for wide depth buffers.
  107352. */
  107353. get useLogarithmicDepth(): boolean;
  107354. /**
  107355. * Enabled the use of logarithmic depth buffers, which is good for wide depth buffers.
  107356. */
  107357. set useLogarithmicDepth(value: boolean);
  107358. /**
  107359. * Returns true if alpha blending should be disabled.
  107360. */
  107361. protected get _disableAlphaBlending(): boolean;
  107362. /**
  107363. * Specifies whether or not this material should be rendered in alpha blend mode.
  107364. */
  107365. needAlphaBlending(): boolean;
  107366. /**
  107367. * Specifies whether or not this material should be rendered in alpha test mode.
  107368. */
  107369. needAlphaTesting(): boolean;
  107370. /**
  107371. * Specifies whether or not the alpha value of the albedo texture should be used for alpha blending.
  107372. */
  107373. protected _shouldUseAlphaFromAlbedoTexture(): boolean;
  107374. /**
  107375. * Specifies whether or not there is a usable alpha channel for transparency.
  107376. */
  107377. protected _hasAlphaChannel(): boolean;
  107378. /**
  107379. * Gets the texture used for the alpha test.
  107380. */
  107381. getAlphaTestTexture(): Nullable<BaseTexture>;
  107382. /**
  107383. * Specifies that the submesh is ready to be used.
  107384. * @param mesh - BJS mesh.
  107385. * @param subMesh - A submesh of the BJS mesh. Used to check if it is ready.
  107386. * @param useInstances - Specifies that instances should be used.
  107387. * @returns - boolean indicating that the submesh is ready or not.
  107388. */
  107389. isReadyForSubMesh(mesh: AbstractMesh, subMesh: SubMesh, useInstances?: boolean): boolean;
  107390. /**
  107391. * Specifies if the material uses metallic roughness workflow.
  107392. * @returns boolean specifiying if the material uses metallic roughness workflow.
  107393. */
  107394. isMetallicWorkflow(): boolean;
  107395. private _prepareEffect;
  107396. private _prepareDefines;
  107397. /**
  107398. * Force shader compilation
  107399. */
  107400. forceCompilation(mesh: AbstractMesh, onCompiled?: (material: Material) => void, options?: Partial<IMaterialCompilationOptions>): void;
  107401. /**
  107402. * Initializes the uniform buffer layout for the shader.
  107403. */
  107404. buildUniformLayout(): void;
  107405. /**
  107406. * Unbinds the material from the mesh
  107407. */
  107408. unbind(): void;
  107409. /**
  107410. * Binds the submesh data.
  107411. * @param world - The world matrix.
  107412. * @param mesh - The BJS mesh.
  107413. * @param subMesh - A submesh of the BJS mesh.
  107414. */
  107415. bindForSubMesh(world: Matrix, mesh: Mesh, subMesh: SubMesh): void;
  107416. /**
  107417. * Returns the animatable textures.
  107418. * @returns - Array of animatable textures.
  107419. */
  107420. getAnimatables(): IAnimatable[];
  107421. /**
  107422. * Returns the texture used for reflections.
  107423. * @returns - Reflection texture if present. Otherwise, returns the environment texture.
  107424. */
  107425. private _getReflectionTexture;
  107426. /**
  107427. * Returns an array of the actively used textures.
  107428. * @returns - Array of BaseTextures
  107429. */
  107430. getActiveTextures(): BaseTexture[];
  107431. /**
  107432. * Checks to see if a texture is used in the material.
  107433. * @param texture - Base texture to use.
  107434. * @returns - Boolean specifying if a texture is used in the material.
  107435. */
  107436. hasTexture(texture: BaseTexture): boolean;
  107437. /**
  107438. * Sets the required values to the prepass renderer.
  107439. * @param prePassRenderer defines the prepass renderer to setup
  107440. */
  107441. setPrePassRenderer(prePassRenderer: PrePassRenderer): boolean;
  107442. /**
  107443. * Disposes the resources of the material.
  107444. * @param forceDisposeEffect - Forces the disposal of effects.
  107445. * @param forceDisposeTextures - Forces the disposal of all textures.
  107446. */
  107447. dispose(forceDisposeEffect?: boolean, forceDisposeTextures?: boolean): void;
  107448. }
  107449. }
  107450. declare module BABYLON {
  107451. /**
  107452. * The Physically based material of BJS.
  107453. *
  107454. * This offers the main features of a standard PBR material.
  107455. * For more information, please refer to the documentation :
  107456. * https://doc.babylonjs.com/how_to/physically_based_rendering
  107457. */
  107458. export class PBRMaterial extends PBRBaseMaterial {
  107459. /**
  107460. * PBRMaterialTransparencyMode: No transparency mode, Alpha channel is not use.
  107461. */
  107462. static readonly PBRMATERIAL_OPAQUE: number;
  107463. /**
  107464. * PBRMaterialTransparencyMode: Alpha Test mode, pixel are discarded below a certain threshold defined by the alpha cutoff value.
  107465. */
  107466. static readonly PBRMATERIAL_ALPHATEST: number;
  107467. /**
  107468. * PBRMaterialTransparencyMode: Pixels are blended (according to the alpha mode) with the already drawn pixels in the current frame buffer.
  107469. */
  107470. static readonly PBRMATERIAL_ALPHABLEND: number;
  107471. /**
  107472. * PBRMaterialTransparencyMode: Pixels are blended (according to the alpha mode) with the already drawn pixels in the current frame buffer.
  107473. * They are also discarded below the alpha cutoff threshold to improve performances.
  107474. */
  107475. static readonly PBRMATERIAL_ALPHATESTANDBLEND: number;
  107476. /**
  107477. * Defines the default value of how much AO map is occluding the analytical lights
  107478. * (point spot...).
  107479. */
  107480. static DEFAULT_AO_ON_ANALYTICAL_LIGHTS: number;
  107481. /**
  107482. * Intensity of the direct lights e.g. the four lights available in your scene.
  107483. * This impacts both the direct diffuse and specular highlights.
  107484. */
  107485. directIntensity: number;
  107486. /**
  107487. * Intensity of the emissive part of the material.
  107488. * This helps controlling the emissive effect without modifying the emissive color.
  107489. */
  107490. emissiveIntensity: number;
  107491. /**
  107492. * Intensity of the environment e.g. how much the environment will light the object
  107493. * either through harmonics for rough material or through the refelction for shiny ones.
  107494. */
  107495. environmentIntensity: number;
  107496. /**
  107497. * This is a special control allowing the reduction of the specular highlights coming from the
  107498. * four lights of the scene. Those highlights may not be needed in full environment lighting.
  107499. */
  107500. specularIntensity: number;
  107501. /**
  107502. * Debug Control allowing disabling the bump map on this material.
  107503. */
  107504. disableBumpMap: boolean;
  107505. /**
  107506. * AKA Diffuse Texture in standard nomenclature.
  107507. */
  107508. albedoTexture: BaseTexture;
  107509. /**
  107510. * AKA Occlusion Texture in other nomenclature.
  107511. */
  107512. ambientTexture: BaseTexture;
  107513. /**
  107514. * AKA Occlusion Texture Intensity in other nomenclature.
  107515. */
  107516. ambientTextureStrength: number;
  107517. /**
  107518. * Defines how much the AO map is occluding the analytical lights (point spot...).
  107519. * 1 means it completely occludes it
  107520. * 0 mean it has no impact
  107521. */
  107522. ambientTextureImpactOnAnalyticalLights: number;
  107523. /**
  107524. * Stores the alpha values in a texture. Use luminance if texture.getAlphaFromRGB is true.
  107525. */
  107526. opacityTexture: BaseTexture;
  107527. /**
  107528. * Stores the reflection values in a texture.
  107529. */
  107530. reflectionTexture: Nullable<BaseTexture>;
  107531. /**
  107532. * Stores the emissive values in a texture.
  107533. */
  107534. emissiveTexture: BaseTexture;
  107535. /**
  107536. * AKA Specular texture in other nomenclature.
  107537. */
  107538. reflectivityTexture: BaseTexture;
  107539. /**
  107540. * Used to switch from specular/glossiness to metallic/roughness workflow.
  107541. */
  107542. metallicTexture: BaseTexture;
  107543. /**
  107544. * Specifies the metallic scalar of the metallic/roughness workflow.
  107545. * Can also be used to scale the metalness values of the metallic texture.
  107546. */
  107547. metallic: Nullable<number>;
  107548. /**
  107549. * Specifies the roughness scalar of the metallic/roughness workflow.
  107550. * Can also be used to scale the roughness values of the metallic texture.
  107551. */
  107552. roughness: Nullable<number>;
  107553. /**
  107554. * In metallic workflow, specifies an F0 factor to help configuring the material F0.
  107555. * By default the indexOfrefraction is used to compute F0;
  107556. *
  107557. * This is used as a factor against the default reflectance at normal incidence to tweak it.
  107558. *
  107559. * F0 = defaultF0 * metallicF0Factor * metallicReflectanceColor;
  107560. * F90 = metallicReflectanceColor;
  107561. */
  107562. metallicF0Factor: number;
  107563. /**
  107564. * In metallic workflow, specifies an F90 color to help configuring the material F90.
  107565. * By default the F90 is always 1;
  107566. *
  107567. * Please note that this factor is also used as a factor against the default reflectance at normal incidence.
  107568. *
  107569. * F0 = defaultF0 * metallicF0Factor * metallicReflectanceColor
  107570. * F90 = metallicReflectanceColor;
  107571. */
  107572. metallicReflectanceColor: Color3;
  107573. /**
  107574. * Defines to store metallicReflectanceColor in RGB and metallicF0Factor in A
  107575. * This is multiply against the scalar values defined in the material.
  107576. */
  107577. metallicReflectanceTexture: Nullable<BaseTexture>;
  107578. /**
  107579. * Used to enable roughness/glossiness fetch from a separate channel depending on the current mode.
  107580. * Gray Scale represents roughness in metallic mode and glossiness in specular mode.
  107581. */
  107582. microSurfaceTexture: BaseTexture;
  107583. /**
  107584. * Stores surface normal data used to displace a mesh in a texture.
  107585. */
  107586. bumpTexture: BaseTexture;
  107587. /**
  107588. * Stores the pre-calculated light information of a mesh in a texture.
  107589. */
  107590. lightmapTexture: BaseTexture;
  107591. /**
  107592. * Stores the refracted light information in a texture.
  107593. */
  107594. get refractionTexture(): Nullable<BaseTexture>;
  107595. set refractionTexture(value: Nullable<BaseTexture>);
  107596. /**
  107597. * The color of a material in ambient lighting.
  107598. */
  107599. ambientColor: Color3;
  107600. /**
  107601. * AKA Diffuse Color in other nomenclature.
  107602. */
  107603. albedoColor: Color3;
  107604. /**
  107605. * AKA Specular Color in other nomenclature.
  107606. */
  107607. reflectivityColor: Color3;
  107608. /**
  107609. * The color reflected from the material.
  107610. */
  107611. reflectionColor: Color3;
  107612. /**
  107613. * The color emitted from the material.
  107614. */
  107615. emissiveColor: Color3;
  107616. /**
  107617. * AKA Glossiness in other nomenclature.
  107618. */
  107619. microSurface: number;
  107620. /**
  107621. * Index of refraction of the material base layer.
  107622. * https://en.wikipedia.org/wiki/List_of_refractive_indices
  107623. *
  107624. * This does not only impact refraction but also the Base F0 of Dielectric Materials.
  107625. *
  107626. * From dielectric fresnel rules: F0 = square((iorT - iorI) / (iorT + iorI))
  107627. */
  107628. get indexOfRefraction(): number;
  107629. set indexOfRefraction(value: number);
  107630. /**
  107631. * Controls if refraction needs to be inverted on Y. This could be useful for procedural texture.
  107632. */
  107633. get invertRefractionY(): boolean;
  107634. set invertRefractionY(value: boolean);
  107635. /**
  107636. * This parameters will make the material used its opacity to control how much it is refracting aginst not.
  107637. * Materials half opaque for instance using refraction could benefit from this control.
  107638. */
  107639. get linkRefractionWithTransparency(): boolean;
  107640. set linkRefractionWithTransparency(value: boolean);
  107641. /**
  107642. * If true, the light map contains occlusion information instead of lighting info.
  107643. */
  107644. useLightmapAsShadowmap: boolean;
  107645. /**
  107646. * Specifies that the alpha is coming form the albedo channel alpha channel for alpha blending.
  107647. */
  107648. useAlphaFromAlbedoTexture: boolean;
  107649. /**
  107650. * Enforces alpha test in opaque or blend mode in order to improve the performances of some situations.
  107651. */
  107652. forceAlphaTest: boolean;
  107653. /**
  107654. * Defines the alpha limits in alpha test mode.
  107655. */
  107656. alphaCutOff: number;
  107657. /**
  107658. * Specifies that the material will keep the specular highlights over a transparent surface (only the most limunous ones).
  107659. * A car glass is a good exemple of that. When sun reflects on it you can not see what is behind.
  107660. */
  107661. useSpecularOverAlpha: boolean;
  107662. /**
  107663. * Specifies if the reflectivity texture contains the glossiness information in its alpha channel.
  107664. */
  107665. useMicroSurfaceFromReflectivityMapAlpha: boolean;
  107666. /**
  107667. * Specifies if the metallic texture contains the roughness information in its alpha channel.
  107668. */
  107669. useRoughnessFromMetallicTextureAlpha: boolean;
  107670. /**
  107671. * Specifies if the metallic texture contains the roughness information in its green channel.
  107672. */
  107673. useRoughnessFromMetallicTextureGreen: boolean;
  107674. /**
  107675. * Specifies if the metallic texture contains the metallness information in its blue channel.
  107676. */
  107677. useMetallnessFromMetallicTextureBlue: boolean;
  107678. /**
  107679. * Specifies if the metallic texture contains the ambient occlusion information in its red channel.
  107680. */
  107681. useAmbientOcclusionFromMetallicTextureRed: boolean;
  107682. /**
  107683. * Specifies if the ambient texture contains the ambient occlusion information in its red channel only.
  107684. */
  107685. useAmbientInGrayScale: boolean;
  107686. /**
  107687. * In case the reflectivity map does not contain the microsurface information in its alpha channel,
  107688. * The material will try to infer what glossiness each pixel should be.
  107689. */
  107690. useAutoMicroSurfaceFromReflectivityMap: boolean;
  107691. /**
  107692. * BJS is using an harcoded light falloff based on a manually sets up range.
  107693. * In PBR, one way to represents the fallof is to use the inverse squared root algorythm.
  107694. * This parameter can help you switch back to the BJS mode in order to create scenes using both materials.
  107695. */
  107696. get usePhysicalLightFalloff(): boolean;
  107697. /**
  107698. * BJS is using an harcoded light falloff based on a manually sets up range.
  107699. * In PBR, one way to represents the fallof is to use the inverse squared root algorythm.
  107700. * This parameter can help you switch back to the BJS mode in order to create scenes using both materials.
  107701. */
  107702. set usePhysicalLightFalloff(value: boolean);
  107703. /**
  107704. * In order to support the falloff compatibility with gltf, a special mode has been added
  107705. * to reproduce the gltf light falloff.
  107706. */
  107707. get useGLTFLightFalloff(): boolean;
  107708. /**
  107709. * In order to support the falloff compatibility with gltf, a special mode has been added
  107710. * to reproduce the gltf light falloff.
  107711. */
  107712. set useGLTFLightFalloff(value: boolean);
  107713. /**
  107714. * Specifies that the material will keeps the reflection highlights over a transparent surface (only the most limunous ones).
  107715. * A car glass is a good exemple of that. When the street lights reflects on it you can not see what is behind.
  107716. */
  107717. useRadianceOverAlpha: boolean;
  107718. /**
  107719. * Allows using an object space normal map (instead of tangent space).
  107720. */
  107721. useObjectSpaceNormalMap: boolean;
  107722. /**
  107723. * Allows using the bump map in parallax mode.
  107724. */
  107725. useParallax: boolean;
  107726. /**
  107727. * Allows using the bump map in parallax occlusion mode.
  107728. */
  107729. useParallaxOcclusion: boolean;
  107730. /**
  107731. * Controls the scale bias of the parallax mode.
  107732. */
  107733. parallaxScaleBias: number;
  107734. /**
  107735. * If sets to true, disables all the lights affecting the material.
  107736. */
  107737. disableLighting: boolean;
  107738. /**
  107739. * Force the shader to compute irradiance in the fragment shader in order to take bump in account.
  107740. */
  107741. forceIrradianceInFragment: boolean;
  107742. /**
  107743. * Number of Simultaneous lights allowed on the material.
  107744. */
  107745. maxSimultaneousLights: number;
  107746. /**
  107747. * If sets to true, x component of normal map value will invert (x = 1.0 - x).
  107748. */
  107749. invertNormalMapX: boolean;
  107750. /**
  107751. * If sets to true, y component of normal map value will invert (y = 1.0 - y).
  107752. */
  107753. invertNormalMapY: boolean;
  107754. /**
  107755. * If sets to true and backfaceCulling is false, normals will be flipped on the backside.
  107756. */
  107757. twoSidedLighting: boolean;
  107758. /**
  107759. * A fresnel is applied to the alpha of the model to ensure grazing angles edges are not alpha tested.
  107760. * And/Or occlude the blended part. (alpha is converted to gamma to compute the fresnel)
  107761. */
  107762. useAlphaFresnel: boolean;
  107763. /**
  107764. * A fresnel is applied to the alpha of the model to ensure grazing angles edges are not alpha tested.
  107765. * And/Or occlude the blended part. (alpha stays linear to compute the fresnel)
  107766. */
  107767. useLinearAlphaFresnel: boolean;
  107768. /**
  107769. * Let user defines the brdf lookup texture used for IBL.
  107770. * A default 8bit version is embedded but you could point at :
  107771. * * Default texture: https://assets.babylonjs.com/environments/correlatedMSBRDF_RGBD.png
  107772. * * Default 16bit pixel depth texture: https://assets.babylonjs.com/environments/correlatedMSBRDF.dds
  107773. * * LEGACY Default None correlated https://assets.babylonjs.com/environments/uncorrelatedBRDF_RGBD.png
  107774. * * LEGACY Default None correlated 16bit pixel depth https://assets.babylonjs.com/environments/uncorrelatedBRDF.dds
  107775. */
  107776. environmentBRDFTexture: Nullable<BaseTexture>;
  107777. /**
  107778. * Force normal to face away from face.
  107779. */
  107780. forceNormalForward: boolean;
  107781. /**
  107782. * Enables specular anti aliasing in the PBR shader.
  107783. * It will both interacts on the Geometry for analytical and IBL lighting.
  107784. * It also prefilter the roughness map based on the bump values.
  107785. */
  107786. enableSpecularAntiAliasing: boolean;
  107787. /**
  107788. * This parameters will enable/disable Horizon occlusion to prevent normal maps to look shiny when the normal
  107789. * makes the reflect vector face the model (under horizon).
  107790. */
  107791. useHorizonOcclusion: boolean;
  107792. /**
  107793. * This parameters will enable/disable radiance occlusion by preventing the radiance to lit
  107794. * too much the area relying on ambient texture to define their ambient occlusion.
  107795. */
  107796. useRadianceOcclusion: boolean;
  107797. /**
  107798. * If set to true, no lighting calculations will be applied.
  107799. */
  107800. unlit: boolean;
  107801. /**
  107802. * Gets the image processing configuration used either in this material.
  107803. */
  107804. get imageProcessingConfiguration(): ImageProcessingConfiguration;
  107805. /**
  107806. * Sets the Default image processing configuration used either in the this material.
  107807. *
  107808. * If sets to null, the scene one is in use.
  107809. */
  107810. set imageProcessingConfiguration(value: ImageProcessingConfiguration);
  107811. /**
  107812. * Gets wether the color curves effect is enabled.
  107813. */
  107814. get cameraColorCurvesEnabled(): boolean;
  107815. /**
  107816. * Sets wether the color curves effect is enabled.
  107817. */
  107818. set cameraColorCurvesEnabled(value: boolean);
  107819. /**
  107820. * Gets wether the color grading effect is enabled.
  107821. */
  107822. get cameraColorGradingEnabled(): boolean;
  107823. /**
  107824. * Gets wether the color grading effect is enabled.
  107825. */
  107826. set cameraColorGradingEnabled(value: boolean);
  107827. /**
  107828. * Gets wether tonemapping is enabled or not.
  107829. */
  107830. get cameraToneMappingEnabled(): boolean;
  107831. /**
  107832. * Sets wether tonemapping is enabled or not
  107833. */
  107834. set cameraToneMappingEnabled(value: boolean);
  107835. /**
  107836. * The camera exposure used on this material.
  107837. * This property is here and not in the camera to allow controlling exposure without full screen post process.
  107838. * This corresponds to a photographic exposure.
  107839. */
  107840. get cameraExposure(): number;
  107841. /**
  107842. * The camera exposure used on this material.
  107843. * This property is here and not in the camera to allow controlling exposure without full screen post process.
  107844. * This corresponds to a photographic exposure.
  107845. */
  107846. set cameraExposure(value: number);
  107847. /**
  107848. * Gets The camera contrast used on this material.
  107849. */
  107850. get cameraContrast(): number;
  107851. /**
  107852. * Sets The camera contrast used on this material.
  107853. */
  107854. set cameraContrast(value: number);
  107855. /**
  107856. * Gets the Color Grading 2D Lookup Texture.
  107857. */
  107858. get cameraColorGradingTexture(): Nullable<BaseTexture>;
  107859. /**
  107860. * Sets the Color Grading 2D Lookup Texture.
  107861. */
  107862. set cameraColorGradingTexture(value: Nullable<BaseTexture>);
  107863. /**
  107864. * The color grading curves provide additional color adjustmnent that is applied after any color grading transform (3D LUT).
  107865. * They allow basic adjustment of saturation and small exposure adjustments, along with color filter tinting to provide white balance adjustment or more stylistic effects.
  107866. * 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;
  107867. * corresponding to low luminance, medium luminance, and high luminance areas respectively.
  107868. */
  107869. get cameraColorCurves(): Nullable<ColorCurves>;
  107870. /**
  107871. * The color grading curves provide additional color adjustmnent that is applied after any color grading transform (3D LUT).
  107872. * They allow basic adjustment of saturation and small exposure adjustments, along with color filter tinting to provide white balance adjustment or more stylistic effects.
  107873. * 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;
  107874. * corresponding to low luminance, medium luminance, and high luminance areas respectively.
  107875. */
  107876. set cameraColorCurves(value: Nullable<ColorCurves>);
  107877. /**
  107878. * Instantiates a new PBRMaterial instance.
  107879. *
  107880. * @param name The material name
  107881. * @param scene The scene the material will be use in.
  107882. */
  107883. constructor(name: string, scene: Scene);
  107884. /**
  107885. * Returns the name of this material class.
  107886. */
  107887. getClassName(): string;
  107888. /**
  107889. * Makes a duplicate of the current material.
  107890. * @param name - name to use for the new material.
  107891. */
  107892. clone(name: string): PBRMaterial;
  107893. /**
  107894. * Serializes this PBR Material.
  107895. * @returns - An object with the serialized material.
  107896. */
  107897. serialize(): any;
  107898. /**
  107899. * Parses a PBR Material from a serialized object.
  107900. * @param source - Serialized object.
  107901. * @param scene - BJS scene instance.
  107902. * @param rootUrl - url for the scene object
  107903. * @returns - PBRMaterial
  107904. */
  107905. static Parse(source: any, scene: Scene, rootUrl: string): PBRMaterial;
  107906. }
  107907. }
  107908. declare module BABYLON {
  107909. /** @hidden */
  107910. export var mrtFragmentDeclaration: {
  107911. name: string;
  107912. shader: string;
  107913. };
  107914. }
  107915. declare module BABYLON {
  107916. /** @hidden */
  107917. export var geometryPixelShader: {
  107918. name: string;
  107919. shader: string;
  107920. };
  107921. }
  107922. declare module BABYLON {
  107923. /** @hidden */
  107924. export var geometryVertexShader: {
  107925. name: string;
  107926. shader: string;
  107927. };
  107928. }
  107929. declare module BABYLON {
  107930. /** @hidden */
  107931. interface ISavedTransformationMatrix {
  107932. world: Matrix;
  107933. viewProjection: Matrix;
  107934. }
  107935. /**
  107936. * This renderer is helpfull to fill one of the render target with a geometry buffer.
  107937. */
  107938. export class GeometryBufferRenderer {
  107939. /**
  107940. * Constant used to retrieve the depth + normal texture index in the G-Buffer textures array
  107941. * using getIndex(GeometryBufferRenderer.DEPTHNORMAL_TEXTURE_INDEX)
  107942. */
  107943. static readonly DEPTHNORMAL_TEXTURE_TYPE: number;
  107944. /**
  107945. * Constant used to retrieve the position texture index in the G-Buffer textures array
  107946. * using getIndex(GeometryBufferRenderer.POSITION_TEXTURE_INDEX)
  107947. */
  107948. static readonly POSITION_TEXTURE_TYPE: number;
  107949. /**
  107950. * Constant used to retrieve the velocity texture index in the G-Buffer textures array
  107951. * using getIndex(GeometryBufferRenderer.VELOCITY_TEXTURE_INDEX)
  107952. */
  107953. static readonly VELOCITY_TEXTURE_TYPE: number;
  107954. /**
  107955. * Constant used to retrieve the reflectivity texture index in the G-Buffer textures array
  107956. * using the getIndex(GeometryBufferRenderer.REFLECTIVITY_TEXTURE_TYPE)
  107957. */
  107958. static readonly REFLECTIVITY_TEXTURE_TYPE: number;
  107959. /**
  107960. * Dictionary used to store the previous transformation matrices of each rendered mesh
  107961. * in order to compute objects velocities when enableVelocity is set to "true"
  107962. * @hidden
  107963. */
  107964. _previousTransformationMatrices: {
  107965. [index: number]: ISavedTransformationMatrix;
  107966. };
  107967. /**
  107968. * Dictionary used to store the previous bones transformation matrices of each rendered mesh
  107969. * in order to compute objects velocities when enableVelocity is set to "true"
  107970. * @hidden
  107971. */
  107972. _previousBonesTransformationMatrices: {
  107973. [index: number]: Float32Array;
  107974. };
  107975. /**
  107976. * Array used to store the ignored skinned meshes while computing velocity map (typically used by the motion blur post-process).
  107977. * Avoids computing bones velocities and computes only mesh's velocity itself (position, rotation, scaling).
  107978. */
  107979. excludedSkinnedMeshesFromVelocity: AbstractMesh[];
  107980. /** Gets or sets a boolean indicating if transparent meshes should be rendered */
  107981. renderTransparentMeshes: boolean;
  107982. private _scene;
  107983. private _resizeObserver;
  107984. private _multiRenderTarget;
  107985. private _ratio;
  107986. private _enablePosition;
  107987. private _enableVelocity;
  107988. private _enableReflectivity;
  107989. private _positionIndex;
  107990. private _velocityIndex;
  107991. private _reflectivityIndex;
  107992. private _depthNormalIndex;
  107993. private _linkedWithPrePass;
  107994. private _prePassRenderer;
  107995. private _attachments;
  107996. protected _effect: Effect;
  107997. protected _cachedDefines: string;
  107998. /**
  107999. * @hidden
  108000. * Sets up internal structures to share outputs with PrePassRenderer
  108001. * This method should only be called by the PrePassRenderer itself
  108002. */
  108003. _linkPrePassRenderer(prePassRenderer: PrePassRenderer): void;
  108004. /**
  108005. * @hidden
  108006. * Separates internal structures from PrePassRenderer so the geometry buffer can now operate by itself.
  108007. * This method should only be called by the PrePassRenderer itself
  108008. */
  108009. _unlinkPrePassRenderer(): void;
  108010. /**
  108011. * @hidden
  108012. * Resets the geometry buffer layout
  108013. */
  108014. _resetLayout(): void;
  108015. /**
  108016. * @hidden
  108017. * Replaces a texture in the geometry buffer renderer
  108018. * Useful when linking textures of the prepass renderer
  108019. */
  108020. _forceTextureType(geometryBufferType: number, index: number): void;
  108021. /**
  108022. * @hidden
  108023. * Sets texture attachments
  108024. * Useful when linking textures of the prepass renderer
  108025. */
  108026. _setAttachments(attachments: number[]): void;
  108027. /**
  108028. * @hidden
  108029. * Replaces the first texture which is hard coded as a depth texture in the geometry buffer
  108030. * Useful when linking textures of the prepass renderer
  108031. */
  108032. _linkInternalTexture(internalTexture: InternalTexture): void;
  108033. /**
  108034. * Gets the render list (meshes to be rendered) used in the G buffer.
  108035. */
  108036. get renderList(): Nullable<AbstractMesh[]>;
  108037. /**
  108038. * Set the render list (meshes to be rendered) used in the G buffer.
  108039. */
  108040. set renderList(meshes: Nullable<AbstractMesh[]>);
  108041. /**
  108042. * Gets wether or not G buffer are supported by the running hardware.
  108043. * This requires draw buffer supports
  108044. */
  108045. get isSupported(): boolean;
  108046. /**
  108047. * Returns the index of the given texture type in the G-Buffer textures array
  108048. * @param textureType The texture type constant. For example GeometryBufferRenderer.POSITION_TEXTURE_INDEX
  108049. * @returns the index of the given texture type in the G-Buffer textures array
  108050. */
  108051. getTextureIndex(textureType: number): number;
  108052. /**
  108053. * Gets a boolean indicating if objects positions are enabled for the G buffer.
  108054. */
  108055. get enablePosition(): boolean;
  108056. /**
  108057. * Sets whether or not objects positions are enabled for the G buffer.
  108058. */
  108059. set enablePosition(enable: boolean);
  108060. /**
  108061. * Gets a boolean indicating if objects velocities are enabled for the G buffer.
  108062. */
  108063. get enableVelocity(): boolean;
  108064. /**
  108065. * Sets wether or not objects velocities are enabled for the G buffer.
  108066. */
  108067. set enableVelocity(enable: boolean);
  108068. /**
  108069. * Gets a boolean indicating if objects roughness are enabled in the G buffer.
  108070. */
  108071. get enableReflectivity(): boolean;
  108072. /**
  108073. * Sets wether or not objects roughness are enabled for the G buffer.
  108074. */
  108075. set enableReflectivity(enable: boolean);
  108076. /**
  108077. * Gets the scene associated with the buffer.
  108078. */
  108079. get scene(): Scene;
  108080. /**
  108081. * Gets the ratio used by the buffer during its creation.
  108082. * How big is the buffer related to the main canvas.
  108083. */
  108084. get ratio(): number;
  108085. /** @hidden */
  108086. static _SceneComponentInitialization: (scene: Scene) => void;
  108087. /**
  108088. * Creates a new G Buffer for the scene
  108089. * @param scene The scene the buffer belongs to
  108090. * @param ratio How big is the buffer related to the main canvas.
  108091. */
  108092. constructor(scene: Scene, ratio?: number);
  108093. /**
  108094. * Checks wether everything is ready to render a submesh to the G buffer.
  108095. * @param subMesh the submesh to check readiness for
  108096. * @param useInstances is the mesh drawn using instance or not
  108097. * @returns true if ready otherwise false
  108098. */
  108099. isReady(subMesh: SubMesh, useInstances: boolean): boolean;
  108100. /**
  108101. * Gets the current underlying G Buffer.
  108102. * @returns the buffer
  108103. */
  108104. getGBuffer(): MultiRenderTarget;
  108105. /**
  108106. * Gets the number of samples used to render the buffer (anti aliasing).
  108107. */
  108108. get samples(): number;
  108109. /**
  108110. * Sets the number of samples used to render the buffer (anti aliasing).
  108111. */
  108112. set samples(value: number);
  108113. /**
  108114. * Disposes the renderer and frees up associated resources.
  108115. */
  108116. dispose(): void;
  108117. private _assignRenderTargetIndices;
  108118. protected _createRenderTargets(): void;
  108119. private _copyBonesTransformationMatrices;
  108120. }
  108121. }
  108122. declare module BABYLON {
  108123. /**
  108124. * Renders a pre pass of the scene
  108125. * This means every mesh in the scene will be rendered to a render target texture
  108126. * And then this texture will be composited to the rendering canvas with post processes
  108127. * It is necessary for effects like subsurface scattering or deferred shading
  108128. */
  108129. export class PrePassRenderer {
  108130. /** @hidden */
  108131. static _SceneComponentInitialization: (scene: Scene) => void;
  108132. private _textureFormats;
  108133. /**
  108134. * To save performance, we can excluded skinned meshes from the prepass
  108135. */
  108136. excludedSkinnedMesh: AbstractMesh[];
  108137. /**
  108138. * Force material to be excluded from the prepass
  108139. * Can be useful when `useGeometryBufferFallback` is set to `true`
  108140. * and you don't want a material to show in the effect.
  108141. */
  108142. excludedMaterials: Material[];
  108143. private _textureIndices;
  108144. private _scene;
  108145. private _engine;
  108146. private _isDirty;
  108147. /**
  108148. * Number of textures in the multi render target texture where the scene is directly rendered
  108149. */
  108150. mrtCount: number;
  108151. /**
  108152. * The render target where the scene is directly rendered
  108153. */
  108154. prePassRT: MultiRenderTarget;
  108155. private _multiRenderAttachments;
  108156. private _defaultAttachments;
  108157. private _clearAttachments;
  108158. private _postProcesses;
  108159. private readonly _clearColor;
  108160. /**
  108161. * Image processing post process for composition
  108162. */
  108163. imageProcessingPostProcess: ImageProcessingPostProcess;
  108164. /**
  108165. * Configuration for prepass effects
  108166. */
  108167. private _effectConfigurations;
  108168. private _mrtFormats;
  108169. private _mrtLayout;
  108170. private _enabled;
  108171. /**
  108172. * Indicates if the prepass is enabled
  108173. */
  108174. get enabled(): boolean;
  108175. /**
  108176. * How many samples are used for MSAA of the scene render target
  108177. */
  108178. get samples(): number;
  108179. set samples(n: number);
  108180. private _geometryBuffer;
  108181. private _useGeometryBufferFallback;
  108182. /**
  108183. * Uses the geometry buffer renderer as a fallback for non prepass capable effects
  108184. */
  108185. get useGeometryBufferFallback(): boolean;
  108186. set useGeometryBufferFallback(value: boolean);
  108187. /**
  108188. * Instanciates a prepass renderer
  108189. * @param scene The scene
  108190. */
  108191. constructor(scene: Scene);
  108192. private _initializeAttachments;
  108193. private _createCompositionEffect;
  108194. /**
  108195. * Indicates if rendering a prepass is supported
  108196. */
  108197. get isSupported(): boolean;
  108198. /**
  108199. * Sets the proper output textures to draw in the engine.
  108200. * @param effect The effect that is drawn. It can be or not be compatible with drawing to several output textures.
  108201. * @param subMesh Submesh on which the effect is applied
  108202. */
  108203. bindAttachmentsForEffect(effect: Effect, subMesh: SubMesh): void;
  108204. /**
  108205. * @hidden
  108206. */
  108207. _beforeCameraDraw(): void;
  108208. /**
  108209. * @hidden
  108210. */
  108211. _afterCameraDraw(): void;
  108212. private _checkRTSize;
  108213. private _bindFrameBuffer;
  108214. /**
  108215. * Clears the scene render target (in the sense of settings pixels to the scene clear color value)
  108216. */
  108217. clear(): void;
  108218. private _setState;
  108219. private _updateGeometryBufferLayout;
  108220. /**
  108221. * Adds an effect configuration to the prepass.
  108222. * If an effect has already been added, it won't add it twice and will return the configuration
  108223. * already present.
  108224. * @param cfg the effect configuration
  108225. * @return the effect configuration now used by the prepass
  108226. */
  108227. addEffectConfiguration(cfg: PrePassEffectConfiguration): PrePassEffectConfiguration;
  108228. /**
  108229. * Returns the index of a texture in the multi render target texture array.
  108230. * @param type Texture type
  108231. * @return The index
  108232. */
  108233. getIndex(type: number): number;
  108234. private _enable;
  108235. private _disable;
  108236. private _resetLayout;
  108237. private _resetPostProcessChain;
  108238. private _bindPostProcessChain;
  108239. /**
  108240. * Marks the prepass renderer as dirty, triggering a check if the prepass is necessary for the next rendering.
  108241. */
  108242. markAsDirty(): void;
  108243. /**
  108244. * Enables a texture on the MultiRenderTarget for prepass
  108245. */
  108246. private _enableTextures;
  108247. private _update;
  108248. private _markAllMaterialsAsPrePassDirty;
  108249. /**
  108250. * Disposes the prepass renderer.
  108251. */
  108252. dispose(): void;
  108253. }
  108254. }
  108255. declare module BABYLON {
  108256. /**
  108257. * Size options for a post process
  108258. */
  108259. export type PostProcessOptions = {
  108260. width: number;
  108261. height: number;
  108262. };
  108263. /**
  108264. * PostProcess can be used to apply a shader to a texture after it has been rendered
  108265. * See https://doc.babylonjs.com/how_to/how_to_use_postprocesses
  108266. */
  108267. export class PostProcess {
  108268. /**
  108269. * Gets or sets the unique id of the post process
  108270. */
  108271. uniqueId: number;
  108272. /** Name of the PostProcess. */
  108273. name: string;
  108274. /**
  108275. * Width of the texture to apply the post process on
  108276. */
  108277. width: number;
  108278. /**
  108279. * Height of the texture to apply the post process on
  108280. */
  108281. height: number;
  108282. /**
  108283. * Gets the node material used to create this postprocess (null if the postprocess was manually created)
  108284. */
  108285. nodeMaterialSource: Nullable<NodeMaterial>;
  108286. /**
  108287. * Internal, reference to the location where this postprocess was output to. (Typically the texture on the next postprocess in the chain)
  108288. * @hidden
  108289. */
  108290. _outputTexture: Nullable<InternalTexture>;
  108291. /**
  108292. * Sampling mode used by the shader
  108293. * See https://doc.babylonjs.com/classes/3.1/texture
  108294. */
  108295. renderTargetSamplingMode: number;
  108296. /**
  108297. * Clear color to use when screen clearing
  108298. */
  108299. clearColor: Color4;
  108300. /**
  108301. * If the buffer needs to be cleared before applying the post process. (default: true)
  108302. * Should be set to false if shader will overwrite all previous pixels.
  108303. */
  108304. autoClear: boolean;
  108305. /**
  108306. * Type of alpha mode to use when performing the post process (default: Engine.ALPHA_DISABLE)
  108307. */
  108308. alphaMode: number;
  108309. /**
  108310. * Sets the setAlphaBlendConstants of the babylon engine
  108311. */
  108312. alphaConstants: Color4;
  108313. /**
  108314. * Animations to be used for the post processing
  108315. */
  108316. animations: Animation[];
  108317. /**
  108318. * Enable Pixel Perfect mode where texture is not scaled to be power of 2.
  108319. * Can only be used on a single postprocess or on the last one of a chain. (default: false)
  108320. */
  108321. enablePixelPerfectMode: boolean;
  108322. /**
  108323. * Force the postprocess to be applied without taking in account viewport
  108324. */
  108325. forceFullscreenViewport: boolean;
  108326. /**
  108327. * List of inspectable custom properties (used by the Inspector)
  108328. * @see https://doc.babylonjs.com/how_to/debug_layer#extensibility
  108329. */
  108330. inspectableCustomProperties: IInspectable[];
  108331. /**
  108332. * Scale mode for the post process (default: Engine.SCALEMODE_FLOOR)
  108333. *
  108334. * | Value | Type | Description |
  108335. * | ----- | ----------------------------------- | ----------- |
  108336. * | 1 | SCALEMODE_FLOOR | [engine.scalemode_floor](https://doc.babylonjs.com/api/classes/babylon.engine#scalemode_floor) |
  108337. * | 2 | SCALEMODE_NEAREST | [engine.scalemode_nearest](https://doc.babylonjs.com/api/classes/babylon.engine#scalemode_nearest) |
  108338. * | 3 | SCALEMODE_CEILING | [engine.scalemode_ceiling](https://doc.babylonjs.com/api/classes/babylon.engine#scalemode_ceiling) |
  108339. *
  108340. */
  108341. scaleMode: number;
  108342. /**
  108343. * Force textures to be a power of two (default: false)
  108344. */
  108345. alwaysForcePOT: boolean;
  108346. private _samples;
  108347. /**
  108348. * Number of sample textures (default: 1)
  108349. */
  108350. get samples(): number;
  108351. set samples(n: number);
  108352. /**
  108353. * Modify the scale of the post process to be the same as the viewport (default: false)
  108354. */
  108355. adaptScaleToCurrentViewport: boolean;
  108356. private _camera;
  108357. protected _scene: Scene;
  108358. private _engine;
  108359. private _options;
  108360. private _reusable;
  108361. private _textureType;
  108362. private _textureFormat;
  108363. /**
  108364. * Smart array of input and output textures for the post process.
  108365. * @hidden
  108366. */
  108367. _textures: SmartArray<InternalTexture>;
  108368. /**
  108369. * The index in _textures that corresponds to the output texture.
  108370. * @hidden
  108371. */
  108372. _currentRenderTextureInd: number;
  108373. private _effect;
  108374. private _samplers;
  108375. private _fragmentUrl;
  108376. private _vertexUrl;
  108377. private _parameters;
  108378. private _scaleRatio;
  108379. protected _indexParameters: any;
  108380. private _shareOutputWithPostProcess;
  108381. private _texelSize;
  108382. private _forcedOutputTexture;
  108383. /**
  108384. * Prepass configuration in case this post process needs a texture from prepass
  108385. * @hidden
  108386. */
  108387. _prePassEffectConfiguration: PrePassEffectConfiguration;
  108388. /**
  108389. * Returns the fragment url or shader name used in the post process.
  108390. * @returns the fragment url or name in the shader store.
  108391. */
  108392. getEffectName(): string;
  108393. /**
  108394. * An event triggered when the postprocess is activated.
  108395. */
  108396. onActivateObservable: Observable<Camera>;
  108397. private _onActivateObserver;
  108398. /**
  108399. * A function that is added to the onActivateObservable
  108400. */
  108401. set onActivate(callback: Nullable<(camera: Camera) => void>);
  108402. /**
  108403. * An event triggered when the postprocess changes its size.
  108404. */
  108405. onSizeChangedObservable: Observable<PostProcess>;
  108406. private _onSizeChangedObserver;
  108407. /**
  108408. * A function that is added to the onSizeChangedObservable
  108409. */
  108410. set onSizeChanged(callback: (postProcess: PostProcess) => void);
  108411. /**
  108412. * An event triggered when the postprocess applies its effect.
  108413. */
  108414. onApplyObservable: Observable<Effect>;
  108415. private _onApplyObserver;
  108416. /**
  108417. * A function that is added to the onApplyObservable
  108418. */
  108419. set onApply(callback: (effect: Effect) => void);
  108420. /**
  108421. * An event triggered before rendering the postprocess
  108422. */
  108423. onBeforeRenderObservable: Observable<Effect>;
  108424. private _onBeforeRenderObserver;
  108425. /**
  108426. * A function that is added to the onBeforeRenderObservable
  108427. */
  108428. set onBeforeRender(callback: (effect: Effect) => void);
  108429. /**
  108430. * An event triggered after rendering the postprocess
  108431. */
  108432. onAfterRenderObservable: Observable<Effect>;
  108433. private _onAfterRenderObserver;
  108434. /**
  108435. * A function that is added to the onAfterRenderObservable
  108436. */
  108437. set onAfterRender(callback: (efect: Effect) => void);
  108438. /**
  108439. * 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
  108440. * render it's output into this texture and this texture will be used as textureSampler in the fragment shader of this post process.
  108441. */
  108442. get inputTexture(): InternalTexture;
  108443. set inputTexture(value: InternalTexture);
  108444. /**
  108445. * Since inputTexture should always be defined, if we previously manually set `inputTexture`,
  108446. * the only way to unset it is to use this function to restore its internal state
  108447. */
  108448. restoreDefaultInputTexture(): void;
  108449. /**
  108450. * Gets the camera which post process is applied to.
  108451. * @returns The camera the post process is applied to.
  108452. */
  108453. getCamera(): Camera;
  108454. /**
  108455. * Gets the texel size of the postprocess.
  108456. * See https://en.wikipedia.org/wiki/Texel_(graphics)
  108457. */
  108458. get texelSize(): Vector2;
  108459. /**
  108460. * Creates a new instance PostProcess
  108461. * @param name The name of the PostProcess.
  108462. * @param fragmentUrl The url of the fragment shader to be used.
  108463. * @param parameters Array of the names of uniform non-sampler2D variables that will be passed to the shader.
  108464. * @param samplers Array of the names of uniform sampler2D variables that will be passed to the shader.
  108465. * @param options The required width/height ratio to downsize to before computing the render pass. (Use 1.0 for full size)
  108466. * @param camera The camera to apply the render pass to.
  108467. * @param samplingMode The sampling mode to be used when computing the pass. (default: 0)
  108468. * @param engine The engine which the post process will be applied. (default: current engine)
  108469. * @param reusable If the post process can be reused on the same frame. (default: false)
  108470. * @param defines String of defines that will be set when running the fragment shader. (default: null)
  108471. * @param textureType Type of textures used when performing the post process. (default: 0)
  108472. * @param vertexUrl The url of the vertex shader to be used. (default: "postprocess")
  108473. * @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
  108474. * @param blockCompilation If the shader should not be compiled immediatly. (default: false)
  108475. * @param textureFormat Format of textures used when performing the post process. (default: TEXTUREFORMAT_RGBA)
  108476. */
  108477. 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);
  108478. /**
  108479. * Gets a string identifying the name of the class
  108480. * @returns "PostProcess" string
  108481. */
  108482. getClassName(): string;
  108483. /**
  108484. * Gets the engine which this post process belongs to.
  108485. * @returns The engine the post process was enabled with.
  108486. */
  108487. getEngine(): Engine;
  108488. /**
  108489. * The effect that is created when initializing the post process.
  108490. * @returns The created effect corresponding the the postprocess.
  108491. */
  108492. getEffect(): Effect;
  108493. /**
  108494. * To avoid multiple redundant textures for multiple post process, the output the output texture for this post process can be shared with another.
  108495. * @param postProcess The post process to share the output with.
  108496. * @returns This post process.
  108497. */
  108498. shareOutputWith(postProcess: PostProcess): PostProcess;
  108499. /**
  108500. * Reverses the effect of calling shareOutputWith and returns the post process back to its original state.
  108501. * This should be called if the post process that shares output with this post process is disabled/disposed.
  108502. */
  108503. useOwnOutput(): void;
  108504. /**
  108505. * Updates the effect with the current post process compile time values and recompiles the shader.
  108506. * @param defines Define statements that should be added at the beginning of the shader. (default: null)
  108507. * @param uniforms Set of uniform variables that will be passed to the shader. (default: null)
  108508. * @param samplers Set of Texture2D variables that will be passed to the shader. (default: null)
  108509. * @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
  108510. * @param onCompiled Called when the shader has been compiled.
  108511. * @param onError Called if there is an error when compiling a shader.
  108512. * @param vertexUrl The url of the vertex shader to be used (default: the one given at construction time)
  108513. * @param fragmentUrl The url of the fragment shader to be used (default: the one given at construction time)
  108514. */
  108515. 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;
  108516. /**
  108517. * The post process is reusable if it can be used multiple times within one frame.
  108518. * @returns If the post process is reusable
  108519. */
  108520. isReusable(): boolean;
  108521. /** invalidate frameBuffer to hint the postprocess to create a depth buffer */
  108522. markTextureDirty(): void;
  108523. /**
  108524. * Activates the post process by intializing the textures to be used when executed. Notifies onActivateObservable.
  108525. * 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.
  108526. * @param camera The camera that will be used in the post process. This camera will be used when calling onActivateObservable.
  108527. * @param sourceTexture The source texture to be inspected to get the width and height if not specified in the post process constructor. (default: null)
  108528. * @param forceDepthStencil If true, a depth and stencil buffer will be generated. (default: false)
  108529. * @returns The target texture that was bound to be written to.
  108530. */
  108531. activate(camera: Nullable<Camera>, sourceTexture?: Nullable<InternalTexture>, forceDepthStencil?: boolean): InternalTexture;
  108532. /**
  108533. * If the post process is supported.
  108534. */
  108535. get isSupported(): boolean;
  108536. /**
  108537. * The aspect ratio of the output texture.
  108538. */
  108539. get aspectRatio(): number;
  108540. /**
  108541. * Get a value indicating if the post-process is ready to be used
  108542. * @returns true if the post-process is ready (shader is compiled)
  108543. */
  108544. isReady(): boolean;
  108545. /**
  108546. * Binds all textures and uniforms to the shader, this will be run on every pass.
  108547. * @returns the effect corresponding to this post process. Null if not compiled or not ready.
  108548. */
  108549. apply(): Nullable<Effect>;
  108550. private _disposeTextures;
  108551. /**
  108552. * Sets the required values to the prepass renderer.
  108553. * @param prePassRenderer defines the prepass renderer to setup.
  108554. * @returns true if the pre pass is needed.
  108555. */
  108556. setPrePassRenderer(prePassRenderer: PrePassRenderer): boolean;
  108557. /**
  108558. * Disposes the post process.
  108559. * @param camera The camera to dispose the post process on.
  108560. */
  108561. dispose(camera?: Camera): void;
  108562. /**
  108563. * Serializes the particle system to a JSON object
  108564. * @returns the JSON object
  108565. */
  108566. serialize(): any;
  108567. /**
  108568. * Creates a material from parsed material data
  108569. * @param parsedPostProcess defines parsed post process data
  108570. * @param scene defines the hosting scene
  108571. * @param rootUrl defines the root URL to use to load textures
  108572. * @returns a new post process
  108573. */
  108574. static Parse(parsedPostProcess: any, scene: Scene, rootUrl: string): Nullable<PostProcess>;
  108575. }
  108576. }
  108577. declare module BABYLON {
  108578. /** @hidden */
  108579. export var kernelBlurVaryingDeclaration: {
  108580. name: string;
  108581. shader: string;
  108582. };
  108583. }
  108584. declare module BABYLON {
  108585. /** @hidden */
  108586. export var kernelBlurFragment: {
  108587. name: string;
  108588. shader: string;
  108589. };
  108590. }
  108591. declare module BABYLON {
  108592. /** @hidden */
  108593. export var kernelBlurFragment2: {
  108594. name: string;
  108595. shader: string;
  108596. };
  108597. }
  108598. declare module BABYLON {
  108599. /** @hidden */
  108600. export var kernelBlurPixelShader: {
  108601. name: string;
  108602. shader: string;
  108603. };
  108604. }
  108605. declare module BABYLON {
  108606. /** @hidden */
  108607. export var kernelBlurVertex: {
  108608. name: string;
  108609. shader: string;
  108610. };
  108611. }
  108612. declare module BABYLON {
  108613. /** @hidden */
  108614. export var kernelBlurVertexShader: {
  108615. name: string;
  108616. shader: string;
  108617. };
  108618. }
  108619. declare module BABYLON {
  108620. /**
  108621. * The Blur Post Process which blurs an image based on a kernel and direction.
  108622. * Can be used twice in x and y directions to perform a guassian blur in two passes.
  108623. */
  108624. export class BlurPostProcess extends PostProcess {
  108625. private blockCompilation;
  108626. protected _kernel: number;
  108627. protected _idealKernel: number;
  108628. protected _packedFloat: boolean;
  108629. private _staticDefines;
  108630. /** The direction in which to blur the image. */
  108631. direction: Vector2;
  108632. /**
  108633. * Sets the length in pixels of the blur sample region
  108634. */
  108635. set kernel(v: number);
  108636. /**
  108637. * Gets the length in pixels of the blur sample region
  108638. */
  108639. get kernel(): number;
  108640. /**
  108641. * Sets wether or not the blur needs to unpack/repack floats
  108642. */
  108643. set packedFloat(v: boolean);
  108644. /**
  108645. * Gets wether or not the blur is unpacking/repacking floats
  108646. */
  108647. get packedFloat(): boolean;
  108648. /**
  108649. * Gets a string identifying the name of the class
  108650. * @returns "BlurPostProcess" string
  108651. */
  108652. getClassName(): string;
  108653. /**
  108654. * Creates a new instance BlurPostProcess
  108655. * @param name The name of the effect.
  108656. * @param direction The direction in which to blur the image.
  108657. * @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.
  108658. * @param options The required width/height ratio to downsize to before computing the render pass. (Use 1.0 for full size)
  108659. * @param camera The camera to apply the render pass to.
  108660. * @param samplingMode The sampling mode to be used when computing the pass. (default: 0)
  108661. * @param engine The engine which the post process will be applied. (default: current engine)
  108662. * @param reusable If the post process can be reused on the same frame. (default: false)
  108663. * @param textureType Type of textures used when performing the post process. (default: 0)
  108664. * @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)
  108665. */
  108666. 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);
  108667. /**
  108668. * Updates the effect with the current post process compile time values and recompiles the shader.
  108669. * @param defines Define statements that should be added at the beginning of the shader. (default: null)
  108670. * @param uniforms Set of uniform variables that will be passed to the shader. (default: null)
  108671. * @param samplers Set of Texture2D variables that will be passed to the shader. (default: null)
  108672. * @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
  108673. * @param onCompiled Called when the shader has been compiled.
  108674. * @param onError Called if there is an error when compiling a shader.
  108675. */
  108676. updateEffect(defines?: Nullable<string>, uniforms?: Nullable<string[]>, samplers?: Nullable<string[]>, indexParameters?: any, onCompiled?: (effect: Effect) => void, onError?: (effect: Effect, errors: string) => void): void;
  108677. protected _updateParameters(onCompiled?: (effect: Effect) => void, onError?: (effect: Effect, errors: string) => void): void;
  108678. /**
  108679. * Best kernels are odd numbers that when divided by 2, their integer part is even, so 5, 9 or 13.
  108680. * Other odd kernels optimize correctly but require proportionally more samples, even kernels are
  108681. * possible but will produce minor visual artifacts. Since each new kernel requires a new shader we
  108682. * want to minimize kernel changes, having gaps between physical kernels is helpful in that regard.
  108683. * The gaps between physical kernels are compensated for in the weighting of the samples
  108684. * @param idealKernel Ideal blur kernel.
  108685. * @return Nearest best kernel.
  108686. */
  108687. protected _nearestBestKernel(idealKernel: number): number;
  108688. /**
  108689. * Calculates the value of a Gaussian distribution with sigma 3 at a given point.
  108690. * @param x The point on the Gaussian distribution to sample.
  108691. * @return the value of the Gaussian function at x.
  108692. */
  108693. protected _gaussianWeight(x: number): number;
  108694. /**
  108695. * Generates a string that can be used as a floating point number in GLSL.
  108696. * @param x Value to print.
  108697. * @param decimalFigures Number of decimal places to print the number to (excluding trailing 0s).
  108698. * @return GLSL float string.
  108699. */
  108700. protected _glslFloat(x: number, decimalFigures?: number): string;
  108701. /** @hidden */
  108702. static _Parse(parsedPostProcess: any, targetCamera: Camera, scene: Scene, rootUrl: string): Nullable<BlurPostProcess>;
  108703. }
  108704. }
  108705. declare module BABYLON {
  108706. /**
  108707. * Mirror texture can be used to simulate the view from a mirror in a scene.
  108708. * It will dynamically be rendered every frame to adapt to the camera point of view.
  108709. * You can then easily use it as a reflectionTexture on a flat surface.
  108710. * In case the surface is not a plane, please consider relying on reflection probes.
  108711. * @see https://doc.babylonjs.com/how_to/reflect#mirrors
  108712. */
  108713. export class MirrorTexture extends RenderTargetTexture {
  108714. private scene;
  108715. /**
  108716. * Define the reflection plane we want to use. The mirrorPlane is usually set to the constructed reflector.
  108717. * 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.
  108718. * @see https://doc.babylonjs.com/how_to/reflect#mirrors
  108719. */
  108720. mirrorPlane: Plane;
  108721. /**
  108722. * Define the blur ratio used to blur the reflection if needed.
  108723. */
  108724. set blurRatio(value: number);
  108725. get blurRatio(): number;
  108726. /**
  108727. * Define the adaptive blur kernel used to blur the reflection if needed.
  108728. * This will autocompute the closest best match for the `blurKernel`
  108729. */
  108730. set adaptiveBlurKernel(value: number);
  108731. /**
  108732. * Define the blur kernel used to blur the reflection if needed.
  108733. * Please consider using `adaptiveBlurKernel` as it could find the closest best value for you.
  108734. */
  108735. set blurKernel(value: number);
  108736. /**
  108737. * Define the blur kernel on the X Axis used to blur the reflection if needed.
  108738. * Please consider using `adaptiveBlurKernel` as it could find the closest best value for you.
  108739. */
  108740. set blurKernelX(value: number);
  108741. get blurKernelX(): number;
  108742. /**
  108743. * Define the blur kernel on the Y Axis used to blur the reflection if needed.
  108744. * Please consider using `adaptiveBlurKernel` as it could find the closest best value for you.
  108745. */
  108746. set blurKernelY(value: number);
  108747. get blurKernelY(): number;
  108748. private _autoComputeBlurKernel;
  108749. protected _onRatioRescale(): void;
  108750. private _updateGammaSpace;
  108751. private _imageProcessingConfigChangeObserver;
  108752. private _transformMatrix;
  108753. private _mirrorMatrix;
  108754. private _savedViewMatrix;
  108755. private _blurX;
  108756. private _blurY;
  108757. private _adaptiveBlurKernel;
  108758. private _blurKernelX;
  108759. private _blurKernelY;
  108760. private _blurRatio;
  108761. /**
  108762. * Instantiates a Mirror Texture.
  108763. * Mirror texture can be used to simulate the view from a mirror in a scene.
  108764. * It will dynamically be rendered every frame to adapt to the camera point of view.
  108765. * You can then easily use it as a reflectionTexture on a flat surface.
  108766. * In case the surface is not a plane, please consider relying on reflection probes.
  108767. * @see https://doc.babylonjs.com/how_to/reflect#mirrors
  108768. * @param name
  108769. * @param size
  108770. * @param scene
  108771. * @param generateMipMaps
  108772. * @param type
  108773. * @param samplingMode
  108774. * @param generateDepthBuffer
  108775. */
  108776. constructor(name: string, size: number | {
  108777. width: number;
  108778. height: number;
  108779. } | {
  108780. ratio: number;
  108781. }, scene: Scene, generateMipMaps?: boolean, type?: number, samplingMode?: number, generateDepthBuffer?: boolean);
  108782. private _preparePostProcesses;
  108783. /**
  108784. * Clone the mirror texture.
  108785. * @returns the cloned texture
  108786. */
  108787. clone(): MirrorTexture;
  108788. /**
  108789. * Serialize the texture to a JSON representation you could use in Parse later on
  108790. * @returns the serialized JSON representation
  108791. */
  108792. serialize(): any;
  108793. /**
  108794. * Dispose the texture and release its associated resources.
  108795. */
  108796. dispose(): void;
  108797. }
  108798. }
  108799. declare module BABYLON {
  108800. /**
  108801. * This represents a texture in babylon. It can be easily loaded from a network, base64 or html input.
  108802. * @see https://doc.babylonjs.com/babylon101/materials#texture
  108803. */
  108804. export class Texture extends BaseTexture {
  108805. /**
  108806. * Gets or sets a general boolean used to indicate that textures containing direct data (buffers) must be saved as part of the serialization process
  108807. */
  108808. static SerializeBuffers: boolean;
  108809. /** @hidden */
  108810. static _CubeTextureParser: (jsonTexture: any, scene: Scene, rootUrl: string) => CubeTexture;
  108811. /** @hidden */
  108812. static _CreateMirror: (name: string, renderTargetSize: number, scene: Scene, generateMipMaps: boolean) => MirrorTexture;
  108813. /** @hidden */
  108814. static _CreateRenderTargetTexture: (name: string, renderTargetSize: number, scene: Scene, generateMipMaps: boolean) => RenderTargetTexture;
  108815. /** nearest is mag = nearest and min = nearest and mip = linear */
  108816. static readonly NEAREST_SAMPLINGMODE: number;
  108817. /** nearest is mag = nearest and min = nearest and mip = linear */
  108818. static readonly NEAREST_NEAREST_MIPLINEAR: number;
  108819. /** Bilinear is mag = linear and min = linear and mip = nearest */
  108820. static readonly BILINEAR_SAMPLINGMODE: number;
  108821. /** Bilinear is mag = linear and min = linear and mip = nearest */
  108822. static readonly LINEAR_LINEAR_MIPNEAREST: number;
  108823. /** Trilinear is mag = linear and min = linear and mip = linear */
  108824. static readonly TRILINEAR_SAMPLINGMODE: number;
  108825. /** Trilinear is mag = linear and min = linear and mip = linear */
  108826. static readonly LINEAR_LINEAR_MIPLINEAR: number;
  108827. /** mag = nearest and min = nearest and mip = nearest */
  108828. static readonly NEAREST_NEAREST_MIPNEAREST: number;
  108829. /** mag = nearest and min = linear and mip = nearest */
  108830. static readonly NEAREST_LINEAR_MIPNEAREST: number;
  108831. /** mag = nearest and min = linear and mip = linear */
  108832. static readonly NEAREST_LINEAR_MIPLINEAR: number;
  108833. /** mag = nearest and min = linear and mip = none */
  108834. static readonly NEAREST_LINEAR: number;
  108835. /** mag = nearest and min = nearest and mip = none */
  108836. static readonly NEAREST_NEAREST: number;
  108837. /** mag = linear and min = nearest and mip = nearest */
  108838. static readonly LINEAR_NEAREST_MIPNEAREST: number;
  108839. /** mag = linear and min = nearest and mip = linear */
  108840. static readonly LINEAR_NEAREST_MIPLINEAR: number;
  108841. /** mag = linear and min = linear and mip = none */
  108842. static readonly LINEAR_LINEAR: number;
  108843. /** mag = linear and min = nearest and mip = none */
  108844. static readonly LINEAR_NEAREST: number;
  108845. /** Explicit coordinates mode */
  108846. static readonly EXPLICIT_MODE: number;
  108847. /** Spherical coordinates mode */
  108848. static readonly SPHERICAL_MODE: number;
  108849. /** Planar coordinates mode */
  108850. static readonly PLANAR_MODE: number;
  108851. /** Cubic coordinates mode */
  108852. static readonly CUBIC_MODE: number;
  108853. /** Projection coordinates mode */
  108854. static readonly PROJECTION_MODE: number;
  108855. /** Inverse Cubic coordinates mode */
  108856. static readonly SKYBOX_MODE: number;
  108857. /** Inverse Cubic coordinates mode */
  108858. static readonly INVCUBIC_MODE: number;
  108859. /** Equirectangular coordinates mode */
  108860. static readonly EQUIRECTANGULAR_MODE: number;
  108861. /** Equirectangular Fixed coordinates mode */
  108862. static readonly FIXED_EQUIRECTANGULAR_MODE: number;
  108863. /** Equirectangular Fixed Mirrored coordinates mode */
  108864. static readonly FIXED_EQUIRECTANGULAR_MIRRORED_MODE: number;
  108865. /** Texture is not repeating outside of 0..1 UVs */
  108866. static readonly CLAMP_ADDRESSMODE: number;
  108867. /** Texture is repeating outside of 0..1 UVs */
  108868. static readonly WRAP_ADDRESSMODE: number;
  108869. /** Texture is repeating and mirrored */
  108870. static readonly MIRROR_ADDRESSMODE: number;
  108871. /**
  108872. * 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
  108873. */
  108874. static UseSerializedUrlIfAny: boolean;
  108875. /**
  108876. * Define the url of the texture.
  108877. */
  108878. url: Nullable<string>;
  108879. /**
  108880. * Define an offset on the texture to offset the u coordinates of the UVs
  108881. * @see https://doc.babylonjs.com/how_to/more_materials#offsetting
  108882. */
  108883. uOffset: number;
  108884. /**
  108885. * Define an offset on the texture to offset the v coordinates of the UVs
  108886. * @see https://doc.babylonjs.com/how_to/more_materials#offsetting
  108887. */
  108888. vOffset: number;
  108889. /**
  108890. * Define an offset on the texture to scale the u coordinates of the UVs
  108891. * @see https://doc.babylonjs.com/how_to/more_materials#tiling
  108892. */
  108893. uScale: number;
  108894. /**
  108895. * Define an offset on the texture to scale the v coordinates of the UVs
  108896. * @see https://doc.babylonjs.com/how_to/more_materials#tiling
  108897. */
  108898. vScale: number;
  108899. /**
  108900. * Define an offset on the texture to rotate around the u coordinates of the UVs
  108901. * @see https://doc.babylonjs.com/how_to/more_materials
  108902. */
  108903. uAng: number;
  108904. /**
  108905. * Define an offset on the texture to rotate around the v coordinates of the UVs
  108906. * @see https://doc.babylonjs.com/how_to/more_materials
  108907. */
  108908. vAng: number;
  108909. /**
  108910. * Define an offset on the texture to rotate around the w coordinates of the UVs (in case of 3d texture)
  108911. * @see https://doc.babylonjs.com/how_to/more_materials
  108912. */
  108913. wAng: number;
  108914. /**
  108915. * Defines the center of rotation (U)
  108916. */
  108917. uRotationCenter: number;
  108918. /**
  108919. * Defines the center of rotation (V)
  108920. */
  108921. vRotationCenter: number;
  108922. /**
  108923. * Defines the center of rotation (W)
  108924. */
  108925. wRotationCenter: number;
  108926. /**
  108927. * Sets this property to true to avoid deformations when rotating the texture with non-uniform scaling
  108928. */
  108929. homogeneousRotationInUVTransform: boolean;
  108930. /**
  108931. * Are mip maps generated for this texture or not.
  108932. */
  108933. get noMipmap(): boolean;
  108934. /**
  108935. * List of inspectable custom properties (used by the Inspector)
  108936. * @see https://doc.babylonjs.com/how_to/debug_layer#extensibility
  108937. */
  108938. inspectableCustomProperties: Nullable<IInspectable[]>;
  108939. private _noMipmap;
  108940. /** @hidden */
  108941. _invertY: boolean;
  108942. private _rowGenerationMatrix;
  108943. private _cachedTextureMatrix;
  108944. private _projectionModeMatrix;
  108945. private _t0;
  108946. private _t1;
  108947. private _t2;
  108948. private _cachedUOffset;
  108949. private _cachedVOffset;
  108950. private _cachedUScale;
  108951. private _cachedVScale;
  108952. private _cachedUAng;
  108953. private _cachedVAng;
  108954. private _cachedWAng;
  108955. private _cachedProjectionMatrixId;
  108956. private _cachedURotationCenter;
  108957. private _cachedVRotationCenter;
  108958. private _cachedWRotationCenter;
  108959. private _cachedHomogeneousRotationInUVTransform;
  108960. private _cachedCoordinatesMode;
  108961. /** @hidden */
  108962. protected _initialSamplingMode: number;
  108963. /** @hidden */
  108964. _buffer: Nullable<string | ArrayBuffer | ArrayBufferView | HTMLImageElement | Blob | ImageBitmap>;
  108965. private _deleteBuffer;
  108966. protected _format: Nullable<number>;
  108967. private _delayedOnLoad;
  108968. private _delayedOnError;
  108969. private _mimeType?;
  108970. /** Returns the texture mime type if it was defined by a loader (undefined else) */
  108971. get mimeType(): string | undefined;
  108972. /**
  108973. * Observable triggered once the texture has been loaded.
  108974. */
  108975. onLoadObservable: Observable<Texture>;
  108976. protected _isBlocking: boolean;
  108977. /**
  108978. * Is the texture preventing material to render while loading.
  108979. * If false, a default texture will be used instead of the loading one during the preparation step.
  108980. */
  108981. set isBlocking(value: boolean);
  108982. get isBlocking(): boolean;
  108983. /**
  108984. * Get the current sampling mode associated with the texture.
  108985. */
  108986. get samplingMode(): number;
  108987. /**
  108988. * Gets a boolean indicating if the texture needs to be inverted on the y axis during loading
  108989. */
  108990. get invertY(): boolean;
  108991. /**
  108992. * Instantiates a new texture.
  108993. * This represents a texture in babylon. It can be easily loaded from a network, base64 or html input.
  108994. * @see https://doc.babylonjs.com/babylon101/materials#texture
  108995. * @param url defines the url of the picture to load as a texture
  108996. * @param sceneOrEngine defines the scene or engine the texture will belong to
  108997. * @param noMipmap defines if the texture will require mip maps or not
  108998. * @param invertY defines if the texture needs to be inverted on the y axis during loading
  108999. * @param samplingMode defines the sampling mode we want for the texture while fectching from it (Texture.NEAREST_SAMPLINGMODE...)
  109000. * @param onLoad defines a callback triggered when the texture has been loaded
  109001. * @param onError defines a callback triggered when an error occurred during the loading session
  109002. * @param buffer defines the buffer to load the texture from in case the texture is loaded from a buffer representation
  109003. * @param deleteBuffer defines if the buffer we are loading the texture from should be deleted after load
  109004. * @param format defines the format of the texture we are trying to load (Engine.TEXTUREFORMAT_RGBA...)
  109005. * @param mimeType defines an optional mime type information
  109006. */
  109007. 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);
  109008. /**
  109009. * Update the url (and optional buffer) of this texture if url was null during construction.
  109010. * @param url the url of the texture
  109011. * @param buffer the buffer of the texture (defaults to null)
  109012. * @param onLoad callback called when the texture is loaded (defaults to null)
  109013. */
  109014. updateURL(url: string, buffer?: Nullable<string | ArrayBuffer | ArrayBufferView | HTMLImageElement | Blob>, onLoad?: () => void): void;
  109015. /**
  109016. * Finish the loading sequence of a texture flagged as delayed load.
  109017. * @hidden
  109018. */
  109019. delayLoad(): void;
  109020. private _prepareRowForTextureGeneration;
  109021. /**
  109022. * Checks if the texture has the same transform matrix than another texture
  109023. * @param texture texture to check against
  109024. * @returns true if the transforms are the same, else false
  109025. */
  109026. checkTransformsAreIdentical(texture: Nullable<Texture>): boolean;
  109027. /**
  109028. * Get the current texture matrix which includes the requested offsetting, tiling and rotation components.
  109029. * @returns the transform matrix of the texture.
  109030. */
  109031. getTextureMatrix(uBase?: number): Matrix;
  109032. /**
  109033. * Get the current matrix used to apply reflection. This is useful to rotate an environment texture for instance.
  109034. * @returns The reflection texture transform
  109035. */
  109036. getReflectionTextureMatrix(): Matrix;
  109037. /**
  109038. * Clones the texture.
  109039. * @returns the cloned texture
  109040. */
  109041. clone(): Texture;
  109042. /**
  109043. * Serialize the texture to a JSON representation we can easily use in the resepective Parse function.
  109044. * @returns The JSON representation of the texture
  109045. */
  109046. serialize(): any;
  109047. /**
  109048. * Get the current class name of the texture useful for serialization or dynamic coding.
  109049. * @returns "Texture"
  109050. */
  109051. getClassName(): string;
  109052. /**
  109053. * Dispose the texture and release its associated resources.
  109054. */
  109055. dispose(): void;
  109056. /**
  109057. * Parse the JSON representation of a texture in order to recreate the texture in the given scene.
  109058. * @param parsedTexture Define the JSON representation of the texture
  109059. * @param scene Define the scene the parsed texture should be instantiated in
  109060. * @param rootUrl Define the root url of the parsing sequence in the case of relative dependencies
  109061. * @returns The parsed texture if successful
  109062. */
  109063. static Parse(parsedTexture: any, scene: Scene, rootUrl: string): Nullable<BaseTexture>;
  109064. /**
  109065. * Creates a texture from its base 64 representation.
  109066. * @param data Define the base64 payload without the data: prefix
  109067. * @param name Define the name of the texture in the scene useful fo caching purpose for instance
  109068. * @param scene Define the scene the texture should belong to
  109069. * @param noMipmap Forces the texture to not create mip map information if true
  109070. * @param invertY define if the texture needs to be inverted on the y axis during loading
  109071. * @param samplingMode define the sampling mode we want for the texture while fectching from it (Texture.NEAREST_SAMPLINGMODE...)
  109072. * @param onLoad define a callback triggered when the texture has been loaded
  109073. * @param onError define a callback triggered when an error occurred during the loading session
  109074. * @param format define the format of the texture we are trying to load (Engine.TEXTUREFORMAT_RGBA...)
  109075. * @returns the created texture
  109076. */
  109077. static CreateFromBase64String(data: string, name: string, scene: Scene, noMipmap?: boolean, invertY?: boolean, samplingMode?: number, onLoad?: Nullable<() => void>, onError?: Nullable<() => void>, format?: number): Texture;
  109078. /**
  109079. * Creates a texture from its data: representation. (data: will be added in case only the payload has been passed in)
  109080. * @param data Define the base64 payload without the data: prefix
  109081. * @param name Define the name of the texture in the scene useful fo caching purpose for instance
  109082. * @param buffer define the buffer to load the texture from in case the texture is loaded from a buffer representation
  109083. * @param scene Define the scene the texture should belong to
  109084. * @param deleteBuffer define if the buffer we are loading the texture from should be deleted after load
  109085. * @param noMipmap Forces the texture to not create mip map information if true
  109086. * @param invertY define if the texture needs to be inverted on the y axis during loading
  109087. * @param samplingMode define the sampling mode we want for the texture while fectching from it (Texture.NEAREST_SAMPLINGMODE...)
  109088. * @param onLoad define a callback triggered when the texture has been loaded
  109089. * @param onError define a callback triggered when an error occurred during the loading session
  109090. * @param format define the format of the texture we are trying to load (Engine.TEXTUREFORMAT_RGBA...)
  109091. * @returns the created texture
  109092. */
  109093. 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;
  109094. }
  109095. }
  109096. declare module BABYLON {
  109097. /**
  109098. * PostProcessManager is used to manage one or more post processes or post process pipelines
  109099. * See https://doc.babylonjs.com/how_to/how_to_use_postprocesses
  109100. */
  109101. export class PostProcessManager {
  109102. private _scene;
  109103. private _indexBuffer;
  109104. private _vertexBuffers;
  109105. /**
  109106. * Creates a new instance PostProcess
  109107. * @param scene The scene that the post process is associated with.
  109108. */
  109109. constructor(scene: Scene);
  109110. private _prepareBuffers;
  109111. private _buildIndexBuffer;
  109112. /**
  109113. * Rebuilds the vertex buffers of the manager.
  109114. * @hidden
  109115. */
  109116. _rebuild(): void;
  109117. /**
  109118. * Prepares a frame to be run through a post process.
  109119. * @param sourceTexture The input texture to the post procesess. (default: null)
  109120. * @param postProcesses An array of post processes to be run. (default: null)
  109121. * @returns True if the post processes were able to be run.
  109122. * @hidden
  109123. */
  109124. _prepareFrame(sourceTexture?: Nullable<InternalTexture>, postProcesses?: Nullable<PostProcess[]>): boolean;
  109125. /**
  109126. * Manually render a set of post processes to a texture.
  109127. * Please note, the frame buffer won't be unbound after the call in case you have more render to do.
  109128. * @param postProcesses An array of post processes to be run.
  109129. * @param targetTexture The target texture to render to.
  109130. * @param forceFullscreenViewport force gl.viewport to be full screen eg. 0,0,textureWidth,textureHeight
  109131. * @param faceIndex defines the face to render to if a cubemap is defined as the target
  109132. * @param lodLevel defines which lod of the texture to render to
  109133. * @param doNotBindFrambuffer If set to true, assumes that the framebuffer has been bound previously
  109134. */
  109135. directRender(postProcesses: PostProcess[], targetTexture?: Nullable<InternalTexture>, forceFullscreenViewport?: boolean, faceIndex?: number, lodLevel?: number, doNotBindFrambuffer?: boolean): void;
  109136. /**
  109137. * Finalize the result of the output of the postprocesses.
  109138. * @param doNotPresent If true the result will not be displayed to the screen.
  109139. * @param targetTexture The target texture to render to.
  109140. * @param faceIndex The index of the face to bind the target texture to.
  109141. * @param postProcesses The array of post processes to render.
  109142. * @param forceFullscreenViewport force gl.viewport to be full screen eg. 0,0,textureWidth,textureHeight (default: false)
  109143. * @hidden
  109144. */
  109145. _finalizeFrame(doNotPresent?: boolean, targetTexture?: InternalTexture, faceIndex?: number, postProcesses?: Array<PostProcess>, forceFullscreenViewport?: boolean): void;
  109146. /**
  109147. * Disposes of the post process manager.
  109148. */
  109149. dispose(): void;
  109150. }
  109151. }
  109152. declare module BABYLON {
  109153. /**
  109154. * This Helps creating a texture that will be created from a camera in your scene.
  109155. * It is basically a dynamic texture that could be used to create special effects for instance.
  109156. * Actually, It is the base of lot of effects in the framework like post process, shadows, effect layers and rendering pipelines...
  109157. */
  109158. export class RenderTargetTexture extends Texture {
  109159. /**
  109160. * The texture will only be rendered once which can be useful to improve performance if everything in your render is static for instance.
  109161. */
  109162. static readonly REFRESHRATE_RENDER_ONCE: number;
  109163. /**
  109164. * The texture will only be rendered rendered every frame and is recomended for dynamic contents.
  109165. */
  109166. static readonly REFRESHRATE_RENDER_ONEVERYFRAME: number;
  109167. /**
  109168. * The texture will be rendered every 2 frames which could be enough if your dynamic objects are not
  109169. * the central point of your effect and can save a lot of performances.
  109170. */
  109171. static readonly REFRESHRATE_RENDER_ONEVERYTWOFRAMES: number;
  109172. /**
  109173. * Use this predicate to dynamically define the list of mesh you want to render.
  109174. * If set, the renderList property will be overwritten.
  109175. */
  109176. renderListPredicate: (AbstractMesh: AbstractMesh) => boolean;
  109177. private _renderList;
  109178. /**
  109179. * Use this list to define the list of mesh you want to render.
  109180. */
  109181. get renderList(): Nullable<Array<AbstractMesh>>;
  109182. set renderList(value: Nullable<Array<AbstractMesh>>);
  109183. /**
  109184. * Use this function to overload the renderList array at rendering time.
  109185. * Return null to render with the curent renderList, else return the list of meshes to use for rendering.
  109186. * For 2DArray RTT, layerOrFace is the index of the layer that is going to be rendered, else it is the faceIndex of
  109187. * the cube (if the RTT is a cube, else layerOrFace=0).
  109188. * The renderList passed to the function is the current render list (the one that will be used if the function returns null).
  109189. * The length of this list is passed through renderListLength: don't use renderList.length directly because the array can
  109190. * hold dummy elements!
  109191. */
  109192. getCustomRenderList: (layerOrFace: number, renderList: Nullable<Immutable<Array<AbstractMesh>>>, renderListLength: number) => Nullable<Array<AbstractMesh>>;
  109193. private _hookArray;
  109194. /**
  109195. * Define if particles should be rendered in your texture.
  109196. */
  109197. renderParticles: boolean;
  109198. /**
  109199. * Define if sprites should be rendered in your texture.
  109200. */
  109201. renderSprites: boolean;
  109202. /**
  109203. * Define the camera used to render the texture.
  109204. */
  109205. activeCamera: Nullable<Camera>;
  109206. /**
  109207. * Override the mesh isReady function with your own one.
  109208. */
  109209. customIsReadyFunction: (mesh: AbstractMesh, refreshRate: number) => boolean;
  109210. /**
  109211. * Override the render function of the texture with your own one.
  109212. */
  109213. customRenderFunction: (opaqueSubMeshes: SmartArray<SubMesh>, alphaTestSubMeshes: SmartArray<SubMesh>, transparentSubMeshes: SmartArray<SubMesh>, depthOnlySubMeshes: SmartArray<SubMesh>, beforeTransparents?: () => void) => void;
  109214. /**
  109215. * Define if camera post processes should be use while rendering the texture.
  109216. */
  109217. useCameraPostProcesses: boolean;
  109218. /**
  109219. * Define if the camera viewport should be respected while rendering the texture or if the render should be done to the entire texture.
  109220. */
  109221. ignoreCameraViewport: boolean;
  109222. private _postProcessManager;
  109223. private _postProcesses;
  109224. private _resizeObserver;
  109225. /**
  109226. * An event triggered when the texture is unbind.
  109227. */
  109228. onBeforeBindObservable: Observable<RenderTargetTexture>;
  109229. /**
  109230. * An event triggered when the texture is unbind.
  109231. */
  109232. onAfterUnbindObservable: Observable<RenderTargetTexture>;
  109233. private _onAfterUnbindObserver;
  109234. /**
  109235. * Set a after unbind callback in the texture.
  109236. * This has been kept for backward compatibility and use of onAfterUnbindObservable is recommended.
  109237. */
  109238. set onAfterUnbind(callback: () => void);
  109239. /**
  109240. * An event triggered before rendering the texture
  109241. */
  109242. onBeforeRenderObservable: Observable<number>;
  109243. private _onBeforeRenderObserver;
  109244. /**
  109245. * Set a before render callback in the texture.
  109246. * This has been kept for backward compatibility and use of onBeforeRenderObservable is recommended.
  109247. */
  109248. set onBeforeRender(callback: (faceIndex: number) => void);
  109249. /**
  109250. * An event triggered after rendering the texture
  109251. */
  109252. onAfterRenderObservable: Observable<number>;
  109253. private _onAfterRenderObserver;
  109254. /**
  109255. * Set a after render callback in the texture.
  109256. * This has been kept for backward compatibility and use of onAfterRenderObservable is recommended.
  109257. */
  109258. set onAfterRender(callback: (faceIndex: number) => void);
  109259. /**
  109260. * An event triggered after the texture clear
  109261. */
  109262. onClearObservable: Observable<Engine>;
  109263. private _onClearObserver;
  109264. /**
  109265. * Set a clear callback in the texture.
  109266. * This has been kept for backward compatibility and use of onClearObservable is recommended.
  109267. */
  109268. set onClear(callback: (Engine: Engine) => void);
  109269. /**
  109270. * An event triggered when the texture is resized.
  109271. */
  109272. onResizeObservable: Observable<RenderTargetTexture>;
  109273. /**
  109274. * Define the clear color of the Render Target if it should be different from the scene.
  109275. */
  109276. clearColor: Color4;
  109277. protected _size: number | {
  109278. width: number;
  109279. height: number;
  109280. layers?: number;
  109281. };
  109282. protected _initialSizeParameter: number | {
  109283. width: number;
  109284. height: number;
  109285. } | {
  109286. ratio: number;
  109287. };
  109288. protected _sizeRatio: Nullable<number>;
  109289. /** @hidden */
  109290. _generateMipMaps: boolean;
  109291. protected _renderingManager: RenderingManager;
  109292. /** @hidden */
  109293. _waitingRenderList?: string[];
  109294. protected _doNotChangeAspectRatio: boolean;
  109295. protected _currentRefreshId: number;
  109296. protected _refreshRate: number;
  109297. protected _textureMatrix: Matrix;
  109298. protected _samples: number;
  109299. protected _renderTargetOptions: RenderTargetCreationOptions;
  109300. /**
  109301. * Gets render target creation options that were used.
  109302. */
  109303. get renderTargetOptions(): RenderTargetCreationOptions;
  109304. protected _onRatioRescale(): void;
  109305. /**
  109306. * Gets or sets the center of the bounding box associated with the texture (when in cube mode)
  109307. * It must define where the camera used to render the texture is set
  109308. */
  109309. boundingBoxPosition: Vector3;
  109310. private _boundingBoxSize;
  109311. /**
  109312. * Gets or sets the size of the bounding box associated with the texture (when in cube mode)
  109313. * When defined, the cubemap will switch to local mode
  109314. * @see https://community.arm.com/graphics/b/blog/posts/reflections-based-on-local-cubemaps-in-unity
  109315. * @example https://www.babylonjs-playground.com/#RNASML
  109316. */
  109317. set boundingBoxSize(value: Vector3);
  109318. get boundingBoxSize(): Vector3;
  109319. /**
  109320. * In case the RTT has been created with a depth texture, get the associated
  109321. * depth texture.
  109322. * Otherwise, return null.
  109323. */
  109324. get depthStencilTexture(): Nullable<InternalTexture>;
  109325. /**
  109326. * Instantiate a render target texture. This is mainly used to render of screen the scene to for instance apply post processse
  109327. * or used a shadow, depth texture...
  109328. * @param name The friendly name of the texture
  109329. * @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)
  109330. * @param scene The scene the RTT belongs to. The latest created scene will be used if not precised.
  109331. * @param generateMipMaps True if mip maps need to be generated after render.
  109332. * @param doNotChangeAspectRatio True to not change the aspect ratio of the scene in the RTT
  109333. * @param type The type of the buffer in the RTT (int, half float, float...)
  109334. * @param isCube True if a cube texture needs to be created
  109335. * @param samplingMode The sampling mode to be usedwith the render target (Linear, Nearest...)
  109336. * @param generateDepthBuffer True to generate a depth buffer
  109337. * @param generateStencilBuffer True to generate a stencil buffer
  109338. * @param isMulti True if multiple textures need to be created (Draw Buffers)
  109339. * @param format The internal format of the buffer in the RTT (RED, RG, RGB, RGBA, ALPHA...)
  109340. * @param delayAllocation if the texture allocation should be delayed (default: false)
  109341. */
  109342. constructor(name: string, size: number | {
  109343. width: number;
  109344. height: number;
  109345. layers?: number;
  109346. } | {
  109347. ratio: number;
  109348. }, scene: Nullable<Scene>, generateMipMaps?: boolean, doNotChangeAspectRatio?: boolean, type?: number, isCube?: boolean, samplingMode?: number, generateDepthBuffer?: boolean, generateStencilBuffer?: boolean, isMulti?: boolean, format?: number, delayAllocation?: boolean);
  109349. /**
  109350. * Creates a depth stencil texture.
  109351. * This is only available in WebGL 2 or with the depth texture extension available.
  109352. * @param comparisonFunction Specifies the comparison function to set on the texture. If 0 or undefined, the texture is not in comparison mode
  109353. * @param bilinearFiltering Specifies whether or not bilinear filtering is enable on the texture
  109354. * @param generateStencil Specifies whether or not a stencil should be allocated in the texture
  109355. */
  109356. createDepthStencilTexture(comparisonFunction?: number, bilinearFiltering?: boolean, generateStencil?: boolean): void;
  109357. private _processSizeParameter;
  109358. /**
  109359. * Define the number of samples to use in case of MSAA.
  109360. * It defaults to one meaning no MSAA has been enabled.
  109361. */
  109362. get samples(): number;
  109363. set samples(value: number);
  109364. /**
  109365. * Resets the refresh counter of the texture and start bak from scratch.
  109366. * Could be useful to regenerate the texture if it is setup to render only once.
  109367. */
  109368. resetRefreshCounter(): void;
  109369. /**
  109370. * Define the refresh rate of the texture or the rendering frequency.
  109371. * Use 0 to render just once, 1 to render on every frame, 2 to render every two frames and so on...
  109372. */
  109373. get refreshRate(): number;
  109374. set refreshRate(value: number);
  109375. /**
  109376. * Adds a post process to the render target rendering passes.
  109377. * @param postProcess define the post process to add
  109378. */
  109379. addPostProcess(postProcess: PostProcess): void;
  109380. /**
  109381. * Clear all the post processes attached to the render target
  109382. * @param dispose define if the cleared post processesshould also be disposed (false by default)
  109383. */
  109384. clearPostProcesses(dispose?: boolean): void;
  109385. /**
  109386. * Remove one of the post process from the list of attached post processes to the texture
  109387. * @param postProcess define the post process to remove from the list
  109388. */
  109389. removePostProcess(postProcess: PostProcess): void;
  109390. /** @hidden */
  109391. _shouldRender(): boolean;
  109392. /**
  109393. * Gets the actual render size of the texture.
  109394. * @returns the width of the render size
  109395. */
  109396. getRenderSize(): number;
  109397. /**
  109398. * Gets the actual render width of the texture.
  109399. * @returns the width of the render size
  109400. */
  109401. getRenderWidth(): number;
  109402. /**
  109403. * Gets the actual render height of the texture.
  109404. * @returns the height of the render size
  109405. */
  109406. getRenderHeight(): number;
  109407. /**
  109408. * Gets the actual number of layers of the texture.
  109409. * @returns the number of layers
  109410. */
  109411. getRenderLayers(): number;
  109412. /**
  109413. * Get if the texture can be rescaled or not.
  109414. */
  109415. get canRescale(): boolean;
  109416. /**
  109417. * Resize the texture using a ratio.
  109418. * @param ratio the ratio to apply to the texture size in order to compute the new target size
  109419. */
  109420. scale(ratio: number): void;
  109421. /**
  109422. * Get the texture reflection matrix used to rotate/transform the reflection.
  109423. * @returns the reflection matrix
  109424. */
  109425. getReflectionTextureMatrix(): Matrix;
  109426. /**
  109427. * Resize the texture to a new desired size.
  109428. * Be carrefull as it will recreate all the data in the new texture.
  109429. * @param size Define the new size. It can be:
  109430. * - a number for squared texture,
  109431. * - an object containing { width: number, height: number }
  109432. * - or an object containing a ratio { ratio: number }
  109433. */
  109434. resize(size: number | {
  109435. width: number;
  109436. height: number;
  109437. } | {
  109438. ratio: number;
  109439. }): void;
  109440. private _defaultRenderListPrepared;
  109441. /**
  109442. * Renders all the objects from the render list into the texture.
  109443. * @param useCameraPostProcess Define if camera post processes should be used during the rendering
  109444. * @param dumpForDebug Define if the rendering result should be dumped (copied) for debugging purpose
  109445. */
  109446. render(useCameraPostProcess?: boolean, dumpForDebug?: boolean): void;
  109447. private _bestReflectionRenderTargetDimension;
  109448. private _prepareRenderingManager;
  109449. /**
  109450. * @hidden
  109451. * @param faceIndex face index to bind to if this is a cubetexture
  109452. * @param layer defines the index of the texture to bind in the array
  109453. */
  109454. _bindFrameBuffer(faceIndex?: number, layer?: number): void;
  109455. protected unbindFrameBuffer(engine: Engine, faceIndex: number): void;
  109456. private renderToTarget;
  109457. /**
  109458. * Overrides the default sort function applied in the renderging group to prepare the meshes.
  109459. * This allowed control for front to back rendering or reversly depending of the special needs.
  109460. *
  109461. * @param renderingGroupId The rendering group id corresponding to its index
  109462. * @param opaqueSortCompareFn The opaque queue comparison function use to sort.
  109463. * @param alphaTestSortCompareFn The alpha test queue comparison function use to sort.
  109464. * @param transparentSortCompareFn The transparent queue comparison function use to sort.
  109465. */
  109466. 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;
  109467. /**
  109468. * Specifies whether or not the stencil and depth buffer are cleared between two rendering groups.
  109469. *
  109470. * @param renderingGroupId The rendering group id corresponding to its index
  109471. * @param autoClearDepthStencil Automatically clears depth and stencil between groups if true.
  109472. */
  109473. setRenderingAutoClearDepthStencil(renderingGroupId: number, autoClearDepthStencil: boolean): void;
  109474. /**
  109475. * Clones the texture.
  109476. * @returns the cloned texture
  109477. */
  109478. clone(): RenderTargetTexture;
  109479. /**
  109480. * Serialize the texture to a JSON representation we can easily use in the resepective Parse function.
  109481. * @returns The JSON representation of the texture
  109482. */
  109483. serialize(): any;
  109484. /**
  109485. * This will remove the attached framebuffer objects. The texture will not be able to be used as render target anymore
  109486. */
  109487. disposeFramebufferObjects(): void;
  109488. /**
  109489. * Dispose the texture and release its associated resources.
  109490. */
  109491. dispose(): void;
  109492. /** @hidden */
  109493. _rebuild(): void;
  109494. /**
  109495. * Clear the info related to rendering groups preventing retention point in material dispose.
  109496. */
  109497. freeRenderingGroups(): void;
  109498. /**
  109499. * Gets the number of views the corresponding to the texture (eg. a MultiviewRenderTarget will have > 1)
  109500. * @returns the view count
  109501. */
  109502. getViewCount(): number;
  109503. }
  109504. }
  109505. declare module BABYLON {
  109506. /**
  109507. * Class used to manipulate GUIDs
  109508. */
  109509. export class GUID {
  109510. /**
  109511. * Implementation from http://stackoverflow.com/questions/105034/how-to-create-a-guid-uuid-in-javascript/2117523#answer-2117523
  109512. * Be aware Math.random() could cause collisions, but:
  109513. * "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"
  109514. * @returns a pseudo random id
  109515. */
  109516. static RandomId(): string;
  109517. }
  109518. }
  109519. declare module BABYLON {
  109520. /**
  109521. * Options to be used when creating a shadow depth material
  109522. */
  109523. export interface IIOptionShadowDepthMaterial {
  109524. /** Variables in the vertex shader code that need to have their names remapped.
  109525. * The format is: ["var_name", "var_remapped_name", "var_name", "var_remapped_name", ...]
  109526. * "var_name" should be either: worldPos or vNormalW
  109527. * So, if the variable holding the world position in your vertex shader is not named worldPos, you must tell the system
  109528. * the name to use instead by using: ["worldPos", "myWorldPosVar"] assuming the variable is named myWorldPosVar in your code.
  109529. * If the normal must also be remapped: ["worldPos", "myWorldPosVar", "vNormalW", "myWorldNormal"]
  109530. */
  109531. remappedVariables?: string[];
  109532. /** Set standalone to true if the base material wrapped by ShadowDepthMaterial is not used for a regular object but for depth shadow generation only */
  109533. standalone?: boolean;
  109534. }
  109535. /**
  109536. * Class that can be used to wrap a base material to generate accurate shadows when using custom vertex/fragment code in the base material
  109537. */
  109538. export class ShadowDepthWrapper {
  109539. private _scene;
  109540. private _options?;
  109541. private _baseMaterial;
  109542. private _onEffectCreatedObserver;
  109543. private _subMeshToEffect;
  109544. private _subMeshToDepthEffect;
  109545. private _meshes;
  109546. /** @hidden */
  109547. _matriceNames: any;
  109548. /** Gets the standalone status of the wrapper */
  109549. get standalone(): boolean;
  109550. /** Gets the base material the wrapper is built upon */
  109551. get baseMaterial(): Material;
  109552. /**
  109553. * Instantiate a new shadow depth wrapper.
  109554. * It works by injecting some specific code in the vertex/fragment shaders of the base material and is used by a shadow generator to
  109555. * generate the shadow depth map. For more information, please refer to the documentation:
  109556. * https://doc.babylonjs.com/babylon101/shadows
  109557. * @param baseMaterial Material to wrap
  109558. * @param scene Define the scene the material belongs to
  109559. * @param options Options used to create the wrapper
  109560. */
  109561. constructor(baseMaterial: Material, scene: Scene, options?: IIOptionShadowDepthMaterial);
  109562. /**
  109563. * Gets the effect to use to generate the depth map
  109564. * @param subMesh subMesh to get the effect for
  109565. * @param shadowGenerator shadow generator to get the effect for
  109566. * @returns the effect to use to generate the depth map for the subMesh + shadow generator specified
  109567. */
  109568. getEffect(subMesh: Nullable<SubMesh>, shadowGenerator: ShadowGenerator): Nullable<Effect>;
  109569. /**
  109570. * Specifies that the submesh is ready to be used for depth rendering
  109571. * @param subMesh submesh to check
  109572. * @param defines the list of defines to take into account when checking the effect
  109573. * @param shadowGenerator combined with subMesh, it defines the effect to check
  109574. * @param useInstances specifies that instances should be used
  109575. * @returns a boolean indicating that the submesh is ready or not
  109576. */
  109577. isReadyForSubMesh(subMesh: SubMesh, defines: string[], shadowGenerator: ShadowGenerator, useInstances: boolean): boolean;
  109578. /**
  109579. * Disposes the resources
  109580. */
  109581. dispose(): void;
  109582. private _makeEffect;
  109583. }
  109584. }
  109585. declare module BABYLON {
  109586. /**
  109587. * Options for compiling materials.
  109588. */
  109589. export interface IMaterialCompilationOptions {
  109590. /**
  109591. * Defines whether clip planes are enabled.
  109592. */
  109593. clipPlane: boolean;
  109594. /**
  109595. * Defines whether instances are enabled.
  109596. */
  109597. useInstances: boolean;
  109598. }
  109599. /**
  109600. * Options passed when calling customShaderNameResolve
  109601. */
  109602. export interface ICustomShaderNameResolveOptions {
  109603. /**
  109604. * 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
  109605. */
  109606. processFinalCode?: Nullable<(shaderType: string, code: string) => string>;
  109607. }
  109608. /**
  109609. * Base class for the main features of a material in Babylon.js
  109610. */
  109611. export class Material implements IAnimatable {
  109612. /**
  109613. * Returns the triangle fill mode
  109614. */
  109615. static readonly TriangleFillMode: number;
  109616. /**
  109617. * Returns the wireframe mode
  109618. */
  109619. static readonly WireFrameFillMode: number;
  109620. /**
  109621. * Returns the point fill mode
  109622. */
  109623. static readonly PointFillMode: number;
  109624. /**
  109625. * Returns the point list draw mode
  109626. */
  109627. static readonly PointListDrawMode: number;
  109628. /**
  109629. * Returns the line list draw mode
  109630. */
  109631. static readonly LineListDrawMode: number;
  109632. /**
  109633. * Returns the line loop draw mode
  109634. */
  109635. static readonly LineLoopDrawMode: number;
  109636. /**
  109637. * Returns the line strip draw mode
  109638. */
  109639. static readonly LineStripDrawMode: number;
  109640. /**
  109641. * Returns the triangle strip draw mode
  109642. */
  109643. static readonly TriangleStripDrawMode: number;
  109644. /**
  109645. * Returns the triangle fan draw mode
  109646. */
  109647. static readonly TriangleFanDrawMode: number;
  109648. /**
  109649. * Stores the clock-wise side orientation
  109650. */
  109651. static readonly ClockWiseSideOrientation: number;
  109652. /**
  109653. * Stores the counter clock-wise side orientation
  109654. */
  109655. static readonly CounterClockWiseSideOrientation: number;
  109656. /**
  109657. * The dirty texture flag value
  109658. */
  109659. static readonly TextureDirtyFlag: number;
  109660. /**
  109661. * The dirty light flag value
  109662. */
  109663. static readonly LightDirtyFlag: number;
  109664. /**
  109665. * The dirty fresnel flag value
  109666. */
  109667. static readonly FresnelDirtyFlag: number;
  109668. /**
  109669. * The dirty attribute flag value
  109670. */
  109671. static readonly AttributesDirtyFlag: number;
  109672. /**
  109673. * The dirty misc flag value
  109674. */
  109675. static readonly MiscDirtyFlag: number;
  109676. /**
  109677. * The dirty prepass flag value
  109678. */
  109679. static readonly PrePassDirtyFlag: number;
  109680. /**
  109681. * The all dirty flag value
  109682. */
  109683. static readonly AllDirtyFlag: number;
  109684. /**
  109685. * MaterialTransparencyMode: No transparency mode, Alpha channel is not use.
  109686. */
  109687. static readonly MATERIAL_OPAQUE: number;
  109688. /**
  109689. * MaterialTransparencyMode: Alpha Test mode, pixel are discarded below a certain threshold defined by the alpha cutoff value.
  109690. */
  109691. static readonly MATERIAL_ALPHATEST: number;
  109692. /**
  109693. * MaterialTransparencyMode: Pixels are blended (according to the alpha mode) with the already drawn pixels in the current frame buffer.
  109694. */
  109695. static readonly MATERIAL_ALPHABLEND: number;
  109696. /**
  109697. * MaterialTransparencyMode: Pixels are blended (according to the alpha mode) with the already drawn pixels in the current frame buffer.
  109698. * They are also discarded below the alpha cutoff threshold to improve performances.
  109699. */
  109700. static readonly MATERIAL_ALPHATESTANDBLEND: number;
  109701. /**
  109702. * The Whiteout method is used to blend normals.
  109703. * Details of the algorithm can be found here: https://blog.selfshadow.com/publications/blending-in-detail/
  109704. */
  109705. static readonly MATERIAL_NORMALBLENDMETHOD_WHITEOUT: number;
  109706. /**
  109707. * The Reoriented Normal Mapping method is used to blend normals.
  109708. * Details of the algorithm can be found here: https://blog.selfshadow.com/publications/blending-in-detail/
  109709. */
  109710. static readonly MATERIAL_NORMALBLENDMETHOD_RNM: number;
  109711. /**
  109712. * Custom callback helping to override the default shader used in the material.
  109713. */
  109714. customShaderNameResolve: (shaderName: string, uniforms: string[], uniformBuffers: string[], samplers: string[], defines: MaterialDefines | string[], attributes?: string[], options?: ICustomShaderNameResolveOptions) => string;
  109715. /**
  109716. * Custom shadow depth material to use for shadow rendering instead of the in-built one
  109717. */
  109718. shadowDepthWrapper: Nullable<ShadowDepthWrapper>;
  109719. /**
  109720. * Gets or sets a boolean indicating that the material is allowed (if supported) to do shader hot swapping.
  109721. * This means that the material can keep using a previous shader while a new one is being compiled.
  109722. * This is mostly used when shader parallel compilation is supported (true by default)
  109723. */
  109724. allowShaderHotSwapping: boolean;
  109725. /**
  109726. * The ID of the material
  109727. */
  109728. id: string;
  109729. /**
  109730. * Gets or sets the unique id of the material
  109731. */
  109732. uniqueId: number;
  109733. /**
  109734. * The name of the material
  109735. */
  109736. name: string;
  109737. /**
  109738. * Gets or sets user defined metadata
  109739. */
  109740. metadata: any;
  109741. /**
  109742. * For internal use only. Please do not use.
  109743. */
  109744. reservedDataStore: any;
  109745. /**
  109746. * Specifies if the ready state should be checked on each call
  109747. */
  109748. checkReadyOnEveryCall: boolean;
  109749. /**
  109750. * Specifies if the ready state should be checked once
  109751. */
  109752. checkReadyOnlyOnce: boolean;
  109753. /**
  109754. * The state of the material
  109755. */
  109756. state: string;
  109757. /**
  109758. * If the material can be rendered to several textures with MRT extension
  109759. */
  109760. get canRenderToMRT(): boolean;
  109761. /**
  109762. * The alpha value of the material
  109763. */
  109764. protected _alpha: number;
  109765. /**
  109766. * List of inspectable custom properties (used by the Inspector)
  109767. * @see https://doc.babylonjs.com/how_to/debug_layer#extensibility
  109768. */
  109769. inspectableCustomProperties: IInspectable[];
  109770. /**
  109771. * Sets the alpha value of the material
  109772. */
  109773. set alpha(value: number);
  109774. /**
  109775. * Gets the alpha value of the material
  109776. */
  109777. get alpha(): number;
  109778. /**
  109779. * Specifies if back face culling is enabled
  109780. */
  109781. protected _backFaceCulling: boolean;
  109782. /**
  109783. * Sets the back-face culling state
  109784. */
  109785. set backFaceCulling(value: boolean);
  109786. /**
  109787. * Gets the back-face culling state
  109788. */
  109789. get backFaceCulling(): boolean;
  109790. /**
  109791. * Stores the value for side orientation
  109792. */
  109793. sideOrientation: number;
  109794. /**
  109795. * Callback triggered when the material is compiled
  109796. */
  109797. onCompiled: Nullable<(effect: Effect) => void>;
  109798. /**
  109799. * Callback triggered when an error occurs
  109800. */
  109801. onError: Nullable<(effect: Effect, errors: string) => void>;
  109802. /**
  109803. * Callback triggered to get the render target textures
  109804. */
  109805. getRenderTargetTextures: Nullable<() => SmartArray<RenderTargetTexture>>;
  109806. /**
  109807. * Gets a boolean indicating that current material needs to register RTT
  109808. */
  109809. get hasRenderTargetTextures(): boolean;
  109810. /**
  109811. * Specifies if the material should be serialized
  109812. */
  109813. doNotSerialize: boolean;
  109814. /**
  109815. * @hidden
  109816. */
  109817. _storeEffectOnSubMeshes: boolean;
  109818. /**
  109819. * Stores the animations for the material
  109820. */
  109821. animations: Nullable<Array<Animation>>;
  109822. /**
  109823. * An event triggered when the material is disposed
  109824. */
  109825. onDisposeObservable: Observable<Material>;
  109826. /**
  109827. * An observer which watches for dispose events
  109828. */
  109829. private _onDisposeObserver;
  109830. private _onUnBindObservable;
  109831. /**
  109832. * Called during a dispose event
  109833. */
  109834. set onDispose(callback: () => void);
  109835. private _onBindObservable;
  109836. /**
  109837. * An event triggered when the material is bound
  109838. */
  109839. get onBindObservable(): Observable<AbstractMesh>;
  109840. /**
  109841. * An observer which watches for bind events
  109842. */
  109843. private _onBindObserver;
  109844. /**
  109845. * Called during a bind event
  109846. */
  109847. set onBind(callback: (Mesh: AbstractMesh) => void);
  109848. /**
  109849. * An event triggered when the material is unbound
  109850. */
  109851. get onUnBindObservable(): Observable<Material>;
  109852. protected _onEffectCreatedObservable: Nullable<Observable<{
  109853. effect: Effect;
  109854. subMesh: Nullable<SubMesh>;
  109855. }>>;
  109856. /**
  109857. * An event triggered when the effect is (re)created
  109858. */
  109859. get onEffectCreatedObservable(): Observable<{
  109860. effect: Effect;
  109861. subMesh: Nullable<SubMesh>;
  109862. }>;
  109863. /**
  109864. * Stores the value of the alpha mode
  109865. */
  109866. private _alphaMode;
  109867. /**
  109868. * Sets the value of the alpha mode.
  109869. *
  109870. * | Value | Type | Description |
  109871. * | --- | --- | --- |
  109872. * | 0 | ALPHA_DISABLE | |
  109873. * | 1 | ALPHA_ADD | |
  109874. * | 2 | ALPHA_COMBINE | |
  109875. * | 3 | ALPHA_SUBTRACT | |
  109876. * | 4 | ALPHA_MULTIPLY | |
  109877. * | 5 | ALPHA_MAXIMIZED | |
  109878. * | 6 | ALPHA_ONEONE | |
  109879. * | 7 | ALPHA_PREMULTIPLIED | |
  109880. * | 8 | ALPHA_PREMULTIPLIED_PORTERDUFF | |
  109881. * | 9 | ALPHA_INTERPOLATE | |
  109882. * | 10 | ALPHA_SCREENMODE | |
  109883. *
  109884. */
  109885. set alphaMode(value: number);
  109886. /**
  109887. * Gets the value of the alpha mode
  109888. */
  109889. get alphaMode(): number;
  109890. /**
  109891. * Stores the state of the need depth pre-pass value
  109892. */
  109893. private _needDepthPrePass;
  109894. /**
  109895. * Sets the need depth pre-pass value
  109896. */
  109897. set needDepthPrePass(value: boolean);
  109898. /**
  109899. * Gets the depth pre-pass value
  109900. */
  109901. get needDepthPrePass(): boolean;
  109902. /**
  109903. * Specifies if depth writing should be disabled
  109904. */
  109905. disableDepthWrite: boolean;
  109906. /**
  109907. * Specifies if color writing should be disabled
  109908. */
  109909. disableColorWrite: boolean;
  109910. /**
  109911. * Specifies if depth writing should be forced
  109912. */
  109913. forceDepthWrite: boolean;
  109914. /**
  109915. * Specifies the depth function that should be used. 0 means the default engine function
  109916. */
  109917. depthFunction: number;
  109918. /**
  109919. * Specifies if there should be a separate pass for culling
  109920. */
  109921. separateCullingPass: boolean;
  109922. /**
  109923. * Stores the state specifing if fog should be enabled
  109924. */
  109925. private _fogEnabled;
  109926. /**
  109927. * Sets the state for enabling fog
  109928. */
  109929. set fogEnabled(value: boolean);
  109930. /**
  109931. * Gets the value of the fog enabled state
  109932. */
  109933. get fogEnabled(): boolean;
  109934. /**
  109935. * Stores the size of points
  109936. */
  109937. pointSize: number;
  109938. /**
  109939. * Stores the z offset value
  109940. */
  109941. zOffset: number;
  109942. get wireframe(): boolean;
  109943. /**
  109944. * Sets the state of wireframe mode
  109945. */
  109946. set wireframe(value: boolean);
  109947. /**
  109948. * Gets the value specifying if point clouds are enabled
  109949. */
  109950. get pointsCloud(): boolean;
  109951. /**
  109952. * Sets the state of point cloud mode
  109953. */
  109954. set pointsCloud(value: boolean);
  109955. /**
  109956. * Gets the material fill mode
  109957. */
  109958. get fillMode(): number;
  109959. /**
  109960. * Sets the material fill mode
  109961. */
  109962. set fillMode(value: number);
  109963. /**
  109964. * @hidden
  109965. * Stores the effects for the material
  109966. */
  109967. _effect: Nullable<Effect>;
  109968. /**
  109969. * Specifies if uniform buffers should be used
  109970. */
  109971. private _useUBO;
  109972. /**
  109973. * Stores a reference to the scene
  109974. */
  109975. private _scene;
  109976. /**
  109977. * Stores the fill mode state
  109978. */
  109979. private _fillMode;
  109980. /**
  109981. * Specifies if the depth write state should be cached
  109982. */
  109983. private _cachedDepthWriteState;
  109984. /**
  109985. * Specifies if the color write state should be cached
  109986. */
  109987. private _cachedColorWriteState;
  109988. /**
  109989. * Specifies if the depth function state should be cached
  109990. */
  109991. private _cachedDepthFunctionState;
  109992. /**
  109993. * Stores the uniform buffer
  109994. */
  109995. protected _uniformBuffer: UniformBuffer;
  109996. /** @hidden */
  109997. _indexInSceneMaterialArray: number;
  109998. /** @hidden */
  109999. meshMap: Nullable<{
  110000. [id: string]: AbstractMesh | undefined;
  110001. }>;
  110002. /**
  110003. * Creates a material instance
  110004. * @param name defines the name of the material
  110005. * @param scene defines the scene to reference
  110006. * @param doNotAdd specifies if the material should be added to the scene
  110007. */
  110008. constructor(name: string, scene: Scene, doNotAdd?: boolean);
  110009. /**
  110010. * Returns a string representation of the current material
  110011. * @param fullDetails defines a boolean indicating which levels of logging is desired
  110012. * @returns a string with material information
  110013. */
  110014. toString(fullDetails?: boolean): string;
  110015. /**
  110016. * Gets the class name of the material
  110017. * @returns a string with the class name of the material
  110018. */
  110019. getClassName(): string;
  110020. /**
  110021. * Specifies if updates for the material been locked
  110022. */
  110023. get isFrozen(): boolean;
  110024. /**
  110025. * Locks updates for the material
  110026. */
  110027. freeze(): void;
  110028. /**
  110029. * Unlocks updates for the material
  110030. */
  110031. unfreeze(): void;
  110032. /**
  110033. * Specifies if the material is ready to be used
  110034. * @param mesh defines the mesh to check
  110035. * @param useInstances specifies if instances should be used
  110036. * @returns a boolean indicating if the material is ready to be used
  110037. */
  110038. isReady(mesh?: AbstractMesh, useInstances?: boolean): boolean;
  110039. /**
  110040. * Specifies that the submesh is ready to be used
  110041. * @param mesh defines the mesh to check
  110042. * @param subMesh defines which submesh to check
  110043. * @param useInstances specifies that instances should be used
  110044. * @returns a boolean indicating that the submesh is ready or not
  110045. */
  110046. isReadyForSubMesh(mesh: AbstractMesh, subMesh: SubMesh, useInstances?: boolean): boolean;
  110047. /**
  110048. * Returns the material effect
  110049. * @returns the effect associated with the material
  110050. */
  110051. getEffect(): Nullable<Effect>;
  110052. /**
  110053. * Returns the current scene
  110054. * @returns a Scene
  110055. */
  110056. getScene(): Scene;
  110057. /**
  110058. * Enforces alpha test in opaque or blend mode in order to improve the performances of some situations.
  110059. */
  110060. protected _forceAlphaTest: boolean;
  110061. /**
  110062. * The transparency mode of the material.
  110063. */
  110064. protected _transparencyMode: Nullable<number>;
  110065. /**
  110066. * Gets the current transparency mode.
  110067. */
  110068. get transparencyMode(): Nullable<number>;
  110069. /**
  110070. * Sets the transparency mode of the material.
  110071. *
  110072. * | Value | Type | Description |
  110073. * | ----- | ----------------------------------- | ----------- |
  110074. * | 0 | OPAQUE | |
  110075. * | 1 | ALPHATEST | |
  110076. * | 2 | ALPHABLEND | |
  110077. * | 3 | ALPHATESTANDBLEND | |
  110078. *
  110079. */
  110080. set transparencyMode(value: Nullable<number>);
  110081. /**
  110082. * Returns true if alpha blending should be disabled.
  110083. */
  110084. protected get _disableAlphaBlending(): boolean;
  110085. /**
  110086. * Specifies whether or not this material should be rendered in alpha blend mode.
  110087. * @returns a boolean specifying if alpha blending is needed
  110088. */
  110089. needAlphaBlending(): boolean;
  110090. /**
  110091. * Specifies if the mesh will require alpha blending
  110092. * @param mesh defines the mesh to check
  110093. * @returns a boolean specifying if alpha blending is needed for the mesh
  110094. */
  110095. needAlphaBlendingForMesh(mesh: AbstractMesh): boolean;
  110096. /**
  110097. * Specifies whether or not this material should be rendered in alpha test mode.
  110098. * @returns a boolean specifying if an alpha test is needed.
  110099. */
  110100. needAlphaTesting(): boolean;
  110101. /**
  110102. * Specifies if material alpha testing should be turned on for the mesh
  110103. * @param mesh defines the mesh to check
  110104. */
  110105. protected _shouldTurnAlphaTestOn(mesh: AbstractMesh): boolean;
  110106. /**
  110107. * Gets the texture used for the alpha test
  110108. * @returns the texture to use for alpha testing
  110109. */
  110110. getAlphaTestTexture(): Nullable<BaseTexture>;
  110111. /**
  110112. * Marks the material to indicate that it needs to be re-calculated
  110113. */
  110114. markDirty(): void;
  110115. /** @hidden */
  110116. _preBind(effect?: Effect, overrideOrientation?: Nullable<number>): boolean;
  110117. /**
  110118. * Binds the material to the mesh
  110119. * @param world defines the world transformation matrix
  110120. * @param mesh defines the mesh to bind the material to
  110121. */
  110122. bind(world: Matrix, mesh?: Mesh): void;
  110123. /**
  110124. * Binds the submesh to the material
  110125. * @param world defines the world transformation matrix
  110126. * @param mesh defines the mesh containing the submesh
  110127. * @param subMesh defines the submesh to bind the material to
  110128. */
  110129. bindForSubMesh(world: Matrix, mesh: Mesh, subMesh: SubMesh): void;
  110130. /**
  110131. * Binds the world matrix to the material
  110132. * @param world defines the world transformation matrix
  110133. */
  110134. bindOnlyWorldMatrix(world: Matrix): void;
  110135. /**
  110136. * Binds the scene's uniform buffer to the effect.
  110137. * @param effect defines the effect to bind to the scene uniform buffer
  110138. * @param sceneUbo defines the uniform buffer storing scene data
  110139. */
  110140. bindSceneUniformBuffer(effect: Effect, sceneUbo: UniformBuffer): void;
  110141. /**
  110142. * Binds the view matrix to the effect
  110143. * @param effect defines the effect to bind the view matrix to
  110144. */
  110145. bindView(effect: Effect): void;
  110146. /**
  110147. * Binds the view projection matrix to the effect
  110148. * @param effect defines the effect to bind the view projection matrix to
  110149. */
  110150. bindViewProjection(effect: Effect): void;
  110151. /**
  110152. * Processes to execute after binding the material to a mesh
  110153. * @param mesh defines the rendered mesh
  110154. */
  110155. protected _afterBind(mesh?: Mesh): void;
  110156. /**
  110157. * Unbinds the material from the mesh
  110158. */
  110159. unbind(): void;
  110160. /**
  110161. * Gets the active textures from the material
  110162. * @returns an array of textures
  110163. */
  110164. getActiveTextures(): BaseTexture[];
  110165. /**
  110166. * Specifies if the material uses a texture
  110167. * @param texture defines the texture to check against the material
  110168. * @returns a boolean specifying if the material uses the texture
  110169. */
  110170. hasTexture(texture: BaseTexture): boolean;
  110171. /**
  110172. * Makes a duplicate of the material, and gives it a new name
  110173. * @param name defines the new name for the duplicated material
  110174. * @returns the cloned material
  110175. */
  110176. clone(name: string): Nullable<Material>;
  110177. /**
  110178. * Gets the meshes bound to the material
  110179. * @returns an array of meshes bound to the material
  110180. */
  110181. getBindedMeshes(): AbstractMesh[];
  110182. /**
  110183. * Force shader compilation
  110184. * @param mesh defines the mesh associated with this material
  110185. * @param onCompiled defines a function to execute once the material is compiled
  110186. * @param options defines the options to configure the compilation
  110187. * @param onError defines a function to execute if the material fails compiling
  110188. */
  110189. forceCompilation(mesh: AbstractMesh, onCompiled?: (material: Material) => void, options?: Partial<IMaterialCompilationOptions>, onError?: (reason: string) => void): void;
  110190. /**
  110191. * Force shader compilation
  110192. * @param mesh defines the mesh that will use this material
  110193. * @param options defines additional options for compiling the shaders
  110194. * @returns a promise that resolves when the compilation completes
  110195. */
  110196. forceCompilationAsync(mesh: AbstractMesh, options?: Partial<IMaterialCompilationOptions>): Promise<void>;
  110197. private static readonly _AllDirtyCallBack;
  110198. private static readonly _ImageProcessingDirtyCallBack;
  110199. private static readonly _TextureDirtyCallBack;
  110200. private static readonly _FresnelDirtyCallBack;
  110201. private static readonly _MiscDirtyCallBack;
  110202. private static readonly _PrePassDirtyCallBack;
  110203. private static readonly _LightsDirtyCallBack;
  110204. private static readonly _AttributeDirtyCallBack;
  110205. private static _FresnelAndMiscDirtyCallBack;
  110206. private static _TextureAndMiscDirtyCallBack;
  110207. private static readonly _DirtyCallbackArray;
  110208. private static readonly _RunDirtyCallBacks;
  110209. /**
  110210. * Marks a define in the material to indicate that it needs to be re-computed
  110211. * @param flag defines a flag used to determine which parts of the material have to be marked as dirty
  110212. */
  110213. markAsDirty(flag: number): void;
  110214. /**
  110215. * Marks all submeshes of a material to indicate that their material defines need to be re-calculated
  110216. * @param func defines a function which checks material defines against the submeshes
  110217. */
  110218. protected _markAllSubMeshesAsDirty(func: (defines: MaterialDefines) => void): void;
  110219. /**
  110220. * Indicates that the scene should check if the rendering now needs a prepass
  110221. */
  110222. protected _markScenePrePassDirty(): void;
  110223. /**
  110224. * Indicates that we need to re-calculated for all submeshes
  110225. */
  110226. protected _markAllSubMeshesAsAllDirty(): void;
  110227. /**
  110228. * Indicates that image processing needs to be re-calculated for all submeshes
  110229. */
  110230. protected _markAllSubMeshesAsImageProcessingDirty(): void;
  110231. /**
  110232. * Indicates that textures need to be re-calculated for all submeshes
  110233. */
  110234. protected _markAllSubMeshesAsTexturesDirty(): void;
  110235. /**
  110236. * Indicates that fresnel needs to be re-calculated for all submeshes
  110237. */
  110238. protected _markAllSubMeshesAsFresnelDirty(): void;
  110239. /**
  110240. * Indicates that fresnel and misc need to be re-calculated for all submeshes
  110241. */
  110242. protected _markAllSubMeshesAsFresnelAndMiscDirty(): void;
  110243. /**
  110244. * Indicates that lights need to be re-calculated for all submeshes
  110245. */
  110246. protected _markAllSubMeshesAsLightsDirty(): void;
  110247. /**
  110248. * Indicates that attributes need to be re-calculated for all submeshes
  110249. */
  110250. protected _markAllSubMeshesAsAttributesDirty(): void;
  110251. /**
  110252. * Indicates that misc needs to be re-calculated for all submeshes
  110253. */
  110254. protected _markAllSubMeshesAsMiscDirty(): void;
  110255. /**
  110256. * Indicates that prepass needs to be re-calculated for all submeshes
  110257. */
  110258. protected _markAllSubMeshesAsPrePassDirty(): void;
  110259. /**
  110260. * Indicates that textures and misc need to be re-calculated for all submeshes
  110261. */
  110262. protected _markAllSubMeshesAsTexturesAndMiscDirty(): void;
  110263. /**
  110264. * Sets the required values to the prepass renderer.
  110265. * @param prePassRenderer defines the prepass renderer to setup.
  110266. * @returns true if the pre pass is needed.
  110267. */
  110268. setPrePassRenderer(prePassRenderer: PrePassRenderer): boolean;
  110269. /**
  110270. * Disposes the material
  110271. * @param forceDisposeEffect specifies if effects should be forcefully disposed
  110272. * @param forceDisposeTextures specifies if textures should be forcefully disposed
  110273. * @param notBoundToMesh specifies if the material that is being disposed is known to be not bound to any mesh
  110274. */
  110275. dispose(forceDisposeEffect?: boolean, forceDisposeTextures?: boolean, notBoundToMesh?: boolean): void;
  110276. /** @hidden */
  110277. private releaseVertexArrayObject;
  110278. /**
  110279. * Serializes this material
  110280. * @returns the serialized material object
  110281. */
  110282. serialize(): any;
  110283. /**
  110284. * Creates a material from parsed material data
  110285. * @param parsedMaterial defines parsed material data
  110286. * @param scene defines the hosting scene
  110287. * @param rootUrl defines the root URL to use to load textures
  110288. * @returns a new material
  110289. */
  110290. static Parse(parsedMaterial: any, scene: Scene, rootUrl: string): Nullable<Material>;
  110291. }
  110292. }
  110293. declare module BABYLON {
  110294. /**
  110295. * A multi-material is used to apply different materials to different parts of the same object without the need of
  110296. * separate meshes. This can be use to improve performances.
  110297. * @see https://doc.babylonjs.com/how_to/multi_materials
  110298. */
  110299. export class MultiMaterial extends Material {
  110300. private _subMaterials;
  110301. /**
  110302. * Gets or Sets the list of Materials used within the multi material.
  110303. * They need to be ordered according to the submeshes order in the associated mesh
  110304. */
  110305. get subMaterials(): Nullable<Material>[];
  110306. set subMaterials(value: Nullable<Material>[]);
  110307. /**
  110308. * Function used to align with Node.getChildren()
  110309. * @returns the list of Materials used within the multi material
  110310. */
  110311. getChildren(): Nullable<Material>[];
  110312. /**
  110313. * Instantiates a new Multi Material
  110314. * A multi-material is used to apply different materials to different parts of the same object without the need of
  110315. * separate meshes. This can be use to improve performances.
  110316. * @see https://doc.babylonjs.com/how_to/multi_materials
  110317. * @param name Define the name in the scene
  110318. * @param scene Define the scene the material belongs to
  110319. */
  110320. constructor(name: string, scene: Scene);
  110321. private _hookArray;
  110322. /**
  110323. * Get one of the submaterial by its index in the submaterials array
  110324. * @param index The index to look the sub material at
  110325. * @returns The Material if the index has been defined
  110326. */
  110327. getSubMaterial(index: number): Nullable<Material>;
  110328. /**
  110329. * Get the list of active textures for the whole sub materials list.
  110330. * @returns All the textures that will be used during the rendering
  110331. */
  110332. getActiveTextures(): BaseTexture[];
  110333. /**
  110334. * Gets the current class name of the material e.g. "MultiMaterial"
  110335. * Mainly use in serialization.
  110336. * @returns the class name
  110337. */
  110338. getClassName(): string;
  110339. /**
  110340. * Checks if the material is ready to render the requested sub mesh
  110341. * @param mesh Define the mesh the submesh belongs to
  110342. * @param subMesh Define the sub mesh to look readyness for
  110343. * @param useInstances Define whether or not the material is used with instances
  110344. * @returns true if ready, otherwise false
  110345. */
  110346. isReadyForSubMesh(mesh: AbstractMesh, subMesh: SubMesh, useInstances?: boolean): boolean;
  110347. /**
  110348. * Clones the current material and its related sub materials
  110349. * @param name Define the name of the newly cloned material
  110350. * @param cloneChildren Define if submaterial will be cloned or shared with the parent instance
  110351. * @returns the cloned material
  110352. */
  110353. clone(name: string, cloneChildren?: boolean): MultiMaterial;
  110354. /**
  110355. * Serializes the materials into a JSON representation.
  110356. * @returns the JSON representation
  110357. */
  110358. serialize(): any;
  110359. /**
  110360. * Dispose the material and release its associated resources
  110361. * @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)
  110362. * @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)
  110363. * @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)
  110364. */
  110365. dispose(forceDisposeEffect?: boolean, forceDisposeTextures?: boolean, forceDisposeChildren?: boolean): void;
  110366. /**
  110367. * Creates a MultiMaterial from parsed MultiMaterial data.
  110368. * @param parsedMultiMaterial defines parsed MultiMaterial data.
  110369. * @param scene defines the hosting scene
  110370. * @returns a new MultiMaterial
  110371. */
  110372. static ParseMultiMaterial(parsedMultiMaterial: any, scene: Scene): MultiMaterial;
  110373. }
  110374. }
  110375. declare module BABYLON {
  110376. /**
  110377. * Defines a subdivision inside a mesh
  110378. */
  110379. export class SubMesh implements ICullable {
  110380. /** the material index to use */
  110381. materialIndex: number;
  110382. /** vertex index start */
  110383. verticesStart: number;
  110384. /** vertices count */
  110385. verticesCount: number;
  110386. /** index start */
  110387. indexStart: number;
  110388. /** indices count */
  110389. indexCount: number;
  110390. /** @hidden */
  110391. _materialDefines: Nullable<MaterialDefines>;
  110392. /** @hidden */
  110393. _materialEffect: Nullable<Effect>;
  110394. /** @hidden */
  110395. _effectOverride: Nullable<Effect>;
  110396. /**
  110397. * Gets material defines used by the effect associated to the sub mesh
  110398. */
  110399. get materialDefines(): Nullable<MaterialDefines>;
  110400. /**
  110401. * Sets material defines used by the effect associated to the sub mesh
  110402. */
  110403. set materialDefines(defines: Nullable<MaterialDefines>);
  110404. /**
  110405. * Gets associated effect
  110406. */
  110407. get effect(): Nullable<Effect>;
  110408. /**
  110409. * Sets associated effect (effect used to render this submesh)
  110410. * @param effect defines the effect to associate with
  110411. * @param defines defines the set of defines used to compile this effect
  110412. */
  110413. setEffect(effect: Nullable<Effect>, defines?: Nullable<MaterialDefines>): void;
  110414. /** @hidden */
  110415. _linesIndexCount: number;
  110416. private _mesh;
  110417. private _renderingMesh;
  110418. private _boundingInfo;
  110419. private _linesIndexBuffer;
  110420. /** @hidden */
  110421. _lastColliderWorldVertices: Nullable<Vector3[]>;
  110422. /** @hidden */
  110423. _trianglePlanes: Plane[];
  110424. /** @hidden */
  110425. _lastColliderTransformMatrix: Nullable<Matrix>;
  110426. /** @hidden */
  110427. _renderId: number;
  110428. /** @hidden */
  110429. _alphaIndex: number;
  110430. /** @hidden */
  110431. _distanceToCamera: number;
  110432. /** @hidden */
  110433. _id: number;
  110434. private _currentMaterial;
  110435. /**
  110436. * Add a new submesh to a mesh
  110437. * @param materialIndex defines the material index to use
  110438. * @param verticesStart defines vertex index start
  110439. * @param verticesCount defines vertices count
  110440. * @param indexStart defines index start
  110441. * @param indexCount defines indices count
  110442. * @param mesh defines the parent mesh
  110443. * @param renderingMesh defines an optional rendering mesh
  110444. * @param createBoundingBox defines if bounding box should be created for this submesh
  110445. * @returns the new submesh
  110446. */
  110447. static AddToMesh(materialIndex: number, verticesStart: number, verticesCount: number, indexStart: number, indexCount: number, mesh: AbstractMesh, renderingMesh?: Mesh, createBoundingBox?: boolean): SubMesh;
  110448. /**
  110449. * Creates a new submesh
  110450. * @param materialIndex defines the material index to use
  110451. * @param verticesStart defines vertex index start
  110452. * @param verticesCount defines vertices count
  110453. * @param indexStart defines index start
  110454. * @param indexCount defines indices count
  110455. * @param mesh defines the parent mesh
  110456. * @param renderingMesh defines an optional rendering mesh
  110457. * @param createBoundingBox defines if bounding box should be created for this submesh
  110458. * @param addToMesh defines a boolean indicating that the submesh must be added to the mesh.subMeshes array (true by default)
  110459. */
  110460. constructor(
  110461. /** the material index to use */
  110462. materialIndex: number,
  110463. /** vertex index start */
  110464. verticesStart: number,
  110465. /** vertices count */
  110466. verticesCount: number,
  110467. /** index start */
  110468. indexStart: number,
  110469. /** indices count */
  110470. indexCount: number, mesh: AbstractMesh, renderingMesh?: Mesh, createBoundingBox?: boolean, addToMesh?: boolean);
  110471. /**
  110472. * Returns true if this submesh covers the entire parent mesh
  110473. * @ignorenaming
  110474. */
  110475. get IsGlobal(): boolean;
  110476. /**
  110477. * Returns the submesh BoudingInfo object
  110478. * @returns current bounding info (or mesh's one if the submesh is global)
  110479. */
  110480. getBoundingInfo(): BoundingInfo;
  110481. /**
  110482. * Sets the submesh BoundingInfo
  110483. * @param boundingInfo defines the new bounding info to use
  110484. * @returns the SubMesh
  110485. */
  110486. setBoundingInfo(boundingInfo: BoundingInfo): SubMesh;
  110487. /**
  110488. * Returns the mesh of the current submesh
  110489. * @return the parent mesh
  110490. */
  110491. getMesh(): AbstractMesh;
  110492. /**
  110493. * Returns the rendering mesh of the submesh
  110494. * @returns the rendering mesh (could be different from parent mesh)
  110495. */
  110496. getRenderingMesh(): Mesh;
  110497. /**
  110498. * Returns the replacement mesh of the submesh
  110499. * @returns the replacement mesh (could be different from parent mesh)
  110500. */
  110501. getReplacementMesh(): Nullable<AbstractMesh>;
  110502. /**
  110503. * Returns the effective mesh of the submesh
  110504. * @returns the effective mesh (could be different from parent mesh)
  110505. */
  110506. getEffectiveMesh(): AbstractMesh;
  110507. /**
  110508. * Returns the submesh material
  110509. * @returns null or the current material
  110510. */
  110511. getMaterial(): Nullable<Material>;
  110512. private _IsMultiMaterial;
  110513. /**
  110514. * Sets a new updated BoundingInfo object to the submesh
  110515. * @param data defines an optional position array to use to determine the bounding info
  110516. * @returns the SubMesh
  110517. */
  110518. refreshBoundingInfo(data?: Nullable<FloatArray>): SubMesh;
  110519. /** @hidden */
  110520. _checkCollision(collider: Collider): boolean;
  110521. /**
  110522. * Updates the submesh BoundingInfo
  110523. * @param world defines the world matrix to use to update the bounding info
  110524. * @returns the submesh
  110525. */
  110526. updateBoundingInfo(world: DeepImmutable<Matrix>): SubMesh;
  110527. /**
  110528. * True is the submesh bounding box intersects the frustum defined by the passed array of planes.
  110529. * @param frustumPlanes defines the frustum planes
  110530. * @returns true if the submesh is intersecting with the frustum
  110531. */
  110532. isInFrustum(frustumPlanes: Plane[]): boolean;
  110533. /**
  110534. * True is the submesh bounding box is completely inside the frustum defined by the passed array of planes
  110535. * @param frustumPlanes defines the frustum planes
  110536. * @returns true if the submesh is inside the frustum
  110537. */
  110538. isCompletelyInFrustum(frustumPlanes: Plane[]): boolean;
  110539. /**
  110540. * Renders the submesh
  110541. * @param enableAlphaMode defines if alpha needs to be used
  110542. * @returns the submesh
  110543. */
  110544. render(enableAlphaMode: boolean): SubMesh;
  110545. /**
  110546. * @hidden
  110547. */
  110548. _getLinesIndexBuffer(indices: IndicesArray, engine: Engine): DataBuffer;
  110549. /**
  110550. * Checks if the submesh intersects with a ray
  110551. * @param ray defines the ray to test
  110552. * @returns true is the passed ray intersects the submesh bounding box
  110553. */
  110554. canIntersects(ray: Ray): boolean;
  110555. /**
  110556. * Intersects current submesh with a ray
  110557. * @param ray defines the ray to test
  110558. * @param positions defines mesh's positions array
  110559. * @param indices defines mesh's indices array
  110560. * @param fastCheck defines if the first intersection will be used (and not the closest)
  110561. * @param trianglePredicate defines an optional predicate used to select faces when a mesh intersection is detected
  110562. * @returns intersection info or null if no intersection
  110563. */
  110564. intersects(ray: Ray, positions: Vector3[], indices: IndicesArray, fastCheck?: boolean, trianglePredicate?: TrianglePickingPredicate): Nullable<IntersectionInfo>;
  110565. /** @hidden */
  110566. private _intersectLines;
  110567. /** @hidden */
  110568. private _intersectUnIndexedLines;
  110569. /** @hidden */
  110570. private _intersectTriangles;
  110571. /** @hidden */
  110572. private _intersectUnIndexedTriangles;
  110573. /** @hidden */
  110574. _rebuild(): void;
  110575. /**
  110576. * Creates a new submesh from the passed mesh
  110577. * @param newMesh defines the new hosting mesh
  110578. * @param newRenderingMesh defines an optional rendering mesh
  110579. * @returns the new submesh
  110580. */
  110581. clone(newMesh: AbstractMesh, newRenderingMesh?: Mesh): SubMesh;
  110582. /**
  110583. * Release associated resources
  110584. */
  110585. dispose(): void;
  110586. /**
  110587. * Gets the class name
  110588. * @returns the string "SubMesh".
  110589. */
  110590. getClassName(): string;
  110591. /**
  110592. * Creates a new submesh from indices data
  110593. * @param materialIndex the index of the main mesh material
  110594. * @param startIndex the index where to start the copy in the mesh indices array
  110595. * @param indexCount the number of indices to copy then from the startIndex
  110596. * @param mesh the main mesh to create the submesh from
  110597. * @param renderingMesh the optional rendering mesh
  110598. * @returns a new submesh
  110599. */
  110600. static CreateFromIndices(materialIndex: number, startIndex: number, indexCount: number, mesh: AbstractMesh, renderingMesh?: Mesh): SubMesh;
  110601. }
  110602. }
  110603. declare module BABYLON {
  110604. /**
  110605. * Class used to represent data loading progression
  110606. */
  110607. export class SceneLoaderFlags {
  110608. private static _ForceFullSceneLoadingForIncremental;
  110609. private static _ShowLoadingScreen;
  110610. private static _CleanBoneMatrixWeights;
  110611. private static _loggingLevel;
  110612. /**
  110613. * Gets or sets a boolean indicating if entire scene must be loaded even if scene contains incremental data
  110614. */
  110615. static get ForceFullSceneLoadingForIncremental(): boolean;
  110616. static set ForceFullSceneLoadingForIncremental(value: boolean);
  110617. /**
  110618. * Gets or sets a boolean indicating if loading screen must be displayed while loading a scene
  110619. */
  110620. static get ShowLoadingScreen(): boolean;
  110621. static set ShowLoadingScreen(value: boolean);
  110622. /**
  110623. * Defines the current logging level (while loading the scene)
  110624. * @ignorenaming
  110625. */
  110626. static get loggingLevel(): number;
  110627. static set loggingLevel(value: number);
  110628. /**
  110629. * Gets or set a boolean indicating if matrix weights must be cleaned upon loading
  110630. */
  110631. static get CleanBoneMatrixWeights(): boolean;
  110632. static set CleanBoneMatrixWeights(value: boolean);
  110633. }
  110634. }
  110635. declare module BABYLON {
  110636. /**
  110637. * Class used to store geometry data (vertex buffers + index buffer)
  110638. */
  110639. export class Geometry implements IGetSetVerticesData {
  110640. /**
  110641. * Gets or sets the ID of the geometry
  110642. */
  110643. id: string;
  110644. /**
  110645. * Gets or sets the unique ID of the geometry
  110646. */
  110647. uniqueId: number;
  110648. /**
  110649. * Gets the delay loading state of the geometry (none by default which means not delayed)
  110650. */
  110651. delayLoadState: number;
  110652. /**
  110653. * Gets the file containing the data to load when running in delay load state
  110654. */
  110655. delayLoadingFile: Nullable<string>;
  110656. /**
  110657. * Callback called when the geometry is updated
  110658. */
  110659. onGeometryUpdated: (geometry: Geometry, kind?: string) => void;
  110660. private _scene;
  110661. private _engine;
  110662. private _meshes;
  110663. private _totalVertices;
  110664. /** @hidden */
  110665. _indices: IndicesArray;
  110666. /** @hidden */
  110667. _vertexBuffers: {
  110668. [key: string]: VertexBuffer;
  110669. };
  110670. private _isDisposed;
  110671. private _extend;
  110672. private _boundingBias;
  110673. /** @hidden */
  110674. _delayInfo: Array<string>;
  110675. private _indexBuffer;
  110676. private _indexBufferIsUpdatable;
  110677. /** @hidden */
  110678. _boundingInfo: Nullable<BoundingInfo>;
  110679. /** @hidden */
  110680. _delayLoadingFunction: Nullable<(any: any, geometry: Geometry) => void>;
  110681. /** @hidden */
  110682. _softwareSkinningFrameId: number;
  110683. private _vertexArrayObjects;
  110684. private _updatable;
  110685. /** @hidden */
  110686. _positions: Nullable<Vector3[]>;
  110687. /**
  110688. * 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
  110689. */
  110690. get boundingBias(): Vector2;
  110691. /**
  110692. * 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
  110693. */
  110694. set boundingBias(value: Vector2);
  110695. /**
  110696. * Static function used to attach a new empty geometry to a mesh
  110697. * @param mesh defines the mesh to attach the geometry to
  110698. * @returns the new Geometry
  110699. */
  110700. static CreateGeometryForMesh(mesh: Mesh): Geometry;
  110701. /** Get the list of meshes using this geometry */
  110702. get meshes(): Mesh[];
  110703. /**
  110704. * 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
  110705. * and won't be computed based on the vertex positions (which is what we get when useBoundingInfoFromGeometry = false)
  110706. */
  110707. useBoundingInfoFromGeometry: boolean;
  110708. /**
  110709. * Creates a new geometry
  110710. * @param id defines the unique ID
  110711. * @param scene defines the hosting scene
  110712. * @param vertexData defines the VertexData used to get geometry data
  110713. * @param updatable defines if geometry must be updatable (false by default)
  110714. * @param mesh defines the mesh that will be associated with the geometry
  110715. */
  110716. constructor(id: string, scene: Scene, vertexData?: VertexData, updatable?: boolean, mesh?: Nullable<Mesh>);
  110717. /**
  110718. * Gets the current extend of the geometry
  110719. */
  110720. get extend(): {
  110721. minimum: Vector3;
  110722. maximum: Vector3;
  110723. };
  110724. /**
  110725. * Gets the hosting scene
  110726. * @returns the hosting Scene
  110727. */
  110728. getScene(): Scene;
  110729. /**
  110730. * Gets the hosting engine
  110731. * @returns the hosting Engine
  110732. */
  110733. getEngine(): Engine;
  110734. /**
  110735. * Defines if the geometry is ready to use
  110736. * @returns true if the geometry is ready to be used
  110737. */
  110738. isReady(): boolean;
  110739. /**
  110740. * Gets a value indicating that the geometry should not be serialized
  110741. */
  110742. get doNotSerialize(): boolean;
  110743. /** @hidden */
  110744. _rebuild(): void;
  110745. /**
  110746. * Affects all geometry data in one call
  110747. * @param vertexData defines the geometry data
  110748. * @param updatable defines if the geometry must be flagged as updatable (false as default)
  110749. */
  110750. setAllVerticesData(vertexData: VertexData, updatable?: boolean): void;
  110751. /**
  110752. * Set specific vertex data
  110753. * @param kind defines the data kind (Position, normal, etc...)
  110754. * @param data defines the vertex data to use
  110755. * @param updatable defines if the vertex must be flagged as updatable (false as default)
  110756. * @param stride defines the stride to use (0 by default). This value is deduced from the kind value if not specified
  110757. */
  110758. setVerticesData(kind: string, data: FloatArray, updatable?: boolean, stride?: number): void;
  110759. /**
  110760. * Removes a specific vertex data
  110761. * @param kind defines the data kind (Position, normal, etc...)
  110762. */
  110763. removeVerticesData(kind: string): void;
  110764. /**
  110765. * Affect a vertex buffer to the geometry. the vertexBuffer.getKind() function is used to determine where to store the data
  110766. * @param buffer defines the vertex buffer to use
  110767. * @param totalVertices defines the total number of vertices for position kind (could be null)
  110768. */
  110769. setVerticesBuffer(buffer: VertexBuffer, totalVertices?: Nullable<number>): void;
  110770. /**
  110771. * Update a specific vertex buffer
  110772. * This function will directly update the underlying DataBuffer according to the passed numeric array or Float32Array
  110773. * It will do nothing if the buffer is not updatable
  110774. * @param kind defines the data kind (Position, normal, etc...)
  110775. * @param data defines the data to use
  110776. * @param offset defines the offset in the target buffer where to store the data
  110777. * @param useBytes set to true if the offset is in bytes
  110778. */
  110779. updateVerticesDataDirectly(kind: string, data: DataArray, offset: number, useBytes?: boolean): void;
  110780. /**
  110781. * Update a specific vertex buffer
  110782. * This function will create a new buffer if the current one is not updatable
  110783. * @param kind defines the data kind (Position, normal, etc...)
  110784. * @param data defines the data to use
  110785. * @param updateExtends defines if the geometry extends must be recomputed (false by default)
  110786. */
  110787. updateVerticesData(kind: string, data: FloatArray, updateExtends?: boolean): void;
  110788. private _updateBoundingInfo;
  110789. /** @hidden */
  110790. _bind(effect: Nullable<Effect>, indexToBind?: Nullable<DataBuffer>): void;
  110791. /**
  110792. * Gets total number of vertices
  110793. * @returns the total number of vertices
  110794. */
  110795. getTotalVertices(): number;
  110796. /**
  110797. * Gets a specific vertex data attached to this geometry. Float data is constructed if the vertex buffer data cannot be returned directly.
  110798. * @param kind defines the data kind (Position, normal, etc...)
  110799. * @param copyWhenShared defines if the returned array must be cloned upon returning it if the current geometry is shared between multiple meshes
  110800. * @param forceCopy defines a boolean indicating that the returned array must be cloned upon returning it
  110801. * @returns a float array containing vertex data
  110802. */
  110803. getVerticesData(kind: string, copyWhenShared?: boolean, forceCopy?: boolean): Nullable<FloatArray>;
  110804. /**
  110805. * Returns a boolean defining if the vertex data for the requested `kind` is updatable
  110806. * @param kind defines the data kind (Position, normal, etc...)
  110807. * @returns true if the vertex buffer with the specified kind is updatable
  110808. */
  110809. isVertexBufferUpdatable(kind: string): boolean;
  110810. /**
  110811. * Gets a specific vertex buffer
  110812. * @param kind defines the data kind (Position, normal, etc...)
  110813. * @returns a VertexBuffer
  110814. */
  110815. getVertexBuffer(kind: string): Nullable<VertexBuffer>;
  110816. /**
  110817. * Returns all vertex buffers
  110818. * @return an object holding all vertex buffers indexed by kind
  110819. */
  110820. getVertexBuffers(): Nullable<{
  110821. [key: string]: VertexBuffer;
  110822. }>;
  110823. /**
  110824. * Gets a boolean indicating if specific vertex buffer is present
  110825. * @param kind defines the data kind (Position, normal, etc...)
  110826. * @returns true if data is present
  110827. */
  110828. isVerticesDataPresent(kind: string): boolean;
  110829. /**
  110830. * Gets a list of all attached data kinds (Position, normal, etc...)
  110831. * @returns a list of string containing all kinds
  110832. */
  110833. getVerticesDataKinds(): string[];
  110834. /**
  110835. * Update index buffer
  110836. * @param indices defines the indices to store in the index buffer
  110837. * @param offset defines the offset in the target buffer where to store the data
  110838. * @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)
  110839. */
  110840. updateIndices(indices: IndicesArray, offset?: number, gpuMemoryOnly?: boolean): void;
  110841. /**
  110842. * Creates a new index buffer
  110843. * @param indices defines the indices to store in the index buffer
  110844. * @param totalVertices defines the total number of vertices (could be null)
  110845. * @param updatable defines if the index buffer must be flagged as updatable (false by default)
  110846. */
  110847. setIndices(indices: IndicesArray, totalVertices?: Nullable<number>, updatable?: boolean): void;
  110848. /**
  110849. * Return the total number of indices
  110850. * @returns the total number of indices
  110851. */
  110852. getTotalIndices(): number;
  110853. /**
  110854. * Gets the index buffer array
  110855. * @param copyWhenShared defines if the returned array must be cloned upon returning it if the current geometry is shared between multiple meshes
  110856. * @param forceCopy defines a boolean indicating that the returned array must be cloned upon returning it
  110857. * @returns the index buffer array
  110858. */
  110859. getIndices(copyWhenShared?: boolean, forceCopy?: boolean): Nullable<IndicesArray>;
  110860. /**
  110861. * Gets the index buffer
  110862. * @return the index buffer
  110863. */
  110864. getIndexBuffer(): Nullable<DataBuffer>;
  110865. /** @hidden */
  110866. _releaseVertexArrayObject(effect?: Nullable<Effect>): void;
  110867. /**
  110868. * Release the associated resources for a specific mesh
  110869. * @param mesh defines the source mesh
  110870. * @param shouldDispose defines if the geometry must be disposed if there is no more mesh pointing to it
  110871. */
  110872. releaseForMesh(mesh: Mesh, shouldDispose?: boolean): void;
  110873. /**
  110874. * Apply current geometry to a given mesh
  110875. * @param mesh defines the mesh to apply geometry to
  110876. */
  110877. applyToMesh(mesh: Mesh): void;
  110878. private _updateExtend;
  110879. private _applyToMesh;
  110880. private notifyUpdate;
  110881. /**
  110882. * Load the geometry if it was flagged as delay loaded
  110883. * @param scene defines the hosting scene
  110884. * @param onLoaded defines a callback called when the geometry is loaded
  110885. */
  110886. load(scene: Scene, onLoaded?: () => void): void;
  110887. private _queueLoad;
  110888. /**
  110889. * Invert the geometry to move from a right handed system to a left handed one.
  110890. */
  110891. toLeftHanded(): void;
  110892. /** @hidden */
  110893. _resetPointsArrayCache(): void;
  110894. /** @hidden */
  110895. _generatePointsArray(): boolean;
  110896. /**
  110897. * Gets a value indicating if the geometry is disposed
  110898. * @returns true if the geometry was disposed
  110899. */
  110900. isDisposed(): boolean;
  110901. private _disposeVertexArrayObjects;
  110902. /**
  110903. * Free all associated resources
  110904. */
  110905. dispose(): void;
  110906. /**
  110907. * Clone the current geometry into a new geometry
  110908. * @param id defines the unique ID of the new geometry
  110909. * @returns a new geometry object
  110910. */
  110911. copy(id: string): Geometry;
  110912. /**
  110913. * Serialize the current geometry info (and not the vertices data) into a JSON object
  110914. * @return a JSON representation of the current geometry data (without the vertices data)
  110915. */
  110916. serialize(): any;
  110917. private toNumberArray;
  110918. /**
  110919. * Serialize all vertices data into a JSON oject
  110920. * @returns a JSON representation of the current geometry data
  110921. */
  110922. serializeVerticeData(): any;
  110923. /**
  110924. * Extracts a clone of a mesh geometry
  110925. * @param mesh defines the source mesh
  110926. * @param id defines the unique ID of the new geometry object
  110927. * @returns the new geometry object
  110928. */
  110929. static ExtractFromMesh(mesh: Mesh, id: string): Nullable<Geometry>;
  110930. /**
  110931. * You should now use Tools.RandomId(), this method is still here for legacy reasons.
  110932. * Implementation from http://stackoverflow.com/questions/105034/how-to-create-a-guid-uuid-in-javascript/2117523#answer-2117523
  110933. * Be aware Math.random() could cause collisions, but:
  110934. * "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"
  110935. * @returns a string containing a new GUID
  110936. */
  110937. static RandomId(): string;
  110938. /** @hidden */
  110939. static _ImportGeometry(parsedGeometry: any, mesh: Mesh): void;
  110940. private static _CleanMatricesWeights;
  110941. /**
  110942. * Create a new geometry from persisted data (Using .babylon file format)
  110943. * @param parsedVertexData defines the persisted data
  110944. * @param scene defines the hosting scene
  110945. * @param rootUrl defines the root url to use to load assets (like delayed data)
  110946. * @returns the new geometry object
  110947. */
  110948. static Parse(parsedVertexData: any, scene: Scene, rootUrl: string): Nullable<Geometry>;
  110949. }
  110950. }
  110951. declare module BABYLON {
  110952. /**
  110953. * Define an interface for all classes that will get and set the data on vertices
  110954. */
  110955. export interface IGetSetVerticesData {
  110956. /**
  110957. * Gets a boolean indicating if specific vertex data is present
  110958. * @param kind defines the vertex data kind to use
  110959. * @returns true is data kind is present
  110960. */
  110961. isVerticesDataPresent(kind: string): boolean;
  110962. /**
  110963. * Gets a specific vertex data attached to this geometry. Float data is constructed if the vertex buffer data cannot be returned directly.
  110964. * @param kind defines the data kind (Position, normal, etc...)
  110965. * @param copyWhenShared defines if the returned array must be cloned upon returning it if the current geometry is shared between multiple meshes
  110966. * @param forceCopy defines a boolean indicating that the returned array must be cloned upon returning it
  110967. * @returns a float array containing vertex data
  110968. */
  110969. getVerticesData(kind: string, copyWhenShared?: boolean, forceCopy?: boolean): Nullable<FloatArray>;
  110970. /**
  110971. * Returns an array of integers or a typed array (Int32Array, Uint32Array, Uint16Array) populated with the mesh indices.
  110972. * @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.
  110973. * @param forceCopy defines a boolean indicating that the returned array must be cloned upon returning it
  110974. * @returns the indices array or an empty array if the mesh has no geometry
  110975. */
  110976. getIndices(copyWhenShared?: boolean, forceCopy?: boolean): Nullable<IndicesArray>;
  110977. /**
  110978. * Set specific vertex data
  110979. * @param kind defines the data kind (Position, normal, etc...)
  110980. * @param data defines the vertex data to use
  110981. * @param updatable defines if the vertex must be flagged as updatable (false as default)
  110982. * @param stride defines the stride to use (0 by default). This value is deduced from the kind value if not specified
  110983. */
  110984. setVerticesData(kind: string, data: FloatArray, updatable: boolean): void;
  110985. /**
  110986. * Update a specific associated vertex buffer
  110987. * @param kind defines which buffer to write to (positions, indices, normals, etc). Possible `kind` values :
  110988. * - VertexBuffer.PositionKind
  110989. * - VertexBuffer.UVKind
  110990. * - VertexBuffer.UV2Kind
  110991. * - VertexBuffer.UV3Kind
  110992. * - VertexBuffer.UV4Kind
  110993. * - VertexBuffer.UV5Kind
  110994. * - VertexBuffer.UV6Kind
  110995. * - VertexBuffer.ColorKind
  110996. * - VertexBuffer.MatricesIndicesKind
  110997. * - VertexBuffer.MatricesIndicesExtraKind
  110998. * - VertexBuffer.MatricesWeightsKind
  110999. * - VertexBuffer.MatricesWeightsExtraKind
  111000. * @param data defines the data source
  111001. * @param updateExtends defines if extends info of the mesh must be updated (can be null). This is mostly useful for "position" kind
  111002. * @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)
  111003. */
  111004. updateVerticesData(kind: string, data: FloatArray, updateExtends?: boolean, makeItUnique?: boolean): void;
  111005. /**
  111006. * Creates a new index buffer
  111007. * @param indices defines the indices to store in the index buffer
  111008. * @param totalVertices defines the total number of vertices (could be null)
  111009. * @param updatable defines if the index buffer must be flagged as updatable (false by default)
  111010. */
  111011. setIndices(indices: IndicesArray, totalVertices: Nullable<number>, updatable?: boolean): void;
  111012. }
  111013. /**
  111014. * This class contains the various kinds of data on every vertex of a mesh used in determining its shape and appearance
  111015. */
  111016. export class VertexData {
  111017. /**
  111018. * Mesh side orientation : usually the external or front surface
  111019. */
  111020. static readonly FRONTSIDE: number;
  111021. /**
  111022. * Mesh side orientation : usually the internal or back surface
  111023. */
  111024. static readonly BACKSIDE: number;
  111025. /**
  111026. * Mesh side orientation : both internal and external or front and back surfaces
  111027. */
  111028. static readonly DOUBLESIDE: number;
  111029. /**
  111030. * Mesh side orientation : by default, `FRONTSIDE`
  111031. */
  111032. static readonly DEFAULTSIDE: number;
  111033. /**
  111034. * An array of the x, y, z position of each vertex [...., x, y, z, .....]
  111035. */
  111036. positions: Nullable<FloatArray>;
  111037. /**
  111038. * An array of the x, y, z normal vector of each vertex [...., x, y, z, .....]
  111039. */
  111040. normals: Nullable<FloatArray>;
  111041. /**
  111042. * An array of the x, y, z tangent vector of each vertex [...., x, y, z, .....]
  111043. */
  111044. tangents: Nullable<FloatArray>;
  111045. /**
  111046. * An array of u,v which maps a texture image onto each vertex [...., u, v, .....]
  111047. */
  111048. uvs: Nullable<FloatArray>;
  111049. /**
  111050. * A second array of u,v which maps a texture image onto each vertex [...., u, v, .....]
  111051. */
  111052. uvs2: Nullable<FloatArray>;
  111053. /**
  111054. * A third array of u,v which maps a texture image onto each vertex [...., u, v, .....]
  111055. */
  111056. uvs3: Nullable<FloatArray>;
  111057. /**
  111058. * A fourth array of u,v which maps a texture image onto each vertex [...., u, v, .....]
  111059. */
  111060. uvs4: Nullable<FloatArray>;
  111061. /**
  111062. * A fifth array of u,v which maps a texture image onto each vertex [...., u, v, .....]
  111063. */
  111064. uvs5: Nullable<FloatArray>;
  111065. /**
  111066. * A sixth array of u,v which maps a texture image onto each vertex [...., u, v, .....]
  111067. */
  111068. uvs6: Nullable<FloatArray>;
  111069. /**
  111070. * An array of the r, g, b, a, color of each vertex [...., r, g, b, a, .....]
  111071. */
  111072. colors: Nullable<FloatArray>;
  111073. /**
  111074. * 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).
  111075. */
  111076. matricesIndices: Nullable<FloatArray>;
  111077. /**
  111078. * An array containing the list of weights defining the weight of each indexed matrix in the final computation
  111079. */
  111080. matricesWeights: Nullable<FloatArray>;
  111081. /**
  111082. * An array extending the number of possible indices
  111083. */
  111084. matricesIndicesExtra: Nullable<FloatArray>;
  111085. /**
  111086. * An array extending the number of possible weights when the number of indices is extended
  111087. */
  111088. matricesWeightsExtra: Nullable<FloatArray>;
  111089. /**
  111090. * An array of i, j, k the three vertex indices required for each triangular facet [...., i, j, k .....]
  111091. */
  111092. indices: Nullable<IndicesArray>;
  111093. /**
  111094. * Uses the passed data array to set the set the values for the specified kind of data
  111095. * @param data a linear array of floating numbers
  111096. * @param kind the type of data that is being set, eg positions, colors etc
  111097. */
  111098. set(data: FloatArray, kind: string): void;
  111099. /**
  111100. * Associates the vertexData to the passed Mesh.
  111101. * Sets it as updatable or not (default `false`)
  111102. * @param mesh the mesh the vertexData is applied to
  111103. * @param updatable when used and having the value true allows new data to update the vertexData
  111104. * @returns the VertexData
  111105. */
  111106. applyToMesh(mesh: Mesh, updatable?: boolean): VertexData;
  111107. /**
  111108. * Associates the vertexData to the passed Geometry.
  111109. * Sets it as updatable or not (default `false`)
  111110. * @param geometry the geometry the vertexData is applied to
  111111. * @param updatable when used and having the value true allows new data to update the vertexData
  111112. * @returns VertexData
  111113. */
  111114. applyToGeometry(geometry: Geometry, updatable?: boolean): VertexData;
  111115. /**
  111116. * Updates the associated mesh
  111117. * @param mesh the mesh to be updated
  111118. * @param updateExtends when true the mesh BoundingInfo will be renewed when and if position kind is updated, optional with default false
  111119. * @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
  111120. * @returns VertexData
  111121. */
  111122. updateMesh(mesh: Mesh): VertexData;
  111123. /**
  111124. * Updates the associated geometry
  111125. * @param geometry the geometry to be updated
  111126. * @param updateExtends when true BoundingInfo will be renewed when and if position kind is updated, optional with default false
  111127. * @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
  111128. * @returns VertexData.
  111129. */
  111130. updateGeometry(geometry: Geometry): VertexData;
  111131. private _applyTo;
  111132. private _update;
  111133. /**
  111134. * Transforms each position and each normal of the vertexData according to the passed Matrix
  111135. * @param matrix the transforming matrix
  111136. * @returns the VertexData
  111137. */
  111138. transform(matrix: Matrix): VertexData;
  111139. /**
  111140. * Merges the passed VertexData into the current one
  111141. * @param other the VertexData to be merged into the current one
  111142. * @param use32BitsIndices defines a boolean indicating if indices must be store in a 32 bits array
  111143. * @returns the modified VertexData
  111144. */
  111145. merge(other: VertexData, use32BitsIndices?: boolean): VertexData;
  111146. private _mergeElement;
  111147. private _validate;
  111148. /**
  111149. * Serializes the VertexData
  111150. * @returns a serialized object
  111151. */
  111152. serialize(): any;
  111153. /**
  111154. * Extracts the vertexData from a mesh
  111155. * @param mesh the mesh from which to extract the VertexData
  111156. * @param copyWhenShared defines if the VertexData must be cloned when shared between multiple meshes, optional, default false
  111157. * @param forceCopy indicating that the VertexData must be cloned, optional, default false
  111158. * @returns the object VertexData associated to the passed mesh
  111159. */
  111160. static ExtractFromMesh(mesh: Mesh, copyWhenShared?: boolean, forceCopy?: boolean): VertexData;
  111161. /**
  111162. * Extracts the vertexData from the geometry
  111163. * @param geometry the geometry from which to extract the VertexData
  111164. * @param copyWhenShared defines if the VertexData must be cloned when the geometrty is shared between multiple meshes, optional, default false
  111165. * @param forceCopy indicating that the VertexData must be cloned, optional, default false
  111166. * @returns the object VertexData associated to the passed mesh
  111167. */
  111168. static ExtractFromGeometry(geometry: Geometry, copyWhenShared?: boolean, forceCopy?: boolean): VertexData;
  111169. private static _ExtractFrom;
  111170. /**
  111171. * Creates the VertexData for a Ribbon
  111172. * @param options an object used to set the following optional parameters for the ribbon, required but can be empty
  111173. * * pathArray array of paths, each of which an array of successive Vector3
  111174. * * closeArray creates a seam between the first and the last paths of the pathArray, optional, default false
  111175. * * closePath creates a seam between the first and the last points of each path of the path array, optional, default false
  111176. * * 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
  111177. * * sideOrientation optional and takes the values : Mesh.FRONTSIDE (default), Mesh.BACKSIDE or Mesh.DOUBLESIDE
  111178. * * 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)
  111179. * * 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)
  111180. * * invertUV swaps in the U and V coordinates when applying a texture, optional, default false
  111181. * * uvs a linear array, of length 2 * number of vertices, of custom UV values, optional
  111182. * * colors a linear array, of length 4 * number of vertices, of custom color values, optional
  111183. * @returns the VertexData of the ribbon
  111184. */
  111185. static CreateRibbon(options: {
  111186. pathArray: Vector3[][];
  111187. closeArray?: boolean;
  111188. closePath?: boolean;
  111189. offset?: number;
  111190. sideOrientation?: number;
  111191. frontUVs?: Vector4;
  111192. backUVs?: Vector4;
  111193. invertUV?: boolean;
  111194. uvs?: Vector2[];
  111195. colors?: Color4[];
  111196. }): VertexData;
  111197. /**
  111198. * Creates the VertexData for a box
  111199. * @param options an object used to set the following optional parameters for the box, required but can be empty
  111200. * * size sets the width, height and depth of the box to the value of size, optional default 1
  111201. * * width sets the width (x direction) of the box, overwrites the width set by size, optional, default size
  111202. * * height sets the height (y direction) of the box, overwrites the height set by size, optional, default size
  111203. * * depth sets the depth (z direction) of the box, overwrites the depth set by size, optional, default size
  111204. * * faceUV an array of 6 Vector4 elements used to set different images to each box side
  111205. * * faceColors an array of 6 Color3 elements used to set different colors to each box side
  111206. * * sideOrientation optional and takes the values : Mesh.FRONTSIDE (default), Mesh.BACKSIDE or Mesh.DOUBLESIDE
  111207. * * 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)
  111208. * * 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)
  111209. * @returns the VertexData of the box
  111210. */
  111211. static CreateBox(options: {
  111212. size?: number;
  111213. width?: number;
  111214. height?: number;
  111215. depth?: number;
  111216. faceUV?: Vector4[];
  111217. faceColors?: Color4[];
  111218. sideOrientation?: number;
  111219. frontUVs?: Vector4;
  111220. backUVs?: Vector4;
  111221. }): VertexData;
  111222. /**
  111223. * Creates the VertexData for a tiled box
  111224. * @param options an object used to set the following optional parameters for the box, required but can be empty
  111225. * * faceTiles sets the pattern, tile size and number of tiles for a face
  111226. * * faceUV an array of 6 Vector4 elements used to set different images to each box side
  111227. * * faceColors an array of 6 Color3 elements used to set different colors to each box side
  111228. * * sideOrientation optional and takes the values : Mesh.FRONTSIDE (default), Mesh.BACKSIDE or Mesh.DOUBLESIDE
  111229. * @returns the VertexData of the box
  111230. */
  111231. static CreateTiledBox(options: {
  111232. pattern?: number;
  111233. width?: number;
  111234. height?: number;
  111235. depth?: number;
  111236. tileSize?: number;
  111237. tileWidth?: number;
  111238. tileHeight?: number;
  111239. alignHorizontal?: number;
  111240. alignVertical?: number;
  111241. faceUV?: Vector4[];
  111242. faceColors?: Color4[];
  111243. sideOrientation?: number;
  111244. }): VertexData;
  111245. /**
  111246. * Creates the VertexData for a tiled plane
  111247. * @param options an object used to set the following optional parameters for the box, required but can be empty
  111248. * * pattern a limited pattern arrangement depending on the number
  111249. * * tileSize sets the width, height and depth of the tile to the value of size, optional default 1
  111250. * * tileWidth sets the width (x direction) of the tile, overwrites the width set by size, optional, default size
  111251. * * tileHeight sets the height (y direction) of the tile, overwrites the height set by size, optional, default size
  111252. * * sideOrientation optional and takes the values : Mesh.FRONTSIDE (default), Mesh.BACKSIDE or Mesh.DOUBLESIDE
  111253. * * 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)
  111254. * * 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)
  111255. * @returns the VertexData of the tiled plane
  111256. */
  111257. static CreateTiledPlane(options: {
  111258. pattern?: number;
  111259. tileSize?: number;
  111260. tileWidth?: number;
  111261. tileHeight?: number;
  111262. size?: number;
  111263. width?: number;
  111264. height?: number;
  111265. alignHorizontal?: number;
  111266. alignVertical?: number;
  111267. sideOrientation?: number;
  111268. frontUVs?: Vector4;
  111269. backUVs?: Vector4;
  111270. }): VertexData;
  111271. /**
  111272. * Creates the VertexData for an ellipsoid, defaults to a sphere
  111273. * @param options an object used to set the following optional parameters for the box, required but can be empty
  111274. * * segments sets the number of horizontal strips optional, default 32
  111275. * * diameter sets the axes dimensions, diameterX, diameterY and diameterZ to the value of diameter, optional default 1
  111276. * * diameterX sets the diameterX (x direction) of the ellipsoid, overwrites the diameterX set by diameter, optional, default diameter
  111277. * * diameterY sets the diameterY (y direction) of the ellipsoid, overwrites the diameterY set by diameter, optional, default diameter
  111278. * * diameterZ sets the diameterZ (z direction) of the ellipsoid, overwrites the diameterZ set by diameter, optional, default diameter
  111279. * * 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
  111280. * * 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
  111281. * * sideOrientation optional and takes the values : Mesh.FRONTSIDE (default), Mesh.BACKSIDE or Mesh.DOUBLESIDE
  111282. * * 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)
  111283. * * 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)
  111284. * @returns the VertexData of the ellipsoid
  111285. */
  111286. static CreateSphere(options: {
  111287. segments?: number;
  111288. diameter?: number;
  111289. diameterX?: number;
  111290. diameterY?: number;
  111291. diameterZ?: number;
  111292. arc?: number;
  111293. slice?: number;
  111294. sideOrientation?: number;
  111295. frontUVs?: Vector4;
  111296. backUVs?: Vector4;
  111297. }): VertexData;
  111298. /**
  111299. * Creates the VertexData for a cylinder, cone or prism
  111300. * @param options an object used to set the following optional parameters for the box, required but can be empty
  111301. * * height sets the height (y direction) of the cylinder, optional, default 2
  111302. * * diameterTop sets the diameter of the top of the cone, overwrites diameter, optional, default diameter
  111303. * * diameterBottom sets the diameter of the bottom of the cone, overwrites diameter, optional, default diameter
  111304. * * diameter sets the diameter of the top and bottom of the cone, optional default 1
  111305. * * tessellation the number of prism sides, 3 for a triangular prism, optional, default 24
  111306. * * subdivisions` the number of rings along the cylinder height, optional, default 1
  111307. * * 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
  111308. * * faceColors an array of Color3 elements used to set different colors to the top, rings and bottom respectively
  111309. * * faceUV an array of Vector4 elements used to set different images to the top, rings and bottom respectively
  111310. * * hasRings when true makes each subdivision independantly treated as a face for faceUV and faceColors, optional, default false
  111311. * * enclose when true closes an open cylinder by adding extra flat faces between the height axis and vertical edges, think cut cake
  111312. * * sideOrientation optional and takes the values : Mesh.FRONTSIDE (default), Mesh.BACKSIDE or Mesh.DOUBLESIDE
  111313. * * 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)
  111314. * * 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)
  111315. * @returns the VertexData of the cylinder, cone or prism
  111316. */
  111317. static CreateCylinder(options: {
  111318. height?: number;
  111319. diameterTop?: number;
  111320. diameterBottom?: number;
  111321. diameter?: number;
  111322. tessellation?: number;
  111323. subdivisions?: number;
  111324. arc?: number;
  111325. faceColors?: Color4[];
  111326. faceUV?: Vector4[];
  111327. hasRings?: boolean;
  111328. enclose?: boolean;
  111329. sideOrientation?: number;
  111330. frontUVs?: Vector4;
  111331. backUVs?: Vector4;
  111332. }): VertexData;
  111333. /**
  111334. * Creates the VertexData for a torus
  111335. * @param options an object used to set the following optional parameters for the box, required but can be empty
  111336. * * diameter the diameter of the torus, optional default 1
  111337. * * thickness the diameter of the tube forming the torus, optional default 0.5
  111338. * * tessellation the number of prism sides, 3 for a triangular prism, optional, default 24
  111339. * * sideOrientation optional and takes the values : Mesh.FRONTSIDE (default), Mesh.BACKSIDE or Mesh.DOUBLESIDE
  111340. * * 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)
  111341. * * 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)
  111342. * @returns the VertexData of the torus
  111343. */
  111344. static CreateTorus(options: {
  111345. diameter?: number;
  111346. thickness?: number;
  111347. tessellation?: number;
  111348. sideOrientation?: number;
  111349. frontUVs?: Vector4;
  111350. backUVs?: Vector4;
  111351. }): VertexData;
  111352. /**
  111353. * Creates the VertexData of the LineSystem
  111354. * @param options an object used to set the following optional parameters for the LineSystem, required but can be empty
  111355. * - lines an array of lines, each line being an array of successive Vector3
  111356. * - colors an array of line colors, each of the line colors being an array of successive Color4, one per line point
  111357. * @returns the VertexData of the LineSystem
  111358. */
  111359. static CreateLineSystem(options: {
  111360. lines: Vector3[][];
  111361. colors?: Nullable<Color4[][]>;
  111362. }): VertexData;
  111363. /**
  111364. * Create the VertexData for a DashedLines
  111365. * @param options an object used to set the following optional parameters for the DashedLines, required but can be empty
  111366. * - points an array successive Vector3
  111367. * - dashSize the size of the dashes relative to the dash number, optional, default 3
  111368. * - gapSize the size of the gap between two successive dashes relative to the dash number, optional, default 1
  111369. * - dashNb the intended total number of dashes, optional, default 200
  111370. * @returns the VertexData for the DashedLines
  111371. */
  111372. static CreateDashedLines(options: {
  111373. points: Vector3[];
  111374. dashSize?: number;
  111375. gapSize?: number;
  111376. dashNb?: number;
  111377. }): VertexData;
  111378. /**
  111379. * Creates the VertexData for a Ground
  111380. * @param options an object used to set the following optional parameters for the Ground, required but can be empty
  111381. * - width the width (x direction) of the ground, optional, default 1
  111382. * - height the height (z direction) of the ground, optional, default 1
  111383. * - subdivisions the number of subdivisions per side, optional, default 1
  111384. * @returns the VertexData of the Ground
  111385. */
  111386. static CreateGround(options: {
  111387. width?: number;
  111388. height?: number;
  111389. subdivisions?: number;
  111390. subdivisionsX?: number;
  111391. subdivisionsY?: number;
  111392. }): VertexData;
  111393. /**
  111394. * Creates the VertexData for a TiledGround by subdividing the ground into tiles
  111395. * @param options an object used to set the following optional parameters for the Ground, required but can be empty
  111396. * * xmin the ground minimum X coordinate, optional, default -1
  111397. * * zmin the ground minimum Z coordinate, optional, default -1
  111398. * * xmax the ground maximum X coordinate, optional, default 1
  111399. * * zmax the ground maximum Z coordinate, optional, default 1
  111400. * * 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}
  111401. * * 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}
  111402. * @returns the VertexData of the TiledGround
  111403. */
  111404. static CreateTiledGround(options: {
  111405. xmin: number;
  111406. zmin: number;
  111407. xmax: number;
  111408. zmax: number;
  111409. subdivisions?: {
  111410. w: number;
  111411. h: number;
  111412. };
  111413. precision?: {
  111414. w: number;
  111415. h: number;
  111416. };
  111417. }): VertexData;
  111418. /**
  111419. * Creates the VertexData of the Ground designed from a heightmap
  111420. * @param options an object used to set the following parameters for the Ground, required and provided by MeshBuilder.CreateGroundFromHeightMap
  111421. * * width the width (x direction) of the ground
  111422. * * height the height (z direction) of the ground
  111423. * * subdivisions the number of subdivisions per side
  111424. * * minHeight the minimum altitude on the ground, optional, default 0
  111425. * * maxHeight the maximum altitude on the ground, optional default 1
  111426. * * colorFilter the filter to apply to the image pixel colors to compute the height, optional Color3, default (0.3, 0.59, 0.11)
  111427. * * buffer the array holding the image color data
  111428. * * bufferWidth the width of image
  111429. * * bufferHeight the height of image
  111430. * * alphaFilter Remove any data where the alpha channel is below this value, defaults 0 (all data visible)
  111431. * @returns the VertexData of the Ground designed from a heightmap
  111432. */
  111433. static CreateGroundFromHeightMap(options: {
  111434. width: number;
  111435. height: number;
  111436. subdivisions: number;
  111437. minHeight: number;
  111438. maxHeight: number;
  111439. colorFilter: Color3;
  111440. buffer: Uint8Array;
  111441. bufferWidth: number;
  111442. bufferHeight: number;
  111443. alphaFilter: number;
  111444. }): VertexData;
  111445. /**
  111446. * Creates the VertexData for a Plane
  111447. * @param options an object used to set the following optional parameters for the plane, required but can be empty
  111448. * * size sets the width and height of the plane to the value of size, optional default 1
  111449. * * width sets the width (x direction) of the plane, overwrites the width set by size, optional, default size
  111450. * * height sets the height (y direction) of the plane, overwrites the height set by size, optional, default size
  111451. * * sideOrientation optional and takes the values : Mesh.FRONTSIDE (default), Mesh.BACKSIDE or Mesh.DOUBLESIDE
  111452. * * 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)
  111453. * * 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)
  111454. * @returns the VertexData of the box
  111455. */
  111456. static CreatePlane(options: {
  111457. size?: number;
  111458. width?: number;
  111459. height?: number;
  111460. sideOrientation?: number;
  111461. frontUVs?: Vector4;
  111462. backUVs?: Vector4;
  111463. }): VertexData;
  111464. /**
  111465. * Creates the VertexData of the Disc or regular Polygon
  111466. * @param options an object used to set the following optional parameters for the disc, required but can be empty
  111467. * * radius the radius of the disc, optional default 0.5
  111468. * * tessellation the number of polygon sides, optional, default 64
  111469. * * 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
  111470. * * sideOrientation optional and takes the values : Mesh.FRONTSIDE (default), Mesh.BACKSIDE or Mesh.DOUBLESIDE
  111471. * * 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)
  111472. * * 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)
  111473. * @returns the VertexData of the box
  111474. */
  111475. static CreateDisc(options: {
  111476. radius?: number;
  111477. tessellation?: number;
  111478. arc?: number;
  111479. sideOrientation?: number;
  111480. frontUVs?: Vector4;
  111481. backUVs?: Vector4;
  111482. }): VertexData;
  111483. /**
  111484. * Creates the VertexData for an irregular Polygon in the XoZ plane using a mesh built by polygonTriangulation.build()
  111485. * All parameters are provided by MeshBuilder.CreatePolygon as needed
  111486. * @param polygon a mesh built from polygonTriangulation.build()
  111487. * @param sideOrientation takes the values Mesh.FRONTSIDE (default), Mesh.BACKSIDE or Mesh.DOUBLESIDE
  111488. * @param fUV an array of Vector4 elements used to set different images to the top, rings and bottom respectively
  111489. * @param fColors an array of Color3 elements used to set different colors to the top, rings and bottom respectively
  111490. * @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)
  111491. * @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)
  111492. * @param wrap a boolean, default false, when true and fUVs used texture is wrapped around all sides, when false texture is applied side
  111493. * @returns the VertexData of the Polygon
  111494. */
  111495. static CreatePolygon(polygon: Mesh, sideOrientation: number, fUV?: Vector4[], fColors?: Color4[], frontUVs?: Vector4, backUVs?: Vector4, wrap?: boolean): VertexData;
  111496. /**
  111497. * Creates the VertexData of the IcoSphere
  111498. * @param options an object used to set the following optional parameters for the IcoSphere, required but can be empty
  111499. * * radius the radius of the IcoSphere, optional default 1
  111500. * * radiusX allows stretching in the x direction, optional, default radius
  111501. * * radiusY allows stretching in the y direction, optional, default radius
  111502. * * radiusZ allows stretching in the z direction, optional, default radius
  111503. * * flat when true creates a flat shaded mesh, optional, default true
  111504. * * subdivisions increasing the subdivisions increases the number of faces, optional, default 4
  111505. * * sideOrientation optional and takes the values : Mesh.FRONTSIDE (default), Mesh.BACKSIDE or Mesh.DOUBLESIDE
  111506. * * 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)
  111507. * * 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)
  111508. * @returns the VertexData of the IcoSphere
  111509. */
  111510. static CreateIcoSphere(options: {
  111511. radius?: number;
  111512. radiusX?: number;
  111513. radiusY?: number;
  111514. radiusZ?: number;
  111515. flat?: boolean;
  111516. subdivisions?: number;
  111517. sideOrientation?: number;
  111518. frontUVs?: Vector4;
  111519. backUVs?: Vector4;
  111520. }): VertexData;
  111521. /**
  111522. * Creates the VertexData for a Polyhedron
  111523. * @param options an object used to set the following optional parameters for the polyhedron, required but can be empty
  111524. * * type provided types are:
  111525. * * 0 : Tetrahedron, 1 : Octahedron, 2 : Dodecahedron, 3 : Icosahedron, 4 : Rhombicuboctahedron, 5 : Triangular Prism, 6 : Pentagonal Prism, 7 : Hexagonal Prism, 8 : Square Pyramid (J1)
  111526. * * 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)
  111527. * * size the size of the IcoSphere, optional default 1
  111528. * * sizeX allows stretching in the x direction, optional, default size
  111529. * * sizeY allows stretching in the y direction, optional, default size
  111530. * * sizeZ allows stretching in the z direction, optional, default size
  111531. * * 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
  111532. * * faceUV an array of Vector4 elements used to set different images to the top, rings and bottom respectively
  111533. * * faceColors an array of Color3 elements used to set different colors to the top, rings and bottom respectively
  111534. * * flat when true creates a flat shaded mesh, optional, default true
  111535. * * subdivisions increasing the subdivisions increases the number of faces, optional, default 4
  111536. * * sideOrientation optional and takes the values : Mesh.FRONTSIDE (default), Mesh.BACKSIDE or Mesh.DOUBLESIDE
  111537. * * 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)
  111538. * * 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)
  111539. * @returns the VertexData of the Polyhedron
  111540. */
  111541. static CreatePolyhedron(options: {
  111542. type?: number;
  111543. size?: number;
  111544. sizeX?: number;
  111545. sizeY?: number;
  111546. sizeZ?: number;
  111547. custom?: any;
  111548. faceUV?: Vector4[];
  111549. faceColors?: Color4[];
  111550. flat?: boolean;
  111551. sideOrientation?: number;
  111552. frontUVs?: Vector4;
  111553. backUVs?: Vector4;
  111554. }): VertexData;
  111555. /**
  111556. * Creates the VertexData for a Capsule, inspired from https://github.com/maximeq/three-js-capsule-geometry/blob/master/src/CapsuleBufferGeometry.js
  111557. * @param options an object used to set the following optional parameters for the capsule, required but can be empty
  111558. * @returns the VertexData of the Capsule
  111559. */
  111560. static CreateCapsule(options?: ICreateCapsuleOptions): VertexData;
  111561. /**
  111562. * Creates the VertexData for a TorusKnot
  111563. * @param options an object used to set the following optional parameters for the TorusKnot, required but can be empty
  111564. * * radius the radius of the torus knot, optional, default 2
  111565. * * tube the thickness of the tube, optional, default 0.5
  111566. * * radialSegments the number of sides on each tube segments, optional, default 32
  111567. * * tubularSegments the number of tubes to decompose the knot into, optional, default 32
  111568. * * p the number of windings around the z axis, optional, default 2
  111569. * * q the number of windings around the x axis, optional, default 3
  111570. * * sideOrientation optional and takes the values : Mesh.FRONTSIDE (default), Mesh.BACKSIDE or Mesh.DOUBLESIDE
  111571. * * 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)
  111572. * * 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)
  111573. * @returns the VertexData of the Torus Knot
  111574. */
  111575. static CreateTorusKnot(options: {
  111576. radius?: number;
  111577. tube?: number;
  111578. radialSegments?: number;
  111579. tubularSegments?: number;
  111580. p?: number;
  111581. q?: number;
  111582. sideOrientation?: number;
  111583. frontUVs?: Vector4;
  111584. backUVs?: Vector4;
  111585. }): VertexData;
  111586. /**
  111587. * Compute normals for given positions and indices
  111588. * @param positions an array of vertex positions, [...., x, y, z, ......]
  111589. * @param indices an array of indices in groups of three for each triangular facet, [...., i, j, k, ......]
  111590. * @param normals an array of vertex normals, [...., x, y, z, ......]
  111591. * @param options an object used to set the following optional parameters for the TorusKnot, optional
  111592. * * facetNormals : optional array of facet normals (vector3)
  111593. * * facetPositions : optional array of facet positions (vector3)
  111594. * * facetPartitioning : optional partitioning array. facetPositions is required for facetPartitioning computation
  111595. * * ratio : optional partitioning ratio / bounding box, required for facetPartitioning computation
  111596. * * bInfo : optional bounding info, required for facetPartitioning computation
  111597. * * bbSize : optional bounding box size data, required for facetPartitioning computation
  111598. * * subDiv : optional partitioning data about subdivsions on each axis (int), required for facetPartitioning computation
  111599. * * useRightHandedSystem: optional boolean to for right handed system computation
  111600. * * depthSort : optional boolean to enable the facet depth sort computation
  111601. * * distanceTo : optional Vector3 to compute the facet depth from this location
  111602. * * depthSortedFacets : optional array of depthSortedFacets to store the facet distances from the reference location
  111603. */
  111604. static ComputeNormals(positions: any, indices: any, normals: any, options?: {
  111605. facetNormals?: any;
  111606. facetPositions?: any;
  111607. facetPartitioning?: any;
  111608. ratio?: number;
  111609. bInfo?: any;
  111610. bbSize?: Vector3;
  111611. subDiv?: any;
  111612. useRightHandedSystem?: boolean;
  111613. depthSort?: boolean;
  111614. distanceTo?: Vector3;
  111615. depthSortedFacets?: any;
  111616. }): void;
  111617. /** @hidden */
  111618. static _ComputeSides(sideOrientation: number, positions: FloatArray, indices: FloatArray, normals: FloatArray, uvs: FloatArray, frontUVs?: Vector4, backUVs?: Vector4): void;
  111619. /**
  111620. * Applies VertexData created from the imported parameters to the geometry
  111621. * @param parsedVertexData the parsed data from an imported file
  111622. * @param geometry the geometry to apply the VertexData to
  111623. */
  111624. static ImportVertexData(parsedVertexData: any, geometry: Geometry): void;
  111625. }
  111626. }
  111627. declare module BABYLON {
  111628. /**
  111629. * Defines a target to use with MorphTargetManager
  111630. * @see https://doc.babylonjs.com/how_to/how_to_use_morphtargets
  111631. */
  111632. export class MorphTarget implements IAnimatable {
  111633. /** defines the name of the target */
  111634. name: string;
  111635. /**
  111636. * Gets or sets the list of animations
  111637. */
  111638. animations: Animation[];
  111639. private _scene;
  111640. private _positions;
  111641. private _normals;
  111642. private _tangents;
  111643. private _uvs;
  111644. private _influence;
  111645. private _uniqueId;
  111646. /**
  111647. * Observable raised when the influence changes
  111648. */
  111649. onInfluenceChanged: Observable<boolean>;
  111650. /** @hidden */
  111651. _onDataLayoutChanged: Observable<void>;
  111652. /**
  111653. * Gets or sets the influence of this target (ie. its weight in the overall morphing)
  111654. */
  111655. get influence(): number;
  111656. set influence(influence: number);
  111657. /**
  111658. * Gets or sets the id of the morph Target
  111659. */
  111660. id: string;
  111661. private _animationPropertiesOverride;
  111662. /**
  111663. * Gets or sets the animation properties override
  111664. */
  111665. get animationPropertiesOverride(): Nullable<AnimationPropertiesOverride>;
  111666. set animationPropertiesOverride(value: Nullable<AnimationPropertiesOverride>);
  111667. /**
  111668. * Creates a new MorphTarget
  111669. * @param name defines the name of the target
  111670. * @param influence defines the influence to use
  111671. * @param scene defines the scene the morphtarget belongs to
  111672. */
  111673. constructor(
  111674. /** defines the name of the target */
  111675. name: string, influence?: number, scene?: Nullable<Scene>);
  111676. /**
  111677. * Gets the unique ID of this manager
  111678. */
  111679. get uniqueId(): number;
  111680. /**
  111681. * Gets a boolean defining if the target contains position data
  111682. */
  111683. get hasPositions(): boolean;
  111684. /**
  111685. * Gets a boolean defining if the target contains normal data
  111686. */
  111687. get hasNormals(): boolean;
  111688. /**
  111689. * Gets a boolean defining if the target contains tangent data
  111690. */
  111691. get hasTangents(): boolean;
  111692. /**
  111693. * Gets a boolean defining if the target contains texture coordinates data
  111694. */
  111695. get hasUVs(): boolean;
  111696. /**
  111697. * Affects position data to this target
  111698. * @param data defines the position data to use
  111699. */
  111700. setPositions(data: Nullable<FloatArray>): void;
  111701. /**
  111702. * Gets the position data stored in this target
  111703. * @returns a FloatArray containing the position data (or null if not present)
  111704. */
  111705. getPositions(): Nullable<FloatArray>;
  111706. /**
  111707. * Affects normal data to this target
  111708. * @param data defines the normal data to use
  111709. */
  111710. setNormals(data: Nullable<FloatArray>): void;
  111711. /**
  111712. * Gets the normal data stored in this target
  111713. * @returns a FloatArray containing the normal data (or null if not present)
  111714. */
  111715. getNormals(): Nullable<FloatArray>;
  111716. /**
  111717. * Affects tangent data to this target
  111718. * @param data defines the tangent data to use
  111719. */
  111720. setTangents(data: Nullable<FloatArray>): void;
  111721. /**
  111722. * Gets the tangent data stored in this target
  111723. * @returns a FloatArray containing the tangent data (or null if not present)
  111724. */
  111725. getTangents(): Nullable<FloatArray>;
  111726. /**
  111727. * Affects texture coordinates data to this target
  111728. * @param data defines the texture coordinates data to use
  111729. */
  111730. setUVs(data: Nullable<FloatArray>): void;
  111731. /**
  111732. * Gets the texture coordinates data stored in this target
  111733. * @returns a FloatArray containing the texture coordinates data (or null if not present)
  111734. */
  111735. getUVs(): Nullable<FloatArray>;
  111736. /**
  111737. * Clone the current target
  111738. * @returns a new MorphTarget
  111739. */
  111740. clone(): MorphTarget;
  111741. /**
  111742. * Serializes the current target into a Serialization object
  111743. * @returns the serialized object
  111744. */
  111745. serialize(): any;
  111746. /**
  111747. * Returns the string "MorphTarget"
  111748. * @returns "MorphTarget"
  111749. */
  111750. getClassName(): string;
  111751. /**
  111752. * Creates a new target from serialized data
  111753. * @param serializationObject defines the serialized data to use
  111754. * @returns a new MorphTarget
  111755. */
  111756. static Parse(serializationObject: any): MorphTarget;
  111757. /**
  111758. * Creates a MorphTarget from mesh data
  111759. * @param mesh defines the source mesh
  111760. * @param name defines the name to use for the new target
  111761. * @param influence defines the influence to attach to the target
  111762. * @returns a new MorphTarget
  111763. */
  111764. static FromMesh(mesh: AbstractMesh, name?: string, influence?: number): MorphTarget;
  111765. }
  111766. }
  111767. declare module BABYLON {
  111768. /**
  111769. * This class is used to deform meshes using morphing between different targets
  111770. * @see https://doc.babylonjs.com/how_to/how_to_use_morphtargets
  111771. */
  111772. export class MorphTargetManager {
  111773. private _targets;
  111774. private _targetInfluenceChangedObservers;
  111775. private _targetDataLayoutChangedObservers;
  111776. private _activeTargets;
  111777. private _scene;
  111778. private _influences;
  111779. private _supportsNormals;
  111780. private _supportsTangents;
  111781. private _supportsUVs;
  111782. private _vertexCount;
  111783. private _uniqueId;
  111784. private _tempInfluences;
  111785. /**
  111786. * Gets or sets a boolean indicating if normals must be morphed
  111787. */
  111788. enableNormalMorphing: boolean;
  111789. /**
  111790. * Gets or sets a boolean indicating if tangents must be morphed
  111791. */
  111792. enableTangentMorphing: boolean;
  111793. /**
  111794. * Gets or sets a boolean indicating if UV must be morphed
  111795. */
  111796. enableUVMorphing: boolean;
  111797. /**
  111798. * Creates a new MorphTargetManager
  111799. * @param scene defines the current scene
  111800. */
  111801. constructor(scene?: Nullable<Scene>);
  111802. /**
  111803. * Gets the unique ID of this manager
  111804. */
  111805. get uniqueId(): number;
  111806. /**
  111807. * Gets the number of vertices handled by this manager
  111808. */
  111809. get vertexCount(): number;
  111810. /**
  111811. * Gets a boolean indicating if this manager supports morphing of normals
  111812. */
  111813. get supportsNormals(): boolean;
  111814. /**
  111815. * Gets a boolean indicating if this manager supports morphing of tangents
  111816. */
  111817. get supportsTangents(): boolean;
  111818. /**
  111819. * Gets a boolean indicating if this manager supports morphing of texture coordinates
  111820. */
  111821. get supportsUVs(): boolean;
  111822. /**
  111823. * Gets the number of targets stored in this manager
  111824. */
  111825. get numTargets(): number;
  111826. /**
  111827. * Gets the number of influencers (ie. the number of targets with influences > 0)
  111828. */
  111829. get numInfluencers(): number;
  111830. /**
  111831. * Gets the list of influences (one per target)
  111832. */
  111833. get influences(): Float32Array;
  111834. /**
  111835. * Gets the active target at specified index. An active target is a target with an influence > 0
  111836. * @param index defines the index to check
  111837. * @returns the requested target
  111838. */
  111839. getActiveTarget(index: number): MorphTarget;
  111840. /**
  111841. * Gets the target at specified index
  111842. * @param index defines the index to check
  111843. * @returns the requested target
  111844. */
  111845. getTarget(index: number): MorphTarget;
  111846. /**
  111847. * Add a new target to this manager
  111848. * @param target defines the target to add
  111849. */
  111850. addTarget(target: MorphTarget): void;
  111851. /**
  111852. * Removes a target from the manager
  111853. * @param target defines the target to remove
  111854. */
  111855. removeTarget(target: MorphTarget): void;
  111856. /**
  111857. * Clone the current manager
  111858. * @returns a new MorphTargetManager
  111859. */
  111860. clone(): MorphTargetManager;
  111861. /**
  111862. * Serializes the current manager into a Serialization object
  111863. * @returns the serialized object
  111864. */
  111865. serialize(): any;
  111866. private _syncActiveTargets;
  111867. /**
  111868. * Syncrhonize the targets with all the meshes using this morph target manager
  111869. */
  111870. synchronize(): void;
  111871. /**
  111872. * Creates a new MorphTargetManager from serialized data
  111873. * @param serializationObject defines the serialized data
  111874. * @param scene defines the hosting scene
  111875. * @returns the new MorphTargetManager
  111876. */
  111877. static Parse(serializationObject: any, scene: Scene): MorphTargetManager;
  111878. }
  111879. }
  111880. declare module BABYLON {
  111881. /**
  111882. * Class used to represent a specific level of detail of a mesh
  111883. * @see https://doc.babylonjs.com/how_to/how_to_use_lod
  111884. */
  111885. export class MeshLODLevel {
  111886. /** Defines the distance where this level should start being displayed */
  111887. distance: number;
  111888. /** Defines the mesh to use to render this level */
  111889. mesh: Nullable<Mesh>;
  111890. /**
  111891. * Creates a new LOD level
  111892. * @param distance defines the distance where this level should star being displayed
  111893. * @param mesh defines the mesh to use to render this level
  111894. */
  111895. constructor(
  111896. /** Defines the distance where this level should start being displayed */
  111897. distance: number,
  111898. /** Defines the mesh to use to render this level */
  111899. mesh: Nullable<Mesh>);
  111900. }
  111901. }
  111902. declare module BABYLON {
  111903. /**
  111904. * Helper class used to generate a canvas to manipulate images
  111905. */
  111906. export class CanvasGenerator {
  111907. /**
  111908. * Create a new canvas (or offscreen canvas depending on the context)
  111909. * @param width defines the expected width
  111910. * @param height defines the expected height
  111911. * @return a new canvas or offscreen canvas
  111912. */
  111913. static CreateCanvas(width: number, height: number): HTMLCanvasElement | OffscreenCanvas;
  111914. }
  111915. }
  111916. declare module BABYLON {
  111917. /**
  111918. * Mesh representing the gorund
  111919. */
  111920. export class GroundMesh extends Mesh {
  111921. /** If octree should be generated */
  111922. generateOctree: boolean;
  111923. private _heightQuads;
  111924. /** @hidden */
  111925. _subdivisionsX: number;
  111926. /** @hidden */
  111927. _subdivisionsY: number;
  111928. /** @hidden */
  111929. _width: number;
  111930. /** @hidden */
  111931. _height: number;
  111932. /** @hidden */
  111933. _minX: number;
  111934. /** @hidden */
  111935. _maxX: number;
  111936. /** @hidden */
  111937. _minZ: number;
  111938. /** @hidden */
  111939. _maxZ: number;
  111940. constructor(name: string, scene: Scene);
  111941. /**
  111942. * "GroundMesh"
  111943. * @returns "GroundMesh"
  111944. */
  111945. getClassName(): string;
  111946. /**
  111947. * The minimum of x and y subdivisions
  111948. */
  111949. get subdivisions(): number;
  111950. /**
  111951. * X subdivisions
  111952. */
  111953. get subdivisionsX(): number;
  111954. /**
  111955. * Y subdivisions
  111956. */
  111957. get subdivisionsY(): number;
  111958. /**
  111959. * This function will update an octree to help to select the right submeshes for rendering, picking and collision computations.
  111960. * Please note that you must have a decent number of submeshes to get performance improvements when using an octree
  111961. * @param chunksCount the number of subdivisions for x and y
  111962. * @param octreeBlocksSize (Default: 32)
  111963. */
  111964. optimize(chunksCount: number, octreeBlocksSize?: number): void;
  111965. /**
  111966. * Returns a height (y) value in the Worl system :
  111967. * the ground altitude at the coordinates (x, z) expressed in the World system.
  111968. * @param x x coordinate
  111969. * @param z z coordinate
  111970. * @returns the ground y position if (x, z) are outside the ground surface.
  111971. */
  111972. getHeightAtCoordinates(x: number, z: number): number;
  111973. /**
  111974. * Returns a normalized vector (Vector3) orthogonal to the ground
  111975. * at the ground coordinates (x, z) expressed in the World system.
  111976. * @param x x coordinate
  111977. * @param z z coordinate
  111978. * @returns Vector3(0.0, 1.0, 0.0) if (x, z) are outside the ground surface.
  111979. */
  111980. getNormalAtCoordinates(x: number, z: number): Vector3;
  111981. /**
  111982. * Updates the Vector3 passed a reference with a normalized vector orthogonal to the ground
  111983. * at the ground coordinates (x, z) expressed in the World system.
  111984. * Doesn't uptade the reference Vector3 if (x, z) are outside the ground surface.
  111985. * @param x x coordinate
  111986. * @param z z coordinate
  111987. * @param ref vector to store the result
  111988. * @returns the GroundMesh.
  111989. */
  111990. getNormalAtCoordinatesToRef(x: number, z: number, ref: Vector3): GroundMesh;
  111991. /**
  111992. * Force the heights to be recomputed for getHeightAtCoordinates() or getNormalAtCoordinates()
  111993. * if the ground has been updated.
  111994. * This can be used in the render loop.
  111995. * @returns the GroundMesh.
  111996. */
  111997. updateCoordinateHeights(): GroundMesh;
  111998. private _getFacetAt;
  111999. private _initHeightQuads;
  112000. private _computeHeightQuads;
  112001. /**
  112002. * Serializes this ground mesh
  112003. * @param serializationObject object to write serialization to
  112004. */
  112005. serialize(serializationObject: any): void;
  112006. /**
  112007. * Parses a serialized ground mesh
  112008. * @param parsedMesh the serialized mesh
  112009. * @param scene the scene to create the ground mesh in
  112010. * @returns the created ground mesh
  112011. */
  112012. static Parse(parsedMesh: any, scene: Scene): GroundMesh;
  112013. }
  112014. }
  112015. declare module BABYLON {
  112016. /**
  112017. * Interface for Physics-Joint data
  112018. * @see https://doc.babylonjs.com/how_to/using_the_physics_engine
  112019. */
  112020. export interface PhysicsJointData {
  112021. /**
  112022. * The main pivot of the joint
  112023. */
  112024. mainPivot?: Vector3;
  112025. /**
  112026. * The connected pivot of the joint
  112027. */
  112028. connectedPivot?: Vector3;
  112029. /**
  112030. * The main axis of the joint
  112031. */
  112032. mainAxis?: Vector3;
  112033. /**
  112034. * The connected axis of the joint
  112035. */
  112036. connectedAxis?: Vector3;
  112037. /**
  112038. * The collision of the joint
  112039. */
  112040. collision?: boolean;
  112041. /**
  112042. * Native Oimo/Cannon/Energy data
  112043. */
  112044. nativeParams?: any;
  112045. }
  112046. /**
  112047. * This is a holder class for the physics joint created by the physics plugin
  112048. * It holds a set of functions to control the underlying joint
  112049. * @see https://doc.babylonjs.com/how_to/using_the_physics_engine
  112050. */
  112051. export class PhysicsJoint {
  112052. /**
  112053. * The type of the physics joint
  112054. */
  112055. type: number;
  112056. /**
  112057. * The data for the physics joint
  112058. */
  112059. jointData: PhysicsJointData;
  112060. private _physicsJoint;
  112061. protected _physicsPlugin: IPhysicsEnginePlugin;
  112062. /**
  112063. * Initializes the physics joint
  112064. * @param type The type of the physics joint
  112065. * @param jointData The data for the physics joint
  112066. */
  112067. constructor(
  112068. /**
  112069. * The type of the physics joint
  112070. */
  112071. type: number,
  112072. /**
  112073. * The data for the physics joint
  112074. */
  112075. jointData: PhysicsJointData);
  112076. /**
  112077. * Gets the physics joint
  112078. */
  112079. get physicsJoint(): any;
  112080. /**
  112081. * Sets the physics joint
  112082. */
  112083. set physicsJoint(newJoint: any);
  112084. /**
  112085. * Sets the physics plugin
  112086. */
  112087. set physicsPlugin(physicsPlugin: IPhysicsEnginePlugin);
  112088. /**
  112089. * Execute a function that is physics-plugin specific.
  112090. * @param {Function} func the function that will be executed.
  112091. * It accepts two parameters: the physics world and the physics joint
  112092. */
  112093. executeNativeFunction(func: (world: any, physicsJoint: any) => void): void;
  112094. /**
  112095. * Distance-Joint type
  112096. */
  112097. static DistanceJoint: number;
  112098. /**
  112099. * Hinge-Joint type
  112100. */
  112101. static HingeJoint: number;
  112102. /**
  112103. * Ball-and-Socket joint type
  112104. */
  112105. static BallAndSocketJoint: number;
  112106. /**
  112107. * Wheel-Joint type
  112108. */
  112109. static WheelJoint: number;
  112110. /**
  112111. * Slider-Joint type
  112112. */
  112113. static SliderJoint: number;
  112114. /**
  112115. * Prismatic-Joint type
  112116. */
  112117. static PrismaticJoint: number;
  112118. /**
  112119. * Universal-Joint type
  112120. * ENERGY FTW! (compare with this - @see http://ode-wiki.org/wiki/index.php?title=Manual:_Joint_Types_and_Functions)
  112121. */
  112122. static UniversalJoint: number;
  112123. /**
  112124. * Hinge-Joint 2 type
  112125. */
  112126. static Hinge2Joint: number;
  112127. /**
  112128. * Point to Point Joint type. Similar to a Ball-Joint. Different in parameters
  112129. */
  112130. static PointToPointJoint: number;
  112131. /**
  112132. * Spring-Joint type
  112133. */
  112134. static SpringJoint: number;
  112135. /**
  112136. * Lock-Joint type
  112137. */
  112138. static LockJoint: number;
  112139. }
  112140. /**
  112141. * A class representing a physics distance joint
  112142. * @see https://doc.babylonjs.com/how_to/using_the_physics_engine
  112143. */
  112144. export class DistanceJoint extends PhysicsJoint {
  112145. /**
  112146. *
  112147. * @param jointData The data for the Distance-Joint
  112148. */
  112149. constructor(jointData: DistanceJointData);
  112150. /**
  112151. * Update the predefined distance.
  112152. * @param maxDistance The maximum preferred distance
  112153. * @param minDistance The minimum preferred distance
  112154. */
  112155. updateDistance(maxDistance: number, minDistance?: number): void;
  112156. }
  112157. /**
  112158. * Represents a Motor-Enabled Joint
  112159. * @see https://doc.babylonjs.com/how_to/using_the_physics_engine
  112160. */
  112161. export class MotorEnabledJoint extends PhysicsJoint implements IMotorEnabledJoint {
  112162. /**
  112163. * Initializes the Motor-Enabled Joint
  112164. * @param type The type of the joint
  112165. * @param jointData The physica joint data for the joint
  112166. */
  112167. constructor(type: number, jointData: PhysicsJointData);
  112168. /**
  112169. * Set the motor values.
  112170. * Attention, this function is plugin specific. Engines won't react 100% the same.
  112171. * @param force the force to apply
  112172. * @param maxForce max force for this motor.
  112173. */
  112174. setMotor(force?: number, maxForce?: number): void;
  112175. /**
  112176. * Set the motor's limits.
  112177. * Attention, this function is plugin specific. Engines won't react 100% the same.
  112178. * @param upperLimit The upper limit of the motor
  112179. * @param lowerLimit The lower limit of the motor
  112180. */
  112181. setLimit(upperLimit: number, lowerLimit?: number): void;
  112182. }
  112183. /**
  112184. * This class represents a single physics Hinge-Joint
  112185. * @see https://doc.babylonjs.com/how_to/using_the_physics_engine
  112186. */
  112187. export class HingeJoint extends MotorEnabledJoint {
  112188. /**
  112189. * Initializes the Hinge-Joint
  112190. * @param jointData The joint data for the Hinge-Joint
  112191. */
  112192. constructor(jointData: PhysicsJointData);
  112193. /**
  112194. * Set the motor values.
  112195. * Attention, this function is plugin specific. Engines won't react 100% the same.
  112196. * @param {number} force the force to apply
  112197. * @param {number} maxForce max force for this motor.
  112198. */
  112199. setMotor(force?: number, maxForce?: number): void;
  112200. /**
  112201. * Set the motor's limits.
  112202. * Attention, this function is plugin specific. Engines won't react 100% the same.
  112203. * @param upperLimit The upper limit of the motor
  112204. * @param lowerLimit The lower limit of the motor
  112205. */
  112206. setLimit(upperLimit: number, lowerLimit?: number): void;
  112207. }
  112208. /**
  112209. * This class represents a dual hinge physics joint (same as wheel joint)
  112210. * @see https://doc.babylonjs.com/how_to/using_the_physics_engine
  112211. */
  112212. export class Hinge2Joint extends MotorEnabledJoint {
  112213. /**
  112214. * Initializes the Hinge2-Joint
  112215. * @param jointData The joint data for the Hinge2-Joint
  112216. */
  112217. constructor(jointData: PhysicsJointData);
  112218. /**
  112219. * Set the motor values.
  112220. * Attention, this function is plugin specific. Engines won't react 100% the same.
  112221. * @param {number} targetSpeed the speed the motor is to reach
  112222. * @param {number} maxForce max force for this motor.
  112223. * @param {motorIndex} the motor's index, 0 or 1.
  112224. */
  112225. setMotor(targetSpeed?: number, maxForce?: number, motorIndex?: number): void;
  112226. /**
  112227. * Set the motor limits.
  112228. * Attention, this function is plugin specific. Engines won't react 100% the same.
  112229. * @param {number} upperLimit the upper limit
  112230. * @param {number} lowerLimit lower limit
  112231. * @param {motorIndex} the motor's index, 0 or 1.
  112232. */
  112233. setLimit(upperLimit: number, lowerLimit?: number, motorIndex?: number): void;
  112234. }
  112235. /**
  112236. * Interface for a motor enabled joint
  112237. * @see https://doc.babylonjs.com/how_to/using_the_physics_engine
  112238. */
  112239. export interface IMotorEnabledJoint {
  112240. /**
  112241. * Physics joint
  112242. */
  112243. physicsJoint: any;
  112244. /**
  112245. * Sets the motor of the motor-enabled joint
  112246. * @param force The force of the motor
  112247. * @param maxForce The maximum force of the motor
  112248. * @param motorIndex The index of the motor
  112249. */
  112250. setMotor(force?: number, maxForce?: number, motorIndex?: number): void;
  112251. /**
  112252. * Sets the limit of the motor
  112253. * @param upperLimit The upper limit of the motor
  112254. * @param lowerLimit The lower limit of the motor
  112255. * @param motorIndex The index of the motor
  112256. */
  112257. setLimit(upperLimit: number, lowerLimit?: number, motorIndex?: number): void;
  112258. }
  112259. /**
  112260. * Joint data for a Distance-Joint
  112261. * @see https://doc.babylonjs.com/how_to/using_the_physics_engine
  112262. */
  112263. export interface DistanceJointData extends PhysicsJointData {
  112264. /**
  112265. * Max distance the 2 joint objects can be apart
  112266. */
  112267. maxDistance: number;
  112268. }
  112269. /**
  112270. * Joint data from a spring joint
  112271. * @see https://doc.babylonjs.com/how_to/using_the_physics_engine
  112272. */
  112273. export interface SpringJointData extends PhysicsJointData {
  112274. /**
  112275. * Length of the spring
  112276. */
  112277. length: number;
  112278. /**
  112279. * Stiffness of the spring
  112280. */
  112281. stiffness: number;
  112282. /**
  112283. * Damping of the spring
  112284. */
  112285. damping: number;
  112286. /** this callback will be called when applying the force to the impostors. */
  112287. forceApplicationCallback: () => void;
  112288. }
  112289. }
  112290. declare module BABYLON {
  112291. /**
  112292. * Holds the data for the raycast result
  112293. * @see https://doc.babylonjs.com/how_to/using_the_physics_engine
  112294. */
  112295. export class PhysicsRaycastResult {
  112296. private _hasHit;
  112297. private _hitDistance;
  112298. private _hitNormalWorld;
  112299. private _hitPointWorld;
  112300. private _rayFromWorld;
  112301. private _rayToWorld;
  112302. /**
  112303. * Gets if there was a hit
  112304. */
  112305. get hasHit(): boolean;
  112306. /**
  112307. * Gets the distance from the hit
  112308. */
  112309. get hitDistance(): number;
  112310. /**
  112311. * Gets the hit normal/direction in the world
  112312. */
  112313. get hitNormalWorld(): Vector3;
  112314. /**
  112315. * Gets the hit point in the world
  112316. */
  112317. get hitPointWorld(): Vector3;
  112318. /**
  112319. * Gets the ray "start point" of the ray in the world
  112320. */
  112321. get rayFromWorld(): Vector3;
  112322. /**
  112323. * Gets the ray "end point" of the ray in the world
  112324. */
  112325. get rayToWorld(): Vector3;
  112326. /**
  112327. * Sets the hit data (normal & point in world space)
  112328. * @param hitNormalWorld defines the normal in world space
  112329. * @param hitPointWorld defines the point in world space
  112330. */
  112331. setHitData(hitNormalWorld: IXYZ, hitPointWorld: IXYZ): void;
  112332. /**
  112333. * Sets the distance from the start point to the hit point
  112334. * @param distance
  112335. */
  112336. setHitDistance(distance: number): void;
  112337. /**
  112338. * Calculates the distance manually
  112339. */
  112340. calculateHitDistance(): void;
  112341. /**
  112342. * Resets all the values to default
  112343. * @param from The from point on world space
  112344. * @param to The to point on world space
  112345. */
  112346. reset(from?: Vector3, to?: Vector3): void;
  112347. }
  112348. /**
  112349. * Interface for the size containing width and height
  112350. */
  112351. interface IXYZ {
  112352. /**
  112353. * X
  112354. */
  112355. x: number;
  112356. /**
  112357. * Y
  112358. */
  112359. y: number;
  112360. /**
  112361. * Z
  112362. */
  112363. z: number;
  112364. }
  112365. }
  112366. declare module BABYLON {
  112367. /**
  112368. * Interface used to describe a physics joint
  112369. */
  112370. export interface PhysicsImpostorJoint {
  112371. /** Defines the main impostor to which the joint is linked */
  112372. mainImpostor: PhysicsImpostor;
  112373. /** Defines the impostor that is connected to the main impostor using this joint */
  112374. connectedImpostor: PhysicsImpostor;
  112375. /** Defines the joint itself */
  112376. joint: PhysicsJoint;
  112377. }
  112378. /** @hidden */
  112379. export interface IPhysicsEnginePlugin {
  112380. world: any;
  112381. name: string;
  112382. setGravity(gravity: Vector3): void;
  112383. setTimeStep(timeStep: number): void;
  112384. getTimeStep(): number;
  112385. executeStep(delta: number, impostors: Array<PhysicsImpostor>): void;
  112386. applyImpulse(impostor: PhysicsImpostor, force: Vector3, contactPoint: Vector3): void;
  112387. applyForce(impostor: PhysicsImpostor, force: Vector3, contactPoint: Vector3): void;
  112388. generatePhysicsBody(impostor: PhysicsImpostor): void;
  112389. removePhysicsBody(impostor: PhysicsImpostor): void;
  112390. generateJoint(joint: PhysicsImpostorJoint): void;
  112391. removeJoint(joint: PhysicsImpostorJoint): void;
  112392. isSupported(): boolean;
  112393. setTransformationFromPhysicsBody(impostor: PhysicsImpostor): void;
  112394. setPhysicsBodyTransformation(impostor: PhysicsImpostor, newPosition: Vector3, newRotation: Quaternion): void;
  112395. setLinearVelocity(impostor: PhysicsImpostor, velocity: Nullable<Vector3>): void;
  112396. setAngularVelocity(impostor: PhysicsImpostor, velocity: Nullable<Vector3>): void;
  112397. getLinearVelocity(impostor: PhysicsImpostor): Nullable<Vector3>;
  112398. getAngularVelocity(impostor: PhysicsImpostor): Nullable<Vector3>;
  112399. setBodyMass(impostor: PhysicsImpostor, mass: number): void;
  112400. getBodyMass(impostor: PhysicsImpostor): number;
  112401. getBodyFriction(impostor: PhysicsImpostor): number;
  112402. setBodyFriction(impostor: PhysicsImpostor, friction: number): void;
  112403. getBodyRestitution(impostor: PhysicsImpostor): number;
  112404. setBodyRestitution(impostor: PhysicsImpostor, restitution: number): void;
  112405. getBodyPressure?(impostor: PhysicsImpostor): number;
  112406. setBodyPressure?(impostor: PhysicsImpostor, pressure: number): void;
  112407. getBodyStiffness?(impostor: PhysicsImpostor): number;
  112408. setBodyStiffness?(impostor: PhysicsImpostor, stiffness: number): void;
  112409. getBodyVelocityIterations?(impostor: PhysicsImpostor): number;
  112410. setBodyVelocityIterations?(impostor: PhysicsImpostor, velocityIterations: number): void;
  112411. getBodyPositionIterations?(impostor: PhysicsImpostor): number;
  112412. setBodyPositionIterations?(impostor: PhysicsImpostor, positionIterations: number): void;
  112413. appendAnchor?(impostor: PhysicsImpostor, otherImpostor: PhysicsImpostor, width: number, height: number, influence: number, noCollisionBetweenLinkedBodies: boolean): void;
  112414. appendHook?(impostor: PhysicsImpostor, otherImpostor: PhysicsImpostor, length: number, influence: number, noCollisionBetweenLinkedBodies: boolean): void;
  112415. sleepBody(impostor: PhysicsImpostor): void;
  112416. wakeUpBody(impostor: PhysicsImpostor): void;
  112417. raycast(from: Vector3, to: Vector3): PhysicsRaycastResult;
  112418. updateDistanceJoint(joint: PhysicsJoint, maxDistance: number, minDistance?: number): void;
  112419. setMotor(joint: IMotorEnabledJoint, speed: number, maxForce?: number, motorIndex?: number): void;
  112420. setLimit(joint: IMotorEnabledJoint, upperLimit: number, lowerLimit?: number, motorIndex?: number): void;
  112421. getRadius(impostor: PhysicsImpostor): number;
  112422. getBoxSizeToRef(impostor: PhysicsImpostor, result: Vector3): void;
  112423. syncMeshWithImpostor(mesh: AbstractMesh, impostor: PhysicsImpostor): void;
  112424. dispose(): void;
  112425. }
  112426. /**
  112427. * Interface used to define a physics engine
  112428. * @see https://doc.babylonjs.com/how_to/using_the_physics_engine
  112429. */
  112430. export interface IPhysicsEngine {
  112431. /**
  112432. * Gets the gravity vector used by the simulation
  112433. */
  112434. gravity: Vector3;
  112435. /**
  112436. * Sets the gravity vector used by the simulation
  112437. * @param gravity defines the gravity vector to use
  112438. */
  112439. setGravity(gravity: Vector3): void;
  112440. /**
  112441. * Set the time step of the physics engine.
  112442. * Default is 1/60.
  112443. * To slow it down, enter 1/600 for example.
  112444. * To speed it up, 1/30
  112445. * @param newTimeStep the new timestep to apply to this world.
  112446. */
  112447. setTimeStep(newTimeStep: number): void;
  112448. /**
  112449. * Get the time step of the physics engine.
  112450. * @returns the current time step
  112451. */
  112452. getTimeStep(): number;
  112453. /**
  112454. * Set the sub time step of the physics engine.
  112455. * Default is 0 meaning there is no sub steps
  112456. * To increase physics resolution precision, set a small value (like 1 ms)
  112457. * @param subTimeStep defines the new sub timestep used for physics resolution.
  112458. */
  112459. setSubTimeStep(subTimeStep: number): void;
  112460. /**
  112461. * Get the sub time step of the physics engine.
  112462. * @returns the current sub time step
  112463. */
  112464. getSubTimeStep(): number;
  112465. /**
  112466. * Release all resources
  112467. */
  112468. dispose(): void;
  112469. /**
  112470. * Gets the name of the current physics plugin
  112471. * @returns the name of the plugin
  112472. */
  112473. getPhysicsPluginName(): string;
  112474. /**
  112475. * Adding a new impostor for the impostor tracking.
  112476. * This will be done by the impostor itself.
  112477. * @param impostor the impostor to add
  112478. */
  112479. addImpostor(impostor: PhysicsImpostor): void;
  112480. /**
  112481. * Remove an impostor from the engine.
  112482. * This impostor and its mesh will not longer be updated by the physics engine.
  112483. * @param impostor the impostor to remove
  112484. */
  112485. removeImpostor(impostor: PhysicsImpostor): void;
  112486. /**
  112487. * Add a joint to the physics engine
  112488. * @param mainImpostor defines the main impostor to which the joint is added.
  112489. * @param connectedImpostor defines the impostor that is connected to the main impostor using this joint
  112490. * @param joint defines the joint that will connect both impostors.
  112491. */
  112492. addJoint(mainImpostor: PhysicsImpostor, connectedImpostor: PhysicsImpostor, joint: PhysicsJoint): void;
  112493. /**
  112494. * Removes a joint from the simulation
  112495. * @param mainImpostor defines the impostor used with the joint
  112496. * @param connectedImpostor defines the other impostor connected to the main one by the joint
  112497. * @param joint defines the joint to remove
  112498. */
  112499. removeJoint(mainImpostor: PhysicsImpostor, connectedImpostor: PhysicsImpostor, joint: PhysicsJoint): void;
  112500. /**
  112501. * Gets the current plugin used to run the simulation
  112502. * @returns current plugin
  112503. */
  112504. getPhysicsPlugin(): IPhysicsEnginePlugin;
  112505. /**
  112506. * Gets the list of physic impostors
  112507. * @returns an array of PhysicsImpostor
  112508. */
  112509. getImpostors(): Array<PhysicsImpostor>;
  112510. /**
  112511. * Gets the impostor for a physics enabled object
  112512. * @param object defines the object impersonated by the impostor
  112513. * @returns the PhysicsImpostor or null if not found
  112514. */
  112515. getImpostorForPhysicsObject(object: IPhysicsEnabledObject): Nullable<PhysicsImpostor>;
  112516. /**
  112517. * Gets the impostor for a physics body object
  112518. * @param body defines physics body used by the impostor
  112519. * @returns the PhysicsImpostor or null if not found
  112520. */
  112521. getImpostorWithPhysicsBody(body: any): Nullable<PhysicsImpostor>;
  112522. /**
  112523. * Does a raycast in the physics world
  112524. * @param from when should the ray start?
  112525. * @param to when should the ray end?
  112526. * @returns PhysicsRaycastResult
  112527. */
  112528. raycast(from: Vector3, to: Vector3): PhysicsRaycastResult;
  112529. /**
  112530. * Called by the scene. No need to call it.
  112531. * @param delta defines the timespam between frames
  112532. */
  112533. _step(delta: number): void;
  112534. }
  112535. }
  112536. declare module BABYLON {
  112537. /**
  112538. * The interface for the physics imposter parameters
  112539. * @see https://doc.babylonjs.com/how_to/using_the_physics_engine
  112540. */
  112541. export interface PhysicsImpostorParameters {
  112542. /**
  112543. * The mass of the physics imposter
  112544. */
  112545. mass: number;
  112546. /**
  112547. * The friction of the physics imposter
  112548. */
  112549. friction?: number;
  112550. /**
  112551. * The coefficient of restitution of the physics imposter
  112552. */
  112553. restitution?: number;
  112554. /**
  112555. * The native options of the physics imposter
  112556. */
  112557. nativeOptions?: any;
  112558. /**
  112559. * Specifies if the parent should be ignored
  112560. */
  112561. ignoreParent?: boolean;
  112562. /**
  112563. * Specifies if bi-directional transformations should be disabled
  112564. */
  112565. disableBidirectionalTransformation?: boolean;
  112566. /**
  112567. * The pressure inside the physics imposter, soft object only
  112568. */
  112569. pressure?: number;
  112570. /**
  112571. * The stiffness the physics imposter, soft object only
  112572. */
  112573. stiffness?: number;
  112574. /**
  112575. * The number of iterations used in maintaining consistent vertex velocities, soft object only
  112576. */
  112577. velocityIterations?: number;
  112578. /**
  112579. * The number of iterations used in maintaining consistent vertex positions, soft object only
  112580. */
  112581. positionIterations?: number;
  112582. /**
  112583. * The number used to fix points on a cloth (0, 1, 2, 4, 8) or rope (0, 1, 2) only
  112584. * 0 None, 1, back left or top, 2, back right or bottom, 4, front left, 8, front right
  112585. * Add to fix multiple points
  112586. */
  112587. fixedPoints?: number;
  112588. /**
  112589. * The collision margin around a soft object
  112590. */
  112591. margin?: number;
  112592. /**
  112593. * The collision margin around a soft object
  112594. */
  112595. damping?: number;
  112596. /**
  112597. * The path for a rope based on an extrusion
  112598. */
  112599. path?: any;
  112600. /**
  112601. * The shape of an extrusion used for a rope based on an extrusion
  112602. */
  112603. shape?: any;
  112604. }
  112605. /**
  112606. * Interface for a physics-enabled object
  112607. * @see https://doc.babylonjs.com/how_to/using_the_physics_engine
  112608. */
  112609. export interface IPhysicsEnabledObject {
  112610. /**
  112611. * The position of the physics-enabled object
  112612. */
  112613. position: Vector3;
  112614. /**
  112615. * The rotation of the physics-enabled object
  112616. */
  112617. rotationQuaternion: Nullable<Quaternion>;
  112618. /**
  112619. * The scale of the physics-enabled object
  112620. */
  112621. scaling: Vector3;
  112622. /**
  112623. * The rotation of the physics-enabled object
  112624. */
  112625. rotation?: Vector3;
  112626. /**
  112627. * The parent of the physics-enabled object
  112628. */
  112629. parent?: any;
  112630. /**
  112631. * The bounding info of the physics-enabled object
  112632. * @returns The bounding info of the physics-enabled object
  112633. */
  112634. getBoundingInfo(): BoundingInfo;
  112635. /**
  112636. * Computes the world matrix
  112637. * @param force Specifies if the world matrix should be computed by force
  112638. * @returns A world matrix
  112639. */
  112640. computeWorldMatrix(force: boolean): Matrix;
  112641. /**
  112642. * Gets the world matrix
  112643. * @returns A world matrix
  112644. */
  112645. getWorldMatrix?(): Matrix;
  112646. /**
  112647. * Gets the child meshes
  112648. * @param directDescendantsOnly Specifies if only direct-descendants should be obtained
  112649. * @returns An array of abstract meshes
  112650. */
  112651. getChildMeshes?(directDescendantsOnly?: boolean): Array<AbstractMesh>;
  112652. /**
  112653. * Gets the vertex data
  112654. * @param kind The type of vertex data
  112655. * @returns A nullable array of numbers, or a float32 array
  112656. */
  112657. getVerticesData(kind: string): Nullable<Array<number> | Float32Array>;
  112658. /**
  112659. * Gets the indices from the mesh
  112660. * @returns A nullable array of index arrays
  112661. */
  112662. getIndices?(): Nullable<IndicesArray>;
  112663. /**
  112664. * Gets the scene from the mesh
  112665. * @returns the indices array or null
  112666. */
  112667. getScene?(): Scene;
  112668. /**
  112669. * Gets the absolute position from the mesh
  112670. * @returns the absolute position
  112671. */
  112672. getAbsolutePosition(): Vector3;
  112673. /**
  112674. * Gets the absolute pivot point from the mesh
  112675. * @returns the absolute pivot point
  112676. */
  112677. getAbsolutePivotPoint(): Vector3;
  112678. /**
  112679. * Rotates the mesh
  112680. * @param axis The axis of rotation
  112681. * @param amount The amount of rotation
  112682. * @param space The space of the rotation
  112683. * @returns The rotation transform node
  112684. */
  112685. rotate(axis: Vector3, amount: number, space?: Space): TransformNode;
  112686. /**
  112687. * Translates the mesh
  112688. * @param axis The axis of translation
  112689. * @param distance The distance of translation
  112690. * @param space The space of the translation
  112691. * @returns The transform node
  112692. */
  112693. translate(axis: Vector3, distance: number, space?: Space): TransformNode;
  112694. /**
  112695. * Sets the absolute position of the mesh
  112696. * @param absolutePosition The absolute position of the mesh
  112697. * @returns The transform node
  112698. */
  112699. setAbsolutePosition(absolutePosition: Vector3): TransformNode;
  112700. /**
  112701. * Gets the class name of the mesh
  112702. * @returns The class name
  112703. */
  112704. getClassName(): string;
  112705. }
  112706. /**
  112707. * Represents a physics imposter
  112708. * @see https://doc.babylonjs.com/how_to/using_the_physics_engine
  112709. */
  112710. export class PhysicsImpostor {
  112711. /**
  112712. * The physics-enabled object used as the physics imposter
  112713. */
  112714. object: IPhysicsEnabledObject;
  112715. /**
  112716. * The type of the physics imposter
  112717. */
  112718. type: number;
  112719. private _options;
  112720. private _scene?;
  112721. /**
  112722. * The default object size of the imposter
  112723. */
  112724. static DEFAULT_OBJECT_SIZE: Vector3;
  112725. /**
  112726. * The identity quaternion of the imposter
  112727. */
  112728. static IDENTITY_QUATERNION: Quaternion;
  112729. /** @hidden */
  112730. _pluginData: any;
  112731. private _physicsEngine;
  112732. private _physicsBody;
  112733. private _bodyUpdateRequired;
  112734. private _onBeforePhysicsStepCallbacks;
  112735. private _onAfterPhysicsStepCallbacks;
  112736. /** @hidden */
  112737. _onPhysicsCollideCallbacks: Array<{
  112738. callback: (collider: PhysicsImpostor, collidedAgainst: PhysicsImpostor, point: Nullable<Vector3>) => void;
  112739. otherImpostors: Array<PhysicsImpostor>;
  112740. }>;
  112741. private _deltaPosition;
  112742. private _deltaRotation;
  112743. private _deltaRotationConjugated;
  112744. /** @hidden */
  112745. _isFromLine: boolean;
  112746. private _parent;
  112747. private _isDisposed;
  112748. private static _tmpVecs;
  112749. private static _tmpQuat;
  112750. /**
  112751. * Specifies if the physics imposter is disposed
  112752. */
  112753. get isDisposed(): boolean;
  112754. /**
  112755. * Gets the mass of the physics imposter
  112756. */
  112757. get mass(): number;
  112758. set mass(value: number);
  112759. /**
  112760. * Gets the coefficient of friction
  112761. */
  112762. get friction(): number;
  112763. /**
  112764. * Sets the coefficient of friction
  112765. */
  112766. set friction(value: number);
  112767. /**
  112768. * Gets the coefficient of restitution
  112769. */
  112770. get restitution(): number;
  112771. /**
  112772. * Sets the coefficient of restitution
  112773. */
  112774. set restitution(value: number);
  112775. /**
  112776. * Gets the pressure of a soft body; only supported by the AmmoJSPlugin
  112777. */
  112778. get pressure(): number;
  112779. /**
  112780. * Sets the pressure of a soft body; only supported by the AmmoJSPlugin
  112781. */
  112782. set pressure(value: number);
  112783. /**
  112784. * Gets the stiffness of a soft body; only supported by the AmmoJSPlugin
  112785. */
  112786. get stiffness(): number;
  112787. /**
  112788. * Sets the stiffness of a soft body; only supported by the AmmoJSPlugin
  112789. */
  112790. set stiffness(value: number);
  112791. /**
  112792. * Gets the velocityIterations of a soft body; only supported by the AmmoJSPlugin
  112793. */
  112794. get velocityIterations(): number;
  112795. /**
  112796. * Sets the velocityIterations of a soft body; only supported by the AmmoJSPlugin
  112797. */
  112798. set velocityIterations(value: number);
  112799. /**
  112800. * Gets the positionIterations of a soft body; only supported by the AmmoJSPlugin
  112801. */
  112802. get positionIterations(): number;
  112803. /**
  112804. * Sets the positionIterations of a soft body; only supported by the AmmoJSPlugin
  112805. */
  112806. set positionIterations(value: number);
  112807. /**
  112808. * The unique id of the physics imposter
  112809. * set by the physics engine when adding this impostor to the array
  112810. */
  112811. uniqueId: number;
  112812. /**
  112813. * @hidden
  112814. */
  112815. soft: boolean;
  112816. /**
  112817. * @hidden
  112818. */
  112819. segments: number;
  112820. private _joints;
  112821. /**
  112822. * Initializes the physics imposter
  112823. * @param object The physics-enabled object used as the physics imposter
  112824. * @param type The type of the physics imposter
  112825. * @param _options The options for the physics imposter
  112826. * @param _scene The Babylon scene
  112827. */
  112828. constructor(
  112829. /**
  112830. * The physics-enabled object used as the physics imposter
  112831. */
  112832. object: IPhysicsEnabledObject,
  112833. /**
  112834. * The type of the physics imposter
  112835. */
  112836. type: number, _options?: PhysicsImpostorParameters, _scene?: Scene | undefined);
  112837. /**
  112838. * This function will completly initialize this impostor.
  112839. * It will create a new body - but only if this mesh has no parent.
  112840. * If it has, this impostor will not be used other than to define the impostor
  112841. * of the child mesh.
  112842. * @hidden
  112843. */
  112844. _init(): void;
  112845. private _getPhysicsParent;
  112846. /**
  112847. * Should a new body be generated.
  112848. * @returns boolean specifying if body initialization is required
  112849. */
  112850. isBodyInitRequired(): boolean;
  112851. /**
  112852. * Sets the updated scaling
  112853. * @param updated Specifies if the scaling is updated
  112854. */
  112855. setScalingUpdated(): void;
  112856. /**
  112857. * Force a regeneration of this or the parent's impostor's body.
  112858. * Use under cautious - This will remove all joints already implemented.
  112859. */
  112860. forceUpdate(): void;
  112861. /**
  112862. * Gets the body that holds this impostor. Either its own, or its parent.
  112863. */
  112864. get physicsBody(): any;
  112865. /**
  112866. * Get the parent of the physics imposter
  112867. * @returns Physics imposter or null
  112868. */
  112869. get parent(): Nullable<PhysicsImpostor>;
  112870. /**
  112871. * Sets the parent of the physics imposter
  112872. */
  112873. set parent(value: Nullable<PhysicsImpostor>);
  112874. /**
  112875. * Set the physics body. Used mainly by the physics engine/plugin
  112876. */
  112877. set physicsBody(physicsBody: any);
  112878. /**
  112879. * Resets the update flags
  112880. */
  112881. resetUpdateFlags(): void;
  112882. /**
  112883. * Gets the object extend size
  112884. * @returns the object extend size
  112885. */
  112886. getObjectExtendSize(): Vector3;
  112887. /**
  112888. * Gets the object center
  112889. * @returns The object center
  112890. */
  112891. getObjectCenter(): Vector3;
  112892. /**
  112893. * Get a specific parameter from the options parameters
  112894. * @param paramName The object parameter name
  112895. * @returns The object parameter
  112896. */
  112897. getParam(paramName: string): any;
  112898. /**
  112899. * Sets a specific parameter in the options given to the physics plugin
  112900. * @param paramName The parameter name
  112901. * @param value The value of the parameter
  112902. */
  112903. setParam(paramName: string, value: number): void;
  112904. /**
  112905. * Specifically change the body's mass option. Won't recreate the physics body object
  112906. * @param mass The mass of the physics imposter
  112907. */
  112908. setMass(mass: number): void;
  112909. /**
  112910. * Gets the linear velocity
  112911. * @returns linear velocity or null
  112912. */
  112913. getLinearVelocity(): Nullable<Vector3>;
  112914. /**
  112915. * Sets the linear velocity
  112916. * @param velocity linear velocity or null
  112917. */
  112918. setLinearVelocity(velocity: Nullable<Vector3>): void;
  112919. /**
  112920. * Gets the angular velocity
  112921. * @returns angular velocity or null
  112922. */
  112923. getAngularVelocity(): Nullable<Vector3>;
  112924. /**
  112925. * Sets the angular velocity
  112926. * @param velocity The velocity or null
  112927. */
  112928. setAngularVelocity(velocity: Nullable<Vector3>): void;
  112929. /**
  112930. * Execute a function with the physics plugin native code
  112931. * Provide a function the will have two variables - the world object and the physics body object
  112932. * @param func The function to execute with the physics plugin native code
  112933. */
  112934. executeNativeFunction(func: (world: any, physicsBody: any) => void): void;
  112935. /**
  112936. * Register a function that will be executed before the physics world is stepping forward
  112937. * @param func The function to execute before the physics world is stepped forward
  112938. */
  112939. registerBeforePhysicsStep(func: (impostor: PhysicsImpostor) => void): void;
  112940. /**
  112941. * Unregister a function that will be executed before the physics world is stepping forward
  112942. * @param func The function to execute before the physics world is stepped forward
  112943. */
  112944. unregisterBeforePhysicsStep(func: (impostor: PhysicsImpostor) => void): void;
  112945. /**
  112946. * Register a function that will be executed after the physics step
  112947. * @param func The function to execute after physics step
  112948. */
  112949. registerAfterPhysicsStep(func: (impostor: PhysicsImpostor) => void): void;
  112950. /**
  112951. * Unregisters a function that will be executed after the physics step
  112952. * @param func The function to execute after physics step
  112953. */
  112954. unregisterAfterPhysicsStep(func: (impostor: PhysicsImpostor) => void): void;
  112955. /**
  112956. * register a function that will be executed when this impostor collides against a different body
  112957. * @param collideAgainst Physics imposter, or array of physics imposters to collide against
  112958. * @param func Callback that is executed on collision
  112959. */
  112960. registerOnPhysicsCollide(collideAgainst: PhysicsImpostor | Array<PhysicsImpostor>, func: (collider: PhysicsImpostor, collidedAgainst: PhysicsImpostor) => void): void;
  112961. /**
  112962. * Unregisters the physics imposter on contact
  112963. * @param collideAgainst The physics object to collide against
  112964. * @param func Callback to execute on collision
  112965. */
  112966. unregisterOnPhysicsCollide(collideAgainst: PhysicsImpostor | Array<PhysicsImpostor>, func: (collider: PhysicsImpostor, collidedAgainst: PhysicsImpostor | Array<PhysicsImpostor>) => void): void;
  112967. private _tmpQuat;
  112968. private _tmpQuat2;
  112969. /**
  112970. * Get the parent rotation
  112971. * @returns The parent rotation
  112972. */
  112973. getParentsRotation(): Quaternion;
  112974. /**
  112975. * this function is executed by the physics engine.
  112976. */
  112977. beforeStep: () => void;
  112978. /**
  112979. * this function is executed by the physics engine
  112980. */
  112981. afterStep: () => void;
  112982. /**
  112983. * Legacy collision detection event support
  112984. */
  112985. onCollideEvent: Nullable<(collider: PhysicsImpostor, collidedWith: PhysicsImpostor) => void>;
  112986. /**
  112987. * event and body object due to cannon's event-based architecture.
  112988. */
  112989. onCollide: (e: {
  112990. body: any;
  112991. point: Nullable<Vector3>;
  112992. }) => void;
  112993. /**
  112994. * Apply a force
  112995. * @param force The force to apply
  112996. * @param contactPoint The contact point for the force
  112997. * @returns The physics imposter
  112998. */
  112999. applyForce(force: Vector3, contactPoint: Vector3): PhysicsImpostor;
  113000. /**
  113001. * Apply an impulse
  113002. * @param force The impulse force
  113003. * @param contactPoint The contact point for the impulse force
  113004. * @returns The physics imposter
  113005. */
  113006. applyImpulse(force: Vector3, contactPoint: Vector3): PhysicsImpostor;
  113007. /**
  113008. * A help function to create a joint
  113009. * @param otherImpostor A physics imposter used to create a joint
  113010. * @param jointType The type of joint
  113011. * @param jointData The data for the joint
  113012. * @returns The physics imposter
  113013. */
  113014. createJoint(otherImpostor: PhysicsImpostor, jointType: number, jointData: PhysicsJointData): PhysicsImpostor;
  113015. /**
  113016. * Add a joint to this impostor with a different impostor
  113017. * @param otherImpostor A physics imposter used to add a joint
  113018. * @param joint The joint to add
  113019. * @returns The physics imposter
  113020. */
  113021. addJoint(otherImpostor: PhysicsImpostor, joint: PhysicsJoint): PhysicsImpostor;
  113022. /**
  113023. * Add an anchor to a cloth impostor
  113024. * @param otherImpostor rigid impostor to anchor to
  113025. * @param width ratio across width from 0 to 1
  113026. * @param height ratio up height from 0 to 1
  113027. * @param influence the elasticity between cloth impostor and anchor from 0, very stretchy to 1, little strech
  113028. * @param noCollisionBetweenLinkedBodies when true collisions between cloth impostor and anchor are ignored; default false
  113029. * @returns impostor the soft imposter
  113030. */
  113031. addAnchor(otherImpostor: PhysicsImpostor, width: number, height: number, influence: number, noCollisionBetweenLinkedBodies: boolean): PhysicsImpostor;
  113032. /**
  113033. * Add a hook to a rope impostor
  113034. * @param otherImpostor rigid impostor to anchor to
  113035. * @param length ratio across rope from 0 to 1
  113036. * @param influence the elasticity between rope impostor and anchor from 0, very stretchy to 1, little strech
  113037. * @param noCollisionBetweenLinkedBodies when true collisions between soft impostor and anchor are ignored; default false
  113038. * @returns impostor the rope imposter
  113039. */
  113040. addHook(otherImpostor: PhysicsImpostor, length: number, influence: number, noCollisionBetweenLinkedBodies: boolean): PhysicsImpostor;
  113041. /**
  113042. * Will keep this body still, in a sleep mode.
  113043. * @returns the physics imposter
  113044. */
  113045. sleep(): PhysicsImpostor;
  113046. /**
  113047. * Wake the body up.
  113048. * @returns The physics imposter
  113049. */
  113050. wakeUp(): PhysicsImpostor;
  113051. /**
  113052. * Clones the physics imposter
  113053. * @param newObject The physics imposter clones to this physics-enabled object
  113054. * @returns A nullable physics imposter
  113055. */
  113056. clone(newObject: IPhysicsEnabledObject): Nullable<PhysicsImpostor>;
  113057. /**
  113058. * Disposes the physics imposter
  113059. */
  113060. dispose(): void;
  113061. /**
  113062. * Sets the delta position
  113063. * @param position The delta position amount
  113064. */
  113065. setDeltaPosition(position: Vector3): void;
  113066. /**
  113067. * Sets the delta rotation
  113068. * @param rotation The delta rotation amount
  113069. */
  113070. setDeltaRotation(rotation: Quaternion): void;
  113071. /**
  113072. * Gets the box size of the physics imposter and stores the result in the input parameter
  113073. * @param result Stores the box size
  113074. * @returns The physics imposter
  113075. */
  113076. getBoxSizeToRef(result: Vector3): PhysicsImpostor;
  113077. /**
  113078. * Gets the radius of the physics imposter
  113079. * @returns Radius of the physics imposter
  113080. */
  113081. getRadius(): number;
  113082. /**
  113083. * Sync a bone with this impostor
  113084. * @param bone The bone to sync to the impostor.
  113085. * @param boneMesh The mesh that the bone is influencing.
  113086. * @param jointPivot The pivot of the joint / bone in local space.
  113087. * @param distToJoint Optional distance from the impostor to the joint.
  113088. * @param adjustRotation Optional quaternion for adjusting the local rotation of the bone.
  113089. */
  113090. syncBoneWithImpostor(bone: Bone, boneMesh: AbstractMesh, jointPivot: Vector3, distToJoint?: number, adjustRotation?: Quaternion): void;
  113091. /**
  113092. * Sync impostor to a bone
  113093. * @param bone The bone that the impostor will be synced to.
  113094. * @param boneMesh The mesh that the bone is influencing.
  113095. * @param jointPivot The pivot of the joint / bone in local space.
  113096. * @param distToJoint Optional distance from the impostor to the joint.
  113097. * @param adjustRotation Optional quaternion for adjusting the local rotation of the bone.
  113098. * @param boneAxis Optional vector3 axis the bone is aligned with
  113099. */
  113100. syncImpostorWithBone(bone: Bone, boneMesh: AbstractMesh, jointPivot: Vector3, distToJoint?: number, adjustRotation?: Quaternion, boneAxis?: Vector3): void;
  113101. /**
  113102. * No-Imposter type
  113103. */
  113104. static NoImpostor: number;
  113105. /**
  113106. * Sphere-Imposter type
  113107. */
  113108. static SphereImpostor: number;
  113109. /**
  113110. * Box-Imposter type
  113111. */
  113112. static BoxImpostor: number;
  113113. /**
  113114. * Plane-Imposter type
  113115. */
  113116. static PlaneImpostor: number;
  113117. /**
  113118. * Mesh-imposter type
  113119. */
  113120. static MeshImpostor: number;
  113121. /**
  113122. * Capsule-Impostor type (Ammo.js plugin only)
  113123. */
  113124. static CapsuleImpostor: number;
  113125. /**
  113126. * Cylinder-Imposter type
  113127. */
  113128. static CylinderImpostor: number;
  113129. /**
  113130. * Particle-Imposter type
  113131. */
  113132. static ParticleImpostor: number;
  113133. /**
  113134. * Heightmap-Imposter type
  113135. */
  113136. static HeightmapImpostor: number;
  113137. /**
  113138. * ConvexHull-Impostor type (Ammo.js plugin only)
  113139. */
  113140. static ConvexHullImpostor: number;
  113141. /**
  113142. * Custom-Imposter type (Ammo.js plugin only)
  113143. */
  113144. static CustomImpostor: number;
  113145. /**
  113146. * Rope-Imposter type
  113147. */
  113148. static RopeImpostor: number;
  113149. /**
  113150. * Cloth-Imposter type
  113151. */
  113152. static ClothImpostor: number;
  113153. /**
  113154. * Softbody-Imposter type
  113155. */
  113156. static SoftbodyImpostor: number;
  113157. }
  113158. }
  113159. declare module BABYLON {
  113160. /**
  113161. * @hidden
  113162. **/
  113163. export class _CreationDataStorage {
  113164. closePath?: boolean;
  113165. closeArray?: boolean;
  113166. idx: number[];
  113167. dashSize: number;
  113168. gapSize: number;
  113169. path3D: Path3D;
  113170. pathArray: Vector3[][];
  113171. arc: number;
  113172. radius: number;
  113173. cap: number;
  113174. tessellation: number;
  113175. }
  113176. /**
  113177. * @hidden
  113178. **/
  113179. class _InstanceDataStorage {
  113180. visibleInstances: any;
  113181. batchCache: _InstancesBatch;
  113182. instancesBufferSize: number;
  113183. instancesBuffer: Nullable<Buffer>;
  113184. instancesData: Float32Array;
  113185. overridenInstanceCount: number;
  113186. isFrozen: boolean;
  113187. previousBatch: Nullable<_InstancesBatch>;
  113188. hardwareInstancedRendering: boolean;
  113189. sideOrientation: number;
  113190. manualUpdate: boolean;
  113191. previousRenderId: number;
  113192. }
  113193. /**
  113194. * @hidden
  113195. **/
  113196. export class _InstancesBatch {
  113197. mustReturn: boolean;
  113198. visibleInstances: Nullable<InstancedMesh[]>[];
  113199. renderSelf: boolean[];
  113200. hardwareInstancedRendering: boolean[];
  113201. }
  113202. /**
  113203. * @hidden
  113204. **/
  113205. class _ThinInstanceDataStorage {
  113206. instancesCount: number;
  113207. matrixBuffer: Nullable<Buffer>;
  113208. matrixBufferSize: number;
  113209. matrixData: Nullable<Float32Array>;
  113210. boundingVectors: Array<Vector3>;
  113211. worldMatrices: Nullable<Matrix[]>;
  113212. }
  113213. /**
  113214. * Class used to represent renderable models
  113215. */
  113216. export class Mesh extends AbstractMesh implements IGetSetVerticesData {
  113217. /**
  113218. * Mesh side orientation : usually the external or front surface
  113219. */
  113220. static readonly FRONTSIDE: number;
  113221. /**
  113222. * Mesh side orientation : usually the internal or back surface
  113223. */
  113224. static readonly BACKSIDE: number;
  113225. /**
  113226. * Mesh side orientation : both internal and external or front and back surfaces
  113227. */
  113228. static readonly DOUBLESIDE: number;
  113229. /**
  113230. * Mesh side orientation : by default, `FRONTSIDE`
  113231. */
  113232. static readonly DEFAULTSIDE: number;
  113233. /**
  113234. * Mesh cap setting : no cap
  113235. */
  113236. static readonly NO_CAP: number;
  113237. /**
  113238. * Mesh cap setting : one cap at the beginning of the mesh
  113239. */
  113240. static readonly CAP_START: number;
  113241. /**
  113242. * Mesh cap setting : one cap at the end of the mesh
  113243. */
  113244. static readonly CAP_END: number;
  113245. /**
  113246. * Mesh cap setting : two caps, one at the beginning and one at the end of the mesh
  113247. */
  113248. static readonly CAP_ALL: number;
  113249. /**
  113250. * Mesh pattern setting : no flip or rotate
  113251. */
  113252. static readonly NO_FLIP: number;
  113253. /**
  113254. * Mesh pattern setting : flip (reflect in y axis) alternate tiles on each row or column
  113255. */
  113256. static readonly FLIP_TILE: number;
  113257. /**
  113258. * Mesh pattern setting : rotate (180degs) alternate tiles on each row or column
  113259. */
  113260. static readonly ROTATE_TILE: number;
  113261. /**
  113262. * Mesh pattern setting : flip (reflect in y axis) all tiles on alternate rows
  113263. */
  113264. static readonly FLIP_ROW: number;
  113265. /**
  113266. * Mesh pattern setting : rotate (180degs) all tiles on alternate rows
  113267. */
  113268. static readonly ROTATE_ROW: number;
  113269. /**
  113270. * Mesh pattern setting : flip and rotate alternate tiles on each row or column
  113271. */
  113272. static readonly FLIP_N_ROTATE_TILE: number;
  113273. /**
  113274. * Mesh pattern setting : rotate pattern and rotate
  113275. */
  113276. static readonly FLIP_N_ROTATE_ROW: number;
  113277. /**
  113278. * Mesh tile positioning : part tiles same on left/right or top/bottom
  113279. */
  113280. static readonly CENTER: number;
  113281. /**
  113282. * Mesh tile positioning : part tiles on left
  113283. */
  113284. static readonly LEFT: number;
  113285. /**
  113286. * Mesh tile positioning : part tiles on right
  113287. */
  113288. static readonly RIGHT: number;
  113289. /**
  113290. * Mesh tile positioning : part tiles on top
  113291. */
  113292. static readonly TOP: number;
  113293. /**
  113294. * Mesh tile positioning : part tiles on bottom
  113295. */
  113296. static readonly BOTTOM: number;
  113297. /**
  113298. * Gets the default side orientation.
  113299. * @param orientation the orientation to value to attempt to get
  113300. * @returns the default orientation
  113301. * @hidden
  113302. */
  113303. static _GetDefaultSideOrientation(orientation?: number): number;
  113304. private _internalMeshDataInfo;
  113305. get computeBonesUsingShaders(): boolean;
  113306. set computeBonesUsingShaders(value: boolean);
  113307. /**
  113308. * An event triggered before rendering the mesh
  113309. */
  113310. get onBeforeRenderObservable(): Observable<Mesh>;
  113311. /**
  113312. * An event triggered before binding the mesh
  113313. */
  113314. get onBeforeBindObservable(): Observable<Mesh>;
  113315. /**
  113316. * An event triggered after rendering the mesh
  113317. */
  113318. get onAfterRenderObservable(): Observable<Mesh>;
  113319. /**
  113320. * An event triggered before drawing the mesh
  113321. */
  113322. get onBeforeDrawObservable(): Observable<Mesh>;
  113323. private _onBeforeDrawObserver;
  113324. /**
  113325. * Sets a callback to call before drawing the mesh. It is recommended to use onBeforeDrawObservable instead
  113326. */
  113327. set onBeforeDraw(callback: () => void);
  113328. get hasInstances(): boolean;
  113329. get hasThinInstances(): boolean;
  113330. /**
  113331. * Gets the delay loading state of the mesh (when delay loading is turned on)
  113332. * @see https://doc.babylonjs.com/how_to/using_the_incremental_loading_system
  113333. */
  113334. delayLoadState: number;
  113335. /**
  113336. * Gets the list of instances created from this mesh
  113337. * it is not supposed to be modified manually.
  113338. * Note also that the order of the InstancedMesh wihin the array is not significant and might change.
  113339. * @see https://doc.babylonjs.com/how_to/how_to_use_instances
  113340. */
  113341. instances: InstancedMesh[];
  113342. /**
  113343. * Gets the file containing delay loading data for this mesh
  113344. */
  113345. delayLoadingFile: string;
  113346. /** @hidden */
  113347. _binaryInfo: any;
  113348. /**
  113349. * User defined function used to change how LOD level selection is done
  113350. * @see https://doc.babylonjs.com/how_to/how_to_use_lod
  113351. */
  113352. onLODLevelSelection: (distance: number, mesh: Mesh, selectedLevel: Nullable<Mesh>) => void;
  113353. /**
  113354. * Gets or sets the morph target manager
  113355. * @see https://doc.babylonjs.com/how_to/how_to_use_morphtargets
  113356. */
  113357. get morphTargetManager(): Nullable<MorphTargetManager>;
  113358. set morphTargetManager(value: Nullable<MorphTargetManager>);
  113359. /** @hidden */
  113360. _creationDataStorage: Nullable<_CreationDataStorage>;
  113361. /** @hidden */
  113362. _geometry: Nullable<Geometry>;
  113363. /** @hidden */
  113364. _delayInfo: Array<string>;
  113365. /** @hidden */
  113366. _delayLoadingFunction: (any: any, mesh: Mesh) => void;
  113367. /** @hidden */
  113368. _instanceDataStorage: _InstanceDataStorage;
  113369. /** @hidden */
  113370. _thinInstanceDataStorage: _ThinInstanceDataStorage;
  113371. private _effectiveMaterial;
  113372. /** @hidden */
  113373. _shouldGenerateFlatShading: boolean;
  113374. /** @hidden */
  113375. _originalBuilderSideOrientation: number;
  113376. /**
  113377. * Use this property to change the original side orientation defined at construction time
  113378. */
  113379. overrideMaterialSideOrientation: Nullable<number>;
  113380. /**
  113381. * Gets the source mesh (the one used to clone this one from)
  113382. */
  113383. get source(): Nullable<Mesh>;
  113384. /**
  113385. * Gets the list of clones of this mesh
  113386. * The scene must have been constructed with useClonedMeshMap=true for this to work!
  113387. * Note that useClonedMeshMap=true is the default setting
  113388. */
  113389. get cloneMeshMap(): Nullable<{
  113390. [id: string]: Mesh | undefined;
  113391. }>;
  113392. /**
  113393. * Gets or sets a boolean indicating that this mesh does not use index buffer
  113394. */
  113395. get isUnIndexed(): boolean;
  113396. set isUnIndexed(value: boolean);
  113397. /** Gets the array buffer used to store the instanced buffer used for instances' world matrices */
  113398. get worldMatrixInstancedBuffer(): Float32Array;
  113399. /** Gets or sets a boolean indicating that the update of the instance buffer of the world matrices is manual */
  113400. get manualUpdateOfWorldMatrixInstancedBuffer(): boolean;
  113401. set manualUpdateOfWorldMatrixInstancedBuffer(value: boolean);
  113402. /**
  113403. * @constructor
  113404. * @param name The value used by scene.getMeshByName() to do a lookup.
  113405. * @param scene The scene to add this mesh to.
  113406. * @param parent The parent of this mesh, if it has one
  113407. * @param source An optional Mesh from which geometry is shared, cloned.
  113408. * @param doNotCloneChildren When cloning, skip cloning child meshes of source, default False.
  113409. * When false, achieved by calling a clone(), also passing False.
  113410. * This will make creation of children, recursive.
  113411. * @param clonePhysicsImpostor When cloning, include cloning mesh physics impostor, default True.
  113412. */
  113413. constructor(name: string, scene?: Nullable<Scene>, parent?: Nullable<Node>, source?: Nullable<Mesh>, doNotCloneChildren?: boolean, clonePhysicsImpostor?: boolean);
  113414. instantiateHierarchy(newParent?: Nullable<TransformNode>, options?: {
  113415. doNotInstantiate: boolean;
  113416. }, onNewNodeCreated?: (source: TransformNode, clone: TransformNode) => void): Nullable<TransformNode>;
  113417. /**
  113418. * Gets the class name
  113419. * @returns the string "Mesh".
  113420. */
  113421. getClassName(): string;
  113422. /** @hidden */
  113423. get _isMesh(): boolean;
  113424. /**
  113425. * Returns a description of this mesh
  113426. * @param fullDetails define if full details about this mesh must be used
  113427. * @returns a descriptive string representing this mesh
  113428. */
  113429. toString(fullDetails?: boolean): string;
  113430. /** @hidden */
  113431. _unBindEffect(): void;
  113432. /**
  113433. * Gets a boolean indicating if this mesh has LOD
  113434. */
  113435. get hasLODLevels(): boolean;
  113436. /**
  113437. * Gets the list of MeshLODLevel associated with the current mesh
  113438. * @returns an array of MeshLODLevel
  113439. */
  113440. getLODLevels(): MeshLODLevel[];
  113441. private _sortLODLevels;
  113442. /**
  113443. * Add a mesh as LOD level triggered at the given distance.
  113444. * @see https://doc.babylonjs.com/how_to/how_to_use_lod
  113445. * @param distance The distance from the center of the object to show this level
  113446. * @param mesh The mesh to be added as LOD level (can be null)
  113447. * @return This mesh (for chaining)
  113448. */
  113449. addLODLevel(distance: number, mesh: Nullable<Mesh>): Mesh;
  113450. /**
  113451. * Returns the LOD level mesh at the passed distance or null if not found.
  113452. * @see https://doc.babylonjs.com/how_to/how_to_use_lod
  113453. * @param distance The distance from the center of the object to show this level
  113454. * @returns a Mesh or `null`
  113455. */
  113456. getLODLevelAtDistance(distance: number): Nullable<Mesh>;
  113457. /**
  113458. * Remove a mesh from the LOD array
  113459. * @see https://doc.babylonjs.com/how_to/how_to_use_lod
  113460. * @param mesh defines the mesh to be removed
  113461. * @return This mesh (for chaining)
  113462. */
  113463. removeLODLevel(mesh: Mesh): Mesh;
  113464. /**
  113465. * Returns the registered LOD mesh distant from the parameter `camera` position if any, else returns the current mesh.
  113466. * @see https://doc.babylonjs.com/how_to/how_to_use_lod
  113467. * @param camera defines the camera to use to compute distance
  113468. * @param boundingSphere defines a custom bounding sphere to use instead of the one from this mesh
  113469. * @return This mesh (for chaining)
  113470. */
  113471. getLOD(camera: Camera, boundingSphere?: BoundingSphere): Nullable<AbstractMesh>;
  113472. /**
  113473. * Gets the mesh internal Geometry object
  113474. */
  113475. get geometry(): Nullable<Geometry>;
  113476. /**
  113477. * Returns the total number of vertices within the mesh geometry or zero if the mesh has no geometry.
  113478. * @returns the total number of vertices
  113479. */
  113480. getTotalVertices(): number;
  113481. /**
  113482. * Returns the content of an associated vertex buffer
  113483. * @param kind defines which buffer to read from (positions, indices, normals, etc). Possible `kind` values :
  113484. * - VertexBuffer.PositionKind
  113485. * - VertexBuffer.UVKind
  113486. * - VertexBuffer.UV2Kind
  113487. * - VertexBuffer.UV3Kind
  113488. * - VertexBuffer.UV4Kind
  113489. * - VertexBuffer.UV5Kind
  113490. * - VertexBuffer.UV6Kind
  113491. * - VertexBuffer.ColorKind
  113492. * - VertexBuffer.MatricesIndicesKind
  113493. * - VertexBuffer.MatricesIndicesExtraKind
  113494. * - VertexBuffer.MatricesWeightsKind
  113495. * - VertexBuffer.MatricesWeightsExtraKind
  113496. * @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
  113497. * @param forceCopy defines a boolean forcing the copy of the buffer no matter what the value of copyWhenShared is
  113498. * @returns a FloatArray or null if the mesh has no geometry or no vertex buffer for this kind.
  113499. */
  113500. getVerticesData(kind: string, copyWhenShared?: boolean, forceCopy?: boolean): Nullable<FloatArray>;
  113501. /**
  113502. * Returns the mesh VertexBuffer object from the requested `kind`
  113503. * @param kind defines which buffer to read from (positions, indices, normals, etc). Possible `kind` values :
  113504. * - VertexBuffer.PositionKind
  113505. * - VertexBuffer.NormalKind
  113506. * - VertexBuffer.UVKind
  113507. * - VertexBuffer.UV2Kind
  113508. * - VertexBuffer.UV3Kind
  113509. * - VertexBuffer.UV4Kind
  113510. * - VertexBuffer.UV5Kind
  113511. * - VertexBuffer.UV6Kind
  113512. * - VertexBuffer.ColorKind
  113513. * - VertexBuffer.MatricesIndicesKind
  113514. * - VertexBuffer.MatricesIndicesExtraKind
  113515. * - VertexBuffer.MatricesWeightsKind
  113516. * - VertexBuffer.MatricesWeightsExtraKind
  113517. * @returns a FloatArray or null if the mesh has no vertex buffer for this kind.
  113518. */
  113519. getVertexBuffer(kind: string): Nullable<VertexBuffer>;
  113520. /**
  113521. * Tests if a specific vertex buffer is associated with this mesh
  113522. * @param kind defines which buffer to check (positions, indices, normals, etc). Possible `kind` values :
  113523. * - VertexBuffer.PositionKind
  113524. * - VertexBuffer.NormalKind
  113525. * - VertexBuffer.UVKind
  113526. * - VertexBuffer.UV2Kind
  113527. * - VertexBuffer.UV3Kind
  113528. * - VertexBuffer.UV4Kind
  113529. * - VertexBuffer.UV5Kind
  113530. * - VertexBuffer.UV6Kind
  113531. * - VertexBuffer.ColorKind
  113532. * - VertexBuffer.MatricesIndicesKind
  113533. * - VertexBuffer.MatricesIndicesExtraKind
  113534. * - VertexBuffer.MatricesWeightsKind
  113535. * - VertexBuffer.MatricesWeightsExtraKind
  113536. * @returns a boolean
  113537. */
  113538. isVerticesDataPresent(kind: string): boolean;
  113539. /**
  113540. * Returns a boolean defining if the vertex data for the requested `kind` is updatable.
  113541. * @param kind defines which buffer to check (positions, indices, normals, etc). Possible `kind` values :
  113542. * - VertexBuffer.PositionKind
  113543. * - VertexBuffer.UVKind
  113544. * - VertexBuffer.UV2Kind
  113545. * - VertexBuffer.UV3Kind
  113546. * - VertexBuffer.UV4Kind
  113547. * - VertexBuffer.UV5Kind
  113548. * - VertexBuffer.UV6Kind
  113549. * - VertexBuffer.ColorKind
  113550. * - VertexBuffer.MatricesIndicesKind
  113551. * - VertexBuffer.MatricesIndicesExtraKind
  113552. * - VertexBuffer.MatricesWeightsKind
  113553. * - VertexBuffer.MatricesWeightsExtraKind
  113554. * @returns a boolean
  113555. */
  113556. isVertexBufferUpdatable(kind: string): boolean;
  113557. /**
  113558. * Returns a string which contains the list of existing `kinds` of Vertex Data associated with this mesh.
  113559. * @param kind defines which buffer to read from (positions, indices, normals, etc). Possible `kind` values :
  113560. * - VertexBuffer.PositionKind
  113561. * - VertexBuffer.NormalKind
  113562. * - VertexBuffer.UVKind
  113563. * - VertexBuffer.UV2Kind
  113564. * - VertexBuffer.UV3Kind
  113565. * - VertexBuffer.UV4Kind
  113566. * - VertexBuffer.UV5Kind
  113567. * - VertexBuffer.UV6Kind
  113568. * - VertexBuffer.ColorKind
  113569. * - VertexBuffer.MatricesIndicesKind
  113570. * - VertexBuffer.MatricesIndicesExtraKind
  113571. * - VertexBuffer.MatricesWeightsKind
  113572. * - VertexBuffer.MatricesWeightsExtraKind
  113573. * @returns an array of strings
  113574. */
  113575. getVerticesDataKinds(): string[];
  113576. /**
  113577. * Returns a positive integer : the total number of indices in this mesh geometry.
  113578. * @returns the numner of indices or zero if the mesh has no geometry.
  113579. */
  113580. getTotalIndices(): number;
  113581. /**
  113582. * Returns an array of integers or a typed array (Int32Array, Uint32Array, Uint16Array) populated with the mesh indices.
  113583. * @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.
  113584. * @param forceCopy defines a boolean indicating that the returned array must be cloned upon returning it
  113585. * @returns the indices array or an empty array if the mesh has no geometry
  113586. */
  113587. getIndices(copyWhenShared?: boolean, forceCopy?: boolean): Nullable<IndicesArray>;
  113588. get isBlocked(): boolean;
  113589. /**
  113590. * Determine if the current mesh is ready to be rendered
  113591. * @param completeCheck defines if a complete check (including materials and lights) has to be done (false by default)
  113592. * @param forceInstanceSupport will check if the mesh will be ready when used with instances (false by default)
  113593. * @returns true if all associated assets are ready (material, textures, shaders)
  113594. */
  113595. isReady(completeCheck?: boolean, forceInstanceSupport?: boolean): boolean;
  113596. /**
  113597. * 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.
  113598. */
  113599. get areNormalsFrozen(): boolean;
  113600. /**
  113601. * 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.
  113602. * @returns the current mesh
  113603. */
  113604. freezeNormals(): Mesh;
  113605. /**
  113606. * 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
  113607. * @returns the current mesh
  113608. */
  113609. unfreezeNormals(): Mesh;
  113610. /**
  113611. * Sets a value overriding the instance count. Only applicable when custom instanced InterleavedVertexBuffer are used rather than InstancedMeshs
  113612. */
  113613. set overridenInstanceCount(count: number);
  113614. /** @hidden */
  113615. _preActivate(): Mesh;
  113616. /** @hidden */
  113617. _preActivateForIntermediateRendering(renderId: number): Mesh;
  113618. /** @hidden */
  113619. _registerInstanceForRenderId(instance: InstancedMesh, renderId: number): Mesh;
  113620. protected _afterComputeWorldMatrix(): void;
  113621. /** @hidden */
  113622. _postActivate(): void;
  113623. /**
  113624. * This method recomputes and sets a new BoundingInfo to the mesh unless it is locked.
  113625. * This means the mesh underlying bounding box and sphere are recomputed.
  113626. * @param applySkeleton defines whether to apply the skeleton before computing the bounding info
  113627. * @returns the current mesh
  113628. */
  113629. refreshBoundingInfo(applySkeleton?: boolean): Mesh;
  113630. /** @hidden */
  113631. _createGlobalSubMesh(force: boolean): Nullable<SubMesh>;
  113632. /**
  113633. * This function will subdivide the mesh into multiple submeshes
  113634. * @param count defines the expected number of submeshes
  113635. */
  113636. subdivide(count: number): void;
  113637. /**
  113638. * Copy a FloatArray into a specific associated vertex buffer
  113639. * @param kind defines which buffer to write to (positions, indices, normals, etc). Possible `kind` values :
  113640. * - VertexBuffer.PositionKind
  113641. * - VertexBuffer.UVKind
  113642. * - VertexBuffer.UV2Kind
  113643. * - VertexBuffer.UV3Kind
  113644. * - VertexBuffer.UV4Kind
  113645. * - VertexBuffer.UV5Kind
  113646. * - VertexBuffer.UV6Kind
  113647. * - VertexBuffer.ColorKind
  113648. * - VertexBuffer.MatricesIndicesKind
  113649. * - VertexBuffer.MatricesIndicesExtraKind
  113650. * - VertexBuffer.MatricesWeightsKind
  113651. * - VertexBuffer.MatricesWeightsExtraKind
  113652. * @param data defines the data source
  113653. * @param updatable defines if the updated vertex buffer must be flagged as updatable
  113654. * @param stride defines the data stride size (can be null)
  113655. * @returns the current mesh
  113656. */
  113657. setVerticesData(kind: string, data: FloatArray, updatable?: boolean, stride?: number): AbstractMesh;
  113658. /**
  113659. * Delete a vertex buffer associated with this mesh
  113660. * @param kind defines which buffer to delete (positions, indices, normals, etc). Possible `kind` values :
  113661. * - VertexBuffer.PositionKind
  113662. * - VertexBuffer.UVKind
  113663. * - VertexBuffer.UV2Kind
  113664. * - VertexBuffer.UV3Kind
  113665. * - VertexBuffer.UV4Kind
  113666. * - VertexBuffer.UV5Kind
  113667. * - VertexBuffer.UV6Kind
  113668. * - VertexBuffer.ColorKind
  113669. * - VertexBuffer.MatricesIndicesKind
  113670. * - VertexBuffer.MatricesIndicesExtraKind
  113671. * - VertexBuffer.MatricesWeightsKind
  113672. * - VertexBuffer.MatricesWeightsExtraKind
  113673. */
  113674. removeVerticesData(kind: string): void;
  113675. /**
  113676. * Flags an associated vertex buffer as updatable
  113677. * @param kind defines which buffer to use (positions, indices, normals, etc). Possible `kind` values :
  113678. * - VertexBuffer.PositionKind
  113679. * - VertexBuffer.UVKind
  113680. * - VertexBuffer.UV2Kind
  113681. * - VertexBuffer.UV3Kind
  113682. * - VertexBuffer.UV4Kind
  113683. * - VertexBuffer.UV5Kind
  113684. * - VertexBuffer.UV6Kind
  113685. * - VertexBuffer.ColorKind
  113686. * - VertexBuffer.MatricesIndicesKind
  113687. * - VertexBuffer.MatricesIndicesExtraKind
  113688. * - VertexBuffer.MatricesWeightsKind
  113689. * - VertexBuffer.MatricesWeightsExtraKind
  113690. * @param updatable defines if the updated vertex buffer must be flagged as updatable
  113691. */
  113692. markVerticesDataAsUpdatable(kind: string, updatable?: boolean): void;
  113693. /**
  113694. * Sets the mesh global Vertex Buffer
  113695. * @param buffer defines the buffer to use
  113696. * @returns the current mesh
  113697. */
  113698. setVerticesBuffer(buffer: VertexBuffer): Mesh;
  113699. /**
  113700. * Update a specific associated vertex buffer
  113701. * @param kind defines which buffer to write to (positions, indices, normals, etc). Possible `kind` values :
  113702. * - VertexBuffer.PositionKind
  113703. * - VertexBuffer.UVKind
  113704. * - VertexBuffer.UV2Kind
  113705. * - VertexBuffer.UV3Kind
  113706. * - VertexBuffer.UV4Kind
  113707. * - VertexBuffer.UV5Kind
  113708. * - VertexBuffer.UV6Kind
  113709. * - VertexBuffer.ColorKind
  113710. * - VertexBuffer.MatricesIndicesKind
  113711. * - VertexBuffer.MatricesIndicesExtraKind
  113712. * - VertexBuffer.MatricesWeightsKind
  113713. * - VertexBuffer.MatricesWeightsExtraKind
  113714. * @param data defines the data source
  113715. * @param updateExtends defines if extends info of the mesh must be updated (can be null). This is mostly useful for "position" kind
  113716. * @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)
  113717. * @returns the current mesh
  113718. */
  113719. updateVerticesData(kind: string, data: FloatArray, updateExtends?: boolean, makeItUnique?: boolean): AbstractMesh;
  113720. /**
  113721. * This method updates the vertex positions of an updatable mesh according to the `positionFunction` returned values.
  113722. * @see https://doc.babylonjs.com/how_to/how_to_dynamically_morph_a_mesh#other-shapes-updatemeshpositions
  113723. * @param positionFunction is a simple JS function what is passed the mesh `positions` array. It doesn't need to return anything
  113724. * @param computeNormals is a boolean (default true) to enable/disable the mesh normal recomputation after the vertex position update
  113725. * @returns the current mesh
  113726. */
  113727. updateMeshPositions(positionFunction: (data: FloatArray) => void, computeNormals?: boolean): Mesh;
  113728. /**
  113729. * Creates a un-shared specific occurence of the geometry for the mesh.
  113730. * @returns the current mesh
  113731. */
  113732. makeGeometryUnique(): Mesh;
  113733. /**
  113734. * Set the index buffer of this mesh
  113735. * @param indices defines the source data
  113736. * @param totalVertices defines the total number of vertices referenced by this index data (can be null)
  113737. * @param updatable defines if the updated index buffer must be flagged as updatable (default is false)
  113738. * @returns the current mesh
  113739. */
  113740. setIndices(indices: IndicesArray, totalVertices?: Nullable<number>, updatable?: boolean): AbstractMesh;
  113741. /**
  113742. * Update the current index buffer
  113743. * @param indices defines the source data
  113744. * @param offset defines the offset in the index buffer where to store the new data (can be null)
  113745. * @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)
  113746. * @returns the current mesh
  113747. */
  113748. updateIndices(indices: IndicesArray, offset?: number, gpuMemoryOnly?: boolean): AbstractMesh;
  113749. /**
  113750. * Invert the geometry to move from a right handed system to a left handed one.
  113751. * @returns the current mesh
  113752. */
  113753. toLeftHanded(): Mesh;
  113754. /** @hidden */
  113755. _bind(subMesh: SubMesh, effect: Effect, fillMode: number): Mesh;
  113756. /** @hidden */
  113757. _draw(subMesh: SubMesh, fillMode: number, instancesCount?: number): Mesh;
  113758. /**
  113759. * Registers for this mesh a javascript function called just before the rendering process
  113760. * @param func defines the function to call before rendering this mesh
  113761. * @returns the current mesh
  113762. */
  113763. registerBeforeRender(func: (mesh: AbstractMesh) => void): Mesh;
  113764. /**
  113765. * Disposes a previously registered javascript function called before the rendering
  113766. * @param func defines the function to remove
  113767. * @returns the current mesh
  113768. */
  113769. unregisterBeforeRender(func: (mesh: AbstractMesh) => void): Mesh;
  113770. /**
  113771. * Registers for this mesh a javascript function called just after the rendering is complete
  113772. * @param func defines the function to call after rendering this mesh
  113773. * @returns the current mesh
  113774. */
  113775. registerAfterRender(func: (mesh: AbstractMesh) => void): Mesh;
  113776. /**
  113777. * Disposes a previously registered javascript function called after the rendering.
  113778. * @param func defines the function to remove
  113779. * @returns the current mesh
  113780. */
  113781. unregisterAfterRender(func: (mesh: AbstractMesh) => void): Mesh;
  113782. /** @hidden */
  113783. _getInstancesRenderList(subMeshId: number, isReplacementMode?: boolean): _InstancesBatch;
  113784. /** @hidden */
  113785. _renderWithInstances(subMesh: SubMesh, fillMode: number, batch: _InstancesBatch, effect: Effect, engine: Engine): Mesh;
  113786. /** @hidden */
  113787. _renderWithThinInstances(subMesh: SubMesh, fillMode: number, effect: Effect, engine: Engine): void;
  113788. /** @hidden */
  113789. _processInstancedBuffers(visibleInstances: InstancedMesh[], renderSelf: boolean): void;
  113790. /** @hidden */
  113791. _processRendering(renderingMesh: AbstractMesh, subMesh: SubMesh, effect: Effect, fillMode: number, batch: _InstancesBatch, hardwareInstancedRendering: boolean, onBeforeDraw: (isInstance: boolean, world: Matrix, effectiveMaterial?: Material) => void, effectiveMaterial?: Material): Mesh;
  113792. /** @hidden */
  113793. _rebuild(): void;
  113794. /** @hidden */
  113795. _freeze(): void;
  113796. /** @hidden */
  113797. _unFreeze(): void;
  113798. /**
  113799. * 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
  113800. * @param subMesh defines the subMesh to render
  113801. * @param enableAlphaMode defines if alpha mode can be changed
  113802. * @param effectiveMeshReplacement defines an optional mesh used to provide info for the rendering
  113803. * @returns the current mesh
  113804. */
  113805. render(subMesh: SubMesh, enableAlphaMode: boolean, effectiveMeshReplacement?: AbstractMesh): Mesh;
  113806. private _onBeforeDraw;
  113807. /**
  113808. * Renormalize the mesh and patch it up if there are no weights
  113809. * Similar to normalization by adding the weights compute the reciprocal and multiply all elements, this wil ensure that everything adds to 1.
  113810. * However in the case of zero weights then we set just a single influence to 1.
  113811. * We check in the function for extra's present and if so we use the normalizeSkinWeightsWithExtras rather than the FourWeights version.
  113812. */
  113813. cleanMatrixWeights(): void;
  113814. private normalizeSkinFourWeights;
  113815. private normalizeSkinWeightsAndExtra;
  113816. /**
  113817. * ValidateSkinning is used to determine that a mesh has valid skinning data along with skin metrics, if missing weights,
  113818. * or not normalized it is returned as invalid mesh the string can be used for console logs, or on screen messages to let
  113819. * the user know there was an issue with importing the mesh
  113820. * @returns a validation object with skinned, valid and report string
  113821. */
  113822. validateSkinning(): {
  113823. skinned: boolean;
  113824. valid: boolean;
  113825. report: string;
  113826. };
  113827. /** @hidden */
  113828. _checkDelayState(): Mesh;
  113829. private _queueLoad;
  113830. /**
  113831. * Returns `true` if the mesh is within the frustum defined by the passed array of planes.
  113832. * A mesh is in the frustum if its bounding box intersects the frustum
  113833. * @param frustumPlanes defines the frustum to test
  113834. * @returns true if the mesh is in the frustum planes
  113835. */
  113836. isInFrustum(frustumPlanes: Plane[]): boolean;
  113837. /**
  113838. * Sets the mesh material by the material or multiMaterial `id` property
  113839. * @param id is a string identifying the material or the multiMaterial
  113840. * @returns the current mesh
  113841. */
  113842. setMaterialByID(id: string): Mesh;
  113843. /**
  113844. * Returns as a new array populated with the mesh material and/or skeleton, if any.
  113845. * @returns an array of IAnimatable
  113846. */
  113847. getAnimatables(): IAnimatable[];
  113848. /**
  113849. * Modifies the mesh geometry according to the passed transformation matrix.
  113850. * This method returns nothing but it really modifies the mesh even if it's originally not set as updatable.
  113851. * The mesh normals are modified using the same transformation.
  113852. * Note that, under the hood, this method sets a new VertexBuffer each call.
  113853. * @param transform defines the transform matrix to use
  113854. * @see https://doc.babylonjs.com/resources/baking_transformations
  113855. * @returns the current mesh
  113856. */
  113857. bakeTransformIntoVertices(transform: Matrix): Mesh;
  113858. /**
  113859. * Modifies the mesh geometry according to its own current World Matrix.
  113860. * The mesh World Matrix is then reset.
  113861. * This method returns nothing but really modifies the mesh even if it's originally not set as updatable.
  113862. * Note that, under the hood, this method sets a new VertexBuffer each call.
  113863. * @see https://doc.babylonjs.com/resources/baking_transformations
  113864. * @param bakeIndependenlyOfChildren indicates whether to preserve all child nodes' World Matrix during baking
  113865. * @returns the current mesh
  113866. */
  113867. bakeCurrentTransformIntoVertices(bakeIndependenlyOfChildren?: boolean): Mesh;
  113868. /** @hidden */
  113869. get _positions(): Nullable<Vector3[]>;
  113870. /** @hidden */
  113871. _resetPointsArrayCache(): Mesh;
  113872. /** @hidden */
  113873. _generatePointsArray(): boolean;
  113874. /**
  113875. * Returns a new Mesh object generated from the current mesh properties.
  113876. * This method must not get confused with createInstance()
  113877. * @param name is a string, the name given to the new mesh
  113878. * @param newParent can be any Node object (default `null`)
  113879. * @param doNotCloneChildren allows/denies the recursive cloning of the original mesh children if any (default `false`)
  113880. * @param clonePhysicsImpostor allows/denies the cloning in the same time of the original mesh `body` used by the physics engine, if any (default `true`)
  113881. * @returns a new mesh
  113882. */
  113883. clone(name?: string, newParent?: Nullable<Node>, doNotCloneChildren?: boolean, clonePhysicsImpostor?: boolean): Mesh;
  113884. /**
  113885. * Releases resources associated with this mesh.
  113886. * @param doNotRecurse Set to true to not recurse into each children (recurse into each children by default)
  113887. * @param disposeMaterialAndTextures Set to true to also dispose referenced materials and textures (false by default)
  113888. */
  113889. dispose(doNotRecurse?: boolean, disposeMaterialAndTextures?: boolean): void;
  113890. /** @hidden */
  113891. _disposeInstanceSpecificData(): void;
  113892. /** @hidden */
  113893. _disposeThinInstanceSpecificData(): void;
  113894. /**
  113895. * Modifies the mesh geometry according to a displacement map.
  113896. * 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.
  113897. * The mesh must be set as updatable. Its internal geometry is directly modified, no new buffer are allocated.
  113898. * @param url is a string, the URL from the image file is to be downloaded.
  113899. * @param minHeight is the lower limit of the displacement.
  113900. * @param maxHeight is the upper limit of the displacement.
  113901. * @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.
  113902. * @param uvOffset is an optional vector2 used to offset UV.
  113903. * @param uvScale is an optional vector2 used to scale UV.
  113904. * @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.
  113905. * @returns the Mesh.
  113906. */
  113907. applyDisplacementMap(url: string, minHeight: number, maxHeight: number, onSuccess?: (mesh: Mesh) => void, uvOffset?: Vector2, uvScale?: Vector2, forceUpdate?: boolean): Mesh;
  113908. /**
  113909. * Modifies the mesh geometry according to a displacementMap buffer.
  113910. * 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.
  113911. * The mesh must be set as updatable. Its internal geometry is directly modified, no new buffer are allocated.
  113912. * @param buffer is a `Uint8Array` buffer containing series of `Uint8` lower than 255, the red, green, blue and alpha values of each successive pixel.
  113913. * @param heightMapWidth is the width of the buffer image.
  113914. * @param heightMapHeight is the height of the buffer image.
  113915. * @param minHeight is the lower limit of the displacement.
  113916. * @param maxHeight is the upper limit of the displacement.
  113917. * @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.
  113918. * @param uvOffset is an optional vector2 used to offset UV.
  113919. * @param uvScale is an optional vector2 used to scale UV.
  113920. * @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.
  113921. * @returns the Mesh.
  113922. */
  113923. applyDisplacementMapFromBuffer(buffer: Uint8Array, heightMapWidth: number, heightMapHeight: number, minHeight: number, maxHeight: number, uvOffset?: Vector2, uvScale?: Vector2, forceUpdate?: boolean): Mesh;
  113924. /**
  113925. * Modify the mesh to get a flat shading rendering.
  113926. * This means each mesh facet will then have its own normals. Usually new vertices are added in the mesh geometry to get this result.
  113927. * Warning : the mesh is really modified even if not set originally as updatable and, under the hood, a new VertexBuffer is allocated.
  113928. * @returns current mesh
  113929. */
  113930. convertToFlatShadedMesh(): Mesh;
  113931. /**
  113932. * This method removes all the mesh indices and add new vertices (duplication) in order to unfold facets into buffers.
  113933. * In other words, more vertices, no more indices and a single bigger VBO.
  113934. * The mesh is really modified even if not set originally as updatable. Under the hood, a new VertexBuffer is allocated.
  113935. * @returns current mesh
  113936. */
  113937. convertToUnIndexedMesh(): Mesh;
  113938. /**
  113939. * Inverses facet orientations.
  113940. * Warning : the mesh is really modified even if not set originally as updatable. A new VertexBuffer is created under the hood each call.
  113941. * @param flipNormals will also inverts the normals
  113942. * @returns current mesh
  113943. */
  113944. flipFaces(flipNormals?: boolean): Mesh;
  113945. /**
  113946. * Increase the number of facets and hence vertices in a mesh
  113947. * Vertex normals are interpolated from existing vertex normals
  113948. * Warning : the mesh is really modified even if not set originally as updatable. A new VertexBuffer is created under the hood each call.
  113949. * @param numberPerEdge the number of new vertices to add to each edge of a facet, optional default 1
  113950. */
  113951. increaseVertices(numberPerEdge: number): void;
  113952. /**
  113953. * Force adjacent facets to share vertices and remove any facets that have all vertices in a line
  113954. * This will undo any application of covertToFlatShadedMesh
  113955. * Warning : the mesh is really modified even if not set originally as updatable. A new VertexBuffer is created under the hood each call.
  113956. */
  113957. forceSharedVertices(): void;
  113958. /** @hidden */
  113959. static _instancedMeshFactory(name: string, mesh: Mesh): InstancedMesh;
  113960. /** @hidden */
  113961. static _PhysicsImpostorParser(scene: Scene, physicObject: IPhysicsEnabledObject, jsonObject: any): PhysicsImpostor;
  113962. /**
  113963. * Creates a new InstancedMesh object from the mesh model.
  113964. * @see https://doc.babylonjs.com/how_to/how_to_use_instances
  113965. * @param name defines the name of the new instance
  113966. * @returns a new InstancedMesh
  113967. */
  113968. createInstance(name: string): InstancedMesh;
  113969. /**
  113970. * Synchronises all the mesh instance submeshes to the current mesh submeshes, if any.
  113971. * After this call, all the mesh instances have the same submeshes than the current mesh.
  113972. * @returns the current mesh
  113973. */
  113974. synchronizeInstances(): Mesh;
  113975. /**
  113976. * Optimization of the mesh's indices, in case a mesh has duplicated vertices.
  113977. * The function will only reorder the indices and will not remove unused vertices to avoid problems with submeshes.
  113978. * This should be used together with the simplification to avoid disappearing triangles.
  113979. * @param successCallback an optional success callback to be called after the optimization finished.
  113980. * @returns the current mesh
  113981. */
  113982. optimizeIndices(successCallback?: (mesh?: Mesh) => void): Mesh;
  113983. /**
  113984. * Serialize current mesh
  113985. * @param serializationObject defines the object which will receive the serialization data
  113986. */
  113987. serialize(serializationObject: any): void;
  113988. /** @hidden */
  113989. _syncGeometryWithMorphTargetManager(): void;
  113990. /** @hidden */
  113991. static _GroundMeshParser: (parsedMesh: any, scene: Scene) => Mesh;
  113992. /**
  113993. * Returns a new Mesh object parsed from the source provided.
  113994. * @param parsedMesh is the source
  113995. * @param scene defines the hosting scene
  113996. * @param rootUrl is the root URL to prefix the `delayLoadingFile` property with
  113997. * @returns a new Mesh
  113998. */
  113999. static Parse(parsedMesh: any, scene: Scene, rootUrl: string): Mesh;
  114000. /**
  114001. * Creates a ribbon mesh. Please consider using the same method from the MeshBuilder class instead
  114002. * @see https://doc.babylonjs.com/how_to/parametric_shapes
  114003. * @param name defines the name of the mesh to create
  114004. * @param pathArray is a required array of paths, what are each an array of successive Vector3. The pathArray parameter depicts the ribbon geometry.
  114005. * @param closeArray creates a seam between the first and the last paths of the path array (default is false)
  114006. * @param closePath creates a seam between the first and the last points of each path of the path array
  114007. * @param offset is taken in account only if the `pathArray` is containing a single path
  114008. * @param scene defines the hosting scene
  114009. * @param updatable defines if the mesh must be flagged as updatable
  114010. * @param sideOrientation defines the mesh side orientation (https://doc.babylonjs.com/babylon101/discover_basic_elements#side-orientation)
  114011. * @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)
  114012. * @returns a new Mesh
  114013. */
  114014. static CreateRibbon(name: string, pathArray: Vector3[][], closeArray: boolean, closePath: boolean, offset: number, scene?: Scene, updatable?: boolean, sideOrientation?: number, instance?: Mesh): Mesh;
  114015. /**
  114016. * Creates a plane polygonal mesh. By default, this is a disc. Please consider using the same method from the MeshBuilder class instead
  114017. * @param name defines the name of the mesh to create
  114018. * @param radius sets the radius size (float) of the polygon (default 0.5)
  114019. * @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
  114020. * @param scene defines the hosting scene
  114021. * @param updatable defines if the mesh must be flagged as updatable
  114022. * @param sideOrientation defines the mesh side orientation (https://doc.babylonjs.com/babylon101/discover_basic_elements#side-orientation)
  114023. * @returns a new Mesh
  114024. */
  114025. static CreateDisc(name: string, radius: number, tessellation: number, scene?: Nullable<Scene>, updatable?: boolean, sideOrientation?: number): Mesh;
  114026. /**
  114027. * Creates a box mesh. Please consider using the same method from the MeshBuilder class instead
  114028. * @param name defines the name of the mesh to create
  114029. * @param size sets the size (float) of each box side (default 1)
  114030. * @param scene defines the hosting scene
  114031. * @param updatable defines if the mesh must be flagged as updatable
  114032. * @param sideOrientation defines the mesh side orientation (https://doc.babylonjs.com/babylon101/discover_basic_elements#side-orientation)
  114033. * @returns a new Mesh
  114034. */
  114035. static CreateBox(name: string, size: number, scene?: Nullable<Scene>, updatable?: boolean, sideOrientation?: number): Mesh;
  114036. /**
  114037. * Creates a sphere mesh. Please consider using the same method from the MeshBuilder class instead
  114038. * @param name defines the name of the mesh to create
  114039. * @param segments sets the sphere number of horizontal stripes (positive integer, default 32)
  114040. * @param diameter sets the diameter size (float) of the sphere (default 1)
  114041. * @param scene defines the hosting scene
  114042. * @param updatable defines if the mesh must be flagged as updatable
  114043. * @param sideOrientation defines the mesh side orientation (https://doc.babylonjs.com/babylon101/discover_basic_elements#side-orientation)
  114044. * @returns a new Mesh
  114045. */
  114046. static CreateSphere(name: string, segments: number, diameter: number, scene?: Scene, updatable?: boolean, sideOrientation?: number): Mesh;
  114047. /**
  114048. * Creates a hemisphere mesh. Please consider using the same method from the MeshBuilder class instead
  114049. * @param name defines the name of the mesh to create
  114050. * @param segments sets the sphere number of horizontal stripes (positive integer, default 32)
  114051. * @param diameter sets the diameter size (float) of the sphere (default 1)
  114052. * @param scene defines the hosting scene
  114053. * @returns a new Mesh
  114054. */
  114055. static CreateHemisphere(name: string, segments: number, diameter: number, scene?: Scene): Mesh;
  114056. /**
  114057. * Creates a cylinder or a cone mesh. Please consider using the same method from the MeshBuilder class instead
  114058. * @param name defines the name of the mesh to create
  114059. * @param height sets the height size (float) of the cylinder/cone (float, default 2)
  114060. * @param diameterTop set the top cap diameter (floats, default 1)
  114061. * @param diameterBottom set the bottom cap diameter (floats, default 1). This value can't be zero
  114062. * @param tessellation sets the number of cylinder sides (positive integer, default 24). Set it to 3 to get a prism for instance
  114063. * @param subdivisions sets the number of rings along the cylinder height (positive integer, default 1)
  114064. * @param scene defines the hosting scene
  114065. * @param updatable defines if the mesh must be flagged as updatable
  114066. * @param sideOrientation defines the mesh side orientation (https://doc.babylonjs.com/babylon101/discover_basic_elements#side-orientation)
  114067. * @returns a new Mesh
  114068. */
  114069. static CreateCylinder(name: string, height: number, diameterTop: number, diameterBottom: number, tessellation: number, subdivisions: any, scene?: Scene, updatable?: any, sideOrientation?: number): Mesh;
  114070. /**
  114071. * Creates a torus mesh. Please consider using the same method from the MeshBuilder class instead
  114072. * @param name defines the name of the mesh to create
  114073. * @param diameter sets the diameter size (float) of the torus (default 1)
  114074. * @param thickness sets the diameter size of the tube of the torus (float, default 0.5)
  114075. * @param tessellation sets the number of torus sides (postive integer, default 16)
  114076. * @param scene defines the hosting scene
  114077. * @param updatable defines if the mesh must be flagged as updatable
  114078. * @param sideOrientation defines the mesh side orientation (https://doc.babylonjs.com/babylon101/discover_basic_elements#side-orientation)
  114079. * @returns a new Mesh
  114080. */
  114081. static CreateTorus(name: string, diameter: number, thickness: number, tessellation: number, scene?: Scene, updatable?: boolean, sideOrientation?: number): Mesh;
  114082. /**
  114083. * Creates a torus knot mesh. Please consider using the same method from the MeshBuilder class instead
  114084. * @param name defines the name of the mesh to create
  114085. * @param radius sets the global radius size (float) of the torus knot (default 2)
  114086. * @param tube sets the diameter size of the tube of the torus (float, default 0.5)
  114087. * @param radialSegments sets the number of sides on each tube segments (positive integer, default 32)
  114088. * @param tubularSegments sets the number of tubes to decompose the knot into (positive integer, default 32)
  114089. * @param p the number of windings on X axis (positive integers, default 2)
  114090. * @param q the number of windings on Y axis (positive integers, default 3)
  114091. * @param scene defines the hosting scene
  114092. * @param updatable defines if the mesh must be flagged as updatable
  114093. * @param sideOrientation defines the mesh side orientation (https://doc.babylonjs.com/babylon101/discover_basic_elements#side-orientation)
  114094. * @returns a new Mesh
  114095. */
  114096. static CreateTorusKnot(name: string, radius: number, tube: number, radialSegments: number, tubularSegments: number, p: number, q: number, scene?: Scene, updatable?: boolean, sideOrientation?: number): Mesh;
  114097. /**
  114098. * Creates a line mesh. Please consider using the same method from the MeshBuilder class instead.
  114099. * @param name defines the name of the mesh to create
  114100. * @param points is an array successive Vector3
  114101. * @param scene defines the hosting scene
  114102. * @param updatable defines if the mesh must be flagged as updatable
  114103. * @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).
  114104. * @returns a new Mesh
  114105. */
  114106. static CreateLines(name: string, points: Vector3[], scene?: Nullable<Scene>, updatable?: boolean, instance?: Nullable<LinesMesh>): LinesMesh;
  114107. /**
  114108. * Creates a dashed line mesh. Please consider using the same method from the MeshBuilder class instead
  114109. * @param name defines the name of the mesh to create
  114110. * @param points is an array successive Vector3
  114111. * @param dashSize is the size of the dashes relatively the dash number (positive float, default 3)
  114112. * @param gapSize is the size of the gap between two successive dashes relatively the dash number (positive float, default 1)
  114113. * @param dashNb is the intended total number of dashes (positive integer, default 200)
  114114. * @param scene defines the hosting scene
  114115. * @param updatable defines if the mesh must be flagged as updatable
  114116. * @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)
  114117. * @returns a new Mesh
  114118. */
  114119. static CreateDashedLines(name: string, points: Vector3[], dashSize: number, gapSize: number, dashNb: number, scene?: Nullable<Scene>, updatable?: boolean, instance?: LinesMesh): LinesMesh;
  114120. /**
  114121. * Creates a polygon mesh.Please consider using the same method from the MeshBuilder class instead
  114122. * The polygon's shape will depend on the input parameters and is constructed parallel to a ground mesh.
  114123. * 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.
  114124. * You can set the mesh side orientation with the values : Mesh.FRONTSIDE (default), Mesh.BACKSIDE or Mesh.DOUBLESIDE
  114125. * The mesh can be set to updatable with the boolean parameter `updatable` (default false) if its internal geometry is supposed to change once created.
  114126. * Remember you can only change the shape positions, not their number when updating a polygon.
  114127. * @see https://doc.babylonjs.com/how_to/parametric_shapes#non-regular-polygon
  114128. * @param name defines the name of the mesh to create
  114129. * @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
  114130. * @param scene defines the hosting scene
  114131. * @param holes is a required array of arrays of successive Vector3 used to defines holes in the polygon
  114132. * @param updatable defines if the mesh must be flagged as updatable
  114133. * @param sideOrientation defines the mesh side orientation (https://doc.babylonjs.com/babylon101/discover_basic_elements#side-orientation)
  114134. * @param earcutInjection can be used to inject your own earcut reference
  114135. * @returns a new Mesh
  114136. */
  114137. static CreatePolygon(name: string, shape: Vector3[], scene: Scene, holes?: Vector3[][], updatable?: boolean, sideOrientation?: number, earcutInjection?: any): Mesh;
  114138. /**
  114139. * Creates an extruded polygon mesh, with depth in the Y direction. Please consider using the same method from the MeshBuilder class instead.
  114140. * @see https://doc.babylonjs.com/how_to/parametric_shapes#extruded-non-regular-polygon
  114141. * @param name defines the name of the mesh to create
  114142. * @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
  114143. * @param depth defines the height of extrusion
  114144. * @param scene defines the hosting scene
  114145. * @param holes is a required array of arrays of successive Vector3 used to defines holes in the polygon
  114146. * @param updatable defines if the mesh must be flagged as updatable
  114147. * @param sideOrientation defines the mesh side orientation (https://doc.babylonjs.com/babylon101/discover_basic_elements#side-orientation)
  114148. * @param earcutInjection can be used to inject your own earcut reference
  114149. * @returns a new Mesh
  114150. */
  114151. static ExtrudePolygon(name: string, shape: Vector3[], depth: number, scene: Scene, holes?: Vector3[][], updatable?: boolean, sideOrientation?: number, earcutInjection?: any): Mesh;
  114152. /**
  114153. * Creates an extruded shape mesh.
  114154. * 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
  114155. * @see https://doc.babylonjs.com/how_to/parametric_shapes
  114156. * @see https://doc.babylonjs.com/how_to/parametric_shapes#extruded-shapes
  114157. * @param name defines the name of the mesh to create
  114158. * @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
  114159. * @param path is a required array of successive Vector3. This is the axis curve the shape is extruded along
  114160. * @param scale is the value to scale the shape
  114161. * @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
  114162. * @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
  114163. * @param scene defines the hosting scene
  114164. * @param updatable defines if the mesh must be flagged as updatable
  114165. * @param sideOrientation defines the mesh side orientation (https://doc.babylonjs.com/babylon101/discover_basic_elements#side-orientation)
  114166. * @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)
  114167. * @returns a new Mesh
  114168. */
  114169. static ExtrudeShape(name: string, shape: Vector3[], path: Vector3[], scale: number, rotation: number, cap: number, scene?: Nullable<Scene>, updatable?: boolean, sideOrientation?: number, instance?: Mesh): Mesh;
  114170. /**
  114171. * Creates an custom extruded shape mesh.
  114172. * The custom extrusion is a parametric shape.
  114173. * It has no predefined shape. Its final shape will depend on the input parameters.
  114174. * Please consider using the same method from the MeshBuilder class instead
  114175. * @see https://doc.babylonjs.com/how_to/parametric_shapes#extruded-shapes
  114176. * @param name defines the name of the mesh to create
  114177. * @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
  114178. * @param path is a required array of successive Vector3. This is the axis curve the shape is extruded along
  114179. * @param scaleFunction is a custom Javascript function called on each path point
  114180. * @param rotationFunction is a custom Javascript function called on each path point
  114181. * @param ribbonCloseArray forces the extrusion underlying ribbon to close all the paths in its `pathArray`
  114182. * @param ribbonClosePath forces the extrusion underlying ribbon to close its `pathArray`
  114183. * @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
  114184. * @param scene defines the hosting scene
  114185. * @param updatable defines if the mesh must be flagged as updatable
  114186. * @param sideOrientation defines the mesh side orientation (https://doc.babylonjs.com/babylon101/discover_basic_elements#side-orientation)
  114187. * @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)
  114188. * @returns a new Mesh
  114189. */
  114190. 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;
  114191. /**
  114192. * Creates lathe mesh.
  114193. * The lathe is a shape with a symetry axis : a 2D model shape is rotated around this axis to design the lathe.
  114194. * Please consider using the same method from the MeshBuilder class instead
  114195. * @param name defines the name of the mesh to create
  114196. * @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
  114197. * @param radius is the radius value of the lathe
  114198. * @param tessellation is the side number of the lathe.
  114199. * @param scene defines the hosting scene
  114200. * @param updatable defines if the mesh must be flagged as updatable
  114201. * @param sideOrientation defines the mesh side orientation (https://doc.babylonjs.com/babylon101/discover_basic_elements#side-orientation)
  114202. * @returns a new Mesh
  114203. */
  114204. static CreateLathe(name: string, shape: Vector3[], radius: number, tessellation: number, scene: Scene, updatable?: boolean, sideOrientation?: number): Mesh;
  114205. /**
  114206. * Creates a plane mesh. Please consider using the same method from the MeshBuilder class instead
  114207. * @param name defines the name of the mesh to create
  114208. * @param size sets the size (float) of both sides of the plane at once (default 1)
  114209. * @param scene defines the hosting scene
  114210. * @param updatable defines if the mesh must be flagged as updatable
  114211. * @param sideOrientation defines the mesh side orientation (https://doc.babylonjs.com/babylon101/discover_basic_elements#side-orientation)
  114212. * @returns a new Mesh
  114213. */
  114214. static CreatePlane(name: string, size: number, scene: Scene, updatable?: boolean, sideOrientation?: number): Mesh;
  114215. /**
  114216. * Creates a ground mesh.
  114217. * Please consider using the same method from the MeshBuilder class instead
  114218. * @param name defines the name of the mesh to create
  114219. * @param width set the width of the ground
  114220. * @param height set the height of the ground
  114221. * @param subdivisions sets the number of subdivisions per side
  114222. * @param scene defines the hosting scene
  114223. * @param updatable defines if the mesh must be flagged as updatable
  114224. * @returns a new Mesh
  114225. */
  114226. static CreateGround(name: string, width: number, height: number, subdivisions: number, scene?: Scene, updatable?: boolean): Mesh;
  114227. /**
  114228. * Creates a tiled ground mesh.
  114229. * Please consider using the same method from the MeshBuilder class instead
  114230. * @param name defines the name of the mesh to create
  114231. * @param xmin set the ground minimum X coordinate
  114232. * @param zmin set the ground minimum Y coordinate
  114233. * @param xmax set the ground maximum X coordinate
  114234. * @param zmax set the ground maximum Z coordinate
  114235. * @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
  114236. * @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
  114237. * @param scene defines the hosting scene
  114238. * @param updatable defines if the mesh must be flagged as updatable
  114239. * @returns a new Mesh
  114240. */
  114241. static CreateTiledGround(name: string, xmin: number, zmin: number, xmax: number, zmax: number, subdivisions: {
  114242. w: number;
  114243. h: number;
  114244. }, precision: {
  114245. w: number;
  114246. h: number;
  114247. }, scene: Scene, updatable?: boolean): Mesh;
  114248. /**
  114249. * Creates a ground mesh from a height map.
  114250. * Please consider using the same method from the MeshBuilder class instead
  114251. * @see https://doc.babylonjs.com/babylon101/height_map
  114252. * @param name defines the name of the mesh to create
  114253. * @param url sets the URL of the height map image resource
  114254. * @param width set the ground width size
  114255. * @param height set the ground height size
  114256. * @param subdivisions sets the number of subdivision per side
  114257. * @param minHeight is the minimum altitude on the ground
  114258. * @param maxHeight is the maximum altitude on the ground
  114259. * @param scene defines the hosting scene
  114260. * @param updatable defines if the mesh must be flagged as updatable
  114261. * @param onReady is a callback function that will be called once the mesh is built (the height map download can last some time)
  114262. * @param alphaFilter will filter any data where the alpha channel is below this value, defaults 0 (all data visible)
  114263. * @returns a new Mesh
  114264. */
  114265. 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;
  114266. /**
  114267. * Creates a tube mesh.
  114268. * The tube is a parametric shape.
  114269. * It has no predefined shape. Its final shape will depend on the input parameters.
  114270. * Please consider using the same method from the MeshBuilder class instead
  114271. * @see https://doc.babylonjs.com/how_to/parametric_shapes
  114272. * @param name defines the name of the mesh to create
  114273. * @param path is a required array of successive Vector3. It is the curve used as the axis of the tube
  114274. * @param radius sets the tube radius size
  114275. * @param tessellation is the number of sides on the tubular surface
  114276. * @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
  114277. * @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
  114278. * @param scene defines the hosting scene
  114279. * @param updatable defines if the mesh must be flagged as updatable
  114280. * @param sideOrientation defines the mesh side orientation (https://doc.babylonjs.com/babylon101/discover_basic_elements#side-orientation)
  114281. * @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)
  114282. * @returns a new Mesh
  114283. */
  114284. static CreateTube(name: string, path: Vector3[], radius: number, tessellation: number, radiusFunction: {
  114285. (i: number, distance: number): number;
  114286. }, cap: number, scene: Scene, updatable?: boolean, sideOrientation?: number, instance?: Mesh): Mesh;
  114287. /**
  114288. * Creates a polyhedron mesh.
  114289. * Please consider using the same method from the MeshBuilder class instead.
  114290. * * 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
  114291. * * The parameter `size` (positive float, default 1) sets the polygon size
  114292. * * You can overwrite the `size` on each dimension bu using the parameters `sizeX`, `sizeY` or `sizeZ` (positive floats, default to `size` value)
  114293. * * 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`
  114294. * * 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
  114295. * * 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)`)
  114296. * * 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
  114297. * * 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
  114298. * * You can also set the mesh side orientation with the values : Mesh.FRONTSIDE (default), Mesh.BACKSIDE or Mesh.DOUBLESIDE
  114299. * * If you create a double-sided mesh, you can choose what parts of the texture image to crop and stick respectively on the front and the back sides with the parameters `frontUVs` and `backUVs` (Vector4). Detail here : https://doc.babylonjs.com/babylon101/discover_basic_elements#side-orientation
  114300. * * The mesh can be set to updatable with the boolean parameter `updatable` (default false) if its internal geometry is supposed to change once created
  114301. * @param name defines the name of the mesh to create
  114302. * @param options defines the options used to create the mesh
  114303. * @param scene defines the hosting scene
  114304. * @returns a new Mesh
  114305. */
  114306. static CreatePolyhedron(name: string, options: {
  114307. type?: number;
  114308. size?: number;
  114309. sizeX?: number;
  114310. sizeY?: number;
  114311. sizeZ?: number;
  114312. custom?: any;
  114313. faceUV?: Vector4[];
  114314. faceColors?: Color4[];
  114315. updatable?: boolean;
  114316. sideOrientation?: number;
  114317. }, scene: Scene): Mesh;
  114318. /**
  114319. * Creates a sphere based upon an icosahedron with 20 triangular faces which can be subdivided
  114320. * * The parameter `radius` sets the radius size (float) of the icosphere (default 1)
  114321. * * 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`)
  114322. * * The parameter `subdivisions` sets the number of subdivisions (postive integer, default 4). The more subdivisions, the more faces on the icosphere whatever its size
  114323. * * 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
  114324. * * You can also set the mesh side orientation with the values : Mesh.FRONTSIDE (default), Mesh.BACKSIDE or Mesh.DOUBLESIDE
  114325. * * If you create a double-sided mesh, you can choose what parts of the texture image to crop and stick respectively on the front and the back sides with the parameters `frontUVs` and `backUVs` (Vector4). Detail here : https://doc.babylonjs.com/babylon101/discover_basic_elements#side-orientation
  114326. * * The mesh can be set to updatable with the boolean parameter `updatable` (default false) if its internal geometry is supposed to change once created
  114327. * @param name defines the name of the mesh
  114328. * @param options defines the options used to create the mesh
  114329. * @param scene defines the hosting scene
  114330. * @returns a new Mesh
  114331. * @see https://doc.babylonjs.com/how_to/polyhedra_shapes#icosphere
  114332. */
  114333. static CreateIcoSphere(name: string, options: {
  114334. radius?: number;
  114335. flat?: boolean;
  114336. subdivisions?: number;
  114337. sideOrientation?: number;
  114338. updatable?: boolean;
  114339. }, scene: Scene): Mesh;
  114340. /**
  114341. * Creates a decal mesh.
  114342. * Please consider using the same method from the MeshBuilder class instead.
  114343. * A decal is a mesh usually applied as a model onto the surface of another mesh
  114344. * @param name defines the name of the mesh
  114345. * @param sourceMesh defines the mesh receiving the decal
  114346. * @param position sets the position of the decal in world coordinates
  114347. * @param normal sets the normal of the mesh where the decal is applied onto in world coordinates
  114348. * @param size sets the decal scaling
  114349. * @param angle sets the angle to rotate the decal
  114350. * @returns a new Mesh
  114351. */
  114352. static CreateDecal(name: string, sourceMesh: AbstractMesh, position: Vector3, normal: Vector3, size: Vector3, angle: number): Mesh;
  114353. /** Creates a Capsule Mesh
  114354. * @param name defines the name of the mesh.
  114355. * @param options the constructors options used to shape the mesh.
  114356. * @param scene defines the scene the mesh is scoped to.
  114357. * @returns the capsule mesh
  114358. * @see https://doc.babylonjs.com/how_to/capsule_shape
  114359. */
  114360. static CreateCapsule(name: string, options: ICreateCapsuleOptions, scene: Scene): Mesh;
  114361. /**
  114362. * Prepare internal position array for software CPU skinning
  114363. * @returns original positions used for CPU skinning. Useful for integrating Morphing with skeletons in same mesh
  114364. */
  114365. setPositionsForCPUSkinning(): Float32Array;
  114366. /**
  114367. * Prepare internal normal array for software CPU skinning
  114368. * @returns original normals used for CPU skinning. Useful for integrating Morphing with skeletons in same mesh.
  114369. */
  114370. setNormalsForCPUSkinning(): Float32Array;
  114371. /**
  114372. * Updates the vertex buffer by applying transformation from the bones
  114373. * @param skeleton defines the skeleton to apply to current mesh
  114374. * @returns the current mesh
  114375. */
  114376. applySkeleton(skeleton: Skeleton): Mesh;
  114377. /**
  114378. * 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
  114379. * @param meshes defines the list of meshes to scan
  114380. * @returns an object `{min:` Vector3`, max:` Vector3`}`
  114381. */
  114382. static MinMax(meshes: AbstractMesh[]): {
  114383. min: Vector3;
  114384. max: Vector3;
  114385. };
  114386. /**
  114387. * Returns the center of the `{min:` Vector3`, max:` Vector3`}` or the center of MinMax vector3 computed from a mesh array
  114388. * @param meshesOrMinMaxVector could be an array of meshes or a `{min:` Vector3`, max:` Vector3`}` object
  114389. * @returns a vector3
  114390. */
  114391. static Center(meshesOrMinMaxVector: {
  114392. min: Vector3;
  114393. max: Vector3;
  114394. } | AbstractMesh[]): Vector3;
  114395. /**
  114396. * Merge the array of meshes into a single mesh for performance reasons.
  114397. * @param meshes defines he vertices source. They should all be of the same material. Entries can empty
  114398. * @param disposeSource when true (default), dispose of the vertices from the source meshes
  114399. * @param allow32BitsIndices when the sum of the vertices > 64k, this must be set to true
  114400. * @param meshSubclass when set, vertices inserted into this Mesh. Meshes can then be merged into a Mesh sub-class.
  114401. * @param subdivideWithSubMeshes when true (false default), subdivide mesh to his subMesh array with meshes source.
  114402. * @param multiMultiMaterials when true (false default), subdivide mesh and accept multiple multi materials, ignores subdivideWithSubMeshes.
  114403. * @returns a new mesh
  114404. */
  114405. static MergeMeshes(meshes: Array<Mesh>, disposeSource?: boolean, allow32BitsIndices?: boolean, meshSubclass?: Mesh, subdivideWithSubMeshes?: boolean, multiMultiMaterials?: boolean): Nullable<Mesh>;
  114406. /** @hidden */
  114407. addInstance(instance: InstancedMesh): void;
  114408. /** @hidden */
  114409. removeInstance(instance: InstancedMesh): void;
  114410. }
  114411. }
  114412. declare module BABYLON {
  114413. /**
  114414. * This is the base class of all the camera used in the application.
  114415. * @see https://doc.babylonjs.com/features/cameras
  114416. */
  114417. export class Camera extends Node {
  114418. /** @hidden */
  114419. static _createDefaultParsedCamera: (name: string, scene: Scene) => Camera;
  114420. /**
  114421. * This is the default projection mode used by the cameras.
  114422. * It helps recreating a feeling of perspective and better appreciate depth.
  114423. * This is the best way to simulate real life cameras.
  114424. */
  114425. static readonly PERSPECTIVE_CAMERA: number;
  114426. /**
  114427. * This helps creating camera with an orthographic mode.
  114428. * 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.
  114429. */
  114430. static readonly ORTHOGRAPHIC_CAMERA: number;
  114431. /**
  114432. * This is the default FOV mode for perspective cameras.
  114433. * This setting aligns the upper and lower bounds of the viewport to the upper and lower bounds of the camera frustum.
  114434. */
  114435. static readonly FOVMODE_VERTICAL_FIXED: number;
  114436. /**
  114437. * This setting aligns the left and right bounds of the viewport to the left and right bounds of the camera frustum.
  114438. */
  114439. static readonly FOVMODE_HORIZONTAL_FIXED: number;
  114440. /**
  114441. * This specifies ther is no need for a camera rig.
  114442. * Basically only one eye is rendered corresponding to the camera.
  114443. */
  114444. static readonly RIG_MODE_NONE: number;
  114445. /**
  114446. * Simulates a camera Rig with one blue eye and one red eye.
  114447. * This can be use with 3d blue and red glasses.
  114448. */
  114449. static readonly RIG_MODE_STEREOSCOPIC_ANAGLYPH: number;
  114450. /**
  114451. * Defines that both eyes of the camera will be rendered side by side with a parallel target.
  114452. */
  114453. static readonly RIG_MODE_STEREOSCOPIC_SIDEBYSIDE_PARALLEL: number;
  114454. /**
  114455. * Defines that both eyes of the camera will be rendered side by side with a none parallel target.
  114456. */
  114457. static readonly RIG_MODE_STEREOSCOPIC_SIDEBYSIDE_CROSSEYED: number;
  114458. /**
  114459. * Defines that both eyes of the camera will be rendered over under each other.
  114460. */
  114461. static readonly RIG_MODE_STEREOSCOPIC_OVERUNDER: number;
  114462. /**
  114463. * Defines that both eyes of the camera will be rendered on successive lines interlaced for passive 3d monitors.
  114464. */
  114465. static readonly RIG_MODE_STEREOSCOPIC_INTERLACED: number;
  114466. /**
  114467. * Defines that both eyes of the camera should be renderered in a VR mode (carbox).
  114468. */
  114469. static readonly RIG_MODE_VR: number;
  114470. /**
  114471. * Defines that both eyes of the camera should be renderered in a VR mode (webVR).
  114472. */
  114473. static readonly RIG_MODE_WEBVR: number;
  114474. /**
  114475. * Custom rig mode allowing rig cameras to be populated manually with any number of cameras
  114476. */
  114477. static readonly RIG_MODE_CUSTOM: number;
  114478. /**
  114479. * Defines if by default attaching controls should prevent the default javascript event to continue.
  114480. */
  114481. static ForceAttachControlToAlwaysPreventDefault: boolean;
  114482. /**
  114483. * Define the input manager associated with the camera.
  114484. */
  114485. inputs: CameraInputsManager<Camera>;
  114486. /** @hidden */
  114487. _position: Vector3;
  114488. /**
  114489. * Define the current local position of the camera in the scene
  114490. */
  114491. get position(): Vector3;
  114492. set position(newPosition: Vector3);
  114493. protected _upVector: Vector3;
  114494. /**
  114495. * The vector the camera should consider as up.
  114496. * (default is Vector3(0, 1, 0) aka Vector3.Up())
  114497. */
  114498. set upVector(vec: Vector3);
  114499. get upVector(): Vector3;
  114500. /**
  114501. * Define the current limit on the left side for an orthographic camera
  114502. * In scene unit
  114503. */
  114504. orthoLeft: Nullable<number>;
  114505. /**
  114506. * Define the current limit on the right side for an orthographic camera
  114507. * In scene unit
  114508. */
  114509. orthoRight: Nullable<number>;
  114510. /**
  114511. * Define the current limit on the bottom side for an orthographic camera
  114512. * In scene unit
  114513. */
  114514. orthoBottom: Nullable<number>;
  114515. /**
  114516. * Define the current limit on the top side for an orthographic camera
  114517. * In scene unit
  114518. */
  114519. orthoTop: Nullable<number>;
  114520. /**
  114521. * Field Of View is set in Radians. (default is 0.8)
  114522. */
  114523. fov: number;
  114524. /**
  114525. * Define the minimum distance the camera can see from.
  114526. * This is important to note that the depth buffer are not infinite and the closer it starts
  114527. * the more your scene might encounter depth fighting issue.
  114528. */
  114529. minZ: number;
  114530. /**
  114531. * Define the maximum distance the camera can see to.
  114532. * This is important to note that the depth buffer are not infinite and the further it end
  114533. * the more your scene might encounter depth fighting issue.
  114534. */
  114535. maxZ: number;
  114536. /**
  114537. * Define the default inertia of the camera.
  114538. * This helps giving a smooth feeling to the camera movement.
  114539. */
  114540. inertia: number;
  114541. /**
  114542. * Define the mode of the camera (Camera.PERSPECTIVE_CAMERA or Camera.ORTHOGRAPHIC_CAMERA)
  114543. */
  114544. mode: number;
  114545. /**
  114546. * Define whether the camera is intermediate.
  114547. * This is useful to not present the output directly to the screen in case of rig without post process for instance
  114548. */
  114549. isIntermediate: boolean;
  114550. /**
  114551. * Define the viewport of the camera.
  114552. * This correspond to the portion of the screen the camera will render to in normalized 0 to 1 unit.
  114553. */
  114554. viewport: Viewport;
  114555. /**
  114556. * Restricts the camera to viewing objects with the same layerMask.
  114557. * A camera with a layerMask of 1 will render mesh.layerMask & camera.layerMask!== 0
  114558. */
  114559. layerMask: number;
  114560. /**
  114561. * fovMode sets the camera frustum bounds to the viewport bounds. (default is FOVMODE_VERTICAL_FIXED)
  114562. */
  114563. fovMode: number;
  114564. /**
  114565. * Rig mode of the camera.
  114566. * This is useful to create the camera with two "eyes" instead of one to create VR or stereoscopic scenes.
  114567. * This is normally controlled byt the camera themselves as internal use.
  114568. */
  114569. cameraRigMode: number;
  114570. /**
  114571. * Defines the distance between both "eyes" in case of a RIG
  114572. */
  114573. interaxialDistance: number;
  114574. /**
  114575. * Defines if stereoscopic rendering is done side by side or over under.
  114576. */
  114577. isStereoscopicSideBySide: boolean;
  114578. /**
  114579. * 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
  114580. * This is pretty helpfull if you wish to make a camera render to a texture you could reuse somewhere
  114581. * else in the scene. (Eg. security camera)
  114582. *
  114583. * 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)
  114584. */
  114585. customRenderTargets: RenderTargetTexture[];
  114586. /**
  114587. * When set, the camera will render to this render target instead of the default canvas
  114588. *
  114589. * If the desire is to use the output of a camera as a texture in the scene consider using camera.customRenderTargets instead
  114590. */
  114591. outputRenderTarget: Nullable<RenderTargetTexture>;
  114592. /**
  114593. * Observable triggered when the camera view matrix has changed.
  114594. */
  114595. onViewMatrixChangedObservable: Observable<Camera>;
  114596. /**
  114597. * Observable triggered when the camera Projection matrix has changed.
  114598. */
  114599. onProjectionMatrixChangedObservable: Observable<Camera>;
  114600. /**
  114601. * Observable triggered when the inputs have been processed.
  114602. */
  114603. onAfterCheckInputsObservable: Observable<Camera>;
  114604. /**
  114605. * Observable triggered when reset has been called and applied to the camera.
  114606. */
  114607. onRestoreStateObservable: Observable<Camera>;
  114608. /**
  114609. * Is this camera a part of a rig system?
  114610. */
  114611. isRigCamera: boolean;
  114612. /**
  114613. * If isRigCamera set to true this will be set with the parent camera.
  114614. * The parent camera is not (!) necessarily the .parent of this camera (like in the case of XR)
  114615. */
  114616. rigParent?: Camera;
  114617. /** @hidden */
  114618. _cameraRigParams: any;
  114619. /** @hidden */
  114620. _rigCameras: Camera[];
  114621. /** @hidden */
  114622. _rigPostProcess: Nullable<PostProcess>;
  114623. protected _webvrViewMatrix: Matrix;
  114624. /** @hidden */
  114625. _skipRendering: boolean;
  114626. /** @hidden */
  114627. _projectionMatrix: Matrix;
  114628. /** @hidden */
  114629. _postProcesses: Nullable<PostProcess>[];
  114630. /** @hidden */
  114631. _activeMeshes: SmartArray<AbstractMesh>;
  114632. protected _globalPosition: Vector3;
  114633. /** @hidden */
  114634. _computedViewMatrix: Matrix;
  114635. private _doNotComputeProjectionMatrix;
  114636. private _transformMatrix;
  114637. private _frustumPlanes;
  114638. private _refreshFrustumPlanes;
  114639. private _storedFov;
  114640. private _stateStored;
  114641. /**
  114642. * Instantiates a new camera object.
  114643. * This should not be used directly but through the inherited cameras: ArcRotate, Free...
  114644. * @see https://doc.babylonjs.com/features/cameras
  114645. * @param name Defines the name of the camera in the scene
  114646. * @param position Defines the position of the camera
  114647. * @param scene Defines the scene the camera belongs too
  114648. * @param setActiveOnSceneIfNoneActive Defines if the camera should be set as active after creation if no other camera have been defined in the scene
  114649. */
  114650. constructor(name: string, position: Vector3, scene: Scene, setActiveOnSceneIfNoneActive?: boolean);
  114651. /**
  114652. * Store current camera state (fov, position, etc..)
  114653. * @returns the camera
  114654. */
  114655. storeState(): Camera;
  114656. /**
  114657. * Restores the camera state values if it has been stored. You must call storeState() first
  114658. */
  114659. protected _restoreStateValues(): boolean;
  114660. /**
  114661. * Restored camera state. You must call storeState() first.
  114662. * @returns true if restored and false otherwise
  114663. */
  114664. restoreState(): boolean;
  114665. /**
  114666. * Gets the class name of the camera.
  114667. * @returns the class name
  114668. */
  114669. getClassName(): string;
  114670. /** @hidden */
  114671. readonly _isCamera: boolean;
  114672. /**
  114673. * Gets a string representation of the camera useful for debug purpose.
  114674. * @param fullDetails Defines that a more verboe level of logging is required
  114675. * @returns the string representation
  114676. */
  114677. toString(fullDetails?: boolean): string;
  114678. /**
  114679. * Gets the current world space position of the camera.
  114680. */
  114681. get globalPosition(): Vector3;
  114682. /**
  114683. * Gets the list of active meshes this frame (meshes no culled or excluded by lod s in the frame)
  114684. * @returns the active meshe list
  114685. */
  114686. getActiveMeshes(): SmartArray<AbstractMesh>;
  114687. /**
  114688. * Check whether a mesh is part of the current active mesh list of the camera
  114689. * @param mesh Defines the mesh to check
  114690. * @returns true if active, false otherwise
  114691. */
  114692. isActiveMesh(mesh: Mesh): boolean;
  114693. /**
  114694. * Is this camera ready to be used/rendered
  114695. * @param completeCheck defines if a complete check (including post processes) has to be done (false by default)
  114696. * @return true if the camera is ready
  114697. */
  114698. isReady(completeCheck?: boolean): boolean;
  114699. /** @hidden */
  114700. _initCache(): void;
  114701. /** @hidden */
  114702. _updateCache(ignoreParentClass?: boolean): void;
  114703. /** @hidden */
  114704. _isSynchronized(): boolean;
  114705. /** @hidden */
  114706. _isSynchronizedViewMatrix(): boolean;
  114707. /** @hidden */
  114708. _isSynchronizedProjectionMatrix(): boolean;
  114709. /**
  114710. * Attach the input controls to a specific dom element to get the input from.
  114711. * @param element Defines the element the controls should be listened from
  114712. * @param noPreventDefault Defines whether event caught by the controls should call preventdefault() (https://developer.mozilla.org/en-US/docs/Web/API/Event/preventDefault)
  114713. */
  114714. attachControl(element: HTMLElement, noPreventDefault?: boolean): void;
  114715. /**
  114716. * Detach the current controls from the specified dom element.
  114717. * @param element Defines the element to stop listening the inputs from
  114718. */
  114719. detachControl(element: HTMLElement): void;
  114720. /**
  114721. * Update the camera state according to the different inputs gathered during the frame.
  114722. */
  114723. update(): void;
  114724. /** @hidden */
  114725. _checkInputs(): void;
  114726. /** @hidden */
  114727. get rigCameras(): Camera[];
  114728. /**
  114729. * Gets the post process used by the rig cameras
  114730. */
  114731. get rigPostProcess(): Nullable<PostProcess>;
  114732. /**
  114733. * Internal, gets the first post proces.
  114734. * @returns the first post process to be run on this camera.
  114735. */
  114736. _getFirstPostProcess(): Nullable<PostProcess>;
  114737. private _cascadePostProcessesToRigCams;
  114738. /**
  114739. * Attach a post process to the camera.
  114740. * @see https://doc.babylonjs.com/how_to/how_to_use_postprocesses#attach-postprocess
  114741. * @param postProcess The post process to attach to the camera
  114742. * @param insertAt The position of the post process in case several of them are in use in the scene
  114743. * @returns the position the post process has been inserted at
  114744. */
  114745. attachPostProcess(postProcess: PostProcess, insertAt?: Nullable<number>): number;
  114746. /**
  114747. * Detach a post process to the camera.
  114748. * @see https://doc.babylonjs.com/how_to/how_to_use_postprocesses#attach-postprocess
  114749. * @param postProcess The post process to detach from the camera
  114750. */
  114751. detachPostProcess(postProcess: PostProcess): void;
  114752. /**
  114753. * Gets the current world matrix of the camera
  114754. */
  114755. getWorldMatrix(): Matrix;
  114756. /** @hidden */
  114757. _getViewMatrix(): Matrix;
  114758. /**
  114759. * Gets the current view matrix of the camera.
  114760. * @param force forces the camera to recompute the matrix without looking at the cached state
  114761. * @returns the view matrix
  114762. */
  114763. getViewMatrix(force?: boolean): Matrix;
  114764. /**
  114765. * Freeze the projection matrix.
  114766. * It will prevent the cache check of the camera projection compute and can speed up perf
  114767. * if no parameter of the camera are meant to change
  114768. * @param projection Defines manually a projection if necessary
  114769. */
  114770. freezeProjectionMatrix(projection?: Matrix): void;
  114771. /**
  114772. * Unfreeze the projection matrix if it has previously been freezed by freezeProjectionMatrix.
  114773. */
  114774. unfreezeProjectionMatrix(): void;
  114775. /**
  114776. * Gets the current projection matrix of the camera.
  114777. * @param force forces the camera to recompute the matrix without looking at the cached state
  114778. * @returns the projection matrix
  114779. */
  114780. getProjectionMatrix(force?: boolean): Matrix;
  114781. /**
  114782. * Gets the transformation matrix (ie. the multiplication of view by projection matrices)
  114783. * @returns a Matrix
  114784. */
  114785. getTransformationMatrix(): Matrix;
  114786. private _updateFrustumPlanes;
  114787. /**
  114788. * Checks if a cullable object (mesh...) is in the camera frustum
  114789. * This checks the bounding box center. See isCompletelyInFrustum for a full bounding check
  114790. * @param target The object to check
  114791. * @param checkRigCameras If the rig cameras should be checked (eg. with webVR camera both eyes should be checked) (Default: false)
  114792. * @returns true if the object is in frustum otherwise false
  114793. */
  114794. isInFrustum(target: ICullable, checkRigCameras?: boolean): boolean;
  114795. /**
  114796. * Checks if a cullable object (mesh...) is in the camera frustum
  114797. * Unlike isInFrustum this cheks the full bounding box
  114798. * @param target The object to check
  114799. * @returns true if the object is in frustum otherwise false
  114800. */
  114801. isCompletelyInFrustum(target: ICullable): boolean;
  114802. /**
  114803. * Gets a ray in the forward direction from the camera.
  114804. * @param length Defines the length of the ray to create
  114805. * @param transform Defines the transform to apply to the ray, by default the world matrx is used to create a workd space ray
  114806. * @param origin Defines the start point of the ray which defaults to the camera position
  114807. * @returns the forward ray
  114808. */
  114809. getForwardRay(length?: number, transform?: Matrix, origin?: Vector3): Ray;
  114810. /**
  114811. * Gets a ray in the forward direction from the camera.
  114812. * @param refRay the ray to (re)use when setting the values
  114813. * @param length Defines the length of the ray to create
  114814. * @param transform Defines the transform to apply to the ray, by default the world matrx is used to create a workd space ray
  114815. * @param origin Defines the start point of the ray which defaults to the camera position
  114816. * @returns the forward ray
  114817. */
  114818. getForwardRayToRef(refRay: Ray, length?: number, transform?: Matrix, origin?: Vector3): Ray;
  114819. /**
  114820. * Releases resources associated with this node.
  114821. * @param doNotRecurse Set to true to not recurse into each children (recurse into each children by default)
  114822. * @param disposeMaterialAndTextures Set to true to also dispose referenced materials and textures (false by default)
  114823. */
  114824. dispose(doNotRecurse?: boolean, disposeMaterialAndTextures?: boolean): void;
  114825. /** @hidden */
  114826. _isLeftCamera: boolean;
  114827. /**
  114828. * Gets the left camera of a rig setup in case of Rigged Camera
  114829. */
  114830. get isLeftCamera(): boolean;
  114831. /** @hidden */
  114832. _isRightCamera: boolean;
  114833. /**
  114834. * Gets the right camera of a rig setup in case of Rigged Camera
  114835. */
  114836. get isRightCamera(): boolean;
  114837. /**
  114838. * Gets the left camera of a rig setup in case of Rigged Camera
  114839. */
  114840. get leftCamera(): Nullable<FreeCamera>;
  114841. /**
  114842. * Gets the right camera of a rig setup in case of Rigged Camera
  114843. */
  114844. get rightCamera(): Nullable<FreeCamera>;
  114845. /**
  114846. * Gets the left camera target of a rig setup in case of Rigged Camera
  114847. * @returns the target position
  114848. */
  114849. getLeftTarget(): Nullable<Vector3>;
  114850. /**
  114851. * Gets the right camera target of a rig setup in case of Rigged Camera
  114852. * @returns the target position
  114853. */
  114854. getRightTarget(): Nullable<Vector3>;
  114855. /**
  114856. * @hidden
  114857. */
  114858. setCameraRigMode(mode: number, rigParams: any): void;
  114859. /** @hidden */
  114860. static _setStereoscopicRigMode(camera: Camera): void;
  114861. /** @hidden */
  114862. static _setStereoscopicAnaglyphRigMode(camera: Camera): void;
  114863. /** @hidden */
  114864. static _setVRRigMode(camera: Camera, rigParams: any): void;
  114865. /** @hidden */
  114866. static _setWebVRRigMode(camera: Camera, rigParams: any): void;
  114867. /** @hidden */
  114868. _getVRProjectionMatrix(): Matrix;
  114869. protected _updateCameraRotationMatrix(): void;
  114870. protected _updateWebVRCameraRotationMatrix(): void;
  114871. /**
  114872. * This function MUST be overwritten by the different WebVR cameras available.
  114873. * The context in which it is running is the RIG camera. So 'this' is the TargetCamera, left or right.
  114874. * @hidden
  114875. */
  114876. _getWebVRProjectionMatrix(): Matrix;
  114877. /**
  114878. * This function MUST be overwritten by the different WebVR cameras available.
  114879. * The context in which it is running is the RIG camera. So 'this' is the TargetCamera, left or right.
  114880. * @hidden
  114881. */
  114882. _getWebVRViewMatrix(): Matrix;
  114883. /** @hidden */
  114884. setCameraRigParameter(name: string, value: any): void;
  114885. /**
  114886. * needs to be overridden by children so sub has required properties to be copied
  114887. * @hidden
  114888. */
  114889. createRigCamera(name: string, cameraIndex: number): Nullable<Camera>;
  114890. /**
  114891. * May need to be overridden by children
  114892. * @hidden
  114893. */
  114894. _updateRigCameras(): void;
  114895. /** @hidden */
  114896. _setupInputs(): void;
  114897. /**
  114898. * Serialiaze the camera setup to a json represention
  114899. * @returns the JSON representation
  114900. */
  114901. serialize(): any;
  114902. /**
  114903. * Clones the current camera.
  114904. * @param name The cloned camera name
  114905. * @returns the cloned camera
  114906. */
  114907. clone(name: string): Camera;
  114908. /**
  114909. * Gets the direction of the camera relative to a given local axis.
  114910. * @param localAxis Defines the reference axis to provide a relative direction.
  114911. * @return the direction
  114912. */
  114913. getDirection(localAxis: Vector3): Vector3;
  114914. /**
  114915. * Returns the current camera absolute rotation
  114916. */
  114917. get absoluteRotation(): Quaternion;
  114918. /**
  114919. * Gets the direction of the camera relative to a given local axis into a passed vector.
  114920. * @param localAxis Defines the reference axis to provide a relative direction.
  114921. * @param result Defines the vector to store the result in
  114922. */
  114923. getDirectionToRef(localAxis: Vector3, result: Vector3): void;
  114924. /**
  114925. * Gets a camera constructor for a given camera type
  114926. * @param type The type of the camera to construct (should be equal to one of the camera class name)
  114927. * @param name The name of the camera the result will be able to instantiate
  114928. * @param scene The scene the result will construct the camera in
  114929. * @param interaxial_distance In case of stereoscopic setup, the distance between both eyes
  114930. * @param isStereoscopicSideBySide In case of stereoscopic setup, should the sereo be side b side
  114931. * @returns a factory method to construc the camera
  114932. */
  114933. static GetConstructorFromName(type: string, name: string, scene: Scene, interaxial_distance?: number, isStereoscopicSideBySide?: boolean): () => Camera;
  114934. /**
  114935. * Compute the world matrix of the camera.
  114936. * @returns the camera world matrix
  114937. */
  114938. computeWorldMatrix(): Matrix;
  114939. /**
  114940. * Parse a JSON and creates the camera from the parsed information
  114941. * @param parsedCamera The JSON to parse
  114942. * @param scene The scene to instantiate the camera in
  114943. * @returns the newly constructed camera
  114944. */
  114945. static Parse(parsedCamera: any, scene: Scene): Camera;
  114946. }
  114947. }
  114948. declare module BABYLON {
  114949. /**
  114950. * Class containing static functions to help procedurally build meshes
  114951. */
  114952. export class DiscBuilder {
  114953. /**
  114954. * Creates a plane polygonal mesh. By default, this is a disc
  114955. * * The parameter `radius` sets the radius size (float) of the polygon (default 0.5)
  114956. * * 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
  114957. * * 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
  114958. * * You can also set the mesh side orientation with the values : BABYLON.Mesh.FRONTSIDE (default), BABYLON.Mesh.BACKSIDE or BABYLON.Mesh.DOUBLESIDE
  114959. * * If you create a double-sided mesh, you can choose what parts of the texture image to crop and stick respectively on the front and the back sides with the parameters `frontUVs` and `backUVs` (Vector4). Detail here : https://doc.babylonjs.com/babylon101/discover_basic_elements#side-orientation
  114960. * * The mesh can be set to updatable with the boolean parameter `updatable` (default false) if its internal geometry is supposed to change once created
  114961. * @param name defines the name of the mesh
  114962. * @param options defines the options used to create the mesh
  114963. * @param scene defines the hosting scene
  114964. * @returns the plane polygonal mesh
  114965. * @see https://doc.babylonjs.com/how_to/set_shapes#disc-or-regular-polygon
  114966. */
  114967. static CreateDisc(name: string, options: {
  114968. radius?: number;
  114969. tessellation?: number;
  114970. arc?: number;
  114971. updatable?: boolean;
  114972. sideOrientation?: number;
  114973. frontUVs?: Vector4;
  114974. backUVs?: Vector4;
  114975. }, scene?: Nullable<Scene>): Mesh;
  114976. }
  114977. }
  114978. declare module BABYLON {
  114979. /**
  114980. * The SPS is a single updatable mesh. The solid particles are simply separate parts or faces fo this big mesh.
  114981. *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.
  114982. * The SPS is also a particle system. It provides some methods to manage the particles.
  114983. * However it is behavior agnostic. This means it has no emitter, no particle physics, no particle recycler. You have to implement your own behavior.
  114984. *
  114985. * Full documentation here : https://doc.babylonjs.com/how_to/Solid_Particle_System
  114986. */
  114987. export class SolidParticleSystem implements IDisposable {
  114988. /**
  114989. * The SPS array of Solid Particle objects. Just access each particle as with any classic array.
  114990. * Example : var p = SPS.particles[i];
  114991. */
  114992. particles: SolidParticle[];
  114993. /**
  114994. * The SPS total number of particles. Read only. Use SPS.counter instead if you need to set your own value.
  114995. */
  114996. nbParticles: number;
  114997. /**
  114998. * If the particles must ever face the camera (default false). Useful for planar particles.
  114999. */
  115000. billboard: boolean;
  115001. /**
  115002. * Recompute normals when adding a shape
  115003. */
  115004. recomputeNormals: boolean;
  115005. /**
  115006. * This a counter ofr your own usage. It's not set by any SPS functions.
  115007. */
  115008. counter: number;
  115009. /**
  115010. * The SPS name. This name is also given to the underlying mesh.
  115011. */
  115012. name: string;
  115013. /**
  115014. * The SPS mesh. It's a standard BJS Mesh, so all the methods from the Mesh class are avalaible.
  115015. */
  115016. mesh: Mesh;
  115017. /**
  115018. * This empty object is intended to store some SPS specific or temporary values in order to lower the Garbage Collector activity.
  115019. * Please read : https://doc.babylonjs.com/how_to/Solid_Particle_System#garbage-collector-concerns
  115020. */
  115021. vars: any;
  115022. /**
  115023. * This array is populated when the SPS is set as 'pickable'.
  115024. * Each key of this array is a `faceId` value that you can get from a pickResult object.
  115025. * Each element of this array is an object `{idx: int, faceId: int}`.
  115026. * `idx` is the picked particle index in the `SPS.particles` array
  115027. * `faceId` is the picked face index counted within this particle.
  115028. * This array is the first element of the pickedBySubMesh array : sps.pickBySubMesh[0].
  115029. * It's not pertinent to use it when using a SPS with the support for MultiMaterial enabled.
  115030. * Use the method SPS.pickedParticle(pickingInfo) instead.
  115031. * Please read : https://doc.babylonjs.com/how_to/Solid_Particle_System#pickable-particles
  115032. */
  115033. pickedParticles: {
  115034. idx: number;
  115035. faceId: number;
  115036. }[];
  115037. /**
  115038. * This array is populated when the SPS is set as 'pickable'
  115039. * Each key of this array is a submesh index.
  115040. * Each element of this array is a second array defined like this :
  115041. * Each key of this second array is a `faceId` value that you can get from a pickResult object.
  115042. * Each element of this second array is an object `{idx: int, faceId: int}`.
  115043. * `idx` is the picked particle index in the `SPS.particles` array
  115044. * `faceId` is the picked face index counted within this particle.
  115045. * It's better to use the method SPS.pickedParticle(pickingInfo) rather than using directly this array.
  115046. * Please read : https://doc.babylonjs.com/how_to/Solid_Particle_System#pickable-particles
  115047. */
  115048. pickedBySubMesh: {
  115049. idx: number;
  115050. faceId: number;
  115051. }[][];
  115052. /**
  115053. * This array is populated when `enableDepthSort` is set to true.
  115054. * Each element of this array is an instance of the class DepthSortedParticle.
  115055. */
  115056. depthSortedParticles: DepthSortedParticle[];
  115057. /**
  115058. * If the particle intersection must be computed only with the bounding sphere (no bounding box computation, so faster). (Internal use only)
  115059. * @hidden
  115060. */
  115061. _bSphereOnly: boolean;
  115062. /**
  115063. * A number to multiply the boundind sphere radius by in order to reduce it for instance. (Internal use only)
  115064. * @hidden
  115065. */
  115066. _bSphereRadiusFactor: number;
  115067. private _scene;
  115068. private _positions;
  115069. private _indices;
  115070. private _normals;
  115071. private _colors;
  115072. private _uvs;
  115073. private _indices32;
  115074. private _positions32;
  115075. private _normals32;
  115076. private _fixedNormal32;
  115077. private _colors32;
  115078. private _uvs32;
  115079. private _index;
  115080. private _updatable;
  115081. private _pickable;
  115082. private _isVisibilityBoxLocked;
  115083. private _alwaysVisible;
  115084. private _depthSort;
  115085. private _expandable;
  115086. private _shapeCounter;
  115087. private _copy;
  115088. private _color;
  115089. private _computeParticleColor;
  115090. private _computeParticleTexture;
  115091. private _computeParticleRotation;
  115092. private _computeParticleVertex;
  115093. private _computeBoundingBox;
  115094. private _depthSortParticles;
  115095. private _camera;
  115096. private _mustUnrotateFixedNormals;
  115097. private _particlesIntersect;
  115098. private _needs32Bits;
  115099. private _isNotBuilt;
  115100. private _lastParticleId;
  115101. private _idxOfId;
  115102. private _multimaterialEnabled;
  115103. private _useModelMaterial;
  115104. private _indicesByMaterial;
  115105. private _materialIndexes;
  115106. private _depthSortFunction;
  115107. private _materialSortFunction;
  115108. private _materials;
  115109. private _multimaterial;
  115110. private _materialIndexesById;
  115111. private _defaultMaterial;
  115112. private _autoUpdateSubMeshes;
  115113. private _tmpVertex;
  115114. /**
  115115. * Creates a SPS (Solid Particle System) object.
  115116. * @param name (String) is the SPS name, this will be the underlying mesh name.
  115117. * @param scene (Scene) is the scene in which the SPS is added.
  115118. * @param options defines the options of the sps e.g.
  115119. * * updatable (optional boolean, default true) : if the SPS must be updatable or immutable.
  115120. * * isPickable (optional boolean, default false) : if the solid particles must be pickable.
  115121. * * enableDepthSort (optional boolean, default false) : if the solid particles must be sorted in the geometry according to their distance to the camera.
  115122. * * 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.
  115123. * * enableMultiMaterial (optional boolean, default false) : if the solid particles can be given different materials.
  115124. * * expandable (optional boolean, default false) : if particles can still be added after the initial SPS mesh creation.
  115125. * * particleIntersection (optional boolean, default false) : if the solid particle intersections must be computed.
  115126. * * boundingSphereOnly (optional boolean, default false) : if the particle intersection must be computed only with the bounding sphere (no bounding box computation, so faster).
  115127. * * bSphereRadiusFactor (optional float, default 1.0) : a number to multiply the boundind sphere radius by in order to reduce it for instance.
  115128. * @example bSphereRadiusFactor = 1.0 / Math.sqrt(3.0) => the bounding sphere exactly matches a spherical mesh.
  115129. */
  115130. constructor(name: string, scene: Scene, options?: {
  115131. updatable?: boolean;
  115132. isPickable?: boolean;
  115133. enableDepthSort?: boolean;
  115134. particleIntersection?: boolean;
  115135. boundingSphereOnly?: boolean;
  115136. bSphereRadiusFactor?: number;
  115137. expandable?: boolean;
  115138. useModelMaterial?: boolean;
  115139. enableMultiMaterial?: boolean;
  115140. });
  115141. /**
  115142. * Builds the SPS underlying mesh. Returns a standard Mesh.
  115143. * If no model shape was added to the SPS, the returned mesh is just a single triangular plane.
  115144. * @returns the created mesh
  115145. */
  115146. buildMesh(): Mesh;
  115147. /**
  115148. * Digests the mesh and generates as many solid particles in the system as wanted. Returns the SPS.
  115149. * These particles will have the same geometry than the mesh parts and will be positioned at the same localisation than the mesh original places.
  115150. * Thus the particles generated from `digest()` have their property `position` set yet.
  115151. * @param mesh ( Mesh ) is the mesh to be digested
  115152. * @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
  115153. * {delta} (optional integer, default 0) is the random extra number of facets per particle , each particle will have between `facetNb` and `facetNb + delta` facets
  115154. * {number} (optional positive integer) is the wanted number of particles : each particle is built with `mesh_total_facets / number` facets
  115155. * {storage} (optional existing array) is an array where the particles will be stored for a further use instead of being inserted in the SPS.
  115156. * @returns the current SPS
  115157. */
  115158. digest(mesh: Mesh, options?: {
  115159. facetNb?: number;
  115160. number?: number;
  115161. delta?: number;
  115162. storage?: [];
  115163. }): SolidParticleSystem;
  115164. /**
  115165. * Unrotate the fixed normals in case the mesh was built with pre-rotated particles, ex : use of positionFunction in addShape()
  115166. * @hidden
  115167. */
  115168. private _unrotateFixedNormals;
  115169. /**
  115170. * Resets the temporary working copy particle
  115171. * @hidden
  115172. */
  115173. private _resetCopy;
  115174. /**
  115175. * Inserts the shape model geometry in the global SPS mesh by updating the positions, indices, normals, colors, uvs arrays
  115176. * @param p the current index in the positions array to be updated
  115177. * @param ind the current index in the indices array
  115178. * @param shape a Vector3 array, the shape geometry
  115179. * @param positions the positions array to be updated
  115180. * @param meshInd the shape indices array
  115181. * @param indices the indices array to be updated
  115182. * @param meshUV the shape uv array
  115183. * @param uvs the uv array to be updated
  115184. * @param meshCol the shape color array
  115185. * @param colors the color array to be updated
  115186. * @param meshNor the shape normals array
  115187. * @param normals the normals array to be updated
  115188. * @param idx the particle index
  115189. * @param idxInShape the particle index in its shape
  115190. * @param options the addShape() method passed options
  115191. * @model the particle model
  115192. * @hidden
  115193. */
  115194. private _meshBuilder;
  115195. /**
  115196. * Returns a shape Vector3 array from positions float array
  115197. * @param positions float array
  115198. * @returns a vector3 array
  115199. * @hidden
  115200. */
  115201. private _posToShape;
  115202. /**
  115203. * Returns a shapeUV array from a float uvs (array deep copy)
  115204. * @param uvs as a float array
  115205. * @returns a shapeUV array
  115206. * @hidden
  115207. */
  115208. private _uvsToShapeUV;
  115209. /**
  115210. * Adds a new particle object in the particles array
  115211. * @param idx particle index in particles array
  115212. * @param id particle id
  115213. * @param idxpos positionIndex : the starting index of the particle vertices in the SPS "positions" array
  115214. * @param idxind indiceIndex : he starting index of the particle indices in the SPS "indices" array
  115215. * @param model particle ModelShape object
  115216. * @param shapeId model shape identifier
  115217. * @param idxInShape index of the particle in the current model
  115218. * @param bInfo model bounding info object
  115219. * @param storage target storage array, if any
  115220. * @hidden
  115221. */
  115222. private _addParticle;
  115223. /**
  115224. * Adds some particles to the SPS from the model shape. Returns the shape id.
  115225. * Please read the doc : https://doc.babylonjs.com/how_to/Solid_Particle_System#create-an-immutable-sps
  115226. * @param mesh is any Mesh object that will be used as a model for the solid particles.
  115227. * @param nb (positive integer) the number of particles to be created from this model
  115228. * @param options {positionFunction} is an optional javascript function to called for each particle on SPS creation.
  115229. * {vertexFunction} is an optional javascript function to called for each vertex of each particle on SPS creation
  115230. * {storage} (optional existing array) is an array where the particles will be stored for a further use instead of being inserted in the SPS.
  115231. * @returns the number of shapes in the system
  115232. */
  115233. addShape(mesh: Mesh, nb: number, options?: {
  115234. positionFunction?: any;
  115235. vertexFunction?: any;
  115236. storage?: [];
  115237. }): number;
  115238. /**
  115239. * Rebuilds a particle back to its just built status : if needed, recomputes the custom positions and vertices
  115240. * @hidden
  115241. */
  115242. private _rebuildParticle;
  115243. /**
  115244. * Rebuilds the whole mesh and updates the VBO : custom positions and vertices are recomputed if needed.
  115245. * @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.
  115246. * @returns the SPS.
  115247. */
  115248. rebuildMesh(reset?: boolean): SolidParticleSystem;
  115249. /** Removes the particles from the start-th to the end-th included from an expandable SPS (required).
  115250. * Returns an array with the removed particles.
  115251. * 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.
  115252. * The SPS can't be empty so at least one particle needs to remain in place.
  115253. * Under the hood, the VertexData array, so the VBO buffer, is recreated each call.
  115254. * @param start index of the first particle to remove
  115255. * @param end index of the last particle to remove (included)
  115256. * @returns an array populated with the removed particles
  115257. */
  115258. removeParticles(start: number, end: number): SolidParticle[];
  115259. /**
  115260. * Inserts some pre-created particles in the solid particle system so that they can be managed by setParticles().
  115261. * @param solidParticleArray an array populated with Solid Particles objects
  115262. * @returns the SPS
  115263. */
  115264. insertParticlesFromArray(solidParticleArray: SolidParticle[]): SolidParticleSystem;
  115265. /**
  115266. * Creates a new particle and modifies the SPS mesh geometry :
  115267. * - calls _meshBuilder() to increase the SPS mesh geometry step by step
  115268. * - calls _addParticle() to populate the particle array
  115269. * factorized code from addShape() and insertParticlesFromArray()
  115270. * @param idx particle index in the particles array
  115271. * @param i particle index in its shape
  115272. * @param modelShape particle ModelShape object
  115273. * @param shape shape vertex array
  115274. * @param meshInd shape indices array
  115275. * @param meshUV shape uv array
  115276. * @param meshCol shape color array
  115277. * @param meshNor shape normals array
  115278. * @param bbInfo shape bounding info
  115279. * @param storage target particle storage
  115280. * @options addShape() passed options
  115281. * @hidden
  115282. */
  115283. private _insertNewParticle;
  115284. /**
  115285. * Sets all the particles : this method actually really updates the mesh according to the particle positions, rotations, colors, textures, etc.
  115286. * This method calls `updateParticle()` for each particle of the SPS.
  115287. * For an animated SPS, it is usually called within the render loop.
  115288. * 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.
  115289. * @param start The particle index in the particle array where to start to compute the particle property values _(default 0)_
  115290. * @param end The particle index in the particle array where to stop to compute the particle property values _(default nbParticle - 1)_
  115291. * @param update If the mesh must be finally updated on this call after all the particle computations _(default true)_
  115292. * @returns the SPS.
  115293. */
  115294. setParticles(start?: number, end?: number, update?: boolean): SolidParticleSystem;
  115295. /**
  115296. * Disposes the SPS.
  115297. */
  115298. dispose(): void;
  115299. /** Returns an object {idx: numbern faceId: number} for the picked particle from the passed pickingInfo object.
  115300. * idx is the particle index in the SPS
  115301. * faceId is the picked face index counted within this particle.
  115302. * Returns null if the pickInfo can't identify a picked particle.
  115303. * @param pickingInfo (PickingInfo object)
  115304. * @returns {idx: number, faceId: number} or null
  115305. */
  115306. pickedParticle(pickingInfo: PickingInfo): Nullable<{
  115307. idx: number;
  115308. faceId: number;
  115309. }>;
  115310. /**
  115311. * Returns a SolidParticle object from its identifier : particle.id
  115312. * @param id (integer) the particle Id
  115313. * @returns the searched particle or null if not found in the SPS.
  115314. */
  115315. getParticleById(id: number): Nullable<SolidParticle>;
  115316. /**
  115317. * Returns a new array populated with the particles having the passed shapeId.
  115318. * @param shapeId (integer) the shape identifier
  115319. * @returns a new solid particle array
  115320. */
  115321. getParticlesByShapeId(shapeId: number): SolidParticle[];
  115322. /**
  115323. * Populates the passed array "ref" with the particles having the passed shapeId.
  115324. * @param shapeId the shape identifier
  115325. * @returns the SPS
  115326. * @param ref
  115327. */
  115328. getParticlesByShapeIdToRef(shapeId: number, ref: SolidParticle[]): SolidParticleSystem;
  115329. /**
  115330. * Computes the required SubMeshes according the materials assigned to the particles.
  115331. * @returns the solid particle system.
  115332. * Does nothing if called before the SPS mesh is built.
  115333. */
  115334. computeSubMeshes(): SolidParticleSystem;
  115335. /**
  115336. * Sorts the solid particles by material when MultiMaterial is enabled.
  115337. * Updates the indices32 array.
  115338. * Updates the indicesByMaterial array.
  115339. * Updates the mesh indices array.
  115340. * @returns the SPS
  115341. * @hidden
  115342. */
  115343. private _sortParticlesByMaterial;
  115344. /**
  115345. * Sets the material indexes by id materialIndexesById[id] = materialIndex
  115346. * @hidden
  115347. */
  115348. private _setMaterialIndexesById;
  115349. /**
  115350. * Returns an array with unique values of Materials from the passed array
  115351. * @param array the material array to be checked and filtered
  115352. * @hidden
  115353. */
  115354. private _filterUniqueMaterialId;
  115355. /**
  115356. * Sets a new Standard Material as _defaultMaterial if not already set.
  115357. * @hidden
  115358. */
  115359. private _setDefaultMaterial;
  115360. /**
  115361. * Visibilty helper : Recomputes the visible size according to the mesh bounding box
  115362. * doc : https://doc.babylonjs.com/how_to/Solid_Particle_System#sps-visibility
  115363. * @returns the SPS.
  115364. */
  115365. refreshVisibleSize(): SolidParticleSystem;
  115366. /**
  115367. * Visibility helper : Sets the size of a visibility box, this sets the underlying mesh bounding box.
  115368. * @param size the size (float) of the visibility box
  115369. * note : this doesn't lock the SPS mesh bounding box.
  115370. * doc : https://doc.babylonjs.com/how_to/Solid_Particle_System#sps-visibility
  115371. */
  115372. setVisibilityBox(size: number): void;
  115373. /**
  115374. * Gets whether the SPS as always visible or not
  115375. * doc : https://doc.babylonjs.com/how_to/Solid_Particle_System#sps-visibility
  115376. */
  115377. get isAlwaysVisible(): boolean;
  115378. /**
  115379. * Sets the SPS as always visible or not
  115380. * doc : https://doc.babylonjs.com/how_to/Solid_Particle_System#sps-visibility
  115381. */
  115382. set isAlwaysVisible(val: boolean);
  115383. /**
  115384. * Sets the SPS visibility box as locked or not. This enables/disables the underlying mesh bounding box updates.
  115385. * doc : https://doc.babylonjs.com/how_to/Solid_Particle_System#sps-visibility
  115386. */
  115387. set isVisibilityBoxLocked(val: boolean);
  115388. /**
  115389. * Gets if the SPS visibility box as locked or not. This enables/disables the underlying mesh bounding box updates.
  115390. * doc : https://doc.babylonjs.com/how_to/Solid_Particle_System#sps-visibility
  115391. */
  115392. get isVisibilityBoxLocked(): boolean;
  115393. /**
  115394. * Tells to `setParticles()` to compute the particle rotations or not.
  115395. * Default value : true. The SPS is faster when it's set to false.
  115396. * Note : the particle rotations aren't stored values, so setting `computeParticleRotation` to false will prevents the particle to rotate.
  115397. */
  115398. set computeParticleRotation(val: boolean);
  115399. /**
  115400. * Tells to `setParticles()` to compute the particle colors or not.
  115401. * Default value : true. The SPS is faster when it's set to false.
  115402. * Note : the particle colors are stored values, so setting `computeParticleColor` to false will keep yet the last colors set.
  115403. */
  115404. set computeParticleColor(val: boolean);
  115405. set computeParticleTexture(val: boolean);
  115406. /**
  115407. * Tells to `setParticles()` to call the vertex function for each vertex of each particle, or not.
  115408. * Default value : false. The SPS is faster when it's set to false.
  115409. * Note : the particle custom vertex positions aren't stored values.
  115410. */
  115411. set computeParticleVertex(val: boolean);
  115412. /**
  115413. * Tells to `setParticles()` to compute or not the mesh bounding box when computing the particle positions.
  115414. */
  115415. set computeBoundingBox(val: boolean);
  115416. /**
  115417. * Tells to `setParticles()` to sort or not the distance between each particle and the camera.
  115418. * Skipped when `enableDepthSort` is set to `false` (default) at construction time.
  115419. * Default : `true`
  115420. */
  115421. set depthSortParticles(val: boolean);
  115422. /**
  115423. * Gets if `setParticles()` computes the particle rotations or not.
  115424. * Default value : true. The SPS is faster when it's set to false.
  115425. * Note : the particle rotations aren't stored values, so setting `computeParticleRotation` to false will prevents the particle to rotate.
  115426. */
  115427. get computeParticleRotation(): boolean;
  115428. /**
  115429. * Gets if `setParticles()` computes the particle colors or not.
  115430. * Default value : true. The SPS is faster when it's set to false.
  115431. * Note : the particle colors are stored values, so setting `computeParticleColor` to false will keep yet the last colors set.
  115432. */
  115433. get computeParticleColor(): boolean;
  115434. /**
  115435. * Gets if `setParticles()` computes the particle textures or not.
  115436. * Default value : true. The SPS is faster when it's set to false.
  115437. * Note : the particle textures are stored values, so setting `computeParticleTexture` to false will keep yet the last colors set.
  115438. */
  115439. get computeParticleTexture(): boolean;
  115440. /**
  115441. * Gets if `setParticles()` calls the vertex function for each vertex of each particle, or not.
  115442. * Default value : false. The SPS is faster when it's set to false.
  115443. * Note : the particle custom vertex positions aren't stored values.
  115444. */
  115445. get computeParticleVertex(): boolean;
  115446. /**
  115447. * Gets if `setParticles()` computes or not the mesh bounding box when computing the particle positions.
  115448. */
  115449. get computeBoundingBox(): boolean;
  115450. /**
  115451. * Gets if `setParticles()` sorts or not the distance between each particle and the camera.
  115452. * Skipped when `enableDepthSort` is set to `false` (default) at construction time.
  115453. * Default : `true`
  115454. */
  115455. get depthSortParticles(): boolean;
  115456. /**
  115457. * Gets if the SPS is created as expandable at construction time.
  115458. * Default : `false`
  115459. */
  115460. get expandable(): boolean;
  115461. /**
  115462. * Gets if the SPS supports the Multi Materials
  115463. */
  115464. get multimaterialEnabled(): boolean;
  115465. /**
  115466. * Gets if the SPS uses the model materials for its own multimaterial.
  115467. */
  115468. get useModelMaterial(): boolean;
  115469. /**
  115470. * The SPS used material array.
  115471. */
  115472. get materials(): Material[];
  115473. /**
  115474. * Sets the SPS MultiMaterial from the passed materials.
  115475. * Note : the passed array is internally copied and not used then by reference.
  115476. * @param materials an array of material objects. This array indexes are the materialIndex values of the particles.
  115477. */
  115478. setMultiMaterial(materials: Material[]): void;
  115479. /**
  115480. * The SPS computed multimaterial object
  115481. */
  115482. get multimaterial(): MultiMaterial;
  115483. set multimaterial(mm: MultiMaterial);
  115484. /**
  115485. * If the subMeshes must be updated on the next call to setParticles()
  115486. */
  115487. get autoUpdateSubMeshes(): boolean;
  115488. set autoUpdateSubMeshes(val: boolean);
  115489. /**
  115490. * This function does nothing. It may be overwritten to set all the particle first values.
  115491. * The SPS doesn't call this function, you may have to call it by your own.
  115492. * doc : https://doc.babylonjs.com/how_to/Solid_Particle_System#particle-management
  115493. */
  115494. initParticles(): void;
  115495. /**
  115496. * This function does nothing. It may be overwritten to recycle a particle.
  115497. * The SPS doesn't call this function, you may have to call it by your own.
  115498. * doc : https://doc.babylonjs.com/how_to/Solid_Particle_System#particle-management
  115499. * @param particle The particle to recycle
  115500. * @returns the recycled particle
  115501. */
  115502. recycleParticle(particle: SolidParticle): SolidParticle;
  115503. /**
  115504. * Updates a particle : this function should be overwritten by the user.
  115505. * It is called on each particle by `setParticles()`. This is the place to code each particle behavior.
  115506. * doc : https://doc.babylonjs.com/how_to/Solid_Particle_System#particle-management
  115507. * @example : just set a particle position or velocity and recycle conditions
  115508. * @param particle The particle to update
  115509. * @returns the updated particle
  115510. */
  115511. updateParticle(particle: SolidParticle): SolidParticle;
  115512. /**
  115513. * Updates a vertex of a particle : it can be overwritten by the user.
  115514. * This will be called on each vertex particle by `setParticles()` if `computeParticleVertex` is set to true only.
  115515. * @param particle the current particle
  115516. * @param vertex the current vertex of the current particle : a SolidParticleVertex object
  115517. * @param pt the index of the current vertex in the particle shape
  115518. * doc : https://doc.babylonjs.com/how_to/Solid_Particle_System#update-each-particle-shape
  115519. * @example : just set a vertex particle position or color
  115520. * @returns the sps
  115521. */
  115522. updateParticleVertex(particle: SolidParticle, vertex: SolidParticleVertex, pt: number): SolidParticleSystem;
  115523. /**
  115524. * This will be called before any other treatment by `setParticles()` and will be passed three parameters.
  115525. * This does nothing and may be overwritten by the user.
  115526. * @param start the particle index in the particle array where to stop to iterate, same than the value passed to setParticle()
  115527. * @param stop the particle index in the particle array where to stop to iterate, same than the value passed to setParticle()
  115528. * @param update the boolean update value actually passed to setParticles()
  115529. */
  115530. beforeUpdateParticles(start?: number, stop?: number, update?: boolean): void;
  115531. /**
  115532. * This will be called by `setParticles()` after all the other treatments and just before the actual mesh update.
  115533. * This will be passed three parameters.
  115534. * This does nothing and may be overwritten by the user.
  115535. * @param start the particle index in the particle array where to stop to iterate, same than the value passed to setParticle()
  115536. * @param stop the particle index in the particle array where to stop to iterate, same than the value passed to setParticle()
  115537. * @param update the boolean update value actually passed to setParticles()
  115538. */
  115539. afterUpdateParticles(start?: number, stop?: number, update?: boolean): void;
  115540. }
  115541. }
  115542. declare module BABYLON {
  115543. /**
  115544. * Represents one particle of a solid particle system.
  115545. */
  115546. export class SolidParticle {
  115547. /**
  115548. * particle global index
  115549. */
  115550. idx: number;
  115551. /**
  115552. * particle identifier
  115553. */
  115554. id: number;
  115555. /**
  115556. * The color of the particle
  115557. */
  115558. color: Nullable<Color4>;
  115559. /**
  115560. * The world space position of the particle.
  115561. */
  115562. position: Vector3;
  115563. /**
  115564. * The world space rotation of the particle. (Not use if rotationQuaternion is set)
  115565. */
  115566. rotation: Vector3;
  115567. /**
  115568. * The world space rotation quaternion of the particle.
  115569. */
  115570. rotationQuaternion: Nullable<Quaternion>;
  115571. /**
  115572. * The scaling of the particle.
  115573. */
  115574. scaling: Vector3;
  115575. /**
  115576. * The uvs of the particle.
  115577. */
  115578. uvs: Vector4;
  115579. /**
  115580. * The current speed of the particle.
  115581. */
  115582. velocity: Vector3;
  115583. /**
  115584. * The pivot point in the particle local space.
  115585. */
  115586. pivot: Vector3;
  115587. /**
  115588. * Must the particle be translated from its pivot point in its local space ?
  115589. * In this case, the pivot point is set at the origin of the particle local space and the particle is translated.
  115590. * Default : false
  115591. */
  115592. translateFromPivot: boolean;
  115593. /**
  115594. * Is the particle active or not ?
  115595. */
  115596. alive: boolean;
  115597. /**
  115598. * Is the particle visible or not ?
  115599. */
  115600. isVisible: boolean;
  115601. /**
  115602. * Index of this particle in the global "positions" array (Internal use)
  115603. * @hidden
  115604. */
  115605. _pos: number;
  115606. /**
  115607. * @hidden Index of this particle in the global "indices" array (Internal use)
  115608. */
  115609. _ind: number;
  115610. /**
  115611. * @hidden ModelShape of this particle (Internal use)
  115612. */
  115613. _model: ModelShape;
  115614. /**
  115615. * ModelShape id of this particle
  115616. */
  115617. shapeId: number;
  115618. /**
  115619. * Index of the particle in its shape id
  115620. */
  115621. idxInShape: number;
  115622. /**
  115623. * @hidden Reference to the shape model BoundingInfo object (Internal use)
  115624. */
  115625. _modelBoundingInfo: BoundingInfo;
  115626. /**
  115627. * @hidden Particle BoundingInfo object (Internal use)
  115628. */
  115629. _boundingInfo: BoundingInfo;
  115630. /**
  115631. * @hidden Reference to the SPS what the particle belongs to (Internal use)
  115632. */
  115633. _sps: SolidParticleSystem;
  115634. /**
  115635. * @hidden Still set as invisible in order to skip useless computations (Internal use)
  115636. */
  115637. _stillInvisible: boolean;
  115638. /**
  115639. * @hidden Last computed particle rotation matrix
  115640. */
  115641. _rotationMatrix: number[];
  115642. /**
  115643. * Parent particle Id, if any.
  115644. * Default null.
  115645. */
  115646. parentId: Nullable<number>;
  115647. /**
  115648. * The particle material identifier (integer) when MultiMaterials are enabled in the SPS.
  115649. */
  115650. materialIndex: Nullable<number>;
  115651. /**
  115652. * Custom object or properties.
  115653. */
  115654. props: Nullable<any>;
  115655. /**
  115656. * The culling strategy to use to check whether the solid particle must be culled or not when using isInFrustum().
  115657. * The possible values are :
  115658. * - AbstractMesh.CULLINGSTRATEGY_STANDARD
  115659. * - AbstractMesh.CULLINGSTRATEGY_BOUNDINGSPHERE_ONLY
  115660. * - AbstractMesh.CULLINGSTRATEGY_OPTIMISTIC_INCLUSION
  115661. * - AbstractMesh.CULLINGSTRATEGY_OPTIMISTIC_INCLUSION_THEN_BSPHERE_ONLY
  115662. * The default value for solid particles is AbstractMesh.CULLINGSTRATEGY_BOUNDINGSPHERE_ONLY
  115663. * Please read each static variable documentation in the class AbstractMesh to get details about the culling process.
  115664. * */
  115665. cullingStrategy: number;
  115666. /**
  115667. * @hidden Internal global position in the SPS.
  115668. */
  115669. _globalPosition: Vector3;
  115670. /**
  115671. * Creates a Solid Particle object.
  115672. * Don't create particles manually, use instead the Solid Particle System internal tools like _addParticle()
  115673. * @param particleIndex (integer) is the particle index in the Solid Particle System pool.
  115674. * @param particleId (integer) is the particle identifier. Unless some particles are removed from the SPS, it's the same value than the particle idx.
  115675. * @param positionIndex (integer) is the starting index of the particle vertices in the SPS "positions" array.
  115676. * @param indiceIndex (integer) is the starting index of the particle indices in the SPS "indices" array.
  115677. * @param model (ModelShape) is a reference to the model shape on what the particle is designed.
  115678. * @param shapeId (integer) is the model shape identifier in the SPS.
  115679. * @param idxInShape (integer) is the index of the particle in the current model (ex: the 10th box of addShape(box, 30))
  115680. * @param sps defines the sps it is associated to
  115681. * @param modelBoundingInfo is the reference to the model BoundingInfo used for intersection computations.
  115682. * @param materialIndex is the particle material identifier (integer) when the MultiMaterials are enabled in the SPS.
  115683. */
  115684. constructor(particleIndex: number, particleId: number, positionIndex: number, indiceIndex: number, model: Nullable<ModelShape>, shapeId: number, idxInShape: number, sps: SolidParticleSystem, modelBoundingInfo?: Nullable<BoundingInfo>, materialIndex?: Nullable<number>);
  115685. /**
  115686. * Copies the particle property values into the existing target : position, rotation, scaling, uvs, colors, pivot, parent, visibility, alive
  115687. * @param target the particle target
  115688. * @returns the current particle
  115689. */
  115690. copyToRef(target: SolidParticle): SolidParticle;
  115691. /**
  115692. * Legacy support, changed scale to scaling
  115693. */
  115694. get scale(): Vector3;
  115695. /**
  115696. * Legacy support, changed scale to scaling
  115697. */
  115698. set scale(scale: Vector3);
  115699. /**
  115700. * Legacy support, changed quaternion to rotationQuaternion
  115701. */
  115702. get quaternion(): Nullable<Quaternion>;
  115703. /**
  115704. * Legacy support, changed quaternion to rotationQuaternion
  115705. */
  115706. set quaternion(q: Nullable<Quaternion>);
  115707. /**
  115708. * Returns a boolean. True if the particle intersects another particle or another mesh, else false.
  115709. * The intersection is computed on the particle bounding sphere and Axis Aligned Bounding Box (AABB)
  115710. * @param target is the object (solid particle or mesh) what the intersection is computed against.
  115711. * @returns true if it intersects
  115712. */
  115713. intersectsMesh(target: Mesh | SolidParticle): boolean;
  115714. /**
  115715. * Returns `true` if the solid particle is within the frustum defined by the passed array of planes.
  115716. * A particle is in the frustum if its bounding box intersects the frustum
  115717. * @param frustumPlanes defines the frustum to test
  115718. * @returns true if the particle is in the frustum planes
  115719. */
  115720. isInFrustum(frustumPlanes: Plane[]): boolean;
  115721. /**
  115722. * get the rotation matrix of the particle
  115723. * @hidden
  115724. */
  115725. getRotationMatrix(m: Matrix): void;
  115726. }
  115727. /**
  115728. * Represents the shape of the model used by one particle of a solid particle system.
  115729. * SPS internal tool, don't use it manually.
  115730. */
  115731. export class ModelShape {
  115732. /**
  115733. * The shape id
  115734. * @hidden
  115735. */
  115736. shapeID: number;
  115737. /**
  115738. * flat array of model positions (internal use)
  115739. * @hidden
  115740. */
  115741. _shape: Vector3[];
  115742. /**
  115743. * flat array of model UVs (internal use)
  115744. * @hidden
  115745. */
  115746. _shapeUV: number[];
  115747. /**
  115748. * color array of the model
  115749. * @hidden
  115750. */
  115751. _shapeColors: number[];
  115752. /**
  115753. * indices array of the model
  115754. * @hidden
  115755. */
  115756. _indices: number[];
  115757. /**
  115758. * normals array of the model
  115759. * @hidden
  115760. */
  115761. _normals: number[];
  115762. /**
  115763. * length of the shape in the model indices array (internal use)
  115764. * @hidden
  115765. */
  115766. _indicesLength: number;
  115767. /**
  115768. * Custom position function (internal use)
  115769. * @hidden
  115770. */
  115771. _positionFunction: Nullable<(particle: SolidParticle, i: number, s: number) => void>;
  115772. /**
  115773. * Custom vertex function (internal use)
  115774. * @hidden
  115775. */
  115776. _vertexFunction: Nullable<(particle: SolidParticle, vertex: Vector3, i: number) => void>;
  115777. /**
  115778. * Model material (internal use)
  115779. * @hidden
  115780. */
  115781. _material: Nullable<Material>;
  115782. /**
  115783. * 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.
  115784. * SPS internal tool, don't use it manually.
  115785. * @hidden
  115786. */
  115787. 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>);
  115788. }
  115789. /**
  115790. * Represents a Depth Sorted Particle in the solid particle system.
  115791. * @hidden
  115792. */
  115793. export class DepthSortedParticle {
  115794. /**
  115795. * Particle index
  115796. */
  115797. idx: number;
  115798. /**
  115799. * Index of the particle in the "indices" array
  115800. */
  115801. ind: number;
  115802. /**
  115803. * Length of the particle shape in the "indices" array
  115804. */
  115805. indicesLength: number;
  115806. /**
  115807. * Squared distance from the particle to the camera
  115808. */
  115809. sqDistance: number;
  115810. /**
  115811. * Material index when used with MultiMaterials
  115812. */
  115813. materialIndex: number;
  115814. /**
  115815. * Creates a new sorted particle
  115816. * @param materialIndex
  115817. */
  115818. constructor(idx: number, ind: number, indLength: number, materialIndex: number);
  115819. }
  115820. /**
  115821. * Represents a solid particle vertex
  115822. */
  115823. export class SolidParticleVertex {
  115824. /**
  115825. * Vertex position
  115826. */
  115827. position: Vector3;
  115828. /**
  115829. * Vertex color
  115830. */
  115831. color: Color4;
  115832. /**
  115833. * Vertex UV
  115834. */
  115835. uv: Vector2;
  115836. /**
  115837. * Creates a new solid particle vertex
  115838. */
  115839. constructor();
  115840. /** Vertex x coordinate */
  115841. get x(): number;
  115842. set x(val: number);
  115843. /** Vertex y coordinate */
  115844. get y(): number;
  115845. set y(val: number);
  115846. /** Vertex z coordinate */
  115847. get z(): number;
  115848. set z(val: number);
  115849. }
  115850. }
  115851. declare module BABYLON {
  115852. /**
  115853. * @hidden
  115854. */
  115855. export class _MeshCollisionData {
  115856. _checkCollisions: boolean;
  115857. _collisionMask: number;
  115858. _collisionGroup: number;
  115859. _surroundingMeshes: Nullable<AbstractMesh[]>;
  115860. _collider: Nullable<Collider>;
  115861. _oldPositionForCollisions: Vector3;
  115862. _diffPositionForCollisions: Vector3;
  115863. _onCollideObserver: Nullable<Observer<AbstractMesh>>;
  115864. _onCollisionPositionChangeObserver: Nullable<Observer<Vector3>>;
  115865. _collisionResponse: boolean;
  115866. }
  115867. }
  115868. declare module BABYLON {
  115869. /** @hidden */
  115870. class _FacetDataStorage {
  115871. facetPositions: Vector3[];
  115872. facetNormals: Vector3[];
  115873. facetPartitioning: number[][];
  115874. facetNb: number;
  115875. partitioningSubdivisions: number;
  115876. partitioningBBoxRatio: number;
  115877. facetDataEnabled: boolean;
  115878. facetParameters: any;
  115879. bbSize: Vector3;
  115880. subDiv: {
  115881. max: number;
  115882. X: number;
  115883. Y: number;
  115884. Z: number;
  115885. };
  115886. facetDepthSort: boolean;
  115887. facetDepthSortEnabled: boolean;
  115888. depthSortedIndices: IndicesArray;
  115889. depthSortedFacets: {
  115890. ind: number;
  115891. sqDistance: number;
  115892. }[];
  115893. facetDepthSortFunction: (f1: {
  115894. ind: number;
  115895. sqDistance: number;
  115896. }, f2: {
  115897. ind: number;
  115898. sqDistance: number;
  115899. }) => number;
  115900. facetDepthSortFrom: Vector3;
  115901. facetDepthSortOrigin: Vector3;
  115902. invertedMatrix: Matrix;
  115903. }
  115904. /**
  115905. * @hidden
  115906. **/
  115907. class _InternalAbstractMeshDataInfo {
  115908. _hasVertexAlpha: boolean;
  115909. _useVertexColors: boolean;
  115910. _numBoneInfluencers: number;
  115911. _applyFog: boolean;
  115912. _receiveShadows: boolean;
  115913. _facetData: _FacetDataStorage;
  115914. _visibility: number;
  115915. _skeleton: Nullable<Skeleton>;
  115916. _layerMask: number;
  115917. _computeBonesUsingShaders: boolean;
  115918. _isActive: boolean;
  115919. _onlyForInstances: boolean;
  115920. _isActiveIntermediate: boolean;
  115921. _onlyForInstancesIntermediate: boolean;
  115922. _actAsRegularMesh: boolean;
  115923. _currentLOD: Nullable<AbstractMesh>;
  115924. }
  115925. /**
  115926. * Class used to store all common mesh properties
  115927. */
  115928. export class AbstractMesh extends TransformNode implements IDisposable, ICullable, IGetSetVerticesData {
  115929. /** No occlusion */
  115930. static OCCLUSION_TYPE_NONE: number;
  115931. /** Occlusion set to optimisitic */
  115932. static OCCLUSION_TYPE_OPTIMISTIC: number;
  115933. /** Occlusion set to strict */
  115934. static OCCLUSION_TYPE_STRICT: number;
  115935. /** Use an accurante occlusion algorithm */
  115936. static OCCLUSION_ALGORITHM_TYPE_ACCURATE: number;
  115937. /** Use a conservative occlusion algorithm */
  115938. static OCCLUSION_ALGORITHM_TYPE_CONSERVATIVE: number;
  115939. /** Default culling strategy : this is an exclusion test and it's the more accurate.
  115940. * Test order :
  115941. * Is the bounding sphere outside the frustum ?
  115942. * If not, are the bounding box vertices outside the frustum ?
  115943. * It not, then the cullable object is in the frustum.
  115944. */
  115945. static readonly CULLINGSTRATEGY_STANDARD: number;
  115946. /** Culling strategy : Bounding Sphere Only.
  115947. * This is an exclusion test. It's faster than the standard strategy because the bounding box is not tested.
  115948. * It's also less accurate than the standard because some not visible objects can still be selected.
  115949. * Test : is the bounding sphere outside the frustum ?
  115950. * If not, then the cullable object is in the frustum.
  115951. */
  115952. static readonly CULLINGSTRATEGY_BOUNDINGSPHERE_ONLY: number;
  115953. /** Culling strategy : Optimistic Inclusion.
  115954. * This in an inclusion test first, then the standard exclusion test.
  115955. * This can be faster when a cullable object is expected to be almost always in the camera frustum.
  115956. * 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.
  115957. * Anyway, it's as accurate as the standard strategy.
  115958. * Test :
  115959. * Is the cullable object bounding sphere center in the frustum ?
  115960. * If not, apply the default culling strategy.
  115961. */
  115962. static readonly CULLINGSTRATEGY_OPTIMISTIC_INCLUSION: number;
  115963. /** Culling strategy : Optimistic Inclusion then Bounding Sphere Only.
  115964. * This in an inclusion test first, then the bounding sphere only exclusion test.
  115965. * This can be the fastest test when a cullable object is expected to be almost always in the camera frustum.
  115966. * 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.
  115967. * It's less accurate than the standard strategy and as accurate as the BoundingSphereOnly strategy.
  115968. * Test :
  115969. * Is the cullable object bounding sphere center in the frustum ?
  115970. * If not, apply the Bounding Sphere Only strategy. No Bounding Box is tested here.
  115971. */
  115972. static readonly CULLINGSTRATEGY_OPTIMISTIC_INCLUSION_THEN_BSPHERE_ONLY: number;
  115973. /**
  115974. * No billboard
  115975. */
  115976. static get BILLBOARDMODE_NONE(): number;
  115977. /** Billboard on X axis */
  115978. static get BILLBOARDMODE_X(): number;
  115979. /** Billboard on Y axis */
  115980. static get BILLBOARDMODE_Y(): number;
  115981. /** Billboard on Z axis */
  115982. static get BILLBOARDMODE_Z(): number;
  115983. /** Billboard on all axes */
  115984. static get BILLBOARDMODE_ALL(): number;
  115985. /** Billboard on using position instead of orientation */
  115986. static get BILLBOARDMODE_USE_POSITION(): number;
  115987. /** @hidden */
  115988. _internalAbstractMeshDataInfo: _InternalAbstractMeshDataInfo;
  115989. /**
  115990. * The culling strategy to use to check whether the mesh must be rendered or not.
  115991. * This value can be changed at any time and will be used on the next render mesh selection.
  115992. * The possible values are :
  115993. * - AbstractMesh.CULLINGSTRATEGY_STANDARD
  115994. * - AbstractMesh.CULLINGSTRATEGY_BOUNDINGSPHERE_ONLY
  115995. * - AbstractMesh.CULLINGSTRATEGY_OPTIMISTIC_INCLUSION
  115996. * - AbstractMesh.CULLINGSTRATEGY_OPTIMISTIC_INCLUSION_THEN_BSPHERE_ONLY
  115997. * Please read each static variable documentation to get details about the culling process.
  115998. * */
  115999. cullingStrategy: number;
  116000. /**
  116001. * Gets the number of facets in the mesh
  116002. * @see https://doc.babylonjs.com/how_to/how_to_use_facetdata#what-is-a-mesh-facet
  116003. */
  116004. get facetNb(): number;
  116005. /**
  116006. * Gets or set the number (integer) of subdivisions per axis in the partioning space
  116007. * @see https://doc.babylonjs.com/how_to/how_to_use_facetdata#tweaking-the-partitioning
  116008. */
  116009. get partitioningSubdivisions(): number;
  116010. set partitioningSubdivisions(nb: number);
  116011. /**
  116012. * The ratio (float) to apply to the bouding box size to set to the partioning space.
  116013. * Ex : 1.01 (default) the partioning space is 1% bigger than the bounding box
  116014. * @see https://doc.babylonjs.com/how_to/how_to_use_facetdata#tweaking-the-partitioning
  116015. */
  116016. get partitioningBBoxRatio(): number;
  116017. set partitioningBBoxRatio(ratio: number);
  116018. /**
  116019. * Gets or sets a boolean indicating that the facets must be depth sorted on next call to `updateFacetData()`.
  116020. * Works only for updatable meshes.
  116021. * Doesn't work with multi-materials
  116022. * @see https://doc.babylonjs.com/how_to/how_to_use_facetdata#facet-depth-sort
  116023. */
  116024. get mustDepthSortFacets(): boolean;
  116025. set mustDepthSortFacets(sort: boolean);
  116026. /**
  116027. * The location (Vector3) where the facet depth sort must be computed from.
  116028. * By default, the active camera position.
  116029. * Used only when facet depth sort is enabled
  116030. * @see https://doc.babylonjs.com/how_to/how_to_use_facetdata#facet-depth-sort
  116031. */
  116032. get facetDepthSortFrom(): Vector3;
  116033. set facetDepthSortFrom(location: Vector3);
  116034. /**
  116035. * gets a boolean indicating if facetData is enabled
  116036. * @see https://doc.babylonjs.com/how_to/how_to_use_facetdata#what-is-a-mesh-facet
  116037. */
  116038. get isFacetDataEnabled(): boolean;
  116039. /** @hidden */
  116040. _updateNonUniformScalingState(value: boolean): boolean;
  116041. /**
  116042. * An event triggered when this mesh collides with another one
  116043. */
  116044. onCollideObservable: Observable<AbstractMesh>;
  116045. /** Set a function to call when this mesh collides with another one */
  116046. set onCollide(callback: () => void);
  116047. /**
  116048. * An event triggered when the collision's position changes
  116049. */
  116050. onCollisionPositionChangeObservable: Observable<Vector3>;
  116051. /** Set a function to call when the collision's position changes */
  116052. set onCollisionPositionChange(callback: () => void);
  116053. /**
  116054. * An event triggered when material is changed
  116055. */
  116056. onMaterialChangedObservable: Observable<AbstractMesh>;
  116057. /**
  116058. * Gets or sets the orientation for POV movement & rotation
  116059. */
  116060. definedFacingForward: boolean;
  116061. /** @hidden */
  116062. _occlusionQuery: Nullable<WebGLQuery>;
  116063. /** @hidden */
  116064. _renderingGroup: Nullable<RenderingGroup>;
  116065. /**
  116066. * Gets or sets mesh visibility between 0 and 1 (default is 1)
  116067. */
  116068. get visibility(): number;
  116069. /**
  116070. * Gets or sets mesh visibility between 0 and 1 (default is 1)
  116071. */
  116072. set visibility(value: number);
  116073. /** Gets or sets the alpha index used to sort transparent meshes
  116074. * @see https://doc.babylonjs.com/resources/transparency_and_how_meshes_are_rendered#alpha-index
  116075. */
  116076. alphaIndex: number;
  116077. /**
  116078. * Gets or sets a boolean indicating if the mesh is visible (renderable). Default is true
  116079. */
  116080. isVisible: boolean;
  116081. /**
  116082. * Gets or sets a boolean indicating if the mesh can be picked (by scene.pick for instance or through actions). Default is true
  116083. */
  116084. isPickable: boolean;
  116085. /** Gets or sets a boolean indicating that bounding boxes of subMeshes must be rendered as well (false by default) */
  116086. showSubMeshesBoundingBox: boolean;
  116087. /** Gets or sets a boolean indicating if the mesh must be considered as a ray blocker for lens flares (false by default)
  116088. * @see https://doc.babylonjs.com/how_to/how_to_use_lens_flares
  116089. */
  116090. isBlocker: boolean;
  116091. /**
  116092. * Gets or sets a boolean indicating that pointer move events must be supported on this mesh (false by default)
  116093. */
  116094. enablePointerMoveEvents: boolean;
  116095. private _renderingGroupId;
  116096. /**
  116097. * Specifies the rendering group id for this mesh (0 by default)
  116098. * @see https://doc.babylonjs.com/resources/transparency_and_how_meshes_are_rendered#rendering-groups
  116099. */
  116100. get renderingGroupId(): number;
  116101. set renderingGroupId(value: number);
  116102. private _material;
  116103. /** Gets or sets current material */
  116104. get material(): Nullable<Material>;
  116105. set material(value: Nullable<Material>);
  116106. /**
  116107. * Gets or sets a boolean indicating that this mesh can receive realtime shadows
  116108. * @see https://doc.babylonjs.com/babylon101/shadows
  116109. */
  116110. get receiveShadows(): boolean;
  116111. set receiveShadows(value: boolean);
  116112. /** Defines color to use when rendering outline */
  116113. outlineColor: Color3;
  116114. /** Define width to use when rendering outline */
  116115. outlineWidth: number;
  116116. /** Defines color to use when rendering overlay */
  116117. overlayColor: Color3;
  116118. /** Defines alpha to use when rendering overlay */
  116119. overlayAlpha: number;
  116120. /** Gets or sets a boolean indicating that this mesh contains vertex color data with alpha values */
  116121. get hasVertexAlpha(): boolean;
  116122. set hasVertexAlpha(value: boolean);
  116123. /** 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) */
  116124. get useVertexColors(): boolean;
  116125. set useVertexColors(value: boolean);
  116126. /**
  116127. * Gets or sets a boolean indicating that bone animations must be computed by the CPU (false by default)
  116128. */
  116129. get computeBonesUsingShaders(): boolean;
  116130. set computeBonesUsingShaders(value: boolean);
  116131. /** Gets or sets the number of allowed bone influences per vertex (4 by default) */
  116132. get numBoneInfluencers(): number;
  116133. set numBoneInfluencers(value: number);
  116134. /** Gets or sets a boolean indicating that this mesh will allow fog to be rendered on it (true by default) */
  116135. get applyFog(): boolean;
  116136. set applyFog(value: boolean);
  116137. /** Gets or sets a boolean indicating that internal octree (if available) can be used to boost submeshes selection (true by default) */
  116138. useOctreeForRenderingSelection: boolean;
  116139. /** Gets or sets a boolean indicating that internal octree (if available) can be used to boost submeshes picking (true by default) */
  116140. useOctreeForPicking: boolean;
  116141. /** Gets or sets a boolean indicating that internal octree (if available) can be used to boost submeshes collision (true by default) */
  116142. useOctreeForCollisions: boolean;
  116143. /**
  116144. * Gets or sets the current layer mask (default is 0x0FFFFFFF)
  116145. * @see https://doc.babylonjs.com/how_to/layermasks_and_multi-cam_textures
  116146. */
  116147. get layerMask(): number;
  116148. set layerMask(value: number);
  116149. /**
  116150. * True if the mesh must be rendered in any case (this will shortcut the frustum clipping phase)
  116151. */
  116152. alwaysSelectAsActiveMesh: boolean;
  116153. /**
  116154. * Gets or sets a boolean indicating that the bounding info does not need to be kept in sync (for performance reason)
  116155. */
  116156. doNotSyncBoundingInfo: boolean;
  116157. /**
  116158. * Gets or sets the current action manager
  116159. * @see https://doc.babylonjs.com/how_to/how_to_use_actions
  116160. */
  116161. actionManager: Nullable<AbstractActionManager>;
  116162. private _meshCollisionData;
  116163. /**
  116164. * Gets or sets the ellipsoid used to impersonate this mesh when using collision engine (default is (0.5, 1, 0.5))
  116165. * @see https://doc.babylonjs.com/babylon101/cameras,_mesh_collisions_and_gravity
  116166. */
  116167. ellipsoid: Vector3;
  116168. /**
  116169. * Gets or sets the ellipsoid offset used to impersonate this mesh when using collision engine (default is (0, 0, 0))
  116170. * @see https://doc.babylonjs.com/babylon101/cameras,_mesh_collisions_and_gravity
  116171. */
  116172. ellipsoidOffset: Vector3;
  116173. /**
  116174. * Gets or sets a collision mask used to mask collisions (default is -1).
  116175. * A collision between A and B will happen if A.collisionGroup & b.collisionMask !== 0
  116176. */
  116177. get collisionMask(): number;
  116178. set collisionMask(mask: number);
  116179. /**
  116180. * Gets or sets a collision response flag (default is true).
  116181. * when collisionResponse is false, events are still triggered but colliding entity has no response
  116182. * This helps creating trigger volume when user wants collision feedback events but not position/velocity
  116183. * to respond to the collision.
  116184. */
  116185. get collisionResponse(): boolean;
  116186. set collisionResponse(response: boolean);
  116187. /**
  116188. * Gets or sets the current collision group mask (-1 by default).
  116189. * A collision between A and B will happen if A.collisionGroup & b.collisionMask !== 0
  116190. */
  116191. get collisionGroup(): number;
  116192. set collisionGroup(mask: number);
  116193. /**
  116194. * Gets or sets current surrounding meshes (null by default).
  116195. *
  116196. * By default collision detection is tested against every mesh in the scene.
  116197. * It is possible to set surroundingMeshes to a defined list of meshes and then only these specified
  116198. * meshes will be tested for the collision.
  116199. *
  116200. * Note: if set to an empty array no collision will happen when this mesh is moved.
  116201. */
  116202. get surroundingMeshes(): Nullable<AbstractMesh[]>;
  116203. set surroundingMeshes(meshes: Nullable<AbstractMesh[]>);
  116204. /**
  116205. * Defines edge width used when edgesRenderer is enabled
  116206. * @see https://www.babylonjs-playground.com/#10OJSG#13
  116207. */
  116208. edgesWidth: number;
  116209. /**
  116210. * Defines edge color used when edgesRenderer is enabled
  116211. * @see https://www.babylonjs-playground.com/#10OJSG#13
  116212. */
  116213. edgesColor: Color4;
  116214. /** @hidden */
  116215. _edgesRenderer: Nullable<IEdgesRenderer>;
  116216. /** @hidden */
  116217. _masterMesh: Nullable<AbstractMesh>;
  116218. /** @hidden */
  116219. _boundingInfo: Nullable<BoundingInfo>;
  116220. /** @hidden */
  116221. _renderId: number;
  116222. /**
  116223. * Gets or sets the list of subMeshes
  116224. * @see https://doc.babylonjs.com/how_to/multi_materials
  116225. */
  116226. subMeshes: SubMesh[];
  116227. /** @hidden */
  116228. _intersectionsInProgress: AbstractMesh[];
  116229. /** @hidden */
  116230. _unIndexed: boolean;
  116231. /** @hidden */
  116232. _lightSources: Light[];
  116233. /** Gets the list of lights affecting that mesh */
  116234. get lightSources(): Light[];
  116235. /** @hidden */
  116236. get _positions(): Nullable<Vector3[]>;
  116237. /** @hidden */
  116238. _waitingData: {
  116239. lods: Nullable<any>;
  116240. actions: Nullable<any>;
  116241. freezeWorldMatrix: Nullable<boolean>;
  116242. };
  116243. /** @hidden */
  116244. _bonesTransformMatrices: Nullable<Float32Array>;
  116245. /** @hidden */
  116246. _transformMatrixTexture: Nullable<RawTexture>;
  116247. /**
  116248. * Gets or sets a skeleton to apply skining transformations
  116249. * @see https://doc.babylonjs.com/how_to/how_to_use_bones_and_skeletons
  116250. */
  116251. set skeleton(value: Nullable<Skeleton>);
  116252. get skeleton(): Nullable<Skeleton>;
  116253. /**
  116254. * An event triggered when the mesh is rebuilt.
  116255. */
  116256. onRebuildObservable: Observable<AbstractMesh>;
  116257. /**
  116258. * Creates a new AbstractMesh
  116259. * @param name defines the name of the mesh
  116260. * @param scene defines the hosting scene
  116261. */
  116262. constructor(name: string, scene?: Nullable<Scene>);
  116263. /**
  116264. * Returns the string "AbstractMesh"
  116265. * @returns "AbstractMesh"
  116266. */
  116267. getClassName(): string;
  116268. /**
  116269. * Gets a string representation of the current mesh
  116270. * @param fullDetails defines a boolean indicating if full details must be included
  116271. * @returns a string representation of the current mesh
  116272. */
  116273. toString(fullDetails?: boolean): string;
  116274. /**
  116275. * @hidden
  116276. */
  116277. protected _getEffectiveParent(): Nullable<Node>;
  116278. /** @hidden */
  116279. _getActionManagerForTrigger(trigger?: number, initialCall?: boolean): Nullable<AbstractActionManager>;
  116280. /** @hidden */
  116281. _rebuild(): void;
  116282. /** @hidden */
  116283. _resyncLightSources(): void;
  116284. /** @hidden */
  116285. _resyncLightSource(light: Light): void;
  116286. /** @hidden */
  116287. _unBindEffect(): void;
  116288. /** @hidden */
  116289. _removeLightSource(light: Light, dispose: boolean): void;
  116290. private _markSubMeshesAsDirty;
  116291. /** @hidden */
  116292. _markSubMeshesAsLightDirty(dispose?: boolean): void;
  116293. /** @hidden */
  116294. _markSubMeshesAsAttributesDirty(): void;
  116295. /** @hidden */
  116296. _markSubMeshesAsMiscDirty(): void;
  116297. /**
  116298. * Gets or sets a Vector3 depicting the mesh scaling along each local axis X, Y, Z. Default is (1.0, 1.0, 1.0)
  116299. */
  116300. get scaling(): Vector3;
  116301. set scaling(newScaling: Vector3);
  116302. /**
  116303. * Returns true if the mesh is blocked. Implemented by child classes
  116304. */
  116305. get isBlocked(): boolean;
  116306. /**
  116307. * Returns the mesh itself by default. Implemented by child classes
  116308. * @param camera defines the camera to use to pick the right LOD level
  116309. * @returns the currentAbstractMesh
  116310. */
  116311. getLOD(camera: Camera): Nullable<AbstractMesh>;
  116312. /**
  116313. * Returns 0 by default. Implemented by child classes
  116314. * @returns an integer
  116315. */
  116316. getTotalVertices(): number;
  116317. /**
  116318. * Returns a positive integer : the total number of indices in this mesh geometry.
  116319. * @returns the numner of indices or zero if the mesh has no geometry.
  116320. */
  116321. getTotalIndices(): number;
  116322. /**
  116323. * Returns null by default. Implemented by child classes
  116324. * @returns null
  116325. */
  116326. getIndices(): Nullable<IndicesArray>;
  116327. /**
  116328. * Returns the array of the requested vertex data kind. Implemented by child classes
  116329. * @param kind defines the vertex data kind to use
  116330. * @returns null
  116331. */
  116332. getVerticesData(kind: string): Nullable<FloatArray>;
  116333. /**
  116334. * Sets the vertex data of the mesh geometry for the requested `kind`.
  116335. * If the mesh has no geometry, a new Geometry object is set to the mesh and then passed this vertex data.
  116336. * Note that a new underlying VertexBuffer object is created each call.
  116337. * If the `kind` is the `PositionKind`, the mesh BoundingInfo is renewed, so the bounding box and sphere, and the mesh World Matrix is recomputed.
  116338. * @param kind defines vertex data kind:
  116339. * * VertexBuffer.PositionKind
  116340. * * VertexBuffer.UVKind
  116341. * * VertexBuffer.UV2Kind
  116342. * * VertexBuffer.UV3Kind
  116343. * * VertexBuffer.UV4Kind
  116344. * * VertexBuffer.UV5Kind
  116345. * * VertexBuffer.UV6Kind
  116346. * * VertexBuffer.ColorKind
  116347. * * VertexBuffer.MatricesIndicesKind
  116348. * * VertexBuffer.MatricesIndicesExtraKind
  116349. * * VertexBuffer.MatricesWeightsKind
  116350. * * VertexBuffer.MatricesWeightsExtraKind
  116351. * @param data defines the data source
  116352. * @param updatable defines if the data must be flagged as updatable (or static)
  116353. * @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
  116354. * @returns the current mesh
  116355. */
  116356. setVerticesData(kind: string, data: FloatArray, updatable?: boolean, stride?: number): AbstractMesh;
  116357. /**
  116358. * Updates the existing vertex data of the mesh geometry for the requested `kind`.
  116359. * If the mesh has no geometry, it is simply returned as it is.
  116360. * @param kind defines vertex data kind:
  116361. * * VertexBuffer.PositionKind
  116362. * * VertexBuffer.UVKind
  116363. * * VertexBuffer.UV2Kind
  116364. * * VertexBuffer.UV3Kind
  116365. * * VertexBuffer.UV4Kind
  116366. * * VertexBuffer.UV5Kind
  116367. * * VertexBuffer.UV6Kind
  116368. * * VertexBuffer.ColorKind
  116369. * * VertexBuffer.MatricesIndicesKind
  116370. * * VertexBuffer.MatricesIndicesExtraKind
  116371. * * VertexBuffer.MatricesWeightsKind
  116372. * * VertexBuffer.MatricesWeightsExtraKind
  116373. * @param data defines the data source
  116374. * @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
  116375. * @param makeItUnique If true, a new global geometry is created from this data and is set to the mesh
  116376. * @returns the current mesh
  116377. */
  116378. updateVerticesData(kind: string, data: FloatArray, updateExtends?: boolean, makeItUnique?: boolean): AbstractMesh;
  116379. /**
  116380. * Sets the mesh indices,
  116381. * If the mesh has no geometry, a new Geometry object is created and set to the mesh.
  116382. * @param indices Expects an array populated with integers or a typed array (Int32Array, Uint32Array, Uint16Array)
  116383. * @param totalVertices Defines the total number of vertices
  116384. * @returns the current mesh
  116385. */
  116386. setIndices(indices: IndicesArray, totalVertices: Nullable<number>): AbstractMesh;
  116387. /**
  116388. * Gets a boolean indicating if specific vertex data is present
  116389. * @param kind defines the vertex data kind to use
  116390. * @returns true is data kind is present
  116391. */
  116392. isVerticesDataPresent(kind: string): boolean;
  116393. /**
  116394. * Returns the mesh BoundingInfo object or creates a new one and returns if it was undefined.
  116395. * Note that it returns a shallow bounding of the mesh (i.e. it does not include children).
  116396. * To get the full bounding of all children, call `getHierarchyBoundingVectors` instead.
  116397. * @returns a BoundingInfo
  116398. */
  116399. getBoundingInfo(): BoundingInfo;
  116400. /**
  116401. * Uniformly scales the mesh to fit inside of a unit cube (1 X 1 X 1 units)
  116402. * @param includeDescendants Use the hierarchy's bounding box instead of the mesh's bounding box. Default is false
  116403. * @param ignoreRotation ignore rotation when computing the scale (ie. object will be axis aligned). Default is false
  116404. * @param predicate predicate that is passed in to getHierarchyBoundingVectors when selecting which object should be included when scaling
  116405. * @returns the current mesh
  116406. */
  116407. normalizeToUnitCube(includeDescendants?: boolean, ignoreRotation?: boolean, predicate?: Nullable<(node: AbstractMesh) => boolean>): AbstractMesh;
  116408. /**
  116409. * Overwrite the current bounding info
  116410. * @param boundingInfo defines the new bounding info
  116411. * @returns the current mesh
  116412. */
  116413. setBoundingInfo(boundingInfo: BoundingInfo): AbstractMesh;
  116414. /** Gets a boolean indicating if this mesh has skinning data and an attached skeleton */
  116415. get useBones(): boolean;
  116416. /** @hidden */
  116417. _preActivate(): void;
  116418. /** @hidden */
  116419. _preActivateForIntermediateRendering(renderId: number): void;
  116420. /** @hidden */
  116421. _activate(renderId: number, intermediateRendering: boolean): boolean;
  116422. /** @hidden */
  116423. _postActivate(): void;
  116424. /** @hidden */
  116425. _freeze(): void;
  116426. /** @hidden */
  116427. _unFreeze(): void;
  116428. /**
  116429. * Gets the current world matrix
  116430. * @returns a Matrix
  116431. */
  116432. getWorldMatrix(): Matrix;
  116433. /** @hidden */
  116434. _getWorldMatrixDeterminant(): number;
  116435. /**
  116436. * Gets a boolean indicating if this mesh is an instance or a regular mesh
  116437. */
  116438. get isAnInstance(): boolean;
  116439. /**
  116440. * Gets a boolean indicating if this mesh has instances
  116441. */
  116442. get hasInstances(): boolean;
  116443. /**
  116444. * Gets a boolean indicating if this mesh has thin instances
  116445. */
  116446. get hasThinInstances(): boolean;
  116447. /**
  116448. * Perform relative position change from the point of view of behind the front of the mesh.
  116449. * This is performed taking into account the meshes current rotation, so you do not have to care.
  116450. * Supports definition of mesh facing forward or backward
  116451. * @param amountRight defines the distance on the right axis
  116452. * @param amountUp defines the distance on the up axis
  116453. * @param amountForward defines the distance on the forward axis
  116454. * @returns the current mesh
  116455. */
  116456. movePOV(amountRight: number, amountUp: number, amountForward: number): AbstractMesh;
  116457. /**
  116458. * Calculate relative position change from the point of view of behind the front of the mesh.
  116459. * This is performed taking into account the meshes current rotation, so you do not have to care.
  116460. * Supports definition of mesh facing forward or backward
  116461. * @param amountRight defines the distance on the right axis
  116462. * @param amountUp defines the distance on the up axis
  116463. * @param amountForward defines the distance on the forward axis
  116464. * @returns the new displacement vector
  116465. */
  116466. calcMovePOV(amountRight: number, amountUp: number, amountForward: number): Vector3;
  116467. /**
  116468. * Perform relative rotation change from the point of view of behind the front of the mesh.
  116469. * Supports definition of mesh facing forward or backward
  116470. * @param flipBack defines the flip
  116471. * @param twirlClockwise defines the twirl
  116472. * @param tiltRight defines the tilt
  116473. * @returns the current mesh
  116474. */
  116475. rotatePOV(flipBack: number, twirlClockwise: number, tiltRight: number): AbstractMesh;
  116476. /**
  116477. * Calculate relative rotation change from the point of view of behind the front of the mesh.
  116478. * Supports definition of mesh facing forward or backward.
  116479. * @param flipBack defines the flip
  116480. * @param twirlClockwise defines the twirl
  116481. * @param tiltRight defines the tilt
  116482. * @returns the new rotation vector
  116483. */
  116484. calcRotatePOV(flipBack: number, twirlClockwise: number, tiltRight: number): Vector3;
  116485. /**
  116486. * This method recomputes and sets a new BoundingInfo to the mesh unless it is locked.
  116487. * This means the mesh underlying bounding box and sphere are recomputed.
  116488. * @param applySkeleton defines whether to apply the skeleton before computing the bounding info
  116489. * @returns the current mesh
  116490. */
  116491. refreshBoundingInfo(applySkeleton?: boolean): AbstractMesh;
  116492. /** @hidden */
  116493. _refreshBoundingInfo(data: Nullable<FloatArray>, bias: Nullable<Vector2>): void;
  116494. /** @hidden */
  116495. _getPositionData(applySkeleton: boolean): Nullable<FloatArray>;
  116496. /** @hidden */
  116497. _updateBoundingInfo(): AbstractMesh;
  116498. /** @hidden */
  116499. _updateSubMeshesBoundingInfo(matrix: DeepImmutable<Matrix>): AbstractMesh;
  116500. /** @hidden */
  116501. protected _afterComputeWorldMatrix(): void;
  116502. /** @hidden */
  116503. get _effectiveMesh(): AbstractMesh;
  116504. /**
  116505. * Returns `true` if the mesh is within the frustum defined by the passed array of planes.
  116506. * A mesh is in the frustum if its bounding box intersects the frustum
  116507. * @param frustumPlanes defines the frustum to test
  116508. * @returns true if the mesh is in the frustum planes
  116509. */
  116510. isInFrustum(frustumPlanes: Plane[]): boolean;
  116511. /**
  116512. * Returns `true` if the mesh is completely in the frustum defined be the passed array of planes.
  116513. * A mesh is completely in the frustum if its bounding box it completely inside the frustum.
  116514. * @param frustumPlanes defines the frustum to test
  116515. * @returns true if the mesh is completely in the frustum planes
  116516. */
  116517. isCompletelyInFrustum(frustumPlanes: Plane[]): boolean;
  116518. /**
  116519. * True if the mesh intersects another mesh or a SolidParticle object
  116520. * @param mesh defines a target mesh or SolidParticle to test
  116521. * @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)
  116522. * @param includeDescendants Can be set to true to test if the mesh defined in parameters intersects with the current mesh or any child meshes
  116523. * @returns true if there is an intersection
  116524. */
  116525. intersectsMesh(mesh: AbstractMesh | SolidParticle, precise?: boolean, includeDescendants?: boolean): boolean;
  116526. /**
  116527. * Returns true if the passed point (Vector3) is inside the mesh bounding box
  116528. * @param point defines the point to test
  116529. * @returns true if there is an intersection
  116530. */
  116531. intersectsPoint(point: Vector3): boolean;
  116532. /**
  116533. * Gets or sets a boolean indicating that this mesh can be used in the collision engine
  116534. * @see https://doc.babylonjs.com/babylon101/cameras,_mesh_collisions_and_gravity
  116535. */
  116536. get checkCollisions(): boolean;
  116537. set checkCollisions(collisionEnabled: boolean);
  116538. /**
  116539. * Gets Collider object used to compute collisions (not physics)
  116540. * @see https://doc.babylonjs.com/babylon101/cameras,_mesh_collisions_and_gravity
  116541. */
  116542. get collider(): Nullable<Collider>;
  116543. /**
  116544. * Move the mesh using collision engine
  116545. * @see https://doc.babylonjs.com/babylon101/cameras,_mesh_collisions_and_gravity
  116546. * @param displacement defines the requested displacement vector
  116547. * @returns the current mesh
  116548. */
  116549. moveWithCollisions(displacement: Vector3): AbstractMesh;
  116550. private _onCollisionPositionChange;
  116551. /** @hidden */
  116552. _collideForSubMesh(subMesh: SubMesh, transformMatrix: Matrix, collider: Collider): AbstractMesh;
  116553. /** @hidden */
  116554. _processCollisionsForSubMeshes(collider: Collider, transformMatrix: Matrix): AbstractMesh;
  116555. /** @hidden */
  116556. _checkCollision(collider: Collider): AbstractMesh;
  116557. /** @hidden */
  116558. _generatePointsArray(): boolean;
  116559. /**
  116560. * Checks if the passed Ray intersects with the mesh
  116561. * @param ray defines the ray to use
  116562. * @param fastCheck defines if fast mode (but less precise) must be used (false by default)
  116563. * @param trianglePredicate defines an optional predicate used to select faces when a mesh intersection is detected
  116564. * @param onlyBoundingInfo defines a boolean indicating if picking should only happen using bounding info (false by default)
  116565. * @param worldToUse defines the world matrix to use to get the world coordinate of the intersection point
  116566. * @returns the picking info
  116567. * @see https://doc.babylonjs.com/babylon101/intersect_collisions_-_mesh
  116568. */
  116569. intersects(ray: Ray, fastCheck?: boolean, trianglePredicate?: TrianglePickingPredicate, onlyBoundingInfo?: boolean, worldToUse?: Matrix): PickingInfo;
  116570. /**
  116571. * Clones the current mesh
  116572. * @param name defines the mesh name
  116573. * @param newParent defines the new mesh parent
  116574. * @param doNotCloneChildren defines a boolean indicating that children must not be cloned (false by default)
  116575. * @returns the new mesh
  116576. */
  116577. clone(name: string, newParent: Nullable<Node>, doNotCloneChildren?: boolean): Nullable<AbstractMesh>;
  116578. /**
  116579. * Disposes all the submeshes of the current meshnp
  116580. * @returns the current mesh
  116581. */
  116582. releaseSubMeshes(): AbstractMesh;
  116583. /**
  116584. * Releases resources associated with this abstract mesh.
  116585. * @param doNotRecurse Set to true to not recurse into each children (recurse into each children by default)
  116586. * @param disposeMaterialAndTextures Set to true to also dispose referenced materials and textures (false by default)
  116587. */
  116588. dispose(doNotRecurse?: boolean, disposeMaterialAndTextures?: boolean): void;
  116589. /**
  116590. * Adds the passed mesh as a child to the current mesh
  116591. * @param mesh defines the child mesh
  116592. * @returns the current mesh
  116593. */
  116594. addChild(mesh: AbstractMesh): AbstractMesh;
  116595. /**
  116596. * Removes the passed mesh from the current mesh children list
  116597. * @param mesh defines the child mesh
  116598. * @returns the current mesh
  116599. */
  116600. removeChild(mesh: AbstractMesh): AbstractMesh;
  116601. /** @hidden */
  116602. private _initFacetData;
  116603. /**
  116604. * Updates the mesh facetData arrays and the internal partitioning when the mesh is morphed or updated.
  116605. * This method can be called within the render loop.
  116606. * 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
  116607. * @returns the current mesh
  116608. * @see https://doc.babylonjs.com/how_to/how_to_use_facetdata
  116609. */
  116610. updateFacetData(): AbstractMesh;
  116611. /**
  116612. * Returns the facetLocalNormals array.
  116613. * The normals are expressed in the mesh local spac
  116614. * @returns an array of Vector3
  116615. * @see https://doc.babylonjs.com/how_to/how_to_use_facetdata
  116616. */
  116617. getFacetLocalNormals(): Vector3[];
  116618. /**
  116619. * Returns the facetLocalPositions array.
  116620. * The facet positions are expressed in the mesh local space
  116621. * @returns an array of Vector3
  116622. * @see https://doc.babylonjs.com/how_to/how_to_use_facetdata
  116623. */
  116624. getFacetLocalPositions(): Vector3[];
  116625. /**
  116626. * Returns the facetLocalPartioning array
  116627. * @returns an array of array of numbers
  116628. * @see https://doc.babylonjs.com/how_to/how_to_use_facetdata
  116629. */
  116630. getFacetLocalPartitioning(): number[][];
  116631. /**
  116632. * Returns the i-th facet position in the world system.
  116633. * This method allocates a new Vector3 per call
  116634. * @param i defines the facet index
  116635. * @returns a new Vector3
  116636. * @see https://doc.babylonjs.com/how_to/how_to_use_facetdata
  116637. */
  116638. getFacetPosition(i: number): Vector3;
  116639. /**
  116640. * Sets the reference Vector3 with the i-th facet position in the world system
  116641. * @param i defines the facet index
  116642. * @param ref defines the target vector
  116643. * @returns the current mesh
  116644. * @see https://doc.babylonjs.com/how_to/how_to_use_facetdata
  116645. */
  116646. getFacetPositionToRef(i: number, ref: Vector3): AbstractMesh;
  116647. /**
  116648. * Returns the i-th facet normal in the world system.
  116649. * This method allocates a new Vector3 per call
  116650. * @param i defines the facet index
  116651. * @returns a new Vector3
  116652. * @see https://doc.babylonjs.com/how_to/how_to_use_facetdata
  116653. */
  116654. getFacetNormal(i: number): Vector3;
  116655. /**
  116656. * Sets the reference Vector3 with the i-th facet normal in the world system
  116657. * @param i defines the facet index
  116658. * @param ref defines the target vector
  116659. * @returns the current mesh
  116660. * @see https://doc.babylonjs.com/how_to/how_to_use_facetdata
  116661. */
  116662. getFacetNormalToRef(i: number, ref: Vector3): this;
  116663. /**
  116664. * 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)
  116665. * @param x defines x coordinate
  116666. * @param y defines y coordinate
  116667. * @param z defines z coordinate
  116668. * @returns the array of facet indexes
  116669. * @see https://doc.babylonjs.com/how_to/how_to_use_facetdata
  116670. */
  116671. getFacetsAtLocalCoordinates(x: number, y: number, z: number): Nullable<number[]>;
  116672. /**
  116673. * Returns the closest mesh facet index at (x,y,z) World coordinates, null if not found
  116674. * @param projected sets as the (x,y,z) world projection on the facet
  116675. * @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
  116676. * @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
  116677. * @param x defines x coordinate
  116678. * @param y defines y coordinate
  116679. * @param z defines z coordinate
  116680. * @returns the face index if found (or null instead)
  116681. * @see https://doc.babylonjs.com/how_to/how_to_use_facetdata
  116682. */
  116683. getClosestFacetAtCoordinates(x: number, y: number, z: number, projected?: Vector3, checkFace?: boolean, facing?: boolean): Nullable<number>;
  116684. /**
  116685. * Returns the closest mesh facet index at (x,y,z) local coordinates, null if not found
  116686. * @param projected sets as the (x,y,z) local projection on the facet
  116687. * @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
  116688. * @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
  116689. * @param x defines x coordinate
  116690. * @param y defines y coordinate
  116691. * @param z defines z coordinate
  116692. * @returns the face index if found (or null instead)
  116693. * @see https://doc.babylonjs.com/how_to/how_to_use_facetdata
  116694. */
  116695. getClosestFacetAtLocalCoordinates(x: number, y: number, z: number, projected?: Vector3, checkFace?: boolean, facing?: boolean): Nullable<number>;
  116696. /**
  116697. * Returns the object "parameter" set with all the expected parameters for facetData computation by ComputeNormals()
  116698. * @returns the parameters
  116699. * @see https://doc.babylonjs.com/how_to/how_to_use_facetdata
  116700. */
  116701. getFacetDataParameters(): any;
  116702. /**
  116703. * Disables the feature FacetData and frees the related memory
  116704. * @returns the current mesh
  116705. * @see https://doc.babylonjs.com/how_to/how_to_use_facetdata
  116706. */
  116707. disableFacetData(): AbstractMesh;
  116708. /**
  116709. * Updates the AbstractMesh indices array
  116710. * @param indices defines the data source
  116711. * @param offset defines the offset in the index buffer where to store the new data (can be null)
  116712. * @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)
  116713. * @returns the current mesh
  116714. */
  116715. updateIndices(indices: IndicesArray, offset?: number, gpuMemoryOnly?: boolean): AbstractMesh;
  116716. /**
  116717. * Creates new normals data for the mesh
  116718. * @param updatable defines if the normal vertex buffer must be flagged as updatable
  116719. * @returns the current mesh
  116720. */
  116721. createNormals(updatable: boolean): AbstractMesh;
  116722. /**
  116723. * Align the mesh with a normal
  116724. * @param normal defines the normal to use
  116725. * @param upDirection can be used to redefined the up vector to use (will use the (0, 1, 0) by default)
  116726. * @returns the current mesh
  116727. */
  116728. alignWithNormal(normal: Vector3, upDirection?: Vector3): AbstractMesh;
  116729. /** @hidden */
  116730. _checkOcclusionQuery(): boolean;
  116731. /**
  116732. * Disables the mesh edge rendering mode
  116733. * @returns the currentAbstractMesh
  116734. */
  116735. disableEdgesRendering(): AbstractMesh;
  116736. /**
  116737. * Enables the edge rendering mode on the mesh.
  116738. * This mode makes the mesh edges visible
  116739. * @param epsilon defines the maximal distance between two angles to detect a face
  116740. * @param checkVerticesInsteadOfIndices indicates that we should check vertex list directly instead of faces
  116741. * @returns the currentAbstractMesh
  116742. * @see https://www.babylonjs-playground.com/#19O9TU#0
  116743. */
  116744. enableEdgesRendering(epsilon?: number, checkVerticesInsteadOfIndices?: boolean): AbstractMesh;
  116745. /**
  116746. * This function returns all of the particle systems in the scene that use the mesh as an emitter.
  116747. * @returns an array of particle systems in the scene that use the mesh as an emitter
  116748. */
  116749. getConnectedParticleSystems(): IParticleSystem[];
  116750. }
  116751. }
  116752. declare module BABYLON {
  116753. /**
  116754. * Interface used to define ActionEvent
  116755. */
  116756. export interface IActionEvent {
  116757. /** The mesh or sprite that triggered the action */
  116758. source: any;
  116759. /** The X mouse cursor position at the time of the event */
  116760. pointerX: number;
  116761. /** The Y mouse cursor position at the time of the event */
  116762. pointerY: number;
  116763. /** The mesh that is currently pointed at (can be null) */
  116764. meshUnderPointer: Nullable<AbstractMesh>;
  116765. /** the original (browser) event that triggered the ActionEvent */
  116766. sourceEvent?: any;
  116767. /** additional data for the event */
  116768. additionalData?: any;
  116769. }
  116770. /**
  116771. * ActionEvent is the event being sent when an action is triggered.
  116772. */
  116773. export class ActionEvent implements IActionEvent {
  116774. /** The mesh or sprite that triggered the action */
  116775. source: any;
  116776. /** The X mouse cursor position at the time of the event */
  116777. pointerX: number;
  116778. /** The Y mouse cursor position at the time of the event */
  116779. pointerY: number;
  116780. /** The mesh that is currently pointed at (can be null) */
  116781. meshUnderPointer: Nullable<AbstractMesh>;
  116782. /** the original (browser) event that triggered the ActionEvent */
  116783. sourceEvent?: any;
  116784. /** additional data for the event */
  116785. additionalData?: any;
  116786. /**
  116787. * Creates a new ActionEvent
  116788. * @param source The mesh or sprite that triggered the action
  116789. * @param pointerX The X mouse cursor position at the time of the event
  116790. * @param pointerY The Y mouse cursor position at the time of the event
  116791. * @param meshUnderPointer The mesh that is currently pointed at (can be null)
  116792. * @param sourceEvent the original (browser) event that triggered the ActionEvent
  116793. * @param additionalData additional data for the event
  116794. */
  116795. constructor(
  116796. /** The mesh or sprite that triggered the action */
  116797. source: any,
  116798. /** The X mouse cursor position at the time of the event */
  116799. pointerX: number,
  116800. /** The Y mouse cursor position at the time of the event */
  116801. pointerY: number,
  116802. /** The mesh that is currently pointed at (can be null) */
  116803. meshUnderPointer: Nullable<AbstractMesh>,
  116804. /** the original (browser) event that triggered the ActionEvent */
  116805. sourceEvent?: any,
  116806. /** additional data for the event */
  116807. additionalData?: any);
  116808. /**
  116809. * Helper function to auto-create an ActionEvent from a source mesh.
  116810. * @param source The source mesh that triggered the event
  116811. * @param evt The original (browser) event
  116812. * @param additionalData additional data for the event
  116813. * @returns the new ActionEvent
  116814. */
  116815. static CreateNew(source: AbstractMesh, evt?: Event, additionalData?: any): ActionEvent;
  116816. /**
  116817. * Helper function to auto-create an ActionEvent from a source sprite
  116818. * @param source The source sprite that triggered the event
  116819. * @param scene Scene associated with the sprite
  116820. * @param evt The original (browser) event
  116821. * @param additionalData additional data for the event
  116822. * @returns the new ActionEvent
  116823. */
  116824. static CreateNewFromSprite(source: Sprite, scene: Scene, evt?: Event, additionalData?: any): ActionEvent;
  116825. /**
  116826. * Helper function to auto-create an ActionEvent from a scene. If triggered by a mesh use ActionEvent.CreateNew
  116827. * @param scene the scene where the event occurred
  116828. * @param evt The original (browser) event
  116829. * @returns the new ActionEvent
  116830. */
  116831. static CreateNewFromScene(scene: Scene, evt: Event): ActionEvent;
  116832. /**
  116833. * Helper function to auto-create an ActionEvent from a primitive
  116834. * @param prim defines the target primitive
  116835. * @param pointerPos defines the pointer position
  116836. * @param evt The original (browser) event
  116837. * @param additionalData additional data for the event
  116838. * @returns the new ActionEvent
  116839. */
  116840. static CreateNewFromPrimitive(prim: any, pointerPos: Vector2, evt?: Event, additionalData?: any): ActionEvent;
  116841. }
  116842. }
  116843. declare module BABYLON {
  116844. /**
  116845. * Abstract class used to decouple action Manager from scene and meshes.
  116846. * Do not instantiate.
  116847. * @see https://doc.babylonjs.com/how_to/how_to_use_actions
  116848. */
  116849. export abstract class AbstractActionManager implements IDisposable {
  116850. /** Gets the list of active triggers */
  116851. static Triggers: {
  116852. [key: string]: number;
  116853. };
  116854. /** Gets the cursor to use when hovering items */
  116855. hoverCursor: string;
  116856. /** Gets the list of actions */
  116857. actions: IAction[];
  116858. /**
  116859. * Gets or sets a boolean indicating that the manager is recursive meaning that it can trigger action from children
  116860. */
  116861. isRecursive: boolean;
  116862. /**
  116863. * Releases all associated resources
  116864. */
  116865. abstract dispose(): void;
  116866. /**
  116867. * Does this action manager has pointer triggers
  116868. */
  116869. abstract get hasPointerTriggers(): boolean;
  116870. /**
  116871. * Does this action manager has pick triggers
  116872. */
  116873. abstract get hasPickTriggers(): boolean;
  116874. /**
  116875. * Process a specific trigger
  116876. * @param trigger defines the trigger to process
  116877. * @param evt defines the event details to be processed
  116878. */
  116879. abstract processTrigger(trigger: number, evt?: IActionEvent): void;
  116880. /**
  116881. * Does this action manager handles actions of any of the given triggers
  116882. * @param triggers defines the triggers to be tested
  116883. * @return a boolean indicating whether one (or more) of the triggers is handled
  116884. */
  116885. abstract hasSpecificTriggers(triggers: number[]): boolean;
  116886. /**
  116887. * Does this action manager handles actions of any of the given triggers. This function takes two arguments for
  116888. * speed.
  116889. * @param triggerA defines the trigger to be tested
  116890. * @param triggerB defines the trigger to be tested
  116891. * @return a boolean indicating whether one (or more) of the triggers is handled
  116892. */
  116893. abstract hasSpecificTriggers2(triggerA: number, triggerB: number): boolean;
  116894. /**
  116895. * Does this action manager handles actions of a given trigger
  116896. * @param trigger defines the trigger to be tested
  116897. * @param parameterPredicate defines an optional predicate to filter triggers by parameter
  116898. * @return whether the trigger is handled
  116899. */
  116900. abstract hasSpecificTrigger(trigger: number, parameterPredicate?: (parameter: any) => boolean): boolean;
  116901. /**
  116902. * Serialize this manager to a JSON object
  116903. * @param name defines the property name to store this manager
  116904. * @returns a JSON representation of this manager
  116905. */
  116906. abstract serialize(name: string): any;
  116907. /**
  116908. * Registers an action to this action manager
  116909. * @param action defines the action to be registered
  116910. * @return the action amended (prepared) after registration
  116911. */
  116912. abstract registerAction(action: IAction): Nullable<IAction>;
  116913. /**
  116914. * Unregisters an action to this action manager
  116915. * @param action defines the action to be unregistered
  116916. * @return a boolean indicating whether the action has been unregistered
  116917. */
  116918. abstract unregisterAction(action: IAction): Boolean;
  116919. /**
  116920. * Does exist one action manager with at least one trigger
  116921. **/
  116922. static get HasTriggers(): boolean;
  116923. /**
  116924. * Does exist one action manager with at least one pick trigger
  116925. **/
  116926. static get HasPickTriggers(): boolean;
  116927. /**
  116928. * Does exist one action manager that handles actions of a given trigger
  116929. * @param trigger defines the trigger to be tested
  116930. * @return a boolean indicating whether the trigger is handeled by at least one action manager
  116931. **/
  116932. static HasSpecificTrigger(trigger: number): boolean;
  116933. }
  116934. }
  116935. declare module BABYLON {
  116936. /**
  116937. * Defines how a node can be built from a string name.
  116938. */
  116939. export type NodeConstructor = (name: string, scene: Scene, options?: any) => () => Node;
  116940. /**
  116941. * Node is the basic class for all scene objects (Mesh, Light, Camera.)
  116942. */
  116943. export class Node implements IBehaviorAware<Node> {
  116944. /** @hidden */
  116945. static _AnimationRangeFactory: (name: string, from: number, to: number) => AnimationRange;
  116946. private static _NodeConstructors;
  116947. /**
  116948. * Add a new node constructor
  116949. * @param type defines the type name of the node to construct
  116950. * @param constructorFunc defines the constructor function
  116951. */
  116952. static AddNodeConstructor(type: string, constructorFunc: NodeConstructor): void;
  116953. /**
  116954. * Returns a node constructor based on type name
  116955. * @param type defines the type name
  116956. * @param name defines the new node name
  116957. * @param scene defines the hosting scene
  116958. * @param options defines optional options to transmit to constructors
  116959. * @returns the new constructor or null
  116960. */
  116961. static Construct(type: string, name: string, scene: Scene, options?: any): Nullable<() => Node>;
  116962. /**
  116963. * Gets or sets the name of the node
  116964. */
  116965. name: string;
  116966. /**
  116967. * Gets or sets the id of the node
  116968. */
  116969. id: string;
  116970. /**
  116971. * Gets or sets the unique id of the node
  116972. */
  116973. uniqueId: number;
  116974. /**
  116975. * Gets or sets a string used to store user defined state for the node
  116976. */
  116977. state: string;
  116978. /**
  116979. * Gets or sets an object used to store user defined information for the node
  116980. */
  116981. metadata: any;
  116982. /**
  116983. * For internal use only. Please do not use.
  116984. */
  116985. reservedDataStore: any;
  116986. /**
  116987. * List of inspectable custom properties (used by the Inspector)
  116988. * @see https://doc.babylonjs.com/how_to/debug_layer#extensibility
  116989. */
  116990. inspectableCustomProperties: IInspectable[];
  116991. private _doNotSerialize;
  116992. /**
  116993. * Gets or sets a boolean used to define if the node must be serialized
  116994. */
  116995. get doNotSerialize(): boolean;
  116996. set doNotSerialize(value: boolean);
  116997. /** @hidden */
  116998. _isDisposed: boolean;
  116999. /**
  117000. * Gets a list of Animations associated with the node
  117001. */
  117002. animations: Animation[];
  117003. protected _ranges: {
  117004. [name: string]: Nullable<AnimationRange>;
  117005. };
  117006. /**
  117007. * Callback raised when the node is ready to be used
  117008. */
  117009. onReady: Nullable<(node: Node) => void>;
  117010. private _isEnabled;
  117011. private _isParentEnabled;
  117012. private _isReady;
  117013. /** @hidden */
  117014. _currentRenderId: number;
  117015. private _parentUpdateId;
  117016. /** @hidden */
  117017. _childUpdateId: number;
  117018. /** @hidden */
  117019. _waitingParentId: Nullable<string>;
  117020. /** @hidden */
  117021. _scene: Scene;
  117022. /** @hidden */
  117023. _cache: any;
  117024. private _parentNode;
  117025. private _children;
  117026. /** @hidden */
  117027. _worldMatrix: Matrix;
  117028. /** @hidden */
  117029. _worldMatrixDeterminant: number;
  117030. /** @hidden */
  117031. _worldMatrixDeterminantIsDirty: boolean;
  117032. /** @hidden */
  117033. private _sceneRootNodesIndex;
  117034. /**
  117035. * Gets a boolean indicating if the node has been disposed
  117036. * @returns true if the node was disposed
  117037. */
  117038. isDisposed(): boolean;
  117039. /**
  117040. * Gets or sets the parent of the node (without keeping the current position in the scene)
  117041. * @see https://doc.babylonjs.com/how_to/parenting
  117042. */
  117043. set parent(parent: Nullable<Node>);
  117044. get parent(): Nullable<Node>;
  117045. /** @hidden */
  117046. _addToSceneRootNodes(): void;
  117047. /** @hidden */
  117048. _removeFromSceneRootNodes(): void;
  117049. private _animationPropertiesOverride;
  117050. /**
  117051. * Gets or sets the animation properties override
  117052. */
  117053. get animationPropertiesOverride(): Nullable<AnimationPropertiesOverride>;
  117054. set animationPropertiesOverride(value: Nullable<AnimationPropertiesOverride>);
  117055. /**
  117056. * Gets a string identifying the name of the class
  117057. * @returns "Node" string
  117058. */
  117059. getClassName(): string;
  117060. /** @hidden */
  117061. readonly _isNode: boolean;
  117062. /**
  117063. * An event triggered when the mesh is disposed
  117064. */
  117065. onDisposeObservable: Observable<Node>;
  117066. private _onDisposeObserver;
  117067. /**
  117068. * Sets a callback that will be raised when the node will be disposed
  117069. */
  117070. set onDispose(callback: () => void);
  117071. /**
  117072. * Creates a new Node
  117073. * @param name the name and id to be given to this node
  117074. * @param scene the scene this node will be added to
  117075. */
  117076. constructor(name: string, scene?: Nullable<Scene>);
  117077. /**
  117078. * Gets the scene of the node
  117079. * @returns a scene
  117080. */
  117081. getScene(): Scene;
  117082. /**
  117083. * Gets the engine of the node
  117084. * @returns a Engine
  117085. */
  117086. getEngine(): Engine;
  117087. private _behaviors;
  117088. /**
  117089. * Attach a behavior to the node
  117090. * @see https://doc.babylonjs.com/features/behaviour
  117091. * @param behavior defines the behavior to attach
  117092. * @param attachImmediately defines that the behavior must be attached even if the scene is still loading
  117093. * @returns the current Node
  117094. */
  117095. addBehavior(behavior: Behavior<Node>, attachImmediately?: boolean): Node;
  117096. /**
  117097. * Remove an attached behavior
  117098. * @see https://doc.babylonjs.com/features/behaviour
  117099. * @param behavior defines the behavior to attach
  117100. * @returns the current Node
  117101. */
  117102. removeBehavior(behavior: Behavior<Node>): Node;
  117103. /**
  117104. * Gets the list of attached behaviors
  117105. * @see https://doc.babylonjs.com/features/behaviour
  117106. */
  117107. get behaviors(): Behavior<Node>[];
  117108. /**
  117109. * Gets an attached behavior by name
  117110. * @param name defines the name of the behavior to look for
  117111. * @see https://doc.babylonjs.com/features/behaviour
  117112. * @returns null if behavior was not found else the requested behavior
  117113. */
  117114. getBehaviorByName(name: string): Nullable<Behavior<Node>>;
  117115. /**
  117116. * Returns the latest update of the World matrix
  117117. * @returns a Matrix
  117118. */
  117119. getWorldMatrix(): Matrix;
  117120. /** @hidden */
  117121. _getWorldMatrixDeterminant(): number;
  117122. /**
  117123. * Returns directly the latest state of the mesh World matrix.
  117124. * A Matrix is returned.
  117125. */
  117126. get worldMatrixFromCache(): Matrix;
  117127. /** @hidden */
  117128. _initCache(): void;
  117129. /** @hidden */
  117130. updateCache(force?: boolean): void;
  117131. /** @hidden */
  117132. _getActionManagerForTrigger(trigger?: number, initialCall?: boolean): Nullable<AbstractActionManager>;
  117133. /** @hidden */
  117134. _updateCache(ignoreParentClass?: boolean): void;
  117135. /** @hidden */
  117136. _isSynchronized(): boolean;
  117137. /** @hidden */
  117138. _markSyncedWithParent(): void;
  117139. /** @hidden */
  117140. isSynchronizedWithParent(): boolean;
  117141. /** @hidden */
  117142. isSynchronized(): boolean;
  117143. /**
  117144. * Is this node ready to be used/rendered
  117145. * @param completeCheck defines if a complete check (including materials and lights) has to be done (false by default)
  117146. * @return true if the node is ready
  117147. */
  117148. isReady(completeCheck?: boolean): boolean;
  117149. /**
  117150. * Is this node enabled?
  117151. * 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
  117152. * @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
  117153. * @return whether this node (and its parent) is enabled
  117154. */
  117155. isEnabled(checkAncestors?: boolean): boolean;
  117156. /** @hidden */
  117157. protected _syncParentEnabledState(): void;
  117158. /**
  117159. * Set the enabled state of this node
  117160. * @param value defines the new enabled state
  117161. */
  117162. setEnabled(value: boolean): void;
  117163. /**
  117164. * Is this node a descendant of the given node?
  117165. * The function will iterate up the hierarchy until the ancestor was found or no more parents defined
  117166. * @param ancestor defines the parent node to inspect
  117167. * @returns a boolean indicating if this node is a descendant of the given node
  117168. */
  117169. isDescendantOf(ancestor: Node): boolean;
  117170. /** @hidden */
  117171. _getDescendants(results: Node[], directDescendantsOnly?: boolean, predicate?: (node: Node) => boolean): void;
  117172. /**
  117173. * Will return all nodes that have this node as ascendant
  117174. * @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
  117175. * @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
  117176. * @return all children nodes of all types
  117177. */
  117178. getDescendants(directDescendantsOnly?: boolean, predicate?: (node: Node) => boolean): Node[];
  117179. /**
  117180. * Get all child-meshes of this node
  117181. * @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)
  117182. * @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
  117183. * @returns an array of AbstractMesh
  117184. */
  117185. getChildMeshes(directDescendantsOnly?: boolean, predicate?: (node: Node) => boolean): AbstractMesh[];
  117186. /**
  117187. * Get all direct children of this node
  117188. * @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
  117189. * @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)
  117190. * @returns an array of Node
  117191. */
  117192. getChildren(predicate?: (node: Node) => boolean, directDescendantsOnly?: boolean): Node[];
  117193. /** @hidden */
  117194. _setReady(state: boolean): void;
  117195. /**
  117196. * Get an animation by name
  117197. * @param name defines the name of the animation to look for
  117198. * @returns null if not found else the requested animation
  117199. */
  117200. getAnimationByName(name: string): Nullable<Animation>;
  117201. /**
  117202. * Creates an animation range for this node
  117203. * @param name defines the name of the range
  117204. * @param from defines the starting key
  117205. * @param to defines the end key
  117206. */
  117207. createAnimationRange(name: string, from: number, to: number): void;
  117208. /**
  117209. * Delete a specific animation range
  117210. * @param name defines the name of the range to delete
  117211. * @param deleteFrames defines if animation frames from the range must be deleted as well
  117212. */
  117213. deleteAnimationRange(name: string, deleteFrames?: boolean): void;
  117214. /**
  117215. * Get an animation range by name
  117216. * @param name defines the name of the animation range to look for
  117217. * @returns null if not found else the requested animation range
  117218. */
  117219. getAnimationRange(name: string): Nullable<AnimationRange>;
  117220. /**
  117221. * Gets the list of all animation ranges defined on this node
  117222. * @returns an array
  117223. */
  117224. getAnimationRanges(): Nullable<AnimationRange>[];
  117225. /**
  117226. * Will start the animation sequence
  117227. * @param name defines the range frames for animation sequence
  117228. * @param loop defines if the animation should loop (false by default)
  117229. * @param speedRatio defines the speed factor in which to run the animation (1 by default)
  117230. * @param onAnimationEnd defines a function to be executed when the animation ended (undefined by default)
  117231. * @returns the object created for this animation. If range does not exist, it will return null
  117232. */
  117233. beginAnimation(name: string, loop?: boolean, speedRatio?: number, onAnimationEnd?: () => void): Nullable<Animatable>;
  117234. /**
  117235. * Serialize animation ranges into a JSON compatible object
  117236. * @returns serialization object
  117237. */
  117238. serializeAnimationRanges(): any;
  117239. /**
  117240. * Computes the world matrix of the node
  117241. * @param force defines if the cache version should be invalidated forcing the world matrix to be created from scratch
  117242. * @returns the world matrix
  117243. */
  117244. computeWorldMatrix(force?: boolean): Matrix;
  117245. /**
  117246. * Releases resources associated with this node.
  117247. * @param doNotRecurse Set to true to not recurse into each children (recurse into each children by default)
  117248. * @param disposeMaterialAndTextures Set to true to also dispose referenced materials and textures (false by default)
  117249. */
  117250. dispose(doNotRecurse?: boolean, disposeMaterialAndTextures?: boolean): void;
  117251. /**
  117252. * Parse animation range data from a serialization object and store them into a given node
  117253. * @param node defines where to store the animation ranges
  117254. * @param parsedNode defines the serialization object to read data from
  117255. * @param scene defines the hosting scene
  117256. */
  117257. static ParseAnimationRanges(node: Node, parsedNode: any, scene: Scene): void;
  117258. /**
  117259. * Return the minimum and maximum world vectors of the entire hierarchy under current node
  117260. * @param includeDescendants Include bounding info from descendants as well (true by default)
  117261. * @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
  117262. * @returns the new bounding vectors
  117263. */
  117264. getHierarchyBoundingVectors(includeDescendants?: boolean, predicate?: Nullable<(abstractMesh: AbstractMesh) => boolean>): {
  117265. min: Vector3;
  117266. max: Vector3;
  117267. };
  117268. }
  117269. }
  117270. declare module BABYLON {
  117271. /**
  117272. * @hidden
  117273. */
  117274. export class _IAnimationState {
  117275. key: number;
  117276. repeatCount: number;
  117277. workValue?: any;
  117278. loopMode?: number;
  117279. offsetValue?: any;
  117280. highLimitValue?: any;
  117281. }
  117282. /**
  117283. * Class used to store any kind of animation
  117284. */
  117285. export class Animation {
  117286. /**Name of the animation */
  117287. name: string;
  117288. /**Property to animate */
  117289. targetProperty: string;
  117290. /**The frames per second of the animation */
  117291. framePerSecond: number;
  117292. /**The data type of the animation */
  117293. dataType: number;
  117294. /**The loop mode of the animation */
  117295. loopMode?: number | undefined;
  117296. /**Specifies if blending should be enabled */
  117297. enableBlending?: boolean | undefined;
  117298. /**
  117299. * Use matrix interpolation instead of using direct key value when animating matrices
  117300. */
  117301. static AllowMatricesInterpolation: boolean;
  117302. /**
  117303. * When matrix interpolation is enabled, this boolean forces the system to use Matrix.DecomposeLerp instead of Matrix.Lerp. Interpolation is more precise but slower
  117304. */
  117305. static AllowMatrixDecomposeForInterpolation: boolean;
  117306. /** Define the Url to load snippets */
  117307. static SnippetUrl: string;
  117308. /** Snippet ID if the animation was created from the snippet server */
  117309. snippetId: string;
  117310. /**
  117311. * Stores the key frames of the animation
  117312. */
  117313. private _keys;
  117314. /**
  117315. * Stores the easing function of the animation
  117316. */
  117317. private _easingFunction;
  117318. /**
  117319. * @hidden Internal use only
  117320. */
  117321. _runtimeAnimations: RuntimeAnimation[];
  117322. /**
  117323. * The set of event that will be linked to this animation
  117324. */
  117325. private _events;
  117326. /**
  117327. * Stores an array of target property paths
  117328. */
  117329. targetPropertyPath: string[];
  117330. /**
  117331. * Stores the blending speed of the animation
  117332. */
  117333. blendingSpeed: number;
  117334. /**
  117335. * Stores the animation ranges for the animation
  117336. */
  117337. private _ranges;
  117338. /**
  117339. * @hidden Internal use
  117340. */
  117341. static _PrepareAnimation(name: string, targetProperty: string, framePerSecond: number, totalFrame: number, from: any, to: any, loopMode?: number, easingFunction?: EasingFunction): Nullable<Animation>;
  117342. /**
  117343. * Sets up an animation
  117344. * @param property The property to animate
  117345. * @param animationType The animation type to apply
  117346. * @param framePerSecond The frames per second of the animation
  117347. * @param easingFunction The easing function used in the animation
  117348. * @returns The created animation
  117349. */
  117350. static CreateAnimation(property: string, animationType: number, framePerSecond: number, easingFunction: EasingFunction): Animation;
  117351. /**
  117352. * Create and start an animation on a node
  117353. * @param name defines the name of the global animation that will be run on all nodes
  117354. * @param node defines the root node where the animation will take place
  117355. * @param targetProperty defines property to animate
  117356. * @param framePerSecond defines the number of frame per second yo use
  117357. * @param totalFrame defines the number of frames in total
  117358. * @param from defines the initial value
  117359. * @param to defines the final value
  117360. * @param loopMode defines which loop mode you want to use (off by default)
  117361. * @param easingFunction defines the easing function to use (linear by default)
  117362. * @param onAnimationEnd defines the callback to call when animation end
  117363. * @returns the animatable created for this animation
  117364. */
  117365. static CreateAndStartAnimation(name: string, node: Node, targetProperty: string, framePerSecond: number, totalFrame: number, from: any, to: any, loopMode?: number, easingFunction?: EasingFunction, onAnimationEnd?: () => void): Nullable<Animatable>;
  117366. /**
  117367. * Create and start an animation on a node and its descendants
  117368. * @param name defines the name of the global animation that will be run on all nodes
  117369. * @param node defines the root node where the animation will take place
  117370. * @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
  117371. * @param targetProperty defines property to animate
  117372. * @param framePerSecond defines the number of frame per second to use
  117373. * @param totalFrame defines the number of frames in total
  117374. * @param from defines the initial value
  117375. * @param to defines the final value
  117376. * @param loopMode defines which loop mode you want to use (off by default)
  117377. * @param easingFunction defines the easing function to use (linear by default)
  117378. * @param onAnimationEnd defines the callback to call when an animation ends (will be called once per node)
  117379. * @returns the list of animatables created for all nodes
  117380. * @example https://www.babylonjs-playground.com/#MH0VLI
  117381. */
  117382. 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[]>;
  117383. /**
  117384. * Creates a new animation, merges it with the existing animations and starts it
  117385. * @param name Name of the animation
  117386. * @param node Node which contains the scene that begins the animations
  117387. * @param targetProperty Specifies which property to animate
  117388. * @param framePerSecond The frames per second of the animation
  117389. * @param totalFrame The total number of frames
  117390. * @param from The frame at the beginning of the animation
  117391. * @param to The frame at the end of the animation
  117392. * @param loopMode Specifies the loop mode of the animation
  117393. * @param easingFunction (Optional) The easing function of the animation, which allow custom mathematical formulas for animations
  117394. * @param onAnimationEnd Callback to run once the animation is complete
  117395. * @returns Nullable animation
  117396. */
  117397. static CreateMergeAndStartAnimation(name: string, node: Node, targetProperty: string, framePerSecond: number, totalFrame: number, from: any, to: any, loopMode?: number, easingFunction?: EasingFunction, onAnimationEnd?: () => void): Nullable<Animatable>;
  117398. /**
  117399. * Convert the keyframes for all animations belonging to the group to be relative to a given reference frame.
  117400. * @param sourceAnimation defines the Animation containing keyframes to convert
  117401. * @param referenceFrame defines the frame that keyframes in the range will be relative to
  117402. * @param range defines the name of the AnimationRange belonging to the Animation to convert
  117403. * @param cloneOriginal defines whether or not to clone the animation and convert the clone or convert the original animation (default is false)
  117404. * @param clonedName defines the name of the resulting cloned Animation if cloneOriginal is true
  117405. * @returns a new Animation if cloneOriginal is true or the original Animation if cloneOriginal is false
  117406. */
  117407. static MakeAnimationAdditive(sourceAnimation: Animation, referenceFrame?: number, range?: string, cloneOriginal?: boolean, clonedName?: string): Animation;
  117408. /**
  117409. * Transition property of an host to the target Value
  117410. * @param property The property to transition
  117411. * @param targetValue The target Value of the property
  117412. * @param host The object where the property to animate belongs
  117413. * @param scene Scene used to run the animation
  117414. * @param frameRate Framerate (in frame/s) to use
  117415. * @param transition The transition type we want to use
  117416. * @param duration The duration of the animation, in milliseconds
  117417. * @param onAnimationEnd Callback trigger at the end of the animation
  117418. * @returns Nullable animation
  117419. */
  117420. static TransitionTo(property: string, targetValue: any, host: any, scene: Scene, frameRate: number, transition: Animation, duration: number, onAnimationEnd?: Nullable<() => void>): Nullable<Animatable>;
  117421. /**
  117422. * Return the array of runtime animations currently using this animation
  117423. */
  117424. get runtimeAnimations(): RuntimeAnimation[];
  117425. /**
  117426. * Specifies if any of the runtime animations are currently running
  117427. */
  117428. get hasRunningRuntimeAnimations(): boolean;
  117429. /**
  117430. * Initializes the animation
  117431. * @param name Name of the animation
  117432. * @param targetProperty Property to animate
  117433. * @param framePerSecond The frames per second of the animation
  117434. * @param dataType The data type of the animation
  117435. * @param loopMode The loop mode of the animation
  117436. * @param enableBlending Specifies if blending should be enabled
  117437. */
  117438. constructor(
  117439. /**Name of the animation */
  117440. name: string,
  117441. /**Property to animate */
  117442. targetProperty: string,
  117443. /**The frames per second of the animation */
  117444. framePerSecond: number,
  117445. /**The data type of the animation */
  117446. dataType: number,
  117447. /**The loop mode of the animation */
  117448. loopMode?: number | undefined,
  117449. /**Specifies if blending should be enabled */
  117450. enableBlending?: boolean | undefined);
  117451. /**
  117452. * Converts the animation to a string
  117453. * @param fullDetails support for multiple levels of logging within scene loading
  117454. * @returns String form of the animation
  117455. */
  117456. toString(fullDetails?: boolean): string;
  117457. /**
  117458. * Add an event to this animation
  117459. * @param event Event to add
  117460. */
  117461. addEvent(event: AnimationEvent): void;
  117462. /**
  117463. * Remove all events found at the given frame
  117464. * @param frame The frame to remove events from
  117465. */
  117466. removeEvents(frame: number): void;
  117467. /**
  117468. * Retrieves all the events from the animation
  117469. * @returns Events from the animation
  117470. */
  117471. getEvents(): AnimationEvent[];
  117472. /**
  117473. * Creates an animation range
  117474. * @param name Name of the animation range
  117475. * @param from Starting frame of the animation range
  117476. * @param to Ending frame of the animation
  117477. */
  117478. createRange(name: string, from: number, to: number): void;
  117479. /**
  117480. * Deletes an animation range by name
  117481. * @param name Name of the animation range to delete
  117482. * @param deleteFrames Specifies if the key frames for the range should also be deleted (true) or not (false)
  117483. */
  117484. deleteRange(name: string, deleteFrames?: boolean): void;
  117485. /**
  117486. * Gets the animation range by name, or null if not defined
  117487. * @param name Name of the animation range
  117488. * @returns Nullable animation range
  117489. */
  117490. getRange(name: string): Nullable<AnimationRange>;
  117491. /**
  117492. * Gets the key frames from the animation
  117493. * @returns The key frames of the animation
  117494. */
  117495. getKeys(): Array<IAnimationKey>;
  117496. /**
  117497. * Gets the highest frame rate of the animation
  117498. * @returns Highest frame rate of the animation
  117499. */
  117500. getHighestFrame(): number;
  117501. /**
  117502. * Gets the easing function of the animation
  117503. * @returns Easing function of the animation
  117504. */
  117505. getEasingFunction(): IEasingFunction;
  117506. /**
  117507. * Sets the easing function of the animation
  117508. * @param easingFunction A custom mathematical formula for animation
  117509. */
  117510. setEasingFunction(easingFunction: EasingFunction): void;
  117511. /**
  117512. * Interpolates a scalar linearly
  117513. * @param startValue Start value of the animation curve
  117514. * @param endValue End value of the animation curve
  117515. * @param gradient Scalar amount to interpolate
  117516. * @returns Interpolated scalar value
  117517. */
  117518. floatInterpolateFunction(startValue: number, endValue: number, gradient: number): number;
  117519. /**
  117520. * Interpolates a scalar cubically
  117521. * @param startValue Start value of the animation curve
  117522. * @param outTangent End tangent of the animation
  117523. * @param endValue End value of the animation curve
  117524. * @param inTangent Start tangent of the animation curve
  117525. * @param gradient Scalar amount to interpolate
  117526. * @returns Interpolated scalar value
  117527. */
  117528. floatInterpolateFunctionWithTangents(startValue: number, outTangent: number, endValue: number, inTangent: number, gradient: number): number;
  117529. /**
  117530. * Interpolates a quaternion using a spherical linear interpolation
  117531. * @param startValue Start value of the animation curve
  117532. * @param endValue End value of the animation curve
  117533. * @param gradient Scalar amount to interpolate
  117534. * @returns Interpolated quaternion value
  117535. */
  117536. quaternionInterpolateFunction(startValue: Quaternion, endValue: Quaternion, gradient: number): Quaternion;
  117537. /**
  117538. * Interpolates a quaternion cubically
  117539. * @param startValue Start value of the animation curve
  117540. * @param outTangent End tangent of the animation curve
  117541. * @param endValue End value of the animation curve
  117542. * @param inTangent Start tangent of the animation curve
  117543. * @param gradient Scalar amount to interpolate
  117544. * @returns Interpolated quaternion value
  117545. */
  117546. quaternionInterpolateFunctionWithTangents(startValue: Quaternion, outTangent: Quaternion, endValue: Quaternion, inTangent: Quaternion, gradient: number): Quaternion;
  117547. /**
  117548. * Interpolates a Vector3 linearl
  117549. * @param startValue Start value of the animation curve
  117550. * @param endValue End value of the animation curve
  117551. * @param gradient Scalar amount to interpolate
  117552. * @returns Interpolated scalar value
  117553. */
  117554. vector3InterpolateFunction(startValue: Vector3, endValue: Vector3, gradient: number): Vector3;
  117555. /**
  117556. * Interpolates a Vector3 cubically
  117557. * @param startValue Start value of the animation curve
  117558. * @param outTangent End tangent of the animation
  117559. * @param endValue End value of the animation curve
  117560. * @param inTangent Start tangent of the animation curve
  117561. * @param gradient Scalar amount to interpolate
  117562. * @returns InterpolatedVector3 value
  117563. */
  117564. vector3InterpolateFunctionWithTangents(startValue: Vector3, outTangent: Vector3, endValue: Vector3, inTangent: Vector3, gradient: number): Vector3;
  117565. /**
  117566. * Interpolates a Vector2 linearly
  117567. * @param startValue Start value of the animation curve
  117568. * @param endValue End value of the animation curve
  117569. * @param gradient Scalar amount to interpolate
  117570. * @returns Interpolated Vector2 value
  117571. */
  117572. vector2InterpolateFunction(startValue: Vector2, endValue: Vector2, gradient: number): Vector2;
  117573. /**
  117574. * Interpolates a Vector2 cubically
  117575. * @param startValue Start value of the animation curve
  117576. * @param outTangent End tangent of the animation
  117577. * @param endValue End value of the animation curve
  117578. * @param inTangent Start tangent of the animation curve
  117579. * @param gradient Scalar amount to interpolate
  117580. * @returns Interpolated Vector2 value
  117581. */
  117582. vector2InterpolateFunctionWithTangents(startValue: Vector2, outTangent: Vector2, endValue: Vector2, inTangent: Vector2, gradient: number): Vector2;
  117583. /**
  117584. * Interpolates a size linearly
  117585. * @param startValue Start value of the animation curve
  117586. * @param endValue End value of the animation curve
  117587. * @param gradient Scalar amount to interpolate
  117588. * @returns Interpolated Size value
  117589. */
  117590. sizeInterpolateFunction(startValue: Size, endValue: Size, gradient: number): Size;
  117591. /**
  117592. * Interpolates a Color3 linearly
  117593. * @param startValue Start value of the animation curve
  117594. * @param endValue End value of the animation curve
  117595. * @param gradient Scalar amount to interpolate
  117596. * @returns Interpolated Color3 value
  117597. */
  117598. color3InterpolateFunction(startValue: Color3, endValue: Color3, gradient: number): Color3;
  117599. /**
  117600. * Interpolates a Color4 linearly
  117601. * @param startValue Start value of the animation curve
  117602. * @param endValue End value of the animation curve
  117603. * @param gradient Scalar amount to interpolate
  117604. * @returns Interpolated Color3 value
  117605. */
  117606. color4InterpolateFunction(startValue: Color4, endValue: Color4, gradient: number): Color4;
  117607. /**
  117608. * @hidden Internal use only
  117609. */
  117610. _getKeyValue(value: any): any;
  117611. /**
  117612. * @hidden Internal use only
  117613. */
  117614. _interpolate(currentFrame: number, state: _IAnimationState): any;
  117615. /**
  117616. * Defines the function to use to interpolate matrices
  117617. * @param startValue defines the start matrix
  117618. * @param endValue defines the end matrix
  117619. * @param gradient defines the gradient between both matrices
  117620. * @param result defines an optional target matrix where to store the interpolation
  117621. * @returns the interpolated matrix
  117622. */
  117623. matrixInterpolateFunction(startValue: Matrix, endValue: Matrix, gradient: number, result?: Matrix): Matrix;
  117624. /**
  117625. * Makes a copy of the animation
  117626. * @returns Cloned animation
  117627. */
  117628. clone(): Animation;
  117629. /**
  117630. * Sets the key frames of the animation
  117631. * @param values The animation key frames to set
  117632. */
  117633. setKeys(values: Array<IAnimationKey>): void;
  117634. /**
  117635. * Serializes the animation to an object
  117636. * @returns Serialized object
  117637. */
  117638. serialize(): any;
  117639. /**
  117640. * Float animation type
  117641. */
  117642. static readonly ANIMATIONTYPE_FLOAT: number;
  117643. /**
  117644. * Vector3 animation type
  117645. */
  117646. static readonly ANIMATIONTYPE_VECTOR3: number;
  117647. /**
  117648. * Quaternion animation type
  117649. */
  117650. static readonly ANIMATIONTYPE_QUATERNION: number;
  117651. /**
  117652. * Matrix animation type
  117653. */
  117654. static readonly ANIMATIONTYPE_MATRIX: number;
  117655. /**
  117656. * Color3 animation type
  117657. */
  117658. static readonly ANIMATIONTYPE_COLOR3: number;
  117659. /**
  117660. * Color3 animation type
  117661. */
  117662. static readonly ANIMATIONTYPE_COLOR4: number;
  117663. /**
  117664. * Vector2 animation type
  117665. */
  117666. static readonly ANIMATIONTYPE_VECTOR2: number;
  117667. /**
  117668. * Size animation type
  117669. */
  117670. static readonly ANIMATIONTYPE_SIZE: number;
  117671. /**
  117672. * Relative Loop Mode
  117673. */
  117674. static readonly ANIMATIONLOOPMODE_RELATIVE: number;
  117675. /**
  117676. * Cycle Loop Mode
  117677. */
  117678. static readonly ANIMATIONLOOPMODE_CYCLE: number;
  117679. /**
  117680. * Constant Loop Mode
  117681. */
  117682. static readonly ANIMATIONLOOPMODE_CONSTANT: number;
  117683. /** @hidden */
  117684. static _UniversalLerp(left: any, right: any, amount: number): any;
  117685. /**
  117686. * Parses an animation object and creates an animation
  117687. * @param parsedAnimation Parsed animation object
  117688. * @returns Animation object
  117689. */
  117690. static Parse(parsedAnimation: any): Animation;
  117691. /**
  117692. * Appends the serialized animations from the source animations
  117693. * @param source Source containing the animations
  117694. * @param destination Target to store the animations
  117695. */
  117696. static AppendSerializedAnimations(source: IAnimatable, destination: any): void;
  117697. /**
  117698. * Creates a new animation or an array of animations from a snippet saved in a remote file
  117699. * @param name defines the name of the animation to create (can be null or empty to use the one from the json data)
  117700. * @param url defines the url to load from
  117701. * @returns a promise that will resolve to the new animation or an array of animations
  117702. */
  117703. static ParseFromFileAsync(name: Nullable<string>, url: string): Promise<Animation | Array<Animation>>;
  117704. /**
  117705. * Creates an animation or an array of animations from a snippet saved by the Inspector
  117706. * @param snippetId defines the snippet to load
  117707. * @returns a promise that will resolve to the new animation or a new array of animations
  117708. */
  117709. static CreateFromSnippetAsync(snippetId: string): Promise<Animation | Array<Animation>>;
  117710. }
  117711. }
  117712. declare module BABYLON {
  117713. /**
  117714. * Interface containing an array of animations
  117715. */
  117716. export interface IAnimatable {
  117717. /**
  117718. * Array of animations
  117719. */
  117720. animations: Nullable<Array<Animation>>;
  117721. }
  117722. }
  117723. declare module BABYLON {
  117724. export function expandToProperty(callback: string, targetKey?: Nullable<string>): (target: any, propertyKey: string) => void;
  117725. export function serialize(sourceName?: string): (target: any, propertyKey: string | symbol) => void;
  117726. export function serializeAsTexture(sourceName?: string): (target: any, propertyKey: string | symbol) => void;
  117727. export function serializeAsColor3(sourceName?: string): (target: any, propertyKey: string | symbol) => void;
  117728. export function serializeAsFresnelParameters(sourceName?: string): (target: any, propertyKey: string | symbol) => void;
  117729. export function serializeAsVector2(sourceName?: string): (target: any, propertyKey: string | symbol) => void;
  117730. export function serializeAsVector3(sourceName?: string): (target: any, propertyKey: string | symbol) => void;
  117731. export function serializeAsMeshReference(sourceName?: string): (target: any, propertyKey: string | symbol) => void;
  117732. export function serializeAsColorCurves(sourceName?: string): (target: any, propertyKey: string | symbol) => void;
  117733. export function serializeAsColor4(sourceName?: string): (target: any, propertyKey: string | symbol) => void;
  117734. export function serializeAsImageProcessingConfiguration(sourceName?: string): (target: any, propertyKey: string | symbol) => void;
  117735. export function serializeAsQuaternion(sourceName?: string): (target: any, propertyKey: string | symbol) => void;
  117736. export function serializeAsMatrix(sourceName?: string): (target: any, propertyKey: string | symbol) => void;
  117737. /**
  117738. * Decorator used to define property that can be serialized as reference to a camera
  117739. * @param sourceName defines the name of the property to decorate
  117740. */
  117741. export function serializeAsCameraReference(sourceName?: string): (target: any, propertyKey: string | symbol) => void;
  117742. /**
  117743. * Class used to help serialization objects
  117744. */
  117745. export class SerializationHelper {
  117746. /** @hidden */
  117747. static _ImageProcessingConfigurationParser: (sourceProperty: any) => ImageProcessingConfiguration;
  117748. /** @hidden */
  117749. static _FresnelParametersParser: (sourceProperty: any) => FresnelParameters;
  117750. /** @hidden */
  117751. static _ColorCurvesParser: (sourceProperty: any) => ColorCurves;
  117752. /** @hidden */
  117753. static _TextureParser: (sourceProperty: any, scene: Scene, rootUrl: string) => Nullable<BaseTexture>;
  117754. /**
  117755. * Appends the serialized animations from the source animations
  117756. * @param source Source containing the animations
  117757. * @param destination Target to store the animations
  117758. */
  117759. static AppendSerializedAnimations(source: IAnimatable, destination: any): void;
  117760. /**
  117761. * Static function used to serialized a specific entity
  117762. * @param entity defines the entity to serialize
  117763. * @param serializationObject defines the optional target obecjt where serialization data will be stored
  117764. * @returns a JSON compatible object representing the serialization of the entity
  117765. */
  117766. static Serialize<T>(entity: T, serializationObject?: any): any;
  117767. /**
  117768. * Creates a new entity from a serialization data object
  117769. * @param creationFunction defines a function used to instanciated the new entity
  117770. * @param source defines the source serialization data
  117771. * @param scene defines the hosting scene
  117772. * @param rootUrl defines the root url for resources
  117773. * @returns a new entity
  117774. */
  117775. static Parse<T>(creationFunction: () => T, source: any, scene: Nullable<Scene>, rootUrl?: Nullable<string>): T;
  117776. /**
  117777. * Clones an object
  117778. * @param creationFunction defines the function used to instanciate the new object
  117779. * @param source defines the source object
  117780. * @returns the cloned object
  117781. */
  117782. static Clone<T>(creationFunction: () => T, source: T): T;
  117783. /**
  117784. * Instanciates a new object based on a source one (some data will be shared between both object)
  117785. * @param creationFunction defines the function used to instanciate the new object
  117786. * @param source defines the source object
  117787. * @returns the new object
  117788. */
  117789. static Instanciate<T>(creationFunction: () => T, source: T): T;
  117790. }
  117791. }
  117792. declare module BABYLON {
  117793. /**
  117794. * Base class of all the textures in babylon.
  117795. * It groups all the common properties the materials, post process, lights... might need
  117796. * in order to make a correct use of the texture.
  117797. */
  117798. export class BaseTexture implements IAnimatable {
  117799. /**
  117800. * Default anisotropic filtering level for the application.
  117801. * It is set to 4 as a good tradeoff between perf and quality.
  117802. */
  117803. static DEFAULT_ANISOTROPIC_FILTERING_LEVEL: number;
  117804. /**
  117805. * Gets or sets the unique id of the texture
  117806. */
  117807. uniqueId: number;
  117808. /**
  117809. * Define the name of the texture.
  117810. */
  117811. name: string;
  117812. /**
  117813. * Gets or sets an object used to store user defined information.
  117814. */
  117815. metadata: any;
  117816. /**
  117817. * For internal use only. Please do not use.
  117818. */
  117819. reservedDataStore: any;
  117820. private _hasAlpha;
  117821. /**
  117822. * Define if the texture is having a usable alpha value (can be use for transparency or glossiness for instance).
  117823. */
  117824. set hasAlpha(value: boolean);
  117825. get hasAlpha(): boolean;
  117826. /**
  117827. * Defines if the alpha value should be determined via the rgb values.
  117828. * If true the luminance of the pixel might be used to find the corresponding alpha value.
  117829. */
  117830. getAlphaFromRGB: boolean;
  117831. /**
  117832. * Intensity or strength of the texture.
  117833. * It is commonly used by materials to fine tune the intensity of the texture
  117834. */
  117835. level: number;
  117836. /**
  117837. * Define the UV chanel to use starting from 0 and defaulting to 0.
  117838. * This is part of the texture as textures usually maps to one uv set.
  117839. */
  117840. coordinatesIndex: number;
  117841. protected _coordinatesMode: number;
  117842. /**
  117843. * How a texture is mapped.
  117844. *
  117845. * | Value | Type | Description |
  117846. * | ----- | ----------------------------------- | ----------- |
  117847. * | 0 | EXPLICIT_MODE | |
  117848. * | 1 | SPHERICAL_MODE | |
  117849. * | 2 | PLANAR_MODE | |
  117850. * | 3 | CUBIC_MODE | |
  117851. * | 4 | PROJECTION_MODE | |
  117852. * | 5 | SKYBOX_MODE | |
  117853. * | 6 | INVCUBIC_MODE | |
  117854. * | 7 | EQUIRECTANGULAR_MODE | |
  117855. * | 8 | FIXED_EQUIRECTANGULAR_MODE | |
  117856. * | 9 | FIXED_EQUIRECTANGULAR_MIRRORED_MODE | |
  117857. */
  117858. set coordinatesMode(value: number);
  117859. get coordinatesMode(): number;
  117860. private _wrapU;
  117861. /**
  117862. * | Value | Type | Description |
  117863. * | ----- | ------------------ | ----------- |
  117864. * | 0 | CLAMP_ADDRESSMODE | |
  117865. * | 1 | WRAP_ADDRESSMODE | |
  117866. * | 2 | MIRROR_ADDRESSMODE | |
  117867. */
  117868. get wrapU(): number;
  117869. set wrapU(value: number);
  117870. private _wrapV;
  117871. /**
  117872. * | Value | Type | Description |
  117873. * | ----- | ------------------ | ----------- |
  117874. * | 0 | CLAMP_ADDRESSMODE | |
  117875. * | 1 | WRAP_ADDRESSMODE | |
  117876. * | 2 | MIRROR_ADDRESSMODE | |
  117877. */
  117878. get wrapV(): number;
  117879. set wrapV(value: number);
  117880. /**
  117881. * | Value | Type | Description |
  117882. * | ----- | ------------------ | ----------- |
  117883. * | 0 | CLAMP_ADDRESSMODE | |
  117884. * | 1 | WRAP_ADDRESSMODE | |
  117885. * | 2 | MIRROR_ADDRESSMODE | |
  117886. */
  117887. wrapR: number;
  117888. /**
  117889. * With compliant hardware and browser (supporting anisotropic filtering)
  117890. * this defines the level of anisotropic filtering in the texture.
  117891. * The higher the better but the slower. This defaults to 4 as it seems to be the best tradeoff.
  117892. */
  117893. anisotropicFilteringLevel: number;
  117894. /**
  117895. * Define if the texture is a cube texture or if false a 2d texture.
  117896. */
  117897. get isCube(): boolean;
  117898. set isCube(value: boolean);
  117899. /**
  117900. * Define if the texture is a 3d texture (webgl 2) or if false a 2d texture.
  117901. */
  117902. get is3D(): boolean;
  117903. set is3D(value: boolean);
  117904. /**
  117905. * Define if the texture is a 2d array texture (webgl 2) or if false a 2d texture.
  117906. */
  117907. get is2DArray(): boolean;
  117908. set is2DArray(value: boolean);
  117909. private _gammaSpace;
  117910. /**
  117911. * Define if the texture contains data in gamma space (most of the png/jpg aside bump).
  117912. * HDR texture are usually stored in linear space.
  117913. * This only impacts the PBR and Background materials
  117914. */
  117915. get gammaSpace(): boolean;
  117916. set gammaSpace(gamma: boolean);
  117917. /**
  117918. * Gets or sets whether or not the texture contains RGBD data.
  117919. */
  117920. get isRGBD(): boolean;
  117921. set isRGBD(value: boolean);
  117922. /**
  117923. * Is Z inverted in the texture (useful in a cube texture).
  117924. */
  117925. invertZ: boolean;
  117926. /**
  117927. * Are mip maps generated for this texture or not.
  117928. */
  117929. get noMipmap(): boolean;
  117930. /**
  117931. * @hidden
  117932. */
  117933. lodLevelInAlpha: boolean;
  117934. /**
  117935. * With prefiltered texture, defined the offset used during the prefiltering steps.
  117936. */
  117937. get lodGenerationOffset(): number;
  117938. set lodGenerationOffset(value: number);
  117939. /**
  117940. * With prefiltered texture, defined the scale used during the prefiltering steps.
  117941. */
  117942. get lodGenerationScale(): number;
  117943. set lodGenerationScale(value: number);
  117944. /**
  117945. * With prefiltered texture, defined if the specular generation is based on a linear ramp.
  117946. * By default we are using a log2 of the linear roughness helping to keep a better resolution for
  117947. * average roughness values.
  117948. */
  117949. get linearSpecularLOD(): boolean;
  117950. set linearSpecularLOD(value: boolean);
  117951. /**
  117952. * In case a better definition than spherical harmonics is required for the diffuse part of the environment.
  117953. * You can set the irradiance texture to rely on a texture instead of the spherical approach.
  117954. * This texture need to have the same characteristics than its parent (Cube vs 2d, coordinates mode, Gamma/Linear, RGBD).
  117955. */
  117956. get irradianceTexture(): Nullable<BaseTexture>;
  117957. set irradianceTexture(value: Nullable<BaseTexture>);
  117958. /**
  117959. * Define if the texture is a render target.
  117960. */
  117961. isRenderTarget: boolean;
  117962. /**
  117963. * Define the unique id of the texture in the scene.
  117964. */
  117965. get uid(): string;
  117966. /** @hidden */
  117967. _prefiltered: boolean;
  117968. /**
  117969. * Return a string representation of the texture.
  117970. * @returns the texture as a string
  117971. */
  117972. toString(): string;
  117973. /**
  117974. * Get the class name of the texture.
  117975. * @returns "BaseTexture"
  117976. */
  117977. getClassName(): string;
  117978. /**
  117979. * Define the list of animation attached to the texture.
  117980. */
  117981. animations: Animation[];
  117982. /**
  117983. * An event triggered when the texture is disposed.
  117984. */
  117985. onDisposeObservable: Observable<BaseTexture>;
  117986. private _onDisposeObserver;
  117987. /**
  117988. * Callback triggered when the texture has been disposed.
  117989. * Kept for back compatibility, you can use the onDisposeObservable instead.
  117990. */
  117991. set onDispose(callback: () => void);
  117992. /**
  117993. * Define the current state of the loading sequence when in delayed load mode.
  117994. */
  117995. delayLoadState: number;
  117996. protected _scene: Nullable<Scene>;
  117997. protected _engine: Nullable<ThinEngine>;
  117998. /** @hidden */
  117999. _texture: Nullable<InternalTexture>;
  118000. private _uid;
  118001. /**
  118002. * Define if the texture is preventinga material to render or not.
  118003. * If not and the texture is not ready, the engine will use a default black texture instead.
  118004. */
  118005. get isBlocking(): boolean;
  118006. /**
  118007. * Instantiates a new BaseTexture.
  118008. * Base class of all the textures in babylon.
  118009. * It groups all the common properties the materials, post process, lights... might need
  118010. * in order to make a correct use of the texture.
  118011. * @param sceneOrEngine Define the scene or engine the texture blongs to
  118012. */
  118013. constructor(sceneOrEngine: Nullable<Scene | ThinEngine>);
  118014. /**
  118015. * Get the scene the texture belongs to.
  118016. * @returns the scene or null if undefined
  118017. */
  118018. getScene(): Nullable<Scene>;
  118019. /** @hidden */
  118020. protected _getEngine(): Nullable<ThinEngine>;
  118021. /**
  118022. * Checks if the texture has the same transform matrix than another texture
  118023. * @param texture texture to check against
  118024. * @returns true if the transforms are the same, else false
  118025. */
  118026. checkTransformsAreIdentical(texture: Nullable<BaseTexture>): boolean;
  118027. /**
  118028. * Get the texture transform matrix used to offset tile the texture for istance.
  118029. * @returns the transformation matrix
  118030. */
  118031. getTextureMatrix(): Matrix;
  118032. /**
  118033. * Get the texture reflection matrix used to rotate/transform the reflection.
  118034. * @returns the reflection matrix
  118035. */
  118036. getReflectionTextureMatrix(): Matrix;
  118037. /**
  118038. * Get the underlying lower level texture from Babylon.
  118039. * @returns the insternal texture
  118040. */
  118041. getInternalTexture(): Nullable<InternalTexture>;
  118042. /**
  118043. * Get if the texture is ready to be consumed (either it is ready or it is not blocking)
  118044. * @returns true if ready or not blocking
  118045. */
  118046. isReadyOrNotBlocking(): boolean;
  118047. /**
  118048. * Get if the texture is ready to be used (downloaded, converted, mip mapped...).
  118049. * @returns true if fully ready
  118050. */
  118051. isReady(): boolean;
  118052. private _cachedSize;
  118053. /**
  118054. * Get the size of the texture.
  118055. * @returns the texture size.
  118056. */
  118057. getSize(): ISize;
  118058. /**
  118059. * Get the base size of the texture.
  118060. * It can be different from the size if the texture has been resized for POT for instance
  118061. * @returns the base size
  118062. */
  118063. getBaseSize(): ISize;
  118064. /**
  118065. * Update the sampling mode of the texture.
  118066. * Default is Trilinear mode.
  118067. *
  118068. * | Value | Type | Description |
  118069. * | ----- | ------------------ | ----------- |
  118070. * | 1 | NEAREST_SAMPLINGMODE or NEAREST_NEAREST_MIPLINEAR | Nearest is: mag = nearest, min = nearest, mip = linear |
  118071. * | 2 | BILINEAR_SAMPLINGMODE or LINEAR_LINEAR_MIPNEAREST | Bilinear is: mag = linear, min = linear, mip = nearest |
  118072. * | 3 | TRILINEAR_SAMPLINGMODE or LINEAR_LINEAR_MIPLINEAR | Trilinear is: mag = linear, min = linear, mip = linear |
  118073. * | 4 | NEAREST_NEAREST_MIPNEAREST | |
  118074. * | 5 | NEAREST_LINEAR_MIPNEAREST | |
  118075. * | 6 | NEAREST_LINEAR_MIPLINEAR | |
  118076. * | 7 | NEAREST_LINEAR | |
  118077. * | 8 | NEAREST_NEAREST | |
  118078. * | 9 | LINEAR_NEAREST_MIPNEAREST | |
  118079. * | 10 | LINEAR_NEAREST_MIPLINEAR | |
  118080. * | 11 | LINEAR_LINEAR | |
  118081. * | 12 | LINEAR_NEAREST | |
  118082. *
  118083. * > _mag_: magnification filter (close to the viewer)
  118084. * > _min_: minification filter (far from the viewer)
  118085. * > _mip_: filter used between mip map levels
  118086. *@param samplingMode Define the new sampling mode of the texture
  118087. */
  118088. updateSamplingMode(samplingMode: number): void;
  118089. /**
  118090. * Scales the texture if is `canRescale()`
  118091. * @param ratio the resize factor we want to use to rescale
  118092. */
  118093. scale(ratio: number): void;
  118094. /**
  118095. * Get if the texture can rescale.
  118096. */
  118097. get canRescale(): boolean;
  118098. /** @hidden */
  118099. _getFromCache(url: Nullable<string>, noMipmap: boolean, sampling?: number, invertY?: boolean): Nullable<InternalTexture>;
  118100. /** @hidden */
  118101. _rebuild(): void;
  118102. /**
  118103. * Triggers the load sequence in delayed load mode.
  118104. */
  118105. delayLoad(): void;
  118106. /**
  118107. * Clones the texture.
  118108. * @returns the cloned texture
  118109. */
  118110. clone(): Nullable<BaseTexture>;
  118111. /**
  118112. * Get the texture underlying type (INT, FLOAT...)
  118113. */
  118114. get textureType(): number;
  118115. /**
  118116. * Get the texture underlying format (RGB, RGBA...)
  118117. */
  118118. get textureFormat(): number;
  118119. /**
  118120. * Indicates that textures need to be re-calculated for all materials
  118121. */
  118122. protected _markAllSubMeshesAsTexturesDirty(): void;
  118123. /**
  118124. * Reads the pixels stored in the webgl texture and returns them as an ArrayBuffer.
  118125. * This will returns an RGBA array buffer containing either in values (0-255) or
  118126. * float values (0-1) depending of the underlying buffer type.
  118127. * @param faceIndex defines the face of the texture to read (in case of cube texture)
  118128. * @param level defines the LOD level of the texture to read (in case of Mip Maps)
  118129. * @param buffer defines a user defined buffer to fill with data (can be null)
  118130. * @returns The Array buffer containing the pixels data.
  118131. */
  118132. readPixels(faceIndex?: number, level?: number, buffer?: Nullable<ArrayBufferView>): Nullable<ArrayBufferView>;
  118133. /**
  118134. * Release and destroy the underlying lower level texture aka internalTexture.
  118135. */
  118136. releaseInternalTexture(): void;
  118137. /** @hidden */
  118138. get _lodTextureHigh(): Nullable<BaseTexture>;
  118139. /** @hidden */
  118140. get _lodTextureMid(): Nullable<BaseTexture>;
  118141. /** @hidden */
  118142. get _lodTextureLow(): Nullable<BaseTexture>;
  118143. /**
  118144. * Dispose the texture and release its associated resources.
  118145. */
  118146. dispose(): void;
  118147. /**
  118148. * Serialize the texture into a JSON representation that can be parsed later on.
  118149. * @returns the JSON representation of the texture
  118150. */
  118151. serialize(): any;
  118152. /**
  118153. * Helper function to be called back once a list of texture contains only ready textures.
  118154. * @param textures Define the list of textures to wait for
  118155. * @param callback Define the callback triggered once the entire list will be ready
  118156. */
  118157. static WhenAllReady(textures: BaseTexture[], callback: () => void): void;
  118158. private static _isScene;
  118159. }
  118160. }
  118161. declare module BABYLON {
  118162. /**
  118163. * Options to be used when creating an effect.
  118164. */
  118165. export interface IEffectCreationOptions {
  118166. /**
  118167. * Atrributes that will be used in the shader.
  118168. */
  118169. attributes: string[];
  118170. /**
  118171. * Uniform varible names that will be set in the shader.
  118172. */
  118173. uniformsNames: string[];
  118174. /**
  118175. * Uniform buffer variable names that will be set in the shader.
  118176. */
  118177. uniformBuffersNames: string[];
  118178. /**
  118179. * Sampler texture variable names that will be set in the shader.
  118180. */
  118181. samplers: string[];
  118182. /**
  118183. * Define statements that will be set in the shader.
  118184. */
  118185. defines: any;
  118186. /**
  118187. * Possible fallbacks for this effect to improve performance when needed.
  118188. */
  118189. fallbacks: Nullable<IEffectFallbacks>;
  118190. /**
  118191. * Callback that will be called when the shader is compiled.
  118192. */
  118193. onCompiled: Nullable<(effect: Effect) => void>;
  118194. /**
  118195. * Callback that will be called if an error occurs during shader compilation.
  118196. */
  118197. onError: Nullable<(effect: Effect, errors: string) => void>;
  118198. /**
  118199. * Parameters to be used with Babylons include syntax to iterate over an array (eg. {lights: 10})
  118200. */
  118201. indexParameters?: any;
  118202. /**
  118203. * Max number of lights that can be used in the shader.
  118204. */
  118205. maxSimultaneousLights?: number;
  118206. /**
  118207. * See https://developer.mozilla.org/en-US/docs/Web/API/WebGL2RenderingContext/transformFeedbackVaryings
  118208. */
  118209. transformFeedbackVaryings?: Nullable<string[]>;
  118210. /**
  118211. * 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
  118212. */
  118213. processFinalCode?: Nullable<(shaderType: string, code: string) => string>;
  118214. /**
  118215. * Is this effect rendering to several color attachments ?
  118216. */
  118217. multiTarget?: boolean;
  118218. }
  118219. /**
  118220. * Effect containing vertex and fragment shader that can be executed on an object.
  118221. */
  118222. export class Effect implements IDisposable {
  118223. /**
  118224. * Gets or sets the relative url used to load shaders if using the engine in non-minified mode
  118225. */
  118226. static ShadersRepository: string;
  118227. /**
  118228. * Enable logging of the shader code when a compilation error occurs
  118229. */
  118230. static LogShaderCodeOnCompilationError: boolean;
  118231. /**
  118232. * Name of the effect.
  118233. */
  118234. name: any;
  118235. /**
  118236. * String container all the define statements that should be set on the shader.
  118237. */
  118238. defines: string;
  118239. /**
  118240. * Callback that will be called when the shader is compiled.
  118241. */
  118242. onCompiled: Nullable<(effect: Effect) => void>;
  118243. /**
  118244. * Callback that will be called if an error occurs during shader compilation.
  118245. */
  118246. onError: Nullable<(effect: Effect, errors: string) => void>;
  118247. /**
  118248. * Callback that will be called when effect is bound.
  118249. */
  118250. onBind: Nullable<(effect: Effect) => void>;
  118251. /**
  118252. * Unique ID of the effect.
  118253. */
  118254. uniqueId: number;
  118255. /**
  118256. * Observable that will be called when the shader is compiled.
  118257. * It is recommended to use executeWhenCompile() or to make sure that scene.isReady() is called to get this observable raised.
  118258. */
  118259. onCompileObservable: Observable<Effect>;
  118260. /**
  118261. * Observable that will be called if an error occurs during shader compilation.
  118262. */
  118263. onErrorObservable: Observable<Effect>;
  118264. /** @hidden */
  118265. _onBindObservable: Nullable<Observable<Effect>>;
  118266. /**
  118267. * @hidden
  118268. * Specifies if the effect was previously ready
  118269. */
  118270. _wasPreviouslyReady: boolean;
  118271. /**
  118272. * Observable that will be called when effect is bound.
  118273. */
  118274. get onBindObservable(): Observable<Effect>;
  118275. /** @hidden */
  118276. _bonesComputationForcedToCPU: boolean;
  118277. /** @hidden */
  118278. _multiTarget: boolean;
  118279. private static _uniqueIdSeed;
  118280. private _engine;
  118281. private _uniformBuffersNames;
  118282. private _uniformBuffersNamesList;
  118283. private _uniformsNames;
  118284. private _samplerList;
  118285. private _samplers;
  118286. private _isReady;
  118287. private _compilationError;
  118288. private _allFallbacksProcessed;
  118289. private _attributesNames;
  118290. private _attributes;
  118291. private _attributeLocationByName;
  118292. private _uniforms;
  118293. /**
  118294. * Key for the effect.
  118295. * @hidden
  118296. */
  118297. _key: string;
  118298. private _indexParameters;
  118299. private _fallbacks;
  118300. private _vertexSourceCode;
  118301. private _fragmentSourceCode;
  118302. private _vertexSourceCodeOverride;
  118303. private _fragmentSourceCodeOverride;
  118304. private _transformFeedbackVaryings;
  118305. /**
  118306. * Compiled shader to webGL program.
  118307. * @hidden
  118308. */
  118309. _pipelineContext: Nullable<IPipelineContext>;
  118310. private _valueCache;
  118311. private static _baseCache;
  118312. /**
  118313. * Instantiates an effect.
  118314. * An effect can be used to create/manage/execute vertex and fragment shaders.
  118315. * @param baseName Name of the effect.
  118316. * @param attributesNamesOrOptions List of attribute names that will be passed to the shader or set of all options to create the effect.
  118317. * @param uniformsNamesOrEngine List of uniform variable names that will be passed to the shader or the engine that will be used to render effect.
  118318. * @param samplers List of sampler variables that will be passed to the shader.
  118319. * @param engine Engine to be used to render the effect
  118320. * @param defines Define statements to be added to the shader.
  118321. * @param fallbacks Possible fallbacks for this effect to improve performance when needed.
  118322. * @param onCompiled Callback that will be called when the shader is compiled.
  118323. * @param onError Callback that will be called if an error occurs during shader compilation.
  118324. * @param indexParameters Parameters to be used with Babylons include syntax to iterate over an array (eg. {lights: 10})
  118325. */
  118326. 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);
  118327. private _useFinalCode;
  118328. /**
  118329. * Unique key for this effect
  118330. */
  118331. get key(): string;
  118332. /**
  118333. * If the effect has been compiled and prepared.
  118334. * @returns if the effect is compiled and prepared.
  118335. */
  118336. isReady(): boolean;
  118337. private _isReadyInternal;
  118338. /**
  118339. * The engine the effect was initialized with.
  118340. * @returns the engine.
  118341. */
  118342. getEngine(): Engine;
  118343. /**
  118344. * The pipeline context for this effect
  118345. * @returns the associated pipeline context
  118346. */
  118347. getPipelineContext(): Nullable<IPipelineContext>;
  118348. /**
  118349. * The set of names of attribute variables for the shader.
  118350. * @returns An array of attribute names.
  118351. */
  118352. getAttributesNames(): string[];
  118353. /**
  118354. * Returns the attribute at the given index.
  118355. * @param index The index of the attribute.
  118356. * @returns The location of the attribute.
  118357. */
  118358. getAttributeLocation(index: number): number;
  118359. /**
  118360. * Returns the attribute based on the name of the variable.
  118361. * @param name of the attribute to look up.
  118362. * @returns the attribute location.
  118363. */
  118364. getAttributeLocationByName(name: string): number;
  118365. /**
  118366. * The number of attributes.
  118367. * @returns the numnber of attributes.
  118368. */
  118369. getAttributesCount(): number;
  118370. /**
  118371. * Gets the index of a uniform variable.
  118372. * @param uniformName of the uniform to look up.
  118373. * @returns the index.
  118374. */
  118375. getUniformIndex(uniformName: string): number;
  118376. /**
  118377. * Returns the attribute based on the name of the variable.
  118378. * @param uniformName of the uniform to look up.
  118379. * @returns the location of the uniform.
  118380. */
  118381. getUniform(uniformName: string): Nullable<WebGLUniformLocation>;
  118382. /**
  118383. * Returns an array of sampler variable names
  118384. * @returns The array of sampler variable names.
  118385. */
  118386. getSamplers(): string[];
  118387. /**
  118388. * Returns an array of uniform variable names
  118389. * @returns The array of uniform variable names.
  118390. */
  118391. getUniformNames(): string[];
  118392. /**
  118393. * Returns an array of uniform buffer variable names
  118394. * @returns The array of uniform buffer variable names.
  118395. */
  118396. getUniformBuffersNames(): string[];
  118397. /**
  118398. * Returns the index parameters used to create the effect
  118399. * @returns The index parameters object
  118400. */
  118401. getIndexParameters(): any;
  118402. /**
  118403. * The error from the last compilation.
  118404. * @returns the error string.
  118405. */
  118406. getCompilationError(): string;
  118407. /**
  118408. * Gets a boolean indicating that all fallbacks were used during compilation
  118409. * @returns true if all fallbacks were used
  118410. */
  118411. allFallbacksProcessed(): boolean;
  118412. /**
  118413. * Adds a callback to the onCompiled observable and call the callback imediatly if already ready.
  118414. * @param func The callback to be used.
  118415. */
  118416. executeWhenCompiled(func: (effect: Effect) => void): void;
  118417. private _checkIsReady;
  118418. private _loadShader;
  118419. /**
  118420. * Gets the vertex shader source code of this effect
  118421. */
  118422. get vertexSourceCode(): string;
  118423. /**
  118424. * Gets the fragment shader source code of this effect
  118425. */
  118426. get fragmentSourceCode(): string;
  118427. /**
  118428. * Recompiles the webGL program
  118429. * @param vertexSourceCode The source code for the vertex shader.
  118430. * @param fragmentSourceCode The source code for the fragment shader.
  118431. * @param onCompiled Callback called when completed.
  118432. * @param onError Callback called on error.
  118433. * @hidden
  118434. */
  118435. _rebuildProgram(vertexSourceCode: string, fragmentSourceCode: string, onCompiled: (pipelineContext: IPipelineContext) => void, onError: (message: string) => void): void;
  118436. /**
  118437. * Prepares the effect
  118438. * @hidden
  118439. */
  118440. _prepareEffect(): void;
  118441. private _getShaderCodeAndErrorLine;
  118442. private _processCompilationErrors;
  118443. /**
  118444. * Checks if the effect is supported. (Must be called after compilation)
  118445. */
  118446. get isSupported(): boolean;
  118447. /**
  118448. * Binds a texture to the engine to be used as output of the shader.
  118449. * @param channel Name of the output variable.
  118450. * @param texture Texture to bind.
  118451. * @hidden
  118452. */
  118453. _bindTexture(channel: string, texture: Nullable<InternalTexture>): void;
  118454. /**
  118455. * Sets a texture on the engine to be used in the shader.
  118456. * @param channel Name of the sampler variable.
  118457. * @param texture Texture to set.
  118458. */
  118459. setTexture(channel: string, texture: Nullable<BaseTexture>): void;
  118460. /**
  118461. * Sets a depth stencil texture from a render target on the engine to be used in the shader.
  118462. * @param channel Name of the sampler variable.
  118463. * @param texture Texture to set.
  118464. */
  118465. setDepthStencilTexture(channel: string, texture: Nullable<RenderTargetTexture>): void;
  118466. /**
  118467. * Sets an array of textures on the engine to be used in the shader.
  118468. * @param channel Name of the variable.
  118469. * @param textures Textures to set.
  118470. */
  118471. setTextureArray(channel: string, textures: BaseTexture[]): void;
  118472. /**
  118473. * 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)
  118474. * @param channel Name of the sampler variable.
  118475. * @param postProcess Post process to get the input texture from.
  118476. */
  118477. setTextureFromPostProcess(channel: string, postProcess: Nullable<PostProcess>): void;
  118478. /**
  118479. * (Warning! setTextureFromPostProcessOutput may be desired instead)
  118480. * 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)
  118481. * @param channel Name of the sampler variable.
  118482. * @param postProcess Post process to get the output texture from.
  118483. */
  118484. setTextureFromPostProcessOutput(channel: string, postProcess: Nullable<PostProcess>): void;
  118485. /** @hidden */
  118486. _cacheMatrix(uniformName: string, matrix: IMatrixLike): boolean;
  118487. /** @hidden */
  118488. _cacheFloat2(uniformName: string, x: number, y: number): boolean;
  118489. /** @hidden */
  118490. _cacheFloat3(uniformName: string, x: number, y: number, z: number): boolean;
  118491. /** @hidden */
  118492. _cacheFloat4(uniformName: string, x: number, y: number, z: number, w: number): boolean;
  118493. /**
  118494. * Binds a buffer to a uniform.
  118495. * @param buffer Buffer to bind.
  118496. * @param name Name of the uniform variable to bind to.
  118497. */
  118498. bindUniformBuffer(buffer: DataBuffer, name: string): void;
  118499. /**
  118500. * Binds block to a uniform.
  118501. * @param blockName Name of the block to bind.
  118502. * @param index Index to bind.
  118503. */
  118504. bindUniformBlock(blockName: string, index: number): void;
  118505. /**
  118506. * Sets an interger value on a uniform variable.
  118507. * @param uniformName Name of the variable.
  118508. * @param value Value to be set.
  118509. * @returns this effect.
  118510. */
  118511. setInt(uniformName: string, value: number): Effect;
  118512. /**
  118513. * Sets an int array on a uniform variable.
  118514. * @param uniformName Name of the variable.
  118515. * @param array array to be set.
  118516. * @returns this effect.
  118517. */
  118518. setIntArray(uniformName: string, array: Int32Array): Effect;
  118519. /**
  118520. * 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)
  118521. * @param uniformName Name of the variable.
  118522. * @param array array to be set.
  118523. * @returns this effect.
  118524. */
  118525. setIntArray2(uniformName: string, array: Int32Array): Effect;
  118526. /**
  118527. * 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)
  118528. * @param uniformName Name of the variable.
  118529. * @param array array to be set.
  118530. * @returns this effect.
  118531. */
  118532. setIntArray3(uniformName: string, array: Int32Array): Effect;
  118533. /**
  118534. * 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)
  118535. * @param uniformName Name of the variable.
  118536. * @param array array to be set.
  118537. * @returns this effect.
  118538. */
  118539. setIntArray4(uniformName: string, array: Int32Array): Effect;
  118540. /**
  118541. * Sets an float array on a uniform variable.
  118542. * @param uniformName Name of the variable.
  118543. * @param array array to be set.
  118544. * @returns this effect.
  118545. */
  118546. setFloatArray(uniformName: string, array: Float32Array): Effect;
  118547. /**
  118548. * 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)
  118549. * @param uniformName Name of the variable.
  118550. * @param array array to be set.
  118551. * @returns this effect.
  118552. */
  118553. setFloatArray2(uniformName: string, array: Float32Array): Effect;
  118554. /**
  118555. * 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)
  118556. * @param uniformName Name of the variable.
  118557. * @param array array to be set.
  118558. * @returns this effect.
  118559. */
  118560. setFloatArray3(uniformName: string, array: Float32Array): Effect;
  118561. /**
  118562. * 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)
  118563. * @param uniformName Name of the variable.
  118564. * @param array array to be set.
  118565. * @returns this effect.
  118566. */
  118567. setFloatArray4(uniformName: string, array: Float32Array): Effect;
  118568. /**
  118569. * Sets an array on a uniform variable.
  118570. * @param uniformName Name of the variable.
  118571. * @param array array to be set.
  118572. * @returns this effect.
  118573. */
  118574. setArray(uniformName: string, array: number[]): Effect;
  118575. /**
  118576. * 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)
  118577. * @param uniformName Name of the variable.
  118578. * @param array array to be set.
  118579. * @returns this effect.
  118580. */
  118581. setArray2(uniformName: string, array: number[]): Effect;
  118582. /**
  118583. * 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)
  118584. * @param uniformName Name of the variable.
  118585. * @param array array to be set.
  118586. * @returns this effect.
  118587. */
  118588. setArray3(uniformName: string, array: number[]): Effect;
  118589. /**
  118590. * 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)
  118591. * @param uniformName Name of the variable.
  118592. * @param array array to be set.
  118593. * @returns this effect.
  118594. */
  118595. setArray4(uniformName: string, array: number[]): Effect;
  118596. /**
  118597. * Sets matrices on a uniform variable.
  118598. * @param uniformName Name of the variable.
  118599. * @param matrices matrices to be set.
  118600. * @returns this effect.
  118601. */
  118602. setMatrices(uniformName: string, matrices: Float32Array | Array<number>): Effect;
  118603. /**
  118604. * Sets matrix on a uniform variable.
  118605. * @param uniformName Name of the variable.
  118606. * @param matrix matrix to be set.
  118607. * @returns this effect.
  118608. */
  118609. setMatrix(uniformName: string, matrix: IMatrixLike): Effect;
  118610. /**
  118611. * 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)
  118612. * @param uniformName Name of the variable.
  118613. * @param matrix matrix to be set.
  118614. * @returns this effect.
  118615. */
  118616. setMatrix3x3(uniformName: string, matrix: Float32Array | Array<number>): Effect;
  118617. /**
  118618. * Sets a 2x2 matrix on a uniform variable. (Speicified as [1,2,3,4] will result in [1,2][3,4] matrix)
  118619. * @param uniformName Name of the variable.
  118620. * @param matrix matrix to be set.
  118621. * @returns this effect.
  118622. */
  118623. setMatrix2x2(uniformName: string, matrix: Float32Array | Array<number>): Effect;
  118624. /**
  118625. * Sets a float on a uniform variable.
  118626. * @param uniformName Name of the variable.
  118627. * @param value value to be set.
  118628. * @returns this effect.
  118629. */
  118630. setFloat(uniformName: string, value: number): Effect;
  118631. /**
  118632. * Sets a boolean on a uniform variable.
  118633. * @param uniformName Name of the variable.
  118634. * @param bool value to be set.
  118635. * @returns this effect.
  118636. */
  118637. setBool(uniformName: string, bool: boolean): Effect;
  118638. /**
  118639. * Sets a Vector2 on a uniform variable.
  118640. * @param uniformName Name of the variable.
  118641. * @param vector2 vector2 to be set.
  118642. * @returns this effect.
  118643. */
  118644. setVector2(uniformName: string, vector2: IVector2Like): Effect;
  118645. /**
  118646. * Sets a float2 on a uniform variable.
  118647. * @param uniformName Name of the variable.
  118648. * @param x First float in float2.
  118649. * @param y Second float in float2.
  118650. * @returns this effect.
  118651. */
  118652. setFloat2(uniformName: string, x: number, y: number): Effect;
  118653. /**
  118654. * Sets a Vector3 on a uniform variable.
  118655. * @param uniformName Name of the variable.
  118656. * @param vector3 Value to be set.
  118657. * @returns this effect.
  118658. */
  118659. setVector3(uniformName: string, vector3: IVector3Like): Effect;
  118660. /**
  118661. * Sets a float3 on a uniform variable.
  118662. * @param uniformName Name of the variable.
  118663. * @param x First float in float3.
  118664. * @param y Second float in float3.
  118665. * @param z Third float in float3.
  118666. * @returns this effect.
  118667. */
  118668. setFloat3(uniformName: string, x: number, y: number, z: number): Effect;
  118669. /**
  118670. * Sets a Vector4 on a uniform variable.
  118671. * @param uniformName Name of the variable.
  118672. * @param vector4 Value to be set.
  118673. * @returns this effect.
  118674. */
  118675. setVector4(uniformName: string, vector4: IVector4Like): Effect;
  118676. /**
  118677. * Sets a float4 on a uniform variable.
  118678. * @param uniformName Name of the variable.
  118679. * @param x First float in float4.
  118680. * @param y Second float in float4.
  118681. * @param z Third float in float4.
  118682. * @param w Fourth float in float4.
  118683. * @returns this effect.
  118684. */
  118685. setFloat4(uniformName: string, x: number, y: number, z: number, w: number): Effect;
  118686. /**
  118687. * Sets a Color3 on a uniform variable.
  118688. * @param uniformName Name of the variable.
  118689. * @param color3 Value to be set.
  118690. * @returns this effect.
  118691. */
  118692. setColor3(uniformName: string, color3: IColor3Like): Effect;
  118693. /**
  118694. * Sets a Color4 on a uniform variable.
  118695. * @param uniformName Name of the variable.
  118696. * @param color3 Value to be set.
  118697. * @param alpha Alpha value to be set.
  118698. * @returns this effect.
  118699. */
  118700. setColor4(uniformName: string, color3: IColor3Like, alpha: number): Effect;
  118701. /**
  118702. * Sets a Color4 on a uniform variable
  118703. * @param uniformName defines the name of the variable
  118704. * @param color4 defines the value to be set
  118705. * @returns this effect.
  118706. */
  118707. setDirectColor4(uniformName: string, color4: IColor4Like): Effect;
  118708. /** Release all associated resources */
  118709. dispose(): void;
  118710. /**
  118711. * This function will add a new shader to the shader store
  118712. * @param name the name of the shader
  118713. * @param pixelShader optional pixel shader content
  118714. * @param vertexShader optional vertex shader content
  118715. */
  118716. static RegisterShader(name: string, pixelShader?: string, vertexShader?: string): void;
  118717. /**
  118718. * Store of each shader (The can be looked up using effect.key)
  118719. */
  118720. static ShadersStore: {
  118721. [key: string]: string;
  118722. };
  118723. /**
  118724. * Store of each included file for a shader (The can be looked up using effect.key)
  118725. */
  118726. static IncludesShadersStore: {
  118727. [key: string]: string;
  118728. };
  118729. /**
  118730. * Resets the cache of effects.
  118731. */
  118732. static ResetCache(): void;
  118733. }
  118734. }
  118735. declare module BABYLON {
  118736. /**
  118737. * Interface used to describe the capabilities of the engine relatively to the current browser
  118738. */
  118739. export interface EngineCapabilities {
  118740. /** Maximum textures units per fragment shader */
  118741. maxTexturesImageUnits: number;
  118742. /** Maximum texture units per vertex shader */
  118743. maxVertexTextureImageUnits: number;
  118744. /** Maximum textures units in the entire pipeline */
  118745. maxCombinedTexturesImageUnits: number;
  118746. /** Maximum texture size */
  118747. maxTextureSize: number;
  118748. /** Maximum texture samples */
  118749. maxSamples?: number;
  118750. /** Maximum cube texture size */
  118751. maxCubemapTextureSize: number;
  118752. /** Maximum render texture size */
  118753. maxRenderTextureSize: number;
  118754. /** Maximum number of vertex attributes */
  118755. maxVertexAttribs: number;
  118756. /** Maximum number of varyings */
  118757. maxVaryingVectors: number;
  118758. /** Maximum number of uniforms per vertex shader */
  118759. maxVertexUniformVectors: number;
  118760. /** Maximum number of uniforms per fragment shader */
  118761. maxFragmentUniformVectors: number;
  118762. /** Defines if standard derivates (dx/dy) are supported */
  118763. standardDerivatives: boolean;
  118764. /** Defines if s3tc texture compression is supported */
  118765. s3tc?: WEBGL_compressed_texture_s3tc;
  118766. /** Defines if pvrtc texture compression is supported */
  118767. pvrtc: any;
  118768. /** Defines if etc1 texture compression is supported */
  118769. etc1: any;
  118770. /** Defines if etc2 texture compression is supported */
  118771. etc2: any;
  118772. /** Defines if astc texture compression is supported */
  118773. astc: any;
  118774. /** Defines if bptc texture compression is supported */
  118775. bptc: any;
  118776. /** Defines if float textures are supported */
  118777. textureFloat: boolean;
  118778. /** Defines if vertex array objects are supported */
  118779. vertexArrayObject: boolean;
  118780. /** Gets the webgl extension for anisotropic filtering (null if not supported) */
  118781. textureAnisotropicFilterExtension?: EXT_texture_filter_anisotropic;
  118782. /** Gets the maximum level of anisotropy supported */
  118783. maxAnisotropy: number;
  118784. /** Defines if instancing is supported */
  118785. instancedArrays: boolean;
  118786. /** Defines if 32 bits indices are supported */
  118787. uintIndices: boolean;
  118788. /** Defines if high precision shaders are supported */
  118789. highPrecisionShaderSupported: boolean;
  118790. /** Defines if depth reading in the fragment shader is supported */
  118791. fragmentDepthSupported: boolean;
  118792. /** Defines if float texture linear filtering is supported*/
  118793. textureFloatLinearFiltering: boolean;
  118794. /** Defines if rendering to float textures is supported */
  118795. textureFloatRender: boolean;
  118796. /** Defines if half float textures are supported*/
  118797. textureHalfFloat: boolean;
  118798. /** Defines if half float texture linear filtering is supported*/
  118799. textureHalfFloatLinearFiltering: boolean;
  118800. /** Defines if rendering to half float textures is supported */
  118801. textureHalfFloatRender: boolean;
  118802. /** Defines if textureLOD shader command is supported */
  118803. textureLOD: boolean;
  118804. /** Defines if draw buffers extension is supported */
  118805. drawBuffersExtension: boolean;
  118806. /** Defines if depth textures are supported */
  118807. depthTextureExtension: boolean;
  118808. /** Defines if float color buffer are supported */
  118809. colorBufferFloat: boolean;
  118810. /** Gets disjoint timer query extension (null if not supported) */
  118811. timerQuery?: EXT_disjoint_timer_query;
  118812. /** Defines if timestamp can be used with timer query */
  118813. canUseTimestampForTimerQuery: boolean;
  118814. /** Defines if multiview is supported (https://www.khronos.org/registry/webgl/extensions/WEBGL_multiview/) */
  118815. multiview?: any;
  118816. /** Defines if oculus multiview is supported (https://developer.oculus.com/documentation/oculus-browser/latest/concepts/browser-multiview/) */
  118817. oculusMultiview?: any;
  118818. /** Function used to let the system compiles shaders in background */
  118819. parallelShaderCompile?: {
  118820. COMPLETION_STATUS_KHR: number;
  118821. };
  118822. /** Max number of texture samples for MSAA */
  118823. maxMSAASamples: number;
  118824. /** Defines if the blend min max extension is supported */
  118825. blendMinMax: boolean;
  118826. }
  118827. }
  118828. declare module BABYLON {
  118829. /**
  118830. * @hidden
  118831. **/
  118832. export class DepthCullingState {
  118833. private _isDepthTestDirty;
  118834. private _isDepthMaskDirty;
  118835. private _isDepthFuncDirty;
  118836. private _isCullFaceDirty;
  118837. private _isCullDirty;
  118838. private _isZOffsetDirty;
  118839. private _isFrontFaceDirty;
  118840. private _depthTest;
  118841. private _depthMask;
  118842. private _depthFunc;
  118843. private _cull;
  118844. private _cullFace;
  118845. private _zOffset;
  118846. private _frontFace;
  118847. /**
  118848. * Initializes the state.
  118849. */
  118850. constructor();
  118851. get isDirty(): boolean;
  118852. get zOffset(): number;
  118853. set zOffset(value: number);
  118854. get cullFace(): Nullable<number>;
  118855. set cullFace(value: Nullable<number>);
  118856. get cull(): Nullable<boolean>;
  118857. set cull(value: Nullable<boolean>);
  118858. get depthFunc(): Nullable<number>;
  118859. set depthFunc(value: Nullable<number>);
  118860. get depthMask(): boolean;
  118861. set depthMask(value: boolean);
  118862. get depthTest(): boolean;
  118863. set depthTest(value: boolean);
  118864. get frontFace(): Nullable<number>;
  118865. set frontFace(value: Nullable<number>);
  118866. reset(): void;
  118867. apply(gl: WebGLRenderingContext): void;
  118868. }
  118869. }
  118870. declare module BABYLON {
  118871. /**
  118872. * @hidden
  118873. **/
  118874. export class StencilState {
  118875. /** 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 */
  118876. static readonly ALWAYS: number;
  118877. /** Passed to stencilOperation to specify that stencil value must be kept */
  118878. static readonly KEEP: number;
  118879. /** Passed to stencilOperation to specify that stencil value must be replaced */
  118880. static readonly REPLACE: number;
  118881. private _isStencilTestDirty;
  118882. private _isStencilMaskDirty;
  118883. private _isStencilFuncDirty;
  118884. private _isStencilOpDirty;
  118885. private _stencilTest;
  118886. private _stencilMask;
  118887. private _stencilFunc;
  118888. private _stencilFuncRef;
  118889. private _stencilFuncMask;
  118890. private _stencilOpStencilFail;
  118891. private _stencilOpDepthFail;
  118892. private _stencilOpStencilDepthPass;
  118893. get isDirty(): boolean;
  118894. get stencilFunc(): number;
  118895. set stencilFunc(value: number);
  118896. get stencilFuncRef(): number;
  118897. set stencilFuncRef(value: number);
  118898. get stencilFuncMask(): number;
  118899. set stencilFuncMask(value: number);
  118900. get stencilOpStencilFail(): number;
  118901. set stencilOpStencilFail(value: number);
  118902. get stencilOpDepthFail(): number;
  118903. set stencilOpDepthFail(value: number);
  118904. get stencilOpStencilDepthPass(): number;
  118905. set stencilOpStencilDepthPass(value: number);
  118906. get stencilMask(): number;
  118907. set stencilMask(value: number);
  118908. get stencilTest(): boolean;
  118909. set stencilTest(value: boolean);
  118910. constructor();
  118911. reset(): void;
  118912. apply(gl: WebGLRenderingContext): void;
  118913. }
  118914. }
  118915. declare module BABYLON {
  118916. /**
  118917. * @hidden
  118918. **/
  118919. export class AlphaState {
  118920. private _isAlphaBlendDirty;
  118921. private _isBlendFunctionParametersDirty;
  118922. private _isBlendEquationParametersDirty;
  118923. private _isBlendConstantsDirty;
  118924. private _alphaBlend;
  118925. private _blendFunctionParameters;
  118926. private _blendEquationParameters;
  118927. private _blendConstants;
  118928. /**
  118929. * Initializes the state.
  118930. */
  118931. constructor();
  118932. get isDirty(): boolean;
  118933. get alphaBlend(): boolean;
  118934. set alphaBlend(value: boolean);
  118935. setAlphaBlendConstants(r: number, g: number, b: number, a: number): void;
  118936. setAlphaBlendFunctionParameters(value0: number, value1: number, value2: number, value3: number): void;
  118937. setAlphaEquationParameters(rgb: number, alpha: number): void;
  118938. reset(): void;
  118939. apply(gl: WebGLRenderingContext): void;
  118940. }
  118941. }
  118942. declare module BABYLON {
  118943. /** @hidden */
  118944. export class WebGL2ShaderProcessor implements IShaderProcessor {
  118945. attributeProcessor(attribute: string): string;
  118946. varyingProcessor(varying: string, isFragment: boolean): string;
  118947. postProcessor(code: string, defines: string[], isFragment: boolean): string;
  118948. }
  118949. }
  118950. declare module BABYLON {
  118951. /**
  118952. * Interface for attribute information associated with buffer instanciation
  118953. */
  118954. export interface InstancingAttributeInfo {
  118955. /**
  118956. * Name of the GLSL attribute
  118957. * if attribute index is not specified, this is used to retrieve the index from the effect
  118958. */
  118959. attributeName: string;
  118960. /**
  118961. * Index/offset of the attribute in the vertex shader
  118962. * if not specified, this will be computes from the name.
  118963. */
  118964. index?: number;
  118965. /**
  118966. * size of the attribute, 1, 2, 3 or 4
  118967. */
  118968. attributeSize: number;
  118969. /**
  118970. * Offset of the data in the Vertex Buffer acting as the instancing buffer
  118971. */
  118972. offset: number;
  118973. /**
  118974. * Modifies the rate at which generic vertex attributes advance when rendering multiple instances
  118975. * default to 1
  118976. */
  118977. divisor?: number;
  118978. /**
  118979. * type of the attribute, gl.BYTE, gl.UNSIGNED_BYTE, gl.SHORT, gl.UNSIGNED_SHORT, gl.FIXED, gl.FLOAT.
  118980. * default is FLOAT
  118981. */
  118982. attributeType?: number;
  118983. /**
  118984. * normalization of fixed-point data. behavior unclear, use FALSE, default is FALSE
  118985. */
  118986. normalized?: boolean;
  118987. }
  118988. }
  118989. declare module BABYLON {
  118990. interface ThinEngine {
  118991. /**
  118992. * Update a video texture
  118993. * @param texture defines the texture to update
  118994. * @param video defines the video element to use
  118995. * @param invertY defines if data must be stored with Y axis inverted
  118996. */
  118997. updateVideoTexture(texture: Nullable<InternalTexture>, video: HTMLVideoElement, invertY: boolean): void;
  118998. }
  118999. }
  119000. declare module BABYLON {
  119001. interface ThinEngine {
  119002. /**
  119003. * Creates a dynamic texture
  119004. * @param width defines the width of the texture
  119005. * @param height defines the height of the texture
  119006. * @param generateMipMaps defines if the engine should generate the mip levels
  119007. * @param samplingMode defines the required sampling mode (Texture.NEAREST_SAMPLINGMODE by default)
  119008. * @returns the dynamic texture inside an InternalTexture
  119009. */
  119010. createDynamicTexture(width: number, height: number, generateMipMaps: boolean, samplingMode: number): InternalTexture;
  119011. /**
  119012. * Update the content of a dynamic texture
  119013. * @param texture defines the texture to update
  119014. * @param canvas defines the canvas containing the source
  119015. * @param invertY defines if data must be stored with Y axis inverted
  119016. * @param premulAlpha defines if alpha is stored as premultiplied
  119017. * @param format defines the format of the data
  119018. * @param forceBindTexture if the texture should be forced to be bound eg. after a graphics context loss (Default: false)
  119019. */
  119020. updateDynamicTexture(texture: Nullable<InternalTexture>, canvas: HTMLCanvasElement | OffscreenCanvas, invertY: boolean, premulAlpha?: boolean, format?: number, forceBindTexture?: boolean): void;
  119021. }
  119022. }
  119023. declare module BABYLON {
  119024. /**
  119025. * Settings for finer control over video usage
  119026. */
  119027. export interface VideoTextureSettings {
  119028. /**
  119029. * Applies `autoplay` to video, if specified
  119030. */
  119031. autoPlay?: boolean;
  119032. /**
  119033. * Applies `muted` to video, if specified
  119034. */
  119035. muted?: boolean;
  119036. /**
  119037. * Applies `loop` to video, if specified
  119038. */
  119039. loop?: boolean;
  119040. /**
  119041. * Automatically updates internal texture from video at every frame in the render loop
  119042. */
  119043. autoUpdateTexture: boolean;
  119044. /**
  119045. * Image src displayed during the video loading or until the user interacts with the video.
  119046. */
  119047. poster?: string;
  119048. }
  119049. /**
  119050. * If you want to display a video in your scene, this is the special texture for that.
  119051. * This special texture works similar to other textures, with the exception of a few parameters.
  119052. * @see https://doc.babylonjs.com/how_to/video_texture
  119053. */
  119054. export class VideoTexture extends Texture {
  119055. /**
  119056. * Tells whether textures will be updated automatically or user is required to call `updateTexture` manually
  119057. */
  119058. readonly autoUpdateTexture: boolean;
  119059. /**
  119060. * The video instance used by the texture internally
  119061. */
  119062. readonly video: HTMLVideoElement;
  119063. private _onUserActionRequestedObservable;
  119064. /**
  119065. * Event triggerd when a dom action is required by the user to play the video.
  119066. * This happens due to recent changes in browser policies preventing video to auto start.
  119067. */
  119068. get onUserActionRequestedObservable(): Observable<Texture>;
  119069. private _generateMipMaps;
  119070. private _stillImageCaptured;
  119071. private _displayingPosterTexture;
  119072. private _settings;
  119073. private _createInternalTextureOnEvent;
  119074. private _frameId;
  119075. private _currentSrc;
  119076. /**
  119077. * Creates a video texture.
  119078. * If you want to display a video in your scene, this is the special texture for that.
  119079. * This special texture works similar to other textures, with the exception of a few parameters.
  119080. * @see https://doc.babylonjs.com/how_to/video_texture
  119081. * @param name optional name, will detect from video source, if not defined
  119082. * @param src can be used to provide an url, array of urls or an already setup HTML video element.
  119083. * @param scene is obviously the current scene.
  119084. * @param generateMipMaps can be used to turn on mipmaps (Can be expensive for videoTextures because they are often updated).
  119085. * @param invertY is false by default but can be used to invert video on Y axis
  119086. * @param samplingMode controls the sampling method and is set to TRILINEAR_SAMPLINGMODE by default
  119087. * @param settings allows finer control over video usage
  119088. */
  119089. constructor(name: Nullable<string>, src: string | string[] | HTMLVideoElement, scene: Nullable<Scene>, generateMipMaps?: boolean, invertY?: boolean, samplingMode?: number, settings?: VideoTextureSettings);
  119090. private _getName;
  119091. private _getVideo;
  119092. private _createInternalTexture;
  119093. private reset;
  119094. /**
  119095. * @hidden Internal method to initiate `update`.
  119096. */
  119097. _rebuild(): void;
  119098. /**
  119099. * Update Texture in the `auto` mode. Does not do anything if `settings.autoUpdateTexture` is false.
  119100. */
  119101. update(): void;
  119102. /**
  119103. * Update Texture in `manual` mode. Does not do anything if not visible or paused.
  119104. * @param isVisible Visibility state, detected by user using `scene.getActiveMeshes()` or othervise.
  119105. */
  119106. updateTexture(isVisible: boolean): void;
  119107. protected _updateInternalTexture: () => void;
  119108. /**
  119109. * Change video content. Changing video instance or setting multiple urls (as in constructor) is not supported.
  119110. * @param url New url.
  119111. */
  119112. updateURL(url: string): void;
  119113. /**
  119114. * Clones the texture.
  119115. * @returns the cloned texture
  119116. */
  119117. clone(): VideoTexture;
  119118. /**
  119119. * Dispose the texture and release its associated resources.
  119120. */
  119121. dispose(): void;
  119122. /**
  119123. * Creates a video texture straight from a stream.
  119124. * @param scene Define the scene the texture should be created in
  119125. * @param stream Define the stream the texture should be created from
  119126. * @returns The created video texture as a promise
  119127. */
  119128. static CreateFromStreamAsync(scene: Scene, stream: MediaStream): Promise<VideoTexture>;
  119129. /**
  119130. * Creates a video texture straight from your WebCam video feed.
  119131. * @param scene Define the scene the texture should be created in
  119132. * @param constraints Define the constraints to use to create the web cam feed from WebRTC
  119133. * @param audioConstaints Define the audio constraints to use to create the web cam feed from WebRTC
  119134. * @returns The created video texture as a promise
  119135. */
  119136. static CreateFromWebCamAsync(scene: Scene, constraints: {
  119137. minWidth: number;
  119138. maxWidth: number;
  119139. minHeight: number;
  119140. maxHeight: number;
  119141. deviceId: string;
  119142. } & MediaTrackConstraints, audioConstaints?: boolean | MediaTrackConstraints): Promise<VideoTexture>;
  119143. /**
  119144. * Creates a video texture straight from your WebCam video feed.
  119145. * @param scene Define the scene the texture should be created in
  119146. * @param onReady Define a callback to triggered once the texture will be ready
  119147. * @param constraints Define the constraints to use to create the web cam feed from WebRTC
  119148. * @param audioConstaints Define the audio constraints to use to create the web cam feed from WebRTC
  119149. */
  119150. static CreateFromWebCam(scene: Scene, onReady: (videoTexture: VideoTexture) => void, constraints: {
  119151. minWidth: number;
  119152. maxWidth: number;
  119153. minHeight: number;
  119154. maxHeight: number;
  119155. deviceId: string;
  119156. } & MediaTrackConstraints, audioConstaints?: boolean | MediaTrackConstraints): void;
  119157. }
  119158. }
  119159. declare module BABYLON {
  119160. /**
  119161. * Defines the interface used by objects working like Scene
  119162. * @hidden
  119163. */
  119164. export interface ISceneLike {
  119165. _addPendingData(data: any): void;
  119166. _removePendingData(data: any): void;
  119167. offlineProvider: IOfflineProvider;
  119168. }
  119169. /**
  119170. * Information about the current host
  119171. */
  119172. export interface HostInformation {
  119173. /**
  119174. * Defines if the current host is a mobile
  119175. */
  119176. isMobile: boolean;
  119177. }
  119178. /** Interface defining initialization parameters for Engine class */
  119179. export interface EngineOptions extends WebGLContextAttributes {
  119180. /**
  119181. * Defines if the engine should no exceed a specified device ratio
  119182. * @see https://developer.mozilla.org/en-US/docs/Web/API/Window/devicePixelRatio
  119183. */
  119184. limitDeviceRatio?: number;
  119185. /**
  119186. * Defines if webvr should be enabled automatically
  119187. * @see https://doc.babylonjs.com/how_to/webvr_camera
  119188. */
  119189. autoEnableWebVR?: boolean;
  119190. /**
  119191. * Defines if webgl2 should be turned off even if supported
  119192. * @see https://doc.babylonjs.com/features/webgl2
  119193. */
  119194. disableWebGL2Support?: boolean;
  119195. /**
  119196. * Defines if webaudio should be initialized as well
  119197. * @see https://doc.babylonjs.com/how_to/playing_sounds_and_music
  119198. */
  119199. audioEngine?: boolean;
  119200. /**
  119201. * Defines if animations should run using a deterministic lock step
  119202. * @see https://doc.babylonjs.com/babylon101/animations#deterministic-lockstep
  119203. */
  119204. deterministicLockstep?: boolean;
  119205. /** Defines the maximum steps to use with deterministic lock step mode */
  119206. lockstepMaxSteps?: number;
  119207. /** Defines the seconds between each deterministic lock step */
  119208. timeStep?: number;
  119209. /**
  119210. * Defines that engine should ignore context lost events
  119211. * If this event happens when this parameter is true, you will have to reload the page to restore rendering
  119212. */
  119213. doNotHandleContextLost?: boolean;
  119214. /**
  119215. * Defines that engine should ignore modifying touch action attribute and style
  119216. * If not handle, you might need to set it up on your side for expected touch devices behavior.
  119217. */
  119218. doNotHandleTouchAction?: boolean;
  119219. /**
  119220. * Defines that engine should compile shaders with high precision floats (if supported). True by default
  119221. */
  119222. useHighPrecisionFloats?: boolean;
  119223. /**
  119224. * Make the canvas XR Compatible for XR sessions
  119225. */
  119226. xrCompatible?: boolean;
  119227. /**
  119228. * Make the matrix computations to be performed in 64 bits instead of 32 bits. False by default
  119229. */
  119230. useHighPrecisionMatrix?: boolean;
  119231. /**
  119232. * Will prevent the system from falling back to software implementation if a hardware device cannot be created
  119233. */
  119234. failIfMajorPerformanceCaveat?: boolean;
  119235. }
  119236. /**
  119237. * The base engine class (root of all engines)
  119238. */
  119239. export class ThinEngine {
  119240. /** Use this array to turn off some WebGL2 features on known buggy browsers version */
  119241. static ExceptionList: ({
  119242. key: string;
  119243. capture: string;
  119244. captureConstraint: number;
  119245. targets: string[];
  119246. } | {
  119247. key: string;
  119248. capture: null;
  119249. captureConstraint: null;
  119250. targets: string[];
  119251. })[];
  119252. /** @hidden */
  119253. static _TextureLoaders: IInternalTextureLoader[];
  119254. /**
  119255. * Returns the current npm package of the sdk
  119256. */
  119257. static get NpmPackage(): string;
  119258. /**
  119259. * Returns the current version of the framework
  119260. */
  119261. static get Version(): string;
  119262. /**
  119263. * Returns a string describing the current engine
  119264. */
  119265. get description(): string;
  119266. /**
  119267. * Gets or sets the epsilon value used by collision engine
  119268. */
  119269. static CollisionsEpsilon: number;
  119270. /**
  119271. * Gets or sets the relative url used to load shaders if using the engine in non-minified mode
  119272. */
  119273. static get ShadersRepository(): string;
  119274. static set ShadersRepository(value: string);
  119275. /** @hidden */
  119276. _shaderProcessor: IShaderProcessor;
  119277. /**
  119278. * Gets or sets a boolean that indicates if textures must be forced to power of 2 size even if not required
  119279. */
  119280. forcePOTTextures: boolean;
  119281. /**
  119282. * Gets a boolean indicating if the engine is currently rendering in fullscreen mode
  119283. */
  119284. isFullscreen: boolean;
  119285. /**
  119286. * Gets or sets a boolean indicating if back faces must be culled (true by default)
  119287. */
  119288. cullBackFaces: boolean;
  119289. /**
  119290. * Gets or sets a boolean indicating if the engine must keep rendering even if the window is not in foregroun
  119291. */
  119292. renderEvenInBackground: boolean;
  119293. /**
  119294. * Gets or sets a boolean indicating that cache can be kept between frames
  119295. */
  119296. preventCacheWipeBetweenFrames: boolean;
  119297. /** Gets or sets a boolean indicating if the engine should validate programs after compilation */
  119298. validateShaderPrograms: boolean;
  119299. /**
  119300. * Gets or sets a boolean indicating if depth buffer should be reverse, going from far to near.
  119301. * This can provide greater z depth for distant objects.
  119302. */
  119303. useReverseDepthBuffer: boolean;
  119304. /**
  119305. * Gets or sets a boolean indicating that uniform buffers must be disabled even if they are supported
  119306. */
  119307. disableUniformBuffers: boolean;
  119308. /** @hidden */
  119309. _uniformBuffers: UniformBuffer[];
  119310. /**
  119311. * Gets a boolean indicating that the engine supports uniform buffers
  119312. * @see https://doc.babylonjs.com/features/webgl2#uniform-buffer-objets
  119313. */
  119314. get supportsUniformBuffers(): boolean;
  119315. /** @hidden */
  119316. _gl: WebGLRenderingContext;
  119317. /** @hidden */
  119318. _webGLVersion: number;
  119319. protected _renderingCanvas: Nullable<HTMLCanvasElement>;
  119320. protected _windowIsBackground: boolean;
  119321. protected _creationOptions: EngineOptions;
  119322. protected _highPrecisionShadersAllowed: boolean;
  119323. /** @hidden */
  119324. get _shouldUseHighPrecisionShader(): boolean;
  119325. /**
  119326. * Gets a boolean indicating that only power of 2 textures are supported
  119327. * Please note that you can still use non power of 2 textures but in this case the engine will forcefully convert them
  119328. */
  119329. get needPOTTextures(): boolean;
  119330. /** @hidden */
  119331. _badOS: boolean;
  119332. /** @hidden */
  119333. _badDesktopOS: boolean;
  119334. private _hardwareScalingLevel;
  119335. /** @hidden */
  119336. _caps: EngineCapabilities;
  119337. private _isStencilEnable;
  119338. private _glVersion;
  119339. private _glRenderer;
  119340. private _glVendor;
  119341. /** @hidden */
  119342. _videoTextureSupported: boolean;
  119343. protected _renderingQueueLaunched: boolean;
  119344. protected _activeRenderLoops: (() => void)[];
  119345. /**
  119346. * Observable signaled when a context lost event is raised
  119347. */
  119348. onContextLostObservable: Observable<ThinEngine>;
  119349. /**
  119350. * Observable signaled when a context restored event is raised
  119351. */
  119352. onContextRestoredObservable: Observable<ThinEngine>;
  119353. private _onContextLost;
  119354. private _onContextRestored;
  119355. protected _contextWasLost: boolean;
  119356. /** @hidden */
  119357. _doNotHandleContextLost: boolean;
  119358. /**
  119359. * Gets or sets a boolean indicating if resources should be retained to be able to handle context lost events
  119360. * @see https://doc.babylonjs.com/how_to/optimizing_your_scene#handling-webgl-context-lost
  119361. */
  119362. get doNotHandleContextLost(): boolean;
  119363. set doNotHandleContextLost(value: boolean);
  119364. /**
  119365. * Gets or sets a boolean indicating that vertex array object must be disabled even if they are supported
  119366. */
  119367. disableVertexArrayObjects: boolean;
  119368. /** @hidden */
  119369. protected _colorWrite: boolean;
  119370. /** @hidden */
  119371. protected _colorWriteChanged: boolean;
  119372. /** @hidden */
  119373. protected _depthCullingState: DepthCullingState;
  119374. /** @hidden */
  119375. protected _stencilState: StencilState;
  119376. /** @hidden */
  119377. _alphaState: AlphaState;
  119378. /** @hidden */
  119379. _alphaMode: number;
  119380. /** @hidden */
  119381. _alphaEquation: number;
  119382. /** @hidden */
  119383. _internalTexturesCache: InternalTexture[];
  119384. /** @hidden */
  119385. protected _activeChannel: number;
  119386. private _currentTextureChannel;
  119387. /** @hidden */
  119388. protected _boundTexturesCache: {
  119389. [key: string]: Nullable<InternalTexture>;
  119390. };
  119391. /** @hidden */
  119392. protected _currentEffect: Nullable<Effect>;
  119393. /** @hidden */
  119394. protected _currentProgram: Nullable<WebGLProgram>;
  119395. private _compiledEffects;
  119396. private _vertexAttribArraysEnabled;
  119397. /** @hidden */
  119398. protected _cachedViewport: Nullable<IViewportLike>;
  119399. private _cachedVertexArrayObject;
  119400. /** @hidden */
  119401. protected _cachedVertexBuffers: any;
  119402. /** @hidden */
  119403. protected _cachedIndexBuffer: Nullable<DataBuffer>;
  119404. /** @hidden */
  119405. protected _cachedEffectForVertexBuffers: Nullable<Effect>;
  119406. /** @hidden */
  119407. _currentRenderTarget: Nullable<InternalTexture>;
  119408. private _uintIndicesCurrentlySet;
  119409. protected _currentBoundBuffer: Nullable<WebGLBuffer>[];
  119410. /** @hidden */
  119411. _currentFramebuffer: Nullable<WebGLFramebuffer>;
  119412. /** @hidden */
  119413. _dummyFramebuffer: Nullable<WebGLFramebuffer>;
  119414. private _currentBufferPointers;
  119415. private _currentInstanceLocations;
  119416. private _currentInstanceBuffers;
  119417. private _textureUnits;
  119418. /** @hidden */
  119419. _workingCanvas: Nullable<HTMLCanvasElement | OffscreenCanvas>;
  119420. /** @hidden */
  119421. _workingContext: Nullable<CanvasRenderingContext2D | OffscreenCanvasRenderingContext2D>;
  119422. /** @hidden */
  119423. _boundRenderFunction: any;
  119424. private _vaoRecordInProgress;
  119425. private _mustWipeVertexAttributes;
  119426. private _emptyTexture;
  119427. private _emptyCubeTexture;
  119428. private _emptyTexture3D;
  119429. private _emptyTexture2DArray;
  119430. /** @hidden */
  119431. _frameHandler: number;
  119432. private _nextFreeTextureSlots;
  119433. private _maxSimultaneousTextures;
  119434. private _activeRequests;
  119435. /** @hidden */
  119436. _transformTextureUrl: Nullable<(url: string) => string>;
  119437. /**
  119438. * Gets information about the current host
  119439. */
  119440. hostInformation: HostInformation;
  119441. protected get _supportsHardwareTextureRescaling(): boolean;
  119442. private _framebufferDimensionsObject;
  119443. /**
  119444. * sets the object from which width and height will be taken from when getting render width and height
  119445. * Will fallback to the gl object
  119446. * @param dimensions the framebuffer width and height that will be used.
  119447. */
  119448. set framebufferDimensionsObject(dimensions: Nullable<{
  119449. framebufferWidth: number;
  119450. framebufferHeight: number;
  119451. }>);
  119452. /**
  119453. * Gets the current viewport
  119454. */
  119455. get currentViewport(): Nullable<IViewportLike>;
  119456. /**
  119457. * Gets the default empty texture
  119458. */
  119459. get emptyTexture(): InternalTexture;
  119460. /**
  119461. * Gets the default empty 3D texture
  119462. */
  119463. get emptyTexture3D(): InternalTexture;
  119464. /**
  119465. * Gets the default empty 2D array texture
  119466. */
  119467. get emptyTexture2DArray(): InternalTexture;
  119468. /**
  119469. * Gets the default empty cube texture
  119470. */
  119471. get emptyCubeTexture(): InternalTexture;
  119472. /**
  119473. * Defines whether the engine has been created with the premultipliedAlpha option on or not.
  119474. */
  119475. readonly premultipliedAlpha: boolean;
  119476. /**
  119477. * Observable event triggered before each texture is initialized
  119478. */
  119479. onBeforeTextureInitObservable: Observable<Texture>;
  119480. /**
  119481. * Creates a new engine
  119482. * @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
  119483. * @param antialias defines enable antialiasing (default: false)
  119484. * @param options defines further options to be sent to the getContext() function
  119485. * @param adaptToDeviceRatio defines whether to adapt to the device's viewport characteristics (default: false)
  119486. */
  119487. constructor(canvasOrContext: Nullable<HTMLCanvasElement | WebGLRenderingContext | WebGL2RenderingContext>, antialias?: boolean, options?: EngineOptions, adaptToDeviceRatio?: boolean);
  119488. private _rebuildInternalTextures;
  119489. private _rebuildEffects;
  119490. /**
  119491. * Gets a boolean indicating if all created effects are ready
  119492. * @returns true if all effects are ready
  119493. */
  119494. areAllEffectsReady(): boolean;
  119495. protected _rebuildBuffers(): void;
  119496. protected _initGLContext(): void;
  119497. /**
  119498. * Gets version of the current webGL context
  119499. */
  119500. get webGLVersion(): number;
  119501. /**
  119502. * Gets a string identifying the name of the class
  119503. * @returns "Engine" string
  119504. */
  119505. getClassName(): string;
  119506. /**
  119507. * Returns true if the stencil buffer has been enabled through the creation option of the context.
  119508. */
  119509. get isStencilEnable(): boolean;
  119510. /** @hidden */
  119511. _prepareWorkingCanvas(): void;
  119512. /**
  119513. * Reset the texture cache to empty state
  119514. */
  119515. resetTextureCache(): void;
  119516. /**
  119517. * Gets an object containing information about the current webGL context
  119518. * @returns an object containing the vender, the renderer and the version of the current webGL context
  119519. */
  119520. getGlInfo(): {
  119521. vendor: string;
  119522. renderer: string;
  119523. version: string;
  119524. };
  119525. /**
  119526. * Defines the hardware scaling level.
  119527. * By default the hardware scaling level is computed from the window device ratio.
  119528. * 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.
  119529. * @param level defines the level to use
  119530. */
  119531. setHardwareScalingLevel(level: number): void;
  119532. /**
  119533. * Gets the current hardware scaling level.
  119534. * By default the hardware scaling level is computed from the window device ratio.
  119535. * 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.
  119536. * @returns a number indicating the current hardware scaling level
  119537. */
  119538. getHardwareScalingLevel(): number;
  119539. /**
  119540. * Gets the list of loaded textures
  119541. * @returns an array containing all loaded textures
  119542. */
  119543. getLoadedTexturesCache(): InternalTexture[];
  119544. /**
  119545. * Gets the object containing all engine capabilities
  119546. * @returns the EngineCapabilities object
  119547. */
  119548. getCaps(): EngineCapabilities;
  119549. /**
  119550. * stop executing a render loop function and remove it from the execution array
  119551. * @param renderFunction defines the function to be removed. If not provided all functions will be removed.
  119552. */
  119553. stopRenderLoop(renderFunction?: () => void): void;
  119554. /** @hidden */
  119555. _renderLoop(): void;
  119556. /**
  119557. * Gets the HTML canvas attached with the current webGL context
  119558. * @returns a HTML canvas
  119559. */
  119560. getRenderingCanvas(): Nullable<HTMLCanvasElement>;
  119561. /**
  119562. * Gets host window
  119563. * @returns the host window object
  119564. */
  119565. getHostWindow(): Nullable<Window>;
  119566. /**
  119567. * Gets the current render width
  119568. * @param useScreen defines if screen size must be used (or the current render target if any)
  119569. * @returns a number defining the current render width
  119570. */
  119571. getRenderWidth(useScreen?: boolean): number;
  119572. /**
  119573. * Gets the current render height
  119574. * @param useScreen defines if screen size must be used (or the current render target if any)
  119575. * @returns a number defining the current render height
  119576. */
  119577. getRenderHeight(useScreen?: boolean): number;
  119578. /**
  119579. * Can be used to override the current requestAnimationFrame requester.
  119580. * @hidden
  119581. */
  119582. protected _queueNewFrame(bindedRenderFunction: any, requester?: any): number;
  119583. /**
  119584. * Register and execute a render loop. The engine can have more than one render function
  119585. * @param renderFunction defines the function to continuously execute
  119586. */
  119587. runRenderLoop(renderFunction: () => void): void;
  119588. /**
  119589. * Clear the current render buffer or the current render target (if any is set up)
  119590. * @param color defines the color to use
  119591. * @param backBuffer defines if the back buffer must be cleared
  119592. * @param depth defines if the depth buffer must be cleared
  119593. * @param stencil defines if the stencil buffer must be cleared
  119594. */
  119595. clear(color: Nullable<IColor4Like>, backBuffer: boolean, depth: boolean, stencil?: boolean): void;
  119596. private _viewportCached;
  119597. /** @hidden */
  119598. _viewport(x: number, y: number, width: number, height: number): void;
  119599. /**
  119600. * Set the WebGL's viewport
  119601. * @param viewport defines the viewport element to be used
  119602. * @param requiredWidth defines the width required for rendering. If not provided the rendering canvas' width is used
  119603. * @param requiredHeight defines the height required for rendering. If not provided the rendering canvas' height is used
  119604. */
  119605. setViewport(viewport: IViewportLike, requiredWidth?: number, requiredHeight?: number): void;
  119606. /**
  119607. * Begin a new frame
  119608. */
  119609. beginFrame(): void;
  119610. /**
  119611. * Enf the current frame
  119612. */
  119613. endFrame(): void;
  119614. /**
  119615. * Resize the view according to the canvas' size
  119616. */
  119617. resize(): void;
  119618. /**
  119619. * Force a specific size of the canvas
  119620. * @param width defines the new canvas' width
  119621. * @param height defines the new canvas' height
  119622. * @returns true if the size was changed
  119623. */
  119624. setSize(width: number, height: number): boolean;
  119625. /**
  119626. * Binds the frame buffer to the specified texture.
  119627. * @param texture The texture to render to or null for the default canvas
  119628. * @param faceIndex The face of the texture to render to in case of cube texture
  119629. * @param requiredWidth The width of the target to render to
  119630. * @param requiredHeight The height of the target to render to
  119631. * @param forceFullscreenViewport Forces the viewport to be the entire texture/screen if true
  119632. * @param lodLevel defines the lod level to bind to the frame buffer
  119633. * @param layer defines the 2d array index to bind to frame buffer to
  119634. */
  119635. bindFramebuffer(texture: InternalTexture, faceIndex?: number, requiredWidth?: number, requiredHeight?: number, forceFullscreenViewport?: boolean, lodLevel?: number, layer?: number): void;
  119636. /** @hidden */
  119637. _bindUnboundFramebuffer(framebuffer: Nullable<WebGLFramebuffer>): void;
  119638. /**
  119639. * Unbind the current render target texture from the webGL context
  119640. * @param texture defines the render target texture to unbind
  119641. * @param disableGenerateMipMaps defines a boolean indicating that mipmaps must not be generated
  119642. * @param onBeforeUnbind defines a function which will be called before the effective unbind
  119643. */
  119644. unBindFramebuffer(texture: InternalTexture, disableGenerateMipMaps?: boolean, onBeforeUnbind?: () => void): void;
  119645. /**
  119646. * Force a webGL flush (ie. a flush of all waiting webGL commands)
  119647. */
  119648. flushFramebuffer(): void;
  119649. /**
  119650. * Unbind the current render target and bind the default framebuffer
  119651. */
  119652. restoreDefaultFramebuffer(): void;
  119653. /** @hidden */
  119654. protected _resetVertexBufferBinding(): void;
  119655. /**
  119656. * Creates a vertex buffer
  119657. * @param data the data for the vertex buffer
  119658. * @returns the new WebGL static buffer
  119659. */
  119660. createVertexBuffer(data: DataArray): DataBuffer;
  119661. private _createVertexBuffer;
  119662. /**
  119663. * Creates a dynamic vertex buffer
  119664. * @param data the data for the dynamic vertex buffer
  119665. * @returns the new WebGL dynamic buffer
  119666. */
  119667. createDynamicVertexBuffer(data: DataArray): DataBuffer;
  119668. protected _resetIndexBufferBinding(): void;
  119669. /**
  119670. * Creates a new index buffer
  119671. * @param indices defines the content of the index buffer
  119672. * @param updatable defines if the index buffer must be updatable
  119673. * @returns a new webGL buffer
  119674. */
  119675. createIndexBuffer(indices: IndicesArray, updatable?: boolean): DataBuffer;
  119676. protected _normalizeIndexData(indices: IndicesArray): Uint16Array | Uint32Array;
  119677. /**
  119678. * Bind a webGL buffer to the webGL context
  119679. * @param buffer defines the buffer to bind
  119680. */
  119681. bindArrayBuffer(buffer: Nullable<DataBuffer>): void;
  119682. protected bindIndexBuffer(buffer: Nullable<DataBuffer>): void;
  119683. private bindBuffer;
  119684. /**
  119685. * update the bound buffer with the given data
  119686. * @param data defines the data to update
  119687. */
  119688. updateArrayBuffer(data: Float32Array): void;
  119689. private _vertexAttribPointer;
  119690. /** @hidden */
  119691. _bindIndexBufferWithCache(indexBuffer: Nullable<DataBuffer>): void;
  119692. private _bindVertexBuffersAttributes;
  119693. /**
  119694. * Records a vertex array object
  119695. * @see https://doc.babylonjs.com/features/webgl2#vertex-array-objects
  119696. * @param vertexBuffers defines the list of vertex buffers to store
  119697. * @param indexBuffer defines the index buffer to store
  119698. * @param effect defines the effect to store
  119699. * @returns the new vertex array object
  119700. */
  119701. recordVertexArrayObject(vertexBuffers: {
  119702. [key: string]: VertexBuffer;
  119703. }, indexBuffer: Nullable<DataBuffer>, effect: Effect): WebGLVertexArrayObject;
  119704. /**
  119705. * Bind a specific vertex array object
  119706. * @see https://doc.babylonjs.com/features/webgl2#vertex-array-objects
  119707. * @param vertexArrayObject defines the vertex array object to bind
  119708. * @param indexBuffer defines the index buffer to bind
  119709. */
  119710. bindVertexArrayObject(vertexArrayObject: WebGLVertexArrayObject, indexBuffer: Nullable<DataBuffer>): void;
  119711. /**
  119712. * Bind webGl buffers directly to the webGL context
  119713. * @param vertexBuffer defines the vertex buffer to bind
  119714. * @param indexBuffer defines the index buffer to bind
  119715. * @param vertexDeclaration defines the vertex declaration to use with the vertex buffer
  119716. * @param vertexStrideSize defines the vertex stride of the vertex buffer
  119717. * @param effect defines the effect associated with the vertex buffer
  119718. */
  119719. bindBuffersDirectly(vertexBuffer: DataBuffer, indexBuffer: DataBuffer, vertexDeclaration: number[], vertexStrideSize: number, effect: Effect): void;
  119720. private _unbindVertexArrayObject;
  119721. /**
  119722. * Bind a list of vertex buffers to the webGL context
  119723. * @param vertexBuffers defines the list of vertex buffers to bind
  119724. * @param indexBuffer defines the index buffer to bind
  119725. * @param effect defines the effect associated with the vertex buffers
  119726. */
  119727. bindBuffers(vertexBuffers: {
  119728. [key: string]: Nullable<VertexBuffer>;
  119729. }, indexBuffer: Nullable<DataBuffer>, effect: Effect): void;
  119730. /**
  119731. * Unbind all instance attributes
  119732. */
  119733. unbindInstanceAttributes(): void;
  119734. /**
  119735. * Release and free the memory of a vertex array object
  119736. * @param vao defines the vertex array object to delete
  119737. */
  119738. releaseVertexArrayObject(vao: WebGLVertexArrayObject): void;
  119739. /** @hidden */
  119740. _releaseBuffer(buffer: DataBuffer): boolean;
  119741. protected _deleteBuffer(buffer: DataBuffer): void;
  119742. /**
  119743. * Update the content of a webGL buffer used with instanciation and bind it to the webGL context
  119744. * @param instancesBuffer defines the webGL buffer to update and bind
  119745. * @param data defines the data to store in the buffer
  119746. * @param offsetLocations defines the offsets or attributes information used to determine where data must be stored in the buffer
  119747. */
  119748. updateAndBindInstancesBuffer(instancesBuffer: DataBuffer, data: Float32Array, offsetLocations: number[] | InstancingAttributeInfo[]): void;
  119749. /**
  119750. * Bind the content of a webGL buffer used with instantiation
  119751. * @param instancesBuffer defines the webGL buffer to bind
  119752. * @param attributesInfo defines the offsets or attributes information used to determine where data must be stored in the buffer
  119753. * @param computeStride defines Whether to compute the strides from the info or use the default 0
  119754. */
  119755. bindInstancesBuffer(instancesBuffer: DataBuffer, attributesInfo: InstancingAttributeInfo[], computeStride?: boolean): void;
  119756. /**
  119757. * Disable the instance attribute corresponding to the name in parameter
  119758. * @param name defines the name of the attribute to disable
  119759. */
  119760. disableInstanceAttributeByName(name: string): void;
  119761. /**
  119762. * Disable the instance attribute corresponding to the location in parameter
  119763. * @param attributeLocation defines the attribute location of the attribute to disable
  119764. */
  119765. disableInstanceAttribute(attributeLocation: number): void;
  119766. /**
  119767. * Disable the attribute corresponding to the location in parameter
  119768. * @param attributeLocation defines the attribute location of the attribute to disable
  119769. */
  119770. disableAttributeByIndex(attributeLocation: number): void;
  119771. /**
  119772. * Send a draw order
  119773. * @param useTriangles defines if triangles must be used to draw (else wireframe will be used)
  119774. * @param indexStart defines the starting index
  119775. * @param indexCount defines the number of index to draw
  119776. * @param instancesCount defines the number of instances to draw (if instanciation is enabled)
  119777. */
  119778. draw(useTriangles: boolean, indexStart: number, indexCount: number, instancesCount?: number): void;
  119779. /**
  119780. * Draw a list of points
  119781. * @param verticesStart defines the index of first vertex to draw
  119782. * @param verticesCount defines the count of vertices to draw
  119783. * @param instancesCount defines the number of instances to draw (if instanciation is enabled)
  119784. */
  119785. drawPointClouds(verticesStart: number, verticesCount: number, instancesCount?: number): void;
  119786. /**
  119787. * Draw a list of unindexed primitives
  119788. * @param useTriangles defines if triangles must be used to draw (else wireframe will be used)
  119789. * @param verticesStart defines the index of first vertex to draw
  119790. * @param verticesCount defines the count of vertices to draw
  119791. * @param instancesCount defines the number of instances to draw (if instanciation is enabled)
  119792. */
  119793. drawUnIndexed(useTriangles: boolean, verticesStart: number, verticesCount: number, instancesCount?: number): void;
  119794. /**
  119795. * Draw a list of indexed primitives
  119796. * @param fillMode defines the primitive to use
  119797. * @param indexStart defines the starting index
  119798. * @param indexCount defines the number of index to draw
  119799. * @param instancesCount defines the number of instances to draw (if instanciation is enabled)
  119800. */
  119801. drawElementsType(fillMode: number, indexStart: number, indexCount: number, instancesCount?: number): void;
  119802. /**
  119803. * Draw a list of unindexed primitives
  119804. * @param fillMode defines the primitive to use
  119805. * @param verticesStart defines the index of first vertex to draw
  119806. * @param verticesCount defines the count of vertices to draw
  119807. * @param instancesCount defines the number of instances to draw (if instanciation is enabled)
  119808. */
  119809. drawArraysType(fillMode: number, verticesStart: number, verticesCount: number, instancesCount?: number): void;
  119810. private _drawMode;
  119811. /** @hidden */
  119812. protected _reportDrawCall(): void;
  119813. /** @hidden */
  119814. _releaseEffect(effect: Effect): void;
  119815. /** @hidden */
  119816. _deletePipelineContext(pipelineContext: IPipelineContext): void;
  119817. /**
  119818. * Create a new effect (used to store vertex/fragment shaders)
  119819. * @param baseName defines the base name of the effect (The name of file without .fragment.fx or .vertex.fx)
  119820. * @param attributesNamesOrOptions defines either a list of attribute names or an IEffectCreationOptions object
  119821. * @param uniformsNamesOrEngine defines either a list of uniform names or the engine to use
  119822. * @param samplers defines an array of string used to represent textures
  119823. * @param defines defines the string containing the defines to use to compile the shaders
  119824. * @param fallbacks defines the list of potential fallbacks to use if shader conmpilation fails
  119825. * @param onCompiled defines a function to call when the effect creation is successful
  119826. * @param onError defines a function to call when the effect creation has failed
  119827. * @param indexParameters defines an object containing the index values to use to compile shaders (like the maximum number of simultaneous lights)
  119828. * @returns the new Effect
  119829. */
  119830. 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;
  119831. protected static _ConcatenateShader(source: string, defines: Nullable<string>, shaderVersion?: string): string;
  119832. private _compileShader;
  119833. private _compileRawShader;
  119834. /** @hidden */
  119835. _getShaderSource(shader: WebGLShader): Nullable<string>;
  119836. /**
  119837. * Directly creates a webGL program
  119838. * @param pipelineContext defines the pipeline context to attach to
  119839. * @param vertexCode defines the vertex shader code to use
  119840. * @param fragmentCode defines the fragment shader code to use
  119841. * @param context defines the webGL context to use (if not set, the current one will be used)
  119842. * @param transformFeedbackVaryings defines the list of transform feedback varyings to use
  119843. * @returns the new webGL program
  119844. */
  119845. createRawShaderProgram(pipelineContext: IPipelineContext, vertexCode: string, fragmentCode: string, context?: WebGLRenderingContext, transformFeedbackVaryings?: Nullable<string[]>): WebGLProgram;
  119846. /**
  119847. * Creates a webGL program
  119848. * @param pipelineContext defines the pipeline context to attach to
  119849. * @param vertexCode defines the vertex shader code to use
  119850. * @param fragmentCode defines the fragment shader code to use
  119851. * @param defines defines the string containing the defines to use to compile the shaders
  119852. * @param context defines the webGL context to use (if not set, the current one will be used)
  119853. * @param transformFeedbackVaryings defines the list of transform feedback varyings to use
  119854. * @returns the new webGL program
  119855. */
  119856. createShaderProgram(pipelineContext: IPipelineContext, vertexCode: string, fragmentCode: string, defines: Nullable<string>, context?: WebGLRenderingContext, transformFeedbackVaryings?: Nullable<string[]>): WebGLProgram;
  119857. /**
  119858. * Creates a new pipeline context
  119859. * @returns the new pipeline
  119860. */
  119861. createPipelineContext(): IPipelineContext;
  119862. protected _createShaderProgram(pipelineContext: WebGLPipelineContext, vertexShader: WebGLShader, fragmentShader: WebGLShader, context: WebGLRenderingContext, transformFeedbackVaryings?: Nullable<string[]>): WebGLProgram;
  119863. protected _finalizePipelineContext(pipelineContext: WebGLPipelineContext): void;
  119864. /** @hidden */
  119865. _preparePipelineContext(pipelineContext: IPipelineContext, vertexSourceCode: string, fragmentSourceCode: string, createAsRaw: boolean, rebuildRebind: any, defines: Nullable<string>, transformFeedbackVaryings: Nullable<string[]>): void;
  119866. /** @hidden */
  119867. _isRenderingStateCompiled(pipelineContext: IPipelineContext): boolean;
  119868. /** @hidden */
  119869. _executeWhenRenderingStateIsCompiled(pipelineContext: IPipelineContext, action: () => void): void;
  119870. /**
  119871. * Gets the list of webGL uniform locations associated with a specific program based on a list of uniform names
  119872. * @param pipelineContext defines the pipeline context to use
  119873. * @param uniformsNames defines the list of uniform names
  119874. * @returns an array of webGL uniform locations
  119875. */
  119876. getUniforms(pipelineContext: IPipelineContext, uniformsNames: string[]): Nullable<WebGLUniformLocation>[];
  119877. /**
  119878. * Gets the lsit of active attributes for a given webGL program
  119879. * @param pipelineContext defines the pipeline context to use
  119880. * @param attributesNames defines the list of attribute names to get
  119881. * @returns an array of indices indicating the offset of each attribute
  119882. */
  119883. getAttributes(pipelineContext: IPipelineContext, attributesNames: string[]): number[];
  119884. /**
  119885. * Activates an effect, mkaing it the current one (ie. the one used for rendering)
  119886. * @param effect defines the effect to activate
  119887. */
  119888. enableEffect(effect: Nullable<Effect>): void;
  119889. /**
  119890. * Set the value of an uniform to a number (int)
  119891. * @param uniform defines the webGL uniform location where to store the value
  119892. * @param value defines the int number to store
  119893. * @returns true if the value was set
  119894. */
  119895. setInt(uniform: Nullable<WebGLUniformLocation>, value: number): boolean;
  119896. /**
  119897. * Set the value of an uniform to an array of int32
  119898. * @param uniform defines the webGL uniform location where to store the value
  119899. * @param array defines the array of int32 to store
  119900. * @returns true if the value was set
  119901. */
  119902. setIntArray(uniform: Nullable<WebGLUniformLocation>, array: Int32Array): boolean;
  119903. /**
  119904. * Set the value of an uniform to an array of int32 (stored as vec2)
  119905. * @param uniform defines the webGL uniform location where to store the value
  119906. * @param array defines the array of int32 to store
  119907. * @returns true if the value was set
  119908. */
  119909. setIntArray2(uniform: Nullable<WebGLUniformLocation>, array: Int32Array): boolean;
  119910. /**
  119911. * Set the value of an uniform to an array of int32 (stored as vec3)
  119912. * @param uniform defines the webGL uniform location where to store the value
  119913. * @param array defines the array of int32 to store
  119914. * @returns true if the value was set
  119915. */
  119916. setIntArray3(uniform: Nullable<WebGLUniformLocation>, array: Int32Array): boolean;
  119917. /**
  119918. * Set the value of an uniform to an array of int32 (stored as vec4)
  119919. * @param uniform defines the webGL uniform location where to store the value
  119920. * @param array defines the array of int32 to store
  119921. * @returns true if the value was set
  119922. */
  119923. setIntArray4(uniform: Nullable<WebGLUniformLocation>, array: Int32Array): boolean;
  119924. /**
  119925. * Set the value of an uniform to an array of number
  119926. * @param uniform defines the webGL uniform location where to store the value
  119927. * @param array defines the array of number to store
  119928. * @returns true if the value was set
  119929. */
  119930. setArray(uniform: Nullable<WebGLUniformLocation>, array: number[] | Float32Array): boolean;
  119931. /**
  119932. * Set the value of an uniform to an array of number (stored as vec2)
  119933. * @param uniform defines the webGL uniform location where to store the value
  119934. * @param array defines the array of number to store
  119935. * @returns true if the value was set
  119936. */
  119937. setArray2(uniform: Nullable<WebGLUniformLocation>, array: number[] | Float32Array): boolean;
  119938. /**
  119939. * Set the value of an uniform to an array of number (stored as vec3)
  119940. * @param uniform defines the webGL uniform location where to store the value
  119941. * @param array defines the array of number to store
  119942. * @returns true if the value was set
  119943. */
  119944. setArray3(uniform: Nullable<WebGLUniformLocation>, array: number[] | Float32Array): boolean;
  119945. /**
  119946. * Set the value of an uniform to an array of number (stored as vec4)
  119947. * @param uniform defines the webGL uniform location where to store the value
  119948. * @param array defines the array of number to store
  119949. * @returns true if the value was set
  119950. */
  119951. setArray4(uniform: Nullable<WebGLUniformLocation>, array: number[] | Float32Array): boolean;
  119952. /**
  119953. * Set the value of an uniform to an array of float32 (stored as matrices)
  119954. * @param uniform defines the webGL uniform location where to store the value
  119955. * @param matrices defines the array of float32 to store
  119956. * @returns true if the value was set
  119957. */
  119958. setMatrices(uniform: Nullable<WebGLUniformLocation>, matrices: Float32Array): boolean;
  119959. /**
  119960. * Set the value of an uniform to a matrix (3x3)
  119961. * @param uniform defines the webGL uniform location where to store the value
  119962. * @param matrix defines the Float32Array representing the 3x3 matrix to store
  119963. * @returns true if the value was set
  119964. */
  119965. setMatrix3x3(uniform: Nullable<WebGLUniformLocation>, matrix: Float32Array): boolean;
  119966. /**
  119967. * Set the value of an uniform to a matrix (2x2)
  119968. * @param uniform defines the webGL uniform location where to store the value
  119969. * @param matrix defines the Float32Array representing the 2x2 matrix to store
  119970. * @returns true if the value was set
  119971. */
  119972. setMatrix2x2(uniform: Nullable<WebGLUniformLocation>, matrix: Float32Array): boolean;
  119973. /**
  119974. * Set the value of an uniform to a number (float)
  119975. * @param uniform defines the webGL uniform location where to store the value
  119976. * @param value defines the float number to store
  119977. * @returns true if the value was transfered
  119978. */
  119979. setFloat(uniform: Nullable<WebGLUniformLocation>, value: number): boolean;
  119980. /**
  119981. * Set the value of an uniform to a vec2
  119982. * @param uniform defines the webGL uniform location where to store the value
  119983. * @param x defines the 1st component of the value
  119984. * @param y defines the 2nd component of the value
  119985. * @returns true if the value was set
  119986. */
  119987. setFloat2(uniform: Nullable<WebGLUniformLocation>, x: number, y: number): boolean;
  119988. /**
  119989. * Set the value of an uniform to a vec3
  119990. * @param uniform defines the webGL uniform location where to store the value
  119991. * @param x defines the 1st component of the value
  119992. * @param y defines the 2nd component of the value
  119993. * @param z defines the 3rd component of the value
  119994. * @returns true if the value was set
  119995. */
  119996. setFloat3(uniform: Nullable<WebGLUniformLocation>, x: number, y: number, z: number): boolean;
  119997. /**
  119998. * Set the value of an uniform to a vec4
  119999. * @param uniform defines the webGL uniform location where to store the value
  120000. * @param x defines the 1st component of the value
  120001. * @param y defines the 2nd component of the value
  120002. * @param z defines the 3rd component of the value
  120003. * @param w defines the 4th component of the value
  120004. * @returns true if the value was set
  120005. */
  120006. setFloat4(uniform: Nullable<WebGLUniformLocation>, x: number, y: number, z: number, w: number): boolean;
  120007. /**
  120008. * Apply all cached states (depth, culling, stencil and alpha)
  120009. */
  120010. applyStates(): void;
  120011. /**
  120012. * Enable or disable color writing
  120013. * @param enable defines the state to set
  120014. */
  120015. setColorWrite(enable: boolean): void;
  120016. /**
  120017. * Gets a boolean indicating if color writing is enabled
  120018. * @returns the current color writing state
  120019. */
  120020. getColorWrite(): boolean;
  120021. /**
  120022. * Gets the depth culling state manager
  120023. */
  120024. get depthCullingState(): DepthCullingState;
  120025. /**
  120026. * Gets the alpha state manager
  120027. */
  120028. get alphaState(): AlphaState;
  120029. /**
  120030. * Gets the stencil state manager
  120031. */
  120032. get stencilState(): StencilState;
  120033. /**
  120034. * Clears the list of texture accessible through engine.
  120035. * This can help preventing texture load conflict due to name collision.
  120036. */
  120037. clearInternalTexturesCache(): void;
  120038. /**
  120039. * Force the entire cache to be cleared
  120040. * You should not have to use this function unless your engine needs to share the webGL context with another engine
  120041. * @param bruteForce defines a boolean to force clearing ALL caches (including stencil, detoh and alpha states)
  120042. */
  120043. wipeCaches(bruteForce?: boolean): void;
  120044. /** @hidden */
  120045. _getSamplingParameters(samplingMode: number, generateMipMaps: boolean): {
  120046. min: number;
  120047. mag: number;
  120048. };
  120049. /** @hidden */
  120050. _createTexture(): WebGLTexture;
  120051. /**
  120052. * Usually called from Texture.ts.
  120053. * Passed information to create a WebGLTexture
  120054. * @param url defines a value which contains one of the following:
  120055. * * A conventional http URL, e.g. 'http://...' or 'file://...'
  120056. * * A base64 string of in-line texture data, e.g. 'data:image/jpg;base64,/...'
  120057. * * An indicator that data being passed using the buffer parameter, e.g. 'data:mytexture.jpg'
  120058. * @param noMipmap defines a boolean indicating that no mipmaps shall be generated. Ignored for compressed textures. They must be in the file
  120059. * @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)
  120060. * @param scene needed for loading to the correct scene
  120061. * @param samplingMode mode with should be used sample / access the texture (Default: Texture.TRILINEAR_SAMPLINGMODE)
  120062. * @param onLoad optional callback to be called upon successful completion
  120063. * @param onError optional callback to be called upon failure
  120064. * @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
  120065. * @param fallback an internal argument in case the function must be called again, due to etc1 not having alpha capabilities
  120066. * @param format internal format. Default: RGB when extension is '.jpg' else RGBA. Ignored for compressed textures
  120067. * @param forcedExtension defines the extension to use to pick the right loader
  120068. * @param mimeType defines an optional mime type
  120069. * @returns a InternalTexture for assignment back into BABYLON.Texture
  120070. */
  120071. 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;
  120072. /**
  120073. * Loads an image as an HTMLImageElement.
  120074. * @param input url string, ArrayBuffer, or Blob to load
  120075. * @param onLoad callback called when the image successfully loads
  120076. * @param onError callback called when the image fails to load
  120077. * @param offlineProvider offline provider for caching
  120078. * @param mimeType optional mime type
  120079. * @returns the HTMLImageElement of the loaded image
  120080. * @hidden
  120081. */
  120082. 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>;
  120083. /**
  120084. * @hidden
  120085. */
  120086. _rescaleTexture(source: InternalTexture, destination: InternalTexture, scene: Nullable<any>, internalFormat: number, onComplete: () => void): void;
  120087. private _unpackFlipYCached;
  120088. /**
  120089. * In case you are sharing the context with other applications, it might
  120090. * be interested to not cache the unpack flip y state to ensure a consistent
  120091. * value would be set.
  120092. */
  120093. enableUnpackFlipYCached: boolean;
  120094. /** @hidden */
  120095. _unpackFlipY(value: boolean): void;
  120096. /** @hidden */
  120097. _getUnpackAlignement(): number;
  120098. private _getTextureTarget;
  120099. /**
  120100. * Update the sampling mode of a given texture
  120101. * @param samplingMode defines the required sampling mode
  120102. * @param texture defines the texture to update
  120103. * @param generateMipMaps defines whether to generate mipmaps for the texture
  120104. */
  120105. updateTextureSamplingMode(samplingMode: number, texture: InternalTexture, generateMipMaps?: boolean): void;
  120106. /**
  120107. * Update the sampling mode of a given texture
  120108. * @param texture defines the texture to update
  120109. * @param wrapU defines the texture wrap mode of the u coordinates
  120110. * @param wrapV defines the texture wrap mode of the v coordinates
  120111. * @param wrapR defines the texture wrap mode of the r coordinates
  120112. */
  120113. updateTextureWrappingMode(texture: InternalTexture, wrapU: Nullable<number>, wrapV?: Nullable<number>, wrapR?: Nullable<number>): void;
  120114. /** @hidden */
  120115. _setupDepthStencilTexture(internalTexture: InternalTexture, size: number | {
  120116. width: number;
  120117. height: number;
  120118. layers?: number;
  120119. }, generateStencil: boolean, bilinearFiltering: boolean, comparisonFunction: number): void;
  120120. /** @hidden */
  120121. _uploadCompressedDataToTextureDirectly(texture: InternalTexture, internalFormat: number, width: number, height: number, data: ArrayBufferView, faceIndex?: number, lod?: number): void;
  120122. /** @hidden */
  120123. _uploadDataToTextureDirectly(texture: InternalTexture, imageData: ArrayBufferView, faceIndex?: number, lod?: number, babylonInternalFormat?: number, useTextureWidthAndHeight?: boolean): void;
  120124. /**
  120125. * Update a portion of an internal texture
  120126. * @param texture defines the texture to update
  120127. * @param imageData defines the data to store into the texture
  120128. * @param xOffset defines the x coordinates of the update rectangle
  120129. * @param yOffset defines the y coordinates of the update rectangle
  120130. * @param width defines the width of the update rectangle
  120131. * @param height defines the height of the update rectangle
  120132. * @param faceIndex defines the face index if texture is a cube (0 by default)
  120133. * @param lod defines the lod level to update (0 by default)
  120134. */
  120135. updateTextureData(texture: InternalTexture, imageData: ArrayBufferView, xOffset: number, yOffset: number, width: number, height: number, faceIndex?: number, lod?: number): void;
  120136. /** @hidden */
  120137. _uploadArrayBufferViewToTexture(texture: InternalTexture, imageData: ArrayBufferView, faceIndex?: number, lod?: number): void;
  120138. protected _prepareWebGLTextureContinuation(texture: InternalTexture, scene: Nullable<ISceneLike>, noMipmap: boolean, isCompressed: boolean, samplingMode: number): void;
  120139. private _prepareWebGLTexture;
  120140. /** @hidden */
  120141. _setupFramebufferDepthAttachments(generateStencilBuffer: boolean, generateDepthBuffer: boolean, width: number, height: number, samples?: number): Nullable<WebGLRenderbuffer>;
  120142. private _getDepthStencilBuffer;
  120143. /** @hidden */
  120144. _releaseFramebufferObjects(texture: InternalTexture): void;
  120145. /** @hidden */
  120146. _releaseTexture(texture: InternalTexture): void;
  120147. protected _deleteTexture(texture: Nullable<WebGLTexture>): void;
  120148. protected _setProgram(program: WebGLProgram): void;
  120149. protected _boundUniforms: {
  120150. [key: number]: WebGLUniformLocation;
  120151. };
  120152. /**
  120153. * Binds an effect to the webGL context
  120154. * @param effect defines the effect to bind
  120155. */
  120156. bindSamplers(effect: Effect): void;
  120157. private _activateCurrentTexture;
  120158. /** @hidden */
  120159. _bindTextureDirectly(target: number, texture: Nullable<InternalTexture>, forTextureDataUpdate?: boolean, force?: boolean): boolean;
  120160. /** @hidden */
  120161. _bindTexture(channel: number, texture: Nullable<InternalTexture>): void;
  120162. /**
  120163. * Unbind all textures from the webGL context
  120164. */
  120165. unbindAllTextures(): void;
  120166. /**
  120167. * Sets a texture to the according uniform.
  120168. * @param channel The texture channel
  120169. * @param uniform The uniform to set
  120170. * @param texture The texture to apply
  120171. */
  120172. setTexture(channel: number, uniform: Nullable<WebGLUniformLocation>, texture: Nullable<BaseTexture>): void;
  120173. private _bindSamplerUniformToChannel;
  120174. private _getTextureWrapMode;
  120175. protected _setTexture(channel: number, texture: Nullable<BaseTexture>, isPartOfTextureArray?: boolean, depthStencilTexture?: boolean): boolean;
  120176. /**
  120177. * Sets an array of texture to the webGL context
  120178. * @param channel defines the channel where the texture array must be set
  120179. * @param uniform defines the associated uniform location
  120180. * @param textures defines the array of textures to bind
  120181. */
  120182. setTextureArray(channel: number, uniform: Nullable<WebGLUniformLocation>, textures: BaseTexture[]): void;
  120183. /** @hidden */
  120184. _setAnisotropicLevel(target: number, internalTexture: InternalTexture, anisotropicFilteringLevel: number): void;
  120185. private _setTextureParameterFloat;
  120186. private _setTextureParameterInteger;
  120187. /**
  120188. * Unbind all vertex attributes from the webGL context
  120189. */
  120190. unbindAllAttributes(): void;
  120191. /**
  120192. * 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
  120193. */
  120194. releaseEffects(): void;
  120195. /**
  120196. * Dispose and release all associated resources
  120197. */
  120198. dispose(): void;
  120199. /**
  120200. * Attach a new callback raised when context lost event is fired
  120201. * @param callback defines the callback to call
  120202. */
  120203. attachContextLostEvent(callback: ((event: WebGLContextEvent) => void)): void;
  120204. /**
  120205. * Attach a new callback raised when context restored event is fired
  120206. * @param callback defines the callback to call
  120207. */
  120208. attachContextRestoredEvent(callback: ((event: WebGLContextEvent) => void)): void;
  120209. /**
  120210. * Get the current error code of the webGL context
  120211. * @returns the error code
  120212. * @see https://developer.mozilla.org/en-US/docs/Web/API/WebGLRenderingContext/getError
  120213. */
  120214. getError(): number;
  120215. private _canRenderToFloatFramebuffer;
  120216. private _canRenderToHalfFloatFramebuffer;
  120217. private _canRenderToFramebuffer;
  120218. /** @hidden */
  120219. _getWebGLTextureType(type: number): number;
  120220. /** @hidden */
  120221. _getInternalFormat(format: number): number;
  120222. /** @hidden */
  120223. _getRGBABufferInternalSizedFormat(type: number, format?: number): number;
  120224. /** @hidden */
  120225. _getRGBAMultiSampleBufferFormat(type: number): number;
  120226. /** @hidden */
  120227. _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;
  120228. /**
  120229. * Loads a file from a url
  120230. * @param url url to load
  120231. * @param onSuccess callback called when the file successfully loads
  120232. * @param onProgress callback called while file is loading (if the server supports this mode)
  120233. * @param offlineProvider defines the offline provider for caching
  120234. * @param useArrayBuffer defines a boolean indicating that date must be returned as ArrayBuffer
  120235. * @param onError callback called when the file fails to load
  120236. * @returns a file request object
  120237. * @hidden
  120238. */
  120239. 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;
  120240. /**
  120241. * Reads pixels from the current frame buffer. Please note that this function can be slow
  120242. * @param x defines the x coordinate of the rectangle where pixels must be read
  120243. * @param y defines the y coordinate of the rectangle where pixels must be read
  120244. * @param width defines the width of the rectangle where pixels must be read
  120245. * @param height defines the height of the rectangle where pixels must be read
  120246. * @param hasAlpha defines whether the output should have alpha or not (defaults to true)
  120247. * @returns a Uint8Array containing RGBA colors
  120248. */
  120249. readPixels(x: number, y: number, width: number, height: number, hasAlpha?: boolean): Uint8Array;
  120250. private static _IsSupported;
  120251. private static _HasMajorPerformanceCaveat;
  120252. /**
  120253. * Gets a boolean indicating if the engine can be instanciated (ie. if a webGL context can be found)
  120254. */
  120255. static get IsSupported(): boolean;
  120256. /**
  120257. * Gets a boolean indicating if the engine can be instanciated (ie. if a webGL context can be found)
  120258. * @returns true if the engine can be created
  120259. * @ignorenaming
  120260. */
  120261. static isSupported(): boolean;
  120262. /**
  120263. * Gets a boolean indicating if the engine can be instanciated on a performant device (ie. if a webGL context can be found and it does not use a slow implementation)
  120264. */
  120265. static get HasMajorPerformanceCaveat(): boolean;
  120266. /**
  120267. * Find the next highest power of two.
  120268. * @param x Number to start search from.
  120269. * @return Next highest power of two.
  120270. */
  120271. static CeilingPOT(x: number): number;
  120272. /**
  120273. * Find the next lowest power of two.
  120274. * @param x Number to start search from.
  120275. * @return Next lowest power of two.
  120276. */
  120277. static FloorPOT(x: number): number;
  120278. /**
  120279. * Find the nearest power of two.
  120280. * @param x Number to start search from.
  120281. * @return Next nearest power of two.
  120282. */
  120283. static NearestPOT(x: number): number;
  120284. /**
  120285. * Get the closest exponent of two
  120286. * @param value defines the value to approximate
  120287. * @param max defines the maximum value to return
  120288. * @param mode defines how to define the closest value
  120289. * @returns closest exponent of two of the given value
  120290. */
  120291. static GetExponentOfTwo(value: number, max: number, mode?: number): number;
  120292. /**
  120293. * Queue a new function into the requested animation frame pool (ie. this function will be executed byt the browser for the next frame)
  120294. * @param func - the function to be called
  120295. * @param requester - the object that will request the next frame. Falls back to window.
  120296. * @returns frame number
  120297. */
  120298. static QueueNewFrame(func: () => void, requester?: any): number;
  120299. /**
  120300. * Gets host document
  120301. * @returns the host document object
  120302. */
  120303. getHostDocument(): Nullable<Document>;
  120304. }
  120305. }
  120306. declare module BABYLON {
  120307. /**
  120308. * Defines the source of the internal texture
  120309. */
  120310. export enum InternalTextureSource {
  120311. /**
  120312. * The source of the texture data is unknown
  120313. */
  120314. Unknown = 0,
  120315. /**
  120316. * Texture data comes from an URL
  120317. */
  120318. Url = 1,
  120319. /**
  120320. * Texture data is only used for temporary storage
  120321. */
  120322. Temp = 2,
  120323. /**
  120324. * Texture data comes from raw data (ArrayBuffer)
  120325. */
  120326. Raw = 3,
  120327. /**
  120328. * Texture content is dynamic (video or dynamic texture)
  120329. */
  120330. Dynamic = 4,
  120331. /**
  120332. * Texture content is generated by rendering to it
  120333. */
  120334. RenderTarget = 5,
  120335. /**
  120336. * Texture content is part of a multi render target process
  120337. */
  120338. MultiRenderTarget = 6,
  120339. /**
  120340. * Texture data comes from a cube data file
  120341. */
  120342. Cube = 7,
  120343. /**
  120344. * Texture data comes from a raw cube data
  120345. */
  120346. CubeRaw = 8,
  120347. /**
  120348. * Texture data come from a prefiltered cube data file
  120349. */
  120350. CubePrefiltered = 9,
  120351. /**
  120352. * Texture content is raw 3D data
  120353. */
  120354. Raw3D = 10,
  120355. /**
  120356. * Texture content is raw 2D array data
  120357. */
  120358. Raw2DArray = 11,
  120359. /**
  120360. * Texture content is a depth texture
  120361. */
  120362. Depth = 12,
  120363. /**
  120364. * Texture data comes from a raw cube data encoded with RGBD
  120365. */
  120366. CubeRawRGBD = 13
  120367. }
  120368. /**
  120369. * Class used to store data associated with WebGL texture data for the engine
  120370. * This class should not be used directly
  120371. */
  120372. export class InternalTexture {
  120373. /** @hidden */
  120374. static _UpdateRGBDAsync: (internalTexture: InternalTexture, data: ArrayBufferView[][], sphericalPolynomial: Nullable<SphericalPolynomial>, lodScale: number, lodOffset: number) => Promise<void>;
  120375. /**
  120376. * Defines if the texture is ready
  120377. */
  120378. isReady: boolean;
  120379. /**
  120380. * Defines if the texture is a cube texture
  120381. */
  120382. isCube: boolean;
  120383. /**
  120384. * Defines if the texture contains 3D data
  120385. */
  120386. is3D: boolean;
  120387. /**
  120388. * Defines if the texture contains 2D array data
  120389. */
  120390. is2DArray: boolean;
  120391. /**
  120392. * Defines if the texture contains multiview data
  120393. */
  120394. isMultiview: boolean;
  120395. /**
  120396. * Gets the URL used to load this texture
  120397. */
  120398. url: string;
  120399. /**
  120400. * Gets the sampling mode of the texture
  120401. */
  120402. samplingMode: number;
  120403. /**
  120404. * Gets a boolean indicating if the texture needs mipmaps generation
  120405. */
  120406. generateMipMaps: boolean;
  120407. /**
  120408. * Gets the number of samples used by the texture (WebGL2+ only)
  120409. */
  120410. samples: number;
  120411. /**
  120412. * Gets the type of the texture (int, float...)
  120413. */
  120414. type: number;
  120415. /**
  120416. * Gets the format of the texture (RGB, RGBA...)
  120417. */
  120418. format: number;
  120419. /**
  120420. * Observable called when the texture is loaded
  120421. */
  120422. onLoadedObservable: Observable<InternalTexture>;
  120423. /**
  120424. * Gets the width of the texture
  120425. */
  120426. width: number;
  120427. /**
  120428. * Gets the height of the texture
  120429. */
  120430. height: number;
  120431. /**
  120432. * Gets the depth of the texture
  120433. */
  120434. depth: number;
  120435. /**
  120436. * Gets the initial width of the texture (It could be rescaled if the current system does not support non power of two textures)
  120437. */
  120438. baseWidth: number;
  120439. /**
  120440. * Gets the initial height of the texture (It could be rescaled if the current system does not support non power of two textures)
  120441. */
  120442. baseHeight: number;
  120443. /**
  120444. * Gets the initial depth of the texture (It could be rescaled if the current system does not support non power of two textures)
  120445. */
  120446. baseDepth: number;
  120447. /**
  120448. * Gets a boolean indicating if the texture is inverted on Y axis
  120449. */
  120450. invertY: boolean;
  120451. /** @hidden */
  120452. _invertVScale: boolean;
  120453. /** @hidden */
  120454. _associatedChannel: number;
  120455. /** @hidden */
  120456. _source: InternalTextureSource;
  120457. /** @hidden */
  120458. _buffer: Nullable<string | ArrayBuffer | ArrayBufferView | HTMLImageElement | Blob | ImageBitmap>;
  120459. /** @hidden */
  120460. _bufferView: Nullable<ArrayBufferView>;
  120461. /** @hidden */
  120462. _bufferViewArray: Nullable<ArrayBufferView[]>;
  120463. /** @hidden */
  120464. _bufferViewArrayArray: Nullable<ArrayBufferView[][]>;
  120465. /** @hidden */
  120466. _size: number;
  120467. /** @hidden */
  120468. _extension: string;
  120469. /** @hidden */
  120470. _files: Nullable<string[]>;
  120471. /** @hidden */
  120472. _workingCanvas: Nullable<HTMLCanvasElement | OffscreenCanvas>;
  120473. /** @hidden */
  120474. _workingContext: Nullable<CanvasRenderingContext2D | OffscreenCanvasRenderingContext2D>;
  120475. /** @hidden */
  120476. _framebuffer: Nullable<WebGLFramebuffer>;
  120477. /** @hidden */
  120478. _depthStencilBuffer: Nullable<WebGLRenderbuffer>;
  120479. /** @hidden */
  120480. _MSAAFramebuffer: Nullable<WebGLFramebuffer>;
  120481. /** @hidden */
  120482. _MSAARenderBuffer: Nullable<WebGLRenderbuffer>;
  120483. /** @hidden */
  120484. _attachments: Nullable<number[]>;
  120485. /** @hidden */
  120486. _textureArray: Nullable<InternalTexture[]>;
  120487. /** @hidden */
  120488. _cachedCoordinatesMode: Nullable<number>;
  120489. /** @hidden */
  120490. _cachedWrapU: Nullable<number>;
  120491. /** @hidden */
  120492. _cachedWrapV: Nullable<number>;
  120493. /** @hidden */
  120494. _cachedWrapR: Nullable<number>;
  120495. /** @hidden */
  120496. _cachedAnisotropicFilteringLevel: Nullable<number>;
  120497. /** @hidden */
  120498. _isDisabled: boolean;
  120499. /** @hidden */
  120500. _compression: Nullable<string>;
  120501. /** @hidden */
  120502. _generateStencilBuffer: boolean;
  120503. /** @hidden */
  120504. _generateDepthBuffer: boolean;
  120505. /** @hidden */
  120506. _comparisonFunction: number;
  120507. /** @hidden */
  120508. _sphericalPolynomial: Nullable<SphericalPolynomial>;
  120509. /** @hidden */
  120510. _lodGenerationScale: number;
  120511. /** @hidden */
  120512. _lodGenerationOffset: number;
  120513. /** @hidden */
  120514. _depthStencilTexture: Nullable<InternalTexture>;
  120515. /** @hidden */
  120516. _colorTextureArray: Nullable<WebGLTexture>;
  120517. /** @hidden */
  120518. _depthStencilTextureArray: Nullable<WebGLTexture>;
  120519. /** @hidden */
  120520. _lodTextureHigh: Nullable<BaseTexture>;
  120521. /** @hidden */
  120522. _lodTextureMid: Nullable<BaseTexture>;
  120523. /** @hidden */
  120524. _lodTextureLow: Nullable<BaseTexture>;
  120525. /** @hidden */
  120526. _isRGBD: boolean;
  120527. /** @hidden */
  120528. _linearSpecularLOD: boolean;
  120529. /** @hidden */
  120530. _irradianceTexture: Nullable<BaseTexture>;
  120531. /** @hidden */
  120532. _webGLTexture: Nullable<WebGLTexture>;
  120533. /** @hidden */
  120534. _references: number;
  120535. /** @hidden */
  120536. _gammaSpace: Nullable<boolean>;
  120537. private _engine;
  120538. /**
  120539. * Gets the Engine the texture belongs to.
  120540. * @returns The babylon engine
  120541. */
  120542. getEngine(): ThinEngine;
  120543. /**
  120544. * Gets the data source type of the texture
  120545. */
  120546. get source(): InternalTextureSource;
  120547. /**
  120548. * Creates a new InternalTexture
  120549. * @param engine defines the engine to use
  120550. * @param source defines the type of data that will be used
  120551. * @param delayAllocation if the texture allocation should be delayed (default: false)
  120552. */
  120553. constructor(engine: ThinEngine, source: InternalTextureSource, delayAllocation?: boolean);
  120554. /**
  120555. * Increments the number of references (ie. the number of Texture that point to it)
  120556. */
  120557. incrementReferences(): void;
  120558. /**
  120559. * Change the size of the texture (not the size of the content)
  120560. * @param width defines the new width
  120561. * @param height defines the new height
  120562. * @param depth defines the new depth (1 by default)
  120563. */
  120564. updateSize(width: int, height: int, depth?: int): void;
  120565. /** @hidden */
  120566. _rebuild(): void;
  120567. /** @hidden */
  120568. _swapAndDie(target: InternalTexture): void;
  120569. /**
  120570. * Dispose the current allocated resources
  120571. */
  120572. dispose(): void;
  120573. }
  120574. }
  120575. declare module BABYLON {
  120576. /**
  120577. * Class used to work with sound analyzer using fast fourier transform (FFT)
  120578. * @see https://doc.babylonjs.com/how_to/playing_sounds_and_music
  120579. */
  120580. export class Analyser {
  120581. /**
  120582. * Gets or sets the smoothing
  120583. * @ignorenaming
  120584. */
  120585. SMOOTHING: number;
  120586. /**
  120587. * Gets or sets the FFT table size
  120588. * @ignorenaming
  120589. */
  120590. FFT_SIZE: number;
  120591. /**
  120592. * Gets or sets the bar graph amplitude
  120593. * @ignorenaming
  120594. */
  120595. BARGRAPHAMPLITUDE: number;
  120596. /**
  120597. * Gets or sets the position of the debug canvas
  120598. * @ignorenaming
  120599. */
  120600. DEBUGCANVASPOS: {
  120601. x: number;
  120602. y: number;
  120603. };
  120604. /**
  120605. * Gets or sets the debug canvas size
  120606. * @ignorenaming
  120607. */
  120608. DEBUGCANVASSIZE: {
  120609. width: number;
  120610. height: number;
  120611. };
  120612. private _byteFreqs;
  120613. private _byteTime;
  120614. private _floatFreqs;
  120615. private _webAudioAnalyser;
  120616. private _debugCanvas;
  120617. private _debugCanvasContext;
  120618. private _scene;
  120619. private _registerFunc;
  120620. private _audioEngine;
  120621. /**
  120622. * Creates a new analyser
  120623. * @param scene defines hosting scene
  120624. */
  120625. constructor(scene: Scene);
  120626. /**
  120627. * Get the number of data values you will have to play with for the visualization
  120628. * @see https://developer.mozilla.org/en-US/docs/Web/API/AnalyserNode/frequencyBinCount
  120629. * @returns a number
  120630. */
  120631. getFrequencyBinCount(): number;
  120632. /**
  120633. * Gets the current frequency data as a byte array
  120634. * @see https://developer.mozilla.org/en-US/docs/Web/API/AnalyserNode/getByteFrequencyData
  120635. * @returns a Uint8Array
  120636. */
  120637. getByteFrequencyData(): Uint8Array;
  120638. /**
  120639. * Gets the current waveform as a byte array
  120640. * @see https://developer.mozilla.org/en-US/docs/Web/API/AnalyserNode/getByteTimeDomainData
  120641. * @returns a Uint8Array
  120642. */
  120643. getByteTimeDomainData(): Uint8Array;
  120644. /**
  120645. * Gets the current frequency data as a float array
  120646. * @see https://developer.mozilla.org/en-US/docs/Web/API/AnalyserNode/getByteFrequencyData
  120647. * @returns a Float32Array
  120648. */
  120649. getFloatFrequencyData(): Float32Array;
  120650. /**
  120651. * Renders the debug canvas
  120652. */
  120653. drawDebugCanvas(): void;
  120654. /**
  120655. * Stops rendering the debug canvas and removes it
  120656. */
  120657. stopDebugCanvas(): void;
  120658. /**
  120659. * Connects two audio nodes
  120660. * @param inputAudioNode defines first node to connect
  120661. * @param outputAudioNode defines second node to connect
  120662. */
  120663. connectAudioNodes(inputAudioNode: AudioNode, outputAudioNode: AudioNode): void;
  120664. /**
  120665. * Releases all associated resources
  120666. */
  120667. dispose(): void;
  120668. }
  120669. }
  120670. declare module BABYLON {
  120671. /**
  120672. * This represents an audio engine and it is responsible
  120673. * to play, synchronize and analyse sounds throughout the application.
  120674. * @see https://doc.babylonjs.com/how_to/playing_sounds_and_music
  120675. */
  120676. export interface IAudioEngine extends IDisposable {
  120677. /**
  120678. * Gets whether the current host supports Web Audio and thus could create AudioContexts.
  120679. */
  120680. readonly canUseWebAudio: boolean;
  120681. /**
  120682. * Gets the current AudioContext if available.
  120683. */
  120684. readonly audioContext: Nullable<AudioContext>;
  120685. /**
  120686. * The master gain node defines the global audio volume of your audio engine.
  120687. */
  120688. readonly masterGain: GainNode;
  120689. /**
  120690. * Gets whether or not mp3 are supported by your browser.
  120691. */
  120692. readonly isMP3supported: boolean;
  120693. /**
  120694. * Gets whether or not ogg are supported by your browser.
  120695. */
  120696. readonly isOGGsupported: boolean;
  120697. /**
  120698. * Defines if Babylon should emit a warning if WebAudio is not supported.
  120699. * @ignoreNaming
  120700. */
  120701. WarnedWebAudioUnsupported: boolean;
  120702. /**
  120703. * Defines if the audio engine relies on a custom unlocked button.
  120704. * In this case, the embedded button will not be displayed.
  120705. */
  120706. useCustomUnlockedButton: boolean;
  120707. /**
  120708. * Gets whether or not the audio engine is unlocked (require first a user gesture on some browser).
  120709. */
  120710. readonly unlocked: boolean;
  120711. /**
  120712. * Event raised when audio has been unlocked on the browser.
  120713. */
  120714. onAudioUnlockedObservable: Observable<AudioEngine>;
  120715. /**
  120716. * Event raised when audio has been locked on the browser.
  120717. */
  120718. onAudioLockedObservable: Observable<AudioEngine>;
  120719. /**
  120720. * Flags the audio engine in Locked state.
  120721. * This happens due to new browser policies preventing audio to autoplay.
  120722. */
  120723. lock(): void;
  120724. /**
  120725. * Unlocks the audio engine once a user action has been done on the dom.
  120726. * This is helpful to resume play once browser policies have been satisfied.
  120727. */
  120728. unlock(): void;
  120729. /**
  120730. * Gets the global volume sets on the master gain.
  120731. * @returns the global volume if set or -1 otherwise
  120732. */
  120733. getGlobalVolume(): number;
  120734. /**
  120735. * Sets the global volume of your experience (sets on the master gain).
  120736. * @param newVolume Defines the new global volume of the application
  120737. */
  120738. setGlobalVolume(newVolume: number): void;
  120739. /**
  120740. * Connect the audio engine to an audio analyser allowing some amazing
  120741. * synchornization between the sounds/music and your visualization (VuMeter for instance).
  120742. * @see https://doc.babylonjs.com/how_to/playing_sounds_and_music#using-the-analyser
  120743. * @param analyser The analyser to connect to the engine
  120744. */
  120745. connectToAnalyser(analyser: Analyser): void;
  120746. }
  120747. /**
  120748. * This represents the default audio engine used in babylon.
  120749. * It is responsible to play, synchronize and analyse sounds throughout the application.
  120750. * @see https://doc.babylonjs.com/how_to/playing_sounds_and_music
  120751. */
  120752. export class AudioEngine implements IAudioEngine {
  120753. private _audioContext;
  120754. private _audioContextInitialized;
  120755. private _muteButton;
  120756. private _hostElement;
  120757. /**
  120758. * Gets whether the current host supports Web Audio and thus could create AudioContexts.
  120759. */
  120760. canUseWebAudio: boolean;
  120761. /**
  120762. * The master gain node defines the global audio volume of your audio engine.
  120763. */
  120764. masterGain: GainNode;
  120765. /**
  120766. * Defines if Babylon should emit a warning if WebAudio is not supported.
  120767. * @ignoreNaming
  120768. */
  120769. WarnedWebAudioUnsupported: boolean;
  120770. /**
  120771. * Gets whether or not mp3 are supported by your browser.
  120772. */
  120773. isMP3supported: boolean;
  120774. /**
  120775. * Gets whether or not ogg are supported by your browser.
  120776. */
  120777. isOGGsupported: boolean;
  120778. /**
  120779. * Gets whether audio has been unlocked on the device.
  120780. * Some Browsers have strong restrictions about Audio and won t autoplay unless
  120781. * a user interaction has happened.
  120782. */
  120783. unlocked: boolean;
  120784. /**
  120785. * Defines if the audio engine relies on a custom unlocked button.
  120786. * In this case, the embedded button will not be displayed.
  120787. */
  120788. useCustomUnlockedButton: boolean;
  120789. /**
  120790. * Event raised when audio has been unlocked on the browser.
  120791. */
  120792. onAudioUnlockedObservable: Observable<AudioEngine>;
  120793. /**
  120794. * Event raised when audio has been locked on the browser.
  120795. */
  120796. onAudioLockedObservable: Observable<AudioEngine>;
  120797. /**
  120798. * Gets the current AudioContext if available.
  120799. */
  120800. get audioContext(): Nullable<AudioContext>;
  120801. private _connectedAnalyser;
  120802. /**
  120803. * Instantiates a new audio engine.
  120804. *
  120805. * There should be only one per page as some browsers restrict the number
  120806. * of audio contexts you can create.
  120807. * @param hostElement defines the host element where to display the mute icon if necessary
  120808. */
  120809. constructor(hostElement?: Nullable<HTMLElement>);
  120810. /**
  120811. * Flags the audio engine in Locked state.
  120812. * This happens due to new browser policies preventing audio to autoplay.
  120813. */
  120814. lock(): void;
  120815. /**
  120816. * Unlocks the audio engine once a user action has been done on the dom.
  120817. * This is helpful to resume play once browser policies have been satisfied.
  120818. */
  120819. unlock(): void;
  120820. private _resumeAudioContext;
  120821. private _initializeAudioContext;
  120822. private _tryToRun;
  120823. private _triggerRunningState;
  120824. private _triggerSuspendedState;
  120825. private _displayMuteButton;
  120826. private _moveButtonToTopLeft;
  120827. private _onResize;
  120828. private _hideMuteButton;
  120829. /**
  120830. * Destroy and release the resources associated with the audio ccontext.
  120831. */
  120832. dispose(): void;
  120833. /**
  120834. * Gets the global volume sets on the master gain.
  120835. * @returns the global volume if set or -1 otherwise
  120836. */
  120837. getGlobalVolume(): number;
  120838. /**
  120839. * Sets the global volume of your experience (sets on the master gain).
  120840. * @param newVolume Defines the new global volume of the application
  120841. */
  120842. setGlobalVolume(newVolume: number): void;
  120843. /**
  120844. * Connect the audio engine to an audio analyser allowing some amazing
  120845. * synchornization between the sounds/music and your visualization (VuMeter for instance).
  120846. * @see https://doc.babylonjs.com/how_to/playing_sounds_and_music#using-the-analyser
  120847. * @param analyser The analyser to connect to the engine
  120848. */
  120849. connectToAnalyser(analyser: Analyser): void;
  120850. }
  120851. }
  120852. declare module BABYLON {
  120853. /**
  120854. * Interface used to present a loading screen while loading a scene
  120855. * @see https://doc.babylonjs.com/how_to/creating_a_custom_loading_screen
  120856. */
  120857. export interface ILoadingScreen {
  120858. /**
  120859. * Function called to display the loading screen
  120860. */
  120861. displayLoadingUI: () => void;
  120862. /**
  120863. * Function called to hide the loading screen
  120864. */
  120865. hideLoadingUI: () => void;
  120866. /**
  120867. * Gets or sets the color to use for the background
  120868. */
  120869. loadingUIBackgroundColor: string;
  120870. /**
  120871. * Gets or sets the text to display while loading
  120872. */
  120873. loadingUIText: string;
  120874. }
  120875. /**
  120876. * Class used for the default loading screen
  120877. * @see https://doc.babylonjs.com/how_to/creating_a_custom_loading_screen
  120878. */
  120879. export class DefaultLoadingScreen implements ILoadingScreen {
  120880. private _renderingCanvas;
  120881. private _loadingText;
  120882. private _loadingDivBackgroundColor;
  120883. private _loadingDiv;
  120884. private _loadingTextDiv;
  120885. /** Gets or sets the logo url to use for the default loading screen */
  120886. static DefaultLogoUrl: string;
  120887. /** Gets or sets the spinner url to use for the default loading screen */
  120888. static DefaultSpinnerUrl: string;
  120889. /**
  120890. * Creates a new default loading screen
  120891. * @param _renderingCanvas defines the canvas used to render the scene
  120892. * @param _loadingText defines the default text to display
  120893. * @param _loadingDivBackgroundColor defines the default background color
  120894. */
  120895. constructor(_renderingCanvas: HTMLCanvasElement, _loadingText?: string, _loadingDivBackgroundColor?: string);
  120896. /**
  120897. * Function called to display the loading screen
  120898. */
  120899. displayLoadingUI(): void;
  120900. /**
  120901. * Function called to hide the loading screen
  120902. */
  120903. hideLoadingUI(): void;
  120904. /**
  120905. * Gets or sets the text to display while loading
  120906. */
  120907. set loadingUIText(text: string);
  120908. get loadingUIText(): string;
  120909. /**
  120910. * Gets or sets the color to use for the background
  120911. */
  120912. get loadingUIBackgroundColor(): string;
  120913. set loadingUIBackgroundColor(color: string);
  120914. private _resizeLoadingUI;
  120915. }
  120916. }
  120917. declare module BABYLON {
  120918. /**
  120919. * Interface for any object that can request an animation frame
  120920. */
  120921. export interface ICustomAnimationFrameRequester {
  120922. /**
  120923. * This function will be called when the render loop is ready. If this is not populated, the engine's renderloop function will be called
  120924. */
  120925. renderFunction?: Function;
  120926. /**
  120927. * Called to request the next frame to render to
  120928. * @see https://developer.mozilla.org/en-US/docs/Web/API/window/requestAnimationFrame
  120929. */
  120930. requestAnimationFrame: Function;
  120931. /**
  120932. * You can pass this value to cancelAnimationFrame() to cancel the refresh callback request
  120933. * @see https://developer.mozilla.org/en-US/docs/Web/API/window/requestAnimationFrame#Return_value
  120934. */
  120935. requestID?: number;
  120936. }
  120937. }
  120938. declare module BABYLON {
  120939. /**
  120940. * Performance monitor tracks rolling average frame-time and frame-time variance over a user defined sliding-window
  120941. */
  120942. export class PerformanceMonitor {
  120943. private _enabled;
  120944. private _rollingFrameTime;
  120945. private _lastFrameTimeMs;
  120946. /**
  120947. * constructor
  120948. * @param frameSampleSize The number of samples required to saturate the sliding window
  120949. */
  120950. constructor(frameSampleSize?: number);
  120951. /**
  120952. * Samples current frame
  120953. * @param timeMs A timestamp in milliseconds of the current frame to compare with other frames
  120954. */
  120955. sampleFrame(timeMs?: number): void;
  120956. /**
  120957. * Returns the average frame time in milliseconds over the sliding window (or the subset of frames sampled so far)
  120958. */
  120959. get averageFrameTime(): number;
  120960. /**
  120961. * Returns the variance frame time in milliseconds over the sliding window (or the subset of frames sampled so far)
  120962. */
  120963. get averageFrameTimeVariance(): number;
  120964. /**
  120965. * Returns the frame time of the most recent frame
  120966. */
  120967. get instantaneousFrameTime(): number;
  120968. /**
  120969. * Returns the average framerate in frames per second over the sliding window (or the subset of frames sampled so far)
  120970. */
  120971. get averageFPS(): number;
  120972. /**
  120973. * Returns the average framerate in frames per second using the most recent frame time
  120974. */
  120975. get instantaneousFPS(): number;
  120976. /**
  120977. * Returns true if enough samples have been taken to completely fill the sliding window
  120978. */
  120979. get isSaturated(): boolean;
  120980. /**
  120981. * Enables contributions to the sliding window sample set
  120982. */
  120983. enable(): void;
  120984. /**
  120985. * Disables contributions to the sliding window sample set
  120986. * Samples will not be interpolated over the disabled period
  120987. */
  120988. disable(): void;
  120989. /**
  120990. * Returns true if sampling is enabled
  120991. */
  120992. get isEnabled(): boolean;
  120993. /**
  120994. * Resets performance monitor
  120995. */
  120996. reset(): void;
  120997. }
  120998. /**
  120999. * RollingAverage
  121000. *
  121001. * Utility to efficiently compute the rolling average and variance over a sliding window of samples
  121002. */
  121003. export class RollingAverage {
  121004. /**
  121005. * Current average
  121006. */
  121007. average: number;
  121008. /**
  121009. * Current variance
  121010. */
  121011. variance: number;
  121012. protected _samples: Array<number>;
  121013. protected _sampleCount: number;
  121014. protected _pos: number;
  121015. protected _m2: number;
  121016. /**
  121017. * constructor
  121018. * @param length The number of samples required to saturate the sliding window
  121019. */
  121020. constructor(length: number);
  121021. /**
  121022. * Adds a sample to the sample set
  121023. * @param v The sample value
  121024. */
  121025. add(v: number): void;
  121026. /**
  121027. * Returns previously added values or null if outside of history or outside the sliding window domain
  121028. * @param i Index in history. For example, pass 0 for the most recent value and 1 for the value before that
  121029. * @return Value previously recorded with add() or null if outside of range
  121030. */
  121031. history(i: number): number;
  121032. /**
  121033. * Returns true if enough samples have been taken to completely fill the sliding window
  121034. * @return true if sample-set saturated
  121035. */
  121036. isSaturated(): boolean;
  121037. /**
  121038. * Resets the rolling average (equivalent to 0 samples taken so far)
  121039. */
  121040. reset(): void;
  121041. /**
  121042. * Wraps a value around the sample range boundaries
  121043. * @param i Position in sample range, for example if the sample length is 5, and i is -3, then 2 will be returned.
  121044. * @return Wrapped position in sample range
  121045. */
  121046. protected _wrapPosition(i: number): number;
  121047. }
  121048. }
  121049. declare module BABYLON {
  121050. /**
  121051. * This class is used to track a performance counter which is number based.
  121052. * The user has access to many properties which give statistics of different nature.
  121053. *
  121054. * The implementer can track two kinds of Performance Counter: time and count.
  121055. * 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.
  121056. * 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.
  121057. */
  121058. export class PerfCounter {
  121059. /**
  121060. * Gets or sets a global boolean to turn on and off all the counters
  121061. */
  121062. static Enabled: boolean;
  121063. /**
  121064. * Returns the smallest value ever
  121065. */
  121066. get min(): number;
  121067. /**
  121068. * Returns the biggest value ever
  121069. */
  121070. get max(): number;
  121071. /**
  121072. * Returns the average value since the performance counter is running
  121073. */
  121074. get average(): number;
  121075. /**
  121076. * Returns the average value of the last second the counter was monitored
  121077. */
  121078. get lastSecAverage(): number;
  121079. /**
  121080. * Returns the current value
  121081. */
  121082. get current(): number;
  121083. /**
  121084. * Gets the accumulated total
  121085. */
  121086. get total(): number;
  121087. /**
  121088. * Gets the total value count
  121089. */
  121090. get count(): number;
  121091. /**
  121092. * Creates a new counter
  121093. */
  121094. constructor();
  121095. /**
  121096. * Call this method to start monitoring a new frame.
  121097. * 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.
  121098. */
  121099. fetchNewFrame(): void;
  121100. /**
  121101. * Call this method to monitor a count of something (e.g. mesh drawn in viewport count)
  121102. * @param newCount the count value to add to the monitored count
  121103. * @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.
  121104. */
  121105. addCount(newCount: number, fetchResult: boolean): void;
  121106. /**
  121107. * Start monitoring this performance counter
  121108. */
  121109. beginMonitoring(): void;
  121110. /**
  121111. * Compute the time lapsed since the previous beginMonitoring() call.
  121112. * @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
  121113. */
  121114. endMonitoring(newFrame?: boolean): void;
  121115. private _fetchResult;
  121116. private _startMonitoringTime;
  121117. private _min;
  121118. private _max;
  121119. private _average;
  121120. private _current;
  121121. private _totalValueCount;
  121122. private _totalAccumulated;
  121123. private _lastSecAverage;
  121124. private _lastSecAccumulated;
  121125. private _lastSecTime;
  121126. private _lastSecValueCount;
  121127. }
  121128. }
  121129. declare module BABYLON {
  121130. interface ThinEngine {
  121131. /** @hidden */
  121132. _readTexturePixels(texture: InternalTexture, width: number, height: number, faceIndex?: number, level?: number, buffer?: Nullable<ArrayBufferView>): ArrayBufferView;
  121133. }
  121134. }
  121135. declare module BABYLON {
  121136. /**
  121137. * Defines the interface used by display changed events
  121138. */
  121139. export interface IDisplayChangedEventArgs {
  121140. /** Gets the vrDisplay object (if any) */
  121141. vrDisplay: Nullable<any>;
  121142. /** Gets a boolean indicating if webVR is supported */
  121143. vrSupported: boolean;
  121144. }
  121145. /**
  121146. * Defines the interface used by objects containing a viewport (like a camera)
  121147. */
  121148. interface IViewportOwnerLike {
  121149. /**
  121150. * Gets or sets the viewport
  121151. */
  121152. viewport: IViewportLike;
  121153. }
  121154. /**
  121155. * The engine class is responsible for interfacing with all lower-level APIs such as WebGL and Audio
  121156. */
  121157. export class Engine extends ThinEngine {
  121158. /** Defines that alpha blending is disabled */
  121159. static readonly ALPHA_DISABLE: number;
  121160. /** Defines that alpha blending to SRC ALPHA * SRC + DEST */
  121161. static readonly ALPHA_ADD: number;
  121162. /** Defines that alpha blending to SRC ALPHA * SRC + (1 - SRC ALPHA) * DEST */
  121163. static readonly ALPHA_COMBINE: number;
  121164. /** Defines that alpha blending to DEST - SRC * DEST */
  121165. static readonly ALPHA_SUBTRACT: number;
  121166. /** Defines that alpha blending to SRC * DEST */
  121167. static readonly ALPHA_MULTIPLY: number;
  121168. /** Defines that alpha blending to SRC ALPHA * SRC + (1 - SRC) * DEST */
  121169. static readonly ALPHA_MAXIMIZED: number;
  121170. /** Defines that alpha blending to SRC + DEST */
  121171. static readonly ALPHA_ONEONE: number;
  121172. /** Defines that alpha blending to SRC + (1 - SRC ALPHA) * DEST */
  121173. static readonly ALPHA_PREMULTIPLIED: number;
  121174. /**
  121175. * Defines that alpha blending to SRC + (1 - SRC ALPHA) * DEST
  121176. * Alpha will be set to (1 - SRC ALPHA) * DEST ALPHA
  121177. */
  121178. static readonly ALPHA_PREMULTIPLIED_PORTERDUFF: number;
  121179. /** Defines that alpha blending to CST * SRC + (1 - CST) * DEST */
  121180. static readonly ALPHA_INTERPOLATE: number;
  121181. /**
  121182. * Defines that alpha blending to SRC + (1 - SRC) * DEST
  121183. * Alpha will be set to SRC ALPHA + (1 - SRC ALPHA) * DEST ALPHA
  121184. */
  121185. static readonly ALPHA_SCREENMODE: number;
  121186. /** Defines that the ressource is not delayed*/
  121187. static readonly DELAYLOADSTATE_NONE: number;
  121188. /** Defines that the ressource was successfully delay loaded */
  121189. static readonly DELAYLOADSTATE_LOADED: number;
  121190. /** Defines that the ressource is currently delay loading */
  121191. static readonly DELAYLOADSTATE_LOADING: number;
  121192. /** Defines that the ressource is delayed and has not started loading */
  121193. static readonly DELAYLOADSTATE_NOTLOADED: number;
  121194. /** Passed to depthFunction or stencilFunction to specify depth or stencil tests will never pass. i.e. Nothing will be drawn */
  121195. static readonly NEVER: number;
  121196. /** 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 */
  121197. static readonly ALWAYS: number;
  121198. /** Passed to depthFunction or stencilFunction to specify depth or stencil tests will pass if the new depth value is less than the stored value */
  121199. static readonly LESS: number;
  121200. /** Passed to depthFunction or stencilFunction to specify depth or stencil tests will pass if the new depth value is equals to the stored value */
  121201. static readonly EQUAL: number;
  121202. /** 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 */
  121203. static readonly LEQUAL: number;
  121204. /** Passed to depthFunction or stencilFunction to specify depth or stencil tests will pass if the new depth value is greater than the stored value */
  121205. static readonly GREATER: number;
  121206. /** 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 */
  121207. static readonly GEQUAL: number;
  121208. /** 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 */
  121209. static readonly NOTEQUAL: number;
  121210. /** Passed to stencilOperation to specify that stencil value must be kept */
  121211. static readonly KEEP: number;
  121212. /** Passed to stencilOperation to specify that stencil value must be replaced */
  121213. static readonly REPLACE: number;
  121214. /** Passed to stencilOperation to specify that stencil value must be incremented */
  121215. static readonly INCR: number;
  121216. /** Passed to stencilOperation to specify that stencil value must be decremented */
  121217. static readonly DECR: number;
  121218. /** Passed to stencilOperation to specify that stencil value must be inverted */
  121219. static readonly INVERT: number;
  121220. /** Passed to stencilOperation to specify that stencil value must be incremented with wrapping */
  121221. static readonly INCR_WRAP: number;
  121222. /** Passed to stencilOperation to specify that stencil value must be decremented with wrapping */
  121223. static readonly DECR_WRAP: number;
  121224. /** Texture is not repeating outside of 0..1 UVs */
  121225. static readonly TEXTURE_CLAMP_ADDRESSMODE: number;
  121226. /** Texture is repeating outside of 0..1 UVs */
  121227. static readonly TEXTURE_WRAP_ADDRESSMODE: number;
  121228. /** Texture is repeating and mirrored */
  121229. static readonly TEXTURE_MIRROR_ADDRESSMODE: number;
  121230. /** ALPHA */
  121231. static readonly TEXTUREFORMAT_ALPHA: number;
  121232. /** LUMINANCE */
  121233. static readonly TEXTUREFORMAT_LUMINANCE: number;
  121234. /** LUMINANCE_ALPHA */
  121235. static readonly TEXTUREFORMAT_LUMINANCE_ALPHA: number;
  121236. /** RGB */
  121237. static readonly TEXTUREFORMAT_RGB: number;
  121238. /** RGBA */
  121239. static readonly TEXTUREFORMAT_RGBA: number;
  121240. /** RED */
  121241. static readonly TEXTUREFORMAT_RED: number;
  121242. /** RED (2nd reference) */
  121243. static readonly TEXTUREFORMAT_R: number;
  121244. /** RG */
  121245. static readonly TEXTUREFORMAT_RG: number;
  121246. /** RED_INTEGER */
  121247. static readonly TEXTUREFORMAT_RED_INTEGER: number;
  121248. /** RED_INTEGER (2nd reference) */
  121249. static readonly TEXTUREFORMAT_R_INTEGER: number;
  121250. /** RG_INTEGER */
  121251. static readonly TEXTUREFORMAT_RG_INTEGER: number;
  121252. /** RGB_INTEGER */
  121253. static readonly TEXTUREFORMAT_RGB_INTEGER: number;
  121254. /** RGBA_INTEGER */
  121255. static readonly TEXTUREFORMAT_RGBA_INTEGER: number;
  121256. /** UNSIGNED_BYTE */
  121257. static readonly TEXTURETYPE_UNSIGNED_BYTE: number;
  121258. /** UNSIGNED_BYTE (2nd reference) */
  121259. static readonly TEXTURETYPE_UNSIGNED_INT: number;
  121260. /** FLOAT */
  121261. static readonly TEXTURETYPE_FLOAT: number;
  121262. /** HALF_FLOAT */
  121263. static readonly TEXTURETYPE_HALF_FLOAT: number;
  121264. /** BYTE */
  121265. static readonly TEXTURETYPE_BYTE: number;
  121266. /** SHORT */
  121267. static readonly TEXTURETYPE_SHORT: number;
  121268. /** UNSIGNED_SHORT */
  121269. static readonly TEXTURETYPE_UNSIGNED_SHORT: number;
  121270. /** INT */
  121271. static readonly TEXTURETYPE_INT: number;
  121272. /** UNSIGNED_INT */
  121273. static readonly TEXTURETYPE_UNSIGNED_INTEGER: number;
  121274. /** UNSIGNED_SHORT_4_4_4_4 */
  121275. static readonly TEXTURETYPE_UNSIGNED_SHORT_4_4_4_4: number;
  121276. /** UNSIGNED_SHORT_5_5_5_1 */
  121277. static readonly TEXTURETYPE_UNSIGNED_SHORT_5_5_5_1: number;
  121278. /** UNSIGNED_SHORT_5_6_5 */
  121279. static readonly TEXTURETYPE_UNSIGNED_SHORT_5_6_5: number;
  121280. /** UNSIGNED_INT_2_10_10_10_REV */
  121281. static readonly TEXTURETYPE_UNSIGNED_INT_2_10_10_10_REV: number;
  121282. /** UNSIGNED_INT_24_8 */
  121283. static readonly TEXTURETYPE_UNSIGNED_INT_24_8: number;
  121284. /** UNSIGNED_INT_10F_11F_11F_REV */
  121285. static readonly TEXTURETYPE_UNSIGNED_INT_10F_11F_11F_REV: number;
  121286. /** UNSIGNED_INT_5_9_9_9_REV */
  121287. static readonly TEXTURETYPE_UNSIGNED_INT_5_9_9_9_REV: number;
  121288. /** FLOAT_32_UNSIGNED_INT_24_8_REV */
  121289. static readonly TEXTURETYPE_FLOAT_32_UNSIGNED_INT_24_8_REV: number;
  121290. /** nearest is mag = nearest and min = nearest and mip = linear */
  121291. static readonly TEXTURE_NEAREST_SAMPLINGMODE: number;
  121292. /** Bilinear is mag = linear and min = linear and mip = nearest */
  121293. static readonly TEXTURE_BILINEAR_SAMPLINGMODE: number;
  121294. /** Trilinear is mag = linear and min = linear and mip = linear */
  121295. static readonly TEXTURE_TRILINEAR_SAMPLINGMODE: number;
  121296. /** nearest is mag = nearest and min = nearest and mip = linear */
  121297. static readonly TEXTURE_NEAREST_NEAREST_MIPLINEAR: number;
  121298. /** Bilinear is mag = linear and min = linear and mip = nearest */
  121299. static readonly TEXTURE_LINEAR_LINEAR_MIPNEAREST: number;
  121300. /** Trilinear is mag = linear and min = linear and mip = linear */
  121301. static readonly TEXTURE_LINEAR_LINEAR_MIPLINEAR: number;
  121302. /** mag = nearest and min = nearest and mip = nearest */
  121303. static readonly TEXTURE_NEAREST_NEAREST_MIPNEAREST: number;
  121304. /** mag = nearest and min = linear and mip = nearest */
  121305. static readonly TEXTURE_NEAREST_LINEAR_MIPNEAREST: number;
  121306. /** mag = nearest and min = linear and mip = linear */
  121307. static readonly TEXTURE_NEAREST_LINEAR_MIPLINEAR: number;
  121308. /** mag = nearest and min = linear and mip = none */
  121309. static readonly TEXTURE_NEAREST_LINEAR: number;
  121310. /** mag = nearest and min = nearest and mip = none */
  121311. static readonly TEXTURE_NEAREST_NEAREST: number;
  121312. /** mag = linear and min = nearest and mip = nearest */
  121313. static readonly TEXTURE_LINEAR_NEAREST_MIPNEAREST: number;
  121314. /** mag = linear and min = nearest and mip = linear */
  121315. static readonly TEXTURE_LINEAR_NEAREST_MIPLINEAR: number;
  121316. /** mag = linear and min = linear and mip = none */
  121317. static readonly TEXTURE_LINEAR_LINEAR: number;
  121318. /** mag = linear and min = nearest and mip = none */
  121319. static readonly TEXTURE_LINEAR_NEAREST: number;
  121320. /** Explicit coordinates mode */
  121321. static readonly TEXTURE_EXPLICIT_MODE: number;
  121322. /** Spherical coordinates mode */
  121323. static readonly TEXTURE_SPHERICAL_MODE: number;
  121324. /** Planar coordinates mode */
  121325. static readonly TEXTURE_PLANAR_MODE: number;
  121326. /** Cubic coordinates mode */
  121327. static readonly TEXTURE_CUBIC_MODE: number;
  121328. /** Projection coordinates mode */
  121329. static readonly TEXTURE_PROJECTION_MODE: number;
  121330. /** Skybox coordinates mode */
  121331. static readonly TEXTURE_SKYBOX_MODE: number;
  121332. /** Inverse Cubic coordinates mode */
  121333. static readonly TEXTURE_INVCUBIC_MODE: number;
  121334. /** Equirectangular coordinates mode */
  121335. static readonly TEXTURE_EQUIRECTANGULAR_MODE: number;
  121336. /** Equirectangular Fixed coordinates mode */
  121337. static readonly TEXTURE_FIXED_EQUIRECTANGULAR_MODE: number;
  121338. /** Equirectangular Fixed Mirrored coordinates mode */
  121339. static readonly TEXTURE_FIXED_EQUIRECTANGULAR_MIRRORED_MODE: number;
  121340. /** Defines that texture rescaling will use a floor to find the closer power of 2 size */
  121341. static readonly SCALEMODE_FLOOR: number;
  121342. /** Defines that texture rescaling will look for the nearest power of 2 size */
  121343. static readonly SCALEMODE_NEAREST: number;
  121344. /** Defines that texture rescaling will use a ceil to find the closer power of 2 size */
  121345. static readonly SCALEMODE_CEILING: number;
  121346. /**
  121347. * Returns the current npm package of the sdk
  121348. */
  121349. static get NpmPackage(): string;
  121350. /**
  121351. * Returns the current version of the framework
  121352. */
  121353. static get Version(): string;
  121354. /** Gets the list of created engines */
  121355. static get Instances(): Engine[];
  121356. /**
  121357. * Gets the latest created engine
  121358. */
  121359. static get LastCreatedEngine(): Nullable<Engine>;
  121360. /**
  121361. * Gets the latest created scene
  121362. */
  121363. static get LastCreatedScene(): Nullable<Scene>;
  121364. /**
  121365. * Will flag all materials in all scenes in all engines as dirty to trigger new shader compilation
  121366. * @param flag defines which part of the materials must be marked as dirty
  121367. * @param predicate defines a predicate used to filter which materials should be affected
  121368. */
  121369. static MarkAllMaterialsAsDirty(flag: number, predicate?: (mat: Material) => boolean): void;
  121370. /**
  121371. * Method called to create the default loading screen.
  121372. * This can be overriden in your own app.
  121373. * @param canvas The rendering canvas element
  121374. * @returns The loading screen
  121375. */
  121376. static DefaultLoadingScreenFactory(canvas: HTMLCanvasElement): ILoadingScreen;
  121377. /**
  121378. * Method called to create the default rescale post process on each engine.
  121379. */
  121380. static _RescalePostProcessFactory: Nullable<(engine: Engine) => PostProcess>;
  121381. /**
  121382. * Gets or sets a boolean to enable/disable IndexedDB support and avoid XHR on .manifest
  121383. **/
  121384. enableOfflineSupport: boolean;
  121385. /**
  121386. * 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)
  121387. **/
  121388. disableManifestCheck: boolean;
  121389. /**
  121390. * Gets the list of created scenes
  121391. */
  121392. scenes: Scene[];
  121393. /**
  121394. * Event raised when a new scene is created
  121395. */
  121396. onNewSceneAddedObservable: Observable<Scene>;
  121397. /**
  121398. * Gets the list of created postprocesses
  121399. */
  121400. postProcesses: PostProcess[];
  121401. /**
  121402. * Gets a boolean indicating if the pointer is currently locked
  121403. */
  121404. isPointerLock: boolean;
  121405. /**
  121406. * Observable event triggered each time the rendering canvas is resized
  121407. */
  121408. onResizeObservable: Observable<Engine>;
  121409. /**
  121410. * Observable event triggered each time the canvas loses focus
  121411. */
  121412. onCanvasBlurObservable: Observable<Engine>;
  121413. /**
  121414. * Observable event triggered each time the canvas gains focus
  121415. */
  121416. onCanvasFocusObservable: Observable<Engine>;
  121417. /**
  121418. * Observable event triggered each time the canvas receives pointerout event
  121419. */
  121420. onCanvasPointerOutObservable: Observable<PointerEvent>;
  121421. /**
  121422. * Observable raised when the engine begins a new frame
  121423. */
  121424. onBeginFrameObservable: Observable<Engine>;
  121425. /**
  121426. * If set, will be used to request the next animation frame for the render loop
  121427. */
  121428. customAnimationFrameRequester: Nullable<ICustomAnimationFrameRequester>;
  121429. /**
  121430. * Observable raised when the engine ends the current frame
  121431. */
  121432. onEndFrameObservable: Observable<Engine>;
  121433. /**
  121434. * Observable raised when the engine is about to compile a shader
  121435. */
  121436. onBeforeShaderCompilationObservable: Observable<Engine>;
  121437. /**
  121438. * Observable raised when the engine has jsut compiled a shader
  121439. */
  121440. onAfterShaderCompilationObservable: Observable<Engine>;
  121441. /**
  121442. * Gets the audio engine
  121443. * @see https://doc.babylonjs.com/how_to/playing_sounds_and_music
  121444. * @ignorenaming
  121445. */
  121446. static audioEngine: IAudioEngine;
  121447. /**
  121448. * Default AudioEngine factory responsible of creating the Audio Engine.
  121449. * By default, this will create a BabylonJS Audio Engine if the workload has been embedded.
  121450. */
  121451. static AudioEngineFactory: (hostElement: Nullable<HTMLElement>) => IAudioEngine;
  121452. /**
  121453. * Default offline support factory responsible of creating a tool used to store data locally.
  121454. * By default, this will create a Database object if the workload has been embedded.
  121455. */
  121456. static OfflineProviderFactory: (urlToScene: string, callbackManifestChecked: (checked: boolean) => any, disableManifestCheck: boolean) => IOfflineProvider;
  121457. private _loadingScreen;
  121458. private _pointerLockRequested;
  121459. private _rescalePostProcess;
  121460. private _deterministicLockstep;
  121461. private _lockstepMaxSteps;
  121462. private _timeStep;
  121463. protected get _supportsHardwareTextureRescaling(): boolean;
  121464. private _fps;
  121465. private _deltaTime;
  121466. /** @hidden */
  121467. _drawCalls: PerfCounter;
  121468. /** 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 */
  121469. canvasTabIndex: number;
  121470. /**
  121471. * Turn this value on if you want to pause FPS computation when in background
  121472. */
  121473. disablePerformanceMonitorInBackground: boolean;
  121474. private _performanceMonitor;
  121475. /**
  121476. * Gets the performance monitor attached to this engine
  121477. * @see https://doc.babylonjs.com/how_to/optimizing_your_scene#engineinstrumentation
  121478. */
  121479. get performanceMonitor(): PerformanceMonitor;
  121480. private _onFocus;
  121481. private _onBlur;
  121482. private _onCanvasPointerOut;
  121483. private _onCanvasBlur;
  121484. private _onCanvasFocus;
  121485. private _onFullscreenChange;
  121486. private _onPointerLockChange;
  121487. /**
  121488. * Gets the HTML element used to attach event listeners
  121489. * @returns a HTML element
  121490. */
  121491. getInputElement(): Nullable<HTMLElement>;
  121492. /**
  121493. * Creates a new engine
  121494. * @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
  121495. * @param antialias defines enable antialiasing (default: false)
  121496. * @param options defines further options to be sent to the getContext() function
  121497. * @param adaptToDeviceRatio defines whether to adapt to the device's viewport characteristics (default: false)
  121498. */
  121499. constructor(canvasOrContext: Nullable<HTMLCanvasElement | WebGLRenderingContext>, antialias?: boolean, options?: EngineOptions, adaptToDeviceRatio?: boolean);
  121500. /**
  121501. * Gets current aspect ratio
  121502. * @param viewportOwner defines the camera to use to get the aspect ratio
  121503. * @param useScreen defines if screen size must be used (or the current render target if any)
  121504. * @returns a number defining the aspect ratio
  121505. */
  121506. getAspectRatio(viewportOwner: IViewportOwnerLike, useScreen?: boolean): number;
  121507. /**
  121508. * Gets current screen aspect ratio
  121509. * @returns a number defining the aspect ratio
  121510. */
  121511. getScreenAspectRatio(): number;
  121512. /**
  121513. * Gets the client rect of the HTML canvas attached with the current webGL context
  121514. * @returns a client rectanglee
  121515. */
  121516. getRenderingCanvasClientRect(): Nullable<ClientRect>;
  121517. /**
  121518. * Gets the client rect of the HTML element used for events
  121519. * @returns a client rectanglee
  121520. */
  121521. getInputElementClientRect(): Nullable<ClientRect>;
  121522. /**
  121523. * Gets a boolean indicating that the engine is running in deterministic lock step mode
  121524. * @see https://doc.babylonjs.com/babylon101/animations#deterministic-lockstep
  121525. * @returns true if engine is in deterministic lock step mode
  121526. */
  121527. isDeterministicLockStep(): boolean;
  121528. /**
  121529. * Gets the max steps when engine is running in deterministic lock step
  121530. * @see https://doc.babylonjs.com/babylon101/animations#deterministic-lockstep
  121531. * @returns the max steps
  121532. */
  121533. getLockstepMaxSteps(): number;
  121534. /**
  121535. * Returns the time in ms between steps when using deterministic lock step.
  121536. * @returns time step in (ms)
  121537. */
  121538. getTimeStep(): number;
  121539. /**
  121540. * Force the mipmap generation for the given render target texture
  121541. * @param texture defines the render target texture to use
  121542. * @param unbind defines whether or not to unbind the texture after generation. Defaults to true.
  121543. */
  121544. generateMipMapsForCubemap(texture: InternalTexture, unbind?: boolean): void;
  121545. /** States */
  121546. /**
  121547. * Set various states to the webGL context
  121548. * @param culling defines backface culling state
  121549. * @param zOffset defines the value to apply to zOffset (0 by default)
  121550. * @param force defines if states must be applied even if cache is up to date
  121551. * @param reverseSide defines if culling must be reversed (CCW instead of CW and CW instead of CCW)
  121552. */
  121553. setState(culling: boolean, zOffset?: number, force?: boolean, reverseSide?: boolean): void;
  121554. /**
  121555. * Set the z offset to apply to current rendering
  121556. * @param value defines the offset to apply
  121557. */
  121558. setZOffset(value: number): void;
  121559. /**
  121560. * Gets the current value of the zOffset
  121561. * @returns the current zOffset state
  121562. */
  121563. getZOffset(): number;
  121564. /**
  121565. * Enable or disable depth buffering
  121566. * @param enable defines the state to set
  121567. */
  121568. setDepthBuffer(enable: boolean): void;
  121569. /**
  121570. * Gets a boolean indicating if depth writing is enabled
  121571. * @returns the current depth writing state
  121572. */
  121573. getDepthWrite(): boolean;
  121574. /**
  121575. * Enable or disable depth writing
  121576. * @param enable defines the state to set
  121577. */
  121578. setDepthWrite(enable: boolean): void;
  121579. /**
  121580. * Gets a boolean indicating if stencil buffer is enabled
  121581. * @returns the current stencil buffer state
  121582. */
  121583. getStencilBuffer(): boolean;
  121584. /**
  121585. * Enable or disable the stencil buffer
  121586. * @param enable defines if the stencil buffer must be enabled or disabled
  121587. */
  121588. setStencilBuffer(enable: boolean): void;
  121589. /**
  121590. * Gets the current stencil mask
  121591. * @returns a number defining the new stencil mask to use
  121592. */
  121593. getStencilMask(): number;
  121594. /**
  121595. * Sets the current stencil mask
  121596. * @param mask defines the new stencil mask to use
  121597. */
  121598. setStencilMask(mask: number): void;
  121599. /**
  121600. * Gets the current stencil function
  121601. * @returns a number defining the stencil function to use
  121602. */
  121603. getStencilFunction(): number;
  121604. /**
  121605. * Gets the current stencil reference value
  121606. * @returns a number defining the stencil reference value to use
  121607. */
  121608. getStencilFunctionReference(): number;
  121609. /**
  121610. * Gets the current stencil mask
  121611. * @returns a number defining the stencil mask to use
  121612. */
  121613. getStencilFunctionMask(): number;
  121614. /**
  121615. * Sets the current stencil function
  121616. * @param stencilFunc defines the new stencil function to use
  121617. */
  121618. setStencilFunction(stencilFunc: number): void;
  121619. /**
  121620. * Sets the current stencil reference
  121621. * @param reference defines the new stencil reference to use
  121622. */
  121623. setStencilFunctionReference(reference: number): void;
  121624. /**
  121625. * Sets the current stencil mask
  121626. * @param mask defines the new stencil mask to use
  121627. */
  121628. setStencilFunctionMask(mask: number): void;
  121629. /**
  121630. * Gets the current stencil operation when stencil fails
  121631. * @returns a number defining stencil operation to use when stencil fails
  121632. */
  121633. getStencilOperationFail(): number;
  121634. /**
  121635. * Gets the current stencil operation when depth fails
  121636. * @returns a number defining stencil operation to use when depth fails
  121637. */
  121638. getStencilOperationDepthFail(): number;
  121639. /**
  121640. * Gets the current stencil operation when stencil passes
  121641. * @returns a number defining stencil operation to use when stencil passes
  121642. */
  121643. getStencilOperationPass(): number;
  121644. /**
  121645. * Sets the stencil operation to use when stencil fails
  121646. * @param operation defines the stencil operation to use when stencil fails
  121647. */
  121648. setStencilOperationFail(operation: number): void;
  121649. /**
  121650. * Sets the stencil operation to use when depth fails
  121651. * @param operation defines the stencil operation to use when depth fails
  121652. */
  121653. setStencilOperationDepthFail(operation: number): void;
  121654. /**
  121655. * Sets the stencil operation to use when stencil passes
  121656. * @param operation defines the stencil operation to use when stencil passes
  121657. */
  121658. setStencilOperationPass(operation: number): void;
  121659. /**
  121660. * Sets a boolean indicating if the dithering state is enabled or disabled
  121661. * @param value defines the dithering state
  121662. */
  121663. setDitheringState(value: boolean): void;
  121664. /**
  121665. * Sets a boolean indicating if the rasterizer state is enabled or disabled
  121666. * @param value defines the rasterizer state
  121667. */
  121668. setRasterizerState(value: boolean): void;
  121669. /**
  121670. * Gets the current depth function
  121671. * @returns a number defining the depth function
  121672. */
  121673. getDepthFunction(): Nullable<number>;
  121674. /**
  121675. * Sets the current depth function
  121676. * @param depthFunc defines the function to use
  121677. */
  121678. setDepthFunction(depthFunc: number): void;
  121679. /**
  121680. * Sets the current depth function to GREATER
  121681. */
  121682. setDepthFunctionToGreater(): void;
  121683. /**
  121684. * Sets the current depth function to GEQUAL
  121685. */
  121686. setDepthFunctionToGreaterOrEqual(): void;
  121687. /**
  121688. * Sets the current depth function to LESS
  121689. */
  121690. setDepthFunctionToLess(): void;
  121691. /**
  121692. * Sets the current depth function to LEQUAL
  121693. */
  121694. setDepthFunctionToLessOrEqual(): void;
  121695. private _cachedStencilBuffer;
  121696. private _cachedStencilFunction;
  121697. private _cachedStencilMask;
  121698. private _cachedStencilOperationPass;
  121699. private _cachedStencilOperationFail;
  121700. private _cachedStencilOperationDepthFail;
  121701. private _cachedStencilReference;
  121702. /**
  121703. * Caches the the state of the stencil buffer
  121704. */
  121705. cacheStencilState(): void;
  121706. /**
  121707. * Restores the state of the stencil buffer
  121708. */
  121709. restoreStencilState(): void;
  121710. /**
  121711. * Directly set the WebGL Viewport
  121712. * @param x defines the x coordinate of the viewport (in screen space)
  121713. * @param y defines the y coordinate of the viewport (in screen space)
  121714. * @param width defines the width of the viewport (in screen space)
  121715. * @param height defines the height of the viewport (in screen space)
  121716. * @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
  121717. */
  121718. setDirectViewport(x: number, y: number, width: number, height: number): Nullable<IViewportLike>;
  121719. /**
  121720. * Executes a scissor clear (ie. a clear on a specific portion of the screen)
  121721. * @param x defines the x-coordinate of the top left corner of the clear rectangle
  121722. * @param y defines the y-coordinate of the corner of the clear rectangle
  121723. * @param width defines the width of the clear rectangle
  121724. * @param height defines the height of the clear rectangle
  121725. * @param clearColor defines the clear color
  121726. */
  121727. scissorClear(x: number, y: number, width: number, height: number, clearColor: IColor4Like): void;
  121728. /**
  121729. * Enable scissor test on a specific rectangle (ie. render will only be executed on a specific portion of the screen)
  121730. * @param x defines the x-coordinate of the top left corner of the clear rectangle
  121731. * @param y defines the y-coordinate of the corner of the clear rectangle
  121732. * @param width defines the width of the clear rectangle
  121733. * @param height defines the height of the clear rectangle
  121734. */
  121735. enableScissor(x: number, y: number, width: number, height: number): void;
  121736. /**
  121737. * Disable previously set scissor test rectangle
  121738. */
  121739. disableScissor(): void;
  121740. protected _reportDrawCall(): void;
  121741. /**
  121742. * Initializes a webVR display and starts listening to display change events
  121743. * The onVRDisplayChangedObservable will be notified upon these changes
  121744. * @returns The onVRDisplayChangedObservable
  121745. */
  121746. initWebVR(): Observable<IDisplayChangedEventArgs>;
  121747. /** @hidden */
  121748. _prepareVRComponent(): void;
  121749. /** @hidden */
  121750. _connectVREvents(canvas?: HTMLCanvasElement, document?: any): void;
  121751. /** @hidden */
  121752. _submitVRFrame(): void;
  121753. /**
  121754. * Call this function to leave webVR mode
  121755. * Will do nothing if webVR is not supported or if there is no webVR device
  121756. * @see https://doc.babylonjs.com/how_to/webvr_camera
  121757. */
  121758. disableVR(): void;
  121759. /**
  121760. * Gets a boolean indicating that the system is in VR mode and is presenting
  121761. * @returns true if VR mode is engaged
  121762. */
  121763. isVRPresenting(): boolean;
  121764. /** @hidden */
  121765. _requestVRFrame(): void;
  121766. /** @hidden */
  121767. _loadFileAsync(url: string, offlineProvider?: IOfflineProvider, useArrayBuffer?: boolean): Promise<string | ArrayBuffer>;
  121768. /**
  121769. * Gets the source code of the vertex shader associated with a specific webGL program
  121770. * @param program defines the program to use
  121771. * @returns a string containing the source code of the vertex shader associated with the program
  121772. */
  121773. getVertexShaderSource(program: WebGLProgram): Nullable<string>;
  121774. /**
  121775. * Gets the source code of the fragment shader associated with a specific webGL program
  121776. * @param program defines the program to use
  121777. * @returns a string containing the source code of the fragment shader associated with the program
  121778. */
  121779. getFragmentShaderSource(program: WebGLProgram): Nullable<string>;
  121780. /**
  121781. * Sets a depth stencil texture from a render target to the according uniform.
  121782. * @param channel The texture channel
  121783. * @param uniform The uniform to set
  121784. * @param texture The render target texture containing the depth stencil texture to apply
  121785. */
  121786. setDepthStencilTexture(channel: number, uniform: Nullable<WebGLUniformLocation>, texture: Nullable<RenderTargetTexture>): void;
  121787. /**
  121788. * Sets a texture to the webGL context from a postprocess
  121789. * @param channel defines the channel to use
  121790. * @param postProcess defines the source postprocess
  121791. */
  121792. setTextureFromPostProcess(channel: number, postProcess: Nullable<PostProcess>): void;
  121793. /**
  121794. * Binds the output of the passed in post process to the texture channel specified
  121795. * @param channel The channel the texture should be bound to
  121796. * @param postProcess The post process which's output should be bound
  121797. */
  121798. setTextureFromPostProcessOutput(channel: number, postProcess: Nullable<PostProcess>): void;
  121799. protected _rebuildBuffers(): void;
  121800. /** @hidden */
  121801. _renderFrame(): void;
  121802. _renderLoop(): void;
  121803. /** @hidden */
  121804. _renderViews(): boolean;
  121805. /**
  121806. * Toggle full screen mode
  121807. * @param requestPointerLock defines if a pointer lock should be requested from the user
  121808. */
  121809. switchFullscreen(requestPointerLock: boolean): void;
  121810. /**
  121811. * Enters full screen mode
  121812. * @param requestPointerLock defines if a pointer lock should be requested from the user
  121813. */
  121814. enterFullscreen(requestPointerLock: boolean): void;
  121815. /**
  121816. * Exits full screen mode
  121817. */
  121818. exitFullscreen(): void;
  121819. /**
  121820. * Enters Pointerlock mode
  121821. */
  121822. enterPointerlock(): void;
  121823. /**
  121824. * Exits Pointerlock mode
  121825. */
  121826. exitPointerlock(): void;
  121827. /**
  121828. * Begin a new frame
  121829. */
  121830. beginFrame(): void;
  121831. /**
  121832. * Enf the current frame
  121833. */
  121834. endFrame(): void;
  121835. resize(): void;
  121836. /**
  121837. * Force a specific size of the canvas
  121838. * @param width defines the new canvas' width
  121839. * @param height defines the new canvas' height
  121840. * @returns true if the size was changed
  121841. */
  121842. setSize(width: number, height: number): boolean;
  121843. _deletePipelineContext(pipelineContext: IPipelineContext): void;
  121844. createShaderProgram(pipelineContext: IPipelineContext, vertexCode: string, fragmentCode: string, defines: Nullable<string>, context?: WebGLRenderingContext, transformFeedbackVaryings?: Nullable<string[]>): WebGLProgram;
  121845. protected _createShaderProgram(pipelineContext: WebGLPipelineContext, vertexShader: WebGLShader, fragmentShader: WebGLShader, context: WebGLRenderingContext, transformFeedbackVaryings?: Nullable<string[]>): WebGLProgram;
  121846. _releaseTexture(texture: InternalTexture): void;
  121847. /**
  121848. * @hidden
  121849. * Rescales a texture
  121850. * @param source input texutre
  121851. * @param destination destination texture
  121852. * @param scene scene to use to render the resize
  121853. * @param internalFormat format to use when resizing
  121854. * @param onComplete callback to be called when resize has completed
  121855. */
  121856. _rescaleTexture(source: InternalTexture, destination: InternalTexture, scene: Nullable<any>, internalFormat: number, onComplete: () => void): void;
  121857. /**
  121858. * Gets the current framerate
  121859. * @returns a number representing the framerate
  121860. */
  121861. getFps(): number;
  121862. /**
  121863. * Gets the time spent between current and previous frame
  121864. * @returns a number representing the delta time in ms
  121865. */
  121866. getDeltaTime(): number;
  121867. private _measureFps;
  121868. /** @hidden */
  121869. _uploadImageToTexture(texture: InternalTexture, image: HTMLImageElement | ImageBitmap, faceIndex?: number, lod?: number): void;
  121870. /**
  121871. * Updates the sample count of a render target texture
  121872. * @see https://doc.babylonjs.com/features/webgl2#multisample-render-targets
  121873. * @param texture defines the texture to update
  121874. * @param samples defines the sample count to set
  121875. * @returns the effective sample count (could be 0 if multisample render targets are not supported)
  121876. */
  121877. updateRenderTargetTextureSampleCount(texture: Nullable<InternalTexture>, samples: number): number;
  121878. /**
  121879. * Updates a depth texture Comparison Mode and Function.
  121880. * If the comparison Function is equal to 0, the mode will be set to none.
  121881. * Otherwise, this only works in webgl 2 and requires a shadow sampler in the shader.
  121882. * @param texture The texture to set the comparison function for
  121883. * @param comparisonFunction The comparison function to set, 0 if no comparison required
  121884. */
  121885. updateTextureComparisonFunction(texture: InternalTexture, comparisonFunction: number): void;
  121886. /**
  121887. * Creates a webGL buffer to use with instanciation
  121888. * @param capacity defines the size of the buffer
  121889. * @returns the webGL buffer
  121890. */
  121891. createInstancesBuffer(capacity: number): DataBuffer;
  121892. /**
  121893. * Delete a webGL buffer used with instanciation
  121894. * @param buffer defines the webGL buffer to delete
  121895. */
  121896. deleteInstancesBuffer(buffer: WebGLBuffer): void;
  121897. private _clientWaitAsync;
  121898. /** @hidden */
  121899. _readPixelsAsync(x: number, y: number, w: number, h: number, format: number, type: number, outputBuffer: ArrayBufferView): Promise<ArrayBufferView> | null;
  121900. dispose(): void;
  121901. private _disableTouchAction;
  121902. /**
  121903. * Display the loading screen
  121904. * @see https://doc.babylonjs.com/how_to/creating_a_custom_loading_screen
  121905. */
  121906. displayLoadingUI(): void;
  121907. /**
  121908. * Hide the loading screen
  121909. * @see https://doc.babylonjs.com/how_to/creating_a_custom_loading_screen
  121910. */
  121911. hideLoadingUI(): void;
  121912. /**
  121913. * Gets the current loading screen object
  121914. * @see https://doc.babylonjs.com/how_to/creating_a_custom_loading_screen
  121915. */
  121916. get loadingScreen(): ILoadingScreen;
  121917. /**
  121918. * Sets the current loading screen object
  121919. * @see https://doc.babylonjs.com/how_to/creating_a_custom_loading_screen
  121920. */
  121921. set loadingScreen(loadingScreen: ILoadingScreen);
  121922. /**
  121923. * Sets the current loading screen text
  121924. * @see https://doc.babylonjs.com/how_to/creating_a_custom_loading_screen
  121925. */
  121926. set loadingUIText(text: string);
  121927. /**
  121928. * Sets the current loading screen background color
  121929. * @see https://doc.babylonjs.com/how_to/creating_a_custom_loading_screen
  121930. */
  121931. set loadingUIBackgroundColor(color: string);
  121932. /** Pointerlock and fullscreen */
  121933. /**
  121934. * Ask the browser to promote the current element to pointerlock mode
  121935. * @param element defines the DOM element to promote
  121936. */
  121937. static _RequestPointerlock(element: HTMLElement): void;
  121938. /**
  121939. * Asks the browser to exit pointerlock mode
  121940. */
  121941. static _ExitPointerlock(): void;
  121942. /**
  121943. * Ask the browser to promote the current element to fullscreen rendering mode
  121944. * @param element defines the DOM element to promote
  121945. */
  121946. static _RequestFullscreen(element: HTMLElement): void;
  121947. /**
  121948. * Asks the browser to exit fullscreen mode
  121949. */
  121950. static _ExitFullscreen(): void;
  121951. }
  121952. }
  121953. declare module BABYLON {
  121954. /**
  121955. * The engine store class is responsible to hold all the instances of Engine and Scene created
  121956. * during the life time of the application.
  121957. */
  121958. export class EngineStore {
  121959. /** Gets the list of created engines */
  121960. static Instances: Engine[];
  121961. /** @hidden */
  121962. static _LastCreatedScene: Nullable<Scene>;
  121963. /**
  121964. * Gets the latest created engine
  121965. */
  121966. static get LastCreatedEngine(): Nullable<Engine>;
  121967. /**
  121968. * Gets the latest created scene
  121969. */
  121970. static get LastCreatedScene(): Nullable<Scene>;
  121971. /**
  121972. * Gets or sets a global variable indicating if fallback texture must be used when a texture cannot be loaded
  121973. * @ignorenaming
  121974. */
  121975. static UseFallbackTexture: boolean;
  121976. /**
  121977. * Texture content used if a texture cannot loaded
  121978. * @ignorenaming
  121979. */
  121980. static FallbackTexture: string;
  121981. }
  121982. }
  121983. declare module BABYLON {
  121984. /**
  121985. * Helper class that provides a small promise polyfill
  121986. */
  121987. export class PromisePolyfill {
  121988. /**
  121989. * Static function used to check if the polyfill is required
  121990. * If this is the case then the function will inject the polyfill to window.Promise
  121991. * @param force defines a boolean used to force the injection (mostly for testing purposes)
  121992. */
  121993. static Apply(force?: boolean): void;
  121994. }
  121995. }
  121996. declare module BABYLON {
  121997. /**
  121998. * Interface for screenshot methods with describe argument called `size` as object with options
  121999. * @link https://doc.babylonjs.com/api/classes/babylon.screenshottools
  122000. */
  122001. export interface IScreenshotSize {
  122002. /**
  122003. * number in pixels for canvas height
  122004. */
  122005. height?: number;
  122006. /**
  122007. * multiplier allowing render at a higher or lower resolution
  122008. * If value is defined then height and width will be ignored and taken from camera
  122009. */
  122010. precision?: number;
  122011. /**
  122012. * number in pixels for canvas width
  122013. */
  122014. width?: number;
  122015. }
  122016. }
  122017. declare module BABYLON {
  122018. interface IColor4Like {
  122019. r: float;
  122020. g: float;
  122021. b: float;
  122022. a: float;
  122023. }
  122024. /**
  122025. * Class containing a set of static utilities functions
  122026. */
  122027. export class Tools {
  122028. /**
  122029. * Gets or sets the base URL to use to load assets
  122030. */
  122031. static get BaseUrl(): string;
  122032. static set BaseUrl(value: string);
  122033. /**
  122034. * Enable/Disable Custom HTTP Request Headers globally.
  122035. * default = false
  122036. * @see CustomRequestHeaders
  122037. */
  122038. static UseCustomRequestHeaders: boolean;
  122039. /**
  122040. * Custom HTTP Request Headers to be sent with XMLHttpRequests
  122041. * i.e. when loading files, where the server/service expects an Authorization header
  122042. */
  122043. static CustomRequestHeaders: {
  122044. [key: string]: string;
  122045. };
  122046. /**
  122047. * Gets or sets the retry strategy to apply when an error happens while loading an asset
  122048. */
  122049. static get DefaultRetryStrategy(): (url: string, request: WebRequest, retryIndex: number) => number;
  122050. static set DefaultRetryStrategy(strategy: (url: string, request: WebRequest, retryIndex: number) => number);
  122051. /**
  122052. * Default behaviour for cors in the application.
  122053. * It can be a string if the expected behavior is identical in the entire app.
  122054. * Or a callback to be able to set it per url or on a group of them (in case of Video source for instance)
  122055. */
  122056. static get CorsBehavior(): string | ((url: string | string[]) => string);
  122057. static set CorsBehavior(value: string | ((url: string | string[]) => string));
  122058. /**
  122059. * Gets or sets a global variable indicating if fallback texture must be used when a texture cannot be loaded
  122060. * @ignorenaming
  122061. */
  122062. static get UseFallbackTexture(): boolean;
  122063. static set UseFallbackTexture(value: boolean);
  122064. /**
  122065. * Use this object to register external classes like custom textures or material
  122066. * to allow the laoders to instantiate them
  122067. */
  122068. static get RegisteredExternalClasses(): {
  122069. [key: string]: Object;
  122070. };
  122071. static set RegisteredExternalClasses(classes: {
  122072. [key: string]: Object;
  122073. });
  122074. /**
  122075. * Texture content used if a texture cannot loaded
  122076. * @ignorenaming
  122077. */
  122078. static get fallbackTexture(): string;
  122079. static set fallbackTexture(value: string);
  122080. /**
  122081. * Read the content of a byte array at a specified coordinates (taking in account wrapping)
  122082. * @param u defines the coordinate on X axis
  122083. * @param v defines the coordinate on Y axis
  122084. * @param width defines the width of the source data
  122085. * @param height defines the height of the source data
  122086. * @param pixels defines the source byte array
  122087. * @param color defines the output color
  122088. */
  122089. static FetchToRef(u: number, v: number, width: number, height: number, pixels: Uint8Array, color: IColor4Like): void;
  122090. /**
  122091. * Interpolates between a and b via alpha
  122092. * @param a The lower value (returned when alpha = 0)
  122093. * @param b The upper value (returned when alpha = 1)
  122094. * @param alpha The interpolation-factor
  122095. * @return The mixed value
  122096. */
  122097. static Mix(a: number, b: number, alpha: number): number;
  122098. /**
  122099. * Tries to instantiate a new object from a given class name
  122100. * @param className defines the class name to instantiate
  122101. * @returns the new object or null if the system was not able to do the instantiation
  122102. */
  122103. static Instantiate(className: string): any;
  122104. /**
  122105. * Provides a slice function that will work even on IE
  122106. * @param data defines the array to slice
  122107. * @param start defines the start of the data (optional)
  122108. * @param end defines the end of the data (optional)
  122109. * @returns the new sliced array
  122110. */
  122111. static Slice<T>(data: T, start?: number, end?: number): T;
  122112. /**
  122113. * Polyfill for setImmediate
  122114. * @param action defines the action to execute after the current execution block
  122115. */
  122116. static SetImmediate(action: () => void): void;
  122117. /**
  122118. * Function indicating if a number is an exponent of 2
  122119. * @param value defines the value to test
  122120. * @returns true if the value is an exponent of 2
  122121. */
  122122. static IsExponentOfTwo(value: number): boolean;
  122123. private static _tmpFloatArray;
  122124. /**
  122125. * Returns the nearest 32-bit single precision float representation of a Number
  122126. * @param value A Number. If the parameter is of a different type, it will get converted
  122127. * to a number or to NaN if it cannot be converted
  122128. * @returns number
  122129. */
  122130. static FloatRound(value: number): number;
  122131. /**
  122132. * Extracts the filename from a path
  122133. * @param path defines the path to use
  122134. * @returns the filename
  122135. */
  122136. static GetFilename(path: string): string;
  122137. /**
  122138. * Extracts the "folder" part of a path (everything before the filename).
  122139. * @param uri The URI to extract the info from
  122140. * @param returnUnchangedIfNoSlash Do not touch the URI if no slashes are present
  122141. * @returns The "folder" part of the path
  122142. */
  122143. static GetFolderPath(uri: string, returnUnchangedIfNoSlash?: boolean): string;
  122144. /**
  122145. * Extracts text content from a DOM element hierarchy
  122146. * Back Compat only, please use DomManagement.GetDOMTextContent instead.
  122147. */
  122148. static GetDOMTextContent: typeof DomManagement.GetDOMTextContent;
  122149. /**
  122150. * Convert an angle in radians to degrees
  122151. * @param angle defines the angle to convert
  122152. * @returns the angle in degrees
  122153. */
  122154. static ToDegrees(angle: number): number;
  122155. /**
  122156. * Convert an angle in degrees to radians
  122157. * @param angle defines the angle to convert
  122158. * @returns the angle in radians
  122159. */
  122160. static ToRadians(angle: number): number;
  122161. /**
  122162. * Returns an array if obj is not an array
  122163. * @param obj defines the object to evaluate as an array
  122164. * @param allowsNullUndefined defines a boolean indicating if obj is allowed to be null or undefined
  122165. * @returns either obj directly if obj is an array or a new array containing obj
  122166. */
  122167. static MakeArray(obj: any, allowsNullUndefined?: boolean): Nullable<Array<any>>;
  122168. /**
  122169. * Gets the pointer prefix to use
  122170. * @param engine defines the engine we are finding the prefix for
  122171. * @returns "pointer" if touch is enabled. Else returns "mouse"
  122172. */
  122173. static GetPointerPrefix(engine: Engine): string;
  122174. /**
  122175. * Sets the cors behavior on a dom element. This will add the required Tools.CorsBehavior to the element.
  122176. * @param url define the url we are trying
  122177. * @param element define the dom element where to configure the cors policy
  122178. */
  122179. static SetCorsBehavior(url: string | string[], element: {
  122180. crossOrigin: string | null;
  122181. }): void;
  122182. /**
  122183. * Removes unwanted characters from an url
  122184. * @param url defines the url to clean
  122185. * @returns the cleaned url
  122186. */
  122187. static CleanUrl(url: string): string;
  122188. /**
  122189. * Gets or sets a function used to pre-process url before using them to load assets
  122190. */
  122191. static get PreprocessUrl(): (url: string) => string;
  122192. static set PreprocessUrl(processor: (url: string) => string);
  122193. /**
  122194. * Loads an image as an HTMLImageElement.
  122195. * @param input url string, ArrayBuffer, or Blob to load
  122196. * @param onLoad callback called when the image successfully loads
  122197. * @param onError callback called when the image fails to load
  122198. * @param offlineProvider offline provider for caching
  122199. * @param mimeType optional mime type
  122200. * @returns the HTMLImageElement of the loaded image
  122201. */
  122202. static LoadImage(input: string | ArrayBuffer | Blob, onLoad: (img: HTMLImageElement | ImageBitmap) => void, onError: (message?: string, exception?: any) => void, offlineProvider: Nullable<IOfflineProvider>, mimeType?: string): Nullable<HTMLImageElement>;
  122203. /**
  122204. * Loads a file from a url
  122205. * @param url url string, ArrayBuffer, or Blob to load
  122206. * @param onSuccess callback called when the file successfully loads
  122207. * @param onProgress callback called while file is loading (if the server supports this mode)
  122208. * @param offlineProvider defines the offline provider for caching
  122209. * @param useArrayBuffer defines a boolean indicating that date must be returned as ArrayBuffer
  122210. * @param onError callback called when the file fails to load
  122211. * @returns a file request object
  122212. */
  122213. 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;
  122214. /**
  122215. * Loads a file from a url
  122216. * @param url the file url to load
  122217. * @param useArrayBuffer defines a boolean indicating that date must be returned as ArrayBuffer
  122218. * @returns a promise containing an ArrayBuffer corresponding to the loaded file
  122219. */
  122220. static LoadFileAsync(url: string, useArrayBuffer?: boolean): Promise<ArrayBuffer | string>;
  122221. /**
  122222. * Load a script (identified by an url). When the url returns, the
  122223. * content of this file is added into a new script element, attached to the DOM (body element)
  122224. * @param scriptUrl defines the url of the script to laod
  122225. * @param onSuccess defines the callback called when the script is loaded
  122226. * @param onError defines the callback to call if an error occurs
  122227. * @param scriptId defines the id of the script element
  122228. */
  122229. static LoadScript(scriptUrl: string, onSuccess: () => void, onError?: (message?: string, exception?: any) => void, scriptId?: string): void;
  122230. /**
  122231. * Load an asynchronous script (identified by an url). When the url returns, the
  122232. * content of this file is added into a new script element, attached to the DOM (body element)
  122233. * @param scriptUrl defines the url of the script to laod
  122234. * @param scriptId defines the id of the script element
  122235. * @returns a promise request object
  122236. */
  122237. static LoadScriptAsync(scriptUrl: string, scriptId?: string): Promise<void>;
  122238. /**
  122239. * Loads a file from a blob
  122240. * @param fileToLoad defines the blob to use
  122241. * @param callback defines the callback to call when data is loaded
  122242. * @param progressCallback defines the callback to call during loading process
  122243. * @returns a file request object
  122244. */
  122245. static ReadFileAsDataURL(fileToLoad: Blob, callback: (data: any) => void, progressCallback: (ev: ProgressEvent) => any): IFileRequest;
  122246. /**
  122247. * Reads a file from a File object
  122248. * @param file defines the file to load
  122249. * @param onSuccess defines the callback to call when data is loaded
  122250. * @param onProgress defines the callback to call during loading process
  122251. * @param useArrayBuffer defines a boolean indicating that data must be returned as an ArrayBuffer
  122252. * @param onError defines the callback to call when an error occurs
  122253. * @returns a file request object
  122254. */
  122255. static ReadFile(file: File, onSuccess: (data: any) => void, onProgress?: (ev: ProgressEvent) => any, useArrayBuffer?: boolean, onError?: (error: ReadFileError) => void): IFileRequest;
  122256. /**
  122257. * Creates a data url from a given string content
  122258. * @param content defines the content to convert
  122259. * @returns the new data url link
  122260. */
  122261. static FileAsURL(content: string): string;
  122262. /**
  122263. * Format the given number to a specific decimal format
  122264. * @param value defines the number to format
  122265. * @param decimals defines the number of decimals to use
  122266. * @returns the formatted string
  122267. */
  122268. static Format(value: number, decimals?: number): string;
  122269. /**
  122270. * Tries to copy an object by duplicating every property
  122271. * @param source defines the source object
  122272. * @param destination defines the target object
  122273. * @param doNotCopyList defines a list of properties to avoid
  122274. * @param mustCopyList defines a list of properties to copy (even if they start with _)
  122275. */
  122276. static DeepCopy(source: any, destination: any, doNotCopyList?: string[], mustCopyList?: string[]): void;
  122277. /**
  122278. * Gets a boolean indicating if the given object has no own property
  122279. * @param obj defines the object to test
  122280. * @returns true if object has no own property
  122281. */
  122282. static IsEmpty(obj: any): boolean;
  122283. /**
  122284. * Function used to register events at window level
  122285. * @param windowElement defines the Window object to use
  122286. * @param events defines the events to register
  122287. */
  122288. static RegisterTopRootEvents(windowElement: Window, events: {
  122289. name: string;
  122290. handler: Nullable<(e: FocusEvent) => any>;
  122291. }[]): void;
  122292. /**
  122293. * Function used to unregister events from window level
  122294. * @param windowElement defines the Window object to use
  122295. * @param events defines the events to unregister
  122296. */
  122297. static UnregisterTopRootEvents(windowElement: Window, events: {
  122298. name: string;
  122299. handler: Nullable<(e: FocusEvent) => any>;
  122300. }[]): void;
  122301. /**
  122302. * @ignore
  122303. */
  122304. static _ScreenshotCanvas: HTMLCanvasElement;
  122305. /**
  122306. * Dumps the current bound framebuffer
  122307. * @param width defines the rendering width
  122308. * @param height defines the rendering height
  122309. * @param engine defines the hosting engine
  122310. * @param successCallback defines the callback triggered once the data are available
  122311. * @param mimeType defines the mime type of the result
  122312. * @param fileName defines the filename to download. If present, the result will automatically be downloaded
  122313. */
  122314. static DumpFramebuffer(width: number, height: number, engine: Engine, successCallback?: (data: string) => void, mimeType?: string, fileName?: string): void;
  122315. /**
  122316. * Converts the canvas data to blob.
  122317. * This acts as a polyfill for browsers not supporting the to blob function.
  122318. * @param canvas Defines the canvas to extract the data from
  122319. * @param successCallback Defines the callback triggered once the data are available
  122320. * @param mimeType Defines the mime type of the result
  122321. */
  122322. static ToBlob(canvas: HTMLCanvasElement, successCallback: (blob: Nullable<Blob>) => void, mimeType?: string): void;
  122323. /**
  122324. * Encodes the canvas data to base 64 or automatically download the result if filename is defined
  122325. * @param successCallback defines the callback triggered once the data are available
  122326. * @param mimeType defines the mime type of the result
  122327. * @param fileName defines he filename to download. If present, the result will automatically be downloaded
  122328. */
  122329. static EncodeScreenshotCanvasData(successCallback?: (data: string) => void, mimeType?: string, fileName?: string): void;
  122330. /**
  122331. * Downloads a blob in the browser
  122332. * @param blob defines the blob to download
  122333. * @param fileName defines the name of the downloaded file
  122334. */
  122335. static Download(blob: Blob, fileName: string): void;
  122336. /**
  122337. * Captures a screenshot of the current rendering
  122338. * @see https://doc.babylonjs.com/how_to/render_scene_on_a_png
  122339. * @param engine defines the rendering engine
  122340. * @param camera defines the source camera
  122341. * @param size This parameter can be set to a single number or to an object with the
  122342. * following (optional) properties: precision, width, height. If a single number is passed,
  122343. * it will be used for both width and height. If an object is passed, the screenshot size
  122344. * will be derived from the parameters. The precision property is a multiplier allowing
  122345. * rendering at a higher or lower resolution
  122346. * @param successCallback defines the callback receives a single parameter which contains the
  122347. * screenshot as a string of base64-encoded characters. This string can be assigned to the
  122348. * src parameter of an <img> to display it
  122349. * @param mimeType defines the MIME type of the screenshot image (default: image/png).
  122350. * Check your browser for supported MIME types
  122351. */
  122352. static CreateScreenshot(engine: Engine, camera: Camera, size: IScreenshotSize | number, successCallback?: (data: string) => void, mimeType?: string): void;
  122353. /**
  122354. * Captures a screenshot of the current rendering
  122355. * @see https://doc.babylonjs.com/how_to/render_scene_on_a_png
  122356. * @param engine defines the rendering engine
  122357. * @param camera defines the source camera
  122358. * @param size This parameter can be set to a single number or to an object with the
  122359. * following (optional) properties: precision, width, height. If a single number is passed,
  122360. * it will be used for both width and height. If an object is passed, the screenshot size
  122361. * will be derived from the parameters. The precision property is a multiplier allowing
  122362. * rendering at a higher or lower resolution
  122363. * @param mimeType defines the MIME type of the screenshot image (default: image/png).
  122364. * Check your browser for supported MIME types
  122365. * @returns screenshot as a string of base64-encoded characters. This string can be assigned
  122366. * to the src parameter of an <img> to display it
  122367. */
  122368. static CreateScreenshotAsync(engine: Engine, camera: Camera, size: IScreenshotSize | number, mimeType?: string): Promise<string>;
  122369. /**
  122370. * Generates an image screenshot from the specified camera.
  122371. * @see https://doc.babylonjs.com/how_to/render_scene_on_a_png
  122372. * @param engine The engine to use for rendering
  122373. * @param camera The camera to use for rendering
  122374. * @param size This parameter can be set to a single number or to an object with the
  122375. * following (optional) properties: precision, width, height. If a single number is passed,
  122376. * it will be used for both width and height. If an object is passed, the screenshot size
  122377. * will be derived from the parameters. The precision property is a multiplier allowing
  122378. * rendering at a higher or lower resolution
  122379. * @param successCallback The callback receives a single parameter which contains the
  122380. * screenshot as a string of base64-encoded characters. This string can be assigned to the
  122381. * src parameter of an <img> to display it
  122382. * @param mimeType The MIME type of the screenshot image (default: image/png).
  122383. * Check your browser for supported MIME types
  122384. * @param samples Texture samples (default: 1)
  122385. * @param antialiasing Whether antialiasing should be turned on or not (default: false)
  122386. * @param fileName A name for for the downloaded file.
  122387. */
  122388. static CreateScreenshotUsingRenderTarget(engine: Engine, camera: Camera, size: IScreenshotSize | number, successCallback?: (data: string) => void, mimeType?: string, samples?: number, antialiasing?: boolean, fileName?: string): void;
  122389. /**
  122390. * Generates an image screenshot from the specified camera.
  122391. * @see https://doc.babylonjs.com/how_to/render_scene_on_a_png
  122392. * @param engine The engine to use for rendering
  122393. * @param camera The camera to use for rendering
  122394. * @param size This parameter can be set to a single number or to an object with the
  122395. * following (optional) properties: precision, width, height. If a single number is passed,
  122396. * it will be used for both width and height. If an object is passed, the screenshot size
  122397. * will be derived from the parameters. The precision property is a multiplier allowing
  122398. * rendering at a higher or lower resolution
  122399. * @param mimeType The MIME type of the screenshot image (default: image/png).
  122400. * Check your browser for supported MIME types
  122401. * @param samples Texture samples (default: 1)
  122402. * @param antialiasing Whether antialiasing should be turned on or not (default: false)
  122403. * @param fileName A name for for the downloaded file.
  122404. * @returns screenshot as a string of base64-encoded characters. This string can be assigned
  122405. * to the src parameter of an <img> to display it
  122406. */
  122407. static CreateScreenshotUsingRenderTargetAsync(engine: Engine, camera: Camera, size: IScreenshotSize | number, mimeType?: string, samples?: number, antialiasing?: boolean, fileName?: string): Promise<string>;
  122408. /**
  122409. * Implementation from http://stackoverflow.com/questions/105034/how-to-create-a-guid-uuid-in-javascript/2117523#answer-2117523
  122410. * Be aware Math.random() could cause collisions, but:
  122411. * "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"
  122412. * @returns a pseudo random id
  122413. */
  122414. static RandomId(): string;
  122415. /**
  122416. * Test if the given uri is a base64 string
  122417. * @param uri The uri to test
  122418. * @return True if the uri is a base64 string or false otherwise
  122419. */
  122420. static IsBase64(uri: string): boolean;
  122421. /**
  122422. * Decode the given base64 uri.
  122423. * @param uri The uri to decode
  122424. * @return The decoded base64 data.
  122425. */
  122426. static DecodeBase64(uri: string): ArrayBuffer;
  122427. /**
  122428. * Gets the absolute url.
  122429. * @param url the input url
  122430. * @return the absolute url
  122431. */
  122432. static GetAbsoluteUrl(url: string): string;
  122433. /**
  122434. * No log
  122435. */
  122436. static readonly NoneLogLevel: number;
  122437. /**
  122438. * Only message logs
  122439. */
  122440. static readonly MessageLogLevel: number;
  122441. /**
  122442. * Only warning logs
  122443. */
  122444. static readonly WarningLogLevel: number;
  122445. /**
  122446. * Only error logs
  122447. */
  122448. static readonly ErrorLogLevel: number;
  122449. /**
  122450. * All logs
  122451. */
  122452. static readonly AllLogLevel: number;
  122453. /**
  122454. * Gets a value indicating the number of loading errors
  122455. * @ignorenaming
  122456. */
  122457. static get errorsCount(): number;
  122458. /**
  122459. * Callback called when a new log is added
  122460. */
  122461. static OnNewCacheEntry: (entry: string) => void;
  122462. /**
  122463. * Log a message to the console
  122464. * @param message defines the message to log
  122465. */
  122466. static Log(message: string): void;
  122467. /**
  122468. * Write a warning message to the console
  122469. * @param message defines the message to log
  122470. */
  122471. static Warn(message: string): void;
  122472. /**
  122473. * Write an error message to the console
  122474. * @param message defines the message to log
  122475. */
  122476. static Error(message: string): void;
  122477. /**
  122478. * Gets current log cache (list of logs)
  122479. */
  122480. static get LogCache(): string;
  122481. /**
  122482. * Clears the log cache
  122483. */
  122484. static ClearLogCache(): void;
  122485. /**
  122486. * Sets the current log level (MessageLogLevel / WarningLogLevel / ErrorLogLevel)
  122487. */
  122488. static set LogLevels(level: number);
  122489. /**
  122490. * Checks if the window object exists
  122491. * Back Compat only, please use DomManagement.IsWindowObjectExist instead.
  122492. */
  122493. static IsWindowObjectExist: typeof DomManagement.IsWindowObjectExist;
  122494. /**
  122495. * No performance log
  122496. */
  122497. static readonly PerformanceNoneLogLevel: number;
  122498. /**
  122499. * Use user marks to log performance
  122500. */
  122501. static readonly PerformanceUserMarkLogLevel: number;
  122502. /**
  122503. * Log performance to the console
  122504. */
  122505. static readonly PerformanceConsoleLogLevel: number;
  122506. private static _performance;
  122507. /**
  122508. * Sets the current performance log level
  122509. */
  122510. static set PerformanceLogLevel(level: number);
  122511. private static _StartPerformanceCounterDisabled;
  122512. private static _EndPerformanceCounterDisabled;
  122513. private static _StartUserMark;
  122514. private static _EndUserMark;
  122515. private static _StartPerformanceConsole;
  122516. private static _EndPerformanceConsole;
  122517. /**
  122518. * Starts a performance counter
  122519. */
  122520. static StartPerformanceCounter: (counterName: string, condition?: boolean) => void;
  122521. /**
  122522. * Ends a specific performance coutner
  122523. */
  122524. static EndPerformanceCounter: (counterName: string, condition?: boolean) => void;
  122525. /**
  122526. * Gets either window.performance.now() if supported or Date.now() else
  122527. */
  122528. static get Now(): number;
  122529. /**
  122530. * This method will return the name of the class used to create the instance of the given object.
  122531. * It will works only on Javascript basic data types (number, string, ...) and instance of class declared with the @className decorator.
  122532. * @param object the object to get the class name from
  122533. * @param isType defines if the object is actually a type
  122534. * @returns the name of the class, will be "object" for a custom data type not using the @className decorator
  122535. */
  122536. static GetClassName(object: any, isType?: boolean): string;
  122537. /**
  122538. * Gets the first element of an array satisfying a given predicate
  122539. * @param array defines the array to browse
  122540. * @param predicate defines the predicate to use
  122541. * @returns null if not found or the element
  122542. */
  122543. static First<T>(array: Array<T>, predicate: (item: T) => boolean): Nullable<T>;
  122544. /**
  122545. * This method will return the name of the full name of the class, including its owning module (if any).
  122546. * 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).
  122547. * @param object the object to get the class name from
  122548. * @param isType defines if the object is actually a type
  122549. * @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.
  122550. * @ignorenaming
  122551. */
  122552. static getFullClassName(object: any, isType?: boolean): Nullable<string>;
  122553. /**
  122554. * Returns a promise that resolves after the given amount of time.
  122555. * @param delay Number of milliseconds to delay
  122556. * @returns Promise that resolves after the given amount of time
  122557. */
  122558. static DelayAsync(delay: number): Promise<void>;
  122559. /**
  122560. * Utility function to detect if the current user agent is Safari
  122561. * @returns whether or not the current user agent is safari
  122562. */
  122563. static IsSafari(): boolean;
  122564. }
  122565. /**
  122566. * Use this className as a decorator on a given class definition to add it a name and optionally its module.
  122567. * You can then use the Tools.getClassName(obj) on an instance to retrieve its class name.
  122568. * This method is the only way to get it done in all cases, even if the .js file declaring the class is minified
  122569. * @param name The name of the class, case should be preserved
  122570. * @param module The name of the Module hosting the class, optional, but strongly recommended to specify if possible. Case should be preserved.
  122571. */
  122572. export function className(name: string, module?: string): (target: Object) => void;
  122573. /**
  122574. * An implementation of a loop for asynchronous functions.
  122575. */
  122576. export class AsyncLoop {
  122577. /**
  122578. * Defines the number of iterations for the loop
  122579. */
  122580. iterations: number;
  122581. /**
  122582. * Defines the current index of the loop.
  122583. */
  122584. index: number;
  122585. private _done;
  122586. private _fn;
  122587. private _successCallback;
  122588. /**
  122589. * Constructor.
  122590. * @param iterations the number of iterations.
  122591. * @param func the function to run each iteration
  122592. * @param successCallback the callback that will be called upon succesful execution
  122593. * @param offset starting offset.
  122594. */
  122595. constructor(
  122596. /**
  122597. * Defines the number of iterations for the loop
  122598. */
  122599. iterations: number, func: (asyncLoop: AsyncLoop) => void, successCallback: () => void, offset?: number);
  122600. /**
  122601. * Execute the next iteration. Must be called after the last iteration was finished.
  122602. */
  122603. executeNext(): void;
  122604. /**
  122605. * Break the loop and run the success callback.
  122606. */
  122607. breakLoop(): void;
  122608. /**
  122609. * Create and run an async loop.
  122610. * @param iterations the number of iterations.
  122611. * @param fn the function to run each iteration
  122612. * @param successCallback the callback that will be called upon succesful execution
  122613. * @param offset starting offset.
  122614. * @returns the created async loop object
  122615. */
  122616. static Run(iterations: number, fn: (asyncLoop: AsyncLoop) => void, successCallback: () => void, offset?: number): AsyncLoop;
  122617. /**
  122618. * A for-loop that will run a given number of iterations synchronous and the rest async.
  122619. * @param iterations total number of iterations
  122620. * @param syncedIterations number of synchronous iterations in each async iteration.
  122621. * @param fn the function to call each iteration.
  122622. * @param callback a success call back that will be called when iterating stops.
  122623. * @param breakFunction a break condition (optional)
  122624. * @param timeout timeout settings for the setTimeout function. default - 0.
  122625. * @returns the created async loop object
  122626. */
  122627. static SyncAsyncForLoop(iterations: number, syncedIterations: number, fn: (iteration: number) => void, callback: () => void, breakFunction?: () => boolean, timeout?: number): AsyncLoop;
  122628. }
  122629. }
  122630. declare module BABYLON {
  122631. /**
  122632. * This class implement a typical dictionary using a string as key and the generic type T as value.
  122633. * The underlying implementation relies on an associative array to ensure the best performances.
  122634. * The value can be anything including 'null' but except 'undefined'
  122635. */
  122636. export class StringDictionary<T> {
  122637. /**
  122638. * This will clear this dictionary and copy the content from the 'source' one.
  122639. * If the T value is a custom object, it won't be copied/cloned, the same object will be used
  122640. * @param source the dictionary to take the content from and copy to this dictionary
  122641. */
  122642. copyFrom(source: StringDictionary<T>): void;
  122643. /**
  122644. * Get a value based from its key
  122645. * @param key the given key to get the matching value from
  122646. * @return the value if found, otherwise undefined is returned
  122647. */
  122648. get(key: string): T | undefined;
  122649. /**
  122650. * Get a value from its key or add it if it doesn't exist.
  122651. * This method will ensure you that a given key/data will be present in the dictionary.
  122652. * @param key the given key to get the matching value from
  122653. * @param factory the factory that will create the value if the key is not present in the dictionary.
  122654. * The factory will only be invoked if there's no data for the given key.
  122655. * @return the value corresponding to the key.
  122656. */
  122657. getOrAddWithFactory(key: string, factory: (key: string) => T): T;
  122658. /**
  122659. * Get a value from its key if present in the dictionary otherwise add it
  122660. * @param key the key to get the value from
  122661. * @param val if there's no such key/value pair in the dictionary add it with this value
  122662. * @return the value corresponding to the key
  122663. */
  122664. getOrAdd(key: string, val: T): T;
  122665. /**
  122666. * Check if there's a given key in the dictionary
  122667. * @param key the key to check for
  122668. * @return true if the key is present, false otherwise
  122669. */
  122670. contains(key: string): boolean;
  122671. /**
  122672. * Add a new key and its corresponding value
  122673. * @param key the key to add
  122674. * @param value the value corresponding to the key
  122675. * @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
  122676. */
  122677. add(key: string, value: T): boolean;
  122678. /**
  122679. * Update a specific value associated to a key
  122680. * @param key defines the key to use
  122681. * @param value defines the value to store
  122682. * @returns true if the value was updated (or false if the key was not found)
  122683. */
  122684. set(key: string, value: T): boolean;
  122685. /**
  122686. * Get the element of the given key and remove it from the dictionary
  122687. * @param key defines the key to search
  122688. * @returns the value associated with the key or null if not found
  122689. */
  122690. getAndRemove(key: string): Nullable<T>;
  122691. /**
  122692. * Remove a key/value from the dictionary.
  122693. * @param key the key to remove
  122694. * @return true if the item was successfully deleted, false if no item with such key exist in the dictionary
  122695. */
  122696. remove(key: string): boolean;
  122697. /**
  122698. * Clear the whole content of the dictionary
  122699. */
  122700. clear(): void;
  122701. /**
  122702. * Gets the current count
  122703. */
  122704. get count(): number;
  122705. /**
  122706. * Execute a callback on each key/val of the dictionary.
  122707. * Note that you can remove any element in this dictionary in the callback implementation
  122708. * @param callback the callback to execute on a given key/value pair
  122709. */
  122710. forEach(callback: (key: string, val: T) => void): void;
  122711. /**
  122712. * Execute a callback on every occurrence of the dictionary until it returns a valid TRes object.
  122713. * If the callback returns null or undefined the method will iterate to the next key/value pair
  122714. * Note that you can remove any element in this dictionary in the callback implementation
  122715. * @param callback the callback to execute, if it return a valid T instanced object the enumeration will stop and the object will be returned
  122716. * @returns the first item
  122717. */
  122718. first<TRes>(callback: (key: string, val: T) => TRes): TRes | null;
  122719. private _count;
  122720. private _data;
  122721. }
  122722. }
  122723. declare module BABYLON {
  122724. /** @hidden */
  122725. export interface ICollisionCoordinator {
  122726. createCollider(): Collider;
  122727. getNewPosition(position: Vector3, displacement: Vector3, collider: Collider, maximumRetry: number, excludedMesh: Nullable<AbstractMesh>, onNewPosition: (collisionIndex: number, newPosition: Vector3, collidedMesh: Nullable<AbstractMesh>) => void, collisionIndex: number): void;
  122728. init(scene: Scene): void;
  122729. }
  122730. /** @hidden */
  122731. export class DefaultCollisionCoordinator implements ICollisionCoordinator {
  122732. private _scene;
  122733. private _scaledPosition;
  122734. private _scaledVelocity;
  122735. private _finalPosition;
  122736. getNewPosition(position: Vector3, displacement: Vector3, collider: Collider, maximumRetry: number, excludedMesh: AbstractMesh, onNewPosition: (collisionIndex: number, newPosition: Vector3, collidedMesh: Nullable<AbstractMesh>) => void, collisionIndex: number): void;
  122737. createCollider(): Collider;
  122738. init(scene: Scene): void;
  122739. private _collideWithWorld;
  122740. }
  122741. }
  122742. declare module BABYLON {
  122743. /**
  122744. * Class used to manage all inputs for the scene.
  122745. */
  122746. export class InputManager {
  122747. /** The distance in pixel that you have to move to prevent some events */
  122748. static DragMovementThreshold: number;
  122749. /** Time in milliseconds to wait to raise long press events if button is still pressed */
  122750. static LongPressDelay: number;
  122751. /** Time in milliseconds with two consecutive clicks will be considered as a double click */
  122752. static DoubleClickDelay: number;
  122753. /** If you need to check double click without raising a single click at first click, enable this flag */
  122754. static ExclusiveDoubleClickMode: boolean;
  122755. /** 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. */
  122756. private _alreadyAttached;
  122757. private _alreadyAttachedTo;
  122758. private _wheelEventName;
  122759. private _onPointerMove;
  122760. private _onPointerDown;
  122761. private _onPointerUp;
  122762. private _initClickEvent;
  122763. private _initActionManager;
  122764. private _delayedSimpleClick;
  122765. private _delayedSimpleClickTimeout;
  122766. private _previousDelayedSimpleClickTimeout;
  122767. private _meshPickProceed;
  122768. private _previousButtonPressed;
  122769. private _currentPickResult;
  122770. private _previousPickResult;
  122771. private _totalPointersPressed;
  122772. private _doubleClickOccured;
  122773. private _pointerOverMesh;
  122774. private _pickedDownMesh;
  122775. private _pickedUpMesh;
  122776. private _pointerX;
  122777. private _pointerY;
  122778. private _unTranslatedPointerX;
  122779. private _unTranslatedPointerY;
  122780. private _startingPointerPosition;
  122781. private _previousStartingPointerPosition;
  122782. private _startingPointerTime;
  122783. private _previousStartingPointerTime;
  122784. private _pointerCaptures;
  122785. private _meshUnderPointerId;
  122786. private _onKeyDown;
  122787. private _onKeyUp;
  122788. private _keyboardIsAttached;
  122789. private _onCanvasFocusObserver;
  122790. private _onCanvasBlurObserver;
  122791. private _scene;
  122792. /**
  122793. * Creates a new InputManager
  122794. * @param scene defines the hosting scene
  122795. */
  122796. constructor(scene: Scene);
  122797. /**
  122798. * Gets the mesh that is currently under the pointer
  122799. */
  122800. get meshUnderPointer(): Nullable<AbstractMesh>;
  122801. /**
  122802. * When using more than one pointer (for example in XR) you can get the mesh under the specific pointer
  122803. * @param pointerId the pointer id to use
  122804. * @returns The mesh under this pointer id or null if not found
  122805. */
  122806. getMeshUnderPointerByPointerId(pointerId: number): Nullable<AbstractMesh>;
  122807. /**
  122808. * Gets the pointer coordinates in 2D without any translation (ie. straight out of the pointer event)
  122809. */
  122810. get unTranslatedPointer(): Vector2;
  122811. /**
  122812. * Gets or sets the current on-screen X position of the pointer
  122813. */
  122814. get pointerX(): number;
  122815. set pointerX(value: number);
  122816. /**
  122817. * Gets or sets the current on-screen Y position of the pointer
  122818. */
  122819. get pointerY(): number;
  122820. set pointerY(value: number);
  122821. private _updatePointerPosition;
  122822. private _processPointerMove;
  122823. private _setRayOnPointerInfo;
  122824. private _checkPrePointerObservable;
  122825. /**
  122826. * Use this method to simulate a pointer move on a mesh
  122827. * The pickResult parameter can be obtained from a scene.pick or scene.pickWithRay
  122828. * @param pickResult pickingInfo of the object wished to simulate pointer event on
  122829. * @param pointerEventInit pointer event state to be used when simulating the pointer event (eg. pointer id for multitouch)
  122830. */
  122831. simulatePointerMove(pickResult: PickingInfo, pointerEventInit?: PointerEventInit): void;
  122832. /**
  122833. * Use this method to simulate a pointer down on a mesh
  122834. * The pickResult parameter can be obtained from a scene.pick or scene.pickWithRay
  122835. * @param pickResult pickingInfo of the object wished to simulate pointer event on
  122836. * @param pointerEventInit pointer event state to be used when simulating the pointer event (eg. pointer id for multitouch)
  122837. */
  122838. simulatePointerDown(pickResult: PickingInfo, pointerEventInit?: PointerEventInit): void;
  122839. private _processPointerDown;
  122840. /** @hidden */
  122841. _isPointerSwiping(): boolean;
  122842. /**
  122843. * Use this method to simulate a pointer up on a mesh
  122844. * The pickResult parameter can be obtained from a scene.pick or scene.pickWithRay
  122845. * @param pickResult pickingInfo of the object wished to simulate pointer event on
  122846. * @param pointerEventInit pointer event state to be used when simulating the pointer event (eg. pointer id for multitouch)
  122847. * @param doubleTap indicates that the pointer up event should be considered as part of a double click (false by default)
  122848. */
  122849. simulatePointerUp(pickResult: PickingInfo, pointerEventInit?: PointerEventInit, doubleTap?: boolean): void;
  122850. private _processPointerUp;
  122851. /**
  122852. * Gets a boolean indicating if the current pointer event is captured (meaning that the scene has already handled the pointer down)
  122853. * @param pointerId defines the pointer id to use in a multi-touch scenario (0 by default)
  122854. * @returns true if the pointer was captured
  122855. */
  122856. isPointerCaptured(pointerId?: number): boolean;
  122857. /**
  122858. * Attach events to the canvas (To handle actionManagers triggers and raise onPointerMove, onPointerDown and onPointerUp
  122859. * @param attachUp defines if you want to attach events to pointerup
  122860. * @param attachDown defines if you want to attach events to pointerdown
  122861. * @param attachMove defines if you want to attach events to pointermove
  122862. * @param elementToAttachTo defines the target DOM element to attach to (will use the canvas by default)
  122863. */
  122864. attachControl(attachUp?: boolean, attachDown?: boolean, attachMove?: boolean, elementToAttachTo?: Nullable<HTMLElement>): void;
  122865. /**
  122866. * Detaches all event handlers
  122867. */
  122868. detachControl(): void;
  122869. /**
  122870. * Force the value of meshUnderPointer
  122871. * @param mesh defines the mesh to use
  122872. * @param pointerId optional pointer id when using more than one pointer. Defaults to 0
  122873. */
  122874. setPointerOverMesh(mesh: Nullable<AbstractMesh>, pointerId?: number): void;
  122875. /**
  122876. * Gets the mesh under the pointer
  122877. * @returns a Mesh or null if no mesh is under the pointer
  122878. */
  122879. getPointerOverMesh(): Nullable<AbstractMesh>;
  122880. }
  122881. }
  122882. declare module BABYLON {
  122883. /**
  122884. * This class defines the direct association between an animation and a target
  122885. */
  122886. export class TargetedAnimation {
  122887. /**
  122888. * Animation to perform
  122889. */
  122890. animation: Animation;
  122891. /**
  122892. * Target to animate
  122893. */
  122894. target: any;
  122895. /**
  122896. * Returns the string "TargetedAnimation"
  122897. * @returns "TargetedAnimation"
  122898. */
  122899. getClassName(): string;
  122900. /**
  122901. * Serialize the object
  122902. * @returns the JSON object representing the current entity
  122903. */
  122904. serialize(): any;
  122905. }
  122906. /**
  122907. * Use this class to create coordinated animations on multiple targets
  122908. */
  122909. export class AnimationGroup implements IDisposable {
  122910. /** The name of the animation group */
  122911. name: string;
  122912. private _scene;
  122913. private _targetedAnimations;
  122914. private _animatables;
  122915. private _from;
  122916. private _to;
  122917. private _isStarted;
  122918. private _isPaused;
  122919. private _speedRatio;
  122920. private _loopAnimation;
  122921. private _isAdditive;
  122922. /**
  122923. * Gets or sets the unique id of the node
  122924. */
  122925. uniqueId: number;
  122926. /**
  122927. * This observable will notify when one animation have ended
  122928. */
  122929. onAnimationEndObservable: Observable<TargetedAnimation>;
  122930. /**
  122931. * Observer raised when one animation loops
  122932. */
  122933. onAnimationLoopObservable: Observable<TargetedAnimation>;
  122934. /**
  122935. * Observer raised when all animations have looped
  122936. */
  122937. onAnimationGroupLoopObservable: Observable<AnimationGroup>;
  122938. /**
  122939. * This observable will notify when all animations have ended.
  122940. */
  122941. onAnimationGroupEndObservable: Observable<AnimationGroup>;
  122942. /**
  122943. * This observable will notify when all animations have paused.
  122944. */
  122945. onAnimationGroupPauseObservable: Observable<AnimationGroup>;
  122946. /**
  122947. * This observable will notify when all animations are playing.
  122948. */
  122949. onAnimationGroupPlayObservable: Observable<AnimationGroup>;
  122950. /**
  122951. * Gets the first frame
  122952. */
  122953. get from(): number;
  122954. /**
  122955. * Gets the last frame
  122956. */
  122957. get to(): number;
  122958. /**
  122959. * Define if the animations are started
  122960. */
  122961. get isStarted(): boolean;
  122962. /**
  122963. * Gets a value indicating that the current group is playing
  122964. */
  122965. get isPlaying(): boolean;
  122966. /**
  122967. * Gets or sets the speed ratio to use for all animations
  122968. */
  122969. get speedRatio(): number;
  122970. /**
  122971. * Gets or sets the speed ratio to use for all animations
  122972. */
  122973. set speedRatio(value: number);
  122974. /**
  122975. * Gets or sets if all animations should loop or not
  122976. */
  122977. get loopAnimation(): boolean;
  122978. set loopAnimation(value: boolean);
  122979. /**
  122980. * Gets or sets if all animations should be evaluated additively
  122981. */
  122982. get isAdditive(): boolean;
  122983. set isAdditive(value: boolean);
  122984. /**
  122985. * Gets the targeted animations for this animation group
  122986. */
  122987. get targetedAnimations(): Array<TargetedAnimation>;
  122988. /**
  122989. * returning the list of animatables controlled by this animation group.
  122990. */
  122991. get animatables(): Array<Animatable>;
  122992. /**
  122993. * Gets the list of target animations
  122994. */
  122995. get children(): TargetedAnimation[];
  122996. /**
  122997. * Instantiates a new Animation Group.
  122998. * This helps managing several animations at once.
  122999. * @see https://doc.babylonjs.com/how_to/group
  123000. * @param name Defines the name of the group
  123001. * @param scene Defines the scene the group belongs to
  123002. */
  123003. constructor(
  123004. /** The name of the animation group */
  123005. name: string, scene?: Nullable<Scene>);
  123006. /**
  123007. * Add an animation (with its target) in the group
  123008. * @param animation defines the animation we want to add
  123009. * @param target defines the target of the animation
  123010. * @returns the TargetedAnimation object
  123011. */
  123012. addTargetedAnimation(animation: Animation, target: any): TargetedAnimation;
  123013. /**
  123014. * This function will normalize every animation in the group to make sure they all go from beginFrame to endFrame
  123015. * It can add constant keys at begin or end
  123016. * @param beginFrame defines the new begin frame for all animations or the smallest begin frame of all animations if null (defaults to null)
  123017. * @param endFrame defines the new end frame for all animations or the largest end frame of all animations if null (defaults to null)
  123018. * @returns the animation group
  123019. */
  123020. normalize(beginFrame?: Nullable<number>, endFrame?: Nullable<number>): AnimationGroup;
  123021. private _animationLoopCount;
  123022. private _animationLoopFlags;
  123023. private _processLoop;
  123024. /**
  123025. * Start all animations on given targets
  123026. * @param loop defines if animations must loop
  123027. * @param speedRatio defines the ratio to apply to animation speed (1 by default)
  123028. * @param from defines the from key (optional)
  123029. * @param to defines the to key (optional)
  123030. * @param isAdditive defines the additive state for the resulting animatables (optional)
  123031. * @returns the current animation group
  123032. */
  123033. start(loop?: boolean, speedRatio?: number, from?: number, to?: number, isAdditive?: boolean): AnimationGroup;
  123034. /**
  123035. * Pause all animations
  123036. * @returns the animation group
  123037. */
  123038. pause(): AnimationGroup;
  123039. /**
  123040. * Play all animations to initial state
  123041. * This function will start() the animations if they were not started or will restart() them if they were paused
  123042. * @param loop defines if animations must loop
  123043. * @returns the animation group
  123044. */
  123045. play(loop?: boolean): AnimationGroup;
  123046. /**
  123047. * Reset all animations to initial state
  123048. * @returns the animation group
  123049. */
  123050. reset(): AnimationGroup;
  123051. /**
  123052. * Restart animations from key 0
  123053. * @returns the animation group
  123054. */
  123055. restart(): AnimationGroup;
  123056. /**
  123057. * Stop all animations
  123058. * @returns the animation group
  123059. */
  123060. stop(): AnimationGroup;
  123061. /**
  123062. * Set animation weight for all animatables
  123063. * @param weight defines the weight to use
  123064. * @return the animationGroup
  123065. * @see https://doc.babylonjs.com/babylon101/animations#animation-weights
  123066. */
  123067. setWeightForAllAnimatables(weight: number): AnimationGroup;
  123068. /**
  123069. * Synchronize and normalize all animatables with a source animatable
  123070. * @param root defines the root animatable to synchronize with
  123071. * @return the animationGroup
  123072. * @see https://doc.babylonjs.com/babylon101/animations#animation-weights
  123073. */
  123074. syncAllAnimationsWith(root: Animatable): AnimationGroup;
  123075. /**
  123076. * Goes to a specific frame in this animation group
  123077. * @param frame the frame number to go to
  123078. * @return the animationGroup
  123079. */
  123080. goToFrame(frame: number): AnimationGroup;
  123081. /**
  123082. * Dispose all associated resources
  123083. */
  123084. dispose(): void;
  123085. private _checkAnimationGroupEnded;
  123086. /**
  123087. * Clone the current animation group and returns a copy
  123088. * @param newName defines the name of the new group
  123089. * @param targetConverter defines an optional function used to convert current animation targets to new ones
  123090. * @returns the new aniamtion group
  123091. */
  123092. clone(newName: string, targetConverter?: (oldTarget: any) => any): AnimationGroup;
  123093. /**
  123094. * Serializes the animationGroup to an object
  123095. * @returns Serialized object
  123096. */
  123097. serialize(): any;
  123098. /**
  123099. * Returns a new AnimationGroup object parsed from the source provided.
  123100. * @param parsedAnimationGroup defines the source
  123101. * @param scene defines the scene that will receive the animationGroup
  123102. * @returns a new AnimationGroup
  123103. */
  123104. static Parse(parsedAnimationGroup: any, scene: Scene): AnimationGroup;
  123105. /**
  123106. * Convert the keyframes for all animations belonging to the group to be relative to a given reference frame.
  123107. * @param sourceAnimationGroup defines the AnimationGroup containing animations to convert
  123108. * @param referenceFrame defines the frame that keyframes in the range will be relative to
  123109. * @param range defines the name of the AnimationRange belonging to the animations in the group to convert
  123110. * @param cloneOriginal defines whether or not to clone the group and convert the clone or convert the original group (default is false)
  123111. * @param clonedName defines the name of the resulting cloned AnimationGroup if cloneOriginal is true
  123112. * @returns a new AnimationGroup if cloneOriginal is true or the original AnimationGroup if cloneOriginal is false
  123113. */
  123114. static MakeAnimationAdditive(sourceAnimationGroup: AnimationGroup, referenceFrame?: number, range?: string, cloneOriginal?: boolean, clonedName?: string): AnimationGroup;
  123115. /**
  123116. * Returns the string "AnimationGroup"
  123117. * @returns "AnimationGroup"
  123118. */
  123119. getClassName(): string;
  123120. /**
  123121. * Creates a detailled string about the object
  123122. * @param fullDetails defines if the output string will support multiple levels of logging within scene loading
  123123. * @returns a string representing the object
  123124. */
  123125. toString(fullDetails?: boolean): string;
  123126. }
  123127. }
  123128. declare module BABYLON {
  123129. /**
  123130. * Define an interface for all classes that will hold resources
  123131. */
  123132. export interface IDisposable {
  123133. /**
  123134. * Releases all held resources
  123135. */
  123136. dispose(): void;
  123137. }
  123138. /** Interface defining initialization parameters for Scene class */
  123139. export interface SceneOptions {
  123140. /**
  123141. * Defines that scene should keep up-to-date a map of geometry to enable fast look-up by uniqueId
  123142. * It will improve performance when the number of geometries becomes important.
  123143. */
  123144. useGeometryUniqueIdsMap?: boolean;
  123145. /**
  123146. * Defines that each material of the scene should keep up-to-date a map of referencing meshes for fast diposing
  123147. * It will improve performance when the number of mesh becomes important, but might consume a bit more memory
  123148. */
  123149. useMaterialMeshMap?: boolean;
  123150. /**
  123151. * Defines that each mesh of the scene should keep up-to-date a map of referencing cloned meshes for fast diposing
  123152. * It will improve performance when the number of mesh becomes important, but might consume a bit more memory
  123153. */
  123154. useClonedMeshMap?: boolean;
  123155. /** Defines if the creation of the scene should impact the engine (Eg. UtilityLayer's scene) */
  123156. virtual?: boolean;
  123157. }
  123158. /**
  123159. * Represents a scene to be rendered by the engine.
  123160. * @see https://doc.babylonjs.com/features/scene
  123161. */
  123162. export class Scene extends AbstractScene implements IAnimatable, IClipPlanesHolder {
  123163. /** The fog is deactivated */
  123164. static readonly FOGMODE_NONE: number;
  123165. /** The fog density is following an exponential function */
  123166. static readonly FOGMODE_EXP: number;
  123167. /** The fog density is following an exponential function faster than FOGMODE_EXP */
  123168. static readonly FOGMODE_EXP2: number;
  123169. /** The fog density is following a linear function. */
  123170. static readonly FOGMODE_LINEAR: number;
  123171. /**
  123172. * Gets or sets the minimum deltatime when deterministic lock step is enabled
  123173. * @see https://doc.babylonjs.com/babylon101/animations#deterministic-lockstep
  123174. */
  123175. static MinDeltaTime: number;
  123176. /**
  123177. * Gets or sets the maximum deltatime when deterministic lock step is enabled
  123178. * @see https://doc.babylonjs.com/babylon101/animations#deterministic-lockstep
  123179. */
  123180. static MaxDeltaTime: number;
  123181. /**
  123182. * Factory used to create the default material.
  123183. * @param name The name of the material to create
  123184. * @param scene The scene to create the material for
  123185. * @returns The default material
  123186. */
  123187. static DefaultMaterialFactory(scene: Scene): Material;
  123188. /**
  123189. * Factory used to create the a collision coordinator.
  123190. * @returns The collision coordinator
  123191. */
  123192. static CollisionCoordinatorFactory(): ICollisionCoordinator;
  123193. /** @hidden */
  123194. _inputManager: InputManager;
  123195. /** Define this parameter if you are using multiple cameras and you want to specify which one should be used for pointer position */
  123196. cameraToUseForPointers: Nullable<Camera>;
  123197. /** @hidden */
  123198. readonly _isScene: boolean;
  123199. /** @hidden */
  123200. _blockEntityCollection: boolean;
  123201. /**
  123202. * Gets or sets a boolean that indicates if the scene must clear the render buffer before rendering a frame
  123203. */
  123204. autoClear: boolean;
  123205. /**
  123206. * Gets or sets a boolean that indicates if the scene must clear the depth and stencil buffers before rendering a frame
  123207. */
  123208. autoClearDepthAndStencil: boolean;
  123209. /**
  123210. * Defines the color used to clear the render buffer (Default is (0.2, 0.2, 0.3, 1.0))
  123211. */
  123212. clearColor: Color4;
  123213. /**
  123214. * Defines the color used to simulate the ambient color (Default is (0, 0, 0))
  123215. */
  123216. ambientColor: Color3;
  123217. /**
  123218. * This is use to store the default BRDF lookup for PBR materials in your scene.
  123219. * It should only be one of the following (if not the default embedded one):
  123220. * * For uncorrelated BRDF (pbr.brdf.useEnergyConservation = false and pbr.brdf.useSmithVisibilityHeightCorrelated = false) : https://assets.babylonjs.com/environments/uncorrelatedBRDF.dds
  123221. * * For correlated BRDF (pbr.brdf.useEnergyConservation = false and pbr.brdf.useSmithVisibilityHeightCorrelated = true) : https://assets.babylonjs.com/environments/correlatedBRDF.dds
  123222. * * For correlated multi scattering BRDF (pbr.brdf.useEnergyConservation = true and pbr.brdf.useSmithVisibilityHeightCorrelated = true) : https://assets.babylonjs.com/environments/correlatedMSBRDF.dds
  123223. * The material properties need to be setup according to the type of texture in use.
  123224. */
  123225. environmentBRDFTexture: BaseTexture;
  123226. /**
  123227. * Texture used in all pbr material as the reflection texture.
  123228. * As in the majority of the scene they are the same (exception for multi room and so on),
  123229. * this is easier to reference from here than from all the materials.
  123230. */
  123231. get environmentTexture(): Nullable<BaseTexture>;
  123232. /**
  123233. * Texture used in all pbr material as the reflection texture.
  123234. * As in the majority of the scene they are the same (exception for multi room and so on),
  123235. * this is easier to set here than in all the materials.
  123236. */
  123237. set environmentTexture(value: Nullable<BaseTexture>);
  123238. /** @hidden */
  123239. protected _environmentIntensity: number;
  123240. /**
  123241. * Intensity of the environment in all pbr material.
  123242. * This dims or reinforces the IBL lighting overall (reflection and diffuse).
  123243. * As in the majority of the scene they are the same (exception for multi room and so on),
  123244. * this is easier to reference from here than from all the materials.
  123245. */
  123246. get environmentIntensity(): number;
  123247. /**
  123248. * Intensity of the environment in all pbr material.
  123249. * This dims or reinforces the IBL lighting overall (reflection and diffuse).
  123250. * As in the majority of the scene they are the same (exception for multi room and so on),
  123251. * this is easier to set here than in all the materials.
  123252. */
  123253. set environmentIntensity(value: number);
  123254. /** @hidden */
  123255. protected _imageProcessingConfiguration: ImageProcessingConfiguration;
  123256. /**
  123257. * Default image processing configuration used either in the rendering
  123258. * Forward main pass or through the imageProcessingPostProcess if present.
  123259. * As in the majority of the scene they are the same (exception for multi camera),
  123260. * this is easier to reference from here than from all the materials and post process.
  123261. *
  123262. * No setter as we it is a shared configuration, you can set the values instead.
  123263. */
  123264. get imageProcessingConfiguration(): ImageProcessingConfiguration;
  123265. private _forceWireframe;
  123266. /**
  123267. * Gets or sets a boolean indicating if all rendering must be done in wireframe
  123268. */
  123269. set forceWireframe(value: boolean);
  123270. get forceWireframe(): boolean;
  123271. private _skipFrustumClipping;
  123272. /**
  123273. * Gets or sets a boolean indicating if we should skip the frustum clipping part of the active meshes selection
  123274. */
  123275. set skipFrustumClipping(value: boolean);
  123276. get skipFrustumClipping(): boolean;
  123277. private _forcePointsCloud;
  123278. /**
  123279. * Gets or sets a boolean indicating if all rendering must be done in point cloud
  123280. */
  123281. set forcePointsCloud(value: boolean);
  123282. get forcePointsCloud(): boolean;
  123283. /**
  123284. * Gets or sets the active clipplane 1
  123285. */
  123286. clipPlane: Nullable<Plane>;
  123287. /**
  123288. * Gets or sets the active clipplane 2
  123289. */
  123290. clipPlane2: Nullable<Plane>;
  123291. /**
  123292. * Gets or sets the active clipplane 3
  123293. */
  123294. clipPlane3: Nullable<Plane>;
  123295. /**
  123296. * Gets or sets the active clipplane 4
  123297. */
  123298. clipPlane4: Nullable<Plane>;
  123299. /**
  123300. * Gets or sets the active clipplane 5
  123301. */
  123302. clipPlane5: Nullable<Plane>;
  123303. /**
  123304. * Gets or sets the active clipplane 6
  123305. */
  123306. clipPlane6: Nullable<Plane>;
  123307. /**
  123308. * Gets or sets a boolean indicating if animations are enabled
  123309. */
  123310. animationsEnabled: boolean;
  123311. private _animationPropertiesOverride;
  123312. /**
  123313. * Gets or sets the animation properties override
  123314. */
  123315. get animationPropertiesOverride(): Nullable<AnimationPropertiesOverride>;
  123316. set animationPropertiesOverride(value: Nullable<AnimationPropertiesOverride>);
  123317. /**
  123318. * Gets or sets a boolean indicating if a constant deltatime has to be used
  123319. * This is mostly useful for testing purposes when you do not want the animations to scale with the framerate
  123320. */
  123321. useConstantAnimationDeltaTime: boolean;
  123322. /**
  123323. * Gets or sets a boolean indicating if the scene must keep the meshUnderPointer property updated
  123324. * Please note that it requires to run a ray cast through the scene on every frame
  123325. */
  123326. constantlyUpdateMeshUnderPointer: boolean;
  123327. /**
  123328. * Defines the HTML cursor to use when hovering over interactive elements
  123329. */
  123330. hoverCursor: string;
  123331. /**
  123332. * Defines the HTML default cursor to use (empty by default)
  123333. */
  123334. defaultCursor: string;
  123335. /**
  123336. * Defines whether cursors are handled by the scene.
  123337. */
  123338. doNotHandleCursors: boolean;
  123339. /**
  123340. * This is used to call preventDefault() on pointer down
  123341. * in order to block unwanted artifacts like system double clicks
  123342. */
  123343. preventDefaultOnPointerDown: boolean;
  123344. /**
  123345. * This is used to call preventDefault() on pointer up
  123346. * in order to block unwanted artifacts like system double clicks
  123347. */
  123348. preventDefaultOnPointerUp: boolean;
  123349. /**
  123350. * Gets or sets user defined metadata
  123351. */
  123352. metadata: any;
  123353. /**
  123354. * For internal use only. Please do not use.
  123355. */
  123356. reservedDataStore: any;
  123357. /**
  123358. * Gets the name of the plugin used to load this scene (null by default)
  123359. */
  123360. loadingPluginName: string;
  123361. /**
  123362. * Use this array to add regular expressions used to disable offline support for specific urls
  123363. */
  123364. disableOfflineSupportExceptionRules: RegExp[];
  123365. /**
  123366. * An event triggered when the scene is disposed.
  123367. */
  123368. onDisposeObservable: Observable<Scene>;
  123369. private _onDisposeObserver;
  123370. /** Sets a function to be executed when this scene is disposed. */
  123371. set onDispose(callback: () => void);
  123372. /**
  123373. * An event triggered before rendering the scene (right after animations and physics)
  123374. */
  123375. onBeforeRenderObservable: Observable<Scene>;
  123376. private _onBeforeRenderObserver;
  123377. /** Sets a function to be executed before rendering this scene */
  123378. set beforeRender(callback: Nullable<() => void>);
  123379. /**
  123380. * An event triggered after rendering the scene
  123381. */
  123382. onAfterRenderObservable: Observable<Scene>;
  123383. /**
  123384. * An event triggered after rendering the scene for an active camera (When scene.render is called this will be called after each camera)
  123385. */
  123386. onAfterRenderCameraObservable: Observable<Camera>;
  123387. private _onAfterRenderObserver;
  123388. /** Sets a function to be executed after rendering this scene */
  123389. set afterRender(callback: Nullable<() => void>);
  123390. /**
  123391. * An event triggered before animating the scene
  123392. */
  123393. onBeforeAnimationsObservable: Observable<Scene>;
  123394. /**
  123395. * An event triggered after animations processing
  123396. */
  123397. onAfterAnimationsObservable: Observable<Scene>;
  123398. /**
  123399. * An event triggered before draw calls are ready to be sent
  123400. */
  123401. onBeforeDrawPhaseObservable: Observable<Scene>;
  123402. /**
  123403. * An event triggered after draw calls have been sent
  123404. */
  123405. onAfterDrawPhaseObservable: Observable<Scene>;
  123406. /**
  123407. * An event triggered when the scene is ready
  123408. */
  123409. onReadyObservable: Observable<Scene>;
  123410. /**
  123411. * An event triggered before rendering a camera
  123412. */
  123413. onBeforeCameraRenderObservable: Observable<Camera>;
  123414. private _onBeforeCameraRenderObserver;
  123415. /** Sets a function to be executed before rendering a camera*/
  123416. set beforeCameraRender(callback: () => void);
  123417. /**
  123418. * An event triggered after rendering a camera
  123419. */
  123420. onAfterCameraRenderObservable: Observable<Camera>;
  123421. private _onAfterCameraRenderObserver;
  123422. /** Sets a function to be executed after rendering a camera*/
  123423. set afterCameraRender(callback: () => void);
  123424. /**
  123425. * An event triggered when active meshes evaluation is about to start
  123426. */
  123427. onBeforeActiveMeshesEvaluationObservable: Observable<Scene>;
  123428. /**
  123429. * An event triggered when active meshes evaluation is done
  123430. */
  123431. onAfterActiveMeshesEvaluationObservable: Observable<Scene>;
  123432. /**
  123433. * An event triggered when particles rendering is about to start
  123434. * Note: This event can be trigger more than once per frame (because particles can be rendered by render target textures as well)
  123435. */
  123436. onBeforeParticlesRenderingObservable: Observable<Scene>;
  123437. /**
  123438. * An event triggered when particles rendering is done
  123439. * Note: This event can be trigger more than once per frame (because particles can be rendered by render target textures as well)
  123440. */
  123441. onAfterParticlesRenderingObservable: Observable<Scene>;
  123442. /**
  123443. * An event triggered when SceneLoader.Append or SceneLoader.Load or SceneLoader.ImportMesh were successfully executed
  123444. */
  123445. onDataLoadedObservable: Observable<Scene>;
  123446. /**
  123447. * An event triggered when a camera is created
  123448. */
  123449. onNewCameraAddedObservable: Observable<Camera>;
  123450. /**
  123451. * An event triggered when a camera is removed
  123452. */
  123453. onCameraRemovedObservable: Observable<Camera>;
  123454. /**
  123455. * An event triggered when a light is created
  123456. */
  123457. onNewLightAddedObservable: Observable<Light>;
  123458. /**
  123459. * An event triggered when a light is removed
  123460. */
  123461. onLightRemovedObservable: Observable<Light>;
  123462. /**
  123463. * An event triggered when a geometry is created
  123464. */
  123465. onNewGeometryAddedObservable: Observable<Geometry>;
  123466. /**
  123467. * An event triggered when a geometry is removed
  123468. */
  123469. onGeometryRemovedObservable: Observable<Geometry>;
  123470. /**
  123471. * An event triggered when a transform node is created
  123472. */
  123473. onNewTransformNodeAddedObservable: Observable<TransformNode>;
  123474. /**
  123475. * An event triggered when a transform node is removed
  123476. */
  123477. onTransformNodeRemovedObservable: Observable<TransformNode>;
  123478. /**
  123479. * An event triggered when a mesh is created
  123480. */
  123481. onNewMeshAddedObservable: Observable<AbstractMesh>;
  123482. /**
  123483. * An event triggered when a mesh is removed
  123484. */
  123485. onMeshRemovedObservable: Observable<AbstractMesh>;
  123486. /**
  123487. * An event triggered when a skeleton is created
  123488. */
  123489. onNewSkeletonAddedObservable: Observable<Skeleton>;
  123490. /**
  123491. * An event triggered when a skeleton is removed
  123492. */
  123493. onSkeletonRemovedObservable: Observable<Skeleton>;
  123494. /**
  123495. * An event triggered when a material is created
  123496. */
  123497. onNewMaterialAddedObservable: Observable<Material>;
  123498. /**
  123499. * An event triggered when a material is removed
  123500. */
  123501. onMaterialRemovedObservable: Observable<Material>;
  123502. /**
  123503. * An event triggered when a texture is created
  123504. */
  123505. onNewTextureAddedObservable: Observable<BaseTexture>;
  123506. /**
  123507. * An event triggered when a texture is removed
  123508. */
  123509. onTextureRemovedObservable: Observable<BaseTexture>;
  123510. /**
  123511. * An event triggered when render targets are about to be rendered
  123512. * Can happen multiple times per frame.
  123513. */
  123514. onBeforeRenderTargetsRenderObservable: Observable<Scene>;
  123515. /**
  123516. * An event triggered when render targets were rendered.
  123517. * Can happen multiple times per frame.
  123518. */
  123519. onAfterRenderTargetsRenderObservable: Observable<Scene>;
  123520. /**
  123521. * An event triggered before calculating deterministic simulation step
  123522. */
  123523. onBeforeStepObservable: Observable<Scene>;
  123524. /**
  123525. * An event triggered after calculating deterministic simulation step
  123526. */
  123527. onAfterStepObservable: Observable<Scene>;
  123528. /**
  123529. * An event triggered when the activeCamera property is updated
  123530. */
  123531. onActiveCameraChanged: Observable<Scene>;
  123532. /**
  123533. * This Observable will be triggered before rendering each renderingGroup of each rendered camera.
  123534. * The RenderinGroupInfo class contains all the information about the context in which the observable is called
  123535. * 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)
  123536. */
  123537. onBeforeRenderingGroupObservable: Observable<RenderingGroupInfo>;
  123538. /**
  123539. * This Observable will be triggered after rendering each renderingGroup of each rendered camera.
  123540. * The RenderinGroupInfo class contains all the information about the context in which the observable is called
  123541. * 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)
  123542. */
  123543. onAfterRenderingGroupObservable: Observable<RenderingGroupInfo>;
  123544. /**
  123545. * This Observable will when a mesh has been imported into the scene.
  123546. */
  123547. onMeshImportedObservable: Observable<AbstractMesh>;
  123548. /**
  123549. * This Observable will when an animation file has been imported into the scene.
  123550. */
  123551. onAnimationFileImportedObservable: Observable<Scene>;
  123552. /**
  123553. * Gets or sets a user defined funtion to select LOD from a mesh and a camera.
  123554. * By default this function is undefined and Babylon.js will select LOD based on distance to camera
  123555. */
  123556. customLODSelector: (mesh: AbstractMesh, camera: Camera) => Nullable<AbstractMesh>;
  123557. /** @hidden */
  123558. _registeredForLateAnimationBindings: SmartArrayNoDuplicate<any>;
  123559. /**
  123560. * Gets or sets a predicate used to select candidate meshes for a pointer down event
  123561. */
  123562. pointerDownPredicate: (Mesh: AbstractMesh) => boolean;
  123563. /**
  123564. * Gets or sets a predicate used to select candidate meshes for a pointer up event
  123565. */
  123566. pointerUpPredicate: (Mesh: AbstractMesh) => boolean;
  123567. /**
  123568. * Gets or sets a predicate used to select candidate meshes for a pointer move event
  123569. */
  123570. pointerMovePredicate: (Mesh: AbstractMesh) => boolean;
  123571. /** Callback called when a pointer move is detected */
  123572. onPointerMove: (evt: PointerEvent, pickInfo: PickingInfo, type: PointerEventTypes) => void;
  123573. /** Callback called when a pointer down is detected */
  123574. onPointerDown: (evt: PointerEvent, pickInfo: PickingInfo, type: PointerEventTypes) => void;
  123575. /** Callback called when a pointer up is detected */
  123576. onPointerUp: (evt: PointerEvent, pickInfo: Nullable<PickingInfo>, type: PointerEventTypes) => void;
  123577. /** Callback called when a pointer pick is detected */
  123578. onPointerPick: (evt: PointerEvent, pickInfo: PickingInfo) => void;
  123579. /**
  123580. * 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).
  123581. * You have the possibility to skip the process and the call to onPointerObservable by setting PointerInfoPre.skipOnPointerObservable to true
  123582. */
  123583. onPrePointerObservable: Observable<PointerInfoPre>;
  123584. /**
  123585. * Observable event triggered each time an input event is received from the rendering canvas
  123586. */
  123587. onPointerObservable: Observable<PointerInfo>;
  123588. /**
  123589. * Gets the pointer coordinates without any translation (ie. straight out of the pointer event)
  123590. */
  123591. get unTranslatedPointer(): Vector2;
  123592. /**
  123593. * Gets or sets the distance in pixel that you have to move to prevent some events. Default is 10 pixels
  123594. */
  123595. static get DragMovementThreshold(): number;
  123596. static set DragMovementThreshold(value: number);
  123597. /**
  123598. * Time in milliseconds to wait to raise long press events if button is still pressed. Default is 500 ms
  123599. */
  123600. static get LongPressDelay(): number;
  123601. static set LongPressDelay(value: number);
  123602. /**
  123603. * Time in milliseconds to wait to raise long press events if button is still pressed. Default is 300 ms
  123604. */
  123605. static get DoubleClickDelay(): number;
  123606. static set DoubleClickDelay(value: number);
  123607. /** If you need to check double click without raising a single click at first click, enable this flag */
  123608. static get ExclusiveDoubleClickMode(): boolean;
  123609. static set ExclusiveDoubleClickMode(value: boolean);
  123610. /** @hidden */
  123611. _mirroredCameraPosition: Nullable<Vector3>;
  123612. /**
  123613. * This observable event is triggered when any keyboard event si raised and registered during Scene.attachControl()
  123614. * You have the possibility to skip the process and the call to onKeyboardObservable by setting KeyboardInfoPre.skipOnPointerObservable to true
  123615. */
  123616. onPreKeyboardObservable: Observable<KeyboardInfoPre>;
  123617. /**
  123618. * Observable event triggered each time an keyboard event is received from the hosting window
  123619. */
  123620. onKeyboardObservable: Observable<KeyboardInfo>;
  123621. private _useRightHandedSystem;
  123622. /**
  123623. * Gets or sets a boolean indicating if the scene must use right-handed coordinates system
  123624. */
  123625. set useRightHandedSystem(value: boolean);
  123626. get useRightHandedSystem(): boolean;
  123627. private _timeAccumulator;
  123628. private _currentStepId;
  123629. private _currentInternalStep;
  123630. /**
  123631. * Sets the step Id used by deterministic lock step
  123632. * @see https://doc.babylonjs.com/babylon101/animations#deterministic-lockstep
  123633. * @param newStepId defines the step Id
  123634. */
  123635. setStepId(newStepId: number): void;
  123636. /**
  123637. * Gets the step Id used by deterministic lock step
  123638. * @see https://doc.babylonjs.com/babylon101/animations#deterministic-lockstep
  123639. * @returns the step Id
  123640. */
  123641. getStepId(): number;
  123642. /**
  123643. * Gets the internal step used by deterministic lock step
  123644. * @see https://doc.babylonjs.com/babylon101/animations#deterministic-lockstep
  123645. * @returns the internal step
  123646. */
  123647. getInternalStep(): number;
  123648. private _fogEnabled;
  123649. /**
  123650. * Gets or sets a boolean indicating if fog is enabled on this scene
  123651. * @see https://doc.babylonjs.com/babylon101/environment#fog
  123652. * (Default is true)
  123653. */
  123654. set fogEnabled(value: boolean);
  123655. get fogEnabled(): boolean;
  123656. private _fogMode;
  123657. /**
  123658. * Gets or sets the fog mode to use
  123659. * @see https://doc.babylonjs.com/babylon101/environment#fog
  123660. * | mode | value |
  123661. * | --- | --- |
  123662. * | FOGMODE_NONE | 0 |
  123663. * | FOGMODE_EXP | 1 |
  123664. * | FOGMODE_EXP2 | 2 |
  123665. * | FOGMODE_LINEAR | 3 |
  123666. */
  123667. set fogMode(value: number);
  123668. get fogMode(): number;
  123669. /**
  123670. * Gets or sets the fog color to use
  123671. * @see https://doc.babylonjs.com/babylon101/environment#fog
  123672. * (Default is Color3(0.2, 0.2, 0.3))
  123673. */
  123674. fogColor: Color3;
  123675. /**
  123676. * Gets or sets the fog density to use
  123677. * @see https://doc.babylonjs.com/babylon101/environment#fog
  123678. * (Default is 0.1)
  123679. */
  123680. fogDensity: number;
  123681. /**
  123682. * Gets or sets the fog start distance to use
  123683. * @see https://doc.babylonjs.com/babylon101/environment#fog
  123684. * (Default is 0)
  123685. */
  123686. fogStart: number;
  123687. /**
  123688. * Gets or sets the fog end distance to use
  123689. * @see https://doc.babylonjs.com/babylon101/environment#fog
  123690. * (Default is 1000)
  123691. */
  123692. fogEnd: number;
  123693. /**
  123694. * Flag indicating that the frame buffer binding is handled by another component
  123695. */
  123696. prePass: boolean;
  123697. private _shadowsEnabled;
  123698. /**
  123699. * Gets or sets a boolean indicating if shadows are enabled on this scene
  123700. */
  123701. set shadowsEnabled(value: boolean);
  123702. get shadowsEnabled(): boolean;
  123703. private _lightsEnabled;
  123704. /**
  123705. * Gets or sets a boolean indicating if lights are enabled on this scene
  123706. */
  123707. set lightsEnabled(value: boolean);
  123708. get lightsEnabled(): boolean;
  123709. /** All of the active cameras added to this scene. */
  123710. activeCameras: Camera[];
  123711. /** @hidden */
  123712. _activeCamera: Nullable<Camera>;
  123713. /** Gets or sets the current active camera */
  123714. get activeCamera(): Nullable<Camera>;
  123715. set activeCamera(value: Nullable<Camera>);
  123716. private _defaultMaterial;
  123717. /** The default material used on meshes when no material is affected */
  123718. get defaultMaterial(): Material;
  123719. /** The default material used on meshes when no material is affected */
  123720. set defaultMaterial(value: Material);
  123721. private _texturesEnabled;
  123722. /**
  123723. * Gets or sets a boolean indicating if textures are enabled on this scene
  123724. */
  123725. set texturesEnabled(value: boolean);
  123726. get texturesEnabled(): boolean;
  123727. /**
  123728. * Gets or sets a boolean indicating if physic engines are enabled on this scene
  123729. */
  123730. physicsEnabled: boolean;
  123731. /**
  123732. * Gets or sets a boolean indicating if particles are enabled on this scene
  123733. */
  123734. particlesEnabled: boolean;
  123735. /**
  123736. * Gets or sets a boolean indicating if sprites are enabled on this scene
  123737. */
  123738. spritesEnabled: boolean;
  123739. private _skeletonsEnabled;
  123740. /**
  123741. * Gets or sets a boolean indicating if skeletons are enabled on this scene
  123742. */
  123743. set skeletonsEnabled(value: boolean);
  123744. get skeletonsEnabled(): boolean;
  123745. /**
  123746. * Gets or sets a boolean indicating if lens flares are enabled on this scene
  123747. */
  123748. lensFlaresEnabled: boolean;
  123749. /**
  123750. * Gets or sets a boolean indicating if collisions are enabled on this scene
  123751. * @see https://doc.babylonjs.com/babylon101/cameras,_mesh_collisions_and_gravity
  123752. */
  123753. collisionsEnabled: boolean;
  123754. private _collisionCoordinator;
  123755. /** @hidden */
  123756. get collisionCoordinator(): ICollisionCoordinator;
  123757. /**
  123758. * Defines the gravity applied to this scene (used only for collisions)
  123759. * @see https://doc.babylonjs.com/babylon101/cameras,_mesh_collisions_and_gravity
  123760. */
  123761. gravity: Vector3;
  123762. /**
  123763. * Gets or sets a boolean indicating if postprocesses are enabled on this scene
  123764. */
  123765. postProcessesEnabled: boolean;
  123766. /**
  123767. * Gets the current postprocess manager
  123768. */
  123769. postProcessManager: PostProcessManager;
  123770. /**
  123771. * Gets or sets a boolean indicating if render targets are enabled on this scene
  123772. */
  123773. renderTargetsEnabled: boolean;
  123774. /**
  123775. * Gets or sets a boolean indicating if next render targets must be dumped as image for debugging purposes
  123776. * We recommend not using it and instead rely on Spector.js: http://spector.babylonjs.com
  123777. */
  123778. dumpNextRenderTargets: boolean;
  123779. /**
  123780. * The list of user defined render targets added to the scene
  123781. */
  123782. customRenderTargets: RenderTargetTexture[];
  123783. /**
  123784. * Defines if texture loading must be delayed
  123785. * If true, textures will only be loaded when they need to be rendered
  123786. */
  123787. useDelayedTextureLoading: boolean;
  123788. /**
  123789. * Gets the list of meshes imported to the scene through SceneLoader
  123790. */
  123791. importedMeshesFiles: String[];
  123792. /**
  123793. * Gets or sets a boolean indicating if probes are enabled on this scene
  123794. */
  123795. probesEnabled: boolean;
  123796. /**
  123797. * Gets or sets the current offline provider to use to store scene data
  123798. * @see https://doc.babylonjs.com/how_to/caching_resources_in_indexeddb
  123799. */
  123800. offlineProvider: IOfflineProvider;
  123801. /**
  123802. * Gets or sets the action manager associated with the scene
  123803. * @see https://doc.babylonjs.com/how_to/how_to_use_actions
  123804. */
  123805. actionManager: AbstractActionManager;
  123806. private _meshesForIntersections;
  123807. /**
  123808. * Gets or sets a boolean indicating if procedural textures are enabled on this scene
  123809. */
  123810. proceduralTexturesEnabled: boolean;
  123811. private _engine;
  123812. private _totalVertices;
  123813. /** @hidden */
  123814. _activeIndices: PerfCounter;
  123815. /** @hidden */
  123816. _activeParticles: PerfCounter;
  123817. /** @hidden */
  123818. _activeBones: PerfCounter;
  123819. private _animationRatio;
  123820. /** @hidden */
  123821. _animationTimeLast: number;
  123822. /** @hidden */
  123823. _animationTime: number;
  123824. /**
  123825. * Gets or sets a general scale for animation speed
  123826. * @see https://www.babylonjs-playground.com/#IBU2W7#3
  123827. */
  123828. animationTimeScale: number;
  123829. /** @hidden */
  123830. _cachedMaterial: Nullable<Material>;
  123831. /** @hidden */
  123832. _cachedEffect: Nullable<Effect>;
  123833. /** @hidden */
  123834. _cachedVisibility: Nullable<number>;
  123835. private _renderId;
  123836. private _frameId;
  123837. private _executeWhenReadyTimeoutId;
  123838. private _intermediateRendering;
  123839. private _viewUpdateFlag;
  123840. private _projectionUpdateFlag;
  123841. /** @hidden */
  123842. _toBeDisposed: Nullable<IDisposable>[];
  123843. private _activeRequests;
  123844. /** @hidden */
  123845. _pendingData: any[];
  123846. private _isDisposed;
  123847. /**
  123848. * Gets or sets a boolean indicating that all submeshes of active meshes must be rendered
  123849. * Use this boolean to avoid computing frustum clipping on submeshes (This could help when you are CPU bound)
  123850. */
  123851. dispatchAllSubMeshesOfActiveMeshes: boolean;
  123852. private _activeMeshes;
  123853. private _processedMaterials;
  123854. private _renderTargets;
  123855. /** @hidden */
  123856. _activeParticleSystems: SmartArray<IParticleSystem>;
  123857. private _activeSkeletons;
  123858. private _softwareSkinnedMeshes;
  123859. private _renderingManager;
  123860. /** @hidden */
  123861. _activeAnimatables: Animatable[];
  123862. private _transformMatrix;
  123863. private _sceneUbo;
  123864. /** @hidden */
  123865. _viewMatrix: Matrix;
  123866. private _projectionMatrix;
  123867. /** @hidden */
  123868. _forcedViewPosition: Nullable<Vector3>;
  123869. /** @hidden */
  123870. _frustumPlanes: Plane[];
  123871. /**
  123872. * Gets the list of frustum planes (built from the active camera)
  123873. */
  123874. get frustumPlanes(): Plane[];
  123875. /**
  123876. * Gets or sets a boolean indicating if lights must be sorted by priority (off by default)
  123877. * This is useful if there are more lights that the maximum simulteanous authorized
  123878. */
  123879. requireLightSorting: boolean;
  123880. /** @hidden */
  123881. readonly useMaterialMeshMap: boolean;
  123882. /** @hidden */
  123883. readonly useClonedMeshMap: boolean;
  123884. private _externalData;
  123885. private _uid;
  123886. /**
  123887. * @hidden
  123888. * Backing store of defined scene components.
  123889. */
  123890. _components: ISceneComponent[];
  123891. /**
  123892. * @hidden
  123893. * Backing store of defined scene components.
  123894. */
  123895. _serializableComponents: ISceneSerializableComponent[];
  123896. /**
  123897. * List of components to register on the next registration step.
  123898. */
  123899. private _transientComponents;
  123900. /**
  123901. * Registers the transient components if needed.
  123902. */
  123903. private _registerTransientComponents;
  123904. /**
  123905. * @hidden
  123906. * Add a component to the scene.
  123907. * Note that the ccomponent could be registered on th next frame if this is called after
  123908. * the register component stage.
  123909. * @param component Defines the component to add to the scene
  123910. */
  123911. _addComponent(component: ISceneComponent): void;
  123912. /**
  123913. * @hidden
  123914. * Gets a component from the scene.
  123915. * @param name defines the name of the component to retrieve
  123916. * @returns the component or null if not present
  123917. */
  123918. _getComponent(name: string): Nullable<ISceneComponent>;
  123919. /**
  123920. * @hidden
  123921. * Defines the actions happening before camera updates.
  123922. */
  123923. _beforeCameraUpdateStage: Stage<SimpleStageAction>;
  123924. /**
  123925. * @hidden
  123926. * Defines the actions happening before clear the canvas.
  123927. */
  123928. _beforeClearStage: Stage<SimpleStageAction>;
  123929. /**
  123930. * @hidden
  123931. * Defines the actions when collecting render targets for the frame.
  123932. */
  123933. _gatherRenderTargetsStage: Stage<RenderTargetsStageAction>;
  123934. /**
  123935. * @hidden
  123936. * Defines the actions happening for one camera in the frame.
  123937. */
  123938. _gatherActiveCameraRenderTargetsStage: Stage<RenderTargetsStageAction>;
  123939. /**
  123940. * @hidden
  123941. * Defines the actions happening during the per mesh ready checks.
  123942. */
  123943. _isReadyForMeshStage: Stage<MeshStageAction>;
  123944. /**
  123945. * @hidden
  123946. * Defines the actions happening before evaluate active mesh checks.
  123947. */
  123948. _beforeEvaluateActiveMeshStage: Stage<SimpleStageAction>;
  123949. /**
  123950. * @hidden
  123951. * Defines the actions happening during the evaluate sub mesh checks.
  123952. */
  123953. _evaluateSubMeshStage: Stage<EvaluateSubMeshStageAction>;
  123954. /**
  123955. * @hidden
  123956. * Defines the actions happening during the active mesh stage.
  123957. */
  123958. _activeMeshStage: Stage<ActiveMeshStageAction>;
  123959. /**
  123960. * @hidden
  123961. * Defines the actions happening during the per camera render target step.
  123962. */
  123963. _cameraDrawRenderTargetStage: Stage<CameraStageFrameBufferAction>;
  123964. /**
  123965. * @hidden
  123966. * Defines the actions happening just before the active camera is drawing.
  123967. */
  123968. _beforeCameraDrawStage: Stage<CameraStageAction>;
  123969. /**
  123970. * @hidden
  123971. * Defines the actions happening just before a render target is drawing.
  123972. */
  123973. _beforeRenderTargetDrawStage: Stage<RenderTargetStageAction>;
  123974. /**
  123975. * @hidden
  123976. * Defines the actions happening just before a rendering group is drawing.
  123977. */
  123978. _beforeRenderingGroupDrawStage: Stage<RenderingGroupStageAction>;
  123979. /**
  123980. * @hidden
  123981. * Defines the actions happening just before a mesh is drawing.
  123982. */
  123983. _beforeRenderingMeshStage: Stage<RenderingMeshStageAction>;
  123984. /**
  123985. * @hidden
  123986. * Defines the actions happening just after a mesh has been drawn.
  123987. */
  123988. _afterRenderingMeshStage: Stage<RenderingMeshStageAction>;
  123989. /**
  123990. * @hidden
  123991. * Defines the actions happening just after a rendering group has been drawn.
  123992. */
  123993. _afterRenderingGroupDrawStage: Stage<RenderingGroupStageAction>;
  123994. /**
  123995. * @hidden
  123996. * Defines the actions happening just after the active camera has been drawn.
  123997. */
  123998. _afterCameraDrawStage: Stage<CameraStageAction>;
  123999. /**
  124000. * @hidden
  124001. * Defines the actions happening just after a render target has been drawn.
  124002. */
  124003. _afterRenderTargetDrawStage: Stage<RenderTargetStageAction>;
  124004. /**
  124005. * @hidden
  124006. * Defines the actions happening just after rendering all cameras and computing intersections.
  124007. */
  124008. _afterRenderStage: Stage<SimpleStageAction>;
  124009. /**
  124010. * @hidden
  124011. * Defines the actions happening when a pointer move event happens.
  124012. */
  124013. _pointerMoveStage: Stage<PointerMoveStageAction>;
  124014. /**
  124015. * @hidden
  124016. * Defines the actions happening when a pointer down event happens.
  124017. */
  124018. _pointerDownStage: Stage<PointerUpDownStageAction>;
  124019. /**
  124020. * @hidden
  124021. * Defines the actions happening when a pointer up event happens.
  124022. */
  124023. _pointerUpStage: Stage<PointerUpDownStageAction>;
  124024. /**
  124025. * an optional map from Geometry Id to Geometry index in the 'geometries' array
  124026. */
  124027. private geometriesByUniqueId;
  124028. /**
  124029. * Creates a new Scene
  124030. * @param engine defines the engine to use to render this scene
  124031. * @param options defines the scene options
  124032. */
  124033. constructor(engine: Engine, options?: SceneOptions);
  124034. /**
  124035. * Gets a string identifying the name of the class
  124036. * @returns "Scene" string
  124037. */
  124038. getClassName(): string;
  124039. private _defaultMeshCandidates;
  124040. /**
  124041. * @hidden
  124042. */
  124043. _getDefaultMeshCandidates(): ISmartArrayLike<AbstractMesh>;
  124044. private _defaultSubMeshCandidates;
  124045. /**
  124046. * @hidden
  124047. */
  124048. _getDefaultSubMeshCandidates(mesh: AbstractMesh): ISmartArrayLike<SubMesh>;
  124049. /**
  124050. * Sets the default candidate providers for the scene.
  124051. * This sets the getActiveMeshCandidates, getActiveSubMeshCandidates, getIntersectingSubMeshCandidates
  124052. * and getCollidingSubMeshCandidates to their default function
  124053. */
  124054. setDefaultCandidateProviders(): void;
  124055. /**
  124056. * Gets the mesh that is currently under the pointer
  124057. */
  124058. get meshUnderPointer(): Nullable<AbstractMesh>;
  124059. /**
  124060. * Gets or sets the current on-screen X position of the pointer
  124061. */
  124062. get pointerX(): number;
  124063. set pointerX(value: number);
  124064. /**
  124065. * Gets or sets the current on-screen Y position of the pointer
  124066. */
  124067. get pointerY(): number;
  124068. set pointerY(value: number);
  124069. /**
  124070. * Gets the cached material (ie. the latest rendered one)
  124071. * @returns the cached material
  124072. */
  124073. getCachedMaterial(): Nullable<Material>;
  124074. /**
  124075. * Gets the cached effect (ie. the latest rendered one)
  124076. * @returns the cached effect
  124077. */
  124078. getCachedEffect(): Nullable<Effect>;
  124079. /**
  124080. * Gets the cached visibility state (ie. the latest rendered one)
  124081. * @returns the cached visibility state
  124082. */
  124083. getCachedVisibility(): Nullable<number>;
  124084. /**
  124085. * Gets a boolean indicating if the current material / effect / visibility must be bind again
  124086. * @param material defines the current material
  124087. * @param effect defines the current effect
  124088. * @param visibility defines the current visibility state
  124089. * @returns true if one parameter is not cached
  124090. */
  124091. isCachedMaterialInvalid(material: Material, effect: Effect, visibility?: number): boolean;
  124092. /**
  124093. * Gets the engine associated with the scene
  124094. * @returns an Engine
  124095. */
  124096. getEngine(): Engine;
  124097. /**
  124098. * Gets the total number of vertices rendered per frame
  124099. * @returns the total number of vertices rendered per frame
  124100. */
  124101. getTotalVertices(): number;
  124102. /**
  124103. * Gets the performance counter for total vertices
  124104. * @see https://doc.babylonjs.com/how_to/optimizing_your_scene#instrumentation
  124105. */
  124106. get totalVerticesPerfCounter(): PerfCounter;
  124107. /**
  124108. * Gets the total number of active indices rendered per frame (You can deduce the number of rendered triangles by dividing this number by 3)
  124109. * @returns the total number of active indices rendered per frame
  124110. */
  124111. getActiveIndices(): number;
  124112. /**
  124113. * Gets the performance counter for active indices
  124114. * @see https://doc.babylonjs.com/how_to/optimizing_your_scene#instrumentation
  124115. */
  124116. get totalActiveIndicesPerfCounter(): PerfCounter;
  124117. /**
  124118. * Gets the total number of active particles rendered per frame
  124119. * @returns the total number of active particles rendered per frame
  124120. */
  124121. getActiveParticles(): number;
  124122. /**
  124123. * Gets the performance counter for active particles
  124124. * @see https://doc.babylonjs.com/how_to/optimizing_your_scene#instrumentation
  124125. */
  124126. get activeParticlesPerfCounter(): PerfCounter;
  124127. /**
  124128. * Gets the total number of active bones rendered per frame
  124129. * @returns the total number of active bones rendered per frame
  124130. */
  124131. getActiveBones(): number;
  124132. /**
  124133. * Gets the performance counter for active bones
  124134. * @see https://doc.babylonjs.com/how_to/optimizing_your_scene#instrumentation
  124135. */
  124136. get activeBonesPerfCounter(): PerfCounter;
  124137. /**
  124138. * Gets the array of active meshes
  124139. * @returns an array of AbstractMesh
  124140. */
  124141. getActiveMeshes(): SmartArray<AbstractMesh>;
  124142. /**
  124143. * Gets the animation ratio (which is 1.0 is the scene renders at 60fps and 2 if the scene renders at 30fps, etc.)
  124144. * @returns a number
  124145. */
  124146. getAnimationRatio(): number;
  124147. /**
  124148. * Gets an unique Id for the current render phase
  124149. * @returns a number
  124150. */
  124151. getRenderId(): number;
  124152. /**
  124153. * Gets an unique Id for the current frame
  124154. * @returns a number
  124155. */
  124156. getFrameId(): number;
  124157. /** Call this function if you want to manually increment the render Id*/
  124158. incrementRenderId(): void;
  124159. private _createUbo;
  124160. /**
  124161. * Use this method to simulate a pointer move on a mesh
  124162. * The pickResult parameter can be obtained from a scene.pick or scene.pickWithRay
  124163. * @param pickResult pickingInfo of the object wished to simulate pointer event on
  124164. * @param pointerEventInit pointer event state to be used when simulating the pointer event (eg. pointer id for multitouch)
  124165. * @returns the current scene
  124166. */
  124167. simulatePointerMove(pickResult: PickingInfo, pointerEventInit?: PointerEventInit): Scene;
  124168. /**
  124169. * Use this method to simulate a pointer down on a mesh
  124170. * The pickResult parameter can be obtained from a scene.pick or scene.pickWithRay
  124171. * @param pickResult pickingInfo of the object wished to simulate pointer event on
  124172. * @param pointerEventInit pointer event state to be used when simulating the pointer event (eg. pointer id for multitouch)
  124173. * @returns the current scene
  124174. */
  124175. simulatePointerDown(pickResult: PickingInfo, pointerEventInit?: PointerEventInit): Scene;
  124176. /**
  124177. * Use this method to simulate a pointer up on a mesh
  124178. * The pickResult parameter can be obtained from a scene.pick or scene.pickWithRay
  124179. * @param pickResult pickingInfo of the object wished to simulate pointer event on
  124180. * @param pointerEventInit pointer event state to be used when simulating the pointer event (eg. pointer id for multitouch)
  124181. * @param doubleTap indicates that the pointer up event should be considered as part of a double click (false by default)
  124182. * @returns the current scene
  124183. */
  124184. simulatePointerUp(pickResult: PickingInfo, pointerEventInit?: PointerEventInit, doubleTap?: boolean): Scene;
  124185. /**
  124186. * Gets a boolean indicating if the current pointer event is captured (meaning that the scene has already handled the pointer down)
  124187. * @param pointerId defines the pointer id to use in a multi-touch scenario (0 by default)
  124188. * @returns true if the pointer was captured
  124189. */
  124190. isPointerCaptured(pointerId?: number): boolean;
  124191. /**
  124192. * Attach events to the canvas (To handle actionManagers triggers and raise onPointerMove, onPointerDown and onPointerUp
  124193. * @param attachUp defines if you want to attach events to pointerup
  124194. * @param attachDown defines if you want to attach events to pointerdown
  124195. * @param attachMove defines if you want to attach events to pointermove
  124196. */
  124197. attachControl(attachUp?: boolean, attachDown?: boolean, attachMove?: boolean): void;
  124198. /** Detaches all event handlers*/
  124199. detachControl(): void;
  124200. /**
  124201. * This function will check if the scene can be rendered (textures are loaded, shaders are compiled)
  124202. * Delay loaded resources are not taking in account
  124203. * @return true if all required resources are ready
  124204. */
  124205. isReady(): boolean;
  124206. /** Resets all cached information relative to material (including effect and visibility) */
  124207. resetCachedMaterial(): void;
  124208. /**
  124209. * Registers a function to be called before every frame render
  124210. * @param func defines the function to register
  124211. */
  124212. registerBeforeRender(func: () => void): void;
  124213. /**
  124214. * Unregisters a function called before every frame render
  124215. * @param func defines the function to unregister
  124216. */
  124217. unregisterBeforeRender(func: () => void): void;
  124218. /**
  124219. * Registers a function to be called after every frame render
  124220. * @param func defines the function to register
  124221. */
  124222. registerAfterRender(func: () => void): void;
  124223. /**
  124224. * Unregisters a function called after every frame render
  124225. * @param func defines the function to unregister
  124226. */
  124227. unregisterAfterRender(func: () => void): void;
  124228. private _executeOnceBeforeRender;
  124229. /**
  124230. * The provided function will run before render once and will be disposed afterwards.
  124231. * A timeout delay can be provided so that the function will be executed in N ms.
  124232. * The timeout is using the browser's native setTimeout so time percision cannot be guaranteed.
  124233. * @param func The function to be executed.
  124234. * @param timeout optional delay in ms
  124235. */
  124236. executeOnceBeforeRender(func: () => void, timeout?: number): void;
  124237. /** @hidden */
  124238. _addPendingData(data: any): void;
  124239. /** @hidden */
  124240. _removePendingData(data: any): void;
  124241. /**
  124242. * Returns the number of items waiting to be loaded
  124243. * @returns the number of items waiting to be loaded
  124244. */
  124245. getWaitingItemsCount(): number;
  124246. /**
  124247. * Returns a boolean indicating if the scene is still loading data
  124248. */
  124249. get isLoading(): boolean;
  124250. /**
  124251. * Registers a function to be executed when the scene is ready
  124252. * @param {Function} func - the function to be executed
  124253. */
  124254. executeWhenReady(func: () => void): void;
  124255. /**
  124256. * Returns a promise that resolves when the scene is ready
  124257. * @returns A promise that resolves when the scene is ready
  124258. */
  124259. whenReadyAsync(): Promise<void>;
  124260. /** @hidden */
  124261. _checkIsReady(): void;
  124262. /**
  124263. * Gets all animatable attached to the scene
  124264. */
  124265. get animatables(): Animatable[];
  124266. /**
  124267. * Resets the last animation time frame.
  124268. * Useful to override when animations start running when loading a scene for the first time.
  124269. */
  124270. resetLastAnimationTimeFrame(): void;
  124271. /**
  124272. * Gets the current view matrix
  124273. * @returns a Matrix
  124274. */
  124275. getViewMatrix(): Matrix;
  124276. /**
  124277. * Gets the current projection matrix
  124278. * @returns a Matrix
  124279. */
  124280. getProjectionMatrix(): Matrix;
  124281. /**
  124282. * Gets the current transform matrix
  124283. * @returns a Matrix made of View * Projection
  124284. */
  124285. getTransformMatrix(): Matrix;
  124286. /**
  124287. * Sets the current transform matrix
  124288. * @param viewL defines the View matrix to use
  124289. * @param projectionL defines the Projection matrix to use
  124290. * @param viewR defines the right View matrix to use (if provided)
  124291. * @param projectionR defines the right Projection matrix to use (if provided)
  124292. */
  124293. setTransformMatrix(viewL: Matrix, projectionL: Matrix, viewR?: Matrix, projectionR?: Matrix): void;
  124294. /**
  124295. * Gets the uniform buffer used to store scene data
  124296. * @returns a UniformBuffer
  124297. */
  124298. getSceneUniformBuffer(): UniformBuffer;
  124299. /**
  124300. * Gets an unique (relatively to the current scene) Id
  124301. * @returns an unique number for the scene
  124302. */
  124303. getUniqueId(): number;
  124304. /**
  124305. * Add a mesh to the list of scene's meshes
  124306. * @param newMesh defines the mesh to add
  124307. * @param recursive if all child meshes should also be added to the scene
  124308. */
  124309. addMesh(newMesh: AbstractMesh, recursive?: boolean): void;
  124310. /**
  124311. * Remove a mesh for the list of scene's meshes
  124312. * @param toRemove defines the mesh to remove
  124313. * @param recursive if all child meshes should also be removed from the scene
  124314. * @returns the index where the mesh was in the mesh list
  124315. */
  124316. removeMesh(toRemove: AbstractMesh, recursive?: boolean): number;
  124317. /**
  124318. * Add a transform node to the list of scene's transform nodes
  124319. * @param newTransformNode defines the transform node to add
  124320. */
  124321. addTransformNode(newTransformNode: TransformNode): void;
  124322. /**
  124323. * Remove a transform node for the list of scene's transform nodes
  124324. * @param toRemove defines the transform node to remove
  124325. * @returns the index where the transform node was in the transform node list
  124326. */
  124327. removeTransformNode(toRemove: TransformNode): number;
  124328. /**
  124329. * Remove a skeleton for the list of scene's skeletons
  124330. * @param toRemove defines the skeleton to remove
  124331. * @returns the index where the skeleton was in the skeleton list
  124332. */
  124333. removeSkeleton(toRemove: Skeleton): number;
  124334. /**
  124335. * Remove a morph target for the list of scene's morph targets
  124336. * @param toRemove defines the morph target to remove
  124337. * @returns the index where the morph target was in the morph target list
  124338. */
  124339. removeMorphTargetManager(toRemove: MorphTargetManager): number;
  124340. /**
  124341. * Remove a light for the list of scene's lights
  124342. * @param toRemove defines the light to remove
  124343. * @returns the index where the light was in the light list
  124344. */
  124345. removeLight(toRemove: Light): number;
  124346. /**
  124347. * Remove a camera for the list of scene's cameras
  124348. * @param toRemove defines the camera to remove
  124349. * @returns the index where the camera was in the camera list
  124350. */
  124351. removeCamera(toRemove: Camera): number;
  124352. /**
  124353. * Remove a particle system for the list of scene's particle systems
  124354. * @param toRemove defines the particle system to remove
  124355. * @returns the index where the particle system was in the particle system list
  124356. */
  124357. removeParticleSystem(toRemove: IParticleSystem): number;
  124358. /**
  124359. * Remove a animation for the list of scene's animations
  124360. * @param toRemove defines the animation to remove
  124361. * @returns the index where the animation was in the animation list
  124362. */
  124363. removeAnimation(toRemove: Animation): number;
  124364. /**
  124365. * Will stop the animation of the given target
  124366. * @param target - the target
  124367. * @param animationName - the name of the animation to stop (all animations will be stopped if both this and targetMask are empty)
  124368. * @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)
  124369. */
  124370. stopAnimation(target: any, animationName?: string, targetMask?: (target: any) => boolean): void;
  124371. /**
  124372. * Removes the given animation group from this scene.
  124373. * @param toRemove The animation group to remove
  124374. * @returns The index of the removed animation group
  124375. */
  124376. removeAnimationGroup(toRemove: AnimationGroup): number;
  124377. /**
  124378. * Removes the given multi-material from this scene.
  124379. * @param toRemove The multi-material to remove
  124380. * @returns The index of the removed multi-material
  124381. */
  124382. removeMultiMaterial(toRemove: MultiMaterial): number;
  124383. /**
  124384. * Removes the given material from this scene.
  124385. * @param toRemove The material to remove
  124386. * @returns The index of the removed material
  124387. */
  124388. removeMaterial(toRemove: Material): number;
  124389. /**
  124390. * Removes the given action manager from this scene.
  124391. * @param toRemove The action manager to remove
  124392. * @returns The index of the removed action manager
  124393. */
  124394. removeActionManager(toRemove: AbstractActionManager): number;
  124395. /**
  124396. * Removes the given texture from this scene.
  124397. * @param toRemove The texture to remove
  124398. * @returns The index of the removed texture
  124399. */
  124400. removeTexture(toRemove: BaseTexture): number;
  124401. /**
  124402. * Adds the given light to this scene
  124403. * @param newLight The light to add
  124404. */
  124405. addLight(newLight: Light): void;
  124406. /**
  124407. * Sorts the list list based on light priorities
  124408. */
  124409. sortLightsByPriority(): void;
  124410. /**
  124411. * Adds the given camera to this scene
  124412. * @param newCamera The camera to add
  124413. */
  124414. addCamera(newCamera: Camera): void;
  124415. /**
  124416. * Adds the given skeleton to this scene
  124417. * @param newSkeleton The skeleton to add
  124418. */
  124419. addSkeleton(newSkeleton: Skeleton): void;
  124420. /**
  124421. * Adds the given particle system to this scene
  124422. * @param newParticleSystem The particle system to add
  124423. */
  124424. addParticleSystem(newParticleSystem: IParticleSystem): void;
  124425. /**
  124426. * Adds the given animation to this scene
  124427. * @param newAnimation The animation to add
  124428. */
  124429. addAnimation(newAnimation: Animation): void;
  124430. /**
  124431. * Adds the given animation group to this scene.
  124432. * @param newAnimationGroup The animation group to add
  124433. */
  124434. addAnimationGroup(newAnimationGroup: AnimationGroup): void;
  124435. /**
  124436. * Adds the given multi-material to this scene
  124437. * @param newMultiMaterial The multi-material to add
  124438. */
  124439. addMultiMaterial(newMultiMaterial: MultiMaterial): void;
  124440. /**
  124441. * Adds the given material to this scene
  124442. * @param newMaterial The material to add
  124443. */
  124444. addMaterial(newMaterial: Material): void;
  124445. /**
  124446. * Adds the given morph target to this scene
  124447. * @param newMorphTargetManager The morph target to add
  124448. */
  124449. addMorphTargetManager(newMorphTargetManager: MorphTargetManager): void;
  124450. /**
  124451. * Adds the given geometry to this scene
  124452. * @param newGeometry The geometry to add
  124453. */
  124454. addGeometry(newGeometry: Geometry): void;
  124455. /**
  124456. * Adds the given action manager to this scene
  124457. * @param newActionManager The action manager to add
  124458. */
  124459. addActionManager(newActionManager: AbstractActionManager): void;
  124460. /**
  124461. * Adds the given texture to this scene.
  124462. * @param newTexture The texture to add
  124463. */
  124464. addTexture(newTexture: BaseTexture): void;
  124465. /**
  124466. * Switch active camera
  124467. * @param newCamera defines the new active camera
  124468. * @param attachControl defines if attachControl must be called for the new active camera (default: true)
  124469. */
  124470. switchActiveCamera(newCamera: Camera, attachControl?: boolean): void;
  124471. /**
  124472. * sets the active camera of the scene using its ID
  124473. * @param id defines the camera's ID
  124474. * @return the new active camera or null if none found.
  124475. */
  124476. setActiveCameraByID(id: string): Nullable<Camera>;
  124477. /**
  124478. * sets the active camera of the scene using its name
  124479. * @param name defines the camera's name
  124480. * @returns the new active camera or null if none found.
  124481. */
  124482. setActiveCameraByName(name: string): Nullable<Camera>;
  124483. /**
  124484. * get an animation group using its name
  124485. * @param name defines the material's name
  124486. * @return the animation group or null if none found.
  124487. */
  124488. getAnimationGroupByName(name: string): Nullable<AnimationGroup>;
  124489. /**
  124490. * Get a material using its unique id
  124491. * @param uniqueId defines the material's unique id
  124492. * @return the material or null if none found.
  124493. */
  124494. getMaterialByUniqueID(uniqueId: number): Nullable<Material>;
  124495. /**
  124496. * get a material using its id
  124497. * @param id defines the material's ID
  124498. * @return the material or null if none found.
  124499. */
  124500. getMaterialByID(id: string): Nullable<Material>;
  124501. /**
  124502. * Gets a the last added material using a given id
  124503. * @param id defines the material's ID
  124504. * @return the last material with the given id or null if none found.
  124505. */
  124506. getLastMaterialByID(id: string): Nullable<Material>;
  124507. /**
  124508. * Gets a material using its name
  124509. * @param name defines the material's name
  124510. * @return the material or null if none found.
  124511. */
  124512. getMaterialByName(name: string): Nullable<Material>;
  124513. /**
  124514. * Get a texture using its unique id
  124515. * @param uniqueId defines the texture's unique id
  124516. * @return the texture or null if none found.
  124517. */
  124518. getTextureByUniqueID(uniqueId: number): Nullable<BaseTexture>;
  124519. /**
  124520. * Gets a camera using its id
  124521. * @param id defines the id to look for
  124522. * @returns the camera or null if not found
  124523. */
  124524. getCameraByID(id: string): Nullable<Camera>;
  124525. /**
  124526. * Gets a camera using its unique id
  124527. * @param uniqueId defines the unique id to look for
  124528. * @returns the camera or null if not found
  124529. */
  124530. getCameraByUniqueID(uniqueId: number): Nullable<Camera>;
  124531. /**
  124532. * Gets a camera using its name
  124533. * @param name defines the camera's name
  124534. * @return the camera or null if none found.
  124535. */
  124536. getCameraByName(name: string): Nullable<Camera>;
  124537. /**
  124538. * Gets a bone using its id
  124539. * @param id defines the bone's id
  124540. * @return the bone or null if not found
  124541. */
  124542. getBoneByID(id: string): Nullable<Bone>;
  124543. /**
  124544. * Gets a bone using its id
  124545. * @param name defines the bone's name
  124546. * @return the bone or null if not found
  124547. */
  124548. getBoneByName(name: string): Nullable<Bone>;
  124549. /**
  124550. * Gets a light node using its name
  124551. * @param name defines the the light's name
  124552. * @return the light or null if none found.
  124553. */
  124554. getLightByName(name: string): Nullable<Light>;
  124555. /**
  124556. * Gets a light node using its id
  124557. * @param id defines the light's id
  124558. * @return the light or null if none found.
  124559. */
  124560. getLightByID(id: string): Nullable<Light>;
  124561. /**
  124562. * Gets a light node using its scene-generated unique ID
  124563. * @param uniqueId defines the light's unique id
  124564. * @return the light or null if none found.
  124565. */
  124566. getLightByUniqueID(uniqueId: number): Nullable<Light>;
  124567. /**
  124568. * Gets a particle system by id
  124569. * @param id defines the particle system id
  124570. * @return the corresponding system or null if none found
  124571. */
  124572. getParticleSystemByID(id: string): Nullable<IParticleSystem>;
  124573. /**
  124574. * Gets a geometry using its ID
  124575. * @param id defines the geometry's id
  124576. * @return the geometry or null if none found.
  124577. */
  124578. getGeometryByID(id: string): Nullable<Geometry>;
  124579. private _getGeometryByUniqueID;
  124580. /**
  124581. * Add a new geometry to this scene
  124582. * @param geometry defines the geometry to be added to the scene.
  124583. * @param force defines if the geometry must be pushed even if a geometry with this id already exists
  124584. * @return a boolean defining if the geometry was added or not
  124585. */
  124586. pushGeometry(geometry: Geometry, force?: boolean): boolean;
  124587. /**
  124588. * Removes an existing geometry
  124589. * @param geometry defines the geometry to be removed from the scene
  124590. * @return a boolean defining if the geometry was removed or not
  124591. */
  124592. removeGeometry(geometry: Geometry): boolean;
  124593. /**
  124594. * Gets the list of geometries attached to the scene
  124595. * @returns an array of Geometry
  124596. */
  124597. getGeometries(): Geometry[];
  124598. /**
  124599. * Gets the first added mesh found of a given ID
  124600. * @param id defines the id to search for
  124601. * @return the mesh found or null if not found at all
  124602. */
  124603. getMeshByID(id: string): Nullable<AbstractMesh>;
  124604. /**
  124605. * Gets a list of meshes using their id
  124606. * @param id defines the id to search for
  124607. * @returns a list of meshes
  124608. */
  124609. getMeshesByID(id: string): Array<AbstractMesh>;
  124610. /**
  124611. * Gets the first added transform node found of a given ID
  124612. * @param id defines the id to search for
  124613. * @return the found transform node or null if not found at all.
  124614. */
  124615. getTransformNodeByID(id: string): Nullable<TransformNode>;
  124616. /**
  124617. * Gets a transform node with its auto-generated unique id
  124618. * @param uniqueId efines the unique id to search for
  124619. * @return the found transform node or null if not found at all.
  124620. */
  124621. getTransformNodeByUniqueID(uniqueId: number): Nullable<TransformNode>;
  124622. /**
  124623. * Gets a list of transform nodes using their id
  124624. * @param id defines the id to search for
  124625. * @returns a list of transform nodes
  124626. */
  124627. getTransformNodesByID(id: string): Array<TransformNode>;
  124628. /**
  124629. * Gets a mesh with its auto-generated unique id
  124630. * @param uniqueId defines the unique id to search for
  124631. * @return the found mesh or null if not found at all.
  124632. */
  124633. getMeshByUniqueID(uniqueId: number): Nullable<AbstractMesh>;
  124634. /**
  124635. * Gets a the last added mesh using a given id
  124636. * @param id defines the id to search for
  124637. * @return the found mesh or null if not found at all.
  124638. */
  124639. getLastMeshByID(id: string): Nullable<AbstractMesh>;
  124640. /**
  124641. * Gets a the last added node (Mesh, Camera, Light) using a given id
  124642. * @param id defines the id to search for
  124643. * @return the found node or null if not found at all
  124644. */
  124645. getLastEntryByID(id: string): Nullable<Node>;
  124646. /**
  124647. * Gets a node (Mesh, Camera, Light) using a given id
  124648. * @param id defines the id to search for
  124649. * @return the found node or null if not found at all
  124650. */
  124651. getNodeByID(id: string): Nullable<Node>;
  124652. /**
  124653. * Gets a node (Mesh, Camera, Light) using a given name
  124654. * @param name defines the name to search for
  124655. * @return the found node or null if not found at all.
  124656. */
  124657. getNodeByName(name: string): Nullable<Node>;
  124658. /**
  124659. * Gets a mesh using a given name
  124660. * @param name defines the name to search for
  124661. * @return the found mesh or null if not found at all.
  124662. */
  124663. getMeshByName(name: string): Nullable<AbstractMesh>;
  124664. /**
  124665. * Gets a transform node using a given name
  124666. * @param name defines the name to search for
  124667. * @return the found transform node or null if not found at all.
  124668. */
  124669. getTransformNodeByName(name: string): Nullable<TransformNode>;
  124670. /**
  124671. * Gets a skeleton using a given id (if many are found, this function will pick the last one)
  124672. * @param id defines the id to search for
  124673. * @return the found skeleton or null if not found at all.
  124674. */
  124675. getLastSkeletonByID(id: string): Nullable<Skeleton>;
  124676. /**
  124677. * Gets a skeleton using a given auto generated unique id
  124678. * @param uniqueId defines the unique id to search for
  124679. * @return the found skeleton or null if not found at all.
  124680. */
  124681. getSkeletonByUniqueId(uniqueId: number): Nullable<Skeleton>;
  124682. /**
  124683. * Gets a skeleton using a given id (if many are found, this function will pick the first one)
  124684. * @param id defines the id to search for
  124685. * @return the found skeleton or null if not found at all.
  124686. */
  124687. getSkeletonById(id: string): Nullable<Skeleton>;
  124688. /**
  124689. * Gets a skeleton using a given name
  124690. * @param name defines the name to search for
  124691. * @return the found skeleton or null if not found at all.
  124692. */
  124693. getSkeletonByName(name: string): Nullable<Skeleton>;
  124694. /**
  124695. * Gets a morph target manager using a given id (if many are found, this function will pick the last one)
  124696. * @param id defines the id to search for
  124697. * @return the found morph target manager or null if not found at all.
  124698. */
  124699. getMorphTargetManagerById(id: number): Nullable<MorphTargetManager>;
  124700. /**
  124701. * Gets a morph target using a given id (if many are found, this function will pick the first one)
  124702. * @param id defines the id to search for
  124703. * @return the found morph target or null if not found at all.
  124704. */
  124705. getMorphTargetById(id: string): Nullable<MorphTarget>;
  124706. /**
  124707. * Gets a morph target using a given name (if many are found, this function will pick the first one)
  124708. * @param name defines the name to search for
  124709. * @return the found morph target or null if not found at all.
  124710. */
  124711. getMorphTargetByName(name: string): Nullable<MorphTarget>;
  124712. /**
  124713. * Gets a post process using a given name (if many are found, this function will pick the first one)
  124714. * @param name defines the name to search for
  124715. * @return the found post process or null if not found at all.
  124716. */
  124717. getPostProcessByName(name: string): Nullable<PostProcess>;
  124718. /**
  124719. * Gets a boolean indicating if the given mesh is active
  124720. * @param mesh defines the mesh to look for
  124721. * @returns true if the mesh is in the active list
  124722. */
  124723. isActiveMesh(mesh: AbstractMesh): boolean;
  124724. /**
  124725. * Return a unique id as a string which can serve as an identifier for the scene
  124726. */
  124727. get uid(): string;
  124728. /**
  124729. * Add an externaly attached data from its key.
  124730. * This method call will fail and return false, if such key already exists.
  124731. * If you don't care and just want to get the data no matter what, use the more convenient getOrAddExternalDataWithFactory() method.
  124732. * @param key the unique key that identifies the data
  124733. * @param data the data object to associate to the key for this Engine instance
  124734. * @return true if no such key were already present and the data was added successfully, false otherwise
  124735. */
  124736. addExternalData<T>(key: string, data: T): boolean;
  124737. /**
  124738. * Get an externaly attached data from its key
  124739. * @param key the unique key that identifies the data
  124740. * @return the associated data, if present (can be null), or undefined if not present
  124741. */
  124742. getExternalData<T>(key: string): Nullable<T>;
  124743. /**
  124744. * Get an externaly attached data from its key, create it using a factory if it's not already present
  124745. * @param key the unique key that identifies the data
  124746. * @param factory the factory that will be called to create the instance if and only if it doesn't exists
  124747. * @return the associated data, can be null if the factory returned null.
  124748. */
  124749. getOrAddExternalDataWithFactory<T>(key: string, factory: (k: string) => T): T;
  124750. /**
  124751. * Remove an externaly attached data from the Engine instance
  124752. * @param key the unique key that identifies the data
  124753. * @return true if the data was successfully removed, false if it doesn't exist
  124754. */
  124755. removeExternalData(key: string): boolean;
  124756. private _evaluateSubMesh;
  124757. /**
  124758. * Clear the processed materials smart array preventing retention point in material dispose.
  124759. */
  124760. freeProcessedMaterials(): void;
  124761. private _preventFreeActiveMeshesAndRenderingGroups;
  124762. /** Gets or sets a boolean blocking all the calls to freeActiveMeshes and freeRenderingGroups
  124763. * It can be used in order to prevent going through methods freeRenderingGroups and freeActiveMeshes several times to improve performance
  124764. * when disposing several meshes in a row or a hierarchy of meshes.
  124765. * When used, it is the responsability of the user to blockfreeActiveMeshesAndRenderingGroups back to false.
  124766. */
  124767. get blockfreeActiveMeshesAndRenderingGroups(): boolean;
  124768. set blockfreeActiveMeshesAndRenderingGroups(value: boolean);
  124769. /**
  124770. * Clear the active meshes smart array preventing retention point in mesh dispose.
  124771. */
  124772. freeActiveMeshes(): void;
  124773. /**
  124774. * Clear the info related to rendering groups preventing retention points during dispose.
  124775. */
  124776. freeRenderingGroups(): void;
  124777. /** @hidden */
  124778. _isInIntermediateRendering(): boolean;
  124779. /**
  124780. * Lambda returning the list of potentially active meshes.
  124781. */
  124782. getActiveMeshCandidates: () => ISmartArrayLike<AbstractMesh>;
  124783. /**
  124784. * Lambda returning the list of potentially active sub meshes.
  124785. */
  124786. getActiveSubMeshCandidates: (mesh: AbstractMesh) => ISmartArrayLike<SubMesh>;
  124787. /**
  124788. * Lambda returning the list of potentially intersecting sub meshes.
  124789. */
  124790. getIntersectingSubMeshCandidates: (mesh: AbstractMesh, localRay: Ray) => ISmartArrayLike<SubMesh>;
  124791. /**
  124792. * Lambda returning the list of potentially colliding sub meshes.
  124793. */
  124794. getCollidingSubMeshCandidates: (mesh: AbstractMesh, collider: Collider) => ISmartArrayLike<SubMesh>;
  124795. private _activeMeshesFrozen;
  124796. private _skipEvaluateActiveMeshesCompletely;
  124797. /**
  124798. * Use this function to stop evaluating active meshes. The current list will be keep alive between frames
  124799. * @param skipEvaluateActiveMeshes defines an optional boolean indicating that the evaluate active meshes step must be completely skipped
  124800. * @param onSuccess optional success callback
  124801. * @param onError optional error callback
  124802. * @returns the current scene
  124803. */
  124804. freezeActiveMeshes(skipEvaluateActiveMeshes?: boolean, onSuccess?: () => void, onError?: (message: string) => void): Scene;
  124805. /**
  124806. * Use this function to restart evaluating active meshes on every frame
  124807. * @returns the current scene
  124808. */
  124809. unfreezeActiveMeshes(): Scene;
  124810. private _evaluateActiveMeshes;
  124811. private _activeMesh;
  124812. /**
  124813. * Update the transform matrix to update from the current active camera
  124814. * @param force defines a boolean used to force the update even if cache is up to date
  124815. */
  124816. updateTransformMatrix(force?: boolean): void;
  124817. private _bindFrameBuffer;
  124818. /** @hidden */
  124819. _allowPostProcessClearColor: boolean;
  124820. /** @hidden */
  124821. _renderForCamera(camera: Camera, rigParent?: Camera): void;
  124822. private _processSubCameras;
  124823. private _checkIntersections;
  124824. /** @hidden */
  124825. _advancePhysicsEngineStep(step: number): void;
  124826. /**
  124827. * User updatable function that will return a deterministic frame time when engine is in deterministic lock step mode
  124828. */
  124829. getDeterministicFrameTime: () => number;
  124830. /** @hidden */
  124831. _animate(): void;
  124832. /** Execute all animations (for a frame) */
  124833. animate(): void;
  124834. /**
  124835. * Render the scene
  124836. * @param updateCameras defines a boolean indicating if cameras must update according to their inputs (true by default)
  124837. * @param ignoreAnimations defines a boolean indicating if animations should not be executed (false by default)
  124838. */
  124839. render(updateCameras?: boolean, ignoreAnimations?: boolean): void;
  124840. /**
  124841. * Freeze all materials
  124842. * A frozen material will not be updatable but should be faster to render
  124843. */
  124844. freezeMaterials(): void;
  124845. /**
  124846. * Unfreeze all materials
  124847. * A frozen material will not be updatable but should be faster to render
  124848. */
  124849. unfreezeMaterials(): void;
  124850. /**
  124851. * Releases all held ressources
  124852. */
  124853. dispose(): void;
  124854. /**
  124855. * Gets if the scene is already disposed
  124856. */
  124857. get isDisposed(): boolean;
  124858. /**
  124859. * Call this function to reduce memory footprint of the scene.
  124860. * Vertex buffers will not store CPU data anymore (this will prevent picking, collisions or physics to work correctly)
  124861. */
  124862. clearCachedVertexData(): void;
  124863. /**
  124864. * This function will remove the local cached buffer data from texture.
  124865. * It will save memory but will prevent the texture from being rebuilt
  124866. */
  124867. cleanCachedTextureBuffer(): void;
  124868. /**
  124869. * Get the world extend vectors with an optional filter
  124870. *
  124871. * @param filterPredicate the predicate - which meshes should be included when calculating the world size
  124872. * @returns {{ min: Vector3; max: Vector3 }} min and max vectors
  124873. */
  124874. getWorldExtends(filterPredicate?: (mesh: AbstractMesh) => boolean): {
  124875. min: Vector3;
  124876. max: Vector3;
  124877. };
  124878. /**
  124879. * Creates a ray that can be used to pick in the scene
  124880. * @param x defines the x coordinate of the origin (on-screen)
  124881. * @param y defines the y coordinate of the origin (on-screen)
  124882. * @param world defines the world matrix to use if you want to pick in object space (instead of world space)
  124883. * @param camera defines the camera to use for the picking
  124884. * @param cameraViewSpace defines if picking will be done in view space (false by default)
  124885. * @returns a Ray
  124886. */
  124887. createPickingRay(x: number, y: number, world: Matrix, camera: Nullable<Camera>, cameraViewSpace?: boolean): Ray;
  124888. /**
  124889. * Creates a ray that can be used to pick in the scene
  124890. * @param x defines the x coordinate of the origin (on-screen)
  124891. * @param y defines the y coordinate of the origin (on-screen)
  124892. * @param world defines the world matrix to use if you want to pick in object space (instead of world space)
  124893. * @param result defines the ray where to store the picking ray
  124894. * @param camera defines the camera to use for the picking
  124895. * @param cameraViewSpace defines if picking will be done in view space (false by default)
  124896. * @returns the current scene
  124897. */
  124898. createPickingRayToRef(x: number, y: number, world: Matrix, result: Ray, camera: Nullable<Camera>, cameraViewSpace?: boolean): Scene;
  124899. /**
  124900. * Creates a ray that can be used to pick in the scene
  124901. * @param x defines the x coordinate of the origin (on-screen)
  124902. * @param y defines the y coordinate of the origin (on-screen)
  124903. * @param camera defines the camera to use for the picking
  124904. * @returns a Ray
  124905. */
  124906. createPickingRayInCameraSpace(x: number, y: number, camera?: Camera): Ray;
  124907. /**
  124908. * Creates a ray that can be used to pick in the scene
  124909. * @param x defines the x coordinate of the origin (on-screen)
  124910. * @param y defines the y coordinate of the origin (on-screen)
  124911. * @param result defines the ray where to store the picking ray
  124912. * @param camera defines the camera to use for the picking
  124913. * @returns the current scene
  124914. */
  124915. createPickingRayInCameraSpaceToRef(x: number, y: number, result: Ray, camera?: Camera): Scene;
  124916. /** Launch a ray to try to pick a mesh in the scene
  124917. * @param x position on screen
  124918. * @param y position on screen
  124919. * @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
  124920. * @param fastCheck defines if the first intersection will be used (and not the closest)
  124921. * @param camera to use for computing the picking ray. Can be set to null. In this case, the scene.activeCamera will be used
  124922. * @param trianglePredicate defines an optional predicate used to select faces when a mesh intersection is detected
  124923. * @returns a PickingInfo
  124924. */
  124925. pick(x: number, y: number, predicate?: (mesh: AbstractMesh) => boolean, fastCheck?: boolean, camera?: Nullable<Camera>, trianglePredicate?: TrianglePickingPredicate): Nullable<PickingInfo>;
  124926. /** Launch a ray to try to pick a mesh in the scene using only bounding information of the main mesh (not using submeshes)
  124927. * @param x position on screen
  124928. * @param y position on screen
  124929. * @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
  124930. * @param fastCheck defines if the first intersection will be used (and not the closest)
  124931. * @param camera to use for computing the picking ray. Can be set to null. In this case, the scene.activeCamera will be used
  124932. * @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)
  124933. */
  124934. pickWithBoundingInfo(x: number, y: number, predicate?: (mesh: AbstractMesh) => boolean, fastCheck?: boolean, camera?: Nullable<Camera>): Nullable<PickingInfo>;
  124935. /** Use the given ray to pick a mesh in the scene
  124936. * @param ray The ray to use to pick meshes
  124937. * @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
  124938. * @param fastCheck defines if the first intersection will be used (and not the closest)
  124939. * @param trianglePredicate defines an optional predicate used to select faces when a mesh intersection is detected
  124940. * @returns a PickingInfo
  124941. */
  124942. pickWithRay(ray: Ray, predicate?: (mesh: AbstractMesh) => boolean, fastCheck?: boolean, trianglePredicate?: TrianglePickingPredicate): Nullable<PickingInfo>;
  124943. /**
  124944. * Launch a ray to try to pick a mesh in the scene
  124945. * @param x X position on screen
  124946. * @param y Y position on screen
  124947. * @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
  124948. * @param camera camera to use for computing the picking ray. Can be set to null. In this case, the scene.activeCamera will be used
  124949. * @param trianglePredicate defines an optional predicate used to select faces when a mesh intersection is detected
  124950. * @returns an array of PickingInfo
  124951. */
  124952. multiPick(x: number, y: number, predicate?: (mesh: AbstractMesh) => boolean, camera?: Camera, trianglePredicate?: TrianglePickingPredicate): Nullable<PickingInfo[]>;
  124953. /**
  124954. * Launch a ray to try to pick a mesh in the scene
  124955. * @param ray Ray to use
  124956. * @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
  124957. * @param trianglePredicate defines an optional predicate used to select faces when a mesh intersection is detected
  124958. * @returns an array of PickingInfo
  124959. */
  124960. multiPickWithRay(ray: Ray, predicate: (mesh: AbstractMesh) => boolean, trianglePredicate?: TrianglePickingPredicate): Nullable<PickingInfo[]>;
  124961. /**
  124962. * Force the value of meshUnderPointer
  124963. * @param mesh defines the mesh to use
  124964. * @param pointerId optional pointer id when using more than one pointer
  124965. */
  124966. setPointerOverMesh(mesh: Nullable<AbstractMesh>, pointerId?: number): void;
  124967. /**
  124968. * Gets the mesh under the pointer
  124969. * @returns a Mesh or null if no mesh is under the pointer
  124970. */
  124971. getPointerOverMesh(): Nullable<AbstractMesh>;
  124972. /** @hidden */
  124973. _rebuildGeometries(): void;
  124974. /** @hidden */
  124975. _rebuildTextures(): void;
  124976. private _getByTags;
  124977. /**
  124978. * Get a list of meshes by tags
  124979. * @param tagsQuery defines the tags query to use
  124980. * @param forEach defines a predicate used to filter results
  124981. * @returns an array of Mesh
  124982. */
  124983. getMeshesByTags(tagsQuery: string, forEach?: (mesh: AbstractMesh) => void): Mesh[];
  124984. /**
  124985. * Get a list of cameras by tags
  124986. * @param tagsQuery defines the tags query to use
  124987. * @param forEach defines a predicate used to filter results
  124988. * @returns an array of Camera
  124989. */
  124990. getCamerasByTags(tagsQuery: string, forEach?: (camera: Camera) => void): Camera[];
  124991. /**
  124992. * Get a list of lights by tags
  124993. * @param tagsQuery defines the tags query to use
  124994. * @param forEach defines a predicate used to filter results
  124995. * @returns an array of Light
  124996. */
  124997. getLightsByTags(tagsQuery: string, forEach?: (light: Light) => void): Light[];
  124998. /**
  124999. * Get a list of materials by tags
  125000. * @param tagsQuery defines the tags query to use
  125001. * @param forEach defines a predicate used to filter results
  125002. * @returns an array of Material
  125003. */
  125004. getMaterialByTags(tagsQuery: string, forEach?: (material: Material) => void): Material[];
  125005. /**
  125006. * Get a list of transform nodes by tags
  125007. * @param tagsQuery defines the tags query to use
  125008. * @param forEach defines a predicate used to filter results
  125009. * @returns an array of TransformNode
  125010. */
  125011. getTransformNodesByTags(tagsQuery: string, forEach?: (transform: TransformNode) => void): TransformNode[];
  125012. /**
  125013. * Overrides the default sort function applied in the renderging group to prepare the meshes.
  125014. * This allowed control for front to back rendering or reversly depending of the special needs.
  125015. *
  125016. * @param renderingGroupId The rendering group id corresponding to its index
  125017. * @param opaqueSortCompareFn The opaque queue comparison function use to sort.
  125018. * @param alphaTestSortCompareFn The alpha test queue comparison function use to sort.
  125019. * @param transparentSortCompareFn The transparent queue comparison function use to sort.
  125020. */
  125021. 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;
  125022. /**
  125023. * Specifies whether or not the stencil and depth buffer are cleared between two rendering groups.
  125024. *
  125025. * @param renderingGroupId The rendering group id corresponding to its index
  125026. * @param autoClearDepthStencil Automatically clears depth and stencil between groups if true.
  125027. * @param depth Automatically clears depth between groups if true and autoClear is true.
  125028. * @param stencil Automatically clears stencil between groups if true and autoClear is true.
  125029. */
  125030. setRenderingAutoClearDepthStencil(renderingGroupId: number, autoClearDepthStencil: boolean, depth?: boolean, stencil?: boolean): void;
  125031. /**
  125032. * Gets the current auto clear configuration for one rendering group of the rendering
  125033. * manager.
  125034. * @param index the rendering group index to get the information for
  125035. * @returns The auto clear setup for the requested rendering group
  125036. */
  125037. getAutoClearDepthStencilSetup(index: number): IRenderingManagerAutoClearSetup;
  125038. private _blockMaterialDirtyMechanism;
  125039. /** Gets or sets a boolean blocking all the calls to markAllMaterialsAsDirty (ie. the materials won't be updated if they are out of sync) */
  125040. get blockMaterialDirtyMechanism(): boolean;
  125041. set blockMaterialDirtyMechanism(value: boolean);
  125042. /**
  125043. * Will flag all materials as dirty to trigger new shader compilation
  125044. * @param flag defines the flag used to specify which material part must be marked as dirty
  125045. * @param predicate If not null, it will be used to specifiy if a material has to be marked as dirty
  125046. */
  125047. markAllMaterialsAsDirty(flag: number, predicate?: (mat: Material) => boolean): void;
  125048. /** @hidden */
  125049. _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;
  125050. /** @hidden */
  125051. _loadFileAsync(url: string, onProgress?: (data: any) => void, useOfflineSupport?: boolean, useArrayBuffer?: boolean): Promise<string | ArrayBuffer>;
  125052. /** @hidden */
  125053. _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;
  125054. /** @hidden */
  125055. _requestFileAsync(url: string, onProgress?: (ev: ProgressEvent) => void, useOfflineSupport?: boolean, useArrayBuffer?: boolean, onOpened?: (request: WebRequest) => void): Promise<string | ArrayBuffer>;
  125056. /** @hidden */
  125057. _readFile(file: File, onSuccess: (data: string | ArrayBuffer) => void, onProgress?: (ev: ProgressEvent) => any, useArrayBuffer?: boolean, onError?: (error: ReadFileError) => void): IFileRequest;
  125058. /** @hidden */
  125059. _readFileAsync(file: File, onProgress?: (ev: ProgressEvent) => any, useArrayBuffer?: boolean): Promise<string | ArrayBuffer>;
  125060. }
  125061. }
  125062. declare module BABYLON {
  125063. /**
  125064. * Set of assets to keep when moving a scene into an asset container.
  125065. */
  125066. export class KeepAssets extends AbstractScene {
  125067. }
  125068. /**
  125069. * Class used to store the output of the AssetContainer.instantiateAllMeshesToScene function
  125070. */
  125071. export class InstantiatedEntries {
  125072. /**
  125073. * List of new root nodes (eg. nodes with no parent)
  125074. */
  125075. rootNodes: TransformNode[];
  125076. /**
  125077. * List of new skeletons
  125078. */
  125079. skeletons: Skeleton[];
  125080. /**
  125081. * List of new animation groups
  125082. */
  125083. animationGroups: AnimationGroup[];
  125084. }
  125085. /**
  125086. * Container with a set of assets that can be added or removed from a scene.
  125087. */
  125088. export class AssetContainer extends AbstractScene {
  125089. private _wasAddedToScene;
  125090. /**
  125091. * The scene the AssetContainer belongs to.
  125092. */
  125093. scene: Scene;
  125094. /**
  125095. * Instantiates an AssetContainer.
  125096. * @param scene The scene the AssetContainer belongs to.
  125097. */
  125098. constructor(scene: Scene);
  125099. /**
  125100. * Instantiate or clone all meshes and add the new ones to the scene.
  125101. * Skeletons and animation groups will all be cloned
  125102. * @param nameFunction defines an optional function used to get new names for clones
  125103. * @param cloneMaterials defines an optional boolean that defines if materials must be cloned as well (false by default)
  125104. * @returns a list of rootNodes, skeletons and aniamtion groups that were duplicated
  125105. */
  125106. instantiateModelsToScene(nameFunction?: (sourceName: string) => string, cloneMaterials?: boolean): InstantiatedEntries;
  125107. /**
  125108. * Adds all the assets from the container to the scene.
  125109. */
  125110. addAllToScene(): void;
  125111. /**
  125112. * Removes all the assets in the container from the scene
  125113. */
  125114. removeAllFromScene(): void;
  125115. /**
  125116. * Disposes all the assets in the container
  125117. */
  125118. dispose(): void;
  125119. private _moveAssets;
  125120. /**
  125121. * Removes all the assets contained in the scene and adds them to the container.
  125122. * @param keepAssets Set of assets to keep in the scene. (default: empty)
  125123. */
  125124. moveAllFromScene(keepAssets?: KeepAssets): void;
  125125. /**
  125126. * 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.
  125127. * @returns the root mesh
  125128. */
  125129. createRootMesh(): Mesh;
  125130. /**
  125131. * Merge animations (direct and animation groups) from this asset container into a scene
  125132. * @param scene is the instance of BABYLON.Scene to append to (default: last created scene)
  125133. * @param animatables set of animatables to retarget to a node from the scene
  125134. * @param targetConverter defines a function used to convert animation targets from the asset container to the scene (default: search node by name)
  125135. * @returns an array of the new AnimationGroup added to the scene (empty array if none)
  125136. */
  125137. mergeAnimationsTo(scene: Scene | null | undefined, animatables: Animatable[], targetConverter?: Nullable<(target: any) => Nullable<Node>>): AnimationGroup[];
  125138. }
  125139. }
  125140. declare module BABYLON {
  125141. /**
  125142. * Defines how the parser contract is defined.
  125143. * These parsers are used to parse a list of specific assets (like particle systems, etc..)
  125144. */
  125145. export type BabylonFileParser = (parsedData: any, scene: Scene, container: AssetContainer, rootUrl: string) => void;
  125146. /**
  125147. * Defines how the individual parser contract is defined.
  125148. * These parser can parse an individual asset
  125149. */
  125150. export type IndividualBabylonFileParser = (parsedData: any, scene: Scene, rootUrl: string) => any;
  125151. /**
  125152. * Base class of the scene acting as a container for the different elements composing a scene.
  125153. * This class is dynamically extended by the different components of the scene increasing
  125154. * flexibility and reducing coupling
  125155. */
  125156. export abstract class AbstractScene {
  125157. /**
  125158. * Stores the list of available parsers in the application.
  125159. */
  125160. private static _BabylonFileParsers;
  125161. /**
  125162. * Stores the list of available individual parsers in the application.
  125163. */
  125164. private static _IndividualBabylonFileParsers;
  125165. /**
  125166. * Adds a parser in the list of available ones
  125167. * @param name Defines the name of the parser
  125168. * @param parser Defines the parser to add
  125169. */
  125170. static AddParser(name: string, parser: BabylonFileParser): void;
  125171. /**
  125172. * Gets a general parser from the list of avaialble ones
  125173. * @param name Defines the name of the parser
  125174. * @returns the requested parser or null
  125175. */
  125176. static GetParser(name: string): Nullable<BabylonFileParser>;
  125177. /**
  125178. * Adds n individual parser in the list of available ones
  125179. * @param name Defines the name of the parser
  125180. * @param parser Defines the parser to add
  125181. */
  125182. static AddIndividualParser(name: string, parser: IndividualBabylonFileParser): void;
  125183. /**
  125184. * Gets an individual parser from the list of avaialble ones
  125185. * @param name Defines the name of the parser
  125186. * @returns the requested parser or null
  125187. */
  125188. static GetIndividualParser(name: string): Nullable<IndividualBabylonFileParser>;
  125189. /**
  125190. * Parser json data and populate both a scene and its associated container object
  125191. * @param jsonData Defines the data to parse
  125192. * @param scene Defines the scene to parse the data for
  125193. * @param container Defines the container attached to the parsing sequence
  125194. * @param rootUrl Defines the root url of the data
  125195. */
  125196. static Parse(jsonData: any, scene: Scene, container: AssetContainer, rootUrl: string): void;
  125197. /**
  125198. * Gets the list of root nodes (ie. nodes with no parent)
  125199. */
  125200. rootNodes: Node[];
  125201. /** All of the cameras added to this scene
  125202. * @see https://doc.babylonjs.com/babylon101/cameras
  125203. */
  125204. cameras: Camera[];
  125205. /**
  125206. * All of the lights added to this scene
  125207. * @see https://doc.babylonjs.com/babylon101/lights
  125208. */
  125209. lights: Light[];
  125210. /**
  125211. * All of the (abstract) meshes added to this scene
  125212. */
  125213. meshes: AbstractMesh[];
  125214. /**
  125215. * The list of skeletons added to the scene
  125216. * @see https://doc.babylonjs.com/how_to/how_to_use_bones_and_skeletons
  125217. */
  125218. skeletons: Skeleton[];
  125219. /**
  125220. * All of the particle systems added to this scene
  125221. * @see https://doc.babylonjs.com/babylon101/particles
  125222. */
  125223. particleSystems: IParticleSystem[];
  125224. /**
  125225. * Gets a list of Animations associated with the scene
  125226. */
  125227. animations: Animation[];
  125228. /**
  125229. * All of the animation groups added to this scene
  125230. * @see https://doc.babylonjs.com/how_to/group
  125231. */
  125232. animationGroups: AnimationGroup[];
  125233. /**
  125234. * All of the multi-materials added to this scene
  125235. * @see https://doc.babylonjs.com/how_to/multi_materials
  125236. */
  125237. multiMaterials: MultiMaterial[];
  125238. /**
  125239. * All of the materials added to this scene
  125240. * In the context of a Scene, it is not supposed to be modified manually.
  125241. * Any addition or removal should be done using the addMaterial and removeMaterial Scene methods.
  125242. * Note also that the order of the Material within the array is not significant and might change.
  125243. * @see https://doc.babylonjs.com/babylon101/materials
  125244. */
  125245. materials: Material[];
  125246. /**
  125247. * The list of morph target managers added to the scene
  125248. * @see https://doc.babylonjs.com/how_to/how_to_dynamically_morph_a_mesh
  125249. */
  125250. morphTargetManagers: MorphTargetManager[];
  125251. /**
  125252. * The list of geometries used in the scene.
  125253. */
  125254. geometries: Geometry[];
  125255. /**
  125256. * All of the tranform nodes added to this scene
  125257. * In the context of a Scene, it is not supposed to be modified manually.
  125258. * Any addition or removal should be done using the addTransformNode and removeTransformNode Scene methods.
  125259. * Note also that the order of the TransformNode wihin the array is not significant and might change.
  125260. * @see https://doc.babylonjs.com/how_to/transformnode
  125261. */
  125262. transformNodes: TransformNode[];
  125263. /**
  125264. * ActionManagers available on the scene.
  125265. */
  125266. actionManagers: AbstractActionManager[];
  125267. /**
  125268. * Textures to keep.
  125269. */
  125270. textures: BaseTexture[];
  125271. /** @hidden */
  125272. protected _environmentTexture: Nullable<BaseTexture>;
  125273. /**
  125274. * Texture used in all pbr material as the reflection texture.
  125275. * As in the majority of the scene they are the same (exception for multi room and so on),
  125276. * this is easier to reference from here than from all the materials.
  125277. */
  125278. get environmentTexture(): Nullable<BaseTexture>;
  125279. set environmentTexture(value: Nullable<BaseTexture>);
  125280. /**
  125281. * The list of postprocesses added to the scene
  125282. */
  125283. postProcesses: PostProcess[];
  125284. /**
  125285. * @returns all meshes, lights, cameras, transformNodes and bones
  125286. */
  125287. getNodes(): Array<Node>;
  125288. }
  125289. }
  125290. declare module BABYLON {
  125291. /**
  125292. * Interface used to define options for Sound class
  125293. */
  125294. export interface ISoundOptions {
  125295. /**
  125296. * Does the sound autoplay once loaded.
  125297. */
  125298. autoplay?: boolean;
  125299. /**
  125300. * Does the sound loop after it finishes playing once.
  125301. */
  125302. loop?: boolean;
  125303. /**
  125304. * Sound's volume
  125305. */
  125306. volume?: number;
  125307. /**
  125308. * Is it a spatial sound?
  125309. */
  125310. spatialSound?: boolean;
  125311. /**
  125312. * Maximum distance to hear that sound
  125313. */
  125314. maxDistance?: number;
  125315. /**
  125316. * Uses user defined attenuation function
  125317. */
  125318. useCustomAttenuation?: boolean;
  125319. /**
  125320. * Define the roll off factor of spatial sounds.
  125321. * @see https://doc.babylonjs.com/how_to/playing_sounds_and_music#creating-a-spatial-3d-sound
  125322. */
  125323. rolloffFactor?: number;
  125324. /**
  125325. * Define the reference distance the sound should be heard perfectly.
  125326. * @see https://doc.babylonjs.com/how_to/playing_sounds_and_music#creating-a-spatial-3d-sound
  125327. */
  125328. refDistance?: number;
  125329. /**
  125330. * Define the distance attenuation model the sound will follow.
  125331. * @see https://doc.babylonjs.com/how_to/playing_sounds_and_music#creating-a-spatial-3d-sound
  125332. */
  125333. distanceModel?: string;
  125334. /**
  125335. * Defines the playback speed (1 by default)
  125336. */
  125337. playbackRate?: number;
  125338. /**
  125339. * Defines if the sound is from a streaming source
  125340. */
  125341. streaming?: boolean;
  125342. /**
  125343. * Defines an optional length (in seconds) inside the sound file
  125344. */
  125345. length?: number;
  125346. /**
  125347. * Defines an optional offset (in seconds) inside the sound file
  125348. */
  125349. offset?: number;
  125350. /**
  125351. * If true, URLs will not be required to state the audio file codec to use.
  125352. */
  125353. skipCodecCheck?: boolean;
  125354. }
  125355. /**
  125356. * Defines a sound that can be played in the application.
  125357. * The sound can either be an ambient track or a simple sound played in reaction to a user action.
  125358. * @see https://doc.babylonjs.com/how_to/playing_sounds_and_music
  125359. */
  125360. export class Sound {
  125361. /**
  125362. * The name of the sound in the scene.
  125363. */
  125364. name: string;
  125365. /**
  125366. * Does the sound autoplay once loaded.
  125367. */
  125368. autoplay: boolean;
  125369. /**
  125370. * Does the sound loop after it finishes playing once.
  125371. */
  125372. loop: boolean;
  125373. /**
  125374. * Does the sound use a custom attenuation curve to simulate the falloff
  125375. * happening when the source gets further away from the camera.
  125376. * @see https://doc.babylonjs.com/how_to/playing_sounds_and_music#creating-your-own-custom-attenuation-function
  125377. */
  125378. useCustomAttenuation: boolean;
  125379. /**
  125380. * The sound track id this sound belongs to.
  125381. */
  125382. soundTrackId: number;
  125383. /**
  125384. * Is this sound currently played.
  125385. */
  125386. isPlaying: boolean;
  125387. /**
  125388. * Is this sound currently paused.
  125389. */
  125390. isPaused: boolean;
  125391. /**
  125392. * Does this sound enables spatial sound.
  125393. * @see https://doc.babylonjs.com/how_to/playing_sounds_and_music#creating-a-spatial-3d-sound
  125394. */
  125395. spatialSound: boolean;
  125396. /**
  125397. * Define the reference distance the sound should be heard perfectly.
  125398. * @see https://doc.babylonjs.com/how_to/playing_sounds_and_music#creating-a-spatial-3d-sound
  125399. */
  125400. refDistance: number;
  125401. /**
  125402. * Define the roll off factor of spatial sounds.
  125403. * @see https://doc.babylonjs.com/how_to/playing_sounds_and_music#creating-a-spatial-3d-sound
  125404. */
  125405. rolloffFactor: number;
  125406. /**
  125407. * Define the max distance the sound should be heard (intensity just became 0 at this point).
  125408. * @see https://doc.babylonjs.com/how_to/playing_sounds_and_music#creating-a-spatial-3d-sound
  125409. */
  125410. maxDistance: number;
  125411. /**
  125412. * Define the distance attenuation model the sound will follow.
  125413. * @see https://doc.babylonjs.com/how_to/playing_sounds_and_music#creating-a-spatial-3d-sound
  125414. */
  125415. distanceModel: string;
  125416. /**
  125417. * @hidden
  125418. * Back Compat
  125419. **/
  125420. onended: () => any;
  125421. /**
  125422. * Gets or sets an object used to store user defined information for the sound.
  125423. */
  125424. metadata: any;
  125425. /**
  125426. * Observable event when the current playing sound finishes.
  125427. */
  125428. onEndedObservable: Observable<Sound>;
  125429. private _panningModel;
  125430. private _playbackRate;
  125431. private _streaming;
  125432. private _startTime;
  125433. private _startOffset;
  125434. private _position;
  125435. /** @hidden */
  125436. _positionInEmitterSpace: boolean;
  125437. private _localDirection;
  125438. private _volume;
  125439. private _isReadyToPlay;
  125440. private _isDirectional;
  125441. private _readyToPlayCallback;
  125442. private _audioBuffer;
  125443. private _soundSource;
  125444. private _streamingSource;
  125445. private _soundPanner;
  125446. private _soundGain;
  125447. private _inputAudioNode;
  125448. private _outputAudioNode;
  125449. private _coneInnerAngle;
  125450. private _coneOuterAngle;
  125451. private _coneOuterGain;
  125452. private _scene;
  125453. private _connectedTransformNode;
  125454. private _customAttenuationFunction;
  125455. private _registerFunc;
  125456. private _isOutputConnected;
  125457. private _htmlAudioElement;
  125458. private _urlType;
  125459. private _length?;
  125460. private _offset?;
  125461. /** @hidden */
  125462. static _SceneComponentInitialization: (scene: Scene) => void;
  125463. /**
  125464. * Create a sound and attach it to a scene
  125465. * @param name Name of your sound
  125466. * @param urlOrArrayBuffer Url to the sound to load async or ArrayBuffer, it also works with MediaStreams
  125467. * @param scene defines the scene the sound belongs to
  125468. * @param readyToPlayCallback Provide a callback function if you'd like to load your code once the sound is ready to be played
  125469. * @param options Objects to provide with the current available options: autoplay, loop, volume, spatialSound, maxDistance, rolloffFactor, refDistance, distanceModel, panningModel, streaming
  125470. */
  125471. constructor(name: string, urlOrArrayBuffer: any, scene: Scene, readyToPlayCallback?: Nullable<() => void>, options?: ISoundOptions);
  125472. /**
  125473. * Release the sound and its associated resources
  125474. */
  125475. dispose(): void;
  125476. /**
  125477. * Gets if the sounds is ready to be played or not.
  125478. * @returns true if ready, otherwise false
  125479. */
  125480. isReady(): boolean;
  125481. private _soundLoaded;
  125482. /**
  125483. * Sets the data of the sound from an audiobuffer
  125484. * @param audioBuffer The audioBuffer containing the data
  125485. */
  125486. setAudioBuffer(audioBuffer: AudioBuffer): void;
  125487. /**
  125488. * Updates the current sounds options such as maxdistance, loop...
  125489. * @param options A JSON object containing values named as the object properties
  125490. */
  125491. updateOptions(options: ISoundOptions): void;
  125492. private _createSpatialParameters;
  125493. private _updateSpatialParameters;
  125494. /**
  125495. * Switch the panning model to HRTF:
  125496. * Renders a stereo output of higher quality than equalpower — it uses a convolution with measured impulse responses from human subjects.
  125497. * @see https://doc.babylonjs.com/how_to/playing_sounds_and_music#creating-a-spatial-3d-sound
  125498. */
  125499. switchPanningModelToHRTF(): void;
  125500. /**
  125501. * Switch the panning model to Equal Power:
  125502. * Represents the equal-power panning algorithm, generally regarded as simple and efficient. equalpower is the default value.
  125503. * @see https://doc.babylonjs.com/how_to/playing_sounds_and_music#creating-a-spatial-3d-sound
  125504. */
  125505. switchPanningModelToEqualPower(): void;
  125506. private _switchPanningModel;
  125507. /**
  125508. * Connect this sound to a sound track audio node like gain...
  125509. * @param soundTrackAudioNode the sound track audio node to connect to
  125510. */
  125511. connectToSoundTrackAudioNode(soundTrackAudioNode: AudioNode): void;
  125512. /**
  125513. * Transform this sound into a directional source
  125514. * @param coneInnerAngle Size of the inner cone in degree
  125515. * @param coneOuterAngle Size of the outer cone in degree
  125516. * @param coneOuterGain Volume of the sound outside the outer cone (between 0.0 and 1.0)
  125517. */
  125518. setDirectionalCone(coneInnerAngle: number, coneOuterAngle: number, coneOuterGain: number): void;
  125519. /**
  125520. * Gets or sets the inner angle for the directional cone.
  125521. */
  125522. get directionalConeInnerAngle(): number;
  125523. /**
  125524. * Gets or sets the inner angle for the directional cone.
  125525. */
  125526. set directionalConeInnerAngle(value: number);
  125527. /**
  125528. * Gets or sets the outer angle for the directional cone.
  125529. */
  125530. get directionalConeOuterAngle(): number;
  125531. /**
  125532. * Gets or sets the outer angle for the directional cone.
  125533. */
  125534. set directionalConeOuterAngle(value: number);
  125535. /**
  125536. * Sets the position of the emitter if spatial sound is enabled
  125537. * @param newPosition Defines the new posisiton
  125538. */
  125539. setPosition(newPosition: Vector3): void;
  125540. /**
  125541. * Sets the local direction of the emitter if spatial sound is enabled
  125542. * @param newLocalDirection Defines the new local direction
  125543. */
  125544. setLocalDirectionToMesh(newLocalDirection: Vector3): void;
  125545. private _updateDirection;
  125546. /** @hidden */
  125547. updateDistanceFromListener(): void;
  125548. /**
  125549. * Sets a new custom attenuation function for the sound.
  125550. * @param callback Defines the function used for the attenuation
  125551. * @see https://doc.babylonjs.com/how_to/playing_sounds_and_music#creating-your-own-custom-attenuation-function
  125552. */
  125553. setAttenuationFunction(callback: (currentVolume: number, currentDistance: number, maxDistance: number, refDistance: number, rolloffFactor: number) => number): void;
  125554. /**
  125555. * Play the sound
  125556. * @param time (optional) Start the sound after X seconds. Start immediately (0) by default.
  125557. * @param offset (optional) Start the sound at a specific time in seconds
  125558. * @param length (optional) Sound duration (in seconds)
  125559. */
  125560. play(time?: number, offset?: number, length?: number): void;
  125561. private _onended;
  125562. /**
  125563. * Stop the sound
  125564. * @param time (optional) Stop the sound after X seconds. Stop immediately (0) by default.
  125565. */
  125566. stop(time?: number): void;
  125567. /**
  125568. * Put the sound in pause
  125569. */
  125570. pause(): void;
  125571. /**
  125572. * Sets a dedicated volume for this sounds
  125573. * @param newVolume Define the new volume of the sound
  125574. * @param time Define time for gradual change to new volume
  125575. */
  125576. setVolume(newVolume: number, time?: number): void;
  125577. /**
  125578. * Set the sound play back rate
  125579. * @param newPlaybackRate Define the playback rate the sound should be played at
  125580. */
  125581. setPlaybackRate(newPlaybackRate: number): void;
  125582. /**
  125583. * Gets the volume of the sound.
  125584. * @returns the volume of the sound
  125585. */
  125586. getVolume(): number;
  125587. /**
  125588. * Attach the sound to a dedicated mesh
  125589. * @param transformNode The transform node to connect the sound with
  125590. * @see https://doc.babylonjs.com/how_to/playing_sounds_and_music#attaching-a-sound-to-a-mesh
  125591. */
  125592. attachToMesh(transformNode: TransformNode): void;
  125593. /**
  125594. * Detach the sound from the previously attached mesh
  125595. * @see https://doc.babylonjs.com/how_to/playing_sounds_and_music#attaching-a-sound-to-a-mesh
  125596. */
  125597. detachFromMesh(): void;
  125598. private _onRegisterAfterWorldMatrixUpdate;
  125599. /**
  125600. * Clone the current sound in the scene.
  125601. * @returns the new sound clone
  125602. */
  125603. clone(): Nullable<Sound>;
  125604. /**
  125605. * Gets the current underlying audio buffer containing the data
  125606. * @returns the audio buffer
  125607. */
  125608. getAudioBuffer(): Nullable<AudioBuffer>;
  125609. /**
  125610. * Gets the WebAudio AudioBufferSourceNode, lets you keep track of and stop instances of this Sound.
  125611. * @returns the source node
  125612. */
  125613. getSoundSource(): Nullable<AudioBufferSourceNode>;
  125614. /**
  125615. * Gets the WebAudio GainNode, gives you precise control over the gain of instances of this Sound.
  125616. * @returns the gain node
  125617. */
  125618. getSoundGain(): Nullable<GainNode>;
  125619. /**
  125620. * Serializes the Sound in a JSON representation
  125621. * @returns the JSON representation of the sound
  125622. */
  125623. serialize(): any;
  125624. /**
  125625. * Parse a JSON representation of a sound to innstantiate in a given scene
  125626. * @param parsedSound Define the JSON representation of the sound (usually coming from the serialize method)
  125627. * @param scene Define the scene the new parsed sound should be created in
  125628. * @param rootUrl Define the rooturl of the load in case we need to fetch relative dependencies
  125629. * @param sourceSound Define a cound place holder if do not need to instantiate a new one
  125630. * @returns the newly parsed sound
  125631. */
  125632. static Parse(parsedSound: any, scene: Scene, rootUrl: string, sourceSound?: Sound): Sound;
  125633. }
  125634. }
  125635. declare module BABYLON {
  125636. /**
  125637. * This defines an action helpful to play a defined sound on a triggered action.
  125638. */
  125639. export class PlaySoundAction extends Action {
  125640. private _sound;
  125641. /**
  125642. * Instantiate the action
  125643. * @param triggerOptions defines the trigger options
  125644. * @param sound defines the sound to play
  125645. * @param condition defines the trigger related conditions
  125646. */
  125647. constructor(triggerOptions: any, sound: Sound, condition?: Condition);
  125648. /** @hidden */
  125649. _prepare(): void;
  125650. /**
  125651. * Execute the action and play the sound.
  125652. */
  125653. execute(): void;
  125654. /**
  125655. * Serializes the actions and its related information.
  125656. * @param parent defines the object to serialize in
  125657. * @returns the serialized object
  125658. */
  125659. serialize(parent: any): any;
  125660. }
  125661. /**
  125662. * This defines an action helpful to stop a defined sound on a triggered action.
  125663. */
  125664. export class StopSoundAction extends Action {
  125665. private _sound;
  125666. /**
  125667. * Instantiate the action
  125668. * @param triggerOptions defines the trigger options
  125669. * @param sound defines the sound to stop
  125670. * @param condition defines the trigger related conditions
  125671. */
  125672. constructor(triggerOptions: any, sound: Sound, condition?: Condition);
  125673. /** @hidden */
  125674. _prepare(): void;
  125675. /**
  125676. * Execute the action and stop the sound.
  125677. */
  125678. execute(): void;
  125679. /**
  125680. * Serializes the actions and its related information.
  125681. * @param parent defines the object to serialize in
  125682. * @returns the serialized object
  125683. */
  125684. serialize(parent: any): any;
  125685. }
  125686. }
  125687. declare module BABYLON {
  125688. /**
  125689. * This defines an action responsible to change the value of a property
  125690. * by interpolating between its current value and the newly set one once triggered.
  125691. * @see https://doc.babylonjs.com/how_to/how_to_use_actions
  125692. */
  125693. export class InterpolateValueAction extends Action {
  125694. /**
  125695. * Defines the path of the property where the value should be interpolated
  125696. */
  125697. propertyPath: string;
  125698. /**
  125699. * Defines the target value at the end of the interpolation.
  125700. */
  125701. value: any;
  125702. /**
  125703. * Defines the time it will take for the property to interpolate to the value.
  125704. */
  125705. duration: number;
  125706. /**
  125707. * Defines if the other scene animations should be stopped when the action has been triggered
  125708. */
  125709. stopOtherAnimations?: boolean;
  125710. /**
  125711. * Defines a callback raised once the interpolation animation has been done.
  125712. */
  125713. onInterpolationDone?: () => void;
  125714. /**
  125715. * Observable triggered once the interpolation animation has been done.
  125716. */
  125717. onInterpolationDoneObservable: Observable<InterpolateValueAction>;
  125718. private _target;
  125719. private _effectiveTarget;
  125720. private _property;
  125721. /**
  125722. * Instantiate the action
  125723. * @param triggerOptions defines the trigger options
  125724. * @param target defines the object containing the value to interpolate
  125725. * @param propertyPath defines the path to the property in the target object
  125726. * @param value defines the target value at the end of the interpolation
  125727. * @param duration deines the time it will take for the property to interpolate to the value.
  125728. * @param condition defines the trigger related conditions
  125729. * @param stopOtherAnimations defines if the other scene animations should be stopped when the action has been triggered
  125730. * @param onInterpolationDone defines a callback raised once the interpolation animation has been done
  125731. */
  125732. constructor(triggerOptions: any, target: any, propertyPath: string, value: any, duration?: number, condition?: Condition, stopOtherAnimations?: boolean, onInterpolationDone?: () => void);
  125733. /** @hidden */
  125734. _prepare(): void;
  125735. /**
  125736. * Execute the action starts the value interpolation.
  125737. */
  125738. execute(): void;
  125739. /**
  125740. * Serializes the actions and its related information.
  125741. * @param parent defines the object to serialize in
  125742. * @returns the serialized object
  125743. */
  125744. serialize(parent: any): any;
  125745. }
  125746. }
  125747. declare module BABYLON {
  125748. /**
  125749. * Options allowed during the creation of a sound track.
  125750. */
  125751. export interface ISoundTrackOptions {
  125752. /**
  125753. * The volume the sound track should take during creation
  125754. */
  125755. volume?: number;
  125756. /**
  125757. * Define if the sound track is the main sound track of the scene
  125758. */
  125759. mainTrack?: boolean;
  125760. }
  125761. /**
  125762. * It could be useful to isolate your music & sounds on several tracks to better manage volume on a grouped instance of sounds.
  125763. * It will be also used in a future release to apply effects on a specific track.
  125764. * @see https://doc.babylonjs.com/how_to/playing_sounds_and_music#using-sound-tracks
  125765. */
  125766. export class SoundTrack {
  125767. /**
  125768. * The unique identifier of the sound track in the scene.
  125769. */
  125770. id: number;
  125771. /**
  125772. * The list of sounds included in the sound track.
  125773. */
  125774. soundCollection: Array<Sound>;
  125775. private _outputAudioNode;
  125776. private _scene;
  125777. private _connectedAnalyser;
  125778. private _options;
  125779. private _isInitialized;
  125780. /**
  125781. * Creates a new sound track.
  125782. * @see https://doc.babylonjs.com/how_to/playing_sounds_and_music#using-sound-tracks
  125783. * @param scene Define the scene the sound track belongs to
  125784. * @param options
  125785. */
  125786. constructor(scene: Scene, options?: ISoundTrackOptions);
  125787. private _initializeSoundTrackAudioGraph;
  125788. /**
  125789. * Release the sound track and its associated resources
  125790. */
  125791. dispose(): void;
  125792. /**
  125793. * Adds a sound to this sound track
  125794. * @param sound define the cound to add
  125795. * @ignoreNaming
  125796. */
  125797. AddSound(sound: Sound): void;
  125798. /**
  125799. * Removes a sound to this sound track
  125800. * @param sound define the cound to remove
  125801. * @ignoreNaming
  125802. */
  125803. RemoveSound(sound: Sound): void;
  125804. /**
  125805. * Set a global volume for the full sound track.
  125806. * @param newVolume Define the new volume of the sound track
  125807. */
  125808. setVolume(newVolume: number): void;
  125809. /**
  125810. * Switch the panning model to HRTF:
  125811. * Renders a stereo output of higher quality than equalpower — it uses a convolution with measured impulse responses from human subjects.
  125812. * @see https://doc.babylonjs.com/how_to/playing_sounds_and_music#creating-a-spatial-3d-sound
  125813. */
  125814. switchPanningModelToHRTF(): void;
  125815. /**
  125816. * Switch the panning model to Equal Power:
  125817. * Represents the equal-power panning algorithm, generally regarded as simple and efficient. equalpower is the default value.
  125818. * @see https://doc.babylonjs.com/how_to/playing_sounds_and_music#creating-a-spatial-3d-sound
  125819. */
  125820. switchPanningModelToEqualPower(): void;
  125821. /**
  125822. * Connect the sound track to an audio analyser allowing some amazing
  125823. * synchornization between the sounds/music and your visualization (VuMeter for instance).
  125824. * @see https://doc.babylonjs.com/how_to/playing_sounds_and_music#using-the-analyser
  125825. * @param analyser The analyser to connect to the engine
  125826. */
  125827. connectToAnalyser(analyser: Analyser): void;
  125828. }
  125829. }
  125830. declare module BABYLON {
  125831. interface AbstractScene {
  125832. /**
  125833. * The list of sounds used in the scene.
  125834. */
  125835. sounds: Nullable<Array<Sound>>;
  125836. }
  125837. interface Scene {
  125838. /**
  125839. * @hidden
  125840. * Backing field
  125841. */
  125842. _mainSoundTrack: SoundTrack;
  125843. /**
  125844. * The main sound track played by the scene.
  125845. * It cotains your primary collection of sounds.
  125846. */
  125847. mainSoundTrack: SoundTrack;
  125848. /**
  125849. * The list of sound tracks added to the scene
  125850. * @see https://doc.babylonjs.com/how_to/playing_sounds_and_music
  125851. */
  125852. soundTracks: Nullable<Array<SoundTrack>>;
  125853. /**
  125854. * Gets a sound using a given name
  125855. * @param name defines the name to search for
  125856. * @return the found sound or null if not found at all.
  125857. */
  125858. getSoundByName(name: string): Nullable<Sound>;
  125859. /**
  125860. * Gets or sets if audio support is enabled
  125861. * @see https://doc.babylonjs.com/how_to/playing_sounds_and_music
  125862. */
  125863. audioEnabled: boolean;
  125864. /**
  125865. * Gets or sets if audio will be output to headphones
  125866. * @see https://doc.babylonjs.com/how_to/playing_sounds_and_music
  125867. */
  125868. headphone: boolean;
  125869. /**
  125870. * Gets or sets custom audio listener position provider
  125871. * @see https://doc.babylonjs.com/how_to/playing_sounds_and_music
  125872. */
  125873. audioListenerPositionProvider: Nullable<() => Vector3>;
  125874. /**
  125875. * Gets or sets a refresh rate when using 3D audio positioning
  125876. */
  125877. audioPositioningRefreshRate: number;
  125878. }
  125879. /**
  125880. * Defines the sound scene component responsible to manage any sounds
  125881. * in a given scene.
  125882. */
  125883. export class AudioSceneComponent implements ISceneSerializableComponent {
  125884. private static _CameraDirectionLH;
  125885. private static _CameraDirectionRH;
  125886. /**
  125887. * The component name helpfull to identify the component in the list of scene components.
  125888. */
  125889. readonly name: string;
  125890. /**
  125891. * The scene the component belongs to.
  125892. */
  125893. scene: Scene;
  125894. private _audioEnabled;
  125895. /**
  125896. * Gets whether audio is enabled or not.
  125897. * Please use related enable/disable method to switch state.
  125898. */
  125899. get audioEnabled(): boolean;
  125900. private _headphone;
  125901. /**
  125902. * Gets whether audio is outputing to headphone or not.
  125903. * Please use the according Switch methods to change output.
  125904. */
  125905. get headphone(): boolean;
  125906. /**
  125907. * Gets or sets a refresh rate when using 3D audio positioning
  125908. */
  125909. audioPositioningRefreshRate: number;
  125910. private _audioListenerPositionProvider;
  125911. /**
  125912. * Gets the current audio listener position provider
  125913. */
  125914. get audioListenerPositionProvider(): Nullable<() => Vector3>;
  125915. /**
  125916. * Sets a custom listener position for all sounds in the scene
  125917. * By default, this is the position of the first active camera
  125918. */
  125919. set audioListenerPositionProvider(value: Nullable<() => Vector3>);
  125920. /**
  125921. * Creates a new instance of the component for the given scene
  125922. * @param scene Defines the scene to register the component in
  125923. */
  125924. constructor(scene: Scene);
  125925. /**
  125926. * Registers the component in a given scene
  125927. */
  125928. register(): void;
  125929. /**
  125930. * Rebuilds the elements related to this component in case of
  125931. * context lost for instance.
  125932. */
  125933. rebuild(): void;
  125934. /**
  125935. * Serializes the component data to the specified json object
  125936. * @param serializationObject The object to serialize to
  125937. */
  125938. serialize(serializationObject: any): void;
  125939. /**
  125940. * Adds all the elements from the container to the scene
  125941. * @param container the container holding the elements
  125942. */
  125943. addFromContainer(container: AbstractScene): void;
  125944. /**
  125945. * Removes all the elements in the container from the scene
  125946. * @param container contains the elements to remove
  125947. * @param dispose if the removed element should be disposed (default: false)
  125948. */
  125949. removeFromContainer(container: AbstractScene, dispose?: boolean): void;
  125950. /**
  125951. * Disposes the component and the associated ressources.
  125952. */
  125953. dispose(): void;
  125954. /**
  125955. * Disables audio in the associated scene.
  125956. */
  125957. disableAudio(): void;
  125958. /**
  125959. * Enables audio in the associated scene.
  125960. */
  125961. enableAudio(): void;
  125962. /**
  125963. * Switch audio to headphone output.
  125964. */
  125965. switchAudioModeForHeadphones(): void;
  125966. /**
  125967. * Switch audio to normal speakers.
  125968. */
  125969. switchAudioModeForNormalSpeakers(): void;
  125970. private _cachedCameraDirection;
  125971. private _cachedCameraPosition;
  125972. private _lastCheck;
  125973. private _afterRender;
  125974. }
  125975. }
  125976. declare module BABYLON {
  125977. /**
  125978. * Wraps one or more Sound objects and selects one with random weight for playback.
  125979. */
  125980. export class WeightedSound {
  125981. /** When true a Sound will be selected and played when the current playing Sound completes. */
  125982. loop: boolean;
  125983. private _coneInnerAngle;
  125984. private _coneOuterAngle;
  125985. private _volume;
  125986. /** A Sound is currently playing. */
  125987. isPlaying: boolean;
  125988. /** A Sound is currently paused. */
  125989. isPaused: boolean;
  125990. private _sounds;
  125991. private _weights;
  125992. private _currentIndex?;
  125993. /**
  125994. * Creates a new WeightedSound from the list of sounds given.
  125995. * @param loop When true a Sound will be selected and played when the current playing Sound completes.
  125996. * @param sounds Array of Sounds that will be selected from.
  125997. * @param weights Array of number values for selection weights; length must equal sounds, values will be normalized to 1
  125998. */
  125999. constructor(loop: boolean, sounds: Sound[], weights: number[]);
  126000. /**
  126001. * The size of cone in degrees for a directional sound in which there will be no attenuation.
  126002. */
  126003. get directionalConeInnerAngle(): number;
  126004. /**
  126005. * The size of cone in degress for a directional sound in which there will be no attenuation.
  126006. */
  126007. set directionalConeInnerAngle(value: number);
  126008. /**
  126009. * Size of cone in degrees for a directional sound outside of which there will be no sound.
  126010. * Listener angles between innerAngle and outerAngle will falloff linearly.
  126011. */
  126012. get directionalConeOuterAngle(): number;
  126013. /**
  126014. * Size of cone in degrees for a directional sound outside of which there will be no sound.
  126015. * Listener angles between innerAngle and outerAngle will falloff linearly.
  126016. */
  126017. set directionalConeOuterAngle(value: number);
  126018. /**
  126019. * Playback volume.
  126020. */
  126021. get volume(): number;
  126022. /**
  126023. * Playback volume.
  126024. */
  126025. set volume(value: number);
  126026. private _onended;
  126027. /**
  126028. * Suspend playback
  126029. */
  126030. pause(): void;
  126031. /**
  126032. * Stop playback
  126033. */
  126034. stop(): void;
  126035. /**
  126036. * Start playback.
  126037. * @param startOffset Position the clip head at a specific time in seconds.
  126038. */
  126039. play(startOffset?: number): void;
  126040. }
  126041. }
  126042. declare module BABYLON {
  126043. /**
  126044. * Add a bouncing effect to an ArcRotateCamera when reaching a specified minimum and maximum radius
  126045. * @see https://doc.babylonjs.com/how_to/camera_behaviors#bouncing-behavior
  126046. */
  126047. export class BouncingBehavior implements Behavior<ArcRotateCamera> {
  126048. /**
  126049. * Gets the name of the behavior.
  126050. */
  126051. get name(): string;
  126052. /**
  126053. * The easing function used by animations
  126054. */
  126055. static EasingFunction: BackEase;
  126056. /**
  126057. * The easing mode used by animations
  126058. */
  126059. static EasingMode: number;
  126060. /**
  126061. * The duration of the animation, in milliseconds
  126062. */
  126063. transitionDuration: number;
  126064. /**
  126065. * Length of the distance animated by the transition when lower radius is reached
  126066. */
  126067. lowerRadiusTransitionRange: number;
  126068. /**
  126069. * Length of the distance animated by the transition when upper radius is reached
  126070. */
  126071. upperRadiusTransitionRange: number;
  126072. private _autoTransitionRange;
  126073. /**
  126074. * Gets a value indicating if the lowerRadiusTransitionRange and upperRadiusTransitionRange are defined automatically
  126075. */
  126076. get autoTransitionRange(): boolean;
  126077. /**
  126078. * Sets a value indicating if the lowerRadiusTransitionRange and upperRadiusTransitionRange are defined automatically
  126079. * Transition ranges will be set to 5% of the bounding box diagonal in world space
  126080. */
  126081. set autoTransitionRange(value: boolean);
  126082. private _attachedCamera;
  126083. private _onAfterCheckInputsObserver;
  126084. private _onMeshTargetChangedObserver;
  126085. /**
  126086. * Initializes the behavior.
  126087. */
  126088. init(): void;
  126089. /**
  126090. * Attaches the behavior to its arc rotate camera.
  126091. * @param camera Defines the camera to attach the behavior to
  126092. */
  126093. attach(camera: ArcRotateCamera): void;
  126094. /**
  126095. * Detaches the behavior from its current arc rotate camera.
  126096. */
  126097. detach(): void;
  126098. private _radiusIsAnimating;
  126099. private _radiusBounceTransition;
  126100. private _animatables;
  126101. private _cachedWheelPrecision;
  126102. /**
  126103. * Checks if the camera radius is at the specified limit. Takes into account animation locks.
  126104. * @param radiusLimit The limit to check against.
  126105. * @return Bool to indicate if at limit.
  126106. */
  126107. private _isRadiusAtLimit;
  126108. /**
  126109. * Applies an animation to the radius of the camera, extending by the radiusDelta.
  126110. * @param radiusDelta The delta by which to animate to. Can be negative.
  126111. */
  126112. private _applyBoundRadiusAnimation;
  126113. /**
  126114. * Removes all animation locks. Allows new animations to be added to any of the camera properties.
  126115. */
  126116. protected _clearAnimationLocks(): void;
  126117. /**
  126118. * Stops and removes all animations that have been applied to the camera
  126119. */
  126120. stopAllAnimations(): void;
  126121. }
  126122. }
  126123. declare module BABYLON {
  126124. /**
  126125. * 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.
  126126. * @see https://doc.babylonjs.com/how_to/camera_behaviors#framing-behavior
  126127. */
  126128. export class FramingBehavior implements Behavior<ArcRotateCamera> {
  126129. /**
  126130. * Gets the name of the behavior.
  126131. */
  126132. get name(): string;
  126133. private _mode;
  126134. private _radiusScale;
  126135. private _positionScale;
  126136. private _defaultElevation;
  126137. private _elevationReturnTime;
  126138. private _elevationReturnWaitTime;
  126139. private _zoomStopsAnimation;
  126140. private _framingTime;
  126141. /**
  126142. * The easing function used by animations
  126143. */
  126144. static EasingFunction: ExponentialEase;
  126145. /**
  126146. * The easing mode used by animations
  126147. */
  126148. static EasingMode: number;
  126149. /**
  126150. * Sets the current mode used by the behavior
  126151. */
  126152. set mode(mode: number);
  126153. /**
  126154. * Gets current mode used by the behavior.
  126155. */
  126156. get mode(): number;
  126157. /**
  126158. * Sets the scale applied to the radius (1 by default)
  126159. */
  126160. set radiusScale(radius: number);
  126161. /**
  126162. * Gets the scale applied to the radius
  126163. */
  126164. get radiusScale(): number;
  126165. /**
  126166. * Sets the scale to apply on Y axis to position camera focus. 0.5 by default which means the center of the bounding box.
  126167. */
  126168. set positionScale(scale: number);
  126169. /**
  126170. * Gets the scale to apply on Y axis to position camera focus. 0.5 by default which means the center of the bounding box.
  126171. */
  126172. get positionScale(): number;
  126173. /**
  126174. * Sets the angle above/below the horizontal plane to return to when the return to default elevation idle
  126175. * behaviour is triggered, in radians.
  126176. */
  126177. set defaultElevation(elevation: number);
  126178. /**
  126179. * Gets the angle above/below the horizontal plane to return to when the return to default elevation idle
  126180. * behaviour is triggered, in radians.
  126181. */
  126182. get defaultElevation(): number;
  126183. /**
  126184. * Sets the time (in milliseconds) taken to return to the default beta position.
  126185. * Negative value indicates camera should not return to default.
  126186. */
  126187. set elevationReturnTime(speed: number);
  126188. /**
  126189. * Gets the time (in milliseconds) taken to return to the default beta position.
  126190. * Negative value indicates camera should not return to default.
  126191. */
  126192. get elevationReturnTime(): number;
  126193. /**
  126194. * Sets the delay (in milliseconds) taken before the camera returns to the default beta position.
  126195. */
  126196. set elevationReturnWaitTime(time: number);
  126197. /**
  126198. * Gets the delay (in milliseconds) taken before the camera returns to the default beta position.
  126199. */
  126200. get elevationReturnWaitTime(): number;
  126201. /**
  126202. * Sets the flag that indicates if user zooming should stop animation.
  126203. */
  126204. set zoomStopsAnimation(flag: boolean);
  126205. /**
  126206. * Gets the flag that indicates if user zooming should stop animation.
  126207. */
  126208. get zoomStopsAnimation(): boolean;
  126209. /**
  126210. * Sets the transition time when framing the mesh, in milliseconds
  126211. */
  126212. set framingTime(time: number);
  126213. /**
  126214. * Gets the transition time when framing the mesh, in milliseconds
  126215. */
  126216. get framingTime(): number;
  126217. /**
  126218. * Define if the behavior should automatically change the configured
  126219. * camera limits and sensibilities.
  126220. */
  126221. autoCorrectCameraLimitsAndSensibility: boolean;
  126222. private _onPrePointerObservableObserver;
  126223. private _onAfterCheckInputsObserver;
  126224. private _onMeshTargetChangedObserver;
  126225. private _attachedCamera;
  126226. private _isPointerDown;
  126227. private _lastInteractionTime;
  126228. /**
  126229. * Initializes the behavior.
  126230. */
  126231. init(): void;
  126232. /**
  126233. * Attaches the behavior to its arc rotate camera.
  126234. * @param camera Defines the camera to attach the behavior to
  126235. */
  126236. attach(camera: ArcRotateCamera): void;
  126237. /**
  126238. * Detaches the behavior from its current arc rotate camera.
  126239. */
  126240. detach(): void;
  126241. private _animatables;
  126242. private _betaIsAnimating;
  126243. private _betaTransition;
  126244. private _radiusTransition;
  126245. private _vectorTransition;
  126246. /**
  126247. * Targets the given mesh and updates zoom level accordingly.
  126248. * @param mesh The mesh to target.
  126249. * @param focusOnOriginXZ Determines if the camera should focus on 0 in the X and Z axis instead of the mesh
  126250. * @param onAnimationEnd Callback triggered at the end of the framing animation
  126251. */
  126252. zoomOnMesh(mesh: AbstractMesh, focusOnOriginXZ?: boolean, onAnimationEnd?: Nullable<() => void>): void;
  126253. /**
  126254. * Targets the given mesh with its children and updates zoom level accordingly.
  126255. * @param mesh The mesh to target.
  126256. * @param focusOnOriginXZ Determines if the camera should focus on 0 in the X and Z axis instead of the mesh
  126257. * @param onAnimationEnd Callback triggered at the end of the framing animation
  126258. */
  126259. zoomOnMeshHierarchy(mesh: AbstractMesh, focusOnOriginXZ?: boolean, onAnimationEnd?: Nullable<() => void>): void;
  126260. /**
  126261. * Targets the given meshes with their children and updates zoom level accordingly.
  126262. * @param meshes The mesh to target.
  126263. * @param focusOnOriginXZ Determines if the camera should focus on 0 in the X and Z axis instead of the mesh
  126264. * @param onAnimationEnd Callback triggered at the end of the framing animation
  126265. */
  126266. zoomOnMeshesHierarchy(meshes: AbstractMesh[], focusOnOriginXZ?: boolean, onAnimationEnd?: Nullable<() => void>): void;
  126267. /**
  126268. * Targets the bounding box info defined by its extends and updates zoom level accordingly.
  126269. * @param minimumWorld Determines the smaller position of the bounding box extend
  126270. * @param maximumWorld Determines the bigger position of the bounding box extend
  126271. * @param focusOnOriginXZ Determines if the camera should focus on 0 in the X and Z axis instead of the mesh
  126272. * @param onAnimationEnd Callback triggered at the end of the framing animation
  126273. */
  126274. zoomOnBoundingInfo(minimumWorld: Vector3, maximumWorld: Vector3, focusOnOriginXZ?: boolean, onAnimationEnd?: Nullable<() => void>): void;
  126275. /**
  126276. * Calculates the lowest radius for the camera based on the bounding box of the mesh.
  126277. * @param mesh The mesh on which to base the calculation. mesh boundingInfo used to estimate necessary
  126278. * frustum width.
  126279. * @return The minimum distance from the primary mesh's center point at which the camera must be kept in order
  126280. * to fully enclose the mesh in the viewing frustum.
  126281. */
  126282. protected _calculateLowerRadiusFromModelBoundingSphere(minimumWorld: Vector3, maximumWorld: Vector3): number;
  126283. /**
  126284. * Keeps the camera above the ground plane. If the user pulls the camera below the ground plane, the camera
  126285. * is automatically returned to its default position (expected to be above ground plane).
  126286. */
  126287. private _maintainCameraAboveGround;
  126288. /**
  126289. * Returns the frustum slope based on the canvas ratio and camera FOV
  126290. * @returns The frustum slope represented as a Vector2 with X and Y slopes
  126291. */
  126292. private _getFrustumSlope;
  126293. /**
  126294. * Removes all animation locks. Allows new animations to be added to any of the arcCamera properties.
  126295. */
  126296. private _clearAnimationLocks;
  126297. /**
  126298. * Applies any current user interaction to the camera. Takes into account maximum alpha rotation.
  126299. */
  126300. private _applyUserInteraction;
  126301. /**
  126302. * Stops and removes all animations that have been applied to the camera
  126303. */
  126304. stopAllAnimations(): void;
  126305. /**
  126306. * Gets a value indicating if the user is moving the camera
  126307. */
  126308. get isUserIsMoving(): boolean;
  126309. /**
  126310. * The camera can move all the way towards the mesh.
  126311. */
  126312. static IgnoreBoundsSizeMode: number;
  126313. /**
  126314. * The camera is not allowed to zoom closer to the mesh than the point at which the adjusted bounding sphere touches the frustum sides
  126315. */
  126316. static FitFrustumSidesMode: number;
  126317. }
  126318. }
  126319. declare module BABYLON {
  126320. /**
  126321. * Base class for Camera Pointer Inputs.
  126322. * See FollowCameraPointersInput in src/Cameras/Inputs/followCameraPointersInput.ts
  126323. * for example usage.
  126324. */
  126325. export abstract class BaseCameraPointersInput implements ICameraInput<Camera> {
  126326. /**
  126327. * Defines the camera the input is attached to.
  126328. */
  126329. abstract camera: Camera;
  126330. /**
  126331. * Whether keyboard modifier keys are pressed at time of last mouse event.
  126332. */
  126333. protected _altKey: boolean;
  126334. protected _ctrlKey: boolean;
  126335. protected _metaKey: boolean;
  126336. protected _shiftKey: boolean;
  126337. /**
  126338. * Which mouse buttons were pressed at time of last mouse event.
  126339. * https://developer.mozilla.org/en-US/docs/Web/API/MouseEvent/buttons
  126340. */
  126341. protected _buttonsPressed: number;
  126342. /**
  126343. * Defines the buttons associated with the input to handle camera move.
  126344. */
  126345. buttons: number[];
  126346. /**
  126347. * Attach the input controls to a specific dom element to get the input from.
  126348. * @param element Defines the element the controls should be listened from
  126349. * @param noPreventDefault Defines whether event caught by the controls should call preventdefault() (https://developer.mozilla.org/en-US/docs/Web/API/Event/preventDefault)
  126350. */
  126351. attachControl(element: HTMLElement, noPreventDefault?: boolean): void;
  126352. /**
  126353. * Detach the current controls from the specified dom element.
  126354. * @param element Defines the element to stop listening the inputs from
  126355. */
  126356. detachControl(element: Nullable<HTMLElement>): void;
  126357. /**
  126358. * Gets the class name of the current input.
  126359. * @returns the class name
  126360. */
  126361. getClassName(): string;
  126362. /**
  126363. * Get the friendly name associated with the input class.
  126364. * @returns the input friendly name
  126365. */
  126366. getSimpleName(): string;
  126367. /**
  126368. * Called on pointer POINTERDOUBLETAP event.
  126369. * Override this method to provide functionality on POINTERDOUBLETAP event.
  126370. */
  126371. protected onDoubleTap(type: string): void;
  126372. /**
  126373. * Called on pointer POINTERMOVE event if only a single touch is active.
  126374. * Override this method to provide functionality.
  126375. */
  126376. protected onTouch(point: Nullable<PointerTouch>, offsetX: number, offsetY: number): void;
  126377. /**
  126378. * Called on pointer POINTERMOVE event if multiple touches are active.
  126379. * Override this method to provide functionality.
  126380. */
  126381. protected onMultiTouch(pointA: Nullable<PointerTouch>, pointB: Nullable<PointerTouch>, previousPinchSquaredDistance: number, pinchSquaredDistance: number, previousMultiTouchPanPosition: Nullable<PointerTouch>, multiTouchPanPosition: Nullable<PointerTouch>): void;
  126382. /**
  126383. * Called on JS contextmenu event.
  126384. * Override this method to provide functionality.
  126385. */
  126386. protected onContextMenu(evt: PointerEvent): void;
  126387. /**
  126388. * Called each time a new POINTERDOWN event occurs. Ie, for each button
  126389. * press.
  126390. * Override this method to provide functionality.
  126391. */
  126392. protected onButtonDown(evt: PointerEvent): void;
  126393. /**
  126394. * Called each time a new POINTERUP event occurs. Ie, for each button
  126395. * release.
  126396. * Override this method to provide functionality.
  126397. */
  126398. protected onButtonUp(evt: PointerEvent): void;
  126399. /**
  126400. * Called when window becomes inactive.
  126401. * Override this method to provide functionality.
  126402. */
  126403. protected onLostFocus(): void;
  126404. private _pointerInput;
  126405. private _observer;
  126406. private _onLostFocus;
  126407. private pointA;
  126408. private pointB;
  126409. }
  126410. }
  126411. declare module BABYLON {
  126412. /**
  126413. * Manage the pointers inputs to control an arc rotate camera.
  126414. * @see https://doc.babylonjs.com/how_to/customizing_camera_inputs
  126415. */
  126416. export class ArcRotateCameraPointersInput extends BaseCameraPointersInput {
  126417. /**
  126418. * Defines the camera the input is attached to.
  126419. */
  126420. camera: ArcRotateCamera;
  126421. /**
  126422. * Gets the class name of the current input.
  126423. * @returns the class name
  126424. */
  126425. getClassName(): string;
  126426. /**
  126427. * Defines the buttons associated with the input to handle camera move.
  126428. */
  126429. buttons: number[];
  126430. /**
  126431. * Defines the pointer angular sensibility along the X axis or how fast is
  126432. * the camera rotating.
  126433. */
  126434. angularSensibilityX: number;
  126435. /**
  126436. * Defines the pointer angular sensibility along the Y axis or how fast is
  126437. * the camera rotating.
  126438. */
  126439. angularSensibilityY: number;
  126440. /**
  126441. * Defines the pointer pinch precision or how fast is the camera zooming.
  126442. */
  126443. pinchPrecision: number;
  126444. /**
  126445. * pinchDeltaPercentage will be used instead of pinchPrecision if different
  126446. * from 0.
  126447. * It defines the percentage of current camera.radius to use as delta when
  126448. * pinch zoom is used.
  126449. */
  126450. pinchDeltaPercentage: number;
  126451. /**
  126452. * When useNaturalPinchZoom is true, multi touch zoom will zoom in such
  126453. * that any object in the plane at the camera's target point will scale
  126454. * perfectly with finger motion.
  126455. * Overrides pinchDeltaPercentage and pinchPrecision.
  126456. */
  126457. useNaturalPinchZoom: boolean;
  126458. /**
  126459. * Defines the pointer panning sensibility or how fast is the camera moving.
  126460. */
  126461. panningSensibility: number;
  126462. /**
  126463. * Defines whether panning (2 fingers swipe) is enabled through multitouch.
  126464. */
  126465. multiTouchPanning: boolean;
  126466. /**
  126467. * Defines whether panning is enabled for both pan (2 fingers swipe) and
  126468. * zoom (pinch) through multitouch.
  126469. */
  126470. multiTouchPanAndZoom: boolean;
  126471. /**
  126472. * Revers pinch action direction.
  126473. */
  126474. pinchInwards: boolean;
  126475. private _isPanClick;
  126476. private _twoFingerActivityCount;
  126477. private _isPinching;
  126478. /**
  126479. * Called on pointer POINTERMOVE event if only a single touch is active.
  126480. */
  126481. protected onTouch(point: Nullable<PointerTouch>, offsetX: number, offsetY: number): void;
  126482. /**
  126483. * Called on pointer POINTERDOUBLETAP event.
  126484. */
  126485. protected onDoubleTap(type: string): void;
  126486. /**
  126487. * Called on pointer POINTERMOVE event if multiple touches are active.
  126488. */
  126489. protected onMultiTouch(pointA: Nullable<PointerTouch>, pointB: Nullable<PointerTouch>, previousPinchSquaredDistance: number, pinchSquaredDistance: number, previousMultiTouchPanPosition: Nullable<PointerTouch>, multiTouchPanPosition: Nullable<PointerTouch>): void;
  126490. /**
  126491. * Called each time a new POINTERDOWN event occurs. Ie, for each button
  126492. * press.
  126493. */
  126494. protected onButtonDown(evt: PointerEvent): void;
  126495. /**
  126496. * Called each time a new POINTERUP event occurs. Ie, for each button
  126497. * release.
  126498. */
  126499. protected onButtonUp(evt: PointerEvent): void;
  126500. /**
  126501. * Called when window becomes inactive.
  126502. */
  126503. protected onLostFocus(): void;
  126504. }
  126505. }
  126506. declare module BABYLON {
  126507. /**
  126508. * Manage the keyboard inputs to control the movement of an arc rotate camera.
  126509. * @see https://doc.babylonjs.com/how_to/customizing_camera_inputs
  126510. */
  126511. export class ArcRotateCameraKeyboardMoveInput implements ICameraInput<ArcRotateCamera> {
  126512. /**
  126513. * Defines the camera the input is attached to.
  126514. */
  126515. camera: ArcRotateCamera;
  126516. /**
  126517. * Defines the list of key codes associated with the up action (increase alpha)
  126518. */
  126519. keysUp: number[];
  126520. /**
  126521. * Defines the list of key codes associated with the down action (decrease alpha)
  126522. */
  126523. keysDown: number[];
  126524. /**
  126525. * Defines the list of key codes associated with the left action (increase beta)
  126526. */
  126527. keysLeft: number[];
  126528. /**
  126529. * Defines the list of key codes associated with the right action (decrease beta)
  126530. */
  126531. keysRight: number[];
  126532. /**
  126533. * Defines the list of key codes associated with the reset action.
  126534. * Those keys reset the camera to its last stored state (with the method camera.storeState())
  126535. */
  126536. keysReset: number[];
  126537. /**
  126538. * Defines the panning sensibility of the inputs.
  126539. * (How fast is the camera panning)
  126540. */
  126541. panningSensibility: number;
  126542. /**
  126543. * Defines the zooming sensibility of the inputs.
  126544. * (How fast is the camera zooming)
  126545. */
  126546. zoomingSensibility: number;
  126547. /**
  126548. * Defines whether maintaining the alt key down switch the movement mode from
  126549. * orientation to zoom.
  126550. */
  126551. useAltToZoom: boolean;
  126552. /**
  126553. * Rotation speed of the camera
  126554. */
  126555. angularSpeed: number;
  126556. private _keys;
  126557. private _ctrlPressed;
  126558. private _altPressed;
  126559. private _onCanvasBlurObserver;
  126560. private _onKeyboardObserver;
  126561. private _engine;
  126562. private _scene;
  126563. /**
  126564. * Attach the input controls to a specific dom element to get the input from.
  126565. * @param element Defines the element the controls should be listened from
  126566. * @param noPreventDefault Defines whether event caught by the controls should call preventdefault() (https://developer.mozilla.org/en-US/docs/Web/API/Event/preventDefault)
  126567. */
  126568. attachControl(element: HTMLElement, noPreventDefault?: boolean): void;
  126569. /**
  126570. * Detach the current controls from the specified dom element.
  126571. * @param element Defines the element to stop listening the inputs from
  126572. */
  126573. detachControl(element: Nullable<HTMLElement>): void;
  126574. /**
  126575. * Update the current camera state depending on the inputs that have been used this frame.
  126576. * This is a dynamically created lambda to avoid the performance penalty of looping for inputs in the render loop.
  126577. */
  126578. checkInputs(): void;
  126579. /**
  126580. * Gets the class name of the current intput.
  126581. * @returns the class name
  126582. */
  126583. getClassName(): string;
  126584. /**
  126585. * Get the friendly name associated with the input class.
  126586. * @returns the input friendly name
  126587. */
  126588. getSimpleName(): string;
  126589. }
  126590. }
  126591. declare module BABYLON {
  126592. /**
  126593. * Manage the mouse wheel inputs to control an arc rotate camera.
  126594. * @see https://doc.babylonjs.com/how_to/customizing_camera_inputs
  126595. */
  126596. export class ArcRotateCameraMouseWheelInput implements ICameraInput<ArcRotateCamera> {
  126597. /**
  126598. * Defines the camera the input is attached to.
  126599. */
  126600. camera: ArcRotateCamera;
  126601. /**
  126602. * Gets or Set the mouse wheel precision or how fast is the camera zooming.
  126603. */
  126604. wheelPrecision: number;
  126605. /**
  126606. * wheelDeltaPercentage will be used instead of wheelPrecision if different from 0.
  126607. * It defines the percentage of current camera.radius to use as delta when wheel is used.
  126608. */
  126609. wheelDeltaPercentage: number;
  126610. private _wheel;
  126611. private _observer;
  126612. private computeDeltaFromMouseWheelLegacyEvent;
  126613. /**
  126614. * Attach the input controls to a specific dom element to get the input from.
  126615. * @param element Defines the element the controls should be listened from
  126616. * @param noPreventDefault Defines whether event caught by the controls should call preventdefault() (https://developer.mozilla.org/en-US/docs/Web/API/Event/preventDefault)
  126617. */
  126618. attachControl(element: HTMLElement, noPreventDefault?: boolean): void;
  126619. /**
  126620. * Detach the current controls from the specified dom element.
  126621. * @param element Defines the element to stop listening the inputs from
  126622. */
  126623. detachControl(element: Nullable<HTMLElement>): void;
  126624. /**
  126625. * Gets the class name of the current intput.
  126626. * @returns the class name
  126627. */
  126628. getClassName(): string;
  126629. /**
  126630. * Get the friendly name associated with the input class.
  126631. * @returns the input friendly name
  126632. */
  126633. getSimpleName(): string;
  126634. }
  126635. }
  126636. declare module BABYLON {
  126637. /**
  126638. * Default Inputs manager for the ArcRotateCamera.
  126639. * It groups all the default supported inputs for ease of use.
  126640. * @see https://doc.babylonjs.com/how_to/customizing_camera_inputs
  126641. */
  126642. export class ArcRotateCameraInputsManager extends CameraInputsManager<ArcRotateCamera> {
  126643. /**
  126644. * Instantiates a new ArcRotateCameraInputsManager.
  126645. * @param camera Defines the camera the inputs belong to
  126646. */
  126647. constructor(camera: ArcRotateCamera);
  126648. /**
  126649. * Add mouse wheel input support to the input manager.
  126650. * @returns the current input manager
  126651. */
  126652. addMouseWheel(): ArcRotateCameraInputsManager;
  126653. /**
  126654. * Add pointers input support to the input manager.
  126655. * @returns the current input manager
  126656. */
  126657. addPointers(): ArcRotateCameraInputsManager;
  126658. /**
  126659. * Add keyboard input support to the input manager.
  126660. * @returns the current input manager
  126661. */
  126662. addKeyboard(): ArcRotateCameraInputsManager;
  126663. }
  126664. }
  126665. declare module BABYLON {
  126666. /**
  126667. * This represents an orbital type of camera.
  126668. *
  126669. * 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.
  126670. * 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.
  126671. * @see https://doc.babylonjs.com/babylon101/cameras#arc-rotate-camera
  126672. */
  126673. export class ArcRotateCamera extends TargetCamera {
  126674. /**
  126675. * Defines the rotation angle of the camera along the longitudinal axis.
  126676. */
  126677. alpha: number;
  126678. /**
  126679. * Defines the rotation angle of the camera along the latitudinal axis.
  126680. */
  126681. beta: number;
  126682. /**
  126683. * Defines the radius of the camera from it s target point.
  126684. */
  126685. radius: number;
  126686. protected _target: Vector3;
  126687. protected _targetHost: Nullable<AbstractMesh>;
  126688. /**
  126689. * Defines the target point of the camera.
  126690. * The camera looks towards it form the radius distance.
  126691. * Please note that you can set the target to a mesh and thus the target will be copied from mesh.position
  126692. */
  126693. get target(): Vector3;
  126694. set target(value: Vector3);
  126695. /**
  126696. * Define the current local position of the camera in the scene
  126697. */
  126698. get position(): Vector3;
  126699. set position(newPosition: Vector3);
  126700. protected _upToYMatrix: Matrix;
  126701. protected _YToUpMatrix: Matrix;
  126702. /**
  126703. * The vector the camera should consider as up. (default is Vector3(0, 1, 0) as returned by Vector3.Up())
  126704. * Setting this will copy the given vector to the camera's upVector, and set rotation matrices to and from Y up.
  126705. * DO NOT set the up vector using copyFrom or copyFromFloats, as this bypasses setting the above matrices.
  126706. */
  126707. set upVector(vec: Vector3);
  126708. get upVector(): Vector3;
  126709. /**
  126710. * Sets the Y-up to camera up-vector rotation matrix, and the up-vector to Y-up rotation matrix.
  126711. */
  126712. setMatUp(): void;
  126713. /**
  126714. * Current inertia value on the longitudinal axis.
  126715. * The bigger this number the longer it will take for the camera to stop.
  126716. */
  126717. inertialAlphaOffset: number;
  126718. /**
  126719. * Current inertia value on the latitudinal axis.
  126720. * The bigger this number the longer it will take for the camera to stop.
  126721. */
  126722. inertialBetaOffset: number;
  126723. /**
  126724. * Current inertia value on the radius axis.
  126725. * The bigger this number the longer it will take for the camera to stop.
  126726. */
  126727. inertialRadiusOffset: number;
  126728. /**
  126729. * Minimum allowed angle on the longitudinal axis.
  126730. * This can help limiting how the Camera is able to move in the scene.
  126731. */
  126732. lowerAlphaLimit: Nullable<number>;
  126733. /**
  126734. * Maximum allowed angle on the longitudinal axis.
  126735. * This can help limiting how the Camera is able to move in the scene.
  126736. */
  126737. upperAlphaLimit: Nullable<number>;
  126738. /**
  126739. * Minimum allowed angle on the latitudinal axis.
  126740. * This can help limiting how the Camera is able to move in the scene.
  126741. */
  126742. lowerBetaLimit: number;
  126743. /**
  126744. * Maximum allowed angle on the latitudinal axis.
  126745. * This can help limiting how the Camera is able to move in the scene.
  126746. */
  126747. upperBetaLimit: number;
  126748. /**
  126749. * Minimum allowed distance of the camera to the target (The camera can not get closer).
  126750. * This can help limiting how the Camera is able to move in the scene.
  126751. */
  126752. lowerRadiusLimit: Nullable<number>;
  126753. /**
  126754. * Maximum allowed distance of the camera to the target (The camera can not get further).
  126755. * This can help limiting how the Camera is able to move in the scene.
  126756. */
  126757. upperRadiusLimit: Nullable<number>;
  126758. /**
  126759. * Defines the current inertia value used during panning of the camera along the X axis.
  126760. */
  126761. inertialPanningX: number;
  126762. /**
  126763. * Defines the current inertia value used during panning of the camera along the Y axis.
  126764. */
  126765. inertialPanningY: number;
  126766. /**
  126767. * Defines the distance used to consider the camera in pan mode vs pinch/zoom.
  126768. * Basically if your fingers moves away from more than this distance you will be considered
  126769. * in pinch mode.
  126770. */
  126771. pinchToPanMaxDistance: number;
  126772. /**
  126773. * Defines the maximum distance the camera can pan.
  126774. * This could help keeping the cammera always in your scene.
  126775. */
  126776. panningDistanceLimit: Nullable<number>;
  126777. /**
  126778. * Defines the target of the camera before paning.
  126779. */
  126780. panningOriginTarget: Vector3;
  126781. /**
  126782. * Defines the value of the inertia used during panning.
  126783. * 0 would mean stop inertia and one would mean no decelleration at all.
  126784. */
  126785. panningInertia: number;
  126786. /**
  126787. * Gets or Set the pointer angular sensibility along the X axis or how fast is the camera rotating.
  126788. */
  126789. get angularSensibilityX(): number;
  126790. set angularSensibilityX(value: number);
  126791. /**
  126792. * Gets or Set the pointer angular sensibility along the Y axis or how fast is the camera rotating.
  126793. */
  126794. get angularSensibilityY(): number;
  126795. set angularSensibilityY(value: number);
  126796. /**
  126797. * Gets or Set the pointer pinch precision or how fast is the camera zooming.
  126798. */
  126799. get pinchPrecision(): number;
  126800. set pinchPrecision(value: number);
  126801. /**
  126802. * Gets or Set the pointer pinch delta percentage or how fast is the camera zooming.
  126803. * It will be used instead of pinchDeltaPrecision if different from 0.
  126804. * It defines the percentage of current camera.radius to use as delta when pinch zoom is used.
  126805. */
  126806. get pinchDeltaPercentage(): number;
  126807. set pinchDeltaPercentage(value: number);
  126808. /**
  126809. * Gets or Set the pointer use natural pinch zoom to override the pinch precision
  126810. * and pinch delta percentage.
  126811. * When useNaturalPinchZoom is true, multi touch zoom will zoom in such
  126812. * that any object in the plane at the camera's target point will scale
  126813. * perfectly with finger motion.
  126814. */
  126815. get useNaturalPinchZoom(): boolean;
  126816. set useNaturalPinchZoom(value: boolean);
  126817. /**
  126818. * Gets or Set the pointer panning sensibility or how fast is the camera moving.
  126819. */
  126820. get panningSensibility(): number;
  126821. set panningSensibility(value: number);
  126822. /**
  126823. * Gets or Set the list of keyboard keys used to control beta angle in a positive direction.
  126824. */
  126825. get keysUp(): number[];
  126826. set keysUp(value: number[]);
  126827. /**
  126828. * Gets or Set the list of keyboard keys used to control beta angle in a negative direction.
  126829. */
  126830. get keysDown(): number[];
  126831. set keysDown(value: number[]);
  126832. /**
  126833. * Gets or Set the list of keyboard keys used to control alpha angle in a negative direction.
  126834. */
  126835. get keysLeft(): number[];
  126836. set keysLeft(value: number[]);
  126837. /**
  126838. * Gets or Set the list of keyboard keys used to control alpha angle in a positive direction.
  126839. */
  126840. get keysRight(): number[];
  126841. set keysRight(value: number[]);
  126842. /**
  126843. * Gets or Set the mouse wheel precision or how fast is the camera zooming.
  126844. */
  126845. get wheelPrecision(): number;
  126846. set wheelPrecision(value: number);
  126847. /**
  126848. * Gets or Set the mouse wheel delta percentage or how fast is the camera zooming.
  126849. * It will be used instead of pinchDeltaPrecision if different from 0.
  126850. * It defines the percentage of current camera.radius to use as delta when pinch zoom is used.
  126851. */
  126852. get wheelDeltaPercentage(): number;
  126853. set wheelDeltaPercentage(value: number);
  126854. /**
  126855. * Defines how much the radius should be scaled while zomming on a particular mesh (through the zoomOn function)
  126856. */
  126857. zoomOnFactor: number;
  126858. /**
  126859. * Defines a screen offset for the camera position.
  126860. */
  126861. targetScreenOffset: Vector2;
  126862. /**
  126863. * Allows the camera to be completely reversed.
  126864. * If false the camera can not arrive upside down.
  126865. */
  126866. allowUpsideDown: boolean;
  126867. /**
  126868. * Define if double tap/click is used to restore the previously saved state of the camera.
  126869. */
  126870. useInputToRestoreState: boolean;
  126871. /** @hidden */
  126872. _viewMatrix: Matrix;
  126873. /** @hidden */
  126874. _useCtrlForPanning: boolean;
  126875. /** @hidden */
  126876. _panningMouseButton: number;
  126877. /**
  126878. * Defines the input associated to the camera.
  126879. */
  126880. inputs: ArcRotateCameraInputsManager;
  126881. /** @hidden */
  126882. _reset: () => void;
  126883. /**
  126884. * Defines the allowed panning axis.
  126885. */
  126886. panningAxis: Vector3;
  126887. protected _localDirection: Vector3;
  126888. protected _transformedDirection: Vector3;
  126889. private _bouncingBehavior;
  126890. /**
  126891. * Gets the bouncing behavior of the camera if it has been enabled.
  126892. * @see https://doc.babylonjs.com/how_to/camera_behaviors#bouncing-behavior
  126893. */
  126894. get bouncingBehavior(): Nullable<BouncingBehavior>;
  126895. /**
  126896. * Defines if the bouncing behavior of the camera is enabled on the camera.
  126897. * @see https://doc.babylonjs.com/how_to/camera_behaviors#bouncing-behavior
  126898. */
  126899. get useBouncingBehavior(): boolean;
  126900. set useBouncingBehavior(value: boolean);
  126901. private _framingBehavior;
  126902. /**
  126903. * Gets the framing behavior of the camera if it has been enabled.
  126904. * @see https://doc.babylonjs.com/how_to/camera_behaviors#framing-behavior
  126905. */
  126906. get framingBehavior(): Nullable<FramingBehavior>;
  126907. /**
  126908. * Defines if the framing behavior of the camera is enabled on the camera.
  126909. * @see https://doc.babylonjs.com/how_to/camera_behaviors#framing-behavior
  126910. */
  126911. get useFramingBehavior(): boolean;
  126912. set useFramingBehavior(value: boolean);
  126913. private _autoRotationBehavior;
  126914. /**
  126915. * Gets the auto rotation behavior of the camera if it has been enabled.
  126916. * @see https://doc.babylonjs.com/how_to/camera_behaviors#autorotation-behavior
  126917. */
  126918. get autoRotationBehavior(): Nullable<AutoRotationBehavior>;
  126919. /**
  126920. * Defines if the auto rotation behavior of the camera is enabled on the camera.
  126921. * @see https://doc.babylonjs.com/how_to/camera_behaviors#autorotation-behavior
  126922. */
  126923. get useAutoRotationBehavior(): boolean;
  126924. set useAutoRotationBehavior(value: boolean);
  126925. /**
  126926. * Observable triggered when the mesh target has been changed on the camera.
  126927. */
  126928. onMeshTargetChangedObservable: Observable<Nullable<AbstractMesh>>;
  126929. /**
  126930. * Event raised when the camera is colliding with a mesh.
  126931. */
  126932. onCollide: (collidedMesh: AbstractMesh) => void;
  126933. /**
  126934. * Defines whether the camera should check collision with the objects oh the scene.
  126935. * @see https://doc.babylonjs.com/babylon101/cameras,_mesh_collisions_and_gravity#how-can-i-do-this
  126936. */
  126937. checkCollisions: boolean;
  126938. /**
  126939. * Defines the collision radius of the camera.
  126940. * This simulates a sphere around the camera.
  126941. * @see https://doc.babylonjs.com/babylon101/cameras,_mesh_collisions_and_gravity#arcrotatecamera
  126942. */
  126943. collisionRadius: Vector3;
  126944. protected _collider: Collider;
  126945. protected _previousPosition: Vector3;
  126946. protected _collisionVelocity: Vector3;
  126947. protected _newPosition: Vector3;
  126948. protected _previousAlpha: number;
  126949. protected _previousBeta: number;
  126950. protected _previousRadius: number;
  126951. protected _collisionTriggered: boolean;
  126952. protected _targetBoundingCenter: Nullable<Vector3>;
  126953. private _computationVector;
  126954. /**
  126955. * Instantiates a new ArcRotateCamera in a given scene
  126956. * @param name Defines the name of the camera
  126957. * @param alpha Defines the camera rotation along the logitudinal axis
  126958. * @param beta Defines the camera rotation along the latitudinal axis
  126959. * @param radius Defines the camera distance from its target
  126960. * @param target Defines the camera target
  126961. * @param scene Defines the scene the camera belongs to
  126962. * @param setActiveOnSceneIfNoneActive Defines wheter the camera should be marked as active if not other active cameras have been defined
  126963. */
  126964. constructor(name: string, alpha: number, beta: number, radius: number, target: Vector3, scene: Scene, setActiveOnSceneIfNoneActive?: boolean);
  126965. /** @hidden */
  126966. _initCache(): void;
  126967. /** @hidden */
  126968. _updateCache(ignoreParentClass?: boolean): void;
  126969. protected _getTargetPosition(): Vector3;
  126970. private _storedAlpha;
  126971. private _storedBeta;
  126972. private _storedRadius;
  126973. private _storedTarget;
  126974. private _storedTargetScreenOffset;
  126975. /**
  126976. * Stores the current state of the camera (alpha, beta, radius and target)
  126977. * @returns the camera itself
  126978. */
  126979. storeState(): Camera;
  126980. /**
  126981. * @hidden
  126982. * Restored camera state. You must call storeState() first
  126983. */
  126984. _restoreStateValues(): boolean;
  126985. /** @hidden */
  126986. _isSynchronizedViewMatrix(): boolean;
  126987. /**
  126988. * Attached controls to the current camera.
  126989. * @param element Defines the element the controls should be listened from
  126990. * @param noPreventDefault Defines whether event caught by the controls should call preventdefault() (https://developer.mozilla.org/en-US/docs/Web/API/Event/preventDefault)
  126991. * @param useCtrlForPanning Defines whether ctrl is used for paning within the controls
  126992. * @param panningMouseButton Defines whether panning is allowed through mouse click button
  126993. */
  126994. attachControl(element: HTMLElement, noPreventDefault?: boolean, useCtrlForPanning?: boolean, panningMouseButton?: number): void;
  126995. /**
  126996. * Detach the current controls from the camera.
  126997. * The camera will stop reacting to inputs.
  126998. * @param element Defines the element to stop listening the inputs from
  126999. */
  127000. detachControl(element: HTMLElement): void;
  127001. /** @hidden */
  127002. _checkInputs(): void;
  127003. protected _checkLimits(): void;
  127004. /**
  127005. * Rebuilds angles (alpha, beta) and radius from the give position and target
  127006. */
  127007. rebuildAnglesAndRadius(): void;
  127008. /**
  127009. * Use a position to define the current camera related information like alpha, beta and radius
  127010. * @param position Defines the position to set the camera at
  127011. */
  127012. setPosition(position: Vector3): void;
  127013. /**
  127014. * Defines the target the camera should look at.
  127015. * This will automatically adapt alpha beta and radius to fit within the new target.
  127016. * @param target Defines the new target as a Vector or a mesh
  127017. * @param toBoundingCenter In case of a mesh target, defines whether to target the mesh position or its bounding information center
  127018. * @param allowSamePosition If false, prevents reapplying the new computed position if it is identical to the current one (optim)
  127019. */
  127020. setTarget(target: AbstractMesh | Vector3, toBoundingCenter?: boolean, allowSamePosition?: boolean): void;
  127021. /** @hidden */
  127022. _getViewMatrix(): Matrix;
  127023. protected _onCollisionPositionChange: (collisionId: number, newPosition: Vector3, collidedMesh?: Nullable<AbstractMesh>) => void;
  127024. /**
  127025. * Zooms on a mesh to be at the min distance where we could see it fully in the current viewport.
  127026. * @param meshes Defines the mesh to zoom on
  127027. * @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)
  127028. */
  127029. zoomOn(meshes?: AbstractMesh[], doNotUpdateMaxZ?: boolean): void;
  127030. /**
  127031. * Focus on a mesh or a bounding box. This adapts the target and maxRadius if necessary but does not update the current radius.
  127032. * The target will be changed but the radius
  127033. * @param meshesOrMinMaxVectorAndDistance Defines the mesh or bounding info to focus on
  127034. * @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)
  127035. */
  127036. focusOn(meshesOrMinMaxVectorAndDistance: AbstractMesh[] | {
  127037. min: Vector3;
  127038. max: Vector3;
  127039. distance: number;
  127040. }, doNotUpdateMaxZ?: boolean): void;
  127041. /**
  127042. * @override
  127043. * Override Camera.createRigCamera
  127044. */
  127045. createRigCamera(name: string, cameraIndex: number): Camera;
  127046. /**
  127047. * @hidden
  127048. * @override
  127049. * Override Camera._updateRigCameras
  127050. */
  127051. _updateRigCameras(): void;
  127052. /**
  127053. * Destroy the camera and release the current resources hold by it.
  127054. */
  127055. dispose(): void;
  127056. /**
  127057. * Gets the current object class name.
  127058. * @return the class name
  127059. */
  127060. getClassName(): string;
  127061. }
  127062. }
  127063. declare module BABYLON {
  127064. /**
  127065. * The autoRotation behavior (AutoRotationBehavior) is designed to create a smooth rotation of an ArcRotateCamera when there is no user interaction.
  127066. * @see https://doc.babylonjs.com/how_to/camera_behaviors#autorotation-behavior
  127067. */
  127068. export class AutoRotationBehavior implements Behavior<ArcRotateCamera> {
  127069. /**
  127070. * Gets the name of the behavior.
  127071. */
  127072. get name(): string;
  127073. private _zoomStopsAnimation;
  127074. private _idleRotationSpeed;
  127075. private _idleRotationWaitTime;
  127076. private _idleRotationSpinupTime;
  127077. /**
  127078. * Sets the flag that indicates if user zooming should stop animation.
  127079. */
  127080. set zoomStopsAnimation(flag: boolean);
  127081. /**
  127082. * Gets the flag that indicates if user zooming should stop animation.
  127083. */
  127084. get zoomStopsAnimation(): boolean;
  127085. /**
  127086. * Sets the default speed at which the camera rotates around the model.
  127087. */
  127088. set idleRotationSpeed(speed: number);
  127089. /**
  127090. * Gets the default speed at which the camera rotates around the model.
  127091. */
  127092. get idleRotationSpeed(): number;
  127093. /**
  127094. * Sets the time (in milliseconds) to wait after user interaction before the camera starts rotating.
  127095. */
  127096. set idleRotationWaitTime(time: number);
  127097. /**
  127098. * Gets the time (milliseconds) to wait after user interaction before the camera starts rotating.
  127099. */
  127100. get idleRotationWaitTime(): number;
  127101. /**
  127102. * Sets the time (milliseconds) to take to spin up to the full idle rotation speed.
  127103. */
  127104. set idleRotationSpinupTime(time: number);
  127105. /**
  127106. * Gets the time (milliseconds) to take to spin up to the full idle rotation speed.
  127107. */
  127108. get idleRotationSpinupTime(): number;
  127109. /**
  127110. * Gets a value indicating if the camera is currently rotating because of this behavior
  127111. */
  127112. get rotationInProgress(): boolean;
  127113. private _onPrePointerObservableObserver;
  127114. private _onAfterCheckInputsObserver;
  127115. private _attachedCamera;
  127116. private _isPointerDown;
  127117. private _lastFrameTime;
  127118. private _lastInteractionTime;
  127119. private _cameraRotationSpeed;
  127120. /**
  127121. * Initializes the behavior.
  127122. */
  127123. init(): void;
  127124. /**
  127125. * Attaches the behavior to its arc rotate camera.
  127126. * @param camera Defines the camera to attach the behavior to
  127127. */
  127128. attach(camera: ArcRotateCamera): void;
  127129. /**
  127130. * Detaches the behavior from its current arc rotate camera.
  127131. */
  127132. detach(): void;
  127133. /**
  127134. * Returns true if user is scrolling.
  127135. * @return true if user is scrolling.
  127136. */
  127137. private _userIsZooming;
  127138. private _lastFrameRadius;
  127139. private _shouldAnimationStopForInteraction;
  127140. /**
  127141. * Applies any current user interaction to the camera. Takes into account maximum alpha rotation.
  127142. */
  127143. private _applyUserInteraction;
  127144. private _userIsMoving;
  127145. }
  127146. }
  127147. declare module BABYLON {
  127148. /**
  127149. * A behavior that when attached to a mesh will will place a specified node on the meshes face pointing towards the camera
  127150. */
  127151. export class AttachToBoxBehavior implements Behavior<Mesh> {
  127152. private ui;
  127153. /**
  127154. * The name of the behavior
  127155. */
  127156. name: string;
  127157. /**
  127158. * The distance away from the face of the mesh that the UI should be attached to (default: 0.15)
  127159. */
  127160. distanceAwayFromFace: number;
  127161. /**
  127162. * The distance from the bottom of the face that the UI should be attached to (default: 0.15)
  127163. */
  127164. distanceAwayFromBottomOfFace: number;
  127165. private _faceVectors;
  127166. private _target;
  127167. private _scene;
  127168. private _onRenderObserver;
  127169. private _tmpMatrix;
  127170. private _tmpVector;
  127171. /**
  127172. * Creates the AttachToBoxBehavior, used to attach UI to the closest face of the box to a camera
  127173. * @param ui The transform node that should be attched to the mesh
  127174. */
  127175. constructor(ui: TransformNode);
  127176. /**
  127177. * Initializes the behavior
  127178. */
  127179. init(): void;
  127180. private _closestFace;
  127181. private _zeroVector;
  127182. private _lookAtTmpMatrix;
  127183. private _lookAtToRef;
  127184. /**
  127185. * Attaches the AttachToBoxBehavior to the passed in mesh
  127186. * @param target The mesh that the specified node will be attached to
  127187. */
  127188. attach(target: Mesh): void;
  127189. /**
  127190. * Detaches the behavior from the mesh
  127191. */
  127192. detach(): void;
  127193. }
  127194. }
  127195. declare module BABYLON {
  127196. /**
  127197. * A behavior that when attached to a mesh will allow the mesh to fade in and out
  127198. */
  127199. export class FadeInOutBehavior implements Behavior<Mesh> {
  127200. /**
  127201. * Time in milliseconds to delay before fading in (Default: 0)
  127202. */
  127203. delay: number;
  127204. /**
  127205. * Time in milliseconds for the mesh to fade in (Default: 300)
  127206. */
  127207. fadeInTime: number;
  127208. private _millisecondsPerFrame;
  127209. private _hovered;
  127210. private _hoverValue;
  127211. private _ownerNode;
  127212. /**
  127213. * Instatiates the FadeInOutBehavior
  127214. */
  127215. constructor();
  127216. /**
  127217. * The name of the behavior
  127218. */
  127219. get name(): string;
  127220. /**
  127221. * Initializes the behavior
  127222. */
  127223. init(): void;
  127224. /**
  127225. * Attaches the fade behavior on the passed in mesh
  127226. * @param ownerNode The mesh that will be faded in/out once attached
  127227. */
  127228. attach(ownerNode: Mesh): void;
  127229. /**
  127230. * Detaches the behavior from the mesh
  127231. */
  127232. detach(): void;
  127233. /**
  127234. * Triggers the mesh to begin fading in or out
  127235. * @param value if the object should fade in or out (true to fade in)
  127236. */
  127237. fadeIn(value: boolean): void;
  127238. private _update;
  127239. private _setAllVisibility;
  127240. }
  127241. }
  127242. declare module BABYLON {
  127243. /**
  127244. * Class containing a set of static utilities functions for managing Pivots
  127245. * @hidden
  127246. */
  127247. export class PivotTools {
  127248. private static _PivotCached;
  127249. private static _OldPivotPoint;
  127250. private static _PivotTranslation;
  127251. private static _PivotTmpVector;
  127252. private static _PivotPostMultiplyPivotMatrix;
  127253. /** @hidden */
  127254. static _RemoveAndStorePivotPoint(mesh: AbstractMesh): void;
  127255. /** @hidden */
  127256. static _RestorePivotPoint(mesh: AbstractMesh): void;
  127257. }
  127258. }
  127259. declare module BABYLON {
  127260. /**
  127261. * Class containing static functions to help procedurally build meshes
  127262. */
  127263. export class PlaneBuilder {
  127264. /**
  127265. * Creates a plane mesh
  127266. * * The parameter `size` sets the size (float) of both sides of the plane at once (default 1)
  127267. * * You can set some different plane dimensions by using the parameters `width` and `height` (both by default have the same value of `size`)
  127268. * * The parameter `sourcePlane` is a Plane instance. It builds a mesh plane from a Math plane
  127269. * * You can also set the mesh side orientation with the values : BABYLON.Mesh.FRONTSIDE (default), BABYLON.Mesh.BACKSIDE or BABYLON.Mesh.DOUBLESIDE
  127270. * * If you create a double-sided mesh, you can choose what parts of the texture image to crop and stick respectively on the front and the back sides with the parameters `frontUVs` and `backUVs` (Vector4). Detail here : https://doc.babylonjs.com/babylon101/discover_basic_elements#side-orientation
  127271. * * The mesh can be set to updatable with the boolean parameter `updatable` (default false) if its internal geometry is supposed to change once created
  127272. * @param name defines the name of the mesh
  127273. * @param options defines the options used to create the mesh
  127274. * @param scene defines the hosting scene
  127275. * @returns the plane mesh
  127276. * @see https://doc.babylonjs.com/how_to/set_shapes#plane
  127277. */
  127278. static CreatePlane(name: string, options: {
  127279. size?: number;
  127280. width?: number;
  127281. height?: number;
  127282. sideOrientation?: number;
  127283. frontUVs?: Vector4;
  127284. backUVs?: Vector4;
  127285. updatable?: boolean;
  127286. sourcePlane?: Plane;
  127287. }, scene?: Nullable<Scene>): Mesh;
  127288. }
  127289. }
  127290. declare module BABYLON {
  127291. /**
  127292. * A behavior that when attached to a mesh will allow the mesh to be dragged around the screen based on pointer events
  127293. */
  127294. export class PointerDragBehavior implements Behavior<AbstractMesh> {
  127295. private static _AnyMouseID;
  127296. /**
  127297. * Abstract mesh the behavior is set on
  127298. */
  127299. attachedNode: AbstractMesh;
  127300. private _dragPlane;
  127301. private _scene;
  127302. private _pointerObserver;
  127303. private _beforeRenderObserver;
  127304. private static _planeScene;
  127305. private _useAlternatePickedPointAboveMaxDragAngleDragSpeed;
  127306. /**
  127307. * 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)
  127308. */
  127309. maxDragAngle: number;
  127310. /**
  127311. * @hidden
  127312. */
  127313. _useAlternatePickedPointAboveMaxDragAngle: boolean;
  127314. /**
  127315. * The id of the pointer that is currently interacting with the behavior (-1 when no pointer is active)
  127316. */
  127317. currentDraggingPointerID: number;
  127318. /**
  127319. * The last position where the pointer hit the drag plane in world space
  127320. */
  127321. lastDragPosition: Vector3;
  127322. /**
  127323. * If the behavior is currently in a dragging state
  127324. */
  127325. dragging: boolean;
  127326. /**
  127327. * 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)
  127328. */
  127329. dragDeltaRatio: number;
  127330. /**
  127331. * If the drag plane orientation should be updated during the dragging (Default: true)
  127332. */
  127333. updateDragPlane: boolean;
  127334. private _debugMode;
  127335. private _moving;
  127336. /**
  127337. * Fires each time the attached mesh is dragged with the pointer
  127338. * * delta between last drag position and current drag position in world space
  127339. * * dragDistance along the drag axis
  127340. * * dragPlaneNormal normal of the current drag plane used during the drag
  127341. * * dragPlanePoint in world space where the drag intersects the drag plane
  127342. */
  127343. onDragObservable: Observable<{
  127344. delta: Vector3;
  127345. dragPlanePoint: Vector3;
  127346. dragPlaneNormal: Vector3;
  127347. dragDistance: number;
  127348. pointerId: number;
  127349. }>;
  127350. /**
  127351. * Fires each time a drag begins (eg. mouse down on mesh)
  127352. */
  127353. onDragStartObservable: Observable<{
  127354. dragPlanePoint: Vector3;
  127355. pointerId: number;
  127356. }>;
  127357. /**
  127358. * Fires each time a drag ends (eg. mouse release after drag)
  127359. */
  127360. onDragEndObservable: Observable<{
  127361. dragPlanePoint: Vector3;
  127362. pointerId: number;
  127363. }>;
  127364. /**
  127365. * If the attached mesh should be moved when dragged
  127366. */
  127367. moveAttached: boolean;
  127368. /**
  127369. * If the drag behavior will react to drag events (Default: true)
  127370. */
  127371. enabled: boolean;
  127372. /**
  127373. * If pointer events should start and release the drag (Default: true)
  127374. */
  127375. startAndReleaseDragOnPointerEvents: boolean;
  127376. /**
  127377. * If camera controls should be detached during the drag
  127378. */
  127379. detachCameraControls: boolean;
  127380. /**
  127381. * If set, the drag plane/axis will be rotated based on the attached mesh's world rotation (Default: true)
  127382. */
  127383. useObjectOrientationForDragging: boolean;
  127384. private _options;
  127385. /**
  127386. * Gets the options used by the behavior
  127387. */
  127388. get options(): {
  127389. dragAxis?: Vector3;
  127390. dragPlaneNormal?: Vector3;
  127391. };
  127392. /**
  127393. * Sets the options used by the behavior
  127394. */
  127395. set options(options: {
  127396. dragAxis?: Vector3;
  127397. dragPlaneNormal?: Vector3;
  127398. });
  127399. /**
  127400. * Creates a pointer drag behavior that can be attached to a mesh
  127401. * @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)
  127402. */
  127403. constructor(options?: {
  127404. dragAxis?: Vector3;
  127405. dragPlaneNormal?: Vector3;
  127406. });
  127407. /**
  127408. * Predicate to determine if it is valid to move the object to a new position when it is moved
  127409. */
  127410. validateDrag: (targetPosition: Vector3) => boolean;
  127411. /**
  127412. * The name of the behavior
  127413. */
  127414. get name(): string;
  127415. /**
  127416. * Initializes the behavior
  127417. */
  127418. init(): void;
  127419. private _tmpVector;
  127420. private _alternatePickedPoint;
  127421. private _worldDragAxis;
  127422. private _targetPosition;
  127423. private _attachedElement;
  127424. /**
  127425. * Attaches the drag behavior the passed in mesh
  127426. * @param ownerNode The mesh that will be dragged around once attached
  127427. * @param predicate Predicate to use for pick filtering
  127428. */
  127429. attach(ownerNode: AbstractMesh, predicate?: (m: AbstractMesh) => boolean): void;
  127430. /**
  127431. * Force relase the drag action by code.
  127432. */
  127433. releaseDrag(): void;
  127434. private _startDragRay;
  127435. private _lastPointerRay;
  127436. /**
  127437. * Simulates the start of a pointer drag event on the behavior
  127438. * @param pointerId pointerID of the pointer that should be simulated (Default: Any mouse pointer ID)
  127439. * @param fromRay initial ray of the pointer to be simulated (Default: Ray from camera to attached mesh)
  127440. * @param startPickedPoint picked point of the pointer to be simulated (Default: attached mesh position)
  127441. */
  127442. startDrag(pointerId?: number, fromRay?: Ray, startPickedPoint?: Vector3): void;
  127443. protected _startDrag(pointerId: number, fromRay?: Ray, startPickedPoint?: Vector3): void;
  127444. private _dragDelta;
  127445. protected _moveDrag(ray: Ray): void;
  127446. private _pickWithRayOnDragPlane;
  127447. private _pointA;
  127448. private _pointC;
  127449. private _localAxis;
  127450. private _lookAt;
  127451. private _updateDragPlanePosition;
  127452. /**
  127453. * Detaches the behavior from the mesh
  127454. */
  127455. detach(): void;
  127456. }
  127457. }
  127458. declare module BABYLON {
  127459. /**
  127460. * A behavior that when attached to a mesh will allow the mesh to be scaled
  127461. */
  127462. export class MultiPointerScaleBehavior implements Behavior<Mesh> {
  127463. private _dragBehaviorA;
  127464. private _dragBehaviorB;
  127465. private _startDistance;
  127466. private _initialScale;
  127467. private _targetScale;
  127468. private _ownerNode;
  127469. private _sceneRenderObserver;
  127470. /**
  127471. * Instantiate a new behavior that when attached to a mesh will allow the mesh to be scaled
  127472. */
  127473. constructor();
  127474. /**
  127475. * The name of the behavior
  127476. */
  127477. get name(): string;
  127478. /**
  127479. * Initializes the behavior
  127480. */
  127481. init(): void;
  127482. private _getCurrentDistance;
  127483. /**
  127484. * Attaches the scale behavior the passed in mesh
  127485. * @param ownerNode The mesh that will be scaled around once attached
  127486. */
  127487. attach(ownerNode: Mesh): void;
  127488. /**
  127489. * Detaches the behavior from the mesh
  127490. */
  127491. detach(): void;
  127492. }
  127493. }
  127494. declare module BABYLON {
  127495. /**
  127496. * 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
  127497. */
  127498. export class SixDofDragBehavior implements Behavior<Mesh> {
  127499. private static _virtualScene;
  127500. private _ownerNode;
  127501. private _sceneRenderObserver;
  127502. private _scene;
  127503. private _targetPosition;
  127504. private _virtualOriginMesh;
  127505. private _virtualDragMesh;
  127506. private _pointerObserver;
  127507. private _moving;
  127508. private _startingOrientation;
  127509. private _attachedElement;
  127510. /**
  127511. * 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)
  127512. */
  127513. private zDragFactor;
  127514. /**
  127515. * If the object should rotate to face the drag origin
  127516. */
  127517. rotateDraggedObject: boolean;
  127518. /**
  127519. * If the behavior is currently in a dragging state
  127520. */
  127521. dragging: boolean;
  127522. /**
  127523. * 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)
  127524. */
  127525. dragDeltaRatio: number;
  127526. /**
  127527. * The id of the pointer that is currently interacting with the behavior (-1 when no pointer is active)
  127528. */
  127529. currentDraggingPointerID: number;
  127530. /**
  127531. * If camera controls should be detached during the drag
  127532. */
  127533. detachCameraControls: boolean;
  127534. /**
  127535. * Fires each time a drag starts
  127536. */
  127537. onDragStartObservable: Observable<{}>;
  127538. /**
  127539. * Fires each time a drag ends (eg. mouse release after drag)
  127540. */
  127541. onDragEndObservable: Observable<{}>;
  127542. /**
  127543. * 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
  127544. */
  127545. constructor();
  127546. /**
  127547. * The name of the behavior
  127548. */
  127549. get name(): string;
  127550. /**
  127551. * Initializes the behavior
  127552. */
  127553. init(): void;
  127554. /**
  127555. * In the case of multiplea active cameras, the cameraToUseForPointers should be used if set instead of active camera
  127556. */
  127557. private get _pointerCamera();
  127558. /**
  127559. * Attaches the scale behavior the passed in mesh
  127560. * @param ownerNode The mesh that will be scaled around once attached
  127561. */
  127562. attach(ownerNode: Mesh): void;
  127563. /**
  127564. * Detaches the behavior from the mesh
  127565. */
  127566. detach(): void;
  127567. }
  127568. }
  127569. declare module BABYLON {
  127570. /**
  127571. * Class used to apply inverse kinematics to bones
  127572. * @see https://doc.babylonjs.com/how_to/how_to_use_bones_and_skeletons#boneikcontroller
  127573. */
  127574. export class BoneIKController {
  127575. private static _tmpVecs;
  127576. private static _tmpQuat;
  127577. private static _tmpMats;
  127578. /**
  127579. * Gets or sets the target mesh
  127580. */
  127581. targetMesh: AbstractMesh;
  127582. /** Gets or sets the mesh used as pole */
  127583. poleTargetMesh: AbstractMesh;
  127584. /**
  127585. * Gets or sets the bone used as pole
  127586. */
  127587. poleTargetBone: Nullable<Bone>;
  127588. /**
  127589. * Gets or sets the target position
  127590. */
  127591. targetPosition: Vector3;
  127592. /**
  127593. * Gets or sets the pole target position
  127594. */
  127595. poleTargetPosition: Vector3;
  127596. /**
  127597. * Gets or sets the pole target local offset
  127598. */
  127599. poleTargetLocalOffset: Vector3;
  127600. /**
  127601. * Gets or sets the pole angle
  127602. */
  127603. poleAngle: number;
  127604. /**
  127605. * Gets or sets the mesh associated with the controller
  127606. */
  127607. mesh: AbstractMesh;
  127608. /**
  127609. * 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)
  127610. */
  127611. slerpAmount: number;
  127612. private _bone1Quat;
  127613. private _bone1Mat;
  127614. private _bone2Ang;
  127615. private _bone1;
  127616. private _bone2;
  127617. private _bone1Length;
  127618. private _bone2Length;
  127619. private _maxAngle;
  127620. private _maxReach;
  127621. private _rightHandedSystem;
  127622. private _bendAxis;
  127623. private _slerping;
  127624. private _adjustRoll;
  127625. /**
  127626. * Gets or sets maximum allowed angle
  127627. */
  127628. get maxAngle(): number;
  127629. set maxAngle(value: number);
  127630. /**
  127631. * Creates a new BoneIKController
  127632. * @param mesh defines the mesh to control
  127633. * @param bone defines the bone to control
  127634. * @param options defines options to set up the controller
  127635. */
  127636. constructor(mesh: AbstractMesh, bone: Bone, options?: {
  127637. targetMesh?: AbstractMesh;
  127638. poleTargetMesh?: AbstractMesh;
  127639. poleTargetBone?: Bone;
  127640. poleTargetLocalOffset?: Vector3;
  127641. poleAngle?: number;
  127642. bendAxis?: Vector3;
  127643. maxAngle?: number;
  127644. slerpAmount?: number;
  127645. });
  127646. private _setMaxAngle;
  127647. /**
  127648. * Force the controller to update the bones
  127649. */
  127650. update(): void;
  127651. }
  127652. }
  127653. declare module BABYLON {
  127654. /**
  127655. * Class used to make a bone look toward a point in space
  127656. * @see https://doc.babylonjs.com/how_to/how_to_use_bones_and_skeletons#bonelookcontroller
  127657. */
  127658. export class BoneLookController {
  127659. private static _tmpVecs;
  127660. private static _tmpQuat;
  127661. private static _tmpMats;
  127662. /**
  127663. * The target Vector3 that the bone will look at
  127664. */
  127665. target: Vector3;
  127666. /**
  127667. * The mesh that the bone is attached to
  127668. */
  127669. mesh: AbstractMesh;
  127670. /**
  127671. * The bone that will be looking to the target
  127672. */
  127673. bone: Bone;
  127674. /**
  127675. * The up axis of the coordinate system that is used when the bone is rotated
  127676. */
  127677. upAxis: Vector3;
  127678. /**
  127679. * The space that the up axis is in - Space.BONE, Space.LOCAL (default), or Space.WORLD
  127680. */
  127681. upAxisSpace: Space;
  127682. /**
  127683. * Used to make an adjustment to the yaw of the bone
  127684. */
  127685. adjustYaw: number;
  127686. /**
  127687. * Used to make an adjustment to the pitch of the bone
  127688. */
  127689. adjustPitch: number;
  127690. /**
  127691. * Used to make an adjustment to the roll of the bone
  127692. */
  127693. adjustRoll: number;
  127694. /**
  127695. * 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)
  127696. */
  127697. slerpAmount: number;
  127698. private _minYaw;
  127699. private _maxYaw;
  127700. private _minPitch;
  127701. private _maxPitch;
  127702. private _minYawSin;
  127703. private _minYawCos;
  127704. private _maxYawSin;
  127705. private _maxYawCos;
  127706. private _midYawConstraint;
  127707. private _minPitchTan;
  127708. private _maxPitchTan;
  127709. private _boneQuat;
  127710. private _slerping;
  127711. private _transformYawPitch;
  127712. private _transformYawPitchInv;
  127713. private _firstFrameSkipped;
  127714. private _yawRange;
  127715. private _fowardAxis;
  127716. /**
  127717. * Gets or sets the minimum yaw angle that the bone can look to
  127718. */
  127719. get minYaw(): number;
  127720. set minYaw(value: number);
  127721. /**
  127722. * Gets or sets the maximum yaw angle that the bone can look to
  127723. */
  127724. get maxYaw(): number;
  127725. set maxYaw(value: number);
  127726. /**
  127727. * Gets or sets the minimum pitch angle that the bone can look to
  127728. */
  127729. get minPitch(): number;
  127730. set minPitch(value: number);
  127731. /**
  127732. * Gets or sets the maximum pitch angle that the bone can look to
  127733. */
  127734. get maxPitch(): number;
  127735. set maxPitch(value: number);
  127736. /**
  127737. * Create a BoneLookController
  127738. * @param mesh the mesh that the bone belongs to
  127739. * @param bone the bone that will be looking to the target
  127740. * @param target the target Vector3 to look at
  127741. * @param options optional settings:
  127742. * * maxYaw: the maximum angle the bone will yaw to
  127743. * * minYaw: the minimum angle the bone will yaw to
  127744. * * maxPitch: the maximum angle the bone will pitch to
  127745. * * minPitch: the minimum angle the bone will yaw to
  127746. * * slerpAmount: set the between 0 and 1 to make the bone slerp to the target.
  127747. * * upAxis: the up axis of the coordinate system
  127748. * * upAxisSpace: the space that the up axis is in - Space.BONE, Space.LOCAL (default), or Space.WORLD.
  127749. * * yawAxis: set yawAxis if the bone does not yaw on the y axis
  127750. * * pitchAxis: set pitchAxis if the bone does not pitch on the x axis
  127751. * * adjustYaw: used to make an adjustment to the yaw of the bone
  127752. * * adjustPitch: used to make an adjustment to the pitch of the bone
  127753. * * adjustRoll: used to make an adjustment to the roll of the bone
  127754. **/
  127755. constructor(mesh: AbstractMesh, bone: Bone, target: Vector3, options?: {
  127756. maxYaw?: number;
  127757. minYaw?: number;
  127758. maxPitch?: number;
  127759. minPitch?: number;
  127760. slerpAmount?: number;
  127761. upAxis?: Vector3;
  127762. upAxisSpace?: Space;
  127763. yawAxis?: Vector3;
  127764. pitchAxis?: Vector3;
  127765. adjustYaw?: number;
  127766. adjustPitch?: number;
  127767. adjustRoll?: number;
  127768. });
  127769. /**
  127770. * Update the bone to look at the target. This should be called before the scene is rendered (use scene.registerBeforeRender())
  127771. */
  127772. update(): void;
  127773. private _getAngleDiff;
  127774. private _getAngleBetween;
  127775. private _isAngleBetween;
  127776. }
  127777. }
  127778. declare module BABYLON {
  127779. /**
  127780. * Manage the gamepad inputs to control an arc rotate camera.
  127781. * @see https://doc.babylonjs.com/how_to/customizing_camera_inputs
  127782. */
  127783. export class ArcRotateCameraGamepadInput implements ICameraInput<ArcRotateCamera> {
  127784. /**
  127785. * Defines the camera the input is attached to.
  127786. */
  127787. camera: ArcRotateCamera;
  127788. /**
  127789. * Defines the gamepad the input is gathering event from.
  127790. */
  127791. gamepad: Nullable<Gamepad>;
  127792. /**
  127793. * Defines the gamepad rotation sensiblity.
  127794. * This is the threshold from when rotation starts to be accounted for to prevent jittering.
  127795. */
  127796. gamepadRotationSensibility: number;
  127797. /**
  127798. * Defines the gamepad move sensiblity.
  127799. * This is the threshold from when moving starts to be accounted for for to prevent jittering.
  127800. */
  127801. gamepadMoveSensibility: number;
  127802. private _yAxisScale;
  127803. /**
  127804. * Gets or sets a boolean indicating that Yaxis (for right stick) should be inverted
  127805. */
  127806. get invertYAxis(): boolean;
  127807. set invertYAxis(value: boolean);
  127808. private _onGamepadConnectedObserver;
  127809. private _onGamepadDisconnectedObserver;
  127810. /**
  127811. * Attach the input controls to a specific dom element to get the input from.
  127812. * @param element Defines the element the controls should be listened from
  127813. * @param noPreventDefault Defines whether event caught by the controls should call preventdefault() (https://developer.mozilla.org/en-US/docs/Web/API/Event/preventDefault)
  127814. */
  127815. attachControl(element: HTMLElement, noPreventDefault?: boolean): void;
  127816. /**
  127817. * Detach the current controls from the specified dom element.
  127818. * @param element Defines the element to stop listening the inputs from
  127819. */
  127820. detachControl(element: Nullable<HTMLElement>): void;
  127821. /**
  127822. * Update the current camera state depending on the inputs that have been used this frame.
  127823. * This is a dynamically created lambda to avoid the performance penalty of looping for inputs in the render loop.
  127824. */
  127825. checkInputs(): void;
  127826. /**
  127827. * Gets the class name of the current intput.
  127828. * @returns the class name
  127829. */
  127830. getClassName(): string;
  127831. /**
  127832. * Get the friendly name associated with the input class.
  127833. * @returns the input friendly name
  127834. */
  127835. getSimpleName(): string;
  127836. }
  127837. }
  127838. declare module BABYLON {
  127839. interface ArcRotateCameraInputsManager {
  127840. /**
  127841. * Add orientation input support to the input manager.
  127842. * @returns the current input manager
  127843. */
  127844. addVRDeviceOrientation(): ArcRotateCameraInputsManager;
  127845. }
  127846. /**
  127847. * Manage the device orientation inputs (gyroscope) to control an arc rotate camera.
  127848. * @see https://doc.babylonjs.com/how_to/customizing_camera_inputs
  127849. */
  127850. export class ArcRotateCameraVRDeviceOrientationInput implements ICameraInput<ArcRotateCamera> {
  127851. /**
  127852. * Defines the camera the input is attached to.
  127853. */
  127854. camera: ArcRotateCamera;
  127855. /**
  127856. * Defines a correction factor applied on the alpha value retrieved from the orientation events.
  127857. */
  127858. alphaCorrection: number;
  127859. /**
  127860. * Defines a correction factor applied on the gamma value retrieved from the orientation events.
  127861. */
  127862. gammaCorrection: number;
  127863. private _alpha;
  127864. private _gamma;
  127865. private _dirty;
  127866. private _deviceOrientationHandler;
  127867. /**
  127868. * Instantiate a new ArcRotateCameraVRDeviceOrientationInput.
  127869. */
  127870. constructor();
  127871. /**
  127872. * Attach the input controls to a specific dom element to get the input from.
  127873. * @param element Defines the element the controls should be listened from
  127874. * @param noPreventDefault Defines whether event caught by the controls should call preventdefault() (https://developer.mozilla.org/en-US/docs/Web/API/Event/preventDefault)
  127875. */
  127876. attachControl(element: HTMLElement, noPreventDefault?: boolean): void;
  127877. /** @hidden */
  127878. _onOrientationEvent(evt: DeviceOrientationEvent): void;
  127879. /**
  127880. * Update the current camera state depending on the inputs that have been used this frame.
  127881. * This is a dynamically created lambda to avoid the performance penalty of looping for inputs in the render loop.
  127882. */
  127883. checkInputs(): void;
  127884. /**
  127885. * Detach the current controls from the specified dom element.
  127886. * @param element Defines the element to stop listening the inputs from
  127887. */
  127888. detachControl(element: Nullable<HTMLElement>): void;
  127889. /**
  127890. * Gets the class name of the current intput.
  127891. * @returns the class name
  127892. */
  127893. getClassName(): string;
  127894. /**
  127895. * Get the friendly name associated with the input class.
  127896. * @returns the input friendly name
  127897. */
  127898. getSimpleName(): string;
  127899. }
  127900. }
  127901. declare module BABYLON {
  127902. /**
  127903. * Listen to mouse events to control the camera.
  127904. * @see https://doc.babylonjs.com/how_to/customizing_camera_inputs
  127905. */
  127906. export class FlyCameraMouseInput implements ICameraInput<FlyCamera> {
  127907. /**
  127908. * Defines the camera the input is attached to.
  127909. */
  127910. camera: FlyCamera;
  127911. /**
  127912. * Defines if touch is enabled. (Default is true.)
  127913. */
  127914. touchEnabled: boolean;
  127915. /**
  127916. * Defines the buttons associated with the input to handle camera rotation.
  127917. */
  127918. buttons: number[];
  127919. /**
  127920. * Assign buttons for Yaw control.
  127921. */
  127922. buttonsYaw: number[];
  127923. /**
  127924. * Assign buttons for Pitch control.
  127925. */
  127926. buttonsPitch: number[];
  127927. /**
  127928. * Assign buttons for Roll control.
  127929. */
  127930. buttonsRoll: number[];
  127931. /**
  127932. * Detect if any button is being pressed while mouse is moved.
  127933. * -1 = Mouse locked.
  127934. * 0 = Left button.
  127935. * 1 = Middle Button.
  127936. * 2 = Right Button.
  127937. */
  127938. activeButton: number;
  127939. /**
  127940. * Defines the pointer's angular sensibility, to control the camera rotation speed.
  127941. * Higher values reduce its sensitivity.
  127942. */
  127943. angularSensibility: number;
  127944. private _observer;
  127945. private _rollObserver;
  127946. private previousPosition;
  127947. private noPreventDefault;
  127948. private element;
  127949. /**
  127950. * Listen to mouse events to control the camera.
  127951. * @param touchEnabled Define if touch is enabled. (Default is true.)
  127952. * @see https://doc.babylonjs.com/how_to/customizing_camera_inputs
  127953. */
  127954. constructor(touchEnabled?: boolean);
  127955. /**
  127956. * Attach the mouse control to the HTML DOM element.
  127957. * @param element Defines the element that listens to the input events.
  127958. * @param noPreventDefault Defines whether events caught by the controls should call preventdefault().
  127959. */
  127960. attachControl(element: HTMLElement, noPreventDefault?: boolean): void;
  127961. /**
  127962. * Detach the current controls from the specified dom element.
  127963. * @param element Defines the element to stop listening the inputs from
  127964. */
  127965. detachControl(element: Nullable<HTMLElement>): void;
  127966. /**
  127967. * Gets the class name of the current input.
  127968. * @returns the class name.
  127969. */
  127970. getClassName(): string;
  127971. /**
  127972. * Get the friendly name associated with the input class.
  127973. * @returns the input's friendly name.
  127974. */
  127975. getSimpleName(): string;
  127976. private _pointerInput;
  127977. private _onMouseMove;
  127978. /**
  127979. * Rotate camera by mouse offset.
  127980. */
  127981. private rotateCamera;
  127982. }
  127983. }
  127984. declare module BABYLON {
  127985. /**
  127986. * Default Inputs manager for the FlyCamera.
  127987. * It groups all the default supported inputs for ease of use.
  127988. * @see https://doc.babylonjs.com/how_to/customizing_camera_inputs
  127989. */
  127990. export class FlyCameraInputsManager extends CameraInputsManager<FlyCamera> {
  127991. /**
  127992. * Instantiates a new FlyCameraInputsManager.
  127993. * @param camera Defines the camera the inputs belong to.
  127994. */
  127995. constructor(camera: FlyCamera);
  127996. /**
  127997. * Add keyboard input support to the input manager.
  127998. * @returns the new FlyCameraKeyboardMoveInput().
  127999. */
  128000. addKeyboard(): FlyCameraInputsManager;
  128001. /**
  128002. * Add mouse input support to the input manager.
  128003. * @param touchEnabled Enable touch screen support.
  128004. * @returns the new FlyCameraMouseInput().
  128005. */
  128006. addMouse(touchEnabled?: boolean): FlyCameraInputsManager;
  128007. }
  128008. }
  128009. declare module BABYLON {
  128010. /**
  128011. * This is a flying camera, designed for 3D movement and rotation in all directions,
  128012. * such as in a 3D Space Shooter or a Flight Simulator.
  128013. */
  128014. export class FlyCamera extends TargetCamera {
  128015. /**
  128016. * Define the collision ellipsoid of the camera.
  128017. * This is helpful for simulating a camera body, like a player's body.
  128018. * @see https://doc.babylonjs.com/babylon101/cameras,_mesh_collisions_and_gravity#arcrotatecamera
  128019. */
  128020. ellipsoid: Vector3;
  128021. /**
  128022. * Define an offset for the position of the ellipsoid around the camera.
  128023. * This can be helpful if the camera is attached away from the player's body center,
  128024. * such as at its head.
  128025. */
  128026. ellipsoidOffset: Vector3;
  128027. /**
  128028. * Enable or disable collisions of the camera with the rest of the scene objects.
  128029. */
  128030. checkCollisions: boolean;
  128031. /**
  128032. * Enable or disable gravity on the camera.
  128033. */
  128034. applyGravity: boolean;
  128035. /**
  128036. * Define the current direction the camera is moving to.
  128037. */
  128038. cameraDirection: Vector3;
  128039. /**
  128040. * Define the current local rotation of the camera as a quaternion to prevent Gimbal lock.
  128041. * This overrides and empties cameraRotation.
  128042. */
  128043. rotationQuaternion: Quaternion;
  128044. /**
  128045. * Track Roll to maintain the wanted Rolling when looking around.
  128046. */
  128047. _trackRoll: number;
  128048. /**
  128049. * Slowly correct the Roll to its original value after a Pitch+Yaw rotation.
  128050. */
  128051. rollCorrect: number;
  128052. /**
  128053. * Mimic a banked turn, Rolling the camera when Yawing.
  128054. * It's recommended to use rollCorrect = 10 for faster banking correction.
  128055. */
  128056. bankedTurn: boolean;
  128057. /**
  128058. * Limit in radians for how much Roll banking will add. (Default: 90°)
  128059. */
  128060. bankedTurnLimit: number;
  128061. /**
  128062. * Value of 0 disables the banked Roll.
  128063. * Value of 1 is equal to the Yaw angle in radians.
  128064. */
  128065. bankedTurnMultiplier: number;
  128066. /**
  128067. * The inputs manager loads all the input sources, such as keyboard and mouse.
  128068. */
  128069. inputs: FlyCameraInputsManager;
  128070. /**
  128071. * Gets the input sensibility for mouse input.
  128072. * Higher values reduce sensitivity.
  128073. */
  128074. get angularSensibility(): number;
  128075. /**
  128076. * Sets the input sensibility for a mouse input.
  128077. * Higher values reduce sensitivity.
  128078. */
  128079. set angularSensibility(value: number);
  128080. /**
  128081. * Get the keys for camera movement forward.
  128082. */
  128083. get keysForward(): number[];
  128084. /**
  128085. * Set the keys for camera movement forward.
  128086. */
  128087. set keysForward(value: number[]);
  128088. /**
  128089. * Get the keys for camera movement backward.
  128090. */
  128091. get keysBackward(): number[];
  128092. set keysBackward(value: number[]);
  128093. /**
  128094. * Get the keys for camera movement up.
  128095. */
  128096. get keysUp(): number[];
  128097. /**
  128098. * Set the keys for camera movement up.
  128099. */
  128100. set keysUp(value: number[]);
  128101. /**
  128102. * Get the keys for camera movement down.
  128103. */
  128104. get keysDown(): number[];
  128105. /**
  128106. * Set the keys for camera movement down.
  128107. */
  128108. set keysDown(value: number[]);
  128109. /**
  128110. * Get the keys for camera movement left.
  128111. */
  128112. get keysLeft(): number[];
  128113. /**
  128114. * Set the keys for camera movement left.
  128115. */
  128116. set keysLeft(value: number[]);
  128117. /**
  128118. * Set the keys for camera movement right.
  128119. */
  128120. get keysRight(): number[];
  128121. /**
  128122. * Set the keys for camera movement right.
  128123. */
  128124. set keysRight(value: number[]);
  128125. /**
  128126. * Event raised when the camera collides with a mesh in the scene.
  128127. */
  128128. onCollide: (collidedMesh: AbstractMesh) => void;
  128129. private _collider;
  128130. private _needMoveForGravity;
  128131. private _oldPosition;
  128132. private _diffPosition;
  128133. private _newPosition;
  128134. /** @hidden */
  128135. _localDirection: Vector3;
  128136. /** @hidden */
  128137. _transformedDirection: Vector3;
  128138. /**
  128139. * Instantiates a FlyCamera.
  128140. * This is a flying camera, designed for 3D movement and rotation in all directions,
  128141. * such as in a 3D Space Shooter or a Flight Simulator.
  128142. * @param name Define the name of the camera in the scene.
  128143. * @param position Define the starting position of the camera in the scene.
  128144. * @param scene Define the scene the camera belongs to.
  128145. * @param setActiveOnSceneIfNoneActive Defines wheter the camera should be marked as active, if no other camera has been defined as active.
  128146. */
  128147. constructor(name: string, position: Vector3, scene: Scene, setActiveOnSceneIfNoneActive?: boolean);
  128148. /**
  128149. * Attach a control to the HTML DOM element.
  128150. * @param element Defines the element that listens to the input events.
  128151. * @param noPreventDefault Defines whether events caught by the controls should call preventdefault(). https://developer.mozilla.org/en-US/docs/Web/API/Event/preventDefault
  128152. */
  128153. attachControl(element: HTMLElement, noPreventDefault?: boolean): void;
  128154. /**
  128155. * Detach a control from the HTML DOM element.
  128156. * The camera will stop reacting to that input.
  128157. * @param element Defines the element that listens to the input events.
  128158. */
  128159. detachControl(element: HTMLElement): void;
  128160. private _collisionMask;
  128161. /**
  128162. * Get the mask that the camera ignores in collision events.
  128163. */
  128164. get collisionMask(): number;
  128165. /**
  128166. * Set the mask that the camera ignores in collision events.
  128167. */
  128168. set collisionMask(mask: number);
  128169. /** @hidden */
  128170. _collideWithWorld(displacement: Vector3): void;
  128171. /** @hidden */
  128172. private _onCollisionPositionChange;
  128173. /** @hidden */
  128174. _checkInputs(): void;
  128175. /** @hidden */
  128176. _decideIfNeedsToMove(): boolean;
  128177. /** @hidden */
  128178. _updatePosition(): void;
  128179. /**
  128180. * Restore the Roll to its target value at the rate specified.
  128181. * @param rate - Higher means slower restoring.
  128182. * @hidden
  128183. */
  128184. restoreRoll(rate: number): void;
  128185. /**
  128186. * Destroy the camera and release the current resources held by it.
  128187. */
  128188. dispose(): void;
  128189. /**
  128190. * Get the current object class name.
  128191. * @returns the class name.
  128192. */
  128193. getClassName(): string;
  128194. }
  128195. }
  128196. declare module BABYLON {
  128197. /**
  128198. * Listen to keyboard events to control the camera.
  128199. * @see https://doc.babylonjs.com/how_to/customizing_camera_inputs
  128200. */
  128201. export class FlyCameraKeyboardInput implements ICameraInput<FlyCamera> {
  128202. /**
  128203. * Defines the camera the input is attached to.
  128204. */
  128205. camera: FlyCamera;
  128206. /**
  128207. * The list of keyboard keys used to control the forward move of the camera.
  128208. */
  128209. keysForward: number[];
  128210. /**
  128211. * The list of keyboard keys used to control the backward move of the camera.
  128212. */
  128213. keysBackward: number[];
  128214. /**
  128215. * The list of keyboard keys used to control the forward move of the camera.
  128216. */
  128217. keysUp: number[];
  128218. /**
  128219. * The list of keyboard keys used to control the backward move of the camera.
  128220. */
  128221. keysDown: number[];
  128222. /**
  128223. * The list of keyboard keys used to control the right strafe move of the camera.
  128224. */
  128225. keysRight: number[];
  128226. /**
  128227. * The list of keyboard keys used to control the left strafe move of the camera.
  128228. */
  128229. keysLeft: number[];
  128230. private _keys;
  128231. private _onCanvasBlurObserver;
  128232. private _onKeyboardObserver;
  128233. private _engine;
  128234. private _scene;
  128235. /**
  128236. * Attach the input controls to a specific dom element to get the input from.
  128237. * @param element Defines the element the controls should be listened from
  128238. * @param noPreventDefault Defines whether event caught by the controls should call preventdefault() (https://developer.mozilla.org/en-US/docs/Web/API/Event/preventDefault)
  128239. */
  128240. attachControl(element: HTMLElement, noPreventDefault?: boolean): void;
  128241. /**
  128242. * Detach the current controls from the specified dom element.
  128243. * @param element Defines the element to stop listening the inputs from
  128244. */
  128245. detachControl(element: Nullable<HTMLElement>): void;
  128246. /**
  128247. * Gets the class name of the current intput.
  128248. * @returns the class name
  128249. */
  128250. getClassName(): string;
  128251. /** @hidden */
  128252. _onLostFocus(e: FocusEvent): void;
  128253. /**
  128254. * Get the friendly name associated with the input class.
  128255. * @returns the input friendly name
  128256. */
  128257. getSimpleName(): string;
  128258. /**
  128259. * Update the current camera state depending on the inputs that have been used this frame.
  128260. * This is a dynamically created lambda to avoid the performance penalty of looping for inputs in the render loop.
  128261. */
  128262. checkInputs(): void;
  128263. }
  128264. }
  128265. declare module BABYLON {
  128266. /**
  128267. * Manage the mouse wheel inputs to control a follow camera.
  128268. * @see https://doc.babylonjs.com/how_to/customizing_camera_inputs
  128269. */
  128270. export class FollowCameraMouseWheelInput implements ICameraInput<FollowCamera> {
  128271. /**
  128272. * Defines the camera the input is attached to.
  128273. */
  128274. camera: FollowCamera;
  128275. /**
  128276. * Moue wheel controls zoom. (Mouse wheel modifies camera.radius value.)
  128277. */
  128278. axisControlRadius: boolean;
  128279. /**
  128280. * Moue wheel controls height. (Mouse wheel modifies camera.heightOffset value.)
  128281. */
  128282. axisControlHeight: boolean;
  128283. /**
  128284. * Moue wheel controls angle. (Mouse wheel modifies camera.rotationOffset value.)
  128285. */
  128286. axisControlRotation: boolean;
  128287. /**
  128288. * Gets or Set the mouse wheel precision or how fast is the camera moves in
  128289. * relation to mouseWheel events.
  128290. */
  128291. wheelPrecision: number;
  128292. /**
  128293. * wheelDeltaPercentage will be used instead of wheelPrecision if different from 0.
  128294. * It defines the percentage of current camera.radius to use as delta when wheel is used.
  128295. */
  128296. wheelDeltaPercentage: number;
  128297. private _wheel;
  128298. private _observer;
  128299. /**
  128300. * Attach the input controls to a specific dom element to get the input from.
  128301. * @param element Defines the element the controls should be listened from
  128302. * @param noPreventDefault Defines whether event caught by the controls should call preventdefault() (https://developer.mozilla.org/en-US/docs/Web/API/Event/preventDefault)
  128303. */
  128304. attachControl(element: HTMLElement, noPreventDefault?: boolean): void;
  128305. /**
  128306. * Detach the current controls from the specified dom element.
  128307. * @param element Defines the element to stop listening the inputs from
  128308. */
  128309. detachControl(element: Nullable<HTMLElement>): void;
  128310. /**
  128311. * Gets the class name of the current intput.
  128312. * @returns the class name
  128313. */
  128314. getClassName(): string;
  128315. /**
  128316. * Get the friendly name associated with the input class.
  128317. * @returns the input friendly name
  128318. */
  128319. getSimpleName(): string;
  128320. }
  128321. }
  128322. declare module BABYLON {
  128323. /**
  128324. * Manage the pointers inputs to control an follow camera.
  128325. * @see https://doc.babylonjs.com/how_to/customizing_camera_inputs
  128326. */
  128327. export class FollowCameraPointersInput extends BaseCameraPointersInput {
  128328. /**
  128329. * Defines the camera the input is attached to.
  128330. */
  128331. camera: FollowCamera;
  128332. /**
  128333. * Gets the class name of the current input.
  128334. * @returns the class name
  128335. */
  128336. getClassName(): string;
  128337. /**
  128338. * Defines the pointer angular sensibility along the X axis or how fast is
  128339. * the camera rotating.
  128340. * A negative number will reverse the axis direction.
  128341. */
  128342. angularSensibilityX: number;
  128343. /**
  128344. * Defines the pointer angular sensibility along the Y axis or how fast is
  128345. * the camera rotating.
  128346. * A negative number will reverse the axis direction.
  128347. */
  128348. angularSensibilityY: number;
  128349. /**
  128350. * Defines the pointer pinch precision or how fast is the camera zooming.
  128351. * A negative number will reverse the axis direction.
  128352. */
  128353. pinchPrecision: number;
  128354. /**
  128355. * pinchDeltaPercentage will be used instead of pinchPrecision if different
  128356. * from 0.
  128357. * It defines the percentage of current camera.radius to use as delta when
  128358. * pinch zoom is used.
  128359. */
  128360. pinchDeltaPercentage: number;
  128361. /**
  128362. * Pointer X axis controls zoom. (X axis modifies camera.radius value.)
  128363. */
  128364. axisXControlRadius: boolean;
  128365. /**
  128366. * Pointer X axis controls height. (X axis modifies camera.heightOffset value.)
  128367. */
  128368. axisXControlHeight: boolean;
  128369. /**
  128370. * Pointer X axis controls angle. (X axis modifies camera.rotationOffset value.)
  128371. */
  128372. axisXControlRotation: boolean;
  128373. /**
  128374. * Pointer Y axis controls zoom. (Y axis modifies camera.radius value.)
  128375. */
  128376. axisYControlRadius: boolean;
  128377. /**
  128378. * Pointer Y axis controls height. (Y axis modifies camera.heightOffset value.)
  128379. */
  128380. axisYControlHeight: boolean;
  128381. /**
  128382. * Pointer Y axis controls angle. (Y axis modifies camera.rotationOffset value.)
  128383. */
  128384. axisYControlRotation: boolean;
  128385. /**
  128386. * Pinch controls zoom. (Pinch modifies camera.radius value.)
  128387. */
  128388. axisPinchControlRadius: boolean;
  128389. /**
  128390. * Pinch controls height. (Pinch modifies camera.heightOffset value.)
  128391. */
  128392. axisPinchControlHeight: boolean;
  128393. /**
  128394. * Pinch controls angle. (Pinch modifies camera.rotationOffset value.)
  128395. */
  128396. axisPinchControlRotation: boolean;
  128397. /**
  128398. * Log error messages if basic misconfiguration has occurred.
  128399. */
  128400. warningEnable: boolean;
  128401. protected onTouch(pointA: Nullable<PointerTouch>, offsetX: number, offsetY: number): void;
  128402. protected onMultiTouch(pointA: Nullable<PointerTouch>, pointB: Nullable<PointerTouch>, previousPinchSquaredDistance: number, pinchSquaredDistance: number, previousMultiTouchPanPosition: Nullable<PointerTouch>, multiTouchPanPosition: Nullable<PointerTouch>): void;
  128403. private _warningCounter;
  128404. private _warning;
  128405. }
  128406. }
  128407. declare module BABYLON {
  128408. /**
  128409. * Default Inputs manager for the FollowCamera.
  128410. * It groups all the default supported inputs for ease of use.
  128411. * @see https://doc.babylonjs.com/how_to/customizing_camera_inputs
  128412. */
  128413. export class FollowCameraInputsManager extends CameraInputsManager<FollowCamera> {
  128414. /**
  128415. * Instantiates a new FollowCameraInputsManager.
  128416. * @param camera Defines the camera the inputs belong to
  128417. */
  128418. constructor(camera: FollowCamera);
  128419. /**
  128420. * Add keyboard input support to the input manager.
  128421. * @returns the current input manager
  128422. */
  128423. addKeyboard(): FollowCameraInputsManager;
  128424. /**
  128425. * Add mouse wheel input support to the input manager.
  128426. * @returns the current input manager
  128427. */
  128428. addMouseWheel(): FollowCameraInputsManager;
  128429. /**
  128430. * Add pointers input support to the input manager.
  128431. * @returns the current input manager
  128432. */
  128433. addPointers(): FollowCameraInputsManager;
  128434. /**
  128435. * Add orientation input support to the input manager.
  128436. * @returns the current input manager
  128437. */
  128438. addVRDeviceOrientation(): FollowCameraInputsManager;
  128439. }
  128440. }
  128441. declare module BABYLON {
  128442. /**
  128443. * A follow camera takes a mesh as a target and follows it as it moves. Both a free camera version followCamera and
  128444. * an arc rotate version arcFollowCamera are available.
  128445. * @see https://doc.babylonjs.com/features/cameras#follow-camera
  128446. */
  128447. export class FollowCamera extends TargetCamera {
  128448. /**
  128449. * Distance the follow camera should follow an object at
  128450. */
  128451. radius: number;
  128452. /**
  128453. * Minimum allowed distance of the camera to the axis of rotation
  128454. * (The camera can not get closer).
  128455. * This can help limiting how the Camera is able to move in the scene.
  128456. */
  128457. lowerRadiusLimit: Nullable<number>;
  128458. /**
  128459. * Maximum allowed distance of the camera to the axis of rotation
  128460. * (The camera can not get further).
  128461. * This can help limiting how the Camera is able to move in the scene.
  128462. */
  128463. upperRadiusLimit: Nullable<number>;
  128464. /**
  128465. * Define a rotation offset between the camera and the object it follows
  128466. */
  128467. rotationOffset: number;
  128468. /**
  128469. * Minimum allowed angle to camera position relative to target object.
  128470. * This can help limiting how the Camera is able to move in the scene.
  128471. */
  128472. lowerRotationOffsetLimit: Nullable<number>;
  128473. /**
  128474. * Maximum allowed angle to camera position relative to target object.
  128475. * This can help limiting how the Camera is able to move in the scene.
  128476. */
  128477. upperRotationOffsetLimit: Nullable<number>;
  128478. /**
  128479. * Define a height offset between the camera and the object it follows.
  128480. * It can help following an object from the top (like a car chaing a plane)
  128481. */
  128482. heightOffset: number;
  128483. /**
  128484. * Minimum allowed height of camera position relative to target object.
  128485. * This can help limiting how the Camera is able to move in the scene.
  128486. */
  128487. lowerHeightOffsetLimit: Nullable<number>;
  128488. /**
  128489. * Maximum allowed height of camera position relative to target object.
  128490. * This can help limiting how the Camera is able to move in the scene.
  128491. */
  128492. upperHeightOffsetLimit: Nullable<number>;
  128493. /**
  128494. * Define how fast the camera can accelerate to follow it s target.
  128495. */
  128496. cameraAcceleration: number;
  128497. /**
  128498. * Define the speed limit of the camera following an object.
  128499. */
  128500. maxCameraSpeed: number;
  128501. /**
  128502. * Define the target of the camera.
  128503. */
  128504. lockedTarget: Nullable<AbstractMesh>;
  128505. /**
  128506. * Defines the input associated with the camera.
  128507. */
  128508. inputs: FollowCameraInputsManager;
  128509. /**
  128510. * Instantiates the follow camera.
  128511. * @see https://doc.babylonjs.com/features/cameras#follow-camera
  128512. * @param name Define the name of the camera in the scene
  128513. * @param position Define the position of the camera
  128514. * @param scene Define the scene the camera belong to
  128515. * @param lockedTarget Define the target of the camera
  128516. */
  128517. constructor(name: string, position: Vector3, scene: Scene, lockedTarget?: Nullable<AbstractMesh>);
  128518. private _follow;
  128519. /**
  128520. * Attached controls to the current camera.
  128521. * @param element Defines the element the controls should be listened from
  128522. * @param noPreventDefault Defines whether event caught by the controls should call preventdefault() (https://developer.mozilla.org/en-US/docs/Web/API/Event/preventDefault)
  128523. */
  128524. attachControl(element: HTMLElement, noPreventDefault?: boolean): void;
  128525. /**
  128526. * Detach the current controls from the camera.
  128527. * The camera will stop reacting to inputs.
  128528. * @param element Defines the element to stop listening the inputs from
  128529. */
  128530. detachControl(element: HTMLElement): void;
  128531. /** @hidden */
  128532. _checkInputs(): void;
  128533. private _checkLimits;
  128534. /**
  128535. * Gets the camera class name.
  128536. * @returns the class name
  128537. */
  128538. getClassName(): string;
  128539. }
  128540. /**
  128541. * Arc Rotate version of the follow camera.
  128542. * It still follows a Defined mesh but in an Arc Rotate Camera fashion.
  128543. * @see https://doc.babylonjs.com/features/cameras#follow-camera
  128544. */
  128545. export class ArcFollowCamera extends TargetCamera {
  128546. /** The longitudinal angle of the camera */
  128547. alpha: number;
  128548. /** The latitudinal angle of the camera */
  128549. beta: number;
  128550. /** The radius of the camera from its target */
  128551. radius: number;
  128552. private _cartesianCoordinates;
  128553. /** Define the camera target (the mesh it should follow) */
  128554. private _meshTarget;
  128555. /**
  128556. * Instantiates a new ArcFollowCamera
  128557. * @see https://doc.babylonjs.com/features/cameras#follow-camera
  128558. * @param name Define the name of the camera
  128559. * @param alpha Define the rotation angle of the camera around the logitudinal axis
  128560. * @param beta Define the rotation angle of the camera around the elevation axis
  128561. * @param radius Define the radius of the camera from its target point
  128562. * @param target Define the target of the camera
  128563. * @param scene Define the scene the camera belongs to
  128564. */
  128565. constructor(name: string,
  128566. /** The longitudinal angle of the camera */
  128567. alpha: number,
  128568. /** The latitudinal angle of the camera */
  128569. beta: number,
  128570. /** The radius of the camera from its target */
  128571. radius: number,
  128572. /** Define the camera target (the mesh it should follow) */
  128573. target: Nullable<AbstractMesh>, scene: Scene);
  128574. private _follow;
  128575. /** @hidden */
  128576. _checkInputs(): void;
  128577. /**
  128578. * Returns the class name of the object.
  128579. * It is mostly used internally for serialization purposes.
  128580. */
  128581. getClassName(): string;
  128582. }
  128583. }
  128584. declare module BABYLON {
  128585. /**
  128586. * Manage the keyboard inputs to control the movement of a follow camera.
  128587. * @see https://doc.babylonjs.com/how_to/customizing_camera_inputs
  128588. */
  128589. export class FollowCameraKeyboardMoveInput implements ICameraInput<FollowCamera> {
  128590. /**
  128591. * Defines the camera the input is attached to.
  128592. */
  128593. camera: FollowCamera;
  128594. /**
  128595. * Defines the list of key codes associated with the up action (increase heightOffset)
  128596. */
  128597. keysHeightOffsetIncr: number[];
  128598. /**
  128599. * Defines the list of key codes associated with the down action (decrease heightOffset)
  128600. */
  128601. keysHeightOffsetDecr: number[];
  128602. /**
  128603. * Defines whether the Alt modifier key is required to move up/down (alter heightOffset)
  128604. */
  128605. keysHeightOffsetModifierAlt: boolean;
  128606. /**
  128607. * Defines whether the Ctrl modifier key is required to move up/down (alter heightOffset)
  128608. */
  128609. keysHeightOffsetModifierCtrl: boolean;
  128610. /**
  128611. * Defines whether the Shift modifier key is required to move up/down (alter heightOffset)
  128612. */
  128613. keysHeightOffsetModifierShift: boolean;
  128614. /**
  128615. * Defines the list of key codes associated with the left action (increase rotationOffset)
  128616. */
  128617. keysRotationOffsetIncr: number[];
  128618. /**
  128619. * Defines the list of key codes associated with the right action (decrease rotationOffset)
  128620. */
  128621. keysRotationOffsetDecr: number[];
  128622. /**
  128623. * Defines whether the Alt modifier key is required to move left/right (alter rotationOffset)
  128624. */
  128625. keysRotationOffsetModifierAlt: boolean;
  128626. /**
  128627. * Defines whether the Ctrl modifier key is required to move left/right (alter rotationOffset)
  128628. */
  128629. keysRotationOffsetModifierCtrl: boolean;
  128630. /**
  128631. * Defines whether the Shift modifier key is required to move left/right (alter rotationOffset)
  128632. */
  128633. keysRotationOffsetModifierShift: boolean;
  128634. /**
  128635. * Defines the list of key codes associated with the zoom-in action (decrease radius)
  128636. */
  128637. keysRadiusIncr: number[];
  128638. /**
  128639. * Defines the list of key codes associated with the zoom-out action (increase radius)
  128640. */
  128641. keysRadiusDecr: number[];
  128642. /**
  128643. * Defines whether the Alt modifier key is required to zoom in/out (alter radius value)
  128644. */
  128645. keysRadiusModifierAlt: boolean;
  128646. /**
  128647. * Defines whether the Ctrl modifier key is required to zoom in/out (alter radius value)
  128648. */
  128649. keysRadiusModifierCtrl: boolean;
  128650. /**
  128651. * Defines whether the Shift modifier key is required to zoom in/out (alter radius value)
  128652. */
  128653. keysRadiusModifierShift: boolean;
  128654. /**
  128655. * Defines the rate of change of heightOffset.
  128656. */
  128657. heightSensibility: number;
  128658. /**
  128659. * Defines the rate of change of rotationOffset.
  128660. */
  128661. rotationSensibility: number;
  128662. /**
  128663. * Defines the rate of change of radius.
  128664. */
  128665. radiusSensibility: number;
  128666. private _keys;
  128667. private _ctrlPressed;
  128668. private _altPressed;
  128669. private _shiftPressed;
  128670. private _onCanvasBlurObserver;
  128671. private _onKeyboardObserver;
  128672. private _engine;
  128673. private _scene;
  128674. /**
  128675. * Attach the input controls to a specific dom element to get the input from.
  128676. * @param element Defines the element the controls should be listened from
  128677. * @param noPreventDefault Defines whether event caught by the controls should call preventdefault() (https://developer.mozilla.org/en-US/docs/Web/API/Event/preventDefault)
  128678. */
  128679. attachControl(element: HTMLElement, noPreventDefault?: boolean): void;
  128680. /**
  128681. * Detach the current controls from the specified dom element.
  128682. * @param element Defines the element to stop listening the inputs from
  128683. */
  128684. detachControl(element: Nullable<HTMLElement>): void;
  128685. /**
  128686. * Update the current camera state depending on the inputs that have been used this frame.
  128687. * This is a dynamically created lambda to avoid the performance penalty of looping for inputs in the render loop.
  128688. */
  128689. checkInputs(): void;
  128690. /**
  128691. * Gets the class name of the current input.
  128692. * @returns the class name
  128693. */
  128694. getClassName(): string;
  128695. /**
  128696. * Get the friendly name associated with the input class.
  128697. * @returns the input friendly name
  128698. */
  128699. getSimpleName(): string;
  128700. /**
  128701. * Check if the pressed modifier keys (Alt/Ctrl/Shift) match those configured to
  128702. * allow modification of the heightOffset value.
  128703. */
  128704. private _modifierHeightOffset;
  128705. /**
  128706. * Check if the pressed modifier keys (Alt/Ctrl/Shift) match those configured to
  128707. * allow modification of the rotationOffset value.
  128708. */
  128709. private _modifierRotationOffset;
  128710. /**
  128711. * Check if the pressed modifier keys (Alt/Ctrl/Shift) match those configured to
  128712. * allow modification of the radius value.
  128713. */
  128714. private _modifierRadius;
  128715. }
  128716. }
  128717. declare module BABYLON {
  128718. interface FreeCameraInputsManager {
  128719. /**
  128720. * @hidden
  128721. */
  128722. _deviceOrientationInput: Nullable<FreeCameraDeviceOrientationInput>;
  128723. /**
  128724. * Add orientation input support to the input manager.
  128725. * @returns the current input manager
  128726. */
  128727. addDeviceOrientation(): FreeCameraInputsManager;
  128728. }
  128729. /**
  128730. * Takes information about the orientation of the device as reported by the deviceorientation event to orient the camera.
  128731. * Screen rotation is taken into account.
  128732. * @see https://doc.babylonjs.com/how_to/customizing_camera_inputs
  128733. */
  128734. export class FreeCameraDeviceOrientationInput implements ICameraInput<FreeCamera> {
  128735. private _camera;
  128736. private _screenOrientationAngle;
  128737. private _constantTranform;
  128738. private _screenQuaternion;
  128739. private _alpha;
  128740. private _beta;
  128741. private _gamma;
  128742. /**
  128743. * Can be used to detect if a device orientation sensor is available on a device
  128744. * @param timeout amount of time in milliseconds to wait for a response from the sensor (default: infinite)
  128745. * @returns a promise that will resolve on orientation change
  128746. */
  128747. static WaitForOrientationChangeAsync(timeout?: number): Promise<unknown>;
  128748. /**
  128749. * @hidden
  128750. */
  128751. _onDeviceOrientationChangedObservable: Observable<void>;
  128752. /**
  128753. * Instantiates a new input
  128754. * @see https://doc.babylonjs.com/how_to/customizing_camera_inputs
  128755. */
  128756. constructor();
  128757. /**
  128758. * Define the camera controlled by the input.
  128759. */
  128760. get camera(): FreeCamera;
  128761. set camera(camera: FreeCamera);
  128762. /**
  128763. * Attach the input controls to a specific dom element to get the input from.
  128764. * @param element Defines the element the controls should be listened from
  128765. * @param noPreventDefault Defines whether event caught by the controls should call preventdefault() (https://developer.mozilla.org/en-US/docs/Web/API/Event/preventDefault)
  128766. */
  128767. attachControl(element: HTMLElement, noPreventDefault?: boolean): void;
  128768. private _orientationChanged;
  128769. private _deviceOrientation;
  128770. /**
  128771. * Detach the current controls from the specified dom element.
  128772. * @param element Defines the element to stop listening the inputs from
  128773. */
  128774. detachControl(element: Nullable<HTMLElement>): void;
  128775. /**
  128776. * Update the current camera state depending on the inputs that have been used this frame.
  128777. * This is a dynamically created lambda to avoid the performance penalty of looping for inputs in the render loop.
  128778. */
  128779. checkInputs(): void;
  128780. /**
  128781. * Gets the class name of the current intput.
  128782. * @returns the class name
  128783. */
  128784. getClassName(): string;
  128785. /**
  128786. * Get the friendly name associated with the input class.
  128787. * @returns the input friendly name
  128788. */
  128789. getSimpleName(): string;
  128790. }
  128791. }
  128792. declare module BABYLON {
  128793. /**
  128794. * Manage the gamepad inputs to control a free camera.
  128795. * @see https://doc.babylonjs.com/how_to/customizing_camera_inputs
  128796. */
  128797. export class FreeCameraGamepadInput implements ICameraInput<FreeCamera> {
  128798. /**
  128799. * Define the camera the input is attached to.
  128800. */
  128801. camera: FreeCamera;
  128802. /**
  128803. * Define the Gamepad controlling the input
  128804. */
  128805. gamepad: Nullable<Gamepad>;
  128806. /**
  128807. * Defines the gamepad rotation sensiblity.
  128808. * This is the threshold from when rotation starts to be accounted for to prevent jittering.
  128809. */
  128810. gamepadAngularSensibility: number;
  128811. /**
  128812. * Defines the gamepad move sensiblity.
  128813. * This is the threshold from when moving starts to be accounted for for to prevent jittering.
  128814. */
  128815. gamepadMoveSensibility: number;
  128816. private _yAxisScale;
  128817. /**
  128818. * Gets or sets a boolean indicating that Yaxis (for right stick) should be inverted
  128819. */
  128820. get invertYAxis(): boolean;
  128821. set invertYAxis(value: boolean);
  128822. private _onGamepadConnectedObserver;
  128823. private _onGamepadDisconnectedObserver;
  128824. private _cameraTransform;
  128825. private _deltaTransform;
  128826. private _vector3;
  128827. private _vector2;
  128828. /**
  128829. * Attach the input controls to a specific dom element to get the input from.
  128830. * @param element Defines the element the controls should be listened from
  128831. * @param noPreventDefault Defines whether event caught by the controls should call preventdefault() (https://developer.mozilla.org/en-US/docs/Web/API/Event/preventDefault)
  128832. */
  128833. attachControl(element: HTMLElement, noPreventDefault?: boolean): void;
  128834. /**
  128835. * Detach the current controls from the specified dom element.
  128836. * @param element Defines the element to stop listening the inputs from
  128837. */
  128838. detachControl(element: Nullable<HTMLElement>): void;
  128839. /**
  128840. * Update the current camera state depending on the inputs that have been used this frame.
  128841. * This is a dynamically created lambda to avoid the performance penalty of looping for inputs in the render loop.
  128842. */
  128843. checkInputs(): void;
  128844. /**
  128845. * Gets the class name of the current intput.
  128846. * @returns the class name
  128847. */
  128848. getClassName(): string;
  128849. /**
  128850. * Get the friendly name associated with the input class.
  128851. * @returns the input friendly name
  128852. */
  128853. getSimpleName(): string;
  128854. }
  128855. }
  128856. declare module BABYLON {
  128857. /**
  128858. * Defines the potential axis of a Joystick
  128859. */
  128860. export enum JoystickAxis {
  128861. /** X axis */
  128862. X = 0,
  128863. /** Y axis */
  128864. Y = 1,
  128865. /** Z axis */
  128866. Z = 2
  128867. }
  128868. /**
  128869. * Represents the different customization options available
  128870. * for VirtualJoystick
  128871. */
  128872. interface VirtualJoystickCustomizations {
  128873. /**
  128874. * Size of the joystick's puck
  128875. */
  128876. puckSize: number;
  128877. /**
  128878. * Size of the joystick's container
  128879. */
  128880. containerSize: number;
  128881. /**
  128882. * Color of the joystick && puck
  128883. */
  128884. color: string;
  128885. /**
  128886. * Image URL for the joystick's puck
  128887. */
  128888. puckImage?: string;
  128889. /**
  128890. * Image URL for the joystick's container
  128891. */
  128892. containerImage?: string;
  128893. /**
  128894. * Defines the unmoving position of the joystick container
  128895. */
  128896. position?: {
  128897. x: number;
  128898. y: number;
  128899. };
  128900. /**
  128901. * Defines whether or not the joystick container is always visible
  128902. */
  128903. alwaysVisible: boolean;
  128904. /**
  128905. * Defines whether or not to limit the movement of the puck to the joystick's container
  128906. */
  128907. limitToContainer: boolean;
  128908. }
  128909. /**
  128910. * Class used to define virtual joystick (used in touch mode)
  128911. */
  128912. export class VirtualJoystick {
  128913. /**
  128914. * Gets or sets a boolean indicating that left and right values must be inverted
  128915. */
  128916. reverseLeftRight: boolean;
  128917. /**
  128918. * Gets or sets a boolean indicating that up and down values must be inverted
  128919. */
  128920. reverseUpDown: boolean;
  128921. /**
  128922. * Gets the offset value for the position (ie. the change of the position value)
  128923. */
  128924. deltaPosition: Vector3;
  128925. /**
  128926. * Gets a boolean indicating if the virtual joystick was pressed
  128927. */
  128928. pressed: boolean;
  128929. /**
  128930. * Canvas the virtual joystick will render onto, default z-index of this is 5
  128931. */
  128932. static Canvas: Nullable<HTMLCanvasElement>;
  128933. /**
  128934. * boolean indicating whether or not the joystick's puck's movement should be limited to the joystick's container area
  128935. */
  128936. limitToContainer: boolean;
  128937. private static _globalJoystickIndex;
  128938. private static _alwaysVisibleSticks;
  128939. private static vjCanvasContext;
  128940. private static vjCanvasWidth;
  128941. private static vjCanvasHeight;
  128942. private static halfWidth;
  128943. private static _GetDefaultOptions;
  128944. private _action;
  128945. private _axisTargetedByLeftAndRight;
  128946. private _axisTargetedByUpAndDown;
  128947. private _joystickSensibility;
  128948. private _inversedSensibility;
  128949. private _joystickPointerID;
  128950. private _joystickColor;
  128951. private _joystickPointerPos;
  128952. private _joystickPreviousPointerPos;
  128953. private _joystickPointerStartPos;
  128954. private _deltaJoystickVector;
  128955. private _leftJoystick;
  128956. private _touches;
  128957. private _joystickPosition;
  128958. private _alwaysVisible;
  128959. private _puckImage;
  128960. private _containerImage;
  128961. private _joystickPuckSize;
  128962. private _joystickContainerSize;
  128963. private _clearPuckSize;
  128964. private _clearContainerSize;
  128965. private _clearPuckSizeOffset;
  128966. private _clearContainerSizeOffset;
  128967. private _onPointerDownHandlerRef;
  128968. private _onPointerMoveHandlerRef;
  128969. private _onPointerUpHandlerRef;
  128970. private _onResize;
  128971. /**
  128972. * Creates a new virtual joystick
  128973. * @param leftJoystick defines that the joystick is for left hand (false by default)
  128974. * @param customizations Defines the options we want to customize the VirtualJoystick
  128975. */
  128976. constructor(leftJoystick?: boolean, customizations?: Partial<VirtualJoystickCustomizations>);
  128977. /**
  128978. * Defines joystick sensibility (ie. the ratio beteen a physical move and virtual joystick position change)
  128979. * @param newJoystickSensibility defines the new sensibility
  128980. */
  128981. setJoystickSensibility(newJoystickSensibility: number): void;
  128982. private _onPointerDown;
  128983. private _onPointerMove;
  128984. private _onPointerUp;
  128985. /**
  128986. * Change the color of the virtual joystick
  128987. * @param newColor a string that must be a CSS color value (like "red") or the hexa value (like "#FF0000")
  128988. */
  128989. setJoystickColor(newColor: string): void;
  128990. /**
  128991. * Size of the joystick's container
  128992. */
  128993. set containerSize(newSize: number);
  128994. get containerSize(): number;
  128995. /**
  128996. * Size of the joystick's puck
  128997. */
  128998. set puckSize(newSize: number);
  128999. get puckSize(): number;
  129000. /**
  129001. * Clears the set position of the joystick
  129002. */
  129003. clearPosition(): void;
  129004. /**
  129005. * Defines whether or not the joystick container is always visible
  129006. */
  129007. set alwaysVisible(value: boolean);
  129008. get alwaysVisible(): boolean;
  129009. /**
  129010. * Sets the constant position of the Joystick container
  129011. * @param x X axis coordinate
  129012. * @param y Y axis coordinate
  129013. */
  129014. setPosition(x: number, y: number): void;
  129015. /**
  129016. * Defines a callback to call when the joystick is touched
  129017. * @param action defines the callback
  129018. */
  129019. setActionOnTouch(action: () => any): void;
  129020. /**
  129021. * Defines which axis you'd like to control for left & right
  129022. * @param axis defines the axis to use
  129023. */
  129024. setAxisForLeftRight(axis: JoystickAxis): void;
  129025. /**
  129026. * Defines which axis you'd like to control for up & down
  129027. * @param axis defines the axis to use
  129028. */
  129029. setAxisForUpDown(axis: JoystickAxis): void;
  129030. /**
  129031. * Clears the canvas from the previous puck / container draw
  129032. */
  129033. private _clearPreviousDraw;
  129034. /**
  129035. * Loads `urlPath` to be used for the container's image
  129036. * @param urlPath defines the urlPath of an image to use
  129037. */
  129038. setContainerImage(urlPath: string): void;
  129039. /**
  129040. * Loads `urlPath` to be used for the puck's image
  129041. * @param urlPath defines the urlPath of an image to use
  129042. */
  129043. setPuckImage(urlPath: string): void;
  129044. /**
  129045. * Draws the Virtual Joystick's container
  129046. */
  129047. private _drawContainer;
  129048. /**
  129049. * Draws the Virtual Joystick's puck
  129050. */
  129051. private _drawPuck;
  129052. private _drawVirtualJoystick;
  129053. /**
  129054. * Release internal HTML canvas
  129055. */
  129056. releaseCanvas(): void;
  129057. }
  129058. }
  129059. declare module BABYLON {
  129060. interface FreeCameraInputsManager {
  129061. /**
  129062. * Add virtual joystick input support to the input manager.
  129063. * @returns the current input manager
  129064. */
  129065. addVirtualJoystick(): FreeCameraInputsManager;
  129066. }
  129067. /**
  129068. * Manage the Virtual Joystick inputs to control the movement of a free camera.
  129069. * @see https://doc.babylonjs.com/how_to/customizing_camera_inputs
  129070. */
  129071. export class FreeCameraVirtualJoystickInput implements ICameraInput<FreeCamera> {
  129072. /**
  129073. * Defines the camera the input is attached to.
  129074. */
  129075. camera: FreeCamera;
  129076. private _leftjoystick;
  129077. private _rightjoystick;
  129078. /**
  129079. * Gets the left stick of the virtual joystick.
  129080. * @returns The virtual Joystick
  129081. */
  129082. getLeftJoystick(): VirtualJoystick;
  129083. /**
  129084. * Gets the right stick of the virtual joystick.
  129085. * @returns The virtual Joystick
  129086. */
  129087. getRightJoystick(): VirtualJoystick;
  129088. /**
  129089. * Update the current camera state depending on the inputs that have been used this frame.
  129090. * This is a dynamically created lambda to avoid the performance penalty of looping for inputs in the render loop.
  129091. */
  129092. checkInputs(): void;
  129093. /**
  129094. * Attach the input controls to a specific dom element to get the input from.
  129095. * @param element Defines the element the controls should be listened from
  129096. * @param noPreventDefault Defines whether event caught by the controls should call preventdefault() (https://developer.mozilla.org/en-US/docs/Web/API/Event/preventDefault)
  129097. */
  129098. attachControl(element: HTMLElement, noPreventDefault?: boolean): void;
  129099. /**
  129100. * Detach the current controls from the specified dom element.
  129101. * @param element Defines the element to stop listening the inputs from
  129102. */
  129103. detachControl(element: Nullable<HTMLElement>): void;
  129104. /**
  129105. * Gets the class name of the current intput.
  129106. * @returns the class name
  129107. */
  129108. getClassName(): string;
  129109. /**
  129110. * Get the friendly name associated with the input class.
  129111. * @returns the input friendly name
  129112. */
  129113. getSimpleName(): string;
  129114. }
  129115. }
  129116. declare module BABYLON {
  129117. /**
  129118. * This represents a FPS type of camera controlled by touch.
  129119. * This is like a universal camera minus the Gamepad controls.
  129120. * @see https://doc.babylonjs.com/features/cameras#universal-camera
  129121. */
  129122. export class TouchCamera extends FreeCamera {
  129123. /**
  129124. * Defines the touch sensibility for rotation.
  129125. * The higher the faster.
  129126. */
  129127. get touchAngularSensibility(): number;
  129128. set touchAngularSensibility(value: number);
  129129. /**
  129130. * Defines the touch sensibility for move.
  129131. * The higher the faster.
  129132. */
  129133. get touchMoveSensibility(): number;
  129134. set touchMoveSensibility(value: number);
  129135. /**
  129136. * Instantiates a new touch camera.
  129137. * This represents a FPS type of camera controlled by touch.
  129138. * This is like a universal camera minus the Gamepad controls.
  129139. * @see https://doc.babylonjs.com/features/cameras#universal-camera
  129140. * @param name Define the name of the camera in the scene
  129141. * @param position Define the start position of the camera in the scene
  129142. * @param scene Define the scene the camera belongs to
  129143. */
  129144. constructor(name: string, position: Vector3, scene: Scene);
  129145. /**
  129146. * Gets the current object class name.
  129147. * @return the class name
  129148. */
  129149. getClassName(): string;
  129150. /** @hidden */
  129151. _setupInputs(): void;
  129152. }
  129153. }
  129154. declare module BABYLON {
  129155. /**
  129156. * This is a camera specifically designed to react to device orientation events such as a modern mobile device
  129157. * being tilted forward or back and left or right.
  129158. */
  129159. export class DeviceOrientationCamera extends FreeCamera {
  129160. private _initialQuaternion;
  129161. private _quaternionCache;
  129162. private _tmpDragQuaternion;
  129163. private _disablePointerInputWhenUsingDeviceOrientation;
  129164. /**
  129165. * Creates a new device orientation camera
  129166. * @param name The name of the camera
  129167. * @param position The start position camera
  129168. * @param scene The scene the camera belongs to
  129169. */
  129170. constructor(name: string, position: Vector3, scene: Scene);
  129171. /**
  129172. * Gets or sets a boolean indicating that pointer input must be disabled on first orientation sensor update (Default: true)
  129173. */
  129174. get disablePointerInputWhenUsingDeviceOrientation(): boolean;
  129175. set disablePointerInputWhenUsingDeviceOrientation(value: boolean);
  129176. private _dragFactor;
  129177. /**
  129178. * Enabled turning on the y axis when the orientation sensor is active
  129179. * @param dragFactor the factor that controls the turn speed (default: 1/300)
  129180. */
  129181. enableHorizontalDragging(dragFactor?: number): void;
  129182. /**
  129183. * Gets the current instance class name ("DeviceOrientationCamera").
  129184. * This helps avoiding instanceof at run time.
  129185. * @returns the class name
  129186. */
  129187. getClassName(): string;
  129188. /**
  129189. * @hidden
  129190. * Checks and applies the current values of the inputs to the camera. (Internal use only)
  129191. */
  129192. _checkInputs(): void;
  129193. /**
  129194. * Reset the camera to its default orientation on the specified axis only.
  129195. * @param axis The axis to reset
  129196. */
  129197. resetToCurrentRotation(axis?: Axis): void;
  129198. }
  129199. }
  129200. declare module BABYLON {
  129201. /**
  129202. * Defines supported buttons for XBox360 compatible gamepads
  129203. */
  129204. export enum Xbox360Button {
  129205. /** A */
  129206. A = 0,
  129207. /** B */
  129208. B = 1,
  129209. /** X */
  129210. X = 2,
  129211. /** Y */
  129212. Y = 3,
  129213. /** Left button */
  129214. LB = 4,
  129215. /** Right button */
  129216. RB = 5,
  129217. /** Back */
  129218. Back = 8,
  129219. /** Start */
  129220. Start = 9,
  129221. /** Left stick */
  129222. LeftStick = 10,
  129223. /** Right stick */
  129224. RightStick = 11
  129225. }
  129226. /** Defines values for XBox360 DPad */
  129227. export enum Xbox360Dpad {
  129228. /** Up */
  129229. Up = 12,
  129230. /** Down */
  129231. Down = 13,
  129232. /** Left */
  129233. Left = 14,
  129234. /** Right */
  129235. Right = 15
  129236. }
  129237. /**
  129238. * Defines a XBox360 gamepad
  129239. */
  129240. export class Xbox360Pad extends Gamepad {
  129241. private _leftTrigger;
  129242. private _rightTrigger;
  129243. private _onlefttriggerchanged;
  129244. private _onrighttriggerchanged;
  129245. private _onbuttondown;
  129246. private _onbuttonup;
  129247. private _ondpaddown;
  129248. private _ondpadup;
  129249. /** Observable raised when a button is pressed */
  129250. onButtonDownObservable: Observable<Xbox360Button>;
  129251. /** Observable raised when a button is released */
  129252. onButtonUpObservable: Observable<Xbox360Button>;
  129253. /** Observable raised when a pad is pressed */
  129254. onPadDownObservable: Observable<Xbox360Dpad>;
  129255. /** Observable raised when a pad is released */
  129256. onPadUpObservable: Observable<Xbox360Dpad>;
  129257. private _buttonA;
  129258. private _buttonB;
  129259. private _buttonX;
  129260. private _buttonY;
  129261. private _buttonBack;
  129262. private _buttonStart;
  129263. private _buttonLB;
  129264. private _buttonRB;
  129265. private _buttonLeftStick;
  129266. private _buttonRightStick;
  129267. private _dPadUp;
  129268. private _dPadDown;
  129269. private _dPadLeft;
  129270. private _dPadRight;
  129271. private _isXboxOnePad;
  129272. /**
  129273. * Creates a new XBox360 gamepad object
  129274. * @param id defines the id of this gamepad
  129275. * @param index defines its index
  129276. * @param gamepad defines the internal HTML gamepad object
  129277. * @param xboxOne defines if it is a XBox One gamepad
  129278. */
  129279. constructor(id: string, index: number, gamepad: any, xboxOne?: boolean);
  129280. /**
  129281. * Defines the callback to call when left trigger is pressed
  129282. * @param callback defines the callback to use
  129283. */
  129284. onlefttriggerchanged(callback: (value: number) => void): void;
  129285. /**
  129286. * Defines the callback to call when right trigger is pressed
  129287. * @param callback defines the callback to use
  129288. */
  129289. onrighttriggerchanged(callback: (value: number) => void): void;
  129290. /**
  129291. * Gets the left trigger value
  129292. */
  129293. get leftTrigger(): number;
  129294. /**
  129295. * Sets the left trigger value
  129296. */
  129297. set leftTrigger(newValue: number);
  129298. /**
  129299. * Gets the right trigger value
  129300. */
  129301. get rightTrigger(): number;
  129302. /**
  129303. * Sets the right trigger value
  129304. */
  129305. set rightTrigger(newValue: number);
  129306. /**
  129307. * Defines the callback to call when a button is pressed
  129308. * @param callback defines the callback to use
  129309. */
  129310. onbuttondown(callback: (buttonPressed: Xbox360Button) => void): void;
  129311. /**
  129312. * Defines the callback to call when a button is released
  129313. * @param callback defines the callback to use
  129314. */
  129315. onbuttonup(callback: (buttonReleased: Xbox360Button) => void): void;
  129316. /**
  129317. * Defines the callback to call when a pad is pressed
  129318. * @param callback defines the callback to use
  129319. */
  129320. ondpaddown(callback: (dPadPressed: Xbox360Dpad) => void): void;
  129321. /**
  129322. * Defines the callback to call when a pad is released
  129323. * @param callback defines the callback to use
  129324. */
  129325. ondpadup(callback: (dPadReleased: Xbox360Dpad) => void): void;
  129326. private _setButtonValue;
  129327. private _setDPadValue;
  129328. /**
  129329. * Gets the value of the `A` button
  129330. */
  129331. get buttonA(): number;
  129332. /**
  129333. * Sets the value of the `A` button
  129334. */
  129335. set buttonA(value: number);
  129336. /**
  129337. * Gets the value of the `B` button
  129338. */
  129339. get buttonB(): number;
  129340. /**
  129341. * Sets the value of the `B` button
  129342. */
  129343. set buttonB(value: number);
  129344. /**
  129345. * Gets the value of the `X` button
  129346. */
  129347. get buttonX(): number;
  129348. /**
  129349. * Sets the value of the `X` button
  129350. */
  129351. set buttonX(value: number);
  129352. /**
  129353. * Gets the value of the `Y` button
  129354. */
  129355. get buttonY(): number;
  129356. /**
  129357. * Sets the value of the `Y` button
  129358. */
  129359. set buttonY(value: number);
  129360. /**
  129361. * Gets the value of the `Start` button
  129362. */
  129363. get buttonStart(): number;
  129364. /**
  129365. * Sets the value of the `Start` button
  129366. */
  129367. set buttonStart(value: number);
  129368. /**
  129369. * Gets the value of the `Back` button
  129370. */
  129371. get buttonBack(): number;
  129372. /**
  129373. * Sets the value of the `Back` button
  129374. */
  129375. set buttonBack(value: number);
  129376. /**
  129377. * Gets the value of the `Left` button
  129378. */
  129379. get buttonLB(): number;
  129380. /**
  129381. * Sets the value of the `Left` button
  129382. */
  129383. set buttonLB(value: number);
  129384. /**
  129385. * Gets the value of the `Right` button
  129386. */
  129387. get buttonRB(): number;
  129388. /**
  129389. * Sets the value of the `Right` button
  129390. */
  129391. set buttonRB(value: number);
  129392. /**
  129393. * Gets the value of the Left joystick
  129394. */
  129395. get buttonLeftStick(): number;
  129396. /**
  129397. * Sets the value of the Left joystick
  129398. */
  129399. set buttonLeftStick(value: number);
  129400. /**
  129401. * Gets the value of the Right joystick
  129402. */
  129403. get buttonRightStick(): number;
  129404. /**
  129405. * Sets the value of the Right joystick
  129406. */
  129407. set buttonRightStick(value: number);
  129408. /**
  129409. * Gets the value of D-pad up
  129410. */
  129411. get dPadUp(): number;
  129412. /**
  129413. * Sets the value of D-pad up
  129414. */
  129415. set dPadUp(value: number);
  129416. /**
  129417. * Gets the value of D-pad down
  129418. */
  129419. get dPadDown(): number;
  129420. /**
  129421. * Sets the value of D-pad down
  129422. */
  129423. set dPadDown(value: number);
  129424. /**
  129425. * Gets the value of D-pad left
  129426. */
  129427. get dPadLeft(): number;
  129428. /**
  129429. * Sets the value of D-pad left
  129430. */
  129431. set dPadLeft(value: number);
  129432. /**
  129433. * Gets the value of D-pad right
  129434. */
  129435. get dPadRight(): number;
  129436. /**
  129437. * Sets the value of D-pad right
  129438. */
  129439. set dPadRight(value: number);
  129440. /**
  129441. * Force the gamepad to synchronize with device values
  129442. */
  129443. update(): void;
  129444. /**
  129445. * Disposes the gamepad
  129446. */
  129447. dispose(): void;
  129448. }
  129449. }
  129450. declare module BABYLON {
  129451. /**
  129452. * Defines supported buttons for DualShock compatible gamepads
  129453. */
  129454. export enum DualShockButton {
  129455. /** Cross */
  129456. Cross = 0,
  129457. /** Circle */
  129458. Circle = 1,
  129459. /** Square */
  129460. Square = 2,
  129461. /** Triangle */
  129462. Triangle = 3,
  129463. /** L1 */
  129464. L1 = 4,
  129465. /** R1 */
  129466. R1 = 5,
  129467. /** Share */
  129468. Share = 8,
  129469. /** Options */
  129470. Options = 9,
  129471. /** Left stick */
  129472. LeftStick = 10,
  129473. /** Right stick */
  129474. RightStick = 11
  129475. }
  129476. /** Defines values for DualShock DPad */
  129477. export enum DualShockDpad {
  129478. /** Up */
  129479. Up = 12,
  129480. /** Down */
  129481. Down = 13,
  129482. /** Left */
  129483. Left = 14,
  129484. /** Right */
  129485. Right = 15
  129486. }
  129487. /**
  129488. * Defines a DualShock gamepad
  129489. */
  129490. export class DualShockPad extends Gamepad {
  129491. private _leftTrigger;
  129492. private _rightTrigger;
  129493. private _onlefttriggerchanged;
  129494. private _onrighttriggerchanged;
  129495. private _onbuttondown;
  129496. private _onbuttonup;
  129497. private _ondpaddown;
  129498. private _ondpadup;
  129499. /** Observable raised when a button is pressed */
  129500. onButtonDownObservable: Observable<DualShockButton>;
  129501. /** Observable raised when a button is released */
  129502. onButtonUpObservable: Observable<DualShockButton>;
  129503. /** Observable raised when a pad is pressed */
  129504. onPadDownObservable: Observable<DualShockDpad>;
  129505. /** Observable raised when a pad is released */
  129506. onPadUpObservable: Observable<DualShockDpad>;
  129507. private _buttonCross;
  129508. private _buttonCircle;
  129509. private _buttonSquare;
  129510. private _buttonTriangle;
  129511. private _buttonShare;
  129512. private _buttonOptions;
  129513. private _buttonL1;
  129514. private _buttonR1;
  129515. private _buttonLeftStick;
  129516. private _buttonRightStick;
  129517. private _dPadUp;
  129518. private _dPadDown;
  129519. private _dPadLeft;
  129520. private _dPadRight;
  129521. /**
  129522. * Creates a new DualShock gamepad object
  129523. * @param id defines the id of this gamepad
  129524. * @param index defines its index
  129525. * @param gamepad defines the internal HTML gamepad object
  129526. */
  129527. constructor(id: string, index: number, gamepad: any);
  129528. /**
  129529. * Defines the callback to call when left trigger is pressed
  129530. * @param callback defines the callback to use
  129531. */
  129532. onlefttriggerchanged(callback: (value: number) => void): void;
  129533. /**
  129534. * Defines the callback to call when right trigger is pressed
  129535. * @param callback defines the callback to use
  129536. */
  129537. onrighttriggerchanged(callback: (value: number) => void): void;
  129538. /**
  129539. * Gets the left trigger value
  129540. */
  129541. get leftTrigger(): number;
  129542. /**
  129543. * Sets the left trigger value
  129544. */
  129545. set leftTrigger(newValue: number);
  129546. /**
  129547. * Gets the right trigger value
  129548. */
  129549. get rightTrigger(): number;
  129550. /**
  129551. * Sets the right trigger value
  129552. */
  129553. set rightTrigger(newValue: number);
  129554. /**
  129555. * Defines the callback to call when a button is pressed
  129556. * @param callback defines the callback to use
  129557. */
  129558. onbuttondown(callback: (buttonPressed: DualShockButton) => void): void;
  129559. /**
  129560. * Defines the callback to call when a button is released
  129561. * @param callback defines the callback to use
  129562. */
  129563. onbuttonup(callback: (buttonReleased: DualShockButton) => void): void;
  129564. /**
  129565. * Defines the callback to call when a pad is pressed
  129566. * @param callback defines the callback to use
  129567. */
  129568. ondpaddown(callback: (dPadPressed: DualShockDpad) => void): void;
  129569. /**
  129570. * Defines the callback to call when a pad is released
  129571. * @param callback defines the callback to use
  129572. */
  129573. ondpadup(callback: (dPadReleased: DualShockDpad) => void): void;
  129574. private _setButtonValue;
  129575. private _setDPadValue;
  129576. /**
  129577. * Gets the value of the `Cross` button
  129578. */
  129579. get buttonCross(): number;
  129580. /**
  129581. * Sets the value of the `Cross` button
  129582. */
  129583. set buttonCross(value: number);
  129584. /**
  129585. * Gets the value of the `Circle` button
  129586. */
  129587. get buttonCircle(): number;
  129588. /**
  129589. * Sets the value of the `Circle` button
  129590. */
  129591. set buttonCircle(value: number);
  129592. /**
  129593. * Gets the value of the `Square` button
  129594. */
  129595. get buttonSquare(): number;
  129596. /**
  129597. * Sets the value of the `Square` button
  129598. */
  129599. set buttonSquare(value: number);
  129600. /**
  129601. * Gets the value of the `Triangle` button
  129602. */
  129603. get buttonTriangle(): number;
  129604. /**
  129605. * Sets the value of the `Triangle` button
  129606. */
  129607. set buttonTriangle(value: number);
  129608. /**
  129609. * Gets the value of the `Options` button
  129610. */
  129611. get buttonOptions(): number;
  129612. /**
  129613. * Sets the value of the `Options` button
  129614. */
  129615. set buttonOptions(value: number);
  129616. /**
  129617. * Gets the value of the `Share` button
  129618. */
  129619. get buttonShare(): number;
  129620. /**
  129621. * Sets the value of the `Share` button
  129622. */
  129623. set buttonShare(value: number);
  129624. /**
  129625. * Gets the value of the `L1` button
  129626. */
  129627. get buttonL1(): number;
  129628. /**
  129629. * Sets the value of the `L1` button
  129630. */
  129631. set buttonL1(value: number);
  129632. /**
  129633. * Gets the value of the `R1` button
  129634. */
  129635. get buttonR1(): number;
  129636. /**
  129637. * Sets the value of the `R1` button
  129638. */
  129639. set buttonR1(value: number);
  129640. /**
  129641. * Gets the value of the Left joystick
  129642. */
  129643. get buttonLeftStick(): number;
  129644. /**
  129645. * Sets the value of the Left joystick
  129646. */
  129647. set buttonLeftStick(value: number);
  129648. /**
  129649. * Gets the value of the Right joystick
  129650. */
  129651. get buttonRightStick(): number;
  129652. /**
  129653. * Sets the value of the Right joystick
  129654. */
  129655. set buttonRightStick(value: number);
  129656. /**
  129657. * Gets the value of D-pad up
  129658. */
  129659. get dPadUp(): number;
  129660. /**
  129661. * Sets the value of D-pad up
  129662. */
  129663. set dPadUp(value: number);
  129664. /**
  129665. * Gets the value of D-pad down
  129666. */
  129667. get dPadDown(): number;
  129668. /**
  129669. * Sets the value of D-pad down
  129670. */
  129671. set dPadDown(value: number);
  129672. /**
  129673. * Gets the value of D-pad left
  129674. */
  129675. get dPadLeft(): number;
  129676. /**
  129677. * Sets the value of D-pad left
  129678. */
  129679. set dPadLeft(value: number);
  129680. /**
  129681. * Gets the value of D-pad right
  129682. */
  129683. get dPadRight(): number;
  129684. /**
  129685. * Sets the value of D-pad right
  129686. */
  129687. set dPadRight(value: number);
  129688. /**
  129689. * Force the gamepad to synchronize with device values
  129690. */
  129691. update(): void;
  129692. /**
  129693. * Disposes the gamepad
  129694. */
  129695. dispose(): void;
  129696. }
  129697. }
  129698. declare module BABYLON {
  129699. /**
  129700. * Manager for handling gamepads
  129701. */
  129702. export class GamepadManager {
  129703. private _scene?;
  129704. private _babylonGamepads;
  129705. private _oneGamepadConnected;
  129706. /** @hidden */
  129707. _isMonitoring: boolean;
  129708. private _gamepadEventSupported;
  129709. private _gamepadSupport?;
  129710. /**
  129711. * observable to be triggered when the gamepad controller has been connected
  129712. */
  129713. onGamepadConnectedObservable: Observable<Gamepad>;
  129714. /**
  129715. * observable to be triggered when the gamepad controller has been disconnected
  129716. */
  129717. onGamepadDisconnectedObservable: Observable<Gamepad>;
  129718. private _onGamepadConnectedEvent;
  129719. private _onGamepadDisconnectedEvent;
  129720. /**
  129721. * Initializes the gamepad manager
  129722. * @param _scene BabylonJS scene
  129723. */
  129724. constructor(_scene?: Scene | undefined);
  129725. /**
  129726. * The gamepads in the game pad manager
  129727. */
  129728. get gamepads(): Gamepad[];
  129729. /**
  129730. * Get the gamepad controllers based on type
  129731. * @param type The type of gamepad controller
  129732. * @returns Nullable gamepad
  129733. */
  129734. getGamepadByType(type?: number): Nullable<Gamepad>;
  129735. /**
  129736. * Disposes the gamepad manager
  129737. */
  129738. dispose(): void;
  129739. private _addNewGamepad;
  129740. private _startMonitoringGamepads;
  129741. private _stopMonitoringGamepads;
  129742. /** @hidden */
  129743. _checkGamepadsStatus(): void;
  129744. private _updateGamepadObjects;
  129745. }
  129746. }
  129747. declare module BABYLON {
  129748. interface Scene {
  129749. /** @hidden */
  129750. _gamepadManager: Nullable<GamepadManager>;
  129751. /**
  129752. * Gets the gamepad manager associated with the scene
  129753. * @see https://doc.babylonjs.com/how_to/how_to_use_gamepads
  129754. */
  129755. gamepadManager: GamepadManager;
  129756. }
  129757. /**
  129758. * Interface representing a free camera inputs manager
  129759. */
  129760. interface FreeCameraInputsManager {
  129761. /**
  129762. * Adds gamepad input support to the FreeCameraInputsManager.
  129763. * @returns the FreeCameraInputsManager
  129764. */
  129765. addGamepad(): FreeCameraInputsManager;
  129766. }
  129767. /**
  129768. * Interface representing an arc rotate camera inputs manager
  129769. */
  129770. interface ArcRotateCameraInputsManager {
  129771. /**
  129772. * Adds gamepad input support to the ArcRotateCamera InputManager.
  129773. * @returns the camera inputs manager
  129774. */
  129775. addGamepad(): ArcRotateCameraInputsManager;
  129776. }
  129777. /**
  129778. * Defines the gamepad scene component responsible to manage gamepads in a given scene
  129779. */
  129780. export class GamepadSystemSceneComponent implements ISceneComponent {
  129781. /**
  129782. * The component name helpfull to identify the component in the list of scene components.
  129783. */
  129784. readonly name: string;
  129785. /**
  129786. * The scene the component belongs to.
  129787. */
  129788. scene: Scene;
  129789. /**
  129790. * Creates a new instance of the component for the given scene
  129791. * @param scene Defines the scene to register the component in
  129792. */
  129793. constructor(scene: Scene);
  129794. /**
  129795. * Registers the component in a given scene
  129796. */
  129797. register(): void;
  129798. /**
  129799. * Rebuilds the elements related to this component in case of
  129800. * context lost for instance.
  129801. */
  129802. rebuild(): void;
  129803. /**
  129804. * Disposes the component and the associated ressources
  129805. */
  129806. dispose(): void;
  129807. private _beforeCameraUpdate;
  129808. }
  129809. }
  129810. declare module BABYLON {
  129811. /**
  129812. * 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,
  129813. * which still works and will still be found in many Playgrounds.
  129814. * @see https://doc.babylonjs.com/features/cameras#universal-camera
  129815. */
  129816. export class UniversalCamera extends TouchCamera {
  129817. /**
  129818. * Defines the gamepad rotation sensiblity.
  129819. * This is the threshold from when rotation starts to be accounted for to prevent jittering.
  129820. */
  129821. get gamepadAngularSensibility(): number;
  129822. set gamepadAngularSensibility(value: number);
  129823. /**
  129824. * Defines the gamepad move sensiblity.
  129825. * This is the threshold from when moving starts to be accounted for for to prevent jittering.
  129826. */
  129827. get gamepadMoveSensibility(): number;
  129828. set gamepadMoveSensibility(value: number);
  129829. /**
  129830. * 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,
  129831. * which still works and will still be found in many Playgrounds.
  129832. * @see https://doc.babylonjs.com/features/cameras#universal-camera
  129833. * @param name Define the name of the camera in the scene
  129834. * @param position Define the start position of the camera in the scene
  129835. * @param scene Define the scene the camera belongs to
  129836. */
  129837. constructor(name: string, position: Vector3, scene: Scene);
  129838. /**
  129839. * Gets the current object class name.
  129840. * @return the class name
  129841. */
  129842. getClassName(): string;
  129843. }
  129844. }
  129845. declare module BABYLON {
  129846. /**
  129847. * This represents a FPS type of camera. This is only here for back compat purpose.
  129848. * Please use the UniversalCamera instead as both are identical.
  129849. * @see https://doc.babylonjs.com/features/cameras#universal-camera
  129850. */
  129851. export class GamepadCamera extends UniversalCamera {
  129852. /**
  129853. * Instantiates a new Gamepad Camera
  129854. * This represents a FPS type of camera. This is only here for back compat purpose.
  129855. * Please use the UniversalCamera instead as both are identical.
  129856. * @see https://doc.babylonjs.com/features/cameras#universal-camera
  129857. * @param name Define the name of the camera in the scene
  129858. * @param position Define the start position of the camera in the scene
  129859. * @param scene Define the scene the camera belongs to
  129860. */
  129861. constructor(name: string, position: Vector3, scene: Scene);
  129862. /**
  129863. * Gets the current object class name.
  129864. * @return the class name
  129865. */
  129866. getClassName(): string;
  129867. }
  129868. }
  129869. declare module BABYLON {
  129870. /** @hidden */
  129871. export var passPixelShader: {
  129872. name: string;
  129873. shader: string;
  129874. };
  129875. }
  129876. declare module BABYLON {
  129877. /** @hidden */
  129878. export var passCubePixelShader: {
  129879. name: string;
  129880. shader: string;
  129881. };
  129882. }
  129883. declare module BABYLON {
  129884. /**
  129885. * PassPostProcess which produces an output the same as it's input
  129886. */
  129887. export class PassPostProcess extends PostProcess {
  129888. /**
  129889. * Gets a string identifying the name of the class
  129890. * @returns "PassPostProcess" string
  129891. */
  129892. getClassName(): string;
  129893. /**
  129894. * Creates the PassPostProcess
  129895. * @param name The name of the effect.
  129896. * @param options The required width/height ratio to downsize to before computing the render pass.
  129897. * @param camera The camera to apply the render pass to.
  129898. * @param samplingMode The sampling mode to be used when computing the pass. (default: 0)
  129899. * @param engine The engine which the post process will be applied. (default: current engine)
  129900. * @param reusable If the post process can be reused on the same frame. (default: false)
  129901. * @param textureType The type of texture to be used when performing the post processing.
  129902. * @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)
  129903. */
  129904. constructor(name: string, options: number | PostProcessOptions, camera?: Nullable<Camera>, samplingMode?: number, engine?: Engine, reusable?: boolean, textureType?: number, blockCompilation?: boolean);
  129905. /** @hidden */
  129906. static _Parse(parsedPostProcess: any, targetCamera: Camera, scene: Scene, rootUrl: string): PassPostProcess;
  129907. }
  129908. /**
  129909. * PassCubePostProcess which produces an output the same as it's input (which must be a cube texture)
  129910. */
  129911. export class PassCubePostProcess extends PostProcess {
  129912. private _face;
  129913. /**
  129914. * Gets or sets the cube face to display.
  129915. * * 0 is +X
  129916. * * 1 is -X
  129917. * * 2 is +Y
  129918. * * 3 is -Y
  129919. * * 4 is +Z
  129920. * * 5 is -Z
  129921. */
  129922. get face(): number;
  129923. set face(value: number);
  129924. /**
  129925. * Gets a string identifying the name of the class
  129926. * @returns "PassCubePostProcess" string
  129927. */
  129928. getClassName(): string;
  129929. /**
  129930. * Creates the PassCubePostProcess
  129931. * @param name The name of the effect.
  129932. * @param options The required width/height ratio to downsize to before computing the render pass.
  129933. * @param camera The camera to apply the render pass to.
  129934. * @param samplingMode The sampling mode to be used when computing the pass. (default: 0)
  129935. * @param engine The engine which the post process will be applied. (default: current engine)
  129936. * @param reusable If the post process can be reused on the same frame. (default: false)
  129937. * @param textureType The type of texture to be used when performing the post processing.
  129938. * @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)
  129939. */
  129940. constructor(name: string, options: number | PostProcessOptions, camera?: Nullable<Camera>, samplingMode?: number, engine?: Engine, reusable?: boolean, textureType?: number, blockCompilation?: boolean);
  129941. /** @hidden */
  129942. static _Parse(parsedPostProcess: any, targetCamera: Camera, scene: Scene, rootUrl: string): PassCubePostProcess;
  129943. }
  129944. }
  129945. declare module BABYLON {
  129946. /** @hidden */
  129947. export var anaglyphPixelShader: {
  129948. name: string;
  129949. shader: string;
  129950. };
  129951. }
  129952. declare module BABYLON {
  129953. /**
  129954. * Postprocess used to generate anaglyphic rendering
  129955. */
  129956. export class AnaglyphPostProcess extends PostProcess {
  129957. private _passedProcess;
  129958. /**
  129959. * Gets a string identifying the name of the class
  129960. * @returns "AnaglyphPostProcess" string
  129961. */
  129962. getClassName(): string;
  129963. /**
  129964. * Creates a new AnaglyphPostProcess
  129965. * @param name defines postprocess name
  129966. * @param options defines creation options or target ratio scale
  129967. * @param rigCameras defines cameras using this postprocess
  129968. * @param samplingMode defines required sampling mode (BABYLON.Texture.NEAREST_SAMPLINGMODE by default)
  129969. * @param engine defines hosting engine
  129970. * @param reusable defines if the postprocess will be reused multiple times per frame
  129971. */
  129972. constructor(name: string, options: number | PostProcessOptions, rigCameras: Camera[], samplingMode?: number, engine?: Engine, reusable?: boolean);
  129973. }
  129974. }
  129975. declare module BABYLON {
  129976. /**
  129977. * Camera used to simulate anaglyphic rendering (based on ArcRotateCamera)
  129978. * @see https://doc.babylonjs.com/features/cameras#anaglyph-cameras
  129979. */
  129980. export class AnaglyphArcRotateCamera extends ArcRotateCamera {
  129981. /**
  129982. * Creates a new AnaglyphArcRotateCamera
  129983. * @param name defines camera name
  129984. * @param alpha defines alpha angle (in radians)
  129985. * @param beta defines beta angle (in radians)
  129986. * @param radius defines radius
  129987. * @param target defines camera target
  129988. * @param interaxialDistance defines distance between each color axis
  129989. * @param scene defines the hosting scene
  129990. */
  129991. constructor(name: string, alpha: number, beta: number, radius: number, target: Vector3, interaxialDistance: number, scene: Scene);
  129992. /**
  129993. * Gets camera class name
  129994. * @returns AnaglyphArcRotateCamera
  129995. */
  129996. getClassName(): string;
  129997. }
  129998. }
  129999. declare module BABYLON {
  130000. /**
  130001. * Camera used to simulate anaglyphic rendering (based on FreeCamera)
  130002. * @see https://doc.babylonjs.com/features/cameras#anaglyph-cameras
  130003. */
  130004. export class AnaglyphFreeCamera extends FreeCamera {
  130005. /**
  130006. * Creates a new AnaglyphFreeCamera
  130007. * @param name defines camera name
  130008. * @param position defines initial position
  130009. * @param interaxialDistance defines distance between each color axis
  130010. * @param scene defines the hosting scene
  130011. */
  130012. constructor(name: string, position: Vector3, interaxialDistance: number, scene: Scene);
  130013. /**
  130014. * Gets camera class name
  130015. * @returns AnaglyphFreeCamera
  130016. */
  130017. getClassName(): string;
  130018. }
  130019. }
  130020. declare module BABYLON {
  130021. /**
  130022. * Camera used to simulate anaglyphic rendering (based on GamepadCamera)
  130023. * @see https://doc.babylonjs.com/features/cameras#anaglyph-cameras
  130024. */
  130025. export class AnaglyphGamepadCamera extends GamepadCamera {
  130026. /**
  130027. * Creates a new AnaglyphGamepadCamera
  130028. * @param name defines camera name
  130029. * @param position defines initial position
  130030. * @param interaxialDistance defines distance between each color axis
  130031. * @param scene defines the hosting scene
  130032. */
  130033. constructor(name: string, position: Vector3, interaxialDistance: number, scene: Scene);
  130034. /**
  130035. * Gets camera class name
  130036. * @returns AnaglyphGamepadCamera
  130037. */
  130038. getClassName(): string;
  130039. }
  130040. }
  130041. declare module BABYLON {
  130042. /**
  130043. * Camera used to simulate anaglyphic rendering (based on UniversalCamera)
  130044. * @see https://doc.babylonjs.com/features/cameras#anaglyph-cameras
  130045. */
  130046. export class AnaglyphUniversalCamera extends UniversalCamera {
  130047. /**
  130048. * Creates a new AnaglyphUniversalCamera
  130049. * @param name defines camera name
  130050. * @param position defines initial position
  130051. * @param interaxialDistance defines distance between each color axis
  130052. * @param scene defines the hosting scene
  130053. */
  130054. constructor(name: string, position: Vector3, interaxialDistance: number, scene: Scene);
  130055. /**
  130056. * Gets camera class name
  130057. * @returns AnaglyphUniversalCamera
  130058. */
  130059. getClassName(): string;
  130060. }
  130061. }
  130062. declare module BABYLON {
  130063. /**
  130064. * Camera used to simulate stereoscopic rendering (based on ArcRotateCamera)
  130065. * @see https://doc.babylonjs.com/features/cameras
  130066. */
  130067. export class StereoscopicArcRotateCamera extends ArcRotateCamera {
  130068. /**
  130069. * Creates a new StereoscopicArcRotateCamera
  130070. * @param name defines camera name
  130071. * @param alpha defines alpha angle (in radians)
  130072. * @param beta defines beta angle (in radians)
  130073. * @param radius defines radius
  130074. * @param target defines camera target
  130075. * @param interaxialDistance defines distance between each color axis
  130076. * @param isStereoscopicSideBySide defines is stereoscopic is done side by side or over under
  130077. * @param scene defines the hosting scene
  130078. */
  130079. constructor(name: string, alpha: number, beta: number, radius: number, target: Vector3, interaxialDistance: number, isStereoscopicSideBySide: boolean, scene: Scene);
  130080. /**
  130081. * Gets camera class name
  130082. * @returns StereoscopicArcRotateCamera
  130083. */
  130084. getClassName(): string;
  130085. }
  130086. }
  130087. declare module BABYLON {
  130088. /**
  130089. * Camera used to simulate stereoscopic rendering (based on FreeCamera)
  130090. * @see https://doc.babylonjs.com/features/cameras
  130091. */
  130092. export class StereoscopicFreeCamera extends FreeCamera {
  130093. /**
  130094. * Creates a new StereoscopicFreeCamera
  130095. * @param name defines camera name
  130096. * @param position defines initial position
  130097. * @param interaxialDistance defines distance between each color axis
  130098. * @param isStereoscopicSideBySide defines is stereoscopic is done side by side or over under
  130099. * @param scene defines the hosting scene
  130100. */
  130101. constructor(name: string, position: Vector3, interaxialDistance: number, isStereoscopicSideBySide: boolean, scene: Scene);
  130102. /**
  130103. * Gets camera class name
  130104. * @returns StereoscopicFreeCamera
  130105. */
  130106. getClassName(): string;
  130107. }
  130108. }
  130109. declare module BABYLON {
  130110. /**
  130111. * Camera used to simulate stereoscopic rendering (based on GamepadCamera)
  130112. * @see https://doc.babylonjs.com/features/cameras
  130113. */
  130114. export class StereoscopicGamepadCamera extends GamepadCamera {
  130115. /**
  130116. * Creates a new StereoscopicGamepadCamera
  130117. * @param name defines camera name
  130118. * @param position defines initial position
  130119. * @param interaxialDistance defines distance between each color axis
  130120. * @param isStereoscopicSideBySide defines is stereoscopic is done side by side or over under
  130121. * @param scene defines the hosting scene
  130122. */
  130123. constructor(name: string, position: Vector3, interaxialDistance: number, isStereoscopicSideBySide: boolean, scene: Scene);
  130124. /**
  130125. * Gets camera class name
  130126. * @returns StereoscopicGamepadCamera
  130127. */
  130128. getClassName(): string;
  130129. }
  130130. }
  130131. declare module BABYLON {
  130132. /**
  130133. * Camera used to simulate stereoscopic rendering (based on UniversalCamera)
  130134. * @see https://doc.babylonjs.com/features/cameras
  130135. */
  130136. export class StereoscopicUniversalCamera extends UniversalCamera {
  130137. /**
  130138. * Creates a new StereoscopicUniversalCamera
  130139. * @param name defines camera name
  130140. * @param position defines initial position
  130141. * @param interaxialDistance defines distance between each color axis
  130142. * @param isStereoscopicSideBySide defines is stereoscopic is done side by side or over under
  130143. * @param scene defines the hosting scene
  130144. */
  130145. constructor(name: string, position: Vector3, interaxialDistance: number, isStereoscopicSideBySide: boolean, scene: Scene);
  130146. /**
  130147. * Gets camera class name
  130148. * @returns StereoscopicUniversalCamera
  130149. */
  130150. getClassName(): string;
  130151. }
  130152. }
  130153. declare module BABYLON {
  130154. /**
  130155. * This represents a free type of camera. It can be useful in First Person Shooter game for instance.
  130156. * It is identical to the Free Camera and simply adds by default a virtual joystick.
  130157. * Virtual Joysticks are on-screen 2D graphics that are used to control the camera or other scene items.
  130158. * @see https://doc.babylonjs.com/features/cameras#virtual-joysticks-camera
  130159. */
  130160. export class VirtualJoysticksCamera extends FreeCamera {
  130161. /**
  130162. * Intantiates a VirtualJoysticksCamera. It can be useful in First Person Shooter game for instance.
  130163. * It is identical to the Free Camera and simply adds by default a virtual joystick.
  130164. * Virtual Joysticks are on-screen 2D graphics that are used to control the camera or other scene items.
  130165. * @see https://doc.babylonjs.com/features/cameras#virtual-joysticks-camera
  130166. * @param name Define the name of the camera in the scene
  130167. * @param position Define the start position of the camera in the scene
  130168. * @param scene Define the scene the camera belongs to
  130169. */
  130170. constructor(name: string, position: Vector3, scene: Scene);
  130171. /**
  130172. * Gets the current object class name.
  130173. * @return the class name
  130174. */
  130175. getClassName(): string;
  130176. }
  130177. }
  130178. declare module BABYLON {
  130179. /**
  130180. * This represents all the required metrics to create a VR camera.
  130181. * @see https://doc.babylonjs.com/babylon101/cameras#device-orientation-camera
  130182. */
  130183. export class VRCameraMetrics {
  130184. /**
  130185. * Define the horizontal resolution off the screen.
  130186. */
  130187. hResolution: number;
  130188. /**
  130189. * Define the vertical resolution off the screen.
  130190. */
  130191. vResolution: number;
  130192. /**
  130193. * Define the horizontal screen size.
  130194. */
  130195. hScreenSize: number;
  130196. /**
  130197. * Define the vertical screen size.
  130198. */
  130199. vScreenSize: number;
  130200. /**
  130201. * Define the vertical screen center position.
  130202. */
  130203. vScreenCenter: number;
  130204. /**
  130205. * Define the distance of the eyes to the screen.
  130206. */
  130207. eyeToScreenDistance: number;
  130208. /**
  130209. * Define the distance between both lenses
  130210. */
  130211. lensSeparationDistance: number;
  130212. /**
  130213. * Define the distance between both viewer's eyes.
  130214. */
  130215. interpupillaryDistance: number;
  130216. /**
  130217. * Define the distortion factor of the VR postprocess.
  130218. * Please, touch with care.
  130219. */
  130220. distortionK: number[];
  130221. /**
  130222. * Define the chromatic aberration correction factors for the VR post process.
  130223. */
  130224. chromaAbCorrection: number[];
  130225. /**
  130226. * Define the scale factor of the post process.
  130227. * The smaller the better but the slower.
  130228. */
  130229. postProcessScaleFactor: number;
  130230. /**
  130231. * Define an offset for the lens center.
  130232. */
  130233. lensCenterOffset: number;
  130234. /**
  130235. * Define if the current vr camera should compensate the distortion of the lense or not.
  130236. */
  130237. compensateDistortion: boolean;
  130238. /**
  130239. * Defines if multiview should be enabled when rendering (Default: false)
  130240. */
  130241. multiviewEnabled: boolean;
  130242. /**
  130243. * Gets the rendering aspect ratio based on the provided resolutions.
  130244. */
  130245. get aspectRatio(): number;
  130246. /**
  130247. * Gets the aspect ratio based on the FOV, scale factors, and real screen sizes.
  130248. */
  130249. get aspectRatioFov(): number;
  130250. /**
  130251. * @hidden
  130252. */
  130253. get leftHMatrix(): Matrix;
  130254. /**
  130255. * @hidden
  130256. */
  130257. get rightHMatrix(): Matrix;
  130258. /**
  130259. * @hidden
  130260. */
  130261. get leftPreViewMatrix(): Matrix;
  130262. /**
  130263. * @hidden
  130264. */
  130265. get rightPreViewMatrix(): Matrix;
  130266. /**
  130267. * Get the default VRMetrics based on the most generic setup.
  130268. * @returns the default vr metrics
  130269. */
  130270. static GetDefault(): VRCameraMetrics;
  130271. }
  130272. }
  130273. declare module BABYLON {
  130274. /** @hidden */
  130275. export var vrDistortionCorrectionPixelShader: {
  130276. name: string;
  130277. shader: string;
  130278. };
  130279. }
  130280. declare module BABYLON {
  130281. /**
  130282. * VRDistortionCorrectionPostProcess used for mobile VR
  130283. */
  130284. export class VRDistortionCorrectionPostProcess extends PostProcess {
  130285. private _isRightEye;
  130286. private _distortionFactors;
  130287. private _postProcessScaleFactor;
  130288. private _lensCenterOffset;
  130289. private _scaleIn;
  130290. private _scaleFactor;
  130291. private _lensCenter;
  130292. /**
  130293. * Gets a string identifying the name of the class
  130294. * @returns "VRDistortionCorrectionPostProcess" string
  130295. */
  130296. getClassName(): string;
  130297. /**
  130298. * Initializes the VRDistortionCorrectionPostProcess
  130299. * @param name The name of the effect.
  130300. * @param camera The camera to apply the render pass to.
  130301. * @param isRightEye If this is for the right eye distortion
  130302. * @param vrMetrics All the required metrics for the VR camera
  130303. */
  130304. constructor(name: string, camera: Camera, isRightEye: boolean, vrMetrics: VRCameraMetrics);
  130305. }
  130306. }
  130307. declare module BABYLON {
  130308. /**
  130309. * Camera used to simulate VR rendering (based on ArcRotateCamera)
  130310. * @see https://doc.babylonjs.com/babylon101/cameras#vr-device-orientation-cameras
  130311. */
  130312. export class VRDeviceOrientationArcRotateCamera extends ArcRotateCamera {
  130313. /**
  130314. * Creates a new VRDeviceOrientationArcRotateCamera
  130315. * @param name defines camera name
  130316. * @param alpha defines the camera rotation along the logitudinal axis
  130317. * @param beta defines the camera rotation along the latitudinal axis
  130318. * @param radius defines the camera distance from its target
  130319. * @param target defines the camera target
  130320. * @param scene defines the scene the camera belongs to
  130321. * @param compensateDistortion defines if the camera needs to compensate the lens distorsion
  130322. * @param vrCameraMetrics defines the vr metrics associated to the camera
  130323. */
  130324. constructor(name: string, alpha: number, beta: number, radius: number, target: Vector3, scene: Scene, compensateDistortion?: boolean, vrCameraMetrics?: VRCameraMetrics);
  130325. /**
  130326. * Gets camera class name
  130327. * @returns VRDeviceOrientationArcRotateCamera
  130328. */
  130329. getClassName(): string;
  130330. }
  130331. }
  130332. declare module BABYLON {
  130333. /**
  130334. * Camera used to simulate VR rendering (based on FreeCamera)
  130335. * @see https://doc.babylonjs.com/babylon101/cameras#vr-device-orientation-cameras
  130336. */
  130337. export class VRDeviceOrientationFreeCamera extends DeviceOrientationCamera {
  130338. /**
  130339. * Creates a new VRDeviceOrientationFreeCamera
  130340. * @param name defines camera name
  130341. * @param position defines the start position of the camera
  130342. * @param scene defines the scene the camera belongs to
  130343. * @param compensateDistortion defines if the camera needs to compensate the lens distorsion
  130344. * @param vrCameraMetrics defines the vr metrics associated to the camera
  130345. */
  130346. constructor(name: string, position: Vector3, scene: Scene, compensateDistortion?: boolean, vrCameraMetrics?: VRCameraMetrics);
  130347. /**
  130348. * Gets camera class name
  130349. * @returns VRDeviceOrientationFreeCamera
  130350. */
  130351. getClassName(): string;
  130352. }
  130353. }
  130354. declare module BABYLON {
  130355. /**
  130356. * Camera used to simulate VR rendering (based on VRDeviceOrientationFreeCamera)
  130357. * @see https://doc.babylonjs.com/babylon101/cameras#vr-device-orientation-cameras
  130358. */
  130359. export class VRDeviceOrientationGamepadCamera extends VRDeviceOrientationFreeCamera {
  130360. /**
  130361. * Creates a new VRDeviceOrientationGamepadCamera
  130362. * @param name defines camera name
  130363. * @param position defines the start position of the camera
  130364. * @param scene defines the scene the camera belongs to
  130365. * @param compensateDistortion defines if the camera needs to compensate the lens distorsion
  130366. * @param vrCameraMetrics defines the vr metrics associated to the camera
  130367. */
  130368. constructor(name: string, position: Vector3, scene: Scene, compensateDistortion?: boolean, vrCameraMetrics?: VRCameraMetrics);
  130369. /**
  130370. * Gets camera class name
  130371. * @returns VRDeviceOrientationGamepadCamera
  130372. */
  130373. getClassName(): string;
  130374. }
  130375. }
  130376. declare module BABYLON {
  130377. /**
  130378. * A class extending Texture allowing drawing on a texture
  130379. * @see https://doc.babylonjs.com/how_to/dynamictexture
  130380. */
  130381. export class DynamicTexture extends Texture {
  130382. private _generateMipMaps;
  130383. private _canvas;
  130384. private _context;
  130385. /**
  130386. * Creates a DynamicTexture
  130387. * @param name defines the name of the texture
  130388. * @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
  130389. * @param scene defines the scene where you want the texture
  130390. * @param generateMipMaps defines the use of MinMaps or not (default is false)
  130391. * @param samplingMode defines the sampling mode to use (default is Texture.TRILINEAR_SAMPLINGMODE)
  130392. * @param format defines the texture format to use (default is Engine.TEXTUREFORMAT_RGBA)
  130393. * @param invertY defines if the texture needs to be inverted on the y axis during loading
  130394. */
  130395. constructor(name: string, options: any, scene: Scene | null | undefined, generateMipMaps: boolean, samplingMode?: number, format?: number, invertY?: boolean);
  130396. /**
  130397. * Get the current class name of the texture useful for serialization or dynamic coding.
  130398. * @returns "DynamicTexture"
  130399. */
  130400. getClassName(): string;
  130401. /**
  130402. * Gets the current state of canRescale
  130403. */
  130404. get canRescale(): boolean;
  130405. private _recreate;
  130406. /**
  130407. * Scales the texture
  130408. * @param ratio the scale factor to apply to both width and height
  130409. */
  130410. scale(ratio: number): void;
  130411. /**
  130412. * Resizes the texture
  130413. * @param width the new width
  130414. * @param height the new height
  130415. */
  130416. scaleTo(width: number, height: number): void;
  130417. /**
  130418. * Gets the context of the canvas used by the texture
  130419. * @returns the canvas context of the dynamic texture
  130420. */
  130421. getContext(): CanvasRenderingContext2D;
  130422. /**
  130423. * Clears the texture
  130424. */
  130425. clear(): void;
  130426. /**
  130427. * Updates the texture
  130428. * @param invertY defines the direction for the Y axis (default is true - y increases downwards)
  130429. * @param premulAlpha defines if alpha is stored as premultiplied (default is false)
  130430. */
  130431. update(invertY?: boolean, premulAlpha?: boolean): void;
  130432. /**
  130433. * Draws text onto the texture
  130434. * @param text defines the text to be drawn
  130435. * @param x defines the placement of the text from the left
  130436. * @param y defines the placement of the text from the top when invertY is true and from the bottom when false
  130437. * @param font defines the font to be used with font-style, font-size, font-name
  130438. * @param color defines the color used for the text
  130439. * @param clearColor defines the color for the canvas, use null to not overwrite canvas
  130440. * @param invertY defines the direction for the Y axis (default is true - y increases downwards)
  130441. * @param update defines whether texture is immediately update (default is true)
  130442. */
  130443. drawText(text: string, x: number | null | undefined, y: number | null | undefined, font: string, color: string | null, clearColor: string, invertY?: boolean, update?: boolean): void;
  130444. /**
  130445. * Clones the texture
  130446. * @returns the clone of the texture.
  130447. */
  130448. clone(): DynamicTexture;
  130449. /**
  130450. * Serializes the dynamic texture. The scene should be ready before the dynamic texture is serialized
  130451. * @returns a serialized dynamic texture object
  130452. */
  130453. serialize(): any;
  130454. private _IsCanvasElement;
  130455. /** @hidden */
  130456. _rebuild(): void;
  130457. }
  130458. }
  130459. declare module BABYLON {
  130460. /**
  130461. * Class containing static functions to help procedurally build meshes
  130462. */
  130463. export class GroundBuilder {
  130464. /**
  130465. * Creates a ground mesh
  130466. * * The parameters `width` and `height` (floats, default 1) set the width and height sizes of the ground
  130467. * * The parameter `subdivisions` (positive integer) sets the number of subdivisions per side
  130468. * * The mesh can be set to updatable with the boolean parameter `updatable` (default false) if its internal geometry is supposed to change once created
  130469. * @param name defines the name of the mesh
  130470. * @param options defines the options used to create the mesh
  130471. * @param scene defines the hosting scene
  130472. * @returns the ground mesh
  130473. * @see https://doc.babylonjs.com/how_to/set_shapes#ground
  130474. */
  130475. static CreateGround(name: string, options: {
  130476. width?: number;
  130477. height?: number;
  130478. subdivisions?: number;
  130479. subdivisionsX?: number;
  130480. subdivisionsY?: number;
  130481. updatable?: boolean;
  130482. }, scene: any): Mesh;
  130483. /**
  130484. * Creates a tiled ground mesh
  130485. * * The parameters `xmin` and `xmax` (floats, default -1 and 1) set the ground minimum and maximum X coordinates
  130486. * * The parameters `zmin` and `zmax` (floats, default -1 and 1) set the ground minimum and maximum Z coordinates
  130487. * * 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
  130488. * * 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
  130489. * * The mesh can be set to updatable with the boolean parameter `updatable` (default false) if its internal geometry is supposed to change once created.
  130490. * @param name defines the name of the mesh
  130491. * @param options defines the options used to create the mesh
  130492. * @param scene defines the hosting scene
  130493. * @returns the tiled ground mesh
  130494. * @see https://doc.babylonjs.com/how_to/set_shapes#tiled-ground
  130495. */
  130496. static CreateTiledGround(name: string, options: {
  130497. xmin: number;
  130498. zmin: number;
  130499. xmax: number;
  130500. zmax: number;
  130501. subdivisions?: {
  130502. w: number;
  130503. h: number;
  130504. };
  130505. precision?: {
  130506. w: number;
  130507. h: number;
  130508. };
  130509. updatable?: boolean;
  130510. }, scene?: Nullable<Scene>): Mesh;
  130511. /**
  130512. * Creates a ground mesh from a height map
  130513. * * The parameter `url` sets the URL of the height map image resource.
  130514. * * The parameters `width` and `height` (positive floats, default 10) set the ground width and height sizes.
  130515. * * The parameter `subdivisions` (positive integer, default 1) sets the number of subdivision per side.
  130516. * * The parameter `minHeight` (float, default 0) is the minimum altitude on the ground.
  130517. * * The parameter `maxHeight` (float, default 1) is the maximum altitude on the ground.
  130518. * * 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.
  130519. * * 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).
  130520. * * The parameter `alphaFilter` will filter any data where the alpha channel is below this value, defaults 0 (all data visible)
  130521. * * The mesh can be set to updatable with the boolean parameter `updatable` (default false) if its internal geometry is supposed to change once created.
  130522. * @param name defines the name of the mesh
  130523. * @param url defines the url to the height map
  130524. * @param options defines the options used to create the mesh
  130525. * @param scene defines the hosting scene
  130526. * @returns the ground mesh
  130527. * @see https://doc.babylonjs.com/babylon101/height_map
  130528. * @see https://doc.babylonjs.com/how_to/set_shapes#ground-from-a-height-map
  130529. */
  130530. static CreateGroundFromHeightMap(name: string, url: string, options: {
  130531. width?: number;
  130532. height?: number;
  130533. subdivisions?: number;
  130534. minHeight?: number;
  130535. maxHeight?: number;
  130536. colorFilter?: Color3;
  130537. alphaFilter?: number;
  130538. updatable?: boolean;
  130539. onReady?: (mesh: GroundMesh) => void;
  130540. }, scene?: Nullable<Scene>): GroundMesh;
  130541. }
  130542. }
  130543. declare module BABYLON {
  130544. /**
  130545. * Class containing static functions to help procedurally build meshes
  130546. */
  130547. export class TorusBuilder {
  130548. /**
  130549. * Creates a torus mesh
  130550. * * The parameter `diameter` sets the diameter size (float) of the torus (default 1)
  130551. * * The parameter `thickness` sets the diameter size of the tube of the torus (float, default 0.5)
  130552. * * The parameter `tessellation` sets the number of torus sides (postive integer, default 16)
  130553. * * You can also set the mesh side orientation with the values : BABYLON.Mesh.FRONTSIDE (default), BABYLON.Mesh.BACKSIDE or BABYLON.Mesh.DOUBLESIDE
  130554. * * If you create a double-sided mesh, you can choose what parts of the texture image to crop and stick respectively on the front and the back sides with the parameters `frontUVs` and `backUVs` (Vector4). Detail here : https://doc.babylonjs.com/babylon101/discover_basic_elements#side-orientation
  130555. * * The mesh can be set to updatable with the boolean parameter `updatable` (default false) if its internal geometry is supposed to change once created.
  130556. * @param name defines the name of the mesh
  130557. * @param options defines the options used to create the mesh
  130558. * @param scene defines the hosting scene
  130559. * @returns the torus mesh
  130560. * @see https://doc.babylonjs.com/how_to/set_shapes#torus
  130561. */
  130562. static CreateTorus(name: string, options: {
  130563. diameter?: number;
  130564. thickness?: number;
  130565. tessellation?: number;
  130566. updatable?: boolean;
  130567. sideOrientation?: number;
  130568. frontUVs?: Vector4;
  130569. backUVs?: Vector4;
  130570. }, scene: any): Mesh;
  130571. }
  130572. }
  130573. declare module BABYLON {
  130574. /**
  130575. * Class containing static functions to help procedurally build meshes
  130576. */
  130577. export class CylinderBuilder {
  130578. /**
  130579. * Creates a cylinder or a cone mesh
  130580. * * The parameter `height` sets the height size (float) of the cylinder/cone (float, default 2).
  130581. * * The parameter `diameter` sets the diameter of the top and bottom cap at once (float, default 1).
  130582. * * 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.
  130583. * * The parameter `tessellation` sets the number of cylinder sides (positive integer, default 24). Set it to 3 to get a prism for instance.
  130584. * * The parameter `subdivisions` sets the number of rings along the cylinder height (positive integer, default 1).
  130585. * * The parameter `hasRings` (boolean, default false) makes the subdivisions independent from each other, so they become different faces.
  130586. * * The parameter `enclose` (boolean, default false) adds two extra faces per subdivision to a sliced cylinder to close it around its height axis.
  130587. * * 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).
  130588. * * The parameter `arc` (float, default 1) is the ratio (max 1) to apply to the circumference to slice the cylinder.
  130589. * * 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).
  130590. * * 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
  130591. * * Now, if the cylinder has 5 independent subdivisions (hasRings = true), n equals : top face + 5 stripe surfaces + bottom face = 2 + 5 = 7
  130592. * * 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
  130593. * * 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.
  130594. * * If `enclose` is false, a ring surface is one element.
  130595. * * If `enclose` is true, a ring surface is 3 successive elements in the array : the tubular surface, then the two closing faces.
  130596. * * 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
  130597. * * You can also set the mesh side orientation with the values : BABYLON.Mesh.FRONTSIDE (default), BABYLON.Mesh.BACKSIDE or BABYLON.Mesh.DOUBLESIDE
  130598. * * If you create a double-sided mesh, you can choose what parts of the texture image to crop and stick respectively on the front and the back sides with the parameters `frontUVs` and `backUVs` (Vector4). Detail here : https://doc.babylonjs.com/babylon101/discover_basic_elements#side-orientation
  130599. * * The mesh can be set to updatable with the boolean parameter `updatable` (default false) if its internal geometry is supposed to change once created.
  130600. * @param name defines the name of the mesh
  130601. * @param options defines the options used to create the mesh
  130602. * @param scene defines the hosting scene
  130603. * @returns the cylinder mesh
  130604. * @see https://doc.babylonjs.com/how_to/set_shapes#cylinder-or-cone
  130605. */
  130606. static CreateCylinder(name: string, options: {
  130607. height?: number;
  130608. diameterTop?: number;
  130609. diameterBottom?: number;
  130610. diameter?: number;
  130611. tessellation?: number;
  130612. subdivisions?: number;
  130613. arc?: number;
  130614. faceColors?: Color4[];
  130615. faceUV?: Vector4[];
  130616. updatable?: boolean;
  130617. hasRings?: boolean;
  130618. enclose?: boolean;
  130619. cap?: number;
  130620. sideOrientation?: number;
  130621. frontUVs?: Vector4;
  130622. backUVs?: Vector4;
  130623. }, scene: any): Mesh;
  130624. }
  130625. }
  130626. declare module BABYLON {
  130627. /**
  130628. * States of the webXR experience
  130629. */
  130630. export enum WebXRState {
  130631. /**
  130632. * Transitioning to being in XR mode
  130633. */
  130634. ENTERING_XR = 0,
  130635. /**
  130636. * Transitioning to non XR mode
  130637. */
  130638. EXITING_XR = 1,
  130639. /**
  130640. * In XR mode and presenting
  130641. */
  130642. IN_XR = 2,
  130643. /**
  130644. * Not entered XR mode
  130645. */
  130646. NOT_IN_XR = 3
  130647. }
  130648. /**
  130649. * The state of the XR camera's tracking
  130650. */
  130651. export enum WebXRTrackingState {
  130652. /**
  130653. * No transformation received, device is not being tracked
  130654. */
  130655. NOT_TRACKING = 0,
  130656. /**
  130657. * Tracking lost - using emulated position
  130658. */
  130659. TRACKING_LOST = 1,
  130660. /**
  130661. * Transformation tracking works normally
  130662. */
  130663. TRACKING = 2
  130664. }
  130665. /**
  130666. * Abstraction of the XR render target
  130667. */
  130668. export interface WebXRRenderTarget extends IDisposable {
  130669. /**
  130670. * xrpresent context of the canvas which can be used to display/mirror xr content
  130671. */
  130672. canvasContext: WebGLRenderingContext;
  130673. /**
  130674. * xr layer for the canvas
  130675. */
  130676. xrLayer: Nullable<XRWebGLLayer>;
  130677. /**
  130678. * Initializes the xr layer for the session
  130679. * @param xrSession xr session
  130680. * @returns a promise that will resolve once the XR Layer has been created
  130681. */
  130682. initializeXRLayerAsync(xrSession: XRSession): Promise<XRWebGLLayer>;
  130683. }
  130684. }
  130685. declare module BABYLON {
  130686. /**
  130687. * COnfiguration object for WebXR output canvas
  130688. */
  130689. export class WebXRManagedOutputCanvasOptions {
  130690. /**
  130691. * An optional canvas in case you wish to create it yourself and provide it here.
  130692. * If not provided, a new canvas will be created
  130693. */
  130694. canvasElement?: HTMLCanvasElement;
  130695. /**
  130696. * Options for this XR Layer output
  130697. */
  130698. canvasOptions?: XRWebGLLayerOptions;
  130699. /**
  130700. * CSS styling for a newly created canvas (if not provided)
  130701. */
  130702. newCanvasCssStyle?: string;
  130703. /**
  130704. * Get the default values of the configuration object
  130705. * @param engine defines the engine to use (can be null)
  130706. * @returns default values of this configuration object
  130707. */
  130708. static GetDefaults(engine?: ThinEngine): WebXRManagedOutputCanvasOptions;
  130709. }
  130710. /**
  130711. * Creates a canvas that is added/removed from the webpage when entering/exiting XR
  130712. */
  130713. export class WebXRManagedOutputCanvas implements WebXRRenderTarget {
  130714. private _options;
  130715. private _canvas;
  130716. private _engine;
  130717. private _originalCanvasSize;
  130718. /**
  130719. * Rendering context of the canvas which can be used to display/mirror xr content
  130720. */
  130721. canvasContext: WebGLRenderingContext;
  130722. /**
  130723. * xr layer for the canvas
  130724. */
  130725. xrLayer: Nullable<XRWebGLLayer>;
  130726. /**
  130727. * Obseervers registered here will be triggered when the xr layer was initialized
  130728. */
  130729. onXRLayerInitObservable: Observable<XRWebGLLayer>;
  130730. /**
  130731. * Initializes the canvas to be added/removed upon entering/exiting xr
  130732. * @param _xrSessionManager The XR Session manager
  130733. * @param _options optional configuration for this canvas output. defaults will be used if not provided
  130734. */
  130735. constructor(_xrSessionManager: WebXRSessionManager, _options?: WebXRManagedOutputCanvasOptions);
  130736. /**
  130737. * Disposes of the object
  130738. */
  130739. dispose(): void;
  130740. /**
  130741. * Initializes the xr layer for the session
  130742. * @param xrSession xr session
  130743. * @returns a promise that will resolve once the XR Layer has been created
  130744. */
  130745. initializeXRLayerAsync(xrSession: XRSession): Promise<XRWebGLLayer>;
  130746. private _addCanvas;
  130747. private _removeCanvas;
  130748. private _setCanvasSize;
  130749. private _setManagedOutputCanvas;
  130750. }
  130751. }
  130752. declare module BABYLON {
  130753. /**
  130754. * Manages an XRSession to work with Babylon's engine
  130755. * @see https://doc.babylonjs.com/how_to/webxr_session_manager
  130756. */
  130757. export class WebXRSessionManager implements IDisposable {
  130758. /** The scene which the session should be created for */
  130759. scene: Scene;
  130760. private _referenceSpace;
  130761. private _rttProvider;
  130762. private _sessionEnded;
  130763. private _xrNavigator;
  130764. private baseLayer;
  130765. /**
  130766. * The base reference space from which the session started. good if you want to reset your
  130767. * reference space
  130768. */
  130769. baseReferenceSpace: XRReferenceSpace;
  130770. /**
  130771. * Current XR frame
  130772. */
  130773. currentFrame: Nullable<XRFrame>;
  130774. /** WebXR timestamp updated every frame */
  130775. currentTimestamp: number;
  130776. /**
  130777. * Used just in case of a failure to initialize an immersive session.
  130778. * The viewer reference space is compensated using this height, creating a kind of "viewer-floor" reference space
  130779. */
  130780. defaultHeightCompensation: number;
  130781. /**
  130782. * Fires every time a new xrFrame arrives which can be used to update the camera
  130783. */
  130784. onXRFrameObservable: Observable<XRFrame>;
  130785. /**
  130786. * Fires when the reference space changed
  130787. */
  130788. onXRReferenceSpaceChanged: Observable<XRReferenceSpace>;
  130789. /**
  130790. * Fires when the xr session is ended either by the device or manually done
  130791. */
  130792. onXRSessionEnded: Observable<any>;
  130793. /**
  130794. * Fires when the xr session is ended either by the device or manually done
  130795. */
  130796. onXRSessionInit: Observable<XRSession>;
  130797. /**
  130798. * Underlying xr session
  130799. */
  130800. session: XRSession;
  130801. /**
  130802. * The viewer (head position) reference space. This can be used to get the XR world coordinates
  130803. * or get the offset the player is currently at.
  130804. */
  130805. viewerReferenceSpace: XRReferenceSpace;
  130806. /**
  130807. * Constructs a WebXRSessionManager, this must be initialized within a user action before usage
  130808. * @param scene The scene which the session should be created for
  130809. */
  130810. constructor(
  130811. /** The scene which the session should be created for */
  130812. scene: Scene);
  130813. /**
  130814. * The current reference space used in this session. This reference space can constantly change!
  130815. * It is mainly used to offset the camera's position.
  130816. */
  130817. get referenceSpace(): XRReferenceSpace;
  130818. /**
  130819. * Set a new reference space and triggers the observable
  130820. */
  130821. set referenceSpace(newReferenceSpace: XRReferenceSpace);
  130822. /**
  130823. * Disposes of the session manager
  130824. */
  130825. dispose(): void;
  130826. /**
  130827. * Stops the xrSession and restores the render loop
  130828. * @returns Promise which resolves after it exits XR
  130829. */
  130830. exitXRAsync(): Promise<void>;
  130831. /**
  130832. * Gets the correct render target texture to be rendered this frame for this eye
  130833. * @param eye the eye for which to get the render target
  130834. * @returns the render target for the specified eye
  130835. */
  130836. getRenderTargetTextureForEye(eye: XREye): RenderTargetTexture;
  130837. /**
  130838. * Creates a WebXRRenderTarget object for the XR session
  130839. * @param onStateChangedObservable optional, mechanism for enabling/disabling XR rendering canvas, used only on Web
  130840. * @param options optional options to provide when creating a new render target
  130841. * @returns a WebXR render target to which the session can render
  130842. */
  130843. getWebXRRenderTarget(options?: WebXRManagedOutputCanvasOptions): WebXRRenderTarget;
  130844. /**
  130845. * Initializes the manager
  130846. * After initialization enterXR can be called to start an XR session
  130847. * @returns Promise which resolves after it is initialized
  130848. */
  130849. initializeAsync(): Promise<void>;
  130850. /**
  130851. * Initializes an xr session
  130852. * @param xrSessionMode mode to initialize
  130853. * @param xrSessionInit defines optional and required values to pass to the session builder
  130854. * @returns a promise which will resolve once the session has been initialized
  130855. */
  130856. initializeSessionAsync(xrSessionMode?: XRSessionMode, xrSessionInit?: XRSessionInit): Promise<XRSession>;
  130857. /**
  130858. * Checks if a session would be supported for the creation options specified
  130859. * @param sessionMode session mode to check if supported eg. immersive-vr
  130860. * @returns A Promise that resolves to true if supported and false if not
  130861. */
  130862. isSessionSupportedAsync(sessionMode: XRSessionMode): Promise<boolean>;
  130863. /**
  130864. * Resets the reference space to the one started the session
  130865. */
  130866. resetReferenceSpace(): void;
  130867. /**
  130868. * Starts rendering to the xr layer
  130869. */
  130870. runXRRenderLoop(): void;
  130871. /**
  130872. * Sets the reference space on the xr session
  130873. * @param referenceSpaceType space to set
  130874. * @returns a promise that will resolve once the reference space has been set
  130875. */
  130876. setReferenceSpaceTypeAsync(referenceSpaceType?: XRReferenceSpaceType): Promise<XRReferenceSpace>;
  130877. /**
  130878. * Updates the render state of the session
  130879. * @param state state to set
  130880. * @returns a promise that resolves once the render state has been updated
  130881. */
  130882. updateRenderStateAsync(state: XRRenderState): Promise<void>;
  130883. /**
  130884. * Returns a promise that resolves with a boolean indicating if the provided session mode is supported by this browser
  130885. * @param sessionMode defines the session to test
  130886. * @returns a promise with boolean as final value
  130887. */
  130888. static IsSessionSupportedAsync(sessionMode: XRSessionMode): Promise<boolean>;
  130889. private _createRenderTargetTexture;
  130890. }
  130891. }
  130892. declare module BABYLON {
  130893. /**
  130894. * WebXR Camera which holds the views for the xrSession
  130895. * @see https://doc.babylonjs.com/how_to/webxr_camera
  130896. */
  130897. export class WebXRCamera extends FreeCamera {
  130898. private _xrSessionManager;
  130899. private _firstFrame;
  130900. private _referenceQuaternion;
  130901. private _referencedPosition;
  130902. private _xrInvPositionCache;
  130903. private _xrInvQuaternionCache;
  130904. private _trackingState;
  130905. /**
  130906. * Observable raised before camera teleportation
  130907. */
  130908. onBeforeCameraTeleport: Observable<Vector3>;
  130909. /**
  130910. * Observable raised after camera teleportation
  130911. */
  130912. onAfterCameraTeleport: Observable<Vector3>;
  130913. /**
  130914. * Notifies when the camera's tracking state has changed.
  130915. * Notice - will also be triggered when tracking has started (at the beginning of the session)
  130916. */
  130917. onTrackingStateChanged: Observable<WebXRTrackingState>;
  130918. /**
  130919. * Should position compensation execute on first frame.
  130920. * This is used when copying the position from a native (non XR) camera
  130921. */
  130922. compensateOnFirstFrame: boolean;
  130923. /**
  130924. * Creates a new webXRCamera, this should only be set at the camera after it has been updated by the xrSessionManager
  130925. * @param name the name of the camera
  130926. * @param scene the scene to add the camera to
  130927. * @param _xrSessionManager a constructed xr session manager
  130928. */
  130929. constructor(name: string, scene: Scene, _xrSessionManager: WebXRSessionManager);
  130930. /**
  130931. * Get the current XR tracking state of the camera
  130932. */
  130933. get trackingState(): WebXRTrackingState;
  130934. private _setTrackingState;
  130935. /**
  130936. * Return the user's height, unrelated to the current ground.
  130937. * This will be the y position of this camera, when ground level is 0.
  130938. */
  130939. get realWorldHeight(): number;
  130940. /** @hidden */
  130941. _updateForDualEyeDebugging(): void;
  130942. /**
  130943. * Sets this camera's transformation based on a non-vr camera
  130944. * @param otherCamera the non-vr camera to copy the transformation from
  130945. * @param resetToBaseReferenceSpace should XR reset to the base reference space
  130946. */
  130947. setTransformationFromNonVRCamera(otherCamera?: Camera, resetToBaseReferenceSpace?: boolean): void;
  130948. /**
  130949. * Gets the current instance class name ("WebXRCamera").
  130950. * @returns the class name
  130951. */
  130952. getClassName(): string;
  130953. private _rotate180;
  130954. private _updateFromXRSession;
  130955. private _updateNumberOfRigCameras;
  130956. private _updateReferenceSpace;
  130957. private _updateReferenceSpaceOffset;
  130958. }
  130959. }
  130960. declare module BABYLON {
  130961. /**
  130962. * Defining the interface required for a (webxr) feature
  130963. */
  130964. export interface IWebXRFeature extends IDisposable {
  130965. /**
  130966. * Is this feature attached
  130967. */
  130968. attached: boolean;
  130969. /**
  130970. * Should auto-attach be disabled?
  130971. */
  130972. disableAutoAttach: boolean;
  130973. /**
  130974. * Attach the feature to the session
  130975. * Will usually be called by the features manager
  130976. *
  130977. * @param force should attachment be forced (even when already attached)
  130978. * @returns true if successful.
  130979. */
  130980. attach(force?: boolean): boolean;
  130981. /**
  130982. * Detach the feature from the session
  130983. * Will usually be called by the features manager
  130984. *
  130985. * @returns true if successful.
  130986. */
  130987. detach(): boolean;
  130988. /**
  130989. * This function will be executed during before enabling the feature and can be used to not-allow enabling it.
  130990. * Note that at this point the session has NOT started, so this is purely checking if the browser supports it
  130991. *
  130992. * @returns whether or not the feature is compatible in this environment
  130993. */
  130994. isCompatible(): boolean;
  130995. /**
  130996. * Was this feature disposed;
  130997. */
  130998. isDisposed: boolean;
  130999. /**
  131000. * The name of the native xr feature name, if applicable (like anchor, hit-test, or hand-tracking)
  131001. */
  131002. xrNativeFeatureName?: string;
  131003. /**
  131004. * A list of (Babylon WebXR) features this feature depends on
  131005. */
  131006. dependsOn?: string[];
  131007. }
  131008. /**
  131009. * A list of the currently available features without referencing them
  131010. */
  131011. export class WebXRFeatureName {
  131012. /**
  131013. * The name of the anchor system feature
  131014. */
  131015. static readonly ANCHOR_SYSTEM: string;
  131016. /**
  131017. * The name of the background remover feature
  131018. */
  131019. static readonly BACKGROUND_REMOVER: string;
  131020. /**
  131021. * The name of the hit test feature
  131022. */
  131023. static readonly HIT_TEST: string;
  131024. /**
  131025. * physics impostors for xr controllers feature
  131026. */
  131027. static readonly PHYSICS_CONTROLLERS: string;
  131028. /**
  131029. * The name of the plane detection feature
  131030. */
  131031. static readonly PLANE_DETECTION: string;
  131032. /**
  131033. * The name of the pointer selection feature
  131034. */
  131035. static readonly POINTER_SELECTION: string;
  131036. /**
  131037. * The name of the teleportation feature
  131038. */
  131039. static readonly TELEPORTATION: string;
  131040. /**
  131041. * The name of the feature points feature.
  131042. */
  131043. static readonly FEATURE_POINTS: string;
  131044. /**
  131045. * The name of the hand tracking feature.
  131046. */
  131047. static readonly HAND_TRACKING: string;
  131048. }
  131049. /**
  131050. * Defining the constructor of a feature. Used to register the modules.
  131051. */
  131052. export type WebXRFeatureConstructor = (xrSessionManager: WebXRSessionManager, options?: any) => () => IWebXRFeature;
  131053. /**
  131054. * The WebXR features manager is responsible of enabling or disabling features required for the current XR session.
  131055. * It is mainly used in AR sessions.
  131056. *
  131057. * A feature can have a version that is defined by Babylon (and does not correspond with the webxr version).
  131058. */
  131059. export class WebXRFeaturesManager implements IDisposable {
  131060. private _xrSessionManager;
  131061. private static readonly _AvailableFeatures;
  131062. private _features;
  131063. /**
  131064. * constructs a new features manages.
  131065. *
  131066. * @param _xrSessionManager an instance of WebXRSessionManager
  131067. */
  131068. constructor(_xrSessionManager: WebXRSessionManager);
  131069. /**
  131070. * Used to register a module. After calling this function a developer can use this feature in the scene.
  131071. * Mainly used internally.
  131072. *
  131073. * @param featureName the name of the feature to register
  131074. * @param constructorFunction the function used to construct the module
  131075. * @param version the (babylon) version of the module
  131076. * @param stable is that a stable version of this module
  131077. */
  131078. static AddWebXRFeature(featureName: string, constructorFunction: WebXRFeatureConstructor, version?: number, stable?: boolean): void;
  131079. /**
  131080. * Returns a constructor of a specific feature.
  131081. *
  131082. * @param featureName the name of the feature to construct
  131083. * @param version the version of the feature to load
  131084. * @param xrSessionManager the xrSessionManager. Used to construct the module
  131085. * @param options optional options provided to the module.
  131086. * @returns a function that, when called, will return a new instance of this feature
  131087. */
  131088. static ConstructFeature(featureName: string, version: number | undefined, xrSessionManager: WebXRSessionManager, options?: any): () => IWebXRFeature;
  131089. /**
  131090. * Can be used to return the list of features currently registered
  131091. *
  131092. * @returns an Array of available features
  131093. */
  131094. static GetAvailableFeatures(): string[];
  131095. /**
  131096. * Gets the versions available for a specific feature
  131097. * @param featureName the name of the feature
  131098. * @returns an array with the available versions
  131099. */
  131100. static GetAvailableVersions(featureName: string): string[];
  131101. /**
  131102. * Return the latest unstable version of this feature
  131103. * @param featureName the name of the feature to search
  131104. * @returns the version number. if not found will return -1
  131105. */
  131106. static GetLatestVersionOfFeature(featureName: string): number;
  131107. /**
  131108. * Return the latest stable version of this feature
  131109. * @param featureName the name of the feature to search
  131110. * @returns the version number. if not found will return -1
  131111. */
  131112. static GetStableVersionOfFeature(featureName: string): number;
  131113. /**
  131114. * Attach a feature to the current session. Mainly used when session started to start the feature effect.
  131115. * Can be used during a session to start a feature
  131116. * @param featureName the name of feature to attach
  131117. */
  131118. attachFeature(featureName: string): void;
  131119. /**
  131120. * Can be used inside a session or when the session ends to detach a specific feature
  131121. * @param featureName the name of the feature to detach
  131122. */
  131123. detachFeature(featureName: string): void;
  131124. /**
  131125. * Used to disable an already-enabled feature
  131126. * The feature will be disposed and will be recreated once enabled.
  131127. * @param featureName the feature to disable
  131128. * @returns true if disable was successful
  131129. */
  131130. disableFeature(featureName: string | {
  131131. Name: string;
  131132. }): boolean;
  131133. /**
  131134. * dispose this features manager
  131135. */
  131136. dispose(): void;
  131137. /**
  131138. * 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.
  131139. * 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.
  131140. *
  131141. * @param featureName the name of the feature to load or the class of the feature
  131142. * @param version optional version to load. if not provided the latest version will be enabled
  131143. * @param moduleOptions options provided to the module. Ses the module documentation / constructor
  131144. * @param attachIfPossible if set to true (default) the feature will be automatically attached, if it is currently possible
  131145. * @param required is this feature required to the app. If set to true the session init will fail if the feature is not available.
  131146. * @returns a new constructed feature or throws an error if feature not found.
  131147. */
  131148. enableFeature(featureName: string | {
  131149. Name: string;
  131150. }, version?: number | string, moduleOptions?: any, attachIfPossible?: boolean, required?: boolean): IWebXRFeature;
  131151. /**
  131152. * get the implementation of an enabled feature.
  131153. * @param featureName the name of the feature to load
  131154. * @returns the feature class, if found
  131155. */
  131156. getEnabledFeature(featureName: string): IWebXRFeature;
  131157. /**
  131158. * Get the list of enabled features
  131159. * @returns an array of enabled features
  131160. */
  131161. getEnabledFeatures(): string[];
  131162. /**
  131163. * This function will exten the session creation configuration object with enabled features.
  131164. * If, for example, the anchors feature is enabled, it will be automatically added to the optional or required features list,
  131165. * according to the defined "required" variable, provided during enableFeature call
  131166. * @param xrSessionInit the xr Session init object to extend
  131167. *
  131168. * @returns an extended XRSessionInit object
  131169. */
  131170. extendXRSessionInitObject(xrSessionInit: XRSessionInit): XRSessionInit;
  131171. }
  131172. }
  131173. declare module BABYLON {
  131174. /**
  131175. * Base set of functionality needed to create an XR experience (WebXRSessionManager, Camera, StateManagement, etc.)
  131176. * @see https://doc.babylonjs.com/how_to/webxr_experience_helpers
  131177. */
  131178. export class WebXRExperienceHelper implements IDisposable {
  131179. private scene;
  131180. private _nonVRCamera;
  131181. private _originalSceneAutoClear;
  131182. private _supported;
  131183. /**
  131184. * Camera used to render xr content
  131185. */
  131186. camera: WebXRCamera;
  131187. /** A features manager for this xr session */
  131188. featuresManager: WebXRFeaturesManager;
  131189. /**
  131190. * Observers registered here will be triggered after the camera's initial transformation is set
  131191. * This can be used to set a different ground level or an extra rotation.
  131192. *
  131193. * Note that ground level is considered to be at 0. The height defined by the XR camera will be added
  131194. * to the position set after this observable is done executing.
  131195. */
  131196. onInitialXRPoseSetObservable: Observable<WebXRCamera>;
  131197. /**
  131198. * Fires when the state of the experience helper has changed
  131199. */
  131200. onStateChangedObservable: Observable<WebXRState>;
  131201. /** Session manager used to keep track of xr session */
  131202. sessionManager: WebXRSessionManager;
  131203. /**
  131204. * The current state of the XR experience (eg. transitioning, in XR or not in XR)
  131205. */
  131206. state: WebXRState;
  131207. /**
  131208. * Creates a WebXRExperienceHelper
  131209. * @param scene The scene the helper should be created in
  131210. */
  131211. private constructor();
  131212. /**
  131213. * Creates the experience helper
  131214. * @param scene the scene to attach the experience helper to
  131215. * @returns a promise for the experience helper
  131216. */
  131217. static CreateAsync(scene: Scene): Promise<WebXRExperienceHelper>;
  131218. /**
  131219. * Disposes of the experience helper
  131220. */
  131221. dispose(): void;
  131222. /**
  131223. * Enters XR mode (This must be done within a user interaction in most browsers eg. button click)
  131224. * @param sessionMode options for the XR session
  131225. * @param referenceSpaceType frame of reference of the XR session
  131226. * @param renderTarget the output canvas that will be used to enter XR mode
  131227. * @param sessionCreationOptions optional XRSessionInit object to init the session with
  131228. * @returns promise that resolves after xr mode has entered
  131229. */
  131230. enterXRAsync(sessionMode: XRSessionMode, referenceSpaceType: XRReferenceSpaceType, renderTarget?: WebXRRenderTarget, sessionCreationOptions?: XRSessionInit): Promise<WebXRSessionManager>;
  131231. /**
  131232. * Exits XR mode and returns the scene to its original state
  131233. * @returns promise that resolves after xr mode has exited
  131234. */
  131235. exitXRAsync(): Promise<void>;
  131236. private _nonXRToXRCamera;
  131237. private _setState;
  131238. }
  131239. }
  131240. declare module BABYLON {
  131241. /**
  131242. * X-Y values for axes in WebXR
  131243. */
  131244. export interface IWebXRMotionControllerAxesValue {
  131245. /**
  131246. * The value of the x axis
  131247. */
  131248. x: number;
  131249. /**
  131250. * The value of the y-axis
  131251. */
  131252. y: number;
  131253. }
  131254. /**
  131255. * changed / previous values for the values of this component
  131256. */
  131257. export interface IWebXRMotionControllerComponentChangesValues<T> {
  131258. /**
  131259. * current (this frame) value
  131260. */
  131261. current: T;
  131262. /**
  131263. * previous (last change) value
  131264. */
  131265. previous: T;
  131266. }
  131267. /**
  131268. * Represents changes in the component between current frame and last values recorded
  131269. */
  131270. export interface IWebXRMotionControllerComponentChanges {
  131271. /**
  131272. * will be populated with previous and current values if axes changed
  131273. */
  131274. axes?: IWebXRMotionControllerComponentChangesValues<IWebXRMotionControllerAxesValue>;
  131275. /**
  131276. * will be populated with previous and current values if pressed changed
  131277. */
  131278. pressed?: IWebXRMotionControllerComponentChangesValues<boolean>;
  131279. /**
  131280. * will be populated with previous and current values if touched changed
  131281. */
  131282. touched?: IWebXRMotionControllerComponentChangesValues<boolean>;
  131283. /**
  131284. * will be populated with previous and current values if value changed
  131285. */
  131286. value?: IWebXRMotionControllerComponentChangesValues<number>;
  131287. }
  131288. /**
  131289. * This class represents a single component (for example button or thumbstick) of a motion controller
  131290. */
  131291. export class WebXRControllerComponent implements IDisposable {
  131292. /**
  131293. * the id of this component
  131294. */
  131295. id: string;
  131296. /**
  131297. * the type of the component
  131298. */
  131299. type: MotionControllerComponentType;
  131300. private _buttonIndex;
  131301. private _axesIndices;
  131302. private _axes;
  131303. private _changes;
  131304. private _currentValue;
  131305. private _hasChanges;
  131306. private _pressed;
  131307. private _touched;
  131308. /**
  131309. * button component type
  131310. */
  131311. static BUTTON_TYPE: MotionControllerComponentType;
  131312. /**
  131313. * squeeze component type
  131314. */
  131315. static SQUEEZE_TYPE: MotionControllerComponentType;
  131316. /**
  131317. * Thumbstick component type
  131318. */
  131319. static THUMBSTICK_TYPE: MotionControllerComponentType;
  131320. /**
  131321. * Touchpad component type
  131322. */
  131323. static TOUCHPAD_TYPE: MotionControllerComponentType;
  131324. /**
  131325. * trigger component type
  131326. */
  131327. static TRIGGER_TYPE: MotionControllerComponentType;
  131328. /**
  131329. * If axes are available for this component (like a touchpad or thumbstick) the observers will be notified when
  131330. * the axes data changes
  131331. */
  131332. onAxisValueChangedObservable: Observable<{
  131333. x: number;
  131334. y: number;
  131335. }>;
  131336. /**
  131337. * Observers registered here will be triggered when the state of a button changes
  131338. * State change is either pressed / touched / value
  131339. */
  131340. onButtonStateChangedObservable: Observable<WebXRControllerComponent>;
  131341. /**
  131342. * Creates a new component for a motion controller.
  131343. * It is created by the motion controller itself
  131344. *
  131345. * @param id the id of this component
  131346. * @param type the type of the component
  131347. * @param _buttonIndex index in the buttons array of the gamepad
  131348. * @param _axesIndices indices of the values in the axes array of the gamepad
  131349. */
  131350. constructor(
  131351. /**
  131352. * the id of this component
  131353. */
  131354. id: string,
  131355. /**
  131356. * the type of the component
  131357. */
  131358. type: MotionControllerComponentType, _buttonIndex?: number, _axesIndices?: number[]);
  131359. /**
  131360. * The current axes data. If this component has no axes it will still return an object { x: 0, y: 0 }
  131361. */
  131362. get axes(): IWebXRMotionControllerAxesValue;
  131363. /**
  131364. * Get the changes. Elements will be populated only if they changed with their previous and current value
  131365. */
  131366. get changes(): IWebXRMotionControllerComponentChanges;
  131367. /**
  131368. * Return whether or not the component changed the last frame
  131369. */
  131370. get hasChanges(): boolean;
  131371. /**
  131372. * is the button currently pressed
  131373. */
  131374. get pressed(): boolean;
  131375. /**
  131376. * is the button currently touched
  131377. */
  131378. get touched(): boolean;
  131379. /**
  131380. * Get the current value of this component
  131381. */
  131382. get value(): number;
  131383. /**
  131384. * Dispose this component
  131385. */
  131386. dispose(): void;
  131387. /**
  131388. * Are there axes correlating to this component
  131389. * @return true is axes data is available
  131390. */
  131391. isAxes(): boolean;
  131392. /**
  131393. * Is this component a button (hence - pressable)
  131394. * @returns true if can be pressed
  131395. */
  131396. isButton(): boolean;
  131397. /**
  131398. * update this component using the gamepad object it is in. Called on every frame
  131399. * @param nativeController the native gamepad controller object
  131400. */
  131401. update(nativeController: IMinimalMotionControllerObject): void;
  131402. }
  131403. }
  131404. declare module BABYLON {
  131405. /**
  131406. * Interface used to represent data loading progression
  131407. */
  131408. export interface ISceneLoaderProgressEvent {
  131409. /**
  131410. * Defines if data length to load can be evaluated
  131411. */
  131412. readonly lengthComputable: boolean;
  131413. /**
  131414. * Defines the loaded data length
  131415. */
  131416. readonly loaded: number;
  131417. /**
  131418. * Defines the data length to load
  131419. */
  131420. readonly total: number;
  131421. }
  131422. /**
  131423. * Interface used by SceneLoader plugins to define supported file extensions
  131424. */
  131425. export interface ISceneLoaderPluginExtensions {
  131426. /**
  131427. * Defines the list of supported extensions
  131428. */
  131429. [extension: string]: {
  131430. isBinary: boolean;
  131431. };
  131432. }
  131433. /**
  131434. * Interface used by SceneLoader plugin factory
  131435. */
  131436. export interface ISceneLoaderPluginFactory {
  131437. /**
  131438. * Defines the name of the factory
  131439. */
  131440. name: string;
  131441. /**
  131442. * Function called to create a new plugin
  131443. * @return the new plugin
  131444. */
  131445. createPlugin(): ISceneLoaderPlugin | ISceneLoaderPluginAsync;
  131446. /**
  131447. * The callback that returns true if the data can be directly loaded.
  131448. * @param data string containing the file data
  131449. * @returns if the data can be loaded directly
  131450. */
  131451. canDirectLoad?(data: string): boolean;
  131452. }
  131453. /**
  131454. * Interface used to define the base of ISceneLoaderPlugin and ISceneLoaderPluginAsync
  131455. */
  131456. export interface ISceneLoaderPluginBase {
  131457. /**
  131458. * The friendly name of this plugin.
  131459. */
  131460. name: string;
  131461. /**
  131462. * The file extensions supported by this plugin.
  131463. */
  131464. extensions: string | ISceneLoaderPluginExtensions;
  131465. /**
  131466. * The callback called when loading from a url.
  131467. * @param scene scene loading this url
  131468. * @param url url to load
  131469. * @param onSuccess callback called when the file successfully loads
  131470. * @param onProgress callback called while file is loading (if the server supports this mode)
  131471. * @param useArrayBuffer defines a boolean indicating that date must be returned as ArrayBuffer
  131472. * @param onError callback called when the file fails to load
  131473. * @returns a file request object
  131474. */
  131475. requestFile?(scene: Scene, url: string, onSuccess: (data: any, request?: WebRequest) => void, onProgress?: (ev: ISceneLoaderProgressEvent) => void, useArrayBuffer?: boolean, onError?: (error: any) => void): IFileRequest;
  131476. /**
  131477. * The callback called when loading from a file object.
  131478. * @param scene scene loading this file
  131479. * @param file defines the file to load
  131480. * @param onSuccess defines the callback to call when data is loaded
  131481. * @param onProgress defines the callback to call during loading process
  131482. * @param useArrayBuffer defines a boolean indicating that data must be returned as an ArrayBuffer
  131483. * @param onError defines the callback to call when an error occurs
  131484. * @returns a file request object
  131485. */
  131486. readFile?(scene: Scene, file: File, onSuccess: (data: any) => void, onProgress?: (ev: ISceneLoaderProgressEvent) => any, useArrayBuffer?: boolean, onError?: (error: any) => void): IFileRequest;
  131487. /**
  131488. * The callback that returns true if the data can be directly loaded.
  131489. * @param data string containing the file data
  131490. * @returns if the data can be loaded directly
  131491. */
  131492. canDirectLoad?(data: string): boolean;
  131493. /**
  131494. * The callback that returns the data to pass to the plugin if the data can be directly loaded.
  131495. * @param scene scene loading this data
  131496. * @param data string containing the data
  131497. * @returns data to pass to the plugin
  131498. */
  131499. directLoad?(scene: Scene, data: string): any;
  131500. /**
  131501. * The callback that allows custom handling of the root url based on the response url.
  131502. * @param rootUrl the original root url
  131503. * @param responseURL the response url if available
  131504. * @returns the new root url
  131505. */
  131506. rewriteRootURL?(rootUrl: string, responseURL?: string): string;
  131507. }
  131508. /**
  131509. * Interface used to define a SceneLoader plugin
  131510. */
  131511. export interface ISceneLoaderPlugin extends ISceneLoaderPluginBase {
  131512. /**
  131513. * Import meshes into a scene.
  131514. * @param meshesNames An array of mesh names, a single mesh name, or empty string for all meshes that filter what meshes are imported
  131515. * @param scene The scene to import into
  131516. * @param data The data to import
  131517. * @param rootUrl The root url for scene and resources
  131518. * @param meshes The meshes array to import into
  131519. * @param particleSystems The particle systems array to import into
  131520. * @param skeletons The skeletons array to import into
  131521. * @param onError The callback when import fails
  131522. * @returns True if successful or false otherwise
  131523. */
  131524. importMesh(meshesNames: any, scene: Scene, data: any, rootUrl: string, meshes: AbstractMesh[], particleSystems: IParticleSystem[], skeletons: Skeleton[], onError?: (message: string, exception?: any) => void): boolean;
  131525. /**
  131526. * Load into a scene.
  131527. * @param scene The scene to load into
  131528. * @param data The data to import
  131529. * @param rootUrl The root url for scene and resources
  131530. * @param onError The callback when import fails
  131531. * @returns True if successful or false otherwise
  131532. */
  131533. load(scene: Scene, data: any, rootUrl: string, onError?: (message: string, exception?: any) => void): boolean;
  131534. /**
  131535. * Load into an asset container.
  131536. * @param scene The scene to load into
  131537. * @param data The data to import
  131538. * @param rootUrl The root url for scene and resources
  131539. * @param onError The callback when import fails
  131540. * @returns The loaded asset container
  131541. */
  131542. loadAssetContainer(scene: Scene, data: any, rootUrl: string, onError?: (message: string, exception?: any) => void): AssetContainer;
  131543. }
  131544. /**
  131545. * Interface used to define an async SceneLoader plugin
  131546. */
  131547. export interface ISceneLoaderPluginAsync extends ISceneLoaderPluginBase {
  131548. /**
  131549. * Import meshes into a scene.
  131550. * @param meshesNames An array of mesh names, a single mesh name, or empty string for all meshes that filter what meshes are imported
  131551. * @param scene The scene to import into
  131552. * @param data The data to import
  131553. * @param rootUrl The root url for scene and resources
  131554. * @param onProgress The callback when the load progresses
  131555. * @param fileName Defines the name of the file to load
  131556. * @returns The loaded meshes, particle systems, skeletons, and animation groups
  131557. */
  131558. importMeshAsync(meshesNames: any, scene: Scene, data: any, rootUrl: string, onProgress?: (event: ISceneLoaderProgressEvent) => void, fileName?: string): Promise<{
  131559. meshes: AbstractMesh[];
  131560. particleSystems: IParticleSystem[];
  131561. skeletons: Skeleton[];
  131562. animationGroups: AnimationGroup[];
  131563. }>;
  131564. /**
  131565. * Load into a scene.
  131566. * @param scene The scene to load into
  131567. * @param data The data to import
  131568. * @param rootUrl The root url for scene and resources
  131569. * @param onProgress The callback when the load progresses
  131570. * @param fileName Defines the name of the file to load
  131571. * @returns Nothing
  131572. */
  131573. loadAsync(scene: Scene, data: any, rootUrl: string, onProgress?: (event: ISceneLoaderProgressEvent) => void, fileName?: string): Promise<void>;
  131574. /**
  131575. * Load into an asset container.
  131576. * @param scene The scene to load into
  131577. * @param data The data to import
  131578. * @param rootUrl The root url for scene and resources
  131579. * @param onProgress The callback when the load progresses
  131580. * @param fileName Defines the name of the file to load
  131581. * @returns The loaded asset container
  131582. */
  131583. loadAssetContainerAsync(scene: Scene, data: any, rootUrl: string, onProgress?: (event: ISceneLoaderProgressEvent) => void, fileName?: string): Promise<AssetContainer>;
  131584. }
  131585. /**
  131586. * Mode that determines how to handle old animation groups before loading new ones.
  131587. */
  131588. export enum SceneLoaderAnimationGroupLoadingMode {
  131589. /**
  131590. * Reset all old animations to initial state then dispose them.
  131591. */
  131592. Clean = 0,
  131593. /**
  131594. * Stop all old animations.
  131595. */
  131596. Stop = 1,
  131597. /**
  131598. * Restart old animations from first frame.
  131599. */
  131600. Sync = 2,
  131601. /**
  131602. * Old animations remains untouched.
  131603. */
  131604. NoSync = 3
  131605. }
  131606. /**
  131607. * Defines a plugin registered by the SceneLoader
  131608. */
  131609. interface IRegisteredPlugin {
  131610. /**
  131611. * Defines the plugin to use
  131612. */
  131613. plugin: ISceneLoaderPlugin | ISceneLoaderPluginAsync | ISceneLoaderPluginFactory;
  131614. /**
  131615. * Defines if the plugin supports binary data
  131616. */
  131617. isBinary: boolean;
  131618. }
  131619. /**
  131620. * Class used to load scene from various file formats using registered plugins
  131621. * @see https://doc.babylonjs.com/how_to/load_from_any_file_type
  131622. */
  131623. export class SceneLoader {
  131624. /**
  131625. * No logging while loading
  131626. */
  131627. static readonly NO_LOGGING: number;
  131628. /**
  131629. * Minimal logging while loading
  131630. */
  131631. static readonly MINIMAL_LOGGING: number;
  131632. /**
  131633. * Summary logging while loading
  131634. */
  131635. static readonly SUMMARY_LOGGING: number;
  131636. /**
  131637. * Detailled logging while loading
  131638. */
  131639. static readonly DETAILED_LOGGING: number;
  131640. /**
  131641. * Gets or sets a boolean indicating if entire scene must be loaded even if scene contains incremental data
  131642. */
  131643. static get ForceFullSceneLoadingForIncremental(): boolean;
  131644. static set ForceFullSceneLoadingForIncremental(value: boolean);
  131645. /**
  131646. * Gets or sets a boolean indicating if loading screen must be displayed while loading a scene
  131647. */
  131648. static get ShowLoadingScreen(): boolean;
  131649. static set ShowLoadingScreen(value: boolean);
  131650. /**
  131651. * Defines the current logging level (while loading the scene)
  131652. * @ignorenaming
  131653. */
  131654. static get loggingLevel(): number;
  131655. static set loggingLevel(value: number);
  131656. /**
  131657. * Gets or set a boolean indicating if matrix weights must be cleaned upon loading
  131658. */
  131659. static get CleanBoneMatrixWeights(): boolean;
  131660. static set CleanBoneMatrixWeights(value: boolean);
  131661. /**
  131662. * Event raised when a plugin is used to load a scene
  131663. */
  131664. static OnPluginActivatedObservable: Observable<ISceneLoaderPlugin | ISceneLoaderPluginAsync>;
  131665. private static _registeredPlugins;
  131666. private static _showingLoadingScreen;
  131667. /**
  131668. * Gets the default plugin (used to load Babylon files)
  131669. * @returns the .babylon plugin
  131670. */
  131671. static GetDefaultPlugin(): IRegisteredPlugin;
  131672. private static _GetPluginForExtension;
  131673. private static _GetPluginForDirectLoad;
  131674. private static _GetPluginForFilename;
  131675. private static _GetDirectLoad;
  131676. private static _LoadData;
  131677. private static _GetFileInfo;
  131678. /**
  131679. * Gets a plugin that can load the given extension
  131680. * @param extension defines the extension to load
  131681. * @returns a plugin or null if none works
  131682. */
  131683. static GetPluginForExtension(extension: string): ISceneLoaderPlugin | ISceneLoaderPluginAsync | ISceneLoaderPluginFactory;
  131684. /**
  131685. * Gets a boolean indicating that the given extension can be loaded
  131686. * @param extension defines the extension to load
  131687. * @returns true if the extension is supported
  131688. */
  131689. static IsPluginForExtensionAvailable(extension: string): boolean;
  131690. /**
  131691. * Adds a new plugin to the list of registered plugins
  131692. * @param plugin defines the plugin to add
  131693. */
  131694. static RegisterPlugin(plugin: ISceneLoaderPlugin | ISceneLoaderPluginAsync): void;
  131695. /**
  131696. * Import meshes into a scene
  131697. * @param meshNames an array of mesh names, a single mesh name, or empty string for all meshes that filter what meshes are imported
  131698. * @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)
  131699. * @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)
  131700. * @param scene the instance of BABYLON.Scene to append to
  131701. * @param onSuccess a callback with a list of imported meshes, particleSystems, skeletons, and animationGroups when import succeeds
  131702. * @param onProgress a callback with a progress event for each file being loaded
  131703. * @param onError a callback with the scene, a message, and possibly an exception when import fails
  131704. * @param pluginExtension the extension used to determine the plugin
  131705. * @returns The loaded plugin
  131706. */
  131707. 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>;
  131708. /**
  131709. * Import meshes into a scene
  131710. * @param meshNames an array of mesh names, a single mesh name, or empty string for all meshes that filter what meshes are imported
  131711. * @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)
  131712. * @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)
  131713. * @param scene the instance of BABYLON.Scene to append to
  131714. * @param onProgress a callback with a progress event for each file being loaded
  131715. * @param pluginExtension the extension used to determine the plugin
  131716. * @returns The loaded list of imported meshes, particle systems, skeletons, and animation groups
  131717. */
  131718. static ImportMeshAsync(meshNames: any, rootUrl: string, sceneFilename?: string | File, scene?: Nullable<Scene>, onProgress?: Nullable<(event: ISceneLoaderProgressEvent) => void>, pluginExtension?: Nullable<string>): Promise<{
  131719. meshes: AbstractMesh[];
  131720. particleSystems: IParticleSystem[];
  131721. skeletons: Skeleton[];
  131722. animationGroups: AnimationGroup[];
  131723. }>;
  131724. /**
  131725. * Load a scene
  131726. * @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)
  131727. * @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)
  131728. * @param engine is the instance of BABYLON.Engine to use to create the scene
  131729. * @param onSuccess a callback with the scene when import succeeds
  131730. * @param onProgress a callback with a progress event for each file being loaded
  131731. * @param onError a callback with the scene, a message, and possibly an exception when import fails
  131732. * @param pluginExtension the extension used to determine the plugin
  131733. * @returns The loaded plugin
  131734. */
  131735. 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>;
  131736. /**
  131737. * Load a scene
  131738. * @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)
  131739. * @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)
  131740. * @param engine is the instance of BABYLON.Engine to use to create the scene
  131741. * @param onProgress a callback with a progress event for each file being loaded
  131742. * @param pluginExtension the extension used to determine the plugin
  131743. * @returns The loaded scene
  131744. */
  131745. static LoadAsync(rootUrl: string, sceneFilename?: string | File, engine?: Nullable<Engine>, onProgress?: Nullable<(event: ISceneLoaderProgressEvent) => void>, pluginExtension?: Nullable<string>): Promise<Scene>;
  131746. /**
  131747. * Append a scene
  131748. * @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)
  131749. * @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)
  131750. * @param scene is the instance of BABYLON.Scene to append to
  131751. * @param onSuccess a callback with the scene when import succeeds
  131752. * @param onProgress a callback with a progress event for each file being loaded
  131753. * @param onError a callback with the scene, a message, and possibly an exception when import fails
  131754. * @param pluginExtension the extension used to determine the plugin
  131755. * @returns The loaded plugin
  131756. */
  131757. 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>;
  131758. /**
  131759. * Append a scene
  131760. * @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)
  131761. * @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)
  131762. * @param scene is the instance of BABYLON.Scene to append to
  131763. * @param onProgress a callback with a progress event for each file being loaded
  131764. * @param pluginExtension the extension used to determine the plugin
  131765. * @returns The given scene
  131766. */
  131767. static AppendAsync(rootUrl: string, sceneFilename?: string | File, scene?: Nullable<Scene>, onProgress?: Nullable<(event: ISceneLoaderProgressEvent) => void>, pluginExtension?: Nullable<string>): Promise<Scene>;
  131768. /**
  131769. * Load a scene into an asset container
  131770. * @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)
  131771. * @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)
  131772. * @param scene is the instance of BABYLON.Scene to append to (default: last created scene)
  131773. * @param onSuccess a callback with the scene when import succeeds
  131774. * @param onProgress a callback with a progress event for each file being loaded
  131775. * @param onError a callback with the scene, a message, and possibly an exception when import fails
  131776. * @param pluginExtension the extension used to determine the plugin
  131777. * @returns The loaded plugin
  131778. */
  131779. 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>;
  131780. /**
  131781. * Load a scene into an asset container
  131782. * @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)
  131783. * @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)
  131784. * @param scene is the instance of Scene to append to
  131785. * @param onProgress a callback with a progress event for each file being loaded
  131786. * @param pluginExtension the extension used to determine the plugin
  131787. * @returns The loaded asset container
  131788. */
  131789. static LoadAssetContainerAsync(rootUrl: string, sceneFilename?: string, scene?: Nullable<Scene>, onProgress?: Nullable<(event: ISceneLoaderProgressEvent) => void>, pluginExtension?: Nullable<string>): Promise<AssetContainer>;
  131790. /**
  131791. * Import animations from a file into a scene
  131792. * @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)
  131793. * @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)
  131794. * @param scene is the instance of BABYLON.Scene to append to (default: last created scene)
  131795. * @param overwriteAnimations when true, animations are cleaned before importing new ones. Animations are appended otherwise
  131796. * @param animationGroupLoadingMode defines how to handle old animations groups before importing new ones
  131797. * @param targetConverter defines a function used to convert animation targets from loaded scene to current scene (default: search node by name)
  131798. * @param onSuccess a callback with the scene when import succeeds
  131799. * @param onProgress a callback with a progress event for each file being loaded
  131800. * @param onError a callback with the scene, a message, and possibly an exception when import fails
  131801. * @param pluginExtension the extension used to determine the plugin
  131802. */
  131803. 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;
  131804. /**
  131805. * Import animations from a file into a scene
  131806. * @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)
  131807. * @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)
  131808. * @param scene is the instance of BABYLON.Scene to append to (default: last created scene)
  131809. * @param overwriteAnimations when true, animations are cleaned before importing new ones. Animations are appended otherwise
  131810. * @param animationGroupLoadingMode defines how to handle old animations groups before importing new ones
  131811. * @param targetConverter defines a function used to convert animation targets from loaded scene to current scene (default: search node by name)
  131812. * @param onSuccess a callback with the scene when import succeeds
  131813. * @param onProgress a callback with a progress event for each file being loaded
  131814. * @param onError a callback with the scene, a message, and possibly an exception when import fails
  131815. * @param pluginExtension the extension used to determine the plugin
  131816. * @returns the updated scene with imported animations
  131817. */
  131818. 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>;
  131819. }
  131820. }
  131821. declare module BABYLON {
  131822. /**
  131823. * Handedness type in xrInput profiles. These can be used to define layouts in the Layout Map.
  131824. */
  131825. export type MotionControllerHandedness = "none" | "left" | "right";
  131826. /**
  131827. * The type of components available in motion controllers.
  131828. * This is not the name of the component.
  131829. */
  131830. export type MotionControllerComponentType = "trigger" | "squeeze" | "touchpad" | "thumbstick" | "button";
  131831. /**
  131832. * The state of a controller component
  131833. */
  131834. export type MotionControllerComponentStateType = "default" | "touched" | "pressed";
  131835. /**
  131836. * The schema of motion controller layout.
  131837. * No object will be initialized using this interface
  131838. * This is used just to define the profile.
  131839. */
  131840. export interface IMotionControllerLayout {
  131841. /**
  131842. * Path to load the assets. Usually relative to the base path
  131843. */
  131844. assetPath: string;
  131845. /**
  131846. * Available components (unsorted)
  131847. */
  131848. components: {
  131849. /**
  131850. * A map of component Ids
  131851. */
  131852. [componentId: string]: {
  131853. /**
  131854. * The type of input the component outputs
  131855. */
  131856. type: MotionControllerComponentType;
  131857. /**
  131858. * The indices of this component in the gamepad object
  131859. */
  131860. gamepadIndices: {
  131861. /**
  131862. * Index of button
  131863. */
  131864. button?: number;
  131865. /**
  131866. * If available, index of x-axis
  131867. */
  131868. xAxis?: number;
  131869. /**
  131870. * If available, index of y-axis
  131871. */
  131872. yAxis?: number;
  131873. };
  131874. /**
  131875. * The mesh's root node name
  131876. */
  131877. rootNodeName: string;
  131878. /**
  131879. * Animation definitions for this model
  131880. */
  131881. visualResponses: {
  131882. [stateKey: string]: {
  131883. /**
  131884. * What property will be animated
  131885. */
  131886. componentProperty: "xAxis" | "yAxis" | "button" | "state";
  131887. /**
  131888. * What states influence this visual response
  131889. */
  131890. states: MotionControllerComponentStateType[];
  131891. /**
  131892. * Type of animation - movement or visibility
  131893. */
  131894. valueNodeProperty: "transform" | "visibility";
  131895. /**
  131896. * Base node name to move. Its position will be calculated according to the min and max nodes
  131897. */
  131898. valueNodeName?: string;
  131899. /**
  131900. * Minimum movement node
  131901. */
  131902. minNodeName?: string;
  131903. /**
  131904. * Max movement node
  131905. */
  131906. maxNodeName?: string;
  131907. };
  131908. };
  131909. /**
  131910. * If touch enabled, what is the name of node to display user feedback
  131911. */
  131912. touchPointNodeName?: string;
  131913. };
  131914. };
  131915. /**
  131916. * Is it xr standard mapping or not
  131917. */
  131918. gamepadMapping: "" | "xr-standard";
  131919. /**
  131920. * Base root node of this entire model
  131921. */
  131922. rootNodeName: string;
  131923. /**
  131924. * Defines the main button component id
  131925. */
  131926. selectComponentId: string;
  131927. }
  131928. /**
  131929. * A definition for the layout map in the input profile
  131930. */
  131931. export interface IMotionControllerLayoutMap {
  131932. /**
  131933. * Layouts with handedness type as a key
  131934. */
  131935. [handedness: string]: IMotionControllerLayout;
  131936. }
  131937. /**
  131938. * The XR Input profile schema
  131939. * Profiles can be found here:
  131940. * https://github.com/immersive-web/webxr-input-profiles/tree/master/packages/registry/profiles
  131941. */
  131942. export interface IMotionControllerProfile {
  131943. /**
  131944. * fallback profiles for this profileId
  131945. */
  131946. fallbackProfileIds: string[];
  131947. /**
  131948. * The layout map, with handedness as key
  131949. */
  131950. layouts: IMotionControllerLayoutMap;
  131951. /**
  131952. * The id of this profile
  131953. * correlates to the profile(s) in the xrInput.profiles array
  131954. */
  131955. profileId: string;
  131956. }
  131957. /**
  131958. * A helper-interface for the 3 meshes needed for controller button animation
  131959. * The meshes are provided to the _lerpButtonTransform function to calculate the current position of the value mesh
  131960. */
  131961. export interface IMotionControllerButtonMeshMap {
  131962. /**
  131963. * the mesh that defines the pressed value mesh position.
  131964. * This is used to find the max-position of this button
  131965. */
  131966. pressedMesh: AbstractMesh;
  131967. /**
  131968. * the mesh that defines the unpressed value mesh position.
  131969. * This is used to find the min (or initial) position of this button
  131970. */
  131971. unpressedMesh: AbstractMesh;
  131972. /**
  131973. * The mesh that will be changed when value changes
  131974. */
  131975. valueMesh: AbstractMesh;
  131976. }
  131977. /**
  131978. * A helper-interface for the 3 meshes needed for controller axis animation.
  131979. * This will be expanded when touchpad animations are fully supported
  131980. * The meshes are provided to the _lerpAxisTransform function to calculate the current position of the value mesh
  131981. */
  131982. export interface IMotionControllerMeshMap {
  131983. /**
  131984. * the mesh that defines the maximum value mesh position.
  131985. */
  131986. maxMesh?: AbstractMesh;
  131987. /**
  131988. * the mesh that defines the minimum value mesh position.
  131989. */
  131990. minMesh?: AbstractMesh;
  131991. /**
  131992. * The mesh that will be changed when axis value changes
  131993. */
  131994. valueMesh?: AbstractMesh;
  131995. }
  131996. /**
  131997. * The elements needed for change-detection of the gamepad objects in motion controllers
  131998. */
  131999. export interface IMinimalMotionControllerObject {
  132000. /**
  132001. * Available axes of this controller
  132002. */
  132003. axes: number[];
  132004. /**
  132005. * An array of available buttons
  132006. */
  132007. buttons: Array<{
  132008. /**
  132009. * Value of the button/trigger
  132010. */
  132011. value: number;
  132012. /**
  132013. * If the button/trigger is currently touched
  132014. */
  132015. touched: boolean;
  132016. /**
  132017. * If the button/trigger is currently pressed
  132018. */
  132019. pressed: boolean;
  132020. }>;
  132021. /**
  132022. * EXPERIMENTAL haptic support.
  132023. */
  132024. hapticActuators?: Array<{
  132025. pulse: (value: number, duration: number) => Promise<boolean>;
  132026. }>;
  132027. }
  132028. /**
  132029. * An Abstract Motion controller
  132030. * This class receives an xrInput and a profile layout and uses those to initialize the components
  132031. * Each component has an observable to check for changes in value and state
  132032. */
  132033. export abstract class WebXRAbstractMotionController implements IDisposable {
  132034. protected scene: Scene;
  132035. protected layout: IMotionControllerLayout;
  132036. /**
  132037. * The gamepad object correlating to this controller
  132038. */
  132039. gamepadObject: IMinimalMotionControllerObject;
  132040. /**
  132041. * handedness (left/right/none) of this controller
  132042. */
  132043. handedness: MotionControllerHandedness;
  132044. private _initComponent;
  132045. private _modelReady;
  132046. /**
  132047. * A map of components (WebXRControllerComponent) in this motion controller
  132048. * Components have a ComponentType and can also have both button and axis definitions
  132049. */
  132050. readonly components: {
  132051. [id: string]: WebXRControllerComponent;
  132052. };
  132053. /**
  132054. * Disable the model's animation. Can be set at any time.
  132055. */
  132056. disableAnimation: boolean;
  132057. /**
  132058. * Observers registered here will be triggered when the model of this controller is done loading
  132059. */
  132060. onModelLoadedObservable: Observable<WebXRAbstractMotionController>;
  132061. /**
  132062. * The profile id of this motion controller
  132063. */
  132064. abstract profileId: string;
  132065. /**
  132066. * The root mesh of the model. It is null if the model was not yet initialized
  132067. */
  132068. rootMesh: Nullable<AbstractMesh>;
  132069. /**
  132070. * constructs a new abstract motion controller
  132071. * @param scene the scene to which the model of the controller will be added
  132072. * @param layout The profile layout to load
  132073. * @param gamepadObject The gamepad object correlating to this controller
  132074. * @param handedness handedness (left/right/none) of this controller
  132075. * @param _doNotLoadControllerMesh set this flag to ignore the mesh loading
  132076. */
  132077. constructor(scene: Scene, layout: IMotionControllerLayout,
  132078. /**
  132079. * The gamepad object correlating to this controller
  132080. */
  132081. gamepadObject: IMinimalMotionControllerObject,
  132082. /**
  132083. * handedness (left/right/none) of this controller
  132084. */
  132085. handedness: MotionControllerHandedness, _doNotLoadControllerMesh?: boolean);
  132086. /**
  132087. * Dispose this controller, the model mesh and all its components
  132088. */
  132089. dispose(): void;
  132090. /**
  132091. * Returns all components of specific type
  132092. * @param type the type to search for
  132093. * @return an array of components with this type
  132094. */
  132095. getAllComponentsOfType(type: MotionControllerComponentType): WebXRControllerComponent[];
  132096. /**
  132097. * get a component based an its component id as defined in layout.components
  132098. * @param id the id of the component
  132099. * @returns the component correlates to the id or undefined if not found
  132100. */
  132101. getComponent(id: string): WebXRControllerComponent;
  132102. /**
  132103. * Get the list of components available in this motion controller
  132104. * @returns an array of strings correlating to available components
  132105. */
  132106. getComponentIds(): string[];
  132107. /**
  132108. * Get the first component of specific type
  132109. * @param type type of component to find
  132110. * @return a controller component or null if not found
  132111. */
  132112. getComponentOfType(type: MotionControllerComponentType): Nullable<WebXRControllerComponent>;
  132113. /**
  132114. * Get the main (Select) component of this controller as defined in the layout
  132115. * @returns the main component of this controller
  132116. */
  132117. getMainComponent(): WebXRControllerComponent;
  132118. /**
  132119. * Loads the model correlating to this controller
  132120. * When the mesh is loaded, the onModelLoadedObservable will be triggered
  132121. * @returns A promise fulfilled with the result of the model loading
  132122. */
  132123. loadModel(): Promise<boolean>;
  132124. /**
  132125. * Update this model using the current XRFrame
  132126. * @param xrFrame the current xr frame to use and update the model
  132127. */
  132128. updateFromXRFrame(xrFrame: XRFrame): void;
  132129. /**
  132130. * Backwards compatibility due to a deeply-integrated typo
  132131. */
  132132. get handness(): XREye;
  132133. /**
  132134. * Pulse (vibrate) this controller
  132135. * If the controller does not support pulses, this function will fail silently and return Promise<false> directly after called
  132136. * Consecutive calls to this function will cancel the last pulse call
  132137. *
  132138. * @param value the strength of the pulse in 0.0...1.0 range
  132139. * @param duration Duration of the pulse in milliseconds
  132140. * @param hapticActuatorIndex optional index of actuator (will usually be 0)
  132141. * @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
  132142. */
  132143. pulse(value: number, duration: number, hapticActuatorIndex?: number): Promise<boolean>;
  132144. protected _getChildByName(node: AbstractMesh, name: string): AbstractMesh | undefined;
  132145. protected _getImmediateChildByName(node: AbstractMesh, name: string): AbstractMesh | undefined;
  132146. /**
  132147. * Moves the axis on the controller mesh based on its current state
  132148. * @param axis the index of the axis
  132149. * @param axisValue the value of the axis which determines the meshes new position
  132150. * @hidden
  132151. */
  132152. protected _lerpTransform(axisMap: IMotionControllerMeshMap, axisValue: number, fixValueCoordinates?: boolean): void;
  132153. /**
  132154. * Update the model itself with the current frame data
  132155. * @param xrFrame the frame to use for updating the model mesh
  132156. */
  132157. protected updateModel(xrFrame: XRFrame): void;
  132158. /**
  132159. * Get the filename and path for this controller's model
  132160. * @returns a map of filename and path
  132161. */
  132162. protected abstract _getFilenameAndPath(): {
  132163. filename: string;
  132164. path: string;
  132165. };
  132166. /**
  132167. * This function is called before the mesh is loaded. It checks for loading constraints.
  132168. * For example, this function can check if the GLB loader is available
  132169. * If this function returns false, the generic controller will be loaded instead
  132170. * @returns Is the client ready to load the mesh
  132171. */
  132172. protected abstract _getModelLoadingConstraints(): boolean;
  132173. /**
  132174. * This function will be called after the model was successfully loaded and can be used
  132175. * for mesh transformations before it is available for the user
  132176. * @param meshes the loaded meshes
  132177. */
  132178. protected abstract _processLoadedModel(meshes: AbstractMesh[]): void;
  132179. /**
  132180. * Set the root mesh for this controller. Important for the WebXR controller class
  132181. * @param meshes the loaded meshes
  132182. */
  132183. protected abstract _setRootMesh(meshes: AbstractMesh[]): void;
  132184. /**
  132185. * A function executed each frame that updates the mesh (if needed)
  132186. * @param xrFrame the current xrFrame
  132187. */
  132188. protected abstract _updateModel(xrFrame: XRFrame): void;
  132189. private _getGenericFilenameAndPath;
  132190. private _getGenericParentMesh;
  132191. }
  132192. }
  132193. declare module BABYLON {
  132194. /**
  132195. * A generic trigger-only motion controller for WebXR
  132196. */
  132197. export class WebXRGenericTriggerMotionController extends WebXRAbstractMotionController {
  132198. /**
  132199. * Static version of the profile id of this controller
  132200. */
  132201. static ProfileId: string;
  132202. profileId: string;
  132203. constructor(scene: Scene, gamepadObject: IMinimalMotionControllerObject, handedness: MotionControllerHandedness);
  132204. protected _getFilenameAndPath(): {
  132205. filename: string;
  132206. path: string;
  132207. };
  132208. protected _getModelLoadingConstraints(): boolean;
  132209. protected _processLoadedModel(meshes: AbstractMesh[]): void;
  132210. protected _setRootMesh(meshes: AbstractMesh[]): void;
  132211. protected _updateModel(): void;
  132212. }
  132213. }
  132214. declare module BABYLON {
  132215. /**
  132216. * Class containing static functions to help procedurally build meshes
  132217. */
  132218. export class SphereBuilder {
  132219. /**
  132220. * Creates a sphere mesh
  132221. * * The parameter `diameter` sets the diameter size (float) of the sphere (default 1)
  132222. * * 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`)
  132223. * * The parameter `segments` sets the sphere number of horizontal stripes (positive integer, default 32)
  132224. * * 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
  132225. * * 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)
  132226. * * You can also set the mesh side orientation with the values : BABYLON.Mesh.FRONTSIDE (default), BABYLON.Mesh.BACKSIDE or BABYLON.Mesh.DOUBLESIDE
  132227. * * If you create a double-sided mesh, you can choose what parts of the texture image to crop and stick respectively on the front and the back sides with the parameters `frontUVs` and `backUVs` (Vector4). Detail here : https://doc.babylonjs.com/babylon101/discover_basic_elements#side-orientation
  132228. * * The mesh can be set to updatable with the boolean parameter `updatable` (default false) if its internal geometry is supposed to change once created
  132229. * @param name defines the name of the mesh
  132230. * @param options defines the options used to create the mesh
  132231. * @param scene defines the hosting scene
  132232. * @returns the sphere mesh
  132233. * @see https://doc.babylonjs.com/how_to/set_shapes#sphere
  132234. */
  132235. static CreateSphere(name: string, options: {
  132236. segments?: number;
  132237. diameter?: number;
  132238. diameterX?: number;
  132239. diameterY?: number;
  132240. diameterZ?: number;
  132241. arc?: number;
  132242. slice?: number;
  132243. sideOrientation?: number;
  132244. frontUVs?: Vector4;
  132245. backUVs?: Vector4;
  132246. updatable?: boolean;
  132247. }, scene?: Nullable<Scene>): Mesh;
  132248. }
  132249. }
  132250. declare module BABYLON {
  132251. /**
  132252. * A profiled motion controller has its profile loaded from an online repository.
  132253. * The class is responsible of loading the model, mapping the keys and enabling model-animations
  132254. */
  132255. export class WebXRProfiledMotionController extends WebXRAbstractMotionController {
  132256. private _repositoryUrl;
  132257. private _buttonMeshMapping;
  132258. private _touchDots;
  132259. /**
  132260. * The profile ID of this controller. Will be populated when the controller initializes.
  132261. */
  132262. profileId: string;
  132263. constructor(scene: Scene, xrInput: XRInputSource, _profile: IMotionControllerProfile, _repositoryUrl: string);
  132264. dispose(): void;
  132265. protected _getFilenameAndPath(): {
  132266. filename: string;
  132267. path: string;
  132268. };
  132269. protected _getModelLoadingConstraints(): boolean;
  132270. protected _processLoadedModel(_meshes: AbstractMesh[]): void;
  132271. protected _setRootMesh(meshes: AbstractMesh[]): void;
  132272. protected _updateModel(_xrFrame: XRFrame): void;
  132273. }
  132274. }
  132275. declare module BABYLON {
  132276. /**
  132277. * A construction function type to create a new controller based on an xrInput object
  132278. */
  132279. export type MotionControllerConstructor = (xrInput: XRInputSource, scene: Scene) => WebXRAbstractMotionController;
  132280. /**
  132281. * The MotionController Manager manages all registered motion controllers and loads the right one when needed.
  132282. *
  132283. * When this repository is complete: https://github.com/immersive-web/webxr-input-profiles/tree/master/packages/assets
  132284. * it should be replaced with auto-loaded controllers.
  132285. *
  132286. * When using a model try to stay as generic as possible. Eventually there will be no need in any of the controller classes
  132287. */
  132288. export class WebXRMotionControllerManager {
  132289. private static _AvailableControllers;
  132290. private static _Fallbacks;
  132291. private static _ProfileLoadingPromises;
  132292. private static _ProfilesList;
  132293. /**
  132294. * The base URL of the online controller repository. Can be changed at any time.
  132295. */
  132296. static BaseRepositoryUrl: string;
  132297. /**
  132298. * Which repository gets priority - local or online
  132299. */
  132300. static PrioritizeOnlineRepository: boolean;
  132301. /**
  132302. * Use the online repository, or use only locally-defined controllers
  132303. */
  132304. static UseOnlineRepository: boolean;
  132305. /**
  132306. * Clear the cache used for profile loading and reload when requested again
  132307. */
  132308. static ClearProfilesCache(): void;
  132309. /**
  132310. * Register the default fallbacks.
  132311. * This function is called automatically when this file is imported.
  132312. */
  132313. static DefaultFallbacks(): void;
  132314. /**
  132315. * Find a fallback profile if the profile was not found. There are a few predefined generic profiles.
  132316. * @param profileId the profile to which a fallback needs to be found
  132317. * @return an array with corresponding fallback profiles
  132318. */
  132319. static FindFallbackWithProfileId(profileId: string): string[];
  132320. /**
  132321. * When acquiring a new xrInput object (usually by the WebXRInput class), match it with the correct profile.
  132322. * The order of search:
  132323. *
  132324. * 1) Iterate the profiles array of the xr input and try finding a corresponding motion controller
  132325. * 2) (If not found) search in the gamepad id and try using it (legacy versions only)
  132326. * 3) search for registered fallbacks (should be redundant, nonetheless it makes sense to check)
  132327. * 4) return the generic trigger controller if none were found
  132328. *
  132329. * @param xrInput the xrInput to which a new controller is initialized
  132330. * @param scene the scene to which the model will be added
  132331. * @param forceProfile force a certain profile for this controller
  132332. * @return A promise that fulfils with the motion controller class for this profile id or the generic standard class if none was found
  132333. */
  132334. static GetMotionControllerWithXRInput(xrInput: XRInputSource, scene: Scene, forceProfile?: string): Promise<WebXRAbstractMotionController>;
  132335. /**
  132336. * Register a new controller based on its profile. This function will be called by the controller classes themselves.
  132337. *
  132338. * If you are missing a profile, make sure it is imported in your source, otherwise it will not register.
  132339. *
  132340. * @param type the profile type to register
  132341. * @param constructFunction the function to be called when loading this profile
  132342. */
  132343. static RegisterController(type: string, constructFunction: MotionControllerConstructor): void;
  132344. /**
  132345. * Register a fallback to a specific profile.
  132346. * @param profileId the profileId that will receive the fallbacks
  132347. * @param fallbacks A list of fallback profiles
  132348. */
  132349. static RegisterFallbacksForProfileId(profileId: string, fallbacks: string[]): void;
  132350. /**
  132351. * Will update the list of profiles available in the repository
  132352. * @return a promise that resolves to a map of profiles available online
  132353. */
  132354. static UpdateProfilesList(): Promise<{
  132355. [profile: string]: string;
  132356. }>;
  132357. private static _LoadProfileFromRepository;
  132358. private static _LoadProfilesFromAvailableControllers;
  132359. }
  132360. }
  132361. declare module BABYLON {
  132362. /**
  132363. * Configuration options for the WebXR controller creation
  132364. */
  132365. export interface IWebXRControllerOptions {
  132366. /**
  132367. * Should the controller mesh be animated when a user interacts with it
  132368. * The pressed buttons / thumbstick and touchpad animations will be disabled
  132369. */
  132370. disableMotionControllerAnimation?: boolean;
  132371. /**
  132372. * Do not load the controller mesh, in case a different mesh needs to be loaded.
  132373. */
  132374. doNotLoadControllerMesh?: boolean;
  132375. /**
  132376. * Force a specific controller type for this controller.
  132377. * This can be used when creating your own profile or when testing different controllers
  132378. */
  132379. forceControllerProfile?: string;
  132380. /**
  132381. * Defines a rendering group ID for meshes that will be loaded.
  132382. * This is for the default controllers only.
  132383. */
  132384. renderingGroupId?: number;
  132385. }
  132386. /**
  132387. * Represents an XR controller
  132388. */
  132389. export class WebXRInputSource {
  132390. private _scene;
  132391. /** The underlying input source for the controller */
  132392. inputSource: XRInputSource;
  132393. private _options;
  132394. private _tmpVector;
  132395. private _uniqueId;
  132396. private _disposed;
  132397. /**
  132398. * 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
  132399. */
  132400. grip?: AbstractMesh;
  132401. /**
  132402. * If available, this is the gamepad object related to this controller.
  132403. * Using this object it is possible to get click events and trackpad changes of the
  132404. * webxr controller that is currently being used.
  132405. */
  132406. motionController?: WebXRAbstractMotionController;
  132407. /**
  132408. * Event that fires when the controller is removed/disposed.
  132409. * The object provided as event data is this controller, after associated assets were disposed.
  132410. * uniqueId is still available.
  132411. */
  132412. onDisposeObservable: Observable<WebXRInputSource>;
  132413. /**
  132414. * Will be triggered when the mesh associated with the motion controller is done loading.
  132415. * It is also possible that this will never trigger (!) if no mesh was loaded, or if the developer decides to load a different mesh
  132416. * A shortened version of controller -> motion controller -> on mesh loaded.
  132417. */
  132418. onMeshLoadedObservable: Observable<AbstractMesh>;
  132419. /**
  132420. * Observers registered here will trigger when a motion controller profile was assigned to this xr controller
  132421. */
  132422. onMotionControllerInitObservable: Observable<WebXRAbstractMotionController>;
  132423. /**
  132424. * Pointer which can be used to select objects or attach a visible laser to
  132425. */
  132426. pointer: AbstractMesh;
  132427. /**
  132428. * Creates the input source object
  132429. * @see https://doc.babylonjs.com/how_to/webxr_controllers_support
  132430. * @param _scene the scene which the controller should be associated to
  132431. * @param inputSource the underlying input source for the controller
  132432. * @param _options options for this controller creation
  132433. */
  132434. constructor(_scene: Scene,
  132435. /** The underlying input source for the controller */
  132436. inputSource: XRInputSource, _options?: IWebXRControllerOptions);
  132437. /**
  132438. * Get this controllers unique id
  132439. */
  132440. get uniqueId(): string;
  132441. /**
  132442. * Disposes of the object
  132443. */
  132444. dispose(): void;
  132445. /**
  132446. * Gets a world space ray coming from the pointer or grip
  132447. * @param result the resulting ray
  132448. * @param gripIfAvailable use the grip mesh instead of the pointer, if available
  132449. */
  132450. getWorldPointerRayToRef(result: Ray, gripIfAvailable?: boolean): void;
  132451. /**
  132452. * Updates the controller pose based on the given XRFrame
  132453. * @param xrFrame xr frame to update the pose with
  132454. * @param referenceSpace reference space to use
  132455. */
  132456. updateFromXRFrame(xrFrame: XRFrame, referenceSpace: XRReferenceSpace): void;
  132457. }
  132458. }
  132459. declare module BABYLON {
  132460. /**
  132461. * The schema for initialization options of the XR Input class
  132462. */
  132463. export interface IWebXRInputOptions {
  132464. /**
  132465. * If set to true no model will be automatically loaded
  132466. */
  132467. doNotLoadControllerMeshes?: boolean;
  132468. /**
  132469. * If set, this profile will be used for all controllers loaded (for example "microsoft-mixed-reality")
  132470. * If not found, the xr input profile data will be used.
  132471. * Profiles are defined here - https://github.com/immersive-web/webxr-input-profiles/
  132472. */
  132473. forceInputProfile?: string;
  132474. /**
  132475. * Do not send a request to the controller repository to load the profile.
  132476. *
  132477. * Instead, use the controllers available in babylon itself.
  132478. */
  132479. disableOnlineControllerRepository?: boolean;
  132480. /**
  132481. * A custom URL for the controllers repository
  132482. */
  132483. customControllersRepositoryURL?: string;
  132484. /**
  132485. * Should the controller model's components not move according to the user input
  132486. */
  132487. disableControllerAnimation?: boolean;
  132488. /**
  132489. * Optional options to pass to the controller. Will be overridden by the Input options where applicable
  132490. */
  132491. controllerOptions?: IWebXRControllerOptions;
  132492. }
  132493. /**
  132494. * XR input used to track XR inputs such as controllers/rays
  132495. */
  132496. export class WebXRInput implements IDisposable {
  132497. /**
  132498. * the xr session manager for this session
  132499. */
  132500. xrSessionManager: WebXRSessionManager;
  132501. /**
  132502. * the WebXR camera for this session. Mainly used for teleportation
  132503. */
  132504. xrCamera: WebXRCamera;
  132505. private readonly options;
  132506. /**
  132507. * XR controllers being tracked
  132508. */
  132509. controllers: Array<WebXRInputSource>;
  132510. private _frameObserver;
  132511. private _sessionEndedObserver;
  132512. private _sessionInitObserver;
  132513. /**
  132514. * Event when a controller has been connected/added
  132515. */
  132516. onControllerAddedObservable: Observable<WebXRInputSource>;
  132517. /**
  132518. * Event when a controller has been removed/disconnected
  132519. */
  132520. onControllerRemovedObservable: Observable<WebXRInputSource>;
  132521. /**
  132522. * Initializes the WebXRInput
  132523. * @param xrSessionManager the xr session manager for this session
  132524. * @param xrCamera the WebXR camera for this session. Mainly used for teleportation
  132525. * @param options = initialization options for this xr input
  132526. */
  132527. constructor(
  132528. /**
  132529. * the xr session manager for this session
  132530. */
  132531. xrSessionManager: WebXRSessionManager,
  132532. /**
  132533. * the WebXR camera for this session. Mainly used for teleportation
  132534. */
  132535. xrCamera: WebXRCamera, options?: IWebXRInputOptions);
  132536. private _onInputSourcesChange;
  132537. private _addAndRemoveControllers;
  132538. /**
  132539. * Disposes of the object
  132540. */
  132541. dispose(): void;
  132542. }
  132543. }
  132544. declare module BABYLON {
  132545. /**
  132546. * This is the base class for all WebXR features.
  132547. * Since most features require almost the same resources and callbacks, this class can be used to simplify the development
  132548. * Note that since the features manager is using the `IWebXRFeature` you are in no way obligated to use this class
  132549. */
  132550. export abstract class WebXRAbstractFeature implements IWebXRFeature {
  132551. protected _xrSessionManager: WebXRSessionManager;
  132552. private _attached;
  132553. private _removeOnDetach;
  132554. /**
  132555. * Is this feature disposed?
  132556. */
  132557. isDisposed: boolean;
  132558. /**
  132559. * Should auto-attach be disabled?
  132560. */
  132561. disableAutoAttach: boolean;
  132562. /**
  132563. * The name of the native xr feature name (like anchor, hit-test, or hand-tracking)
  132564. */
  132565. xrNativeFeatureName: string;
  132566. /**
  132567. * Construct a new (abstract) WebXR feature
  132568. * @param _xrSessionManager the xr session manager for this feature
  132569. */
  132570. constructor(_xrSessionManager: WebXRSessionManager);
  132571. /**
  132572. * Is this feature attached
  132573. */
  132574. get attached(): boolean;
  132575. /**
  132576. * attach this feature
  132577. *
  132578. * @param force should attachment be forced (even when already attached)
  132579. * @returns true if successful, false is failed or already attached
  132580. */
  132581. attach(force?: boolean): boolean;
  132582. /**
  132583. * detach this feature.
  132584. *
  132585. * @returns true if successful, false if failed or already detached
  132586. */
  132587. detach(): boolean;
  132588. /**
  132589. * Dispose this feature and all of the resources attached
  132590. */
  132591. dispose(): void;
  132592. /**
  132593. * This function will be executed during before enabling the feature and can be used to not-allow enabling it.
  132594. * Note that at this point the session has NOT started, so this is purely checking if the browser supports it
  132595. *
  132596. * @returns whether or not the feature is compatible in this environment
  132597. */
  132598. isCompatible(): boolean;
  132599. /**
  132600. * This is used to register callbacks that will automatically be removed when detach is called.
  132601. * @param observable the observable to which the observer will be attached
  132602. * @param callback the callback to register
  132603. */
  132604. protected _addNewAttachObserver<T>(observable: Observable<T>, callback: (eventData: T, eventState: EventState) => void): void;
  132605. /**
  132606. * Code in this function will be executed on each xrFrame received from the browser.
  132607. * This function will not execute after the feature is detached.
  132608. * @param _xrFrame the current frame
  132609. */
  132610. protected abstract _onXRFrame(_xrFrame: XRFrame): void;
  132611. }
  132612. }
  132613. declare module BABYLON {
  132614. /**
  132615. * Renders a layer on top of an existing scene
  132616. */
  132617. export class UtilityLayerRenderer implements IDisposable {
  132618. /** the original scene that will be rendered on top of */
  132619. originalScene: Scene;
  132620. private _pointerCaptures;
  132621. private _lastPointerEvents;
  132622. private static _DefaultUtilityLayer;
  132623. private static _DefaultKeepDepthUtilityLayer;
  132624. private _sharedGizmoLight;
  132625. private _renderCamera;
  132626. /**
  132627. * Gets the camera that is used to render the utility layer (when not set, this will be the last active camera)
  132628. * @param getRigParentIfPossible if the current active camera is a rig camera, should its parent camera be returned
  132629. * @returns the camera that is used when rendering the utility layer
  132630. */
  132631. getRenderCamera(getRigParentIfPossible?: boolean): Camera;
  132632. /**
  132633. * Sets the camera that should be used when rendering the utility layer (If set to null the last active camera will be used)
  132634. * @param cam the camera that should be used when rendering the utility layer
  132635. */
  132636. setRenderCamera(cam: Nullable<Camera>): void;
  132637. /**
  132638. * @hidden
  132639. * Light which used by gizmos to get light shading
  132640. */
  132641. _getSharedGizmoLight(): HemisphericLight;
  132642. /**
  132643. * If the picking should be done on the utility layer prior to the actual scene (Default: true)
  132644. */
  132645. pickUtilitySceneFirst: boolean;
  132646. /**
  132647. * 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)
  132648. */
  132649. static get DefaultUtilityLayer(): UtilityLayerRenderer;
  132650. /**
  132651. * 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)
  132652. */
  132653. static get DefaultKeepDepthUtilityLayer(): UtilityLayerRenderer;
  132654. /**
  132655. * The scene that is rendered on top of the original scene
  132656. */
  132657. utilityLayerScene: Scene;
  132658. /**
  132659. * If the utility layer should automatically be rendered on top of existing scene
  132660. */
  132661. shouldRender: boolean;
  132662. /**
  132663. * If set to true, only pointer down onPointerObservable events will be blocked when picking is occluded by original scene
  132664. */
  132665. onlyCheckPointerDownEvents: boolean;
  132666. /**
  132667. * If set to false, only pointerUp, pointerDown and pointerMove will be sent to the utilityLayerScene (false by default)
  132668. */
  132669. processAllEvents: boolean;
  132670. /**
  132671. * Observable raised when the pointer move from the utility layer scene to the main scene
  132672. */
  132673. onPointerOutObservable: Observable<number>;
  132674. /** Gets or sets a predicate that will be used to indicate utility meshes present in the main scene */
  132675. mainSceneTrackerPredicate: (mesh: Nullable<AbstractMesh>) => boolean;
  132676. private _afterRenderObserver;
  132677. private _sceneDisposeObserver;
  132678. private _originalPointerObserver;
  132679. /**
  132680. * Instantiates a UtilityLayerRenderer
  132681. * @param originalScene the original scene that will be rendered on top of
  132682. * @param handleEvents boolean indicating if the utility layer should handle events
  132683. */
  132684. constructor(
  132685. /** the original scene that will be rendered on top of */
  132686. originalScene: Scene, handleEvents?: boolean);
  132687. private _notifyObservers;
  132688. /**
  132689. * Renders the utility layers scene on top of the original scene
  132690. */
  132691. render(): void;
  132692. /**
  132693. * Disposes of the renderer
  132694. */
  132695. dispose(): void;
  132696. private _updateCamera;
  132697. }
  132698. }
  132699. declare module BABYLON {
  132700. /**
  132701. * Options interface for the pointer selection module
  132702. */
  132703. export interface IWebXRControllerPointerSelectionOptions {
  132704. /**
  132705. * if provided, this scene will be used to render meshes.
  132706. */
  132707. customUtilityLayerScene?: Scene;
  132708. /**
  132709. * 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)
  132710. * If not disabled, the last picked point will be used to execute a pointer up event
  132711. * If disabled, pointer up event will be triggered right after the pointer down event.
  132712. * Used in screen and gaze target ray mode only
  132713. */
  132714. disablePointerUpOnTouchOut: boolean;
  132715. /**
  132716. * For gaze mode for tracked-pointer / controllers (time to select instead of button press)
  132717. */
  132718. forceGazeMode: boolean;
  132719. /**
  132720. * 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
  132721. * to start a new countdown to the pointer down event.
  132722. * Defaults to 1.
  132723. */
  132724. gazeModePointerMovedFactor?: number;
  132725. /**
  132726. * Different button type to use instead of the main component
  132727. */
  132728. overrideButtonId?: string;
  132729. /**
  132730. * use this rendering group id for the meshes (optional)
  132731. */
  132732. renderingGroupId?: number;
  132733. /**
  132734. * The amount of time in milliseconds it takes between pick found something to a pointer down event.
  132735. * Used in gaze modes. Tracked pointer uses the trigger, screen uses touch events
  132736. * 3000 means 3 seconds between pointing at something and selecting it
  132737. */
  132738. timeToSelect?: number;
  132739. /**
  132740. * Should meshes created here be added to a utility layer or the main scene
  132741. */
  132742. useUtilityLayer?: boolean;
  132743. /**
  132744. * Optional WebXR camera to be used for gaze selection
  132745. */
  132746. gazeCamera?: WebXRCamera;
  132747. /**
  132748. * the xr input to use with this pointer selection
  132749. */
  132750. xrInput: WebXRInput;
  132751. /**
  132752. * Should the scene pointerX and pointerY update be disabled
  132753. * This is required for fullscreen AR GUI, but might slow down other experiences.
  132754. * Disable in VR, if not needed.
  132755. * The first rig camera (left eye) will be used to calculate the projection
  132756. */
  132757. disableScenePointerVectorUpdate: boolean;
  132758. }
  132759. /**
  132760. * A module that will enable pointer selection for motion controllers of XR Input Sources
  132761. */
  132762. export class WebXRControllerPointerSelection extends WebXRAbstractFeature {
  132763. private readonly _options;
  132764. private static _idCounter;
  132765. private _attachController;
  132766. private _controllers;
  132767. private _scene;
  132768. private _tmpVectorForPickCompare;
  132769. /**
  132770. * The module's name
  132771. */
  132772. static readonly Name: string;
  132773. /**
  132774. * The (Babylon) version of this module.
  132775. * This is an integer representing the implementation version.
  132776. * This number does not correspond to the WebXR specs version
  132777. */
  132778. static readonly Version: number;
  132779. /**
  132780. * Disable lighting on the laser pointer (so it will always be visible)
  132781. */
  132782. disablePointerLighting: boolean;
  132783. /**
  132784. * Disable lighting on the selection mesh (so it will always be visible)
  132785. */
  132786. disableSelectionMeshLighting: boolean;
  132787. /**
  132788. * Should the laser pointer be displayed
  132789. */
  132790. displayLaserPointer: boolean;
  132791. /**
  132792. * Should the selection mesh be displayed (The ring at the end of the laser pointer)
  132793. */
  132794. displaySelectionMesh: boolean;
  132795. /**
  132796. * This color will be set to the laser pointer when selection is triggered
  132797. */
  132798. laserPointerPickedColor: Color3;
  132799. /**
  132800. * Default color of the laser pointer
  132801. */
  132802. laserPointerDefaultColor: Color3;
  132803. /**
  132804. * default color of the selection ring
  132805. */
  132806. selectionMeshDefaultColor: Color3;
  132807. /**
  132808. * This color will be applied to the selection ring when selection is triggered
  132809. */
  132810. selectionMeshPickedColor: Color3;
  132811. /**
  132812. * Optional filter to be used for ray selection. This predicate shares behavior with
  132813. * scene.pointerMovePredicate which takes priority if it is also assigned.
  132814. */
  132815. raySelectionPredicate: (mesh: AbstractMesh) => boolean;
  132816. /**
  132817. * constructs a new background remover module
  132818. * @param _xrSessionManager the session manager for this module
  132819. * @param _options read-only options to be used in this module
  132820. */
  132821. constructor(_xrSessionManager: WebXRSessionManager, _options: IWebXRControllerPointerSelectionOptions);
  132822. /**
  132823. * attach this feature
  132824. * Will usually be called by the features manager
  132825. *
  132826. * @returns true if successful.
  132827. */
  132828. attach(): boolean;
  132829. /**
  132830. * detach this feature.
  132831. * Will usually be called by the features manager
  132832. *
  132833. * @returns true if successful.
  132834. */
  132835. detach(): boolean;
  132836. /**
  132837. * Will get the mesh under a specific pointer.
  132838. * `scene.meshUnderPointer` will only return one mesh - either left or right.
  132839. * @param controllerId the controllerId to check
  132840. * @returns The mesh under pointer or null if no mesh is under the pointer
  132841. */
  132842. getMeshUnderPointer(controllerId: string): Nullable<AbstractMesh>;
  132843. /**
  132844. * Get the xr controller that correlates to the pointer id in the pointer event
  132845. *
  132846. * @param id the pointer id to search for
  132847. * @returns the controller that correlates to this id or null if not found
  132848. */
  132849. getXRControllerByPointerId(id: number): Nullable<WebXRInputSource>;
  132850. private _identityMatrix;
  132851. private _screenCoordinatesRef;
  132852. private _viewportRef;
  132853. protected _onXRFrame(_xrFrame: XRFrame): void;
  132854. private _attachGazeMode;
  132855. private _attachScreenRayMode;
  132856. private _attachTrackedPointerRayMode;
  132857. private _convertNormalToDirectionOfRay;
  132858. private _detachController;
  132859. private _generateNewMeshPair;
  132860. private _pickingMoved;
  132861. private _updatePointerDistance;
  132862. /** @hidden */
  132863. get lasterPointerDefaultColor(): Color3;
  132864. }
  132865. }
  132866. declare module BABYLON {
  132867. /**
  132868. * Button which can be used to enter a different mode of XR
  132869. */
  132870. export class WebXREnterExitUIButton {
  132871. /** button element */
  132872. element: HTMLElement;
  132873. /** XR initialization options for the button */
  132874. sessionMode: XRSessionMode;
  132875. /** Reference space type */
  132876. referenceSpaceType: XRReferenceSpaceType;
  132877. /**
  132878. * Creates a WebXREnterExitUIButton
  132879. * @param element button element
  132880. * @param sessionMode XR initialization session mode
  132881. * @param referenceSpaceType the type of reference space to be used
  132882. */
  132883. constructor(
  132884. /** button element */
  132885. element: HTMLElement,
  132886. /** XR initialization options for the button */
  132887. sessionMode: XRSessionMode,
  132888. /** Reference space type */
  132889. referenceSpaceType: XRReferenceSpaceType);
  132890. /**
  132891. * Extendable function which can be used to update the button's visuals when the state changes
  132892. * @param activeButton the current active button in the UI
  132893. */
  132894. update(activeButton: Nullable<WebXREnterExitUIButton>): void;
  132895. }
  132896. /**
  132897. * Options to create the webXR UI
  132898. */
  132899. export class WebXREnterExitUIOptions {
  132900. /**
  132901. * User provided buttons to enable/disable WebXR. The system will provide default if not set
  132902. */
  132903. customButtons?: Array<WebXREnterExitUIButton>;
  132904. /**
  132905. * A reference space type to use when creating the default button.
  132906. * Default is local-floor
  132907. */
  132908. referenceSpaceType?: XRReferenceSpaceType;
  132909. /**
  132910. * Context to enter xr with
  132911. */
  132912. renderTarget?: Nullable<WebXRRenderTarget>;
  132913. /**
  132914. * A session mode to use when creating the default button.
  132915. * Default is immersive-vr
  132916. */
  132917. sessionMode?: XRSessionMode;
  132918. /**
  132919. * A list of optional features to init the session with
  132920. */
  132921. optionalFeatures?: string[];
  132922. /**
  132923. * A list of optional features to init the session with
  132924. */
  132925. requiredFeatures?: string[];
  132926. }
  132927. /**
  132928. * UI to allow the user to enter/exit XR mode
  132929. */
  132930. export class WebXREnterExitUI implements IDisposable {
  132931. private scene;
  132932. /** version of the options passed to this UI */
  132933. options: WebXREnterExitUIOptions;
  132934. private _activeButton;
  132935. private _buttons;
  132936. /**
  132937. * The HTML Div Element to which buttons are added.
  132938. */
  132939. readonly overlay: HTMLDivElement;
  132940. /**
  132941. * Fired every time the active button is changed.
  132942. *
  132943. * When xr is entered via a button that launches xr that button will be the callback parameter
  132944. *
  132945. * When exiting xr the callback parameter will be null)
  132946. */
  132947. activeButtonChangedObservable: Observable<Nullable<WebXREnterExitUIButton>>;
  132948. /**
  132949. *
  132950. * @param scene babylon scene object to use
  132951. * @param options (read-only) version of the options passed to this UI
  132952. */
  132953. private constructor();
  132954. /**
  132955. * Creates UI to allow the user to enter/exit XR mode
  132956. * @param scene the scene to add the ui to
  132957. * @param helper the xr experience helper to enter/exit xr with
  132958. * @param options options to configure the UI
  132959. * @returns the created ui
  132960. */
  132961. static CreateAsync(scene: Scene, helper: WebXRExperienceHelper, options: WebXREnterExitUIOptions): Promise<WebXREnterExitUI>;
  132962. /**
  132963. * Disposes of the XR UI component
  132964. */
  132965. dispose(): void;
  132966. private _updateButtons;
  132967. }
  132968. }
  132969. declare module BABYLON {
  132970. /**
  132971. * Class containing static functions to help procedurally build meshes
  132972. */
  132973. export class LinesBuilder {
  132974. /**
  132975. * Creates a line system mesh. A line system is a pool of many lines gathered in a single mesh
  132976. * * 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
  132977. * * Like every other parametric shape, it is dynamically updatable by passing an existing instance of LineSystem to this static function
  132978. * * The parameter `lines` is an array of lines, each line being an array of successive Vector3
  132979. * * The optional parameter `instance` is an instance of an existing LineSystem object to be updated with the passed `lines` parameter
  132980. * * The optional parameter `colors` is an array of line colors, each line colors being an array of successive Color4, one per line point
  132981. * * The optional parameter `useVertexAlpha` is to be set to `false` (default `true`) when you don't need the alpha blending (faster)
  132982. * * 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
  132983. * * When updating an instance, remember that only line point positions can change, not the number of points, neither the number of lines
  132984. * * The mesh can be set to updatable with the boolean parameter `updatable` (default false) if its internal geometry is supposed to change once created
  132985. * @see https://doc.babylonjs.com/how_to/parametric_shapes#line-system
  132986. * @param name defines the name of the new line system
  132987. * @param options defines the options used to create the line system
  132988. * @param scene defines the hosting scene
  132989. * @returns a new line system mesh
  132990. */
  132991. static CreateLineSystem(name: string, options: {
  132992. lines: Vector3[][];
  132993. updatable?: boolean;
  132994. instance?: Nullable<LinesMesh>;
  132995. colors?: Nullable<Color4[][]>;
  132996. useVertexAlpha?: boolean;
  132997. }, scene: Nullable<Scene>): LinesMesh;
  132998. /**
  132999. * Creates a line mesh
  133000. * 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
  133001. * * Like every other parametric shape, it is dynamically updatable by passing an existing instance of LineMesh to this static function
  133002. * * The parameter `points` is an array successive Vector3
  133003. * * 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
  133004. * * The optional parameter `colors` is an array of successive Color4, one per line point
  133005. * * The optional parameter `useVertexAlpha` is to be set to `false` (default `true`) when you don't need alpha blending (faster)
  133006. * * When updating an instance, remember that only point positions can change, not the number of points
  133007. * * The mesh can be set to updatable with the boolean parameter `updatable` (default false) if its internal geometry is supposed to change once created
  133008. * @see https://doc.babylonjs.com/how_to/parametric_shapes#lines
  133009. * @param name defines the name of the new line system
  133010. * @param options defines the options used to create the line system
  133011. * @param scene defines the hosting scene
  133012. * @returns a new line mesh
  133013. */
  133014. static CreateLines(name: string, options: {
  133015. points: Vector3[];
  133016. updatable?: boolean;
  133017. instance?: Nullable<LinesMesh>;
  133018. colors?: Color4[];
  133019. useVertexAlpha?: boolean;
  133020. }, scene?: Nullable<Scene>): LinesMesh;
  133021. /**
  133022. * Creates a dashed line mesh
  133023. * * 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
  133024. * * Like every other parametric shape, it is dynamically updatable by passing an existing instance of LineMesh to this static function
  133025. * * The parameter `points` is an array successive Vector3
  133026. * * The parameter `dashNb` is the intended total number of dashes (positive integer, default 200)
  133027. * * The parameter `dashSize` is the size of the dashes relatively the dash number (positive float, default 3)
  133028. * * The parameter `gapSize` is the size of the gap between two successive dashes relatively the dash number (positive float, default 1)
  133029. * * 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
  133030. * * The optional parameter `useVertexAlpha` is to be set to `false` (default `true`) when you don't need the alpha blending (faster)
  133031. * * When updating an instance, remember that only point positions can change, not the number of points
  133032. * * The mesh can be set to updatable with the boolean parameter `updatable` (default false) if its internal geometry is supposed to change once created
  133033. * @param name defines the name of the mesh
  133034. * @param options defines the options used to create the mesh
  133035. * @param scene defines the hosting scene
  133036. * @returns the dashed line mesh
  133037. * @see https://doc.babylonjs.com/how_to/parametric_shapes#dashed-lines
  133038. */
  133039. static CreateDashedLines(name: string, options: {
  133040. points: Vector3[];
  133041. dashSize?: number;
  133042. gapSize?: number;
  133043. dashNb?: number;
  133044. updatable?: boolean;
  133045. instance?: LinesMesh;
  133046. useVertexAlpha?: boolean;
  133047. }, scene?: Nullable<Scene>): LinesMesh;
  133048. }
  133049. }
  133050. declare module BABYLON {
  133051. /**
  133052. * Construction options for a timer
  133053. */
  133054. export interface ITimerOptions<T> {
  133055. /**
  133056. * Time-to-end
  133057. */
  133058. timeout: number;
  133059. /**
  133060. * The context observable is used to calculate time deltas and provides the context of the timer's callbacks. Will usually be OnBeforeRenderObservable.
  133061. * Countdown calculation is done ONLY when the observable is notifying its observers, meaning that if
  133062. * you choose an observable that doesn't trigger too often, the wait time might extend further than the requested max time
  133063. */
  133064. contextObservable: Observable<T>;
  133065. /**
  133066. * Optional parameters when adding an observer to the observable
  133067. */
  133068. observableParameters?: {
  133069. mask?: number;
  133070. insertFirst?: boolean;
  133071. scope?: any;
  133072. };
  133073. /**
  133074. * An optional break condition that will stop the times prematurely. In this case onEnded will not be triggered!
  133075. */
  133076. breakCondition?: (data?: ITimerData<T>) => boolean;
  133077. /**
  133078. * Will be triggered when the time condition has met
  133079. */
  133080. onEnded?: (data: ITimerData<any>) => void;
  133081. /**
  133082. * Will be triggered when the break condition has met (prematurely ended)
  133083. */
  133084. onAborted?: (data: ITimerData<any>) => void;
  133085. /**
  133086. * Optional function to execute on each tick (or count)
  133087. */
  133088. onTick?: (data: ITimerData<any>) => void;
  133089. }
  133090. /**
  133091. * An interface defining the data sent by the timer
  133092. */
  133093. export interface ITimerData<T> {
  133094. /**
  133095. * When did it start
  133096. */
  133097. startTime: number;
  133098. /**
  133099. * Time now
  133100. */
  133101. currentTime: number;
  133102. /**
  133103. * Time passed since started
  133104. */
  133105. deltaTime: number;
  133106. /**
  133107. * How much is completed, in [0.0...1.0].
  133108. * Note that this CAN be higher than 1 due to the fact that we don't actually measure time but delta between observable calls
  133109. */
  133110. completeRate: number;
  133111. /**
  133112. * What the registered observable sent in the last count
  133113. */
  133114. payload: T;
  133115. }
  133116. /**
  133117. * The current state of the timer
  133118. */
  133119. export enum TimerState {
  133120. /**
  133121. * Timer initialized, not yet started
  133122. */
  133123. INIT = 0,
  133124. /**
  133125. * Timer started and counting
  133126. */
  133127. STARTED = 1,
  133128. /**
  133129. * Timer ended (whether aborted or time reached)
  133130. */
  133131. ENDED = 2
  133132. }
  133133. /**
  133134. * A simple version of the timer. Will take options and start the timer immediately after calling it
  133135. *
  133136. * @param options options with which to initialize this timer
  133137. */
  133138. export function setAndStartTimer(options: ITimerOptions<any>): Nullable<Observer<any>>;
  133139. /**
  133140. * An advanced implementation of a timer class
  133141. */
  133142. export class AdvancedTimer<T = any> implements IDisposable {
  133143. /**
  133144. * Will notify each time the timer calculates the remaining time
  133145. */
  133146. onEachCountObservable: Observable<ITimerData<T>>;
  133147. /**
  133148. * Will trigger when the timer was aborted due to the break condition
  133149. */
  133150. onTimerAbortedObservable: Observable<ITimerData<T>>;
  133151. /**
  133152. * Will trigger when the timer ended successfully
  133153. */
  133154. onTimerEndedObservable: Observable<ITimerData<T>>;
  133155. /**
  133156. * Will trigger when the timer state has changed
  133157. */
  133158. onStateChangedObservable: Observable<TimerState>;
  133159. private _observer;
  133160. private _contextObservable;
  133161. private _observableParameters;
  133162. private _startTime;
  133163. private _timer;
  133164. private _state;
  133165. private _breakCondition;
  133166. private _timeToEnd;
  133167. private _breakOnNextTick;
  133168. /**
  133169. * Will construct a new advanced timer based on the options provided. Timer will not start until start() is called.
  133170. * @param options construction options for this advanced timer
  133171. */
  133172. constructor(options: ITimerOptions<T>);
  133173. /**
  133174. * set a breaking condition for this timer. Default is to never break during count
  133175. * @param predicate the new break condition. Returns true to break, false otherwise
  133176. */
  133177. set breakCondition(predicate: (data: ITimerData<T>) => boolean);
  133178. /**
  133179. * Reset ALL associated observables in this advanced timer
  133180. */
  133181. clearObservables(): void;
  133182. /**
  133183. * Will start a new iteration of this timer. Only one instance of this timer can run at a time.
  133184. *
  133185. * @param timeToEnd how much time to measure until timer ended
  133186. */
  133187. start(timeToEnd?: number): void;
  133188. /**
  133189. * Will force a stop on the next tick.
  133190. */
  133191. stop(): void;
  133192. /**
  133193. * Dispose this timer, clearing all resources
  133194. */
  133195. dispose(): void;
  133196. private _setState;
  133197. private _tick;
  133198. private _stop;
  133199. }
  133200. }
  133201. declare module BABYLON {
  133202. /**
  133203. * The options container for the teleportation module
  133204. */
  133205. export interface IWebXRTeleportationOptions {
  133206. /**
  133207. * if provided, this scene will be used to render meshes.
  133208. */
  133209. customUtilityLayerScene?: Scene;
  133210. /**
  133211. * Values to configure the default target mesh
  133212. */
  133213. defaultTargetMeshOptions?: {
  133214. /**
  133215. * Fill color of the teleportation area
  133216. */
  133217. teleportationFillColor?: string;
  133218. /**
  133219. * Border color for the teleportation area
  133220. */
  133221. teleportationBorderColor?: string;
  133222. /**
  133223. * Disable the mesh's animation sequence
  133224. */
  133225. disableAnimation?: boolean;
  133226. /**
  133227. * Disable lighting on the material or the ring and arrow
  133228. */
  133229. disableLighting?: boolean;
  133230. /**
  133231. * Override the default material of the torus and arrow
  133232. */
  133233. torusArrowMaterial?: Material;
  133234. };
  133235. /**
  133236. * A list of meshes to use as floor meshes.
  133237. * Meshes can be added and removed after initializing the feature using the
  133238. * addFloorMesh and removeFloorMesh functions
  133239. * If empty, rotation will still work
  133240. */
  133241. floorMeshes?: AbstractMesh[];
  133242. /**
  133243. * use this rendering group id for the meshes (optional)
  133244. */
  133245. renderingGroupId?: number;
  133246. /**
  133247. * Should teleportation move only to snap points
  133248. */
  133249. snapPointsOnly?: boolean;
  133250. /**
  133251. * An array of points to which the teleportation will snap to.
  133252. * If the teleportation ray is in the proximity of one of those points, it will be corrected to this point.
  133253. */
  133254. snapPositions?: Vector3[];
  133255. /**
  133256. * How close should the teleportation ray be in order to snap to position.
  133257. * Default to 0.8 units (meters)
  133258. */
  133259. snapToPositionRadius?: number;
  133260. /**
  133261. * Provide your own teleportation mesh instead of babylon's wonderful doughnut.
  133262. * If you want to support rotation, make sure your mesh has a direction indicator.
  133263. *
  133264. * When left untouched, the default mesh will be initialized.
  133265. */
  133266. teleportationTargetMesh?: AbstractMesh;
  133267. /**
  133268. * If main component is used (no thumbstick), how long should the "long press" take before teleport
  133269. */
  133270. timeToTeleport?: number;
  133271. /**
  133272. * Disable using the thumbstick and use the main component (usually trigger) on long press.
  133273. * This will be automatically true if the controller doesn't have a thumbstick or touchpad.
  133274. */
  133275. useMainComponentOnly?: boolean;
  133276. /**
  133277. * Should meshes created here be added to a utility layer or the main scene
  133278. */
  133279. useUtilityLayer?: boolean;
  133280. /**
  133281. * Babylon XR Input class for controller
  133282. */
  133283. xrInput: WebXRInput;
  133284. /**
  133285. * Meshes that the teleportation ray cannot go through
  133286. */
  133287. pickBlockerMeshes?: AbstractMesh[];
  133288. }
  133289. /**
  133290. * This is a teleportation feature to be used with WebXR-enabled motion controllers.
  133291. * When enabled and attached, the feature will allow a user to move around and rotate in the scene using
  133292. * the input of the attached controllers.
  133293. */
  133294. export class WebXRMotionControllerTeleportation extends WebXRAbstractFeature {
  133295. private _options;
  133296. private _controllers;
  133297. private _currentTeleportationControllerId;
  133298. private _floorMeshes;
  133299. private _quadraticBezierCurve;
  133300. private _selectionFeature;
  133301. private _snapToPositions;
  133302. private _snappedToPoint;
  133303. private _teleportationRingMaterial?;
  133304. private _tmpRay;
  133305. private _tmpVector;
  133306. private _tmpQuaternion;
  133307. /**
  133308. * The module's name
  133309. */
  133310. static readonly Name: string;
  133311. /**
  133312. * The (Babylon) version of this module.
  133313. * This is an integer representing the implementation version.
  133314. * This number does not correspond to the webxr specs version
  133315. */
  133316. static readonly Version: number;
  133317. /**
  133318. * Is movement backwards enabled
  133319. */
  133320. backwardsMovementEnabled: boolean;
  133321. /**
  133322. * Distance to travel when moving backwards
  133323. */
  133324. backwardsTeleportationDistance: number;
  133325. /**
  133326. * The distance from the user to the inspection point in the direction of the controller
  133327. * A higher number will allow the user to move further
  133328. * defaults to 5 (meters, in xr units)
  133329. */
  133330. parabolicCheckRadius: number;
  133331. /**
  133332. * Should the module support parabolic ray on top of direct ray
  133333. * If enabled, the user will be able to point "at the sky" and move according to predefined radius distance
  133334. * Very helpful when moving between floors / different heights
  133335. */
  133336. parabolicRayEnabled: boolean;
  133337. /**
  133338. * How much rotation should be applied when rotating right and left
  133339. */
  133340. rotationAngle: number;
  133341. /**
  133342. * Is rotation enabled when moving forward?
  133343. * Disabling this feature will prevent the user from deciding the direction when teleporting
  133344. */
  133345. rotationEnabled: boolean;
  133346. /**
  133347. * constructs a new anchor system
  133348. * @param _xrSessionManager an instance of WebXRSessionManager
  133349. * @param _options configuration object for this feature
  133350. */
  133351. constructor(_xrSessionManager: WebXRSessionManager, _options: IWebXRTeleportationOptions);
  133352. /**
  133353. * Get the snapPointsOnly flag
  133354. */
  133355. get snapPointsOnly(): boolean;
  133356. /**
  133357. * Sets the snapPointsOnly flag
  133358. * @param snapToPoints should teleportation be exclusively to snap points
  133359. */
  133360. set snapPointsOnly(snapToPoints: boolean);
  133361. /**
  133362. * Add a new mesh to the floor meshes array
  133363. * @param mesh the mesh to use as floor mesh
  133364. */
  133365. addFloorMesh(mesh: AbstractMesh): void;
  133366. /**
  133367. * Add a new snap-to point to fix teleportation to this position
  133368. * @param newSnapPoint The new Snap-To point
  133369. */
  133370. addSnapPoint(newSnapPoint: Vector3): void;
  133371. attach(): boolean;
  133372. detach(): boolean;
  133373. dispose(): void;
  133374. /**
  133375. * Remove a mesh from the floor meshes array
  133376. * @param mesh the mesh to remove
  133377. */
  133378. removeFloorMesh(mesh: AbstractMesh): void;
  133379. /**
  133380. * Remove a mesh from the floor meshes array using its name
  133381. * @param name the mesh name to remove
  133382. */
  133383. removeFloorMeshByName(name: string): void;
  133384. /**
  133385. * 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
  133386. * @param snapPointToRemove the point (or a clone of it) to be removed from the array
  133387. * @returns was the point found and removed or not
  133388. */
  133389. removeSnapPoint(snapPointToRemove: Vector3): boolean;
  133390. /**
  133391. * This function sets a selection feature that will be disabled when
  133392. * the forward ray is shown and will be reattached when hidden.
  133393. * This is used to remove the selection rays when moving.
  133394. * @param selectionFeature the feature to disable when forward movement is enabled
  133395. */
  133396. setSelectionFeature(selectionFeature: Nullable<IWebXRFeature>): void;
  133397. protected _onXRFrame(_xrFrame: XRFrame): void;
  133398. private _attachController;
  133399. private _createDefaultTargetMesh;
  133400. private _detachController;
  133401. private _findClosestSnapPointWithRadius;
  133402. private _setTargetMeshPosition;
  133403. private _setTargetMeshVisibility;
  133404. private _showParabolicPath;
  133405. private _teleportForward;
  133406. }
  133407. }
  133408. declare module BABYLON {
  133409. /**
  133410. * Options for the default xr helper
  133411. */
  133412. export class WebXRDefaultExperienceOptions {
  133413. /**
  133414. * Enable or disable default UI to enter XR
  133415. */
  133416. disableDefaultUI?: boolean;
  133417. /**
  133418. * Should teleportation not initialize. defaults to false.
  133419. */
  133420. disableTeleportation?: boolean;
  133421. /**
  133422. * Floor meshes that will be used for teleport
  133423. */
  133424. floorMeshes?: Array<AbstractMesh>;
  133425. /**
  133426. * If set to true, the first frame will not be used to reset position
  133427. * The first frame is mainly used when copying transformation from the old camera
  133428. * Mainly used in AR
  133429. */
  133430. ignoreNativeCameraTransformation?: boolean;
  133431. /**
  133432. * Disable the controller mesh-loading. Can be used if you want to load your own meshes
  133433. */
  133434. inputOptions?: IWebXRInputOptions;
  133435. /**
  133436. * optional configuration for the output canvas
  133437. */
  133438. outputCanvasOptions?: WebXRManagedOutputCanvasOptions;
  133439. /**
  133440. * optional UI options. This can be used among other to change session mode and reference space type
  133441. */
  133442. uiOptions?: WebXREnterExitUIOptions;
  133443. /**
  133444. * When loading teleportation and pointer select, use stable versions instead of latest.
  133445. */
  133446. useStablePlugins?: boolean;
  133447. /**
  133448. * An optional rendering group id that will be set globally for teleportation, pointer selection and default controller meshes
  133449. */
  133450. renderingGroupId?: number;
  133451. /**
  133452. * A list of optional features to init the session with
  133453. * If set to true, all features we support will be added
  133454. */
  133455. optionalFeatures?: boolean | string[];
  133456. }
  133457. /**
  133458. * Default experience which provides a similar setup to the previous webVRExperience
  133459. */
  133460. export class WebXRDefaultExperience {
  133461. /**
  133462. * Base experience
  133463. */
  133464. baseExperience: WebXRExperienceHelper;
  133465. /**
  133466. * Enables ui for entering/exiting xr
  133467. */
  133468. enterExitUI: WebXREnterExitUI;
  133469. /**
  133470. * Input experience extension
  133471. */
  133472. input: WebXRInput;
  133473. /**
  133474. * Enables laser pointer and selection
  133475. */
  133476. pointerSelection: WebXRControllerPointerSelection;
  133477. /**
  133478. * Default target xr should render to
  133479. */
  133480. renderTarget: WebXRRenderTarget;
  133481. /**
  133482. * Enables teleportation
  133483. */
  133484. teleportation: WebXRMotionControllerTeleportation;
  133485. private constructor();
  133486. /**
  133487. * Creates the default xr experience
  133488. * @param scene scene
  133489. * @param options options for basic configuration
  133490. * @returns resulting WebXRDefaultExperience
  133491. */
  133492. static CreateAsync(scene: Scene, options?: WebXRDefaultExperienceOptions): Promise<WebXRDefaultExperience>;
  133493. /**
  133494. * DIsposes of the experience helper
  133495. */
  133496. dispose(): void;
  133497. }
  133498. }
  133499. declare module BABYLON {
  133500. /**
  133501. * Options to modify the vr teleportation behavior.
  133502. */
  133503. export interface VRTeleportationOptions {
  133504. /**
  133505. * The name of the mesh which should be used as the teleportation floor. (default: null)
  133506. */
  133507. floorMeshName?: string;
  133508. /**
  133509. * A list of meshes to be used as the teleportation floor. (default: empty)
  133510. */
  133511. floorMeshes?: Mesh[];
  133512. /**
  133513. * The teleportation mode. (default: TELEPORTATIONMODE_CONSTANTTIME)
  133514. */
  133515. teleportationMode?: number;
  133516. /**
  133517. * The duration of the animation in ms, apply when animationMode is TELEPORTATIONMODE_CONSTANTTIME. (default 122ms)
  133518. */
  133519. teleportationTime?: number;
  133520. /**
  133521. * The speed of the animation in distance/sec, apply when animationMode is TELEPORTATIONMODE_CONSTANTSPEED. (default 20 units / sec)
  133522. */
  133523. teleportationSpeed?: number;
  133524. /**
  133525. * The easing function used in the animation or null for Linear. (default CircleEase)
  133526. */
  133527. easingFunction?: EasingFunction;
  133528. }
  133529. /**
  133530. * Options to modify the vr experience helper's behavior.
  133531. */
  133532. export interface VRExperienceHelperOptions extends WebVROptions {
  133533. /**
  133534. * Create a DeviceOrientationCamera to be used as your out of vr camera. (default: true)
  133535. */
  133536. createDeviceOrientationCamera?: boolean;
  133537. /**
  133538. * Create a VRDeviceOrientationFreeCamera to be used for VR when no external HMD is found. (default: true)
  133539. */
  133540. createFallbackVRDeviceOrientationFreeCamera?: boolean;
  133541. /**
  133542. * Uses the main button on the controller to toggle the laser casted. (default: true)
  133543. */
  133544. laserToggle?: boolean;
  133545. /**
  133546. * A list of meshes to be used as the teleportation floor. If specified, teleportation will be enabled (default: undefined)
  133547. */
  133548. floorMeshes?: Mesh[];
  133549. /**
  133550. * Distortion metrics for the fallback vrDeviceOrientationCamera (default: VRCameraMetrics.Default)
  133551. */
  133552. vrDeviceOrientationCameraMetrics?: VRCameraMetrics;
  133553. /**
  133554. * Defines if WebXR should be used instead of WebVR (if available)
  133555. */
  133556. useXR?: boolean;
  133557. }
  133558. /**
  133559. * Event containing information after VR has been entered
  133560. */
  133561. export class OnAfterEnteringVRObservableEvent {
  133562. /**
  133563. * If entering vr was successful
  133564. */
  133565. success: boolean;
  133566. }
  133567. /**
  133568. * Helps to quickly add VR support to an existing scene.
  133569. * See https://doc.babylonjs.com/how_to/webvr_helper
  133570. */
  133571. export class VRExperienceHelper {
  133572. /** Options to modify the vr experience helper's behavior. */
  133573. webVROptions: VRExperienceHelperOptions;
  133574. private _scene;
  133575. private _position;
  133576. private _btnVR;
  133577. private _btnVRDisplayed;
  133578. private _webVRsupported;
  133579. private _webVRready;
  133580. private _webVRrequesting;
  133581. private _webVRpresenting;
  133582. private _hasEnteredVR;
  133583. private _fullscreenVRpresenting;
  133584. private _inputElement;
  133585. private _webVRCamera;
  133586. private _vrDeviceOrientationCamera;
  133587. private _deviceOrientationCamera;
  133588. private _existingCamera;
  133589. private _onKeyDown;
  133590. private _onVrDisplayPresentChange;
  133591. private _onVRDisplayChanged;
  133592. private _onVRRequestPresentStart;
  133593. private _onVRRequestPresentComplete;
  133594. /**
  133595. * 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)
  133596. */
  133597. enableGazeEvenWhenNoPointerLock: boolean;
  133598. /**
  133599. * Gets or sets a boolean indicating that the VREXperienceHelper will exit VR if double tap is detected
  133600. */
  133601. exitVROnDoubleTap: boolean;
  133602. /**
  133603. * Observable raised right before entering VR.
  133604. */
  133605. onEnteringVRObservable: Observable<VRExperienceHelper>;
  133606. /**
  133607. * Observable raised when entering VR has completed.
  133608. */
  133609. onAfterEnteringVRObservable: Observable<OnAfterEnteringVRObservableEvent>;
  133610. /**
  133611. * Observable raised when exiting VR.
  133612. */
  133613. onExitingVRObservable: Observable<VRExperienceHelper>;
  133614. /**
  133615. * Observable raised when controller mesh is loaded.
  133616. */
  133617. onControllerMeshLoadedObservable: Observable<WebVRController>;
  133618. /** Return this.onEnteringVRObservable
  133619. * Note: This one is for backward compatibility. Please use onEnteringVRObservable directly
  133620. */
  133621. get onEnteringVR(): Observable<VRExperienceHelper>;
  133622. /** Return this.onExitingVRObservable
  133623. * Note: This one is for backward compatibility. Please use onExitingVRObservable directly
  133624. */
  133625. get onExitingVR(): Observable<VRExperienceHelper>;
  133626. /** Return this.onControllerMeshLoadedObservable
  133627. * Note: This one is for backward compatibility. Please use onControllerMeshLoadedObservable directly
  133628. */
  133629. get onControllerMeshLoaded(): Observable<WebVRController>;
  133630. private _rayLength;
  133631. private _useCustomVRButton;
  133632. private _teleportationRequested;
  133633. private _teleportActive;
  133634. private _floorMeshName;
  133635. private _floorMeshesCollection;
  133636. private _teleportationMode;
  133637. private _teleportationTime;
  133638. private _teleportationSpeed;
  133639. private _teleportationEasing;
  133640. private _rotationAllowed;
  133641. private _teleportBackwardsVector;
  133642. private _teleportationTarget;
  133643. private _isDefaultTeleportationTarget;
  133644. private _postProcessMove;
  133645. private _teleportationFillColor;
  133646. private _teleportationBorderColor;
  133647. private _rotationAngle;
  133648. private _haloCenter;
  133649. private _cameraGazer;
  133650. private _padSensibilityUp;
  133651. private _padSensibilityDown;
  133652. private _leftController;
  133653. private _rightController;
  133654. private _gazeColor;
  133655. private _laserColor;
  133656. private _pickedLaserColor;
  133657. private _pickedGazeColor;
  133658. /**
  133659. * Observable raised when a new mesh is selected based on meshSelectionPredicate
  133660. */
  133661. onNewMeshSelected: Observable<AbstractMesh>;
  133662. /**
  133663. * Observable raised when a new mesh is selected based on meshSelectionPredicate.
  133664. * This observable will provide the mesh and the controller used to select the mesh
  133665. */
  133666. onMeshSelectedWithController: Observable<{
  133667. mesh: AbstractMesh;
  133668. controller: WebVRController;
  133669. }>;
  133670. /**
  133671. * Observable raised when a new mesh is picked based on meshSelectionPredicate
  133672. */
  133673. onNewMeshPicked: Observable<PickingInfo>;
  133674. private _circleEase;
  133675. /**
  133676. * Observable raised before camera teleportation
  133677. */
  133678. onBeforeCameraTeleport: Observable<Vector3>;
  133679. /**
  133680. * Observable raised after camera teleportation
  133681. */
  133682. onAfterCameraTeleport: Observable<Vector3>;
  133683. /**
  133684. * Observable raised when current selected mesh gets unselected
  133685. */
  133686. onSelectedMeshUnselected: Observable<AbstractMesh>;
  133687. private _raySelectionPredicate;
  133688. /**
  133689. * To be optionaly changed by user to define custom ray selection
  133690. */
  133691. raySelectionPredicate: (mesh: AbstractMesh) => boolean;
  133692. /**
  133693. * To be optionaly changed by user to define custom selection logic (after ray selection)
  133694. */
  133695. meshSelectionPredicate: (mesh: AbstractMesh) => boolean;
  133696. /**
  133697. * Set teleportation enabled. If set to false camera teleportation will be disabled but camera rotation will be kept.
  133698. */
  133699. teleportationEnabled: boolean;
  133700. private _defaultHeight;
  133701. private _teleportationInitialized;
  133702. private _interactionsEnabled;
  133703. private _interactionsRequested;
  133704. private _displayGaze;
  133705. private _displayLaserPointer;
  133706. /**
  133707. * The mesh used to display where the user is going to teleport.
  133708. */
  133709. get teleportationTarget(): Mesh;
  133710. /**
  133711. * Sets the mesh to be used to display where the user is going to teleport.
  133712. */
  133713. set teleportationTarget(value: Mesh);
  133714. /**
  133715. * 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
  133716. * when set bakeCurrentTransformIntoVertices will be called on the mesh.
  133717. * See https://doc.babylonjs.com/resources/baking_transformations
  133718. */
  133719. get gazeTrackerMesh(): Mesh;
  133720. set gazeTrackerMesh(value: Mesh);
  133721. /**
  133722. * If the gaze trackers scale should be updated to be constant size when pointing at near/far meshes
  133723. */
  133724. updateGazeTrackerScale: boolean;
  133725. /**
  133726. * If the gaze trackers color should be updated when selecting meshes
  133727. */
  133728. updateGazeTrackerColor: boolean;
  133729. /**
  133730. * If the controller laser color should be updated when selecting meshes
  133731. */
  133732. updateControllerLaserColor: boolean;
  133733. /**
  133734. * The gaze tracking mesh corresponding to the left controller
  133735. */
  133736. get leftControllerGazeTrackerMesh(): Nullable<Mesh>;
  133737. /**
  133738. * The gaze tracking mesh corresponding to the right controller
  133739. */
  133740. get rightControllerGazeTrackerMesh(): Nullable<Mesh>;
  133741. /**
  133742. * If the ray of the gaze should be displayed.
  133743. */
  133744. get displayGaze(): boolean;
  133745. /**
  133746. * Sets if the ray of the gaze should be displayed.
  133747. */
  133748. set displayGaze(value: boolean);
  133749. /**
  133750. * If the ray of the LaserPointer should be displayed.
  133751. */
  133752. get displayLaserPointer(): boolean;
  133753. /**
  133754. * Sets if the ray of the LaserPointer should be displayed.
  133755. */
  133756. set displayLaserPointer(value: boolean);
  133757. /**
  133758. * The deviceOrientationCamera used as the camera when not in VR.
  133759. */
  133760. get deviceOrientationCamera(): Nullable<DeviceOrientationCamera>;
  133761. /**
  133762. * Based on the current WebVR support, returns the current VR camera used.
  133763. */
  133764. get currentVRCamera(): Nullable<Camera>;
  133765. /**
  133766. * The webVRCamera which is used when in VR.
  133767. */
  133768. get webVRCamera(): WebVRFreeCamera;
  133769. /**
  133770. * The deviceOrientationCamera that is used as a fallback when vr device is not connected.
  133771. */
  133772. get vrDeviceOrientationCamera(): Nullable<VRDeviceOrientationFreeCamera>;
  133773. /**
  133774. * The html button that is used to trigger entering into VR.
  133775. */
  133776. get vrButton(): Nullable<HTMLButtonElement>;
  133777. private get _teleportationRequestInitiated();
  133778. /**
  133779. * Defines whether or not Pointer lock should be requested when switching to
  133780. * full screen.
  133781. */
  133782. requestPointerLockOnFullScreen: boolean;
  133783. /**
  133784. * If asking to force XR, this will be populated with the default xr experience
  133785. */
  133786. xr: WebXRDefaultExperience;
  133787. /**
  133788. * Was the XR test done already. If this is true AND this.xr exists, xr is initialized.
  133789. * If this is true and no this.xr, xr exists but is not supported, using WebVR.
  133790. */
  133791. xrTestDone: boolean;
  133792. /**
  133793. * Instantiates a VRExperienceHelper.
  133794. * Helps to quickly add VR support to an existing scene.
  133795. * @param scene The scene the VRExperienceHelper belongs to.
  133796. * @param webVROptions Options to modify the vr experience helper's behavior.
  133797. */
  133798. constructor(scene: Scene,
  133799. /** Options to modify the vr experience helper's behavior. */
  133800. webVROptions?: VRExperienceHelperOptions);
  133801. private completeVRInit;
  133802. private _onDefaultMeshLoaded;
  133803. private _onResize;
  133804. private _onFullscreenChange;
  133805. /**
  133806. * Gets a value indicating if we are currently in VR mode.
  133807. */
  133808. get isInVRMode(): boolean;
  133809. private onVrDisplayPresentChange;
  133810. private onVRDisplayChanged;
  133811. private moveButtonToBottomRight;
  133812. private displayVRButton;
  133813. private updateButtonVisibility;
  133814. private _cachedAngularSensibility;
  133815. /**
  133816. * Attempt to enter VR. If a headset is connected and ready, will request present on that.
  133817. * Otherwise, will use the fullscreen API.
  133818. */
  133819. enterVR(): void;
  133820. /**
  133821. * Attempt to exit VR, or fullscreen.
  133822. */
  133823. exitVR(): void;
  133824. /**
  133825. * The position of the vr experience helper.
  133826. */
  133827. get position(): Vector3;
  133828. /**
  133829. * Sets the position of the vr experience helper.
  133830. */
  133831. set position(value: Vector3);
  133832. /**
  133833. * Enables controllers and user interactions such as selecting and object or clicking on an object.
  133834. */
  133835. enableInteractions(): void;
  133836. private get _noControllerIsActive();
  133837. private beforeRender;
  133838. private _isTeleportationFloor;
  133839. /**
  133840. * Adds a floor mesh to be used for teleportation.
  133841. * @param floorMesh the mesh to be used for teleportation.
  133842. */
  133843. addFloorMesh(floorMesh: Mesh): void;
  133844. /**
  133845. * Removes a floor mesh from being used for teleportation.
  133846. * @param floorMesh the mesh to be removed.
  133847. */
  133848. removeFloorMesh(floorMesh: Mesh): void;
  133849. /**
  133850. * Enables interactions and teleportation using the VR controllers and gaze.
  133851. * @param vrTeleportationOptions options to modify teleportation behavior.
  133852. */
  133853. enableTeleportation(vrTeleportationOptions?: VRTeleportationOptions): void;
  133854. private _onNewGamepadConnected;
  133855. private _tryEnableInteractionOnController;
  133856. private _onNewGamepadDisconnected;
  133857. private _enableInteractionOnController;
  133858. private _checkTeleportWithRay;
  133859. private _checkRotate;
  133860. private _checkTeleportBackwards;
  133861. private _enableTeleportationOnController;
  133862. private _createTeleportationCircles;
  133863. private _displayTeleportationTarget;
  133864. private _hideTeleportationTarget;
  133865. private _rotateCamera;
  133866. private _moveTeleportationSelectorTo;
  133867. private _workingVector;
  133868. private _workingQuaternion;
  133869. private _workingMatrix;
  133870. /**
  133871. * Time Constant Teleportation Mode
  133872. */
  133873. static readonly TELEPORTATIONMODE_CONSTANTTIME: number;
  133874. /**
  133875. * Speed Constant Teleportation Mode
  133876. */
  133877. static readonly TELEPORTATIONMODE_CONSTANTSPEED: number;
  133878. /**
  133879. * Teleports the users feet to the desired location
  133880. * @param location The location where the user's feet should be placed
  133881. */
  133882. teleportCamera(location: Vector3): void;
  133883. private _convertNormalToDirectionOfRay;
  133884. private _castRayAndSelectObject;
  133885. private _notifySelectedMeshUnselected;
  133886. /**
  133887. * Permanently set new colors for the laser pointer
  133888. * @param color the new laser color
  133889. * @param pickedColor the new laser color when picked mesh detected
  133890. */
  133891. setLaserColor(color: Color3, pickedColor?: Color3): void;
  133892. /**
  133893. * Set lighting enabled / disabled on the laser pointer of both controllers
  133894. * @param enabled should the lighting be enabled on the laser pointer
  133895. */
  133896. setLaserLightingState(enabled?: boolean): void;
  133897. /**
  133898. * Permanently set new colors for the gaze pointer
  133899. * @param color the new gaze color
  133900. * @param pickedColor the new gaze color when picked mesh detected
  133901. */
  133902. setGazeColor(color: Color3, pickedColor?: Color3): void;
  133903. /**
  133904. * Sets the color of the laser ray from the vr controllers.
  133905. * @param color new color for the ray.
  133906. */
  133907. changeLaserColor(color: Color3): void;
  133908. /**
  133909. * Sets the color of the ray from the vr headsets gaze.
  133910. * @param color new color for the ray.
  133911. */
  133912. changeGazeColor(color: Color3): void;
  133913. /**
  133914. * Exits VR and disposes of the vr experience helper
  133915. */
  133916. dispose(): void;
  133917. /**
  133918. * Gets the name of the VRExperienceHelper class
  133919. * @returns "VRExperienceHelper"
  133920. */
  133921. getClassName(): string;
  133922. }
  133923. }
  133924. declare module BABYLON {
  133925. /**
  133926. * Contains an array of blocks representing the octree
  133927. */
  133928. export interface IOctreeContainer<T> {
  133929. /**
  133930. * Blocks within the octree
  133931. */
  133932. blocks: Array<OctreeBlock<T>>;
  133933. }
  133934. /**
  133935. * Class used to store a cell in an octree
  133936. * @see https://doc.babylonjs.com/how_to/optimizing_your_scene_with_octrees
  133937. */
  133938. export class OctreeBlock<T> {
  133939. /**
  133940. * Gets the content of the current block
  133941. */
  133942. entries: T[];
  133943. /**
  133944. * Gets the list of block children
  133945. */
  133946. blocks: Array<OctreeBlock<T>>;
  133947. private _depth;
  133948. private _maxDepth;
  133949. private _capacity;
  133950. private _minPoint;
  133951. private _maxPoint;
  133952. private _boundingVectors;
  133953. private _creationFunc;
  133954. /**
  133955. * Creates a new block
  133956. * @param minPoint defines the minimum vector (in world space) of the block's bounding box
  133957. * @param maxPoint defines the maximum vector (in world space) of the block's bounding box
  133958. * @param capacity defines the maximum capacity of this block (if capacity is reached the block will be split into sub blocks)
  133959. * @param depth defines the current depth of this block in the octree
  133960. * @param maxDepth defines the maximal depth allowed (beyond this value, the capacity is ignored)
  133961. * @param creationFunc defines a callback to call when an element is added to the block
  133962. */
  133963. constructor(minPoint: Vector3, maxPoint: Vector3, capacity: number, depth: number, maxDepth: number, creationFunc: (entry: T, block: OctreeBlock<T>) => void);
  133964. /**
  133965. * Gets the maximum capacity of this block (if capacity is reached the block will be split into sub blocks)
  133966. */
  133967. get capacity(): number;
  133968. /**
  133969. * Gets the minimum vector (in world space) of the block's bounding box
  133970. */
  133971. get minPoint(): Vector3;
  133972. /**
  133973. * Gets the maximum vector (in world space) of the block's bounding box
  133974. */
  133975. get maxPoint(): Vector3;
  133976. /**
  133977. * Add a new element to this block
  133978. * @param entry defines the element to add
  133979. */
  133980. addEntry(entry: T): void;
  133981. /**
  133982. * Remove an element from this block
  133983. * @param entry defines the element to remove
  133984. */
  133985. removeEntry(entry: T): void;
  133986. /**
  133987. * Add an array of elements to this block
  133988. * @param entries defines the array of elements to add
  133989. */
  133990. addEntries(entries: T[]): void;
  133991. /**
  133992. * Test if the current block intersects the furstum planes and if yes, then add its content to the selection array
  133993. * @param frustumPlanes defines the frustum planes to test
  133994. * @param selection defines the array to store current content if selection is positive
  133995. * @param allowDuplicate defines if the selection array can contains duplicated entries
  133996. */
  133997. select(frustumPlanes: Plane[], selection: SmartArrayNoDuplicate<T>, allowDuplicate?: boolean): void;
  133998. /**
  133999. * Test if the current block intersect with the given bounding sphere and if yes, then add its content to the selection array
  134000. * @param sphereCenter defines the bounding sphere center
  134001. * @param sphereRadius defines the bounding sphere radius
  134002. * @param selection defines the array to store current content if selection is positive
  134003. * @param allowDuplicate defines if the selection array can contains duplicated entries
  134004. */
  134005. intersects(sphereCenter: Vector3, sphereRadius: number, selection: SmartArrayNoDuplicate<T>, allowDuplicate?: boolean): void;
  134006. /**
  134007. * Test if the current block intersect with the given ray and if yes, then add its content to the selection array
  134008. * @param ray defines the ray to test with
  134009. * @param selection defines the array to store current content if selection is positive
  134010. */
  134011. intersectsRay(ray: Ray, selection: SmartArrayNoDuplicate<T>): void;
  134012. /**
  134013. * Subdivide the content into child blocks (this block will then be empty)
  134014. */
  134015. createInnerBlocks(): void;
  134016. /**
  134017. * @hidden
  134018. */
  134019. 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;
  134020. }
  134021. }
  134022. declare module BABYLON {
  134023. /**
  134024. * Octrees are a really powerful data structure that can quickly select entities based on space coordinates.
  134025. * @see https://doc.babylonjs.com/how_to/optimizing_your_scene_with_octrees
  134026. */
  134027. export class Octree<T> {
  134028. /** 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.) */
  134029. maxDepth: number;
  134030. /**
  134031. * Blocks within the octree containing objects
  134032. */
  134033. blocks: Array<OctreeBlock<T>>;
  134034. /**
  134035. * Content stored in the octree
  134036. */
  134037. dynamicContent: T[];
  134038. private _maxBlockCapacity;
  134039. private _selectionContent;
  134040. private _creationFunc;
  134041. /**
  134042. * Creates a octree
  134043. * @see https://doc.babylonjs.com/how_to/optimizing_your_scene_with_octrees
  134044. * @param creationFunc function to be used to instatiate the octree
  134045. * @param maxBlockCapacity defines the maximum number of meshes you want on your octree's leaves (default: 64)
  134046. * @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.)
  134047. */
  134048. constructor(creationFunc: (entry: T, block: OctreeBlock<T>) => void, maxBlockCapacity?: number,
  134049. /** 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.) */
  134050. maxDepth?: number);
  134051. /**
  134052. * Updates the octree by adding blocks for the passed in meshes within the min and max world parameters
  134053. * @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);
  134054. * @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);
  134055. * @param entries meshes to be added to the octree blocks
  134056. */
  134057. update(worldMin: Vector3, worldMax: Vector3, entries: T[]): void;
  134058. /**
  134059. * Adds a mesh to the octree
  134060. * @param entry Mesh to add to the octree
  134061. */
  134062. addMesh(entry: T): void;
  134063. /**
  134064. * Remove an element from the octree
  134065. * @param entry defines the element to remove
  134066. */
  134067. removeMesh(entry: T): void;
  134068. /**
  134069. * Selects an array of meshes within the frustum
  134070. * @param frustumPlanes The frustum planes to use which will select all meshes within it
  134071. * @param allowDuplicate If duplicate objects are allowed in the resulting object array
  134072. * @returns array of meshes within the frustum
  134073. */
  134074. select(frustumPlanes: Plane[], allowDuplicate?: boolean): SmartArray<T>;
  134075. /**
  134076. * Test if the octree intersect with the given bounding sphere and if yes, then add its content to the selection array
  134077. * @param sphereCenter defines the bounding sphere center
  134078. * @param sphereRadius defines the bounding sphere radius
  134079. * @param allowDuplicate defines if the selection array can contains duplicated entries
  134080. * @returns an array of objects that intersect the sphere
  134081. */
  134082. intersects(sphereCenter: Vector3, sphereRadius: number, allowDuplicate?: boolean): SmartArray<T>;
  134083. /**
  134084. * Test if the octree intersect with the given ray and if yes, then add its content to resulting array
  134085. * @param ray defines the ray to test with
  134086. * @returns array of intersected objects
  134087. */
  134088. intersectsRay(ray: Ray): SmartArray<T>;
  134089. /**
  134090. * Adds a mesh into the octree block if it intersects the block
  134091. */
  134092. static CreationFuncForMeshes: (entry: AbstractMesh, block: OctreeBlock<AbstractMesh>) => void;
  134093. /**
  134094. * Adds a submesh into the octree block if it intersects the block
  134095. */
  134096. static CreationFuncForSubMeshes: (entry: SubMesh, block: OctreeBlock<SubMesh>) => void;
  134097. }
  134098. }
  134099. declare module BABYLON {
  134100. interface Scene {
  134101. /**
  134102. * @hidden
  134103. * Backing Filed
  134104. */
  134105. _selectionOctree: Octree<AbstractMesh>;
  134106. /**
  134107. * Gets the octree used to boost mesh selection (picking)
  134108. * @see https://doc.babylonjs.com/how_to/optimizing_your_scene_with_octrees
  134109. */
  134110. selectionOctree: Octree<AbstractMesh>;
  134111. /**
  134112. * Creates or updates the octree used to boost selection (picking)
  134113. * @see https://doc.babylonjs.com/how_to/optimizing_your_scene_with_octrees
  134114. * @param maxCapacity defines the maximum capacity per leaf
  134115. * @param maxDepth defines the maximum depth of the octree
  134116. * @returns an octree of AbstractMesh
  134117. */
  134118. createOrUpdateSelectionOctree(maxCapacity?: number, maxDepth?: number): Octree<AbstractMesh>;
  134119. }
  134120. interface AbstractMesh {
  134121. /**
  134122. * @hidden
  134123. * Backing Field
  134124. */
  134125. _submeshesOctree: Octree<SubMesh>;
  134126. /**
  134127. * This function will create an octree to help to select the right submeshes for rendering, picking and collision computations.
  134128. * Please note that you must have a decent number of submeshes to get performance improvements when using an octree
  134129. * @param maxCapacity defines the maximum size of each block (64 by default)
  134130. * @param maxDepth defines the maximum depth to use (no more than 2 levels by default)
  134131. * @returns the new octree
  134132. * @see https://www.babylonjs-playground.com/#NA4OQ#12
  134133. * @see https://doc.babylonjs.com/how_to/optimizing_your_scene_with_octrees
  134134. */
  134135. createOrUpdateSubmeshesOctree(maxCapacity?: number, maxDepth?: number): Octree<SubMesh>;
  134136. }
  134137. /**
  134138. * Defines the octree scene component responsible to manage any octrees
  134139. * in a given scene.
  134140. */
  134141. export class OctreeSceneComponent {
  134142. /**
  134143. * The component name help to identify the component in the list of scene components.
  134144. */
  134145. readonly name: string;
  134146. /**
  134147. * The scene the component belongs to.
  134148. */
  134149. scene: Scene;
  134150. /**
  134151. * Indicates if the meshes have been checked to make sure they are isEnabled()
  134152. */
  134153. readonly checksIsEnabled: boolean;
  134154. /**
  134155. * Creates a new instance of the component for the given scene
  134156. * @param scene Defines the scene to register the component in
  134157. */
  134158. constructor(scene: Scene);
  134159. /**
  134160. * Registers the component in a given scene
  134161. */
  134162. register(): void;
  134163. /**
  134164. * Return the list of active meshes
  134165. * @returns the list of active meshes
  134166. */
  134167. getActiveMeshCandidates(): ISmartArrayLike<AbstractMesh>;
  134168. /**
  134169. * Return the list of active sub meshes
  134170. * @param mesh The mesh to get the candidates sub meshes from
  134171. * @returns the list of active sub meshes
  134172. */
  134173. getActiveSubMeshCandidates(mesh: AbstractMesh): ISmartArrayLike<SubMesh>;
  134174. private _tempRay;
  134175. /**
  134176. * Return the list of sub meshes intersecting with a given local ray
  134177. * @param mesh defines the mesh to find the submesh for
  134178. * @param localRay defines the ray in local space
  134179. * @returns the list of intersecting sub meshes
  134180. */
  134181. getIntersectingSubMeshCandidates(mesh: AbstractMesh, localRay: Ray): ISmartArrayLike<SubMesh>;
  134182. /**
  134183. * Return the list of sub meshes colliding with a collider
  134184. * @param mesh defines the mesh to find the submesh for
  134185. * @param collider defines the collider to evaluate the collision against
  134186. * @returns the list of colliding sub meshes
  134187. */
  134188. getCollidingSubMeshCandidates(mesh: AbstractMesh, collider: Collider): ISmartArrayLike<SubMesh>;
  134189. /**
  134190. * Rebuilds the elements related to this component in case of
  134191. * context lost for instance.
  134192. */
  134193. rebuild(): void;
  134194. /**
  134195. * Disposes the component and the associated ressources.
  134196. */
  134197. dispose(): void;
  134198. }
  134199. }
  134200. declare module BABYLON {
  134201. /**
  134202. * Renders gizmos on top of an existing scene which provide controls for position, rotation, etc.
  134203. */
  134204. export class Gizmo implements IDisposable {
  134205. /** The utility layer the gizmo will be added to */
  134206. gizmoLayer: UtilityLayerRenderer;
  134207. /**
  134208. * The root mesh of the gizmo
  134209. */
  134210. _rootMesh: Mesh;
  134211. private _attachedMesh;
  134212. private _attachedNode;
  134213. /**
  134214. * Ratio for the scale of the gizmo (Default: 1)
  134215. */
  134216. protected _scaleRatio: number;
  134217. /**
  134218. * boolean updated by pointermove when a gizmo mesh is hovered
  134219. */
  134220. protected _isHovered: boolean;
  134221. /**
  134222. * Ratio for the scale of the gizmo (Default: 1)
  134223. */
  134224. set scaleRatio(value: number);
  134225. get scaleRatio(): number;
  134226. /**
  134227. * True when the mouse pointer is hovered a gizmo mesh
  134228. */
  134229. get isHovered(): boolean;
  134230. /**
  134231. * If a custom mesh has been set (Default: false)
  134232. */
  134233. protected _customMeshSet: boolean;
  134234. /**
  134235. * Mesh that the gizmo will be attached to. (eg. on a drag gizmo the mesh that will be dragged)
  134236. * * When set, interactions will be enabled
  134237. */
  134238. get attachedMesh(): Nullable<AbstractMesh>;
  134239. set attachedMesh(value: Nullable<AbstractMesh>);
  134240. /**
  134241. * Node that the gizmo will be attached to. (eg. on a drag gizmo the mesh, bone or NodeTransform that will be dragged)
  134242. * * When set, interactions will be enabled
  134243. */
  134244. get attachedNode(): Nullable<Node>;
  134245. set attachedNode(value: Nullable<Node>);
  134246. /**
  134247. * Disposes and replaces the current meshes in the gizmo with the specified mesh
  134248. * @param mesh The mesh to replace the default mesh of the gizmo
  134249. */
  134250. setCustomMesh(mesh: Mesh): void;
  134251. protected _updateGizmoRotationToMatchAttachedMesh: boolean;
  134252. /**
  134253. * If set the gizmo's rotation will be updated to match the attached mesh each frame (Default: true)
  134254. */
  134255. set updateGizmoRotationToMatchAttachedMesh(value: boolean);
  134256. get updateGizmoRotationToMatchAttachedMesh(): boolean;
  134257. /**
  134258. * If set the gizmo's position will be updated to match the attached mesh each frame (Default: true)
  134259. */
  134260. updateGizmoPositionToMatchAttachedMesh: boolean;
  134261. /**
  134262. * When set, the gizmo will always appear the same size no matter where the camera is (default: true)
  134263. */
  134264. updateScale: boolean;
  134265. protected _interactionsEnabled: boolean;
  134266. protected _attachedNodeChanged(value: Nullable<Node>): void;
  134267. private _beforeRenderObserver;
  134268. private _tempQuaternion;
  134269. private _tempVector;
  134270. private _tempVector2;
  134271. private _tempMatrix1;
  134272. private _tempMatrix2;
  134273. private _rightHandtoLeftHandMatrix;
  134274. /**
  134275. * Creates a gizmo
  134276. * @param gizmoLayer The utility layer the gizmo will be added to
  134277. */
  134278. constructor(
  134279. /** The utility layer the gizmo will be added to */
  134280. gizmoLayer?: UtilityLayerRenderer);
  134281. /**
  134282. * Updates the gizmo to match the attached mesh's position/rotation
  134283. */
  134284. protected _update(): void;
  134285. /**
  134286. * computes the rotation/scaling/position of the transform once the Node world matrix has changed.
  134287. * @param value Node, TransformNode or mesh
  134288. */
  134289. protected _matrixChanged(): void;
  134290. /**
  134291. * Disposes of the gizmo
  134292. */
  134293. dispose(): void;
  134294. }
  134295. }
  134296. declare module BABYLON {
  134297. /**
  134298. * Single plane drag gizmo
  134299. */
  134300. export class PlaneDragGizmo extends Gizmo {
  134301. /**
  134302. * Drag behavior responsible for the gizmos dragging interactions
  134303. */
  134304. dragBehavior: PointerDragBehavior;
  134305. private _pointerObserver;
  134306. /**
  134307. * Drag distance in babylon units that the gizmo will snap to when dragged (Default: 0)
  134308. */
  134309. snapDistance: number;
  134310. /**
  134311. * Event that fires each time the gizmo snaps to a new location.
  134312. * * snapDistance is the the change in distance
  134313. */
  134314. onSnapObservable: Observable<{
  134315. snapDistance: number;
  134316. }>;
  134317. private _plane;
  134318. private _coloredMaterial;
  134319. private _hoverMaterial;
  134320. private _isEnabled;
  134321. private _parent;
  134322. /** @hidden */
  134323. static _CreatePlane(scene: Scene, material: StandardMaterial): TransformNode;
  134324. /** @hidden */
  134325. static _CreateArrowInstance(scene: Scene, arrow: TransformNode): TransformNode;
  134326. /**
  134327. * Creates a PlaneDragGizmo
  134328. * @param gizmoLayer The utility layer the gizmo will be added to
  134329. * @param dragPlaneNormal The axis normal to which the gizmo will be able to drag on
  134330. * @param color The color of the gizmo
  134331. */
  134332. constructor(dragPlaneNormal: Vector3, color?: Color3, gizmoLayer?: UtilityLayerRenderer, parent?: Nullable<PositionGizmo>);
  134333. protected _attachedNodeChanged(value: Nullable<Node>): void;
  134334. /**
  134335. * If the gizmo is enabled
  134336. */
  134337. set isEnabled(value: boolean);
  134338. get isEnabled(): boolean;
  134339. /**
  134340. * Disposes of the gizmo
  134341. */
  134342. dispose(): void;
  134343. }
  134344. }
  134345. declare module BABYLON {
  134346. /**
  134347. * Gizmo that enables dragging a mesh along 3 axis
  134348. */
  134349. export class PositionGizmo extends Gizmo {
  134350. /**
  134351. * Internal gizmo used for interactions on the x axis
  134352. */
  134353. xGizmo: AxisDragGizmo;
  134354. /**
  134355. * Internal gizmo used for interactions on the y axis
  134356. */
  134357. yGizmo: AxisDragGizmo;
  134358. /**
  134359. * Internal gizmo used for interactions on the z axis
  134360. */
  134361. zGizmo: AxisDragGizmo;
  134362. /**
  134363. * Internal gizmo used for interactions on the yz plane
  134364. */
  134365. xPlaneGizmo: PlaneDragGizmo;
  134366. /**
  134367. * Internal gizmo used for interactions on the xz plane
  134368. */
  134369. yPlaneGizmo: PlaneDragGizmo;
  134370. /**
  134371. * Internal gizmo used for interactions on the xy plane
  134372. */
  134373. zPlaneGizmo: PlaneDragGizmo;
  134374. /**
  134375. * private variables
  134376. */
  134377. private _meshAttached;
  134378. private _nodeAttached;
  134379. private _snapDistance;
  134380. /** Fires an event when any of it's sub gizmos are dragged */
  134381. onDragStartObservable: Observable<unknown>;
  134382. /** Fires an event when any of it's sub gizmos are released from dragging */
  134383. onDragEndObservable: Observable<unknown>;
  134384. /**
  134385. * If set to true, planar drag is enabled
  134386. */
  134387. private _planarGizmoEnabled;
  134388. get attachedMesh(): Nullable<AbstractMesh>;
  134389. set attachedMesh(mesh: Nullable<AbstractMesh>);
  134390. get attachedNode(): Nullable<Node>;
  134391. set attachedNode(node: Nullable<Node>);
  134392. /**
  134393. * True when the mouse pointer is hovering a gizmo mesh
  134394. */
  134395. get isHovered(): boolean;
  134396. /**
  134397. * Creates a PositionGizmo
  134398. * @param gizmoLayer The utility layer the gizmo will be added to
  134399. @param thickness display gizmo axis thickness
  134400. */
  134401. constructor(gizmoLayer?: UtilityLayerRenderer, thickness?: number);
  134402. /**
  134403. * If the planar drag gizmo is enabled
  134404. * setting this will enable/disable XY, XZ and YZ planes regardless of individual gizmo settings.
  134405. */
  134406. set planarGizmoEnabled(value: boolean);
  134407. get planarGizmoEnabled(): boolean;
  134408. set updateGizmoRotationToMatchAttachedMesh(value: boolean);
  134409. get updateGizmoRotationToMatchAttachedMesh(): boolean;
  134410. /**
  134411. * Drag distance in babylon units that the gizmo will snap to when dragged (Default: 0)
  134412. */
  134413. set snapDistance(value: number);
  134414. get snapDistance(): number;
  134415. /**
  134416. * Ratio for the scale of the gizmo (Default: 1)
  134417. */
  134418. set scaleRatio(value: number);
  134419. get scaleRatio(): number;
  134420. /**
  134421. * Disposes of the gizmo
  134422. */
  134423. dispose(): void;
  134424. /**
  134425. * CustomMeshes are not supported by this gizmo
  134426. * @param mesh The mesh to replace the default mesh of the gizmo
  134427. */
  134428. setCustomMesh(mesh: Mesh): void;
  134429. }
  134430. }
  134431. declare module BABYLON {
  134432. /**
  134433. * Single axis drag gizmo
  134434. */
  134435. export class AxisDragGizmo extends Gizmo {
  134436. /**
  134437. * Drag behavior responsible for the gizmos dragging interactions
  134438. */
  134439. dragBehavior: PointerDragBehavior;
  134440. private _pointerObserver;
  134441. /**
  134442. * Drag distance in babylon units that the gizmo will snap to when dragged (Default: 0)
  134443. */
  134444. snapDistance: number;
  134445. /**
  134446. * Event that fires each time the gizmo snaps to a new location.
  134447. * * snapDistance is the the change in distance
  134448. */
  134449. onSnapObservable: Observable<{
  134450. snapDistance: number;
  134451. }>;
  134452. private _isEnabled;
  134453. private _parent;
  134454. private _arrow;
  134455. private _coloredMaterial;
  134456. private _hoverMaterial;
  134457. /** @hidden */
  134458. static _CreateArrow(scene: Scene, material: StandardMaterial, thickness?: number): TransformNode;
  134459. /** @hidden */
  134460. static _CreateArrowInstance(scene: Scene, arrow: TransformNode): TransformNode;
  134461. /**
  134462. * Creates an AxisDragGizmo
  134463. * @param gizmoLayer The utility layer the gizmo will be added to
  134464. * @param dragAxis The axis which the gizmo will be able to drag on
  134465. * @param color The color of the gizmo
  134466. * @param thickness display gizmo axis thickness
  134467. */
  134468. constructor(dragAxis: Vector3, color?: Color3, gizmoLayer?: UtilityLayerRenderer, parent?: Nullable<PositionGizmo>, thickness?: number);
  134469. protected _attachedNodeChanged(value: Nullable<Node>): void;
  134470. /**
  134471. * If the gizmo is enabled
  134472. */
  134473. set isEnabled(value: boolean);
  134474. get isEnabled(): boolean;
  134475. /**
  134476. * Disposes of the gizmo
  134477. */
  134478. dispose(): void;
  134479. }
  134480. }
  134481. declare module BABYLON.Debug {
  134482. /**
  134483. * The Axes viewer will show 3 axes in a specific point in space
  134484. */
  134485. export class AxesViewer {
  134486. private _xAxis;
  134487. private _yAxis;
  134488. private _zAxis;
  134489. private _scaleLinesFactor;
  134490. private _instanced;
  134491. /**
  134492. * Gets the hosting scene
  134493. */
  134494. scene: Nullable<Scene>;
  134495. /**
  134496. * Gets or sets a number used to scale line length
  134497. */
  134498. scaleLines: number;
  134499. /** Gets the node hierarchy used to render x-axis */
  134500. get xAxis(): TransformNode;
  134501. /** Gets the node hierarchy used to render y-axis */
  134502. get yAxis(): TransformNode;
  134503. /** Gets the node hierarchy used to render z-axis */
  134504. get zAxis(): TransformNode;
  134505. /**
  134506. * Creates a new AxesViewer
  134507. * @param scene defines the hosting scene
  134508. * @param scaleLines defines a number used to scale line length (1 by default)
  134509. * @param renderingGroupId defines a number used to set the renderingGroupId of the meshes (2 by default)
  134510. * @param xAxis defines the node hierarchy used to render the x-axis
  134511. * @param yAxis defines the node hierarchy used to render the y-axis
  134512. * @param zAxis defines the node hierarchy used to render the z-axis
  134513. */
  134514. constructor(scene: Scene, scaleLines?: number, renderingGroupId?: Nullable<number>, xAxis?: TransformNode, yAxis?: TransformNode, zAxis?: TransformNode);
  134515. /**
  134516. * Force the viewer to update
  134517. * @param position defines the position of the viewer
  134518. * @param xaxis defines the x axis of the viewer
  134519. * @param yaxis defines the y axis of the viewer
  134520. * @param zaxis defines the z axis of the viewer
  134521. */
  134522. update(position: Vector3, xaxis: Vector3, yaxis: Vector3, zaxis: Vector3): void;
  134523. /**
  134524. * Creates an instance of this axes viewer.
  134525. * @returns a new axes viewer with instanced meshes
  134526. */
  134527. createInstance(): AxesViewer;
  134528. /** Releases resources */
  134529. dispose(): void;
  134530. private static _SetRenderingGroupId;
  134531. }
  134532. }
  134533. declare module BABYLON.Debug {
  134534. /**
  134535. * The BoneAxesViewer will attach 3 axes to a specific bone of a specific mesh
  134536. * @see demo here: https://www.babylonjs-playground.com/#0DE8F4#8
  134537. */
  134538. export class BoneAxesViewer extends AxesViewer {
  134539. /**
  134540. * Gets or sets the target mesh where to display the axes viewer
  134541. */
  134542. mesh: Nullable<Mesh>;
  134543. /**
  134544. * Gets or sets the target bone where to display the axes viewer
  134545. */
  134546. bone: Nullable<Bone>;
  134547. /** Gets current position */
  134548. pos: Vector3;
  134549. /** Gets direction of X axis */
  134550. xaxis: Vector3;
  134551. /** Gets direction of Y axis */
  134552. yaxis: Vector3;
  134553. /** Gets direction of Z axis */
  134554. zaxis: Vector3;
  134555. /**
  134556. * Creates a new BoneAxesViewer
  134557. * @param scene defines the hosting scene
  134558. * @param bone defines the target bone
  134559. * @param mesh defines the target mesh
  134560. * @param scaleLines defines a scaling factor for line length (1 by default)
  134561. */
  134562. constructor(scene: Scene, bone: Bone, mesh: Mesh, scaleLines?: number);
  134563. /**
  134564. * Force the viewer to update
  134565. */
  134566. update(): void;
  134567. /** Releases resources */
  134568. dispose(): void;
  134569. }
  134570. }
  134571. declare module BABYLON {
  134572. /**
  134573. * Interface used to define scene explorer extensibility option
  134574. */
  134575. export interface IExplorerExtensibilityOption {
  134576. /**
  134577. * Define the option label
  134578. */
  134579. label: string;
  134580. /**
  134581. * Defines the action to execute on click
  134582. */
  134583. action: (entity: any) => void;
  134584. }
  134585. /**
  134586. * Defines a group of actions associated with a predicate to use when extending the Inspector scene explorer
  134587. */
  134588. export interface IExplorerExtensibilityGroup {
  134589. /**
  134590. * Defines a predicate to test if a given type mut be extended
  134591. */
  134592. predicate: (entity: any) => boolean;
  134593. /**
  134594. * Gets the list of options added to a type
  134595. */
  134596. entries: IExplorerExtensibilityOption[];
  134597. }
  134598. /**
  134599. * Interface used to define the options to use to create the Inspector
  134600. */
  134601. export interface IInspectorOptions {
  134602. /**
  134603. * Display in overlay mode (default: false)
  134604. */
  134605. overlay?: boolean;
  134606. /**
  134607. * HTML element to use as root (the parent of the rendering canvas will be used as default value)
  134608. */
  134609. globalRoot?: HTMLElement;
  134610. /**
  134611. * Display the Scene explorer
  134612. */
  134613. showExplorer?: boolean;
  134614. /**
  134615. * Display the property inspector
  134616. */
  134617. showInspector?: boolean;
  134618. /**
  134619. * Display in embed mode (both panes on the right)
  134620. */
  134621. embedMode?: boolean;
  134622. /**
  134623. * let the Inspector handles resize of the canvas when panes are resized (default to true)
  134624. */
  134625. handleResize?: boolean;
  134626. /**
  134627. * Allow the panes to popup (default: true)
  134628. */
  134629. enablePopup?: boolean;
  134630. /**
  134631. * Allow the panes to be closed by users (default: true)
  134632. */
  134633. enableClose?: boolean;
  134634. /**
  134635. * Optional list of extensibility entries
  134636. */
  134637. explorerExtensibility?: IExplorerExtensibilityGroup[];
  134638. /**
  134639. * Optional URL to get the inspector script from (by default it uses the babylonjs CDN).
  134640. */
  134641. inspectorURL?: string;
  134642. /**
  134643. * Optional initial tab (default to DebugLayerTab.Properties)
  134644. */
  134645. initialTab?: DebugLayerTab;
  134646. }
  134647. interface Scene {
  134648. /**
  134649. * @hidden
  134650. * Backing field
  134651. */
  134652. _debugLayer: DebugLayer;
  134653. /**
  134654. * Gets the debug layer (aka Inspector) associated with the scene
  134655. * @see https://doc.babylonjs.com/features/playground_debuglayer
  134656. */
  134657. debugLayer: DebugLayer;
  134658. }
  134659. /**
  134660. * Enum of inspector action tab
  134661. */
  134662. export enum DebugLayerTab {
  134663. /**
  134664. * Properties tag (default)
  134665. */
  134666. Properties = 0,
  134667. /**
  134668. * Debug tab
  134669. */
  134670. Debug = 1,
  134671. /**
  134672. * Statistics tab
  134673. */
  134674. Statistics = 2,
  134675. /**
  134676. * Tools tab
  134677. */
  134678. Tools = 3,
  134679. /**
  134680. * Settings tab
  134681. */
  134682. Settings = 4
  134683. }
  134684. /**
  134685. * The debug layer (aka Inspector) is the go to tool in order to better understand
  134686. * what is happening in your scene
  134687. * @see https://doc.babylonjs.com/features/playground_debuglayer
  134688. */
  134689. export class DebugLayer {
  134690. /**
  134691. * Define the url to get the inspector script from.
  134692. * By default it uses the babylonjs CDN.
  134693. * @ignoreNaming
  134694. */
  134695. static InspectorURL: string;
  134696. private _scene;
  134697. private BJSINSPECTOR;
  134698. private _onPropertyChangedObservable?;
  134699. /**
  134700. * Observable triggered when a property is changed through the inspector.
  134701. */
  134702. get onPropertyChangedObservable(): any;
  134703. /**
  134704. * Instantiates a new debug layer.
  134705. * The debug layer (aka Inspector) is the go to tool in order to better understand
  134706. * what is happening in your scene
  134707. * @see https://doc.babylonjs.com/features/playground_debuglayer
  134708. * @param scene Defines the scene to inspect
  134709. */
  134710. constructor(scene: Scene);
  134711. /** Creates the inspector window. */
  134712. private _createInspector;
  134713. /**
  134714. * Select a specific entity in the scene explorer and highlight a specific block in that entity property grid
  134715. * @param entity defines the entity to select
  134716. * @param lineContainerTitles defines the specific blocks to highlight (could be a string or an array of strings)
  134717. */
  134718. select(entity: any, lineContainerTitles?: string | string[]): void;
  134719. /** Get the inspector from bundle or global */
  134720. private _getGlobalInspector;
  134721. /**
  134722. * Get if the inspector is visible or not.
  134723. * @returns true if visible otherwise, false
  134724. */
  134725. isVisible(): boolean;
  134726. /**
  134727. * Hide the inspector and close its window.
  134728. */
  134729. hide(): void;
  134730. /**
  134731. * Update the scene in the inspector
  134732. */
  134733. setAsActiveScene(): void;
  134734. /**
  134735. * Launch the debugLayer.
  134736. * @param config Define the configuration of the inspector
  134737. * @return a promise fulfilled when the debug layer is visible
  134738. */
  134739. show(config?: IInspectorOptions): Promise<DebugLayer>;
  134740. }
  134741. }
  134742. declare module BABYLON {
  134743. /**
  134744. * Class containing static functions to help procedurally build meshes
  134745. */
  134746. export class BoxBuilder {
  134747. /**
  134748. * Creates a box mesh
  134749. * * The parameter `size` sets the size (float) of each box side (default 1)
  134750. * * You can set some different box dimensions by using the parameters `width`, `height` and `depth` (all by default have the same value of `size`)
  134751. * * 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)
  134752. * * Please read this tutorial : https://doc.babylonjs.com/how_to/createbox_per_face_textures_and_colors
  134753. * * You can also set the mesh side orientation with the values : BABYLON.Mesh.FRONTSIDE (default), BABYLON.Mesh.BACKSIDE or BABYLON.Mesh.DOUBLESIDE
  134754. * * If you create a double-sided mesh, you can choose what parts of the texture image to crop and stick respectively on the front and the back sides with the parameters `frontUVs` and `backUVs` (Vector4). Detail here : https://doc.babylonjs.com/babylon101/discover_basic_elements#side-orientation
  134755. * * The mesh can be set to updatable with the boolean parameter `updatable` (default false) if its internal geometry is supposed to change once created
  134756. * @see https://doc.babylonjs.com/how_to/set_shapes#box
  134757. * @param name defines the name of the mesh
  134758. * @param options defines the options used to create the mesh
  134759. * @param scene defines the hosting scene
  134760. * @returns the box mesh
  134761. */
  134762. static CreateBox(name: string, options: {
  134763. size?: number;
  134764. width?: number;
  134765. height?: number;
  134766. depth?: number;
  134767. faceUV?: Vector4[];
  134768. faceColors?: Color4[];
  134769. sideOrientation?: number;
  134770. frontUVs?: Vector4;
  134771. backUVs?: Vector4;
  134772. wrap?: boolean;
  134773. topBaseAt?: number;
  134774. bottomBaseAt?: number;
  134775. updatable?: boolean;
  134776. }, scene?: Nullable<Scene>): Mesh;
  134777. }
  134778. }
  134779. declare module BABYLON.Debug {
  134780. /**
  134781. * Used to show the physics impostor around the specific mesh
  134782. */
  134783. export class PhysicsViewer {
  134784. /** @hidden */
  134785. protected _impostors: Array<Nullable<PhysicsImpostor>>;
  134786. /** @hidden */
  134787. protected _meshes: Array<Nullable<AbstractMesh>>;
  134788. /** @hidden */
  134789. protected _scene: Nullable<Scene>;
  134790. /** @hidden */
  134791. protected _numMeshes: number;
  134792. /** @hidden */
  134793. protected _physicsEnginePlugin: Nullable<IPhysicsEnginePlugin>;
  134794. private _renderFunction;
  134795. private _utilityLayer;
  134796. private _debugBoxMesh;
  134797. private _debugSphereMesh;
  134798. private _debugCylinderMesh;
  134799. private _debugMaterial;
  134800. private _debugMeshMeshes;
  134801. /**
  134802. * Creates a new PhysicsViewer
  134803. * @param scene defines the hosting scene
  134804. */
  134805. constructor(scene: Scene);
  134806. /** @hidden */
  134807. protected _updateDebugMeshes(): void;
  134808. /**
  134809. * Renders a specified physic impostor
  134810. * @param impostor defines the impostor to render
  134811. * @param targetMesh defines the mesh represented by the impostor
  134812. * @returns the new debug mesh used to render the impostor
  134813. */
  134814. showImpostor(impostor: PhysicsImpostor, targetMesh?: Mesh): Nullable<AbstractMesh>;
  134815. /**
  134816. * Hides a specified physic impostor
  134817. * @param impostor defines the impostor to hide
  134818. */
  134819. hideImpostor(impostor: Nullable<PhysicsImpostor>): void;
  134820. private _getDebugMaterial;
  134821. private _getDebugBoxMesh;
  134822. private _getDebugSphereMesh;
  134823. private _getDebugCylinderMesh;
  134824. private _getDebugMeshMesh;
  134825. private _getDebugMesh;
  134826. /** Releases all resources */
  134827. dispose(): void;
  134828. }
  134829. }
  134830. declare module BABYLON {
  134831. /**
  134832. * As raycast might be hard to debug, the RayHelper can help rendering the different rays
  134833. * in order to better appreciate the issue one might have.
  134834. * @see https://doc.babylonjs.com/babylon101/raycasts#debugging
  134835. */
  134836. export class RayHelper {
  134837. /**
  134838. * Defines the ray we are currently tryin to visualize.
  134839. */
  134840. ray: Nullable<Ray>;
  134841. private _renderPoints;
  134842. private _renderLine;
  134843. private _renderFunction;
  134844. private _scene;
  134845. private _onAfterRenderObserver;
  134846. private _onAfterStepObserver;
  134847. private _attachedToMesh;
  134848. private _meshSpaceDirection;
  134849. private _meshSpaceOrigin;
  134850. /**
  134851. * Helper function to create a colored helper in a scene in one line.
  134852. * @param ray Defines the ray we are currently tryin to visualize
  134853. * @param scene Defines the scene the ray is used in
  134854. * @param color Defines the color we want to see the ray in
  134855. * @returns The newly created ray helper.
  134856. */
  134857. static CreateAndShow(ray: Ray, scene: Scene, color: Color3): RayHelper;
  134858. /**
  134859. * Instantiate a new ray helper.
  134860. * As raycast might be hard to debug, the RayHelper can help rendering the different rays
  134861. * in order to better appreciate the issue one might have.
  134862. * @see https://doc.babylonjs.com/babylon101/raycasts#debugging
  134863. * @param ray Defines the ray we are currently tryin to visualize
  134864. */
  134865. constructor(ray: Ray);
  134866. /**
  134867. * Shows the ray we are willing to debug.
  134868. * @param scene Defines the scene the ray needs to be rendered in
  134869. * @param color Defines the color the ray needs to be rendered in
  134870. */
  134871. show(scene: Scene, color?: Color3): void;
  134872. /**
  134873. * Hides the ray we are debugging.
  134874. */
  134875. hide(): void;
  134876. private _render;
  134877. /**
  134878. * Attach a ray helper to a mesh so that we can easily see its orientation for instance or information like its normals.
  134879. * @param mesh Defines the mesh we want the helper attached to
  134880. * @param meshSpaceDirection Defines the direction of the Ray in mesh space (local space of the mesh node)
  134881. * @param meshSpaceOrigin Defines the origin of the Ray in mesh space (local space of the mesh node)
  134882. * @param length Defines the length of the ray
  134883. */
  134884. attachToMesh(mesh: AbstractMesh, meshSpaceDirection?: Vector3, meshSpaceOrigin?: Vector3, length?: number): void;
  134885. /**
  134886. * Detach the ray helper from the mesh it has previously been attached to.
  134887. */
  134888. detachFromMesh(): void;
  134889. private _updateToMesh;
  134890. /**
  134891. * Dispose the helper and release its associated resources.
  134892. */
  134893. dispose(): void;
  134894. }
  134895. }
  134896. declare module BABYLON {
  134897. /**
  134898. * Defines the options associated with the creation of a SkeletonViewer.
  134899. */
  134900. export interface ISkeletonViewerOptions {
  134901. /** Should the system pause animations before building the Viewer? */
  134902. pauseAnimations: boolean;
  134903. /** Should the system return the skeleton to rest before building? */
  134904. returnToRest: boolean;
  134905. /** public Display Mode of the Viewer */
  134906. displayMode: number;
  134907. /** Flag to toggle if the Viewer should use the CPU for animations or not? */
  134908. displayOptions: ISkeletonViewerDisplayOptions;
  134909. /** Flag to toggle if the Viewer should use the CPU for animations or not? */
  134910. computeBonesUsingShaders: boolean;
  134911. /** Flag ignore non weighted bones */
  134912. useAllBones: boolean;
  134913. }
  134914. /**
  134915. * Defines how to display the various bone meshes for the viewer.
  134916. */
  134917. export interface ISkeletonViewerDisplayOptions {
  134918. /** How far down to start tapering the bone spurs */
  134919. midStep?: number;
  134920. /** How big is the midStep? */
  134921. midStepFactor?: number;
  134922. /** Base for the Sphere Size */
  134923. sphereBaseSize?: number;
  134924. /** The ratio of the sphere to the longest bone in units */
  134925. sphereScaleUnit?: number;
  134926. /** Ratio for the Sphere Size */
  134927. sphereFactor?: number;
  134928. /** Whether a spur should attach its far end to the child bone position */
  134929. spurFollowsChild?: boolean;
  134930. /** Whether to show local axes or not */
  134931. showLocalAxes?: boolean;
  134932. /** Length of each local axis */
  134933. localAxesSize?: number;
  134934. }
  134935. /**
  134936. * Defines the constructor options for the BoneWeight Shader.
  134937. */
  134938. export interface IBoneWeightShaderOptions {
  134939. /** Skeleton to Map */
  134940. skeleton: Skeleton;
  134941. /** Colors for Uninfluenced bones */
  134942. colorBase?: Color3;
  134943. /** Colors for 0.0-0.25 Weight bones */
  134944. colorZero?: Color3;
  134945. /** Color for 0.25-0.5 Weight Influence */
  134946. colorQuarter?: Color3;
  134947. /** Color for 0.5-0.75 Weight Influence */
  134948. colorHalf?: Color3;
  134949. /** Color for 0.75-1 Weight Influence */
  134950. colorFull?: Color3;
  134951. /** Color for Zero Weight Influence */
  134952. targetBoneIndex?: number;
  134953. }
  134954. /**
  134955. * Simple structure of the gradient steps for the Color Map.
  134956. */
  134957. export interface ISkeletonMapShaderColorMapKnot {
  134958. /** Color of the Knot */
  134959. color: Color3;
  134960. /** Location of the Knot */
  134961. location: number;
  134962. }
  134963. /**
  134964. * Defines the constructor options for the SkeletonMap Shader.
  134965. */
  134966. export interface ISkeletonMapShaderOptions {
  134967. /** Skeleton to Map */
  134968. skeleton: Skeleton;
  134969. /** Array of ColorMapKnots that make the gradient must be ordered with knot[i].location < knot[i+1].location*/
  134970. colorMap?: ISkeletonMapShaderColorMapKnot[];
  134971. }
  134972. }
  134973. declare module BABYLON {
  134974. /**
  134975. * Class containing static functions to help procedurally build meshes
  134976. */
  134977. export class RibbonBuilder {
  134978. /**
  134979. * Creates a ribbon mesh. The ribbon is a parametric shape. It has no predefined shape. Its final shape will depend on the input parameters
  134980. * * The parameter `pathArray` is a required array of paths, what are each an array of successive Vector3. The pathArray parameter depicts the ribbon geometry
  134981. * * The parameter `closeArray` (boolean, default false) creates a seam between the first and the last paths of the path array
  134982. * * The parameter `closePath` (boolean, default false) creates a seam between the first and the last points of each path of the path array
  134983. * * 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
  134984. * * 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
  134985. * * 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
  134986. * * You can also set the mesh side orientation with the values : BABYLON.Mesh.FRONTSIDE (default), BABYLON.Mesh.BACKSIDE or BABYLON.Mesh.DOUBLESIDE
  134987. * * If you create a double-sided mesh, you can choose what parts of the texture image to crop and stick respectively on the front and the back sides with the parameters `frontUVs` and `backUVs` (Vector4). Detail here : https://doc.babylonjs.com/babylon101/discover_basic_elements#side-orientation
  134988. * * The optional parameter `invertUV` (boolean, default false) swaps in the geometry the U and V coordinates to apply a texture
  134989. * * 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
  134990. * * The parameters `colors` is an optional flat array of `Color4` to set/update each ribbon vertex with its own custom color values
  134991. * * 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
  134992. * * Moreover, you can use the parameter `color` with `instance` (to update the ribbon), only if you previously used it at creation time
  134993. * * The mesh can be set to updatable with the boolean parameter `updatable` (default false) if its internal geometry is supposed to change once created
  134994. * @param name defines the name of the mesh
  134995. * @param options defines the options used to create the mesh
  134996. * @param scene defines the hosting scene
  134997. * @returns the ribbon mesh
  134998. * @see https://doc.babylonjs.com/how_to/ribbon_tutorial
  134999. * @see https://doc.babylonjs.com/how_to/parametric_shapes
  135000. */
  135001. static CreateRibbon(name: string, options: {
  135002. pathArray: Vector3[][];
  135003. closeArray?: boolean;
  135004. closePath?: boolean;
  135005. offset?: number;
  135006. updatable?: boolean;
  135007. sideOrientation?: number;
  135008. frontUVs?: Vector4;
  135009. backUVs?: Vector4;
  135010. instance?: Mesh;
  135011. invertUV?: boolean;
  135012. uvs?: Vector2[];
  135013. colors?: Color4[];
  135014. }, scene?: Nullable<Scene>): Mesh;
  135015. }
  135016. }
  135017. declare module BABYLON {
  135018. /**
  135019. * Class containing static functions to help procedurally build meshes
  135020. */
  135021. export class ShapeBuilder {
  135022. /**
  135023. * 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.
  135024. * * 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.
  135025. * * The parameter `path` is a required array of successive Vector3. This is the axis curve the shape is extruded along.
  135026. * * 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.
  135027. * * The parameter `scale` (float, default 1) is the value to scale the shape.
  135028. * * 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
  135029. * * 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
  135030. * * Remember you can only change the shape or path point positions, not their number when updating an extruded shape.
  135031. * * You can also set the mesh side orientation with the values : BABYLON.Mesh.FRONTSIDE (default), BABYLON.Mesh.BACKSIDE or BABYLON.Mesh.DOUBLESIDE
  135032. * * If you create a double-sided mesh, you can choose what parts of the texture image to crop and stick respectively on the front and the back sides with the parameters `frontUVs` and `backUVs` (Vector4). Detail here : https://doc.babylonjs.com/babylon101/discover_basic_elements#side-orientation
  135033. * * The optional parameter `invertUV` (boolean, default false) swaps in the geometry the U and V coordinates to apply a texture.
  135034. * * The mesh can be set to updatable with the boolean parameter `updatable` (default false) if its internal geometry is supposed to change once created.
  135035. * @param name defines the name of the mesh
  135036. * @param options defines the options used to create the mesh
  135037. * @param scene defines the hosting scene
  135038. * @returns the extruded shape mesh
  135039. * @see https://doc.babylonjs.com/how_to/parametric_shapes
  135040. * @see https://doc.babylonjs.com/how_to/parametric_shapes#extruded-shapes
  135041. */
  135042. static ExtrudeShape(name: string, options: {
  135043. shape: Vector3[];
  135044. path: Vector3[];
  135045. scale?: number;
  135046. rotation?: number;
  135047. cap?: number;
  135048. updatable?: boolean;
  135049. sideOrientation?: number;
  135050. frontUVs?: Vector4;
  135051. backUVs?: Vector4;
  135052. instance?: Mesh;
  135053. invertUV?: boolean;
  135054. }, scene?: Nullable<Scene>): Mesh;
  135055. /**
  135056. * Creates an custom extruded shape mesh.
  135057. * The custom extrusion is a parametric shape. It has no predefined shape. Its final shape will depend on the input parameters.
  135058. * * 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.
  135059. * * The parameter `path` is a required array of successive Vector3. This is the axis curve the shape is extruded along.
  135060. * * 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
  135061. * * It must returns a float value that will be the rotation in radians applied to the shape on each path point.
  135062. * * 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
  135063. * * It must returns a float value that will be the scale value applied to the shape on each path point
  135064. * * The parameter `ribbonClosePath` (boolean, default false) forces the extrusion underlying ribbon to close all the paths in its `pathArray`
  135065. * * The parameter `ribbonCloseArray` (boolean, default false) forces the extrusion underlying ribbon to close its `pathArray`
  135066. * * 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
  135067. * * 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
  135068. * * Remember you can only change the shape or path point positions, not their number when updating an extruded shape
  135069. * * You can also set the mesh side orientation with the values : BABYLON.Mesh.FRONTSIDE (default), BABYLON.Mesh.BACKSIDE or BABYLON.Mesh.DOUBLESIDE
  135070. * * If you create a double-sided mesh, you can choose what parts of the texture image to crop and stick respectively on the front and the back sides with the parameters `frontUVs` and `backUVs` (Vector4). Detail here : https://doc.babylonjs.com/babylon101/discover_basic_elements#side-orientation
  135071. * * The optional parameter `invertUV` (boolean, default false) swaps in the geometry the U and V coordinates to apply a texture
  135072. * * The mesh can be set to updatable with the boolean parameter `updatable` (default false) if its internal geometry is supposed to change once created
  135073. * @param name defines the name of the mesh
  135074. * @param options defines the options used to create the mesh
  135075. * @param scene defines the hosting scene
  135076. * @returns the custom extruded shape mesh
  135077. * @see https://doc.babylonjs.com/how_to/parametric_shapes#custom-extruded-shapes
  135078. * @see https://doc.babylonjs.com/how_to/parametric_shapes
  135079. * @see https://doc.babylonjs.com/how_to/parametric_shapes#extruded-shapes
  135080. */
  135081. static ExtrudeShapeCustom(name: string, options: {
  135082. shape: Vector3[];
  135083. path: Vector3[];
  135084. scaleFunction?: any;
  135085. rotationFunction?: any;
  135086. ribbonCloseArray?: boolean;
  135087. ribbonClosePath?: boolean;
  135088. cap?: number;
  135089. updatable?: boolean;
  135090. sideOrientation?: number;
  135091. frontUVs?: Vector4;
  135092. backUVs?: Vector4;
  135093. instance?: Mesh;
  135094. invertUV?: boolean;
  135095. }, scene?: Nullable<Scene>): Mesh;
  135096. private static _ExtrudeShapeGeneric;
  135097. }
  135098. }
  135099. declare module BABYLON.Debug {
  135100. /**
  135101. * Class used to render a debug view of a given skeleton
  135102. * @see http://www.babylonjs-playground.com/#1BZJVJ#8
  135103. */
  135104. export class SkeletonViewer {
  135105. /** defines the skeleton to render */
  135106. skeleton: Skeleton;
  135107. /** defines the mesh attached to the skeleton */
  135108. mesh: AbstractMesh;
  135109. /** defines a boolean indicating if bones matrices must be forced to update before rendering (true by default) */
  135110. autoUpdateBonesMatrices: boolean;
  135111. /** defines the rendering group id to use with the viewer */
  135112. renderingGroupId: number;
  135113. /** is the options for the viewer */
  135114. options: Partial<ISkeletonViewerOptions>;
  135115. /** public Display constants BABYLON.SkeletonViewer.DISPLAY_LINES */
  135116. static readonly DISPLAY_LINES: number;
  135117. /** public Display constants BABYLON.SkeletonViewer.DISPLAY_SPHERES */
  135118. static readonly DISPLAY_SPHERES: number;
  135119. /** public Display constants BABYLON.SkeletonViewer.DISPLAY_SPHERE_AND_SPURS */
  135120. static readonly DISPLAY_SPHERE_AND_SPURS: number;
  135121. /** public static method to create a BoneWeight Shader
  135122. * @param options The constructor options
  135123. * @param scene The scene that the shader is scoped to
  135124. * @returns The created ShaderMaterial
  135125. * @see http://www.babylonjs-playground.com/#1BZJVJ#395
  135126. */
  135127. static CreateBoneWeightShader(options: IBoneWeightShaderOptions, scene: Scene): ShaderMaterial;
  135128. /** public static method to create a BoneWeight Shader
  135129. * @param options The constructor options
  135130. * @param scene The scene that the shader is scoped to
  135131. * @returns The created ShaderMaterial
  135132. */
  135133. static CreateSkeletonMapShader(options: ISkeletonMapShaderOptions, scene: Scene): ShaderMaterial;
  135134. /** private static method to create a BoneWeight Shader
  135135. * @param size The size of the buffer to create (usually the bone count)
  135136. * @param colorMap The gradient data to generate
  135137. * @param scene The scene that the shader is scoped to
  135138. * @returns an Array of floats from the color gradient values
  135139. */
  135140. private static _CreateBoneMapColorBuffer;
  135141. /** If SkeletonViewer scene scope. */
  135142. private _scene;
  135143. /** Gets or sets the color used to render the skeleton */
  135144. color: Color3;
  135145. /** Array of the points of the skeleton fo the line view. */
  135146. private _debugLines;
  135147. /** The SkeletonViewers Mesh. */
  135148. private _debugMesh;
  135149. /** The local axes Meshes. */
  135150. private _localAxes;
  135151. /** If SkeletonViewer is enabled. */
  135152. private _isEnabled;
  135153. /** If SkeletonViewer is ready. */
  135154. private _ready;
  135155. /** SkeletonViewer render observable. */
  135156. private _obs;
  135157. /** The Utility Layer to render the gizmos in. */
  135158. private _utilityLayer;
  135159. private _boneIndices;
  135160. /** Gets the Scene. */
  135161. get scene(): Scene;
  135162. /** Gets the utilityLayer. */
  135163. get utilityLayer(): Nullable<UtilityLayerRenderer>;
  135164. /** Checks Ready Status. */
  135165. get isReady(): Boolean;
  135166. /** Sets Ready Status. */
  135167. set ready(value: boolean);
  135168. /** Gets the debugMesh */
  135169. get debugMesh(): Nullable<AbstractMesh> | Nullable<LinesMesh>;
  135170. /** Sets the debugMesh */
  135171. set debugMesh(value: Nullable<AbstractMesh> | Nullable<LinesMesh>);
  135172. /** Gets the displayMode */
  135173. get displayMode(): number;
  135174. /** Sets the displayMode */
  135175. set displayMode(value: number);
  135176. /**
  135177. * Creates a new SkeletonViewer
  135178. * @param skeleton defines the skeleton to render
  135179. * @param mesh defines the mesh attached to the skeleton
  135180. * @param scene defines the hosting scene
  135181. * @param autoUpdateBonesMatrices defines a boolean indicating if bones matrices must be forced to update before rendering (true by default)
  135182. * @param renderingGroupId defines the rendering group id to use with the viewer
  135183. * @param options All of the extra constructor options for the SkeletonViewer
  135184. */
  135185. constructor(
  135186. /** defines the skeleton to render */
  135187. skeleton: Skeleton,
  135188. /** defines the mesh attached to the skeleton */
  135189. mesh: AbstractMesh,
  135190. /** The Scene scope*/
  135191. scene: Scene,
  135192. /** defines a boolean indicating if bones matrices must be forced to update before rendering (true by default) */
  135193. autoUpdateBonesMatrices?: boolean,
  135194. /** defines the rendering group id to use with the viewer */
  135195. renderingGroupId?: number,
  135196. /** is the options for the viewer */
  135197. options?: Partial<ISkeletonViewerOptions>);
  135198. /** The Dynamic bindings for the update functions */
  135199. private _bindObs;
  135200. /** Update the viewer to sync with current skeleton state, only used to manually update. */
  135201. update(): void;
  135202. /** Gets or sets a boolean indicating if the viewer is enabled */
  135203. set isEnabled(value: boolean);
  135204. get isEnabled(): boolean;
  135205. private _getBonePosition;
  135206. private _getLinesForBonesWithLength;
  135207. private _getLinesForBonesNoLength;
  135208. /** function to revert the mesh and scene back to the initial state. */
  135209. private _revert;
  135210. /** function to get the absolute bind pose of a bone by accumulating transformations up the bone hierarchy. */
  135211. private _getAbsoluteBindPoseToRef;
  135212. /** function to build and bind sphere joint points and spur bone representations. */
  135213. private _buildSpheresAndSpurs;
  135214. private _buildLocalAxes;
  135215. /** Update the viewer to sync with current skeleton state, only used for the line display. */
  135216. private _displayLinesUpdate;
  135217. /** Changes the displayMode of the skeleton viewer
  135218. * @param mode The displayMode numerical value
  135219. */
  135220. changeDisplayMode(mode: number): void;
  135221. /** Sets a display option of the skeleton viewer
  135222. *
  135223. * | Option | Type | Default | Description |
  135224. * | ---------------- | ------- | ------- | ----------- |
  135225. * | midStep | float | 0.235 | A percentage between a bone and its child that determines the widest part of a spur. Only used when `displayMode` is set to `DISPLAY_SPHERE_AND_SPURS`. |
  135226. * | midStepFactor | float | 0.15 | Mid step width expressed as a factor of the length. A value of 0.5 makes the spur width half of the spur length. Only used when `displayMode` is set to `DISPLAY_SPHERE_AND_SPURS`. |
  135227. * | sphereBaseSize | float | 2 | Sphere base size. Only used when `displayMode` is set to `DISPLAY_SPHERE_AND_SPURS`. |
  135228. * | sphereScaleUnit | float | 0.865 | Sphere scale factor used to scale spheres in relation to the longest bone. Only used when `displayMode` is set to `DISPLAY_SPHERE_AND_SPURS`. |
  135229. * | spurFollowsChild | boolean | false | Whether a spur should attach its far end to the child bone. |
  135230. * | showLocalAxes | boolean | false | Displays local axes on all bones. |
  135231. * | localAxesSize | float | 0.075 | Determines the length of each local axis. |
  135232. *
  135233. * @param option String of the option name
  135234. * @param value The numerical option value
  135235. */
  135236. changeDisplayOptions(option: string, value: number): void;
  135237. /** Release associated resources */
  135238. dispose(): void;
  135239. }
  135240. }
  135241. declare module BABYLON {
  135242. /**
  135243. * Enum for Device Types
  135244. */
  135245. export enum DeviceType {
  135246. /** Generic */
  135247. Generic = 0,
  135248. /** Keyboard */
  135249. Keyboard = 1,
  135250. /** Mouse */
  135251. Mouse = 2,
  135252. /** Touch Pointers */
  135253. Touch = 3,
  135254. /** PS4 Dual Shock */
  135255. DualShock = 4,
  135256. /** Xbox */
  135257. Xbox = 5,
  135258. /** Switch Controller */
  135259. Switch = 6
  135260. }
  135261. /**
  135262. * Enum for All Pointers (Touch/Mouse)
  135263. */
  135264. export enum PointerInput {
  135265. /** Horizontal Axis */
  135266. Horizontal = 0,
  135267. /** Vertical Axis */
  135268. Vertical = 1,
  135269. /** Left Click or Touch */
  135270. LeftClick = 2,
  135271. /** Middle Click */
  135272. MiddleClick = 3,
  135273. /** Right Click */
  135274. RightClick = 4,
  135275. /** Browser Back */
  135276. BrowserBack = 5,
  135277. /** Browser Forward */
  135278. BrowserForward = 6
  135279. }
  135280. /**
  135281. * Enum for Dual Shock Gamepad
  135282. */
  135283. export enum DualShockInput {
  135284. /** Cross */
  135285. Cross = 0,
  135286. /** Circle */
  135287. Circle = 1,
  135288. /** Square */
  135289. Square = 2,
  135290. /** Triangle */
  135291. Triangle = 3,
  135292. /** L1 */
  135293. L1 = 4,
  135294. /** R1 */
  135295. R1 = 5,
  135296. /** L2 */
  135297. L2 = 6,
  135298. /** R2 */
  135299. R2 = 7,
  135300. /** Share */
  135301. Share = 8,
  135302. /** Options */
  135303. Options = 9,
  135304. /** L3 */
  135305. L3 = 10,
  135306. /** R3 */
  135307. R3 = 11,
  135308. /** DPadUp */
  135309. DPadUp = 12,
  135310. /** DPadDown */
  135311. DPadDown = 13,
  135312. /** DPadLeft */
  135313. DPadLeft = 14,
  135314. /** DRight */
  135315. DPadRight = 15,
  135316. /** Home */
  135317. Home = 16,
  135318. /** TouchPad */
  135319. TouchPad = 17,
  135320. /** LStickXAxis */
  135321. LStickXAxis = 18,
  135322. /** LStickYAxis */
  135323. LStickYAxis = 19,
  135324. /** RStickXAxis */
  135325. RStickXAxis = 20,
  135326. /** RStickYAxis */
  135327. RStickYAxis = 21
  135328. }
  135329. /**
  135330. * Enum for Xbox Gamepad
  135331. */
  135332. export enum XboxInput {
  135333. /** A */
  135334. A = 0,
  135335. /** B */
  135336. B = 1,
  135337. /** X */
  135338. X = 2,
  135339. /** Y */
  135340. Y = 3,
  135341. /** LB */
  135342. LB = 4,
  135343. /** RB */
  135344. RB = 5,
  135345. /** LT */
  135346. LT = 6,
  135347. /** RT */
  135348. RT = 7,
  135349. /** Back */
  135350. Back = 8,
  135351. /** Start */
  135352. Start = 9,
  135353. /** LS */
  135354. LS = 10,
  135355. /** RS */
  135356. RS = 11,
  135357. /** DPadUp */
  135358. DPadUp = 12,
  135359. /** DPadDown */
  135360. DPadDown = 13,
  135361. /** DPadLeft */
  135362. DPadLeft = 14,
  135363. /** DRight */
  135364. DPadRight = 15,
  135365. /** Home */
  135366. Home = 16,
  135367. /** LStickXAxis */
  135368. LStickXAxis = 17,
  135369. /** LStickYAxis */
  135370. LStickYAxis = 18,
  135371. /** RStickXAxis */
  135372. RStickXAxis = 19,
  135373. /** RStickYAxis */
  135374. RStickYAxis = 20
  135375. }
  135376. /**
  135377. * Enum for Switch (Pro/JoyCon L+R) Gamepad
  135378. */
  135379. export enum SwitchInput {
  135380. /** B */
  135381. B = 0,
  135382. /** A */
  135383. A = 1,
  135384. /** Y */
  135385. Y = 2,
  135386. /** X */
  135387. X = 3,
  135388. /** L */
  135389. L = 4,
  135390. /** R */
  135391. R = 5,
  135392. /** ZL */
  135393. ZL = 6,
  135394. /** ZR */
  135395. ZR = 7,
  135396. /** Minus */
  135397. Minus = 8,
  135398. /** Plus */
  135399. Plus = 9,
  135400. /** LS */
  135401. LS = 10,
  135402. /** RS */
  135403. RS = 11,
  135404. /** DPadUp */
  135405. DPadUp = 12,
  135406. /** DPadDown */
  135407. DPadDown = 13,
  135408. /** DPadLeft */
  135409. DPadLeft = 14,
  135410. /** DRight */
  135411. DPadRight = 15,
  135412. /** Home */
  135413. Home = 16,
  135414. /** Capture */
  135415. Capture = 17,
  135416. /** LStickXAxis */
  135417. LStickXAxis = 18,
  135418. /** LStickYAxis */
  135419. LStickYAxis = 19,
  135420. /** RStickXAxis */
  135421. RStickXAxis = 20,
  135422. /** RStickYAxis */
  135423. RStickYAxis = 21
  135424. }
  135425. }
  135426. declare module BABYLON {
  135427. /**
  135428. * This class will take all inputs from Keyboard, Pointer, and
  135429. * any Gamepads and provide a polling system that all devices
  135430. * will use. This class assumes that there will only be one
  135431. * pointer device and one keyboard.
  135432. */
  135433. export class DeviceInputSystem implements IDisposable {
  135434. /**
  135435. * Callback to be triggered when a device is connected
  135436. */
  135437. onDeviceConnected: (deviceType: DeviceType, deviceSlot: number) => void;
  135438. /**
  135439. * Callback to be triggered when a device is disconnected
  135440. */
  135441. onDeviceDisconnected: (deviceType: DeviceType, deviceSlot: number) => void;
  135442. /**
  135443. * Callback to be triggered when event driven input is updated
  135444. */
  135445. onInputChanged: (deviceType: DeviceType, deviceSlot: number, inputIndex: number, previousState: Nullable<number>, currentState: Nullable<number>) => void;
  135446. private _inputs;
  135447. private _gamepads;
  135448. private _keyboardActive;
  135449. private _pointerActive;
  135450. private _elementToAttachTo;
  135451. private _keyboardDownEvent;
  135452. private _keyboardUpEvent;
  135453. private _pointerMoveEvent;
  135454. private _pointerDownEvent;
  135455. private _pointerUpEvent;
  135456. private _gamepadConnectedEvent;
  135457. private _gamepadDisconnectedEvent;
  135458. private static _MAX_KEYCODES;
  135459. private static _MAX_POINTER_INPUTS;
  135460. private constructor();
  135461. /**
  135462. * Creates a new DeviceInputSystem instance
  135463. * @param engine Engine to pull input element from
  135464. * @returns The new instance
  135465. */
  135466. static Create(engine: Engine): DeviceInputSystem;
  135467. /**
  135468. * Checks for current device input value, given an id and input index
  135469. * @param deviceName Id of connected device
  135470. * @param inputIndex Index of device input
  135471. * @returns Current value of input
  135472. */
  135473. /**
  135474. * Checks for current device input value, given an id and input index. Throws exception if requested device not initialized.
  135475. * @param deviceType Enum specifiying device type
  135476. * @param deviceSlot "Slot" or index that device is referenced in
  135477. * @param inputIndex Id of input to be checked
  135478. * @returns Current value of input
  135479. */
  135480. pollInput(deviceType: DeviceType, deviceSlot: number, inputIndex: number): number;
  135481. /**
  135482. * Dispose of all the eventlisteners
  135483. */
  135484. dispose(): void;
  135485. /**
  135486. * Add device and inputs to device array
  135487. * @param deviceType Enum specifiying device type
  135488. * @param deviceSlot "Slot" or index that device is referenced in
  135489. * @param numberOfInputs Number of input entries to create for given device
  135490. */
  135491. private _registerDevice;
  135492. /**
  135493. * Given a specific device name, remove that device from the device map
  135494. * @param deviceType Enum specifiying device type
  135495. * @param deviceSlot "Slot" or index that device is referenced in
  135496. */
  135497. private _unregisterDevice;
  135498. /**
  135499. * Handle all actions that come from keyboard interaction
  135500. */
  135501. private _handleKeyActions;
  135502. /**
  135503. * Handle all actions that come from pointer interaction
  135504. */
  135505. private _handlePointerActions;
  135506. /**
  135507. * Handle all actions that come from gamepad interaction
  135508. */
  135509. private _handleGamepadActions;
  135510. /**
  135511. * Update all non-event based devices with each frame
  135512. * @param deviceType Enum specifiying device type
  135513. * @param deviceSlot "Slot" or index that device is referenced in
  135514. * @param inputIndex Id of input to be checked
  135515. */
  135516. private _updateDevice;
  135517. /**
  135518. * Gets DeviceType from the device name
  135519. * @param deviceName Name of Device from DeviceInputSystem
  135520. * @returns DeviceType enum value
  135521. */
  135522. private _getGamepadDeviceType;
  135523. }
  135524. }
  135525. declare module BABYLON {
  135526. /**
  135527. * Type to handle enforcement of inputs
  135528. */
  135529. 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;
  135530. }
  135531. declare module BABYLON {
  135532. /**
  135533. * Class that handles all input for a specific device
  135534. */
  135535. export class DeviceSource<T extends DeviceType> {
  135536. /** Type of device */
  135537. readonly deviceType: DeviceType;
  135538. /** "Slot" or index that device is referenced in */
  135539. readonly deviceSlot: number;
  135540. /**
  135541. * Observable to handle device input changes per device
  135542. */
  135543. readonly onInputChangedObservable: Observable<{
  135544. inputIndex: DeviceInput<T>;
  135545. previousState: Nullable<number>;
  135546. currentState: Nullable<number>;
  135547. }>;
  135548. private readonly _deviceInputSystem;
  135549. /**
  135550. * Default Constructor
  135551. * @param deviceInputSystem Reference to DeviceInputSystem
  135552. * @param deviceType Type of device
  135553. * @param deviceSlot "Slot" or index that device is referenced in
  135554. */
  135555. constructor(deviceInputSystem: DeviceInputSystem,
  135556. /** Type of device */
  135557. deviceType: DeviceType,
  135558. /** "Slot" or index that device is referenced in */
  135559. deviceSlot?: number);
  135560. /**
  135561. * Get input for specific input
  135562. * @param inputIndex index of specific input on device
  135563. * @returns Input value from DeviceInputSystem
  135564. */
  135565. getInput(inputIndex: DeviceInput<T>): number;
  135566. }
  135567. /**
  135568. * Class to keep track of devices
  135569. */
  135570. export class DeviceSourceManager implements IDisposable {
  135571. /**
  135572. * Observable to be triggered when before a device is connected
  135573. */
  135574. readonly onBeforeDeviceConnectedObservable: Observable<{
  135575. deviceType: DeviceType;
  135576. deviceSlot: number;
  135577. }>;
  135578. /**
  135579. * Observable to be triggered when before a device is disconnected
  135580. */
  135581. readonly onBeforeDeviceDisconnectedObservable: Observable<{
  135582. deviceType: DeviceType;
  135583. deviceSlot: number;
  135584. }>;
  135585. /**
  135586. * Observable to be triggered when after a device is connected
  135587. */
  135588. readonly onAfterDeviceConnectedObservable: Observable<{
  135589. deviceType: DeviceType;
  135590. deviceSlot: number;
  135591. }>;
  135592. /**
  135593. * Observable to be triggered when after a device is disconnected
  135594. */
  135595. readonly onAfterDeviceDisconnectedObservable: Observable<{
  135596. deviceType: DeviceType;
  135597. deviceSlot: number;
  135598. }>;
  135599. private readonly _devices;
  135600. private readonly _firstDevice;
  135601. private readonly _deviceInputSystem;
  135602. /**
  135603. * Default Constructor
  135604. * @param engine engine to pull input element from
  135605. */
  135606. constructor(engine: Engine);
  135607. /**
  135608. * Gets a DeviceSource, given a type and slot
  135609. * @param deviceType Enum specifying device type
  135610. * @param deviceSlot "Slot" or index that device is referenced in
  135611. * @returns DeviceSource object
  135612. */
  135613. getDeviceSource<T extends DeviceType>(deviceType: T, deviceSlot?: number): Nullable<DeviceSource<T>>;
  135614. /**
  135615. * Gets an array of DeviceSource objects for a given device type
  135616. * @param deviceType Enum specifying device type
  135617. * @returns Array of DeviceSource objects
  135618. */
  135619. getDeviceSources<T extends DeviceType>(deviceType: T): ReadonlyArray<DeviceSource<T>>;
  135620. /**
  135621. * Dispose of DeviceInputSystem and other parts
  135622. */
  135623. dispose(): void;
  135624. /**
  135625. * Function to add device name to device list
  135626. * @param deviceType Enum specifying device type
  135627. * @param deviceSlot "Slot" or index that device is referenced in
  135628. */
  135629. private _addDevice;
  135630. /**
  135631. * Function to remove device name to device list
  135632. * @param deviceType Enum specifying device type
  135633. * @param deviceSlot "Slot" or index that device is referenced in
  135634. */
  135635. private _removeDevice;
  135636. /**
  135637. * Updates array storing first connected device of each type
  135638. * @param type Type of Device
  135639. */
  135640. private _updateFirstDevices;
  135641. }
  135642. }
  135643. declare module BABYLON {
  135644. /**
  135645. * Options to create the null engine
  135646. */
  135647. export class NullEngineOptions {
  135648. /**
  135649. * Render width (Default: 512)
  135650. */
  135651. renderWidth: number;
  135652. /**
  135653. * Render height (Default: 256)
  135654. */
  135655. renderHeight: number;
  135656. /**
  135657. * Texture size (Default: 512)
  135658. */
  135659. textureSize: number;
  135660. /**
  135661. * If delta time between frames should be constant
  135662. * @see https://doc.babylonjs.com/babylon101/animations#deterministic-lockstep
  135663. */
  135664. deterministicLockstep: boolean;
  135665. /**
  135666. * Maximum about of steps between frames (Default: 4)
  135667. * @see https://doc.babylonjs.com/babylon101/animations#deterministic-lockstep
  135668. */
  135669. lockstepMaxSteps: number;
  135670. /**
  135671. * Make the matrix computations to be performed in 64 bits instead of 32 bits. False by default
  135672. */
  135673. useHighPrecisionMatrix?: boolean;
  135674. }
  135675. /**
  135676. * The null engine class provides support for headless version of babylon.js.
  135677. * This can be used in server side scenario or for testing purposes
  135678. */
  135679. export class NullEngine extends Engine {
  135680. private _options;
  135681. /**
  135682. * Gets a boolean indicating that the engine is running in deterministic lock step mode
  135683. * @see https://doc.babylonjs.com/babylon101/animations#deterministic-lockstep
  135684. * @returns true if engine is in deterministic lock step mode
  135685. */
  135686. isDeterministicLockStep(): boolean;
  135687. /**
  135688. * Gets the max steps when engine is running in deterministic lock step
  135689. * @see https://doc.babylonjs.com/babylon101/animations#deterministic-lockstep
  135690. * @returns the max steps
  135691. */
  135692. getLockstepMaxSteps(): number;
  135693. /**
  135694. * Gets the current hardware scaling level.
  135695. * By default the hardware scaling level is computed from the window device ratio.
  135696. * 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.
  135697. * @returns a number indicating the current hardware scaling level
  135698. */
  135699. getHardwareScalingLevel(): number;
  135700. constructor(options?: NullEngineOptions);
  135701. /**
  135702. * Creates a vertex buffer
  135703. * @param vertices the data for the vertex buffer
  135704. * @returns the new WebGL static buffer
  135705. */
  135706. createVertexBuffer(vertices: FloatArray): DataBuffer;
  135707. /**
  135708. * Creates a new index buffer
  135709. * @param indices defines the content of the index buffer
  135710. * @param updatable defines if the index buffer must be updatable
  135711. * @returns a new webGL buffer
  135712. */
  135713. createIndexBuffer(indices: IndicesArray): DataBuffer;
  135714. /**
  135715. * Clear the current render buffer or the current render target (if any is set up)
  135716. * @param color defines the color to use
  135717. * @param backBuffer defines if the back buffer must be cleared
  135718. * @param depth defines if the depth buffer must be cleared
  135719. * @param stencil defines if the stencil buffer must be cleared
  135720. */
  135721. clear(color: IColor4Like, backBuffer: boolean, depth: boolean, stencil?: boolean): void;
  135722. /**
  135723. * Gets the current render width
  135724. * @param useScreen defines if screen size must be used (or the current render target if any)
  135725. * @returns a number defining the current render width
  135726. */
  135727. getRenderWidth(useScreen?: boolean): number;
  135728. /**
  135729. * Gets the current render height
  135730. * @param useScreen defines if screen size must be used (or the current render target if any)
  135731. * @returns a number defining the current render height
  135732. */
  135733. getRenderHeight(useScreen?: boolean): number;
  135734. /**
  135735. * Set the WebGL's viewport
  135736. * @param viewport defines the viewport element to be used
  135737. * @param requiredWidth defines the width required for rendering. If not provided the rendering canvas' width is used
  135738. * @param requiredHeight defines the height required for rendering. If not provided the rendering canvas' height is used
  135739. */
  135740. setViewport(viewport: IViewportLike, requiredWidth?: number, requiredHeight?: number): void;
  135741. createShaderProgram(pipelineContext: IPipelineContext, vertexCode: string, fragmentCode: string, defines: string, context?: WebGLRenderingContext): WebGLProgram;
  135742. /**
  135743. * Gets the list of webGL uniform locations associated with a specific program based on a list of uniform names
  135744. * @param pipelineContext defines the pipeline context to use
  135745. * @param uniformsNames defines the list of uniform names
  135746. * @returns an array of webGL uniform locations
  135747. */
  135748. getUniforms(pipelineContext: IPipelineContext, uniformsNames: string[]): Nullable<WebGLUniformLocation>[];
  135749. /**
  135750. * Gets the lsit of active attributes for a given webGL program
  135751. * @param pipelineContext defines the pipeline context to use
  135752. * @param attributesNames defines the list of attribute names to get
  135753. * @returns an array of indices indicating the offset of each attribute
  135754. */
  135755. getAttributes(pipelineContext: IPipelineContext, attributesNames: string[]): number[];
  135756. /**
  135757. * Binds an effect to the webGL context
  135758. * @param effect defines the effect to bind
  135759. */
  135760. bindSamplers(effect: Effect): void;
  135761. /**
  135762. * Activates an effect, mkaing it the current one (ie. the one used for rendering)
  135763. * @param effect defines the effect to activate
  135764. */
  135765. enableEffect(effect: Effect): void;
  135766. /**
  135767. * Set various states to the webGL context
  135768. * @param culling defines backface culling state
  135769. * @param zOffset defines the value to apply to zOffset (0 by default)
  135770. * @param force defines if states must be applied even if cache is up to date
  135771. * @param reverseSide defines if culling must be reversed (CCW instead of CW and CW instead of CCW)
  135772. */
  135773. setState(culling: boolean, zOffset?: number, force?: boolean, reverseSide?: boolean): void;
  135774. /**
  135775. * Set the value of an uniform to an array of int32
  135776. * @param uniform defines the webGL uniform location where to store the value
  135777. * @param array defines the array of int32 to store
  135778. * @returns true if value was set
  135779. */
  135780. setIntArray(uniform: WebGLUniformLocation, array: Int32Array): boolean;
  135781. /**
  135782. * Set the value of an uniform to an array of int32 (stored as vec2)
  135783. * @param uniform defines the webGL uniform location where to store the value
  135784. * @param array defines the array of int32 to store
  135785. * @returns true if value was set
  135786. */
  135787. setIntArray2(uniform: WebGLUniformLocation, array: Int32Array): boolean;
  135788. /**
  135789. * Set the value of an uniform to an array of int32 (stored as vec3)
  135790. * @param uniform defines the webGL uniform location where to store the value
  135791. * @param array defines the array of int32 to store
  135792. * @returns true if value was set
  135793. */
  135794. setIntArray3(uniform: WebGLUniformLocation, array: Int32Array): boolean;
  135795. /**
  135796. * Set the value of an uniform to an array of int32 (stored as vec4)
  135797. * @param uniform defines the webGL uniform location where to store the value
  135798. * @param array defines the array of int32 to store
  135799. * @returns true if value was set
  135800. */
  135801. setIntArray4(uniform: WebGLUniformLocation, array: Int32Array): boolean;
  135802. /**
  135803. * Set the value of an uniform to an array of float32
  135804. * @param uniform defines the webGL uniform location where to store the value
  135805. * @param array defines the array of float32 to store
  135806. * @returns true if value was set
  135807. */
  135808. setFloatArray(uniform: WebGLUniformLocation, array: Float32Array): boolean;
  135809. /**
  135810. * Set the value of an uniform to an array of float32 (stored as vec2)
  135811. * @param uniform defines the webGL uniform location where to store the value
  135812. * @param array defines the array of float32 to store
  135813. * @returns true if value was set
  135814. */
  135815. setFloatArray2(uniform: WebGLUniformLocation, array: Float32Array): boolean;
  135816. /**
  135817. * Set the value of an uniform to an array of float32 (stored as vec3)
  135818. * @param uniform defines the webGL uniform location where to store the value
  135819. * @param array defines the array of float32 to store
  135820. * @returns true if value was set
  135821. */
  135822. setFloatArray3(uniform: WebGLUniformLocation, array: Float32Array): boolean;
  135823. /**
  135824. * Set the value of an uniform to an array of float32 (stored as vec4)
  135825. * @param uniform defines the webGL uniform location where to store the value
  135826. * @param array defines the array of float32 to store
  135827. * @returns true if value was set
  135828. */
  135829. setFloatArray4(uniform: WebGLUniformLocation, array: Float32Array): boolean;
  135830. /**
  135831. * Set the value of an uniform to an array of number
  135832. * @param uniform defines the webGL uniform location where to store the value
  135833. * @param array defines the array of number to store
  135834. * @returns true if value was set
  135835. */
  135836. setArray(uniform: WebGLUniformLocation, array: number[]): boolean;
  135837. /**
  135838. * Set the value of an uniform to an array of number (stored as vec2)
  135839. * @param uniform defines the webGL uniform location where to store the value
  135840. * @param array defines the array of number to store
  135841. * @returns true if value was set
  135842. */
  135843. setArray2(uniform: WebGLUniformLocation, array: number[]): boolean;
  135844. /**
  135845. * Set the value of an uniform to an array of number (stored as vec3)
  135846. * @param uniform defines the webGL uniform location where to store the value
  135847. * @param array defines the array of number to store
  135848. * @returns true if value was set
  135849. */
  135850. setArray3(uniform: WebGLUniformLocation, array: number[]): boolean;
  135851. /**
  135852. * Set the value of an uniform to an array of number (stored as vec4)
  135853. * @param uniform defines the webGL uniform location where to store the value
  135854. * @param array defines the array of number to store
  135855. * @returns true if value was set
  135856. */
  135857. setArray4(uniform: WebGLUniformLocation, array: number[]): boolean;
  135858. /**
  135859. * Set the value of an uniform to an array of float32 (stored as matrices)
  135860. * @param uniform defines the webGL uniform location where to store the value
  135861. * @param matrices defines the array of float32 to store
  135862. * @returns true if value was set
  135863. */
  135864. setMatrices(uniform: WebGLUniformLocation, matrices: Float32Array): boolean;
  135865. /**
  135866. * Set the value of an uniform to a matrix (3x3)
  135867. * @param uniform defines the webGL uniform location where to store the value
  135868. * @param matrix defines the Float32Array representing the 3x3 matrix to store
  135869. * @returns true if value was set
  135870. */
  135871. setMatrix3x3(uniform: WebGLUniformLocation, matrix: Float32Array): boolean;
  135872. /**
  135873. * Set the value of an uniform to a matrix (2x2)
  135874. * @param uniform defines the webGL uniform location where to store the value
  135875. * @param matrix defines the Float32Array representing the 2x2 matrix to store
  135876. * @returns true if value was set
  135877. */
  135878. setMatrix2x2(uniform: WebGLUniformLocation, matrix: Float32Array): boolean;
  135879. /**
  135880. * Set the value of an uniform to a number (float)
  135881. * @param uniform defines the webGL uniform location where to store the value
  135882. * @param value defines the float number to store
  135883. * @returns true if value was set
  135884. */
  135885. setFloat(uniform: WebGLUniformLocation, value: number): boolean;
  135886. /**
  135887. * Set the value of an uniform to a vec2
  135888. * @param uniform defines the webGL uniform location where to store the value
  135889. * @param x defines the 1st component of the value
  135890. * @param y defines the 2nd component of the value
  135891. * @returns true if value was set
  135892. */
  135893. setFloat2(uniform: WebGLUniformLocation, x: number, y: number): boolean;
  135894. /**
  135895. * Set the value of an uniform to a vec3
  135896. * @param uniform defines the webGL uniform location where to store the value
  135897. * @param x defines the 1st component of the value
  135898. * @param y defines the 2nd component of the value
  135899. * @param z defines the 3rd component of the value
  135900. * @returns true if value was set
  135901. */
  135902. setFloat3(uniform: WebGLUniformLocation, x: number, y: number, z: number): boolean;
  135903. /**
  135904. * Set the value of an uniform to a boolean
  135905. * @param uniform defines the webGL uniform location where to store the value
  135906. * @param bool defines the boolean to store
  135907. * @returns true if value was set
  135908. */
  135909. setBool(uniform: WebGLUniformLocation, bool: number): boolean;
  135910. /**
  135911. * Set the value of an uniform to a vec4
  135912. * @param uniform defines the webGL uniform location where to store the value
  135913. * @param x defines the 1st component of the value
  135914. * @param y defines the 2nd component of the value
  135915. * @param z defines the 3rd component of the value
  135916. * @param w defines the 4th component of the value
  135917. * @returns true if value was set
  135918. */
  135919. setFloat4(uniform: WebGLUniformLocation, x: number, y: number, z: number, w: number): boolean;
  135920. /**
  135921. * Sets the current alpha mode
  135922. * @param mode defines the mode to use (one of the Engine.ALPHA_XXX)
  135923. * @param noDepthWriteChange defines if depth writing state should remains unchanged (false by default)
  135924. * @see https://doc.babylonjs.com/resources/transparency_and_how_meshes_are_rendered
  135925. */
  135926. setAlphaMode(mode: number, noDepthWriteChange?: boolean): void;
  135927. /**
  135928. * Bind webGl buffers directly to the webGL context
  135929. * @param vertexBuffers defines the vertex buffer to bind
  135930. * @param indexBuffer defines the index buffer to bind
  135931. * @param vertexDeclaration defines the vertex declaration to use with the vertex buffer
  135932. * @param vertexStrideSize defines the vertex stride of the vertex buffer
  135933. * @param effect defines the effect associated with the vertex buffer
  135934. */
  135935. bindBuffers(vertexBuffers: {
  135936. [key: string]: VertexBuffer;
  135937. }, indexBuffer: DataBuffer, effect: Effect): void;
  135938. /**
  135939. * Force the entire cache to be cleared
  135940. * You should not have to use this function unless your engine needs to share the webGL context with another engine
  135941. * @param bruteForce defines a boolean to force clearing ALL caches (including stencil, detoh and alpha states)
  135942. */
  135943. wipeCaches(bruteForce?: boolean): void;
  135944. /**
  135945. * Send a draw order
  135946. * @param useTriangles defines if triangles must be used to draw (else wireframe will be used)
  135947. * @param indexStart defines the starting index
  135948. * @param indexCount defines the number of index to draw
  135949. * @param instancesCount defines the number of instances to draw (if instanciation is enabled)
  135950. */
  135951. draw(useTriangles: boolean, indexStart: number, indexCount: number, instancesCount?: number): void;
  135952. /**
  135953. * Draw a list of indexed primitives
  135954. * @param fillMode defines the primitive to use
  135955. * @param indexStart defines the starting index
  135956. * @param indexCount defines the number of index to draw
  135957. * @param instancesCount defines the number of instances to draw (if instanciation is enabled)
  135958. */
  135959. drawElementsType(fillMode: number, indexStart: number, indexCount: number, instancesCount?: number): void;
  135960. /**
  135961. * Draw a list of unindexed primitives
  135962. * @param fillMode defines the primitive to use
  135963. * @param verticesStart defines the index of first vertex to draw
  135964. * @param verticesCount defines the count of vertices to draw
  135965. * @param instancesCount defines the number of instances to draw (if instanciation is enabled)
  135966. */
  135967. drawArraysType(fillMode: number, verticesStart: number, verticesCount: number, instancesCount?: number): void;
  135968. /** @hidden */
  135969. _createTexture(): WebGLTexture;
  135970. /** @hidden */
  135971. _releaseTexture(texture: InternalTexture): void;
  135972. /**
  135973. * Usually called from Texture.ts.
  135974. * Passed information to create a WebGLTexture
  135975. * @param urlArg defines a value which contains one of the following:
  135976. * * A conventional http URL, e.g. 'http://...' or 'file://...'
  135977. * * A base64 string of in-line texture data, e.g. 'data:image/jpg;base64,/...'
  135978. * * An indicator that data being passed using the buffer parameter, e.g. 'data:mytexture.jpg'
  135979. * @param noMipmap defines a boolean indicating that no mipmaps shall be generated. Ignored for compressed textures. They must be in the file
  135980. * @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)
  135981. * @param scene needed for loading to the correct scene
  135982. * @param samplingMode mode with should be used sample / access the texture (Default: Texture.TRILINEAR_SAMPLINGMODE)
  135983. * @param onLoad optional callback to be called upon successful completion
  135984. * @param onError optional callback to be called upon failure
  135985. * @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
  135986. * @param fallback an internal argument in case the function must be called again, due to etc1 not having alpha capabilities
  135987. * @param format internal format. Default: RGB when extension is '.jpg' else RGBA. Ignored for compressed textures
  135988. * @param forcedExtension defines the extension to use to pick the right loader
  135989. * @param mimeType defines an optional mime type
  135990. * @returns a InternalTexture for assignment back into BABYLON.Texture
  135991. */
  135992. 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;
  135993. /**
  135994. * Creates a new render target texture
  135995. * @param size defines the size of the texture
  135996. * @param options defines the options used to create the texture
  135997. * @returns a new render target texture stored in an InternalTexture
  135998. */
  135999. createRenderTargetTexture(size: any, options: boolean | RenderTargetCreationOptions): InternalTexture;
  136000. /**
  136001. * Update the sampling mode of a given texture
  136002. * @param samplingMode defines the required sampling mode
  136003. * @param texture defines the texture to update
  136004. */
  136005. updateTextureSamplingMode(samplingMode: number, texture: InternalTexture): void;
  136006. /**
  136007. * Binds the frame buffer to the specified texture.
  136008. * @param texture The texture to render to or null for the default canvas
  136009. * @param faceIndex The face of the texture to render to in case of cube texture
  136010. * @param requiredWidth The width of the target to render to
  136011. * @param requiredHeight The height of the target to render to
  136012. * @param forceFullscreenViewport Forces the viewport to be the entire texture/screen if true
  136013. * @param lodLevel defines le lod level to bind to the frame buffer
  136014. */
  136015. bindFramebuffer(texture: InternalTexture, faceIndex?: number, requiredWidth?: number, requiredHeight?: number, forceFullscreenViewport?: boolean): void;
  136016. /**
  136017. * Unbind the current render target texture from the webGL context
  136018. * @param texture defines the render target texture to unbind
  136019. * @param disableGenerateMipMaps defines a boolean indicating that mipmaps must not be generated
  136020. * @param onBeforeUnbind defines a function which will be called before the effective unbind
  136021. */
  136022. unBindFramebuffer(texture: InternalTexture, disableGenerateMipMaps?: boolean, onBeforeUnbind?: () => void): void;
  136023. /**
  136024. * Creates a dynamic vertex buffer
  136025. * @param vertices the data for the dynamic vertex buffer
  136026. * @returns the new WebGL dynamic buffer
  136027. */
  136028. createDynamicVertexBuffer(vertices: FloatArray): DataBuffer;
  136029. /**
  136030. * Update the content of a dynamic texture
  136031. * @param texture defines the texture to update
  136032. * @param canvas defines the canvas containing the source
  136033. * @param invertY defines if data must be stored with Y axis inverted
  136034. * @param premulAlpha defines if alpha is stored as premultiplied
  136035. * @param format defines the format of the data
  136036. * @param forceBindTexture if the texture should be forced to be bound eg. after a graphics context loss (Default: false)
  136037. */
  136038. updateDynamicTexture(texture: Nullable<InternalTexture>, canvas: HTMLCanvasElement, invertY: boolean, premulAlpha?: boolean, format?: number): void;
  136039. /**
  136040. * Gets a boolean indicating if all created effects are ready
  136041. * @returns true if all effects are ready
  136042. */
  136043. areAllEffectsReady(): boolean;
  136044. /**
  136045. * @hidden
  136046. * Get the current error code of the webGL context
  136047. * @returns the error code
  136048. * @see https://developer.mozilla.org/en-US/docs/Web/API/WebGLRenderingContext/getError
  136049. */
  136050. getError(): number;
  136051. /** @hidden */
  136052. _getUnpackAlignement(): number;
  136053. /** @hidden */
  136054. _unpackFlipY(value: boolean): void;
  136055. /**
  136056. * Update a dynamic index buffer
  136057. * @param indexBuffer defines the target index buffer
  136058. * @param indices defines the data to update
  136059. * @param offset defines the offset in the target index buffer where update should start
  136060. */
  136061. updateDynamicIndexBuffer(indexBuffer: WebGLBuffer, indices: IndicesArray, offset?: number): void;
  136062. /**
  136063. * Updates a dynamic vertex buffer.
  136064. * @param vertexBuffer the vertex buffer to update
  136065. * @param vertices the data used to update the vertex buffer
  136066. * @param byteOffset the byte offset of the data (optional)
  136067. * @param byteLength the byte length of the data (optional)
  136068. */
  136069. updateDynamicVertexBuffer(vertexBuffer: WebGLBuffer, vertices: FloatArray, byteOffset?: number, byteLength?: number): void;
  136070. /** @hidden */
  136071. _bindTextureDirectly(target: number, texture: InternalTexture): boolean;
  136072. /** @hidden */
  136073. _bindTexture(channel: number, texture: InternalTexture): void;
  136074. protected _deleteBuffer(buffer: WebGLBuffer): void;
  136075. /**
  136076. * 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
  136077. */
  136078. releaseEffects(): void;
  136079. displayLoadingUI(): void;
  136080. hideLoadingUI(): void;
  136081. /** @hidden */
  136082. _uploadCompressedDataToTextureDirectly(texture: InternalTexture, internalFormat: number, width: number, height: number, data: ArrayBufferView, faceIndex?: number, lod?: number): void;
  136083. /** @hidden */
  136084. _uploadDataToTextureDirectly(texture: InternalTexture, imageData: ArrayBufferView, faceIndex?: number, lod?: number): void;
  136085. /** @hidden */
  136086. _uploadArrayBufferViewToTexture(texture: InternalTexture, imageData: ArrayBufferView, faceIndex?: number, lod?: number): void;
  136087. /** @hidden */
  136088. _uploadImageToTexture(texture: InternalTexture, image: HTMLImageElement, faceIndex?: number, lod?: number): void;
  136089. }
  136090. }
  136091. declare module BABYLON {
  136092. /**
  136093. * @hidden
  136094. **/
  136095. export class _TimeToken {
  136096. _startTimeQuery: Nullable<WebGLQuery>;
  136097. _endTimeQuery: Nullable<WebGLQuery>;
  136098. _timeElapsedQuery: Nullable<WebGLQuery>;
  136099. _timeElapsedQueryEnded: boolean;
  136100. }
  136101. }
  136102. declare module BABYLON {
  136103. /** @hidden */
  136104. export class _OcclusionDataStorage {
  136105. /** @hidden */
  136106. occlusionInternalRetryCounter: number;
  136107. /** @hidden */
  136108. isOcclusionQueryInProgress: boolean;
  136109. /** @hidden */
  136110. isOccluded: boolean;
  136111. /** @hidden */
  136112. occlusionRetryCount: number;
  136113. /** @hidden */
  136114. occlusionType: number;
  136115. /** @hidden */
  136116. occlusionQueryAlgorithmType: number;
  136117. }
  136118. interface Engine {
  136119. /**
  136120. * Create a new webGL query (you must be sure that queries are supported by checking getCaps() function)
  136121. * @return the new query
  136122. */
  136123. createQuery(): WebGLQuery;
  136124. /**
  136125. * Delete and release a webGL query
  136126. * @param query defines the query to delete
  136127. * @return the current engine
  136128. */
  136129. deleteQuery(query: WebGLQuery): Engine;
  136130. /**
  136131. * Check if a given query has resolved and got its value
  136132. * @param query defines the query to check
  136133. * @returns true if the query got its value
  136134. */
  136135. isQueryResultAvailable(query: WebGLQuery): boolean;
  136136. /**
  136137. * Gets the value of a given query
  136138. * @param query defines the query to check
  136139. * @returns the value of the query
  136140. */
  136141. getQueryResult(query: WebGLQuery): number;
  136142. /**
  136143. * Initiates an occlusion query
  136144. * @param algorithmType defines the algorithm to use
  136145. * @param query defines the query to use
  136146. * @returns the current engine
  136147. * @see https://doc.babylonjs.com/features/occlusionquery
  136148. */
  136149. beginOcclusionQuery(algorithmType: number, query: WebGLQuery): Engine;
  136150. /**
  136151. * Ends an occlusion query
  136152. * @see https://doc.babylonjs.com/features/occlusionquery
  136153. * @param algorithmType defines the algorithm to use
  136154. * @returns the current engine
  136155. */
  136156. endOcclusionQuery(algorithmType: number): Engine;
  136157. /**
  136158. * Starts a time query (used to measure time spent by the GPU on a specific frame)
  136159. * Please note that only one query can be issued at a time
  136160. * @returns a time token used to track the time span
  136161. */
  136162. startTimeQuery(): Nullable<_TimeToken>;
  136163. /**
  136164. * Ends a time query
  136165. * @param token defines the token used to measure the time span
  136166. * @returns the time spent (in ns)
  136167. */
  136168. endTimeQuery(token: _TimeToken): int;
  136169. /** @hidden */
  136170. _currentNonTimestampToken: Nullable<_TimeToken>;
  136171. /** @hidden */
  136172. _createTimeQuery(): WebGLQuery;
  136173. /** @hidden */
  136174. _deleteTimeQuery(query: WebGLQuery): void;
  136175. /** @hidden */
  136176. _getGlAlgorithmType(algorithmType: number): number;
  136177. /** @hidden */
  136178. _getTimeQueryResult(query: WebGLQuery): any;
  136179. /** @hidden */
  136180. _getTimeQueryAvailability(query: WebGLQuery): any;
  136181. }
  136182. interface AbstractMesh {
  136183. /**
  136184. * Backing filed
  136185. * @hidden
  136186. */
  136187. __occlusionDataStorage: _OcclusionDataStorage;
  136188. /**
  136189. * Access property
  136190. * @hidden
  136191. */
  136192. _occlusionDataStorage: _OcclusionDataStorage;
  136193. /**
  136194. * 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.
  136195. * The default value is -1 which means don't break the query and wait till the result
  136196. * @see https://doc.babylonjs.com/features/occlusionquery
  136197. */
  136198. occlusionRetryCount: number;
  136199. /**
  136200. * 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:
  136201. * * OCCLUSION_TYPE_NONE (Default Value): this option means no occlusion query whith the Mesh.
  136202. * * OCCLUSION_TYPE_OPTIMISTIC: this option is means use occlusion query and if occlusionRetryCount is reached and the query is broken show the mesh.
  136203. * * 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.
  136204. * @see https://doc.babylonjs.com/features/occlusionquery
  136205. */
  136206. occlusionType: number;
  136207. /**
  136208. * This property determines the type of occlusion query algorithm to run in WebGl, you can use:
  136209. * * AbstractMesh.OCCLUSION_ALGORITHM_TYPE_ACCURATE which is mapped to GL_ANY_SAMPLES_PASSED.
  136210. * * 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.
  136211. * @see https://doc.babylonjs.com/features/occlusionquery
  136212. */
  136213. occlusionQueryAlgorithmType: number;
  136214. /**
  136215. * 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
  136216. * @see https://doc.babylonjs.com/features/occlusionquery
  136217. */
  136218. isOccluded: boolean;
  136219. /**
  136220. * Flag to check the progress status of the query
  136221. * @see https://doc.babylonjs.com/features/occlusionquery
  136222. */
  136223. isOcclusionQueryInProgress: boolean;
  136224. }
  136225. }
  136226. declare module BABYLON {
  136227. /** @hidden */
  136228. export var _forceTransformFeedbackToBundle: boolean;
  136229. interface Engine {
  136230. /**
  136231. * Creates a webGL transform feedback object
  136232. * Please makes sure to check webGLVersion property to check if you are running webGL 2+
  136233. * @returns the webGL transform feedback object
  136234. */
  136235. createTransformFeedback(): WebGLTransformFeedback;
  136236. /**
  136237. * Delete a webGL transform feedback object
  136238. * @param value defines the webGL transform feedback object to delete
  136239. */
  136240. deleteTransformFeedback(value: WebGLTransformFeedback): void;
  136241. /**
  136242. * Bind a webGL transform feedback object to the webgl context
  136243. * @param value defines the webGL transform feedback object to bind
  136244. */
  136245. bindTransformFeedback(value: Nullable<WebGLTransformFeedback>): void;
  136246. /**
  136247. * Begins a transform feedback operation
  136248. * @param usePoints defines if points or triangles must be used
  136249. */
  136250. beginTransformFeedback(usePoints: boolean): void;
  136251. /**
  136252. * Ends a transform feedback operation
  136253. */
  136254. endTransformFeedback(): void;
  136255. /**
  136256. * Specify the varyings to use with transform feedback
  136257. * @param program defines the associated webGL program
  136258. * @param value defines the list of strings representing the varying names
  136259. */
  136260. setTranformFeedbackVaryings(program: WebGLProgram, value: string[]): void;
  136261. /**
  136262. * Bind a webGL buffer for a transform feedback operation
  136263. * @param value defines the webGL buffer to bind
  136264. */
  136265. bindTransformFeedbackBuffer(value: Nullable<DataBuffer>): void;
  136266. }
  136267. }
  136268. declare module BABYLON {
  136269. /**
  136270. * Class used to define an additional view for the engine
  136271. * @see https://doc.babylonjs.com/how_to/multi_canvases
  136272. */
  136273. export class EngineView {
  136274. /** Defines the canvas where to render the view */
  136275. target: HTMLCanvasElement;
  136276. /** Defines an optional camera used to render the view (will use active camera else) */
  136277. camera?: Camera;
  136278. }
  136279. interface Engine {
  136280. /**
  136281. * Gets or sets the HTML element to use for attaching events
  136282. */
  136283. inputElement: Nullable<HTMLElement>;
  136284. /**
  136285. * Gets the current engine view
  136286. * @see https://doc.babylonjs.com/how_to/multi_canvases
  136287. */
  136288. activeView: Nullable<EngineView>;
  136289. /** Gets or sets the list of views */
  136290. views: EngineView[];
  136291. /**
  136292. * Register a new child canvas
  136293. * @param canvas defines the canvas to register
  136294. * @param camera defines an optional camera to use with this canvas (it will overwrite the scene.camera for this view)
  136295. * @returns the associated view
  136296. */
  136297. registerView(canvas: HTMLCanvasElement, camera?: Camera): EngineView;
  136298. /**
  136299. * Remove a registered child canvas
  136300. * @param canvas defines the canvas to remove
  136301. * @returns the current engine
  136302. */
  136303. unRegisterView(canvas: HTMLCanvasElement): Engine;
  136304. }
  136305. }
  136306. declare module BABYLON {
  136307. interface Engine {
  136308. /** @hidden */
  136309. _excludedCompressedTextures: string[];
  136310. /** @hidden */
  136311. _textureFormatInUse: string;
  136312. /**
  136313. * Gets the list of texture formats supported
  136314. */
  136315. readonly texturesSupported: Array<string>;
  136316. /**
  136317. * Gets the texture format in use
  136318. */
  136319. readonly textureFormatInUse: Nullable<string>;
  136320. /**
  136321. * Set the compressed texture extensions or file names to skip.
  136322. *
  136323. * @param skippedFiles defines the list of those texture files you want to skip
  136324. * Example: [".dds", ".env", "myfile.png"]
  136325. */
  136326. setCompressedTextureExclusions(skippedFiles: Array<string>): void;
  136327. /**
  136328. * Set the compressed texture format to use, based on the formats you have, and the formats
  136329. * supported by the hardware / browser.
  136330. *
  136331. * Khronos Texture Container (.ktx) files are used to support this. This format has the
  136332. * advantage of being specifically designed for OpenGL. Header elements directly correspond
  136333. * to API arguments needed to compressed textures. This puts the burden on the container
  136334. * generator to house the arcane code for determining these for current & future formats.
  136335. *
  136336. * for description see https://www.khronos.org/opengles/sdk/tools/KTX/
  136337. * for file layout see https://www.khronos.org/opengles/sdk/tools/KTX/file_format_spec/
  136338. *
  136339. * Note: The result of this call is not taken into account when a texture is base64.
  136340. *
  136341. * @param formatsAvailable defines the list of those format families you have created
  136342. * on your server. Syntax: '-' + format family + '.ktx'. (Case and order do not matter.)
  136343. *
  136344. * Current families are astc, dxt, pvrtc, etc2, & etc1.
  136345. * @returns The extension selected.
  136346. */
  136347. setTextureFormatToUse(formatsAvailable: Array<string>): Nullable<string>;
  136348. }
  136349. }
  136350. declare module BABYLON {
  136351. /** @hidden */
  136352. export var rgbdEncodePixelShader: {
  136353. name: string;
  136354. shader: string;
  136355. };
  136356. }
  136357. declare module BABYLON {
  136358. /**
  136359. * Raw texture data and descriptor sufficient for WebGL texture upload
  136360. */
  136361. export interface EnvironmentTextureInfo {
  136362. /**
  136363. * Version of the environment map
  136364. */
  136365. version: number;
  136366. /**
  136367. * Width of image
  136368. */
  136369. width: number;
  136370. /**
  136371. * Irradiance information stored in the file.
  136372. */
  136373. irradiance: any;
  136374. /**
  136375. * Specular information stored in the file.
  136376. */
  136377. specular: any;
  136378. }
  136379. /**
  136380. * Defines One Image in the file. It requires only the position in the file
  136381. * as well as the length.
  136382. */
  136383. interface BufferImageData {
  136384. /**
  136385. * Length of the image data.
  136386. */
  136387. length: number;
  136388. /**
  136389. * Position of the data from the null terminator delimiting the end of the JSON.
  136390. */
  136391. position: number;
  136392. }
  136393. /**
  136394. * Defines the specular data enclosed in the file.
  136395. * This corresponds to the version 1 of the data.
  136396. */
  136397. export interface EnvironmentTextureSpecularInfoV1 {
  136398. /**
  136399. * Defines where the specular Payload is located. It is a runtime value only not stored in the file.
  136400. */
  136401. specularDataPosition?: number;
  136402. /**
  136403. * This contains all the images data needed to reconstruct the cubemap.
  136404. */
  136405. mipmaps: Array<BufferImageData>;
  136406. /**
  136407. * Defines the scale applied to environment texture. This manages the range of LOD level used for IBL according to the roughness.
  136408. */
  136409. lodGenerationScale: number;
  136410. }
  136411. /**
  136412. * Sets of helpers addressing the serialization and deserialization of environment texture
  136413. * stored in a BabylonJS env file.
  136414. * Those files are usually stored as .env files.
  136415. */
  136416. export class EnvironmentTextureTools {
  136417. /**
  136418. * Magic number identifying the env file.
  136419. */
  136420. private static _MagicBytes;
  136421. /**
  136422. * Gets the environment info from an env file.
  136423. * @param data The array buffer containing the .env bytes.
  136424. * @returns the environment file info (the json header) if successfully parsed.
  136425. */
  136426. static GetEnvInfo(data: ArrayBufferView): Nullable<EnvironmentTextureInfo>;
  136427. /**
  136428. * Creates an environment texture from a loaded cube texture.
  136429. * @param texture defines the cube texture to convert in env file
  136430. * @return a promise containing the environment data if succesfull.
  136431. */
  136432. static CreateEnvTextureAsync(texture: BaseTexture): Promise<ArrayBuffer>;
  136433. /**
  136434. * Creates a JSON representation of the spherical data.
  136435. * @param texture defines the texture containing the polynomials
  136436. * @return the JSON representation of the spherical info
  136437. */
  136438. private static _CreateEnvTextureIrradiance;
  136439. /**
  136440. * Creates the ArrayBufferViews used for initializing environment texture image data.
  136441. * @param data the image data
  136442. * @param info parameters that determine what views will be created for accessing the underlying buffer
  136443. * @return the views described by info providing access to the underlying buffer
  136444. */
  136445. static CreateImageDataArrayBufferViews(data: ArrayBufferView, info: EnvironmentTextureInfo): Array<Array<ArrayBufferView>>;
  136446. /**
  136447. * Uploads the texture info contained in the env file to the GPU.
  136448. * @param texture defines the internal texture to upload to
  136449. * @param data defines the data to load
  136450. * @param info defines the texture info retrieved through the GetEnvInfo method
  136451. * @returns a promise
  136452. */
  136453. static UploadEnvLevelsAsync(texture: InternalTexture, data: ArrayBufferView, info: EnvironmentTextureInfo): Promise<void>;
  136454. private static _OnImageReadyAsync;
  136455. /**
  136456. * Uploads the levels of image data to the GPU.
  136457. * @param texture defines the internal texture to upload to
  136458. * @param imageData defines the array buffer views of image data [mipmap][face]
  136459. * @returns a promise
  136460. */
  136461. static UploadLevelsAsync(texture: InternalTexture, imageData: ArrayBufferView[][]): Promise<void>;
  136462. /**
  136463. * Uploads spherical polynomials information to the texture.
  136464. * @param texture defines the texture we are trying to upload the information to
  136465. * @param info defines the environment texture info retrieved through the GetEnvInfo method
  136466. */
  136467. static UploadEnvSpherical(texture: InternalTexture, info: EnvironmentTextureInfo): void;
  136468. /** @hidden */
  136469. static _UpdateRGBDAsync(internalTexture: InternalTexture, data: ArrayBufferView[][], sphericalPolynomial: Nullable<SphericalPolynomial>, lodScale: number, lodOffset: number): Promise<void>;
  136470. }
  136471. }
  136472. declare module BABYLON {
  136473. /**
  136474. * Class used to inline functions in shader code
  136475. */
  136476. export class ShaderCodeInliner {
  136477. private static readonly _RegexpFindFunctionNameAndType;
  136478. private _sourceCode;
  136479. private _functionDescr;
  136480. private _numMaxIterations;
  136481. /** Gets or sets the token used to mark the functions to inline */
  136482. inlineToken: string;
  136483. /** Gets or sets the debug mode */
  136484. debug: boolean;
  136485. /** Gets the code after the inlining process */
  136486. get code(): string;
  136487. /**
  136488. * Initializes the inliner
  136489. * @param sourceCode shader code source to inline
  136490. * @param numMaxIterations maximum number of iterations (used to detect recursive calls)
  136491. */
  136492. constructor(sourceCode: string, numMaxIterations?: number);
  136493. /**
  136494. * Start the processing of the shader code
  136495. */
  136496. processCode(): void;
  136497. private _collectFunctions;
  136498. private _processInlining;
  136499. private _extractBetweenMarkers;
  136500. private _skipWhitespaces;
  136501. private _removeComments;
  136502. private _replaceFunctionCallsByCode;
  136503. private _findBackward;
  136504. private _escapeRegExp;
  136505. private _replaceNames;
  136506. }
  136507. }
  136508. declare module BABYLON {
  136509. /**
  136510. * Container for accessors for natively-stored mesh data buffers.
  136511. */
  136512. class NativeDataBuffer extends DataBuffer {
  136513. /**
  136514. * Accessor value used to identify/retrieve a natively-stored index buffer.
  136515. */
  136516. nativeIndexBuffer?: any;
  136517. /**
  136518. * Accessor value used to identify/retrieve a natively-stored vertex buffer.
  136519. */
  136520. nativeVertexBuffer?: any;
  136521. }
  136522. /** @hidden */
  136523. class NativeTexture extends InternalTexture {
  136524. getInternalTexture(): InternalTexture;
  136525. getViewCount(): number;
  136526. }
  136527. /** @hidden */
  136528. export class NativeEngine extends Engine {
  136529. private readonly _native;
  136530. /** Defines the invalid handle returned by bgfx when resource creation goes wrong */
  136531. private readonly INVALID_HANDLE;
  136532. private _boundBuffersVertexArray;
  136533. private _currentDepthTest;
  136534. getHardwareScalingLevel(): number;
  136535. constructor();
  136536. dispose(): void;
  136537. /**
  136538. * Can be used to override the current requestAnimationFrame requester.
  136539. * @hidden
  136540. */
  136541. protected _queueNewFrame(bindedRenderFunction: any, requester?: any): number;
  136542. /**
  136543. * Override default engine behavior.
  136544. * @param color
  136545. * @param backBuffer
  136546. * @param depth
  136547. * @param stencil
  136548. */
  136549. _bindUnboundFramebuffer(framebuffer: Nullable<WebGLFramebuffer>): void;
  136550. /**
  136551. * Gets host document
  136552. * @returns the host document object
  136553. */
  136554. getHostDocument(): Nullable<Document>;
  136555. clear(color: Nullable<IColor4Like>, backBuffer: boolean, depth: boolean, stencil?: boolean): void;
  136556. createIndexBuffer(indices: IndicesArray, updateable?: boolean): NativeDataBuffer;
  136557. createVertexBuffer(data: DataArray, updateable?: boolean): NativeDataBuffer;
  136558. protected _recordVertexArrayObject(vertexArray: any, vertexBuffers: {
  136559. [key: string]: VertexBuffer;
  136560. }, indexBuffer: Nullable<NativeDataBuffer>, effect: Effect): void;
  136561. bindBuffers(vertexBuffers: {
  136562. [key: string]: VertexBuffer;
  136563. }, indexBuffer: Nullable<NativeDataBuffer>, effect: Effect): void;
  136564. recordVertexArrayObject(vertexBuffers: {
  136565. [key: string]: VertexBuffer;
  136566. }, indexBuffer: Nullable<NativeDataBuffer>, effect: Effect): WebGLVertexArrayObject;
  136567. bindVertexArrayObject(vertexArray: WebGLVertexArrayObject): void;
  136568. releaseVertexArrayObject(vertexArray: WebGLVertexArrayObject): void;
  136569. getAttributes(pipelineContext: IPipelineContext, attributesNames: string[]): number[];
  136570. /**
  136571. * Draw a list of indexed primitives
  136572. * @param fillMode defines the primitive to use
  136573. * @param indexStart defines the starting index
  136574. * @param indexCount defines the number of index to draw
  136575. * @param instancesCount defines the number of instances to draw (if instanciation is enabled)
  136576. */
  136577. drawElementsType(fillMode: number, indexStart: number, indexCount: number, instancesCount?: number): void;
  136578. /**
  136579. * Draw a list of unindexed primitives
  136580. * @param fillMode defines the primitive to use
  136581. * @param verticesStart defines the index of first vertex to draw
  136582. * @param verticesCount defines the count of vertices to draw
  136583. * @param instancesCount defines the number of instances to draw (if instanciation is enabled)
  136584. */
  136585. drawArraysType(fillMode: number, verticesStart: number, verticesCount: number, instancesCount?: number): void;
  136586. createPipelineContext(): IPipelineContext;
  136587. _preparePipelineContext(pipelineContext: IPipelineContext, vertexSourceCode: string, fragmentSourceCode: string, createAsRaw: boolean, rebuildRebind: any, defines: Nullable<string>, transformFeedbackVaryings: Nullable<string[]>): void;
  136588. /** @hidden */
  136589. _isRenderingStateCompiled(pipelineContext: IPipelineContext): boolean;
  136590. /** @hidden */
  136591. _executeWhenRenderingStateIsCompiled(pipelineContext: IPipelineContext, action: () => void): void;
  136592. createRawShaderProgram(pipelineContext: IPipelineContext, vertexCode: string, fragmentCode: string, context?: WebGLRenderingContext, transformFeedbackVaryings?: Nullable<string[]>): any;
  136593. createShaderProgram(pipelineContext: IPipelineContext, vertexCode: string, fragmentCode: string, defines: Nullable<string>, context?: WebGLRenderingContext, transformFeedbackVaryings?: Nullable<string[]>): any;
  136594. protected _setProgram(program: WebGLProgram): void;
  136595. _releaseEffect(effect: Effect): void;
  136596. _deletePipelineContext(pipelineContext: IPipelineContext): void;
  136597. getUniforms(pipelineContext: IPipelineContext, uniformsNames: string[]): WebGLUniformLocation[];
  136598. bindUniformBlock(pipelineContext: IPipelineContext, blockName: string, index: number): void;
  136599. bindSamplers(effect: Effect): void;
  136600. setMatrix(uniform: WebGLUniformLocation, matrix: Matrix): void;
  136601. getRenderWidth(useScreen?: boolean): number;
  136602. getRenderHeight(useScreen?: boolean): number;
  136603. setViewport(viewport: Viewport, requiredWidth?: number, requiredHeight?: number): void;
  136604. setState(culling: boolean, zOffset?: number, force?: boolean, reverseSide?: boolean): void;
  136605. /**
  136606. * Set the z offset to apply to current rendering
  136607. * @param value defines the offset to apply
  136608. */
  136609. setZOffset(value: number): void;
  136610. /**
  136611. * Gets the current value of the zOffset
  136612. * @returns the current zOffset state
  136613. */
  136614. getZOffset(): number;
  136615. /**
  136616. * Enable or disable depth buffering
  136617. * @param enable defines the state to set
  136618. */
  136619. setDepthBuffer(enable: boolean): void;
  136620. /**
  136621. * Gets a boolean indicating if depth writing is enabled
  136622. * @returns the current depth writing state
  136623. */
  136624. getDepthWrite(): boolean;
  136625. setDepthFunctionToGreater(): void;
  136626. setDepthFunctionToGreaterOrEqual(): void;
  136627. setDepthFunctionToLess(): void;
  136628. setDepthFunctionToLessOrEqual(): void;
  136629. /**
  136630. * Enable or disable depth writing
  136631. * @param enable defines the state to set
  136632. */
  136633. setDepthWrite(enable: boolean): void;
  136634. /**
  136635. * Enable or disable color writing
  136636. * @param enable defines the state to set
  136637. */
  136638. setColorWrite(enable: boolean): void;
  136639. /**
  136640. * Gets a boolean indicating if color writing is enabled
  136641. * @returns the current color writing state
  136642. */
  136643. getColorWrite(): boolean;
  136644. /**
  136645. * Sets alpha constants used by some alpha blending modes
  136646. * @param r defines the red component
  136647. * @param g defines the green component
  136648. * @param b defines the blue component
  136649. * @param a defines the alpha component
  136650. */
  136651. setAlphaConstants(r: number, g: number, b: number, a: number): void;
  136652. /**
  136653. * Sets the current alpha mode
  136654. * @param mode defines the mode to use (one of the BABYLON.Constants.ALPHA_XXX)
  136655. * @param noDepthWriteChange defines if depth writing state should remains unchanged (false by default)
  136656. * @see https://doc.babylonjs.com/resources/transparency_and_how_meshes_are_rendered
  136657. */
  136658. setAlphaMode(mode: number, noDepthWriteChange?: boolean): void;
  136659. /**
  136660. * Gets the current alpha mode
  136661. * @see https://doc.babylonjs.com/resources/transparency_and_how_meshes_are_rendered
  136662. * @returns the current alpha mode
  136663. */
  136664. getAlphaMode(): number;
  136665. setInt(uniform: WebGLUniformLocation, int: number): boolean;
  136666. setIntArray(uniform: WebGLUniformLocation, array: Int32Array): boolean;
  136667. setIntArray2(uniform: WebGLUniformLocation, array: Int32Array): boolean;
  136668. setIntArray3(uniform: WebGLUniformLocation, array: Int32Array): boolean;
  136669. setIntArray4(uniform: WebGLUniformLocation, array: Int32Array): boolean;
  136670. setFloatArray(uniform: WebGLUniformLocation, array: Float32Array): boolean;
  136671. setFloatArray2(uniform: WebGLUniformLocation, array: Float32Array): boolean;
  136672. setFloatArray3(uniform: WebGLUniformLocation, array: Float32Array): boolean;
  136673. setFloatArray4(uniform: WebGLUniformLocation, array: Float32Array): boolean;
  136674. setArray(uniform: WebGLUniformLocation, array: number[]): boolean;
  136675. setArray2(uniform: WebGLUniformLocation, array: number[]): boolean;
  136676. setArray3(uniform: WebGLUniformLocation, array: number[]): boolean;
  136677. setArray4(uniform: WebGLUniformLocation, array: number[]): boolean;
  136678. setMatrices(uniform: WebGLUniformLocation, matrices: Float32Array): boolean;
  136679. setMatrix3x3(uniform: WebGLUniformLocation, matrix: Float32Array): boolean;
  136680. setMatrix2x2(uniform: WebGLUniformLocation, matrix: Float32Array): boolean;
  136681. setFloat(uniform: WebGLUniformLocation, value: number): boolean;
  136682. setFloat2(uniform: WebGLUniformLocation, x: number, y: number): boolean;
  136683. setFloat3(uniform: WebGLUniformLocation, x: number, y: number, z: number): boolean;
  136684. setFloat4(uniform: WebGLUniformLocation, x: number, y: number, z: number, w: number): boolean;
  136685. setColor3(uniform: WebGLUniformLocation, color3: Color3): boolean;
  136686. setColor4(uniform: WebGLUniformLocation, color3: Color3, alpha: number): boolean;
  136687. wipeCaches(bruteForce?: boolean): void;
  136688. _createTexture(): WebGLTexture;
  136689. protected _deleteTexture(texture: Nullable<WebGLTexture>): void;
  136690. /**
  136691. * Update the content of a dynamic texture
  136692. * @param texture defines the texture to update
  136693. * @param canvas defines the canvas containing the source
  136694. * @param invertY defines if data must be stored with Y axis inverted
  136695. * @param premulAlpha defines if alpha is stored as premultiplied
  136696. * @param format defines the format of the data
  136697. * @param forceBindTexture if the texture should be forced to be bound eg. after a graphics context loss (Default: false)
  136698. */
  136699. updateDynamicTexture(texture: Nullable<InternalTexture>, canvas: HTMLCanvasElement, invertY: boolean, premulAlpha?: boolean, format?: number): void;
  136700. /**
  136701. * Usually called from Texture.ts.
  136702. * Passed information to create a WebGLTexture
  136703. * @param url defines a value which contains one of the following:
  136704. * * A conventional http URL, e.g. 'http://...' or 'file://...'
  136705. * * A base64 string of in-line texture data, e.g. 'data:image/jpg;base64,/...'
  136706. * * An indicator that data being passed using the buffer parameter, e.g. 'data:mytexture.jpg'
  136707. * @param noMipmap defines a boolean indicating that no mipmaps shall be generated. Ignored for compressed textures. They must be in the file
  136708. * @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)
  136709. * @param scene needed for loading to the correct scene
  136710. * @param samplingMode mode with should be used sample / access the texture (Default: Texture.TRILINEAR_SAMPLINGMODE)
  136711. * @param onLoad optional callback to be called upon successful completion
  136712. * @param onError optional callback to be called upon failure
  136713. * @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
  136714. * @param fallback an internal argument in case the function must be called again, due to etc1 not having alpha capabilities
  136715. * @param format internal format. Default: RGB when extension is '.jpg' else RGBA. Ignored for compressed textures
  136716. * @param forcedExtension defines the extension to use to pick the right loader
  136717. * @param mimeType defines an optional mime type
  136718. * @returns a InternalTexture for assignment back into BABYLON.Texture
  136719. */
  136720. 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;
  136721. _createDepthStencilTexture(size: RenderTargetTextureSize, options: DepthTextureCreationOptions): NativeTexture;
  136722. _releaseFramebufferObjects(texture: InternalTexture): void;
  136723. /**
  136724. * Creates a cube texture
  136725. * @param rootUrl defines the url where the files to load is located
  136726. * @param scene defines the current scene
  136727. * @param files defines the list of files to load (1 per face)
  136728. * @param noMipmap defines a boolean indicating that no mipmaps shall be generated (false by default)
  136729. * @param onLoad defines an optional callback raised when the texture is loaded
  136730. * @param onError defines an optional callback raised if there is an issue to load the texture
  136731. * @param format defines the format of the data
  136732. * @param forcedExtension defines the extension to use to pick the right loader
  136733. * @param createPolynomials if a polynomial sphere should be created for the cube texture
  136734. * @param lodScale defines the scale applied to environment texture. This manages the range of LOD level used for IBL according to the roughness
  136735. * @param lodOffset defines the offset applied to environment texture. This manages first LOD level used for IBL according to the roughness
  136736. * @param fallback defines texture to use while falling back when (compressed) texture file not found.
  136737. * @returns the cube texture as an InternalTexture
  136738. */
  136739. 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;
  136740. createRenderTargetTexture(size: number | {
  136741. width: number;
  136742. height: number;
  136743. }, options: boolean | RenderTargetCreationOptions): NativeTexture;
  136744. updateTextureSamplingMode(samplingMode: number, texture: InternalTexture): void;
  136745. bindFramebuffer(texture: InternalTexture, faceIndex?: number, requiredWidth?: number, requiredHeight?: number, forceFullscreenViewport?: boolean): void;
  136746. unBindFramebuffer(texture: InternalTexture, disableGenerateMipMaps?: boolean, onBeforeUnbind?: () => void): void;
  136747. createDynamicVertexBuffer(data: DataArray): DataBuffer;
  136748. updateDynamicIndexBuffer(indexBuffer: DataBuffer, indices: IndicesArray, offset?: number): void;
  136749. /**
  136750. * Updates a dynamic vertex buffer.
  136751. * @param vertexBuffer the vertex buffer to update
  136752. * @param data the data used to update the vertex buffer
  136753. * @param byteOffset the byte offset of the data (optional)
  136754. * @param byteLength the byte length of the data (optional)
  136755. */
  136756. updateDynamicVertexBuffer(vertexBuffer: DataBuffer, data: DataArray, byteOffset?: number, byteLength?: number): void;
  136757. protected _setTexture(channel: number, texture: Nullable<BaseTexture>, isPartOfTextureArray?: boolean, depthStencilTexture?: boolean): boolean;
  136758. private _updateAnisotropicLevel;
  136759. private _getAddressMode;
  136760. /** @hidden */
  136761. _bindTexture(channel: number, texture: InternalTexture): void;
  136762. protected _deleteBuffer(buffer: NativeDataBuffer): void;
  136763. releaseEffects(): void;
  136764. /** @hidden */
  136765. _uploadCompressedDataToTextureDirectly(texture: InternalTexture, internalFormat: number, width: number, height: number, data: ArrayBufferView, faceIndex?: number, lod?: number): void;
  136766. /** @hidden */
  136767. _uploadDataToTextureDirectly(texture: InternalTexture, imageData: ArrayBufferView, faceIndex?: number, lod?: number): void;
  136768. /** @hidden */
  136769. _uploadArrayBufferViewToTexture(texture: InternalTexture, imageData: ArrayBufferView, faceIndex?: number, lod?: number): void;
  136770. /** @hidden */
  136771. _uploadImageToTexture(texture: InternalTexture, image: HTMLImageElement, faceIndex?: number, lod?: number): void;
  136772. private _getNativeSamplingMode;
  136773. private _getNativeTextureFormat;
  136774. private _getNativeAlphaMode;
  136775. private _getNativeAttribType;
  136776. }
  136777. }
  136778. declare module BABYLON {
  136779. /**
  136780. * Gather the list of clipboard event types as constants.
  136781. */
  136782. export class ClipboardEventTypes {
  136783. /**
  136784. * The clipboard event is fired when a copy command is active (pressed).
  136785. */
  136786. static readonly COPY: number;
  136787. /**
  136788. * The clipboard event is fired when a cut command is active (pressed).
  136789. */
  136790. static readonly CUT: number;
  136791. /**
  136792. * The clipboard event is fired when a paste command is active (pressed).
  136793. */
  136794. static readonly PASTE: number;
  136795. }
  136796. /**
  136797. * This class is used to store clipboard related info for the onClipboardObservable event.
  136798. */
  136799. export class ClipboardInfo {
  136800. /**
  136801. * Defines the type of event (BABYLON.ClipboardEventTypes)
  136802. */
  136803. type: number;
  136804. /**
  136805. * Defines the related dom event
  136806. */
  136807. event: ClipboardEvent;
  136808. /**
  136809. *Creates an instance of ClipboardInfo.
  136810. * @param type Defines the type of event (BABYLON.ClipboardEventTypes)
  136811. * @param event Defines the related dom event
  136812. */
  136813. constructor(
  136814. /**
  136815. * Defines the type of event (BABYLON.ClipboardEventTypes)
  136816. */
  136817. type: number,
  136818. /**
  136819. * Defines the related dom event
  136820. */
  136821. event: ClipboardEvent);
  136822. /**
  136823. * Get the clipboard event's type from the keycode.
  136824. * @param keyCode Defines the keyCode for the current keyboard event.
  136825. * @return {number}
  136826. */
  136827. static GetTypeFromCharacter(keyCode: number): number;
  136828. }
  136829. }
  136830. declare module BABYLON {
  136831. /**
  136832. * Google Daydream controller
  136833. */
  136834. export class DaydreamController extends WebVRController {
  136835. /**
  136836. * Base Url for the controller model.
  136837. */
  136838. static MODEL_BASE_URL: string;
  136839. /**
  136840. * File name for the controller model.
  136841. */
  136842. static MODEL_FILENAME: string;
  136843. /**
  136844. * Gamepad Id prefix used to identify Daydream Controller.
  136845. */
  136846. static readonly GAMEPAD_ID_PREFIX: string;
  136847. /**
  136848. * Creates a new DaydreamController from a gamepad
  136849. * @param vrGamepad the gamepad that the controller should be created from
  136850. */
  136851. constructor(vrGamepad: any);
  136852. /**
  136853. * Implements abstract method on WebVRController class, loading controller meshes and calling this.attachToMesh if successful.
  136854. * @param scene scene in which to add meshes
  136855. * @param meshLoaded optional callback function that will be called if the mesh loads successfully.
  136856. */
  136857. initControllerMesh(scene: Scene, meshLoaded?: (mesh: AbstractMesh) => void): void;
  136858. /**
  136859. * Called once for each button that changed state since the last frame
  136860. * @param buttonIdx Which button index changed
  136861. * @param state New state of the button
  136862. * @param changes Which properties on the state changed since last frame
  136863. */
  136864. protected _handleButtonChange(buttonIdx: number, state: ExtendedGamepadButton, changes: GamepadButtonChanges): void;
  136865. }
  136866. }
  136867. declare module BABYLON {
  136868. /**
  136869. * Gear VR Controller
  136870. */
  136871. export class GearVRController extends WebVRController {
  136872. /**
  136873. * Base Url for the controller model.
  136874. */
  136875. static MODEL_BASE_URL: string;
  136876. /**
  136877. * File name for the controller model.
  136878. */
  136879. static MODEL_FILENAME: string;
  136880. /**
  136881. * Gamepad Id prefix used to identify this controller.
  136882. */
  136883. static readonly GAMEPAD_ID_PREFIX: string;
  136884. private readonly _buttonIndexToObservableNameMap;
  136885. /**
  136886. * Creates a new GearVRController from a gamepad
  136887. * @param vrGamepad the gamepad that the controller should be created from
  136888. */
  136889. constructor(vrGamepad: any);
  136890. /**
  136891. * Implements abstract method on WebVRController class, loading controller meshes and calling this.attachToMesh if successful.
  136892. * @param scene scene in which to add meshes
  136893. * @param meshLoaded optional callback function that will be called if the mesh loads successfully.
  136894. */
  136895. initControllerMesh(scene: Scene, meshLoaded?: (mesh: AbstractMesh) => void): void;
  136896. /**
  136897. * Called once for each button that changed state since the last frame
  136898. * @param buttonIdx Which button index changed
  136899. * @param state New state of the button
  136900. * @param changes Which properties on the state changed since last frame
  136901. */
  136902. protected _handleButtonChange(buttonIdx: number, state: ExtendedGamepadButton, changes: GamepadButtonChanges): void;
  136903. }
  136904. }
  136905. declare module BABYLON {
  136906. /**
  136907. * Generic Controller
  136908. */
  136909. export class GenericController extends WebVRController {
  136910. /**
  136911. * Base Url for the controller model.
  136912. */
  136913. static readonly MODEL_BASE_URL: string;
  136914. /**
  136915. * File name for the controller model.
  136916. */
  136917. static readonly MODEL_FILENAME: string;
  136918. /**
  136919. * Creates a new GenericController from a gamepad
  136920. * @param vrGamepad the gamepad that the controller should be created from
  136921. */
  136922. constructor(vrGamepad: any);
  136923. /**
  136924. * Implements abstract method on WebVRController class, loading controller meshes and calling this.attachToMesh if successful.
  136925. * @param scene scene in which to add meshes
  136926. * @param meshLoaded optional callback function that will be called if the mesh loads successfully.
  136927. */
  136928. initControllerMesh(scene: Scene, meshLoaded?: (mesh: AbstractMesh) => void): void;
  136929. /**
  136930. * Called once for each button that changed state since the last frame
  136931. * @param buttonIdx Which button index changed
  136932. * @param state New state of the button
  136933. * @param changes Which properties on the state changed since last frame
  136934. */
  136935. protected _handleButtonChange(buttonIdx: number, state: ExtendedGamepadButton, changes: GamepadButtonChanges): void;
  136936. }
  136937. }
  136938. declare module BABYLON {
  136939. /**
  136940. * Oculus Touch Controller
  136941. */
  136942. export class OculusTouchController extends WebVRController {
  136943. /**
  136944. * Base Url for the controller model.
  136945. */
  136946. static MODEL_BASE_URL: string;
  136947. /**
  136948. * File name for the left controller model.
  136949. */
  136950. static MODEL_LEFT_FILENAME: string;
  136951. /**
  136952. * File name for the right controller model.
  136953. */
  136954. static MODEL_RIGHT_FILENAME: string;
  136955. /**
  136956. * Base Url for the Quest controller model.
  136957. */
  136958. static QUEST_MODEL_BASE_URL: string;
  136959. /**
  136960. * @hidden
  136961. * If the controllers are running on a device that needs the updated Quest controller models
  136962. */
  136963. static _IsQuest: boolean;
  136964. /**
  136965. * Fired when the secondary trigger on this controller is modified
  136966. */
  136967. onSecondaryTriggerStateChangedObservable: Observable<ExtendedGamepadButton>;
  136968. /**
  136969. * Fired when the thumb rest on this controller is modified
  136970. */
  136971. onThumbRestChangedObservable: Observable<ExtendedGamepadButton>;
  136972. /**
  136973. * Creates a new OculusTouchController from a gamepad
  136974. * @param vrGamepad the gamepad that the controller should be created from
  136975. */
  136976. constructor(vrGamepad: any);
  136977. /**
  136978. * Implements abstract method on WebVRController class, loading controller meshes and calling this.attachToMesh if successful.
  136979. * @param scene scene in which to add meshes
  136980. * @param meshLoaded optional callback function that will be called if the mesh loads successfully.
  136981. */
  136982. initControllerMesh(scene: Scene, meshLoaded?: (mesh: AbstractMesh) => void): void;
  136983. /**
  136984. * Fired when the A button on this controller is modified
  136985. */
  136986. get onAButtonStateChangedObservable(): Observable<ExtendedGamepadButton>;
  136987. /**
  136988. * Fired when the B button on this controller is modified
  136989. */
  136990. get onBButtonStateChangedObservable(): Observable<ExtendedGamepadButton>;
  136991. /**
  136992. * Fired when the X button on this controller is modified
  136993. */
  136994. get onXButtonStateChangedObservable(): Observable<ExtendedGamepadButton>;
  136995. /**
  136996. * Fired when the Y button on this controller is modified
  136997. */
  136998. get onYButtonStateChangedObservable(): Observable<ExtendedGamepadButton>;
  136999. /**
  137000. * Called once for each button that changed state since the last frame
  137001. * 0) thumb stick (touch, press, value = pressed (0,1)). value is in this.leftStick
  137002. * 1) index trigger (touch (?), press (only when value > 0.1), value 0 to 1)
  137003. * 2) secondary trigger (same)
  137004. * 3) A (right) X (left), touch, pressed = value
  137005. * 4) B / Y
  137006. * 5) thumb rest
  137007. * @param buttonIdx Which button index changed
  137008. * @param state New state of the button
  137009. * @param changes Which properties on the state changed since last frame
  137010. */
  137011. protected _handleButtonChange(buttonIdx: number, state: ExtendedGamepadButton, changes: GamepadButtonChanges): void;
  137012. }
  137013. }
  137014. declare module BABYLON {
  137015. /**
  137016. * Vive Controller
  137017. */
  137018. export class ViveController extends WebVRController {
  137019. /**
  137020. * Base Url for the controller model.
  137021. */
  137022. static MODEL_BASE_URL: string;
  137023. /**
  137024. * File name for the controller model.
  137025. */
  137026. static MODEL_FILENAME: string;
  137027. /**
  137028. * Creates a new ViveController from a gamepad
  137029. * @param vrGamepad the gamepad that the controller should be created from
  137030. */
  137031. constructor(vrGamepad: any);
  137032. /**
  137033. * Implements abstract method on WebVRController class, loading controller meshes and calling this.attachToMesh if successful.
  137034. * @param scene scene in which to add meshes
  137035. * @param meshLoaded optional callback function that will be called if the mesh loads successfully.
  137036. */
  137037. initControllerMesh(scene: Scene, meshLoaded?: (mesh: AbstractMesh) => void): void;
  137038. /**
  137039. * Fired when the left button on this controller is modified
  137040. */
  137041. get onLeftButtonStateChangedObservable(): Observable<ExtendedGamepadButton>;
  137042. /**
  137043. * Fired when the right button on this controller is modified
  137044. */
  137045. get onRightButtonStateChangedObservable(): Observable<ExtendedGamepadButton>;
  137046. /**
  137047. * Fired when the menu button on this controller is modified
  137048. */
  137049. get onMenuButtonStateChangedObservable(): Observable<ExtendedGamepadButton>;
  137050. /**
  137051. * Called once for each button that changed state since the last frame
  137052. * Vive mapping:
  137053. * 0: touchpad
  137054. * 1: trigger
  137055. * 2: left AND right buttons
  137056. * 3: menu button
  137057. * @param buttonIdx Which button index changed
  137058. * @param state New state of the button
  137059. * @param changes Which properties on the state changed since last frame
  137060. */
  137061. protected _handleButtonChange(buttonIdx: number, state: ExtendedGamepadButton, changes: GamepadButtonChanges): void;
  137062. }
  137063. }
  137064. declare module BABYLON {
  137065. /**
  137066. * Defines the WindowsMotionController object that the state of the windows motion controller
  137067. */
  137068. export class WindowsMotionController extends WebVRController {
  137069. /**
  137070. * The base url used to load the left and right controller models
  137071. */
  137072. static MODEL_BASE_URL: string;
  137073. /**
  137074. * The name of the left controller model file
  137075. */
  137076. static MODEL_LEFT_FILENAME: string;
  137077. /**
  137078. * The name of the right controller model file
  137079. */
  137080. static MODEL_RIGHT_FILENAME: string;
  137081. /**
  137082. * The controller name prefix for this controller type
  137083. */
  137084. static readonly GAMEPAD_ID_PREFIX: string;
  137085. /**
  137086. * The controller id pattern for this controller type
  137087. */
  137088. private static readonly GAMEPAD_ID_PATTERN;
  137089. private _loadedMeshInfo;
  137090. protected readonly _mapping: {
  137091. buttons: string[];
  137092. buttonMeshNames: {
  137093. trigger: string;
  137094. menu: string;
  137095. grip: string;
  137096. thumbstick: string;
  137097. trackpad: string;
  137098. };
  137099. buttonObservableNames: {
  137100. trigger: string;
  137101. menu: string;
  137102. grip: string;
  137103. thumbstick: string;
  137104. trackpad: string;
  137105. };
  137106. axisMeshNames: string[];
  137107. pointingPoseMeshName: string;
  137108. };
  137109. /**
  137110. * Fired when the trackpad on this controller is clicked
  137111. */
  137112. onTrackpadChangedObservable: Observable<ExtendedGamepadButton>;
  137113. /**
  137114. * Fired when the trackpad on this controller is modified
  137115. */
  137116. onTrackpadValuesChangedObservable: Observable<StickValues>;
  137117. /**
  137118. * The current x and y values of this controller's trackpad
  137119. */
  137120. trackpad: StickValues;
  137121. /**
  137122. * Creates a new WindowsMotionController from a gamepad
  137123. * @param vrGamepad the gamepad that the controller should be created from
  137124. */
  137125. constructor(vrGamepad: any);
  137126. /**
  137127. * Fired when the trigger on this controller is modified
  137128. */
  137129. get onTriggerButtonStateChangedObservable(): Observable<ExtendedGamepadButton>;
  137130. /**
  137131. * Fired when the menu button on this controller is modified
  137132. */
  137133. get onMenuButtonStateChangedObservable(): Observable<ExtendedGamepadButton>;
  137134. /**
  137135. * Fired when the grip button on this controller is modified
  137136. */
  137137. get onGripButtonStateChangedObservable(): Observable<ExtendedGamepadButton>;
  137138. /**
  137139. * Fired when the thumbstick button on this controller is modified
  137140. */
  137141. get onThumbstickButtonStateChangedObservable(): Observable<ExtendedGamepadButton>;
  137142. /**
  137143. * Fired when the touchpad button on this controller is modified
  137144. */
  137145. get onTouchpadButtonStateChangedObservable(): Observable<ExtendedGamepadButton>;
  137146. /**
  137147. * Fired when the touchpad values on this controller are modified
  137148. */
  137149. get onTouchpadValuesChangedObservable(): Observable<StickValues>;
  137150. protected _updateTrackpad(): void;
  137151. /**
  137152. * Called once per frame by the engine.
  137153. */
  137154. update(): void;
  137155. /**
  137156. * Called once for each button that changed state since the last frame
  137157. * @param buttonIdx Which button index changed
  137158. * @param state New state of the button
  137159. * @param changes Which properties on the state changed since last frame
  137160. */
  137161. protected _handleButtonChange(buttonIdx: number, state: ExtendedGamepadButton, changes: GamepadButtonChanges): void;
  137162. /**
  137163. * Moves the buttons on the controller mesh based on their current state
  137164. * @param buttonName the name of the button to move
  137165. * @param buttonValue the value of the button which determines the buttons new position
  137166. */
  137167. protected _lerpButtonTransform(buttonName: string, buttonValue: number): void;
  137168. /**
  137169. * Moves the axis on the controller mesh based on its current state
  137170. * @param axis the index of the axis
  137171. * @param axisValue the value of the axis which determines the meshes new position
  137172. * @hidden
  137173. */
  137174. protected _lerpAxisTransform(axis: number, axisValue: number): void;
  137175. /**
  137176. * Implements abstract method on WebVRController class, loading controller meshes and calling this.attachToMesh if successful.
  137177. * @param scene scene in which to add meshes
  137178. * @param meshLoaded optional callback function that will be called if the mesh loads successfully.
  137179. */
  137180. initControllerMesh(scene: Scene, meshLoaded?: (mesh: AbstractMesh) => void, forceDefault?: boolean): void;
  137181. /**
  137182. * Takes a list of meshes (as loaded from the glTF file) and finds the root node, as well as nodes that
  137183. * can be transformed by button presses and axes values, based on this._mapping.
  137184. *
  137185. * @param scene scene in which the meshes exist
  137186. * @param meshes list of meshes that make up the controller model to process
  137187. * @return structured view of the given meshes, with mapping of buttons and axes to meshes that can be transformed.
  137188. */
  137189. private processModel;
  137190. private createMeshInfo;
  137191. /**
  137192. * Gets the ray of the controller in the direction the controller is pointing
  137193. * @param length the length the resulting ray should be
  137194. * @returns a ray in the direction the controller is pointing
  137195. */
  137196. getForwardRay(length?: number): Ray;
  137197. /**
  137198. * Disposes of the controller
  137199. */
  137200. dispose(): void;
  137201. }
  137202. /**
  137203. * This class represents a new windows motion controller in XR.
  137204. */
  137205. export class XRWindowsMotionController extends WindowsMotionController {
  137206. /**
  137207. * Changing the original WIndowsMotionController mapping to fir the new mapping
  137208. */
  137209. protected readonly _mapping: {
  137210. buttons: string[];
  137211. buttonMeshNames: {
  137212. trigger: string;
  137213. menu: string;
  137214. grip: string;
  137215. thumbstick: string;
  137216. trackpad: string;
  137217. };
  137218. buttonObservableNames: {
  137219. trigger: string;
  137220. menu: string;
  137221. grip: string;
  137222. thumbstick: string;
  137223. trackpad: string;
  137224. };
  137225. axisMeshNames: string[];
  137226. pointingPoseMeshName: string;
  137227. };
  137228. /**
  137229. * Construct a new XR-Based windows motion controller
  137230. *
  137231. * @param gamepadInfo the gamepad object from the browser
  137232. */
  137233. constructor(gamepadInfo: any);
  137234. /**
  137235. * holds the thumbstick values (X,Y)
  137236. */
  137237. thumbstickValues: StickValues;
  137238. /**
  137239. * Fired when the thumbstick on this controller is clicked
  137240. */
  137241. onThumbstickStateChangedObservable: Observable<ExtendedGamepadButton>;
  137242. /**
  137243. * Fired when the thumbstick on this controller is modified
  137244. */
  137245. onThumbstickValuesChangedObservable: Observable<StickValues>;
  137246. /**
  137247. * Fired when the touchpad button on this controller is modified
  137248. */
  137249. onTrackpadChangedObservable: Observable<ExtendedGamepadButton>;
  137250. /**
  137251. * Fired when the touchpad values on this controller are modified
  137252. */
  137253. onTrackpadValuesChangedObservable: Observable<StickValues>;
  137254. /**
  137255. * Fired when the thumbstick button on this controller is modified
  137256. * here to prevent breaking changes
  137257. */
  137258. get onThumbstickButtonStateChangedObservable(): Observable<ExtendedGamepadButton>;
  137259. /**
  137260. * updating the thumbstick(!) and not the trackpad.
  137261. * This is named this way due to the difference between WebVR and XR and to avoid
  137262. * changing the parent class.
  137263. */
  137264. protected _updateTrackpad(): void;
  137265. /**
  137266. * Disposes the class with joy
  137267. */
  137268. dispose(): void;
  137269. }
  137270. }
  137271. declare module BABYLON {
  137272. /**
  137273. * Class containing static functions to help procedurally build meshes
  137274. */
  137275. export class PolyhedronBuilder {
  137276. /**
  137277. * Creates a polyhedron mesh
  137278. * * 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
  137279. * * The parameter `size` (positive float, default 1) sets the polygon size
  137280. * * You can overwrite the `size` on each dimension bu using the parameters `sizeX`, `sizeY` or `sizeZ` (positive floats, default to `size` value)
  137281. * * 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`
  137282. * * 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
  137283. * * 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)`)
  137284. * * 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
  137285. * * 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
  137286. * * You can also set the mesh side orientation with the values : BABYLON.Mesh.FRONTSIDE (default), BABYLON.Mesh.BACKSIDE or BABYLON.Mesh.DOUBLESIDE
  137287. * * If you create a double-sided mesh, you can choose what parts of the texture image to crop and stick respectively on the front and the back sides with the parameters `frontUVs` and `backUVs` (Vector4). Detail here : https://doc.babylonjs.com/babylon101/discover_basic_elements#side-orientation
  137288. * * The mesh can be set to updatable with the boolean parameter `updatable` (default false) if its internal geometry is supposed to change once created
  137289. * @param name defines the name of the mesh
  137290. * @param options defines the options used to create the mesh
  137291. * @param scene defines the hosting scene
  137292. * @returns the polyhedron mesh
  137293. * @see https://doc.babylonjs.com/how_to/polyhedra_shapes
  137294. */
  137295. static CreatePolyhedron(name: string, options: {
  137296. type?: number;
  137297. size?: number;
  137298. sizeX?: number;
  137299. sizeY?: number;
  137300. sizeZ?: number;
  137301. custom?: any;
  137302. faceUV?: Vector4[];
  137303. faceColors?: Color4[];
  137304. flat?: boolean;
  137305. updatable?: boolean;
  137306. sideOrientation?: number;
  137307. frontUVs?: Vector4;
  137308. backUVs?: Vector4;
  137309. }, scene?: Nullable<Scene>): Mesh;
  137310. }
  137311. }
  137312. declare module BABYLON {
  137313. /**
  137314. * Gizmo that enables scaling a mesh along 3 axis
  137315. */
  137316. export class ScaleGizmo extends Gizmo {
  137317. /**
  137318. * Internal gizmo used for interactions on the x axis
  137319. */
  137320. xGizmo: AxisScaleGizmo;
  137321. /**
  137322. * Internal gizmo used for interactions on the y axis
  137323. */
  137324. yGizmo: AxisScaleGizmo;
  137325. /**
  137326. * Internal gizmo used for interactions on the z axis
  137327. */
  137328. zGizmo: AxisScaleGizmo;
  137329. /**
  137330. * Internal gizmo used to scale all axis equally
  137331. */
  137332. uniformScaleGizmo: AxisScaleGizmo;
  137333. private _meshAttached;
  137334. private _nodeAttached;
  137335. private _snapDistance;
  137336. private _uniformScalingMesh;
  137337. private _octahedron;
  137338. private _sensitivity;
  137339. /** Fires an event when any of it's sub gizmos are dragged */
  137340. onDragStartObservable: Observable<unknown>;
  137341. /** Fires an event when any of it's sub gizmos are released from dragging */
  137342. onDragEndObservable: Observable<unknown>;
  137343. get attachedMesh(): Nullable<AbstractMesh>;
  137344. set attachedMesh(mesh: Nullable<AbstractMesh>);
  137345. get attachedNode(): Nullable<Node>;
  137346. set attachedNode(node: Nullable<Node>);
  137347. /**
  137348. * True when the mouse pointer is hovering a gizmo mesh
  137349. */
  137350. get isHovered(): boolean;
  137351. /**
  137352. * Creates a ScaleGizmo
  137353. * @param gizmoLayer The utility layer the gizmo will be added to
  137354. * @param thickness display gizmo axis thickness
  137355. */
  137356. constructor(gizmoLayer?: UtilityLayerRenderer, thickness?: number);
  137357. set updateGizmoRotationToMatchAttachedMesh(value: boolean);
  137358. get updateGizmoRotationToMatchAttachedMesh(): boolean;
  137359. /**
  137360. * Drag distance in babylon units that the gizmo will snap to when dragged (Default: 0)
  137361. */
  137362. set snapDistance(value: number);
  137363. get snapDistance(): number;
  137364. /**
  137365. * Ratio for the scale of the gizmo (Default: 1)
  137366. */
  137367. set scaleRatio(value: number);
  137368. get scaleRatio(): number;
  137369. /**
  137370. * Sensitivity factor for dragging (Default: 1)
  137371. */
  137372. set sensitivity(value: number);
  137373. get sensitivity(): number;
  137374. /**
  137375. * Disposes of the gizmo
  137376. */
  137377. dispose(): void;
  137378. }
  137379. }
  137380. declare module BABYLON {
  137381. /**
  137382. * Single axis scale gizmo
  137383. */
  137384. export class AxisScaleGizmo extends Gizmo {
  137385. /**
  137386. * Drag behavior responsible for the gizmos dragging interactions
  137387. */
  137388. dragBehavior: PointerDragBehavior;
  137389. private _pointerObserver;
  137390. /**
  137391. * Scale distance in babylon units that the gizmo will snap to when dragged (Default: 0)
  137392. */
  137393. snapDistance: number;
  137394. /**
  137395. * Event that fires each time the gizmo snaps to a new location.
  137396. * * snapDistance is the the change in distance
  137397. */
  137398. onSnapObservable: Observable<{
  137399. snapDistance: number;
  137400. }>;
  137401. /**
  137402. * If the scaling operation should be done on all axis (default: false)
  137403. */
  137404. uniformScaling: boolean;
  137405. /**
  137406. * Custom sensitivity value for the drag strength
  137407. */
  137408. sensitivity: number;
  137409. private _isEnabled;
  137410. private _parent;
  137411. private _arrow;
  137412. private _coloredMaterial;
  137413. private _hoverMaterial;
  137414. /**
  137415. * Creates an AxisScaleGizmo
  137416. * @param gizmoLayer The utility layer the gizmo will be added to
  137417. * @param dragAxis The axis which the gizmo will be able to scale on
  137418. * @param color The color of the gizmo
  137419. * @param thickness display gizmo axis thickness
  137420. */
  137421. constructor(dragAxis: Vector3, color?: Color3, gizmoLayer?: UtilityLayerRenderer, parent?: Nullable<ScaleGizmo>, thickness?: number);
  137422. protected _attachedNodeChanged(value: Nullable<Node>): void;
  137423. /**
  137424. * If the gizmo is enabled
  137425. */
  137426. set isEnabled(value: boolean);
  137427. get isEnabled(): boolean;
  137428. /**
  137429. * Disposes of the gizmo
  137430. */
  137431. dispose(): void;
  137432. /**
  137433. * Disposes and replaces the current meshes in the gizmo with the specified mesh
  137434. * @param mesh The mesh to replace the default mesh of the gizmo
  137435. * @param useGizmoMaterial If the gizmo's default material should be used (default: false)
  137436. */
  137437. setCustomMesh(mesh: Mesh, useGizmoMaterial?: boolean): void;
  137438. }
  137439. }
  137440. declare module BABYLON {
  137441. /**
  137442. * Bounding box gizmo
  137443. */
  137444. export class BoundingBoxGizmo extends Gizmo {
  137445. private _lineBoundingBox;
  137446. private _rotateSpheresParent;
  137447. private _scaleBoxesParent;
  137448. private _boundingDimensions;
  137449. private _renderObserver;
  137450. private _pointerObserver;
  137451. private _scaleDragSpeed;
  137452. private _tmpQuaternion;
  137453. private _tmpVector;
  137454. private _tmpRotationMatrix;
  137455. /**
  137456. * 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)
  137457. */
  137458. ignoreChildren: boolean;
  137459. /**
  137460. * 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)
  137461. */
  137462. includeChildPredicate: Nullable<(abstractMesh: AbstractMesh) => boolean>;
  137463. /**
  137464. * The size of the rotation spheres attached to the bounding box (Default: 0.1)
  137465. */
  137466. rotationSphereSize: number;
  137467. /**
  137468. * The size of the scale boxes attached to the bounding box (Default: 0.1)
  137469. */
  137470. scaleBoxSize: number;
  137471. /**
  137472. * 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)
  137473. */
  137474. fixedDragMeshScreenSize: boolean;
  137475. /**
  137476. * The distance away from the object which the draggable meshes should appear world sized when fixedDragMeshScreenSize is set to true (default: 10)
  137477. */
  137478. fixedDragMeshScreenSizeDistanceFactor: number;
  137479. /**
  137480. * Fired when a rotation sphere or scale box is dragged
  137481. */
  137482. onDragStartObservable: Observable<{}>;
  137483. /**
  137484. * Fired when a scale box is dragged
  137485. */
  137486. onScaleBoxDragObservable: Observable<{}>;
  137487. /**
  137488. * Fired when a scale box drag is ended
  137489. */
  137490. onScaleBoxDragEndObservable: Observable<{}>;
  137491. /**
  137492. * Fired when a rotation sphere is dragged
  137493. */
  137494. onRotationSphereDragObservable: Observable<{}>;
  137495. /**
  137496. * Fired when a rotation sphere drag is ended
  137497. */
  137498. onRotationSphereDragEndObservable: Observable<{}>;
  137499. /**
  137500. * 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)
  137501. */
  137502. scalePivot: Nullable<Vector3>;
  137503. /**
  137504. * Mesh used as a pivot to rotate the attached node
  137505. */
  137506. private _anchorMesh;
  137507. private _existingMeshScale;
  137508. private _dragMesh;
  137509. private pointerDragBehavior;
  137510. private coloredMaterial;
  137511. private hoverColoredMaterial;
  137512. /**
  137513. * Sets the color of the bounding box gizmo
  137514. * @param color the color to set
  137515. */
  137516. setColor(color: Color3): void;
  137517. /**
  137518. * Creates an BoundingBoxGizmo
  137519. * @param gizmoLayer The utility layer the gizmo will be added to
  137520. * @param color The color of the gizmo
  137521. */
  137522. constructor(color?: Color3, gizmoLayer?: UtilityLayerRenderer);
  137523. protected _attachedNodeChanged(value: Nullable<AbstractMesh>): void;
  137524. private _selectNode;
  137525. /**
  137526. * Updates the bounding box information for the Gizmo
  137527. */
  137528. updateBoundingBox(): void;
  137529. private _updateRotationSpheres;
  137530. private _updateScaleBoxes;
  137531. /**
  137532. * Enables rotation on the specified axis and disables rotation on the others
  137533. * @param axis The list of axis that should be enabled (eg. "xy" or "xyz")
  137534. */
  137535. setEnabledRotationAxis(axis: string): void;
  137536. /**
  137537. * Enables/disables scaling
  137538. * @param enable if scaling should be enabled
  137539. * @param homogeneousScaling defines if scaling should only be homogeneous
  137540. */
  137541. setEnabledScaling(enable: boolean, homogeneousScaling?: boolean): void;
  137542. private _updateDummy;
  137543. /**
  137544. * Enables a pointer drag behavior on the bounding box of the gizmo
  137545. */
  137546. enableDragBehavior(): void;
  137547. /**
  137548. * Disposes of the gizmo
  137549. */
  137550. dispose(): void;
  137551. /**
  137552. * 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)
  137553. * @param mesh the mesh to wrap in the bounding box mesh and make not pickable
  137554. * @returns the bounding box mesh with the passed in mesh as a child
  137555. */
  137556. static MakeNotPickableAndWrapInBoundingBox(mesh: Mesh): Mesh;
  137557. /**
  137558. * CustomMeshes are not supported by this gizmo
  137559. * @param mesh The mesh to replace the default mesh of the gizmo
  137560. */
  137561. setCustomMesh(mesh: Mesh): void;
  137562. }
  137563. }
  137564. declare module BABYLON {
  137565. /**
  137566. * Single plane rotation gizmo
  137567. */
  137568. export class PlaneRotationGizmo extends Gizmo {
  137569. /**
  137570. * Drag behavior responsible for the gizmos dragging interactions
  137571. */
  137572. dragBehavior: PointerDragBehavior;
  137573. private _pointerObserver;
  137574. /**
  137575. * Rotation distance in radians that the gizmo will snap to (Default: 0)
  137576. */
  137577. snapDistance: number;
  137578. /**
  137579. * Event that fires each time the gizmo snaps to a new location.
  137580. * * snapDistance is the the change in distance
  137581. */
  137582. onSnapObservable: Observable<{
  137583. snapDistance: number;
  137584. }>;
  137585. private _isEnabled;
  137586. private _parent;
  137587. /**
  137588. * Creates a PlaneRotationGizmo
  137589. * @param gizmoLayer The utility layer the gizmo will be added to
  137590. * @param planeNormal The normal of the plane which the gizmo will be able to rotate on
  137591. * @param color The color of the gizmo
  137592. * @param tessellation Amount of tessellation to be used when creating rotation circles
  137593. * @param useEulerRotation Use and update Euler angle instead of quaternion
  137594. * @param thickness display gizmo axis thickness
  137595. */
  137596. constructor(planeNormal: Vector3, color?: Color3, gizmoLayer?: UtilityLayerRenderer, tessellation?: number, parent?: Nullable<RotationGizmo>, useEulerRotation?: boolean, thickness?: number);
  137597. protected _attachedNodeChanged(value: Nullable<Node>): void;
  137598. /**
  137599. * If the gizmo is enabled
  137600. */
  137601. set isEnabled(value: boolean);
  137602. get isEnabled(): boolean;
  137603. /**
  137604. * Disposes of the gizmo
  137605. */
  137606. dispose(): void;
  137607. }
  137608. }
  137609. declare module BABYLON {
  137610. /**
  137611. * Gizmo that enables rotating a mesh along 3 axis
  137612. */
  137613. export class RotationGizmo extends Gizmo {
  137614. /**
  137615. * Internal gizmo used for interactions on the x axis
  137616. */
  137617. xGizmo: PlaneRotationGizmo;
  137618. /**
  137619. * Internal gizmo used for interactions on the y axis
  137620. */
  137621. yGizmo: PlaneRotationGizmo;
  137622. /**
  137623. * Internal gizmo used for interactions on the z axis
  137624. */
  137625. zGizmo: PlaneRotationGizmo;
  137626. /** Fires an event when any of it's sub gizmos are dragged */
  137627. onDragStartObservable: Observable<unknown>;
  137628. /** Fires an event when any of it's sub gizmos are released from dragging */
  137629. onDragEndObservable: Observable<unknown>;
  137630. private _meshAttached;
  137631. private _nodeAttached;
  137632. get attachedMesh(): Nullable<AbstractMesh>;
  137633. set attachedMesh(mesh: Nullable<AbstractMesh>);
  137634. get attachedNode(): Nullable<Node>;
  137635. set attachedNode(node: Nullable<Node>);
  137636. protected _checkBillboardTransform(): void;
  137637. /**
  137638. * True when the mouse pointer is hovering a gizmo mesh
  137639. */
  137640. get isHovered(): boolean;
  137641. /**
  137642. * Creates a RotationGizmo
  137643. * @param gizmoLayer The utility layer the gizmo will be added to
  137644. * @param tessellation Amount of tessellation to be used when creating rotation circles
  137645. * @param useEulerRotation Use and update Euler angle instead of quaternion
  137646. * @param thickness display gizmo axis thickness
  137647. */
  137648. constructor(gizmoLayer?: UtilityLayerRenderer, tessellation?: number, useEulerRotation?: boolean, thickness?: number);
  137649. set updateGizmoRotationToMatchAttachedMesh(value: boolean);
  137650. get updateGizmoRotationToMatchAttachedMesh(): boolean;
  137651. /**
  137652. * Drag distance in babylon units that the gizmo will snap to when dragged (Default: 0)
  137653. */
  137654. set snapDistance(value: number);
  137655. get snapDistance(): number;
  137656. /**
  137657. * Ratio for the scale of the gizmo (Default: 1)
  137658. */
  137659. set scaleRatio(value: number);
  137660. get scaleRatio(): number;
  137661. /**
  137662. * Disposes of the gizmo
  137663. */
  137664. dispose(): void;
  137665. /**
  137666. * CustomMeshes are not supported by this gizmo
  137667. * @param mesh The mesh to replace the default mesh of the gizmo
  137668. */
  137669. setCustomMesh(mesh: Mesh): void;
  137670. }
  137671. }
  137672. declare module BABYLON {
  137673. /**
  137674. * Helps setup gizmo's in the scene to rotate/scale/position nodes
  137675. */
  137676. export class GizmoManager implements IDisposable {
  137677. private scene;
  137678. /**
  137679. * Gizmo's created by the gizmo manager, gizmo will be null until gizmo has been enabled for the first time
  137680. */
  137681. gizmos: {
  137682. positionGizmo: Nullable<PositionGizmo>;
  137683. rotationGizmo: Nullable<RotationGizmo>;
  137684. scaleGizmo: Nullable<ScaleGizmo>;
  137685. boundingBoxGizmo: Nullable<BoundingBoxGizmo>;
  137686. };
  137687. /** When true, the gizmo will be detached from the current object when a pointer down occurs with an empty picked mesh */
  137688. clearGizmoOnEmptyPointerEvent: boolean;
  137689. /** Fires an event when the manager is attached to a mesh */
  137690. onAttachedToMeshObservable: Observable<Nullable<AbstractMesh>>;
  137691. /** Fires an event when the manager is attached to a node */
  137692. onAttachedToNodeObservable: Observable<Nullable<Node>>;
  137693. private _gizmosEnabled;
  137694. private _pointerObserver;
  137695. private _attachedMesh;
  137696. private _attachedNode;
  137697. private _boundingBoxColor;
  137698. private _defaultUtilityLayer;
  137699. private _defaultKeepDepthUtilityLayer;
  137700. private _thickness;
  137701. /**
  137702. * When bounding box gizmo is enabled, this can be used to track drag/end events
  137703. */
  137704. boundingBoxDragBehavior: SixDofDragBehavior;
  137705. /**
  137706. * Array of meshes which will have the gizmo attached when a pointer selected them. If null, all meshes are attachable. (Default: null)
  137707. */
  137708. attachableMeshes: Nullable<Array<AbstractMesh>>;
  137709. /**
  137710. * Array of nodes which will have the gizmo attached when a pointer selected them. If null, all nodes are attachable. (Default: null)
  137711. */
  137712. attachableNodes: Nullable<Array<Node>>;
  137713. /**
  137714. * If pointer events should perform attaching/detaching a gizmo, if false this can be done manually via attachToMesh/attachToNode. (Default: true)
  137715. */
  137716. usePointerToAttachGizmos: boolean;
  137717. /**
  137718. * Utility layer that the bounding box gizmo belongs to
  137719. */
  137720. get keepDepthUtilityLayer(): UtilityLayerRenderer;
  137721. /**
  137722. * Utility layer that all gizmos besides bounding box belong to
  137723. */
  137724. get utilityLayer(): UtilityLayerRenderer;
  137725. /**
  137726. * True when the mouse pointer is hovering a gizmo mesh
  137727. */
  137728. get isHovered(): boolean;
  137729. /**
  137730. * Instatiates a gizmo manager
  137731. * @param scene the scene to overlay the gizmos on top of
  137732. * @param thickness display gizmo axis thickness
  137733. */
  137734. constructor(scene: Scene, thickness?: number);
  137735. /**
  137736. * Attaches a set of gizmos to the specified mesh
  137737. * @param mesh The mesh the gizmo's should be attached to
  137738. */
  137739. attachToMesh(mesh: Nullable<AbstractMesh>): void;
  137740. /**
  137741. * Attaches a set of gizmos to the specified node
  137742. * @param node The node the gizmo's should be attached to
  137743. */
  137744. attachToNode(node: Nullable<Node>): void;
  137745. /**
  137746. * If the position gizmo is enabled
  137747. */
  137748. set positionGizmoEnabled(value: boolean);
  137749. get positionGizmoEnabled(): boolean;
  137750. /**
  137751. * If the rotation gizmo is enabled
  137752. */
  137753. set rotationGizmoEnabled(value: boolean);
  137754. get rotationGizmoEnabled(): boolean;
  137755. /**
  137756. * If the scale gizmo is enabled
  137757. */
  137758. set scaleGizmoEnabled(value: boolean);
  137759. get scaleGizmoEnabled(): boolean;
  137760. /**
  137761. * If the boundingBox gizmo is enabled
  137762. */
  137763. set boundingBoxGizmoEnabled(value: boolean);
  137764. get boundingBoxGizmoEnabled(): boolean;
  137765. /**
  137766. * Disposes of the gizmo manager
  137767. */
  137768. dispose(): void;
  137769. }
  137770. }
  137771. declare module BABYLON {
  137772. /**
  137773. * A directional light is defined by a direction (what a surprise!).
  137774. * The light is emitted from everywhere in the specified direction, and has an infinite range.
  137775. * 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.
  137776. * Documentation: https://doc.babylonjs.com/babylon101/lights
  137777. */
  137778. export class DirectionalLight extends ShadowLight {
  137779. private _shadowFrustumSize;
  137780. /**
  137781. * Fix frustum size for the shadow generation. This is disabled if the value is 0.
  137782. */
  137783. get shadowFrustumSize(): number;
  137784. /**
  137785. * Specifies a fix frustum size for the shadow generation.
  137786. */
  137787. set shadowFrustumSize(value: number);
  137788. private _shadowOrthoScale;
  137789. /**
  137790. * Gets the shadow projection scale against the optimal computed one.
  137791. * 0.1 by default which means that the projection window is increase by 10% from the optimal size.
  137792. * This does not impact in fixed frustum size (shadowFrustumSize being set)
  137793. */
  137794. get shadowOrthoScale(): number;
  137795. /**
  137796. * Sets the shadow projection scale against the optimal computed one.
  137797. * 0.1 by default which means that the projection window is increase by 10% from the optimal size.
  137798. * This does not impact in fixed frustum size (shadowFrustumSize being set)
  137799. */
  137800. set shadowOrthoScale(value: number);
  137801. /**
  137802. * Automatically compute the projection matrix to best fit (including all the casters)
  137803. * on each frame.
  137804. */
  137805. autoUpdateExtends: boolean;
  137806. /**
  137807. * Automatically compute the shadowMinZ and shadowMaxZ for the projection matrix to best fit (including all the casters)
  137808. * on each frame. autoUpdateExtends must be set to true for this to work
  137809. */
  137810. autoCalcShadowZBounds: boolean;
  137811. private _orthoLeft;
  137812. private _orthoRight;
  137813. private _orthoTop;
  137814. private _orthoBottom;
  137815. /**
  137816. * Creates a DirectionalLight object in the scene, oriented towards the passed direction (Vector3).
  137817. * The directional light is emitted from everywhere in the given direction.
  137818. * It can cast shadows.
  137819. * Documentation : https://doc.babylonjs.com/babylon101/lights
  137820. * @param name The friendly name of the light
  137821. * @param direction The direction of the light
  137822. * @param scene The scene the light belongs to
  137823. */
  137824. constructor(name: string, direction: Vector3, scene: Scene);
  137825. /**
  137826. * Returns the string "DirectionalLight".
  137827. * @return The class name
  137828. */
  137829. getClassName(): string;
  137830. /**
  137831. * Returns the integer 1.
  137832. * @return The light Type id as a constant defines in Light.LIGHTTYPEID_x
  137833. */
  137834. getTypeID(): number;
  137835. /**
  137836. * Sets the passed matrix "matrix" as projection matrix for the shadows cast by the light according to the passed view matrix.
  137837. * Returns the DirectionalLight Shadow projection matrix.
  137838. */
  137839. protected _setDefaultShadowProjectionMatrix(matrix: Matrix, viewMatrix: Matrix, renderList: Array<AbstractMesh>): void;
  137840. /**
  137841. * Sets the passed matrix "matrix" as fixed frustum projection matrix for the shadows cast by the light according to the passed view matrix.
  137842. * Returns the DirectionalLight Shadow projection matrix.
  137843. */
  137844. protected _setDefaultFixedFrustumShadowProjectionMatrix(matrix: Matrix): void;
  137845. /**
  137846. * Sets the passed matrix "matrix" as auto extend projection matrix for the shadows cast by the light according to the passed view matrix.
  137847. * Returns the DirectionalLight Shadow projection matrix.
  137848. */
  137849. protected _setDefaultAutoExtendShadowProjectionMatrix(matrix: Matrix, viewMatrix: Matrix, renderList: Array<AbstractMesh>): void;
  137850. protected _buildUniformLayout(): void;
  137851. /**
  137852. * Sets the passed Effect object with the DirectionalLight transformed position (or position if not parented) and the passed name.
  137853. * @param effect The effect to update
  137854. * @param lightIndex The index of the light in the effect to update
  137855. * @returns The directional light
  137856. */
  137857. transferToEffect(effect: Effect, lightIndex: string): DirectionalLight;
  137858. transferToNodeMaterialEffect(effect: Effect, lightDataUniformName: string): Light;
  137859. /**
  137860. * Gets the minZ used for shadow according to both the scene and the light.
  137861. *
  137862. * Values are fixed on directional lights as it relies on an ortho projection hence the need to convert being
  137863. * -1 and 1 to 0 and 1 doing (depth + min) / (min + max) -> (depth + 1) / (1 + 1) -> (depth * 0.5) + 0.5.
  137864. * @param activeCamera The camera we are returning the min for
  137865. * @returns the depth min z
  137866. */
  137867. getDepthMinZ(activeCamera: Camera): number;
  137868. /**
  137869. * Gets the maxZ used for shadow according to both the scene and the light.
  137870. *
  137871. * Values are fixed on directional lights as it relies on an ortho projection hence the need to convert being
  137872. * -1 and 1 to 0 and 1 doing (depth + min) / (min + max) -> (depth + 1) / (1 + 1) -> (depth * 0.5) + 0.5.
  137873. * @param activeCamera The camera we are returning the max for
  137874. * @returns the depth max z
  137875. */
  137876. getDepthMaxZ(activeCamera: Camera): number;
  137877. /**
  137878. * Prepares the list of defines specific to the light type.
  137879. * @param defines the list of defines
  137880. * @param lightIndex defines the index of the light for the effect
  137881. */
  137882. prepareLightSpecificDefines(defines: any, lightIndex: number): void;
  137883. }
  137884. }
  137885. declare module BABYLON {
  137886. /**
  137887. * Class containing static functions to help procedurally build meshes
  137888. */
  137889. export class HemisphereBuilder {
  137890. /**
  137891. * Creates a hemisphere mesh
  137892. * @param name defines the name of the mesh
  137893. * @param options defines the options used to create the mesh
  137894. * @param scene defines the hosting scene
  137895. * @returns the hemisphere mesh
  137896. */
  137897. static CreateHemisphere(name: string, options: {
  137898. segments?: number;
  137899. diameter?: number;
  137900. sideOrientation?: number;
  137901. }, scene: any): Mesh;
  137902. }
  137903. }
  137904. declare module BABYLON {
  137905. /**
  137906. * A spot light is defined by a position, a direction, an angle, and an exponent.
  137907. * These values define a cone of light starting from the position, emitting toward the direction.
  137908. * The angle, in radians, defines the size (field of illumination) of the spotlight's conical beam,
  137909. * and the exponent defines the speed of the decay of the light with distance (reach).
  137910. * Documentation: https://doc.babylonjs.com/babylon101/lights
  137911. */
  137912. export class SpotLight extends ShadowLight {
  137913. private _angle;
  137914. private _innerAngle;
  137915. private _cosHalfAngle;
  137916. private _lightAngleScale;
  137917. private _lightAngleOffset;
  137918. /**
  137919. * Gets the cone angle of the spot light in Radians.
  137920. */
  137921. get angle(): number;
  137922. /**
  137923. * Sets the cone angle of the spot light in Radians.
  137924. */
  137925. set angle(value: number);
  137926. /**
  137927. * Only used in gltf falloff mode, this defines the angle where
  137928. * the directional falloff will start before cutting at angle which could be seen
  137929. * as outer angle.
  137930. */
  137931. get innerAngle(): number;
  137932. /**
  137933. * Only used in gltf falloff mode, this defines the angle where
  137934. * the directional falloff will start before cutting at angle which could be seen
  137935. * as outer angle.
  137936. */
  137937. set innerAngle(value: number);
  137938. private _shadowAngleScale;
  137939. /**
  137940. * Allows scaling the angle of the light for shadow generation only.
  137941. */
  137942. get shadowAngleScale(): number;
  137943. /**
  137944. * Allows scaling the angle of the light for shadow generation only.
  137945. */
  137946. set shadowAngleScale(value: number);
  137947. /**
  137948. * The light decay speed with the distance from the emission spot.
  137949. */
  137950. exponent: number;
  137951. private _projectionTextureMatrix;
  137952. /**
  137953. * Allows reading the projecton texture
  137954. */
  137955. get projectionTextureMatrix(): Matrix;
  137956. protected _projectionTextureLightNear: number;
  137957. /**
  137958. * Gets the near clip of the Spotlight for texture projection.
  137959. */
  137960. get projectionTextureLightNear(): number;
  137961. /**
  137962. * Sets the near clip of the Spotlight for texture projection.
  137963. */
  137964. set projectionTextureLightNear(value: number);
  137965. protected _projectionTextureLightFar: number;
  137966. /**
  137967. * Gets the far clip of the Spotlight for texture projection.
  137968. */
  137969. get projectionTextureLightFar(): number;
  137970. /**
  137971. * Sets the far clip of the Spotlight for texture projection.
  137972. */
  137973. set projectionTextureLightFar(value: number);
  137974. protected _projectionTextureUpDirection: Vector3;
  137975. /**
  137976. * Gets the Up vector of the Spotlight for texture projection.
  137977. */
  137978. get projectionTextureUpDirection(): Vector3;
  137979. /**
  137980. * Sets the Up vector of the Spotlight for texture projection.
  137981. */
  137982. set projectionTextureUpDirection(value: Vector3);
  137983. private _projectionTexture;
  137984. /**
  137985. * Gets the projection texture of the light.
  137986. */
  137987. get projectionTexture(): Nullable<BaseTexture>;
  137988. /**
  137989. * Sets the projection texture of the light.
  137990. */
  137991. set projectionTexture(value: Nullable<BaseTexture>);
  137992. private _projectionTextureViewLightDirty;
  137993. private _projectionTextureProjectionLightDirty;
  137994. private _projectionTextureDirty;
  137995. private _projectionTextureViewTargetVector;
  137996. private _projectionTextureViewLightMatrix;
  137997. private _projectionTextureProjectionLightMatrix;
  137998. private _projectionTextureScalingMatrix;
  137999. /**
  138000. * Creates a SpotLight object in the scene. A spot light is a simply light oriented cone.
  138001. * It can cast shadows.
  138002. * Documentation : https://doc.babylonjs.com/babylon101/lights
  138003. * @param name The light friendly name
  138004. * @param position The position of the spot light in the scene
  138005. * @param direction The direction of the light in the scene
  138006. * @param angle The cone angle of the light in Radians
  138007. * @param exponent The light decay speed with the distance from the emission spot
  138008. * @param scene The scene the lights belongs to
  138009. */
  138010. constructor(name: string, position: Vector3, direction: Vector3, angle: number, exponent: number, scene: Scene);
  138011. /**
  138012. * Returns the string "SpotLight".
  138013. * @returns the class name
  138014. */
  138015. getClassName(): string;
  138016. /**
  138017. * Returns the integer 2.
  138018. * @returns The light Type id as a constant defines in Light.LIGHTTYPEID_x
  138019. */
  138020. getTypeID(): number;
  138021. /**
  138022. * Overrides the direction setter to recompute the projection texture view light Matrix.
  138023. */
  138024. protected _setDirection(value: Vector3): void;
  138025. /**
  138026. * Overrides the position setter to recompute the projection texture view light Matrix.
  138027. */
  138028. protected _setPosition(value: Vector3): void;
  138029. /**
  138030. * 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.
  138031. * Returns the SpotLight.
  138032. */
  138033. protected _setDefaultShadowProjectionMatrix(matrix: Matrix, viewMatrix: Matrix, renderList: Array<AbstractMesh>): void;
  138034. protected _computeProjectionTextureViewLightMatrix(): void;
  138035. protected _computeProjectionTextureProjectionLightMatrix(): void;
  138036. /**
  138037. * Main function for light texture projection matrix computing.
  138038. */
  138039. protected _computeProjectionTextureMatrix(): void;
  138040. protected _buildUniformLayout(): void;
  138041. private _computeAngleValues;
  138042. /**
  138043. * Sets the passed Effect "effect" with the Light textures.
  138044. * @param effect The effect to update
  138045. * @param lightIndex The index of the light in the effect to update
  138046. * @returns The light
  138047. */
  138048. transferTexturesToEffect(effect: Effect, lightIndex: string): Light;
  138049. /**
  138050. * Sets the passed Effect object with the SpotLight transfomed position (or position if not parented) and normalized direction.
  138051. * @param effect The effect to update
  138052. * @param lightIndex The index of the light in the effect to update
  138053. * @returns The spot light
  138054. */
  138055. transferToEffect(effect: Effect, lightIndex: string): SpotLight;
  138056. transferToNodeMaterialEffect(effect: Effect, lightDataUniformName: string): this;
  138057. /**
  138058. * Disposes the light and the associated resources.
  138059. */
  138060. dispose(): void;
  138061. /**
  138062. * Prepares the list of defines specific to the light type.
  138063. * @param defines the list of defines
  138064. * @param lightIndex defines the index of the light for the effect
  138065. */
  138066. prepareLightSpecificDefines(defines: any, lightIndex: number): void;
  138067. }
  138068. }
  138069. declare module BABYLON {
  138070. /**
  138071. * Gizmo that enables viewing a light
  138072. */
  138073. export class LightGizmo extends Gizmo {
  138074. private _lightMesh;
  138075. private _material;
  138076. private _cachedPosition;
  138077. private _cachedForward;
  138078. private _attachedMeshParent;
  138079. private _pointerObserver;
  138080. /**
  138081. * Event that fires each time the gizmo is clicked
  138082. */
  138083. onClickedObservable: Observable<Light>;
  138084. /**
  138085. * Creates a LightGizmo
  138086. * @param gizmoLayer The utility layer the gizmo will be added to
  138087. */
  138088. constructor(gizmoLayer?: UtilityLayerRenderer);
  138089. private _light;
  138090. /**
  138091. * The light that the gizmo is attached to
  138092. */
  138093. set light(light: Nullable<Light>);
  138094. get light(): Nullable<Light>;
  138095. /**
  138096. * Gets the material used to render the light gizmo
  138097. */
  138098. get material(): StandardMaterial;
  138099. /**
  138100. * @hidden
  138101. * Updates the gizmo to match the attached mesh's position/rotation
  138102. */
  138103. protected _update(): void;
  138104. private static _Scale;
  138105. /**
  138106. * Creates the lines for a light mesh
  138107. */
  138108. private static _CreateLightLines;
  138109. /**
  138110. * Disposes of the light gizmo
  138111. */
  138112. dispose(): void;
  138113. private static _CreateHemisphericLightMesh;
  138114. private static _CreatePointLightMesh;
  138115. private static _CreateSpotLightMesh;
  138116. private static _CreateDirectionalLightMesh;
  138117. }
  138118. }
  138119. declare module BABYLON {
  138120. /**
  138121. * Gizmo that enables viewing a camera
  138122. */
  138123. export class CameraGizmo extends Gizmo {
  138124. private _cameraMesh;
  138125. private _cameraLinesMesh;
  138126. private _material;
  138127. private _pointerObserver;
  138128. /**
  138129. * Event that fires each time the gizmo is clicked
  138130. */
  138131. onClickedObservable: Observable<Camera>;
  138132. /**
  138133. * Creates a CameraGizmo
  138134. * @param gizmoLayer The utility layer the gizmo will be added to
  138135. */
  138136. constructor(gizmoLayer?: UtilityLayerRenderer);
  138137. private _camera;
  138138. /** Gets or sets a boolean indicating if frustum lines must be rendered (true by default)) */
  138139. get displayFrustum(): boolean;
  138140. set displayFrustum(value: boolean);
  138141. /**
  138142. * The camera that the gizmo is attached to
  138143. */
  138144. set camera(camera: Nullable<Camera>);
  138145. get camera(): Nullable<Camera>;
  138146. /**
  138147. * Gets the material used to render the camera gizmo
  138148. */
  138149. get material(): StandardMaterial;
  138150. /**
  138151. * @hidden
  138152. * Updates the gizmo to match the attached mesh's position/rotation
  138153. */
  138154. protected _update(): void;
  138155. private static _Scale;
  138156. private _invProjection;
  138157. /**
  138158. * Disposes of the camera gizmo
  138159. */
  138160. dispose(): void;
  138161. private static _CreateCameraMesh;
  138162. private static _CreateCameraFrustum;
  138163. }
  138164. }
  138165. declare module BABYLON {
  138166. /** @hidden */
  138167. export var backgroundFragmentDeclaration: {
  138168. name: string;
  138169. shader: string;
  138170. };
  138171. }
  138172. declare module BABYLON {
  138173. /** @hidden */
  138174. export var backgroundUboDeclaration: {
  138175. name: string;
  138176. shader: string;
  138177. };
  138178. }
  138179. declare module BABYLON {
  138180. /** @hidden */
  138181. export var backgroundPixelShader: {
  138182. name: string;
  138183. shader: string;
  138184. };
  138185. }
  138186. declare module BABYLON {
  138187. /** @hidden */
  138188. export var backgroundVertexDeclaration: {
  138189. name: string;
  138190. shader: string;
  138191. };
  138192. }
  138193. declare module BABYLON {
  138194. /** @hidden */
  138195. export var backgroundVertexShader: {
  138196. name: string;
  138197. shader: string;
  138198. };
  138199. }
  138200. declare module BABYLON {
  138201. /**
  138202. * Background material used to create an efficient environement around your scene.
  138203. */
  138204. export class BackgroundMaterial extends PushMaterial {
  138205. /**
  138206. * Standard reflectance value at parallel view angle.
  138207. */
  138208. static StandardReflectance0: number;
  138209. /**
  138210. * Standard reflectance value at grazing angle.
  138211. */
  138212. static StandardReflectance90: number;
  138213. protected _primaryColor: Color3;
  138214. /**
  138215. * Key light Color (multiply against the environement texture)
  138216. */
  138217. primaryColor: Color3;
  138218. protected __perceptualColor: Nullable<Color3>;
  138219. /**
  138220. * Experimental Internal Use Only.
  138221. *
  138222. * Key light Color in "perceptual value" meaning the color you would like to see on screen.
  138223. * This acts as a helper to set the primary color to a more "human friendly" value.
  138224. * Conversion to linear space as well as exposure and tone mapping correction will be applied to keep the
  138225. * output color as close as possible from the chosen value.
  138226. * (This does not account for contrast color grading and color curves as they are considered post effect and not directly
  138227. * part of lighting setup.)
  138228. */
  138229. get _perceptualColor(): Nullable<Color3>;
  138230. set _perceptualColor(value: Nullable<Color3>);
  138231. protected _primaryColorShadowLevel: float;
  138232. /**
  138233. * Defines the level of the shadows (dark area of the reflection map) in order to help scaling the colors.
  138234. * The color opposite to the primary color is used at the level chosen to define what the black area would look.
  138235. */
  138236. get primaryColorShadowLevel(): float;
  138237. set primaryColorShadowLevel(value: float);
  138238. protected _primaryColorHighlightLevel: float;
  138239. /**
  138240. * Defines the level of the highliights (highlight area of the reflection map) in order to help scaling the colors.
  138241. * The primary color is used at the level chosen to define what the white area would look.
  138242. */
  138243. get primaryColorHighlightLevel(): float;
  138244. set primaryColorHighlightLevel(value: float);
  138245. protected _reflectionTexture: Nullable<BaseTexture>;
  138246. /**
  138247. * Reflection Texture used in the material.
  138248. * Should be author in a specific way for the best result (refer to the documentation).
  138249. */
  138250. reflectionTexture: Nullable<BaseTexture>;
  138251. protected _reflectionBlur: float;
  138252. /**
  138253. * Reflection Texture level of blur.
  138254. *
  138255. * Can be use to reuse an existing HDR Texture and target a specific LOD to prevent authoring the
  138256. * texture twice.
  138257. */
  138258. reflectionBlur: float;
  138259. protected _diffuseTexture: Nullable<BaseTexture>;
  138260. /**
  138261. * Diffuse Texture used in the material.
  138262. * Should be author in a specific way for the best result (refer to the documentation).
  138263. */
  138264. diffuseTexture: Nullable<BaseTexture>;
  138265. protected _shadowLights: Nullable<IShadowLight[]>;
  138266. /**
  138267. * Specify the list of lights casting shadow on the material.
  138268. * All scene shadow lights will be included if null.
  138269. */
  138270. shadowLights: Nullable<IShadowLight[]>;
  138271. protected _shadowLevel: float;
  138272. /**
  138273. * Helps adjusting the shadow to a softer level if required.
  138274. * 0 means black shadows and 1 means no shadows.
  138275. */
  138276. shadowLevel: float;
  138277. protected _sceneCenter: Vector3;
  138278. /**
  138279. * In case of opacity Fresnel or reflection falloff, this is use as a scene center.
  138280. * It is usually zero but might be interesting to modify according to your setup.
  138281. */
  138282. sceneCenter: Vector3;
  138283. protected _opacityFresnel: boolean;
  138284. /**
  138285. * This helps specifying that the material is falling off to the sky box at grazing angle.
  138286. * This helps ensuring a nice transition when the camera goes under the ground.
  138287. */
  138288. opacityFresnel: boolean;
  138289. protected _reflectionFresnel: boolean;
  138290. /**
  138291. * This helps specifying that the material is falling off from diffuse to the reflection texture at grazing angle.
  138292. * This helps adding a mirror texture on the ground.
  138293. */
  138294. reflectionFresnel: boolean;
  138295. protected _reflectionFalloffDistance: number;
  138296. /**
  138297. * This helps specifying the falloff radius off the reflection texture from the sceneCenter.
  138298. * This helps adding a nice falloff effect to the reflection if used as a mirror for instance.
  138299. */
  138300. reflectionFalloffDistance: number;
  138301. protected _reflectionAmount: number;
  138302. /**
  138303. * This specifies the weight of the reflection against the background in case of reflection Fresnel.
  138304. */
  138305. reflectionAmount: number;
  138306. protected _reflectionReflectance0: number;
  138307. /**
  138308. * This specifies the weight of the reflection at grazing angle.
  138309. */
  138310. reflectionReflectance0: number;
  138311. protected _reflectionReflectance90: number;
  138312. /**
  138313. * This specifies the weight of the reflection at a perpendicular point of view.
  138314. */
  138315. reflectionReflectance90: number;
  138316. /**
  138317. * Sets the reflection reflectance fresnel values according to the default standard
  138318. * empirically know to work well :-)
  138319. */
  138320. set reflectionStandardFresnelWeight(value: number);
  138321. protected _useRGBColor: boolean;
  138322. /**
  138323. * Helps to directly use the maps channels instead of their level.
  138324. */
  138325. useRGBColor: boolean;
  138326. protected _enableNoise: boolean;
  138327. /**
  138328. * This helps reducing the banding effect that could occur on the background.
  138329. */
  138330. enableNoise: boolean;
  138331. /**
  138332. * The current fov(field of view) multiplier, 0.0 - 2.0. Defaults to 1.0. Lower values "zoom in" and higher values "zoom out".
  138333. * Best used when trying to implement visual zoom effects like fish-eye or binoculars while not adjusting camera fov.
  138334. * Recommended to be keep at 1.0 except for special cases.
  138335. */
  138336. get fovMultiplier(): number;
  138337. set fovMultiplier(value: number);
  138338. private _fovMultiplier;
  138339. /**
  138340. * Enable the FOV adjustment feature controlled by fovMultiplier.
  138341. */
  138342. useEquirectangularFOV: boolean;
  138343. private _maxSimultaneousLights;
  138344. /**
  138345. * Number of Simultaneous lights allowed on the material.
  138346. */
  138347. maxSimultaneousLights: int;
  138348. private _shadowOnly;
  138349. /**
  138350. * Make the material only render shadows
  138351. */
  138352. shadowOnly: boolean;
  138353. /**
  138354. * Default configuration related to image processing available in the Background Material.
  138355. */
  138356. protected _imageProcessingConfiguration: ImageProcessingConfiguration;
  138357. /**
  138358. * Keep track of the image processing observer to allow dispose and replace.
  138359. */
  138360. private _imageProcessingObserver;
  138361. /**
  138362. * Attaches a new image processing configuration to the PBR Material.
  138363. * @param configuration (if null the scene configuration will be use)
  138364. */
  138365. protected _attachImageProcessingConfiguration(configuration: Nullable<ImageProcessingConfiguration>): void;
  138366. /**
  138367. * Gets the image processing configuration used either in this material.
  138368. */
  138369. get imageProcessingConfiguration(): Nullable<ImageProcessingConfiguration>;
  138370. /**
  138371. * Sets the Default image processing configuration used either in the this material.
  138372. *
  138373. * If sets to null, the scene one is in use.
  138374. */
  138375. set imageProcessingConfiguration(value: Nullable<ImageProcessingConfiguration>);
  138376. /**
  138377. * Gets wether the color curves effect is enabled.
  138378. */
  138379. get cameraColorCurvesEnabled(): boolean;
  138380. /**
  138381. * Sets wether the color curves effect is enabled.
  138382. */
  138383. set cameraColorCurvesEnabled(value: boolean);
  138384. /**
  138385. * Gets wether the color grading effect is enabled.
  138386. */
  138387. get cameraColorGradingEnabled(): boolean;
  138388. /**
  138389. * Gets wether the color grading effect is enabled.
  138390. */
  138391. set cameraColorGradingEnabled(value: boolean);
  138392. /**
  138393. * Gets wether tonemapping is enabled or not.
  138394. */
  138395. get cameraToneMappingEnabled(): boolean;
  138396. /**
  138397. * Sets wether tonemapping is enabled or not
  138398. */
  138399. set cameraToneMappingEnabled(value: boolean);
  138400. /**
  138401. * The camera exposure used on this material.
  138402. * This property is here and not in the camera to allow controlling exposure without full screen post process.
  138403. * This corresponds to a photographic exposure.
  138404. */
  138405. get cameraExposure(): float;
  138406. /**
  138407. * The camera exposure used on this material.
  138408. * This property is here and not in the camera to allow controlling exposure without full screen post process.
  138409. * This corresponds to a photographic exposure.
  138410. */
  138411. set cameraExposure(value: float);
  138412. /**
  138413. * Gets The camera contrast used on this material.
  138414. */
  138415. get cameraContrast(): float;
  138416. /**
  138417. * Sets The camera contrast used on this material.
  138418. */
  138419. set cameraContrast(value: float);
  138420. /**
  138421. * Gets the Color Grading 2D Lookup Texture.
  138422. */
  138423. get cameraColorGradingTexture(): Nullable<BaseTexture>;
  138424. /**
  138425. * Sets the Color Grading 2D Lookup Texture.
  138426. */
  138427. set cameraColorGradingTexture(value: Nullable<BaseTexture>);
  138428. /**
  138429. * The color grading curves provide additional color adjustmnent that is applied after any color grading transform (3D LUT).
  138430. * They allow basic adjustment of saturation and small exposure adjustments, along with color filter tinting to provide white balance adjustment or more stylistic effects.
  138431. * 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;
  138432. * corresponding to low luminance, medium luminance, and high luminance areas respectively.
  138433. */
  138434. get cameraColorCurves(): Nullable<ColorCurves>;
  138435. /**
  138436. * The color grading curves provide additional color adjustmnent that is applied after any color grading transform (3D LUT).
  138437. * They allow basic adjustment of saturation and small exposure adjustments, along with color filter tinting to provide white balance adjustment or more stylistic effects.
  138438. * 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;
  138439. * corresponding to low luminance, medium luminance, and high luminance areas respectively.
  138440. */
  138441. set cameraColorCurves(value: Nullable<ColorCurves>);
  138442. /**
  138443. * Due to a bug in iOS10, video tags (which are using the background material) are in BGR and not RGB.
  138444. * Setting this flag to true (not done automatically!) will convert it back to RGB.
  138445. */
  138446. switchToBGR: boolean;
  138447. private _renderTargets;
  138448. private _reflectionControls;
  138449. private _white;
  138450. private _primaryShadowColor;
  138451. private _primaryHighlightColor;
  138452. /**
  138453. * Instantiates a Background Material in the given scene
  138454. * @param name The friendly name of the material
  138455. * @param scene The scene to add the material to
  138456. */
  138457. constructor(name: string, scene: Scene);
  138458. /**
  138459. * Gets a boolean indicating that current material needs to register RTT
  138460. */
  138461. get hasRenderTargetTextures(): boolean;
  138462. /**
  138463. * The entire material has been created in order to prevent overdraw.
  138464. * @returns false
  138465. */
  138466. needAlphaTesting(): boolean;
  138467. /**
  138468. * The entire material has been created in order to prevent overdraw.
  138469. * @returns true if blending is enable
  138470. */
  138471. needAlphaBlending(): boolean;
  138472. /**
  138473. * Checks wether the material is ready to be rendered for a given mesh.
  138474. * @param mesh The mesh to render
  138475. * @param subMesh The submesh to check against
  138476. * @param useInstances Specify wether or not the material is used with instances
  138477. * @returns true if all the dependencies are ready (Textures, Effects...)
  138478. */
  138479. isReadyForSubMesh(mesh: AbstractMesh, subMesh: SubMesh, useInstances?: boolean): boolean;
  138480. /**
  138481. * Compute the primary color according to the chosen perceptual color.
  138482. */
  138483. private _computePrimaryColorFromPerceptualColor;
  138484. /**
  138485. * Compute the highlights and shadow colors according to their chosen levels.
  138486. */
  138487. private _computePrimaryColors;
  138488. /**
  138489. * Build the uniform buffer used in the material.
  138490. */
  138491. buildUniformLayout(): void;
  138492. /**
  138493. * Unbind the material.
  138494. */
  138495. unbind(): void;
  138496. /**
  138497. * Bind only the world matrix to the material.
  138498. * @param world The world matrix to bind.
  138499. */
  138500. bindOnlyWorldMatrix(world: Matrix): void;
  138501. /**
  138502. * Bind the material for a dedicated submeh (every used meshes will be considered opaque).
  138503. * @param world The world matrix to bind.
  138504. * @param subMesh The submesh to bind for.
  138505. */
  138506. bindForSubMesh(world: Matrix, mesh: Mesh, subMesh: SubMesh): void;
  138507. /**
  138508. * Checks to see if a texture is used in the material.
  138509. * @param texture - Base texture to use.
  138510. * @returns - Boolean specifying if a texture is used in the material.
  138511. */
  138512. hasTexture(texture: BaseTexture): boolean;
  138513. /**
  138514. * Dispose the material.
  138515. * @param forceDisposeEffect Force disposal of the associated effect.
  138516. * @param forceDisposeTextures Force disposal of the associated textures.
  138517. */
  138518. dispose(forceDisposeEffect?: boolean, forceDisposeTextures?: boolean): void;
  138519. /**
  138520. * Clones the material.
  138521. * @param name The cloned name.
  138522. * @returns The cloned material.
  138523. */
  138524. clone(name: string): BackgroundMaterial;
  138525. /**
  138526. * Serializes the current material to its JSON representation.
  138527. * @returns The JSON representation.
  138528. */
  138529. serialize(): any;
  138530. /**
  138531. * Gets the class name of the material
  138532. * @returns "BackgroundMaterial"
  138533. */
  138534. getClassName(): string;
  138535. /**
  138536. * Parse a JSON input to create back a background material.
  138537. * @param source The JSON data to parse
  138538. * @param scene The scene to create the parsed material in
  138539. * @param rootUrl The root url of the assets the material depends upon
  138540. * @returns the instantiated BackgroundMaterial.
  138541. */
  138542. static Parse(source: any, scene: Scene, rootUrl: string): BackgroundMaterial;
  138543. }
  138544. }
  138545. declare module BABYLON {
  138546. /**
  138547. * Represents the different options available during the creation of
  138548. * a Environment helper.
  138549. *
  138550. * This can control the default ground, skybox and image processing setup of your scene.
  138551. */
  138552. export interface IEnvironmentHelperOptions {
  138553. /**
  138554. * Specifies whether or not to create a ground.
  138555. * True by default.
  138556. */
  138557. createGround: boolean;
  138558. /**
  138559. * Specifies the ground size.
  138560. * 15 by default.
  138561. */
  138562. groundSize: number;
  138563. /**
  138564. * The texture used on the ground for the main color.
  138565. * Comes from the BabylonJS CDN by default.
  138566. *
  138567. * Remarks: Can be either a texture or a url.
  138568. */
  138569. groundTexture: string | BaseTexture;
  138570. /**
  138571. * The color mixed in the ground texture by default.
  138572. * BabylonJS clearColor by default.
  138573. */
  138574. groundColor: Color3;
  138575. /**
  138576. * Specifies the ground opacity.
  138577. * 1 by default.
  138578. */
  138579. groundOpacity: number;
  138580. /**
  138581. * Enables the ground to receive shadows.
  138582. * True by default.
  138583. */
  138584. enableGroundShadow: boolean;
  138585. /**
  138586. * Helps preventing the shadow to be fully black on the ground.
  138587. * 0.5 by default.
  138588. */
  138589. groundShadowLevel: number;
  138590. /**
  138591. * Creates a mirror texture attach to the ground.
  138592. * false by default.
  138593. */
  138594. enableGroundMirror: boolean;
  138595. /**
  138596. * Specifies the ground mirror size ratio.
  138597. * 0.3 by default as the default kernel is 64.
  138598. */
  138599. groundMirrorSizeRatio: number;
  138600. /**
  138601. * Specifies the ground mirror blur kernel size.
  138602. * 64 by default.
  138603. */
  138604. groundMirrorBlurKernel: number;
  138605. /**
  138606. * Specifies the ground mirror visibility amount.
  138607. * 1 by default
  138608. */
  138609. groundMirrorAmount: number;
  138610. /**
  138611. * Specifies the ground mirror reflectance weight.
  138612. * This uses the standard weight of the background material to setup the fresnel effect
  138613. * of the mirror.
  138614. * 1 by default.
  138615. */
  138616. groundMirrorFresnelWeight: number;
  138617. /**
  138618. * Specifies the ground mirror Falloff distance.
  138619. * This can helps reducing the size of the reflection.
  138620. * 0 by Default.
  138621. */
  138622. groundMirrorFallOffDistance: number;
  138623. /**
  138624. * Specifies the ground mirror texture type.
  138625. * Unsigned Int by Default.
  138626. */
  138627. groundMirrorTextureType: number;
  138628. /**
  138629. * Specifies a bias applied to the ground vertical position to prevent z-fighting with
  138630. * the shown objects.
  138631. */
  138632. groundYBias: number;
  138633. /**
  138634. * Specifies whether or not to create a skybox.
  138635. * True by default.
  138636. */
  138637. createSkybox: boolean;
  138638. /**
  138639. * Specifies the skybox size.
  138640. * 20 by default.
  138641. */
  138642. skyboxSize: number;
  138643. /**
  138644. * The texture used on the skybox for the main color.
  138645. * Comes from the BabylonJS CDN by default.
  138646. *
  138647. * Remarks: Can be either a texture or a url.
  138648. */
  138649. skyboxTexture: string | BaseTexture;
  138650. /**
  138651. * The color mixed in the skybox texture by default.
  138652. * BabylonJS clearColor by default.
  138653. */
  138654. skyboxColor: Color3;
  138655. /**
  138656. * The background rotation around the Y axis of the scene.
  138657. * This helps aligning the key lights of your scene with the background.
  138658. * 0 by default.
  138659. */
  138660. backgroundYRotation: number;
  138661. /**
  138662. * Compute automatically the size of the elements to best fit with the scene.
  138663. */
  138664. sizeAuto: boolean;
  138665. /**
  138666. * Default position of the rootMesh if autoSize is not true.
  138667. */
  138668. rootPosition: Vector3;
  138669. /**
  138670. * Sets up the image processing in the scene.
  138671. * true by default.
  138672. */
  138673. setupImageProcessing: boolean;
  138674. /**
  138675. * The texture used as your environment texture in the scene.
  138676. * Comes from the BabylonJS CDN by default and in use if setupImageProcessing is true.
  138677. *
  138678. * Remarks: Can be either a texture or a url.
  138679. */
  138680. environmentTexture: string | BaseTexture;
  138681. /**
  138682. * The value of the exposure to apply to the scene.
  138683. * 0.6 by default if setupImageProcessing is true.
  138684. */
  138685. cameraExposure: number;
  138686. /**
  138687. * The value of the contrast to apply to the scene.
  138688. * 1.6 by default if setupImageProcessing is true.
  138689. */
  138690. cameraContrast: number;
  138691. /**
  138692. * Specifies whether or not tonemapping should be enabled in the scene.
  138693. * true by default if setupImageProcessing is true.
  138694. */
  138695. toneMappingEnabled: boolean;
  138696. }
  138697. /**
  138698. * The Environment helper class can be used to add a fully featuread none expensive background to your scene.
  138699. * It includes by default a skybox and a ground relying on the BackgroundMaterial.
  138700. * It also helps with the default setup of your imageProcessing configuration.
  138701. */
  138702. export class EnvironmentHelper {
  138703. /**
  138704. * Default ground texture URL.
  138705. */
  138706. private static _groundTextureCDNUrl;
  138707. /**
  138708. * Default skybox texture URL.
  138709. */
  138710. private static _skyboxTextureCDNUrl;
  138711. /**
  138712. * Default environment texture URL.
  138713. */
  138714. private static _environmentTextureCDNUrl;
  138715. /**
  138716. * Creates the default options for the helper.
  138717. */
  138718. private static _getDefaultOptions;
  138719. private _rootMesh;
  138720. /**
  138721. * Gets the root mesh created by the helper.
  138722. */
  138723. get rootMesh(): Mesh;
  138724. private _skybox;
  138725. /**
  138726. * Gets the skybox created by the helper.
  138727. */
  138728. get skybox(): Nullable<Mesh>;
  138729. private _skyboxTexture;
  138730. /**
  138731. * Gets the skybox texture created by the helper.
  138732. */
  138733. get skyboxTexture(): Nullable<BaseTexture>;
  138734. private _skyboxMaterial;
  138735. /**
  138736. * Gets the skybox material created by the helper.
  138737. */
  138738. get skyboxMaterial(): Nullable<BackgroundMaterial>;
  138739. private _ground;
  138740. /**
  138741. * Gets the ground mesh created by the helper.
  138742. */
  138743. get ground(): Nullable<Mesh>;
  138744. private _groundTexture;
  138745. /**
  138746. * Gets the ground texture created by the helper.
  138747. */
  138748. get groundTexture(): Nullable<BaseTexture>;
  138749. private _groundMirror;
  138750. /**
  138751. * Gets the ground mirror created by the helper.
  138752. */
  138753. get groundMirror(): Nullable<MirrorTexture>;
  138754. /**
  138755. * Gets the ground mirror render list to helps pushing the meshes
  138756. * you wish in the ground reflection.
  138757. */
  138758. get groundMirrorRenderList(): Nullable<AbstractMesh[]>;
  138759. private _groundMaterial;
  138760. /**
  138761. * Gets the ground material created by the helper.
  138762. */
  138763. get groundMaterial(): Nullable<BackgroundMaterial>;
  138764. /**
  138765. * Stores the creation options.
  138766. */
  138767. private readonly _scene;
  138768. private _options;
  138769. /**
  138770. * This observable will be notified with any error during the creation of the environment,
  138771. * mainly texture creation errors.
  138772. */
  138773. onErrorObservable: Observable<{
  138774. message?: string;
  138775. exception?: any;
  138776. }>;
  138777. /**
  138778. * constructor
  138779. * @param options Defines the options we want to customize the helper
  138780. * @param scene The scene to add the material to
  138781. */
  138782. constructor(options: Partial<IEnvironmentHelperOptions>, scene: Scene);
  138783. /**
  138784. * Updates the background according to the new options
  138785. * @param options
  138786. */
  138787. updateOptions(options: Partial<IEnvironmentHelperOptions>): void;
  138788. /**
  138789. * Sets the primary color of all the available elements.
  138790. * @param color the main color to affect to the ground and the background
  138791. */
  138792. setMainColor(color: Color3): void;
  138793. /**
  138794. * Setup the image processing according to the specified options.
  138795. */
  138796. private _setupImageProcessing;
  138797. /**
  138798. * Setup the environment texture according to the specified options.
  138799. */
  138800. private _setupEnvironmentTexture;
  138801. /**
  138802. * Setup the background according to the specified options.
  138803. */
  138804. private _setupBackground;
  138805. /**
  138806. * Get the scene sizes according to the setup.
  138807. */
  138808. private _getSceneSize;
  138809. /**
  138810. * Setup the ground according to the specified options.
  138811. */
  138812. private _setupGround;
  138813. /**
  138814. * Setup the ground material according to the specified options.
  138815. */
  138816. private _setupGroundMaterial;
  138817. /**
  138818. * Setup the ground diffuse texture according to the specified options.
  138819. */
  138820. private _setupGroundDiffuseTexture;
  138821. /**
  138822. * Setup the ground mirror texture according to the specified options.
  138823. */
  138824. private _setupGroundMirrorTexture;
  138825. /**
  138826. * Setup the ground to receive the mirror texture.
  138827. */
  138828. private _setupMirrorInGroundMaterial;
  138829. /**
  138830. * Setup the skybox according to the specified options.
  138831. */
  138832. private _setupSkybox;
  138833. /**
  138834. * Setup the skybox material according to the specified options.
  138835. */
  138836. private _setupSkyboxMaterial;
  138837. /**
  138838. * Setup the skybox reflection texture according to the specified options.
  138839. */
  138840. private _setupSkyboxReflectionTexture;
  138841. private _errorHandler;
  138842. /**
  138843. * Dispose all the elements created by the Helper.
  138844. */
  138845. dispose(): void;
  138846. }
  138847. }
  138848. declare module BABYLON {
  138849. /**
  138850. * Display a 360/180 degree texture on an approximately spherical surface, useful for VR applications or skyboxes.
  138851. * As a subclass of TransformNode, this allow parenting to the camera or multiple textures with different locations in the scene.
  138852. * This class achieves its effect with a Texture and a correctly configured BackgroundMaterial on an inverted sphere.
  138853. * Potential additions to this helper include zoom and and non-infinite distance rendering effects.
  138854. */
  138855. export abstract class TextureDome<T extends Texture> extends TransformNode {
  138856. protected onError: Nullable<(message?: string, exception?: any) => void>;
  138857. /**
  138858. * Define the source as a Monoscopic panoramic 360/180.
  138859. */
  138860. static readonly MODE_MONOSCOPIC: number;
  138861. /**
  138862. * Define the source as a Stereoscopic TopBottom/OverUnder panoramic 360/180.
  138863. */
  138864. static readonly MODE_TOPBOTTOM: number;
  138865. /**
  138866. * Define the source as a Stereoscopic Side by Side panoramic 360/180.
  138867. */
  138868. static readonly MODE_SIDEBYSIDE: number;
  138869. private _halfDome;
  138870. private _crossEye;
  138871. protected _useDirectMapping: boolean;
  138872. /**
  138873. * The texture being displayed on the sphere
  138874. */
  138875. protected _texture: T;
  138876. /**
  138877. * Gets the texture being displayed on the sphere
  138878. */
  138879. get texture(): T;
  138880. /**
  138881. * Sets the texture being displayed on the sphere
  138882. */
  138883. set texture(newTexture: T);
  138884. /**
  138885. * The skybox material
  138886. */
  138887. protected _material: BackgroundMaterial;
  138888. /**
  138889. * The surface used for the dome
  138890. */
  138891. protected _mesh: Mesh;
  138892. /**
  138893. * Gets the mesh used for the dome.
  138894. */
  138895. get mesh(): Mesh;
  138896. /**
  138897. * A mesh that will be used to mask the back of the dome in case it is a 180 degree movie.
  138898. */
  138899. private _halfDomeMask;
  138900. /**
  138901. * The current fov(field of view) multiplier, 0.0 - 2.0. Defaults to 1.0. Lower values "zoom in" and higher values "zoom out".
  138902. * Also see the options.resolution property.
  138903. */
  138904. get fovMultiplier(): number;
  138905. set fovMultiplier(value: number);
  138906. protected _textureMode: number;
  138907. /**
  138908. * Gets or set the current texture mode for the texture. It can be:
  138909. * * TextureDome.MODE_MONOSCOPIC : Define the texture source as a Monoscopic panoramic 360.
  138910. * * TextureDome.MODE_TOPBOTTOM : Define the texture source as a Stereoscopic TopBottom/OverUnder panoramic 360.
  138911. * * TextureDome.MODE_SIDEBYSIDE : Define the texture source as a Stereoscopic Side by Side panoramic 360.
  138912. */
  138913. get textureMode(): number;
  138914. /**
  138915. * Sets the current texture mode for the texture. It can be:
  138916. * * TextureDome.MODE_MONOSCOPIC : Define the texture source as a Monoscopic panoramic 360.
  138917. * * TextureDome.MODE_TOPBOTTOM : Define the texture source as a Stereoscopic TopBottom/OverUnder panoramic 360.
  138918. * * TextureDome.MODE_SIDEBYSIDE : Define the texture source as a Stereoscopic Side by Side panoramic 360.
  138919. */
  138920. set textureMode(value: number);
  138921. /**
  138922. * Is it a 180 degrees dome (half dome) or 360 texture (full dome)
  138923. */
  138924. get halfDome(): boolean;
  138925. /**
  138926. * Set the halfDome mode. If set, only the front (180 degrees) will be displayed and the back will be blacked out.
  138927. */
  138928. set halfDome(enabled: boolean);
  138929. /**
  138930. * Set the cross-eye mode. If set, images that can be seen when crossing eyes will render correctly
  138931. */
  138932. set crossEye(enabled: boolean);
  138933. /**
  138934. * Is it a cross-eye texture?
  138935. */
  138936. get crossEye(): boolean;
  138937. /**
  138938. * The background material of this dome.
  138939. */
  138940. get material(): BackgroundMaterial;
  138941. /**
  138942. * Oberserver used in Stereoscopic VR Mode.
  138943. */
  138944. private _onBeforeCameraRenderObserver;
  138945. /**
  138946. * Observable raised when an error occured while loading the 360 image
  138947. */
  138948. onLoadErrorObservable: Observable<string>;
  138949. /**
  138950. * Create an instance of this class and pass through the parameters to the relevant classes- Texture, StandardMaterial, and Mesh.
  138951. * @param name Element's name, child elements will append suffixes for their own names.
  138952. * @param textureUrlOrElement defines the url(s) or the (video) HTML element to use
  138953. * @param options An object containing optional or exposed sub element properties
  138954. */
  138955. constructor(name: string, textureUrlOrElement: string | string[] | HTMLVideoElement, options: {
  138956. resolution?: number;
  138957. clickToPlay?: boolean;
  138958. autoPlay?: boolean;
  138959. loop?: boolean;
  138960. size?: number;
  138961. poster?: string;
  138962. faceForward?: boolean;
  138963. useDirectMapping?: boolean;
  138964. halfDomeMode?: boolean;
  138965. crossEyeMode?: boolean;
  138966. generateMipMaps?: boolean;
  138967. }, scene: Scene, onError?: Nullable<(message?: string, exception?: any) => void>);
  138968. protected abstract _initTexture(urlsOrElement: string | string[] | HTMLElement, scene: Scene, options: any): T;
  138969. protected _changeTextureMode(value: number): void;
  138970. /**
  138971. * Releases resources associated with this node.
  138972. * @param doNotRecurse Set to true to not recurse into each children (recurse into each children by default)
  138973. * @param disposeMaterialAndTextures Set to true to also dispose referenced materials and textures (false by default)
  138974. */
  138975. dispose(doNotRecurse?: boolean, disposeMaterialAndTextures?: boolean): void;
  138976. }
  138977. }
  138978. declare module BABYLON {
  138979. /**
  138980. * Display a 360 degree photo on an approximately spherical surface, useful for VR applications or skyboxes.
  138981. * As a subclass of TransformNode, this allow parenting to the camera with different locations in the scene.
  138982. * This class achieves its effect with a Texture and a correctly configured BackgroundMaterial on an inverted sphere.
  138983. * Potential additions to this helper include zoom and and non-infinite distance rendering effects.
  138984. */
  138985. export class PhotoDome extends TextureDome<Texture> {
  138986. /**
  138987. * Define the image as a Monoscopic panoramic 360 image.
  138988. */
  138989. static readonly MODE_MONOSCOPIC: number;
  138990. /**
  138991. * Define the image as a Stereoscopic TopBottom/OverUnder panoramic 360 image.
  138992. */
  138993. static readonly MODE_TOPBOTTOM: number;
  138994. /**
  138995. * Define the image as a Stereoscopic Side by Side panoramic 360 image.
  138996. */
  138997. static readonly MODE_SIDEBYSIDE: number;
  138998. /**
  138999. * Gets or sets the texture being displayed on the sphere
  139000. */
  139001. get photoTexture(): Texture;
  139002. /**
  139003. * sets the texture being displayed on the sphere
  139004. */
  139005. set photoTexture(value: Texture);
  139006. /**
  139007. * Gets the current video mode for the video. It can be:
  139008. * * TextureDome.MODE_MONOSCOPIC : Define the texture source as a Monoscopic panoramic 360.
  139009. * * TextureDome.MODE_TOPBOTTOM : Define the texture source as a Stereoscopic TopBottom/OverUnder panoramic 360.
  139010. * * TextureDome.MODE_SIDEBYSIDE : Define the texture source as a Stereoscopic Side by Side panoramic 360.
  139011. */
  139012. get imageMode(): number;
  139013. /**
  139014. * Sets the current video mode for the video. It can be:
  139015. * * TextureDome.MODE_MONOSCOPIC : Define the texture source as a Monoscopic panoramic 360.
  139016. * * TextureDome.MODE_TOPBOTTOM : Define the texture source as a Stereoscopic TopBottom/OverUnder panoramic 360.
  139017. * * TextureDome.MODE_SIDEBYSIDE : Define the texture source as a Stereoscopic Side by Side panoramic 360.
  139018. */
  139019. set imageMode(value: number);
  139020. protected _initTexture(urlsOrElement: string, scene: Scene, options: any): Texture;
  139021. }
  139022. }
  139023. declare module BABYLON {
  139024. /**
  139025. * Direct draw surface info
  139026. * @see https://docs.microsoft.com/en-us/windows/desktop/direct3ddds/dx-graphics-dds-pguide
  139027. */
  139028. export interface DDSInfo {
  139029. /**
  139030. * Width of the texture
  139031. */
  139032. width: number;
  139033. /**
  139034. * Width of the texture
  139035. */
  139036. height: number;
  139037. /**
  139038. * Number of Mipmaps for the texture
  139039. * @see https://en.wikipedia.org/wiki/Mipmap
  139040. */
  139041. mipmapCount: number;
  139042. /**
  139043. * If the textures format is a known fourCC format
  139044. * @see https://www.fourcc.org/
  139045. */
  139046. isFourCC: boolean;
  139047. /**
  139048. * If the texture is an RGB format eg. DXGI_FORMAT_B8G8R8X8_UNORM format
  139049. */
  139050. isRGB: boolean;
  139051. /**
  139052. * If the texture is a lumincance format
  139053. */
  139054. isLuminance: boolean;
  139055. /**
  139056. * If this is a cube texture
  139057. * @see https://docs.microsoft.com/en-us/windows/desktop/direct3ddds/dds-file-layout-for-cubic-environment-maps
  139058. */
  139059. isCube: boolean;
  139060. /**
  139061. * If the texture is a compressed format eg. FOURCC_DXT1
  139062. */
  139063. isCompressed: boolean;
  139064. /**
  139065. * The dxgiFormat of the texture
  139066. * @see https://docs.microsoft.com/en-us/windows/desktop/api/dxgiformat/ne-dxgiformat-dxgi_format
  139067. */
  139068. dxgiFormat: number;
  139069. /**
  139070. * Texture type eg. Engine.TEXTURETYPE_UNSIGNED_INT, Engine.TEXTURETYPE_FLOAT
  139071. */
  139072. textureType: number;
  139073. /**
  139074. * Sphericle polynomial created for the dds texture
  139075. */
  139076. sphericalPolynomial?: SphericalPolynomial;
  139077. }
  139078. /**
  139079. * Class used to provide DDS decompression tools
  139080. */
  139081. export class DDSTools {
  139082. /**
  139083. * Gets or sets a boolean indicating that LOD info is stored in alpha channel (false by default)
  139084. */
  139085. static StoreLODInAlphaChannel: boolean;
  139086. /**
  139087. * Gets DDS information from an array buffer
  139088. * @param data defines the array buffer view to read data from
  139089. * @returns the DDS information
  139090. */
  139091. static GetDDSInfo(data: ArrayBufferView): DDSInfo;
  139092. private static _FloatView;
  139093. private static _Int32View;
  139094. private static _ToHalfFloat;
  139095. private static _FromHalfFloat;
  139096. private static _GetHalfFloatAsFloatRGBAArrayBuffer;
  139097. private static _GetHalfFloatRGBAArrayBuffer;
  139098. private static _GetFloatRGBAArrayBuffer;
  139099. private static _GetFloatAsUIntRGBAArrayBuffer;
  139100. private static _GetHalfFloatAsUIntRGBAArrayBuffer;
  139101. private static _GetRGBAArrayBuffer;
  139102. private static _ExtractLongWordOrder;
  139103. private static _GetRGBArrayBuffer;
  139104. private static _GetLuminanceArrayBuffer;
  139105. /**
  139106. * Uploads DDS Levels to a Babylon Texture
  139107. * @hidden
  139108. */
  139109. static UploadDDSLevels(engine: ThinEngine, texture: InternalTexture, data: ArrayBufferView, info: DDSInfo, loadMipmaps: boolean, faces: number, lodIndex?: number, currentFace?: number): void;
  139110. }
  139111. interface ThinEngine {
  139112. /**
  139113. * Create a cube texture from prefiltered data (ie. the mipmaps contain ready to use data for PBR reflection)
  139114. * @param rootUrl defines the url where the file to load is located
  139115. * @param scene defines the current scene
  139116. * @param lodScale defines scale to apply to the mip map selection
  139117. * @param lodOffset defines offset to apply to the mip map selection
  139118. * @param onLoad defines an optional callback raised when the texture is loaded
  139119. * @param onError defines an optional callback raised if there is an issue to load the texture
  139120. * @param format defines the format of the data
  139121. * @param forcedExtension defines the extension to use to pick the right loader
  139122. * @param createPolynomials defines wheter or not to create polynomails harmonics for the texture
  139123. * @returns the cube texture as an InternalTexture
  139124. */
  139125. 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;
  139126. }
  139127. }
  139128. declare module BABYLON {
  139129. /**
  139130. * Implementation of the DDS Texture Loader.
  139131. * @hidden
  139132. */
  139133. export class _DDSTextureLoader implements IInternalTextureLoader {
  139134. /**
  139135. * Defines wether the loader supports cascade loading the different faces.
  139136. */
  139137. readonly supportCascades: boolean;
  139138. /**
  139139. * This returns if the loader support the current file information.
  139140. * @param extension defines the file extension of the file being loaded
  139141. * @returns true if the loader can load the specified file
  139142. */
  139143. canLoad(extension: string): boolean;
  139144. /**
  139145. * Uploads the cube texture data to the WebGL texture. It has already been bound.
  139146. * @param data contains the texture data
  139147. * @param texture defines the BabylonJS internal texture
  139148. * @param createPolynomials will be true if polynomials have been requested
  139149. * @param onLoad defines the callback to trigger once the texture is ready
  139150. * @param onError defines the callback to trigger in case of error
  139151. */
  139152. loadCubeData(imgs: ArrayBufferView | ArrayBufferView[], texture: InternalTexture, createPolynomials: boolean, onLoad: Nullable<(data?: any) => void>, onError: Nullable<(message?: string, exception?: any) => void>): void;
  139153. /**
  139154. * Uploads the 2D texture data to the WebGL texture. It has already been bound once in the callback.
  139155. * @param data contains the texture data
  139156. * @param texture defines the BabylonJS internal texture
  139157. * @param callback defines the method to call once ready to upload
  139158. */
  139159. loadData(data: ArrayBufferView, texture: InternalTexture, callback: (width: number, height: number, loadMipmap: boolean, isCompressed: boolean, done: () => void) => void): void;
  139160. }
  139161. }
  139162. declare module BABYLON {
  139163. /**
  139164. * Implementation of the ENV Texture Loader.
  139165. * @hidden
  139166. */
  139167. export class _ENVTextureLoader implements IInternalTextureLoader {
  139168. /**
  139169. * Defines wether the loader supports cascade loading the different faces.
  139170. */
  139171. readonly supportCascades: boolean;
  139172. /**
  139173. * This returns if the loader support the current file information.
  139174. * @param extension defines the file extension of the file being loaded
  139175. * @returns true if the loader can load the specified file
  139176. */
  139177. canLoad(extension: string): boolean;
  139178. /**
  139179. * Uploads the cube texture data to the WebGL texture. It has already been bound.
  139180. * @param data contains the texture data
  139181. * @param texture defines the BabylonJS internal texture
  139182. * @param createPolynomials will be true if polynomials have been requested
  139183. * @param onLoad defines the callback to trigger once the texture is ready
  139184. * @param onError defines the callback to trigger in case of error
  139185. */
  139186. loadCubeData(data: ArrayBufferView | ArrayBufferView[], texture: InternalTexture, createPolynomials: boolean, onLoad: Nullable<(data?: any) => void>, onError: Nullable<(message?: string, exception?: any) => void>): void;
  139187. /**
  139188. * Uploads the 2D texture data to the WebGL texture. It has already been bound once in the callback.
  139189. * @param data contains the texture data
  139190. * @param texture defines the BabylonJS internal texture
  139191. * @param callback defines the method to call once ready to upload
  139192. */
  139193. loadData(data: ArrayBufferView, texture: InternalTexture, callback: (width: number, height: number, loadMipmap: boolean, isCompressed: boolean, done: () => void) => void): void;
  139194. }
  139195. }
  139196. declare module BABYLON {
  139197. /**
  139198. * for description see https://www.khronos.org/opengles/sdk/tools/KTX/
  139199. * for file layout see https://www.khronos.org/opengles/sdk/tools/KTX/file_format_spec/
  139200. */
  139201. export class KhronosTextureContainer {
  139202. /** contents of the KTX container file */
  139203. data: ArrayBufferView;
  139204. private static HEADER_LEN;
  139205. private static COMPRESSED_2D;
  139206. private static COMPRESSED_3D;
  139207. private static TEX_2D;
  139208. private static TEX_3D;
  139209. /**
  139210. * Gets the openGL type
  139211. */
  139212. glType: number;
  139213. /**
  139214. * Gets the openGL type size
  139215. */
  139216. glTypeSize: number;
  139217. /**
  139218. * Gets the openGL format
  139219. */
  139220. glFormat: number;
  139221. /**
  139222. * Gets the openGL internal format
  139223. */
  139224. glInternalFormat: number;
  139225. /**
  139226. * Gets the base internal format
  139227. */
  139228. glBaseInternalFormat: number;
  139229. /**
  139230. * Gets image width in pixel
  139231. */
  139232. pixelWidth: number;
  139233. /**
  139234. * Gets image height in pixel
  139235. */
  139236. pixelHeight: number;
  139237. /**
  139238. * Gets image depth in pixels
  139239. */
  139240. pixelDepth: number;
  139241. /**
  139242. * Gets the number of array elements
  139243. */
  139244. numberOfArrayElements: number;
  139245. /**
  139246. * Gets the number of faces
  139247. */
  139248. numberOfFaces: number;
  139249. /**
  139250. * Gets the number of mipmap levels
  139251. */
  139252. numberOfMipmapLevels: number;
  139253. /**
  139254. * Gets the bytes of key value data
  139255. */
  139256. bytesOfKeyValueData: number;
  139257. /**
  139258. * Gets the load type
  139259. */
  139260. loadType: number;
  139261. /**
  139262. * If the container has been made invalid (eg. constructor failed to correctly load array buffer)
  139263. */
  139264. isInvalid: boolean;
  139265. /**
  139266. * Creates a new KhronosTextureContainer
  139267. * @param data contents of the KTX container file
  139268. * @param facesExpected should be either 1 or 6, based whether a cube texture or or
  139269. * @param threeDExpected provision for indicating that data should be a 3D texture, not implemented
  139270. * @param textureArrayExpected provision for indicating that data should be a texture array, not implemented
  139271. */
  139272. constructor(
  139273. /** contents of the KTX container file */
  139274. data: ArrayBufferView, facesExpected: number, threeDExpected?: boolean, textureArrayExpected?: boolean);
  139275. /**
  139276. * Uploads KTX content to a Babylon Texture.
  139277. * It is assumed that the texture has already been created & is currently bound
  139278. * @hidden
  139279. */
  139280. uploadLevels(texture: InternalTexture, loadMipmaps: boolean): void;
  139281. private _upload2DCompressedLevels;
  139282. /**
  139283. * Checks if the given data starts with a KTX file identifier.
  139284. * @param data the data to check
  139285. * @returns true if the data is a KTX file or false otherwise
  139286. */
  139287. static IsValid(data: ArrayBufferView): boolean;
  139288. }
  139289. }
  139290. declare module BABYLON {
  139291. /**
  139292. * Helper class to push actions to a pool of workers.
  139293. */
  139294. export class WorkerPool implements IDisposable {
  139295. private _workerInfos;
  139296. private _pendingActions;
  139297. /**
  139298. * Constructor
  139299. * @param workers Array of workers to use for actions
  139300. */
  139301. constructor(workers: Array<Worker>);
  139302. /**
  139303. * Terminates all workers and clears any pending actions.
  139304. */
  139305. dispose(): void;
  139306. /**
  139307. * Pushes an action to the worker pool. If all the workers are active, the action will be
  139308. * pended until a worker has completed its action.
  139309. * @param action The action to perform. Call onComplete when the action is complete.
  139310. */
  139311. push(action: (worker: Worker, onComplete: () => void) => void): void;
  139312. private _execute;
  139313. }
  139314. }
  139315. declare module BABYLON {
  139316. /**
  139317. * Class for loading KTX2 files
  139318. */
  139319. export class KhronosTextureContainer2 {
  139320. private static _WorkerPoolPromise?;
  139321. private static _Initialized;
  139322. private static _Ktx2Decoder;
  139323. /**
  139324. * URLs to use when loading the KTX2 decoder module as well as its dependencies
  139325. * If a url is null, the default url is used (pointing to https://preview.babylonjs.com)
  139326. * Note that jsDecoderModule can't be null and that the other dependencies will only be loaded if necessary
  139327. * Urls you can change:
  139328. * URLConfig.jsDecoderModule
  139329. * URLConfig.wasmUASTCToASTC
  139330. * URLConfig.wasmUASTCToBC7
  139331. * URLConfig.jsMSCTranscoder
  139332. * URLConfig.wasmMSCTranscoder
  139333. * You can see their default values in this PG: https://playground.babylonjs.com/#EIJH8L#9
  139334. */
  139335. static URLConfig: {
  139336. jsDecoderModule: string;
  139337. wasmUASTCToASTC: null;
  139338. wasmUASTCToBC7: null;
  139339. jsMSCTranscoder: null;
  139340. wasmMSCTranscoder: null;
  139341. };
  139342. /**
  139343. * Default number of workers used to handle data decoding
  139344. */
  139345. static DefaultNumWorkers: number;
  139346. private static GetDefaultNumWorkers;
  139347. private _engine;
  139348. private static _CreateWorkerPool;
  139349. /**
  139350. * Constructor
  139351. * @param engine The engine to use
  139352. * @param numWorkers The number of workers for async operations. Specify `0` to disable web workers and run synchronously in the current context.
  139353. */
  139354. constructor(engine: ThinEngine, numWorkers?: number);
  139355. /** @hidden */
  139356. uploadAsync(data: ArrayBufferView, internalTexture: InternalTexture): Promise<void>;
  139357. /**
  139358. * Stop all async operations and release resources.
  139359. */
  139360. dispose(): void;
  139361. protected _createTexture(data: any, internalTexture: InternalTexture): void;
  139362. /**
  139363. * Checks if the given data starts with a KTX2 file identifier.
  139364. * @param data the data to check
  139365. * @returns true if the data is a KTX2 file or false otherwise
  139366. */
  139367. static IsValid(data: ArrayBufferView): boolean;
  139368. }
  139369. }
  139370. declare module BABYLON {
  139371. /**
  139372. * Implementation of the KTX Texture Loader.
  139373. * @hidden
  139374. */
  139375. export class _KTXTextureLoader implements IInternalTextureLoader {
  139376. /**
  139377. * Defines wether the loader supports cascade loading the different faces.
  139378. */
  139379. readonly supportCascades: boolean;
  139380. /**
  139381. * This returns if the loader support the current file information.
  139382. * @param extension defines the file extension of the file being loaded
  139383. * @param mimeType defines the optional mime type of the file being loaded
  139384. * @returns true if the loader can load the specified file
  139385. */
  139386. canLoad(extension: string, mimeType?: string): boolean;
  139387. /**
  139388. * Uploads the cube texture data to the WebGL texture. It has already been bound.
  139389. * @param data contains the texture data
  139390. * @param texture defines the BabylonJS internal texture
  139391. * @param createPolynomials will be true if polynomials have been requested
  139392. * @param onLoad defines the callback to trigger once the texture is ready
  139393. * @param onError defines the callback to trigger in case of error
  139394. */
  139395. loadCubeData(data: ArrayBufferView | ArrayBufferView[], texture: InternalTexture, createPolynomials: boolean, onLoad: Nullable<(data?: any) => void>, onError: Nullable<(message?: string, exception?: any) => void>): void;
  139396. /**
  139397. * Uploads the 2D texture data to the WebGL texture. It has already been bound once in the callback.
  139398. * @param data contains the texture data
  139399. * @param texture defines the BabylonJS internal texture
  139400. * @param callback defines the method to call once ready to upload
  139401. */
  139402. loadData(data: ArrayBufferView, texture: InternalTexture, callback: (width: number, height: number, loadMipmap: boolean, isCompressed: boolean, done: () => void, loadFailed: boolean) => void): void;
  139403. }
  139404. }
  139405. declare module BABYLON {
  139406. /** @hidden */
  139407. export var _forceSceneHelpersToBundle: boolean;
  139408. interface Scene {
  139409. /**
  139410. * Creates a default light for the scene.
  139411. * @see https://doc.babylonjs.com/How_To/Fast_Build#create-default-light
  139412. * @param replace has the default false, when true replaces the existing lights in the scene with a hemispheric light
  139413. */
  139414. createDefaultLight(replace?: boolean): void;
  139415. /**
  139416. * Creates a default camera for the scene.
  139417. * @see https://doc.babylonjs.com/How_To/Fast_Build#create-default-camera
  139418. * @param createArcRotateCamera has the default false which creates a free camera, when true creates an arc rotate camera
  139419. * @param replace has default false, when true replaces the active camera in the scene
  139420. * @param attachCameraControls has default false, when true attaches camera controls to the canvas.
  139421. */
  139422. createDefaultCamera(createArcRotateCamera?: boolean, replace?: boolean, attachCameraControls?: boolean): void;
  139423. /**
  139424. * Creates a default camera and a default light.
  139425. * @see https://doc.babylonjs.com/how_to/Fast_Build#create-default-camera-or-light
  139426. * @param createArcRotateCamera has the default false which creates a free camera, when true creates an arc rotate camera
  139427. * @param replace has the default false, when true replaces the active camera/light in the scene
  139428. * @param attachCameraControls has the default false, when true attaches camera controls to the canvas.
  139429. */
  139430. createDefaultCameraOrLight(createArcRotateCamera?: boolean, replace?: boolean, attachCameraControls?: boolean): void;
  139431. /**
  139432. * Creates a new sky box
  139433. * @see https://doc.babylonjs.com/how_to/Fast_Build#create-default-skybox
  139434. * @param environmentTexture defines the texture to use as environment texture
  139435. * @param pbr has default false which requires the StandardMaterial to be used, when true PBRMaterial must be used
  139436. * @param scale defines the overall scale of the skybox
  139437. * @param blur is only available when pbr is true, default is 0, no blur, maximum value is 1
  139438. * @param setGlobalEnvTexture has default true indicating that scene.environmentTexture must match the current skybox texture
  139439. * @returns a new mesh holding the sky box
  139440. */
  139441. createDefaultSkybox(environmentTexture?: BaseTexture, pbr?: boolean, scale?: number, blur?: number, setGlobalEnvTexture?: boolean): Nullable<Mesh>;
  139442. /**
  139443. * Creates a new environment
  139444. * @see https://doc.babylonjs.com/How_To/Fast_Build#create-default-environment
  139445. * @param options defines the options you can use to configure the environment
  139446. * @returns the new EnvironmentHelper
  139447. */
  139448. createDefaultEnvironment(options?: Partial<IEnvironmentHelperOptions>): Nullable<EnvironmentHelper>;
  139449. /**
  139450. * Creates a new VREXperienceHelper
  139451. * @see https://doc.babylonjs.com/how_to/webvr_helper
  139452. * @param webVROptions defines the options used to create the new VREXperienceHelper
  139453. * @returns a new VREXperienceHelper
  139454. */
  139455. createDefaultVRExperience(webVROptions?: VRExperienceHelperOptions): VRExperienceHelper;
  139456. /**
  139457. * Creates a new WebXRDefaultExperience
  139458. * @see https://doc.babylonjs.com/how_to/introduction_to_webxr
  139459. * @param options experience options
  139460. * @returns a promise for a new WebXRDefaultExperience
  139461. */
  139462. createDefaultXRExperienceAsync(options: WebXRDefaultExperienceOptions): Promise<WebXRDefaultExperience>;
  139463. }
  139464. }
  139465. declare module BABYLON {
  139466. /**
  139467. * Display a 360/180 degree video on an approximately spherical surface, useful for VR applications or skyboxes.
  139468. * As a subclass of TransformNode, this allow parenting to the camera or multiple videos with different locations in the scene.
  139469. * This class achieves its effect with a VideoTexture and a correctly configured BackgroundMaterial on an inverted sphere.
  139470. * Potential additions to this helper include zoom and and non-infinite distance rendering effects.
  139471. */
  139472. export class VideoDome extends TextureDome<VideoTexture> {
  139473. /**
  139474. * Define the video source as a Monoscopic panoramic 360 video.
  139475. */
  139476. static readonly MODE_MONOSCOPIC: number;
  139477. /**
  139478. * Define the video source as a Stereoscopic TopBottom/OverUnder panoramic 360 video.
  139479. */
  139480. static readonly MODE_TOPBOTTOM: number;
  139481. /**
  139482. * Define the video source as a Stereoscopic Side by Side panoramic 360 video.
  139483. */
  139484. static readonly MODE_SIDEBYSIDE: number;
  139485. /**
  139486. * Get the video texture associated with this video dome
  139487. */
  139488. get videoTexture(): VideoTexture;
  139489. /**
  139490. * Get the video mode of this dome
  139491. */
  139492. get videoMode(): number;
  139493. /**
  139494. * Set the video mode of this dome.
  139495. * @see textureMode
  139496. */
  139497. set videoMode(value: number);
  139498. protected _initTexture(urlsOrElement: string | string[] | HTMLVideoElement, scene: Scene, options: any): VideoTexture;
  139499. }
  139500. }
  139501. declare module BABYLON {
  139502. /**
  139503. * This class can be used to get instrumentation data from a Babylon engine
  139504. * @see https://doc.babylonjs.com/how_to/optimizing_your_scene#engineinstrumentation
  139505. */
  139506. export class EngineInstrumentation implements IDisposable {
  139507. /**
  139508. * Define the instrumented engine.
  139509. */
  139510. engine: Engine;
  139511. private _captureGPUFrameTime;
  139512. private _gpuFrameTimeToken;
  139513. private _gpuFrameTime;
  139514. private _captureShaderCompilationTime;
  139515. private _shaderCompilationTime;
  139516. private _onBeginFrameObserver;
  139517. private _onEndFrameObserver;
  139518. private _onBeforeShaderCompilationObserver;
  139519. private _onAfterShaderCompilationObserver;
  139520. /**
  139521. * Gets the perf counter used for GPU frame time
  139522. */
  139523. get gpuFrameTimeCounter(): PerfCounter;
  139524. /**
  139525. * Gets the GPU frame time capture status
  139526. */
  139527. get captureGPUFrameTime(): boolean;
  139528. /**
  139529. * Enable or disable the GPU frame time capture
  139530. */
  139531. set captureGPUFrameTime(value: boolean);
  139532. /**
  139533. * Gets the perf counter used for shader compilation time
  139534. */
  139535. get shaderCompilationTimeCounter(): PerfCounter;
  139536. /**
  139537. * Gets the shader compilation time capture status
  139538. */
  139539. get captureShaderCompilationTime(): boolean;
  139540. /**
  139541. * Enable or disable the shader compilation time capture
  139542. */
  139543. set captureShaderCompilationTime(value: boolean);
  139544. /**
  139545. * Instantiates a new engine instrumentation.
  139546. * This class can be used to get instrumentation data from a Babylon engine
  139547. * @see https://doc.babylonjs.com/how_to/optimizing_your_scene#engineinstrumentation
  139548. * @param engine Defines the engine to instrument
  139549. */
  139550. constructor(
  139551. /**
  139552. * Define the instrumented engine.
  139553. */
  139554. engine: Engine);
  139555. /**
  139556. * Dispose and release associated resources.
  139557. */
  139558. dispose(): void;
  139559. }
  139560. }
  139561. declare module BABYLON {
  139562. /**
  139563. * This class can be used to get instrumentation data from a Babylon engine
  139564. * @see https://doc.babylonjs.com/how_to/optimizing_your_scene#sceneinstrumentation
  139565. */
  139566. export class SceneInstrumentation implements IDisposable {
  139567. /**
  139568. * Defines the scene to instrument
  139569. */
  139570. scene: Scene;
  139571. private _captureActiveMeshesEvaluationTime;
  139572. private _activeMeshesEvaluationTime;
  139573. private _captureRenderTargetsRenderTime;
  139574. private _renderTargetsRenderTime;
  139575. private _captureFrameTime;
  139576. private _frameTime;
  139577. private _captureRenderTime;
  139578. private _renderTime;
  139579. private _captureInterFrameTime;
  139580. private _interFrameTime;
  139581. private _captureParticlesRenderTime;
  139582. private _particlesRenderTime;
  139583. private _captureSpritesRenderTime;
  139584. private _spritesRenderTime;
  139585. private _capturePhysicsTime;
  139586. private _physicsTime;
  139587. private _captureAnimationsTime;
  139588. private _animationsTime;
  139589. private _captureCameraRenderTime;
  139590. private _cameraRenderTime;
  139591. private _onBeforeActiveMeshesEvaluationObserver;
  139592. private _onAfterActiveMeshesEvaluationObserver;
  139593. private _onBeforeRenderTargetsRenderObserver;
  139594. private _onAfterRenderTargetsRenderObserver;
  139595. private _onAfterRenderObserver;
  139596. private _onBeforeDrawPhaseObserver;
  139597. private _onAfterDrawPhaseObserver;
  139598. private _onBeforeAnimationsObserver;
  139599. private _onBeforeParticlesRenderingObserver;
  139600. private _onAfterParticlesRenderingObserver;
  139601. private _onBeforeSpritesRenderingObserver;
  139602. private _onAfterSpritesRenderingObserver;
  139603. private _onBeforePhysicsObserver;
  139604. private _onAfterPhysicsObserver;
  139605. private _onAfterAnimationsObserver;
  139606. private _onBeforeCameraRenderObserver;
  139607. private _onAfterCameraRenderObserver;
  139608. /**
  139609. * Gets the perf counter used for active meshes evaluation time
  139610. */
  139611. get activeMeshesEvaluationTimeCounter(): PerfCounter;
  139612. /**
  139613. * Gets the active meshes evaluation time capture status
  139614. */
  139615. get captureActiveMeshesEvaluationTime(): boolean;
  139616. /**
  139617. * Enable or disable the active meshes evaluation time capture
  139618. */
  139619. set captureActiveMeshesEvaluationTime(value: boolean);
  139620. /**
  139621. * Gets the perf counter used for render targets render time
  139622. */
  139623. get renderTargetsRenderTimeCounter(): PerfCounter;
  139624. /**
  139625. * Gets the render targets render time capture status
  139626. */
  139627. get captureRenderTargetsRenderTime(): boolean;
  139628. /**
  139629. * Enable or disable the render targets render time capture
  139630. */
  139631. set captureRenderTargetsRenderTime(value: boolean);
  139632. /**
  139633. * Gets the perf counter used for particles render time
  139634. */
  139635. get particlesRenderTimeCounter(): PerfCounter;
  139636. /**
  139637. * Gets the particles render time capture status
  139638. */
  139639. get captureParticlesRenderTime(): boolean;
  139640. /**
  139641. * Enable or disable the particles render time capture
  139642. */
  139643. set captureParticlesRenderTime(value: boolean);
  139644. /**
  139645. * Gets the perf counter used for sprites render time
  139646. */
  139647. get spritesRenderTimeCounter(): PerfCounter;
  139648. /**
  139649. * Gets the sprites render time capture status
  139650. */
  139651. get captureSpritesRenderTime(): boolean;
  139652. /**
  139653. * Enable or disable the sprites render time capture
  139654. */
  139655. set captureSpritesRenderTime(value: boolean);
  139656. /**
  139657. * Gets the perf counter used for physics time
  139658. */
  139659. get physicsTimeCounter(): PerfCounter;
  139660. /**
  139661. * Gets the physics time capture status
  139662. */
  139663. get capturePhysicsTime(): boolean;
  139664. /**
  139665. * Enable or disable the physics time capture
  139666. */
  139667. set capturePhysicsTime(value: boolean);
  139668. /**
  139669. * Gets the perf counter used for animations time
  139670. */
  139671. get animationsTimeCounter(): PerfCounter;
  139672. /**
  139673. * Gets the animations time capture status
  139674. */
  139675. get captureAnimationsTime(): boolean;
  139676. /**
  139677. * Enable or disable the animations time capture
  139678. */
  139679. set captureAnimationsTime(value: boolean);
  139680. /**
  139681. * Gets the perf counter used for frame time capture
  139682. */
  139683. get frameTimeCounter(): PerfCounter;
  139684. /**
  139685. * Gets the frame time capture status
  139686. */
  139687. get captureFrameTime(): boolean;
  139688. /**
  139689. * Enable or disable the frame time capture
  139690. */
  139691. set captureFrameTime(value: boolean);
  139692. /**
  139693. * Gets the perf counter used for inter-frames time capture
  139694. */
  139695. get interFrameTimeCounter(): PerfCounter;
  139696. /**
  139697. * Gets the inter-frames time capture status
  139698. */
  139699. get captureInterFrameTime(): boolean;
  139700. /**
  139701. * Enable or disable the inter-frames time capture
  139702. */
  139703. set captureInterFrameTime(value: boolean);
  139704. /**
  139705. * Gets the perf counter used for render time capture
  139706. */
  139707. get renderTimeCounter(): PerfCounter;
  139708. /**
  139709. * Gets the render time capture status
  139710. */
  139711. get captureRenderTime(): boolean;
  139712. /**
  139713. * Enable or disable the render time capture
  139714. */
  139715. set captureRenderTime(value: boolean);
  139716. /**
  139717. * Gets the perf counter used for camera render time capture
  139718. */
  139719. get cameraRenderTimeCounter(): PerfCounter;
  139720. /**
  139721. * Gets the camera render time capture status
  139722. */
  139723. get captureCameraRenderTime(): boolean;
  139724. /**
  139725. * Enable or disable the camera render time capture
  139726. */
  139727. set captureCameraRenderTime(value: boolean);
  139728. /**
  139729. * Gets the perf counter used for draw calls
  139730. */
  139731. get drawCallsCounter(): PerfCounter;
  139732. /**
  139733. * Instantiates a new scene instrumentation.
  139734. * This class can be used to get instrumentation data from a Babylon engine
  139735. * @see https://doc.babylonjs.com/how_to/optimizing_your_scene#sceneinstrumentation
  139736. * @param scene Defines the scene to instrument
  139737. */
  139738. constructor(
  139739. /**
  139740. * Defines the scene to instrument
  139741. */
  139742. scene: Scene);
  139743. /**
  139744. * Dispose and release associated resources.
  139745. */
  139746. dispose(): void;
  139747. }
  139748. }
  139749. declare module BABYLON {
  139750. /** @hidden */
  139751. export var glowMapGenerationPixelShader: {
  139752. name: string;
  139753. shader: string;
  139754. };
  139755. }
  139756. declare module BABYLON {
  139757. /** @hidden */
  139758. export var glowMapGenerationVertexShader: {
  139759. name: string;
  139760. shader: string;
  139761. };
  139762. }
  139763. declare module BABYLON {
  139764. /**
  139765. * Effect layer options. This helps customizing the behaviour
  139766. * of the effect layer.
  139767. */
  139768. export interface IEffectLayerOptions {
  139769. /**
  139770. * Multiplication factor apply to the canvas size to compute the render target size
  139771. * used to generated the objects (the smaller the faster).
  139772. */
  139773. mainTextureRatio: number;
  139774. /**
  139775. * Enforces a fixed size texture to ensure effect stability across devices.
  139776. */
  139777. mainTextureFixedSize?: number;
  139778. /**
  139779. * Alpha blending mode used to apply the blur. Default depends of the implementation.
  139780. */
  139781. alphaBlendingMode: number;
  139782. /**
  139783. * The camera attached to the layer.
  139784. */
  139785. camera: Nullable<Camera>;
  139786. /**
  139787. * The rendering group to draw the layer in.
  139788. */
  139789. renderingGroupId: number;
  139790. }
  139791. /**
  139792. * The effect layer Helps adding post process effect blended with the main pass.
  139793. *
  139794. * This can be for instance use to generate glow or higlight effects on the scene.
  139795. *
  139796. * The effect layer class can not be used directly and is intented to inherited from to be
  139797. * customized per effects.
  139798. */
  139799. export abstract class EffectLayer {
  139800. private _vertexBuffers;
  139801. private _indexBuffer;
  139802. private _cachedDefines;
  139803. private _effectLayerMapGenerationEffect;
  139804. private _effectLayerOptions;
  139805. private _mergeEffect;
  139806. protected _scene: Scene;
  139807. protected _engine: Engine;
  139808. protected _maxSize: number;
  139809. protected _mainTextureDesiredSize: ISize;
  139810. protected _mainTexture: RenderTargetTexture;
  139811. protected _shouldRender: boolean;
  139812. protected _postProcesses: PostProcess[];
  139813. protected _textures: BaseTexture[];
  139814. protected _emissiveTextureAndColor: {
  139815. texture: Nullable<BaseTexture>;
  139816. color: Color4;
  139817. };
  139818. /**
  139819. * The name of the layer
  139820. */
  139821. name: string;
  139822. /**
  139823. * The clear color of the texture used to generate the glow map.
  139824. */
  139825. neutralColor: Color4;
  139826. /**
  139827. * Specifies whether the highlight layer is enabled or not.
  139828. */
  139829. isEnabled: boolean;
  139830. /**
  139831. * Gets the camera attached to the layer.
  139832. */
  139833. get camera(): Nullable<Camera>;
  139834. /**
  139835. * Gets the rendering group id the layer should render in.
  139836. */
  139837. get renderingGroupId(): number;
  139838. set renderingGroupId(renderingGroupId: number);
  139839. /**
  139840. * An event triggered when the effect layer has been disposed.
  139841. */
  139842. onDisposeObservable: Observable<EffectLayer>;
  139843. /**
  139844. * An event triggered when the effect layer is about rendering the main texture with the glowy parts.
  139845. */
  139846. onBeforeRenderMainTextureObservable: Observable<EffectLayer>;
  139847. /**
  139848. * An event triggered when the generated texture is being merged in the scene.
  139849. */
  139850. onBeforeComposeObservable: Observable<EffectLayer>;
  139851. /**
  139852. * An event triggered when the mesh is rendered into the effect render target.
  139853. */
  139854. onBeforeRenderMeshToEffect: Observable<AbstractMesh>;
  139855. /**
  139856. * An event triggered after the mesh has been rendered into the effect render target.
  139857. */
  139858. onAfterRenderMeshToEffect: Observable<AbstractMesh>;
  139859. /**
  139860. * An event triggered when the generated texture has been merged in the scene.
  139861. */
  139862. onAfterComposeObservable: Observable<EffectLayer>;
  139863. /**
  139864. * An event triggered when the efffect layer changes its size.
  139865. */
  139866. onSizeChangedObservable: Observable<EffectLayer>;
  139867. /** @hidden */
  139868. static _SceneComponentInitialization: (scene: Scene) => void;
  139869. /**
  139870. * Instantiates a new effect Layer and references it in the scene.
  139871. * @param name The name of the layer
  139872. * @param scene The scene to use the layer in
  139873. */
  139874. constructor(
  139875. /** The Friendly of the effect in the scene */
  139876. name: string, scene: Scene);
  139877. /**
  139878. * Get the effect name of the layer.
  139879. * @return The effect name
  139880. */
  139881. abstract getEffectName(): string;
  139882. /**
  139883. * Checks for the readiness of the element composing the layer.
  139884. * @param subMesh the mesh to check for
  139885. * @param useInstances specify whether or not to use instances to render the mesh
  139886. * @return true if ready otherwise, false
  139887. */
  139888. abstract isReady(subMesh: SubMesh, useInstances: boolean): boolean;
  139889. /**
  139890. * Returns whether or nood the layer needs stencil enabled during the mesh rendering.
  139891. * @returns true if the effect requires stencil during the main canvas render pass.
  139892. */
  139893. abstract needStencil(): boolean;
  139894. /**
  139895. * Create the merge effect. This is the shader use to blit the information back
  139896. * to the main canvas at the end of the scene rendering.
  139897. * @returns The effect containing the shader used to merge the effect on the main canvas
  139898. */
  139899. protected abstract _createMergeEffect(): Effect;
  139900. /**
  139901. * Creates the render target textures and post processes used in the effect layer.
  139902. */
  139903. protected abstract _createTextureAndPostProcesses(): void;
  139904. /**
  139905. * Implementation specific of rendering the generating effect on the main canvas.
  139906. * @param effect The effect used to render through
  139907. */
  139908. protected abstract _internalRender(effect: Effect): void;
  139909. /**
  139910. * Sets the required values for both the emissive texture and and the main color.
  139911. */
  139912. protected abstract _setEmissiveTextureAndColor(mesh: Mesh, subMesh: SubMesh, material: Material): void;
  139913. /**
  139914. * Free any resources and references associated to a mesh.
  139915. * Internal use
  139916. * @param mesh The mesh to free.
  139917. */
  139918. abstract _disposeMesh(mesh: Mesh): void;
  139919. /**
  139920. * Serializes this layer (Glow or Highlight for example)
  139921. * @returns a serialized layer object
  139922. */
  139923. abstract serialize?(): any;
  139924. /**
  139925. * Initializes the effect layer with the required options.
  139926. * @param options Sets of none mandatory options to use with the layer (see IEffectLayerOptions for more information)
  139927. */
  139928. protected _init(options: Partial<IEffectLayerOptions>): void;
  139929. /**
  139930. * Generates the index buffer of the full screen quad blending to the main canvas.
  139931. */
  139932. private _generateIndexBuffer;
  139933. /**
  139934. * Generates the vertex buffer of the full screen quad blending to the main canvas.
  139935. */
  139936. private _generateVertexBuffer;
  139937. /**
  139938. * Sets the main texture desired size which is the closest power of two
  139939. * of the engine canvas size.
  139940. */
  139941. private _setMainTextureSize;
  139942. /**
  139943. * Creates the main texture for the effect layer.
  139944. */
  139945. protected _createMainTexture(): void;
  139946. /**
  139947. * Adds specific effects defines.
  139948. * @param defines The defines to add specifics to.
  139949. */
  139950. protected _addCustomEffectDefines(defines: string[]): void;
  139951. /**
  139952. * Checks for the readiness of the element composing the layer.
  139953. * @param subMesh the mesh to check for
  139954. * @param useInstances specify whether or not to use instances to render the mesh
  139955. * @param emissiveTexture the associated emissive texture used to generate the glow
  139956. * @return true if ready otherwise, false
  139957. */
  139958. protected _isReady(subMesh: SubMesh, useInstances: boolean, emissiveTexture: Nullable<BaseTexture>): boolean;
  139959. /**
  139960. * Renders the glowing part of the scene by blending the blurred glowing meshes on top of the rendered scene.
  139961. */
  139962. render(): void;
  139963. /**
  139964. * Determine if a given mesh will be used in the current effect.
  139965. * @param mesh mesh to test
  139966. * @returns true if the mesh will be used
  139967. */
  139968. hasMesh(mesh: AbstractMesh): boolean;
  139969. /**
  139970. * Returns true if the layer contains information to display, otherwise false.
  139971. * @returns true if the glow layer should be rendered
  139972. */
  139973. shouldRender(): boolean;
  139974. /**
  139975. * Returns true if the mesh should render, otherwise false.
  139976. * @param mesh The mesh to render
  139977. * @returns true if it should render otherwise false
  139978. */
  139979. protected _shouldRenderMesh(mesh: AbstractMesh): boolean;
  139980. /**
  139981. * Returns true if the mesh can be rendered, otherwise false.
  139982. * @param mesh The mesh to render
  139983. * @param material The material used on the mesh
  139984. * @returns true if it can be rendered otherwise false
  139985. */
  139986. protected _canRenderMesh(mesh: AbstractMesh, material: Material): boolean;
  139987. /**
  139988. * Returns true if the mesh should render, otherwise false.
  139989. * @param mesh The mesh to render
  139990. * @returns true if it should render otherwise false
  139991. */
  139992. protected _shouldRenderEmissiveTextureForMesh(): boolean;
  139993. /**
  139994. * Renders the submesh passed in parameter to the generation map.
  139995. */
  139996. protected _renderSubMesh(subMesh: SubMesh, enableAlphaMode?: boolean): void;
  139997. /**
  139998. * Defines whether the current material of the mesh should be use to render the effect.
  139999. * @param mesh defines the current mesh to render
  140000. */
  140001. protected _useMeshMaterial(mesh: AbstractMesh): boolean;
  140002. /**
  140003. * Rebuild the required buffers.
  140004. * @hidden Internal use only.
  140005. */
  140006. _rebuild(): void;
  140007. /**
  140008. * Dispose only the render target textures and post process.
  140009. */
  140010. private _disposeTextureAndPostProcesses;
  140011. /**
  140012. * Dispose the highlight layer and free resources.
  140013. */
  140014. dispose(): void;
  140015. /**
  140016. * Gets the class name of the effect layer
  140017. * @returns the string with the class name of the effect layer
  140018. */
  140019. getClassName(): string;
  140020. /**
  140021. * Creates an effect layer from parsed effect layer data
  140022. * @param parsedEffectLayer defines effect layer data
  140023. * @param scene defines the current scene
  140024. * @param rootUrl defines the root URL containing the effect layer information
  140025. * @returns a parsed effect Layer
  140026. */
  140027. static Parse(parsedEffectLayer: any, scene: Scene, rootUrl: string): EffectLayer;
  140028. }
  140029. }
  140030. declare module BABYLON {
  140031. interface AbstractScene {
  140032. /**
  140033. * The list of effect layers (highlights/glow) added to the scene
  140034. * @see https://doc.babylonjs.com/how_to/highlight_layer
  140035. * @see https://doc.babylonjs.com/how_to/glow_layer
  140036. */
  140037. effectLayers: Array<EffectLayer>;
  140038. /**
  140039. * Removes the given effect layer from this scene.
  140040. * @param toRemove defines the effect layer to remove
  140041. * @returns the index of the removed effect layer
  140042. */
  140043. removeEffectLayer(toRemove: EffectLayer): number;
  140044. /**
  140045. * Adds the given effect layer to this scene
  140046. * @param newEffectLayer defines the effect layer to add
  140047. */
  140048. addEffectLayer(newEffectLayer: EffectLayer): void;
  140049. }
  140050. /**
  140051. * Defines the layer scene component responsible to manage any effect layers
  140052. * in a given scene.
  140053. */
  140054. export class EffectLayerSceneComponent implements ISceneSerializableComponent {
  140055. /**
  140056. * The component name helpfull to identify the component in the list of scene components.
  140057. */
  140058. readonly name: string;
  140059. /**
  140060. * The scene the component belongs to.
  140061. */
  140062. scene: Scene;
  140063. private _engine;
  140064. private _renderEffects;
  140065. private _needStencil;
  140066. private _previousStencilState;
  140067. /**
  140068. * Creates a new instance of the component for the given scene
  140069. * @param scene Defines the scene to register the component in
  140070. */
  140071. constructor(scene: Scene);
  140072. /**
  140073. * Registers the component in a given scene
  140074. */
  140075. register(): void;
  140076. /**
  140077. * Rebuilds the elements related to this component in case of
  140078. * context lost for instance.
  140079. */
  140080. rebuild(): void;
  140081. /**
  140082. * Serializes the component data to the specified json object
  140083. * @param serializationObject The object to serialize to
  140084. */
  140085. serialize(serializationObject: any): void;
  140086. /**
  140087. * Adds all the elements from the container to the scene
  140088. * @param container the container holding the elements
  140089. */
  140090. addFromContainer(container: AbstractScene): void;
  140091. /**
  140092. * Removes all the elements in the container from the scene
  140093. * @param container contains the elements to remove
  140094. * @param dispose if the removed element should be disposed (default: false)
  140095. */
  140096. removeFromContainer(container: AbstractScene, dispose?: boolean): void;
  140097. /**
  140098. * Disposes the component and the associated ressources.
  140099. */
  140100. dispose(): void;
  140101. private _isReadyForMesh;
  140102. private _renderMainTexture;
  140103. private _setStencil;
  140104. private _setStencilBack;
  140105. private _draw;
  140106. private _drawCamera;
  140107. private _drawRenderingGroup;
  140108. }
  140109. }
  140110. declare module BABYLON {
  140111. /** @hidden */
  140112. export var glowMapMergePixelShader: {
  140113. name: string;
  140114. shader: string;
  140115. };
  140116. }
  140117. declare module BABYLON {
  140118. /** @hidden */
  140119. export var glowMapMergeVertexShader: {
  140120. name: string;
  140121. shader: string;
  140122. };
  140123. }
  140124. declare module BABYLON {
  140125. interface AbstractScene {
  140126. /**
  140127. * Return a the first highlight layer of the scene with a given name.
  140128. * @param name The name of the highlight layer to look for.
  140129. * @return The highlight layer if found otherwise null.
  140130. */
  140131. getGlowLayerByName(name: string): Nullable<GlowLayer>;
  140132. }
  140133. /**
  140134. * Glow layer options. This helps customizing the behaviour
  140135. * of the glow layer.
  140136. */
  140137. export interface IGlowLayerOptions {
  140138. /**
  140139. * Multiplication factor apply to the canvas size to compute the render target size
  140140. * used to generated the glowing objects (the smaller the faster).
  140141. */
  140142. mainTextureRatio: number;
  140143. /**
  140144. * Enforces a fixed size texture to ensure resize independant blur.
  140145. */
  140146. mainTextureFixedSize?: number;
  140147. /**
  140148. * How big is the kernel of the blur texture.
  140149. */
  140150. blurKernelSize: number;
  140151. /**
  140152. * The camera attached to the layer.
  140153. */
  140154. camera: Nullable<Camera>;
  140155. /**
  140156. * Enable MSAA by chosing the number of samples.
  140157. */
  140158. mainTextureSamples?: number;
  140159. /**
  140160. * The rendering group to draw the layer in.
  140161. */
  140162. renderingGroupId: number;
  140163. }
  140164. /**
  140165. * The glow layer Helps adding a glow effect around the emissive parts of a mesh.
  140166. *
  140167. * Once instantiated in a scene, by default, all the emissive meshes will glow.
  140168. *
  140169. * Documentation: https://doc.babylonjs.com/how_to/glow_layer
  140170. */
  140171. export class GlowLayer extends EffectLayer {
  140172. /**
  140173. * Effect Name of the layer.
  140174. */
  140175. static readonly EffectName: string;
  140176. /**
  140177. * The default blur kernel size used for the glow.
  140178. */
  140179. static DefaultBlurKernelSize: number;
  140180. /**
  140181. * The default texture size ratio used for the glow.
  140182. */
  140183. static DefaultTextureRatio: number;
  140184. /**
  140185. * Sets the kernel size of the blur.
  140186. */
  140187. set blurKernelSize(value: number);
  140188. /**
  140189. * Gets the kernel size of the blur.
  140190. */
  140191. get blurKernelSize(): number;
  140192. /**
  140193. * Sets the glow intensity.
  140194. */
  140195. set intensity(value: number);
  140196. /**
  140197. * Gets the glow intensity.
  140198. */
  140199. get intensity(): number;
  140200. private _options;
  140201. private _intensity;
  140202. private _horizontalBlurPostprocess1;
  140203. private _verticalBlurPostprocess1;
  140204. private _horizontalBlurPostprocess2;
  140205. private _verticalBlurPostprocess2;
  140206. private _blurTexture1;
  140207. private _blurTexture2;
  140208. private _postProcesses1;
  140209. private _postProcesses2;
  140210. private _includedOnlyMeshes;
  140211. private _excludedMeshes;
  140212. private _meshesUsingTheirOwnMaterials;
  140213. /**
  140214. * Callback used to let the user override the color selection on a per mesh basis
  140215. */
  140216. customEmissiveColorSelector: (mesh: Mesh, subMesh: SubMesh, material: Material, result: Color4) => void;
  140217. /**
  140218. * Callback used to let the user override the texture selection on a per mesh basis
  140219. */
  140220. customEmissiveTextureSelector: (mesh: Mesh, subMesh: SubMesh, material: Material) => Texture;
  140221. /**
  140222. * Instantiates a new glow Layer and references it to the scene.
  140223. * @param name The name of the layer
  140224. * @param scene The scene to use the layer in
  140225. * @param options Sets of none mandatory options to use with the layer (see IGlowLayerOptions for more information)
  140226. */
  140227. constructor(name: string, scene: Scene, options?: Partial<IGlowLayerOptions>);
  140228. /**
  140229. * Get the effect name of the layer.
  140230. * @return The effect name
  140231. */
  140232. getEffectName(): string;
  140233. /**
  140234. * Create the merge effect. This is the shader use to blit the information back
  140235. * to the main canvas at the end of the scene rendering.
  140236. */
  140237. protected _createMergeEffect(): Effect;
  140238. /**
  140239. * Creates the render target textures and post processes used in the glow layer.
  140240. */
  140241. protected _createTextureAndPostProcesses(): void;
  140242. /**
  140243. * Checks for the readiness of the element composing the layer.
  140244. * @param subMesh the mesh to check for
  140245. * @param useInstances specify wether or not to use instances to render the mesh
  140246. * @param emissiveTexture the associated emissive texture used to generate the glow
  140247. * @return true if ready otherwise, false
  140248. */
  140249. isReady(subMesh: SubMesh, useInstances: boolean): boolean;
  140250. /**
  140251. * Returns whether or nood the layer needs stencil enabled during the mesh rendering.
  140252. */
  140253. needStencil(): boolean;
  140254. /**
  140255. * Returns true if the mesh can be rendered, otherwise false.
  140256. * @param mesh The mesh to render
  140257. * @param material The material used on the mesh
  140258. * @returns true if it can be rendered otherwise false
  140259. */
  140260. protected _canRenderMesh(mesh: AbstractMesh, material: Material): boolean;
  140261. /**
  140262. * Implementation specific of rendering the generating effect on the main canvas.
  140263. * @param effect The effect used to render through
  140264. */
  140265. protected _internalRender(effect: Effect): void;
  140266. /**
  140267. * Sets the required values for both the emissive texture and and the main color.
  140268. */
  140269. protected _setEmissiveTextureAndColor(mesh: Mesh, subMesh: SubMesh, material: Material): void;
  140270. /**
  140271. * Returns true if the mesh should render, otherwise false.
  140272. * @param mesh The mesh to render
  140273. * @returns true if it should render otherwise false
  140274. */
  140275. protected _shouldRenderMesh(mesh: Mesh): boolean;
  140276. /**
  140277. * Adds specific effects defines.
  140278. * @param defines The defines to add specifics to.
  140279. */
  140280. protected _addCustomEffectDefines(defines: string[]): void;
  140281. /**
  140282. * Add a mesh in the exclusion list to prevent it to impact or being impacted by the glow layer.
  140283. * @param mesh The mesh to exclude from the glow layer
  140284. */
  140285. addExcludedMesh(mesh: Mesh): void;
  140286. /**
  140287. * Remove a mesh from the exclusion list to let it impact or being impacted by the glow layer.
  140288. * @param mesh The mesh to remove
  140289. */
  140290. removeExcludedMesh(mesh: Mesh): void;
  140291. /**
  140292. * Add a mesh in the inclusion list to impact or being impacted by the glow layer.
  140293. * @param mesh The mesh to include in the glow layer
  140294. */
  140295. addIncludedOnlyMesh(mesh: Mesh): void;
  140296. /**
  140297. * Remove a mesh from the Inclusion list to prevent it to impact or being impacted by the glow layer.
  140298. * @param mesh The mesh to remove
  140299. */
  140300. removeIncludedOnlyMesh(mesh: Mesh): void;
  140301. /**
  140302. * Determine if a given mesh will be used in the glow layer
  140303. * @param mesh The mesh to test
  140304. * @returns true if the mesh will be highlighted by the current glow layer
  140305. */
  140306. hasMesh(mesh: AbstractMesh): boolean;
  140307. /**
  140308. * Defines whether the current material of the mesh should be use to render the effect.
  140309. * @param mesh defines the current mesh to render
  140310. */
  140311. protected _useMeshMaterial(mesh: AbstractMesh): boolean;
  140312. /**
  140313. * Add a mesh to be rendered through its own material and not with emissive only.
  140314. * @param mesh The mesh for which we need to use its material
  140315. */
  140316. referenceMeshToUseItsOwnMaterial(mesh: AbstractMesh): void;
  140317. /**
  140318. * Remove a mesh from being rendered through its own material and not with emissive only.
  140319. * @param mesh The mesh for which we need to not use its material
  140320. */
  140321. unReferenceMeshFromUsingItsOwnMaterial(mesh: AbstractMesh): void;
  140322. /**
  140323. * Free any resources and references associated to a mesh.
  140324. * Internal use
  140325. * @param mesh The mesh to free.
  140326. * @hidden
  140327. */
  140328. _disposeMesh(mesh: Mesh): void;
  140329. /**
  140330. * Gets the class name of the effect layer
  140331. * @returns the string with the class name of the effect layer
  140332. */
  140333. getClassName(): string;
  140334. /**
  140335. * Serializes this glow layer
  140336. * @returns a serialized glow layer object
  140337. */
  140338. serialize(): any;
  140339. /**
  140340. * Creates a Glow Layer from parsed glow layer data
  140341. * @param parsedGlowLayer defines glow layer data
  140342. * @param scene defines the current scene
  140343. * @param rootUrl defines the root URL containing the glow layer information
  140344. * @returns a parsed Glow Layer
  140345. */
  140346. static Parse(parsedGlowLayer: any, scene: Scene, rootUrl: string): GlowLayer;
  140347. }
  140348. }
  140349. declare module BABYLON {
  140350. /** @hidden */
  140351. export var glowBlurPostProcessPixelShader: {
  140352. name: string;
  140353. shader: string;
  140354. };
  140355. }
  140356. declare module BABYLON {
  140357. interface AbstractScene {
  140358. /**
  140359. * Return a the first highlight layer of the scene with a given name.
  140360. * @param name The name of the highlight layer to look for.
  140361. * @return The highlight layer if found otherwise null.
  140362. */
  140363. getHighlightLayerByName(name: string): Nullable<HighlightLayer>;
  140364. }
  140365. /**
  140366. * Highlight layer options. This helps customizing the behaviour
  140367. * of the highlight layer.
  140368. */
  140369. export interface IHighlightLayerOptions {
  140370. /**
  140371. * Multiplication factor apply to the canvas size to compute the render target size
  140372. * used to generated the glowing objects (the smaller the faster).
  140373. */
  140374. mainTextureRatio: number;
  140375. /**
  140376. * Enforces a fixed size texture to ensure resize independant blur.
  140377. */
  140378. mainTextureFixedSize?: number;
  140379. /**
  140380. * Multiplication factor apply to the main texture size in the first step of the blur to reduce the size
  140381. * of the picture to blur (the smaller the faster).
  140382. */
  140383. blurTextureSizeRatio: number;
  140384. /**
  140385. * How big in texel of the blur texture is the vertical blur.
  140386. */
  140387. blurVerticalSize: number;
  140388. /**
  140389. * How big in texel of the blur texture is the horizontal blur.
  140390. */
  140391. blurHorizontalSize: number;
  140392. /**
  140393. * Alpha blending mode used to apply the blur. Default is combine.
  140394. */
  140395. alphaBlendingMode: number;
  140396. /**
  140397. * The camera attached to the layer.
  140398. */
  140399. camera: Nullable<Camera>;
  140400. /**
  140401. * Should we display highlight as a solid stroke?
  140402. */
  140403. isStroke?: boolean;
  140404. /**
  140405. * The rendering group to draw the layer in.
  140406. */
  140407. renderingGroupId: number;
  140408. }
  140409. /**
  140410. * The highlight layer Helps adding a glow effect around a mesh.
  140411. *
  140412. * Once instantiated in a scene, simply use the addMesh or removeMesh method to add or remove
  140413. * glowy meshes to your scene.
  140414. *
  140415. * !!! THIS REQUIRES AN ACTIVE STENCIL BUFFER ON THE CANVAS !!!
  140416. */
  140417. export class HighlightLayer extends EffectLayer {
  140418. name: string;
  140419. /**
  140420. * Effect Name of the highlight layer.
  140421. */
  140422. static readonly EffectName: string;
  140423. /**
  140424. * The neutral color used during the preparation of the glow effect.
  140425. * This is black by default as the blend operation is a blend operation.
  140426. */
  140427. static NeutralColor: Color4;
  140428. /**
  140429. * Stencil value used for glowing meshes.
  140430. */
  140431. static GlowingMeshStencilReference: number;
  140432. /**
  140433. * Stencil value used for the other meshes in the scene.
  140434. */
  140435. static NormalMeshStencilReference: number;
  140436. /**
  140437. * Specifies whether or not the inner glow is ACTIVE in the layer.
  140438. */
  140439. innerGlow: boolean;
  140440. /**
  140441. * Specifies whether or not the outer glow is ACTIVE in the layer.
  140442. */
  140443. outerGlow: boolean;
  140444. /**
  140445. * Specifies the horizontal size of the blur.
  140446. */
  140447. set blurHorizontalSize(value: number);
  140448. /**
  140449. * Specifies the vertical size of the blur.
  140450. */
  140451. set blurVerticalSize(value: number);
  140452. /**
  140453. * Gets the horizontal size of the blur.
  140454. */
  140455. get blurHorizontalSize(): number;
  140456. /**
  140457. * Gets the vertical size of the blur.
  140458. */
  140459. get blurVerticalSize(): number;
  140460. /**
  140461. * An event triggered when the highlight layer is being blurred.
  140462. */
  140463. onBeforeBlurObservable: Observable<HighlightLayer>;
  140464. /**
  140465. * An event triggered when the highlight layer has been blurred.
  140466. */
  140467. onAfterBlurObservable: Observable<HighlightLayer>;
  140468. private _instanceGlowingMeshStencilReference;
  140469. private _options;
  140470. private _downSamplePostprocess;
  140471. private _horizontalBlurPostprocess;
  140472. private _verticalBlurPostprocess;
  140473. private _blurTexture;
  140474. private _meshes;
  140475. private _excludedMeshes;
  140476. /**
  140477. * Instantiates a new highlight Layer and references it to the scene..
  140478. * @param name The name of the layer
  140479. * @param scene The scene to use the layer in
  140480. * @param options Sets of none mandatory options to use with the layer (see IHighlightLayerOptions for more information)
  140481. */
  140482. constructor(name: string, scene: Scene, options?: Partial<IHighlightLayerOptions>);
  140483. /**
  140484. * Get the effect name of the layer.
  140485. * @return The effect name
  140486. */
  140487. getEffectName(): string;
  140488. /**
  140489. * Create the merge effect. This is the shader use to blit the information back
  140490. * to the main canvas at the end of the scene rendering.
  140491. */
  140492. protected _createMergeEffect(): Effect;
  140493. /**
  140494. * Creates the render target textures and post processes used in the highlight layer.
  140495. */
  140496. protected _createTextureAndPostProcesses(): void;
  140497. /**
  140498. * Returns wether or nood the layer needs stencil enabled during the mesh rendering.
  140499. */
  140500. needStencil(): boolean;
  140501. /**
  140502. * Checks for the readiness of the element composing the layer.
  140503. * @param subMesh the mesh to check for
  140504. * @param useInstances specify wether or not to use instances to render the mesh
  140505. * @param emissiveTexture the associated emissive texture used to generate the glow
  140506. * @return true if ready otherwise, false
  140507. */
  140508. isReady(subMesh: SubMesh, useInstances: boolean): boolean;
  140509. /**
  140510. * Implementation specific of rendering the generating effect on the main canvas.
  140511. * @param effect The effect used to render through
  140512. */
  140513. protected _internalRender(effect: Effect): void;
  140514. /**
  140515. * Returns true if the layer contains information to display, otherwise false.
  140516. */
  140517. shouldRender(): boolean;
  140518. /**
  140519. * Returns true if the mesh should render, otherwise false.
  140520. * @param mesh The mesh to render
  140521. * @returns true if it should render otherwise false
  140522. */
  140523. protected _shouldRenderMesh(mesh: Mesh): boolean;
  140524. /**
  140525. * Returns true if the mesh can be rendered, otherwise false.
  140526. * @param mesh The mesh to render
  140527. * @param material The material used on the mesh
  140528. * @returns true if it can be rendered otherwise false
  140529. */
  140530. protected _canRenderMesh(mesh: AbstractMesh, material: Material): boolean;
  140531. /**
  140532. * Adds specific effects defines.
  140533. * @param defines The defines to add specifics to.
  140534. */
  140535. protected _addCustomEffectDefines(defines: string[]): void;
  140536. /**
  140537. * Sets the required values for both the emissive texture and and the main color.
  140538. */
  140539. protected _setEmissiveTextureAndColor(mesh: Mesh, subMesh: SubMesh, material: Material): void;
  140540. /**
  140541. * Add a mesh in the exclusion list to prevent it to impact or being impacted by the highlight layer.
  140542. * @param mesh The mesh to exclude from the highlight layer
  140543. */
  140544. addExcludedMesh(mesh: Mesh): void;
  140545. /**
  140546. * Remove a mesh from the exclusion list to let it impact or being impacted by the highlight layer.
  140547. * @param mesh The mesh to highlight
  140548. */
  140549. removeExcludedMesh(mesh: Mesh): void;
  140550. /**
  140551. * Determine if a given mesh will be highlighted by the current HighlightLayer
  140552. * @param mesh mesh to test
  140553. * @returns true if the mesh will be highlighted by the current HighlightLayer
  140554. */
  140555. hasMesh(mesh: AbstractMesh): boolean;
  140556. /**
  140557. * Add a mesh in the highlight layer in order to make it glow with the chosen color.
  140558. * @param mesh The mesh to highlight
  140559. * @param color The color of the highlight
  140560. * @param glowEmissiveOnly Extract the glow from the emissive texture
  140561. */
  140562. addMesh(mesh: Mesh, color: Color3, glowEmissiveOnly?: boolean): void;
  140563. /**
  140564. * Remove a mesh from the highlight layer in order to make it stop glowing.
  140565. * @param mesh The mesh to highlight
  140566. */
  140567. removeMesh(mesh: Mesh): void;
  140568. /**
  140569. * Remove all the meshes currently referenced in the highlight layer
  140570. */
  140571. removeAllMeshes(): void;
  140572. /**
  140573. * Force the stencil to the normal expected value for none glowing parts
  140574. */
  140575. private _defaultStencilReference;
  140576. /**
  140577. * Free any resources and references associated to a mesh.
  140578. * Internal use
  140579. * @param mesh The mesh to free.
  140580. * @hidden
  140581. */
  140582. _disposeMesh(mesh: Mesh): void;
  140583. /**
  140584. * Dispose the highlight layer and free resources.
  140585. */
  140586. dispose(): void;
  140587. /**
  140588. * Gets the class name of the effect layer
  140589. * @returns the string with the class name of the effect layer
  140590. */
  140591. getClassName(): string;
  140592. /**
  140593. * Serializes this Highlight layer
  140594. * @returns a serialized Highlight layer object
  140595. */
  140596. serialize(): any;
  140597. /**
  140598. * Creates a Highlight layer from parsed Highlight layer data
  140599. * @param parsedHightlightLayer defines the Highlight layer data
  140600. * @param scene defines the current scene
  140601. * @param rootUrl defines the root URL containing the Highlight layer information
  140602. * @returns a parsed Highlight layer
  140603. */
  140604. static Parse(parsedHightlightLayer: any, scene: Scene, rootUrl: string): HighlightLayer;
  140605. }
  140606. }
  140607. declare module BABYLON {
  140608. interface AbstractScene {
  140609. /**
  140610. * The list of layers (background and foreground) of the scene
  140611. */
  140612. layers: Array<Layer>;
  140613. }
  140614. /**
  140615. * Defines the layer scene component responsible to manage any layers
  140616. * in a given scene.
  140617. */
  140618. export class LayerSceneComponent implements ISceneComponent {
  140619. /**
  140620. * The component name helpfull to identify the component in the list of scene components.
  140621. */
  140622. readonly name: string;
  140623. /**
  140624. * The scene the component belongs to.
  140625. */
  140626. scene: Scene;
  140627. private _engine;
  140628. /**
  140629. * Creates a new instance of the component for the given scene
  140630. * @param scene Defines the scene to register the component in
  140631. */
  140632. constructor(scene: Scene);
  140633. /**
  140634. * Registers the component in a given scene
  140635. */
  140636. register(): void;
  140637. /**
  140638. * Rebuilds the elements related to this component in case of
  140639. * context lost for instance.
  140640. */
  140641. rebuild(): void;
  140642. /**
  140643. * Disposes the component and the associated ressources.
  140644. */
  140645. dispose(): void;
  140646. private _draw;
  140647. private _drawCameraPredicate;
  140648. private _drawCameraBackground;
  140649. private _drawCameraForeground;
  140650. private _drawRenderTargetPredicate;
  140651. private _drawRenderTargetBackground;
  140652. private _drawRenderTargetForeground;
  140653. /**
  140654. * Adds all the elements from the container to the scene
  140655. * @param container the container holding the elements
  140656. */
  140657. addFromContainer(container: AbstractScene): void;
  140658. /**
  140659. * Removes all the elements in the container from the scene
  140660. * @param container contains the elements to remove
  140661. * @param dispose if the removed element should be disposed (default: false)
  140662. */
  140663. removeFromContainer(container: AbstractScene, dispose?: boolean): void;
  140664. }
  140665. }
  140666. declare module BABYLON {
  140667. /** @hidden */
  140668. export var layerPixelShader: {
  140669. name: string;
  140670. shader: string;
  140671. };
  140672. }
  140673. declare module BABYLON {
  140674. /** @hidden */
  140675. export var layerVertexShader: {
  140676. name: string;
  140677. shader: string;
  140678. };
  140679. }
  140680. declare module BABYLON {
  140681. /**
  140682. * This represents a full screen 2d layer.
  140683. * This can be useful to display a picture in the background of your scene for instance.
  140684. * @see https://www.babylonjs-playground.com/#08A2BS#1
  140685. */
  140686. export class Layer {
  140687. /**
  140688. * Define the name of the layer.
  140689. */
  140690. name: string;
  140691. /**
  140692. * Define the texture the layer should display.
  140693. */
  140694. texture: Nullable<Texture>;
  140695. /**
  140696. * Is the layer in background or foreground.
  140697. */
  140698. isBackground: boolean;
  140699. /**
  140700. * Define the color of the layer (instead of texture).
  140701. */
  140702. color: Color4;
  140703. /**
  140704. * Define the scale of the layer in order to zoom in out of the texture.
  140705. */
  140706. scale: Vector2;
  140707. /**
  140708. * Define an offset for the layer in order to shift the texture.
  140709. */
  140710. offset: Vector2;
  140711. /**
  140712. * Define the alpha blending mode used in the layer in case the texture or color has an alpha.
  140713. */
  140714. alphaBlendingMode: number;
  140715. /**
  140716. * Define if the layer should alpha test or alpha blend with the rest of the scene.
  140717. * Alpha test will not mix with the background color in case of transparency.
  140718. * It will either use the texture color or the background depending on the alpha value of the current pixel.
  140719. */
  140720. alphaTest: boolean;
  140721. /**
  140722. * Define a mask to restrict the layer to only some of the scene cameras.
  140723. */
  140724. layerMask: number;
  140725. /**
  140726. * Define the list of render target the layer is visible into.
  140727. */
  140728. renderTargetTextures: RenderTargetTexture[];
  140729. /**
  140730. * Define if the layer is only used in renderTarget or if it also
  140731. * renders in the main frame buffer of the canvas.
  140732. */
  140733. renderOnlyInRenderTargetTextures: boolean;
  140734. private _scene;
  140735. private _vertexBuffers;
  140736. private _indexBuffer;
  140737. private _effect;
  140738. private _previousDefines;
  140739. /**
  140740. * An event triggered when the layer is disposed.
  140741. */
  140742. onDisposeObservable: Observable<Layer>;
  140743. private _onDisposeObserver;
  140744. /**
  140745. * Back compatibility with callback before the onDisposeObservable existed.
  140746. * The set callback will be triggered when the layer has been disposed.
  140747. */
  140748. set onDispose(callback: () => void);
  140749. /**
  140750. * An event triggered before rendering the scene
  140751. */
  140752. onBeforeRenderObservable: Observable<Layer>;
  140753. private _onBeforeRenderObserver;
  140754. /**
  140755. * Back compatibility with callback before the onBeforeRenderObservable existed.
  140756. * The set callback will be triggered just before rendering the layer.
  140757. */
  140758. set onBeforeRender(callback: () => void);
  140759. /**
  140760. * An event triggered after rendering the scene
  140761. */
  140762. onAfterRenderObservable: Observable<Layer>;
  140763. private _onAfterRenderObserver;
  140764. /**
  140765. * Back compatibility with callback before the onAfterRenderObservable existed.
  140766. * The set callback will be triggered just after rendering the layer.
  140767. */
  140768. set onAfterRender(callback: () => void);
  140769. /**
  140770. * Instantiates a new layer.
  140771. * This represents a full screen 2d layer.
  140772. * This can be useful to display a picture in the background of your scene for instance.
  140773. * @see https://www.babylonjs-playground.com/#08A2BS#1
  140774. * @param name Define the name of the layer in the scene
  140775. * @param imgUrl Define the url of the texture to display in the layer
  140776. * @param scene Define the scene the layer belongs to
  140777. * @param isBackground Defines whether the layer is displayed in front or behind the scene
  140778. * @param color Defines a color for the layer
  140779. */
  140780. constructor(
  140781. /**
  140782. * Define the name of the layer.
  140783. */
  140784. name: string, imgUrl: Nullable<string>, scene: Nullable<Scene>, isBackground?: boolean, color?: Color4);
  140785. private _createIndexBuffer;
  140786. /** @hidden */
  140787. _rebuild(): void;
  140788. /**
  140789. * Renders the layer in the scene.
  140790. */
  140791. render(): void;
  140792. /**
  140793. * Disposes and releases the associated ressources.
  140794. */
  140795. dispose(): void;
  140796. }
  140797. }
  140798. declare module BABYLON {
  140799. /** @hidden */
  140800. export var lensFlarePixelShader: {
  140801. name: string;
  140802. shader: string;
  140803. };
  140804. }
  140805. declare module BABYLON {
  140806. /** @hidden */
  140807. export var lensFlareVertexShader: {
  140808. name: string;
  140809. shader: string;
  140810. };
  140811. }
  140812. declare module BABYLON {
  140813. /**
  140814. * This represents a Lens Flare System or the shiny effect created by the light reflection on the camera lenses.
  140815. * It is usually composed of several `lensFlare`.
  140816. * @see https://doc.babylonjs.com/how_to/how_to_use_lens_flares
  140817. */
  140818. export class LensFlareSystem {
  140819. /**
  140820. * Define the name of the lens flare system
  140821. */
  140822. name: string;
  140823. /**
  140824. * List of lens flares used in this system.
  140825. */
  140826. lensFlares: LensFlare[];
  140827. /**
  140828. * Define a limit from the border the lens flare can be visible.
  140829. */
  140830. borderLimit: number;
  140831. /**
  140832. * Define a viewport border we do not want to see the lens flare in.
  140833. */
  140834. viewportBorder: number;
  140835. /**
  140836. * Define a predicate which could limit the list of meshes able to occlude the effect.
  140837. */
  140838. meshesSelectionPredicate: (mesh: AbstractMesh) => boolean;
  140839. /**
  140840. * Restricts the rendering of the effect to only the camera rendering this layer mask.
  140841. */
  140842. layerMask: number;
  140843. /**
  140844. * Define the id of the lens flare system in the scene.
  140845. * (equal to name by default)
  140846. */
  140847. id: string;
  140848. private _scene;
  140849. private _emitter;
  140850. private _vertexBuffers;
  140851. private _indexBuffer;
  140852. private _effect;
  140853. private _positionX;
  140854. private _positionY;
  140855. private _isEnabled;
  140856. /** @hidden */
  140857. static _SceneComponentInitialization: (scene: Scene) => void;
  140858. /**
  140859. * Instantiates a lens flare system.
  140860. * This represents a Lens Flare System or the shiny effect created by the light reflection on the camera lenses.
  140861. * It is usually composed of several `lensFlare`.
  140862. * @see https://doc.babylonjs.com/how_to/how_to_use_lens_flares
  140863. * @param name Define the name of the lens flare system in the scene
  140864. * @param emitter Define the source (the emitter) of the lens flares (it can be a camera, a light or a mesh).
  140865. * @param scene Define the scene the lens flare system belongs to
  140866. */
  140867. constructor(
  140868. /**
  140869. * Define the name of the lens flare system
  140870. */
  140871. name: string, emitter: any, scene: Scene);
  140872. /**
  140873. * Define if the lens flare system is enabled.
  140874. */
  140875. get isEnabled(): boolean;
  140876. set isEnabled(value: boolean);
  140877. /**
  140878. * Get the scene the effects belongs to.
  140879. * @returns the scene holding the lens flare system
  140880. */
  140881. getScene(): Scene;
  140882. /**
  140883. * Get the emitter of the lens flare system.
  140884. * It defines the source of the lens flares (it can be a camera, a light or a mesh).
  140885. * @returns the emitter of the lens flare system
  140886. */
  140887. getEmitter(): any;
  140888. /**
  140889. * Set the emitter of the lens flare system.
  140890. * It defines the source of the lens flares (it can be a camera, a light or a mesh).
  140891. * @param newEmitter Define the new emitter of the system
  140892. */
  140893. setEmitter(newEmitter: any): void;
  140894. /**
  140895. * Get the lens flare system emitter position.
  140896. * The emitter defines the source of the lens flares (it can be a camera, a light or a mesh).
  140897. * @returns the position
  140898. */
  140899. getEmitterPosition(): Vector3;
  140900. /**
  140901. * @hidden
  140902. */
  140903. computeEffectivePosition(globalViewport: Viewport): boolean;
  140904. /** @hidden */
  140905. _isVisible(): boolean;
  140906. /**
  140907. * @hidden
  140908. */
  140909. render(): boolean;
  140910. /**
  140911. * Dispose and release the lens flare with its associated resources.
  140912. */
  140913. dispose(): void;
  140914. /**
  140915. * Parse a lens flare system from a JSON repressentation
  140916. * @param parsedLensFlareSystem Define the JSON to parse
  140917. * @param scene Define the scene the parsed system should be instantiated in
  140918. * @param rootUrl Define the rootUrl of the load sequence to easily find a load relative dependencies such as textures
  140919. * @returns the parsed system
  140920. */
  140921. static Parse(parsedLensFlareSystem: any, scene: Scene, rootUrl: string): LensFlareSystem;
  140922. /**
  140923. * Serialize the current Lens Flare System into a JSON representation.
  140924. * @returns the serialized JSON
  140925. */
  140926. serialize(): any;
  140927. }
  140928. }
  140929. declare module BABYLON {
  140930. /**
  140931. * This represents one of the lens effect in a `lensFlareSystem`.
  140932. * It controls one of the indiviual texture used in the effect.
  140933. * @see https://doc.babylonjs.com/how_to/how_to_use_lens_flares
  140934. */
  140935. export class LensFlare {
  140936. /**
  140937. * Define the size of the lens flare in the system (a floating value between 0 and 1)
  140938. */
  140939. size: number;
  140940. /**
  140941. * 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.
  140942. */
  140943. position: number;
  140944. /**
  140945. * Define the lens color.
  140946. */
  140947. color: Color3;
  140948. /**
  140949. * Define the lens texture.
  140950. */
  140951. texture: Nullable<Texture>;
  140952. /**
  140953. * Define the alpha mode to render this particular lens.
  140954. */
  140955. alphaMode: number;
  140956. private _system;
  140957. /**
  140958. * Creates a new Lens Flare.
  140959. * This represents one of the lens effect in a `lensFlareSystem`.
  140960. * It controls one of the indiviual texture used in the effect.
  140961. * @see https://doc.babylonjs.com/how_to/how_to_use_lens_flares
  140962. * @param size Define the size of the lens flare (a floating value between 0 and 1)
  140963. * @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.
  140964. * @param color Define the lens color
  140965. * @param imgUrl Define the lens texture url
  140966. * @param system Define the `lensFlareSystem` this flare is part of
  140967. * @returns The newly created Lens Flare
  140968. */
  140969. static AddFlare(size: number, position: number, color: Color3, imgUrl: string, system: LensFlareSystem): LensFlare;
  140970. /**
  140971. * Instantiates a new Lens Flare.
  140972. * This represents one of the lens effect in a `lensFlareSystem`.
  140973. * It controls one of the indiviual texture used in the effect.
  140974. * @see https://doc.babylonjs.com/how_to/how_to_use_lens_flares
  140975. * @param size Define the size of the lens flare in the system (a floating value between 0 and 1)
  140976. * @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.
  140977. * @param color Define the lens color
  140978. * @param imgUrl Define the lens texture url
  140979. * @param system Define the `lensFlareSystem` this flare is part of
  140980. */
  140981. constructor(
  140982. /**
  140983. * Define the size of the lens flare in the system (a floating value between 0 and 1)
  140984. */
  140985. size: number,
  140986. /**
  140987. * 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.
  140988. */
  140989. position: number, color: Color3, imgUrl: string, system: LensFlareSystem);
  140990. /**
  140991. * Dispose and release the lens flare with its associated resources.
  140992. */
  140993. dispose(): void;
  140994. }
  140995. }
  140996. declare module BABYLON {
  140997. interface AbstractScene {
  140998. /**
  140999. * The list of lens flare system added to the scene
  141000. * @see https://doc.babylonjs.com/how_to/how_to_use_lens_flares
  141001. */
  141002. lensFlareSystems: Array<LensFlareSystem>;
  141003. /**
  141004. * Removes the given lens flare system from this scene.
  141005. * @param toRemove The lens flare system to remove
  141006. * @returns The index of the removed lens flare system
  141007. */
  141008. removeLensFlareSystem(toRemove: LensFlareSystem): number;
  141009. /**
  141010. * Adds the given lens flare system to this scene
  141011. * @param newLensFlareSystem The lens flare system to add
  141012. */
  141013. addLensFlareSystem(newLensFlareSystem: LensFlareSystem): void;
  141014. /**
  141015. * Gets a lens flare system using its name
  141016. * @param name defines the name to look for
  141017. * @returns the lens flare system or null if not found
  141018. */
  141019. getLensFlareSystemByName(name: string): Nullable<LensFlareSystem>;
  141020. /**
  141021. * Gets a lens flare system using its id
  141022. * @param id defines the id to look for
  141023. * @returns the lens flare system or null if not found
  141024. */
  141025. getLensFlareSystemByID(id: string): Nullable<LensFlareSystem>;
  141026. }
  141027. /**
  141028. * Defines the lens flare scene component responsible to manage any lens flares
  141029. * in a given scene.
  141030. */
  141031. export class LensFlareSystemSceneComponent implements ISceneSerializableComponent {
  141032. /**
  141033. * The component name helpfull to identify the component in the list of scene components.
  141034. */
  141035. readonly name: string;
  141036. /**
  141037. * The scene the component belongs to.
  141038. */
  141039. scene: Scene;
  141040. /**
  141041. * Creates a new instance of the component for the given scene
  141042. * @param scene Defines the scene to register the component in
  141043. */
  141044. constructor(scene: Scene);
  141045. /**
  141046. * Registers the component in a given scene
  141047. */
  141048. register(): void;
  141049. /**
  141050. * Rebuilds the elements related to this component in case of
  141051. * context lost for instance.
  141052. */
  141053. rebuild(): void;
  141054. /**
  141055. * Adds all the elements from the container to the scene
  141056. * @param container the container holding the elements
  141057. */
  141058. addFromContainer(container: AbstractScene): void;
  141059. /**
  141060. * Removes all the elements in the container from the scene
  141061. * @param container contains the elements to remove
  141062. * @param dispose if the removed element should be disposed (default: false)
  141063. */
  141064. removeFromContainer(container: AbstractScene, dispose?: boolean): void;
  141065. /**
  141066. * Serializes the component data to the specified json object
  141067. * @param serializationObject The object to serialize to
  141068. */
  141069. serialize(serializationObject: any): void;
  141070. /**
  141071. * Disposes the component and the associated ressources.
  141072. */
  141073. dispose(): void;
  141074. private _draw;
  141075. }
  141076. }
  141077. declare module BABYLON {
  141078. /** @hidden */
  141079. export var depthPixelShader: {
  141080. name: string;
  141081. shader: string;
  141082. };
  141083. }
  141084. declare module BABYLON {
  141085. /** @hidden */
  141086. export var depthVertexShader: {
  141087. name: string;
  141088. shader: string;
  141089. };
  141090. }
  141091. declare module BABYLON {
  141092. /**
  141093. * This represents a depth renderer in Babylon.
  141094. * A depth renderer will render to it's depth map every frame which can be displayed or used in post processing
  141095. */
  141096. export class DepthRenderer {
  141097. private _scene;
  141098. private _depthMap;
  141099. private _effect;
  141100. private readonly _storeNonLinearDepth;
  141101. private readonly _clearColor;
  141102. /** Get if the depth renderer is using packed depth or not */
  141103. readonly isPacked: boolean;
  141104. private _cachedDefines;
  141105. private _camera;
  141106. /** Enable or disable the depth renderer. When disabled, the depth texture is not updated */
  141107. enabled: boolean;
  141108. /**
  141109. * Specifiess that the depth renderer will only be used within
  141110. * the camera it is created for.
  141111. * This can help forcing its rendering during the camera processing.
  141112. */
  141113. useOnlyInActiveCamera: boolean;
  141114. /** @hidden */
  141115. static _SceneComponentInitialization: (scene: Scene) => void;
  141116. /**
  141117. * Instantiates a depth renderer
  141118. * @param scene The scene the renderer belongs to
  141119. * @param type The texture type of the depth map (default: Engine.TEXTURETYPE_FLOAT)
  141120. * @param camera The camera to be used to render the depth map (default: scene's active camera)
  141121. * @param storeNonLinearDepth Defines whether the depth is stored linearly like in Babylon Shadows or directly like glFragCoord.z
  141122. */
  141123. constructor(scene: Scene, type?: number, camera?: Nullable<Camera>, storeNonLinearDepth?: boolean);
  141124. /**
  141125. * Creates the depth rendering effect and checks if the effect is ready.
  141126. * @param subMesh The submesh to be used to render the depth map of
  141127. * @param useInstances If multiple world instances should be used
  141128. * @returns if the depth renderer is ready to render the depth map
  141129. */
  141130. isReady(subMesh: SubMesh, useInstances: boolean): boolean;
  141131. /**
  141132. * Gets the texture which the depth map will be written to.
  141133. * @returns The depth map texture
  141134. */
  141135. getDepthMap(): RenderTargetTexture;
  141136. /**
  141137. * Disposes of the depth renderer.
  141138. */
  141139. dispose(): void;
  141140. }
  141141. }
  141142. declare module BABYLON {
  141143. /** @hidden */
  141144. export var minmaxReduxPixelShader: {
  141145. name: string;
  141146. shader: string;
  141147. };
  141148. }
  141149. declare module BABYLON {
  141150. /**
  141151. * This class computes a min/max reduction from a texture: it means it computes the minimum
  141152. * and maximum values from all values of the texture.
  141153. * It is performed on the GPU for better performances, thanks to a succession of post processes.
  141154. * The source values are read from the red channel of the texture.
  141155. */
  141156. export class MinMaxReducer {
  141157. /**
  141158. * Observable triggered when the computation has been performed
  141159. */
  141160. onAfterReductionPerformed: Observable<{
  141161. min: number;
  141162. max: number;
  141163. }>;
  141164. protected _camera: Camera;
  141165. protected _sourceTexture: Nullable<RenderTargetTexture>;
  141166. protected _reductionSteps: Nullable<Array<PostProcess>>;
  141167. protected _postProcessManager: PostProcessManager;
  141168. protected _onAfterUnbindObserver: Nullable<Observer<RenderTargetTexture>>;
  141169. protected _forceFullscreenViewport: boolean;
  141170. /**
  141171. * Creates a min/max reducer
  141172. * @param camera The camera to use for the post processes
  141173. */
  141174. constructor(camera: Camera);
  141175. /**
  141176. * Gets the texture used to read the values from.
  141177. */
  141178. get sourceTexture(): Nullable<RenderTargetTexture>;
  141179. /**
  141180. * Sets the source texture to read the values from.
  141181. * One must indicate if the texture is a depth texture or not through the depthRedux parameter
  141182. * because in such textures '1' value must not be taken into account to compute the maximum
  141183. * as this value is used to clear the texture.
  141184. * Note that the computation is not activated by calling this function, you must call activate() for that!
  141185. * @param sourceTexture The texture to read the values from. The values should be in the red channel.
  141186. * @param depthRedux Indicates if the texture is a depth texture or not
  141187. * @param type The type of the textures created for the reduction (defaults to TEXTURETYPE_HALF_FLOAT)
  141188. * @param forceFullscreenViewport Forces the post processes used for the reduction to be applied without taking into account viewport (defaults to true)
  141189. */
  141190. setSourceTexture(sourceTexture: RenderTargetTexture, depthRedux: boolean, type?: number, forceFullscreenViewport?: boolean): void;
  141191. /**
  141192. * Defines the refresh rate of the computation.
  141193. * Use 0 to compute just once, 1 to compute on every frame, 2 to compute every two frames and so on...
  141194. */
  141195. get refreshRate(): number;
  141196. set refreshRate(value: number);
  141197. protected _activated: boolean;
  141198. /**
  141199. * Gets the activation status of the reducer
  141200. */
  141201. get activated(): boolean;
  141202. /**
  141203. * Activates the reduction computation.
  141204. * When activated, the observers registered in onAfterReductionPerformed are
  141205. * called after the compuation is performed
  141206. */
  141207. activate(): void;
  141208. /**
  141209. * Deactivates the reduction computation.
  141210. */
  141211. deactivate(): void;
  141212. /**
  141213. * Disposes the min/max reducer
  141214. * @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.
  141215. */
  141216. dispose(disposeAll?: boolean): void;
  141217. }
  141218. }
  141219. declare module BABYLON {
  141220. /**
  141221. * This class is a small wrapper around the MinMaxReducer class to compute the min/max values of a depth texture
  141222. */
  141223. export class DepthReducer extends MinMaxReducer {
  141224. private _depthRenderer;
  141225. private _depthRendererId;
  141226. /**
  141227. * Gets the depth renderer used for the computation.
  141228. * Note that the result is null if you provide your own renderer when calling setDepthRenderer.
  141229. */
  141230. get depthRenderer(): Nullable<DepthRenderer>;
  141231. /**
  141232. * Creates a depth reducer
  141233. * @param camera The camera used to render the depth texture
  141234. */
  141235. constructor(camera: Camera);
  141236. /**
  141237. * Sets the depth renderer to use to generate the depth map
  141238. * @param depthRenderer The depth renderer to use. If not provided, a new one will be created automatically
  141239. * @param type The texture type of the depth map (default: TEXTURETYPE_HALF_FLOAT)
  141240. * @param forceFullscreenViewport Forces the post processes used for the reduction to be applied without taking into account viewport (defaults to true)
  141241. */
  141242. setDepthRenderer(depthRenderer?: Nullable<DepthRenderer>, type?: number, forceFullscreenViewport?: boolean): void;
  141243. /** @hidden */
  141244. setSourceTexture(sourceTexture: RenderTargetTexture, depthRedux: boolean, type?: number, forceFullscreenViewport?: boolean): void;
  141245. /**
  141246. * Activates the reduction computation.
  141247. * When activated, the observers registered in onAfterReductionPerformed are
  141248. * called after the compuation is performed
  141249. */
  141250. activate(): void;
  141251. /**
  141252. * Deactivates the reduction computation.
  141253. */
  141254. deactivate(): void;
  141255. /**
  141256. * Disposes the depth reducer
  141257. * @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.
  141258. */
  141259. dispose(disposeAll?: boolean): void;
  141260. }
  141261. }
  141262. declare module BABYLON {
  141263. /**
  141264. * A CSM implementation allowing casting shadows on large scenes.
  141265. * Documentation : https://doc.babylonjs.com/babylon101/cascadedShadows
  141266. * Based on: https://github.com/TheRealMJP/Shadows and https://johanmedestrom.wordpress.com/2016/03/18/opengl-cascaded-shadow-maps/
  141267. */
  141268. export class CascadedShadowGenerator extends ShadowGenerator {
  141269. private static readonly frustumCornersNDCSpace;
  141270. /**
  141271. * Name of the CSM class
  141272. */
  141273. static CLASSNAME: string;
  141274. /**
  141275. * Defines the default number of cascades used by the CSM.
  141276. */
  141277. static readonly DEFAULT_CASCADES_COUNT: number;
  141278. /**
  141279. * Defines the minimum number of cascades used by the CSM.
  141280. */
  141281. static readonly MIN_CASCADES_COUNT: number;
  141282. /**
  141283. * Defines the maximum number of cascades used by the CSM.
  141284. */
  141285. static readonly MAX_CASCADES_COUNT: number;
  141286. protected _validateFilter(filter: number): number;
  141287. /**
  141288. * Gets or sets the actual darkness of the soft shadows while using PCSS filtering (value between 0. and 1.)
  141289. */
  141290. penumbraDarkness: number;
  141291. private _numCascades;
  141292. /**
  141293. * Gets or set the number of cascades used by the CSM.
  141294. */
  141295. get numCascades(): number;
  141296. set numCascades(value: number);
  141297. /**
  141298. * Sets this to true if you want that the edges of the shadows don't "swimm" / "shimmer" when rotating the camera.
  141299. * The trade off is that you lose some precision in the shadow rendering when enabling this setting.
  141300. */
  141301. stabilizeCascades: boolean;
  141302. private _freezeShadowCastersBoundingInfo;
  141303. private _freezeShadowCastersBoundingInfoObservable;
  141304. /**
  141305. * Enables or disables the shadow casters bounding info computation.
  141306. * If your shadow casters don't move, you can disable this feature.
  141307. * If it is enabled, the bounding box computation is done every frame.
  141308. */
  141309. get freezeShadowCastersBoundingInfo(): boolean;
  141310. set freezeShadowCastersBoundingInfo(freeze: boolean);
  141311. private _scbiMin;
  141312. private _scbiMax;
  141313. protected _computeShadowCastersBoundingInfo(): void;
  141314. protected _shadowCastersBoundingInfo: BoundingInfo;
  141315. /**
  141316. * Gets or sets the shadow casters bounding info.
  141317. * If you provide your own shadow casters bounding info, first enable freezeShadowCastersBoundingInfo
  141318. * so that the system won't overwrite the bounds you provide
  141319. */
  141320. get shadowCastersBoundingInfo(): BoundingInfo;
  141321. set shadowCastersBoundingInfo(boundingInfo: BoundingInfo);
  141322. protected _breaksAreDirty: boolean;
  141323. protected _minDistance: number;
  141324. protected _maxDistance: number;
  141325. /**
  141326. * Sets the minimal and maximal distances to use when computing the cascade breaks.
  141327. *
  141328. * The values of min / max are typically the depth zmin and zmax values of your scene, for a given frame.
  141329. * If you don't know these values, simply leave them to their defaults and don't call this function.
  141330. * @param min minimal distance for the breaks (default to 0.)
  141331. * @param max maximal distance for the breaks (default to 1.)
  141332. */
  141333. setMinMaxDistance(min: number, max: number): void;
  141334. /** Gets the minimal distance used in the cascade break computation */
  141335. get minDistance(): number;
  141336. /** Gets the maximal distance used in the cascade break computation */
  141337. get maxDistance(): number;
  141338. /**
  141339. * Gets the class name of that object
  141340. * @returns "CascadedShadowGenerator"
  141341. */
  141342. getClassName(): string;
  141343. private _cascadeMinExtents;
  141344. private _cascadeMaxExtents;
  141345. /**
  141346. * Gets a cascade minimum extents
  141347. * @param cascadeIndex index of the cascade
  141348. * @returns the minimum cascade extents
  141349. */
  141350. getCascadeMinExtents(cascadeIndex: number): Nullable<Vector3>;
  141351. /**
  141352. * Gets a cascade maximum extents
  141353. * @param cascadeIndex index of the cascade
  141354. * @returns the maximum cascade extents
  141355. */
  141356. getCascadeMaxExtents(cascadeIndex: number): Nullable<Vector3>;
  141357. private _cascades;
  141358. private _currentLayer;
  141359. private _viewSpaceFrustumsZ;
  141360. private _viewMatrices;
  141361. private _projectionMatrices;
  141362. private _transformMatrices;
  141363. private _transformMatricesAsArray;
  141364. private _frustumLengths;
  141365. private _lightSizeUVCorrection;
  141366. private _depthCorrection;
  141367. private _frustumCornersWorldSpace;
  141368. private _frustumCenter;
  141369. private _shadowCameraPos;
  141370. private _shadowMaxZ;
  141371. /**
  141372. * Gets the shadow max z distance. It's the limit beyond which shadows are not displayed.
  141373. * It defaults to camera.maxZ
  141374. */
  141375. get shadowMaxZ(): number;
  141376. /**
  141377. * Sets the shadow max z distance.
  141378. */
  141379. set shadowMaxZ(value: number);
  141380. protected _debug: boolean;
  141381. /**
  141382. * Gets or sets the debug flag.
  141383. * When enabled, the cascades are materialized by different colors on the screen.
  141384. */
  141385. get debug(): boolean;
  141386. set debug(dbg: boolean);
  141387. private _depthClamp;
  141388. /**
  141389. * Gets or sets the depth clamping value.
  141390. *
  141391. * When enabled, it improves the shadow quality because the near z plane of the light frustum don't need to be adjusted
  141392. * to account for the shadow casters far away.
  141393. *
  141394. * Note that this property is incompatible with PCSS filtering, so it won't be used in that case.
  141395. */
  141396. get depthClamp(): boolean;
  141397. set depthClamp(value: boolean);
  141398. private _cascadeBlendPercentage;
  141399. /**
  141400. * Gets or sets the percentage of blending between two cascades (value between 0. and 1.).
  141401. * It defaults to 0.1 (10% blending).
  141402. */
  141403. get cascadeBlendPercentage(): number;
  141404. set cascadeBlendPercentage(value: number);
  141405. private _lambda;
  141406. /**
  141407. * Gets or set the lambda parameter.
  141408. * This parameter is used to split the camera frustum and create the cascades.
  141409. * 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.
  141410. * For all values in-between, it's a linear combination of the uniform and logarithm split algorithm.
  141411. */
  141412. get lambda(): number;
  141413. set lambda(value: number);
  141414. /**
  141415. * Gets the view matrix corresponding to a given cascade
  141416. * @param cascadeNum cascade to retrieve the view matrix from
  141417. * @returns the cascade view matrix
  141418. */
  141419. getCascadeViewMatrix(cascadeNum: number): Nullable<Matrix>;
  141420. /**
  141421. * Gets the projection matrix corresponding to a given cascade
  141422. * @param cascadeNum cascade to retrieve the projection matrix from
  141423. * @returns the cascade projection matrix
  141424. */
  141425. getCascadeProjectionMatrix(cascadeNum: number): Nullable<Matrix>;
  141426. /**
  141427. * Gets the transformation matrix corresponding to a given cascade
  141428. * @param cascadeNum cascade to retrieve the transformation matrix from
  141429. * @returns the cascade transformation matrix
  141430. */
  141431. getCascadeTransformMatrix(cascadeNum: number): Nullable<Matrix>;
  141432. private _depthRenderer;
  141433. /**
  141434. * Sets the depth renderer to use when autoCalcDepthBounds is enabled.
  141435. *
  141436. * Note that if no depth renderer is set, a new one will be automatically created internally when necessary.
  141437. *
  141438. * You should call this function if you already have a depth renderer enabled in your scene, to avoid
  141439. * doing multiple depth rendering each frame. If you provide your own depth renderer, make sure it stores linear depth!
  141440. * @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
  141441. */
  141442. setDepthRenderer(depthRenderer: Nullable<DepthRenderer>): void;
  141443. private _depthReducer;
  141444. private _autoCalcDepthBounds;
  141445. /**
  141446. * Gets or sets the autoCalcDepthBounds property.
  141447. *
  141448. * When enabled, a depth rendering pass is first performed (with an internally created depth renderer or with the one
  141449. * you provide by calling setDepthRenderer). Then, a min/max reducing is applied on the depth map to compute the
  141450. * minimal and maximal depth of the map and those values are used as inputs for the setMinMaxDistance() function.
  141451. * It can greatly enhance the shadow quality, at the expense of more GPU works.
  141452. * When using this option, you should increase the value of the lambda parameter, and even set it to 1 for best results.
  141453. */
  141454. get autoCalcDepthBounds(): boolean;
  141455. set autoCalcDepthBounds(value: boolean);
  141456. /**
  141457. * Defines the refresh rate of the min/max computation used when autoCalcDepthBounds is set to true
  141458. * Use 0 to compute just once, 1 to compute on every frame, 2 to compute every two frames and so on...
  141459. * Note that if you provided your own depth renderer through a call to setDepthRenderer, you are responsible
  141460. * for setting the refresh rate on the renderer yourself!
  141461. */
  141462. get autoCalcDepthBoundsRefreshRate(): number;
  141463. set autoCalcDepthBoundsRefreshRate(value: number);
  141464. /**
  141465. * Create the cascade breaks according to the lambda, shadowMaxZ and min/max distance properties, as well as the camera near and far planes.
  141466. * This function is automatically called when updating lambda, shadowMaxZ and min/max distances, however you should call it yourself if
  141467. * you change the camera near/far planes!
  141468. */
  141469. splitFrustum(): void;
  141470. private _splitFrustum;
  141471. private _computeMatrices;
  141472. private _computeFrustumInWorldSpace;
  141473. private _computeCascadeFrustum;
  141474. /**
  141475. * Support test.
  141476. */
  141477. static get IsSupported(): boolean;
  141478. /** @hidden */
  141479. static _SceneComponentInitialization: (scene: Scene) => void;
  141480. /**
  141481. * Creates a Cascaded Shadow Generator object.
  141482. * A ShadowGenerator is the required tool to use the shadows.
  141483. * Each directional light casting shadows needs to use its own ShadowGenerator.
  141484. * Documentation : https://doc.babylonjs.com/babylon101/cascadedShadows
  141485. * @param mapSize The size of the texture what stores the shadows. Example : 1024.
  141486. * @param light The directional light object generating the shadows.
  141487. * @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.
  141488. */
  141489. constructor(mapSize: number, light: DirectionalLight, usefulFloatFirst?: boolean);
  141490. protected _initializeGenerator(): void;
  141491. protected _createTargetRenderTexture(): void;
  141492. protected _initializeShadowMap(): void;
  141493. protected _bindCustomEffectForRenderSubMeshForShadowMap(subMesh: SubMesh, effect: Effect, matriceNames: any, mesh: AbstractMesh): void;
  141494. protected _isReadyCustomDefines(defines: any, subMesh: SubMesh, useInstances: boolean): void;
  141495. /**
  141496. * Prepare all the defines in a material relying on a shadow map at the specified light index.
  141497. * @param defines Defines of the material we want to update
  141498. * @param lightIndex Index of the light in the enabled light list of the material
  141499. */
  141500. prepareDefines(defines: any, lightIndex: number): void;
  141501. /**
  141502. * Binds the shadow related information inside of an effect (information like near, far, darkness...
  141503. * defined in the generator but impacting the effect).
  141504. * @param lightIndex Index of the light in the enabled light list of the material owning the effect
  141505. * @param effect The effect we are binfing the information for
  141506. */
  141507. bindShadowLight(lightIndex: string, effect: Effect): void;
  141508. /**
  141509. * Gets the transformation matrix of the first cascade used to project the meshes into the map from the light point of view.
  141510. * (eq to view projection * shadow projection matrices)
  141511. * @returns The transform matrix used to create the shadow map
  141512. */
  141513. getTransformMatrix(): Matrix;
  141514. /**
  141515. * Disposes the ShadowGenerator.
  141516. * Returns nothing.
  141517. */
  141518. dispose(): void;
  141519. /**
  141520. * Serializes the shadow generator setup to a json object.
  141521. * @returns The serialized JSON object
  141522. */
  141523. serialize(): any;
  141524. /**
  141525. * Parses a serialized ShadowGenerator and returns a new ShadowGenerator.
  141526. * @param parsedShadowGenerator The JSON object to parse
  141527. * @param scene The scene to create the shadow map for
  141528. * @returns The parsed shadow generator
  141529. */
  141530. static Parse(parsedShadowGenerator: any, scene: Scene): ShadowGenerator;
  141531. }
  141532. }
  141533. declare module BABYLON {
  141534. /**
  141535. * Defines the shadow generator component responsible to manage any shadow generators
  141536. * in a given scene.
  141537. */
  141538. export class ShadowGeneratorSceneComponent implements ISceneSerializableComponent {
  141539. /**
  141540. * The component name helpfull to identify the component in the list of scene components.
  141541. */
  141542. readonly name: string;
  141543. /**
  141544. * The scene the component belongs to.
  141545. */
  141546. scene: Scene;
  141547. /**
  141548. * Creates a new instance of the component for the given scene
  141549. * @param scene Defines the scene to register the component in
  141550. */
  141551. constructor(scene: Scene);
  141552. /**
  141553. * Registers the component in a given scene
  141554. */
  141555. register(): void;
  141556. /**
  141557. * Rebuilds the elements related to this component in case of
  141558. * context lost for instance.
  141559. */
  141560. rebuild(): void;
  141561. /**
  141562. * Serializes the component data to the specified json object
  141563. * @param serializationObject The object to serialize to
  141564. */
  141565. serialize(serializationObject: any): void;
  141566. /**
  141567. * Adds all the elements from the container to the scene
  141568. * @param container the container holding the elements
  141569. */
  141570. addFromContainer(container: AbstractScene): void;
  141571. /**
  141572. * Removes all the elements in the container from the scene
  141573. * @param container contains the elements to remove
  141574. * @param dispose if the removed element should be disposed (default: false)
  141575. */
  141576. removeFromContainer(container: AbstractScene, dispose?: boolean): void;
  141577. /**
  141578. * Rebuilds the elements related to this component in case of
  141579. * context lost for instance.
  141580. */
  141581. dispose(): void;
  141582. private _gatherRenderTargets;
  141583. }
  141584. }
  141585. declare module BABYLON {
  141586. /**
  141587. * A point light is a light defined by an unique point in world space.
  141588. * The light is emitted in every direction from this point.
  141589. * A good example of a point light is a standard light bulb.
  141590. * Documentation: https://doc.babylonjs.com/babylon101/lights
  141591. */
  141592. export class PointLight extends ShadowLight {
  141593. private _shadowAngle;
  141594. /**
  141595. * Getter: In case of direction provided, the shadow will not use a cube texture but simulate a spot shadow as a fallback
  141596. * This specifies what angle the shadow will use to be created.
  141597. *
  141598. * It default to 90 degrees to work nicely with the cube texture generation for point lights shadow maps.
  141599. */
  141600. get shadowAngle(): number;
  141601. /**
  141602. * Setter: In case of direction provided, the shadow will not use a cube texture but simulate a spot shadow as a fallback
  141603. * This specifies what angle the shadow will use to be created.
  141604. *
  141605. * It default to 90 degrees to work nicely with the cube texture generation for point lights shadow maps.
  141606. */
  141607. set shadowAngle(value: number);
  141608. /**
  141609. * Gets the direction if it has been set.
  141610. * In case of direction provided, the shadow will not use a cube texture but simulate a spot shadow as a fallback
  141611. */
  141612. get direction(): Vector3;
  141613. /**
  141614. * In case of direction provided, the shadow will not use a cube texture but simulate a spot shadow as a fallback
  141615. */
  141616. set direction(value: Vector3);
  141617. /**
  141618. * Creates a PointLight object from the passed name and position (Vector3) and adds it in the scene.
  141619. * A PointLight emits the light in every direction.
  141620. * It can cast shadows.
  141621. * If the scene camera is already defined and you want to set your PointLight at the camera position, just set it :
  141622. * ```javascript
  141623. * var pointLight = new PointLight("pl", camera.position, scene);
  141624. * ```
  141625. * Documentation : https://doc.babylonjs.com/babylon101/lights
  141626. * @param name The light friendly name
  141627. * @param position The position of the point light in the scene
  141628. * @param scene The scene the lights belongs to
  141629. */
  141630. constructor(name: string, position: Vector3, scene: Scene);
  141631. /**
  141632. * Returns the string "PointLight"
  141633. * @returns the class name
  141634. */
  141635. getClassName(): string;
  141636. /**
  141637. * Returns the integer 0.
  141638. * @returns The light Type id as a constant defines in Light.LIGHTTYPEID_x
  141639. */
  141640. getTypeID(): number;
  141641. /**
  141642. * Specifies wether or not the shadowmap should be a cube texture.
  141643. * @returns true if the shadowmap needs to be a cube texture.
  141644. */
  141645. needCube(): boolean;
  141646. /**
  141647. * Returns a new Vector3 aligned with the PointLight cube system according to the passed cube face index (integer).
  141648. * @param faceIndex The index of the face we are computed the direction to generate shadow
  141649. * @returns The set direction in 2d mode otherwise the direction to the cubemap face if needCube() is true
  141650. */
  141651. getShadowDirection(faceIndex?: number): Vector3;
  141652. /**
  141653. * Sets the passed matrix "matrix" as a left-handed perspective projection matrix with the following settings :
  141654. * - fov = PI / 2
  141655. * - aspect ratio : 1.0
  141656. * - z-near and far equal to the active camera minZ and maxZ.
  141657. * Returns the PointLight.
  141658. */
  141659. protected _setDefaultShadowProjectionMatrix(matrix: Matrix, viewMatrix: Matrix, renderList: Array<AbstractMesh>): void;
  141660. protected _buildUniformLayout(): void;
  141661. /**
  141662. * Sets the passed Effect "effect" with the PointLight transformed position (or position, if none) and passed name (string).
  141663. * @param effect The effect to update
  141664. * @param lightIndex The index of the light in the effect to update
  141665. * @returns The point light
  141666. */
  141667. transferToEffect(effect: Effect, lightIndex: string): PointLight;
  141668. transferToNodeMaterialEffect(effect: Effect, lightDataUniformName: string): this;
  141669. /**
  141670. * Prepares the list of defines specific to the light type.
  141671. * @param defines the list of defines
  141672. * @param lightIndex defines the index of the light for the effect
  141673. */
  141674. prepareLightSpecificDefines(defines: any, lightIndex: number): void;
  141675. }
  141676. }
  141677. declare module BABYLON {
  141678. /**
  141679. * Header information of HDR texture files.
  141680. */
  141681. export interface HDRInfo {
  141682. /**
  141683. * The height of the texture in pixels.
  141684. */
  141685. height: number;
  141686. /**
  141687. * The width of the texture in pixels.
  141688. */
  141689. width: number;
  141690. /**
  141691. * The index of the beginning of the data in the binary file.
  141692. */
  141693. dataPosition: number;
  141694. }
  141695. /**
  141696. * This groups tools to convert HDR texture to native colors array.
  141697. */
  141698. export class HDRTools {
  141699. private static Ldexp;
  141700. private static Rgbe2float;
  141701. private static readStringLine;
  141702. /**
  141703. * Reads header information from an RGBE texture stored in a native array.
  141704. * More information on this format are available here:
  141705. * https://en.wikipedia.org/wiki/RGBE_image_format
  141706. *
  141707. * @param uint8array The binary file stored in native array.
  141708. * @return The header information.
  141709. */
  141710. static RGBE_ReadHeader(uint8array: Uint8Array): HDRInfo;
  141711. /**
  141712. * Returns the cubemap information (each faces texture data) extracted from an RGBE texture.
  141713. * This RGBE texture needs to store the information as a panorama.
  141714. *
  141715. * More information on this format are available here:
  141716. * https://en.wikipedia.org/wiki/RGBE_image_format
  141717. *
  141718. * @param buffer The binary file stored in an array buffer.
  141719. * @param size The expected size of the extracted cubemap.
  141720. * @return The Cube Map information.
  141721. */
  141722. static GetCubeMapTextureData(buffer: ArrayBuffer, size: number): CubeMapInfo;
  141723. /**
  141724. * Returns the pixels data extracted from an RGBE texture.
  141725. * This pixels will be stored left to right up to down in the R G B order in one array.
  141726. *
  141727. * More information on this format are available here:
  141728. * https://en.wikipedia.org/wiki/RGBE_image_format
  141729. *
  141730. * @param uint8array The binary file stored in an array buffer.
  141731. * @param hdrInfo The header information of the file.
  141732. * @return The pixels data in RGB right to left up to down order.
  141733. */
  141734. static RGBE_ReadPixels(uint8array: Uint8Array, hdrInfo: HDRInfo): Float32Array;
  141735. private static RGBE_ReadPixels_RLE;
  141736. private static RGBE_ReadPixels_NOT_RLE;
  141737. }
  141738. }
  141739. declare module BABYLON {
  141740. /**
  141741. * Effect Render Options
  141742. */
  141743. export interface IEffectRendererOptions {
  141744. /**
  141745. * Defines the vertices positions.
  141746. */
  141747. positions?: number[];
  141748. /**
  141749. * Defines the indices.
  141750. */
  141751. indices?: number[];
  141752. }
  141753. /**
  141754. * Helper class to render one or more effects.
  141755. * You can access the previous rendering in your shader by declaring a sampler named textureSampler
  141756. */
  141757. export class EffectRenderer {
  141758. private engine;
  141759. private static _DefaultOptions;
  141760. private _vertexBuffers;
  141761. private _indexBuffer;
  141762. private _fullscreenViewport;
  141763. /**
  141764. * Creates an effect renderer
  141765. * @param engine the engine to use for rendering
  141766. * @param options defines the options of the effect renderer
  141767. */
  141768. constructor(engine: ThinEngine, options?: IEffectRendererOptions);
  141769. /**
  141770. * Sets the current viewport in normalized coordinates 0-1
  141771. * @param viewport Defines the viewport to set (defaults to 0 0 1 1)
  141772. */
  141773. setViewport(viewport?: Viewport): void;
  141774. /**
  141775. * Binds the embedded attributes buffer to the effect.
  141776. * @param effect Defines the effect to bind the attributes for
  141777. */
  141778. bindBuffers(effect: Effect): void;
  141779. /**
  141780. * Sets the current effect wrapper to use during draw.
  141781. * The effect needs to be ready before calling this api.
  141782. * This also sets the default full screen position attribute.
  141783. * @param effectWrapper Defines the effect to draw with
  141784. */
  141785. applyEffectWrapper(effectWrapper: EffectWrapper): void;
  141786. /**
  141787. * Restores engine states
  141788. */
  141789. restoreStates(): void;
  141790. /**
  141791. * Draws a full screen quad.
  141792. */
  141793. draw(): void;
  141794. private isRenderTargetTexture;
  141795. /**
  141796. * renders one or more effects to a specified texture
  141797. * @param effectWrapper the effect to renderer
  141798. * @param outputTexture texture to draw to, if null it will render to the screen.
  141799. */
  141800. render(effectWrapper: EffectWrapper, outputTexture?: Nullable<InternalTexture | RenderTargetTexture>): void;
  141801. /**
  141802. * Disposes of the effect renderer
  141803. */
  141804. dispose(): void;
  141805. }
  141806. /**
  141807. * Options to create an EffectWrapper
  141808. */
  141809. interface EffectWrapperCreationOptions {
  141810. /**
  141811. * Engine to use to create the effect
  141812. */
  141813. engine: ThinEngine;
  141814. /**
  141815. * Fragment shader for the effect
  141816. */
  141817. fragmentShader: string;
  141818. /**
  141819. * Use the shader store instead of direct source code
  141820. */
  141821. useShaderStore?: boolean;
  141822. /**
  141823. * Vertex shader for the effect
  141824. */
  141825. vertexShader?: string;
  141826. /**
  141827. * Attributes to use in the shader
  141828. */
  141829. attributeNames?: Array<string>;
  141830. /**
  141831. * Uniforms to use in the shader
  141832. */
  141833. uniformNames?: Array<string>;
  141834. /**
  141835. * Texture sampler names to use in the shader
  141836. */
  141837. samplerNames?: Array<string>;
  141838. /**
  141839. * Defines to use in the shader
  141840. */
  141841. defines?: Array<string>;
  141842. /**
  141843. * Callback when effect is compiled
  141844. */
  141845. onCompiled?: Nullable<(effect: Effect) => void>;
  141846. /**
  141847. * The friendly name of the effect displayed in Spector.
  141848. */
  141849. name?: string;
  141850. }
  141851. /**
  141852. * Wraps an effect to be used for rendering
  141853. */
  141854. export class EffectWrapper {
  141855. /**
  141856. * Event that is fired right before the effect is drawn (should be used to update uniforms)
  141857. */
  141858. onApplyObservable: Observable<{}>;
  141859. /**
  141860. * The underlying effect
  141861. */
  141862. effect: Effect;
  141863. /**
  141864. * Creates an effect to be renderer
  141865. * @param creationOptions options to create the effect
  141866. */
  141867. constructor(creationOptions: EffectWrapperCreationOptions);
  141868. /**
  141869. * Disposes of the effect wrapper
  141870. */
  141871. dispose(): void;
  141872. }
  141873. }
  141874. declare module BABYLON {
  141875. /** @hidden */
  141876. export var hdrFilteringVertexShader: {
  141877. name: string;
  141878. shader: string;
  141879. };
  141880. }
  141881. declare module BABYLON {
  141882. /** @hidden */
  141883. export var hdrFilteringPixelShader: {
  141884. name: string;
  141885. shader: string;
  141886. };
  141887. }
  141888. declare module BABYLON {
  141889. /**
  141890. * Options for texture filtering
  141891. */
  141892. interface IHDRFilteringOptions {
  141893. /**
  141894. * Scales pixel intensity for the input HDR map.
  141895. */
  141896. hdrScale?: number;
  141897. /**
  141898. * Quality of the filter. Should be `Constants.TEXTURE_FILTERING_QUALITY_OFFLINE` for prefiltering
  141899. */
  141900. quality?: number;
  141901. }
  141902. /**
  141903. * Filters HDR maps to get correct renderings of PBR reflections
  141904. */
  141905. export class HDRFiltering {
  141906. private _engine;
  141907. private _effectRenderer;
  141908. private _effectWrapper;
  141909. private _lodGenerationOffset;
  141910. private _lodGenerationScale;
  141911. /**
  141912. * Quality switch for prefiltering. Should be set to `Constants.TEXTURE_FILTERING_QUALITY_OFFLINE` unless
  141913. * you care about baking speed.
  141914. */
  141915. quality: number;
  141916. /**
  141917. * Scales pixel intensity for the input HDR map.
  141918. */
  141919. hdrScale: number;
  141920. /**
  141921. * Instantiates HDR filter for reflection maps
  141922. *
  141923. * @param engine Thin engine
  141924. * @param options Options
  141925. */
  141926. constructor(engine: ThinEngine, options?: IHDRFilteringOptions);
  141927. private _createRenderTarget;
  141928. private _prefilterInternal;
  141929. private _createEffect;
  141930. /**
  141931. * Get a value indicating if the filter is ready to be used
  141932. * @param texture Texture to filter
  141933. * @returns true if the filter is ready
  141934. */
  141935. isReady(texture: BaseTexture): boolean;
  141936. /**
  141937. * Prefilters a cube texture to have mipmap levels representing roughness values.
  141938. * Prefiltering will be invoked at the end of next rendering pass.
  141939. * This has to be done once the map is loaded, and has not been prefiltered by a third party software.
  141940. * See http://blog.selfshadow.com/publications/s2013-shading-course/karis/s2013_pbs_epic_notes_v2.pdf for more information
  141941. * @param texture Texture to filter
  141942. * @param onFinished Callback when filtering is done
  141943. * @return Promise called when prefiltering is done
  141944. */
  141945. prefilter(texture: BaseTexture, onFinished?: Nullable<() => void>): Promise<unknown> | undefined;
  141946. }
  141947. }
  141948. declare module BABYLON {
  141949. /**
  141950. * This represents a texture coming from an HDR input.
  141951. *
  141952. * The only supported format is currently panorama picture stored in RGBE format.
  141953. * Example of such files can be found on HDRLib: http://hdrlib.com/
  141954. */
  141955. export class HDRCubeTexture extends BaseTexture {
  141956. private static _facesMapping;
  141957. private _generateHarmonics;
  141958. private _noMipmap;
  141959. private _prefilterOnLoad;
  141960. private _textureMatrix;
  141961. private _size;
  141962. private _onLoad;
  141963. private _onError;
  141964. /**
  141965. * The texture URL.
  141966. */
  141967. url: string;
  141968. protected _isBlocking: boolean;
  141969. /**
  141970. * Sets wether or not the texture is blocking during loading.
  141971. */
  141972. set isBlocking(value: boolean);
  141973. /**
  141974. * Gets wether or not the texture is blocking during loading.
  141975. */
  141976. get isBlocking(): boolean;
  141977. protected _rotationY: number;
  141978. /**
  141979. * Sets texture matrix rotation angle around Y axis in radians.
  141980. */
  141981. set rotationY(value: number);
  141982. /**
  141983. * Gets texture matrix rotation angle around Y axis radians.
  141984. */
  141985. get rotationY(): number;
  141986. /**
  141987. * Gets or sets the center of the bounding box associated with the cube texture
  141988. * It must define where the camera used to render the texture was set
  141989. */
  141990. boundingBoxPosition: Vector3;
  141991. private _boundingBoxSize;
  141992. /**
  141993. * Gets or sets the size of the bounding box associated with the cube texture
  141994. * When defined, the cubemap will switch to local mode
  141995. * @see https://community.arm.com/graphics/b/blog/posts/reflections-based-on-local-cubemaps-in-unity
  141996. * @example https://www.babylonjs-playground.com/#RNASML
  141997. */
  141998. set boundingBoxSize(value: Vector3);
  141999. get boundingBoxSize(): Vector3;
  142000. /**
  142001. * Instantiates an HDRTexture from the following parameters.
  142002. *
  142003. * @param url The location of the HDR raw data (Panorama stored in RGBE format)
  142004. * @param sceneOrEngine The scene or engine the texture will be used in
  142005. * @param size The cubemap desired size (the more it increases the longer the generation will be)
  142006. * @param noMipmap Forces to not generate the mipmap if true
  142007. * @param generateHarmonics Specifies whether you want to extract the polynomial harmonics during the generation process
  142008. * @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)
  142009. * @param prefilterOnLoad Prefilters HDR texture to allow use of this texture as a PBR reflection texture.
  142010. */
  142011. 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>);
  142012. /**
  142013. * Get the current class name of the texture useful for serialization or dynamic coding.
  142014. * @returns "HDRCubeTexture"
  142015. */
  142016. getClassName(): string;
  142017. /**
  142018. * Occurs when the file is raw .hdr file.
  142019. */
  142020. private loadTexture;
  142021. clone(): HDRCubeTexture;
  142022. delayLoad(): void;
  142023. /**
  142024. * Get the texture reflection matrix used to rotate/transform the reflection.
  142025. * @returns the reflection matrix
  142026. */
  142027. getReflectionTextureMatrix(): Matrix;
  142028. /**
  142029. * Set the texture reflection matrix used to rotate/transform the reflection.
  142030. * @param value Define the reflection matrix to set
  142031. */
  142032. setReflectionTextureMatrix(value: Matrix): void;
  142033. /**
  142034. * Parses a JSON representation of an HDR Texture in order to create the texture
  142035. * @param parsedTexture Define the JSON representation
  142036. * @param scene Define the scene the texture should be created in
  142037. * @param rootUrl Define the root url in case we need to load relative dependencies
  142038. * @returns the newly created texture after parsing
  142039. */
  142040. static Parse(parsedTexture: any, scene: Scene, rootUrl: string): Nullable<HDRCubeTexture>;
  142041. serialize(): any;
  142042. }
  142043. }
  142044. declare module BABYLON {
  142045. /**
  142046. * Class used to control physics engine
  142047. * @see https://doc.babylonjs.com/how_to/using_the_physics_engine
  142048. */
  142049. export class PhysicsEngine implements IPhysicsEngine {
  142050. private _physicsPlugin;
  142051. /**
  142052. * Global value used to control the smallest number supported by the simulation
  142053. */
  142054. static Epsilon: number;
  142055. private _impostors;
  142056. private _joints;
  142057. private _subTimeStep;
  142058. /**
  142059. * Gets the gravity vector used by the simulation
  142060. */
  142061. gravity: Vector3;
  142062. /**
  142063. * Factory used to create the default physics plugin.
  142064. * @returns The default physics plugin
  142065. */
  142066. static DefaultPluginFactory(): IPhysicsEnginePlugin;
  142067. /**
  142068. * Creates a new Physics Engine
  142069. * @param gravity defines the gravity vector used by the simulation
  142070. * @param _physicsPlugin defines the plugin to use (CannonJS by default)
  142071. */
  142072. constructor(gravity: Nullable<Vector3>, _physicsPlugin?: IPhysicsEnginePlugin);
  142073. /**
  142074. * Sets the gravity vector used by the simulation
  142075. * @param gravity defines the gravity vector to use
  142076. */
  142077. setGravity(gravity: Vector3): void;
  142078. /**
  142079. * Set the time step of the physics engine.
  142080. * Default is 1/60.
  142081. * To slow it down, enter 1/600 for example.
  142082. * To speed it up, 1/30
  142083. * @param newTimeStep defines the new timestep to apply to this world.
  142084. */
  142085. setTimeStep(newTimeStep?: number): void;
  142086. /**
  142087. * Get the time step of the physics engine.
  142088. * @returns the current time step
  142089. */
  142090. getTimeStep(): number;
  142091. /**
  142092. * Set the sub time step of the physics engine.
  142093. * Default is 0 meaning there is no sub steps
  142094. * To increase physics resolution precision, set a small value (like 1 ms)
  142095. * @param subTimeStep defines the new sub timestep used for physics resolution.
  142096. */
  142097. setSubTimeStep(subTimeStep?: number): void;
  142098. /**
  142099. * Get the sub time step of the physics engine.
  142100. * @returns the current sub time step
  142101. */
  142102. getSubTimeStep(): number;
  142103. /**
  142104. * Release all resources
  142105. */
  142106. dispose(): void;
  142107. /**
  142108. * Gets the name of the current physics plugin
  142109. * @returns the name of the plugin
  142110. */
  142111. getPhysicsPluginName(): string;
  142112. /**
  142113. * Adding a new impostor for the impostor tracking.
  142114. * This will be done by the impostor itself.
  142115. * @param impostor the impostor to add
  142116. */
  142117. addImpostor(impostor: PhysicsImpostor): void;
  142118. /**
  142119. * Remove an impostor from the engine.
  142120. * This impostor and its mesh will not longer be updated by the physics engine.
  142121. * @param impostor the impostor to remove
  142122. */
  142123. removeImpostor(impostor: PhysicsImpostor): void;
  142124. /**
  142125. * Add a joint to the physics engine
  142126. * @param mainImpostor defines the main impostor to which the joint is added.
  142127. * @param connectedImpostor defines the impostor that is connected to the main impostor using this joint
  142128. * @param joint defines the joint that will connect both impostors.
  142129. */
  142130. addJoint(mainImpostor: PhysicsImpostor, connectedImpostor: PhysicsImpostor, joint: PhysicsJoint): void;
  142131. /**
  142132. * Removes a joint from the simulation
  142133. * @param mainImpostor defines the impostor used with the joint
  142134. * @param connectedImpostor defines the other impostor connected to the main one by the joint
  142135. * @param joint defines the joint to remove
  142136. */
  142137. removeJoint(mainImpostor: PhysicsImpostor, connectedImpostor: PhysicsImpostor, joint: PhysicsJoint): void;
  142138. /**
  142139. * Called by the scene. No need to call it.
  142140. * @param delta defines the timespam between frames
  142141. */
  142142. _step(delta: number): void;
  142143. /**
  142144. * Gets the current plugin used to run the simulation
  142145. * @returns current plugin
  142146. */
  142147. getPhysicsPlugin(): IPhysicsEnginePlugin;
  142148. /**
  142149. * Gets the list of physic impostors
  142150. * @returns an array of PhysicsImpostor
  142151. */
  142152. getImpostors(): Array<PhysicsImpostor>;
  142153. /**
  142154. * Gets the impostor for a physics enabled object
  142155. * @param object defines the object impersonated by the impostor
  142156. * @returns the PhysicsImpostor or null if not found
  142157. */
  142158. getImpostorForPhysicsObject(object: IPhysicsEnabledObject): Nullable<PhysicsImpostor>;
  142159. /**
  142160. * Gets the impostor for a physics body object
  142161. * @param body defines physics body used by the impostor
  142162. * @returns the PhysicsImpostor or null if not found
  142163. */
  142164. getImpostorWithPhysicsBody(body: any): Nullable<PhysicsImpostor>;
  142165. /**
  142166. * Does a raycast in the physics world
  142167. * @param from when should the ray start?
  142168. * @param to when should the ray end?
  142169. * @returns PhysicsRaycastResult
  142170. */
  142171. raycast(from: Vector3, to: Vector3): PhysicsRaycastResult;
  142172. }
  142173. }
  142174. declare module BABYLON {
  142175. /** @hidden */
  142176. export class CannonJSPlugin implements IPhysicsEnginePlugin {
  142177. private _useDeltaForWorldStep;
  142178. world: any;
  142179. name: string;
  142180. private _physicsMaterials;
  142181. private _fixedTimeStep;
  142182. private _cannonRaycastResult;
  142183. private _raycastResult;
  142184. private _physicsBodysToRemoveAfterStep;
  142185. private _firstFrame;
  142186. BJSCANNON: any;
  142187. constructor(_useDeltaForWorldStep?: boolean, iterations?: number, cannonInjection?: any);
  142188. setGravity(gravity: Vector3): void;
  142189. setTimeStep(timeStep: number): void;
  142190. getTimeStep(): number;
  142191. executeStep(delta: number, impostors: Array<PhysicsImpostor>): void;
  142192. private _removeMarkedPhysicsBodiesFromWorld;
  142193. applyImpulse(impostor: PhysicsImpostor, force: Vector3, contactPoint: Vector3): void;
  142194. applyForce(impostor: PhysicsImpostor, force: Vector3, contactPoint: Vector3): void;
  142195. generatePhysicsBody(impostor: PhysicsImpostor): void;
  142196. private _processChildMeshes;
  142197. removePhysicsBody(impostor: PhysicsImpostor): void;
  142198. generateJoint(impostorJoint: PhysicsImpostorJoint): void;
  142199. removeJoint(impostorJoint: PhysicsImpostorJoint): void;
  142200. private _addMaterial;
  142201. private _checkWithEpsilon;
  142202. private _createShape;
  142203. private _createHeightmap;
  142204. private _minus90X;
  142205. private _plus90X;
  142206. private _tmpPosition;
  142207. private _tmpDeltaPosition;
  142208. private _tmpUnityRotation;
  142209. private _updatePhysicsBodyTransformation;
  142210. setTransformationFromPhysicsBody(impostor: PhysicsImpostor): void;
  142211. setPhysicsBodyTransformation(impostor: PhysicsImpostor, newPosition: Vector3, newRotation: Quaternion): void;
  142212. isSupported(): boolean;
  142213. setLinearVelocity(impostor: PhysicsImpostor, velocity: Vector3): void;
  142214. setAngularVelocity(impostor: PhysicsImpostor, velocity: Vector3): void;
  142215. getLinearVelocity(impostor: PhysicsImpostor): Nullable<Vector3>;
  142216. getAngularVelocity(impostor: PhysicsImpostor): Nullable<Vector3>;
  142217. setBodyMass(impostor: PhysicsImpostor, mass: number): void;
  142218. getBodyMass(impostor: PhysicsImpostor): number;
  142219. getBodyFriction(impostor: PhysicsImpostor): number;
  142220. setBodyFriction(impostor: PhysicsImpostor, friction: number): void;
  142221. getBodyRestitution(impostor: PhysicsImpostor): number;
  142222. setBodyRestitution(impostor: PhysicsImpostor, restitution: number): void;
  142223. sleepBody(impostor: PhysicsImpostor): void;
  142224. wakeUpBody(impostor: PhysicsImpostor): void;
  142225. updateDistanceJoint(joint: PhysicsJoint, maxDistance: number): void;
  142226. setMotor(joint: IMotorEnabledJoint, speed?: number, maxForce?: number, motorIndex?: number): void;
  142227. setLimit(joint: IMotorEnabledJoint, upperLimit: number, lowerLimit?: number): void;
  142228. syncMeshWithImpostor(mesh: AbstractMesh, impostor: PhysicsImpostor): void;
  142229. getRadius(impostor: PhysicsImpostor): number;
  142230. getBoxSizeToRef(impostor: PhysicsImpostor, result: Vector3): void;
  142231. dispose(): void;
  142232. private _extendNamespace;
  142233. /**
  142234. * Does a raycast in the physics world
  142235. * @param from when should the ray start?
  142236. * @param to when should the ray end?
  142237. * @returns PhysicsRaycastResult
  142238. */
  142239. raycast(from: Vector3, to: Vector3): PhysicsRaycastResult;
  142240. }
  142241. }
  142242. declare module BABYLON {
  142243. /** @hidden */
  142244. export class OimoJSPlugin implements IPhysicsEnginePlugin {
  142245. private _useDeltaForWorldStep;
  142246. world: any;
  142247. name: string;
  142248. BJSOIMO: any;
  142249. private _raycastResult;
  142250. private _fixedTimeStep;
  142251. constructor(_useDeltaForWorldStep?: boolean, iterations?: number, oimoInjection?: any);
  142252. setGravity(gravity: Vector3): void;
  142253. setTimeStep(timeStep: number): void;
  142254. getTimeStep(): number;
  142255. private _tmpImpostorsArray;
  142256. executeStep(delta: number, impostors: Array<PhysicsImpostor>): void;
  142257. applyImpulse(impostor: PhysicsImpostor, force: Vector3, contactPoint: Vector3): void;
  142258. applyForce(impostor: PhysicsImpostor, force: Vector3, contactPoint: Vector3): void;
  142259. generatePhysicsBody(impostor: PhysicsImpostor): void;
  142260. private _tmpPositionVector;
  142261. removePhysicsBody(impostor: PhysicsImpostor): void;
  142262. generateJoint(impostorJoint: PhysicsImpostorJoint): void;
  142263. removeJoint(impostorJoint: PhysicsImpostorJoint): void;
  142264. isSupported(): boolean;
  142265. setTransformationFromPhysicsBody(impostor: PhysicsImpostor): void;
  142266. setPhysicsBodyTransformation(impostor: PhysicsImpostor, newPosition: Vector3, newRotation: Quaternion): void;
  142267. setLinearVelocity(impostor: PhysicsImpostor, velocity: Vector3): void;
  142268. setAngularVelocity(impostor: PhysicsImpostor, velocity: Vector3): void;
  142269. getLinearVelocity(impostor: PhysicsImpostor): Nullable<Vector3>;
  142270. getAngularVelocity(impostor: PhysicsImpostor): Nullable<Vector3>;
  142271. setBodyMass(impostor: PhysicsImpostor, mass: number): void;
  142272. getBodyMass(impostor: PhysicsImpostor): number;
  142273. getBodyFriction(impostor: PhysicsImpostor): number;
  142274. setBodyFriction(impostor: PhysicsImpostor, friction: number): void;
  142275. getBodyRestitution(impostor: PhysicsImpostor): number;
  142276. setBodyRestitution(impostor: PhysicsImpostor, restitution: number): void;
  142277. sleepBody(impostor: PhysicsImpostor): void;
  142278. wakeUpBody(impostor: PhysicsImpostor): void;
  142279. updateDistanceJoint(joint: PhysicsJoint, maxDistance: number, minDistance?: number): void;
  142280. setMotor(joint: IMotorEnabledJoint, speed: number, force?: number, motorIndex?: number): void;
  142281. setLimit(joint: IMotorEnabledJoint, upperLimit: number, lowerLimit?: number, motorIndex?: number): void;
  142282. syncMeshWithImpostor(mesh: AbstractMesh, impostor: PhysicsImpostor): void;
  142283. getRadius(impostor: PhysicsImpostor): number;
  142284. getBoxSizeToRef(impostor: PhysicsImpostor, result: Vector3): void;
  142285. dispose(): void;
  142286. /**
  142287. * Does a raycast in the physics world
  142288. * @param from when should the ray start?
  142289. * @param to when should the ray end?
  142290. * @returns PhysicsRaycastResult
  142291. */
  142292. raycast(from: Vector3, to: Vector3): PhysicsRaycastResult;
  142293. }
  142294. }
  142295. declare module BABYLON {
  142296. /**
  142297. * AmmoJS Physics plugin
  142298. * @see https://doc.babylonjs.com/how_to/using_the_physics_engine
  142299. * @see https://github.com/kripken/ammo.js/
  142300. */
  142301. export class AmmoJSPlugin implements IPhysicsEnginePlugin {
  142302. private _useDeltaForWorldStep;
  142303. /**
  142304. * Reference to the Ammo library
  142305. */
  142306. bjsAMMO: any;
  142307. /**
  142308. * Created ammoJS world which physics bodies are added to
  142309. */
  142310. world: any;
  142311. /**
  142312. * Name of the plugin
  142313. */
  142314. name: string;
  142315. private _timeStep;
  142316. private _fixedTimeStep;
  142317. private _maxSteps;
  142318. private _tmpQuaternion;
  142319. private _tmpAmmoTransform;
  142320. private _tmpAmmoQuaternion;
  142321. private _tmpAmmoConcreteContactResultCallback;
  142322. private _collisionConfiguration;
  142323. private _dispatcher;
  142324. private _overlappingPairCache;
  142325. private _solver;
  142326. private _softBodySolver;
  142327. private _tmpAmmoVectorA;
  142328. private _tmpAmmoVectorB;
  142329. private _tmpAmmoVectorC;
  142330. private _tmpAmmoVectorD;
  142331. private _tmpContactCallbackResult;
  142332. private _tmpAmmoVectorRCA;
  142333. private _tmpAmmoVectorRCB;
  142334. private _raycastResult;
  142335. private _tmpContactPoint;
  142336. private static readonly DISABLE_COLLISION_FLAG;
  142337. private static readonly KINEMATIC_FLAG;
  142338. private static readonly DISABLE_DEACTIVATION_FLAG;
  142339. /**
  142340. * Initializes the ammoJS plugin
  142341. * @param _useDeltaForWorldStep if the time between frames should be used when calculating physics steps (Default: true)
  142342. * @param ammoInjection can be used to inject your own ammo reference
  142343. * @param overlappingPairCache can be used to specify your own overlapping pair cache
  142344. */
  142345. constructor(_useDeltaForWorldStep?: boolean, ammoInjection?: any, overlappingPairCache?: any);
  142346. /**
  142347. * Sets the gravity of the physics world (m/(s^2))
  142348. * @param gravity Gravity to set
  142349. */
  142350. setGravity(gravity: Vector3): void;
  142351. /**
  142352. * Amount of time to step forward on each frame (only used if useDeltaForWorldStep is false in the constructor)
  142353. * @param timeStep timestep to use in seconds
  142354. */
  142355. setTimeStep(timeStep: number): void;
  142356. /**
  142357. * 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)
  142358. * @param fixedTimeStep fixedTimeStep to use in seconds
  142359. */
  142360. setFixedTimeStep(fixedTimeStep: number): void;
  142361. /**
  142362. * Sets the maximum number of steps by the physics engine per frame (Default: 5)
  142363. * @param maxSteps the maximum number of steps by the physics engine per frame
  142364. */
  142365. setMaxSteps(maxSteps: number): void;
  142366. /**
  142367. * Gets the current timestep (only used if useDeltaForWorldStep is false in the constructor)
  142368. * @returns the current timestep in seconds
  142369. */
  142370. getTimeStep(): number;
  142371. /**
  142372. * The create custom shape handler function to be called when using BABYLON.PhysicsImposter.CustomImpostor
  142373. */
  142374. onCreateCustomShape: (impostor: PhysicsImpostor) => any;
  142375. private _isImpostorInContact;
  142376. private _isImpostorPairInContact;
  142377. private _stepSimulation;
  142378. /**
  142379. * Moves the physics simulation forward delta seconds and updates the given physics imposters
  142380. * Prior to the step the imposters physics location is set to the position of the babylon meshes
  142381. * After the step the babylon meshes are set to the position of the physics imposters
  142382. * @param delta amount of time to step forward
  142383. * @param impostors array of imposters to update before/after the step
  142384. */
  142385. executeStep(delta: number, impostors: Array<PhysicsImpostor>): void;
  142386. /**
  142387. * Update babylon mesh to match physics world object
  142388. * @param impostor imposter to match
  142389. */
  142390. private _afterSoftStep;
  142391. /**
  142392. * Update babylon mesh vertices vertices to match physics world softbody or cloth
  142393. * @param impostor imposter to match
  142394. */
  142395. private _ropeStep;
  142396. /**
  142397. * Update babylon mesh vertices vertices to match physics world softbody or cloth
  142398. * @param impostor imposter to match
  142399. */
  142400. private _softbodyOrClothStep;
  142401. private _tmpMatrix;
  142402. /**
  142403. * Applies an impulse on the imposter
  142404. * @param impostor imposter to apply impulse to
  142405. * @param force amount of force to be applied to the imposter
  142406. * @param contactPoint the location to apply the impulse on the imposter
  142407. */
  142408. applyImpulse(impostor: PhysicsImpostor, force: Vector3, contactPoint: Vector3): void;
  142409. /**
  142410. * Applies a force on the imposter
  142411. * @param impostor imposter to apply force
  142412. * @param force amount of force to be applied to the imposter
  142413. * @param contactPoint the location to apply the force on the imposter
  142414. */
  142415. applyForce(impostor: PhysicsImpostor, force: Vector3, contactPoint: Vector3): void;
  142416. /**
  142417. * Creates a physics body using the plugin
  142418. * @param impostor the imposter to create the physics body on
  142419. */
  142420. generatePhysicsBody(impostor: PhysicsImpostor): void;
  142421. /**
  142422. * Removes the physics body from the imposter and disposes of the body's memory
  142423. * @param impostor imposter to remove the physics body from
  142424. */
  142425. removePhysicsBody(impostor: PhysicsImpostor): void;
  142426. /**
  142427. * Generates a joint
  142428. * @param impostorJoint the imposter joint to create the joint with
  142429. */
  142430. generateJoint(impostorJoint: PhysicsImpostorJoint): void;
  142431. /**
  142432. * Removes a joint
  142433. * @param impostorJoint the imposter joint to remove the joint from
  142434. */
  142435. removeJoint(impostorJoint: PhysicsImpostorJoint): void;
  142436. private _addMeshVerts;
  142437. /**
  142438. * Initialise the soft body vertices to match its object's (mesh) vertices
  142439. * Softbody vertices (nodes) are in world space and to match this
  142440. * The object's position and rotation is set to zero and so its vertices are also then set in world space
  142441. * @param impostor to create the softbody for
  142442. */
  142443. private _softVertexData;
  142444. /**
  142445. * Create an impostor's soft body
  142446. * @param impostor to create the softbody for
  142447. */
  142448. private _createSoftbody;
  142449. /**
  142450. * Create cloth for an impostor
  142451. * @param impostor to create the softbody for
  142452. */
  142453. private _createCloth;
  142454. /**
  142455. * Create rope for an impostor
  142456. * @param impostor to create the softbody for
  142457. */
  142458. private _createRope;
  142459. /**
  142460. * Create a custom physics impostor shape using the plugin's onCreateCustomShape handler
  142461. * @param impostor to create the custom physics shape for
  142462. */
  142463. private _createCustom;
  142464. private _addHullVerts;
  142465. private _createShape;
  142466. /**
  142467. * Sets the physics body position/rotation from the babylon mesh's position/rotation
  142468. * @param impostor imposter containing the physics body and babylon object
  142469. */
  142470. setTransformationFromPhysicsBody(impostor: PhysicsImpostor): void;
  142471. /**
  142472. * Sets the babylon object's position/rotation from the physics body's position/rotation
  142473. * @param impostor imposter containing the physics body and babylon object
  142474. * @param newPosition new position
  142475. * @param newRotation new rotation
  142476. */
  142477. setPhysicsBodyTransformation(impostor: PhysicsImpostor, newPosition: Vector3, newRotation: Quaternion): void;
  142478. /**
  142479. * If this plugin is supported
  142480. * @returns true if its supported
  142481. */
  142482. isSupported(): boolean;
  142483. /**
  142484. * Sets the linear velocity of the physics body
  142485. * @param impostor imposter to set the velocity on
  142486. * @param velocity velocity to set
  142487. */
  142488. setLinearVelocity(impostor: PhysicsImpostor, velocity: Vector3): void;
  142489. /**
  142490. * Sets the angular velocity of the physics body
  142491. * @param impostor imposter to set the velocity on
  142492. * @param velocity velocity to set
  142493. */
  142494. setAngularVelocity(impostor: PhysicsImpostor, velocity: Vector3): void;
  142495. /**
  142496. * gets the linear velocity
  142497. * @param impostor imposter to get linear velocity from
  142498. * @returns linear velocity
  142499. */
  142500. getLinearVelocity(impostor: PhysicsImpostor): Nullable<Vector3>;
  142501. /**
  142502. * gets the angular velocity
  142503. * @param impostor imposter to get angular velocity from
  142504. * @returns angular velocity
  142505. */
  142506. getAngularVelocity(impostor: PhysicsImpostor): Nullable<Vector3>;
  142507. /**
  142508. * Sets the mass of physics body
  142509. * @param impostor imposter to set the mass on
  142510. * @param mass mass to set
  142511. */
  142512. setBodyMass(impostor: PhysicsImpostor, mass: number): void;
  142513. /**
  142514. * Gets the mass of the physics body
  142515. * @param impostor imposter to get the mass from
  142516. * @returns mass
  142517. */
  142518. getBodyMass(impostor: PhysicsImpostor): number;
  142519. /**
  142520. * Gets friction of the impostor
  142521. * @param impostor impostor to get friction from
  142522. * @returns friction value
  142523. */
  142524. getBodyFriction(impostor: PhysicsImpostor): number;
  142525. /**
  142526. * Sets friction of the impostor
  142527. * @param impostor impostor to set friction on
  142528. * @param friction friction value
  142529. */
  142530. setBodyFriction(impostor: PhysicsImpostor, friction: number): void;
  142531. /**
  142532. * Gets restitution of the impostor
  142533. * @param impostor impostor to get restitution from
  142534. * @returns restitution value
  142535. */
  142536. getBodyRestitution(impostor: PhysicsImpostor): number;
  142537. /**
  142538. * Sets resitution of the impostor
  142539. * @param impostor impostor to set resitution on
  142540. * @param restitution resitution value
  142541. */
  142542. setBodyRestitution(impostor: PhysicsImpostor, restitution: number): void;
  142543. /**
  142544. * Gets pressure inside the impostor
  142545. * @param impostor impostor to get pressure from
  142546. * @returns pressure value
  142547. */
  142548. getBodyPressure(impostor: PhysicsImpostor): number;
  142549. /**
  142550. * Sets pressure inside a soft body impostor
  142551. * Cloth and rope must remain 0 pressure
  142552. * @param impostor impostor to set pressure on
  142553. * @param pressure pressure value
  142554. */
  142555. setBodyPressure(impostor: PhysicsImpostor, pressure: number): void;
  142556. /**
  142557. * Gets stiffness of the impostor
  142558. * @param impostor impostor to get stiffness from
  142559. * @returns pressure value
  142560. */
  142561. getBodyStiffness(impostor: PhysicsImpostor): number;
  142562. /**
  142563. * Sets stiffness of the impostor
  142564. * @param impostor impostor to set stiffness on
  142565. * @param stiffness stiffness value from 0 to 1
  142566. */
  142567. setBodyStiffness(impostor: PhysicsImpostor, stiffness: number): void;
  142568. /**
  142569. * Gets velocityIterations of the impostor
  142570. * @param impostor impostor to get velocity iterations from
  142571. * @returns velocityIterations value
  142572. */
  142573. getBodyVelocityIterations(impostor: PhysicsImpostor): number;
  142574. /**
  142575. * Sets velocityIterations of the impostor
  142576. * @param impostor impostor to set velocity iterations on
  142577. * @param velocityIterations velocityIterations value
  142578. */
  142579. setBodyVelocityIterations(impostor: PhysicsImpostor, velocityIterations: number): void;
  142580. /**
  142581. * Gets positionIterations of the impostor
  142582. * @param impostor impostor to get position iterations from
  142583. * @returns positionIterations value
  142584. */
  142585. getBodyPositionIterations(impostor: PhysicsImpostor): number;
  142586. /**
  142587. * Sets positionIterations of the impostor
  142588. * @param impostor impostor to set position on
  142589. * @param positionIterations positionIterations value
  142590. */
  142591. setBodyPositionIterations(impostor: PhysicsImpostor, positionIterations: number): void;
  142592. /**
  142593. * Append an anchor to a cloth object
  142594. * @param impostor is the cloth impostor to add anchor to
  142595. * @param otherImpostor is the rigid impostor to anchor to
  142596. * @param width ratio across width from 0 to 1
  142597. * @param height ratio up height from 0 to 1
  142598. * @param influence the elasticity between cloth impostor and anchor from 0, very stretchy to 1, little strech
  142599. * @param noCollisionBetweenLinkedBodies when true collisions between soft impostor and anchor are ignored; default false
  142600. */
  142601. appendAnchor(impostor: PhysicsImpostor, otherImpostor: PhysicsImpostor, width: number, height: number, influence?: number, noCollisionBetweenLinkedBodies?: boolean): void;
  142602. /**
  142603. * Append an hook to a rope object
  142604. * @param impostor is the rope impostor to add hook to
  142605. * @param otherImpostor is the rigid impostor to hook to
  142606. * @param length ratio along the rope from 0 to 1
  142607. * @param influence the elasticity between soft impostor and anchor from 0, very stretchy to 1, little strech
  142608. * @param noCollisionBetweenLinkedBodies when true collisions between soft impostor and anchor are ignored; default false
  142609. */
  142610. appendHook(impostor: PhysicsImpostor, otherImpostor: PhysicsImpostor, length: number, influence?: number, noCollisionBetweenLinkedBodies?: boolean): void;
  142611. /**
  142612. * Sleeps the physics body and stops it from being active
  142613. * @param impostor impostor to sleep
  142614. */
  142615. sleepBody(impostor: PhysicsImpostor): void;
  142616. /**
  142617. * Activates the physics body
  142618. * @param impostor impostor to activate
  142619. */
  142620. wakeUpBody(impostor: PhysicsImpostor): void;
  142621. /**
  142622. * Updates the distance parameters of the joint
  142623. * @param joint joint to update
  142624. * @param maxDistance maximum distance of the joint
  142625. * @param minDistance minimum distance of the joint
  142626. */
  142627. updateDistanceJoint(joint: PhysicsJoint, maxDistance: number, minDistance?: number): void;
  142628. /**
  142629. * Sets a motor on the joint
  142630. * @param joint joint to set motor on
  142631. * @param speed speed of the motor
  142632. * @param maxForce maximum force of the motor
  142633. * @param motorIndex index of the motor
  142634. */
  142635. setMotor(joint: IMotorEnabledJoint, speed?: number, maxForce?: number, motorIndex?: number): void;
  142636. /**
  142637. * Sets the motors limit
  142638. * @param joint joint to set limit on
  142639. * @param upperLimit upper limit
  142640. * @param lowerLimit lower limit
  142641. */
  142642. setLimit(joint: IMotorEnabledJoint, upperLimit: number, lowerLimit?: number): void;
  142643. /**
  142644. * Syncs the position and rotation of a mesh with the impostor
  142645. * @param mesh mesh to sync
  142646. * @param impostor impostor to update the mesh with
  142647. */
  142648. syncMeshWithImpostor(mesh: AbstractMesh, impostor: PhysicsImpostor): void;
  142649. /**
  142650. * Gets the radius of the impostor
  142651. * @param impostor impostor to get radius from
  142652. * @returns the radius
  142653. */
  142654. getRadius(impostor: PhysicsImpostor): number;
  142655. /**
  142656. * Gets the box size of the impostor
  142657. * @param impostor impostor to get box size from
  142658. * @param result the resulting box size
  142659. */
  142660. getBoxSizeToRef(impostor: PhysicsImpostor, result: Vector3): void;
  142661. /**
  142662. * Disposes of the impostor
  142663. */
  142664. dispose(): void;
  142665. /**
  142666. * Does a raycast in the physics world
  142667. * @param from when should the ray start?
  142668. * @param to when should the ray end?
  142669. * @returns PhysicsRaycastResult
  142670. */
  142671. raycast(from: Vector3, to: Vector3): PhysicsRaycastResult;
  142672. }
  142673. }
  142674. declare module BABYLON {
  142675. interface AbstractScene {
  142676. /**
  142677. * The list of reflection probes added to the scene
  142678. * @see https://doc.babylonjs.com/how_to/how_to_use_reflection_probes
  142679. */
  142680. reflectionProbes: Array<ReflectionProbe>;
  142681. /**
  142682. * Removes the given reflection probe from this scene.
  142683. * @param toRemove The reflection probe to remove
  142684. * @returns The index of the removed reflection probe
  142685. */
  142686. removeReflectionProbe(toRemove: ReflectionProbe): number;
  142687. /**
  142688. * Adds the given reflection probe to this scene.
  142689. * @param newReflectionProbe The reflection probe to add
  142690. */
  142691. addReflectionProbe(newReflectionProbe: ReflectionProbe): void;
  142692. }
  142693. /**
  142694. * Class used to generate realtime reflection / refraction cube textures
  142695. * @see https://doc.babylonjs.com/how_to/how_to_use_reflection_probes
  142696. */
  142697. export class ReflectionProbe {
  142698. /** defines the name of the probe */
  142699. name: string;
  142700. private _scene;
  142701. private _renderTargetTexture;
  142702. private _projectionMatrix;
  142703. private _viewMatrix;
  142704. private _target;
  142705. private _add;
  142706. private _attachedMesh;
  142707. private _invertYAxis;
  142708. /** Gets or sets probe position (center of the cube map) */
  142709. position: Vector3;
  142710. /**
  142711. * Creates a new reflection probe
  142712. * @param name defines the name of the probe
  142713. * @param size defines the texture resolution (for each face)
  142714. * @param scene defines the hosting scene
  142715. * @param generateMipMaps defines if mip maps should be generated automatically (true by default)
  142716. * @param useFloat defines if HDR data (flaot data) should be used to store colors (false by default)
  142717. */
  142718. constructor(
  142719. /** defines the name of the probe */
  142720. name: string, size: number, scene: Scene, generateMipMaps?: boolean, useFloat?: boolean);
  142721. /** Gets or sets the number of samples to use for multi-sampling (0 by default). Required WebGL2 */
  142722. get samples(): number;
  142723. set samples(value: number);
  142724. /** Gets or sets the refresh rate to use (on every frame by default) */
  142725. get refreshRate(): number;
  142726. set refreshRate(value: number);
  142727. /**
  142728. * Gets the hosting scene
  142729. * @returns a Scene
  142730. */
  142731. getScene(): Scene;
  142732. /** Gets the internal CubeTexture used to render to */
  142733. get cubeTexture(): RenderTargetTexture;
  142734. /** Gets the list of meshes to render */
  142735. get renderList(): Nullable<AbstractMesh[]>;
  142736. /**
  142737. * Attach the probe to a specific mesh (Rendering will be done from attached mesh's position)
  142738. * @param mesh defines the mesh to attach to
  142739. */
  142740. attachToMesh(mesh: Nullable<AbstractMesh>): void;
  142741. /**
  142742. * Specifies whether or not the stencil and depth buffer are cleared between two rendering groups
  142743. * @param renderingGroupId The rendering group id corresponding to its index
  142744. * @param autoClearDepthStencil Automatically clears depth and stencil between groups if true.
  142745. */
  142746. setRenderingAutoClearDepthStencil(renderingGroupId: number, autoClearDepthStencil: boolean): void;
  142747. /**
  142748. * Clean all associated resources
  142749. */
  142750. dispose(): void;
  142751. /**
  142752. * Converts the reflection probe information to a readable string for debug purpose.
  142753. * @param fullDetails Supports for multiple levels of logging within scene loading
  142754. * @returns the human readable reflection probe info
  142755. */
  142756. toString(fullDetails?: boolean): string;
  142757. /**
  142758. * Get the class name of the relfection probe.
  142759. * @returns "ReflectionProbe"
  142760. */
  142761. getClassName(): string;
  142762. /**
  142763. * Serialize the reflection probe to a JSON representation we can easily use in the resepective Parse function.
  142764. * @returns The JSON representation of the texture
  142765. */
  142766. serialize(): any;
  142767. /**
  142768. * Parse the JSON representation of a reflection probe in order to recreate the reflection probe in the given scene.
  142769. * @param parsedReflectionProbe Define the JSON representation of the reflection probe
  142770. * @param scene Define the scene the parsed reflection probe should be instantiated in
  142771. * @param rootUrl Define the root url of the parsing sequence in the case of relative dependencies
  142772. * @returns The parsed reflection probe if successful
  142773. */
  142774. static Parse(parsedReflectionProbe: any, scene: Scene, rootUrl: string): Nullable<ReflectionProbe>;
  142775. }
  142776. }
  142777. declare module BABYLON {
  142778. /** @hidden */
  142779. export var _BabylonLoaderRegistered: boolean;
  142780. /**
  142781. * Helps setting up some configuration for the babylon file loader.
  142782. */
  142783. export class BabylonFileLoaderConfiguration {
  142784. /**
  142785. * The loader does not allow injecting custom physix engine into the plugins.
  142786. * Unfortunately in ES6, we need to manually inject them into the plugin.
  142787. * So you could set this variable to your engine import to make it work.
  142788. */
  142789. static LoaderInjectedPhysicsEngine: any;
  142790. }
  142791. }
  142792. declare module BABYLON {
  142793. /**
  142794. * The Physically based simple base material of BJS.
  142795. *
  142796. * This enables better naming and convention enforcements on top of the pbrMaterial.
  142797. * It is used as the base class for both the specGloss and metalRough conventions.
  142798. */
  142799. export abstract class PBRBaseSimpleMaterial extends PBRBaseMaterial {
  142800. /**
  142801. * Number of Simultaneous lights allowed on the material.
  142802. */
  142803. maxSimultaneousLights: number;
  142804. /**
  142805. * If sets to true, disables all the lights affecting the material.
  142806. */
  142807. disableLighting: boolean;
  142808. /**
  142809. * Environment Texture used in the material (this is use for both reflection and environment lighting).
  142810. */
  142811. environmentTexture: BaseTexture;
  142812. /**
  142813. * If sets to true, x component of normal map value will invert (x = 1.0 - x).
  142814. */
  142815. invertNormalMapX: boolean;
  142816. /**
  142817. * If sets to true, y component of normal map value will invert (y = 1.0 - y).
  142818. */
  142819. invertNormalMapY: boolean;
  142820. /**
  142821. * Normal map used in the model.
  142822. */
  142823. normalTexture: BaseTexture;
  142824. /**
  142825. * Emissivie color used to self-illuminate the model.
  142826. */
  142827. emissiveColor: Color3;
  142828. /**
  142829. * Emissivie texture used to self-illuminate the model.
  142830. */
  142831. emissiveTexture: BaseTexture;
  142832. /**
  142833. * Occlusion Channel Strenght.
  142834. */
  142835. occlusionStrength: number;
  142836. /**
  142837. * Occlusion Texture of the material (adding extra occlusion effects).
  142838. */
  142839. occlusionTexture: BaseTexture;
  142840. /**
  142841. * Defines the alpha limits in alpha test mode.
  142842. */
  142843. alphaCutOff: number;
  142844. /**
  142845. * Gets the current double sided mode.
  142846. */
  142847. get doubleSided(): boolean;
  142848. /**
  142849. * If sets to true and backfaceCulling is false, normals will be flipped on the backside.
  142850. */
  142851. set doubleSided(value: boolean);
  142852. /**
  142853. * Stores the pre-calculated light information of a mesh in a texture.
  142854. */
  142855. lightmapTexture: BaseTexture;
  142856. /**
  142857. * If true, the light map contains occlusion information instead of lighting info.
  142858. */
  142859. useLightmapAsShadowmap: boolean;
  142860. /**
  142861. * Instantiates a new PBRMaterial instance.
  142862. *
  142863. * @param name The material name
  142864. * @param scene The scene the material will be use in.
  142865. */
  142866. constructor(name: string, scene: Scene);
  142867. getClassName(): string;
  142868. }
  142869. }
  142870. declare module BABYLON {
  142871. /**
  142872. * The PBR material of BJS following the metal roughness convention.
  142873. *
  142874. * This fits to the PBR convention in the GLTF definition:
  142875. * https://github.com/KhronosGroup/glTF/tree/2.0/specification/2.0
  142876. */
  142877. export class PBRMetallicRoughnessMaterial extends PBRBaseSimpleMaterial {
  142878. /**
  142879. * The base color has two different interpretations depending on the value of metalness.
  142880. * When the material is a metal, the base color is the specific measured reflectance value
  142881. * at normal incidence (F0). For a non-metal the base color represents the reflected diffuse color
  142882. * of the material.
  142883. */
  142884. baseColor: Color3;
  142885. /**
  142886. * Base texture of the metallic workflow. It contains both the baseColor information in RGB as
  142887. * well as opacity information in the alpha channel.
  142888. */
  142889. baseTexture: BaseTexture;
  142890. /**
  142891. * Specifies the metallic scalar value of the material.
  142892. * Can also be used to scale the metalness values of the metallic texture.
  142893. */
  142894. metallic: number;
  142895. /**
  142896. * Specifies the roughness scalar value of the material.
  142897. * Can also be used to scale the roughness values of the metallic texture.
  142898. */
  142899. roughness: number;
  142900. /**
  142901. * Texture containing both the metallic value in the B channel and the
  142902. * roughness value in the G channel to keep better precision.
  142903. */
  142904. metallicRoughnessTexture: BaseTexture;
  142905. /**
  142906. * Instantiates a new PBRMetalRoughnessMaterial instance.
  142907. *
  142908. * @param name The material name
  142909. * @param scene The scene the material will be use in.
  142910. */
  142911. constructor(name: string, scene: Scene);
  142912. /**
  142913. * Return the currrent class name of the material.
  142914. */
  142915. getClassName(): string;
  142916. /**
  142917. * Makes a duplicate of the current material.
  142918. * @param name - name to use for the new material.
  142919. */
  142920. clone(name: string): PBRMetallicRoughnessMaterial;
  142921. /**
  142922. * Serialize the material to a parsable JSON object.
  142923. */
  142924. serialize(): any;
  142925. /**
  142926. * Parses a JSON object correponding to the serialize function.
  142927. */
  142928. static Parse(source: any, scene: Scene, rootUrl: string): PBRMetallicRoughnessMaterial;
  142929. }
  142930. }
  142931. declare module BABYLON {
  142932. /**
  142933. * The PBR material of BJS following the specular glossiness convention.
  142934. *
  142935. * This fits to the PBR convention in the GLTF definition:
  142936. * https://github.com/KhronosGroup/glTF/tree/2.0/extensions/Khronos/KHR_materials_pbrSpecularGlossiness
  142937. */
  142938. export class PBRSpecularGlossinessMaterial extends PBRBaseSimpleMaterial {
  142939. /**
  142940. * Specifies the diffuse color of the material.
  142941. */
  142942. diffuseColor: Color3;
  142943. /**
  142944. * Specifies the diffuse texture of the material. This can also contains the opcity value in its alpha
  142945. * channel.
  142946. */
  142947. diffuseTexture: BaseTexture;
  142948. /**
  142949. * Specifies the specular color of the material. This indicates how reflective is the material (none to mirror).
  142950. */
  142951. specularColor: Color3;
  142952. /**
  142953. * Specifies the glossiness of the material. This indicates "how sharp is the reflection".
  142954. */
  142955. glossiness: number;
  142956. /**
  142957. * Specifies both the specular color RGB and the glossiness A of the material per pixels.
  142958. */
  142959. specularGlossinessTexture: BaseTexture;
  142960. /**
  142961. * Instantiates a new PBRSpecularGlossinessMaterial instance.
  142962. *
  142963. * @param name The material name
  142964. * @param scene The scene the material will be use in.
  142965. */
  142966. constructor(name: string, scene: Scene);
  142967. /**
  142968. * Return the currrent class name of the material.
  142969. */
  142970. getClassName(): string;
  142971. /**
  142972. * Makes a duplicate of the current material.
  142973. * @param name - name to use for the new material.
  142974. */
  142975. clone(name: string): PBRSpecularGlossinessMaterial;
  142976. /**
  142977. * Serialize the material to a parsable JSON object.
  142978. */
  142979. serialize(): any;
  142980. /**
  142981. * Parses a JSON object correponding to the serialize function.
  142982. */
  142983. static Parse(source: any, scene: Scene, rootUrl: string): PBRSpecularGlossinessMaterial;
  142984. }
  142985. }
  142986. declare module BABYLON {
  142987. /**
  142988. * This represents a color grading texture. This acts as a lookup table LUT, useful during post process
  142989. * It can help converting any input color in a desired output one. This can then be used to create effects
  142990. * from sepia, black and white to sixties or futuristic rendering...
  142991. *
  142992. * The only supported format is currently 3dl.
  142993. * More information on LUT: https://en.wikipedia.org/wiki/3D_lookup_table
  142994. */
  142995. export class ColorGradingTexture extends BaseTexture {
  142996. /**
  142997. * The texture URL.
  142998. */
  142999. url: string;
  143000. /**
  143001. * Empty line regex stored for GC.
  143002. */
  143003. private static _noneEmptyLineRegex;
  143004. private _textureMatrix;
  143005. private _onLoad;
  143006. /**
  143007. * Instantiates a ColorGradingTexture from the following parameters.
  143008. *
  143009. * @param url The location of the color gradind data (currently only supporting 3dl)
  143010. * @param sceneOrEngine The scene or engine the texture will be used in
  143011. * @param onLoad defines a callback triggered when the texture has been loaded
  143012. */
  143013. constructor(url: string, sceneOrEngine: Scene | ThinEngine, onLoad?: Nullable<() => void>);
  143014. /**
  143015. * Fires the onload event from the constructor if requested.
  143016. */
  143017. private _triggerOnLoad;
  143018. /**
  143019. * Returns the texture matrix used in most of the material.
  143020. * This is not used in color grading but keep for troubleshooting purpose (easily swap diffuse by colorgrading to look in).
  143021. */
  143022. getTextureMatrix(): Matrix;
  143023. /**
  143024. * Occurs when the file being loaded is a .3dl LUT file.
  143025. */
  143026. private load3dlTexture;
  143027. /**
  143028. * Starts the loading process of the texture.
  143029. */
  143030. private loadTexture;
  143031. /**
  143032. * Clones the color gradind texture.
  143033. */
  143034. clone(): ColorGradingTexture;
  143035. /**
  143036. * Called during delayed load for textures.
  143037. */
  143038. delayLoad(): void;
  143039. /**
  143040. * Parses a color grading texture serialized by Babylon.
  143041. * @param parsedTexture The texture information being parsedTexture
  143042. * @param scene The scene to load the texture in
  143043. * @param rootUrl The root url of the data assets to load
  143044. * @return A color gradind texture
  143045. */
  143046. static Parse(parsedTexture: any, scene: Scene): Nullable<ColorGradingTexture>;
  143047. /**
  143048. * Serializes the LUT texture to json format.
  143049. */
  143050. serialize(): any;
  143051. }
  143052. }
  143053. declare module BABYLON {
  143054. /**
  143055. * This represents a texture coming from an equirectangular image supported by the web browser canvas.
  143056. */
  143057. export class EquiRectangularCubeTexture extends BaseTexture {
  143058. /** The six faces of the cube. */
  143059. private static _FacesMapping;
  143060. private _noMipmap;
  143061. private _onLoad;
  143062. private _onError;
  143063. /** The size of the cubemap. */
  143064. private _size;
  143065. /** The buffer of the image. */
  143066. private _buffer;
  143067. /** The width of the input image. */
  143068. private _width;
  143069. /** The height of the input image. */
  143070. private _height;
  143071. /** The URL to the image. */
  143072. url: string;
  143073. /**
  143074. * Instantiates an EquiRectangularCubeTexture from the following parameters.
  143075. * @param url The location of the image
  143076. * @param scene The scene the texture will be used in
  143077. * @param size The cubemap desired size (the more it increases the longer the generation will be)
  143078. * @param noMipmap Forces to not generate the mipmap if true
  143079. * @param gammaSpace Specifies if the texture will be used in gamma or linear space
  143080. * (the PBR material requires those textures in linear space, but the standard material would require them in Gamma space)
  143081. * @param onLoad — defines a callback called when texture is loaded
  143082. * @param onError — defines a callback called if there is an error
  143083. */
  143084. constructor(url: string, scene: Scene, size: number, noMipmap?: boolean, gammaSpace?: boolean, onLoad?: Nullable<() => void>, onError?: Nullable<(message?: string, exception?: any) => void>);
  143085. /**
  143086. * Load the image data, by putting the image on a canvas and extracting its buffer.
  143087. */
  143088. private loadImage;
  143089. /**
  143090. * Convert the image buffer into a cubemap and create a CubeTexture.
  143091. */
  143092. private loadTexture;
  143093. /**
  143094. * Convert the ArrayBuffer into a Float32Array and drop the transparency channel.
  143095. * @param buffer The ArrayBuffer that should be converted.
  143096. * @returns The buffer as Float32Array.
  143097. */
  143098. private getFloat32ArrayFromArrayBuffer;
  143099. /**
  143100. * Get the current class name of the texture useful for serialization or dynamic coding.
  143101. * @returns "EquiRectangularCubeTexture"
  143102. */
  143103. getClassName(): string;
  143104. /**
  143105. * Create a clone of the current EquiRectangularCubeTexture and return it.
  143106. * @returns A clone of the current EquiRectangularCubeTexture.
  143107. */
  143108. clone(): EquiRectangularCubeTexture;
  143109. }
  143110. }
  143111. declare module BABYLON {
  143112. /**
  143113. * Defines the options related to the creation of an HtmlElementTexture
  143114. */
  143115. export interface IHtmlElementTextureOptions {
  143116. /**
  143117. * Defines wether mip maps should be created or not.
  143118. */
  143119. generateMipMaps?: boolean;
  143120. /**
  143121. * Defines the sampling mode of the texture.
  143122. */
  143123. samplingMode?: number;
  143124. /**
  143125. * Defines the engine instance to use the texture with. It is not mandatory if you define a scene.
  143126. */
  143127. engine: Nullable<ThinEngine>;
  143128. /**
  143129. * Defines the scene the texture belongs to. It is not mandatory if you define an engine.
  143130. */
  143131. scene: Nullable<Scene>;
  143132. }
  143133. /**
  143134. * This represents the smallest workload to use an already existing element (Canvas or Video) as a texture.
  143135. * To be as efficient as possible depending on your constraints nothing aside the first upload
  143136. * is automatically managed.
  143137. * It is a cheap VideoTexture or DynamicTexture if you prefer to keep full control of the elements
  143138. * in your application.
  143139. *
  143140. * As the update is not automatic, you need to call them manually.
  143141. */
  143142. export class HtmlElementTexture extends BaseTexture {
  143143. /**
  143144. * The texture URL.
  143145. */
  143146. element: HTMLVideoElement | HTMLCanvasElement;
  143147. private static readonly DefaultOptions;
  143148. private _textureMatrix;
  143149. private _isVideo;
  143150. private _generateMipMaps;
  143151. private _samplingMode;
  143152. /**
  143153. * Instantiates a HtmlElementTexture from the following parameters.
  143154. *
  143155. * @param name Defines the name of the texture
  143156. * @param element Defines the video or canvas the texture is filled with
  143157. * @param options Defines the other none mandatory texture creation options
  143158. */
  143159. constructor(name: string, element: HTMLVideoElement | HTMLCanvasElement, options: IHtmlElementTextureOptions);
  143160. private _createInternalTexture;
  143161. /**
  143162. * Returns the texture matrix used in most of the material.
  143163. */
  143164. getTextureMatrix(): Matrix;
  143165. /**
  143166. * Updates the content of the texture.
  143167. * @param invertY Defines wether the texture should be inverted on Y (false by default on video and true on canvas)
  143168. */
  143169. update(invertY?: Nullable<boolean>): void;
  143170. }
  143171. }
  143172. declare module BABYLON {
  143173. /**
  143174. * Based on jsTGALoader - Javascript loader for TGA file
  143175. * By Vincent Thibault
  143176. * @see http://blog.robrowser.com/javascript-tga-loader.html
  143177. */
  143178. export class TGATools {
  143179. private static _TYPE_INDEXED;
  143180. private static _TYPE_RGB;
  143181. private static _TYPE_GREY;
  143182. private static _TYPE_RLE_INDEXED;
  143183. private static _TYPE_RLE_RGB;
  143184. private static _TYPE_RLE_GREY;
  143185. private static _ORIGIN_MASK;
  143186. private static _ORIGIN_SHIFT;
  143187. private static _ORIGIN_BL;
  143188. private static _ORIGIN_BR;
  143189. private static _ORIGIN_UL;
  143190. private static _ORIGIN_UR;
  143191. /**
  143192. * Gets the header of a TGA file
  143193. * @param data defines the TGA data
  143194. * @returns the header
  143195. */
  143196. static GetTGAHeader(data: Uint8Array): any;
  143197. /**
  143198. * Uploads TGA content to a Babylon Texture
  143199. * @hidden
  143200. */
  143201. static UploadContent(texture: InternalTexture, data: Uint8Array): void;
  143202. /** @hidden */
  143203. 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;
  143204. /** @hidden */
  143205. 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;
  143206. /** @hidden */
  143207. 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;
  143208. /** @hidden */
  143209. 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;
  143210. /** @hidden */
  143211. 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;
  143212. /** @hidden */
  143213. 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;
  143214. }
  143215. }
  143216. declare module BABYLON {
  143217. /**
  143218. * Implementation of the TGA Texture Loader.
  143219. * @hidden
  143220. */
  143221. export class _TGATextureLoader implements IInternalTextureLoader {
  143222. /**
  143223. * Defines wether the loader supports cascade loading the different faces.
  143224. */
  143225. readonly supportCascades: boolean;
  143226. /**
  143227. * This returns if the loader support the current file information.
  143228. * @param extension defines the file extension of the file being loaded
  143229. * @returns true if the loader can load the specified file
  143230. */
  143231. canLoad(extension: string): boolean;
  143232. /**
  143233. * Uploads the cube texture data to the WebGL texture. It has already been bound.
  143234. * @param data contains the texture data
  143235. * @param texture defines the BabylonJS internal texture
  143236. * @param createPolynomials will be true if polynomials have been requested
  143237. * @param onLoad defines the callback to trigger once the texture is ready
  143238. * @param onError defines the callback to trigger in case of error
  143239. */
  143240. loadCubeData(data: ArrayBufferView | ArrayBufferView[], texture: InternalTexture, createPolynomials: boolean, onLoad: Nullable<(data?: any) => void>, onError: Nullable<(message?: string, exception?: any) => void>): void;
  143241. /**
  143242. * Uploads the 2D texture data to the WebGL texture. It has already been bound once in the callback.
  143243. * @param data contains the texture data
  143244. * @param texture defines the BabylonJS internal texture
  143245. * @param callback defines the method to call once ready to upload
  143246. */
  143247. loadData(data: ArrayBufferView, texture: InternalTexture, callback: (width: number, height: number, loadMipmap: boolean, isCompressed: boolean, done: () => void) => void): void;
  143248. }
  143249. }
  143250. declare module BABYLON {
  143251. /**
  143252. * Info about the .basis files
  143253. */
  143254. class BasisFileInfo {
  143255. /**
  143256. * If the file has alpha
  143257. */
  143258. hasAlpha: boolean;
  143259. /**
  143260. * Info about each image of the basis file
  143261. */
  143262. images: Array<{
  143263. levels: Array<{
  143264. width: number;
  143265. height: number;
  143266. transcodedPixels: ArrayBufferView;
  143267. }>;
  143268. }>;
  143269. }
  143270. /**
  143271. * Result of transcoding a basis file
  143272. */
  143273. class TranscodeResult {
  143274. /**
  143275. * Info about the .basis file
  143276. */
  143277. fileInfo: BasisFileInfo;
  143278. /**
  143279. * Format to use when loading the file
  143280. */
  143281. format: number;
  143282. }
  143283. /**
  143284. * Configuration options for the Basis transcoder
  143285. */
  143286. export class BasisTranscodeConfiguration {
  143287. /**
  143288. * Supported compression formats used to determine the supported output format of the transcoder
  143289. */
  143290. supportedCompressionFormats?: {
  143291. /**
  143292. * etc1 compression format
  143293. */
  143294. etc1?: boolean;
  143295. /**
  143296. * s3tc compression format
  143297. */
  143298. s3tc?: boolean;
  143299. /**
  143300. * pvrtc compression format
  143301. */
  143302. pvrtc?: boolean;
  143303. /**
  143304. * etc2 compression format
  143305. */
  143306. etc2?: boolean;
  143307. };
  143308. /**
  143309. * If mipmap levels should be loaded for transcoded images (Default: true)
  143310. */
  143311. loadMipmapLevels?: boolean;
  143312. /**
  143313. * Index of a single image to load (Default: all images)
  143314. */
  143315. loadSingleImage?: number;
  143316. }
  143317. /**
  143318. * Used to load .Basis files
  143319. * See https://github.com/BinomialLLC/basis_universal/tree/master/webgl
  143320. */
  143321. export class BasisTools {
  143322. private static _IgnoreSupportedFormats;
  143323. /**
  143324. * URL to use when loading the basis transcoder
  143325. */
  143326. static JSModuleURL: string;
  143327. /**
  143328. * URL to use when loading the wasm module for the transcoder
  143329. */
  143330. static WasmModuleURL: string;
  143331. /**
  143332. * Get the internal format to be passed to texImage2D corresponding to the .basis format value
  143333. * @param basisFormat format chosen from GetSupportedTranscodeFormat
  143334. * @returns internal format corresponding to the Basis format
  143335. */
  143336. static GetInternalFormatFromBasisFormat(basisFormat: number): number;
  143337. private static _WorkerPromise;
  143338. private static _Worker;
  143339. private static _actionId;
  143340. private static _CreateWorkerAsync;
  143341. /**
  143342. * Transcodes a loaded image file to compressed pixel data
  143343. * @param data image data to transcode
  143344. * @param config configuration options for the transcoding
  143345. * @returns a promise resulting in the transcoded image
  143346. */
  143347. static TranscodeAsync(data: ArrayBuffer | ArrayBufferView, config: BasisTranscodeConfiguration): Promise<TranscodeResult>;
  143348. /**
  143349. * Loads a texture from the transcode result
  143350. * @param texture texture load to
  143351. * @param transcodeResult the result of transcoding the basis file to load from
  143352. */
  143353. static LoadTextureFromTranscodeResult(texture: InternalTexture, transcodeResult: TranscodeResult): void;
  143354. }
  143355. }
  143356. declare module BABYLON {
  143357. /**
  143358. * Loader for .basis file format
  143359. */
  143360. export class _BasisTextureLoader implements IInternalTextureLoader {
  143361. /**
  143362. * Defines whether the loader supports cascade loading the different faces.
  143363. */
  143364. readonly supportCascades: boolean;
  143365. /**
  143366. * This returns if the loader support the current file information.
  143367. * @param extension defines the file extension of the file being loaded
  143368. * @returns true if the loader can load the specified file
  143369. */
  143370. canLoad(extension: string): boolean;
  143371. /**
  143372. * Uploads the cube texture data to the WebGL texture. It has already been bound.
  143373. * @param data contains the texture data
  143374. * @param texture defines the BabylonJS internal texture
  143375. * @param createPolynomials will be true if polynomials have been requested
  143376. * @param onLoad defines the callback to trigger once the texture is ready
  143377. * @param onError defines the callback to trigger in case of error
  143378. */
  143379. loadCubeData(data: ArrayBufferView | ArrayBufferView[], texture: InternalTexture, createPolynomials: boolean, onLoad: Nullable<(data?: any) => void>, onError: Nullable<(message?: string, exception?: any) => void>): void;
  143380. /**
  143381. * Uploads the 2D texture data to the WebGL texture. It has already been bound once in the callback.
  143382. * @param data contains the texture data
  143383. * @param texture defines the BabylonJS internal texture
  143384. * @param callback defines the method to call once ready to upload
  143385. */
  143386. loadData(data: ArrayBufferView, texture: InternalTexture, callback: (width: number, height: number, loadMipmap: boolean, isCompressed: boolean, done: () => void) => void): void;
  143387. }
  143388. }
  143389. declare module BABYLON {
  143390. /**
  143391. * Defines the basic options interface of a TexturePacker Frame
  143392. */
  143393. export interface ITexturePackerFrame {
  143394. /**
  143395. * The frame ID
  143396. */
  143397. id: number;
  143398. /**
  143399. * The frames Scale
  143400. */
  143401. scale: Vector2;
  143402. /**
  143403. * The Frames offset
  143404. */
  143405. offset: Vector2;
  143406. }
  143407. /**
  143408. * This is a support class for frame Data on texture packer sets.
  143409. */
  143410. export class TexturePackerFrame implements ITexturePackerFrame {
  143411. /**
  143412. * The frame ID
  143413. */
  143414. id: number;
  143415. /**
  143416. * The frames Scale
  143417. */
  143418. scale: Vector2;
  143419. /**
  143420. * The Frames offset
  143421. */
  143422. offset: Vector2;
  143423. /**
  143424. * Initializes a texture package frame.
  143425. * @param id The numerical frame identifier
  143426. * @param scale Scalar Vector2 for UV frame
  143427. * @param offset Vector2 for the frame position in UV units.
  143428. * @returns TexturePackerFrame
  143429. */
  143430. constructor(id: number, scale: Vector2, offset: Vector2);
  143431. }
  143432. }
  143433. declare module BABYLON {
  143434. /**
  143435. * Defines the basic options interface of a TexturePacker
  143436. */
  143437. export interface ITexturePackerOptions {
  143438. /**
  143439. * Custom targets for the channels of a texture packer. Default is all the channels of the Standard Material
  143440. */
  143441. map?: string[];
  143442. /**
  143443. * the UV input targets, as a single value for all meshes. Defaults to VertexBuffer.UVKind
  143444. */
  143445. uvsIn?: string;
  143446. /**
  143447. * the UV output targets, as a single value for all meshes. Defaults to VertexBuffer.UVKind
  143448. */
  143449. uvsOut?: string;
  143450. /**
  143451. * number representing the layout style. Defaults to LAYOUT_STRIP
  143452. */
  143453. layout?: number;
  143454. /**
  143455. * number of columns if using custom column count layout(2). This defaults to 4.
  143456. */
  143457. colnum?: number;
  143458. /**
  143459. * flag to update the input meshes to the new packed texture after compilation. Defaults to true.
  143460. */
  143461. updateInputMeshes?: boolean;
  143462. /**
  143463. * boolean flag to dispose all the source textures. Defaults to true.
  143464. */
  143465. disposeSources?: boolean;
  143466. /**
  143467. * Fills the blank cells in a set to the customFillColor. Defaults to true.
  143468. */
  143469. fillBlanks?: boolean;
  143470. /**
  143471. * string value representing the context fill style color. Defaults to 'black'.
  143472. */
  143473. customFillColor?: string;
  143474. /**
  143475. * Width and Height Value of each Frame in the TexturePacker Sets
  143476. */
  143477. frameSize?: number;
  143478. /**
  143479. * Ratio of the value to add padding wise to each cell. Defaults to 0.0115
  143480. */
  143481. paddingRatio?: number;
  143482. /**
  143483. * Number that declares the fill method for the padding gutter.
  143484. */
  143485. paddingMode?: number;
  143486. /**
  143487. * If in SUBUV_COLOR padding mode what color to use.
  143488. */
  143489. paddingColor?: Color3 | Color4;
  143490. }
  143491. /**
  143492. * Defines the basic interface of a TexturePacker JSON File
  143493. */
  143494. export interface ITexturePackerJSON {
  143495. /**
  143496. * The frame ID
  143497. */
  143498. name: string;
  143499. /**
  143500. * The base64 channel data
  143501. */
  143502. sets: any;
  143503. /**
  143504. * The options of the Packer
  143505. */
  143506. options: ITexturePackerOptions;
  143507. /**
  143508. * The frame data of the Packer
  143509. */
  143510. frames: Array<number>;
  143511. }
  143512. /**
  143513. * This is a support class that generates a series of packed texture sets.
  143514. * @see https://doc.babylonjs.com/babylon101/materials
  143515. */
  143516. export class TexturePacker {
  143517. /** Packer Layout Constant 0 */
  143518. static readonly LAYOUT_STRIP: number;
  143519. /** Packer Layout Constant 1 */
  143520. static readonly LAYOUT_POWER2: number;
  143521. /** Packer Layout Constant 2 */
  143522. static readonly LAYOUT_COLNUM: number;
  143523. /** Packer Layout Constant 0 */
  143524. static readonly SUBUV_WRAP: number;
  143525. /** Packer Layout Constant 1 */
  143526. static readonly SUBUV_EXTEND: number;
  143527. /** Packer Layout Constant 2 */
  143528. static readonly SUBUV_COLOR: number;
  143529. /** The Name of the Texture Package */
  143530. name: string;
  143531. /** The scene scope of the TexturePacker */
  143532. scene: Scene;
  143533. /** The Meshes to target */
  143534. meshes: AbstractMesh[];
  143535. /** Arguments passed with the Constructor */
  143536. options: ITexturePackerOptions;
  143537. /** The promise that is started upon initialization */
  143538. promise: Nullable<Promise<TexturePacker | string>>;
  143539. /** The Container object for the channel sets that are generated */
  143540. sets: object;
  143541. /** The Container array for the frames that are generated */
  143542. frames: TexturePackerFrame[];
  143543. /** The expected number of textures the system is parsing. */
  143544. private _expecting;
  143545. /** The padding value from Math.ceil(frameSize * paddingRatio) */
  143546. private _paddingValue;
  143547. /**
  143548. * Initializes a texture package series from an array of meshes or a single mesh.
  143549. * @param name The name of the package
  143550. * @param meshes The target meshes to compose the package from
  143551. * @param options The arguments that texture packer should follow while building.
  143552. * @param scene The scene which the textures are scoped to.
  143553. * @returns TexturePacker
  143554. */
  143555. constructor(name: string, meshes: AbstractMesh[], options: ITexturePackerOptions, scene: Scene);
  143556. /**
  143557. * Starts the package process
  143558. * @param resolve The promises resolution function
  143559. * @returns TexturePacker
  143560. */
  143561. private _createFrames;
  143562. /**
  143563. * Calculates the Size of the Channel Sets
  143564. * @returns Vector2
  143565. */
  143566. private _calculateSize;
  143567. /**
  143568. * Calculates the UV data for the frames.
  143569. * @param baseSize the base frameSize
  143570. * @param padding the base frame padding
  143571. * @param dtSize size of the Dynamic Texture for that channel
  143572. * @param dtUnits is 1/dtSize
  143573. * @param update flag to update the input meshes
  143574. */
  143575. private _calculateMeshUVFrames;
  143576. /**
  143577. * Calculates the frames Offset.
  143578. * @param index of the frame
  143579. * @returns Vector2
  143580. */
  143581. private _getFrameOffset;
  143582. /**
  143583. * Updates a Mesh to the frame data
  143584. * @param mesh that is the target
  143585. * @param frameID or the frame index
  143586. */
  143587. private _updateMeshUV;
  143588. /**
  143589. * Updates a Meshes materials to use the texture packer channels
  143590. * @param m is the mesh to target
  143591. * @param force all channels on the packer to be set.
  143592. */
  143593. private _updateTextureReferences;
  143594. /**
  143595. * Public method to set a Mesh to a frame
  143596. * @param m that is the target
  143597. * @param frameID or the frame index
  143598. * @param updateMaterial trigger for if the Meshes attached Material be updated?
  143599. */
  143600. setMeshToFrame(m: AbstractMesh, frameID: number, updateMaterial?: boolean): void;
  143601. /**
  143602. * Starts the async promise to compile the texture packer.
  143603. * @returns Promise<void>
  143604. */
  143605. processAsync(): Promise<void>;
  143606. /**
  143607. * Disposes all textures associated with this packer
  143608. */
  143609. dispose(): void;
  143610. /**
  143611. * Starts the download process for all the channels converting them to base64 data and embedding it all in a JSON file.
  143612. * @param imageType is the image type to use.
  143613. * @param quality of the image if downloading as jpeg, Ranges from >0 to 1.
  143614. */
  143615. download(imageType?: string, quality?: number): void;
  143616. /**
  143617. * Public method to load a texturePacker JSON file.
  143618. * @param data of the JSON file in string format.
  143619. */
  143620. updateFromJSON(data: string): void;
  143621. }
  143622. }
  143623. declare module BABYLON {
  143624. /**
  143625. * 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.
  143626. * Custom Procedural textures are the easiest way to create your own procedural in your application.
  143627. * @see https://doc.babylonjs.com/how_to/how_to_use_procedural_textures#creating-custom-procedural-textures
  143628. */
  143629. export class CustomProceduralTexture extends ProceduralTexture {
  143630. private _animate;
  143631. private _time;
  143632. private _config;
  143633. private _texturePath;
  143634. /**
  143635. * Instantiates a new Custom Procedural Texture.
  143636. * 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.
  143637. * Custom Procedural textures are the easiest way to create your own procedural in your application.
  143638. * @see https://doc.babylonjs.com/how_to/how_to_use_procedural_textures#creating-custom-procedural-textures
  143639. * @param name Define the name of the texture
  143640. * @param texturePath Define the folder path containing all the cutom texture related files (config, shaders...)
  143641. * @param size Define the size of the texture to create
  143642. * @param scene Define the scene the texture belongs to
  143643. * @param fallbackTexture Define a fallback texture in case there were issues to create the custom texture
  143644. * @param generateMipMaps Define if the texture should creates mip maps or not
  143645. */
  143646. constructor(name: string, texturePath: string, size: number, scene: Scene, fallbackTexture?: Texture, generateMipMaps?: boolean);
  143647. private _loadJson;
  143648. /**
  143649. * Is the texture ready to be used ? (rendered at least once)
  143650. * @returns true if ready, otherwise, false.
  143651. */
  143652. isReady(): boolean;
  143653. /**
  143654. * Render the texture to its associated render target.
  143655. * @param useCameraPostProcess Define if camera post process should be applied to the texture
  143656. */
  143657. render(useCameraPostProcess?: boolean): void;
  143658. /**
  143659. * Update the list of dependant textures samplers in the shader.
  143660. */
  143661. updateTextures(): void;
  143662. /**
  143663. * Update the uniform values of the procedural texture in the shader.
  143664. */
  143665. updateShaderUniforms(): void;
  143666. /**
  143667. * Define if the texture animates or not.
  143668. */
  143669. get animate(): boolean;
  143670. set animate(value: boolean);
  143671. }
  143672. }
  143673. declare module BABYLON {
  143674. /** @hidden */
  143675. export var noisePixelShader: {
  143676. name: string;
  143677. shader: string;
  143678. };
  143679. }
  143680. declare module BABYLON {
  143681. /**
  143682. * Class used to generate noise procedural textures
  143683. */
  143684. export class NoiseProceduralTexture extends ProceduralTexture {
  143685. /** Gets or sets the start time (default is 0) */
  143686. time: number;
  143687. /** Gets or sets a value between 0 and 1 indicating the overall brightness of the texture (default is 0.2) */
  143688. brightness: number;
  143689. /** Defines the number of octaves to process */
  143690. octaves: number;
  143691. /** Defines the level of persistence (0.8 by default) */
  143692. persistence: number;
  143693. /** Gets or sets animation speed factor (default is 1) */
  143694. animationSpeedFactor: number;
  143695. /**
  143696. * Creates a new NoiseProceduralTexture
  143697. * @param name defines the name fo the texture
  143698. * @param size defines the size of the texture (default is 256)
  143699. * @param scene defines the hosting scene
  143700. * @param fallbackTexture defines the texture to use if the NoiseProceduralTexture can't be created
  143701. * @param generateMipMaps defines if mipmaps must be generated (true by default)
  143702. */
  143703. constructor(name: string, size?: number, scene?: Nullable<Scene>, fallbackTexture?: Texture, generateMipMaps?: boolean);
  143704. private _updateShaderUniforms;
  143705. protected _getDefines(): string;
  143706. /** Generate the current state of the procedural texture */
  143707. render(useCameraPostProcess?: boolean): void;
  143708. /**
  143709. * Serializes this noise procedural texture
  143710. * @returns a serialized noise procedural texture object
  143711. */
  143712. serialize(): any;
  143713. /**
  143714. * Clone the texture.
  143715. * @returns the cloned texture
  143716. */
  143717. clone(): NoiseProceduralTexture;
  143718. /**
  143719. * Creates a NoiseProceduralTexture from parsed noise procedural texture data
  143720. * @param parsedTexture defines parsed texture data
  143721. * @param scene defines the current scene
  143722. * @param rootUrl defines the root URL containing noise procedural texture information
  143723. * @returns a parsed NoiseProceduralTexture
  143724. */
  143725. static Parse(parsedTexture: any, scene: Scene): NoiseProceduralTexture;
  143726. }
  143727. }
  143728. declare module BABYLON {
  143729. /**
  143730. * Raw cube texture where the raw buffers are passed in
  143731. */
  143732. export class RawCubeTexture extends CubeTexture {
  143733. /**
  143734. * Creates a cube texture where the raw buffers are passed in.
  143735. * @param scene defines the scene the texture is attached to
  143736. * @param data defines the array of data to use to create each face
  143737. * @param size defines the size of the textures
  143738. * @param format defines the format of the data
  143739. * @param type defines the type of the data (like Engine.TEXTURETYPE_UNSIGNED_INT)
  143740. * @param generateMipMaps defines if the engine should generate the mip levels
  143741. * @param invertY defines if data must be stored with Y axis inverted
  143742. * @param samplingMode defines the required sampling mode (like Texture.NEAREST_SAMPLINGMODE)
  143743. * @param compression defines the compression used (null by default)
  143744. */
  143745. constructor(scene: Scene, data: Nullable<ArrayBufferView[]>, size: number, format?: number, type?: number, generateMipMaps?: boolean, invertY?: boolean, samplingMode?: number, compression?: Nullable<string>);
  143746. /**
  143747. * Updates the raw cube texture.
  143748. * @param data defines the data to store
  143749. * @param format defines the data format
  143750. * @param type defines the type fo the data (Engine.TEXTURETYPE_UNSIGNED_INT by default)
  143751. * @param invertY defines if data must be stored with Y axis inverted
  143752. * @param compression defines the compression used (null by default)
  143753. * @param level defines which level of the texture to update
  143754. */
  143755. update(data: ArrayBufferView[], format: number, type: number, invertY: boolean, compression?: Nullable<string>): void;
  143756. /**
  143757. * Updates a raw cube texture with RGBD encoded data.
  143758. * @param data defines the array of data [mipmap][face] to use to create each face
  143759. * @param sphericalPolynomial defines the spherical polynomial for irradiance
  143760. * @param lodScale defines the scale applied to environment texture. This manages the range of LOD level used for IBL according to the roughness
  143761. * @param lodOffset defines the offset applied to environment texture. This manages first LOD level used for IBL according to the roughness
  143762. * @returns a promsie that resolves when the operation is complete
  143763. */
  143764. updateRGBDAsync(data: ArrayBufferView[][], sphericalPolynomial?: Nullable<SphericalPolynomial>, lodScale?: number, lodOffset?: number): Promise<void>;
  143765. /**
  143766. * Clones the raw cube texture.
  143767. * @return a new cube texture
  143768. */
  143769. clone(): CubeTexture;
  143770. /** @hidden */
  143771. static _UpdateRGBDAsync(internalTexture: InternalTexture, data: ArrayBufferView[][], sphericalPolynomial: Nullable<SphericalPolynomial>, lodScale: number, lodOffset: number): Promise<void>;
  143772. }
  143773. }
  143774. declare module BABYLON {
  143775. /**
  143776. * Class used to store 2D array textures containing user data
  143777. */
  143778. export class RawTexture2DArray extends Texture {
  143779. /** Gets or sets the texture format to use */
  143780. format: number;
  143781. /**
  143782. * Create a new RawTexture2DArray
  143783. * @param data defines the data of the texture
  143784. * @param width defines the width of the texture
  143785. * @param height defines the height of the texture
  143786. * @param depth defines the number of layers of the texture
  143787. * @param format defines the texture format to use
  143788. * @param scene defines the hosting scene
  143789. * @param generateMipMaps defines a boolean indicating if mip levels should be generated (true by default)
  143790. * @param invertY defines if texture must be stored with Y axis inverted
  143791. * @param samplingMode defines the sampling mode to use (Texture.TRILINEAR_SAMPLINGMODE by default)
  143792. * @param textureType defines the texture Type (Engine.TEXTURETYPE_UNSIGNED_INT, Engine.TEXTURETYPE_FLOAT...)
  143793. */
  143794. constructor(data: ArrayBufferView, width: number, height: number, depth: number,
  143795. /** Gets or sets the texture format to use */
  143796. format: number, scene: Scene, generateMipMaps?: boolean, invertY?: boolean, samplingMode?: number, textureType?: number);
  143797. /**
  143798. * Update the texture with new data
  143799. * @param data defines the data to store in the texture
  143800. */
  143801. update(data: ArrayBufferView): void;
  143802. }
  143803. }
  143804. declare module BABYLON {
  143805. /**
  143806. * Class used to store 3D textures containing user data
  143807. */
  143808. export class RawTexture3D extends Texture {
  143809. /** Gets or sets the texture format to use */
  143810. format: number;
  143811. /**
  143812. * Create a new RawTexture3D
  143813. * @param data defines the data of the texture
  143814. * @param width defines the width of the texture
  143815. * @param height defines the height of the texture
  143816. * @param depth defines the depth of the texture
  143817. * @param format defines the texture format to use
  143818. * @param scene defines the hosting scene
  143819. * @param generateMipMaps defines a boolean indicating if mip levels should be generated (true by default)
  143820. * @param invertY defines if texture must be stored with Y axis inverted
  143821. * @param samplingMode defines the sampling mode to use (Texture.TRILINEAR_SAMPLINGMODE by default)
  143822. * @param textureType defines the texture Type (Engine.TEXTURETYPE_UNSIGNED_INT, Engine.TEXTURETYPE_FLOAT...)
  143823. */
  143824. constructor(data: ArrayBufferView, width: number, height: number, depth: number,
  143825. /** Gets or sets the texture format to use */
  143826. format: number, scene: Scene, generateMipMaps?: boolean, invertY?: boolean, samplingMode?: number, textureType?: number);
  143827. /**
  143828. * Update the texture with new data
  143829. * @param data defines the data to store in the texture
  143830. */
  143831. update(data: ArrayBufferView): void;
  143832. }
  143833. }
  143834. declare module BABYLON {
  143835. /**
  143836. * Creates a refraction texture used by refraction channel of the standard material.
  143837. * It is like a mirror but to see through a material.
  143838. * @see https://doc.babylonjs.com/how_to/reflect#refraction
  143839. */
  143840. export class RefractionTexture extends RenderTargetTexture {
  143841. /**
  143842. * Define the reflection plane we want to use. The refractionPlane is usually set to the constructed refractor.
  143843. * 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.
  143844. * @see https://doc.babylonjs.com/how_to/reflect#refraction
  143845. */
  143846. refractionPlane: Plane;
  143847. /**
  143848. * Define how deep under the surface we should see.
  143849. */
  143850. depth: number;
  143851. /**
  143852. * Creates a refraction texture used by refraction channel of the standard material.
  143853. * It is like a mirror but to see through a material.
  143854. * @see https://doc.babylonjs.com/how_to/reflect#refraction
  143855. * @param name Define the texture name
  143856. * @param size Define the size of the underlying texture
  143857. * @param scene Define the scene the refraction belongs to
  143858. * @param generateMipMaps Define if we need to generate mips level for the refraction
  143859. */
  143860. constructor(name: string, size: number, scene: Scene, generateMipMaps?: boolean);
  143861. /**
  143862. * Clone the refraction texture.
  143863. * @returns the cloned texture
  143864. */
  143865. clone(): RefractionTexture;
  143866. /**
  143867. * Serialize the texture to a JSON representation you could use in Parse later on
  143868. * @returns the serialized JSON representation
  143869. */
  143870. serialize(): any;
  143871. }
  143872. }
  143873. declare module BABYLON {
  143874. /**
  143875. * Block used to add support for vertex skinning (bones)
  143876. */
  143877. export class BonesBlock extends NodeMaterialBlock {
  143878. /**
  143879. * Creates a new BonesBlock
  143880. * @param name defines the block name
  143881. */
  143882. constructor(name: string);
  143883. /**
  143884. * Initialize the block and prepare the context for build
  143885. * @param state defines the state that will be used for the build
  143886. */
  143887. initialize(state: NodeMaterialBuildState): void;
  143888. /**
  143889. * Gets the current class name
  143890. * @returns the class name
  143891. */
  143892. getClassName(): string;
  143893. /**
  143894. * Gets the matrix indices input component
  143895. */
  143896. get matricesIndices(): NodeMaterialConnectionPoint;
  143897. /**
  143898. * Gets the matrix weights input component
  143899. */
  143900. get matricesWeights(): NodeMaterialConnectionPoint;
  143901. /**
  143902. * Gets the extra matrix indices input component
  143903. */
  143904. get matricesIndicesExtra(): NodeMaterialConnectionPoint;
  143905. /**
  143906. * Gets the extra matrix weights input component
  143907. */
  143908. get matricesWeightsExtra(): NodeMaterialConnectionPoint;
  143909. /**
  143910. * Gets the world input component
  143911. */
  143912. get world(): NodeMaterialConnectionPoint;
  143913. /**
  143914. * Gets the output component
  143915. */
  143916. get output(): NodeMaterialConnectionPoint;
  143917. autoConfigure(material: NodeMaterial): void;
  143918. provideFallbacks(mesh: AbstractMesh, fallbacks: EffectFallbacks): void;
  143919. bind(effect: Effect, nodeMaterial: NodeMaterial, mesh?: Mesh): void;
  143920. prepareDefines(mesh: AbstractMesh, nodeMaterial: NodeMaterial, defines: NodeMaterialDefines): void;
  143921. protected _buildBlock(state: NodeMaterialBuildState): this;
  143922. }
  143923. }
  143924. declare module BABYLON {
  143925. /**
  143926. * Block used to add support for instances
  143927. * @see https://doc.babylonjs.com/how_to/how_to_use_instances
  143928. */
  143929. export class InstancesBlock extends NodeMaterialBlock {
  143930. /**
  143931. * Creates a new InstancesBlock
  143932. * @param name defines the block name
  143933. */
  143934. constructor(name: string);
  143935. /**
  143936. * Gets the current class name
  143937. * @returns the class name
  143938. */
  143939. getClassName(): string;
  143940. /**
  143941. * Gets the first world row input component
  143942. */
  143943. get world0(): NodeMaterialConnectionPoint;
  143944. /**
  143945. * Gets the second world row input component
  143946. */
  143947. get world1(): NodeMaterialConnectionPoint;
  143948. /**
  143949. * Gets the third world row input component
  143950. */
  143951. get world2(): NodeMaterialConnectionPoint;
  143952. /**
  143953. * Gets the forth world row input component
  143954. */
  143955. get world3(): NodeMaterialConnectionPoint;
  143956. /**
  143957. * Gets the world input component
  143958. */
  143959. get world(): NodeMaterialConnectionPoint;
  143960. /**
  143961. * Gets the output component
  143962. */
  143963. get output(): NodeMaterialConnectionPoint;
  143964. /**
  143965. * Gets the isntanceID component
  143966. */
  143967. get instanceID(): NodeMaterialConnectionPoint;
  143968. autoConfigure(material: NodeMaterial): void;
  143969. prepareDefines(mesh: AbstractMesh, nodeMaterial: NodeMaterial, defines: NodeMaterialDefines, useInstances?: boolean, subMesh?: SubMesh): void;
  143970. protected _buildBlock(state: NodeMaterialBuildState): this;
  143971. }
  143972. }
  143973. declare module BABYLON {
  143974. /**
  143975. * Block used to add morph targets support to vertex shader
  143976. */
  143977. export class MorphTargetsBlock extends NodeMaterialBlock {
  143978. private _repeatableContentAnchor;
  143979. /**
  143980. * Create a new MorphTargetsBlock
  143981. * @param name defines the block name
  143982. */
  143983. constructor(name: string);
  143984. /**
  143985. * Gets the current class name
  143986. * @returns the class name
  143987. */
  143988. getClassName(): string;
  143989. /**
  143990. * Gets the position input component
  143991. */
  143992. get position(): NodeMaterialConnectionPoint;
  143993. /**
  143994. * Gets the normal input component
  143995. */
  143996. get normal(): NodeMaterialConnectionPoint;
  143997. /**
  143998. * Gets the tangent input component
  143999. */
  144000. get tangent(): NodeMaterialConnectionPoint;
  144001. /**
  144002. * Gets the tangent input component
  144003. */
  144004. get uv(): NodeMaterialConnectionPoint;
  144005. /**
  144006. * Gets the position output component
  144007. */
  144008. get positionOutput(): NodeMaterialConnectionPoint;
  144009. /**
  144010. * Gets the normal output component
  144011. */
  144012. get normalOutput(): NodeMaterialConnectionPoint;
  144013. /**
  144014. * Gets the tangent output component
  144015. */
  144016. get tangentOutput(): NodeMaterialConnectionPoint;
  144017. /**
  144018. * Gets the tangent output component
  144019. */
  144020. get uvOutput(): NodeMaterialConnectionPoint;
  144021. initialize(state: NodeMaterialBuildState): void;
  144022. autoConfigure(material: NodeMaterial): void;
  144023. prepareDefines(mesh: AbstractMesh, nodeMaterial: NodeMaterial, defines: NodeMaterialDefines): void;
  144024. bind(effect: Effect, nodeMaterial: NodeMaterial, mesh?: Mesh): void;
  144025. replaceRepeatableContent(vertexShaderState: NodeMaterialBuildState, fragmentShaderState: NodeMaterialBuildState, mesh: AbstractMesh, defines: NodeMaterialDefines): void;
  144026. protected _buildBlock(state: NodeMaterialBuildState): this;
  144027. }
  144028. }
  144029. declare module BABYLON {
  144030. /**
  144031. * Block used to get data information from a light
  144032. */
  144033. export class LightInformationBlock extends NodeMaterialBlock {
  144034. private _lightDataUniformName;
  144035. private _lightColorUniformName;
  144036. private _lightTypeDefineName;
  144037. /**
  144038. * Gets or sets the light associated with this block
  144039. */
  144040. light: Nullable<Light>;
  144041. /**
  144042. * Creates a new LightInformationBlock
  144043. * @param name defines the block name
  144044. */
  144045. constructor(name: string);
  144046. /**
  144047. * Gets the current class name
  144048. * @returns the class name
  144049. */
  144050. getClassName(): string;
  144051. /**
  144052. * Gets the world position input component
  144053. */
  144054. get worldPosition(): NodeMaterialConnectionPoint;
  144055. /**
  144056. * Gets the direction output component
  144057. */
  144058. get direction(): NodeMaterialConnectionPoint;
  144059. /**
  144060. * Gets the direction output component
  144061. */
  144062. get color(): NodeMaterialConnectionPoint;
  144063. /**
  144064. * Gets the direction output component
  144065. */
  144066. get intensity(): NodeMaterialConnectionPoint;
  144067. bind(effect: Effect, nodeMaterial: NodeMaterial, mesh?: Mesh): void;
  144068. prepareDefines(mesh: AbstractMesh, nodeMaterial: NodeMaterial, defines: NodeMaterialDefines): void;
  144069. protected _buildBlock(state: NodeMaterialBuildState): this;
  144070. serialize(): any;
  144071. _deserialize(serializationObject: any, scene: Scene, rootUrl: string): void;
  144072. }
  144073. }
  144074. declare module BABYLON {
  144075. /**
  144076. * Block used to add image processing support to fragment shader
  144077. */
  144078. export class ImageProcessingBlock extends NodeMaterialBlock {
  144079. /**
  144080. * Create a new ImageProcessingBlock
  144081. * @param name defines the block name
  144082. */
  144083. constructor(name: string);
  144084. /**
  144085. * Gets the current class name
  144086. * @returns the class name
  144087. */
  144088. getClassName(): string;
  144089. /**
  144090. * Gets the color input component
  144091. */
  144092. get color(): NodeMaterialConnectionPoint;
  144093. /**
  144094. * Gets the output component
  144095. */
  144096. get output(): NodeMaterialConnectionPoint;
  144097. /**
  144098. * Initialize the block and prepare the context for build
  144099. * @param state defines the state that will be used for the build
  144100. */
  144101. initialize(state: NodeMaterialBuildState): void;
  144102. isReady(mesh: AbstractMesh, nodeMaterial: NodeMaterial, defines: NodeMaterialDefines): boolean;
  144103. prepareDefines(mesh: AbstractMesh, nodeMaterial: NodeMaterial, defines: NodeMaterialDefines): void;
  144104. bind(effect: Effect, nodeMaterial: NodeMaterial, mesh?: Mesh): void;
  144105. protected _buildBlock(state: NodeMaterialBuildState): this;
  144106. }
  144107. }
  144108. declare module BABYLON {
  144109. /**
  144110. * Block used to pertub normals based on a normal map
  144111. */
  144112. export class PerturbNormalBlock extends NodeMaterialBlock {
  144113. private _tangentSpaceParameterName;
  144114. /** Gets or sets a boolean indicating that normal should be inverted on X axis */
  144115. invertX: boolean;
  144116. /** Gets or sets a boolean indicating that normal should be inverted on Y axis */
  144117. invertY: boolean;
  144118. /**
  144119. * Create a new PerturbNormalBlock
  144120. * @param name defines the block name
  144121. */
  144122. constructor(name: string);
  144123. /**
  144124. * Gets the current class name
  144125. * @returns the class name
  144126. */
  144127. getClassName(): string;
  144128. /**
  144129. * Gets the world position input component
  144130. */
  144131. get worldPosition(): NodeMaterialConnectionPoint;
  144132. /**
  144133. * Gets the world normal input component
  144134. */
  144135. get worldNormal(): NodeMaterialConnectionPoint;
  144136. /**
  144137. * Gets the world tangent input component
  144138. */
  144139. get worldTangent(): NodeMaterialConnectionPoint;
  144140. /**
  144141. * Gets the uv input component
  144142. */
  144143. get uv(): NodeMaterialConnectionPoint;
  144144. /**
  144145. * Gets the normal map color input component
  144146. */
  144147. get normalMapColor(): NodeMaterialConnectionPoint;
  144148. /**
  144149. * Gets the strength input component
  144150. */
  144151. get strength(): NodeMaterialConnectionPoint;
  144152. /**
  144153. * Gets the output component
  144154. */
  144155. get output(): NodeMaterialConnectionPoint;
  144156. prepareDefines(mesh: AbstractMesh, nodeMaterial: NodeMaterial, defines: NodeMaterialDefines): void;
  144157. bind(effect: Effect, nodeMaterial: NodeMaterial, mesh?: Mesh): void;
  144158. autoConfigure(material: NodeMaterial): void;
  144159. protected _buildBlock(state: NodeMaterialBuildState): this;
  144160. protected _dumpPropertiesCode(): string;
  144161. serialize(): any;
  144162. _deserialize(serializationObject: any, scene: Scene, rootUrl: string): void;
  144163. }
  144164. }
  144165. declare module BABYLON {
  144166. /**
  144167. * Block used to discard a pixel if a value is smaller than a cutoff
  144168. */
  144169. export class DiscardBlock extends NodeMaterialBlock {
  144170. /**
  144171. * Create a new DiscardBlock
  144172. * @param name defines the block name
  144173. */
  144174. constructor(name: string);
  144175. /**
  144176. * Gets the current class name
  144177. * @returns the class name
  144178. */
  144179. getClassName(): string;
  144180. /**
  144181. * Gets the color input component
  144182. */
  144183. get value(): NodeMaterialConnectionPoint;
  144184. /**
  144185. * Gets the cutoff input component
  144186. */
  144187. get cutoff(): NodeMaterialConnectionPoint;
  144188. protected _buildBlock(state: NodeMaterialBuildState): this;
  144189. }
  144190. }
  144191. declare module BABYLON {
  144192. /**
  144193. * Block used to test if the fragment shader is front facing
  144194. */
  144195. export class FrontFacingBlock extends NodeMaterialBlock {
  144196. /**
  144197. * Creates a new FrontFacingBlock
  144198. * @param name defines the block name
  144199. */
  144200. constructor(name: string);
  144201. /**
  144202. * Gets the current class name
  144203. * @returns the class name
  144204. */
  144205. getClassName(): string;
  144206. /**
  144207. * Gets the output component
  144208. */
  144209. get output(): NodeMaterialConnectionPoint;
  144210. protected _buildBlock(state: NodeMaterialBuildState): this;
  144211. }
  144212. }
  144213. declare module BABYLON {
  144214. /**
  144215. * Block used to get the derivative value on x and y of a given input
  144216. */
  144217. export class DerivativeBlock extends NodeMaterialBlock {
  144218. /**
  144219. * Create a new DerivativeBlock
  144220. * @param name defines the block name
  144221. */
  144222. constructor(name: string);
  144223. /**
  144224. * Gets the current class name
  144225. * @returns the class name
  144226. */
  144227. getClassName(): string;
  144228. /**
  144229. * Gets the input component
  144230. */
  144231. get input(): NodeMaterialConnectionPoint;
  144232. /**
  144233. * Gets the derivative output on x
  144234. */
  144235. get dx(): NodeMaterialConnectionPoint;
  144236. /**
  144237. * Gets the derivative output on y
  144238. */
  144239. get dy(): NodeMaterialConnectionPoint;
  144240. protected _buildBlock(state: NodeMaterialBuildState): this;
  144241. }
  144242. }
  144243. declare module BABYLON {
  144244. /**
  144245. * Block used to make gl_FragCoord available
  144246. */
  144247. export class FragCoordBlock extends NodeMaterialBlock {
  144248. /**
  144249. * Creates a new FragCoordBlock
  144250. * @param name defines the block name
  144251. */
  144252. constructor(name: string);
  144253. /**
  144254. * Gets the current class name
  144255. * @returns the class name
  144256. */
  144257. getClassName(): string;
  144258. /**
  144259. * Gets the xy component
  144260. */
  144261. get xy(): NodeMaterialConnectionPoint;
  144262. /**
  144263. * Gets the xyz component
  144264. */
  144265. get xyz(): NodeMaterialConnectionPoint;
  144266. /**
  144267. * Gets the xyzw component
  144268. */
  144269. get xyzw(): NodeMaterialConnectionPoint;
  144270. /**
  144271. * Gets the x component
  144272. */
  144273. get x(): NodeMaterialConnectionPoint;
  144274. /**
  144275. * Gets the y component
  144276. */
  144277. get y(): NodeMaterialConnectionPoint;
  144278. /**
  144279. * Gets the z component
  144280. */
  144281. get z(): NodeMaterialConnectionPoint;
  144282. /**
  144283. * Gets the w component
  144284. */
  144285. get output(): NodeMaterialConnectionPoint;
  144286. protected writeOutputs(state: NodeMaterialBuildState): string;
  144287. protected _buildBlock(state: NodeMaterialBuildState): this;
  144288. }
  144289. }
  144290. declare module BABYLON {
  144291. /**
  144292. * Block used to get the screen sizes
  144293. */
  144294. export class ScreenSizeBlock extends NodeMaterialBlock {
  144295. private _varName;
  144296. private _scene;
  144297. /**
  144298. * Creates a new ScreenSizeBlock
  144299. * @param name defines the block name
  144300. */
  144301. constructor(name: string);
  144302. /**
  144303. * Gets the current class name
  144304. * @returns the class name
  144305. */
  144306. getClassName(): string;
  144307. /**
  144308. * Gets the xy component
  144309. */
  144310. get xy(): NodeMaterialConnectionPoint;
  144311. /**
  144312. * Gets the x component
  144313. */
  144314. get x(): NodeMaterialConnectionPoint;
  144315. /**
  144316. * Gets the y component
  144317. */
  144318. get y(): NodeMaterialConnectionPoint;
  144319. bind(effect: Effect, nodeMaterial: NodeMaterial, mesh?: Mesh): void;
  144320. protected writeOutputs(state: NodeMaterialBuildState, varName: string): string;
  144321. protected _buildBlock(state: NodeMaterialBuildState): this;
  144322. }
  144323. }
  144324. declare module BABYLON {
  144325. /**
  144326. * Block used to add support for scene fog
  144327. */
  144328. export class FogBlock extends NodeMaterialBlock {
  144329. private _fogDistanceName;
  144330. private _fogParameters;
  144331. /**
  144332. * Create a new FogBlock
  144333. * @param name defines the block name
  144334. */
  144335. constructor(name: string);
  144336. /**
  144337. * Gets the current class name
  144338. * @returns the class name
  144339. */
  144340. getClassName(): string;
  144341. /**
  144342. * Gets the world position input component
  144343. */
  144344. get worldPosition(): NodeMaterialConnectionPoint;
  144345. /**
  144346. * Gets the view input component
  144347. */
  144348. get view(): NodeMaterialConnectionPoint;
  144349. /**
  144350. * Gets the color input component
  144351. */
  144352. get input(): NodeMaterialConnectionPoint;
  144353. /**
  144354. * Gets the fog color input component
  144355. */
  144356. get fogColor(): NodeMaterialConnectionPoint;
  144357. /**
  144358. * Gets the output component
  144359. */
  144360. get output(): NodeMaterialConnectionPoint;
  144361. autoConfigure(material: NodeMaterial): void;
  144362. prepareDefines(mesh: AbstractMesh, nodeMaterial: NodeMaterial, defines: NodeMaterialDefines): void;
  144363. bind(effect: Effect, nodeMaterial: NodeMaterial, mesh?: Mesh): void;
  144364. protected _buildBlock(state: NodeMaterialBuildState): this;
  144365. }
  144366. }
  144367. declare module BABYLON {
  144368. /**
  144369. * Block used to add light in the fragment shader
  144370. */
  144371. export class LightBlock extends NodeMaterialBlock {
  144372. private _lightId;
  144373. /**
  144374. * Gets or sets the light associated with this block
  144375. */
  144376. light: Nullable<Light>;
  144377. /**
  144378. * Create a new LightBlock
  144379. * @param name defines the block name
  144380. */
  144381. constructor(name: string);
  144382. /**
  144383. * Gets the current class name
  144384. * @returns the class name
  144385. */
  144386. getClassName(): string;
  144387. /**
  144388. * Gets the world position input component
  144389. */
  144390. get worldPosition(): NodeMaterialConnectionPoint;
  144391. /**
  144392. * Gets the world normal input component
  144393. */
  144394. get worldNormal(): NodeMaterialConnectionPoint;
  144395. /**
  144396. * Gets the camera (or eye) position component
  144397. */
  144398. get cameraPosition(): NodeMaterialConnectionPoint;
  144399. /**
  144400. * Gets the glossiness component
  144401. */
  144402. get glossiness(): NodeMaterialConnectionPoint;
  144403. /**
  144404. * Gets the glossinness power component
  144405. */
  144406. get glossPower(): NodeMaterialConnectionPoint;
  144407. /**
  144408. * Gets the diffuse color component
  144409. */
  144410. get diffuseColor(): NodeMaterialConnectionPoint;
  144411. /**
  144412. * Gets the specular color component
  144413. */
  144414. get specularColor(): NodeMaterialConnectionPoint;
  144415. /**
  144416. * Gets the diffuse output component
  144417. */
  144418. get diffuseOutput(): NodeMaterialConnectionPoint;
  144419. /**
  144420. * Gets the specular output component
  144421. */
  144422. get specularOutput(): NodeMaterialConnectionPoint;
  144423. /**
  144424. * Gets the shadow output component
  144425. */
  144426. get shadow(): NodeMaterialConnectionPoint;
  144427. autoConfigure(material: NodeMaterial): void;
  144428. prepareDefines(mesh: AbstractMesh, nodeMaterial: NodeMaterial, defines: NodeMaterialDefines): void;
  144429. updateUniformsAndSamples(state: NodeMaterialBuildState, nodeMaterial: NodeMaterial, defines: NodeMaterialDefines, uniformBuffers: string[]): void;
  144430. bind(effect: Effect, nodeMaterial: NodeMaterial, mesh?: Mesh): void;
  144431. private _injectVertexCode;
  144432. protected _buildBlock(state: NodeMaterialBuildState): this | undefined;
  144433. serialize(): any;
  144434. _deserialize(serializationObject: any, scene: Scene, rootUrl: string): void;
  144435. }
  144436. }
  144437. declare module BABYLON {
  144438. /**
  144439. * Block used to read a reflection texture from a sampler
  144440. */
  144441. export class ReflectionTextureBlock extends ReflectionTextureBaseBlock {
  144442. /**
  144443. * Create a new ReflectionTextureBlock
  144444. * @param name defines the block name
  144445. */
  144446. constructor(name: string);
  144447. /**
  144448. * Gets the current class name
  144449. * @returns the class name
  144450. */
  144451. getClassName(): string;
  144452. /**
  144453. * Gets the world position input component
  144454. */
  144455. get position(): NodeMaterialConnectionPoint;
  144456. /**
  144457. * Gets the world position input component
  144458. */
  144459. get worldPosition(): NodeMaterialConnectionPoint;
  144460. /**
  144461. * Gets the world normal input component
  144462. */
  144463. get worldNormal(): NodeMaterialConnectionPoint;
  144464. /**
  144465. * Gets the world input component
  144466. */
  144467. get world(): NodeMaterialConnectionPoint;
  144468. /**
  144469. * Gets the camera (or eye) position component
  144470. */
  144471. get cameraPosition(): NodeMaterialConnectionPoint;
  144472. /**
  144473. * Gets the view input component
  144474. */
  144475. get view(): NodeMaterialConnectionPoint;
  144476. /**
  144477. * Gets the rgb output component
  144478. */
  144479. get rgb(): NodeMaterialConnectionPoint;
  144480. /**
  144481. * Gets the rgba output component
  144482. */
  144483. get rgba(): NodeMaterialConnectionPoint;
  144484. /**
  144485. * Gets the r output component
  144486. */
  144487. get r(): NodeMaterialConnectionPoint;
  144488. /**
  144489. * Gets the g output component
  144490. */
  144491. get g(): NodeMaterialConnectionPoint;
  144492. /**
  144493. * Gets the b output component
  144494. */
  144495. get b(): NodeMaterialConnectionPoint;
  144496. /**
  144497. * Gets the a output component
  144498. */
  144499. get a(): NodeMaterialConnectionPoint;
  144500. autoConfigure(material: NodeMaterial): void;
  144501. protected _buildBlock(state: NodeMaterialBuildState): this;
  144502. }
  144503. }
  144504. declare module BABYLON {
  144505. /**
  144506. * Block used to add 2 vectors
  144507. */
  144508. export class AddBlock extends NodeMaterialBlock {
  144509. /**
  144510. * Creates a new AddBlock
  144511. * @param name defines the block name
  144512. */
  144513. constructor(name: string);
  144514. /**
  144515. * Gets the current class name
  144516. * @returns the class name
  144517. */
  144518. getClassName(): string;
  144519. /**
  144520. * Gets the left operand input component
  144521. */
  144522. get left(): NodeMaterialConnectionPoint;
  144523. /**
  144524. * Gets the right operand input component
  144525. */
  144526. get right(): NodeMaterialConnectionPoint;
  144527. /**
  144528. * Gets the output component
  144529. */
  144530. get output(): NodeMaterialConnectionPoint;
  144531. protected _buildBlock(state: NodeMaterialBuildState): this;
  144532. }
  144533. }
  144534. declare module BABYLON {
  144535. /**
  144536. * Block used to scale a vector by a float
  144537. */
  144538. export class ScaleBlock extends NodeMaterialBlock {
  144539. /**
  144540. * Creates a new ScaleBlock
  144541. * @param name defines the block name
  144542. */
  144543. constructor(name: string);
  144544. /**
  144545. * Gets the current class name
  144546. * @returns the class name
  144547. */
  144548. getClassName(): string;
  144549. /**
  144550. * Gets the input component
  144551. */
  144552. get input(): NodeMaterialConnectionPoint;
  144553. /**
  144554. * Gets the factor input component
  144555. */
  144556. get factor(): NodeMaterialConnectionPoint;
  144557. /**
  144558. * Gets the output component
  144559. */
  144560. get output(): NodeMaterialConnectionPoint;
  144561. protected _buildBlock(state: NodeMaterialBuildState): this;
  144562. }
  144563. }
  144564. declare module BABYLON {
  144565. /**
  144566. * Block used to clamp a float
  144567. */
  144568. export class ClampBlock extends NodeMaterialBlock {
  144569. /** Gets or sets the minimum range */
  144570. minimum: number;
  144571. /** Gets or sets the maximum range */
  144572. maximum: number;
  144573. /**
  144574. * Creates a new ClampBlock
  144575. * @param name defines the block name
  144576. */
  144577. constructor(name: string);
  144578. /**
  144579. * Gets the current class name
  144580. * @returns the class name
  144581. */
  144582. getClassName(): string;
  144583. /**
  144584. * Gets the value input component
  144585. */
  144586. get value(): NodeMaterialConnectionPoint;
  144587. /**
  144588. * Gets the output component
  144589. */
  144590. get output(): NodeMaterialConnectionPoint;
  144591. protected _buildBlock(state: NodeMaterialBuildState): this;
  144592. protected _dumpPropertiesCode(): string;
  144593. serialize(): any;
  144594. _deserialize(serializationObject: any, scene: Scene, rootUrl: string): void;
  144595. }
  144596. }
  144597. declare module BABYLON {
  144598. /**
  144599. * Block used to apply a cross product between 2 vectors
  144600. */
  144601. export class CrossBlock extends NodeMaterialBlock {
  144602. /**
  144603. * Creates a new CrossBlock
  144604. * @param name defines the block name
  144605. */
  144606. constructor(name: string);
  144607. /**
  144608. * Gets the current class name
  144609. * @returns the class name
  144610. */
  144611. getClassName(): string;
  144612. /**
  144613. * Gets the left operand input component
  144614. */
  144615. get left(): NodeMaterialConnectionPoint;
  144616. /**
  144617. * Gets the right operand input component
  144618. */
  144619. get right(): NodeMaterialConnectionPoint;
  144620. /**
  144621. * Gets the output component
  144622. */
  144623. get output(): NodeMaterialConnectionPoint;
  144624. protected _buildBlock(state: NodeMaterialBuildState): this;
  144625. }
  144626. }
  144627. declare module BABYLON {
  144628. /**
  144629. * Block used to apply a dot product between 2 vectors
  144630. */
  144631. export class DotBlock extends NodeMaterialBlock {
  144632. /**
  144633. * Creates a new DotBlock
  144634. * @param name defines the block name
  144635. */
  144636. constructor(name: string);
  144637. /**
  144638. * Gets the current class name
  144639. * @returns the class name
  144640. */
  144641. getClassName(): string;
  144642. /**
  144643. * Gets the left operand input component
  144644. */
  144645. get left(): NodeMaterialConnectionPoint;
  144646. /**
  144647. * Gets the right operand input component
  144648. */
  144649. get right(): NodeMaterialConnectionPoint;
  144650. /**
  144651. * Gets the output component
  144652. */
  144653. get output(): NodeMaterialConnectionPoint;
  144654. protected _buildBlock(state: NodeMaterialBuildState): this;
  144655. }
  144656. }
  144657. declare module BABYLON {
  144658. /**
  144659. * Block used to normalize a vector
  144660. */
  144661. export class NormalizeBlock extends NodeMaterialBlock {
  144662. /**
  144663. * Creates a new NormalizeBlock
  144664. * @param name defines the block name
  144665. */
  144666. constructor(name: string);
  144667. /**
  144668. * Gets the current class name
  144669. * @returns the class name
  144670. */
  144671. getClassName(): string;
  144672. /**
  144673. * Gets the input component
  144674. */
  144675. get input(): NodeMaterialConnectionPoint;
  144676. /**
  144677. * Gets the output component
  144678. */
  144679. get output(): NodeMaterialConnectionPoint;
  144680. protected _buildBlock(state: NodeMaterialBuildState): this;
  144681. }
  144682. }
  144683. declare module BABYLON {
  144684. /**
  144685. * Block used to create a Color3/4 out of individual inputs (one for each component)
  144686. */
  144687. export class ColorMergerBlock extends NodeMaterialBlock {
  144688. /**
  144689. * Create a new ColorMergerBlock
  144690. * @param name defines the block name
  144691. */
  144692. constructor(name: string);
  144693. /**
  144694. * Gets the current class name
  144695. * @returns the class name
  144696. */
  144697. getClassName(): string;
  144698. /**
  144699. * Gets the rgb component (input)
  144700. */
  144701. get rgbIn(): NodeMaterialConnectionPoint;
  144702. /**
  144703. * Gets the r component (input)
  144704. */
  144705. get r(): NodeMaterialConnectionPoint;
  144706. /**
  144707. * Gets the g component (input)
  144708. */
  144709. get g(): NodeMaterialConnectionPoint;
  144710. /**
  144711. * Gets the b component (input)
  144712. */
  144713. get b(): NodeMaterialConnectionPoint;
  144714. /**
  144715. * Gets the a component (input)
  144716. */
  144717. get a(): NodeMaterialConnectionPoint;
  144718. /**
  144719. * Gets the rgba component (output)
  144720. */
  144721. get rgba(): NodeMaterialConnectionPoint;
  144722. /**
  144723. * Gets the rgb component (output)
  144724. */
  144725. get rgbOut(): NodeMaterialConnectionPoint;
  144726. /**
  144727. * Gets the rgb component (output)
  144728. * @deprecated Please use rgbOut instead.
  144729. */
  144730. get rgb(): NodeMaterialConnectionPoint;
  144731. protected _buildBlock(state: NodeMaterialBuildState): this;
  144732. }
  144733. }
  144734. declare module BABYLON {
  144735. /**
  144736. * Block used to expand a Vector3/4 into 4 outputs (one for each component)
  144737. */
  144738. export class VectorSplitterBlock extends NodeMaterialBlock {
  144739. /**
  144740. * Create a new VectorSplitterBlock
  144741. * @param name defines the block name
  144742. */
  144743. constructor(name: string);
  144744. /**
  144745. * Gets the current class name
  144746. * @returns the class name
  144747. */
  144748. getClassName(): string;
  144749. /**
  144750. * Gets the xyzw component (input)
  144751. */
  144752. get xyzw(): NodeMaterialConnectionPoint;
  144753. /**
  144754. * Gets the xyz component (input)
  144755. */
  144756. get xyzIn(): NodeMaterialConnectionPoint;
  144757. /**
  144758. * Gets the xy component (input)
  144759. */
  144760. get xyIn(): NodeMaterialConnectionPoint;
  144761. /**
  144762. * Gets the xyz component (output)
  144763. */
  144764. get xyzOut(): NodeMaterialConnectionPoint;
  144765. /**
  144766. * Gets the xy component (output)
  144767. */
  144768. get xyOut(): NodeMaterialConnectionPoint;
  144769. /**
  144770. * Gets the x component (output)
  144771. */
  144772. get x(): NodeMaterialConnectionPoint;
  144773. /**
  144774. * Gets the y component (output)
  144775. */
  144776. get y(): NodeMaterialConnectionPoint;
  144777. /**
  144778. * Gets the z component (output)
  144779. */
  144780. get z(): NodeMaterialConnectionPoint;
  144781. /**
  144782. * Gets the w component (output)
  144783. */
  144784. get w(): NodeMaterialConnectionPoint;
  144785. protected _inputRename(name: string): string;
  144786. protected _outputRename(name: string): string;
  144787. protected _buildBlock(state: NodeMaterialBuildState): this;
  144788. }
  144789. }
  144790. declare module BABYLON {
  144791. /**
  144792. * Block used to lerp between 2 values
  144793. */
  144794. export class LerpBlock extends NodeMaterialBlock {
  144795. /**
  144796. * Creates a new LerpBlock
  144797. * @param name defines the block name
  144798. */
  144799. constructor(name: string);
  144800. /**
  144801. * Gets the current class name
  144802. * @returns the class name
  144803. */
  144804. getClassName(): string;
  144805. /**
  144806. * Gets the left operand input component
  144807. */
  144808. get left(): NodeMaterialConnectionPoint;
  144809. /**
  144810. * Gets the right operand input component
  144811. */
  144812. get right(): NodeMaterialConnectionPoint;
  144813. /**
  144814. * Gets the gradient operand input component
  144815. */
  144816. get gradient(): NodeMaterialConnectionPoint;
  144817. /**
  144818. * Gets the output component
  144819. */
  144820. get output(): NodeMaterialConnectionPoint;
  144821. protected _buildBlock(state: NodeMaterialBuildState): this;
  144822. }
  144823. }
  144824. declare module BABYLON {
  144825. /**
  144826. * Block used to divide 2 vectors
  144827. */
  144828. export class DivideBlock extends NodeMaterialBlock {
  144829. /**
  144830. * Creates a new DivideBlock
  144831. * @param name defines the block name
  144832. */
  144833. constructor(name: string);
  144834. /**
  144835. * Gets the current class name
  144836. * @returns the class name
  144837. */
  144838. getClassName(): string;
  144839. /**
  144840. * Gets the left operand input component
  144841. */
  144842. get left(): NodeMaterialConnectionPoint;
  144843. /**
  144844. * Gets the right operand input component
  144845. */
  144846. get right(): NodeMaterialConnectionPoint;
  144847. /**
  144848. * Gets the output component
  144849. */
  144850. get output(): NodeMaterialConnectionPoint;
  144851. protected _buildBlock(state: NodeMaterialBuildState): this;
  144852. }
  144853. }
  144854. declare module BABYLON {
  144855. /**
  144856. * Block used to subtract 2 vectors
  144857. */
  144858. export class SubtractBlock extends NodeMaterialBlock {
  144859. /**
  144860. * Creates a new SubtractBlock
  144861. * @param name defines the block name
  144862. */
  144863. constructor(name: string);
  144864. /**
  144865. * Gets the current class name
  144866. * @returns the class name
  144867. */
  144868. getClassName(): string;
  144869. /**
  144870. * Gets the left operand input component
  144871. */
  144872. get left(): NodeMaterialConnectionPoint;
  144873. /**
  144874. * Gets the right operand input component
  144875. */
  144876. get right(): NodeMaterialConnectionPoint;
  144877. /**
  144878. * Gets the output component
  144879. */
  144880. get output(): NodeMaterialConnectionPoint;
  144881. protected _buildBlock(state: NodeMaterialBuildState): this;
  144882. }
  144883. }
  144884. declare module BABYLON {
  144885. /**
  144886. * Block used to step a value
  144887. */
  144888. export class StepBlock extends NodeMaterialBlock {
  144889. /**
  144890. * Creates a new StepBlock
  144891. * @param name defines the block name
  144892. */
  144893. constructor(name: string);
  144894. /**
  144895. * Gets the current class name
  144896. * @returns the class name
  144897. */
  144898. getClassName(): string;
  144899. /**
  144900. * Gets the value operand input component
  144901. */
  144902. get value(): NodeMaterialConnectionPoint;
  144903. /**
  144904. * Gets the edge operand input component
  144905. */
  144906. get edge(): NodeMaterialConnectionPoint;
  144907. /**
  144908. * Gets the output component
  144909. */
  144910. get output(): NodeMaterialConnectionPoint;
  144911. protected _buildBlock(state: NodeMaterialBuildState): this;
  144912. }
  144913. }
  144914. declare module BABYLON {
  144915. /**
  144916. * Block used to get the opposite (1 - x) of a value
  144917. */
  144918. export class OneMinusBlock extends NodeMaterialBlock {
  144919. /**
  144920. * Creates a new OneMinusBlock
  144921. * @param name defines the block name
  144922. */
  144923. constructor(name: string);
  144924. /**
  144925. * Gets the current class name
  144926. * @returns the class name
  144927. */
  144928. getClassName(): string;
  144929. /**
  144930. * Gets the input component
  144931. */
  144932. get input(): NodeMaterialConnectionPoint;
  144933. /**
  144934. * Gets the output component
  144935. */
  144936. get output(): NodeMaterialConnectionPoint;
  144937. protected _buildBlock(state: NodeMaterialBuildState): this;
  144938. }
  144939. }
  144940. declare module BABYLON {
  144941. /**
  144942. * Block used to get the view direction
  144943. */
  144944. export class ViewDirectionBlock extends NodeMaterialBlock {
  144945. /**
  144946. * Creates a new ViewDirectionBlock
  144947. * @param name defines the block name
  144948. */
  144949. constructor(name: string);
  144950. /**
  144951. * Gets the current class name
  144952. * @returns the class name
  144953. */
  144954. getClassName(): string;
  144955. /**
  144956. * Gets the world position component
  144957. */
  144958. get worldPosition(): NodeMaterialConnectionPoint;
  144959. /**
  144960. * Gets the camera position component
  144961. */
  144962. get cameraPosition(): NodeMaterialConnectionPoint;
  144963. /**
  144964. * Gets the output component
  144965. */
  144966. get output(): NodeMaterialConnectionPoint;
  144967. autoConfigure(material: NodeMaterial): void;
  144968. protected _buildBlock(state: NodeMaterialBuildState): this;
  144969. }
  144970. }
  144971. declare module BABYLON {
  144972. /**
  144973. * Block used to compute fresnel value
  144974. */
  144975. export class FresnelBlock extends NodeMaterialBlock {
  144976. /**
  144977. * Create a new FresnelBlock
  144978. * @param name defines the block name
  144979. */
  144980. constructor(name: string);
  144981. /**
  144982. * Gets the current class name
  144983. * @returns the class name
  144984. */
  144985. getClassName(): string;
  144986. /**
  144987. * Gets the world normal input component
  144988. */
  144989. get worldNormal(): NodeMaterialConnectionPoint;
  144990. /**
  144991. * Gets the view direction input component
  144992. */
  144993. get viewDirection(): NodeMaterialConnectionPoint;
  144994. /**
  144995. * Gets the bias input component
  144996. */
  144997. get bias(): NodeMaterialConnectionPoint;
  144998. /**
  144999. * Gets the camera (or eye) position component
  145000. */
  145001. get power(): NodeMaterialConnectionPoint;
  145002. /**
  145003. * Gets the fresnel output component
  145004. */
  145005. get fresnel(): NodeMaterialConnectionPoint;
  145006. autoConfigure(material: NodeMaterial): void;
  145007. protected _buildBlock(state: NodeMaterialBuildState): this;
  145008. }
  145009. }
  145010. declare module BABYLON {
  145011. /**
  145012. * Block used to get the max of 2 values
  145013. */
  145014. export class MaxBlock extends NodeMaterialBlock {
  145015. /**
  145016. * Creates a new MaxBlock
  145017. * @param name defines the block name
  145018. */
  145019. constructor(name: string);
  145020. /**
  145021. * Gets the current class name
  145022. * @returns the class name
  145023. */
  145024. getClassName(): string;
  145025. /**
  145026. * Gets the left operand input component
  145027. */
  145028. get left(): NodeMaterialConnectionPoint;
  145029. /**
  145030. * Gets the right operand input component
  145031. */
  145032. get right(): NodeMaterialConnectionPoint;
  145033. /**
  145034. * Gets the output component
  145035. */
  145036. get output(): NodeMaterialConnectionPoint;
  145037. protected _buildBlock(state: NodeMaterialBuildState): this;
  145038. }
  145039. }
  145040. declare module BABYLON {
  145041. /**
  145042. * Block used to get the min of 2 values
  145043. */
  145044. export class MinBlock extends NodeMaterialBlock {
  145045. /**
  145046. * Creates a new MinBlock
  145047. * @param name defines the block name
  145048. */
  145049. constructor(name: string);
  145050. /**
  145051. * Gets the current class name
  145052. * @returns the class name
  145053. */
  145054. getClassName(): string;
  145055. /**
  145056. * Gets the left operand input component
  145057. */
  145058. get left(): NodeMaterialConnectionPoint;
  145059. /**
  145060. * Gets the right operand input component
  145061. */
  145062. get right(): NodeMaterialConnectionPoint;
  145063. /**
  145064. * Gets the output component
  145065. */
  145066. get output(): NodeMaterialConnectionPoint;
  145067. protected _buildBlock(state: NodeMaterialBuildState): this;
  145068. }
  145069. }
  145070. declare module BABYLON {
  145071. /**
  145072. * Block used to get the distance between 2 values
  145073. */
  145074. export class DistanceBlock extends NodeMaterialBlock {
  145075. /**
  145076. * Creates a new DistanceBlock
  145077. * @param name defines the block name
  145078. */
  145079. constructor(name: string);
  145080. /**
  145081. * Gets the current class name
  145082. * @returns the class name
  145083. */
  145084. getClassName(): string;
  145085. /**
  145086. * Gets the left operand input component
  145087. */
  145088. get left(): NodeMaterialConnectionPoint;
  145089. /**
  145090. * Gets the right operand input component
  145091. */
  145092. get right(): NodeMaterialConnectionPoint;
  145093. /**
  145094. * Gets the output component
  145095. */
  145096. get output(): NodeMaterialConnectionPoint;
  145097. protected _buildBlock(state: NodeMaterialBuildState): this;
  145098. }
  145099. }
  145100. declare module BABYLON {
  145101. /**
  145102. * Block used to get the length of a vector
  145103. */
  145104. export class LengthBlock extends NodeMaterialBlock {
  145105. /**
  145106. * Creates a new LengthBlock
  145107. * @param name defines the block name
  145108. */
  145109. constructor(name: string);
  145110. /**
  145111. * Gets the current class name
  145112. * @returns the class name
  145113. */
  145114. getClassName(): string;
  145115. /**
  145116. * Gets the value input component
  145117. */
  145118. get value(): NodeMaterialConnectionPoint;
  145119. /**
  145120. * Gets the output component
  145121. */
  145122. get output(): NodeMaterialConnectionPoint;
  145123. protected _buildBlock(state: NodeMaterialBuildState): this;
  145124. }
  145125. }
  145126. declare module BABYLON {
  145127. /**
  145128. * Block used to get negative version of a value (i.e. x * -1)
  145129. */
  145130. export class NegateBlock extends NodeMaterialBlock {
  145131. /**
  145132. * Creates a new NegateBlock
  145133. * @param name defines the block name
  145134. */
  145135. constructor(name: string);
  145136. /**
  145137. * Gets the current class name
  145138. * @returns the class name
  145139. */
  145140. getClassName(): string;
  145141. /**
  145142. * Gets the value input component
  145143. */
  145144. get value(): NodeMaterialConnectionPoint;
  145145. /**
  145146. * Gets the output component
  145147. */
  145148. get output(): NodeMaterialConnectionPoint;
  145149. protected _buildBlock(state: NodeMaterialBuildState): this;
  145150. }
  145151. }
  145152. declare module BABYLON {
  145153. /**
  145154. * Block used to get the value of the first parameter raised to the power of the second
  145155. */
  145156. export class PowBlock extends NodeMaterialBlock {
  145157. /**
  145158. * Creates a new PowBlock
  145159. * @param name defines the block name
  145160. */
  145161. constructor(name: string);
  145162. /**
  145163. * Gets the current class name
  145164. * @returns the class name
  145165. */
  145166. getClassName(): string;
  145167. /**
  145168. * Gets the value operand input component
  145169. */
  145170. get value(): NodeMaterialConnectionPoint;
  145171. /**
  145172. * Gets the power operand input component
  145173. */
  145174. get power(): NodeMaterialConnectionPoint;
  145175. /**
  145176. * Gets the output component
  145177. */
  145178. get output(): NodeMaterialConnectionPoint;
  145179. protected _buildBlock(state: NodeMaterialBuildState): this;
  145180. }
  145181. }
  145182. declare module BABYLON {
  145183. /**
  145184. * Block used to get a random number
  145185. */
  145186. export class RandomNumberBlock extends NodeMaterialBlock {
  145187. /**
  145188. * Creates a new RandomNumberBlock
  145189. * @param name defines the block name
  145190. */
  145191. constructor(name: string);
  145192. /**
  145193. * Gets the current class name
  145194. * @returns the class name
  145195. */
  145196. getClassName(): string;
  145197. /**
  145198. * Gets the seed input component
  145199. */
  145200. get seed(): NodeMaterialConnectionPoint;
  145201. /**
  145202. * Gets the output component
  145203. */
  145204. get output(): NodeMaterialConnectionPoint;
  145205. protected _buildBlock(state: NodeMaterialBuildState): this;
  145206. }
  145207. }
  145208. declare module BABYLON {
  145209. /**
  145210. * Block used to compute arc tangent of 2 values
  145211. */
  145212. export class ArcTan2Block extends NodeMaterialBlock {
  145213. /**
  145214. * Creates a new ArcTan2Block
  145215. * @param name defines the block name
  145216. */
  145217. constructor(name: string);
  145218. /**
  145219. * Gets the current class name
  145220. * @returns the class name
  145221. */
  145222. getClassName(): string;
  145223. /**
  145224. * Gets the x operand input component
  145225. */
  145226. get x(): NodeMaterialConnectionPoint;
  145227. /**
  145228. * Gets the y operand input component
  145229. */
  145230. get y(): NodeMaterialConnectionPoint;
  145231. /**
  145232. * Gets the output component
  145233. */
  145234. get output(): NodeMaterialConnectionPoint;
  145235. protected _buildBlock(state: NodeMaterialBuildState): this;
  145236. }
  145237. }
  145238. declare module BABYLON {
  145239. /**
  145240. * Block used to smooth step a value
  145241. */
  145242. export class SmoothStepBlock extends NodeMaterialBlock {
  145243. /**
  145244. * Creates a new SmoothStepBlock
  145245. * @param name defines the block name
  145246. */
  145247. constructor(name: string);
  145248. /**
  145249. * Gets the current class name
  145250. * @returns the class name
  145251. */
  145252. getClassName(): string;
  145253. /**
  145254. * Gets the value operand input component
  145255. */
  145256. get value(): NodeMaterialConnectionPoint;
  145257. /**
  145258. * Gets the first edge operand input component
  145259. */
  145260. get edge0(): NodeMaterialConnectionPoint;
  145261. /**
  145262. * Gets the second edge operand input component
  145263. */
  145264. get edge1(): NodeMaterialConnectionPoint;
  145265. /**
  145266. * Gets the output component
  145267. */
  145268. get output(): NodeMaterialConnectionPoint;
  145269. protected _buildBlock(state: NodeMaterialBuildState): this;
  145270. }
  145271. }
  145272. declare module BABYLON {
  145273. /**
  145274. * Block used to get the reciprocal (1 / x) of a value
  145275. */
  145276. export class ReciprocalBlock extends NodeMaterialBlock {
  145277. /**
  145278. * Creates a new ReciprocalBlock
  145279. * @param name defines the block name
  145280. */
  145281. constructor(name: string);
  145282. /**
  145283. * Gets the current class name
  145284. * @returns the class name
  145285. */
  145286. getClassName(): string;
  145287. /**
  145288. * Gets the input component
  145289. */
  145290. get input(): NodeMaterialConnectionPoint;
  145291. /**
  145292. * Gets the output component
  145293. */
  145294. get output(): NodeMaterialConnectionPoint;
  145295. protected _buildBlock(state: NodeMaterialBuildState): this;
  145296. }
  145297. }
  145298. declare module BABYLON {
  145299. /**
  145300. * Block used to replace a color by another one
  145301. */
  145302. export class ReplaceColorBlock extends NodeMaterialBlock {
  145303. /**
  145304. * Creates a new ReplaceColorBlock
  145305. * @param name defines the block name
  145306. */
  145307. constructor(name: string);
  145308. /**
  145309. * Gets the current class name
  145310. * @returns the class name
  145311. */
  145312. getClassName(): string;
  145313. /**
  145314. * Gets the value input component
  145315. */
  145316. get value(): NodeMaterialConnectionPoint;
  145317. /**
  145318. * Gets the reference input component
  145319. */
  145320. get reference(): NodeMaterialConnectionPoint;
  145321. /**
  145322. * Gets the distance input component
  145323. */
  145324. get distance(): NodeMaterialConnectionPoint;
  145325. /**
  145326. * Gets the replacement input component
  145327. */
  145328. get replacement(): NodeMaterialConnectionPoint;
  145329. /**
  145330. * Gets the output component
  145331. */
  145332. get output(): NodeMaterialConnectionPoint;
  145333. protected _buildBlock(state: NodeMaterialBuildState): this;
  145334. }
  145335. }
  145336. declare module BABYLON {
  145337. /**
  145338. * Block used to posterize a value
  145339. * @see https://en.wikipedia.org/wiki/Posterization
  145340. */
  145341. export class PosterizeBlock extends NodeMaterialBlock {
  145342. /**
  145343. * Creates a new PosterizeBlock
  145344. * @param name defines the block name
  145345. */
  145346. constructor(name: string);
  145347. /**
  145348. * Gets the current class name
  145349. * @returns the class name
  145350. */
  145351. getClassName(): string;
  145352. /**
  145353. * Gets the value input component
  145354. */
  145355. get value(): NodeMaterialConnectionPoint;
  145356. /**
  145357. * Gets the steps input component
  145358. */
  145359. get steps(): NodeMaterialConnectionPoint;
  145360. /**
  145361. * Gets the output component
  145362. */
  145363. get output(): NodeMaterialConnectionPoint;
  145364. protected _buildBlock(state: NodeMaterialBuildState): this;
  145365. }
  145366. }
  145367. declare module BABYLON {
  145368. /**
  145369. * Operations supported by the Wave block
  145370. */
  145371. export enum WaveBlockKind {
  145372. /** SawTooth */
  145373. SawTooth = 0,
  145374. /** Square */
  145375. Square = 1,
  145376. /** Triangle */
  145377. Triangle = 2
  145378. }
  145379. /**
  145380. * Block used to apply wave operation to floats
  145381. */
  145382. export class WaveBlock extends NodeMaterialBlock {
  145383. /**
  145384. * Gets or sets the kibnd of wave to be applied by the block
  145385. */
  145386. kind: WaveBlockKind;
  145387. /**
  145388. * Creates a new WaveBlock
  145389. * @param name defines the block name
  145390. */
  145391. constructor(name: string);
  145392. /**
  145393. * Gets the current class name
  145394. * @returns the class name
  145395. */
  145396. getClassName(): string;
  145397. /**
  145398. * Gets the input component
  145399. */
  145400. get input(): NodeMaterialConnectionPoint;
  145401. /**
  145402. * Gets the output component
  145403. */
  145404. get output(): NodeMaterialConnectionPoint;
  145405. protected _buildBlock(state: NodeMaterialBuildState): this;
  145406. serialize(): any;
  145407. _deserialize(serializationObject: any, scene: Scene, rootUrl: string): void;
  145408. }
  145409. }
  145410. declare module BABYLON {
  145411. /**
  145412. * Class used to store a color step for the GradientBlock
  145413. */
  145414. export class GradientBlockColorStep {
  145415. private _step;
  145416. /**
  145417. * Gets value indicating which step this color is associated with (between 0 and 1)
  145418. */
  145419. get step(): number;
  145420. /**
  145421. * Sets a value indicating which step this color is associated with (between 0 and 1)
  145422. */
  145423. set step(val: number);
  145424. private _color;
  145425. /**
  145426. * Gets the color associated with this step
  145427. */
  145428. get color(): Color3;
  145429. /**
  145430. * Sets the color associated with this step
  145431. */
  145432. set color(val: Color3);
  145433. /**
  145434. * Creates a new GradientBlockColorStep
  145435. * @param step defines a value indicating which step this color is associated with (between 0 and 1)
  145436. * @param color defines the color associated with this step
  145437. */
  145438. constructor(step: number, color: Color3);
  145439. }
  145440. /**
  145441. * Block used to return a color from a gradient based on an input value between 0 and 1
  145442. */
  145443. export class GradientBlock extends NodeMaterialBlock {
  145444. /**
  145445. * Gets or sets the list of color steps
  145446. */
  145447. colorSteps: GradientBlockColorStep[];
  145448. /** Gets an observable raised when the value is changed */
  145449. onValueChangedObservable: Observable<GradientBlock>;
  145450. /** calls observable when the value is changed*/
  145451. colorStepsUpdated(): void;
  145452. /**
  145453. * Creates a new GradientBlock
  145454. * @param name defines the block name
  145455. */
  145456. constructor(name: string);
  145457. /**
  145458. * Gets the current class name
  145459. * @returns the class name
  145460. */
  145461. getClassName(): string;
  145462. /**
  145463. * Gets the gradient input component
  145464. */
  145465. get gradient(): NodeMaterialConnectionPoint;
  145466. /**
  145467. * Gets the output component
  145468. */
  145469. get output(): NodeMaterialConnectionPoint;
  145470. private _writeColorConstant;
  145471. protected _buildBlock(state: NodeMaterialBuildState): this | undefined;
  145472. serialize(): any;
  145473. _deserialize(serializationObject: any, scene: Scene, rootUrl: string): void;
  145474. protected _dumpPropertiesCode(): string;
  145475. }
  145476. }
  145477. declare module BABYLON {
  145478. /**
  145479. * Block used to normalize lerp between 2 values
  145480. */
  145481. export class NLerpBlock extends NodeMaterialBlock {
  145482. /**
  145483. * Creates a new NLerpBlock
  145484. * @param name defines the block name
  145485. */
  145486. constructor(name: string);
  145487. /**
  145488. * Gets the current class name
  145489. * @returns the class name
  145490. */
  145491. getClassName(): string;
  145492. /**
  145493. * Gets the left operand input component
  145494. */
  145495. get left(): NodeMaterialConnectionPoint;
  145496. /**
  145497. * Gets the right operand input component
  145498. */
  145499. get right(): NodeMaterialConnectionPoint;
  145500. /**
  145501. * Gets the gradient operand input component
  145502. */
  145503. get gradient(): NodeMaterialConnectionPoint;
  145504. /**
  145505. * Gets the output component
  145506. */
  145507. get output(): NodeMaterialConnectionPoint;
  145508. protected _buildBlock(state: NodeMaterialBuildState): this;
  145509. }
  145510. }
  145511. declare module BABYLON {
  145512. /**
  145513. * block used to Generate a Worley Noise 3D Noise Pattern
  145514. */
  145515. export class WorleyNoise3DBlock extends NodeMaterialBlock {
  145516. /** Gets or sets a boolean indicating that normal should be inverted on X axis */
  145517. manhattanDistance: boolean;
  145518. /**
  145519. * Creates a new WorleyNoise3DBlock
  145520. * @param name defines the block name
  145521. */
  145522. constructor(name: string);
  145523. /**
  145524. * Gets the current class name
  145525. * @returns the class name
  145526. */
  145527. getClassName(): string;
  145528. /**
  145529. * Gets the seed input component
  145530. */
  145531. get seed(): NodeMaterialConnectionPoint;
  145532. /**
  145533. * Gets the jitter input component
  145534. */
  145535. get jitter(): NodeMaterialConnectionPoint;
  145536. /**
  145537. * Gets the output component
  145538. */
  145539. get output(): NodeMaterialConnectionPoint;
  145540. protected _buildBlock(state: NodeMaterialBuildState): this | undefined;
  145541. /**
  145542. * Exposes the properties to the UI?
  145543. */
  145544. protected _dumpPropertiesCode(): string;
  145545. /**
  145546. * Exposes the properties to the Seralize?
  145547. */
  145548. serialize(): any;
  145549. /**
  145550. * Exposes the properties to the deseralize?
  145551. */
  145552. _deserialize(serializationObject: any, scene: Scene, rootUrl: string): void;
  145553. }
  145554. }
  145555. declare module BABYLON {
  145556. /**
  145557. * block used to Generate a Simplex Perlin 3d Noise Pattern
  145558. */
  145559. export class SimplexPerlin3DBlock extends NodeMaterialBlock {
  145560. /**
  145561. * Creates a new SimplexPerlin3DBlock
  145562. * @param name defines the block name
  145563. */
  145564. constructor(name: string);
  145565. /**
  145566. * Gets the current class name
  145567. * @returns the class name
  145568. */
  145569. getClassName(): string;
  145570. /**
  145571. * Gets the seed operand input component
  145572. */
  145573. get seed(): NodeMaterialConnectionPoint;
  145574. /**
  145575. * Gets the output component
  145576. */
  145577. get output(): NodeMaterialConnectionPoint;
  145578. protected _buildBlock(state: NodeMaterialBuildState): this | undefined;
  145579. }
  145580. }
  145581. declare module BABYLON {
  145582. /**
  145583. * Block used to blend normals
  145584. */
  145585. export class NormalBlendBlock extends NodeMaterialBlock {
  145586. /**
  145587. * Creates a new NormalBlendBlock
  145588. * @param name defines the block name
  145589. */
  145590. constructor(name: string);
  145591. /**
  145592. * Gets the current class name
  145593. * @returns the class name
  145594. */
  145595. getClassName(): string;
  145596. /**
  145597. * Gets the first input component
  145598. */
  145599. get normalMap0(): NodeMaterialConnectionPoint;
  145600. /**
  145601. * Gets the second input component
  145602. */
  145603. get normalMap1(): NodeMaterialConnectionPoint;
  145604. /**
  145605. * Gets the output component
  145606. */
  145607. get output(): NodeMaterialConnectionPoint;
  145608. protected _buildBlock(state: NodeMaterialBuildState): this;
  145609. }
  145610. }
  145611. declare module BABYLON {
  145612. /**
  145613. * Block used to rotate a 2d vector by a given angle
  145614. */
  145615. export class Rotate2dBlock extends NodeMaterialBlock {
  145616. /**
  145617. * Creates a new Rotate2dBlock
  145618. * @param name defines the block name
  145619. */
  145620. constructor(name: string);
  145621. /**
  145622. * Gets the current class name
  145623. * @returns the class name
  145624. */
  145625. getClassName(): string;
  145626. /**
  145627. * Gets the input vector
  145628. */
  145629. get input(): NodeMaterialConnectionPoint;
  145630. /**
  145631. * Gets the input angle
  145632. */
  145633. get angle(): NodeMaterialConnectionPoint;
  145634. /**
  145635. * Gets the output component
  145636. */
  145637. get output(): NodeMaterialConnectionPoint;
  145638. autoConfigure(material: NodeMaterial): void;
  145639. protected _buildBlock(state: NodeMaterialBuildState): this;
  145640. }
  145641. }
  145642. declare module BABYLON {
  145643. /**
  145644. * Block used to get the reflected vector from a direction and a normal
  145645. */
  145646. export class ReflectBlock extends NodeMaterialBlock {
  145647. /**
  145648. * Creates a new ReflectBlock
  145649. * @param name defines the block name
  145650. */
  145651. constructor(name: string);
  145652. /**
  145653. * Gets the current class name
  145654. * @returns the class name
  145655. */
  145656. getClassName(): string;
  145657. /**
  145658. * Gets the incident component
  145659. */
  145660. get incident(): NodeMaterialConnectionPoint;
  145661. /**
  145662. * Gets the normal component
  145663. */
  145664. get normal(): NodeMaterialConnectionPoint;
  145665. /**
  145666. * Gets the output component
  145667. */
  145668. get output(): NodeMaterialConnectionPoint;
  145669. protected _buildBlock(state: NodeMaterialBuildState): this;
  145670. }
  145671. }
  145672. declare module BABYLON {
  145673. /**
  145674. * Block used to get the refracted vector from a direction and a normal
  145675. */
  145676. export class RefractBlock extends NodeMaterialBlock {
  145677. /**
  145678. * Creates a new RefractBlock
  145679. * @param name defines the block name
  145680. */
  145681. constructor(name: string);
  145682. /**
  145683. * Gets the current class name
  145684. * @returns the class name
  145685. */
  145686. getClassName(): string;
  145687. /**
  145688. * Gets the incident component
  145689. */
  145690. get incident(): NodeMaterialConnectionPoint;
  145691. /**
  145692. * Gets the normal component
  145693. */
  145694. get normal(): NodeMaterialConnectionPoint;
  145695. /**
  145696. * Gets the index of refraction component
  145697. */
  145698. get ior(): NodeMaterialConnectionPoint;
  145699. /**
  145700. * Gets the output component
  145701. */
  145702. get output(): NodeMaterialConnectionPoint;
  145703. protected _buildBlock(state: NodeMaterialBuildState): this;
  145704. }
  145705. }
  145706. declare module BABYLON {
  145707. /**
  145708. * Block used to desaturate a color
  145709. */
  145710. export class DesaturateBlock extends NodeMaterialBlock {
  145711. /**
  145712. * Creates a new DesaturateBlock
  145713. * @param name defines the block name
  145714. */
  145715. constructor(name: string);
  145716. /**
  145717. * Gets the current class name
  145718. * @returns the class name
  145719. */
  145720. getClassName(): string;
  145721. /**
  145722. * Gets the color operand input component
  145723. */
  145724. get color(): NodeMaterialConnectionPoint;
  145725. /**
  145726. * Gets the level operand input component
  145727. */
  145728. get level(): NodeMaterialConnectionPoint;
  145729. /**
  145730. * Gets the output component
  145731. */
  145732. get output(): NodeMaterialConnectionPoint;
  145733. protected _buildBlock(state: NodeMaterialBuildState): this;
  145734. }
  145735. }
  145736. declare module BABYLON {
  145737. /**
  145738. * Block used to implement the ambient occlusion module of the PBR material
  145739. */
  145740. export class AmbientOcclusionBlock extends NodeMaterialBlock {
  145741. /**
  145742. * Create a new AmbientOcclusionBlock
  145743. * @param name defines the block name
  145744. */
  145745. constructor(name: string);
  145746. /**
  145747. * Specifies if the ambient texture contains the ambient occlusion information in its red channel only.
  145748. */
  145749. useAmbientInGrayScale: boolean;
  145750. /**
  145751. * Initialize the block and prepare the context for build
  145752. * @param state defines the state that will be used for the build
  145753. */
  145754. initialize(state: NodeMaterialBuildState): void;
  145755. /**
  145756. * Gets the current class name
  145757. * @returns the class name
  145758. */
  145759. getClassName(): string;
  145760. /**
  145761. * Gets the texture input component
  145762. */
  145763. get texture(): NodeMaterialConnectionPoint;
  145764. /**
  145765. * Gets the texture intensity component
  145766. */
  145767. get intensity(): NodeMaterialConnectionPoint;
  145768. /**
  145769. * Gets the direct light intensity input component
  145770. */
  145771. get directLightIntensity(): NodeMaterialConnectionPoint;
  145772. /**
  145773. * Gets the ambient occlusion object output component
  145774. */
  145775. get ambientOcc(): NodeMaterialConnectionPoint;
  145776. /**
  145777. * Gets the main code of the block (fragment side)
  145778. * @param block instance of an AmbientOcclusionBlock or null if the code must be generated without an active ambient occlusion module
  145779. * @returns the shader code
  145780. */
  145781. static GetCode(block: Nullable<AmbientOcclusionBlock>): string;
  145782. prepareDefines(mesh: AbstractMesh, nodeMaterial: NodeMaterial, defines: NodeMaterialDefines): void;
  145783. protected _buildBlock(state: NodeMaterialBuildState): this;
  145784. protected _dumpPropertiesCode(): string;
  145785. serialize(): any;
  145786. _deserialize(serializationObject: any, scene: Scene, rootUrl: string): void;
  145787. }
  145788. }
  145789. declare module BABYLON {
  145790. /**
  145791. * Block used to implement the reflection module of the PBR material
  145792. */
  145793. export class ReflectionBlock extends ReflectionTextureBaseBlock {
  145794. /** @hidden */
  145795. _defineLODReflectionAlpha: string;
  145796. /** @hidden */
  145797. _defineLinearSpecularReflection: string;
  145798. private _vEnvironmentIrradianceName;
  145799. /** @hidden */
  145800. _vReflectionMicrosurfaceInfosName: string;
  145801. /** @hidden */
  145802. _vReflectionInfosName: string;
  145803. /** @hidden */
  145804. _vReflectionFilteringInfoName: string;
  145805. private _scene;
  145806. /**
  145807. * The three properties below are set by the main PBR block prior to calling methods of this class.
  145808. * This is to avoid having to add them as inputs here whereas they are already inputs of the main block, so already known.
  145809. * It's less burden on the user side in the editor part.
  145810. */
  145811. /** @hidden */
  145812. worldPositionConnectionPoint: NodeMaterialConnectionPoint;
  145813. /** @hidden */
  145814. worldNormalConnectionPoint: NodeMaterialConnectionPoint;
  145815. /** @hidden */
  145816. cameraPositionConnectionPoint: NodeMaterialConnectionPoint;
  145817. /**
  145818. * Defines if the material uses spherical harmonics vs spherical polynomials for the
  145819. * diffuse part of the IBL.
  145820. */
  145821. useSphericalHarmonics: boolean;
  145822. /**
  145823. * Force the shader to compute irradiance in the fragment shader in order to take bump in account.
  145824. */
  145825. forceIrradianceInFragment: boolean;
  145826. /**
  145827. * Create a new ReflectionBlock
  145828. * @param name defines the block name
  145829. */
  145830. constructor(name: string);
  145831. /**
  145832. * Gets the current class name
  145833. * @returns the class name
  145834. */
  145835. getClassName(): string;
  145836. /**
  145837. * Gets the position input component
  145838. */
  145839. get position(): NodeMaterialConnectionPoint;
  145840. /**
  145841. * Gets the world position input component
  145842. */
  145843. get worldPosition(): NodeMaterialConnectionPoint;
  145844. /**
  145845. * Gets the world normal input component
  145846. */
  145847. get worldNormal(): NodeMaterialConnectionPoint;
  145848. /**
  145849. * Gets the world input component
  145850. */
  145851. get world(): NodeMaterialConnectionPoint;
  145852. /**
  145853. * Gets the camera (or eye) position component
  145854. */
  145855. get cameraPosition(): NodeMaterialConnectionPoint;
  145856. /**
  145857. * Gets the view input component
  145858. */
  145859. get view(): NodeMaterialConnectionPoint;
  145860. /**
  145861. * Gets the color input component
  145862. */
  145863. get color(): NodeMaterialConnectionPoint;
  145864. /**
  145865. * Gets the reflection object output component
  145866. */
  145867. get reflection(): NodeMaterialConnectionPoint;
  145868. /**
  145869. * Returns true if the block has a texture (either its own texture or the environment texture from the scene, if set)
  145870. */
  145871. get hasTexture(): boolean;
  145872. /**
  145873. * Gets the reflection color (either the name of the variable if the color input is connected, else a default value)
  145874. */
  145875. get reflectionColor(): string;
  145876. protected _getTexture(): Nullable<BaseTexture>;
  145877. prepareDefines(mesh: AbstractMesh, nodeMaterial: NodeMaterial, defines: NodeMaterialDefines): void;
  145878. bind(effect: Effect, nodeMaterial: NodeMaterial, mesh?: Mesh, subMesh?: SubMesh): void;
  145879. /**
  145880. * Gets the code to inject in the vertex shader
  145881. * @param state current state of the node material building
  145882. * @returns the shader code
  145883. */
  145884. handleVertexSide(state: NodeMaterialBuildState): string;
  145885. /**
  145886. * Gets the main code of the block (fragment side)
  145887. * @param state current state of the node material building
  145888. * @param normalVarName name of the existing variable corresponding to the normal
  145889. * @returns the shader code
  145890. */
  145891. getCode(state: NodeMaterialBuildState, normalVarName: string): string;
  145892. protected _buildBlock(state: NodeMaterialBuildState): this;
  145893. protected _dumpPropertiesCode(): string;
  145894. serialize(): any;
  145895. _deserialize(serializationObject: any, scene: Scene, rootUrl: string): void;
  145896. }
  145897. }
  145898. declare module BABYLON {
  145899. /**
  145900. * Block used to implement the sheen module of the PBR material
  145901. */
  145902. export class SheenBlock extends NodeMaterialBlock {
  145903. /**
  145904. * Create a new SheenBlock
  145905. * @param name defines the block name
  145906. */
  145907. constructor(name: string);
  145908. /**
  145909. * If true, the sheen effect is layered above the base BRDF with the albedo-scaling technique.
  145910. * It allows the strength of the sheen effect to not depend on the base color of the material,
  145911. * making it easier to setup and tweak the effect
  145912. */
  145913. albedoScaling: boolean;
  145914. /**
  145915. * Defines if the sheen is linked to the sheen color.
  145916. */
  145917. linkSheenWithAlbedo: boolean;
  145918. /**
  145919. * Initialize the block and prepare the context for build
  145920. * @param state defines the state that will be used for the build
  145921. */
  145922. initialize(state: NodeMaterialBuildState): void;
  145923. /**
  145924. * Gets the current class name
  145925. * @returns the class name
  145926. */
  145927. getClassName(): string;
  145928. /**
  145929. * Gets the intensity input component
  145930. */
  145931. get intensity(): NodeMaterialConnectionPoint;
  145932. /**
  145933. * Gets the color input component
  145934. */
  145935. get color(): NodeMaterialConnectionPoint;
  145936. /**
  145937. * Gets the roughness input component
  145938. */
  145939. get roughness(): NodeMaterialConnectionPoint;
  145940. /**
  145941. * Gets the sheen object output component
  145942. */
  145943. get sheen(): NodeMaterialConnectionPoint;
  145944. prepareDefines(mesh: AbstractMesh, nodeMaterial: NodeMaterial, defines: NodeMaterialDefines): void;
  145945. /**
  145946. * Gets the main code of the block (fragment side)
  145947. * @param reflectionBlock instance of a ReflectionBlock null if the code must be generated without an active reflection module
  145948. * @returns the shader code
  145949. */
  145950. getCode(reflectionBlock: Nullable<ReflectionBlock>): string;
  145951. protected _buildBlock(state: NodeMaterialBuildState): this;
  145952. protected _dumpPropertiesCode(): string;
  145953. serialize(): any;
  145954. _deserialize(serializationObject: any, scene: Scene, rootUrl: string): void;
  145955. }
  145956. }
  145957. declare module BABYLON {
  145958. /**
  145959. * Block used to implement the reflectivity module of the PBR material
  145960. */
  145961. export class ReflectivityBlock extends NodeMaterialBlock {
  145962. private _metallicReflectanceColor;
  145963. private _metallicF0Factor;
  145964. /** @hidden */
  145965. _vMetallicReflectanceFactorsName: string;
  145966. /**
  145967. * The property below is set by the main PBR block prior to calling methods of this class.
  145968. */
  145969. /** @hidden */
  145970. indexOfRefractionConnectionPoint: Nullable<NodeMaterialConnectionPoint>;
  145971. /**
  145972. * Specifies if the metallic texture contains the ambient occlusion information in its red channel.
  145973. */
  145974. useAmbientOcclusionFromMetallicTextureRed: boolean;
  145975. /**
  145976. * Specifies if the metallic texture contains the metallness information in its blue channel.
  145977. */
  145978. useMetallnessFromMetallicTextureBlue: boolean;
  145979. /**
  145980. * Specifies if the metallic texture contains the roughness information in its alpha channel.
  145981. */
  145982. useRoughnessFromMetallicTextureAlpha: boolean;
  145983. /**
  145984. * Specifies if the metallic texture contains the roughness information in its green channel.
  145985. */
  145986. useRoughnessFromMetallicTextureGreen: boolean;
  145987. /**
  145988. * Create a new ReflectivityBlock
  145989. * @param name defines the block name
  145990. */
  145991. constructor(name: string);
  145992. /**
  145993. * Initialize the block and prepare the context for build
  145994. * @param state defines the state that will be used for the build
  145995. */
  145996. initialize(state: NodeMaterialBuildState): void;
  145997. /**
  145998. * Gets the current class name
  145999. * @returns the class name
  146000. */
  146001. getClassName(): string;
  146002. /**
  146003. * Gets the metallic input component
  146004. */
  146005. get metallic(): NodeMaterialConnectionPoint;
  146006. /**
  146007. * Gets the roughness input component
  146008. */
  146009. get roughness(): NodeMaterialConnectionPoint;
  146010. /**
  146011. * Gets the texture input component
  146012. */
  146013. get texture(): NodeMaterialConnectionPoint;
  146014. /**
  146015. * Gets the reflectivity object output component
  146016. */
  146017. get reflectivity(): NodeMaterialConnectionPoint;
  146018. bind(effect: Effect, nodeMaterial: NodeMaterial, mesh?: Mesh, subMesh?: SubMesh): void;
  146019. /**
  146020. * Gets the main code of the block (fragment side)
  146021. * @param state current state of the node material building
  146022. * @param aoIntensityVarName name of the variable with the ambient occlusion intensity
  146023. * @returns the shader code
  146024. */
  146025. getCode(state: NodeMaterialBuildState, aoIntensityVarName: string): string;
  146026. prepareDefines(mesh: AbstractMesh, nodeMaterial: NodeMaterial, defines: NodeMaterialDefines): void;
  146027. protected _buildBlock(state: NodeMaterialBuildState): this;
  146028. protected _dumpPropertiesCode(): string;
  146029. serialize(): any;
  146030. _deserialize(serializationObject: any, scene: Scene, rootUrl: string): void;
  146031. }
  146032. }
  146033. declare module BABYLON {
  146034. /**
  146035. * Block used to implement the anisotropy module of the PBR material
  146036. */
  146037. export class AnisotropyBlock extends NodeMaterialBlock {
  146038. /**
  146039. * The two properties below are set by the main PBR block prior to calling methods of this class.
  146040. * This is to avoid having to add them as inputs here whereas they are already inputs of the main block, so already known.
  146041. * It's less burden on the user side in the editor part.
  146042. */
  146043. /** @hidden */
  146044. worldPositionConnectionPoint: NodeMaterialConnectionPoint;
  146045. /** @hidden */
  146046. worldNormalConnectionPoint: NodeMaterialConnectionPoint;
  146047. /**
  146048. * Create a new AnisotropyBlock
  146049. * @param name defines the block name
  146050. */
  146051. constructor(name: string);
  146052. /**
  146053. * Initialize the block and prepare the context for build
  146054. * @param state defines the state that will be used for the build
  146055. */
  146056. initialize(state: NodeMaterialBuildState): void;
  146057. /**
  146058. * Gets the current class name
  146059. * @returns the class name
  146060. */
  146061. getClassName(): string;
  146062. /**
  146063. * Gets the intensity input component
  146064. */
  146065. get intensity(): NodeMaterialConnectionPoint;
  146066. /**
  146067. * Gets the direction input component
  146068. */
  146069. get direction(): NodeMaterialConnectionPoint;
  146070. /**
  146071. * Gets the texture input component
  146072. */
  146073. get texture(): NodeMaterialConnectionPoint;
  146074. /**
  146075. * Gets the uv input component
  146076. */
  146077. get uv(): NodeMaterialConnectionPoint;
  146078. /**
  146079. * Gets the worldTangent input component
  146080. */
  146081. get worldTangent(): NodeMaterialConnectionPoint;
  146082. /**
  146083. * Gets the anisotropy object output component
  146084. */
  146085. get anisotropy(): NodeMaterialConnectionPoint;
  146086. private _generateTBNSpace;
  146087. /**
  146088. * Gets the main code of the block (fragment side)
  146089. * @param state current state of the node material building
  146090. * @param generateTBNSpace if true, the code needed to create the TBN coordinate space is generated
  146091. * @returns the shader code
  146092. */
  146093. getCode(state: NodeMaterialBuildState, generateTBNSpace?: boolean): string;
  146094. prepareDefines(mesh: AbstractMesh, nodeMaterial: NodeMaterial, defines: NodeMaterialDefines): void;
  146095. protected _buildBlock(state: NodeMaterialBuildState): this;
  146096. }
  146097. }
  146098. declare module BABYLON {
  146099. /**
  146100. * Block used to implement the clear coat module of the PBR material
  146101. */
  146102. export class ClearCoatBlock extends NodeMaterialBlock {
  146103. private _scene;
  146104. /**
  146105. * Create a new ClearCoatBlock
  146106. * @param name defines the block name
  146107. */
  146108. constructor(name: string);
  146109. /**
  146110. * Initialize the block and prepare the context for build
  146111. * @param state defines the state that will be used for the build
  146112. */
  146113. initialize(state: NodeMaterialBuildState): void;
  146114. /**
  146115. * Gets the current class name
  146116. * @returns the class name
  146117. */
  146118. getClassName(): string;
  146119. /**
  146120. * Gets the intensity input component
  146121. */
  146122. get intensity(): NodeMaterialConnectionPoint;
  146123. /**
  146124. * Gets the roughness input component
  146125. */
  146126. get roughness(): NodeMaterialConnectionPoint;
  146127. /**
  146128. * Gets the ior input component
  146129. */
  146130. get ior(): NodeMaterialConnectionPoint;
  146131. /**
  146132. * Gets the texture input component
  146133. */
  146134. get texture(): NodeMaterialConnectionPoint;
  146135. /**
  146136. * Gets the bump texture input component
  146137. */
  146138. get bumpTexture(): NodeMaterialConnectionPoint;
  146139. /**
  146140. * Gets the uv input component
  146141. */
  146142. get uv(): NodeMaterialConnectionPoint;
  146143. /**
  146144. * Gets the tint color input component
  146145. */
  146146. get tintColor(): NodeMaterialConnectionPoint;
  146147. /**
  146148. * Gets the tint "at distance" input component
  146149. */
  146150. get tintAtDistance(): NodeMaterialConnectionPoint;
  146151. /**
  146152. * Gets the tint thickness input component
  146153. */
  146154. get tintThickness(): NodeMaterialConnectionPoint;
  146155. /**
  146156. * Gets the world tangent input component
  146157. */
  146158. get worldTangent(): NodeMaterialConnectionPoint;
  146159. /**
  146160. * Gets the clear coat object output component
  146161. */
  146162. get clearcoat(): NodeMaterialConnectionPoint;
  146163. autoConfigure(material: NodeMaterial): void;
  146164. prepareDefines(mesh: AbstractMesh, nodeMaterial: NodeMaterial, defines: NodeMaterialDefines): void;
  146165. bind(effect: Effect, nodeMaterial: NodeMaterial, mesh?: Mesh, subMesh?: SubMesh): void;
  146166. private _generateTBNSpace;
  146167. /**
  146168. * Gets the main code of the block (fragment side)
  146169. * @param state current state of the node material building
  146170. * @param ccBlock instance of a ClearCoatBlock or null if the code must be generated without an active clear coat module
  146171. * @param reflectionBlock instance of a ReflectionBlock null if the code must be generated without an active reflection module
  146172. * @param worldPosVarName name of the variable holding the world position
  146173. * @param generateTBNSpace if true, the code needed to create the TBN coordinate space is generated
  146174. * @param vTBNAvailable indicate that the vTBN variable is already existing because it has already been generated by another block (PerturbNormal or Anisotropy)
  146175. * @param worldNormalVarName name of the variable holding the world normal
  146176. * @returns the shader code
  146177. */
  146178. static GetCode(state: NodeMaterialBuildState, ccBlock: Nullable<ClearCoatBlock>, reflectionBlock: Nullable<ReflectionBlock>, worldPosVarName: string, generateTBNSpace: boolean, vTBNAvailable: boolean, worldNormalVarName: string): string;
  146179. protected _buildBlock(state: NodeMaterialBuildState): this;
  146180. }
  146181. }
  146182. declare module BABYLON {
  146183. /**
  146184. * Block used to implement the sub surface module of the PBR material
  146185. */
  146186. export class SubSurfaceBlock extends NodeMaterialBlock {
  146187. /**
  146188. * Create a new SubSurfaceBlock
  146189. * @param name defines the block name
  146190. */
  146191. constructor(name: string);
  146192. /**
  146193. * Stores the intensity of the different subsurface effects in the thickness texture.
  146194. * * the green channel is the translucency intensity.
  146195. * * the blue channel is the scattering intensity.
  146196. * * the alpha channel is the refraction intensity.
  146197. */
  146198. useMaskFromThicknessTexture: boolean;
  146199. /**
  146200. * Initialize the block and prepare the context for build
  146201. * @param state defines the state that will be used for the build
  146202. */
  146203. initialize(state: NodeMaterialBuildState): void;
  146204. /**
  146205. * Gets the current class name
  146206. * @returns the class name
  146207. */
  146208. getClassName(): string;
  146209. /**
  146210. * Gets the min thickness input component
  146211. */
  146212. get minThickness(): NodeMaterialConnectionPoint;
  146213. /**
  146214. * Gets the max thickness input component
  146215. */
  146216. get maxThickness(): NodeMaterialConnectionPoint;
  146217. /**
  146218. * Gets the thickness texture component
  146219. */
  146220. get thicknessTexture(): NodeMaterialConnectionPoint;
  146221. /**
  146222. * Gets the tint color input component
  146223. */
  146224. get tintColor(): NodeMaterialConnectionPoint;
  146225. /**
  146226. * Gets the translucency intensity input component
  146227. */
  146228. get translucencyIntensity(): NodeMaterialConnectionPoint;
  146229. /**
  146230. * Gets the translucency diffusion distance input component
  146231. */
  146232. get translucencyDiffusionDistance(): NodeMaterialConnectionPoint;
  146233. /**
  146234. * Gets the refraction object parameters
  146235. */
  146236. get refraction(): NodeMaterialConnectionPoint;
  146237. /**
  146238. * Gets the sub surface object output component
  146239. */
  146240. get subsurface(): NodeMaterialConnectionPoint;
  146241. autoConfigure(material: NodeMaterial): void;
  146242. prepareDefines(mesh: AbstractMesh, nodeMaterial: NodeMaterial, defines: NodeMaterialDefines): void;
  146243. /**
  146244. * Gets the main code of the block (fragment side)
  146245. * @param state current state of the node material building
  146246. * @param ssBlock instance of a SubSurfaceBlock or null if the code must be generated without an active sub surface module
  146247. * @param reflectionBlock instance of a ReflectionBlock null if the code must be generated without an active reflection module
  146248. * @param worldPosVarName name of the variable holding the world position
  146249. * @returns the shader code
  146250. */
  146251. static GetCode(state: NodeMaterialBuildState, ssBlock: Nullable<SubSurfaceBlock>, reflectionBlock: Nullable<ReflectionBlock>, worldPosVarName: string): string;
  146252. protected _buildBlock(state: NodeMaterialBuildState): this;
  146253. }
  146254. }
  146255. declare module BABYLON {
  146256. /**
  146257. * Block used to implement the PBR metallic/roughness model
  146258. */
  146259. export class PBRMetallicRoughnessBlock extends NodeMaterialBlock {
  146260. /**
  146261. * Gets or sets the light associated with this block
  146262. */
  146263. light: Nullable<Light>;
  146264. private _lightId;
  146265. private _scene;
  146266. private _environmentBRDFTexture;
  146267. private _environmentBrdfSamplerName;
  146268. private _vNormalWName;
  146269. private _invertNormalName;
  146270. /**
  146271. * Create a new ReflectionBlock
  146272. * @param name defines the block name
  146273. */
  146274. constructor(name: string);
  146275. /**
  146276. * Intensity of the direct lights e.g. the four lights available in your scene.
  146277. * This impacts both the direct diffuse and specular highlights.
  146278. */
  146279. directIntensity: number;
  146280. /**
  146281. * Intensity of the environment e.g. how much the environment will light the object
  146282. * either through harmonics for rough material or through the refelction for shiny ones.
  146283. */
  146284. environmentIntensity: number;
  146285. /**
  146286. * This is a special control allowing the reduction of the specular highlights coming from the
  146287. * four lights of the scene. Those highlights may not be needed in full environment lighting.
  146288. */
  146289. specularIntensity: number;
  146290. /**
  146291. * Defines the falloff type used in this material.
  146292. * It by default is Physical.
  146293. */
  146294. lightFalloff: number;
  146295. /**
  146296. * Specifies that the alpha is coming form the albedo channel alpha channel for alpha blending.
  146297. */
  146298. useAlphaFromAlbedoTexture: boolean;
  146299. /**
  146300. * Specifies that alpha test should be used
  146301. */
  146302. useAlphaTest: boolean;
  146303. /**
  146304. * Defines the alpha limits in alpha test mode.
  146305. */
  146306. alphaTestCutoff: number;
  146307. /**
  146308. * Specifies that alpha blending should be used
  146309. */
  146310. useAlphaBlending: boolean;
  146311. /**
  146312. * Defines if the alpha value should be determined via the rgb values.
  146313. * If true the luminance of the pixel might be used to find the corresponding alpha value.
  146314. */
  146315. opacityRGB: boolean;
  146316. /**
  146317. * Specifies that the material will keeps the reflection highlights over a transparent surface (only the most luminous ones).
  146318. * A car glass is a good exemple of that. When the street lights reflects on it you can not see what is behind.
  146319. */
  146320. useRadianceOverAlpha: boolean;
  146321. /**
  146322. * Specifies that the material will keeps the specular highlights over a transparent surface (only the most luminous ones).
  146323. * A car glass is a good exemple of that. When sun reflects on it you can not see what is behind.
  146324. */
  146325. useSpecularOverAlpha: boolean;
  146326. /**
  146327. * Enables specular anti aliasing in the PBR shader.
  146328. * It will both interacts on the Geometry for analytical and IBL lighting.
  146329. * It also prefilter the roughness map based on the bump values.
  146330. */
  146331. enableSpecularAntiAliasing: boolean;
  146332. /**
  146333. * Enables realtime filtering on the texture.
  146334. */
  146335. realTimeFiltering: boolean;
  146336. /**
  146337. * Quality switch for realtime filtering
  146338. */
  146339. realTimeFilteringQuality: number;
  146340. /**
  146341. * Defines if the material uses energy conservation.
  146342. */
  146343. useEnergyConservation: boolean;
  146344. /**
  146345. * This parameters will enable/disable radiance occlusion by preventing the radiance to lit
  146346. * too much the area relying on ambient texture to define their ambient occlusion.
  146347. */
  146348. useRadianceOcclusion: boolean;
  146349. /**
  146350. * This parameters will enable/disable Horizon occlusion to prevent normal maps to look shiny when the normal
  146351. * makes the reflect vector face the model (under horizon).
  146352. */
  146353. useHorizonOcclusion: boolean;
  146354. /**
  146355. * If set to true, no lighting calculations will be applied.
  146356. */
  146357. unlit: boolean;
  146358. /**
  146359. * Force normal to face away from face.
  146360. */
  146361. forceNormalForward: boolean;
  146362. /**
  146363. * Defines the material debug mode.
  146364. * It helps seeing only some components of the material while troubleshooting.
  146365. */
  146366. debugMode: number;
  146367. /**
  146368. * Specify from where on screen the debug mode should start.
  146369. * The value goes from -1 (full screen) to 1 (not visible)
  146370. * It helps with side by side comparison against the final render
  146371. * This defaults to 0
  146372. */
  146373. debugLimit: number;
  146374. /**
  146375. * As the default viewing range might not be enough (if the ambient is really small for instance)
  146376. * You can use the factor to better multiply the final value.
  146377. */
  146378. debugFactor: number;
  146379. /**
  146380. * Initialize the block and prepare the context for build
  146381. * @param state defines the state that will be used for the build
  146382. */
  146383. initialize(state: NodeMaterialBuildState): void;
  146384. /**
  146385. * Gets the current class name
  146386. * @returns the class name
  146387. */
  146388. getClassName(): string;
  146389. /**
  146390. * Gets the world position input component
  146391. */
  146392. get worldPosition(): NodeMaterialConnectionPoint;
  146393. /**
  146394. * Gets the world normal input component
  146395. */
  146396. get worldNormal(): NodeMaterialConnectionPoint;
  146397. /**
  146398. * Gets the perturbed normal input component
  146399. */
  146400. get perturbedNormal(): NodeMaterialConnectionPoint;
  146401. /**
  146402. * Gets the camera position input component
  146403. */
  146404. get cameraPosition(): NodeMaterialConnectionPoint;
  146405. /**
  146406. * Gets the base color input component
  146407. */
  146408. get baseColor(): NodeMaterialConnectionPoint;
  146409. /**
  146410. * Gets the opacity texture input component
  146411. */
  146412. get opacityTexture(): NodeMaterialConnectionPoint;
  146413. /**
  146414. * Gets the ambient color input component
  146415. */
  146416. get ambientColor(): NodeMaterialConnectionPoint;
  146417. /**
  146418. * Gets the reflectivity object parameters
  146419. */
  146420. get reflectivity(): NodeMaterialConnectionPoint;
  146421. /**
  146422. * Gets the ambient occlusion object parameters
  146423. */
  146424. get ambientOcc(): NodeMaterialConnectionPoint;
  146425. /**
  146426. * Gets the reflection object parameters
  146427. */
  146428. get reflection(): NodeMaterialConnectionPoint;
  146429. /**
  146430. * Gets the sheen object parameters
  146431. */
  146432. get sheen(): NodeMaterialConnectionPoint;
  146433. /**
  146434. * Gets the clear coat object parameters
  146435. */
  146436. get clearcoat(): NodeMaterialConnectionPoint;
  146437. /**
  146438. * Gets the sub surface object parameters
  146439. */
  146440. get subsurface(): NodeMaterialConnectionPoint;
  146441. /**
  146442. * Gets the anisotropy object parameters
  146443. */
  146444. get anisotropy(): NodeMaterialConnectionPoint;
  146445. /**
  146446. * Gets the ambient output component
  146447. */
  146448. get ambient(): NodeMaterialConnectionPoint;
  146449. /**
  146450. * Gets the diffuse output component
  146451. */
  146452. get diffuse(): NodeMaterialConnectionPoint;
  146453. /**
  146454. * Gets the specular output component
  146455. */
  146456. get specular(): NodeMaterialConnectionPoint;
  146457. /**
  146458. * Gets the sheen output component
  146459. */
  146460. get sheenDir(): NodeMaterialConnectionPoint;
  146461. /**
  146462. * Gets the clear coat output component
  146463. */
  146464. get clearcoatDir(): NodeMaterialConnectionPoint;
  146465. /**
  146466. * Gets the indirect diffuse output component
  146467. */
  146468. get diffuseIndirect(): NodeMaterialConnectionPoint;
  146469. /**
  146470. * Gets the indirect specular output component
  146471. */
  146472. get specularIndirect(): NodeMaterialConnectionPoint;
  146473. /**
  146474. * Gets the indirect sheen output component
  146475. */
  146476. get sheenIndirect(): NodeMaterialConnectionPoint;
  146477. /**
  146478. * Gets the indirect clear coat output component
  146479. */
  146480. get clearcoatIndirect(): NodeMaterialConnectionPoint;
  146481. /**
  146482. * Gets the refraction output component
  146483. */
  146484. get refraction(): NodeMaterialConnectionPoint;
  146485. /**
  146486. * Gets the global lighting output component
  146487. */
  146488. get lighting(): NodeMaterialConnectionPoint;
  146489. /**
  146490. * Gets the shadow output component
  146491. */
  146492. get shadow(): NodeMaterialConnectionPoint;
  146493. /**
  146494. * Gets the alpha output component
  146495. */
  146496. get alpha(): NodeMaterialConnectionPoint;
  146497. autoConfigure(material: NodeMaterial): void;
  146498. prepareDefines(mesh: AbstractMesh, nodeMaterial: NodeMaterial, defines: NodeMaterialDefines): void;
  146499. updateUniformsAndSamples(state: NodeMaterialBuildState, nodeMaterial: NodeMaterial, defines: NodeMaterialDefines, uniformBuffers: string[]): void;
  146500. bind(effect: Effect, nodeMaterial: NodeMaterial, mesh?: Mesh): void;
  146501. private _injectVertexCode;
  146502. /**
  146503. * Gets the code corresponding to the albedo/opacity module
  146504. * @returns the shader code
  146505. */
  146506. getAlbedoOpacityCode(): string;
  146507. protected _buildBlock(state: NodeMaterialBuildState): this;
  146508. protected _dumpPropertiesCode(): string;
  146509. serialize(): any;
  146510. _deserialize(serializationObject: any, scene: Scene, rootUrl: string): void;
  146511. }
  146512. }
  146513. declare module BABYLON {
  146514. /**
  146515. * Block used to compute value of one parameter modulo another
  146516. */
  146517. export class ModBlock extends NodeMaterialBlock {
  146518. /**
  146519. * Creates a new ModBlock
  146520. * @param name defines the block name
  146521. */
  146522. constructor(name: string);
  146523. /**
  146524. * Gets the current class name
  146525. * @returns the class name
  146526. */
  146527. getClassName(): string;
  146528. /**
  146529. * Gets the left operand input component
  146530. */
  146531. get left(): NodeMaterialConnectionPoint;
  146532. /**
  146533. * Gets the right operand input component
  146534. */
  146535. get right(): NodeMaterialConnectionPoint;
  146536. /**
  146537. * Gets the output component
  146538. */
  146539. get output(): NodeMaterialConnectionPoint;
  146540. protected _buildBlock(state: NodeMaterialBuildState): this;
  146541. }
  146542. }
  146543. declare module BABYLON {
  146544. /**
  146545. * Configuration for Draco compression
  146546. */
  146547. export interface IDracoCompressionConfiguration {
  146548. /**
  146549. * Configuration for the decoder.
  146550. */
  146551. decoder: {
  146552. /**
  146553. * The url to the WebAssembly module.
  146554. */
  146555. wasmUrl?: string;
  146556. /**
  146557. * The url to the WebAssembly binary.
  146558. */
  146559. wasmBinaryUrl?: string;
  146560. /**
  146561. * The url to the fallback JavaScript module.
  146562. */
  146563. fallbackUrl?: string;
  146564. };
  146565. }
  146566. /**
  146567. * Draco compression (https://google.github.io/draco/)
  146568. *
  146569. * This class wraps the Draco module.
  146570. *
  146571. * **Encoder**
  146572. *
  146573. * The encoder is not currently implemented.
  146574. *
  146575. * **Decoder**
  146576. *
  146577. * 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.
  146578. *
  146579. * To update the configuration, use the following code:
  146580. * ```javascript
  146581. * DracoCompression.Configuration = {
  146582. * decoder: {
  146583. * wasmUrl: "<url to the WebAssembly library>",
  146584. * wasmBinaryUrl: "<url to the WebAssembly binary>",
  146585. * fallbackUrl: "<url to the fallback JavaScript library>",
  146586. * }
  146587. * };
  146588. * ```
  146589. *
  146590. * 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.
  146591. * Decoding will automatically fallback to the JavaScript version if WebAssembly version is not configured or if WebAssembly is not supported by the browser.
  146592. * Use `DracoCompression.DecoderAvailable` to determine if the decoder configuration is available for the current context.
  146593. *
  146594. * To decode Draco compressed data, get the default DracoCompression object and call decodeMeshAsync:
  146595. * ```javascript
  146596. * var vertexData = await DracoCompression.Default.decodeMeshAsync(data);
  146597. * ```
  146598. *
  146599. * @see https://www.babylonjs-playground.com/#N3EK4B#0
  146600. */
  146601. export class DracoCompression implements IDisposable {
  146602. private _workerPoolPromise?;
  146603. private _decoderModulePromise?;
  146604. /**
  146605. * The configuration. Defaults to the following urls:
  146606. * - wasmUrl: "https://preview.babylonjs.com/draco_wasm_wrapper_gltf.js"
  146607. * - wasmBinaryUrl: "https://preview.babylonjs.com/draco_decoder_gltf.wasm"
  146608. * - fallbackUrl: "https://preview.babylonjs.com/draco_decoder_gltf.js"
  146609. */
  146610. static Configuration: IDracoCompressionConfiguration;
  146611. /**
  146612. * Returns true if the decoder configuration is available.
  146613. */
  146614. static get DecoderAvailable(): boolean;
  146615. /**
  146616. * Default number of workers to create when creating the draco compression object.
  146617. */
  146618. static DefaultNumWorkers: number;
  146619. private static GetDefaultNumWorkers;
  146620. private static _Default;
  146621. /**
  146622. * Default instance for the draco compression object.
  146623. */
  146624. static get Default(): DracoCompression;
  146625. /**
  146626. * Constructor
  146627. * @param numWorkers The number of workers for async operations. Specify `0` to disable web workers and run synchronously in the current context.
  146628. */
  146629. constructor(numWorkers?: number);
  146630. /**
  146631. * Stop all async operations and release resources.
  146632. */
  146633. dispose(): void;
  146634. /**
  146635. * Returns a promise that resolves when ready. Call this manually to ensure draco compression is ready before use.
  146636. * @returns a promise that resolves when ready
  146637. */
  146638. whenReadyAsync(): Promise<void>;
  146639. /**
  146640. * Decode Draco compressed mesh data to vertex data.
  146641. * @param data The ArrayBuffer or ArrayBufferView for the Draco compression data
  146642. * @param attributes A map of attributes from vertex buffer kinds to Draco unique ids
  146643. * @returns A promise that resolves with the decoded vertex data
  146644. */
  146645. decodeMeshAsync(data: ArrayBuffer | ArrayBufferView, attributes?: {
  146646. [kind: string]: number;
  146647. }): Promise<VertexData>;
  146648. }
  146649. }
  146650. declare module BABYLON {
  146651. /**
  146652. * Class for building Constructive Solid Geometry
  146653. */
  146654. export class CSG {
  146655. private polygons;
  146656. /**
  146657. * The world matrix
  146658. */
  146659. matrix: Matrix;
  146660. /**
  146661. * Stores the position
  146662. */
  146663. position: Vector3;
  146664. /**
  146665. * Stores the rotation
  146666. */
  146667. rotation: Vector3;
  146668. /**
  146669. * Stores the rotation quaternion
  146670. */
  146671. rotationQuaternion: Nullable<Quaternion>;
  146672. /**
  146673. * Stores the scaling vector
  146674. */
  146675. scaling: Vector3;
  146676. /**
  146677. * Convert the Mesh to CSG
  146678. * @param mesh The Mesh to convert to CSG
  146679. * @returns A new CSG from the Mesh
  146680. */
  146681. static FromMesh(mesh: Mesh): CSG;
  146682. /**
  146683. * Construct a CSG solid from a list of `CSG.Polygon` instances.
  146684. * @param polygons Polygons used to construct a CSG solid
  146685. */
  146686. private static FromPolygons;
  146687. /**
  146688. * Clones, or makes a deep copy, of the CSG
  146689. * @returns A new CSG
  146690. */
  146691. clone(): CSG;
  146692. /**
  146693. * Unions this CSG with another CSG
  146694. * @param csg The CSG to union against this CSG
  146695. * @returns The unioned CSG
  146696. */
  146697. union(csg: CSG): CSG;
  146698. /**
  146699. * Unions this CSG with another CSG in place
  146700. * @param csg The CSG to union against this CSG
  146701. */
  146702. unionInPlace(csg: CSG): void;
  146703. /**
  146704. * Subtracts this CSG with another CSG
  146705. * @param csg The CSG to subtract against this CSG
  146706. * @returns A new CSG
  146707. */
  146708. subtract(csg: CSG): CSG;
  146709. /**
  146710. * Subtracts this CSG with another CSG in place
  146711. * @param csg The CSG to subtact against this CSG
  146712. */
  146713. subtractInPlace(csg: CSG): void;
  146714. /**
  146715. * Intersect this CSG with another CSG
  146716. * @param csg The CSG to intersect against this CSG
  146717. * @returns A new CSG
  146718. */
  146719. intersect(csg: CSG): CSG;
  146720. /**
  146721. * Intersects this CSG with another CSG in place
  146722. * @param csg The CSG to intersect against this CSG
  146723. */
  146724. intersectInPlace(csg: CSG): void;
  146725. /**
  146726. * Return a new CSG solid with solid and empty space switched. This solid is
  146727. * not modified.
  146728. * @returns A new CSG solid with solid and empty space switched
  146729. */
  146730. inverse(): CSG;
  146731. /**
  146732. * Inverses the CSG in place
  146733. */
  146734. inverseInPlace(): void;
  146735. /**
  146736. * This is used to keep meshes transformations so they can be restored
  146737. * when we build back a Babylon Mesh
  146738. * NB : All CSG operations are performed in world coordinates
  146739. * @param csg The CSG to copy the transform attributes from
  146740. * @returns This CSG
  146741. */
  146742. copyTransformAttributes(csg: CSG): CSG;
  146743. /**
  146744. * Build Raw mesh from CSG
  146745. * Coordinates here are in world space
  146746. * @param name The name of the mesh geometry
  146747. * @param scene The Scene
  146748. * @param keepSubMeshes Specifies if the submeshes should be kept
  146749. * @returns A new Mesh
  146750. */
  146751. buildMeshGeometry(name: string, scene?: Scene, keepSubMeshes?: boolean): Mesh;
  146752. /**
  146753. * Build Mesh from CSG taking material and transforms into account
  146754. * @param name The name of the Mesh
  146755. * @param material The material of the Mesh
  146756. * @param scene The Scene
  146757. * @param keepSubMeshes Specifies if submeshes should be kept
  146758. * @returns The new Mesh
  146759. */
  146760. toMesh(name: string, material?: Nullable<Material>, scene?: Scene, keepSubMeshes?: boolean): Mesh;
  146761. }
  146762. }
  146763. declare module BABYLON {
  146764. /**
  146765. * Class used to create a trail following a mesh
  146766. */
  146767. export class TrailMesh extends Mesh {
  146768. private _generator;
  146769. private _autoStart;
  146770. private _running;
  146771. private _diameter;
  146772. private _length;
  146773. private _sectionPolygonPointsCount;
  146774. private _sectionVectors;
  146775. private _sectionNormalVectors;
  146776. private _beforeRenderObserver;
  146777. /**
  146778. * @constructor
  146779. * @param name The value used by scene.getMeshByName() to do a lookup.
  146780. * @param generator The mesh or transform node to generate a trail.
  146781. * @param scene The scene to add this mesh to.
  146782. * @param diameter Diameter of trailing mesh. Default is 1.
  146783. * @param length Length of trailing mesh. Default is 60.
  146784. * @param autoStart Automatically start trailing mesh. Default true.
  146785. */
  146786. constructor(name: string, generator: TransformNode, scene: Scene, diameter?: number, length?: number, autoStart?: boolean);
  146787. /**
  146788. * "TrailMesh"
  146789. * @returns "TrailMesh"
  146790. */
  146791. getClassName(): string;
  146792. private _createMesh;
  146793. /**
  146794. * Start trailing mesh.
  146795. */
  146796. start(): void;
  146797. /**
  146798. * Stop trailing mesh.
  146799. */
  146800. stop(): void;
  146801. /**
  146802. * Update trailing mesh geometry.
  146803. */
  146804. update(): void;
  146805. /**
  146806. * Returns a new TrailMesh object.
  146807. * @param name is a string, the name given to the new mesh
  146808. * @param newGenerator use new generator object for cloned trail mesh
  146809. * @returns a new mesh
  146810. */
  146811. clone(name: string | undefined, newGenerator: TransformNode): TrailMesh;
  146812. /**
  146813. * Serializes this trail mesh
  146814. * @param serializationObject object to write serialization to
  146815. */
  146816. serialize(serializationObject: any): void;
  146817. /**
  146818. * Parses a serialized trail mesh
  146819. * @param parsedMesh the serialized mesh
  146820. * @param scene the scene to create the trail mesh in
  146821. * @returns the created trail mesh
  146822. */
  146823. static Parse(parsedMesh: any, scene: Scene): TrailMesh;
  146824. }
  146825. }
  146826. declare module BABYLON {
  146827. /**
  146828. * Class containing static functions to help procedurally build meshes
  146829. */
  146830. export class TiledBoxBuilder {
  146831. /**
  146832. * Creates a box mesh
  146833. * 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)
  146834. * * Please read this tutorial : https://doc.babylonjs.com/how_to/createbox_per_face_textures_and_colors
  146835. * * You can also set the mesh side orientation with the values : BABYLON.Mesh.FRONTSIDE (default), BABYLON.Mesh.BACKSIDE or BABYLON.Mesh.DOUBLESIDE
  146836. * * If you create a double-sided mesh, you can choose what parts of the texture image to crop and stick respectively on the front and the back sides with the parameters `frontUVs` and `backUVs` (Vector4). Detail here : https://doc.babylonjs.com/babylon101/discover_basic_elements#side-orientation
  146837. * * The mesh can be set to updatable with the boolean parameter `updatable` (default false) if its internal geometry is supposed to change once created
  146838. * @param name defines the name of the mesh
  146839. * @param options defines the options used to create the mesh
  146840. * @param scene defines the hosting scene
  146841. * @returns the box mesh
  146842. */
  146843. static CreateTiledBox(name: string, options: {
  146844. pattern?: number;
  146845. width?: number;
  146846. height?: number;
  146847. depth?: number;
  146848. tileSize?: number;
  146849. tileWidth?: number;
  146850. tileHeight?: number;
  146851. alignHorizontal?: number;
  146852. alignVertical?: number;
  146853. faceUV?: Vector4[];
  146854. faceColors?: Color4[];
  146855. sideOrientation?: number;
  146856. updatable?: boolean;
  146857. }, scene?: Nullable<Scene>): Mesh;
  146858. }
  146859. }
  146860. declare module BABYLON {
  146861. /**
  146862. * Class containing static functions to help procedurally build meshes
  146863. */
  146864. export class TorusKnotBuilder {
  146865. /**
  146866. * Creates a torus knot mesh
  146867. * * The parameter `radius` sets the global radius size (float) of the torus knot (default 2)
  146868. * * The parameter `radialSegments` sets the number of sides on each tube segments (positive integer, default 32)
  146869. * * The parameter `tubularSegments` sets the number of tubes to decompose the knot into (positive integer, default 32)
  146870. * * The parameters `p` and `q` are the number of windings on each axis (positive integers, default 2 and 3)
  146871. * * You can also set the mesh side orientation with the values : BABYLON.Mesh.FRONTSIDE (default), BABYLON.Mesh.BACKSIDE or BABYLON.Mesh.DOUBLESIDE
  146872. * * If you create a double-sided mesh, you can choose what parts of the texture image to crop and stick respectively on the front and the back sides with the parameters `frontUVs` and `backUVs` (Vector4). Detail here : https://doc.babylonjs.com/babylon101/discover_basic_elements#side-orientation
  146873. * * The mesh can be set to updatable with the boolean parameter `updatable` (default false) if its internal geometry is supposed to change once created.
  146874. * @param name defines the name of the mesh
  146875. * @param options defines the options used to create the mesh
  146876. * @param scene defines the hosting scene
  146877. * @returns the torus knot mesh
  146878. * @see https://doc.babylonjs.com/how_to/set_shapes#torus-knot
  146879. */
  146880. static CreateTorusKnot(name: string, options: {
  146881. radius?: number;
  146882. tube?: number;
  146883. radialSegments?: number;
  146884. tubularSegments?: number;
  146885. p?: number;
  146886. q?: number;
  146887. updatable?: boolean;
  146888. sideOrientation?: number;
  146889. frontUVs?: Vector4;
  146890. backUVs?: Vector4;
  146891. }, scene: any): Mesh;
  146892. }
  146893. }
  146894. declare module BABYLON {
  146895. /**
  146896. * Polygon
  146897. * @see https://doc.babylonjs.com/how_to/parametric_shapes#non-regular-polygon
  146898. */
  146899. export class Polygon {
  146900. /**
  146901. * Creates a rectangle
  146902. * @param xmin bottom X coord
  146903. * @param ymin bottom Y coord
  146904. * @param xmax top X coord
  146905. * @param ymax top Y coord
  146906. * @returns points that make the resulting rectation
  146907. */
  146908. static Rectangle(xmin: number, ymin: number, xmax: number, ymax: number): Vector2[];
  146909. /**
  146910. * Creates a circle
  146911. * @param radius radius of circle
  146912. * @param cx scale in x
  146913. * @param cy scale in y
  146914. * @param numberOfSides number of sides that make up the circle
  146915. * @returns points that make the resulting circle
  146916. */
  146917. static Circle(radius: number, cx?: number, cy?: number, numberOfSides?: number): Vector2[];
  146918. /**
  146919. * Creates a polygon from input string
  146920. * @param input Input polygon data
  146921. * @returns the parsed points
  146922. */
  146923. static Parse(input: string): Vector2[];
  146924. /**
  146925. * Starts building a polygon from x and y coordinates
  146926. * @param x x coordinate
  146927. * @param y y coordinate
  146928. * @returns the started path2
  146929. */
  146930. static StartingAt(x: number, y: number): Path2;
  146931. }
  146932. /**
  146933. * Builds a polygon
  146934. * @see https://doc.babylonjs.com/how_to/polygonmeshbuilder
  146935. */
  146936. export class PolygonMeshBuilder {
  146937. private _points;
  146938. private _outlinepoints;
  146939. private _holes;
  146940. private _name;
  146941. private _scene;
  146942. private _epoints;
  146943. private _eholes;
  146944. private _addToepoint;
  146945. /**
  146946. * Babylon reference to the earcut plugin.
  146947. */
  146948. bjsEarcut: any;
  146949. /**
  146950. * Creates a PolygonMeshBuilder
  146951. * @param name name of the builder
  146952. * @param contours Path of the polygon
  146953. * @param scene scene to add to when creating the mesh
  146954. * @param earcutInjection can be used to inject your own earcut reference
  146955. */
  146956. constructor(name: string, contours: Path2 | Vector2[] | any, scene?: Scene, earcutInjection?: any);
  146957. /**
  146958. * Adds a whole within the polygon
  146959. * @param hole Array of points defining the hole
  146960. * @returns this
  146961. */
  146962. addHole(hole: Vector2[]): PolygonMeshBuilder;
  146963. /**
  146964. * Creates the polygon
  146965. * @param updatable If the mesh should be updatable
  146966. * @param depth The depth of the mesh created
  146967. * @returns the created mesh
  146968. */
  146969. build(updatable?: boolean, depth?: number): Mesh;
  146970. /**
  146971. * Creates the polygon
  146972. * @param depth The depth of the mesh created
  146973. * @returns the created VertexData
  146974. */
  146975. buildVertexData(depth?: number): VertexData;
  146976. /**
  146977. * Adds a side to the polygon
  146978. * @param positions points that make the polygon
  146979. * @param normals normals of the polygon
  146980. * @param uvs uvs of the polygon
  146981. * @param indices indices of the polygon
  146982. * @param bounds bounds of the polygon
  146983. * @param points points of the polygon
  146984. * @param depth depth of the polygon
  146985. * @param flip flip of the polygon
  146986. */
  146987. private addSide;
  146988. }
  146989. }
  146990. declare module BABYLON {
  146991. /**
  146992. * Class containing static functions to help procedurally build meshes
  146993. */
  146994. export class PolygonBuilder {
  146995. /**
  146996. * Creates a polygon mesh
  146997. * The polygon's shape will depend on the input parameters and is constructed parallel to a ground mesh
  146998. * * 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
  146999. * * You can set the mesh side orientation with the values : Mesh.FRONTSIDE (default), Mesh.BACKSIDE or Mesh.DOUBLESIDE
  147000. * * The mesh can be set to updatable with the boolean parameter `updatable` (default false) if its internal geometry is supposed to change once created
  147001. * * If you create a double-sided mesh, you can choose what parts of the texture image to crop and stick respectively on the front and the back sides with the parameters `frontUVs` and `backUVs` (Vector4)
  147002. * * Remember you can only change the shape positions, not their number when updating a polygon
  147003. * @param name defines the name of the mesh
  147004. * @param options defines the options used to create the mesh
  147005. * @param scene defines the hosting scene
  147006. * @param earcutInjection can be used to inject your own earcut reference
  147007. * @returns the polygon mesh
  147008. */
  147009. static CreatePolygon(name: string, options: {
  147010. shape: Vector3[];
  147011. holes?: Vector3[][];
  147012. depth?: number;
  147013. faceUV?: Vector4[];
  147014. faceColors?: Color4[];
  147015. updatable?: boolean;
  147016. sideOrientation?: number;
  147017. frontUVs?: Vector4;
  147018. backUVs?: Vector4;
  147019. wrap?: boolean;
  147020. }, scene?: Nullable<Scene>, earcutInjection?: any): Mesh;
  147021. /**
  147022. * Creates an extruded polygon mesh, with depth in the Y direction.
  147023. * * 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)
  147024. * @see https://doc.babylonjs.com/how_to/createbox_per_face_textures_and_colors
  147025. * @param name defines the name of the mesh
  147026. * @param options defines the options used to create the mesh
  147027. * @param scene defines the hosting scene
  147028. * @param earcutInjection can be used to inject your own earcut reference
  147029. * @returns the polygon mesh
  147030. */
  147031. static ExtrudePolygon(name: string, options: {
  147032. shape: Vector3[];
  147033. holes?: Vector3[][];
  147034. depth?: number;
  147035. faceUV?: Vector4[];
  147036. faceColors?: Color4[];
  147037. updatable?: boolean;
  147038. sideOrientation?: number;
  147039. frontUVs?: Vector4;
  147040. backUVs?: Vector4;
  147041. wrap?: boolean;
  147042. }, scene?: Nullable<Scene>, earcutInjection?: any): Mesh;
  147043. }
  147044. }
  147045. declare module BABYLON {
  147046. /**
  147047. * Class containing static functions to help procedurally build meshes
  147048. */
  147049. export class LatheBuilder {
  147050. /**
  147051. * Creates lathe mesh.
  147052. * The lathe is a shape with a symetry axis : a 2D model shape is rotated around this axis to design the lathe
  147053. * * 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
  147054. * * The parameter `radius` (positive float, default 1) is the radius value of the lathe
  147055. * * The parameter `tessellation` (positive integer, default 64) is the side number of the lathe
  147056. * * The parameter `clip` (positive integer, default 0) is the number of sides to not create without effecting the general shape of the sides
  147057. * * 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
  147058. * * The parameter `closed` (boolean, default true) opens/closes the lathe circumference. This should be set to false when used with the parameter "arc"
  147059. * * 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
  147060. * * You can also set the mesh side orientation with the values : BABYLON.Mesh.FRONTSIDE (default), BABYLON.Mesh.BACKSIDE or BABYLON.Mesh.DOUBLESIDE
  147061. * * If you create a double-sided mesh, you can choose what parts of the texture image to crop and stick respectively on the front and the back sides with the parameters `frontUVs` and `backUVs` (Vector4). Detail here : https://doc.babylonjs.com/babylon101/discover_basic_elements#side-orientation
  147062. * * The optional parameter `invertUV` (boolean, default false) swaps in the geometry the U and V coordinates to apply a texture
  147063. * * The mesh can be set to updatable with the boolean parameter `updatable` (default false) if its internal geometry is supposed to change once created
  147064. * @param name defines the name of the mesh
  147065. * @param options defines the options used to create the mesh
  147066. * @param scene defines the hosting scene
  147067. * @returns the lathe mesh
  147068. * @see https://doc.babylonjs.com/how_to/parametric_shapes#lathe
  147069. */
  147070. static CreateLathe(name: string, options: {
  147071. shape: Vector3[];
  147072. radius?: number;
  147073. tessellation?: number;
  147074. clip?: number;
  147075. arc?: number;
  147076. closed?: boolean;
  147077. updatable?: boolean;
  147078. sideOrientation?: number;
  147079. frontUVs?: Vector4;
  147080. backUVs?: Vector4;
  147081. cap?: number;
  147082. invertUV?: boolean;
  147083. }, scene?: Nullable<Scene>): Mesh;
  147084. }
  147085. }
  147086. declare module BABYLON {
  147087. /**
  147088. * Class containing static functions to help procedurally build meshes
  147089. */
  147090. export class TiledPlaneBuilder {
  147091. /**
  147092. * Creates a tiled plane mesh
  147093. * * The parameter `pattern` will, depending on value, do nothing or
  147094. * * * flip (reflect about central vertical) alternate tiles across and up
  147095. * * * flip every tile on alternate rows
  147096. * * * rotate (180 degs) alternate tiles across and up
  147097. * * * rotate every tile on alternate rows
  147098. * * * flip and rotate alternate tiles across and up
  147099. * * * flip and rotate every tile on alternate rows
  147100. * * The parameter `tileSize` sets the size (float) of each tile side (default 1)
  147101. * * You can set some different tile dimensions by using the parameters `tileWidth` and `tileHeight` (both by default have the same value of `tileSize`)
  147102. * * If you create a double-sided mesh, you can choose what parts of the texture image to crop and stick respectively on the front and the back sides with the parameters `frontUVs` and `backUVs` (Vector4). Detail here : https://doc.babylonjs.com/babylon101/discover_basic_elements#side-orientation
  147103. * * sideOrientation optional and takes the values : Mesh.FRONTSIDE (default), Mesh.BACKSIDE or Mesh.DOUBLESIDE
  147104. * * 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)
  147105. * * 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)
  147106. * @see https://doc.babylonjs.com/how_to/set_shapes#box
  147107. * @param name defines the name of the mesh
  147108. * @param options defines the options used to create the mesh
  147109. * @param scene defines the hosting scene
  147110. * @returns the box mesh
  147111. */
  147112. static CreateTiledPlane(name: string, options: {
  147113. pattern?: number;
  147114. tileSize?: number;
  147115. tileWidth?: number;
  147116. tileHeight?: number;
  147117. size?: number;
  147118. width?: number;
  147119. height?: number;
  147120. alignHorizontal?: number;
  147121. alignVertical?: number;
  147122. sideOrientation?: number;
  147123. frontUVs?: Vector4;
  147124. backUVs?: Vector4;
  147125. updatable?: boolean;
  147126. }, scene?: Nullable<Scene>): Mesh;
  147127. }
  147128. }
  147129. declare module BABYLON {
  147130. /**
  147131. * Class containing static functions to help procedurally build meshes
  147132. */
  147133. export class TubeBuilder {
  147134. /**
  147135. * Creates a tube mesh.
  147136. * The tube is a parametric shape. It has no predefined shape. Its final shape will depend on the input parameters
  147137. * * The parameter `path` is a required array of successive Vector3. It is the curve used as the axis of the tube
  147138. * * The parameter `radius` (positive float, default 1) sets the tube radius size
  147139. * * The parameter `tessellation` (positive float, default 64) is the number of sides on the tubular surface
  147140. * * The parameter `radiusFunction` (javascript function, default null) is a vanilla javascript function. If it is not null, it overwrittes the parameter `radius`
  147141. * * 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)
  147142. * * The parameter `arc` (positive float, maximum 1, default 1) is the ratio to apply to the tube circumference : 2 x PI x arc
  147143. * * 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
  147144. * * 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
  147145. * * You can also set the mesh side orientation with the values : BABYLON.Mesh.FRONTSIDE (default), BABYLON.Mesh.BACKSIDE or BABYLON.Mesh.DOUBLESIDE
  147146. * * If you create a double-sided mesh, you can choose what parts of the texture image to crop and stick respectively on the front and the back sides with the parameters `frontUVs` and `backUVs` (Vector4). Detail here : https://doc.babylonjs.com/babylon101/discover_basic_elements#side-orientation
  147147. * * The optional parameter `invertUV` (boolean, default false) swaps in the geometry the U and V coordinates to apply a texture
  147148. * * The mesh can be set to updatable with the boolean parameter `updatable` (default false) if its internal geometry is supposed to change once created
  147149. * @param name defines the name of the mesh
  147150. * @param options defines the options used to create the mesh
  147151. * @param scene defines the hosting scene
  147152. * @returns the tube mesh
  147153. * @see https://doc.babylonjs.com/how_to/parametric_shapes
  147154. * @see https://doc.babylonjs.com/how_to/set_shapes#tube
  147155. */
  147156. static CreateTube(name: string, options: {
  147157. path: Vector3[];
  147158. radius?: number;
  147159. tessellation?: number;
  147160. radiusFunction?: {
  147161. (i: number, distance: number): number;
  147162. };
  147163. cap?: number;
  147164. arc?: number;
  147165. updatable?: boolean;
  147166. sideOrientation?: number;
  147167. frontUVs?: Vector4;
  147168. backUVs?: Vector4;
  147169. instance?: Mesh;
  147170. invertUV?: boolean;
  147171. }, scene?: Nullable<Scene>): Mesh;
  147172. }
  147173. }
  147174. declare module BABYLON {
  147175. /**
  147176. * Class containing static functions to help procedurally build meshes
  147177. */
  147178. export class IcoSphereBuilder {
  147179. /**
  147180. * Creates a sphere based upon an icosahedron with 20 triangular faces which can be subdivided
  147181. * * The parameter `radius` sets the radius size (float) of the icosphere (default 1)
  147182. * * 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`)
  147183. * * The parameter `subdivisions` sets the number of subdivisions (postive integer, default 4). The more subdivisions, the more faces on the icosphere whatever its size
  147184. * * 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
  147185. * * You can also set the mesh side orientation with the values : BABYLON.Mesh.FRONTSIDE (default), BABYLON.Mesh.BACKSIDE or BABYLON.Mesh.DOUBLESIDE
  147186. * * If you create a double-sided mesh, you can choose what parts of the texture image to crop and stick respectively on the front and the back sides with the parameters `frontUVs` and `backUVs` (Vector4). Detail here : https://doc.babylonjs.com/babylon101/discover_basic_elements#side-orientation
  147187. * * The mesh can be set to updatable with the boolean parameter `updatable` (default false) if its internal geometry is supposed to change once created
  147188. * @param name defines the name of the mesh
  147189. * @param options defines the options used to create the mesh
  147190. * @param scene defines the hosting scene
  147191. * @returns the icosahedron mesh
  147192. * @see https://doc.babylonjs.com/how_to/polyhedra_shapes#icosphere
  147193. */
  147194. static CreateIcoSphere(name: string, options: {
  147195. radius?: number;
  147196. radiusX?: number;
  147197. radiusY?: number;
  147198. radiusZ?: number;
  147199. flat?: boolean;
  147200. subdivisions?: number;
  147201. sideOrientation?: number;
  147202. frontUVs?: Vector4;
  147203. backUVs?: Vector4;
  147204. updatable?: boolean;
  147205. }, scene?: Nullable<Scene>): Mesh;
  147206. }
  147207. }
  147208. declare module BABYLON {
  147209. /**
  147210. * Class containing static functions to help procedurally build meshes
  147211. */
  147212. export class DecalBuilder {
  147213. /**
  147214. * Creates a decal mesh.
  147215. * 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
  147216. * * The parameter `position` (Vector3, default `(0, 0, 0)`) sets the position of the decal in World coordinates
  147217. * * The parameter `normal` (Vector3, default `Vector3.Up`) sets the normal of the mesh where the decal is applied onto in World coordinates
  147218. * * The parameter `size` (Vector3, default `(1, 1, 1)`) sets the decal scaling
  147219. * * The parameter `angle` (float in radian, default 0) sets the angle to rotate the decal
  147220. * @param name defines the name of the mesh
  147221. * @param sourceMesh defines the mesh where the decal must be applied
  147222. * @param options defines the options used to create the mesh
  147223. * @param scene defines the hosting scene
  147224. * @returns the decal mesh
  147225. * @see https://doc.babylonjs.com/how_to/decals
  147226. */
  147227. static CreateDecal(name: string, sourceMesh: AbstractMesh, options: {
  147228. position?: Vector3;
  147229. normal?: Vector3;
  147230. size?: Vector3;
  147231. angle?: number;
  147232. }): Mesh;
  147233. }
  147234. }
  147235. declare module BABYLON {
  147236. /**
  147237. * Class containing static functions to help procedurally build meshes
  147238. */
  147239. export class MeshBuilder {
  147240. /**
  147241. * Creates a box mesh
  147242. * * The parameter `size` sets the size (float) of each box side (default 1)
  147243. * * You can set some different box dimensions by using the parameters `width`, `height` and `depth` (all by default have the same value of `size`)
  147244. * * 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)
  147245. * * Please read this tutorial : https://doc.babylonjs.com/how_to/createbox_per_face_textures_and_colors
  147246. * * You can also set the mesh side orientation with the values : BABYLON.Mesh.FRONTSIDE (default), BABYLON.Mesh.BACKSIDE or BABYLON.Mesh.DOUBLESIDE
  147247. * * If you create a double-sided mesh, you can choose what parts of the texture image to crop and stick respectively on the front and the back sides with the parameters `frontUVs` and `backUVs` (Vector4). Detail here : https://doc.babylonjs.com/babylon101/discover_basic_elements#side-orientation
  147248. * * The mesh can be set to updatable with the boolean parameter `updatable` (default false) if its internal geometry is supposed to change once created
  147249. * @see https://doc.babylonjs.com/how_to/set_shapes#box
  147250. * @param name defines the name of the mesh
  147251. * @param options defines the options used to create the mesh
  147252. * @param scene defines the hosting scene
  147253. * @returns the box mesh
  147254. */
  147255. static CreateBox(name: string, options: {
  147256. size?: number;
  147257. width?: number;
  147258. height?: number;
  147259. depth?: number;
  147260. faceUV?: Vector4[];
  147261. faceColors?: Color4[];
  147262. sideOrientation?: number;
  147263. frontUVs?: Vector4;
  147264. backUVs?: Vector4;
  147265. wrap?: boolean;
  147266. topBaseAt?: number;
  147267. bottomBaseAt?: number;
  147268. updatable?: boolean;
  147269. }, scene?: Nullable<Scene>): Mesh;
  147270. /**
  147271. * Creates a tiled box mesh
  147272. * * faceTiles sets the pattern, tile size and number of tiles for a face
  147273. * * The mesh can be set to updatable with the boolean parameter `updatable` (default false) if its internal geometry is supposed to change once created
  147274. * @param name defines the name of the mesh
  147275. * @param options defines the options used to create the mesh
  147276. * @param scene defines the hosting scene
  147277. * @returns the tiled box mesh
  147278. */
  147279. static CreateTiledBox(name: string, options: {
  147280. pattern?: number;
  147281. size?: number;
  147282. width?: number;
  147283. height?: number;
  147284. depth: number;
  147285. tileSize?: number;
  147286. tileWidth?: number;
  147287. tileHeight?: number;
  147288. faceUV?: Vector4[];
  147289. faceColors?: Color4[];
  147290. alignHorizontal?: number;
  147291. alignVertical?: number;
  147292. sideOrientation?: number;
  147293. updatable?: boolean;
  147294. }, scene?: Nullable<Scene>): Mesh;
  147295. /**
  147296. * Creates a sphere mesh
  147297. * * The parameter `diameter` sets the diameter size (float) of the sphere (default 1)
  147298. * * 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`)
  147299. * * The parameter `segments` sets the sphere number of horizontal stripes (positive integer, default 32)
  147300. * * 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
  147301. * * 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)
  147302. * * You can also set the mesh side orientation with the values : BABYLON.Mesh.FRONTSIDE (default), BABYLON.Mesh.BACKSIDE or BABYLON.Mesh.DOUBLESIDE
  147303. * * If you create a double-sided mesh, you can choose what parts of the texture image to crop and stick respectively on the front and the back sides with the parameters `frontUVs` and `backUVs` (Vector4). Detail here : https://doc.babylonjs.com/babylon101/discover_basic_elements#side-orientation
  147304. * * The mesh can be set to updatable with the boolean parameter `updatable` (default false) if its internal geometry is supposed to change once created
  147305. * @param name defines the name of the mesh
  147306. * @param options defines the options used to create the mesh
  147307. * @param scene defines the hosting scene
  147308. * @returns the sphere mesh
  147309. * @see https://doc.babylonjs.com/how_to/set_shapes#sphere
  147310. */
  147311. static CreateSphere(name: string, options: {
  147312. segments?: number;
  147313. diameter?: number;
  147314. diameterX?: number;
  147315. diameterY?: number;
  147316. diameterZ?: number;
  147317. arc?: number;
  147318. slice?: number;
  147319. sideOrientation?: number;
  147320. frontUVs?: Vector4;
  147321. backUVs?: Vector4;
  147322. updatable?: boolean;
  147323. }, scene?: Nullable<Scene>): Mesh;
  147324. /**
  147325. * Creates a plane polygonal mesh. By default, this is a disc
  147326. * * The parameter `radius` sets the radius size (float) of the polygon (default 0.5)
  147327. * * 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
  147328. * * 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
  147329. * * You can also set the mesh side orientation with the values : BABYLON.Mesh.FRONTSIDE (default), BABYLON.Mesh.BACKSIDE or BABYLON.Mesh.DOUBLESIDE
  147330. * * If you create a double-sided mesh, you can choose what parts of the texture image to crop and stick respectively on the front and the back sides with the parameters `frontUVs` and `backUVs` (Vector4). Detail here : https://doc.babylonjs.com/babylon101/discover_basic_elements#side-orientation
  147331. * * The mesh can be set to updatable with the boolean parameter `updatable` (default false) if its internal geometry is supposed to change once created
  147332. * @param name defines the name of the mesh
  147333. * @param options defines the options used to create the mesh
  147334. * @param scene defines the hosting scene
  147335. * @returns the plane polygonal mesh
  147336. * @see https://doc.babylonjs.com/how_to/set_shapes#disc-or-regular-polygon
  147337. */
  147338. static CreateDisc(name: string, options: {
  147339. radius?: number;
  147340. tessellation?: number;
  147341. arc?: number;
  147342. updatable?: boolean;
  147343. sideOrientation?: number;
  147344. frontUVs?: Vector4;
  147345. backUVs?: Vector4;
  147346. }, scene?: Nullable<Scene>): Mesh;
  147347. /**
  147348. * Creates a sphere based upon an icosahedron with 20 triangular faces which can be subdivided
  147349. * * The parameter `radius` sets the radius size (float) of the icosphere (default 1)
  147350. * * 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`)
  147351. * * The parameter `subdivisions` sets the number of subdivisions (postive integer, default 4). The more subdivisions, the more faces on the icosphere whatever its size
  147352. * * 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
  147353. * * You can also set the mesh side orientation with the values : BABYLON.Mesh.FRONTSIDE (default), BABYLON.Mesh.BACKSIDE or BABYLON.Mesh.DOUBLESIDE
  147354. * * If you create a double-sided mesh, you can choose what parts of the texture image to crop and stick respectively on the front and the back sides with the parameters `frontUVs` and `backUVs` (Vector4). Detail here : https://doc.babylonjs.com/babylon101/discover_basic_elements#side-orientation
  147355. * * The mesh can be set to updatable with the boolean parameter `updatable` (default false) if its internal geometry is supposed to change once created
  147356. * @param name defines the name of the mesh
  147357. * @param options defines the options used to create the mesh
  147358. * @param scene defines the hosting scene
  147359. * @returns the icosahedron mesh
  147360. * @see https://doc.babylonjs.com/how_to/polyhedra_shapes#icosphere
  147361. */
  147362. static CreateIcoSphere(name: string, options: {
  147363. radius?: number;
  147364. radiusX?: number;
  147365. radiusY?: number;
  147366. radiusZ?: number;
  147367. flat?: boolean;
  147368. subdivisions?: number;
  147369. sideOrientation?: number;
  147370. frontUVs?: Vector4;
  147371. backUVs?: Vector4;
  147372. updatable?: boolean;
  147373. }, scene?: Nullable<Scene>): Mesh;
  147374. /**
  147375. * Creates a ribbon mesh. The ribbon is a parametric shape. It has no predefined shape. Its final shape will depend on the input parameters
  147376. * * The parameter `pathArray` is a required array of paths, what are each an array of successive Vector3. The pathArray parameter depicts the ribbon geometry
  147377. * * The parameter `closeArray` (boolean, default false) creates a seam between the first and the last paths of the path array
  147378. * * The parameter `closePath` (boolean, default false) creates a seam between the first and the last points of each path of the path array
  147379. * * 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
  147380. * * 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
  147381. * * 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
  147382. * * You can also set the mesh side orientation with the values : BABYLON.Mesh.FRONTSIDE (default), BABYLON.Mesh.BACKSIDE or BABYLON.Mesh.DOUBLESIDE
  147383. * * If you create a double-sided mesh, you can choose what parts of the texture image to crop and stick respectively on the front and the back sides with the parameters `frontUVs` and `backUVs` (Vector4). Detail here : https://doc.babylonjs.com/babylon101/discover_basic_elements#side-orientation
  147384. * * The optional parameter `invertUV` (boolean, default false) swaps in the geometry the U and V coordinates to apply a texture
  147385. * * 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
  147386. * * The parameters `colors` is an optional flat array of `Color4` to set/update each ribbon vertex with its own custom color values
  147387. * * 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
  147388. * * Moreover, you can use the parameter `color` with `instance` (to update the ribbon), only if you previously used it at creation time
  147389. * * The mesh can be set to updatable with the boolean parameter `updatable` (default false) if its internal geometry is supposed to change once created
  147390. * @param name defines the name of the mesh
  147391. * @param options defines the options used to create the mesh
  147392. * @param scene defines the hosting scene
  147393. * @returns the ribbon mesh
  147394. * @see https://doc.babylonjs.com/how_to/ribbon_tutorial
  147395. * @see https://doc.babylonjs.com/how_to/parametric_shapes
  147396. */
  147397. static CreateRibbon(name: string, options: {
  147398. pathArray: Vector3[][];
  147399. closeArray?: boolean;
  147400. closePath?: boolean;
  147401. offset?: number;
  147402. updatable?: boolean;
  147403. sideOrientation?: number;
  147404. frontUVs?: Vector4;
  147405. backUVs?: Vector4;
  147406. instance?: Mesh;
  147407. invertUV?: boolean;
  147408. uvs?: Vector2[];
  147409. colors?: Color4[];
  147410. }, scene?: Nullable<Scene>): Mesh;
  147411. /**
  147412. * Creates a cylinder or a cone mesh
  147413. * * The parameter `height` sets the height size (float) of the cylinder/cone (float, default 2).
  147414. * * The parameter `diameter` sets the diameter of the top and bottom cap at once (float, default 1).
  147415. * * 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.
  147416. * * The parameter `tessellation` sets the number of cylinder sides (positive integer, default 24). Set it to 3 to get a prism for instance.
  147417. * * The parameter `subdivisions` sets the number of rings along the cylinder height (positive integer, default 1).
  147418. * * The parameter `hasRings` (boolean, default false) makes the subdivisions independent from each other, so they become different faces.
  147419. * * The parameter `enclose` (boolean, default false) adds two extra faces per subdivision to a sliced cylinder to close it around its height axis.
  147420. * * 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).
  147421. * * The parameter `arc` (float, default 1) is the ratio (max 1) to apply to the circumference to slice the cylinder.
  147422. * * 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).
  147423. * * 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
  147424. * * Now, if the cylinder has 5 independent subdivisions (hasRings = true), n equals : top face + 5 stripe surfaces + bottom face = 2 + 5 = 7
  147425. * * 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
  147426. * * 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.
  147427. * * If `enclose` is false, a ring surface is one element.
  147428. * * If `enclose` is true, a ring surface is 3 successive elements in the array : the tubular surface, then the two closing faces.
  147429. * * 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
  147430. * * You can also set the mesh side orientation with the values : BABYLON.Mesh.FRONTSIDE (default), BABYLON.Mesh.BACKSIDE or BABYLON.Mesh.DOUBLESIDE
  147431. * * If you create a double-sided mesh, you can choose what parts of the texture image to crop and stick respectively on the front and the back sides with the parameters `frontUVs` and `backUVs` (Vector4). Detail here : https://doc.babylonjs.com/babylon101/discover_basic_elements#side-orientation
  147432. * * The mesh can be set to updatable with the boolean parameter `updatable` (default false) if its internal geometry is supposed to change once created.
  147433. * @param name defines the name of the mesh
  147434. * @param options defines the options used to create the mesh
  147435. * @param scene defines the hosting scene
  147436. * @returns the cylinder mesh
  147437. * @see https://doc.babylonjs.com/how_to/set_shapes#cylinder-or-cone
  147438. */
  147439. static CreateCylinder(name: string, options: {
  147440. height?: number;
  147441. diameterTop?: number;
  147442. diameterBottom?: number;
  147443. diameter?: number;
  147444. tessellation?: number;
  147445. subdivisions?: number;
  147446. arc?: number;
  147447. faceColors?: Color4[];
  147448. faceUV?: Vector4[];
  147449. updatable?: boolean;
  147450. hasRings?: boolean;
  147451. enclose?: boolean;
  147452. cap?: number;
  147453. sideOrientation?: number;
  147454. frontUVs?: Vector4;
  147455. backUVs?: Vector4;
  147456. }, scene?: Nullable<Scene>): Mesh;
  147457. /**
  147458. * Creates a torus mesh
  147459. * * The parameter `diameter` sets the diameter size (float) of the torus (default 1)
  147460. * * The parameter `thickness` sets the diameter size of the tube of the torus (float, default 0.5)
  147461. * * The parameter `tessellation` sets the number of torus sides (postive integer, default 16)
  147462. * * You can also set the mesh side orientation with the values : BABYLON.Mesh.FRONTSIDE (default), BABYLON.Mesh.BACKSIDE or BABYLON.Mesh.DOUBLESIDE
  147463. * * If you create a double-sided mesh, you can choose what parts of the texture image to crop and stick respectively on the front and the back sides with the parameters `frontUVs` and `backUVs` (Vector4). Detail here : https://doc.babylonjs.com/babylon101/discover_basic_elements#side-orientation
  147464. * * The mesh can be set to updatable with the boolean parameter `updatable` (default false) if its internal geometry is supposed to change once created.
  147465. * @param name defines the name of the mesh
  147466. * @param options defines the options used to create the mesh
  147467. * @param scene defines the hosting scene
  147468. * @returns the torus mesh
  147469. * @see https://doc.babylonjs.com/how_to/set_shapes#torus
  147470. */
  147471. static CreateTorus(name: string, options: {
  147472. diameter?: number;
  147473. thickness?: number;
  147474. tessellation?: number;
  147475. updatable?: boolean;
  147476. sideOrientation?: number;
  147477. frontUVs?: Vector4;
  147478. backUVs?: Vector4;
  147479. }, scene?: Nullable<Scene>): Mesh;
  147480. /**
  147481. * Creates a torus knot mesh
  147482. * * The parameter `radius` sets the global radius size (float) of the torus knot (default 2)
  147483. * * The parameter `radialSegments` sets the number of sides on each tube segments (positive integer, default 32)
  147484. * * The parameter `tubularSegments` sets the number of tubes to decompose the knot into (positive integer, default 32)
  147485. * * The parameters `p` and `q` are the number of windings on each axis (positive integers, default 2 and 3)
  147486. * * You can also set the mesh side orientation with the values : BABYLON.Mesh.FRONTSIDE (default), BABYLON.Mesh.BACKSIDE or BABYLON.Mesh.DOUBLESIDE
  147487. * * If you create a double-sided mesh, you can choose what parts of the texture image to crop and stick respectively on the front and the back sides with the parameters `frontUVs` and `backUVs` (Vector4). Detail here : https://doc.babylonjs.com/babylon101/discover_basic_elements#side-orientation
  147488. * * The mesh can be set to updatable with the boolean parameter `updatable` (default false) if its internal geometry is supposed to change once created.
  147489. * @param name defines the name of the mesh
  147490. * @param options defines the options used to create the mesh
  147491. * @param scene defines the hosting scene
  147492. * @returns the torus knot mesh
  147493. * @see https://doc.babylonjs.com/how_to/set_shapes#torus-knot
  147494. */
  147495. static CreateTorusKnot(name: string, options: {
  147496. radius?: number;
  147497. tube?: number;
  147498. radialSegments?: number;
  147499. tubularSegments?: number;
  147500. p?: number;
  147501. q?: number;
  147502. updatable?: boolean;
  147503. sideOrientation?: number;
  147504. frontUVs?: Vector4;
  147505. backUVs?: Vector4;
  147506. }, scene?: Nullable<Scene>): Mesh;
  147507. /**
  147508. * Creates a line system mesh. A line system is a pool of many lines gathered in a single mesh
  147509. * * 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
  147510. * * Like every other parametric shape, it is dynamically updatable by passing an existing instance of LineSystem to this static function
  147511. * * The parameter `lines` is an array of lines, each line being an array of successive Vector3
  147512. * * The optional parameter `instance` is an instance of an existing LineSystem object to be updated with the passed `lines` parameter
  147513. * * The optional parameter `colors` is an array of line colors, each line colors being an array of successive Color4, one per line point
  147514. * * The optional parameter `useVertexAlpha` is to be set to `false` (default `true`) when you don't need the alpha blending (faster)
  147515. * * 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
  147516. * * When updating an instance, remember that only line point positions can change, not the number of points, neither the number of lines
  147517. * * The mesh can be set to updatable with the boolean parameter `updatable` (default false) if its internal geometry is supposed to change once created
  147518. * @see https://doc.babylonjs.com/how_to/parametric_shapes#line-system
  147519. * @param name defines the name of the new line system
  147520. * @param options defines the options used to create the line system
  147521. * @param scene defines the hosting scene
  147522. * @returns a new line system mesh
  147523. */
  147524. static CreateLineSystem(name: string, options: {
  147525. lines: Vector3[][];
  147526. updatable?: boolean;
  147527. instance?: Nullable<LinesMesh>;
  147528. colors?: Nullable<Color4[][]>;
  147529. useVertexAlpha?: boolean;
  147530. }, scene: Nullable<Scene>): LinesMesh;
  147531. /**
  147532. * Creates a line mesh
  147533. * 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
  147534. * * Like every other parametric shape, it is dynamically updatable by passing an existing instance of LineMesh to this static function
  147535. * * The parameter `points` is an array successive Vector3
  147536. * * 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
  147537. * * The optional parameter `colors` is an array of successive Color4, one per line point
  147538. * * The optional parameter `useVertexAlpha` is to be set to `false` (default `true`) when you don't need alpha blending (faster)
  147539. * * When updating an instance, remember that only point positions can change, not the number of points
  147540. * * The mesh can be set to updatable with the boolean parameter `updatable` (default false) if its internal geometry is supposed to change once created
  147541. * @see https://doc.babylonjs.com/how_to/parametric_shapes#lines
  147542. * @param name defines the name of the new line system
  147543. * @param options defines the options used to create the line system
  147544. * @param scene defines the hosting scene
  147545. * @returns a new line mesh
  147546. */
  147547. static CreateLines(name: string, options: {
  147548. points: Vector3[];
  147549. updatable?: boolean;
  147550. instance?: Nullable<LinesMesh>;
  147551. colors?: Color4[];
  147552. useVertexAlpha?: boolean;
  147553. }, scene?: Nullable<Scene>): LinesMesh;
  147554. /**
  147555. * Creates a dashed line mesh
  147556. * * 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
  147557. * * Like every other parametric shape, it is dynamically updatable by passing an existing instance of LineMesh to this static function
  147558. * * The parameter `points` is an array successive Vector3
  147559. * * The parameter `dashNb` is the intended total number of dashes (positive integer, default 200)
  147560. * * The parameter `dashSize` is the size of the dashes relatively the dash number (positive float, default 3)
  147561. * * The parameter `gapSize` is the size of the gap between two successive dashes relatively the dash number (positive float, default 1)
  147562. * * 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
  147563. * * When updating an instance, remember that only point positions can change, not the number of points
  147564. * * The mesh can be set to updatable with the boolean parameter `updatable` (default false) if its internal geometry is supposed to change once created
  147565. * @param name defines the name of the mesh
  147566. * @param options defines the options used to create the mesh
  147567. * @param scene defines the hosting scene
  147568. * @returns the dashed line mesh
  147569. * @see https://doc.babylonjs.com/how_to/parametric_shapes#dashed-lines
  147570. */
  147571. static CreateDashedLines(name: string, options: {
  147572. points: Vector3[];
  147573. dashSize?: number;
  147574. gapSize?: number;
  147575. dashNb?: number;
  147576. updatable?: boolean;
  147577. instance?: LinesMesh;
  147578. }, scene?: Nullable<Scene>): LinesMesh;
  147579. /**
  147580. * 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.
  147581. * * 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.
  147582. * * The parameter `path` is a required array of successive Vector3. This is the axis curve the shape is extruded along.
  147583. * * 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.
  147584. * * The parameter `scale` (float, default 1) is the value to scale the shape.
  147585. * * 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
  147586. * * 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
  147587. * * Remember you can only change the shape or path point positions, not their number when updating an extruded shape.
  147588. * * You can also set the mesh side orientation with the values : BABYLON.Mesh.FRONTSIDE (default), BABYLON.Mesh.BACKSIDE or BABYLON.Mesh.DOUBLESIDE
  147589. * * If you create a double-sided mesh, you can choose what parts of the texture image to crop and stick respectively on the front and the back sides with the parameters `frontUVs` and `backUVs` (Vector4). Detail here : https://doc.babylonjs.com/babylon101/discover_basic_elements#side-orientation
  147590. * * The optional parameter `invertUV` (boolean, default false) swaps in the geometry the U and V coordinates to apply a texture.
  147591. * * The mesh can be set to updatable with the boolean parameter `updatable` (default false) if its internal geometry is supposed to change once created.
  147592. * @param name defines the name of the mesh
  147593. * @param options defines the options used to create the mesh
  147594. * @param scene defines the hosting scene
  147595. * @returns the extruded shape mesh
  147596. * @see https://doc.babylonjs.com/how_to/parametric_shapes
  147597. * @see https://doc.babylonjs.com/how_to/parametric_shapes#extruded-shapes
  147598. */
  147599. static ExtrudeShape(name: string, options: {
  147600. shape: Vector3[];
  147601. path: Vector3[];
  147602. scale?: number;
  147603. rotation?: number;
  147604. cap?: number;
  147605. updatable?: boolean;
  147606. sideOrientation?: number;
  147607. frontUVs?: Vector4;
  147608. backUVs?: Vector4;
  147609. instance?: Mesh;
  147610. invertUV?: boolean;
  147611. }, scene?: Nullable<Scene>): Mesh;
  147612. /**
  147613. * Creates an custom extruded shape mesh.
  147614. * The custom extrusion is a parametric shape. It has no predefined shape. Its final shape will depend on the input parameters.
  147615. * * 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.
  147616. * * The parameter `path` is a required array of successive Vector3. This is the axis curve the shape is extruded along.
  147617. * * 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
  147618. * * It must returns a float value that will be the rotation in radians applied to the shape on each path point.
  147619. * * 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
  147620. * * It must returns a float value that will be the scale value applied to the shape on each path point
  147621. * * The parameter `ribbonClosePath` (boolean, default false) forces the extrusion underlying ribbon to close all the paths in its `pathArray`
  147622. * * The parameter `ribbonCloseArray` (boolean, default false) forces the extrusion underlying ribbon to close its `pathArray`
  147623. * * 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
  147624. * * 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
  147625. * * Remember you can only change the shape or path point positions, not their number when updating an extruded shape
  147626. * * You can also set the mesh side orientation with the values : BABYLON.Mesh.FRONTSIDE (default), BABYLON.Mesh.BACKSIDE or BABYLON.Mesh.DOUBLESIDE
  147627. * * If you create a double-sided mesh, you can choose what parts of the texture image to crop and stick respectively on the front and the back sides with the parameters `frontUVs` and `backUVs` (Vector4). Detail here : https://doc.babylonjs.com/babylon101/discover_basic_elements#side-orientation
  147628. * * The optional parameter `invertUV` (boolean, default false) swaps in the geometry the U and V coordinates to apply a texture
  147629. * * The mesh can be set to updatable with the boolean parameter `updatable` (default false) if its internal geometry is supposed to change once created
  147630. * @param name defines the name of the mesh
  147631. * @param options defines the options used to create the mesh
  147632. * @param scene defines the hosting scene
  147633. * @returns the custom extruded shape mesh
  147634. * @see https://doc.babylonjs.com/how_to/parametric_shapes#custom-extruded-shapes
  147635. * @see https://doc.babylonjs.com/how_to/parametric_shapes
  147636. * @see https://doc.babylonjs.com/how_to/parametric_shapes#extruded-shapes
  147637. */
  147638. static ExtrudeShapeCustom(name: string, options: {
  147639. shape: Vector3[];
  147640. path: Vector3[];
  147641. scaleFunction?: any;
  147642. rotationFunction?: any;
  147643. ribbonCloseArray?: boolean;
  147644. ribbonClosePath?: boolean;
  147645. cap?: number;
  147646. updatable?: boolean;
  147647. sideOrientation?: number;
  147648. frontUVs?: Vector4;
  147649. backUVs?: Vector4;
  147650. instance?: Mesh;
  147651. invertUV?: boolean;
  147652. }, scene?: Nullable<Scene>): Mesh;
  147653. /**
  147654. * Creates lathe mesh.
  147655. * The lathe is a shape with a symetry axis : a 2D model shape is rotated around this axis to design the lathe
  147656. * * 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
  147657. * * The parameter `radius` (positive float, default 1) is the radius value of the lathe
  147658. * * The parameter `tessellation` (positive integer, default 64) is the side number of the lathe
  147659. * * The parameter `clip` (positive integer, default 0) is the number of sides to not create without effecting the general shape of the sides
  147660. * * 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
  147661. * * The parameter `closed` (boolean, default true) opens/closes the lathe circumference. This should be set to false when used with the parameter "arc"
  147662. * * 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
  147663. * * You can also set the mesh side orientation with the values : BABYLON.Mesh.FRONTSIDE (default), BABYLON.Mesh.BACKSIDE or BABYLON.Mesh.DOUBLESIDE
  147664. * * If you create a double-sided mesh, you can choose what parts of the texture image to crop and stick respectively on the front and the back sides with the parameters `frontUVs` and `backUVs` (Vector4). Detail here : https://doc.babylonjs.com/babylon101/discover_basic_elements#side-orientation
  147665. * * The optional parameter `invertUV` (boolean, default false) swaps in the geometry the U and V coordinates to apply a texture
  147666. * * The mesh can be set to updatable with the boolean parameter `updatable` (default false) if its internal geometry is supposed to change once created
  147667. * @param name defines the name of the mesh
  147668. * @param options defines the options used to create the mesh
  147669. * @param scene defines the hosting scene
  147670. * @returns the lathe mesh
  147671. * @see https://doc.babylonjs.com/how_to/parametric_shapes#lathe
  147672. */
  147673. static CreateLathe(name: string, options: {
  147674. shape: Vector3[];
  147675. radius?: number;
  147676. tessellation?: number;
  147677. clip?: number;
  147678. arc?: number;
  147679. closed?: boolean;
  147680. updatable?: boolean;
  147681. sideOrientation?: number;
  147682. frontUVs?: Vector4;
  147683. backUVs?: Vector4;
  147684. cap?: number;
  147685. invertUV?: boolean;
  147686. }, scene?: Nullable<Scene>): Mesh;
  147687. /**
  147688. * Creates a tiled plane mesh
  147689. * * You can set a limited pattern arrangement with the tiles
  147690. * * You can also set the mesh side orientation with the values : BABYLON.Mesh.FRONTSIDE (default), BABYLON.Mesh.BACKSIDE or BABYLON.Mesh.DOUBLESIDE
  147691. * * If you create a double-sided mesh, you can choose what parts of the texture image to crop and stick respectively on the front and the back sides with the parameters `frontUVs` and `backUVs` (Vector4). Detail here : https://doc.babylonjs.com/babylon101/discover_basic_elements#side-orientation
  147692. * * The mesh can be set to updatable with the boolean parameter `updatable` (default false) if its internal geometry is supposed to change once created
  147693. * @param name defines the name of the mesh
  147694. * @param options defines the options used to create the mesh
  147695. * @param scene defines the hosting scene
  147696. * @returns the plane mesh
  147697. * @see https://doc.babylonjs.com/how_to/set_shapes#plane
  147698. */
  147699. static CreateTiledPlane(name: string, options: {
  147700. pattern?: number;
  147701. tileSize?: number;
  147702. tileWidth?: number;
  147703. tileHeight?: number;
  147704. size?: number;
  147705. width?: number;
  147706. height?: number;
  147707. alignHorizontal?: number;
  147708. alignVertical?: number;
  147709. sideOrientation?: number;
  147710. frontUVs?: Vector4;
  147711. backUVs?: Vector4;
  147712. updatable?: boolean;
  147713. }, scene?: Nullable<Scene>): Mesh;
  147714. /**
  147715. * Creates a plane mesh
  147716. * * The parameter `size` sets the size (float) of both sides of the plane at once (default 1)
  147717. * * You can set some different plane dimensions by using the parameters `width` and `height` (both by default have the same value of `size`)
  147718. * * The parameter `sourcePlane` is a Plane instance. It builds a mesh plane from a Math plane
  147719. * * You can also set the mesh side orientation with the values : BABYLON.Mesh.FRONTSIDE (default), BABYLON.Mesh.BACKSIDE or BABYLON.Mesh.DOUBLESIDE
  147720. * * If you create a double-sided mesh, you can choose what parts of the texture image to crop and stick respectively on the front and the back sides with the parameters `frontUVs` and `backUVs` (Vector4). Detail here : https://doc.babylonjs.com/babylon101/discover_basic_elements#side-orientation
  147721. * * The mesh can be set to updatable with the boolean parameter `updatable` (default false) if its internal geometry is supposed to change once created
  147722. * @param name defines the name of the mesh
  147723. * @param options defines the options used to create the mesh
  147724. * @param scene defines the hosting scene
  147725. * @returns the plane mesh
  147726. * @see https://doc.babylonjs.com/how_to/set_shapes#plane
  147727. */
  147728. static CreatePlane(name: string, options: {
  147729. size?: number;
  147730. width?: number;
  147731. height?: number;
  147732. sideOrientation?: number;
  147733. frontUVs?: Vector4;
  147734. backUVs?: Vector4;
  147735. updatable?: boolean;
  147736. sourcePlane?: Plane;
  147737. }, scene?: Nullable<Scene>): Mesh;
  147738. /**
  147739. * Creates a ground mesh
  147740. * * The parameters `width` and `height` (floats, default 1) set the width and height sizes of the ground
  147741. * * The parameter `subdivisions` (positive integer) sets the number of subdivisions per side
  147742. * * The mesh can be set to updatable with the boolean parameter `updatable` (default false) if its internal geometry is supposed to change once created
  147743. * @param name defines the name of the mesh
  147744. * @param options defines the options used to create the mesh
  147745. * @param scene defines the hosting scene
  147746. * @returns the ground mesh
  147747. * @see https://doc.babylonjs.com/how_to/set_shapes#ground
  147748. */
  147749. static CreateGround(name: string, options: {
  147750. width?: number;
  147751. height?: number;
  147752. subdivisions?: number;
  147753. subdivisionsX?: number;
  147754. subdivisionsY?: number;
  147755. updatable?: boolean;
  147756. }, scene?: Nullable<Scene>): Mesh;
  147757. /**
  147758. * Creates a tiled ground mesh
  147759. * * The parameters `xmin` and `xmax` (floats, default -1 and 1) set the ground minimum and maximum X coordinates
  147760. * * The parameters `zmin` and `zmax` (floats, default -1 and 1) set the ground minimum and maximum Z coordinates
  147761. * * 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
  147762. * * 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
  147763. * * The mesh can be set to updatable with the boolean parameter `updatable` (default false) if its internal geometry is supposed to change once created.
  147764. * @param name defines the name of the mesh
  147765. * @param options defines the options used to create the mesh
  147766. * @param scene defines the hosting scene
  147767. * @returns the tiled ground mesh
  147768. * @see https://doc.babylonjs.com/how_to/set_shapes#tiled-ground
  147769. */
  147770. static CreateTiledGround(name: string, options: {
  147771. xmin: number;
  147772. zmin: number;
  147773. xmax: number;
  147774. zmax: number;
  147775. subdivisions?: {
  147776. w: number;
  147777. h: number;
  147778. };
  147779. precision?: {
  147780. w: number;
  147781. h: number;
  147782. };
  147783. updatable?: boolean;
  147784. }, scene?: Nullable<Scene>): Mesh;
  147785. /**
  147786. * Creates a ground mesh from a height map
  147787. * * The parameter `url` sets the URL of the height map image resource.
  147788. * * The parameters `width` and `height` (positive floats, default 10) set the ground width and height sizes.
  147789. * * The parameter `subdivisions` (positive integer, default 1) sets the number of subdivision per side.
  147790. * * The parameter `minHeight` (float, default 0) is the minimum altitude on the ground.
  147791. * * The parameter `maxHeight` (float, default 1) is the maximum altitude on the ground.
  147792. * * 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.
  147793. * * 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).
  147794. * * The parameter `alphaFilter` will filter any data where the alpha channel is below this value, defaults 0 (all data visible)
  147795. * * The mesh can be set to updatable with the boolean parameter `updatable` (default false) if its internal geometry is supposed to change once created.
  147796. * @param name defines the name of the mesh
  147797. * @param url defines the url to the height map
  147798. * @param options defines the options used to create the mesh
  147799. * @param scene defines the hosting scene
  147800. * @returns the ground mesh
  147801. * @see https://doc.babylonjs.com/babylon101/height_map
  147802. * @see https://doc.babylonjs.com/how_to/set_shapes#ground-from-a-height-map
  147803. */
  147804. static CreateGroundFromHeightMap(name: string, url: string, options: {
  147805. width?: number;
  147806. height?: number;
  147807. subdivisions?: number;
  147808. minHeight?: number;
  147809. maxHeight?: number;
  147810. colorFilter?: Color3;
  147811. alphaFilter?: number;
  147812. updatable?: boolean;
  147813. onReady?: (mesh: GroundMesh) => void;
  147814. }, scene?: Nullable<Scene>): GroundMesh;
  147815. /**
  147816. * Creates a polygon mesh
  147817. * The polygon's shape will depend on the input parameters and is constructed parallel to a ground mesh
  147818. * * 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
  147819. * * You can set the mesh side orientation with the values : Mesh.FRONTSIDE (default), Mesh.BACKSIDE or Mesh.DOUBLESIDE
  147820. * * The mesh can be set to updatable with the boolean parameter `updatable` (default false) if its internal geometry is supposed to change once created
  147821. * * If you create a double-sided mesh, you can choose what parts of the texture image to crop and stick respectively on the front and the back sides with the parameters `frontUVs` and `backUVs` (Vector4)
  147822. * * Remember you can only change the shape positions, not their number when updating a polygon
  147823. * @param name defines the name of the mesh
  147824. * @param options defines the options used to create the mesh
  147825. * @param scene defines the hosting scene
  147826. * @param earcutInjection can be used to inject your own earcut reference
  147827. * @returns the polygon mesh
  147828. */
  147829. static CreatePolygon(name: string, options: {
  147830. shape: Vector3[];
  147831. holes?: Vector3[][];
  147832. depth?: number;
  147833. faceUV?: Vector4[];
  147834. faceColors?: Color4[];
  147835. updatable?: boolean;
  147836. sideOrientation?: number;
  147837. frontUVs?: Vector4;
  147838. backUVs?: Vector4;
  147839. }, scene?: Nullable<Scene>, earcutInjection?: any): Mesh;
  147840. /**
  147841. * Creates an extruded polygon mesh, with depth in the Y direction.
  147842. * * 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)
  147843. * @see https://doc.babylonjs.com/how_to/createbox_per_face_textures_and_colors
  147844. * @param name defines the name of the mesh
  147845. * @param options defines the options used to create the mesh
  147846. * @param scene defines the hosting scene
  147847. * @param earcutInjection can be used to inject your own earcut reference
  147848. * @returns the polygon mesh
  147849. */
  147850. static ExtrudePolygon(name: string, options: {
  147851. shape: Vector3[];
  147852. holes?: Vector3[][];
  147853. depth?: number;
  147854. faceUV?: Vector4[];
  147855. faceColors?: Color4[];
  147856. updatable?: boolean;
  147857. sideOrientation?: number;
  147858. frontUVs?: Vector4;
  147859. backUVs?: Vector4;
  147860. wrap?: boolean;
  147861. }, scene?: Nullable<Scene>, earcutInjection?: any): Mesh;
  147862. /**
  147863. * Creates a tube mesh.
  147864. * The tube is a parametric shape. It has no predefined shape. Its final shape will depend on the input parameters
  147865. * * The parameter `path` is a required array of successive Vector3. It is the curve used as the axis of the tube
  147866. * * The parameter `radius` (positive float, default 1) sets the tube radius size
  147867. * * The parameter `tessellation` (positive float, default 64) is the number of sides on the tubular surface
  147868. * * The parameter `radiusFunction` (javascript function, default null) is a vanilla javascript function. If it is not null, it overwrittes the parameter `radius`
  147869. * * 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)
  147870. * * The parameter `arc` (positive float, maximum 1, default 1) is the ratio to apply to the tube circumference : 2 x PI x arc
  147871. * * 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
  147872. * * 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
  147873. * * You can also set the mesh side orientation with the values : BABYLON.Mesh.FRONTSIDE (default), BABYLON.Mesh.BACKSIDE or BABYLON.Mesh.DOUBLESIDE
  147874. * * If you create a double-sided mesh, you can choose what parts of the texture image to crop and stick respectively on the front and the back sides with the parameters `frontUVs` and `backUVs` (Vector4). Detail here : https://doc.babylonjs.com/babylon101/discover_basic_elements#side-orientation
  147875. * * The optional parameter `invertUV` (boolean, default false) swaps in the geometry the U and V coordinates to apply a texture
  147876. * * The mesh can be set to updatable with the boolean parameter `updatable` (default false) if its internal geometry is supposed to change once created
  147877. * @param name defines the name of the mesh
  147878. * @param options defines the options used to create the mesh
  147879. * @param scene defines the hosting scene
  147880. * @returns the tube mesh
  147881. * @see https://doc.babylonjs.com/how_to/parametric_shapes
  147882. * @see https://doc.babylonjs.com/how_to/set_shapes#tube
  147883. */
  147884. static CreateTube(name: string, options: {
  147885. path: Vector3[];
  147886. radius?: number;
  147887. tessellation?: number;
  147888. radiusFunction?: {
  147889. (i: number, distance: number): number;
  147890. };
  147891. cap?: number;
  147892. arc?: number;
  147893. updatable?: boolean;
  147894. sideOrientation?: number;
  147895. frontUVs?: Vector4;
  147896. backUVs?: Vector4;
  147897. instance?: Mesh;
  147898. invertUV?: boolean;
  147899. }, scene?: Nullable<Scene>): Mesh;
  147900. /**
  147901. * Creates a polyhedron mesh
  147902. * * 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
  147903. * * The parameter `size` (positive float, default 1) sets the polygon size
  147904. * * You can overwrite the `size` on each dimension bu using the parameters `sizeX`, `sizeY` or `sizeZ` (positive floats, default to `size` value)
  147905. * * 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`
  147906. * * 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
  147907. * * 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)`)
  147908. * * 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
  147909. * * 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
  147910. * * You can also set the mesh side orientation with the values : BABYLON.Mesh.FRONTSIDE (default), BABYLON.Mesh.BACKSIDE or BABYLON.Mesh.DOUBLESIDE
  147911. * * If you create a double-sided mesh, you can choose what parts of the texture image to crop and stick respectively on the front and the back sides with the parameters `frontUVs` and `backUVs` (Vector4). Detail here : https://doc.babylonjs.com/babylon101/discover_basic_elements#side-orientation
  147912. * * The mesh can be set to updatable with the boolean parameter `updatable` (default false) if its internal geometry is supposed to change once created
  147913. * @param name defines the name of the mesh
  147914. * @param options defines the options used to create the mesh
  147915. * @param scene defines the hosting scene
  147916. * @returns the polyhedron mesh
  147917. * @see https://doc.babylonjs.com/how_to/polyhedra_shapes
  147918. */
  147919. static CreatePolyhedron(name: string, options: {
  147920. type?: number;
  147921. size?: number;
  147922. sizeX?: number;
  147923. sizeY?: number;
  147924. sizeZ?: number;
  147925. custom?: any;
  147926. faceUV?: Vector4[];
  147927. faceColors?: Color4[];
  147928. flat?: boolean;
  147929. updatable?: boolean;
  147930. sideOrientation?: number;
  147931. frontUVs?: Vector4;
  147932. backUVs?: Vector4;
  147933. }, scene?: Nullable<Scene>): Mesh;
  147934. /**
  147935. * Creates a decal mesh.
  147936. * 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
  147937. * * The parameter `position` (Vector3, default `(0, 0, 0)`) sets the position of the decal in World coordinates
  147938. * * The parameter `normal` (Vector3, default `Vector3.Up`) sets the normal of the mesh where the decal is applied onto in World coordinates
  147939. * * The parameter `size` (Vector3, default `(1, 1, 1)`) sets the decal scaling
  147940. * * The parameter `angle` (float in radian, default 0) sets the angle to rotate the decal
  147941. * @param name defines the name of the mesh
  147942. * @param sourceMesh defines the mesh where the decal must be applied
  147943. * @param options defines the options used to create the mesh
  147944. * @param scene defines the hosting scene
  147945. * @returns the decal mesh
  147946. * @see https://doc.babylonjs.com/how_to/decals
  147947. */
  147948. static CreateDecal(name: string, sourceMesh: AbstractMesh, options: {
  147949. position?: Vector3;
  147950. normal?: Vector3;
  147951. size?: Vector3;
  147952. angle?: number;
  147953. }): Mesh;
  147954. /**
  147955. * Creates a Capsule Mesh
  147956. * @param name defines the name of the mesh.
  147957. * @param options the constructors options used to shape the mesh.
  147958. * @param scene defines the scene the mesh is scoped to.
  147959. * @returns the capsule mesh
  147960. * @see https://doc.babylonjs.com/how_to/capsule_shape
  147961. */
  147962. static CreateCapsule(name: string, options?: ICreateCapsuleOptions, scene?: Nullable<Scene>): Mesh;
  147963. }
  147964. }
  147965. declare module BABYLON {
  147966. /**
  147967. * A simplifier interface for future simplification implementations
  147968. * @see https://doc.babylonjs.com/how_to/in-browser_mesh_simplification
  147969. */
  147970. export interface ISimplifier {
  147971. /**
  147972. * Simplification of a given mesh according to the given settings.
  147973. * Since this requires computation, it is assumed that the function runs async.
  147974. * @param settings The settings of the simplification, including quality and distance
  147975. * @param successCallback A callback that will be called after the mesh was simplified.
  147976. * @param errorCallback in case of an error, this callback will be called. optional.
  147977. */
  147978. simplify(settings: ISimplificationSettings, successCallback: (simplifiedMeshes: Mesh) => void, errorCallback?: () => void): void;
  147979. }
  147980. /**
  147981. * Expected simplification settings.
  147982. * Quality should be between 0 and 1 (1 being 100%, 0 being 0%)
  147983. * @see https://doc.babylonjs.com/how_to/in-browser_mesh_simplification
  147984. */
  147985. export interface ISimplificationSettings {
  147986. /**
  147987. * Gets or sets the expected quality
  147988. */
  147989. quality: number;
  147990. /**
  147991. * Gets or sets the distance when this optimized version should be used
  147992. */
  147993. distance: number;
  147994. /**
  147995. * Gets an already optimized mesh
  147996. */
  147997. optimizeMesh?: boolean;
  147998. }
  147999. /**
  148000. * Class used to specify simplification options
  148001. * @see https://doc.babylonjs.com/how_to/in-browser_mesh_simplification
  148002. */
  148003. export class SimplificationSettings implements ISimplificationSettings {
  148004. /** expected quality */
  148005. quality: number;
  148006. /** distance when this optimized version should be used */
  148007. distance: number;
  148008. /** already optimized mesh */
  148009. optimizeMesh?: boolean | undefined;
  148010. /**
  148011. * Creates a SimplificationSettings
  148012. * @param quality expected quality
  148013. * @param distance distance when this optimized version should be used
  148014. * @param optimizeMesh already optimized mesh
  148015. */
  148016. constructor(
  148017. /** expected quality */
  148018. quality: number,
  148019. /** distance when this optimized version should be used */
  148020. distance: number,
  148021. /** already optimized mesh */
  148022. optimizeMesh?: boolean | undefined);
  148023. }
  148024. /**
  148025. * Interface used to define a simplification task
  148026. */
  148027. export interface ISimplificationTask {
  148028. /**
  148029. * Array of settings
  148030. */
  148031. settings: Array<ISimplificationSettings>;
  148032. /**
  148033. * Simplification type
  148034. */
  148035. simplificationType: SimplificationType;
  148036. /**
  148037. * Mesh to simplify
  148038. */
  148039. mesh: Mesh;
  148040. /**
  148041. * Callback called on success
  148042. */
  148043. successCallback?: () => void;
  148044. /**
  148045. * Defines if parallel processing can be used
  148046. */
  148047. parallelProcessing: boolean;
  148048. }
  148049. /**
  148050. * Queue used to order the simplification tasks
  148051. * @see https://doc.babylonjs.com/how_to/in-browser_mesh_simplification
  148052. */
  148053. export class SimplificationQueue {
  148054. private _simplificationArray;
  148055. /**
  148056. * Gets a boolean indicating that the process is still running
  148057. */
  148058. running: boolean;
  148059. /**
  148060. * Creates a new queue
  148061. */
  148062. constructor();
  148063. /**
  148064. * Adds a new simplification task
  148065. * @param task defines a task to add
  148066. */
  148067. addTask(task: ISimplificationTask): void;
  148068. /**
  148069. * Execute next task
  148070. */
  148071. executeNext(): void;
  148072. /**
  148073. * Execute a simplification task
  148074. * @param task defines the task to run
  148075. */
  148076. runSimplification(task: ISimplificationTask): void;
  148077. private getSimplifier;
  148078. }
  148079. /**
  148080. * The implemented types of simplification
  148081. * At the moment only Quadratic Error Decimation is implemented
  148082. * @see https://doc.babylonjs.com/how_to/in-browser_mesh_simplification
  148083. */
  148084. export enum SimplificationType {
  148085. /** Quadratic error decimation */
  148086. QUADRATIC = 0
  148087. }
  148088. /**
  148089. * An implementation of the Quadratic Error simplification algorithm.
  148090. * Original paper : http://www1.cs.columbia.edu/~cs4162/html05s/garland97.pdf
  148091. * Ported mostly from QSlim and http://voxels.blogspot.de/2014/05/quadric-mesh-simplification-with-source.html to babylon JS
  148092. * @author RaananW
  148093. * @see https://doc.babylonjs.com/how_to/in-browser_mesh_simplification
  148094. */
  148095. export class QuadraticErrorSimplification implements ISimplifier {
  148096. private _mesh;
  148097. private triangles;
  148098. private vertices;
  148099. private references;
  148100. private _reconstructedMesh;
  148101. /** Gets or sets the number pf sync interations */
  148102. syncIterations: number;
  148103. /** Gets or sets the aggressiveness of the simplifier */
  148104. aggressiveness: number;
  148105. /** Gets or sets the number of allowed iterations for decimation */
  148106. decimationIterations: number;
  148107. /** Gets or sets the espilon to use for bounding box computation */
  148108. boundingBoxEpsilon: number;
  148109. /**
  148110. * Creates a new QuadraticErrorSimplification
  148111. * @param _mesh defines the target mesh
  148112. */
  148113. constructor(_mesh: Mesh);
  148114. /**
  148115. * Simplification of a given mesh according to the given settings.
  148116. * Since this requires computation, it is assumed that the function runs async.
  148117. * @param settings The settings of the simplification, including quality and distance
  148118. * @param successCallback A callback that will be called after the mesh was simplified.
  148119. */
  148120. simplify(settings: ISimplificationSettings, successCallback: (simplifiedMesh: Mesh) => void): void;
  148121. private runDecimation;
  148122. private initWithMesh;
  148123. private init;
  148124. private reconstructMesh;
  148125. private initDecimatedMesh;
  148126. private isFlipped;
  148127. private updateTriangles;
  148128. private identifyBorder;
  148129. private updateMesh;
  148130. private vertexError;
  148131. private calculateError;
  148132. }
  148133. }
  148134. declare module BABYLON {
  148135. interface Scene {
  148136. /** @hidden (Backing field) */
  148137. _simplificationQueue: SimplificationQueue;
  148138. /**
  148139. * Gets or sets the simplification queue attached to the scene
  148140. * @see https://doc.babylonjs.com/how_to/in-browser_mesh_simplification
  148141. */
  148142. simplificationQueue: SimplificationQueue;
  148143. }
  148144. interface Mesh {
  148145. /**
  148146. * Simplify the mesh according to the given array of settings.
  148147. * Function will return immediately and will simplify async
  148148. * @param settings a collection of simplification settings
  148149. * @param parallelProcessing should all levels calculate parallel or one after the other
  148150. * @param simplificationType the type of simplification to run
  148151. * @param successCallback optional success callback to be called after the simplification finished processing all settings
  148152. * @returns the current mesh
  148153. */
  148154. simplify(settings: Array<ISimplificationSettings>, parallelProcessing?: boolean, simplificationType?: SimplificationType, successCallback?: (mesh?: Mesh, submeshIndex?: number) => void): Mesh;
  148155. }
  148156. /**
  148157. * Defines the simplification queue scene component responsible to help scheduling the various simplification task
  148158. * created in a scene
  148159. */
  148160. export class SimplicationQueueSceneComponent implements ISceneComponent {
  148161. /**
  148162. * The component name helpfull to identify the component in the list of scene components.
  148163. */
  148164. readonly name: string;
  148165. /**
  148166. * The scene the component belongs to.
  148167. */
  148168. scene: Scene;
  148169. /**
  148170. * Creates a new instance of the component for the given scene
  148171. * @param scene Defines the scene to register the component in
  148172. */
  148173. constructor(scene: Scene);
  148174. /**
  148175. * Registers the component in a given scene
  148176. */
  148177. register(): void;
  148178. /**
  148179. * Rebuilds the elements related to this component in case of
  148180. * context lost for instance.
  148181. */
  148182. rebuild(): void;
  148183. /**
  148184. * Disposes the component and the associated ressources
  148185. */
  148186. dispose(): void;
  148187. private _beforeCameraUpdate;
  148188. }
  148189. }
  148190. declare module BABYLON {
  148191. interface Mesh {
  148192. /**
  148193. * Gets or sets a boolean defining if we want picking to pick thin instances as well
  148194. */
  148195. thinInstanceEnablePicking: boolean;
  148196. /**
  148197. * Creates a new thin instance
  148198. * @param matrix the matrix or array of matrices (position, rotation, scale) of the thin instance(s) to create
  148199. * @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
  148200. * @returns the thin instance index number. If you pass an array of matrices, other instance indexes are index+1, index+2, etc
  148201. */
  148202. thinInstanceAdd(matrix: DeepImmutableObject<Matrix> | Array<DeepImmutableObject<Matrix>>, refresh: boolean): number;
  148203. /**
  148204. * Adds the transformation (matrix) of the current mesh as a thin instance
  148205. * @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
  148206. * @returns the thin instance index number
  148207. */
  148208. thinInstanceAddSelf(refresh: boolean): number;
  148209. /**
  148210. * Registers a custom attribute to be used with thin instances
  148211. * @param kind name of the attribute
  148212. * @param stride size in floats of the attribute
  148213. */
  148214. thinInstanceRegisterAttribute(kind: string, stride: number): void;
  148215. /**
  148216. * Sets the matrix of a thin instance
  148217. * @param index index of the thin instance
  148218. * @param matrix matrix to set
  148219. * @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
  148220. */
  148221. thinInstanceSetMatrixAt(index: number, matrix: DeepImmutableObject<Matrix>, refresh: boolean): void;
  148222. /**
  148223. * Sets the value of a custom attribute for a thin instance
  148224. * @param kind name of the attribute
  148225. * @param index index of the thin instance
  148226. * @param value value to set
  148227. * @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
  148228. */
  148229. thinInstanceSetAttributeAt(kind: string, index: number, value: Array<number>, refresh: boolean): void;
  148230. /**
  148231. * 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.
  148232. */
  148233. thinInstanceCount: number;
  148234. /**
  148235. * Sets a buffer to be used with thin instances. This method is a faster way to setup multiple instances than calling thinInstanceAdd repeatedly
  148236. * @param kind name of the attribute. Use "matrix" to setup the buffer of matrices
  148237. * @param buffer buffer to set
  148238. * @param stride size in floats of each value of the buffer
  148239. * @param staticBuffer indicates that the buffer is static, so that you won't change it after it is set (better performances - false by default)
  148240. */
  148241. thinInstanceSetBuffer(kind: string, buffer: Nullable<Float32Array>, stride: number, staticBuffer: boolean): void;
  148242. /**
  148243. * Gets the list of world matrices
  148244. * @return an array containing all the world matrices from the thin instances
  148245. */
  148246. thinInstanceGetWorldMatrices(): Matrix[];
  148247. /**
  148248. * Synchronize the gpu buffers with a thin instance buffer. Call this method if you update later on the buffers passed to thinInstanceSetBuffer
  148249. * @param kind name of the attribute to update. Use "matrix" to update the buffer of matrices
  148250. */
  148251. thinInstanceBufferUpdated(kind: string): void;
  148252. /**
  148253. * Applies a partial update to a buffer directly on the GPU
  148254. * Note that the buffer located on the CPU is NOT updated! It's up to you to update it (or not) with the same data you pass to this method
  148255. * @param kind name of the attribute to update. Use "matrix" to update the buffer of matrices
  148256. * @param data the data to set in the GPU buffer
  148257. * @param offset the offset in the GPU buffer where to update the data
  148258. */
  148259. thinInstancePartialBufferUpdate(kind: string, data: Float32Array, offset: number): void;
  148260. /**
  148261. * Refreshes the bounding info, taking into account all the thin instances defined
  148262. * @param forceRefreshParentInfo true to force recomputing the mesh bounding info and use it to compute the aggregated bounding info
  148263. */
  148264. thinInstanceRefreshBoundingInfo(forceRefreshParentInfo: boolean): void;
  148265. /** @hidden */
  148266. _thinInstanceInitializeUserStorage(): void;
  148267. /** @hidden */
  148268. _thinInstanceUpdateBufferSize(kind: string, numInstances: number): void;
  148269. /** @hidden */
  148270. _userThinInstanceBuffersStorage: {
  148271. data: {
  148272. [key: string]: Float32Array;
  148273. };
  148274. sizes: {
  148275. [key: string]: number;
  148276. };
  148277. vertexBuffers: {
  148278. [key: string]: Nullable<VertexBuffer>;
  148279. };
  148280. strides: {
  148281. [key: string]: number;
  148282. };
  148283. };
  148284. }
  148285. }
  148286. declare module BABYLON {
  148287. /**
  148288. * Navigation plugin interface to add navigation constrained by a navigation mesh
  148289. */
  148290. export interface INavigationEnginePlugin {
  148291. /**
  148292. * plugin name
  148293. */
  148294. name: string;
  148295. /**
  148296. * Creates a navigation mesh
  148297. * @param meshes array of all the geometry used to compute the navigatio mesh
  148298. * @param parameters bunch of parameters used to filter geometry
  148299. */
  148300. createNavMesh(meshes: Array<Mesh>, parameters: INavMeshParameters): void;
  148301. /**
  148302. * Create a navigation mesh debug mesh
  148303. * @param scene is where the mesh will be added
  148304. * @returns debug display mesh
  148305. */
  148306. createDebugNavMesh(scene: Scene): Mesh;
  148307. /**
  148308. * Get a navigation mesh constrained position, closest to the parameter position
  148309. * @param position world position
  148310. * @returns the closest point to position constrained by the navigation mesh
  148311. */
  148312. getClosestPoint(position: Vector3): Vector3;
  148313. /**
  148314. * Get a navigation mesh constrained position, closest to the parameter position
  148315. * @param position world position
  148316. * @param result output the closest point to position constrained by the navigation mesh
  148317. */
  148318. getClosestPointToRef(position: Vector3, result: Vector3): void;
  148319. /**
  148320. * Get a navigation mesh constrained position, within a particular radius
  148321. * @param position world position
  148322. * @param maxRadius the maximum distance to the constrained world position
  148323. * @returns the closest point to position constrained by the navigation mesh
  148324. */
  148325. getRandomPointAround(position: Vector3, maxRadius: number): Vector3;
  148326. /**
  148327. * Get a navigation mesh constrained position, within a particular radius
  148328. * @param position world position
  148329. * @param maxRadius the maximum distance to the constrained world position
  148330. * @param result output the closest point to position constrained by the navigation mesh
  148331. */
  148332. getRandomPointAroundToRef(position: Vector3, maxRadius: number, result: Vector3): void;
  148333. /**
  148334. * Compute the final position from a segment made of destination-position
  148335. * @param position world position
  148336. * @param destination world position
  148337. * @returns the resulting point along the navmesh
  148338. */
  148339. moveAlong(position: Vector3, destination: Vector3): Vector3;
  148340. /**
  148341. * Compute the final position from a segment made of destination-position
  148342. * @param position world position
  148343. * @param destination world position
  148344. * @param result output the resulting point along the navmesh
  148345. */
  148346. moveAlongToRef(position: Vector3, destination: Vector3, result: Vector3): void;
  148347. /**
  148348. * Compute a navigation path from start to end. Returns an empty array if no path can be computed
  148349. * @param start world position
  148350. * @param end world position
  148351. * @returns array containing world position composing the path
  148352. */
  148353. computePath(start: Vector3, end: Vector3): Vector3[];
  148354. /**
  148355. * If this plugin is supported
  148356. * @returns true if plugin is supported
  148357. */
  148358. isSupported(): boolean;
  148359. /**
  148360. * Create a new Crowd so you can add agents
  148361. * @param maxAgents the maximum agent count in the crowd
  148362. * @param maxAgentRadius the maximum radius an agent can have
  148363. * @param scene to attach the crowd to
  148364. * @returns the crowd you can add agents to
  148365. */
  148366. createCrowd(maxAgents: number, maxAgentRadius: number, scene: Scene): ICrowd;
  148367. /**
  148368. * Set the Bounding box extent for doing spatial queries (getClosestPoint, getRandomPointAround, ...)
  148369. * The queries will try to find a solution within those bounds
  148370. * default is (1,1,1)
  148371. * @param extent x,y,z value that define the extent around the queries point of reference
  148372. */
  148373. setDefaultQueryExtent(extent: Vector3): void;
  148374. /**
  148375. * Get the Bounding box extent specified by setDefaultQueryExtent
  148376. * @returns the box extent values
  148377. */
  148378. getDefaultQueryExtent(): Vector3;
  148379. /**
  148380. * build the navmesh from a previously saved state using getNavmeshData
  148381. * @param data the Uint8Array returned by getNavmeshData
  148382. */
  148383. buildFromNavmeshData(data: Uint8Array): void;
  148384. /**
  148385. * returns the navmesh data that can be used later. The navmesh must be built before retrieving the data
  148386. * @returns data the Uint8Array that can be saved and reused
  148387. */
  148388. getNavmeshData(): Uint8Array;
  148389. /**
  148390. * Get the Bounding box extent result specified by setDefaultQueryExtent
  148391. * @param result output the box extent values
  148392. */
  148393. getDefaultQueryExtentToRef(result: Vector3): void;
  148394. /**
  148395. * Release all resources
  148396. */
  148397. dispose(): void;
  148398. }
  148399. /**
  148400. * Crowd Interface. A Crowd is a collection of moving agents constrained by a navigation mesh
  148401. */
  148402. export interface ICrowd {
  148403. /**
  148404. * Add a new agent to the crowd with the specified parameter a corresponding transformNode.
  148405. * You can attach anything to that node. The node position is updated in the scene update tick.
  148406. * @param pos world position that will be constrained by the navigation mesh
  148407. * @param parameters agent parameters
  148408. * @param transform hooked to the agent that will be update by the scene
  148409. * @returns agent index
  148410. */
  148411. addAgent(pos: Vector3, parameters: IAgentParameters, transform: TransformNode): number;
  148412. /**
  148413. * Returns the agent position in world space
  148414. * @param index agent index returned by addAgent
  148415. * @returns world space position
  148416. */
  148417. getAgentPosition(index: number): Vector3;
  148418. /**
  148419. * Gets the agent position result in world space
  148420. * @param index agent index returned by addAgent
  148421. * @param result output world space position
  148422. */
  148423. getAgentPositionToRef(index: number, result: Vector3): void;
  148424. /**
  148425. * Gets the agent velocity in world space
  148426. * @param index agent index returned by addAgent
  148427. * @returns world space velocity
  148428. */
  148429. getAgentVelocity(index: number): Vector3;
  148430. /**
  148431. * Gets the agent velocity result in world space
  148432. * @param index agent index returned by addAgent
  148433. * @param result output world space velocity
  148434. */
  148435. getAgentVelocityToRef(index: number, result: Vector3): void;
  148436. /**
  148437. * remove a particular agent previously created
  148438. * @param index agent index returned by addAgent
  148439. */
  148440. removeAgent(index: number): void;
  148441. /**
  148442. * get the list of all agents attached to this crowd
  148443. * @returns list of agent indices
  148444. */
  148445. getAgents(): number[];
  148446. /**
  148447. * Tick update done by the Scene. Agent position/velocity/acceleration is updated by this function
  148448. * @param deltaTime in seconds
  148449. */
  148450. update(deltaTime: number): void;
  148451. /**
  148452. * Asks a particular agent to go to a destination. That destination is constrained by the navigation mesh
  148453. * @param index agent index returned by addAgent
  148454. * @param destination targeted world position
  148455. */
  148456. agentGoto(index: number, destination: Vector3): void;
  148457. /**
  148458. * Teleport the agent to a new position
  148459. * @param index agent index returned by addAgent
  148460. * @param destination targeted world position
  148461. */
  148462. agentTeleport(index: number, destination: Vector3): void;
  148463. /**
  148464. * Update agent parameters
  148465. * @param index agent index returned by addAgent
  148466. * @param parameters agent parameters
  148467. */
  148468. updateAgentParameters(index: number, parameters: IAgentParameters): void;
  148469. /**
  148470. * Set the Bounding box extent for doing spatial queries (getClosestPoint, getRandomPointAround, ...)
  148471. * The queries will try to find a solution within those bounds
  148472. * default is (1,1,1)
  148473. * @param extent x,y,z value that define the extent around the queries point of reference
  148474. */
  148475. setDefaultQueryExtent(extent: Vector3): void;
  148476. /**
  148477. * Get the Bounding box extent specified by setDefaultQueryExtent
  148478. * @returns the box extent values
  148479. */
  148480. getDefaultQueryExtent(): Vector3;
  148481. /**
  148482. * Get the Bounding box extent result specified by setDefaultQueryExtent
  148483. * @param result output the box extent values
  148484. */
  148485. getDefaultQueryExtentToRef(result: Vector3): void;
  148486. /**
  148487. * Release all resources
  148488. */
  148489. dispose(): void;
  148490. }
  148491. /**
  148492. * Configures an agent
  148493. */
  148494. export interface IAgentParameters {
  148495. /**
  148496. * Agent radius. [Limit: >= 0]
  148497. */
  148498. radius: number;
  148499. /**
  148500. * Agent height. [Limit: > 0]
  148501. */
  148502. height: number;
  148503. /**
  148504. * Maximum allowed acceleration. [Limit: >= 0]
  148505. */
  148506. maxAcceleration: number;
  148507. /**
  148508. * Maximum allowed speed. [Limit: >= 0]
  148509. */
  148510. maxSpeed: number;
  148511. /**
  148512. * Defines how close a collision element must be before it is considered for steering behaviors. [Limits: > 0]
  148513. */
  148514. collisionQueryRange: number;
  148515. /**
  148516. * The path visibility optimization range. [Limit: > 0]
  148517. */
  148518. pathOptimizationRange: number;
  148519. /**
  148520. * How aggresive the agent manager should be at avoiding collisions with this agent. [Limit: >= 0]
  148521. */
  148522. separationWeight: number;
  148523. }
  148524. /**
  148525. * Configures the navigation mesh creation
  148526. */
  148527. export interface INavMeshParameters {
  148528. /**
  148529. * The xz-plane cell size to use for fields. [Limit: > 0] [Units: wu]
  148530. */
  148531. cs: number;
  148532. /**
  148533. * The y-axis cell size to use for fields. [Limit: > 0] [Units: wu]
  148534. */
  148535. ch: number;
  148536. /**
  148537. * The maximum slope that is considered walkable. [Limits: 0 <= value < 90] [Units: Degrees]
  148538. */
  148539. walkableSlopeAngle: number;
  148540. /**
  148541. * Minimum floor to 'ceiling' height that will still allow the floor area to
  148542. * be considered walkable. [Limit: >= 3] [Units: vx]
  148543. */
  148544. walkableHeight: number;
  148545. /**
  148546. * Maximum ledge height that is considered to still be traversable. [Limit: >=0] [Units: vx]
  148547. */
  148548. walkableClimb: number;
  148549. /**
  148550. * The distance to erode/shrink the walkable area of the heightfield away from
  148551. * obstructions. [Limit: >=0] [Units: vx]
  148552. */
  148553. walkableRadius: number;
  148554. /**
  148555. * The maximum allowed length for contour edges along the border of the mesh. [Limit: >=0] [Units: vx]
  148556. */
  148557. maxEdgeLen: number;
  148558. /**
  148559. * The maximum distance a simplfied contour's border edges should deviate
  148560. * the original raw contour. [Limit: >=0] [Units: vx]
  148561. */
  148562. maxSimplificationError: number;
  148563. /**
  148564. * The minimum number of cells allowed to form isolated island areas. [Limit: >=0] [Units: vx]
  148565. */
  148566. minRegionArea: number;
  148567. /**
  148568. * Any regions with a span count smaller than this value will, if possible,
  148569. * be merged with larger regions. [Limit: >=0] [Units: vx]
  148570. */
  148571. mergeRegionArea: number;
  148572. /**
  148573. * The maximum number of vertices allowed for polygons generated during the
  148574. * contour to polygon conversion process. [Limit: >= 3]
  148575. */
  148576. maxVertsPerPoly: number;
  148577. /**
  148578. * Sets the sampling distance to use when generating the detail mesh.
  148579. * (For height detail only.) [Limits: 0 or >= 0.9] [Units: wu]
  148580. */
  148581. detailSampleDist: number;
  148582. /**
  148583. * The maximum distance the detail mesh surface should deviate from heightfield
  148584. * data. (For height detail only.) [Limit: >=0] [Units: wu]
  148585. */
  148586. detailSampleMaxError: number;
  148587. }
  148588. }
  148589. declare module BABYLON {
  148590. /**
  148591. * RecastJS navigation plugin
  148592. */
  148593. export class RecastJSPlugin implements INavigationEnginePlugin {
  148594. /**
  148595. * Reference to the Recast library
  148596. */
  148597. bjsRECAST: any;
  148598. /**
  148599. * plugin name
  148600. */
  148601. name: string;
  148602. /**
  148603. * the first navmesh created. We might extend this to support multiple navmeshes
  148604. */
  148605. navMesh: any;
  148606. /**
  148607. * Initializes the recastJS plugin
  148608. * @param recastInjection can be used to inject your own recast reference
  148609. */
  148610. constructor(recastInjection?: any);
  148611. /**
  148612. * Creates a navigation mesh
  148613. * @param meshes array of all the geometry used to compute the navigatio mesh
  148614. * @param parameters bunch of parameters used to filter geometry
  148615. */
  148616. createNavMesh(meshes: Array<Mesh>, parameters: INavMeshParameters): void;
  148617. /**
  148618. * Create a navigation mesh debug mesh
  148619. * @param scene is where the mesh will be added
  148620. * @returns debug display mesh
  148621. */
  148622. createDebugNavMesh(scene: Scene): Mesh;
  148623. /**
  148624. * Get a navigation mesh constrained position, closest to the parameter position
  148625. * @param position world position
  148626. * @returns the closest point to position constrained by the navigation mesh
  148627. */
  148628. getClosestPoint(position: Vector3): Vector3;
  148629. /**
  148630. * Get a navigation mesh constrained position, closest to the parameter position
  148631. * @param position world position
  148632. * @param result output the closest point to position constrained by the navigation mesh
  148633. */
  148634. getClosestPointToRef(position: Vector3, result: Vector3): void;
  148635. /**
  148636. * Get a navigation mesh constrained position, within a particular radius
  148637. * @param position world position
  148638. * @param maxRadius the maximum distance to the constrained world position
  148639. * @returns the closest point to position constrained by the navigation mesh
  148640. */
  148641. getRandomPointAround(position: Vector3, maxRadius: number): Vector3;
  148642. /**
  148643. * Get a navigation mesh constrained position, within a particular radius
  148644. * @param position world position
  148645. * @param maxRadius the maximum distance to the constrained world position
  148646. * @param result output the closest point to position constrained by the navigation mesh
  148647. */
  148648. getRandomPointAroundToRef(position: Vector3, maxRadius: number, result: Vector3): void;
  148649. /**
  148650. * Compute the final position from a segment made of destination-position
  148651. * @param position world position
  148652. * @param destination world position
  148653. * @returns the resulting point along the navmesh
  148654. */
  148655. moveAlong(position: Vector3, destination: Vector3): Vector3;
  148656. /**
  148657. * Compute the final position from a segment made of destination-position
  148658. * @param position world position
  148659. * @param destination world position
  148660. * @param result output the resulting point along the navmesh
  148661. */
  148662. moveAlongToRef(position: Vector3, destination: Vector3, result: Vector3): void;
  148663. /**
  148664. * Compute a navigation path from start to end. Returns an empty array if no path can be computed
  148665. * @param start world position
  148666. * @param end world position
  148667. * @returns array containing world position composing the path
  148668. */
  148669. computePath(start: Vector3, end: Vector3): Vector3[];
  148670. /**
  148671. * Create a new Crowd so you can add agents
  148672. * @param maxAgents the maximum agent count in the crowd
  148673. * @param maxAgentRadius the maximum radius an agent can have
  148674. * @param scene to attach the crowd to
  148675. * @returns the crowd you can add agents to
  148676. */
  148677. createCrowd(maxAgents: number, maxAgentRadius: number, scene: Scene): ICrowd;
  148678. /**
  148679. * Set the Bounding box extent for doing spatial queries (getClosestPoint, getRandomPointAround, ...)
  148680. * The queries will try to find a solution within those bounds
  148681. * default is (1,1,1)
  148682. * @param extent x,y,z value that define the extent around the queries point of reference
  148683. */
  148684. setDefaultQueryExtent(extent: Vector3): void;
  148685. /**
  148686. * Get the Bounding box extent specified by setDefaultQueryExtent
  148687. * @returns the box extent values
  148688. */
  148689. getDefaultQueryExtent(): Vector3;
  148690. /**
  148691. * build the navmesh from a previously saved state using getNavmeshData
  148692. * @param data the Uint8Array returned by getNavmeshData
  148693. */
  148694. buildFromNavmeshData(data: Uint8Array): void;
  148695. /**
  148696. * returns the navmesh data that can be used later. The navmesh must be built before retrieving the data
  148697. * @returns data the Uint8Array that can be saved and reused
  148698. */
  148699. getNavmeshData(): Uint8Array;
  148700. /**
  148701. * Get the Bounding box extent result specified by setDefaultQueryExtent
  148702. * @param result output the box extent values
  148703. */
  148704. getDefaultQueryExtentToRef(result: Vector3): void;
  148705. /**
  148706. * Disposes
  148707. */
  148708. dispose(): void;
  148709. /**
  148710. * If this plugin is supported
  148711. * @returns true if plugin is supported
  148712. */
  148713. isSupported(): boolean;
  148714. }
  148715. /**
  148716. * Recast detour crowd implementation
  148717. */
  148718. export class RecastJSCrowd implements ICrowd {
  148719. /**
  148720. * Recast/detour plugin
  148721. */
  148722. bjsRECASTPlugin: RecastJSPlugin;
  148723. /**
  148724. * Link to the detour crowd
  148725. */
  148726. recastCrowd: any;
  148727. /**
  148728. * One transform per agent
  148729. */
  148730. transforms: TransformNode[];
  148731. /**
  148732. * All agents created
  148733. */
  148734. agents: number[];
  148735. /**
  148736. * Link to the scene is kept to unregister the crowd from the scene
  148737. */
  148738. private _scene;
  148739. /**
  148740. * Observer for crowd updates
  148741. */
  148742. private _onBeforeAnimationsObserver;
  148743. /**
  148744. * Constructor
  148745. * @param plugin recastJS plugin
  148746. * @param maxAgents the maximum agent count in the crowd
  148747. * @param maxAgentRadius the maximum radius an agent can have
  148748. * @param scene to attach the crowd to
  148749. * @returns the crowd you can add agents to
  148750. */
  148751. constructor(plugin: RecastJSPlugin, maxAgents: number, maxAgentRadius: number, scene: Scene);
  148752. /**
  148753. * Add a new agent to the crowd with the specified parameter a corresponding transformNode.
  148754. * You can attach anything to that node. The node position is updated in the scene update tick.
  148755. * @param pos world position that will be constrained by the navigation mesh
  148756. * @param parameters agent parameters
  148757. * @param transform hooked to the agent that will be update by the scene
  148758. * @returns agent index
  148759. */
  148760. addAgent(pos: Vector3, parameters: IAgentParameters, transform: TransformNode): number;
  148761. /**
  148762. * Returns the agent position in world space
  148763. * @param index agent index returned by addAgent
  148764. * @returns world space position
  148765. */
  148766. getAgentPosition(index: number): Vector3;
  148767. /**
  148768. * Returns the agent position result in world space
  148769. * @param index agent index returned by addAgent
  148770. * @param result output world space position
  148771. */
  148772. getAgentPositionToRef(index: number, result: Vector3): void;
  148773. /**
  148774. * Returns the agent velocity in world space
  148775. * @param index agent index returned by addAgent
  148776. * @returns world space velocity
  148777. */
  148778. getAgentVelocity(index: number): Vector3;
  148779. /**
  148780. * Returns the agent velocity result in world space
  148781. * @param index agent index returned by addAgent
  148782. * @param result output world space velocity
  148783. */
  148784. getAgentVelocityToRef(index: number, result: Vector3): void;
  148785. /**
  148786. * Asks a particular agent to go to a destination. That destination is constrained by the navigation mesh
  148787. * @param index agent index returned by addAgent
  148788. * @param destination targeted world position
  148789. */
  148790. agentGoto(index: number, destination: Vector3): void;
  148791. /**
  148792. * Teleport the agent to a new position
  148793. * @param index agent index returned by addAgent
  148794. * @param destination targeted world position
  148795. */
  148796. agentTeleport(index: number, destination: Vector3): void;
  148797. /**
  148798. * Update agent parameters
  148799. * @param index agent index returned by addAgent
  148800. * @param parameters agent parameters
  148801. */
  148802. updateAgentParameters(index: number, parameters: IAgentParameters): void;
  148803. /**
  148804. * remove a particular agent previously created
  148805. * @param index agent index returned by addAgent
  148806. */
  148807. removeAgent(index: number): void;
  148808. /**
  148809. * get the list of all agents attached to this crowd
  148810. * @returns list of agent indices
  148811. */
  148812. getAgents(): number[];
  148813. /**
  148814. * Tick update done by the Scene. Agent position/velocity/acceleration is updated by this function
  148815. * @param deltaTime in seconds
  148816. */
  148817. update(deltaTime: number): void;
  148818. /**
  148819. * Set the Bounding box extent for doing spatial queries (getClosestPoint, getRandomPointAround, ...)
  148820. * The queries will try to find a solution within those bounds
  148821. * default is (1,1,1)
  148822. * @param extent x,y,z value that define the extent around the queries point of reference
  148823. */
  148824. setDefaultQueryExtent(extent: Vector3): void;
  148825. /**
  148826. * Get the Bounding box extent specified by setDefaultQueryExtent
  148827. * @returns the box extent values
  148828. */
  148829. getDefaultQueryExtent(): Vector3;
  148830. /**
  148831. * Get the Bounding box extent result specified by setDefaultQueryExtent
  148832. * @param result output the box extent values
  148833. */
  148834. getDefaultQueryExtentToRef(result: Vector3): void;
  148835. /**
  148836. * Release all resources
  148837. */
  148838. dispose(): void;
  148839. }
  148840. }
  148841. declare module BABYLON {
  148842. /**
  148843. * Class used to enable access to IndexedDB
  148844. * @see https://doc.babylonjs.com/how_to/caching_resources_in_indexeddb
  148845. */
  148846. export class Database implements IOfflineProvider {
  148847. private _callbackManifestChecked;
  148848. private _currentSceneUrl;
  148849. private _db;
  148850. private _enableSceneOffline;
  148851. private _enableTexturesOffline;
  148852. private _manifestVersionFound;
  148853. private _mustUpdateRessources;
  148854. private _hasReachedQuota;
  148855. private _isSupported;
  148856. private _idbFactory;
  148857. /** Gets a boolean indicating if the user agent supports blob storage (this value will be updated after creating the first Database object) */
  148858. private static IsUASupportingBlobStorage;
  148859. /**
  148860. * Gets a boolean indicating if Database storate is enabled (off by default)
  148861. */
  148862. static IDBStorageEnabled: boolean;
  148863. /**
  148864. * Gets a boolean indicating if scene must be saved in the database
  148865. */
  148866. get enableSceneOffline(): boolean;
  148867. /**
  148868. * Gets a boolean indicating if textures must be saved in the database
  148869. */
  148870. get enableTexturesOffline(): boolean;
  148871. /**
  148872. * Creates a new Database
  148873. * @param urlToScene defines the url to load the scene
  148874. * @param callbackManifestChecked defines the callback to use when manifest is checked
  148875. * @param disableManifestCheck defines a boolean indicating that we want to skip the manifest validation (it will be considered validated and up to date)
  148876. */
  148877. constructor(urlToScene: string, callbackManifestChecked: (checked: boolean) => any, disableManifestCheck?: boolean);
  148878. private static _ParseURL;
  148879. private static _ReturnFullUrlLocation;
  148880. private _checkManifestFile;
  148881. /**
  148882. * Open the database and make it available
  148883. * @param successCallback defines the callback to call on success
  148884. * @param errorCallback defines the callback to call on error
  148885. */
  148886. open(successCallback: () => void, errorCallback: () => void): void;
  148887. /**
  148888. * Loads an image from the database
  148889. * @param url defines the url to load from
  148890. * @param image defines the target DOM image
  148891. */
  148892. loadImage(url: string, image: HTMLImageElement): void;
  148893. private _loadImageFromDBAsync;
  148894. private _saveImageIntoDBAsync;
  148895. private _checkVersionFromDB;
  148896. private _loadVersionFromDBAsync;
  148897. private _saveVersionIntoDBAsync;
  148898. /**
  148899. * Loads a file from database
  148900. * @param url defines the URL to load from
  148901. * @param sceneLoaded defines a callback to call on success
  148902. * @param progressCallBack defines a callback to call when progress changed
  148903. * @param errorCallback defines a callback to call on error
  148904. * @param useArrayBuffer defines a boolean to use array buffer instead of text string
  148905. */
  148906. loadFile(url: string, sceneLoaded: (data: any) => void, progressCallBack?: (data: any) => void, errorCallback?: () => void, useArrayBuffer?: boolean): void;
  148907. private _loadFileAsync;
  148908. private _saveFileAsync;
  148909. /**
  148910. * Validates if xhr data is correct
  148911. * @param xhr defines the request to validate
  148912. * @param dataType defines the expected data type
  148913. * @returns true if data is correct
  148914. */
  148915. private static _ValidateXHRData;
  148916. }
  148917. }
  148918. declare module BABYLON {
  148919. /** @hidden */
  148920. export var gpuUpdateParticlesPixelShader: {
  148921. name: string;
  148922. shader: string;
  148923. };
  148924. }
  148925. declare module BABYLON {
  148926. /** @hidden */
  148927. export var gpuUpdateParticlesVertexShader: {
  148928. name: string;
  148929. shader: string;
  148930. };
  148931. }
  148932. declare module BABYLON {
  148933. /** @hidden */
  148934. export var clipPlaneFragmentDeclaration2: {
  148935. name: string;
  148936. shader: string;
  148937. };
  148938. }
  148939. declare module BABYLON {
  148940. /** @hidden */
  148941. export var gpuRenderParticlesPixelShader: {
  148942. name: string;
  148943. shader: string;
  148944. };
  148945. }
  148946. declare module BABYLON {
  148947. /** @hidden */
  148948. export var clipPlaneVertexDeclaration2: {
  148949. name: string;
  148950. shader: string;
  148951. };
  148952. }
  148953. declare module BABYLON {
  148954. /** @hidden */
  148955. export var gpuRenderParticlesVertexShader: {
  148956. name: string;
  148957. shader: string;
  148958. };
  148959. }
  148960. declare module BABYLON {
  148961. /**
  148962. * This represents a GPU particle system in Babylon
  148963. * This is the fastest particle system in Babylon as it uses the GPU to update the individual particle data
  148964. * @see https://www.babylonjs-playground.com/#PU4WYI#4
  148965. */
  148966. export class GPUParticleSystem extends BaseParticleSystem implements IDisposable, IParticleSystem, IAnimatable {
  148967. /**
  148968. * The layer mask we are rendering the particles through.
  148969. */
  148970. layerMask: number;
  148971. private _capacity;
  148972. private _activeCount;
  148973. private _currentActiveCount;
  148974. private _accumulatedCount;
  148975. private _renderEffect;
  148976. private _updateEffect;
  148977. private _buffer0;
  148978. private _buffer1;
  148979. private _spriteBuffer;
  148980. private _updateVAO;
  148981. private _renderVAO;
  148982. private _targetIndex;
  148983. private _sourceBuffer;
  148984. private _targetBuffer;
  148985. private _currentRenderId;
  148986. private _started;
  148987. private _stopped;
  148988. private _timeDelta;
  148989. private _randomTexture;
  148990. private _randomTexture2;
  148991. private _attributesStrideSize;
  148992. private _updateEffectOptions;
  148993. private _randomTextureSize;
  148994. private _actualFrame;
  148995. private _customEffect;
  148996. private readonly _rawTextureWidth;
  148997. /**
  148998. * Gets a boolean indicating if the GPU particles can be rendered on current browser
  148999. */
  149000. static get IsSupported(): boolean;
  149001. /**
  149002. * An event triggered when the system is disposed.
  149003. */
  149004. onDisposeObservable: Observable<IParticleSystem>;
  149005. /**
  149006. * An event triggered when the system is stopped
  149007. */
  149008. onStoppedObservable: Observable<IParticleSystem>;
  149009. /**
  149010. * Gets the maximum number of particles active at the same time.
  149011. * @returns The max number of active particles.
  149012. */
  149013. getCapacity(): number;
  149014. /**
  149015. * Forces the particle to write their depth information to the depth buffer. This can help preventing other draw calls
  149016. * to override the particles.
  149017. */
  149018. forceDepthWrite: boolean;
  149019. /**
  149020. * Gets or set the number of active particles
  149021. */
  149022. get activeParticleCount(): number;
  149023. set activeParticleCount(value: number);
  149024. private _preWarmDone;
  149025. /**
  149026. * Specifies if the particles are updated in emitter local space or world space.
  149027. */
  149028. isLocal: boolean;
  149029. /** Gets or sets a matrix to use to compute projection */
  149030. defaultProjectionMatrix: Matrix;
  149031. /**
  149032. * Is this system ready to be used/rendered
  149033. * @return true if the system is ready
  149034. */
  149035. isReady(): boolean;
  149036. /**
  149037. * Gets if the system has been started. (Note: this will still be true after stop is called)
  149038. * @returns True if it has been started, otherwise false.
  149039. */
  149040. isStarted(): boolean;
  149041. /**
  149042. * Gets if the system has been stopped. (Note: rendering is still happening but the system is frozen)
  149043. * @returns True if it has been stopped, otherwise false.
  149044. */
  149045. isStopped(): boolean;
  149046. /**
  149047. * Gets a boolean indicating that the system is stopping
  149048. * @returns true if the system is currently stopping
  149049. */
  149050. isStopping(): boolean;
  149051. /**
  149052. * Gets the number of particles active at the same time.
  149053. * @returns The number of active particles.
  149054. */
  149055. getActiveCount(): number;
  149056. /**
  149057. * Starts the particle system and begins to emit
  149058. * @param delay defines the delay in milliseconds before starting the system (this.startDelay by default)
  149059. */
  149060. start(delay?: number): void;
  149061. /**
  149062. * Stops the particle system.
  149063. */
  149064. stop(): void;
  149065. /**
  149066. * Remove all active particles
  149067. */
  149068. reset(): void;
  149069. /**
  149070. * Returns the string "GPUParticleSystem"
  149071. * @returns a string containing the class name
  149072. */
  149073. getClassName(): string;
  149074. /**
  149075. * Gets the custom effect used to render the particles
  149076. * @param blendMode Blend mode for which the effect should be retrieved
  149077. * @returns The effect
  149078. */
  149079. getCustomEffect(blendMode?: number): Nullable<Effect>;
  149080. /**
  149081. * Sets the custom effect used to render the particles
  149082. * @param effect The effect to set
  149083. * @param blendMode Blend mode for which the effect should be set
  149084. */
  149085. setCustomEffect(effect: Nullable<Effect>, blendMode?: number): void;
  149086. /** @hidden */
  149087. protected _onBeforeDrawParticlesObservable: Nullable<Observable<Nullable<Effect>>>;
  149088. /**
  149089. * Observable that will be called just before the particles are drawn
  149090. */
  149091. get onBeforeDrawParticlesObservable(): Observable<Nullable<Effect>>;
  149092. /**
  149093. * Gets the name of the particle vertex shader
  149094. */
  149095. get vertexShaderName(): string;
  149096. private _colorGradientsTexture;
  149097. protected _removeGradientAndTexture(gradient: number, gradients: Nullable<IValueGradient[]>, texture: RawTexture): BaseParticleSystem;
  149098. /**
  149099. * Adds a new color gradient
  149100. * @param gradient defines the gradient to use (between 0 and 1)
  149101. * @param color1 defines the color to affect to the specified gradient
  149102. * @param color2 defines an additional color used to define a range ([color, color2]) with main color to pick the final color from
  149103. * @returns the current particle system
  149104. */
  149105. addColorGradient(gradient: number, color1: Color4, color2?: Color4): GPUParticleSystem;
  149106. private _refreshColorGradient;
  149107. /** Force the system to rebuild all gradients that need to be resync */
  149108. forceRefreshGradients(): void;
  149109. /**
  149110. * Remove a specific color gradient
  149111. * @param gradient defines the gradient to remove
  149112. * @returns the current particle system
  149113. */
  149114. removeColorGradient(gradient: number): GPUParticleSystem;
  149115. private _angularSpeedGradientsTexture;
  149116. private _sizeGradientsTexture;
  149117. private _velocityGradientsTexture;
  149118. private _limitVelocityGradientsTexture;
  149119. private _dragGradientsTexture;
  149120. private _addFactorGradient;
  149121. /**
  149122. * Adds a new size gradient
  149123. * @param gradient defines the gradient to use (between 0 and 1)
  149124. * @param factor defines the size factor to affect to the specified gradient
  149125. * @returns the current particle system
  149126. */
  149127. addSizeGradient(gradient: number, factor: number): GPUParticleSystem;
  149128. /**
  149129. * Remove a specific size gradient
  149130. * @param gradient defines the gradient to remove
  149131. * @returns the current particle system
  149132. */
  149133. removeSizeGradient(gradient: number): GPUParticleSystem;
  149134. private _refreshFactorGradient;
  149135. /**
  149136. * Adds a new angular speed gradient
  149137. * @param gradient defines the gradient to use (between 0 and 1)
  149138. * @param factor defines the angular speed to affect to the specified gradient
  149139. * @returns the current particle system
  149140. */
  149141. addAngularSpeedGradient(gradient: number, factor: number): GPUParticleSystem;
  149142. /**
  149143. * Remove a specific angular speed gradient
  149144. * @param gradient defines the gradient to remove
  149145. * @returns the current particle system
  149146. */
  149147. removeAngularSpeedGradient(gradient: number): GPUParticleSystem;
  149148. /**
  149149. * Adds a new velocity gradient
  149150. * @param gradient defines the gradient to use (between 0 and 1)
  149151. * @param factor defines the velocity to affect to the specified gradient
  149152. * @returns the current particle system
  149153. */
  149154. addVelocityGradient(gradient: number, factor: number): GPUParticleSystem;
  149155. /**
  149156. * Remove a specific velocity gradient
  149157. * @param gradient defines the gradient to remove
  149158. * @returns the current particle system
  149159. */
  149160. removeVelocityGradient(gradient: number): GPUParticleSystem;
  149161. /**
  149162. * Adds a new limit velocity gradient
  149163. * @param gradient defines the gradient to use (between 0 and 1)
  149164. * @param factor defines the limit velocity value to affect to the specified gradient
  149165. * @returns the current particle system
  149166. */
  149167. addLimitVelocityGradient(gradient: number, factor: number): GPUParticleSystem;
  149168. /**
  149169. * Remove a specific limit velocity gradient
  149170. * @param gradient defines the gradient to remove
  149171. * @returns the current particle system
  149172. */
  149173. removeLimitVelocityGradient(gradient: number): GPUParticleSystem;
  149174. /**
  149175. * Adds a new drag gradient
  149176. * @param gradient defines the gradient to use (between 0 and 1)
  149177. * @param factor defines the drag value to affect to the specified gradient
  149178. * @returns the current particle system
  149179. */
  149180. addDragGradient(gradient: number, factor: number): GPUParticleSystem;
  149181. /**
  149182. * Remove a specific drag gradient
  149183. * @param gradient defines the gradient to remove
  149184. * @returns the current particle system
  149185. */
  149186. removeDragGradient(gradient: number): GPUParticleSystem;
  149187. /**
  149188. * Not supported by GPUParticleSystem
  149189. * @param gradient defines the gradient to use (between 0 and 1)
  149190. * @param factor defines the emit rate value to affect to the specified gradient
  149191. * @param factor2 defines an additional factor used to define a range ([factor, factor2]) with main value to pick the final value from
  149192. * @returns the current particle system
  149193. */
  149194. addEmitRateGradient(gradient: number, factor: number, factor2?: number): IParticleSystem;
  149195. /**
  149196. * Not supported by GPUParticleSystem
  149197. * @param gradient defines the gradient to remove
  149198. * @returns the current particle system
  149199. */
  149200. removeEmitRateGradient(gradient: number): IParticleSystem;
  149201. /**
  149202. * Not supported by GPUParticleSystem
  149203. * @param gradient defines the gradient to use (between 0 and 1)
  149204. * @param factor defines the start size value to affect to the specified gradient
  149205. * @param factor2 defines an additional factor used to define a range ([factor, factor2]) with main value to pick the final value from
  149206. * @returns the current particle system
  149207. */
  149208. addStartSizeGradient(gradient: number, factor: number, factor2?: number): IParticleSystem;
  149209. /**
  149210. * Not supported by GPUParticleSystem
  149211. * @param gradient defines the gradient to remove
  149212. * @returns the current particle system
  149213. */
  149214. removeStartSizeGradient(gradient: number): IParticleSystem;
  149215. /**
  149216. * Not supported by GPUParticleSystem
  149217. * @param gradient defines the gradient to use (between 0 and 1)
  149218. * @param min defines the color remap minimal range
  149219. * @param max defines the color remap maximal range
  149220. * @returns the current particle system
  149221. */
  149222. addColorRemapGradient(gradient: number, min: number, max: number): IParticleSystem;
  149223. /**
  149224. * Not supported by GPUParticleSystem
  149225. * @param gradient defines the gradient to remove
  149226. * @returns the current particle system
  149227. */
  149228. removeColorRemapGradient(): IParticleSystem;
  149229. /**
  149230. * Not supported by GPUParticleSystem
  149231. * @param gradient defines the gradient to use (between 0 and 1)
  149232. * @param min defines the alpha remap minimal range
  149233. * @param max defines the alpha remap maximal range
  149234. * @returns the current particle system
  149235. */
  149236. addAlphaRemapGradient(gradient: number, min: number, max: number): IParticleSystem;
  149237. /**
  149238. * Not supported by GPUParticleSystem
  149239. * @param gradient defines the gradient to remove
  149240. * @returns the current particle system
  149241. */
  149242. removeAlphaRemapGradient(): IParticleSystem;
  149243. /**
  149244. * Not supported by GPUParticleSystem
  149245. * @param gradient defines the gradient to use (between 0 and 1)
  149246. * @param color defines the color to affect to the specified gradient
  149247. * @returns the current particle system
  149248. */
  149249. addRampGradient(gradient: number, color: Color3): IParticleSystem;
  149250. /**
  149251. * Not supported by GPUParticleSystem
  149252. * @param gradient defines the gradient to remove
  149253. * @returns the current particle system
  149254. */
  149255. removeRampGradient(): IParticleSystem;
  149256. /**
  149257. * Not supported by GPUParticleSystem
  149258. * @returns the list of ramp gradients
  149259. */
  149260. getRampGradients(): Nullable<Array<Color3Gradient>>;
  149261. /**
  149262. * Not supported by GPUParticleSystem
  149263. * Gets or sets a boolean indicating that ramp gradients must be used
  149264. * @see https://doc.babylonjs.com/babylon101/particles#ramp-gradients
  149265. */
  149266. get useRampGradients(): boolean;
  149267. set useRampGradients(value: boolean);
  149268. /**
  149269. * Not supported by GPUParticleSystem
  149270. * @param gradient defines the gradient to use (between 0 and 1)
  149271. * @param factor defines the life time factor to affect to the specified gradient
  149272. * @param factor2 defines an additional factor used to define a range ([factor, factor2]) with main value to pick the final value from
  149273. * @returns the current particle system
  149274. */
  149275. addLifeTimeGradient(gradient: number, factor: number, factor2?: number): IParticleSystem;
  149276. /**
  149277. * Not supported by GPUParticleSystem
  149278. * @param gradient defines the gradient to remove
  149279. * @returns the current particle system
  149280. */
  149281. removeLifeTimeGradient(gradient: number): IParticleSystem;
  149282. /**
  149283. * Instantiates a GPU particle system.
  149284. * 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.
  149285. * @param name The name of the particle system
  149286. * @param options The options used to create the system
  149287. * @param sceneOrEngine The scene the particle system belongs to or the engine to use if no scene
  149288. * @param isAnimationSheetEnabled Must be true if using a spritesheet to animate the particles texture
  149289. * @param customEffect a custom effect used to change the way particles are rendered by default
  149290. */
  149291. constructor(name: string, options: Partial<{
  149292. capacity: number;
  149293. randomTextureSize: number;
  149294. }>, sceneOrEngine: Scene | ThinEngine, isAnimationSheetEnabled?: boolean, customEffect?: Nullable<Effect>);
  149295. protected _reset(): void;
  149296. private _createUpdateVAO;
  149297. private _createRenderVAO;
  149298. private _initialize;
  149299. /** @hidden */
  149300. _recreateUpdateEffect(): void;
  149301. private _getEffect;
  149302. /**
  149303. * Fill the defines array according to the current settings of the particle system
  149304. * @param defines Array to be updated
  149305. * @param blendMode blend mode to take into account when updating the array
  149306. */
  149307. fillDefines(defines: Array<string>, blendMode?: number): void;
  149308. /**
  149309. * Fill the uniforms, attributes and samplers arrays according to the current settings of the particle system
  149310. * @param uniforms Uniforms array to fill
  149311. * @param attributes Attributes array to fill
  149312. * @param samplers Samplers array to fill
  149313. */
  149314. fillUniformsAttributesAndSamplerNames(uniforms: Array<string>, attributes: Array<string>, samplers: Array<string>): void;
  149315. /** @hidden */
  149316. _recreateRenderEffect(): Effect;
  149317. /**
  149318. * Animates the particle system for the current frame by emitting new particles and or animating the living ones.
  149319. * @param preWarm defines if we are in the pre-warmimg phase
  149320. */
  149321. animate(preWarm?: boolean): void;
  149322. private _createFactorGradientTexture;
  149323. private _createSizeGradientTexture;
  149324. private _createAngularSpeedGradientTexture;
  149325. private _createVelocityGradientTexture;
  149326. private _createLimitVelocityGradientTexture;
  149327. private _createDragGradientTexture;
  149328. private _createColorGradientTexture;
  149329. /**
  149330. * Renders the particle system in its current state
  149331. * @param preWarm defines if the system should only update the particles but not render them
  149332. * @returns the current number of particles
  149333. */
  149334. render(preWarm?: boolean): number;
  149335. /**
  149336. * Rebuilds the particle system
  149337. */
  149338. rebuild(): void;
  149339. private _releaseBuffers;
  149340. private _releaseVAOs;
  149341. /**
  149342. * Disposes the particle system and free the associated resources
  149343. * @param disposeTexture defines if the particule texture must be disposed as well (true by default)
  149344. */
  149345. dispose(disposeTexture?: boolean): void;
  149346. /**
  149347. * Clones the particle system.
  149348. * @param name The name of the cloned object
  149349. * @param newEmitter The new emitter to use
  149350. * @returns the cloned particle system
  149351. */
  149352. clone(name: string, newEmitter: any): GPUParticleSystem;
  149353. /**
  149354. * Serializes the particle system to a JSON object
  149355. * @param serializeTexture defines if the texture must be serialized as well
  149356. * @returns the JSON object
  149357. */
  149358. serialize(serializeTexture?: boolean): any;
  149359. /**
  149360. * Parses a JSON object to create a GPU particle system.
  149361. * @param parsedParticleSystem The JSON object to parse
  149362. * @param sceneOrEngine The scene or the engine to create the particle system in
  149363. * @param rootUrl The root url to use to load external dependencies like texture
  149364. * @param doNotStart Ignore the preventAutoStart attribute and does not start
  149365. * @returns the parsed GPU particle system
  149366. */
  149367. static Parse(parsedParticleSystem: any, sceneOrEngine: Scene | ThinEngine, rootUrl: string, doNotStart?: boolean): GPUParticleSystem;
  149368. }
  149369. }
  149370. declare module BABYLON {
  149371. /**
  149372. * Represents a set of particle systems working together to create a specific effect
  149373. */
  149374. export class ParticleSystemSet implements IDisposable {
  149375. /**
  149376. * Gets or sets base Assets URL
  149377. */
  149378. static BaseAssetsUrl: string;
  149379. private _emitterCreationOptions;
  149380. private _emitterNode;
  149381. /**
  149382. * Gets the particle system list
  149383. */
  149384. systems: IParticleSystem[];
  149385. /**
  149386. * Gets the emitter node used with this set
  149387. */
  149388. get emitterNode(): Nullable<TransformNode>;
  149389. /**
  149390. * Creates a new emitter mesh as a sphere
  149391. * @param options defines the options used to create the sphere
  149392. * @param renderingGroupId defines the renderingGroupId to use for the sphere
  149393. * @param scene defines the hosting scene
  149394. */
  149395. setEmitterAsSphere(options: {
  149396. diameter: number;
  149397. segments: number;
  149398. color: Color3;
  149399. }, renderingGroupId: number, scene: Scene): void;
  149400. /**
  149401. * Starts all particle systems of the set
  149402. * @param emitter defines an optional mesh to use as emitter for the particle systems
  149403. */
  149404. start(emitter?: AbstractMesh): void;
  149405. /**
  149406. * Release all associated resources
  149407. */
  149408. dispose(): void;
  149409. /**
  149410. * Serialize the set into a JSON compatible object
  149411. * @param serializeTexture defines if the texture must be serialized as well
  149412. * @returns a JSON compatible representation of the set
  149413. */
  149414. serialize(serializeTexture?: boolean): any;
  149415. /**
  149416. * Parse a new ParticleSystemSet from a serialized source
  149417. * @param data defines a JSON compatible representation of the set
  149418. * @param scene defines the hosting scene
  149419. * @param gpu defines if we want GPU particles or CPU particles
  149420. * @returns a new ParticleSystemSet
  149421. */
  149422. static Parse(data: any, scene: Scene, gpu?: boolean): ParticleSystemSet;
  149423. }
  149424. }
  149425. declare module BABYLON {
  149426. /**
  149427. * This class is made for on one-liner static method to help creating particle system set.
  149428. */
  149429. export class ParticleHelper {
  149430. /**
  149431. * Gets or sets base Assets URL
  149432. */
  149433. static BaseAssetsUrl: string;
  149434. /** Define the Url to load snippets */
  149435. static SnippetUrl: string;
  149436. /**
  149437. * Create a default particle system that you can tweak
  149438. * @param emitter defines the emitter to use
  149439. * @param capacity defines the system capacity (default is 500 particles)
  149440. * @param scene defines the hosting scene
  149441. * @param useGPU defines if a GPUParticleSystem must be created (default is false)
  149442. * @returns the new Particle system
  149443. */
  149444. static CreateDefault(emitter: Nullable<AbstractMesh | Vector3>, capacity?: number, scene?: Scene, useGPU?: boolean): IParticleSystem;
  149445. /**
  149446. * This is the main static method (one-liner) of this helper to create different particle systems
  149447. * @param type This string represents the type to the particle system to create
  149448. * @param scene The scene where the particle system should live
  149449. * @param gpu If the system will use gpu
  149450. * @returns the ParticleSystemSet created
  149451. */
  149452. static CreateAsync(type: string, scene: Nullable<Scene>, gpu?: boolean): Promise<ParticleSystemSet>;
  149453. /**
  149454. * Static function used to export a particle system to a ParticleSystemSet variable.
  149455. * Please note that the emitter shape is not exported
  149456. * @param systems defines the particle systems to export
  149457. * @returns the created particle system set
  149458. */
  149459. static ExportSet(systems: IParticleSystem[]): ParticleSystemSet;
  149460. /**
  149461. * Creates a particle system from a snippet saved in a remote file
  149462. * @param name defines the name of the particle system to create (can be null or empty to use the one from the json data)
  149463. * @param url defines the url to load from
  149464. * @param scene defines the hosting scene
  149465. * @param gpu If the system will use gpu
  149466. * @param rootUrl defines the root URL to use to load textures and relative dependencies
  149467. * @returns a promise that will resolve to the new particle system
  149468. */
  149469. static ParseFromFileAsync(name: Nullable<string>, url: string, scene: Scene, gpu?: boolean, rootUrl?: string): Promise<IParticleSystem>;
  149470. /**
  149471. * Creates a particle system from a snippet saved by the particle system editor
  149472. * @param snippetId defines the snippet to load (can be set to _BLANK to create a default one)
  149473. * @param scene defines the hosting scene
  149474. * @param gpu If the system will use gpu
  149475. * @param rootUrl defines the root URL to use to load textures and relative dependencies
  149476. * @returns a promise that will resolve to the new particle system
  149477. */
  149478. static CreateFromSnippetAsync(snippetId: string, scene: Scene, gpu?: boolean, rootUrl?: string): Promise<IParticleSystem>;
  149479. }
  149480. }
  149481. declare module BABYLON {
  149482. interface Engine {
  149483. /**
  149484. * Create an effect to use with particle systems.
  149485. * Please note that some parameters like animation sheets or not being billboard are not supported in this configuration, except if you pass
  149486. * the particle system for which you want to create a custom effect in the last parameter
  149487. * @param fragmentName defines the base name of the effect (The name of file without .fragment.fx)
  149488. * @param uniformsNames defines a list of attribute names
  149489. * @param samplers defines an array of string used to represent textures
  149490. * @param defines defines the string containing the defines to use to compile the shaders
  149491. * @param fallbacks defines the list of potential fallbacks to use if shader conmpilation fails
  149492. * @param onCompiled defines a function to call when the effect creation is successful
  149493. * @param onError defines a function to call when the effect creation has failed
  149494. * @param particleSystem the particle system you want to create the effect for
  149495. * @returns the new Effect
  149496. */
  149497. createEffectForParticles(fragmentName: string, uniformsNames: string[], samplers: string[], defines: string, fallbacks?: EffectFallbacks, onCompiled?: (effect: Effect) => void, onError?: (effect: Effect, errors: string) => void, particleSystem?: IParticleSystem): Effect;
  149498. }
  149499. interface Mesh {
  149500. /**
  149501. * Returns an array populated with IParticleSystem objects whose the mesh is the emitter
  149502. * @returns an array of IParticleSystem
  149503. */
  149504. getEmittedParticleSystems(): IParticleSystem[];
  149505. /**
  149506. * Returns an array populated with IParticleSystem objects whose the mesh or its children are the emitter
  149507. * @returns an array of IParticleSystem
  149508. */
  149509. getHierarchyEmittedParticleSystems(): IParticleSystem[];
  149510. }
  149511. }
  149512. declare module BABYLON {
  149513. /** Defines the 4 color options */
  149514. export enum PointColor {
  149515. /** color value */
  149516. Color = 2,
  149517. /** uv value */
  149518. UV = 1,
  149519. /** random value */
  149520. Random = 0,
  149521. /** stated value */
  149522. Stated = 3
  149523. }
  149524. /**
  149525. * The PointCloudSystem (PCS) is a single updatable mesh. The points corresponding to the vertices of this big mesh.
  149526. * 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.
  149527. * The PointCloudSytem is also a particle system, with each point being a particle. It provides some methods to manage the particles.
  149528. * However it is behavior agnostic. This means it has no emitter, no particle physics, no particle recycler. You have to implement your own behavior.
  149529. *
  149530. * Full documentation here : TO BE ENTERED
  149531. */
  149532. export class PointsCloudSystem implements IDisposable {
  149533. /**
  149534. * The PCS array of cloud point objects. Just access each particle as with any classic array.
  149535. * Example : var p = SPS.particles[i];
  149536. */
  149537. particles: CloudPoint[];
  149538. /**
  149539. * The PCS total number of particles. Read only. Use PCS.counter instead if you need to set your own value.
  149540. */
  149541. nbParticles: number;
  149542. /**
  149543. * This a counter for your own usage. It's not set by any SPS functions.
  149544. */
  149545. counter: number;
  149546. /**
  149547. * The PCS name. This name is also given to the underlying mesh.
  149548. */
  149549. name: string;
  149550. /**
  149551. * The PCS mesh. It's a standard BJS Mesh, so all the methods from the Mesh class are avalaible.
  149552. */
  149553. mesh: Mesh;
  149554. /**
  149555. * This empty object is intended to store some PCS specific or temporary values in order to lower the Garbage Collector activity.
  149556. * Please read :
  149557. */
  149558. vars: any;
  149559. /**
  149560. * @hidden
  149561. */
  149562. _size: number;
  149563. private _scene;
  149564. private _promises;
  149565. private _positions;
  149566. private _indices;
  149567. private _normals;
  149568. private _colors;
  149569. private _uvs;
  149570. private _indices32;
  149571. private _positions32;
  149572. private _colors32;
  149573. private _uvs32;
  149574. private _updatable;
  149575. private _isVisibilityBoxLocked;
  149576. private _alwaysVisible;
  149577. private _groups;
  149578. private _groupCounter;
  149579. private _computeParticleColor;
  149580. private _computeParticleTexture;
  149581. private _computeParticleRotation;
  149582. private _computeBoundingBox;
  149583. private _isReady;
  149584. /**
  149585. * Creates a PCS (Points Cloud System) object
  149586. * @param name (String) is the PCS name, this will be the underlying mesh name
  149587. * @param pointSize (number) is the size for each point
  149588. * @param scene (Scene) is the scene in which the PCS is added
  149589. * @param options defines the options of the PCS e.g.
  149590. * * updatable (optional boolean, default true) : if the PCS must be updatable or immutable
  149591. */
  149592. constructor(name: string, pointSize: number, scene: Scene, options?: {
  149593. updatable?: boolean;
  149594. });
  149595. /**
  149596. * Builds the PCS underlying mesh. Returns a standard Mesh.
  149597. * If no points were added to the PCS, the returned mesh is just a single point.
  149598. * @returns a promise for the created mesh
  149599. */
  149600. buildMeshAsync(): Promise<Mesh>;
  149601. /**
  149602. * @hidden
  149603. */
  149604. private _buildMesh;
  149605. private _addParticle;
  149606. private _randomUnitVector;
  149607. private _getColorIndicesForCoord;
  149608. private _setPointsColorOrUV;
  149609. private _colorFromTexture;
  149610. private _calculateDensity;
  149611. /**
  149612. * Adds points to the PCS in random positions within a unit sphere
  149613. * @param nb (positive integer) the number of particles to be created from this model
  149614. * @param pointFunction is an optional javascript function to be called for each particle on PCS creation
  149615. * @returns the number of groups in the system
  149616. */
  149617. addPoints(nb: number, pointFunction?: any): number;
  149618. /**
  149619. * Adds points to the PCS from the surface of the model shape
  149620. * @param mesh is any Mesh object that will be used as a surface model for the points
  149621. * @param nb (positive integer) the number of particles to be created from this model
  149622. * @param colorWith determines whether a point is colored using color (default), uv, random, stated or none (invisible)
  149623. * @param color (color4) to be used when colorWith is stated or color (number) when used to specify texture position
  149624. * @param range (number from 0 to 1) to determine the variation in shape and tone for a stated color
  149625. * @returns the number of groups in the system
  149626. */
  149627. addSurfacePoints(mesh: Mesh, nb: number, colorWith?: number, color?: Color4 | number, range?: number): number;
  149628. /**
  149629. * Adds points to the PCS inside the model shape
  149630. * @param mesh is any Mesh object that will be used as a surface model for the points
  149631. * @param nb (positive integer) the number of particles to be created from this model
  149632. * @param colorWith determines whether a point is colored using color (default), uv, random, stated or none (invisible)
  149633. * @param color (color4) to be used when colorWith is stated or color (number) when used to specify texture position
  149634. * @param range (number from 0 to 1) to determine the variation in shape and tone for a stated color
  149635. * @returns the number of groups in the system
  149636. */
  149637. addVolumePoints(mesh: Mesh, nb: number, colorWith?: number, color?: Color4 | number, range?: number): number;
  149638. /**
  149639. * Sets all the particles : this method actually really updates the mesh according to the particle positions, rotations, colors, textures, etc.
  149640. * This method calls `updateParticle()` for each particle of the SPS.
  149641. * For an animated SPS, it is usually called within the render loop.
  149642. * @param start The particle index in the particle array where to start to compute the particle property values _(default 0)_
  149643. * @param end The particle index in the particle array where to stop to compute the particle property values _(default nbParticle - 1)_
  149644. * @param update If the mesh must be finally updated on this call after all the particle computations _(default true)_
  149645. * @returns the PCS.
  149646. */
  149647. setParticles(start?: number, end?: number, update?: boolean): PointsCloudSystem;
  149648. /**
  149649. * Disposes the PCS.
  149650. */
  149651. dispose(): void;
  149652. /**
  149653. * Visibilty helper : Recomputes the visible size according to the mesh bounding box
  149654. * doc :
  149655. * @returns the PCS.
  149656. */
  149657. refreshVisibleSize(): PointsCloudSystem;
  149658. /**
  149659. * Visibility helper : Sets the size of a visibility box, this sets the underlying mesh bounding box.
  149660. * @param size the size (float) of the visibility box
  149661. * note : this doesn't lock the PCS mesh bounding box.
  149662. * doc :
  149663. */
  149664. setVisibilityBox(size: number): void;
  149665. /**
  149666. * Gets whether the PCS is always visible or not
  149667. * doc :
  149668. */
  149669. get isAlwaysVisible(): boolean;
  149670. /**
  149671. * Sets the PCS as always visible or not
  149672. * doc :
  149673. */
  149674. set isAlwaysVisible(val: boolean);
  149675. /**
  149676. * Tells to `setParticles()` to compute the particle rotations or not
  149677. * Default value : false. The PCS is faster when it's set to false
  149678. * Note : particle rotations are only applied to parent particles
  149679. * Note : the particle rotations aren't stored values, so setting `computeParticleRotation` to false will prevents the particle to rotate
  149680. */
  149681. set computeParticleRotation(val: boolean);
  149682. /**
  149683. * Tells to `setParticles()` to compute the particle colors or not.
  149684. * Default value : true. The PCS is faster when it's set to false.
  149685. * Note : the particle colors are stored values, so setting `computeParticleColor` to false will keep yet the last colors set.
  149686. */
  149687. set computeParticleColor(val: boolean);
  149688. set computeParticleTexture(val: boolean);
  149689. /**
  149690. * Gets if `setParticles()` computes the particle colors or not.
  149691. * Default value : false. The PCS is faster when it's set to false.
  149692. * Note : the particle colors are stored values, so setting `computeParticleColor` to false will keep yet the last colors set.
  149693. */
  149694. get computeParticleColor(): boolean;
  149695. /**
  149696. * Gets if `setParticles()` computes the particle textures or not.
  149697. * Default value : false. The PCS is faster when it's set to false.
  149698. * Note : the particle textures are stored values, so setting `computeParticleTexture` to false will keep yet the last colors set.
  149699. */
  149700. get computeParticleTexture(): boolean;
  149701. /**
  149702. * Tells to `setParticles()` to compute or not the mesh bounding box when computing the particle positions.
  149703. */
  149704. set computeBoundingBox(val: boolean);
  149705. /**
  149706. * Gets if `setParticles()` computes or not the mesh bounding box when computing the particle positions.
  149707. */
  149708. get computeBoundingBox(): boolean;
  149709. /**
  149710. * This function does nothing. It may be overwritten to set all the particle first values.
  149711. * The PCS doesn't call this function, you may have to call it by your own.
  149712. * doc :
  149713. */
  149714. initParticles(): void;
  149715. /**
  149716. * This function does nothing. It may be overwritten to recycle a particle
  149717. * The PCS doesn't call this function, you can to call it
  149718. * doc :
  149719. * @param particle The particle to recycle
  149720. * @returns the recycled particle
  149721. */
  149722. recycleParticle(particle: CloudPoint): CloudPoint;
  149723. /**
  149724. * Updates a particle : this function should be overwritten by the user.
  149725. * It is called on each particle by `setParticles()`. This is the place to code each particle behavior.
  149726. * doc :
  149727. * @example : just set a particle position or velocity and recycle conditions
  149728. * @param particle The particle to update
  149729. * @returns the updated particle
  149730. */
  149731. updateParticle(particle: CloudPoint): CloudPoint;
  149732. /**
  149733. * This will be called before any other treatment by `setParticles()` and will be passed three parameters.
  149734. * This does nothing and may be overwritten by the user.
  149735. * @param start the particle index in the particle array where to start to iterate, same than the value passed to setParticle()
  149736. * @param stop the particle index in the particle array where to stop to iterate, same than the value passed to setParticle()
  149737. * @param update the boolean update value actually passed to setParticles()
  149738. */
  149739. beforeUpdateParticles(start?: number, stop?: number, update?: boolean): void;
  149740. /**
  149741. * This will be called by `setParticles()` after all the other treatments and just before the actual mesh update.
  149742. * This will be passed three parameters.
  149743. * This does nothing and may be overwritten by the user.
  149744. * @param start the particle index in the particle array where to start to iterate, same than the value passed to setParticle()
  149745. * @param stop the particle index in the particle array where to stop to iterate, same than the value passed to setParticle()
  149746. * @param update the boolean update value actually passed to setParticles()
  149747. */
  149748. afterUpdateParticles(start?: number, stop?: number, update?: boolean): void;
  149749. }
  149750. }
  149751. declare module BABYLON {
  149752. /**
  149753. * Represents one particle of a points cloud system.
  149754. */
  149755. export class CloudPoint {
  149756. /**
  149757. * particle global index
  149758. */
  149759. idx: number;
  149760. /**
  149761. * The color of the particle
  149762. */
  149763. color: Nullable<Color4>;
  149764. /**
  149765. * The world space position of the particle.
  149766. */
  149767. position: Vector3;
  149768. /**
  149769. * The world space rotation of the particle. (Not use if rotationQuaternion is set)
  149770. */
  149771. rotation: Vector3;
  149772. /**
  149773. * The world space rotation quaternion of the particle.
  149774. */
  149775. rotationQuaternion: Nullable<Quaternion>;
  149776. /**
  149777. * The uv of the particle.
  149778. */
  149779. uv: Nullable<Vector2>;
  149780. /**
  149781. * The current speed of the particle.
  149782. */
  149783. velocity: Vector3;
  149784. /**
  149785. * The pivot point in the particle local space.
  149786. */
  149787. pivot: Vector3;
  149788. /**
  149789. * Must the particle be translated from its pivot point in its local space ?
  149790. * In this case, the pivot point is set at the origin of the particle local space and the particle is translated.
  149791. * Default : false
  149792. */
  149793. translateFromPivot: boolean;
  149794. /**
  149795. * Index of this particle in the global "positions" array (Internal use)
  149796. * @hidden
  149797. */
  149798. _pos: number;
  149799. /**
  149800. * @hidden Index of this particle in the global "indices" array (Internal use)
  149801. */
  149802. _ind: number;
  149803. /**
  149804. * Group this particle belongs to
  149805. */
  149806. _group: PointsGroup;
  149807. /**
  149808. * Group id of this particle
  149809. */
  149810. groupId: number;
  149811. /**
  149812. * Index of the particle in its group id (Internal use)
  149813. */
  149814. idxInGroup: number;
  149815. /**
  149816. * @hidden Particle BoundingInfo object (Internal use)
  149817. */
  149818. _boundingInfo: BoundingInfo;
  149819. /**
  149820. * @hidden Reference to the PCS that the particle belongs to (Internal use)
  149821. */
  149822. _pcs: PointsCloudSystem;
  149823. /**
  149824. * @hidden Still set as invisible in order to skip useless computations (Internal use)
  149825. */
  149826. _stillInvisible: boolean;
  149827. /**
  149828. * @hidden Last computed particle rotation matrix
  149829. */
  149830. _rotationMatrix: number[];
  149831. /**
  149832. * Parent particle Id, if any.
  149833. * Default null.
  149834. */
  149835. parentId: Nullable<number>;
  149836. /**
  149837. * @hidden Internal global position in the PCS.
  149838. */
  149839. _globalPosition: Vector3;
  149840. /**
  149841. * Creates a Point Cloud object.
  149842. * Don't create particles manually, use instead the PCS internal tools like _addParticle()
  149843. * @param particleIndex (integer) is the particle index in the PCS pool. It's also the particle identifier.
  149844. * @param group (PointsGroup) is the group the particle belongs to
  149845. * @param groupId (integer) is the group identifier in the PCS.
  149846. * @param idxInGroup (integer) is the index of the particle in the current point group (ex: the 10th point of addPoints(30))
  149847. * @param pcs defines the PCS it is associated to
  149848. */
  149849. constructor(particleIndex: number, group: PointsGroup, groupId: number, idxInGroup: number, pcs: PointsCloudSystem);
  149850. /**
  149851. * get point size
  149852. */
  149853. get size(): Vector3;
  149854. /**
  149855. * Set point size
  149856. */
  149857. set size(scale: Vector3);
  149858. /**
  149859. * Legacy support, changed quaternion to rotationQuaternion
  149860. */
  149861. get quaternion(): Nullable<Quaternion>;
  149862. /**
  149863. * Legacy support, changed quaternion to rotationQuaternion
  149864. */
  149865. set quaternion(q: Nullable<Quaternion>);
  149866. /**
  149867. * Returns a boolean. True if the particle intersects a mesh, else false
  149868. * The intersection is computed on the particle position and Axis Aligned Bounding Box (AABB) or Sphere
  149869. * @param target is the object (point or mesh) what the intersection is computed against
  149870. * @param isSphere is boolean flag when false (default) bounding box of mesh is used, when true the bouding sphere is used
  149871. * @returns true if it intersects
  149872. */
  149873. intersectsMesh(target: Mesh, isSphere: boolean): boolean;
  149874. /**
  149875. * get the rotation matrix of the particle
  149876. * @hidden
  149877. */
  149878. getRotationMatrix(m: Matrix): void;
  149879. }
  149880. /**
  149881. * Represents a group of points in a points cloud system
  149882. * * PCS internal tool, don't use it manually.
  149883. */
  149884. export class PointsGroup {
  149885. /**
  149886. * The group id
  149887. * @hidden
  149888. */
  149889. groupID: number;
  149890. /**
  149891. * image data for group (internal use)
  149892. * @hidden
  149893. */
  149894. _groupImageData: Nullable<ArrayBufferView>;
  149895. /**
  149896. * Image Width (internal use)
  149897. * @hidden
  149898. */
  149899. _groupImgWidth: number;
  149900. /**
  149901. * Image Height (internal use)
  149902. * @hidden
  149903. */
  149904. _groupImgHeight: number;
  149905. /**
  149906. * Custom position function (internal use)
  149907. * @hidden
  149908. */
  149909. _positionFunction: Nullable<(particle: CloudPoint, i?: number, s?: number) => void>;
  149910. /**
  149911. * density per facet for surface points
  149912. * @hidden
  149913. */
  149914. _groupDensity: number[];
  149915. /**
  149916. * Only when points are colored by texture carries pointer to texture list array
  149917. * @hidden
  149918. */
  149919. _textureNb: number;
  149920. /**
  149921. * Creates a points group object. This is an internal reference to produce particles for the PCS.
  149922. * PCS internal tool, don't use it manually.
  149923. * @hidden
  149924. */
  149925. constructor(id: number, posFunction: Nullable<(particle: CloudPoint, i?: number, s?: number) => void>);
  149926. }
  149927. }
  149928. declare module BABYLON {
  149929. interface Scene {
  149930. /** @hidden (Backing field) */
  149931. _physicsEngine: Nullable<IPhysicsEngine>;
  149932. /** @hidden */
  149933. _physicsTimeAccumulator: number;
  149934. /**
  149935. * Gets the current physics engine
  149936. * @returns a IPhysicsEngine or null if none attached
  149937. */
  149938. getPhysicsEngine(): Nullable<IPhysicsEngine>;
  149939. /**
  149940. * Enables physics to the current scene
  149941. * @param gravity defines the scene's gravity for the physics engine
  149942. * @param plugin defines the physics engine to be used. defaults to OimoJS.
  149943. * @return a boolean indicating if the physics engine was initialized
  149944. */
  149945. enablePhysics(gravity: Nullable<Vector3>, plugin?: IPhysicsEnginePlugin): boolean;
  149946. /**
  149947. * Disables and disposes the physics engine associated with the scene
  149948. */
  149949. disablePhysicsEngine(): void;
  149950. /**
  149951. * Gets a boolean indicating if there is an active physics engine
  149952. * @returns a boolean indicating if there is an active physics engine
  149953. */
  149954. isPhysicsEnabled(): boolean;
  149955. /**
  149956. * Deletes a physics compound impostor
  149957. * @param compound defines the compound to delete
  149958. */
  149959. deleteCompoundImpostor(compound: any): void;
  149960. /**
  149961. * An event triggered when physic simulation is about to be run
  149962. */
  149963. onBeforePhysicsObservable: Observable<Scene>;
  149964. /**
  149965. * An event triggered when physic simulation has been done
  149966. */
  149967. onAfterPhysicsObservable: Observable<Scene>;
  149968. }
  149969. interface AbstractMesh {
  149970. /** @hidden */
  149971. _physicsImpostor: Nullable<PhysicsImpostor>;
  149972. /**
  149973. * Gets or sets impostor used for physic simulation
  149974. * @see https://doc.babylonjs.com/features/physics_engine
  149975. */
  149976. physicsImpostor: Nullable<PhysicsImpostor>;
  149977. /**
  149978. * Gets the current physics impostor
  149979. * @see https://doc.babylonjs.com/features/physics_engine
  149980. * @returns a physics impostor or null
  149981. */
  149982. getPhysicsImpostor(): Nullable<PhysicsImpostor>;
  149983. /** Apply a physic impulse to the mesh
  149984. * @param force defines the force to apply
  149985. * @param contactPoint defines where to apply the force
  149986. * @returns the current mesh
  149987. * @see https://doc.babylonjs.com/how_to/using_the_physics_engine
  149988. */
  149989. applyImpulse(force: Vector3, contactPoint: Vector3): AbstractMesh;
  149990. /**
  149991. * Creates a physic joint between two meshes
  149992. * @param otherMesh defines the other mesh to use
  149993. * @param pivot1 defines the pivot to use on this mesh
  149994. * @param pivot2 defines the pivot to use on the other mesh
  149995. * @param options defines additional options (can be plugin dependent)
  149996. * @returns the current mesh
  149997. * @see https://www.babylonjs-playground.com/#0BS5U0#0
  149998. */
  149999. setPhysicsLinkWith(otherMesh: Mesh, pivot1: Vector3, pivot2: Vector3, options?: any): AbstractMesh;
  150000. /** @hidden */
  150001. _disposePhysicsObserver: Nullable<Observer<Node>>;
  150002. }
  150003. /**
  150004. * Defines the physics engine scene component responsible to manage a physics engine
  150005. */
  150006. export class PhysicsEngineSceneComponent implements ISceneComponent {
  150007. /**
  150008. * The component name helpful to identify the component in the list of scene components.
  150009. */
  150010. readonly name: string;
  150011. /**
  150012. * The scene the component belongs to.
  150013. */
  150014. scene: Scene;
  150015. /**
  150016. * Creates a new instance of the component for the given scene
  150017. * @param scene Defines the scene to register the component in
  150018. */
  150019. constructor(scene: Scene);
  150020. /**
  150021. * Registers the component in a given scene
  150022. */
  150023. register(): void;
  150024. /**
  150025. * Rebuilds the elements related to this component in case of
  150026. * context lost for instance.
  150027. */
  150028. rebuild(): void;
  150029. /**
  150030. * Disposes the component and the associated ressources
  150031. */
  150032. dispose(): void;
  150033. }
  150034. }
  150035. declare module BABYLON {
  150036. /**
  150037. * A helper for physics simulations
  150038. * @see https://doc.babylonjs.com/how_to/using_the_physics_engine#further-functionality-of-the-impostor-class
  150039. */
  150040. export class PhysicsHelper {
  150041. private _scene;
  150042. private _physicsEngine;
  150043. /**
  150044. * Initializes the Physics helper
  150045. * @param scene Babylon.js scene
  150046. */
  150047. constructor(scene: Scene);
  150048. /**
  150049. * Applies a radial explosion impulse
  150050. * @param origin the origin of the explosion
  150051. * @param radiusOrEventOptions the radius or the options of radial explosion
  150052. * @param strength the explosion strength
  150053. * @param falloff possible options: Constant & Linear. Defaults to Constant
  150054. * @returns A physics radial explosion event, or null
  150055. */
  150056. applyRadialExplosionImpulse(origin: Vector3, radiusOrEventOptions: number | PhysicsRadialExplosionEventOptions, strength?: number, falloff?: PhysicsRadialImpulseFalloff): Nullable<PhysicsRadialExplosionEvent>;
  150057. /**
  150058. * Applies a radial explosion force
  150059. * @param origin the origin of the explosion
  150060. * @param radiusOrEventOptions the radius or the options of radial explosion
  150061. * @param strength the explosion strength
  150062. * @param falloff possible options: Constant & Linear. Defaults to Constant
  150063. * @returns A physics radial explosion event, or null
  150064. */
  150065. applyRadialExplosionForce(origin: Vector3, radiusOrEventOptions: number | PhysicsRadialExplosionEventOptions, strength?: number, falloff?: PhysicsRadialImpulseFalloff): Nullable<PhysicsRadialExplosionEvent>;
  150066. /**
  150067. * Creates a gravitational field
  150068. * @param origin the origin of the explosion
  150069. * @param radiusOrEventOptions the radius or the options of radial explosion
  150070. * @param strength the explosion strength
  150071. * @param falloff possible options: Constant & Linear. Defaults to Constant
  150072. * @returns A physics gravitational field event, or null
  150073. */
  150074. gravitationalField(origin: Vector3, radiusOrEventOptions: number | PhysicsRadialExplosionEventOptions, strength?: number, falloff?: PhysicsRadialImpulseFalloff): Nullable<PhysicsGravitationalFieldEvent>;
  150075. /**
  150076. * Creates a physics updraft event
  150077. * @param origin the origin of the updraft
  150078. * @param radiusOrEventOptions the radius or the options of the updraft
  150079. * @param strength the strength of the updraft
  150080. * @param height the height of the updraft
  150081. * @param updraftMode possible options: Center & Perpendicular. Defaults to Center
  150082. * @returns A physics updraft event, or null
  150083. */
  150084. updraft(origin: Vector3, radiusOrEventOptions: number | PhysicsUpdraftEventOptions, strength?: number, height?: number, updraftMode?: PhysicsUpdraftMode): Nullable<PhysicsUpdraftEvent>;
  150085. /**
  150086. * Creates a physics vortex event
  150087. * @param origin the of the vortex
  150088. * @param radiusOrEventOptions the radius or the options of the vortex
  150089. * @param strength the strength of the vortex
  150090. * @param height the height of the vortex
  150091. * @returns a Physics vortex event, or null
  150092. * A physics vortex event or null
  150093. */
  150094. vortex(origin: Vector3, radiusOrEventOptions: number | PhysicsVortexEventOptions, strength?: number, height?: number): Nullable<PhysicsVortexEvent>;
  150095. }
  150096. /**
  150097. * Represents a physics radial explosion event
  150098. */
  150099. class PhysicsRadialExplosionEvent {
  150100. private _scene;
  150101. private _options;
  150102. private _sphere;
  150103. private _dataFetched;
  150104. /**
  150105. * Initializes a radial explosioin event
  150106. * @param _scene BabylonJS scene
  150107. * @param _options The options for the vortex event
  150108. */
  150109. constructor(_scene: Scene, _options: PhysicsRadialExplosionEventOptions);
  150110. /**
  150111. * Returns the data related to the radial explosion event (sphere).
  150112. * @returns The radial explosion event data
  150113. */
  150114. getData(): PhysicsRadialExplosionEventData;
  150115. /**
  150116. * Returns the force and contact point of the impostor or false, if the impostor is not affected by the force/impulse.
  150117. * @param impostor A physics imposter
  150118. * @param origin the origin of the explosion
  150119. * @returns {Nullable<PhysicsHitData>} A physics force and contact point, or null
  150120. */
  150121. getImpostorHitData(impostor: PhysicsImpostor, origin: Vector3): Nullable<PhysicsHitData>;
  150122. /**
  150123. * Triggers affecterd impostors callbacks
  150124. * @param affectedImpostorsWithData defines the list of affected impostors (including associated data)
  150125. */
  150126. triggerAffectedImpostorsCallback(affectedImpostorsWithData: Array<PhysicsAffectedImpostorWithData>): void;
  150127. /**
  150128. * Disposes the sphere.
  150129. * @param force Specifies if the sphere should be disposed by force
  150130. */
  150131. dispose(force?: boolean): void;
  150132. /*** Helpers ***/
  150133. private _prepareSphere;
  150134. private _intersectsWithSphere;
  150135. }
  150136. /**
  150137. * Represents a gravitational field event
  150138. */
  150139. class PhysicsGravitationalFieldEvent {
  150140. private _physicsHelper;
  150141. private _scene;
  150142. private _origin;
  150143. private _options;
  150144. private _tickCallback;
  150145. private _sphere;
  150146. private _dataFetched;
  150147. /**
  150148. * Initializes the physics gravitational field event
  150149. * @param _physicsHelper A physics helper
  150150. * @param _scene BabylonJS scene
  150151. * @param _origin The origin position of the gravitational field event
  150152. * @param _options The options for the vortex event
  150153. */
  150154. constructor(_physicsHelper: PhysicsHelper, _scene: Scene, _origin: Vector3, _options: PhysicsRadialExplosionEventOptions);
  150155. /**
  150156. * Returns the data related to the gravitational field event (sphere).
  150157. * @returns A gravitational field event
  150158. */
  150159. getData(): PhysicsGravitationalFieldEventData;
  150160. /**
  150161. * Enables the gravitational field.
  150162. */
  150163. enable(): void;
  150164. /**
  150165. * Disables the gravitational field.
  150166. */
  150167. disable(): void;
  150168. /**
  150169. * Disposes the sphere.
  150170. * @param force The force to dispose from the gravitational field event
  150171. */
  150172. dispose(force?: boolean): void;
  150173. private _tick;
  150174. }
  150175. /**
  150176. * Represents a physics updraft event
  150177. */
  150178. class PhysicsUpdraftEvent {
  150179. private _scene;
  150180. private _origin;
  150181. private _options;
  150182. private _physicsEngine;
  150183. private _originTop;
  150184. private _originDirection;
  150185. private _tickCallback;
  150186. private _cylinder;
  150187. private _cylinderPosition;
  150188. private _dataFetched;
  150189. /**
  150190. * Initializes the physics updraft event
  150191. * @param _scene BabylonJS scene
  150192. * @param _origin The origin position of the updraft
  150193. * @param _options The options for the updraft event
  150194. */
  150195. constructor(_scene: Scene, _origin: Vector3, _options: PhysicsUpdraftEventOptions);
  150196. /**
  150197. * Returns the data related to the updraft event (cylinder).
  150198. * @returns A physics updraft event
  150199. */
  150200. getData(): PhysicsUpdraftEventData;
  150201. /**
  150202. * Enables the updraft.
  150203. */
  150204. enable(): void;
  150205. /**
  150206. * Disables the updraft.
  150207. */
  150208. disable(): void;
  150209. /**
  150210. * Disposes the cylinder.
  150211. * @param force Specifies if the updraft should be disposed by force
  150212. */
  150213. dispose(force?: boolean): void;
  150214. private getImpostorHitData;
  150215. private _tick;
  150216. /*** Helpers ***/
  150217. private _prepareCylinder;
  150218. private _intersectsWithCylinder;
  150219. }
  150220. /**
  150221. * Represents a physics vortex event
  150222. */
  150223. class PhysicsVortexEvent {
  150224. private _scene;
  150225. private _origin;
  150226. private _options;
  150227. private _physicsEngine;
  150228. private _originTop;
  150229. private _tickCallback;
  150230. private _cylinder;
  150231. private _cylinderPosition;
  150232. private _dataFetched;
  150233. /**
  150234. * Initializes the physics vortex event
  150235. * @param _scene The BabylonJS scene
  150236. * @param _origin The origin position of the vortex
  150237. * @param _options The options for the vortex event
  150238. */
  150239. constructor(_scene: Scene, _origin: Vector3, _options: PhysicsVortexEventOptions);
  150240. /**
  150241. * Returns the data related to the vortex event (cylinder).
  150242. * @returns The physics vortex event data
  150243. */
  150244. getData(): PhysicsVortexEventData;
  150245. /**
  150246. * Enables the vortex.
  150247. */
  150248. enable(): void;
  150249. /**
  150250. * Disables the cortex.
  150251. */
  150252. disable(): void;
  150253. /**
  150254. * Disposes the sphere.
  150255. * @param force
  150256. */
  150257. dispose(force?: boolean): void;
  150258. private getImpostorHitData;
  150259. private _tick;
  150260. /*** Helpers ***/
  150261. private _prepareCylinder;
  150262. private _intersectsWithCylinder;
  150263. }
  150264. /**
  150265. * Options fot the radial explosion event
  150266. * @see https://doc.babylonjs.com/how_to/using_the_physics_engine#further-functionality-of-the-impostor-class
  150267. */
  150268. export class PhysicsRadialExplosionEventOptions {
  150269. /**
  150270. * The radius of the sphere for the radial explosion.
  150271. */
  150272. radius: number;
  150273. /**
  150274. * The strenth of the explosion.
  150275. */
  150276. strength: number;
  150277. /**
  150278. * The strenght of the force in correspondence to the distance of the affected object
  150279. */
  150280. falloff: PhysicsRadialImpulseFalloff;
  150281. /**
  150282. * Sphere options for the radial explosion.
  150283. */
  150284. sphere: {
  150285. segments: number;
  150286. diameter: number;
  150287. };
  150288. /**
  150289. * Sphere options for the radial explosion.
  150290. */
  150291. affectedImpostorsCallback: (affectedImpostorsWithData: Array<PhysicsAffectedImpostorWithData>) => void;
  150292. }
  150293. /**
  150294. * Options fot the updraft event
  150295. * @see https://doc.babylonjs.com/how_to/using_the_physics_engine#further-functionality-of-the-impostor-class
  150296. */
  150297. export class PhysicsUpdraftEventOptions {
  150298. /**
  150299. * The radius of the cylinder for the vortex
  150300. */
  150301. radius: number;
  150302. /**
  150303. * The strenth of the updraft.
  150304. */
  150305. strength: number;
  150306. /**
  150307. * The height of the cylinder for the updraft.
  150308. */
  150309. height: number;
  150310. /**
  150311. * The mode for the the updraft.
  150312. */
  150313. updraftMode: PhysicsUpdraftMode;
  150314. }
  150315. /**
  150316. * Options fot the vortex event
  150317. * @see https://doc.babylonjs.com/how_to/using_the_physics_engine#further-functionality-of-the-impostor-class
  150318. */
  150319. export class PhysicsVortexEventOptions {
  150320. /**
  150321. * The radius of the cylinder for the vortex
  150322. */
  150323. radius: number;
  150324. /**
  150325. * The strenth of the vortex.
  150326. */
  150327. strength: number;
  150328. /**
  150329. * The height of the cylinder for the vortex.
  150330. */
  150331. height: number;
  150332. /**
  150333. * At which distance, relative to the radius the centripetal forces should kick in? Range: 0-1
  150334. */
  150335. centripetalForceThreshold: number;
  150336. /**
  150337. * This multiplier determines with how much force the objects will be pushed sideways/around the vortex, when below the treshold.
  150338. */
  150339. centripetalForceMultiplier: number;
  150340. /**
  150341. * This multiplier determines with how much force the objects will be pushed sideways/around the vortex, when above the treshold.
  150342. */
  150343. centrifugalForceMultiplier: number;
  150344. /**
  150345. * This multiplier determines with how much force the objects will be pushed upwards, when in the vortex.
  150346. */
  150347. updraftForceMultiplier: number;
  150348. }
  150349. /**
  150350. * The strenght of the force in correspondence to the distance of the affected object
  150351. * @see https://doc.babylonjs.com/how_to/using_the_physics_engine#further-functionality-of-the-impostor-class
  150352. */
  150353. export enum PhysicsRadialImpulseFalloff {
  150354. /** Defines that impulse is constant in strength across it's whole radius */
  150355. Constant = 0,
  150356. /** Defines that impulse gets weaker if it's further from the origin */
  150357. Linear = 1
  150358. }
  150359. /**
  150360. * The strength of the force in correspondence to the distance of the affected object
  150361. * @see https://doc.babylonjs.com/how_to/using_the_physics_engine#further-functionality-of-the-impostor-class
  150362. */
  150363. export enum PhysicsUpdraftMode {
  150364. /** Defines that the upstream forces will pull towards the top center of the cylinder */
  150365. Center = 0,
  150366. /** Defines that once a impostor is inside the cylinder, it will shoot out perpendicular from the ground of the cylinder */
  150367. Perpendicular = 1
  150368. }
  150369. /**
  150370. * Interface for a physics hit data
  150371. * @see https://doc.babylonjs.com/how_to/using_the_physics_engine#further-functionality-of-the-impostor-class
  150372. */
  150373. export interface PhysicsHitData {
  150374. /**
  150375. * The force applied at the contact point
  150376. */
  150377. force: Vector3;
  150378. /**
  150379. * The contact point
  150380. */
  150381. contactPoint: Vector3;
  150382. /**
  150383. * The distance from the origin to the contact point
  150384. */
  150385. distanceFromOrigin: number;
  150386. }
  150387. /**
  150388. * Interface for radial explosion event data
  150389. * @see https://doc.babylonjs.com/how_to/using_the_physics_engine#further-functionality-of-the-impostor-class
  150390. */
  150391. export interface PhysicsRadialExplosionEventData {
  150392. /**
  150393. * A sphere used for the radial explosion event
  150394. */
  150395. sphere: Mesh;
  150396. }
  150397. /**
  150398. * Interface for gravitational field event data
  150399. * @see https://doc.babylonjs.com/how_to/using_the_physics_engine#further-functionality-of-the-impostor-class
  150400. */
  150401. export interface PhysicsGravitationalFieldEventData {
  150402. /**
  150403. * A sphere mesh used for the gravitational field event
  150404. */
  150405. sphere: Mesh;
  150406. }
  150407. /**
  150408. * Interface for updraft event data
  150409. * @see https://doc.babylonjs.com/how_to/using_the_physics_engine#further-functionality-of-the-impostor-class
  150410. */
  150411. export interface PhysicsUpdraftEventData {
  150412. /**
  150413. * A cylinder used for the updraft event
  150414. */
  150415. cylinder: Mesh;
  150416. }
  150417. /**
  150418. * Interface for vortex event data
  150419. * @see https://doc.babylonjs.com/how_to/using_the_physics_engine#further-functionality-of-the-impostor-class
  150420. */
  150421. export interface PhysicsVortexEventData {
  150422. /**
  150423. * A cylinder used for the vortex event
  150424. */
  150425. cylinder: Mesh;
  150426. }
  150427. /**
  150428. * Interface for an affected physics impostor
  150429. * @see https://doc.babylonjs.com/how_to/using_the_physics_engine#further-functionality-of-the-impostor-class
  150430. */
  150431. export interface PhysicsAffectedImpostorWithData {
  150432. /**
  150433. * The impostor affected by the effect
  150434. */
  150435. impostor: PhysicsImpostor;
  150436. /**
  150437. * The data about the hit/horce from the explosion
  150438. */
  150439. hitData: PhysicsHitData;
  150440. }
  150441. }
  150442. declare module BABYLON {
  150443. /** @hidden */
  150444. export var blackAndWhitePixelShader: {
  150445. name: string;
  150446. shader: string;
  150447. };
  150448. }
  150449. declare module BABYLON {
  150450. /**
  150451. * Post process used to render in black and white
  150452. */
  150453. export class BlackAndWhitePostProcess extends PostProcess {
  150454. /**
  150455. * Linear about to convert he result to black and white (default: 1)
  150456. */
  150457. degree: number;
  150458. /**
  150459. * Gets a string identifying the name of the class
  150460. * @returns "BlackAndWhitePostProcess" string
  150461. */
  150462. getClassName(): string;
  150463. /**
  150464. * Creates a black and white post process
  150465. * @see https://doc.babylonjs.com/how_to/how_to_use_postprocesses#black-and-white
  150466. * @param name The name of the effect.
  150467. * @param options The required width/height ratio to downsize to before computing the render pass.
  150468. * @param camera The camera to apply the render pass to.
  150469. * @param samplingMode The sampling mode to be used when computing the pass. (default: 0)
  150470. * @param engine The engine which the post process will be applied. (default: current engine)
  150471. * @param reusable If the post process can be reused on the same frame. (default: false)
  150472. */
  150473. constructor(name: string, options: number | PostProcessOptions, camera: Camera, samplingMode?: number, engine?: Engine, reusable?: boolean);
  150474. /** @hidden */
  150475. static _Parse(parsedPostProcess: any, targetCamera: Camera, scene: Scene, rootUrl: string): Nullable<BlackAndWhitePostProcess>;
  150476. }
  150477. }
  150478. declare module BABYLON {
  150479. /**
  150480. * This represents a set of one or more post processes in Babylon.
  150481. * A post process can be used to apply a shader to a texture after it is rendered.
  150482. * @example https://doc.babylonjs.com/how_to/how_to_use_postprocessrenderpipeline
  150483. */
  150484. export class PostProcessRenderEffect {
  150485. private _postProcesses;
  150486. private _getPostProcesses;
  150487. private _singleInstance;
  150488. private _cameras;
  150489. private _indicesForCamera;
  150490. /**
  150491. * Name of the effect
  150492. * @hidden
  150493. */
  150494. _name: string;
  150495. /**
  150496. * Instantiates a post process render effect.
  150497. * A post process can be used to apply a shader to a texture after it is rendered.
  150498. * @param engine The engine the effect is tied to
  150499. * @param name The name of the effect
  150500. * @param getPostProcesses A function that returns a set of post processes which the effect will run in order to be run.
  150501. * @param singleInstance False if this post process can be run on multiple cameras. (default: true)
  150502. */
  150503. constructor(engine: Engine, name: string, getPostProcesses: () => Nullable<PostProcess | Array<PostProcess>>, singleInstance?: boolean);
  150504. /**
  150505. * Checks if all the post processes in the effect are supported.
  150506. */
  150507. get isSupported(): boolean;
  150508. /**
  150509. * Updates the current state of the effect
  150510. * @hidden
  150511. */
  150512. _update(): void;
  150513. /**
  150514. * Attaches the effect on cameras
  150515. * @param cameras The camera to attach to.
  150516. * @hidden
  150517. */
  150518. _attachCameras(cameras: Camera): void;
  150519. /**
  150520. * Attaches the effect on cameras
  150521. * @param cameras The camera to attach to.
  150522. * @hidden
  150523. */
  150524. _attachCameras(cameras: Camera[]): void;
  150525. /**
  150526. * Detaches the effect on cameras
  150527. * @param cameras The camera to detatch from.
  150528. * @hidden
  150529. */
  150530. _detachCameras(cameras: Camera): void;
  150531. /**
  150532. * Detatches the effect on cameras
  150533. * @param cameras The camera to detatch from.
  150534. * @hidden
  150535. */
  150536. _detachCameras(cameras: Camera[]): void;
  150537. /**
  150538. * Enables the effect on given cameras
  150539. * @param cameras The camera to enable.
  150540. * @hidden
  150541. */
  150542. _enable(cameras: Camera): void;
  150543. /**
  150544. * Enables the effect on given cameras
  150545. * @param cameras The camera to enable.
  150546. * @hidden
  150547. */
  150548. _enable(cameras: Nullable<Camera[]>): void;
  150549. /**
  150550. * Disables the effect on the given cameras
  150551. * @param cameras The camera to disable.
  150552. * @hidden
  150553. */
  150554. _disable(cameras: Camera): void;
  150555. /**
  150556. * Disables the effect on the given cameras
  150557. * @param cameras The camera to disable.
  150558. * @hidden
  150559. */
  150560. _disable(cameras: Nullable<Camera[]>): void;
  150561. /**
  150562. * Gets a list of the post processes contained in the effect.
  150563. * @param camera The camera to get the post processes on.
  150564. * @returns The list of the post processes in the effect.
  150565. */
  150566. getPostProcesses(camera?: Camera): Nullable<Array<PostProcess>>;
  150567. }
  150568. }
  150569. declare module BABYLON {
  150570. /** @hidden */
  150571. export var extractHighlightsPixelShader: {
  150572. name: string;
  150573. shader: string;
  150574. };
  150575. }
  150576. declare module BABYLON {
  150577. /**
  150578. * 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.
  150579. */
  150580. export class ExtractHighlightsPostProcess extends PostProcess {
  150581. /**
  150582. * The luminance threshold, pixels below this value will be set to black.
  150583. */
  150584. threshold: number;
  150585. /** @hidden */
  150586. _exposure: number;
  150587. /**
  150588. * Post process which has the input texture to be used when performing highlight extraction
  150589. * @hidden
  150590. */
  150591. _inputPostProcess: Nullable<PostProcess>;
  150592. /**
  150593. * Gets a string identifying the name of the class
  150594. * @returns "ExtractHighlightsPostProcess" string
  150595. */
  150596. getClassName(): string;
  150597. constructor(name: string, options: number | PostProcessOptions, camera: Nullable<Camera>, samplingMode?: number, engine?: Engine, reusable?: boolean, textureType?: number, blockCompilation?: boolean);
  150598. }
  150599. }
  150600. declare module BABYLON {
  150601. /** @hidden */
  150602. export var bloomMergePixelShader: {
  150603. name: string;
  150604. shader: string;
  150605. };
  150606. }
  150607. declare module BABYLON {
  150608. /**
  150609. * The BloomMergePostProcess merges blurred images with the original based on the values of the circle of confusion.
  150610. */
  150611. export class BloomMergePostProcess extends PostProcess {
  150612. /** Weight of the bloom to be added to the original input. */
  150613. weight: number;
  150614. /**
  150615. * Gets a string identifying the name of the class
  150616. * @returns "BloomMergePostProcess" string
  150617. */
  150618. getClassName(): string;
  150619. /**
  150620. * Creates a new instance of @see BloomMergePostProcess
  150621. * @param name The name of the effect.
  150622. * @param originalFromInput Post process which's input will be used for the merge.
  150623. * @param blurred Blurred highlights post process which's output will be used.
  150624. * @param weight Weight of the bloom to be added to the original input.
  150625. * @param options The required width/height ratio to downsize to before computing the render pass.
  150626. * @param camera The camera to apply the render pass to.
  150627. * @param samplingMode The sampling mode to be used when computing the pass. (default: 0)
  150628. * @param engine The engine which the post process will be applied. (default: current engine)
  150629. * @param reusable If the post process can be reused on the same frame. (default: false)
  150630. * @param textureType Type of textures used when performing the post process. (default: 0)
  150631. * @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)
  150632. */
  150633. constructor(name: string, originalFromInput: PostProcess, blurred: PostProcess,
  150634. /** Weight of the bloom to be added to the original input. */
  150635. weight: number, options: number | PostProcessOptions, camera: Nullable<Camera>, samplingMode?: number, engine?: Engine, reusable?: boolean, textureType?: number, blockCompilation?: boolean);
  150636. }
  150637. }
  150638. declare module BABYLON {
  150639. /**
  150640. * The bloom effect spreads bright areas of an image to simulate artifacts seen in cameras
  150641. */
  150642. export class BloomEffect extends PostProcessRenderEffect {
  150643. private bloomScale;
  150644. /**
  150645. * @hidden Internal
  150646. */
  150647. _effects: Array<PostProcess>;
  150648. /**
  150649. * @hidden Internal
  150650. */
  150651. _downscale: ExtractHighlightsPostProcess;
  150652. private _blurX;
  150653. private _blurY;
  150654. private _merge;
  150655. /**
  150656. * The luminance threshold to find bright areas of the image to bloom.
  150657. */
  150658. get threshold(): number;
  150659. set threshold(value: number);
  150660. /**
  150661. * The strength of the bloom.
  150662. */
  150663. get weight(): number;
  150664. set weight(value: number);
  150665. /**
  150666. * Specifies the size of the bloom blur kernel, relative to the final output size
  150667. */
  150668. get kernel(): number;
  150669. set kernel(value: number);
  150670. /**
  150671. * Creates a new instance of @see BloomEffect
  150672. * @param scene The scene the effect belongs to.
  150673. * @param bloomScale The ratio of the blur texture to the input texture that should be used to compute the bloom.
  150674. * @param bloomKernel The size of the kernel to be used when applying the blur.
  150675. * @param bloomWeight The the strength of bloom.
  150676. * @param pipelineTextureType The type of texture to be used when performing the post processing.
  150677. * @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)
  150678. */
  150679. constructor(scene: Scene, bloomScale: number, bloomWeight: number, bloomKernel: number, pipelineTextureType?: number, blockCompilation?: boolean);
  150680. /**
  150681. * Disposes each of the internal effects for a given camera.
  150682. * @param camera The camera to dispose the effect on.
  150683. */
  150684. disposeEffects(camera: Camera): void;
  150685. /**
  150686. * @hidden Internal
  150687. */
  150688. _updateEffects(): void;
  150689. /**
  150690. * Internal
  150691. * @returns if all the contained post processes are ready.
  150692. * @hidden
  150693. */
  150694. _isReady(): boolean;
  150695. }
  150696. }
  150697. declare module BABYLON {
  150698. /** @hidden */
  150699. export var chromaticAberrationPixelShader: {
  150700. name: string;
  150701. shader: string;
  150702. };
  150703. }
  150704. declare module BABYLON {
  150705. /**
  150706. * The ChromaticAberrationPostProcess separates the rgb channels in an image to produce chromatic distortion around the edges of the screen
  150707. */
  150708. export class ChromaticAberrationPostProcess extends PostProcess {
  150709. /**
  150710. * The amount of seperation of rgb channels (default: 30)
  150711. */
  150712. aberrationAmount: number;
  150713. /**
  150714. * The amount the effect will increase for pixels closer to the edge of the screen. (default: 0)
  150715. */
  150716. radialIntensity: number;
  150717. /**
  150718. * 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))
  150719. */
  150720. direction: Vector2;
  150721. /**
  150722. * 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))
  150723. */
  150724. centerPosition: Vector2;
  150725. /** The width of the screen to apply the effect on */
  150726. screenWidth: number;
  150727. /** The height of the screen to apply the effect on */
  150728. screenHeight: number;
  150729. /**
  150730. * Gets a string identifying the name of the class
  150731. * @returns "ChromaticAberrationPostProcess" string
  150732. */
  150733. getClassName(): string;
  150734. /**
  150735. * Creates a new instance ChromaticAberrationPostProcess
  150736. * @param name The name of the effect.
  150737. * @param screenWidth The width of the screen to apply the effect on.
  150738. * @param screenHeight The height of the screen to apply the effect on.
  150739. * @param options The required width/height ratio to downsize to before computing the render pass.
  150740. * @param camera The camera to apply the render pass to.
  150741. * @param samplingMode The sampling mode to be used when computing the pass. (default: 0)
  150742. * @param engine The engine which the post process will be applied. (default: current engine)
  150743. * @param reusable If the post process can be reused on the same frame. (default: false)
  150744. * @param textureType Type of textures used when performing the post process. (default: 0)
  150745. * @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)
  150746. */
  150747. constructor(name: string, screenWidth: number, screenHeight: number, options: number | PostProcessOptions, camera: Nullable<Camera>, samplingMode?: number, engine?: Engine, reusable?: boolean, textureType?: number, blockCompilation?: boolean);
  150748. /** @hidden */
  150749. static _Parse(parsedPostProcess: any, targetCamera: Camera, scene: Scene, rootUrl: string): Nullable<ChromaticAberrationPostProcess>;
  150750. }
  150751. }
  150752. declare module BABYLON {
  150753. /** @hidden */
  150754. export var circleOfConfusionPixelShader: {
  150755. name: string;
  150756. shader: string;
  150757. };
  150758. }
  150759. declare module BABYLON {
  150760. /**
  150761. * The CircleOfConfusionPostProcess computes the circle of confusion value for each pixel given required lens parameters. See https://en.wikipedia.org/wiki/Circle_of_confusion
  150762. */
  150763. export class CircleOfConfusionPostProcess extends PostProcess {
  150764. /**
  150765. * 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.
  150766. */
  150767. lensSize: number;
  150768. /**
  150769. * F-Stop of the effect's camera. The diamater of the resulting aperture can be computed by lensSize/fStop. (default: 1.4)
  150770. */
  150771. fStop: number;
  150772. /**
  150773. * Distance away from the camera to focus on in scene units/1000 (eg. millimeter). (default: 2000)
  150774. */
  150775. focusDistance: number;
  150776. /**
  150777. * Focal length of the effect's camera in scene units/1000 (eg. millimeter). (default: 50)
  150778. */
  150779. focalLength: number;
  150780. /**
  150781. * Gets a string identifying the name of the class
  150782. * @returns "CircleOfConfusionPostProcess" string
  150783. */
  150784. getClassName(): string;
  150785. private _depthTexture;
  150786. /**
  150787. * Creates a new instance CircleOfConfusionPostProcess
  150788. * @param name The name of the effect.
  150789. * @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.
  150790. * @param options The required width/height ratio to downsize to before computing the render pass.
  150791. * @param camera The camera to apply the render pass to.
  150792. * @param samplingMode The sampling mode to be used when computing the pass. (default: 0)
  150793. * @param engine The engine which the post process will be applied. (default: current engine)
  150794. * @param reusable If the post process can be reused on the same frame. (default: false)
  150795. * @param textureType Type of textures used when performing the post process. (default: 0)
  150796. * @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)
  150797. */
  150798. constructor(name: string, depthTexture: Nullable<RenderTargetTexture>, options: number | PostProcessOptions, camera: Nullable<Camera>, samplingMode?: number, engine?: Engine, reusable?: boolean, textureType?: number, blockCompilation?: boolean);
  150799. /**
  150800. * 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.
  150801. */
  150802. set depthTexture(value: RenderTargetTexture);
  150803. }
  150804. }
  150805. declare module BABYLON {
  150806. /** @hidden */
  150807. export var colorCorrectionPixelShader: {
  150808. name: string;
  150809. shader: string;
  150810. };
  150811. }
  150812. declare module BABYLON {
  150813. /**
  150814. *
  150815. * This post-process allows the modification of rendered colors by using
  150816. * a 'look-up table' (LUT). This effect is also called Color Grading.
  150817. *
  150818. * The object needs to be provided an url to a texture containing the color
  150819. * look-up table: the texture must be 256 pixels wide and 16 pixels high.
  150820. * Use an image editing software to tweak the LUT to match your needs.
  150821. *
  150822. * For an example of a color LUT, see here:
  150823. * @see http://udn.epicgames.com/Three/rsrc/Three/ColorGrading/RGBTable16x1.png
  150824. * For explanations on color grading, see here:
  150825. * @see http://udn.epicgames.com/Three/ColorGrading.html
  150826. *
  150827. */
  150828. export class ColorCorrectionPostProcess extends PostProcess {
  150829. private _colorTableTexture;
  150830. /**
  150831. * Gets the color table url used to create the LUT texture
  150832. */
  150833. colorTableUrl: string;
  150834. /**
  150835. * Gets a string identifying the name of the class
  150836. * @returns "ColorCorrectionPostProcess" string
  150837. */
  150838. getClassName(): string;
  150839. constructor(name: string, colorTableUrl: string, options: number | PostProcessOptions, camera: Camera, samplingMode?: number, engine?: Engine, reusable?: boolean);
  150840. /** @hidden */
  150841. static _Parse(parsedPostProcess: any, targetCamera: Camera, scene: Scene, rootUrl: string): Nullable<ColorCorrectionPostProcess>;
  150842. }
  150843. }
  150844. declare module BABYLON {
  150845. /** @hidden */
  150846. export var convolutionPixelShader: {
  150847. name: string;
  150848. shader: string;
  150849. };
  150850. }
  150851. declare module BABYLON {
  150852. /**
  150853. * The ConvolutionPostProcess applies a 3x3 kernel to every pixel of the
  150854. * input texture to perform effects such as edge detection or sharpening
  150855. * See http://en.wikipedia.org/wiki/Kernel_(image_processing)
  150856. */
  150857. export class ConvolutionPostProcess extends PostProcess {
  150858. /** Array of 9 values corresponding to the 3x3 kernel to be applied */
  150859. kernel: number[];
  150860. /**
  150861. * Gets a string identifying the name of the class
  150862. * @returns "ConvolutionPostProcess" string
  150863. */
  150864. getClassName(): string;
  150865. /**
  150866. * Creates a new instance ConvolutionPostProcess
  150867. * @param name The name of the effect.
  150868. * @param kernel Array of 9 values corresponding to the 3x3 kernel to be applied
  150869. * @param options The required width/height ratio to downsize to before computing the render pass.
  150870. * @param camera The camera to apply the render pass to.
  150871. * @param samplingMode The sampling mode to be used when computing the pass. (default: 0)
  150872. * @param engine The engine which the post process will be applied. (default: current engine)
  150873. * @param reusable If the post process can be reused on the same frame. (default: false)
  150874. * @param textureType Type of textures used when performing the post process. (default: 0)
  150875. */
  150876. constructor(name: string, kernel: number[], options: number | PostProcessOptions, camera: Nullable<Camera>, samplingMode?: number, engine?: Engine, reusable?: boolean, textureType?: number);
  150877. /** @hidden */
  150878. static _Parse(parsedPostProcess: any, targetCamera: Camera, scene: Scene, rootUrl: string): Nullable<ConvolutionPostProcess>;
  150879. /**
  150880. * Edge detection 0 see https://en.wikipedia.org/wiki/Kernel_(image_processing)
  150881. */
  150882. static EdgeDetect0Kernel: number[];
  150883. /**
  150884. * Edge detection 1 see https://en.wikipedia.org/wiki/Kernel_(image_processing)
  150885. */
  150886. static EdgeDetect1Kernel: number[];
  150887. /**
  150888. * Edge detection 2 see https://en.wikipedia.org/wiki/Kernel_(image_processing)
  150889. */
  150890. static EdgeDetect2Kernel: number[];
  150891. /**
  150892. * Kernel to sharpen an image see https://en.wikipedia.org/wiki/Kernel_(image_processing)
  150893. */
  150894. static SharpenKernel: number[];
  150895. /**
  150896. * Kernel to emboss an image see https://en.wikipedia.org/wiki/Kernel_(image_processing)
  150897. */
  150898. static EmbossKernel: number[];
  150899. /**
  150900. * Kernel to blur an image see https://en.wikipedia.org/wiki/Kernel_(image_processing)
  150901. */
  150902. static GaussianKernel: number[];
  150903. }
  150904. }
  150905. declare module BABYLON {
  150906. /**
  150907. * The DepthOfFieldBlurPostProcess applied a blur in a give direction.
  150908. * This blur differs from the standard BlurPostProcess as it attempts to avoid blurring pixels
  150909. * based on samples that have a large difference in distance than the center pixel.
  150910. * See section 2.6.2 http://fileadmin.cs.lth.se/cs/education/edan35/lectures/12dof.pdf
  150911. */
  150912. export class DepthOfFieldBlurPostProcess extends BlurPostProcess {
  150913. /**
  150914. * The direction the blur should be applied
  150915. */
  150916. direction: Vector2;
  150917. /**
  150918. * Gets a string identifying the name of the class
  150919. * @returns "DepthOfFieldBlurPostProcess" string
  150920. */
  150921. getClassName(): string;
  150922. /**
  150923. * Creates a new instance CircleOfConfusionPostProcess
  150924. * @param name The name of the effect.
  150925. * @param scene The scene the effect belongs to.
  150926. * @param direction The direction the blur should be applied.
  150927. * @param kernel The size of the kernel used to blur.
  150928. * @param options The required width/height ratio to downsize to before computing the render pass.
  150929. * @param camera The camera to apply the render pass to.
  150930. * @param circleOfConfusion The circle of confusion + depth map to be used to avoid blurring accross edges
  150931. * @param imageToBlur The image to apply the blur to (default: Current rendered frame)
  150932. * @param samplingMode The sampling mode to be used when computing the pass. (default: 0)
  150933. * @param engine The engine which the post process will be applied. (default: current engine)
  150934. * @param reusable If the post process can be reused on the same frame. (default: false)
  150935. * @param textureType Type of textures used when performing the post process. (default: 0)
  150936. * @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)
  150937. */
  150938. 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);
  150939. }
  150940. }
  150941. declare module BABYLON {
  150942. /** @hidden */
  150943. export var depthOfFieldMergePixelShader: {
  150944. name: string;
  150945. shader: string;
  150946. };
  150947. }
  150948. declare module BABYLON {
  150949. /**
  150950. * Options to be set when merging outputs from the default pipeline.
  150951. */
  150952. export class DepthOfFieldMergePostProcessOptions {
  150953. /**
  150954. * The original image to merge on top of
  150955. */
  150956. originalFromInput: PostProcess;
  150957. /**
  150958. * Parameters to perform the merge of the depth of field effect
  150959. */
  150960. depthOfField?: {
  150961. circleOfConfusion: PostProcess;
  150962. blurSteps: Array<PostProcess>;
  150963. };
  150964. /**
  150965. * Parameters to perform the merge of bloom effect
  150966. */
  150967. bloom?: {
  150968. blurred: PostProcess;
  150969. weight: number;
  150970. };
  150971. }
  150972. /**
  150973. * The DepthOfFieldMergePostProcess merges blurred images with the original based on the values of the circle of confusion.
  150974. */
  150975. export class DepthOfFieldMergePostProcess extends PostProcess {
  150976. private blurSteps;
  150977. /**
  150978. * Gets a string identifying the name of the class
  150979. * @returns "DepthOfFieldMergePostProcess" string
  150980. */
  150981. getClassName(): string;
  150982. /**
  150983. * Creates a new instance of DepthOfFieldMergePostProcess
  150984. * @param name The name of the effect.
  150985. * @param originalFromInput Post process which's input will be used for the merge.
  150986. * @param circleOfConfusion Circle of confusion post process which's output will be used to blur each pixel.
  150987. * @param blurSteps Blur post processes from low to high which will be mixed with the original image.
  150988. * @param options The required width/height ratio to downsize to before computing the render pass.
  150989. * @param camera The camera to apply the render pass to.
  150990. * @param samplingMode The sampling mode to be used when computing the pass. (default: 0)
  150991. * @param engine The engine which the post process will be applied. (default: current engine)
  150992. * @param reusable If the post process can be reused on the same frame. (default: false)
  150993. * @param textureType Type of textures used when performing the post process. (default: 0)
  150994. * @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)
  150995. */
  150996. 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);
  150997. /**
  150998. * Updates the effect with the current post process compile time values and recompiles the shader.
  150999. * @param defines Define statements that should be added at the beginning of the shader. (default: null)
  151000. * @param uniforms Set of uniform variables that will be passed to the shader. (default: null)
  151001. * @param samplers Set of Texture2D variables that will be passed to the shader. (default: null)
  151002. * @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
  151003. * @param onCompiled Called when the shader has been compiled.
  151004. * @param onError Called if there is an error when compiling a shader.
  151005. */
  151006. updateEffect(defines?: Nullable<string>, uniforms?: Nullable<string[]>, samplers?: Nullable<string[]>, indexParameters?: any, onCompiled?: (effect: Effect) => void, onError?: (effect: Effect, errors: string) => void): void;
  151007. }
  151008. }
  151009. declare module BABYLON {
  151010. /**
  151011. * Specifies the level of max blur that should be applied when using the depth of field effect
  151012. */
  151013. export enum DepthOfFieldEffectBlurLevel {
  151014. /**
  151015. * Subtle blur
  151016. */
  151017. Low = 0,
  151018. /**
  151019. * Medium blur
  151020. */
  151021. Medium = 1,
  151022. /**
  151023. * Large blur
  151024. */
  151025. High = 2
  151026. }
  151027. /**
  151028. * The depth of field effect applies a blur to objects that are closer or further from where the camera is focusing.
  151029. */
  151030. export class DepthOfFieldEffect extends PostProcessRenderEffect {
  151031. private _circleOfConfusion;
  151032. /**
  151033. * @hidden Internal, blurs from high to low
  151034. */
  151035. _depthOfFieldBlurX: Array<DepthOfFieldBlurPostProcess>;
  151036. private _depthOfFieldBlurY;
  151037. private _dofMerge;
  151038. /**
  151039. * @hidden Internal post processes in depth of field effect
  151040. */
  151041. _effects: Array<PostProcess>;
  151042. /**
  151043. * The focal the length of the camera used in the effect in scene units/1000 (eg. millimeter)
  151044. */
  151045. set focalLength(value: number);
  151046. get focalLength(): number;
  151047. /**
  151048. * F-Stop of the effect's camera. The diameter of the resulting aperture can be computed by lensSize/fStop. (default: 1.4)
  151049. */
  151050. set fStop(value: number);
  151051. get fStop(): number;
  151052. /**
  151053. * Distance away from the camera to focus on in scene units/1000 (eg. millimeter). (default: 2000)
  151054. */
  151055. set focusDistance(value: number);
  151056. get focusDistance(): number;
  151057. /**
  151058. * 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.
  151059. */
  151060. set lensSize(value: number);
  151061. get lensSize(): number;
  151062. /**
  151063. * Creates a new instance DepthOfFieldEffect
  151064. * @param scene The scene the effect belongs to.
  151065. * @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.
  151066. * @param pipelineTextureType The type of texture to be used when performing the post processing.
  151067. * @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)
  151068. */
  151069. constructor(scene: Scene, depthTexture: Nullable<RenderTargetTexture>, blurLevel?: DepthOfFieldEffectBlurLevel, pipelineTextureType?: number, blockCompilation?: boolean);
  151070. /**
  151071. * Get the current class name of the current effet
  151072. * @returns "DepthOfFieldEffect"
  151073. */
  151074. getClassName(): string;
  151075. /**
  151076. * 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.
  151077. */
  151078. set depthTexture(value: RenderTargetTexture);
  151079. /**
  151080. * Disposes each of the internal effects for a given camera.
  151081. * @param camera The camera to dispose the effect on.
  151082. */
  151083. disposeEffects(camera: Camera): void;
  151084. /**
  151085. * @hidden Internal
  151086. */
  151087. _updateEffects(): void;
  151088. /**
  151089. * Internal
  151090. * @returns if all the contained post processes are ready.
  151091. * @hidden
  151092. */
  151093. _isReady(): boolean;
  151094. }
  151095. }
  151096. declare module BABYLON {
  151097. /** @hidden */
  151098. export var displayPassPixelShader: {
  151099. name: string;
  151100. shader: string;
  151101. };
  151102. }
  151103. declare module BABYLON {
  151104. /**
  151105. * DisplayPassPostProcess which produces an output the same as it's input
  151106. */
  151107. export class DisplayPassPostProcess extends PostProcess {
  151108. /**
  151109. * Gets a string identifying the name of the class
  151110. * @returns "DisplayPassPostProcess" string
  151111. */
  151112. getClassName(): string;
  151113. /**
  151114. * Creates the DisplayPassPostProcess
  151115. * @param name The name of the effect.
  151116. * @param options The required width/height ratio to downsize to before computing the render pass.
  151117. * @param camera The camera to apply the render pass to.
  151118. * @param samplingMode The sampling mode to be used when computing the pass. (default: 0)
  151119. * @param engine The engine which the post process will be applied. (default: current engine)
  151120. * @param reusable If the post process can be reused on the same frame. (default: false)
  151121. */
  151122. constructor(name: string, options: number | PostProcessOptions, camera: Nullable<Camera>, samplingMode?: number, engine?: Engine, reusable?: boolean);
  151123. /** @hidden */
  151124. static _Parse(parsedPostProcess: any, targetCamera: Camera, scene: Scene, rootUrl: string): Nullable<DisplayPassPostProcess>;
  151125. }
  151126. }
  151127. declare module BABYLON {
  151128. /** @hidden */
  151129. export var filterPixelShader: {
  151130. name: string;
  151131. shader: string;
  151132. };
  151133. }
  151134. declare module BABYLON {
  151135. /**
  151136. * Applies a kernel filter to the image
  151137. */
  151138. export class FilterPostProcess extends PostProcess {
  151139. /** The matrix to be applied to the image */
  151140. kernelMatrix: Matrix;
  151141. /**
  151142. * Gets a string identifying the name of the class
  151143. * @returns "FilterPostProcess" string
  151144. */
  151145. getClassName(): string;
  151146. /**
  151147. *
  151148. * @param name The name of the effect.
  151149. * @param kernelMatrix The matrix to be applied to the image
  151150. * @param options The required width/height ratio to downsize to before computing the render pass.
  151151. * @param camera The camera to apply the render pass to.
  151152. * @param samplingMode The sampling mode to be used when computing the pass. (default: 0)
  151153. * @param engine The engine which the post process will be applied. (default: current engine)
  151154. * @param reusable If the post process can be reused on the same frame. (default: false)
  151155. */
  151156. constructor(name: string, kernelMatrix: Matrix, options: number | PostProcessOptions, camera: Nullable<Camera>, samplingMode?: number, engine?: Engine, reusable?: boolean);
  151157. /** @hidden */
  151158. static _Parse(parsedPostProcess: any, targetCamera: Camera, scene: Scene, rootUrl: string): Nullable<FilterPostProcess>;
  151159. }
  151160. }
  151161. declare module BABYLON {
  151162. /** @hidden */
  151163. export var fxaaPixelShader: {
  151164. name: string;
  151165. shader: string;
  151166. };
  151167. }
  151168. declare module BABYLON {
  151169. /** @hidden */
  151170. export var fxaaVertexShader: {
  151171. name: string;
  151172. shader: string;
  151173. };
  151174. }
  151175. declare module BABYLON {
  151176. /**
  151177. * Fxaa post process
  151178. * @see https://doc.babylonjs.com/how_to/how_to_use_postprocesses#fxaa
  151179. */
  151180. export class FxaaPostProcess extends PostProcess {
  151181. /**
  151182. * Gets a string identifying the name of the class
  151183. * @returns "FxaaPostProcess" string
  151184. */
  151185. getClassName(): string;
  151186. constructor(name: string, options: number | PostProcessOptions, camera?: Nullable<Camera>, samplingMode?: number, engine?: Engine, reusable?: boolean, textureType?: number);
  151187. private _getDefines;
  151188. /** @hidden */
  151189. static _Parse(parsedPostProcess: any, targetCamera: Camera, scene: Scene, rootUrl: string): FxaaPostProcess;
  151190. }
  151191. }
  151192. declare module BABYLON {
  151193. /** @hidden */
  151194. export var grainPixelShader: {
  151195. name: string;
  151196. shader: string;
  151197. };
  151198. }
  151199. declare module BABYLON {
  151200. /**
  151201. * The GrainPostProcess adds noise to the image at mid luminance levels
  151202. */
  151203. export class GrainPostProcess extends PostProcess {
  151204. /**
  151205. * The intensity of the grain added (default: 30)
  151206. */
  151207. intensity: number;
  151208. /**
  151209. * If the grain should be randomized on every frame
  151210. */
  151211. animated: boolean;
  151212. /**
  151213. * Gets a string identifying the name of the class
  151214. * @returns "GrainPostProcess" string
  151215. */
  151216. getClassName(): string;
  151217. /**
  151218. * Creates a new instance of @see GrainPostProcess
  151219. * @param name The name of the effect.
  151220. * @param options The required width/height ratio to downsize to before computing the render pass.
  151221. * @param camera The camera to apply the render pass to.
  151222. * @param samplingMode The sampling mode to be used when computing the pass. (default: 0)
  151223. * @param engine The engine which the post process will be applied. (default: current engine)
  151224. * @param reusable If the post process can be reused on the same frame. (default: false)
  151225. * @param textureType Type of textures used when performing the post process. (default: 0)
  151226. * @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)
  151227. */
  151228. constructor(name: string, options: number | PostProcessOptions, camera: Nullable<Camera>, samplingMode?: number, engine?: Engine, reusable?: boolean, textureType?: number, blockCompilation?: boolean);
  151229. /** @hidden */
  151230. static _Parse(parsedPostProcess: any, targetCamera: Camera, scene: Scene, rootUrl: string): GrainPostProcess;
  151231. }
  151232. }
  151233. declare module BABYLON {
  151234. /** @hidden */
  151235. export var highlightsPixelShader: {
  151236. name: string;
  151237. shader: string;
  151238. };
  151239. }
  151240. declare module BABYLON {
  151241. /**
  151242. * Extracts highlights from the image
  151243. * @see https://doc.babylonjs.com/how_to/how_to_use_postprocesses
  151244. */
  151245. export class HighlightsPostProcess extends PostProcess {
  151246. /**
  151247. * Gets a string identifying the name of the class
  151248. * @returns "HighlightsPostProcess" string
  151249. */
  151250. getClassName(): string;
  151251. /**
  151252. * Extracts highlights from the image
  151253. * @see https://doc.babylonjs.com/how_to/how_to_use_postprocesses
  151254. * @param name The name of the effect.
  151255. * @param options The required width/height ratio to downsize to before computing the render pass.
  151256. * @param camera The camera to apply the render pass to.
  151257. * @param samplingMode The sampling mode to be used when computing the pass. (default: 0)
  151258. * @param engine The engine which the post process will be applied. (default: current engine)
  151259. * @param reusable If the post process can be reused on the same frame. (default: false)
  151260. * @param textureType Type of texture for the post process (default: Engine.TEXTURETYPE_UNSIGNED_INT)
  151261. */
  151262. constructor(name: string, options: number | PostProcessOptions, camera: Nullable<Camera>, samplingMode?: number, engine?: Engine, reusable?: boolean, textureType?: number);
  151263. }
  151264. }
  151265. declare module BABYLON {
  151266. /**
  151267. * Contains all parameters needed for the prepass to perform
  151268. * motion blur
  151269. */
  151270. export class MotionBlurConfiguration implements PrePassEffectConfiguration {
  151271. /**
  151272. * Is motion blur enabled
  151273. */
  151274. enabled: boolean;
  151275. /**
  151276. * Name of the configuration
  151277. */
  151278. name: string;
  151279. /**
  151280. * Textures that should be present in the MRT for this effect to work
  151281. */
  151282. readonly texturesRequired: number[];
  151283. }
  151284. }
  151285. declare module BABYLON {
  151286. interface Scene {
  151287. /** @hidden (Backing field) */
  151288. _geometryBufferRenderer: Nullable<GeometryBufferRenderer>;
  151289. /**
  151290. * Gets or Sets the current geometry buffer associated to the scene.
  151291. */
  151292. geometryBufferRenderer: Nullable<GeometryBufferRenderer>;
  151293. /**
  151294. * Enables a GeometryBufferRender and associates it with the scene
  151295. * @param ratio defines the scaling ratio to apply to the renderer (1 by default which means same resolution)
  151296. * @returns the GeometryBufferRenderer
  151297. */
  151298. enableGeometryBufferRenderer(ratio?: number): Nullable<GeometryBufferRenderer>;
  151299. /**
  151300. * Disables the GeometryBufferRender associated with the scene
  151301. */
  151302. disableGeometryBufferRenderer(): void;
  151303. }
  151304. /**
  151305. * Defines the Geometry Buffer scene component responsible to manage a G-Buffer useful
  151306. * in several rendering techniques.
  151307. */
  151308. export class GeometryBufferRendererSceneComponent implements ISceneComponent {
  151309. /**
  151310. * The component name helpful to identify the component in the list of scene components.
  151311. */
  151312. readonly name: string;
  151313. /**
  151314. * The scene the component belongs to.
  151315. */
  151316. scene: Scene;
  151317. /**
  151318. * Creates a new instance of the component for the given scene
  151319. * @param scene Defines the scene to register the component in
  151320. */
  151321. constructor(scene: Scene);
  151322. /**
  151323. * Registers the component in a given scene
  151324. */
  151325. register(): void;
  151326. /**
  151327. * Rebuilds the elements related to this component in case of
  151328. * context lost for instance.
  151329. */
  151330. rebuild(): void;
  151331. /**
  151332. * Disposes the component and the associated ressources
  151333. */
  151334. dispose(): void;
  151335. private _gatherRenderTargets;
  151336. }
  151337. }
  151338. declare module BABYLON {
  151339. /** @hidden */
  151340. export var motionBlurPixelShader: {
  151341. name: string;
  151342. shader: string;
  151343. };
  151344. }
  151345. declare module BABYLON {
  151346. /**
  151347. * The Motion Blur Post Process which blurs an image based on the objects velocity in scene.
  151348. * Velocity can be affected by each object's rotation, position and scale depending on the transformation speed.
  151349. * As an example, all you have to do is to create the post-process:
  151350. * var mb = new BABYLON.MotionBlurPostProcess(
  151351. * 'mb', // The name of the effect.
  151352. * scene, // The scene containing the objects to blur according to their velocity.
  151353. * 1.0, // The required width/height ratio to downsize to before computing the render pass.
  151354. * camera // The camera to apply the render pass to.
  151355. * );
  151356. * Then, all objects moving, rotating and/or scaling will be blurred depending on the transformation speed.
  151357. */
  151358. export class MotionBlurPostProcess extends PostProcess {
  151359. /**
  151360. * Defines how much the image is blurred by the movement. Default value is equal to 1
  151361. */
  151362. motionStrength: number;
  151363. /**
  151364. * Gets the number of iterations are used for motion blur quality. Default value is equal to 32
  151365. */
  151366. get motionBlurSamples(): number;
  151367. /**
  151368. * Sets the number of iterations to be used for motion blur quality
  151369. */
  151370. set motionBlurSamples(samples: number);
  151371. private _motionBlurSamples;
  151372. private _forceGeometryBuffer;
  151373. private _geometryBufferRenderer;
  151374. private _prePassRenderer;
  151375. /**
  151376. * Gets a string identifying the name of the class
  151377. * @returns "MotionBlurPostProcess" string
  151378. */
  151379. getClassName(): string;
  151380. /**
  151381. * Creates a new instance MotionBlurPostProcess
  151382. * @param name The name of the effect.
  151383. * @param scene The scene containing the objects to blur according to their velocity.
  151384. * @param options The required width/height ratio to downsize to before computing the render pass.
  151385. * @param camera The camera to apply the render pass to.
  151386. * @param samplingMode The sampling mode to be used when computing the pass. (default: 0)
  151387. * @param engine The engine which the post process will be applied. (default: current engine)
  151388. * @param reusable If the post process can be reused on the same frame. (default: false)
  151389. * @param textureType Type of textures used when performing the post process. (default: 0)
  151390. * @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)
  151391. * @param forceGeometryBuffer If this post process should use geometry buffer instead of prepass (default: false)
  151392. */
  151393. constructor(name: string, scene: Scene, options: number | PostProcessOptions, camera: Nullable<Camera>, samplingMode?: number, engine?: Engine, reusable?: boolean, textureType?: number, blockCompilation?: boolean, forceGeometryBuffer?: boolean);
  151394. /**
  151395. * Excludes the given skinned mesh from computing bones velocities.
  151396. * 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.
  151397. * @param skinnedMesh The mesh containing the skeleton to ignore when computing the velocity map.
  151398. */
  151399. excludeSkinnedMesh(skinnedMesh: AbstractMesh): void;
  151400. /**
  151401. * Removes the given skinned mesh from the excluded meshes to integrate bones velocities while rendering the velocity map.
  151402. * @param skinnedMesh The mesh containing the skeleton that has been ignored previously.
  151403. * @see excludeSkinnedMesh to exclude a skinned mesh from bones velocity computation.
  151404. */
  151405. removeExcludedSkinnedMesh(skinnedMesh: AbstractMesh): void;
  151406. /**
  151407. * Disposes the post process.
  151408. * @param camera The camera to dispose the post process on.
  151409. */
  151410. dispose(camera?: Camera): void;
  151411. /** @hidden */
  151412. static _Parse(parsedPostProcess: any, targetCamera: Camera, scene: Scene, rootUrl: string): Nullable<MotionBlurPostProcess>;
  151413. }
  151414. }
  151415. declare module BABYLON {
  151416. /** @hidden */
  151417. export var refractionPixelShader: {
  151418. name: string;
  151419. shader: string;
  151420. };
  151421. }
  151422. declare module BABYLON {
  151423. /**
  151424. * Post process which applies a refractin texture
  151425. * @see https://doc.babylonjs.com/how_to/how_to_use_postprocesses#refraction
  151426. */
  151427. export class RefractionPostProcess extends PostProcess {
  151428. private _refTexture;
  151429. private _ownRefractionTexture;
  151430. /** the base color of the refraction (used to taint the rendering) */
  151431. color: Color3;
  151432. /** simulated refraction depth */
  151433. depth: number;
  151434. /** the coefficient of the base color (0 to remove base color tainting) */
  151435. colorLevel: number;
  151436. /** Gets the url used to load the refraction texture */
  151437. refractionTextureUrl: string;
  151438. /**
  151439. * Gets or sets the refraction texture
  151440. * Please note that you are responsible for disposing the texture if you set it manually
  151441. */
  151442. get refractionTexture(): Texture;
  151443. set refractionTexture(value: Texture);
  151444. /**
  151445. * Gets a string identifying the name of the class
  151446. * @returns "RefractionPostProcess" string
  151447. */
  151448. getClassName(): string;
  151449. /**
  151450. * Initializes the RefractionPostProcess
  151451. * @see https://doc.babylonjs.com/how_to/how_to_use_postprocesses#refraction
  151452. * @param name The name of the effect.
  151453. * @param refractionTextureUrl Url of the refraction texture to use
  151454. * @param color the base color of the refraction (used to taint the rendering)
  151455. * @param depth simulated refraction depth
  151456. * @param colorLevel the coefficient of the base color (0 to remove base color tainting)
  151457. * @param camera The camera to apply the render pass to.
  151458. * @param options The required width/height ratio to downsize to before computing the render pass.
  151459. * @param samplingMode The sampling mode to be used when computing the pass. (default: 0)
  151460. * @param engine The engine which the post process will be applied. (default: current engine)
  151461. * @param reusable If the post process can be reused on the same frame. (default: false)
  151462. */
  151463. constructor(name: string, refractionTextureUrl: string, color: Color3, depth: number, colorLevel: number, options: number | PostProcessOptions, camera: Camera, samplingMode?: number, engine?: Engine, reusable?: boolean);
  151464. /**
  151465. * Disposes of the post process
  151466. * @param camera Camera to dispose post process on
  151467. */
  151468. dispose(camera: Camera): void;
  151469. /** @hidden */
  151470. static _Parse(parsedPostProcess: any, targetCamera: Camera, scene: Scene, rootUrl: string): RefractionPostProcess;
  151471. }
  151472. }
  151473. declare module BABYLON {
  151474. /** @hidden */
  151475. export var sharpenPixelShader: {
  151476. name: string;
  151477. shader: string;
  151478. };
  151479. }
  151480. declare module BABYLON {
  151481. /**
  151482. * The SharpenPostProcess applies a sharpen kernel to every pixel
  151483. * See http://en.wikipedia.org/wiki/Kernel_(image_processing)
  151484. */
  151485. export class SharpenPostProcess extends PostProcess {
  151486. /**
  151487. * How much of the original color should be applied. Setting this to 0 will display edge detection. (default: 1)
  151488. */
  151489. colorAmount: number;
  151490. /**
  151491. * How much sharpness should be applied (default: 0.3)
  151492. */
  151493. edgeAmount: number;
  151494. /**
  151495. * Gets a string identifying the name of the class
  151496. * @returns "SharpenPostProcess" string
  151497. */
  151498. getClassName(): string;
  151499. /**
  151500. * Creates a new instance ConvolutionPostProcess
  151501. * @param name The name of the effect.
  151502. * @param options The required width/height ratio to downsize to before computing the render pass.
  151503. * @param camera The camera to apply the render pass to.
  151504. * @param samplingMode The sampling mode to be used when computing the pass. (default: 0)
  151505. * @param engine The engine which the post process will be applied. (default: current engine)
  151506. * @param reusable If the post process can be reused on the same frame. (default: false)
  151507. * @param textureType Type of textures used when performing the post process. (default: 0)
  151508. * @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)
  151509. */
  151510. constructor(name: string, options: number | PostProcessOptions, camera: Nullable<Camera>, samplingMode?: number, engine?: Engine, reusable?: boolean, textureType?: number, blockCompilation?: boolean);
  151511. /** @hidden */
  151512. static _Parse(parsedPostProcess: any, targetCamera: Camera, scene: Scene, rootUrl: string): SharpenPostProcess;
  151513. }
  151514. }
  151515. declare module BABYLON {
  151516. /**
  151517. * PostProcessRenderPipeline
  151518. * @see https://doc.babylonjs.com/how_to/how_to_use_postprocessrenderpipeline
  151519. */
  151520. export class PostProcessRenderPipeline {
  151521. private engine;
  151522. private _renderEffects;
  151523. private _renderEffectsForIsolatedPass;
  151524. /**
  151525. * List of inspectable custom properties (used by the Inspector)
  151526. * @see https://doc.babylonjs.com/how_to/debug_layer#extensibility
  151527. */
  151528. inspectableCustomProperties: IInspectable[];
  151529. /**
  151530. * @hidden
  151531. */
  151532. protected _cameras: Camera[];
  151533. /** @hidden */
  151534. _name: string;
  151535. /**
  151536. * Gets pipeline name
  151537. */
  151538. get name(): string;
  151539. /** Gets the list of attached cameras */
  151540. get cameras(): Camera[];
  151541. /**
  151542. * Initializes a PostProcessRenderPipeline
  151543. * @param engine engine to add the pipeline to
  151544. * @param name name of the pipeline
  151545. */
  151546. constructor(engine: Engine, name: string);
  151547. /**
  151548. * Gets the class name
  151549. * @returns "PostProcessRenderPipeline"
  151550. */
  151551. getClassName(): string;
  151552. /**
  151553. * If all the render effects in the pipeline are supported
  151554. */
  151555. get isSupported(): boolean;
  151556. /**
  151557. * Adds an effect to the pipeline
  151558. * @param renderEffect the effect to add
  151559. */
  151560. addEffect(renderEffect: PostProcessRenderEffect): void;
  151561. /** @hidden */
  151562. _rebuild(): void;
  151563. /** @hidden */
  151564. _enableEffect(renderEffectName: string, cameras: Camera): void;
  151565. /** @hidden */
  151566. _enableEffect(renderEffectName: string, cameras: Camera[]): void;
  151567. /** @hidden */
  151568. _disableEffect(renderEffectName: string, cameras: Nullable<Camera[]>): void;
  151569. /** @hidden */
  151570. _disableEffect(renderEffectName: string, cameras: Nullable<Camera[]>): void;
  151571. /** @hidden */
  151572. _attachCameras(cameras: Camera, unique: boolean): void;
  151573. /** @hidden */
  151574. _attachCameras(cameras: Camera[], unique: boolean): void;
  151575. /** @hidden */
  151576. _detachCameras(cameras: Camera): void;
  151577. /** @hidden */
  151578. _detachCameras(cameras: Nullable<Camera[]>): void;
  151579. /** @hidden */
  151580. _update(): void;
  151581. /** @hidden */
  151582. _reset(): void;
  151583. protected _enableMSAAOnFirstPostProcess(sampleCount: number): boolean;
  151584. /**
  151585. * Sets the required values to the prepass renderer.
  151586. * @param prePassRenderer defines the prepass renderer to setup.
  151587. * @returns true if the pre pass is needed.
  151588. */
  151589. setPrePassRenderer(prePassRenderer: PrePassRenderer): boolean;
  151590. /**
  151591. * Disposes of the pipeline
  151592. */
  151593. dispose(): void;
  151594. }
  151595. }
  151596. declare module BABYLON {
  151597. /**
  151598. * PostProcessRenderPipelineManager class
  151599. * @see https://doc.babylonjs.com/how_to/how_to_use_postprocessrenderpipeline
  151600. */
  151601. export class PostProcessRenderPipelineManager {
  151602. private _renderPipelines;
  151603. /**
  151604. * Initializes a PostProcessRenderPipelineManager
  151605. * @see https://doc.babylonjs.com/how_to/how_to_use_postprocessrenderpipeline
  151606. */
  151607. constructor();
  151608. /**
  151609. * Gets the list of supported render pipelines
  151610. */
  151611. get supportedPipelines(): PostProcessRenderPipeline[];
  151612. /**
  151613. * Adds a pipeline to the manager
  151614. * @param renderPipeline The pipeline to add
  151615. */
  151616. addPipeline(renderPipeline: PostProcessRenderPipeline): void;
  151617. /**
  151618. * Attaches a camera to the pipeline
  151619. * @param renderPipelineName The name of the pipeline to attach to
  151620. * @param cameras the camera to attach
  151621. * @param unique if the camera can be attached multiple times to the pipeline
  151622. */
  151623. attachCamerasToRenderPipeline(renderPipelineName: string, cameras: any | Camera[] | Camera, unique?: boolean): void;
  151624. /**
  151625. * Detaches a camera from the pipeline
  151626. * @param renderPipelineName The name of the pipeline to detach from
  151627. * @param cameras the camera to detach
  151628. */
  151629. detachCamerasFromRenderPipeline(renderPipelineName: string, cameras: any | Camera[] | Camera): void;
  151630. /**
  151631. * Enables an effect by name on a pipeline
  151632. * @param renderPipelineName the name of the pipeline to enable the effect in
  151633. * @param renderEffectName the name of the effect to enable
  151634. * @param cameras the cameras that the effect should be enabled on
  151635. */
  151636. enableEffectInPipeline(renderPipelineName: string, renderEffectName: string, cameras: any | Camera[] | Camera): void;
  151637. /**
  151638. * Disables an effect by name on a pipeline
  151639. * @param renderPipelineName the name of the pipeline to disable the effect in
  151640. * @param renderEffectName the name of the effect to disable
  151641. * @param cameras the cameras that the effect should be disabled on
  151642. */
  151643. disableEffectInPipeline(renderPipelineName: string, renderEffectName: string, cameras: any | Camera[] | Camera): void;
  151644. /**
  151645. * Updates the state of all contained render pipelines and disposes of any non supported pipelines
  151646. */
  151647. update(): void;
  151648. /** @hidden */
  151649. _rebuild(): void;
  151650. /**
  151651. * Disposes of the manager and pipelines
  151652. */
  151653. dispose(): void;
  151654. }
  151655. }
  151656. declare module BABYLON {
  151657. interface Scene {
  151658. /** @hidden (Backing field) */
  151659. _postProcessRenderPipelineManager: PostProcessRenderPipelineManager;
  151660. /**
  151661. * Gets the postprocess render pipeline manager
  151662. * @see https://doc.babylonjs.com/how_to/how_to_use_postprocessrenderpipeline
  151663. * @see https://doc.babylonjs.com/how_to/using_default_rendering_pipeline
  151664. */
  151665. readonly postProcessRenderPipelineManager: PostProcessRenderPipelineManager;
  151666. }
  151667. /**
  151668. * Defines the Render Pipeline scene component responsible to rendering pipelines
  151669. */
  151670. export class PostProcessRenderPipelineManagerSceneComponent implements ISceneComponent {
  151671. /**
  151672. * The component name helpfull to identify the component in the list of scene components.
  151673. */
  151674. readonly name: string;
  151675. /**
  151676. * The scene the component belongs to.
  151677. */
  151678. scene: Scene;
  151679. /**
  151680. * Creates a new instance of the component for the given scene
  151681. * @param scene Defines the scene to register the component in
  151682. */
  151683. constructor(scene: Scene);
  151684. /**
  151685. * Registers the component in a given scene
  151686. */
  151687. register(): void;
  151688. /**
  151689. * Rebuilds the elements related to this component in case of
  151690. * context lost for instance.
  151691. */
  151692. rebuild(): void;
  151693. /**
  151694. * Disposes the component and the associated ressources
  151695. */
  151696. dispose(): void;
  151697. private _gatherRenderTargets;
  151698. }
  151699. }
  151700. declare module BABYLON {
  151701. /**
  151702. * The default rendering pipeline can be added to a scene to apply common post processing effects such as anti-aliasing or depth of field.
  151703. * See https://doc.babylonjs.com/how_to/using_default_rendering_pipeline
  151704. */
  151705. export class DefaultRenderingPipeline extends PostProcessRenderPipeline implements IDisposable, IAnimatable {
  151706. private _scene;
  151707. private _camerasToBeAttached;
  151708. /**
  151709. * ID of the sharpen post process,
  151710. */
  151711. private readonly SharpenPostProcessId;
  151712. /**
  151713. * @ignore
  151714. * ID of the image processing post process;
  151715. */
  151716. readonly ImageProcessingPostProcessId: string;
  151717. /**
  151718. * @ignore
  151719. * ID of the Fast Approximate Anti-Aliasing post process;
  151720. */
  151721. readonly FxaaPostProcessId: string;
  151722. /**
  151723. * ID of the chromatic aberration post process,
  151724. */
  151725. private readonly ChromaticAberrationPostProcessId;
  151726. /**
  151727. * ID of the grain post process
  151728. */
  151729. private readonly GrainPostProcessId;
  151730. /**
  151731. * Sharpen post process which will apply a sharpen convolution to enhance edges
  151732. */
  151733. sharpen: SharpenPostProcess;
  151734. private _sharpenEffect;
  151735. private bloom;
  151736. /**
  151737. * Depth of field effect, applies a blur based on how far away objects are from the focus distance.
  151738. */
  151739. depthOfField: DepthOfFieldEffect;
  151740. /**
  151741. * The Fast Approximate Anti-Aliasing post process which attemps to remove aliasing from an image.
  151742. */
  151743. fxaa: FxaaPostProcess;
  151744. /**
  151745. * Image post processing pass used to perform operations such as tone mapping or color grading.
  151746. */
  151747. imageProcessing: ImageProcessingPostProcess;
  151748. /**
  151749. * Chromatic aberration post process which will shift rgb colors in the image
  151750. */
  151751. chromaticAberration: ChromaticAberrationPostProcess;
  151752. private _chromaticAberrationEffect;
  151753. /**
  151754. * Grain post process which add noise to the image
  151755. */
  151756. grain: GrainPostProcess;
  151757. private _grainEffect;
  151758. /**
  151759. * Glow post process which adds a glow to emissive areas of the image
  151760. */
  151761. private _glowLayer;
  151762. /**
  151763. * Animations which can be used to tweak settings over a period of time
  151764. */
  151765. animations: Animation[];
  151766. private _imageProcessingConfigurationObserver;
  151767. private _sharpenEnabled;
  151768. private _bloomEnabled;
  151769. private _depthOfFieldEnabled;
  151770. private _depthOfFieldBlurLevel;
  151771. private _fxaaEnabled;
  151772. private _imageProcessingEnabled;
  151773. private _defaultPipelineTextureType;
  151774. private _bloomScale;
  151775. private _chromaticAberrationEnabled;
  151776. private _grainEnabled;
  151777. private _buildAllowed;
  151778. /**
  151779. * Gets active scene
  151780. */
  151781. get scene(): Scene;
  151782. /**
  151783. * Enable or disable the sharpen process from the pipeline
  151784. */
  151785. set sharpenEnabled(enabled: boolean);
  151786. get sharpenEnabled(): boolean;
  151787. private _resizeObserver;
  151788. private _hardwareScaleLevel;
  151789. private _bloomKernel;
  151790. /**
  151791. * Specifies the size of the bloom blur kernel, relative to the final output size
  151792. */
  151793. get bloomKernel(): number;
  151794. set bloomKernel(value: number);
  151795. /**
  151796. * Specifies the weight of the bloom in the final rendering
  151797. */
  151798. private _bloomWeight;
  151799. /**
  151800. * Specifies the luma threshold for the area that will be blurred by the bloom
  151801. */
  151802. private _bloomThreshold;
  151803. private _hdr;
  151804. /**
  151805. * The strength of the bloom.
  151806. */
  151807. set bloomWeight(value: number);
  151808. get bloomWeight(): number;
  151809. /**
  151810. * The strength of the bloom.
  151811. */
  151812. set bloomThreshold(value: number);
  151813. get bloomThreshold(): number;
  151814. /**
  151815. * The scale of the bloom, lower value will provide better performance.
  151816. */
  151817. set bloomScale(value: number);
  151818. get bloomScale(): number;
  151819. /**
  151820. * Enable or disable the bloom from the pipeline
  151821. */
  151822. set bloomEnabled(enabled: boolean);
  151823. get bloomEnabled(): boolean;
  151824. private _rebuildBloom;
  151825. /**
  151826. * If the depth of field is enabled.
  151827. */
  151828. get depthOfFieldEnabled(): boolean;
  151829. set depthOfFieldEnabled(enabled: boolean);
  151830. /**
  151831. * Blur level of the depth of field effect. (Higher blur will effect performance)
  151832. */
  151833. get depthOfFieldBlurLevel(): DepthOfFieldEffectBlurLevel;
  151834. set depthOfFieldBlurLevel(value: DepthOfFieldEffectBlurLevel);
  151835. /**
  151836. * If the anti aliasing is enabled.
  151837. */
  151838. set fxaaEnabled(enabled: boolean);
  151839. get fxaaEnabled(): boolean;
  151840. private _samples;
  151841. /**
  151842. * MSAA sample count, setting this to 4 will provide 4x anti aliasing. (default: 1)
  151843. */
  151844. set samples(sampleCount: number);
  151845. get samples(): number;
  151846. /**
  151847. * If image processing is enabled.
  151848. */
  151849. set imageProcessingEnabled(enabled: boolean);
  151850. get imageProcessingEnabled(): boolean;
  151851. /**
  151852. * If glow layer is enabled. (Adds a glow effect to emmissive materials)
  151853. */
  151854. set glowLayerEnabled(enabled: boolean);
  151855. get glowLayerEnabled(): boolean;
  151856. /**
  151857. * Gets the glow layer (or null if not defined)
  151858. */
  151859. get glowLayer(): Nullable<GlowLayer>;
  151860. /**
  151861. * Enable or disable the chromaticAberration process from the pipeline
  151862. */
  151863. set chromaticAberrationEnabled(enabled: boolean);
  151864. get chromaticAberrationEnabled(): boolean;
  151865. /**
  151866. * Enable or disable the grain process from the pipeline
  151867. */
  151868. set grainEnabled(enabled: boolean);
  151869. get grainEnabled(): boolean;
  151870. /**
  151871. * @constructor
  151872. * @param name - The rendering pipeline name (default: "")
  151873. * @param hdr - If high dynamic range textures should be used (default: true)
  151874. * @param scene - The scene linked to this pipeline (default: the last created scene)
  151875. * @param cameras - The array of cameras that the rendering pipeline will be attached to (default: scene.cameras)
  151876. * @param automaticBuild - if false, you will have to manually call prepare() to update the pipeline (default: true)
  151877. */
  151878. constructor(name?: string, hdr?: boolean, scene?: Scene, cameras?: Camera[], automaticBuild?: boolean);
  151879. /**
  151880. * Get the class name
  151881. * @returns "DefaultRenderingPipeline"
  151882. */
  151883. getClassName(): string;
  151884. /**
  151885. * Force the compilation of the entire pipeline.
  151886. */
  151887. prepare(): void;
  151888. private _hasCleared;
  151889. private _prevPostProcess;
  151890. private _prevPrevPostProcess;
  151891. private _setAutoClearAndTextureSharing;
  151892. private _depthOfFieldSceneObserver;
  151893. private _buildPipeline;
  151894. private _disposePostProcesses;
  151895. /**
  151896. * Adds a camera to the pipeline
  151897. * @param camera the camera to be added
  151898. */
  151899. addCamera(camera: Camera): void;
  151900. /**
  151901. * Removes a camera from the pipeline
  151902. * @param camera the camera to remove
  151903. */
  151904. removeCamera(camera: Camera): void;
  151905. /**
  151906. * Dispose of the pipeline and stop all post processes
  151907. */
  151908. dispose(): void;
  151909. /**
  151910. * Serialize the rendering pipeline (Used when exporting)
  151911. * @returns the serialized object
  151912. */
  151913. serialize(): any;
  151914. /**
  151915. * Parse the serialized pipeline
  151916. * @param source Source pipeline.
  151917. * @param scene The scene to load the pipeline to.
  151918. * @param rootUrl The URL of the serialized pipeline.
  151919. * @returns An instantiated pipeline from the serialized object.
  151920. */
  151921. static Parse(source: any, scene: Scene, rootUrl: string): DefaultRenderingPipeline;
  151922. }
  151923. }
  151924. declare module BABYLON {
  151925. /** @hidden */
  151926. export var lensHighlightsPixelShader: {
  151927. name: string;
  151928. shader: string;
  151929. };
  151930. }
  151931. declare module BABYLON {
  151932. /** @hidden */
  151933. export var depthOfFieldPixelShader: {
  151934. name: string;
  151935. shader: string;
  151936. };
  151937. }
  151938. declare module BABYLON {
  151939. /**
  151940. * BABYLON.JS Chromatic Aberration GLSL Shader
  151941. * Author: Olivier Guyot
  151942. * Separates very slightly R, G and B colors on the edges of the screen
  151943. * Inspired by Francois Tarlier & Martins Upitis
  151944. */
  151945. export class LensRenderingPipeline extends PostProcessRenderPipeline {
  151946. /**
  151947. * @ignore
  151948. * The chromatic aberration PostProcess id in the pipeline
  151949. */
  151950. LensChromaticAberrationEffect: string;
  151951. /**
  151952. * @ignore
  151953. * The highlights enhancing PostProcess id in the pipeline
  151954. */
  151955. HighlightsEnhancingEffect: string;
  151956. /**
  151957. * @ignore
  151958. * The depth-of-field PostProcess id in the pipeline
  151959. */
  151960. LensDepthOfFieldEffect: string;
  151961. private _scene;
  151962. private _depthTexture;
  151963. private _grainTexture;
  151964. private _chromaticAberrationPostProcess;
  151965. private _highlightsPostProcess;
  151966. private _depthOfFieldPostProcess;
  151967. private _edgeBlur;
  151968. private _grainAmount;
  151969. private _chromaticAberration;
  151970. private _distortion;
  151971. private _highlightsGain;
  151972. private _highlightsThreshold;
  151973. private _dofDistance;
  151974. private _dofAperture;
  151975. private _dofDarken;
  151976. private _dofPentagon;
  151977. private _blurNoise;
  151978. /**
  151979. * @constructor
  151980. *
  151981. * Effect parameters are as follow:
  151982. * {
  151983. * chromatic_aberration: number; // from 0 to x (1 for realism)
  151984. * edge_blur: number; // from 0 to x (1 for realism)
  151985. * distortion: number; // from 0 to x (1 for realism)
  151986. * grain_amount: number; // from 0 to 1
  151987. * grain_texture: BABYLON.Texture; // texture to use for grain effect; if unset, use random B&W noise
  151988. * dof_focus_distance: number; // depth-of-field: focus distance; unset to disable (disabled by default)
  151989. * dof_aperture: number; // depth-of-field: focus blur bias (default: 1)
  151990. * dof_darken: number; // depth-of-field: darken that which is out of focus (from 0 to 1, disabled by default)
  151991. * dof_pentagon: boolean; // depth-of-field: makes a pentagon-like "bokeh" effect
  151992. * dof_gain: number; // depth-of-field: highlights gain; unset to disable (disabled by default)
  151993. * dof_threshold: number; // depth-of-field: highlights threshold (default: 1)
  151994. * blur_noise: boolean; // add a little bit of noise to the blur (default: true)
  151995. * }
  151996. * Note: if an effect parameter is unset, effect is disabled
  151997. *
  151998. * @param name The rendering pipeline name
  151999. * @param parameters - An object containing all parameters (see above)
  152000. * @param scene The scene linked to this pipeline
  152001. * @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)
  152002. * @param cameras The array of cameras that the rendering pipeline will be attached to
  152003. */
  152004. constructor(name: string, parameters: any, scene: Scene, ratio?: number, cameras?: Camera[]);
  152005. /**
  152006. * Get the class name
  152007. * @returns "LensRenderingPipeline"
  152008. */
  152009. getClassName(): string;
  152010. /**
  152011. * Gets associated scene
  152012. */
  152013. get scene(): Scene;
  152014. /**
  152015. * Gets or sets the edge blur
  152016. */
  152017. get edgeBlur(): number;
  152018. set edgeBlur(value: number);
  152019. /**
  152020. * Gets or sets the grain amount
  152021. */
  152022. get grainAmount(): number;
  152023. set grainAmount(value: number);
  152024. /**
  152025. * Gets or sets the chromatic aberration amount
  152026. */
  152027. get chromaticAberration(): number;
  152028. set chromaticAberration(value: number);
  152029. /**
  152030. * Gets or sets the depth of field aperture
  152031. */
  152032. get dofAperture(): number;
  152033. set dofAperture(value: number);
  152034. /**
  152035. * Gets or sets the edge distortion
  152036. */
  152037. get edgeDistortion(): number;
  152038. set edgeDistortion(value: number);
  152039. /**
  152040. * Gets or sets the depth of field distortion
  152041. */
  152042. get dofDistortion(): number;
  152043. set dofDistortion(value: number);
  152044. /**
  152045. * Gets or sets the darken out of focus amount
  152046. */
  152047. get darkenOutOfFocus(): number;
  152048. set darkenOutOfFocus(value: number);
  152049. /**
  152050. * Gets or sets a boolean indicating if blur noise is enabled
  152051. */
  152052. get blurNoise(): boolean;
  152053. set blurNoise(value: boolean);
  152054. /**
  152055. * Gets or sets a boolean indicating if pentagon bokeh is enabled
  152056. */
  152057. get pentagonBokeh(): boolean;
  152058. set pentagonBokeh(value: boolean);
  152059. /**
  152060. * Gets or sets the highlight grain amount
  152061. */
  152062. get highlightsGain(): number;
  152063. set highlightsGain(value: number);
  152064. /**
  152065. * Gets or sets the highlight threshold
  152066. */
  152067. get highlightsThreshold(): number;
  152068. set highlightsThreshold(value: number);
  152069. /**
  152070. * Sets the amount of blur at the edges
  152071. * @param amount blur amount
  152072. */
  152073. setEdgeBlur(amount: number): void;
  152074. /**
  152075. * Sets edge blur to 0
  152076. */
  152077. disableEdgeBlur(): void;
  152078. /**
  152079. * Sets the amout of grain
  152080. * @param amount Amount of grain
  152081. */
  152082. setGrainAmount(amount: number): void;
  152083. /**
  152084. * Set grain amount to 0
  152085. */
  152086. disableGrain(): void;
  152087. /**
  152088. * Sets the chromatic aberration amount
  152089. * @param amount amount of chromatic aberration
  152090. */
  152091. setChromaticAberration(amount: number): void;
  152092. /**
  152093. * Sets chromatic aberration amount to 0
  152094. */
  152095. disableChromaticAberration(): void;
  152096. /**
  152097. * Sets the EdgeDistortion amount
  152098. * @param amount amount of EdgeDistortion
  152099. */
  152100. setEdgeDistortion(amount: number): void;
  152101. /**
  152102. * Sets edge distortion to 0
  152103. */
  152104. disableEdgeDistortion(): void;
  152105. /**
  152106. * Sets the FocusDistance amount
  152107. * @param amount amount of FocusDistance
  152108. */
  152109. setFocusDistance(amount: number): void;
  152110. /**
  152111. * Disables depth of field
  152112. */
  152113. disableDepthOfField(): void;
  152114. /**
  152115. * Sets the Aperture amount
  152116. * @param amount amount of Aperture
  152117. */
  152118. setAperture(amount: number): void;
  152119. /**
  152120. * Sets the DarkenOutOfFocus amount
  152121. * @param amount amount of DarkenOutOfFocus
  152122. */
  152123. setDarkenOutOfFocus(amount: number): void;
  152124. private _pentagonBokehIsEnabled;
  152125. /**
  152126. * Creates a pentagon bokeh effect
  152127. */
  152128. enablePentagonBokeh(): void;
  152129. /**
  152130. * Disables the pentagon bokeh effect
  152131. */
  152132. disablePentagonBokeh(): void;
  152133. /**
  152134. * Enables noise blur
  152135. */
  152136. enableNoiseBlur(): void;
  152137. /**
  152138. * Disables noise blur
  152139. */
  152140. disableNoiseBlur(): void;
  152141. /**
  152142. * Sets the HighlightsGain amount
  152143. * @param amount amount of HighlightsGain
  152144. */
  152145. setHighlightsGain(amount: number): void;
  152146. /**
  152147. * Sets the HighlightsThreshold amount
  152148. * @param amount amount of HighlightsThreshold
  152149. */
  152150. setHighlightsThreshold(amount: number): void;
  152151. /**
  152152. * Disables highlights
  152153. */
  152154. disableHighlights(): void;
  152155. /**
  152156. * Removes the internal pipeline assets and detaches the pipeline from the scene cameras
  152157. * @param disableDepthRender If the scens depth rendering should be disabled (default: false)
  152158. */
  152159. dispose(disableDepthRender?: boolean): void;
  152160. private _createChromaticAberrationPostProcess;
  152161. private _createHighlightsPostProcess;
  152162. private _createDepthOfFieldPostProcess;
  152163. private _createGrainTexture;
  152164. }
  152165. }
  152166. declare module BABYLON {
  152167. /**
  152168. * Contains all parameters needed for the prepass to perform
  152169. * screen space subsurface scattering
  152170. */
  152171. export class SSAO2Configuration implements PrePassEffectConfiguration {
  152172. /**
  152173. * Is subsurface enabled
  152174. */
  152175. enabled: boolean;
  152176. /**
  152177. * Name of the configuration
  152178. */
  152179. name: string;
  152180. /**
  152181. * Textures that should be present in the MRT for this effect to work
  152182. */
  152183. readonly texturesRequired: number[];
  152184. }
  152185. }
  152186. declare module BABYLON {
  152187. /** @hidden */
  152188. export var ssao2PixelShader: {
  152189. name: string;
  152190. shader: string;
  152191. };
  152192. }
  152193. declare module BABYLON {
  152194. /** @hidden */
  152195. export var ssaoCombinePixelShader: {
  152196. name: string;
  152197. shader: string;
  152198. };
  152199. }
  152200. declare module BABYLON {
  152201. /**
  152202. * Render pipeline to produce ssao effect
  152203. */
  152204. export class SSAO2RenderingPipeline extends PostProcessRenderPipeline {
  152205. /**
  152206. * @ignore
  152207. * The PassPostProcess id in the pipeline that contains the original scene color
  152208. */
  152209. SSAOOriginalSceneColorEffect: string;
  152210. /**
  152211. * @ignore
  152212. * The SSAO PostProcess id in the pipeline
  152213. */
  152214. SSAORenderEffect: string;
  152215. /**
  152216. * @ignore
  152217. * The horizontal blur PostProcess id in the pipeline
  152218. */
  152219. SSAOBlurHRenderEffect: string;
  152220. /**
  152221. * @ignore
  152222. * The vertical blur PostProcess id in the pipeline
  152223. */
  152224. SSAOBlurVRenderEffect: string;
  152225. /**
  152226. * @ignore
  152227. * The PostProcess id in the pipeline that combines the SSAO-Blur output with the original scene color (SSAOOriginalSceneColorEffect)
  152228. */
  152229. SSAOCombineRenderEffect: string;
  152230. /**
  152231. * The output strength of the SSAO post-process. Default value is 1.0.
  152232. */
  152233. totalStrength: number;
  152234. /**
  152235. * Maximum depth value to still render AO. A smooth falloff makes the dimming more natural, so there will be no abrupt shading change.
  152236. */
  152237. maxZ: number;
  152238. /**
  152239. * In order to save performances, SSAO radius is clamped on close geometry. This ratio changes by how much
  152240. */
  152241. minZAspect: number;
  152242. private _samples;
  152243. /**
  152244. * Number of samples used for the SSAO calculations. Default value is 8
  152245. */
  152246. set samples(n: number);
  152247. get samples(): number;
  152248. private _textureSamples;
  152249. /**
  152250. * Number of samples to use for antialiasing
  152251. */
  152252. set textureSamples(n: number);
  152253. get textureSamples(): number;
  152254. /**
  152255. * Force rendering the geometry through geometry buffer
  152256. */
  152257. private _forceGeometryBuffer;
  152258. /**
  152259. * Ratio object used for SSAO ratio and blur ratio
  152260. */
  152261. private _ratio;
  152262. /**
  152263. * Dynamically generated sphere sampler.
  152264. */
  152265. private _sampleSphere;
  152266. /**
  152267. * Blur filter offsets
  152268. */
  152269. private _samplerOffsets;
  152270. private _expensiveBlur;
  152271. /**
  152272. * If bilateral blur should be used
  152273. */
  152274. set expensiveBlur(b: boolean);
  152275. get expensiveBlur(): boolean;
  152276. /**
  152277. * The radius around the analyzed pixel used by the SSAO post-process. Default value is 2.0
  152278. */
  152279. radius: number;
  152280. /**
  152281. * The base color of the SSAO post-process
  152282. * The final result is "base + ssao" between [0, 1]
  152283. */
  152284. base: number;
  152285. /**
  152286. * Support test.
  152287. */
  152288. static get IsSupported(): boolean;
  152289. private _scene;
  152290. private _randomTexture;
  152291. private _originalColorPostProcess;
  152292. private _ssaoPostProcess;
  152293. private _blurHPostProcess;
  152294. private _blurVPostProcess;
  152295. private _ssaoCombinePostProcess;
  152296. private _prePassRenderer;
  152297. /**
  152298. * Gets active scene
  152299. */
  152300. get scene(): Scene;
  152301. /**
  152302. * @constructor
  152303. * @param name The rendering pipeline name
  152304. * @param scene The scene linked to this pipeline
  152305. * @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 }
  152306. * @param cameras The array of cameras that the rendering pipeline will be attached to
  152307. * @param forceGeometryBuffer Set to true if you want to use the legacy geometry buffer renderer
  152308. */
  152309. constructor(name: string, scene: Scene, ratio: any, cameras?: Camera[], forceGeometryBuffer?: boolean);
  152310. /**
  152311. * Get the class name
  152312. * @returns "SSAO2RenderingPipeline"
  152313. */
  152314. getClassName(): string;
  152315. /**
  152316. * Removes the internal pipeline assets and detatches the pipeline from the scene cameras
  152317. */
  152318. dispose(disableGeometryBufferRenderer?: boolean): void;
  152319. private _createBlurPostProcess;
  152320. /** @hidden */
  152321. _rebuild(): void;
  152322. private _bits;
  152323. private _radicalInverse_VdC;
  152324. private _hammersley;
  152325. private _hemisphereSample_uniform;
  152326. private _generateHemisphere;
  152327. private _getDefinesForSSAO;
  152328. private _createSSAOPostProcess;
  152329. private _createSSAOCombinePostProcess;
  152330. private _createRandomTexture;
  152331. /**
  152332. * Serialize the rendering pipeline (Used when exporting)
  152333. * @returns the serialized object
  152334. */
  152335. serialize(): any;
  152336. /**
  152337. * Parse the serialized pipeline
  152338. * @param source Source pipeline.
  152339. * @param scene The scene to load the pipeline to.
  152340. * @param rootUrl The URL of the serialized pipeline.
  152341. * @returns An instantiated pipeline from the serialized object.
  152342. */
  152343. static Parse(source: any, scene: Scene, rootUrl: string): SSAO2RenderingPipeline;
  152344. }
  152345. }
  152346. declare module BABYLON {
  152347. /** @hidden */
  152348. export var ssaoPixelShader: {
  152349. name: string;
  152350. shader: string;
  152351. };
  152352. }
  152353. declare module BABYLON {
  152354. /**
  152355. * Render pipeline to produce ssao effect
  152356. */
  152357. export class SSAORenderingPipeline extends PostProcessRenderPipeline {
  152358. /**
  152359. * @ignore
  152360. * The PassPostProcess id in the pipeline that contains the original scene color
  152361. */
  152362. SSAOOriginalSceneColorEffect: string;
  152363. /**
  152364. * @ignore
  152365. * The SSAO PostProcess id in the pipeline
  152366. */
  152367. SSAORenderEffect: string;
  152368. /**
  152369. * @ignore
  152370. * The horizontal blur PostProcess id in the pipeline
  152371. */
  152372. SSAOBlurHRenderEffect: string;
  152373. /**
  152374. * @ignore
  152375. * The vertical blur PostProcess id in the pipeline
  152376. */
  152377. SSAOBlurVRenderEffect: string;
  152378. /**
  152379. * @ignore
  152380. * The PostProcess id in the pipeline that combines the SSAO-Blur output with the original scene color (SSAOOriginalSceneColorEffect)
  152381. */
  152382. SSAOCombineRenderEffect: string;
  152383. /**
  152384. * The output strength of the SSAO post-process. Default value is 1.0.
  152385. */
  152386. totalStrength: number;
  152387. /**
  152388. * The radius around the analyzed pixel used by the SSAO post-process. Default value is 0.0006
  152389. */
  152390. radius: number;
  152391. /**
  152392. * Related to fallOff, used to interpolate SSAO samples (first interpolate function input) based on the occlusion difference of each pixel
  152393. * Must not be equal to fallOff and superior to fallOff.
  152394. * Default value is 0.0075
  152395. */
  152396. area: number;
  152397. /**
  152398. * Related to area, used to interpolate SSAO samples (second interpolate function input) based on the occlusion difference of each pixel
  152399. * Must not be equal to area and inferior to area.
  152400. * Default value is 0.000001
  152401. */
  152402. fallOff: number;
  152403. /**
  152404. * The base color of the SSAO post-process
  152405. * The final result is "base + ssao" between [0, 1]
  152406. */
  152407. base: number;
  152408. private _scene;
  152409. private _depthTexture;
  152410. private _randomTexture;
  152411. private _originalColorPostProcess;
  152412. private _ssaoPostProcess;
  152413. private _blurHPostProcess;
  152414. private _blurVPostProcess;
  152415. private _ssaoCombinePostProcess;
  152416. private _firstUpdate;
  152417. /**
  152418. * Gets active scene
  152419. */
  152420. get scene(): Scene;
  152421. /**
  152422. * @constructor
  152423. * @param name - The rendering pipeline name
  152424. * @param scene - The scene linked to this pipeline
  152425. * @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 }
  152426. * @param cameras - The array of cameras that the rendering pipeline will be attached to
  152427. */
  152428. constructor(name: string, scene: Scene, ratio: any, cameras?: Camera[]);
  152429. /**
  152430. * Get the class name
  152431. * @returns "SSAORenderingPipeline"
  152432. */
  152433. getClassName(): string;
  152434. /**
  152435. * Removes the internal pipeline assets and detatches the pipeline from the scene cameras
  152436. */
  152437. dispose(disableDepthRender?: boolean): void;
  152438. private _createBlurPostProcess;
  152439. /** @hidden */
  152440. _rebuild(): void;
  152441. private _createSSAOPostProcess;
  152442. private _createSSAOCombinePostProcess;
  152443. private _createRandomTexture;
  152444. }
  152445. }
  152446. declare module BABYLON {
  152447. /**
  152448. * Contains all parameters needed for the prepass to perform
  152449. * screen space reflections
  152450. */
  152451. export class ScreenSpaceReflectionsConfiguration implements PrePassEffectConfiguration {
  152452. /**
  152453. * Is ssr enabled
  152454. */
  152455. enabled: boolean;
  152456. /**
  152457. * Name of the configuration
  152458. */
  152459. name: string;
  152460. /**
  152461. * Textures that should be present in the MRT for this effect to work
  152462. */
  152463. readonly texturesRequired: number[];
  152464. }
  152465. }
  152466. declare module BABYLON {
  152467. /** @hidden */
  152468. export var screenSpaceReflectionPixelShader: {
  152469. name: string;
  152470. shader: string;
  152471. };
  152472. }
  152473. declare module BABYLON {
  152474. /**
  152475. * The ScreenSpaceReflectionPostProcess performs realtime reflections using only and only the available informations on the screen (positions and normals).
  152476. * Basically, the screen space reflection post-process will compute reflections according the material's reflectivity.
  152477. */
  152478. export class ScreenSpaceReflectionPostProcess extends PostProcess {
  152479. /**
  152480. * Gets or sets a reflection threshold mainly used to adjust the reflection's height.
  152481. */
  152482. threshold: number;
  152483. /**
  152484. * Gets or sets the current reflection strength. 1.0 is an ideal value but can be increased/decreased for particular results.
  152485. */
  152486. strength: number;
  152487. /**
  152488. * Gets or sets the falloff exponent used while computing fresnel. More the exponent is high, more the reflections will be discrete.
  152489. */
  152490. reflectionSpecularFalloffExponent: number;
  152491. /**
  152492. * 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]
  152493. */
  152494. step: number;
  152495. /**
  152496. * Gets or sets the factor applied when computing roughness. Default value is 0.2.
  152497. */
  152498. roughnessFactor: number;
  152499. private _forceGeometryBuffer;
  152500. private _geometryBufferRenderer;
  152501. private _prePassRenderer;
  152502. private _enableSmoothReflections;
  152503. private _reflectionSamples;
  152504. private _smoothSteps;
  152505. /**
  152506. * Gets a string identifying the name of the class
  152507. * @returns "ScreenSpaceReflectionPostProcess" string
  152508. */
  152509. getClassName(): string;
  152510. /**
  152511. * Creates a new instance of ScreenSpaceReflectionPostProcess.
  152512. * @param name The name of the effect.
  152513. * @param scene The scene containing the objects to calculate reflections.
  152514. * @param options The required width/height ratio to downsize to before computing the render pass.
  152515. * @param camera The camera to apply the render pass to.
  152516. * @param samplingMode The sampling mode to be used when computing the pass. (default: 0)
  152517. * @param engine The engine which the post process will be applied. (default: current engine)
  152518. * @param reusable If the post process can be reused on the same frame. (default: false)
  152519. * @param textureType Type of textures used when performing the post process. (default: 0)
  152520. * @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)
  152521. * @param forceGeometryBuffer If this post process should use geometry buffer instead of prepass (default: false)
  152522. */
  152523. constructor(name: string, scene: Scene, options: number | PostProcessOptions, camera: Nullable<Camera>, samplingMode?: number, engine?: Engine, reusable?: boolean, textureType?: number, blockCompilation?: boolean, forceGeometryBuffer?: boolean);
  152524. /**
  152525. * Gets wether or not smoothing reflections is enabled.
  152526. * Enabling smoothing will require more GPU power and can generate a drop in FPS.
  152527. */
  152528. get enableSmoothReflections(): boolean;
  152529. /**
  152530. * Sets wether or not smoothing reflections is enabled.
  152531. * Enabling smoothing will require more GPU power and can generate a drop in FPS.
  152532. */
  152533. set enableSmoothReflections(enabled: boolean);
  152534. /**
  152535. * Gets the number of samples taken while computing reflections. More samples count is high,
  152536. * more the post-process wil require GPU power and can generate a drop in FPS. Basically in interval [25, 100].
  152537. */
  152538. get reflectionSamples(): number;
  152539. /**
  152540. * Sets the number of samples taken while computing reflections. More samples count is high,
  152541. * more the post-process wil require GPU power and can generate a drop in FPS. Basically in interval [25, 100].
  152542. */
  152543. set reflectionSamples(samples: number);
  152544. /**
  152545. * Gets the number of samples taken while smoothing reflections. More samples count is high,
  152546. * more the post-process will require GPU power and can generate a drop in FPS.
  152547. * Default value (5.0) work pretty well in all cases but can be adjusted.
  152548. */
  152549. get smoothSteps(): number;
  152550. set smoothSteps(steps: number);
  152551. private _updateEffectDefines;
  152552. /** @hidden */
  152553. static _Parse(parsedPostProcess: any, targetCamera: Camera, scene: Scene, rootUrl: string): ScreenSpaceReflectionPostProcess;
  152554. }
  152555. }
  152556. declare module BABYLON {
  152557. /** @hidden */
  152558. export var standardPixelShader: {
  152559. name: string;
  152560. shader: string;
  152561. };
  152562. }
  152563. declare module BABYLON {
  152564. /**
  152565. * Standard rendering pipeline
  152566. * Default pipeline should be used going forward but the standard pipeline will be kept for backwards compatibility.
  152567. * @see https://doc.babylonjs.com/how_to/using_standard_rendering_pipeline
  152568. */
  152569. export class StandardRenderingPipeline extends PostProcessRenderPipeline implements IDisposable, IAnimatable {
  152570. /**
  152571. * Public members
  152572. */
  152573. /**
  152574. * Post-process which contains the original scene color before the pipeline applies all the effects
  152575. */
  152576. originalPostProcess: Nullable<PostProcess>;
  152577. /**
  152578. * Post-process used to down scale an image x4
  152579. */
  152580. downSampleX4PostProcess: Nullable<PostProcess>;
  152581. /**
  152582. * Post-process used to calculate the illuminated surfaces controlled by a threshold
  152583. */
  152584. brightPassPostProcess: Nullable<PostProcess>;
  152585. /**
  152586. * Post-process array storing all the horizontal blur post-processes used by the pipeline
  152587. */
  152588. blurHPostProcesses: PostProcess[];
  152589. /**
  152590. * Post-process array storing all the vertical blur post-processes used by the pipeline
  152591. */
  152592. blurVPostProcesses: PostProcess[];
  152593. /**
  152594. * Post-process used to add colors of 2 textures (typically brightness + real scene color)
  152595. */
  152596. textureAdderPostProcess: Nullable<PostProcess>;
  152597. /**
  152598. * Post-process used to create volumetric lighting effect
  152599. */
  152600. volumetricLightPostProcess: Nullable<PostProcess>;
  152601. /**
  152602. * Post-process used to smooth the previous volumetric light post-process on the X axis
  152603. */
  152604. volumetricLightSmoothXPostProcess: Nullable<BlurPostProcess>;
  152605. /**
  152606. * Post-process used to smooth the previous volumetric light post-process on the Y axis
  152607. */
  152608. volumetricLightSmoothYPostProcess: Nullable<BlurPostProcess>;
  152609. /**
  152610. * Post-process used to merge the volumetric light effect and the real scene color
  152611. */
  152612. volumetricLightMergePostProces: Nullable<PostProcess>;
  152613. /**
  152614. * Post-process used to store the final volumetric light post-process (attach/detach for debug purpose)
  152615. */
  152616. volumetricLightFinalPostProcess: Nullable<PostProcess>;
  152617. /**
  152618. * Base post-process used to calculate the average luminance of the final image for HDR
  152619. */
  152620. luminancePostProcess: Nullable<PostProcess>;
  152621. /**
  152622. * Post-processes used to create down sample post-processes in order to get
  152623. * the average luminance of the final image for HDR
  152624. * Array of length "StandardRenderingPipeline.LuminanceSteps"
  152625. */
  152626. luminanceDownSamplePostProcesses: PostProcess[];
  152627. /**
  152628. * Post-process used to create a HDR effect (light adaptation)
  152629. */
  152630. hdrPostProcess: Nullable<PostProcess>;
  152631. /**
  152632. * Post-process used to store the final texture adder post-process (attach/detach for debug purpose)
  152633. */
  152634. textureAdderFinalPostProcess: Nullable<PostProcess>;
  152635. /**
  152636. * Post-process used to store the final lens flare post-process (attach/detach for debug purpose)
  152637. */
  152638. lensFlareFinalPostProcess: Nullable<PostProcess>;
  152639. /**
  152640. * Post-process used to merge the final HDR post-process and the real scene color
  152641. */
  152642. hdrFinalPostProcess: Nullable<PostProcess>;
  152643. /**
  152644. * Post-process used to create a lens flare effect
  152645. */
  152646. lensFlarePostProcess: Nullable<PostProcess>;
  152647. /**
  152648. * Post-process that merges the result of the lens flare post-process and the real scene color
  152649. */
  152650. lensFlareComposePostProcess: Nullable<PostProcess>;
  152651. /**
  152652. * Post-process used to create a motion blur effect
  152653. */
  152654. motionBlurPostProcess: Nullable<PostProcess>;
  152655. /**
  152656. * Post-process used to create a depth of field effect
  152657. */
  152658. depthOfFieldPostProcess: Nullable<PostProcess>;
  152659. /**
  152660. * The Fast Approximate Anti-Aliasing post process which attemps to remove aliasing from an image.
  152661. */
  152662. fxaaPostProcess: Nullable<FxaaPostProcess>;
  152663. /**
  152664. * Post-process used to simulate realtime reflections using the screen space and geometry renderer.
  152665. */
  152666. screenSpaceReflectionPostProcess: Nullable<ScreenSpaceReflectionPostProcess>;
  152667. /**
  152668. * Represents the brightness threshold in order to configure the illuminated surfaces
  152669. */
  152670. brightThreshold: number;
  152671. /**
  152672. * Configures the blur intensity used for surexposed surfaces are highlighted surfaces (light halo)
  152673. */
  152674. blurWidth: number;
  152675. /**
  152676. * Sets if the blur for highlighted surfaces must be only horizontal
  152677. */
  152678. horizontalBlur: boolean;
  152679. /**
  152680. * Gets the overall exposure used by the pipeline
  152681. */
  152682. get exposure(): number;
  152683. /**
  152684. * Sets the overall exposure used by the pipeline
  152685. */
  152686. set exposure(value: number);
  152687. /**
  152688. * Texture used typically to simulate "dirty" on camera lens
  152689. */
  152690. lensTexture: Nullable<Texture>;
  152691. /**
  152692. * Represents the offset coefficient based on Rayleigh principle. Typically in interval [-0.2, 0.2]
  152693. */
  152694. volumetricLightCoefficient: number;
  152695. /**
  152696. * The overall power of volumetric lights, typically in interval [0, 10] maximum
  152697. */
  152698. volumetricLightPower: number;
  152699. /**
  152700. * Used the set the blur intensity to smooth the volumetric lights
  152701. */
  152702. volumetricLightBlurScale: number;
  152703. /**
  152704. * Light (spot or directional) used to generate the volumetric lights rays
  152705. * The source light must have a shadow generate so the pipeline can get its
  152706. * depth map
  152707. */
  152708. sourceLight: Nullable<SpotLight | DirectionalLight>;
  152709. /**
  152710. * For eye adaptation, represents the minimum luminance the eye can see
  152711. */
  152712. hdrMinimumLuminance: number;
  152713. /**
  152714. * For eye adaptation, represents the decrease luminance speed
  152715. */
  152716. hdrDecreaseRate: number;
  152717. /**
  152718. * For eye adaptation, represents the increase luminance speed
  152719. */
  152720. hdrIncreaseRate: number;
  152721. /**
  152722. * Gets wether or not the exposure of the overall pipeline should be automatically adjusted by the HDR post-process
  152723. */
  152724. get hdrAutoExposure(): boolean;
  152725. /**
  152726. * Sets wether or not the exposure of the overall pipeline should be automatically adjusted by the HDR post-process
  152727. */
  152728. set hdrAutoExposure(value: boolean);
  152729. /**
  152730. * Lens color texture used by the lens flare effect. Mandatory if lens flare effect enabled
  152731. */
  152732. lensColorTexture: Nullable<Texture>;
  152733. /**
  152734. * The overall strengh for the lens flare effect
  152735. */
  152736. lensFlareStrength: number;
  152737. /**
  152738. * Dispersion coefficient for lens flare ghosts
  152739. */
  152740. lensFlareGhostDispersal: number;
  152741. /**
  152742. * Main lens flare halo width
  152743. */
  152744. lensFlareHaloWidth: number;
  152745. /**
  152746. * Based on the lens distortion effect, defines how much the lens flare result
  152747. * is distorted
  152748. */
  152749. lensFlareDistortionStrength: number;
  152750. /**
  152751. * Configures the blur intensity used for for lens flare (halo)
  152752. */
  152753. lensFlareBlurWidth: number;
  152754. /**
  152755. * Lens star texture must be used to simulate rays on the flares and is available
  152756. * in the documentation
  152757. */
  152758. lensStarTexture: Nullable<Texture>;
  152759. /**
  152760. * As the "lensTexture" (can be the same texture or different), it is used to apply the lens
  152761. * flare effect by taking account of the dirt texture
  152762. */
  152763. lensFlareDirtTexture: Nullable<Texture>;
  152764. /**
  152765. * Represents the focal length for the depth of field effect
  152766. */
  152767. depthOfFieldDistance: number;
  152768. /**
  152769. * Represents the blur intensity for the blurred part of the depth of field effect
  152770. */
  152771. depthOfFieldBlurWidth: number;
  152772. /**
  152773. * Gets how much the image is blurred by the movement while using the motion blur post-process
  152774. */
  152775. get motionStrength(): number;
  152776. /**
  152777. * Sets how much the image is blurred by the movement while using the motion blur post-process
  152778. */
  152779. set motionStrength(strength: number);
  152780. /**
  152781. * Gets wether or not the motion blur post-process is object based or screen based.
  152782. */
  152783. get objectBasedMotionBlur(): boolean;
  152784. /**
  152785. * Sets wether or not the motion blur post-process should be object based or screen based
  152786. */
  152787. set objectBasedMotionBlur(value: boolean);
  152788. /**
  152789. * List of animations for the pipeline (IAnimatable implementation)
  152790. */
  152791. animations: Animation[];
  152792. /**
  152793. * Private members
  152794. */
  152795. private _scene;
  152796. private _currentDepthOfFieldSource;
  152797. private _basePostProcess;
  152798. private _fixedExposure;
  152799. private _currentExposure;
  152800. private _hdrAutoExposure;
  152801. private _hdrCurrentLuminance;
  152802. private _motionStrength;
  152803. private _isObjectBasedMotionBlur;
  152804. private _floatTextureType;
  152805. private _camerasToBeAttached;
  152806. private _ratio;
  152807. private _bloomEnabled;
  152808. private _depthOfFieldEnabled;
  152809. private _vlsEnabled;
  152810. private _lensFlareEnabled;
  152811. private _hdrEnabled;
  152812. private _motionBlurEnabled;
  152813. private _fxaaEnabled;
  152814. private _screenSpaceReflectionsEnabled;
  152815. private _motionBlurSamples;
  152816. private _volumetricLightStepsCount;
  152817. private _samples;
  152818. /**
  152819. * @ignore
  152820. * Specifies if the bloom pipeline is enabled
  152821. */
  152822. get BloomEnabled(): boolean;
  152823. set BloomEnabled(enabled: boolean);
  152824. /**
  152825. * @ignore
  152826. * Specifies if the depth of field pipeline is enabed
  152827. */
  152828. get DepthOfFieldEnabled(): boolean;
  152829. set DepthOfFieldEnabled(enabled: boolean);
  152830. /**
  152831. * @ignore
  152832. * Specifies if the lens flare pipeline is enabed
  152833. */
  152834. get LensFlareEnabled(): boolean;
  152835. set LensFlareEnabled(enabled: boolean);
  152836. /**
  152837. * @ignore
  152838. * Specifies if the HDR pipeline is enabled
  152839. */
  152840. get HDREnabled(): boolean;
  152841. set HDREnabled(enabled: boolean);
  152842. /**
  152843. * @ignore
  152844. * Specifies if the volumetric lights scattering effect is enabled
  152845. */
  152846. get VLSEnabled(): boolean;
  152847. set VLSEnabled(enabled: boolean);
  152848. /**
  152849. * @ignore
  152850. * Specifies if the motion blur effect is enabled
  152851. */
  152852. get MotionBlurEnabled(): boolean;
  152853. set MotionBlurEnabled(enabled: boolean);
  152854. /**
  152855. * Specifies if anti-aliasing is enabled
  152856. */
  152857. get fxaaEnabled(): boolean;
  152858. set fxaaEnabled(enabled: boolean);
  152859. /**
  152860. * Specifies if screen space reflections are enabled.
  152861. */
  152862. get screenSpaceReflectionsEnabled(): boolean;
  152863. set screenSpaceReflectionsEnabled(enabled: boolean);
  152864. /**
  152865. * Specifies the number of steps used to calculate the volumetric lights
  152866. * Typically in interval [50, 200]
  152867. */
  152868. get volumetricLightStepsCount(): number;
  152869. set volumetricLightStepsCount(count: number);
  152870. /**
  152871. * Specifies the number of samples used for the motion blur effect
  152872. * Typically in interval [16, 64]
  152873. */
  152874. get motionBlurSamples(): number;
  152875. set motionBlurSamples(samples: number);
  152876. /**
  152877. * Specifies MSAA sample count, setting this to 4 will provide 4x anti aliasing. (default: 1)
  152878. */
  152879. get samples(): number;
  152880. set samples(sampleCount: number);
  152881. /**
  152882. * Default pipeline should be used going forward but the standard pipeline will be kept for backwards compatibility.
  152883. * @constructor
  152884. * @param name The rendering pipeline name
  152885. * @param scene The scene linked to this pipeline
  152886. * @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)
  152887. * @param originalPostProcess the custom original color post-process. Must be "reusable". Can be null.
  152888. * @param cameras The array of cameras that the rendering pipeline will be attached to
  152889. */
  152890. constructor(name: string, scene: Scene, ratio: number, originalPostProcess?: Nullable<PostProcess>, cameras?: Camera[]);
  152891. private _buildPipeline;
  152892. private _createDownSampleX4PostProcess;
  152893. private _createBrightPassPostProcess;
  152894. private _createBlurPostProcesses;
  152895. private _createTextureAdderPostProcess;
  152896. private _createVolumetricLightPostProcess;
  152897. private _createLuminancePostProcesses;
  152898. private _createHdrPostProcess;
  152899. private _createLensFlarePostProcess;
  152900. private _createDepthOfFieldPostProcess;
  152901. private _createMotionBlurPostProcess;
  152902. private _getDepthTexture;
  152903. private _disposePostProcesses;
  152904. /**
  152905. * Dispose of the pipeline and stop all post processes
  152906. */
  152907. dispose(): void;
  152908. /**
  152909. * Serialize the rendering pipeline (Used when exporting)
  152910. * @returns the serialized object
  152911. */
  152912. serialize(): any;
  152913. /**
  152914. * Parse the serialized pipeline
  152915. * @param source Source pipeline.
  152916. * @param scene The scene to load the pipeline to.
  152917. * @param rootUrl The URL of the serialized pipeline.
  152918. * @returns An instantiated pipeline from the serialized object.
  152919. */
  152920. static Parse(source: any, scene: Scene, rootUrl: string): StandardRenderingPipeline;
  152921. /**
  152922. * Luminance steps
  152923. */
  152924. static LuminanceSteps: number;
  152925. }
  152926. }
  152927. declare module BABYLON {
  152928. /** @hidden */
  152929. export var stereoscopicInterlacePixelShader: {
  152930. name: string;
  152931. shader: string;
  152932. };
  152933. }
  152934. declare module BABYLON {
  152935. /**
  152936. * StereoscopicInterlacePostProcessI used to render stereo views from a rigged camera with support for alternate line interlacing
  152937. */
  152938. export class StereoscopicInterlacePostProcessI extends PostProcess {
  152939. private _stepSize;
  152940. private _passedProcess;
  152941. /**
  152942. * Gets a string identifying the name of the class
  152943. * @returns "StereoscopicInterlacePostProcessI" string
  152944. */
  152945. getClassName(): string;
  152946. /**
  152947. * Initializes a StereoscopicInterlacePostProcessI
  152948. * @param name The name of the effect.
  152949. * @param rigCameras The rig cameras to be appled to the post process
  152950. * @param isStereoscopicHoriz If the rendered results are horizontal or vertical
  152951. * @param isStereoscopicInterlaced If the rendered results are alternate line interlaced
  152952. * @param samplingMode The sampling mode to be used when computing the pass. (default: 0)
  152953. * @param engine The engine which the post process will be applied. (default: current engine)
  152954. * @param reusable If the post process can be reused on the same frame. (default: false)
  152955. */
  152956. constructor(name: string, rigCameras: Camera[], isStereoscopicHoriz: boolean, isStereoscopicInterlaced: boolean, samplingMode?: number, engine?: Engine, reusable?: boolean);
  152957. }
  152958. /**
  152959. * StereoscopicInterlacePostProcess used to render stereo views from a rigged camera
  152960. */
  152961. export class StereoscopicInterlacePostProcess extends PostProcess {
  152962. private _stepSize;
  152963. private _passedProcess;
  152964. /**
  152965. * Gets a string identifying the name of the class
  152966. * @returns "StereoscopicInterlacePostProcess" string
  152967. */
  152968. getClassName(): string;
  152969. /**
  152970. * Initializes a StereoscopicInterlacePostProcess
  152971. * @param name The name of the effect.
  152972. * @param rigCameras The rig cameras to be appled to the post process
  152973. * @param isStereoscopicHoriz If the rendered results are horizontal or verticle
  152974. * @param samplingMode The sampling mode to be used when computing the pass. (default: 0)
  152975. * @param engine The engine which the post process will be applied. (default: current engine)
  152976. * @param reusable If the post process can be reused on the same frame. (default: false)
  152977. */
  152978. constructor(name: string, rigCameras: Camera[], isStereoscopicHoriz: boolean, samplingMode?: number, engine?: Engine, reusable?: boolean);
  152979. }
  152980. }
  152981. declare module BABYLON {
  152982. /** @hidden */
  152983. export var tonemapPixelShader: {
  152984. name: string;
  152985. shader: string;
  152986. };
  152987. }
  152988. declare module BABYLON {
  152989. /** Defines operator used for tonemapping */
  152990. export enum TonemappingOperator {
  152991. /** Hable */
  152992. Hable = 0,
  152993. /** Reinhard */
  152994. Reinhard = 1,
  152995. /** HejiDawson */
  152996. HejiDawson = 2,
  152997. /** Photographic */
  152998. Photographic = 3
  152999. }
  153000. /**
  153001. * Defines a post process to apply tone mapping
  153002. */
  153003. export class TonemapPostProcess extends PostProcess {
  153004. private _operator;
  153005. /** Defines the required exposure adjustement */
  153006. exposureAdjustment: number;
  153007. /**
  153008. * Gets a string identifying the name of the class
  153009. * @returns "TonemapPostProcess" string
  153010. */
  153011. getClassName(): string;
  153012. /**
  153013. * Creates a new TonemapPostProcess
  153014. * @param name defines the name of the postprocess
  153015. * @param _operator defines the operator to use
  153016. * @param exposureAdjustment defines the required exposure adjustement
  153017. * @param camera defines the camera to use (can be null)
  153018. * @param samplingMode defines the required sampling mode (BABYLON.Texture.BILINEAR_SAMPLINGMODE by default)
  153019. * @param engine defines the hosting engine (can be ignore if camera is set)
  153020. * @param textureFormat defines the texture format to use (BABYLON.Engine.TEXTURETYPE_UNSIGNED_INT by default)
  153021. */
  153022. constructor(name: string, _operator: TonemappingOperator,
  153023. /** Defines the required exposure adjustement */
  153024. exposureAdjustment: number, camera: Camera, samplingMode?: number, engine?: Engine, textureFormat?: number);
  153025. }
  153026. }
  153027. declare module BABYLON {
  153028. /** @hidden */
  153029. export var volumetricLightScatteringPixelShader: {
  153030. name: string;
  153031. shader: string;
  153032. };
  153033. }
  153034. declare module BABYLON {
  153035. /** @hidden */
  153036. export var volumetricLightScatteringPassVertexShader: {
  153037. name: string;
  153038. shader: string;
  153039. };
  153040. }
  153041. declare module BABYLON {
  153042. /** @hidden */
  153043. export var volumetricLightScatteringPassPixelShader: {
  153044. name: string;
  153045. shader: string;
  153046. };
  153047. }
  153048. declare module BABYLON {
  153049. /**
  153050. * Inspired by http://http.developer.nvidia.com/GPUGems3/gpugems3_ch13.html
  153051. */
  153052. export class VolumetricLightScatteringPostProcess extends PostProcess {
  153053. private _volumetricLightScatteringPass;
  153054. private _volumetricLightScatteringRTT;
  153055. private _viewPort;
  153056. private _screenCoordinates;
  153057. private _cachedDefines;
  153058. /**
  153059. * If not undefined, the mesh position is computed from the attached node position
  153060. */
  153061. attachedNode: {
  153062. position: Vector3;
  153063. };
  153064. /**
  153065. * Custom position of the mesh. Used if "useCustomMeshPosition" is set to "true"
  153066. */
  153067. customMeshPosition: Vector3;
  153068. /**
  153069. * Set if the post-process should use a custom position for the light source (true) or the internal mesh position (false)
  153070. */
  153071. useCustomMeshPosition: boolean;
  153072. /**
  153073. * If the post-process should inverse the light scattering direction
  153074. */
  153075. invert: boolean;
  153076. /**
  153077. * The internal mesh used by the post-process
  153078. */
  153079. mesh: Mesh;
  153080. /**
  153081. * @hidden
  153082. * VolumetricLightScatteringPostProcess.useDiffuseColor is no longer used, use the mesh material directly instead
  153083. */
  153084. get useDiffuseColor(): boolean;
  153085. set useDiffuseColor(useDiffuseColor: boolean);
  153086. /**
  153087. * Array containing the excluded meshes not rendered in the internal pass
  153088. */
  153089. excludedMeshes: AbstractMesh[];
  153090. /**
  153091. * Controls the overall intensity of the post-process
  153092. */
  153093. exposure: number;
  153094. /**
  153095. * Dissipates each sample's contribution in range [0, 1]
  153096. */
  153097. decay: number;
  153098. /**
  153099. * Controls the overall intensity of each sample
  153100. */
  153101. weight: number;
  153102. /**
  153103. * Controls the density of each sample
  153104. */
  153105. density: number;
  153106. /**
  153107. * @constructor
  153108. * @param name The post-process name
  153109. * @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)
  153110. * @param camera The camera that the post-process will be attached to
  153111. * @param mesh The mesh used to create the light scattering
  153112. * @param samples The post-process quality, default 100
  153113. * @param samplingModeThe post-process filtering mode
  153114. * @param engine The babylon engine
  153115. * @param reusable If the post-process is reusable
  153116. * @param scene The constructor needs a scene reference to initialize internal components. If "camera" is null a "scene" must be provided
  153117. */
  153118. constructor(name: string, ratio: any, camera: Camera, mesh?: Mesh, samples?: number, samplingMode?: number, engine?: Engine, reusable?: boolean, scene?: Scene);
  153119. /**
  153120. * Returns the string "VolumetricLightScatteringPostProcess"
  153121. * @returns "VolumetricLightScatteringPostProcess"
  153122. */
  153123. getClassName(): string;
  153124. private _isReady;
  153125. /**
  153126. * Sets the new light position for light scattering effect
  153127. * @param position The new custom light position
  153128. */
  153129. setCustomMeshPosition(position: Vector3): void;
  153130. /**
  153131. * Returns the light position for light scattering effect
  153132. * @return Vector3 The custom light position
  153133. */
  153134. getCustomMeshPosition(): Vector3;
  153135. /**
  153136. * Disposes the internal assets and detaches the post-process from the camera
  153137. */
  153138. dispose(camera: Camera): void;
  153139. /**
  153140. * Returns the render target texture used by the post-process
  153141. * @return the render target texture used by the post-process
  153142. */
  153143. getPass(): RenderTargetTexture;
  153144. private _meshExcluded;
  153145. private _createPass;
  153146. private _updateMeshScreenCoordinates;
  153147. /**
  153148. * Creates a default mesh for the Volumeric Light Scattering post-process
  153149. * @param name The mesh name
  153150. * @param scene The scene where to create the mesh
  153151. * @return the default mesh
  153152. */
  153153. static CreateDefaultMesh(name: string, scene: Scene): Mesh;
  153154. }
  153155. }
  153156. declare module BABYLON {
  153157. /** @hidden */
  153158. export var screenSpaceCurvaturePixelShader: {
  153159. name: string;
  153160. shader: string;
  153161. };
  153162. }
  153163. declare module BABYLON {
  153164. /**
  153165. * The Screen Space curvature effect can help highlighting ridge and valley of a model.
  153166. */
  153167. export class ScreenSpaceCurvaturePostProcess extends PostProcess {
  153168. /**
  153169. * Defines how much ridge the curvature effect displays.
  153170. */
  153171. ridge: number;
  153172. /**
  153173. * Defines how much valley the curvature effect displays.
  153174. */
  153175. valley: number;
  153176. private _geometryBufferRenderer;
  153177. /**
  153178. * Gets a string identifying the name of the class
  153179. * @returns "ScreenSpaceCurvaturePostProcess" string
  153180. */
  153181. getClassName(): string;
  153182. /**
  153183. * Creates a new instance ScreenSpaceCurvaturePostProcess
  153184. * @param name The name of the effect.
  153185. * @param scene The scene containing the objects to blur according to their velocity.
  153186. * @param options The required width/height ratio to downsize to before computing the render pass.
  153187. * @param camera The camera to apply the render pass to.
  153188. * @param samplingMode The sampling mode to be used when computing the pass. (default: 0)
  153189. * @param engine The engine which the post process will be applied. (default: current engine)
  153190. * @param reusable If the post process can be reused on the same frame. (default: false)
  153191. * @param textureType Type of textures used when performing the post process. (default: 0)
  153192. * @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)
  153193. */
  153194. constructor(name: string, scene: Scene, options: number | PostProcessOptions, camera: Nullable<Camera>, samplingMode?: number, engine?: Engine, reusable?: boolean, textureType?: number, blockCompilation?: boolean);
  153195. /**
  153196. * Support test.
  153197. */
  153198. static get IsSupported(): boolean;
  153199. /** @hidden */
  153200. static _Parse(parsedPostProcess: any, targetCamera: Camera, scene: Scene, rootUrl: string): ScreenSpaceCurvaturePostProcess;
  153201. }
  153202. }
  153203. declare module BABYLON {
  153204. interface Scene {
  153205. /** @hidden (Backing field) */
  153206. _boundingBoxRenderer: BoundingBoxRenderer;
  153207. /** @hidden (Backing field) */
  153208. _forceShowBoundingBoxes: boolean;
  153209. /**
  153210. * Gets or sets a boolean indicating if all bounding boxes must be rendered
  153211. */
  153212. forceShowBoundingBoxes: boolean;
  153213. /**
  153214. * Gets the bounding box renderer associated with the scene
  153215. * @returns a BoundingBoxRenderer
  153216. */
  153217. getBoundingBoxRenderer(): BoundingBoxRenderer;
  153218. }
  153219. interface AbstractMesh {
  153220. /** @hidden (Backing field) */
  153221. _showBoundingBox: boolean;
  153222. /**
  153223. * Gets or sets a boolean indicating if the bounding box must be rendered as well (false by default)
  153224. */
  153225. showBoundingBox: boolean;
  153226. }
  153227. /**
  153228. * Component responsible of rendering the bounding box of the meshes in a scene.
  153229. * This is usually used through the mesh.showBoundingBox or the scene.forceShowBoundingBoxes properties
  153230. */
  153231. export class BoundingBoxRenderer implements ISceneComponent {
  153232. /**
  153233. * The component name helpfull to identify the component in the list of scene components.
  153234. */
  153235. readonly name: string;
  153236. /**
  153237. * The scene the component belongs to.
  153238. */
  153239. scene: Scene;
  153240. /**
  153241. * Color of the bounding box lines placed in front of an object
  153242. */
  153243. frontColor: Color3;
  153244. /**
  153245. * Color of the bounding box lines placed behind an object
  153246. */
  153247. backColor: Color3;
  153248. /**
  153249. * Defines if the renderer should show the back lines or not
  153250. */
  153251. showBackLines: boolean;
  153252. /**
  153253. * Observable raised before rendering a bounding box
  153254. */
  153255. onBeforeBoxRenderingObservable: Observable<BoundingBox>;
  153256. /**
  153257. * Observable raised after rendering a bounding box
  153258. */
  153259. onAfterBoxRenderingObservable: Observable<BoundingBox>;
  153260. /**
  153261. * @hidden
  153262. */
  153263. renderList: SmartArray<BoundingBox>;
  153264. private _colorShader;
  153265. private _vertexBuffers;
  153266. private _indexBuffer;
  153267. private _fillIndexBuffer;
  153268. private _fillIndexData;
  153269. /**
  153270. * Instantiates a new bounding box renderer in a scene.
  153271. * @param scene the scene the renderer renders in
  153272. */
  153273. constructor(scene: Scene);
  153274. /**
  153275. * Registers the component in a given scene
  153276. */
  153277. register(): void;
  153278. private _evaluateSubMesh;
  153279. private _activeMesh;
  153280. private _prepareRessources;
  153281. private _createIndexBuffer;
  153282. /**
  153283. * Rebuilds the elements related to this component in case of
  153284. * context lost for instance.
  153285. */
  153286. rebuild(): void;
  153287. /**
  153288. * @hidden
  153289. */
  153290. reset(): void;
  153291. /**
  153292. * Render the bounding boxes of a specific rendering group
  153293. * @param renderingGroupId defines the rendering group to render
  153294. */
  153295. render(renderingGroupId: number): void;
  153296. /**
  153297. * In case of occlusion queries, we can render the occlusion bounding box through this method
  153298. * @param mesh Define the mesh to render the occlusion bounding box for
  153299. */
  153300. renderOcclusionBoundingBox(mesh: AbstractMesh): void;
  153301. /**
  153302. * Dispose and release the resources attached to this renderer.
  153303. */
  153304. dispose(): void;
  153305. }
  153306. }
  153307. declare module BABYLON {
  153308. interface Scene {
  153309. /** @hidden (Backing field) */
  153310. _depthRenderer: {
  153311. [id: string]: DepthRenderer;
  153312. };
  153313. /**
  153314. * Creates a depth renderer a given camera which contains a depth map which can be used for post processing.
  153315. * @param camera The camera to create the depth renderer on (default: scene's active camera)
  153316. * @param storeNonLinearDepth Defines whether the depth is stored linearly like in Babylon Shadows or directly like glFragCoord.z
  153317. * @param force32bitsFloat Forces 32 bits float when supported (else 16 bits float is prioritized over 32 bits float if supported)
  153318. * @returns the created depth renderer
  153319. */
  153320. enableDepthRenderer(camera?: Nullable<Camera>, storeNonLinearDepth?: boolean, force32bitsFloat?: boolean): DepthRenderer;
  153321. /**
  153322. * Disables a depth renderer for a given camera
  153323. * @param camera The camera to disable the depth renderer on (default: scene's active camera)
  153324. */
  153325. disableDepthRenderer(camera?: Nullable<Camera>): void;
  153326. }
  153327. /**
  153328. * Defines the Depth Renderer scene component responsible to manage a depth buffer useful
  153329. * in several rendering techniques.
  153330. */
  153331. export class DepthRendererSceneComponent implements ISceneComponent {
  153332. /**
  153333. * The component name helpfull to identify the component in the list of scene components.
  153334. */
  153335. readonly name: string;
  153336. /**
  153337. * The scene the component belongs to.
  153338. */
  153339. scene: Scene;
  153340. /**
  153341. * Creates a new instance of the component for the given scene
  153342. * @param scene Defines the scene to register the component in
  153343. */
  153344. constructor(scene: Scene);
  153345. /**
  153346. * Registers the component in a given scene
  153347. */
  153348. register(): void;
  153349. /**
  153350. * Rebuilds the elements related to this component in case of
  153351. * context lost for instance.
  153352. */
  153353. rebuild(): void;
  153354. /**
  153355. * Disposes the component and the associated ressources
  153356. */
  153357. dispose(): void;
  153358. private _gatherRenderTargets;
  153359. private _gatherActiveCameraRenderTargets;
  153360. }
  153361. }
  153362. declare module BABYLON {
  153363. interface AbstractScene {
  153364. /** @hidden (Backing field) */
  153365. _prePassRenderer: Nullable<PrePassRenderer>;
  153366. /**
  153367. * Gets or Sets the current prepass renderer associated to the scene.
  153368. */
  153369. prePassRenderer: Nullable<PrePassRenderer>;
  153370. /**
  153371. * Enables the prepass and associates it with the scene
  153372. * @returns the PrePassRenderer
  153373. */
  153374. enablePrePassRenderer(): Nullable<PrePassRenderer>;
  153375. /**
  153376. * Disables the prepass associated with the scene
  153377. */
  153378. disablePrePassRenderer(): void;
  153379. }
  153380. /**
  153381. * Defines the Geometry Buffer scene component responsible to manage a G-Buffer useful
  153382. * in several rendering techniques.
  153383. */
  153384. export class PrePassRendererSceneComponent implements ISceneComponent {
  153385. /**
  153386. * The component name helpful to identify the component in the list of scene components.
  153387. */
  153388. readonly name: string;
  153389. /**
  153390. * The scene the component belongs to.
  153391. */
  153392. scene: Scene;
  153393. /**
  153394. * Creates a new instance of the component for the given scene
  153395. * @param scene Defines the scene to register the component in
  153396. */
  153397. constructor(scene: Scene);
  153398. /**
  153399. * Registers the component in a given scene
  153400. */
  153401. register(): void;
  153402. private _beforeCameraDraw;
  153403. private _afterCameraDraw;
  153404. private _beforeClearStage;
  153405. /**
  153406. * Rebuilds the elements related to this component in case of
  153407. * context lost for instance.
  153408. */
  153409. rebuild(): void;
  153410. /**
  153411. * Disposes the component and the associated ressources
  153412. */
  153413. dispose(): void;
  153414. }
  153415. }
  153416. declare module BABYLON {
  153417. /** @hidden */
  153418. export var fibonacci: {
  153419. name: string;
  153420. shader: string;
  153421. };
  153422. }
  153423. declare module BABYLON {
  153424. /** @hidden */
  153425. export var diffusionProfile: {
  153426. name: string;
  153427. shader: string;
  153428. };
  153429. }
  153430. declare module BABYLON {
  153431. /** @hidden */
  153432. export var subSurfaceScatteringPixelShader: {
  153433. name: string;
  153434. shader: string;
  153435. };
  153436. }
  153437. declare module BABYLON {
  153438. /**
  153439. * Sub surface scattering post process
  153440. */
  153441. export class SubSurfaceScatteringPostProcess extends PostProcess {
  153442. /**
  153443. * Gets a string identifying the name of the class
  153444. * @returns "SubSurfaceScatteringPostProcess" string
  153445. */
  153446. getClassName(): string;
  153447. constructor(name: string, scene: Scene, options: number | PostProcessOptions, camera?: Nullable<Camera>, samplingMode?: number, engine?: Engine, reusable?: boolean, textureType?: number);
  153448. }
  153449. }
  153450. declare module BABYLON {
  153451. /**
  153452. * Contains all parameters needed for the prepass to perform
  153453. * screen space subsurface scattering
  153454. */
  153455. export class SubSurfaceConfiguration implements PrePassEffectConfiguration {
  153456. /** @hidden */
  153457. static _SceneComponentInitialization: (scene: Scene) => void;
  153458. private _ssDiffusionS;
  153459. private _ssFilterRadii;
  153460. private _ssDiffusionD;
  153461. /**
  153462. * Post process to attach for screen space subsurface scattering
  153463. */
  153464. postProcess: SubSurfaceScatteringPostProcess;
  153465. /**
  153466. * Diffusion profile color for subsurface scattering
  153467. */
  153468. get ssDiffusionS(): number[];
  153469. /**
  153470. * Diffusion profile max color channel value for subsurface scattering
  153471. */
  153472. get ssDiffusionD(): number[];
  153473. /**
  153474. * Diffusion profile filter radius for subsurface scattering
  153475. */
  153476. get ssFilterRadii(): number[];
  153477. /**
  153478. * Is subsurface enabled
  153479. */
  153480. enabled: boolean;
  153481. /**
  153482. * Name of the configuration
  153483. */
  153484. name: string;
  153485. /**
  153486. * Diffusion profile colors for subsurface scattering
  153487. * You can add one diffusion color using `addDiffusionProfile` on `scene.prePassRenderer`
  153488. * See ...
  153489. * Note that you can only store up to 5 of them
  153490. */
  153491. ssDiffusionProfileColors: Color3[];
  153492. /**
  153493. * Defines the ratio real world => scene units.
  153494. * Used for subsurface scattering
  153495. */
  153496. metersPerUnit: number;
  153497. /**
  153498. * Textures that should be present in the MRT for this effect to work
  153499. */
  153500. readonly texturesRequired: number[];
  153501. private _scene;
  153502. /**
  153503. * Builds a subsurface configuration object
  153504. * @param scene The scene
  153505. */
  153506. constructor(scene: Scene);
  153507. /**
  153508. * Adds a new diffusion profile.
  153509. * Useful for more realistic subsurface scattering on diverse materials.
  153510. * @param color The color of the diffusion profile. Should be the average color of the material.
  153511. * @return The index of the diffusion profile for the material subsurface configuration
  153512. */
  153513. addDiffusionProfile(color: Color3): number;
  153514. /**
  153515. * Creates the sss post process
  153516. * @return The created post process
  153517. */
  153518. createPostProcess(): SubSurfaceScatteringPostProcess;
  153519. /**
  153520. * Deletes all diffusion profiles.
  153521. * Note that in order to render subsurface scattering, you should have at least 1 diffusion profile.
  153522. */
  153523. clearAllDiffusionProfiles(): void;
  153524. /**
  153525. * Disposes this object
  153526. */
  153527. dispose(): void;
  153528. /**
  153529. * @hidden
  153530. * https://zero-radiance.github.io/post/sampling-diffusion/
  153531. *
  153532. * Importance sample the normalized diffuse reflectance profile for the computed value of 's'.
  153533. * ------------------------------------------------------------------------------------
  153534. * R[r, phi, s] = s * (Exp[-r * s] + Exp[-r * s / 3]) / (8 * Pi * r)
  153535. * PDF[r, phi, s] = r * R[r, phi, s]
  153536. * CDF[r, s] = 1 - 1/4 * Exp[-r * s] - 3/4 * Exp[-r * s / 3]
  153537. * ------------------------------------------------------------------------------------
  153538. * We importance sample the color channel with the widest scattering distance.
  153539. */
  153540. getDiffusionProfileParameters(color: Color3): number;
  153541. /**
  153542. * Performs sampling of a Normalized Burley diffusion profile in polar coordinates.
  153543. * 'u' is the random number (the value of the CDF): [0, 1).
  153544. * rcp(s) = 1 / ShapeParam = ScatteringDistance.
  153545. * Returns the sampled radial distance, s.t. (u = 0 -> r = 0) and (u = 1 -> r = Inf).
  153546. */
  153547. private _sampleBurleyDiffusionProfile;
  153548. }
  153549. }
  153550. declare module BABYLON {
  153551. interface AbstractScene {
  153552. /** @hidden (Backing field) */
  153553. _subSurfaceConfiguration: Nullable<SubSurfaceConfiguration>;
  153554. /**
  153555. * Gets or Sets the current prepass renderer associated to the scene.
  153556. */
  153557. subSurfaceConfiguration: Nullable<SubSurfaceConfiguration>;
  153558. /**
  153559. * Enables the subsurface effect for prepass
  153560. * @returns the SubSurfaceConfiguration
  153561. */
  153562. enableSubSurfaceForPrePass(): Nullable<SubSurfaceConfiguration>;
  153563. /**
  153564. * Disables the subsurface effect for prepass
  153565. */
  153566. disableSubSurfaceForPrePass(): void;
  153567. }
  153568. /**
  153569. * Defines the Geometry Buffer scene component responsible to manage a G-Buffer useful
  153570. * in several rendering techniques.
  153571. */
  153572. export class SubSurfaceSceneComponent implements ISceneSerializableComponent {
  153573. /**
  153574. * The component name helpful to identify the component in the list of scene components.
  153575. */
  153576. readonly name: string;
  153577. /**
  153578. * The scene the component belongs to.
  153579. */
  153580. scene: Scene;
  153581. /**
  153582. * Creates a new instance of the component for the given scene
  153583. * @param scene Defines the scene to register the component in
  153584. */
  153585. constructor(scene: Scene);
  153586. /**
  153587. * Registers the component in a given scene
  153588. */
  153589. register(): void;
  153590. /**
  153591. * Serializes the component data to the specified json object
  153592. * @param serializationObject The object to serialize to
  153593. */
  153594. serialize(serializationObject: any): void;
  153595. /**
  153596. * Adds all the elements from the container to the scene
  153597. * @param container the container holding the elements
  153598. */
  153599. addFromContainer(container: AbstractScene): void;
  153600. /**
  153601. * Removes all the elements in the container from the scene
  153602. * @param container contains the elements to remove
  153603. * @param dispose if the removed element should be disposed (default: false)
  153604. */
  153605. removeFromContainer(container: AbstractScene, dispose?: boolean): void;
  153606. /**
  153607. * Rebuilds the elements related to this component in case of
  153608. * context lost for instance.
  153609. */
  153610. rebuild(): void;
  153611. /**
  153612. * Disposes the component and the associated ressources
  153613. */
  153614. dispose(): void;
  153615. }
  153616. }
  153617. declare module BABYLON {
  153618. /** @hidden */
  153619. export var outlinePixelShader: {
  153620. name: string;
  153621. shader: string;
  153622. };
  153623. }
  153624. declare module BABYLON {
  153625. /** @hidden */
  153626. export var outlineVertexShader: {
  153627. name: string;
  153628. shader: string;
  153629. };
  153630. }
  153631. declare module BABYLON {
  153632. interface Scene {
  153633. /** @hidden */
  153634. _outlineRenderer: OutlineRenderer;
  153635. /**
  153636. * Gets the outline renderer associated with the scene
  153637. * @returns a OutlineRenderer
  153638. */
  153639. getOutlineRenderer(): OutlineRenderer;
  153640. }
  153641. interface AbstractMesh {
  153642. /** @hidden (Backing field) */
  153643. _renderOutline: boolean;
  153644. /**
  153645. * Gets or sets a boolean indicating if the outline must be rendered as well
  153646. * @see https://www.babylonjs-playground.com/#10WJ5S#3
  153647. */
  153648. renderOutline: boolean;
  153649. /** @hidden (Backing field) */
  153650. _renderOverlay: boolean;
  153651. /**
  153652. * Gets or sets a boolean indicating if the overlay must be rendered as well
  153653. * @see https://www.babylonjs-playground.com/#10WJ5S#2
  153654. */
  153655. renderOverlay: boolean;
  153656. }
  153657. /**
  153658. * This class is responsible to draw bothe outline/overlay of meshes.
  153659. * It should not be used directly but through the available method on mesh.
  153660. */
  153661. export class OutlineRenderer implements ISceneComponent {
  153662. /**
  153663. * Stencil value used to avoid outline being seen within the mesh when the mesh is transparent
  153664. */
  153665. private static _StencilReference;
  153666. /**
  153667. * The name of the component. Each component must have a unique name.
  153668. */
  153669. name: string;
  153670. /**
  153671. * The scene the component belongs to.
  153672. */
  153673. scene: Scene;
  153674. /**
  153675. * Defines a zOffset to prevent zFighting between the overlay and the mesh.
  153676. */
  153677. zOffset: number;
  153678. private _engine;
  153679. private _effect;
  153680. private _cachedDefines;
  153681. private _savedDepthWrite;
  153682. /**
  153683. * Instantiates a new outline renderer. (There could be only one per scene).
  153684. * @param scene Defines the scene it belongs to
  153685. */
  153686. constructor(scene: Scene);
  153687. /**
  153688. * Register the component to one instance of a scene.
  153689. */
  153690. register(): void;
  153691. /**
  153692. * Rebuilds the elements related to this component in case of
  153693. * context lost for instance.
  153694. */
  153695. rebuild(): void;
  153696. /**
  153697. * Disposes the component and the associated ressources.
  153698. */
  153699. dispose(): void;
  153700. /**
  153701. * Renders the outline in the canvas.
  153702. * @param subMesh Defines the sumesh to render
  153703. * @param batch Defines the batch of meshes in case of instances
  153704. * @param useOverlay Defines if the rendering is for the overlay or the outline
  153705. */
  153706. render(subMesh: SubMesh, batch: _InstancesBatch, useOverlay?: boolean): void;
  153707. /**
  153708. * Returns whether or not the outline renderer is ready for a given submesh.
  153709. * All the dependencies e.g. submeshes, texture, effect... mus be ready
  153710. * @param subMesh Defines the submesh to check readyness for
  153711. * @param useInstances Defines wheter wee are trying to render instances or not
  153712. * @returns true if ready otherwise false
  153713. */
  153714. isReady(subMesh: SubMesh, useInstances: boolean): boolean;
  153715. private _beforeRenderingMesh;
  153716. private _afterRenderingMesh;
  153717. }
  153718. }
  153719. declare module BABYLON {
  153720. /**
  153721. * Defines the basic options interface of a Sprite Frame Source Size.
  153722. */
  153723. export interface ISpriteJSONSpriteSourceSize {
  153724. /**
  153725. * number of the original width of the Frame
  153726. */
  153727. w: number;
  153728. /**
  153729. * number of the original height of the Frame
  153730. */
  153731. h: number;
  153732. }
  153733. /**
  153734. * Defines the basic options interface of a Sprite Frame Data.
  153735. */
  153736. export interface ISpriteJSONSpriteFrameData {
  153737. /**
  153738. * number of the x offset of the Frame
  153739. */
  153740. x: number;
  153741. /**
  153742. * number of the y offset of the Frame
  153743. */
  153744. y: number;
  153745. /**
  153746. * number of the width of the Frame
  153747. */
  153748. w: number;
  153749. /**
  153750. * number of the height of the Frame
  153751. */
  153752. h: number;
  153753. }
  153754. /**
  153755. * Defines the basic options interface of a JSON Sprite.
  153756. */
  153757. export interface ISpriteJSONSprite {
  153758. /**
  153759. * string name of the Frame
  153760. */
  153761. filename: string;
  153762. /**
  153763. * ISpriteJSONSpriteFrame basic object of the frame data
  153764. */
  153765. frame: ISpriteJSONSpriteFrameData;
  153766. /**
  153767. * boolean to flag is the frame was rotated.
  153768. */
  153769. rotated: boolean;
  153770. /**
  153771. * boolean to flag is the frame was trimmed.
  153772. */
  153773. trimmed: boolean;
  153774. /**
  153775. * ISpriteJSONSpriteFrame basic object of the source data
  153776. */
  153777. spriteSourceSize: ISpriteJSONSpriteFrameData;
  153778. /**
  153779. * ISpriteJSONSpriteFrame basic object of the source data
  153780. */
  153781. sourceSize: ISpriteJSONSpriteSourceSize;
  153782. }
  153783. /**
  153784. * Defines the basic options interface of a JSON atlas.
  153785. */
  153786. export interface ISpriteJSONAtlas {
  153787. /**
  153788. * Array of objects that contain the frame data.
  153789. */
  153790. frames: Array<ISpriteJSONSprite>;
  153791. /**
  153792. * object basic object containing the sprite meta data.
  153793. */
  153794. meta?: object;
  153795. }
  153796. }
  153797. declare module BABYLON {
  153798. /** @hidden */
  153799. export var spriteMapPixelShader: {
  153800. name: string;
  153801. shader: string;
  153802. };
  153803. }
  153804. declare module BABYLON {
  153805. /** @hidden */
  153806. export var spriteMapVertexShader: {
  153807. name: string;
  153808. shader: string;
  153809. };
  153810. }
  153811. declare module BABYLON {
  153812. /**
  153813. * Defines the basic options interface of a SpriteMap
  153814. */
  153815. export interface ISpriteMapOptions {
  153816. /**
  153817. * Vector2 of the number of cells in the grid.
  153818. */
  153819. stageSize?: Vector2;
  153820. /**
  153821. * Vector2 of the size of the output plane in World Units.
  153822. */
  153823. outputSize?: Vector2;
  153824. /**
  153825. * Vector3 of the position of the output plane in World Units.
  153826. */
  153827. outputPosition?: Vector3;
  153828. /**
  153829. * Vector3 of the rotation of the output plane.
  153830. */
  153831. outputRotation?: Vector3;
  153832. /**
  153833. * number of layers that the system will reserve in resources.
  153834. */
  153835. layerCount?: number;
  153836. /**
  153837. * number of max animation frames a single cell will reserve in resources.
  153838. */
  153839. maxAnimationFrames?: number;
  153840. /**
  153841. * number cell index of the base tile when the system compiles.
  153842. */
  153843. baseTile?: number;
  153844. /**
  153845. * boolean flip the sprite after its been repositioned by the framing data.
  153846. */
  153847. flipU?: boolean;
  153848. /**
  153849. * Vector3 scalar of the global RGB values of the SpriteMap.
  153850. */
  153851. colorMultiply?: Vector3;
  153852. }
  153853. /**
  153854. * Defines the IDisposable interface in order to be cleanable from resources.
  153855. */
  153856. export interface ISpriteMap extends IDisposable {
  153857. /**
  153858. * String name of the SpriteMap.
  153859. */
  153860. name: string;
  153861. /**
  153862. * The JSON Array file from a https://www.codeandweb.com/texturepacker export. Or similar structure.
  153863. */
  153864. atlasJSON: ISpriteJSONAtlas;
  153865. /**
  153866. * Texture of the SpriteMap.
  153867. */
  153868. spriteSheet: Texture;
  153869. /**
  153870. * The parameters to initialize the SpriteMap with.
  153871. */
  153872. options: ISpriteMapOptions;
  153873. }
  153874. /**
  153875. * Class used to manage a grid restricted sprite deployment on an Output plane.
  153876. */
  153877. export class SpriteMap implements ISpriteMap {
  153878. /** The Name of the spriteMap */
  153879. name: string;
  153880. /** The JSON file with the frame and meta data */
  153881. atlasJSON: ISpriteJSONAtlas;
  153882. /** The systems Sprite Sheet Texture */
  153883. spriteSheet: Texture;
  153884. /** Arguments passed with the Constructor */
  153885. options: ISpriteMapOptions;
  153886. /** Public Sprite Storage array, parsed from atlasJSON */
  153887. sprites: Array<ISpriteJSONSprite>;
  153888. /** Returns the Number of Sprites in the System */
  153889. get spriteCount(): number;
  153890. /** Returns the Position of Output Plane*/
  153891. get position(): Vector3;
  153892. /** Returns the Position of Output Plane*/
  153893. set position(v: Vector3);
  153894. /** Returns the Rotation of Output Plane*/
  153895. get rotation(): Vector3;
  153896. /** Returns the Rotation of Output Plane*/
  153897. set rotation(v: Vector3);
  153898. /** Sets the AnimationMap*/
  153899. get animationMap(): RawTexture;
  153900. /** Sets the AnimationMap*/
  153901. set animationMap(v: RawTexture);
  153902. /** Scene that the SpriteMap was created in */
  153903. private _scene;
  153904. /** Texture Buffer of Float32 that holds tile frame data*/
  153905. private _frameMap;
  153906. /** Texture Buffers of Float32 that holds tileMap data*/
  153907. private _tileMaps;
  153908. /** Texture Buffer of Float32 that holds Animation Data*/
  153909. private _animationMap;
  153910. /** Custom ShaderMaterial Central to the System*/
  153911. private _material;
  153912. /** Custom ShaderMaterial Central to the System*/
  153913. private _output;
  153914. /** Systems Time Ticker*/
  153915. private _time;
  153916. /**
  153917. * Creates a new SpriteMap
  153918. * @param name defines the SpriteMaps Name
  153919. * @param atlasJSON is the JSON file that controls the Sprites Frames and Meta
  153920. * @param spriteSheet is the Texture that the Sprites are on.
  153921. * @param options a basic deployment configuration
  153922. * @param scene The Scene that the map is deployed on
  153923. */
  153924. constructor(name: string, atlasJSON: ISpriteJSONAtlas, spriteSheet: Texture, options: ISpriteMapOptions, scene: Scene);
  153925. /**
  153926. * Returns tileID location
  153927. * @returns Vector2 the cell position ID
  153928. */
  153929. getTileID(): Vector2;
  153930. /**
  153931. * Gets the UV location of the mouse over the SpriteMap.
  153932. * @returns Vector2 the UV position of the mouse interaction
  153933. */
  153934. getMousePosition(): Vector2;
  153935. /**
  153936. * Creates the "frame" texture Buffer
  153937. * -------------------------------------
  153938. * Structure of frames
  153939. * "filename": "Falling-Water-2.png",
  153940. * "frame": {"x":69,"y":103,"w":24,"h":32},
  153941. * "rotated": true,
  153942. * "trimmed": true,
  153943. * "spriteSourceSize": {"x":4,"y":0,"w":24,"h":32},
  153944. * "sourceSize": {"w":32,"h":32}
  153945. * @returns RawTexture of the frameMap
  153946. */
  153947. private _createFrameBuffer;
  153948. /**
  153949. * Creates the tileMap texture Buffer
  153950. * @param buffer normally and array of numbers, or a false to generate from scratch
  153951. * @param _layer indicates what layer for a logic trigger dealing with the baseTile. The system uses this
  153952. * @returns RawTexture of the tileMap
  153953. */
  153954. private _createTileBuffer;
  153955. /**
  153956. * Modifies the data of the tileMaps
  153957. * @param _layer is the ID of the layer you want to edit on the SpriteMap
  153958. * @param pos is the iVector2 Coordinates of the Tile
  153959. * @param tile The SpriteIndex of the new Tile
  153960. */
  153961. changeTiles(_layer: number | undefined, pos: Vector2 | Vector2[], tile?: number): void;
  153962. /**
  153963. * Creates the animationMap texture Buffer
  153964. * @param buffer normally and array of numbers, or a false to generate from scratch
  153965. * @returns RawTexture of the animationMap
  153966. */
  153967. private _createTileAnimationBuffer;
  153968. /**
  153969. * Modifies the data of the animationMap
  153970. * @param cellID is the Index of the Sprite
  153971. * @param _frame is the target Animation frame
  153972. * @param toCell is the Target Index of the next frame of the animation
  153973. * @param time is a value between 0-1 that is the trigger for when the frame should change tiles
  153974. * @param speed is a global scalar of the time variable on the map.
  153975. */
  153976. addAnimationToTile(cellID?: number, _frame?: number, toCell?: number, time?: number, speed?: number): void;
  153977. /**
  153978. * Exports the .tilemaps file
  153979. */
  153980. saveTileMaps(): void;
  153981. /**
  153982. * Imports the .tilemaps file
  153983. * @param url of the .tilemaps file
  153984. */
  153985. loadTileMaps(url: string): void;
  153986. /**
  153987. * Release associated resources
  153988. */
  153989. dispose(): void;
  153990. }
  153991. }
  153992. declare module BABYLON {
  153993. /**
  153994. * Class used to manage multiple sprites of different sizes on the same spritesheet
  153995. * @see https://doc.babylonjs.com/babylon101/sprites
  153996. */
  153997. export class SpritePackedManager extends SpriteManager {
  153998. /** defines the packed manager's name */
  153999. name: string;
  154000. /**
  154001. * Creates a new sprite manager from a packed sprite sheet
  154002. * @param name defines the manager's name
  154003. * @param imgUrl defines the sprite sheet url
  154004. * @param capacity defines the maximum allowed number of sprites
  154005. * @param scene defines the hosting scene
  154006. * @param spriteJSON null otherwise a JSON object defining sprite sheet data
  154007. * @param epsilon defines the epsilon value to align texture (0.01 by default)
  154008. * @param samplingMode defines the smapling mode to use with spritesheet
  154009. * @param fromPacked set to true; do not alter
  154010. */
  154011. constructor(
  154012. /** defines the packed manager's name */
  154013. name: string, imgUrl: string, capacity: number, scene: Scene, spriteJSON?: string | null, epsilon?: number, samplingMode?: number);
  154014. }
  154015. }
  154016. declare module BABYLON {
  154017. /**
  154018. * Defines the list of states available for a task inside a AssetsManager
  154019. */
  154020. export enum AssetTaskState {
  154021. /**
  154022. * Initialization
  154023. */
  154024. INIT = 0,
  154025. /**
  154026. * Running
  154027. */
  154028. RUNNING = 1,
  154029. /**
  154030. * Done
  154031. */
  154032. DONE = 2,
  154033. /**
  154034. * Error
  154035. */
  154036. ERROR = 3
  154037. }
  154038. /**
  154039. * Define an abstract asset task used with a AssetsManager class to load assets into a scene
  154040. */
  154041. export abstract class AbstractAssetTask {
  154042. /**
  154043. * Task name
  154044. */ name: string;
  154045. /**
  154046. * Callback called when the task is successful
  154047. */
  154048. onSuccess: (task: any) => void;
  154049. /**
  154050. * Callback called when the task is not successful
  154051. */
  154052. onError: (task: any, message?: string, exception?: any) => void;
  154053. /**
  154054. * Creates a new AssetsManager
  154055. * @param name defines the name of the task
  154056. */
  154057. constructor(
  154058. /**
  154059. * Task name
  154060. */ name: string);
  154061. private _isCompleted;
  154062. private _taskState;
  154063. private _errorObject;
  154064. /**
  154065. * Get if the task is completed
  154066. */
  154067. get isCompleted(): boolean;
  154068. /**
  154069. * Gets the current state of the task
  154070. */
  154071. get taskState(): AssetTaskState;
  154072. /**
  154073. * Gets the current error object (if task is in error)
  154074. */
  154075. get errorObject(): {
  154076. message?: string;
  154077. exception?: any;
  154078. };
  154079. /**
  154080. * Internal only
  154081. * @hidden
  154082. */
  154083. _setErrorObject(message?: string, exception?: any): void;
  154084. /**
  154085. * Execute the current task
  154086. * @param scene defines the scene where you want your assets to be loaded
  154087. * @param onSuccess is a callback called when the task is successfully executed
  154088. * @param onError is a callback called if an error occurs
  154089. */
  154090. run(scene: Scene, onSuccess: () => void, onError: (message?: string, exception?: any) => void): void;
  154091. /**
  154092. * Execute the current task
  154093. * @param scene defines the scene where you want your assets to be loaded
  154094. * @param onSuccess is a callback called when the task is successfully executed
  154095. * @param onError is a callback called if an error occurs
  154096. */
  154097. runTask(scene: Scene, onSuccess: () => void, onError: (message?: string, exception?: any) => void): void;
  154098. /**
  154099. * Reset will set the task state back to INIT, so the next load call of the assets manager will execute this task again.
  154100. * This can be used with failed tasks that have the reason for failure fixed.
  154101. */
  154102. reset(): void;
  154103. private onErrorCallback;
  154104. private onDoneCallback;
  154105. }
  154106. /**
  154107. * Define the interface used by progress events raised during assets loading
  154108. */
  154109. export interface IAssetsProgressEvent {
  154110. /**
  154111. * Defines the number of remaining tasks to process
  154112. */
  154113. remainingCount: number;
  154114. /**
  154115. * Defines the total number of tasks
  154116. */
  154117. totalCount: number;
  154118. /**
  154119. * Defines the task that was just processed
  154120. */
  154121. task: AbstractAssetTask;
  154122. }
  154123. /**
  154124. * Class used to share progress information about assets loading
  154125. */
  154126. export class AssetsProgressEvent implements IAssetsProgressEvent {
  154127. /**
  154128. * Defines the number of remaining tasks to process
  154129. */
  154130. remainingCount: number;
  154131. /**
  154132. * Defines the total number of tasks
  154133. */
  154134. totalCount: number;
  154135. /**
  154136. * Defines the task that was just processed
  154137. */
  154138. task: AbstractAssetTask;
  154139. /**
  154140. * Creates a AssetsProgressEvent
  154141. * @param remainingCount defines the number of remaining tasks to process
  154142. * @param totalCount defines the total number of tasks
  154143. * @param task defines the task that was just processed
  154144. */
  154145. constructor(remainingCount: number, totalCount: number, task: AbstractAssetTask);
  154146. }
  154147. /**
  154148. * Define a task used by AssetsManager to load assets into a container
  154149. */
  154150. export class ContainerAssetTask extends AbstractAssetTask {
  154151. /**
  154152. * Defines the name of the task
  154153. */
  154154. name: string;
  154155. /**
  154156. * Defines the list of mesh's names you want to load
  154157. */
  154158. meshesNames: any;
  154159. /**
  154160. * Defines the root url to use as a base to load your meshes and associated resources
  154161. */
  154162. rootUrl: string;
  154163. /**
  154164. * Defines the filename or File of the scene to load from
  154165. */
  154166. sceneFilename: string | File;
  154167. /**
  154168. * Get the loaded asset container
  154169. */
  154170. loadedContainer: AssetContainer;
  154171. /**
  154172. * Gets the list of loaded meshes
  154173. */
  154174. loadedMeshes: Array<AbstractMesh>;
  154175. /**
  154176. * Gets the list of loaded particle systems
  154177. */
  154178. loadedParticleSystems: Array<IParticleSystem>;
  154179. /**
  154180. * Gets the list of loaded skeletons
  154181. */
  154182. loadedSkeletons: Array<Skeleton>;
  154183. /**
  154184. * Gets the list of loaded animation groups
  154185. */
  154186. loadedAnimationGroups: Array<AnimationGroup>;
  154187. /**
  154188. * Callback called when the task is successful
  154189. */
  154190. onSuccess: (task: ContainerAssetTask) => void;
  154191. /**
  154192. * Callback called when the task is successful
  154193. */
  154194. onError: (task: ContainerAssetTask, message?: string, exception?: any) => void;
  154195. /**
  154196. * Creates a new ContainerAssetTask
  154197. * @param name defines the name of the task
  154198. * @param meshesNames defines the list of mesh's names you want to load
  154199. * @param rootUrl defines the root url to use as a base to load your meshes and associated resources
  154200. * @param sceneFilename defines the filename or File of the scene to load from
  154201. */
  154202. constructor(
  154203. /**
  154204. * Defines the name of the task
  154205. */
  154206. name: string,
  154207. /**
  154208. * Defines the list of mesh's names you want to load
  154209. */
  154210. meshesNames: any,
  154211. /**
  154212. * Defines the root url to use as a base to load your meshes and associated resources
  154213. */
  154214. rootUrl: string,
  154215. /**
  154216. * Defines the filename or File of the scene to load from
  154217. */
  154218. sceneFilename: string | File);
  154219. /**
  154220. * Execute the current task
  154221. * @param scene defines the scene where you want your assets to be loaded
  154222. * @param onSuccess is a callback called when the task is successfully executed
  154223. * @param onError is a callback called if an error occurs
  154224. */
  154225. runTask(scene: Scene, onSuccess: () => void, onError: (message?: string, exception?: any) => void): void;
  154226. }
  154227. /**
  154228. * Define a task used by AssetsManager to load meshes
  154229. */
  154230. export class MeshAssetTask extends AbstractAssetTask {
  154231. /**
  154232. * Defines the name of the task
  154233. */
  154234. name: string;
  154235. /**
  154236. * Defines the list of mesh's names you want to load
  154237. */
  154238. meshesNames: any;
  154239. /**
  154240. * Defines the root url to use as a base to load your meshes and associated resources
  154241. */
  154242. rootUrl: string;
  154243. /**
  154244. * Defines the filename or File of the scene to load from
  154245. */
  154246. sceneFilename: string | File;
  154247. /**
  154248. * Gets the list of loaded meshes
  154249. */
  154250. loadedMeshes: Array<AbstractMesh>;
  154251. /**
  154252. * Gets the list of loaded particle systems
  154253. */
  154254. loadedParticleSystems: Array<IParticleSystem>;
  154255. /**
  154256. * Gets the list of loaded skeletons
  154257. */
  154258. loadedSkeletons: Array<Skeleton>;
  154259. /**
  154260. * Gets the list of loaded animation groups
  154261. */
  154262. loadedAnimationGroups: Array<AnimationGroup>;
  154263. /**
  154264. * Callback called when the task is successful
  154265. */
  154266. onSuccess: (task: MeshAssetTask) => void;
  154267. /**
  154268. * Callback called when the task is successful
  154269. */
  154270. onError: (task: MeshAssetTask, message?: string, exception?: any) => void;
  154271. /**
  154272. * Creates a new MeshAssetTask
  154273. * @param name defines the name of the task
  154274. * @param meshesNames defines the list of mesh's names you want to load
  154275. * @param rootUrl defines the root url to use as a base to load your meshes and associated resources
  154276. * @param sceneFilename defines the filename or File of the scene to load from
  154277. */
  154278. constructor(
  154279. /**
  154280. * Defines the name of the task
  154281. */
  154282. name: string,
  154283. /**
  154284. * Defines the list of mesh's names you want to load
  154285. */
  154286. meshesNames: any,
  154287. /**
  154288. * Defines the root url to use as a base to load your meshes and associated resources
  154289. */
  154290. rootUrl: string,
  154291. /**
  154292. * Defines the filename or File of the scene to load from
  154293. */
  154294. sceneFilename: string | File);
  154295. /**
  154296. * Execute the current task
  154297. * @param scene defines the scene where you want your assets to be loaded
  154298. * @param onSuccess is a callback called when the task is successfully executed
  154299. * @param onError is a callback called if an error occurs
  154300. */
  154301. runTask(scene: Scene, onSuccess: () => void, onError: (message?: string, exception?: any) => void): void;
  154302. }
  154303. /**
  154304. * Define a task used by AssetsManager to load text content
  154305. */
  154306. export class TextFileAssetTask extends AbstractAssetTask {
  154307. /**
  154308. * Defines the name of the task
  154309. */
  154310. name: string;
  154311. /**
  154312. * Defines the location of the file to load
  154313. */
  154314. url: string;
  154315. /**
  154316. * Gets the loaded text string
  154317. */
  154318. text: string;
  154319. /**
  154320. * Callback called when the task is successful
  154321. */
  154322. onSuccess: (task: TextFileAssetTask) => void;
  154323. /**
  154324. * Callback called when the task is successful
  154325. */
  154326. onError: (task: TextFileAssetTask, message?: string, exception?: any) => void;
  154327. /**
  154328. * Creates a new TextFileAssetTask object
  154329. * @param name defines the name of the task
  154330. * @param url defines the location of the file to load
  154331. */
  154332. constructor(
  154333. /**
  154334. * Defines the name of the task
  154335. */
  154336. name: string,
  154337. /**
  154338. * Defines the location of the file to load
  154339. */
  154340. url: string);
  154341. /**
  154342. * Execute the current task
  154343. * @param scene defines the scene where you want your assets to be loaded
  154344. * @param onSuccess is a callback called when the task is successfully executed
  154345. * @param onError is a callback called if an error occurs
  154346. */
  154347. runTask(scene: Scene, onSuccess: () => void, onError: (message?: string, exception?: any) => void): void;
  154348. }
  154349. /**
  154350. * Define a task used by AssetsManager to load binary data
  154351. */
  154352. export class BinaryFileAssetTask extends AbstractAssetTask {
  154353. /**
  154354. * Defines the name of the task
  154355. */
  154356. name: string;
  154357. /**
  154358. * Defines the location of the file to load
  154359. */
  154360. url: string;
  154361. /**
  154362. * Gets the lodaded data (as an array buffer)
  154363. */
  154364. data: ArrayBuffer;
  154365. /**
  154366. * Callback called when the task is successful
  154367. */
  154368. onSuccess: (task: BinaryFileAssetTask) => void;
  154369. /**
  154370. * Callback called when the task is successful
  154371. */
  154372. onError: (task: BinaryFileAssetTask, message?: string, exception?: any) => void;
  154373. /**
  154374. * Creates a new BinaryFileAssetTask object
  154375. * @param name defines the name of the new task
  154376. * @param url defines the location of the file to load
  154377. */
  154378. constructor(
  154379. /**
  154380. * Defines the name of the task
  154381. */
  154382. name: string,
  154383. /**
  154384. * Defines the location of the file to load
  154385. */
  154386. url: string);
  154387. /**
  154388. * Execute the current task
  154389. * @param scene defines the scene where you want your assets to be loaded
  154390. * @param onSuccess is a callback called when the task is successfully executed
  154391. * @param onError is a callback called if an error occurs
  154392. */
  154393. runTask(scene: Scene, onSuccess: () => void, onError: (message?: string, exception?: any) => void): void;
  154394. }
  154395. /**
  154396. * Define a task used by AssetsManager to load images
  154397. */
  154398. export class ImageAssetTask extends AbstractAssetTask {
  154399. /**
  154400. * Defines the name of the task
  154401. */
  154402. name: string;
  154403. /**
  154404. * Defines the location of the image to load
  154405. */
  154406. url: string;
  154407. /**
  154408. * Gets the loaded images
  154409. */
  154410. image: HTMLImageElement;
  154411. /**
  154412. * Callback called when the task is successful
  154413. */
  154414. onSuccess: (task: ImageAssetTask) => void;
  154415. /**
  154416. * Callback called when the task is successful
  154417. */
  154418. onError: (task: ImageAssetTask, message?: string, exception?: any) => void;
  154419. /**
  154420. * Creates a new ImageAssetTask
  154421. * @param name defines the name of the task
  154422. * @param url defines the location of the image to load
  154423. */
  154424. constructor(
  154425. /**
  154426. * Defines the name of the task
  154427. */
  154428. name: string,
  154429. /**
  154430. * Defines the location of the image to load
  154431. */
  154432. url: string);
  154433. /**
  154434. * Execute the current task
  154435. * @param scene defines the scene where you want your assets to be loaded
  154436. * @param onSuccess is a callback called when the task is successfully executed
  154437. * @param onError is a callback called if an error occurs
  154438. */
  154439. runTask(scene: Scene, onSuccess: () => void, onError: (message?: string, exception?: any) => void): void;
  154440. }
  154441. /**
  154442. * Defines the interface used by texture loading tasks
  154443. */
  154444. export interface ITextureAssetTask<TEX extends BaseTexture> {
  154445. /**
  154446. * Gets the loaded texture
  154447. */
  154448. texture: TEX;
  154449. }
  154450. /**
  154451. * Define a task used by AssetsManager to load 2D textures
  154452. */
  154453. export class TextureAssetTask extends AbstractAssetTask implements ITextureAssetTask<Texture> {
  154454. /**
  154455. * Defines the name of the task
  154456. */
  154457. name: string;
  154458. /**
  154459. * Defines the location of the file to load
  154460. */
  154461. url: string;
  154462. /**
  154463. * Defines if mipmap should not be generated (default is false)
  154464. */
  154465. noMipmap?: boolean | undefined;
  154466. /**
  154467. * Defines if texture must be inverted on Y axis (default is true)
  154468. */
  154469. invertY: boolean;
  154470. /**
  154471. * Defines the sampling mode to use (default is Texture.TRILINEAR_SAMPLINGMODE)
  154472. */
  154473. samplingMode: number;
  154474. /**
  154475. * Gets the loaded texture
  154476. */
  154477. texture: Texture;
  154478. /**
  154479. * Callback called when the task is successful
  154480. */
  154481. onSuccess: (task: TextureAssetTask) => void;
  154482. /**
  154483. * Callback called when the task is successful
  154484. */
  154485. onError: (task: TextureAssetTask, message?: string, exception?: any) => void;
  154486. /**
  154487. * Creates a new TextureAssetTask object
  154488. * @param name defines the name of the task
  154489. * @param url defines the location of the file to load
  154490. * @param noMipmap defines if mipmap should not be generated (default is false)
  154491. * @param invertY defines if texture must be inverted on Y axis (default is true)
  154492. * @param samplingMode defines the sampling mode to use (default is Texture.TRILINEAR_SAMPLINGMODE)
  154493. */
  154494. constructor(
  154495. /**
  154496. * Defines the name of the task
  154497. */
  154498. name: string,
  154499. /**
  154500. * Defines the location of the file to load
  154501. */
  154502. url: string,
  154503. /**
  154504. * Defines if mipmap should not be generated (default is false)
  154505. */
  154506. noMipmap?: boolean | undefined,
  154507. /**
  154508. * Defines if texture must be inverted on Y axis (default is true)
  154509. */
  154510. invertY?: boolean,
  154511. /**
  154512. * Defines the sampling mode to use (default is Texture.TRILINEAR_SAMPLINGMODE)
  154513. */
  154514. samplingMode?: number);
  154515. /**
  154516. * Execute the current task
  154517. * @param scene defines the scene where you want your assets to be loaded
  154518. * @param onSuccess is a callback called when the task is successfully executed
  154519. * @param onError is a callback called if an error occurs
  154520. */
  154521. runTask(scene: Scene, onSuccess: () => void, onError: (message?: string, exception?: any) => void): void;
  154522. }
  154523. /**
  154524. * Define a task used by AssetsManager to load cube textures
  154525. */
  154526. export class CubeTextureAssetTask extends AbstractAssetTask implements ITextureAssetTask<CubeTexture> {
  154527. /**
  154528. * Defines the name of the task
  154529. */
  154530. name: string;
  154531. /**
  154532. * Defines the location of the files to load (You have to specify the folder where the files are + filename with no extension)
  154533. */
  154534. url: string;
  154535. /**
  154536. * Defines the extensions to use to load files (["_px", "_py", "_pz", "_nx", "_ny", "_nz"] by default)
  154537. */
  154538. extensions?: string[] | undefined;
  154539. /**
  154540. * Defines if mipmaps should not be generated (default is false)
  154541. */
  154542. noMipmap?: boolean | undefined;
  154543. /**
  154544. * Defines the explicit list of files (undefined by default)
  154545. */
  154546. files?: string[] | undefined;
  154547. /**
  154548. * Gets the loaded texture
  154549. */
  154550. texture: CubeTexture;
  154551. /**
  154552. * Callback called when the task is successful
  154553. */
  154554. onSuccess: (task: CubeTextureAssetTask) => void;
  154555. /**
  154556. * Callback called when the task is successful
  154557. */
  154558. onError: (task: CubeTextureAssetTask, message?: string, exception?: any) => void;
  154559. /**
  154560. * Creates a new CubeTextureAssetTask
  154561. * @param name defines the name of the task
  154562. * @param url defines the location of the files to load (You have to specify the folder where the files are + filename with no extension)
  154563. * @param extensions defines the extensions to use to load files (["_px", "_py", "_pz", "_nx", "_ny", "_nz"] by default)
  154564. * @param noMipmap defines if mipmaps should not be generated (default is false)
  154565. * @param files defines the explicit list of files (undefined by default)
  154566. */
  154567. constructor(
  154568. /**
  154569. * Defines the name of the task
  154570. */
  154571. name: string,
  154572. /**
  154573. * Defines the location of the files to load (You have to specify the folder where the files are + filename with no extension)
  154574. */
  154575. url: string,
  154576. /**
  154577. * Defines the extensions to use to load files (["_px", "_py", "_pz", "_nx", "_ny", "_nz"] by default)
  154578. */
  154579. extensions?: string[] | undefined,
  154580. /**
  154581. * Defines if mipmaps should not be generated (default is false)
  154582. */
  154583. noMipmap?: boolean | undefined,
  154584. /**
  154585. * Defines the explicit list of files (undefined by default)
  154586. */
  154587. files?: string[] | undefined);
  154588. /**
  154589. * Execute the current task
  154590. * @param scene defines the scene where you want your assets to be loaded
  154591. * @param onSuccess is a callback called when the task is successfully executed
  154592. * @param onError is a callback called if an error occurs
  154593. */
  154594. runTask(scene: Scene, onSuccess: () => void, onError: (message?: string, exception?: any) => void): void;
  154595. }
  154596. /**
  154597. * Define a task used by AssetsManager to load HDR cube textures
  154598. */
  154599. export class HDRCubeTextureAssetTask extends AbstractAssetTask implements ITextureAssetTask<HDRCubeTexture> {
  154600. /**
  154601. * Defines the name of the task
  154602. */
  154603. name: string;
  154604. /**
  154605. * Defines the location of the file to load
  154606. */
  154607. url: string;
  154608. /**
  154609. * Defines the desired size (the more it increases the longer the generation will be)
  154610. */
  154611. size: number;
  154612. /**
  154613. * Defines if mipmaps should not be generated (default is false)
  154614. */
  154615. noMipmap: boolean;
  154616. /**
  154617. * Specifies whether you want to extract the polynomial harmonics during the generation process (default is true)
  154618. */
  154619. generateHarmonics: boolean;
  154620. /**
  154621. * 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)
  154622. */
  154623. gammaSpace: boolean;
  154624. /**
  154625. * Internal Use Only
  154626. */
  154627. reserved: boolean;
  154628. /**
  154629. * Gets the loaded texture
  154630. */
  154631. texture: HDRCubeTexture;
  154632. /**
  154633. * Callback called when the task is successful
  154634. */
  154635. onSuccess: (task: HDRCubeTextureAssetTask) => void;
  154636. /**
  154637. * Callback called when the task is successful
  154638. */
  154639. onError: (task: HDRCubeTextureAssetTask, message?: string, exception?: any) => void;
  154640. /**
  154641. * Creates a new HDRCubeTextureAssetTask object
  154642. * @param name defines the name of the task
  154643. * @param url defines the location of the file to load
  154644. * @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.
  154645. * @param noMipmap defines if mipmaps should not be generated (default is false)
  154646. * @param generateHarmonics specifies whether you want to extract the polynomial harmonics during the generation process (default is true)
  154647. * @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)
  154648. * @param reserved Internal use only
  154649. */
  154650. constructor(
  154651. /**
  154652. * Defines the name of the task
  154653. */
  154654. name: string,
  154655. /**
  154656. * Defines the location of the file to load
  154657. */
  154658. url: string,
  154659. /**
  154660. * Defines the desired size (the more it increases the longer the generation will be)
  154661. */
  154662. size: number,
  154663. /**
  154664. * Defines if mipmaps should not be generated (default is false)
  154665. */
  154666. noMipmap?: boolean,
  154667. /**
  154668. * Specifies whether you want to extract the polynomial harmonics during the generation process (default is true)
  154669. */
  154670. generateHarmonics?: boolean,
  154671. /**
  154672. * 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)
  154673. */
  154674. gammaSpace?: boolean,
  154675. /**
  154676. * Internal Use Only
  154677. */
  154678. reserved?: boolean);
  154679. /**
  154680. * Execute the current task
  154681. * @param scene defines the scene where you want your assets to be loaded
  154682. * @param onSuccess is a callback called when the task is successfully executed
  154683. * @param onError is a callback called if an error occurs
  154684. */
  154685. runTask(scene: Scene, onSuccess: () => void, onError: (message?: string, exception?: any) => void): void;
  154686. }
  154687. /**
  154688. * Define a task used by AssetsManager to load Equirectangular cube textures
  154689. */
  154690. export class EquiRectangularCubeTextureAssetTask extends AbstractAssetTask implements ITextureAssetTask<EquiRectangularCubeTexture> {
  154691. /**
  154692. * Defines the name of the task
  154693. */
  154694. name: string;
  154695. /**
  154696. * Defines the location of the file to load
  154697. */
  154698. url: string;
  154699. /**
  154700. * Defines the desired size (the more it increases the longer the generation will be)
  154701. */
  154702. size: number;
  154703. /**
  154704. * Defines if mipmaps should not be generated (default is false)
  154705. */
  154706. noMipmap: boolean;
  154707. /**
  154708. * Specifies if the texture will be use in gamma or linear space (the PBR material requires those texture in linear space,
  154709. * but the standard material would require them in Gamma space) (default is true)
  154710. */
  154711. gammaSpace: boolean;
  154712. /**
  154713. * Gets the loaded texture
  154714. */
  154715. texture: EquiRectangularCubeTexture;
  154716. /**
  154717. * Callback called when the task is successful
  154718. */
  154719. onSuccess: (task: EquiRectangularCubeTextureAssetTask) => void;
  154720. /**
  154721. * Callback called when the task is successful
  154722. */
  154723. onError: (task: EquiRectangularCubeTextureAssetTask, message?: string, exception?: any) => void;
  154724. /**
  154725. * Creates a new EquiRectangularCubeTextureAssetTask object
  154726. * @param name defines the name of the task
  154727. * @param url defines the location of the file to load
  154728. * @param size defines the desired size (the more it increases the longer the generation will be)
  154729. * If the size is omitted this implies you are using a preprocessed cubemap.
  154730. * @param noMipmap defines if mipmaps should not be generated (default is false)
  154731. * @param gammaSpace specifies if the texture will be used in gamma or linear space
  154732. * (the PBR material requires those texture in linear space, but the standard material would require them in Gamma space)
  154733. * (default is true)
  154734. */
  154735. constructor(
  154736. /**
  154737. * Defines the name of the task
  154738. */
  154739. name: string,
  154740. /**
  154741. * Defines the location of the file to load
  154742. */
  154743. url: string,
  154744. /**
  154745. * Defines the desired size (the more it increases the longer the generation will be)
  154746. */
  154747. size: number,
  154748. /**
  154749. * Defines if mipmaps should not be generated (default is false)
  154750. */
  154751. noMipmap?: boolean,
  154752. /**
  154753. * Specifies if the texture will be use in gamma or linear space (the PBR material requires those texture in linear space,
  154754. * but the standard material would require them in Gamma space) (default is true)
  154755. */
  154756. gammaSpace?: boolean);
  154757. /**
  154758. * Execute the current task
  154759. * @param scene defines the scene where you want your assets to be loaded
  154760. * @param onSuccess is a callback called when the task is successfully executed
  154761. * @param onError is a callback called if an error occurs
  154762. */
  154763. runTask(scene: Scene, onSuccess: () => void, onError: (message?: string, exception?: any) => void): void;
  154764. }
  154765. /**
  154766. * This class can be used to easily import assets into a scene
  154767. * @see https://doc.babylonjs.com/how_to/how_to_use_assetsmanager
  154768. */
  154769. export class AssetsManager {
  154770. private _scene;
  154771. private _isLoading;
  154772. protected _tasks: AbstractAssetTask[];
  154773. protected _waitingTasksCount: number;
  154774. protected _totalTasksCount: number;
  154775. /**
  154776. * Callback called when all tasks are processed
  154777. */
  154778. onFinish: (tasks: AbstractAssetTask[]) => void;
  154779. /**
  154780. * Callback called when a task is successful
  154781. */
  154782. onTaskSuccess: (task: AbstractAssetTask) => void;
  154783. /**
  154784. * Callback called when a task had an error
  154785. */
  154786. onTaskError: (task: AbstractAssetTask) => void;
  154787. /**
  154788. * Callback called when a task is done (whatever the result is)
  154789. */
  154790. onProgress: (remainingCount: number, totalCount: number, task: AbstractAssetTask) => void;
  154791. /**
  154792. * Observable called when all tasks are processed
  154793. */
  154794. onTaskSuccessObservable: Observable<AbstractAssetTask>;
  154795. /**
  154796. * Observable called when a task had an error
  154797. */
  154798. onTaskErrorObservable: Observable<AbstractAssetTask>;
  154799. /**
  154800. * Observable called when all tasks were executed
  154801. */
  154802. onTasksDoneObservable: Observable<AbstractAssetTask[]>;
  154803. /**
  154804. * Observable called when a task is done (whatever the result is)
  154805. */
  154806. onProgressObservable: Observable<IAssetsProgressEvent>;
  154807. /**
  154808. * Gets or sets a boolean defining if the AssetsManager should use the default loading screen
  154809. * @see https://doc.babylonjs.com/how_to/creating_a_custom_loading_screen
  154810. */
  154811. useDefaultLoadingScreen: boolean;
  154812. /**
  154813. * Gets or sets a boolean defining if the AssetsManager should automatically hide the loading screen
  154814. * when all assets have been downloaded.
  154815. * If set to false, you need to manually call in hideLoadingUI() once your scene is ready.
  154816. */
  154817. autoHideLoadingUI: boolean;
  154818. /**
  154819. * Creates a new AssetsManager
  154820. * @param scene defines the scene to work on
  154821. */
  154822. constructor(scene: Scene);
  154823. /**
  154824. * Add a ContainerAssetTask to the list of active tasks
  154825. * @param taskName defines the name of the new task
  154826. * @param meshesNames defines the name of meshes to load
  154827. * @param rootUrl defines the root url to use to locate files
  154828. * @param sceneFilename defines the filename of the scene file
  154829. * @returns a new ContainerAssetTask object
  154830. */
  154831. addContainerTask(taskName: string, meshesNames: any, rootUrl: string, sceneFilename: string): ContainerAssetTask;
  154832. /**
  154833. * Add a MeshAssetTask to the list of active tasks
  154834. * @param taskName defines the name of the new task
  154835. * @param meshesNames defines the name of meshes to load
  154836. * @param rootUrl defines the root url to use to locate files
  154837. * @param sceneFilename defines the filename of the scene file
  154838. * @returns a new MeshAssetTask object
  154839. */
  154840. addMeshTask(taskName: string, meshesNames: any, rootUrl: string, sceneFilename: string): MeshAssetTask;
  154841. /**
  154842. * Add a TextFileAssetTask to the list of active tasks
  154843. * @param taskName defines the name of the new task
  154844. * @param url defines the url of the file to load
  154845. * @returns a new TextFileAssetTask object
  154846. */
  154847. addTextFileTask(taskName: string, url: string): TextFileAssetTask;
  154848. /**
  154849. * Add a BinaryFileAssetTask to the list of active tasks
  154850. * @param taskName defines the name of the new task
  154851. * @param url defines the url of the file to load
  154852. * @returns a new BinaryFileAssetTask object
  154853. */
  154854. addBinaryFileTask(taskName: string, url: string): BinaryFileAssetTask;
  154855. /**
  154856. * Add a ImageAssetTask to the list of active tasks
  154857. * @param taskName defines the name of the new task
  154858. * @param url defines the url of the file to load
  154859. * @returns a new ImageAssetTask object
  154860. */
  154861. addImageTask(taskName: string, url: string): ImageAssetTask;
  154862. /**
  154863. * Add a TextureAssetTask to the list of active tasks
  154864. * @param taskName defines the name of the new task
  154865. * @param url defines the url of the file to load
  154866. * @param noMipmap defines if the texture must not receive mipmaps (false by default)
  154867. * @param invertY defines if you want to invert Y axis of the loaded texture (false by default)
  154868. * @param samplingMode defines the sampling mode to use (Texture.TRILINEAR_SAMPLINGMODE by default)
  154869. * @returns a new TextureAssetTask object
  154870. */
  154871. addTextureTask(taskName: string, url: string, noMipmap?: boolean, invertY?: boolean, samplingMode?: number): TextureAssetTask;
  154872. /**
  154873. * Add a CubeTextureAssetTask to the list of active tasks
  154874. * @param taskName defines the name of the new task
  154875. * @param url defines the url of the file to load
  154876. * @param extensions defines the extension to use to load the cube map (can be null)
  154877. * @param noMipmap defines if the texture must not receive mipmaps (false by default)
  154878. * @param files defines the list of files to load (can be null)
  154879. * @returns a new CubeTextureAssetTask object
  154880. */
  154881. addCubeTextureTask(taskName: string, url: string, extensions?: string[], noMipmap?: boolean, files?: string[]): CubeTextureAssetTask;
  154882. /**
  154883. *
  154884. * Add a HDRCubeTextureAssetTask to the list of active tasks
  154885. * @param taskName defines the name of the new task
  154886. * @param url defines the url of the file to load
  154887. * @param size defines the size you want for the cubemap (can be null)
  154888. * @param noMipmap defines if the texture must not receive mipmaps (false by default)
  154889. * @param generateHarmonics defines if you want to automatically generate (true by default)
  154890. * @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)
  154891. * @param reserved Internal use only
  154892. * @returns a new HDRCubeTextureAssetTask object
  154893. */
  154894. addHDRCubeTextureTask(taskName: string, url: string, size: number, noMipmap?: boolean, generateHarmonics?: boolean, gammaSpace?: boolean, reserved?: boolean): HDRCubeTextureAssetTask;
  154895. /**
  154896. *
  154897. * Add a EquiRectangularCubeTextureAssetTask to the list of active tasks
  154898. * @param taskName defines the name of the new task
  154899. * @param url defines the url of the file to load
  154900. * @param size defines the size you want for the cubemap (can be null)
  154901. * @param noMipmap defines if the texture must not receive mipmaps (false by default)
  154902. * @param gammaSpace Specifies if the texture will be used in gamma or linear space
  154903. * (the PBR material requires those textures in linear space, but the standard material would require them in Gamma space)
  154904. * @returns a new EquiRectangularCubeTextureAssetTask object
  154905. */
  154906. addEquiRectangularCubeTextureAssetTask(taskName: string, url: string, size: number, noMipmap?: boolean, gammaSpace?: boolean): EquiRectangularCubeTextureAssetTask;
  154907. /**
  154908. * Remove a task from the assets manager.
  154909. * @param task the task to remove
  154910. */
  154911. removeTask(task: AbstractAssetTask): void;
  154912. private _decreaseWaitingTasksCount;
  154913. private _runTask;
  154914. /**
  154915. * Reset the AssetsManager and remove all tasks
  154916. * @return the current instance of the AssetsManager
  154917. */
  154918. reset(): AssetsManager;
  154919. /**
  154920. * Start the loading process
  154921. * @return the current instance of the AssetsManager
  154922. */
  154923. load(): AssetsManager;
  154924. /**
  154925. * Start the loading process as an async operation
  154926. * @return a promise returning the list of failed tasks
  154927. */
  154928. loadAsync(): Promise<void>;
  154929. }
  154930. }
  154931. declare module BABYLON {
  154932. /**
  154933. * Wrapper class for promise with external resolve and reject.
  154934. */
  154935. export class Deferred<T> {
  154936. /**
  154937. * The promise associated with this deferred object.
  154938. */
  154939. readonly promise: Promise<T>;
  154940. private _resolve;
  154941. private _reject;
  154942. /**
  154943. * The resolve method of the promise associated with this deferred object.
  154944. */
  154945. get resolve(): (value?: T | PromiseLike<T> | undefined) => void;
  154946. /**
  154947. * The reject method of the promise associated with this deferred object.
  154948. */
  154949. get reject(): (reason?: any) => void;
  154950. /**
  154951. * Constructor for this deferred object.
  154952. */
  154953. constructor();
  154954. }
  154955. }
  154956. declare module BABYLON {
  154957. /**
  154958. * Class used to explode meshes (ie. to have a center and move them away from that center to better see the overall organization)
  154959. */
  154960. export class MeshExploder {
  154961. private _centerMesh;
  154962. private _meshes;
  154963. private _meshesOrigins;
  154964. private _toCenterVectors;
  154965. private _scaledDirection;
  154966. private _newPosition;
  154967. private _centerPosition;
  154968. /**
  154969. * Explodes meshes from a center mesh.
  154970. * @param meshes The meshes to explode.
  154971. * @param centerMesh The mesh to be center of explosion.
  154972. */
  154973. constructor(meshes: Array<Mesh>, centerMesh?: Mesh);
  154974. private _setCenterMesh;
  154975. /**
  154976. * Get class name
  154977. * @returns "MeshExploder"
  154978. */
  154979. getClassName(): string;
  154980. /**
  154981. * "Exploded meshes"
  154982. * @returns Array of meshes with the centerMesh at index 0.
  154983. */
  154984. getMeshes(): Array<Mesh>;
  154985. /**
  154986. * Explodes meshes giving a specific direction
  154987. * @param direction Number to multiply distance of each mesh's origin from center. Use a negative number to implode, or zero to reset.
  154988. */
  154989. explode(direction?: number): void;
  154990. }
  154991. }
  154992. declare module BABYLON {
  154993. /**
  154994. * Class used to help managing file picking and drag'n'drop
  154995. */
  154996. export class FilesInput {
  154997. /**
  154998. * List of files ready to be loaded
  154999. */
  155000. static get FilesToLoad(): {
  155001. [key: string]: File;
  155002. };
  155003. /**
  155004. * Callback called when a file is processed
  155005. */
  155006. onProcessFileCallback: (file: File, name: string, extension: string) => boolean;
  155007. private _engine;
  155008. private _currentScene;
  155009. private _sceneLoadedCallback;
  155010. private _progressCallback;
  155011. private _additionalRenderLoopLogicCallback;
  155012. private _textureLoadingCallback;
  155013. private _startingProcessingFilesCallback;
  155014. private _onReloadCallback;
  155015. private _errorCallback;
  155016. private _elementToMonitor;
  155017. private _sceneFileToLoad;
  155018. private _filesToLoad;
  155019. /**
  155020. * Creates a new FilesInput
  155021. * @param engine defines the rendering engine
  155022. * @param scene defines the hosting scene
  155023. * @param sceneLoadedCallback callback called when scene is loaded
  155024. * @param progressCallback callback called to track progress
  155025. * @param additionalRenderLoopLogicCallback callback called to add user logic to the rendering loop
  155026. * @param textureLoadingCallback callback called when a texture is loading
  155027. * @param startingProcessingFilesCallback callback called when the system is about to process all files
  155028. * @param onReloadCallback callback called when a reload is requested
  155029. * @param errorCallback callback call if an error occurs
  155030. */
  155031. 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>);
  155032. private _dragEnterHandler;
  155033. private _dragOverHandler;
  155034. private _dropHandler;
  155035. /**
  155036. * Calls this function to listen to drag'n'drop events on a specific DOM element
  155037. * @param elementToMonitor defines the DOM element to track
  155038. */
  155039. monitorElementForDragNDrop(elementToMonitor: HTMLElement): void;
  155040. /** Gets the current list of files to load */
  155041. get filesToLoad(): File[];
  155042. /**
  155043. * Release all associated resources
  155044. */
  155045. dispose(): void;
  155046. private renderFunction;
  155047. private drag;
  155048. private drop;
  155049. private _traverseFolder;
  155050. private _processFiles;
  155051. /**
  155052. * Load files from a drop event
  155053. * @param event defines the drop event to use as source
  155054. */
  155055. loadFiles(event: any): void;
  155056. private _processReload;
  155057. /**
  155058. * Reload the current scene from the loaded files
  155059. */
  155060. reload(): void;
  155061. }
  155062. }
  155063. declare module BABYLON {
  155064. /**
  155065. * Defines the root class used to create scene optimization to use with SceneOptimizer
  155066. * @description More details at https://doc.babylonjs.com/how_to/how_to_use_sceneoptimizer
  155067. */
  155068. export class SceneOptimization {
  155069. /**
  155070. * Defines the priority of this optimization (0 by default which means first in the list)
  155071. */
  155072. priority: number;
  155073. /**
  155074. * Gets a string describing the action executed by the current optimization
  155075. * @returns description string
  155076. */
  155077. getDescription(): string;
  155078. /**
  155079. * This function will be called by the SceneOptimizer when its priority is reached in order to apply the change required by the current optimization
  155080. * @param scene defines the current scene where to apply this optimization
  155081. * @param optimizer defines the current optimizer
  155082. * @returns true if everything that can be done was applied
  155083. */
  155084. apply(scene: Scene, optimizer: SceneOptimizer): boolean;
  155085. /**
  155086. * Creates the SceneOptimization object
  155087. * @param priority defines the priority of this optimization (0 by default which means first in the list)
  155088. * @param desc defines the description associated with the optimization
  155089. */
  155090. constructor(
  155091. /**
  155092. * Defines the priority of this optimization (0 by default which means first in the list)
  155093. */
  155094. priority?: number);
  155095. }
  155096. /**
  155097. * Defines an optimization used to reduce the size of render target textures
  155098. * @description More details at https://doc.babylonjs.com/how_to/how_to_use_sceneoptimizer
  155099. */
  155100. export class TextureOptimization extends SceneOptimization {
  155101. /**
  155102. * Defines the priority of this optimization (0 by default which means first in the list)
  155103. */
  155104. priority: number;
  155105. /**
  155106. * 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
  155107. */
  155108. maximumSize: number;
  155109. /**
  155110. * Defines the factor (0.5 by default) used to scale down textures bigger than maximum sized allowed.
  155111. */
  155112. step: number;
  155113. /**
  155114. * Gets a string describing the action executed by the current optimization
  155115. * @returns description string
  155116. */
  155117. getDescription(): string;
  155118. /**
  155119. * Creates the TextureOptimization object
  155120. * @param priority defines the priority of this optimization (0 by default which means first in the list)
  155121. * @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
  155122. * @param step defines the factor (0.5 by default) used to scale down textures bigger than maximum sized allowed.
  155123. */
  155124. constructor(
  155125. /**
  155126. * Defines the priority of this optimization (0 by default which means first in the list)
  155127. */
  155128. priority?: number,
  155129. /**
  155130. * 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
  155131. */
  155132. maximumSize?: number,
  155133. /**
  155134. * Defines the factor (0.5 by default) used to scale down textures bigger than maximum sized allowed.
  155135. */
  155136. step?: number);
  155137. /**
  155138. * This function will be called by the SceneOptimizer when its priority is reached in order to apply the change required by the current optimization
  155139. * @param scene defines the current scene where to apply this optimization
  155140. * @param optimizer defines the current optimizer
  155141. * @returns true if everything that can be done was applied
  155142. */
  155143. apply(scene: Scene, optimizer: SceneOptimizer): boolean;
  155144. }
  155145. /**
  155146. * Defines an optimization used to increase or decrease the rendering resolution
  155147. * @description More details at https://doc.babylonjs.com/how_to/how_to_use_sceneoptimizer
  155148. */
  155149. export class HardwareScalingOptimization extends SceneOptimization {
  155150. /**
  155151. * Defines the priority of this optimization (0 by default which means first in the list)
  155152. */
  155153. priority: number;
  155154. /**
  155155. * Defines the maximum scale to use (2 by default)
  155156. */
  155157. maximumScale: number;
  155158. /**
  155159. * Defines the step to use between two passes (0.5 by default)
  155160. */
  155161. step: number;
  155162. private _currentScale;
  155163. private _directionOffset;
  155164. /**
  155165. * Gets a string describing the action executed by the current optimization
  155166. * @return description string
  155167. */
  155168. getDescription(): string;
  155169. /**
  155170. * Creates the HardwareScalingOptimization object
  155171. * @param priority defines the priority of this optimization (0 by default which means first in the list)
  155172. * @param maximumScale defines the maximum scale to use (2 by default)
  155173. * @param step defines the step to use between two passes (0.5 by default)
  155174. */
  155175. constructor(
  155176. /**
  155177. * Defines the priority of this optimization (0 by default which means first in the list)
  155178. */
  155179. priority?: number,
  155180. /**
  155181. * Defines the maximum scale to use (2 by default)
  155182. */
  155183. maximumScale?: number,
  155184. /**
  155185. * Defines the step to use between two passes (0.5 by default)
  155186. */
  155187. step?: number);
  155188. /**
  155189. * This function will be called by the SceneOptimizer when its priority is reached in order to apply the change required by the current optimization
  155190. * @param scene defines the current scene where to apply this optimization
  155191. * @param optimizer defines the current optimizer
  155192. * @returns true if everything that can be done was applied
  155193. */
  155194. apply(scene: Scene, optimizer: SceneOptimizer): boolean;
  155195. }
  155196. /**
  155197. * Defines an optimization used to remove shadows
  155198. * @description More details at https://doc.babylonjs.com/how_to/how_to_use_sceneoptimizer
  155199. */
  155200. export class ShadowsOptimization extends SceneOptimization {
  155201. /**
  155202. * Gets a string describing the action executed by the current optimization
  155203. * @return description string
  155204. */
  155205. getDescription(): string;
  155206. /**
  155207. * This function will be called by the SceneOptimizer when its priority is reached in order to apply the change required by the current optimization
  155208. * @param scene defines the current scene where to apply this optimization
  155209. * @param optimizer defines the current optimizer
  155210. * @returns true if everything that can be done was applied
  155211. */
  155212. apply(scene: Scene, optimizer: SceneOptimizer): boolean;
  155213. }
  155214. /**
  155215. * Defines an optimization used to turn post-processes off
  155216. * @description More details at https://doc.babylonjs.com/how_to/how_to_use_sceneoptimizer
  155217. */
  155218. export class PostProcessesOptimization extends SceneOptimization {
  155219. /**
  155220. * Gets a string describing the action executed by the current optimization
  155221. * @return description string
  155222. */
  155223. getDescription(): string;
  155224. /**
  155225. * This function will be called by the SceneOptimizer when its priority is reached in order to apply the change required by the current optimization
  155226. * @param scene defines the current scene where to apply this optimization
  155227. * @param optimizer defines the current optimizer
  155228. * @returns true if everything that can be done was applied
  155229. */
  155230. apply(scene: Scene, optimizer: SceneOptimizer): boolean;
  155231. }
  155232. /**
  155233. * Defines an optimization used to turn lens flares off
  155234. * @description More details at https://doc.babylonjs.com/how_to/how_to_use_sceneoptimizer
  155235. */
  155236. export class LensFlaresOptimization extends SceneOptimization {
  155237. /**
  155238. * Gets a string describing the action executed by the current optimization
  155239. * @return description string
  155240. */
  155241. getDescription(): string;
  155242. /**
  155243. * This function will be called by the SceneOptimizer when its priority is reached in order to apply the change required by the current optimization
  155244. * @param scene defines the current scene where to apply this optimization
  155245. * @param optimizer defines the current optimizer
  155246. * @returns true if everything that can be done was applied
  155247. */
  155248. apply(scene: Scene, optimizer: SceneOptimizer): boolean;
  155249. }
  155250. /**
  155251. * Defines an optimization based on user defined callback.
  155252. * @description More details at https://doc.babylonjs.com/how_to/how_to_use_sceneoptimizer
  155253. */
  155254. export class CustomOptimization extends SceneOptimization {
  155255. /**
  155256. * Callback called to apply the custom optimization.
  155257. */
  155258. onApply: (scene: Scene, optimizer: SceneOptimizer) => boolean;
  155259. /**
  155260. * Callback called to get custom description
  155261. */
  155262. onGetDescription: () => string;
  155263. /**
  155264. * Gets a string describing the action executed by the current optimization
  155265. * @returns description string
  155266. */
  155267. getDescription(): string;
  155268. /**
  155269. * This function will be called by the SceneOptimizer when its priority is reached in order to apply the change required by the current optimization
  155270. * @param scene defines the current scene where to apply this optimization
  155271. * @param optimizer defines the current optimizer
  155272. * @returns true if everything that can be done was applied
  155273. */
  155274. apply(scene: Scene, optimizer: SceneOptimizer): boolean;
  155275. }
  155276. /**
  155277. * Defines an optimization used to turn particles off
  155278. * @description More details at https://doc.babylonjs.com/how_to/how_to_use_sceneoptimizer
  155279. */
  155280. export class ParticlesOptimization extends SceneOptimization {
  155281. /**
  155282. * Gets a string describing the action executed by the current optimization
  155283. * @return description string
  155284. */
  155285. getDescription(): string;
  155286. /**
  155287. * This function will be called by the SceneOptimizer when its priority is reached in order to apply the change required by the current optimization
  155288. * @param scene defines the current scene where to apply this optimization
  155289. * @param optimizer defines the current optimizer
  155290. * @returns true if everything that can be done was applied
  155291. */
  155292. apply(scene: Scene, optimizer: SceneOptimizer): boolean;
  155293. }
  155294. /**
  155295. * Defines an optimization used to turn render targets off
  155296. * @description More details at https://doc.babylonjs.com/how_to/how_to_use_sceneoptimizer
  155297. */
  155298. export class RenderTargetsOptimization extends SceneOptimization {
  155299. /**
  155300. * Gets a string describing the action executed by the current optimization
  155301. * @return description string
  155302. */
  155303. getDescription(): string;
  155304. /**
  155305. * This function will be called by the SceneOptimizer when its priority is reached in order to apply the change required by the current optimization
  155306. * @param scene defines the current scene where to apply this optimization
  155307. * @param optimizer defines the current optimizer
  155308. * @returns true if everything that can be done was applied
  155309. */
  155310. apply(scene: Scene, optimizer: SceneOptimizer): boolean;
  155311. }
  155312. /**
  155313. * Defines an optimization used to merge meshes with compatible materials
  155314. * @description More details at https://doc.babylonjs.com/how_to/how_to_use_sceneoptimizer
  155315. */
  155316. export class MergeMeshesOptimization extends SceneOptimization {
  155317. private static _UpdateSelectionTree;
  155318. /**
  155319. * Gets or sets a boolean which defines if optimization octree has to be updated
  155320. */
  155321. static get UpdateSelectionTree(): boolean;
  155322. /**
  155323. * Gets or sets a boolean which defines if optimization octree has to be updated
  155324. */
  155325. static set UpdateSelectionTree(value: boolean);
  155326. /**
  155327. * Gets a string describing the action executed by the current optimization
  155328. * @return description string
  155329. */
  155330. getDescription(): string;
  155331. private _canBeMerged;
  155332. /**
  155333. * This function will be called by the SceneOptimizer when its priority is reached in order to apply the change required by the current optimization
  155334. * @param scene defines the current scene where to apply this optimization
  155335. * @param optimizer defines the current optimizer
  155336. * @param updateSelectionTree defines that the selection octree has to be updated (false by default)
  155337. * @returns true if everything that can be done was applied
  155338. */
  155339. apply(scene: Scene, optimizer: SceneOptimizer, updateSelectionTree?: boolean): boolean;
  155340. }
  155341. /**
  155342. * Defines a list of options used by SceneOptimizer
  155343. * @description More details at https://doc.babylonjs.com/how_to/how_to_use_sceneoptimizer
  155344. */
  155345. export class SceneOptimizerOptions {
  155346. /**
  155347. * Defines the target frame rate to reach (60 by default)
  155348. */
  155349. targetFrameRate: number;
  155350. /**
  155351. * Defines the interval between two checkes (2000ms by default)
  155352. */
  155353. trackerDuration: number;
  155354. /**
  155355. * Gets the list of optimizations to apply
  155356. */
  155357. optimizations: SceneOptimization[];
  155358. /**
  155359. * Creates a new list of options used by SceneOptimizer
  155360. * @param targetFrameRate defines the target frame rate to reach (60 by default)
  155361. * @param trackerDuration defines the interval between two checkes (2000ms by default)
  155362. */
  155363. constructor(
  155364. /**
  155365. * Defines the target frame rate to reach (60 by default)
  155366. */
  155367. targetFrameRate?: number,
  155368. /**
  155369. * Defines the interval between two checkes (2000ms by default)
  155370. */
  155371. trackerDuration?: number);
  155372. /**
  155373. * Add a new optimization
  155374. * @param optimization defines the SceneOptimization to add to the list of active optimizations
  155375. * @returns the current SceneOptimizerOptions
  155376. */
  155377. addOptimization(optimization: SceneOptimization): SceneOptimizerOptions;
  155378. /**
  155379. * Add a new custom optimization
  155380. * @param onApply defines the callback called to apply the custom optimization (true if everything that can be done was applied)
  155381. * @param onGetDescription defines the callback called to get the description attached with the optimization.
  155382. * @param priority defines the priority of this optimization (0 by default which means first in the list)
  155383. * @returns the current SceneOptimizerOptions
  155384. */
  155385. addCustomOptimization(onApply: (scene: Scene) => boolean, onGetDescription: () => string, priority?: number): SceneOptimizerOptions;
  155386. /**
  155387. * Creates a list of pre-defined optimizations aimed to reduce the visual impact on the scene
  155388. * @param targetFrameRate defines the target frame rate (60 by default)
  155389. * @returns a SceneOptimizerOptions object
  155390. */
  155391. static LowDegradationAllowed(targetFrameRate?: number): SceneOptimizerOptions;
  155392. /**
  155393. * Creates a list of pre-defined optimizations aimed to have a moderate impact on the scene visual
  155394. * @param targetFrameRate defines the target frame rate (60 by default)
  155395. * @returns a SceneOptimizerOptions object
  155396. */
  155397. static ModerateDegradationAllowed(targetFrameRate?: number): SceneOptimizerOptions;
  155398. /**
  155399. * Creates a list of pre-defined optimizations aimed to have a big impact on the scene visual
  155400. * @param targetFrameRate defines the target frame rate (60 by default)
  155401. * @returns a SceneOptimizerOptions object
  155402. */
  155403. static HighDegradationAllowed(targetFrameRate?: number): SceneOptimizerOptions;
  155404. }
  155405. /**
  155406. * Class used to run optimizations in order to reach a target frame rate
  155407. * @description More details at https://doc.babylonjs.com/how_to/how_to_use_sceneoptimizer
  155408. */
  155409. export class SceneOptimizer implements IDisposable {
  155410. private _isRunning;
  155411. private _options;
  155412. private _scene;
  155413. private _currentPriorityLevel;
  155414. private _targetFrameRate;
  155415. private _trackerDuration;
  155416. private _currentFrameRate;
  155417. private _sceneDisposeObserver;
  155418. private _improvementMode;
  155419. /**
  155420. * Defines an observable called when the optimizer reaches the target frame rate
  155421. */
  155422. onSuccessObservable: Observable<SceneOptimizer>;
  155423. /**
  155424. * Defines an observable called when the optimizer enables an optimization
  155425. */
  155426. onNewOptimizationAppliedObservable: Observable<SceneOptimization>;
  155427. /**
  155428. * Defines an observable called when the optimizer is not able to reach the target frame rate
  155429. */
  155430. onFailureObservable: Observable<SceneOptimizer>;
  155431. /**
  155432. * Gets a boolean indicating if the optimizer is in improvement mode
  155433. */
  155434. get isInImprovementMode(): boolean;
  155435. /**
  155436. * Gets the current priority level (0 at start)
  155437. */
  155438. get currentPriorityLevel(): number;
  155439. /**
  155440. * Gets the current frame rate checked by the SceneOptimizer
  155441. */
  155442. get currentFrameRate(): number;
  155443. /**
  155444. * Gets or sets the current target frame rate (60 by default)
  155445. */
  155446. get targetFrameRate(): number;
  155447. /**
  155448. * Gets or sets the current target frame rate (60 by default)
  155449. */
  155450. set targetFrameRate(value: number);
  155451. /**
  155452. * Gets or sets the current interval between two checks (every 2000ms by default)
  155453. */
  155454. get trackerDuration(): number;
  155455. /**
  155456. * Gets or sets the current interval between two checks (every 2000ms by default)
  155457. */
  155458. set trackerDuration(value: number);
  155459. /**
  155460. * Gets the list of active optimizations
  155461. */
  155462. get optimizations(): SceneOptimization[];
  155463. /**
  155464. * Creates a new SceneOptimizer
  155465. * @param scene defines the scene to work on
  155466. * @param options defines the options to use with the SceneOptimizer
  155467. * @param autoGeneratePriorities defines if priorities must be generated and not read from SceneOptimization property (true by default)
  155468. * @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)
  155469. */
  155470. constructor(scene: Scene, options?: SceneOptimizerOptions, autoGeneratePriorities?: boolean, improvementMode?: boolean);
  155471. /**
  155472. * Stops the current optimizer
  155473. */
  155474. stop(): void;
  155475. /**
  155476. * Reset the optimizer to initial step (current priority level = 0)
  155477. */
  155478. reset(): void;
  155479. /**
  155480. * Start the optimizer. By default it will try to reach a specific framerate
  155481. * but if the optimizer is set with improvementMode === true then it will run all optimiatiation while frame rate is above the target frame rate
  155482. */
  155483. start(): void;
  155484. private _checkCurrentState;
  155485. /**
  155486. * Release all resources
  155487. */
  155488. dispose(): void;
  155489. /**
  155490. * Helper function to create a SceneOptimizer with one single line of code
  155491. * @param scene defines the scene to work on
  155492. * @param options defines the options to use with the SceneOptimizer
  155493. * @param onSuccess defines a callback to call on success
  155494. * @param onFailure defines a callback to call on failure
  155495. * @returns the new SceneOptimizer object
  155496. */
  155497. static OptimizeAsync(scene: Scene, options?: SceneOptimizerOptions, onSuccess?: () => void, onFailure?: () => void): SceneOptimizer;
  155498. }
  155499. }
  155500. declare module BABYLON {
  155501. /**
  155502. * Class used to serialize a scene into a string
  155503. */
  155504. export class SceneSerializer {
  155505. /**
  155506. * Clear cache used by a previous serialization
  155507. */
  155508. static ClearCache(): void;
  155509. /**
  155510. * Serialize a scene into a JSON compatible object
  155511. * @param scene defines the scene to serialize
  155512. * @returns a JSON compatible object
  155513. */
  155514. static Serialize(scene: Scene): any;
  155515. /**
  155516. * Serialize a mesh into a JSON compatible object
  155517. * @param toSerialize defines the mesh to serialize
  155518. * @param withParents defines if parents must be serialized as well
  155519. * @param withChildren defines if children must be serialized as well
  155520. * @returns a JSON compatible object
  155521. */
  155522. static SerializeMesh(toSerialize: any, withParents?: boolean, withChildren?: boolean): any;
  155523. }
  155524. }
  155525. declare module BABYLON {
  155526. /**
  155527. * Class used to host texture specific utilities
  155528. */
  155529. export class TextureTools {
  155530. /**
  155531. * Uses the GPU to create a copy texture rescaled at a given size
  155532. * @param texture Texture to copy from
  155533. * @param width defines the desired width
  155534. * @param height defines the desired height
  155535. * @param useBilinearMode defines if bilinear mode has to be used
  155536. * @return the generated texture
  155537. */
  155538. static CreateResizedCopy(texture: Texture, width: number, height: number, useBilinearMode?: boolean): Texture;
  155539. }
  155540. }
  155541. declare module BABYLON {
  155542. /**
  155543. * This represents the different options available for the video capture.
  155544. */
  155545. export interface VideoRecorderOptions {
  155546. /** Defines the mime type of the video. */
  155547. mimeType: string;
  155548. /** Defines the FPS the video should be recorded at. */
  155549. fps: number;
  155550. /** Defines the chunk size for the recording data. */
  155551. recordChunckSize: number;
  155552. /** The audio tracks to attach to the recording. */
  155553. audioTracks?: MediaStreamTrack[];
  155554. }
  155555. /**
  155556. * This can help with recording videos from BabylonJS.
  155557. * This is based on the available WebRTC functionalities of the browser.
  155558. *
  155559. * @see https://doc.babylonjs.com/how_to/render_scene_on_a_video
  155560. */
  155561. export class VideoRecorder {
  155562. private static readonly _defaultOptions;
  155563. /**
  155564. * Returns whether or not the VideoRecorder is available in your browser.
  155565. * @param engine Defines the Babylon Engine.
  155566. * @returns true if supported otherwise false.
  155567. */
  155568. static IsSupported(engine: Engine): boolean;
  155569. private readonly _options;
  155570. private _canvas;
  155571. private _mediaRecorder;
  155572. private _recordedChunks;
  155573. private _fileName;
  155574. private _resolve;
  155575. private _reject;
  155576. /**
  155577. * True when a recording is already in progress.
  155578. */
  155579. get isRecording(): boolean;
  155580. /**
  155581. * Create a new VideoCapture object which can help converting what you see in Babylon to a video file.
  155582. * @param engine Defines the BabylonJS Engine you wish to record.
  155583. * @param options Defines options that can be used to customize the capture.
  155584. */
  155585. constructor(engine: Engine, options?: Nullable<VideoRecorderOptions>);
  155586. /**
  155587. * Stops the current recording before the default capture timeout passed in the startRecording function.
  155588. */
  155589. stopRecording(): void;
  155590. /**
  155591. * Starts recording the canvas for a max duration specified in parameters.
  155592. * @param fileName Defines the name of the file to be downloaded when the recording stop.
  155593. * If null no automatic download will start and you can rely on the promise to get the data back.
  155594. * @param maxDuration Defines the maximum recording time in seconds.
  155595. * It defaults to 7 seconds. A value of zero will not stop automatically, you would need to call stopRecording manually.
  155596. * @return A promise callback at the end of the recording with the video data in Blob.
  155597. */
  155598. startRecording(fileName?: Nullable<string>, maxDuration?: number): Promise<Blob>;
  155599. /**
  155600. * Releases internal resources used during the recording.
  155601. */
  155602. dispose(): void;
  155603. private _handleDataAvailable;
  155604. private _handleError;
  155605. private _handleStop;
  155606. }
  155607. }
  155608. declare module BABYLON {
  155609. /**
  155610. * Class containing a set of static utilities functions for screenshots
  155611. */
  155612. export class ScreenshotTools {
  155613. /**
  155614. * Captures a screenshot of the current rendering
  155615. * @see https://doc.babylonjs.com/how_to/render_scene_on_a_png
  155616. * @param engine defines the rendering engine
  155617. * @param camera defines the source camera
  155618. * @param size This parameter can be set to a single number or to an object with the
  155619. * following (optional) properties: precision, width, height. If a single number is passed,
  155620. * it will be used for both width and height. If an object is passed, the screenshot size
  155621. * will be derived from the parameters. The precision property is a multiplier allowing
  155622. * rendering at a higher or lower resolution
  155623. * @param successCallback defines the callback receives a single parameter which contains the
  155624. * screenshot as a string of base64-encoded characters. This string can be assigned to the
  155625. * src parameter of an <img> to display it
  155626. * @param mimeType defines the MIME type of the screenshot image (default: image/png).
  155627. * Check your browser for supported MIME types
  155628. */
  155629. static CreateScreenshot(engine: Engine, camera: Camera, size: IScreenshotSize | number, successCallback?: (data: string) => void, mimeType?: string): void;
  155630. /**
  155631. * Captures a screenshot of the current rendering
  155632. * @see https://doc.babylonjs.com/how_to/render_scene_on_a_png
  155633. * @param engine defines the rendering engine
  155634. * @param camera defines the source camera
  155635. * @param size This parameter can be set to a single number or to an object with the
  155636. * following (optional) properties: precision, width, height. If a single number is passed,
  155637. * it will be used for both width and height. If an object is passed, the screenshot size
  155638. * will be derived from the parameters. The precision property is a multiplier allowing
  155639. * rendering at a higher or lower resolution
  155640. * @param mimeType defines the MIME type of the screenshot image (default: image/png).
  155641. * Check your browser for supported MIME types
  155642. * @returns screenshot as a string of base64-encoded characters. This string can be assigned
  155643. * to the src parameter of an <img> to display it
  155644. */
  155645. static CreateScreenshotAsync(engine: Engine, camera: Camera, size: any, mimeType?: string): Promise<string>;
  155646. /**
  155647. * Generates an image screenshot from the specified camera.
  155648. * @see https://doc.babylonjs.com/how_to/render_scene_on_a_png
  155649. * @param engine The engine to use for rendering
  155650. * @param camera The camera to use for rendering
  155651. * @param size This parameter can be set to a single number or to an object with the
  155652. * following (optional) properties: precision, width, height. If a single number is passed,
  155653. * it will be used for both width and height. If an object is passed, the screenshot size
  155654. * will be derived from the parameters. The precision property is a multiplier allowing
  155655. * rendering at a higher or lower resolution
  155656. * @param successCallback The callback receives a single parameter which contains the
  155657. * screenshot as a string of base64-encoded characters. This string can be assigned to the
  155658. * src parameter of an <img> to display it
  155659. * @param mimeType The MIME type of the screenshot image (default: image/png).
  155660. * Check your browser for supported MIME types
  155661. * @param samples Texture samples (default: 1)
  155662. * @param antialiasing Whether antialiasing should be turned on or not (default: false)
  155663. * @param fileName A name for for the downloaded file.
  155664. * @param renderSprites Whether the sprites should be rendered or not (default: false)
  155665. * @param enableStencilBuffer Whether the stencil buffer should be enabled or not (default: false)
  155666. */
  155667. 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;
  155668. /**
  155669. * Generates an image screenshot from the specified camera.
  155670. * @see https://doc.babylonjs.com/how_to/render_scene_on_a_png
  155671. * @param engine The engine to use for rendering
  155672. * @param camera The camera to use for rendering
  155673. * @param size This parameter can be set to a single number or to an object with the
  155674. * following (optional) properties: precision, width, height. If a single number is passed,
  155675. * it will be used for both width and height. If an object is passed, the screenshot size
  155676. * will be derived from the parameters. The precision property is a multiplier allowing
  155677. * rendering at a higher or lower resolution
  155678. * @param mimeType The MIME type of the screenshot image (default: image/png).
  155679. * Check your browser for supported MIME types
  155680. * @param samples Texture samples (default: 1)
  155681. * @param antialiasing Whether antialiasing should be turned on or not (default: false)
  155682. * @param fileName A name for for the downloaded file.
  155683. * @param renderSprites Whether the sprites should be rendered or not (default: false)
  155684. * @returns screenshot as a string of base64-encoded characters. This string can be assigned
  155685. * to the src parameter of an <img> to display it
  155686. */
  155687. static CreateScreenshotUsingRenderTargetAsync(engine: Engine, camera: Camera, size: any, mimeType?: string, samples?: number, antialiasing?: boolean, fileName?: string, renderSprites?: boolean): Promise<string>;
  155688. /**
  155689. * Gets height and width for screenshot size
  155690. * @private
  155691. */
  155692. private static _getScreenshotSize;
  155693. }
  155694. }
  155695. declare module BABYLON {
  155696. /**
  155697. * Interface for a data buffer
  155698. */
  155699. export interface IDataBuffer {
  155700. /**
  155701. * Reads bytes from the data buffer.
  155702. * @param byteOffset The byte offset to read
  155703. * @param byteLength The byte length to read
  155704. * @returns A promise that resolves when the bytes are read
  155705. */
  155706. readAsync(byteOffset: number, byteLength: number): Promise<ArrayBufferView>;
  155707. /**
  155708. * The byte length of the buffer.
  155709. */
  155710. readonly byteLength: number;
  155711. }
  155712. /**
  155713. * Utility class for reading from a data buffer
  155714. */
  155715. export class DataReader {
  155716. /**
  155717. * The data buffer associated with this data reader.
  155718. */
  155719. readonly buffer: IDataBuffer;
  155720. /**
  155721. * The current byte offset from the beginning of the data buffer.
  155722. */
  155723. byteOffset: number;
  155724. private _dataView;
  155725. private _dataByteOffset;
  155726. /**
  155727. * Constructor
  155728. * @param buffer The buffer to read
  155729. */
  155730. constructor(buffer: IDataBuffer);
  155731. /**
  155732. * Loads the given byte length.
  155733. * @param byteLength The byte length to load
  155734. * @returns A promise that resolves when the load is complete
  155735. */
  155736. loadAsync(byteLength: number): Promise<void>;
  155737. /**
  155738. * Read a unsigned 32-bit integer from the currently loaded data range.
  155739. * @returns The 32-bit integer read
  155740. */
  155741. readUint32(): number;
  155742. /**
  155743. * Read a byte array from the currently loaded data range.
  155744. * @param byteLength The byte length to read
  155745. * @returns The byte array read
  155746. */
  155747. readUint8Array(byteLength: number): Uint8Array;
  155748. /**
  155749. * Read a string from the currently loaded data range.
  155750. * @param byteLength The byte length to read
  155751. * @returns The string read
  155752. */
  155753. readString(byteLength: number): string;
  155754. /**
  155755. * Skips the given byte length the currently loaded data range.
  155756. * @param byteLength The byte length to skip
  155757. */
  155758. skipBytes(byteLength: number): void;
  155759. }
  155760. }
  155761. declare module BABYLON {
  155762. /**
  155763. * Class for storing data to local storage if available or in-memory storage otherwise
  155764. */
  155765. export class DataStorage {
  155766. private static _Storage;
  155767. private static _GetStorage;
  155768. /**
  155769. * Reads a string from the data storage
  155770. * @param key The key to read
  155771. * @param defaultValue The value if the key doesn't exist
  155772. * @returns The string value
  155773. */
  155774. static ReadString(key: string, defaultValue: string): string;
  155775. /**
  155776. * Writes a string to the data storage
  155777. * @param key The key to write
  155778. * @param value The value to write
  155779. */
  155780. static WriteString(key: string, value: string): void;
  155781. /**
  155782. * Reads a boolean from the data storage
  155783. * @param key The key to read
  155784. * @param defaultValue The value if the key doesn't exist
  155785. * @returns The boolean value
  155786. */
  155787. static ReadBoolean(key: string, defaultValue: boolean): boolean;
  155788. /**
  155789. * Writes a boolean to the data storage
  155790. * @param key The key to write
  155791. * @param value The value to write
  155792. */
  155793. static WriteBoolean(key: string, value: boolean): void;
  155794. /**
  155795. * Reads a number from the data storage
  155796. * @param key The key to read
  155797. * @param defaultValue The value if the key doesn't exist
  155798. * @returns The number value
  155799. */
  155800. static ReadNumber(key: string, defaultValue: number): number;
  155801. /**
  155802. * Writes a number to the data storage
  155803. * @param key The key to write
  155804. * @param value The value to write
  155805. */
  155806. static WriteNumber(key: string, value: number): void;
  155807. }
  155808. }
  155809. declare module BABYLON {
  155810. /**
  155811. * Class used to record delta files between 2 scene states
  155812. */
  155813. export class SceneRecorder {
  155814. private _trackedScene;
  155815. private _savedJSON;
  155816. /**
  155817. * Track a given scene. This means the current scene state will be considered the original state
  155818. * @param scene defines the scene to track
  155819. */
  155820. track(scene: Scene): void;
  155821. /**
  155822. * Get the delta between current state and original state
  155823. * @returns a string containing the delta
  155824. */
  155825. getDelta(): any;
  155826. private _compareArray;
  155827. private _compareObjects;
  155828. private _compareCollections;
  155829. private static GetShadowGeneratorById;
  155830. /**
  155831. * Apply a given delta to a given scene
  155832. * @param deltaJSON defines the JSON containing the delta
  155833. * @param scene defines the scene to apply the delta to
  155834. */
  155835. static ApplyDelta(deltaJSON: any | string, scene: Scene): void;
  155836. private static _ApplyPropertiesToEntity;
  155837. private static _ApplyDeltaForEntity;
  155838. }
  155839. }
  155840. declare module BABYLON {
  155841. /**
  155842. * A 3D trajectory consisting of an order list of vectors describing a
  155843. * path of motion through 3D space.
  155844. */
  155845. export class Trajectory {
  155846. private _points;
  155847. private readonly _segmentLength;
  155848. /**
  155849. * Serialize to JSON.
  155850. * @returns serialized JSON string
  155851. */
  155852. serialize(): string;
  155853. /**
  155854. * Deserialize from JSON.
  155855. * @param json serialized JSON string
  155856. * @returns deserialized Trajectory
  155857. */
  155858. static Deserialize(json: string): Trajectory;
  155859. /**
  155860. * Create a new empty Trajectory.
  155861. * @param segmentLength radius of discretization for Trajectory points
  155862. */
  155863. constructor(segmentLength?: number);
  155864. /**
  155865. * Get the length of the Trajectory.
  155866. * @returns length of the Trajectory
  155867. */
  155868. getLength(): number;
  155869. /**
  155870. * Append a new point to the Trajectory.
  155871. * NOTE: This implementation has many allocations.
  155872. * @param point point to append to the Trajectory
  155873. */
  155874. add(point: DeepImmutable<Vector3>): void;
  155875. /**
  155876. * Create a new Trajectory with a segment length chosen to make it
  155877. * probable that the new Trajectory will have a specified number of
  155878. * segments. This operation is imprecise.
  155879. * @param targetResolution number of segments desired
  155880. * @returns new Trajectory with approximately the requested number of segments
  155881. */
  155882. resampleAtTargetResolution(targetResolution: number): Trajectory;
  155883. /**
  155884. * Convert Trajectory segments into tokenized representation. This
  155885. * representation is an array of numbers where each nth number is the
  155886. * index of the token which is most similar to the nth segment of the
  155887. * Trajectory.
  155888. * @param tokens list of vectors which serve as discrete tokens
  155889. * @returns list of indices of most similar token per segment
  155890. */
  155891. tokenize(tokens: DeepImmutable<Vector3[]>): number[];
  155892. private static _forwardDir;
  155893. private static _inverseFromVec;
  155894. private static _upDir;
  155895. private static _fromToVec;
  155896. private static _lookMatrix;
  155897. /**
  155898. * Transform the rotation (i.e., direction) of a segment to isolate
  155899. * the relative transformation represented by the segment. This operation
  155900. * may or may not succeed due to singularities in the equations that define
  155901. * motion relativity in this context.
  155902. * @param priorVec the origin of the prior segment
  155903. * @param fromVec the origin of the current segment
  155904. * @param toVec the destination of the current segment
  155905. * @param result reference to output variable
  155906. * @returns whether or not transformation was successful
  155907. */
  155908. private static _transformSegmentDirToRef;
  155909. private static _bestMatch;
  155910. private static _score;
  155911. private static _bestScore;
  155912. /**
  155913. * Determine which token vector is most similar to the
  155914. * segment vector.
  155915. * @param segment segment vector
  155916. * @param tokens token vector list
  155917. * @returns index of the most similar token to the segment
  155918. */
  155919. private static _tokenizeSegment;
  155920. }
  155921. /**
  155922. * Class representing a set of known, named trajectories to which Trajectories can be
  155923. * added and using which Trajectories can be recognized.
  155924. */
  155925. export class TrajectoryClassifier {
  155926. private _maximumAllowableMatchCost;
  155927. private _vector3Alphabet;
  155928. private _levenshteinAlphabet;
  155929. private _nameToDescribedTrajectory;
  155930. /**
  155931. * Serialize to JSON.
  155932. * @returns JSON serialization
  155933. */
  155934. serialize(): string;
  155935. /**
  155936. * Deserialize from JSON.
  155937. * @param json JSON serialization
  155938. * @returns deserialized TrajectorySet
  155939. */
  155940. static Deserialize(json: string): TrajectoryClassifier;
  155941. /**
  155942. * Initialize a new empty TrajectorySet with auto-generated Alphabets.
  155943. * VERY naive, need to be generating these things from known
  155944. * sets. Better version later, probably eliminating this one.
  155945. * @returns auto-generated TrajectorySet
  155946. */
  155947. static Generate(): TrajectoryClassifier;
  155948. private constructor();
  155949. /**
  155950. * Add a new Trajectory to the set with a given name.
  155951. * @param trajectory new Trajectory to be added
  155952. * @param classification name to which to add the Trajectory
  155953. */
  155954. addTrajectoryToClassification(trajectory: Trajectory, classification: string): void;
  155955. /**
  155956. * Remove a known named trajectory and all Trajectories associated with it.
  155957. * @param classification name to remove
  155958. * @returns whether anything was removed
  155959. */
  155960. deleteClassification(classification: string): boolean;
  155961. /**
  155962. * Attempt to recognize a Trajectory from among all the classifications
  155963. * already known to the classifier.
  155964. * @param trajectory Trajectory to be recognized
  155965. * @returns classification of Trajectory if recognized, null otherwise
  155966. */
  155967. classifyTrajectory(trajectory: Trajectory): Nullable<string>;
  155968. }
  155969. }
  155970. declare module BABYLON {
  155971. /**
  155972. * An interface for all Hit test features
  155973. */
  155974. export interface IWebXRHitTestFeature<T extends IWebXRLegacyHitResult> extends IWebXRFeature {
  155975. /**
  155976. * Triggered when new babylon (transformed) hit test results are available
  155977. */
  155978. onHitTestResultObservable: Observable<T[]>;
  155979. }
  155980. /**
  155981. * Options used for hit testing
  155982. */
  155983. export interface IWebXRLegacyHitTestOptions {
  155984. /**
  155985. * Only test when user interacted with the scene. Default - hit test every frame
  155986. */
  155987. testOnPointerDownOnly?: boolean;
  155988. /**
  155989. * The node to use to transform the local results to world coordinates
  155990. */
  155991. worldParentNode?: TransformNode;
  155992. }
  155993. /**
  155994. * Interface defining the babylon result of raycasting/hit-test
  155995. */
  155996. export interface IWebXRLegacyHitResult {
  155997. /**
  155998. * Transformation matrix that can be applied to a node that will put it in the hit point location
  155999. */
  156000. transformationMatrix: Matrix;
  156001. /**
  156002. * The native hit test result
  156003. */
  156004. xrHitResult: XRHitResult | XRHitTestResult;
  156005. }
  156006. /**
  156007. * The currently-working hit-test module.
  156008. * Hit test (or Ray-casting) is used to interact with the real world.
  156009. * For further information read here - https://github.com/immersive-web/hit-test
  156010. */
  156011. export class WebXRHitTestLegacy extends WebXRAbstractFeature implements IWebXRHitTestFeature<IWebXRLegacyHitResult> {
  156012. /**
  156013. * options to use when constructing this feature
  156014. */
  156015. readonly options: IWebXRLegacyHitTestOptions;
  156016. private _direction;
  156017. private _mat;
  156018. private _onSelectEnabled;
  156019. private _origin;
  156020. /**
  156021. * The module's name
  156022. */
  156023. static readonly Name: string;
  156024. /**
  156025. * The (Babylon) version of this module.
  156026. * This is an integer representing the implementation version.
  156027. * This number does not correspond to the WebXR specs version
  156028. */
  156029. static readonly Version: number;
  156030. /**
  156031. * Populated with the last native XR Hit Results
  156032. */
  156033. lastNativeXRHitResults: XRHitResult[];
  156034. /**
  156035. * Triggered when new babylon (transformed) hit test results are available
  156036. */
  156037. onHitTestResultObservable: Observable<IWebXRLegacyHitResult[]>;
  156038. /**
  156039. * Creates a new instance of the (legacy version) hit test feature
  156040. * @param _xrSessionManager an instance of WebXRSessionManager
  156041. * @param options options to use when constructing this feature
  156042. */
  156043. constructor(_xrSessionManager: WebXRSessionManager,
  156044. /**
  156045. * options to use when constructing this feature
  156046. */
  156047. options?: IWebXRLegacyHitTestOptions);
  156048. /**
  156049. * execute a hit test with an XR Ray
  156050. *
  156051. * @param xrSession a native xrSession that will execute this hit test
  156052. * @param xrRay the ray (position and direction) to use for ray-casting
  156053. * @param referenceSpace native XR reference space to use for the hit-test
  156054. * @param filter filter function that will filter the results
  156055. * @returns a promise that resolves with an array of native XR hit result in xr coordinates system
  156056. */
  156057. static XRHitTestWithRay(xrSession: XRSession, xrRay: XRRay, referenceSpace: XRReferenceSpace, filter?: (result: XRHitResult) => boolean): Promise<XRHitResult[]>;
  156058. /**
  156059. * Execute a hit test on the current running session using a select event returned from a transient input (such as touch)
  156060. * @param event the (select) event to use to select with
  156061. * @param referenceSpace the reference space to use for this hit test
  156062. * @returns a promise that resolves with an array of native XR hit result in xr coordinates system
  156063. */
  156064. static XRHitTestWithSelectEvent(event: XRInputSourceEvent, referenceSpace: XRReferenceSpace): Promise<XRHitResult[]>;
  156065. /**
  156066. * attach this feature
  156067. * Will usually be called by the features manager
  156068. *
  156069. * @returns true if successful.
  156070. */
  156071. attach(): boolean;
  156072. /**
  156073. * detach this feature.
  156074. * Will usually be called by the features manager
  156075. *
  156076. * @returns true if successful.
  156077. */
  156078. detach(): boolean;
  156079. /**
  156080. * Dispose this feature and all of the resources attached
  156081. */
  156082. dispose(): void;
  156083. protected _onXRFrame(frame: XRFrame): void;
  156084. private _onHitTestResults;
  156085. private _onSelect;
  156086. }
  156087. }
  156088. declare module BABYLON {
  156089. /**
  156090. * Options used for hit testing (version 2)
  156091. */
  156092. export interface IWebXRHitTestOptions extends IWebXRLegacyHitTestOptions {
  156093. /**
  156094. * Do not create a permanent hit test. Will usually be used when only
  156095. * transient inputs are needed.
  156096. */
  156097. disablePermanentHitTest?: boolean;
  156098. /**
  156099. * Enable transient (for example touch-based) hit test inspections
  156100. */
  156101. enableTransientHitTest?: boolean;
  156102. /**
  156103. * Offset ray for the permanent hit test
  156104. */
  156105. offsetRay?: Vector3;
  156106. /**
  156107. * Offset ray for the transient hit test
  156108. */
  156109. transientOffsetRay?: Vector3;
  156110. /**
  156111. * Instead of using viewer space for hit tests, use the reference space defined in the session manager
  156112. */
  156113. useReferenceSpace?: boolean;
  156114. /**
  156115. * Override the default entity type(s) of the hit-test result
  156116. */
  156117. entityTypes?: XRHitTestTrackableType[];
  156118. }
  156119. /**
  156120. * Interface defining the babylon result of hit-test
  156121. */
  156122. export interface IWebXRHitResult extends IWebXRLegacyHitResult {
  156123. /**
  156124. * The input source that generated this hit test (if transient)
  156125. */
  156126. inputSource?: XRInputSource;
  156127. /**
  156128. * Is this a transient hit test
  156129. */
  156130. isTransient?: boolean;
  156131. /**
  156132. * Position of the hit test result
  156133. */
  156134. position: Vector3;
  156135. /**
  156136. * Rotation of the hit test result
  156137. */
  156138. rotationQuaternion: Quaternion;
  156139. /**
  156140. * The native hit test result
  156141. */
  156142. xrHitResult: XRHitTestResult;
  156143. }
  156144. /**
  156145. * The currently-working hit-test module.
  156146. * Hit test (or Ray-casting) is used to interact with the real world.
  156147. * For further information read here - https://github.com/immersive-web/hit-test
  156148. *
  156149. * Tested on chrome (mobile) 80.
  156150. */
  156151. export class WebXRHitTest extends WebXRAbstractFeature implements IWebXRHitTestFeature<IWebXRHitResult> {
  156152. /**
  156153. * options to use when constructing this feature
  156154. */
  156155. readonly options: IWebXRHitTestOptions;
  156156. private _tmpMat;
  156157. private _tmpPos;
  156158. private _tmpQuat;
  156159. private _transientXrHitTestSource;
  156160. private _xrHitTestSource;
  156161. private initHitTestSource;
  156162. /**
  156163. * The module's name
  156164. */
  156165. static readonly Name: string;
  156166. /**
  156167. * The (Babylon) version of this module.
  156168. * This is an integer representing the implementation version.
  156169. * This number does not correspond to the WebXR specs version
  156170. */
  156171. static readonly Version: number;
  156172. /**
  156173. * When set to true, each hit test will have its own position/rotation objects
  156174. * When set to false, position and rotation objects will be reused for each hit test. It is expected that
  156175. * the developers will clone them or copy them as they see fit.
  156176. */
  156177. autoCloneTransformation: boolean;
  156178. /**
  156179. * Triggered when new babylon (transformed) hit test results are available
  156180. * Note - this will be called when results come back from the device. It can be an empty array!!
  156181. */
  156182. onHitTestResultObservable: Observable<IWebXRHitResult[]>;
  156183. /**
  156184. * Use this to temporarily pause hit test checks.
  156185. */
  156186. paused: boolean;
  156187. /**
  156188. * Creates a new instance of the hit test feature
  156189. * @param _xrSessionManager an instance of WebXRSessionManager
  156190. * @param options options to use when constructing this feature
  156191. */
  156192. constructor(_xrSessionManager: WebXRSessionManager,
  156193. /**
  156194. * options to use when constructing this feature
  156195. */
  156196. options?: IWebXRHitTestOptions);
  156197. /**
  156198. * attach this feature
  156199. * Will usually be called by the features manager
  156200. *
  156201. * @returns true if successful.
  156202. */
  156203. attach(): boolean;
  156204. /**
  156205. * detach this feature.
  156206. * Will usually be called by the features manager
  156207. *
  156208. * @returns true if successful.
  156209. */
  156210. detach(): boolean;
  156211. /**
  156212. * Dispose this feature and all of the resources attached
  156213. */
  156214. dispose(): void;
  156215. protected _onXRFrame(frame: XRFrame): void;
  156216. private _processWebXRHitTestResult;
  156217. }
  156218. }
  156219. declare module BABYLON {
  156220. /**
  156221. * Configuration options of the anchor system
  156222. */
  156223. export interface IWebXRAnchorSystemOptions {
  156224. /**
  156225. * a node that will be used to convert local to world coordinates
  156226. */
  156227. worldParentNode?: TransformNode;
  156228. /**
  156229. * If set to true a reference of the created anchors will be kept until the next session starts
  156230. * If not defined, anchors will be removed from the array when the feature is detached or the session ended.
  156231. */
  156232. doNotRemoveAnchorsOnSessionEnded?: boolean;
  156233. }
  156234. /**
  156235. * A babylon container for an XR Anchor
  156236. */
  156237. export interface IWebXRAnchor {
  156238. /**
  156239. * A babylon-assigned ID for this anchor
  156240. */
  156241. id: number;
  156242. /**
  156243. * Transformation matrix to apply to an object attached to this anchor
  156244. */
  156245. transformationMatrix: Matrix;
  156246. /**
  156247. * The native anchor object
  156248. */
  156249. xrAnchor: XRAnchor;
  156250. /**
  156251. * if defined, this object will be constantly updated by the anchor's position and rotation
  156252. */
  156253. attachedNode?: TransformNode;
  156254. }
  156255. /**
  156256. * An implementation of the anchor system for WebXR.
  156257. * For further information see https://github.com/immersive-web/anchors/
  156258. */
  156259. export class WebXRAnchorSystem extends WebXRAbstractFeature {
  156260. private _options;
  156261. private _lastFrameDetected;
  156262. private _trackedAnchors;
  156263. private _referenceSpaceForFrameAnchors;
  156264. private _futureAnchors;
  156265. /**
  156266. * The module's name
  156267. */
  156268. static readonly Name: string;
  156269. /**
  156270. * The (Babylon) version of this module.
  156271. * This is an integer representing the implementation version.
  156272. * This number does not correspond to the WebXR specs version
  156273. */
  156274. static readonly Version: number;
  156275. /**
  156276. * Observers registered here will be executed when a new anchor was added to the session
  156277. */
  156278. onAnchorAddedObservable: Observable<IWebXRAnchor>;
  156279. /**
  156280. * Observers registered here will be executed when an anchor was removed from the session
  156281. */
  156282. onAnchorRemovedObservable: Observable<IWebXRAnchor>;
  156283. /**
  156284. * Observers registered here will be executed when an existing anchor updates
  156285. * This can execute N times every frame
  156286. */
  156287. onAnchorUpdatedObservable: Observable<IWebXRAnchor>;
  156288. /**
  156289. * Set the reference space to use for anchor creation, when not using a hit test.
  156290. * Will default to the session's reference space if not defined
  156291. */
  156292. set referenceSpaceForFrameAnchors(referenceSpace: XRReferenceSpace);
  156293. /**
  156294. * constructs a new anchor system
  156295. * @param _xrSessionManager an instance of WebXRSessionManager
  156296. * @param _options configuration object for this feature
  156297. */
  156298. constructor(_xrSessionManager: WebXRSessionManager, _options?: IWebXRAnchorSystemOptions);
  156299. private _tmpVector;
  156300. private _tmpQuaternion;
  156301. private _populateTmpTransformation;
  156302. /**
  156303. * Create a new anchor point using a hit test result at a specific point in the scene
  156304. * An anchor is tracked only after it is added to the trackerAnchors in xrFrame. The promise returned here does not yet guaranty that.
  156305. * Use onAnchorAddedObservable to get newly added anchors if you require tracking guaranty.
  156306. *
  156307. * @param hitTestResult The hit test result to use for this anchor creation
  156308. * @param position an optional position offset for this anchor
  156309. * @param rotationQuaternion an optional rotation offset for this anchor
  156310. * @returns A promise that fulfills when the XR anchor was registered in the system (but not necessarily added to the tracked anchors)
  156311. */
  156312. addAnchorPointUsingHitTestResultAsync(hitTestResult: IWebXRHitResult, position?: Vector3, rotationQuaternion?: Quaternion): Promise<XRAnchor>;
  156313. /**
  156314. * Add a new anchor at a specific position and rotation
  156315. * This function will add a new anchor per default in the next available frame. Unless forced, the createAnchor function
  156316. * will be called in the next xrFrame loop to make sure that the anchor can be created correctly.
  156317. * An anchor is tracked only after it is added to the trackerAnchors in xrFrame. The promise returned here does not yet guaranty that.
  156318. * Use onAnchorAddedObservable to get newly added anchors if you require tracking guaranty.
  156319. *
  156320. * @param position the position in which to add an anchor
  156321. * @param rotationQuaternion an optional rotation for the anchor transformation
  156322. * @param forceCreateInCurrentFrame force the creation of this anchor in the current frame. Must be called inside xrFrame loop!
  156323. * @returns A promise that fulfills when the XR anchor was registered in the system (but not necessarily added to the tracked anchors)
  156324. */
  156325. addAnchorAtPositionAndRotationAsync(position: Vector3, rotationQuaternion?: Quaternion, forceCreateInCurrentFrame?: boolean): Promise<XRAnchor>;
  156326. /**
  156327. * detach this feature.
  156328. * Will usually be called by the features manager
  156329. *
  156330. * @returns true if successful.
  156331. */
  156332. detach(): boolean;
  156333. /**
  156334. * Dispose this feature and all of the resources attached
  156335. */
  156336. dispose(): void;
  156337. protected _onXRFrame(frame: XRFrame): void;
  156338. /**
  156339. * avoiding using Array.find for global support.
  156340. * @param xrAnchor the plane to find in the array
  156341. */
  156342. private _findIndexInAnchorArray;
  156343. private _updateAnchorWithXRFrame;
  156344. private _createAnchorAtTransformation;
  156345. }
  156346. }
  156347. declare module BABYLON {
  156348. /**
  156349. * Options used in the plane detector module
  156350. */
  156351. export interface IWebXRPlaneDetectorOptions {
  156352. /**
  156353. * The node to use to transform the local results to world coordinates
  156354. */
  156355. worldParentNode?: TransformNode;
  156356. /**
  156357. * If set to true a reference of the created planes will be kept until the next session starts
  156358. * If not defined, planes will be removed from the array when the feature is detached or the session ended.
  156359. */
  156360. doNotRemovePlanesOnSessionEnded?: boolean;
  156361. }
  156362. /**
  156363. * A babylon interface for a WebXR plane.
  156364. * A Plane is actually a polygon, built from N points in space
  156365. *
  156366. * Supported in chrome 79, not supported in canary 81 ATM
  156367. */
  156368. export interface IWebXRPlane {
  156369. /**
  156370. * a babylon-assigned ID for this polygon
  156371. */
  156372. id: number;
  156373. /**
  156374. * an array of vector3 points in babylon space. right/left hand system is taken into account.
  156375. */
  156376. polygonDefinition: Array<Vector3>;
  156377. /**
  156378. * A transformation matrix to apply on the mesh that will be built using the polygonDefinition
  156379. * Local vs. World are decided if worldParentNode was provided or not in the options when constructing the module
  156380. */
  156381. transformationMatrix: Matrix;
  156382. /**
  156383. * the native xr-plane object
  156384. */
  156385. xrPlane: XRPlane;
  156386. }
  156387. /**
  156388. * The plane detector is used to detect planes in the real world when in AR
  156389. * For more information see https://github.com/immersive-web/real-world-geometry/
  156390. */
  156391. export class WebXRPlaneDetector extends WebXRAbstractFeature {
  156392. private _options;
  156393. private _detectedPlanes;
  156394. private _enabled;
  156395. private _lastFrameDetected;
  156396. /**
  156397. * The module's name
  156398. */
  156399. static readonly Name: string;
  156400. /**
  156401. * The (Babylon) version of this module.
  156402. * This is an integer representing the implementation version.
  156403. * This number does not correspond to the WebXR specs version
  156404. */
  156405. static readonly Version: number;
  156406. /**
  156407. * Observers registered here will be executed when a new plane was added to the session
  156408. */
  156409. onPlaneAddedObservable: Observable<IWebXRPlane>;
  156410. /**
  156411. * Observers registered here will be executed when a plane is no longer detected in the session
  156412. */
  156413. onPlaneRemovedObservable: Observable<IWebXRPlane>;
  156414. /**
  156415. * Observers registered here will be executed when an existing plane updates (for example - expanded)
  156416. * This can execute N times every frame
  156417. */
  156418. onPlaneUpdatedObservable: Observable<IWebXRPlane>;
  156419. /**
  156420. * construct a new Plane Detector
  156421. * @param _xrSessionManager an instance of xr Session manager
  156422. * @param _options configuration to use when constructing this feature
  156423. */
  156424. constructor(_xrSessionManager: WebXRSessionManager, _options?: IWebXRPlaneDetectorOptions);
  156425. /**
  156426. * detach this feature.
  156427. * Will usually be called by the features manager
  156428. *
  156429. * @returns true if successful.
  156430. */
  156431. detach(): boolean;
  156432. /**
  156433. * Dispose this feature and all of the resources attached
  156434. */
  156435. dispose(): void;
  156436. protected _onXRFrame(frame: XRFrame): void;
  156437. private _init;
  156438. private _updatePlaneWithXRPlane;
  156439. /**
  156440. * avoiding using Array.find for global support.
  156441. * @param xrPlane the plane to find in the array
  156442. */
  156443. private findIndexInPlaneArray;
  156444. }
  156445. }
  156446. declare module BABYLON {
  156447. /**
  156448. * Options interface for the background remover plugin
  156449. */
  156450. export interface IWebXRBackgroundRemoverOptions {
  156451. /**
  156452. * Further background meshes to disable when entering AR
  156453. */
  156454. backgroundMeshes?: AbstractMesh[];
  156455. /**
  156456. * flags to configure the removal of the environment helper.
  156457. * If not set, the entire background will be removed. If set, flags should be set as well.
  156458. */
  156459. environmentHelperRemovalFlags?: {
  156460. /**
  156461. * Should the skybox be removed (default false)
  156462. */
  156463. skyBox?: boolean;
  156464. /**
  156465. * Should the ground be removed (default false)
  156466. */
  156467. ground?: boolean;
  156468. };
  156469. /**
  156470. * don't disable the environment helper
  156471. */
  156472. ignoreEnvironmentHelper?: boolean;
  156473. }
  156474. /**
  156475. * A module that will automatically disable background meshes when entering AR and will enable them when leaving AR.
  156476. */
  156477. export class WebXRBackgroundRemover extends WebXRAbstractFeature {
  156478. /**
  156479. * read-only options to be used in this module
  156480. */
  156481. readonly options: IWebXRBackgroundRemoverOptions;
  156482. /**
  156483. * The module's name
  156484. */
  156485. static readonly Name: string;
  156486. /**
  156487. * The (Babylon) version of this module.
  156488. * This is an integer representing the implementation version.
  156489. * This number does not correspond to the WebXR specs version
  156490. */
  156491. static readonly Version: number;
  156492. /**
  156493. * registered observers will be triggered when the background state changes
  156494. */
  156495. onBackgroundStateChangedObservable: Observable<boolean>;
  156496. /**
  156497. * constructs a new background remover module
  156498. * @param _xrSessionManager the session manager for this module
  156499. * @param options read-only options to be used in this module
  156500. */
  156501. constructor(_xrSessionManager: WebXRSessionManager,
  156502. /**
  156503. * read-only options to be used in this module
  156504. */
  156505. options?: IWebXRBackgroundRemoverOptions);
  156506. /**
  156507. * attach this feature
  156508. * Will usually be called by the features manager
  156509. *
  156510. * @returns true if successful.
  156511. */
  156512. attach(): boolean;
  156513. /**
  156514. * detach this feature.
  156515. * Will usually be called by the features manager
  156516. *
  156517. * @returns true if successful.
  156518. */
  156519. detach(): boolean;
  156520. /**
  156521. * Dispose this feature and all of the resources attached
  156522. */
  156523. dispose(): void;
  156524. protected _onXRFrame(_xrFrame: XRFrame): void;
  156525. private _setBackgroundState;
  156526. }
  156527. }
  156528. declare module BABYLON {
  156529. /**
  156530. * Options for the controller physics feature
  156531. */
  156532. export class IWebXRControllerPhysicsOptions {
  156533. /**
  156534. * Should the headset get its own impostor
  156535. */
  156536. enableHeadsetImpostor?: boolean;
  156537. /**
  156538. * Optional parameters for the headset impostor
  156539. */
  156540. headsetImpostorParams?: {
  156541. /**
  156542. * The type of impostor to create. Default is sphere
  156543. */
  156544. impostorType: number;
  156545. /**
  156546. * the size of the impostor. Defaults to 10cm
  156547. */
  156548. impostorSize?: number | {
  156549. width: number;
  156550. height: number;
  156551. depth: number;
  156552. };
  156553. /**
  156554. * Friction definitions
  156555. */
  156556. friction?: number;
  156557. /**
  156558. * Restitution
  156559. */
  156560. restitution?: number;
  156561. };
  156562. /**
  156563. * The physics properties of the future impostors
  156564. */
  156565. physicsProperties?: {
  156566. /**
  156567. * If set to true, a mesh impostor will be created when the controller mesh was loaded
  156568. * Note that this requires a physics engine that supports mesh impostors!
  156569. */
  156570. useControllerMesh?: boolean;
  156571. /**
  156572. * The type of impostor to create. Default is sphere
  156573. */
  156574. impostorType?: number;
  156575. /**
  156576. * the size of the impostor. Defaults to 10cm
  156577. */
  156578. impostorSize?: number | {
  156579. width: number;
  156580. height: number;
  156581. depth: number;
  156582. };
  156583. /**
  156584. * Friction definitions
  156585. */
  156586. friction?: number;
  156587. /**
  156588. * Restitution
  156589. */
  156590. restitution?: number;
  156591. };
  156592. /**
  156593. * the xr input to use with this pointer selection
  156594. */
  156595. xrInput: WebXRInput;
  156596. }
  156597. /**
  156598. * Add physics impostor to your webxr controllers,
  156599. * including naive calculation of their linear and angular velocity
  156600. */
  156601. export class WebXRControllerPhysics extends WebXRAbstractFeature {
  156602. private readonly _options;
  156603. private _attachController;
  156604. private _controllers;
  156605. private _debugMode;
  156606. private _delta;
  156607. private _headsetImpostor?;
  156608. private _headsetMesh?;
  156609. private _lastTimestamp;
  156610. private _tmpQuaternion;
  156611. private _tmpVector;
  156612. /**
  156613. * The module's name
  156614. */
  156615. static readonly Name: string;
  156616. /**
  156617. * The (Babylon) version of this module.
  156618. * This is an integer representing the implementation version.
  156619. * This number does not correspond to the webxr specs version
  156620. */
  156621. static readonly Version: number;
  156622. /**
  156623. * Construct a new Controller Physics Feature
  156624. * @param _xrSessionManager the corresponding xr session manager
  156625. * @param _options options to create this feature with
  156626. */
  156627. constructor(_xrSessionManager: WebXRSessionManager, _options: IWebXRControllerPhysicsOptions);
  156628. /**
  156629. * @hidden
  156630. * enable debugging - will show console outputs and the impostor mesh
  156631. */
  156632. _enablePhysicsDebug(): void;
  156633. /**
  156634. * Manually add a controller (if no xrInput was provided or physics engine was not enabled)
  156635. * @param xrController the controller to add
  156636. */
  156637. addController(xrController: WebXRInputSource): void;
  156638. /**
  156639. * attach this feature
  156640. * Will usually be called by the features manager
  156641. *
  156642. * @returns true if successful.
  156643. */
  156644. attach(): boolean;
  156645. /**
  156646. * detach this feature.
  156647. * Will usually be called by the features manager
  156648. *
  156649. * @returns true if successful.
  156650. */
  156651. detach(): boolean;
  156652. /**
  156653. * Get the headset impostor, if enabled
  156654. * @returns the impostor
  156655. */
  156656. getHeadsetImpostor(): PhysicsImpostor | undefined;
  156657. /**
  156658. * Get the physics impostor of a specific controller.
  156659. * The impostor is not attached to a mesh because a mesh for each controller is not obligatory
  156660. * @param controller the controller or the controller id of which to get the impostor
  156661. * @returns the impostor or null
  156662. */
  156663. getImpostorForController(controller: WebXRInputSource | string): Nullable<PhysicsImpostor>;
  156664. /**
  156665. * Update the physics properties provided in the constructor
  156666. * @param newProperties the new properties object
  156667. */
  156668. setPhysicsProperties(newProperties: {
  156669. impostorType?: number;
  156670. impostorSize?: number | {
  156671. width: number;
  156672. height: number;
  156673. depth: number;
  156674. };
  156675. friction?: number;
  156676. restitution?: number;
  156677. }): void;
  156678. protected _onXRFrame(_xrFrame: any): void;
  156679. private _detachController;
  156680. }
  156681. }
  156682. declare module BABYLON {
  156683. /**
  156684. * A babylon interface for a "WebXR" feature point.
  156685. * Represents the position and confidence value of a given feature point.
  156686. */
  156687. export interface IWebXRFeaturePoint {
  156688. /**
  156689. * Represents the position of the feature point in world space.
  156690. */
  156691. position: Vector3;
  156692. /**
  156693. * Represents the confidence value of the feature point in world space. 0 being least confident, and 1 being most confident.
  156694. */
  156695. confidenceValue: number;
  156696. }
  156697. /**
  156698. * The feature point system is used to detect feature points from real world geometry.
  156699. * This feature is currently experimental and only supported on BabylonNative, and should not be used in the browser.
  156700. * The newly introduced API can be seen in webxr.nativeextensions.d.ts and described in FeaturePoints.md.
  156701. */
  156702. export class WebXRFeaturePointSystem extends WebXRAbstractFeature {
  156703. private _enabled;
  156704. private _featurePointCloud;
  156705. /**
  156706. * The module's name
  156707. */
  156708. static readonly Name: string;
  156709. /**
  156710. * The (Babylon) version of this module.
  156711. * This is an integer representing the implementation version.
  156712. * This number does not correspond to the WebXR specs version
  156713. */
  156714. static readonly Version: number;
  156715. /**
  156716. * Observers registered here will be executed whenever new feature points are added (on XRFrame while the session is tracking).
  156717. * Will notify the observers about which feature points have been added.
  156718. */
  156719. readonly onFeaturePointsAddedObservable: Observable<number[]>;
  156720. /**
  156721. * Observers registered here will be executed whenever a feature point has been updated (on XRFrame while the session is tracking).
  156722. * Will notify the observers about which feature points have been updated.
  156723. */
  156724. readonly onFeaturePointsUpdatedObservable: Observable<number[]>;
  156725. /**
  156726. * The current feature point cloud maintained across frames.
  156727. */
  156728. get featurePointCloud(): Array<IWebXRFeaturePoint>;
  156729. /**
  156730. * construct the feature point system
  156731. * @param _xrSessionManager an instance of xr Session manager
  156732. */
  156733. constructor(_xrSessionManager: WebXRSessionManager);
  156734. /**
  156735. * Detach this feature.
  156736. * Will usually be called by the features manager
  156737. *
  156738. * @returns true if successful.
  156739. */
  156740. detach(): boolean;
  156741. /**
  156742. * Dispose this feature and all of the resources attached
  156743. */
  156744. dispose(): void;
  156745. /**
  156746. * On receiving a new XR frame if this feature is attached notify observers new feature point data is available.
  156747. */
  156748. protected _onXRFrame(frame: XRFrame): void;
  156749. /**
  156750. * Initializes the feature. If the feature point feature is not available for this environment do not mark the feature as enabled.
  156751. */
  156752. private _init;
  156753. }
  156754. }
  156755. declare module BABYLON {
  156756. /**
  156757. * Configuration interface for the hand tracking feature
  156758. */
  156759. export interface IWebXRHandTrackingOptions {
  156760. /**
  156761. * The xrInput that will be used as source for new hands
  156762. */
  156763. xrInput: WebXRInput;
  156764. /**
  156765. * Configuration object for the joint meshes
  156766. */
  156767. jointMeshes?: {
  156768. /**
  156769. * Should the meshes created be invisible (defaults to false)
  156770. */
  156771. invisible?: boolean;
  156772. /**
  156773. * A source mesh to be used to create instances. Defaults to a sphere.
  156774. * This mesh will be the source for all other (25) meshes.
  156775. * It should have the general size of a single unit, as the instances will be scaled according to the provided radius
  156776. */
  156777. sourceMesh?: Mesh;
  156778. /**
  156779. * This function will be called after a mesh was created for a specific joint.
  156780. * Using this function you can either manipulate the instance or return a new mesh.
  156781. * When returning a new mesh the instance created before will be disposed
  156782. */
  156783. onHandJointMeshGenerated?: (meshInstance: InstancedMesh, jointId: number, controllerId: string) => Mesh | undefined;
  156784. /**
  156785. * Should the source mesh stay visible. Defaults to false
  156786. */
  156787. keepOriginalVisible?: boolean;
  156788. /**
  156789. * Scale factor for all instances (defaults to 2)
  156790. */
  156791. scaleFactor?: number;
  156792. /**
  156793. * Should each instance have its own physics impostor
  156794. */
  156795. enablePhysics?: boolean;
  156796. /**
  156797. * If enabled, override default physics properties
  156798. */
  156799. physicsProps?: {
  156800. friction?: number;
  156801. restitution?: number;
  156802. impostorType?: number;
  156803. };
  156804. /**
  156805. * For future use - a single hand-mesh that will be updated according to the XRHand data provided
  156806. */
  156807. handMesh?: AbstractMesh;
  156808. };
  156809. }
  156810. /**
  156811. * Parts of the hands divided to writs and finger names
  156812. */
  156813. export const enum HandPart {
  156814. /**
  156815. * HandPart - Wrist
  156816. */
  156817. WRIST = "wrist",
  156818. /**
  156819. * HandPart - The THumb
  156820. */
  156821. THUMB = "thumb",
  156822. /**
  156823. * HandPart - Index finger
  156824. */
  156825. INDEX = "index",
  156826. /**
  156827. * HandPart - Middle finger
  156828. */
  156829. MIDDLE = "middle",
  156830. /**
  156831. * HandPart - Ring finger
  156832. */
  156833. RING = "ring",
  156834. /**
  156835. * HandPart - Little finger
  156836. */
  156837. LITTLE = "little"
  156838. }
  156839. /**
  156840. * Representing a single hand (with its corresponding native XRHand object)
  156841. */
  156842. export class WebXRHand implements IDisposable {
  156843. /** the controller to which the hand correlates */
  156844. readonly xrController: WebXRInputSource;
  156845. /** the meshes to be used to track the hand joints */
  156846. readonly trackedMeshes: AbstractMesh[];
  156847. /**
  156848. * Hand-parts definition (key is HandPart)
  156849. */
  156850. handPartsDefinition: {
  156851. [key: string]: number[];
  156852. };
  156853. /**
  156854. * Populate the HandPartsDefinition object.
  156855. * This is called as a side effect since certain browsers don't have XRHand defined.
  156856. */
  156857. private generateHandPartsDefinition;
  156858. /**
  156859. * Construct a new hand object
  156860. * @param xrController the controller to which the hand correlates
  156861. * @param trackedMeshes the meshes to be used to track the hand joints
  156862. */
  156863. constructor(
  156864. /** the controller to which the hand correlates */
  156865. xrController: WebXRInputSource,
  156866. /** the meshes to be used to track the hand joints */
  156867. trackedMeshes: AbstractMesh[]);
  156868. /**
  156869. * Update this hand from the latest xr frame
  156870. * @param xrFrame xrFrame to update from
  156871. * @param referenceSpace The current viewer reference space
  156872. * @param scaleFactor optional scale factor for the meshes
  156873. */
  156874. updateFromXRFrame(xrFrame: XRFrame, referenceSpace: XRReferenceSpace, scaleFactor?: number): void;
  156875. /**
  156876. * Get meshes of part of the hand
  156877. * @param part the part of hand to get
  156878. * @returns An array of meshes that correlate to the hand part requested
  156879. */
  156880. getHandPartMeshes(part: HandPart): AbstractMesh[];
  156881. /**
  156882. * Dispose this Hand object
  156883. */
  156884. dispose(): void;
  156885. }
  156886. /**
  156887. * WebXR Hand Joint tracking feature, available for selected browsers and devices
  156888. */
  156889. export class WebXRHandTracking extends WebXRAbstractFeature {
  156890. /**
  156891. * options to use when constructing this feature
  156892. */
  156893. readonly options: IWebXRHandTrackingOptions;
  156894. private static _idCounter;
  156895. /**
  156896. * The module's name
  156897. */
  156898. static readonly Name: string;
  156899. /**
  156900. * The (Babylon) version of this module.
  156901. * This is an integer representing the implementation version.
  156902. * This number does not correspond to the WebXR specs version
  156903. */
  156904. static readonly Version: number;
  156905. /**
  156906. * This observable will notify registered observers when a new hand object was added and initialized
  156907. */
  156908. onHandAddedObservable: Observable<WebXRHand>;
  156909. /**
  156910. * This observable will notify its observers right before the hand object is disposed
  156911. */
  156912. onHandRemovedObservable: Observable<WebXRHand>;
  156913. private _hands;
  156914. /**
  156915. * Creates a new instance of the hit test feature
  156916. * @param _xrSessionManager an instance of WebXRSessionManager
  156917. * @param options options to use when constructing this feature
  156918. */
  156919. constructor(_xrSessionManager: WebXRSessionManager,
  156920. /**
  156921. * options to use when constructing this feature
  156922. */
  156923. options: IWebXRHandTrackingOptions);
  156924. /**
  156925. * Check if the needed objects are defined.
  156926. * This does not mean that the feature is enabled, but that the objects needed are well defined.
  156927. */
  156928. isCompatible(): boolean;
  156929. /**
  156930. * attach this feature
  156931. * Will usually be called by the features manager
  156932. *
  156933. * @returns true if successful.
  156934. */
  156935. attach(): boolean;
  156936. /**
  156937. * detach this feature.
  156938. * Will usually be called by the features manager
  156939. *
  156940. * @returns true if successful.
  156941. */
  156942. detach(): boolean;
  156943. /**
  156944. * Dispose this feature and all of the resources attached
  156945. */
  156946. dispose(): void;
  156947. /**
  156948. * Get the hand object according to the controller id
  156949. * @param controllerId the controller id to which we want to get the hand
  156950. * @returns null if not found or the WebXRHand object if found
  156951. */
  156952. getHandByControllerId(controllerId: string): Nullable<WebXRHand>;
  156953. /**
  156954. * Get a hand object according to the requested handedness
  156955. * @param handedness the handedness to request
  156956. * @returns null if not found or the WebXRHand object if found
  156957. */
  156958. getHandByHandedness(handedness: XRHandedness): Nullable<WebXRHand>;
  156959. protected _onXRFrame(_xrFrame: XRFrame): void;
  156960. private _attachHand;
  156961. private _detachHand;
  156962. }
  156963. }
  156964. declare module BABYLON {
  156965. /**
  156966. * The motion controller class for all microsoft mixed reality controllers
  156967. */
  156968. export class WebXRMicrosoftMixedRealityController extends WebXRAbstractMotionController {
  156969. protected readonly _mapping: {
  156970. defaultButton: {
  156971. valueNodeName: string;
  156972. unpressedNodeName: string;
  156973. pressedNodeName: string;
  156974. };
  156975. defaultAxis: {
  156976. valueNodeName: string;
  156977. minNodeName: string;
  156978. maxNodeName: string;
  156979. };
  156980. buttons: {
  156981. "xr-standard-trigger": {
  156982. rootNodeName: string;
  156983. componentProperty: string;
  156984. states: string[];
  156985. };
  156986. "xr-standard-squeeze": {
  156987. rootNodeName: string;
  156988. componentProperty: string;
  156989. states: string[];
  156990. };
  156991. "xr-standard-touchpad": {
  156992. rootNodeName: string;
  156993. labelAnchorNodeName: string;
  156994. touchPointNodeName: string;
  156995. };
  156996. "xr-standard-thumbstick": {
  156997. rootNodeName: string;
  156998. componentProperty: string;
  156999. states: string[];
  157000. };
  157001. };
  157002. axes: {
  157003. "xr-standard-touchpad": {
  157004. "x-axis": {
  157005. rootNodeName: string;
  157006. };
  157007. "y-axis": {
  157008. rootNodeName: string;
  157009. };
  157010. };
  157011. "xr-standard-thumbstick": {
  157012. "x-axis": {
  157013. rootNodeName: string;
  157014. };
  157015. "y-axis": {
  157016. rootNodeName: string;
  157017. };
  157018. };
  157019. };
  157020. };
  157021. /**
  157022. * The base url used to load the left and right controller models
  157023. */
  157024. static MODEL_BASE_URL: string;
  157025. /**
  157026. * The name of the left controller model file
  157027. */
  157028. static MODEL_LEFT_FILENAME: string;
  157029. /**
  157030. * The name of the right controller model file
  157031. */
  157032. static MODEL_RIGHT_FILENAME: string;
  157033. profileId: string;
  157034. constructor(scene: Scene, gamepadObject: IMinimalMotionControllerObject, handedness: MotionControllerHandedness);
  157035. protected _getFilenameAndPath(): {
  157036. filename: string;
  157037. path: string;
  157038. };
  157039. protected _getModelLoadingConstraints(): boolean;
  157040. protected _processLoadedModel(_meshes: AbstractMesh[]): void;
  157041. protected _setRootMesh(meshes: AbstractMesh[]): void;
  157042. protected _updateModel(): void;
  157043. }
  157044. }
  157045. declare module BABYLON {
  157046. /**
  157047. * The motion controller class for oculus touch (quest, rift).
  157048. * This class supports legacy mapping as well the standard xr mapping
  157049. */
  157050. export class WebXROculusTouchMotionController extends WebXRAbstractMotionController {
  157051. private _forceLegacyControllers;
  157052. private _modelRootNode;
  157053. /**
  157054. * The base url used to load the left and right controller models
  157055. */
  157056. static MODEL_BASE_URL: string;
  157057. /**
  157058. * The name of the left controller model file
  157059. */
  157060. static MODEL_LEFT_FILENAME: string;
  157061. /**
  157062. * The name of the right controller model file
  157063. */
  157064. static MODEL_RIGHT_FILENAME: string;
  157065. /**
  157066. * Base Url for the Quest controller model.
  157067. */
  157068. static QUEST_MODEL_BASE_URL: string;
  157069. profileId: string;
  157070. constructor(scene: Scene, gamepadObject: IMinimalMotionControllerObject, handedness: MotionControllerHandedness, legacyMapping?: boolean, _forceLegacyControllers?: boolean);
  157071. protected _getFilenameAndPath(): {
  157072. filename: string;
  157073. path: string;
  157074. };
  157075. protected _getModelLoadingConstraints(): boolean;
  157076. protected _processLoadedModel(_meshes: AbstractMesh[]): void;
  157077. protected _setRootMesh(meshes: AbstractMesh[]): void;
  157078. protected _updateModel(): void;
  157079. /**
  157080. * Is this the new type of oculus touch. At the moment both have the same profile and it is impossible to differentiate
  157081. * between the touch and touch 2.
  157082. */
  157083. private _isQuest;
  157084. }
  157085. }
  157086. declare module BABYLON {
  157087. /**
  157088. * The motion controller class for the standard HTC-Vive controllers
  157089. */
  157090. export class WebXRHTCViveMotionController extends WebXRAbstractMotionController {
  157091. private _modelRootNode;
  157092. /**
  157093. * The base url used to load the left and right controller models
  157094. */
  157095. static MODEL_BASE_URL: string;
  157096. /**
  157097. * File name for the controller model.
  157098. */
  157099. static MODEL_FILENAME: string;
  157100. profileId: string;
  157101. /**
  157102. * Create a new Vive motion controller object
  157103. * @param scene the scene to use to create this controller
  157104. * @param gamepadObject the corresponding gamepad object
  157105. * @param handedness the handedness of the controller
  157106. */
  157107. constructor(scene: Scene, gamepadObject: IMinimalMotionControllerObject, handedness: MotionControllerHandedness);
  157108. protected _getFilenameAndPath(): {
  157109. filename: string;
  157110. path: string;
  157111. };
  157112. protected _getModelLoadingConstraints(): boolean;
  157113. protected _processLoadedModel(_meshes: AbstractMesh[]): void;
  157114. protected _setRootMesh(meshes: AbstractMesh[]): void;
  157115. protected _updateModel(): void;
  157116. }
  157117. }
  157118. declare module BABYLON {
  157119. /**
  157120. * A cursor which tracks a point on a path
  157121. */
  157122. export class PathCursor {
  157123. private path;
  157124. /**
  157125. * Stores path cursor callbacks for when an onchange event is triggered
  157126. */
  157127. private _onchange;
  157128. /**
  157129. * The value of the path cursor
  157130. */
  157131. value: number;
  157132. /**
  157133. * The animation array of the path cursor
  157134. */
  157135. animations: Animation[];
  157136. /**
  157137. * Initializes the path cursor
  157138. * @param path The path to track
  157139. */
  157140. constructor(path: Path2);
  157141. /**
  157142. * Gets the cursor point on the path
  157143. * @returns A point on the path cursor at the cursor location
  157144. */
  157145. getPoint(): Vector3;
  157146. /**
  157147. * Moves the cursor ahead by the step amount
  157148. * @param step The amount to move the cursor forward
  157149. * @returns This path cursor
  157150. */
  157151. moveAhead(step?: number): PathCursor;
  157152. /**
  157153. * Moves the cursor behind by the step amount
  157154. * @param step The amount to move the cursor back
  157155. * @returns This path cursor
  157156. */
  157157. moveBack(step?: number): PathCursor;
  157158. /**
  157159. * Moves the cursor by the step amount
  157160. * If the step amount is greater than one, an exception is thrown
  157161. * @param step The amount to move the cursor
  157162. * @returns This path cursor
  157163. */
  157164. move(step: number): PathCursor;
  157165. /**
  157166. * Ensures that the value is limited between zero and one
  157167. * @returns This path cursor
  157168. */
  157169. private ensureLimits;
  157170. /**
  157171. * Runs onchange callbacks on change (used by the animation engine)
  157172. * @returns This path cursor
  157173. */
  157174. private raiseOnChange;
  157175. /**
  157176. * Executes a function on change
  157177. * @param f A path cursor onchange callback
  157178. * @returns This path cursor
  157179. */
  157180. onchange(f: (cursor: PathCursor) => void): PathCursor;
  157181. }
  157182. }
  157183. declare module BABYLON {
  157184. /** @hidden */
  157185. export var blurPixelShader: {
  157186. name: string;
  157187. shader: string;
  157188. };
  157189. }
  157190. declare module BABYLON {
  157191. /** @hidden */
  157192. export var pointCloudVertexDeclaration: {
  157193. name: string;
  157194. shader: string;
  157195. };
  157196. }
  157197. // Mixins
  157198. interface Window {
  157199. mozIndexedDB: IDBFactory;
  157200. webkitIndexedDB: IDBFactory;
  157201. msIndexedDB: IDBFactory;
  157202. webkitURL: typeof URL;
  157203. mozRequestAnimationFrame(callback: FrameRequestCallback): number;
  157204. oRequestAnimationFrame(callback: FrameRequestCallback): number;
  157205. WebGLRenderingContext: WebGLRenderingContext;
  157206. MSGesture: MSGesture;
  157207. CANNON: any;
  157208. AudioContext: AudioContext;
  157209. webkitAudioContext: AudioContext;
  157210. PointerEvent: any;
  157211. Math: Math;
  157212. Uint8Array: Uint8ArrayConstructor;
  157213. Float32Array: Float32ArrayConstructor;
  157214. mozURL: typeof URL;
  157215. msURL: typeof URL;
  157216. VRFrameData: any; // WebVR, from specs 1.1
  157217. DracoDecoderModule: any;
  157218. setImmediate(handler: (...args: any[]) => void): number;
  157219. }
  157220. interface HTMLCanvasElement {
  157221. requestPointerLock(): void;
  157222. msRequestPointerLock?(): void;
  157223. mozRequestPointerLock?(): void;
  157224. webkitRequestPointerLock?(): void;
  157225. /** Track wether a record is in progress */
  157226. isRecording: boolean;
  157227. /** Capture Stream method defined by some browsers */
  157228. captureStream(fps?: number): MediaStream;
  157229. }
  157230. interface CanvasRenderingContext2D {
  157231. msImageSmoothingEnabled: boolean;
  157232. }
  157233. interface MouseEvent {
  157234. mozMovementX: number;
  157235. mozMovementY: number;
  157236. webkitMovementX: number;
  157237. webkitMovementY: number;
  157238. msMovementX: number;
  157239. msMovementY: number;
  157240. }
  157241. interface Navigator {
  157242. mozGetVRDevices: (any: any) => any;
  157243. webkitGetUserMedia(constraints: MediaStreamConstraints, successCallback: NavigatorUserMediaSuccessCallback, errorCallback: NavigatorUserMediaErrorCallback): void;
  157244. mozGetUserMedia(constraints: MediaStreamConstraints, successCallback: NavigatorUserMediaSuccessCallback, errorCallback: NavigatorUserMediaErrorCallback): void;
  157245. msGetUserMedia(constraints: MediaStreamConstraints, successCallback: NavigatorUserMediaSuccessCallback, errorCallback: NavigatorUserMediaErrorCallback): void;
  157246. webkitGetGamepads(): Gamepad[];
  157247. msGetGamepads(): Gamepad[];
  157248. webkitGamepads(): Gamepad[];
  157249. }
  157250. interface HTMLVideoElement {
  157251. mozSrcObject: any;
  157252. }
  157253. interface Math {
  157254. fround(x: number): number;
  157255. imul(a: number, b: number): number;
  157256. }
  157257. interface WebGLRenderingContext {
  157258. drawArraysInstanced(mode: number, first: number, count: number, primcount: number): void;
  157259. drawElementsInstanced(mode: number, count: number, type: number, offset: number, primcount: number): void;
  157260. vertexAttribDivisor(index: number, divisor: number): void;
  157261. createVertexArray(): any;
  157262. bindVertexArray(vao?: WebGLVertexArrayObject | null): void;
  157263. deleteVertexArray(vao: WebGLVertexArrayObject): void;
  157264. blitFramebuffer(srcX0: number, srcY0: number, srcX1: number, srcY1: number, dstX0: number, dstY0: number, dstX1: number, dstY1: number, mask: number, filter: number): void;
  157265. renderbufferStorageMultisample?(target: number, samples: number, internalformat: number, width: number, height: number): void;
  157266. bindBufferBase(target: number, index: number, buffer: WebGLBuffer | null): void;
  157267. getUniformBlockIndex(program: WebGLProgram, uniformBlockName: string): number;
  157268. uniformBlockBinding(program: WebGLProgram, uniformBlockIndex: number, uniformBlockBinding: number): void;
  157269. // Queries
  157270. createQuery(): WebGLQuery;
  157271. deleteQuery(query: WebGLQuery): void;
  157272. beginQuery(target: number, query: WebGLQuery): void;
  157273. endQuery(target: number): void;
  157274. getQueryParameter(query: WebGLQuery, pname: number): any;
  157275. getQuery(target: number, pname: number): any;
  157276. MAX_SAMPLES: number;
  157277. RGBA8: number;
  157278. READ_FRAMEBUFFER: number;
  157279. DRAW_FRAMEBUFFER: number;
  157280. UNIFORM_BUFFER: number;
  157281. HALF_FLOAT_OES: number;
  157282. RGBA16F: number;
  157283. RGBA32F: number;
  157284. R32F: number;
  157285. RG32F: number;
  157286. RGB32F: number;
  157287. R16F: number;
  157288. RG16F: number;
  157289. RGB16F: number;
  157290. RED: number;
  157291. RG: number;
  157292. R8: number;
  157293. RG8: number;
  157294. UNSIGNED_INT_24_8: number;
  157295. DEPTH24_STENCIL8: number;
  157296. MIN: number;
  157297. MAX: number;
  157298. /* Multiple Render Targets */
  157299. drawBuffers(buffers: number[]): void;
  157300. readBuffer(src: number): void;
  157301. readonly COLOR_ATTACHMENT0: number; // 0x8CE1
  157302. readonly COLOR_ATTACHMENT1: number; // 0x8CE2
  157303. readonly COLOR_ATTACHMENT2: number; // 0x8CE3
  157304. readonly COLOR_ATTACHMENT3: number; // 0x8CE4
  157305. // Occlusion Query
  157306. ANY_SAMPLES_PASSED_CONSERVATIVE: number;
  157307. ANY_SAMPLES_PASSED: number;
  157308. QUERY_RESULT_AVAILABLE: number;
  157309. QUERY_RESULT: number;
  157310. }
  157311. interface WebGLProgram {
  157312. __SPECTOR_rebuildProgram?: ((vertexSourceCode: string, fragmentSourceCode: string, onCompiled: (program: WebGLProgram) => void, onError: (message: string) => void) => void) | null;
  157313. }
  157314. interface EXT_disjoint_timer_query {
  157315. QUERY_COUNTER_BITS_EXT: number;
  157316. TIME_ELAPSED_EXT: number;
  157317. TIMESTAMP_EXT: number;
  157318. GPU_DISJOINT_EXT: number;
  157319. QUERY_RESULT_EXT: number;
  157320. QUERY_RESULT_AVAILABLE_EXT: number;
  157321. queryCounterEXT(query: WebGLQuery, target: number): void;
  157322. createQueryEXT(): WebGLQuery;
  157323. beginQueryEXT(target: number, query: WebGLQuery): void;
  157324. endQueryEXT(target: number): void;
  157325. getQueryObjectEXT(query: WebGLQuery, target: number): any;
  157326. deleteQueryEXT(query: WebGLQuery): void;
  157327. }
  157328. interface WebGLUniformLocation {
  157329. _currentState: any;
  157330. }
  157331. // Type definitions for WebGL 2, Editor's Draft Fri Feb 24 16:10:18 2017 -0800
  157332. // Project: https://www.khronos.org/registry/webgl/specs/latest/2.0/
  157333. // Definitions by: Nico Kemnitz <https://github.com/nkemnitz/>
  157334. // Definitions: https://github.com/DefinitelyTyped/DefinitelyTyped
  157335. interface WebGLRenderingContext {
  157336. readonly RASTERIZER_DISCARD: number;
  157337. readonly DEPTH_COMPONENT24: number;
  157338. readonly TEXTURE_3D: number;
  157339. readonly TEXTURE_2D_ARRAY: number;
  157340. readonly TEXTURE_COMPARE_FUNC: number;
  157341. readonly TEXTURE_COMPARE_MODE: number;
  157342. readonly COMPARE_REF_TO_TEXTURE: number;
  157343. readonly TEXTURE_WRAP_R: number;
  157344. readonly HALF_FLOAT: number;
  157345. readonly RGB8: number;
  157346. readonly RED_INTEGER: number;
  157347. readonly RG_INTEGER: number;
  157348. readonly RGB_INTEGER: number;
  157349. readonly RGBA_INTEGER: number;
  157350. readonly R8_SNORM: number;
  157351. readonly RG8_SNORM: number;
  157352. readonly RGB8_SNORM: number;
  157353. readonly RGBA8_SNORM: number;
  157354. readonly R8I: number;
  157355. readonly RG8I: number;
  157356. readonly RGB8I: number;
  157357. readonly RGBA8I: number;
  157358. readonly R8UI: number;
  157359. readonly RG8UI: number;
  157360. readonly RGB8UI: number;
  157361. readonly RGBA8UI: number;
  157362. readonly R16I: number;
  157363. readonly RG16I: number;
  157364. readonly RGB16I: number;
  157365. readonly RGBA16I: number;
  157366. readonly R16UI: number;
  157367. readonly RG16UI: number;
  157368. readonly RGB16UI: number;
  157369. readonly RGBA16UI: number;
  157370. readonly R32I: number;
  157371. readonly RG32I: number;
  157372. readonly RGB32I: number;
  157373. readonly RGBA32I: number;
  157374. readonly R32UI: number;
  157375. readonly RG32UI: number;
  157376. readonly RGB32UI: number;
  157377. readonly RGBA32UI: number;
  157378. readonly RGB10_A2UI: number;
  157379. readonly R11F_G11F_B10F: number;
  157380. readonly RGB9_E5: number;
  157381. readonly RGB10_A2: number;
  157382. readonly UNSIGNED_INT_2_10_10_10_REV: number;
  157383. readonly UNSIGNED_INT_10F_11F_11F_REV: number;
  157384. readonly UNSIGNED_INT_5_9_9_9_REV: number;
  157385. readonly FLOAT_32_UNSIGNED_INT_24_8_REV: number;
  157386. readonly DEPTH_COMPONENT32F: number;
  157387. texImage3D(target: number, level: number, internalformat: number, width: number, height: number, depth: number, border: number, format: number, type: number, pixels: ArrayBufferView | null): void;
  157388. texImage3D(target: number, level: number, internalformat: number, width: number, height: number, depth: number, border: number, format: number, type: number, pixels: ArrayBufferView, offset: number): void;
  157389. 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;
  157390. framebufferTextureLayer(target: number, attachment: number, texture: WebGLTexture | null, level: number, layer: number): void;
  157391. compressedTexImage3D(target: number, level: number, internalformat: number, width: number, height: number, depth: number, border: number, data: ArrayBufferView, offset?: number, length?: number): void;
  157392. readonly TRANSFORM_FEEDBACK: number;
  157393. readonly INTERLEAVED_ATTRIBS: number;
  157394. readonly TRANSFORM_FEEDBACK_BUFFER: number;
  157395. createTransformFeedback(): WebGLTransformFeedback;
  157396. deleteTransformFeedback(transformFeedbac: WebGLTransformFeedback): void;
  157397. bindTransformFeedback(target: number, transformFeedback: WebGLTransformFeedback | null): void;
  157398. beginTransformFeedback(primitiveMode: number): void;
  157399. endTransformFeedback(): void;
  157400. transformFeedbackVaryings(program: WebGLProgram, varyings: string[], bufferMode: number): void;
  157401. clearBufferfv(buffer: number, drawbuffer: number, values: ArrayBufferView, srcOffset: number | null): void;
  157402. clearBufferiv(buffer: number, drawbuffer: number, values: ArrayBufferView, srcOffset: number | null): void;
  157403. clearBufferuiv(buffer: number, drawbuffer: number, values: ArrayBufferView, srcOffset: number | null): void;
  157404. clearBufferfi(buffer: number, drawbuffer: number, depth: number, stencil: number): void;
  157405. }
  157406. interface ImageBitmap {
  157407. readonly width: number;
  157408. readonly height: number;
  157409. close(): void;
  157410. }
  157411. interface WebGLQuery extends WebGLObject {
  157412. }
  157413. declare var WebGLQuery: {
  157414. prototype: WebGLQuery;
  157415. new(): WebGLQuery;
  157416. };
  157417. interface WebGLSampler extends WebGLObject {
  157418. }
  157419. declare var WebGLSampler: {
  157420. prototype: WebGLSampler;
  157421. new(): WebGLSampler;
  157422. };
  157423. interface WebGLSync extends WebGLObject {
  157424. }
  157425. declare var WebGLSync: {
  157426. prototype: WebGLSync;
  157427. new(): WebGLSync;
  157428. };
  157429. interface WebGLTransformFeedback extends WebGLObject {
  157430. }
  157431. declare var WebGLTransformFeedback: {
  157432. prototype: WebGLTransformFeedback;
  157433. new(): WebGLTransformFeedback;
  157434. };
  157435. interface WebGLVertexArrayObject extends WebGLObject {
  157436. }
  157437. declare var WebGLVertexArrayObject: {
  157438. prototype: WebGLVertexArrayObject;
  157439. new(): WebGLVertexArrayObject;
  157440. };
  157441. // Type definitions for WebVR API
  157442. // Project: https://w3c.github.io/webvr/
  157443. // Definitions by: six a <https://github.com/lostfictions>
  157444. // Definitions: https://github.com/DefinitelyTyped/DefinitelyTyped
  157445. interface VRDisplay extends EventTarget {
  157446. /**
  157447. * Dictionary of capabilities describing the VRDisplay.
  157448. */
  157449. readonly capabilities: VRDisplayCapabilities;
  157450. /**
  157451. * z-depth defining the far plane of the eye view frustum
  157452. * enables mapping of values in the render target depth
  157453. * attachment to scene coordinates. Initially set to 10000.0.
  157454. */
  157455. depthFar: number;
  157456. /**
  157457. * z-depth defining the near plane of the eye view frustum
  157458. * enables mapping of values in the render target depth
  157459. * attachment to scene coordinates. Initially set to 0.01.
  157460. */
  157461. depthNear: number;
  157462. /**
  157463. * An identifier for this distinct VRDisplay. Used as an
  157464. * association point in the Gamepad API.
  157465. */
  157466. readonly displayId: number;
  157467. /**
  157468. * A display name, a user-readable name identifying it.
  157469. */
  157470. readonly displayName: string;
  157471. readonly isConnected: boolean;
  157472. readonly isPresenting: boolean;
  157473. /**
  157474. * If this VRDisplay supports room-scale experiences, the optional
  157475. * stage attribute contains details on the room-scale parameters.
  157476. */
  157477. readonly stageParameters: VRStageParameters | null;
  157478. /**
  157479. * Passing the value returned by `requestAnimationFrame` to
  157480. * `cancelAnimationFrame` will unregister the callback.
  157481. * @param handle Define the hanle of the request to cancel
  157482. */
  157483. cancelAnimationFrame(handle: number): void;
  157484. /**
  157485. * Stops presenting to the VRDisplay.
  157486. * @returns a promise to know when it stopped
  157487. */
  157488. exitPresent(): Promise<void>;
  157489. /**
  157490. * Return the current VREyeParameters for the given eye.
  157491. * @param whichEye Define the eye we want the parameter for
  157492. * @returns the eye parameters
  157493. */
  157494. getEyeParameters(whichEye: string): VREyeParameters;
  157495. /**
  157496. * Populates the passed VRFrameData with the information required to render
  157497. * the current frame.
  157498. * @param frameData Define the data structure to populate
  157499. * @returns true if ok otherwise false
  157500. */
  157501. getFrameData(frameData: VRFrameData): boolean;
  157502. /**
  157503. * Get the layers currently being presented.
  157504. * @returns the list of VR layers
  157505. */
  157506. getLayers(): VRLayer[];
  157507. /**
  157508. * Return a VRPose containing the future predicted pose of the VRDisplay
  157509. * when the current frame will be presented. The value returned will not
  157510. * change until JavaScript has returned control to the browser.
  157511. *
  157512. * The VRPose will contain the position, orientation, velocity,
  157513. * and acceleration of each of these properties.
  157514. * @returns the pose object
  157515. */
  157516. getPose(): VRPose;
  157517. /**
  157518. * Return the current instantaneous pose of the VRDisplay, with no
  157519. * prediction applied.
  157520. * @returns the current instantaneous pose
  157521. */
  157522. getImmediatePose(): VRPose;
  157523. /**
  157524. * The callback passed to `requestAnimationFrame` will be called
  157525. * any time a new frame should be rendered. When the VRDisplay is
  157526. * presenting the callback will be called at the native refresh
  157527. * rate of the HMD. When not presenting this function acts
  157528. * identically to how window.requestAnimationFrame acts. Content should
  157529. * make no assumptions of frame rate or vsync behavior as the HMD runs
  157530. * asynchronously from other displays and at differing refresh rates.
  157531. * @param callback Define the eaction to run next frame
  157532. * @returns the request handle it
  157533. */
  157534. requestAnimationFrame(callback: FrameRequestCallback): number;
  157535. /**
  157536. * Begin presenting to the VRDisplay. Must be called in response to a user gesture.
  157537. * Repeat calls while already presenting will update the VRLayers being displayed.
  157538. * @param layers Define the list of layer to present
  157539. * @returns a promise to know when the request has been fulfilled
  157540. */
  157541. requestPresent(layers: VRLayer[]): Promise<void>;
  157542. /**
  157543. * Reset the pose for this display, treating its current position and
  157544. * orientation as the "origin/zero" values. VRPose.position,
  157545. * VRPose.orientation, and VRStageParameters.sittingToStandingTransform may be
  157546. * updated when calling resetPose(). This should be called in only
  157547. * sitting-space experiences.
  157548. */
  157549. resetPose(): void;
  157550. /**
  157551. * The VRLayer provided to the VRDisplay will be captured and presented
  157552. * in the HMD. Calling this function has the same effect on the source
  157553. * canvas as any other operation that uses its source image, and canvases
  157554. * created without preserveDrawingBuffer set to true will be cleared.
  157555. * @param pose Define the pose to submit
  157556. */
  157557. submitFrame(pose?: VRPose): void;
  157558. }
  157559. declare var VRDisplay: {
  157560. prototype: VRDisplay;
  157561. new(): VRDisplay;
  157562. };
  157563. interface VRLayer {
  157564. leftBounds?: number[] | Float32Array | null;
  157565. rightBounds?: number[] | Float32Array | null;
  157566. source?: HTMLCanvasElement | null;
  157567. }
  157568. interface VRDisplayCapabilities {
  157569. readonly canPresent: boolean;
  157570. readonly hasExternalDisplay: boolean;
  157571. readonly hasOrientation: boolean;
  157572. readonly hasPosition: boolean;
  157573. readonly maxLayers: number;
  157574. }
  157575. interface VREyeParameters {
  157576. /** @deprecated */
  157577. readonly fieldOfView: VRFieldOfView;
  157578. readonly offset: Float32Array;
  157579. readonly renderHeight: number;
  157580. readonly renderWidth: number;
  157581. }
  157582. interface VRFieldOfView {
  157583. readonly downDegrees: number;
  157584. readonly leftDegrees: number;
  157585. readonly rightDegrees: number;
  157586. readonly upDegrees: number;
  157587. }
  157588. interface VRFrameData {
  157589. readonly leftProjectionMatrix: Float32Array;
  157590. readonly leftViewMatrix: Float32Array;
  157591. readonly pose: VRPose;
  157592. readonly rightProjectionMatrix: Float32Array;
  157593. readonly rightViewMatrix: Float32Array;
  157594. readonly timestamp: number;
  157595. }
  157596. interface VRPose {
  157597. readonly angularAcceleration: Float32Array | null;
  157598. readonly angularVelocity: Float32Array | null;
  157599. readonly linearAcceleration: Float32Array | null;
  157600. readonly linearVelocity: Float32Array | null;
  157601. readonly orientation: Float32Array | null;
  157602. readonly position: Float32Array | null;
  157603. readonly timestamp: number;
  157604. }
  157605. interface VRStageParameters {
  157606. sittingToStandingTransform?: Float32Array;
  157607. sizeX?: number;
  157608. sizeY?: number;
  157609. }
  157610. interface Navigator {
  157611. getVRDisplays(): Promise<VRDisplay[]>;
  157612. readonly activeVRDisplays: ReadonlyArray<VRDisplay>;
  157613. }
  157614. interface Window {
  157615. onvrdisplayconnected: ((this: Window, ev: Event) => any) | null;
  157616. onvrdisplaydisconnected: ((this: Window, ev: Event) => any) | null;
  157617. onvrdisplaypresentchange: ((this: Window, ev: Event) => any) | null;
  157618. addEventListener(type: "vrdisplayconnected", listener: (ev: Event) => any, useCapture?: boolean): void;
  157619. addEventListener(type: "vrdisplaydisconnected", listener: (ev: Event) => any, useCapture?: boolean): void;
  157620. addEventListener(type: "vrdisplaypresentchange", listener: (ev: Event) => any, useCapture?: boolean): void;
  157621. }
  157622. interface Gamepad {
  157623. readonly displayId: number;
  157624. }
  157625. type XRSessionMode = "inline" | "immersive-vr" | "immersive-ar";
  157626. type XRReferenceSpaceType = "viewer" | "local" | "local-floor" | "bounded-floor" | "unbounded";
  157627. type XREnvironmentBlendMode = "opaque" | "additive" | "alpha-blend";
  157628. type XRVisibilityState = "visible" | "visible-blurred" | "hidden";
  157629. type XRHandedness = "none" | "left" | "right";
  157630. type XRTargetRayMode = "gaze" | "tracked-pointer" | "screen";
  157631. type XREye = "none" | "left" | "right";
  157632. type XREventType = "devicechange" | "visibilitychange" | "end" | "inputsourceschange" | "select" | "selectstart" | "selectend" | "squeeze" | "squeezestart" | "squeezeend" | "reset";
  157633. interface XRSpace extends EventTarget {}
  157634. interface XRRenderState {
  157635. depthNear?: number;
  157636. depthFar?: number;
  157637. inlineVerticalFieldOfView?: number;
  157638. baseLayer?: XRWebGLLayer;
  157639. }
  157640. interface XRInputSource {
  157641. handedness: XRHandedness;
  157642. targetRayMode: XRTargetRayMode;
  157643. targetRaySpace: XRSpace;
  157644. gripSpace: XRSpace | undefined;
  157645. gamepad: Gamepad | undefined;
  157646. profiles: Array<string>;
  157647. hand: XRHand | undefined;
  157648. }
  157649. interface XRSessionInit {
  157650. optionalFeatures?: string[];
  157651. requiredFeatures?: string[];
  157652. }
  157653. interface XRSession {
  157654. addEventListener: Function;
  157655. removeEventListener: Function;
  157656. requestReferenceSpace(type: XRReferenceSpaceType): Promise<XRReferenceSpace>;
  157657. updateRenderState(XRRenderStateInit: XRRenderState): Promise<void>;
  157658. requestAnimationFrame: Function;
  157659. end(): Promise<void>;
  157660. renderState: XRRenderState;
  157661. inputSources: Array<XRInputSource>;
  157662. // hit test
  157663. requestHitTestSource(options: XRHitTestOptionsInit): Promise<XRHitTestSource>;
  157664. requestHitTestSourceForTransientInput(options: XRTransientInputHitTestOptionsInit): Promise<XRTransientInputHitTestSource>;
  157665. // legacy AR hit test
  157666. requestHitTest(ray: XRRay, referenceSpace: XRReferenceSpace): Promise<XRHitResult[]>;
  157667. // legacy plane detection
  157668. updateWorldTrackingState(options: { planeDetectionState?: { enabled: boolean } }): void;
  157669. }
  157670. interface XRReferenceSpace extends XRSpace {
  157671. getOffsetReferenceSpace(originOffset: XRRigidTransform): XRReferenceSpace;
  157672. onreset: any;
  157673. }
  157674. type XRPlaneSet = Set<XRPlane>;
  157675. type XRAnchorSet = Set<XRAnchor>;
  157676. interface XRFrame {
  157677. session: XRSession;
  157678. getViewerPose(referenceSpace: XRReferenceSpace): XRViewerPose | undefined;
  157679. getPose(space: XRSpace, baseSpace: XRSpace): XRPose | undefined;
  157680. // AR
  157681. getHitTestResults(hitTestSource: XRHitTestSource): Array<XRHitTestResult>;
  157682. getHitTestResultsForTransientInput(hitTestSource: XRTransientInputHitTestSource): Array<XRTransientInputHitTestResult>;
  157683. // Anchors
  157684. trackedAnchors?: XRAnchorSet;
  157685. createAnchor(pose: XRRigidTransform, space: XRSpace): Promise<XRAnchor>;
  157686. // Planes
  157687. worldInformation: {
  157688. detectedPlanes?: XRPlaneSet;
  157689. };
  157690. // Hand tracking
  157691. getJointPose(joint: XRJointSpace, baseSpace: XRSpace): XRJointPose;
  157692. }
  157693. interface XRViewerPose extends XRPose {
  157694. views: Array<XRView>;
  157695. }
  157696. interface XRPose {
  157697. transform: XRRigidTransform;
  157698. emulatedPosition: boolean;
  157699. }
  157700. interface XRWebGLLayerOptions {
  157701. antialias?: boolean;
  157702. depth?: boolean;
  157703. stencil?: boolean;
  157704. alpha?: boolean;
  157705. multiview?: boolean;
  157706. framebufferScaleFactor?: number;
  157707. }
  157708. declare var XRWebGLLayer: {
  157709. prototype: XRWebGLLayer;
  157710. new (session: XRSession, context: WebGLRenderingContext | undefined, options?: XRWebGLLayerOptions): XRWebGLLayer;
  157711. };
  157712. interface XRWebGLLayer {
  157713. framebuffer: WebGLFramebuffer;
  157714. framebufferWidth: number;
  157715. framebufferHeight: number;
  157716. getViewport: Function;
  157717. }
  157718. declare class XRRigidTransform {
  157719. constructor(matrix: Float32Array | DOMPointInit, direction?: DOMPointInit);
  157720. position: DOMPointReadOnly;
  157721. orientation: DOMPointReadOnly;
  157722. matrix: Float32Array;
  157723. inverse: XRRigidTransform;
  157724. }
  157725. interface XRView {
  157726. eye: XREye;
  157727. projectionMatrix: Float32Array;
  157728. transform: XRRigidTransform;
  157729. }
  157730. interface XRInputSourceChangeEvent {
  157731. session: XRSession;
  157732. removed: Array<XRInputSource>;
  157733. added: Array<XRInputSource>;
  157734. }
  157735. interface XRInputSourceEvent extends Event {
  157736. readonly frame: XRFrame;
  157737. readonly inputSource: XRInputSource;
  157738. }
  157739. // Experimental(er) features
  157740. declare class XRRay {
  157741. constructor(transformOrOrigin: XRRigidTransform | DOMPointInit, direction?: DOMPointInit);
  157742. origin: DOMPointReadOnly;
  157743. direction: DOMPointReadOnly;
  157744. matrix: Float32Array;
  157745. }
  157746. declare enum XRHitTestTrackableType {
  157747. "point",
  157748. "plane",
  157749. "mesh",
  157750. }
  157751. interface XRHitResult {
  157752. hitMatrix: Float32Array;
  157753. }
  157754. interface XRTransientInputHitTestResult {
  157755. readonly inputSource: XRInputSource;
  157756. readonly results: Array<XRHitTestResult>;
  157757. }
  157758. interface XRHitTestResult {
  157759. getPose(baseSpace: XRSpace): XRPose | undefined;
  157760. // When anchor system is enabled
  157761. createAnchor?(pose: XRRigidTransform): Promise<XRAnchor>;
  157762. }
  157763. interface XRHitTestSource {
  157764. cancel(): void;
  157765. }
  157766. interface XRTransientInputHitTestSource {
  157767. cancel(): void;
  157768. }
  157769. interface XRHitTestOptionsInit {
  157770. space: XRSpace;
  157771. entityTypes?: Array<XRHitTestTrackableType>;
  157772. offsetRay?: XRRay;
  157773. }
  157774. interface XRTransientInputHitTestOptionsInit {
  157775. profile: string;
  157776. entityTypes?: Array<XRHitTestTrackableType>;
  157777. offsetRay?: XRRay;
  157778. }
  157779. interface XRAnchor {
  157780. anchorSpace: XRSpace;
  157781. delete(): void;
  157782. }
  157783. interface XRPlane {
  157784. orientation: "Horizontal" | "Vertical";
  157785. planeSpace: XRSpace;
  157786. polygon: Array<DOMPointReadOnly>;
  157787. lastChangedTime: number;
  157788. }
  157789. interface XRJointSpace extends XRSpace {}
  157790. interface XRJointPose extends XRPose {
  157791. radius: number | undefined;
  157792. }
  157793. interface XRHand /*extends Iterablele<XRJointSpace>*/ {
  157794. readonly length: number;
  157795. [index: number]: XRJointSpace;
  157796. // Specs have the function 'joint(idx: number)', but chrome doesn't support it yet.
  157797. readonly WRIST: number;
  157798. readonly THUMB_METACARPAL: number;
  157799. readonly THUMB_PHALANX_PROXIMAL: number;
  157800. readonly THUMB_PHALANX_DISTAL: number;
  157801. readonly THUMB_PHALANX_TIP: number;
  157802. readonly INDEX_METACARPAL: number;
  157803. readonly INDEX_PHALANX_PROXIMAL: number;
  157804. readonly INDEX_PHALANX_INTERMEDIATE: number;
  157805. readonly INDEX_PHALANX_DISTAL: number;
  157806. readonly INDEX_PHALANX_TIP: number;
  157807. readonly MIDDLE_METACARPAL: number;
  157808. readonly MIDDLE_PHALANX_PROXIMAL: number;
  157809. readonly MIDDLE_PHALANX_INTERMEDIATE: number;
  157810. readonly MIDDLE_PHALANX_DISTAL: number;
  157811. readonly MIDDLE_PHALANX_TIP: number;
  157812. readonly RING_METACARPAL: number;
  157813. readonly RING_PHALANX_PROXIMAL: number;
  157814. readonly RING_PHALANX_INTERMEDIATE: number;
  157815. readonly RING_PHALANX_DISTAL: number;
  157816. readonly RING_PHALANX_TIP: number;
  157817. readonly LITTLE_METACARPAL: number;
  157818. readonly LITTLE_PHALANX_PROXIMAL: number;
  157819. readonly LITTLE_PHALANX_INTERMEDIATE: number;
  157820. readonly LITTLE_PHALANX_DISTAL: number;
  157821. readonly LITTLE_PHALANX_TIP: number;
  157822. }
  157823. // This file contains native only extensions for WebXR These APIs are not supported in the browser yet.
  157824. // They are intended for use with either Babylon Native https://github.com/BabylonJS/BabylonNative or
  157825. // Babylon React Native: https://github.com/BabylonJS/BabylonReactNative
  157826. interface XRSession {
  157827. trySetFeaturePointCloudEnabled(enabled: boolean): boolean;
  157828. }
  157829. interface XRFrame {
  157830. featurePointCloud? : Array<number>;
  157831. }